/* * $Id: squid.h,v 1.203.2.5 2001/02/22 21:39:14 wessels 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 #include "config.h" /* * On some systems, FD_SETSIZE is set to something lower than the * actual number of files which can be opened. IRIX is one case, * NetBSD is another. So here we increase FD_SETSIZE to our * configure-discovered maximum *before* any system includes. */ #define CHANGE_FD_SETSIZE 1 /* Cannot increase FD_SETSIZE on Linux */ #if defined(_SQUID_LINUX_) #undef CHANGE_FD_SETSIZE #define CHANGE_FD_SETSIZE 0 #endif /* * Cannot increase FD_SETSIZE on FreeBSD before 2.2.0, causes select(2) * to return EINVAL. * --Marian Durkovic * --Peter Wemm */ #if defined(_SQUID_FREEBSD_) #include #if __FreeBSD_version < 220000 #undef CHANGE_FD_SETSIZE #define CHANGE_FD_SETSIZE 0 #endif #endif /* * Trying to redefine CHANGE_FD_SETSIZE causes a slew of warnings * on Mac OS X Server. */ #if defined(_SQUID_APPLE_) #undef CHANGE_FD_SETSIZE #define CHANGE_FD_SETSIZE 0 #endif /* Increase FD_SETSIZE if SQUID_MAXFD is bigger */ #if CHANGE_FD_SETSIZE && SQUID_MAXFD > DEFAULT_FD_SETSIZE #define FD_SETSIZE SQUID_MAXFD #endif #if PURIFY #define assert(EX) ((void)0) #elif defined(NODEBUG) #define assert(EX) ((void)0) #elif STDC_HEADERS #define assert(EX) ((EX)?((void)0):xassert( # EX , __FILE__, __LINE__)) #else #define assert(EX) ((EX)?((void)0):xassert("EX", __FILE__, __LINE__)) #endif #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 && !defined(_SQUID_FREEBSD_) && !defined(_SQUID_NEXT_) #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_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 #ifdef HAVE_CRYPT_H #include #endif #if HAVE_SYS_SELECT_H #include #endif #if HAVE_GETOPT_H #include #endif #if HAVE_LIMITS_H #include #endif #if defined(_SQUID_CYGWIN_) #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 HAVE_POLL #if HAVE_POLL_H #include #else /* HAVE_POLL_H */ #undef HAVE_POLL #endif /* HAVE_POLL_H */ #endif /* HAVE_POLL */ #if STDC_HEADERS #include #else #include #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 #if !defined(MAXHOSTNAMELEN) || (MAXHOSTNAMELEN < 128) #define SQUIDHOSTNAMELEN 128 #else #define SQUIDHOSTNAMELEN MAXHOSTNAMELEN #endif #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 #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 PURIFY #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 CBDATA_DEBUG #define cbdataAdd(a,b,c) cbdataAddDbg(a,b,c,__FILE__,__LINE__) #define cbdataLock(a) cbdataLockDbg(a,__FILE__,__LINE__) #define cbdataUnlock(a) cbdataUnlockDbg(a,__FILE__,__LINE__) #endif #if USE_LEAKFINDER #define leakAdd(p) leakAddFL(p,__FILE__,__LINE__) #define leakTouch(p) leakTouchFL(p,__FILE__,__LINE__) #define leakFree(p) leakFreeFL(p,__FILE__,__LINE__) #else #define leakAdd(p) p #define leakTouch(p) p #define leakFree(p) p #endif #if defined(_SQUID_NEXT_) && !defined(S_ISDIR) #define S_ISDIR(mode) (((mode) & (_S_IFMT)) == (_S_IFDIR)) #endif #ifdef USE_GNUREGEX #include "GNUregex.h" #elif HAVE_REGEX_H #include #endif #include "md5.h" #include "Stack.h" /* Needed for poll() on Linux at least */ #if HAVE_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 "structs.h" #include "protos.h" #include "globals.h" #include "util.h" /* * Mac OS X Server already has radix.h as a standard header, so * this causes conflicts. */ #ifndef _SQUID_APPLE_ #include "radix.h" #endif #if !HAVE_TEMPNAM #include "tempnam.h" #endif #if !HAVE_SNPRINTF #include "snprintf.h" #endif #define XMIN(x,y) ((x)<(y)? (x) : (y)) #define XMAX(a,b) ((a)>(b)? (a) : (b)) /* * 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 #ifndef free #define free + #endif #ifndef calloc #define calloc + #endif #ifndef sprintf #define sprintf + #endif #ifndef strdup #define strdup + #endif /* * 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)]) #endif /* SQUID_H */