* Seperate out socket engines into derived classes of SocketEngine.

* Add a classfactory SocketEngineFactory to create a new socketengine of the configured type
* Implement configure hax to compile only the required socketengine and the base class
* Eliminates ugly defines, and is more in line with C++ ways


git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@4439 e03df62e-2008-0410-955e-edbf42e46eb7

6 files changed, 402 insertions, 180 deletions

diff --git a/src/dns.cpp b/src/dns.cpp
index 0347caaae..d67815b2c 100644
--- a/src/dns.cpp
+++ b/src/dns.cpp
@@ -49,6 +49,7 @@ using namespace std;
 #include "dns.h"
 #include "inspircd.h"
 #include "helperfuncs.h"
+#include "inspircd_config.h"
 #include "socketengine.h"
 #include "configreader.h"
 
diff --git a/src/inspircd.cpp b/src/inspircd.cpp
index a6106a787..2f08750bd 100644
--- a/src/inspircd.cpp
+++ b/src/inspircd.cpp
@@ -63,6 +63,7 @@
 #include "helperfuncs.h"
 #include "hashcomp.h"
 #include "socketengine.h"
+#include "inspircd_se_config.h"
 #include "userprocess.h"
 #include "socket.h"
 #include "typedefs.h"
@@ -323,7 +324,9 @@ InspIRCd::InspIRCd(int argc, char** argv)
 	/* Because of limitations in kqueue on freebsd, we must fork BEFORE we
 	 * initialize the socket engine.
 	 */
-	SE = new SocketEngine();
+	SocketEngineFactory* SEF = new SocketEngineFactory();
+	SE = SEF->Create();
+	delete SEF;
 
 	/* We must load the modules AFTER initializing the socket engine, now */
 
diff --git a/src/socketengine.cpp b/src/socketengine.cpp
index 886e2b0d0..4c164f31e 100644
--- a/src/socketengine.cpp
+++ b/src/socketengine.cpp
@@ -30,40 +30,17 @@
 #include "socketengine.h"
 #include "helperfuncs.h"
 
