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/IpAddress.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
  49
  50 #if FORW_VIA_DB
  51 SQUIDCEXTERN void fvdbCountVia(const char *key);
  52 SQUIDCEXTERN void fvdbCountForw(const char *key);
  53 #endif
  54 #if HEADERS_LOG
  55 SQUIDCEXTERN void headersLog(int cs, int pq, const HttpRequestMethod& m, void *data);
  56 #endif
  57 SQUIDCEXTERN char *log_quote(const char *header);
  58 SQUIDCEXTERN int logTypeIsATcpHit(log_type);
  59
  60 /*
  61  * cache_cf.c
  62  */
  63 SQUIDCEXTERN void configFreeMemory(void);
  64 class MemBuf;
  65 SQUIDCEXTERN void wordlistCat(const wordlist *, MemBuf * mb);
  66 SQUIDCEXTERN void self_destruct(void);
  67 SQUIDCEXTERN void add_http_port(char *portspec);
  68 extern int xatoi(const char *token);
  69 extern long xatol(const char *token);
  70
  71
  72 /* extra functions from cache_cf.c useful for lib modules */
  73 SQUIDCEXTERN void parse_int(int *var);
  74 SQUIDCEXTERN void parse_onoff(int *var);
  75 SQUIDCEXTERN void parse_eol(char *volatile *var);
  76 SQUIDCEXTERN void parse_wordlist(wordlist ** list);
  77 SQUIDCEXTERN void requirePathnameExists(const char *name, const char *path);
  78 SQUIDCEXTERN void parse_time_t(time_t * var);
  79
  80 SQUIDCEXTERN void parse_IpAddress_list_token(IpAddress_list **, char *);
  81
  82
  83 /* client_side.c - FD related client side routines */
  84
  85 SQUIDCEXTERN void clientdbInit(void);
  86
  87 SQUIDCEXTERN void clientdbUpdate(const IpAddress &, log_type, protocol_t, size_t);
  88
  89 SQUIDCEXTERN int clientdbCutoffDenied(const IpAddress &);
  90 SQUIDCEXTERN void clientdbDump(StoreEntry *);
  91 SQUIDCEXTERN void clientdbFreeMemory(void);
  92
  93 SQUIDCEXTERN int clientdbEstablished(const IpAddress &, int);
  94 SQUIDCEXTERN void clientOpenListenSockets(void);
  95 SQUIDCEXTERN void clientHttpConnectionsClose(void);
  96 SQUIDCEXTERN void httpRequestFree(void *);
  97
  98 extern void clientAccessCheck(void *);
  99
 100 #include "Debug.h"
 101 /* see debug.c for info on context-based debugging */
 102 SQUIDCEXTERN Ctx ctx_enter(const char *descr);
 103 SQUIDCEXTERN void ctx_exit(Ctx ctx);
 104
 105 SQUIDCEXTERN void _db_set_syslog(const char *facility);
 106 SQUIDCEXTERN void _db_init(const char *logfile, const char *options);
 107 SQUIDCEXTERN void _db_rotate_log(void);
 108
 109 /* packs, then prints an object using debugs() */
 110 SQUIDCEXTERN void debugObj(int section, int level, const char *label, void *obj, ObjPackMethod pm);
 111
 112 /* disk.c */
 113 SQUIDCEXTERN int file_open(const char *path, int mode);
 114 SQUIDCEXTERN void file_close(int fd);
 115 /* Adapter file_write for object callbacks */
 116
 117 template <class O>
 118 void
 119 FreeObject(void *address)
 120 {
 121     O *anObject = static_cast <O *>(address);
 122     delete anObject;
 123 }
 124
 125 SQUIDCEXTERN void file_write(int, off_t, void const *, int len, DWCB *, void *, FREE *);
 126 SQUIDCEXTERN void file_write_mbuf(int fd, off_t, MemBuf mb, DWCB * handler, void *handler_data);
 127 SQUIDCEXTERN void file_read(int, char *, int, off_t, DRCB *, void *);
 128 SQUIDCEXTERN void disk_init(void);
 129
 130 SQUIDCEXTERN void dnsShutdown(void);
 131 SQUIDCEXTERN void dnsInit(void);
 132 SQUIDCEXTERN void dnsSubmit(const char *lookup, HLPCB * callback, void *data);
 133
 134 /* dns_internal.c */
 135 SQUIDCEXTERN void idnsInit(void);
 136 SQUIDCEXTERN void idnsShutdown(void);
 137 SQUIDCEXTERN void idnsALookup(const char *, IDNSCB *, void *);
 138
 139 SQUIDCEXTERN void idnsPTRLookup(const IpAddress &, IDNSCB *, void *);
 140
 141 SQUIDCEXTERN void fd_close(int fd);
 142 SQUIDCEXTERN void fd_open(int fd, unsigned int type, const char *);
 143 SQUIDCEXTERN void fd_note(int fd, const char *);
 144 SQUIDCEXTERN void fd_bytes(int fd, int len, unsigned int type);
 145 SQUIDCEXTERN void fdDumpOpen(void);
 146 SQUIDCEXTERN int fdNFree(void);
 147 SQUIDCEXTERN int fdUsageHigh(void);
 148 SQUIDCEXTERN void fdAdjustReserved(void);
 149
 150 SQUIDCEXTERN fileMap *file_map_create(void);
 151 SQUIDCEXTERN int file_map_allocate(fileMap *, int);
 152 SQUIDCEXTERN int file_map_bit_set(fileMap *, int);
 153 SQUIDCEXTERN int file_map_bit_test(fileMap *, int);
 154 SQUIDCEXTERN void file_map_bit_reset(fileMap *, int);
 155 SQUIDCEXTERN void filemapFreeMemory(fileMap *);
 156
 157
 158 SQUIDCEXTERN void fqdncache_nbgethostbyaddr(IpAddress &, FQDNH *, void *);
 159
 160 SQUIDCEXTERN const char *fqdncache_gethostbyaddr(IpAddress &, int flags);
 161 SQUIDCEXTERN void fqdncache_init(void);
 162 SQUIDCEXTERN void fqdnStats(StoreEntry *);
 163 SQUIDCEXTERN void fqdncacheReleaseInvalid(const char *);
 164
 165 SQUIDCEXTERN const char *fqdnFromAddr(IpAddress &);
 166 SQUIDCEXTERN int fqdncacheQueueDrain(void);
 167 SQUIDCEXTERN void fqdncacheFreeMemory(void);
 168 SQUIDCEXTERN void fqdncache_restart(void);
 169 SQUIDCEXTERN void fqdncache_purgelru(void *);
 170 SQUIDCEXTERN void fqdncacheAddEntryFromHosts(char *addr, wordlist * hostnames);
 171
 172 class FwdState;
 173
 174 /**
 175  \defgroup ServerProtocolFTPAPI Server-Side FTP API
 176  \ingroup ServerProtocol
 177  */
 178
 179 /// \ingroup ServerProtocolFTPAPI
 180 SQUIDCEXTERN void ftpStart(FwdState *);
 181
 182 class HttpRequest;
 183 class HttpReply;
 184
 185 /// \ingroup ServerProtocolFTPAPI
 186 SQUIDCEXTERN const char *ftpUrlWith2f(HttpRequest *);
 187
 188
 189 /**
 190  \defgroup ServerProtocolGopherAPI Server-Side Gopher API
 191  \ingroup ServerProtocol
 192  */
 193
 194 /// \ingroup ServerProtocolGopherAPI
 195 SQUIDCEXTERN void gopherStart(FwdState *);
 196
 197 /// \ingroup ServerProtocolGopherAPI
 198 SQUIDCEXTERN int gopherCachable(const HttpRequest *);
 199
 200
 201 /**
 202  \defgroup ServerProtocolWhoisAPI Server-Side WHOIS API
 203  \ingroup ServerProtocol
 204  */
 205
 206 /// \ingroup ServerProtocolWhoisAPI
 207 SQUIDCEXTERN void whoisStart(FwdState *);
 208
 209
 210 /* http.c */
 211 /* for http_hdr_type field */
 212 #include "HttpHeader.h"
 213 SQUIDCEXTERN int httpCachable(const HttpRequestMethod&);
 214 SQUIDCEXTERN void httpStart(FwdState *);
 215 SQUIDCEXTERN mb_size_t httpBuildRequestPrefix(HttpRequest * request,
 216         HttpRequest * orig_request,
 217         StoreEntry * entry,
 218         MemBuf * mb,
 219         http_state_flags);
 220 SQUIDCEXTERN void httpAnonInitModule(void);
 221 SQUIDCEXTERN int httpAnonHdrAllowed(http_hdr_type hdr_id);
 222 SQUIDCEXTERN int httpAnonHdrDenied(http_hdr_type hdr_id);
 223 SQUIDCEXTERN const char *httpMakeVaryMark(HttpRequest * request, HttpReply const * reply);
 224
 225 /* ETag */
 226 SQUIDCEXTERN int etagParseInit(ETag * etag, const char *str);
 227 SQUIDCEXTERN int etagIsEqual(const ETag * tag1, const ETag * tag2);
 228
 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 SQUIDCEXTERN 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 SQUIDCEXTERN void httpHeaderStoreReport(StoreEntry * e);
 281 SQUIDCEXTERN void httpHdrMangleList(HttpHeader *, HttpRequest *, int req_or_rep);
 282 SQUIDCEXTERN int httpReqHdrManglersConfigured();
 283
 284 #ifdef 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 void snmpDebugOid(int lvl, oid * Name, snint Len);
 291
 292 SQUIDCEXTERN void addr2oid(IpAddress &addr, oid *Dest);
 293 SQUIDCEXTERN void oid2addr(oid *Dest, IpAddress &addr, u_int code);
 294
 295 SQUIDCEXTERN IpAddress *client_entry(IpAddress *current);
 296 SQUIDCEXTERN variable_list *snmp_basicFn(variable_list *, snint *);
 297 SQUIDCEXTERN variable_list *snmp_confFn(variable_list *, snint *);
 298 SQUIDCEXTERN variable_list *snmp_sysFn(variable_list *, snint *);
 299 SQUIDCEXTERN variable_list *snmp_prfSysFn(variable_list *, snint *);
 300 SQUIDCEXTERN variable_list *snmp_prfProtoFn(variable_list *, snint *);
 301 SQUIDCEXTERN variable_list *snmp_prfPeerFn(variable_list *, snint *);
 302 SQUIDCEXTERN variable_list *snmp_netIpFn(variable_list *, snint *);
 303 SQUIDCEXTERN variable_list *snmp_netFqdnFn(variable_list *, snint *);
 304 #if USE_DNSSERVERS
 305 SQUIDCEXTERN variable_list *snmp_netDnsFn(variable_list *, snint *);
 306 #else
 307 SQUIDCEXTERN variable_list *snmp_netIdnsFn(variable_list *, snint *);
 308 #endif
 309 SQUIDCEXTERN variable_list *snmp_meshPtblFn(variable_list *, snint *);
 310 SQUIDCEXTERN 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 SQUIDCEXTERN void ipcache_nbgethostbyname(const char *name,
 326         IPH * handler,
 327         void *handlerData);
 328 SQUIDCEXTERN void ipcache_purgelru(void *);
 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 stat_ipcache_get(StoreEntry *);
 334 SQUIDCEXTERN void ipcacheCycleAddr(const char *name, ipcache_addrs *);
 335
 336 SQUIDCEXTERN void ipcacheMarkBadAddr(const char *name, IpAddress &);
 337
 338 SQUIDCEXTERN void ipcacheMarkGoodAddr(const char *name, IpAddress &);
 339 SQUIDCEXTERN void ipcacheFreeMemory(void);
 340 SQUIDCEXTERN ipcache_addrs *ipcacheCheckNumeric(const char *name);
 341 SQUIDCEXTERN void ipcache_restart(void);
 342 SQUIDCEXTERN int ipcacheAddEntryFromHosts(const char *name, const char *ipaddr);
 343
 344 SQUIDCEXTERN char *mime_get_header(const char *mime, const char *header);
 345 SQUIDCEXTERN char *mime_get_header_field(const char *mime, const char *name, const char *prefix);
 346 SQUIDCEXTERN size_t headersEnd(const char *, size_t);
 347
 348 SQUIDCEXTERN void mimeInit(char *filename);
 349 SQUIDCEXTERN void mimeFreeMemory(void);
 350 SQUIDCEXTERN char *mimeGetContentEncoding(const char *fn);
 351 SQUIDCEXTERN char *mimeGetContentType(const char *fn);
 352 SQUIDCEXTERN char const *mimeGetIcon(const char *fn);
 353 SQUIDCEXTERN const char *mimeGetIconURL(const char *fn);
 354 SQUIDCEXTERN char mimeGetTransferMode(const char *fn);
 355 SQUIDCEXTERN int mimeGetDownloadOption(const char *fn);
 356 SQUIDCEXTERN int mimeGetViewOption(const char *fn);
 357
 358 SQUIDCEXTERN int mcastSetTtl(int, int);
 359 SQUIDCEXTERN IPH mcastJoinGroups;
 360
 361 SQUIDCEXTERN peer *getFirstPeer(void);
 362 SQUIDCEXTERN peer *getFirstUpParent(HttpRequest *);
 363 SQUIDCEXTERN peer *getNextPeer(peer *);
 364 SQUIDCEXTERN peer *getSingleParent(HttpRequest *);
 365 SQUIDCEXTERN int neighborsCount(HttpRequest *);
 366 SQUIDCEXTERN int neighborsUdpPing(HttpRequest *,
 367                                   StoreEntry *,
 368                                   IRCB * callback,
 369                                   void *data,
 370                                   int *exprep,
 371                                   int *timeout);
 372 SQUIDCEXTERN void neighborAddAcl(const char *, const char *);
 373
 374 SQUIDCEXTERN void neighborsUdpAck(const cache_key *, icp_common_t *, const IpAddress &);
 375 SQUIDCEXTERN void neighborAdd(const char *, const char *, int, int, int, int, int);
 376 SQUIDCEXTERN void neighbors_init(void);
 377 #if USE_HTCP
 378 SQUIDCEXTERN void neighborsHtcpClear(StoreEntry *, const char *, HttpRequest *, const HttpRequestMethod &, htcp_clr_reason);
 379 #endif
 380 SQUIDCEXTERN peer *peerFindByName(const char *);
 381 SQUIDCEXTERN peer *peerFindByNameAndPort(const char *, unsigned short);
 382 SQUIDCEXTERN peer *getDefaultParent(HttpRequest * request);
 383 SQUIDCEXTERN peer *getRoundRobinParent(HttpRequest * request);
 384 SQUIDCEXTERN peer *getWeightedRoundRobinParent(HttpRequest * request);
 385 SQUIDCEXTERN void peerClearRRStart(void);
 386 SQUIDCEXTERN void peerClearRR(void);
 387 SQUIDCEXTERN peer *getAnyParent(HttpRequest * request);
 388 SQUIDCEXTERN lookup_t peerDigestLookup(peer * p, HttpRequest * request);
 389 SQUIDCEXTERN peer *neighborsDigestSelect(HttpRequest * request);
 390 SQUIDCEXTERN void peerNoteDigestLookup(HttpRequest * request, peer * p, lookup_t lookup);
 391 SQUIDCEXTERN void peerNoteDigestGone(peer * p);
 392 SQUIDCEXTERN int neighborUp(const peer * e);
 393 SQUIDCEXTERN CBDUNL peerDestroy;
 394 SQUIDCEXTERN const char *neighborTypeStr(const peer * e);
 395 SQUIDCEXTERN peer_t neighborType(const peer *, const HttpRequest *);
 396 SQUIDCEXTERN void peerConnectFailed(peer *);
 397 SQUIDCEXTERN void peerConnectSucceded(peer *);
 398 SQUIDCEXTERN void dump_peer_options(StoreEntry *, peer *);
 399 SQUIDCEXTERN int peerHTTPOkay(const peer *, HttpRequest *);
 400
 401 SQUIDCEXTERN peer *whichPeer(const IpAddress &from);
 402
 403 SQUIDCEXTERN void peerSelect(HttpRequest *, StoreEntry *, PSC *, void *data);
 404 SQUIDCEXTERN void peerSelectInit(void);
 405
 406 /* peer_digest.c */
 407 class PeerDigest;
 408 SQUIDCEXTERN PeerDigest *peerDigestCreate(peer * p);
 409 SQUIDCEXTERN void peerDigestNeeded(PeerDigest * pd);
 410 SQUIDCEXTERN void peerDigestNotePeerGone(PeerDigest * pd);
 411 SQUIDCEXTERN void peerDigestStatsReport(const PeerDigest * pd, StoreEntry * e);
 412
 413 extern IpAddress getOutgoingAddr(HttpRequest * request, struct peer *dst_peer);
 414 unsigned long getOutgoingTOS(HttpRequest * request);
 415
 416 SQUIDCEXTERN void urnStart(HttpRequest *, StoreEntry *);
 417
 418 SQUIDCEXTERN void redirectInit(void);
 419 SQUIDCEXTERN void redirectShutdown(void);
 420
 421 extern void refreshAddToList(const char *, int, time_t, int, time_t);
 422 extern int refreshIsCachable(const StoreEntry *);
 423 extern int refreshCheckHTTP(const StoreEntry *, HttpRequest *);
 424 extern int refreshCheckICP(const StoreEntry *, HttpRequest *);
 425 extern int refreshCheckHTCP(const StoreEntry *, HttpRequest *);
 426 extern int refreshCheckDigest(const StoreEntry *, time_t delta);
 427 extern time_t getMaxAge(const char *url);
 428 extern void refreshInit(void);
 429 extern const refresh_t *refreshLimits(const char *url);
 430
 431 extern void shut_down(int);
 432 extern void rotate_logs(int);
 433 extern void reconfigure(int);
 434
 435
 436 extern void start_announce(void *unused);
 437 extern void waisStart(FwdState *);
 438
 439 SQUIDCEXTERN void statInit(void);
 440 SQUIDCEXTERN void statFreeMemory(void);
 441 SQUIDCEXTERN double median_svc_get(int, int);
 442 SQUIDCEXTERN void pconnHistCount(int, int);
 443 SQUIDCEXTERN int stat5minClientRequests(void);
 444 SQUIDCEXTERN double stat5minCPUUsage(void);
 445 SQUIDCEXTERN double statRequestHitRatio(int minutes);
 446 SQUIDCEXTERN double statRequestHitMemoryRatio(int minutes);
 447 SQUIDCEXTERN double statRequestHitDiskRatio(int minutes);
 448 SQUIDCEXTERN double statByteHitRatio(int minutes);
 449
 450 /* StatHist */
 451 SQUIDCEXTERN void statHistClean(StatHist * H);
 452 SQUIDCEXTERN void statHistCount(StatHist * H, double val);
 453 SQUIDCEXTERN void statHistCopy(StatHist * Dest, const StatHist * Orig);
 454 SQUIDCEXTERN void statHistSafeCopy(StatHist * Dest, const StatHist * Orig);
 455 SQUIDCEXTERN double statHistDeltaMedian(const StatHist * A, const StatHist * B);
 456 SQUIDCEXTERN double statHistDeltaPctile(const StatHist * A, const StatHist * B, double pctile);
 457 SQUIDCEXTERN void statHistDump(const StatHist * H, StoreEntry * sentry, StatHistBinDumper * bd);
 458 SQUIDCEXTERN void statHistLogInit(StatHist * H, int capacity, double min, double max);
 459 SQUIDCEXTERN void statHistEnumInit(StatHist * H, int last_enum);
 460 SQUIDCEXTERN void statHistIntInit(StatHist * H, int n);
 461 SQUIDCEXTERN StatHistBinDumper statHistEnumDumper;
 462 SQUIDCEXTERN StatHistBinDumper statHistIntDumper;
 463
 464
 465 /* mem */
 466 SQUIDCEXTERN void memClean(void);
 467 SQUIDCEXTERN void memInitModule(void);
 468 SQUIDCEXTERN void memCleanModule(void);
 469 SQUIDCEXTERN void memConfigure(void);
 470 SQUIDCEXTERN void *memAllocate(mem_type);
 471 SQUIDCEXTERN void *memAllocString(size_t net_size, size_t * gross_size);
 472 SQUIDCEXTERN void *memAllocBuf(size_t net_size, size_t * gross_size);
 473 SQUIDCEXTERN void *memReallocBuf(void *buf, size_t net_size, size_t * gross_size);
 474 SQUIDCEXTERN void memFree(void *, int type);
 475 SQUIDCEXTERN void memFree4K(void *);
 476 SQUIDCEXTERN void memFree8K(void *);
 477 SQUIDCEXTERN void memFreeString(size_t size, void *);
 478 SQUIDCEXTERN void memFreeBuf(size_t size, void *);
 479 SQUIDCEXTERN FREE *memFreeBufFunc(size_t size);
 480 SQUIDCEXTERN int memInUse(mem_type);
 481 SQUIDCEXTERN void memDataInit(mem_type, const char *, size_t, int, bool zeroOnPush = true);
 482 SQUIDCEXTERN void memCheckInit(void);
 483
 484
 485 /* Mem */
 486 SQUIDCEXTERN void memConfigure(void);
 487
 488 /* ----------------------------------------------------------------- */
 489
 490 /* repl_modules.c */
 491 SQUIDCEXTERN void storeReplSetup(void);
 492
 493 /*
 494  * store_log.c
 495  */
 496 SQUIDCEXTERN void storeLog(int tag, const StoreEntry * e);
 497 SQUIDCEXTERN void storeLogRotate(void);
 498 SQUIDCEXTERN void storeLogClose(void);
 499 SQUIDCEXTERN void storeLogOpen(void);
 500
 501
 502 /*
 503  * store_key_*.c
 504  */
 505 SQUIDCEXTERN cache_key *storeKeyDup(const cache_key *);
 506 SQUIDCEXTERN cache_key *storeKeyCopy(cache_key *, const cache_key *);
 507 SQUIDCEXTERN void storeKeyFree(const cache_key *);
 508 SQUIDCEXTERN const cache_key *storeKeyScan(const char *);
 509 SQUIDCEXTERN const char *storeKeyText(const cache_key *);
 510 SQUIDCEXTERN const cache_key *storeKeyPublic(const char *, const HttpRequestMethod&);
 511 SQUIDCEXTERN const cache_key *storeKeyPublicByRequest(HttpRequest *);
 512 SQUIDCEXTERN const cache_key *storeKeyPublicByRequestMethod(HttpRequest *, const HttpRequestMethod&);
 513 SQUIDCEXTERN const cache_key *storeKeyPrivate(const char *, const HttpRequestMethod&, int);
 514 SQUIDCEXTERN int storeKeyHashBuckets(int);
 515 SQUIDCEXTERN int storeKeyNull(const cache_key *);
 516 SQUIDCEXTERN void storeKeyInit(void);
 517 SQUIDCEXTERN HASHHASH storeKeyHashHash;
 518 SQUIDCEXTERN HASHCMP storeKeyHashCmp;
 519
 520 /*
 521  * store_digest.c
 522  */
 523 SQUIDCEXTERN void storeDigestInit(void);
 524 SQUIDCEXTERN void storeDigestNoteStoreReady(void);
 525 SQUIDCEXTERN void storeDigestScheduleRebuild(void);
 526 SQUIDCEXTERN void storeDigestDel(const StoreEntry * entry);
 527 SQUIDCEXTERN void storeDigestReport(StoreEntry *);
 528
 529 /*
 530  * store_rebuild.c
 531  */
 532 SQUIDCEXTERN void storeRebuildStart(void);
 533
 534 SQUIDCEXTERN void storeRebuildComplete(struct _store_rebuild_data *);
 535 SQUIDCEXTERN void storeRebuildProgress(int sd_index, int total, int sofar);
 536
 537 /*
 538  * store_swapin.c
 539  */
 540 class store_client;
 541 SQUIDCEXTERN void storeSwapInStart(store_client *);
 542
 543 /*
 544  * store_client.c
 545  */
 546 SQUIDCEXTERN store_client *storeClientListAdd(StoreEntry * e, void *data);
 547 SQUIDCEXTERN int storeClientCopyPending(store_client *, StoreEntry * e, void *data);
 548 SQUIDCEXTERN int storeUnregister(store_client * sc, StoreEntry * e, void *data)
 549 ;
 550 SQUIDCEXTERN int storePendingNClients(const StoreEntry * e);
 551 SQUIDCEXTERN int storeClientIsThisAClient(store_client * sc, void *someClient);
 552
 553
 554 SQUIDCEXTERN const char *getMyHostname(void);
 555 SQUIDCEXTERN const char *uniqueHostname(void);
 556 SQUIDCEXTERN void safeunlink(const char *path, int quiet);
 557 SQUIDCEXTERN void death(int sig);
 558 SQUIDCEXTERN void fatal(const char *message);
 559 SQUIDCEXTERN void fatalf(const char *fmt,...) PRINTF_FORMAT_ARG1;
 560 SQUIDCEXTERN void fatal_dump(const char *message);
 561 SQUIDCEXTERN void sigusr2_handle(int sig);
 562 SQUIDCEXTERN void sig_child(int sig);
 563 SQUIDCEXTERN void leave_suid(void);
 564 SQUIDCEXTERN void enter_suid(void);
 565 SQUIDCEXTERN void no_suid(void);
 566 SQUIDCEXTERN void writePidFile(void);
 567 SQUIDCEXTERN void setSocketShutdownLifetimes(int);
 568 SQUIDCEXTERN void setMaxFD(void);
 569 SQUIDCEXTERN int percent(int, int);
 570 SQUIDCEXTERN double dpercent(double, double);
 571 SQUIDCEXTERN void squid_signal(int sig, SIGHDLR *, int flags);
 572 SQUIDCEXTERN pid_t readPidFile(void);
 573 SQUIDCEXTERN void keepCapabilities(void);
 574
 575 /* AYJ debugs function to show locations being reset with memset() */
 576 SQUIDCEXTERN void *xmemset(void *dst, int, size_t);
 577
 578 SQUIDCEXTERN int intAverage(int, int, int, int);
 579 SQUIDCEXTERN double doubleAverage(double, double, int, int);
 580 SQUIDCEXTERN void debug_trap(const char *);
 581 SQUIDCEXTERN void logsFlush(void);
 582 SQUIDCEXTERN const char *checkNullString(const char *p);
 583
 584 SQUIDCEXTERN void squid_getrusage(struct rusage *r);
 585
 586 SQUIDCEXTERN double rusage_cputime(struct rusage *r);
 587
 588 SQUIDCEXTERN int rusage_maxrss(struct rusage *r);
 589
 590 SQUIDCEXTERN int rusage_pagefaults(struct rusage *r);
 591 SQUIDCEXTERN void releaseServerSockets(void);
 592 SQUIDCEXTERN void PrintRusage(void);
 593 SQUIDCEXTERN void dumpMallocStats(void);
 594
 595 #if USE_UNLINKD
 596 SQUIDCEXTERN void unlinkdInit(void);
 597 SQUIDCEXTERN void unlinkdClose(void);
 598 SQUIDCEXTERN void unlinkdUnlink(const char *);
 599 #endif
 600
 601 SQUIDCEXTERN protocol_t urlParseProtocol(const char *, const char *e = NULL);
 602 SQUIDCEXTERN void urlInitialize(void);
 603 SQUIDCEXTERN HttpRequest *urlParse(const HttpRequestMethod&, char *, HttpRequest *request = NULL);
 604 SQUIDCEXTERN const char *urlCanonical(HttpRequest *);
 605 SQUIDCEXTERN char *urlCanonicalClean(const HttpRequest *);
 606 SQUIDCEXTERN const char *urlCanonicalFakeHttps(const HttpRequest * request);
 607 SQUIDCEXTERN bool urlIsRelative(const char *);
 608 SQUIDCEXTERN char *urlMakeAbsolute(const HttpRequest *, const char *);
 609 SQUIDCEXTERN char *urlRInternal(const char *host, u_short port, const char *dir, const char *name);
 610 SQUIDCEXTERN char *urlInternal(const char *dir, const char *name);
 611 SQUIDCEXTERN int matchDomainName(const char *host, const char *domain);
 612 SQUIDCEXTERN int urlCheckRequest(const HttpRequest *);
 613 SQUIDCEXTERN int urlDefaultPort(protocol_t p);
 614 SQUIDCEXTERN char *urlHostname(const char *url);
 615 SQUIDCEXTERN void urlExtMethodConfigure(void);
 616
 617 SQUIDCEXTERN void useragentOpenLog(void);
 618 SQUIDCEXTERN void useragentRotateLog(void);
 619 SQUIDCEXTERN void logUserAgent(const char *, const char *);
 620 SQUIDCEXTERN void useragentLogClose(void);
 621 SQUIDCEXTERN void refererOpenLog(void);
 622 SQUIDCEXTERN void refererRotateLog(void);
 623 SQUIDCEXTERN void logReferer(const char *, const char *, const char *);
 624 SQUIDCEXTERN void refererCloseLog(void);
 625 SQUIDCEXTERN peer_t parseNeighborType(const char *s);
 626
 627 /* tools.c */
 628 //UNUSED        #include "dlink.h"
 629 //UNUSED        SQUIDCEXTERN void dlinkAdd(void *data, dlink_node *, dlink_list *);
 630 //UNUSED        SQUIDCEXTERN void dlinkAddAfter(void *, dlink_node *, dlink_node *, dlink_list *);
 631 //UNUSED        SQUIDCEXTERN void dlinkAddTail(void *data, dlink_node *, dlink_list *);
 632 //UNUSED        SQUIDCEXTERN void dlinkDelete(dlink_node * m, dlink_list * list);
 633 //UNUSED        SQUIDCEXTERN void dlinkNodeDelete(dlink_node * m);
 634 //UNUSED        SQUIDCEXTERN dlink_node *dlinkNodeNew(void);
 635
 636 SQUIDCEXTERN void kb_incr(kb_t *, size_t);
 637 SQUIDCEXTERN int stringHasWhitespace(const char *);
 638 SQUIDCEXTERN int stringHasCntl(const char *);
 639 SQUIDCEXTERN void linklistPush(link_list **, void *);
 640 SQUIDCEXTERN void *linklistShift(link_list **);
 641 SQUIDCEXTERN int xrename(const char *from, const char *to);
 642 SQUIDCEXTERN int isPowTen(int);
 643 SQUIDCEXTERN void parseEtcHosts(void);
 644 SQUIDCEXTERN int getMyPort(void);
 645 SQUIDCEXTERN void setUmask(mode_t mask);
 646
 647 SQUIDCEXTERN char *strwordtok(char *buf, char **t);
 648 SQUIDCEXTERN void strwordquote(MemBuf * mb, const char *str);
 649
 650
 651 /*
 652  * ipc.c
 653  */
 654 SQUIDCEXTERN pid_t ipcCreate(int type,
 655                              const char *prog,
 656                              const char *const args[],
 657                              const char *name,
 658                              IpAddress &local_addr,
 659                              int *rfd,
 660                              int *wfd,
 661                              void **hIpc);
 662
 663
 664 /* CacheDigest */
 665 SQUIDCEXTERN CacheDigest *cacheDigestCreate(int capacity, int bpe);
 666 SQUIDCEXTERN void cacheDigestDestroy(CacheDigest * cd);
 667 SQUIDCEXTERN CacheDigest *cacheDigestClone(const CacheDigest * cd);
 668 SQUIDCEXTERN void cacheDigestClear(CacheDigest * cd);
 669 SQUIDCEXTERN void cacheDigestChangeCap(CacheDigest * cd, int new_cap);
 670 SQUIDCEXTERN int cacheDigestTest(const CacheDigest * cd, const cache_key * key);
 671 SQUIDCEXTERN void cacheDigestAdd(CacheDigest * cd, const cache_key * key);
 672 SQUIDCEXTERN void cacheDigestDel(CacheDigest * cd, const cache_key * key);
 673 SQUIDCEXTERN size_t cacheDigestCalcMaskSize(int cap, int bpe);
 674 SQUIDCEXTERN int cacheDigestBitUtil(const CacheDigest * cd);
 675 SQUIDCEXTERN void cacheDigestGuessStatsUpdate(cd_guess_stats * stats, int real_hit, int guess_hit);
 676 SQUIDCEXTERN void cacheDigestGuessStatsReport(const cd_guess_stats * stats, StoreEntry * sentry, const char *label);
 677 SQUIDCEXTERN void cacheDigestReport(CacheDigest * cd, const char *label, StoreEntry * e);
 678
 679 SQUIDCEXTERN void internalStart(HttpRequest *, StoreEntry *);
 680 SQUIDCEXTERN int internalCheck(const char *urlpath);
 681 SQUIDCEXTERN int internalStaticCheck(const char *urlpath);
 682 SQUIDCEXTERN char *internalLocalUri(const char *dir, const char *name);
 683 SQUIDCEXTERN char *internalRemoteUri(const char *, u_short, const char *, const char *);
 684 SQUIDCEXTERN const char *internalHostname(void);
 685 SQUIDCEXTERN int internalHostnameIs(const char *);
 686
 687 SQUIDCEXTERN void carpInit(void);
 688 SQUIDCEXTERN peer *carpSelectParent(HttpRequest *);
 689
 690 SQUIDCEXTERN void peerUserHashInit(void);
 691 SQUIDCEXTERN peer * peerUserHashSelectParent(HttpRequest * request);
 692
 693 SQUIDCEXTERN void peerSourceHashInit(void);
 694 SQUIDCEXTERN peer * peerSourceHashSelectParent(HttpRequest * request);
 695
 696 #if USE_LEAKFINDER
 697 SQUIDCEXTERN void leakInit(void);
 698 SQUIDCEXTERN void *leakAddFL(void *, const char *, int);
 699 SQUIDCEXTERN void *leakTouchFL(void *, const char *, int);
 700 SQUIDCEXTERN void *leakFreeFL(void *, const char *, int);
 701 #endif
 702
 703 /* logfile.c */
 704 SQUIDCEXTERN Logfile *logfileOpen(const char *path, size_t bufsz, int);
 705 SQUIDCEXTERN void logfileClose(Logfile * lf);
 706 SQUIDCEXTERN void logfileRotate(Logfile * lf);
 707 SQUIDCEXTERN void logfileWrite(Logfile * lf, void *buf, size_t len);
 708 SQUIDCEXTERN void logfileFlush(Logfile * lf);
 709 SQUIDCEXTERN void logfilePrintf(Logfile * lf, const char *fmt,...) PRINTF_FORMAT_ARG2;
 710
 711 /*
 712  * prototypes for system functions missing from system includes
 713  */
 714
 715 #ifdef _SQUID_SOLARIS_
 716
 717 SQUIDCEXTERN int getrusage(int, struct rusage *);
 718 SQUIDCEXTERN int getpagesize(void);
 719 #if !defined(_XPG4_2) && !(defined(__EXTENSIONS__) || \
 720 (!defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)))
 721 SQUIDCEXTERN int gethostname(char *, int);
 722 #endif
 723 #endif
 724
 725 /*
 726  * hack to allow snmp access to the statistics counters
 727  */
 728 SQUIDCEXTERN StatCounters *snmpStatGet(int);
 729
 730 /* Vary support functions */
 731 SQUIDCEXTERN int varyEvaluateMatch(StoreEntry * entry, HttpRequest * req);
 732
 733 /* CygWin & Windows NT Port */
 734 /* win32.c */
 735 #ifdef _SQUID_WIN32_
 736 SQUIDCEXTERN int WIN32_Subsystem_Init(int *, char ***);
 737 SQUIDCEXTERN void WIN32_sendSignal(int);
 738 SQUIDCEXTERN void WIN32_Abort(int);
 739 SQUIDCEXTERN void WIN32_Exit(void);
 740 SQUIDCEXTERN void WIN32_SetServiceCommandLine(void);
 741 SQUIDCEXTERN void WIN32_InstallService(void);
 742 SQUIDCEXTERN void WIN32_RemoveService(void);
 743 SQUIDCEXTERN int SquidMain(int, char **);
 744 #endif /* _SQUID_WIN32_ */
 745 #ifdef _SQUID_MSWIN_
 746
 747 SQUIDCEXTERN int WIN32_pipe(int[2]);
 748
 749 SQUIDCEXTERN int WIN32_getrusage(int, struct rusage *);
 750 SQUIDCEXTERN void WIN32_ExceptionHandlerInit(void);
 751
 752 SQUIDCEXTERN int Win32__WSAFDIsSet(int fd, fd_set* set);
 753 SQUIDCEXTERN DWORD WIN32_IpAddrChangeMonitorInit();
 754
 755 #endif
 756
 757 /* external_acl.c */
 758 class external_acl;
 759         SQUIDCEXTERN void parse_externalAclHelper(external_acl **);
 760
 761         SQUIDCEXTERN void dump_externalAclHelper(StoreEntry * sentry, const char *name, const external_acl *);
 762
 763         SQUIDCEXTERN void free_externalAclHelper(external_acl **);
 764
 765         typedef void EAH(void *data, void *result);
 766         class ACLChecklist;
 767             SQUIDCEXTERN void externalAclLookup(ACLChecklist * ch, void *acl_data, EAH * handler, void *data);
 768
 769             SQUIDCEXTERN void externalAclInit(void);
 770
 771             SQUIDCEXTERN void externalAclShutdown(void);
 772
 773             SQUIDCEXTERN char *strtokFile(void);
 774
 775 #if USE_WCCPv2
 776
 777             SQUIDCEXTERN void parse_wccp2_method(int *v);
 778             SQUIDCEXTERN void free_wccp2_method(int *v);
 779             SQUIDCEXTERN void dump_wccp2_method(StoreEntry * e, const char *label, int v);
 780             SQUIDCEXTERN void parse_wccp2_amethod(int *v);
 781             SQUIDCEXTERN void free_wccp2_amethod(int *v);
 782             SQUIDCEXTERN void dump_wccp2_amethod(StoreEntry * e, const char *label, int v);
 783
 784             SQUIDCEXTERN void parse_wccp2_service(void *v);
 785             SQUIDCEXTERN void free_wccp2_service(void *v);
 786             SQUIDCEXTERN void dump_wccp2_service(StoreEntry * e, const char *label, void *v);
 787
 788             SQUIDCEXTERN int check_null_wccp2_service(void *v);
 789
 790             SQUIDCEXTERN void parse_wccp2_service_info(void *v);
 791
 792             SQUIDCEXTERN void free_wccp2_service_info(void *v);
 793
 794             SQUIDCEXTERN void dump_wccp2_service_info(StoreEntry * e, const char *label, void *v);
 795
 796 #endif
 797
 798 #if HAVE_KRB5 && HAVE_GSSAPI
 799             /* upstream proxy authentication */
 800             SQUIDCEXTERN char *peer_proxy_negotiate_auth(char *principal_name, char *proxy);
 801 #endif
 802 #endif /* SQUID_PROTOS_H */