include/socketengine.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15 */
  16
  17 #ifndef __SOCKETENGINE__
  18 #define __SOCKETENGINE__
  19
  20 #include <vector>
  21 #include <string>
  22 #include <map>
  23 #include "inspircd_config.h"
  24 #include "globals.h"
  25 #include "inspircd.h"
  26 #ifdef USE_EPOLL
  27 #include <sys/epoll.h>
  28 #define EP_DELAY 5
  29 #endif
  30 #ifdef USE_KQUEUE
  31 #include <sys/types.h>
  32 #include <sys/event.h>
  33 #include <sys/time.h>
  34 #endif
  35
  36 /**
  37  * Each of these values represents a socket
  38  * type in our reference table (the reference
  39  * table itself is only accessible to
  40  * socketengine.cpp)
  41  */
  42 const char X_EMPTY_SLOT         = 0;
  43 const char X_LISTEN             = 1;
  44 const char X_ESTAB_CLIENT       = 2;
  45 const char X_ESTAB_MODULE       = 3;
  46 const char X_ESTAB_DNS          = 4;
  47
  48 /**
  49  * To indicate that a socket is readable, we
  50  * mask its top bit with this X_READBIT value.
  51  * The socket engine can handle two types of
  52  * socket, readable and writeable (error sockets
  53  * are dealt with when read() and write() return
  54  * negative or zero values).
  55  */
  56 const char X_READBIT            = 0x80;
  57
  58 /**
  59  * The actual socketengine class presents the
  60  * same interface on all operating systems, but
  61  * its private members and internal behaviour
  62  * should be treated as blackboxed, and vary
  63  * from system to system and upon the config
  64  * settings chosen by the server admin. The current
  65  * version supports select, epoll and kqueue.
  66  */
  67 class SocketEngine {
  68
  69         int EngineHandle;                       /* Handle to the socket engine if needed */
  70         int CurrentSetSize;                     /* Current number of descriptors in the engine */
  71 #ifdef USE_SELECT
  72         std::map<int,int> fds;                  /* List of file descriptors being monitored */
  73         fd_set wfdset, rfdset;                  /* Readable and writeable sets for select() */
  74 #endif
  75 #ifdef USE_KQUEUE
  76         struct kevent ke_list[MAX_DESCRIPTORS]; /* Up to 64k sockets for kqueue */
  77         struct timespec ts;                     /* kqueue delay value */
  78 #endif
  79 #ifdef USE_EPOLL
  80         struct epoll_event events[MAX_DESCRIPTORS];     /* Up to 64k sockets for epoll */
  81 #endif
  82
  83 public:
  84
  85         /** Constructor
  86          * The constructor transparently initializes
  87          * the socket engine which the ircd is using.
  88          * Please note that if there is a catastrophic
  89          * failure (for example, you try and enable
  90          * epoll on a 2.4 linux kernel) then this
  91          * function may bail back to the shell.
  92          */
  93         SocketEngine();
  94
  95         /** Destructor
  96          * The destructor transparently tidies up
  97          * any resources used by the socket engine.
  98          */
  99         ~SocketEngine();
 100
 101         /** Add a file descriptor to the engine
 102          * Use AddFd to add a file descriptor to the
 103          * engine and have the socket engine monitor
 104          * it. You must provide a type (see the consts
 105          * in socketengine.h) and a boolean flag to
 106          * indicate wether to watch this fd for read
 107          * or write events (there is currently no
 108          * need for support of both).
 109          */
 110         bool AddFd(int fd, bool readable, char type);
 111
 112         /** Returns the type value for this file descriptor
 113          * This function masks off the X_READBIT value
 114          * so that the type of the socket can be obtained.
 115          * The core uses this to decide where to dispatch
 116          * the event to. Please note that some engines
 117          * such as select() have an upper limit of 1024
 118          * descriptors which may be active at any one time,
 119          * where others such as kqueue have no practical
 120          * limits at all.
 121          */
 122         char GetType(int fd);
 123
 124         /** Returns the maximum number of file descriptors
 125          * you may store in the socket engine at any one time.
 126          */
 127         int GetMaxFds();
 128
 129         /** Returns the number of file descriptor slots
 130          * which are available for storing fds.
 131          */
 132         int GetRemainingFds();
 133
 134         /** Delete a file descriptor from the engine
 135          * This function call deletes a file descriptor
 136          * from the engine, returning true if it succeeded
 137          * and false if it failed.
 138          */
 139         bool DelFd(int fd);
 140
 141         bool HasFd(int fd);
 142
 143         /** Waits for an event.
 144          * Please note that this doesnt wait long, only
 145          * a couple of milliseconds. It returns a list
 146          * of active file descriptors in the vector
 147          * fdlist which the core may then act upon.
 148          */
 149         int Wait(int* fdlist);
 150
 151         /** Returns the socket engines name
 152          * This returns the name of the engine for use
 153          * in /VERSION responses.
 154          */
 155         std::string GetName();
 156 };
 157
 158 #endif