]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
c69ee87c | 2 | * Copyright (c) 2008, 2009, 2010 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 BP |
79 | |
80 | /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns | |
81 | the STRUCT object. */ | |
82 | #define CONTAINER_OF(POINTER, STRUCT, MEMBER) \ | |
83 | ((STRUCT *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER))) | |
84 | ||
85 | #ifdef __cplusplus | |
86 | extern "C" { | |
87 | #endif | |
88 | ||
89 | void set_program_name(const char *); | |
90 | ||
91 | void ovs_print_version(char *date, char *time, | |
92 | uint8_t min_ofp, uint8_t max_ofp); | |
93 | #define OVS_PRINT_VERSION(min_ofp, max_ofp) \ | |
94 | ovs_print_version(__DATE__, __TIME__, (min_ofp), (max_ofp)) | |
95 | ||
96 | void out_of_memory(void) NO_RETURN; | |
97 | void *xmalloc(size_t) MALLOC_LIKE; | |
98 | void *xcalloc(size_t, size_t) MALLOC_LIKE; | |
ec6fde61 | 99 | void *xzalloc(size_t) MALLOC_LIKE; |
064af421 BP |
100 | void *xrealloc(void *, size_t); |
101 | void *xmemdup(const void *, size_t) MALLOC_LIKE; | |
102 | char *xmemdup0(const char *, size_t) MALLOC_LIKE; | |
103 | char *xstrdup(const char *) MALLOC_LIKE; | |
104 | char *xasprintf(const char *format, ...) PRINTF_FORMAT(1, 2) MALLOC_LIKE; | |
105 | char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE; | |
106 | void *x2nrealloc(void *p, size_t *n, size_t s); | |
107 | ||
108 | void ovs_strlcpy(char *dst, const char *src, size_t size); | |
109 | ||
110 | void ovs_fatal(int err_no, const char *format, ...) | |
111 | PRINTF_FORMAT(2, 3) NO_RETURN; | |
112 | void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3); | |
113 | void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii); | |
114 | ||
115 | bool str_to_int(const char *, int base, int *); | |
116 | bool str_to_long(const char *, int base, long *); | |
117 | bool str_to_llong(const char *, int base, long long *); | |
118 | bool str_to_uint(const char *, int base, unsigned int *); | |
119 | bool str_to_ulong(const char *, int base, unsigned long *); | |
120 | bool str_to_ullong(const char *, int base, unsigned long long *); | |
121 | ||
f38b84ea BP |
122 | bool str_to_double(const char *, double *); |
123 | ||
124 | int hexit_value(int c); | |
125 | ||
daf03c53 | 126 | char *get_cwd(void); |
29d4af60 | 127 | char *dir_name(const char *file_name); |
daf03c53 | 128 | char *abs_file_name(const char *dir, const char *file_name); |
29d4af60 | 129 | |
c69ee87c | 130 | void ignore(bool x OVS_UNUSED); |
18b9283b | 131 | |
064af421 BP |
132 | #ifdef __cplusplus |
133 | } | |
134 | #endif | |
135 | ||
136 | #endif /* util.h */ |