X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Futil.h;h=b944ec793b817c56fe93a8e15da550857e01a73d;hb=ea7655d9f9d38a3af7250de8ba0b89115b5f4a5e;hp=9df6db5836833522dfeb955fa98e19354f232fda;hpb=daf03c53ee14a0227b43330be2e638b9ad9ce022;p=sliver-openvswitch.git diff --git a/lib/util.h b/lib/util.h index 9df6db583..b944ec793 100644 --- a/lib/util.h +++ b/lib/util.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2008, 2009, 2010 Nicira Networks. + * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,6 +17,7 @@ #ifndef UTIL_H #define UTIL_H 1 +#include #include #include #include @@ -33,7 +34,10 @@ #endif #endif -#ifndef __cplusplus +#ifdef __CHECKER__ +#define BUILD_ASSERT(EXPR) ((void) 0) +#define BUILD_ASSERT_DECL(EXPR) extern int (*build_assert(void))[1] +#elif !defined(__cplusplus) /* Build-time assertion building block. */ #define BUILD_ASSERT__(EXPR) \ sizeof(struct { unsigned int build_assert_failed : (EXPR) ? 1 : -1; }) @@ -50,7 +54,37 @@ #define BUILD_ASSERT_DECL BOOST_STATIC_ASSERT #endif /* __cplusplus */ +#ifdef __GNUC__ +#define BUILD_ASSERT_GCCONLY(EXPR) BUILD_ASSERT(EXPR) +#define BUILD_ASSERT_DECL_GCCONLY(EXPR) BUILD_ASSERT_DECL(EXPR) +#else +#define BUILD_ASSERT_GCCONLY(EXPR) ((void) 0) +#define BUILD_ASSERT_DECL_GCCONLY(EXPR) ((void) 0) +#endif + +/* Like the standard assert macro, except: + * + * - Writes the failure message to the log. + * + * - Not affected by NDEBUG. */ +#define ovs_assert(CONDITION) \ + if (!OVS_LIKELY(CONDITION)) { \ + ovs_assert_failure(SOURCE_LOCATOR, __func__, #CONDITION); \ + } +void ovs_assert_failure(const char *, const char *, const char *) NO_RETURN; + +/* Casts 'pointer' to 'type' and issues a compiler warning if the cast changes + * anything other than an outermost "const" or "volatile" qualifier. + * + * The cast to int is present only to suppress an "expression using sizeof + * bool" warning from "sparse" (see + * http://permalink.gmane.org/gmane.comp.parsers.sparse/2967). */ +#define CONST_CAST(TYPE, POINTER) \ + ((void) sizeof ((int) ((POINTER) == (TYPE) (POINTER))), \ + (TYPE) (POINTER)) + extern const char *program_name; +extern const char *subprogram_name; /* Returns the number of elements in ARRAY. */ #define ARRAY_SIZE(ARRAY) (sizeof ARRAY / sizeof *ARRAY) @@ -67,6 +101,12 @@ extern const char *program_name; /* Returns true if X is a power of 2, otherwise false. */ #define IS_POW2(X) ((X) && !((X) & ((X) - 1))) +static inline bool +is_pow2(uintmax_t x) +{ + return IS_POW2(x); +} + #ifndef MIN #define MIN(X, Y) ((X) < (Y) ? (X) : (Y)) #endif @@ -77,21 +117,73 @@ extern const char *program_name; #define NOT_REACHED() abort() +/* Expands to a string that looks like ":", e.g. "tmp.c:10". + * + * See http://c-faq.com/ansi/stringize.html for an explanation of STRINGIZE and + * STRINGIZE2. */ +#define SOURCE_LOCATOR __FILE__ ":" STRINGIZE(__LINE__) +#define STRINGIZE(ARG) STRINGIZE2(ARG) +#define STRINGIZE2(ARG) #ARG + +/* Given a pointer-typed lvalue OBJECT, expands to a pointer type that may be + * assigned to OBJECT. */ +#ifdef __GNUC__ +#define OVS_TYPEOF(OBJECT) typeof(OBJECT) +#else +#define OVS_TYPEOF(OBJECT) void * +#endif + +/* Given OBJECT of type pointer-to-structure, expands to the offset of MEMBER + * within an instance of the structure. + * + * The GCC-specific version avoids the technicality of undefined behavior if + * OBJECT is null, invalid, or not yet initialized. This makes some static + * checkers (like Coverity) happier. But the non-GCC version does not actually + * dereference any pointer, so it would be surprising for it to cause any + * problems in practice. + */ +#ifdef __GNUC__ +#define OBJECT_OFFSETOF(OBJECT, MEMBER) offsetof(typeof(*(OBJECT)), MEMBER) +#else +#define OBJECT_OFFSETOF(OBJECT, MEMBER) \ + ((char *) &(OBJECT)->MEMBER - (char *) (OBJECT)) +#endif + /* Given POINTER, the address of the given MEMBER in a STRUCT object, returns the STRUCT object. */ #define CONTAINER_OF(POINTER, STRUCT, MEMBER) \ - ((STRUCT *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER))) + ((STRUCT *) (void *) ((char *) (POINTER) - offsetof (STRUCT, MEMBER))) + +/* Given POINTER, the address of the given MEMBER within an object of the type + * that that OBJECT points to, returns OBJECT as an assignment-compatible + * pointer type (either the correct pointer type or "void *"). OBJECT must be + * an lvalue. + * + * This is the same as CONTAINER_OF except that it infers the structure type + * from the type of '*OBJECT'. */ +#define OBJECT_CONTAINING(POINTER, OBJECT, MEMBER) \ + ((OVS_TYPEOF(OBJECT)) (void *) \ + ((char *) (POINTER) - OBJECT_OFFSETOF(OBJECT, MEMBER))) + +/* Given POINTER, the address of the given MEMBER within an object of the type + * that that OBJECT points to, assigns the address of the outer object to + * OBJECT, which must be an lvalue. + * + * Evaluates to 1. */ +#define ASSIGN_CONTAINER(OBJECT, POINTER, MEMBER) \ + ((OBJECT) = OBJECT_CONTAINING(POINTER, OBJECT, MEMBER), 1) #ifdef __cplusplus extern "C" { #endif -void set_program_name(const char *); +void set_program_name__(const char *name, const char *version, + const char *date, const char *time); +#define set_program_name(name) \ + set_program_name__(name, VERSION, __DATE__, __TIME__) -void ovs_print_version(char *date, char *time, - uint8_t min_ofp, uint8_t max_ofp); -#define OVS_PRINT_VERSION(min_ofp, max_ofp) \ - ovs_print_version(__DATE__, __TIME__, (min_ofp), (max_ofp)) +const char *get_program_version(void); +void ovs_print_version(uint8_t min_ofp, uint8_t max_ofp); void out_of_memory(void) NO_RETURN; void *xmalloc(size_t) MALLOC_LIKE; @@ -106,10 +198,20 @@ char *xvasprintf(const char *format, va_list) PRINTF_FORMAT(1, 0) MALLOC_LIKE; void *x2nrealloc(void *p, size_t *n, size_t s); void ovs_strlcpy(char *dst, const char *src, size_t size); +void ovs_strzcpy(char *dst, const char *src, size_t size); +void ovs_abort(int err_no, const char *format, ...) + PRINTF_FORMAT(2, 3) NO_RETURN; +void ovs_abort_valist(int err_no, const char *format, va_list) + PRINTF_FORMAT(2, 0) NO_RETURN; void ovs_fatal(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3) NO_RETURN; +void ovs_fatal_valist(int err_no, const char *format, va_list) + PRINTF_FORMAT(2, 0) NO_RETURN; void ovs_error(int err_no, const char *format, ...) PRINTF_FORMAT(2, 3); +void ovs_error_valist(int err_no, const char *format, va_list) + PRINTF_FORMAT(2, 0); +const char *ovs_retval_to_string(int); void ovs_hex_dump(FILE *, const void *, size_t, uintptr_t offset, bool ascii); bool str_to_int(const char *, int base, int *); @@ -122,12 +224,102 @@ bool str_to_ullong(const char *, int base, unsigned long long *); bool str_to_double(const char *, double *); int hexit_value(int c); +unsigned int hexits_value(const char *s, size_t n, bool *ok); + +const char *english_list_delimiter(size_t index, size_t total); char *get_cwd(void); char *dir_name(const char *file_name); +char *base_name(const char *file_name); char *abs_file_name(const char *dir, const char *file_name); +char *xreadlink(const char *filename); +char *follow_symlinks(const char *filename); + void ignore(bool x OVS_UNUSED); + +/* Bitwise tests. */ + +/* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. + * + * This compiles to a single machine instruction ("bsf") with GCC on x86. */ +#if !defined(UINT_MAX) || !defined(UINT32_MAX) +#error "Someone screwed up the #includes." +#elif __GNUC__ >= 4 && UINT_MAX == UINT32_MAX +static inline int +raw_ctz(uint32_t n) +{ + return __builtin_ctz(n); +} +#else +/* Defined in util.c. */ +int raw_ctz(uint32_t n); +#endif + +/* Returns the number of trailing 0-bits in 'n', or 32 if 'n' is 0. */ +static inline int +ctz(uint32_t n) +{ + return n ? raw_ctz(n) : 32; +} + +int log_2_floor(uint32_t); +int log_2_ceil(uint32_t); +int popcount(uint32_t); + +/* Returns the rightmost 1-bit in 'x' (e.g. 01011000 => 00001000), or 0 if 'x' + * is 0. */ +static inline uintmax_t +rightmost_1bit(uintmax_t x) +{ + return x & -x; +} + +/* Returns 'x' with its rightmost 1-bit changed to a zero (e.g. 01011000 => + * 01010000), or 0 if 'x' is 0. */ +static inline uintmax_t +zero_rightmost_1bit(uintmax_t x) +{ + return x & (x - 1); +} + +/* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 3), or 32 + * if 'x' is 0. + * + * Unlike the other functions for rightmost 1-bits, this function only works + * with 32-bit integers. */ +static inline uint32_t +rightmost_1bit_idx(uint32_t x) +{ + return x ? ctz(x) : 32; +} + +/* Returns the index of the rightmost 1-bit in 'x' (e.g. 01011000 => 6), or 32 + * if 'x' is 0. + * + * This function only works with 32-bit integers. */ +static inline uint32_t +leftmost_1bit_idx(uint32_t x) +{ + return x ? log_2_floor(x) : 32; +} + +bool is_all_zeros(const uint8_t *, size_t); +bool is_all_ones(const uint8_t *, size_t); +void bitwise_copy(const void *src, unsigned int src_len, unsigned int src_ofs, + void *dst, unsigned int dst_len, unsigned int dst_ofs, + unsigned int n_bits); +void bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs, + unsigned int n_bits); +void bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs, + unsigned int n_bits); +bool bitwise_is_all_zeros(const void *, unsigned int len, unsigned int ofs, + unsigned int n_bits); +void bitwise_put(uint64_t value, + void *dst, unsigned int dst_len, unsigned int dst_ofs, + unsigned int n_bits); +uint64_t bitwise_get(const void *src, unsigned int src_len, + unsigned int src_ofs, unsigned int n_bits); #ifdef __cplusplus }