include/util.h

   1 /*
   2  * AUTHOR: Harvest Derived
   3  *
   4  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   5  * ----------------------------------------------------------
   6  *
   7  *  Squid is the result of efforts by numerous individuals from
   8  *  the Internet community; see the CONTRIBUTORS file for full
   9  *  details.   Many organizations have provided support for Squid's
  10  *  development; see the SPONSORS file for full details.  Squid is
  11  *  Copyrighted (C) 2001 by the Regents of the University of
  12  *  California; see the COPYRIGHT file for full details.  Squid
  13  *  incorporates software developed and/or copyrighted by other
  14  *  sources; see the CREDITS file for full details.
  15  *
  16  *  This program is free software; you can redistribute it and/or modify
  17  *  it under the terms of the GNU General Public License as published by
  18  *  the Free Software Foundation; either version 2 of the License, or
  19  *  (at your option) any later version.
  20  *
  21  *  This program is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  *  GNU General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU General Public License
  27  *  along with this program; if not, write to the Free Software
  28  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  29  *
  30  */
  31
  32 #ifndef SQUID_UTIL_H
  33 #define SQUID_UTIL_H
  34
  35 #if HAVE_TIME_H
  36 #include <time.h>
  37 #endif
  38 #if HAVE_ARPA_INET_H
  39 #include <arpa/inet.h>
  40 #endif
  41
  42 SQUIDCEXTERN int tvSubUsec(struct timeval, struct timeval);
  43 SQUIDCEXTERN double tvSubDsec(struct timeval, struct timeval);
  44 SQUIDCEXTERN void Tolower(char *);
  45 #if defined(__cplusplus)
  46 /*
  47  * Any code using libstdc++ must have externally resolvable overloads
  48  * for void * operator new - which means in the .o for the binary,
  49  * or in a shared library. static libs don't propogate the symbol
  50  * so, look in the translation unit containing main() in squid
  51  * for the extern version in squid
  52  */
  53 #if !defined(_SQUID_EXTERNNEW_)
  54 #if defined(__GNUC_STDC_INLINE__) || defined(__GNUC_GNU_INLINE__)
  55 #define _SQUID_EXTERNNEW_ extern inline __attribute__((gnu_inline))
  56 #else
  57 #define _SQUID_EXTERNNEW_ extern inline
  58 #endif
  59 #endif
  60 #include "SquidNew.h"
  61 #endif
  62
  63 SQUIDCEXTERN time_t parse_iso3307_time(const char *buf);
  64
  65 SQUIDCEXTERN double xpercent(double part, double whole);
  66 SQUIDCEXTERN int xpercentInt(double part, double whole);
  67 SQUIDCEXTERN double xdiv(double nom, double denom);
  68
  69 SQUIDCEXTERN const char *xitoa(int num);
  70 SQUIDCEXTERN const char *xint64toa(int64_t num);
  71
  72 typedef struct {
  73     size_t count;
  74     size_t bytes;
  75     size_t gb;
  76 } gb_t;
  77
  78 /* gb_type operations */
  79 #define gb_flush_limit (0x3FFFFFFF)
  80 #define gb_inc(gb, delta) { if ((gb)->bytes > gb_flush_limit || delta > gb_flush_limit) gb_flush(gb); (gb)->bytes += delta; (gb)->count++; }
  81 #define gb_incb(gb, delta) { if ((gb)->bytes > gb_flush_limit || delta > gb_flush_limit) gb_flush(gb); (gb)->bytes += delta; }
  82 #define gb_incc(gb, delta) { if ((gb)->bytes > gb_flush_limit || delta > gb_flush_limit) gb_flush(gb); (gb)->count+= delta; }
  83 extern double gb_to_double(const gb_t *);
  84 SQUIDCEXTERN const char *double_to_str(char *buf, int buf_size, double value);
  85 extern const char *gb_to_str(const gb_t *);
  86 extern void gb_flush(gb_t *);  /* internal, do not use this */
  87
  88 /*
  89  * Returns the amount of known allocated memory
  90  */
  91 int statMemoryAccounted(void);
  92
  93 SQUIDCEXTERN unsigned int RoundTo(const unsigned int num, const unsigned int what);
  94
  95 #endif /* SQUID_UTIL_H */