1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
7 * <brain@chatspike.net>
8 * <Craig@chatspike.net>
10 * Written by Craig Edwards, Craig McLure, and others.
11 * This program is free but copyrighted software; see
12 * the file COPYING for details.
14 * ---------------------------------------------------
26 #include "helperfuncs.h"
30 /* VERSION 2 API: With nonblocking (threaded) requests */
32 /* $ModDesc: SQL Service Provider module for all other m_sql* modules */
33 /* $CompileFlags: `mysql_config --include` */
34 /* $LinkerFlags: `mysql_config --libs_r` `perl extra/mysql_rpath.pl` */
36 /* THE NONBLOCKING MYSQL API!
38 * MySQL provides no nonblocking (asyncronous) API of its own, and its developers recommend
39 * that instead, you should thread your program. This is what i've done here to allow for
40 * asyncronous SQL requests via mysql. The way this works is as follows:
42 * The module spawns a thread via pthreads, and performs its mysql queries in this thread,
43 * using a queue with priorities. There is a mutex on either end which prevents two threads
44 * adjusting the queue at the same time, and crashing the ircd. Every 50 milliseconds, the
45 * worker thread wakes up, and checks if there is a request at the head of its queue.
46 * If there is, it processes this request, blocking the worker thread but leaving the ircd
47 * thread to go about its business as usual. During this period, the ircd thread is able
48 * to insert futher pending requests into the queue.
50 * Once the processing of a request is complete, it is removed from the incoming queue to
51 * an outgoing queue, and initialized as a 'response'. The worker thread then signals the
52 * ircd thread (via a loopback socket) of the fact a result is available, by sending the
53 * connection ID through the connection.
55 * The ircd thread then mutexes the queue once more, reads the outbound response off the head
56 * of the queue, and sends it on its way to the original calling module.
58 * XXX: You might be asking "why doesnt he just send the response from within the worker thread?"
59 * The answer to this is simple. The majority of InspIRCd, and in fact most ircd's are not
60 * threadsafe. This module is designed to be threadsafe and is careful with its use of threads,
61 * however, if we were to call a module's OnRequest even from within a thread which was not the
62 * one the module was originally instantiated upon, there is a chance of all hell breaking loose
63 * if a module is ever put in a re-enterant state (stack corruption could occur, crashes, data
64 * corruption, and worse, so DONT think about it until the day comes when InspIRCd is 100%
65 * gauranteed threadsafe!)
67 * For a diagram of this system please see http://www.inspircd.org/wiki/Mysql2
74 extern InspIRCd* ServerInstance;
75 typedef std::map<std::string, SQLConnection*> ConnMap;
77 static Module* SQLModule = NULL;
78 static Notifier* MessagePipe = NULL;
82 #if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224
83 #define mysql_field_count mysql_num_fields
86 typedef std::deque<SQLresult*> ResultQueue;
88 class QueryQueue : public classbase
91 typedef std::deque<SQLrequest> ReqDeque;
93 ReqDeque priority; /* The priority queue */
94 ReqDeque normal; /* The 'normal' queue */
95 enum { PRI, NOR, NON } which; /* Which queue the currently active element is at the front of */
103 void push(const SQLrequest &q)
105 log(DEBUG, "QueryQueue::push(): Adding %s query to queue: %s", ((q.pri) ? "priority" : "non-priority"), q.query.q.c_str());
108 priority.push_back(q);
115 if((which == PRI) && priority.size())
117 priority.pop_front();
119 else if((which == NOR) && normal.size())
127 /* Silently do nothing if there was no element to pop() */
135 return priority.front();
137 return normal.front();
142 return priority.front();
148 return normal.front();
151 /* This will probably result in a segfault,
152 * but the caller should have checked totalsize()
153 * first so..meh - moron :p
156 return priority.front();
160 std::pair<int, int> size()
162 return std::make_pair(priority.size(), normal.size());
167 return priority.size() + normal.size();
170 void PurgeModule(Module* mod)
172 DoPurgeModule(mod, priority);
173 DoPurgeModule(mod, normal);
177 void DoPurgeModule(Module* mod, ReqDeque& q)
179 for(ReqDeque::iterator iter = q.begin(); iter != q.end(); iter++)
181 if(iter->GetSource() == mod)
183 if(iter->id == front().id)
185 /* It's the currently active query.. :x */
186 iter->SetSource(NULL);
190 /* It hasn't been executed yet..just remove it */
191 iter = q.erase(iter);
198 /* A mutex to wrap around queue accesses */
199 pthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER;
201 pthread_mutex_t results_mutex = PTHREAD_MUTEX_INITIALIZER;
203 class MySQLresult : public SQLresult
206 //std::vector<std::map<std::string,std::string> > results;
207 std::vector<std::string> colnames;
208 std::vector<SQLfieldList> fieldlists;
209 SQLfieldMap* fieldmap;
210 SQLfieldMap fieldmap2;
211 SQLfieldList emptyfieldlist;
215 MySQLresult(Module* self, Module* to, MYSQL_RES* res, int affected_rows, unsigned int id) : SQLresult(self, to, id), currentrow(0), fieldmap(NULL)
217 /* A number of affected rows from from mysql_affected_rows.
219 log(DEBUG,"Created new MySQLresult of non-error type");
222 if (affected_rows >= 1)
224 rows = affected_rows;
225 fieldlists.resize(rows);
227 unsigned int field_count = 0;
232 while ((row = mysql_fetch_row(res)))
234 if (fieldlists.size() < (unsigned int)rows+1)
236 fieldlists.resize(fieldlists.size()+1);
239 MYSQL_FIELD *fields = mysql_fetch_fields(res);
240 if(mysql_num_fields(res) == 0)
242 if (fields && mysql_num_fields(res))
245 while (field_count < mysql_num_fields(res))
247 std::string a = (fields[field_count].name ? fields[field_count].name : "");
248 std::string b = (row[field_count] ? row[field_count] : "");
249 SQLfield sqlf(b, !row[field_count]);
250 colnames.push_back(a);
251 fieldlists[n].push_back(sqlf);
252 log(DEBUG,"Inc field count to %d",field_count+1);
259 mysql_free_result(res);
261 log(DEBUG, "Created new MySQL result; %d rows, %d columns", rows, colnames.size());
264 MySQLresult(Module* self, Module* to, SQLerror e, unsigned int id) : SQLresult(self, to, id), currentrow(0)
268 log(DEBUG,"Created new MySQLresult of error type");
282 return colnames.size();
285 virtual std::string ColName(int column)
287 if (column < (int)colnames.size())
289 return colnames[column];
293 throw SQLbadColName();
298 virtual int ColNum(const std::string &column)
300 for (unsigned int i = 0; i < colnames.size(); i++)
302 if (column == colnames[i])
305 throw SQLbadColName();
309 virtual SQLfield GetValue(int row, int column)
311 if ((row >= 0) && (row < rows) && (column >= 0) && (column < Cols()))
313 return fieldlists[row][column];
316 log(DEBUG,"Danger will robinson, we don't have row %d, column %d!", row, column);
317 throw SQLbadColName();
319 /* XXX: We never actually get here because of the throw */
320 return SQLfield("",true);
323 virtual SQLfieldList& GetRow()
325 if (currentrow < rows)
326 return fieldlists[currentrow];
328 return emptyfieldlist;
331 virtual SQLfieldMap& GetRowMap()
335 if (currentrow < rows)
337 for (int i = 0; i < Cols(); i++)
339 fieldmap2.insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
347 virtual SQLfieldList* GetRowPtr()
349 SQLfieldList* fieldlist = new SQLfieldList();
351 if (currentrow < rows)
353 for (int i = 0; i < Rows(); i++)
355 fieldlist->push_back(fieldlists[currentrow][i]);
362 virtual SQLfieldMap* GetRowMapPtr()
364 fieldmap = new SQLfieldMap();
366 if (currentrow < rows)
368 for (int i = 0; i < Cols(); i++)
370 fieldmap->insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
378 virtual void Free(SQLfieldMap* fm)
383 virtual void Free(SQLfieldList* fl)
391 void NotifyMainThread(SQLConnection* connection_with_new_result);
393 class SQLConnection : public classbase
404 std::map<std::string,std::string> thisrow;
413 // This constructor creates an SQLConnection object with the given credentials, and creates the underlying
414 // MYSQL struct, but does not connect yet.
415 SQLConnection(std::string thishost, std::string thisuser, std::string thispass, std::string thisdb, const std::string &myid)
417 this->Enabled = true;
418 this->host = thishost;
419 this->user = thisuser;
420 this->pass = thispass;
425 // This method connects to the database using the credentials supplied to the constructor, and returns
426 // true upon success.
429 unsigned int timeout = 1;
430 mysql_init(&connection);
431 mysql_options(&connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
432 return mysql_real_connect(&connection, host.c_str(), user.c_str(), pass.c_str(), db.c_str(), 0, NULL, 0);
435 void DoLeadingQuery()
437 if (!CheckConnection())
440 /* Parse the command string and dispatch it to mysql */
441 SQLrequest& req = queue.front();
442 log(DEBUG,"DO QUERY: %s",req.query.q.c_str());
444 /* Pointer to the buffer we screw around with substitution in */
447 /* Pointer to the current end of query, where we append new stuff */
450 /* Total length of the unescaped parameters */
451 unsigned long paramlen;
453 /* Total length of query, used for binary-safety in mysql_real_query */
454 unsigned long querylength = 0;
458 for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
460 paramlen += i->size();
463 /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
464 * sizeofquery + (totalparamlength*2) + 1
466 * The +1 is for null-terminating the string for mysql_real_escape_string
469 query = new char[req.query.q.length() + (paramlen*2)];
472 /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
473 * the parameters into it...
476 for(unsigned long i = 0; i < req.query.q.length(); i++)
478 if(req.query.q[i] == '?')
480 /* We found a place to substitute..what fun.
481 * use mysql calls to escape and write the
482 * escaped string onto the end of our query buffer,
483 * then we "just" need to make sure queryend is
484 * pointing at the right place.
486 if(req.query.p.size())
488 unsigned long len = mysql_real_escape_string(&connection, queryend, req.query.p.front().c_str(), req.query.p.front().length());
491 req.query.p.pop_front();
495 log(DEBUG, "Found a substitution location but no parameter to substitute :|");
501 *queryend = req.query.q[i];
509 log(DEBUG, "Attempting to dispatch query: %s", query);
511 pthread_mutex_lock(&queue_mutex);
513 pthread_mutex_unlock(&queue_mutex);
515 log(DEBUG,"REQUEST ID: %d",req.id);
517 if (!mysql_real_query(&connection, req.query.q.data(), req.query.q.length()))
519 /* Successfull query */
520 res = mysql_use_result(&connection);
521 unsigned long rows = mysql_affected_rows(&connection);
522 MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), res, rows, req.id);
523 r->dbid = this->GetID();
524 r->query = req.query.q;
525 /* Put this new result onto the results queue.
526 * XXX: Remember to mutex the queue!
528 pthread_mutex_lock(&results_mutex);
530 pthread_mutex_unlock(&results_mutex);
534 /* XXX: See /usr/include/mysql/mysqld_error.h for a list of
535 * possible error numbers and error messages */
536 log(DEBUG,"SQL ERROR: %s",mysql_error(&connection));
537 SQLerror e(QREPLY_FAIL, ConvToStr(mysql_errno(&connection)) + std::string(": ") + mysql_error(&connection));
538 MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), e, req.id);
539 r->dbid = this->GetID();
540 r->query = req.query.q;
542 pthread_mutex_lock(&results_mutex);
544 pthread_mutex_unlock(&results_mutex);
547 /* Now signal the main thread that we've got a result to process.
548 * Pass them this connection id as what to examine
551 NotifyMainThread(this);
554 bool ConnectionLost()
557 return (mysql_ping(&connection) != 0);
562 bool CheckConnection()
564 if (ConnectionLost()) {
570 std::string GetError()
572 return mysql_error(&connection);
575 const std::string& GetID()
580 std::string GetHost()
585 void SetEnable(bool Enable)
599 void ConnectDatabases(Server* Srv)
601 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
603 i->second->SetEnable(true);
604 if (i->second->Connect())
606 log(DEFAULT,"SQL: Successfully connected database "+i->second->GetHost());
610 log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
611 i->second->SetEnable(false);
617 void LoadDatabases(ConfigReader* ThisConf, Server* Srv)
619 log(DEFAULT,"SQL: Loading database settings");
621 log(DEBUG,"Cleared connections");
622 for (int j =0; j < ThisConf->Enumerate("database"); j++)
624 std::string db = ThisConf->ReadValue("database","name",j);
625 std::string user = ThisConf->ReadValue("database","username",j);
626 std::string pass = ThisConf->ReadValue("database","password",j);
627 std::string host = ThisConf->ReadValue("database","hostname",j);
628 std::string id = ThisConf->ReadValue("database","id",j);
629 log(DEBUG,"Read database settings");
630 if ((db != "") && (host != "") && (user != "") && (id != "") && (pass != ""))
632 SQLConnection* ThisSQL = new SQLConnection(host,user,pass,db,id);
633 log(DEFAULT,"Loaded database: "+ThisSQL->GetHost());
634 Connections[id] = ThisSQL;
635 log(DEBUG,"Pushed back connection");
638 ConnectDatabases(Srv);
641 void NotifyMainThread(SQLConnection* connection_with_new_result)
643 /* Here we write() to the socket the main thread has open
644 * and we connect()ed back to before our thread became active.
645 * The main thread is using a nonblocking socket tied into
646 * the socket engine, so they wont block and they'll receive
647 * nearly instant notification. Because we're in a seperate
648 * thread, we can just use standard connect(), and we can
649 * block if we like. We just send the connection id of the
652 log(DEBUG,"Notify of result on connection: %s",connection_with_new_result->GetID().c_str());
653 if (send(QueueFD, connection_with_new_result->GetID().c_str(), connection_with_new_result->GetID().length()+1, 0) < 1) // add one for null terminator
655 log(DEBUG,"Error writing to QueueFD: %s",strerror(errno));
657 log(DEBUG,"Sent it on its way via fd=%d",QueueFD);
660 void* DispatcherThread(void* arg);
662 class Notifier : public InspSocket
664 insp_sockaddr sock_us;
670 /* Create a socket on a random port. Let the tcp stack allocate us an available port */
672 Notifier(InspIRCd* SI, Server* S) : InspSocket(SI, "::1", 0, true, 3000), Srv(S)
674 Notifier(InspIRCd* SI, Server* S) : InspSocket(SI, "127.0.0.1", 0, true, 3000), Srv(S)
677 uslen = sizeof(sock_us);
678 if (getsockname(this->fd,(sockaddr*)&sock_us,&uslen))
680 throw ModuleException("Could not create random listening port on localhost");
684 Notifier(InspIRCd* SI, int newfd, char* ip, Server* S) : InspSocket(SI, newfd, ip), Srv(S)
686 log(DEBUG,"Constructor of new socket");
689 /* Using getsockname and ntohs, we can determine which port number we were allocated */
693 return ntohs(sock_us.sin6_port);
695 return ntohs(sock_us.sin_port);
699 virtual int OnIncomingConnection(int newsock, char* ip)
701 log(DEBUG,"Inbound connection on fd %d!",newsock);
702 Notifier* n = new Notifier(this->Instance, newsock, ip, Srv);
707 virtual bool OnDataReady()
709 log(DEBUG,"Inbound data!");
710 char* data = this->Read();
711 ConnMap::iterator iter;
715 log(DEBUG,"Looking for connection %s",data);
716 /* We expect to be sent a null terminated string */
717 if((iter = Connections.find(data)) != Connections.end())
719 log(DEBUG,"Found it!");
721 /* Lock the mutex, send back the data */
722 pthread_mutex_lock(&results_mutex);
723 ResultQueue::iterator n = iter->second->rq.begin();
725 iter->second->rq.pop_front();
726 pthread_mutex_unlock(&results_mutex);
735 class ModuleSQL : public Module
740 pthread_t Dispatcher;
743 void Implements(char* List)
745 List[I_OnRehash] = List[I_OnRequest] = 1;
748 unsigned long NewID()
755 char* OnRequest(Request* request)
757 if(strcmp(SQLREQID, request->GetId()) == 0)
759 SQLrequest* req = (SQLrequest*)request;
762 pthread_mutex_lock(&queue_mutex);
764 ConnMap::iterator iter;
766 char* returnval = NULL;
768 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());
770 if((iter = Connections.find(req->dbid)) != Connections.end())
773 iter->second->queue.push(*req);
774 returnval = SQLSUCCESS;
778 req->error.Id(BAD_DBID);
781 pthread_mutex_unlock(&queue_mutex);
787 log(DEBUG, "Got unsupported API version string: %s", request->GetId());
792 ModuleSQL(Server* Me)
796 Conf = new ConfigReader();
800 MessagePipe = new Notifier(ServerInstance, Srv);
801 Srv->AddSocket(MessagePipe);
802 log(DEBUG,"Bound notifier to 127.0.0.1:%d",MessagePipe->GetPort());
804 pthread_attr_t attribs;
805 pthread_attr_init(&attribs);
806 pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED);
807 if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)
809 throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));
811 if (!Srv->PublishFeature("SQL", this))
813 /* Tell worker thread to exit NOW */
815 throw ModuleException("m_mysql: Unable to publish feature 'SQL'");
824 virtual void OnRehash(const std::string ¶meter)
826 /* TODO: set rehash bool here, which makes the dispatcher thread rehash at next opportunity */
829 virtual Version GetVersion()
831 return Version(1,1,0,0,VF_VENDOR|VF_SERVICEPROVIDER);
836 void* DispatcherThread(void* arg)
838 log(DEBUG,"Starting Dispatcher thread, mysql version %d",mysql_get_client_version());
839 ModuleSQL* thismodule = (ModuleSQL*)arg;
840 LoadDatabases(thismodule->Conf, thismodule->Srv);
842 /* Connect back to the Notifier */
844 if ((QueueFD = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1)
846 /* crap, we're out of sockets... */
847 log(DEBUG,"QueueFD cant be created");
851 log(DEBUG,"Initialize QueueFD to %d",QueueFD);
856 insp_aton("::1", &addr.sin6_addr);
857 addr.sin6_family = AF_FAMILY;
858 addr.sin6_port = htons(MessagePipe->GetPort());
861 insp_aton("127.0.0.1", &ia);
862 addr.sin_family = AF_FAMILY;
864 addr.sin_port = htons(MessagePipe->GetPort());
867 if (connect(QueueFD, (sockaddr*)&addr,sizeof(addr)) == -1)
869 /* wtf, we cant connect to it, but we just created it! */
870 log(DEBUG,"QueueFD cant connect!");
874 log(DEBUG,"Connect QUEUE FD");
878 SQLConnection* conn = NULL;
879 /* XXX: Lock here for safety */
880 pthread_mutex_lock(&queue_mutex);
881 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
883 if (i->second->queue.totalsize())
889 pthread_mutex_unlock(&queue_mutex);
892 /* Theres an item! */
895 log(DEBUG,"Process Leading query");
896 conn->DoLeadingQuery();
899 pthread_mutex_lock(&queue_mutex);
901 pthread_mutex_unlock(&queue_mutex);
912 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
914 class ModuleSQLFactory : public ModuleFactory
925 virtual Module * CreateModule(Server* Me)
927 return new ModuleSQL(Me);
933 extern "C" void * init_module( void )
935 return new ModuleSQLFactory;