ovs-ofctl: Use vconn as a parameter of dump_stats_transaction()
[sliver-openvswitch.git] / lib / util.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
3  *
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:
7  *
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.
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 #ifdef __CHECKER__
37 #define BUILD_ASSERT(EXPR) ((void) 0)
38 #define BUILD_ASSERT_DECL(EXPR) extern int (*build_assert(void))[1]
39 #elif !defined(__cplusplus)
40 /* Build-time assertion building block. */
41 #define BUILD_ASSERT__(EXPR) \
42         sizeof(struct { unsigned int build_assert_failed : (EXPR) ? 1 : -1; })
43
44 /* Build-time assertion for use in a statement context. */
45 #define BUILD_ASSERT(EXPR) (void) BUILD_ASSERT__(EXPR)
46
47 /* Build-time assertion for use in a declaration context. */
48 #define BUILD_ASSERT_DECL(EXPR) \
49         extern int (*build_assert(void))[BUILD_ASSERT__(EXPR)]
50 #else /* __cplusplus */
51 #include <boost/static_assert.hpp>
52 #define BUILD_ASSERT BOOST_STATIC_ASSERT
53 #define BUILD_ASSERT_DECL BOOST_STATIC_ASSERT
54 #endif /* __cplusplus */
55
56 #ifdef __GNUC__
57 #define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR)
58 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR)
59 #else
60 #define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0)
61 #define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0)
62 #endif
63
64 /* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes
65  * anything other than an outermost "const" or "volatile" qualifier.
66  *
67  * The cast to int is present only to suppress an "expression using sizeof
68  * bool" warning from "sparse" (see
69  * http://permalink.gmane.org/gmane.comp.parsers.sparse/2967). */
70 #define CONST_CAST(TYPE, POINTER)                               \
71     ((void) sizeof ((int) ((POINTER) == (TYPE) (POINTER))),     \
72      (TYPE) (POINTER))
73
74 extern const char *program_name;
75 extern const char *subprogram_name;
76
77 /* Returns the number of elements in ARRAY. */
78 #define ARRAY_SIZE(ARRAY) (sizeof ARRAY / sizeof *ARRAY)
79
80 /* Returns X / Y, rounding up.  X must be nonnegative to round correctly. */
81 #define DIV_ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
82
83 /* Returns X rounded up to the nearest multiple of Y. */
84 #define ROUND_UP(X, Y) (DIV_ROUND_UP(X, Y) * (Y))
85
86 /* Returns X rounded down to the nearest multiple of Y. */
87 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
88
89 /* Returns true if X is a power of 2, otherwise false. */
90 #define IS_POW2(X) ((X) && !((X) & ((X) - 1)))
91
92 static inline bool
93 is_pow2(uintmax_t x)
94 {
95     return IS_POW2(x);
96 }
97
98 /* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x'
99  * is 0. */
100 static inline uintmax_t
101 rightmost_1bit(uintmax_t x)
102 {
103     return x & -x;
104 }
105
106 #ifndef MIN
107 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
108 #endif
109
110 #ifndef MAX
111 #define MAX(X, Y) ((X) > (Y) ? (X) : (Y))
112 #endif
113
114 #define NOT_REACHED() abort()
115
116 /* Expands to a string that looks like "<file>:<line>", e.g. "tmp.c:10".
117  *
118  * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and
119  * STRINGIZE2. */
120 #define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__)
121 #define STRINGIZE(ARG) STRINGIZE2(ARG)
122 #define STRINGIZE2(ARG) #ARG
123
124 /* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be
125  * assigned to OBJECT. */
126 #ifdef __GNUC__
127 #define OVS_TYPEOF(OBJECT) typeof(OBJECT)
128 #else
129 #define OVS_TYPEOF(OBJECT) void *
130 #endif
131
132 /* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER
133  * within an instance of the structure.
134  *
135  * The GCC-specific version avoids the technicality of undefined behavior if
136  * OBJECT is null, invalid, or not yet initialized.  This makes some static
137  * checkers (like Coverity) happier.  But the non-GCC version does not actually
138  * dereference any pointer, so it would be surprising for it to cause any
139  * problems in practice.
140  */
141 #ifdef __GNUC__
142 #define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER)
143 #else
144 #define OBJECT_OFFSETOF(OBJECT, MEMBER) \
145     ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT))
146 #endif
147
148 /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns
149    the STRUCT object. */
150 #define CONTAINER_OF(POINTER, STRUCT, MEMBER)                           \
151         ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER)))
152
153 /* Given POINTER, the address of the given MEMBER within an object of the type
154  * that that OBJECT points to, returns OBJECT as an assignment-compatible
155  * pointer type (either the correct pointer type or "void *").  OBJECT must be
156  * an lvalue.
157  *
158  * This is the same as CONTAINER_OF except that it infers the structure type
159  * from the type of '*OBJECT'. */
160 #define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER)                      \
161     ((OVS_TYPEOF(OBJECT)) (void *)                                      \
162      ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER)))
163
164 /* Given POINTER, the address of the given MEMBER within an object of the type
165  * that that OBJECT points to, assigns the address of the outer object to
166  * OBJECT, which must be an lvalue.
167  *
168  * Evaluates to 1. */
169 #define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \
170     ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), 1)
171
172 #ifdef  __cplusplus
173 extern "C" {
174 #endif
175
176 void set_program_name__(const char *name, const char *version,
177                         const char *date, const char *time);
178 #define set_program_name(name) \
179         set_program_name__(name, VERSION, __DATE__, __TIME__)
180
181 const char *get_program_version(void);
182 void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp);
183
184 void out_of_memory(void) NO_RETURN;
185 void *xmalloc(size_t) MALLOC_LIKE;
186 void *xcalloc(size_t, size_t) MALLOC_LIKE;
187 void *xzalloc(size_t) MALLOC_LIKE;
188 void *xrealloc(void *, size_t);
189 void *xmemdup(const void *, size_t) MALLOC_LIKE;
190 char *xmemdup0(const char *, size_t) MALLOC_LIKE;
191 char *xstrdup(const char *) MALLOC_LIKE;
192 char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE;
193 char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE;
194 void *x2nrealloc(void *p, size_t *n, size_t s);
195
196 void ovs_strlcpy(char *dst, const char *src, size_t size);
197 void ovs_strzcpy(char *dst, const char *src, size_t size);
198
199 void ovs_abort(int err_no, const char *format, ...)
200     PRINTF_FORMAT(2, 3) NO_RETURN;
201 void ovs_abort_valist(int err_no, const char *format, va_list)
202     PRINTF_FORMAT(2, 0) NO_RETURN;
203 void ovs_fatal(int err_no, const char *format, ...)
204     PRINTF_FORMAT(2, 3) NO_RETURN;
205 void ovs_fatal_valist(int err_no, const char *format, va_list)
206     PRINTF_FORMAT(2, 0) NO_RETURN;
207 void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3);
208 void ovs_error_valist(int err_no, const char *format, va_list)
209     PRINTF_FORMAT(2, 0);
210 const char *ovs_retval_to_string(int);
211 void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii);
212
213 bool str_to_int(const char *, int base, int *);
214 bool str_to_long(const char *, int base, long *);
215 bool str_to_llong(const char *, int base, long long *);
216 bool str_to_uint(const char *, int base, unsigned int *);
217 bool str_to_ulong(const char *, int base, unsigned long *);
218 bool str_to_ullong(const char *, int base, unsigned long long *);
219
220 bool str_to_double(const char *, double *);
221
222 int hexit_value(int c);
223 unsigned int hexits_value(const char *s, size_t n, bool *ok);
224
225 const char *english_list_delimiter(size_t index, size_t total);
226
227 char *get_cwd(void);
228 char *dir_name(const char *file_name);
229 char *base_name(const char *file_name);
230 char *abs_file_name(const char *dir, const char *file_name);
231
232 char *xreadlink(const char *filename);
233 char *follow_symlinks(const char *filename);
234
235 void ignore(bool x OVS_UNUSED);
236 int log_2_floor(uint32_t);
237 int log_2_ceil(uint32_t);
238 int ctz(uint32_t);
239
240 bool is_all_zeros(const uint8_t *, size_t);
241 bool is_all_ones(const uint8_t *, size_t);
242 void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs,
243                   void *dst, unsigned int dst_len, unsigned int dst_ofs,
244                   unsigned int n_bits);
245 void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
246                   unsigned int n_bits);
247 void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
248                  unsigned int n_bits);
249 bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs,
250                           unsigned int n_bits);
251 void bitwise_put(uint64_t value,
252                  void *dst, unsigned int dst_len, unsigned int dst_ofs,
253                  unsigned int n_bits);
254 uint64_t bitwise_get(const void *src, unsigned int src_len,
255                      unsigned int src_ofs, unsigned int n_bits);
256
257 #ifdef  __cplusplus
258 }
259 #endif
260
261 #endif /* util.h */