2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
29 #include "byte-order.h"
31 #include "ovs-thread.h"
33 #ifdef HAVE_PTHREAD_SET_NAME_NP
34 #include <pthread_np.h>
37 VLOG_DEFINE_THIS_MODULE(util);
39 COVERAGE_DEFINE(util_xalloc);
41 /* argv[0] without directory names. */
42 const char *program_name;
44 /* Name for the currently running thread or process, for log messages, process
45 * listings, and debuggers. */
46 DEFINE_PER_THREAD_MALLOCED_DATA(char *, subprogram_name);
48 /* --version option output. */
49 static char *program_version;
51 /* Buffer used by ovs_strerror(). */
52 DEFINE_STATIC_PER_THREAD_DATA(struct { char s[128]; },
57 ovs_assert_failure(const char *where, const char *function,
58 const char *condition)
60 /* Prevent an infinite loop (or stack overflow) in case VLOG_ABORT happens
61 * to trigger an assertion failure of its own. */
62 static int reentry = 0;
66 VLOG_ABORT("%s: assertion %s failed in %s()",
67 where, condition, function);
71 fprintf(stderr, "%s: assertion %s failed in %s()",
72 where, condition, function);
83 ovs_abort(0, "virtual memory exhausted");
87 xcalloc(size_t count, size_t size)
89 void *p = count && size ? calloc(count, size) : malloc(1);
90 COVERAGE_INC(util_xalloc);
100 return xcalloc(1, size);
106 void *p = malloc(size ? size : 1);
107 COVERAGE_INC(util_xalloc);
115 xrealloc(void *p, size_t size)
117 p = realloc(p, size ? size : 1);
118 COVERAGE_INC(util_xalloc);
126 xmemdup(const void *p_, size_t size)
128 void *p = xmalloc(size);
134 xmemdup0(const char *p_, size_t length)
136 char *p = xmalloc(length + 1);
137 memcpy(p, p_, length);
143 xstrdup(const char *s)
145 return xmemdup0(s, strlen(s));
149 xvasprintf(const char *format, va_list args)
155 va_copy(args2, args);
156 needed = vsnprintf(NULL, 0, format, args);
158 s = xmalloc(needed + 1);
160 vsnprintf(s, needed + 1, format, args2);
167 x2nrealloc(void *p, size_t *n, size_t s)
169 *n = *n == 0 ? 1 : 2 * *n;
170 return xrealloc(p, *n * s);
174 xasprintf(const char *format, ...)
179 va_start(args, format);
180 s = xvasprintf(format, args);
186 /* Similar to strlcpy() from OpenBSD, but it never reads more than 'size - 1'
187 * bytes from 'src' and doesn't return anything. */
189 ovs_strlcpy(char *dst, const char *src, size_t size)
192 size_t len = strnlen(src, size - 1);
193 memcpy(dst, src, len);
198 /* Copies 'src' to 'dst'. Reads no more than 'size - 1' bytes from 'src'.
199 * Always null-terminates 'dst' (if 'size' is nonzero), and writes a zero byte
200 * to every otherwise unused byte in 'dst'.
202 * Except for performance, the following call:
203 * ovs_strzcpy(dst, src, size);
204 * is equivalent to these two calls:
205 * memset(dst, '\0', size);
206 * ovs_strlcpy(dst, src, size);
208 * (Thus, ovs_strzcpy() is similar to strncpy() without some of the pitfalls.)
211 ovs_strzcpy(char *dst, const char *src, size_t size)
214 size_t len = strnlen(src, size - 1);
215 memcpy(dst, src, len);
216 memset(dst + len, '\0', size - len);
220 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
221 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
222 * the message inside parentheses. Then, terminates with abort().
224 * This function is preferred to ovs_fatal() in a situation where it would make
225 * sense for a monitoring process to restart the daemon.
227 * 'format' should not end with a new-line, because this function will add one
230 ovs_abort(int err_no, const char *format, ...)
234 va_start(args, format);
235 ovs_abort_valist(err_no, format, args);
238 /* Same as ovs_abort() except that the arguments are supplied as a va_list. */
240 ovs_abort_valist(int err_no, const char *format, va_list args)
242 ovs_error_valist(err_no, format, args);
246 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
247 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
248 * the message inside parentheses. Then, terminates with EXIT_FAILURE.
250 * 'format' should not end with a new-line, because this function will add one
253 ovs_fatal(int err_no, const char *format, ...)
257 va_start(args, format);
258 ovs_fatal_valist(err_no, format, args);
261 /* Same as ovs_fatal() except that the arguments are supplied as a va_list. */
263 ovs_fatal_valist(int err_no, const char *format, va_list args)
265 ovs_error_valist(err_no, format, args);
269 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
270 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
271 * the message inside parentheses.
273 * 'format' should not end with a new-line, because this function will add one
276 ovs_error(int err_no, const char *format, ...)
280 va_start(args, format);
281 ovs_error_valist(err_no, format, args);
285 /* Same as ovs_error() except that the arguments are supplied as a va_list. */
287 ovs_error_valist(int err_no, const char *format, va_list args)
289 const char *subprogram_name = get_subprogram_name();
290 int save_errno = errno;
292 if (subprogram_name[0]) {
293 fprintf(stderr, "%s(%s): ", program_name, subprogram_name);
295 fprintf(stderr, "%s: ", program_name);
298 vfprintf(stderr, format, args);
300 fprintf(stderr, " (%s)", ovs_retval_to_string(err_no));
307 /* Many OVS functions return an int which is one of:
310 * - EOF: end of file (not necessarily an error; depends on the function called)
312 * Returns the appropriate human-readable string. The caller must copy the
313 * string if it wants to hold onto it, as the storage may be overwritten on
314 * subsequent function calls.
317 ovs_retval_to_string(int retval)
320 : retval == EOF ? "End of file"
321 : ovs_strerror(retval));
325 ovs_strerror(int error)
327 enum { BUFSIZE = sizeof strerror_buffer_get()->s };
333 buffer = strerror_buffer_get()->s;
335 #if STRERROR_R_CHAR_P
336 /* GNU style strerror_r() might return an immutable static string, or it
337 * might write and return 'buffer', but in either case we can pass the
338 * returned string directly to the caller. */
339 s = strerror_r(error, buffer, BUFSIZE);
340 #else /* strerror_r() returns an int. */
342 if (strerror_r(error, buffer, BUFSIZE)) {
343 /* strerror_r() is only allowed to fail on ERANGE (because the buffer
344 * is too short). We don't check the actual failure reason because
345 * POSIX requires strerror_r() to return the error but old glibc
346 * (before 2.13) returns -1 and sets errno. */
347 snprintf(buffer, BUFSIZE, "Unknown error %d", error);
356 /* Sets global "program_name" and "program_version" variables. Should
357 * be called at the beginning of main() with "argv[0]" as the argument
360 * 'version' should contain the version of the caller's program. If 'version'
361 * is the same as the VERSION #define, the caller is assumed to be part of Open
362 * vSwitch. Otherwise, it is assumed to be an external program linking against
363 * the Open vSwitch libraries.
365 * The 'date' and 'time' arguments should likely be called with
366 * "__DATE__" and "__TIME__" to use the time the binary was built.
367 * Alternatively, the "set_program_name" macro may be called to do this
371 set_program_name__(const char *argv0, const char *version, const char *date,
374 const char *slash = strrchr(argv0, '/');
376 assert_single_threaded();
378 program_name = slash ? slash + 1 : argv0;
380 free(program_version);
382 if (!strcmp(version, VERSION)) {
383 program_version = xasprintf("%s (Open vSwitch) "VERSION"\n"
385 program_name, date, time);
387 program_version = xasprintf("%s %s\n"
388 "Open vSwitch Library "VERSION"\n"
390 program_name, version, date, time);
394 /* Returns the name of the currently running thread or process. */
396 get_subprogram_name(void)
398 const char *name = subprogram_name_get();
399 return name ? name : "";
402 /* Sets 'name' as the name of the currently running thread or process. (This
403 * appears in log messages and may also be visible in system process listings
406 set_subprogram_name(const char *name)
408 const char *pname = name[0] ? name : program_name;
409 free(subprogram_name_set(xstrdup(name)));
410 #if HAVE_GLIBC_PTHREAD_SETNAME_NP
411 pthread_setname_np(pthread_self(), pname);
412 #elif HAVE_NETBSD_PTHREAD_SETNAME_NP
413 pthread_setname_np(pthread_self(), "%s", pname);
414 #elif HAVE_PTHREAD_SET_NAME_NP
415 pthread_set_name_np(pthread_self(), pname);
419 /* Returns a pointer to a string describing the program version. The
420 * caller must not modify or free the returned string.
423 get_program_version(void)
425 return program_version;
428 /* Print the version information for the program. */
430 ovs_print_version(uint8_t min_ofp, uint8_t max_ofp)
432 printf("%s", program_version);
433 if (min_ofp || max_ofp) {
434 printf("OpenFlow versions %#x:%#x\n", min_ofp, max_ofp);
438 /* Writes the 'size' bytes in 'buf' to 'stream' as hex bytes arranged 16 per
439 * line. Numeric offsets are also included, starting at 'ofs' for the first
440 * byte in 'buf'. If 'ascii' is true then the corresponding ASCII characters
441 * are also rendered alongside. */
443 ovs_hex_dump(FILE *stream, const void *buf_, size_t size,
444 uintptr_t ofs, bool ascii)
446 const uint8_t *buf = buf_;
447 const size_t per_line = 16; /* Maximum bytes per line. */
451 size_t start, end, n;
454 /* Number of bytes on this line. */
455 start = ofs % per_line;
457 if (end - start > size)
462 fprintf(stream, "%08jx ", (uintmax_t) ROUND_DOWN(ofs, per_line));
463 for (i = 0; i < start; i++)
464 fprintf(stream, " ");
466 fprintf(stream, "%02hhx%c",
467 buf[i - start], i == per_line / 2 - 1? '-' : ' ');
470 for (; i < per_line; i++)
471 fprintf(stream, " ");
472 fprintf(stream, "|");
473 for (i = 0; i < start; i++)
474 fprintf(stream, " ");
475 for (; i < end; i++) {
476 int c = buf[i - start];
477 putc(c >= 32 && c < 127 ? c : '.', stream);
479 for (; i < per_line; i++)
480 fprintf(stream, " ");
481 fprintf(stream, "|");
483 fprintf(stream, "\n");
492 str_to_int(const char *s, int base, int *i)
495 bool ok = str_to_llong(s, base, &ll);
501 str_to_long(const char *s, int base, long *li)
504 bool ok = str_to_llong(s, base, &ll);
510 str_to_llong(const char *s, int base, long long *x)
512 int save_errno = errno;
515 *x = strtoll(s, &tail, base);
516 if (errno == EINVAL || errno == ERANGE || tail == s || *tail != '\0') {
527 str_to_uint(const char *s, int base, unsigned int *u)
529 return str_to_int(s, base, (int *) u);
533 str_to_ulong(const char *s, int base, unsigned long *ul)
535 return str_to_long(s, base, (long *) ul);
539 str_to_ullong(const char *s, int base, unsigned long long *ull)
541 return str_to_llong(s, base, (long long *) ull);
544 /* Converts floating-point string 's' into a double. If successful, stores
545 * the double in '*d' and returns true; on failure, stores 0 in '*d' and
548 * Underflow (e.g. "1e-9999") is not considered an error, but overflow
549 * (e.g. "1e9999)" is. */
551 str_to_double(const char *s, double *d)
553 int save_errno = errno;
556 *d = strtod(s, &tail);
557 if (errno == EINVAL || (errno == ERANGE && *d != 0)
558 || tail == s || *tail != '\0') {
568 /* Returns the value of 'c' as a hexadecimal digit. */
573 case '0': case '1': case '2': case '3': case '4':
574 case '5': case '6': case '7': case '8': case '9':
600 /* Returns the integer value of the 'n' hexadecimal digits starting at 's', or
601 * UINT_MAX if one of those "digits" is not really a hex digit. If 'ok' is
602 * nonnull, '*ok' is set to true if the conversion succeeds or to false if a
603 * non-hex digit is detected. */
605 hexits_value(const char *s, size_t n, bool *ok)
611 for (i = 0; i < n; i++) {
612 int hexit = hexit_value(s[i]);
619 value = (value << 4) + hexit;
627 /* Returns the current working directory as a malloc()'d string, or a null
628 * pointer if the current working directory cannot be determined. */
635 /* Get maximum path length or at least a reasonable estimate. */
636 path_max = pathconf(".", _PC_PATH_MAX);
637 size = (path_max < 0 ? 1024
638 : path_max > 10240 ? 10240
641 /* Get current working directory. */
643 char *buf = xmalloc(size);
644 if (getcwd(buf, size)) {
645 return xrealloc(buf, strlen(buf) + 1);
649 if (error != ERANGE) {
650 VLOG_WARN("getcwd failed (%s)", ovs_strerror(error));
659 all_slashes_name(const char *s)
661 return xstrdup(s[0] == '/' && s[1] == '/' && s[2] != '/' ? "//"
666 /* Returns the directory name portion of 'file_name' as a malloc()'d string,
667 * similar to the POSIX dirname() function but thread-safe. */
669 dir_name(const char *file_name)
671 size_t len = strlen(file_name);
672 while (len > 0 && file_name[len - 1] == '/') {
675 while (len > 0 && file_name[len - 1] != '/') {
678 while (len > 0 && file_name[len - 1] == '/') {
681 return len ? xmemdup0(file_name, len) : all_slashes_name(file_name);
684 /* Returns the file name portion of 'file_name' as a malloc()'d string,
685 * similar to the POSIX basename() function but thread-safe. */
687 base_name(const char *file_name)
691 end = strlen(file_name);
692 while (end > 0 && file_name[end - 1] == '/') {
697 return all_slashes_name(file_name);
701 while (start > 0 && file_name[start - 1] != '/') {
705 return xmemdup0(file_name + start, end - start);
708 /* If 'file_name' starts with '/', returns a copy of 'file_name'. Otherwise,
709 * returns an absolute path to 'file_name' considering it relative to 'dir',
710 * which itself must be absolute. 'dir' may be null or the empty string, in
711 * which case the current working directory is used.
713 * Returns a null pointer if 'dir' is null and getcwd() fails. */
715 abs_file_name(const char *dir, const char *file_name)
717 if (file_name[0] == '/') {
718 return xstrdup(file_name);
719 } else if (dir && dir[0]) {
720 char *separator = dir[strlen(dir) - 1] == '/' ? "" : "/";
721 return xasprintf("%s%s%s", dir, separator, file_name);
723 char *cwd = get_cwd();
725 char *abs_name = xasprintf("%s/%s", cwd, file_name);
734 /* Like readlink(), but returns the link name as a null-terminated string in
735 * allocated memory that the caller must eventually free (with free()).
736 * Returns NULL on error, in which case errno is set appropriately. */
738 xreadlink(const char *filename)
742 for (size = 64; ; size *= 2) {
743 char *buf = xmalloc(size);
744 ssize_t retval = readlink(filename, buf, size);
747 if (retval >= 0 && retval < size) {
760 /* Returns a version of 'filename' with symlinks in the final component
761 * dereferenced. This differs from realpath() in that:
763 * - 'filename' need not exist.
765 * - If 'filename' does exist as a symlink, its referent need not exist.
767 * - Only symlinks in the final component of 'filename' are dereferenced.
769 * The caller must eventually free the returned string (with free()). */
771 follow_symlinks(const char *filename)
777 fn = xstrdup(filename);
778 for (i = 0; i < 10; i++) {
782 if (lstat(fn, &s) != 0 || !S_ISLNK(s.st_mode)) {
786 linkname = xreadlink(fn);
788 VLOG_WARN("%s: readlink failed (%s)",
789 filename, ovs_strerror(errno));
793 if (linkname[0] == '/') {
794 /* Target of symlink is absolute so use it raw. */
797 /* Target of symlink is relative so add to 'fn''s directory. */
798 char *dir = dir_name(fn);
800 if (!strcmp(dir, ".")) {
803 char *separator = dir[strlen(dir) - 1] == '/' ? "" : "/";
804 next_fn = xasprintf("%s%s%s", dir, separator, linkname);
815 VLOG_WARN("%s: too many levels of symlinks", filename);
817 return xstrdup(filename);
820 /* Pass a value to this function if it is marked with
821 * __attribute__((warn_unused_result)) and you genuinely want to ignore
822 * its return value. (Note that every scalar type can be implicitly
823 * converted to bool.) */
824 void ignore(bool x OVS_UNUSED) { }
826 /* Returns an appropriate delimiter for inserting just before the 0-based item
827 * 'index' in a list that has 'total' items in it. */
829 english_list_delimiter(size_t index, size_t total)
831 return (index == 0 ? ""
832 : index < total - 1 ? ", "
833 : total > 2 ? ", and "
837 /* Given a 32 bit word 'n', calculates floor(log_2('n')). This is equivalent
838 * to finding the bit position of the most significant one bit in 'n'. It is
839 * an error to call this function with 'n' == 0. */
841 log_2_floor(uint32_t n)
845 #if !defined(UINT_MAX) || !defined(UINT32_MAX)
846 #error "Someone screwed up the #includes."
847 #elif __GNUC__ >= 4 && UINT_MAX == UINT32_MAX
848 return 31 - __builtin_clz(n);
853 #define BIN_SEARCH_STEP(BITS) \
854 if (n >= (1 << BITS)) { \
863 #undef BIN_SEARCH_STEP
869 /* Given a 32 bit word 'n', calculates ceil(log_2('n')). It is an error to
870 * call this function with 'n' == 0. */
872 log_2_ceil(uint32_t n)
874 return log_2_floor(n) + !is_pow2(n);
877 /* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. */
878 #if !defined(UINT_MAX) || !defined(UINT32_MAX)
879 #error "Someone screwed up the #includes."
880 #elif __GNUC__ >= 4 && UINT_MAX == UINT32_MAX
881 /* Defined inline in util.h. */
889 #define CTZ_STEP(X) \
906 /* Returns the number of 1-bits in 'x', between 0 and 32 inclusive. */
910 /* In my testing, this implementation is over twice as fast as any other
911 * portable implementation that I tried, including GCC 4.4
912 * __builtin_popcount(), although nonportable asm("popcnt") was over 50%
915 ((((X) & (1 << 0)) != 0) + \
916 (((X) & (1 << 1)) != 0) + \
917 (((X) & (1 << 2)) != 0) + \
918 (((X) & (1 << 3)) != 0) + \
919 (((X) & (1 << 4)) != 0) + \
920 (((X) & (1 << 5)) != 0) + \
921 (((X) & (1 << 6)) != 0) + \
922 (((X) & (1 << 7)) != 0))
923 #define INIT2(X) INIT1(X), INIT1((X) + 1)
924 #define INIT4(X) INIT2(X), INIT2((X) + 2)
925 #define INIT8(X) INIT4(X), INIT4((X) + 4)
926 #define INIT16(X) INIT8(X), INIT8((X) + 8)
927 #define INIT32(X) INIT16(X), INIT16((X) + 16)
928 #define INIT64(X) INIT32(X), INIT32((X) + 32)
930 static const uint8_t popcount8[256] = {
931 INIT64(0), INIT64(64), INIT64(128), INIT64(192)
934 return (popcount8[x & 0xff] +
935 popcount8[(x >> 8) & 0xff] +
936 popcount8[(x >> 16) & 0xff] +
940 /* Returns true if the 'n' bytes starting at 'p' are zeros. */
942 is_all_zeros(const uint8_t *p, size_t n)
946 for (i = 0; i < n; i++) {
954 /* Returns true if the 'n' bytes starting at 'p' are 0xff. */
956 is_all_ones(const uint8_t *p, size_t n)
960 for (i = 0; i < n; i++) {
968 /* Copies 'n_bits' bits starting from bit 'src_ofs' in 'src' to the 'n_bits'
969 * starting from bit 'dst_ofs' in 'dst'. 'src' is 'src_len' bytes long and
970 * 'dst' is 'dst_len' bytes long.
972 * If you consider all of 'src' to be a single unsigned integer in network byte
973 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
974 * with value 1 in src[src_len - 1], bit 1 is the bit with value 2, bit 2 is
975 * the bit with value 4, ..., bit 8 is the bit with value 1 in src[src_len -
976 * 2], and so on. Similarly for 'dst'.
978 * Required invariants:
979 * src_ofs + n_bits <= src_len * 8
980 * dst_ofs + n_bits <= dst_len * 8
981 * 'src' and 'dst' must not overlap.
984 bitwise_copy(const void *src_, unsigned int src_len, unsigned int src_ofs,
985 void *dst_, unsigned int dst_len, unsigned int dst_ofs,
988 const uint8_t *src = src_;
991 src += src_len - (src_ofs / 8 + 1);
994 dst += dst_len - (dst_ofs / 8 + 1);
997 if (src_ofs == 0 && dst_ofs == 0) {
998 unsigned int n_bytes = n_bits / 8;
1002 memcpy(dst, src, n_bytes);
1009 uint8_t mask = (1 << n_bits) - 1;
1010 *dst = (*dst & ~mask) | (*src & mask);
1013 while (n_bits > 0) {
1014 unsigned int max_copy = 8 - MAX(src_ofs, dst_ofs);
1015 unsigned int chunk = MIN(n_bits, max_copy);
1016 uint8_t mask = ((1 << chunk) - 1) << dst_ofs;
1019 *dst |= ((*src >> src_ofs) << dst_ofs) & mask;
1036 /* Zeros the 'n_bits' bits starting from bit 'dst_ofs' in 'dst'. 'dst' is
1037 * 'dst_len' bytes long.
1039 * If you consider all of 'dst' to be a single unsigned integer in network byte
1040 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1041 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1042 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1045 * Required invariant:
1046 * dst_ofs + n_bits <= dst_len * 8
1049 bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
1050 unsigned int n_bits)
1052 uint8_t *dst = dst_;
1058 dst += dst_len - (dst_ofs / 8 + 1);
1062 unsigned int chunk = MIN(n_bits, 8 - dst_ofs);
1064 *dst &= ~(((1 << chunk) - 1) << dst_ofs);
1074 while (n_bits >= 8) {
1080 *dst &= ~((1 << n_bits) - 1);
1084 /* Sets to 1 all of the 'n_bits' bits starting from bit 'dst_ofs' in 'dst'.
1085 * 'dst' is 'dst_len' bytes long.
1087 * If you consider all of 'dst' to be a single unsigned integer in network byte
1088 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1089 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1090 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1093 * Required invariant:
1094 * dst_ofs + n_bits <= dst_len * 8
1097 bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
1098 unsigned int n_bits)
1100 uint8_t *dst = dst_;
1106 dst += dst_len - (dst_ofs / 8 + 1);
1110 unsigned int chunk = MIN(n_bits, 8 - dst_ofs);
1112 *dst |= ((1 << chunk) - 1) << dst_ofs;
1122 while (n_bits >= 8) {
1128 *dst |= (1 << n_bits) - 1;
1132 /* Scans the 'n_bits' bits starting from bit 'dst_ofs' in 'dst' for 1-bits.
1133 * Returns false if any 1-bits are found, otherwise true. 'dst' is 'dst_len'
1136 * If you consider all of 'dst' to be a single unsigned integer in network byte
1137 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1138 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1139 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1142 * Required invariant:
1143 * dst_ofs + n_bits <= dst_len * 8
1146 bitwise_is_all_zeros(const void *p_, unsigned int len, unsigned int ofs,
1147 unsigned int n_bits)
1149 const uint8_t *p = p_;
1155 p += len - (ofs / 8 + 1);
1159 unsigned int chunk = MIN(n_bits, 8 - ofs);
1161 if (*p & (((1 << chunk) - 1) << ofs)) {
1173 while (n_bits >= 8) {
1181 if (n_bits && *p & ((1 << n_bits) - 1)) {
1188 /* Copies the 'n_bits' low-order bits of 'value' into the 'n_bits' bits
1189 * starting at bit 'dst_ofs' in 'dst', which is 'dst_len' bytes long.
1191 * If you consider all of 'dst' to be a single unsigned integer in network byte
1192 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1193 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1194 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1197 * Required invariants:
1198 * dst_ofs + n_bits <= dst_len * 8
1202 bitwise_put(uint64_t value,
1203 void *dst, unsigned int dst_len, unsigned int dst_ofs,
1204 unsigned int n_bits)
1206 ovs_be64 n_value = htonll(value);
1207 bitwise_copy(&n_value, sizeof n_value, 0,
1208 dst, dst_len, dst_ofs,
1212 /* Returns the value of the 'n_bits' bits starting at bit 'src_ofs' in 'src',
1213 * which is 'src_len' bytes long.
1215 * If you consider all of 'src' to be a single unsigned integer in network byte
1216 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1217 * with value 1 in src[src_len - 1], bit 1 is the bit with value 2, bit 2 is
1218 * the bit with value 4, ..., bit 8 is the bit with value 1 in src[src_len -
1221 * Required invariants:
1222 * src_ofs + n_bits <= src_len * 8
1226 bitwise_get(const void *src, unsigned int src_len,
1227 unsigned int src_ofs, unsigned int n_bits)
1229 ovs_be64 value = htonll(0);
1231 bitwise_copy(src, src_len, src_ofs,
1232 &value, sizeof value, 0,
1234 return ntohll(value);