source/lib/util/util.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Utility functions for Samba
   4    Copyright (C) Andrew Tridgell 1992-1999
   5    Copyright (C) John H Terpstra 1996-1999
   6    Copyright (C) Luke Kenneth Casson Leighton 1996-1999
   7    Copyright (C) Paul Ashton 1998 - 1999
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 #ifndef _SAMBA_UTIL_H_
  25 #define _SAMBA_UTIL_H_
  26
  27 /**
  28  * @file
  29  * @brief Helpful macros
  30  */
  31
  32 struct substitute_context;
  33
  34 #include "util/xfile.h"
  35 #include "util/debug.h"
  36 #include "util/mutex.h"
  37 #include "util/byteorder.h"
  38 #include "util/util_proto.h"
  39
  40 /**
  41  * zero a structure
  42  */
  43 #define ZERO_STRUCT(x) memset((char *)&(x), 0, sizeof(x))
  44
  45 /**
  46  * zero a structure given a pointer to the structure
  47  */
  48 #define ZERO_STRUCTP(x) do { if ((x) != NULL) memset((char *)(x), 0, sizeof(*(x))); } while(0)
  49
  50 /**
  51  * zero a structure given a pointer to the structure - no zero check
  52  */
  53 #define ZERO_STRUCTPN(x) memset((char *)(x), 0, sizeof(*(x)))
  54
  55 /**
  56  * pointer difference macro
  57  */
  58 #define PTR_DIFF(p1,p2) ((ptrdiff_t)(((const char *)(p1)) - (const char *)(p2)))
  59
  60 /**
  61  * work out how many elements there are in a static array
  62  */
  63 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(a[0]))
  64
  65 /**
  66  * assert macros
  67  */
  68 #define SMB_ASSERT(b) do { if (!(b)) { \
  69         DEBUG(0,("PANIC: assert failed at %s(%d)\n", __FILE__, __LINE__)); \
  70         smb_panic("assert failed"); }} while (0)
  71
  72 /**
  73  * determine the lowest of two values
  74  */
  75 #ifndef MIN
  76 #define MIN(a,b) ((a)<(b)?(a):(b))
  77 #endif
  78
  79 /**
  80  * determine the highest of two values
  81  */
  82 #ifndef MAX
  83 #define MAX(a,b) ((a)>(b)?(a):(b))
  84 #endif
  85
  86 /**
  87  * determine absolute value
  88  */
  89 #ifndef ABS
  90 #define ABS(a) ((a)>0?(a):(-(a)))
  91 #endif
  92
  93 #ifndef SAFE_FREE /* Oh no this is also defined in tdb.h */
  94 /**
  95  * Free memory if the pointer and zero the pointer.
  96  *
  97  * @note You are explicitly allowed to pass NULL pointers -- they will
  98  * always be ignored.
  99  **/
 100 #define SAFE_FREE(x) do { if ((x) != NULL) {free(discard_const_p(void *, (x))); (x)=NULL;} } while(0)
 101 #endif
 102
 103 /**
 104  * Type-safe version of malloc. Allocated one copy of the
 105  * specified data type.
 106  */
 107 #define malloc_p(type) (type *)malloc(sizeof(type))
 108
 109 /**
 110  * Allocate an array of elements of one data type. Does type-checking.
 111  */
 112 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count)
 113
 114 /**
 115  * Resize an array of elements of one data type. Does type-checking.
 116  */
 117 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count)
 118
 119 #if defined(VALGRIND)
 120 #define strlen(x) valgrind_strlen(x)
 121 #endif
 122
 123 /**
 124   this is a warning hack. The idea is to use this everywhere that we
 125   get the "discarding const" warning from gcc. That doesn't actually
 126   fix the problem of course, but it means that when we do get to
 127   cleaning them up we can do it by searching the code for
 128   discard_const.
 129
 130   It also means that other error types aren't as swamped by the noise
 131   of hundreds of const warnings, so we are more likely to notice when
 132   we get new errors.
 133
 134   Please only add more uses of this macro when you find it
 135   _really_ hard to fix const warnings. Our aim is to eventually use
 136   this function in only a very few places.
 137
 138   Also, please call this via the discard_const_p() macro interface, as that
 139   makes the return type safe.
 140 */
 141 #define discard_const(ptr) ((void *)((intptr_t)(ptr)))
 142
 143 /** Type-safe version of discard_const */
 144 #define discard_const_p(type, ptr) ((type *)discard_const(ptr))
 145
 146 #endif /* _SAMBA_UTIL_H_ */