lib/util.c

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