-
Notifications
You must be signed in to change notification settings - Fork 493
/
structs.h
executable file
·1412 lines (1191 loc) · 27 KB
/
structs.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* $Id: structs.h,v 1.575 2008/02/11 22:28:47 rousskov Exp $
*
*
* SQUID Web Proxy Cache http://www.squid-cache.org/
* ----------------------------------------------------------
*
* Squid is the result of efforts by numerous individuals from
* the Internet community; see the CONTRIBUTORS file for full
* details. Many organizations have provided support for Squid's
* development; see the SPONSORS file for full details. Squid is
* Copyrighted (C) 2001 by the Regents of the University of
* California; see the COPYRIGHT file for full details. Squid
* incorporates software developed and/or copyrighted by other
* sources; see the CREDITS file for full details.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
*
*/
#ifndef SQUID_STRUCTS_H
#define SQUID_STRUCTS_H
#include "config.h"
#include "RefCount.h"
#include "cbdata.h"
/* needed for various structures still in structs.h */
#include "dlink.h"
/* needed for the global config */
#include "HttpHeader.h"
struct acl_name_list
{
char name[ACL_NAME_SZ];
acl_name_list *next;
};
struct acl_deny_info_list
{
err_type err_page_id;
char *err_page_name;
acl_name_list *acl_list;
acl_deny_info_list *next;
};
class acl_access;
struct _header_mangler
{
acl_access *access_list;
char *replacement;
};
class ACLChecklist;
#if SQUID_SNMP
struct _snmp_request_t
{
u_char *buf;
u_char *outbuf;
int len;
int sock;
long reqid;
int outlen;
IPAddress from;
struct snmp_pdu *PDU;
ACLChecklist *acl_checklist;
u_char *community;
struct snmp_session session;
};
#endif
class ACLList;
struct acl_address
{
acl_address *next;
ACLList *aclList;
IPAddress addr;
};
struct acl_tos
{
acl_tos *next;
ACLList *aclList;
int tos;
};
struct acl_size_t
{
acl_size_t *next;
ACLList *aclList;
int64_t size;
};
struct ushortlist
{
u_short i;
ushortlist *next;
};
struct relist
{
char *pattern;
regex_t regex;
relist *next;
};
#if DELAY_POOLS
#include "DelayConfig.h"
#endif
#if USE_ICMP
#include "ICMPConfig.h"
#endif
/* forward decl for SquidConfig, see RemovalPolicy.h */
class RemovalPolicySettings;
class external_acl;
class Store;
struct SquidConfig
{
struct
{
/* These should be for the Store::Root instance.
* this needs pluggable parsing to be done smoothly.
*/
int highWaterMark;
int lowWaterMark;
} Swap;
size_t memMaxSize;
struct
{
int64_t min;
int pct;
int64_t max;
} quickAbort;
int64_t readAheadGap;
RemovalPolicySettings *replPolicy;
RemovalPolicySettings *memPolicy;
#if HTTP_VIOLATIONS
time_t negativeTtl;
#endif
time_t negativeDnsTtl;
time_t positiveDnsTtl;
time_t shutdownLifetime;
time_t backgroundPingRate;
struct
{
time_t read;
time_t lifetime;
time_t connect;
time_t forward;
time_t peer_connect;
time_t request;
time_t persistent_request;
time_t pconn;
time_t siteSelect;
time_t deadPeer;
int icp_query; /* msec */
int icp_query_max; /* msec */
int icp_query_min; /* msec */
int mcast_icp_query; /* msec */
#if USE_IDENT
time_t ident;
#endif
#if !USE_DNSSERVERS
time_t idns_retransmit;
time_t idns_query;
#endif
} Timeout;
size_t maxRequestHeaderSize;
int64_t maxRequestBodySize;
size_t maxReplyHeaderSize;
acl_size_t *ReplyBodySize;
struct
{
u_short icp;
#if USE_HTCP
u_short htcp;
#endif
#if SQUID_SNMP
u_short snmp;
#endif
} Port;
struct
{
http_port_list *http;
#if USE_SSL
https_port_list *https;
#endif
} Sockaddr;
#if SQUID_SNMP
struct
{
char *configFile;
char *agentInfo;
} Snmp;
#endif
#if USE_WCCP
struct
{
IPAddress router;
IPAddress address;
int version;
} Wccp;
#endif
#if USE_WCCPv2
struct
{
IPAddress_list *router;
IPAddress address;
int forwarding_method;
int return_method;
int assignment_method;
int weight;
int rebuildwait;
void *info;
} Wccp2;
#endif
#if USE_ICMP
ICMPConfig pinger;
#endif
char *as_whois_server;
struct
{
char *log;
char *store;
char *swap;
#if USE_USERAGENT_LOG
char *useragent;
#endif
#if USE_REFERER_LOG
char *referer;
#endif
#if WIP_FWD_LOG
char *forward;
#endif
logformat *logformats;
customlog *accesslogs;
int rotateNumber;
} Log;
char *adminEmail;
char *EmailFrom;
char *EmailProgram;
char *effectiveUser;
char *visible_appname_string;
char *effectiveGroup;
struct
{
#if USE_DNSSERVERS
char *dnsserver;
#endif
wordlist *redirect;
#if USE_UNLINKD
char *unlinkd;
#endif
char *diskd;
#if USE_SSL
char *ssl_password;
#endif
} Program;
#if USE_DNSSERVERS
int dnsChildren;
#endif
int redirectChildren;
int redirectConcurrency;
time_t authenticateGCInterval;
time_t authenticateTTL;
time_t authenticateIpTTL;
struct
{
#if USE_SQUID_ESI
char *surrogate_id;
#endif
} Accel;
char *appendDomain;
size_t appendDomainLen;
char *debugOptions;
char *pidFilename;
char *netdbFilename;
char *mimeTablePathname;
char *etcHostsPath;
char *visibleHostname;
char *uniqueHostname;
wordlist *hostnameAliases;
char *errHtmlText;
struct
{
char *host;
char *file;
time_t period;
u_short port;
} Announce;
struct
{
IPAddress udp_incoming;
IPAddress udp_outgoing;
#if SQUID_SNMP
IPAddress snmp_incoming;
IPAddress snmp_outgoing;
#endif
/* FIXME INET6 : this should really be a CIDR value */
IPAddress client_netmask;
} Addrs;
size_t tcpRcvBufsz;
size_t udpMaxHitObjsz;
wordlist *hierarchy_stoplist;
wordlist *mcast_group_list;
wordlist *dns_testname_list;
wordlist *dns_nameservers;
peer *peers;
int npeers;
struct
{
int size;
int low;
int high;
} ipcache;
struct
{
int size;
} fqdncache;
int minDirectHops;
int minDirectRtt;
cachemgr_passwd *passwd_list;
struct
{
int objectsPerBucket;
int64_t avgObjectSize;
int64_t maxObjectSize;
int64_t minObjectSize;
size_t maxInMemObjSize;
} Store;
struct
{
int high;
int low;
time_t period;
} Netdb;
struct
{
int log_udp;
int res_defnames;
int anonymizer;
int client_db;
int query_icmp;
int icp_hit_stale;
int buffered_logs;
int common_log;
int log_mime_hdrs;
int log_fqdn;
int announce;
int mem_pools;
int test_reachability;
int half_closed_clients;
int refresh_all_ims;
#if HTTP_VIOLATIONS
int reload_into_ims;
#endif
int offline;
int redir_rewrites_host;
int prefer_direct;
int nonhierarchical_direct;
int strip_query_terms;
int redirector_bypass;
int ignore_unknown_nameservers;
int client_pconns;
int server_pconns;
int error_pconns;
#if USE_CACHE_DIGESTS
int digest_generation;
#endif
int log_ip_on_direct;
int ie_refresh;
int vary_ignore_expire;
int pipeline_prefetch;
#if USE_SQUID_ESI
int surrogate_is_remote;
#endif
int request_entities;
int detect_broken_server_pconns;
int balance_on_multiple_ip;
int relaxed_header_parser;
int check_hostnames;
int allow_underscore;
int via;
int emailErrData;
int httpd_suppress_version_string;
int global_internal_static;
int dns_require_A;
int debug_override_X;
#if FOLLOW_X_FORWARDED_FOR
int acl_uses_indirect_client;
int delay_pool_uses_indirect_client;
int log_uses_indirect_client;
#endif /* FOLLOW_X_FORWARDED_FOR */
#if USE_ZPH_QOS
int zph_tos_parent;
int zph_preserve_miss_tos;
#endif
int WIN32_IpAddrChangeMonitor;
} onoff;
class ACL *aclList;
struct
{
acl_access *http;
acl_access *icp;
acl_access *miss;
acl_access *NeverDirect;
acl_access *AlwaysDirect;
acl_access *ASlists;
acl_access *noCache;
acl_access *log;
#if SQUID_SNMP
acl_access *snmp;
#endif
acl_access *brokenPosts;
#if USE_IDENT
acl_access *identLookup;
#endif
acl_access *redirector;
acl_access *reply;
acl_address *outgoing_address;
acl_tos *outgoing_tos;
acl_tos *clientside_tos;
#if USE_HTCP
acl_access *htcp;
acl_access *htcp_clr;
#endif
#if USE_SSL
acl_access *ssl_bump;
#endif
#if FOLLOW_X_FORWARDED_FOR
acl_access *followXFF;
#endif /* FOLLOW_X_FORWARDED_FOR */
} accessList;
acl_deny_info_list *denyInfoList;
authConfig authConfiguration;
struct
{
size_t list_width;
int list_wrap;
char *anon_user;
int passive;
int epsv_all;
int sanitycheck;
int telnet;
} Ftp;
refresh_t *Refresh;
struct _cacheSwap
{
RefCount<class Store> *swapDirs;
int n_allocated;
int n_configured;
} cacheSwap;
struct
{
char *directory;
int use_short_names;
} icons;
char *errorDirectory;
struct
{
int maxtries;
int onerror;
} retry;
struct
{
size_t limit;
} MemPools;
#if DELAY_POOLS
DelayConfig Delay;
#endif
struct
{
int icp_average;
int dns_average;
int http_average;
int icp_min_poll;
int dns_min_poll;
int http_min_poll;
} comm_incoming;
int max_open_disk_fds;
int uri_whitespace;
int64_t rangeOffsetLimit;
#if MULTICAST_MISS_STREAM
struct
{
IPAddress addr;
int ttl;
unsigned short port;
char *encode_key;
} mcast_miss;
#endif
/* one access list per header type we know of */
header_mangler request_header_access[HDR_ENUM_END];
/* one access list per header type we know of */
header_mangler reply_header_access[HDR_ENUM_END];
char *coredump_dir;
char *chroot_dir;
#if USE_CACHE_DIGESTS
struct
{
int bits_per_entry;
time_t rebuild_period;
time_t rewrite_period;
size_t swapout_chunk_size;
int rebuild_chunk_percentage;
} digest;
#endif
#if USE_SSL
struct
{
int unclean_shutdown;
char *ssl_engine;
} SSL;
#endif
wordlist *ext_methods;
struct
{
int high_rptm;
int high_pf;
size_t high_memory;
} warnings;
char *store_dir_select_algorithm;
int sleep_after_fork; /* microseconds */
time_t minimum_expiry_time; /* seconds */
external_acl *externalAclHelperList;
#if USE_ZPH_QOS
int zph_tos_local;
int zph_tos_peer;
int zph_preserve_miss_tos_mask;
#endif
#if USE_SSL
struct
{
char *cert;
char *key;
int version;
char *options;
char *cipher;
char *cafile;
char *capath;
char *crlfile;
char *flags;
acl_access *cert_error;
SSL_CTX *sslContext;
} ssl_client;
#endif
char *accept_filter;
int umask;
#if USE_LOADABLE_MODULES
wordlist *loadable_module_names;
#endif
};
SQUIDCEXTERN SquidConfig Config;
struct SquidConfig2
{
struct
{
int enable_purge;
int mangle_request_headers;
} onoff;
uid_t effectiveUserID;
gid_t effectiveGroupID;
};
SQUIDCEXTERN SquidConfig2 Config2;
struct _close_handler
{
PF *handler;
void *data;
close_handler *next;
};
struct _dread_ctrl
{
int fd;
off_t offset;
int req_len;
char *buf;
int end_of_file;
DRCB *handler;
void *client_data;
};
struct _dwrite_q
{
off_t file_offset;
char *buf;
size_t len;
size_t buf_offset;
dwrite_q *next;
FREE *free_func;
};
/* ETag support is rudimantal;
* this struct is likely to change
* Note: "str" points to memory in HttpHeaderEntry (for now)
* so ETags should be used as tmp variables only (for now) */
struct _ETag
{
const char *str; /* quoted-string */
int weak; /* true if it is a weak validator */
};
struct _fde_disk
{
DWCB *wrt_handle;
void *wrt_handle_data;
dwrite_q *write_q;
dwrite_q *write_q_tail;
off_t offset;
};
struct _fileMap
{
int max_n_files;
int n_files_in_map;
int toggle;
int nwords;
unsigned long *file_map;
};
/*
* Note: HttpBody is used only for messages with a small content that is
* known a priory (e.g., error messages).
*/
class MemBuf;
struct _HttpBody
{
/* private */
MemBuf *mb;
};
#include "SquidString.h"
/* http header extention field */
class HttpHdrExtField
{
String name; /* field-name from HTTP/1.1 (no column after name) */
String value; /* field-value from HTTP/1.1 */
};
/* http cache control header field */
class HttpHdrCc
{
public:
int mask;
int max_age;
int s_maxage;
int max_stale;
String other;
};
/* some fields can hold either time or etag specs (e.g. If-Range) */
struct _TimeOrTag
{
ETag tag; /* entity tag */
time_t time;
int valid; /* true if struct is usable */
};
/* per field statistics */
class HttpHeaderFieldStat
{
public:
HttpHeaderFieldStat() : aliveCount(0), seenCount(0), parsCount(0), errCount(0), repCount(0){}
int aliveCount; /* created but not destroyed (count) */
int seenCount; /* #fields we've seen */
int parsCount; /* #parsing attempts */
int errCount; /* #pasring errors */
int repCount; /* #repetitons */
};
/* compiled version of HttpHeaderFieldAttrs plus stats */
class HttpHeaderFieldInfo
{
public:
HttpHeaderFieldInfo() : id (HDR_ACCEPT), type (ftInvalid){}
http_hdr_type id;
String name;
field_type type;
HttpHeaderFieldStat stat;
};
struct _http_state_flags
{
unsigned int proxying:1;
unsigned int keepalive:1;
unsigned int only_if_cached:1;
unsigned int headers_parsed:1;
unsigned int front_end_https:2;
unsigned int originpeer:1;
unsigned int keepalive_broken:1;
unsigned int abuse_detected:1;
unsigned int request_sent:1;
unsigned int do_next_read:1;
unsigned int consume_body_data:1;
unsigned int chunked:1;
};
struct _ipcache_addrs
{
IPAddress *in_addrs;
unsigned char *bad_mask;
unsigned char count;
unsigned char cur;
unsigned char badcount;
};
struct _domain_ping
{
char *domain;
int do_ping; /* boolean */
domain_ping *next;
};
struct _domain_type
{
char *domain;
peer_t type;
domain_type *next;
};
#if USE_CACHE_DIGESTS
/* statistics for cache digests and other hit "predictors" */
struct _cd_guess_stats
{
/* public, read-only */
int true_hits;
int false_hits;
int true_misses;
int false_misses;
int close_hits; /* tmp, remove it later */
};
#endif
class PeerDigest;
struct peer
{
u_int index;
char *name;
char *host;
peer_t type;
IPAddress in_addr;
struct
{
int pings_sent;
int pings_acked;
int fetches;
int rtt;
int ignored_replies;
int n_keepalives_sent;
int n_keepalives_recv;
time_t probe_start;
time_t last_query;
time_t last_reply;
time_t last_connect_failure;
time_t last_connect_probe;
int logged_state; /* so we can print dead/revived msgs */
int conn_open; /* current opened connections */
} stats;
struct
{
int version;
int counts[ICP_END+1];
u_short port;
} icp;
#if USE_HTCP
struct
{
double version;
int counts[2];
u_short port;
} htcp;
#endif
u_short http_port;
domain_ping *peer_domain;
domain_type *typelist;
acl_access *access;
struct
{
unsigned int proxy_only:1;
unsigned int no_query:1;
unsigned int background_ping:1;
unsigned int no_digest:1;
unsigned int default_parent:1;
unsigned int roundrobin:1;
unsigned int weighted_roundrobin:1;
unsigned int mcast_responder:1;
unsigned int closest_only:1;
#if USE_HTCP
unsigned int htcp:1;
unsigned int htcp_oldsquid:1;
#endif
unsigned int no_netdb_exchange:1;
#if DELAY_POOLS
unsigned int no_delay:1;
#endif
unsigned int allow_miss:1;
unsigned int carp:1;
unsigned int originserver:1;
} options;
int weight;
int basetime;
struct
{
double avg_n_members;
int n_times_counted;
int n_replies_expected;
int ttl;
int id;
struct
{
unsigned int count_event_pending:1;
unsigned int counting:1;
} flags;
} mcast;
#if USE_CACHE_DIGESTS
PeerDigest *digest;
char *digest_url;
#endif
int tcp_up; /* 0 if a connect() fails */
IPAddress addresses[10];
int n_addresses;
int rr_count;
int rr_lastcount;
peer *next;
int test_fd;
struct
{
unsigned int hash;
double load_multiplier;
double load_factor; /* normalized weight value */
} carp;
char *login; /* Proxy authorization */
time_t connect_timeout;
int max_conn;
char *domain; /* Forced domain */
#if USE_SSL
int use_ssl;
char *sslcert;
char *sslkey;
int sslversion;
char *ssloptions;
char *sslcipher;
char *sslcafile;
char *sslcapath;
char *sslcrlfile;
char *sslflags;
char *ssldomain;
SSL_CTX *sslContext;
SSL_SESSION *sslSession;
#endif
int front_end_https;
};
struct _net_db_name
{