X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fextra%2Fm_mysql.cpp;h=ce0644e96fc3bfe9bf36ccc3d88719115aa93356;hb=5a88424dbb33ac825aa0b9b6525179329ee75519;hp=486b7e2f475c8a3add2da7065b8afac87736386c;hpb=ec787f412eddfa97e73c17a1ecad0b9e1b3efc06;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/extra/m_mysql.cpp b/src/modules/extra/m_mysql.cpp index 486b7e2f4..ce0644e96 100644 --- a/src/modules/extra/m_mysql.cpp +++ b/src/modules/extra/m_mysql.cpp @@ -23,20 +23,55 @@ 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` */ +/* $ModDep: m_sqlv2.h */ + +/* 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; @@ -50,6 +85,8 @@ int QueueFD = -1; typedef std::deque ResultQueue; +/** Represents a mysql query queue + */ class QueryQueue : public classbase { private: @@ -67,8 +104,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 @@ -165,6 +200,8 @@ pthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER; pthread_mutex_t results_mutex = PTHREAD_MUTEX_INITIALIZER; +/** Represents a mysql result set + */ class MySQLresult : public SQLresult { int currentrow; @@ -172,24 +209,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) @@ -201,23 +247,22 @@ 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) : SQLresult(self, to), currentrow(0), rows(0), cols(0) + MySQLresult(Module* self, Module* to, SQLerror e, unsigned int id) : SQLresult(self, to, id), currentrow(0) { + rows = 0; error = e; } @@ -232,7 +277,7 @@ class MySQLresult : public SQLresult virtual int Cols() { - return cols; + return colnames.size(); } virtual std::string ColName(int column) @@ -261,12 +306,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 */ @@ -275,36 +319,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; } @@ -316,11 +379,7 @@ 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; } }; @@ -328,6 +387,8 @@ class SQLConnection; void NotifyMainThread(SQLConnection* connection_with_new_result); +/** Represents a connection to a mysql database + */ class SQLConnection : public classbase { protected: @@ -348,16 +409,9 @@ class SQLConnection : public classbase 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, const std::string &myid) + // This constructor creates an SQLConnection object with the given credentials, but does not connect yet. + SQLConnection(const std::string &thishost, const std::string &thisuser, const std::string &thispass, const std::string &thisdb, const std::string &myid) : host(thishost), user(thisuser), pass(thispass), db(thisdb), Enabled(true), id(myid) { - this->Enabled = true; - this->host = thishost; - this->user = thisuser; - this->pass = thispass; - this->db = thisdb; - this->id = myid; } // This method connects to the database using the credentials supplied to the constructor, and returns @@ -372,9 +426,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; @@ -426,10 +482,7 @@ class SQLConnection : public classbase req.query.p.pop_front(); } else - { - log(DEBUG, "Found a substitution location but no parameter to substitute :|"); break; - } } else { @@ -441,10 +494,8 @@ 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())) @@ -452,7 +503,7 @@ class SQLConnection : public classbase /* Successfull query */ res = mysql_use_result(&connection); unsigned long rows = mysql_affected_rows(&connection); - MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), res, 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. @@ -466,8 +517,8 @@ class SQLConnection : public classbase { /* XXX: See /usr/include/mysql/mysqld_error.h for a list of * possible error numbers and error messages */ - SQLerror e((SQLerrorNum)mysql_errno(&connection), mysql_error(&connection)); - MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), e); + 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; @@ -480,6 +531,8 @@ class SQLConnection : public classbase * Pass them this connection id as what to examine */ + delete[] query; + NotifyMainThread(this); } @@ -528,29 +581,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->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()); + 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); @@ -558,16 +611,16 @@ 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,id); - Srv->Log(DEFAULT,"Loaded database: "+ThisSQL->GetHost()); + 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) @@ -581,26 +634,27 @@ void NotifyMainThread(SQLConnection* connection_with_new_result) * block if we like. We just send the connection id of the * connection back. */ - log(DEBUG,"Notify of result on connection: %s",connection_with_new_result->GetID().c_str()); - if (send(QueueFD, connection_with_new_result->GetID().c_str(), connection_with_new_result->GetID().length()+1, 0) < 1) // add one for null terminator - { - log(DEBUG,"Error writing to QueueFD: %s",strerror(errno)); - } - log(DEBUG,"Sent it on its way via fd=%d",QueueFD); + send(QueueFD, connection_with_new_result->GetID().c_str(), connection_with_new_result->GetID().length()+1, 0); } void* DispatcherThread(void* arg); +/** Used by m_mysql to notify one thread when the other has a result + */ class Notifier : public InspSocket { - sockaddr_in sock_us; + insp_sockaddr sock_us; socklen_t uslen; - Server* Srv; + public: /* Create a socket on a random port. Let the tcp stack allocate us an available port */ - Notifier(Server* S) : InspSocket("127.0.0.1", 0, true, 3000), Srv(S) +#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)) @@ -609,38 +663,42 @@ class Notifier : public InspSocket } } - Notifier(int newfd, char* ip, Server* S) : InspSocket(newfd, ip), Srv(S) + Notifier(InspIRCd* SI, int newfd, char* ip) : InspSocket(SI, newfd, ip) { - log(DEBUG,"Constructor of new socket"); + 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) { - log(DEBUG,"Inbound connection on fd %d!",newsock); - Notifier* n = new Notifier(newsock, ip, Srv); - Srv->AddSocket(n); + Instance->Log(DEBUG,"Inbound connection on fd %d!",newsock); + Notifier* n = new Notifier(this->Instance, newsock, ip); + n = n; /* Stop bitching at me, GCC */ return true; } virtual bool OnDataReady() { - log(DEBUG,"Inbound data!"); + Instance->Log(DEBUG,"Inbound data!"); char* data = this->Read(); ConnMap::iterator iter; if (data && *data) { - log(DEBUG,"Looking for connection %s",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()) { - log(DEBUG,"Found it!"); + Instance->Log(DEBUG,"Found it!"); /* Lock the mutex, send back the data */ pthread_mutex_lock(&results_mutex); @@ -656,11 +714,14 @@ class Notifier : public InspSocket } }; +/** MySQL module + */ class ModuleSQL : public Module { public: - Server *Srv; + ConfigReader *Conf; + InspIRCd* PublicServerInstance; pthread_t Dispatcher; int currid; @@ -678,7 +739,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; @@ -689,12 +750,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 @@ -708,22 +769,22 @@ 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(Srv); - Srv->AddSocket(MessagePipe); - log(DEBUG,"Bound notifier to 127.0.0.1:%d",MessagePipe->GetPort()); + MessagePipe = new Notifier(ServerInstance); + ServerInstance->Log(DEBUG,"Bound notifier to 127.0.0.1:%d",MessagePipe->GetPort()); pthread_attr_t attribs; pthread_attr_init(&attribs); @@ -732,8 +793,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() @@ -748,7 +813,7 @@ class ModuleSQL : public Module virtual Version GetVersion() { - return Version(1,1,0,0,VF_VENDOR|VF_SERVICEPROVIDER); + return Version(1,1,0,0,VF_VENDOR|VF_SERVICEPROVIDER,API_VERSION); } }; @@ -756,35 +821,36 @@ 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_INET, SOCK_STREAM, 0)) == -1) + if ((QueueFD = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1) { /* crap, we're out of sockets... */ - log(DEBUG,"QueueFD cant be created"); return NULL; } - log(DEBUG,"Initialize QueueFD to %d",QueueFD); + insp_sockaddr addr; - sockaddr_in addr; - in_addr ia; - inet_aton("127.0.0.1", &ia); - addr.sin_family = AF_INET; +#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! */ - log(DEBUG,"QueueFD cant connect!"); return NULL; } - log(DEBUG,"Connect QUEUE FD"); - while (!giveup) { SQLConnection* conn = NULL; @@ -804,7 +870,6 @@ void* DispatcherThread(void* arg) /* Theres an item! */ if (conn) { - log(DEBUG,"Process Leading query"); conn->DoLeadingQuery(); /* XXX: Lock */ @@ -834,7 +899,7 @@ class ModuleSQLFactory : public ModuleFactory { } - virtual Module * CreateModule(Server* Me) + virtual Module * CreateModule(InspIRCd* Me) { return new ModuleSQL(Me); } @@ -846,4 +911,3 @@ extern "C" void * init_module( void ) { return new ModuleSQLFactory; } -