* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * Inspire is copyright (C) 2002-2005 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
+ * InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
*
- * Written by Craig Edwards, Craig McLure, and others.
* This program is free but copyrighted software; see
* the file COPYING for details.
*
* ---------------------------------------------------
-*/
+ */
#ifndef __SOCKETENGINE__
#define __SOCKETENGINE__
#include <vector>
#include <string>
+#include <map>
#include "inspircd_config.h"
-#include "globals.h"
-#include "inspircd.h"
-#ifdef USE_EPOLL
-#include <sys/epoll.h>
-#define EP_DELAY 5
-#endif
-#ifdef USE_KQUEUE
-#include <sys/types.h>
-#include <sys/event.h>
-#include <sys/time.h>
-#endif
+#include "base.h"
+
+/** Types of event an EventHandler may receive.
+ * EVENT_READ is a readable file descriptor,
+ * and EVENT_WRITE is a writeable file descriptor.
+ * EVENT_ERROR can always occur, and indicates
+ * a write error or read error on the socket,
+ * e.g. EOF condition or broken pipe.
+ */
+enum EventType
+{
+ EVENT_READ = 0,
+ EVENT_WRITE = 1,
+ EVENT_ERROR = 2
+};
-class SocketEngine {
+class InspIRCd;
+
+/** This class is a basic I/O handler class.
+ * Any object which wishes to receive basic I/O events
+ * from the socketengine must derive from this class and
+ * implement the HandleEvent() method. The derived class
+ * must then be added to SocketEngine using the method
+ * SocketEngine::AddFd(), after which point the derived
+ * class will receive events to its HandleEvent() method.
+ * The derived class should also implement one of Readable()
+ * and Writeable(). In the current implementation, only
+ * Readable() is used. If this returns true, the socketengine
+ * inserts a readable socket. If it is false, the socketengine
+ * inserts a writeable socket. The derived class should never
+ * change the value this function returns without first
+ * deleting the socket from the socket engine. The only
+ * requirement beyond this for an event handler is that it
+ * must have a file descriptor. What this file descriptor
+ * is actually attached to is completely up to you.
+ */
+class CoreExport EventHandler : public Extensible
+{
+ protected:
+ /** File descriptor.
+ * All events which can be handled
+ * must have a file descriptor.
+ * This allows you to add events for
+ * sockets, fifo's, pipes, and various
+ * other forms of IPC.
+ */
+ int fd;
+ public:
+ /** Get the current file descriptor
+ * @return The file descriptor of this handler
+ */
+ int GetFd();
+
+ /** Set a new file desciptor
+ * @param FD The new file descriptor. Do not
+ * call this method without first deleting the
+ * object from the SocketEngine if you have
+ * added it to a SocketEngine instance.
+ */
+ void SetFd(int FD);
+
+ /** Constructor
+ */
+ EventHandler() {}
+
+ /** Destructor
+ */
+ virtual ~EventHandler() {}
+
+ /** Override this function to indicate readability.
+ * @return This should return true if the function
+ * wishes to receive EVENT_READ events. Do not change
+ * what this function returns while the event handler
+ * is still added to a SocketEngine instance!
+ * If this function is unimplemented, the base class
+ * will return true.
+ *
+ * NOTE: You cannot set both Readable() and
+ * Writeable() to true. If you wish to receive
+ * a write event for your object, you must call
+ * SocketEngine::WantWrite() instead. This will
+ * trigger your objects next EVENT_WRITE type event.
+ */
+ virtual bool Readable();
+
+ /** Override this function to indicate writeability.
+ * @return This should return true if the function
+ * wishes to receive EVENT_WRITE events. Do not change
+ * what this function returns while the event handler
+ * is still added to a SocketEngine instance!
+ * If this function is unimplemented, the base class
+ * will return false.
+ *
+ * NOTE: You cannot set both Readable() and
+ * Writeable() to true. If you wish to receive
+ * a write event for your object, you must call
+ * SocketEngine::WantWrite() instead. This will
+ * trigger your objects next EVENT_WRITE type event.
+ */
+ virtual bool Writeable();
+
+ /** Process an I/O event.
+ * You MUST implement this function in your derived
+ * class, and it will be called whenever read or write
+ * events are received, depending on what your functions
+ * Readable() and Writeable() returns and wether you
+ * previously made a call to SocketEngine::WantWrite().
+ * @param et either one of EVENT_READ for read events,
+ * and EVENT_WRITE for write events.
+ */
+ virtual void HandleEvent(EventType et, int errornum = 0) = 0;
+
+#ifdef WINDOWS
+
+ /** "Fake" file descriptor. This is windows-specific.
+ */
+ int m_internalFd;
+
+ /** Pointer to read event. We delete this so the buffer can't be used
+ * after the socket is deleted, and so it doesn't leak memory
+ */
+ void * m_readEvent;
+ void * m_writeEvent;
+ void * m_acceptEvent;
- std::vector<int> fds;
- int EngineHandle;
-#ifdef USE_SELECT
- fd_set wfdset, rfdset;
-#endif
-#ifdef USE_KQUEUE
- struct kevent ke_list[65535];
- struct timespec ts;
-#endif
-#ifdef USE_EPOLL
- struct epoll_event events[65535];
#endif
+};
+/** Provides basic file-descriptor-based I/O support.
+ * The actual socketengine class presents the
+ * same interface on all operating systems, but
+ * its private members and internal behaviour
+ * should be treated as blackboxed, and vary
+ * from system to system and upon the config
+ * settings chosen by the server admin. The current
+ * version supports select, epoll and kqueue.
+ * The configure script will enable a socket engine
+ * based upon what OS is detected, and will derive
+ * a class from SocketEngine based upon what it finds.
+ * The derived classes file will also implement a
+ * classfactory, SocketEngineFactory, which will
+ * create a derived instance of SocketEngine using
+ * polymorphism so that the core and modules do not
+ * have to be aware of which SocketEngine derived
+ * class they are using.
+ */
+class CoreExport SocketEngine : public Extensible
+{
+protected:
+ /** Owner/Creator
+ */
+ InspIRCd* ServerInstance;
+ /** Handle to socket engine, where needed.
+ */
+ int EngineHandle;
+ /** Current number of descriptors in the engine
+ */
+ int CurrentSetSize;
+ /** Reference table, contains all current handlers
+ */
+ EventHandler* ref[MAX_DESCRIPTORS];
public:
- SocketEngine();
- ~SocketEngine();
- bool AddFd(int fd, bool readable, char type);
- bool DelFd(int fd);
- bool Wait(std::vector<int> &fdlist);
- std::string GetName();
+ /** Constructor.
+ * The constructor transparently initializes
+ * the socket engine which the ircd is using.
+ * Please note that if there is a catastrophic
+ * failure (for example, you try and enable
+ * epoll on a 2.4 linux kernel) then this
+ * function may bail back to the shell.
+ * @param Instance The creator/owner of this object
+ */
+ SocketEngine(InspIRCd* Instance);
+
+ /** Destructor.
+ * The destructor transparently tidies up
+ * any resources used by the socket engine.
+ */
+ virtual ~SocketEngine();
+
+ /** Add an EventHandler object to the engine.
+ * Use AddFd to add a file descriptor to the
+ * engine and have the socket engine monitor
+ * it. You must provide an object derived from
+ * EventHandler which implements HandleEvent()
+ * and optionally Readable() and Writeable().
+ * @param eh An event handling object to add
+ */
+ virtual bool AddFd(EventHandler* eh);
+
+ /** If you call this function and pass it an
+ * event handler, that event handler will
+ * receive the next available write event,
+ * even if the socket is a readable socket only.
+ * Developers should avoid constantly keeping
+ * an eventhandler in the writeable state,
+ * as this will consume large amounts of
+ * CPU time.
+ * @param eh An event handler which wants to
+ * receive the next writeability event.
+ */
+ virtual void WantWrite(EventHandler* eh);
+
+ /** Returns the maximum number of file descriptors
+ * you may store in the socket engine at any one time.
+ * @return The maximum fd value
+ */
+ virtual int GetMaxFds();
+
+ /** Returns the number of file descriptor slots
+ * which are available for storing fds.
+ * @return The number of remaining fd's
+ */
+ virtual int GetRemainingFds();
+
+ /** Delete an event handler from the engine.
+ * This function call deletes an EventHandler
+ * from the engine, returning true if it succeeded
+ * and false if it failed. This does not free the
+ * EventHandler pointer using delete, if this is
+ * required you must do this yourself.
+ * Note on forcing deletes. DO NOT DO THIS! This is
+ * extremely dangerous and will most likely render the
+ * socketengine dead. This was added only for handling
+ * very rare cases where broken 3rd party libs destroys
+ * the OS socket beyond our control. If you can't explain
+ * in minute details why forcing is absolutely necessary
+ * then you don't need it. That was a NO!
+ * @param eh The event handler object to remove
+ * @param force *DANGEROUS* See method description!
+ * @return True if the event handler was removed
+ */
+ virtual bool DelFd(EventHandler* eh, bool force = false);
+
+ /** Returns true if a file descriptor exists in
+ * the socket engine's list.
+ * @param fd The event handler to look for
+ * @return True if this fd has an event handler
+ */
+ virtual bool HasFd(int fd);
+
+ /** Returns the EventHandler attached to a specific fd.
+ * If the fd isnt in the socketengine, returns NULL.
+ * @param fd The event handler to look for
+ * @return A pointer to the event handler, or NULL
+ */
+ virtual EventHandler* GetRef(int fd);
+
+ /** Waits for events and dispatches them to handlers.
+ * Please note that this doesnt wait long, only
+ * a couple of milliseconds. It returns the number of
+ * events which occured during this call.
+ * This method will dispatch events to their handlers
+ * by calling their EventHandler::HandleEvent()
+ * methods with the neccessary EventType value.
+ * @return The number of events which have occured.
+ */
+ virtual int DispatchEvents();
+
+ /** Returns the socket engines name.
+ * This returns the name of the engine for use
+ * in /VERSION responses.
+ * @return The socket engine name
+ */
+ virtual std::string GetName();
};
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-// Fill the engine with client file descriptors pending an action
-
-#define epoll_fill int i = epoll_wait(ep, event, 1, 5); \
- if (i > 0) \
- { \
- log(DEBUG,"epoll_wait call: ep=%d, i=%d",ep,i); \
- userrec* cu = fd_ref_table[event[0].data.fd];
-
-#define kqueue_fill ts.tv_sec = 0; \
- ts.tv_nsec = 1000L; \
- int i = kevent(kq, NULL, 0, &ke, 1, &ts); \
- if (i > 0) \
- { \
- log(DEBUG,"kevent call: kq=%d, i=%d",kq,i); \
- userrec* cu = fd_ref_table[ke.ident];
-
-#define select_fill tval.tv_sec = 0; \
- tval.tv_usec = 1000L; \
- selectResult2 = select(FD_SETSIZE, &sfd, NULL, NULL, &tval); \
- if ((selectResult2 > 0) && (xcount != clientlist.end())) \
- for (user_hash::iterator count2a = xcount; count2a != endingiter; count2a++) \
- { \
- if (count2a == clientlist.end()) \
- break; \
- userrec* cu = count2a->second;
-
-#ifdef USE_EPOLL
-#define engine_fill epoll_fill
-#endif
-#ifdef USE_KQUEUE
-#define engine_fill kqueue_fill
-#endif
-#ifdef USE_SELECT
-#define engine_fill select_fill
-#endif
-
-// how to determine if a socket needs attention if further checks are needed
-
-#define epoll_check ((cu->fd != FD_MAGIC_NUMBER) && (cu->fd != -1))
-
-#define kqueue_check ((cu->fd != FD_MAGIC_NUMBER) && (cu->fd != -1))
-
-#define select_check ((cu->fd != FD_MAGIC_NUMBER) && (cu->fd != -1) && (FD_ISSET (cu->fd, &sfd)))
-
-#ifdef USE_EPOLL
-#define engine_check epoll_check
-#endif
-#ifdef USE_KQUEUE
-#define engine_check kqueue_check
-#endif
-#ifdef USE_SELECT
-#define engine_check select_check
-#endif
-
-// how to clean up an exiting client
-
-#define epoll_cleanup log(DEBUG,"InspIRCd: Exited: %s",cu->nick); \
- kill_link(cu,"Client exited"); \
- log(DEBUG,"Bailing from client exit"); \
- goto label;
-
-#define kqueue_cleanup log(DEBUG,"InspIRCd: Exited: %s",cu->nick); \
- kill_link(cu,"Client exited"); \
- log(DEBUG,"Bailing from client exit"); \
- goto label;
-
-#define select_cleanup if (count2->second) \
- { \
- log(DEBUG,"InspIRCd: Exited: %s",cu->nick); \
- kill_link(cu,"Client exited"); \
- log(DEBUG,"Bailing from client exit"); \
- goto label; \
- }
-
-#ifdef USE_EPOLL
-#define engine_cleanup epoll_cleanup
-#endif
-#ifdef USE_KQUEUE
-#define engine_cleanup kqueue_cleanup
-#endif
-#ifdef USE_SELECT
-#define engine_cleanup select_cleanup
-#endif
-
-
-// how to scan the set for fd's requiring action
-
-#define select_scanset for (count = 0; count < boundPortCount; count++) \
- { \
- FD_SET (openSockfd[count], &selectFds); \
- } \
- tv.tv_usec = 30000L; \
- selectResult = select(MAXSOCKS, &selectFds, NULL, NULL, &tv); \
- if (selectResult > 0) \
- { \
- for (count = 0; count < boundPortCount; count++) \
- { \
- if (FD_ISSET (openSockfd[count], &selectFds)) \
- {
-
-#define kqueue_scanset ts.tv_sec = 0; \
- ts.tv_nsec = 30000L; \
- i = kevent(lkq, NULL, 0, ke_list, 32, &ts); \
- if (i > 0) for (j = 0; j < i; j++) \
- { \
- log(DEBUG,"kqueue: Listening socket event, i=%d, ke.ident=%d",i,ke_list[j].ident); \
- for (count = 0; count < boundPortCount; count++) \
- { \
- if ((unsigned)ke_list[j].ident == (unsigned)openSockfd[count]) \
- {
-
-#define epoll_scanset i = epoll_wait(lep, event, 32, EP_DELAY); \
- if (i > 0) for (j = 0; j < i; j++) \
- { \
- log(DEBUG,"epoll: Listening socket event, i=%d,events[j].data.fd=%d",i,event[j].data.fd); \
- for (count = 0; count < boundPortCount; count++) \
- { \
- if ((unsigned)event[j].data.fd == (unsigned)openSockfd[count]) \
- {
-
-#ifdef USE_EPOLL
-#define engine_scanset epoll_scanset
-#endif
-#ifdef USE_KQUEUE
-#define engine_scanset kqueue_scanset
-#endif
-#ifdef USE_SELECT
-#define engine_scanset select_scanset
-#endif
-
-// a list of variables used specifically by this engine
-
-#define kqueue_structs struct kevent ke; \
- struct kevent ke_list[33]; \
- struct timespec ts;
-
-#define epoll_structs struct epoll_event event[33];
-
-#define select_structs fd_set sfd;
-
-#ifdef USE_EPOLL
-#define engine_structs epoll_structs
-#endif
-#ifdef USE_KQUEUE
-#define engine_structs kqueue_structs
-#endif
-#ifdef USE_SELECT
-#define engine_structs select_structs
-#endif
-
-// how to initialise the engine before using it
-
-#define select_init while(0);
-
-#define kqueue_init kq = kqueue(); \
- lkq = kqueue(); \
- skq = kqueue(); \
- if ((kq == -1) || (lkq == -1) || (skq == -1)) \
- { \
- log(DEFAULT,"main: kqueue() failed!"); \
- printf("ERROR: could not initialise kqueue event system. Shutting down.\n"); \
- Exit(ERROR); \
- }
-
-#define epoll_init ep = epoll_create(MAXCLIENTS); \
- lep = epoll_create(32); \
- sep = epoll_create(128); \
- if ((ep == -1) || (lep == -1) || (sep == -1)) \
- { \
- log(DEFAULT,"main: epoll_create() failed!"); \
- printf("ERROR: could not initialise epoll event system. Shutting down.\n"); \
- Exit(ERROR); \
- }
-
-
-#ifdef USE_EPOLL
-#define engine_init epoll_init
-#endif
-#ifdef USE_KQUEUE
-#define engine_init kqueue_init
-#endif
-#ifdef USE_SELECT
-#define engine_init select_init
-#endif
-
-// how to delete a client fd from the engine
-
-#define kqueue_delete_fd struct kevent ke; \
- EV_SET(&ke, user->fd, EVFILT_READ, EV_DELETE, 0, 0, NULL); \
- int i = kevent(kq, &ke, 1, 0, 0, NULL); \
- if (i == -1) \
- { \
- log(DEBUG,"kqueue: Failed to remove user from queue!"); \
- }
-
-#define epoll_delete_fd struct epoll_event ev; \
- ev.events = EPOLLIN | EPOLLET; \
- ev.data.fd = user->fd; \
- int i = epoll_ctl(ep, EPOLL_CTL_DEL, user->fd, &ev); \
- if (i < 0) \
- { \
- log(DEBUG,"epoll: List deletion failure!"); \
- }
-
-#define select_delete_fd while(0);
-
-
-#ifdef USE_EPOLL
-#define engine_delete_fd epoll_delete_fd
-#endif
-#ifdef USE_KQUEUE
-#define engine_delete_fd kqueue_delete_fd
-#endif
-#ifdef USE_SELECT
-#define engine_delete_fd select_delete_fd
-#endif
-
-// how to add a client fd to the engine
-
-#define select_add_fd while(0);
-
-#define epoll_add_fd struct epoll_event ev; \
- log(DEBUG,"epoll: Adduser to events, ep=%d socket=%d",ep,socket); \
- ev.events = EPOLLIN | EPOLLET; \
- ev.data.fd = socket; \
- int i = epoll_ctl(ep, EPOLL_CTL_ADD, socket, &ev); \
- if (i < 0) \
- { \
- log(DEBUG,"epoll: List insertion failure!"); \
- }
-
-#define kqueue_add_fd struct kevent ke; \
- log(DEBUG,"kqueue: Add user to events, kq=%d socket=%d",kq,socket);\
- EV_SET(&ke, socket, EVFILT_READ, EV_ADD, 0, 0, NULL); \
- int i = kevent(kq, &ke, 1, 0, 0, NULL); \
- if (i == -1) \
- { \
- log(DEBUG,"kqueue: List insertion failure!"); \
- }
-
-#ifdef USE_EPOLL
-#define engine_add_fd epoll_add_fd
-#endif
-#ifdef USE_KQUEUE
-#define engine_add_fd kqueue_add_fd
-#endif
-#ifdef USE_SELECT
-#define engine_add_fd select_add_fd
-#endif
-
-#define select_server_fill log(DEFAULT,"Using standard select socket engine.");
-
-#define epoll_server_fill log(DEFAULT,"epoll socket engine is enabled. Filling listen list. boundPortcount=%d",boundPortCount); \
- for (count = 0; count < boundPortCount; count++) \
- { \
- struct epoll_event ev; \
- log(DEBUG,"epoll: Add listening socket to events, ep=%d socket=%d",lep,openSockfd[count]); \
- ev.events = EPOLLIN | EPOLLET; \
- ev.data.fd = openSockfd[count]; \
- int i = epoll_ctl(lep, EPOLL_CTL_ADD, openSockfd[count], &ev); \
- if (i < 0) \
- { \
- log(DEFAULT,"main: add listen ports, epoll_ctl failed!"); \
- printf("ERROR: could not initialise listening sockets in epoll list. Shutting down.\n"); \
- Exit(ERROR); \
- } \
- }
-
-#define kqueue_server_fill log(DEFAULT,"kqueue socket engine is enabled. Filling listen list."); \
- for (count = 0; count < boundPortCount; count++) \
- { \
- struct kevent ke; \
- log(DEBUG,"kqueue: Add listening socket to events, kq=%d socket=%d",lkq,openSockfd[count]); \
- EV_SET(&ke, openSockfd[count], EVFILT_READ, EV_ADD, 0, MaxConn, NULL); \
- int i = kevent(lkq, &ke, 1, 0, 0, NULL); \
- if (i == -1) \
- { \
- log(DEFAULT,"main: add listen ports to kqueue failed!"); \
- printf("ERROR: could not initialise listening sockets in kqueue. Shutting down.\n"); \
- Exit(ERROR); \
- } \
- }
-
-#ifdef USE_EPOLL
-#define engine_server_fill epoll_server_fill
-#endif
-#ifdef USE_KQUEUE
-#define engine_server_fill kqueue_server_fill
-#endif
-#ifdef USE_SELECT
-#define engine_server_fill select_server_fill
-#endif
-
-
-// what is this engine called?
-
-#ifdef USE_KQUEUE
-#define engine_name "kqueue"
-#endif
-#ifdef USE_SELECT
-#define engine_name "select"
-#endif
-#ifdef USE_EPOLL
-#define engine_name "epoll"
-#endif
-
-
#endif