1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
24 /* VERSION 2 API: With nonblocking (threaded) requests */
26 /* $ModDesc: SQL Service Provider module for all other m_sql* modules */
27 /* $CompileFlags: exec("mysql_config --include") */
28 /* $LinkerFlags: exec("mysql_config --libs_r") rpath("mysql_config --libs_r") */
29 /* $ModDep: m_sqlv2.h */
31 /* THE NONBLOCKING MYSQL API!
33 * MySQL provides no nonblocking (asyncronous) API of its own, and its developers recommend
34 * that instead, you should thread your program. This is what i've done here to allow for
35 * asyncronous SQL requests via mysql. The way this works is as follows:
37 * The module spawns a thread via pthreads, and performs its mysql queries in this thread,
38 * using a queue with priorities. There is a mutex on either end which prevents two threads
39 * adjusting the queue at the same time, and crashing the ircd. Every 50 milliseconds, the
40 * worker thread wakes up, and checks if there is a request at the head of its queue.
41 * If there is, it processes this request, blocking the worker thread but leaving the ircd
42 * thread to go about its business as usual. During this period, the ircd thread is able
43 * to insert futher pending requests into the queue.
45 * Once the processing of a request is complete, it is removed from the incoming queue to
46 * an outgoing queue, and initialized as a 'response'. The worker thread then signals the
47 * ircd thread (via a loopback socket) of the fact a result is available, by sending the
48 * connection ID through the connection.
50 * The ircd thread then mutexes the queue once more, reads the outbound response off the head
51 * of the queue, and sends it on its way to the original calling module.
53 * XXX: You might be asking "why doesnt he just send the response from within the worker thread?"
54 * The answer to this is simple. The majority of InspIRCd, and in fact most ircd's are not
55 * threadsafe. This module is designed to be threadsafe and is careful with its use of threads,
56 * however, if we were to call a module's OnRequest even from within a thread which was not the
57 * one the module was originally instantiated upon, there is a chance of all hell breaking loose
58 * if a module is ever put in a re-enterant state (stack corruption could occur, crashes, data
59 * corruption, and worse, so DONT think about it until the day comes when InspIRCd is 100%
60 * gauranteed threadsafe!)
62 * For a diagram of this system please see http://www.inspircd.org/wiki/Mysql2
70 typedef std::map<std::string, SQLConnection*> ConnMap;
72 static Module* SQLModule = NULL;
73 static Notifier* MessagePipe = NULL;
77 #if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224
78 #define mysql_field_count mysql_num_fields
81 typedef std::deque<SQLresult*> ResultQueue;
83 /** Represents a mysql query queue
85 class QueryQueue : public classbase
88 typedef std::deque<SQLrequest> ReqDeque;
90 ReqDeque priority; /* The priority queue */
91 ReqDeque normal; /* The 'normal' queue */
92 enum { PRI, NOR, NON } which; /* Which queue the currently active element is at the front of */
100 void push(const SQLrequest &q)
103 priority.push_back(q);
110 if((which == PRI) && priority.size())
112 priority.pop_front();
114 else if((which == NOR) && normal.size())
122 /* Silently do nothing if there was no element to pop() */
130 return priority.front();
132 return normal.front();
137 return priority.front();
143 return normal.front();
146 /* This will probably result in a segfault,
147 * but the caller should have checked totalsize()
148 * first so..meh - moron :p
151 return priority.front();
155 std::pair<int, int> size()
157 return std::make_pair(priority.size(), normal.size());
162 return priority.size() + normal.size();
165 void PurgeModule(Module* mod)
167 DoPurgeModule(mod, priority);
168 DoPurgeModule(mod, normal);
172 void DoPurgeModule(Module* mod, ReqDeque& q)
174 for(ReqDeque::iterator iter = q.begin(); iter != q.end(); iter++)
176 if(iter->GetSource() == mod)
178 if(iter->id == front().id)
180 /* It's the currently active query.. :x */
181 iter->SetSource(NULL);
185 /* It hasn't been executed yet..just remove it */
186 iter = q.erase(iter);
193 /* A mutex to wrap around queue accesses */
194 pthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER;
196 pthread_mutex_t results_mutex = PTHREAD_MUTEX_INITIALIZER;
198 pthread_mutex_t logging_mutex = PTHREAD_MUTEX_INITIALIZER;
200 /** Represents a mysql result set
202 class MySQLresult : public SQLresult
205 //std::vector<std::map<std::string,std::string> > results;
206 std::vector<std::string> colnames;
207 std::vector<SQLfieldList> fieldlists;
208 SQLfieldMap* fieldmap;
209 SQLfieldMap fieldmap2;
210 SQLfieldList emptyfieldlist;
214 MySQLresult(Module* self, Module* to, MYSQL_RES* res, int affected_rows, unsigned int id) : SQLresult(self, to, id), currentrow(0), fieldmap(NULL)
216 /* A number of affected rows from from mysql_affected_rows.
220 if (affected_rows >= 1)
222 rows = affected_rows;
223 fieldlists.resize(rows);
225 unsigned int field_count = 0;
230 while ((row = mysql_fetch_row(res)))
232 if (fieldlists.size() < (unsigned int)rows+1)
234 fieldlists.resize(fieldlists.size()+1);
237 MYSQL_FIELD *fields = mysql_fetch_fields(res);
238 if(mysql_num_fields(res) == 0)
240 if (fields && mysql_num_fields(res))
243 while (field_count < mysql_num_fields(res))
245 std::string a = (fields[field_count].name ? fields[field_count].name : "");
246 std::string b = (row[field_count] ? row[field_count] : "");
247 SQLfield sqlf(b, !row[field_count]);
248 colnames.push_back(a);
249 fieldlists[n].push_back(sqlf);
256 mysql_free_result(res);
260 MySQLresult(Module* self, Module* to, SQLerror e, unsigned int id) : SQLresult(self, to, id), currentrow(0)
277 return colnames.size();
280 virtual std::string ColName(int column)
282 if (column < (int)colnames.size())
284 return colnames[column];
288 throw SQLbadColName();
293 virtual int ColNum(const std::string &column)
295 for (unsigned int i = 0; i < colnames.size(); i++)
297 if (column == colnames[i])
300 throw SQLbadColName();
304 virtual SQLfield GetValue(int row, int column)
306 if ((row >= 0) && (row < rows) && (column >= 0) && (column < Cols()))
308 return fieldlists[row][column];
311 throw SQLbadColName();
313 /* XXX: We never actually get here because of the throw */
314 return SQLfield("",true);
317 virtual SQLfieldList& GetRow()
319 if (currentrow < rows)
320 return fieldlists[currentrow];
322 return emptyfieldlist;
325 virtual SQLfieldMap& GetRowMap()
329 if (currentrow < rows)
331 for (int i = 0; i < Cols(); i++)
333 fieldmap2.insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
341 virtual SQLfieldList* GetRowPtr()
343 SQLfieldList* fieldlist = new SQLfieldList();
345 if (currentrow < rows)
347 for (int i = 0; i < Rows(); i++)
349 fieldlist->push_back(fieldlists[currentrow][i]);
356 virtual SQLfieldMap* GetRowMapPtr()
358 fieldmap = new SQLfieldMap();
360 if (currentrow < rows)
362 for (int i = 0; i < Cols(); i++)
364 fieldmap->insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
372 virtual void Free(SQLfieldMap* fm)
377 virtual void Free(SQLfieldList* fl)
385 void NotifyMainThread(SQLConnection* connection_with_new_result);
387 /** Represents a connection to a mysql database
389 class SQLConnection : public classbase
397 std::map<std::string,std::string> thisrow;
405 // This constructor creates an SQLConnection object with the given credentials, but does not connect yet.
406 SQLConnection(const SQLhost &hi) : host(hi), Enabled(false)
415 // This method connects to the database using the credentials supplied to the constructor, and returns
416 // true upon success.
419 unsigned int timeout = 1;
420 mysql_init(&connection);
421 mysql_options(&connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
422 return mysql_real_connect(&connection, host.host.c_str(), host.user.c_str(), host.pass.c_str(), host.name.c_str(), host.port, NULL, 0);
425 void DoLeadingQuery()
427 if (!CheckConnection())
430 /* Parse the command string and dispatch it to mysql */
431 SQLrequest& req = queue.front();
433 /* Pointer to the buffer we screw around with substitution in */
436 /* Pointer to the current end of query, where we append new stuff */
439 /* Total length of the unescaped parameters */
440 unsigned long paramlen;
442 /* Total length of query, used for binary-safety in mysql_real_query */
443 unsigned long querylength = 0;
447 for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
449 paramlen += i->size();
452 /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
453 * sizeofquery + (totalparamlength*2) + 1
455 * The +1 is for null-terminating the string for mysql_real_escape_string
458 query = new char[req.query.q.length() + (paramlen*2) + 1];
461 /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
462 * the parameters into it...
465 for(unsigned long i = 0; i < req.query.q.length(); i++)
467 if(req.query.q[i] == '?')
469 /* We found a place to substitute..what fun.
470 * use mysql calls to escape and write the
471 * escaped string onto the end of our query buffer,
472 * then we "just" need to make sure queryend is
473 * pointing at the right place.
475 if(req.query.p.size())
477 unsigned long len = mysql_real_escape_string(&connection, queryend, req.query.p.front().c_str(), req.query.p.front().length());
480 req.query.p.pop_front();
487 *queryend = req.query.q[i];
495 pthread_mutex_lock(&queue_mutex);
497 pthread_mutex_unlock(&queue_mutex);
499 if (!mysql_real_query(&connection, req.query.q.data(), req.query.q.length()))
501 /* Successfull query */
502 res = mysql_use_result(&connection);
503 unsigned long rows = mysql_affected_rows(&connection);
504 MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), res, rows, req.id);
505 r->dbid = this->GetID();
506 r->query = req.query.q;
507 /* Put this new result onto the results queue.
508 * XXX: Remember to mutex the queue!
510 pthread_mutex_lock(&results_mutex);
512 pthread_mutex_unlock(&results_mutex);
516 /* XXX: See /usr/include/mysql/mysqld_error.h for a list of
517 * possible error numbers and error messages */
518 SQLerror e(QREPLY_FAIL, ConvToStr(mysql_errno(&connection)) + std::string(": ") + mysql_error(&connection));
519 MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), e, req.id);
520 r->dbid = this->GetID();
521 r->query = req.query.q;
523 pthread_mutex_lock(&results_mutex);
525 pthread_mutex_unlock(&results_mutex);
528 /* Now signal the main thread that we've got a result to process.
529 * Pass them this connection id as what to examine
534 NotifyMainThread(this);
537 bool ConnectionLost()
540 return (mysql_ping(&connection) != 0);
545 bool CheckConnection()
547 if (ConnectionLost()) {
553 std::string GetError()
555 return mysql_error(&connection);
558 const std::string& GetID()
563 std::string GetHost()
568 void SetEnable(bool Enable)
580 mysql_close(&connection);
583 const SQLhost& GetConfHost()
592 bool HasHost(const SQLhost &host)
594 for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); iter++)
596 if (host == iter->second->GetConfHost())
602 bool HostInConf(ConfigReader* conf, const SQLhost &h)
604 for(int i = 0; i < conf->Enumerate("database"); i++)
607 host.id = conf->ReadValue("database", "id", i);
608 host.host = conf->ReadValue("database", "hostname", i);
609 host.port = conf->ReadInteger("database", "port", i, true);
610 host.name = conf->ReadValue("database", "name", i);
611 host.user = conf->ReadValue("database", "username", i);
612 host.pass = conf->ReadValue("database", "password", i);
613 host.ssl = conf->ReadFlag("database", "ssl", i);
620 void ClearOldConnections(ConfigReader* conf)
622 ConnMap::iterator i,safei;
623 for (i = Connections.begin(); i != Connections.end(); i++)
625 if (!HostInConf(conf, i->second->GetConfHost()))
630 Connections.erase(safei);
635 void ClearAllConnections()
638 while ((i = Connections.begin()) != Connections.end())
640 Connections.erase(i);
645 void ConnectDatabases(InspIRCd* ServerInstance)
647 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
649 if (i->second->IsEnabled())
652 i->second->SetEnable(true);
653 if (!i->second->Connect())
656 pthread_mutex_lock(&logging_mutex);
657 ServerInstance->Log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
658 i->second->SetEnable(false);
659 pthread_mutex_unlock(&logging_mutex);
664 void LoadDatabases(ConfigReader* conf, InspIRCd* ServerInstance)
666 ClearOldConnections(conf);
667 for (int j =0; j < conf->Enumerate("database"); j++)
670 host.id = conf->ReadValue("database", "id", j);
671 host.host = conf->ReadValue("database", "hostname", j);
672 host.port = conf->ReadInteger("database", "port", j, true);
673 host.name = conf->ReadValue("database", "name", j);
674 host.user = conf->ReadValue("database", "username", j);
675 host.pass = conf->ReadValue("database", "password", j);
676 host.ssl = conf->ReadFlag("database", "ssl", j);
681 if (!host.id.empty() && !host.host.empty() && !host.name.empty() && !host.user.empty() && !host.pass.empty())
683 SQLConnection* ThisSQL = new SQLConnection(host);
684 Connections[host.id] = ThisSQL;
687 ConnectDatabases(ServerInstance);
690 void NotifyMainThread(SQLConnection* connection_with_new_result)
692 /* Here we write() to the socket the main thread has open
693 * and we connect()ed back to before our thread became active.
694 * The main thread is using a nonblocking socket tied into
695 * the socket engine, so they wont block and they'll receive
696 * nearly instant notification. Because we're in a seperate
697 * thread, we can just use standard connect(), and we can
698 * block if we like. We just send the connection id of the
701 send(QueueFD, connection_with_new_result->GetID().c_str(), connection_with_new_result->GetID().length()+1, 0);
704 void* DispatcherThread(void* arg);
706 /** Used by m_mysql to notify one thread when the other has a result
708 class Notifier : public InspSocket
710 insp_sockaddr sock_us;
716 /* Create a socket on a random port. Let the tcp stack allocate us an available port */
718 Notifier(InspIRCd* SI) : InspSocket(SI, "::1", 0, true, 3000)
720 Notifier(InspIRCd* SI) : InspSocket(SI, "127.0.0.1", 0, true, 3000)
723 uslen = sizeof(sock_us);
724 if (getsockname(this->fd,(sockaddr*)&sock_us,&uslen))
726 throw ModuleException("Could not create random listening port on localhost");
730 Notifier(InspIRCd* SI, int newfd, char* ip) : InspSocket(SI, newfd, ip)
732 Instance->Log(DEBUG,"Constructor of new socket");
735 /* Using getsockname and ntohs, we can determine which port number we were allocated */
739 return ntohs(sock_us.sin6_port);
741 return ntohs(sock_us.sin_port);
745 virtual int OnIncomingConnection(int newsock, char* ip)
747 Instance->Log(DEBUG,"Inbound connection on fd %d!",newsock);
748 Notifier* n = new Notifier(this->Instance, newsock, ip);
749 n = n; /* Stop bitching at me, GCC */
753 virtual bool OnDataReady()
755 Instance->Log(DEBUG,"Inbound data!");
756 char* data = this->Read();
757 ConnMap::iterator iter;
761 Instance->Log(DEBUG,"Looking for connection %s",data);
762 /* We expect to be sent a null terminated string */
763 if((iter = Connections.find(data)) != Connections.end())
765 Instance->Log(DEBUG,"Found it!");
767 /* Lock the mutex, send back the data */
768 pthread_mutex_lock(&results_mutex);
769 ResultQueue::iterator n = iter->second->rq.begin();
771 iter->second->rq.pop_front();
772 pthread_mutex_unlock(&results_mutex);
783 class ModuleSQL : public Module
788 InspIRCd* PublicServerInstance;
789 pthread_t Dispatcher;
793 ModuleSQL(InspIRCd* Me)
794 : Module::Module(Me), rehashing(false)
796 ServerInstance->UseInterface("SQLutils");
798 Conf = new ConfigReader(ServerInstance);
799 PublicServerInstance = ServerInstance;
803 MessagePipe = new Notifier(ServerInstance);
804 ServerInstance->Log(DEBUG,"Bound notifier to 127.0.0.1:%d",MessagePipe->GetPort());
806 pthread_attr_t attribs;
807 pthread_attr_init(&attribs);
808 pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED);
809 if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)
811 throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));
814 if (!ServerInstance->PublishFeature("SQL", this))
816 /* Tell worker thread to exit NOW */
818 throw ModuleException("m_mysql: Unable to publish feature 'SQL'");
821 ServerInstance->PublishInterface("SQL", this);
827 ClearAllConnections();
829 ServerInstance->UnpublishInterface("SQL", this);
830 ServerInstance->UnpublishFeature("SQL");
831 ServerInstance->DoneWithInterface("SQLutils");
835 void Implements(char* List)
837 List[I_OnRehash] = List[I_OnRequest] = 1;
840 unsigned long NewID()
847 char* OnRequest(Request* request)
849 if(strcmp(SQLREQID, request->GetId()) == 0)
851 SQLrequest* req = (SQLrequest*)request;
854 pthread_mutex_lock(&queue_mutex);
856 ConnMap::iterator iter;
858 char* returnval = NULL;
860 ServerInstance->Log(DEBUG, "Got query: '%s' with %d replacement parameters on id '%s'", req->query.q.c_str(), req->query.p.size(), req->dbid.c_str());
862 if((iter = Connections.find(req->dbid)) != Connections.end())
865 iter->second->queue.push(*req);
866 returnval = SQLSUCCESS;
870 req->error.Id(BAD_DBID);
873 pthread_mutex_unlock(&queue_mutex);
879 ServerInstance->Log(DEBUG, "Got unsupported API version string: %s", request->GetId());
884 virtual void OnRehash(userrec* user, const std::string ¶meter)
889 virtual Version GetVersion()
891 return Version(1,1,0,0,VF_VENDOR|VF_SERVICEPROVIDER,API_VERSION);
896 void* DispatcherThread(void* arg)
898 ModuleSQL* thismodule = (ModuleSQL*)arg;
899 LoadDatabases(thismodule->Conf, thismodule->PublicServerInstance);
901 /* Connect back to the Notifier */
903 if ((QueueFD = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1)
905 /* crap, we're out of sockets... */
912 insp_aton("::1", &addr.sin6_addr);
913 addr.sin6_family = AF_FAMILY;
914 addr.sin6_port = htons(MessagePipe->GetPort());
917 insp_aton("127.0.0.1", &ia);
918 addr.sin_family = AF_FAMILY;
920 addr.sin_port = htons(MessagePipe->GetPort());
923 if (connect(QueueFD, (sockaddr*)&addr,sizeof(addr)) == -1)
925 /* wtf, we cant connect to it, but we just created it! */
931 if (thismodule->rehashing)
934 pthread_mutex_lock(&queue_mutex);
935 thismodule->rehashing = false;
936 LoadDatabases(thismodule->Conf, thismodule->PublicServerInstance);
937 pthread_mutex_unlock(&queue_mutex);
941 SQLConnection* conn = NULL;
942 /* XXX: Lock here for safety */
943 pthread_mutex_lock(&queue_mutex);
944 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
946 if (i->second->queue.totalsize())
952 pthread_mutex_unlock(&queue_mutex);
955 /* Theres an item! */
958 conn->DoLeadingQuery();
961 pthread_mutex_lock(&queue_mutex);
963 pthread_mutex_unlock(&queue_mutex);
974 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
976 class ModuleSQLFactory : public ModuleFactory
987 virtual Module * CreateModule(InspIRCd* Me)
989 return new ModuleSQL(Me);
995 extern "C" void * init_module( void )
997 return new ModuleSQLFactory;