src/libstrongswan/utils/utils.h

   1 /*
   2  * Copyright (C) 2008-2014 Tobias Brunner
   3  * Copyright (C) 2008 Martin Willi
   4  * Hochschule fuer Technik Rapperswil
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2 of the License, or (at your
   9  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * for more details.
  15  */
  16
  17 /**
  18  * @defgroup utils_i utils
  19  * @{ @ingroup utils
  20  */
  21
  22 #ifndef UTILS_H_
  23 #define UTILS_H_
  24
  25 #include <sys/types.h>
  26 #include <stdlib.h>
  27 #include <stddef.h>
  28 #include <sys/time.h>
  29 #include <string.h>
  30
  31 #ifdef WIN32
  32 # include "compat/windows.h"
  33 #else
  34 # define _GNU_SOURCE
  35 # include <arpa/inet.h>
  36 # include <sys/socket.h>
  37 # include <netdb.h>
  38 # include <netinet/in.h>
  39 # include <sched.h>
  40 # include <poll.h>
  41 #endif
  42
  43 #include "utils/types.h"
  44 #include "enum.h"
  45 #include "utils/atomics.h"
  46 #include "utils/align.h"
  47 #include "utils/byteorder.h"
  48 #include "utils/string.h"
  49 #include "utils/memory.h"
  50 #include "utils/strerror.h"
  51 #include "utils/status.h"
  52 #include "utils/object.h"
  53 #include "utils/path.h"
  54 #include "utils/time.h"
  55 #include "utils/tty.h"
  56 #ifdef __APPLE__
  57 # include "compat/apple.h"
  58 #endif
  59
  60 /**
  61  * Initialize utility functions
  62  */
  63 void utils_init();
  64
  65 /**
  66  * Deinitialize utility functions
  67  */
  68 void utils_deinit();
  69
  70 /**
  71  * strongSwan program return codes
  72  */
  73 #define SS_RC_LIBSTRONGSWAN_INTEGRITY   64
  74 #define SS_RC_DAEMON_INTEGRITY                  65
  75 #define SS_RC_INITIALIZATION_FAILED             66
  76
  77 #define SS_RC_FIRST     SS_RC_LIBSTRONGSWAN_INTEGRITY
  78 #define SS_RC_LAST      SS_RC_INITIALIZATION_FAILED
  79
  80 /**
  81  * Number of bits in a byte
  82  */
  83 #define BITS_PER_BYTE 8
  84
  85 /**
  86  * Default length for various auxiliary text buffers
  87  */
  88 #define BUF_LEN 512
  89
  90 /**
  91  * Build assertion macro for integer expressions, evaluates to 0
  92  */
  93 #define BUILD_ASSERT(x) (sizeof(char[(x) ? 0 : -1]))
  94
  95 /**
  96  * Build time check to assert a is an array, evaluates to 0
  97  *
  98  * The address of an array element has a pointer type, which is not compatible
  99  * to the array type.
 100  */
 101 #define BUILD_ASSERT_ARRAY(a) \
 102                 BUILD_ASSERT(!__builtin_types_compatible_p(typeof(a), typeof(&(a)[0])))
 103
 104 /**
 105  * Debug macro to follow control flow
 106  */
 107 #define POS printf("%s, line %d\n", __FILE__, __LINE__)
 108
 109 /**
 110  * This macro allows counting the number of arguments passed to a macro.
 111  * Combined with the VA_ARGS_DISPATCH() macro this can be used to implement
 112  * macro overloading based on the number of arguments.
 113  * 0 to 10 arguments are currently supported.
 114  */
 115 #define VA_ARGS_NUM(...) _VA_ARGS_NUM(0,##__VA_ARGS__,10,9,8,7,6,5,4,3,2,1,0)
 116 #define _VA_ARGS_NUM(_0,_1,_2,_3,_4,_5,_6,_7,_8,_9,_10,NUM,...) NUM
 117
 118 /**
 119  * This macro can be used to dispatch a macro call based on the number of given
 120  * arguments, for instance:
 121  *
 122  * @code
 123  * #define MY_MACRO(...) VA_ARGS_DISPATCH(MY_MACRO, __VA_ARGS__)(__VA_ARGS__)
 124  * #define MY_MACRO1(arg) one_arg(arg)
 125  * #define MY_MACRO2(arg1,arg2) two_args(arg1,arg2)
 126  * @endcode
 127  *
 128  * MY_MACRO() can now be called with either one or two arguments, which will
 129  * resolve to one_arg(arg) or two_args(arg1,arg2), respectively.
 130  */
 131 #define VA_ARGS_DISPATCH(func, ...) _VA_ARGS_DISPATCH(func, VA_ARGS_NUM(__VA_ARGS__))
 132 #define _VA_ARGS_DISPATCH(func, num) __VA_ARGS_DISPATCH(func, num)
 133 #define __VA_ARGS_DISPATCH(func, num) func ## num
 134
 135 /**
 136  * Macro to allocate a sized type.
 137  */
 138 #define malloc_thing(thing) ((thing*)malloc(sizeof(thing)))
 139
 140 /**
 141  * Get the number of elements in an array
 142  */
 143 #define countof(array) (sizeof(array)/sizeof((array)[0]) \
 144                                                 + BUILD_ASSERT_ARRAY(array))
 145
 146 /**
 147  * Ignore result of functions tagged with warn_unused_result attributes
 148  */
 149 #define ignore_result(call) { if(call){}; }
 150
 151 /**
 152  * Portable function to wait for SIGINT/SIGTERM (or equivalent).
 153  */
 154 void wait_sigint();
 155
 156 #ifndef HAVE_CLOSEFROM
 157 /**
 158  * Close open file descriptors greater than or equal to lowfd.
 159  *
 160  * @param lowfd         start closing file descriptors from here
 161  */
 162 void closefrom(int lowfd);
 163 #endif
 164
 165 /**
 166  * returns null
 167  */
 168 void *return_null();
 169
 170 /**
 171  * No-Operation function
 172  */
 173 void nop();
 174
 175 /**
 176  * returns TRUE
 177  */
 178 bool return_true();
 179
 180 /**
 181  * returns FALSE
 182  */
 183 bool return_false();
 184
 185 #endif /** UTILS_H_ @}*/