/* * $Id: squid.h,v 1.268 2007/12/04 13:31:11 hno Exp $ * * AUTHOR: Duane Wessels * * 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_H #define SQUID_H /* * On linux this must be defined to get PRId64 and friends */ #define __STDC_FORMAT_MACROS #include "config.h" #ifdef _SQUID_MSWIN_ using namespace Squid; #endif #include "assert.h" #if HAVE_UNISTD_H #include #endif #if HAVE_STDLIB_H #include #endif #if HAVE_STDIO_H #include #endif #if HAVE_SYS_TYPES_H #include #endif #if HAVE_CTYPE_H #include #endif #if HAVE_ERRNO_H #include #endif #if HAVE_FCNTL_H #include #endif #if HAVE_GRP_H #include #endif #if HAVE_GNUMALLOC_H #include #elif HAVE_MALLOC_H #include #endif #if HAVE_MEMORY_H #include #endif #if HAVE_NETDB_H && !defined(_SQUID_NETDB_H_) /* protect NEXTSTEP */ #define _SQUID_NETDB_H_ #ifdef _SQUID_NEXT_ #include #endif #include #endif #if HAVE_PATHS_H #include #endif #if HAVE_PWD_H #include #endif #if HAVE_SIGNAL_H #include #endif #if HAVE_TIME_H #include #endif #if HAVE_SYS_PARAM_H #include #endif #if HAVE_SYS_TIME_H #include #endif #if HAVE_SYS_RESOURCE_H #include /* needs sys/time.h above it */ #endif #if HAVE_SYS_SOCKET_H #include #endif #if HAVE_NETINET_IN_H #include #endif #if HAVE_ARPA_INET_H #include #endif #if HAVE_SYS_STAT_H #include #endif #if HAVE_SYS_UN_H #include #endif #if HAVE_SYS_WAIT_H #include #endif #if HAVE_LIBC_H #include #endif #ifdef HAVE_SYS_SYSCALL_H #include #endif #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_STRINGS_H #include #endif #if HAVE_BSTRING_H #include #endif #if HAVE_SYS_SELECT_H #include #endif #if HAVE_GETOPT_H #include #endif #if HAVE_LIMITS_H #include #endif #ifdef _SQUID_WIN32_ #include #endif #if HAVE_DIRENT_H #include #define NAMLEN(dirent) strlen((dirent)->d_name) #else /* HAVE_DIRENT_H */ #define dirent direct #define NAMLEN(dirent) (dirent)->d_namlen #if HAVE_SYS_NDIR_H #include #endif /* HAVE_SYS_NDIR_H */ #if HAVE_SYS_DIR_H #include #endif /* HAVE_SYS_DIR_H */ #if HAVE_NDIR_H #include #endif /* HAVE_NDIR_H */ #endif /* HAVE_DIRENT_H */ #if defined(__QNX__) #include #endif #if HAVE_SYS_MOUNT_H #include #endif /* * We require poll.h before using poll(). If the symbols used * by poll() are defined elsewhere, we will need to make this * a more sophisticated test. * -- Oskar Pearson * -- Stewart Forster */ #if USE_POLL #if HAVE_POLL_H #include #endif /* HAVE_POLL_H */ #endif /* USE_POLL */ /* * Filedescriptor limits in the different select loops * * NP: FreeBSD 7 defines FD_SETSIZE as unsigned but Squid needs * it to be signed to compare it with signed values. * Linux and others including FreeBSD <7, define it as signed. * If this causes any issues please contact squid-dev@squid-cache.org */ #if defined(USE_SELECT) || defined(USE_SELECT_WIN32) /* Limited by design */ # define SQUID_MAXFD_LIMIT ((signed int)FD_SETSIZE) #elif defined(USE_POLL) /* Limited due to delay pools */ # define SQUID_MAXFD_LIMIT ((signed int)FD_SETSIZE) #elif defined(USE_KQUEUE) || defined(USE_EPOLL) # define SQUID_FDSET_NOUSE 1 #else # error Unknown select loop model! #endif /* * Trap unintentional use of fd_set. Must not be used outside the * select code as it only supports FD_SETSIZE number of filedescriptors * and Squid may be running with a lot more.. * But only for code linked into Squid, not the helpers.. (unlinkd, pinger) */ #ifdef SQUID_FDSET_NOUSE # ifndef SQUID_HELPER # define fd_set ERROR_FD_SET_USED # endif #endif #if defined(HAVE_STDARG_H) #include #define HAVE_STDARGS /* let's hope that works everywhere (mj) */ #define VA_LOCAL_DECL va_list ap; #define VA_START(f) va_start(ap, f) #define VA_SHIFT(v,t) ; /* no-op for ANSI */ #define VA_END va_end(ap) #else #if defined(HAVE_VARARGS_H) #include #undef HAVE_STDARGS #define VA_LOCAL_DECL va_list ap; #define VA_START(f) va_start(ap) /* f is ignored! */ #define VA_SHIFT(v,t) v = va_arg(ap,t) #define VA_END va_end(ap) #else #error XX **NO VARARGS ** XX #endif #endif /* Make sure syslog goes after stdarg/varargs */ #ifdef HAVE_SYSLOG_H #ifdef _SQUID_AIX_ #define _XOPEN_EXTENDED_SOURCE #define _XOPEN_SOURCE_EXTENDED 1 #endif #include #endif #if HAVE_MATH_H #include #endif #define SQUIDHOSTNAMELEN 256 #define SQUID_MAXPATHLEN 256 #ifndef MAXPATHLEN #define MAXPATHLEN SQUID_MAXPATHLEN #endif #if !HAVE_GETRUSAGE #if defined(_SQUID_HPUX_) #define HAVE_GETRUSAGE 1 #define getrusage(a, b) syscall(SYS_GETRUSAGE, a, b) #endif #endif #if !HAVE_STRUCT_RUSAGE /* * If we don't have getrusage() then we create a fake structure * with only the fields Squid cares about. This just makes the * source code cleaner, so we don't need lots of #ifdefs in other * places */ struct rusage { struct timeval ru_stime; struct timeval ru_utime; int ru_maxrss; int ru_majflt; }; #endif #if !defined(HAVE_GETPAGESIZE) && defined(_SQUID_HPUX_) #define HAVE_GETPAGESIZE #define getpagesize( ) sysconf(_SC_PAGE_SIZE) #endif #if defined(_SQUID_MSWIN_) && !defined(getpagesize) /* Windows may lack getpagesize() prototype */ SQUIDCEXTERN size_t getpagesize(void); #endif /* _SQUID_MSWIN_ */ #ifndef BUFSIZ #define BUFSIZ 4096 /* make reasonable guess */ #endif #ifndef SA_RESTART #define SA_RESTART 0 #endif #ifndef SA_NODEFER #define SA_NODEFER 0 #endif #ifndef SA_RESETHAND #define SA_RESETHAND 0 #endif #if SA_RESETHAND == 0 && defined(SA_ONESHOT) #undef SA_RESETHAND #define SA_RESETHAND SA_ONESHOT #endif #if LEAK_CHECK_MODE #define LOCAL_ARRAY(type,name,size) \ static type *local_##name=NULL; \ type *name = local_##name ? local_##name : \ ( local_##name = (type *)xcalloc(size, sizeof(type)) ) #else #define LOCAL_ARRAY(type,name,size) static type name[size] #endif #if defined(_SQUID_NEXT_) && !defined(S_ISDIR) #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR)) #endif #ifdef USE_GNUREGEX #ifdef __cplusplus extern "C" { #endif #include "GNUregex.h" #ifdef __cplusplus } #endif #elif HAVE_REGEX_H #include #endif #include "md5.h" #if USE_SSL #include "ssl_support.h" #endif /* Needed for poll() on Linux at least */ #if USE_POLL #ifndef POLLRDNORM #define POLLRDNORM POLLIN #endif #ifndef POLLWRNORM #define POLLWRNORM POLLOUT #endif #endif #ifdef SQUID_SNMP #include "cache_snmp.h" #endif #include "hash.h" #include "rfc1035.h" #include "defines.h" #include "enums.h" #include "typedefs.h" #include "util.h" #include "profiling.h" #include "MemPool.h" #if !HAVE_TEMPNAM #include "tempnam.h" #endif #if !HAVE_STRSEP #include "strsep.h" #endif #if !HAVE_STRTOLL #include "strtoll.h" #endif #if !HAVE_INITGROUPS #include "initgroups.h" #endif #ifndef min template inline A const & min(A const & lhs, A const & rhs) { if (rhs < lhs) return rhs; return lhs; } #endif #define XMIN(x,y) (min (x,y)) #ifndef max template inline A const & max(A const & lhs, A const & rhs) { if (rhs > lhs) return rhs; return lhs; } #endif #define XMAX(a,b) (max (a,b)) #include "structs.h" #include "protos.h" #include "globals.h" /* Exclude CPPUnit tests from the below restriction. */ /* BSD implementation uses these still */ #if !defined(SQUID_UNIT_TEST) /* * Squid source files should not call these functions directly. * Use xmalloc, xfree, xcalloc, snprintf, and xstrdup instead. * Also use xmemcpy, xisspace, ... */ #ifndef malloc #define malloc + #endif template void free(V x) { fatal("Do not use ::free()"); } #ifndef calloc #define calloc + #endif #ifndef sprintf #define sprintf + #endif #ifndef strdup #define strdup + #endif #endif /* !SQUID_UNIT_TEST */ /* * Hey dummy, don't be tempted to move this to lib/config.h.in * again. O_NONBLOCK will not be defined there because you didn't * #include yet. */ #if defined(_SQUID_SUNOS_) /* * We assume O_NONBLOCK is broken, or does not exist, on SunOS. */ #define SQUID_NONBLOCK O_NDELAY #elif defined(O_NONBLOCK) /* * We used to assume O_NONBLOCK was broken on Solaris, but evidence * now indicates that its fine on Solaris 8, and in fact required for * properly detecting EOF on FIFOs. So now we assume that if * its defined, it works correctly on all operating systems. */ #define SQUID_NONBLOCK O_NONBLOCK /* * O_NDELAY is our fallback. */ #else #define SQUID_NONBLOCK O_NDELAY #endif /* * I'm sick of having to keep doing this .. */ #define INDEXSD(i) (Config.cacheSwap.swapDirs[(i)].getRaw()) #define FD_READ_METHOD(fd, buf, len) (*fd_table[fd].read_method)(fd, buf, len) #define FD_WRITE_METHOD(fd, buf, len) (*fd_table[fd].write_method)(fd, buf, len) #ifndef IPPROTO_UDP #define IPPROTO_UDP 0 #endif #ifndef IPPROTO_TCP #define IPPROTO_TCP 0 #endif #endif /* SQUID_H */