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_STRUCTS_H
30 #define SQUID_STRUCTS_H
36 /* needed for various structures still in structs.h */
38 /* needed for the global config */
39 #include "HttpHeader.h"
41 struct acl_name_list
{
42 char name
[ACL_NAME_SZ
];
46 struct acl_deny_info_list
{
49 acl_name_list
*acl_list
;
50 acl_deny_info_list
*next
;
56 struct _header_mangler
{
57 acl_access
*access_list
;
65 struct _snmp_request_t
{
76 ACLChecklist
*acl_checklist
;
79 struct snmp_session session
;
117 #include "DelayConfig.h"
121 #include "icmp/IcmpConfig.h"
125 #include "ip/QosConfig.h"
128 /* forward decl for SquidConfig, see RemovalPolicy.h */
130 class RemovalPolicySettings
;
137 /* These should be for the Store::Root instance.
138 * this needs pluggable parsing to be done smoothly.
150 int64_t readAheadGap
;
151 RemovalPolicySettings
*replPolicy
;
152 RemovalPolicySettings
*memPolicy
;
156 time_t negativeDnsTtl
;
157 time_t positiveDnsTtl
;
158 time_t shutdownLifetime
;
159 time_t backgroundPingRate
;
168 time_t persistent_request
;
172 int icp_query
; /* msec */
173 int icp_query_max
; /* msec */
174 int icp_query_min
; /* msec */
175 int mcast_icp_query
; /* msec */
179 time_t idns_retransmit
;
184 size_t maxRequestHeaderSize
;
185 int64_t maxRequestBodySize
;
186 size_t maxReplyHeaderSize
;
187 acl_size_t
*ReplyBodySize
;
202 http_port_list
*http
;
205 https_port_list
*https
;
229 IpAddress_list
*router
;
232 int forwarding_method
;
234 int assignment_method
;
245 char *as_whois_server
;
250 #if USE_USERAGENT_LOG
263 logformat
*logformats
;
265 customlog
*accesslogs
;
273 char *visible_appname_string
;
274 char *effectiveGroup
;
299 int redirectChildren
;
300 int redirectConcurrency
;
301 time_t authenticateGCInterval
;
302 time_t authenticateTTL
;
303 time_t authenticateIpTTL
;
312 size_t appendDomainLen
;
315 char *mimeTablePathname
;
317 char *visibleHostname
;
318 char *uniqueHostname
;
319 wordlist
*hostnameAliases
;
331 IpAddress udp_incoming
;
333 IpAddress udp_outgoing
;
336 IpAddress snmp_incoming
;
338 IpAddress snmp_outgoing
;
340 /* FIXME INET6 : this should really be a CIDR value */
341 IpAddress client_netmask
;
344 size_t udpMaxHitObjsz
;
345 wordlist
*hierarchy_stoplist
;
346 wordlist
*mcast_group_list
;
347 wordlist
*dns_nameservers
;
362 cachemgr_passwd
*passwd_list
;
365 int objectsPerBucket
;
366 int64_t avgObjectSize
;
367 int64_t maxObjectSize
;
368 int64_t minObjectSize
;
369 size_t maxInMemObjSize
;
391 int test_reachability
;
392 int half_closed_clients
;
400 int redir_rewrites_host
;
402 int nonhierarchical_direct
;
403 int strip_query_terms
;
404 int redirector_bypass
;
405 int ignore_unknown_nameservers
;
409 #if USE_CACHE_DIGESTS
411 int digest_generation
;
414 int log_ip_on_direct
;
416 int vary_ignore_expire
;
417 int pipeline_prefetch
;
420 int surrogate_is_remote
;
423 int request_entities
;
424 int detect_broken_server_pconns
;
425 int balance_on_multiple_ip
;
426 int relaxed_header_parser
;
428 int allow_underscore
;
431 int httpd_suppress_version_string
;
432 int global_internal_static
;
435 #if FOLLOW_X_FORWARDED_FOR
436 int acl_uses_indirect_client
;
437 int delay_pool_uses_indirect_client
;
438 int log_uses_indirect_client
;
439 #endif /* FOLLOW_X_FORWARDED_FOR */
441 int WIN32_IpAddrChangeMonitor
;
444 int forward_max_tries
;
452 acl_access
*NeverDirect
;
453 acl_access
*AlwaysDirect
;
462 acl_access
*brokenPosts
;
464 acl_access
*redirector
;
466 acl_address
*outgoing_address
;
467 acl_tos
*outgoing_tos
;
468 acl_tos
*clientside_tos
;
472 acl_access
*htcp_clr
;
476 acl_access
*ssl_bump
;
478 #if FOLLOW_X_FORWARDED_FOR
479 acl_access
*followXFF
;
480 #endif /* FOLLOW_X_FORWARDED_FOR */
483 acl_deny_info_list
*denyInfoList
;
484 authConfig authConfiguration
;
499 RefCount
<class Store
> *swapDirs
;
508 char *errorDirectory
;
510 char *errorDefaultLanguage
;
511 int errorLogMissingLanguages
;
513 char *errorStylesheet
;
536 int max_open_disk_fds
;
538 int64_t rangeOffsetLimit
;
539 #if MULTICAST_MISS_STREAM
550 /* one access list per header type we know of */
551 header_mangler request_header_access
[HDR_ENUM_END
];
552 /* one access list per header type we know of */
553 header_mangler reply_header_access
[HDR_ENUM_END
];
556 #if USE_CACHE_DIGESTS
560 time_t rebuild_period
;
561 time_t rewrite_period
;
562 size_t swapout_chunk_size
;
563 int rebuild_chunk_percentage
;
569 int unclean_shutdown
;
574 wordlist
*ext_methods
;
581 char *store_dir_select_algorithm
;
582 int sleep_after_fork
; /* microseconds */
583 time_t minimum_expiry_time
; /* seconds */
584 external_acl
*externalAclHelperList
;
602 acl_access
*cert_error
;
610 #if USE_LOADABLE_MODULES
611 wordlist
*loadable_module_names
;
615 SQUIDCEXTERN SquidConfig Config
;
617 struct SquidConfig2
{
620 int mangle_request_headers
;
622 uid_t effectiveUserID
;
623 gid_t effectiveGroupID
;
626 SQUIDCEXTERN SquidConfig2 Config2
;
628 struct _close_handler
{
654 /* ETag support is rudimantal;
655 * this struct is likely to change
656 * Note: "str" points to memory in HttpHeaderEntry (for now)
657 * so ETags should be used as tmp variables only (for now) */
660 const char *str
; /* quoted-string */
661 int weak
; /* true if it is a weak validator */
666 void *wrt_handle_data
;
668 dwrite_q
*write_q_tail
;
677 unsigned long *file_map
;
681 * Note: HttpBody is used only for messages with a small content that is
682 * known a priory (e.g., error messages).
692 #include "SquidString.h"
693 /* http header extention field */
695 class HttpHdrExtField
697 String name
; /* field-name from HTTP/1.1 (no column after name) */
698 String value
; /* field-value from HTTP/1.1 */
701 /* http cache control header field */
714 /* some fields can hold either time or etag specs (e.g. If-Range) */
717 ETag tag
; /* entity tag */
719 int valid
; /* true if struct is usable */
722 /* per field statistics */
724 class HttpHeaderFieldStat
728 HttpHeaderFieldStat() : aliveCount(0), seenCount(0), parsCount(0), errCount(0), repCount(0) {}
730 int aliveCount
; /* created but not destroyed (count) */
731 int seenCount
; /* #fields we've seen */
732 int parsCount
; /* #parsing attempts */
733 int errCount
; /* #pasring errors */
734 int repCount
; /* #repetitons */
737 /* compiled version of HttpHeaderFieldAttrs plus stats */
739 class HttpHeaderFieldInfo
743 HttpHeaderFieldInfo() : id (HDR_ACCEPT
), type (ftInvalid
) {}
748 HttpHeaderFieldStat stat
;
751 struct _http_state_flags
{
752 unsigned int proxying
:1;
753 unsigned int keepalive
:1;
754 unsigned int only_if_cached
:1;
755 unsigned int headers_parsed
:1;
756 unsigned int front_end_https
:2;
757 unsigned int originpeer
:1;
758 unsigned int keepalive_broken
:1;
759 unsigned int abuse_detected
:1;
760 unsigned int request_sent
:1;
761 unsigned int do_next_read
:1;
762 unsigned int consume_body_data
:1;
763 unsigned int chunked
:1;
766 struct _ipcache_addrs
{
768 unsigned char *bad_mask
;
771 unsigned char badcount
;
774 struct _domain_ping
{
776 int do_ping
; /* boolean */
780 struct _domain_type
{
786 #if USE_CACHE_DIGESTS
788 /* statistics for cache digests and other hit "predictors" */
790 struct _cd_guess_stats
{
791 /* public, read-only */
796 int close_hits
; /* tmp, remove it later */
817 int n_keepalives_sent
;
818 int n_keepalives_recv
;
822 time_t last_connect_failure
;
823 time_t last_connect_probe
;
824 int logged_state
; /* so we can print dead/revived msgs */
825 int conn_open
; /* current opened connections */
830 int counts
[ICP_END
+1];
843 domain_ping
*peer_domain
;
844 domain_type
*typelist
;
848 unsigned int proxy_only
:1;
849 unsigned int no_query
:1;
850 unsigned int background_ping
:1;
851 unsigned int no_digest
:1;
852 unsigned int default_parent
:1;
853 unsigned int roundrobin
:1;
854 unsigned int weighted_roundrobin
:1;
855 unsigned int mcast_responder
:1;
856 unsigned int closest_only
:1;
859 unsigned int htcp_oldsquid
:1;
860 unsigned int htcp_no_clr
:1;
861 unsigned int htcp_no_purge_clr
:1;
862 unsigned int htcp_only_clr
:1;
863 unsigned int htcp_forward_clr
:1;
865 unsigned int no_netdb_exchange
:1;
867 unsigned int no_delay
:1;
869 unsigned int allow_miss
:1;
871 unsigned int userhash
:1;
872 unsigned int sourcehash
:1;
873 unsigned int originserver
:1;
880 double avg_n_members
;
882 int n_replies_expected
;
887 unsigned int count_event_pending
:1;
888 unsigned int counting
:1;
891 #if USE_CACHE_DIGESTS
897 int tcp_up
; /* 0 if a connect() fails */
899 IpAddress addresses
[10];
907 double load_multiplier
;
908 double load_factor
; /* normalized weight value */
913 double load_multiplier
;
914 double load_factor
; /* normalized weight value */
919 double load_multiplier
;
920 double load_factor
; /* normalized weight value */
923 char *login
; /* Proxy authorization */
924 time_t connect_timeout
;
925 int connect_fail_limit
;
927 char *domain
; /* Forced domain */
942 SSL_SESSION
*sslSession
;
949 struct _net_db_name
{
950 hash_link hash
; /* must be first */
952 netdbEntry
*net_db_entry
;
955 struct _net_db_peer
{
956 const char *peername
;
963 hash_link hash
; /* must be first */
964 char network
[MAX_IPSTRLEN
];
969 time_t next_ping_time
;
970 time_t last_use_time
;
993 struct request_flags
{
994 request_flags(): range(0),nocache(0),ims(0),auth(0),cachable(0),hierarchical(0),loopdetect(0),proxy_keepalive(0),proxying(0),refresh(0),redirected(0),need_validation(0),accelerated(0),intercepted(0),spoof_client_ip(0),internal(0),internalclient(0),must_keepalive(0),destinationIPLookedUp_(0) {
998 #if FOLLOW_X_FORWARDED_FOR
999 done_follow_x_forwarded_for
= 0;
1000 #endif /* FOLLOW_X_FORWARDED_FOR */
1003 unsigned int range
:1;
1004 unsigned int nocache
:1;
1006 unsigned int auth
:1;
1007 unsigned int cachable
:1;
1008 unsigned int hierarchical
:1;
1009 unsigned int loopdetect
:1;
1010 unsigned int proxy_keepalive
:1;
1011 unsigned int proxying
:
1012 1; /* this should be killed, also in httpstateflags */
1013 unsigned int refresh
:1;
1014 unsigned int redirected
:1;
1015 unsigned int need_validation
:1;
1017 unsigned int nocache_hack
:1; /* for changing/ignoring no-cache requests */
1019 unsigned int accelerated
:1;
1020 unsigned int intercepted
:1; /**< transparently intercepted request */
1021 unsigned int spoof_client_ip
:1; /**< spoof client ip if possible */
1022 unsigned int internal
:1;
1023 unsigned int internalclient
:1;
1024 unsigned int must_keepalive
:1;
1025 unsigned int connection_auth
:1; /** Request wants connection oriented auth */
1026 unsigned int connection_auth_disabled
:1; /** Connection oriented auth can not be supported */
1027 unsigned int connection_proxy_auth
:1; /** Request wants connection oriented auth */
1028 unsigned int pinned
:1; /* Request sent on a pinned connection */
1029 unsigned int auth_sent
:1; /* Authentication forwarded */
1030 unsigned int no_direct
:1; /* Deny direct forwarding unless overriden by always_direct. Used in accelerator mode */
1032 // When adding new flags, please update cloneAdaptationImmune() as needed.
1034 bool resetTCP() const;
1036 void clearResetTCP();
1037 void destinationIPLookupCompleted();
1038 bool destinationIPLookedUp() const;
1040 // returns a partial copy of the flags that includes only those flags
1041 // that are safe for a related (e.g., ICAP-adapted) request to inherit
1042 request_flags
cloneAdaptationImmune() const;
1044 #if FOLLOW_X_FORWARDED_FOR
1045 unsigned int done_follow_x_forwarded_for
;
1046 #endif /* FOLLOW_X_FORWARDED_FOR */
1049 unsigned int reset_tcp
:1;
1050 unsigned int destinationIPLookedUp_
:1;
1056 struct _link_list
*next
;
1059 struct _cachemgr_passwd
{
1062 cachemgr_passwd
*next
;
1066 const char *pattern
;
1067 regex_t compiled_pattern
;
1074 unsigned int icase
:1;
1075 unsigned int refresh_ims
:1;
1077 unsigned int override_expire
:1;
1078 unsigned int override_lastmod
:1;
1079 unsigned int reload_into_ims
:1;
1080 unsigned int ignore_reload
:1;
1081 unsigned int ignore_no_cache
:1;
1082 unsigned int ignore_no_store
:1;
1083 unsigned int ignore_must_revalidate
:1;
1084 unsigned int ignore_private
:1;
1085 unsigned int ignore_auth
:1;
1091 * "very generic" histogram;
1092 * see important comments on hbase_f restrictions in StatHist.c
1101 hbase_f
*val_in
; /* e.g., log() for log-based histogram */
1102 hbase_f
*val_out
; /* e.g., exp() for log based histogram */
1106 * if you add a field to StatCounters,
1107 * you MUST sync statCountersInitSpecial, statCountersClean, and statCountersCopy
1110 struct _StatCounters
{
1121 kb_t hit_kbytes_out
;
1122 StatHist miss_svc_time
;
1123 StatHist nm_svc_time
;
1124 StatHist nh_svc_time
;
1125 StatHist hit_svc_time
;
1126 StatHist all_svc_time
;
1136 } all
, http
, ftp
, other
;
1149 int replies_dropped
;
1156 StatHist query_svc_time
;
1157 StatHist reply_svc_time
;
1182 #if USE_CACHE_DIGESTS
1184 cd_guess_stats guess
;
1187 StatHist on_xition_count
;
1194 unsigned long int select_loops
;
1199 struct timeval timestamp
;
1200 StatHist comm_icp_incoming
;
1201 StatHist comm_dns_incoming
;
1202 StatHist comm_http_incoming
;
1203 StatHist select_fds_hist
;
1228 int aborted_requests
;
1237 /* per header statistics */
1239 struct _HttpHeaderStat
{
1241 HttpHeaderMask
*owner_mask
;
1243 StatHist hdrUCountDistr
;
1244 StatHist fieldTypeDistr
;
1245 StatHist ccTypeDistr
;
1246 StatHist scTypeDistr
;
1252 int busyDestroyedCount
;
1256 struct _CacheDigest
{
1257 /* public, read-only */
1258 char *mask
; /* bit mask */
1259 int mask_size
; /* mask size in bytes */
1260 int capacity
; /* expected maximum for .count, not a hard limit */
1261 int bits_per_entry
; /* number of bits allocated for each entry from capacity */
1262 int count
; /* number of digested entries */
1263 int del_count
; /* number of deletions performed so far */
1267 struct _store_rebuild_data
{
1268 int objcount
; /* # objects successfully reloaded */
1269 int expcount
; /* # objects expired */
1270 int scancount
; /* # entries scanned or read from state file */
1271 int clashcount
; /* # swapfile clashes avoided */
1272 int dupcount
; /* # duplicates purged */
1273 int cancelcount
; /* # SWAP_LOG_DEL objects purged */
1274 int invalid
; /* # bad lines */
1275 int badflags
; /* # bad e->flags */
1282 char path
[MAXPATHLEN
];
1289 unsigned int syslog
;
1292 int syslog_priority
;
1295 class logformat_token
;
1299 logformat_token
*format
;
1306 logformat
*logFormat
;
1309 customlog_type type
;
1312 #endif /* SQUID_STRUCTS_H */