2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
28 VLOG_DEFINE_THIS_MODULE(util);
30 COVERAGE_DEFINE(util_xalloc);
32 const char *program_name;
37 ovs_abort(0, "virtual memory exhausted");
41 xcalloc(size_t count, size_t size)
43 void *p = count && size ? calloc(count, size) : malloc(1);
44 COVERAGE_INC(util_xalloc);
54 return xcalloc(1, size);
60 void *p = malloc(size ? size : 1);
61 COVERAGE_INC(util_xalloc);
69 xrealloc(void *p, size_t size)
71 p = realloc(p, size ? size : 1);
72 COVERAGE_INC(util_xalloc);
80 xmemdup(const void *p_, size_t size)
82 void *p = xmalloc(size);
88 xmemdup0(const char *p_, size_t length)
90 char *p = xmalloc(length + 1);
91 memcpy(p, p_, length);
97 xstrdup(const char *s)
99 return xmemdup0(s, strlen(s));
103 xvasprintf(const char *format, va_list args)
109 va_copy(args2, args);
110 needed = vsnprintf(NULL, 0, format, args);
112 s = xmalloc(needed + 1);
114 vsnprintf(s, needed + 1, format, args2);
121 x2nrealloc(void *p, size_t *n, size_t s)
123 *n = *n == 0 ? 1 : 2 * *n;
124 return xrealloc(p, *n * s);
128 xasprintf(const char *format, ...)
133 va_start(args, format);
134 s = xvasprintf(format, args);
140 /* Similar to strlcpy() from OpenBSD, but it never reads more than 'size - 1'
141 * bytes from 'src' and doesn't return anything. */
143 ovs_strlcpy(char *dst, const char *src, size_t size)
146 size_t len = strnlen(src, size - 1);
147 memcpy(dst, src, len);
152 /* Copies 'src' to 'dst'. Reads no more than 'size - 1' bytes from 'src'.
153 * Always null-terminates 'dst' (if 'size' is nonzero), and writes a zero byte
154 * to every otherwise unused byte in 'dst'.
156 * Except for performance, the following call:
157 * ovs_strzcpy(dst, src, size);
158 * is equivalent to these two calls:
159 * memset(dst, '\0', size);
160 * ovs_strlcpy(dst, src, size);
162 * (Thus, ovs_strzcpy() is similar to strncpy() without some of the pitfalls.)
165 ovs_strzcpy(char *dst, const char *src, size_t size)
168 size_t len = strnlen(src, size - 1);
169 memcpy(dst, src, len);
170 memset(dst + len, '\0', size - len);
174 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
175 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
176 * the message inside parentheses. Then, terminates with abort().
178 * This function is preferred to ovs_fatal() in a situation where it would make
179 * sense for a monitoring process to restart the daemon.
181 * 'format' should not end with a new-line, because this function will add one
184 ovs_abort(int err_no, const char *format, ...)
188 va_start(args, format);
189 ovs_error_valist(err_no, format, args);
195 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
196 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
197 * the message inside parentheses. Then, terminates with EXIT_FAILURE.
199 * 'format' should not end with a new-line, because this function will add one
202 ovs_fatal(int err_no, const char *format, ...)
206 va_start(args, format);
207 ovs_error_valist(err_no, format, args);
213 /* Prints 'format' on stderr, formatting it like printf() does. If 'err_no' is
214 * nonzero, then it is formatted with ovs_retval_to_string() and appended to
215 * the message inside parentheses.
217 * 'format' should not end with a new-line, because this function will add one
220 ovs_error(int err_no, const char *format, ...)
224 va_start(args, format);
225 ovs_error_valist(err_no, format, args);
229 /* Same as ovs_error() except that the arguments are supplied as a va_list. */
231 ovs_error_valist(int err_no, const char *format, va_list args)
233 int save_errno = errno;
235 fprintf(stderr, "%s: ", program_name);
236 vfprintf(stderr, format, args);
238 fprintf(stderr, " (%s)", ovs_retval_to_string(err_no));
245 /* Many OVS functions return an int which is one of:
248 * - EOF: end of file (not necessarily an error; depends on the function called)
250 * Returns the appropriate human-readable string. The caller must copy the
251 * string if it wants to hold onto it, as the storage may be overwritten on
252 * subsequent function calls.
255 ovs_retval_to_string(int retval)
257 static char unknown[48];
263 return strerror(retval);
266 return "End of file";
268 snprintf(unknown, sizeof unknown, "***unknown return value: %d***", retval);
272 /* Sets program_name based on 'argv0'. Should be called at the beginning of
273 * main(), as "set_program_name(argv[0]);". */
274 void set_program_name(const char *argv0)
276 const char *slash = strrchr(argv0, '/');
277 program_name = slash ? slash + 1 : argv0;
280 /* Print the version information for the program. */
282 ovs_print_version(char *date, char *time,
283 uint8_t min_ofp, uint8_t max_ofp)
285 printf("%s (Open vSwitch) "VERSION BUILDNR"\n", program_name);
286 printf("Compiled %s %s\n", date, time);
287 if (min_ofp || max_ofp) {
288 printf("OpenFlow versions %#x:%#x\n", min_ofp, max_ofp);
292 /* Writes the 'size' bytes in 'buf' to 'stream' as hex bytes arranged 16 per
293 * line. Numeric offsets are also included, starting at 'ofs' for the first
294 * byte in 'buf'. If 'ascii' is true then the corresponding ASCII characters
295 * are also rendered alongside. */
297 ovs_hex_dump(FILE *stream, const void *buf_, size_t size,
298 uintptr_t ofs, bool ascii)
300 const uint8_t *buf = buf_;
301 const size_t per_line = 16; /* Maximum bytes per line. */
305 size_t start, end, n;
308 /* Number of bytes on this line. */
309 start = ofs % per_line;
311 if (end - start > size)
316 fprintf(stream, "%08jx ", (uintmax_t) ROUND_DOWN(ofs, per_line));
317 for (i = 0; i < start; i++)
318 fprintf(stream, " ");
320 fprintf(stream, "%02hhx%c",
321 buf[i - start], i == per_line / 2 - 1? '-' : ' ');
324 for (; i < per_line; i++)
325 fprintf(stream, " ");
326 fprintf(stream, "|");
327 for (i = 0; i < start; i++)
328 fprintf(stream, " ");
329 for (; i < end; i++) {
330 int c = buf[i - start];
331 putc(c >= 32 && c < 127 ? c : '.', stream);
333 for (; i < per_line; i++)
334 fprintf(stream, " ");
335 fprintf(stream, "|");
337 fprintf(stream, "\n");
346 str_to_int(const char *s, int base, int *i)
349 bool ok = str_to_llong(s, base, &ll);
355 str_to_long(const char *s, int base, long *li)
358 bool ok = str_to_llong(s, base, &ll);
364 str_to_llong(const char *s, int base, long long *x)
366 int save_errno = errno;
369 *x = strtoll(s, &tail, base);
370 if (errno == EINVAL || errno == ERANGE || tail == s || *tail != '\0') {
381 str_to_uint(const char *s, int base, unsigned int *u)
383 return str_to_int(s, base, (int *) u);
387 str_to_ulong(const char *s, int base, unsigned long *ul)
389 return str_to_long(s, base, (long *) ul);
393 str_to_ullong(const char *s, int base, unsigned long long *ull)
395 return str_to_llong(s, base, (long long *) ull);
398 /* Converts floating-point string 's' into a double. If successful, stores
399 * the double in '*d' and returns true; on failure, stores 0 in '*d' and
402 * Underflow (e.g. "1e-9999") is not considered an error, but overflow
403 * (e.g. "1e9999)" is. */
405 str_to_double(const char *s, double *d)
407 int save_errno = errno;
410 *d = strtod(s, &tail);
411 if (errno == EINVAL || (errno == ERANGE && *d != 0)
412 || tail == s || *tail != '\0') {
422 /* Returns the value of 'c' as a hexadecimal digit. */
427 case '0': case '1': case '2': case '3': case '4':
428 case '5': case '6': case '7': case '8': case '9':
454 /* Returns the integer value of the 'n' hexadecimal digits starting at 's', or
455 * UINT_MAX if one of those "digits" is not really a hex digit. If 'ok' is
456 * nonnull, '*ok' is set to true if the conversion succeeds or to false if a
457 * non-hex digit is detected. */
459 hexits_value(const char *s, size_t n, bool *ok)
465 for (i = 0; i < n; i++) {
466 int hexit = hexit_value(s[i]);
473 value = (value << 4) + hexit;
481 /* Returns the current working directory as a malloc()'d string, or a null
482 * pointer if the current working directory cannot be determined. */
489 /* Get maximum path length or at least a reasonable estimate. */
490 path_max = pathconf(".", _PC_PATH_MAX);
491 size = (path_max < 0 ? 1024
492 : path_max > 10240 ? 10240
495 /* Get current working directory. */
497 char *buf = xmalloc(size);
498 if (getcwd(buf, size)) {
499 return xrealloc(buf, strlen(buf) + 1);
503 if (error != ERANGE) {
504 VLOG_WARN("getcwd failed (%s)", strerror(error));
513 all_slashes_name(const char *s)
515 return xstrdup(s[0] == '/' && s[1] == '/' && s[2] != '/' ? "//"
520 /* Returns the directory name portion of 'file_name' as a malloc()'d string,
521 * similar to the POSIX dirname() function but thread-safe. */
523 dir_name(const char *file_name)
525 size_t len = strlen(file_name);
526 while (len > 0 && file_name[len - 1] == '/') {
529 while (len > 0 && file_name[len - 1] != '/') {
532 while (len > 0 && file_name[len - 1] == '/') {
535 return len ? xmemdup0(file_name, len) : all_slashes_name(file_name);
538 /* Returns the file name portion of 'file_name' as a malloc()'d string,
539 * similar to the POSIX basename() function but thread-safe. */
541 base_name(const char *file_name)
545 end = strlen(file_name);
546 while (end > 0 && file_name[end - 1] == '/') {
551 return all_slashes_name(file_name);
555 while (start > 0 && file_name[start - 1] != '/') {
559 return xmemdup0(file_name + start, end - start);
562 /* If 'file_name' starts with '/', returns a copy of 'file_name'. Otherwise,
563 * returns an absolute path to 'file_name' considering it relative to 'dir',
564 * which itself must be absolute. 'dir' may be null or the empty string, in
565 * which case the current working directory is used.
567 * Returns a null pointer if 'dir' is null and getcwd() fails. */
569 abs_file_name(const char *dir, const char *file_name)
571 if (file_name[0] == '/') {
572 return xstrdup(file_name);
573 } else if (dir && dir[0]) {
574 char *separator = dir[strlen(dir) - 1] == '/' ? "" : "/";
575 return xasprintf("%s%s%s", dir, separator, file_name);
577 char *cwd = get_cwd();
579 char *abs_name = xasprintf("%s/%s", cwd, file_name);
589 /* Pass a value to this function if it is marked with
590 * __attribute__((warn_unused_result)) and you genuinely want to ignore
591 * its return value. (Note that every scalar type can be implicitly
592 * converted to bool.) */
593 void ignore(bool x OVS_UNUSED) { }