c9ef066c1dc267f893fced31997b5d056eaa8ae5
[strongswan.git] / src / libstrongswan / 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 /**
64 * Macro gives back larger of two values.
65 */
66 #define max(x,y) (x > y ? x : y)
67
68 /**
69 * Macro gives back smaller of two values.
70 */
71 #define min(x,y) (x < y ? x : y)
72
73 /**
74 * Debug macro to follow control flow
75 */
76 #define POS printf("%s, line %d\n", __FILE__, __LINE__)
77
78 /**
79 * Macro to allocate a sized type.
80 *
81 * @param thing object on which a sizeof is performed
82 * @return poiner to allocated memory
83 */
84 #define malloc_thing(thing) ((thing*)malloc(sizeof(thing)))
85
86
87 /**
88 * Mapping entry which defines the end of a mapping_t array.
89 */
90 #define MAPPING_END (-1)
91
92 typedef struct mapping_t mapping_t;
93
94 /**
95 * @brief Mapping entry, where enum-to-string mappings are stored.
96 */
97 struct mapping_t
98 {
99 /**
100 * Enumeration value.
101 */
102 int value;
103
104 /**
105 * Mapped string.
106 */
107 char *string;
108 };
109
110
111 /**
112 * @brief Find a mapping_string in the mapping[].
113 *
114 * @param mappings mappings array
115 * @param value enum-value to get the string from
116 *
117 */
118 char *mapping_find(mapping_t *mappings, int value);
119
120 #endif /*DEFINITIONS_H_*/