2 * SQUID Web Proxy Cache http://www.squid-cache.org/
3 * ----------------------------------------------------------
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.
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.
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.
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.
29 #ifndef SQUID_PROTOS_H
30 #define SQUID_PROTOS_H
32 /* included for routines that have not moved out to their proper homes
36 /* for routines still in this file that take CacheManager parameters */
37 #include "ip/Address.h"
38 /* for parameters that still need these */
40 /* some parameters stil need this */
43 /* for parameters that still need these */
47 class HttpRequestMethod
;
54 SQUIDCEXTERN
void fvdbCountVia(const char *key
);
55 SQUIDCEXTERN
void fvdbCountForw(const char *key
);
58 SQUIDCEXTERN
void headersLog(int cs
, int pq
, const HttpRequestMethod
& m
, void *data
);
60 SQUIDCEXTERN
int logTypeIsATcpHit(log_type
);
65 SQUIDCEXTERN
void configFreeMemory(void);
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
);
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
);
83 /* client_side.c - FD related client side routines */
85 SQUIDCEXTERN
void clientdbInit(void);
87 #include "anyp/ProtocolType.h"
88 SQUIDCEXTERN
void clientdbUpdate(const Ip::Address
&, log_type
, AnyP::ProtocolType
, size_t);
90 SQUIDCEXTERN
int clientdbCutoffDenied(const Ip::Address
&);
91 void clientdbDump(StoreEntry
*);
92 SQUIDCEXTERN
void clientdbFreeMemory(void);
94 SQUIDCEXTERN
int clientdbEstablished(const Ip::Address
&, int);
96 SQUIDCEXTERN
void clientdbSetWriteLimiter(ClientInfo
* info
, const int writeSpeedLimit
,const double initialBurst
,const double highWatermark
);
97 SQUIDCEXTERN ClientInfo
* clientdbGetInfo(const Ip::Address
&addr
);
99 SQUIDCEXTERN
void clientOpenListenSockets(void);
100 SQUIDCEXTERN
void clientHttpConnectionsClose(void);
101 SQUIDCEXTERN
void httpRequestFree(void *);
103 extern void clientAccessCheck(void *);
107 /* packs, then prints an object using debugs() */
108 SQUIDCEXTERN
void debugObj(int section
, int level
, const char *label
, void *obj
, ObjPackMethod pm
);
111 SQUIDCEXTERN
int file_open(const char *path
, int mode
);
112 SQUIDCEXTERN
void file_close(int fd
);
113 /* Adapter file_write for object callbacks */
117 FreeObject(void *address
)
119 O
*anObject
= static_cast <O
*>(address
);
123 SQUIDCEXTERN
void file_write(int, off_t
, void const *, int len
, DWCB
*, void *, FREE
*);
124 SQUIDCEXTERN
void file_write_mbuf(int fd
, off_t
, MemBuf mb
, DWCB
* handler
, void *handler_data
);
125 SQUIDCEXTERN
void file_read(int, char *, int, off_t
, DRCB
*, void *);
126 SQUIDCEXTERN
void disk_init(void);
128 SQUIDCEXTERN
void fd_close(int fd
);
129 SQUIDCEXTERN
void fd_open(int fd
, unsigned int type
, const char *);
130 SQUIDCEXTERN
void fd_note(int fd
, const char *);
131 SQUIDCEXTERN
void fd_bytes(int fd
, int len
, unsigned int type
);
132 SQUIDCEXTERN
void fdDumpOpen(void);
133 SQUIDCEXTERN
int fdUsageHigh(void);
134 SQUIDCEXTERN
void fdAdjustReserved(void);
136 SQUIDCEXTERN
void fqdncache_nbgethostbyaddr(const Ip::Address
&, FQDNH
*, void *);
138 SQUIDCEXTERN
const char *fqdncache_gethostbyaddr(const Ip::Address
&, int flags
);
139 SQUIDCEXTERN
void fqdncache_init(void);
140 void fqdnStats(StoreEntry
*);
141 SQUIDCEXTERN
void fqdncacheReleaseInvalid(const char *);
143 SQUIDCEXTERN
const char *fqdnFromAddr(const Ip::Address
&);
144 SQUIDCEXTERN
int fqdncacheQueueDrain(void);
145 SQUIDCEXTERN
void fqdncacheFreeMemory(void);
146 SQUIDCEXTERN
void fqdncache_restart(void);
147 void fqdncache_purgelru(void *);
148 SQUIDCEXTERN
void fqdncacheAddEntryFromHosts(char *addr
, wordlist
* hostnames
);
153 \defgroup ServerProtocolFTPAPI Server-Side FTP API
154 \ingroup ServerProtocol
157 /// \ingroup ServerProtocolFTPAPI
158 SQUIDCEXTERN
void ftpStart(FwdState
*);
163 /// \ingroup ServerProtocolFTPAPI
164 SQUIDCEXTERN
const char *ftpUrlWith2f(HttpRequest
*);
168 \defgroup ServerProtocolGopherAPI Server-Side Gopher API
169 \ingroup ServerProtocol
172 /// \ingroup ServerProtocolGopherAPI
173 SQUIDCEXTERN
void gopherStart(FwdState
*);
175 /// \ingroup ServerProtocolGopherAPI
176 SQUIDCEXTERN
int gopherCachable(const HttpRequest
*);
180 \defgroup ServerProtocolWhoisAPI Server-Side WHOIS API
181 \ingroup ServerProtocol
184 /// \ingroup ServerProtocolWhoisAPI
185 SQUIDCEXTERN
void whoisStart(FwdState
*);
189 /* for http_hdr_type field */
190 #include "HttpHeader.h"
191 SQUIDCEXTERN
int httpCachable(const HttpRequestMethod
&);
192 SQUIDCEXTERN
void httpStart(FwdState
*);
193 SQUIDCEXTERN mb_size_t
httpBuildRequestPrefix(HttpRequest
* request
,
194 HttpRequest
* orig_request
,
198 SQUIDCEXTERN
const char *httpMakeVaryMark(HttpRequest
* request
, HttpReply
const * reply
);
200 #include "HttpStatusCode.h"
201 SQUIDCEXTERN
const char *httpStatusString(http_status status
);
205 /* Http Cache Control Header Field */
206 SQUIDCEXTERN
void httpHdrCcInitModule(void);
207 SQUIDCEXTERN
void httpHdrCcCleanModule(void);
208 SQUIDCEXTERN
void httpHdrCcUpdateStats(const HttpHdrCc
* cc
, StatHist
* hist
);
209 void httpHdrCcStatDumper(StoreEntry
* sentry
, int idx
, double val
, double size
, int count
);
211 /* Http Header Tools */
212 class HttpHeaderFieldInfo
;
213 SQUIDCEXTERN HttpHeaderFieldInfo
*httpHeaderBuildFieldsInfo(const HttpHeaderFieldAttrs
* attrs
, int count
);
214 SQUIDCEXTERN
void httpHeaderDestroyFieldsInfo(HttpHeaderFieldInfo
* info
, int count
);
215 SQUIDCEXTERN http_hdr_type
httpHeaderIdByName(const char *name
, size_t name_len
, const HttpHeaderFieldInfo
* attrs
, int end
);
216 SQUIDCEXTERN http_hdr_type
httpHeaderIdByNameDef(const char *name
, int name_len
);
217 SQUIDCEXTERN
const char *httpHeaderNameById(int id
);
218 SQUIDCEXTERN
int httpHeaderHasConnDir(const HttpHeader
* hdr
, const char *directive
);
219 SQUIDCEXTERN
void strListAdd(String
* str
, const char *item
, char del
);
220 SQUIDCEXTERN
int strListIsMember(const String
* str
, const char *item
, char del
);
221 SQUIDCEXTERN
int strListIsSubstr(const String
* list
, const char *s
, char del
);
222 SQUIDCEXTERN
int strListGetItem(const String
* str
, char del
, const char **item
, int *ilen
, const char **pos
);
223 SQUIDCEXTERN
const char *getStringPrefix(const char *str
, const char *end
);
224 SQUIDCEXTERN
int httpHeaderParseInt(const char *start
, int *val
);
225 SQUIDCEXTERN
int httpHeaderParseOffset(const char *start
, int64_t * off
);
227 httpHeaderPutStrf(HttpHeader
* hdr
, http_hdr_type id
, const char *fmt
,...) PRINTF_FORMAT_ARG3
;
231 SQUIDCEXTERN
void httpHeaderInitModule(void);
232 SQUIDCEXTERN
void httpHeaderCleanModule(void);
234 /* store report about current header usage and other stats */
235 void httpHeaderStoreReport(StoreEntry
* e
);
236 SQUIDCEXTERN
void httpHdrMangleList(HttpHeader
*, HttpRequest
*, int req_or_rep
);
237 SQUIDCEXTERN
int httpReqHdrManglersConfigured();
240 SQUIDCEXTERN PF snmpHandleUdp
;
241 SQUIDCEXTERN
void snmpInit(void);
242 SQUIDCEXTERN
void snmpOpenPorts(void);
243 SQUIDCEXTERN
void snmpClosePorts(void);
244 SQUIDCEXTERN
const char * snmpDebugOid(oid
* Name
, snint Len
, MemBuf
&outbuf
);
246 SQUIDCEXTERN
void addr2oid(Ip::Address
&addr
, oid
*Dest
);
247 SQUIDCEXTERN
void oid2addr(oid
*Dest
, Ip::Address
&addr
, u_int code
);
249 SQUIDCEXTERN
Ip::Address
*client_entry(Ip::Address
*current
);
250 extern variable_list
*snmp_basicFn(variable_list
*, snint
*);
251 extern variable_list
*snmp_confFn(variable_list
*, snint
*);
252 extern variable_list
*snmp_sysFn(variable_list
*, snint
*);
253 extern variable_list
*snmp_prfSysFn(variable_list
*, snint
*);
254 extern variable_list
*snmp_prfProtoFn(variable_list
*, snint
*);
255 extern variable_list
*snmp_prfPeerFn(variable_list
*, snint
*);
256 extern variable_list
*snmp_netIpFn(variable_list
*, snint
*);
257 extern variable_list
*snmp_netFqdnFn(variable_list
*, snint
*);
258 extern variable_list
*snmp_netDnsFn(variable_list
*, snint
*);
259 extern variable_list
*snmp_meshPtblFn(variable_list
*, snint
*);
260 extern variable_list
*snmp_meshCtblFn(variable_list
*, snint
*);
261 #endif /* SQUID_SNMP */
264 SQUIDCEXTERN
void wccpInit(void);
265 SQUIDCEXTERN
void wccpConnectionOpen(void);
266 SQUIDCEXTERN
void wccpConnectionClose(void);
267 #endif /* USE_WCCP */
270 extern void wccp2Init(void);
271 extern void wccp2ConnectionOpen(void);
272 extern void wccp2ConnectionClose(void);
273 #endif /* USE_WCCPv2 */
275 SQUIDCEXTERN
char *mime_get_header(const char *mime
, const char *header
);
276 SQUIDCEXTERN
char *mime_get_header_field(const char *mime
, const char *name
, const char *prefix
);
277 SQUIDCEXTERN
size_t headersEnd(const char *, size_t);
279 SQUIDCEXTERN
void mimeInit(char *filename
);
280 SQUIDCEXTERN
void mimeFreeMemory(void);
281 SQUIDCEXTERN
char *mimeGetContentEncoding(const char *fn
);
282 SQUIDCEXTERN
char *mimeGetContentType(const char *fn
);
283 SQUIDCEXTERN
char const *mimeGetIcon(const char *fn
);
284 SQUIDCEXTERN
const char *mimeGetIconURL(const char *fn
);
285 SQUIDCEXTERN
char mimeGetTransferMode(const char *fn
);
286 SQUIDCEXTERN
int mimeGetDownloadOption(const char *fn
);
287 SQUIDCEXTERN
int mimeGetViewOption(const char *fn
);
290 SQUIDCEXTERN
int mcastSetTtl(int, int);
291 SQUIDCEXTERN IPH mcastJoinGroups
;
293 SQUIDCEXTERN peer
*getFirstPeer(void);
294 SQUIDCEXTERN peer
*getFirstUpParent(HttpRequest
*);
295 SQUIDCEXTERN peer
*getNextPeer(peer
*);
296 SQUIDCEXTERN peer
*getSingleParent(HttpRequest
*);
297 SQUIDCEXTERN
int neighborsCount(HttpRequest
*);
298 SQUIDCEXTERN
int neighborsUdpPing(HttpRequest
*,
304 SQUIDCEXTERN
void neighborAddAcl(const char *, const char *);
306 SQUIDCEXTERN
void neighborsUdpAck(const cache_key
*, icp_common_t
*, const Ip::Address
&);
307 SQUIDCEXTERN
void neighborAdd(const char *, const char *, int, int, int, int, int);
308 SQUIDCEXTERN
void neighbors_init(void);
310 SQUIDCEXTERN
void neighborsHtcpClear(StoreEntry
*, const char *, HttpRequest
*, const HttpRequestMethod
&, htcp_clr_reason
);
312 SQUIDCEXTERN peer
*peerFindByName(const char *);
313 SQUIDCEXTERN peer
*peerFindByNameAndPort(const char *, unsigned short);
314 SQUIDCEXTERN peer
*getDefaultParent(HttpRequest
* request
);
315 SQUIDCEXTERN peer
*getRoundRobinParent(HttpRequest
* request
);
316 SQUIDCEXTERN peer
*getWeightedRoundRobinParent(HttpRequest
* request
);
317 SQUIDCEXTERN
void peerClearRRStart(void);
318 SQUIDCEXTERN
void peerClearRR(void);
319 SQUIDCEXTERN lookup_t
peerDigestLookup(peer
* p
, HttpRequest
* request
);
320 SQUIDCEXTERN peer
*neighborsDigestSelect(HttpRequest
* request
);
321 SQUIDCEXTERN
void peerNoteDigestLookup(HttpRequest
* request
, peer
* p
, lookup_t lookup
);
322 SQUIDCEXTERN
void peerNoteDigestGone(peer
* p
);
323 SQUIDCEXTERN
int neighborUp(const peer
* e
);
324 SQUIDCEXTERN CBDUNL peerDestroy
;
325 SQUIDCEXTERN
const char *neighborTypeStr(const peer
* e
);
326 SQUIDCEXTERN peer_t
neighborType(const peer
*, const HttpRequest
*);
327 SQUIDCEXTERN
void peerConnectFailed(peer
*);
328 SQUIDCEXTERN
void peerConnectSucceded(peer
*);
329 SQUIDCEXTERN
void dump_peer_options(StoreEntry
*, peer
*);
330 SQUIDCEXTERN
int peerHTTPOkay(const peer
*, HttpRequest
*);
332 SQUIDCEXTERN peer
*whichPeer(const Ip::Address
&from
);
336 SQUIDCEXTERN PeerDigest
*peerDigestCreate(peer
* p
);
337 SQUIDCEXTERN
void peerDigestNeeded(PeerDigest
* pd
);
338 SQUIDCEXTERN
void peerDigestNotePeerGone(PeerDigest
* pd
);
339 SQUIDCEXTERN
void peerDigestStatsReport(const PeerDigest
* pd
, StoreEntry
* e
);
341 #include "comm/forward.h"
342 extern void getOutgoingAddress(HttpRequest
* request
, Comm::ConnectionPointer conn
);
343 extern Ip::Address
getOutgoingAddr(HttpRequest
* request
, struct peer
*dst_peer
);
345 SQUIDCEXTERN
void urnStart(HttpRequest
*, StoreEntry
*);
347 SQUIDCEXTERN
void redirectInit(void);
348 SQUIDCEXTERN
void redirectShutdown(void);
350 extern void refreshAddToList(const char *, int, time_t, int, time_t);
351 extern int refreshIsCachable(const StoreEntry
*);
352 extern int refreshCheckHTTP(const StoreEntry
*, HttpRequest
*);
353 extern int refreshCheckICP(const StoreEntry
*, HttpRequest
*);
354 extern int refreshCheckHTCP(const StoreEntry
*, HttpRequest
*);
355 extern int refreshCheckDigest(const StoreEntry
*, time_t delta
);
356 extern time_t getMaxAge(const char *url
);
357 extern void refreshInit(void);
358 extern const refresh_t
*refreshLimits(const char *url
);
360 extern void shut_down(int);
361 extern void rotate_logs(int);
362 extern void reconfigure(int);
365 extern void start_announce(void *unused
);
366 extern void waisStart(FwdState
*);
368 SQUIDCEXTERN
void statInit(void);
369 SQUIDCEXTERN
void statFreeMemory(void);
370 SQUIDCEXTERN
double median_svc_get(int, int);
371 SQUIDCEXTERN
void pconnHistCount(int, int);
372 SQUIDCEXTERN
int stat5minClientRequests(void);
373 SQUIDCEXTERN
double stat5minCPUUsage(void);
374 SQUIDCEXTERN
double statRequestHitRatio(int minutes
);
375 SQUIDCEXTERN
double statRequestHitMemoryRatio(int minutes
);
376 SQUIDCEXTERN
double statRequestHitDiskRatio(int minutes
);
377 SQUIDCEXTERN
double statByteHitRatio(int minutes
);
380 SQUIDCEXTERN
void memClean(void);
381 SQUIDCEXTERN
void memInitModule(void);
382 SQUIDCEXTERN
void memCleanModule(void);
383 SQUIDCEXTERN
void memConfigure(void);
384 SQUIDCEXTERN
void *memAllocate(mem_type
);
385 SQUIDCEXTERN
void *memAllocString(size_t net_size
, size_t * gross_size
);
386 SQUIDCEXTERN
void *memAllocBuf(size_t net_size
, size_t * gross_size
);
387 SQUIDCEXTERN
void *memReallocBuf(void *buf
, size_t net_size
, size_t * gross_size
);
388 SQUIDCEXTERN
void memFree(void *, int type
);
389 void memFree2K(void *);
390 void memFree4K(void *);
391 void memFree8K(void *);
392 void memFree16K(void *);
393 void memFree32K(void *);
394 void memFree64K(void *);
395 SQUIDCEXTERN
void memFreeString(size_t size
, void *);
396 SQUIDCEXTERN
void memFreeBuf(size_t size
, void *);
397 SQUIDCEXTERN FREE
*memFreeBufFunc(size_t size
);
398 SQUIDCEXTERN
int memInUse(mem_type
);
399 SQUIDCEXTERN
void memDataInit(mem_type
, const char *, size_t, int, bool zeroOnPush
= true);
400 SQUIDCEXTERN
void memCheckInit(void);
404 SQUIDCEXTERN
void memConfigure(void);
406 /* ----------------------------------------------------------------- */
409 SQUIDCEXTERN
void storeReplSetup(void);
414 SQUIDCEXTERN
void storeLog(int tag
, const StoreEntry
* e
);
415 SQUIDCEXTERN
void storeLogRotate(void);
416 SQUIDCEXTERN
void storeLogClose(void);
417 SQUIDCEXTERN
void storeLogOpen(void);
423 SQUIDCEXTERN cache_key
*storeKeyDup(const cache_key
*);
424 SQUIDCEXTERN cache_key
*storeKeyCopy(cache_key
*, const cache_key
*);
425 SQUIDCEXTERN
void storeKeyFree(const cache_key
*);
426 SQUIDCEXTERN
const cache_key
*storeKeyScan(const char *);
427 SQUIDCEXTERN
const char *storeKeyText(const cache_key
*);
428 SQUIDCEXTERN
const cache_key
*storeKeyPublic(const char *, const HttpRequestMethod
&);
429 SQUIDCEXTERN
const cache_key
*storeKeyPublicByRequest(HttpRequest
*);
430 SQUIDCEXTERN
const cache_key
*storeKeyPublicByRequestMethod(HttpRequest
*, const HttpRequestMethod
&);
431 SQUIDCEXTERN
const cache_key
*storeKeyPrivate(const char *, const HttpRequestMethod
&, int);
432 SQUIDCEXTERN
int storeKeyHashBuckets(int);
433 SQUIDCEXTERN
int storeKeyNull(const cache_key
*);
434 SQUIDCEXTERN
void storeKeyInit(void);
435 SQUIDCEXTERN HASHHASH storeKeyHashHash
;
436 SQUIDCEXTERN HASHCMP storeKeyHashCmp
;
441 SQUIDCEXTERN
void storeDigestInit(void);
442 SQUIDCEXTERN
void storeDigestNoteStoreReady(void);
443 SQUIDCEXTERN
void storeDigestScheduleRebuild(void);
444 SQUIDCEXTERN
void storeDigestDel(const StoreEntry
* entry
);
445 extern void storeDigestReport(StoreEntry
*);
450 SQUIDCEXTERN
void storeRebuildStart(void);
452 SQUIDCEXTERN
void storeRebuildComplete(struct _store_rebuild_data
*);
453 SQUIDCEXTERN
void storeRebuildProgress(int sd_index
, int total
, int sofar
);
455 /// loads entry from disk; fills supplied memory buffer on success
456 bool storeRebuildLoadEntry(int fd
, int diskIndex
, MemBuf
&buf
, struct _store_rebuild_data
&counts
);
457 /// parses entry buffer and validates entry metadata; fills e on success
458 bool storeRebuildParseEntry(MemBuf
&buf
, StoreEntry
&e
, cache_key
*key
, struct _store_rebuild_data
&counts
, uint64_t expectedSize
);
459 /// checks whether the loaded entry should be kept; updates counters
460 bool storeRebuildKeepEntry(const StoreEntry
&e
, const cache_key
*key
, struct _store_rebuild_data
&counts
);
467 SQUIDCEXTERN
void storeSwapInStart(store_client
*);
472 SQUIDCEXTERN store_client
*storeClientListAdd(StoreEntry
* e
, void *data
);
473 SQUIDCEXTERN
int storeClientCopyPending(store_client
*, StoreEntry
* e
, void *data
);
474 SQUIDCEXTERN
int storeUnregister(store_client
* sc
, StoreEntry
* e
, void *data
)
476 SQUIDCEXTERN
int storePendingNClients(const StoreEntry
* e
);
477 SQUIDCEXTERN
int storeClientIsThisAClient(store_client
* sc
, void *someClient
);
480 SQUIDCEXTERN
const char *getMyHostname(void);
481 SQUIDCEXTERN
const char *uniqueHostname(void);
482 SQUIDCEXTERN
void safeunlink(const char *path
, int quiet
);
486 void sigusr2_handle(int sig
);
487 void sig_child(int sig
);
488 void sig_shutdown(int sig
); ///< handles shutdown notifications from kids
489 SQUIDCEXTERN
void leave_suid(void);
490 SQUIDCEXTERN
void enter_suid(void);
491 SQUIDCEXTERN
void no_suid(void);
492 SQUIDCEXTERN
void writePidFile(void);
493 SQUIDCEXTERN
void setSocketShutdownLifetimes(int);
494 SQUIDCEXTERN
void setMaxFD(void);
495 SQUIDCEXTERN
void setSystemLimits(void);
496 extern void squid_signal(int sig
, SIGHDLR
*, int flags
);
497 SQUIDCEXTERN pid_t
readPidFile(void);
498 SQUIDCEXTERN
void keepCapabilities(void);
499 SQUIDCEXTERN
void BroadcastSignalIfAny(int& sig
);
500 /// whether the current process is the parent of all other Squid processes
501 SQUIDCEXTERN
bool IamMasterProcess();
503 whether the current process is dedicated to doing things that only
504 a single process should do, such as PID file maintenance and WCCP
506 SQUIDCEXTERN
bool IamPrimaryProcess();
507 /// whether the current process coordinates worker processes
508 SQUIDCEXTERN
bool IamCoordinatorProcess();
509 /// whether the current process handles HTTP transactions and such
510 SQUIDCEXTERN
bool IamWorkerProcess();
511 /// whether the current process is dedicated to managing a cache_dir
512 bool IamDiskProcess();
513 /// Whether we are running in daemon mode
514 SQUIDCEXTERN
bool InDaemonMode(); // try using specific Iam*() checks above first
515 /// Whether there should be more than one worker process running
516 SQUIDCEXTERN
bool UsingSmp(); // try using specific Iam*() checks above first
517 /// number of Kid processes as defined in src/ipc/Kid.h
518 SQUIDCEXTERN
int NumberOfKids();
519 /// a string describing this process roles such as worker or coordinator
520 String
ProcessRoles();
521 SQUIDCEXTERN
int DebugSignal
;
523 /* AYJ debugs function to show locations being reset with memset() */
524 SQUIDCEXTERN
void *xmemset(void *dst
, int, size_t);
526 SQUIDCEXTERN
void debug_trap(const char *);
527 SQUIDCEXTERN
void logsFlush(void);
528 SQUIDCEXTERN
const char *checkNullString(const char *p
);
530 SQUIDCEXTERN
void squid_getrusage(struct rusage
*r
);
532 SQUIDCEXTERN
double rusage_cputime(struct rusage
*r
);
534 SQUIDCEXTERN
int rusage_maxrss(struct rusage
*r
);
536 SQUIDCEXTERN
int rusage_pagefaults(struct rusage
*r
);
537 SQUIDCEXTERN
void releaseServerSockets(void);
538 SQUIDCEXTERN
void PrintRusage(void);
539 SQUIDCEXTERN
void dumpMallocStats(void);
542 SQUIDCEXTERN
bool unlinkdNeeded(void);
543 SQUIDCEXTERN
void unlinkdInit(void);
544 SQUIDCEXTERN
void unlinkdClose(void);
545 SQUIDCEXTERN
void unlinkdUnlink(const char *);
548 SQUIDCEXTERN
AnyP::ProtocolType
urlParseProtocol(const char *, const char *e
= NULL
);
549 SQUIDCEXTERN
void urlInitialize(void);
550 SQUIDCEXTERN HttpRequest
*urlParse(const HttpRequestMethod
&, char *, HttpRequest
*request
= NULL
);
551 SQUIDCEXTERN
const char *urlCanonical(HttpRequest
*);
552 SQUIDCEXTERN
char *urlCanonicalClean(const HttpRequest
*);
553 SQUIDCEXTERN
const char *urlCanonicalFakeHttps(const HttpRequest
* request
);
554 SQUIDCEXTERN
bool urlIsRelative(const char *);
555 SQUIDCEXTERN
char *urlMakeAbsolute(const HttpRequest
*, const char *);
556 SQUIDCEXTERN
char *urlRInternal(const char *host
, unsigned short port
, const char *dir
, const char *name
);
557 SQUIDCEXTERN
char *urlInternal(const char *dir
, const char *name
);
558 SQUIDCEXTERN
int matchDomainName(const char *host
, const char *domain
);
559 SQUIDCEXTERN
int urlCheckRequest(const HttpRequest
*);
560 SQUIDCEXTERN
int urlDefaultPort(AnyP::ProtocolType p
);
561 SQUIDCEXTERN
char *urlHostname(const char *url
);
562 SQUIDCEXTERN
void urlExtMethodConfigure(void);
564 SQUIDCEXTERN peer_t
parseNeighborType(const char *s
);
567 //UNUSED #include "dlink.h"
568 //UNUSED SQUIDCEXTERN void dlinkAdd(void *data, dlink_node *, dlink_list *);
569 //UNUSED SQUIDCEXTERN void dlinkAddAfter(void *, dlink_node *, dlink_node *, dlink_list *);
570 //UNUSED SQUIDCEXTERN void dlinkAddTail(void *data, dlink_node *, dlink_list *);
571 //UNUSED SQUIDCEXTERN void dlinkDelete(dlink_node * m, dlink_list * list);
572 //UNUSED SQUIDCEXTERN void dlinkNodeDelete(dlink_node * m);
573 //UNUSED SQUIDCEXTERN dlink_node *dlinkNodeNew(void);
575 SQUIDCEXTERN
void kb_incr(kb_t
*, size_t);
576 SQUIDCEXTERN
int stringHasWhitespace(const char *);
577 SQUIDCEXTERN
int stringHasCntl(const char *);
578 SQUIDCEXTERN
void linklistPush(link_list
**, void *);
579 SQUIDCEXTERN
void *linklistShift(link_list
**);
580 SQUIDCEXTERN
int xrename(const char *from
, const char *to
);
581 SQUIDCEXTERN
int isPowTen(int);
582 SQUIDCEXTERN
void parseEtcHosts(void);
583 SQUIDCEXTERN
int getMyPort(void);
584 SQUIDCEXTERN
void setUmask(mode_t mask
);
586 SQUIDCEXTERN
char *strwordtok(char *buf
, char **t
);
587 SQUIDCEXTERN
void strwordquote(MemBuf
* mb
, const char *str
);
593 SQUIDCEXTERN pid_t
ipcCreate(int type
,
595 const char *const args
[],
597 Ip::Address
&local_addr
,
602 class CacheDigestGuessStats
;
604 SQUIDCEXTERN CacheDigest
*cacheDigestCreate(int capacity
, int bpe
);
605 SQUIDCEXTERN
void cacheDigestDestroy(CacheDigest
* cd
);
606 SQUIDCEXTERN CacheDigest
*cacheDigestClone(const CacheDigest
* cd
);
607 SQUIDCEXTERN
void cacheDigestClear(CacheDigest
* cd
);
608 SQUIDCEXTERN
void cacheDigestChangeCap(CacheDigest
* cd
, int new_cap
);
609 SQUIDCEXTERN
int cacheDigestTest(const CacheDigest
* cd
, const cache_key
* key
);
610 SQUIDCEXTERN
void cacheDigestAdd(CacheDigest
* cd
, const cache_key
* key
);
611 SQUIDCEXTERN
void cacheDigestDel(CacheDigest
* cd
, const cache_key
* key
);
612 SQUIDCEXTERN
size_t cacheDigestCalcMaskSize(int cap
, int bpe
);
613 SQUIDCEXTERN
int cacheDigestBitUtil(const CacheDigest
* cd
);
614 SQUIDCEXTERN
void cacheDigestGuessStatsUpdate(CacheDigestGuessStats
* stats
, int real_hit
, int guess_hit
);
615 SQUIDCEXTERN
void cacheDigestGuessStatsReport(const CacheDigestGuessStats
* stats
, StoreEntry
* sentry
, const char *label
);
616 SQUIDCEXTERN
void cacheDigestReport(CacheDigest
* cd
, const char *label
, StoreEntry
* e
);
618 SQUIDCEXTERN
void internalStart(const Comm::ConnectionPointer
&clientConn
, HttpRequest
*, StoreEntry
*);
619 SQUIDCEXTERN
int internalCheck(const char *urlpath
);
620 SQUIDCEXTERN
int internalStaticCheck(const char *urlpath
);
621 SQUIDCEXTERN
char *internalLocalUri(const char *dir
, const char *name
);
622 SQUIDCEXTERN
char *internalRemoteUri(const char *, unsigned short, const char *, const char *);
623 SQUIDCEXTERN
const char *internalHostname(void);
624 SQUIDCEXTERN
int internalHostnameIs(const char *);
626 SQUIDCEXTERN
void carpInit(void);
627 SQUIDCEXTERN peer
*carpSelectParent(HttpRequest
*);
629 SQUIDCEXTERN
void peerUserHashInit(void);
630 SQUIDCEXTERN peer
* peerUserHashSelectParent(HttpRequest
* request
);
632 SQUIDCEXTERN
void peerSourceHashInit(void);
633 SQUIDCEXTERN peer
* peerSourceHashSelectParent(HttpRequest
* request
);
636 SQUIDCEXTERN
void leakInit(void);
637 SQUIDCEXTERN
void *leakAddFL(void *, const char *, int);
638 SQUIDCEXTERN
void *leakTouchFL(void *, const char *, int);
639 SQUIDCEXTERN
void *leakFreeFL(void *, const char *, int);
643 * prototypes for system functions missing from system includes
648 SQUIDCEXTERN
int getrusage(int, struct rusage
*);
649 SQUIDCEXTERN
int getpagesize(void);
650 #if !defined(_XPG4_2) && !(defined(__EXTENSIONS__) || \
651 (!defined(_POSIX_C_SOURCE) && !defined(_XOPEN_SOURCE)))
652 SQUIDCEXTERN
int gethostname(char *, int);
657 * hack to allow snmp access to the statistics counters
660 SQUIDCEXTERN StatCounters
*snmpStatGet(int);
662 /* Vary support functions */
663 SQUIDCEXTERN
int varyEvaluateMatch(StoreEntry
* entry
, HttpRequest
* req
);
665 /* CygWin & Windows NT Port */
668 SQUIDCEXTERN
int WIN32_Subsystem_Init(int *, char ***);
669 SQUIDCEXTERN
void WIN32_sendSignal(int);
670 SQUIDCEXTERN
void WIN32_Abort(int);
671 SQUIDCEXTERN
void WIN32_Exit(void);
672 SQUIDCEXTERN
void WIN32_SetServiceCommandLine(void);
673 SQUIDCEXTERN
void WIN32_InstallService(void);
674 SQUIDCEXTERN
void WIN32_RemoveService(void);
675 SQUIDCEXTERN
int SquidMain(int, char **);
676 #endif /* _SQUID_WINDOWS_ */
679 SQUIDCEXTERN
int WIN32_pipe(int[2]);
681 SQUIDCEXTERN
int WIN32_getrusage(int, struct rusage
*);
682 SQUIDCEXTERN
void WIN32_ExceptionHandlerInit(void);
684 SQUIDCEXTERN
int Win32__WSAFDIsSet(int fd
, fd_set
* set
);
685 SQUIDCEXTERN DWORD
WIN32_IpAddrChangeMonitorInit();
691 SQUIDCEXTERN
void parse_externalAclHelper(external_acl
**);
693 SQUIDCEXTERN
void dump_externalAclHelper(StoreEntry
* sentry
, const char *name
, const external_acl
*);
695 SQUIDCEXTERN
void free_externalAclHelper(external_acl
**);
697 typedef void EAH(void *data
, void *result
);
699 SQUIDCEXTERN
void externalAclLookup(ACLChecklist
* ch
, void *acl_data
, EAH
* handler
, void *data
);
701 SQUIDCEXTERN
void externalAclInit(void);
703 SQUIDCEXTERN
void externalAclShutdown(void);
705 SQUIDCEXTERN
char *strtokFile(void);
709 SQUIDCEXTERN
void parse_wccp2_method(int *v
);
710 SQUIDCEXTERN
void free_wccp2_method(int *v
);
711 SQUIDCEXTERN
void dump_wccp2_method(StoreEntry
* e
, const char *label
, int v
);
712 SQUIDCEXTERN
void parse_wccp2_amethod(int *v
);
713 SQUIDCEXTERN
void free_wccp2_amethod(int *v
);
714 SQUIDCEXTERN
void dump_wccp2_amethod(StoreEntry
* e
, const char *label
, int v
);
716 SQUIDCEXTERN
void parse_wccp2_service(void *v
);
717 SQUIDCEXTERN
void free_wccp2_service(void *v
);
718 SQUIDCEXTERN
void dump_wccp2_service(StoreEntry
* e
, const char *label
, void *v
);
720 SQUIDCEXTERN
int check_null_wccp2_service(void *v
);
722 SQUIDCEXTERN
void parse_wccp2_service_info(void *v
);
724 SQUIDCEXTERN
void free_wccp2_service_info(void *v
);
726 SQUIDCEXTERN
void dump_wccp2_service_info(StoreEntry
* e
, const char *label
, void *v
);
732 #if HAVE_AUTH_MODULE_NEGOTIATE && HAVE_KRB5 && HAVE_GSSAPI
733 /* upstream proxy authentication */
734 SQUIDCEXTERN
char *peer_proxy_negotiate_auth(char *principal_name
, char *proxy
);
738 /* call to ensure the auth component schemes exist. */
739 extern void Init(void);
742 #endif /* USE_AUTH */
744 #endif /* SQUID_PROTOS_H */