2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 nullable_xstrdup(const char *s
)
157 return s
? xstrdup(s
) : NULL
;
161 nullable_string_is_equal(const char *a
, const char *b
)
163 return a
? b
&& !strcmp(a
, b
) : !b
;
167 xvasprintf(const char *format
, va_list args
)
173 va_copy(args2
, args
);
174 needed
= vsnprintf(NULL
, 0, format
, args
);
176 s
= xmalloc(needed
+ 1);
178 vsnprintf(s
, needed
+ 1, format
, args2
);
185 x2nrealloc(void *p
, size_t *n
, size_t s
)
187 *n
= *n
== 0 ? 1 : 2 * *n
;
188 return xrealloc(p
, *n
* s
);
191 /* The desired minimum alignment for an allocated block of memory. */
192 #define MEM_ALIGN MAX(sizeof(void *), 8)
193 BUILD_ASSERT_DECL(IS_POW2(MEM_ALIGN
));
194 BUILD_ASSERT_DECL(CACHE_LINE_SIZE
>= MEM_ALIGN
);
196 /* Allocates and returns 'size' bytes of memory in dedicated cache lines. That
197 * is, the memory block returned will not share a cache line with other data,
198 * avoiding "false sharing". (The memory returned will not be at the start of
199 * a cache line, though, so don't assume such alignment.)
201 * Use free_cacheline() to free the returned memory block. */
203 xmalloc_cacheline(size_t size
)
205 #ifdef HAVE_POSIX_MEMALIGN
209 COVERAGE_INC(util_xalloc
);
210 error
= posix_memalign(&p
, CACHE_LINE_SIZE
, size
? size
: 1);
219 /* Allocate room for:
221 * - Up to CACHE_LINE_SIZE - 1 bytes before the payload, so that the
222 * start of the payload doesn't potentially share a cache line.
224 * - A payload consisting of a void *, followed by padding out to
225 * MEM_ALIGN bytes, followed by 'size' bytes of user data.
227 * - Space following the payload up to the end of the cache line, so
228 * that the end of the payload doesn't potentially share a cache line
229 * with some following block. */
230 base
= xmalloc((CACHE_LINE_SIZE
- 1)
231 + ROUND_UP(MEM_ALIGN
+ size
, CACHE_LINE_SIZE
));
233 /* Locate the payload and store a pointer to the base at the beginning. */
234 payload
= (void **) ROUND_UP((uintptr_t) base
, CACHE_LINE_SIZE
);
237 return (char *) payload
+ MEM_ALIGN
;
241 /* Like xmalloc_cacheline() but clears the allocated memory to all zero
244 xzalloc_cacheline(size_t size
)
246 void *p
= xmalloc_cacheline(size
);
251 /* Frees a memory block allocated with xmalloc_cacheline() or
252 * xzalloc_cacheline(). */
254 free_cacheline(void *p
)
256 #ifdef HAVE_POSIX_MEMALIGN
260 free(*(void **) ((uintptr_t) p
- MEM_ALIGN
));
266 xasprintf(const char *format
, ...)
271 va_start(args
, format
);
272 s
= xvasprintf(format
, args
);
278 /* Similar to strlcpy() from OpenBSD, but it never reads more than 'size - 1'
279 * bytes from 'src' and doesn't return anything. */
281 ovs_strlcpy(char *dst
, const char *src
, size_t size
)
284 size_t len
= strnlen(src
, size
- 1);
285 memcpy(dst
, src
, len
);
290 /* Copies 'src' to 'dst'. Reads no more than 'size - 1' bytes from 'src'.
291 * Always null-terminates 'dst' (if 'size' is nonzero), and writes a zero byte
292 * to every otherwise unused byte in 'dst'.
294 * Except for performance, the following call:
295 * ovs_strzcpy(dst, src, size);
296 * is equivalent to these two calls:
297 * memset(dst, '\0', size);
298 * ovs_strlcpy(dst, src, size);
300 * (Thus, ovs_strzcpy() is similar to strncpy() without some of the pitfalls.)
303 ovs_strzcpy(char *dst
, const char *src
, size_t size
)
306 size_t len
= strnlen(src
, size
- 1);
307 memcpy(dst
, src
, len
);
308 memset(dst
+ len
, '\0', size
- len
);
312 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
313 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
314 * the message inside parentheses. Then, terminates with abort().
316 * This function is preferred to ovs_fatal() in a situation where it would make
317 * sense for a monitoring process to restart the daemon.
319 * 'format' should not end with a new-line, because this function will add one
322 ovs_abort(int err_no
, const char *format
, ...)
326 va_start(args
, format
);
327 ovs_abort_valist(err_no
, format
, args
);
330 /* Same as ovs_abort() except that the arguments are supplied as a va_list. */
332 ovs_abort_valist(int err_no
, const char *format
, va_list args
)
334 ovs_error_valist(err_no
, format
, args
);
338 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
339 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
340 * the message inside parentheses. Then, terminates with EXIT_FAILURE.
342 * 'format' should not end with a new-line, because this function will add one
345 ovs_fatal(int err_no
, const char *format
, ...)
349 va_start(args
, format
);
350 ovs_fatal_valist(err_no
, format
, args
);
353 /* Same as ovs_fatal() except that the arguments are supplied as a va_list. */
355 ovs_fatal_valist(int err_no
, const char *format
, va_list args
)
357 ovs_error_valist(err_no
, format
, args
);
361 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
362 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
363 * the message inside parentheses.
365 * 'format' should not end with a new-line, because this function will add one
368 ovs_error(int err_no
, const char *format
, ...)
372 va_start(args
, format
);
373 ovs_error_valist(err_no
, format
, args
);
377 /* Same as ovs_error() except that the arguments are supplied as a va_list. */
379 ovs_error_valist(int err_no
, const char *format
, va_list args
)
381 const char *subprogram_name
= get_subprogram_name();
382 int save_errno
= errno
;
384 if (subprogram_name
[0]) {
385 fprintf(stderr
, "%s(%s): ", program_name
, subprogram_name
);
387 fprintf(stderr
, "%s: ", program_name
);
390 vfprintf(stderr
, format
, args
);
392 fprintf(stderr
, " (%s)", ovs_retval_to_string(err_no
));
399 /* Many OVS functions return an int which is one of:
402 * - EOF: end of file (not necessarily an error; depends on the function called)
404 * Returns the appropriate human-readable string. The caller must copy the
405 * string if it wants to hold onto it, as the storage may be overwritten on
406 * subsequent function calls.
409 ovs_retval_to_string(int retval
)
412 : retval
== EOF
? "End of file"
413 : ovs_strerror(retval
));
416 /* This function returns the string describing the error number in 'error'
417 * for POSIX platforms. For Windows, this function can be used for C library
418 * calls. For socket calls that are also used in Windows, use sock_strerror()
419 * instead. For WINAPI calls, look at ovs_lasterror_to_string(). */
421 ovs_strerror(int error
)
423 enum { BUFSIZE
= sizeof strerror_buffer_get()->s
};
430 * strerror(0) varies among platforms:
436 * We want to provide a consistent result here because
437 * our testsuite has test cases which strictly matches
438 * log messages containing this string.
444 buffer
= strerror_buffer_get()->s
;
446 #if STRERROR_R_CHAR_P
447 /* GNU style strerror_r() might return an immutable static string, or it
448 * might write and return 'buffer', but in either case we can pass the
449 * returned string directly to the caller. */
450 s
= strerror_r(error
, buffer
, BUFSIZE
);
451 #else /* strerror_r() returns an int. */
453 if (strerror_r(error
, buffer
, BUFSIZE
)) {
454 /* strerror_r() is only allowed to fail on ERANGE (because the buffer
455 * is too short). We don't check the actual failure reason because
456 * POSIX requires strerror_r() to return the error but old glibc
457 * (before 2.13) returns -1 and sets errno. */
458 snprintf(buffer
, BUFSIZE
, "Unknown error %d", error
);
467 /* Sets global "program_name" and "program_version" variables. Should
468 * be called at the beginning of main() with "argv[0]" as the argument
471 * 'version' should contain the version of the caller's program. If 'version'
472 * is the same as the VERSION #define, the caller is assumed to be part of Open
473 * vSwitch. Otherwise, it is assumed to be an external program linking against
474 * the Open vSwitch libraries.
478 ovs_set_program_name(const char *argv0
, const char *version
)
482 size_t max_len
= strlen(argv0
) + 1;
484 SetErrorMode(GetErrorMode() | SEM_NOGPFAULTERRORBOX
);
485 _set_output_format(_TWO_DIGIT_EXPONENT
);
487 basename
= xmalloc(max_len
);
488 _splitpath_s(argv0
, NULL
, 0, NULL
, 0, basename
, max_len
, NULL
, 0);
490 const char *slash
= strrchr(argv0
, '/');
491 basename
= xstrdup(slash
? slash
+ 1 : argv0
);
494 assert_single_threaded();
496 /* Remove libtool prefix, if it is there */
497 if (strncmp(basename
, "lt-", 3) == 0) {
498 char *tmp_name
= basename
;
499 basename
= xstrdup(basename
+ 3);
502 program_name
= basename
;
504 free(program_version
);
505 if (!strcmp(version
, VERSION
)) {
506 program_version
= xasprintf("%s (Open vSwitch) "VERSION
"\n",
509 program_version
= xasprintf("%s %s\n"
510 "Open vSwitch Library "VERSION
"\n",
511 program_name
, version
);
515 /* Returns the name of the currently running thread or process. */
517 get_subprogram_name(void)
519 const char *name
= subprogram_name_get();
520 return name
? name
: "";
523 /* Sets 'subprogram_name' as the name of the currently running thread or
524 * process. (This appears in log messages and may also be visible in system
525 * process listings and debuggers.) */
527 set_subprogram_name(const char *subprogram_name
)
529 char *pname
= xstrdup(subprogram_name
? subprogram_name
: program_name
);
530 free(subprogram_name_set(pname
));
532 #if HAVE_GLIBC_PTHREAD_SETNAME_NP
533 pthread_setname_np(pthread_self(), pname
);
534 #elif HAVE_NETBSD_PTHREAD_SETNAME_NP
535 pthread_setname_np(pthread_self(), "%s", pname
);
536 #elif HAVE_PTHREAD_SET_NAME_NP
537 pthread_set_name_np(pthread_self(), pname
);
541 /* Returns a pointer to a string describing the program version. The
542 * caller must not modify or free the returned string.
545 ovs_get_program_version(void)
547 return program_version
;
550 /* Returns a pointer to a string describing the program name. The
551 * caller must not modify or free the returned string.
554 ovs_get_program_name(void)
559 /* Print the version information for the program. */
561 ovs_print_version(uint8_t min_ofp
, uint8_t max_ofp
)
563 printf("%s", program_version
);
564 if (min_ofp
|| max_ofp
) {
565 printf("OpenFlow versions %#x:%#x\n", min_ofp
, max_ofp
);
569 /* Writes the 'size' bytes in 'buf' to 'stream' as hex bytes arranged 16 per
570 * line. Numeric offsets are also included, starting at 'ofs' for the first
571 * byte in 'buf'. If 'ascii' is true then the corresponding ASCII characters
572 * are also rendered alongside. */
574 ovs_hex_dump(FILE *stream
, const void *buf_
, size_t size
,
575 uintptr_t ofs
, bool ascii
)
577 const uint8_t *buf
= buf_
;
578 const size_t per_line
= 16; /* Maximum bytes per line. */
582 size_t start
, end
, n
;
585 /* Number of bytes on this line. */
586 start
= ofs
% per_line
;
588 if (end
- start
> size
)
593 fprintf(stream
, "%08"PRIxMAX
" ", (uintmax_t) ROUND_DOWN(ofs
, per_line
));
594 for (i
= 0; i
< start
; i
++)
595 fprintf(stream
, " ");
597 fprintf(stream
, "%02x%c",
598 buf
[i
- start
], i
== per_line
/ 2 - 1? '-' : ' ');
601 for (; i
< per_line
; i
++)
602 fprintf(stream
, " ");
603 fprintf(stream
, "|");
604 for (i
= 0; i
< start
; i
++)
605 fprintf(stream
, " ");
606 for (; i
< end
; i
++) {
607 int c
= buf
[i
- start
];
608 putc(c
>= 32 && c
< 127 ? c
: '.', stream
);
610 for (; i
< per_line
; i
++)
611 fprintf(stream
, " ");
612 fprintf(stream
, "|");
614 fprintf(stream
, "\n");
623 str_to_int(const char *s
, int base
, int *i
)
626 bool ok
= str_to_llong(s
, base
, &ll
);
632 str_to_long(const char *s
, int base
, long *li
)
635 bool ok
= str_to_llong(s
, base
, &ll
);
641 str_to_llong(const char *s
, int base
, long long *x
)
644 bool ok
= str_to_llong_with_tail(s
, &tail
, base
, x
);
653 str_to_llong_with_tail(const char *s
, char **tail
, int base
, long long *x
)
655 int save_errno
= errno
;
657 *x
= strtoll(s
, tail
, base
);
658 if (errno
== EINVAL
|| errno
== ERANGE
|| *tail
== s
) {
669 str_to_uint(const char *s
, int base
, unsigned int *u
)
672 bool ok
= str_to_llong(s
, base
, &ll
);
673 if (!ok
|| ll
< 0 || ll
> UINT_MAX
) {
683 str_to_llong_range(const char *s
, int base
, long long *begin
,
687 if (str_to_llong_with_tail(s
, &tail
, base
, begin
)
689 && str_to_llong(tail
+ 1, base
, end
)) {
697 /* Converts floating-point string 's' into a double. If successful, stores
698 * the double in '*d' and returns true; on failure, stores 0 in '*d' and
701 * Underflow (e.g. "1e-9999") is not considered an error, but overflow
702 * (e.g. "1e9999)" is. */
704 str_to_double(const char *s
, double *d
)
706 int save_errno
= errno
;
709 *d
= strtod(s
, &tail
);
710 if (errno
== EINVAL
|| (errno
== ERANGE
&& *d
!= 0)
711 || tail
== s
|| *tail
!= '\0') {
721 /* Returns the value of 'c' as a hexadecimal digit. */
726 case '0': case '1': case '2': case '3': case '4':
727 case '5': case '6': case '7': case '8': case '9':
753 /* Returns the integer value of the 'n' hexadecimal digits starting at 's', or
754 * UINTMAX_MAX if one of those "digits" is not really a hex digit. Sets '*ok'
755 * to true if the conversion succeeds or to false if a non-hex digit is
758 hexits_value(const char *s
, size_t n
, bool *ok
)
764 for (i
= 0; i
< n
; i
++) {
765 int hexit
= hexit_value(s
[i
]);
770 value
= (value
<< 4) + hexit
;
776 /* Parses the string in 's' as an integer in either hex or decimal format and
777 * puts the result right justified in the array 'valuep' that is 'field_width'
778 * big. If the string is in hex format, the value may be arbitrarily large;
779 * integers are limited to 64-bit values. (The rationale is that decimal is
780 * likely to represent a number and 64 bits is a reasonable maximum whereas
781 * hex could either be a number or a byte string.)
783 * On return 'tail' points to the first character in the string that was
784 * not parsed as part of the value. ERANGE is returned if the value is too
785 * large to fit in the given field. */
787 parse_int_string(const char *s
, uint8_t *valuep
, int field_width
, char **tail
)
789 unsigned long long int integer
;
792 if (!strncmp(s
, "0x", 2) || !strncmp(s
, "0X", 2)) {
799 hexit_str
= xmalloc(field_width
* 2);
805 s
+= strspn(s
, " \t\r\n");
806 hexit
= hexits_value(s
, 1, &ok
);
808 *tail
= CONST_CAST(char *, s
);
812 if (hexit
!= 0 || len
) {
813 if (DIV_ROUND_UP(len
+ 1, 2) > field_width
) {
818 hexit_str
[len
] = hexit
;
824 val_idx
= field_width
;
825 for (i
= len
- 1; i
>= 0; i
-= 2) {
827 valuep
[val_idx
] = hexit_str
[i
];
829 valuep
[val_idx
] += hexit_str
[i
- 1] << 4;
833 memset(valuep
, 0, val_idx
);
841 integer
= strtoull(s
, tail
, 0);
846 for (i
= field_width
- 1; i
>= 0; i
--) {
857 /* Returns the current working directory as a malloc()'d string, or a null
858 * pointer if the current working directory cannot be determined. */
865 /* Get maximum path length or at least a reasonable estimate. */
867 path_max
= pathconf(".", _PC_PATH_MAX
);
871 size
= (path_max
< 0 ? 1024
872 : path_max
> 10240 ? 10240
875 /* Get current working directory. */
877 char *buf
= xmalloc(size
);
878 if (getcwd(buf
, size
)) {
879 return xrealloc(buf
, strlen(buf
) + 1);
883 if (error
!= ERANGE
) {
884 VLOG_WARN("getcwd failed (%s)", ovs_strerror(error
));
893 all_slashes_name(const char *s
)
895 return xstrdup(s
[0] == '/' && s
[1] == '/' && s
[2] != '/' ? "//"
901 /* Returns the directory name portion of 'file_name' as a malloc()'d string,
902 * similar to the POSIX dirname() function but thread-safe. */
904 dir_name(const char *file_name
)
906 size_t len
= strlen(file_name
);
907 while (len
> 0 && file_name
[len
- 1] == '/') {
910 while (len
> 0 && file_name
[len
- 1] != '/') {
913 while (len
> 0 && file_name
[len
- 1] == '/') {
916 return len
? xmemdup0(file_name
, len
) : all_slashes_name(file_name
);
919 /* Returns the file name portion of 'file_name' as a malloc()'d string,
920 * similar to the POSIX basename() function but thread-safe. */
922 base_name(const char *file_name
)
926 end
= strlen(file_name
);
927 while (end
> 0 && file_name
[end
- 1] == '/') {
932 return all_slashes_name(file_name
);
936 while (start
> 0 && file_name
[start
- 1] != '/') {
940 return xmemdup0(file_name
+ start
, end
- start
);
944 /* If 'file_name' starts with '/', returns a copy of 'file_name'. Otherwise,
945 * returns an absolute path to 'file_name' considering it relative to 'dir',
946 * which itself must be absolute. 'dir' may be null or the empty string, in
947 * which case the current working directory is used.
949 * Additionally on Windows, if 'file_name' has a ':', returns a copy of
952 * Returns a null pointer if 'dir' is null and getcwd() fails. */
954 abs_file_name(const char *dir
, const char *file_name
)
956 if (file_name
[0] == '/') {
957 return xstrdup(file_name
);
959 } else if (strchr(file_name
, ':')) {
960 return xstrdup(file_name
);
962 } else if (dir
&& dir
[0]) {
963 char *separator
= dir
[strlen(dir
) - 1] == '/' ? "" : "/";
964 return xasprintf("%s%s%s", dir
, separator
, file_name
);
966 char *cwd
= get_cwd();
968 char *abs_name
= xasprintf("%s/%s", cwd
, file_name
);
977 /* Like readlink(), but returns the link name as a null-terminated string in
978 * allocated memory that the caller must eventually free (with free()).
979 * Returns NULL on error, in which case errno is set appropriately. */
981 xreadlink(const char *filename
)
989 for (size
= 64; ; size
*= 2) {
990 char *buf
= xmalloc(size
);
991 ssize_t retval
= readlink(filename
, buf
, size
);
994 if (retval
>= 0 && retval
< size
) {
1008 /* Returns a version of 'filename' with symlinks in the final component
1009 * dereferenced. This differs from realpath() in that:
1011 * - 'filename' need not exist.
1013 * - If 'filename' does exist as a symlink, its referent need not exist.
1015 * - Only symlinks in the final component of 'filename' are dereferenced.
1017 * For Windows platform, this function returns a string that has the same
1018 * value as the passed string.
1020 * The caller must eventually free the returned string (with free()). */
1022 follow_symlinks(const char *filename
)
1029 fn
= xstrdup(filename
);
1030 for (i
= 0; i
< 10; i
++) {
1034 if (lstat(fn
, &s
) != 0 || !S_ISLNK(s
.st_mode
)) {
1038 linkname
= xreadlink(fn
);
1040 VLOG_WARN("%s: readlink failed (%s)",
1041 filename
, ovs_strerror(errno
));
1045 if (linkname
[0] == '/') {
1046 /* Target of symlink is absolute so use it raw. */
1049 /* Target of symlink is relative so add to 'fn''s directory. */
1050 char *dir
= dir_name(fn
);
1052 if (!strcmp(dir
, ".")) {
1055 char *separator
= dir
[strlen(dir
) - 1] == '/' ? "" : "/";
1056 next_fn
= xasprintf("%s%s%s", dir
, separator
, linkname
);
1067 VLOG_WARN("%s: too many levels of symlinks", filename
);
1070 return xstrdup(filename
);
1073 /* Pass a value to this function if it is marked with
1074 * __attribute__((warn_unused_result)) and you genuinely want to ignore
1075 * its return value. (Note that every scalar type can be implicitly
1076 * converted to bool.) */
1077 void ignore(bool x OVS_UNUSED
) { }
1079 /* Returns an appropriate delimiter for inserting just before the 0-based item
1080 * 'index' in a list that has 'total' items in it. */
1082 english_list_delimiter(size_t index
, size_t total
)
1084 return (index
== 0 ? ""
1085 : index
< total
- 1 ? ", "
1086 : total
> 2 ? ", and "
1090 /* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. */
1091 #if __GNUC__ >= 4 || _MSC_VER
1092 /* Defined inline in util.h. */
1094 /* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. */
1101 #define CTZ_STEP(X) \
1118 /* Returns the number of leading 0-bits in 'n'. Undefined if 'n' == 0. */
1120 raw_clz64(uint64_t n
)
1125 #define CLZ_STEP(X) \
1143 #if NEED_COUNT_1BITS_8
1145 ((((X) & (1 << 0)) != 0) + \
1146 (((X) & (1 << 1)) != 0) + \
1147 (((X) & (1 << 2)) != 0) + \
1148 (((X) & (1 << 3)) != 0) + \
1149 (((X) & (1 << 4)) != 0) + \
1150 (((X) & (1 << 5)) != 0) + \
1151 (((X) & (1 << 6)) != 0) + \
1152 (((X) & (1 << 7)) != 0))
1153 #define INIT2(X) INIT1(X), INIT1((X) + 1)
1154 #define INIT4(X) INIT2(X), INIT2((X) + 2)
1155 #define INIT8(X) INIT4(X), INIT4((X) + 4)
1156 #define INIT16(X) INIT8(X), INIT8((X) + 8)
1157 #define INIT32(X) INIT16(X), INIT16((X) + 16)
1158 #define INIT64(X) INIT32(X), INIT32((X) + 32)
1160 const uint8_t count_1bits_8
[256] = {
1161 INIT64(0), INIT64(64), INIT64(128), INIT64(192)
1165 /* Returns true if the 'n' bytes starting at 'p' are zeros. */
1167 is_all_zeros(const void *p_
, size_t n
)
1169 const uint8_t *p
= p_
;
1172 for (i
= 0; i
< n
; i
++) {
1180 /* Returns true if the 'n' bytes starting at 'p' are 0xff. */
1182 is_all_ones(const void *p_
, size_t n
)
1184 const uint8_t *p
= p_
;
1187 for (i
= 0; i
< n
; i
++) {
1195 /* Copies 'n_bits' bits starting from bit 'src_ofs' in 'src' to the 'n_bits'
1196 * starting from bit 'dst_ofs' in 'dst'. 'src' is 'src_len' bytes long and
1197 * 'dst' is 'dst_len' bytes long.
1199 * If you consider all of 'src' to be a single unsigned integer in network byte
1200 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1201 * with value 1 in src[src_len - 1], bit 1 is the bit with value 2, bit 2 is
1202 * the bit with value 4, ..., bit 8 is the bit with value 1 in src[src_len -
1203 * 2], and so on. Similarly for 'dst'.
1205 * Required invariants:
1206 * src_ofs + n_bits <= src_len * 8
1207 * dst_ofs + n_bits <= dst_len * 8
1208 * 'src' and 'dst' must not overlap.
1211 bitwise_copy(const void *src_
, unsigned int src_len
, unsigned int src_ofs
,
1212 void *dst_
, unsigned int dst_len
, unsigned int dst_ofs
,
1213 unsigned int n_bits
)
1215 const uint8_t *src
= src_
;
1216 uint8_t *dst
= dst_
;
1218 src
+= src_len
- (src_ofs
/ 8 + 1);
1221 dst
+= dst_len
- (dst_ofs
/ 8 + 1);
1224 if (src_ofs
== 0 && dst_ofs
== 0) {
1225 unsigned int n_bytes
= n_bits
/ 8;
1229 memcpy(dst
, src
, n_bytes
);
1236 uint8_t mask
= (1 << n_bits
) - 1;
1237 *dst
= (*dst
& ~mask
) | (*src
& mask
);
1240 while (n_bits
> 0) {
1241 unsigned int max_copy
= 8 - MAX(src_ofs
, dst_ofs
);
1242 unsigned int chunk
= MIN(n_bits
, max_copy
);
1243 uint8_t mask
= ((1 << chunk
) - 1) << dst_ofs
;
1246 *dst
|= ((*src
>> src_ofs
) << dst_ofs
) & mask
;
1263 /* Zeros the 'n_bits' bits starting from bit 'dst_ofs' in 'dst'. 'dst' is
1264 * 'dst_len' bytes long.
1266 * If you consider all of 'dst' to be a single unsigned integer in network byte
1267 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1268 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1269 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1272 * Required invariant:
1273 * dst_ofs + n_bits <= dst_len * 8
1276 bitwise_zero(void *dst_
, unsigned int dst_len
, unsigned dst_ofs
,
1277 unsigned int n_bits
)
1279 uint8_t *dst
= dst_
;
1285 dst
+= dst_len
- (dst_ofs
/ 8 + 1);
1289 unsigned int chunk
= MIN(n_bits
, 8 - dst_ofs
);
1291 *dst
&= ~(((1 << chunk
) - 1) << dst_ofs
);
1301 while (n_bits
>= 8) {
1307 *dst
&= ~((1 << n_bits
) - 1);
1311 /* Sets to 1 all of the 'n_bits' bits starting from bit 'dst_ofs' in 'dst'.
1312 * 'dst' is 'dst_len' bytes long.
1314 * If you consider all of 'dst' to be a single unsigned integer in network byte
1315 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1316 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1317 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1320 * Required invariant:
1321 * dst_ofs + n_bits <= dst_len * 8
1324 bitwise_one(void *dst_
, unsigned int dst_len
, unsigned dst_ofs
,
1325 unsigned int n_bits
)
1327 uint8_t *dst
= dst_
;
1333 dst
+= dst_len
- (dst_ofs
/ 8 + 1);
1337 unsigned int chunk
= MIN(n_bits
, 8 - dst_ofs
);
1339 *dst
|= ((1 << chunk
) - 1) << dst_ofs
;
1349 while (n_bits
>= 8) {
1355 *dst
|= (1 << n_bits
) - 1;
1359 /* Scans the 'n_bits' bits starting from bit 'dst_ofs' in 'dst' for 1-bits.
1360 * Returns false if any 1-bits are found, otherwise true. 'dst' is 'dst_len'
1363 * If you consider all of 'dst' to be a single unsigned integer in network byte
1364 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1365 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1366 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1369 * Required invariant:
1370 * dst_ofs + n_bits <= dst_len * 8
1373 bitwise_is_all_zeros(const void *p_
, unsigned int len
, unsigned int ofs
,
1374 unsigned int n_bits
)
1376 const uint8_t *p
= p_
;
1382 p
+= len
- (ofs
/ 8 + 1);
1386 unsigned int chunk
= MIN(n_bits
, 8 - ofs
);
1388 if (*p
& (((1 << chunk
) - 1) << ofs
)) {
1400 while (n_bits
>= 8) {
1408 if (n_bits
&& *p
& ((1 << n_bits
) - 1)) {
1415 /* Scans the bits in 'p' that have bit offsets 'start' (inclusive) through
1416 * 'end' (exclusive) for the first bit with value 'target'. If one is found,
1417 * returns its offset, otherwise 'end'. 'p' is 'len' bytes long.
1419 * If you consider all of 'p' to be a single unsigned integer in network byte
1420 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1421 * with value 1 in p[len - 1], bit 1 is the bit with value 2, bit 2 is the bit
1422 * with value 4, ..., bit 8 is the bit with value 1 in p[len - 2], and so on.
1424 * Required invariant:
1428 bitwise_scan(const void *p
, unsigned int len
, bool target
, unsigned int start
,
1433 for (ofs
= start
; ofs
< end
; ofs
++) {
1434 if (bitwise_get_bit(p
, len
, ofs
) == target
) {
1441 /* Scans the bits in 'p' that have bit offsets 'start' (inclusive) through
1442 * 'end' (exclusive) for the first bit with value 'target', in reverse order.
1443 * If one is found, returns its offset, otherwise 'end'. 'p' is 'len' bytes
1446 * If you consider all of 'p' to be a single unsigned integer in network byte
1447 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1448 * with value 1 in p[len - 1], bit 1 is the bit with value 2, bit 2 is the bit
1449 * with value 4, ..., bit 8 is the bit with value 1 in p[len - 2], and so on.
1451 * To scan an entire bit array in reverse order, specify start == len * 8 - 1
1452 * and end == -1, in which case the return value is nonnegative if successful
1453 * and -1 if no 'target' match is found.
1455 * Required invariant:
1459 bitwise_rscan(const void *p
, unsigned int len
, bool target
, int start
, int end
)
1461 const uint8_t *s
= p
;
1462 int start_byte
= len
- (start
/ 8 + 1);
1463 int end_byte
= len
- (end
/ 8 + 1);
1468 /* Find the target in the start_byte from starting offset */
1469 ofs_byte
= start_byte
;
1470 the_byte
= s
[ofs_byte
];
1471 for (ofs
= start
% 8; ofs
>= 0; ofs
--) {
1472 if (((the_byte
& (1u << ofs
)) != 0) == target
) {
1477 /* Target not found in start byte, continue searching byte by byte */
1478 for (ofs_byte
= start_byte
+ 1; ofs_byte
<= end_byte
; ofs_byte
++) {
1479 if ((target
&& s
[ofs_byte
])
1480 || (!target
&& (s
[ofs_byte
] != 0xff))) {
1484 if (ofs_byte
> end_byte
) {
1487 the_byte
= s
[ofs_byte
];
1488 /* Target is in the_byte, find it bit by bit */
1489 for (ofs
= 7; ofs
>= 0; ofs
--) {
1490 if (((the_byte
& (1u << ofs
)) != 0) == target
) {
1495 int ret
= (len
- ofs_byte
) * 8 - (8 - ofs
);
1502 /* Copies the 'n_bits' low-order bits of 'value' into the 'n_bits' bits
1503 * starting at bit 'dst_ofs' in 'dst', which is 'dst_len' bytes long.
1505 * If you consider all of 'dst' to be a single unsigned integer in network byte
1506 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1507 * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1508 * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1511 * Required invariants:
1512 * dst_ofs + n_bits <= dst_len * 8
1516 bitwise_put(uint64_t value
,
1517 void *dst
, unsigned int dst_len
, unsigned int dst_ofs
,
1518 unsigned int n_bits
)
1520 ovs_be64 n_value
= htonll(value
);
1521 bitwise_copy(&n_value
, sizeof n_value
, 0,
1522 dst
, dst_len
, dst_ofs
,
1526 /* Returns the value of the 'n_bits' bits starting at bit 'src_ofs' in 'src',
1527 * which is 'src_len' bytes long.
1529 * If you consider all of 'src' to be a single unsigned integer in network byte
1530 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1531 * with value 1 in src[src_len - 1], bit 1 is the bit with value 2, bit 2 is
1532 * the bit with value 4, ..., bit 8 is the bit with value 1 in src[src_len -
1535 * Required invariants:
1536 * src_ofs + n_bits <= src_len * 8
1540 bitwise_get(const void *src
, unsigned int src_len
,
1541 unsigned int src_ofs
, unsigned int n_bits
)
1543 ovs_be64 value
= htonll(0);
1545 bitwise_copy(src
, src_len
, src_ofs
,
1546 &value
, sizeof value
, 0,
1548 return ntohll(value
);
1551 /* Returns the value of the bit with offset 'ofs' in 'src', which is 'len'
1554 * If you consider all of 'src' to be a single unsigned integer in network byte
1555 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1556 * with value 1 in src[len - 1], bit 1 is the bit with value 2, bit 2 is the
1557 * bit with value 4, ..., bit 8 is the bit with value 1 in src[len - 2], and so
1560 * Required invariants:
1564 bitwise_get_bit(const void *src_
, unsigned int len
, unsigned int ofs
)
1566 const uint8_t *src
= src_
;
1568 return (src
[len
- (ofs
/ 8 + 1)] & (1u << (ofs
% 8))) != 0;
1571 /* Sets the bit with offset 'ofs' in 'dst', which is 'len' bytes long, to 0.
1573 * If you consider all of 'dst' to be a single unsigned integer in network byte
1574 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1575 * with value 1 in dst[len - 1], bit 1 is the bit with value 2, bit 2 is the
1576 * bit with value 4, ..., bit 8 is the bit with value 1 in dst[len - 2], and so
1579 * Required invariants:
1583 bitwise_put0(void *dst_
, unsigned int len
, unsigned int ofs
)
1585 uint8_t *dst
= dst_
;
1587 dst
[len
- (ofs
/ 8 + 1)] &= ~(1u << (ofs
% 8));
1590 /* Sets the bit with offset 'ofs' in 'dst', which is 'len' bytes long, to 1.
1592 * If you consider all of 'dst' to be a single unsigned integer in network byte
1593 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1594 * with value 1 in dst[len - 1], bit 1 is the bit with value 2, bit 2 is the
1595 * bit with value 4, ..., bit 8 is the bit with value 1 in dst[len - 2], and so
1598 * Required invariants:
1602 bitwise_put1(void *dst_
, unsigned int len
, unsigned int ofs
)
1604 uint8_t *dst
= dst_
;
1606 dst
[len
- (ofs
/ 8 + 1)] |= 1u << (ofs
% 8);
1609 /* Sets the bit with offset 'ofs' in 'dst', which is 'len' bytes long, to 'b'.
1611 * If you consider all of 'dst' to be a single unsigned integer in network byte
1612 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1613 * with value 1 in dst[len - 1], bit 1 is the bit with value 2, bit 2 is the
1614 * bit with value 4, ..., bit 8 is the bit with value 1 in dst[len - 2], and so
1617 * Required invariants:
1621 bitwise_put_bit(void *dst
, unsigned int len
, unsigned int ofs
, bool b
)
1624 bitwise_put1(dst
, len
, ofs
);
1626 bitwise_put0(dst
, len
, ofs
);
1630 /* Flips the bit with offset 'ofs' in 'dst', which is 'len' bytes long.
1632 * If you consider all of 'dst' to be a single unsigned integer in network byte
1633 * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
1634 * with value 1 in dst[len - 1], bit 1 is the bit with value 2, bit 2 is the
1635 * bit with value 4, ..., bit 8 is the bit with value 1 in dst[len - 2], and so
1638 * Required invariants:
1642 bitwise_toggle_bit(void *dst_
, unsigned int len
, unsigned int ofs
)
1644 uint8_t *dst
= dst_
;
1646 dst
[len
- (ofs
/ 8 + 1)] ^= 1u << (ofs
% 8);
1667 skip_spaces(const char *s
)
1669 while (isspace((unsigned char) *s
)) {
1676 scan_int(const char *s
, const struct scan_spec
*spec
, int base
, va_list *args
)
1678 const char *start
= s
;
1683 negative
= *s
== '-';
1684 s
+= *s
== '-' || *s
== '+';
1686 if ((!base
|| base
== 16) && *s
== '0' && (s
[1] == 'x' || s
[1] == 'X')) {
1690 base
= *s
== '0' ? 8 : 10;
1693 if (s
- start
>= spec
->width
) {
1699 while (s
- start
< spec
->width
) {
1700 int digit
= hexit_value(*s
);
1702 if (digit
< 0 || digit
>= base
) {
1705 value
= value
* base
+ digit
;
1717 switch (spec
->type
) {
1721 *va_arg(*args
, char *) = value
;
1724 *va_arg(*args
, short int *) = value
;
1727 *va_arg(*args
, int *) = value
;
1730 *va_arg(*args
, long int *) = value
;
1733 *va_arg(*args
, long long int *) = value
;
1736 *va_arg(*args
, intmax_t *) = value
;
1738 case SCAN_PTRDIFF_T
:
1739 *va_arg(*args
, ptrdiff_t *) = value
;
1742 *va_arg(*args
, size_t *) = value
;
1749 skip_digits(const char *s
)
1751 while (*s
>= '0' && *s
<= '9') {
1758 scan_float(const char *s
, const struct scan_spec
*spec
, va_list *args
)
1760 const char *start
= s
;
1766 s
+= *s
== '+' || *s
== '-';
1769 s
= skip_digits(s
+ 1);
1771 if (*s
== 'e' || *s
== 'E') {
1773 s
+= *s
== '+' || *s
== '-';
1777 if (s
- start
> spec
->width
) {
1778 s
= start
+ spec
->width
;
1781 copy
= xmemdup0(start
, s
- start
);
1782 value
= strtold(copy
, &tail
);
1789 switch (spec
->type
) {
1793 *va_arg(*args
, float *) = value
;
1796 *va_arg(*args
, double *) = value
;
1799 *va_arg(*args
, long double *) = value
;
1805 case SCAN_PTRDIFF_T
:
1813 scan_output_string(const struct scan_spec
*spec
,
1814 const char *s
, size_t n
,
1817 if (spec
->type
!= SCAN_DISCARD
) {
1818 char *out
= va_arg(*args
, char *);
1825 scan_string(const char *s
, const struct scan_spec
*spec
, va_list *args
)
1829 for (n
= 0; n
< spec
->width
; n
++) {
1830 if (!s
[n
] || isspace((unsigned char) s
[n
])) {
1838 scan_output_string(spec
, s
, n
, args
);
1843 parse_scanset(const char *p_
, unsigned long *set
, bool *complemented
)
1845 const uint8_t *p
= (const uint8_t *) p_
;
1847 *complemented
= *p
== '^';
1851 bitmap_set1(set
, ']');
1855 while (*p
&& *p
!= ']') {
1856 if (p
[1] == '-' && p
[2] != ']' && p
[2] > *p
) {
1857 bitmap_set_multiple(set
, *p
, p
[2] - *p
+ 1, true);
1860 bitmap_set1(set
, *p
++);
1866 return (const char *) p
;
1870 scan_set(const char *s
, const struct scan_spec
*spec
, const char **pp
,
1873 unsigned long set
[BITMAP_N_LONGS(UCHAR_MAX
+ 1)];
1877 /* Parse the scan set. */
1878 memset(set
, 0, sizeof set
);
1879 *pp
= parse_scanset(*pp
, set
, &complemented
);
1881 /* Parse the data. */
1884 && bitmap_is_set(set
, (unsigned char) s
[n
]) == !complemented
1885 && n
< spec
->width
) {
1891 scan_output_string(spec
, s
, n
, args
);
1896 scan_chars(const char *s
, const struct scan_spec
*spec
, va_list *args
)
1898 unsigned int n
= spec
->width
== UINT_MAX
? 1 : spec
->width
;
1900 if (strlen(s
) < n
) {
1903 if (spec
->type
!= SCAN_DISCARD
) {
1904 memcpy(va_arg(*args
, char *), s
, n
);
1910 ovs_scan__(const char *s
, int *n
, const char *format
, va_list *args
)
1912 const char *const start
= s
;
1917 while (*p
!= '\0') {
1918 struct scan_spec spec
;
1919 unsigned char c
= *p
++;
1925 } else if (c
!= '%') {
1931 } else if (*p
== '%') {
1939 /* Parse '*' flag. */
1940 discard
= *p
== '*';
1943 /* Parse field width. */
1945 while (*p
>= '0' && *p
<= '9') {
1946 spec
.width
= spec
.width
* 10 + (*p
++ - '0');
1948 if (spec
.width
== 0) {
1949 spec
.width
= UINT_MAX
;
1952 /* Parse type modifier. */
1956 spec
.type
= SCAN_CHAR
;
1959 spec
.type
= SCAN_SHORT
;
1965 spec
.type
= SCAN_INTMAX_T
;
1971 spec
.type
= SCAN_LLONG
;
1974 spec
.type
= SCAN_LONG
;
1981 spec
.type
= SCAN_LLONG
;
1986 spec
.type
= SCAN_PTRDIFF_T
;
1991 spec
.type
= SCAN_SIZE_T
;
1996 spec
.type
= SCAN_INT
;
2001 spec
.type
= SCAN_DISCARD
;
2005 if (c
!= 'c' && c
!= 'n' && c
!= '[') {
2010 s
= scan_int(s
, &spec
, 10, args
);
2014 s
= scan_int(s
, &spec
, 0, args
);
2018 s
= scan_int(s
, &spec
, 8, args
);
2022 s
= scan_int(s
, &spec
, 10, args
);
2027 s
= scan_int(s
, &spec
, 16, args
);
2035 s
= scan_float(s
, &spec
, args
);
2039 s
= scan_string(s
, &spec
, args
);
2043 s
= scan_set(s
, &spec
, &p
, args
);
2047 s
= scan_chars(s
, &spec
, args
);
2051 if (spec
.type
!= SCAN_DISCARD
) {
2052 *va_arg(*args
, int *) = s
- start
;
2070 /* This is an implementation of the standard sscanf() function, with the
2071 * following exceptions:
2073 * - It returns true if the entire format was successfully scanned and
2074 * converted, false if any conversion failed.
2076 * - The standard doesn't define sscanf() behavior when an out-of-range value
2077 * is scanned, e.g. if a "%"PRIi8 conversion scans "-1" or "0x1ff". Some
2078 * implementations consider this an error and stop scanning. This
2079 * implementation never considers an out-of-range value an error; instead,
2080 * it stores the least-significant bits of the converted value in the
2081 * destination, e.g. the value 255 for both examples earlier.
2083 * - Only single-byte characters are supported, that is, the 'l' modifier
2084 * on %s, %[, and %c is not supported. The GNU extension 'a' modifier is
2085 * also not supported.
2087 * - %p is not supported.
2090 ovs_scan(const char *s
, const char *format
, ...)
2095 va_start(args
, format
);
2096 res
= ovs_scan__(s
, NULL
, format
, &args
);
2102 * This function is similar to ovs_scan(), with an extra parameter `n` added to
2103 * return the number of scanned characters.
2106 ovs_scan_len(const char *s
, int *n
, const char *format
, ...)
2112 va_start(args
, format
);
2113 success
= ovs_scan__(s
+ *n
, &n1
, format
, &args
);
2122 xsleep(unsigned int seconds
)
2124 ovsrcu_quiesce_start();
2126 Sleep(seconds
* 1000);
2130 ovsrcu_quiesce_end();
2133 /* Determine whether standard output is a tty or not. This is useful to decide
2134 * whether to use color output or not when --color option for utilities is set
2138 is_stdout_a_tty(void)
2140 char const *t
= getenv("TERM");
2141 return (isatty(STDOUT_FILENO
) && t
&& strcmp(t
, "dumb") != 0);
2147 ovs_format_message(int error
)
2149 enum { BUFSIZE
= sizeof strerror_buffer_get()->s
};
2150 char *buffer
= strerror_buffer_get()->s
;
2153 /* See ovs_strerror */
2157 FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM
| FORMAT_MESSAGE_IGNORE_INSERTS
,
2158 NULL
, error
, 0, buffer
, BUFSIZE
, NULL
);
2162 /* Returns a null-terminated string that explains the last error.
2163 * Use this function to get the error string for WINAPI calls. */
2165 ovs_lasterror_to_string(void)
2167 return ovs_format_message(GetLastError());
2171 ftruncate(int fd
, off_t length
)
2175 error
= _chsize_s(fd
, length
);
2182 OVS_CONSTRUCTOR(winsock_start
) {
2186 error
= WSAStartup(MAKEWORD(2, 2), &wsaData
);
2188 VLOG_FATAL("WSAStartup failed: %s", sock_strerror(sock_errno()));