X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fextra%2Fm_mysql.cpp;h=db68e17cd3fbafbf44d5f64963de41e710987955;hb=6050df73f498d05597fb37c6157868df1f6f4db2;hp=507702a4a1fe20f29e18184bf7d9ac0ce4dcb7c4;hpb=21fe5137706628f0dc67202caae2a71d1e97e8f6;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/extra/m_mysql.cpp b/src/modules/extra/m_mysql.cpp index 507702a4a..db68e17cd 100644 --- a/src/modules/extra/m_mysql.cpp +++ b/src/modules/extra/m_mysql.cpp @@ -23,27 +23,68 @@ using namespace std; #include "users.h" #include "channels.h" #include "modules.h" -#include "helperfuncs.h" + +#include "inspircd.h" #include "m_sqlv2.h" /* VERSION 2 API: With nonblocking (threaded) requests */ /* $ModDesc: SQL Service Provider module for all other m_sql* modules */ /* $CompileFlags: `mysql_config --include` */ -/* $LinkerFlags: `mysql_config --libs_r` `perl ../mysql_rpath.pl` */ +/* $LinkerFlags: `mysql_config --libs_r` `perl extra/mysql_rpath.pl` */ + +/* THE NONBLOCKING MYSQL API! + * + * MySQL provides no nonblocking (asyncronous) API of its own, and its developers recommend + * that instead, you should thread your program. This is what i've done here to allow for + * asyncronous SQL requests via mysql. The way this works is as follows: + * + * The module spawns a thread via pthreads, and performs its mysql queries in this thread, + * using a queue with priorities. There is a mutex on either end which prevents two threads + * adjusting the queue at the same time, and crashing the ircd. Every 50 milliseconds, the + * worker thread wakes up, and checks if there is a request at the head of its queue. + * If there is, it processes this request, blocking the worker thread but leaving the ircd + * thread to go about its business as usual. During this period, the ircd thread is able + * to insert futher pending requests into the queue. + * + * Once the processing of a request is complete, it is removed from the incoming queue to + * an outgoing queue, and initialized as a 'response'. The worker thread then signals the + * ircd thread (via a loopback socket) of the fact a result is available, by sending the + * connection ID through the connection. + * + * The ircd thread then mutexes the queue once more, reads the outbound response off the head + * of the queue, and sends it on its way to the original calling module. + * + * XXX: You might be asking "why doesnt he just send the response from within the worker thread?" + * The answer to this is simple. The majority of InspIRCd, and in fact most ircd's are not + * threadsafe. This module is designed to be threadsafe and is careful with its use of threads, + * however, if we were to call a module's OnRequest even from within a thread which was not the + * one the module was originally instantiated upon, there is a chance of all hell breaking loose + * if a module is ever put in a re-enterant state (stack corruption could occur, crashes, data + * corruption, and worse, so DONT think about it until the day comes when InspIRCd is 100% + * gauranteed threadsafe!) + * + * For a diagram of this system please see http://www.inspircd.org/wiki/Mysql2 + */ class SQLConnection; +class Notifier; + -extern InspIRCd* ServerInstance; typedef std::map ConnMap; bool giveup = false; +static Module* SQLModule = NULL; +static Notifier* MessagePipe = NULL; +int QueueFD = -1; #if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224 #define mysql_field_count mysql_num_fields #endif +typedef std::deque ResultQueue; + class QueryQueue : public classbase { private: @@ -61,8 +102,6 @@ public: void push(const SQLrequest &q) { - log(DEBUG, "QueryQueue::push(): Adding %s query to queue: %s", ((q.pri) ? "priority" : "non-priority"), q.query.q.c_str()); - if(q.pri) priority.push_back(q); else @@ -157,6 +196,8 @@ private: /* A mutex to wrap around queue accesses */ pthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER; +pthread_mutex_t results_mutex = PTHREAD_MUTEX_INITIALIZER; + class MySQLresult : public SQLresult { int currentrow; @@ -164,23 +205,33 @@ class MySQLresult : public SQLresult std::vector colnames; std::vector fieldlists; SQLfieldMap* fieldmap; + SQLfieldMap fieldmap2; + SQLfieldList emptyfieldlist; int rows; - int cols; + public: - MySQLresult(Module* self, Module* to, MYSQL_RES* res, int affected_rows) : SQLresult(self, to), currentrow(0), fieldmap(NULL) + MySQLresult(Module* self, Module* to, MYSQL_RES* res, int affected_rows, unsigned int id) : SQLresult(self, to, id), currentrow(0), fieldmap(NULL) { /* A number of affected rows from from mysql_affected_rows. */ fieldlists.clear(); - rows = affected_rows; - fieldlists.resize(rows); - unsigned int field_count; + rows = 0; + if (affected_rows >= 1) + { + rows = affected_rows; + fieldlists.resize(rows); + } + unsigned int field_count = 0; if (res) { MYSQL_ROW row; int n = 0; while ((row = mysql_fetch_row(res))) { + if (fieldlists.size() < (unsigned int)rows+1) + { + fieldlists.resize(fieldlists.size()+1); + } field_count = 0; MYSQL_FIELD *fields = mysql_fetch_fields(res); if(mysql_num_fields(res) == 0) @@ -192,19 +243,23 @@ class MySQLresult : public SQLresult { std::string a = (fields[field_count].name ? fields[field_count].name : ""); std::string b = (row[field_count] ? row[field_count] : ""); - SQLfield sqlf(a, !row[field_count]); + SQLfield sqlf(b, !row[field_count]); colnames.push_back(a); fieldlists[n].push_back(sqlf); field_count++; } n++; } + rows++; } - cols = mysql_num_fields(res); mysql_free_result(res); } - cols = field_count; - log(DEBUG, "Created new MySQL result; %d rows, %d columns", rows, cols); + } + + MySQLresult(Module* self, Module* to, SQLerror e, unsigned int id) : SQLresult(self, to, id), currentrow(0) + { + rows = 0; + error = e; } ~MySQLresult() @@ -218,7 +273,7 @@ class MySQLresult : public SQLresult virtual int Cols() { - return cols; + return colnames.size(); } virtual std::string ColName(int column) @@ -247,12 +302,11 @@ class MySQLresult : public SQLresult virtual SQLfield GetValue(int row, int column) { - if ((row >= 0) && (row < rows) && (column >= 0) && (column < cols)) + if ((row >= 0) && (row < rows) && (column >= 0) && (column < Cols())) { return fieldlists[row][column]; } - log(DEBUG,"Danger will robinson, we don't have row %d, column %d!", row, column); throw SQLbadColName(); /* XXX: We never actually get here because of the throw */ @@ -261,36 +315,55 @@ class MySQLresult : public SQLresult virtual SQLfieldList& GetRow() { - return fieldlists[currentrow]; + if (currentrow < rows) + return fieldlists[currentrow]; + else + return emptyfieldlist; } virtual SQLfieldMap& GetRowMap() { - fieldmap = new SQLfieldMap(); - - for (int i = 0; i < cols; i++) + fieldmap2.clear(); + + if (currentrow < rows) { - fieldmap->insert(std::make_pair(colnames[cols],GetValue(currentrow, i))); + for (int i = 0; i < Cols(); i++) + { + fieldmap2.insert(std::make_pair(colnames[i],GetValue(currentrow, i))); + } + currentrow++; } - currentrow++; - return *fieldmap; + return fieldmap2; } virtual SQLfieldList* GetRowPtr() { - return &fieldlists[currentrow++]; + SQLfieldList* fieldlist = new SQLfieldList(); + + if (currentrow < rows) + { + for (int i = 0; i < Rows(); i++) + { + fieldlist->push_back(fieldlists[currentrow][i]); + } + currentrow++; + } + return fieldlist; } virtual SQLfieldMap* GetRowMapPtr() { fieldmap = new SQLfieldMap(); - - for (int i = 0; i < cols; i++) + + if (currentrow < rows) { - fieldmap->insert(std::make_pair(colnames[cols],GetValue(currentrow, i))); + for (int i = 0; i < Cols(); i++) + { + fieldmap->insert(std::make_pair(colnames[i],GetValue(currentrow, i))); + } + currentrow++; } - currentrow++; return fieldmap; } @@ -302,14 +375,14 @@ class MySQLresult : public SQLresult virtual void Free(SQLfieldList* fl) { - /* XXX: Yes, this is SUPPOSED to do nothing, we - * dont want to free our fieldlist until we - * destruct the object. Unlike the pgsql module, - * we only have the one. - */ + delete fl; } }; +class SQLConnection; + +void NotifyMainThread(SQLConnection* connection_with_new_result); + class SQLConnection : public classbase { protected: @@ -323,15 +396,16 @@ class SQLConnection : public classbase std::string db; std::map thisrow; bool Enabled; - long id; + std::string id; public: QueryQueue queue; + ResultQueue rq; // This constructor creates an SQLConnection object with the given credentials, and creates the underlying // MYSQL struct, but does not connect yet. - SQLConnection(std::string thishost, std::string thisuser, std::string thispass, std::string thisdb, long myid) + SQLConnection(std::string thishost, std::string thisuser, std::string thispass, std::string thisdb, const std::string &myid) { this->Enabled = true; this->host = thishost; @@ -353,9 +427,11 @@ class SQLConnection : public classbase void DoLeadingQuery() { + if (!CheckConnection()) + return; + /* Parse the command string and dispatch it to mysql */ SQLrequest& req = queue.front(); - log(DEBUG,"DO QUERY: %s",req.query.q.c_str()); /* Pointer to the buffer we screw around with substitution in */ char* query; @@ -367,7 +443,7 @@ class SQLConnection : public classbase unsigned long paramlen; /* Total length of query, used for binary-safety in mysql_real_query */ - unsigned long querylength; + unsigned long querylength = 0; paramlen = 0; @@ -407,10 +483,7 @@ class SQLConnection : public classbase req.query.p.pop_front(); } else - { - log(DEBUG, "Found a substitution location but no parameter to substitute :|"); break; - } } else { @@ -422,93 +495,44 @@ class SQLConnection : public classbase *queryend = 0; - log(DEBUG, "Attempting to dispatch query: %s", query); - pthread_mutex_lock(&queue_mutex); - req.query.q = std::string(query,querylength); + req.query.q = query; pthread_mutex_unlock(&queue_mutex); if (!mysql_real_query(&connection, req.query.q.data(), req.query.q.length())) { /* Successfull query */ res = mysql_use_result(&connection); - } - - - } - - // This method issues a query that expects multiple rows of results. Use GetRow() and QueryDone() to retrieve - // multiple rows. - bool QueryResult(std::string query) - { - if (!CheckConnection()) return false; - - int r = mysql_query(&connection, query.c_str()); - if (!r) - { - res = mysql_use_result(&connection); - } - return (!r); - } - - // This method issues a query that just expects a number of 'effected' rows (e.g. UPDATE or DELETE FROM). - // the number of effected rows is returned in the return value. - long QueryCount(std::string query) - { - /* If the connection is down, we return a negative value - New to 1.1 */ - if (!CheckConnection()) return -1; - - int r = mysql_query(&connection, query.c_str()); - if (!r) - { - res = mysql_store_result(&connection); unsigned long rows = mysql_affected_rows(&connection); - mysql_free_result(res); - return rows; + MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), res, rows, req.id); + r->dbid = this->GetID(); + r->query = req.query.q; + /* Put this new result onto the results queue. + * XXX: Remember to mutex the queue! + */ + pthread_mutex_lock(&results_mutex); + rq.push_back(r); + pthread_mutex_unlock(&results_mutex); } - return 0; - } - - // This method fetches a row, if available from the database. You must issue a query - // using QueryResult() first! The row's values are returned as a map of std::string - // where each item is keyed by the column name. - std::map GetRow() - { - thisrow.clear(); - if (res) + else { - row = mysql_fetch_row(res); - if (row) - { - unsigned int field_count = 0; - MYSQL_FIELD *fields = mysql_fetch_fields(res); - if(mysql_field_count(&connection) == 0) - return thisrow; - if (fields && mysql_field_count(&connection)) - { - while (field_count < mysql_field_count(&connection)) - { - std::string a = (fields[field_count].name ? fields[field_count].name : ""); - std::string b = (row[field_count] ? row[field_count] : ""); - thisrow[a] = b; - field_count++; - } - return thisrow; - } - } + /* XXX: See /usr/include/mysql/mysqld_error.h for a list of + * possible error numbers and error messages */ + SQLerror e(QREPLY_FAIL, ConvToStr(mysql_errno(&connection)) + std::string(": ") + mysql_error(&connection)); + MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), e, req.id); + r->dbid = this->GetID(); + r->query = req.query.q; + + pthread_mutex_lock(&results_mutex); + rq.push_back(r); + pthread_mutex_unlock(&results_mutex); } - return thisrow; - } - bool QueryDone() - { - if (res) - { - mysql_free_result(res); - res = NULL; - return true; - } - else return false; + /* Now signal the main thread that we've got a result to process. + * Pass them this connection id as what to examine + */ + + NotifyMainThread(this); } bool ConnectionLost() @@ -532,7 +556,7 @@ class SQLConnection : public classbase return mysql_error(&connection); } - long GetID() + const std::string& GetID() { return id; } @@ -542,14 +566,9 @@ class SQLConnection : public classbase return host; } - void Enable() + void SetEnable(bool Enable) { - Enabled = true; - } - - void Disable() - { - Enabled = false; + Enabled = Enable; } bool IsEnabled() @@ -561,29 +580,29 @@ class SQLConnection : public classbase ConnMap Connections; -void ConnectDatabases(Server* Srv) +void ConnectDatabases(InspIRCd* ServerInstance) { for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++) { - i->second->Enable(); + i->second->SetEnable(true); if (i->second->Connect()) { - Srv->Log(DEFAULT,"SQL: Successfully connected database "+i->second->GetHost()); + ServerInstance->Log(DEFAULT,"SQL: Successfully connected database "+i->second->GetHost()); } else { - Srv->Log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError()); - i->second->Disable(); + ServerInstance->Log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError()); + i->second->SetEnable(false); } } } -void LoadDatabases(ConfigReader* ThisConf, Server* Srv) +void LoadDatabases(ConfigReader* ThisConf, InspIRCd* ServerInstance) { - Srv->Log(DEFAULT,"SQL: Loading database settings"); + ServerInstance->Log(DEFAULT,"SQL: Loading database settings"); Connections.clear(); - Srv->Log(DEBUG,"Cleared connections"); + ServerInstance->Log(DEBUG,"Cleared connections"); for (int j =0; j < ThisConf->Enumerate("database"); j++) { std::string db = ThisConf->ReadValue("database","name",j); @@ -591,25 +610,113 @@ void LoadDatabases(ConfigReader* ThisConf, Server* Srv) std::string pass = ThisConf->ReadValue("database","password",j); std::string host = ThisConf->ReadValue("database","hostname",j); std::string id = ThisConf->ReadValue("database","id",j); - Srv->Log(DEBUG,"Read database settings"); + ServerInstance->Log(DEBUG,"Read database settings"); if ((db != "") && (host != "") && (user != "") && (id != "") && (pass != "")) { - SQLConnection* ThisSQL = new SQLConnection(host,user,pass,db,atoi(id.c_str())); - Srv->Log(DEFAULT,"Loaded database: "+ThisSQL->GetHost()); + SQLConnection* ThisSQL = new SQLConnection(host,user,pass,db,id); + ServerInstance->Log(DEFAULT,"Loaded database: "+ThisSQL->GetHost()); Connections[id] = ThisSQL; - Srv->Log(DEBUG,"Pushed back connection"); + ServerInstance->Log(DEBUG,"Pushed back connection"); } } - ConnectDatabases(Srv); + ConnectDatabases(ServerInstance); +} + +void NotifyMainThread(SQLConnection* connection_with_new_result) +{ + /* Here we write() to the socket the main thread has open + * and we connect()ed back to before our thread became active. + * The main thread is using a nonblocking socket tied into + * the socket engine, so they wont block and they'll receive + * nearly instant notification. Because we're in a seperate + * thread, we can just use standard connect(), and we can + * block if we like. We just send the connection id of the + * connection back. + */ + send(QueueFD, connection_with_new_result->GetID().c_str(), connection_with_new_result->GetID().length()+1, 0); } void* DispatcherThread(void* arg); +class Notifier : public InspSocket +{ + insp_sockaddr sock_us; + socklen_t uslen; + + + public: + + /* Create a socket on a random port. Let the tcp stack allocate us an available port */ +#ifdef IPV6 + Notifier(InspIRCd* SI) : InspSocket(SI, "::1", 0, true, 3000) +#else + Notifier(InspIRCd* SI) : InspSocket(SI, "127.0.0.1", 0, true, 3000) +#endif + { + uslen = sizeof(sock_us); + if (getsockname(this->fd,(sockaddr*)&sock_us,&uslen)) + { + throw ModuleException("Could not create random listening port on localhost"); + } + } + + Notifier(InspIRCd* SI, int newfd, char* ip) : InspSocket(SI, newfd, ip) + { + Instance->Log(DEBUG,"Constructor of new socket"); + } + + /* Using getsockname and ntohs, we can determine which port number we were allocated */ + int GetPort() + { +#ifdef IPV6 + return ntohs(sock_us.sin6_port); +#else + return ntohs(sock_us.sin_port); +#endif + } + + virtual int OnIncomingConnection(int newsock, char* ip) + { + Instance->Log(DEBUG,"Inbound connection on fd %d!",newsock); + Notifier* n = new Notifier(this->Instance, newsock, ip); + this->Instance->AddSocket(n); + return true; + } + + virtual bool OnDataReady() + { + Instance->Log(DEBUG,"Inbound data!"); + char* data = this->Read(); + ConnMap::iterator iter; + + if (data && *data) + { + Instance->Log(DEBUG,"Looking for connection %s",data); + /* We expect to be sent a null terminated string */ + if((iter = Connections.find(data)) != Connections.end()) + { + Instance->Log(DEBUG,"Found it!"); + + /* Lock the mutex, send back the data */ + pthread_mutex_lock(&results_mutex); + ResultQueue::iterator n = iter->second->rq.begin(); + (*n)->Send(); + iter->second->rq.pop_front(); + pthread_mutex_unlock(&results_mutex); + return true; + } + } + + return false; + } +}; + class ModuleSQL : public Module { public: - Server *Srv; + ConfigReader *Conf; + InspIRCd* PublicServerInstance; pthread_t Dispatcher; int currid; @@ -627,7 +734,7 @@ class ModuleSQL : public Module char* OnRequest(Request* request) { - if(strcmp(SQLREQID, request->GetData()) == 0) + if(strcmp(SQLREQID, request->GetId()) == 0) { SQLrequest* req = (SQLrequest*)request; @@ -638,12 +745,12 @@ class ModuleSQL : public Module char* returnval = NULL; - 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()); + 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()); if((iter = Connections.find(req->dbid)) != Connections.end()) { - iter->second->queue.push(*req); req->id = NewID(); + iter->second->queue.push(*req); returnval = SQLSUCCESS; } else @@ -657,17 +764,24 @@ class ModuleSQL : public Module return returnval; } - log(DEBUG, "Got unsupported API version string: %s", request->GetData()); + ServerInstance->Log(DEBUG, "Got unsupported API version string: %s", request->GetId()); return NULL; } - ModuleSQL(Server* Me) + ModuleSQL(InspIRCd* Me) : Module::Module(Me) { - Srv = Me; - Conf = new ConfigReader(); + + Conf = new ConfigReader(ServerInstance); + PublicServerInstance = ServerInstance; currid = 0; + SQLModule = this; + + MessagePipe = new Notifier(ServerInstance); + ServerInstance->AddSocket(MessagePipe); + ServerInstance->Log(DEBUG,"Bound notifier to 127.0.0.1:%d",MessagePipe->GetPort()); + pthread_attr_t attribs; pthread_attr_init(&attribs); pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED); @@ -675,8 +789,12 @@ class ModuleSQL : public Module { throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno))); } - Srv->PublishFeature("SQL", this); - Srv->PublishFeature("MySQL", this); + if (!ServerInstance->PublishFeature("SQL", this)) + { + /* Tell worker thread to exit NOW */ + giveup = true; + throw ModuleException("m_mysql: Unable to publish feature 'SQL'"); + } } virtual ~ModuleSQL() @@ -699,7 +817,35 @@ class ModuleSQL : public Module void* DispatcherThread(void* arg) { ModuleSQL* thismodule = (ModuleSQL*)arg; - LoadDatabases(thismodule->Conf, thismodule->Srv); + LoadDatabases(thismodule->Conf, thismodule->PublicServerInstance); + + /* Connect back to the Notifier */ + + if ((QueueFD = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1) + { + /* crap, we're out of sockets... */ + return NULL; + } + + insp_sockaddr addr; + +#ifdef IPV6 + insp_aton("::1", &addr.sin6_addr); + addr.sin6_family = AF_FAMILY; + addr.sin6_port = htons(MessagePipe->GetPort()); +#else + insp_inaddr ia; + insp_aton("127.0.0.1", &ia); + addr.sin_family = AF_FAMILY; + addr.sin_addr = ia; + addr.sin_port = htons(MessagePipe->GetPort()); +#endif + + if (connect(QueueFD, (sockaddr*)&addr,sizeof(addr)) == -1) + { + /* wtf, we cant connect to it, but we just created it! */ + return NULL; + } while (!giveup) { @@ -749,7 +895,7 @@ class ModuleSQLFactory : public ModuleFactory { } - virtual Module * CreateModule(Server* Me) + virtual Module * CreateModule(InspIRCd* Me) { return new ModuleSQL(Me); } @@ -761,4 +907,3 @@ extern "C" void * init_module( void ) { return new ModuleSQLFactory; } -