citadel/event_client.h

   1 /*
   2  *
   3  * Copyright (c) 1998-2012 by the citadel.org team
   4  *
   5  *  This program is open source software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License, version 3.
   7  *
   8  *  This program is distributed in the hope that it will be useful,
   9  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  *  GNU General Public License for more details.
  12  */
  13
  14 #ifndef __EVENT_CLIENT_H__
  15 #define __EVENT_CLIENT_H__
  16 #define EV_COMPAT3 0
  17 #include "sysconfig.h"
  18 #include <ev.h>
  19 #include <sys/types.h>
  20 #include <sys/socket.h>
  21 #include <netdb.h>
  22 #include <arpa/nameser.h>
  23 #include <ares.h>
  24 #include <curl/curl.h>
  25
  26 #ifndef __ASYNCIO__
  27 #define __ASYNCIO__
  28 typedef struct AsyncIO AsyncIO;
  29 #endif
  30 #ifndef __CIT_CONTEXT__
  31 #define __CIT_CONTEXT__
  32 typedef struct CitContext CitContext;
  33 #endif
  34
  35 typedef enum __eIOState {
  36         eDBQ,
  37         eQDBNext,
  38         eDBAttach,
  39         eDBNext,
  40         eDBStop,
  41         eDBX,
  42         eDBTerm,
  43         eIOQ,
  44         eIOAttach,
  45         eIOConnectSock,
  46         eIOAbort,
  47         eIOTimeout,
  48         eIOConnfail,
  49         eIOConnfailNow,
  50         eIOConnNow,
  51         eIOConnWait,
  52         eCurlQ,
  53         eCurlStart,
  54         eCurlShutdown,
  55         eCurlNewIO,
  56         eCurlGotIO,
  57         eCurlGotData,
  58         eCurlGotStatus,
  59         eCaresStart,
  60         eCaresDoneIO,
  61         eCaresFinished,
  62         eCaresX,
  63         eKill,
  64         eExit
  65 }eIOState;
  66
  67 typedef enum _eNextState {
  68         eSendDNSQuery,
  69         eReadDNSReply,
  70
  71         eDBQuery,
  72
  73         eConnect,
  74         eSendReply,
  75         eSendMore,
  76         eSendFile,
  77
  78         eReadMessage,
  79         eReadMore,
  80         eReadPayload,
  81         eReadFile,
  82
  83         eTerminateConnection,
  84         eAbort
  85 }eNextState;
  86
  87 void SetEVState(AsyncIO *IO, eIOState State);
  88
  89 typedef eNextState (*IO_CallBack)(AsyncIO *IO);
  90 typedef eReadState (*IO_LineReaderCallback)(AsyncIO *IO);
  91 typedef void (*ParseDNSAnswerCb)(AsyncIO*, unsigned char*, int);
  92 typedef void (*FreeDNSReply)(void *DNSData);
  93
  94
  95 typedef struct __ReadAsyncMsg {
  96         StrBuf *MsgBuf;
  97         size_t maxlen;          /* maximum message length */
  98
  99         const char *terminator; /* token signalling EOT */
 100         long tlen;
 101         int dodot;
 102
 103         int flushing;
 104 /* if we read maxlen, read until nothing more arives and ignore this. */
 105
 106         int crlf;               /* CRLF newlines instead of LF */
 107 } ReadAsyncMsg;
 108
 109
 110 typedef struct _DNSQueryParts {
 111         ParseDNSAnswerCb DNS_CB;
 112         IO_CallBack PostDNS;
 113
 114         const char *QueryTYPE;
 115         const char *QStr;
 116         int DNSStatus;
 117         void *VParsedDNSReply;
 118         FreeDNSReply DNSReplyFree;
 119         void *Data;
 120 } DNSQueryParts;
 121
 122 typedef struct _evcurl_request_data
 123 {
 124         CURL                    *chnd;
 125         struct curl_slist       *headers;
 126         char                     errdesc[CURL_ERROR_SIZE];
 127         const char              *CurlError;
 128
 129         int                      attached;
 130
 131         char                    *PlainPostData;
 132         long                     PlainPostDataLen;
 133         StrBuf                  *PostData;
 134
 135         StrBuf                  *ReplyData;
 136         long                     httpcode;
 137 } evcurl_request_data;
 138
 139 /* DNS Related */
 140 typedef struct __evcares_data {
 141         ev_tstamp Start;
 142         ev_io recv_event,
 143                 send_event;
 144         ev_timer timeout;           /* timeout while requesting ips */
 145         short int SourcePort;
 146
 147         struct ares_options Options;
 148         ares_channel Channel;
 149         DNSQueryParts *Query;
 150
 151         IO_CallBack Fail;      /* the dns lookup didn't work out. */
 152 } evcares_data;
 153
 154 struct AsyncIO {
 155         long ID;
 156         ev_tstamp Now;
 157         ev_tstamp StartIO;
 158         ev_tstamp StartDB;
 159         eNextState NextState;
 160
 161         /* connection related */
 162         ParsedURL *ConnectMe;
 163
 164         /* read/send related... */
 165         StrBuf *IOBuf;
 166         IOBuffer SendBuf,
 167                 RecvBuf;
 168
 169         FDIOBuffer IOB;
 170         /* when sending from / reading into files, this is used. */
 171
 172         /* our events... */
 173         ev_cleanup abort_by_shutdown, /* server wants to go down... */
 174                 db_abort_by_shutdown; /* server wants to go down... */
 175         ev_timer conn_fail,           /* connection establishing timed out */
 176                 rw_timeout;           /* timeout while sending data */
 177         ev_idle unwind_stack,         /* get c-ares out of the stack */
 178                 db_unwind_stack,      /* wait for next db operation... */
 179                 conn_fail_immediate;  /* unwind stack, but fail immediately. */
 180         ev_io recv_event,             /* receive data from the client */
 181                 send_event,           /* send more data to the client */
 182                 conn_event;           /* Connection successfully established */
 183
 184         StrBuf *ErrMsg; /* if we fail to connect, or lookup, error goes here. */
 185
 186         /* Citadel application callbacks... */
 187         IO_CallBack ReadDone, /* Theres new data to read... */
 188                 SendDone,     /* we may send more data */
 189                 Terminate,    /* shutting down... */
 190                 DBTerminate,  /* shutting down... */
 191                 Timeout,      /* Timeout handler;may also be conn. timeout */
 192                 ConnFail,     /* What to do when one connection failed? */
 193                 ShutdownAbort,/* we're going down. make your piece. */
 194                 NextDBOperation; /* Perform Database IO */
 195
 196         /* if we have linereaders, maybe we want to read more lines before
 197          * the real application logic is called? */
 198         IO_LineReaderCallback LineReader;
 199
 200         evcares_data DNS;
 201
 202         evcurl_request_data HttpReq;
 203
 204         /* Saving / loading a message async from / to disk */
 205         ReadAsyncMsg *ReadMsg;
 206         struct CtdlMessage *AsyncMsg;
 207         recptypes *AsyncRcp;
 208
 209         /* Context specific data; Hint: put AsyncIO in there */
 210         void *Data;        /* application specific data */
 211         CitContext *CitContext;  /* Citadel Session context... */
 212 };
 213
 214 typedef struct _IOAddHandler {
 215         AsyncIO *IO;
 216         IO_CallBack EvAttch;
 217 } IOAddHandler;
 218
 219
 220
 221 extern int DebugEventLoop;
 222 extern int DebugCAres;
 223
 224 #define EDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugEventLoop != 0))
 225
 226 #define CCID ((CitContext*)IO->CitContext)?((CitContext*)IO->CitContext)->cs_pid:-1
 227
 228 #define EVQ_syslog(LEVEL, FORMAT, ...)                                  \
 229         EDBGLOG (LEVEL) syslog(LEVEL, "IOQ " FORMAT, __VA_ARGS__)
 230
 231 #define EVQM_syslog(LEVEL, FORMAT)                      \
 232         EDBGLOG (LEVEL) syslog(LEVEL, "IO " FORMAT)
 233
 234 #define EV_syslog(LEVEL, FORMAT, ...)                                   \
 235         EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
 236
 237 #define EVM_syslog(LEVEL, FORMAT)                                       \
 238         EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
 239
 240 #define EVNC_syslog(LEVEL, FORMAT, ...)                                 \
 241         EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld] " FORMAT, IO->ID, __VA_ARGS__)
 242
 243 #define EVNCM_syslog(LEVEL, FORMAT) EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
 244
 245
 246 #define CDBGLOG() if (DebugCAres != 0)
 247 #define CEDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugCAres != 0))
 248 #define EV_DNS_LOG_START(a)                                                     \
 249         CDBGLOG () {syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
 250                     EV_backtrace(IO);}
 251
 252 #define EV_DNS_LOG_STOP(a)                                                      \
 253         CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
 254                      EV_backtrace(IO);}
 255
 256 #define EV_DNS_LOG_INIT(a)                                                      \
 257         CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
 258                      EV_backtrace(IO);}
 259
 260 #define EV_DNS_LOGT_START(a)                                                    \
 261         CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
 262                      EV_backtrace(IO);}
 263
 264 #define EV_DNS_LOGT_STOP(a)                                                     \
 265         CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
 266                      EV_backtrace(IO); }
 267
 268 #define EV_DNS_LOGT_INIT(a)                                                     \
 269         CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p", IO->ID, CCID, &IO->a); \
 270                      EV_backtrace(IO);}
 271
 272 #define EV_DNS_syslog(LEVEL, FORMAT, ...)                               \
 273         CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
 274
 275 #define EVM_DNS_syslog(LEVEL, FORMAT)                                   \
 276         CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
 277
 278 void FreeAsyncIOContents(AsyncIO *IO);
 279
 280 eNextState NextDBOperation(AsyncIO *IO, IO_CallBack CB);
 281 eNextState QueueDBOperation(AsyncIO *IO, IO_CallBack CB);
 282 eNextState EventQueueDBOperation(AsyncIO *IO, IO_CallBack CB);
 283 void StopDBWatchers(AsyncIO *IO);
 284 eNextState QueueEventContext(AsyncIO *IO, IO_CallBack CB);
 285 eNextState QueueCurlContext(AsyncIO *IO);
 286 eNextState DBQueueEventContext(AsyncIO *IO, IO_CallBack CB);
 287
 288 eNextState EvConnectSock(AsyncIO *IO,
 289                          double conn_timeout,
 290                          double first_rw_timeout,
 291                          int ReadFirst);
 292 void IO_postdns_callback(struct ev_loop *loop, ev_idle *watcher, int revents);
 293
 294 int QueueQuery(ns_type Type,
 295                const char *name,
 296                AsyncIO *IO,
 297                DNSQueryParts *QueryParts,
 298                IO_CallBack PostDNS);
 299
 300 void QueueGetHostByName(AsyncIO *IO,
 301                         const char *Hostname,
 302                         DNSQueryParts *QueryParts,
 303                         IO_CallBack PostDNS);
 304
 305 void QueryCbDone(AsyncIO *IO);
 306
 307 void StopClient(AsyncIO *IO);
 308
 309 void StopClientWatchers(AsyncIO *IO, int CloseFD);
 310
 311 void SetNextTimeout(AsyncIO *IO, double timeout);
 312
 313 #include <curl/curl.h>
 314
 315 #define OPT(s, v) \
 316         do { \
 317                 sta = curl_easy_setopt(chnd, (CURLOPT_##s), (v));       \
 318                 if (sta)  {                                             \
 319                         EVQ_syslog(LOG_ERR,                             \
 320                                "error setting option " #s               \
 321                                " on curl handle: %s",                   \
 322                                curl_easy_strerror(sta));                \
 323         } } while (0)
 324
 325 void InitIOStruct(AsyncIO *IO,
 326                   void *Data,
 327                   eNextState NextState,
 328                   IO_LineReaderCallback LineReader,
 329                   IO_CallBack DNS_Fail,
 330                   IO_CallBack SendDone,
 331                   IO_CallBack ReadDone,
 332                   IO_CallBack Terminate,
 333                   IO_CallBack DBTerminate,
 334                   IO_CallBack ConnFail,
 335                   IO_CallBack Timeout,
 336                   IO_CallBack ShutdownAbort);
 337
 338 int InitcURLIOStruct(AsyncIO *IO,
 339                      void *Data,
 340                      const char* Desc,
 341                      IO_CallBack SendDone,
 342                      IO_CallBack Terminate,
 343                      IO_CallBack DBTerminate,
 344                      IO_CallBack ShutdownAbort);
 345 void KillAsyncIOContext(AsyncIO *IO);
 346 void StopCurlWatchers(AsyncIO *IO);
 347
 348 eNextState CurlQueueDBOperation(AsyncIO *IO, IO_CallBack CB);
 349
 350 eNextState ReAttachIO(AsyncIO *IO,
 351                       void *pData,
 352                       int ReadFirst);
 353
 354 void EV_backtrace(AsyncIO *IO);
 355 ev_tstamp ctdl_ev_now (void);
 356
 357 #endif /* __EVENT_CLIENT_H__ */