* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2004 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
*/
-using namespace std;
+/* Stop mysql wanting to use long long */
+#define NO_CLIENT_LONG_LONG
-#include <stdio.h>
-#include <string>
+#include "inspircd.h"
#include <mysql.h>
-#include <pthread.h>
#include "users.h"
#include "channels.h"
#include "modules.h"
-#include "helperfuncs.h"
#include "m_sqlv2.h"
+#ifdef WINDOWS
+#pragma comment(lib, "mysqlclient.lib")
+#endif
+
/* 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` */
+/* $CompileFlags: exec("mysql_config --include") */
+/* $LinkerFlags: exec("mysql_config --libs_r") rpath("mysql_config --libs_r") */
+/* $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 class Thread, 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 MySQLListener;
+
-extern InspIRCd* ServerInstance;
typedef std::map<std::string, SQLConnection*> ConnMap;
-bool giveup = false;
+static MySQLListener *MessagePipe = NULL;
+int QueueFD = -1;
+
+class DispatcherThread;
+
+/** MySQL module
+ * */
+class ModuleSQL : public Module
+{
+ public:
+
+ ConfigReader *Conf;
+ InspIRCd* PublicServerInstance;
+ int currid;
+ bool rehashing;
+ DispatcherThread* Dispatcher;
+ Mutex* QueueMutex;
+ Mutex* ResultsMutex;
+ Mutex* LoggingMutex;
+
+ ModuleSQL(InspIRCd* Me);
+ ~ModuleSQL();
+ unsigned long NewID();
+ const char* OnRequest(Request* request);
+ void OnRehash(User* user, const std::string ¶meter);
+ Version GetVersion();
+};
+
#if !defined(MYSQL_VERSION_ID) || MYSQL_VERSION_ID<32224
#define mysql_field_count mysql_num_fields
#endif
-class QueryQueue : public classbase
+typedef std::deque<SQLresult*> ResultQueue;
+
+/** Represents a mysql result set
+ */
+class MySQLresult : public SQLresult
{
-private:
- typedef std::deque<SQLrequest> ReqDeque;
+ int currentrow;
+ std::vector<std::string> colnames;
+ std::vector<SQLfieldList> fieldlists;
+ SQLfieldMap* fieldmap;
+ SQLfieldMap fieldmap2;
+ SQLfieldList emptyfieldlist;
+ int rows;
+ public:
- ReqDeque priority; /* The priority queue */
- ReqDeque normal; /* The 'normal' queue */
- enum { PRI, NOR, NON } which; /* Which queue the currently active element is at the front of */
+ MySQLresult(Module* self, Module* to, MYSQL_RES* res, int affected_rows, unsigned int rid) : SQLresult(self, to, rid), currentrow(0), fieldmap(NULL)
+ {
+ /* A number of affected rows from from mysql_affected_rows.
+ */
+ fieldlists.clear();
+ 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)
+ break;
+ if (fields && mysql_num_fields(res))
+ {
+ colnames.clear();
+ while (field_count < mysql_num_fields(res))
+ {
+ std::string a = (fields[field_count].name ? fields[field_count].name : "");
+ std::string b = (row[field_count] ? row[field_count] : "");
+ SQLfield sqlf(b, !row[field_count]);
+ colnames.push_back(a);
+ fieldlists[n].push_back(sqlf);
+ field_count++;
+ }
+ n++;
+ }
+ rows++;
+ }
+ mysql_free_result(res);
+ }
+ }
-public:
- QueryQueue()
- : which(NON)
+ MySQLresult(Module* self, Module* to, SQLerror e, unsigned int rid) : SQLresult(self, to, rid), currentrow(0)
{
+ rows = 0;
+ error = e;
}
- void push(const SQLrequest &q)
+ ~MySQLresult()
{
- 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
- normal.push_back(q);
+ virtual int Rows()
+ {
+ return rows;
}
- void pop()
+ virtual int Cols()
{
- if((which == PRI) && priority.size())
+ return colnames.size();
+ }
+
+ virtual std::string ColName(int column)
+ {
+ if (column < (int)colnames.size())
{
- priority.pop_front();
+ return colnames[column];
}
- else if((which == NOR) && normal.size())
+ else
{
- normal.pop_front();
+ throw SQLbadColName();
}
-
- /* Reset this */
- which = NON;
-
- /* Silently do nothing if there was no element to pop() */
+ return "";
}
- SQLrequest& front()
+ virtual int ColNum(const std::string &column)
{
- switch(which)
+ for (unsigned int i = 0; i < colnames.size(); i++)
{
- case PRI:
- return priority.front();
- case NOR:
- return normal.front();
- default:
- if(priority.size())
- {
- which = PRI;
- return priority.front();
- }
+ if (column == colnames[i])
+ return i;
+ }
+ throw SQLbadColName();
+ return 0;
+ }
- if(normal.size())
- {
- which = NOR;
- return normal.front();
- }
+ virtual SQLfield GetValue(int row, int column)
+ {
+ if ((row >= 0) && (row < rows) && (column >= 0) && (column < Cols()))
+ {
+ return fieldlists[row][column];
+ }
- /* This will probably result in a segfault,
- * but the caller should have checked totalsize()
- * first so..meh - moron :p
- */
+ throw SQLbadColName();
- return priority.front();
- }
+ /* XXX: We never actually get here because of the throw */
+ return SQLfield("",true);
}
- std::pair<int, int> size()
+ virtual SQLfieldList& GetRow()
{
- return std::make_pair(priority.size(), normal.size());
+ if (currentrow < rows)
+ return fieldlists[currentrow++];
+ else
+ return emptyfieldlist;
}
- int totalsize()
+ virtual SQLfieldMap& GetRowMap()
{
- return priority.size() + normal.size();
+ fieldmap2.clear();
+
+ if (currentrow < rows)
+ {
+ for (int i = 0; i < Cols(); i++)
+ {
+ fieldmap2.insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
+ }
+ currentrow++;
+ }
+
+ return fieldmap2;
}
- void PurgeModule(Module* mod)
+ virtual SQLfieldList* GetRowPtr()
{
- DoPurgeModule(mod, priority);
- DoPurgeModule(mod, normal);
+ SQLfieldList* fieldlist = new SQLfieldList();
+
+ if (currentrow < rows)
+ {
+ for (int i = 0; i < Rows(); i++)
+ {
+ fieldlist->push_back(fieldlists[currentrow][i]);
+ }
+ currentrow++;
+ }
+ return fieldlist;
}
-private:
- void DoPurgeModule(Module* mod, ReqDeque& q)
+ virtual SQLfieldMap* GetRowMapPtr()
{
- for(ReqDeque::iterator iter = q.begin(); iter != q.end(); iter++)
+ fieldmap = new SQLfieldMap();
+
+ if (currentrow < rows)
{
- if(iter->GetSource() == mod)
+ for (int i = 0; i < Cols(); i++)
{
- if(iter->id == front().id)
- {
- /* It's the currently active query.. :x */
- iter->SetSource(NULL);
- }
- else
- {
- /* It hasn't been executed yet..just remove it */
- iter = q.erase(iter);
- }
+ fieldmap->insert(std::make_pair(colnames[i],GetValue(currentrow, i)));
}
+ currentrow++;
}
+
+ return fieldmap;
+ }
+
+ virtual void Free(SQLfieldMap* fm)
+ {
+ delete fm;
+ }
+
+ virtual void Free(SQLfieldList* fl)
+ {
+ delete fl;
}
};
-/* A mutex to wrap around queue accesses */
-pthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER;
+class SQLConnection;
+
+void NotifyMainThread(SQLConnection* connection_with_new_result);
+/** Represents a connection to a mysql database
+ */
class SQLConnection : public classbase
{
protected:
MYSQL connection;
MYSQL_RES *res;
MYSQL_ROW row;
- std::string host;
- std::string user;
- std::string pass;
- std::string db;
+ SQLhost host;
std::map<std::string,std::string> thisrow;
bool Enabled;
- long id;
+ ModuleSQL* Parent;
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)
+ // This constructor creates an SQLConnection object with the given credentials, but does not connect yet.
+ SQLConnection(const SQLhost &hi, ModuleSQL* Creator) : host(hi), Enabled(false), Parent(Creator)
{
- this->Enabled = true;
- this->host = thishost;
- this->user = thisuser;
- this->pass = thispass;
- this->db = thisdb;
- this->id = myid;
+ }
+
+ ~SQLConnection()
+ {
+ Close();
}
// This method connects to the database using the credentials supplied to the constructor, and returns
unsigned int timeout = 1;
mysql_init(&connection);
mysql_options(&connection,MYSQL_OPT_CONNECT_TIMEOUT,(char*)&timeout);
- return mysql_real_connect(&connection, host.c_str(), user.c_str(), pass.c_str(), db.c_str(), 0, NULL, 0);
+ 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);
}
void DoLeadingQuery()
{
- SQLrequest& query = queue.front();
- log(DEBUG,"DO QUERY: %s",query.query.q.c_str());
- }
+ if (!CheckConnection())
+ return;
- // 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);
- }
+ /* Parse the command string and dispatch it to mysql */
+ SQLrequest& req = queue.front();
- // 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;
+ /* Pointer to the buffer we screw around with substitution in */
+ char* query;
+
+ /* Pointer to the current end of query, where we append new stuff */
+ char* queryend;
+
+ /* Total length of the unescaped parameters */
+ unsigned long paramlen;
+
+ /* Total length of query, used for binary-safety in mysql_real_query */
+ unsigned long querylength = 0;
- int r = mysql_query(&connection, query.c_str());
- if (!r)
+ paramlen = 0;
+
+ for(ParamL::iterator i = req.query.p.begin(); i != req.query.p.end(); i++)
{
- res = mysql_store_result(&connection);
- unsigned long rows = mysql_affected_rows(&connection);
- mysql_free_result(res);
- return rows;
+ paramlen += i->size();
}
- 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<std::string,std::string> GetRow()
- {
- thisrow.clear();
- if (res)
+ /* To avoid a lot of allocations, allocate enough memory for the biggest the escaped query could possibly be.
+ * sizeofquery + (totalparamlength*2) + 1
+ *
+ * The +1 is for null-terminating the string for mysql_real_escape_string
+ */
+
+ query = new char[req.query.q.length() + (paramlen*2) + 1];
+ queryend = query;
+
+ /* Okay, now we have a buffer large enough we need to start copying the query into it and escaping and substituting
+ * the parameters into it...
+ */
+
+ for(unsigned long i = 0; i < req.query.q.length(); i++)
{
- row = mysql_fetch_row(res);
- if (row)
+ if(req.query.q[i] == '?')
{
- 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))
+ /* We found a place to substitute..what fun.
+ * use mysql calls to escape and write the
+ * escaped string onto the end of our query buffer,
+ * then we "just" need to make sure queryend is
+ * pointing at the right place.
+ */
+ if(req.query.p.size())
{
- 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;
+ unsigned long len = mysql_real_escape_string(&connection, queryend, req.query.p.front().c_str(), req.query.p.front().length());
+
+ queryend += len;
+ req.query.p.pop_front();
}
+ else
+ break;
+ }
+ else
+ {
+ *queryend = req.query.q[i];
+ queryend++;
}
+ querylength++;
}
- return thisrow;
- }
- bool QueryDone()
- {
- if (res)
+ *queryend = 0;
+
+ Parent->QueueMutex->Lock();
+ req.query.q = query;
+ Parent->QueueMutex->Unlock();
+
+ if (!mysql_real_query(&connection, req.query.q.data(), req.query.q.length()))
{
- mysql_free_result(res);
- res = NULL;
- return true;
+ /* Successfull query */
+ res = mysql_use_result(&connection);
+ unsigned long rows = mysql_affected_rows(&connection);
+ MySQLresult* r = new MySQLresult(Parent, 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!
+ */
+ Parent->ResultsMutex->Lock();
+ rq.push_back(r);
+ Parent->ResultsMutex->Unlock();
}
- else return false;
+ else
+ {
+ /* XXX: See /usr/include/mysql/mysqld_error.h for a list of
+ * possible error numbers and error messages */
+ SQLerror e(SQL_QREPLY_FAIL, ConvToStr(mysql_errno(&connection)) + std::string(": ") + mysql_error(&connection));
+ MySQLresult* r = new MySQLresult(Parent, req.GetSource(), e, req.id);
+ r->dbid = this->GetID();
+ r->query = req.query.q;
+
+ Parent->ResultsMutex->Lock();
+ rq.push_back(r);
+ Parent->ResultsMutex->Unlock();
+ }
+
+ /* Now signal the main thread that we've got a result to process.
+ * Pass them this connection id as what to examine
+ */
+
+ delete[] query;
+
+ NotifyMainThread(this);
}
bool ConnectionLost()
return mysql_error(&connection);
}
- long GetID()
+ const std::string& GetID()
{
- return id;
+ return host.id;
}
std::string GetHost()
{
- return host;
+ return host.host;
}
- void Enable()
+ void SetEnable(bool Enable)
{
- Enabled = true;
+ Enabled = Enable;
}
- void Disable()
+ bool IsEnabled()
{
- Enabled = false;
+ return Enabled;
}
- bool IsEnabled()
+ void Close()
{
- return Enabled;
+ mysql_close(&connection);
+ }
+
+ const SQLhost& GetConfHost()
+ {
+ return host;
}
};
ConnMap Connections;
-void ConnectDatabases(Server* Srv)
+bool HasHost(const SQLhost &host)
{
- for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
+ for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); iter++)
+ {
+ if (host == iter->second->GetConfHost())
+ return true;
+ }
+ return false;
+}
+
+bool HostInConf(ConfigReader* conf, const SQLhost &h)
+{
+ for(int i = 0; i < conf->Enumerate("database"); i++)
+ {
+ SQLhost host;
+ host.id = conf->ReadValue("database", "id", i);
+ host.host = conf->ReadValue("database", "hostname", i);
+ host.port = conf->ReadInteger("database", "port", i, true);
+ host.name = conf->ReadValue("database", "name", i);
+ host.user = conf->ReadValue("database", "username", i);
+ host.pass = conf->ReadValue("database", "password", i);
+ host.ssl = conf->ReadFlag("database", "ssl", i);
+ if (h == host)
+ return true;
+ }
+ return false;
+}
+
+void ClearOldConnections(ConfigReader* conf)
+{
+ ConnMap::iterator i,safei;
+ for (i = Connections.begin(); i != Connections.end(); i++)
{
- i->second->Enable();
- if (i->second->Connect())
+ if (!HostInConf(conf, i->second->GetConfHost()))
{
- Srv->Log(DEFAULT,"SQL: Successfully connected database "+i->second->GetHost());
+ delete i->second;
+ safei = i;
+ --i;
+ Connections.erase(safei);
}
- else
+ }
+}
+
+void ClearAllConnections()
+{
+ ConnMap::iterator i;
+ while ((i = Connections.begin()) != Connections.end())
+ {
+ Connections.erase(i);
+ delete i->second;
+ }
+}
+
+void ConnectDatabases(InspIRCd* ServerInstance, ModuleSQL* Parent)
+{
+ for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
+ {
+ if (i->second->IsEnabled())
+ continue;
+
+ i->second->SetEnable(true);
+ if (!i->second->Connect())
{
- Srv->Log(DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
- i->second->Disable();
+ /* XXX: MUTEX */
+ Parent->LoggingMutex->Lock();
+ ServerInstance->Logs->Log("m_mysql",DEFAULT,"SQL: Failed to connect database "+i->second->GetHost()+": Error: "+i->second->GetError());
+ i->second->SetEnable(false);
+ Parent->LoggingMutex->Unlock();
}
}
}
+void LoadDatabases(ConfigReader* conf, InspIRCd* ServerInstance, ModuleSQL* Parent)
+{
+ ClearOldConnections(conf);
+ for (int j =0; j < conf->Enumerate("database"); j++)
+ {
+ SQLhost host;
+ host.id = conf->ReadValue("database", "id", j);
+ host.host = conf->ReadValue("database", "hostname", j);
+ host.port = conf->ReadInteger("database", "port", j, true);
+ host.name = conf->ReadValue("database", "name", j);
+ host.user = conf->ReadValue("database", "username", j);
+ host.pass = conf->ReadValue("database", "password", j);
+ host.ssl = conf->ReadFlag("database", "ssl", j);
+
+ if (HasHost(host))
+ continue;
+
+ if (!host.id.empty() && !host.host.empty() && !host.name.empty() && !host.user.empty() && !host.pass.empty())
+ {
+ SQLConnection* ThisSQL = new SQLConnection(host, Parent);
+ Connections[host.id] = ThisSQL;
+ }
+ }
+ ConnectDatabases(ServerInstance, Parent);
+}
-void LoadDatabases(ConfigReader* ThisConf, Server* Srv)
+char FindCharId(const std::string &id)
{
- Srv->Log(DEFAULT,"SQL: Loading database settings");
- Connections.clear();
- Srv->Log(DEBUG,"Cleared connections");
- for (int j =0; j < ThisConf->Enumerate("database"); j++)
- {
- std::string db = ThisConf->ReadValue("database","name",j);
- std::string user = ThisConf->ReadValue("database","username",j);
- 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");
- if ((db != "") && (host != "") && (user != "") && (id != "") && (pass != ""))
+ char i = 1;
+ for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); ++iter, ++i)
+ {
+ if (iter->first == id)
{
- SQLConnection* ThisSQL = new SQLConnection(host,user,pass,db,atoi(id.c_str()));
- Srv->Log(DEFAULT,"Loaded database: "+ThisSQL->GetHost());
- Connections[id] = ThisSQL;
- Srv->Log(DEBUG,"Pushed back connection");
+ return i;
}
}
- ConnectDatabases(Srv);
+ return 0;
}
-void* DispatcherThread(void* arg);
+ConnMap::iterator GetCharId(char id)
+{
+ char i = 1;
+ for (ConnMap::iterator iter = Connections.begin(); iter != Connections.end(); ++iter, ++i)
+ {
+ if (i == id)
+ return iter;
+ }
+ return Connections.end();
+}
-class ModuleSQL : public Module
+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.
+ *
+ * NOTE: We only send a single char down the connection, this
+ * way we know it wont get a partial read at the other end if
+ * the system is especially congested (see bug #263).
+ * The function FindCharId translates a connection name into a
+ * one character id, and GetCharId translates a character id
+ * back into an iterator.
+ */
+ char id = FindCharId(connection_with_new_result->GetID());
+ send(QueueFD, &id, 1, 0);
+}
+
+class ModuleSQL;
+
+class DispatcherThread : public Thread
{
+ private:
+ ModuleSQL* Parent;
+ InspIRCd* ServerInstance;
public:
- Server *Srv;
- ConfigReader *Conf;
- pthread_t Dispatcher;
- int currid;
+ DispatcherThread(InspIRCd* Instance, ModuleSQL* CreatorModule) : Thread(), Parent(CreatorModule), ServerInstance(Instance) { }
+ ~DispatcherThread() { }
+ virtual void Run();
+};
+
+/** Used by m_mysql to notify one thread when the other has a result
+ */
+class Notifier : public BufferedSocket
+{
+ ModuleSQL* Parent;
+
+ public:
+ Notifier(InspIRCd* SI, int newfd, char* ip) : BufferedSocket(SI, newfd, ip) { }
+
+ virtual bool OnDataReady()
+ {
+ char data = 0;
+ /* NOTE: Only a single character is read so we know we
+ * cant get a partial read. (We've been told that theres
+ * data waiting, so we wont ever get EAGAIN)
+ * The function GetCharId translates a single character
+ * back into an iterator.
+ */
+ if (Instance->SE->Recv(this, &data, 1, 0) > 0)
+ {
+ ConnMap::iterator iter = GetCharId(data);
+ if (iter != Connections.end())
+ {
+ /* Lock the mutex, send back the data */
+ Parent->ResultsMutex->Lock();
+ ResultQueue::iterator n = iter->second->rq.begin();
+ (*n)->Send();
+ delete (*n);
+ iter->second->rq.pop_front();
+ Parent->ResultsMutex->Unlock();
+ return true;
+ }
+ /* No error, but unknown id */
+ return true;
+ }
+
+ /* Erk, error on descriptor! */
+ return false;
+ }
+};
+
+/** Spawn sockets from a listener
+ */
+class MySQLListener : public ListenSocketBase
+{
+ insp_sockaddr sock_us;
+ socklen_t uslen;
+ FileReader* index;
- void Implements(char* List)
+ public:
+ MySQLListener(InspIRCd* Instance, int port, const std::string &addr) : ListenSocketBase(Instance, port, addr)
{
- List[I_OnRehash] = List[I_OnRequest] = 1;
+ uslen = sizeof(sock_us);
+ if (getsockname(this->fd,(sockaddr*)&sock_us,&uslen))
+ {
+ throw ModuleException("Could not getsockname() to find out port number for ITC port");
+ }
}
- unsigned long NewID()
+ virtual void OnAcceptReady(const std::string &ipconnectedto, int nfd, const std::string &incomingip)
{
- if (currid+1 == 0)
- currid++;
- return ++currid;
+ new Notifier(this->ServerInstance, nfd, (char *)ipconnectedto.c_str()); // XXX unsafe casts suck
}
- char* OnRequest(Request* request)
+ /* Using getsockname and ntohs, we can determine which port number we were allocated */
+ int GetPort()
{
- if(strcmp(SQLREQID, request->GetData()) == 0)
- {
- SQLrequest* req = (SQLrequest*)request;
+#ifdef IPV6
+ return ntohs(sock_us.sin6_port);
+#else
+ return ntohs(sock_us.sin_port);
+#endif
+ }
+};
- /* XXX: Lock */
- pthread_mutex_lock(&queue_mutex);
+ModuleSQL::ModuleSQL(InspIRCd* Me) : Module(Me), rehashing(false)
+{
+ ServerInstance->Modules->UseInterface("SQLutils");
- ConnMap::iterator iter;
+ Conf = new ConfigReader(ServerInstance);
+ PublicServerInstance = ServerInstance;
+ currid = 0;
- char* returnval = NULL;
+ /* Create a socket on a random port. Let the tcp stack allocate us an available port */
+#ifdef IPV6
+ MessagePipe = new MySQLListener(ServerInstance, 0, "::1");
+#else
+ MessagePipe = new MySQLListener(ServerInstance, 0, "127.0.0.1");
+#endif
- 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 (MessagePipe->GetFd() == -1)
+ throw ModuleException("m_mysql: unable to create ITC pipe");
+ else
+ ServerInstance->Logs->Log("m_mysql", DEBUG, "MySQL: Interthread comms port is %d", MessagePipe->GetPort());
- if((iter = Connections.find(req->dbid)) != Connections.end())
- {
- iter->second->queue.push(*req);
- req->id = NewID();
- returnval = SQLSUCCESS;
- }
- else
- {
- req->error.Id(BAD_DBID);
- }
+ Dispatcher = new DispatcherThread(ServerInstance, this);
+ ServerInstance->Threads->Create(Dispatcher);
- pthread_mutex_unlock(&queue_mutex);
- /* XXX: Unlock */
+ LoggingMutex = ServerInstance->Mutexes->CreateMutex();
+ ResultsMutex = ServerInstance->Mutexes->CreateMutex();
+ QueueMutex = ServerInstance->Mutexes->CreateMutex();
- return returnval;
- }
+ if (!ServerInstance->Modules->PublishFeature("SQL", this))
+ {
+ /* Tell worker thread to exit NOW,
+ * Automatically joins */
+ delete Dispatcher;
+ throw ModuleException("m_mysql: Unable to publish feature 'SQL'");
+ }
- log(DEBUG, "Got unsupported API version string: %s", request->GetData());
+ ServerInstance->Modules->PublishInterface("SQL", this);
+ Implementation eventlist[] = { I_OnRehash, I_OnRequest };
+ ServerInstance->Modules->Attach(eventlist, this, 2);
+}
- return NULL;
- }
+ModuleSQL::~ModuleSQL()
+{
+ delete Dispatcher;
+ ClearAllConnections();
+ delete Conf;
+ ServerInstance->Modules->UnpublishInterface("SQL", this);
+ ServerInstance->Modules->UnpublishFeature("SQL");
+ ServerInstance->Modules->DoneWithInterface("SQLutils");
+ delete LoggingMutex;
+ delete ResultsMutex;
+ delete QueueMutex;
+}
+
+unsigned long ModuleSQL::NewID()
+{
+ if (currid+1 == 0)
+ currid++;
+ return ++currid;
+}
- ModuleSQL(Server* Me)
- : Module::Module(Me)
+const char* ModuleSQL::OnRequest(Request* request)
+{
+ if(strcmp(SQLREQID, request->GetId()) == 0)
{
- Srv = Me;
- Conf = new ConfigReader();
- currid = 0;
- pthread_attr_t attribs;
- pthread_attr_init(&attribs);
- pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_DETACHED);
- if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)
+ SQLrequest* req = (SQLrequest*)request;
+
+ /* XXX: Lock */
+ QueueMutex->Lock();
+
+ ConnMap::iterator iter;
+
+ const char* returnval = NULL;
+
+ if((iter = Connections.find(req->dbid)) != Connections.end())
{
- throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));
+ req->id = NewID();
+ iter->second->queue.push(*req);
+ returnval = SQLSUCCESS;
}
- Srv->PublishFeature("SQL", this);
- Srv->PublishFeature("MySQL", this);
- }
-
- virtual ~ModuleSQL()
- {
- DELETE(Conf);
+ else
+ {
+ req->error.Id(SQL_BAD_DBID);
+ }
+
+ QueueMutex->Unlock();
+ /* XXX: Unlock */
+
+ return returnval;
}
-
- virtual void OnRehash(const std::string ¶meter)
+
+ return NULL;
+}
+
+void ModuleSQL::OnRehash(User* user, const std::string ¶meter)
+{
+ rehashing = true;
+}
+
+Version ModuleSQL::GetVersion()
+{
+ return Version("$Id$", VF_VENDOR | VF_SERVICEPROVIDER, API_VERSION);
+}
+
+void DispatcherThread::Run()
+{
+ LoadDatabases(Parent->Conf, Parent->PublicServerInstance, Parent);
+
+ /* Connect back to the Notifier */
+
+ if ((QueueFD = socket(AF_FAMILY, SOCK_STREAM, 0)) == -1)
{
- /* TODO: set rehash bool here, which makes the dispatcher thread rehash at next opportunity */
+ /* crap, we're out of sockets... */
+ return;
}
-
- virtual Version GetVersion()
+
+ 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)
{
- return Version(1,1,0,0,VF_VENDOR|VF_SERVICEPROVIDER);
+ /* wtf, we cant connect to it, but we just created it! */
+ return;
}
-
-};
-void* DispatcherThread(void* arg)
-{
- ModuleSQL* thismodule = (ModuleSQL*)arg;
- LoadDatabases(thismodule->Conf, thismodule->Srv);
-
- while (!giveup)
+ while (this->GetExitFlag() == false)
{
+ if (Parent->rehashing)
+ {
+ /* XXX: Lock */
+ Parent->QueueMutex->Lock();
+ Parent->rehashing = false;
+ LoadDatabases(Parent->Conf, Parent->PublicServerInstance, Parent);
+ Parent->QueueMutex->Unlock();
+ /* XXX: Unlock */
+ }
+
SQLConnection* conn = NULL;
/* XXX: Lock here for safety */
- pthread_mutex_lock(&queue_mutex);
+ Parent->QueueMutex->Lock();
for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
{
if (i->second->queue.totalsize())
break;
}
}
- pthread_mutex_unlock(&queue_mutex);
+ Parent->QueueMutex->Unlock();
/* XXX: Unlock */
/* Theres an item! */
conn->DoLeadingQuery();
/* XXX: Lock */
- pthread_mutex_lock(&queue_mutex);
+ Parent->QueueMutex->Lock();
conn->queue.pop();
- pthread_mutex_unlock(&queue_mutex);
+ Parent->QueueMutex->Unlock();
/* XXX: Unlock */
}
- usleep(50);
+ usleep(1000);
}
-
- return NULL;
}
-
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
-
-class ModuleSQLFactory : public ModuleFactory
-{
- public:
- ModuleSQLFactory()
- {
- }
-
- ~ModuleSQLFactory()
- {
- }
-
- virtual Module * CreateModule(Server* Me)
- {
- return new ModuleSQL(Me);
- }
-
-};
-
-
-extern "C" void * init_module( void )
-{
- return new ModuleSQLFactory;
-}
+MODULE_INIT(ModuleSQL)
projects / user / henk / code / inspircd.git / blobdiff