lib/util.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   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 <errno.h>
  20 #include <stdarg.h>
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <unistd.h>
  25 #include "coverage.h"
  26 #include "vlog.h"
  27
  28 VLOG_DEFINE_THIS_MODULE(util);
  29
  30 COVERAGE_DEFINE(util_xalloc);
  31
  32 const char *program_name;
  33
  34 void
  35 out_of_memory(void)
  36 {
  37     ovs_fatal(0, "virtual memory exhausted");
  38 }
  39
  40 void *
  41 xcalloc(size_t count, size_t size)
  42 {
  43     void *p = count && size ? calloc(count, size) : malloc(1);
  44     COVERAGE_INC(util_xalloc);
  45     if (p == NULL) {
  46         out_of_memory();
  47     }
  48     return p;
  49 }
  50
  51 void *
  52 xzalloc(size_t size)
  53 {
  54     return xcalloc(1, size);
  55 }
  56
  57 void *
  58 xmalloc(size_t size)
  59 {
  60     void *p = malloc(size ? size : 1);
  61     COVERAGE_INC(util_xalloc);
  62     if (p == NULL) {
  63         out_of_memory();
  64     }
  65     return p;
  66 }
  67
  68 void *
  69 xrealloc(void *p, size_t size)
  70 {
  71     p = realloc(p, size ? size : 1);
  72     COVERAGE_INC(util_xalloc);
  73     if (p == NULL) {
  74         out_of_memory();
  75     }
  76     return p;
  77 }
  78
  79 void *
  80 xmemdup(const void *p_, size_t size)
  81 {
  82     void *p = xmalloc(size);
  83     memcpy(p, p_, size);
  84     return p;
  85 }
  86
  87 char *
  88 xmemdup0(const char *p_, size_t length)
  89 {
  90     char *p = xmalloc(length + 1);
  91     memcpy(p, p_, length);
  92     p[length] = '\0';
  93     return p;
  94 }
  95
  96 char *
  97 xstrdup(const char *s)
  98 {
  99     return xmemdup0(s, strlen(s));
 100 }
 101
 102 char *
 103 xvasprintf(const char *format, va_list args)
 104 {
 105     va_list args2;
 106     size_t needed;
 107     char *s;
 108
 109     va_copy(args2, args);
 110     needed = vsnprintf(NULL, 0, format, args);
 111
 112     s = xmalloc(needed + 1);
 113
 114     vsnprintf(s, needed + 1, format, args2);
 115     va_end(args2);
 116
 117     return s;
 118 }
 119
 120 void *
 121 x2nrealloc(void *p, size_t *n, size_t s)
 122 {
 123     *n = *n == 0 ? 1 : 2 * *n;
 124     return xrealloc(p, *n * s);
 125 }
 126
 127 char *
 128 xasprintf(const char *format, ...)
 129 {
 130     va_list args;
 131     char *s;
 132
 133     va_start(args, format);
 134     s = xvasprintf(format, args);
 135     va_end(args);
 136
 137     return s;
 138 }
 139
 140 void
 141 ovs_strlcpy(char *dst, const char *src, size_t size)
 142 {
 143     if (size > 0) {
 144         size_t n = strlen(src);
 145         size_t n_copy = MIN(n, size - 1);
 146         memcpy(dst, src, n_copy);
 147         dst[n_copy] = '\0';
 148     }
 149 }
 150
 151 void
 152 ovs_fatal(int err_no, const char *format, ...)
 153 {
 154     va_list args;
 155
 156     fprintf(stderr, "%s: ", program_name);
 157     va_start(args, format);
 158     vfprintf(stderr, format, args);
 159     va_end(args);
 160     if (err_no != 0)
 161         fprintf(stderr, " (%s)",
 162                 err_no == EOF ? "end of file" : strerror(err_no));
 163     putc('\n', stderr);
 164
 165     exit(EXIT_FAILURE);
 166 }
 167
 168 void
 169 ovs_error(int err_no, const char *format, ...)
 170 {
 171     int save_errno = errno;
 172     va_list args;
 173
 174     fprintf(stderr, "%s: ", program_name);
 175     va_start(args, format);
 176     vfprintf(stderr, format, args);
 177     va_end(args);
 178     if (err_no != 0) {
 179         fprintf(stderr, " (%s)",
 180                 err_no == EOF ? "end of file" : strerror(err_no));
 181     }
 182     putc('\n', stderr);
 183
 184     errno = save_errno;
 185 }
 186
 187 /* Sets program_name based on 'argv0'.  Should be called at the beginning of
 188  * main(), as "set_program_name(argv[0]);".  */
 189 void set_program_name(const char *argv0)
 190 {
 191     const char *slash = strrchr(argv0, '/');
 192     program_name = slash ? slash + 1 : argv0;
 193 }
 194
 195 /* Print the version information for the program.  */
 196 void
 197 ovs_print_version(char *date, char *time,
 198                   uint8_t min_ofp, uint8_t max_ofp)
 199 {
 200     printf("%s (Open vSwitch) "VERSION BUILDNR"\n", program_name);
 201     printf("Compiled %s %s\n", date, time);
 202     if (min_ofp || max_ofp) {
 203         printf("OpenFlow versions %#x:%#x\n", min_ofp, max_ofp);
 204     }
 205 }
 206
 207 /* Writes the 'size' bytes in 'buf' to 'stream' as hex bytes arranged 16 per
 208  * line.  Numeric offsets are also included, starting at 'ofs' for the first
 209  * byte in 'buf'.  If 'ascii' is true then the corresponding ASCII characters
 210  * are also rendered alongside. */
 211 void
 212 ovs_hex_dump(FILE *stream, const void *buf_, size_t size,
 213              uintptr_t ofs, bool ascii)
 214 {
 215   const uint8_t *buf = buf_;
 216   const size_t per_line = 16; /* Maximum bytes per line. */
 217
 218   while (size > 0)
 219     {
 220       size_t start, end, n;
 221       size_t i;
 222
 223       /* Number of bytes on this line. */
 224       start = ofs % per_line;
 225       end = per_line;
 226       if (end - start > size)
 227         end = start + size;
 228       n = end - start;
 229
 230       /* Print line. */
 231       fprintf(stream, "%08jx  ", (uintmax_t) ROUND_DOWN(ofs, per_line));
 232       for (i = 0; i < start; i++)
 233         fprintf(stream, "   ");
 234       for (; i < end; i++)
 235         fprintf(stream, "%02hhx%c",
 236                 buf[i - start], i == per_line / 2 - 1? '-' : ' ');
 237       if (ascii)
 238         {
 239           for (; i < per_line; i++)
 240             fprintf(stream, "   ");
 241           fprintf(stream, "|");
 242           for (i = 0; i < start; i++)
 243             fprintf(stream, " ");
 244           for (; i < end; i++) {
 245               int c = buf[i - start];
 246               putc(c >= 32 && c < 127 ? c : '.', stream);
 247           }
 248           for (; i < per_line; i++)
 249             fprintf(stream, " ");
 250           fprintf(stream, "|");
 251         }
 252       fprintf(stream, "\n");
 253
 254       ofs += n;
 255       buf += n;
 256       size -= n;
 257     }
 258 }
 259
 260 bool
 261 str_to_int(const char *s, int base, int *i)
 262 {
 263     long long ll;
 264     bool ok = str_to_llong(s, base, &ll);
 265     *i = ll;
 266     return ok;
 267 }
 268
 269 bool
 270 str_to_long(const char *s, int base, long *li)
 271 {
 272     long long ll;
 273     bool ok = str_to_llong(s, base, &ll);
 274     *li = ll;
 275     return ok;
 276 }
 277
 278 bool
 279 str_to_llong(const char *s, int base, long long *x)
 280 {
 281     int save_errno = errno;
 282     char *tail;
 283     errno = 0;
 284     *x = strtoll(s, &tail, base);
 285     if (errno == EINVAL || errno == ERANGE || tail == s || *tail != '\0') {
 286         errno = save_errno;
 287         *x = 0;
 288         return false;
 289     } else {
 290         errno = save_errno;
 291         return true;
 292     }
 293 }
 294
 295 bool
 296 str_to_uint(const char *s, int base, unsigned int *u)
 297 {
 298     return str_to_int(s, base, (int *) u);
 299 }
 300
 301 bool
 302 str_to_ulong(const char *s, int base, unsigned long *ul)
 303 {
 304     return str_to_long(s, base, (long *) ul);
 305 }
 306
 307 bool
 308 str_to_ullong(const char *s, int base, unsigned long long *ull)
 309 {
 310     return str_to_llong(s, base, (long long *) ull);
 311 }
 312
 313 /* Converts floating-point string 's' into a double.  If successful, stores
 314  * the double in '*d' and returns true; on failure, stores 0 in '*d' and
 315  * returns false.
 316  *
 317  * Underflow (e.g. "1e-9999") is not considered an error, but overflow
 318  * (e.g. "1e9999)" is. */
 319 bool
 320 str_to_double(const char *s, double *d)
 321 {
 322     int save_errno = errno;
 323     char *tail;
 324     errno = 0;
 325     *d = strtod(s, &tail);
 326     if (errno == EINVAL || (errno == ERANGE && *d != 0)
 327         || tail == s || *tail != '\0') {
 328         errno = save_errno;
 329         *d = 0;
 330         return false;
 331     } else {
 332         errno = save_errno;
 333         return true;
 334     }
 335 }
 336
 337 /* Returns the value of 'c' as a hexadecimal digit. */
 338 int
 339 hexit_value(int c)
 340 {
 341     switch (c) {
 342     case '0': case '1': case '2': case '3': case '4':
 343     case '5': case '6': case '7': case '8': case '9':
 344         return c - '0';
 345
 346     case 'a': case 'A':
 347         return 0xa;
 348
 349     case 'b': case 'B':
 350         return 0xb;
 351
 352     case 'c': case 'C':
 353         return 0xc;
 354
 355     case 'd': case 'D':
 356         return 0xd;
 357
 358     case 'e': case 'E':
 359         return 0xe;
 360
 361     case 'f': case 'F':
 362         return 0xf;
 363
 364     default:
 365         return -1;
 366     }
 367 }
 368
 369 /* Returns the integer value of the 'n' hexadecimal digits starting at 's', or
 370  * UINT_MAX if one of those "digits" is not really a hex digit.  If 'ok' is
 371  * nonnull, '*ok' is set to true if the conversion succeeds or to false if a
 372  * non-hex digit is detected. */
 373 unsigned int
 374 hexits_value(const char *s, size_t n, bool *ok)
 375 {
 376     unsigned int value;
 377     size_t i;
 378
 379     value = 0;
 380     for (i = 0; i < n; i++) {
 381         int hexit = hexit_value(s[i]);
 382         if (hexit < 0) {
 383             if (ok) {
 384                 *ok = false;
 385             }
 386             return UINT_MAX;
 387         }
 388         value = (value << 4) + hexit;
 389     }
 390     if (ok) {
 391         *ok = true;
 392     }
 393     return value;
 394 }
 395
 396 /* Returns the current working directory as a malloc()'d string, or a null
 397  * pointer if the current working directory cannot be determined. */
 398 char *
 399 get_cwd(void)
 400 {
 401     long int path_max;
 402     size_t size;
 403
 404     /* Get maximum path length or at least a reasonable estimate. */
 405     path_max = pathconf(".", _PC_PATH_MAX);
 406     size = (path_max < 0 ? 1024
 407             : path_max > 10240 ? 10240
 408             : path_max);
 409
 410     /* Get current working directory. */
 411     for (;;) {
 412         char *buf = xmalloc(size);
 413         if (getcwd(buf, size)) {
 414             return xrealloc(buf, strlen(buf) + 1);
 415         } else {
 416             int error = errno;
 417             free(buf);
 418             if (error != ERANGE) {
 419                 VLOG_WARN("getcwd failed (%s)", strerror(error));
 420                 return NULL;
 421             }
 422             size *= 2;
 423         }
 424     }
 425 }
 426
 427 static char *
 428 all_slashes_name(const char *s)
 429 {
 430     return xstrdup(s[0] == '/' && s[1] == '/' && s[2] != '/' ? "//"
 431                    : s[0] == '/' ? "/"
 432                    : ".");
 433 }
 434
 435 /* Returns the directory name portion of 'file_name' as a malloc()'d string,
 436  * similar to the POSIX dirname() function but thread-safe. */
 437 char *
 438 dir_name(const char *file_name)
 439 {
 440     size_t len = strlen(file_name);
 441     while (len > 0 && file_name[len - 1] == '/') {
 442         len--;
 443     }
 444     while (len > 0 && file_name[len - 1] != '/') {
 445         len--;
 446     }
 447     while (len > 0 && file_name[len - 1] == '/') {
 448         len--;
 449     }
 450     return len ? xmemdup0(file_name, len) : all_slashes_name(file_name);
 451 }
 452
 453 /* Returns the file name portion of 'file_name' as a malloc()'d string,
 454  * similar to the POSIX basename() function but thread-safe. */
 455 char *
 456 base_name(const char *file_name)
 457 {
 458     size_t end, start;
 459
 460     end = strlen(file_name);
 461     while (end > 0 && file_name[end - 1] == '/') {
 462         end--;
 463     }
 464
 465     if (!end) {
 466         return all_slashes_name(file_name);
 467     }
 468
 469     start = end;
 470     while (start > 0 && file_name[start - 1] != '/') {
 471         start--;
 472     }
 473
 474     return xmemdup0(file_name + start, end - start);
 475 }
 476
 477 /* If 'file_name' starts with '/', returns a copy of 'file_name'.  Otherwise,
 478  * returns an absolute path to 'file_name' considering it relative to 'dir',
 479  * which itself must be absolute.  'dir' may be null or the empty string, in
 480  * which case the current working directory is used.
 481  *
 482  * Returns a null pointer if 'dir' is null and getcwd() fails. */
 483 char *
 484 abs_file_name(const char *dir, const char *file_name)
 485 {
 486     if (file_name[0] == '/') {
 487         return xstrdup(file_name);
 488     } else if (dir && dir[0]) {
 489         char *separator = dir[strlen(dir) - 1] == '/' ? "" : "/";
 490         return xasprintf("%s%s%s", dir, separator, file_name);
 491     } else {
 492         char *cwd = get_cwd();
 493         if (cwd) {
 494             char *abs_name = xasprintf("%s/%s", cwd, file_name);
 495             free(cwd);
 496             return abs_name;
 497         } else {
 498             return NULL;
 499         }
 500     }
 501 }
 502
 503
 504 /* Pass a value to this function if it is marked with
 505  * __attribute__((warn_unused_result)) and you genuinely want to ignore
 506  * its return value.  (Note that every scalar type can be implicitly
 507  * converted to bool.) */
 508 void ignore(bool x OVS_UNUSED) { }