src/protos.h

   1 /*
   2  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   3  * ----------------------------------------------------------
   4  *
   5  *  Squid is the result of efforts by numerous individuals from
   6  *  the Internet community; see the CONTRIBUTORS file for full
   7  *  details.   Many organizations have provided support for Squid's
   8  *  development; see the SPONSORS file for full details.  Squid is
   9  *  Copyrighted (C) 2001 by the Regents of the University of
  10  *  California; see the COPYRIGHT file for full details.  Squid
  11  *  incorporates software developed and/or copyrighted by other
  12  *  sources; see the CREDITS file for full details.
  13  *
  14  *  This program is free software; you can redistribute it and/or modify
  15  *  it under the terms of the GNU General Public License as published by
  16  *  the Free Software Foundation; either version 2 of the License, or
  17  *  (at your option) any later version.
  18  *
  19  *  This program is distributed in the hope that it will be useful,
  20  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  *  GNU General Public License for more details.
  23  *
  24  *  You should have received a copy of the GNU General Public License
  25  *  along with this program; if not, write to the Free Software
  26  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  27  *
  28  */
  29 #ifndef SQUID_PROTOS_H
  30 #define SQUID_PROTOS_H
  31
  32 /* included for routines that have not moved out to their proper homes
  33  * yet.
  34  */
  35 #include "Packer.h"
  36 /* for routines still in this file that take CacheManager parameters */
  37 #include "ip/Address.h"
  38 /* for parameters that still need these */
  39 #include "enums.h"
  40 /* some parameters stil need this */
  41 #include "wordlist.h"
  42
  43 /* for parameters that still need these */
  44 #include "lookup_t.h"
  45
  46
  47 class HttpRequestMethod;
  48 #if USE_DELAY_POOLS
  49 class ClientInfo;
  50 #endif
  51
  52
  53 #if USE_FORW_VIA_DB
  54 SQUIDCEXTERN void fvdbCountVia(const char *key);
  55 SQUIDCEXTERN void fvdbCountForw(const char *key);
  56 #endif
  57 #if HEADERS_LOG
  58 SQUIDCEXTERN void headersLog(int cs, int pq, const HttpRequestMethod& m, void *data);
  59 #endif
  60 SQUIDCEXTERN int logTypeIsATcpHit(log_type);
  61
  62 /*
  63  * cache_cf.c
  64  */
  65 SQUIDCEXTERN void configFreeMemory(void);
  66 class MemBuf;
  67 SQUIDCEXTERN void wordlistCat(const wordlist *, MemBuf * mb);
  68 SQUIDCEXTERN void self_destruct(void);
  69 SQUIDCEXTERN void add_http_port(char *portspec);
  70 extern int xatoi(const char *token);
  71 extern long xatol(const char *token);
  72
  73
  74 /* extra functions from cache_cf.c useful for lib modules */
  75 SQUIDCEXTERN void parse_int(int *var);
  76 SQUIDCEXTERN void parse_onoff(int *var);
  77 SQUIDCEXTERN void parse_eol(char *volatile *var);
  78 SQUIDCEXTERN void parse_wordlist(wordlist ** list);
  79 SQUIDCEXTERN void requirePathnameExists(const char *name, const char *path);
  80 SQUIDCEXTERN void parse_time_t(time_t * var);
  81
  82
  83 /* client_side.c - FD related client side routines */
  84
  85 SQUIDCEXTERN void clientdbInit(void);
  86
  87 SQUIDCEXTERN void clientdbUpdate(const Ip::Address &, log_type, protocol_t, size_t);
  88
  89 SQUIDCEXTERN int clientdbCutoffDenied(const Ip::Address &);
  90 void clientdbDump(StoreEntry *);
  91 SQUIDCEXTERN void clientdbFreeMemory(void);
  92
  93 SQUIDCEXTERN int clientdbEstablished(const Ip::Address &, int);
  94 #if USE_DELAY_POOLS
  95 SQUIDCEXTERN void clientdbSetWriteLimiter(ClientInfo * info, const int writeSpeedLimit,const double initialBurst,const double highWatermark);
  96 SQUIDCEXTERN ClientInfo * clientdbGetInfo(const Ip::Address &addr);
  97 #endif
  98 SQUIDCEXTERN void clientOpenListenSockets(void);
  99 SQUIDCEXTERN void clientHttpConnectionsClose(void);
 100 SQUIDCEXTERN void httpRequestFree(void *);
 101
 102 extern void clientAccessCheck(void *);
 103
 104 #include "Debug.h"
 105
 106 /* packs, then prints an object using debugs() */
 107 SQUIDCEXTERN void debugObj(int section, int level, const char *label, void *obj, ObjPackMethod pm);
 108
 109 /* disk.c */
 110 SQUIDCEXTERN int file_open(const char *path, int mode);
 111 SQUIDCEXTERN void file_close(int fd);
 112 /* Adapter file_write for object callbacks */
 113
 114 template <class O>
 115 void
 116 FreeObject(void *address)
 117 {
 118     O *anObject = static_cast <O *>(address);
 119     delete anObject;
 120 }
 121
 122 SQUIDCEXTERN void file_write(int, off_t, void const *, int len, DWCB *, void *, FREE *);
 123 SQUIDCEXTERN void file_write_mbuf(int fd, off_t, MemBuf mb, DWCB * handler, void *handler_data);
 124 SQUIDCEXTERN void file_read(int, char *, int, off_t, DRCB *, void *);
 125 SQUIDCEXTERN void disk_init(void);
 126
 127 SQUIDCEXTERN void dnsShutdown(void);
 128 SQUIDCEXTERN void dnsInit(void);
 129 SQUIDCEXTERN void dnsSubmit(const char *lookup, HLPCB * callback, void *data);
 130
 131 /* dns_internal.c */
 132 SQUIDCEXTERN void idnsInit(void);
 133 SQUIDCEXTERN void idnsShutdown(void);
 134 SQUIDCEXTERN void idnsALookup(const char *, IDNSCB *, void *);
 135
 136 SQUIDCEXTERN void idnsPTRLookup(const Ip::Address &, IDNSCB *, void *);
 137
 138 SQUIDCEXTERN void fd_close(int fd);
 139 SQUIDCEXTERN void fd_open(int fd, unsigned int type, const char *);
 140 SQUIDCEXTERN void fd_note(int fd, const char *);
 141 SQUIDCEXTERN void fd_bytes(int fd, int len, unsigned int type);
 142 SQUIDCEXTERN void fdDumpOpen(void);
 143 SQUIDCEXTERN int fdUsageHigh(void);
 144 SQUIDCEXTERN void fdAdjustReserved(void);
 145
 146 SQUIDCEXTERN fileMap *file_map_create(void);
 147 SQUIDCEXTERN int file_map_allocate(fileMap *, int);
 148 SQUIDCEXTERN int file_map_bit_set(fileMap *, int);
 149 SQUIDCEXTERN int file_map_bit_test(fileMap *, int);
 150 SQUIDCEXTERN void file_map_bit_reset(fileMap *, int);
 151 SQUIDCEXTERN void filemapFreeMemory(fileMap *);
 152
 153
 154 SQUIDCEXTERN void fqdncache_nbgethostbyaddr(const Ip::Address &, FQDNH *, void *);
 155
 156 SQUIDCEXTERN const char *fqdncache_gethostbyaddr(const Ip::Address &, int flags);
 157 SQUIDCEXTERN void fqdncache_init(void);
 158 void fqdnStats(StoreEntry *);
 159 SQUIDCEXTERN void fqdncacheReleaseInvalid(const char *);
 160
 161 SQUIDCEXTERN const char *fqdnFromAddr(const Ip::Address &);
 162 SQUIDCEXTERN int fqdncacheQueueDrain(void);
 163 SQUIDCEXTERN void fqdncacheFreeMemory(void);
 164 SQUIDCEXTERN void fqdncache_restart(void);
 165 void fqdncache_purgelru(void *);
 166 SQUIDCEXTERN void fqdncacheAddEntryFromHosts(char *addr, wordlist * hostnames);
 167
 168 class FwdState;
 169
 170 /**
 171  \defgroup ServerProtocolFTPAPI Server-Side FTP API
 172  \ingroup ServerProtocol
 173  */
 174
 175 /// \ingroup ServerProtocolFTPAPI
 176 SQUIDCEXTERN void ftpStart(FwdState *);
 177
 178 class HttpRequest;
 179 class HttpReply;
 180
 181 /// \ingroup ServerProtocolFTPAPI
 182 SQUIDCEXTERN const char *ftpUrlWith2f(HttpRequest *);
 183
 184
 185 /**
 186  \defgroup ServerProtocolGopherAPI Server-Side Gopher API
 187  \ingroup ServerProtocol
 188  */
 189
 190 /// \ingroup ServerProtocolGopherAPI
 191 SQUIDCEXTERN void gopherStart(FwdState *);
 192
 193 /// \ingroup ServerProtocolGopherAPI
 194 SQUIDCEXTERN int gopherCachable(const HttpRequest *);
 195
 196
 197 /**
 198  \defgroup ServerProtocolWhoisAPI Server-Side WHOIS API
 199  \ingroup ServerProtocol
 200  */
 201
 202 /// \ingroup ServerProtocolWhoisAPI
 203 SQUIDCEXTERN void whoisStart(FwdState *);
 204
 205
 206 /* http.c */
 207 /* for http_hdr_type field */
 208 #include "HttpHeader.h"
 209 SQUIDCEXTERN int httpCachable(const HttpRequestMethod&);
 210 SQUIDCEXTERN void httpStart(FwdState *);
 211 SQUIDCEXTERN mb_size_t httpBuildRequestPrefix(HttpRequest * request,
 212         HttpRequest * orig_request,
 213         StoreEntry * entry,
 214         MemBuf * mb,
 215         http_state_flags);
 216 SQUIDCEXTERN void httpAnonInitModule(void);
 217 SQUIDCEXTERN int httpAnonHdrAllowed(http_hdr_type hdr_id);
 218 SQUIDCEXTERN int httpAnonHdrDenied(http_hdr_type hdr_id);
 219 SQUIDCEXTERN const char *httpMakeVaryMark(HttpRequest * request, HttpReply const * reply);
 220
 221 /* ETag */
 222 SQUIDCEXTERN int etagParseInit(ETag * etag, const char *str);
 223 /// whether etags are strong-equal
 224 SQUIDCEXTERN bool etagIsStrongEqual(const ETag &tag1, const ETag &tag2);
 225 /// whether etags are weak-equal
 226 SQUIDCEXTERN bool etagIsWeakEqual(const ETag &tag1, const ETag &tag2);
 227
 228 #include "HttpStatusCode.h"
 229 SQUIDCEXTERN const char *httpStatusString(http_status status);
 230
 231 /* Http Body */
 232 /* init/clean */
 233 SQUIDCEXTERN void httpBodyInit(HttpBody * body);
 234 SQUIDCEXTERN void httpBodyClean(HttpBody * body);
 235 /* get body ptr (always use this) */
 236 SQUIDCEXTERN const char *httpBodyPtr(const HttpBody * body);
 237 /* set body, does not clone mb so you should not reuse it */
 238 SQUIDCEXTERN void httpBodySet(HttpBody * body, MemBuf * mb);
 239
 240 /* pack */
 241 SQUIDCEXTERN void httpBodyPackInto(const HttpBody * body, Packer * p);
 242
 243 /* Http Cache Control Header Field */
 244 SQUIDCEXTERN void httpHdrCcInitModule(void);
 245 SQUIDCEXTERN void httpHdrCcCleanModule(void);
 246 SQUIDCEXTERN HttpHdrCc *httpHdrCcCreate(void);
 247 SQUIDCEXTERN HttpHdrCc *httpHdrCcParseCreate(const String * str);
 248 SQUIDCEXTERN void httpHdrCcDestroy(HttpHdrCc * cc);
 249 SQUIDCEXTERN HttpHdrCc *httpHdrCcDup(const HttpHdrCc * cc);
 250 SQUIDCEXTERN void httpHdrCcPackInto(const HttpHdrCc * cc, Packer * p);
 251 SQUIDCEXTERN void httpHdrCcSetMaxAge(HttpHdrCc * cc, int max_age);
 252 SQUIDCEXTERN void httpHdrCcSetSMaxAge(HttpHdrCc * cc, int s_maxage);
 253 SQUIDCEXTERN void httpHdrCcUpdateStats(const HttpHdrCc * cc, StatHist * hist);
 254 void httpHdrCcStatDumper(StoreEntry * sentry, int idx, double val, double size, int count);
 255
 256 /* Http Header Tools */
 257 class HttpHeaderFieldInfo;
 258 SQUIDCEXTERN HttpHeaderFieldInfo *httpHeaderBuildFieldsInfo(const HttpHeaderFieldAttrs * attrs, int count);
 259 SQUIDCEXTERN void httpHeaderDestroyFieldsInfo(HttpHeaderFieldInfo * info, int count);
 260 SQUIDCEXTERN http_hdr_type httpHeaderIdByName(const char *name, size_t name_len, const HttpHeaderFieldInfo * attrs, int end);
 261 SQUIDCEXTERN http_hdr_type httpHeaderIdByNameDef(const char *name, int name_len);
 262 SQUIDCEXTERN const char *httpHeaderNameById(int id);
 263 SQUIDCEXTERN int httpHeaderHasConnDir(const HttpHeader * hdr, const char *directive);
 264 SQUIDCEXTERN void strListAdd(String * str, const char *item, char del);
 265 SQUIDCEXTERN int strListIsMember(const String * str, const char *item, char del);
 266 SQUIDCEXTERN int strListIsSubstr(const String * list, const char *s, char del);
 267 SQUIDCEXTERN int strListGetItem(const String * str, char del, const char **item, int *ilen, const char **pos);
 268 SQUIDCEXTERN const char *getStringPrefix(const char *str, const char *end);
 269 SQUIDCEXTERN int httpHeaderParseInt(const char *start, int *val);
 270 SQUIDCEXTERN int httpHeaderParseOffset(const char *start, int64_t * off);
 271 SQUIDCEXTERN void
 272 httpHeaderPutStrf(HttpHeader * hdr, http_hdr_type id, const char *fmt,...) PRINTF_FORMAT_ARG3;
 273
 274
 275 /* Http Header */
 276 SQUIDCEXTERN void httpHeaderInitModule(void);
 277 SQUIDCEXTERN void httpHeaderCleanModule(void);
 278
 279 /* store report about current header usage and other stats */
 280 void httpHeaderStoreReport(StoreEntry * e);
 281 SQUIDCEXTERN void httpHdrMangleList(HttpHeader *, HttpRequest *, int req_or_rep);
 282 SQUIDCEXTERN int httpReqHdrManglersConfigured();
 283
 284 #if SQUID_SNMP
 285 SQUIDCEXTERN PF snmpHandleUdp;
 286 SQUIDCEXTERN void snmpInit(void);
 287 SQUIDCEXTERN void snmpConnectionOpen(void);
 288 SQUIDCEXTERN void snmpConnectionShutdown(void);
 289 SQUIDCEXTERN void snmpConnectionClose(void);
 290 SQUIDCEXTERN const char * snmpDebugOid(oid * Name, snint Len, MemBuf &outbuf);
 291
 292 SQUIDCEXTERN void addr2oid(Ip::Address &addr, oid *Dest);
 293 SQUIDCEXTERN void oid2addr(oid *Dest, Ip::Address &addr, u_int code);
 294
 295 SQUIDCEXTERN Ip::Address *client_entry(Ip::Address *current);
 296 extern variable_list *snmp_basicFn(variable_list *, snint *);
 297 extern variable_list *snmp_confFn(variable_list *, snint *);
 298 extern variable_list *snmp_sysFn(variable_list *, snint *);
 299 extern variable_list *snmp_prfSysFn(variable_list *, snint *);
 300 extern variable_list *snmp_prfProtoFn(variable_list *, snint *);
 301 extern variable_list *snmp_prfPeerFn(variable_list *, snint *);
 302 extern variable_list *snmp_netIpFn(variable_list *, snint *);
 303 extern variable_list *snmp_netFqdnFn(variable_list *, snint *);
 304 #if USE_DNSSERVERS
 305 extern variable_list *snmp_netDnsFn(variable_list *, snint *);
 306 #else
 307 extern variable_list *snmp_netIdnsFn(variable_list *, snint *);
 308 #endif /* USE_DNSSERVERS */
 309 extern variable_list *snmp_meshPtblFn(variable_list *, snint *);
 310 extern variable_list *snmp_meshCtblFn(variable_list *, snint *);
 311 #endif /* SQUID_SNMP */
 312
 313 #if USE_WCCP
 314 SQUIDCEXTERN void wccpInit(void);
 315 SQUIDCEXTERN void wccpConnectionOpen(void);
 316 SQUIDCEXTERN void wccpConnectionClose(void);
 317 #endif /* USE_WCCP */
 318
 319 #if USE_WCCPv2
 320 extern void wccp2Init(void);
 321 extern void wccp2ConnectionOpen(void);
 322 extern void wccp2ConnectionClose(void);
 323 #endif /* USE_WCCPv2 */
 324
 325 void ipcache_purgelru(void *);
 326 SQUIDCEXTERN void ipcache_nbgethostbyname(const char *name,
 327         IPH * handler,
 328         void *handlerData);
 329 SQUIDCEXTERN const ipcache_addrs *ipcache_gethostbyname(const char *, int flags);
 330 SQUIDCEXTERN void ipcacheInvalidate(const char *);
 331 SQUIDCEXTERN void ipcacheInvalidateNegative(const char *);
 332 SQUIDCEXTERN void ipcache_init(void);
 333 SQUIDCEXTERN void ipcacheCycleAddr(const char *name, ipcache_addrs *);
 334 SQUIDCEXTERN void ipcacheMarkBadAddr(const char *name, const Ip::Address &);
 335 SQUIDCEXTERN void ipcacheMarkGoodAddr(const char *name, const Ip::Address &);
 336 SQUIDCEXTERN void ipcacheMarkAllGood(const char *name);
 337 SQUIDCEXTERN void ipcacheFreeMemory(void);
 338 SQUIDCEXTERN ipcache_addrs *ipcacheCheckNumeric(const char *name);
 339 SQUIDCEXTERN void ipcache_restart(void);
 340 SQUIDCEXTERN int ipcacheAddEntryFromHosts(const char *name, const char *ipaddr);
 341
 342 SQUIDCEXTERN char *mime_get_header(const char *mime, const char *header);
 343 SQUIDCEXTERN char *mime_get_header_field(const char *mime, const char *name, const char *prefix);
 344 SQUIDCEXTERN size_t headersEnd(const char *, size_t);
 345
 346 SQUIDCEXTERN void mimeInit(char *filename);
 347 SQUIDCEXTERN void mimeFreeMemory(void);
 348 SQUIDCEXTERN char *mimeGetContentEncoding(const char *fn);
 349 SQUIDCEXTERN char *mimeGetContentType(const char *fn);
 350 SQUIDCEXTERN char const *mimeGetIcon(const char *fn);
 351 SQUIDCEXTERN const char *mimeGetIconURL(const char *fn);
 352 SQUIDCEXTERN char mimeGetTransferMode(const char *fn);
 353 SQUIDCEXTERN int mimeGetDownloadOption(const char *fn);
 354 SQUIDCEXTERN int mimeGetViewOption(const char *fn);
 355
 356 SQUIDCEXTERN int mcastSetTtl(int, int);
 357 SQUIDCEXTERN IPH mcastJoinGroups;
 358
 359 SQUIDCEXTERN peer *getFirstPeer(void);
 360 SQUIDCEXTERN peer *getFirstUpParent(HttpRequest *);
 361 SQUIDCEXTERN peer *getNextPeer(peer *);
 362 SQUIDCEXTERN peer *getSingleParent(HttpRequest *);
 363 SQUIDCEXTERN int neighborsCount(HttpRequest *);
 364 SQUIDCEXTERN int neighborsUdpPing(HttpRequest *,
 365                                   StoreEntry *,
 366                                   IRCB * callback,
 367                                   void *data,
 368                                   int *exprep,
 369                                   int *timeout);
 370 SQUIDCEXTERN void neighborAddAcl(const char *, const char *);
 371
 372 SQUIDCEXTERN void neighborsUdpAck(const cache_key *, icp_common_t *, const Ip::Address &);
 373 SQUIDCEXTERN void neighborAdd(const char *, const char *, int, int, int, int, int);
 374 SQUIDCEXTERN void neighbors_init(void);
 375 #if USE_HTCP
 376 SQUIDCEXTERN void neighborsHtcpClear(StoreEntry *, const char *, HttpRequest *, const HttpRequestMethod &, htcp_clr_reason);
 377 #endif
 378 SQUIDCEXTERN peer *peerFindByName(const char *);
 379 SQUIDCEXTERN peer *peerFindByNameAndPort(const char *, unsigned short);
 380 SQUIDCEXTERN peer *getDefaultParent(HttpRequest * request);
 381 SQUIDCEXTERN peer *getRoundRobinParent(HttpRequest * request);
 382 SQUIDCEXTERN peer *getWeightedRoundRobinParent(HttpRequest * request);
 383 SQUIDCEXTERN void peerClearRRStart(void);
 384 SQUIDCEXTERN void peerClearRR(void);
 385 SQUIDCEXTERN peer *getAnyParent(HttpRequest * request);
 386 SQUIDCEXTERN lookup_t peerDigestLookup(peer * p, HttpRequest * request);
 387 SQUIDCEXTERN peer *neighborsDigestSelect(HttpRequest * request);
 388 SQUIDCEXTERN void peerNoteDigestLookup(HttpRequest * request, peer * p, lookup_t lookup);
 389 SQUIDCEXTERN void peerNoteDigestGone(peer * p);
 390 SQUIDCEXTERN int neighborUp(const peer * e);
 391 SQUIDCEXTERN CBDUNL peerDestroy;
 392 SQUIDCEXTERN const char *neighborTypeStr(const peer * e);
 393 SQUIDCEXTERN peer_t neighborType(const peer *, const HttpRequest *);
 394 SQUIDCEXTERN void peerConnectFailed(peer *);
 395 SQUIDCEXTERN void peerConnectSucceded(peer *);
 396 SQUIDCEXTERN void dump_peer_options(StoreEntry *, peer *);
 397 SQUIDCEXTERN int peerHTTPOkay(const peer *, HttpRequest *);
 398
 399 SQUIDCEXTERN peer *whichPeer(const Ip::Address &from);
 400
 401 SQUIDCEXTERN void peerSelect(HttpRequest *, StoreEntry *, PSC *, void *data);
 402 SQUIDCEXTERN void peerSelectInit(void);
 403
 404 /* peer_digest.c */
 405 class PeerDigest;
 406 SQUIDCEXTERN PeerDigest *peerDigestCreate(peer * p);
 407 SQUIDCEXTERN void peerDigestNeeded(PeerDigest * pd);
 408 SQUIDCEXTERN void peerDigestNotePeerGone(PeerDigest * pd);
 409 SQUIDCEXTERN void peerDigestStatsReport(const PeerDigest * pd, StoreEntry * e);
 410
 411 extern Ip::Address getOutgoingAddr(HttpRequest * request, struct peer *dst_peer);
 412
 413 SQUIDCEXTERN void urnStart(HttpRequest *, StoreEntry *);
 414
 415 SQUIDCEXTERN void redirectInit(void);
 416 SQUIDCEXTERN void redirectShutdown(void);
 417
 418 extern void refreshAddToList(const char *, int, time_t, int, time_t);
 419 extern int refreshIsCachable(const StoreEntry *);
 420 extern int refreshCheckHTTP(const StoreEntry *, HttpRequest *);
 421 extern int refreshCheckICP(const StoreEntry *, HttpRequest *);
 422 extern int refreshCheckHTCP(const StoreEntry *, HttpRequest *);
 423 extern int refreshCheckDigest(const StoreEntry *, time_t delta);
 424 extern time_t getMaxAge(const char *url);
 425 extern void refreshInit(void);
 426 extern const refresh_t *refreshLimits(const char *url);
 427
 428 extern void shut_down(int);
 429 extern void rotate_logs(int);
 430 extern void reconfigure(int);
 431
 432
 433 extern void start_announce(void *unused);
 434 extern void waisStart(FwdState *);
 435
 436 SQUIDCEXTERN void statInit(void);
 437 SQUIDCEXTERN void statFreeMemory(void);
 438 SQUIDCEXTERN double median_svc_get(int, int);
 439 SQUIDCEXTERN void pconnHistCount(int, int);
 440 SQUIDCEXTERN int stat5minClientRequests(void);
 441 SQUIDCEXTERN double stat5minCPUUsage(void);
 442 SQUIDCEXTERN double statRequestHitRatio(int minutes);
 443 SQUIDCEXTERN double statRequestHitMemoryRatio(int minutes);
 444 SQUIDCEXTERN double statRequestHitDiskRatio(int minutes);
 445 SQUIDCEXTERN double statByteHitRatio(int minutes);
 446
 447 /* StatHist */
 448 SQUIDCEXTERN void statHistClean(StatHist * H);
 449 SQUIDCEXTERN void statHistCount(StatHist * H, double val);
 450 SQUIDCEXTERN void statHistCopy(StatHist * Dest, const StatHist * Orig);
 451 SQUIDCEXTERN void statHistSafeCopy(StatHist * Dest, const StatHist * Orig);
 452 SQUIDCEXTERN double statHistDeltaMedian(const StatHist * A, const StatHist * B);
 453 SQUIDCEXTERN double statHistDeltaPctile(const StatHist * A, const StatHist * B, double pctile);
 454 SQUIDCEXTERN void statHistDump(const StatHist * H, StoreEntry * sentry, StatHistBinDumper * bd);
 455 SQUIDCEXTERN void statHistLogInit(StatHist * H, int capacity, double min, double max);
 456 SQUIDCEXTERN void statHistEnumInit(StatHist * H, int last_enum);
 457 SQUIDCEXTERN void statHistIntInit(StatHist * H, int n);
 458 SQUIDCEXTERN StatHistBinDumper statHistEnumDumper;
 459 SQUIDCEXTERN StatHistBinDumper statHistIntDumper;
 460
 461
 462 /* mem */
 463 SQUIDCEXTERN void memClean(void);
 464 SQUIDCEXTERN void memInitModule(void);
 465 SQUIDCEXTERN void memCleanModule(void);
 466 SQUIDCEXTERN void memConfigure(void);
 467 SQUIDCEXTERN void *memAllocate(mem_type);
 468 SQUIDCEXTERN void *memAllocString(size_t net_size, size_t * gross_size);
 469 SQUIDCEXTERN void *memAllocBuf(size_t net_size, size_t * gross_size);
 470 SQUIDCEXTERN void *memReallocBuf(void *buf, size_t net_size, size_t * gross_size);
 471 SQUIDCEXTERN void memFree(void *, int type);
 472 void memFree2K(void *);
 473 void memFree4K(void *);
 474 void memFree8K(void *);
 475 void memFree16K(void *);
 476 void memFree32K(void *);
 477 void memFree64K(void *);
 478 SQUIDCEXTERN void memFreeString(size_t size, void *);
 479 SQUIDCEXTERN void memFreeBuf(size_t size, void *);
 480 SQUIDCEXTERN FREE *memFreeBufFunc(size_t size);
 481 SQUIDCEXTERN int memInUse(mem_type);
 482 SQUIDCEXTERN void memDataInit(mem_type, const char *, size_t, int, bool zeroOnPush = true);
 483 SQUIDCEXTERN void memCheckInit(void);
 484
 485
 486 /* Mem */
 487 SQUIDCEXTERN void memConfigure(void);
 488
 489 /* ----------------------------------------------------------------- */
 490
 491 /* repl_modules.c */
 492 SQUIDCEXTERN void storeReplSetup(void);
 493
 494 /*
 495  * store_log.c
 496  */
 497 SQUIDCEXTERN void storeLog(int tag, const StoreEntry * e);
 498 SQUIDCEXTERN void storeLogRotate(void);
 499 SQUIDCEXTERN void storeLogClose(void);
 500 SQUIDCEXTERN void storeLogOpen(void);
 501
 502
 503 /*
 504  * store_key_*.c
 505  */
 506 SQUIDCEXTERN cache_key *storeKeyDup(const cache_key *);
 507 SQUIDCEXTERN cache_key *storeKeyCopy(cache_key *, const cache_key *);
 508 SQUIDCEXTERN void storeKeyFree(const cache_key *);
 509 SQUIDCEXTERN const cache_key *storeKeyScan(const char *);
 510 SQUIDCEXTERN const char *storeKeyText(const cache_key *);
 511 SQUIDCEXTERN const cache_key *storeKeyPublic(const char *, const HttpRequestMethod&);
 512 SQUIDCEXTERN const cache_key *storeKeyPublicByRequest(HttpRequest *);
 513 SQUIDCEXTERN const cache_key *storeKeyPublicByRequestMethod(HttpRequest *, const HttpRequestMethod&);
 514 SQUIDCEXTERN const cache_key *storeKeyPrivate(const char *, const HttpRequestMethod&, int);
 515 SQUIDCEXTERN int storeKeyHashBuckets(int);
 516 SQUIDCEXTERN int storeKeyNull(const cache_key *);
 517 SQUIDCEXTERN void storeKeyInit(void);
 518 SQUIDCEXTERN HASHHASH storeKeyHashHash;
 519 SQUIDCEXTERN HASHCMP storeKeyHashCmp;
 520
 521 /*
 522  * store_digest.c
 523  */
 524 SQUIDCEXTERN void storeDigestInit(void);
 525 SQUIDCEXTERN void storeDigestNoteStoreReady(void);
 526 SQUIDCEXTERN void storeDigestScheduleRebuild(void);
 527 SQUIDCEXTERN void storeDigestDel(const StoreEntry * entry);
 528 extern void storeDigestReport(StoreEntry *);
 529
 530 /*
 531  * store_rebuild.c
 532  */
 533 SQUIDCEXTERN void storeRebuildStart(void);
 534
 535 SQUIDCEXTERN void storeRebuildComplete(struct _store_rebuild_data *);
 536 SQUIDCEXTERN void storeRebuildProgress(int sd_index, int total, int sofar);
 537
 538 /// loads entry from disk; fills supplied memory buffer on success
 539 bool storeRebuildLoadEntry(int fd, int diskIndex, MemBuf &buf, struct _store_rebuild_data &counts);
 540 /// parses entry buffer and validates entry metadata; fills e on success
 541 bool storeRebuildParseEntry(MemBuf &buf, StoreEntry &e, cache_key *key, struct _store_rebuild_data &counts, uint64_t expectedSize);
 542 /// checks whether the loaded entry should be kept; updates counters
 543 bool storeRebuildKeepEntry(const StoreEntry &e, const cache_key *key, struct _store_rebuild_data &counts);
 544
 545
 546 /*
 547  * store_swapin.c
 548  */
 549 class store_client;
 550 SQUIDCEXTERN void storeSwapInStart(store_client *);
 551
 552 /*
 553  * store_client.c
 554  */
 555 SQUIDCEXTERN store_client *storeClientListAdd(StoreEntry * e, void *data);
 556 SQUIDCEXTERN int storeClientCopyPending(store_client *, StoreEntry * e, void *data);
 557 SQUIDCEXTERN int storeUnregister(store_client * sc, StoreEntry * e, void *data)
 558 ;
 559 SQUIDCEXTERN int storePendingNClients(const StoreEntry * e);
 560 SQUIDCEXTERN int storeClientIsThisAClient(store_client * sc, void *someClient);
 561
 562
 563 SQUIDCEXTERN const char *getMyHostname(void);
 564 SQUIDCEXTERN const char *uniqueHostname(void);
 565 SQUIDCEXTERN void safeunlink(const char *path, int quiet);
 566
 567 #include "fatal.h"
 568 void death(int sig);
 569 void sigusr2_handle(int sig);
 570 void sig_child(int sig);
 571 SQUIDCEXTERN void leave_suid(void);
 572 SQUIDCEXTERN void enter_suid(void);
 573 SQUIDCEXTERN void no_suid(void);
 574 SQUIDCEXTERN void writePidFile(void);
 575 SQUIDCEXTERN void setSocketShutdownLifetimes(int);
 576 SQUIDCEXTERN void setMaxFD(void);
 577 SQUIDCEXTERN void setSystemLimits(void);
 578 extern void squid_signal(int sig, SIGHDLR *, int flags);
 579 SQUIDCEXTERN pid_t readPidFile(void);
 580 SQUIDCEXTERN void keepCapabilities(void);
 581 SQUIDCEXTERN void BroadcastSignalIfAny(int& sig);
 582 /// whether the current process is the parent of all other Squid processes
 583 SQUIDCEXTERN bool IamMasterProcess();
 584 /**
 585     whether the current process is dedicated to doing things that only
 586     a single process should do, such as PID file maintenance and WCCP
 587 */
 588 SQUIDCEXTERN bool IamPrimaryProcess();
 589 /// whether the current process coordinates worker processes
 590 SQUIDCEXTERN bool IamCoordinatorProcess();
 591 /// whether the current process handles HTTP transactions and such
 592 SQUIDCEXTERN bool IamWorkerProcess();
 593 /// whether the current process is dedicated to managing a cache_dir
 594 bool IamDiskProcess();
 595 /// Whether we are running in daemon mode
 596 SQUIDCEXTERN bool InDaemonMode(); // try using specific Iam*() checks above first
 597 /// Whether there should be more than one worker process running
 598 SQUIDCEXTERN bool UsingSmp(); // try using specific Iam*() checks above first
 599 /// number of Kid processes as defined in src/ipc/Kid.h
 600 SQUIDCEXTERN int NumberOfKids();
 601 /// a string describing this process roles such as worker or coordinator
 602 String ProcessRoles();
 603 SQUIDCEXTERN int DebugSignal;
 604
 605 /* AYJ debugs function to show locations being reset with memset() */
 606 SQUIDCEXTERN void *xmemset(void *dst, int, size_t);
 607
 608 SQUIDCEXTERN void debug_trap(const char *);
 609 SQUIDCEXTERN void logsFlush(void);
 610 SQUIDCEXTERN const char *checkNullString(const char *p);
 611
 612 SQUIDCEXTERN void squid_getrusage(struct rusage *r);
 613
 614 SQUIDCEXTERN double rusage_cputime(struct rusage *r);
 615
 616 SQUIDCEXTERN int rusage_maxrss(struct rusage *r);
 617
 618 SQUIDCEXTERN int rusage_pagefaults(struct rusage *r);
 619 SQUIDCEXTERN void releaseServerSockets(void);
 620 SQUIDCEXTERN void PrintRusage(void);
 621 SQUIDCEXTERN void dumpMallocStats(void);
 622
 623 #if USE_UNLINKD
 624 SQUIDCEXTERN void unlinkdInit(void);
 625 SQUIDCEXTERN void unlinkdClose(void);
 626 SQUIDCEXTERN void unlinkdUnlink(const char *);
 627 #endif
 628
 629 SQUIDCEXTERN protocol_t urlParseProtocol(const char *, const char *e = NULL);
 630 SQUIDCEXTERN void urlInitialize(void);
 631 SQUIDCEXTERN HttpRequest *urlParse(const HttpRequestMethod&, char *, HttpRequest *request = NULL);
 632 SQUIDCEXTERN const char *urlCanonical(HttpRequest *);
 633 SQUIDCEXTERN char *urlCanonicalClean(const HttpRequest *);
 634 SQUIDCEXTERN const char *urlCanonicalFakeHttps(const HttpRequest * request);
 635 SQUIDCEXTERN bool urlIsRelative(const char *);
 636 SQUIDCEXTERN char *urlMakeAbsolute(const HttpRequest *, const char *);
 637 SQUIDCEXTERN char *urlRInternal(const char *host, u_short port, const char *dir, const char *name);
 638 SQUIDCEXTERN char *urlInternal(const char *dir, const char *name);
 639 SQUIDCEXTERN int matchDomainName(const char *host, const char *domain);
 640 SQUIDCEXTERN int urlCheckRequest(const HttpRequest *);
 641 SQUIDCEXTERN int urlDefaultPort(protocol_t p);
 642 SQUIDCEXTERN char *urlHostname(const char *url);
 643 SQUIDCEXTERN void urlExtMethodConfigure(void);
 644
 645 SQUIDCEXTERN peer_t parseNeighborType(const char *s);
 646
 647 /* tools.c */
 648 //UNUSED        #include "dlink.h"
 649 //UNUSED        SQUIDCEXTERN void dlinkAdd(void *data, dlink_node *, dlink_list *);
 650 //UNUSED        SQUIDCEXTERN void dlinkAddAfter(void *, dlink_node *, dlink_node *, dlink_list *);
 651 //UNUSED        SQUIDCEXTERN void dlinkAddTail(void *data, dlink_node *, dlink_list *);
 652 //UNUSED        SQUIDCEXTERN void dlinkDelete(dlink_node * m, dlink_list * list);
 653 //UNUSED        SQUIDCEXTERN void dlinkNodeDelete(dlink_node * m);
 654 //UNUSED        SQUIDCEXTERN dlink_node *dlinkNodeNew(void);
 655
 656 SQUIDCEXTERN void kb_incr(kb_t *, size_t);
 657 SQUIDCEXTERN int stringHasWhitespace(const char *);
 658 SQUIDCEXTERN int stringHasCntl(const char *);
 659 SQUIDCEXTERN void linklistPush(link_list **, void *);
 660 SQUIDCEXTERN void *linklistShift(link_list **);
 661 SQUIDCEXTERN int xrename(const char *from, const char *to);
 662 SQUIDCEXTERN int isPowTen(int);
 663 SQUIDCEXTERN void parseEtcHosts(void);
 664 SQUIDCEXTERN int getMyPort(void);
 665 SQUIDCEXTERN void setUmask(mode_t mask);
 666
 667 SQUIDCEXTERN char *strwordtok(char *buf, char **t);
 668 SQUIDCEXTERN void strwordquote(MemBuf * mb, const char *str);
 669
 670
 671 /*
 672  * ipc.c
 673  */
 674 SQUIDCEXTERN pid_t ipcCreate(int type,
 675                              const char *prog,
 676                              const char *const args[],
 677                              const char *name,
 678                              Ip::Address &local_addr,
 679                              int *rfd,
 680                              int *wfd,
 681                              void **hIpc);
 682
 683
 684 /* CacheDigest */
 685 SQUIDCEXTERN CacheDigest *cacheDigestCreate(int capacity, int bpe);
 686 SQUIDCEXTERN void cacheDigestDestroy(CacheDigest * cd);
 687 SQUIDCEXTERN CacheDigest *cacheDigestClone(const CacheDigest * cd);
 688 SQUIDCEXTERN void cacheDigestClear(CacheDigest * cd);
 689 SQUIDCEXTERN void cacheDigestChangeCap(CacheDigest * cd, int new_cap);
 690 SQUIDCEXTERN int cacheDigestTest(const CacheDigest * cd, const cache_key * key);
 691 SQUIDCEXTERN void cacheDigestAdd(CacheDigest * cd, const cache_key * key);
 692 SQUIDCEXTERN void cacheDigestDel(CacheDigest * cd, const cache_key * key);
 693 SQUIDCEXTERN size_t cacheDigestCalcMaskSize(int cap, int bpe);
 694 SQUIDCEXTERN int cacheDigestBitUtil(const CacheDigest * cd);
 695 SQUIDCEXTERN void cacheDigestGuessStatsUpdate(cd_guess_stats * stats, int real_hit, int guess_hit);
 696 SQUIDCEXTERN void cacheDigestGuessStatsReport(const cd_guess_stats * stats, StoreEntry * sentry, const char *label);
 697 SQUIDCEXTERN void cacheDigestReport(CacheDigest * cd, const char *label, StoreEntry * e);
 698
 699 SQUIDCEXTERN void internalStart(HttpRequest *, StoreEntry *);
 700 SQUIDCEXTERN int internalCheck(const char *urlpath);
 701 SQUIDCEXTERN int internalStaticCheck(const char *urlpath);
 702 SQUIDCEXTERN char *internalLocalUri(const char *dir, const char *name);
 703 SQUIDCEXTERN char *internalRemoteUri(const char *, u_short, const char *, const char *);
 704 SQUIDCEXTERN const char *internalHostname(void);
 705 SQUIDCEXTERN int internalHostnameIs(const char *);
 706
 707 SQUIDCEXTERN void carpInit(void);
 708 SQUIDCEXTERN peer *carpSelectParent(HttpRequest *);
 709
 710 SQUIDCEXTERN void peerUserHashInit(void);
 711 SQUIDCEXTERN peer * peerUserHashSelectParent(HttpRequest * request);
 712
 713 SQUIDCEXTERN void peerSourceHashInit(void);
 714 SQUIDCEXTERN peer * peerSourceHashSelectParent(HttpRequest * request);
 715
 716 #if USE_LEAKFINDER
 717 SQUIDCEXTERN void leakInit(void);
 718 SQUIDCEXTERN void *leakAddFL(void *, const char *, int);
 719 SQUIDCEXTERN void *leakTouchFL(void *, const char *, int);
 720 SQUIDCEXTERN void *leakFreeFL(void *, const char *, int);
 721 #endif
 722
 723 /*
 724  * prototypes for system functions missing from system includes
 725  */
 726
 727 #ifdef _SQUID_SOLARIS_
 728
 729 SQUIDCEXTERN int getrusage(int, struct rusage *);
 730 SQUIDCEXTERN int getpagesize(void);
 731 #if !defined(_XPG4_2) && !(defined(__EXTENSIONS__) || \
 732 (!defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)))
 733 SQUIDCEXTERN int gethostname(char *, int);
 734 #endif
 735 #endif
 736
 737 /*
 738  * hack to allow snmp access to the statistics counters
 739  */
 740 SQUIDCEXTERN StatCounters *snmpStatGet(int);
 741
 742 /* Vary support functions */
 743 SQUIDCEXTERN int varyEvaluateMatch(StoreEntry * entry, HttpRequest * req);
 744
 745 /* CygWin & Windows NT Port */
 746 /* win32.c */
 747 #ifdef _SQUID_WIN32_
 748 SQUIDCEXTERN int WIN32_Subsystem_Init(int *, char ***);
 749 SQUIDCEXTERN void WIN32_sendSignal(int);
 750 SQUIDCEXTERN void WIN32_Abort(int);
 751 SQUIDCEXTERN void WIN32_Exit(void);
 752 SQUIDCEXTERN void WIN32_SetServiceCommandLine(void);
 753 SQUIDCEXTERN void WIN32_InstallService(void);
 754 SQUIDCEXTERN void WIN32_RemoveService(void);
 755 SQUIDCEXTERN int SquidMain(int, char **);
 756 #endif /* _SQUID_WIN32_ */
 757 #ifdef _SQUID_MSWIN_
 758
 759 SQUIDCEXTERN int WIN32_pipe(int[2]);
 760
 761 SQUIDCEXTERN int WIN32_getrusage(int, struct rusage *);
 762 SQUIDCEXTERN void WIN32_ExceptionHandlerInit(void);
 763
 764 SQUIDCEXTERN int Win32__WSAFDIsSet(int fd, fd_set* set);
 765 SQUIDCEXTERN DWORD WIN32_IpAddrChangeMonitorInit();
 766
 767 #endif
 768
 769 /* external_acl.c */
 770 class external_acl;
 771         SQUIDCEXTERN void parse_externalAclHelper(external_acl **);
 772
 773         SQUIDCEXTERN void dump_externalAclHelper(StoreEntry * sentry, const char *name, const external_acl *);
 774
 775         SQUIDCEXTERN void free_externalAclHelper(external_acl **);
 776
 777         typedef void EAH(void *data, void *result);
 778         class ACLChecklist;
 779             SQUIDCEXTERN void externalAclLookup(ACLChecklist * ch, void *acl_data, EAH * handler, void *data);
 780
 781             SQUIDCEXTERN void externalAclInit(void);
 782
 783             SQUIDCEXTERN void externalAclShutdown(void);
 784
 785             SQUIDCEXTERN char *strtokFile(void);
 786
 787 #if USE_WCCPv2
 788
 789             SQUIDCEXTERN void parse_wccp2_method(int *v);
 790             SQUIDCEXTERN void free_wccp2_method(int *v);
 791             SQUIDCEXTERN void dump_wccp2_method(StoreEntry * e, const char *label, int v);
 792             SQUIDCEXTERN void parse_wccp2_amethod(int *v);
 793             SQUIDCEXTERN void free_wccp2_amethod(int *v);
 794             SQUIDCEXTERN void dump_wccp2_amethod(StoreEntry * e, const char *label, int v);
 795
 796             SQUIDCEXTERN void parse_wccp2_service(void *v);
 797             SQUIDCEXTERN void free_wccp2_service(void *v);
 798             SQUIDCEXTERN void dump_wccp2_service(StoreEntry * e, const char *label, void *v);
 799
 800             SQUIDCEXTERN int check_null_wccp2_service(void *v);
 801
 802             SQUIDCEXTERN void parse_wccp2_service_info(void *v);
 803
 804             SQUIDCEXTERN void free_wccp2_service_info(void *v);
 805
 806             SQUIDCEXTERN void dump_wccp2_service_info(StoreEntry * e, const char *label, void *v);
 807
 808 #endif
 809
 810 #if HAVE_KRB5 && HAVE_GSSAPI
 811             /* upstream proxy authentication */
 812             SQUIDCEXTERN char *peer_proxy_negotiate_auth(char *principal_name, char *proxy);
 813 #endif
 814
 815             /* call to ensure the auth component schemes exist. */
 816             SQUIDCEXTERN void InitAuthSchemes(void);
 817
 818 #endif /* SQUID_PROTOS_H */