/* * $Id: util.h,v 1.78 2007/09/20 12:32:50 amosjeffries Exp $ * * AUTHOR: Harvest Derived * * 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_UTIL_H #define SQUID_UTIL_H #include "config.h" #if HAVE_STDIO_H #include #endif #if HAVE_TIME_H #include #endif #if HAVE_SYS_TIME_H #include #endif #if !defined(SQUIDHOSTNAMELEN) #define SQUIDHOSTNAMELEN 256 #endif #if defined(_SQUID_FREEBSD_) #define _etext etext #endif SQUIDCEXTERN const char *getfullhostname(void); SQUIDCEXTERN const char *mkhttpdlogtime(const time_t *); SQUIDCEXTERN const char *mkrfc1123(time_t); SQUIDCEXTERN char *uudecode(const char *); SQUIDCEXTERN char *xstrdup(const char *); SQUIDCEXTERN char *xstrndup(const char *, size_t); SQUIDCEXTERN const char *xstrerr(int xerrno); SQUIDCEXTERN const char *xstrerror(void); SQUIDCEXTERN int tvSubMsec(struct timeval, struct timeval); SQUIDCEXTERN int tvSubUsec(struct timeval, struct timeval); SQUIDCEXTERN double tvSubDsec(struct timeval, struct timeval); SQUIDCEXTERN char *xstrncpy(char *, const char *, size_t); SQUIDCEXTERN size_t xcountws(const char *str); SQUIDCEXTERN time_t parse_rfc1123(const char *str); SQUIDCEXTERN void *xcalloc(size_t, size_t); SQUIDCEXTERN void *xmalloc(size_t); SQUIDCEXTERN void *xrealloc(void *, size_t); SQUIDCEXTERN void Tolower(char *); SQUIDCEXTERN void xfree(void *); SQUIDCEXTERN void xxfree(const void *); #ifdef __cplusplus /* * Any code using libstdc++ must have externally resolvable overloads * for void * operator new - which means in the .o for the binary, * or in a shared library. static libs don't propogate the symbol * so, look in the translation unit containing main() in squid * for the extern version in squid */ #ifndef _SQUID_EXTERNNEW_ /* * SunPro CC handles extern inline as inline, PLUS extern symbols. */ #if _SQUID_SOLARIS_ && !defined(_SQUID_EXTERNNEW_) && defined(__SUNPRO_CC) #define _SQUID_EXTERNNEW_ extern #else #if _SQUID_SGI_ && !defined(_GNUC_) /* * The gcc compiler treats extern inline functions as being extern, * while the SGI MIPSpro compilers treat them as inline. To get equivalent * behavior, remove the inline keyword. */ #define _SQUID_EXTERNNEW_ extern #else #ifdef __GNUC_STDC_INLINE__ #define _SQUID_EXTERNNEW_ extern inline __attribute__((gnu_inline)) #else #define _SQUID_EXTERNNEW_ extern inline #endif #endif /* SGI */ #endif /* Solaris */ #endif /* _SQUID_EXTERNNEW_ */ #include "SquidNew.h" #endif /* rfc1738.c */ SQUIDCEXTERN char *rfc1738_escape(const char *); SQUIDCEXTERN char *rfc1738_escape_unescaped(const char *); SQUIDCEXTERN char *rfc1738_escape_part(const char *); SQUIDCEXTERN void rfc1738_unescape(char *); /* html.c */ SQUIDCEXTERN char *html_quote(const char *); #if XMALLOC_STATISTICS SQUIDCEXTERN void malloc_statistics(void (*)(int, int, int, void *), void *); #endif #if XMALLOC_TRACE #define xmalloc(size) (xmalloc_func="xmalloc",xmalloc_line=__LINE__,xmalloc_file=__FILE__,xmalloc(size)) #define xfree(ptr) (xmalloc_func="xfree",xmalloc_line=__LINE__,xmalloc_file=__FILE__,xfree(ptr)) #define xxfree(ptr) (xmalloc_func="xxfree",xmalloc_line=__LINE__,xmalloc_file=__FILE__,xxfree(ptr)) #define xrealloc(ptr,size) (xmalloc_func="xrealloc",xmalloc_line=__LINE__,xmalloc_file=__FILE__,xrealloc(ptr,size)) #define xcalloc(n,size) (xmalloc_func="xcalloc",xmalloc_line=__LINE__,xmalloc_file=__FILE__,xcalloc(n,size)) #define xstrdup(ptr) (xmalloc_func="xstrdup",xmalloc_line=__LINE__,xmalloc_file=__FILE__,xstrdup(ptr)) extern int xmalloc_line; extern char *xmalloc_file; extern char *xmalloc_func; extern int xmalloc_trace; extern size_t xmalloc_total; extern void xmalloc_find_leaks(void); #endif typedef struct IN_ADDR SIA; SQUIDCEXTERN int safe_inet_addr(const char *, SIA *); SQUIDCEXTERN time_t parse_iso3307_time(const char *buf); SQUIDCEXTERN char *base64_decode(const char *coded); SQUIDCEXTERN const char *base64_encode(const char *decoded); SQUIDCEXTERN const char *base64_encode_bin(const char *data, int len); SQUIDCEXTERN double xpercent(double part, double whole); SQUIDCEXTERN int xpercentInt(double part, double whole); SQUIDCEXTERN double xdiv(double nom, double denom); SQUIDCEXTERN const char *xitoa(int num); SQUIDCEXTERN const char *xint64toa(int64_t num); #if !HAVE_DRAND48 SQUIDCEXTERN double drand48(void); #endif typedef struct { size_t count; size_t bytes; size_t gb; } gb_t; /* gb_type operations */ #define gb_flush_limit (0x3FFFFFFF) #define gb_inc(gb, delta) { if ((gb)->bytes > gb_flush_limit || delta > gb_flush_limit) gb_flush(gb); (gb)->bytes += delta; (gb)->count++; } #define gb_incb(gb, delta) { if ((gb)->bytes > gb_flush_limit || delta > gb_flush_limit) gb_flush(gb); (gb)->bytes += delta; } #define gb_incc(gb, delta) { if ((gb)->bytes > gb_flush_limit || delta > gb_flush_limit) gb_flush(gb); (gb)->count+= delta; } extern double gb_to_double(const gb_t *); SQUIDCEXTERN const char *double_to_str(char *buf, int buf_size, double value); extern const char *gb_to_str(const gb_t *); extern void gb_flush(gb_t *); /* internal, do not use this */ /* * Returns the amount of known allocated memory */ int statMemoryAccounted(void); /* Windows Port */ /* win32lib.c */ #ifdef _SQUID_MSWIN_ SQUIDCEXTERN int chroot (const char *); SQUIDCEXTERN int ftruncate(int, off_t); #ifndef HAVE_GETTIMEOFDAY SQUIDCEXTERN int gettimeofday(struct timeval * ,void *); #endif SQUIDCEXTERN int kill(pid_t, int); SQUIDCEXTERN int statfs(const char *, struct statfs *); SQUIDCEXTERN int truncate(const char *, off_t); SQUIDCEXTERN const char * wsastrerror(int); SQUIDCEXTERN struct passwd *getpwnam(char *); SQUIDCEXTERN struct group *getgrnam(char *); SQUIDCEXTERN uid_t geteuid(void); SQUIDCEXTERN uid_t getuid(void); SQUIDCEXTERN int setuid(uid_t); SQUIDCEXTERN int seteuid(uid_t); SQUIDCEXTERN gid_t getgid(void); SQUIDCEXTERN gid_t getegid(void); SQUIDCEXTERN int setgid(gid_t); SQUIDCEXTERN int setegid(gid_t); SQUIDCEXTERN const char *WIN32_strerror(int); SQUIDCEXTERN void WIN32_maperror(unsigned long); #endif #endif /* SQUID_UTIL_H */