include/inspsocket.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   7  *   Copyright (C) 2006-2007 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
   9  *
  10  * This file is part of InspIRCd.  InspIRCd is free software: you can
  11  * redistribute it and/or modify it under the terms of the GNU General Public
  12  * License as published by the Free Software Foundation, version 2.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  */
  22
  23
  24 #pragma once
  25
  26 #include "timer.h"
  27
  28 class IOHook;
  29
  30 /**
  31  * States which a socket may be in
  32  */
  33 enum BufferedSocketState
  34 {
  35         /** Socket disconnected */
  36         I_DISCONNECTED,
  37         /** Socket connecting */
  38         I_CONNECTING,
  39         /** Socket fully connected */
  40         I_CONNECTED,
  41         /** Socket has an error */
  42         I_ERROR
  43 };
  44
  45 /**
  46  * Error types which a socket may exhibit
  47  */
  48 enum BufferedSocketError
  49 {
  50         /** No error */
  51         I_ERR_NONE,
  52         /** Socket was closed by peer */
  53         I_ERR_DISCONNECT,
  54         /** Socket connect timed out */
  55         I_ERR_TIMEOUT,
  56         /** Socket could not be created */
  57         I_ERR_SOCKET,
  58         /** Socket could not connect (refused) */
  59         I_ERR_CONNECT,
  60         /** Socket could not bind to local port/ip */
  61         I_ERR_BIND,
  62         /** Socket could not write data */
  63         I_ERR_WRITE,
  64         /** No more file descriptors left to create socket! */
  65         I_ERR_NOMOREFDS,
  66         /** Some other error */
  67         I_ERR_OTHER
  68 };
  69
  70 /* Required forward declarations */
  71 class BufferedSocket;
  72
  73 /** Used to time out socket connections
  74  */
  75 class CoreExport SocketTimeout : public Timer
  76 {
  77  private:
  78         /** BufferedSocket the class is attached to
  79          */
  80         BufferedSocket* sock;
  81
  82         /** File descriptor of class this is attached to
  83          */
  84         int sfd;
  85
  86  public:
  87         /** Create a socket timeout class
  88          * @param fd File descriptor of BufferedSocket
  89          * @param thesock BufferedSocket to attach to
  90          * @param secs_from_now Seconds from now to time out
  91          * @param now The current time
  92          */
  93         SocketTimeout(int fd, BufferedSocket* thesock, long secs_from_now) : Timer(secs_from_now), sock(thesock), sfd(fd) { }
  94
  95         /** Handle tick event
  96          */
  97         virtual bool Tick(time_t now);
  98 };
  99
 100 /**
 101  * StreamSocket is a class that wraps a TCP socket and handles send
 102  * and receive queues, including passing them to IO hooks
 103  */
 104 class CoreExport StreamSocket : public EventHandler
 105 {
 106  public:
 107         /** Socket send queue
 108          */
 109         class SendQueue
 110         {
 111          public:
 112                 /** One element of the queue, a continuous buffer
 113                  */
 114                 typedef std::string Element;
 115
 116                 /** Sequence container of buffers in the queue
 117                  */
 118                 typedef std::deque<Element> Container;
 119
 120                 /** Container iterator
 121                  */
 122                 typedef Container::const_iterator const_iterator;
 123
 124                 SendQueue() : nbytes(0) { }
 125
 126                 /** Return whether the queue is empty
 127                  * @return True if the queue is empty, false otherwise
 128                  */
 129                 bool empty() const { return (nbytes == 0); }
 130
 131                 /** Get the number of individual buffers in the queue
 132                  * @return Number of individual buffers in the queue
 133                  */
 134                 Container::size_type size() const { return data.size(); }
 135
 136                 /** Get the number of queued bytes
 137                  * @return Size in bytes of the data in the queue
 138                  */
 139                 size_t bytes() const { return nbytes; }
 140
 141                 /** Get the first buffer of the queue
 142                  * @return A reference to the first buffer in the queue
 143                  */
 144                 const Element& front() const { return data.front(); }
 145
 146                 /** Get an iterator to the first buffer in the queue.
 147                  * The returned iterator cannot be used to make modifications to the queue,
 148                  * for that purpose the member functions push_*(), pop_front(), erase_front() and clear() can be used.
 149                  * @return Iterator referring to the first buffer in the queue, or end() if there are no elements.
 150                  */
 151                 const_iterator begin() const { return data.begin(); }
 152
 153                 /** Get an iterator to the (theoretical) buffer one past the end of the queue.
 154                  * @return Iterator referring to one element past the end of the container
 155                  */
 156                 const_iterator end() const { return data.end(); }
 157
 158                 /** Remove the first buffer in the queue
 159                  */
 160                 void pop_front()
 161                 {
 162                         nbytes -= data.front().length();
 163                         data.pop_front();
 164                 }
 165
 166                 /** Remove bytes from the beginning of the first buffer
 167                  * @param n Number of bytes to remove
 168                  */
 169                 void erase_front(Element::size_type n)
 170                 {
 171                         nbytes -= n;
 172                         data.front().erase(0, n);
 173                 }
 174
 175                 /** Insert a new buffer at the beginning of the queue
 176                  * @param newdata Data to add
 177                  */
 178                 void push_front(const Element& newdata)
 179                 {
 180                         data.push_front(newdata);
 181                         nbytes += newdata.length();
 182                 }
 183
 184                 /** Insert a new buffer at the end of the queue
 185                  * @param newdata Data to add
 186                  */
 187                 void push_back(const Element& newdata)
 188                 {
 189                         data.push_back(newdata);
 190                         nbytes += newdata.length();
 191                 }
 192
 193                 /** Clear the queue
 194                  */
 195                 void clear()
 196                 {
 197                         data.clear();
 198                         nbytes = 0;
 199                 }
 200
 201          private:
 202                 /** Private send queue. Note that individual strings may be shared.
 203                  */
 204                 Container data;
 205
 206                 /** Length, in bytes, of the sendq
 207                  */
 208                 size_t nbytes;
 209         };
 210
 211  private:
 212         /** The IOHook that handles raw I/O for this socket, or NULL */
 213         IOHook* iohook;
 214
 215         /** Send queue of the socket
 216          */
 217         SendQueue sendq;
 218
 219         /** Error - if nonempty, the socket is dead, and this is the reason. */
 220         std::string error;
 221
 222         /** Check if the socket has an error set, if yes, call OnError
 223          * @param err Error to pass to OnError()
 224          */
 225         void CheckError(BufferedSocketError err);
 226
 227         /** Read data from the socket into the recvq, if successful call OnDataReady()
 228          */
 229         void DoRead();
 230
 231         /** Send as much data contained in a SendQueue object as possible.
 232          * All data which successfully sent will be removed from the SendQueue.
 233          * @param sq SendQueue to flush
 234          */
 235         void FlushSendQ(SendQueue& sq);
 236
 237         /** Read incoming data into a receive queue.
 238          * @param rq Receive queue to put incoming data into
 239          * @return < 0 on error or close, 0 if no new data is ready (but the socket is still connected), > 0 if data was read from the socket and put into the recvq
 240          */
 241         int ReadToRecvQ(std::string& rq);
 242
 243         /** Read data from a hook chain recursively, starting at 'hook'.
 244          * If 'hook' is NULL, the recvq is filled with data from SocketEngine::Recv(), otherwise it is filled with data from the
 245          * next hook in the chain.
 246          * @param hook Next IOHook in the chain, can be NULL
 247          * @param rq Receive queue to put incoming data into
 248          * @return < 0 on error or close, 0 if no new data is ready (but the socket is still connected), > 0 if data was read from
 249          the socket and put into the recvq
 250          */
 251         int HookChainRead(IOHook* hook, std::string& rq);
 252
 253  protected:
 254         std::string recvq;
 255  public:
 256         StreamSocket() : iohook(NULL) { }
 257         IOHook* GetIOHook() const;
 258         void AddIOHook(IOHook* hook);
 259         void DelIOHook();
 260
 261         /** Flush the send queue
 262          */
 263         void DoWrite();
 264
 265         /** Called by the socket engine on a read event
 266          */
 267         void OnEventHandlerRead() CXX11_OVERRIDE;
 268
 269         /** Called by the socket engine on a write event
 270          */
 271         void OnEventHandlerWrite() CXX11_OVERRIDE;
 272
 273         /** Called by the socket engine on error
 274          * @param errcode Error
 275          */
 276         void OnEventHandlerError(int errcode) CXX11_OVERRIDE;
 277
 278         /** Sets the error message for this socket. Once set, the socket is dead. */
 279         void SetError(const std::string& err) { if (error.empty()) error = err; }
 280
 281         /** Gets the error message for this socket. */
 282         const std::string& getError() const { return error; }
 283
 284         /** Called when new data is present in recvq */
 285         virtual void OnDataReady() = 0;
 286         /** Called when the socket gets an error from socket engine or IO hook */
 287         virtual void OnError(BufferedSocketError e) = 0;
 288
 289         /** Send the given data out the socket, either now or when writes unblock
 290          */
 291         void WriteData(const std::string& data);
 292         /** Convenience function: read a line from the socket
 293          * @param line The line read
 294          * @param delim The line delimiter
 295          * @return true if a line was read
 296          */
 297         bool GetNextLine(std::string& line, char delim = '\n');
 298         /** Useful for implementing sendq exceeded */
 299         size_t getSendQSize() const;
 300
 301         SendQueue& GetSendQ() { return sendq; }
 302
 303         /**
 304          * Close the socket, remove from socket engine, etc
 305          */
 306         virtual void Close();
 307         /** This ensures that close is called prior to destructor */
 308         virtual CullResult cull();
 309
 310         /** Get the IOHook of a module attached to this socket
 311          * @param mod Module whose IOHook to return
 312          * @return IOHook belonging to the module or NULL if the module haven't attached an IOHook to this socket
 313          */
 314         IOHook* GetModHook(Module* mod) const;
 315 };
 316 /**
 317  * BufferedSocket is an extendable socket class which modules
 318  * can use for TCP socket support. It is fully integrated
 319  * into InspIRCds socket loop and attaches its sockets to
 320  * the core's instance of the SocketEngine class, meaning
 321  * that all use is fully asynchronous.
 322  *
 323  * To use BufferedSocket, you must inherit a class from it.
 324  */
 325 class CoreExport BufferedSocket : public StreamSocket
 326 {
 327  public:
 328         /** Timeout object or NULL
 329          */
 330         SocketTimeout* Timeout;
 331
 332         /**
 333          * The state for this socket, either
 334          * listening, connecting, connected
 335          * or error.
 336          */
 337         BufferedSocketState state;
 338
 339         BufferedSocket();
 340         /**
 341          * This constructor is used to associate
 342          * an existing connecting with an BufferedSocket
 343          * class. The given file descriptor must be
 344          * valid, and when initialized, the BufferedSocket
 345          * will be placed in CONNECTED state.
 346          */
 347         BufferedSocket(int newfd);
 348
 349         /** Begin connection to the given address
 350          * This will create a socket, register with socket engine, and start the asynchronous
 351          * connection process. If an error is detected at this point (such as out of file descriptors),
 352          * OnError will be called; otherwise, the state will become CONNECTING.
 353          * @param ipaddr Address to connect to
 354          * @param aport Port to connect on
 355          * @param maxtime Time to wait for connection
 356          * @param connectbindip Address to bind to (if NULL, no bind will be done)
 357          */
 358         void DoConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip);
 359
 360         /** This method is called when an outbound connection on your socket is
 361          * completed.
 362          */
 363         virtual void OnConnected();
 364
 365         /** When there is data waiting to be read on a socket, the OnDataReady()
 366          * method is called.
 367          */
 368         virtual void OnDataReady() = 0;
 369
 370         /**
 371          * When an outbound connection fails, and the attempt times out, you
 372          * will receive this event.  The method will trigger once maxtime
 373          * seconds are reached (as given in the constructor) just before the
 374          * socket's descriptor is closed.  A failed DNS lookup may cause this
 375          * event if the DNS server is not responding, as well as a failed
 376          * connect() call, because DNS lookups are nonblocking as implemented by
 377          * this class.
 378          */
 379         virtual void OnTimeout();
 380
 381         virtual ~BufferedSocket();
 382  protected:
 383         void OnEventHandlerWrite() CXX11_OVERRIDE;
 384         BufferedSocketError BeginConnect(const irc::sockets::sockaddrs& dest, const irc::sockets::sockaddrs& bind, unsigned long timeout);
 385         BufferedSocketError BeginConnect(const std::string &ipaddr, int aport, unsigned long maxtime, const std::string &connectbindip);
 386 };
 387
 388 inline IOHook* StreamSocket::GetIOHook() const { return iohook; }
 389 inline void StreamSocket::DelIOHook() { iohook = NULL; }