2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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.
31 #include "byte-order.h"
34 #include "ovs-thread.h"
35 #include "socket-util.h"
36 #include "openvswitch/vlog.h"
37 #ifdef HAVE_PTHREAD_SET_NAME_NP
38 #include <pthread_np.h>
41 VLOG_DEFINE_THIS_MODULE(util);
43 COVERAGE_DEFINE(util_xalloc);
45 /* argv[0] without directory names. */
48 /* Name for the currently running thread or process, for log messages, process
49 * listings, and debuggers. */
50 DEFINE_PER_THREAD_MALLOCED_DATA(char *, subprogram_name);
52 /* --version option output. */
53 static char *program_version;
55 /* Buffer used by ovs_strerror() and ovs_format_message(). */
56 DEFINE_STATIC_PER_THREAD_DATA(struct { char s[128]; },
60 static char *xreadlink(const char *filename);
63 ovs_assert_failure(const char *where, const char *function,
64 const char *condition)
66 /* Prevent an infinite loop (or stack overflow) in case VLOG_ABORT happens
67 * to trigger an assertion failure of its own. */
68 static int reentry = 0;
72 VLOG_ABORT("%s: assertion %s failed in %s()",
73 where, condition, function);
77 fprintf(stderr, "%s: assertion %s failed in %s()",
78 where, condition, function);
89 ovs_abort(0, "virtual memory exhausted");
93 xcalloc(size_t count, size_t size)
95 void *p = count && size ? calloc(count, size) : malloc(1);
96 COVERAGE_INC(util_xalloc);
106 return xcalloc(1, size);
112 void *p = malloc(size ? size : 1);
113 COVERAGE_INC(util_xalloc);
121 xrealloc(void *p, size_t size)
123 p = realloc(p, size ? size : 1);
124 COVERAGE_INC(util_xalloc);
132 xmemdup(const void *p_, size_t size)
134 void *p = xmalloc(size);
140 xmemdup0(const char *p_, size_t length)
142 char *p = xmalloc(length + 1);
143 memcpy(p, p_, length);
149 xstrdup(const char *s)
151 return xmemdup0(s, strlen(s));
155 xvasprintf(const char *format, va_list args)
161 va_copy(args2, args);
162 needed = vsnprintf(NULL, 0, format, args);
164 s = xmalloc(needed + 1);
166 vsnprintf(s, needed + 1, format, args2);
173 x2nrealloc(void *p, size_t *n, size_t s)
175 *n = *n == 0 ? 1 : 2 * *n;
176 return xrealloc(p, *n * s);
179 /* The desired minimum alignment for an allocated block of memory. */
180 #define MEM_ALIGN MAX(sizeof(void *), 8)
181 BUILD_ASSERT_DECL(IS_POW2(MEM_ALIGN));
182 BUILD_ASSERT_DECL(CACHE_LINE_SIZE >= MEM_ALIGN);
184 /* Allocates and returns 'size' bytes of memory in dedicated cache lines. That
185 * is, the memory block returned will not share a cache line with other data,
186 * avoiding "false sharing". (The memory returned will not be at the start of
187 * a cache line, though, so don't assume such alignment.)
189 * Use free_cacheline() to free the returned memory block. */
191 xmalloc_cacheline(size_t size)
193 #ifdef HAVE_POSIX_MEMALIGN
197 COVERAGE_INC(util_xalloc);
198 error = posix_memalign(&p, CACHE_LINE_SIZE, size ? size : 1);
207 /* Allocate room for:
209 * - Up to CACHE_LINE_SIZE - 1 bytes before the payload, so that the
210 * start of the payload doesn't potentially share a cache line.
212 * - A payload consisting of a void *, followed by padding out to
213 * MEM_ALIGN bytes, followed by 'size' bytes of user data.
215 * - Space following the payload up to the end of the cache line, so
216 * that the end of the payload doesn't potentially share a cache line
217 * with some following block. */
218 base = xmalloc((CACHE_LINE_SIZE - 1)
219 + ROUND_UP(MEM_ALIGN + size, CACHE_LINE_SIZE));
221 /* Locate the payload and store a pointer to the base at the beginning. */
222 payload = (void **) ROUND_UP((uintptr_t) base, CACHE_LINE_SIZE);
225 return (char *) payload + MEM_ALIGN;
229 /* Like xmalloc_cacheline() but clears the allocated memory to all zero
232 xzalloc_cacheline(size_t size)
234 void *p = xmalloc_cacheline(size);
239 /* Frees a memory block allocated with xmalloc_cacheline() or
240 * xzalloc_cacheline(). */
242 free_cacheline(void *p)
244 #ifdef HAVE_POSIX_MEMALIGN
248 free(*(void **) ((uintptr_t) p - MEM_ALIGN));
254 xasprintf(const char *format, ...)
259 va_start(args, format);
260 s = xvasprintf(format, args);
266 /* Similar to strlcpy() from OpenBSD, but it never reads more than 'size - 1'
267 * bytes from 'src' and doesn't return anything. */
269 ovs_strlcpy(char *dst, const char *src, size_t size)
272 size_t len = strnlen(src, size - 1);
273 memcpy(dst, src, len);
278 /* Copies 'src' to 'dst'. Reads no more than 'size - 1' bytes from 'src'.
279 * Always null-terminates 'dst' (if 'size' is nonzero), and writes a zero byte
280 * to every otherwise unused byte in 'dst'.
282 * Except for performance, the following call:
283 * ovs_strzcpy(dst, src, size);
284 * is equivalent to these two calls:
285 * memset(dst, '\0', size);
286 * ovs_strlcpy(dst, src, size);
288 * (Thus, ovs_strzcpy() is similar to strncpy() without some of the pitfalls.)
291 ovs_strzcpy(char *dst, const char *src, size_t size)
294 size_t len = strnlen(src, size - 1);
295 memcpy(dst, src, len);
296 memset(dst + len, '\0', size - len);
300 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
301 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
302 * the message inside parentheses. Then, terminates with abort().
304 * This function is preferred to ovs_fatal() in a situation where it would make
305 * sense for a monitoring process to restart the daemon.
307 * 'format' should not end with a new-line, because this function will add one
310 ovs_abort(int err_no, const char *format, ...)
314 va_start(args, format);
315 ovs_abort_valist(err_no, format, args);
318 /* Same as ovs_abort() except that the arguments are supplied as a va_list. */
320 ovs_abort_valist(int err_no, const char *format, va_list args)
322 ovs_error_valist(err_no, format, args);
326 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
327 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
328 * the message inside parentheses. Then, terminates with EXIT_FAILURE.
330 * 'format' should not end with a new-line, because this function will add one
333 ovs_fatal(int err_no, const char *format, ...)
337 va_start(args, format);
338 ovs_fatal_valist(err_no, format, args);
341 /* Same as ovs_fatal() except that the arguments are supplied as a va_list. */
343 ovs_fatal_valist(int err_no, const char *format, va_list args)
345 ovs_error_valist(err_no, format, args);
349 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
350 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
351 * the message inside parentheses.
353 * 'format' should not end with a new-line, because this function will add one
356 ovs_error(int err_no, const char *format, ...)
360 va_start(args, format);
361 ovs_error_valist(err_no, format, args);
365 /* Same as ovs_error() except that the arguments are supplied as a va_list. */
367 ovs_error_valist(int err_no, const char *format, va_list args)
369 const char *subprogram_name = get_subprogram_name();
370 int save_errno = errno;
372 if (subprogram_name[0]) {
373 fprintf(stderr, "%s(%s): ", program_name, subprogram_name);
375 fprintf(stderr, "%s: ", program_name);
378 vfprintf(stderr, format, args);
380 fprintf(stderr, " (%s)", ovs_retval_to_string(err_no));
387 /* Many OVS functions return an int which is one of:
390 * - EOF: end of file (not necessarily an error; depends on the function called)
392 * Returns the appropriate human-readable string. The caller must copy the
393 * string if it wants to hold onto it, as the storage may be overwritten on
394 * subsequent function calls.
397 ovs_retval_to_string(int retval)
400 : retval == EOF ? "End of file"
401 : ovs_strerror(retval));
404 /* This function returns the string describing the error number in 'error'
405 * for POSIX platforms. For Windows, this function can be used for C library
406 * calls. For socket calls that are also used in Windows, use sock_strerror()
407 * instead. For WINAPI calls, look at ovs_lasterror_to_string(). */
409 ovs_strerror(int error)
411 enum { BUFSIZE = sizeof strerror_buffer_get()->s };
417 buffer = strerror_buffer_get()->s;
419 #if STRERROR_R_CHAR_P
420 /* GNU style strerror_r() might return an immutable static string, or it
421 * might write and return 'buffer', but in either case we can pass the
422 * returned string directly to the caller. */
423 s = strerror_r(error, buffer, BUFSIZE);
424 #else /* strerror_r() returns an int. */
426 if (strerror_r(error, buffer, BUFSIZE)) {
427 /* strerror_r() is only allowed to fail on ERANGE (because the buffer
428 * is too short). We don't check the actual failure reason because
429 * POSIX requires strerror_r() to return the error but old glibc
430 * (before 2.13) returns -1 and sets errno. */
431 snprintf(buffer, BUFSIZE, "Unknown error %d", error);
440 /* Sets global "program_name" and "program_version" variables. Should
441 * be called at the beginning of main() with "argv[0]" as the argument
444 * 'version' should contain the version of the caller's program. If 'version'
445 * is the same as the VERSION #define, the caller is assumed to be part of Open
446 * vSwitch. Otherwise, it is assumed to be an external program linking against
447 * the Open vSwitch libraries.
449 * The 'date' and 'time' arguments should likely be called with
450 * "__DATE__" and "__TIME__" to use the time the binary was built.
451 * Alternatively, the "ovs_set_program_name" macro may be called to do this
455 ovs_set_program_name__(const char *argv0, const char *version, const char *date,
460 size_t max_len = strlen(argv0) + 1;
462 SetErrorMode(GetErrorMode() | SEM_NOGPFAULTERRORBOX);
463 _set_output_format(_TWO_DIGIT_EXPONENT);
465 basename = xmalloc(max_len);
466 _splitpath_s(argv0, NULL, 0, NULL, 0, basename, max_len, NULL, 0);
468 const char *slash = strrchr(argv0, '/');
469 basename = xstrdup(slash ? slash + 1 : argv0);
472 assert_single_threaded();
474 /* Remove libtool prefix, if it is there */
475 if (strncmp(basename, "lt-", 3) == 0) {
476 char *tmp_name = basename;
477 basename = xstrdup(basename + 3);
480 program_name = basename;
482 free(program_version);
483 if (!strcmp(version, VERSION)) {
484 program_version = xasprintf("%s (Open vSwitch) "VERSION"\n"
486 program_name, date, time);
488 program_version = xasprintf("%s %s\n"
489 "Open vSwitch Library "VERSION"\n"
491 program_name, version, date, time);
495 /* Returns the name of the currently running thread or process. */
497 get_subprogram_name(void)
499 const char *name = subprogram_name_get();
500 return name ? name : "";
503 /* Sets the formatted value of 'format' as the name of the currently running
504 * thread or process. (This appears in log messages and may also be visible in
505 * system process listings and debuggers.) */
507 set_subprogram_name(const char *format, ...)
514 va_start(args, format);
515 pname = xvasprintf(format, args);
518 pname = xstrdup(program_name);
521 free(subprogram_name_set(pname));
523 #if HAVE_GLIBC_PTHREAD_SETNAME_NP
524 pthread_setname_np(pthread_self(), pname);
525 #elif HAVE_NETBSD_PTHREAD_SETNAME_NP
526 pthread_setname_np(pthread_self(), "%s", pname);
527 #elif HAVE_PTHREAD_SET_NAME_NP
528 pthread_set_name_np(pthread_self(), pname);
532 /* Returns a pointer to a string describing the program version. The
533 * caller must not modify or free the returned string.
536 ovs_get_program_version(void)
538 return program_version;
541 /* Returns a pointer to a string describing the program name. The
542 * caller must not modify or free the returned string.
545 ovs_get_program_name(void)
550 /* Print the version information for the program. */
552 ovs_print_version(uint8_t min_ofp, uint8_t max_ofp)
554 printf("%s", program_version);
555 if (min_ofp || max_ofp) {
556 printf("OpenFlow versions %#x:%#x\n", min_ofp, max_ofp);
560 /* Writes the 'size' bytes in 'buf' to 'stream' as hex bytes arranged 16 per
561 * line. Numeric offsets are also included, starting at 'ofs' for the first
562 * byte in 'buf'. If 'ascii' is true then the corresponding ASCII characters
563 * are also rendered alongside. */
565 ovs_hex_dump(FILE *stream, const void *buf_, size_t size,
566 uintptr_t ofs, bool ascii)
568 const uint8_t *buf = buf_;
569 const size_t per_line = 16; /* Maximum bytes per line. */
573 size_t start, end, n;
576 /* Number of bytes on this line. */
577 start = ofs % per_line;
579 if (end - start > size)
584 fprintf(stream, "%08"PRIxMAX" ", (uintmax_t) ROUND_DOWN(ofs, per_line));
585 for (i = 0; i < start; i++)
586 fprintf(stream, " ");
588 fprintf(stream, "%02x%c",
589 buf[i - start], i == per_line / 2 - 1? '-' : ' ');
592 for (; i < per_line; i++)
593 fprintf(stream, " ");
594 fprintf(stream, "|");
595 for (i = 0; i < start; i++)
596 fprintf(stream, " ");
597 for (; i < end; i++) {
598 int c = buf[i - start];
599 putc(c >= 32 && c < 127 ? c : '.', stream);
601 for (; i < per_line; i++)
602 fprintf(stream, " ");
603 fprintf(stream, "|");
605 fprintf(stream, "\n");
614 str_to_int(const char *s, int base, int *i)
617 bool ok = str_to_llong(s, base, &ll);
623 str_to_long(const char *s, int base, long *li)
626 bool ok = str_to_llong(s, base, &ll);
632 str_to_llong(const char *s, int base, long long *x)
634 int save_errno = errno;
637 *x = strtoll(s, &tail, base);
638 if (errno == EINVAL || errno == ERANGE || tail == s || *tail != '\0') {
649 str_to_uint(const char *s, int base, unsigned int *u)
652 bool ok = str_to_llong(s, base, &ll);
653 if (!ok || ll < 0 || ll > UINT_MAX) {
662 /* Converts floating-point string 's' into a double. If successful, stores
663 * the double in '*d' and returns true; on failure, stores 0 in '*d' and
666 * Underflow (e.g. "1e-9999") is not considered an error, but overflow
667 * (e.g. "1e9999)" is. */
669 str_to_double(const char *s, double *d)
671 int save_errno = errno;
674 *d = strtod(s, &tail);
675 if (errno == EINVAL || (errno == ERANGE && *d != 0)
676 || tail == s || *tail != '\0') {
686 /* Returns the value of 'c' as a hexadecimal digit. */
691 case '0': case '1': case '2': case '3': case '4':
692 case '5': case '6': case '7': case '8': case '9':
718 /* Returns the integer value of the 'n' hexadecimal digits starting at 's', or
719 * UINTMAX_MAX if one of those "digits" is not really a hex digit. Sets '*ok'
720 * to true if the conversion succeeds or to false if a non-hex digit is
723 hexits_value(const char *s, size_t n, bool *ok)
729 for (i = 0; i < n; i++) {
730 int hexit = hexit_value(s[i]);
735 value = (value << 4) + hexit;
741 /* Returns the current working directory as a malloc()'d string, or a null
742 * pointer if the current working directory cannot be determined. */
749 /* Get maximum path length or at least a reasonable estimate. */
751 path_max = pathconf(".", _PC_PATH_MAX);
755 size = (path_max < 0 ? 1024
756 : path_max > 10240 ? 10240
759 /* Get current working directory. */
761 char *buf = xmalloc(size);
762 if (getcwd(buf, size)) {
763 return xrealloc(buf, strlen(buf) + 1);
767 if (error != ERANGE) {
768 VLOG_WARN("getcwd failed (%s)", ovs_strerror(error));
777 all_slashes_name(const char *s)
779 return xstrdup(s[0] == '/' && s[1] == '/' && s[2] != '/' ? "//"
785 /* Returns the directory name portion of 'file_name' as a malloc()'d string,
786 * similar to the POSIX dirname() function but thread-safe. */
788 dir_name(const char *file_name)
790 size_t len = strlen(file_name);
791 while (len > 0 && file_name[len - 1] == '/') {
794 while (len > 0 && file_name[len - 1] != '/') {
797 while (len > 0 && file_name[len - 1] == '/') {
800 return len ? xmemdup0(file_name, len) : all_slashes_name(file_name);
803 /* Returns the file name portion of 'file_name' as a malloc()'d string,
804 * similar to the POSIX basename() function but thread-safe. */
806 base_name(const char *file_name)
810 end = strlen(file_name);
811 while (end > 0 && file_name[end - 1] == '/') {
816 return all_slashes_name(file_name);
820 while (start > 0 && file_name[start - 1] != '/') {
824 return xmemdup0(file_name + start, end - start);
828 /* If 'file_name' starts with '/', returns a copy of 'file_name'. Otherwise,
829 * returns an absolute path to 'file_name' considering it relative to 'dir',
830 * which itself must be absolute. 'dir' may be null or the empty string, in
831 * which case the current working directory is used.
833 * Returns a null pointer if 'dir' is null and getcwd() fails. */
835 abs_file_name(const char *dir, const char *file_name)
837 if (file_name[0] == '/') {
838 return xstrdup(file_name);
839 } else if (dir && dir[0]) {
840 char *separator = dir[strlen(dir) - 1] == '/' ? "" : "/";
841 return xasprintf("%s%s%s", dir, separator, file_name);
843 char *cwd = get_cwd();
845 char *abs_name = xasprintf("%s/%s", cwd, file_name);
854 /* Like readlink(), but returns the link name as a null-terminated string in
855 * allocated memory that the caller must eventually free (with free()).
856 * Returns NULL on error, in which case errno is set appropriately. */
858 xreadlink(const char *filename)
862 for (size = 64; ; size *= 2) {
863 char *buf = xmalloc(size);
864 ssize_t retval = readlink(filename, buf, size);
867 if (retval >= 0 && retval < size) {
880 /* Returns a version of 'filename' with symlinks in the final component
881 * dereferenced. This differs from realpath() in that:
883 * - 'filename' need not exist.
885 * - If 'filename' does exist as a symlink, its referent need not exist.
887 * - Only symlinks in the final component of 'filename' are dereferenced.
889 * For Windows platform, this function returns a string that has the same
890 * value as the passed string.
892 * The caller must eventually free the returned string (with free()). */
894 follow_symlinks(const char *filename)
901 fn = xstrdup(filename);
902 for (i = 0; i < 10; i++) {
906 if (lstat(fn, &s) != 0 || !S_ISLNK(s.st_mode)) {
910 linkname = xreadlink(fn);
912 VLOG_WARN("%s: readlink failed (%s)",
913 filename, ovs_strerror(errno));
917 if (linkname[0] == '/') {
918 /* Target of symlink is absolute so use it raw. */
921 /* Target of symlink is relative so add to 'fn''s directory. */
922 char *dir = dir_name(fn);
924 if (!strcmp(dir, ".")) {
927 char *separator = dir[strlen(dir) - 1] == '/' ? "" : "/";
928 next_fn = xasprintf("%s%s%s", dir, separator, linkname);
939 VLOG_WARN("%s: too many levels of symlinks", filename);
942 return xstrdup(filename);
945 /* Pass a value to this function if it is marked with
946 * __attribute__((warn_unused_result)) and you genuinely want to ignore
947 * its return value. (Note that every scalar type can be implicitly
948 * converted to bool.) */
949 void ignore(bool x OVS_UNUSED) { }
951 /* Returns an appropriate delimiter for inserting just before the 0-based item
952 * 'index' in a list that has 'total' items in it. */
954 english_list_delimiter(size_t index, size_t total)
956 return (index == 0 ? ""
957 : index < total - 1 ? ", "
958 : total > 2 ? ", and "
962 /* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. */
963 #if __GNUC__ >= 4 || _MSC_VER
964 /* Defined inline in util.h. */
966 /* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. */
973 #define CTZ_STEP(X) \
990 /* Returns the number of leading 0-bits in 'n'. Undefined if 'n' == 0. */
992 raw_clz64(uint64_t n)
997 #define CLZ_STEP(X) \
1015 #if NEED_COUNT_1BITS_8
1017 ((((X) & (1 << 0)) != 0) + \
1018 (((X) & (1 << 1)) != 0) + \
1019 (((X) & (1 << 2)) != 0) + \
1020 (((X) & (1 << 3)) != 0) + \
1021 (((X) & (1 << 4)) != 0) + \
1022 (((X) & (1 << 5)) != 0) + \
1023 (((X) & (1 << 6)) != 0) + \
1024 (((X) & (1 << 7)) != 0))
1025 #define INIT2(X) INIT1(X), INIT1((X) + 1)
1026 #define INIT4(X) INIT2(X), INIT2((X) + 2)
1027 #define INIT8(X) INIT4(X), INIT4((X) + 4)
1028 #define INIT16(X) INIT8(X), INIT8((X) + 8)
1029 #define INIT32(X) INIT16(X), INIT16((X) + 16)
1030 #define INIT64(X) INIT32(X), INIT32((X) + 32)
1032 const uint8_t count_1bits_8[256] = {
1033 INIT64(0), INIT64(64), INIT64(128), INIT64(192)
1037 /* Returns true if the 'n' bytes starting at 'p' are zeros. */
1039 is_all_zeros(const void *p_, size_t n)
1041 const uint8_t *p = p_;
1044 for (i = 0; i < n; i++) {
1052 /* Returns true if the 'n' bytes starting at 'p' are 0xff. */
1054 is_all_ones(const void *p_, size_t n)
1056 const uint8_t *p = p_;
1059 for (i = 0; i < n; i++) {
1067 /* Copies 'n_bits' bits starting from bit 'src_ofs' in 'src' to the 'n_bits'
1068 * starting from bit 'dst_ofs' in 'dst'. 'src' is 'src_len' bytes long and
1069 * 'dst' is 'dst_len' bytes long.
1071 * If you consider all of 'src' to be a single unsigned integer in network byte
1072 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1073 * with value 1 in src[src_len - 1], bit 1 is the bit with value 2, bit 2 is
1074 * the bit with value 4, ..., bit 8 is the bit with value 1 in src[src_len -
1075 * 2], and so on. Similarly for 'dst'.
1077 * Required invariants:
1078 * src_ofs + n_bits <= src_len * 8
1079 * dst_ofs + n_bits <= dst_len * 8
1080 * 'src' and 'dst' must not overlap.
1083 bitwise_copy(const void *src_, unsigned int src_len, unsigned int src_ofs,
1084 void *dst_, unsigned int dst_len, unsigned int dst_ofs,
1085 unsigned int n_bits)
1087 const uint8_t *src = src_;
1088 uint8_t *dst = dst_;
1090 src += src_len - (src_ofs / 8 + 1);
1093 dst += dst_len - (dst_ofs / 8 + 1);
1096 if (src_ofs == 0 && dst_ofs == 0) {
1097 unsigned int n_bytes = n_bits / 8;
1101 memcpy(dst, src, n_bytes);
1108 uint8_t mask = (1 << n_bits) - 1;
1109 *dst = (*dst & ~mask) | (*src & mask);
1112 while (n_bits > 0) {
1113 unsigned int max_copy = 8 - MAX(src_ofs, dst_ofs);
1114 unsigned int chunk = MIN(n_bits, max_copy);
1115 uint8_t mask = ((1 << chunk) - 1) << dst_ofs;
1118 *dst |= ((*src >> src_ofs) << dst_ofs) & mask;
1135 /* Zeros the 'n_bits' bits starting from bit 'dst_ofs' in 'dst'. 'dst' is
1136 * 'dst_len' bytes long.
1138 * If you consider all of 'dst' to be a single unsigned integer in network byte
1139 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1140 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1141 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1144 * Required invariant:
1145 * dst_ofs + n_bits <= dst_len * 8
1148 bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
1149 unsigned int n_bits)
1151 uint8_t *dst = dst_;
1157 dst += dst_len - (dst_ofs / 8 + 1);
1161 unsigned int chunk = MIN(n_bits, 8 - dst_ofs);
1163 *dst &= ~(((1 << chunk) - 1) << dst_ofs);
1173 while (n_bits >= 8) {
1179 *dst &= ~((1 << n_bits) - 1);
1183 /* Sets to 1 all of the 'n_bits' bits starting from bit 'dst_ofs' in 'dst'.
1184 * 'dst' is 'dst_len' bytes long.
1186 * If you consider all of 'dst' to be a single unsigned integer in network byte
1187 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1188 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1189 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1192 * Required invariant:
1193 * dst_ofs + n_bits <= dst_len * 8
1196 bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
1197 unsigned int n_bits)
1199 uint8_t *dst = dst_;
1205 dst += dst_len - (dst_ofs / 8 + 1);
1209 unsigned int chunk = MIN(n_bits, 8 - dst_ofs);
1211 *dst |= ((1 << chunk) - 1) << dst_ofs;
1221 while (n_bits >= 8) {
1227 *dst |= (1 << n_bits) - 1;
1231 /* Scans the 'n_bits' bits starting from bit 'dst_ofs' in 'dst' for 1-bits.
1232 * Returns false if any 1-bits are found, otherwise true. 'dst' is 'dst_len'
1235 * If you consider all of 'dst' to be a single unsigned integer in network byte
1236 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1237 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1238 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1241 * Required invariant:
1242 * dst_ofs + n_bits <= dst_len * 8
1245 bitwise_is_all_zeros(const void *p_, unsigned int len, unsigned int ofs,
1246 unsigned int n_bits)
1248 const uint8_t *p = p_;
1254 p += len - (ofs / 8 + 1);
1258 unsigned int chunk = MIN(n_bits, 8 - ofs);
1260 if (*p & (((1 << chunk) - 1) << ofs)) {
1272 while (n_bits >= 8) {
1280 if (n_bits && *p & ((1 << n_bits) - 1)) {
1287 /* Scans the bits in 'p' that have bit offsets 'start' through 'end'
1288 * (inclusive) for the first bit with value 'target'. If one is found, returns
1289 * its offset, otherwise 'end'. 'p' is 'len' bytes long.
1291 * If you consider all of 'p' to be a single unsigned integer in network byte
1292 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1293 * with value 1 in p[len - 1], bit 1 is the bit with value 2, bit 2 is the bit
1294 * with value 4, ..., bit 8 is the bit with value 1 in p[len - 2], and so on.
1296 * Required invariant:
1300 bitwise_scan(const void *p_, unsigned int len, bool target, unsigned int start,
1303 const uint8_t *p = p_;
1306 for (ofs = start; ofs < end; ofs++) {
1307 bool bit = (p[len - (ofs / 8 + 1)] & (1u << (ofs % 8))) != 0;
1308 if (bit == target) {
1316 /* Copies the 'n_bits' low-order bits of 'value' into the 'n_bits' bits
1317 * starting at bit 'dst_ofs' in 'dst', which is 'dst_len' bytes long.
1319 * If you consider all of 'dst' to be a single unsigned integer in network byte
1320 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1321 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1322 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1325 * Required invariants:
1326 * dst_ofs + n_bits <= dst_len * 8
1330 bitwise_put(uint64_t value,
1331 void *dst, unsigned int dst_len, unsigned int dst_ofs,
1332 unsigned int n_bits)
1334 ovs_be64 n_value = htonll(value);
1335 bitwise_copy(&n_value, sizeof n_value, 0,
1336 dst, dst_len, dst_ofs,
1340 /* Returns the value of the 'n_bits' bits starting at bit 'src_ofs' in 'src',
1341 * which is 'src_len' bytes long.
1343 * If you consider all of 'src' to be a single unsigned integer in network byte
1344 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1345 * with value 1 in src[src_len - 1], bit 1 is the bit with value 2, bit 2 is
1346 * the bit with value 4, ..., bit 8 is the bit with value 1 in src[src_len -
1349 * Required invariants:
1350 * src_ofs + n_bits <= src_len * 8
1354 bitwise_get(const void *src, unsigned int src_len,
1355 unsigned int src_ofs, unsigned int n_bits)
1357 ovs_be64 value = htonll(0);
1359 bitwise_copy(src, src_len, src_ofs,
1360 &value, sizeof value, 0,
1362 return ntohll(value);
1383 skip_spaces(const char *s)
1385 while (isspace((unsigned char) *s)) {
1392 scan_int(const char *s, const struct scan_spec *spec, int base, va_list *args)
1394 const char *start = s;
1399 negative = *s == '-';
1400 s += *s == '-' || *s == '+';
1402 if ((!base || base == 16) && *s == '0' && (s[1] == 'x' || s[1] == 'X')) {
1406 base = *s == '0' ? 8 : 10;
1409 if (s - start >= spec->width) {
1415 while (s - start < spec->width) {
1416 int digit = hexit_value(*s);
1418 if (digit < 0 || digit >= base) {
1421 value = value * base + digit;
1433 switch (spec->type) {
1437 *va_arg(*args, char *) = value;
1440 *va_arg(*args, short int *) = value;
1443 *va_arg(*args, int *) = value;
1446 *va_arg(*args, long int *) = value;
1449 *va_arg(*args, long long int *) = value;
1452 *va_arg(*args, intmax_t *) = value;
1454 case SCAN_PTRDIFF_T:
1455 *va_arg(*args, ptrdiff_t *) = value;
1458 *va_arg(*args, size_t *) = value;
1465 skip_digits(const char *s)
1467 while (*s >= '0' && *s <= '9') {
1474 scan_float(const char *s, const struct scan_spec *spec, va_list *args)
1476 const char *start = s;
1482 s += *s == '+' || *s == '-';
1485 s = skip_digits(s + 1);
1487 if (*s == 'e' || *s == 'E') {
1489 s += *s == '+' || *s == '-';
1493 if (s - start > spec->width) {
1494 s = start + spec->width;
1497 copy = xmemdup0(start, s - start);
1498 value = strtold(copy, &tail);
1505 switch (spec->type) {
1509 *va_arg(*args, float *) = value;
1512 *va_arg(*args, double *) = value;
1515 *va_arg(*args, long double *) = value;
1521 case SCAN_PTRDIFF_T:
1529 scan_output_string(const struct scan_spec *spec,
1530 const char *s, size_t n,
1533 if (spec->type != SCAN_DISCARD) {
1534 char *out = va_arg(*args, char *);
1541 scan_string(const char *s, const struct scan_spec *spec, va_list *args)
1545 for (n = 0; n < spec->width; n++) {
1546 if (!s[n] || isspace((unsigned char) s[n])) {
1554 scan_output_string(spec, s, n, args);
1559 parse_scanset(const char *p_, unsigned long *set, bool *complemented)
1561 const uint8_t *p = (const uint8_t *) p_;
1563 *complemented = *p == '^';
1567 bitmap_set1(set, ']');
1571 while (*p && *p != ']') {
1572 if (p[1] == '-' && p[2] != ']' && p[2] > *p) {
1573 bitmap_set_multiple(set, *p, p[2] - *p + 1, true);
1576 bitmap_set1(set, *p++);
1582 return (const char *) p;
1586 scan_set(const char *s, const struct scan_spec *spec, const char **pp,
1589 unsigned long set[BITMAP_N_LONGS(UCHAR_MAX + 1)];
1593 /* Parse the scan set. */
1594 memset(set, 0, sizeof set);
1595 *pp = parse_scanset(*pp, set, &complemented);
1597 /* Parse the data. */
1600 && bitmap_is_set(set, (unsigned char) s[n]) == !complemented
1601 && n < spec->width) {
1607 scan_output_string(spec, s, n, args);
1612 scan_chars(const char *s, const struct scan_spec *spec, va_list *args)
1614 unsigned int n = spec->width == UINT_MAX ? 1 : spec->width;
1616 if (strlen(s) < n) {
1619 if (spec->type != SCAN_DISCARD) {
1620 memcpy(va_arg(*args, char *), s, n);
1626 ovs_scan__(const char *s, int *n, const char *format, va_list *args)
1628 const char *const start = s;
1633 while (*p != '\0') {
1634 struct scan_spec spec;
1635 unsigned char c = *p++;
1641 } else if (c != '%') {
1647 } else if (*p == '%') {
1655 /* Parse '*' flag. */
1656 discard = *p == '*';
1659 /* Parse field width. */
1661 while (*p >= '0' && *p <= '9') {
1662 spec.width = spec.width * 10 + (*p++ - '0');
1664 if (spec.width == 0) {
1665 spec.width = UINT_MAX;
1668 /* Parse type modifier. */
1672 spec.type = SCAN_CHAR;
1675 spec.type = SCAN_SHORT;
1681 spec.type = SCAN_INTMAX_T;
1687 spec.type = SCAN_LLONG;
1690 spec.type = SCAN_LONG;
1697 spec.type = SCAN_LLONG;
1702 spec.type = SCAN_PTRDIFF_T;
1707 spec.type = SCAN_SIZE_T;
1712 spec.type = SCAN_INT;
1717 spec.type = SCAN_DISCARD;
1721 if (c != 'c' && c != 'n' && c != '[') {
1726 s = scan_int(s, &spec, 10, args);
1730 s = scan_int(s, &spec, 0, args);
1734 s = scan_int(s, &spec, 8, args);
1738 s = scan_int(s, &spec, 10, args);
1743 s = scan_int(s, &spec, 16, args);
1751 s = scan_float(s, &spec, args);
1755 s = scan_string(s, &spec, args);
1759 s = scan_set(s, &spec, &p, args);
1763 s = scan_chars(s, &spec, args);
1767 if (spec.type != SCAN_DISCARD) {
1768 *va_arg(*args, int *) = s - start;
1786 /* This is an implementation of the standard sscanf() function, with the
1787 * following exceptions:
1789 * - It returns true if the entire format was successfully scanned and
1790 * converted, false if any conversion failed.
1792 * - The standard doesn't define sscanf() behavior when an out-of-range value
1793 * is scanned, e.g. if a "%"PRIi8 conversion scans "-1" or "0x1ff". Some
1794 * implementations consider this an error and stop scanning. This
1795 * implementation never considers an out-of-range value an error; instead,
1796 * it stores the least-significant bits of the converted value in the
1797 * destination, e.g. the value 255 for both examples earlier.
1799 * - Only single-byte characters are supported, that is, the 'l' modifier
1800 * on %s, %[, and %c is not supported. The GNU extension 'a' modifier is
1801 * also not supported.
1803 * - %p is not supported.
1806 ovs_scan(const char *s, const char *format, ...)
1811 va_start(args, format);
1812 res = ovs_scan__(s, NULL, format, &args);
1818 * This function is similar to ocs_scan(), extra parameter `n` is added to
1819 * return number of scanned characters.
1822 ovs_scan_len(const char *s, int *n, const char *format, ...)
1828 va_start(args, format);
1829 success = ovs_scan__(s + *n, &n1, format, &args);
1838 xsleep(unsigned int seconds)
1840 ovsrcu_quiesce_start();
1842 Sleep(seconds * 1000);
1846 ovsrcu_quiesce_end();
1852 ovs_format_message(int error)
1854 enum { BUFSIZE = sizeof strerror_buffer_get()->s };
1855 char *buffer = strerror_buffer_get()->s;
1857 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
1858 NULL, error, 0, buffer, BUFSIZE, NULL);
1862 /* Returns a null-terminated string that explains the last error.
1863 * Use this function to get the error string for WINAPI calls. */
1865 ovs_lasterror_to_string(void)
1867 return ovs_format_message(GetLastError());
1871 ftruncate(int fd, off_t length)
1875 error = _chsize_s(fd, length);
1882 OVS_CONSTRUCTOR(winsock_start) {
1886 error = WSAStartup(MAKEWORD(2, 2), &wsaData);
1888 VLOG_FATAL("WSAStartup failed: %s", sock_strerror(sock_errno()));