lib/util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "util.h"
  19 #include <ctype.h>
  20 #include <errno.h>
  21 #include <limits.h>
  22 #include <pthread.h>
  23 #include <stdarg.h>
  24 #include <stdint.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <sys/stat.h>
  29 #include <unistd.h>
  30 #include "bitmap.h"
  31 #include "byte-order.h"
  32 #include "coverage.h"
  33 #include "ovs-rcu.h"
  34 #include "ovs-thread.h"
  35 #include "socket-util.h"
  36 #include "vlog.h"
  37 #ifdef HAVE_PTHREAD_SET_NAME_NP
  38 #include <pthread_np.h>
  39 #endif
  40
  41 VLOG_DEFINE_THIS_MODULE(util);
  42
  43 COVERAGE_DEFINE(util_xalloc);
  44
  45 /* argv[0] without directory names. */
  46 char *program_name;
  47
  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);
  51
  52 /* --version option output. */
  53 static char *program_version;
  54
  55 /* Buffer used by ovs_strerror() and ovs_format_message(). */
  56 DEFINE_STATIC_PER_THREAD_DATA(struct { char s[128]; },
  57                               strerror_buffer,
  58                               { "" });
  59
  60 static char *xreadlink(const char *filename);
  61
  62 void
  63 ovs_assert_failure(const char *where, const char *function,
  64                    const char *condition)
  65 {
  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;
  69
  70     switch (reentry++) {
  71     case 0:
  72         VLOG_ABORT("%s: assertion %s failed in %s()",
  73                    where, condition, function);
  74         OVS_NOT_REACHED();
  75
  76     case 1:
  77         fprintf(stderr, "%s: assertion %s failed in %s()",
  78                 where, condition, function);
  79         abort();
  80
  81     default:
  82         abort();
  83     }
  84 }
  85
  86 void
  87 out_of_memory(void)
  88 {
  89     ovs_abort(0, "virtual memory exhausted");
  90 }
  91
  92 void *
  93 xcalloc(size_t count, size_t size)
  94 {
  95     void *p = count && size ? calloc(count, size) : malloc(1);
  96     COVERAGE_INC(util_xalloc);
  97     if (p == NULL) {
  98         out_of_memory();
  99     }
 100     return p;
 101 }
 102
 103 void *
 104 xzalloc(size_t size)
 105 {
 106     return xcalloc(1, size);
 107 }
 108
 109 void *
 110 xmalloc(size_t size)
 111 {
 112     void *p = malloc(size ? size : 1);
 113     COVERAGE_INC(util_xalloc);
 114     if (p == NULL) {
 115         out_of_memory();
 116     }
 117     return p;
 118 }
 119
 120 void *
 121 xrealloc(void *p, size_t size)
 122 {
 123     p = realloc(p, size ? size : 1);
 124     COVERAGE_INC(util_xalloc);
 125     if (p == NULL) {
 126         out_of_memory();
 127     }
 128     return p;
 129 }
 130
 131 void *
 132 xmemdup(const void *p_, size_t size)
 133 {
 134     void *p = xmalloc(size);
 135     memcpy(p, p_, size);
 136     return p;
 137 }
 138
 139 char *
 140 xmemdup0(const char *p_, size_t length)
 141 {
 142     char *p = xmalloc(length + 1);
 143     memcpy(p, p_, length);
 144     p[length] = '\0';
 145     return p;
 146 }
 147
 148 char *
 149 xstrdup(const char *s)
 150 {
 151     return xmemdup0(s, strlen(s));
 152 }
 153
 154 char *
 155 xvasprintf(const char *format, va_list args)
 156 {
 157     va_list args2;
 158     size_t needed;
 159     char *s;
 160
 161     va_copy(args2, args);
 162     needed = vsnprintf(NULL, 0, format, args);
 163
 164     s = xmalloc(needed + 1);
 165
 166     vsnprintf(s, needed + 1, format, args2);
 167     va_end(args2);
 168
 169     return s;
 170 }
 171
 172 void *
 173 x2nrealloc(void *p, size_t *n, size_t s)
 174 {
 175     *n = *n == 0 ? 1 : 2 * *n;
 176     return xrealloc(p, *n * s);
 177 }
 178
 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);
 183
 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.)
 188  *
 189  * Use free_cacheline() to free the returned memory block. */
 190 void *
 191 xmalloc_cacheline(size_t size)
 192 {
 193 #ifdef HAVE_POSIX_MEMALIGN
 194     void *p;
 195     int error;
 196
 197     COVERAGE_INC(util_xalloc);
 198     error = posix_memalign(&p, CACHE_LINE_SIZE, size ? size : 1);
 199     if (error != 0) {
 200         out_of_memory();
 201     }
 202     return p;
 203 #else
 204     void **payload;
 205     void *base;
 206
 207     /* Allocate room for:
 208      *
 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.
 211      *
 212      *     - A payload consisting of a void *, followed by padding out to
 213      *       MEM_ALIGN bytes, followed by 'size' bytes of user data.
 214      *
 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));
 220
 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);
 223     *payload = base;
 224
 225     return (char *) payload + MEM_ALIGN;
 226 #endif
 227 }
 228
 229 /* Like xmalloc_cacheline() but clears the allocated memory to all zero
 230  * bytes. */
 231 void *
 232 xzalloc_cacheline(size_t size)
 233 {
 234     void *p = xmalloc_cacheline(size);
 235     memset(p, 0, size);
 236     return p;
 237 }
 238
 239 /* Frees a memory block allocated with xmalloc_cacheline() or
 240  * xzalloc_cacheline(). */
 241 void
 242 free_cacheline(void *p)
 243 {
 244 #ifdef HAVE_POSIX_MEMALIGN
 245     free(p);
 246 #else
 247     if (p) {
 248         free(*(void **) ((uintptr_t) p - MEM_ALIGN));
 249     }
 250 #endif
 251 }
 252
 253 char *
 254 xasprintf(const char *format, ...)
 255 {
 256     va_list args;
 257     char *s;
 258
 259     va_start(args, format);
 260     s = xvasprintf(format, args);
 261     va_end(args);
 262
 263     return s;
 264 }
 265
 266 /* Similar to strlcpy() from OpenBSD, but it never reads more than 'size - 1'
 267  * bytes from 'src' and doesn't return anything. */
 268 void
 269 ovs_strlcpy(char *dst, const char *src, size_t size)
 270 {
 271     if (size > 0) {
 272         size_t len = strnlen(src, size - 1);
 273         memcpy(dst, src, len);
 274         dst[len] = '\0';
 275     }
 276 }
 277
 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'.
 281  *
 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);
 287  *
 288  * (Thus, ovs_strzcpy() is similar to strncpy() without some of the pitfalls.)
 289  */
 290 void
 291 ovs_strzcpy(char *dst, const char *src, size_t size)
 292 {
 293     if (size > 0) {
 294         size_t len = strnlen(src, size - 1);
 295         memcpy(dst, src, len);
 296         memset(dst + len, '\0', size - len);
 297     }
 298 }
 299
 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().
 303  *
 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.
 306  *
 307  * 'format' should not end with a new-line, because this function will add one
 308  * itself. */
 309 void
 310 ovs_abort(int err_no, const char *format, ...)
 311 {
 312     va_list args;
 313
 314     va_start(args, format);
 315     ovs_abort_valist(err_no, format, args);
 316 }
 317
 318 /* Same as ovs_abort() except that the arguments are supplied as a va_list. */
 319 void
 320 ovs_abort_valist(int err_no, const char *format, va_list args)
 321 {
 322     ovs_error_valist(err_no, format, args);
 323     abort();
 324 }
 325
 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.
 329  *
 330  * 'format' should not end with a new-line, because this function will add one
 331  * itself. */
 332 void
 333 ovs_fatal(int err_no, const char *format, ...)
 334 {
 335     va_list args;
 336
 337     va_start(args, format);
 338     ovs_fatal_valist(err_no, format, args);
 339 }
 340
 341 /* Same as ovs_fatal() except that the arguments are supplied as a va_list. */
 342 void
 343 ovs_fatal_valist(int err_no, const char *format, va_list args)
 344 {
 345     ovs_error_valist(err_no, format, args);
 346     exit(EXIT_FAILURE);
 347 }
 348
 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.
 352  *
 353  * 'format' should not end with a new-line, because this function will add one
 354  * itself. */
 355 void
 356 ovs_error(int err_no, const char *format, ...)
 357 {
 358     va_list args;
 359
 360     va_start(args, format);
 361     ovs_error_valist(err_no, format, args);
 362     va_end(args);
 363 }
 364
 365 /* Same as ovs_error() except that the arguments are supplied as a va_list. */
 366 void
 367 ovs_error_valist(int err_no, const char *format, va_list args)
 368 {
 369     const char *subprogram_name = get_subprogram_name();
 370     int save_errno = errno;
 371
 372     if (subprogram_name[0]) {
 373         fprintf(stderr, "%s(%s): ", program_name, subprogram_name);
 374     } else {
 375         fprintf(stderr, "%s: ", program_name);
 376     }
 377
 378     vfprintf(stderr, format, args);
 379     if (err_no != 0) {
 380         fprintf(stderr, " (%s)", ovs_retval_to_string(err_no));
 381     }
 382     putc('\n', stderr);
 383
 384     errno = save_errno;
 385 }
 386
 387 /* Many OVS functions return an int which is one of:
 388  * - 0: no error yet
 389  * - >0: errno value
 390  * - EOF: end of file (not necessarily an error; depends on the function called)
 391  *
 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.
 395  */
 396 const char *
 397 ovs_retval_to_string(int retval)
 398 {
 399     return (!retval ? ""
 400             : retval == EOF ? "End of file"
 401             : ovs_strerror(retval));
 402 }
 403
 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(). */
 408 const char *
 409 ovs_strerror(int error)
 410 {
 411     enum { BUFSIZE = sizeof strerror_buffer_get()->s };
 412     int save_errno;
 413     char *buffer;
 414     char *s;
 415
 416     save_errno = errno;
 417     buffer = strerror_buffer_get()->s;
 418
 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. */
 425     s = buffer;
 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);
 432     }
 433 #endif
 434
 435     errno = save_errno;
 436
 437     return s;
 438 }
 439
 440 /* Sets global "program_name" and "program_version" variables.  Should
 441  * be called at the beginning of main() with "argv[0]" as the argument
 442  * to 'argv0'.
 443  *
 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.
 448  *
 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 "set_program_name" macro may be called to do this
 452  * automatically.
 453  */
 454 void
 455 set_program_name__(const char *argv0, const char *version, const char *date,
 456                    const char *time)
 457 {
 458     char *basename;
 459 #ifdef _WIN32
 460     size_t max_len = strlen(argv0) + 1;
 461
 462     SetErrorMode(GetErrorMode() | SEM_NOGPFAULTERRORBOX);
 463     _set_output_format(_TWO_DIGIT_EXPONENT);
 464
 465     basename = xmalloc(max_len);
 466     _splitpath_s(argv0, NULL, 0, NULL, 0, basename, max_len, NULL, 0);
 467 #else
 468     const char *slash = strrchr(argv0, '/');
 469     basename = xstrdup(slash ? slash + 1 : argv0);
 470 #endif
 471
 472     assert_single_threaded();
 473     free(program_name);
 474     program_name = basename;
 475     free(program_version);
 476
 477     if (!strcmp(version, VERSION)) {
 478         program_version = xasprintf("%s (Open vSwitch) "VERSION"\n"
 479                                     "Compiled %s %s\n",
 480                                     program_name, date, time);
 481     } else {
 482         program_version = xasprintf("%s %s\n"
 483                                     "Open vSwitch Library "VERSION"\n"
 484                                     "Compiled %s %s\n",
 485                                     program_name, version, date, time);
 486     }
 487 }
 488
 489 /* Returns the name of the currently running thread or process. */
 490 const char *
 491 get_subprogram_name(void)
 492 {
 493     const char *name = subprogram_name_get();
 494     return name ? name : "";
 495 }
 496
 497 /* Sets the formatted value of 'format' as the name of the currently running
 498  * thread or process.  (This appears in log messages and may also be visible in
 499  * system process listings and debuggers.) */
 500 void
 501 set_subprogram_name(const char *format, ...)
 502 {
 503     char *pname;
 504
 505     if (format) {
 506         va_list args;
 507
 508         va_start(args, format);
 509         pname = xvasprintf(format, args);
 510         va_end(args);
 511     } else {
 512         pname = xstrdup(program_name);
 513     }
 514
 515     free(subprogram_name_set(pname));
 516
 517 #if HAVE_GLIBC_PTHREAD_SETNAME_NP
 518     pthread_setname_np(pthread_self(), pname);
 519 #elif HAVE_NETBSD_PTHREAD_SETNAME_NP
 520     pthread_setname_np(pthread_self(), "%s", pname);
 521 #elif HAVE_PTHREAD_SET_NAME_NP
 522     pthread_set_name_np(pthread_self(), pname);
 523 #endif
 524 }
 525
 526 /* Returns a pointer to a string describing the program version.  The
 527  * caller must not modify or free the returned string.
 528  */
 529 const char *
 530 get_program_version(void)
 531 {
 532     return program_version;
 533 }
 534
 535 /* Print the version information for the program.  */
 536 void
 537 ovs_print_version(uint8_t min_ofp, uint8_t max_ofp)
 538 {
 539     printf("%s", program_version);
 540     if (min_ofp || max_ofp) {
 541         printf("OpenFlow versions %#x:%#x\n", min_ofp, max_ofp);
 542     }
 543 }
 544
 545 /* Writes the 'size' bytes in 'buf' to 'stream' as hex bytes arranged 16 per
 546  * line.  Numeric offsets are also included, starting at 'ofs' for the first
 547  * byte in 'buf'.  If 'ascii' is true then the corresponding ASCII characters
 548  * are also rendered alongside. */
 549 void
 550 ovs_hex_dump(FILE *stream, const void *buf_, size_t size,
 551              uintptr_t ofs, bool ascii)
 552 {
 553   const uint8_t *buf = buf_;
 554   const size_t per_line = 16; /* Maximum bytes per line. */
 555
 556   while (size > 0)
 557     {
 558       size_t start, end, n;
 559       size_t i;
 560
 561       /* Number of bytes on this line. */
 562       start = ofs % per_line;
 563       end = per_line;
 564       if (end - start > size)
 565         end = start + size;
 566       n = end - start;
 567
 568       /* Print line. */
 569       fprintf(stream, "%08"PRIxMAX"  ", (uintmax_t) ROUND_DOWN(ofs, per_line));
 570       for (i = 0; i < start; i++)
 571         fprintf(stream, "   ");
 572       for (; i < end; i++)
 573         fprintf(stream, "%02x%c",
 574                 buf[i - start], i == per_line / 2 - 1? '-' : ' ');
 575       if (ascii)
 576         {
 577           for (; i < per_line; i++)
 578             fprintf(stream, "   ");
 579           fprintf(stream, "|");
 580           for (i = 0; i < start; i++)
 581             fprintf(stream, " ");
 582           for (; i < end; i++) {
 583               int c = buf[i - start];
 584               putc(c >= 32 && c < 127 ? c : '.', stream);
 585           }
 586           for (; i < per_line; i++)
 587             fprintf(stream, " ");
 588           fprintf(stream, "|");
 589         }
 590       fprintf(stream, "\n");
 591
 592       ofs += n;
 593       buf += n;
 594       size -= n;
 595     }
 596 }
 597
 598 bool
 599 str_to_int(const char *s, int base, int *i)
 600 {
 601     long long ll;
 602     bool ok = str_to_llong(s, base, &ll);
 603     *i = ll;
 604     return ok;
 605 }
 606
 607 bool
 608 str_to_long(const char *s, int base, long *li)
 609 {
 610     long long ll;
 611     bool ok = str_to_llong(s, base, &ll);
 612     *li = ll;
 613     return ok;
 614 }
 615
 616 bool
 617 str_to_llong(const char *s, int base, long long *x)
 618 {
 619     int save_errno = errno;
 620     char *tail;
 621     errno = 0;
 622     *x = strtoll(s, &tail, base);
 623     if (errno == EINVAL || errno == ERANGE || tail == s || *tail != '\0') {
 624         errno = save_errno;
 625         *x = 0;
 626         return false;
 627     } else {
 628         errno = save_errno;
 629         return true;
 630     }
 631 }
 632
 633 bool
 634 str_to_uint(const char *s, int base, unsigned int *u)
 635 {
 636     long long ll;
 637     bool ok = str_to_llong(s, base, &ll);
 638     if (!ok || ll < 0 || ll > UINT_MAX) {
 639         *u = 0;
 640         return false;
 641     } else {
 642         *u = ll;
 643         return true;
 644     }
 645 }
 646
 647 /* Converts floating-point string 's' into a double.  If successful, stores
 648  * the double in '*d' and returns true; on failure, stores 0 in '*d' and
 649  * returns false.
 650  *
 651  * Underflow (e.g. "1e-9999") is not considered an error, but overflow
 652  * (e.g. "1e9999)" is. */
 653 bool
 654 str_to_double(const char *s, double *d)
 655 {
 656     int save_errno = errno;
 657     char *tail;
 658     errno = 0;
 659     *d = strtod(s, &tail);
 660     if (errno == EINVAL || (errno == ERANGE && *d != 0)
 661         || tail == s || *tail != '\0') {
 662         errno = save_errno;
 663         *d = 0;
 664         return false;
 665     } else {
 666         errno = save_errno;
 667         return true;
 668     }
 669 }
 670
 671 /* Returns the value of 'c' as a hexadecimal digit. */
 672 int
 673 hexit_value(int c)
 674 {
 675     switch (c) {
 676     case '0': case '1': case '2': case '3': case '4':
 677     case '5': case '6': case '7': case '8': case '9':
 678         return c - '0';
 679
 680     case 'a': case 'A':
 681         return 0xa;
 682
 683     case 'b': case 'B':
 684         return 0xb;
 685
 686     case 'c': case 'C':
 687         return 0xc;
 688
 689     case 'd': case 'D':
 690         return 0xd;
 691
 692     case 'e': case 'E':
 693         return 0xe;
 694
 695     case 'f': case 'F':
 696         return 0xf;
 697
 698     default:
 699         return -1;
 700     }
 701 }
 702
 703 /* Returns the integer value of the 'n' hexadecimal digits starting at 's', or
 704  * UINTMAX_MAX if one of those "digits" is not really a hex digit.  Sets '*ok'
 705  * to true if the conversion succeeds or to false if a non-hex digit is
 706  * detected. */
 707 uintmax_t
 708 hexits_value(const char *s, size_t n, bool *ok)
 709 {
 710     uintmax_t value;
 711     size_t i;
 712
 713     value = 0;
 714     for (i = 0; i < n; i++) {
 715         int hexit = hexit_value(s[i]);
 716         if (hexit < 0) {
 717             *ok = false;
 718             return UINTMAX_MAX;
 719         }
 720         value = (value << 4) + hexit;
 721     }
 722     *ok = true;
 723     return value;
 724 }
 725
 726 /* Returns the current working directory as a malloc()'d string, or a null
 727  * pointer if the current working directory cannot be determined. */
 728 char *
 729 get_cwd(void)
 730 {
 731     long int path_max;
 732     size_t size;
 733
 734     /* Get maximum path length or at least a reasonable estimate. */
 735 #ifndef _WIN32
 736     path_max = pathconf(".", _PC_PATH_MAX);
 737 #else
 738     path_max = MAX_PATH;
 739 #endif
 740     size = (path_max < 0 ? 1024
 741             : path_max > 10240 ? 10240
 742             : path_max);
 743
 744     /* Get current working directory. */
 745     for (;;) {
 746         char *buf = xmalloc(size);
 747         if (getcwd(buf, size)) {
 748             return xrealloc(buf, strlen(buf) + 1);
 749         } else {
 750             int error = errno;
 751             free(buf);
 752             if (error != ERANGE) {
 753                 VLOG_WARN("getcwd failed (%s)", ovs_strerror(error));
 754                 return NULL;
 755             }
 756             size *= 2;
 757         }
 758     }
 759 }
 760
 761 static char *
 762 all_slashes_name(const char *s)
 763 {
 764     return xstrdup(s[0] == '/' && s[1] == '/' && s[2] != '/' ? "//"
 765                    : s[0] == '/' ? "/"
 766                    : ".");
 767 }
 768
 769 #ifndef _WIN32
 770 /* Returns the directory name portion of 'file_name' as a malloc()'d string,
 771  * similar to the POSIX dirname() function but thread-safe. */
 772 char *
 773 dir_name(const char *file_name)
 774 {
 775     size_t len = strlen(file_name);
 776     while (len > 0 && file_name[len - 1] == '/') {
 777         len--;
 778     }
 779     while (len > 0 && file_name[len - 1] != '/') {
 780         len--;
 781     }
 782     while (len > 0 && file_name[len - 1] == '/') {
 783         len--;
 784     }
 785     return len ? xmemdup0(file_name, len) : all_slashes_name(file_name);
 786 }
 787
 788 /* Returns the file name portion of 'file_name' as a malloc()'d string,
 789  * similar to the POSIX basename() function but thread-safe. */
 790 char *
 791 base_name(const char *file_name)
 792 {
 793     size_t end, start;
 794
 795     end = strlen(file_name);
 796     while (end > 0 && file_name[end - 1] == '/') {
 797         end--;
 798     }
 799
 800     if (!end) {
 801         return all_slashes_name(file_name);
 802     }
 803
 804     start = end;
 805     while (start > 0 && file_name[start - 1] != '/') {
 806         start--;
 807     }
 808
 809     return xmemdup0(file_name + start, end - start);
 810 }
 811 #endif /* _WIN32 */
 812
 813 /* If 'file_name' starts with '/', returns a copy of 'file_name'.  Otherwise,
 814  * returns an absolute path to 'file_name' considering it relative to 'dir',
 815  * which itself must be absolute.  'dir' may be null or the empty string, in
 816  * which case the current working directory is used.
 817  *
 818  * Returns a null pointer if 'dir' is null and getcwd() fails. */
 819 char *
 820 abs_file_name(const char *dir, const char *file_name)
 821 {
 822     if (file_name[0] == '/') {
 823         return xstrdup(file_name);
 824     } else if (dir && dir[0]) {
 825         char *separator = dir[strlen(dir) - 1] == '/' ? "" : "/";
 826         return xasprintf("%s%s%s", dir, separator, file_name);
 827     } else {
 828         char *cwd = get_cwd();
 829         if (cwd) {
 830             char *abs_name = xasprintf("%s/%s", cwd, file_name);
 831             free(cwd);
 832             return abs_name;
 833         } else {
 834             return NULL;
 835         }
 836     }
 837 }
 838
 839 /* Like readlink(), but returns the link name as a null-terminated string in
 840  * allocated memory that the caller must eventually free (with free()).
 841  * Returns NULL on error, in which case errno is set appropriately. */
 842 static char *
 843 xreadlink(const char *filename)
 844 {
 845     size_t size;
 846
 847     for (size = 64; ; size *= 2) {
 848         char *buf = xmalloc(size);
 849         ssize_t retval = readlink(filename, buf, size);
 850         int error = errno;
 851
 852         if (retval >= 0 && retval < size) {
 853             buf[retval] = '\0';
 854             return buf;
 855         }
 856
 857         free(buf);
 858         if (retval < 0) {
 859             errno = error;
 860             return NULL;
 861         }
 862     }
 863 }
 864
 865 /* Returns a version of 'filename' with symlinks in the final component
 866  * dereferenced.  This differs from realpath() in that:
 867  *
 868  *     - 'filename' need not exist.
 869  *
 870  *     - If 'filename' does exist as a symlink, its referent need not exist.
 871  *
 872  *     - Only symlinks in the final component of 'filename' are dereferenced.
 873  *
 874  * For Windows platform, this function returns a string that has the same
 875  * value as the passed string.
 876  *
 877  * The caller must eventually free the returned string (with free()). */
 878 char *
 879 follow_symlinks(const char *filename)
 880 {
 881 #ifndef _WIN32
 882     struct stat s;
 883     char *fn;
 884     int i;
 885
 886     fn = xstrdup(filename);
 887     for (i = 0; i < 10; i++) {
 888         char *linkname;
 889         char *next_fn;
 890
 891         if (lstat(fn, &s) != 0 || !S_ISLNK(s.st_mode)) {
 892             return fn;
 893         }
 894
 895         linkname = xreadlink(fn);
 896         if (!linkname) {
 897             VLOG_WARN("%s: readlink failed (%s)",
 898                       filename, ovs_strerror(errno));
 899             return fn;
 900         }
 901
 902         if (linkname[0] == '/') {
 903             /* Target of symlink is absolute so use it raw. */
 904             next_fn = linkname;
 905         } else {
 906             /* Target of symlink is relative so add to 'fn''s directory. */
 907             char *dir = dir_name(fn);
 908
 909             if (!strcmp(dir, ".")) {
 910                 next_fn = linkname;
 911             } else {
 912                 char *separator = dir[strlen(dir) - 1] == '/' ? "" : "/";
 913                 next_fn = xasprintf("%s%s%s", dir, separator, linkname);
 914                 free(linkname);
 915             }
 916
 917             free(dir);
 918         }
 919
 920         free(fn);
 921         fn = next_fn;
 922     }
 923
 924     VLOG_WARN("%s: too many levels of symlinks", filename);
 925     free(fn);
 926 #endif
 927     return xstrdup(filename);
 928 }
 929
 930 /* Pass a value to this function if it is marked with
 931  * __attribute__((warn_unused_result)) and you genuinely want to ignore
 932  * its return value.  (Note that every scalar type can be implicitly
 933  * converted to bool.) */
 934 void ignore(bool x OVS_UNUSED) { }
 935
 936 /* Returns an appropriate delimiter for inserting just before the 0-based item
 937  * 'index' in a list that has 'total' items in it. */
 938 const char *
 939 english_list_delimiter(size_t index, size_t total)
 940 {
 941     return (index == 0 ? ""
 942             : index < total - 1 ? ", "
 943             : total > 2 ? ", and "
 944             : " and ");
 945 }
 946
 947 /* Returns the number of trailing 0-bits in 'n'.  Undefined if 'n' == 0. */
 948 #if __GNUC__ >= 4 || _MSC_VER
 949 /* Defined inline in util.h. */
 950 #else
 951 /* Returns the number of trailing 0-bits in 'n'.  Undefined if 'n' == 0. */
 952 int
 953 raw_ctz(uint64_t n)
 954 {
 955     uint64_t k;
 956     int count = 63;
 957
 958 #define CTZ_STEP(X)                             \
 959     k = n << (X);                               \
 960     if (k) {                                    \
 961         count -= X;                             \
 962         n = k;                                  \
 963     }
 964     CTZ_STEP(32);
 965     CTZ_STEP(16);
 966     CTZ_STEP(8);
 967     CTZ_STEP(4);
 968     CTZ_STEP(2);
 969     CTZ_STEP(1);
 970 #undef CTZ_STEP
 971
 972     return count;
 973 }
 974
 975 /* Returns the number of leading 0-bits in 'n'.  Undefined if 'n' == 0. */
 976 int
 977 raw_clz64(uint64_t n)
 978 {
 979     uint64_t k;
 980     int count = 63;
 981
 982 #define CLZ_STEP(X)                             \
 983     k = n >> (X);                               \
 984     if (k) {                                    \
 985         count -= X;                             \
 986         n = k;                                  \
 987     }
 988     CLZ_STEP(32);
 989     CLZ_STEP(16);
 990     CLZ_STEP(8);
 991     CLZ_STEP(4);
 992     CLZ_STEP(2);
 993     CLZ_STEP(1);
 994 #undef CLZ_STEP
 995
 996     return count;
 997 }
 998 #endif
 999
