* See: http://www.inspircd.org/wiki/index.php/Credits
*
* This program is free but copyrighted software; see
- * the file COPYING for details.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
+/* Stop mysql wanting to use long long */
+#define NO_CLIENT_LONG_LONG
+
#include "inspircd.h"
#include <mysql.h>
-#include <pthread.h>
#include "users.h"
#include "channels.h"
#include "modules.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: exec("mysql_config --include") */
/* $LinkerFlags: exec("mysql_config --libs_r") rpath("mysql_config --libs_r") */
/* $ModDep: m_sqlv2.h */
-/* $NoPedantic */
/* 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,
+ * 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.
class SQLConnection;
-class Notifier;
+class MySQLListener;
typedef std::map<std::string, SQLConnection*> ConnMap;
-bool giveup = false;
-bool threadfinished = false;
-static Module* SQLModule = NULL;
-static Notifier* MessagePipe = NULL;
+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;
+ Mutex* ConnMutex;
+
+ 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
typedef std::deque<SQLresult*> ResultQueue;
-/* A mutex to wrap around queue accesses */
-pthread_mutex_t queue_mutex = PTHREAD_MUTEX_INITIALIZER;
-
-pthread_mutex_t results_mutex = PTHREAD_MUTEX_INITIALIZER;
-
-pthread_mutex_t logging_mutex = PTHREAD_MUTEX_INITIALIZER;
-
/** Represents a mysql result set
*/
class MySQLresult : public SQLresult
std::string b = (row[field_count] ? row[field_count] : "");
SQLfield sqlf(b, !row[field_count]);
colnames.push_back(a);
- fieldlists[n].push_back(sqlf);
+ fieldlists[n].push_back(sqlf);
field_count++;
}
n++;
virtual SQLfieldList& GetRow()
{
if (currentrow < rows)
- return fieldlists[currentrow];
+ return fieldlists[currentrow++];
else
return emptyfieldlist;
}
virtual SQLfieldMap* GetRowMapPtr()
{
fieldmap = new SQLfieldMap();
-
+
if (currentrow < rows)
{
for (int i = 0; i < Cols(); i++)
SQLhost host;
std::map<std::string,std::string> thisrow;
bool Enabled;
+ ModuleSQL* Parent;
public:
ResultQueue rq;
// This constructor creates an SQLConnection object with the given credentials, but does not connect yet.
- SQLConnection(const SQLhost &hi) : host(hi), Enabled(false)
+ SQLConnection(const SQLhost &hi, ModuleSQL* Creator) : host(hi), Enabled(false), Parent(Creator)
{
}
*queryend = 0;
- pthread_mutex_lock(&queue_mutex);
+ Parent->QueueMutex->Lock();
req.query.q = query;
- pthread_mutex_unlock(&queue_mutex);
+ Parent->QueueMutex->Unlock();
if (!mysql_real_query(&connection, req.query.q.data(), req.query.q.length()))
{
/* Successfull query */
res = mysql_use_result(&connection);
unsigned long rows = mysql_affected_rows(&connection);
- MySQLresult* r = new MySQLresult(SQLModule, req.GetSource(), res, rows, req.id);
+ 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!
*/
- pthread_mutex_lock(&results_mutex);
+ Parent->ResultsMutex->Lock();
rq.push_back(r);
- pthread_mutex_unlock(&results_mutex);
+ Parent->ResultsMutex->Unlock();
}
else
{
/* 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);
+ 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;
- pthread_mutex_lock(&results_mutex);
+ Parent->ResultsMutex->Lock();
rq.push_back(r);
- pthread_mutex_unlock(&results_mutex);
+ Parent->ResultsMutex->Unlock();
}
/* Now signal the main thread that we've got a result to process.
}
}
-void ConnectDatabases(InspIRCd* ServerInstance)
+void ConnectDatabases(InspIRCd* ServerInstance, ModuleSQL* Parent)
{
for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
{
if (!i->second->Connect())
{
/* XXX: MUTEX */
- pthread_mutex_lock(&logging_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);
- pthread_mutex_unlock(&logging_mutex);
+ Parent->LoggingMutex->Unlock();
}
}
}
-void LoadDatabases(ConfigReader* conf, InspIRCd* ServerInstance)
+void LoadDatabases(ConfigReader* conf, InspIRCd* ServerInstance, ModuleSQL* Parent)
{
+ Parent->ConnMutex->Lock();
ClearOldConnections(conf);
for (int j =0; j < conf->Enumerate("database"); j++)
{
if (!host.id.empty() && !host.host.empty() && !host.name.empty() && !host.user.empty() && !host.pass.empty())
{
- SQLConnection* ThisSQL = new SQLConnection(host);
+ SQLConnection* ThisSQL = new SQLConnection(host, Parent);
Connections[host.id] = ThisSQL;
}
}
- ConnectDatabases(ServerInstance);
+ ConnectDatabases(ServerInstance, Parent);
+ Parent->ConnMutex->Unlock();
}
char FindCharId(const std::string &id)
send(QueueFD, &id, 1, 0);
}
-void* DispatcherThread(void* arg);
+class ModuleSQL;
+
+class DispatcherThread : public Thread
+{
+ private:
+ ModuleSQL* Parent;
+ InspIRCd* ServerInstance;
+ public:
+ 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
{
- insp_sockaddr sock_us;
- socklen_t uslen;
-
+ ModuleSQL* Parent;
public:
-
- /* Create a socket on a random port. Let the tcp stack allocate us an available port */
-#ifdef IPV6
- Notifier(InspIRCd* SI) : BufferedSocket(SI, "::1", 0, true, 3000)
-#else
- Notifier(InspIRCd* SI) : BufferedSocket(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) : BufferedSocket(SI, newfd, ip)
- {
- }
-
- /* 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)
- {
- Notifier* n = new Notifier(this->Instance, newsock, ip);
- n = n; /* Stop bitching at me, GCC */
- return true;
- }
+ Notifier(ModuleSQL* P, InspIRCd* SI, int newfd, char* ip) : BufferedSocket(SI, newfd, ip), Parent(P) { }
virtual bool OnDataReady()
{
* The function GetCharId translates a single character
* back into an iterator.
*/
+
if (Instance->SE->Recv(this, &data, 1, 0) > 0)
{
+ Parent->ConnMutex->Lock();
ConnMap::iterator iter = GetCharId(data);
if (iter != Connections.end())
{
/* Lock the mutex, send back the data */
- pthread_mutex_lock(&results_mutex);
+ Parent->ResultsMutex->Lock();
ResultQueue::iterator n = iter->second->rq.begin();
(*n)->Send();
+ delete (*n);
iter->second->rq.pop_front();
- pthread_mutex_unlock(&results_mutex);
+ Parent->ResultsMutex->Unlock();
+ Parent->ConnMutex->Unlock();
return true;
}
/* No error, but unknown id */
+ Parent->ConnMutex->Unlock();
return true;
}
}
};
-/** MySQL module
+/** Spawn sockets from a listener
*/
-class ModuleSQL : public Module
+class MySQLListener : public ListenSocketBase
{
+ ModuleSQL* Parent;
+ insp_sockaddr sock_us;
+ socklen_t uslen;
+ FileReader* index;
+
public:
-
- ConfigReader *Conf;
- InspIRCd* PublicServerInstance;
- pthread_t Dispatcher;
- int currid;
- bool rehashing;
-
- ModuleSQL(InspIRCd* Me)
- : Module::Module(Me), rehashing(false)
- {
- ServerInstance->Modules->UseInterface("SQLutils");
-
- Conf = new ConfigReader(ServerInstance);
- PublicServerInstance = ServerInstance;
- currid = 0;
- SQLModule = this;
-
- MessagePipe = new Notifier(ServerInstance);
-
- pthread_attr_t attribs;
- pthread_attr_init(&attribs);
- pthread_attr_setdetachstate(&attribs, PTHREAD_CREATE_JOINABLE);
- if (pthread_create(&this->Dispatcher, &attribs, DispatcherThread, (void *)this) != 0)
+ MySQLListener(ModuleSQL* P, InspIRCd* Instance, int port, const std::string &addr) : ListenSocketBase(Instance, port, addr), Parent(P)
+ {
+ uslen = sizeof(sock_us);
+ if (getsockname(this->fd,(sockaddr*)&sock_us,&uslen))
{
- throw ModuleException("m_mysql: Failed to create dispatcher thread: " + std::string(strerror(errno)));
+ throw ModuleException("Could not getsockname() to find out port number for ITC port");
}
- pthread_attr_destroy(&attribs);
+ }
- if (!ServerInstance->Modules->PublishFeature("SQL", this))
- {
- /* Tell worker thread to exit NOW */
- int rc;
- void *status;
- giveup = true;
- rc = pthread_join(Dispatcher, &status);
- if (rc)
- {
- ServerInstance->Logs->Log("m_mysql",DEFAULT,"SQL: Error code from pthread_join() is %d", rc);
- }
- throw ModuleException("m_mysql: Unable to publish feature 'SQL'");
- }
+ virtual void OnAcceptReady(const std::string &ipconnectedto, int nfd, const std::string &incomingip)
+ {
+ new Notifier(this->Parent, this->ServerInstance, nfd, (char *)ipconnectedto.c_str()); // XXX unsafe casts suck
+ }
- ServerInstance->Modules->PublishInterface("SQL", this);
- Implementation eventlist[] = { I_OnRehash, I_OnRequest };
- ServerInstance->Modules->Attach(eventlist, this, 2);
+ /* 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
}
+};
+
+ModuleSQL::ModuleSQL(InspIRCd* Me) : Module(Me), rehashing(false)
+{
+ ServerInstance->Modules->UseInterface("SQLutils");
+
+ Conf = new ConfigReader(ServerInstance);
+ PublicServerInstance = ServerInstance;
+ currid = 0;
+
+ /* Create a socket on a random port. Let the tcp stack allocate us an available port */
+#ifdef IPV6
+ MessagePipe = new MySQLListener(this, ServerInstance, 0, "::1");
+#else
+ MessagePipe = new MySQLListener(this, ServerInstance, 0, "127.0.0.1");
+#endif
- virtual ~ModuleSQL()
+ LoggingMutex = ServerInstance->Mutexes->CreateMutex();
+ ConnMutex = ServerInstance->Mutexes->CreateMutex();
+
+ if (MessagePipe->GetFd() == -1)
{
- int rc;
- void *status;
- giveup = true;
- rc = pthread_join(Dispatcher, &status);
- if (rc)
- {
- ServerInstance->Logs->Log("m_mysql",DEFAULT,"SQL: Error code from pthread_join() is %d", rc);
- }
- ClearAllConnections();
- delete Conf;
- ServerInstance->Modules->UnpublishInterface("SQL", this);
- ServerInstance->Modules->UnpublishFeature("SQL");
+ delete ConnMutex;
ServerInstance->Modules->DoneWithInterface("SQLutils");
+ throw ModuleException("m_mysql: unable to create ITC pipe");
+ }
+ else
+ {
+ LoggingMutex->Lock();
+ ServerInstance->Logs->Log("m_mysql", DEBUG, "MySQL: Interthread comms port is %d", MessagePipe->GetPort());
+ LoggingMutex->Unlock();
}
+ Dispatcher = new DispatcherThread(ServerInstance, this);
+ ServerInstance->Threads->Create(Dispatcher);
+ ResultsMutex = ServerInstance->Mutexes->CreateMutex();
+ QueueMutex = ServerInstance->Mutexes->CreateMutex();
- unsigned long NewID()
+ if (!ServerInstance->Modules->PublishFeature("SQL", this))
{
- if (currid+1 == 0)
- currid++;
- return ++currid;
+ /* Tell worker thread to exit NOW,
+ * Automatically joins */
+ delete Dispatcher;
+ delete LoggingMutex;
+ delete ResultsMutex;
+ delete QueueMutex;
+ delete ConnMutex;
+ ServerInstance->Modules->DoneWithInterface("SQLutils");
+ throw ModuleException("m_mysql: Unable to publish feature 'SQL'");
}
- virtual const char* OnRequest(Request* request)
- {
- if(strcmp(SQLREQID, request->GetId()) == 0)
- {
- SQLrequest* req = (SQLrequest*)request;
+ ServerInstance->Modules->PublishInterface("SQL", this);
+ Implementation eventlist[] = { I_OnRehash, I_OnRequest };
+ ServerInstance->Modules->Attach(eventlist, this, 2);
+}
- /* XXX: Lock */
- pthread_mutex_lock(&queue_mutex);
+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;
+ delete ConnMutex;
+}
- ConnMap::iterator iter;
+unsigned long ModuleSQL::NewID()
+{
+ if (currid+1 == 0)
+ currid++;
+ return ++currid;
+}
- const char* returnval = NULL;
+const char* ModuleSQL::OnRequest(Request* request)
+{
+ if(strcmp(SQLREQID, request->GetId()) == 0)
+ {
+ SQLrequest* req = (SQLrequest*)request;
- if((iter = Connections.find(req->dbid)) != Connections.end())
- {
- req->id = NewID();
- iter->second->queue.push(*req);
- returnval = SQLSUCCESS;
- }
- else
- {
- req->error.Id(BAD_DBID);
- }
+ /* XXX: Lock */
+ QueueMutex->Lock();
- pthread_mutex_unlock(&queue_mutex);
- /* XXX: Unlock */
+ ConnMap::iterator iter;
+
+ const char* returnval = NULL;
- return returnval;
+ ConnMutex->Lock();
+ if((iter = Connections.find(req->dbid)) != Connections.end())
+ {
+ req->id = NewID();
+ iter->second->queue.push(*req);
+ returnval = SQLSUCCESS;
+ }
+ else
+ {
+ req->error.Id(SQL_BAD_DBID);
}
- return NULL;
- }
+ ConnMutex->Unlock();
+ QueueMutex->Unlock();
- virtual void OnRehash(User* user, const std::string ¶meter)
- {
- rehashing = true;
- }
-
- virtual Version GetVersion()
- {
- return Version(1,2,0,0,VF_VENDOR|VF_SERVICEPROVIDER,API_VERSION);
+ return returnval;
}
-
-};
-void* DispatcherThread(void* arg)
+ return NULL;
+}
+
+void ModuleSQL::OnRehash(User* user, const std::string ¶meter)
{
- ModuleSQL* thismodule = (ModuleSQL*)arg;
- LoadDatabases(thismodule->Conf, thismodule->PublicServerInstance);
+ 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)
{
/* crap, we're out of sockets... */
- return NULL;
+ return;
}
insp_sockaddr addr;
if (connect(QueueFD, (sockaddr*)&addr,sizeof(addr)) == -1)
{
/* wtf, we cant connect to it, but we just created it! */
- return NULL;
+ return;
}
- while (!giveup)
+ while (this->GetExitFlag() == false)
{
- if (thismodule->rehashing)
+ if (Parent->rehashing)
{
/* XXX: Lock */
- pthread_mutex_lock(&queue_mutex);
- thismodule->rehashing = false;
- LoadDatabases(thismodule->Conf, thismodule->PublicServerInstance);
- pthread_mutex_unlock(&queue_mutex);
+ 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();
+ Parent->ConnMutex->Lock();
for (ConnMap::iterator i = Connections.begin(); i != Connections.end(); i++)
{
if (i->second->queue.totalsize())
break;
}
}
- pthread_mutex_unlock(&queue_mutex);
+ Parent->ConnMutex->Unlock();
+ 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(1000);
}
-
- pthread_exit((void *) 0);
}
MODULE_INIT(ModuleSQL)
+
projects / user / henk / code / inspircd.git / blobdiff