Source/charon/definitions.h

   1 /**
   2  * @file definitions.h
   3  *
   4  * @brief general purpose definitions and macros
   5  *
   6  */
   7
   8 /*
   9  * Copyright (C) 2005 Jan Hutter, Martin Willi
  10  * Hochschule fuer Technik Rapperswil
  11  * Copyright (C) 1998, 1999  D. Hugh Redelmeier. (Endian stuff)
  12  *
  13  * This program is free software; you can redistribute it and/or modify it
  14  * under the terms of the GNU General Public License as published by the
  15  * Free Software Foundation; either version 2 of the License, or (at your
  16  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  17  *
  18  * This program is distributed in the hope that it will be useful, but
  19  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  20  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  21  * for more details.
  22  */
  23
  24 #ifndef DEFINITIONS_H_
  25 #define DEFINITIONS_H_
  26
  27
  28
  29 /* stolen from strongswan */
  30 #if linux
  31 # if defined(i386) && !defined(__i386__)
  32 #  define __i386__ 1
  33 #  define MYHACKFORTHIS 1
  34 # endif
  35 # include <endian.h>
  36 # ifdef MYHACKFORTHIS
  37 #  undef __i386__
  38 #  undef MYHACKFORTHIS
  39 # endif
  40 #elif !(defined(BIG_ENDIAN) && defined(LITTLE_ENDIAN) && defined(BYTE_ORDER))
  41  /* we don't know how to do this, so we require the macros to be defined
  42   * with compiler flags:
  43   *    -DBIG_ENDIAN=4321 -DLITTLE_ENDIAN=1234 -DBYTE_ORDER=BIG_ENDIAN
  44   * or -DBIG_ENDIAN=4321 -DLITTLE_ENDIAN=1234 -DBYTE_ORDER=LITTLE_ENDIAN
  45   * Thse match the GNU definitions
  46   */
  47 # include <sys/endian.h>
  48 #endif
  49
  50 #ifndef BIG_ENDIAN
  51  #error "BIG_ENDIAN must be defined"
  52 #endif
  53
  54 #ifndef LITTLE_ENDIAN
  55  #error "LITTLE_ENDIAN must be defined"
  56 #endif
  57
  58 #ifndef BYTE_ORDER
  59  #error "BYTE_ORDER must be defined"
  60 #endif
  61
  62 /**
  63  * Doxygen namespace support
  64  */
  65
  66
  67 /**
  68  * @addtogroup transforms
  69  *
  70  * Transform algorithms of different kind.
  71  */
  72
  73 /**
  74  * @addtogroup prfs
  75  *
  76  * Pseudo random functions, generate a lot of pseudo
  77  * randomness using random numbers.
  78  *
  79  * @ingroup transforms
  80  */
  81
  82 /**
  83  * @addtogroup signers
  84  *
  85  * Symmetric signing algorithms, used to ensure
  86  * message integrity.
  87  *
  88  * @ingroup transforms
  89  */
  90
  91 /**
  92  * @addtogroup crypters
  93  *
  94  * Symmetric encryption algorithms, used to en-
  95  * and decrypt.
  96  *
  97  * @ingroup transforms
  98  */
  99
 100 /**
 101  * @addtogroup hashers
 102  *
 103  * Hash algorithms
 104  *
 105  * @ingroup transforms
 106  */
 107
 108  /**
 109  * @addtogroup utils
 110  *
 111  * Generic helper classes.
 112  */
 113
 114 /**
 115  * @addtogroup threads
 116  *
 117  * Threaded classes, which will do their
 118  * job alone.
 119  */
 120
 121
 122
 123 /**
 124  * macro gives back larger of two values
 125  */
 126 #define max(x,y) (x > y ? x : y)
 127
 128
 129 /**
 130  * macro gives back smaller of two values
 131  */
 132 #define min(x,y) (x < y ? x : y)
 133
 134
 135 /**
 136  * mapping entry which defines the end of a mapping_t array
 137  */
 138 #define MAPPING_END (-1)
 139
 140 typedef struct mapping_t mapping_t;
 141
 142 /**
 143  * @brief mapping entry, where enum-to-string mappings are stored.
 144  */
 145 struct mapping_t
 146 {
 147         /**
 148          * enumeration value
 149          */
 150         int value;
 151         /**
 152          * mapped string
 153          */
 154         char *string;
 155 };
 156
 157
 158 /**
 159  * @brief find a mapping_string in the mapping[]
 160  *
 161  * @param mappings              mappings array
 162  * @param value                 enum-value to get the string from
 163  *
 164  */
 165 char *mapping_find(mapping_t *mappings, int value);
 166
 167
 168 /**
 169  * Default random device used when no device is given.
 170  */
 171 #define DEFAULT_RANDOM_DEVICE "/dev/random"
 172
 173 /**
 174  * Pseudo random device used when no device is given.
 175  */
 176 #define DEFAULT_PSEUDO_RANDOM_DEVICE "/dev/urandom"
 177
 178
 179 #endif /*DEFINITIONS_H_*/