src/helper.h

   1
   2 /*
   3  * $Id: helper.h,v 1.12 2008/02/26 21:49:34 amosjeffries Exp $
   4  *
   5  * DEBUG: section 84    Helper process maintenance
   6  * AUTHOR: Harvest Derived?
   7  *
   8  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   9  * ----------------------------------------------------------
  10  *
  11  *  Squid is the result of efforts by numerous individuals from
  12  *  the Internet community; see the CONTRIBUTORS file for full
  13  *  details.   Many organizations have provided support for Squid's
  14  *  development; see the SPONSORS file for full details.  Squid is
  15  *  Copyrighted (C) 2001 by the Regents of the University of
  16  *  California; see the COPYRIGHT file for full details.  Squid
  17  *  incorporates software developed and/or copyrighted by other
  18  *  sources; see the CREDITS file for full details.
  19  *
  20  *  This program is free software; you can redistribute it and/or modify
  21  *  it under the terms of the GNU General Public License as published by
  22  *  the Free Software Foundation; either version 2 of the License, or
  23  *  (at your option) any later version.
  24  *
  25  *  This program is distributed in the hope that it will be useful,
  26  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  *  GNU General Public License for more details.
  29  *
  30  *  You should have received a copy of the GNU General Public License
  31  *  along with this program; if not, write to the Free Software
  32  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  33  *
  34  */
  35
  36 #ifndef SQUID_HELPER_H
  37 #define SQUID_HELPER_H
  38
  39 #include "squid.h"
  40 #include "cbdata.h"
  41 #include "IPAddress.h"
  42
  43 class helper_request;
  44
  45 typedef struct _helper helper;
  46
  47 typedef struct _helper_stateful statefulhelper;
  48
  49 typedef struct _helper_server helper_server;
  50
  51 typedef struct _helper_stateful_server helper_stateful_server;
  52
  53 typedef struct _helper_flags helper_flags;
  54
  55 typedef struct _helper_stateful_flags helper_stateful_flags;
  56
  57 typedef stateful_helper_callback_t HLPSCB(void *, void *lastserver, char *buf);
  58
  59 struct _helper
  60 {
  61     wordlist *cmdline;
  62     dlink_list servers;
  63     dlink_list queue;
  64     const char *id_name;
  65     int n_to_start;
  66     int n_running;
  67     int n_active;
  68     int ipc_type;
  69     IPAddress addr;
  70     unsigned int concurrency;
  71     time_t last_queue_warn;
  72     time_t last_restart;
  73
  74     struct
  75     {
  76         int requests;
  77         int replies;
  78         int queue_size;
  79         int avg_svc_time;
  80     } stats;
  81 };
  82
  83 struct _helper_stateful
  84 {
  85     wordlist *cmdline;
  86     dlink_list servers;
  87     dlink_list queue;
  88     const char *id_name;
  89     int n_to_start;
  90     int n_running;
  91     int n_active;
  92     int ipc_type;
  93     IPAddress addr;
  94     MemAllocator *datapool;
  95     HLPSAVAIL *IsAvailable;
  96     HLPSONEQ *OnEmptyQueue;
  97     time_t last_queue_warn;
  98     time_t last_restart;
  99
 100     struct
 101     {
 102         int requests;
 103         int replies;
 104         int queue_size;
 105         int avg_svc_time;
 106     } stats;
 107 };
 108
 109 struct _helper_server
 110 {
 111     int index;
 112     int pid;
 113     IPAddress addr;
 114     int rfd;
 115     int wfd;
 116     MemBuf *wqueue;
 117     MemBuf *writebuf;
 118     char *rbuf;
 119     size_t rbuf_sz;
 120     size_t roffset;
 121
 122     struct timeval dispatch_time;
 123
 124     struct timeval answer_time;
 125
 126     dlink_node link;
 127     helper *parent;
 128     helper_request **requests;
 129
 130     struct _helper_flags
 131     {
 132         unsigned int writing:1;
 133         unsigned int closing:1;
 134         unsigned int shutdown:1;
 135     } flags;
 136
 137     struct
 138     {
 139         int uses;
 140         unsigned int pending;
 141     } stats;
 142
 143     void *hIpc;
 144 };
 145
 146 class helper_stateful_request;
 147
 148 struct _helper_stateful_server
 149 {
 150     int index;
 151     int pid;
 152     IPAddress addr;
 153     int rfd;
 154     int wfd;
 155     /* MemBuf wqueue; */
 156     /* MemBuf writebuf; */
 157     char *rbuf;
 158     size_t rbuf_sz;
 159     size_t roffset;
 160
 161     struct timeval dispatch_time;
 162
 163     struct timeval answer_time;
 164
 165     dlink_node link;
 166     dlink_list queue;
 167     statefulhelper *parent;
 168     helper_stateful_request *request;
 169
 170     struct _helper_stateful_flags
 171     {
 172         unsigned int busy:1;
 173         unsigned int closing:1;
 174         unsigned int shutdown:1;
 175         stateful_helper_reserve_t reserved;
 176     } flags;
 177
 178     struct
 179     {
 180         int uses;
 181         int submits;
 182         int releases;
 183         int deferbyfunc;
 184         int deferbycb;
 185     } stats;
 186     int deferred_requests;      /* current number of deferred requests */
 187     void *data;                 /* State data used by the calling routines */
 188     void *hIpc;
 189 };
 190
 191 class helper_request
 192 {
 193
 194 public:
 195     MEMPROXY_CLASS(helper_request);
 196     char *buf;
 197     HLPCB *callback;
 198     void *data;
 199
 200     struct timeval dispatch_time;
 201 };
 202
 203 MEMPROXY_CLASS_INLINE(helper_request)           /**DOCS_NOSEMI*/
 204
 205 class helper_stateful_request
 206 {
 207
 208 public:
 209     MEMPROXY_CLASS(helper_stateful_request);
 210     char *buf;
 211     HLPSCB *callback;
 212     int placeholder;            /* if 1, this is a dummy request waiting for a stateful helper to become available for deferred requests.*/
 213     void *data;
 214 };
 215
 216 MEMPROXY_CLASS_INLINE(helper_stateful_request)          /**DOCS_NOSEMI*/
 217
 218 /* helper.c */
 219 SQUIDCEXTERN void helperOpenServers(helper * hlp);
 220 SQUIDCEXTERN void helperStatefulOpenServers(statefulhelper * hlp);
 221 SQUIDCEXTERN void helperSubmit(helper * hlp, const char *buf, HLPCB * callback, void *data);
 222 SQUIDCEXTERN void helperStatefulSubmit(statefulhelper * hlp, const char *buf, HLPSCB * callback, void *data, helper_stateful_server * lastserver);
 223 SQUIDCEXTERN void helperStats(StoreEntry * sentry, helper * hlp, const char *label = NULL);
 224 SQUIDCEXTERN void helperStatefulStats(StoreEntry * sentry, statefulhelper * hlp, const char *label = NULL);
 225 SQUIDCEXTERN void helperShutdown(helper * hlp);
 226 SQUIDCEXTERN void helperStatefulShutdown(statefulhelper * hlp);
 227 SQUIDCEXTERN helper *helperCreate(const char *);
 228 SQUIDCEXTERN statefulhelper *helperStatefulCreate(const char *);
 229 SQUIDCEXTERN void helperFree(helper *);
 230 SQUIDCEXTERN void helperStatefulFree(statefulhelper *);
 231 SQUIDCEXTERN void helperStatefulReset(helper_stateful_server * srv);
 232 SQUIDCEXTERN void helperStatefulReleaseServer(helper_stateful_server * srv);
 233 SQUIDCEXTERN void *helperStatefulServerGetData(helper_stateful_server * srv);
 234 SQUIDCEXTERN helper_stateful_server *helperStatefulDefer(statefulhelper *);
 235
 236
 237
 238 #endif /* SQUID_HELPER_H */