-char ref[MAX_DESCRIPTORS];
-
 SocketEngine::SocketEngine()
 {
-	log(DEBUG,"SocketEngine::SocketEngine()");
-#ifdef USE_EPOLL
-	EngineHandle = epoll_create(MAX_DESCRIPTORS);
-#endif
-#ifdef USE_KQUEUE
-	EngineHandle = kqueue();
-#endif
-#ifdef USE_SELECT
-	EngineHandle = 0;
-#endif
-	if (EngineHandle == -1)
-	{
-		log(SPARSE,"ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
-		log(SPARSE,"ERROR: this is a fatal error, exiting now.");
-		printf("ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
-		printf("ERROR: this is a fatal error, exiting now.");
-		Exit(0);
-	}
-	CurrentSetSize = 0;
+	printf("Something blew up in your face. class SocketEngine is an abstract class and configure must\n");
+	printf("select a socket engine to derive from it such as EPollEngine, KQueueEngine or SelectEngine.\n");
+	printf("Rerun configure, and try again.\n");
+	exit(0);
 }
 
 SocketEngine::~SocketEngine()
 {
 	log(DEBUG,"SocketEngine::~SocketEngine()");
-#ifdef USE_EPOLL
-	close(EngineHandle);
-#endif
-#ifdef USE_KQUEUE
-	close(EngineHandle);
-#endif
 }
 
 char SocketEngine::GetType(int fd)
@@ -76,51 +53,6 @@ char SocketEngine::GetType(int fd)
 
 bool SocketEngine::AddFd(int fd, bool readable, char type)
 {
-	if ((fd < 0) || (fd > MAX_DESCRIPTORS))
-	{
-		log(DEFAULT,"ERROR: FD of %d added above max of %d",fd,MAX_DESCRIPTORS);
-		return false;
-	}
-	if (GetRemainingFds() <= 1)
-	{
-		log(DEFAULT,"ERROR: System out of file descriptors!");
-		return false;
-	}
-#ifdef USE_SELECT
-	fds[fd] = fd;
-#endif
-	ref[fd] = type;
-	if (readable)
-	{
-		log(DEBUG,"Set readbit");
-		ref[fd] |= X_READBIT;
-	}
-	log(DEBUG,"Add socket %d",fd);
-#ifdef USE_EPOLL
-	struct epoll_event ev;
-	memset(&ev,0,sizeof(struct epoll_event));
-	log(DEBUG,"epoll: Add socket to events, ep=%d socket=%d",EngineHandle,fd);
-	readable ? ev.events = EPOLLIN : ev.events = EPOLLOUT;
-	ev.data.fd = fd;
-	int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
-	if (i < 0)
-	{
-		log(DEBUG,"epoll: List insertion failure!");
-		return false;
-	}
-#endif
-#ifdef USE_KQUEUE
-	struct kevent ke;
-	log(DEBUG,"kqueue: Add socket to events, kq=%d socket=%d",EngineHandle,fd);
-	EV_SET(&ke, fd, readable ? EVFILT_READ : EVFILT_WRITE, EV_ADD, 0, 0, NULL);
-	int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
-	if (i == -1)
-	{
-		log(DEBUG,"kqueue: List insertion failure!");
-		return false;
-	}
-#endif
-	CurrentSetSize++;
 	return true;
 }
 
@@ -133,129 +65,25 @@ bool SocketEngine::HasFd(int fd)
 
 bool SocketEngine::DelFd(int fd)
 {
-	log(DEBUG,"SocketEngine::DelFd(%d)",fd);
-
-	if ((fd < 0) || (fd > MAX_DESCRIPTORS))
-		return false;
-
-#ifdef USE_SELECT
-	std::map<int,int>::iterator t = fds.find(fd);
-	if (t != fds.end())
-	{
-		fds.erase(t);
-		log(DEBUG,"Deleted fd %d",fd);
-	}
-#endif
-#ifdef USE_KQUEUE
-	struct kevent ke;
-	EV_SET(&ke, fd, ref[fd] & X_READBIT ? EVFILT_READ : EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
-	int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
-	if (i == -1)
-	{
-		log(DEBUG,"kqueue: Failed to remove socket from queue!");
-		return false;
-	}
-#endif
-#ifdef USE_EPOLL
-	struct epoll_event ev;
-	memset(&ev,0,sizeof(struct epoll_event));
-	ref[fd] && X_READBIT ? ev.events = EPOLLIN : ev.events = EPOLLOUT;
-	ev.data.fd = fd;
-	int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
-	if (i < 0)
-	{
-		log(DEBUG,"epoll: List deletion failure!");
-		return false;
-	}
-#endif
-	CurrentSetSize--;
-	ref[fd] = 0;
 	return true;
 }
 
 int SocketEngine::GetMaxFds()
 {
-#ifdef USE_SELECT
-	return FD_SETSIZE;
-#endif
-#ifdef USE_KQUEUE
-	return MAX_DESCRIPTORS;
-#endif
-#ifdef USE_EPOLL
-	return MAX_DESCRIPTORS;
-#endif
+	return 0;
 }
 
 int SocketEngine::GetRemainingFds()
 {
-#ifdef USE_SELECT
-	return FD_SETSIZE - CurrentSetSize;
-#endif
-#ifdef USE_KQUEUE
-	return MAX_DESCRIPTORS - CurrentSetSize;
-#endif
-#ifdef USE_EPOLL
-	return MAX_DESCRIPTORS - CurrentSetSize;
-#endif
+	return 0;
 }
 
 int SocketEngine::Wait(int* fdlist)
 {
-	int result = 0;
-#ifdef USE_SELECT
-	FD_ZERO(&wfdset);
-	FD_ZERO(&rfdset);
-	timeval tval;
-	int sresult;
-	for (std::map<int,int>::iterator a = fds.begin(); a != fds.end(); a++)
-	{
-		if (ref[a->second] & X_READBIT)
-		{
-			FD_SET (a->second, &rfdset);
-		}
-		else
-		{
-			FD_SET (a->second, &wfdset);
-		}
-		
-	}
-	tval.tv_sec = 0;
-	tval.tv_usec = 50L;
-	sresult = select(FD_SETSIZE, &rfdset, &wfdset, NULL, &tval);
-	if (sresult > 0)
-	{
-		for (std::map<int,int>::iterator a = fds.begin(); a != fds.end(); a++)
-		{
-			if ((FD_ISSET (a->second, &rfdset)) || (FD_ISSET (a->second, &wfdset)))
-				fdlist[result++] = a->second;
-		}
-	}
-#endif
-#ifdef USE_KQUEUE
-	ts.tv_nsec = 5000L;
-	ts.tv_sec = 0;
-	int i = kevent(EngineHandle, NULL, 0, &ke_list[0], MAX_DESCRIPTORS, &ts);
-	for (int j = 0; j < i; j++)
-		fdlist[result++] = ke_list[j].ident;
-#endif
-#ifdef USE_EPOLL
-	int i = epoll_wait(EngineHandle, events, MAX_DESCRIPTORS, 50);
-	for (int j = 0; j < i; j++)
-		fdlist[result++] = events[j].data.fd;
-#endif
-	return result;
+	return 0;
 }
 
 std::string SocketEngine::GetName()
 {
-#ifdef USE_SELECT
-	return "select";
-#endif
-#ifdef USE_KQUEUE
-	return "kqueue";
-#endif
-#ifdef USE_EPOLL
-	return "epoll";
-#endif
 	return "misconfigured";
 }
diff --git a/src/socketengine_epoll.cpp b/src/socketengine_epoll.cpp
new file mode 100644
index 000000000..d1a761d5b
--- /dev/null
+++ b/src/socketengine_epoll.cpp
@@ -0,0 +1,129 @@
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
+ *                       E-mail:
+ *                <brain@chatspike.net>
+ *                <Craig@chatspike.net>
+ *
+ * Written by Craig Edwards, Craig McLure, and others.
+ * This program is free but copyrighted software; see
+ *            the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
+#include "inspircd_config.h"
+#include "globals.h"
+#include "inspircd.h"
+#include <sys/epoll.h>
+#include <vector>
+#include <string>
+#include "socketengine_epoll.h"
+#include "helperfuncs.h"
+
+EPollEngine::EPollEngine()
+{
+	EngineHandle = epoll_create(MAX_DESCRIPTORS);
+
+	if (EngineHandle == -1)
+	{
+		log(SPARSE,"ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
+		log(SPARSE,"ERROR: this is a fatal error, exiting now.");
+		printf("ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
+		printf("ERROR: this is a fatal error, exiting now.");
+		Exit(0);
+	}
+	CurrentSetSize = 0;
+}
+
+EPollEngine::~EPollEngine()
+{
+	close(EngineHandle);
+}
+
+bool EPollEngine::AddFd(int fd, bool readable, char type)
+{
+	if ((fd < 0) || (fd > MAX_DESCRIPTORS))
+	{
+		log(DEFAULT,"ERROR: FD of %d added above max of %d",fd,MAX_DESCRIPTORS);
+		return false;
+	}
+	if (GetRemainingFds() <= 1)
+	{
+		log(DEFAULT,"ERROR: System out of file descriptors!");
+		return false;
+	}
+	ref[fd] = type;
+	if (readable)
+	{
+		log(DEBUG,"Set readbit");
+		ref[fd] |= X_READBIT;
+	}
+	log(DEBUG,"Add socket %d",fd);
+
+	struct epoll_event ev;
+	memset(&ev,0,sizeof(struct epoll_event));
+	log(DEBUG,"epoll: Add socket to events, ep=%d socket=%d",EngineHandle,fd);
+	readable ? ev.events = EPOLLIN : ev.events = EPOLLOUT;
+	ev.data.fd = fd;
+	int i = epoll_ctl(EngineHandle, EPOLL_CTL_ADD, fd, &ev);
+	if (i < 0)
+	{
+		log(DEBUG,"epoll: List insertion failure!");
+		return false;
+	}
+
+	CurrentSetSize++;
+	return true;
+}
+
+bool EPollEngine::DelFd(int fd)
+{
+	log(DEBUG,"EPollEngine::DelFd(%d)",fd);
+
+	if ((fd < 0) || (fd > MAX_DESCRIPTORS))
+		return false;
+
+	struct epoll_event ev;
+	memset(&ev,0,sizeof(struct epoll_event));
+	ref[fd] && X_READBIT ? ev.events = EPOLLIN : ev.events = EPOLLOUT;
+	ev.data.fd = fd;
+	int i = epoll_ctl(EngineHandle, EPOLL_CTL_DEL, fd, &ev);
+	if (i < 0)
+	{
+		log(DEBUG,"epoll: List deletion failure!");
+		return false;
+	}
+
+	CurrentSetSize--;
+	ref[fd] = 0;
+	return true;
+}
+
+int EPollEngine::GetMaxFds()
+{
+	return MAX_DESCRIPTORS;
+}
+
+int EPollEngine::GetRemainingFds()
+{
+	return MAX_DESCRIPTORS - CurrentSetSize;
+}
+
+int EPollEngine::Wait(int* fdlist)
+{
+	int result = 0;
+
+	int i = epoll_wait(EngineHandle, events, MAX_DESCRIPTORS, 50);
+	for (int j = 0; j < i; j++)
+		fdlist[result++] = events[j].data.fd;
+
+	return result;
+}
+
+std::string EPollEngine::GetName()
+{
+	return "epoll";
+}
diff --git a/src/socketengine_kqueue.cpp b/src/socketengine_kqueue.cpp
new file mode 100644
index 000000000..388a84f29
--- /dev/null
+++ b/src/socketengine_kqueue.cpp
@@ -0,0 +1,130 @@
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
+ *                       E-mail:
+ *                <brain@chatspike.net>
+ *                <Craig@chatspike.net>
+ *
+ * Written by Craig Edwards, Craig McLure, and others.
+ * This program is free but copyrighted software; see
+ *            the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
+#include "inspircd_config.h"
+#include "globals.h"
+#include "inspircd.h"
+#include <sys/types.h>
+#include <sys/event.h>
+#include <sys/time.h>
+#include <vector>
+#include <string>
+#include "socketengine_kqueue.h"
+#include "helperfuncs.h"
+
+KQueueEngine::KQueueEngine()
+{
+	EngineHandle = kqueue();
+	if (EngineHandle == -1)
+	{
+		log(SPARSE,"ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
+		log(SPARSE,"ERROR: this is a fatal error, exiting now.");
+		printf("ERROR: Could not initialize socket engine. Your kernel probably does not have the proper features.");
+		printf("ERROR: this is a fatal error, exiting now.");
+		Exit(0);
+	}
+	CurrentSetSize = 0;
+}
+
+KQueueEngine::~KQueueEngine()
+{
+	log(DEBUG,"KQueueEngine::~KQueueEngine()");
+	close(EngineHandle);
+}
+
+bool KQueueEngine::AddFd(int fd, bool readable, char type)
+{
+	if ((fd < 0) || (fd > MAX_DESCRIPTORS))
+	{
+		log(DEFAULT,"ERROR: FD of %d added above max of %d",fd,MAX_DESCRIPTORS);
+		return false;
+	}
+	if (GetRemainingFds() <= 1)
+	{
+		log(DEFAULT,"ERROR: System out of file descriptors!");
+		return false;
+	}
+
+	ref[fd] = type;
+	if (readable)
+	{
+		log(DEBUG,"Set readbit");
+		ref[fd] |= X_READBIT;
+	}
+	log(DEBUG,"Add socket %d",fd);
+
+	struct kevent ke;
+	log(DEBUG,"kqueue: Add socket to events, kq=%d socket=%d",EngineHandle,fd);
+	EV_SET(&ke, fd, readable ? EVFILT_READ : EVFILT_WRITE, EV_ADD, 0, 0, NULL);
+	int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
+	if (i == -1)
+	{
+		log(DEBUG,"kqueue: List insertion failure!");
+		return false;
+	}
+
+	CurrentSetSize++;
+	return true;
+}
+
+bool KQueueEngine::DelFd(int fd)
+{
+	log(DEBUG,"KQueueEngine::DelFd(%d)",fd);
+
+	if ((fd < 0) || (fd > MAX_DESCRIPTORS))
+		return false;
+
+	struct kevent ke;
+	EV_SET(&ke, fd, ref[fd] & X_READBIT ? EVFILT_READ : EVFILT_WRITE, EV_DELETE, 0, 0, NULL);
+	int i = kevent(EngineHandle, &ke, 1, 0, 0, NULL);
+	if (i == -1)
+	{
+		log(DEBUG,"kqueue: Failed to remove socket from queue!");
+		return false;
+	}
+
+	CurrentSetSize--;
+	ref[fd] = 0;
+	return true;
+}
+
+int KQueueEngine::GetMaxFds()
+{
+	return MAX_DESCRIPTORS;
+}
+
+int KQueueEngine::GetRemainingFds()
+{
+	return MAX_DESCRIPTORS - CurrentSetSize;
+}
+
+int KQueueEngine::Wait(int* fdlist)
+{
+	int result = 0;
+
+	ts.tv_nsec = 5000L;
+	ts.tv_sec = 0;
+	int i = kevent(EngineHandle, NULL, 0, &ke_list[0], MAX_DESCRIPTORS, &ts);
+	for (int j = 0; j < i; j++)
+		fdlist[result++] = ke_list[j].ident;
+
+	return result;
+}
+
+std::string KQueueEngine::GetName()
+{
+	return "kqueue";
+}
diff --git a/src/socketengine_select.cpp b/src/socketengine_select.cpp
new file mode 100644
index 000000000..8d77da461
--- /dev/null
+++ b/src/socketengine_select.cpp
@@ -0,0 +1,131 @@
+/*       +------------------------------------+
+ *       | Inspire Internet Relay Chat Daemon |
+ *       +------------------------------------+
+ *
+ *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
+ *                       E-mail:
+ *                <brain@chatspike.net>
+ *                <Craig@chatspike.net>
+ *
+ * Written by Craig Edwards, Craig McLure, and others.
+ * This program is free but copyrighted software; see
+ *            the file COPYING for details.
+ *
+ * ---------------------------------------------------
+ */
+
+#include "inspircd_config.h"
+#include "globals.h"
+#include "inspircd.h"
+#include <vector>
+#include <string>
+#include "socketengine_select.h"
+#include "helperfuncs.h"
+
+SelectEngine::SelectEngine()
+{
+	log(DEBUG,"SelectEngine::SelectEngine()");
+	EngineHandle = 0;
+	CurrentSetSize = 0;
+}
+
+SelectEngine::~SelectEngine()
+{
+	log(DEBUG,"SelectEngine::~SelectEngine()");
+}
+
+bool SelectEngine::AddFd(int fd, bool readable, char type)
+{
+	if ((fd < 0) || (fd > MAX_DESCRIPTORS))
+	{
+		log(DEFAULT,"ERROR: FD of %d added above max of %d",fd,MAX_DESCRIPTORS);
+		return false;
+	}
+	if (GetRemainingFds() <= 1)
+	{
+		log(DEFAULT,"ERROR: System out of file descriptors!");
+		return false;
+	}
+
+	fds[fd] = fd;
+
+	ref[fd] = type;
+	if (readable)
+	{
+		log(DEBUG,"Set readbit");
+		ref[fd] |= X_READBIT;
+	}
+	log(DEBUG,"Add socket %d",fd);
+
+	CurrentSetSize++;
+	return true;
+}
+
+bool SelectEngine::DelFd(int fd)
+{
+	log(DEBUG,"SelectEngine::DelFd(%d)",fd);
+
+	if ((fd < 0) || (fd > MAX_DESCRIPTORS))
+		return false;
+
+	std::map<int,int>::iterator t = fds.find(fd);
+	if (t != fds.end())
+	{
+		fds.erase(t);
+		log(DEBUG,"Deleted fd %d",fd);
+	}
+
+	CurrentSetSize--;
+	ref[fd] = 0;
+	return true;
+}
+
+int SelectEngine::GetMaxFds()
+{
+	return FD_SETSIZE;
+}
+
+int SelectEngine::GetRemainingFds()
+{
+	return FD_SETSIZE - CurrentSetSize;
+}
+
+int SelectEngine::Wait(int* fdlist)
+{
+	int result = 0;
+
+	FD_ZERO(&wfdset);
+	FD_ZERO(&rfdset);
+	timeval tval;
+	int sresult;
+	for (std::map<int,int>::iterator a = fds.begin(); a != fds.end(); a++)
+	{
+		if (ref[a->second] & X_READBIT)
+		{
+			FD_SET (a->second, &rfdset);
+		}
+		else
+		{
+			FD_SET (a->second, &wfdset);
+		}
+		
+	}
+	tval.tv_sec = 0;
+	tval.tv_usec = 50L;
+	sresult = select(FD_SETSIZE, &rfdset, &wfdset, NULL, &tval);
+	if (sresult > 0)
+	{
+		for (std::map<int,int>::iterator a = fds.begin(); a != fds.end(); a++)
+		{
+			if ((FD_ISSET (a->second, &rfdset)) || (FD_ISSET (a->second, &wfdset)))
+				fdlist[result++] = a->second;
+		}
+	}
+
+	return result;
+}
+
+std::string SelectEngine::GetName()
+{
+	return "select";
+}