1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2009 InspIRCd Development Team
6 * See: http://wiki.inspircd.org/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 /* Stop mysql wanting to use long long */
15 #define NO_CLIENT_LONG_LONG
22 #pragma comment(lib, "mysqlclient.lib")
25 /* VERSION 2 API: With nonblocking (threaded) requests */
27 /* $ModDesc: SQL Service Provider module for all other m_sql* modules */
28 /* $CompileFlags: exec("mysql_config --include") */
29 /* $LinkerFlags: exec("mysql_config --libs_r") rpath("mysql_config --libs_r") */
30 /* $ModDep: m_sqlv2.h */
32 /* THE NONBLOCKING MYSQL API!
34 * MySQL provides no nonblocking (asyncronous) API of its own, and its developers recommend
35 * that instead, you should thread your program. This is what i've done here to allow for
36 * asyncronous SQL requests via mysql. The way this works is as follows:
38 * The module spawns a thread via class Thread, and performs its mysql queries in this thread,
39 * using a queue with priorities. There is a mutex on either end which prevents two threads
40 * adjusting the queue at the same time, and crashing the ircd. Every 50 milliseconds, the
41 * worker thread wakes up, and checks if there is a request at the head of its queue.
42 * If there is, it processes this request, blocking the worker thread but leaving the ircd
43 * thread to go about its business as usual. During this period, the ircd thread is able
44 * to insert futher pending requests into the queue.
46 * Once the processing of a request is complete, it is removed from the incoming queue to
47 * an outgoing queue, and initialized as a 'response'. The worker thread then signals the
48 * ircd thread (via a loopback socket) of the fact a result is available, by sending the
49 * connection ID through the connection.
51 * The ircd thread then mutexes the queue once more, reads the outbound response off the head
52 * of the queue, and sends it on its way to the original calling module.
54 * XXX: You might be asking "why doesnt he just send the response from within the worker thread?"
55 * The answer to this is simple. The majority of InspIRCd, and in fact most ircd's are not
56 * threadsafe. This module is designed to be threadsafe and is careful with its use of threads,
57 * however, if we were to call a module's OnRequest even from within a thread which was not the
58 * one the module was originally instantiated upon, there is a chance of all hell breaking loose
59 * if a module is ever put in a re-enterant state (stack corruption could occur, crashes, data
60 * corruption, and worse, so DONT think about it until the day comes when InspIRCd is 100%
61 * gauranteed threadsafe!)
63 * For a diagram of this system please see http://wiki.inspircd.org/Mysql2
68 class DispatcherThread;
70 typedef std::map<std::string, SQLConnection*> ConnMap;
71 typedef std::deque<SQLresult*> ResultQueue;
73 static unsigned long count(const char * const str, char a)
76 for (const char *p = str; *p; ++p)
87 class ModuleSQL : public Module
92 DispatcherThread* Dispatcher;
96 ServiceProvider sqlserv;
100 unsigned long NewID();
101 void OnRequest(Request& request);
102 void OnRehash(User* user);
103 Version GetVersion();
107 #if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224
108 #define mysql_field_count mysql_num_fields
111 /** Represents a mysql result set
113 class MySQLresult : public SQLresult
116 std::vector<std::string> colnames;
117 std::vector<SQLfieldList> fieldlists;
118 SQLfieldMap* fieldmap;
119 SQLfieldMap fieldmap2;
120 SQLfieldList emptyfieldlist;
124 MySQLresult(Module* self, Module* to, MYSQL_RES* res, int affected_rows, unsigned int rid) : SQLresult(self, to, rid), currentrow(0), fieldmap(NULL)
126 /* A number of affected rows from from mysql_affected_rows.
130 if (affected_rows >= 1)
132 rows = affected_rows;
133 fieldlists.resize(rows);
135 unsigned int field_count = 0;
140 while ((row = mysql_fetch_row(res)))
142 if (fieldlists.size() < (unsigned int)rows+1)
144 fieldlists.resize(fieldlists.size()+1);
147 MYSQL_FIELD *fields = mysql_fetch_fields(res);
148 if(mysql_num_fields(res) == 0)
150 if (fields && mysql_num_fields(res))
153 while (field_count < mysql_num_fields(res))
155 std::string a = (fields[field_count].name ? fields[field_count].name : "");
156 std::string b = (row[field_count] ? row[field_count] : "");
157 SQLfield sqlf(b, !row[field_count]);
158 colnames.push_back(a);
159 fieldlists[n].push_back(sqlf);
166 mysql_free_result(res);
171 MySQLresult(Module* self, Module* to, SQLerror e, unsigned int rid) : SQLresult(self, to, rid), currentrow(0)
188 return colnames.size();
191 virtual std::string ColName(int column)
193 if (column < (int)colnames.size())
195 return colnames[column];
199 throw SQLbadColName();
204 virtual int ColNum(const std::string &column)
206 for (unsigned int i = 0; i < colnames.size(); i++)
208 if (column == colnames[i])
211 throw SQLbadColName();
215 virtual SQLfield GetValue(int row, int column)
217 if ((row >= 0) && (row < rows) && (column >= 0) && (column < Cols()))
219 return fieldlists[row][column];
222 throw SQLbadColName();
224 /* XXX: We never actually get here because of the throw */
225 return SQLfield("",true);
228 virtual SQLfieldList& GetRow()
230 if (currentrow < rows)
231 return fieldlists[currentrow++];
233 return emptyfieldlist;
236 virtual SQLfieldMap& GetRowMap()
240 if (currentrow < rows)
242 for (int i = 0; i < Cols(); i++)
244 fieldmap2.insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
252 virtual SQLfieldList* GetRowPtr()
254 SQLfieldList* fieldlist = new SQLfieldList();
256 if (currentrow < rows)
258 for (int i = 0; i < Rows(); i++)
260 fieldlist->push_back(fieldlists[currentrow][i]);
267 virtual SQLfieldMap* GetRowMapPtr()
269 fieldmap = new SQLfieldMap();
271 if (currentrow < rows)
273 for (int i = 0; i < Cols(); i++)
275 fieldmap->insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
283 virtual void Free(SQLfieldMap* fm)
288 virtual void Free(SQLfieldList* fl)
294 /** Represents a connection to a mysql database
296 class SQLConnection : public classbase
303 std::map<std::string,std::string> thisrow;
306 std::string initquery;
313 // This constructor creates an SQLConnection object with the given credentials, but does not connect yet.
314 SQLConnection(const SQLhost &hi, ModuleSQL* Creator) : connection(NULL), host(hi), Enabled(false), Parent(Creator)
323 // This method connects to the database using the credentials supplied to the constructor, and returns
324 // true upon success.
327 unsigned int timeout = 1;
328 connection = mysql_init(connection);
329 mysql_options(connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
330 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);
333 void DoLeadingQuery()
335 if (!CheckConnection())
338 if( !initquery.empty() )
339 mysql_query(connection,initquery.c_str());
341 /* Parse the command string and dispatch it to mysql */
342 SQLrequest* req = queue.front();
344 /* Pointer to the buffer we screw around with substitution in */
347 /* Pointer to the current end of query, where we append new stuff */
350 /* Total length of the unescaped parameters */
351 unsigned long maxparamlen, paramcount;
353 /* The length of the longest parameter */
356 for(ParamL::iterator i = req->query.p.begin(); i != req->query.p.end(); i++)
358 if (i->size() > maxparamlen)
359 maxparamlen = i->size();
362 /* How many params are there in the query? */
363 paramcount = count(req->query.q.c_str(), '?');
365 /* This stores copy of params to be inserted with using numbered params 1;3B*/
366 ParamL paramscopy(req->query.p);
368 /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
369 * sizeofquery + (maxtotalparamlength*2) + 1
371 * The +1 is for null-terminating the string for mysql_real_escape_string
374 query = new char[req->query.q.length() + (maxparamlen*paramcount*2) + 1];
377 /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
378 * the parameters into it...
381 for(unsigned long i = 0; i < req->query.q.length(); i++)
383 if(req->query.q[i] == '?')
385 /* We found a place to substitute..what fun.
386 * use mysql calls to escape and write the
387 * escaped string onto the end of our query buffer,
388 * then we "just" need to make sure queryend is
389 * pointing at the right place.
392 /* Is it numbered parameter?
398 /* Numbered parameter number :|
400 unsigned int paramnum;
403 /* Let's check if it's a numbered param. And also calculate it's number.
406 while ((i < req->query.q.length() - 1) && (req->query.q[i+1] >= '0') && (req->query.q[i+1] <= '9'))
410 paramnum = paramnum * 10 + req->query.q[i] - '0';
413 if (paramnum > paramscopy.size() - 1)
415 /* index is out of range!
422 unsigned long len = mysql_real_escape_string(connection, queryend, paramscopy[paramnum].c_str(), paramscopy[paramnum].length());
426 else if (req->query.p.size())
428 unsigned long len = mysql_real_escape_string(connection, queryend, req->query.p.front().c_str(), req->query.p.front().length());
431 req->query.p.pop_front();
438 *queryend = req->query.q[i];
445 req->query.q = query;
447 if (!mysql_real_query(connection, req->query.q.data(), req->query.q.length()))
449 /* Successfull query */
450 res = mysql_use_result(connection);
451 unsigned long rows = mysql_affected_rows(connection);
452 MySQLresult* r = new MySQLresult(Parent, req->source, res, rows, req->id);
453 r->dbid = this->GetID();
454 r->query = req->query.q;
455 /* Put this new result onto the results queue.
456 * XXX: Remember to mutex the queue!
458 Parent->ResultsMutex.Lock();
460 Parent->ResultsMutex.Unlock();
464 /* XXX: See /usr/include/mysql/mysqld_error.h for a list of
465 * possible error numbers and error messages */
466 SQLerror e(SQL_QREPLY_FAIL, ConvToStr(mysql_errno(connection)) + std::string(": ") + mysql_error(connection));
467 MySQLresult* r = new MySQLresult(Parent, req->source, e, req->id);
468 r->dbid = this->GetID();
469 r->query = req->query.q;
471 Parent->ResultsMutex.Lock();
473 Parent->ResultsMutex.Unlock();
479 bool ConnectionLost()
483 return (mysql_ping(connection) != 0);
488 bool CheckConnection()
490 if (ConnectionLost())
497 std::string GetError()
499 return mysql_error(connection);
502 const std::string& GetID()
507 std::string GetHost()
512 void setInitialQuery(std::string init)
517 void SetEnable(bool Enable)
529 mysql_close(connection);
532 const SQLhost& GetConfHost()
541 bool HasHost(const SQLhost &host)
543 for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); iter++)
545 if (host == iter->second->GetConfHost())
551 bool HostInConf(const SQLhost &h)
554 for(int i = 0; i < conf.Enumerate("database"); i++)
557 host.id = conf.ReadValue("database", "id", i);
558 host.host = conf.ReadValue("database", "hostname", i);
559 host.port = conf.ReadInteger("database", "port", i, true);
560 host.name = conf.ReadValue("database", "name", i);
561 host.user = conf.ReadValue("database", "username", i);
562 host.pass = conf.ReadValue("database", "password", i);
563 host.ssl = conf.ReadFlag("database", "ssl", i);
570 void ClearOldConnections()
572 ConnMap::iterator i,safei;
573 for (i = Connections.begin(); i != Connections.end(); i++)
575 if (!HostInConf(i->second->GetConfHost()))
580 Connections.erase(safei);
585 void ClearAllConnections()
588 while ((i = Connections.begin()) != Connections.end())
590 Connections.erase(i);
595 void ConnectDatabases(ModuleSQL* Parent)
597 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
599 if (i->second->IsEnabled())
602 i->second->SetEnable(true);
603 if (!i->second->Connect())
606 Parent->LoggingMutex.Lock();
607 ServerInstance->Logs->Log("m_mysql",DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
608 i->second->SetEnable(false);
609 Parent->LoggingMutex.Unlock();
614 void LoadDatabases(ModuleSQL* Parent)
617 Parent->ConnMutex.Lock();
618 ClearOldConnections();
619 for (int j =0; j < conf.Enumerate("database"); j++)
622 host.id = conf.ReadValue("database", "id", j);
623 host.host = conf.ReadValue("database", "hostname", j);
624 host.port = conf.ReadInteger("database", "port", j, true);
625 host.name = conf.ReadValue("database", "name", j);
626 host.user = conf.ReadValue("database", "username", j);
627 host.pass = conf.ReadValue("database", "password", j);
628 host.ssl = conf.ReadFlag("database", "ssl", j);
629 std::string initquery = conf.ReadValue("database", "initialquery", j);
634 if (!host.id.empty() && !host.host.empty() && !host.name.empty() && !host.user.empty() && !host.pass.empty())
636 SQLConnection* ThisSQL = new SQLConnection(host, Parent);
637 Connections[host.id] = ThisSQL;
639 ThisSQL->setInitialQuery(initquery);
642 ConnectDatabases(Parent);
643 Parent->ConnMutex.Unlock();
646 char FindCharId(const std::string &id)
649 for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); ++iter, ++i)
651 if (iter->first == id)
659 ConnMap::iterator GetCharId(char id)
662 for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); ++iter, ++i)
667 return Connections.end();
670 class DispatcherThread : public SocketThread
673 ModuleSQL* const Parent;
675 DispatcherThread(ModuleSQL* CreatorModule) : Parent(CreatorModule) { }
676 ~DispatcherThread() { }
678 virtual void OnNotify();
681 ModuleSQL::ModuleSQL() : rehashing(false), sqlserv(this, "SQL/mysql", SERVICE_DATA)
685 Dispatcher = new DispatcherThread(this);
686 ServerInstance->Threads->Start(Dispatcher);
688 Implementation eventlist[] = { I_OnRehash };
689 ServerInstance->Modules->Attach(eventlist, this, 1);
692 ModuleSQL::~ModuleSQL()
695 ClearAllConnections();
698 unsigned long ModuleSQL::NewID()
705 void ModuleSQL::OnRequest(Request& request)
707 if(strcmp(SQLREQID, request.id) == 0)
709 SQLrequest* req = (SQLrequest*)&request;
711 ConnMap::iterator iter;
713 Dispatcher->LockQueue();
715 if((iter = Connections.find(req->dbid)) != Connections.end())
718 iter->second->queue.push(new SQLrequest(*req));
722 req->error.Id(SQL_BAD_DBID);
726 Dispatcher->UnlockQueueWakeup();
727 /* Yes, it's possible this will generate a spurious wakeup.
728 * That's fine, it'll just get ignored.
733 void ModuleSQL::OnRehash(User* user)
735 Dispatcher->LockQueue();
737 Dispatcher->UnlockQueueWakeup();
740 Version ModuleSQL::GetVersion()
742 return Version("SQL Service Provider module for all other m_sql* modules", VF_VENDOR);
745 void DispatcherThread::Run()
747 LoadDatabases(Parent);
749 SQLConnection* conn = NULL;
752 while (!this->GetExitFlag())
754 if (Parent->rehashing)
756 Parent->rehashing = false;
757 LoadDatabases(Parent);
761 Parent->ConnMutex.Lock();
762 for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
764 if (i->second->queue.totalsize())
770 Parent->ConnMutex.Unlock();
774 /* There's an item! */
776 conn->DoLeadingQuery();
777 this->NotifyParent();
783 /* We know the queue is empty, we can safely hang this thread until
786 this->WaitForQueue();
792 void DispatcherThread::OnNotify()
798 Parent->ConnMutex.Lock();
799 for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); iter++)
801 if (!iter->second->rq.empty())
807 Parent->ConnMutex.Unlock();
812 Parent->ResultsMutex.Lock();
813 ResultQueue::iterator n = conn->rq.begin();
814 Parent->ResultsMutex.Unlock();
819 Parent->ResultsMutex.Lock();
820 conn->rq.pop_front();
821 Parent->ResultsMutex.Unlock();
825 MODULE_INIT(ModuleSQL)