Assert that we don't always have a valid session.
[citadel.git] / citadel / event_client.h
index 2d5ab986161d1a7a85de628b766d2dec5f2fec29..66976a8aded74ce1fc8aa1a120976007579c26ca 100644 (file)
@@ -3,18 +3,12 @@
  * Copyright (c) 1998-2012 by the citadel.org team
  *
  *  This program is open source software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 3 of the License, or
- *  (at your option) any later version.
+ *  it under the terms of the GNU General Public License, version 3.
  *
  *  This program is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  *  GNU General Public License for more details.
- *
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #ifndef __EVENT_CLIENT_H__
 #include <ares.h>
 #include <curl/curl.h>
 
+#ifndef __ASYNCIO__
+#define __ASYNCIO__
 typedef struct AsyncIO AsyncIO;
+#endif
+#ifndef __CIT_CONTEXT__
+#define __CIT_CONTEXT__
+typedef struct CitContext CitContext;
+#endif
+
+extern pthread_key_t evConKey;
+
+typedef enum __eIOState { 
+       eDBQ,
+       eQDBNext,
+       eDBAttach,
+       eDBNext,
+       eDBStop,
+       eDBX,
+       eDBTerm,
+       eIOQ,
+       eIOAttach,
+       eIOConnectSock,
+       eIOAbort,
+       eIOTimeout,
+       eIOConnfail,
+       eIOConnfailNow,
+       eIOConnNow,
+       eIOConnWait,
+       eCurlQ,
+       eCurlStart,
+       eCurlShutdown,
+       eCurlNewIO,
+       eCurlGotIO,
+       eCurlGotData,
+       eCurlGotStatus,
+       eCaresStart,
+       eCaresDoneIO,
+       eCaresFinished,
+       eCaresX,
+       eKill,
+       eExit
+}eIOState;
 
 typedef enum _eNextState {
        eSendDNSQuery,
@@ -51,6 +86,8 @@ typedef enum _eNextState {
        eAbort
 }eNextState;
 
+void SetEVState(AsyncIO *IO, eIOState State);
+
 typedef eNextState (*IO_CallBack)(AsyncIO *IO);
 typedef eReadState (*IO_LineReaderCallback)(AsyncIO *IO);
 typedef void (*ParseDNSAnswerCb)(AsyncIO*, unsigned char*, int);
@@ -76,6 +113,8 @@ typedef struct _DNSQueryParts {
        ParseDNSAnswerCb DNS_CB;
        IO_CallBack PostDNS;
 
+       const char *QueryTYPE;
+       const char *QStr;
        int DNSStatus;
        void *VParsedDNSReply;
        FreeDNSReply DNSReplyFree;
@@ -87,6 +126,7 @@ typedef struct _evcurl_request_data
        CURL                    *chnd;
        struct curl_slist       *headers;
        char                     errdesc[CURL_ERROR_SIZE];
+       const char              *CurlError;
 
        int                      attached;
 
@@ -104,9 +144,8 @@ typedef struct __evcares_data {
        ev_io recv_event,
                send_event;
        ev_timer timeout;           /* timeout while requesting ips */
-#ifdef DEBUG_CARES
        short int SourcePort;
-#endif
+
        struct ares_options Options;
        ares_channel Channel;
        DNSQueryParts *Query;
@@ -114,6 +153,7 @@ typedef struct __evcares_data {
        IO_CallBack Fail;      /* the dns lookup didn't work out. */
 } evcares_data;
 
+
 struct AsyncIO {
        long ID;
        ev_tstamp Now;
@@ -154,7 +194,8 @@ struct AsyncIO {
                Timeout,      /* Timeout handler;may also be conn. timeout */
                ConnFail,     /* What to do when one connection failed? */
                ShutdownAbort,/* we're going down. make your piece. */
-               NextDBOperation; /* Perform Database IO */
+               NextDBOperation, /* Perform Database IO */
+               ReAttachCB;   /* on the hop from one Q to the other, this is the next CB */
 
        /* if we have linereaders, maybe we want to read more lines before
         * the real application logic is called? */
@@ -167,11 +208,11 @@ struct AsyncIO {
        /* Saving / loading a message async from / to disk */
        ReadAsyncMsg *ReadMsg;
        struct CtdlMessage *AsyncMsg;
-       struct recptypes *AsyncRcp;
+       recptypes *AsyncRcp;
 
        /* Context specific data; Hint: put AsyncIO in there */
        void *Data;        /* application specific data */
-       void *CitContext;  /* Citadel Session context... */
+       CitContext *CitContext;  /* Citadel Session context... */
 };
 
 typedef struct _IOAddHandler {
@@ -179,58 +220,76 @@ typedef struct _IOAddHandler {
        IO_CallBack EvAttch;
 } IOAddHandler;
 
-#define CCID ((CitContext*)IO->CitContext)->cs_pid
 
-#define EV_syslog(LEVEL, FORMAT, ...) \
-       syslog(LEVEL, "IO[%ld]CC[%d]" FORMAT, IO->ID, CCID, __VA_ARGS__)
+inline static time_t EvGetNow(AsyncIO *IO) { return (time_t) IO->Now;}
+
+extern int DebugEventLoop;
+extern int DebugCAres;
+
+#define IOSTR (const char *) pthread_getspecific(evConKey)
+
+#define EDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugEventLoop != 0))
 
-#define EVM_syslog(LEVEL, FORMAT) \
-       syslog(LEVEL, "IO[%ld]CC[%d]" FORMAT, IO->ID, CCID)
+#define CCID ((CitContext*)IO->CitContext)?((CitContext*)IO->CitContext)->cs_pid:-1
 
-#define EVNC_syslog(LEVEL, FORMAT, ...) \
-       syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID, __VA_ARGS__)
+#define EVQ_syslog(LEVEL, FORMAT, ...)                                 \
+       EDBGLOG (LEVEL) syslog(LEVEL, "%sQ " FORMAT, IOSTR, __VA_ARGS__)
 
-#define EVNCM_syslog(LEVEL, FORMAT) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
+#define EVQM_syslog(LEVEL, FORMAT)                     \
+       EDBGLOG (LEVEL) syslog(LEVEL, "%s " FORMAT, IOSTR)
 
-#ifdef DEBUG_CARES
+#define EV_syslog(LEVEL, FORMAT, ...)                                  \
+       EDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld]CC[%d] " FORMAT, IOSTR, IO->ID, CCID, __VA_ARGS__)
+
+#define EVM_syslog(LEVEL, FORMAT)                                      \
+       EDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld]CC[%d] " FORMAT, IOSTR, IO->ID, CCID)
+
+#define EVNC_syslog(LEVEL, FORMAT, ...)                                        \
+       EDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld] " FORMAT, IOSTR, IO->ID, __VA_ARGS__)
+
+#define EVNCM_syslog(LEVEL, FORMAT) EDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld]" FORMAT, IOSTR, IO->ID)
+
+
+#define CDBGLOG() if (DebugCAres != 0)
+#define CEDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugCAres != 0))
 #define EV_DNS_LOG_START(a)                                                    \
-       syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %p FD %d", IO->ID, CCID, &IO->a, IO->a.fd); \
-       EV_backtrace(IO);
+       CDBGLOG () {syslog(LOG_DEBUG, "%s[%ld]CC[%d] + Starting " #a " %s %p FD %d", IOSTR, IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
+                   EV_backtrace(IO);}
 
 #define EV_DNS_LOG_STOP(a)                                                     \
-       syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %p FD %d", IO->ID, CCID, &IO->a, IO->a.fd); \
-       EV_backtrace(IO);
+       CDBGLOG () { syslog(LOG_DEBUG, "%s[%ld]CC[%d] - Stopping " #a " %s %p FD %d", IOSTR, IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
+                    EV_backtrace(IO);}
 
 #define EV_DNS_LOG_INIT(a)                                                     \
-       syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p FD %d", IO->ID, CCID, &IO->a, IO->a.fd); \
-       EV_backtrace(IO);
+       CDBGLOG () { syslog(LOG_DEBUG, "%s[%ld]CC[%d] * Init " #a " %s %p FD %d", IOSTR, IO->ID, CCID, __FUNCTION__, &IO->a, IO->a.fd); \
+                    EV_backtrace(IO);}
 
 #define EV_DNS_LOGT_START(a)                                                   \
-       syslog(LOG_DEBUG, "IO[%ld]CC[%d] + Starting " #a " %p", IO->ID, CCID, &IO->a); \
-       EV_backtrace(IO);
+       CDBGLOG () { syslog(LOG_DEBUG, "%s[%ld]CC[%d] + Starting " #a " %s %p", IOSTR, IO->ID, CCID, __FUNCTION__, &IO->a); \
+                    EV_backtrace(IO);}
 
 #define EV_DNS_LOGT_STOP(a)                                                    \
-       syslog(LOG_DEBUG, "IO[%ld]CC[%d] - Stopping " #a " %p", IO->ID, CCID, &IO->a); \
-       EV_backtrace(IO);
+       CDBGLOG () { syslog(LOG_DEBUG, "%s[%ld]CC[%d] - Stopping " #a " %s %p", IOSTR, IO->ID, CCID, __FUNCTION__, &IO->a); \
+                    EV_backtrace(IO); }
 
 #define EV_DNS_LOGT_INIT(a)                                                    \
-       syslog(LOG_DEBUG, "IO[%ld]CC[%d] * Init " #a " %p", IO->ID, CCID, &IO->a); \
-       EV_backtrace(IO);
-#else
-#define EV_DNS_LOG_START(a)
-#define EV_DNS_LOG_STOP(a)
-#define EV_DNS_LOG_INIT(a)
-#define EV_DNS_LOGT_START(a)
-#define EV_DNS_LOGT_STOP(a)
-#define EV_DNS_LOGT_INIT(a)
-#endif
+       CDBGLOG () { syslog(LOG_DEBUG, "%s[%ld]CC[%d] * Init " #a " %p", IOSTR, IO->ID, CCID, &IO->a); \
+                    EV_backtrace(IO);}
+
+#define EV_DNS_syslog(LEVEL, FORMAT, ...)                              \
+       CEDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld]CC[%d] " FORMAT, IOSTR, IO->ID, CCID, __VA_ARGS__)
+
+#define EVM_DNS_syslog(LEVEL, FORMAT)                                  \
+       CEDBGLOG (LEVEL) syslog(LEVEL, "%s[%ld]CC[%d] " FORMAT, IOSTR, IO->ID, CCID)
 
 void FreeAsyncIOContents(AsyncIO *IO);
 
 eNextState NextDBOperation(AsyncIO *IO, IO_CallBack CB);
-eNextState QueueDBOperation(AsyncIO *IO, IO_CallBack CB);
+eNextState EventQueueDBOperation(AsyncIO *IO, IO_CallBack CB, int CloseFDs);
+void StopDBWatchers(AsyncIO *IO);
 eNextState QueueEventContext(AsyncIO *IO, IO_CallBack CB);
 eNextState QueueCurlContext(AsyncIO *IO);
+eNextState DBQueueEventContext(AsyncIO *IO, IO_CallBack CB);
 
 eNextState EvConnectSock(AsyncIO *IO,
                         double conn_timeout,
@@ -253,7 +312,7 @@ void QueryCbDone(AsyncIO *IO);
 
 void StopClient(AsyncIO *IO);
 
-void StopClientWatchers(AsyncIO *IO);
+void StopClientWatchers(AsyncIO *IO, int CloseFD);
 
 void SetNextTimeout(AsyncIO *IO, double timeout);
 
@@ -263,12 +322,16 @@ void SetNextTimeout(AsyncIO *IO, double timeout);
        do { \
                sta = curl_easy_setopt(chnd, (CURLOPT_##s), (v));       \
                if (sta)  {                                             \
-                       syslog(LOG_ERR,                         \
+                       EVQ_syslog(LOG_ERR,                             \
                               "error setting option " #s               \
                               " on curl handle: %s",                   \
                               curl_easy_strerror(sta));                \
        } } while (0)
 
+#define SET_EV_TIME(IO, BASE)                                          \
+       IO->Now = ev_now(BASE);                                         \
+       if (IO->CitContext != NULL) IO->CitContext->lastcmd = IO->Now; 
+
 void InitIOStruct(AsyncIO *IO,
                  void *Data,
                  eNextState NextState,
@@ -289,6 +352,10 @@ int InitcURLIOStruct(AsyncIO *IO,
                     IO_CallBack Terminate,
                     IO_CallBack DBTerminate,
                     IO_CallBack ShutdownAbort);
+void KillAsyncIOContext(AsyncIO *IO);
+void StopCurlWatchers(AsyncIO *IO);
+
+eNextState CurlQueueDBOperation(AsyncIO *IO, IO_CallBack CB);
 
 eNextState ReAttachIO(AsyncIO *IO,
                      void *pData,