EV: stop all watchers before going into other queues - so we can avoid race conditions.
[citadel.git] / citadel / event_client.h
index 217ffc26e372ef3d57b303caf57763cff23e8e07..b136c2e670a975d1516398c235fe18c347d82967 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
+
+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 +84,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 +111,8 @@ typedef struct _DNSQueryParts {
        ParseDNSAnswerCb DNS_CB;
        IO_CallBack PostDNS;
 
+       const char *QueryTYPE;
+       const char *QStr;
        int DNSStatus;
        void *VParsedDNSReply;
        FreeDNSReply DNSReplyFree;
@@ -100,12 +137,12 @@ typedef struct _evcurl_request_data
 
 /* DNS Related */
 typedef struct __evcares_data {
+       ev_tstamp Start;
        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;
@@ -115,6 +152,9 @@ typedef struct __evcares_data {
 
 struct AsyncIO {
        long ID;
+       ev_tstamp Now;
+       ev_tstamp StartIO;
+       ev_tstamp StartDB;
        eNextState NextState;
 
        /* connection related */
@@ -146,6 +186,7 @@ struct AsyncIO {
        IO_CallBack ReadDone, /* Theres new data to read... */
                SendDone,     /* we may send more data */
                Terminate,    /* shutting down... */
+               DBTerminate,  /* shutting down... */
                Timeout,      /* Timeout handler;may also be conn. timeout */
                ConnFail,     /* What to do when one connection failed? */
                ShutdownAbort,/* we're going down. make your piece. */
@@ -166,7 +207,7 @@ struct AsyncIO {
 
        /* 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 {
@@ -174,58 +215,74 @@ typedef struct _IOAddHandler {
        IO_CallBack EvAttch;
 } IOAddHandler;
 
+
+
+extern int DebugEventLoop;
+extern int DebugCAres;
+
+#define EDBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (DebugEventLoop != 0))
+
 #define CCID ((CitContext*)IO->CitContext)->cs_pid
 
-#define EV_syslog(LEVEL, FORMAT, ...) \
-       syslog(LEVEL, "IO[%ld]CC[%d]" FORMAT, IO->ID, CCID, __VA_ARGS__)
+#define EVQ_syslog(LEVEL, FORMAT, ...)                                 \
+       EDBGLOG (LEVEL) syslog(LEVEL, "IOQ " FORMAT, __VA_ARGS__)
+
+#define EVQM_syslog(LEVEL, FORMAT)                     \
+       EDBGLOG (LEVEL) syslog(LEVEL, "IO " FORMAT)
+
+#define EV_syslog(LEVEL, FORMAT, ...)                                  \
+       EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
 
-#define EVM_syslog(LEVEL, FORMAT) \
-       syslog(LEVEL, "IO[%ld]CC[%d]" FORMAT, IO->ID, CCID)
+#define EVM_syslog(LEVEL, FORMAT)                                      \
+       EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID)
 
-#define EVNC_syslog(LEVEL, FORMAT, ...) \
-       syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID, __VA_ARGS__)
+#define EVNC_syslog(LEVEL, FORMAT, ...)                                        \
+       EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld] " FORMAT, IO->ID, __VA_ARGS__)
 
-#define EVNCM_syslog(LEVEL, FORMAT) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
+#define EVNCM_syslog(LEVEL, FORMAT) EDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]" FORMAT, IO->ID)
 
-#ifdef DEBUG_CARES
+
+#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, "IO[%ld]CC[%d] + Starting " #a " %s %p FD %d", 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, "IO[%ld]CC[%d] - Stopping " #a " %s %p FD %d", 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, "IO[%ld]CC[%d] * Init " #a " %s %p FD %d", 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, "IO[%ld]CC[%d] + Starting " #a " %s %p", 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, "IO[%ld]CC[%d] - Stopping " #a " %s %p", 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, "IO[%ld]CC[%d] * Init " #a " %p", IO->ID, CCID, &IO->a); \
+                    EV_backtrace(IO);}
+
+#define EV_DNS_syslog(LEVEL, FORMAT, ...)                              \
+       CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, IO->ID, CCID, __VA_ARGS__)
+
+#define EVM_DNS_syslog(LEVEL, FORMAT)                                  \
+       CEDBGLOG (LEVEL) syslog(LEVEL, "IO[%ld]CC[%d] " FORMAT, 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);
+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,
@@ -248,19 +305,17 @@ void QueryCbDone(AsyncIO *IO);
 
 void StopClient(AsyncIO *IO);
 
-void StopClientWatchers(AsyncIO *IO);
+void StopClientWatchers(AsyncIO *IO, int CloseFD);
 
 void SetNextTimeout(AsyncIO *IO, double timeout);
 
-void InitC_ares_dns(AsyncIO *IO);
-
 #include <curl/curl.h>
 
 #define OPT(s, v) \
        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));                \
@@ -274,6 +329,7 @@ void InitIOStruct(AsyncIO *IO,
                  IO_CallBack SendDone,
                  IO_CallBack ReadDone,
                  IO_CallBack Terminate,
+                 IO_CallBack DBTerminate,
                  IO_CallBack ConnFail,
                  IO_CallBack Timeout,
                  IO_CallBack ShutdownAbort);
@@ -283,7 +339,12 @@ int InitcURLIOStruct(AsyncIO *IO,
                     const char* Desc,
                     IO_CallBack SendDone,
                     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,