/*
- * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include "bitmap.h"
#include "byte-order.h"
#include "coverage.h"
+#include "ovs-rcu.h"
#include "ovs-thread.h"
+#include "socket-util.h"
#include "vlog.h"
#ifdef HAVE_PTHREAD_SET_NAME_NP
#include <pthread_np.h>
COVERAGE_DEFINE(util_xalloc);
/* argv[0] without directory names. */
-const char *program_name;
+char *program_name;
/* Name for the currently running thread or process, for log messages, process
* listings, and debuggers. */
/* --version option output. */
static char *program_version;
-/* Buffer used by ovs_strerror(). */
+/* Buffer used by ovs_strerror() and ovs_format_message(). */
DEFINE_STATIC_PER_THREAD_DATA(struct { char s[128]; },
strerror_buffer,
{ "" });
+static char *xreadlink(const char *filename);
+
void
ovs_assert_failure(const char *where, const char *function,
const char *condition)
return xrealloc(p, *n * s);
}
+/* The desired minimum alignment for an allocated block of memory. */
+#define MEM_ALIGN MAX(sizeof(void *), 8)
+BUILD_ASSERT_DECL(IS_POW2(MEM_ALIGN));
+BUILD_ASSERT_DECL(CACHE_LINE_SIZE >= MEM_ALIGN);
+
+/* Allocates and returns 'size' bytes of memory in dedicated cache lines. That
+ * is, the memory block returned will not share a cache line with other data,
+ * avoiding "false sharing". (The memory returned will not be at the start of
+ * a cache line, though, so don't assume such alignment.)
+ *
+ * Use free_cacheline() to free the returned memory block. */
+void *
+xmalloc_cacheline(size_t size)
+{
+#ifdef HAVE_POSIX_MEMALIGN
+ void *p;
+ int error;
+
+ COVERAGE_INC(util_xalloc);
+ error = posix_memalign(&p, CACHE_LINE_SIZE, size ? size : 1);
+ if (error != 0) {
+ out_of_memory();
+ }
+ return p;
+#else
+ void **payload;
+ void *base;
+
+ /* Allocate room for:
+ *
+ * - Up to CACHE_LINE_SIZE - 1 bytes before the payload, so that the
+ * start of the payload doesn't potentially share a cache line.
+ *
+ * - A payload consisting of a void *, followed by padding out to
+ * MEM_ALIGN bytes, followed by 'size' bytes of user data.
+ *
+ * - Space following the payload up to the end of the cache line, so
+ * that the end of the payload doesn't potentially share a cache line
+ * with some following block. */
+ base = xmalloc((CACHE_LINE_SIZE - 1)
+ + ROUND_UP(MEM_ALIGN + size, CACHE_LINE_SIZE));
+
+ /* Locate the payload and store a pointer to the base at the beginning. */
+ payload = (void **) ROUND_UP((uintptr_t) base, CACHE_LINE_SIZE);
+ *payload = base;
+
+ return (char *) payload + MEM_ALIGN;
+#endif
+}
+
+/* Like xmalloc_cacheline() but clears the allocated memory to all zero
+ * bytes. */
+void *
+xzalloc_cacheline(size_t size)
+{
+ void *p = xmalloc_cacheline(size);
+ memset(p, 0, size);
+ return p;
+}
+
+/* Frees a memory block allocated with xmalloc_cacheline() or
+ * xzalloc_cacheline(). */
+void
+free_cacheline(void *p)
+{
+#ifdef HAVE_POSIX_MEMALIGN
+ free(p);
+#else
+ if (p) {
+ free(*(void **) ((uintptr_t) p - MEM_ALIGN));
+ }
+#endif
+}
+
char *
xasprintf(const char *format, ...)
{
: ovs_strerror(retval));
}
+/* This function returns the string describing the error number in 'error'
+ * for POSIX platforms. For Windows, this function can be used for C library
+ * calls. For socket calls that are also used in Windows, use sock_strerror()
+ * instead. For WINAPI calls, look at ovs_lasterror_to_string(). */
const char *
ovs_strerror(int error)
{
set_program_name__(const char *argv0, const char *version, const char *date,
const char *time)
{
-#ifdef _WIN32
char *basename;
+#ifdef _WIN32
size_t max_len = strlen(argv0) + 1;
- if (program_name) {
- return;
- }
+ SetErrorMode(GetErrorMode() | SEM_NOGPFAULTERRORBOX);
+ _set_output_format(_TWO_DIGIT_EXPONENT);
+
basename = xmalloc(max_len);
_splitpath_s(argv0, NULL, 0, NULL, 0, basename, max_len, NULL, 0);
- assert_single_threaded();
- program_name = basename;
#else
const char *slash = strrchr(argv0, '/');
- assert_single_threaded();
- program_name = slash ? slash + 1 : argv0;
+ basename = xstrdup(slash ? slash + 1 : argv0);
#endif
- free(program_version);
+ assert_single_threaded();
+ free(program_name);
+ /* Remove libtool prefix, if it is there */
+ if (strncmp(basename, "lt-", 3) == 0) {
+ char *tmp_name = basename;
+ basename = xstrdup(basename + 3);
+ free(tmp_name);
+ }
+ program_name = basename;
+ free(program_version);
if (!strcmp(version, VERSION)) {
program_version = xasprintf("%s (Open vSwitch) "VERSION"\n"
"Compiled %s %s\n",
}
}
+bool
+str_to_uint(const char *s, int base, unsigned int *u)
+{
+ long long ll;
+ bool ok = str_to_llong(s, base, &ll);
+ if (!ok || ll < 0 || ll > UINT_MAX) {
+ *u = 0;
+ return false;
+ } else {
+ *u = ll;
+ return true;
+ }
+}
+
/* Converts floating-point string 's' into a double. If successful, stores
* the double in '*d' and returns true; on failure, stores 0 in '*d' and
* returns false.
}
/* Returns the integer value of the 'n' hexadecimal digits starting at 's', or
- * UINT_MAX if one of those "digits" is not really a hex digit. If 'ok' is
- * nonnull, '*ok' is set to true if the conversion succeeds or to false if a
- * non-hex digit is detected. */
-unsigned int
+ * UINTMAX_MAX if one of those "digits" is not really a hex digit. Sets '*ok'
+ * to true if the conversion succeeds or to false if a non-hex digit is
+ * detected. */
+uintmax_t
hexits_value(const char *s, size_t n, bool *ok)
{
- unsigned int value;
+ uintmax_t value;
size_t i;
value = 0;
for (i = 0; i < n; i++) {
int hexit = hexit_value(s[i]);
if (hexit < 0) {
- if (ok) {
- *ok = false;
- }
- return UINT_MAX;
+ *ok = false;
+ return UINTMAX_MAX;
}
value = (value << 4) + hexit;
}
- if (ok) {
- *ok = true;
- }
+ *ok = true;
return value;
}
size_t size;
/* Get maximum path length or at least a reasonable estimate. */
+#ifndef _WIN32
path_max = pathconf(".", _PC_PATH_MAX);
+#else
+ path_max = MAX_PATH;
+#endif
size = (path_max < 0 ? 1024
: path_max > 10240 ? 10240
: path_max);
: ".");
}
+#ifndef _WIN32
/* Returns the directory name portion of 'file_name' as a malloc()'d string,
* similar to the POSIX dirname() function but thread-safe. */
char *
return xmemdup0(file_name + start, end - start);
}
+#endif /* _WIN32 */
/* If 'file_name' starts with '/', returns a copy of 'file_name'. Otherwise,
* returns an absolute path to 'file_name' considering it relative to 'dir',
/* Like readlink(), but returns the link name as a null-terminated string in
* allocated memory that the caller must eventually free (with free()).
* Returns NULL on error, in which case errno is set appropriately. */
-char *
+static char *
xreadlink(const char *filename)
{
size_t size;
*
* - Only symlinks in the final component of 'filename' are dereferenced.
*
+ * For Windows platform, this function returns a string that has the same
+ * value as the passed string.
+ *
* The caller must eventually free the returned string (with free()). */
char *
follow_symlinks(const char *filename)
{
+#ifndef _WIN32
struct stat s;
char *fn;
int i;
VLOG_WARN("%s: too many levels of symlinks", filename);
free(fn);
+#endif
return xstrdup(filename);
}
}
/* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. */
-#if __GNUC__ >= 4
+#if __GNUC__ >= 4 || _MSC_VER
/* Defined inline in util.h. */
#else
/* Returns the number of trailing 0-bits in 'n'. Undefined if 'n' == 0. */
/* Returns true if the 'n' bytes starting at 'p' are zeros. */
bool
-is_all_zeros(const uint8_t *p, size_t n)
+is_all_zeros(const void *p_, size_t n)
{
+ const uint8_t *p = p_;
size_t i;
for (i = 0; i < n; i++) {
/* Returns true if the 'n' bytes starting at 'p' are 0xff. */
bool
-is_all_ones(const uint8_t *p, size_t n)
+is_all_ones(const void *p_, size_t n)
{
+ const uint8_t *p = p_;
size_t i;
for (i = 0; i < n; i++) {
return true;
}
+/* Scans the bits in 'p' that have bit offsets 'start' through 'end'
+ * (inclusive) for the first bit with value 'target'. If one is found, returns
+ * its offset, otherwise 'end'. 'p' is 'len' bytes long.
+ *
+ * If you consider all of 'p' to be a single unsigned integer in network byte
+ * order, then bit N is the bit with value 2**N. That is, bit 0 is the bit
+ * with value 1 in p[len - 1], bit 1 is the bit with value 2, bit 2 is the bit
+ * with value 4, ..., bit 8 is the bit with value 1 in p[len - 2], and so on.
+ *
+ * Required invariant:
+ * start <= end
+ */
+unsigned int
+bitwise_scan(const void *p_, unsigned int len, bool target, unsigned int start,
+ unsigned int end)
+{
+ const uint8_t *p = p_;
+ unsigned int ofs;
+
+ for (ofs = start; ofs < end; ofs++) {
+ bool bit = (p[len - (ofs / 8 + 1)] & (1u << (ofs % 8))) != 0;
+ if (bit == target) {
+ break;
+ }
+ }
+ return ofs;
+}
+
+
/* Copies the 'n_bits' low-order bits of 'value' into the 'n_bits' bits
* starting at bit 'dst_ofs' in 'dst', which is 'dst_len' bytes long.
*
return s + n;
}
-/* This is an implementation of the standard sscanf() function, with the
- * following exceptions:
- *
- * - It returns true if the entire format was successfully scanned and
- * converted, false if any conversion failed.
- *
- * - The standard doesn't define sscanf() behavior when an out-of-range value
- * is scanned, e.g. if a "%"PRIi8 conversion scans "-1" or "0x1ff". Some
- * implementations consider this an error and stop scanning. This
- * implementation never considers an out-of-range value an error; instead,
- * it stores the least-significant bits of the converted value in the
- * destination, e.g. the value 255 for both examples earlier.
- *
- * - Only single-byte characters are supported, that is, the 'l' modifier
- * on %s, %[, and %c is not supported. The GNU extension 'a' modifier is
- * also not supported.
- *
- * - %p is not supported.
- */
-bool
-ovs_scan(const char *s, const char *format, ...)
+static bool
+ovs_scan__(const char *s, int *n, const char *format, va_list *args)
{
const char *const start = s;
bool ok = false;
const char *p;
- va_list args;
- va_start(args, format);
p = format;
while (*p != '\0') {
struct scan_spec spec;
}
switch (c) {
case 'd':
- s = scan_int(s, &spec, 10, &args);
+ s = scan_int(s, &spec, 10, args);
break;
case 'i':
- s = scan_int(s, &spec, 0, &args);
+ s = scan_int(s, &spec, 0, args);
break;
case 'o':
- s = scan_int(s, &spec, 8, &args);
+ s = scan_int(s, &spec, 8, args);
break;
case 'u':
- s = scan_int(s, &spec, 10, &args);
+ s = scan_int(s, &spec, 10, args);
break;
case 'x':
case 'X':
- s = scan_int(s, &spec, 16, &args);
+ s = scan_int(s, &spec, 16, args);
break;
case 'e':
case 'g':
case 'E':
case 'G':
- s = scan_float(s, &spec, &args);
+ s = scan_float(s, &spec, args);
break;
case 's':
- s = scan_string(s, &spec, &args);
+ s = scan_string(s, &spec, args);
break;
case '[':
- s = scan_set(s, &spec, &p, &args);
+ s = scan_set(s, &spec, &p, args);
break;
case 'c':
- s = scan_chars(s, &spec, &args);
+ s = scan_chars(s, &spec, args);
break;
case 'n':
if (spec.type != SCAN_DISCARD) {
- *va_arg(args, int *) = s - start;
+ *va_arg(*args, int *) = s - start;
}
break;
}
goto exit;
}
}
- ok = true;
+ if (n) {
+ *n = s - start;
+ }
+ ok = true;
exit:
- va_end(args);
return ok;
}
+/* This is an implementation of the standard sscanf() function, with the
+ * following exceptions:
+ *
+ * - It returns true if the entire format was successfully scanned and
+ * converted, false if any conversion failed.
+ *
+ * - The standard doesn't define sscanf() behavior when an out-of-range value
+ * is scanned, e.g. if a "%"PRIi8 conversion scans "-1" or "0x1ff". Some
+ * implementations consider this an error and stop scanning. This
+ * implementation never considers an out-of-range value an error; instead,
+ * it stores the least-significant bits of the converted value in the
+ * destination, e.g. the value 255 for both examples earlier.
+ *
+ * - Only single-byte characters are supported, that is, the 'l' modifier
+ * on %s, %[, and %c is not supported. The GNU extension 'a' modifier is
+ * also not supported.
+ *
+ * - %p is not supported.
+ */
+bool
+ovs_scan(const char *s, const char *format, ...)
+{
+ va_list args;
+ bool res;
+
+ va_start(args, format);
+ res = ovs_scan__(s, NULL, format, &args);
+ va_end(args);
+ return res;
+}
+
+/*
+ * This function is similar to ocs_scan(), extra parameter `n` is added to
+ * return number of scanned characters.
+ */
+bool
+ovs_scan_len(const char *s, int *n, const char *format, ...)
+{
+ va_list args;
+ bool success;
+ int n1;
+
+ va_start(args, format);
+ success = ovs_scan__(s + *n, &n1, format, &args);
+ va_end(args);
+ if (success) {
+ *n = *n + n1;
+ }
+ return success;
+}
+
+void
+xsleep(unsigned int seconds)
+{
+ ovsrcu_quiesce_start();
+#ifdef _WIN32
+ Sleep(seconds * 1000);
+#else
+ sleep(seconds);
+#endif
+ ovsrcu_quiesce_end();
+}
+
#ifdef _WIN32
\f
-/* Calls FormatMessage() with GetLastError() as an argument. Returns
- * pointer to a buffer that receives the null-terminated string that specifies
- * the formatted message and that has to be freed by the caller with
- * LocalFree(). */
char *
-ovs_lasterror_to_string(void)
+ovs_format_message(int error)
{
- char *buffer;
- FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM
- | FORMAT_MESSAGE_IGNORE_INSERTS, NULL, GetLastError(), 0,
- (char *)&buffer, 0, NULL);
+ enum { BUFSIZE = sizeof strerror_buffer_get()->s };
+ char *buffer = strerror_buffer_get()->s;
+
+ FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
+ NULL, error, 0, buffer, BUFSIZE, NULL);
return buffer;
}
+
+/* Returns a null-terminated string that explains the last error.
+ * Use this function to get the error string for WINAPI calls. */
+char *
+ovs_lasterror_to_string(void)
+{
+ return ovs_format_message(GetLastError());
+}
+
+int
+ftruncate(int fd, off_t length)
+{
+ int error;
+
+ error = _chsize_s(fd, length);
+ if (error) {
+ return -1;
+ }
+ return 0;
+}
+
+OVS_CONSTRUCTOR(winsock_start) {
+ WSADATA wsaData;
+ int error;
+
+ error = WSAStartup(MAKEWORD(2, 2), &wsaData);
+ if (error != 0) {
+ VLOG_FATAL("WSAStartup failed: %s", sock_strerror(sock_errno()));
+ }
+}
#endif