src/defines.h

   1 /*
   2  * $Id$
   3  *
   4  *
   5  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   6  * ----------------------------------------------------------
   7  *
   8  *  Squid is the result of efforts by numerous individuals from
   9  *  the Internet community; see the CONTRIBUTORS file for full
  10  *  details.   Many organizations have provided support for Squid's
  11  *  development; see the SPONSORS file for full details.  Squid is
  12  *  Copyrighted (C) 2001 by the Regents of the University of
  13  *  California; see the COPYRIGHT file for full details.  Squid
  14  *  incorporates software developed and/or copyrighted by other
  15  *  sources; see the CREDITS file for full details.
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2 of the License, or
  20  *  (at your option) any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; if not, write to the Free Software
  29  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  30  *
  31  */
  32 #ifndef SQUID_DEFINES_H
  33 #define SQUID_DEFINES_H
  34
  35 #ifndef TRUE
  36 #define TRUE 1
  37 #endif
  38 #ifndef FALSE
  39 #define FALSE 0
  40 #endif
  41
  42 #ifndef BUFSIZ
  43 #define BUFSIZ  4096            /* make unreasonable guess */
  44 #endif
  45
  46 #define ACL_NAME_SZ 32
  47 #define BROWSERNAMELEN 128
  48
  49 #define ACL_SUNDAY      0x01
  50 #define ACL_MONDAY      0x02
  51 #define ACL_TUESDAY     0x04
  52 #define ACL_WEDNESDAY   0x08
  53 #define ACL_THURSDAY    0x10
  54 #define ACL_FRIDAY      0x20
  55 #define ACL_SATURDAY    0x40
  56 #define ACL_ALLWEEK     0x7F
  57 #define ACL_WEEKDAYS    0x3E
  58
  59 #define MAXHTTPPORTS                    128
  60
  61 /* Select types. */
  62 #define COMM_SELECT_READ   (0x1)
  63 #define COMM_SELECT_WRITE  (0x2)
  64
  65 #define COMM_NONBLOCKING        0x01
  66 #define COMM_NOCLOEXEC          0x02
  67 #define COMM_REUSEADDR          0x04
  68 #define COMM_TRANSPARENT        0x08
  69 #define COMM_DOBIND             0x10
  70
  71 #define DISK_OK                   (0)
  72 #define DISK_ERROR               (-1)
  73 #define DISK_EOF                 (-2)
  74 #define DISK_NO_SPACE_LEFT       (-6)
  75
  76 #define DNS_INBUF_SZ 4096
  77
  78 #define FD_DESC_SZ              64
  79
  80 #define FQDN_LOOKUP_IF_MISS     0x01
  81 #define FQDN_MAX_NAMES 5
  82
  83 #define HTTP_REPLY_FIELD_SZ 128
  84
  85 #define BUF_TYPE_8K     1
  86 #define BUF_TYPE_MALLOC 2
  87
  88 #define ANONYMIZER_NONE         0
  89 #define ANONYMIZER_STANDARD     1
  90 #define ANONYMIZER_PARANOID     2
  91
  92 #define USER_IDENT_SZ 64
  93 #define IDENT_NONE 0
  94 #define IDENT_PENDING 1
  95 #define IDENT_DONE 2
  96
  97 #define IP_LOOKUP_IF_MISS       0x01
  98
  99 #define MAX_MIME 4096
 100
 101 /* Mark a neighbor cache as dead if it doesn't answer this many pings */
 102 #define HIER_MAX_DEFICIT  20
 103
 104 #define ICP_FLAG_HIT_OBJ     0x80000000ul
 105 #define ICP_FLAG_SRC_RTT     0x40000000ul
 106
 107 /* Version */
 108 #define ICP_VERSION_2           2
 109 #define ICP_VERSION_3           3
 110 #define ICP_VERSION_CURRENT     ICP_VERSION_2
 111
 112 #define DIRECT_UNKNOWN 0
 113 #define DIRECT_NO    1
 114 #define DIRECT_MAYBE 2
 115 #define DIRECT_YES   3
 116
 117 #define REDIRECT_AV_FACTOR 1000
 118
 119 #define REDIRECT_NONE 0
 120 #define REDIRECT_PENDING 1
 121 #define REDIRECT_DONE 2
 122
 123 #define AUTHENTICATE_AV_FACTOR 1000
 124 /* AUTHENTICATION */
 125
 126 #define NTLM_CHALLENGE_SZ 300
 127
 128 #define  CONNECT_PORT        443
 129
 130 #define current_stacksize(stack) ((stack)->top - (stack)->base)
 131
 132 /* logfile status */
 133 #define LOG_ENABLE  1
 134 #define LOG_DISABLE 0
 135
 136 #define SM_PAGE_SIZE 4096
 137 #define MAX_CLIENT_BUF_SZ 4096
 138
 139 #define EBIT_SET(flag, bit)     ((void)((flag) |= ((1L<<(bit)))))
 140 #define EBIT_CLR(flag, bit)     ((void)((flag) &= ~((1L<<(bit)))))
 141 #define EBIT_TEST(flag, bit)    ((flag) & ((1L<<(bit))))
 142
 143 /* bit opearations on a char[] mask of unlimited length */
 144 #define CBIT_BIT(bit)           (1<<((bit)%8))
 145 #define CBIT_BIN(mask, bit)     (mask)[(bit)>>3]
 146 #define CBIT_SET(mask, bit)     ((void)(CBIT_BIN(mask, bit) |= CBIT_BIT(bit)))
 147 #define CBIT_CLR(mask, bit)     ((void)(CBIT_BIN(mask, bit) &= ~CBIT_BIT(bit)))
 148 #define CBIT_TEST(mask, bit)    (CBIT_BIN(mask, bit) & CBIT_BIT(bit))
 149
 150 #define MAX_FILES_PER_DIR (1<<20)
 151
 152 #define MAX_URL  8192
 153 #define MAX_LOGIN_SZ  128
 154
 155 #define PEER_MAX_ADDRESSES 10
 156 #define RTT_AV_FACTOR      50
 157 #define RTT_BACKGROUND_AV_FACTOR      25        /* Background pings need a smaller factor since they are sent less frequently */
 158
 159 #define PEER_DEAD 0
 160 #define PEER_ALIVE 1
 161
 162 #define AUTH_MSG_SZ 4096
 163 #define HTTP_REPLY_BUF_SZ 4096
 164 #define CLIENT_REQ_BUF_SZ 4096
 165
 166 #if !defined(ERROR_BUF_SZ) && defined(MAX_URL)
 167 #define ERROR_BUF_SZ (MAX_URL << 2)
 168 #endif
 169
 170 #if SQUID_SNMP
 171 #define VIEWINCLUDED    1
 172 #define VIEWEXCLUDED    2
 173 #endif
 174
 175 #define STORE_META_OK     0x03
 176 #define STORE_META_DIRTY  0x04
 177 #define STORE_META_BAD    0x05
 178
 179 #define IPC_NONE 0
 180 #define IPC_TCP_SOCKET 1
 181 #define IPC_UDP_SOCKET 2
 182 #define IPC_FIFO 3
 183 #define IPC_UNIX_STREAM 4
 184 #define IPC_UNIX_DGRAM 5
 185
 186 #if HAVE_SOCKETPAIR && defined (AF_UNIX)
 187 #define IPC_STREAM IPC_UNIX_STREAM
 188 #define IPC_DGRAM IPC_UNIX_DGRAM
 189 #else
 190 #define IPC_STREAM IPC_TCP_SOCKET
 191 #define IPC_DGRAM IPC_UDP_SOCKET
 192 #endif
 193
 194 #define STORE_META_KEY STORE_META_KEY_MD5
 195
 196 #define STORE_META_TLD_START sizeof(int)+sizeof(char)
 197 #define STORE_META_TLD_SIZE STORE_META_TLD_START
 198 #define SwapMetaType(x) (char)x[0]
 199 #define SwapMetaSize(x) &x[sizeof(char)]
 200 #define SwapMetaData(x) &x[STORE_META_TLD_START]
 201 #define STORE_HDR_METASIZE (4*sizeof(time_t)+2*sizeof(u_short)+sizeof(uint64_t))
 202 #define STORE_HDR_METASIZE_OLD (4*sizeof(time_t)+2*sizeof(u_short)+sizeof(size_t))
 203
 204 #define COUNT_INTERVAL 60
 205 /*
 206  * keep 60 minutes' worth of per-minute readings (+ current reading)
 207  */
 208 #define N_COUNT_HIST (3600 / COUNT_INTERVAL) + 1
 209 /*
 210  * keep 3 days' (72 hours) worth of hourly readings
 211  */
 212 #define N_COUNT_HOUR_HIST (86400 * 3) / (60 * COUNT_INTERVAL)
 213
 214 /* handy to determine the #elements in a static array */
 215 #define countof(arr) (sizeof(arr)/sizeof(*arr))
 216
 217 /*
 218  * Max number of ICP messages to receive per call to icpHandleUdp
 219  */
 220 #ifdef _SQUID_MSWIN_
 221 #define INCOMING_ICP_MAX 1
 222 #else
 223 #define INCOMING_ICP_MAX 15
 224 #endif
 225 /*
 226  * Max number of DNS messages to receive per call to DNS read handler
 227  */
 228 #ifdef _SQUID_MSWIN_
 229 #define INCOMING_DNS_MAX 1
 230 #else
 231 #define INCOMING_DNS_MAX 15
 232 #endif
 233 /*
 234  * Max number of HTTP connections to accept per call to httpAccept
 235  * and PER HTTP PORT
 236  */
 237 #ifdef _SQUID_MSWIN_
 238 #define INCOMING_HTTP_MAX 1
 239 #else
 240 #define INCOMING_HTTP_MAX 10
 241 #endif
 242 #define INCOMING_TOTAL_MAX (INCOMING_ICP_MAX+INCOMING_HTTP_MAX)
 243
 244 /*
 245  * This many TCP connections must FAIL before we mark the
 246  * peer as DEAD
 247  */
 248 #define PEER_TCP_MAGIC_COUNT 10
 249
 250 #define URI_WHITESPACE_STRIP 0
 251 #define URI_WHITESPACE_ALLOW 1
 252 #define URI_WHITESPACE_ENCODE 2
 253 #define URI_WHITESPACE_CHOP 3
 254 #define URI_WHITESPACE_DENY 4
 255
 256 #ifndef O_TEXT
 257 #define O_TEXT 0
 258 #endif
 259 #ifndef O_BINARY
 260 #define O_BINARY 0
 261 #endif
 262
 263 /*
 264  * Macro to find file access mode
 265  */
 266 #ifdef O_ACCMODE
 267 #define FILE_MODE(x) ((x)&O_ACCMODE)
 268 #else
 269 #define FILE_MODE(x) ((x)&(O_RDONLY|O_WRONLY|O_RDWR))
 270 #endif
 271
 272 #define HTTP_REQBUF_SZ  4096
 273
 274 /* CygWin & Windows NT Port */
 275 #if _SQUID_WINDOWS_
 276 #define _WIN_SQUID_SERVICE_CONTROL_STOP SERVICE_CONTROL_STOP
 277 #define _WIN_SQUID_SERVICE_CONTROL_SHUTDOWN SERVICE_CONTROL_SHUTDOWN
 278 #define _WIN_SQUID_SERVICE_CONTROL_INTERROGATE SERVICE_CONTROL_INTERROGATE
 279 #define _WIN_SQUID_SERVICE_CONTROL_ROTATE       128
 280 #define _WIN_SQUID_SERVICE_CONTROL_RECONFIGURE  129
 281 #define _WIN_SQUID_SERVICE_CONTROL_DEBUG        130
 282 #define _WIN_SQUID_SERVICE_CONTROL_INTERRUPT    131
 283 #define _WIN_SQUID_DEFAULT_SERVICE_NAME         "Squid"
 284 #define _WIN_SQUID_SERVICE_OPTION               "--ntservice"
 285 #define _WIN_SQUID_RUN_MODE_INTERACTIVE         0
 286 #define _WIN_SQUID_RUN_MODE_SERVICE             1
 287 #endif
 288
 289 #endif /* SQUID_DEFINES_H */