1000 #if NEED_COUNT_1BITS_8
1001 #define INIT1(X)                                \
1002     ((((X) & (1 << 0)) != 0) +                  \
1003      (((X) & (1 << 1)) != 0) +                  \
1004      (((X) & (1 << 2)) != 0) +                  \
1005      (((X) & (1 << 3)) != 0) +                  \
1006      (((X) & (1 << 4)) != 0) +                  \
1007      (((X) & (1 << 5)) != 0) +                  \
1008      (((X) & (1 << 6)) != 0) +                  \
1009      (((X) & (1 << 7)) != 0))
1010 #define INIT2(X)   INIT1(X),  INIT1((X) +  1)
1011 #define INIT4(X)   INIT2(X),  INIT2((X) +  2)
1012 #define INIT8(X)   INIT4(X),  INIT4((X) +  4)
1013 #define INIT16(X)  INIT8(X),  INIT8((X) +  8)
1014 #define INIT32(X) INIT16(X), INIT16((X) + 16)
1015 #define INIT64(X) INIT32(X), INIT32((X) + 32)
1016
1017 const uint8_t count_1bits_8[256] = {
1018     INIT64(0), INIT64(64), INIT64(128), INIT64(192)
1019 };
1020 #endif
1021
1022 /* Returns true if the 'n' bytes starting at 'p' are zeros. */
1023 bool
1024 is_all_zeros(const void *p_, size_t n)
1025 {
1026     const uint8_t *p = p_;
1027     size_t i;
1028
1029     for (i = 0; i < n; i++) {
1030         if (p[i] != 0x00) {
1031             return false;
1032         }
1033     }
1034     return true;
1035 }
1036
1037 /* Returns true if the 'n' bytes starting at 'p' are 0xff. */
1038 bool
1039 is_all_ones(const void *p_, size_t n)
1040 {
1041     const uint8_t *p = p_;
1042     size_t i;
1043
1044     for (i = 0; i < n; i++) {
1045         if (p[i] != 0xff) {
1046             return false;
1047         }
1048     }
1049     return true;
1050 }
1051
1052 /* Copies 'n_bits' bits starting from bit 'src_ofs' in 'src' to the 'n_bits'
1053  * starting from bit 'dst_ofs' in 'dst'.  'src' is 'src_len' bytes long and
1054  * 'dst' is 'dst_len' bytes long.
1055  *
1056  * If you consider all of 'src' to be a single unsigned integer in network byte
1057  * order, then bit N is the bit with value 2**N.  That is, bit 0 is the bit
1058  * with value 1 in src[src_len - 1], bit 1 is the bit with value 2, bit 2 is
1059  * the bit with value 4, ..., bit 8 is the bit with value 1 in src[src_len -
1060  * 2], and so on.  Similarly for 'dst'.
1061  *
1062  * Required invariants:
1063  *   src_ofs + n_bits <= src_len * 8
1064  *   dst_ofs + n_bits <= dst_len * 8
1065  *   'src' and 'dst' must not overlap.
1066  */
1067 void
1068 bitwise_copy(const void *src_, unsigned int src_len, unsigned int src_ofs,
1069              void *dst_, unsigned int dst_len, unsigned int dst_ofs,
1070              unsigned int n_bits)
1071 {
1072     const uint8_t *src = src_;
1073     uint8_t *dst = dst_;
1074
1075     src += src_len - (src_ofs / 8 + 1);
1076     src_ofs %= 8;
1077
1078     dst += dst_len - (dst_ofs / 8 + 1);
1079     dst_ofs %= 8;
1080
1081     if (src_ofs == 0 && dst_ofs == 0) {
1082         unsigned int n_bytes = n_bits / 8;
1083         if (n_bytes) {
1084             dst -= n_bytes - 1;
1085             src -= n_bytes - 1;
1086             memcpy(dst, src, n_bytes);
1087
1088             n_bits %= 8;
1089             src--;
1090             dst--;
1091         }
1092         if (n_bits) {
1093             uint8_t mask = (1 << n_bits) - 1;
1094             *dst = (*dst & ~mask) | (*src & mask);
1095         }
1096     } else {
1097         while (n_bits > 0) {
1098             unsigned int max_copy = 8 - MAX(src_ofs, dst_ofs);
1099             unsigned int chunk = MIN(n_bits, max_copy);
1100             uint8_t mask = ((1 << chunk) - 1) << dst_ofs;
1101
1102             *dst &= ~mask;
1103             *dst |= ((*src >> src_ofs) << dst_ofs) & mask;
1104
1105             src_ofs += chunk;
1106             if (src_ofs == 8) {
1107                 src--;
1108                 src_ofs = 0;
1109             }
1110             dst_ofs += chunk;
1111             if (dst_ofs == 8) {
1112                 dst--;
1113                 dst_ofs = 0;
1114             }
1115             n_bits -= chunk;
1116         }
1117     }
1118 }
1119
1120 /* Zeros the 'n_bits' bits starting from bit 'dst_ofs' in 'dst'.  'dst' is
1121  * 'dst_len' bytes long.
1122  *
1123  * If you consider all of 'dst' to be a single unsigned integer in network byte
1124  * order, then bit N is the bit with value 2**N.  That is, bit 0 is the bit
1125  * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1126  * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1127  * 2], and so on.
1128  *
1129  * Required invariant:
1130  *   dst_ofs + n_bits <= dst_len * 8
1131  */
1132 void
1133 bitwise_zero(void *dst_, unsigned int dst_len, unsigned dst_ofs,
1134              unsigned int n_bits)
1135 {
1136     uint8_t *dst = dst_;
1137
1138     if (!n_bits) {
1139         return;
1140     }
1141
1142     dst += dst_len - (dst_ofs / 8 + 1);
1143     dst_ofs %= 8;
1144
1145     if (dst_ofs) {
1146         unsigned int chunk = MIN(n_bits, 8 - dst_ofs);
1147
1148         *dst &= ~(((1 << chunk) - 1) << dst_ofs);
1149
1150         n_bits -= chunk;
1151         if (!n_bits) {
1152             return;
1153         }
1154
1155         dst--;
1156     }
1157
1158     while (n_bits >= 8) {
1159         *dst-- = 0;
1160         n_bits -= 8;
1161     }
1162
1163     if (n_bits) {
1164         *dst &= ~((1 << n_bits) - 1);
1165     }
1166 }
1167
1168 /* Sets to 1 all of the 'n_bits' bits starting from bit 'dst_ofs' in 'dst'.
1169  * 'dst' is 'dst_len' bytes long.
1170  *
1171  * If you consider all of 'dst' to be a single unsigned integer in network byte
1172  * order, then bit N is the bit with value 2**N.  That is, bit 0 is the bit
1173  * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1174  * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1175  * 2], and so on.
1176  *
1177  * Required invariant:
1178  *   dst_ofs + n_bits <= dst_len * 8
1179  */
1180 void
1181 bitwise_one(void *dst_, unsigned int dst_len, unsigned dst_ofs,
1182             unsigned int n_bits)
1183 {
1184     uint8_t *dst = dst_;
1185
1186     if (!n_bits) {
1187         return;
1188     }
1189
1190     dst += dst_len - (dst_ofs / 8 + 1);
1191     dst_ofs %= 8;
1192
1193     if (dst_ofs) {
1194         unsigned int chunk = MIN(n_bits, 8 - dst_ofs);
1195
1196         *dst |= ((1 << chunk) - 1) << dst_ofs;
1197
1198         n_bits -= chunk;
1199         if (!n_bits) {
1200             return;
1201         }
1202
1203         dst--;
1204     }
1205
1206     while (n_bits >= 8) {
1207         *dst-- = 0xff;
1208         n_bits -= 8;
1209     }
1210
1211     if (n_bits) {
1212         *dst |= (1 << n_bits) - 1;
1213     }
1214 }
1215
1216 /* Scans the 'n_bits' bits starting from bit 'dst_ofs' in 'dst' for 1-bits.
1217  * Returns false if any 1-bits are found, otherwise true.  'dst' is 'dst_len'
1218  * bytes long.
1219  *
1220  * If you consider all of 'dst' to be a single unsigned integer in network byte
1221  * order, then bit N is the bit with value 2**N.  That is, bit 0 is the bit
1222  * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1223  * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1224  * 2], and so on.
1225  *
1226  * Required invariant:
1227  *   dst_ofs + n_bits <= dst_len * 8
1228  */
1229 bool
1230 bitwise_is_all_zeros(const void *p_, unsigned int len, unsigned int ofs,
1231                      unsigned int n_bits)
1232 {
1233     const uint8_t *p = p_;
1234
1235     if (!n_bits) {
1236         return true;
1237     }
1238
1239     p += len - (ofs / 8 + 1);
1240     ofs %= 8;
1241
1242     if (ofs) {
1243         unsigned int chunk = MIN(n_bits, 8 - ofs);
1244
1245         if (*p & (((1 << chunk) - 1) << ofs)) {
1246             return false;
1247         }
1248
1249         n_bits -= chunk;
1250         if (!n_bits) {
1251             return true;
1252         }
1253
1254         p--;
1255     }
1256
1257     while (n_bits >= 8) {
1258         if (*p) {
1259             return false;
1260         }
1261         n_bits -= 8;
1262         p--;
1263     }
1264
1265     if (n_bits && *p & ((1 << n_bits) - 1)) {
1266         return false;
1267     }
1268
1269     return true;
1270 }
1271
1272 /* Scans the bits in 'p' that have bit offsets 'start' through 'end'
1273  * (inclusive) for the first bit with value 'target'.  If one is found, returns
1274  * its offset, otherwise 'end'.  'p' is 'len' bytes long.
1275  *
1276  * If you consider all of 'p' to be a single unsigned integer in network byte
1277  * order, then bit N is the bit with value 2**N.  That is, bit 0 is the bit
1278  * with value 1 in p[len - 1], bit 1 is the bit with value 2, bit 2 is the bit
1279  * with value 4, ..., bit 8 is the bit with value 1 in p[len - 2], and so on.
1280  *
1281  * Required invariant:
1282  *   start <= end
1283  */
1284 unsigned int
1285 bitwise_scan(const void *p_, unsigned int len, bool target, unsigned int start,
1286              unsigned int end)
1287 {
1288     const uint8_t *p = p_;
1289     unsigned int ofs;
1290
1291     for (ofs = start; ofs < end; ofs++) {
1292         bool bit = (p[len - (ofs / 8 + 1)] & (1u << (ofs % 8))) != 0;
1293         if (bit == target) {
1294             break;
1295         }
1296     }
1297     return ofs;
1298 }
1299
1300
1301 /* Copies the 'n_bits' low-order bits of 'value' into the 'n_bits' bits
1302  * starting at bit 'dst_ofs' in 'dst', which is 'dst_len' bytes long.
1303  *
1304  * If you consider all of 'dst' to be a single unsigned integer in network byte
1305  * order, then bit N is the bit with value 2**N.  That is, bit 0 is the bit
1306  * with value 1 in dst[dst_len - 1], bit 1 is the bit with value 2, bit 2 is
1307  * the bit with value 4, ..., bit 8 is the bit with value 1 in dst[dst_len -
1308  * 2], and so on.
1309  *
1310  * Required invariants:
1311  *   dst_ofs + n_bits <= dst_len * 8
1312  *   n_bits <= 64
1313  */
1314 void
1315 bitwise_put(uint64_t value,
1316             void *dst, unsigned int dst_len, unsigned int dst_ofs,
1317             unsigned int n_bits)
1318 {
1319     ovs_be64 n_value = htonll(value);
1320     bitwise_copy(&n_value, sizeof n_value, 0,
1321                  dst, dst_len, dst_ofs,
1322                  n_bits);
1323 }
1324
1325 /* Returns the value of the 'n_bits' bits starting at bit 'src_ofs' in 'src',
1326  * which is 'src_len' bytes long.
1327  *
1328  * If you consider all of 'src' to be a single unsigned integer in network byte
1329  * order, then bit N is the bit with value 2**N.  That is, bit 0 is the bit
1330  * with value 1 in src[src_len - 1], bit 1 is the bit with value 2, bit 2 is
1331  * the bit with value 4, ..., bit 8 is the bit with value 1 in src[src_len -
1332  * 2], and so on.
1333  *
1334  * Required invariants:
1335  *   src_ofs + n_bits <= src_len * 8
1336  *   n_bits <= 64
1337  */
1338 uint64_t
1339 bitwise_get(const void *src, unsigned int src_len,
1340             unsigned int src_ofs, unsigned int n_bits)
1341 {
1342     ovs_be64 value = htonll(0);
1343
1344     bitwise_copy(src, src_len, src_ofs,
1345                  &value, sizeof value, 0,
1346                  n_bits);
1347     return ntohll(value);
1348 }
1349 \f
1350 /* ovs_scan */
1351
1352 struct scan_spec {
1353     unsigned int width;
1354     enum {
1355         SCAN_DISCARD,
1356         SCAN_CHAR,
1357         SCAN_SHORT,
1358         SCAN_INT,
1359         SCAN_LONG,
1360         SCAN_LLONG,
1361         SCAN_INTMAX_T,
1362         SCAN_PTRDIFF_T,
1363         SCAN_SIZE_T
1364     } type;
1365 };
1366
1367 static const char *
1368 skip_spaces(const char *s)
1369 {
1370     while (isspace((unsigned char) *s)) {
1371         s++;
1372     }
1373     return s;
1374 }
1375
1376 static const char *
1377 scan_int(const char *s, const struct scan_spec *spec, int base, va_list *args)
1378 {
1379     const char *start = s;
1380     uintmax_t value;
1381     bool negative;
1382     int n_digits;
1383
1384     negative = *s == '-';
1385     s += *s == '-' || *s == '+';
1386
1387     if ((!base || base == 16) && *s == '0' && (s[1] == 'x' || s[1] == 'X')) {
1388         base = 16;
1389         s += 2;
1390     } else if (!base) {
1391         base = *s == '0' ? 8 : 10;
1392     }
1393
1394     if (s - start >= spec->width) {
1395         return NULL;
1396     }
1397
1398     value = 0;
1399     n_digits = 0;
1400     while (s - start < spec->width) {
1401         int digit = hexit_value(*s);
1402
1403         if (digit < 0 || digit >= base) {
1404             break;
1405         }
1406         value = value * base + digit;
1407         n_digits++;
1408         s++;
1409     }
1410     if (!n_digits) {
1411         return NULL;
1412     }
1413
1414     if (negative) {
1415         value = -value;
1416     }
1417
1418     switch (spec->type) {
1419     case SCAN_DISCARD:
1420         break;
1421     case SCAN_CHAR:
1422         *va_arg(*args, char *) = value;
1423         break;
1424     case SCAN_SHORT:
1425         *va_arg(*args, short int *) = value;
1426         break;
1427     case SCAN_INT:
1428         *va_arg(*args, int *) = value;
1429         break;
1430     case SCAN_LONG:
1431         *va_arg(*args, long int *) = value;
1432         break;
1433     case SCAN_LLONG:
1434         *va_arg(*args, long long int *) = value;
1435         break;
1436     case SCAN_INTMAX_T:
1437         *va_arg(*args, intmax_t *) = value;
1438         break;
1439     case SCAN_PTRDIFF_T:
1440         *va_arg(*args, ptrdiff_t *) = value;
1441         break;
1442     case SCAN_SIZE_T:
1443         *va_arg(*args, size_t *) = value;
1444         break;
1445     }
1446     return s;
1447 }
1448
1449 static const char *
1450 skip_digits(const char *s)
1451 {
1452     while (*s >= '0' && *s <= '9') {
1453         s++;
1454     }
1455     return s;
1456 }
1457
1458 static const char *
1459 scan_float(const char *s, const struct scan_spec *spec, va_list *args)
1460 {
1461     const char *start = s;
1462     long double value;
1463     char *tail;
1464     char *copy;
1465     bool ok;
1466
1467     s += *s == '+' || *s == '-';
1468     s = skip_digits(s);
1469     if (*s == '.') {
1470         s = skip_digits(s + 1);
1471     }
1472     if (*s == 'e' || *s == 'E') {
1473         s++;
1474         s += *s == '+' || *s == '-';
1475         s = skip_digits(s);
1476     }
1477
1478     if (s - start > spec->width) {
1479         s = start + spec->width;
1480     }
1481
1482     copy = xmemdup0(start, s - start);
1483     value = strtold(copy, &tail);
1484     ok = *tail == '\0';
1485     free(copy);
1486     if (!ok) {
1487         return NULL;
1488     }
1489
1490     switch (spec->type) {
1491     case SCAN_DISCARD:
1492         break;
1493     case SCAN_INT:
1494         *va_arg(*args, float *) = value;
1495         break;
1496     case SCAN_LONG:
1497         *va_arg(*args, double *) = value;
1498         break;
1499     case SCAN_LLONG:
1500         *va_arg(*args, long double *) = value;
1501         break;
1502
1503     case SCAN_CHAR:
1504     case SCAN_SHORT:
1505     case SCAN_INTMAX_T:
1506     case SCAN_PTRDIFF_T:
1507     case SCAN_SIZE_T:
1508         OVS_NOT_REACHED();
1509     }
1510     return s;
1511 }
1512
1513 static void
1514 scan_output_string(const struct scan_spec *spec,
1515                    const char *s, size_t n,
1516                    va_list *args)
1517 {
1518     if (spec->type != SCAN_DISCARD) {
1519         char *out = va_arg(*args, char *);
1520         memcpy(out, s, n);
1521         out[n] = '\0';
1522     }
1523 }
1524
1525 static const char *
1526 scan_string(const char *s, const struct scan_spec *spec, va_list *args)
1527 {
1528     size_t n;
1529
1530     for (n = 0; n < spec->width; n++) {
1531         if (!s[n] || isspace((unsigned char) s[n])) {
1532             break;
1533         }
1534     }
1535     if (!n) {
1536         return NULL;
1537     }
1538
1539     scan_output_string(spec, s, n, args);
1540     return s + n;
1541 }
1542
1543 static const char *
1544 parse_scanset(const char *p_, unsigned long *set, bool *complemented)
1545 {
1546     const uint8_t *p = (const uint8_t *) p_;
1547
1548     *complemented = *p == '^';
1549     p += *complemented;
1550
1551     if (*p == ']') {
1552         bitmap_set1(set, ']');
1553         p++;
1554     }
1555
1556     while (*p && *p != ']') {
1557         if (p[1] == '-' && p[2] != ']' && p[2] > *p) {
1558             bitmap_set_multiple(set, *p, p[2] - *p + 1, true);
1559             p += 3;
1560         } else {
1561             bitmap_set1(set, *p++);
1562         }
1563     }
1564     if (*p == ']') {
1565         p++;
1566     }
1567     return (const char *) p;
1568 }
1569
1570 static const char *
1571 scan_set(const char *s, const struct scan_spec *spec, const char **pp,
1572          va_list *args)
1573 {
1574     unsigned long set[BITMAP_N_LONGS(UCHAR_MAX + 1)];
1575     bool complemented;
1576     unsigned int n;
1577
1578     /* Parse the scan set. */
1579     memset(set, 0, sizeof set);
1580     *pp = parse_scanset(*pp, set, &complemented);
1581
1582     /* Parse the data. */
1583     n = 0;
1584     while (s[n]
1585            && bitmap_is_set(set, (unsigned char) s[n]) == !complemented
1586            && n < spec->width) {
1587         n++;
1588     }
1589     if (!n) {
1590         return NULL;
1591     }
1592     scan_output_string(spec, s, n, args);
1593     return s + n;
1594 }
1595
1596 static const char *
1597 scan_chars(const char *s, const struct scan_spec *spec, va_list *args)
1598 {
1599     unsigned int n = spec->width == UINT_MAX ? 1 : spec->width;
1600
1601     if (strlen(s) < n) {
1602         return NULL;
1603     }
1604     if (spec->type != SCAN_DISCARD) {
1605         memcpy(va_arg(*args, char *), s, n);
1606     }
1607     return s + n;
1608 }
1609
1610 /* This is an implementation of the standard sscanf() function, with the
1611  * following exceptions:
1612  *
1613  *   - It returns true if the entire format was successfully scanned and
1614  *     converted, false if any conversion failed.
1615  *
1616  *   - The standard doesn't define sscanf() behavior when an out-of-range value
1617  *     is scanned, e.g. if a "%"PRIi8 conversion scans "-1" or "0x1ff".  Some
1618  *     implementations consider this an error and stop scanning.  This
1619  *     implementation never considers an out-of-range value an error; instead,
1620  *     it stores the least-significant bits of the converted value in the
1621  *     destination, e.g. the value 255 for both examples earlier.
1622  *
1623  *   - Only single-byte characters are supported, that is, the 'l' modifier
1624  *     on %s, %[, and %c is not supported.  The GNU extension 'a' modifier is
1625  *     also not supported.
1626  *
1627  *   - %p is not supported.
1628  */
1629 bool
1630 ovs_scan(const char *s, const char *format, ...)
1631 {
1632     const char *const start = s;
1633     bool ok = false;
1634     const char *p;
1635     va_list args;
1636
1637     va_start(args, format);
1638     p = format;
1639     while (*p != '\0') {
1640         struct scan_spec spec;
1641         unsigned char c = *p++;
1642         bool discard;
1643
1644         if (isspace(c)) {
1645             s = skip_spaces(s);
1646             continue;
1647         } else if (c != '%') {
1648             if (*s != c) {
1649                 goto exit;
1650             }
1651             s++;
1652             continue;
1653         } else if (*p == '%') {
1654             if (*s++ != '%') {
1655                 goto exit;
1656             }
1657             p++;
1658             continue;
1659         }
1660
1661         /* Parse '*' flag. */
1662         discard = *p == '*';
1663         p += discard;
1664
1665         /* Parse field width. */
1666         spec.width = 0;
1667         while (*p >= '0' && *p <= '9') {
1668             spec.width = spec.width * 10 + (*p++ - '0');
1669         }
1670         if (spec.width == 0) {
1671             spec.width = UINT_MAX;
1672         }
1673
1674         /* Parse type modifier. */
1675         switch (*p) {
1676         case 'h':
1677             if (p[1] == 'h') {
1678                 spec.type = SCAN_CHAR;
1679                 p += 2;
1680             } else {
1681                 spec.type = SCAN_SHORT;
1682                 p++;
1683             }
1684             break;
1685
1686         case 'j':
1687             spec.type = SCAN_INTMAX_T;
1688             p++;
1689             break;
1690
1691         case 'l':
1692             if (p[1] == 'l') {
1693                 spec.type = SCAN_LLONG;
1694                 p += 2;
1695             } else {
1696                 spec.type = SCAN_LONG;
1697                 p++;
1698             }
1699             break;
1700
1701         case 'L':
1702         case 'q':
1703             spec.type = SCAN_LLONG;
1704             p++;
1705             break;
1706
1707         case 't':
1708             spec.type = SCAN_PTRDIFF_T;
1709             p++;
1710             break;
1711
1712         case 'z':
1713             spec.type = SCAN_SIZE_T;
1714             p++;
1715             break;
1716
1717         default:
1718             spec.type = SCAN_INT;
1719             break;
1720         }
1721
1722         if (discard) {
1723             spec.type = SCAN_DISCARD;
1724         }
1725
1726         c = *p++;
1727         if (c != 'c' && c != 'n' && c != '[') {
1728             s = skip_spaces(s);
1729         }
1730         switch (c) {
1731         case 'd':
1732             s = scan_int(s, &spec, 10, &args);
1733             break;
1734
1735         case 'i':
1736             s = scan_int(s, &spec, 0, &args);
1737             break;
1738
1739         case 'o':
1740             s = scan_int(s, &spec, 8, &args);
1741             break;
1742
1743         case 'u':
1744             s = scan_int(s, &spec, 10, &args);
1745             break;
1746
1747         case 'x':
1748         case 'X':
1749             s = scan_int(s, &spec, 16, &args);
1750             break;
1751
1752         case 'e':
1753         case 'f':
1754         case 'g':
1755         case 'E':
1756         case 'G':
1757             s = scan_float(s, &spec, &args);
1758             break;
1759
1760         case 's':
1761             s = scan_string(s, &spec, &args);
1762             break;
1763
1764         case '[':
1765             s = scan_set(s, &spec, &p, &args);
1766             break;
1767
1768         case 'c':
1769             s = scan_chars(s, &spec, &args);
1770             break;
1771
1772         case 'n':
1773             if (spec.type != SCAN_DISCARD) {
1774                 *va_arg(args, int *) = s - start;
1775             }
1776             break;
1777         }
1778
1779         if (!s) {
1780             goto exit;
1781         }
1782     }
1783     ok = true;
1784
1785 exit:
1786     va_end(args);
1787     return ok;
1788 }
1789
1790 void
1791 xsleep(unsigned int seconds)
1792 {
1793     ovsrcu_quiesce_start();
1794 #ifdef _WIN32
1795     Sleep(seconds * 1000);
1796 #else
1797     sleep(seconds);
1798 #endif
1799     ovsrcu_quiesce_end();
1800 }
1801
1802 #ifdef _WIN32
1803 \f
1804 char *
1805 ovs_format_message(int error)
1806 {
1807     enum { BUFSIZE = sizeof strerror_buffer_get()->s };
1808     char *buffer = strerror_buffer_get()->s;
1809
1810     FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
1811                   NULL, error, 0, buffer, BUFSIZE, NULL);
1812     return buffer;
1813 }
1814
1815 /* Returns a null-terminated string that explains the last error.
1816  * Use this function to get the error string for WINAPI calls. */
1817 char *
1818 ovs_lasterror_to_string(void)
1819 {
1820     return ovs_format_message(GetLastError());
1821 }
1822
1823 int
1824 ftruncate(int fd, off_t length)
1825 {
1826     int error;
1827
1828     error = _chsize_s(fd, length);
1829     if (error) {
1830         return -1;
1831     }
1832     return 0;
1833 }
1834
1835 OVS_CONSTRUCTOR(winsock_start) {
1836     WSADATA wsaData;
1837     int error;
1838
1839     error = WSAStartup(MAKEWORD(2, 2), &wsaData);
1840     if (error != 0) {
1841         VLOG_FATAL("WSAStartup failed: %s", sock_strerror(sock_errno()));
1842    }
1843 }
1844 #endif