]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
71d7c22f | 2 | * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks. |
064af421 | 3 | * |
a14bc59f BP |
4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at: | |
064af421 | 7 | * |
a14bc59f BP |
8 | * http://www.apache.org/licenses/LICENSE-2.0 |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
064af421 BP |
15 | */ |
16 | ||
17 | #ifndef UTIL_H | |
18 | #define UTIL_H 1 | |
19 | ||
20 | #include <stdarg.h> | |
21 | #include <stdbool.h> | |
22 | #include <stddef.h> | |
23 | #include <stdint.h> | |
24 | #include <stdio.h> | |
25 | #include <string.h> | |
26 | #include "compiler.h" | |
27 | ||
28 | #ifndef va_copy | |
29 | #ifdef __va_copy | |
30 | #define va_copy __va_copy | |
31 | #else | |
32 | #define va_copy(dst, src) ((dst) = (src)) | |
33 | #endif | |
34 | #endif | |
35 | ||
36 | #ifndef __cplusplus | |
37 | /* Build-time assertion building block. */ | |
38 | #define BUILD_ASSERT__(EXPR) \ | |
39 | sizeof(struct { unsigned int build_assert_failed : (EXPR) ? 1 : -1; }) | |
40 | ||
41 | /* Build-time assertion for use in a statement context. */ | |
42 | #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR) | |
43 | ||
44 | /* Build-time assertion for use in a declaration context. */ | |
45 | #define BUILD_ASSERT_DECL(EXPR) \ | |
46 | extern int (*build_assert(void))[BUILD_ASSERT__(EXPR)] | |
47 | #else /* __cplusplus */ | |
48 | #include <boost/static_assert.hpp> | |
49 | #define BUILD_ASSERT BOOST_STATIC_ASSERT | |
50 | #define BUILD_ASSERT_DECL BOOST_STATIC_ASSERT | |
51 | #endif /* __cplusplus */ | |
52 | ||
53 | extern const char *program_name; | |
54 | ||
ba25c9d1 | 55 | /* Returns the number of elements in ARRAY. */ |
064af421 | 56 | #define ARRAY_SIZE(ARRAY) (sizeof ARRAY / sizeof *ARRAY) |
ba25c9d1 BP |
57 | |
58 | /* Returns X / Y, rounding up. X must be nonnegative to round correctly. */ | |
bbb18ba7 | 59 | #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y)) |
ba25c9d1 BP |
60 | |
61 | /* Returns X rounded up to the nearest multiple of Y. */ | |
bbb18ba7 | 62 | #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y)) |
ba25c9d1 BP |
63 | |
64 | /* Returns X rounded down to the nearest multiple of Y. */ | |
064af421 | 65 | #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y)) |
ba25c9d1 BP |
66 | |
67 | /* Returns true if X is a power of 2, otherwise false. */ | |
064af421 BP |
68 | #define IS_POW2(X) ((X) && !((X) & ((X) - 1))) |
69 | ||
70 | #ifndef MIN | |
71 | #define MIN(X, Y) ((X) < (Y) ? (X) : (Y)) | |
72 | #endif | |
73 | ||
74 | #ifndef MAX | |
75 | #define MAX(X, Y) ((X) > (Y) ? (X) : (Y)) | |
76 | #endif | |
77 | ||
78 | #define NOT_REACHED() abort() | |
064af421 | 79 | |
17e42975 BP |
80 | /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be |
81 | * assigned to OBJECT. */ | |
82 | #ifdef __GNUC__ | |
83 | #define OVS_TYPEOF(OBJECT) typeof(OBJECT) | |
84 | #else | |
85 | #define OVS_TYPEOF(OBJECT) void * | |
86 | #endif | |
87 | ||
4e6ca956 BP |
88 | /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER |
89 | * within an instance of the structure. | |
90 | * | |
91 | * The GCC-specific version avoids the technicality of undefined behavior if | |
92 | * OBJECT is null, invalid, or not yet initialized. This makes some static | |
93 | * checkers (like Coverity) happier. But the non-GCC version does not actually | |
94 | * dereference any pointer, so it would be surprising for it to cause any | |
95 | * problems in practice. | |
96 | */ | |
97 | #ifdef __GNUC__ | |
98 | #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER) | |
99 | #else | |
100 | #define OBJECT_OFFSETOF(OBJECT, MEMBER) \ | |
101 | ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT)) | |
102 | #endif | |
103 | ||
064af421 BP |
104 | /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns |
105 | the STRUCT object. */ | |
106 | #define CONTAINER_OF(POINTER, STRUCT, MEMBER) \ | |
26adc8dd | 107 | ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER))) |
064af421 | 108 | |
adf7cfd8 | 109 | /* Given POINTER, the address of the given MEMBER within an object of the type |
17e42975 BP |
110 | * that that OBJECT points to, returns OBJECT as an assignment-compatible |
111 | * pointer type (either the correct pointer type or "void *"). OBJECT must be | |
112 | * an lvalue. | |
adf7cfd8 BP |
113 | * |
114 | * This is the same as CONTAINER_OF except that it infers the structure type | |
115 | * from the type of '*OBJECT'. */ | |
116 | #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER) \ | |
17e42975 | 117 | ((OVS_TYPEOF(OBJECT)) (void *) \ |
4e6ca956 | 118 | ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER))) |
adf7cfd8 | 119 | |
772ec52b BP |
120 | /* Given POINTER, the address of the given MEMBER within an object of the type |
121 | * that that OBJECT points to, assigns the address of the outer object to | |
122 | * OBJECT, which must be an lvalue. | |
123 | * | |
124 | * Evaluates to 1. */ | |
125 | #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \ | |
126 | ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), 1) | |
127 | ||
064af421 BP |
128 | #ifdef __cplusplus |
129 | extern "C" { | |
130 | #endif | |
131 | ||
132 | void set_program_name(const char *); | |
133 | ||
d295e8e9 | 134 | void ovs_print_version(char *date, char *time, |
064af421 BP |
135 | uint8_t min_ofp, uint8_t max_ofp); |
136 | #define OVS_PRINT_VERSION(min_ofp, max_ofp) \ | |
137 | ovs_print_version(__DATE__, __TIME__, (min_ofp), (max_ofp)) | |
138 | ||
139 | void out_of_memory(void) NO_RETURN; | |
140 | void *xmalloc(size_t) MALLOC_LIKE; | |
141 | void *xcalloc(size_t, size_t) MALLOC_LIKE; | |
ec6fde61 | 142 | void *xzalloc(size_t) MALLOC_LIKE; |
064af421 BP |
143 | void *xrealloc(void *, size_t); |
144 | void *xmemdup(const void *, size_t) MALLOC_LIKE; | |
145 | char *xmemdup0(const char *, size_t) MALLOC_LIKE; | |
146 | char *xstrdup(const char *) MALLOC_LIKE; | |
147 | char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE; | |
148 | char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE; | |
149 | void *x2nrealloc(void *p, size_t *n, size_t s); | |
150 | ||
151 | void ovs_strlcpy(char *dst, const char *src, size_t size); | |
71d7c22f | 152 | void ovs_strzcpy(char *dst, const char *src, size_t size); |
064af421 | 153 | |
c1c8308a BP |
154 | void ovs_abort(int err_no, const char *format, ...) |
155 | PRINTF_FORMAT(2, 3) NO_RETURN; | |
064af421 BP |
156 | void ovs_fatal(int err_no, const char *format, ...) |
157 | PRINTF_FORMAT(2, 3) NO_RETURN; | |
fcaddd4d BP |
158 | void ovs_fatal_valist(int err_no, const char *format, va_list) |
159 | PRINTF_FORMAT(2, 0) NO_RETURN; | |
064af421 | 160 | void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3); |
c1c8308a BP |
161 | void ovs_error_valist(int err_no, const char *format, va_list) |
162 | PRINTF_FORMAT(2, 0); | |
c18ea70d | 163 | const char *ovs_retval_to_string(int); |
064af421 BP |
164 | void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii); |
165 | ||
166 | bool str_to_int(const char *, int base, int *); | |
167 | bool str_to_long(const char *, int base, long *); | |
168 | bool str_to_llong(const char *, int base, long long *); | |
169 | bool str_to_uint(const char *, int base, unsigned int *); | |
170 | bool str_to_ulong(const char *, int base, unsigned long *); | |
171 | bool str_to_ullong(const char *, int base, unsigned long long *); | |
172 | ||
f38b84ea BP |
173 | bool str_to_double(const char *, double *); |
174 | ||
175 | int hexit_value(int c); | |
bf971267 | 176 | unsigned int hexits_value(const char *s, size_t n, bool *ok); |
f38b84ea | 177 | |
daf03c53 | 178 | char *get_cwd(void); |
29d4af60 | 179 | char *dir_name(const char *file_name); |
e1aff6f9 | 180 | char *base_name(const char *file_name); |
daf03c53 | 181 | char *abs_file_name(const char *dir, const char *file_name); |
29d4af60 | 182 | |
c69ee87c | 183 | void ignore(bool x OVS_UNUSED); |
18b9283b | 184 | |
064af421 BP |
185 | #ifdef __cplusplus |
186 | } | |
187 | #endif | |
188 | ||
189 | #endif /* util.h */ |