pintos-os.org Git - openvswitch/blob - lib/util.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include "util.h"
  35 #include <stdarg.h>
  36 #include <stdio.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39
  40 const char *program_name;
  41
  42 static void
  43 out_of_memory(void)
  44 {
  45     fatal(0, "virtual memory exhausted");
  46 }
  47
  48 void *
  49 xcalloc(size_t count, size_t size)
  50 {
  51     void *p = count && size ? calloc(count, size) : malloc(1);
  52     if (p == NULL) {
  53         out_of_memory();
  54     }
  55     return p;
  56 }
  57
  58 void *
  59 xmalloc(size_t size)
  60 {
  61     void *p = malloc(size ? size : 1);
  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     if (p == NULL) {
  73         out_of_memory();
  74     }
  75     return p;
  76 }
  77
  78 char *
  79 xstrdup(const char *s_)
  80 {
  81     size_t size = strlen(s_) + 1;
  82     char *s = xmalloc(size);
  83     memcpy(s, s_, size);
  84     return s;
  85 }
  86
  87 char *
  88 xasprintf(const char *format, ...)
  89 {
  90     va_list args;
  91     size_t needed;
  92     char *s;
  93
  94     va_start(args, format);
  95     needed = vsnprintf(NULL, 0, format, args);
  96     va_end(args);
  97
  98     s = xmalloc(needed + 1);
  99
 100     va_start(args, format);
 101     vsnprintf(s, needed + 1, format, args);
 102     va_end(args);
 103
 104     return s;
 105 }
 106
 107 void fatal(int err_no, const char *format, ...)
 108 {
 109     va_list args;
 110
 111     fprintf(stderr, "%s: ", program_name);
 112     va_start(args, format);
 113     vfprintf(stderr, format, args);
 114     va_end(args);
 115     if (err_no != 0)
 116         fprintf(stderr, " (%s)", strerror(err_no));
 117     putc('\n', stderr);
 118
 119     exit(EXIT_FAILURE);
 120 }
 121
 122 void error(int err_no, const char *format, ...)
 123 {
 124     va_list args;
 125
 126     fprintf(stderr, "%s: ", program_name);
 127     va_start(args, format);
 128     vfprintf(stderr, format, args);
 129     va_end(args);
 130     if (err_no != 0)
 131         fprintf(stderr, " (%s)", strerror(err_no));
 132     putc('\n', stderr);
 133 }
 134
 135 void debug(int err_no, const char *format, ...)
 136 {
 137     va_list args;
 138
 139     fprintf(stderr, "%s: ", program_name);
 140     va_start(args, format);
 141     vfprintf(stderr, format, args);
 142     va_end(args);
 143     if (err_no != 0)
 144         fprintf(stderr, " (%s)", strerror(err_no));
 145     putc('\n', stderr);
 146 }
 147
 148 /* Sets program_name based on 'argv0'.  Should be called at the beginning of
 149  * main(), as "set_program_name(argv[0]);".  */
 150 void set_program_name(const char *argv0)
 151 {
 152     const char *slash = strrchr(argv0, '/');
 153     program_name = slash ? slash + 1 : argv0;
 154 }
 155
 156 /* Writes the 'size' bytes in 'buf' to 'stream' as hex bytes arranged 16 per
 157  * line.  Numeric offsets are also included, starting at 'ofs' for the first
 158  * byte in 'buf'.  If 'ascii' is true then the corresponding ASCII characters
 159  * are also rendered alongside. */
 160 void
 161 hex_dump(FILE *stream, const void *buf_, size_t size,
 162          uintptr_t ofs, bool ascii)
 163 {
 164   const uint8_t *buf = buf_;
 165   const size_t per_line = 16; /* Maximum bytes per line. */
 166
 167   while (size > 0)
 168     {
 169       size_t start, end, n;
 170       size_t i;
 171
 172       /* Number of bytes on this line. */
 173       start = ofs % per_line;
 174       end = per_line;
 175       if (end - start > size)
 176         end = start + size;
 177       n = end - start;
 178
 179       /* Print line. */
 180       fprintf(stream, "%08jx  ", (uintmax_t) ROUND_DOWN(ofs, per_line));
 181       for (i = 0; i < start; i++)
 182         fprintf(stream, "   ");
 183       for (; i < end; i++)
 184         fprintf(stream, "%02hhx%c",
 185                 buf[i - start], i == per_line / 2 - 1? '-' : ' ');
 186       if (ascii)
 187         {
 188           for (; i < per_line; i++)
 189             fprintf(stream, "   ");
 190           fprintf(stream, "|");
 191           for (i = 0; i < start; i++)
 192             fprintf(stream, " ");
 193           for (; i < end; i++) {
 194               int c = buf[i - start];
 195               putc(c >= 32 && c < 127 ? c : '.', stream);
 196           }
 197           for (; i < per_line; i++)
 198             fprintf(stream, " ");
 199           fprintf(stream, "|");
 200         }
 201       fprintf(stream, "\n");
 202
 203       ofs += n;
 204       buf += n;
 205       size -= n;
 206     }
 207 }