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 typedef struct AsyncIO AsyncIO;
  27 typedef struct CitContext CitContext;
  28
  29 typedef enum _eNextState {
  30         eSendDNSQuery,
  31         eReadDNSReply,
  32
  33         eDBQuery,
  34
  35         eConnect,
  36         eSendReply,
  37         eSendMore,
  38         eSendFile,
  39
  40         eReadMessage,
  41         eReadMore,
  42         eReadPayload,
  43         eReadFile,
  44
  45         eTerminateConnection,
  46         eAbort
  47 }eNextState;
  48
  49 typedef eNextState (*IO_CallBack)(AsyncIO *IO);
  50 typedef eReadState (*IO_LineReaderCallback)(AsyncIO *IO);
  51 typedef void (*ParseDNSAnswerCb)(AsyncIO*, unsigned char*, int);
  52 typedef void (*FreeDNSReply)(void *DNSData);
  53
  54
  55 typedef struct __ReadAsyncMsg {
  56         StrBuf *MsgBuf;
  57         size_t maxlen;          /* maximum message length */
  58
  59         const char *terminator; /* token signalling EOT */
  60         long tlen;
  61         int dodot;
  62
  63         int flushing;
  64 /* if we read maxlen, read until nothing more arives and ignore this. */
  65
  66         int crlf;               /* CRLF newlines instead of LF */
  67 } ReadAsyncMsg;
  68
  69
  70 typedef struct _DNSQueryParts {
  71         ParseDNSAnswerCb DNS_CB;
  72         IO_CallBack PostDNS;
  73
  74         int DNSStatus;
  75         void *VParsedDNSReply;
  76         FreeDNSReply DNSReplyFree;
  77         void *Data;
  78 } DNSQueryParts;
  79
  80 typedef struct _evcurl_request_data
  81 {
  82         CURL                    *chnd;
  83         struct curl_slist       *headers;
  84         char                     errdesc[CURL_ERROR_SIZE];
  85
  86         int                      attached;
  87
  88         char                    *PlainPostData;
  89         long                     PlainPostDataLen;
  90         StrBuf                  *PostData;
  91
  92         StrBuf                  *ReplyData;
  93         long                     httpcode;
  94 } evcurl_request_data;
  95
  96 /* DNS Related */
  97 typedef struct __evcares_data {
  98         ev_tstamp Start;
  99         ev_io recv_event,
 100                 send_event;
 101         ev_timer timeout;           /* timeout while requesting ips */
 102         short int SourcePort;
 103
 104         struct ares_options Options;
 105         ares_channel Channel;
 106         DNSQueryParts *Query;
 107
 108         IO_CallBack Fail;      /* the dns lookup didn't work out. */
 109 } evcares_data;
 110
 111 struct AsyncIO {
 112         long ID;
 113         ev_tstamp Now;
 114         ev_tstamp StartIO;
 115         ev_tstamp StartDB;
 116         eNextState NextState;
 117
 118         /* connection related */
 119         ParsedURL *ConnectMe;
 120
 121         /* read/send related... */
 122         StrBuf *IOBuf;
 123         IOBuffer SendBuf,
 124                 RecvBuf;
 125
 126         FDIOBuffer IOB;
 127         /* when sending from / reading into files, this is used. */
 128
 129         /* our events... */
 130         ev_cleanup abort_by_shutdown, /* server wants to go down... */
 131                 db_abort_by_shutdown; /* server wants to go down... */
 132         ev_timer conn_fail,           /* connection establishing timed out */
 133                 rw_timeout;           /* timeout while sending data */
 134         ev_idle unwind_stack,         /* get c-ares out of the stack */
 135                 db_unwind_stack,      /* wait for next db operation... */
 136                 conn_fail_immediate;  /* unwind stack, but fail immediately. */
 137         ev_io recv_event,             /* receive data from the client */
 138                 send_event,           /* send more data to the client */
 139                 conn_event;           /* Connection successfully established */
 140
 141         StrBuf *ErrMsg; /* if we fail to connect, or lookup, error goes here. */
 142
 143         /* Citadel application callbacks... */
 144         IO_CallBack ReadDone, /* Theres new data to read... */
 145                 SendDone,     /* we may send more data */
 146                 Terminate,    /* shutting down... */
 147                 DBTerminate,  /* shutting down... */
 148                 Timeout,      /* Timeout handler;may also be conn. timeout */
 149                 ConnFail,     /* What to do when one connection failed? */
 150                 ShutdownAbort,/* we're going down. make your piece. */
 151                 NextDBOperation; /* Perform Database IO */
 152
 153         /* if we have linereaders, maybe we want to read more lines before
 154          * the real application logic is called? */
 155         IO_LineReaderCallback LineReader;
 156
 157         evcares_data DNS;
 158
 159         evcurl_request_data HttpReq;
 160
 161         /* Saving / loading a message async from / to disk */
 162         ReadAsyncMsg *ReadMsg;
 163         struct CtdlMessage *AsyncMsg;
 164         struct recptypes *AsyncRcp;
 165
 166         /* Context specific data; Hint: put AsyncIO in there */
 167         void *Data;        /* application specific data */
 168         CitContext *CitContext;  /* Citadel Session context... */
 169 };
 170
 171 typedef struct _IOAddHandler {
 172         AsyncIO *IO;
 173         IO_CallBack EvAttch;
 174 } IOAddHandler;
 175
 176
 177
 178 extern int DebugEventLoop;
 179 extern int DebugCAres;
 180
 181 #define EDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugEventLoop != 0))
 182
 183 #define CCID ((CitContext*)IO->CitContext)->cs_pid
 184
 185 #define EVQ_syslog(LEVEL, FORMAT, ...)                                  \
 186         EDBGLOG (LEVEL) syslog(LEVEL, "IOQ " FORMAT, __VA_ARGS__)
 187
 188 #define EVQM_syslog(LEVEL, FORMAT)                      \
 189         EDBGLOG (LEVEL) syslog(LEVEL, "IO " FORMAT)
 190
 191 #define EV_syslog(LEVEL, FORMAT, ...)                                   \
 192         EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
 193
 194 #define EVM_syslog(LEVEL, FORMAT)                                       \
 195         EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
 196
 197 #define EVNC_syslog(LEVEL, FORMAT, ...)                                 \
 198         EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld] " FORMAT, IO->ID, __VA_ARGS__)
 199
 200 #define EVNCM_syslog(LEVEL, FORMAT) EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
 201
 202
 203 #define CDBGLOG() if (DebugCAres != 0)
 204 #define CEDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugCAres != 0))
 205 #define EV_DNS_LOG_START(a)                                                     \
 206         CDBGLOG () {syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
 207                     EV_backtrace(IO);}
 208
 209 #define EV_DNS_LOG_STOP(a)                                                      \
 210         CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
 211                      EV_backtrace(IO);}
 212
 213 #define EV_DNS_LOG_INIT(a)                                                      \
 214         CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %s %p FD %d", IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
 215                      EV_backtrace(IO);}
 216
 217 #define EV_DNS_LOGT_START(a)                                                    \
 218         CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
 219                      EV_backtrace(IO);}
 220
 221 #define EV_DNS_LOGT_STOP(a)                                                     \
 222         CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %s %p", IO->ID, CCID, __FUNCTION__, &IO->a); \
 223                      EV_backtrace(IO); }
 224
 225 #define EV_DNS_LOGT_INIT(a)                                                     \
 226         CDBGLOG () { syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p", IO->ID, CCID, &IO->a); \
 227                      EV_backtrace(IO);}
 228
 229 #define EV_DNS_syslog(LEVEL, FORMAT, ...)                               \
 230         CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
 231
 232 #define EVM_DNS_syslog(LEVEL, FORMAT)                                   \
 233         CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
 234
 235 void FreeAsyncIOContents(AsyncIO *IO);
 236
 237 eNextState NextDBOperation(AsyncIO *IO, IO_CallBack CB);
 238 eNextState QueueDBOperation(AsyncIO *IO, IO_CallBack CB);
 239 void StopDBWatchers(AsyncIO *IO);
 240 eNextState QueueEventContext(AsyncIO *IO, IO_CallBack CB);
 241 eNextState QueueCurlContext(AsyncIO *IO);
 242
 243 eNextState EvConnectSock(AsyncIO *IO,
 244                          double conn_timeout,
 245                          double first_rw_timeout,
 246                          int ReadFirst);
 247 void IO_postdns_callback(struct ev_loop *loop, ev_idle *watcher, int revents);
 248
 249 int QueueQuery(ns_type Type,
 250                const char *name,
 251                AsyncIO *IO,
 252                DNSQueryParts *QueryParts,
 253                IO_CallBack PostDNS);
 254
 255 void QueueGetHostByName(AsyncIO *IO,
 256                         const char *Hostname,
 257                         DNSQueryParts *QueryParts,
 258                         IO_CallBack PostDNS);
 259
 260 void QueryCbDone(AsyncIO *IO);
 261
 262 void StopClient(AsyncIO *IO);
 263
 264 void StopClientWatchers(AsyncIO *IO, int CloseFD);
 265
 266 void SetNextTimeout(AsyncIO *IO, double timeout);
 267
 268 #include <curl/curl.h>
 269
 270 #define OPT(s, v) \
 271         do { \
 272                 sta = curl_easy_setopt(chnd, (CURLOPT_##s), (v));       \
 273                 if (sta)  {                                             \
 274                         EVQ_syslog(LOG_ERR,                             \
 275                                "error setting option " #s               \
 276                                " on curl handle: %s",                   \
 277                                curl_easy_strerror(sta));                \
 278         } } while (0)
 279
 280 void InitIOStruct(AsyncIO *IO,
 281                   void *Data,
 282                   eNextState NextState,
 283                   IO_LineReaderCallback LineReader,
 284                   IO_CallBack DNS_Fail,
 285                   IO_CallBack SendDone,
 286                   IO_CallBack ReadDone,
 287                   IO_CallBack Terminate,
 288                   IO_CallBack DBTerminate,
 289                   IO_CallBack ConnFail,
 290                   IO_CallBack Timeout,
 291                   IO_CallBack ShutdownAbort);
 292
 293 int InitcURLIOStruct(AsyncIO *IO,
 294                      void *Data,
 295                      const char* Desc,
 296                      IO_CallBack SendDone,
 297                      IO_CallBack Terminate,
 298                      IO_CallBack DBTerminate,
 299                      IO_CallBack ShutdownAbort);
 300 void KillAsyncIOContext(AsyncIO *IO);
 301 void StopCurlWatchers(AsyncIO *IO);
 302
 303
 304 eNextState ReAttachIO(AsyncIO *IO,
 305                       void *pData,
 306                       int ReadFirst);
 307
 308 void EV_backtrace(AsyncIO *IO);
 309 ev_tstamp ctdl_ev_now (void);
 310
 311 #endif /* __EVENT_CLIENT_H__ */