From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; Signed-off-by: Daniel P. Berrange <berrange(a)redhat.com&gt; --- src/Makefile.am | 2 +- src/conf/cpu_conf.h | 2 +- src/conf/domain_conf.c | 3 +- src/conf/domain_conf.h | 2 +- src/conf/network_conf.h | 2 +- src/conf/snapshot_conf.c | 2 +- src/libxl/libxl_conf.h | 2 +- src/qemu/qemu_capabilities.c | 2 +- src/qemu/qemu_conf.h | 2 +- src/qemu/qemu_driver.c | 2 +- src/qemu/qemu_monitor.h | 2 +- src/qemu/qemu_monitor_json.h | 2 +- src/qemu/qemu_process.c | 2 +- src/util/bitmap.c | 636 ------------------------------------------- src/util/bitmap.h | 109 -------- src/util/dnsmasq.c | 2 +- src/util/processinfo.h | 2 +- src/util/virbitmap.c | 636 +++++++++++++++++++++++++++++++++++++++++++ src/util/virbitmap.h | 109 ++++++++ tests/virbitmaptest.c | 2 +- tools/virsh-domain.c | 2 +- tools/virsh.c | 2 +- 22 files changed, 763 insertions(+), 764 deletions(-) delete mode 100644 src/util/bitmap.c delete mode 100644 src/util/bitmap.h create mode 100644 src/util/virbitmap.c create mode 100644 src/util/virbitmap.h diff --git a/src/Makefile.am b/src/Makefile.am index 149ffc9..25a21e8 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -53,7 +53,6 @@ augeastest_DATA = # These files are not related to driver APIs. Simply generic # helper APIs for various purposes UTIL_SOURCES = \ - util/bitmap.c util/bitmap.h \ util/buf.c util/buf.h \ util/command.c util/command.h \ util/conf.c util/conf.h \ @@ -83,6 +82,7 @@ UTIL_SOURCES = \ util/viraudit.c util/viraudit.h \ util/virauth.c util/virauth.h \ util/virauthconfig.c util/virauthconfig.h \ + util/virbitmap.c util/virbitmap.h \ util/virfile.c util/virfile.h \ util/virnodesuspend.c util/virnodesuspend.h \ util/virobject.c util/virobject.h \ diff --git a/src/conf/cpu_conf.h b/src/conf/cpu_conf.h index 879f8eb..38fc675 100644 --- a/src/conf/cpu_conf.h +++ b/src/conf/cpu_conf.h @@ -27,7 +27,7 @@ # include "util.h" # include "buf.h" # include "xml.h" -# include "bitmap.h" +# include "virbitmap.h" # define VIR_CPU_VENDOR_ID_LENGTH 12 diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c index 19af058..c90c6b9 100644 --- a/src/conf/domain_conf.c +++ b/src/conf/domain_conf.c @@ -44,14 +44,13 @@ #include "nwfilter_conf.h" #include "storage_file.h" #include "virfile.h" -#include "bitmap.h" +#include "virbitmap.h" #include "count-one-bits.h" #include "secret_conf.h" #include "netdev_vport_profile_conf.h" #include "netdev_bandwidth_conf.h" #include "netdev_vlan_conf.h" #include "device_conf.h" -#include "bitmap.h" #define VIR_FROM_THIS VIR_FROM_DOMAIN diff --git a/src/conf/domain_conf.h b/src/conf/domain_conf.h index bc9ef88..26d2264 100644 --- a/src/conf/domain_conf.h +++ b/src/conf/domain_conf.h @@ -46,7 +46,7 @@ # include "virnetdevvlan.h" # include "virobject.h" # include "device_conf.h" -# include "bitmap.h" +# include "virbitmap.h" # include "storage_file.h" /* forward declarations of all device types, required by diff --git a/src/conf/network_conf.h b/src/conf/network_conf.h index 72cf64b..4d70fe6 100644 --- a/src/conf/network_conf.h +++ b/src/conf/network_conf.h @@ -38,7 +38,7 @@ # include "virnetdevvlan.h" # include "virmacaddr.h" # include "device_conf.h" -# include "bitmap.h" +# include "virbitmap.h" enum virNetworkForwardType { VIR_NETWORK_FORWARD_NONE = 0, diff --git a/src/conf/snapshot_conf.c b/src/conf/snapshot_conf.c index bba1bb7..95b7943 100644 --- a/src/conf/snapshot_conf.c +++ b/src/conf/snapshot_conf.c @@ -29,7 +29,7 @@ #include <unistd.h> #include "internal.h" -#include "bitmap.h" +#include "virbitmap.h" #include "buf.h" #include "count-one-bits.h" #include "datatypes.h" diff --git a/src/libxl/libxl_conf.h b/src/libxl/libxl_conf.h index 6bcf805..c8808a1 100644 --- a/src/libxl/libxl_conf.h +++ b/src/libxl/libxl_conf.h @@ -34,7 +34,7 @@ # include "domain_event.h" # include "capabilities.h" # include "configmake.h" -# include "bitmap.h" +# include "virbitmap.h" # define LIBXL_VNC_PORT_MIN 5900 diff --git a/src/qemu/qemu_capabilities.c b/src/qemu/qemu_capabilities.c index 104a3f8..45962b0 100644 --- a/src/qemu/qemu_capabilities.c +++ b/src/qemu/qemu_capabilities.c @@ -35,7 +35,7 @@ #include "cpu/cpu.h" #include "domain_conf.h" #include "command.h" -#include "bitmap.h" +#include "virbitmap.h" #include "virnodesuspend.h" #include "qemu_monitor.h" diff --git a/src/qemu/qemu_conf.h b/src/qemu/qemu_conf.h index cfa6fff..bcf21c3 100644 --- a/src/qemu/qemu_conf.h +++ b/src/qemu/qemu_conf.h @@ -39,7 +39,7 @@ # include "hostusb.h" # include "cpu_conf.h" # include "driver.h" -# include "bitmap.h" +# include "virbitmap.h" # include "command.h" # include "threadpool.h" # include "locking/lock_manager.h" diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c index 2dd6922..e87397f 100644 --- a/src/qemu/qemu_driver.c +++ b/src/qemu/qemu_driver.c @@ -92,7 +92,7 @@ #include "virnodesuspend.h" #include "virtime.h" #include "virtypedparam.h" -#include "bitmap.h" +#include "virbitmap.h" #define VIR_FROM_THIS VIR_FROM_QEMU diff --git a/src/qemu/qemu_monitor.h b/src/qemu/qemu_monitor.h index dbfab88..8c42b12 100644 --- a/src/qemu/qemu_monitor.h +++ b/src/qemu/qemu_monitor.h @@ -28,7 +28,7 @@ # include "internal.h" # include "domain_conf.h" -# include "bitmap.h" +# include "virbitmap.h" # include "virhash.h" # include "json.h" # include "device_conf.h" diff --git a/src/qemu/qemu_monitor_json.h b/src/qemu/qemu_monitor_json.h index acca4ec..2b09a8f 100644 --- a/src/qemu/qemu_monitor_json.h +++ b/src/qemu/qemu_monitor_json.h @@ -28,7 +28,7 @@ # include "internal.h" # include "qemu_monitor.h" -# include "bitmap.h" +# include "virbitmap.h" int qemuMonitorJSONIOProcess(qemuMonitorPtr mon, const char *data, diff --git a/src/qemu/qemu_process.c b/src/qemu/qemu_process.c index cc0e947..969cbc7 100644 --- a/src/qemu/qemu_process.c +++ b/src/qemu/qemu_process.c @@ -69,7 +69,7 @@ #include "virprocess.h" #include "virtime.h" #include "virnetdevtap.h" -#include "bitmap.h" +#include "virbitmap.h" #define VIR_FROM_THIS VIR_FROM_QEMU diff --git a/src/util/bitmap.c b/src/util/bitmap.c deleted file mode 100644 index c29f5f3..0000000 --- a/src/util/bitmap.c +++ /dev/null @@ -1,636 +0,0 @@ -/* - * bitmap.h: Simple bitmap operations - * - * Copyright (C) 2010-2012 Red Hat, Inc. - * Copyright (C) 2010 Novell, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Author: Jim Fehlig <jfehlig(a)novell.com&gt; - */ - -#include <config.h> - -#include <limits.h> -#include <stdint.h> -#include <stdio.h> -#include <string.h> -#include <stdlib.h> -#include <sys/types.h> - -#include "bitmap.h" -#include "memory.h" -#include "buf.h" -#include "util.h" -#include "c-ctype.h" -#include "count-one-bits.h" - - -struct _virBitmap { - size_t max_bit; - size_t map_len; - unsigned long *map; -}; - - -#define VIR_BITMAP_BITS_PER_UNIT ((int) sizeof(unsigned long) * CHAR_BIT) -#define VIR_BITMAP_UNIT_OFFSET(b) ((b) / VIR_BITMAP_BITS_PER_UNIT) -#define VIR_BITMAP_BIT_OFFSET(b) ((b) % VIR_BITMAP_BITS_PER_UNIT) -#define VIR_BITMAP_BIT(b) (1UL << VIR_BITMAP_BIT_OFFSET(b)) - - -/** - * virBitmapNew: - * @size: number of bits - * - * Allocate a bitmap capable of containing @size bits. - * - * Returns a pointer to the allocated bitmap or NULL if - * memory cannot be allocated. - */ -virBitmapPtr virBitmapNew(size_t size) -{ - virBitmapPtr bitmap; - size_t sz; - - if (SIZE_MAX - VIR_BITMAP_BITS_PER_UNIT < size || size == 0) - return NULL; - - sz = (size + VIR_BITMAP_BITS_PER_UNIT - 1) / - VIR_BITMAP_BITS_PER_UNIT; - - if (VIR_ALLOC(bitmap) < 0) - return NULL; - - if (VIR_ALLOC_N(bitmap->map, sz) < 0) { - VIR_FREE(bitmap); - return NULL; - } - - bitmap->max_bit = size; - bitmap->map_len = sz; - return bitmap; -} - -/** - * virBitmapFree: - * @bitmap: previously allocated bitmap - * - * Free @bitmap previously allocated by virBitmapNew. - */ -void virBitmapFree(virBitmapPtr bitmap) -{ - if (bitmap) { - VIR_FREE(bitmap->map); - VIR_FREE(bitmap); - } -} - - -int virBitmapCopy(virBitmapPtr dst, virBitmapPtr src) -{ - if (dst->max_bit != src->max_bit) { - errno = EINVAL; - return -1; - } - - memcpy(dst->map, src->map, src->map_len * sizeof(src->map[0])); - - return 0; -} - - -/** - * virBitmapSetBit: - * @bitmap: Pointer to bitmap - * @b: bit position to set - * - * Set bit position @b in @bitmap - * - * Returns 0 on if bit is successfully set, -1 on error. - */ -int virBitmapSetBit(virBitmapPtr bitmap, size_t b) -{ - if (bitmap->max_bit <= b) - return -1; - - bitmap->map[VIR_BITMAP_UNIT_OFFSET(b)] |= VIR_BITMAP_BIT(b); - return 0; -} - -/** - * virBitmapClearBit: - * @bitmap: Pointer to bitmap - * @b: bit position to clear - * - * Clear bit position @b in @bitmap - * - * Returns 0 on if bit is successfully clear, -1 on error. - */ -int virBitmapClearBit(virBitmapPtr bitmap, size_t b) -{ - if (bitmap->max_bit <= b) - return -1; - - bitmap->map[VIR_BITMAP_UNIT_OFFSET(b)] &= ~VIR_BITMAP_BIT(b); - return 0; -} - -/* Helper function. caller must ensure b < bitmap->max_bit */ -static bool virBitmapIsSet(virBitmapPtr bitmap, size_t b) -{ - return !!(bitmap->map[VIR_BITMAP_UNIT_OFFSET(b)] & VIR_BITMAP_BIT(b)); -} - -/** - * virBitmapGetBit: - * @bitmap: Pointer to bitmap - * @b: bit position to get - * @result: bool pointer to receive bit setting - * - * Get setting of bit position @b in @bitmap and store in @result - * - * On success, @result will contain the setting of @b and 0 is - * returned. On failure, -1 is returned and @result is unchanged. - */ -int virBitmapGetBit(virBitmapPtr bitmap, size_t b, bool *result) -{ - if (bitmap->max_bit <= b) - return -1; - - *result = virBitmapIsSet(bitmap, b); - return 0; -} - -/** - * virBitmapString: - * @bitmap: Pointer to bitmap - * - * Convert @bitmap to printable string. - * - * Returns pointer to the string or NULL on error. - */ -char *virBitmapString(virBitmapPtr bitmap) -{ - virBuffer buf = VIR_BUFFER_INITIALIZER; - size_t sz; - - virBufferAddLit(&buf, "0x"); - - sz = bitmap->map_len; - - while (sz--) { - virBufferAsprintf(&buf, "%0*lx", - VIR_BITMAP_BITS_PER_UNIT / 4, - bitmap->map[sz]); - } - - if (virBufferError(&buf)) { - virBufferFreeAndReset(&buf); - return NULL; - } - - return virBufferContentAndReset(&buf); -} - -/** - * virBitmapFormat: - * @bitmap: the bitmap - * - * This function is the counterpart of virBitmapParse. This function creates - * a human-readable string representing the bits in bitmap. - * - * See virBitmapParse for the format of @str. - * - * Returns the string on success or NULL otherwise. Caller should call - * VIR_FREE to free the string. - */ -char *virBitmapFormat(virBitmapPtr bitmap) -{ - virBuffer buf = VIR_BUFFER_INITIALIZER; - bool first = true; - int start, cur, prev; - - if (!bitmap) - return NULL; - - cur = virBitmapNextSetBit(bitmap, -1); - if (cur < 0) - return strdup(""); - - start = prev = cur; - while (prev >= 0) { - cur = virBitmapNextSetBit(bitmap, prev); - - if (cur == prev + 1) { - prev = cur; - continue; - } - - /* cur < 0 or cur > prev + 1 */ - - if (!first) - virBufferAddLit(&buf, ","); - else - first = false; - - if (prev == start) - virBufferAsprintf(&buf, "%d", start); - else - virBufferAsprintf(&buf, "%d-%d", start, prev); - - start = prev = cur; - } - - if (virBufferError(&buf)) { - virBufferFreeAndReset(&buf); - return NULL; - } - - return virBufferContentAndReset(&buf); -} - -/** - * virBitmapParse: - * @str: points to a string representing a human-readable bitmap - * @bitmap: a bitmap created from @str - * @bitmapSize: the upper limit of num of bits in created bitmap - * - * This function is the counterpart of virBitmapFormat. This function creates - * a bitmap, in which bits are set according to the content of @str. - * - * @str is a comma separated string of fields N, which means a number of bit - * to set, and ^N, which means to unset the bit, and N-M for ranges of bits - * to set. - * - * Returns the number of bits set in @bitmap, or -1 in case of error. - */ - -int virBitmapParse(const char *str, - char sep, - virBitmapPtr *bitmap, - size_t bitmapSize) -{ - int ret = 0; - bool neg = false; - const char *cur; - char *tmp; - int i, start, last; - - if (!str) - return -1; - - cur = str; - virSkipSpaces(&cur); - - if (*cur == 0) - return -1; - - *bitmap = virBitmapNew(bitmapSize); - if (!*bitmap) - return -1; - - while (*cur != 0 && *cur != sep) { - /* - * 3 constructs are allowed: - * - N : a single CPU number - * - N-M : a range of CPU numbers with N < M - * - ^N : remove a single CPU number from the current set - */ - if (*cur == '^') { - cur++; - neg = true; - } - - if (!c_isdigit(*cur)) - goto parse_error; - - if (virStrToLong_i(cur, &tmp, 10, &start) < 0) - goto parse_error; - if (start < 0) - goto parse_error; - - cur = tmp; - - virSkipSpaces(&cur); - - if (*cur == ',' || *cur == 0 || *cur == sep) { - if (neg) { - if (virBitmapIsSet(*bitmap, start)) { - ignore_value(virBitmapClearBit(*bitmap, start)); - ret--; - } - } else { - if (!virBitmapIsSet(*bitmap, start)) { - ignore_value(virBitmapSetBit(*bitmap, start)); - ret++; - } - } - } else if (*cur == '-') { - if (neg) - goto parse_error; - - cur++; - virSkipSpaces(&cur); - - if (virStrToLong_i(cur, &tmp, 10, &last) < 0) - goto parse_error; - if (last < start) - goto parse_error; - - cur = tmp; - - for (i = start; i <= last; i++) { - if (!virBitmapIsSet(*bitmap, i)) { - ignore_value(virBitmapSetBit(*bitmap, i)); - ret++; - } - } - - virSkipSpaces(&cur); - } - - if (*cur == ',') { - cur++; - virSkipSpaces(&cur); - neg = false; - } else if (*cur == 0 || *cur == sep) { - break; - } else { - goto parse_error; - } - } - - return ret; - -parse_error: - virBitmapFree(*bitmap); - *bitmap = NULL; - return -1; -} - -/** - * virBitmapNewCopy: - * @src: the source bitmap. - * - * Makes a copy of bitmap @src. - * - * returns the copied bitmap on success, or NULL otherwise. Caller - * should call virBitmapFree to free the returned bitmap. - */ -virBitmapPtr virBitmapNewCopy(virBitmapPtr src) -{ - virBitmapPtr dst; - - if ((dst = virBitmapNew(src->max_bit)) == NULL) - return NULL; - - if (virBitmapCopy(dst, src) != 0) { - virBitmapFree(dst); - return NULL; - } - - return dst; -} - -/** - * virBitmapNewData: - * @data: the data - * @len: length of @data in bytes - * - * Allocate a bitmap from a chunk of data containing bits - * information - * - * Returns a pointer to the allocated bitmap or NULL if - * memory cannot be allocated. - */ -virBitmapPtr virBitmapNewData(void *data, int len) -{ - virBitmapPtr bitmap; - int i, j; - unsigned long *p; - unsigned char *bytes = data; - - bitmap = virBitmapNew(len * CHAR_BIT); - if (!bitmap) - return NULL; - - /* le64toh is not provided by gnulib, so we do the conversion by hand */ - p = bitmap->map; - for (i = j = 0; i < len; i++, j++) { - if (j == sizeof(*p)) { - j = 0; - p++; - } - *p |= (unsigned long) bytes[i] << (j * CHAR_BIT); - } - - return bitmap; -} - -/** - * virBitmapToData: - * @data: the data - * @len: len of @data in byte - * - * Convert a bitmap to a chunk of data containing bits information. - * Data consists of sequential bytes, with lower bytes containing - * lower bits. - * - * Returns 0 on success, -1 otherwise. - */ -int virBitmapToData(virBitmapPtr bitmap, unsigned char **data, int *dataLen) -{ - int len; - unsigned long *l; - int i, j; - unsigned char *bytes; - - len = (bitmap->max_bit + CHAR_BIT - 1) / CHAR_BIT; - - if (VIR_ALLOC_N(*data, len) < 0) - return -1; - - bytes = *data; - *dataLen = len; - - /* htole64 is not provided by gnulib, so we do the conversion by hand */ - l = bitmap->map; - for (i = j = 0; i < len; i++, j++) { - if (j == sizeof(*l)) { - j = 0; - l++; - } - bytes[i] = *l >> (j * CHAR_BIT); - } - - return 0; -} - -/** - * virBitmapEqual: - * @b1: bitmap 1 - * @b2: bitmap 2 - * - * Compares two bitmaps, whose lengths can be different from each other. - * - * Returns true if two bitmaps have exactly the same set of bits set, - * otherwise false. - */ -bool virBitmapEqual(virBitmapPtr b1, virBitmapPtr b2) -{ - virBitmapPtr tmp; - int i; - - if (b1->max_bit > b2->max_bit) { - tmp = b1; - b1 = b2; - b2 = tmp; - } - - /* Now b1 is the smaller one, if not equal */ - - for (i = 0; i < b1->map_len; i++) { - if (b1->map[i] != b2->map[i]) - return false; - } - - for (; i < b2->map_len; i++) { - if (b2->map[i]) - return false; - } - - return true; -} - -size_t virBitmapSize(virBitmapPtr bitmap) -{ - return bitmap->max_bit; -} - -/** - * virBitmapSetAll: - * @bitmap: the bitmap - * - * set all bits in @bitmap. - */ -void virBitmapSetAll(virBitmapPtr bitmap) -{ - int tail = bitmap->max_bit % VIR_BITMAP_BITS_PER_UNIT; - - memset(bitmap->map, 0xff, - bitmap->map_len * (VIR_BITMAP_BITS_PER_UNIT / CHAR_BIT)); - - /* Ensure tail bits are clear. */ - if (tail) - bitmap->map[bitmap->map_len - 1] &= - -1UL >> (VIR_BITMAP_BITS_PER_UNIT - tail); -} - -/** - * virBitmapClearAll: - * @bitmap: the bitmap - * - * clear all bits in @bitmap. - */ -void virBitmapClearAll(virBitmapPtr bitmap) -{ - memset(bitmap->map, 0, - bitmap->map_len * (VIR_BITMAP_BITS_PER_UNIT / CHAR_BIT)); -} - -/** - * virBitmapIsAllSet: - * @bitmap: the bitmap to check - * - * check if all bits in @bitmap are set. - */ -bool virBitmapIsAllSet(virBitmapPtr bitmap) -{ - int i; - int unusedBits; - size_t sz; - - unusedBits = bitmap->map_len * VIR_BITMAP_BITS_PER_UNIT - bitmap->max_bit; - - sz = bitmap->map_len; - if (unusedBits > 0) - sz--; - - for (i = 0; i < sz; i++) - if (bitmap->map[i] != -1) - return false; - - if (unusedBits > 0) { - if ((bitmap->map[sz] & ((1UL << (VIR_BITMAP_BITS_PER_UNIT - unusedBits)) - 1)) - != ((1UL << (VIR_BITMAP_BITS_PER_UNIT - unusedBits)) - 1)) - return false; - } - - return true; -} - -/** - * virBitmapNextSetBit: - * @bitmap: the bitmap - * @pos: the position after which to search for a set bit - * - * search the first set bit after position @pos in bitmap @bitmap. - * @pos can be -1 to search for the first set bit. Position starts - * at 0. - * - * returns the position of the found bit, or -1 if no bit found. - */ -ssize_t virBitmapNextSetBit(virBitmapPtr bitmap, ssize_t pos) -{ - size_t nl; - size_t nb; - unsigned long bits; - - if (pos < 0) - pos = -1; - - pos++; - - if (pos >= bitmap->max_bit) - return -1; - - nl = pos / VIR_BITMAP_BITS_PER_UNIT; - nb = pos % VIR_BITMAP_BITS_PER_UNIT; - - bits = bitmap->map[nl] & ~((1UL << nb) - 1); - - while (bits == 0 && ++nl < bitmap->map_len) { - bits = bitmap->map[nl]; - } - - if (bits == 0) - return -1; - - return ffsl(bits) - 1 + nl * VIR_BITMAP_BITS_PER_UNIT; -} - -/* Return the number of bits currently set in the map. */ -size_t -virBitmapCountBits(virBitmapPtr bitmap) -{ - size_t i; - size_t ret = 0; - - for (i = 0; i < bitmap->map_len; i++) - ret += count_one_bits_l(bitmap->map[i]); - - return ret; -} diff --git a/src/util/bitmap.h b/src/util/bitmap.h deleted file mode 100644 index 346a1fb..0000000 --- a/src/util/bitmap.h +++ /dev/null @@ -1,109 +0,0 @@ -/* - * bitmap.h: Simple bitmap operations - * - * Copyright (C) 2012 Red Hat, Inc. - * Copyright (C) 2010 Novell, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Author: Jim Fehlig <jfehlig(a)novell.com&gt; - */ - -#ifndef __BITMAP_H__ -# define __BITMAP_H__ - -# include "internal.h" - -# include <sys/types.h> - - -typedef struct _virBitmap virBitmap; -typedef virBitmap *virBitmapPtr; - -/* - * Allocate a bitmap capable of containing @size bits. - */ -virBitmapPtr virBitmapNew(size_t size) ATTRIBUTE_RETURN_CHECK; - -/* - * Free previously allocated bitmap - */ -void virBitmapFree(virBitmapPtr bitmap); - -/* - * Copy all bits from @src to @dst. The bitmap sizes - * must be the same - */ -int virBitmapCopy(virBitmapPtr dst, virBitmapPtr src); - -/* - * Set bit position @b in @bitmap - */ -int virBitmapSetBit(virBitmapPtr bitmap, size_t b) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; - -/* - * Clear bit position @b in @bitmap - */ -int virBitmapClearBit(virBitmapPtr bitmap, size_t b) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; - -/* - * Get setting of bit position @b in @bitmap and store in @result - */ -int virBitmapGetBit(virBitmapPtr bitmap, size_t b, bool *result) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK; - -char *virBitmapString(virBitmapPtr bitmap) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; - -char *virBitmapFormat(virBitmapPtr bitmap) - ATTRIBUTE_NONNULL(1); - -int virBitmapParse(const char *str, - char sep, - virBitmapPtr *bitmap, - size_t bitmapSize) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3); - -virBitmapPtr virBitmapNewCopy(virBitmapPtr src) ATTRIBUTE_NONNULL(1); - -virBitmapPtr virBitmapNewData(void *data, int len) ATTRIBUTE_NONNULL(1); - -int virBitmapToData(virBitmapPtr bitmap, unsigned char **data, int *dataLen) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2); - -bool virBitmapEqual(virBitmapPtr b1, virBitmapPtr b2) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2); - -size_t virBitmapSize(virBitmapPtr bitmap) - ATTRIBUTE_NONNULL(1); - -void virBitmapSetAll(virBitmapPtr bitmap) - ATTRIBUTE_NONNULL(1); - -void virBitmapClearAll(virBitmapPtr bitmap) - ATTRIBUTE_NONNULL(1); - -bool virBitmapIsAllSet(virBitmapPtr bitmap) - ATTRIBUTE_NONNULL(1); - -ssize_t virBitmapNextSetBit(virBitmapPtr bitmap, ssize_t pos) - ATTRIBUTE_NONNULL(1); - -size_t virBitmapCountBits(virBitmapPtr bitmap) - ATTRIBUTE_NONNULL(1); - -#endif diff --git a/src/util/dnsmasq.c b/src/util/dnsmasq.c index e8eab1e..74593c8 100644 --- a/src/util/dnsmasq.c +++ b/src/util/dnsmasq.c @@ -39,7 +39,7 @@ #include "internal.h" #include "datatypes.h" -#include "bitmap.h" +#include "virbitmap.h" #include "dnsmasq.h" #include "util.h" #include "command.h" diff --git a/src/util/processinfo.h b/src/util/processinfo.h index 116c092..0ae23c6 100644 --- a/src/util/processinfo.h +++ b/src/util/processinfo.h @@ -23,7 +23,7 @@ # define __VIR_PROCESSINFO_H__ # include "internal.h" -# include "bitmap.h" +# include "virbitmap.h" int virProcessInfoSetAffinity(pid_t pid, virBitmapPtr map); diff --git a/src/util/virbitmap.c b/src/util/virbitmap.c new file mode 100644 index 0000000..0f13389 --- /dev/null +++ b/src/util/virbitmap.c @@ -0,0 +1,636 @@ +/* + * bitmap.h: Simple bitmap operations + * + * Copyright (C) 2010-2012 Red Hat, Inc. + * Copyright (C) 2010 Novell, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Author: Jim Fehlig <jfehlig(a)novell.com&gt; + */ + +#include <config.h> + +#include <limits.h> +#include <stdint.h> +#include <stdio.h> +#include <string.h> +#include <stdlib.h> +#include <sys/types.h> + +#include "virbitmap.h" +#include "memory.h" +#include "buf.h" +#include "util.h" +#include "c-ctype.h" +#include "count-one-bits.h" + + +struct _virBitmap { + size_t max_bit; + size_t map_len; + unsigned long *map; +}; + + +#define VIR_BITMAP_BITS_PER_UNIT ((int) sizeof(unsigned long) * CHAR_BIT) +#define VIR_BITMAP_UNIT_OFFSET(b) ((b) / VIR_BITMAP_BITS_PER_UNIT) +#define VIR_BITMAP_BIT_OFFSET(b) ((b) % VIR_BITMAP_BITS_PER_UNIT) +#define VIR_BITMAP_BIT(b) (1UL << VIR_BITMAP_BIT_OFFSET(b)) + + +/** + * virBitmapNew: + * @size: number of bits + * + * Allocate a bitmap capable of containing @size bits. + * + * Returns a pointer to the allocated bitmap or NULL if + * memory cannot be allocated. + */ +virBitmapPtr virBitmapNew(size_t size) +{ + virBitmapPtr bitmap; + size_t sz; + + if (SIZE_MAX - VIR_BITMAP_BITS_PER_UNIT < size || size == 0) + return NULL; + + sz = (size + VIR_BITMAP_BITS_PER_UNIT - 1) / + VIR_BITMAP_BITS_PER_UNIT; + + if (VIR_ALLOC(bitmap) < 0) + return NULL; + + if (VIR_ALLOC_N(bitmap->map, sz) < 0) { + VIR_FREE(bitmap); + return NULL; + } + + bitmap->max_bit = size; + bitmap->map_len = sz; + return bitmap; +} + +/** + * virBitmapFree: + * @bitmap: previously allocated bitmap + * + * Free @bitmap previously allocated by virBitmapNew. + */ +void virBitmapFree(virBitmapPtr bitmap) +{ + if (bitmap) { + VIR_FREE(bitmap->map); + VIR_FREE(bitmap); + } +} + + +int virBitmapCopy(virBitmapPtr dst, virBitmapPtr src) +{ + if (dst->max_bit != src->max_bit) { + errno = EINVAL; + return -1; + } + + memcpy(dst->map, src->map, src->map_len * sizeof(src->map[0])); + + return 0; +} + + +/** + * virBitmapSetBit: + * @bitmap: Pointer to bitmap + * @b: bit position to set + * + * Set bit position @b in @bitmap + * + * Returns 0 on if bit is successfully set, -1 on error. + */ +int virBitmapSetBit(virBitmapPtr bitmap, size_t b) +{ + if (bitmap->max_bit <= b) + return -1; + + bitmap->map[VIR_BITMAP_UNIT_OFFSET(b)] |= VIR_BITMAP_BIT(b); + return 0; +} + +/** + * virBitmapClearBit: + * @bitmap: Pointer to bitmap + * @b: bit position to clear + * + * Clear bit position @b in @bitmap + * + * Returns 0 on if bit is successfully clear, -1 on error. + */ +int virBitmapClearBit(virBitmapPtr bitmap, size_t b) +{ + if (bitmap->max_bit <= b) + return -1; + + bitmap->map[VIR_BITMAP_UNIT_OFFSET(b)] &= ~VIR_BITMAP_BIT(b); + return 0; +} + +/* Helper function. caller must ensure b < bitmap->max_bit */ +static bool virBitmapIsSet(virBitmapPtr bitmap, size_t b) +{ + return !!(bitmap->map[VIR_BITMAP_UNIT_OFFSET(b)] & VIR_BITMAP_BIT(b)); +} + +/** + * virBitmapGetBit: + * @bitmap: Pointer to bitmap + * @b: bit position to get + * @result: bool pointer to receive bit setting + * + * Get setting of bit position @b in @bitmap and store in @result + * + * On success, @result will contain the setting of @b and 0 is + * returned. On failure, -1 is returned and @result is unchanged. + */ +int virBitmapGetBit(virBitmapPtr bitmap, size_t b, bool *result) +{ + if (bitmap->max_bit <= b) + return -1; + + *result = virBitmapIsSet(bitmap, b); + return 0; +} + +/** + * virBitmapString: + * @bitmap: Pointer to bitmap + * + * Convert @bitmap to printable string. + * + * Returns pointer to the string or NULL on error. + */ +char *virBitmapString(virBitmapPtr bitmap) +{ + virBuffer buf = VIR_BUFFER_INITIALIZER; + size_t sz; + + virBufferAddLit(&buf, "0x"); + + sz = bitmap->map_len; + + while (sz--) { + virBufferAsprintf(&buf, "%0*lx", + VIR_BITMAP_BITS_PER_UNIT / 4, + bitmap->map[sz]); + } + + if (virBufferError(&buf)) { + virBufferFreeAndReset(&buf); + return NULL; + } + + return virBufferContentAndReset(&buf); +} + +/** + * virBitmapFormat: + * @bitmap: the bitmap + * + * This function is the counterpart of virBitmapParse. This function creates + * a human-readable string representing the bits in bitmap. + * + * See virBitmapParse for the format of @str. + * + * Returns the string on success or NULL otherwise. Caller should call + * VIR_FREE to free the string. + */ +char *virBitmapFormat(virBitmapPtr bitmap) +{ + virBuffer buf = VIR_BUFFER_INITIALIZER; + bool first = true; + int start, cur, prev; + + if (!bitmap) + return NULL; + + cur = virBitmapNextSetBit(bitmap, -1); + if (cur < 0) + return strdup(""); + + start = prev = cur; + while (prev >= 0) { + cur = virBitmapNextSetBit(bitmap, prev); + + if (cur == prev + 1) { + prev = cur; + continue; + } + + /* cur < 0 or cur > prev + 1 */ + + if (!first) + virBufferAddLit(&buf, ","); + else + first = false; + + if (prev == start) + virBufferAsprintf(&buf, "%d", start); + else + virBufferAsprintf(&buf, "%d-%d", start, prev); + + start = prev = cur; + } + + if (virBufferError(&buf)) { + virBufferFreeAndReset(&buf); + return NULL; + } + + return virBufferContentAndReset(&buf); +} + +/** + * virBitmapParse: + * @str: points to a string representing a human-readable bitmap + * @bitmap: a bitmap created from @str + * @bitmapSize: the upper limit of num of bits in created bitmap + * + * This function is the counterpart of virBitmapFormat. This function creates + * a bitmap, in which bits are set according to the content of @str. + * + * @str is a comma separated string of fields N, which means a number of bit + * to set, and ^N, which means to unset the bit, and N-M for ranges of bits + * to set. + * + * Returns the number of bits set in @bitmap, or -1 in case of error. + */ + +int virBitmapParse(const char *str, + char sep, + virBitmapPtr *bitmap, + size_t bitmapSize) +{ + int ret = 0; + bool neg = false; + const char *cur; + char *tmp; + int i, start, last; + + if (!str) + return -1; + + cur = str; + virSkipSpaces(&cur); + + if (*cur == 0) + return -1; + + *bitmap = virBitmapNew(bitmapSize); + if (!*bitmap) + return -1; + + while (*cur != 0 && *cur != sep) { + /* + * 3 constructs are allowed: + * - N : a single CPU number + * - N-M : a range of CPU numbers with N < M + * - ^N : remove a single CPU number from the current set + */ + if (*cur == '^') { + cur++; + neg = true; + } + + if (!c_isdigit(*cur)) + goto parse_error; + + if (virStrToLong_i(cur, &tmp, 10, &start) < 0) + goto parse_error; + if (start < 0) + goto parse_error; + + cur = tmp; + + virSkipSpaces(&cur); + + if (*cur == ',' || *cur == 0 || *cur == sep) { + if (neg) { + if (virBitmapIsSet(*bitmap, start)) { + ignore_value(virBitmapClearBit(*bitmap, start)); + ret--; + } + } else { + if (!virBitmapIsSet(*bitmap, start)) { + ignore_value(virBitmapSetBit(*bitmap, start)); + ret++; + } + } + } else if (*cur == '-') { + if (neg) + goto parse_error; + + cur++; + virSkipSpaces(&cur); + + if (virStrToLong_i(cur, &tmp, 10, &last) < 0) + goto parse_error; + if (last < start) + goto parse_error; + + cur = tmp; + + for (i = start; i <= last; i++) { + if (!virBitmapIsSet(*bitmap, i)) { + ignore_value(virBitmapSetBit(*bitmap, i)); + ret++; + } + } + + virSkipSpaces(&cur); + } + + if (*cur == ',') { + cur++; + virSkipSpaces(&cur); + neg = false; + } else if (*cur == 0 || *cur == sep) { + break; + } else { + goto parse_error; + } + } + + return ret; + +parse_error: + virBitmapFree(*bitmap); + *bitmap = NULL; + return -1; +} + +/** + * virBitmapNewCopy: + * @src: the source bitmap. + * + * Makes a copy of bitmap @src. + * + * returns the copied bitmap on success, or NULL otherwise. Caller + * should call virBitmapFree to free the returned bitmap. + */ +virBitmapPtr virBitmapNewCopy(virBitmapPtr src) +{ + virBitmapPtr dst; + + if ((dst = virBitmapNew(src->max_bit)) == NULL) + return NULL; + + if (virBitmapCopy(dst, src) != 0) { + virBitmapFree(dst); + return NULL; + } + + return dst; +} + +/** + * virBitmapNewData: + * @data: the data + * @len: length of @data in bytes + * + * Allocate a bitmap from a chunk of data containing bits + * information + * + * Returns a pointer to the allocated bitmap or NULL if + * memory cannot be allocated. + */ +virBitmapPtr virBitmapNewData(void *data, int len) +{ + virBitmapPtr bitmap; + int i, j; + unsigned long *p; + unsigned char *bytes = data; + + bitmap = virBitmapNew(len * CHAR_BIT); + if (!bitmap) + return NULL; + + /* le64toh is not provided by gnulib, so we do the conversion by hand */ + p = bitmap->map; + for (i = j = 0; i < len; i++, j++) { + if (j == sizeof(*p)) { + j = 0; + p++; + } + *p |= (unsigned long) bytes[i] << (j * CHAR_BIT); + } + + return bitmap; +} + +/** + * virBitmapToData: + * @data: the data + * @len: len of @data in byte + * + * Convert a bitmap to a chunk of data containing bits information. + * Data consists of sequential bytes, with lower bytes containing + * lower bits. + * + * Returns 0 on success, -1 otherwise. + */ +int virBitmapToData(virBitmapPtr bitmap, unsigned char **data, int *dataLen) +{ + int len; + unsigned long *l; + int i, j; + unsigned char *bytes; + + len = (bitmap->max_bit + CHAR_BIT - 1) / CHAR_BIT; + + if (VIR_ALLOC_N(*data, len) < 0) + return -1; + + bytes = *data; + *dataLen = len; + + /* htole64 is not provided by gnulib, so we do the conversion by hand */ + l = bitmap->map; + for (i = j = 0; i < len; i++, j++) { + if (j == sizeof(*l)) { + j = 0; + l++; + } + bytes[i] = *l >> (j * CHAR_BIT); + } + + return 0; +} + +/** + * virBitmapEqual: + * @b1: bitmap 1 + * @b2: bitmap 2 + * + * Compares two bitmaps, whose lengths can be different from each other. + * + * Returns true if two bitmaps have exactly the same set of bits set, + * otherwise false. + */ +bool virBitmapEqual(virBitmapPtr b1, virBitmapPtr b2) +{ + virBitmapPtr tmp; + int i; + + if (b1->max_bit > b2->max_bit) { + tmp = b1; + b1 = b2; + b2 = tmp; + } + + /* Now b1 is the smaller one, if not equal */ + + for (i = 0; i < b1->map_len; i++) { + if (b1->map[i] != b2->map[i]) + return false; + } + + for (; i < b2->map_len; i++) { + if (b2->map[i]) + return false; + } + + return true; +} + +size_t virBitmapSize(virBitmapPtr bitmap) +{ + return bitmap->max_bit; +} + +/** + * virBitmapSetAll: + * @bitmap: the bitmap + * + * set all bits in @bitmap. + */ +void virBitmapSetAll(virBitmapPtr bitmap) +{ + int tail = bitmap->max_bit % VIR_BITMAP_BITS_PER_UNIT; + + memset(bitmap->map, 0xff, + bitmap->map_len * (VIR_BITMAP_BITS_PER_UNIT / CHAR_BIT)); + + /* Ensure tail bits are clear. */ + if (tail) + bitmap->map[bitmap->map_len - 1] &= + -1UL >> (VIR_BITMAP_BITS_PER_UNIT - tail); +} + +/** + * virBitmapClearAll: + * @bitmap: the bitmap + * + * clear all bits in @bitmap. + */ +void virBitmapClearAll(virBitmapPtr bitmap) +{ + memset(bitmap->map, 0, + bitmap->map_len * (VIR_BITMAP_BITS_PER_UNIT / CHAR_BIT)); +} + +/** + * virBitmapIsAllSet: + * @bitmap: the bitmap to check + * + * check if all bits in @bitmap are set. + */ +bool virBitmapIsAllSet(virBitmapPtr bitmap) +{ + int i; + int unusedBits; + size_t sz; + + unusedBits = bitmap->map_len * VIR_BITMAP_BITS_PER_UNIT - bitmap->max_bit; + + sz = bitmap->map_len; + if (unusedBits > 0) + sz--; + + for (i = 0; i < sz; i++) + if (bitmap->map[i] != -1) + return false; + + if (unusedBits > 0) { + if ((bitmap->map[sz] & ((1UL << (VIR_BITMAP_BITS_PER_UNIT - unusedBits)) - 1)) + != ((1UL << (VIR_BITMAP_BITS_PER_UNIT - unusedBits)) - 1)) + return false; + } + + return true; +} + +/** + * virBitmapNextSetBit: + * @bitmap: the bitmap + * @pos: the position after which to search for a set bit + * + * search the first set bit after position @pos in bitmap @bitmap. + * @pos can be -1 to search for the first set bit. Position starts + * at 0. + * + * returns the position of the found bit, or -1 if no bit found. + */ +ssize_t virBitmapNextSetBit(virBitmapPtr bitmap, ssize_t pos) +{ + size_t nl; + size_t nb; + unsigned long bits; + + if (pos < 0) + pos = -1; + + pos++; + + if (pos >= bitmap->max_bit) + return -1; + + nl = pos / VIR_BITMAP_BITS_PER_UNIT; + nb = pos % VIR_BITMAP_BITS_PER_UNIT; + + bits = bitmap->map[nl] & ~((1UL << nb) - 1); + + while (bits == 0 && ++nl < bitmap->map_len) { + bits = bitmap->map[nl]; + } + + if (bits == 0) + return -1; + + return ffsl(bits) - 1 + nl * VIR_BITMAP_BITS_PER_UNIT; +} + +/* Return the number of bits currently set in the map. */ +size_t +virBitmapCountBits(virBitmapPtr bitmap) +{ + size_t i; + size_t ret = 0; + + for (i = 0; i < bitmap->map_len; i++) + ret += count_one_bits_l(bitmap->map[i]); + + return ret; +} diff --git a/src/util/virbitmap.h b/src/util/virbitmap.h new file mode 100644 index 0000000..346a1fb --- /dev/null +++ b/src/util/virbitmap.h @@ -0,0 +1,109 @@ +/* + * bitmap.h: Simple bitmap operations + * + * Copyright (C) 2012 Red Hat, Inc. + * Copyright (C) 2010 Novell, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Author: Jim Fehlig <jfehlig(a)novell.com&gt; + */ + +#ifndef __BITMAP_H__ +# define __BITMAP_H__ + +# include "internal.h" + +# include <sys/types.h> + + +typedef struct _virBitmap virBitmap; +typedef virBitmap *virBitmapPtr; + +/* + * Allocate a bitmap capable of containing @size bits. + */ +virBitmapPtr virBitmapNew(size_t size) ATTRIBUTE_RETURN_CHECK; + +/* + * Free previously allocated bitmap + */ +void virBitmapFree(virBitmapPtr bitmap); + +/* + * Copy all bits from @src to @dst. The bitmap sizes + * must be the same + */ +int virBitmapCopy(virBitmapPtr dst, virBitmapPtr src); + +/* + * Set bit position @b in @bitmap + */ +int virBitmapSetBit(virBitmapPtr bitmap, size_t b) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; + +/* + * Clear bit position @b in @bitmap + */ +int virBitmapClearBit(virBitmapPtr bitmap, size_t b) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; + +/* + * Get setting of bit position @b in @bitmap and store in @result + */ +int virBitmapGetBit(virBitmapPtr bitmap, size_t b, bool *result) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK; + +char *virBitmapString(virBitmapPtr bitmap) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; + +char *virBitmapFormat(virBitmapPtr bitmap) + ATTRIBUTE_NONNULL(1); + +int virBitmapParse(const char *str, + char sep, + virBitmapPtr *bitmap, + size_t bitmapSize) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3); + +virBitmapPtr virBitmapNewCopy(virBitmapPtr src) ATTRIBUTE_NONNULL(1); + +virBitmapPtr virBitmapNewData(void *data, int len) ATTRIBUTE_NONNULL(1); + +int virBitmapToData(virBitmapPtr bitmap, unsigned char **data, int *dataLen) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2); + +bool virBitmapEqual(virBitmapPtr b1, virBitmapPtr b2) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2); + +size_t virBitmapSize(virBitmapPtr bitmap) + ATTRIBUTE_NONNULL(1); + +void virBitmapSetAll(virBitmapPtr bitmap) + ATTRIBUTE_NONNULL(1); + +void virBitmapClearAll(virBitmapPtr bitmap) + ATTRIBUTE_NONNULL(1); + +bool virBitmapIsAllSet(virBitmapPtr bitmap) + ATTRIBUTE_NONNULL(1); + +ssize_t virBitmapNextSetBit(virBitmapPtr bitmap, ssize_t pos) + ATTRIBUTE_NONNULL(1); + +size_t virBitmapCountBits(virBitmapPtr bitmap) + ATTRIBUTE_NONNULL(1); + +#endif diff --git a/tests/virbitmaptest.c b/tests/virbitmaptest.c index af94dab..db76672 100644 --- a/tests/virbitmaptest.c +++ b/tests/virbitmaptest.c @@ -21,7 +21,7 @@ #include "testutils.h" -#include "bitmap.h" +#include "virbitmap.h" static int test1(const void *data ATTRIBUTE_UNUSED) { diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c index 561e0e7..765f30c 100644 --- a/tools/virsh-domain.c +++ b/tools/virsh-domain.c @@ -37,7 +37,7 @@ #include <libxml/xmlsave.h> #include "internal.h" -#include "bitmap.h" +#include "virbitmap.h" #include "buf.h" #include "c-ctype.h" #include "conf/domain_conf.h" diff --git a/tools/virsh.c b/tools/virsh.c index 465cb44..2f7d4a3 100644 --- a/tools/virsh.c +++ b/tools/virsh.c @@ -69,7 +69,7 @@ #include "command.h" #include "virkeycode.h" #include "virnetdevbandwidth.h" -#include "util/bitmap.h" +#include "virbitmap.h" #include "conf/domain_conf.h" #include "virtypedparam.h" -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- cfg.mk | 4 +- daemon/remote.c | 2 +- po/POTFILES.in | 2 +- src/Makefile.am | 2 +- src/fdstream.h | 2 +- src/libvirt.c | 2 +- src/libxl/libxl_driver.c | 2 +- src/lxc/lxc_container.c | 2 +- src/lxc/lxc_controller.c | 2 +- src/lxc/lxc_process.c | 2 +- src/network/bridge_driver.c | 2 +- src/network/bridge_driver.h | 2 +- src/nwfilter/nwfilter_ebiptables_driver.c | 2 +- src/openvz/openvz_conf.c | 2 +- src/openvz/openvz_driver.c | 2 +- src/openvz/openvz_util.c | 2 +- src/parallels/parallels_driver.c | 2 +- src/parallels/parallels_utils.c | 2 +- src/qemu/qemu_capabilities.c | 2 +- src/qemu/qemu_capabilities.h | 2 +- src/qemu/qemu_command.h | 2 +- src/qemu/qemu_conf.h | 2 +- src/remote/remote_driver.c | 2 +- src/rpc/virnetsocket.h | 2 +- src/security/security_apparmor.c | 2 +- src/security/virt-aa-helper.c | 2 +- src/storage/storage_backend.h | 2 +- src/storage/storage_backend_disk.c | 2 +- src/storage/storage_backend_fs.c | 2 +- src/storage/storage_backend_iscsi.c | 2 +- src/storage/storage_backend_logical.c | 2 +- src/storage/storage_backend_scsi.c | 2 +- src/storage/storage_backend_sheepdog.c | 2 +- src/uml/uml_conf.c | 2 +- src/uml/uml_conf.h | 2 +- src/util/command.c | 2523 ----------------------------- src/util/command.h | 166 -- src/util/dnsmasq.c | 2 +- src/util/ebtables.c | 2 +- src/util/hooks.c | 2 +- src/util/iptables.c | 2 +- src/util/pci.c | 2 +- src/util/storage_file.c | 2 +- src/util/sysinfo.c | 2 +- src/util/util.c | 2 +- src/util/vircommand.c | 2523 +++++++++++++++++++++++++++++ src/util/vircommand.h | 166 ++ src/util/virfile.c | 2 +- src/util/virnetdev.c | 2 +- src/util/virnetdevbandwidth.c | 2 +- src/util/virnetdevopenvswitch.c | 2 +- src/util/virnetdevveth.c | 2 +- src/util/virnodesuspend.c | 2 +- src/vmware/vmware_conf.c | 2 +- src/vmware/vmware_driver.c | 2 +- src/xen/xen_driver.c | 2 +- tests/commandtest.c | 2 +- tests/networkxml2conftest.c | 2 +- tests/reconnect.c | 2 +- tests/statstest.c | 2 +- tests/testutils.c | 2 +- tests/virnettlscontexttest.c | 2 +- tools/virsh.c | 2 +- 63 files changed, 2749 insertions(+), 2749 deletions(-) delete mode 100644 src/util/command.c delete mode 100644 src/util/command.h create mode 100644 src/util/vircommand.c create mode 100644 src/util/vircommand.h diff --git a/cfg.mk b/cfg.mk index 1fe007e..9fbf799 100644 --- a/cfg.mk +++ b/cfg.mk @@ -745,7 +745,7 @@ $(srcdir)/src/remote/remote_client_bodies.h: $(srcdir)/src/remote/remote_protoco # List all syntax-check exemptions: exclude_file_name_regexp--sc_avoid_strcase = ^tools/virsh\.h$$ -_src1=libvirt|fdstream|qemu/qemu_monitor|util/(command|util)|xen/xend_internal|rpc/virnetsocket|lxc/lxc_controller|locking/lock_daemon +_src1=libvirt|fdstream|qemu/qemu_monitor|util/(vircommand|util)|xen/xend_internal|rpc/virnetsocket|lxc/lxc_controller|locking/lock_daemon exclude_file_name_regexp--sc_avoid_write = \ ^(src/($(_src1))|daemon/libvirtd|tools/console|tests/(shunload|virnettlscontext)test)\.c$$ @@ -778,7 +778,7 @@ exclude_file_name_regexp--sc_prohibit_close = \ exclude_file_name_regexp--sc_prohibit_empty_lines_at_EOF = \ (^tests/(qemuhelp|nodeinfo)data/|\.(gif|ico|png|diff)$$) -_src2=src/(util/command|libvirt|lxc/lxc_controller|locking/lock_daemon) +_src2=src/(util/vircommand|libvirt|lxc/lxc_controller|locking/lock_daemon) exclude_file_name_regexp--sc_prohibit_fork_wrappers = \ (^($(_src2)|tests/testutils|daemon/libvirtd)\.c$$) diff --git a/daemon/remote.c b/daemon/remote.c index 41b8ea8..1746280 100644 --- a/daemon/remote.c +++ b/daemon/remote.c @@ -39,7 +39,7 @@ #include "stream.h" #include "uuid.h" #include "libvirt/libvirt-qemu.h" -#include "command.h" +#include "vircommand.h" #include "intprops.h" #include "virnetserverservice.h" #include "virnetserver.h" diff --git a/po/POTFILES.in b/po/POTFILES.in index 19ed187..843db7c 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -137,7 +137,6 @@ src/storage/storage_driver.c src/test/test_driver.c src/uml/uml_conf.c src/uml/uml_driver.c -src/util/command.c src/util/conf.c src/util/dnsmasq.c src/util/event_poll.c @@ -157,6 +156,7 @@ src/util/viraudit.c src/util/virauth.c src/util/virauthconfig.c src/util/vircgroup.c +src/util/vircommand.c src/util/virdbus.c src/util/virfile.c src/util/virhash.c diff --git a/src/Makefile.am b/src/Makefile.am index fd21aa6..7e16d68 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -53,7 +53,6 @@ augeastest_DATA = # These files are not related to driver APIs. Simply generic # helper APIs for various purposes UTIL_SOURCES = \ - util/command.c util/command.h \ util/conf.c util/conf.h \ util/event.c util/event.h \ util/event_poll.c util/event_poll.h \ @@ -83,6 +82,7 @@ UTIL_SOURCES = \ util/virauthconfig.c util/virauthconfig.h \ util/virbitmap.c util/virbitmap.h \ util/virbuffer.c util/virbuffer.h \ + util/vircommand.c util/vircommand.h \ util/virfile.c util/virfile.h \ util/virnodesuspend.c util/virnodesuspend.h \ util/virobject.c util/virobject.h \ diff --git a/src/fdstream.h b/src/fdstream.h index 65457d8..d6f5a7a 100644 --- a/src/fdstream.h +++ b/src/fdstream.h @@ -24,7 +24,7 @@ # define __VIR_FDSTREAM_H_ # include "internal.h" -# include "command.h" +# include "vircommand.h" /* internal callback, the generic one is used up by daemon stream driver */ /* the close callback is called with fdstream private data locked */ diff --git a/src/libvirt.c b/src/libvirt.c index 4215971..e28ed05 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -56,7 +56,7 @@ #include "intprops.h" #include "conf.h" #include "rpc/virnettlscontext.h" -#include "command.h" +#include "vircommand.h" #include "virrandom.h" #include "viruri.h" #include "threads.h" diff --git a/src/libxl/libxl_driver.c b/src/libxl/libxl_driver.c index 302f81c..1423073 100644 --- a/src/libxl/libxl_driver.c +++ b/src/libxl/libxl_driver.c @@ -39,7 +39,7 @@ #include "virfile.h" #include "memory.h" #include "uuid.h" -#include "command.h" +#include "vircommand.h" #include "libxl.h" #include "libxl_driver.h" #include "libxl_conf.h" diff --git a/src/lxc/lxc_container.c b/src/lxc/lxc_container.c index 3014564..33ebf1f 100644 --- a/src/lxc/lxc_container.c +++ b/src/lxc/lxc_container.c @@ -61,7 +61,7 @@ #include "virnetdevveth.h" #include "uuid.h" #include "virfile.h" -#include "command.h" +#include "vircommand.h" #include "virnetdev.h" #include "virprocess.h" diff --git a/src/lxc/lxc_controller.c b/src/lxc/lxc_controller.c index 5510b9a..c9cac5d 100644 --- a/src/lxc/lxc_controller.c +++ b/src/lxc/lxc_controller.c @@ -67,7 +67,7 @@ #include "util.h" #include "virfile.h" #include "virpidfile.h" -#include "command.h" +#include "vircommand.h" #include "processinfo.h" #include "nodeinfo.h" #include "virrandom.h" diff --git a/src/lxc/lxc_process.c b/src/lxc/lxc_process.c index 3e7fcb8..7f66dc7 100644 --- a/src/lxc/lxc_process.c +++ b/src/lxc/lxc_process.c @@ -42,7 +42,7 @@ #include "domain_audit.h" #include "virterror_internal.h" #include "logging.h" -#include "command.h" +#include "vircommand.h" #include "hooks.h" #define VIR_FROM_THIS VIR_FROM_LXC diff --git a/src/network/bridge_driver.c b/src/network/bridge_driver.c index c65f0bb..319ff8c 100644 --- a/src/network/bridge_driver.c +++ b/src/network/bridge_driver.c @@ -53,7 +53,7 @@ #include "virbuffer.h" #include "virpidfile.h" #include "util.h" -#include "command.h" +#include "vircommand.h" #include "memory.h" #include "uuid.h" #include "iptables.h" diff --git a/src/network/bridge_driver.h b/src/network/bridge_driver.h index 43fefc0..fea27e0 100644 --- a/src/network/bridge_driver.h +++ b/src/network/bridge_driver.h @@ -30,7 +30,7 @@ # include "internal.h" # include "network_conf.h" # include "domain_conf.h" -# include "command.h" +# include "vircommand.h" # include "dnsmasq.h" int networkRegister(void); diff --git a/src/nwfilter/nwfilter_ebiptables_driver.c b/src/nwfilter/nwfilter_ebiptables_driver.c index 5cfc036..6966acf 100644 --- a/src/nwfilter/nwfilter_ebiptables_driver.c +++ b/src/nwfilter/nwfilter_ebiptables_driver.c @@ -40,7 +40,7 @@ #include "nwfilter_gentech_driver.h" #include "nwfilter_ebiptables_driver.h" #include "virfile.h" -#include "command.h" +#include "vircommand.h" #include "configmake.h" #include "intprops.h" diff --git a/src/openvz/openvz_conf.c b/src/openvz/openvz_conf.c index 3f89db3..c9189ef 100644 --- a/src/openvz/openvz_conf.c +++ b/src/openvz/openvz_conf.c @@ -52,7 +52,7 @@ #include "util.h" #include "nodeinfo.h" #include "virfile.h" -#include "command.h" +#include "vircommand.h" #define VIR_FROM_THIS VIR_FROM_OPENVZ diff --git a/src/openvz/openvz_driver.c b/src/openvz/openvz_driver.c index 1b213c4..75d52e2 100644 --- a/src/openvz/openvz_driver.c +++ b/src/openvz/openvz_driver.c @@ -57,7 +57,7 @@ #include "virfile.h" #include "virtypedparam.h" #include "logging.h" -#include "command.h" +#include "vircommand.h" #include "viruri.h" #include "stats_linux.h" diff --git a/src/openvz/openvz_util.c b/src/openvz/openvz_util.c index 111045f..4163e19 100644 --- a/src/openvz/openvz_util.c +++ b/src/openvz/openvz_util.c @@ -26,7 +26,7 @@ #include "internal.h" #include "virterror_internal.h" -#include "command.h" +#include "vircommand.h" #include "datatypes.h" #include "memory.h" diff --git a/src/parallels/parallels_driver.c b/src/parallels/parallels_driver.c index 60507e7..648cb48 100644 --- a/src/parallels/parallels_driver.c +++ b/src/parallels/parallels_driver.c @@ -46,7 +46,7 @@ #include "memory.h" #include "util.h" #include "logging.h" -#include "command.h" +#include "vircommand.h" #include "configmake.h" #include "storage_file.h" #include "nodeinfo.h" diff --git a/src/parallels/parallels_utils.c b/src/parallels/parallels_utils.c index 521fd97..e47ff76 100644 --- a/src/parallels/parallels_utils.c +++ b/src/parallels/parallels_utils.c @@ -24,7 +24,7 @@ #include <stdarg.h> -#include "command.h" +#include "vircommand.h" #include "virterror_internal.h" #include "memory.h" #include "json.h" diff --git a/src/qemu/qemu_capabilities.c b/src/qemu/qemu_capabilities.c index 45962b0..f68e081 100644 --- a/src/qemu/qemu_capabilities.c +++ b/src/qemu/qemu_capabilities.c @@ -34,7 +34,7 @@ #include "nodeinfo.h" #include "cpu/cpu.h" #include "domain_conf.h" -#include "command.h" +#include "vircommand.h" #include "virbitmap.h" #include "virnodesuspend.h" #include "qemu_monitor.h" diff --git a/src/qemu/qemu_capabilities.h b/src/qemu/qemu_capabilities.h index bf4eef8..cd7ee92 100644 --- a/src/qemu/qemu_capabilities.h +++ b/src/qemu/qemu_capabilities.h @@ -26,7 +26,7 @@ # include "virobject.h" # include "capabilities.h" -# include "command.h" +# include "vircommand.h" # include "virobject.h" # include "qemu_monitor.h" diff --git a/src/qemu/qemu_command.h b/src/qemu/qemu_command.h index 0dde4be..b3ac4a6 100644 --- a/src/qemu/qemu_command.h +++ b/src/qemu/qemu_command.h @@ -25,7 +25,7 @@ # define __QEMU_COMMAND_H__ # include "domain_conf.h" -# include "command.h" +# include "vircommand.h" # include "capabilities.h" # include "qemu_conf.h" # include "qemu_domain.h" diff --git a/src/qemu/qemu_conf.h b/src/qemu/qemu_conf.h index bcf21c3..eafaf9f 100644 --- a/src/qemu/qemu_conf.h +++ b/src/qemu/qemu_conf.h @@ -40,7 +40,7 @@ # include "cpu_conf.h" # include "driver.h" # include "virbitmap.h" -# include "command.h" +# include "vircommand.h" # include "threadpool.h" # include "locking/lock_manager.h" # include "qemu_capabilities.h" diff --git a/src/remote/remote_driver.c b/src/remote/remote_driver.c index f32e88e..8b77e7d 100644 --- a/src/remote/remote_driver.c +++ b/src/remote/remote_driver.c @@ -41,7 +41,7 @@ #include "memory.h" #include "util.h" #include "virfile.h" -#include "command.h" +#include "vircommand.h" #include "intprops.h" #include "virtypedparam.h" #include "viruri.h" diff --git a/src/rpc/virnetsocket.h b/src/rpc/virnetsocket.h index e024640..fcd54dd 100644 --- a/src/rpc/virnetsocket.h +++ b/src/rpc/virnetsocket.h @@ -25,7 +25,7 @@ # define __VIR_NET_SOCKET_H__ # include "virsocketaddr.h" -# include "command.h" +# include "vircommand.h" # include "virnettlscontext.h" # include "virobject.h" # ifdef HAVE_SASL diff --git a/src/security/security_apparmor.c b/src/security/security_apparmor.c index b0cdb65..ff8aea1 100644 --- a/src/security/security_apparmor.c +++ b/src/security/security_apparmor.c @@ -47,7 +47,7 @@ #include "hostusb.h" #include "virfile.h" #include "configmake.h" -#include "command.h" +#include "vircommand.h" #include "logging.h" #define VIR_FROM_THIS VIR_FROM_SECURITY diff --git a/src/security/virt-aa-helper.c b/src/security/virt-aa-helper.c index 78ebae3..bfd6305 100644 --- a/src/security/virt-aa-helper.c +++ b/src/security/virt-aa-helper.c @@ -43,7 +43,7 @@ #include "virbuffer.h" #include "util.h" #include "memory.h" -#include "command.h" +#include "vircommand.h" #include "security_driver.h" #include "security_apparmor.h" diff --git a/src/storage/storage_backend.h b/src/storage/storage_backend.h index c991015..56b6797 100644 --- a/src/storage/storage_backend.h +++ b/src/storage/storage_backend.h @@ -26,7 +26,7 @@ # include "internal.h" # include "storage_conf.h" -# include "command.h" +# include "vircommand.h" typedef char * (*virStorageBackendFindPoolSources)(virConnectPtr conn, const char *srcSpec, unsigned int flags); typedef int (*virStorageBackendCheckPool)(virConnectPtr conn, virStoragePoolObjPtr pool, bool *active); diff --git a/src/storage/storage_backend_disk.c b/src/storage/storage_backend_disk.c index 06b5909..c6aa407 100644 --- a/src/storage/storage_backend_disk.c +++ b/src/storage/storage_backend_disk.c @@ -31,7 +31,7 @@ #include "storage_backend_disk.h" #include "util.h" #include "memory.h" -#include "command.h" +#include "vircommand.h" #include "configmake.h" #define VIR_FROM_THIS VIR_FROM_STORAGE diff --git a/src/storage/storage_backend_fs.c b/src/storage/storage_backend_fs.c index fcc46b7..cdf93af 100644 --- a/src/storage/storage_backend_fs.c +++ b/src/storage/storage_backend_fs.c @@ -45,7 +45,7 @@ #include "storage_backend_fs.h" #include "storage_conf.h" #include "storage_file.h" -#include "command.h" +#include "vircommand.h" #include "memory.h" #include "xml.h" #include "virfile.h" diff --git a/src/storage/storage_backend_iscsi.c b/src/storage/storage_backend_iscsi.c index b080250..c468b1b 100644 --- a/src/storage/storage_backend_iscsi.c +++ b/src/storage/storage_backend_iscsi.c @@ -41,7 +41,7 @@ #include "memory.h" #include "logging.h" #include "virfile.h" -#include "command.h" +#include "vircommand.h" #include "virrandom.h" #define VIR_FROM_THIS VIR_FROM_STORAGE diff --git a/src/storage/storage_backend_logical.c b/src/storage/storage_backend_logical.c index fd5cbd1..53e6c61 100644 --- a/src/storage/storage_backend_logical.c +++ b/src/storage/storage_backend_logical.c @@ -34,7 +34,7 @@ #include "virterror_internal.h" #include "storage_backend_logical.h" #include "storage_conf.h" -#include "command.h" +#include "vircommand.h" #include "memory.h" #include "logging.h" #include "virfile.h" diff --git a/src/storage/storage_backend_scsi.c b/src/storage/storage_backend_scsi.c index 4e832eb..6515e57 100644 --- a/src/storage/storage_backend_scsi.c +++ b/src/storage/storage_backend_scsi.c @@ -33,7 +33,7 @@ #include "memory.h" #include "logging.h" #include "virfile.h" -#include "command.h" +#include "vircommand.h" #define VIR_FROM_THIS VIR_FROM_STORAGE diff --git a/src/storage/storage_backend_sheepdog.c b/src/storage/storage_backend_sheepdog.c index 66d8fb4..ecca7a8 100644 --- a/src/storage/storage_backend_sheepdog.c +++ b/src/storage/storage_backend_sheepdog.c @@ -29,7 +29,7 @@ #include "virterror_internal.h" #include "storage_backend_sheepdog.h" #include "storage_conf.h" -#include "util/command.h" +#include "vircommand.h" #include "util.h" #include "memory.h" #include "logging.h" diff --git a/src/uml/uml_conf.c b/src/uml/uml_conf.c index 11c915e..6aec8fc 100644 --- a/src/uml/uml_conf.c +++ b/src/uml/uml_conf.c @@ -45,7 +45,7 @@ #include "logging.h" #include "domain_nwfilter.h" #include "virfile.h" -#include "command.h" +#include "vircommand.h" #include "virnetdevtap.h" #include "virnodesuspend.h" diff --git a/src/uml/uml_conf.h b/src/uml/uml_conf.h index 9bddedc..09a0305 100644 --- a/src/uml/uml_conf.h +++ b/src/uml/uml_conf.h @@ -31,7 +31,7 @@ # include "domain_event.h" # include "virterror_internal.h" # include "threads.h" -# include "command.h" +# include "vircommand.h" # include "virhash.h" # define umlDebug(fmt, ...) do {} while(0) diff --git a/src/util/command.c b/src/util/command.c deleted file mode 100644 index fbd9ff8..0000000 --- a/src/util/command.c +++ /dev/null @@ -1,2523 +0,0 @@ -/* - * command.c: Child command execution - * - * Copyright (C) 2010-2012 Red Hat, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - */ - -#include <config.h> - -#include <poll.h> -#include <signal.h> -#include <stdarg.h> -#include <stdlib.h> -#include <sys/stat.h> -#include <sys/wait.h> -#include <fcntl.h> - -#if HAVE_CAPNG -# include <cap-ng.h> -#endif - -#include "command.h" -#include "memory.h" -#include "virterror_internal.h" -#include "util.h" -#include "logging.h" -#include "virfile.h" -#include "virpidfile.h" -#include "virprocess.h" -#include "virbuffer.h" - -#define VIR_FROM_THIS VIR_FROM_NONE - -/* Flags for virExecWithHook */ -enum { - VIR_EXEC_NONE = 0, - VIR_EXEC_NONBLOCK = (1 << 0), - VIR_EXEC_DAEMON = (1 << 1), - VIR_EXEC_CLEAR_CAPS = (1 << 2), - VIR_EXEC_RUN_SYNC = (1 << 3), -}; - -struct _virCommand { - int has_error; /* ENOMEM on allocation failure, -1 for anything else. */ - - char **args; - size_t nargs; - size_t maxargs; - - char **env; - size_t nenv; - size_t maxenv; - - char *pwd; - - int *preserve; /* FDs to pass to child. */ - int preserve_size; - int *transfer; /* FDs to close in parent. */ - int transfer_size; - - unsigned int flags; - - char *inbuf; - char **outbuf; - char **errbuf; - - int infd; - int outfd; - int errfd; - int *outfdptr; - int *errfdptr; - - bool handshake; - int handshakeWait[2]; - int handshakeNotify[2]; - - virExecHook hook; - void *opaque; - - pid_t pid; - char *pidfile; - bool reap; - - unsigned long long capabilities; -}; - -/* - * virCommandFDIsSet: - * @fd: FD to test - * @set: the set - * @set_size: actual size of @set - * - * Check if FD is already in @set or not. - * - * Returns true if @set contains @fd, - * false otherwise. - */ -static bool -virCommandFDIsSet(int fd, - const int *set, - int set_size) -{ - int i = 0; - - while (i < set_size) - if (set[i++] == fd) - return true; - - return false; -} - -/* - * virCommandFDSet: - * @fd: FD to be put into @set - * @set: the set - * @set_size: actual size of @set - * - * This is practically generalized implementation - * of FD_SET() as we do not want to be limited - * by FD_SETSIZE. - * - * Returns: 0 on success, - * -1 on usage error, - * ENOMEM on OOM - */ -static int -virCommandFDSet(int fd, - int **set, - int *set_size) -{ - if (fd < 0 || !set || !set_size) - return -1; - - if (virCommandFDIsSet(fd, *set, *set_size)) - return 0; - - if (VIR_REALLOC_N(*set, *set_size + 1) < 0) { - return ENOMEM; - } - - (*set)[*set_size] = fd; - (*set_size)++; - - return 0; -} - -#ifndef WIN32 - -static int virClearCapabilities(void) ATTRIBUTE_UNUSED; - -# if HAVE_CAPNG -static int virClearCapabilities(void) -{ - int ret; - - capng_clear(CAPNG_SELECT_BOTH); - - if ((ret = capng_apply(CAPNG_SELECT_BOTH)) < 0) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("cannot clear process capabilities %d"), ret); - return -1; - } - - return 0; -} - -/** - * virSetCapabilities: - * @capabilities - capability flag to set. - * In case of 0, this function is identical to - * virClearCapabilities() - * - */ -static int virSetCapabilities(unsigned long long capabilities) -{ - int ret, i; - - capng_clear(CAPNG_SELECT_BOTH); - - for (i = 0; i <= CAP_LAST_CAP; i++) { - if (capabilities & (1ULL << i)) - capng_update(CAPNG_ADD, CAPNG_BOUNDING_SET, i); - } - - if ((ret = capng_apply(CAPNG_SELECT_BOTH)) < 0) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("cannot apply process capabilities %d"), ret); - return -1; - } - - return 0; -} -# else -static int virClearCapabilities(void) -{ -// VIR_WARN("libcap-ng support not compiled in, unable to clear " -// "capabilities"); - return 0; -} - -static int -virSetCapabilities(unsigned long long capabilities ATTRIBUTE_UNUSED) -{ - return 0; -} -# endif - -/** - * virFork: - * @pid - a pointer to a pid_t that will receive the return value from - * fork() - * - * fork a new process while avoiding various race/deadlock conditions - * - * on return from virFork(), if *pid < 0, the fork failed and there is - * no new process. Otherwise, just like fork(), if *pid == 0, it is the - * child process returning, and if *pid > 0, it is the parent. - * - * Even if *pid >= 0, if the return value from virFork() is < 0, it - * indicates a failure that occurred in the parent or child process - * after the fork. In this case, the child process should call - * _exit(EXIT_FAILURE) after doing any additional error reporting. - */ -int -virFork(pid_t *pid) -{ - sigset_t oldmask, newmask; - struct sigaction sig_action; - int saved_errno, ret = -1; - - *pid = -1; - - /* - * Need to block signals now, so that child process can safely - * kill off caller's signal handlers without a race. - */ - sigfillset(&newmask); - if (pthread_sigmask(SIG_SETMASK, &newmask, &oldmask) != 0) { - saved_errno = errno; - virReportSystemError(errno, - "%s", _("cannot block signals")); - goto cleanup; - } - - /* Ensure we hold the logging lock, to protect child processes - * from deadlocking on another thread's inherited mutex state */ - virLogLock(); - - *pid = fork(); - saved_errno = errno; /* save for caller */ - - /* Unlock for both parent and child process */ - virLogUnlock(); - - if (*pid < 0) { - /* attempt to restore signal mask, but ignore failure, to - avoid obscuring the fork failure */ - ignore_value(pthread_sigmask(SIG_SETMASK, &oldmask, NULL)); - virReportSystemError(saved_errno, - "%s", _("cannot fork child process")); - goto cleanup; - } - - if (*pid) { - - /* parent process */ - - /* Restore our original signal mask now that the child is - safely running */ - if (pthread_sigmask(SIG_SETMASK, &oldmask, NULL) != 0) { - saved_errno = errno; /* save for caller */ - virReportSystemError(errno, "%s", _("cannot unblock signals")); - goto cleanup; - } - ret = 0; - - } else { - - /* child process */ - - int logprio; - int i; - - /* Remove any error callback so errors in child now - get sent to stderr where they stand a fighting chance - of being seen / logged */ - virSetErrorFunc(NULL, NULL); - virSetErrorLogPriorityFunc(NULL); - - /* Make sure any hook logging is sent to stderr, since child - * process may close the logfile FDs */ - logprio = virLogGetDefaultPriority(); - virLogReset(); - virLogSetDefaultPriority(logprio); - - /* Clear out all signal handlers from parent so nothing - unexpected can happen in our child once we unblock - signals */ - sig_action.sa_handler = SIG_DFL; - sig_action.sa_flags = 0; - sigemptyset(&sig_action.sa_mask); - - for (i = 1; i < NSIG; i++) { - /* Only possible errors are EFAULT or EINVAL - The former wont happen, the latter we - expect, so no need to check return value */ - - sigaction(i, &sig_action, NULL); - } - - /* Unmask all signals in child, since we've no idea - what the caller's done with their signal mask - and don't want to propagate that to children */ - sigemptyset(&newmask); - if (pthread_sigmask(SIG_SETMASK, &newmask, NULL) != 0) { - saved_errno = errno; /* save for caller */ - virReportSystemError(errno, "%s", _("cannot unblock signals")); - goto cleanup; - } - ret = 0; - } - -cleanup: - if (ret < 0) - errno = saved_errno; - return ret; -} - -/* - * Ensure that *null is an fd visiting /dev/null. Return 0 on - * success, -1 on failure. Allows for lazy opening of shared - * /dev/null fd only as required. - */ -static int -getDevNull(int *null) -{ - if (*null == -1 && (*null = open("/dev/null", O_RDWR|O_CLOEXEC)) < 0) { - virReportSystemError(errno, - _("cannot open %s"), - "/dev/null"); - return -1; - } - return 0; -} - -/* Ensure that STD is an inheritable copy of FD. Return 0 on success, - * -1 on failure. */ -static int -prepareStdFd(int fd, int std) -{ - if (fd == std) - return virSetInherit(fd, true); - if (dup2(fd, std) != std) - return -1; - return 0; -} - -/* - * @argv argv to exec - * @envp optional environment to use for exec - * @keepfd options fd_ret to keep open for child process - * @retpid optional pointer to store child process pid - * @infd optional file descriptor to use as child input, otherwise /dev/null - * @outfd optional pointer to communicate output fd behavior - * outfd == NULL : Use /dev/null - * *outfd == -1 : Use a new fd - * *outfd != -1 : Use *outfd - * @errfd optional pointer to communcate error fd behavior. See outfd - * @flags possible combination of the following: - * VIR_EXEC_NONE : Default function behavior - * VIR_EXEC_NONBLOCK : Set child process output fd's as non-blocking - * VIR_EXEC_DAEMON : Daemonize the child process - * @hook optional virExecHook function to call prior to exec - * @data data to pass to the hook function - * @pidfile path to use as pidfile for daemonized process (needs DAEMON flag) - * @capabilities capabilities to keep - */ -static int -virExecWithHook(const char *const*argv, - const char *const*envp, - const int *keepfd, - int keepfd_size, - pid_t *retpid, - int infd, int *outfd, int *errfd, - unsigned int flags, - virExecHook hook, - void *data, - char *pidfile, - unsigned long long capabilities) -{ - pid_t pid; - int null = -1, i, openmax; - int pipeout[2] = {-1,-1}; - int pipeerr[2] = {-1,-1}; - int childout = -1; - int childerr = -1; - int tmpfd; - const char *binary = NULL; - int forkRet; - - if (argv[0][0] != '/') { - if (!(binary = virFindFileInPath(argv[0]))) { - virReportSystemError(ENOENT, - _("Cannot find '%s' in path"), - argv[0]); - return -1; - } - } else { - binary = argv[0]; - } - - if (infd < 0) { - if (getDevNull(&null) < 0) - goto cleanup; - infd = null; - } - - if (outfd != NULL) { - if (*outfd == -1) { - if (pipe2(pipeout, O_CLOEXEC) < 0) { - virReportSystemError(errno, - "%s", _("cannot create pipe")); - goto cleanup; - } - - if ((flags & VIR_EXEC_NONBLOCK) && - virSetNonBlock(pipeout[0]) == -1) { - virReportSystemError(errno, - "%s", _("Failed to set non-blocking file descriptor flag")); - goto cleanup; - } - - childout = pipeout[1]; - } else { - childout = *outfd; - } - } else { - if (getDevNull(&null) < 0) - goto cleanup; - childout = null; - } - - if (errfd != NULL) { - if (errfd == outfd) { - childerr = childout; - } else if (*errfd == -1) { - if (pipe2(pipeerr, O_CLOEXEC) < 0) { - virReportSystemError(errno, - "%s", _("Failed to create pipe")); - goto cleanup; - } - - if ((flags & VIR_EXEC_NONBLOCK) && - virSetNonBlock(pipeerr[0]) == -1) { - virReportSystemError(errno, - "%s", _("Failed to set non-blocking file descriptor flag")); - goto cleanup; - } - - childerr = pipeerr[1]; - } else { - childerr = *errfd; - } - } else { - if (getDevNull(&null) < 0) - goto cleanup; - childerr = null; - } - - forkRet = virFork(&pid); - - if (pid < 0) { - goto cleanup; - } - - if (pid) { /* parent */ - if (forkRet < 0) { - goto cleanup; - } - - VIR_FORCE_CLOSE(null); - if (outfd && *outfd == -1) { - VIR_FORCE_CLOSE(pipeout[1]); - *outfd = pipeout[0]; - } - if (errfd && *errfd == -1) { - VIR_FORCE_CLOSE(pipeerr[1]); - *errfd = pipeerr[0]; - } - - *retpid = pid; - - if (binary != argv[0]) - VIR_FREE(binary); - - return 0; - } - - /* child */ - - if (forkRet < 0) { - /* The fork was successful, but after that there was an error - * in the child (which was already logged). - */ - goto fork_error; - } - - openmax = sysconf(_SC_OPEN_MAX); - for (i = 3; i < openmax; i++) { - if (i == infd || i == childout || i == childerr) - continue; - if (!keepfd || !virCommandFDIsSet(i, keepfd, keepfd_size)) { - tmpfd = i; - VIR_MASS_CLOSE(tmpfd); - } else if (virSetInherit(i, true) < 0) { - virReportSystemError(errno, _("failed to preserve fd %d"), i); - goto fork_error; - } - } - - if (prepareStdFd(infd, STDIN_FILENO) < 0) { - virReportSystemError(errno, - "%s", _("failed to setup stdin file handle")); - goto fork_error; - } - if (childout > 0 && prepareStdFd(childout, STDOUT_FILENO) < 0) { - virReportSystemError(errno, - "%s", _("failed to setup stdout file handle")); - goto fork_error; - } - if (childerr > 0 && prepareStdFd(childerr, STDERR_FILENO) < 0) { - virReportSystemError(errno, - "%s", _("failed to setup stderr file handle")); - goto fork_error; - } - - if (infd != STDIN_FILENO && infd != null && infd != childerr && - infd != childout) - VIR_FORCE_CLOSE(infd); - if (childout > STDERR_FILENO && childout != null && childout != childerr) - VIR_FORCE_CLOSE(childout); - if (childerr > STDERR_FILENO && childerr != null) - VIR_FORCE_CLOSE(childerr); - VIR_FORCE_CLOSE(null); - - /* Initialize full logging for a while */ - virLogSetFromEnv(); - - /* Daemonize as late as possible, so the parent process can detect - * the above errors with wait* */ - if (flags & VIR_EXEC_DAEMON) { - if (setsid() < 0) { - virReportSystemError(errno, - "%s", _("cannot become session leader")); - goto fork_error; - } - - if (chdir("/") < 0) { - virReportSystemError(errno, - "%s", _("cannot change to root directory")); - goto fork_error; - } - - pid = fork(); - if (pid < 0) { - virReportSystemError(errno, - "%s", _("cannot fork child process")); - goto fork_error; - } - - if (pid > 0) { - if (pidfile && (virPidFileWritePath(pidfile,pid) < 0)) { - kill(pid, SIGTERM); - usleep(500*1000); - kill(pid, SIGTERM); - virReportSystemError(errno, - _("could not write pidfile %s for %d"), - pidfile, pid); - goto fork_error; - } - _exit(0); - } - } - - if (hook) { - /* virFork reset all signal handlers to the defaults. - * This is good for the child process, but our hook - * risks running something that generates SIGPIPE, - * so we need to temporarily block that again - */ - struct sigaction waxon, waxoff; - memset(&waxoff, 0, sizeof(waxoff)); - waxoff.sa_handler = SIG_IGN; - sigemptyset(&waxoff.sa_mask); - memset(&waxon, 0, sizeof(waxon)); - if (sigaction(SIGPIPE, &waxoff, &waxon) < 0) { - virReportSystemError(errno, "%s", - _("Could not disable SIGPIPE")); - goto fork_error; - } - - if ((hook)(data) != 0) { - VIR_DEBUG("Hook function failed."); - goto fork_error; - } - - if (sigaction(SIGPIPE, &waxon, NULL) < 0) { - virReportSystemError(errno, "%s", - _("Could not re-enable SIGPIPE")); - goto fork_error; - } - } - - /* The steps above may need todo something privileged, so - * we delay clearing capabilities until the last minute */ - if (capabilities || (flags & VIR_EXEC_CLEAR_CAPS)) - if (virSetCapabilities(capabilities) < 0) - goto fork_error; - - /* Close logging again to ensure no FDs leak to child */ - virLogReset(); - - if (envp) - execve(binary, (char **) argv, (char**)envp); - else - execv(binary, (char **) argv); - - virReportSystemError(errno, - _("cannot execute binary %s"), - argv[0]); - - fork_error: - virDispatchError(NULL); - _exit(EXIT_FAILURE); - - cleanup: - /* This is cleanup of parent process only - child - should never jump here on error */ - - if (binary != argv[0]) - VIR_FREE(binary); - - /* NB we don't virReportError() on any failures here - because the code which jumped here already raised - an error condition which we must not overwrite */ - VIR_FORCE_CLOSE(pipeerr[0]); - VIR_FORCE_CLOSE(pipeerr[1]); - VIR_FORCE_CLOSE(pipeout[0]); - VIR_FORCE_CLOSE(pipeout[1]); - VIR_FORCE_CLOSE(null); - return -1; -} - -/** - * virRun: - * @argv NULL terminated argv to run - * @status optional variable to return exit status in - * - * Run a command without using the shell. - * - * If status is NULL, then return 0 if the command run and - * exited with 0 status; Otherwise return -1 - * - * If status is not-NULL, then return 0 if the command ran. - * The status variable is filled with the command exit status - * and should be checked by caller for success. Return -1 - * only if the command could not be run. - */ -int -virRun(const char *const*argv, int *status) -{ - int ret; - virCommandPtr cmd = virCommandNewArgs(argv); - - ret = virCommandRun(cmd, status); - virCommandFree(cmd); - return ret; -} - -#else /* WIN32 */ - -int -virRun(const char *const *argv ATTRIBUTE_UNUSED, - int *status) -{ - if (status) - *status = ENOTSUP; - else - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virRun is not implemented for WIN32")); - return -1; -} - -static int -virExecWithHook(const char *const*argv ATTRIBUTE_UNUSED, - const char *const*envp ATTRIBUTE_UNUSED, - const int *keepfd ATTRIBUTE_UNUSED, - int keepfd_size ATTRIBUTE_UNUSED, - pid_t *retpid ATTRIBUTE_UNUSED, - int infd ATTRIBUTE_UNUSED, - int *outfd ATTRIBUTE_UNUSED, - int *errfd ATTRIBUTE_UNUSED, - int flags_unused ATTRIBUTE_UNUSED, - virExecHook hook ATTRIBUTE_UNUSED, - void *data ATTRIBUTE_UNUSED, - char *pidfile ATTRIBUTE_UNUSED, - unsigned long long capabilities ATTRIBUTE_UNUSED) -{ - /* XXX: Some day we can implement pieces of virCommand/virExec on - * top of _spawn() or CreateProcess(), but we can't implement - * everything, since mingw completely lacks fork(), so we cannot - * run hook code in the child. */ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virExec is not implemented for WIN32")); - return -1; -} - -int -virFork(pid_t *pid) -{ - *pid = -1; - errno = ENOTSUP; - - return -1; -} - -#endif /* WIN32 */ - - -/** - * virCommandNew: - * @binary: program to run - * - * Create a new command for named binary. If @binary is relative, - * it will be found via a PATH search of the parent's PATH (and not - * any altered PATH set by virCommandAddEnv* commands). - */ -virCommandPtr -virCommandNew(const char *binary) -{ - const char *const args[] = { binary, NULL }; - - return virCommandNewArgs(args); -} - -/** - * virCommandNewArgs: - * @args: array of arguments - * - * Create a new command with a NULL terminated - * set of args, taking binary from args[0]. More arguments can - * be added later. @args[0] is handled like @binary of virCommandNew. - */ -virCommandPtr -virCommandNewArgs(const char *const*args) -{ - virCommandPtr cmd; - - if (VIR_ALLOC(cmd) < 0) - return NULL; - - cmd->handshakeWait[0] = -1; - cmd->handshakeWait[1] = -1; - cmd->handshakeNotify[0] = -1; - cmd->handshakeNotify[1] = -1; - - cmd->infd = cmd->outfd = cmd->errfd = -1; - cmd->pid = -1; - - virCommandAddArgSet(cmd, args); - - return cmd; -} - -/** - * virCommandNewArgList: - * @binary: program to run - * @...: additional arguments - * - * Create a new command with a NULL terminated - * list of args, starting with the binary to run. More arguments can - * be added later. @binary is handled as in virCommandNew. - */ -virCommandPtr -virCommandNewArgList(const char *binary, ...) -{ - virCommandPtr cmd = virCommandNew(binary); - va_list list; - const char *arg; - - if (!cmd || cmd->has_error) - return cmd; - - va_start(list, binary); - while ((arg = va_arg(list, const char *)) != NULL) - virCommandAddArg(cmd, arg); - va_end(list); - return cmd; -} - -/** - * virCommandNewVAList: - * @binary: program to run - * @va_list: additional arguments - * - * Create a new command with a NULL terminated - * variable argument list. @binary is handled as in virCommandNew. - */ -virCommandPtr -virCommandNewVAList(const char *binary, va_list list) -{ - virCommandPtr cmd = virCommandNew(binary); - const char *arg; - - if (!cmd || cmd->has_error) - return cmd; - - while ((arg = va_arg(list, const char *)) != NULL) - virCommandAddArg(cmd, arg); - return cmd; -} - - -/* - * Preserve the specified file descriptor in the child, instead of - * closing it. FD must not be one of the three standard streams. If - * transfer is true, then fd will be closed in the parent after a call - * to Run/RunAsync/Free, otherwise caller is still responsible for fd. - * Returns true if a transferring caller should close FD now, and - * false if the transfer is successfully recorded. - */ -static bool -virCommandKeepFD(virCommandPtr cmd, int fd, bool transfer) -{ - int ret = 0; - - if (!cmd) - return fd > STDERR_FILENO; - - if (fd <= STDERR_FILENO || - (ret = virCommandFDSet(fd, &cmd->preserve, &cmd->preserve_size)) || - (transfer && (ret = virCommandFDSet(fd, &cmd->transfer, - &cmd->transfer_size)))) { - if (!cmd->has_error) - cmd->has_error = ret ? ret : -1 ; - VIR_DEBUG("cannot preserve %d", fd); - return fd > STDERR_FILENO; - } - - return false; -} - -/** - * virCommandPreserveFD: - * @cmd: the command to modify - * @fd: fd to mark for inheritance into child - * - * Preserve the specified file descriptor - * in the child, instead of closing it on exec. - * The parent is still responsible for managing fd. - */ -void -virCommandPreserveFD(virCommandPtr cmd, int fd) -{ - virCommandKeepFD(cmd, fd, false); -} - -/** - * virCommandTransferFD: - * @cmd: the command to modify - * @fd: fd to reassign to the child - * - * Transfer the specified file descriptor - * to the child, instead of closing it on exec. - * The parent should no longer use fd, and the parent's copy will - * be automatically closed no later than during Run/RunAsync/Free. - */ -void -virCommandTransferFD(virCommandPtr cmd, int fd) -{ - if (virCommandKeepFD(cmd, fd, true)) - VIR_FORCE_CLOSE(fd); -} - - -/** - * virCommandSetPidFile: - * @cmd: the command to modify - * @pidfile: filename to use - * - * Save the child PID in a pidfile. The pidfile will be populated - * before the exec of the child. - */ -void -virCommandSetPidFile(virCommandPtr cmd, const char *pidfile) -{ - if (!cmd || cmd->has_error) - return; - - VIR_FREE(cmd->pidfile); - if (!(cmd->pidfile = strdup(pidfile))) { - cmd->has_error = ENOMEM; - } -} - - -/** - * virCommandClearCaps: - * @cmd: the command to modify - * - * Remove all capabilities from the child, after any hooks have been run. - */ -void -virCommandClearCaps(virCommandPtr cmd) -{ - if (!cmd || cmd->has_error) - return; - - cmd->flags |= VIR_EXEC_CLEAR_CAPS; -} - -/** - * virCommandAllowCap: - * @cmd: the command to modify - * @capability: what to allow - * - * Allow specific capabilities - */ -void -virCommandAllowCap(virCommandPtr cmd, - int capability) -{ - if (!cmd || cmd->has_error) - return; - - cmd->capabilities |= (1ULL << capability); -} - - - -/** - * virCommandDaemonize: - * @cmd: the command to modify - * - * Daemonize the child process. The child will have a current working - * directory of /, and must be started with virCommandRun, which will - * complete as soon as the daemon grandchild has started. - */ -void -virCommandDaemonize(virCommandPtr cmd) -{ - if (!cmd || cmd->has_error) - return; - - cmd->flags |= VIR_EXEC_DAEMON; -} - -/** - * virCommandNonblockingFDs: - * @cmd: the command to modify - * - * Set FDs created by virCommandSetOutputFD and virCommandSetErrorFD - * as non-blocking in the parent. - */ -void -virCommandNonblockingFDs(virCommandPtr cmd) -{ - if (!cmd || cmd->has_error) - return; - - cmd->flags |= VIR_EXEC_NONBLOCK; -} - -/* Add an environment variable to the cmd->env list. 'env' is a - * string like "name=value". If the named environment variable is - * already set, then it is replaced in the list. - */ -static inline void -virCommandAddEnv(virCommandPtr cmd, char *env) -{ - size_t namelen; - size_t i; - - /* Search for the name in the existing environment. */ - namelen = strcspn(env, "="); - for (i = 0; i < cmd->nenv; ++i) { - /* + 1 because we want to match the '=' character too. */ - if (STREQLEN(cmd->env[i], env, namelen + 1)) { - VIR_FREE(cmd->env[i]); - cmd->env[i] = env; - return; - } - } - - /* Arg plus trailing NULL. */ - if (VIR_RESIZE_N(cmd->env, cmd->maxenv, cmd->nenv, 1 + 1) < 0) { - VIR_FREE(env); - cmd->has_error = ENOMEM; - return; - } - - cmd->env[cmd->nenv++] = env; -} - -/** - * virCommandAddEnvFormat: - * @cmd: the command to modify - * @format: format of arguments, end result must be in name=value format - * @...: arguments to be formatted - * - * Add an environment variable to the child created by a printf-style format. - */ -void -virCommandAddEnvFormat(virCommandPtr cmd, const char *format, ...) -{ - char *env; - va_list list; - - if (!cmd || cmd->has_error) - return; - - va_start(list, format); - if (virVasprintf(&env, format, list) < 0) { - cmd->has_error = ENOMEM; - va_end(list); - return; - } - va_end(list); - - virCommandAddEnv(cmd, env); -} - -/** - * virCommandAddEnvPair: - * @cmd: the command to modify - * @name: variable name, must not contain = - * @value: value to assign to name - * - * Add an environment variable to the child - * using separate name & value strings - */ -void -virCommandAddEnvPair(virCommandPtr cmd, const char *name, const char *value) -{ - virCommandAddEnvFormat(cmd, "%s=%s", name, value); -} - - -/** - * virCommandAddEnvString: - * @cmd: the command to modify - * @str: name=value format - * - * Add an environment variable to the child - * using a preformatted env string FOO=BAR - */ -void -virCommandAddEnvString(virCommandPtr cmd, const char *str) -{ - char *env; - - if (!cmd || cmd->has_error) - return; - - if (!(env = strdup(str))) { - cmd->has_error = ENOMEM; - return; - } - - virCommandAddEnv(cmd, env); -} - - -/** - * virCommandAddEnvBuffer: - * @cmd: the command to modify - * @buf: buffer that contains name=value string, which will be reset on return - * - * Convert a buffer containing preformatted name=value into an - * environment variable of the child. - * Correctly transfers memory errors or contents from buf to cmd. - */ -void -virCommandAddEnvBuffer(virCommandPtr cmd, virBufferPtr buf) -{ - if (!cmd || cmd->has_error) { - virBufferFreeAndReset(buf); - return; - } - - if (virBufferError(buf)) { - cmd->has_error = ENOMEM; - virBufferFreeAndReset(buf); - return; - } - if (!virBufferUse(buf)) { - cmd->has_error = EINVAL; - return; - } - - virCommandAddEnv(cmd, virBufferContentAndReset(buf)); -} - - -/** - * virCommandAddEnvPass: - * @cmd: the command to modify - * @name: the name to look up in current environment - * - * Pass an environment variable to the child - * using current process' value - */ -void -virCommandAddEnvPass(virCommandPtr cmd, const char *name) -{ - char *value; - if (!cmd || cmd->has_error) - return; - - value = getenv(name); - if (value) - virCommandAddEnvPair(cmd, name, value); -} - - -/** - * virCommandAddEnvPassCommon: - * @cmd: the command to modify - * - * Set LC_ALL to C, and propagate other essential environment - * variables (such as PATH) from the parent process. - */ -void -virCommandAddEnvPassCommon(virCommandPtr cmd) -{ - if (!cmd || cmd->has_error) - return; - - /* Attempt to Pre-allocate; allocation failure will be detected - * later during virCommandAdd*. */ - ignore_value(VIR_RESIZE_N(cmd->env, cmd->maxenv, cmd->nenv, 9)); - - virCommandAddEnvPair(cmd, "LC_ALL", "C"); - - virCommandAddEnvPass(cmd, "LD_PRELOAD"); - virCommandAddEnvPass(cmd, "LD_LIBRARY_PATH"); - virCommandAddEnvPass(cmd, "PATH"); - virCommandAddEnvPass(cmd, "HOME"); - virCommandAddEnvPass(cmd, "USER"); - virCommandAddEnvPass(cmd, "LOGNAME"); - virCommandAddEnvPass(cmd, "TMPDIR"); -} - -/** - * virCommandAddArg: - * @cmd: the command to modify - * @val: the argument to add - * - * Add a command line argument to the child - */ -void -virCommandAddArg(virCommandPtr cmd, const char *val) -{ - char *arg; - - if (!cmd || cmd->has_error) - return; - - if (!(arg = strdup(val))) { - cmd->has_error = ENOMEM; - return; - } - - /* Arg plus trailing NULL. */ - if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, 1 + 1) < 0) { - VIR_FREE(arg); - cmd->has_error = ENOMEM; - return; - } - - cmd->args[cmd->nargs++] = arg; -} - - -/** - * virCommandAddArgBuffer: - * @cmd: the command to modify - * @buf: buffer that contains argument string, which will be reset on return - * - * Convert a buffer into a command line argument to the child. - * Correctly transfers memory errors or contents from buf to cmd. - */ -void -virCommandAddArgBuffer(virCommandPtr cmd, virBufferPtr buf) -{ - if (!cmd || cmd->has_error) { - virBufferFreeAndReset(buf); - return; - } - - /* Arg plus trailing NULL. */ - if (virBufferError(buf) || - VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, 1 + 1) < 0) { - cmd->has_error = ENOMEM; - virBufferFreeAndReset(buf); - return; - } - - cmd->args[cmd->nargs] = virBufferContentAndReset(buf); - if (!cmd->args[cmd->nargs]) - cmd->args[cmd->nargs] = strdup(""); - if (!cmd->args[cmd->nargs]) { - cmd->has_error = ENOMEM; - return; - } - cmd->nargs++; -} - - -/** - * virCommandAddArgFormat: - * @cmd: the command to modify - * @format: format of arguments, end result must be in name=value format - * @...: arguments to be formatted - * - * Add a command line argument created by a printf-style format. - */ -void -virCommandAddArgFormat(virCommandPtr cmd, const char *format, ...) -{ - char *arg; - va_list list; - - if (!cmd || cmd->has_error) - return; - - va_start(list, format); - if (virVasprintf(&arg, format, list) < 0) { - cmd->has_error = ENOMEM; - va_end(list); - return; - } - va_end(list); - - /* Arg plus trailing NULL. */ - if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, 1 + 1) < 0) { - VIR_FREE(arg); - cmd->has_error = ENOMEM; - return; - } - - cmd->args[cmd->nargs++] = arg; -} - -/** - * virCommandAddArgPair: - * @cmd: the command to modify - * @name: left half of argument - * @value: right half of argument - * - * Add "NAME=VAL" as a single command line argument to the child - */ -void -virCommandAddArgPair(virCommandPtr cmd, const char *name, const char *val) -{ - virCommandAddArgFormat(cmd, "%s=%s", name, val); -} - -/** - * virCommandAddArgSet: - * @cmd: the command to modify - * @vals: array of arguments to add - * - * Add a NULL terminated list of args - */ -void -virCommandAddArgSet(virCommandPtr cmd, const char *const*vals) -{ - int narg = 0; - - if (!cmd || cmd->has_error) - return; - - if (vals[0] == NULL) { - cmd->has_error = EINVAL; - return; - } - - while (vals[narg] != NULL) - narg++; - - /* narg plus trailing NULL. */ - if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, narg + 1) < 0) { - cmd->has_error = ENOMEM; - return; - } - - narg = 0; - while (vals[narg] != NULL) { - char *arg = strdup(vals[narg++]); - if (!arg) { - cmd->has_error = ENOMEM; - return; - } - cmd->args[cmd->nargs++] = arg; - } -} - -/** - * virCommandAddArgList: - * @cmd: the command to modify - * @...: list of arguments to add - * - * Add a NULL terminated list of args. - */ -void -virCommandAddArgList(virCommandPtr cmd, ...) -{ - va_list list; - int narg = 0; - - if (!cmd || cmd->has_error) - return; - - va_start(list, cmd); - while (va_arg(list, const char *) != NULL) - narg++; - va_end(list); - - /* narg plus trailing NULL. */ - if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, narg + 1) < 0) { - cmd->has_error = ENOMEM; - return; - } - - va_start(list, cmd); - while (1) { - char *arg = va_arg(list, char *); - if (!arg) - break; - arg = strdup(arg); - if (!arg) { - cmd->has_error = ENOMEM; - va_end(list); - return; - } - cmd->args[cmd->nargs++] = arg; - } - va_end(list); -} - -/** - * virCommandSetWorkingDirectory: - * @cmd: the command to modify - * @pwd: directory to use - * - * Set the working directory of a non-daemon child process, rather - * than the parent's working directory. Daemons automatically get / - * without using this call. - */ -void -virCommandSetWorkingDirectory(virCommandPtr cmd, const char *pwd) -{ - if (!cmd || cmd->has_error) - return; - - if (cmd->pwd) { - cmd->has_error = -1; - VIR_DEBUG("cannot set directory twice"); - } else { - cmd->pwd = strdup(pwd); - if (!cmd->pwd) - cmd->has_error = ENOMEM; - } -} - - -/** - * virCommandSetInputBuffer: - * @cmd: the command to modify - * @inbuf: string to feed to stdin - * - * Feed the child's stdin from a string buffer. This requires the use - * of virCommandRun(). - */ -void -virCommandSetInputBuffer(virCommandPtr cmd, const char *inbuf) -{ - if (!cmd || cmd->has_error) - return; - - if (cmd->infd != -1 || cmd->inbuf) { - cmd->has_error = -1; - VIR_DEBUG("cannot specify input twice"); - return; - } - - cmd->inbuf = strdup(inbuf); - if (!cmd->inbuf) - cmd->has_error = ENOMEM; -} - - -/** - * virCommandSetOutputBuffer: - * @cmd: the command to modify - * @outbuf: address of variable to store malloced result buffer - * - * Capture the child's stdout to a string buffer. *outbuf is - * guaranteed to be allocated after successful virCommandRun or - * virCommandWait, and is best-effort allocated after failed - * virCommandRun; caller is responsible for freeing *outbuf. - * This requires the use of virCommandRun. - */ -void -virCommandSetOutputBuffer(virCommandPtr cmd, char **outbuf) -{ - *outbuf = NULL; - if (!cmd || cmd->has_error) - return; - - if (cmd->outfdptr) { - cmd->has_error = -1; - VIR_DEBUG("cannot specify output twice"); - return; - } - - cmd->outbuf = outbuf; - cmd->outfdptr = &cmd->outfd; -} - - -/** - * virCommandSetErrorBuffer: - * @cmd: the command to modify - * @errbuf: address of variable to store malloced result buffer - * - * Capture the child's stderr to a string buffer. *errbuf is - * guaranteed to be allocated after successful virCommandRun or - * virCommandWait, and is best-effort allocated after failed - * virCommandRun; caller is responsible for freeing *errbuf. - * This requires the use of virCommandRun. It is possible to - * pass the same pointer as for virCommandSetOutputBuffer(), in - * which case the child process will interleave all output into - * a single string. - */ -void -virCommandSetErrorBuffer(virCommandPtr cmd, char **errbuf) -{ - *errbuf = NULL; - if (!cmd || cmd->has_error) - return; - - if (cmd->errfdptr) { - cmd->has_error = -1; - VIR_DEBUG("cannot specify stderr twice"); - return; - } - - cmd->errbuf = errbuf; - cmd->errfdptr = &cmd->errfd; -} - - -/** - * virCommandSetInputFD: - * @cmd: the command to modify - * @infd: the descriptor to use - * - * Attach a file descriptor to the child's stdin - */ -void -virCommandSetInputFD(virCommandPtr cmd, int infd) -{ - if (!cmd || cmd->has_error) - return; - - if (cmd->infd != -1 || cmd->inbuf) { - cmd->has_error = -1; - VIR_DEBUG("cannot specify input twice"); - return; - } - if (infd < 0) { - cmd->has_error = -1; - VIR_DEBUG("cannot specify invalid input fd"); - return; - } - - cmd->infd = infd; -} - - -/** - * virCommandSetOutputFD: - * @cmd: the command to modify - * @outfd: location of output fd - * - * Attach a file descriptor to the child's stdout. If *@outfd is -1 on - * entry, then a pipe will be created and returned in this variable when - * the child is run. Otherwise, *@outfd is used as the output. - */ -void -virCommandSetOutputFD(virCommandPtr cmd, int *outfd) -{ - if (!cmd || cmd->has_error) - return; - - if (cmd->outfdptr) { - cmd->has_error = -1; - VIR_DEBUG("cannot specify output twice"); - return; - } - - cmd->outfdptr = outfd; -} - - -/** - * virCommandSetErrorFD: - * @cmd: the command to modify - * @errfd: location of error fd - * - * Attach a file descriptor to the child's stderr. If *@errfd is -1 on - * entry, then a pipe will be created and returned in this variable when - * the child is run. Otherwise, *@errfd is used for error collection, - * and may be the same as outfd given to virCommandSetOutputFD(). - */ -void -virCommandSetErrorFD(virCommandPtr cmd, int *errfd) -{ - if (!cmd || cmd->has_error) - return; - - if (cmd->errfdptr) { - cmd->has_error = -1; - VIR_DEBUG("cannot specify stderr twice"); - return; - } - - cmd->errfdptr = errfd; -} - - -/** - * virCommandSetPreExecHook: - * @cmd: the command to modify - * @hook: the hook to run - * @opaque: argument to pass to the hook - * - * Run HOOK(OPAQUE) in the child as the last thing before changing - * directories, dropping capabilities, and executing the new process. - * Force the child to fail if HOOK does not return zero. - * - * Since @hook runs in the child, it should be careful to avoid - * any functions that are not async-signal-safe. - */ -void -virCommandSetPreExecHook(virCommandPtr cmd, virExecHook hook, void *opaque) -{ - if (!cmd || cmd->has_error) - return; - - if (cmd->hook) { - cmd->has_error = -1; - VIR_DEBUG("cannot specify hook twice"); - return; - } - cmd->hook = hook; - cmd->opaque = opaque; -} - - -/** - * virCommandWriteArgLog: - * @cmd: the command to log - * @logfd: where to log the results - * - * Call after adding all arguments and environment settings, but before - * Run/RunAsync, to immediately output the environment and arguments of - * cmd to logfd. If virCommandRun cannot succeed (because of an - * out-of-memory condition while building cmd), nothing will be logged. - */ -void -virCommandWriteArgLog(virCommandPtr cmd, int logfd) -{ - int ioError = 0; - size_t i; - - /* Any errors will be reported later by virCommandRun, which means - * no command will be run, so there is nothing to log. */ - if (!cmd || cmd->has_error) - return; - - for (i = 0 ; i < cmd->nenv ; i++) { - if (safewrite(logfd, cmd->env[i], strlen(cmd->env[i])) < 0) - ioError = errno; - if (safewrite(logfd, " ", 1) < 0) - ioError = errno; - } - for (i = 0 ; i < cmd->nargs ; i++) { - if (safewrite(logfd, cmd->args[i], strlen(cmd->args[i])) < 0) - ioError = errno; - if (safewrite(logfd, i == cmd->nargs - 1 ? "\n" : " ", 1) < 0) - ioError = errno; - } - - if (ioError) { - char ebuf[1024]; - VIR_WARN("Unable to write command %s args to logfile: %s", - cmd->args[0], virStrerror(ioError, ebuf, sizeof(ebuf))); - } -} - - -/** - * virCommandToString: - * @cmd: the command to convert - * - * Call after adding all arguments and environment settings, but - * before Run/RunAsync, to return a string representation of the - * environment and arguments of cmd, suitably quoted for pasting into - * a shell. If virCommandRun cannot succeed (because of an - * out-of-memory condition while building cmd), NULL will be returned. - * Caller is responsible for freeing the resulting string. - */ -char * -virCommandToString(virCommandPtr cmd) -{ - size_t i; - virBuffer buf = VIR_BUFFER_INITIALIZER; - - /* Cannot assume virCommandRun will be called; so report the error - * now. If virCommandRun is called, it will report the same error. */ - if (!cmd ||cmd->has_error == ENOMEM) { - virReportOOMError(); - return NULL; - } - if (cmd->has_error) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("invalid use of command API")); - return NULL; - } - - for (i = 0; i < cmd->nenv; i++) { - /* In shell, a='b c' has a different meaning than 'a=b c', so - * we must determine where the '=' lives. */ - char *eq = strchr(cmd->env[i], '='); - - if (!eq) { - virBufferFreeAndReset(&buf); - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("invalid use of command API")); - return NULL; - } - eq++; - virBufferAdd(&buf, cmd->env[i], eq - cmd->env[i]); - virBufferEscapeShell(&buf, eq); - virBufferAddChar(&buf, ' '); - } - virBufferEscapeShell(&buf, cmd->args[0]); - for (i = 1; i < cmd->nargs; i++) { - virBufferAddChar(&buf, ' '); - virBufferEscapeShell(&buf, cmd->args[i]); - } - - if (virBufferError(&buf)) { - virBufferFreeAndReset(&buf); - virReportOOMError(); - return NULL; - } - - return virBufferContentAndReset(&buf); -} - - -/* - * Manage input and output to the child process. - */ -static int -virCommandProcessIO(virCommandPtr cmd, int *inpipe) -{ - int infd = -1, outfd = -1, errfd = -1; - size_t inlen = 0, outlen = 0, errlen = 0; - size_t inoff = 0; - int ret = 0; - - /* With an input buffer, feed data to child - * via pipe */ - if (cmd->inbuf) { - inlen = strlen(cmd->inbuf); - infd = *inpipe; - } - - /* With out/err buffer, the outfd/errfd have been filled with an - * FD for us. Guarantee an allocated string with partial results - * even if we encounter a later failure, as well as freeing any - * results accumulated over a prior run of the same command. */ - if (cmd->outbuf) { - outfd = cmd->outfd; - if (VIR_REALLOC_N(*cmd->outbuf, 1) < 0) { - virReportOOMError(); - ret = -1; - } - } - if (cmd->errbuf) { - errfd = cmd->errfd; - if (VIR_REALLOC_N(*cmd->errbuf, 1) < 0) { - virReportOOMError(); - ret = -1; - } - } - if (ret == -1) - goto cleanup; - ret = -1; - - for (;;) { - int i; - struct pollfd fds[3]; - int nfds = 0; - - if (infd != -1) { - fds[nfds].fd = infd; - fds[nfds].events = POLLOUT; - fds[nfds].revents = 0; - nfds++; - } - if (outfd != -1) { - fds[nfds].fd = outfd; - fds[nfds].events = POLLIN; - fds[nfds].revents = 0; - nfds++; - } - if (errfd != -1) { - fds[nfds].fd = errfd; - fds[nfds].events = POLLIN; - fds[nfds].revents = 0; - nfds++; - } - - if (nfds == 0) - break; - - if (poll(fds, nfds, -1) < 0) { - if (errno == EAGAIN || errno == EINTR) - continue; - virReportSystemError(errno, "%s", - _("unable to poll on child")); - goto cleanup; - } - - for (i = 0; i < nfds ; i++) { - if (fds[i].revents & (POLLIN | POLLHUP | POLLERR) && - (fds[i].fd == errfd || fds[i].fd == outfd)) { - char data[1024]; - char **buf; - size_t *len; - int done; - if (fds[i].fd == outfd) { - buf = cmd->outbuf; - len = &outlen; - } else { - buf = cmd->errbuf; - len = &errlen; - } - /* Silence a false positive from clang. */ - sa_assert(buf); - - done = read(fds[i].fd, data, sizeof(data)); - if (done < 0) { - if (errno != EINTR && - errno != EAGAIN) { - virReportSystemError(errno, "%s", - (fds[i].fd == outfd) ? - _("unable to read child stdout") : - _("unable to read child stderr")); - goto cleanup; - } - } else if (done == 0) { - if (fds[i].fd == outfd) - outfd = -1; - else - errfd = -1; - } else { - if (VIR_REALLOC_N(*buf, *len + done + 1) < 0) { - virReportOOMError(); - goto cleanup; - } - memcpy(*buf + *len, data, done); - *len += done; - } - } - - if (fds[i].revents & (POLLOUT | POLLERR) && - fds[i].fd == infd) { - int done; - - /* Coverity 5.3.0 can't see that we only get here if - * infd is in the set because it was non-negative. */ - sa_assert(infd != -1); - done = write(infd, cmd->inbuf + inoff, - inlen - inoff); - if (done < 0) { - if (errno == EPIPE) { - VIR_DEBUG("child closed stdin early, ignoring EPIPE " - "on fd %d", infd); - if (VIR_CLOSE(*inpipe) < 0) - VIR_DEBUG("ignoring failed close on fd %d", infd); - infd = -1; - } else if (errno != EINTR && errno != EAGAIN) { - virReportSystemError(errno, "%s", - _("unable to write to child input")); - goto cleanup; - } - } else { - inoff += done; - if (inoff == inlen) { - if (VIR_CLOSE(*inpipe) < 0) - VIR_DEBUG("ignoring failed close on fd %d", infd); - infd = -1; - } - } - } - } - } - - ret = 0; -cleanup: - if (cmd->outbuf && *cmd->outbuf) - (*cmd->outbuf)[outlen] = '\0'; - if (cmd->errbuf && *cmd->errbuf) - (*cmd->errbuf)[errlen] = '\0'; - return ret; -} - -/** - * virCommandExec: - * @cmd: command to run - * - * Exec the command, replacing the current process. Meant to be called - * in the hook after already forking / cloning, so does not attempt to - * daemonize or preserve any FDs. - * - * Returns -1 on any error executing the command. - * Will not return on success. - */ -#ifndef WIN32 -int virCommandExec(virCommandPtr cmd) -{ - if (!cmd ||cmd->has_error == ENOMEM) { - virReportOOMError(); - return -1; - } - if (cmd->has_error) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("invalid use of command API")); - return -1; - } - - return execve(cmd->args[0], cmd->args, cmd->env); -} -#else -int virCommandExec(virCommandPtr cmd ATTRIBUTE_UNUSED) -{ - /* Mingw execve() has a broken signature. Disable this - * function until gnulib fixes the signature, since we - * don't really need this on Win32 anyway. - */ - virReportSystemError(ENOSYS, "%s", - _("Executing new processes is not supported on Win32 platform")); - return -1; -} -#endif - -/** - * virCommandRun: - * @cmd: command to run - * @exitstatus: optional status collection - * - * Run the command and wait for completion. - * Returns -1 on any error executing the - * command. Returns 0 if the command executed, - * with the exit status set. If @exitstatus is NULL, then the - * child must exit with status 0 for this to succeed. - */ -int -virCommandRun(virCommandPtr cmd, int *exitstatus) -{ - int ret = 0; - char *outbuf = NULL; - char *errbuf = NULL; - int infd[2] = { -1, -1 }; - struct stat st; - bool string_io; - bool async_io = false; - char *str; - int tmpfd; - - if (!cmd ||cmd->has_error == ENOMEM) { - virReportOOMError(); - return -1; - } - if (cmd->has_error) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("invalid use of command API")); - return -1; - } - - /* Avoid deadlock, by requiring that any open fd not under our - * control must be visiting a regular file, or that we are - * daemonized and no string io is required. */ - string_io = cmd->inbuf || cmd->outbuf || cmd->errbuf; - if (cmd->infd != -1 && - (fstat(cmd->infd, &st) < 0 || !S_ISREG(st.st_mode))) - async_io = true; - if (cmd->outfdptr && cmd->outfdptr != &cmd->outfd && - (*cmd->outfdptr == -1 || - fstat(*cmd->outfdptr, &st) < 0 || !S_ISREG(st.st_mode))) - async_io = true; - if (cmd->errfdptr && cmd->errfdptr != &cmd->errfd && - (*cmd->errfdptr == -1 || - fstat(*cmd->errfdptr, &st) < 0 || !S_ISREG(st.st_mode))) - async_io = true; - if (async_io) { - if (!(cmd->flags & VIR_EXEC_DAEMON) || string_io) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("cannot mix caller fds with blocking execution")); - return -1; - } - } else { - if ((cmd->flags & VIR_EXEC_DAEMON) && string_io) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("cannot mix string I/O with daemon")); - return -1; - } - } - - /* If we have an input buffer, we need - * a pipe to feed the data to the child */ - if (cmd->inbuf) { - if (pipe2(infd, O_CLOEXEC) < 0) { - virReportSystemError(errno, "%s", - _("unable to open pipe")); - cmd->has_error = -1; - return -1; - } - cmd->infd = infd[0]; - } - - /* If caller requested the same string for stdout and stderr, then - * merge those into one string. */ - if (cmd->outbuf && cmd->outbuf == cmd->errbuf) { - cmd->errfdptr = &cmd->outfd; - cmd->errbuf = NULL; - } - - /* If caller hasn't requested capture of stdout/err, then capture - * it ourselves so we can log it. But the intermediate child for - * a daemon has no expected output, and we don't want our - * capturing pipes passed on to the daemon grandchild. - */ - if (!(cmd->flags & VIR_EXEC_DAEMON)) { - if (!cmd->outfdptr) { - cmd->outfdptr = &cmd->outfd; - cmd->outbuf = &outbuf; - string_io = true; - } - if (!cmd->errfdptr) { - cmd->errfdptr = &cmd->errfd; - cmd->errbuf = &errbuf; - string_io = true; - } - } - - cmd->flags |= VIR_EXEC_RUN_SYNC; - if (virCommandRunAsync(cmd, NULL) < 0) { - if (cmd->inbuf) { - tmpfd = infd[0]; - if (VIR_CLOSE(infd[0]) < 0) - VIR_DEBUG("ignoring failed close on fd %d", tmpfd); - tmpfd = infd[1]; - if (VIR_CLOSE(infd[1]) < 0) - VIR_DEBUG("ignoring failed close on fd %d", tmpfd); - } - cmd->has_error = -1; - return -1; - } - - tmpfd = infd[0]; - if (VIR_CLOSE(infd[0]) < 0) - VIR_DEBUG("ignoring failed close on fd %d", tmpfd); - if (string_io) - ret = virCommandProcessIO(cmd, &infd[1]); - - if (virCommandWait(cmd, exitstatus) < 0) - ret = -1; - - str = (exitstatus ? virProcessTranslateStatus(*exitstatus) - : (char *) "status 0"); - VIR_DEBUG("Result %s, stdout: '%s' stderr: '%s'", - NULLSTR(str), - cmd->outbuf ? NULLSTR(*cmd->outbuf) : "(null)", - cmd->errbuf ? NULLSTR(*cmd->errbuf) : "(null)"); - if (exitstatus) - VIR_FREE(str); - - /* Reset any capturing, in case caller runs - * this identical command again */ - if (cmd->inbuf) { - tmpfd = infd[1]; - if (VIR_CLOSE(infd[1]) < 0) - VIR_DEBUG("ignoring failed close on fd %d", tmpfd); - } - if (cmd->outbuf == &outbuf) { - tmpfd = cmd->outfd; - if (VIR_CLOSE(cmd->outfd) < 0) - VIR_DEBUG("ignoring failed close on fd %d", tmpfd); - cmd->outfdptr = NULL; - cmd->outbuf = NULL; - VIR_FREE(outbuf); - } - if (cmd->errbuf == &errbuf) { - tmpfd = cmd->errfd; - if (VIR_CLOSE(cmd->errfd) < 0) - VIR_DEBUG("ignoring failed close on fd %d", tmpfd); - cmd->errfdptr = NULL; - cmd->errbuf = NULL; - VIR_FREE(errbuf); - } - - return ret; -} - - -/* - * Perform all virCommand-specific actions, along with the user hook. - */ -static int -virCommandHook(void *data) -{ - virCommandPtr cmd = data; - int res = 0; - - if (cmd->hook) { - VIR_DEBUG("Run hook %p %p", cmd->hook, cmd->opaque); - res = cmd->hook(cmd->opaque); - VIR_DEBUG("Done hook %d", res); - } - if (res == 0 && cmd->pwd) { - VIR_DEBUG("Running child in %s", cmd->pwd); - res = chdir(cmd->pwd); - if (res < 0) { - virReportSystemError(errno, - _("Unable to change to %s"), cmd->pwd); - } - } - if (cmd->handshake) { - char c = res < 0 ? '0' : '1'; - int rv; - VIR_DEBUG("Notifying parent for handshake start on %d", - cmd->handshakeWait[1]); - if (safewrite(cmd->handshakeWait[1], &c, sizeof(c)) != sizeof(c)) { - virReportSystemError(errno, "%s", - _("Unable to notify parent process")); - return -1; - } - - /* On failure we pass the error message back to parent, - * so they don't have to dig through stderr logs - */ - if (res < 0) { - virErrorPtr err = virGetLastError(); - const char *msg = err ? err->message : - _("Unknown failure during hook execution"); - size_t len = strlen(msg) + 1; - if (safewrite(cmd->handshakeWait[1], msg, len) != len) { - virReportSystemError(errno, "%s", - _("Unable to send error to parent")); - return -1; - } - return -1; - } - - VIR_DEBUG("Waiting on parent for handshake complete on %d", - cmd->handshakeNotify[0]); - if ((rv = saferead(cmd->handshakeNotify[0], &c, - sizeof(c))) != sizeof(c)) { - if (rv < 0) - virReportSystemError(errno, "%s", - _("Unable to wait on parent process")); - else - virReportSystemError(EIO, "%s", - _("libvirtd quit during handshake")); - return -1; - } - if (c != '1') { - virReportSystemError(EINVAL, - _("Unexpected confirm code '%c' from parent"), - c); - return -1; - } - VIR_FORCE_CLOSE(cmd->handshakeWait[1]); - VIR_FORCE_CLOSE(cmd->handshakeNotify[0]); - } - - VIR_DEBUG("Hook is done %d", res); - - return res; -} - - -/** - * virCommandRunAsync: - * @cmd: command to start - * @pid: optional variable to track child pid - * - * Run the command asynchronously - * Returns -1 on any error executing the - * command. Returns 0 if the command executed. - * - * There are two approaches to child process cleanup. - * 1. Use auto-cleanup, by passing NULL for pid. The child will be - * auto-reaped by virCommandFree, unless you reap it earlier via - * virCommandWait or virCommandAbort. Good for where cmd is in - * scope for the duration of the child process. - * 2. Use manual cleanup, by passing the address of a pid_t variable - * for pid. While cmd is still in scope, you may reap the child via - * virCommandWait or virCommandAbort. But after virCommandFree, if - * you have not yet reaped the child, then it continues to run until - * you call virProcessWait or virProcessAbort. - */ -int -virCommandRunAsync(virCommandPtr cmd, pid_t *pid) -{ - int ret; - char *str; - int i; - bool synchronous = false; - - if (!cmd || cmd->has_error == ENOMEM) { - virReportOOMError(); - return -1; - } - if (cmd->has_error) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("invalid use of command API")); - return -1; - } - - synchronous = cmd->flags & VIR_EXEC_RUN_SYNC; - cmd->flags &= ~VIR_EXEC_RUN_SYNC; - - /* Buffer management can only be requested via virCommandRun. */ - if ((cmd->inbuf && cmd->infd == -1) || - (cmd->outbuf && cmd->outfdptr != &cmd->outfd) || - (cmd->errbuf && cmd->errfdptr != &cmd->errfd)) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("cannot mix string I/O with asynchronous command")); - return -1; - } - - if (cmd->pid != -1) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("command is already running as pid %lld"), - (long long) cmd->pid); - return -1; - } - - if (!synchronous && (cmd->flags & VIR_EXEC_DAEMON)) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("daemonized command cannot use virCommandRunAsync")); - return -1; - } - if (cmd->pwd && (cmd->flags & VIR_EXEC_DAEMON)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("daemonized command cannot set working directory %s"), - cmd->pwd); - return -1; - } - if (cmd->pidfile && !(cmd->flags & VIR_EXEC_DAEMON)) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("creation of pid file requires daemonized command")); - return -1; - } - - str = virCommandToString(cmd); - VIR_DEBUG("About to run %s", str ? str : cmd->args[0]); - VIR_FREE(str); - - ret = virExecWithHook((const char *const *)cmd->args, - (const char *const *)cmd->env, - cmd->preserve, - cmd->preserve_size, - &cmd->pid, - cmd->infd, - cmd->outfdptr, - cmd->errfdptr, - cmd->flags, - virCommandHook, - cmd, - cmd->pidfile, - cmd->capabilities); - - VIR_DEBUG("Command result %d, with PID %d", - ret, (int)cmd->pid); - - for (i = 0; i < cmd->transfer_size; i++) { - VIR_FORCE_CLOSE(cmd->transfer[i]); - } - cmd->transfer_size = 0; - VIR_FREE(cmd->transfer); - - if (ret == 0 && pid) - *pid = cmd->pid; - else - cmd->reap = true; - - return ret; -} - - -/** - * virCommandWait: - * @cmd: command to wait on - * @exitstatus: optional status collection - * - * Wait for the command previously started with virCommandRunAsync() - * to complete. Return -1 on any error waiting for - * completion. Returns 0 if the command - * finished with the exit status set. If @exitstatus is NULL, then the - * child must exit with status 0 for this to succeed. - */ -int -virCommandWait(virCommandPtr cmd, int *exitstatus) -{ - int ret; - int status = 0; - - if (!cmd ||cmd->has_error == ENOMEM) { - virReportOOMError(); - return -1; - } - if (cmd->has_error) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("invalid use of command API")); - return -1; - } - - if (cmd->pid == -1) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("command is not yet running")); - return -1; - } - - /* If virProcessWait reaps pid but then returns failure because - * exitstatus was NULL, then a second virCommandWait would risk - * calling waitpid on an unrelated process. Besides, that error - * message is not as detailed as what we can provide. So, we - * guarantee that virProcessWait only fails due to failure to wait, - * and repeat the exitstatus check code ourselves. */ - ret = virProcessWait(cmd->pid, exitstatus ? exitstatus : &status); - if (ret == 0) { - cmd->pid = -1; - cmd->reap = false; - if (status) { - char *str = virCommandToString(cmd); - char *st = virProcessTranslateStatus(status); - bool haveErrMsg = cmd->errbuf && *cmd->errbuf && (*cmd->errbuf)[0]; - - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Child process (%s) unexpected %s%s%s"), - str ? str : cmd->args[0], NULLSTR(st), - haveErrMsg ? ": " : "", - haveErrMsg ? *cmd->errbuf : ""); - VIR_FREE(str); - VIR_FREE(st); - return -1; - } - } - - return ret; -} - - -#ifndef WIN32 -/** - * virCommandAbort: - * @cmd: command to abort - * - * Abort an async command if it is running, without issuing - * any errors or affecting errno. Designed for error paths - * where some but not all paths to the cleanup code might - * have started the child process. - */ -void -virCommandAbort(virCommandPtr cmd) -{ - if (!cmd || cmd->pid == -1) - return; - virProcessAbort(cmd->pid); - cmd->pid = -1; - cmd->reap = false; -} -#else /* WIN32 */ -void -virCommandAbort(virCommandPtr cmd ATTRIBUTE_UNUSED) -{ - /* Mingw lacks WNOHANG and kill(). But since we haven't ported - * virExecWithHook to mingw yet, there's no process to be killed, - * making this implementation trivially correct for now :) */ -} -#endif - - -/** - * virCommandRequireHandshake: - * @cmd: command to modify - * - * Request that the child perform a handshake with - * the parent when the hook function has completed - * execution. The child will not exec() until the - * parent has notified - */ -void virCommandRequireHandshake(virCommandPtr cmd) -{ - if (!cmd || cmd->has_error) - return; - - if (cmd->handshake) { - cmd->has_error = -1; - VIR_DEBUG("Cannot require handshake twice"); - return; - } - - if (pipe2(cmd->handshakeWait, O_CLOEXEC) < 0) { - cmd->has_error = errno; - return; - } - if (pipe2(cmd->handshakeNotify, O_CLOEXEC) < 0) { - VIR_FORCE_CLOSE(cmd->handshakeWait[0]); - VIR_FORCE_CLOSE(cmd->handshakeWait[1]); - cmd->has_error = errno; - return; - } - - VIR_DEBUG("Transfer handshake wait=%d notify=%d, " - "keep handshake wait=%d notify=%d", - cmd->handshakeWait[1], cmd->handshakeNotify[0], - cmd->handshakeWait[0], cmd->handshakeNotify[1]); - virCommandTransferFD(cmd, cmd->handshakeWait[1]); - virCommandTransferFD(cmd, cmd->handshakeNotify[0]); - cmd->handshake = true; -} - -/** - * virCommandHandshakeWait: - * @cmd: command to wait on - * - * Wait for the child to complete execution of its - * hook function. To be called in the parent. - */ -int virCommandHandshakeWait(virCommandPtr cmd) -{ - char c; - int rv; - if (!cmd ||cmd->has_error == ENOMEM) { - virReportOOMError(); - return -1; - } - if (cmd->has_error || !cmd->handshake) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("invalid use of command API")); - return -1; - } - - if (cmd->handshakeWait[0] == -1) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("Handshake is already complete")); - return -1; - } - - VIR_DEBUG("Wait for handshake on %d", cmd->handshakeWait[0]); - if ((rv = saferead(cmd->handshakeWait[0], &c, sizeof(c))) != sizeof(c)) { - if (rv < 0) - virReportSystemError(errno, "%s", - _("Unable to wait for child process")); - else - virReportSystemError(EIO, "%s", - _("Child quit during startup handshake")); - VIR_FORCE_CLOSE(cmd->handshakeWait[0]); - return -1; - } - if (c != '1') { - char *msg; - ssize_t len; - if (VIR_ALLOC_N(msg, 1024) < 0) { - virReportOOMError(); - VIR_FORCE_CLOSE(cmd->handshakeWait[0]); - return -1; - } - /* Close the handshakeNotify fd before trying to read anything - * further on the handshakeWait pipe; so that a child waiting - * on our acknowledgment will die rather than deadlock. */ - VIR_FORCE_CLOSE(cmd->handshakeNotify[1]); - - if ((len = saferead(cmd->handshakeWait[0], msg, 1024)) < 0) { - VIR_FORCE_CLOSE(cmd->handshakeWait[0]); - VIR_FREE(msg); - virReportSystemError(errno, "%s", - _("No error message from child failure")); - return -1; - } - VIR_FORCE_CLOSE(cmd->handshakeWait[0]); - msg[len-1] = '\0'; - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", msg); - VIR_FREE(msg); - return -1; - } - VIR_FORCE_CLOSE(cmd->handshakeWait[0]); - return 0; -} - -/** - * virCommandHandshakeNotify: - * @cmd: command to resume - * - * Notify the child that it is OK to exec() the - * real binary now. To be called in the parent. - */ -int virCommandHandshakeNotify(virCommandPtr cmd) -{ - char c = '1'; - if (!cmd ||cmd->has_error == ENOMEM) { - virReportOOMError(); - return -1; - } - if (cmd->has_error || !cmd->handshake) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("invalid use of command API")); - return -1; - } - - if (cmd->handshakeNotify[1] == -1) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("Handshake is already complete")); - return -1; - } - - VIR_DEBUG("Notify handshake on %d", cmd->handshakeNotify[1]); - if (safewrite(cmd->handshakeNotify[1], &c, sizeof(c)) != sizeof(c)) { - virReportSystemError(errno, "%s", _("Unable to notify child process")); - VIR_FORCE_CLOSE(cmd->handshakeNotify[1]); - return -1; - } - VIR_FORCE_CLOSE(cmd->handshakeNotify[1]); - return 0; -} - - -/** - * virCommandFree: - * @cmd: optional command to free - * - * Release all resources. The only exception is that if you called - * virCommandRunAsync with a non-null pid, then the asynchronous child - * is not reaped, and you must call virProcessWait() or virProcessAbort() yourself. - */ -void -virCommandFree(virCommandPtr cmd) -{ - int i; - if (!cmd) - return; - - for (i = 0; i < cmd->transfer_size; i++) { - VIR_FORCE_CLOSE(cmd->transfer[i]); - } - - VIR_FREE(cmd->inbuf); - VIR_FORCE_CLOSE(cmd->outfd); - VIR_FORCE_CLOSE(cmd->errfd); - - for (i = 0 ; i < cmd->nargs ; i++) - VIR_FREE(cmd->args[i]); - VIR_FREE(cmd->args); - - for (i = 0 ; i < cmd->nenv ; i++) - VIR_FREE(cmd->env[i]); - VIR_FREE(cmd->env); - - VIR_FREE(cmd->pwd); - - if (cmd->handshake) { - /* The other 2 fds in these arrays are closed - * due to use with virCommandTransferFD - */ - VIR_FORCE_CLOSE(cmd->handshakeWait[0]); - VIR_FORCE_CLOSE(cmd->handshakeNotify[1]); - } - - VIR_FREE(cmd->pidfile); - - if (cmd->reap) - virCommandAbort(cmd); - - VIR_FREE(cmd->transfer); - VIR_FREE(cmd->preserve); - - VIR_FREE(cmd); -} diff --git a/src/util/command.h b/src/util/command.h deleted file mode 100644 index 6c8ab49..0000000 --- a/src/util/command.h +++ /dev/null @@ -1,166 +0,0 @@ -/* - * command.h: Child command execution - * - * Copyright (C) 2010-2011 Red Hat, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - */ - -#ifndef __VIR_COMMAND_H__ -# define __VIR_COMMAND_H__ - -# include "internal.h" -# include "util.h" -# include "virbuffer.h" - -typedef struct _virCommand virCommand; -typedef virCommand *virCommandPtr; - -/* This will execute in the context of the first child - * after fork() but before execve(). As such, it is unsafe to - * call any function that is not async-signal-safe. */ -typedef int (*virExecHook)(void *data); - -int virFork(pid_t *pid) ATTRIBUTE_RETURN_CHECK; - -int virRun(const char *const*argv, int *status) ATTRIBUTE_RETURN_CHECK; - -virCommandPtr virCommandNew(const char *binary) ATTRIBUTE_NONNULL(1); - -virCommandPtr virCommandNewArgs(const char *const*args) ATTRIBUTE_NONNULL(1); - -virCommandPtr virCommandNewArgList(const char *binary, ...) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_SENTINEL; - -virCommandPtr virCommandNewVAList(const char *binary, va_list list) - ATTRIBUTE_NONNULL(1); - -/* All error report from these setup APIs is - * delayed until the Run/RunAsync methods - */ - -void virCommandPreserveFD(virCommandPtr cmd, - int fd); - -void virCommandTransferFD(virCommandPtr cmd, - int fd); - -void virCommandSetPidFile(virCommandPtr cmd, - const char *pidfile) ATTRIBUTE_NONNULL(2); - -void virCommandClearCaps(virCommandPtr cmd); - -void virCommandAllowCap(virCommandPtr cmd, - int capability); - -void virCommandDaemonize(virCommandPtr cmd); - -void virCommandNonblockingFDs(virCommandPtr cmd); - -void virCommandAddEnvFormat(virCommandPtr cmd, const char *format, ...) - ATTRIBUTE_NONNULL(2) ATTRIBUTE_FMT_PRINTF(2, 3); - -void virCommandAddEnvPair(virCommandPtr cmd, - const char *name, - const char *value) ATTRIBUTE_NONNULL(2); - -void virCommandAddEnvString(virCommandPtr cmd, - const char *str) ATTRIBUTE_NONNULL(2); - -void virCommandAddEnvBuffer(virCommandPtr cmd, - virBufferPtr buf); - -void virCommandAddEnvPass(virCommandPtr cmd, - const char *name) ATTRIBUTE_NONNULL(2); - -void virCommandAddEnvPassCommon(virCommandPtr cmd); - -void virCommandAddArg(virCommandPtr cmd, - const char *val) ATTRIBUTE_NONNULL(2); - -void virCommandAddArgBuffer(virCommandPtr cmd, - virBufferPtr buf); - -void virCommandAddArgFormat(virCommandPtr cmd, - const char *format, ...) - ATTRIBUTE_NONNULL(2) ATTRIBUTE_FMT_PRINTF(2, 3); - -void virCommandAddArgPair(virCommandPtr cmd, - const char *name, - const char *val) - ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3); - -void virCommandAddArgSet(virCommandPtr cmd, - const char *const*vals) ATTRIBUTE_NONNULL(2); - -void virCommandAddArgList(virCommandPtr cmd, - ... /* const char *arg, ..., NULL */) - ATTRIBUTE_SENTINEL; - -void virCommandSetWorkingDirectory(virCommandPtr cmd, - const char *pwd) ATTRIBUTE_NONNULL(2); - -void virCommandSetInputBuffer(virCommandPtr cmd, - const char *inbuf) ATTRIBUTE_NONNULL(2); - -void virCommandSetOutputBuffer(virCommandPtr cmd, - char **outbuf) ATTRIBUTE_NONNULL(2); - -void virCommandSetErrorBuffer(virCommandPtr cmd, - char **errbuf) ATTRIBUTE_NONNULL(2); - -void virCommandSetInputFD(virCommandPtr cmd, - int infd); - -void virCommandSetOutputFD(virCommandPtr cmd, - int *outfd) ATTRIBUTE_NONNULL(2); - -void virCommandSetErrorFD(virCommandPtr cmd, - int *errfd) ATTRIBUTE_NONNULL(2); - -void virCommandSetPreExecHook(virCommandPtr cmd, - virExecHook hook, - void *opaque) ATTRIBUTE_NONNULL(2); - -void virCommandWriteArgLog(virCommandPtr cmd, - int logfd); - -char *virCommandToString(virCommandPtr cmd) ATTRIBUTE_RETURN_CHECK; - -int virCommandExec(virCommandPtr cmd) ATTRIBUTE_RETURN_CHECK; - -int virCommandRun(virCommandPtr cmd, - int *exitstatus) ATTRIBUTE_RETURN_CHECK; - -int virCommandRunAsync(virCommandPtr cmd, - pid_t *pid) ATTRIBUTE_RETURN_CHECK; - -int virCommandWait(virCommandPtr cmd, - int *exitstatus) ATTRIBUTE_RETURN_CHECK; - -void virCommandRequireHandshake(virCommandPtr cmd); - -int virCommandHandshakeWait(virCommandPtr cmd) - ATTRIBUTE_RETURN_CHECK; - -int virCommandHandshakeNotify(virCommandPtr cmd) - ATTRIBUTE_RETURN_CHECK; - -void virCommandAbort(virCommandPtr cmd); - -void virCommandFree(virCommandPtr cmd); - -#endif /* __VIR_COMMAND_H__ */ diff --git a/src/util/dnsmasq.c b/src/util/dnsmasq.c index 74593c8..6e9c9dd 100644 --- a/src/util/dnsmasq.c +++ b/src/util/dnsmasq.c @@ -42,7 +42,7 @@ #include "virbitmap.h" #include "dnsmasq.h" #include "util.h" -#include "command.h" +#include "vircommand.h" #include "memory.h" #include "virterror_internal.h" #include "logging.h" diff --git a/src/util/ebtables.c b/src/util/ebtables.c index f1b2986..4b427ee 100644 --- a/src/util/ebtables.c +++ b/src/util/ebtables.c @@ -41,7 +41,7 @@ #include "internal.h" #include "ebtables.h" -#include "command.h" +#include "vircommand.h" #include "memory.h" #include "virterror_internal.h" #include "logging.h" diff --git a/src/util/hooks.c b/src/util/hooks.c index 8817a4e..a6c056d 100644 --- a/src/util/hooks.c +++ b/src/util/hooks.c @@ -37,7 +37,7 @@ #include "memory.h" #include "virfile.h" #include "configmake.h" -#include "command.h" +#include "vircommand.h" #define VIR_FROM_THIS VIR_FROM_HOOK diff --git a/src/util/iptables.c b/src/util/iptables.c index 00a1c29..25253ff 100644 --- a/src/util/iptables.c +++ b/src/util/iptables.c @@ -39,7 +39,7 @@ #include "internal.h" #include "iptables.h" -#include "command.h" +#include "vircommand.h" #include "memory.h" #include "virterror_internal.h" #include "logging.h" diff --git a/src/util/pci.c b/src/util/pci.c index 5971764..bf46fca 100644 --- a/src/util/pci.c +++ b/src/util/pci.c @@ -36,7 +36,7 @@ #include "logging.h" #include "memory.h" -#include "command.h" +#include "vircommand.h" #include "virterror_internal.h" #include "virfile.h" diff --git a/src/util/storage_file.c b/src/util/storage_file.c index 3f85e0e..eebf59a 100644 --- a/src/util/storage_file.c +++ b/src/util/storage_file.c @@ -24,7 +24,6 @@ #include <config.h> #include "storage_file.h" -#include <command.h> #include <sys/stat.h> #include <unistd.h> #include <fcntl.h> @@ -41,6 +40,7 @@ #include "logging.h" #include "virfile.h" #include "c-ctype.h" +#include "vircommand.h" #include "virhash.h" #define VIR_FROM_THIS VIR_FROM_STORAGE diff --git a/src/util/sysinfo.c b/src/util/sysinfo.c index bac4b23..e21cbfd 100644 --- a/src/util/sysinfo.c +++ b/src/util/sysinfo.c @@ -35,7 +35,7 @@ #include "util.h" #include "logging.h" #include "memory.h" -#include "command.h" +#include "vircommand.h" #define VIR_FROM_THIS VIR_FROM_SYSINFO diff --git a/src/util/util.c b/src/util/util.c index 422ee75..f8ba7b4 100644 --- a/src/util/util.c +++ b/src/util/util.c @@ -84,7 +84,7 @@ #include "threads.h" #include "verify.h" #include "virfile.h" -#include "command.h" +#include "vircommand.h" #include "nonblocking.h" #include "passfd.h" #include "virprocess.h" diff --git a/src/util/vircommand.c b/src/util/vircommand.c new file mode 100644 index 0000000..3046658 --- /dev/null +++ b/src/util/vircommand.c @@ -0,0 +1,2523 @@ +/* + * vircommand.c: Child command execution + * + * Copyright (C) 2010-2012 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + */ + +#include <config.h> + +#include <poll.h> +#include <signal.h> +#include <stdarg.h> +#include <stdlib.h> +#include <sys/stat.h> +#include <sys/wait.h> +#include <fcntl.h> + +#if HAVE_CAPNG +# include <cap-ng.h> +#endif + +#include "vircommand.h" +#include "memory.h" +#include "virterror_internal.h" +#include "util.h" +#include "logging.h" +#include "virfile.h" +#include "virpidfile.h" +#include "virprocess.h" +#include "virbuffer.h" + +#define VIR_FROM_THIS VIR_FROM_NONE + +/* Flags for virExecWithHook */ +enum { + VIR_EXEC_NONE = 0, + VIR_EXEC_NONBLOCK = (1 << 0), + VIR_EXEC_DAEMON = (1 << 1), + VIR_EXEC_CLEAR_CAPS = (1 << 2), + VIR_EXEC_RUN_SYNC = (1 << 3), +}; + +struct _virCommand { + int has_error; /* ENOMEM on allocation failure, -1 for anything else. */ + + char **args; + size_t nargs; + size_t maxargs; + + char **env; + size_t nenv; + size_t maxenv; + + char *pwd; + + int *preserve; /* FDs to pass to child. */ + int preserve_size; + int *transfer; /* FDs to close in parent. */ + int transfer_size; + + unsigned int flags; + + char *inbuf; + char **outbuf; + char **errbuf; + + int infd; + int outfd; + int errfd; + int *outfdptr; + int *errfdptr; + + bool handshake; + int handshakeWait[2]; + int handshakeNotify[2]; + + virExecHook hook; + void *opaque; + + pid_t pid; + char *pidfile; + bool reap; + + unsigned long long capabilities; +}; + +/* + * virCommandFDIsSet: + * @fd: FD to test + * @set: the set + * @set_size: actual size of @set + * + * Check if FD is already in @set or not. + * + * Returns true if @set contains @fd, + * false otherwise. + */ +static bool +virCommandFDIsSet(int fd, + const int *set, + int set_size) +{ + int i = 0; + + while (i < set_size) + if (set[i++] == fd) + return true; + + return false; +} + +/* + * virCommandFDSet: + * @fd: FD to be put into @set + * @set: the set + * @set_size: actual size of @set + * + * This is practically generalized implementation + * of FD_SET() as we do not want to be limited + * by FD_SETSIZE. + * + * Returns: 0 on success, + * -1 on usage error, + * ENOMEM on OOM + */ +static int +virCommandFDSet(int fd, + int **set, + int *set_size) +{ + if (fd < 0 || !set || !set_size) + return -1; + + if (virCommandFDIsSet(fd, *set, *set_size)) + return 0; + + if (VIR_REALLOC_N(*set, *set_size + 1) < 0) { + return ENOMEM; + } + + (*set)[*set_size] = fd; + (*set_size)++; + + return 0; +} + +#ifndef WIN32 + +static int virClearCapabilities(void) ATTRIBUTE_UNUSED; + +# if HAVE_CAPNG +static int virClearCapabilities(void) +{ + int ret; + + capng_clear(CAPNG_SELECT_BOTH); + + if ((ret = capng_apply(CAPNG_SELECT_BOTH)) < 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("cannot clear process capabilities %d"), ret); + return -1; + } + + return 0; +} + +/** + * virSetCapabilities: + * @capabilities - capability flag to set. + * In case of 0, this function is identical to + * virClearCapabilities() + * + */ +static int virSetCapabilities(unsigned long long capabilities) +{ + int ret, i; + + capng_clear(CAPNG_SELECT_BOTH); + + for (i = 0; i <= CAP_LAST_CAP; i++) { + if (capabilities & (1ULL << i)) + capng_update(CAPNG_ADD, CAPNG_BOUNDING_SET, i); + } + + if ((ret = capng_apply(CAPNG_SELECT_BOTH)) < 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("cannot apply process capabilities %d"), ret); + return -1; + } + + return 0; +} +# else +static int virClearCapabilities(void) +{ +// VIR_WARN("libcap-ng support not compiled in, unable to clear " +// "capabilities"); + return 0; +} + +static int +virSetCapabilities(unsigned long long capabilities ATTRIBUTE_UNUSED) +{ + return 0; +} +# endif + +/** + * virFork: + * @pid - a pointer to a pid_t that will receive the return value from + * fork() + * + * fork a new process while avoiding various race/deadlock conditions + * + * on return from virFork(), if *pid < 0, the fork failed and there is + * no new process. Otherwise, just like fork(), if *pid == 0, it is the + * child process returning, and if *pid > 0, it is the parent. + * + * Even if *pid >= 0, if the return value from virFork() is < 0, it + * indicates a failure that occurred in the parent or child process + * after the fork. In this case, the child process should call + * _exit(EXIT_FAILURE) after doing any additional error reporting. + */ +int +virFork(pid_t *pid) +{ + sigset_t oldmask, newmask; + struct sigaction sig_action; + int saved_errno, ret = -1; + + *pid = -1; + + /* + * Need to block signals now, so that child process can safely + * kill off caller's signal handlers without a race. + */ + sigfillset(&newmask); + if (pthread_sigmask(SIG_SETMASK, &newmask, &oldmask) != 0) { + saved_errno = errno; + virReportSystemError(errno, + "%s", _("cannot block signals")); + goto cleanup; + } + + /* Ensure we hold the logging lock, to protect child processes + * from deadlocking on another thread's inherited mutex state */ + virLogLock(); + + *pid = fork(); + saved_errno = errno; /* save for caller */ + + /* Unlock for both parent and child process */ + virLogUnlock(); + + if (*pid < 0) { + /* attempt to restore signal mask, but ignore failure, to + avoid obscuring the fork failure */ + ignore_value(pthread_sigmask(SIG_SETMASK, &oldmask, NULL)); + virReportSystemError(saved_errno, + "%s", _("cannot fork child process")); + goto cleanup; + } + + if (*pid) { + + /* parent process */ + + /* Restore our original signal mask now that the child is + safely running */ + if (pthread_sigmask(SIG_SETMASK, &oldmask, NULL) != 0) { + saved_errno = errno; /* save for caller */ + virReportSystemError(errno, "%s", _("cannot unblock signals")); + goto cleanup; + } + ret = 0; + + } else { + + /* child process */ + + int logprio; + int i; + + /* Remove any error callback so errors in child now + get sent to stderr where they stand a fighting chance + of being seen / logged */ + virSetErrorFunc(NULL, NULL); + virSetErrorLogPriorityFunc(NULL); + + /* Make sure any hook logging is sent to stderr, since child + * process may close the logfile FDs */ + logprio = virLogGetDefaultPriority(); + virLogReset(); + virLogSetDefaultPriority(logprio); + + /* Clear out all signal handlers from parent so nothing + unexpected can happen in our child once we unblock + signals */ + sig_action.sa_handler = SIG_DFL; + sig_action.sa_flags = 0; + sigemptyset(&sig_action.sa_mask); + + for (i = 1; i < NSIG; i++) { + /* Only possible errors are EFAULT or EINVAL + The former wont happen, the latter we + expect, so no need to check return value */ + + sigaction(i, &sig_action, NULL); + } + + /* Unmask all signals in child, since we've no idea + what the caller's done with their signal mask + and don't want to propagate that to children */ + sigemptyset(&newmask); + if (pthread_sigmask(SIG_SETMASK, &newmask, NULL) != 0) { + saved_errno = errno; /* save for caller */ + virReportSystemError(errno, "%s", _("cannot unblock signals")); + goto cleanup; + } + ret = 0; + } + +cleanup: + if (ret < 0) + errno = saved_errno; + return ret; +} + +/* + * Ensure that *null is an fd visiting /dev/null. Return 0 on + * success, -1 on failure. Allows for lazy opening of shared + * /dev/null fd only as required. + */ +static int +getDevNull(int *null) +{ + if (*null == -1 && (*null = open("/dev/null", O_RDWR|O_CLOEXEC)) < 0) { + virReportSystemError(errno, + _("cannot open %s"), + "/dev/null"); + return -1; + } + return 0; +} + +/* Ensure that STD is an inheritable copy of FD. Return 0 on success, + * -1 on failure. */ +static int +prepareStdFd(int fd, int std) +{ + if (fd == std) + return virSetInherit(fd, true); + if (dup2(fd, std) != std) + return -1; + return 0; +} + +/* + * @argv argv to exec + * @envp optional environment to use for exec + * @keepfd options fd_ret to keep open for child process + * @retpid optional pointer to store child process pid + * @infd optional file descriptor to use as child input, otherwise /dev/null + * @outfd optional pointer to communicate output fd behavior + * outfd == NULL : Use /dev/null + * *outfd == -1 : Use a new fd + * *outfd != -1 : Use *outfd + * @errfd optional pointer to communcate error fd behavior. See outfd + * @flags possible combination of the following: + * VIR_EXEC_NONE : Default function behavior + * VIR_EXEC_NONBLOCK : Set child process output fd's as non-blocking + * VIR_EXEC_DAEMON : Daemonize the child process + * @hook optional virExecHook function to call prior to exec + * @data data to pass to the hook function + * @pidfile path to use as pidfile for daemonized process (needs DAEMON flag) + * @capabilities capabilities to keep + */ +static int +virExecWithHook(const char *const*argv, + const char *const*envp, + const int *keepfd, + int keepfd_size, + pid_t *retpid, + int infd, int *outfd, int *errfd, + unsigned int flags, + virExecHook hook, + void *data, + char *pidfile, + unsigned long long capabilities) +{ + pid_t pid; + int null = -1, i, openmax; + int pipeout[2] = {-1,-1}; + int pipeerr[2] = {-1,-1}; + int childout = -1; + int childerr = -1; + int tmpfd; + const char *binary = NULL; + int forkRet; + + if (argv[0][0] != '/') { + if (!(binary = virFindFileInPath(argv[0]))) { + virReportSystemError(ENOENT, + _("Cannot find '%s' in path"), + argv[0]); + return -1; + } + } else { + binary = argv[0]; + } + + if (infd < 0) { + if (getDevNull(&null) < 0) + goto cleanup; + infd = null; + } + + if (outfd != NULL) { + if (*outfd == -1) { + if (pipe2(pipeout, O_CLOEXEC) < 0) { + virReportSystemError(errno, + "%s", _("cannot create pipe")); + goto cleanup; + } + + if ((flags & VIR_EXEC_NONBLOCK) && + virSetNonBlock(pipeout[0]) == -1) { + virReportSystemError(errno, + "%s", _("Failed to set non-blocking file descriptor flag")); + goto cleanup; + } + + childout = pipeout[1]; + } else { + childout = *outfd; + } + } else { + if (getDevNull(&null) < 0) + goto cleanup; + childout = null; + } + + if (errfd != NULL) { + if (errfd == outfd) { + childerr = childout; + } else if (*errfd == -1) { + if (pipe2(pipeerr, O_CLOEXEC) < 0) { + virReportSystemError(errno, + "%s", _("Failed to create pipe")); + goto cleanup; + } + + if ((flags & VIR_EXEC_NONBLOCK) && + virSetNonBlock(pipeerr[0]) == -1) { + virReportSystemError(errno, + "%s", _("Failed to set non-blocking file descriptor flag")); + goto cleanup; + } + + childerr = pipeerr[1]; + } else { + childerr = *errfd; + } + } else { + if (getDevNull(&null) < 0) + goto cleanup; + childerr = null; + } + + forkRet = virFork(&pid); + + if (pid < 0) { + goto cleanup; + } + + if (pid) { /* parent */ + if (forkRet < 0) { + goto cleanup; + } + + VIR_FORCE_CLOSE(null); + if (outfd && *outfd == -1) { + VIR_FORCE_CLOSE(pipeout[1]); + *outfd = pipeout[0]; + } + if (errfd && *errfd == -1) { + VIR_FORCE_CLOSE(pipeerr[1]); + *errfd = pipeerr[0]; + } + + *retpid = pid; + + if (binary != argv[0]) + VIR_FREE(binary); + + return 0; + } + + /* child */ + + if (forkRet < 0) { + /* The fork was successful, but after that there was an error + * in the child (which was already logged). + */ + goto fork_error; + } + + openmax = sysconf(_SC_OPEN_MAX); + for (i = 3; i < openmax; i++) { + if (i == infd || i == childout || i == childerr) + continue; + if (!keepfd || !virCommandFDIsSet(i, keepfd, keepfd_size)) { + tmpfd = i; + VIR_MASS_CLOSE(tmpfd); + } else if (virSetInherit(i, true) < 0) { + virReportSystemError(errno, _("failed to preserve fd %d"), i); + goto fork_error; + } + } + + if (prepareStdFd(infd, STDIN_FILENO) < 0) { + virReportSystemError(errno, + "%s", _("failed to setup stdin file handle")); + goto fork_error; + } + if (childout > 0 && prepareStdFd(childout, STDOUT_FILENO) < 0) { + virReportSystemError(errno, + "%s", _("failed to setup stdout file handle")); + goto fork_error; + } + if (childerr > 0 && prepareStdFd(childerr, STDERR_FILENO) < 0) { + virReportSystemError(errno, + "%s", _("failed to setup stderr file handle")); + goto fork_error; + } + + if (infd != STDIN_FILENO && infd != null && infd != childerr && + infd != childout) + VIR_FORCE_CLOSE(infd); + if (childout > STDERR_FILENO && childout != null && childout != childerr) + VIR_FORCE_CLOSE(childout); + if (childerr > STDERR_FILENO && childerr != null) + VIR_FORCE_CLOSE(childerr); + VIR_FORCE_CLOSE(null); + + /* Initialize full logging for a while */ + virLogSetFromEnv(); + + /* Daemonize as late as possible, so the parent process can detect + * the above errors with wait* */ + if (flags & VIR_EXEC_DAEMON) { + if (setsid() < 0) { + virReportSystemError(errno, + "%s", _("cannot become session leader")); + goto fork_error; + } + + if (chdir("/") < 0) { + virReportSystemError(errno, + "%s", _("cannot change to root directory")); + goto fork_error; + } + + pid = fork(); + if (pid < 0) { + virReportSystemError(errno, + "%s", _("cannot fork child process")); + goto fork_error; + } + + if (pid > 0) { + if (pidfile && (virPidFileWritePath(pidfile,pid) < 0)) { + kill(pid, SIGTERM); + usleep(500*1000); + kill(pid, SIGTERM); + virReportSystemError(errno, + _("could not write pidfile %s for %d"), + pidfile, pid); + goto fork_error; + } + _exit(0); + } + } + + if (hook) { + /* virFork reset all signal handlers to the defaults. + * This is good for the child process, but our hook + * risks running something that generates SIGPIPE, + * so we need to temporarily block that again + */ + struct sigaction waxon, waxoff; + memset(&waxoff, 0, sizeof(waxoff)); + waxoff.sa_handler = SIG_IGN; + sigemptyset(&waxoff.sa_mask); + memset(&waxon, 0, sizeof(waxon)); + if (sigaction(SIGPIPE, &waxoff, &waxon) < 0) { + virReportSystemError(errno, "%s", + _("Could not disable SIGPIPE")); + goto fork_error; + } + + if ((hook)(data) != 0) { + VIR_DEBUG("Hook function failed."); + goto fork_error; + } + + if (sigaction(SIGPIPE, &waxon, NULL) < 0) { + virReportSystemError(errno, "%s", + _("Could not re-enable SIGPIPE")); + goto fork_error; + } + } + + /* The steps above may need todo something privileged, so + * we delay clearing capabilities until the last minute */ + if (capabilities || (flags & VIR_EXEC_CLEAR_CAPS)) + if (virSetCapabilities(capabilities) < 0) + goto fork_error; + + /* Close logging again to ensure no FDs leak to child */ + virLogReset(); + + if (envp) + execve(binary, (char **) argv, (char**)envp); + else + execv(binary, (char **) argv); + + virReportSystemError(errno, + _("cannot execute binary %s"), + argv[0]); + + fork_error: + virDispatchError(NULL); + _exit(EXIT_FAILURE); + + cleanup: + /* This is cleanup of parent process only - child + should never jump here on error */ + + if (binary != argv[0]) + VIR_FREE(binary); + + /* NB we don't virReportError() on any failures here + because the code which jumped here already raised + an error condition which we must not overwrite */ + VIR_FORCE_CLOSE(pipeerr[0]); + VIR_FORCE_CLOSE(pipeerr[1]); + VIR_FORCE_CLOSE(pipeout[0]); + VIR_FORCE_CLOSE(pipeout[1]); + VIR_FORCE_CLOSE(null); + return -1; +} + +/** + * virRun: + * @argv NULL terminated argv to run + * @status optional variable to return exit status in + * + * Run a command without using the shell. + * + * If status is NULL, then return 0 if the command run and + * exited with 0 status; Otherwise return -1 + * + * If status is not-NULL, then return 0 if the command ran. + * The status variable is filled with the command exit status + * and should be checked by caller for success. Return -1 + * only if the command could not be run. + */ +int +virRun(const char *const*argv, int *status) +{ + int ret; + virCommandPtr cmd = virCommandNewArgs(argv); + + ret = virCommandRun(cmd, status); + virCommandFree(cmd); + return ret; +} + +#else /* WIN32 */ + +int +virRun(const char *const *argv ATTRIBUTE_UNUSED, + int *status) +{ + if (status) + *status = ENOTSUP; + else + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virRun is not implemented for WIN32")); + return -1; +} + +static int +virExecWithHook(const char *const*argv ATTRIBUTE_UNUSED, + const char *const*envp ATTRIBUTE_UNUSED, + const int *keepfd ATTRIBUTE_UNUSED, + int keepfd_size ATTRIBUTE_UNUSED, + pid_t *retpid ATTRIBUTE_UNUSED, + int infd ATTRIBUTE_UNUSED, + int *outfd ATTRIBUTE_UNUSED, + int *errfd ATTRIBUTE_UNUSED, + int flags_unused ATTRIBUTE_UNUSED, + virExecHook hook ATTRIBUTE_UNUSED, + void *data ATTRIBUTE_UNUSED, + char *pidfile ATTRIBUTE_UNUSED, + unsigned long long capabilities ATTRIBUTE_UNUSED) +{ + /* XXX: Some day we can implement pieces of virCommand/virExec on + * top of _spawn() or CreateProcess(), but we can't implement + * everything, since mingw completely lacks fork(), so we cannot + * run hook code in the child. */ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virExec is not implemented for WIN32")); + return -1; +} + +int +virFork(pid_t *pid) +{ + *pid = -1; + errno = ENOTSUP; + + return -1; +} + +#endif /* WIN32 */ + + +/** + * virCommandNew: + * @binary: program to run + * + * Create a new command for named binary. If @binary is relative, + * it will be found via a PATH search of the parent's PATH (and not + * any altered PATH set by virCommandAddEnv* commands). + */ +virCommandPtr +virCommandNew(const char *binary) +{ + const char *const args[] = { binary, NULL }; + + return virCommandNewArgs(args); +} + +/** + * virCommandNewArgs: + * @args: array of arguments + * + * Create a new command with a NULL terminated + * set of args, taking binary from args[0]. More arguments can + * be added later. @args[0] is handled like @binary of virCommandNew. + */ +virCommandPtr +virCommandNewArgs(const char *const*args) +{ + virCommandPtr cmd; + + if (VIR_ALLOC(cmd) < 0) + return NULL; + + cmd->handshakeWait[0] = -1; + cmd->handshakeWait[1] = -1; + cmd->handshakeNotify[0] = -1; + cmd->handshakeNotify[1] = -1; + + cmd->infd = cmd->outfd = cmd->errfd = -1; + cmd->pid = -1; + + virCommandAddArgSet(cmd, args); + + return cmd; +} + +/** + * virCommandNewArgList: + * @binary: program to run + * @...: additional arguments + * + * Create a new command with a NULL terminated + * list of args, starting with the binary to run. More arguments can + * be added later. @binary is handled as in virCommandNew. + */ +virCommandPtr +virCommandNewArgList(const char *binary, ...) +{ + virCommandPtr cmd = virCommandNew(binary); + va_list list; + const char *arg; + + if (!cmd || cmd->has_error) + return cmd; + + va_start(list, binary); + while ((arg = va_arg(list, const char *)) != NULL) + virCommandAddArg(cmd, arg); + va_end(list); + return cmd; +} + +/** + * virCommandNewVAList: + * @binary: program to run + * @va_list: additional arguments + * + * Create a new command with a NULL terminated + * variable argument list. @binary is handled as in virCommandNew. + */ +virCommandPtr +virCommandNewVAList(const char *binary, va_list list) +{ + virCommandPtr cmd = virCommandNew(binary); + const char *arg; + + if (!cmd || cmd->has_error) + return cmd; + + while ((arg = va_arg(list, const char *)) != NULL) + virCommandAddArg(cmd, arg); + return cmd; +} + + +/* + * Preserve the specified file descriptor in the child, instead of + * closing it. FD must not be one of the three standard streams. If + * transfer is true, then fd will be closed in the parent after a call + * to Run/RunAsync/Free, otherwise caller is still responsible for fd. + * Returns true if a transferring caller should close FD now, and + * false if the transfer is successfully recorded. + */ +static bool +virCommandKeepFD(virCommandPtr cmd, int fd, bool transfer) +{ + int ret = 0; + + if (!cmd) + return fd > STDERR_FILENO; + + if (fd <= STDERR_FILENO || + (ret = virCommandFDSet(fd, &cmd->preserve, &cmd->preserve_size)) || + (transfer && (ret = virCommandFDSet(fd, &cmd->transfer, + &cmd->transfer_size)))) { + if (!cmd->has_error) + cmd->has_error = ret ? ret : -1 ; + VIR_DEBUG("cannot preserve %d", fd); + return fd > STDERR_FILENO; + } + + return false; +} + +/** + * virCommandPreserveFD: + * @cmd: the command to modify + * @fd: fd to mark for inheritance into child + * + * Preserve the specified file descriptor + * in the child, instead of closing it on exec. + * The parent is still responsible for managing fd. + */ +void +virCommandPreserveFD(virCommandPtr cmd, int fd) +{ + virCommandKeepFD(cmd, fd, false); +} + +/** + * virCommandTransferFD: + * @cmd: the command to modify + * @fd: fd to reassign to the child + * + * Transfer the specified file descriptor + * to the child, instead of closing it on exec. + * The parent should no longer use fd, and the parent's copy will + * be automatically closed no later than during Run/RunAsync/Free. + */ +void +virCommandTransferFD(virCommandPtr cmd, int fd) +{ + if (virCommandKeepFD(cmd, fd, true)) + VIR_FORCE_CLOSE(fd); +} + + +/** + * virCommandSetPidFile: + * @cmd: the command to modify + * @pidfile: filename to use + * + * Save the child PID in a pidfile. The pidfile will be populated + * before the exec of the child. + */ +void +virCommandSetPidFile(virCommandPtr cmd, const char *pidfile) +{ + if (!cmd || cmd->has_error) + return; + + VIR_FREE(cmd->pidfile); + if (!(cmd->pidfile = strdup(pidfile))) { + cmd->has_error = ENOMEM; + } +} + + +/** + * virCommandClearCaps: + * @cmd: the command to modify + * + * Remove all capabilities from the child, after any hooks have been run. + */ +void +virCommandClearCaps(virCommandPtr cmd) +{ + if (!cmd || cmd->has_error) + return; + + cmd->flags |= VIR_EXEC_CLEAR_CAPS; +} + +/** + * virCommandAllowCap: + * @cmd: the command to modify + * @capability: what to allow + * + * Allow specific capabilities + */ +void +virCommandAllowCap(virCommandPtr cmd, + int capability) +{ + if (!cmd || cmd->has_error) + return; + + cmd->capabilities |= (1ULL << capability); +} + + + +/** + * virCommandDaemonize: + * @cmd: the command to modify + * + * Daemonize the child process. The child will have a current working + * directory of /, and must be started with virCommandRun, which will + * complete as soon as the daemon grandchild has started. + */ +void +virCommandDaemonize(virCommandPtr cmd) +{ + if (!cmd || cmd->has_error) + return; + + cmd->flags |= VIR_EXEC_DAEMON; +} + +/** + * virCommandNonblockingFDs: + * @cmd: the command to modify + * + * Set FDs created by virCommandSetOutputFD and virCommandSetErrorFD + * as non-blocking in the parent. + */ +void +virCommandNonblockingFDs(virCommandPtr cmd) +{ + if (!cmd || cmd->has_error) + return; + + cmd->flags |= VIR_EXEC_NONBLOCK; +} + +/* Add an environment variable to the cmd->env list. 'env' is a + * string like "name=value". If the named environment variable is + * already set, then it is replaced in the list. + */ +static inline void +virCommandAddEnv(virCommandPtr cmd, char *env) +{ + size_t namelen; + size_t i; + + /* Search for the name in the existing environment. */ + namelen = strcspn(env, "="); + for (i = 0; i < cmd->nenv; ++i) { + /* + 1 because we want to match the '=' character too. */ + if (STREQLEN(cmd->env[i], env, namelen + 1)) { + VIR_FREE(cmd->env[i]); + cmd->env[i] = env; + return; + } + } + + /* Arg plus trailing NULL. */ + if (VIR_RESIZE_N(cmd->env, cmd->maxenv, cmd->nenv, 1 + 1) < 0) { + VIR_FREE(env); + cmd->has_error = ENOMEM; + return; + } + + cmd->env[cmd->nenv++] = env; +} + +/** + * virCommandAddEnvFormat: + * @cmd: the command to modify + * @format: format of arguments, end result must be in name=value format + * @...: arguments to be formatted + * + * Add an environment variable to the child created by a printf-style format. + */ +void +virCommandAddEnvFormat(virCommandPtr cmd, const char *format, ...) +{ + char *env; + va_list list; + + if (!cmd || cmd->has_error) + return; + + va_start(list, format); + if (virVasprintf(&env, format, list) < 0) { + cmd->has_error = ENOMEM; + va_end(list); + return; + } + va_end(list); + + virCommandAddEnv(cmd, env); +} + +/** + * virCommandAddEnvPair: + * @cmd: the command to modify + * @name: variable name, must not contain = + * @value: value to assign to name + * + * Add an environment variable to the child + * using separate name & value strings + */ +void +virCommandAddEnvPair(virCommandPtr cmd, const char *name, const char *value) +{ + virCommandAddEnvFormat(cmd, "%s=%s", name, value); +} + + +/** + * virCommandAddEnvString: + * @cmd: the command to modify + * @str: name=value format + * + * Add an environment variable to the child + * using a preformatted env string FOO=BAR + */ +void +virCommandAddEnvString(virCommandPtr cmd, const char *str) +{ + char *env; + + if (!cmd || cmd->has_error) + return; + + if (!(env = strdup(str))) { + cmd->has_error = ENOMEM; + return; + } + + virCommandAddEnv(cmd, env); +} + + +/** + * virCommandAddEnvBuffer: + * @cmd: the command to modify + * @buf: buffer that contains name=value string, which will be reset on return + * + * Convert a buffer containing preformatted name=value into an + * environment variable of the child. + * Correctly transfers memory errors or contents from buf to cmd. + */ +void +virCommandAddEnvBuffer(virCommandPtr cmd, virBufferPtr buf) +{ + if (!cmd || cmd->has_error) { + virBufferFreeAndReset(buf); + return; + } + + if (virBufferError(buf)) { + cmd->has_error = ENOMEM; + virBufferFreeAndReset(buf); + return; + } + if (!virBufferUse(buf)) { + cmd->has_error = EINVAL; + return; + } + + virCommandAddEnv(cmd, virBufferContentAndReset(buf)); +} + + +/** + * virCommandAddEnvPass: + * @cmd: the command to modify + * @name: the name to look up in current environment + * + * Pass an environment variable to the child + * using current process' value + */ +void +virCommandAddEnvPass(virCommandPtr cmd, const char *name) +{ + char *value; + if (!cmd || cmd->has_error) + return; + + value = getenv(name); + if (value) + virCommandAddEnvPair(cmd, name, value); +} + + +/** + * virCommandAddEnvPassCommon: + * @cmd: the command to modify + * + * Set LC_ALL to C, and propagate other essential environment + * variables (such as PATH) from the parent process. + */ +void +virCommandAddEnvPassCommon(virCommandPtr cmd) +{ + if (!cmd || cmd->has_error) + return; + + /* Attempt to Pre-allocate; allocation failure will be detected + * later during virCommandAdd*. */ + ignore_value(VIR_RESIZE_N(cmd->env, cmd->maxenv, cmd->nenv, 9)); + + virCommandAddEnvPair(cmd, "LC_ALL", "C"); + + virCommandAddEnvPass(cmd, "LD_PRELOAD"); + virCommandAddEnvPass(cmd, "LD_LIBRARY_PATH"); + virCommandAddEnvPass(cmd, "PATH"); + virCommandAddEnvPass(cmd, "HOME"); + virCommandAddEnvPass(cmd, "USER"); + virCommandAddEnvPass(cmd, "LOGNAME"); + virCommandAddEnvPass(cmd, "TMPDIR"); +} + +/** + * virCommandAddArg: + * @cmd: the command to modify + * @val: the argument to add + * + * Add a command line argument to the child + */ +void +virCommandAddArg(virCommandPtr cmd, const char *val) +{ + char *arg; + + if (!cmd || cmd->has_error) + return; + + if (!(arg = strdup(val))) { + cmd->has_error = ENOMEM; + return; + } + + /* Arg plus trailing NULL. */ + if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, 1 + 1) < 0) { + VIR_FREE(arg); + cmd->has_error = ENOMEM; + return; + } + + cmd->args[cmd->nargs++] = arg; +} + + +/** + * virCommandAddArgBuffer: + * @cmd: the command to modify + * @buf: buffer that contains argument string, which will be reset on return + * + * Convert a buffer into a command line argument to the child. + * Correctly transfers memory errors or contents from buf to cmd. + */ +void +virCommandAddArgBuffer(virCommandPtr cmd, virBufferPtr buf) +{ + if (!cmd || cmd->has_error) { + virBufferFreeAndReset(buf); + return; + } + + /* Arg plus trailing NULL. */ + if (virBufferError(buf) || + VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, 1 + 1) < 0) { + cmd->has_error = ENOMEM; + virBufferFreeAndReset(buf); + return; + } + + cmd->args[cmd->nargs] = virBufferContentAndReset(buf); + if (!cmd->args[cmd->nargs]) + cmd->args[cmd->nargs] = strdup(""); + if (!cmd->args[cmd->nargs]) { + cmd->has_error = ENOMEM; + return; + } + cmd->nargs++; +} + + +/** + * virCommandAddArgFormat: + * @cmd: the command to modify + * @format: format of arguments, end result must be in name=value format + * @...: arguments to be formatted + * + * Add a command line argument created by a printf-style format. + */ +void +virCommandAddArgFormat(virCommandPtr cmd, const char *format, ...) +{ + char *arg; + va_list list; + + if (!cmd || cmd->has_error) + return; + + va_start(list, format); + if (virVasprintf(&arg, format, list) < 0) { + cmd->has_error = ENOMEM; + va_end(list); + return; + } + va_end(list); + + /* Arg plus trailing NULL. */ + if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, 1 + 1) < 0) { + VIR_FREE(arg); + cmd->has_error = ENOMEM; + return; + } + + cmd->args[cmd->nargs++] = arg; +} + +/** + * virCommandAddArgPair: + * @cmd: the command to modify + * @name: left half of argument + * @value: right half of argument + * + * Add "NAME=VAL" as a single command line argument to the child + */ +void +virCommandAddArgPair(virCommandPtr cmd, const char *name, const char *val) +{ + virCommandAddArgFormat(cmd, "%s=%s", name, val); +} + +/** + * virCommandAddArgSet: + * @cmd: the command to modify + * @vals: array of arguments to add + * + * Add a NULL terminated list of args + */ +void +virCommandAddArgSet(virCommandPtr cmd, const char *const*vals) +{ + int narg = 0; + + if (!cmd || cmd->has_error) + return; + + if (vals[0] == NULL) { + cmd->has_error = EINVAL; + return; + } + + while (vals[narg] != NULL) + narg++; + + /* narg plus trailing NULL. */ + if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, narg + 1) < 0) { + cmd->has_error = ENOMEM; + return; + } + + narg = 0; + while (vals[narg] != NULL) { + char *arg = strdup(vals[narg++]); + if (!arg) { + cmd->has_error = ENOMEM; + return; + } + cmd->args[cmd->nargs++] = arg; + } +} + +/** + * virCommandAddArgList: + * @cmd: the command to modify + * @...: list of arguments to add + * + * Add a NULL terminated list of args. + */ +void +virCommandAddArgList(virCommandPtr cmd, ...) +{ + va_list list; + int narg = 0; + + if (!cmd || cmd->has_error) + return; + + va_start(list, cmd); + while (va_arg(list, const char *) != NULL) + narg++; + va_end(list); + + /* narg plus trailing NULL. */ + if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, narg + 1) < 0) { + cmd->has_error = ENOMEM; + return; + } + + va_start(list, cmd); + while (1) { + char *arg = va_arg(list, char *); + if (!arg) + break; + arg = strdup(arg); + if (!arg) { + cmd->has_error = ENOMEM; + va_end(list); + return; + } + cmd->args[cmd->nargs++] = arg; + } + va_end(list); +} + +/** + * virCommandSetWorkingDirectory: + * @cmd: the command to modify + * @pwd: directory to use + * + * Set the working directory of a non-daemon child process, rather + * than the parent's working directory. Daemons automatically get / + * without using this call. + */ +void +virCommandSetWorkingDirectory(virCommandPtr cmd, const char *pwd) +{ + if (!cmd || cmd->has_error) + return; + + if (cmd->pwd) { + cmd->has_error = -1; + VIR_DEBUG("cannot set directory twice"); + } else { + cmd->pwd = strdup(pwd); + if (!cmd->pwd) + cmd->has_error = ENOMEM; + } +} + + +/** + * virCommandSetInputBuffer: + * @cmd: the command to modify + * @inbuf: string to feed to stdin + * + * Feed the child's stdin from a string buffer. This requires the use + * of virCommandRun(). + */ +void +virCommandSetInputBuffer(virCommandPtr cmd, const char *inbuf) +{ + if (!cmd || cmd->has_error) + return; + + if (cmd->infd != -1 || cmd->inbuf) { + cmd->has_error = -1; + VIR_DEBUG("cannot specify input twice"); + return; + } + + cmd->inbuf = strdup(inbuf); + if (!cmd->inbuf) + cmd->has_error = ENOMEM; +} + + +/** + * virCommandSetOutputBuffer: + * @cmd: the command to modify + * @outbuf: address of variable to store malloced result buffer + * + * Capture the child's stdout to a string buffer. *outbuf is + * guaranteed to be allocated after successful virCommandRun or + * virCommandWait, and is best-effort allocated after failed + * virCommandRun; caller is responsible for freeing *outbuf. + * This requires the use of virCommandRun. + */ +void +virCommandSetOutputBuffer(virCommandPtr cmd, char **outbuf) +{ + *outbuf = NULL; + if (!cmd || cmd->has_error) + return; + + if (cmd->outfdptr) { + cmd->has_error = -1; + VIR_DEBUG("cannot specify output twice"); + return; + } + + cmd->outbuf = outbuf; + cmd->outfdptr = &cmd->outfd; +} + + +/** + * virCommandSetErrorBuffer: + * @cmd: the command to modify + * @errbuf: address of variable to store malloced result buffer + * + * Capture the child's stderr to a string buffer. *errbuf is + * guaranteed to be allocated after successful virCommandRun or + * virCommandWait, and is best-effort allocated after failed + * virCommandRun; caller is responsible for freeing *errbuf. + * This requires the use of virCommandRun. It is possible to + * pass the same pointer as for virCommandSetOutputBuffer(), in + * which case the child process will interleave all output into + * a single string. + */ +void +virCommandSetErrorBuffer(virCommandPtr cmd, char **errbuf) +{ + *errbuf = NULL; + if (!cmd || cmd->has_error) + return; + + if (cmd->errfdptr) { + cmd->has_error = -1; + VIR_DEBUG("cannot specify stderr twice"); + return; + } + + cmd->errbuf = errbuf; + cmd->errfdptr = &cmd->errfd; +} + + +/** + * virCommandSetInputFD: + * @cmd: the command to modify + * @infd: the descriptor to use + * + * Attach a file descriptor to the child's stdin + */ +void +virCommandSetInputFD(virCommandPtr cmd, int infd) +{ + if (!cmd || cmd->has_error) + return; + + if (cmd->infd != -1 || cmd->inbuf) { + cmd->has_error = -1; + VIR_DEBUG("cannot specify input twice"); + return; + } + if (infd < 0) { + cmd->has_error = -1; + VIR_DEBUG("cannot specify invalid input fd"); + return; + } + + cmd->infd = infd; +} + + +/** + * virCommandSetOutputFD: + * @cmd: the command to modify + * @outfd: location of output fd + * + * Attach a file descriptor to the child's stdout. If *@outfd is -1 on + * entry, then a pipe will be created and returned in this variable when + * the child is run. Otherwise, *@outfd is used as the output. + */ +void +virCommandSetOutputFD(virCommandPtr cmd, int *outfd) +{ + if (!cmd || cmd->has_error) + return; + + if (cmd->outfdptr) { + cmd->has_error = -1; + VIR_DEBUG("cannot specify output twice"); + return; + } + + cmd->outfdptr = outfd; +} + + +/** + * virCommandSetErrorFD: + * @cmd: the command to modify + * @errfd: location of error fd + * + * Attach a file descriptor to the child's stderr. If *@errfd is -1 on + * entry, then a pipe will be created and returned in this variable when + * the child is run. Otherwise, *@errfd is used for error collection, + * and may be the same as outfd given to virCommandSetOutputFD(). + */ +void +virCommandSetErrorFD(virCommandPtr cmd, int *errfd) +{ + if (!cmd || cmd->has_error) + return; + + if (cmd->errfdptr) { + cmd->has_error = -1; + VIR_DEBUG("cannot specify stderr twice"); + return; + } + + cmd->errfdptr = errfd; +} + + +/** + * virCommandSetPreExecHook: + * @cmd: the command to modify + * @hook: the hook to run + * @opaque: argument to pass to the hook + * + * Run HOOK(OPAQUE) in the child as the last thing before changing + * directories, dropping capabilities, and executing the new process. + * Force the child to fail if HOOK does not return zero. + * + * Since @hook runs in the child, it should be careful to avoid + * any functions that are not async-signal-safe. + */ +void +virCommandSetPreExecHook(virCommandPtr cmd, virExecHook hook, void *opaque) +{ + if (!cmd || cmd->has_error) + return; + + if (cmd->hook) { + cmd->has_error = -1; + VIR_DEBUG("cannot specify hook twice"); + return; + } + cmd->hook = hook; + cmd->opaque = opaque; +} + + +/** + * virCommandWriteArgLog: + * @cmd: the command to log + * @logfd: where to log the results + * + * Call after adding all arguments and environment settings, but before + * Run/RunAsync, to immediately output the environment and arguments of + * cmd to logfd. If virCommandRun cannot succeed (because of an + * out-of-memory condition while building cmd), nothing will be logged. + */ +void +virCommandWriteArgLog(virCommandPtr cmd, int logfd) +{ + int ioError = 0; + size_t i; + + /* Any errors will be reported later by virCommandRun, which means + * no command will be run, so there is nothing to log. */ + if (!cmd || cmd->has_error) + return; + + for (i = 0 ; i < cmd->nenv ; i++) { + if (safewrite(logfd, cmd->env[i], strlen(cmd->env[i])) < 0) + ioError = errno; + if (safewrite(logfd, " ", 1) < 0) + ioError = errno; + } + for (i = 0 ; i < cmd->nargs ; i++) { + if (safewrite(logfd, cmd->args[i], strlen(cmd->args[i])) < 0) + ioError = errno; + if (safewrite(logfd, i == cmd->nargs - 1 ? "\n" : " ", 1) < 0) + ioError = errno; + } + + if (ioError) { + char ebuf[1024]; + VIR_WARN("Unable to write command %s args to logfile: %s", + cmd->args[0], virStrerror(ioError, ebuf, sizeof(ebuf))); + } +} + + +/** + * virCommandToString: + * @cmd: the command to convert + * + * Call after adding all arguments and environment settings, but + * before Run/RunAsync, to return a string representation of the + * environment and arguments of cmd, suitably quoted for pasting into + * a shell. If virCommandRun cannot succeed (because of an + * out-of-memory condition while building cmd), NULL will be returned. + * Caller is responsible for freeing the resulting string. + */ +char * +virCommandToString(virCommandPtr cmd) +{ + size_t i; + virBuffer buf = VIR_BUFFER_INITIALIZER; + + /* Cannot assume virCommandRun will be called; so report the error + * now. If virCommandRun is called, it will report the same error. */ + if (!cmd ||cmd->has_error == ENOMEM) { + virReportOOMError(); + return NULL; + } + if (cmd->has_error) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("invalid use of command API")); + return NULL; + } + + for (i = 0; i < cmd->nenv; i++) { + /* In shell, a='b c' has a different meaning than 'a=b c', so + * we must determine where the '=' lives. */ + char *eq = strchr(cmd->env[i], '='); + + if (!eq) { + virBufferFreeAndReset(&buf); + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("invalid use of command API")); + return NULL; + } + eq++; + virBufferAdd(&buf, cmd->env[i], eq - cmd->env[i]); + virBufferEscapeShell(&buf, eq); + virBufferAddChar(&buf, ' '); + } + virBufferEscapeShell(&buf, cmd->args[0]); + for (i = 1; i < cmd->nargs; i++) { + virBufferAddChar(&buf, ' '); + virBufferEscapeShell(&buf, cmd->args[i]); + } + + if (virBufferError(&buf)) { + virBufferFreeAndReset(&buf); + virReportOOMError(); + return NULL; + } + + return virBufferContentAndReset(&buf); +} + + +/* + * Manage input and output to the child process. + */ +static int +virCommandProcessIO(virCommandPtr cmd, int *inpipe) +{ + int infd = -1, outfd = -1, errfd = -1; + size_t inlen = 0, outlen = 0, errlen = 0; + size_t inoff = 0; + int ret = 0; + + /* With an input buffer, feed data to child + * via pipe */ + if (cmd->inbuf) { + inlen = strlen(cmd->inbuf); + infd = *inpipe; + } + + /* With out/err buffer, the outfd/errfd have been filled with an + * FD for us. Guarantee an allocated string with partial results + * even if we encounter a later failure, as well as freeing any + * results accumulated over a prior run of the same command. */ + if (cmd->outbuf) { + outfd = cmd->outfd; + if (VIR_REALLOC_N(*cmd->outbuf, 1) < 0) { + virReportOOMError(); + ret = -1; + } + } + if (cmd->errbuf) { + errfd = cmd->errfd; + if (VIR_REALLOC_N(*cmd->errbuf, 1) < 0) { + virReportOOMError(); + ret = -1; + } + } + if (ret == -1) + goto cleanup; + ret = -1; + + for (;;) { + int i; + struct pollfd fds[3]; + int nfds = 0; + + if (infd != -1) { + fds[nfds].fd = infd; + fds[nfds].events = POLLOUT; + fds[nfds].revents = 0; + nfds++; + } + if (outfd != -1) { + fds[nfds].fd = outfd; + fds[nfds].events = POLLIN; + fds[nfds].revents = 0; + nfds++; + } + if (errfd != -1) { + fds[nfds].fd = errfd; + fds[nfds].events = POLLIN; + fds[nfds].revents = 0; + nfds++; + } + + if (nfds == 0) + break; + + if (poll(fds, nfds, -1) < 0) { + if (errno == EAGAIN || errno == EINTR) + continue; + virReportSystemError(errno, "%s", + _("unable to poll on child")); + goto cleanup; + } + + for (i = 0; i < nfds ; i++) { + if (fds[i].revents & (POLLIN | POLLHUP | POLLERR) && + (fds[i].fd == errfd || fds[i].fd == outfd)) { + char data[1024]; + char **buf; + size_t *len; + int done; + if (fds[i].fd == outfd) { + buf = cmd->outbuf; + len = &outlen; + } else { + buf = cmd->errbuf; + len = &errlen; + } + /* Silence a false positive from clang. */ + sa_assert(buf); + + done = read(fds[i].fd, data, sizeof(data)); + if (done < 0) { + if (errno != EINTR && + errno != EAGAIN) { + virReportSystemError(errno, "%s", + (fds[i].fd == outfd) ? + _("unable to read child stdout") : + _("unable to read child stderr")); + goto cleanup; + } + } else if (done == 0) { + if (fds[i].fd == outfd) + outfd = -1; + else + errfd = -1; + } else { + if (VIR_REALLOC_N(*buf, *len + done + 1) < 0) { + virReportOOMError(); + goto cleanup; + } + memcpy(*buf + *len, data, done); + *len += done; + } + } + + if (fds[i].revents & (POLLOUT | POLLERR) && + fds[i].fd == infd) { + int done; + + /* Coverity 5.3.0 can't see that we only get here if + * infd is in the set because it was non-negative. */ + sa_assert(infd != -1); + done = write(infd, cmd->inbuf + inoff, + inlen - inoff); + if (done < 0) { + if (errno == EPIPE) { + VIR_DEBUG("child closed stdin early, ignoring EPIPE " + "on fd %d", infd); + if (VIR_CLOSE(*inpipe) < 0) + VIR_DEBUG("ignoring failed close on fd %d", infd); + infd = -1; + } else if (errno != EINTR && errno != EAGAIN) { + virReportSystemError(errno, "%s", + _("unable to write to child input")); + goto cleanup; + } + } else { + inoff += done; + if (inoff == inlen) { + if (VIR_CLOSE(*inpipe) < 0) + VIR_DEBUG("ignoring failed close on fd %d", infd); + infd = -1; + } + } + } + } + } + + ret = 0; +cleanup: + if (cmd->outbuf && *cmd->outbuf) + (*cmd->outbuf)[outlen] = '\0'; + if (cmd->errbuf && *cmd->errbuf) + (*cmd->errbuf)[errlen] = '\0'; + return ret; +} + +/** + * virCommandExec: + * @cmd: command to run + * + * Exec the command, replacing the current process. Meant to be called + * in the hook after already forking / cloning, so does not attempt to + * daemonize or preserve any FDs. + * + * Returns -1 on any error executing the command. + * Will not return on success. + */ +#ifndef WIN32 +int virCommandExec(virCommandPtr cmd) +{ + if (!cmd ||cmd->has_error == ENOMEM) { + virReportOOMError(); + return -1; + } + if (cmd->has_error) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("invalid use of command API")); + return -1; + } + + return execve(cmd->args[0], cmd->args, cmd->env); +} +#else +int virCommandExec(virCommandPtr cmd ATTRIBUTE_UNUSED) +{ + /* Mingw execve() has a broken signature. Disable this + * function until gnulib fixes the signature, since we + * don't really need this on Win32 anyway. + */ + virReportSystemError(ENOSYS, "%s", + _("Executing new processes is not supported on Win32 platform")); + return -1; +} +#endif + +/** + * virCommandRun: + * @cmd: command to run + * @exitstatus: optional status collection + * + * Run the command and wait for completion. + * Returns -1 on any error executing the + * command. Returns 0 if the command executed, + * with the exit status set. If @exitstatus is NULL, then the + * child must exit with status 0 for this to succeed. + */ +int +virCommandRun(virCommandPtr cmd, int *exitstatus) +{ + int ret = 0; + char *outbuf = NULL; + char *errbuf = NULL; + int infd[2] = { -1, -1 }; + struct stat st; + bool string_io; + bool async_io = false; + char *str; + int tmpfd; + + if (!cmd ||cmd->has_error == ENOMEM) { + virReportOOMError(); + return -1; + } + if (cmd->has_error) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("invalid use of command API")); + return -1; + } + + /* Avoid deadlock, by requiring that any open fd not under our + * control must be visiting a regular file, or that we are + * daemonized and no string io is required. */ + string_io = cmd->inbuf || cmd->outbuf || cmd->errbuf; + if (cmd->infd != -1 && + (fstat(cmd->infd, &st) < 0 || !S_ISREG(st.st_mode))) + async_io = true; + if (cmd->outfdptr && cmd->outfdptr != &cmd->outfd && + (*cmd->outfdptr == -1 || + fstat(*cmd->outfdptr, &st) < 0 || !S_ISREG(st.st_mode))) + async_io = true; + if (cmd->errfdptr && cmd->errfdptr != &cmd->errfd && + (*cmd->errfdptr == -1 || + fstat(*cmd->errfdptr, &st) < 0 || !S_ISREG(st.st_mode))) + async_io = true; + if (async_io) { + if (!(cmd->flags & VIR_EXEC_DAEMON) || string_io) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("cannot mix caller fds with blocking execution")); + return -1; + } + } else { + if ((cmd->flags & VIR_EXEC_DAEMON) && string_io) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("cannot mix string I/O with daemon")); + return -1; + } + } + + /* If we have an input buffer, we need + * a pipe to feed the data to the child */ + if (cmd->inbuf) { + if (pipe2(infd, O_CLOEXEC) < 0) { + virReportSystemError(errno, "%s", + _("unable to open pipe")); + cmd->has_error = -1; + return -1; + } + cmd->infd = infd[0]; + } + + /* If caller requested the same string for stdout and stderr, then + * merge those into one string. */ + if (cmd->outbuf && cmd->outbuf == cmd->errbuf) { + cmd->errfdptr = &cmd->outfd; + cmd->errbuf = NULL; + } + + /* If caller hasn't requested capture of stdout/err, then capture + * it ourselves so we can log it. But the intermediate child for + * a daemon has no expected output, and we don't want our + * capturing pipes passed on to the daemon grandchild. + */ + if (!(cmd->flags & VIR_EXEC_DAEMON)) { + if (!cmd->outfdptr) { + cmd->outfdptr = &cmd->outfd; + cmd->outbuf = &outbuf; + string_io = true; + } + if (!cmd->errfdptr) { + cmd->errfdptr = &cmd->errfd; + cmd->errbuf = &errbuf; + string_io = true; + } + } + + cmd->flags |= VIR_EXEC_RUN_SYNC; + if (virCommandRunAsync(cmd, NULL) < 0) { + if (cmd->inbuf) { + tmpfd = infd[0]; + if (VIR_CLOSE(infd[0]) < 0) + VIR_DEBUG("ignoring failed close on fd %d", tmpfd); + tmpfd = infd[1]; + if (VIR_CLOSE(infd[1]) < 0) + VIR_DEBUG("ignoring failed close on fd %d", tmpfd); + } + cmd->has_error = -1; + return -1; + } + + tmpfd = infd[0]; + if (VIR_CLOSE(infd[0]) < 0) + VIR_DEBUG("ignoring failed close on fd %d", tmpfd); + if (string_io) + ret = virCommandProcessIO(cmd, &infd[1]); + + if (virCommandWait(cmd, exitstatus) < 0) + ret = -1; + + str = (exitstatus ? virProcessTranslateStatus(*exitstatus) + : (char *) "status 0"); + VIR_DEBUG("Result %s, stdout: '%s' stderr: '%s'", + NULLSTR(str), + cmd->outbuf ? NULLSTR(*cmd->outbuf) : "(null)", + cmd->errbuf ? NULLSTR(*cmd->errbuf) : "(null)"); + if (exitstatus) + VIR_FREE(str); + + /* Reset any capturing, in case caller runs + * this identical command again */ + if (cmd->inbuf) { + tmpfd = infd[1]; + if (VIR_CLOSE(infd[1]) < 0) + VIR_DEBUG("ignoring failed close on fd %d", tmpfd); + } + if (cmd->outbuf == &outbuf) { + tmpfd = cmd->outfd; + if (VIR_CLOSE(cmd->outfd) < 0) + VIR_DEBUG("ignoring failed close on fd %d", tmpfd); + cmd->outfdptr = NULL; + cmd->outbuf = NULL; + VIR_FREE(outbuf); + } + if (cmd->errbuf == &errbuf) { + tmpfd = cmd->errfd; + if (VIR_CLOSE(cmd->errfd) < 0) + VIR_DEBUG("ignoring failed close on fd %d", tmpfd); + cmd->errfdptr = NULL; + cmd->errbuf = NULL; + VIR_FREE(errbuf); + } + + return ret; +} + + +/* + * Perform all virCommand-specific actions, along with the user hook. + */ +static int +virCommandHook(void *data) +{ + virCommandPtr cmd = data; + int res = 0; + + if (cmd->hook) { + VIR_DEBUG("Run hook %p %p", cmd->hook, cmd->opaque); + res = cmd->hook(cmd->opaque); + VIR_DEBUG("Done hook %d", res); + } + if (res == 0 && cmd->pwd) { + VIR_DEBUG("Running child in %s", cmd->pwd); + res = chdir(cmd->pwd); + if (res < 0) { + virReportSystemError(errno, + _("Unable to change to %s"), cmd->pwd); + } + } + if (cmd->handshake) { + char c = res < 0 ? '0' : '1'; + int rv; + VIR_DEBUG("Notifying parent for handshake start on %d", + cmd->handshakeWait[1]); + if (safewrite(cmd->handshakeWait[1], &c, sizeof(c)) != sizeof(c)) { + virReportSystemError(errno, "%s", + _("Unable to notify parent process")); + return -1; + } + + /* On failure we pass the error message back to parent, + * so they don't have to dig through stderr logs + */ + if (res < 0) { + virErrorPtr err = virGetLastError(); + const char *msg = err ? err->message : + _("Unknown failure during hook execution"); + size_t len = strlen(msg) + 1; + if (safewrite(cmd->handshakeWait[1], msg, len) != len) { + virReportSystemError(errno, "%s", + _("Unable to send error to parent")); + return -1; + } + return -1; + } + + VIR_DEBUG("Waiting on parent for handshake complete on %d", + cmd->handshakeNotify[0]); + if ((rv = saferead(cmd->handshakeNotify[0], &c, + sizeof(c))) != sizeof(c)) { + if (rv < 0) + virReportSystemError(errno, "%s", + _("Unable to wait on parent process")); + else + virReportSystemError(EIO, "%s", + _("libvirtd quit during handshake")); + return -1; + } + if (c != '1') { + virReportSystemError(EINVAL, + _("Unexpected confirm code '%c' from parent"), + c); + return -1; + } + VIR_FORCE_CLOSE(cmd->handshakeWait[1]); + VIR_FORCE_CLOSE(cmd->handshakeNotify[0]); + } + + VIR_DEBUG("Hook is done %d", res); + + return res; +} + + +/** + * virCommandRunAsync: + * @cmd: command to start + * @pid: optional variable to track child pid + * + * Run the command asynchronously + * Returns -1 on any error executing the + * command. Returns 0 if the command executed. + * + * There are two approaches to child process cleanup. + * 1. Use auto-cleanup, by passing NULL for pid. The child will be + * auto-reaped by virCommandFree, unless you reap it earlier via + * virCommandWait or virCommandAbort. Good for where cmd is in + * scope for the duration of the child process. + * 2. Use manual cleanup, by passing the address of a pid_t variable + * for pid. While cmd is still in scope, you may reap the child via + * virCommandWait or virCommandAbort. But after virCommandFree, if + * you have not yet reaped the child, then it continues to run until + * you call virProcessWait or virProcessAbort. + */ +int +virCommandRunAsync(virCommandPtr cmd, pid_t *pid) +{ + int ret; + char *str; + int i; + bool synchronous = false; + + if (!cmd || cmd->has_error == ENOMEM) { + virReportOOMError(); + return -1; + } + if (cmd->has_error) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("invalid use of command API")); + return -1; + } + + synchronous = cmd->flags & VIR_EXEC_RUN_SYNC; + cmd->flags &= ~VIR_EXEC_RUN_SYNC; + + /* Buffer management can only be requested via virCommandRun. */ + if ((cmd->inbuf && cmd->infd == -1) || + (cmd->outbuf && cmd->outfdptr != &cmd->outfd) || + (cmd->errbuf && cmd->errfdptr != &cmd->errfd)) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("cannot mix string I/O with asynchronous command")); + return -1; + } + + if (cmd->pid != -1) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("command is already running as pid %lld"), + (long long) cmd->pid); + return -1; + } + + if (!synchronous && (cmd->flags & VIR_EXEC_DAEMON)) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("daemonized command cannot use virCommandRunAsync")); + return -1; + } + if (cmd->pwd && (cmd->flags & VIR_EXEC_DAEMON)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("daemonized command cannot set working directory %s"), + cmd->pwd); + return -1; + } + if (cmd->pidfile && !(cmd->flags & VIR_EXEC_DAEMON)) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("creation of pid file requires daemonized command")); + return -1; + } + + str = virCommandToString(cmd); + VIR_DEBUG("About to run %s", str ? str : cmd->args[0]); + VIR_FREE(str); + + ret = virExecWithHook((const char *const *)cmd->args, + (const char *const *)cmd->env, + cmd->preserve, + cmd->preserve_size, + &cmd->pid, + cmd->infd, + cmd->outfdptr, + cmd->errfdptr, + cmd->flags, + virCommandHook, + cmd, + cmd->pidfile, + cmd->capabilities); + + VIR_DEBUG("Command result %d, with PID %d", + ret, (int)cmd->pid); + + for (i = 0; i < cmd->transfer_size; i++) { + VIR_FORCE_CLOSE(cmd->transfer[i]); + } + cmd->transfer_size = 0; + VIR_FREE(cmd->transfer); + + if (ret == 0 && pid) + *pid = cmd->pid; + else + cmd->reap = true; + + return ret; +} + + +/** + * virCommandWait: + * @cmd: command to wait on + * @exitstatus: optional status collection + * + * Wait for the command previously started with virCommandRunAsync() + * to complete. Return -1 on any error waiting for + * completion. Returns 0 if the command + * finished with the exit status set. If @exitstatus is NULL, then the + * child must exit with status 0 for this to succeed. + */ +int +virCommandWait(virCommandPtr cmd, int *exitstatus) +{ + int ret; + int status = 0; + + if (!cmd ||cmd->has_error == ENOMEM) { + virReportOOMError(); + return -1; + } + if (cmd->has_error) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("invalid use of command API")); + return -1; + } + + if (cmd->pid == -1) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("command is not yet running")); + return -1; + } + + /* If virProcessWait reaps pid but then returns failure because + * exitstatus was NULL, then a second virCommandWait would risk + * calling waitpid on an unrelated process. Besides, that error + * message is not as detailed as what we can provide. So, we + * guarantee that virProcessWait only fails due to failure to wait, + * and repeat the exitstatus check code ourselves. */ + ret = virProcessWait(cmd->pid, exitstatus ? exitstatus : &status); + if (ret == 0) { + cmd->pid = -1; + cmd->reap = false; + if (status) { + char *str = virCommandToString(cmd); + char *st = virProcessTranslateStatus(status); + bool haveErrMsg = cmd->errbuf && *cmd->errbuf && (*cmd->errbuf)[0]; + + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Child process (%s) unexpected %s%s%s"), + str ? str : cmd->args[0], NULLSTR(st), + haveErrMsg ? ": " : "", + haveErrMsg ? *cmd->errbuf : ""); + VIR_FREE(str); + VIR_FREE(st); + return -1; + } + } + + return ret; +} + + +#ifndef WIN32 +/** + * virCommandAbort: + * @cmd: command to abort + * + * Abort an async command if it is running, without issuing + * any errors or affecting errno. Designed for error paths + * where some but not all paths to the cleanup code might + * have started the child process. + */ +void +virCommandAbort(virCommandPtr cmd) +{ + if (!cmd || cmd->pid == -1) + return; + virProcessAbort(cmd->pid); + cmd->pid = -1; + cmd->reap = false; +} +#else /* WIN32 */ +void +virCommandAbort(virCommandPtr cmd ATTRIBUTE_UNUSED) +{ + /* Mingw lacks WNOHANG and kill(). But since we haven't ported + * virExecWithHook to mingw yet, there's no process to be killed, + * making this implementation trivially correct for now :) */ +} +#endif + + +/** + * virCommandRequireHandshake: + * @cmd: command to modify + * + * Request that the child perform a handshake with + * the parent when the hook function has completed + * execution. The child will not exec() until the + * parent has notified + */ +void virCommandRequireHandshake(virCommandPtr cmd) +{ + if (!cmd || cmd->has_error) + return; + + if (cmd->handshake) { + cmd->has_error = -1; + VIR_DEBUG("Cannot require handshake twice"); + return; + } + + if (pipe2(cmd->handshakeWait, O_CLOEXEC) < 0) { + cmd->has_error = errno; + return; + } + if (pipe2(cmd->handshakeNotify, O_CLOEXEC) < 0) { + VIR_FORCE_CLOSE(cmd->handshakeWait[0]); + VIR_FORCE_CLOSE(cmd->handshakeWait[1]); + cmd->has_error = errno; + return; + } + + VIR_DEBUG("Transfer handshake wait=%d notify=%d, " + "keep handshake wait=%d notify=%d", + cmd->handshakeWait[1], cmd->handshakeNotify[0], + cmd->handshakeWait[0], cmd->handshakeNotify[1]); + virCommandTransferFD(cmd, cmd->handshakeWait[1]); + virCommandTransferFD(cmd, cmd->handshakeNotify[0]); + cmd->handshake = true; +} + +/** + * virCommandHandshakeWait: + * @cmd: command to wait on + * + * Wait for the child to complete execution of its + * hook function. To be called in the parent. + */ +int virCommandHandshakeWait(virCommandPtr cmd) +{ + char c; + int rv; + if (!cmd ||cmd->has_error == ENOMEM) { + virReportOOMError(); + return -1; + } + if (cmd->has_error || !cmd->handshake) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("invalid use of command API")); + return -1; + } + + if (cmd->handshakeWait[0] == -1) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Handshake is already complete")); + return -1; + } + + VIR_DEBUG("Wait for handshake on %d", cmd->handshakeWait[0]); + if ((rv = saferead(cmd->handshakeWait[0], &c, sizeof(c))) != sizeof(c)) { + if (rv < 0) + virReportSystemError(errno, "%s", + _("Unable to wait for child process")); + else + virReportSystemError(EIO, "%s", + _("Child quit during startup handshake")); + VIR_FORCE_CLOSE(cmd->handshakeWait[0]); + return -1; + } + if (c != '1') { + char *msg; + ssize_t len; + if (VIR_ALLOC_N(msg, 1024) < 0) { + virReportOOMError(); + VIR_FORCE_CLOSE(cmd->handshakeWait[0]); + return -1; + } + /* Close the handshakeNotify fd before trying to read anything + * further on the handshakeWait pipe; so that a child waiting + * on our acknowledgment will die rather than deadlock. */ + VIR_FORCE_CLOSE(cmd->handshakeNotify[1]); + + if ((len = saferead(cmd->handshakeWait[0], msg, 1024)) < 0) { + VIR_FORCE_CLOSE(cmd->handshakeWait[0]); + VIR_FREE(msg); + virReportSystemError(errno, "%s", + _("No error message from child failure")); + return -1; + } + VIR_FORCE_CLOSE(cmd->handshakeWait[0]); + msg[len-1] = '\0'; + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", msg); + VIR_FREE(msg); + return -1; + } + VIR_FORCE_CLOSE(cmd->handshakeWait[0]); + return 0; +} + +/** + * virCommandHandshakeNotify: + * @cmd: command to resume + * + * Notify the child that it is OK to exec() the + * real binary now. To be called in the parent. + */ +int virCommandHandshakeNotify(virCommandPtr cmd) +{ + char c = '1'; + if (!cmd ||cmd->has_error == ENOMEM) { + virReportOOMError(); + return -1; + } + if (cmd->has_error || !cmd->handshake) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("invalid use of command API")); + return -1; + } + + if (cmd->handshakeNotify[1] == -1) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Handshake is already complete")); + return -1; + } + + VIR_DEBUG("Notify handshake on %d", cmd->handshakeNotify[1]); + if (safewrite(cmd->handshakeNotify[1], &c, sizeof(c)) != sizeof(c)) { + virReportSystemError(errno, "%s", _("Unable to notify child process")); + VIR_FORCE_CLOSE(cmd->handshakeNotify[1]); + return -1; + } + VIR_FORCE_CLOSE(cmd->handshakeNotify[1]); + return 0; +} + + +/** + * virCommandFree: + * @cmd: optional command to free + * + * Release all resources. The only exception is that if you called + * virCommandRunAsync with a non-null pid, then the asynchronous child + * is not reaped, and you must call virProcessWait() or virProcessAbort() yourself. + */ +void +virCommandFree(virCommandPtr cmd) +{ + int i; + if (!cmd) + return; + + for (i = 0; i < cmd->transfer_size; i++) { + VIR_FORCE_CLOSE(cmd->transfer[i]); + } + + VIR_FREE(cmd->inbuf); + VIR_FORCE_CLOSE(cmd->outfd); + VIR_FORCE_CLOSE(cmd->errfd); + + for (i = 0 ; i < cmd->nargs ; i++) + VIR_FREE(cmd->args[i]); + VIR_FREE(cmd->args); + + for (i = 0 ; i < cmd->nenv ; i++) + VIR_FREE(cmd->env[i]); + VIR_FREE(cmd->env); + + VIR_FREE(cmd->pwd); + + if (cmd->handshake) { + /* The other 2 fds in these arrays are closed + * due to use with virCommandTransferFD + */ + VIR_FORCE_CLOSE(cmd->handshakeWait[0]); + VIR_FORCE_CLOSE(cmd->handshakeNotify[1]); + } + + VIR_FREE(cmd->pidfile); + + if (cmd->reap) + virCommandAbort(cmd); + + VIR_FREE(cmd->transfer); + VIR_FREE(cmd->preserve); + + VIR_FREE(cmd); +} diff --git a/src/util/vircommand.h b/src/util/vircommand.h new file mode 100644 index 0000000..4c88165 --- /dev/null +++ b/src/util/vircommand.h @@ -0,0 +1,166 @@ +/* + * vircommand.h: Child command execution + * + * Copyright (C) 2010-2011 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + */ + +#ifndef __VIR_COMMAND_H__ +# define __VIR_COMMAND_H__ + +# include "internal.h" +# include "util.h" +# include "virbuffer.h" + +typedef struct _virCommand virCommand; +typedef virCommand *virCommandPtr; + +/* This will execute in the context of the first child + * after fork() but before execve(). As such, it is unsafe to + * call any function that is not async-signal-safe. */ +typedef int (*virExecHook)(void *data); + +int virFork(pid_t *pid) ATTRIBUTE_RETURN_CHECK; + +int virRun(const char *const*argv, int *status) ATTRIBUTE_RETURN_CHECK; + +virCommandPtr virCommandNew(const char *binary) ATTRIBUTE_NONNULL(1); + +virCommandPtr virCommandNewArgs(const char *const*args) ATTRIBUTE_NONNULL(1); + +virCommandPtr virCommandNewArgList(const char *binary, ...) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_SENTINEL; + +virCommandPtr virCommandNewVAList(const char *binary, va_list list) + ATTRIBUTE_NONNULL(1); + +/* All error report from these setup APIs is + * delayed until the Run/RunAsync methods + */ + +void virCommandPreserveFD(virCommandPtr cmd, + int fd); + +void virCommandTransferFD(virCommandPtr cmd, + int fd); + +void virCommandSetPidFile(virCommandPtr cmd, + const char *pidfile) ATTRIBUTE_NONNULL(2); + +void virCommandClearCaps(virCommandPtr cmd); + +void virCommandAllowCap(virCommandPtr cmd, + int capability); + +void virCommandDaemonize(virCommandPtr cmd); + +void virCommandNonblockingFDs(virCommandPtr cmd); + +void virCommandAddEnvFormat(virCommandPtr cmd, const char *format, ...) + ATTRIBUTE_NONNULL(2) ATTRIBUTE_FMT_PRINTF(2, 3); + +void virCommandAddEnvPair(virCommandPtr cmd, + const char *name, + const char *value) ATTRIBUTE_NONNULL(2); + +void virCommandAddEnvString(virCommandPtr cmd, + const char *str) ATTRIBUTE_NONNULL(2); + +void virCommandAddEnvBuffer(virCommandPtr cmd, + virBufferPtr buf); + +void virCommandAddEnvPass(virCommandPtr cmd, + const char *name) ATTRIBUTE_NONNULL(2); + +void virCommandAddEnvPassCommon(virCommandPtr cmd); + +void virCommandAddArg(virCommandPtr cmd, + const char *val) ATTRIBUTE_NONNULL(2); + +void virCommandAddArgBuffer(virCommandPtr cmd, + virBufferPtr buf); + +void virCommandAddArgFormat(virCommandPtr cmd, + const char *format, ...) + ATTRIBUTE_NONNULL(2) ATTRIBUTE_FMT_PRINTF(2, 3); + +void virCommandAddArgPair(virCommandPtr cmd, + const char *name, + const char *val) + ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3); + +void virCommandAddArgSet(virCommandPtr cmd, + const char *const*vals) ATTRIBUTE_NONNULL(2); + +void virCommandAddArgList(virCommandPtr cmd, + ... /* const char *arg, ..., NULL */) + ATTRIBUTE_SENTINEL; + +void virCommandSetWorkingDirectory(virCommandPtr cmd, + const char *pwd) ATTRIBUTE_NONNULL(2); + +void virCommandSetInputBuffer(virCommandPtr cmd, + const char *inbuf) ATTRIBUTE_NONNULL(2); + +void virCommandSetOutputBuffer(virCommandPtr cmd, + char **outbuf) ATTRIBUTE_NONNULL(2); + +void virCommandSetErrorBuffer(virCommandPtr cmd, + char **errbuf) ATTRIBUTE_NONNULL(2); + +void virCommandSetInputFD(virCommandPtr cmd, + int infd); + +void virCommandSetOutputFD(virCommandPtr cmd, + int *outfd) ATTRIBUTE_NONNULL(2); + +void virCommandSetErrorFD(virCommandPtr cmd, + int *errfd) ATTRIBUTE_NONNULL(2); + +void virCommandSetPreExecHook(virCommandPtr cmd, + virExecHook hook, + void *opaque) ATTRIBUTE_NONNULL(2); + +void virCommandWriteArgLog(virCommandPtr cmd, + int logfd); + +char *virCommandToString(virCommandPtr cmd) ATTRIBUTE_RETURN_CHECK; + +int virCommandExec(virCommandPtr cmd) ATTRIBUTE_RETURN_CHECK; + +int virCommandRun(virCommandPtr cmd, + int *exitstatus) ATTRIBUTE_RETURN_CHECK; + +int virCommandRunAsync(virCommandPtr cmd, + pid_t *pid) ATTRIBUTE_RETURN_CHECK; + +int virCommandWait(virCommandPtr cmd, + int *exitstatus) ATTRIBUTE_RETURN_CHECK; + +void virCommandRequireHandshake(virCommandPtr cmd); + +int virCommandHandshakeWait(virCommandPtr cmd) + ATTRIBUTE_RETURN_CHECK; + +int virCommandHandshakeNotify(virCommandPtr cmd) + ATTRIBUTE_RETURN_CHECK; + +void virCommandAbort(virCommandPtr cmd); + +void virCommandFree(virCommandPtr cmd); + +#endif /* __VIR_COMMAND_H__ */ diff --git a/src/util/virfile.c b/src/util/virfile.c index c79ef04..d77b726 100644 --- a/src/util/virfile.c +++ b/src/util/virfile.c @@ -37,7 +37,7 @@ # include <sys/ioctl.h> #endif -#include "command.h" +#include "vircommand.h" #include "configmake.h" #include "memory.h" #include "virterror_internal.h" diff --git a/src/util/virnetdev.c b/src/util/virnetdev.c index c345013..e98a2ca 100644 --- a/src/util/virnetdev.c +++ b/src/util/virnetdev.c @@ -26,7 +26,7 @@ #include "virmacaddr.h" #include "virfile.h" #include "virterror_internal.h" -#include "command.h" +#include "vircommand.h" #include "memory.h" #include "pci.h" #include "logging.h" diff --git a/src/util/virnetdevbandwidth.c b/src/util/virnetdevbandwidth.c index 19c00b6..bd75a9d 100644 --- a/src/util/virnetdevbandwidth.c +++ b/src/util/virnetdevbandwidth.c @@ -23,7 +23,7 @@ #include <config.h> #include "virnetdevbandwidth.h" -#include "command.h" +#include "vircommand.h" #include "memory.h" #include "virterror_internal.h" diff --git a/src/util/virnetdevopenvswitch.c b/src/util/virnetdevopenvswitch.c index 5bce611..983a240 100644 --- a/src/util/virnetdevopenvswitch.c +++ b/src/util/virnetdevopenvswitch.c @@ -24,7 +24,7 @@ #include <config.h> #include "virnetdevopenvswitch.h" -#include "command.h" +#include "vircommand.h" #include "memory.h" #include "virterror_internal.h" #include "virmacaddr.h" diff --git a/src/util/virnetdevveth.c b/src/util/virnetdevveth.c index 4166ee0..3261337 100644 --- a/src/util/virnetdevveth.c +++ b/src/util/virnetdevveth.c @@ -28,7 +28,7 @@ #include "virnetdevveth.h" #include "memory.h" #include "logging.h" -#include "command.h" +#include "vircommand.h" #include "virterror_internal.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/src/util/virnodesuspend.c b/src/util/virnodesuspend.c index f80920e..a34ca6a 100644 --- a/src/util/virnodesuspend.c +++ b/src/util/virnodesuspend.c @@ -22,7 +22,7 @@ #include <config.h> #include "virnodesuspend.h" -#include "command.h" +#include "vircommand.h" #include "threads.h" #include "datatypes.h" diff --git a/src/vmware/vmware_conf.c b/src/vmware/vmware_conf.c index 2eed4f8..b32de66 100644 --- a/src/vmware/vmware_conf.c +++ b/src/vmware/vmware_conf.c @@ -24,7 +24,7 @@ #include <string.h> #include <sys/utsname.h> -#include "command.h" +#include "vircommand.h" #include "cpu/cpu.h" #include "dirname.h" #include "memory.h" diff --git a/src/vmware/vmware_driver.c b/src/vmware/vmware_driver.c index 3e7397f..d9a1333 100644 --- a/src/vmware/vmware_driver.c +++ b/src/vmware/vmware_driver.c @@ -30,7 +30,7 @@ #include "memory.h" #include "util.h" #include "uuid.h" -#include "command.h" +#include "vircommand.h" #include "vmx.h" #include "vmware_conf.h" #include "vmware_driver.h" diff --git a/src/xen/xen_driver.c b/src/xen/xen_driver.c index d2de141..d9174b6 100644 --- a/src/xen/xen_driver.c +++ b/src/xen/xen_driver.c @@ -62,7 +62,7 @@ #include "fdstream.h" #include "virfile.h" #include "viruri.h" -#include "command.h" +#include "vircommand.h" #include "virnodesuspend.h" #include "nodeinfo.h" #include "configmake.h" diff --git a/tests/commandtest.c b/tests/commandtest.c index 19bf9ba..f76bc54 100644 --- a/tests/commandtest.c +++ b/tests/commandtest.c @@ -33,7 +33,7 @@ #include "nodeinfo.h" #include "util.h" #include "memory.h" -#include "command.h" +#include "vircommand.h" #include "virfile.h" #include "virpidfile.h" #include "virterror_internal.h" diff --git a/tests/networkxml2conftest.c b/tests/networkxml2conftest.c index 1888465..dc0e064 100644 --- a/tests/networkxml2conftest.c +++ b/tests/networkxml2conftest.c @@ -11,7 +11,7 @@ #include "internal.h" #include "testutils.h" #include "network_conf.h" -#include "command.h" +#include "vircommand.h" #include "memory.h" #include "network/bridge_driver.h" diff --git a/tests/reconnect.c b/tests/reconnect.c index 90af830..4031360 100644 --- a/tests/reconnect.c +++ b/tests/reconnect.c @@ -6,7 +6,7 @@ #include "internal.h" #include "testutils.h" -#include "command.h" +#include "vircommand.h" static void errorHandler(void *userData ATTRIBUTE_UNUSED, virErrorPtr error ATTRIBUTE_UNUSED) { diff --git a/tests/statstest.c b/tests/statstest.c index 8c40082..ad71bf9 100644 --- a/tests/statstest.c +++ b/tests/statstest.c @@ -9,7 +9,7 @@ #include "internal.h" #include "xen/block_stats.h" #include "testutils.h" -#include "command.h" +#include "vircommand.h" static void testQuietError(void *userData ATTRIBUTE_UNUSED, virErrorPtr error ATTRIBUTE_UNUSED) diff --git a/tests/testutils.c b/tests/testutils.c index e8b48e8..1315cb5 100644 --- a/tests/testutils.c +++ b/tests/testutils.c @@ -45,7 +45,7 @@ #include "virterror_internal.h" #include "virbuffer.h" #include "logging.h" -#include "command.h" +#include "vircommand.h" #include "virrandom.h" #include "dirname.h" #include "virprocess.h" diff --git a/tests/virnettlscontexttest.c b/tests/virnettlscontexttest.c index cc260e0..d421feb 100644 --- a/tests/virnettlscontexttest.c +++ b/tests/virnettlscontexttest.c @@ -32,7 +32,7 @@ #include "memory.h" #include "logging.h" #include "virfile.h" -#include "command.h" +#include "vircommand.h" #include "virsocketaddr.h" #include "gnutls_1_0_compat.h" diff --git a/tools/virsh.c b/tools/virsh.c index 82c03e4..07da077 100644 --- a/tools/virsh.c +++ b/tools/virsh.c @@ -66,7 +66,7 @@ #include "event_poll.h" #include "configmake.h" #include "threads.h" -#include "command.h" +#include "vircommand.h" #include "virkeycode.h" #include "virnetdevbandwidth.h" #include "virbitmap.h" -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- po/POTFILES.in | 2 +- src/Makefile.am | 2 +- src/network/bridge_driver.c | 2 +- src/network/bridge_driver.h | 2 +- src/util/dnsmasq.c | 872 -------------------------------------------- src/util/dnsmasq.h | 117 ------ src/util/virdnsmasq.c | 872 ++++++++++++++++++++++++++++++++++++++++++++ src/util/virdnsmasq.h | 117 ++++++ 8 files changed, 993 insertions(+), 993 deletions(-) delete mode 100644 src/util/dnsmasq.c delete mode 100644 src/util/dnsmasq.h create mode 100644 src/util/virdnsmasq.c create mode 100644 src/util/virdnsmasq.h diff --git a/po/POTFILES.in b/po/POTFILES.in index e80c413..3214ebe 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -137,7 +137,6 @@ src/storage/storage_driver.c src/test/test_driver.c src/uml/uml_conf.c src/uml/uml_driver.c -src/util/dnsmasq.c src/util/event_poll.c src/util/hooks.c src/util/hostusb.c @@ -158,6 +157,7 @@ src/util/vircgroup.c src/util/vircommand.c src/util/virconf.c src/util/virdbus.c +src/util/virdnsmasq.c src/util/virfile.c src/util/virhash.c src/util/virinitctl.c diff --git a/src/Makefile.am b/src/Makefile.am index b53f1f2..ce16e87 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -58,7 +58,6 @@ UTIL_SOURCES = \ util/hooks.c util/hooks.h \ util/iptables.c util/iptables.h \ util/ebtables.c util/ebtables.h \ - util/dnsmasq.c util/dnsmasq.h \ util/json.c util/json.h \ util/logging.c util/logging.h \ util/memory.c util/memory.h \ @@ -83,6 +82,7 @@ UTIL_SOURCES = \ util/virbuffer.c util/virbuffer.h \ util/vircommand.c util/vircommand.h \ util/virconf.c util/virconf.h \ + util/virdnsmasq.c util/virdnsmasq.h \ util/virfile.c util/virfile.h \ util/virnodesuspend.c util/virnodesuspend.h \ util/virobject.c util/virobject.h \ diff --git a/src/network/bridge_driver.c b/src/network/bridge_driver.c index 319ff8c..1110208 100644 --- a/src/network/bridge_driver.c +++ b/src/network/bridge_driver.c @@ -58,7 +58,7 @@ #include "uuid.h" #include "iptables.h" #include "logging.h" -#include "dnsmasq.h" +#include "virdnsmasq.h" #include "configmake.h" #include "virnetdev.h" #include "pci.h" diff --git a/src/network/bridge_driver.h b/src/network/bridge_driver.h index fea27e0..4bf64ea 100644 --- a/src/network/bridge_driver.h +++ b/src/network/bridge_driver.h @@ -31,7 +31,7 @@ # include "network_conf.h" # include "domain_conf.h" # include "vircommand.h" -# include "dnsmasq.h" +# include "virdnsmasq.h" int networkRegister(void); diff --git a/src/util/dnsmasq.c b/src/util/dnsmasq.c deleted file mode 100644 index 6e9c9dd..0000000 --- a/src/util/dnsmasq.c +++ /dev/null @@ -1,872 +0,0 @@ -/* - * Copyright (C) 2007-2012 Red Hat, Inc. - * Copyright (C) 2010 Satoru SATOH <satoru.satoh(a)gmail.com&gt; - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Based on iptables.c - */ - -#include <config.h> - -#include <stdio.h> -#include <stdlib.h> -#include <stdarg.h> -#include <string.h> -#include <errno.h> -#include <limits.h> -#include <unistd.h> -#include <fcntl.h> -#include <sys/types.h> -#include <sys/stat.h> -#include <signal.h> - -#ifdef HAVE_PATHS_H -# include <paths.h> -#endif - -#include "internal.h" -#include "datatypes.h" -#include "virbitmap.h" -#include "dnsmasq.h" -#include "util.h" -#include "vircommand.h" -#include "memory.h" -#include "virterror_internal.h" -#include "logging.h" -#include "virfile.h" - -#define VIR_FROM_THIS VIR_FROM_NETWORK -#define DNSMASQ_HOSTSFILE_SUFFIX "hostsfile" -#define DNSMASQ_ADDNHOSTSFILE_SUFFIX "addnhosts" - -static void -dhcphostFree(dnsmasqDhcpHost *host) -{ - VIR_FREE(host->host); -} - -static void -addnhostFree(dnsmasqAddnHost *host) -{ - int i; - - for (i = 0; i < host->nhostnames; i++) - VIR_FREE(host->hostnames[i]); - VIR_FREE(host->hostnames); - VIR_FREE(host->ip); -} - -static void -addnhostsFree(dnsmasqAddnHostsfile *addnhostsfile) -{ - unsigned int i; - - if (addnhostsfile->hosts) { - for (i = 0; i < addnhostsfile->nhosts; i++) - addnhostFree(&addnhostsfile->hosts[i]); - - VIR_FREE(addnhostsfile->hosts); - - addnhostsfile->nhosts = 0; - } - - VIR_FREE(addnhostsfile->path); - - VIR_FREE(addnhostsfile); -} - -static int -addnhostsAdd(dnsmasqAddnHostsfile *addnhostsfile, - virSocketAddr *ip, - const char *name) -{ - char *ipstr = NULL; - int idx = -1; - int i; - - if (!(ipstr = virSocketAddrFormat(ip))) - return -1; - - for (i = 0; i < addnhostsfile->nhosts; i++) { - if (STREQ((const char *)addnhostsfile->hosts[i].ip, (const char *)ipstr)) { - idx = i; - break; - } - } - - if (idx < 0) { - if (VIR_REALLOC_N(addnhostsfile->hosts, addnhostsfile->nhosts + 1) < 0) - goto alloc_error; - - idx = addnhostsfile->nhosts; - if (VIR_ALLOC(addnhostsfile->hosts[idx].hostnames) < 0) - goto alloc_error; - - if (virAsprintf(&addnhostsfile->hosts[idx].ip, "%s", ipstr) < 0) - goto alloc_error; - - addnhostsfile->hosts[idx].nhostnames = 0; - addnhostsfile->nhosts++; - } - - if (VIR_REALLOC_N(addnhostsfile->hosts[idx].hostnames, addnhostsfile->hosts[idx].nhostnames + 1) < 0) - goto alloc_error; - - if (virAsprintf(&addnhostsfile->hosts[idx].hostnames[addnhostsfile->hosts[idx].nhostnames], "%s", name) < 0) - goto alloc_error; - - VIR_FREE(ipstr); - - addnhostsfile->hosts[idx].nhostnames++; - - return 0; - - alloc_error: - virReportOOMError(); - VIR_FREE(ipstr); - return -1; -} - -static dnsmasqAddnHostsfile * -addnhostsNew(const char *name, - const char *config_dir) -{ - dnsmasqAddnHostsfile *addnhostsfile; - - if (VIR_ALLOC(addnhostsfile) < 0) { - virReportOOMError(); - return NULL; - } - - addnhostsfile->hosts = NULL; - addnhostsfile->nhosts = 0; - - if (virAsprintf(&addnhostsfile->path, "%s/%s.%s", config_dir, name, - DNSMASQ_ADDNHOSTSFILE_SUFFIX) < 0) { - virReportOOMError(); - goto error; - } - - return addnhostsfile; - - error: - addnhostsFree(addnhostsfile); - return NULL; -} - -static int -addnhostsWrite(const char *path, - dnsmasqAddnHost *hosts, - unsigned int nhosts) -{ - char *tmp; - FILE *f; - bool istmp = true; - unsigned int i, ii; - int rc = 0; - - /* even if there are 0 hosts, create a 0 length file, to allow - * for runtime addition. - */ - - if (virAsprintf(&tmp, "%s.new", path) < 0) - return -ENOMEM; - - if (!(f = fopen(tmp, "w"))) { - istmp = false; - if (!(f = fopen(path, "w"))) { - rc = -errno; - goto cleanup; - } - } - - for (i = 0; i < nhosts; i++) { - if (fputs(hosts[i].ip, f) == EOF || fputc('\t', f) == EOF) { - rc = -errno; - VIR_FORCE_FCLOSE(f); - - if (istmp) - unlink(tmp); - - goto cleanup; - } - - for (ii = 0; ii < hosts[i].nhostnames; ii++) { - if (fputs(hosts[i].hostnames[ii], f) == EOF || fputc('\t', f) == EOF) { - rc = -errno; - VIR_FORCE_FCLOSE(f); - - if (istmp) - unlink(tmp); - - goto cleanup; - } - } - - if (fputc('\n', f) == EOF) { - rc = -errno; - VIR_FORCE_FCLOSE(f); - - if (istmp) - unlink(tmp); - - goto cleanup; - } - } - - if (VIR_FCLOSE(f) == EOF) { - rc = -errno; - goto cleanup; - } - - if (istmp && rename(tmp, path) < 0) { - rc = -errno; - unlink(tmp); - goto cleanup; - } - - cleanup: - VIR_FREE(tmp); - - return rc; -} - -static int -addnhostsSave(dnsmasqAddnHostsfile *addnhostsfile) -{ - int err = addnhostsWrite(addnhostsfile->path, addnhostsfile->hosts, - addnhostsfile->nhosts); - - if (err < 0) { - virReportSystemError(-err, _("cannot write config file '%s'"), - addnhostsfile->path); - return -1; - } - - return 0; -} - -static int -genericFileDelete(char *path) -{ - if (!virFileExists(path)) - return 0; - - if (unlink(path) < 0) { - virReportSystemError(errno, _("cannot remove config file '%s'"), - path); - return -1; - } - - return 0; -} - -static void -hostsfileFree(dnsmasqHostsfile *hostsfile) -{ - unsigned int i; - - if (hostsfile->hosts) { - for (i = 0; i < hostsfile->nhosts; i++) - dhcphostFree(&hostsfile->hosts[i]); - - VIR_FREE(hostsfile->hosts); - - hostsfile->nhosts = 0; - } - - VIR_FREE(hostsfile->path); - - VIR_FREE(hostsfile); -} - -/* Note: There are many additional dhcp-host specifications - * supported by dnsmasq. There are only the basic ones. - */ -static int -hostsfileAdd(dnsmasqHostsfile *hostsfile, - const char *mac, - virSocketAddr *ip, - const char *name, - bool ipv6) -{ - char *ipstr = NULL; - if (VIR_REALLOC_N(hostsfile->hosts, hostsfile->nhosts + 1) < 0) - goto alloc_error; - - if (!(ipstr = virSocketAddrFormat(ip))) - return -1; - - /* the first test determines if it is a dhcpv6 host */ - if (ipv6) { - if (virAsprintf(&hostsfile->hosts[hostsfile->nhosts].host, "%s,[%s]", - name, ipstr) < 0) - goto alloc_error; - } - else if (name && mac) { - if (virAsprintf(&hostsfile->hosts[hostsfile->nhosts].host, "%s,%s,%s", - mac, ipstr, name) < 0) - goto alloc_error; - } else if (name && !mac){ - if (virAsprintf(&hostsfile->hosts[hostsfile->nhosts].host, "%s,%s", - name, ipstr) < 0) - goto alloc_error; - } else { - if (virAsprintf(&hostsfile->hosts[hostsfile->nhosts].host, "%s,%s", - mac, ipstr) < 0) - goto alloc_error; - } - VIR_FREE(ipstr); - - hostsfile->nhosts++; - - return 0; - - alloc_error: - virReportOOMError(); - VIR_FREE(ipstr); - return -1; -} - -static dnsmasqHostsfile * -hostsfileNew(const char *name, - const char *config_dir) -{ - dnsmasqHostsfile *hostsfile; - - if (VIR_ALLOC(hostsfile) < 0) { - virReportOOMError(); - return NULL; - } - - hostsfile->hosts = NULL; - hostsfile->nhosts = 0; - - if (virAsprintf(&hostsfile->path, "%s/%s.%s", config_dir, name, - DNSMASQ_HOSTSFILE_SUFFIX) < 0) { - virReportOOMError(); - goto error; - } - - return hostsfile; - - error: - hostsfileFree(hostsfile); - return NULL; -} - -static int -hostsfileWrite(const char *path, - dnsmasqDhcpHost *hosts, - unsigned int nhosts) -{ - char *tmp; - FILE *f; - bool istmp = true; - unsigned int i; - int rc = 0; - - /* even if there are 0 hosts, create a 0 length file, to allow - * for runtime addition. - */ - - if (virAsprintf(&tmp, "%s.new", path) < 0) - return -ENOMEM; - - if (!(f = fopen(tmp, "w"))) { - istmp = false; - if (!(f = fopen(path, "w"))) { - rc = -errno; - goto cleanup; - } - } - - for (i = 0; i < nhosts; i++) { - if (fputs(hosts[i].host, f) == EOF || fputc('\n', f) == EOF) { - rc = -errno; - VIR_FORCE_FCLOSE(f); - - if (istmp) - unlink(tmp); - - goto cleanup; - } - } - - if (VIR_FCLOSE(f) == EOF) { - rc = -errno; - goto cleanup; - } - - if (istmp && rename(tmp, path) < 0) { - rc = -errno; - unlink(tmp); - goto cleanup; - } - - cleanup: - VIR_FREE(tmp); - - return rc; -} - -static int -hostsfileSave(dnsmasqHostsfile *hostsfile) -{ - int err = hostsfileWrite(hostsfile->path, hostsfile->hosts, - hostsfile->nhosts); - - if (err < 0) { - virReportSystemError(-err, _("cannot write config file '%s'"), - hostsfile->path); - return -1; - } - - return 0; -} - -/** - * dnsmasqContextNew: - * - * Create a new Dnsmasq context - * - * Returns a pointer to the new structure or NULL in case of error - */ -dnsmasqContext * -dnsmasqContextNew(const char *network_name, - const char *config_dir) -{ - dnsmasqContext *ctx; - - if (VIR_ALLOC(ctx) < 0) { - virReportOOMError(); - return NULL; - } - - if (!(ctx->config_dir = strdup(config_dir))) { - virReportOOMError(); - goto error; - } - - if (!(ctx->hostsfile = hostsfileNew(network_name, config_dir))) - goto error; - if (!(ctx->addnhostsfile = addnhostsNew(network_name, config_dir))) - goto error; - - return ctx; - - error: - dnsmasqContextFree(ctx); - return NULL; -} - -/** - * dnsmasqContextFree: - * @ctx: pointer to the dnsmasq context - * - * Free the resources associated with a dnsmasq context - */ -void -dnsmasqContextFree(dnsmasqContext *ctx) -{ - if (!ctx) - return; - - VIR_FREE(ctx->config_dir); - - if (ctx->hostsfile) - hostsfileFree(ctx->hostsfile); - if (ctx->addnhostsfile) - addnhostsFree(ctx->addnhostsfile); - - VIR_FREE(ctx); -} - -/** - * dnsmasqAddDhcpHost: - * @ctx: pointer to the dnsmasq context for each network - * @mac: pointer to the string contains mac address of the host - * @ip: pointer to the socket address contains ip of the host - * @name: pointer to the string contains hostname of the host or NULL - * - * Add dhcp-host entry. - */ -int -dnsmasqAddDhcpHost(dnsmasqContext *ctx, - const char *mac, - virSocketAddr *ip, - const char *name, - bool ipv6) -{ - return hostsfileAdd(ctx->hostsfile, mac, ip, name, ipv6); -} - -/* - * dnsmasqAddHost: - * @ctx: pointer to the dnsmasq context for each network - * @ip: pointer to the socket address contains ip of the host - * @name: pointer to the string contains hostname of the host - * - * Add additional host entry. - */ - -int -dnsmasqAddHost(dnsmasqContext *ctx, - virSocketAddr *ip, - const char *name) -{ - return addnhostsAdd(ctx->addnhostsfile, ip, name); -} - -/** - * dnsmasqSave: - * @ctx: pointer to the dnsmasq context for each network - * - * Saves all the configurations associated with a context to disk. - */ -int -dnsmasqSave(const dnsmasqContext *ctx) -{ - int ret = 0; - - if (virFileMakePath(ctx->config_dir) < 0) { - virReportSystemError(errno, _("cannot create config directory '%s'"), - ctx->config_dir); - return -1; - } - - if (ctx->hostsfile) - ret = hostsfileSave(ctx->hostsfile); - if (ret == 0) { - if (ctx->addnhostsfile) - ret = addnhostsSave(ctx->addnhostsfile); - } - - return ret; -} - - -/** - * dnsmasqDelete: - * @ctx: pointer to the dnsmasq context for each network - * - * Delete all the configuration files associated with a context. - */ -int -dnsmasqDelete(const dnsmasqContext *ctx) -{ - int ret = 0; - - if (ctx->hostsfile) - ret = genericFileDelete(ctx->hostsfile->path); - if (ctx->addnhostsfile) - ret = genericFileDelete(ctx->addnhostsfile->path); - - return ret; -} - -/** - * dnsmasqReload: - * @pid: the pid of the target dnsmasq process - * - * Reloads all the configurations associated to a context - */ -int -dnsmasqReload(pid_t pid ATTRIBUTE_UNUSED) -{ -#ifndef WIN32 - if (kill(pid, SIGHUP) != 0) { - virReportSystemError(errno, - _("Failed to make dnsmasq (PID: %d) reload config files."), - pid); - return -1; - } -#endif /* WIN32 */ - - return 0; -} - -/* - * dnsmasqCapabilities functions - provide useful information about the - * version of dnsmasq on this machine. - * - */ -struct _dnsmasqCaps { - virObject object; - char *binaryPath; - bool noRefresh; - time_t mtime; - virBitmapPtr flags; - unsigned long version; -}; - -static virClassPtr dnsmasqCapsClass; - -static void -dnsmasqCapsDispose(void *obj) -{ - dnsmasqCapsPtr caps = obj; - - virBitmapFree(caps->flags); - VIR_FREE(caps->binaryPath); -} - -static int dnsmasqCapsOnceInit(void) -{ - if (!(dnsmasqCapsClass = virClassNew("dnsmasqCaps", - sizeof(dnsmasqCaps), - dnsmasqCapsDispose))) { - return -1; - } - - return 0; -} - -VIR_ONCE_GLOBAL_INIT(dnsmasqCaps) - -static void -dnsmasqCapsSet(dnsmasqCapsPtr caps, - dnsmasqCapsFlags flag) -{ - ignore_value(virBitmapSetBit(caps->flags, flag)); -} - - -#define DNSMASQ_VERSION_STR "Dnsmasq version " - -static int -dnsmasqCapsSetFromBuffer(dnsmasqCapsPtr caps, const char *buf) -{ - const char *p; - - caps->noRefresh = true; - - p = STRSKIP(buf, DNSMASQ_VERSION_STR); - if (!p) - goto fail; - virSkipSpaces(&p); - if (virParseVersionString(p, &caps->version, true) < 0) - goto fail; - - if (strstr(buf, "--bind-dynamic")) - dnsmasqCapsSet(caps, DNSMASQ_CAPS_BIND_DYNAMIC); - - VIR_INFO("dnsmasq version is %d.%d, --bind-dynamic is %s", - (int)caps->version / 1000000, (int)(caps->version % 1000000) / 1000, - dnsmasqCapsGet(caps, DNSMASQ_CAPS_BIND_DYNAMIC) - ? "present" : "NOT present"); - return 0; - -fail: - p = strchrnul(buf, '\n'); - virReportError(VIR_ERR_INTERNAL_ERROR, - _("cannot parse %s version number in '%.*s'"), - caps->binaryPath, (int) (p - buf), buf); - return -1; - -} - -static int -dnsmasqCapsSetFromFile(dnsmasqCapsPtr caps, const char *path) -{ - int ret = -1; - char *buf = NULL; - - if (virFileReadAll(path, 1024 * 1024, &buf) < 0) - goto cleanup; - - ret = dnsmasqCapsSetFromBuffer(caps, buf); - -cleanup: - VIR_FREE(buf); - return ret; -} - -static int -dnsmasqCapsRefreshInternal(dnsmasqCapsPtr caps, bool force) -{ - int ret = -1; - struct stat sb; - virCommandPtr cmd = NULL; - char *help = NULL, *version = NULL, *complete = NULL; - - if (!caps || caps->noRefresh) - return 0; - - if (stat(caps->binaryPath, &sb) < 0) { - virReportSystemError(errno, _("Cannot check dnsmasq binary %s"), - caps->binaryPath); - return -1; - } - if (!force && caps->mtime == sb.st_mtime) { - return 0; - } - caps->mtime = sb.st_mtime; - - /* Make sure the binary we are about to try exec'ing exists. - * Technically we could catch the exec() failure, but that's - * in a sub-process so it's hard to feed back a useful error. - */ - if (!virFileIsExecutable(caps->binaryPath)) { - virReportSystemError(errno, _("dnsmasq binary %s is not executable"), - caps->binaryPath); - goto cleanup; - } - - cmd = virCommandNewArgList(caps->binaryPath, "--version", NULL); - virCommandSetOutputBuffer(cmd, &version); - virCommandAddEnvPassCommon(cmd); - virCommandClearCaps(cmd); - if (virCommandRun(cmd, NULL) < 0) { - virReportSystemError(errno, _("failed to run '%s --version': %s"), - caps->binaryPath, version); - goto cleanup; - } - virCommandFree(cmd); - - cmd = virCommandNewArgList(caps->binaryPath, "--help", NULL); - virCommandSetOutputBuffer(cmd, &help); - virCommandAddEnvPassCommon(cmd); - virCommandClearCaps(cmd); - if (virCommandRun(cmd, NULL) < 0) { - virReportSystemError(errno, _("failed to run '%s --help': %s"), - caps->binaryPath, help); - goto cleanup; - } - - if (virAsprintf(&complete, "%s\n%s", version, help) < 0) { - virReportOOMError(); - goto cleanup; - } - - ret = dnsmasqCapsSetFromBuffer(caps, complete); - -cleanup: - virCommandFree(cmd); - VIR_FREE(help); - VIR_FREE(version); - VIR_FREE(complete); - return ret; -} - -static dnsmasqCapsPtr -dnsmasqCapsNewEmpty(const char *binaryPath) -{ - dnsmasqCapsPtr caps; - - if (dnsmasqCapsInitialize() < 0) - return NULL; - if (!(caps = virObjectNew(dnsmasqCapsClass))) - return NULL; - if (!(caps->flags = virBitmapNew(DNSMASQ_CAPS_LAST))) - goto error; - if (!(caps->binaryPath = strdup(binaryPath ? binaryPath : DNSMASQ))) - goto error; - return caps; - -error: - virReportOOMError(); - virObjectUnref(caps); - return NULL; -} - -dnsmasqCapsPtr -dnsmasqCapsNewFromBuffer(const char *buf, const char *binaryPath) -{ - dnsmasqCapsPtr caps = dnsmasqCapsNewEmpty(binaryPath); - - if (!caps) - return NULL; - - if (dnsmasqCapsSetFromBuffer(caps, buf) < 0) { - virObjectUnref(caps); - return NULL; - } - return caps; -} - -dnsmasqCapsPtr -dnsmasqCapsNewFromFile(const char *dataPath, const char *binaryPath) -{ - dnsmasqCapsPtr caps = dnsmasqCapsNewEmpty(binaryPath); - - if (!caps) - return NULL; - - if (dnsmasqCapsSetFromFile(caps, dataPath) < 0) { - virObjectUnref(caps); - return NULL; - } - return caps; -} - -dnsmasqCapsPtr -dnsmasqCapsNewFromBinary(const char *binaryPath) -{ - dnsmasqCapsPtr caps = dnsmasqCapsNewEmpty(binaryPath); - - if (!caps) - return NULL; - - if (dnsmasqCapsRefreshInternal(caps, true) < 0) { - virObjectUnref(caps); - return NULL; - } - return caps; -} - -/** dnsmasqCapsRefresh: - * - * Refresh an existing caps object if the binary has changed. If - * there isn't yet a caps object (if it's NULL), create a new one. - * - * Returns 0 on success, -1 on failure - */ -int -dnsmasqCapsRefresh(dnsmasqCapsPtr *caps, const char *binaryPath) -{ - if (!*caps) { - *caps = dnsmasqCapsNewFromBinary(binaryPath); - return *caps ? 0 : -1; - } - return dnsmasqCapsRefreshInternal(*caps, false); -} - -const char * -dnsmasqCapsGetBinaryPath(dnsmasqCapsPtr caps) -{ - return caps ? caps->binaryPath : DNSMASQ; -} - -unsigned long -dnsmasqCapsGetVersion(dnsmasqCapsPtr caps) -{ - if (caps) - return caps->version; - else - return 0; -} - -bool -dnsmasqCapsGet(dnsmasqCapsPtr caps, dnsmasqCapsFlags flag) -{ - bool b; - - if (!caps || virBitmapGetBit(caps->flags, flag, &b) < 0) - return false; - else - return b; -} diff --git a/src/util/dnsmasq.h b/src/util/dnsmasq.h deleted file mode 100644 index 7a39232..0000000 --- a/src/util/dnsmasq.h +++ /dev/null @@ -1,117 +0,0 @@ -/* - * Copyright (C) 2007-2012 Red Hat, Inc. - * Copyright (C) 2010 Satoru SATOH <satoru.satoh(a)gmail.com&gt; - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * based on iptables.h - */ - -#ifndef __DNSMASQ_H__ -# define __DNSMASQ_H__ - -# include "virobject.h" -# include "virsocketaddr.h" - -typedef struct -{ - /* - * Each entry holds a string, "<mac_addr>,<hostname>,<ip_addr>" such as - * "01:23:45:67:89:0a,foo,10.0.0.3". - */ - char *host; - -} dnsmasqDhcpHost; - -typedef struct -{ - unsigned int nhosts; - dnsmasqDhcpHost *hosts; - - char *path; /* Absolute path of dnsmasq's hostsfile. */ -} dnsmasqHostsfile; - -typedef struct -{ - unsigned int nhostnames; - char *ip; - char **hostnames; - -} dnsmasqAddnHost; - -typedef struct -{ - unsigned int nhosts; - dnsmasqAddnHost *hosts; - - char *path; /* Absolute path of dnsmasq's hostsfile. */ -} dnsmasqAddnHostsfile; - -typedef struct -{ - char *config_dir; - dnsmasqHostsfile *hostsfile; - dnsmasqAddnHostsfile *addnhostsfile; -} dnsmasqContext; - -typedef enum { - DNSMASQ_CAPS_BIND_DYNAMIC = 0, /* support for --bind-dynamic */ - - DNSMASQ_CAPS_LAST, /* this must always be the last item */ -} dnsmasqCapsFlags; - -typedef struct _dnsmasqCaps dnsmasqCaps; -typedef dnsmasqCaps *dnsmasqCapsPtr; - - -dnsmasqContext * dnsmasqContextNew(const char *network_name, - const char *config_dir); -void dnsmasqContextFree(dnsmasqContext *ctx); -int dnsmasqAddDhcpHost(dnsmasqContext *ctx, - const char *mac, - virSocketAddr *ip, - const char *name, - bool ipv6); -int dnsmasqAddHost(dnsmasqContext *ctx, - virSocketAddr *ip, - const char *name); -int dnsmasqSave(const dnsmasqContext *ctx); -int dnsmasqDelete(const dnsmasqContext *ctx); -int dnsmasqReload(pid_t pid); - -dnsmasqCapsPtr dnsmasqCapsNewFromBuffer(const char *buf, - const char *binaryPath); -dnsmasqCapsPtr dnsmasqCapsNewFromFile(const char *dataPath, - const char *binaryPath); -dnsmasqCapsPtr dnsmasqCapsNewFromBinary(const char *binaryPath); -int dnsmasqCapsRefresh(dnsmasqCapsPtr *caps, const char *binaryPath); -bool dnsmasqCapsGet(dnsmasqCapsPtr caps, dnsmasqCapsFlags flag); -const char *dnsmasqCapsGetBinaryPath(dnsmasqCapsPtr caps); -unsigned long dnsmasqCapsGetVersion(dnsmasqCapsPtr caps); - -# define DNSMASQ_DHCPv6_MAJOR_REQD 2 -# define DNSMASQ_DHCPv6_MINOR_REQD 64 -# define DNSMASQ_RA_MAJOR_REQD 2 -# define DNSMASQ_RA_MINOR_REQD 64 - -# define DNSMASQ_DHCPv6_SUPPORT(CAPS) \ - (dnsmasqCapsGetVersion(CAPS) >= \ - (DNSMASQ_DHCPv6_MAJOR_REQD * 1000000) + \ - (DNSMASQ_DHCPv6_MINOR_REQD * 1000)) -# define DNSMASQ_RA_SUPPORT(CAPS) \ - (dnsmasqCapsGetVersion(CAPS) >= \ - (DNSMASQ_RA_MAJOR_REQD * 1000000) + \ - (DNSMASQ_RA_MINOR_REQD * 1000)) -#endif /* __DNSMASQ_H__ */ diff --git a/src/util/virdnsmasq.c b/src/util/virdnsmasq.c new file mode 100644 index 0000000..4a32f49 --- /dev/null +++ b/src/util/virdnsmasq.c @@ -0,0 +1,872 @@ +/* + * Copyright (C) 2007-2012 Red Hat, Inc. + * Copyright (C) 2010 Satoru SATOH <satoru.satoh(a)gmail.com&gt; + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Based on iptables.c + */ + +#include <config.h> + +#include <stdio.h> +#include <stdlib.h> +#include <stdarg.h> +#include <string.h> +#include <errno.h> +#include <limits.h> +#include <unistd.h> +#include <fcntl.h> +#include <sys/types.h> +#include <sys/stat.h> +#include <signal.h> + +#ifdef HAVE_PATHS_H +# include <paths.h> +#endif + +#include "internal.h" +#include "datatypes.h" +#include "virbitmap.h" +#include "virdnsmasq.h" +#include "util.h" +#include "vircommand.h" +#include "memory.h" +#include "virterror_internal.h" +#include "logging.h" +#include "virfile.h" + +#define VIR_FROM_THIS VIR_FROM_NETWORK +#define DNSMASQ_HOSTSFILE_SUFFIX "hostsfile" +#define DNSMASQ_ADDNHOSTSFILE_SUFFIX "addnhosts" + +static void +dhcphostFree(dnsmasqDhcpHost *host) +{ + VIR_FREE(host->host); +} + +static void +addnhostFree(dnsmasqAddnHost *host) +{ + int i; + + for (i = 0; i < host->nhostnames; i++) + VIR_FREE(host->hostnames[i]); + VIR_FREE(host->hostnames); + VIR_FREE(host->ip); +} + +static void +addnhostsFree(dnsmasqAddnHostsfile *addnhostsfile) +{ + unsigned int i; + + if (addnhostsfile->hosts) { + for (i = 0; i < addnhostsfile->nhosts; i++) + addnhostFree(&addnhostsfile->hosts[i]); + + VIR_FREE(addnhostsfile->hosts); + + addnhostsfile->nhosts = 0; + } + + VIR_FREE(addnhostsfile->path); + + VIR_FREE(addnhostsfile); +} + +static int +addnhostsAdd(dnsmasqAddnHostsfile *addnhostsfile, + virSocketAddr *ip, + const char *name) +{ + char *ipstr = NULL; + int idx = -1; + int i; + + if (!(ipstr = virSocketAddrFormat(ip))) + return -1; + + for (i = 0; i < addnhostsfile->nhosts; i++) { + if (STREQ((const char *)addnhostsfile->hosts[i].ip, (const char *)ipstr)) { + idx = i; + break; + } + } + + if (idx < 0) { + if (VIR_REALLOC_N(addnhostsfile->hosts, addnhostsfile->nhosts + 1) < 0) + goto alloc_error; + + idx = addnhostsfile->nhosts; + if (VIR_ALLOC(addnhostsfile->hosts[idx].hostnames) < 0) + goto alloc_error; + + if (virAsprintf(&addnhostsfile->hosts[idx].ip, "%s", ipstr) < 0) + goto alloc_error; + + addnhostsfile->hosts[idx].nhostnames = 0; + addnhostsfile->nhosts++; + } + + if (VIR_REALLOC_N(addnhostsfile->hosts[idx].hostnames, addnhostsfile->hosts[idx].nhostnames + 1) < 0) + goto alloc_error; + + if (virAsprintf(&addnhostsfile->hosts[idx].hostnames[addnhostsfile->hosts[idx].nhostnames], "%s", name) < 0) + goto alloc_error; + + VIR_FREE(ipstr); + + addnhostsfile->hosts[idx].nhostnames++; + + return 0; + + alloc_error: + virReportOOMError(); + VIR_FREE(ipstr); + return -1; +} + +static dnsmasqAddnHostsfile * +addnhostsNew(const char *name, + const char *config_dir) +{ + dnsmasqAddnHostsfile *addnhostsfile; + + if (VIR_ALLOC(addnhostsfile) < 0) { + virReportOOMError(); + return NULL; + } + + addnhostsfile->hosts = NULL; + addnhostsfile->nhosts = 0; + + if (virAsprintf(&addnhostsfile->path, "%s/%s.%s", config_dir, name, + DNSMASQ_ADDNHOSTSFILE_SUFFIX) < 0) { + virReportOOMError(); + goto error; + } + + return addnhostsfile; + + error: + addnhostsFree(addnhostsfile); + return NULL; +} + +static int +addnhostsWrite(const char *path, + dnsmasqAddnHost *hosts, + unsigned int nhosts) +{ + char *tmp; + FILE *f; + bool istmp = true; + unsigned int i, ii; + int rc = 0; + + /* even if there are 0 hosts, create a 0 length file, to allow + * for runtime addition. + */ + + if (virAsprintf(&tmp, "%s.new", path) < 0) + return -ENOMEM; + + if (!(f = fopen(tmp, "w"))) { + istmp = false; + if (!(f = fopen(path, "w"))) { + rc = -errno; + goto cleanup; + } + } + + for (i = 0; i < nhosts; i++) { + if (fputs(hosts[i].ip, f) == EOF || fputc('\t', f) == EOF) { + rc = -errno; + VIR_FORCE_FCLOSE(f); + + if (istmp) + unlink(tmp); + + goto cleanup; + } + + for (ii = 0; ii < hosts[i].nhostnames; ii++) { + if (fputs(hosts[i].hostnames[ii], f) == EOF || fputc('\t', f) == EOF) { + rc = -errno; + VIR_FORCE_FCLOSE(f); + + if (istmp) + unlink(tmp); + + goto cleanup; + } + } + + if (fputc('\n', f) == EOF) { + rc = -errno; + VIR_FORCE_FCLOSE(f); + + if (istmp) + unlink(tmp); + + goto cleanup; + } + } + + if (VIR_FCLOSE(f) == EOF) { + rc = -errno; + goto cleanup; + } + + if (istmp && rename(tmp, path) < 0) { + rc = -errno; + unlink(tmp); + goto cleanup; + } + + cleanup: + VIR_FREE(tmp); + + return rc; +} + +static int +addnhostsSave(dnsmasqAddnHostsfile *addnhostsfile) +{ + int err = addnhostsWrite(addnhostsfile->path, addnhostsfile->hosts, + addnhostsfile->nhosts); + + if (err < 0) { + virReportSystemError(-err, _("cannot write config file '%s'"), + addnhostsfile->path); + return -1; + } + + return 0; +} + +static int +genericFileDelete(char *path) +{ + if (!virFileExists(path)) + return 0; + + if (unlink(path) < 0) { + virReportSystemError(errno, _("cannot remove config file '%s'"), + path); + return -1; + } + + return 0; +} + +static void +hostsfileFree(dnsmasqHostsfile *hostsfile) +{ + unsigned int i; + + if (hostsfile->hosts) { + for (i = 0; i < hostsfile->nhosts; i++) + dhcphostFree(&hostsfile->hosts[i]); + + VIR_FREE(hostsfile->hosts); + + hostsfile->nhosts = 0; + } + + VIR_FREE(hostsfile->path); + + VIR_FREE(hostsfile); +} + +/* Note: There are many additional dhcp-host specifications + * supported by dnsmasq. There are only the basic ones. + */ +static int +hostsfileAdd(dnsmasqHostsfile *hostsfile, + const char *mac, + virSocketAddr *ip, + const char *name, + bool ipv6) +{ + char *ipstr = NULL; + if (VIR_REALLOC_N(hostsfile->hosts, hostsfile->nhosts + 1) < 0) + goto alloc_error; + + if (!(ipstr = virSocketAddrFormat(ip))) + return -1; + + /* the first test determines if it is a dhcpv6 host */ + if (ipv6) { + if (virAsprintf(&hostsfile->hosts[hostsfile->nhosts].host, "%s,[%s]", + name, ipstr) < 0) + goto alloc_error; + } + else if (name && mac) { + if (virAsprintf(&hostsfile->hosts[hostsfile->nhosts].host, "%s,%s,%s", + mac, ipstr, name) < 0) + goto alloc_error; + } else if (name && !mac){ + if (virAsprintf(&hostsfile->hosts[hostsfile->nhosts].host, "%s,%s", + name, ipstr) < 0) + goto alloc_error; + } else { + if (virAsprintf(&hostsfile->hosts[hostsfile->nhosts].host, "%s,%s", + mac, ipstr) < 0) + goto alloc_error; + } + VIR_FREE(ipstr); + + hostsfile->nhosts++; + + return 0; + + alloc_error: + virReportOOMError(); + VIR_FREE(ipstr); + return -1; +} + +static dnsmasqHostsfile * +hostsfileNew(const char *name, + const char *config_dir) +{ + dnsmasqHostsfile *hostsfile; + + if (VIR_ALLOC(hostsfile) < 0) { + virReportOOMError(); + return NULL; + } + + hostsfile->hosts = NULL; + hostsfile->nhosts = 0; + + if (virAsprintf(&hostsfile->path, "%s/%s.%s", config_dir, name, + DNSMASQ_HOSTSFILE_SUFFIX) < 0) { + virReportOOMError(); + goto error; + } + + return hostsfile; + + error: + hostsfileFree(hostsfile); + return NULL; +} + +static int +hostsfileWrite(const char *path, + dnsmasqDhcpHost *hosts, + unsigned int nhosts) +{ + char *tmp; + FILE *f; + bool istmp = true; + unsigned int i; + int rc = 0; + + /* even if there are 0 hosts, create a 0 length file, to allow + * for runtime addition. + */ + + if (virAsprintf(&tmp, "%s.new", path) < 0) + return -ENOMEM; + + if (!(f = fopen(tmp, "w"))) { + istmp = false; + if (!(f = fopen(path, "w"))) { + rc = -errno; + goto cleanup; + } + } + + for (i = 0; i < nhosts; i++) { + if (fputs(hosts[i].host, f) == EOF || fputc('\n', f) == EOF) { + rc = -errno; + VIR_FORCE_FCLOSE(f); + + if (istmp) + unlink(tmp); + + goto cleanup; + } + } + + if (VIR_FCLOSE(f) == EOF) { + rc = -errno; + goto cleanup; + } + + if (istmp && rename(tmp, path) < 0) { + rc = -errno; + unlink(tmp); + goto cleanup; + } + + cleanup: + VIR_FREE(tmp); + + return rc; +} + +static int +hostsfileSave(dnsmasqHostsfile *hostsfile) +{ + int err = hostsfileWrite(hostsfile->path, hostsfile->hosts, + hostsfile->nhosts); + + if (err < 0) { + virReportSystemError(-err, _("cannot write config file '%s'"), + hostsfile->path); + return -1; + } + + return 0; +} + +/** + * dnsmasqContextNew: + * + * Create a new Dnsmasq context + * + * Returns a pointer to the new structure or NULL in case of error + */ +dnsmasqContext * +dnsmasqContextNew(const char *network_name, + const char *config_dir) +{ + dnsmasqContext *ctx; + + if (VIR_ALLOC(ctx) < 0) { + virReportOOMError(); + return NULL; + } + + if (!(ctx->config_dir = strdup(config_dir))) { + virReportOOMError(); + goto error; + } + + if (!(ctx->hostsfile = hostsfileNew(network_name, config_dir))) + goto error; + if (!(ctx->addnhostsfile = addnhostsNew(network_name, config_dir))) + goto error; + + return ctx; + + error: + dnsmasqContextFree(ctx); + return NULL; +} + +/** + * dnsmasqContextFree: + * @ctx: pointer to the dnsmasq context + * + * Free the resources associated with a dnsmasq context + */ +void +dnsmasqContextFree(dnsmasqContext *ctx) +{ + if (!ctx) + return; + + VIR_FREE(ctx->config_dir); + + if (ctx->hostsfile) + hostsfileFree(ctx->hostsfile); + if (ctx->addnhostsfile) + addnhostsFree(ctx->addnhostsfile); + + VIR_FREE(ctx); +} + +/** + * dnsmasqAddDhcpHost: + * @ctx: pointer to the dnsmasq context for each network + * @mac: pointer to the string contains mac address of the host + * @ip: pointer to the socket address contains ip of the host + * @name: pointer to the string contains hostname of the host or NULL + * + * Add dhcp-host entry. + */ +int +dnsmasqAddDhcpHost(dnsmasqContext *ctx, + const char *mac, + virSocketAddr *ip, + const char *name, + bool ipv6) +{ + return hostsfileAdd(ctx->hostsfile, mac, ip, name, ipv6); +} + +/* + * dnsmasqAddHost: + * @ctx: pointer to the dnsmasq context for each network + * @ip: pointer to the socket address contains ip of the host + * @name: pointer to the string contains hostname of the host + * + * Add additional host entry. + */ + +int +dnsmasqAddHost(dnsmasqContext *ctx, + virSocketAddr *ip, + const char *name) +{ + return addnhostsAdd(ctx->addnhostsfile, ip, name); +} + +/** + * dnsmasqSave: + * @ctx: pointer to the dnsmasq context for each network + * + * Saves all the configurations associated with a context to disk. + */ +int +dnsmasqSave(const dnsmasqContext *ctx) +{ + int ret = 0; + + if (virFileMakePath(ctx->config_dir) < 0) { + virReportSystemError(errno, _("cannot create config directory '%s'"), + ctx->config_dir); + return -1; + } + + if (ctx->hostsfile) + ret = hostsfileSave(ctx->hostsfile); + if (ret == 0) { + if (ctx->addnhostsfile) + ret = addnhostsSave(ctx->addnhostsfile); + } + + return ret; +} + + +/** + * dnsmasqDelete: + * @ctx: pointer to the dnsmasq context for each network + * + * Delete all the configuration files associated with a context. + */ +int +dnsmasqDelete(const dnsmasqContext *ctx) +{ + int ret = 0; + + if (ctx->hostsfile) + ret = genericFileDelete(ctx->hostsfile->path); + if (ctx->addnhostsfile) + ret = genericFileDelete(ctx->addnhostsfile->path); + + return ret; +} + +/** + * dnsmasqReload: + * @pid: the pid of the target dnsmasq process + * + * Reloads all the configurations associated to a context + */ +int +dnsmasqReload(pid_t pid ATTRIBUTE_UNUSED) +{ +#ifndef WIN32 + if (kill(pid, SIGHUP) != 0) { + virReportSystemError(errno, + _("Failed to make dnsmasq (PID: %d) reload config files."), + pid); + return -1; + } +#endif /* WIN32 */ + + return 0; +} + +/* + * dnsmasqCapabilities functions - provide useful information about the + * version of dnsmasq on this machine. + * + */ +struct _dnsmasqCaps { + virObject object; + char *binaryPath; + bool noRefresh; + time_t mtime; + virBitmapPtr flags; + unsigned long version; +}; + +static virClassPtr dnsmasqCapsClass; + +static void +dnsmasqCapsDispose(void *obj) +{ + dnsmasqCapsPtr caps = obj; + + virBitmapFree(caps->flags); + VIR_FREE(caps->binaryPath); +} + +static int dnsmasqCapsOnceInit(void) +{ + if (!(dnsmasqCapsClass = virClassNew("dnsmasqCaps", + sizeof(dnsmasqCaps), + dnsmasqCapsDispose))) { + return -1; + } + + return 0; +} + +VIR_ONCE_GLOBAL_INIT(dnsmasqCaps) + +static void +dnsmasqCapsSet(dnsmasqCapsPtr caps, + dnsmasqCapsFlags flag) +{ + ignore_value(virBitmapSetBit(caps->flags, flag)); +} + + +#define DNSMASQ_VERSION_STR "Dnsmasq version " + +static int +dnsmasqCapsSetFromBuffer(dnsmasqCapsPtr caps, const char *buf) +{ + const char *p; + + caps->noRefresh = true; + + p = STRSKIP(buf, DNSMASQ_VERSION_STR); + if (!p) + goto fail; + virSkipSpaces(&p); + if (virParseVersionString(p, &caps->version, true) < 0) + goto fail; + + if (strstr(buf, "--bind-dynamic")) + dnsmasqCapsSet(caps, DNSMASQ_CAPS_BIND_DYNAMIC); + + VIR_INFO("dnsmasq version is %d.%d, --bind-dynamic is %s", + (int)caps->version / 1000000, (int)(caps->version % 1000000) / 1000, + dnsmasqCapsGet(caps, DNSMASQ_CAPS_BIND_DYNAMIC) + ? "present" : "NOT present"); + return 0; + +fail: + p = strchrnul(buf, '\n'); + virReportError(VIR_ERR_INTERNAL_ERROR, + _("cannot parse %s version number in '%.*s'"), + caps->binaryPath, (int) (p - buf), buf); + return -1; + +} + +static int +dnsmasqCapsSetFromFile(dnsmasqCapsPtr caps, const char *path) +{ + int ret = -1; + char *buf = NULL; + + if (virFileReadAll(path, 1024 * 1024, &buf) < 0) + goto cleanup; + + ret = dnsmasqCapsSetFromBuffer(caps, buf); + +cleanup: + VIR_FREE(buf); + return ret; +} + +static int +dnsmasqCapsRefreshInternal(dnsmasqCapsPtr caps, bool force) +{ + int ret = -1; + struct stat sb; + virCommandPtr cmd = NULL; + char *help = NULL, *version = NULL, *complete = NULL; + + if (!caps || caps->noRefresh) + return 0; + + if (stat(caps->binaryPath, &sb) < 0) { + virReportSystemError(errno, _("Cannot check dnsmasq binary %s"), + caps->binaryPath); + return -1; + } + if (!force && caps->mtime == sb.st_mtime) { + return 0; + } + caps->mtime = sb.st_mtime; + + /* Make sure the binary we are about to try exec'ing exists. + * Technically we could catch the exec() failure, but that's + * in a sub-process so it's hard to feed back a useful error. + */ + if (!virFileIsExecutable(caps->binaryPath)) { + virReportSystemError(errno, _("dnsmasq binary %s is not executable"), + caps->binaryPath); + goto cleanup; + } + + cmd = virCommandNewArgList(caps->binaryPath, "--version", NULL); + virCommandSetOutputBuffer(cmd, &version); + virCommandAddEnvPassCommon(cmd); + virCommandClearCaps(cmd); + if (virCommandRun(cmd, NULL) < 0) { + virReportSystemError(errno, _("failed to run '%s --version': %s"), + caps->binaryPath, version); + goto cleanup; + } + virCommandFree(cmd); + + cmd = virCommandNewArgList(caps->binaryPath, "--help", NULL); + virCommandSetOutputBuffer(cmd, &help); + virCommandAddEnvPassCommon(cmd); + virCommandClearCaps(cmd); + if (virCommandRun(cmd, NULL) < 0) { + virReportSystemError(errno, _("failed to run '%s --help': %s"), + caps->binaryPath, help); + goto cleanup; + } + + if (virAsprintf(&complete, "%s\n%s", version, help) < 0) { + virReportOOMError(); + goto cleanup; + } + + ret = dnsmasqCapsSetFromBuffer(caps, complete); + +cleanup: + virCommandFree(cmd); + VIR_FREE(help); + VIR_FREE(version); + VIR_FREE(complete); + return ret; +} + +static dnsmasqCapsPtr +dnsmasqCapsNewEmpty(const char *binaryPath) +{ + dnsmasqCapsPtr caps; + + if (dnsmasqCapsInitialize() < 0) + return NULL; + if (!(caps = virObjectNew(dnsmasqCapsClass))) + return NULL; + if (!(caps->flags = virBitmapNew(DNSMASQ_CAPS_LAST))) + goto error; + if (!(caps->binaryPath = strdup(binaryPath ? binaryPath : DNSMASQ))) + goto error; + return caps; + +error: + virReportOOMError(); + virObjectUnref(caps); + return NULL; +} + +dnsmasqCapsPtr +dnsmasqCapsNewFromBuffer(const char *buf, const char *binaryPath) +{ + dnsmasqCapsPtr caps = dnsmasqCapsNewEmpty(binaryPath); + + if (!caps) + return NULL; + + if (dnsmasqCapsSetFromBuffer(caps, buf) < 0) { + virObjectUnref(caps); + return NULL; + } + return caps; +} + +dnsmasqCapsPtr +dnsmasqCapsNewFromFile(const char *dataPath, const char *binaryPath) +{ + dnsmasqCapsPtr caps = dnsmasqCapsNewEmpty(binaryPath); + + if (!caps) + return NULL; + + if (dnsmasqCapsSetFromFile(caps, dataPath) < 0) { + virObjectUnref(caps); + return NULL; + } + return caps; +} + +dnsmasqCapsPtr +dnsmasqCapsNewFromBinary(const char *binaryPath) +{ + dnsmasqCapsPtr caps = dnsmasqCapsNewEmpty(binaryPath); + + if (!caps) + return NULL; + + if (dnsmasqCapsRefreshInternal(caps, true) < 0) { + virObjectUnref(caps); + return NULL; + } + return caps; +} + +/** dnsmasqCapsRefresh: + * + * Refresh an existing caps object if the binary has changed. If + * there isn't yet a caps object (if it's NULL), create a new one. + * + * Returns 0 on success, -1 on failure + */ +int +dnsmasqCapsRefresh(dnsmasqCapsPtr *caps, const char *binaryPath) +{ + if (!*caps) { + *caps = dnsmasqCapsNewFromBinary(binaryPath); + return *caps ? 0 : -1; + } + return dnsmasqCapsRefreshInternal(*caps, false); +} + +const char * +dnsmasqCapsGetBinaryPath(dnsmasqCapsPtr caps) +{ + return caps ? caps->binaryPath : DNSMASQ; +} + +unsigned long +dnsmasqCapsGetVersion(dnsmasqCapsPtr caps) +{ + if (caps) + return caps->version; + else + return 0; +} + +bool +dnsmasqCapsGet(dnsmasqCapsPtr caps, dnsmasqCapsFlags flag) +{ + bool b; + + if (!caps || virBitmapGetBit(caps->flags, flag, &b) < 0) + return false; + else + return b; +} diff --git a/src/util/virdnsmasq.h b/src/util/virdnsmasq.h new file mode 100644 index 0000000..7a39232 --- /dev/null +++ b/src/util/virdnsmasq.h @@ -0,0 +1,117 @@ +/* + * Copyright (C) 2007-2012 Red Hat, Inc. + * Copyright (C) 2010 Satoru SATOH <satoru.satoh(a)gmail.com&gt; + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * based on iptables.h + */ + +#ifndef __DNSMASQ_H__ +# define __DNSMASQ_H__ + +# include "virobject.h" +# include "virsocketaddr.h" + +typedef struct +{ + /* + * Each entry holds a string, "<mac_addr>,<hostname>,<ip_addr>" such as + * "01:23:45:67:89:0a,foo,10.0.0.3". + */ + char *host; + +} dnsmasqDhcpHost; + +typedef struct +{ + unsigned int nhosts; + dnsmasqDhcpHost *hosts; + + char *path; /* Absolute path of dnsmasq's hostsfile. */ +} dnsmasqHostsfile; + +typedef struct +{ + unsigned int nhostnames; + char *ip; + char **hostnames; + +} dnsmasqAddnHost; + +typedef struct +{ + unsigned int nhosts; + dnsmasqAddnHost *hosts; + + char *path; /* Absolute path of dnsmasq's hostsfile. */ +} dnsmasqAddnHostsfile; + +typedef struct +{ + char *config_dir; + dnsmasqHostsfile *hostsfile; + dnsmasqAddnHostsfile *addnhostsfile; +} dnsmasqContext; + +typedef enum { + DNSMASQ_CAPS_BIND_DYNAMIC = 0, /* support for --bind-dynamic */ + + DNSMASQ_CAPS_LAST, /* this must always be the last item */ +} dnsmasqCapsFlags; + +typedef struct _dnsmasqCaps dnsmasqCaps; +typedef dnsmasqCaps *dnsmasqCapsPtr; + + +dnsmasqContext * dnsmasqContextNew(const char *network_name, + const char *config_dir); +void dnsmasqContextFree(dnsmasqContext *ctx); +int dnsmasqAddDhcpHost(dnsmasqContext *ctx, + const char *mac, + virSocketAddr *ip, + const char *name, + bool ipv6); +int dnsmasqAddHost(dnsmasqContext *ctx, + virSocketAddr *ip, + const char *name); +int dnsmasqSave(const dnsmasqContext *ctx); +int dnsmasqDelete(const dnsmasqContext *ctx); +int dnsmasqReload(pid_t pid); + +dnsmasqCapsPtr dnsmasqCapsNewFromBuffer(const char *buf, + const char *binaryPath); +dnsmasqCapsPtr dnsmasqCapsNewFromFile(const char *dataPath, + const char *binaryPath); +dnsmasqCapsPtr dnsmasqCapsNewFromBinary(const char *binaryPath); +int dnsmasqCapsRefresh(dnsmasqCapsPtr *caps, const char *binaryPath); +bool dnsmasqCapsGet(dnsmasqCapsPtr caps, dnsmasqCapsFlags flag); +const char *dnsmasqCapsGetBinaryPath(dnsmasqCapsPtr caps); +unsigned long dnsmasqCapsGetVersion(dnsmasqCapsPtr caps); + +# define DNSMASQ_DHCPv6_MAJOR_REQD 2 +# define DNSMASQ_DHCPv6_MINOR_REQD 64 +# define DNSMASQ_RA_MAJOR_REQD 2 +# define DNSMASQ_RA_MINOR_REQD 64 + +# define DNSMASQ_DHCPv6_SUPPORT(CAPS) \ + (dnsmasqCapsGetVersion(CAPS) >= \ + (DNSMASQ_DHCPv6_MAJOR_REQD * 1000000) + \ + (DNSMASQ_DHCPv6_MINOR_REQD * 1000)) +# define DNSMASQ_RA_SUPPORT(CAPS) \ + (dnsmasqCapsGetVersion(CAPS) >= \ + (DNSMASQ_RA_MAJOR_REQD * 1000000) + \ + (DNSMASQ_RA_MINOR_REQD * 1000)) +#endif /* __DNSMASQ_H__ */ -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; Since the event APIs are now in the public header, no internal code should include virevent.h --- src/Makefile.am | 2 +- src/rpc/virnetclientstream.c | 1 - src/rpc/virnetserver.c | 1 - src/rpc/virnetservermdns.c | 1 - src/rpc/virnetsocket.c | 1 - src/util/event.c | 253 ------------------------------------------- src/util/event.h | 28 ----- src/util/virevent.c | 253 +++++++++++++++++++++++++++++++++++++++++++ src/util/virevent.h | 28 +++++ tests/eventtest.c | 1 - 10 files changed, 282 insertions(+), 287 deletions(-) delete mode 100644 src/util/event.c delete mode 100644 src/util/event.h create mode 100644 src/util/virevent.c create mode 100644 src/util/virevent.h diff --git a/src/Makefile.am b/src/Makefile.am index daefa95..5c0d668 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -53,7 +53,6 @@ augeastest_DATA = # These files are not related to driver APIs. Simply generic # helper APIs for various purposes UTIL_SOURCES = \ - util/event.c util/event.h \ util/event_poll.c util/event_poll.h \ util/hooks.c util/hooks.h \ util/iptables.c util/iptables.h \ @@ -83,6 +82,7 @@ UTIL_SOURCES = \ util/virconf.c util/virconf.h \ util/virdnsmasq.c util/virdnsmasq.h \ util/virebtables.c util/virebtables.h \ + util/virevent.c util/virevent.h \ util/virfile.c util/virfile.h \ util/virnodesuspend.c util/virnodesuspend.h \ util/virobject.c util/virobject.h \ diff --git a/src/rpc/virnetclientstream.c b/src/rpc/virnetclientstream.c index 4ed40ca..0e7e38e 100644 --- a/src/rpc/virnetclientstream.c +++ b/src/rpc/virnetclientstream.c @@ -27,7 +27,6 @@ #include "memory.h" #include "virterror_internal.h" #include "logging.h" -#include "event.h" #include "threads.h" #define VIR_FROM_THIS VIR_FROM_RPC diff --git a/src/rpc/virnetserver.c b/src/rpc/virnetserver.c index 6a5a53a..f686a8f 100644 --- a/src/rpc/virnetserver.c +++ b/src/rpc/virnetserver.c @@ -35,7 +35,6 @@ #include "threadpool.h" #include "util.h" #include "virfile.h" -#include "event.h" #include "virnetservermdns.h" #include "virdbus.h" diff --git a/src/rpc/virnetservermdns.c b/src/rpc/virnetservermdns.c index b55d403..0ddb9d8 100644 --- a/src/rpc/virnetservermdns.c +++ b/src/rpc/virnetservermdns.c @@ -41,7 +41,6 @@ #endif #include "virnetservermdns.h" -#include "event.h" #include "event_poll.h" #include "memory.h" #include "virterror_internal.h" diff --git a/src/rpc/virnetsocket.c b/src/rpc/virnetsocket.c index 70c621f..5a2eab3 100644 --- a/src/rpc/virnetsocket.c +++ b/src/rpc/virnetsocket.c @@ -46,7 +46,6 @@ #include "virterror_internal.h" #include "logging.h" #include "virfile.h" -#include "event.h" #include "threads.h" #include "virprocess.h" diff --git a/src/util/event.c b/src/util/event.c deleted file mode 100644 index 0abc30b..0000000 --- a/src/util/event.c +++ /dev/null @@ -1,253 +0,0 @@ -/* - * event.c: event loop for monitoring file handles - * - * Copyright (C) 2007, 2011 Red Hat, Inc. - * Copyright (C) 2007 Daniel P. Berrange - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Author: Daniel P. Berrange <berrange(a)redhat.com&gt; - */ - -#include <config.h> - -#include "event.h" -#include "event_poll.h" -#include "logging.h" -#include "virterror_internal.h" - -#include <stdlib.h> - -static virEventAddHandleFunc addHandleImpl = NULL; -static virEventUpdateHandleFunc updateHandleImpl = NULL; -static virEventRemoveHandleFunc removeHandleImpl = NULL; -static virEventAddTimeoutFunc addTimeoutImpl = NULL; -static virEventUpdateTimeoutFunc updateTimeoutImpl = NULL; -static virEventRemoveTimeoutFunc removeTimeoutImpl = NULL; - -/** - * virEventAddHandle: register a callback for monitoring file handle events - * - * @fd: file handle to monitor for events - * @events: bitset of events to watch from virEventHandleType constants - * @cb: callback to invoke when an event occurs - * @opaque: user data to pass to callback - * - * returns -1 if the file handle cannot be registered, 0 upon success - */ -int virEventAddHandle(int fd, - int events, - virEventHandleCallback cb, - void *opaque, - virFreeCallback ff) { - if (!addHandleImpl) - return -1; - - return addHandleImpl(fd, events, cb, opaque, ff); -} - -/** - * virEventUpdateHandle: change event set for a monitored file handle - * - * @watch: watch whose file handle to update - * @events: bitset of events to watch from virEventHandleType constants - * - * Will not fail if fd exists - */ -void virEventUpdateHandle(int watch, int events) { - updateHandleImpl(watch, events); -} - -/** - * virEventRemoveHandle: unregister a callback from a file handle - * - * @watch: watch whose file handle to remove - * - * returns -1 if the file handle was not registered, 0 upon success - */ -int virEventRemoveHandle(int watch) { - if (!removeHandleImpl) - return -1; - - return removeHandleImpl(watch); -} - -/** - * virEventAddTimeout: register a callback for a timer event - * - * @timeout: time between events in milliseconds - * @cb: callback to invoke when an event occurs - * @opaque: user data to pass to callback - * - * Setting timeout to -1 will disable the timer. Setting the timeout - * to zero will cause it to fire on every event loop iteration. - * - * returns -1 if the timer cannot be registered, a positive - * integer timer id upon success - */ -int virEventAddTimeout(int timeout, - virEventTimeoutCallback cb, - void *opaque, - virFreeCallback ff) { - if (!addTimeoutImpl) - return -1; - - return addTimeoutImpl(timeout, cb, opaque, ff); -} - -/** - * virEventUpdateTimeoutImpl: change frequency for a timer - * - * @timer: timer id to change - * @frequency: time between events in milliseconds - * - * Setting frequency to -1 will disable the timer. Setting the frequency - * to zero will cause it to fire on every event loop iteration. - * - * Will not fail if timer exists - */ -void virEventUpdateTimeout(int timer, int timeout) { - updateTimeoutImpl(timer, timeout); -} - -/** - * virEventRemoveTimeout: unregister a callback for a timer - * - * @timer: the timer id to remove - * - * returns -1 if the timer was not registered, 0 upon success - */ -int virEventRemoveTimeout(int timer) { - if (!removeTimeoutImpl) - return -1; - - return removeTimeoutImpl(timer); -} - - -/***************************************************** - * - * Below this point are 3 *PUBLIC* APIs for event - * loop integration with applications using libvirt. - * These API contracts cannot be changed. - * - *****************************************************/ - -/** - * virEventRegisterImpl: - * @addHandle: the callback to add fd handles - * @updateHandle: the callback to update fd handles - * @removeHandle: the callback to remove fd handles - * @addTimeout: the callback to add a timeout - * @updateTimeout: the callback to update a timeout - * @removeTimeout: the callback to remove a timeout - * - * Registers an event implementation, to allow integration - * with an external event loop. Applications would use this - * to integrate with the libglib2 event loop, or libevent - * or the QT event loop. - * - * If an application does not need to integrate with an - * existing event loop implementation, then the - * virEventRegisterDefaultImpl method can be used to setup - * the generic libvirt implementation. - */ -void virEventRegisterImpl(virEventAddHandleFunc addHandle, - virEventUpdateHandleFunc updateHandle, - virEventRemoveHandleFunc removeHandle, - virEventAddTimeoutFunc addTimeout, - virEventUpdateTimeoutFunc updateTimeout, - virEventRemoveTimeoutFunc removeTimeout) -{ - VIR_DEBUG("addHandle=%p updateHandle=%p removeHandle=%p " - "addTimeout=%p updateTimeout=%p removeTimeout=%p", - addHandle, updateHandle, removeHandle, - addTimeout, updateTimeout, removeTimeout); - - addHandleImpl = addHandle; - updateHandleImpl = updateHandle; - removeHandleImpl = removeHandle; - addTimeoutImpl = addTimeout; - updateTimeoutImpl = updateTimeout; - removeTimeoutImpl = removeTimeout; -} - -/** - * virEventRegisterDefaultImpl: - * - * Registers a default event implementation based on the - * poll() system call. This is a generic implementation - * that can be used by any client application which does - * not have a need to integrate with an external event - * loop impl. - * - * Once registered, the application has to invoke virEventRunDefaultImpl in - * a loop to process events. Failure to do so may result in connections being - * closed unexpectedly as a result of keepalive timeout. - * - * Returns 0 on success, -1 on failure. - */ -int virEventRegisterDefaultImpl(void) -{ - VIR_DEBUG("registering default event implementation"); - - virResetLastError(); - - if (virEventPollInit() < 0) { - virDispatchError(NULL); - return -1; - } - - virEventRegisterImpl( - virEventPollAddHandle, - virEventPollUpdateHandle, - virEventPollRemoveHandle, - virEventPollAddTimeout, - virEventPollUpdateTimeout, - virEventPollRemoveTimeout - ); - - return 0; -} - - -/** - * virEventRunDefaultImpl: - * - * Run one iteration of the event loop. Applications - * will generally want to have a thread which invokes - * this method in an infinite loop - * - * static bool quit = false; - * - * while (!quit) { - * if (virEventRunDefaultImpl() < 0) - * ...print error... - * } - * - * Returns 0 on success, -1 on failure. - */ -int virEventRunDefaultImpl(void) -{ - VIR_DEBUG("running default event implementation"); - virResetLastError(); - - if (virEventPollRunOnce() < 0) { - virDispatchError(NULL); - return -1; - } - - return 0; -} diff --git a/src/util/event.h b/src/util/event.h deleted file mode 100644 index 5ab567a..0000000 --- a/src/util/event.h +++ /dev/null @@ -1,28 +0,0 @@ -/* - * event.h: event loop for monitoring file handles - * - * Copyright (C) 2007 Daniel P. Berrange - * Copyright (C) 2007 Red Hat, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Author: Daniel P. Berrange <berrange(a)redhat.com&gt; - */ - -#ifndef __VIR_EVENT_H__ -# define __VIR_EVENT_H__ -# include "internal.h" - -#endif /* __VIR_EVENT_H__ */ diff --git a/src/util/virevent.c b/src/util/virevent.c new file mode 100644 index 0000000..08b7006 --- /dev/null +++ b/src/util/virevent.c @@ -0,0 +1,253 @@ +/* + * event.c: event loop for monitoring file handles + * + * Copyright (C) 2007, 2011 Red Hat, Inc. + * Copyright (C) 2007 Daniel P. Berrange + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Author: Daniel P. Berrange <berrange(a)redhat.com&gt; + */ + +#include <config.h> + +#include "virevent.h" +#include "event_poll.h" +#include "logging.h" +#include "virterror_internal.h" + +#include <stdlib.h> + +static virEventAddHandleFunc addHandleImpl = NULL; +static virEventUpdateHandleFunc updateHandleImpl = NULL; +static virEventRemoveHandleFunc removeHandleImpl = NULL; +static virEventAddTimeoutFunc addTimeoutImpl = NULL; +static virEventUpdateTimeoutFunc updateTimeoutImpl = NULL; +static virEventRemoveTimeoutFunc removeTimeoutImpl = NULL; + +/** + * virEventAddHandle: register a callback for monitoring file handle events + * + * @fd: file handle to monitor for events + * @events: bitset of events to watch from virEventHandleType constants + * @cb: callback to invoke when an event occurs + * @opaque: user data to pass to callback + * + * returns -1 if the file handle cannot be registered, 0 upon success + */ +int virEventAddHandle(int fd, + int events, + virEventHandleCallback cb, + void *opaque, + virFreeCallback ff) { + if (!addHandleImpl) + return -1; + + return addHandleImpl(fd, events, cb, opaque, ff); +} + +/** + * virEventUpdateHandle: change event set for a monitored file handle + * + * @watch: watch whose file handle to update + * @events: bitset of events to watch from virEventHandleType constants + * + * Will not fail if fd exists + */ +void virEventUpdateHandle(int watch, int events) { + updateHandleImpl(watch, events); +} + +/** + * virEventRemoveHandle: unregister a callback from a file handle + * + * @watch: watch whose file handle to remove + * + * returns -1 if the file handle was not registered, 0 upon success + */ +int virEventRemoveHandle(int watch) { + if (!removeHandleImpl) + return -1; + + return removeHandleImpl(watch); +} + +/** + * virEventAddTimeout: register a callback for a timer event + * + * @timeout: time between events in milliseconds + * @cb: callback to invoke when an event occurs + * @opaque: user data to pass to callback + * + * Setting timeout to -1 will disable the timer. Setting the timeout + * to zero will cause it to fire on every event loop iteration. + * + * returns -1 if the timer cannot be registered, a positive + * integer timer id upon success + */ +int virEventAddTimeout(int timeout, + virEventTimeoutCallback cb, + void *opaque, + virFreeCallback ff) { + if (!addTimeoutImpl) + return -1; + + return addTimeoutImpl(timeout, cb, opaque, ff); +} + +/** + * virEventUpdateTimeoutImpl: change frequency for a timer + * + * @timer: timer id to change + * @frequency: time between events in milliseconds + * + * Setting frequency to -1 will disable the timer. Setting the frequency + * to zero will cause it to fire on every event loop iteration. + * + * Will not fail if timer exists + */ +void virEventUpdateTimeout(int timer, int timeout) { + updateTimeoutImpl(timer, timeout); +} + +/** + * virEventRemoveTimeout: unregister a callback for a timer + * + * @timer: the timer id to remove + * + * returns -1 if the timer was not registered, 0 upon success + */ +int virEventRemoveTimeout(int timer) { + if (!removeTimeoutImpl) + return -1; + + return removeTimeoutImpl(timer); +} + + +/***************************************************** + * + * Below this point are 3 *PUBLIC* APIs for event + * loop integration with applications using libvirt. + * These API contracts cannot be changed. + * + *****************************************************/ + +/** + * virEventRegisterImpl: + * @addHandle: the callback to add fd handles + * @updateHandle: the callback to update fd handles + * @removeHandle: the callback to remove fd handles + * @addTimeout: the callback to add a timeout + * @updateTimeout: the callback to update a timeout + * @removeTimeout: the callback to remove a timeout + * + * Registers an event implementation, to allow integration + * with an external event loop. Applications would use this + * to integrate with the libglib2 event loop, or libevent + * or the QT event loop. + * + * If an application does not need to integrate with an + * existing event loop implementation, then the + * virEventRegisterDefaultImpl method can be used to setup + * the generic libvirt implementation. + */ +void virEventRegisterImpl(virEventAddHandleFunc addHandle, + virEventUpdateHandleFunc updateHandle, + virEventRemoveHandleFunc removeHandle, + virEventAddTimeoutFunc addTimeout, + virEventUpdateTimeoutFunc updateTimeout, + virEventRemoveTimeoutFunc removeTimeout) +{ + VIR_DEBUG("addHandle=%p updateHandle=%p removeHandle=%p " + "addTimeout=%p updateTimeout=%p removeTimeout=%p", + addHandle, updateHandle, removeHandle, + addTimeout, updateTimeout, removeTimeout); + + addHandleImpl = addHandle; + updateHandleImpl = updateHandle; + removeHandleImpl = removeHandle; + addTimeoutImpl = addTimeout; + updateTimeoutImpl = updateTimeout; + removeTimeoutImpl = removeTimeout; +} + +/** + * virEventRegisterDefaultImpl: + * + * Registers a default event implementation based on the + * poll() system call. This is a generic implementation + * that can be used by any client application which does + * not have a need to integrate with an external event + * loop impl. + * + * Once registered, the application has to invoke virEventRunDefaultImpl in + * a loop to process events. Failure to do so may result in connections being + * closed unexpectedly as a result of keepalive timeout. + * + * Returns 0 on success, -1 on failure. + */ +int virEventRegisterDefaultImpl(void) +{ + VIR_DEBUG("registering default event implementation"); + + virResetLastError(); + + if (virEventPollInit() < 0) { + virDispatchError(NULL); + return -1; + } + + virEventRegisterImpl( + virEventPollAddHandle, + virEventPollUpdateHandle, + virEventPollRemoveHandle, + virEventPollAddTimeout, + virEventPollUpdateTimeout, + virEventPollRemoveTimeout + ); + + return 0; +} + + +/** + * virEventRunDefaultImpl: + * + * Run one iteration of the event loop. Applications + * will generally want to have a thread which invokes + * this method in an infinite loop + * + * static bool quit = false; + * + * while (!quit) { + * if (virEventRunDefaultImpl() < 0) + * ...print error... + * } + * + * Returns 0 on success, -1 on failure. + */ +int virEventRunDefaultImpl(void) +{ + VIR_DEBUG("running default event implementation"); + virResetLastError(); + + if (virEventPollRunOnce() < 0) { + virDispatchError(NULL); + return -1; + } + + return 0; +} diff --git a/src/util/virevent.h b/src/util/virevent.h new file mode 100644 index 0000000..5ab567a --- /dev/null +++ b/src/util/virevent.h @@ -0,0 +1,28 @@ +/* + * event.h: event loop for monitoring file handles + * + * Copyright (C) 2007 Daniel P. Berrange + * Copyright (C) 2007 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Author: Daniel P. Berrange <berrange(a)redhat.com&gt; + */ + +#ifndef __VIR_EVENT_H__ +# define __VIR_EVENT_H__ +# include "internal.h" + +#endif /* __VIR_EVENT_H__ */ diff --git a/tests/eventtest.c b/tests/eventtest.c index 78f51b7..c087978 100644 --- a/tests/eventtest.c +++ b/tests/eventtest.c @@ -31,7 +31,6 @@ #include "threads.h" #include "logging.h" #include "util.h" -#include "event.h" #include "event_poll.h" #define NUM_FDS 31 -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- daemon/libvirtd.c | 2 +- po/POTFILES.in | 2 +- src/Makefile.am | 2 +- src/lxc/lxc_driver.c | 2 +- src/lxc/lxc_process.c | 2 +- src/qemu/qemu_driver.c | 2 +- src/qemu/qemu_migration.c | 2 +- src/qemu/qemu_process.c | 2 +- src/util/hooks.c | 293 ---------------------------------------------- src/util/hooks.h | 85 -------------- src/util/virhooks.c | 293 ++++++++++++++++++++++++++++++++++++++++++++++ src/util/virhooks.h | 85 ++++++++++++++ 12 files changed, 386 insertions(+), 386 deletions(-) delete mode 100644 src/util/hooks.c delete mode 100644 src/util/hooks.h create mode 100644 src/util/virhooks.c create mode 100644 src/util/virhooks.h diff --git a/daemon/libvirtd.c b/daemon/libvirtd.c index 9b0e45a..fbf23d8 100644 --- a/daemon/libvirtd.c +++ b/daemon/libvirtd.c @@ -53,7 +53,7 @@ #include "threads.h" #include "remote.h" #include "remote_driver.h" -#include "hooks.h" +#include "virhooks.h" #include "uuid.h" #include "viraudit.h" #include "locking/lock_manager.h" diff --git a/po/POTFILES.in b/po/POTFILES.in index 818bb4e..18d96c8 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -137,7 +137,6 @@ src/storage/storage_driver.c src/test/test_driver.c src/uml/uml_conf.c src/uml/uml_driver.c -src/util/hooks.c src/util/hostusb.c src/util/iohelper.c src/util/iptables.c @@ -160,6 +159,7 @@ src/util/virdnsmasq.c src/util/vireventpoll.c src/util/virfile.c src/util/virhash.c +src/util/virhooks.c src/util/virinitctl.c src/util/virkeyfile.c src/util/virlockspace.c diff --git a/src/Makefile.am b/src/Makefile.am index f803de0..07ace32 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -53,7 +53,6 @@ augeastest_DATA = # These files are not related to driver APIs. Simply generic # helper APIs for various purposes UTIL_SOURCES = \ - util/hooks.c util/hooks.h \ util/iptables.c util/iptables.h \ util/json.c util/json.h \ util/logging.c util/logging.h \ @@ -84,6 +83,7 @@ UTIL_SOURCES = \ util/virevent.c util/virevent.h \ util/vireventpoll.c util/vireventpoll.h \ util/virfile.c util/virfile.h \ + util/virhooks.c util/virhooks.h \ util/virnodesuspend.c util/virnodesuspend.h \ util/virobject.c util/virobject.h \ util/virpidfile.c util/virpidfile.h \ diff --git a/src/lxc/lxc_driver.c b/src/lxc/lxc_driver.c index e0e76e6..9c35406 100644 --- a/src/lxc/lxc_driver.c +++ b/src/lxc/lxc_driver.c @@ -50,7 +50,7 @@ #include "nodeinfo.h" #include "uuid.h" #include "stats_linux.h" -#include "hooks.h" +#include "virhooks.h" #include "virfile.h" #include "virpidfile.h" #include "fdstream.h" diff --git a/src/lxc/lxc_process.c b/src/lxc/lxc_process.c index 7f66dc7..d59bd2e 100644 --- a/src/lxc/lxc_process.c +++ b/src/lxc/lxc_process.c @@ -43,7 +43,7 @@ #include "virterror_internal.h" #include "logging.h" #include "vircommand.h" -#include "hooks.h" +#include "virhooks.h" #define VIR_FROM_THIS VIR_FROM_LXC diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c index 0ebbf7d..0733f4e 100644 --- a/src/qemu/qemu_driver.c +++ b/src/qemu/qemu_driver.c @@ -80,7 +80,7 @@ #include "cpu/cpu.h" #include "sysinfo.h" #include "domain_nwfilter.h" -#include "hooks.h" +#include "virhooks.h" #include "storage_file.h" #include "virfile.h" #include "fdstream.h" diff --git a/src/qemu/qemu_migration.c b/src/qemu/qemu_migration.c index 5dcbb07..468a92f 100644 --- a/src/qemu/qemu_migration.c +++ b/src/qemu/qemu_migration.c @@ -49,7 +49,7 @@ #include "rpc/virnetsocket.h" #include "storage_file.h" #include "viruri.h" -#include "hooks.h" +#include "virhooks.h" #define VIR_FROM_THIS VIR_FROM_QEMU diff --git a/src/qemu/qemu_process.c b/src/qemu/qemu_process.c index 969cbc7..e528d78 100644 --- a/src/qemu/qemu_process.c +++ b/src/qemu/qemu_process.c @@ -54,7 +54,7 @@ #include "logging.h" #include "virterror_internal.h" #include "memory.h" -#include "hooks.h" +#include "virhooks.h" #include "virfile.h" #include "virpidfile.h" #include "util.h" diff --git a/src/util/hooks.c b/src/util/hooks.c deleted file mode 100644 index a6c056d..0000000 --- a/src/util/hooks.c +++ /dev/null @@ -1,293 +0,0 @@ -/* - * hooks.c: implementation of the synchronous hooks support - * - * Copyright (C) 2010-2012 Red Hat, Inc. - * Copyright (C) 2010 Daniel Veillard - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Author: Daniel Veillard <veillard(a)redhat.com&gt; - */ - -#include <config.h> - -#include <sys/types.h> -#include <sys/wait.h> -#include <sys/stat.h> -#include <unistd.h> -#include <stdlib.h> -#include <stdio.h> - -#include "virterror_internal.h" -#include "hooks.h" -#include "util.h" -#include "logging.h" -#include "memory.h" -#include "virfile.h" -#include "configmake.h" -#include "vircommand.h" - -#define VIR_FROM_THIS VIR_FROM_HOOK - -#define LIBVIRT_HOOK_DIR SYSCONFDIR "/libvirt/hooks" - -VIR_ENUM_DECL(virHookDriver) -VIR_ENUM_DECL(virHookDaemonOp) -VIR_ENUM_DECL(virHookSubop) -VIR_ENUM_DECL(virHookQemuOp) -VIR_ENUM_DECL(virHookLxcOp) - -VIR_ENUM_IMPL(virHookDriver, - VIR_HOOK_DRIVER_LAST, - "daemon", - "qemu", - "lxc") - -VIR_ENUM_IMPL(virHookDaemonOp, VIR_HOOK_DAEMON_OP_LAST, - "start", - "shutdown", - "reload") - -VIR_ENUM_IMPL(virHookSubop, VIR_HOOK_SUBOP_LAST, - "-", - "begin", - "end") - -VIR_ENUM_IMPL(virHookQemuOp, VIR_HOOK_QEMU_OP_LAST, - "start", - "stopped", - "prepare", - "release", - "migrate", - "started", - "reconnect", - "attach") - -VIR_ENUM_IMPL(virHookLxcOp, VIR_HOOK_LXC_OP_LAST, - "start", - "stopped", - "prepare", - "release", - "started", - "reconnect") - -static int virHooksFound = -1; - -/** - * virHookCheck: - * @driver: the driver name "daemon", "qemu", "lxc"... - * - * Check is there is an installed hook for the given driver, if this - * is the case register it. Then subsequent calls to virHookCall - * will call the hook if found. - * - * Returns 1 if found, 0 if not found, and -1 in case of error - */ -static int -virHookCheck(int no, const char *driver) { - char *path; - int ret; - - if (driver == NULL) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Invalid hook name for #%d"), no); - return -1; - } - - ret = virBuildPath(&path, LIBVIRT_HOOK_DIR, driver); - if ((ret < 0) || (path == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to build path for %s hook"), - driver); - return -1; - } - - if (!virFileExists(path)) { - ret = 0; - VIR_DEBUG("No hook script %s", path); - } else if (!virFileIsExecutable(path)) { - ret = 0; - VIR_WARN("Non-executable hook script %s", path); - } else { - ret = 1; - VIR_DEBUG("Found hook script %s", path); - } - - VIR_FREE(path); - return ret; -} - -/* - * virHookInitialize: - * - * Initialize synchronous hooks support. - * Check is there is an installed hook for all the drivers - * - * Returns the number of hooks found or -1 in case of failure - */ -int -virHookInitialize(void) { - int i, res, ret = 0; - - virHooksFound = 0; - for (i = 0;i < VIR_HOOK_DRIVER_LAST;i++) { - res = virHookCheck(i, virHookDriverTypeToString(i)); - if (res < 0) - return -1; - - if (res == 1) { - virHooksFound |= (1 << i); - ret++; - } - } - return ret; -} - -/** - * virHookPresent: - * @driver: the driver number (from virHookDriver enum) - * - * Check if a hook exists for the given driver, this is needed - * to avoid unnecessary work if the hook is not present - * - * Returns 1 if present, 0 otherwise - */ -int -virHookPresent(int driver) { - if ((driver < VIR_HOOK_DRIVER_DAEMON) || - (driver >= VIR_HOOK_DRIVER_LAST)) - return 0; - if (virHooksFound == -1) - return 0; - - if ((virHooksFound & (1 << driver)) == 0) - return 0; - return 1; -} - -/** - * virHookCall: - * @driver: the driver number (from virHookDriver enum) - * @id: an id for the object '-' if non available for example on daemon hooks - * @op: the operation on the id e.g. VIR_HOOK_QEMU_OP_START - * @sub_op: a sub_operation, currently unused - * @extra: optional string information - * @input: extra input given to the script on stdin - * @output: optional address of variable to store malloced result buffer - * - * Implement a hook call, where the external script for the driver is - * called with the given information. This is a synchronous call, we wait for - * execution completion. If @output is non-NULL, *output is guaranteed to be - * allocated after successful virHookCall, and is best-effort allocated after - * failed virHookCall; the caller is responsible for freeing *output. - * - * Returns: 0 if the execution succeeded, 1 if the script was not found or - * invalid parameters, and -1 if script returned an error - */ -int -virHookCall(int driver, - const char *id, - int op, - int sub_op, - const char *extra, - const char *input, - char **output) -{ - int ret; - char *path; - virCommandPtr cmd; - const char *drvstr; - const char *opstr; - const char *subopstr; - - if (output) - *output = NULL; - - if ((driver < VIR_HOOK_DRIVER_DAEMON) || - (driver >= VIR_HOOK_DRIVER_LAST)) - return 1; - - /* - * We cache the availability of the script to minimize impact at - * runtime if no script is defined, this is being reset on SIGHUP - */ - if ((virHooksFound == -1) || - ((driver == VIR_HOOK_DRIVER_DAEMON) && - (op == VIR_HOOK_DAEMON_OP_RELOAD || - op == VIR_HOOK_DAEMON_OP_SHUTDOWN))) - virHookInitialize(); - - if ((virHooksFound & (1 << driver)) == 0) - return 1; - - drvstr = virHookDriverTypeToString(driver); - - opstr = NULL; - switch (driver) { - case VIR_HOOK_DRIVER_DAEMON: - opstr = virHookDaemonOpTypeToString(op); - break; - case VIR_HOOK_DRIVER_QEMU: - opstr = virHookQemuOpTypeToString(op); - break; - case VIR_HOOK_DRIVER_LXC: - opstr = virHookLxcOpTypeToString(op); - break; - } - if (opstr == NULL) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Hook for %s, failed to find operation #%d"), - drvstr, op); - return 1; - } - subopstr = virHookSubopTypeToString(sub_op); - if (subopstr == NULL) - subopstr = "-"; - if (extra == NULL) - extra = "-"; - - ret = virBuildPath(&path, LIBVIRT_HOOK_DIR, drvstr); - if ((ret < 0) || (path == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to build path for %s hook"), - drvstr); - return -1; - } - - VIR_DEBUG("Calling hook opstr=%s subopstr=%s extra=%s", - opstr, subopstr, extra); - - cmd = virCommandNewArgList(path, id, opstr, subopstr, extra, NULL); - - virCommandAddEnvPassCommon(cmd); - - if (input) - virCommandSetInputBuffer(cmd, input); - if (output) - virCommandSetOutputBuffer(cmd, output); - - ret = virCommandRun(cmd, NULL); - if (ret < 0) { - /* Convert INTERNAL_ERROR into known error. */ - virErrorPtr err = virGetLastError(); - virReportError(VIR_ERR_HOOK_SCRIPT_FAILED, "%s", err->message); - } - - virCommandFree(cmd); - - VIR_FREE(path); - - return ret; -} diff --git a/src/util/hooks.h b/src/util/hooks.h deleted file mode 100644 index 0ca376f..0000000 --- a/src/util/hooks.h +++ /dev/null @@ -1,85 +0,0 @@ -/* - * hook.h: internal entry points needed for synchronous hooks support - * - * Copyright (C) 2010 Red Hat, Inc. - * Copyright (C) 2010 Daniel Veillard - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Author: Daniel Veillard <veillard(a)redhat.com&gt; - */ - -#ifndef __VIR_HOOKS_H__ -# define __VIR_HOOKS_H__ - -# include "internal.h" -# include "util.h" - -enum virHookDriverType { - VIR_HOOK_DRIVER_DAEMON = 0, /* Daemon related events */ - VIR_HOOK_DRIVER_QEMU, /* QEmu domains related events */ - VIR_HOOK_DRIVER_LXC, /* LXC domains related events */ - - VIR_HOOK_DRIVER_LAST, -}; - -enum virHookDaemonOpType { - VIR_HOOK_DAEMON_OP_START, /* daemon is about to start */ - VIR_HOOK_DAEMON_OP_SHUTDOWN, /* daemon is about to shutdown */ - VIR_HOOK_DAEMON_OP_RELOAD, /* driver reload with SIGHUP */ - - VIR_HOOK_DAEMON_OP_LAST, -}; - -enum virHookSubopType { - VIR_HOOK_SUBOP_NONE, /* no sub-operation */ - VIR_HOOK_SUBOP_BEGIN, /* beginning of the operation */ - VIR_HOOK_SUBOP_END, /* end of the operation */ - - VIR_HOOK_SUBOP_LAST, -}; - -enum virHookQemuOpType { - VIR_HOOK_QEMU_OP_START, /* domain is about to start */ - VIR_HOOK_QEMU_OP_STOPPED, /* domain has stopped */ - VIR_HOOK_QEMU_OP_PREPARE, /* domain startup initiated */ - VIR_HOOK_QEMU_OP_RELEASE, /* domain destruction is over */ - VIR_HOOK_QEMU_OP_MIGRATE, /* domain is being migrated */ - VIR_HOOK_QEMU_OP_STARTED, /* domain has started */ - VIR_HOOK_QEMU_OP_RECONNECT, /* domain is being reconnected by libvirt */ - VIR_HOOK_QEMU_OP_ATTACH, /* domain is being attached to be libvirt */ - - VIR_HOOK_QEMU_OP_LAST, -}; - -enum virHookLxcOpType { - VIR_HOOK_LXC_OP_START, /* domain is about to start */ - VIR_HOOK_LXC_OP_STOPPED, /* domain has stopped */ - VIR_HOOK_LXC_OP_PREPARE, /* domain startup initiated */ - VIR_HOOK_LXC_OP_RELEASE, /* domain destruction is over */ - VIR_HOOK_LXC_OP_STARTED, /* domain has started */ - VIR_HOOK_LXC_OP_RECONNECT, /* domain is being reconnected by libvirt */ - - VIR_HOOK_LXC_OP_LAST, -}; - -int virHookInitialize(void); - -int virHookPresent(int driver); - -int virHookCall(int driver, const char *id, int op, int sub_op, - const char *extra, const char *input, char **output); - -#endif /* __VIR_HOOKS_H__ */ diff --git a/src/util/virhooks.c b/src/util/virhooks.c new file mode 100644 index 0000000..4a732ff --- /dev/null +++ b/src/util/virhooks.c @@ -0,0 +1,293 @@ +/* + * hooks.c: implementation of the synchronous hooks support + * + * Copyright (C) 2010-2012 Red Hat, Inc. + * Copyright (C) 2010 Daniel Veillard + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Author: Daniel Veillard <veillard(a)redhat.com&gt; + */ + +#include <config.h> + +#include <sys/types.h> +#include <sys/wait.h> +#include <sys/stat.h> +#include <unistd.h> +#include <stdlib.h> +#include <stdio.h> + +#include "virterror_internal.h" +#include "virhooks.h" +#include "util.h" +#include "logging.h" +#include "memory.h" +#include "virfile.h" +#include "configmake.h" +#include "vircommand.h" + +#define VIR_FROM_THIS VIR_FROM_HOOK + +#define LIBVIRT_HOOK_DIR SYSCONFDIR "/libvirt/hooks" + +VIR_ENUM_DECL(virHookDriver) +VIR_ENUM_DECL(virHookDaemonOp) +VIR_ENUM_DECL(virHookSubop) +VIR_ENUM_DECL(virHookQemuOp) +VIR_ENUM_DECL(virHookLxcOp) + +VIR_ENUM_IMPL(virHookDriver, + VIR_HOOK_DRIVER_LAST, + "daemon", + "qemu", + "lxc") + +VIR_ENUM_IMPL(virHookDaemonOp, VIR_HOOK_DAEMON_OP_LAST, + "start", + "shutdown", + "reload") + +VIR_ENUM_IMPL(virHookSubop, VIR_HOOK_SUBOP_LAST, + "-", + "begin", + "end") + +VIR_ENUM_IMPL(virHookQemuOp, VIR_HOOK_QEMU_OP_LAST, + "start", + "stopped", + "prepare", + "release", + "migrate", + "started", + "reconnect", + "attach") + +VIR_ENUM_IMPL(virHookLxcOp, VIR_HOOK_LXC_OP_LAST, + "start", + "stopped", + "prepare", + "release", + "started", + "reconnect") + +static int virHooksFound = -1; + +/** + * virHookCheck: + * @driver: the driver name "daemon", "qemu", "lxc"... + * + * Check is there is an installed hook for the given driver, if this + * is the case register it. Then subsequent calls to virHookCall + * will call the hook if found. + * + * Returns 1 if found, 0 if not found, and -1 in case of error + */ +static int +virHookCheck(int no, const char *driver) { + char *path; + int ret; + + if (driver == NULL) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Invalid hook name for #%d"), no); + return -1; + } + + ret = virBuildPath(&path, LIBVIRT_HOOK_DIR, driver); + if ((ret < 0) || (path == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to build path for %s hook"), + driver); + return -1; + } + + if (!virFileExists(path)) { + ret = 0; + VIR_DEBUG("No hook script %s", path); + } else if (!virFileIsExecutable(path)) { + ret = 0; + VIR_WARN("Non-executable hook script %s", path); + } else { + ret = 1; + VIR_DEBUG("Found hook script %s", path); + } + + VIR_FREE(path); + return ret; +} + +/* + * virHookInitialize: + * + * Initialize synchronous hooks support. + * Check is there is an installed hook for all the drivers + * + * Returns the number of hooks found or -1 in case of failure + */ +int +virHookInitialize(void) { + int i, res, ret = 0; + + virHooksFound = 0; + for (i = 0;i < VIR_HOOK_DRIVER_LAST;i++) { + res = virHookCheck(i, virHookDriverTypeToString(i)); + if (res < 0) + return -1; + + if (res == 1) { + virHooksFound |= (1 << i); + ret++; + } + } + return ret; +} + +/** + * virHookPresent: + * @driver: the driver number (from virHookDriver enum) + * + * Check if a hook exists for the given driver, this is needed + * to avoid unnecessary work if the hook is not present + * + * Returns 1 if present, 0 otherwise + */ +int +virHookPresent(int driver) { + if ((driver < VIR_HOOK_DRIVER_DAEMON) || + (driver >= VIR_HOOK_DRIVER_LAST)) + return 0; + if (virHooksFound == -1) + return 0; + + if ((virHooksFound & (1 << driver)) == 0) + return 0; + return 1; +} + +/** + * virHookCall: + * @driver: the driver number (from virHookDriver enum) + * @id: an id for the object '-' if non available for example on daemon hooks + * @op: the operation on the id e.g. VIR_HOOK_QEMU_OP_START + * @sub_op: a sub_operation, currently unused + * @extra: optional string information + * @input: extra input given to the script on stdin + * @output: optional address of variable to store malloced result buffer + * + * Implement a hook call, where the external script for the driver is + * called with the given information. This is a synchronous call, we wait for + * execution completion. If @output is non-NULL, *output is guaranteed to be + * allocated after successful virHookCall, and is best-effort allocated after + * failed virHookCall; the caller is responsible for freeing *output. + * + * Returns: 0 if the execution succeeded, 1 if the script was not found or + * invalid parameters, and -1 if script returned an error + */ +int +virHookCall(int driver, + const char *id, + int op, + int sub_op, + const char *extra, + const char *input, + char **output) +{ + int ret; + char *path; + virCommandPtr cmd; + const char *drvstr; + const char *opstr; + const char *subopstr; + + if (output) + *output = NULL; + + if ((driver < VIR_HOOK_DRIVER_DAEMON) || + (driver >= VIR_HOOK_DRIVER_LAST)) + return 1; + + /* + * We cache the availability of the script to minimize impact at + * runtime if no script is defined, this is being reset on SIGHUP + */ + if ((virHooksFound == -1) || + ((driver == VIR_HOOK_DRIVER_DAEMON) && + (op == VIR_HOOK_DAEMON_OP_RELOAD || + op == VIR_HOOK_DAEMON_OP_SHUTDOWN))) + virHookInitialize(); + + if ((virHooksFound & (1 << driver)) == 0) + return 1; + + drvstr = virHookDriverTypeToString(driver); + + opstr = NULL; + switch (driver) { + case VIR_HOOK_DRIVER_DAEMON: + opstr = virHookDaemonOpTypeToString(op); + break; + case VIR_HOOK_DRIVER_QEMU: + opstr = virHookQemuOpTypeToString(op); + break; + case VIR_HOOK_DRIVER_LXC: + opstr = virHookLxcOpTypeToString(op); + break; + } + if (opstr == NULL) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Hook for %s, failed to find operation #%d"), + drvstr, op); + return 1; + } + subopstr = virHookSubopTypeToString(sub_op); + if (subopstr == NULL) + subopstr = "-"; + if (extra == NULL) + extra = "-"; + + ret = virBuildPath(&path, LIBVIRT_HOOK_DIR, drvstr); + if ((ret < 0) || (path == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to build path for %s hook"), + drvstr); + return -1; + } + + VIR_DEBUG("Calling hook opstr=%s subopstr=%s extra=%s", + opstr, subopstr, extra); + + cmd = virCommandNewArgList(path, id, opstr, subopstr, extra, NULL); + + virCommandAddEnvPassCommon(cmd); + + if (input) + virCommandSetInputBuffer(cmd, input); + if (output) + virCommandSetOutputBuffer(cmd, output); + + ret = virCommandRun(cmd, NULL); + if (ret < 0) { + /* Convert INTERNAL_ERROR into known error. */ + virErrorPtr err = virGetLastError(); + virReportError(VIR_ERR_HOOK_SCRIPT_FAILED, "%s", err->message); + } + + virCommandFree(cmd); + + VIR_FREE(path); + + return ret; +} diff --git a/src/util/virhooks.h b/src/util/virhooks.h new file mode 100644 index 0000000..0ca376f --- /dev/null +++ b/src/util/virhooks.h @@ -0,0 +1,85 @@ +/* + * hook.h: internal entry points needed for synchronous hooks support + * + * Copyright (C) 2010 Red Hat, Inc. + * Copyright (C) 2010 Daniel Veillard + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Author: Daniel Veillard <veillard(a)redhat.com&gt; + */ + +#ifndef __VIR_HOOKS_H__ +# define __VIR_HOOKS_H__ + +# include "internal.h" +# include "util.h" + +enum virHookDriverType { + VIR_HOOK_DRIVER_DAEMON = 0, /* Daemon related events */ + VIR_HOOK_DRIVER_QEMU, /* QEmu domains related events */ + VIR_HOOK_DRIVER_LXC, /* LXC domains related events */ + + VIR_HOOK_DRIVER_LAST, +}; + +enum virHookDaemonOpType { + VIR_HOOK_DAEMON_OP_START, /* daemon is about to start */ + VIR_HOOK_DAEMON_OP_SHUTDOWN, /* daemon is about to shutdown */ + VIR_HOOK_DAEMON_OP_RELOAD, /* driver reload with SIGHUP */ + + VIR_HOOK_DAEMON_OP_LAST, +}; + +enum virHookSubopType { + VIR_HOOK_SUBOP_NONE, /* no sub-operation */ + VIR_HOOK_SUBOP_BEGIN, /* beginning of the operation */ + VIR_HOOK_SUBOP_END, /* end of the operation */ + + VIR_HOOK_SUBOP_LAST, +}; + +enum virHookQemuOpType { + VIR_HOOK_QEMU_OP_START, /* domain is about to start */ + VIR_HOOK_QEMU_OP_STOPPED, /* domain has stopped */ + VIR_HOOK_QEMU_OP_PREPARE, /* domain startup initiated */ + VIR_HOOK_QEMU_OP_RELEASE, /* domain destruction is over */ + VIR_HOOK_QEMU_OP_MIGRATE, /* domain is being migrated */ + VIR_HOOK_QEMU_OP_STARTED, /* domain has started */ + VIR_HOOK_QEMU_OP_RECONNECT, /* domain is being reconnected by libvirt */ + VIR_HOOK_QEMU_OP_ATTACH, /* domain is being attached to be libvirt */ + + VIR_HOOK_QEMU_OP_LAST, +}; + +enum virHookLxcOpType { + VIR_HOOK_LXC_OP_START, /* domain is about to start */ + VIR_HOOK_LXC_OP_STOPPED, /* domain has stopped */ + VIR_HOOK_LXC_OP_PREPARE, /* domain startup initiated */ + VIR_HOOK_LXC_OP_RELEASE, /* domain destruction is over */ + VIR_HOOK_LXC_OP_STARTED, /* domain has started */ + VIR_HOOK_LXC_OP_RECONNECT, /* domain is being reconnected by libvirt */ + + VIR_HOOK_LXC_OP_LAST, +}; + +int virHookInitialize(void); + +int virHookPresent(int driver); + +int virHookCall(int driver, const char *id, int op, int sub_op, + const char *extra, const char *input, char **output); + +#endif /* __VIR_HOOKS_H__ */ -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- po/POTFILES.in | 2 +- src/Makefile.am | 2 +- src/network/bridge_driver.c | 2 +- src/util/iptables.c | 970 -------------------------------------------- src/util/iptables.h | 121 ------ src/util/viriptables.c | 970 ++++++++++++++++++++++++++++++++++++++++++++ src/util/viriptables.h | 121 ++++++ 7 files changed, 1094 insertions(+), 1094 deletions(-) delete mode 100644 src/util/iptables.c delete mode 100644 src/util/iptables.h create mode 100644 src/util/viriptables.c create mode 100644 src/util/viriptables.h diff --git a/po/POTFILES.in b/po/POTFILES.in index 3f3362c..f55a1b1 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -138,7 +138,6 @@ src/test/test_driver.c src/uml/uml_conf.c src/uml/uml_driver.c src/util/iohelper.c -src/util/iptables.c src/util/json.c src/util/pci.c src/util/processinfo.c @@ -160,6 +159,7 @@ src/util/virfile.c src/util/virhash.c src/util/virhooks.c src/util/virinitctl.c +src/util/viriptables.c src/util/virkeyfile.c src/util/virlockspace.c src/util/virnetdev.c diff --git a/src/Makefile.am b/src/Makefile.am index 4f89bdc..45e6169 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -53,7 +53,6 @@ augeastest_DATA = # These files are not related to driver APIs. Simply generic # helper APIs for various purposes UTIL_SOURCES = \ - util/iptables.c util/iptables.h \ util/json.c util/json.h \ util/logging.c util/logging.h \ util/memory.c util/memory.h \ @@ -84,6 +83,7 @@ UTIL_SOURCES = \ util/virfile.c util/virfile.h \ util/virhooks.c util/virhooks.h \ util/virnodesuspend.c util/virnodesuspend.h \ + util/viriptables.c util/viriptables.h \ util/virobject.c util/virobject.h \ util/virpidfile.c util/virpidfile.h \ util/virprocess.c util/virprocess.h \ diff --git a/src/network/bridge_driver.c b/src/network/bridge_driver.c index 1110208..bc37bde 100644 --- a/src/network/bridge_driver.c +++ b/src/network/bridge_driver.c @@ -56,7 +56,7 @@ #include "vircommand.h" #include "memory.h" #include "uuid.h" -#include "iptables.h" +#include "viriptables.h" #include "logging.h" #include "virdnsmasq.h" #include "configmake.h" diff --git a/src/util/iptables.c b/src/util/iptables.c deleted file mode 100644 index 25253ff..0000000 --- a/src/util/iptables.c +++ /dev/null @@ -1,970 +0,0 @@ -/* - * Copyright (C) 2007-2012 Red Hat, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Authors: - * Mark McLoughlin <markmc(a)redhat.com&gt; - */ - -#include <config.h> - -#include <stdio.h> -#include <stdlib.h> -#include <stdarg.h> -#include <string.h> -#include <errno.h> -#include <limits.h> -#include <unistd.h> -#include <fcntl.h> -#include <sys/types.h> -#include <sys/stat.h> -#include <sys/wait.h> - -#ifdef HAVE_PATHS_H -# include <paths.h> -#endif - -#include "internal.h" -#include "iptables.h" -#include "vircommand.h" -#include "memory.h" -#include "virterror_internal.h" -#include "logging.h" -#include "threads.h" - -#if HAVE_FIREWALLD -static char *firewall_cmd_path = NULL; - -static int -virIpTablesOnceInit(void) -{ - firewall_cmd_path = virFindFileInPath("firewall-cmd"); - if (!firewall_cmd_path) { - VIR_INFO("firewall-cmd not found on system. " - "firewalld support disabled for iptables."); - } else { - virCommandPtr cmd = virCommandNew(firewall_cmd_path); - int status; - - virCommandAddArgList(cmd, "--state", NULL); - if (virCommandRun(cmd, &status) < 0 || status != 0) { - VIR_INFO("firewall-cmd found but disabled for iptables"); - VIR_FREE(firewall_cmd_path); - firewall_cmd_path = NULL; - } else { - VIR_INFO("using firewalld for iptables commands"); - } - virCommandFree(cmd); - } - return 0; -} - -VIR_ONCE_GLOBAL_INIT(virIpTables) - -#endif - -#define VIR_FROM_THIS VIR_FROM_NONE - -enum { - ADD = 0, - REMOVE -}; - -typedef struct -{ - char *table; - char *chain; -} iptRules; - -struct _iptablesContext -{ - iptRules *input_filter; - iptRules *forward_filter; - iptRules *nat_postrouting; - iptRules *mangle_postrouting; -}; - -static void -iptRulesFree(iptRules *rules) -{ - VIR_FREE(rules->table); - VIR_FREE(rules->chain); - VIR_FREE(rules); -} - -static iptRules * -iptRulesNew(const char *table, - const char *chain) -{ - iptRules *rules; - - if (VIR_ALLOC(rules) < 0) - return NULL; - - if (!(rules->table = strdup(table))) - goto error; - - if (!(rules->chain = strdup(chain))) - goto error; - - return rules; - - error: - iptRulesFree(rules); - return NULL; -} - -static int ATTRIBUTE_SENTINEL -iptablesAddRemoveRule(iptRules *rules, int family, int action, - const char *arg, ...) -{ - va_list args; - int ret; - virCommandPtr cmd = NULL; - const char *s; - -#if HAVE_FIREWALLD - virIpTablesInitialize(); - if (firewall_cmd_path) { - cmd = virCommandNew(firewall_cmd_path); - virCommandAddArgList(cmd, "--direct", "--passthrough", - (family == AF_INET6) ? "ipv6" : "ipv4", NULL); - } -#endif - - if (cmd == NULL) { - cmd = virCommandNew((family == AF_INET6) - ? IP6TABLES_PATH : IPTABLES_PATH); - } - - virCommandAddArgList(cmd, "--table", rules->table, - action == ADD ? "--insert" : "--delete", - rules->chain, arg, NULL); - - va_start(args, arg); - while ((s = va_arg(args, const char *))) - virCommandAddArg(cmd, s); - va_end(args); - - ret = virCommandRun(cmd, NULL); - virCommandFree(cmd); - return ret; -} - -/** - * iptablesContextNew: - * - * Create a new IPtable context - * - * Returns a pointer to the new structure or NULL in case of error - */ -iptablesContext * -iptablesContextNew(void) -{ - iptablesContext *ctx; - - if (VIR_ALLOC(ctx) < 0) - return NULL; - - if (!(ctx->input_filter = iptRulesNew("filter", "INPUT"))) - goto error; - - if (!(ctx->forward_filter = iptRulesNew("filter", "FORWARD"))) - goto error; - - if (!(ctx->nat_postrouting = iptRulesNew("nat", "POSTROUTING"))) - goto error; - - if (!(ctx->mangle_postrouting = iptRulesNew("mangle", "POSTROUTING"))) - goto error; - - return ctx; - - error: - iptablesContextFree(ctx); - return NULL; -} - -/** - * iptablesContextFree: - * @ctx: pointer to the IP table context - * - * Free the resources associated with an IP table context - */ -void -iptablesContextFree(iptablesContext *ctx) -{ - if (ctx->input_filter) - iptRulesFree(ctx->input_filter); - if (ctx->forward_filter) - iptRulesFree(ctx->forward_filter); - if (ctx->nat_postrouting) - iptRulesFree(ctx->nat_postrouting); - if (ctx->mangle_postrouting) - iptRulesFree(ctx->mangle_postrouting); - VIR_FREE(ctx); -} - -static int -iptablesInput(iptablesContext *ctx, - int family, - const char *iface, - int port, - int action, - int tcp) -{ - char portstr[32]; - - snprintf(portstr, sizeof(portstr), "%d", port); - portstr[sizeof(portstr) - 1] = '\0'; - - return iptablesAddRemoveRule(ctx->input_filter, - family, - action, - "--in-interface", iface, - "--protocol", tcp ? "tcp" : "udp", - "--destination-port", portstr, - "--jump", "ACCEPT", - NULL); -} - -/** - * iptablesAddTcpInput: - * @ctx: pointer to the IP table context - * @iface: the interface name - * @port: the TCP port to add - * - * Add an input to the IP table allowing access to the given @port on - * the given @iface interface for TCP packets - * - * Returns 0 in case of success or an error code in case of error - */ - -int -iptablesAddTcpInput(iptablesContext *ctx, - int family, - const char *iface, - int port) -{ - return iptablesInput(ctx, family, iface, port, ADD, 1); -} - -/** - * iptablesRemoveTcpInput: - * @ctx: pointer to the IP table context - * @iface: the interface name - * @port: the TCP port to remove - * - * Removes an input from the IP table, hence forbidding access to the given - * @port on the given @iface interface for TCP packets - * - * Returns 0 in case of success or an error code in case of error - */ -int -iptablesRemoveTcpInput(iptablesContext *ctx, - int family, - const char *iface, - int port) -{ - return iptablesInput(ctx, family, iface, port, REMOVE, 1); -} - -/** - * iptablesAddUdpInput: - * @ctx: pointer to the IP table context - * @iface: the interface name - * @port: the UDP port to add - * - * Add an input to the IP table allowing access to the given @port on - * the given @iface interface for UDP packets - * - * Returns 0 in case of success or an error code in case of error - */ - -int -iptablesAddUdpInput(iptablesContext *ctx, - int family, - const char *iface, - int port) -{ - return iptablesInput(ctx, family, iface, port, ADD, 0); -} - -/** - * iptablesRemoveUdpInput: - * @ctx: pointer to the IP table context - * @iface: the interface name - * @port: the UDP port to remove - * - * Removes an input from the IP table, hence forbidding access to the given - * @port on the given @iface interface for UDP packets - * - * Returns 0 in case of success or an error code in case of error - */ -int -iptablesRemoveUdpInput(iptablesContext *ctx, - int family, - const char *iface, - int port) -{ - return iptablesInput(ctx, family, iface, port, REMOVE, 0); -} - - -static char *iptablesFormatNetwork(virSocketAddr *netaddr, - unsigned int prefix) -{ - virSocketAddr network; - char *netstr; - char *ret; - - if (!(VIR_SOCKET_ADDR_IS_FAMILY(netaddr, AF_INET) || - VIR_SOCKET_ADDR_IS_FAMILY(netaddr, AF_INET6))) { - virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s", - _("Only IPv4 or IPv6 addresses can be used with iptables")); - return NULL; - } - - if (virSocketAddrMaskByPrefix(netaddr, prefix, &network) < 0) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("Failure to mask address")); - return NULL; - } - - netstr = virSocketAddrFormat(&network); - - if (!netstr) - return NULL; - - if (virAsprintf(&ret, "%s/%d", netstr, prefix) < 0) - virReportOOMError(); - - VIR_FREE(netstr); - return ret; -} - - -/* Allow all traffic coming from the bridge, with a valid network address - * to proceed to WAN - */ -static int -iptablesForwardAllowOut(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev, - int action) -{ - int ret; - char *networkstr; - - if (!(networkstr = iptablesFormatNetwork(netaddr, prefix))) - return -1; - - if (physdev && physdev[0]) { - ret = iptablesAddRemoveRule(ctx->forward_filter, - VIR_SOCKET_ADDR_FAMILY(netaddr), - action, - "--source", networkstr, - "--in-interface", iface, - "--out-interface", physdev, - "--jump", "ACCEPT", - NULL); - } else { - ret = iptablesAddRemoveRule(ctx->forward_filter, - VIR_SOCKET_ADDR_FAMILY(netaddr), - action, - "--source", networkstr, - "--in-interface", iface, - "--jump", "ACCEPT", - NULL); - } - VIR_FREE(networkstr); - return ret; -} - -/** - * iptablesAddForwardAllowOut: - * @ctx: pointer to the IP table context - * @network: the source network name - * @iface: the source interface name - * @physdev: the physical output device - * - * Add a rule to the IP table context to allow the traffic for the - * network @network via interface @iface to be forwarded to - * @physdev device. This allow the outbound traffic on a bridge. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesAddForwardAllowOut(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev) -{ - return iptablesForwardAllowOut(ctx, netaddr, prefix, iface, physdev, ADD); -} - -/** - * iptablesRemoveForwardAllowOut: - * @ctx: pointer to the IP table context - * @network: the source network name - * @iface: the source interface name - * @physdev: the physical output device - * - * Remove a rule from the IP table context hence forbidding forwarding - * of the traffic for the network @network via interface @iface - * to the @physdev device output. This stops the outbound traffic on a bridge. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesRemoveForwardAllowOut(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev) -{ - return iptablesForwardAllowOut(ctx, netaddr, prefix, iface, physdev, REMOVE); -} - - -/* Allow all traffic destined to the bridge, with a valid network address - * and associated with an existing connection - */ -static int -iptablesForwardAllowRelatedIn(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev, - int action) -{ - int ret; - char *networkstr; - - if (!(networkstr = iptablesFormatNetwork(netaddr, prefix))) - return -1; - - if (physdev && physdev[0]) { - ret = iptablesAddRemoveRule(ctx->forward_filter, - VIR_SOCKET_ADDR_FAMILY(netaddr), - action, - "--destination", networkstr, - "--in-interface", physdev, - "--out-interface", iface, - "--match", "state", - "--state", "ESTABLISHED,RELATED", - "--jump", "ACCEPT", - NULL); - } else { - ret = iptablesAddRemoveRule(ctx->forward_filter, - VIR_SOCKET_ADDR_FAMILY(netaddr), - action, - "--destination", networkstr, - "--out-interface", iface, - "--match", "state", - "--state", "ESTABLISHED,RELATED", - "--jump", "ACCEPT", - NULL); - } - VIR_FREE(networkstr); - return ret; -} - -/** - * iptablesAddForwardAllowRelatedIn: - * @ctx: pointer to the IP table context - * @network: the source network name - * @iface: the output interface name - * @physdev: the physical input device or NULL - * - * Add rules to the IP table context to allow the traffic for the - * network @network on @physdev device to be forwarded to - * interface @iface, if it is part of an existing connection. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesAddForwardAllowRelatedIn(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev) -{ - return iptablesForwardAllowRelatedIn(ctx, netaddr, prefix, iface, physdev, ADD); -} - -/** - * iptablesRemoveForwardAllowRelatedIn: - * @ctx: pointer to the IP table context - * @network: the source network name - * @iface: the output interface name - * @physdev: the physical input device or NULL - * - * Remove rules from the IP table context hence forbidding the traffic for - * network @network on @physdev device to be forwarded to - * interface @iface, if it is part of an existing connection. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesRemoveForwardAllowRelatedIn(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev) -{ - return iptablesForwardAllowRelatedIn(ctx, netaddr, prefix, iface, physdev, REMOVE); -} - -/* Allow all traffic destined to the bridge, with a valid network address - */ -static int -iptablesForwardAllowIn(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev, - int action) -{ - int ret; - char *networkstr; - - if (!(networkstr = iptablesFormatNetwork(netaddr, prefix))) - return -1; - - if (physdev && physdev[0]) { - ret = iptablesAddRemoveRule(ctx->forward_filter, - VIR_SOCKET_ADDR_FAMILY(netaddr), - action, - "--destination", networkstr, - "--in-interface", physdev, - "--out-interface", iface, - "--jump", "ACCEPT", - NULL); - } else { - ret = iptablesAddRemoveRule(ctx->forward_filter, - VIR_SOCKET_ADDR_FAMILY(netaddr), - action, - "--destination", networkstr, - "--out-interface", iface, - "--jump", "ACCEPT", - NULL); - } - VIR_FREE(networkstr); - return ret; -} - -/** - * iptablesAddForwardAllowIn: - * @ctx: pointer to the IP table context - * @network: the source network name - * @iface: the output interface name - * @physdev: the physical input device or NULL - * - * Add rules to the IP table context to allow the traffic for the - * network @network on @physdev device to be forwarded to - * interface @iface. This allow the inbound traffic on a bridge. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesAddForwardAllowIn(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev) -{ - return iptablesForwardAllowIn(ctx, netaddr, prefix, iface, physdev, ADD); -} - -/** - * iptablesRemoveForwardAllowIn: - * @ctx: pointer to the IP table context - * @network: the source network name - * @iface: the output interface name - * @physdev: the physical input device or NULL - * - * Remove rules from the IP table context hence forbidding the traffic for - * network @network on @physdev device to be forwarded to - * interface @iface. This stops the inbound traffic on a bridge. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesRemoveForwardAllowIn(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev) -{ - return iptablesForwardAllowIn(ctx, netaddr, prefix, iface, physdev, REMOVE); -} - - -/* Allow all traffic between guests on the same bridge, - * with a valid network address - */ -static int -iptablesForwardAllowCross(iptablesContext *ctx, - int family, - const char *iface, - int action) -{ - return iptablesAddRemoveRule(ctx->forward_filter, - family, - action, - "--in-interface", iface, - "--out-interface", iface, - "--jump", "ACCEPT", - NULL); -} - -/** - * iptablesAddForwardAllowCross: - * @ctx: pointer to the IP table context - * @iface: the input/output interface name - * - * Add rules to the IP table context to allow traffic to cross that - * interface. It allows all traffic between guests on the same bridge - * represented by that interface. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesAddForwardAllowCross(iptablesContext *ctx, - int family, - const char *iface) -{ - return iptablesForwardAllowCross(ctx, family, iface, ADD); -} - -/** - * iptablesRemoveForwardAllowCross: - * @ctx: pointer to the IP table context - * @iface: the input/output interface name - * - * Remove rules to the IP table context to block traffic to cross that - * interface. It forbids traffic between guests on the same bridge - * represented by that interface. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesRemoveForwardAllowCross(iptablesContext *ctx, - int family, - const char *iface) -{ - return iptablesForwardAllowCross(ctx, family, iface, REMOVE); -} - - -/* Drop all traffic trying to forward from the bridge. - * ie the bridge is the in interface - */ -static int -iptablesForwardRejectOut(iptablesContext *ctx, - int family, - const char *iface, - int action) -{ - return iptablesAddRemoveRule(ctx->forward_filter, - family, - action, - "--in-interface", iface, - "--jump", "REJECT", - NULL); -} - -/** - * iptablesAddForwardRejectOut: - * @ctx: pointer to the IP table context - * @iface: the output interface name - * - * Add rules to the IP table context to forbid all traffic to that - * interface. It forbids forwarding from the bridge to that interface. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesAddForwardRejectOut(iptablesContext *ctx, - int family, - const char *iface) -{ - return iptablesForwardRejectOut(ctx, family, iface, ADD); -} - -/** - * iptablesRemoveForwardRejectOut: - * @ctx: pointer to the IP table context - * @iface: the output interface name - * - * Remove rules from the IP table context forbidding all traffic to that - * interface. It reallow forwarding from the bridge to that interface. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesRemoveForwardRejectOut(iptablesContext *ctx, - int family, - const char *iface) -{ - return iptablesForwardRejectOut(ctx, family, iface, REMOVE); -} - - - - -/* Drop all traffic trying to forward to the bridge. - * ie the bridge is the out interface - */ -static int -iptablesForwardRejectIn(iptablesContext *ctx, - int family, - const char *iface, - int action) -{ - return iptablesAddRemoveRule(ctx->forward_filter, - family, - action, - "--out-interface", iface, - "--jump", "REJECT", - NULL); -} - -/** - * iptablesAddForwardRejectIn: - * @ctx: pointer to the IP table context - * @iface: the input interface name - * - * Add rules to the IP table context to forbid all traffic from that - * interface. It forbids forwarding from that interface to the bridge. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesAddForwardRejectIn(iptablesContext *ctx, - int family, - const char *iface) -{ - return iptablesForwardRejectIn(ctx, family, iface, ADD); -} - -/** - * iptablesRemoveForwardRejectIn: - * @ctx: pointer to the IP table context - * @iface: the input interface name - * - * Remove rules from the IP table context forbidding all traffic from that - * interface. It allows forwarding from that interface to the bridge. - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesRemoveForwardRejectIn(iptablesContext *ctx, - int family, - const char *iface) -{ - return iptablesForwardRejectIn(ctx, family, iface, REMOVE); -} - - -/* Masquerade all traffic coming from the network associated - * with the bridge - */ -static int -iptablesForwardMasquerade(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *physdev, - const char *protocol, - int action) -{ - int ret; - char *networkstr; - - if (!(networkstr = iptablesFormatNetwork(netaddr, prefix))) - return -1; - - if (!VIR_SOCKET_ADDR_IS_FAMILY(netaddr, AF_INET)) { - /* Higher level code *should* guaranteee it's impossible to get here. */ - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Attempted to NAT '%s'. NAT is only supported for IPv4."), - networkstr); - VIR_FREE(networkstr); - return -1; - } - - if (protocol && protocol[0]) { - if (physdev && physdev[0]) { - ret = iptablesAddRemoveRule(ctx->nat_postrouting, - AF_INET, - action, - "--source", networkstr, - "-p", protocol, - "!", "--destination", networkstr, - "--out-interface", physdev, - "--jump", "MASQUERADE", - "--to-ports", "1024-65535", - NULL); - } else { - ret = iptablesAddRemoveRule(ctx->nat_postrouting, - AF_INET, - action, - "--source", networkstr, - "-p", protocol, - "!", "--destination", networkstr, - "--jump", "MASQUERADE", - "--to-ports", "1024-65535", - NULL); - } - } else { - if (physdev && physdev[0]) { - ret = iptablesAddRemoveRule(ctx->nat_postrouting, - AF_INET, - action, - "--source", networkstr, - "!", "--destination", networkstr, - "--out-interface", physdev, - "--jump", "MASQUERADE", - NULL); - } else { - ret = iptablesAddRemoveRule(ctx->nat_postrouting, - AF_INET, - action, - "--source", networkstr, - "!", "--destination", networkstr, - "--jump", "MASQUERADE", - NULL); - } - } - VIR_FREE(networkstr); - return ret; -} - -/** - * iptablesAddForwardMasquerade: - * @ctx: pointer to the IP table context - * @network: the source network name - * @physdev: the physical input device or NULL - * @protocol: the network protocol or NULL - * - * Add rules to the IP table context to allow masquerading - * network @network on @physdev. This allow the bridge to - * masquerade for that network (on @physdev). - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesAddForwardMasquerade(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *physdev, - const char *protocol) -{ - return iptablesForwardMasquerade(ctx, netaddr, prefix, physdev, protocol, ADD); -} - -/** - * iptablesRemoveForwardMasquerade: - * @ctx: pointer to the IP table context - * @network: the source network name - * @physdev: the physical input device or NULL - * @protocol: the network protocol or NULL - * - * Remove rules from the IP table context to stop masquerading - * network @network on @physdev. This stops the bridge from - * masquerading for that network (on @physdev). - * - * Returns 0 in case of success or an error code otherwise - */ -int -iptablesRemoveForwardMasquerade(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *physdev, - const char *protocol) -{ - return iptablesForwardMasquerade(ctx, netaddr, prefix, physdev, protocol, REMOVE); -} - - -static int -iptablesOutputFixUdpChecksum(iptablesContext *ctx, - const char *iface, - int port, - int action) -{ - char portstr[32]; - - snprintf(portstr, sizeof(portstr), "%d", port); - portstr[sizeof(portstr) - 1] = '\0'; - - return iptablesAddRemoveRule(ctx->mangle_postrouting, - AF_INET, - action, - "--out-interface", iface, - "--protocol", "udp", - "--destination-port", portstr, - "--jump", "CHECKSUM", "--checksum-fill", - NULL); -} - -/** - * iptablesAddOutputFixUdpChecksum: - * @ctx: pointer to the IP table context - * @iface: the interface name - * @port: the UDP port to match - * - * Add a rule to the mangle table's POSTROUTING chain that fixes up the - * checksum of packets with the given destination @port. - * the given @iface interface for TCP packets. - * - * Returns 0 in case of success or an error code in case of error. - * (NB: if the system's iptables does not support checksum mangling, - * this will return an error, which should be ignored.) - */ - -int -iptablesAddOutputFixUdpChecksum(iptablesContext *ctx, - const char *iface, - int port) -{ - return iptablesOutputFixUdpChecksum(ctx, iface, port, ADD); -} - -/** - * iptablesRemoveOutputFixUdpChecksum: - * @ctx: pointer to the IP table context - * @iface: the interface name - * @port: the UDP port of the rule to remove - * - * Removes the checksum fixup rule that was previous added with - * iptablesAddOutputFixUdpChecksum. - * - * Returns 0 in case of success or an error code in case of error - * (again, if iptables doesn't support checksum fixup, this will - * return an error, which should be ignored) - */ -int -iptablesRemoveOutputFixUdpChecksum(iptablesContext *ctx, - const char *iface, - int port) -{ - return iptablesOutputFixUdpChecksum(ctx, iface, port, REMOVE); -} diff --git a/src/util/iptables.h b/src/util/iptables.h deleted file mode 100644 index e54f8b1..0000000 --- a/src/util/iptables.h +++ /dev/null @@ -1,121 +0,0 @@ -/* - * Copyright (C) 2007, 2008 Red Hat, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Authors: - * Mark McLoughlin <markmc(a)redhat.com&gt; - */ - -#ifndef __QEMUD_IPTABLES_H__ -# define __QEMUD_IPTABLES_H__ - -# include "virsocketaddr.h" - -typedef struct _iptablesContext iptablesContext; - -iptablesContext *iptablesContextNew (void); -void iptablesContextFree (iptablesContext *ctx); - -int iptablesAddTcpInput (iptablesContext *ctx, - int family, - const char *iface, - int port); -int iptablesRemoveTcpInput (iptablesContext *ctx, - int family, - const char *iface, - int port); - -int iptablesAddUdpInput (iptablesContext *ctx, - int family, - const char *iface, - int port); -int iptablesRemoveUdpInput (iptablesContext *ctx, - int family, - const char *iface, - int port); - -int iptablesAddForwardAllowOut (iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev); -int iptablesRemoveForwardAllowOut (iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev); - -int iptablesAddForwardAllowRelatedIn(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev); -int iptablesRemoveForwardAllowRelatedIn(iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev); - -int iptablesAddForwardAllowIn (iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev); -int iptablesRemoveForwardAllowIn (iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *iface, - const char *physdev); - -int iptablesAddForwardAllowCross (iptablesContext *ctx, - int family, - const char *iface); -int iptablesRemoveForwardAllowCross (iptablesContext *ctx, - int family, - const char *iface); - -int iptablesAddForwardRejectOut (iptablesContext *ctx, - int family, - const char *iface); -int iptablesRemoveForwardRejectOut (iptablesContext *ctx, - int family, - const char *iface); - -int iptablesAddForwardRejectIn (iptablesContext *ctx, - int family, - const char *iface); -int iptablesRemoveForwardRejectIn (iptablesContext *ctx, - int family, - const char *iface); - -int iptablesAddForwardMasquerade (iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *physdev, - const char *protocol); -int iptablesRemoveForwardMasquerade (iptablesContext *ctx, - virSocketAddr *netaddr, - unsigned int prefix, - const char *physdev, - const char *protocol); -int iptablesAddOutputFixUdpChecksum (iptablesContext *ctx, - const char *iface, - int port); -int iptablesRemoveOutputFixUdpChecksum (iptablesContext *ctx, - const char *iface, - int port); - -#endif /* __QEMUD_IPTABLES_H__ */ diff --git a/src/util/viriptables.c b/src/util/viriptables.c new file mode 100644 index 0000000..8831920 --- /dev/null +++ b/src/util/viriptables.c @@ -0,0 +1,970 @@ +/* + * Copyright (C) 2007-2012 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Authors: + * Mark McLoughlin <markmc(a)redhat.com&gt; + */ + +#include <config.h> + +#include <stdio.h> +#include <stdlib.h> +#include <stdarg.h> +#include <string.h> +#include <errno.h> +#include <limits.h> +#include <unistd.h> +#include <fcntl.h> +#include <sys/types.h> +#include <sys/stat.h> +#include <sys/wait.h> + +#ifdef HAVE_PATHS_H +# include <paths.h> +#endif + +#include "internal.h" +#include "viriptables.h" +#include "vircommand.h" +#include "memory.h" +#include "virterror_internal.h" +#include "logging.h" +#include "threads.h" + +#if HAVE_FIREWALLD +static char *firewall_cmd_path = NULL; + +static int +virIpTablesOnceInit(void) +{ + firewall_cmd_path = virFindFileInPath("firewall-cmd"); + if (!firewall_cmd_path) { + VIR_INFO("firewall-cmd not found on system. " + "firewalld support disabled for iptables."); + } else { + virCommandPtr cmd = virCommandNew(firewall_cmd_path); + int status; + + virCommandAddArgList(cmd, "--state", NULL); + if (virCommandRun(cmd, &status) < 0 || status != 0) { + VIR_INFO("firewall-cmd found but disabled for iptables"); + VIR_FREE(firewall_cmd_path); + firewall_cmd_path = NULL; + } else { + VIR_INFO("using firewalld for iptables commands"); + } + virCommandFree(cmd); + } + return 0; +} + +VIR_ONCE_GLOBAL_INIT(virIpTables) + +#endif + +#define VIR_FROM_THIS VIR_FROM_NONE + +enum { + ADD = 0, + REMOVE +}; + +typedef struct +{ + char *table; + char *chain; +} iptRules; + +struct _iptablesContext +{ + iptRules *input_filter; + iptRules *forward_filter; + iptRules *nat_postrouting; + iptRules *mangle_postrouting; +}; + +static void +iptRulesFree(iptRules *rules) +{ + VIR_FREE(rules->table); + VIR_FREE(rules->chain); + VIR_FREE(rules); +} + +static iptRules * +iptRulesNew(const char *table, + const char *chain) +{ + iptRules *rules; + + if (VIR_ALLOC(rules) < 0) + return NULL; + + if (!(rules->table = strdup(table))) + goto error; + + if (!(rules->chain = strdup(chain))) + goto error; + + return rules; + + error: + iptRulesFree(rules); + return NULL; +} + +static int ATTRIBUTE_SENTINEL +iptablesAddRemoveRule(iptRules *rules, int family, int action, + const char *arg, ...) +{ + va_list args; + int ret; + virCommandPtr cmd = NULL; + const char *s; + +#if HAVE_FIREWALLD + virIpTablesInitialize(); + if (firewall_cmd_path) { + cmd = virCommandNew(firewall_cmd_path); + virCommandAddArgList(cmd, "--direct", "--passthrough", + (family == AF_INET6) ? "ipv6" : "ipv4", NULL); + } +#endif + + if (cmd == NULL) { + cmd = virCommandNew((family == AF_INET6) + ? IP6TABLES_PATH : IPTABLES_PATH); + } + + virCommandAddArgList(cmd, "--table", rules->table, + action == ADD ? "--insert" : "--delete", + rules->chain, arg, NULL); + + va_start(args, arg); + while ((s = va_arg(args, const char *))) + virCommandAddArg(cmd, s); + va_end(args); + + ret = virCommandRun(cmd, NULL); + virCommandFree(cmd); + return ret; +} + +/** + * iptablesContextNew: + * + * Create a new IPtable context + * + * Returns a pointer to the new structure or NULL in case of error + */ +iptablesContext * +iptablesContextNew(void) +{ + iptablesContext *ctx; + + if (VIR_ALLOC(ctx) < 0) + return NULL; + + if (!(ctx->input_filter = iptRulesNew("filter", "INPUT"))) + goto error; + + if (!(ctx->forward_filter = iptRulesNew("filter", "FORWARD"))) + goto error; + + if (!(ctx->nat_postrouting = iptRulesNew("nat", "POSTROUTING"))) + goto error; + + if (!(ctx->mangle_postrouting = iptRulesNew("mangle", "POSTROUTING"))) + goto error; + + return ctx; + + error: + iptablesContextFree(ctx); + return NULL; +} + +/** + * iptablesContextFree: + * @ctx: pointer to the IP table context + * + * Free the resources associated with an IP table context + */ +void +iptablesContextFree(iptablesContext *ctx) +{ + if (ctx->input_filter) + iptRulesFree(ctx->input_filter); + if (ctx->forward_filter) + iptRulesFree(ctx->forward_filter); + if (ctx->nat_postrouting) + iptRulesFree(ctx->nat_postrouting); + if (ctx->mangle_postrouting) + iptRulesFree(ctx->mangle_postrouting); + VIR_FREE(ctx); +} + +static int +iptablesInput(iptablesContext *ctx, + int family, + const char *iface, + int port, + int action, + int tcp) +{ + char portstr[32]; + + snprintf(portstr, sizeof(portstr), "%d", port); + portstr[sizeof(portstr) - 1] = '\0'; + + return iptablesAddRemoveRule(ctx->input_filter, + family, + action, + "--in-interface", iface, + "--protocol", tcp ? "tcp" : "udp", + "--destination-port", portstr, + "--jump", "ACCEPT", + NULL); +} + +/** + * iptablesAddTcpInput: + * @ctx: pointer to the IP table context + * @iface: the interface name + * @port: the TCP port to add + * + * Add an input to the IP table allowing access to the given @port on + * the given @iface interface for TCP packets + * + * Returns 0 in case of success or an error code in case of error + */ + +int +iptablesAddTcpInput(iptablesContext *ctx, + int family, + const char *iface, + int port) +{ + return iptablesInput(ctx, family, iface, port, ADD, 1); +} + +/** + * iptablesRemoveTcpInput: + * @ctx: pointer to the IP table context + * @iface: the interface name + * @port: the TCP port to remove + * + * Removes an input from the IP table, hence forbidding access to the given + * @port on the given @iface interface for TCP packets + * + * Returns 0 in case of success or an error code in case of error + */ +int +iptablesRemoveTcpInput(iptablesContext *ctx, + int family, + const char *iface, + int port) +{ + return iptablesInput(ctx, family, iface, port, REMOVE, 1); +} + +/** + * iptablesAddUdpInput: + * @ctx: pointer to the IP table context + * @iface: the interface name + * @port: the UDP port to add + * + * Add an input to the IP table allowing access to the given @port on + * the given @iface interface for UDP packets + * + * Returns 0 in case of success or an error code in case of error + */ + +int +iptablesAddUdpInput(iptablesContext *ctx, + int family, + const char *iface, + int port) +{ + return iptablesInput(ctx, family, iface, port, ADD, 0); +} + +/** + * iptablesRemoveUdpInput: + * @ctx: pointer to the IP table context + * @iface: the interface name + * @port: the UDP port to remove + * + * Removes an input from the IP table, hence forbidding access to the given + * @port on the given @iface interface for UDP packets + * + * Returns 0 in case of success or an error code in case of error + */ +int +iptablesRemoveUdpInput(iptablesContext *ctx, + int family, + const char *iface, + int port) +{ + return iptablesInput(ctx, family, iface, port, REMOVE, 0); +} + + +static char *iptablesFormatNetwork(virSocketAddr *netaddr, + unsigned int prefix) +{ + virSocketAddr network; + char *netstr; + char *ret; + + if (!(VIR_SOCKET_ADDR_IS_FAMILY(netaddr, AF_INET) || + VIR_SOCKET_ADDR_IS_FAMILY(netaddr, AF_INET6))) { + virReportError(VIR_ERR_CONFIG_UNSUPPORTED, "%s", + _("Only IPv4 or IPv6 addresses can be used with iptables")); + return NULL; + } + + if (virSocketAddrMaskByPrefix(netaddr, prefix, &network) < 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Failure to mask address")); + return NULL; + } + + netstr = virSocketAddrFormat(&network); + + if (!netstr) + return NULL; + + if (virAsprintf(&ret, "%s/%d", netstr, prefix) < 0) + virReportOOMError(); + + VIR_FREE(netstr); + return ret; +} + + +/* Allow all traffic coming from the bridge, with a valid network address + * to proceed to WAN + */ +static int +iptablesForwardAllowOut(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev, + int action) +{ + int ret; + char *networkstr; + + if (!(networkstr = iptablesFormatNetwork(netaddr, prefix))) + return -1; + + if (physdev && physdev[0]) { + ret = iptablesAddRemoveRule(ctx->forward_filter, + VIR_SOCKET_ADDR_FAMILY(netaddr), + action, + "--source", networkstr, + "--in-interface", iface, + "--out-interface", physdev, + "--jump", "ACCEPT", + NULL); + } else { + ret = iptablesAddRemoveRule(ctx->forward_filter, + VIR_SOCKET_ADDR_FAMILY(netaddr), + action, + "--source", networkstr, + "--in-interface", iface, + "--jump", "ACCEPT", + NULL); + } + VIR_FREE(networkstr); + return ret; +} + +/** + * iptablesAddForwardAllowOut: + * @ctx: pointer to the IP table context + * @network: the source network name + * @iface: the source interface name + * @physdev: the physical output device + * + * Add a rule to the IP table context to allow the traffic for the + * network @network via interface @iface to be forwarded to + * @physdev device. This allow the outbound traffic on a bridge. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesAddForwardAllowOut(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev) +{ + return iptablesForwardAllowOut(ctx, netaddr, prefix, iface, physdev, ADD); +} + +/** + * iptablesRemoveForwardAllowOut: + * @ctx: pointer to the IP table context + * @network: the source network name + * @iface: the source interface name + * @physdev: the physical output device + * + * Remove a rule from the IP table context hence forbidding forwarding + * of the traffic for the network @network via interface @iface + * to the @physdev device output. This stops the outbound traffic on a bridge. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesRemoveForwardAllowOut(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev) +{ + return iptablesForwardAllowOut(ctx, netaddr, prefix, iface, physdev, REMOVE); +} + + +/* Allow all traffic destined to the bridge, with a valid network address + * and associated with an existing connection + */ +static int +iptablesForwardAllowRelatedIn(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev, + int action) +{ + int ret; + char *networkstr; + + if (!(networkstr = iptablesFormatNetwork(netaddr, prefix))) + return -1; + + if (physdev && physdev[0]) { + ret = iptablesAddRemoveRule(ctx->forward_filter, + VIR_SOCKET_ADDR_FAMILY(netaddr), + action, + "--destination", networkstr, + "--in-interface", physdev, + "--out-interface", iface, + "--match", "state", + "--state", "ESTABLISHED,RELATED", + "--jump", "ACCEPT", + NULL); + } else { + ret = iptablesAddRemoveRule(ctx->forward_filter, + VIR_SOCKET_ADDR_FAMILY(netaddr), + action, + "--destination", networkstr, + "--out-interface", iface, + "--match", "state", + "--state", "ESTABLISHED,RELATED", + "--jump", "ACCEPT", + NULL); + } + VIR_FREE(networkstr); + return ret; +} + +/** + * iptablesAddForwardAllowRelatedIn: + * @ctx: pointer to the IP table context + * @network: the source network name + * @iface: the output interface name + * @physdev: the physical input device or NULL + * + * Add rules to the IP table context to allow the traffic for the + * network @network on @physdev device to be forwarded to + * interface @iface, if it is part of an existing connection. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesAddForwardAllowRelatedIn(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev) +{ + return iptablesForwardAllowRelatedIn(ctx, netaddr, prefix, iface, physdev, ADD); +} + +/** + * iptablesRemoveForwardAllowRelatedIn: + * @ctx: pointer to the IP table context + * @network: the source network name + * @iface: the output interface name + * @physdev: the physical input device or NULL + * + * Remove rules from the IP table context hence forbidding the traffic for + * network @network on @physdev device to be forwarded to + * interface @iface, if it is part of an existing connection. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesRemoveForwardAllowRelatedIn(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev) +{ + return iptablesForwardAllowRelatedIn(ctx, netaddr, prefix, iface, physdev, REMOVE); +} + +/* Allow all traffic destined to the bridge, with a valid network address + */ +static int +iptablesForwardAllowIn(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev, + int action) +{ + int ret; + char *networkstr; + + if (!(networkstr = iptablesFormatNetwork(netaddr, prefix))) + return -1; + + if (physdev && physdev[0]) { + ret = iptablesAddRemoveRule(ctx->forward_filter, + VIR_SOCKET_ADDR_FAMILY(netaddr), + action, + "--destination", networkstr, + "--in-interface", physdev, + "--out-interface", iface, + "--jump", "ACCEPT", + NULL); + } else { + ret = iptablesAddRemoveRule(ctx->forward_filter, + VIR_SOCKET_ADDR_FAMILY(netaddr), + action, + "--destination", networkstr, + "--out-interface", iface, + "--jump", "ACCEPT", + NULL); + } + VIR_FREE(networkstr); + return ret; +} + +/** + * iptablesAddForwardAllowIn: + * @ctx: pointer to the IP table context + * @network: the source network name + * @iface: the output interface name + * @physdev: the physical input device or NULL + * + * Add rules to the IP table context to allow the traffic for the + * network @network on @physdev device to be forwarded to + * interface @iface. This allow the inbound traffic on a bridge. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesAddForwardAllowIn(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev) +{ + return iptablesForwardAllowIn(ctx, netaddr, prefix, iface, physdev, ADD); +} + +/** + * iptablesRemoveForwardAllowIn: + * @ctx: pointer to the IP table context + * @network: the source network name + * @iface: the output interface name + * @physdev: the physical input device or NULL + * + * Remove rules from the IP table context hence forbidding the traffic for + * network @network on @physdev device to be forwarded to + * interface @iface. This stops the inbound traffic on a bridge. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesRemoveForwardAllowIn(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev) +{ + return iptablesForwardAllowIn(ctx, netaddr, prefix, iface, physdev, REMOVE); +} + + +/* Allow all traffic between guests on the same bridge, + * with a valid network address + */ +static int +iptablesForwardAllowCross(iptablesContext *ctx, + int family, + const char *iface, + int action) +{ + return iptablesAddRemoveRule(ctx->forward_filter, + family, + action, + "--in-interface", iface, + "--out-interface", iface, + "--jump", "ACCEPT", + NULL); +} + +/** + * iptablesAddForwardAllowCross: + * @ctx: pointer to the IP table context + * @iface: the input/output interface name + * + * Add rules to the IP table context to allow traffic to cross that + * interface. It allows all traffic between guests on the same bridge + * represented by that interface. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesAddForwardAllowCross(iptablesContext *ctx, + int family, + const char *iface) +{ + return iptablesForwardAllowCross(ctx, family, iface, ADD); +} + +/** + * iptablesRemoveForwardAllowCross: + * @ctx: pointer to the IP table context + * @iface: the input/output interface name + * + * Remove rules to the IP table context to block traffic to cross that + * interface. It forbids traffic between guests on the same bridge + * represented by that interface. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesRemoveForwardAllowCross(iptablesContext *ctx, + int family, + const char *iface) +{ + return iptablesForwardAllowCross(ctx, family, iface, REMOVE); +} + + +/* Drop all traffic trying to forward from the bridge. + * ie the bridge is the in interface + */ +static int +iptablesForwardRejectOut(iptablesContext *ctx, + int family, + const char *iface, + int action) +{ + return iptablesAddRemoveRule(ctx->forward_filter, + family, + action, + "--in-interface", iface, + "--jump", "REJECT", + NULL); +} + +/** + * iptablesAddForwardRejectOut: + * @ctx: pointer to the IP table context + * @iface: the output interface name + * + * Add rules to the IP table context to forbid all traffic to that + * interface. It forbids forwarding from the bridge to that interface. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesAddForwardRejectOut(iptablesContext *ctx, + int family, + const char *iface) +{ + return iptablesForwardRejectOut(ctx, family, iface, ADD); +} + +/** + * iptablesRemoveForwardRejectOut: + * @ctx: pointer to the IP table context + * @iface: the output interface name + * + * Remove rules from the IP table context forbidding all traffic to that + * interface. It reallow forwarding from the bridge to that interface. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesRemoveForwardRejectOut(iptablesContext *ctx, + int family, + const char *iface) +{ + return iptablesForwardRejectOut(ctx, family, iface, REMOVE); +} + + + + +/* Drop all traffic trying to forward to the bridge. + * ie the bridge is the out interface + */ +static int +iptablesForwardRejectIn(iptablesContext *ctx, + int family, + const char *iface, + int action) +{ + return iptablesAddRemoveRule(ctx->forward_filter, + family, + action, + "--out-interface", iface, + "--jump", "REJECT", + NULL); +} + +/** + * iptablesAddForwardRejectIn: + * @ctx: pointer to the IP table context + * @iface: the input interface name + * + * Add rules to the IP table context to forbid all traffic from that + * interface. It forbids forwarding from that interface to the bridge. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesAddForwardRejectIn(iptablesContext *ctx, + int family, + const char *iface) +{ + return iptablesForwardRejectIn(ctx, family, iface, ADD); +} + +/** + * iptablesRemoveForwardRejectIn: + * @ctx: pointer to the IP table context + * @iface: the input interface name + * + * Remove rules from the IP table context forbidding all traffic from that + * interface. It allows forwarding from that interface to the bridge. + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesRemoveForwardRejectIn(iptablesContext *ctx, + int family, + const char *iface) +{ + return iptablesForwardRejectIn(ctx, family, iface, REMOVE); +} + + +/* Masquerade all traffic coming from the network associated + * with the bridge + */ +static int +iptablesForwardMasquerade(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *physdev, + const char *protocol, + int action) +{ + int ret; + char *networkstr; + + if (!(networkstr = iptablesFormatNetwork(netaddr, prefix))) + return -1; + + if (!VIR_SOCKET_ADDR_IS_FAMILY(netaddr, AF_INET)) { + /* Higher level code *should* guaranteee it's impossible to get here. */ + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Attempted to NAT '%s'. NAT is only supported for IPv4."), + networkstr); + VIR_FREE(networkstr); + return -1; + } + + if (protocol && protocol[0]) { + if (physdev && physdev[0]) { + ret = iptablesAddRemoveRule(ctx->nat_postrouting, + AF_INET, + action, + "--source", networkstr, + "-p", protocol, + "!", "--destination", networkstr, + "--out-interface", physdev, + "--jump", "MASQUERADE", + "--to-ports", "1024-65535", + NULL); + } else { + ret = iptablesAddRemoveRule(ctx->nat_postrouting, + AF_INET, + action, + "--source", networkstr, + "-p", protocol, + "!", "--destination", networkstr, + "--jump", "MASQUERADE", + "--to-ports", "1024-65535", + NULL); + } + } else { + if (physdev && physdev[0]) { + ret = iptablesAddRemoveRule(ctx->nat_postrouting, + AF_INET, + action, + "--source", networkstr, + "!", "--destination", networkstr, + "--out-interface", physdev, + "--jump", "MASQUERADE", + NULL); + } else { + ret = iptablesAddRemoveRule(ctx->nat_postrouting, + AF_INET, + action, + "--source", networkstr, + "!", "--destination", networkstr, + "--jump", "MASQUERADE", + NULL); + } + } + VIR_FREE(networkstr); + return ret; +} + +/** + * iptablesAddForwardMasquerade: + * @ctx: pointer to the IP table context + * @network: the source network name + * @physdev: the physical input device or NULL + * @protocol: the network protocol or NULL + * + * Add rules to the IP table context to allow masquerading + * network @network on @physdev. This allow the bridge to + * masquerade for that network (on @physdev). + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesAddForwardMasquerade(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *physdev, + const char *protocol) +{ + return iptablesForwardMasquerade(ctx, netaddr, prefix, physdev, protocol, ADD); +} + +/** + * iptablesRemoveForwardMasquerade: + * @ctx: pointer to the IP table context + * @network: the source network name + * @physdev: the physical input device or NULL + * @protocol: the network protocol or NULL + * + * Remove rules from the IP table context to stop masquerading + * network @network on @physdev. This stops the bridge from + * masquerading for that network (on @physdev). + * + * Returns 0 in case of success or an error code otherwise + */ +int +iptablesRemoveForwardMasquerade(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *physdev, + const char *protocol) +{ + return iptablesForwardMasquerade(ctx, netaddr, prefix, physdev, protocol, REMOVE); +} + + +static int +iptablesOutputFixUdpChecksum(iptablesContext *ctx, + const char *iface, + int port, + int action) +{ + char portstr[32]; + + snprintf(portstr, sizeof(portstr), "%d", port); + portstr[sizeof(portstr) - 1] = '\0'; + + return iptablesAddRemoveRule(ctx->mangle_postrouting, + AF_INET, + action, + "--out-interface", iface, + "--protocol", "udp", + "--destination-port", portstr, + "--jump", "CHECKSUM", "--checksum-fill", + NULL); +} + +/** + * iptablesAddOutputFixUdpChecksum: + * @ctx: pointer to the IP table context + * @iface: the interface name + * @port: the UDP port to match + * + * Add a rule to the mangle table's POSTROUTING chain that fixes up the + * checksum of packets with the given destination @port. + * the given @iface interface for TCP packets. + * + * Returns 0 in case of success or an error code in case of error. + * (NB: if the system's iptables does not support checksum mangling, + * this will return an error, which should be ignored.) + */ + +int +iptablesAddOutputFixUdpChecksum(iptablesContext *ctx, + const char *iface, + int port) +{ + return iptablesOutputFixUdpChecksum(ctx, iface, port, ADD); +} + +/** + * iptablesRemoveOutputFixUdpChecksum: + * @ctx: pointer to the IP table context + * @iface: the interface name + * @port: the UDP port of the rule to remove + * + * Removes the checksum fixup rule that was previous added with + * iptablesAddOutputFixUdpChecksum. + * + * Returns 0 in case of success or an error code in case of error + * (again, if iptables doesn't support checksum fixup, this will + * return an error, which should be ignored) + */ +int +iptablesRemoveOutputFixUdpChecksum(iptablesContext *ctx, + const char *iface, + int port) +{ + return iptablesOutputFixUdpChecksum(ctx, iface, port, REMOVE); +} diff --git a/src/util/viriptables.h b/src/util/viriptables.h new file mode 100644 index 0000000..e54f8b1 --- /dev/null +++ b/src/util/viriptables.h @@ -0,0 +1,121 @@ +/* + * Copyright (C) 2007, 2008 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Authors: + * Mark McLoughlin <markmc(a)redhat.com&gt; + */ + +#ifndef __QEMUD_IPTABLES_H__ +# define __QEMUD_IPTABLES_H__ + +# include "virsocketaddr.h" + +typedef struct _iptablesContext iptablesContext; + +iptablesContext *iptablesContextNew (void); +void iptablesContextFree (iptablesContext *ctx); + +int iptablesAddTcpInput (iptablesContext *ctx, + int family, + const char *iface, + int port); +int iptablesRemoveTcpInput (iptablesContext *ctx, + int family, + const char *iface, + int port); + +int iptablesAddUdpInput (iptablesContext *ctx, + int family, + const char *iface, + int port); +int iptablesRemoveUdpInput (iptablesContext *ctx, + int family, + const char *iface, + int port); + +int iptablesAddForwardAllowOut (iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev); +int iptablesRemoveForwardAllowOut (iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev); + +int iptablesAddForwardAllowRelatedIn(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev); +int iptablesRemoveForwardAllowRelatedIn(iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev); + +int iptablesAddForwardAllowIn (iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev); +int iptablesRemoveForwardAllowIn (iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *iface, + const char *physdev); + +int iptablesAddForwardAllowCross (iptablesContext *ctx, + int family, + const char *iface); +int iptablesRemoveForwardAllowCross (iptablesContext *ctx, + int family, + const char *iface); + +int iptablesAddForwardRejectOut (iptablesContext *ctx, + int family, + const char *iface); +int iptablesRemoveForwardRejectOut (iptablesContext *ctx, + int family, + const char *iface); + +int iptablesAddForwardRejectIn (iptablesContext *ctx, + int family, + const char *iface); +int iptablesRemoveForwardRejectIn (iptablesContext *ctx, + int family, + const char *iface); + +int iptablesAddForwardMasquerade (iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *physdev, + const char *protocol); +int iptablesRemoveForwardMasquerade (iptablesContext *ctx, + virSocketAddr *netaddr, + unsigned int prefix, + const char *physdev, + const char *protocol); +int iptablesAddOutputFixUdpChecksum (iptablesContext *ctx, + const char *iface, + int port); +int iptablesRemoveOutputFixUdpChecksum (iptablesContext *ctx, + const char *iface, + int port); + +#endif /* __QEMUD_IPTABLES_H__ */ -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- daemon/libvirtd-config.c | 2 +- daemon/libvirtd.h | 2 +- daemon/remote.c | 2 +- daemon/stream.c | 2 +- src/Makefile.am | 2 +- src/conf/domain_audit.c | 2 +- src/conf/domain_conf.c | 2 +- src/conf/domain_event.c | 2 +- src/conf/nwfilter_params.c | 2 +- src/conf/secret_conf.c | 2 +- src/conf/snapshot_conf.c | 2 +- src/conf/virconsole.c | 2 +- src/cpu/cpu.c | 2 +- src/cpu/cpu_powerpc.c | 2 +- src/cpu/cpu_x86.c | 2 +- src/datatypes.c | 2 +- src/driver.c | 2 +- src/esx/esx_device_monitor.c | 2 +- src/esx/esx_driver.c | 2 +- src/esx/esx_interface_driver.c | 2 +- src/esx/esx_network_driver.c | 2 +- src/esx/esx_nwfilter_driver.c | 2 +- src/esx/esx_secret_driver.c | 2 +- src/esx/esx_storage_backend_iscsi.c | 2 +- src/esx/esx_storage_backend_vmfs.c | 2 +- src/esx/esx_util.c | 2 +- src/esx/esx_vi.c | 2 +- src/esx/esx_vi_methods.c | 2 +- src/esx/esx_vi_types.c | 2 +- src/fdstream.c | 2 +- src/hyperv/hyperv_device_monitor.c | 2 +- src/hyperv/hyperv_driver.c | 2 +- src/hyperv/hyperv_interface_driver.c | 2 +- src/hyperv/hyperv_network_driver.c | 2 +- src/hyperv/hyperv_nwfilter_driver.c | 2 +- src/hyperv/hyperv_secret_driver.c | 2 +- src/hyperv/hyperv_storage_driver.c | 2 +- src/hyperv/hyperv_util.c | 2 +- src/hyperv/hyperv_wmi.c | 2 +- src/interface/interface_backend_netcf.c | 2 +- src/libvirt-qemu.c | 2 +- src/libvirt.c | 2 +- src/libxl/libxl_conf.c | 2 +- src/libxl/libxl_driver.c | 2 +- src/locking/domain_lock.c | 2 +- src/locking/lock_daemon.c | 2 +- src/locking/lock_daemon_config.c | 2 +- src/locking/lock_daemon_dispatch.c | 2 +- src/locking/lock_driver_lockd.c | 2 +- src/locking/lock_driver_nop.c | 2 +- src/locking/lock_driver_sanlock.c | 2 +- src/locking/lock_manager.c | 2 +- src/lxc/lxc_cgroup.c | 2 +- src/lxc/lxc_conf.c | 2 +- src/lxc/lxc_container.c | 2 +- src/lxc/lxc_controller.c | 2 +- src/lxc/lxc_domain.c | 2 +- src/lxc/lxc_driver.c | 2 +- src/lxc/lxc_fuse.c | 2 +- src/lxc/lxc_monitor.c | 2 +- src/lxc/lxc_process.c | 2 +- src/network/bridge_driver.c | 2 +- src/node_device/node_device_driver.c | 2 +- src/node_device/node_device_hal.c | 2 +- src/node_device/node_device_linux_sysfs.c | 2 +- src/node_device/node_device_udev.c | 2 +- src/nodeinfo.c | 2 +- src/nwfilter/nwfilter_dhcpsnoop.c | 2 +- src/nwfilter/nwfilter_driver.c | 2 +- src/nwfilter/nwfilter_ebiptables_driver.c | 2 +- src/nwfilter/nwfilter_gentech_driver.c | 2 +- src/nwfilter/nwfilter_learnipaddr.c | 2 +- src/openvz/openvz_driver.c | 2 +- src/parallels/parallels_driver.c | 2 +- src/phyp/phyp_driver.c | 2 +- src/qemu/qemu_agent.c | 2 +- src/qemu/qemu_bridge_filter.c | 2 +- src/qemu/qemu_capabilities.c | 2 +- src/qemu/qemu_cgroup.c | 2 +- src/qemu/qemu_command.c | 2 +- src/qemu/qemu_conf.c | 2 +- src/qemu/qemu_domain.c | 2 +- src/qemu/qemu_driver.c | 2 +- src/qemu/qemu_hostdev.c | 2 +- src/qemu/qemu_hotplug.c | 2 +- src/qemu/qemu_migration.c | 2 +- src/qemu/qemu_monitor.c | 2 +- src/qemu/qemu_monitor_json.c | 2 +- src/qemu/qemu_monitor_text.c | 2 +- src/qemu/qemu_process.c | 2 +- src/remote/remote_driver.c | 2 +- src/rpc/virkeepalive.c | 2 +- src/rpc/virnetclient.c | 2 +- src/rpc/virnetclientprogram.c | 2 +- src/rpc/virnetclientstream.c | 2 +- src/rpc/virnetmessage.c | 2 +- src/rpc/virnetsaslcontext.c | 2 +- src/rpc/virnetserver.c | 2 +- src/rpc/virnetserverclient.c | 2 +- src/rpc/virnetservermdns.c | 2 +- src/rpc/virnetserverprogram.c | 2 +- src/rpc/virnetsocket.c | 2 +- src/rpc/virnetsshsession.c | 2 +- src/rpc/virnettlscontext.c | 2 +- src/secret/secret_driver.c | 2 +- src/security/security_apparmor.c | 2 +- src/security/security_dac.c | 2 +- src/security/security_driver.c | 2 +- src/security/security_manager.c | 2 +- src/security/security_selinux.c | 2 +- src/storage/storage_backend.c | 2 +- src/storage/storage_backend_disk.c | 2 +- src/storage/storage_backend_fs.c | 2 +- src/storage/storage_backend_iscsi.c | 2 +- src/storage/storage_backend_logical.c | 2 +- src/storage/storage_backend_mpath.c | 2 +- src/storage/storage_backend_rbd.c | 2 +- src/storage/storage_backend_scsi.c | 2 +- src/storage/storage_backend_sheepdog.c | 2 +- src/storage/storage_driver.c | 2 +- src/test/test_driver.c | 2 +- src/uml/uml_conf.c | 2 +- src/uml/uml_driver.c | 2 +- src/util/logging.c | 1590 ----------------------------- src/util/logging.h | 191 ---- src/util/memory.c | 2 +- src/util/pci.c | 2 +- src/util/storage_file.c | 2 +- src/util/sysinfo.c | 2 +- src/util/util.c | 2 +- src/util/uuid.c | 2 +- src/util/viraudit.c | 2 +- src/util/virauth.c | 2 +- src/util/virauthconfig.c | 2 +- src/util/vircgroup.c | 2 +- src/util/vircommand.c | 2 +- src/util/virconf.c | 2 +- src/util/virdbus.c | 2 +- src/util/virdnsmasq.c | 2 +- src/util/virebtables.c | 2 +- src/util/virevent.c | 2 +- src/util/vireventpoll.c | 2 +- src/util/virfile.c | 2 +- src/util/virhash.c | 2 +- src/util/virhooks.c | 2 +- src/util/viriptables.c | 2 +- src/util/virjson.c | 2 +- src/util/virkeyfile.c | 2 +- src/util/virlockspace.c | 2 +- src/util/virlog.c | 1590 +++++++++++++++++++++++++++++ src/util/virlog.h | 191 ++++ src/util/virnetdev.c | 2 +- src/util/virnetdevmacvlan.c | 2 +- src/util/virnetdevtap.c | 2 +- src/util/virnetdevveth.c | 2 +- src/util/virnetdevvportprofile.c | 2 +- src/util/virnetlink.c | 2 +- src/util/virnodesuspend.c | 2 +- src/util/virobject.c | 2 +- src/util/virpidfile.c | 2 +- src/util/virprocess.c | 2 +- src/util/virrandom.c | 2 +- src/util/virterror.c | 2 +- src/util/virusb.c | 2 +- src/vbox/vbox_MSCOMGlue.c | 2 +- src/vbox/vbox_XPCOMCGlue.c | 2 +- src/vbox/vbox_driver.c | 2 +- src/vbox/vbox_tmpl.c | 2 +- src/vmx/vmx.c | 2 +- src/xen/xen_driver.c | 2 +- src/xen/xen_hypervisor.c | 2 +- src/xen/xen_inotify.c | 2 +- src/xen/xend_internal.c | 2 +- src/xen/xm_internal.c | 2 +- src/xen/xs_internal.c | 2 +- src/xenapi/xenapi_utils.c | 2 +- src/xenxs/xen_sxpr.c | 2 +- tests/eventtest.c | 2 +- tests/libvirtdconftest.c | 2 +- tests/qemumonitortestutils.c | 2 +- tests/securityselinuxtest.c | 2 +- tests/sockettest.c | 2 +- tests/testutils.c | 2 +- tests/virauthconfigtest.c | 2 +- tests/virdrivermoduletest.c | 2 +- tests/virhashtest.c | 2 +- tests/virkeyfiletest.c | 2 +- tests/virlockspacetest.c | 2 +- tests/virnetmessagetest.c | 2 +- tests/virnetsockettest.c | 2 +- tests/virnettlscontexttest.c | 2 +- tests/virstringtest.c | 2 +- tests/virtimetest.c | 2 +- tests/viruritest.c | 2 +- tools/console.c | 2 +- 195 files changed, 1972 insertions(+), 1972 deletions(-) delete mode 100644 src/util/logging.c delete mode 100644 src/util/logging.h create mode 100644 src/util/virlog.c create mode 100644 src/util/virlog.h diff --git a/daemon/libvirtd-config.c b/daemon/libvirtd-config.c index 0ca185c..f61f08d 100644 --- a/daemon/libvirtd-config.c +++ b/daemon/libvirtd-config.c @@ -27,7 +27,7 @@ #include "virconf.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "rpc/virnetserver.h" #include "configmake.h" #include "remote/remote_protocol.h" diff --git a/daemon/libvirtd.h b/daemon/libvirtd.h index e389151..b04cc71 100644 --- a/daemon/libvirtd.h +++ b/daemon/libvirtd.h @@ -33,7 +33,7 @@ # include <rpc/xdr.h> # include "remote_protocol.h" # include "qemu_protocol.h" -# include "logging.h" +# include "virlog.h" # include "threads.h" # if HAVE_SASL # include "virnetsaslcontext.h" diff --git a/daemon/remote.c b/daemon/remote.c index 1746280..58ceb39 100644 --- a/daemon/remote.c +++ b/daemon/remote.c @@ -34,7 +34,7 @@ #include "libvirt_internal.h" #include "datatypes.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include "stream.h" #include "uuid.h" diff --git a/daemon/stream.c b/daemon/stream.c index fa14eeb..d63e009 100644 --- a/daemon/stream.c +++ b/daemon/stream.c @@ -26,7 +26,7 @@ #include "stream.h" #include "remote.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virnetserverclient.h" #include "virterror_internal.h" diff --git a/src/Makefile.am b/src/Makefile.am index dd49851..93da171 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -53,7 +53,6 @@ augeastest_DATA = # These files are not related to driver APIs. Simply generic # helper APIs for various purposes UTIL_SOURCES = \ - util/logging.c util/logging.h \ util/memory.c util/memory.h \ util/pci.c util/pci.h \ util/processinfo.c util/processinfo.h \ @@ -84,6 +83,7 @@ UTIL_SOURCES = \ util/virnodesuspend.c util/virnodesuspend.h \ util/viriptables.c util/viriptables.h \ util/virjson.c util/virjson.h \ + util/virlog.c util/virlog.h \ util/virobject.c util/virobject.h \ util/virpidfile.c util/virpidfile.h \ util/virprocess.c util/virprocess.h \ diff --git a/src/conf/domain_audit.c b/src/conf/domain_audit.c index 939d213..5fca6a6 100644 --- a/src/conf/domain_audit.c +++ b/src/conf/domain_audit.c @@ -29,7 +29,7 @@ #include "domain_audit.h" #include "viraudit.h" #include "uuid.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" /* Return nn:mm in hex for block and character devices, and NULL diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c index d1fadc3..c48adf5 100644 --- a/src/conf/domain_conf.c +++ b/src/conf/domain_conf.c @@ -40,7 +40,7 @@ #include "uuid.h" #include "util.h" #include "virbuffer.h" -#include "logging.h" +#include "virlog.h" #include "nwfilter_conf.h" #include "storage_file.h" #include "virfile.h" diff --git a/src/conf/domain_event.c b/src/conf/domain_event.c index cf37308..f1e247b 100644 --- a/src/conf/domain_event.c +++ b/src/conf/domain_event.c @@ -24,7 +24,7 @@ #include <config.h> #include "domain_event.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "memory.h" #include "virterror_internal.h" diff --git a/src/conf/nwfilter_params.c b/src/conf/nwfilter_params.c index 7254519..f8cf980 100644 --- a/src/conf/nwfilter_params.c +++ b/src/conf/nwfilter_params.c @@ -30,7 +30,7 @@ #include "datatypes.h" #include "nwfilter_params.h" #include "domain_conf.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_NWFILTER diff --git a/src/conf/secret_conf.c b/src/conf/secret_conf.c index ec67f57..24d7aa0 100644 --- a/src/conf/secret_conf.c +++ b/src/conf/secret_conf.c @@ -25,7 +25,7 @@ #include "internal.h" #include "virbuffer.h" #include "datatypes.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "secret_conf.h" #include "virterror_internal.h" diff --git a/src/conf/snapshot_conf.c b/src/conf/snapshot_conf.c index 38a3e2a..6361810 100644 --- a/src/conf/snapshot_conf.c +++ b/src/conf/snapshot_conf.c @@ -34,7 +34,7 @@ #include "count-one-bits.h" #include "datatypes.h" #include "domain_conf.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "netdev_bandwidth_conf.h" #include "netdev_vport_profile_conf.h" diff --git a/src/conf/virconsole.c b/src/conf/virconsole.c index 143c1a6..92179cc 100644 --- a/src/conf/virconsole.c +++ b/src/conf/virconsole.c @@ -34,7 +34,7 @@ #include "threads.h" #include "memory.h" #include "virpidfile.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "virfile.h" diff --git a/src/cpu/cpu.c b/src/cpu/cpu.c index 4263b88..17a06f3 100644 --- a/src/cpu/cpu.c +++ b/src/cpu/cpu.c @@ -23,7 +23,7 @@ #include <config.h> -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "xml.h" #include "cpu.h" diff --git a/src/cpu/cpu_powerpc.c b/src/cpu/cpu_powerpc.c index 363d6c1..c59bd1b 100644 --- a/src/cpu/cpu_powerpc.c +++ b/src/cpu/cpu_powerpc.c @@ -26,7 +26,7 @@ #include <config.h> #include <stdint.h> -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "util.h" #include "cpu.h" diff --git a/src/cpu/cpu_x86.c b/src/cpu/cpu_x86.c index 563cd67..bea48a1 100644 --- a/src/cpu/cpu_x86.c +++ b/src/cpu/cpu_x86.c @@ -25,7 +25,7 @@ #include <stdint.h> -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "util.h" #include "cpu.h" diff --git a/src/datatypes.c b/src/datatypes.c index c0ed3a2..73a2fd0 100644 --- a/src/datatypes.c +++ b/src/datatypes.c @@ -24,7 +24,7 @@ #include "datatypes.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "uuid.h" #include "util.h" diff --git a/src/driver.c b/src/driver.c index 6d2feb9..4ef6fd2 100644 --- a/src/driver.c +++ b/src/driver.c @@ -26,7 +26,7 @@ #include "driver.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include "configmake.h" diff --git a/src/esx/esx_device_monitor.c b/src/esx/esx_device_monitor.c index c3f9339..0ad95f5 100644 --- a/src/esx/esx_device_monitor.c +++ b/src/esx/esx_device_monitor.c @@ -27,7 +27,7 @@ #include "internal.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "esx_private.h" #include "esx_device_monitor.h" diff --git a/src/esx/esx_driver.c b/src/esx/esx_driver.c index a858298..a69d149 100644 --- a/src/esx/esx_driver.c +++ b/src/esx/esx_driver.c @@ -30,7 +30,7 @@ #include "virauth.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "vmx.h" #include "virtypedparam.h" diff --git a/src/esx/esx_interface_driver.c b/src/esx/esx_interface_driver.c index 35bc7fa..4760264 100644 --- a/src/esx/esx_interface_driver.c +++ b/src/esx/esx_interface_driver.c @@ -27,7 +27,7 @@ #include "internal.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "interface_conf.h" #include "virsocketaddr.h" diff --git a/src/esx/esx_network_driver.c b/src/esx/esx_network_driver.c index 6a87abd..3e25aa2 100644 --- a/src/esx/esx_network_driver.c +++ b/src/esx/esx_network_driver.c @@ -28,7 +28,7 @@ #include "internal.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "network_conf.h" #include "esx_private.h" diff --git a/src/esx/esx_nwfilter_driver.c b/src/esx/esx_nwfilter_driver.c index 9780ca6..f5e710d 100644 --- a/src/esx/esx_nwfilter_driver.c +++ b/src/esx/esx_nwfilter_driver.c @@ -27,7 +27,7 @@ #include "internal.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "esx_private.h" #include "esx_nwfilter_driver.h" diff --git a/src/esx/esx_secret_driver.c b/src/esx/esx_secret_driver.c index 55b2e9a..2a98644 100644 --- a/src/esx/esx_secret_driver.c +++ b/src/esx/esx_secret_driver.c @@ -26,7 +26,7 @@ #include "internal.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "esx_private.h" #include "esx_secret_driver.h" diff --git a/src/esx/esx_storage_backend_iscsi.c b/src/esx/esx_storage_backend_iscsi.c index b6cde96..5d4eb3c 100644 --- a/src/esx/esx_storage_backend_iscsi.c +++ b/src/esx/esx_storage_backend_iscsi.c @@ -30,7 +30,7 @@ #include "md5.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "storage_conf.h" #include "storage_file.h" diff --git a/src/esx/esx_storage_backend_vmfs.c b/src/esx/esx_storage_backend_vmfs.c index 5ef2981..c8bba9e 100644 --- a/src/esx/esx_storage_backend_vmfs.c +++ b/src/esx/esx_storage_backend_vmfs.c @@ -33,7 +33,7 @@ #include "md5.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "storage_conf.h" #include "storage_file.h" diff --git a/src/esx/esx_util.c b/src/esx/esx_util.c index b807607..6e27fe4 100644 --- a/src/esx/esx_util.c +++ b/src/esx/esx_util.c @@ -30,7 +30,7 @@ #include "datatypes.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "vmx.h" #include "esx_private.h" diff --git a/src/esx/esx_vi.c b/src/esx/esx_vi.c index d645bfb..76192df 100644 --- a/src/esx/esx_vi.c +++ b/src/esx/esx_vi.c @@ -28,7 +28,7 @@ #include "virbuffer.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include "uuid.h" #include "vmx.h" diff --git a/src/esx/esx_vi_methods.c b/src/esx/esx_vi_methods.c index a3c3c8b..a3870ee 100644 --- a/src/esx/esx_vi_methods.c +++ b/src/esx/esx_vi_methods.c @@ -25,7 +25,7 @@ #include "virbuffer.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "esx_vi_methods.h" #include "esx_util.h" diff --git a/src/esx/esx_vi_types.c b/src/esx/esx_vi_types.c index 1654e1b..d0a2c6c 100644 --- a/src/esx/esx_vi_types.c +++ b/src/esx/esx_vi_types.c @@ -30,7 +30,7 @@ #include "virbuffer.h" #include "datatypes.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include "esx_vi.h" #include "esx_vi_types.h" diff --git a/src/fdstream.c b/src/fdstream.c index d1eb04c..fdbd7a2 100644 --- a/src/fdstream.c +++ b/src/fdstream.c @@ -35,7 +35,7 @@ #include "fdstream.h" #include "virterror_internal.h" #include "datatypes.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "util.h" #include "virfile.h" diff --git a/src/hyperv/hyperv_device_monitor.c b/src/hyperv/hyperv_device_monitor.c index e183798..1fa98b2 100644 --- a/src/hyperv/hyperv_device_monitor.c +++ b/src/hyperv/hyperv_device_monitor.c @@ -28,7 +28,7 @@ #include "datatypes.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "hyperv_device_monitor.h" diff --git a/src/hyperv/hyperv_driver.c b/src/hyperv/hyperv_driver.c index 4aed41f..95b0cd9 100644 --- a/src/hyperv/hyperv_driver.c +++ b/src/hyperv/hyperv_driver.c @@ -29,7 +29,7 @@ #include "virauth.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "hyperv_driver.h" #include "hyperv_interface_driver.h" diff --git a/src/hyperv/hyperv_interface_driver.c b/src/hyperv/hyperv_interface_driver.c index 9b1bb37..6a3c2cb 100644 --- a/src/hyperv/hyperv_interface_driver.c +++ b/src/hyperv/hyperv_interface_driver.c @@ -28,7 +28,7 @@ #include "datatypes.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "hyperv_interface_driver.h" diff --git a/src/hyperv/hyperv_network_driver.c b/src/hyperv/hyperv_network_driver.c index 3a61fe6..2f9fcab 100644 --- a/src/hyperv/hyperv_network_driver.c +++ b/src/hyperv/hyperv_network_driver.c @@ -28,7 +28,7 @@ #include "datatypes.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "hyperv_network_driver.h" diff --git a/src/hyperv/hyperv_nwfilter_driver.c b/src/hyperv/hyperv_nwfilter_driver.c index 9d54f82..c490522 100644 --- a/src/hyperv/hyperv_nwfilter_driver.c +++ b/src/hyperv/hyperv_nwfilter_driver.c @@ -28,7 +28,7 @@ #include "datatypes.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "hyperv_nwfilter_driver.h" diff --git a/src/hyperv/hyperv_secret_driver.c b/src/hyperv/hyperv_secret_driver.c index 7ee8ce9..3d58b01 100644 --- a/src/hyperv/hyperv_secret_driver.c +++ b/src/hyperv/hyperv_secret_driver.c @@ -28,7 +28,7 @@ #include "datatypes.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "hyperv_secret_driver.h" diff --git a/src/hyperv/hyperv_storage_driver.c b/src/hyperv/hyperv_storage_driver.c index 2e03162..7fbc14d 100644 --- a/src/hyperv/hyperv_storage_driver.c +++ b/src/hyperv/hyperv_storage_driver.c @@ -28,7 +28,7 @@ #include "datatypes.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "hyperv_storage_driver.h" diff --git a/src/hyperv/hyperv_util.c b/src/hyperv/hyperv_util.c index 3050d61..1ef6dae 100644 --- a/src/hyperv/hyperv_util.c +++ b/src/hyperv/hyperv_util.c @@ -26,7 +26,7 @@ #include "datatypes.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "hyperv_private.h" #include "hyperv_util.h" diff --git a/src/hyperv/hyperv_wmi.c b/src/hyperv/hyperv_wmi.c index 0a6b107..069ebe6 100644 --- a/src/hyperv/hyperv_wmi.c +++ b/src/hyperv/hyperv_wmi.c @@ -27,7 +27,7 @@ #include "internal.h" #include "virterror_internal.h" #include "datatypes.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "util.h" #include "uuid.h" diff --git a/src/interface/interface_backend_netcf.c b/src/interface/interface_backend_netcf.c index 226e020..1f42920 100644 --- a/src/interface/interface_backend_netcf.c +++ b/src/interface/interface_backend_netcf.c @@ -30,7 +30,7 @@ #include "interface_driver.h" #include "interface_conf.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_INTERFACE diff --git a/src/libvirt-qemu.c b/src/libvirt-qemu.c index cc98bbb..8d53b5c 100644 --- a/src/libvirt-qemu.c +++ b/src/libvirt-qemu.c @@ -24,7 +24,7 @@ #include <config.h> #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "libvirt/libvirt-qemu.h" diff --git a/src/libvirt.c b/src/libvirt.c index 8f7a869..d078304 100644 --- a/src/libvirt.c +++ b/src/libvirt.c @@ -46,7 +46,7 @@ #endif #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "driver.h" diff --git a/src/libxl/libxl_conf.c b/src/libxl/libxl_conf.c index 55d2ef4..460d15f 100644 --- a/src/libxl/libxl_conf.c +++ b/src/libxl/libxl_conf.c @@ -32,7 +32,7 @@ #include <sys/utsname.h> #include "internal.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "datatypes.h" #include "virfile.h" diff --git a/src/libxl/libxl_driver.c b/src/libxl/libxl_driver.c index 884fca8..ced7cfa 100644 --- a/src/libxl/libxl_driver.c +++ b/src/libxl/libxl_driver.c @@ -32,7 +32,7 @@ #include <fcntl.h> #include "internal.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "virconf.h" #include "datatypes.h" diff --git a/src/locking/domain_lock.c b/src/locking/domain_lock.c index 1e3da5f..00861cf 100644 --- a/src/locking/domain_lock.c +++ b/src/locking/domain_lock.c @@ -25,7 +25,7 @@ #include "memory.h" #include "uuid.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_LOCKING diff --git a/src/locking/lock_daemon.c b/src/locking/lock_daemon.c index 08caa16..3c2a50c 100644 --- a/src/locking/lock_daemon.c +++ b/src/locking/lock_daemon.c @@ -38,7 +38,7 @@ #include "virpidfile.h" #include "virprocess.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "virconf.h" #include "rpc/virnetserver.h" diff --git a/src/locking/lock_daemon_config.c b/src/locking/lock_daemon_config.c index c2d9a76..9557b8c 100644 --- a/src/locking/lock_daemon_config.c +++ b/src/locking/lock_daemon_config.c @@ -27,7 +27,7 @@ #include "virconf.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "rpc/virnetserver.h" #include "configmake.h" diff --git a/src/locking/lock_daemon_dispatch.c b/src/locking/lock_daemon_dispatch.c index bb4dcfa..78c9726 100644 --- a/src/locking/lock_daemon_dispatch.c +++ b/src/locking/lock_daemon_dispatch.c @@ -25,7 +25,7 @@ #include "rpc/virnetserver.h" #include "rpc/virnetserverclient.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "lock_daemon.h" #include "lock_protocol.h" diff --git a/src/locking/lock_driver_lockd.c b/src/locking/lock_driver_lockd.c index c88c5af..d5d721d 100644 --- a/src/locking/lock_driver_lockd.c +++ b/src/locking/lock_driver_lockd.c @@ -24,7 +24,7 @@ #include "lock_driver.h" #include "virconf.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "util.h" #include "virfile.h" diff --git a/src/locking/lock_driver_nop.c b/src/locking/lock_driver_nop.c index c9ab806..745a0bf 100644 --- a/src/locking/lock_driver_nop.c +++ b/src/locking/lock_driver_nop.c @@ -23,7 +23,7 @@ #include "lock_driver_nop.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" diff --git a/src/locking/lock_driver_sanlock.c b/src/locking/lock_driver_sanlock.c index 2eadc07..1e8df26 100644 --- a/src/locking/lock_driver_sanlock.c +++ b/src/locking/lock_driver_sanlock.c @@ -37,7 +37,7 @@ #include "dirname.h" #include "lock_driver.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "memory.h" #include "util.h" diff --git a/src/locking/lock_manager.c b/src/locking/lock_manager.c index e6d9308..f038d4e 100644 --- a/src/locking/lock_manager.c +++ b/src/locking/lock_manager.c @@ -24,7 +24,7 @@ #include "lock_manager.h" #include "lock_driver_nop.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include "memory.h" #include "uuid.h" diff --git a/src/lxc/lxc_cgroup.c b/src/lxc/lxc_cgroup.c index e354d6c..b8c4308 100644 --- a/src/lxc/lxc_cgroup.c +++ b/src/lxc/lxc_cgroup.c @@ -25,7 +25,7 @@ #include "lxc_container.h" #include "virfile.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "vircgroup.h" diff --git a/src/lxc/lxc_conf.c b/src/lxc/lxc_conf.c index 77667bd..ca36965 100644 --- a/src/lxc/lxc_conf.c +++ b/src/lxc/lxc_conf.c @@ -33,7 +33,7 @@ #include "virterror_internal.h" #include "virconf.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "configmake.h" #include "lxc_container.h" diff --git a/src/lxc/lxc_container.c b/src/lxc/lxc_container.c index 33ebf1f..4aae28e 100644 --- a/src/lxc/lxc_container.c +++ b/src/lxc/lxc_container.c @@ -54,7 +54,7 @@ #endif #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "lxc_container.h" #include "util.h" #include "memory.h" diff --git a/src/lxc/lxc_controller.c b/src/lxc/lxc_controller.c index c9cac5d..78f10ab 100644 --- a/src/lxc/lxc_controller.c +++ b/src/lxc/lxc_controller.c @@ -53,7 +53,7 @@ #endif #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include "lxc_conf.h" diff --git a/src/lxc/lxc_domain.c b/src/lxc/lxc_domain.c index bd80d9f..77a64dd 100644 --- a/src/lxc/lxc_domain.c +++ b/src/lxc/lxc_domain.c @@ -24,7 +24,7 @@ #include "lxc_domain.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #define VIR_FROM_THIS VIR_FROM_LXC diff --git a/src/lxc/lxc_driver.c b/src/lxc/lxc_driver.c index 9c35406..0ab2cb9 100644 --- a/src/lxc/lxc_driver.c +++ b/src/lxc/lxc_driver.c @@ -36,7 +36,7 @@ #include <wait.h> #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "lxc_conf.h" #include "lxc_container.h" diff --git a/src/lxc/lxc_fuse.c b/src/lxc/lxc_fuse.c index 4e7df55..485456e 100644 --- a/src/lxc/lxc_fuse.c +++ b/src/lxc/lxc_fuse.c @@ -32,7 +32,7 @@ #include "lxc_fuse.h" #include "lxc_cgroup.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "virbuffer.h" diff --git a/src/lxc/lxc_monitor.c b/src/lxc/lxc_monitor.c index 4d177c9..9eb587d 100644 --- a/src/lxc/lxc_monitor.c +++ b/src/lxc/lxc_monitor.c @@ -28,7 +28,7 @@ #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "threads.h" #include "rpc/virnetclient.h" diff --git a/src/lxc/lxc_process.c b/src/lxc/lxc_process.c index d59bd2e..02ed226 100644 --- a/src/lxc/lxc_process.c +++ b/src/lxc/lxc_process.c @@ -41,7 +41,7 @@ #include "memory.h" #include "domain_audit.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "vircommand.h" #include "virhooks.h" diff --git a/src/network/bridge_driver.c b/src/network/bridge_driver.c index bc37bde..2a59b84 100644 --- a/src/network/bridge_driver.c +++ b/src/network/bridge_driver.c @@ -57,7 +57,7 @@ #include "memory.h" #include "uuid.h" #include "viriptables.h" -#include "logging.h" +#include "virlog.h" #include "virdnsmasq.h" #include "configmake.h" #include "virnetdev.h" diff --git a/src/node_device/node_device_driver.c b/src/node_device/node_device_driver.c index 4d3e01b..48360e3 100644 --- a/src/node_device/node_device_driver.c +++ b/src/node_device/node_device_driver.c @@ -33,7 +33,7 @@ #include "virterror_internal.h" #include "datatypes.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "node_device_conf.h" #include "node_device_hal.h" #include "node_device_driver.h" diff --git a/src/node_device/node_device_hal.c b/src/node_device/node_device_hal.c index 080aaed..59ba5c3 100644 --- a/src/node_device/node_device_hal.c +++ b/src/node_device/node_device_hal.c @@ -36,7 +36,7 @@ #include "memory.h" #include "uuid.h" #include "pci.h" -#include "logging.h" +#include "virlog.h" #include "node_device_driver.h" #include "virdbus.h" diff --git a/src/node_device/node_device_linux_sysfs.c b/src/node_device/node_device_linux_sysfs.c index 3048e33..fbe0da5 100644 --- a/src/node_device/node_device_linux_sysfs.c +++ b/src/node_device/node_device_linux_sysfs.c @@ -30,7 +30,7 @@ #include "node_device_hal.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #define VIR_FROM_THIS VIR_FROM_NODEDEV diff --git a/src/node_device/node_device_udev.c b/src/node_device/node_device_udev.c index b3499fb..fef00ad 100644 --- a/src/node_device/node_device_udev.c +++ b/src/node_device/node_device_udev.c @@ -32,7 +32,7 @@ #include "node_device_driver.h" #include "driver.h" #include "datatypes.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "uuid.h" #include "util.h" diff --git a/src/nodeinfo.c b/src/nodeinfo.c index 096000b..0019c2b 100644 --- a/src/nodeinfo.c +++ b/src/nodeinfo.c @@ -43,7 +43,7 @@ #include "nodeinfo.h" #include "physmem.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "count-one-bits.h" #include "intprops.h" diff --git a/src/nwfilter/nwfilter_dhcpsnoop.c b/src/nwfilter/nwfilter_dhcpsnoop.c index e4c895f..68aa233 100644 --- a/src/nwfilter/nwfilter_dhcpsnoop.c +++ b/src/nwfilter/nwfilter_dhcpsnoop.c @@ -55,7 +55,7 @@ #include <net/if.h> #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "virterror_internal.h" #include "conf/domain_conf.h" diff --git a/src/nwfilter/nwfilter_driver.c b/src/nwfilter/nwfilter_driver.c index 3aa026a..7fde656 100644 --- a/src/nwfilter/nwfilter_driver.c +++ b/src/nwfilter/nwfilter_driver.c @@ -28,7 +28,7 @@ #include <config.h> #include "virdbus.h" -#include "logging.h" +#include "virlog.h" #include "internal.h" diff --git a/src/nwfilter/nwfilter_ebiptables_driver.c b/src/nwfilter/nwfilter_ebiptables_driver.c index 6966acf..23a43d2 100644 --- a/src/nwfilter/nwfilter_ebiptables_driver.c +++ b/src/nwfilter/nwfilter_ebiptables_driver.c @@ -32,7 +32,7 @@ #include "virbuffer.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "domain_conf.h" #include "nwfilter_conf.h" diff --git a/src/nwfilter/nwfilter_gentech_driver.c b/src/nwfilter/nwfilter_gentech_driver.c index 572acf4..6be4a93 100644 --- a/src/nwfilter/nwfilter_gentech_driver.c +++ b/src/nwfilter/nwfilter_gentech_driver.c @@ -27,7 +27,7 @@ #include "internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "domain_conf.h" #include "virterror_internal.h" #include "nwfilter_gentech_driver.h" diff --git a/src/nwfilter/nwfilter_learnipaddr.c b/src/nwfilter/nwfilter_learnipaddr.c index 361bdce..110eae8 100644 --- a/src/nwfilter/nwfilter_learnipaddr.c +++ b/src/nwfilter/nwfilter_learnipaddr.c @@ -43,7 +43,7 @@ #include "intprops.h" #include "virbuffer.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "virnetdev.h" #include "virterror_internal.h" diff --git a/src/openvz/openvz_driver.c b/src/openvz/openvz_driver.c index 75d52e2..101fa32 100644 --- a/src/openvz/openvz_driver.c +++ b/src/openvz/openvz_driver.c @@ -56,7 +56,7 @@ #include "memory.h" #include "virfile.h" #include "virtypedparam.h" -#include "logging.h" +#include "virlog.h" #include "vircommand.h" #include "viruri.h" #include "stats_linux.h" diff --git a/src/parallels/parallels_driver.c b/src/parallels/parallels_driver.c index 648cb48..4e6f903 100644 --- a/src/parallels/parallels_driver.c +++ b/src/parallels/parallels_driver.c @@ -45,7 +45,7 @@ #include "virterror_internal.h" #include "memory.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "vircommand.h" #include "configmake.h" #include "storage_file.h" diff --git a/src/phyp/phyp_driver.c b/src/phyp/phyp_driver.c index e54f0f3..0ac2771 100644 --- a/src/phyp/phyp_driver.c +++ b/src/phyp/phyp_driver.c @@ -49,7 +49,7 @@ #include "datatypes.h" #include "virbuffer.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "driver.h" #include "libvirt/libvirt.h" #include "virterror_internal.h" diff --git a/src/qemu/qemu_agent.c b/src/qemu/qemu_agent.c index 6727294..421e43f 100644 --- a/src/qemu/qemu_agent.c +++ b/src/qemu/qemu_agent.c @@ -35,7 +35,7 @@ #include "qemu_agent.h" #include "qemu_command.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "virjson.h" #include "virfile.h" diff --git a/src/qemu/qemu_bridge_filter.c b/src/qemu/qemu_bridge_filter.c index a6d0d4f..08a9f1a 100644 --- a/src/qemu/qemu_bridge_filter.c +++ b/src/qemu/qemu_bridge_filter.c @@ -27,7 +27,7 @@ #include "qemu_driver.h" #include "util.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "qemu_bridge_filter.h" diff --git a/src/qemu/qemu_capabilities.c b/src/qemu/qemu_capabilities.c index f68e081..5853180 100644 --- a/src/qemu/qemu_capabilities.c +++ b/src/qemu/qemu_capabilities.c @@ -25,7 +25,7 @@ #include "qemu_capabilities.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "util.h" #include "virfile.h" diff --git a/src/qemu/qemu_cgroup.c b/src/qemu/qemu_cgroup.c index 6c6607d..8d9ccf9 100644 --- a/src/qemu/qemu_cgroup.c +++ b/src/qemu/qemu_cgroup.c @@ -27,7 +27,7 @@ #include "qemu_domain.h" #include "qemu_process.h" #include "vircgroup.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "virterror_internal.h" #include "util.h" diff --git a/src/qemu/qemu_command.c b/src/qemu/qemu_command.c index 04a9512..8a35982 100644 --- a/src/qemu/qemu_command.c +++ b/src/qemu/qemu_command.c @@ -29,7 +29,7 @@ #include "qemu_bridge_filter.h" #include "cpu/cpu.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "util.h" #include "virfile.h" diff --git a/src/qemu/qemu_conf.c b/src/qemu/qemu_conf.c index 7c8d826..598fad7 100644 --- a/src/qemu/qemu_conf.c +++ b/src/qemu/qemu_conf.c @@ -48,7 +48,7 @@ #include "datatypes.h" #include "xml.h" #include "nodeinfo.h" -#include "logging.h" +#include "virlog.h" #include "cpu/cpu.h" #include "domain_nwfilter.h" #include "virfile.h" diff --git a/src/qemu/qemu_domain.c b/src/qemu/qemu_domain.c index 8d8cf02..e6eaa58 100644 --- a/src/qemu/qemu_domain.c +++ b/src/qemu/qemu_domain.c @@ -28,7 +28,7 @@ #include "qemu_capabilities.h" #include "qemu_migration.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "c-ctype.h" #include "cpu/cpu.h" diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c index 79f42fb..25e5738 100644 --- a/src/qemu/qemu_driver.c +++ b/src/qemu/qemu_driver.c @@ -60,7 +60,7 @@ #include "qemu_migration.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "virbuffer.h" #include "util.h" diff --git a/src/qemu/qemu_hostdev.c b/src/qemu/qemu_hostdev.c index aa000d1..3854520 100644 --- a/src/qemu/qemu_hostdev.c +++ b/src/qemu/qemu_hostdev.c @@ -24,7 +24,7 @@ #include <config.h> #include "qemu_hostdev.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "memory.h" #include "pci.h" diff --git a/src/qemu/qemu_hotplug.c b/src/qemu/qemu_hotplug.c index e9a5e35..7edd125 100644 --- a/src/qemu/qemu_hotplug.c +++ b/src/qemu/qemu_hotplug.c @@ -32,7 +32,7 @@ #include "qemu_hostdev.h" #include "domain_audit.h" #include "domain_nwfilter.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "virterror_internal.h" #include "memory.h" diff --git a/src/qemu/qemu_migration.c b/src/qemu/qemu_migration.c index 468a92f..cabbe1a 100644 --- a/src/qemu/qemu_migration.c +++ b/src/qemu/qemu_migration.c @@ -36,7 +36,7 @@ #include "qemu_cgroup.h" #include "domain_audit.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "memory.h" #include "util.h" diff --git a/src/qemu/qemu_monitor.c b/src/qemu/qemu_monitor.c index 131e8df..920453d 100644 --- a/src/qemu/qemu_monitor.c +++ b/src/qemu/qemu_monitor.c @@ -33,7 +33,7 @@ #include "qemu_monitor_json.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "virprocess.h" #include "virobject.h" diff --git a/src/qemu/qemu_monitor_json.c b/src/qemu/qemu_monitor_json.c index 6181668..e14134b 100644 --- a/src/qemu/qemu_monitor_json.c +++ b/src/qemu/qemu_monitor_json.c @@ -36,7 +36,7 @@ #include "qemu_command.h" #include "qemu_capabilities.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "driver.h" #include "datatypes.h" #include "virterror_internal.h" diff --git a/src/qemu/qemu_monitor_text.c b/src/qemu/qemu_monitor_text.c index a12adb6..28690b1 100644 --- a/src/qemu/qemu_monitor_text.c +++ b/src/qemu/qemu_monitor_text.c @@ -35,7 +35,7 @@ #include "c-ctype.h" #include "c-strcasestr.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "driver.h" #include "datatypes.h" #include "virterror_internal.h" diff --git a/src/qemu/qemu_process.c b/src/qemu/qemu_process.c index e528d78..a77b248 100644 --- a/src/qemu/qemu_process.c +++ b/src/qemu/qemu_process.c @@ -51,7 +51,7 @@ #endif #include "datatypes.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "memory.h" #include "virhooks.h" diff --git a/src/remote/remote_driver.c b/src/remote/remote_driver.c index 8b77e7d..1e9151a 100644 --- a/src/remote/remote_driver.c +++ b/src/remote/remote_driver.c @@ -30,7 +30,7 @@ #include "virnetclientprogram.h" #include "virnetclientstream.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "domain_event.h" #include "driver.h" diff --git a/src/rpc/virkeepalive.c b/src/rpc/virkeepalive.c index 309f22f..8fc1cba 100644 --- a/src/rpc/virkeepalive.c +++ b/src/rpc/virkeepalive.c @@ -25,7 +25,7 @@ #include "memory.h" #include "threads.h" #include "virfile.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include "virterror_internal.h" #include "virnetsocket.h" diff --git a/src/rpc/virnetclient.c b/src/rpc/virnetclient.c index bf2547c..7370ae0 100644 --- a/src/rpc/virnetclient.c +++ b/src/rpc/virnetclient.c @@ -33,7 +33,7 @@ #include "memory.h" #include "threads.h" #include "virfile.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include "virterror_internal.h" diff --git a/src/rpc/virnetclientprogram.c b/src/rpc/virnetclientprogram.c index 1f08640..dec3943 100644 --- a/src/rpc/virnetclientprogram.c +++ b/src/rpc/virnetclientprogram.c @@ -30,7 +30,7 @@ #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include "virfile.h" #include "threads.h" diff --git a/src/rpc/virnetclientstream.c b/src/rpc/virnetclientstream.c index 0e7e38e..26dc292 100644 --- a/src/rpc/virnetclientstream.c +++ b/src/rpc/virnetclientstream.c @@ -26,7 +26,7 @@ #include "virnetclient.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "threads.h" #define VIR_FROM_THIS VIR_FROM_RPC diff --git a/src/rpc/virnetmessage.c b/src/rpc/virnetmessage.c index cf76e21..16d8e61 100644 --- a/src/rpc/virnetmessage.c +++ b/src/rpc/virnetmessage.c @@ -26,7 +26,7 @@ #include "virnetmessage.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "util.h" diff --git a/src/rpc/virnetsaslcontext.c b/src/rpc/virnetsaslcontext.c index b6b68d5..e880127 100644 --- a/src/rpc/virnetsaslcontext.c +++ b/src/rpc/virnetsaslcontext.c @@ -28,7 +28,7 @@ #include "virterror_internal.h" #include "memory.h" #include "threads.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_RPC diff --git a/src/rpc/virnetserver.c b/src/rpc/virnetserver.c index f686a8f..6d3532a 100644 --- a/src/rpc/virnetserver.c +++ b/src/rpc/virnetserver.c @@ -28,7 +28,7 @@ #include <fcntl.h> #include "virnetserver.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "virterror_internal.h" #include "threads.h" diff --git a/src/rpc/virnetserverclient.c b/src/rpc/virnetserverclient.c index ed26719..9642ea5 100644 --- a/src/rpc/virnetserverclient.c +++ b/src/rpc/virnetserverclient.c @@ -29,7 +29,7 @@ #include "virnetserverclient.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "memory.h" #include "threads.h" diff --git a/src/rpc/virnetservermdns.c b/src/rpc/virnetservermdns.c index 166b4eb..c17b65d 100644 --- a/src/rpc/virnetservermdns.c +++ b/src/rpc/virnetservermdns.c @@ -44,7 +44,7 @@ #include "vireventpoll.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_RPC diff --git a/src/rpc/virnetserverprogram.c b/src/rpc/virnetserverprogram.c index e4aa2da..5b96c34 100644 --- a/src/rpc/virnetserverprogram.c +++ b/src/rpc/virnetserverprogram.c @@ -28,7 +28,7 @@ #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "threads.h" diff --git a/src/rpc/virnetsocket.c b/src/rpc/virnetsocket.c index 5a2eab3..aa8f4b9 100644 --- a/src/rpc/virnetsocket.c +++ b/src/rpc/virnetsocket.c @@ -44,7 +44,7 @@ #include "util.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "threads.h" #include "virprocess.h" diff --git a/src/rpc/virnetsshsession.c b/src/rpc/virnetsshsession.c index d890569..734acaa 100644 --- a/src/rpc/virnetsshsession.c +++ b/src/rpc/virnetsshsession.c @@ -28,7 +28,7 @@ #include "internal.h" #include "virbuffer.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "configmake.h" #include "threads.h" #include "util.h" diff --git a/src/rpc/virnettlscontext.c b/src/rpc/virnettlscontext.c index 1d32327..2931003 100644 --- a/src/rpc/virnettlscontext.c +++ b/src/rpc/virnettlscontext.c @@ -33,7 +33,7 @@ #include "memory.h" #include "virterror_internal.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "threads.h" #include "configmake.h" diff --git a/src/secret/secret_driver.c b/src/secret/secret_driver.c index d9ba42b..4159358 100644 --- a/src/secret/secret_driver.c +++ b/src/secret/secret_driver.c @@ -32,7 +32,7 @@ #include "base64.h" #include "datatypes.h" #include "driver.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "secret_conf.h" #include "secret_driver.h" diff --git a/src/security/security_apparmor.c b/src/security/security_apparmor.c index 034eb04..f2aebc8 100644 --- a/src/security/security_apparmor.c +++ b/src/security/security_apparmor.c @@ -48,7 +48,7 @@ #include "virfile.h" #include "configmake.h" #include "vircommand.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_SECURITY #define SECURITY_APPARMOR_VOID_DOI "0" diff --git a/src/security/security_dac.c b/src/security/security_dac.c index 9f5d39d..9ff2665 100644 --- a/src/security/security_dac.c +++ b/src/security/security_dac.c @@ -27,7 +27,7 @@ #include "virterror_internal.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "pci.h" #include "virusb.h" #include "storage_file.h" diff --git a/src/security/security_driver.c b/src/security/security_driver.c index c7ff8a5..82d3ca9 100644 --- a/src/security/security_driver.c +++ b/src/security/security_driver.c @@ -24,7 +24,7 @@ #include <string.h> #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "security_driver.h" #ifdef WITH_SECDRIVER_SELINUX diff --git a/src/security/security_manager.c b/src/security/security_manager.c index 690e4da..67c8858 100644 --- a/src/security/security_manager.c +++ b/src/security/security_manager.c @@ -28,7 +28,7 @@ #include "security_dac.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_SECURITY diff --git a/src/security/security_selinux.c b/src/security/security_selinux.c index eb4f253..2a19781 100644 --- a/src/security/security_selinux.c +++ b/src/security/security_selinux.c @@ -36,7 +36,7 @@ #include "virterror_internal.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "pci.h" #include "virusb.h" #include "storage_file.h" diff --git a/src/storage/storage_backend.c b/src/storage/storage_backend.c index 083028d..899caeb 100644 --- a/src/storage/storage_backend.c +++ b/src/storage/storage_backend.c @@ -54,7 +54,7 @@ #include "uuid.h" #include "storage_file.h" #include "storage_backend.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "stat-time.h" diff --git a/src/storage/storage_backend_disk.c b/src/storage/storage_backend_disk.c index c6aa407..7e1d3ec 100644 --- a/src/storage/storage_backend_disk.c +++ b/src/storage/storage_backend_disk.c @@ -27,7 +27,7 @@ #include <stdio.h> #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "storage_backend_disk.h" #include "util.h" #include "memory.h" diff --git a/src/storage/storage_backend_fs.c b/src/storage/storage_backend_fs.c index cdf93af..78b50f0 100644 --- a/src/storage/storage_backend_fs.c +++ b/src/storage/storage_backend_fs.c @@ -49,7 +49,7 @@ #include "memory.h" #include "xml.h" #include "virfile.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_STORAGE diff --git a/src/storage/storage_backend_iscsi.c b/src/storage/storage_backend_iscsi.c index c468b1b..46659af 100644 --- a/src/storage/storage_backend_iscsi.c +++ b/src/storage/storage_backend_iscsi.c @@ -39,7 +39,7 @@ #include "storage_backend_iscsi.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "vircommand.h" #include "virrandom.h" diff --git a/src/storage/storage_backend_logical.c b/src/storage/storage_backend_logical.c index 53e6c61..f28c663 100644 --- a/src/storage/storage_backend_logical.c +++ b/src/storage/storage_backend_logical.c @@ -36,7 +36,7 @@ #include "storage_conf.h" #include "vircommand.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #define VIR_FROM_THIS VIR_FROM_STORAGE diff --git a/src/storage/storage_backend_mpath.c b/src/storage/storage_backend_mpath.c index efcfb28..1ca120f 100644 --- a/src/storage/storage_backend_mpath.c +++ b/src/storage/storage_backend_mpath.c @@ -33,7 +33,7 @@ #include "storage_conf.h" #include "storage_backend.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #define VIR_FROM_THIS VIR_FROM_STORAGE diff --git a/src/storage/storage_backend_rbd.c b/src/storage/storage_backend_rbd.c index bc61cf7..4e58911 100644 --- a/src/storage/storage_backend_rbd.c +++ b/src/storage/storage_backend_rbd.c @@ -27,7 +27,7 @@ #include "storage_conf.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "base64.h" #include "uuid.h" #include "rados/librados.h" diff --git a/src/storage/storage_backend_scsi.c b/src/storage/storage_backend_scsi.c index 6515e57..32713be 100644 --- a/src/storage/storage_backend_scsi.c +++ b/src/storage/storage_backend_scsi.c @@ -31,7 +31,7 @@ #include "virterror_internal.h" #include "storage_backend_scsi.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "vircommand.h" diff --git a/src/storage/storage_backend_sheepdog.c b/src/storage/storage_backend_sheepdog.c index ecca7a8..05deeeb 100644 --- a/src/storage/storage_backend_sheepdog.c +++ b/src/storage/storage_backend_sheepdog.c @@ -32,7 +32,7 @@ #include "vircommand.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_STORAGE diff --git a/src/storage/storage_driver.c b/src/storage/storage_driver.c index c567fff..6076f6c 100644 --- a/src/storage/storage_driver.c +++ b/src/storage/storage_driver.c @@ -44,7 +44,7 @@ #include "storage_conf.h" #include "memory.h" #include "storage_backend.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "fdstream.h" #include "configmake.h" diff --git a/src/test/test_driver.c b/src/test/test_driver.c index 8e57370..dbaf14e 100644 --- a/src/test/test_driver.c +++ b/src/test/test_driver.c @@ -48,7 +48,7 @@ #include "node_device_conf.h" #include "xml.h" #include "threads.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "virtypedparam.h" #include "virrandom.h" diff --git a/src/uml/uml_conf.c b/src/uml/uml_conf.c index 51e5a7a..35b54c2 100644 --- a/src/uml/uml_conf.c +++ b/src/uml/uml_conf.c @@ -42,7 +42,7 @@ #include "util.h" #include "memory.h" #include "nodeinfo.h" -#include "logging.h" +#include "virlog.h" #include "domain_nwfilter.h" #include "virfile.h" #include "vircommand.h" diff --git a/src/uml/uml_driver.c b/src/uml/uml_driver.c index 8dece66..90c9b66 100644 --- a/src/uml/uml_driver.c +++ b/src/uml/uml_driver.c @@ -56,7 +56,7 @@ #include "domain_conf.h" #include "domain_audit.h" #include "datatypes.h" -#include "logging.h" +#include "virlog.h" #include "domain_nwfilter.h" #include "virfile.h" #include "fdstream.h" diff --git a/src/util/logging.c b/src/util/logging.c deleted file mode 100644 index 0df3549..0000000 --- a/src/util/logging.c +++ /dev/null @@ -1,1590 +0,0 @@ -/* - * logging.c: internal logging and debugging - * - * Copyright (C) 2008, 2010-2012 Red Hat, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - */ - -#include <config.h> - -#include <stdio.h> -#include <stdarg.h> -#include <stdlib.h> -#include <time.h> -#include <sys/time.h> -#include <sys/types.h> -#include <sys/stat.h> -#include <fcntl.h> -#include <unistd.h> -#include <signal.h> -#include <execinfo.h> -#if HAVE_SYSLOG_H -# include <syslog.h> -#endif -#include <sys/socket.h> -#if HAVE_SYS_UN_H -# include <sys/un.h> -#endif - -#include "virterror_internal.h" -#include "logging.h" -#include "memory.h" -#include "util.h" -#include "virbuffer.h" -#include "threads.h" -#include "virfile.h" -#include "virtime.h" -#include "intprops.h" - -/* Journald output is only supported on Linux new enough to expose - * htole64. */ -#if HAVE_SYSLOG_H && defined(__linux__) && HAVE_DECL_HTOLE64 -# define USE_JOURNALD 1 -#endif - -#define VIR_FROM_THIS VIR_FROM_NONE - -VIR_ENUM_DECL(virLogSource) -VIR_ENUM_IMPL(virLogSource, VIR_LOG_FROM_LAST, - "file", - "error", - "audit", - "trace", - "library"); - -/* - * A logging buffer to keep some history over logs - */ - -static int virLogSize = 64 * 1024; -static char *virLogBuffer = NULL; -static int virLogLen = 0; -static int virLogStart = 0; -static int virLogEnd = 0; - -/* - * Filters are used to refine the rules on what to keep or drop - * based on a matching pattern (currently a substring) - */ -struct _virLogFilter { - const char *match; - virLogPriority priority; - unsigned int flags; -}; -typedef struct _virLogFilter virLogFilter; -typedef virLogFilter *virLogFilterPtr; - -static virLogFilterPtr virLogFilters = NULL; -static int virLogNbFilters = 0; - -/* - * Outputs are used to emit the messages retained - * after filtering, multiple output can be used simultaneously - */ -struct _virLogOutput { - bool logVersion; - void *data; - virLogOutputFunc f; - virLogCloseFunc c; - virLogPriority priority; - virLogDestination dest; - const char *name; -}; -typedef struct _virLogOutput virLogOutput; -typedef virLogOutput *virLogOutputPtr; - -static virLogOutputPtr virLogOutputs = NULL; -static int virLogNbOutputs = 0; - -/* - * Default priorities - */ -static virLogPriority virLogDefaultPriority = VIR_LOG_DEFAULT; - -static int virLogResetFilters(void); -static int virLogResetOutputs(void); -static void virLogOutputToFd(virLogSource src, - virLogPriority priority, - const char *filename, - int linenr, - const char *funcname, - const char *timestamp, - virLogMetadataPtr metadata, - unsigned int flags, - const char *rawstr, - const char *str, - void *data); - -/* - * Logs accesses must be serialized though a mutex - */ -virMutex virLogMutex; - -void -virLogLock(void) -{ - virMutexLock(&virLogMutex); -} - - -void -virLogUnlock(void) -{ - virMutexUnlock(&virLogMutex); -} - - -static const char * -virLogOutputString(virLogDestination ldest) -{ - switch (ldest) { - case VIR_LOG_TO_STDERR: - return "stderr"; - case VIR_LOG_TO_SYSLOG: - return "syslog"; - case VIR_LOG_TO_FILE: - return "file"; - case VIR_LOG_TO_JOURNALD: - return "journald"; - } - return "unknown"; -} - - -static const char * -virLogPriorityString(virLogPriority lvl) -{ - switch (lvl) { - case VIR_LOG_DEBUG: - return "debug"; - case VIR_LOG_INFO: - return "info"; - case VIR_LOG_WARN: - return "warning"; - case VIR_LOG_ERROR: - return "error"; - } - return "unknown"; -} - - -static int -virLogOnceInit(void) -{ - const char *pbm = NULL; - - if (virMutexInit(&virLogMutex) < 0) - return -1; - - virLogLock(); - if (VIR_ALLOC_N(virLogBuffer, virLogSize + 1) < 0) { - /* - * The debug buffer is not a critical component, allow startup - * even in case of failure to allocate it in case of a - * configuration mistake. - */ - virLogSize = 64 * 1024; - if (VIR_ALLOC_N(virLogBuffer, virLogSize + 1) < 0) { - pbm = "Failed to allocate debug buffer: deactivating debug log\n"; - virLogSize = 0; - } else { - pbm = "Failed to allocate debug buffer: reduced to 64 kB\n"; - } - } - virLogLen = 0; - virLogStart = 0; - virLogEnd = 0; - virLogDefaultPriority = VIR_LOG_DEFAULT; - virLogUnlock(); - if (pbm) - VIR_WARN("%s", pbm); - return 0; -} - -VIR_ONCE_GLOBAL_INIT(virLog) - - -/** - * virLogSetBufferSize: - * @size: size of the buffer in kilobytes or <= 0 to deactivate - * - * Dynamically set the size or deactivate the logging buffer used to keep - * a trace of all recent debug output. Note that the content of the buffer - * is lost if it gets reallocated. - * - * Return -1 in case of failure or 0 in case of success - */ -int -virLogSetBufferSize(int size) -{ - int ret = 0; - int oldsize; - char *oldLogBuffer; - const char *pbm = NULL; - - if (size < 0) - size = 0; - - if (virLogInitialize() < 0) - return -1; - - if (size * 1024 == virLogSize) - return ret; - - virLogLock(); - - oldsize = virLogSize; - oldLogBuffer = virLogBuffer; - - if (INT_MAX / 1024 <= size) { - pbm = "Requested log size of %d kB too large\n"; - ret = -1; - goto error; - } - - virLogSize = size * 1024; - if (VIR_ALLOC_N(virLogBuffer, virLogSize + 1) < 0) { - pbm = "Failed to allocate debug buffer of %d kB\n"; - virLogBuffer = oldLogBuffer; - virLogSize = oldsize; - ret = -1; - goto error; - } - VIR_FREE(oldLogBuffer); - virLogLen = 0; - virLogStart = 0; - virLogEnd = 0; - -error: - virLogUnlock(); - if (pbm) - VIR_ERROR(pbm, size); - return ret; -} - - -/** - * virLogReset: - * - * Reset the logging module to its default initial state - * - * Returns 0 if successful, and -1 in case or error - */ -int -virLogReset(void) -{ - if (virLogInitialize() < 0) - return -1; - - virLogLock(); - virLogResetFilters(); - virLogResetOutputs(); - virLogLen = 0; - virLogStart = 0; - virLogEnd = 0; - virLogDefaultPriority = VIR_LOG_DEFAULT; - virLogUnlock(); - return 0; -} - - -/* - * Store a string in the ring buffer - */ -static void -virLogStr(const char *str) -{ - int tmp; - int len; - - if ((str == NULL) || (virLogBuffer == NULL) || (virLogSize <= 0)) - return; - len = strlen(str); - if (len >= virLogSize) - return; - - /* - * copy the data and reset the end, we cycle over the end of the buffer - */ - if (virLogEnd + len >= virLogSize) { - tmp = virLogSize - virLogEnd; - memcpy(&virLogBuffer[virLogEnd], str, tmp); - memcpy(&virLogBuffer[0], &str[tmp], len - tmp); - virLogEnd = len - tmp; - } else { - memcpy(&virLogBuffer[virLogEnd], str, len); - virLogEnd += len; - } - virLogBuffer[virLogEnd] = 0; - /* - * Update the log length, and if full move the start index - */ - virLogLen += len; - if (virLogLen > virLogSize) { - tmp = virLogLen - virLogSize; - virLogLen = virLogSize; - virLogStart += tmp; - if (virLogStart >= virLogSize) - virLogStart -= virLogSize; - } -} - - -static void -virLogDumpAllFD(const char *msg, int len) -{ - int i, found = 0; - - if (len <= 0) - len = strlen(msg); - - for (i = 0; i < virLogNbOutputs;i++) { - if (virLogOutputs[i].f == virLogOutputToFd) { - int fd = (intptr_t) virLogOutputs[i].data; - - if (fd >= 0) { - ignore_value(safewrite(fd, msg, len)); - found = 1; - } - } - } - if (!found) - ignore_value(safewrite(STDERR_FILENO, msg, len)); -} - - -/** - * virLogEmergencyDumpAll: - * @signum: the signal number - * - * Emergency function called, possibly from a signal handler. - * It need to output the debug ring buffer through the log - * output which are safe to use from a signal handler. - * In case none is found it is emitted to standard error. - */ -void -virLogEmergencyDumpAll(int signum) -{ - int len; - int oldLogStart, oldLogLen; - - switch (signum) { -#ifdef SIGFPE - case SIGFPE: - virLogDumpAllFD("Caught signal Floating-point exception", -1); - break; -#endif -#ifdef SIGSEGV - case SIGSEGV: - virLogDumpAllFD("Caught Segmentation violation", -1); - break; -#endif -#ifdef SIGILL - case SIGILL: - virLogDumpAllFD("Caught illegal instruction", -1); - break; -#endif -#ifdef SIGABRT - case SIGABRT: - virLogDumpAllFD("Caught abort signal", -1); - break; -#endif -#ifdef SIGBUS - case SIGBUS: - virLogDumpAllFD("Caught bus error", -1); - break; -#endif -#ifdef SIGUSR2 - case SIGUSR2: - virLogDumpAllFD("Caught User-defined signal 2", -1); - break; -#endif - default: - virLogDumpAllFD("Caught unexpected signal", -1); - break; - } - if ((virLogBuffer == NULL) || (virLogSize <= 0)) { - virLogDumpAllFD(" internal log buffer deactivated\n", -1); - return; - } - - virLogDumpAllFD(" dumping internal log buffer:\n", -1); - virLogDumpAllFD("\n\n ====== start of log =====\n\n", -1); - - /* - * Since we can't lock the buffer safely from a signal handler - * we mark it as empty in case of concurrent access, and proceed - * with the data, at worse we will output something a bit weird - * if another thread start logging messages at the same time. - * Note that virLogStr() uses virLogEnd for the computations and - * writes to the buffer and only then updates virLogLen and virLogStart - * so it's best to reset it first. - */ - oldLogStart = virLogStart; - oldLogLen = virLogLen; - virLogEnd = 0; - virLogLen = 0; - virLogStart = 0; - - while (oldLogLen > 0) { - if (oldLogStart + oldLogLen < virLogSize) { - virLogBuffer[oldLogStart + oldLogLen] = 0; - virLogDumpAllFD(&virLogBuffer[oldLogStart], oldLogLen); - oldLogStart += oldLogLen; - oldLogLen = 0; - } else { - len = virLogSize - oldLogStart; - virLogBuffer[virLogSize] = 0; - virLogDumpAllFD(&virLogBuffer[oldLogStart], len); - oldLogLen -= len; - oldLogStart = 0; - } - } - virLogDumpAllFD("\n\n ====== end of log =====\n\n", -1); -} - - -/** - * virLogSetDefaultPriority: - * @priority: the default priority level - * - * Set the default priority level, i.e. any logged data of a priority - * equal or superior to this level will be logged, unless a specific rule - * was defined for the log category of the message. - * - * Returns 0 if successful, -1 in case of error. - */ -int -virLogSetDefaultPriority(virLogPriority priority) -{ - if ((priority < VIR_LOG_DEBUG) || (priority > VIR_LOG_ERROR)) { - VIR_WARN("Ignoring invalid log level setting."); - return -1; - } - if (virLogInitialize() < 0) - return -1; - - virLogDefaultPriority = priority; - return 0; -} - - -/** - * virLogResetFilters: - * - * Removes the set of logging filters defined. - * - * Returns the number of filters removed - */ -static int -virLogResetFilters(void) -{ - int i; - - for (i = 0; i < virLogNbFilters;i++) - VIR_FREE(virLogFilters[i].match); - VIR_FREE(virLogFilters); - virLogNbFilters = 0; - return i; -} - - -/** - * virLogDefineFilter: - * @match: the pattern to match - * @priority: the priority to give to messages matching the pattern - * @flags: extra flags, see virLogFilterFlags enum - * - * Defines a pattern used for log filtering, it allow to select or - * reject messages independently of the default priority. - * The filter defines a rules that will apply only to messages matching - * the pattern (currently if @match is a substring of the message category) - * - * Returns -1 in case of failure or the filter number if successful - */ -int -virLogDefineFilter(const char *match, - virLogPriority priority, - unsigned int flags) -{ - int i; - char *mdup = NULL; - - virCheckFlags(VIR_LOG_STACK_TRACE, -1); - - if ((match == NULL) || (priority < VIR_LOG_DEBUG) || - (priority > VIR_LOG_ERROR)) - return -1; - - virLogLock(); - for (i = 0;i < virLogNbFilters;i++) { - if (STREQ(virLogFilters[i].match, match)) { - virLogFilters[i].priority = priority; - goto cleanup; - } - } - - mdup = strdup(match); - if (mdup == NULL) { - i = -1; - goto cleanup; - } - i = virLogNbFilters; - if (VIR_REALLOC_N(virLogFilters, virLogNbFilters + 1)) { - i = -1; - VIR_FREE(mdup); - goto cleanup; - } - virLogFilters[i].match = mdup; - virLogFilters[i].priority = priority; - virLogFilters[i].flags = flags; - virLogNbFilters++; -cleanup: - virLogUnlock(); - return i; -} - - -/** - * virLogFiltersCheck: - * @input: the input string - * - * Check the input of the message against the existing filters. Currently - * the match is just a substring check of the category used as the input - * string, a more subtle approach could be used instead - * - * Returns 0 if not matched or the new priority if found. - */ -static int -virLogFiltersCheck(const char *input, - unsigned int *flags) -{ - int ret = 0; - int i; - - virLogLock(); - for (i = 0;i < virLogNbFilters;i++) { - if (strstr(input, virLogFilters[i].match)) { - ret = virLogFilters[i].priority; - *flags = virLogFilters[i].flags; - break; - } - } - virLogUnlock(); - return ret; -} - - -/** - * virLogResetOutputs: - * - * Removes the set of logging output defined. - * - * Returns the number of output removed - */ -static int -virLogResetOutputs(void) -{ - int i; - - for (i = 0;i < virLogNbOutputs;i++) { - if (virLogOutputs[i].c != NULL) - virLogOutputs[i].c(virLogOutputs[i].data); - VIR_FREE(virLogOutputs[i].name); - } - VIR_FREE(virLogOutputs); - i = virLogNbOutputs; - virLogNbOutputs = 0; - return i; -} - - -/** - * virLogDefineOutput: - * @f: the function to call to output a message - * @c: the function to call to close the output (or NULL) - * @data: extra data passed as first arg to the function - * @priority: minimal priority for this filter, use 0 for none - * @dest: where to send output of this priority - * @name: optional name data associated with an output - * @flags: extra flag, currently unused - * - * Defines an output function for log messages. Each message once - * gone though filtering is emitted through each registered output. - * - * Returns -1 in case of failure or the output number if successful - */ -int -virLogDefineOutput(virLogOutputFunc f, - virLogCloseFunc c, - void *data, - virLogPriority priority, - virLogDestination dest, - const char *name, - unsigned int flags) -{ - int ret = -1; - char *ndup = NULL; - - virCheckFlags(0, -1); - - if (f == NULL) - return -1; - - if (dest == VIR_LOG_TO_SYSLOG || dest == VIR_LOG_TO_FILE) { - if (name == NULL) - return -1; - ndup = strdup(name); - if (ndup == NULL) - return -1; - } - - virLogLock(); - if (VIR_REALLOC_N(virLogOutputs, virLogNbOutputs + 1)) { - VIR_FREE(ndup); - goto cleanup; - } - ret = virLogNbOutputs++; - virLogOutputs[ret].logVersion = true; - virLogOutputs[ret].f = f; - virLogOutputs[ret].c = c; - virLogOutputs[ret].data = data; - virLogOutputs[ret].priority = priority; - virLogOutputs[ret].dest = dest; - virLogOutputs[ret].name = ndup; -cleanup: - virLogUnlock(); - return ret; -} - - -static int -virLogFormatString(char **msg, - int linenr, - const char *funcname, - virLogPriority priority, - const char *str) -{ - int ret; - - /* - * Be careful when changing the following log message formatting, we rely - * on it when stripping libvirt debug messages from qemu log files. So when - * changing this, you might also need to change the code there. - * virLogFormatString() function name is mentioned there so it's sufficient - * to just grep for it to find the right place. - */ - if ((funcname != NULL)) { - ret = virAsprintf(msg, "%d: %s : %s:%d : %s\n", - virThreadSelfID(), virLogPriorityString(priority), - funcname, linenr, str); - } else { - ret = virAsprintf(msg, "%d: %s : %s\n", - virThreadSelfID(), virLogPriorityString(priority), - str); - } - return ret; -} - - -static int -virLogVersionString(const char **rawmsg, - char **msg) -{ -#ifdef PACKAGER_VERSION -# ifdef PACKAGER -# define LOG_VERSION_STRING \ - "libvirt version: " VERSION ", package: " PACKAGER_VERSION " (" PACKAGER ")" -# else -# define LOG_VERSION_STRING \ - "libvirt version: " VERSION ", package: " PACKAGER_VERSION -# endif -#else -# define LOG_VERSION_STRING \ - "libvirt version: " VERSION -#endif - - *rawmsg = LOG_VERSION_STRING; - return virLogFormatString(msg, 0, NULL, VIR_LOG_INFO, LOG_VERSION_STRING); -} - - -/** - * virLogMessage: - * @source: where is that message coming from - * @priority: the priority level - * @filename: file where the message was emitted - * @linenr: line where the message was emitted - * @funcname: the function emitting the (debug) message - * @metadata: NULL or metadata array, terminated by an item with NULL key - * @fmt: the string format - * @...: the arguments - * - * Call the libvirt logger with some information. Based on the configuration - * the message may be stored, sent to output or just discarded - */ -void -virLogMessage(virLogSource source, - virLogPriority priority, - const char *filename, - int linenr, - const char *funcname, - virLogMetadataPtr metadata, - const char *fmt, ...) -{ - va_list ap; - va_start(ap, fmt); - virLogVMessage(source, priority, - filename, linenr, funcname, - metadata, fmt, ap); - va_end(ap); -} - - -/** - * virLogVMessage: - * @source: where is that message coming from - * @priority: the priority level - * @filename: file where the message was emitted - * @linenr: line where the message was emitted - * @funcname: the function emitting the (debug) message - * @metadata: NULL or metadata array, terminated by an item with NULL key - * @fmt: the string format - * @vargs: format args - * - * Call the libvirt logger with some information. Based on the configuration - * the message may be stored, sent to output or just discarded - */ -void -virLogVMessage(virLogSource source, - virLogPriority priority, - const char *filename, - int linenr, - const char *funcname, - virLogMetadataPtr metadata, - const char *fmt, - va_list vargs) -{ - static bool logVersionStderr = true; - char *str = NULL; - char *msg = NULL; - char timestamp[VIR_TIME_STRING_BUFLEN]; - int fprio, i, ret; - int saved_errno = errno; - int emit = 1; - unsigned int filterflags = 0; - - if (virLogInitialize() < 0) - return; - - if (fmt == NULL) - goto cleanup; - - /* - * check against list of specific logging patterns - */ - fprio = virLogFiltersCheck(filename, &filterflags); - if (fprio == 0) { - if (priority < virLogDefaultPriority) - emit = 0; - } else if (priority < fprio) { - emit = 0; - } - - if ((emit == 0) && ((virLogBuffer == NULL) || (virLogSize <= 0))) - goto cleanup; - - /* - * serialize the error message, add level and timestamp - */ - if (virVasprintf(&str, fmt, vargs) < 0) { - goto cleanup; - } - - ret = virLogFormatString(&msg, linenr, funcname, priority, str); - if (ret < 0) - goto cleanup; - - if (virTimeStringNowRaw(timestamp) < 0) - timestamp[0] = '\0'; - - /* - * Log based on defaults, first store in the history buffer, - * then if emit push the message on the outputs defined, if none - * use stderr. - * NOTE: the locking is a single point of contention for multiple - * threads, but avoid intermixing. Maybe set up locks per output - * to improve paralellism. - */ - virLogLock(); - virLogStr(timestamp); - virLogStr(msg); - virLogUnlock(); - if (emit == 0) - goto cleanup; - - virLogLock(); - for (i = 0; i < virLogNbOutputs; i++) { - if (priority >= virLogOutputs[i].priority) { - if (virLogOutputs[i].logVersion) { - const char *rawver; - char *ver = NULL; - if (virLogVersionString(&rawver, &ver) >= 0) - virLogOutputs[i].f(VIR_LOG_FROM_FILE, VIR_LOG_INFO, - __FILE__, __LINE__, __func__, - timestamp, NULL, 0, rawver, ver, - virLogOutputs[i].data); - VIR_FREE(ver); - virLogOutputs[i].logVersion = false; - } - virLogOutputs[i].f(source, priority, - filename, linenr, funcname, - timestamp, metadata, filterflags, - str, msg, virLogOutputs[i].data); - } - } - if ((virLogNbOutputs == 0) && (source != VIR_LOG_FROM_ERROR)) { - if (logVersionStderr) { - const char *rawver; - char *ver = NULL; - if (virLogVersionString(&rawver, &ver) >= 0) - virLogOutputToFd(VIR_LOG_FROM_FILE, VIR_LOG_INFO, - __FILE__, __LINE__, __func__, - timestamp, NULL, 0, rawver, ver, - (void *) STDERR_FILENO); - VIR_FREE(ver); - logVersionStderr = false; - } - virLogOutputToFd(source, priority, - filename, linenr, funcname, - timestamp, metadata, filterflags, - str, msg, (void *) STDERR_FILENO); - } - virLogUnlock(); - -cleanup: - VIR_FREE(str); - VIR_FREE(msg); - errno = saved_errno; -} - - -static void -virLogStackTraceToFd(int fd) -{ - void *array[100]; - int size; - static bool doneWarning = false; - const char *msg = "Stack trace not available on this platform\n"; - -#define STRIP_DEPTH 3 - size = backtrace(array, ARRAY_CARDINALITY(array)); - if (size) { - backtrace_symbols_fd(array + STRIP_DEPTH, size - STRIP_DEPTH, fd); - ignore_value(safewrite(fd, "\n", 1)); - } else if (!doneWarning) { - ignore_value(safewrite(fd, msg, strlen(msg))); - doneWarning = true; - } -#undef STRIP_DEPTH -} - -static void -virLogOutputToFd(virLogSource source ATTRIBUTE_UNUSED, - virLogPriority priority ATTRIBUTE_UNUSED, - const char *filename ATTRIBUTE_UNUSED, - int linenr ATTRIBUTE_UNUSED, - const char *funcname ATTRIBUTE_UNUSED, - const char *timestamp, - virLogMetadataPtr metadata ATTRIBUTE_UNUSED, - unsigned int flags, - const char *rawstr ATTRIBUTE_UNUSED, - const char *str, - void *data) -{ - int fd = (intptr_t) data; - char *msg; - - if (fd < 0) - return; - - if (virAsprintf(&msg, "%s: %s", timestamp, str) < 0) - return; - - ignore_value(safewrite(fd, msg, strlen(msg))); - VIR_FREE(msg); - - if (flags & VIR_LOG_STACK_TRACE) - virLogStackTraceToFd(fd); -} - - -static void -virLogCloseFd(void *data) -{ - int fd = (intptr_t) data; - - VIR_LOG_CLOSE(fd); -} - - -static int -virLogAddOutputToStderr(virLogPriority priority) -{ - if (virLogDefineOutput(virLogOutputToFd, NULL, (void *)2L, priority, - VIR_LOG_TO_STDERR, NULL, 0) < 0) - return -1; - return 0; -} - - -static int -virLogAddOutputToFile(virLogPriority priority, - const char *file) -{ - int fd; - - fd = open(file, O_CREAT | O_APPEND | O_WRONLY, S_IRUSR | S_IWUSR); - if (fd < 0) - return -1; - if (virLogDefineOutput(virLogOutputToFd, virLogCloseFd, - (void *)(intptr_t)fd, - priority, VIR_LOG_TO_FILE, file, 0) < 0) { - VIR_FORCE_CLOSE(fd); - return -1; - } - return 0; -} - - -#if HAVE_SYSLOG_H -static int -virLogPrioritySyslog(virLogPriority priority) -{ - switch (priority) { - case VIR_LOG_DEBUG: - return LOG_DEBUG; - case VIR_LOG_INFO: - return LOG_INFO; - case VIR_LOG_WARN: - return LOG_WARNING; - case VIR_LOG_ERROR: - return LOG_ERR; - default: - return LOG_ERR; - } -} - - -static void -virLogOutputToSyslog(virLogSource source ATTRIBUTE_UNUSED, - virLogPriority priority, - const char *filename ATTRIBUTE_UNUSED, - int linenr ATTRIBUTE_UNUSED, - const char *funcname ATTRIBUTE_UNUSED, - const char *timestamp ATTRIBUTE_UNUSED, - virLogMetadataPtr metadata ATTRIBUTE_UNUSED, - unsigned int flags, - const char *rawstr ATTRIBUTE_UNUSED, - const char *str, - void *data ATTRIBUTE_UNUSED) -{ - virCheckFlags(VIR_LOG_STACK_TRACE,); - - syslog(virLogPrioritySyslog(priority), "%s", str); -} - -static char *current_ident = NULL; - - -static void -virLogCloseSyslog(void *data ATTRIBUTE_UNUSED) -{ - closelog(); - VIR_FREE(current_ident); -} - - -static int -virLogAddOutputToSyslog(virLogPriority priority, - const char *ident) -{ - /* - * ident needs to be kept around on Solaris - */ - VIR_FREE(current_ident); - current_ident = strdup(ident); - if (current_ident == NULL) - return -1; - - openlog(current_ident, 0, 0); - if (virLogDefineOutput(virLogOutputToSyslog, virLogCloseSyslog, NULL, - priority, VIR_LOG_TO_SYSLOG, ident, 0) < 0) { - closelog(); - VIR_FREE(current_ident); - return -1; - } - return 0; -} - - -# if USE_JOURNALD -# define IOVEC_SET(iov, data, size) \ - do { \ - struct iovec *_i = &(iov); \ - _i->iov_base = (void*)(data); \ - _i->iov_len = (size); \ - } while (0) - -# define IOVEC_SET_STRING(iov, str) IOVEC_SET(iov, str, strlen(str)) - -/* Used for conversion of numbers to strings, and for length of binary data */ -# define JOURNAL_BUF_SIZE (MAX(INT_BUFSIZE_BOUND(int), sizeof(uint64_t))) - -struct journalState -{ - struct iovec *iov, *iov_end; - char (*bufs)[JOURNAL_BUF_SIZE], (*bufs_end)[JOURNAL_BUF_SIZE]; -}; - -static void -journalAddString(struct journalState *state, const char *field, - const char *value) -{ - static const char newline = '\n', equals = '='; - - if (strchr(value, '\n') != NULL) { - uint64_t nstr; - - /* If 'str' contains a newline, then we must - * encode the string length, since we can't - * rely on the newline for the field separator - */ - if (state->iov_end - state->iov < 5 || state->bufs == state->bufs_end) - return; /* Silently drop */ - nstr = htole64(strlen(value)); - memcpy(state->bufs[0], &nstr, sizeof(nstr)); - - IOVEC_SET_STRING(state->iov[0], field); - IOVEC_SET(state->iov[1], &newline, sizeof(newline)); - IOVEC_SET(state->iov[2], state->bufs[0], sizeof(nstr)); - state->bufs++; - state->iov += 3; - } else { - if (state->iov_end - state->iov < 4) - return; /* Silently drop */ - IOVEC_SET_STRING(state->iov[0], field); - IOVEC_SET(state->iov[1], (void *)&equals, sizeof(equals)); - state->iov += 2; - } - IOVEC_SET_STRING(state->iov[0], value); - IOVEC_SET(state->iov[1], (void *)&newline, sizeof(newline)); - state->iov += 2; -} - -static void -journalAddInt(struct journalState *state, const char *field, int value) -{ - static const char newline = '\n', equals = '='; - - char *num; - - if (state->iov_end - state->iov < 4 || state->bufs == state->bufs_end) - return; /* Silently drop */ - - num = virFormatIntDecimal(state->bufs[0], sizeof(state->bufs[0]), value); - - IOVEC_SET_STRING(state->iov[0], field); - IOVEC_SET(state->iov[1], (void *)&equals, sizeof(equals)); - IOVEC_SET_STRING(state->iov[2], num); - IOVEC_SET(state->iov[3], (void *)&newline, sizeof(newline)); - state->bufs++; - state->iov += 4; -} - -static int journalfd = -1; - -static void -virLogOutputToJournald(virLogSource source, - virLogPriority priority, - const char *filename, - int linenr, - const char *funcname, - const char *timestamp ATTRIBUTE_UNUSED, - virLogMetadataPtr metadata ATTRIBUTE_UNUSED, - unsigned int flags, - const char *rawstr, - const char *str ATTRIBUTE_UNUSED, - void *data ATTRIBUTE_UNUSED) -{ - virCheckFlags(VIR_LOG_STACK_TRACE,); - int buffd = -1; - struct msghdr mh; - struct sockaddr_un sa; - union { - struct cmsghdr cmsghdr; - uint8_t buf[CMSG_SPACE(sizeof(int))]; - } control; - struct cmsghdr *cmsg; - /* We use /dev/shm instead of /tmp here, since we want this to - * be a tmpfs, and one that is available from early boot on - * and where unprivileged users can create files. */ - char path[] = "/dev/shm/journal.XXXXXX"; - -# define NUM_FIELDS 6 - struct iovec iov[NUM_FIELDS * 5]; - char iov_bufs[NUM_FIELDS][JOURNAL_BUF_SIZE]; - struct journalState state; - - state.iov = iov; - state.iov_end = iov + ARRAY_CARDINALITY(iov); - state.bufs = iov_bufs; - state.bufs_end = iov_bufs + ARRAY_CARDINALITY(iov_bufs); - - journalAddString(&state ,"MESSAGE", rawstr); - journalAddInt(&state, "PRIORITY", priority); - journalAddString(&state, "LIBVIRT_SOURCE", - virLogSourceTypeToString(source)); - journalAddString(&state, "CODE_FILE", filename); - journalAddInt(&state, "CODE_LINE", linenr); - journalAddString(&state, "CODE_FUNC", funcname); - - memset(&sa, 0, sizeof(sa)); - sa.sun_family = AF_UNIX; - if (!virStrcpy(sa.sun_path, "/run/systemd/journal/socket", sizeof(sa.sun_path))) - return; - - memset(&mh, 0, sizeof(mh)); - mh.msg_name = &sa; - mh.msg_namelen = offsetof(struct sockaddr_un, sun_path) + strlen(sa.sun_path); - mh.msg_iov = iov; - mh.msg_iovlen = state.iov - iov; - - if (sendmsg(journalfd, &mh, MSG_NOSIGNAL) >= 0) - return; - - if (errno != EMSGSIZE && errno != ENOBUFS) - return; - - /* Message was too large, so dump to temporary file - * and pass an FD to the journal - */ - - /* NB: mkostemp is not declared async signal safe by - * POSIX, but this is Linux only code and the GLibc - * impl is safe enough, only using open() and inline - * asm to read a timestamp (falling back to gettimeofday - * on some arches - */ - if ((buffd = mkostemp(path, O_CLOEXEC|O_RDWR)) < 0) - return; - - if (unlink(path) < 0) - goto cleanup; - - if (writev(buffd, iov, state.iov - iov) < 0) - goto cleanup; - - mh.msg_iov = NULL; - mh.msg_iovlen = 0; - - memset(&control, 0, sizeof(control)); - mh.msg_control = &control; - mh.msg_controllen = sizeof(control); - - cmsg = CMSG_FIRSTHDR(&mh); - cmsg->cmsg_level = SOL_SOCKET; - cmsg->cmsg_type = SCM_RIGHTS; - cmsg->cmsg_len = CMSG_LEN(sizeof(int)); - memcpy(CMSG_DATA(cmsg), &buffd, sizeof(int)); - - mh.msg_controllen = cmsg->cmsg_len; - - sendmsg(journalfd, &mh, MSG_NOSIGNAL); - -cleanup: - VIR_LOG_CLOSE(buffd); -} - - -static void virLogCloseJournald(void *data ATTRIBUTE_UNUSED) -{ - VIR_LOG_CLOSE(journalfd); -} - - -static int virLogAddOutputToJournald(int priority) -{ - if ((journalfd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0) - return -1; - if (virSetInherit(journalfd, false) < 0) { - VIR_LOG_CLOSE(journalfd); - return -1; - } - if (virLogDefineOutput(virLogOutputToJournald, virLogCloseJournald, NULL, - priority, VIR_LOG_TO_JOURNALD, NULL, 0) < 0) { - return -1; - } - return 0; -} -# endif /* USE_JOURNALD */ -#endif /* HAVE_SYSLOG_H */ - -#define IS_SPACE(cur) \ - ((*cur == ' ') || (*cur == '\t') || (*cur == '\n') || \ - (*cur == '\r') || (*cur == '\\')) - - -/** - * virLogParseOutputs: - * @outputs: string defining a (set of) output(s) - * - * The format for an output can be: - * x:stderr - * output goes to stderr - * x:syslog:name - * use syslog for the output and use the given name as the ident - * x:file:file_path - * output to a file, with the given filepath - * In all case the x prefix is the minimal level, acting as a filter - * 0: everything - * 1: DEBUG - * 2: INFO - * 3: WARNING - * 4: ERROR - * - * Multiple output can be defined in a single @output, they just need to be - * separated by spaces. - * - * Returns the number of output parsed and installed or -1 in case of error - */ -int -virLogParseOutputs(const char *outputs) -{ - const char *cur = outputs, *str; - char *name; - char *abspath; - virLogPriority prio; - int ret = -1; - int count = 0; - - if (cur == NULL) - return -1; - - VIR_DEBUG("outputs=%s", outputs); - - virSkipSpaces(&cur); - while (*cur != 0) { - prio= virParseNumber(&cur); - if ((prio < VIR_LOG_DEBUG) || (prio > VIR_LOG_ERROR)) - goto cleanup; - if (*cur != ':') - goto cleanup; - cur++; - if (STREQLEN(cur, "stderr", 6)) { - cur += 6; - if (virLogAddOutputToStderr(prio) == 0) - count++; - } else if (STREQLEN(cur, "syslog", 6)) { - cur += 6; - if (*cur != ':') - goto cleanup; - cur++; - str = cur; - while ((*cur != 0) && (!IS_SPACE(cur))) - cur++; - if (str == cur) - goto cleanup; -#if HAVE_SYSLOG_H - name = strndup(str, cur - str); - if (name == NULL) - goto cleanup; - if (virLogAddOutputToSyslog(prio, name) == 0) - count++; - VIR_FREE(name); -#endif /* HAVE_SYSLOG_H */ - } else if (STREQLEN(cur, "file", 4)) { - cur += 4; - if (*cur != ':') - goto cleanup; - cur++; - str = cur; - while ((*cur != 0) && (!IS_SPACE(cur))) - cur++; - if (str == cur) - goto cleanup; - name = strndup(str, cur - str); - if (name == NULL) - goto cleanup; - if (virFileAbsPath(name, &abspath) < 0) { - VIR_FREE(name); - return -1; /* skip warning here because setting was fine */ - } - if (virLogAddOutputToFile(prio, abspath) == 0) - count++; - VIR_FREE(name); - VIR_FREE(abspath); - } else if (STREQLEN(cur, "journald", 8)) { - cur += 8; -#if USE_JOURNALD - if (virLogAddOutputToJournald(prio) == 0) - count++; -#endif /* USE_JOURNALD */ - } else { - goto cleanup; - } - virSkipSpaces(&cur); - } - ret = count; -cleanup: - if (ret == -1) - VIR_WARN("Ignoring invalid log output setting."); - return ret; -} - - -/** - * virLogParseFilters: - * @filters: string defining a (set of) filter(s) - * - * The format for a filter is: - * x:name - * where name is a match string - * the x prefix is the minimal level where the messages should be logged - * 1: DEBUG - * 2: INFO - * 3: WARNING - * 4: ERROR - * - * Multiple filter can be defined in a single @filters, they just need to be - * separated by spaces. - * - * Returns the number of filter parsed and installed or -1 in case of error - */ -int -virLogParseFilters(const char *filters) -{ - const char *cur = filters, *str; - char *name; - virLogPriority prio; - int ret = -1; - int count = 0; - - if (cur == NULL) - return -1; - - virSkipSpaces(&cur); - while (*cur != 0) { - unsigned int flags = 0; - prio= virParseNumber(&cur); - if ((prio < VIR_LOG_DEBUG) || (prio > VIR_LOG_ERROR)) - goto cleanup; - if (*cur != ':') - goto cleanup; - cur++; - if (*cur == '+') { - flags |= VIR_LOG_STACK_TRACE; - cur++; - } - str = cur; - while ((*cur != 0) && (!IS_SPACE(cur))) - cur++; - if (str == cur) - goto cleanup; - name = strndup(str, cur - str); - if (name == NULL) - goto cleanup; - if (virLogDefineFilter(name, prio, flags) >= 0) - count++; - VIR_FREE(name); - virSkipSpaces(&cur); - } - ret = count; -cleanup: - if (ret == -1) - VIR_WARN("Ignoring invalid log filter setting."); - return ret; -} - - -/** - * virLogGetDefaultPriority: - * - * Returns the current logging priority level. - */ -virLogPriority -virLogGetDefaultPriority(void) -{ - return virLogDefaultPriority; -} - - -/** - * virLogGetFilters: - * - * Returns a string listing the current filters, in the format originally - * specified in the config file or environment. Caller must free the - * result. - */ -char * -virLogGetFilters(void) -{ - int i; - virBuffer filterbuf = VIR_BUFFER_INITIALIZER; - - virLogLock(); - for (i = 0; i < virLogNbFilters; i++) { - const char *sep = ":"; - if (virLogFilters[i].flags & VIR_LOG_STACK_TRACE) - sep = ":+"; - virBufferAsprintf(&filterbuf, "%d%s%s ", - virLogFilters[i].priority, - sep, - virLogFilters[i].match); - } - virLogUnlock(); - - if (virBufferError(&filterbuf)) { - virBufferFreeAndReset(&filterbuf); - return NULL; - } - - return virBufferContentAndReset(&filterbuf); -} - - -/** - * virLogGetOutputs: - * - * Returns a string listing the current outputs, in the format originally - * specified in the config file or environment. Caller must free the - * result. - */ -char * -virLogGetOutputs(void) -{ - int i; - virBuffer outputbuf = VIR_BUFFER_INITIALIZER; - - virLogLock(); - for (i = 0; i < virLogNbOutputs; i++) { - virLogDestination dest = virLogOutputs[i].dest; - if (i) - virBufferAsprintf(&outputbuf, " "); - switch (dest) { - case VIR_LOG_TO_SYSLOG: - case VIR_LOG_TO_FILE: - virBufferAsprintf(&outputbuf, "%d:%s:%s", - virLogOutputs[i].priority, - virLogOutputString(dest), - virLogOutputs[i].name); - break; - default: - virBufferAsprintf(&outputbuf, "%d:%s", - virLogOutputs[i].priority, - virLogOutputString(dest)); - } - } - virLogUnlock(); - - if (virBufferError(&outputbuf)) { - virBufferFreeAndReset(&outputbuf); - return NULL; - } - - return virBufferContentAndReset(&outputbuf); -} - - -/** - * virLogGetNbFilters: - * - * Returns the current number of defined log filters. - */ -int -virLogGetNbFilters(void) -{ - return virLogNbFilters; -} - - -/** - * virLogGetNbOutputs: - * - * Returns the current number of defined log outputs. - */ -int -virLogGetNbOutputs(void) -{ - return virLogNbOutputs; -} - - -/** - * virLogParseDefaultPriority: - * @priority: string defining the desired logging level - * - * Parses and sets the default log priority level. It can take a string or - * number corresponding to the following levels: - * 1: DEBUG - * 2: INFO - * 3: WARNING - * 4: ERROR - * - * Returns the parsed log level or -1 on error. - */ -int -virLogParseDefaultPriority(const char *priority) -{ - int ret = -1; - - if (STREQ(priority, "1") || STREQ(priority, "debug")) - ret = virLogSetDefaultPriority(VIR_LOG_DEBUG); - else if (STREQ(priority, "2") || STREQ(priority, "info")) - ret = virLogSetDefaultPriority(VIR_LOG_INFO); - else if (STREQ(priority, "3") || STREQ(priority, "warning")) - ret = virLogSetDefaultPriority(VIR_LOG_WARN); - else if (STREQ(priority, "4") || STREQ(priority, "error")) - ret = virLogSetDefaultPriority(VIR_LOG_ERROR); - else - VIR_WARN("Ignoring invalid log level setting"); - - return ret; -} - - -/** - * virLogSetFromEnv: - * - * Sets virLogDefaultPriority, virLogFilters and virLogOutputs based on - * environment variables. - */ -void -virLogSetFromEnv(void) -{ - char *debugEnv; - - debugEnv = getenv("LIBVIRT_DEBUG"); - if (debugEnv && *debugEnv) - virLogParseDefaultPriority(debugEnv); - debugEnv = getenv("LIBVIRT_LOG_FILTERS"); - if (debugEnv && *debugEnv) - virLogParseFilters(debugEnv); - debugEnv = getenv("LIBVIRT_LOG_OUTPUTS"); - if (debugEnv && *debugEnv) - virLogParseOutputs(debugEnv); -} diff --git a/src/util/logging.h b/src/util/logging.h deleted file mode 100644 index 028b791..0000000 --- a/src/util/logging.h +++ /dev/null @@ -1,191 +0,0 @@ -/* - * logging.h: internal logging and debugging - * - * Copyright (C) 2006-2008, 2011-2012 Red Hat, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - */ - -#ifndef __VIRTLOG_H_ -# define __VIRTLOG_H_ - -# include "internal.h" -# include "virbuffer.h" - -/* - * To be made public - */ -typedef enum { - VIR_LOG_DEBUG = 1, - VIR_LOG_INFO, - VIR_LOG_WARN, - VIR_LOG_ERROR, -} virLogPriority; - -# define VIR_LOG_DEFAULT VIR_LOG_WARN - -typedef enum { - VIR_LOG_TO_STDERR = 1, - VIR_LOG_TO_SYSLOG, - VIR_LOG_TO_FILE, - VIR_LOG_TO_JOURNALD, -} virLogDestination; - -typedef enum { - VIR_LOG_FROM_FILE, - VIR_LOG_FROM_ERROR, - VIR_LOG_FROM_AUDIT, - VIR_LOG_FROM_TRACE, - VIR_LOG_FROM_LIBRARY, - - VIR_LOG_FROM_LAST, -} virLogSource; - -/* - * If configured with --enable-debug=yes then library calls - * are printed to stderr for debugging or to an appropriate channel - * defined at runtime from the libvirt daemon configuration file - */ -# ifdef ENABLE_DEBUG -# define VIR_DEBUG_INT(src, filename, linenr, funcname, ...) \ - virLogMessage(src, VIR_LOG_DEBUG, filename, linenr, funcname, NULL, __VA_ARGS__) -# else -/** - * virLogEatParams: - * - * Do nothing but eat parameters. - */ -static inline void virLogEatParams(virLogSource unused, ...) -{ - /* Silence gcc */ - unused = unused; -} -# define VIR_DEBUG_INT(src, filename, linenr, funcname, ...) \ - virLogEatParams(src, filename, linenr, funcname, __VA_ARGS__) -# endif /* !ENABLE_DEBUG */ - -# define VIR_INFO_INT(src, filename, linenr, funcname, ...) \ - virLogMessage(src, VIR_LOG_INFO, filename, linenr, funcname, NULL, __VA_ARGS__) -# define VIR_WARN_INT(src, filename, linenr, funcname, ...) \ - virLogMessage(src, VIR_LOG_WARN, filename, linenr, funcname, NULL, __VA_ARGS__) -# define VIR_ERROR_INT(src, filename, linenr, funcname, ...) \ - virLogMessage(src, VIR_LOG_ERROR, filename, linenr, funcname, NULL, __VA_ARGS__) - -# define VIR_DEBUG(...) \ - VIR_DEBUG_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__) -# define VIR_INFO(...) \ - VIR_INFO_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__) -# define VIR_WARN(...) \ - VIR_WARN_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__) -# define VIR_ERROR(...) \ - VIR_ERROR_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__) - - -struct _virLogMetadata { - const char *key; - const char *s; /* String value, or NULL to use "i" */ - int i; -}; - -typedef struct _virLogMetadata virLogMetadata; -typedef struct _virLogMetadata *virLogMetadataPtr; - -/** - * virLogOutputFunc: - * @src: the src for the message - * @priority: the priority for the message - * @filename: file where the message was emitted - * @linenr: line where the message was emitted - * @funcname: the function emitting the message - * @timestamp: zero terminated string with timestamp of the message - * @metadata: NULL or metadata array, terminated by an item with NULL key - * @flags: flags associated with the message - * @rawstr: the unformatted message to log, zero terminated - * @str: the message to log, preformatted and zero terminated - * @data: extra output logging data - * - * Callback function used to output messages - */ -typedef void (*virLogOutputFunc) (virLogSource src, - virLogPriority priority, - const char *filename, - int linenr, - const char *funcname, - const char *timestamp, - virLogMetadataPtr metadata, - unsigned int flags, - const char *rawstr, - const char *str, - void *data); - -/** - * virLogCloseFunc: - * @data: extra output logging data - * - * Callback function used to close a log output - */ -typedef void (*virLogCloseFunc) (void *data); - -typedef enum { - VIR_LOG_STACK_TRACE = (1 << 0), -} virLogFlags; - -extern int virLogGetNbFilters(void); -extern int virLogGetNbOutputs(void); -extern char *virLogGetFilters(void); -extern char *virLogGetOutputs(void); -extern virLogPriority virLogGetDefaultPriority(void); -extern int virLogSetDefaultPriority(virLogPriority priority); -extern void virLogSetFromEnv(void); -extern int virLogDefineFilter(const char *match, - virLogPriority priority, - unsigned int flags); -extern int virLogDefineOutput(virLogOutputFunc f, - virLogCloseFunc c, - void *data, - virLogPriority priority, - virLogDestination dest, - const char *name, - unsigned int flags); - -/* - * Internal logging API - */ - -extern void virLogLock(void); -extern void virLogUnlock(void); -extern int virLogReset(void); -extern int virLogParseDefaultPriority(const char *priority); -extern int virLogParseFilters(const char *filters); -extern int virLogParseOutputs(const char *output); -extern void virLogMessage(virLogSource src, - virLogPriority priority, - const char *filename, - int linenr, - const char *funcname, - virLogMetadataPtr metadata, - const char *fmt, ...) ATTRIBUTE_FMT_PRINTF(7, 8); -extern void virLogVMessage(virLogSource src, - virLogPriority priority, - const char *filename, - int linenr, - const char *funcname, - virLogMetadataPtr metadata, - const char *fmt, - va_list vargs) ATTRIBUTE_FMT_PRINTF(7, 0); -extern int virLogSetBufferSize(int size); -extern void virLogEmergencyDumpAll(int signum); -#endif diff --git a/src/util/memory.c b/src/util/memory.c index b224f30..186d3b6 100644 --- a/src/util/memory.c +++ b/src/util/memory.c @@ -24,7 +24,7 @@ #include <stdlib.h> #include "memory.h" -#include "logging.h" +#include "virlog.h" #if TEST_OOM static int testMallocNext = 0; diff --git a/src/util/pci.c b/src/util/pci.c index bf46fca..7adce75 100644 --- a/src/util/pci.c +++ b/src/util/pci.c @@ -34,7 +34,7 @@ #include <unistd.h> #include <stdlib.h> -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "vircommand.h" #include "virterror_internal.h" diff --git a/src/util/storage_file.c b/src/util/storage_file.c index eebf59a..6c3390b 100644 --- a/src/util/storage_file.c +++ b/src/util/storage_file.c @@ -37,7 +37,7 @@ #include "dirname.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "c-ctype.h" #include "vircommand.h" diff --git a/src/util/sysinfo.c b/src/util/sysinfo.c index e21cbfd..5690f95 100644 --- a/src/util/sysinfo.c +++ b/src/util/sysinfo.c @@ -33,7 +33,7 @@ #include "virterror_internal.h" #include "sysinfo.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "vircommand.h" diff --git a/src/util/util.c b/src/util/util.c index f8ba7b4..f941dfd 100644 --- a/src/util/util.c +++ b/src/util/util.c @@ -76,7 +76,7 @@ #include "c-ctype.h" #include "dirname.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "virbuffer.h" #include "util.h" #include "storage_file.h" diff --git a/src/util/uuid.c b/src/util/uuid.c index 5c3b32c..6efc7be 100644 --- a/src/util/uuid.c +++ b/src/util/uuid.c @@ -37,7 +37,7 @@ #include "internal.h" #include "util.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "virfile.h" #include "virrandom.h" diff --git a/src/util/viraudit.c b/src/util/viraudit.c index 9bdc5ed..c4e0129 100644 --- a/src/util/viraudit.c +++ b/src/util/viraudit.c @@ -28,7 +28,7 @@ #include <unistd.h> #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "viraudit.h" #include "util.h" #include "virfile.h" diff --git a/src/util/virauth.c b/src/util/virauth.c index 6d9935d..a1bad6a 100644 --- a/src/util/virauth.c +++ b/src/util/virauth.c @@ -27,7 +27,7 @@ #include "virauth.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "virterror_internal.h" #include "configmake.h" diff --git a/src/util/virauthconfig.c b/src/util/virauthconfig.c index 49a4466..46ba040 100644 --- a/src/util/virauthconfig.c +++ b/src/util/virauthconfig.c @@ -27,7 +27,7 @@ #include "virkeyfile.h" #include "memory.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" diff --git a/src/util/vircgroup.c b/src/util/vircgroup.c index e9fc67f..82e6613 100644 --- a/src/util/vircgroup.c +++ b/src/util/vircgroup.c @@ -41,7 +41,7 @@ #include "util.h" #include "memory.h" #include "vircgroup.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "virhash.h" #include "virhashcode.h" diff --git a/src/util/vircommand.c b/src/util/vircommand.c index 3046658..7bed04e 100644 --- a/src/util/vircommand.c +++ b/src/util/vircommand.c @@ -37,7 +37,7 @@ #include "memory.h" #include "virterror_internal.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "virpidfile.h" #include "virprocess.h" diff --git a/src/util/virconf.c b/src/util/virconf.c index 221a1eb..c12a0bb 100644 --- a/src/util/virconf.c +++ b/src/util/virconf.c @@ -35,7 +35,7 @@ #include "virconf.h" #include "util.h" #include "c-ctype.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "virfile.h" diff --git a/src/util/virdbus.c b/src/util/virdbus.c index 2a96778..b6c6642 100644 --- a/src/util/virdbus.c +++ b/src/util/virdbus.c @@ -24,7 +24,7 @@ #include "virdbus.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "threads.h" #define VIR_FROM_THIS VIR_FROM_DBUS diff --git a/src/util/virdnsmasq.c b/src/util/virdnsmasq.c index 4a32f49..7bb42fc 100644 --- a/src/util/virdnsmasq.c +++ b/src/util/virdnsmasq.c @@ -45,7 +45,7 @@ #include "vircommand.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #define VIR_FROM_THIS VIR_FROM_NETWORK diff --git a/src/util/virebtables.c b/src/util/virebtables.c index 8474b2a..8333c38 100644 --- a/src/util/virebtables.c +++ b/src/util/virebtables.c @@ -44,7 +44,7 @@ #include "vircommand.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "threads.h" #if HAVE_FIREWALLD diff --git a/src/util/virevent.c b/src/util/virevent.c index 7d11f85..573b4ac 100644 --- a/src/util/virevent.c +++ b/src/util/virevent.c @@ -25,7 +25,7 @@ #include "virevent.h" #include "vireventpoll.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include <stdlib.h> diff --git a/src/util/vireventpoll.c b/src/util/vireventpoll.c index 9fd196d..0256d83 100644 --- a/src/util/vireventpoll.c +++ b/src/util/vireventpoll.c @@ -32,7 +32,7 @@ #include <fcntl.h> #include "threads.h" -#include "logging.h" +#include "virlog.h" #include "vireventpoll.h" #include "memory.h" #include "util.h" diff --git a/src/util/virfile.c b/src/util/virfile.c index d77b726..30294a2 100644 --- a/src/util/virfile.c +++ b/src/util/virfile.c @@ -41,7 +41,7 @@ #include "configmake.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/src/util/virhash.c b/src/util/virhash.c index 1576dd3..077abca 100644 --- a/src/util/virhash.c +++ b/src/util/virhash.c @@ -27,7 +27,7 @@ #include "virterror_internal.h" #include "virhash.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virhashcode.h" #include "virrandom.h" diff --git a/src/util/virhooks.c b/src/util/virhooks.c index 4a732ff..2e8ecf2 100644 --- a/src/util/virhooks.c +++ b/src/util/virhooks.c @@ -33,7 +33,7 @@ #include "virterror_internal.h" #include "virhooks.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "virfile.h" #include "configmake.h" diff --git a/src/util/viriptables.c b/src/util/viriptables.c index 8831920..ee3e9a0 100644 --- a/src/util/viriptables.c +++ b/src/util/viriptables.c @@ -42,7 +42,7 @@ #include "vircommand.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "threads.h" #if HAVE_FIREWALLD diff --git a/src/util/virjson.c b/src/util/virjson.c index a07dd5c..18a28ba 100644 --- a/src/util/virjson.c +++ b/src/util/virjson.c @@ -26,7 +26,7 @@ #include "virjson.h" #include "memory.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #if HAVE_YAJL diff --git a/src/util/virkeyfile.c b/src/util/virkeyfile.c index 3c2ce26..b43b92d 100644 --- a/src/util/virkeyfile.c +++ b/src/util/virkeyfile.c @@ -26,7 +26,7 @@ #include <stdio.h> #include "c-ctype.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "util.h" #include "virhash.h" diff --git a/src/util/virlockspace.c b/src/util/virlockspace.c index 99b6182..b652294 100644 --- a/src/util/virlockspace.c +++ b/src/util/virlockspace.c @@ -22,7 +22,7 @@ #include <config.h> #include "virlockspace.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "virterror_internal.h" #include "util.h" diff --git a/src/util/virlog.c b/src/util/virlog.c new file mode 100644 index 0000000..d179de2 --- /dev/null +++ b/src/util/virlog.c @@ -0,0 +1,1590 @@ +/* + * logging.c: internal logging and debugging + * + * Copyright (C) 2008, 2010-2012 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + */ + +#include <config.h> + +#include <stdio.h> +#include <stdarg.h> +#include <stdlib.h> +#include <time.h> +#include <sys/time.h> +#include <sys/types.h> +#include <sys/stat.h> +#include <fcntl.h> +#include <unistd.h> +#include <signal.h> +#include <execinfo.h> +#if HAVE_SYSLOG_H +# include <syslog.h> +#endif +#include <sys/socket.h> +#if HAVE_SYS_UN_H +# include <sys/un.h> +#endif + +#include "virterror_internal.h" +#include "virlog.h" +#include "memory.h" +#include "util.h" +#include "virbuffer.h" +#include "threads.h" +#include "virfile.h" +#include "virtime.h" +#include "intprops.h" + +/* Journald output is only supported on Linux new enough to expose + * htole64. */ +#if HAVE_SYSLOG_H && defined(__linux__) && HAVE_DECL_HTOLE64 +# define USE_JOURNALD 1 +#endif + +#define VIR_FROM_THIS VIR_FROM_NONE + +VIR_ENUM_DECL(virLogSource) +VIR_ENUM_IMPL(virLogSource, VIR_LOG_FROM_LAST, + "file", + "error", + "audit", + "trace", + "library"); + +/* + * A logging buffer to keep some history over logs + */ + +static int virLogSize = 64 * 1024; +static char *virLogBuffer = NULL; +static int virLogLen = 0; +static int virLogStart = 0; +static int virLogEnd = 0; + +/* + * Filters are used to refine the rules on what to keep or drop + * based on a matching pattern (currently a substring) + */ +struct _virLogFilter { + const char *match; + virLogPriority priority; + unsigned int flags; +}; +typedef struct _virLogFilter virLogFilter; +typedef virLogFilter *virLogFilterPtr; + +static virLogFilterPtr virLogFilters = NULL; +static int virLogNbFilters = 0; + +/* + * Outputs are used to emit the messages retained + * after filtering, multiple output can be used simultaneously + */ +struct _virLogOutput { + bool logVersion; + void *data; + virLogOutputFunc f; + virLogCloseFunc c; + virLogPriority priority; + virLogDestination dest; + const char *name; +}; +typedef struct _virLogOutput virLogOutput; +typedef virLogOutput *virLogOutputPtr; + +static virLogOutputPtr virLogOutputs = NULL; +static int virLogNbOutputs = 0; + +/* + * Default priorities + */ +static virLogPriority virLogDefaultPriority = VIR_LOG_DEFAULT; + +static int virLogResetFilters(void); +static int virLogResetOutputs(void); +static void virLogOutputToFd(virLogSource src, + virLogPriority priority, + const char *filename, + int linenr, + const char *funcname, + const char *timestamp, + virLogMetadataPtr metadata, + unsigned int flags, + const char *rawstr, + const char *str, + void *data); + +/* + * Logs accesses must be serialized though a mutex + */ +virMutex virLogMutex; + +void +virLogLock(void) +{ + virMutexLock(&virLogMutex); +} + + +void +virLogUnlock(void) +{ + virMutexUnlock(&virLogMutex); +} + + +static const char * +virLogOutputString(virLogDestination ldest) +{ + switch (ldest) { + case VIR_LOG_TO_STDERR: + return "stderr"; + case VIR_LOG_TO_SYSLOG: + return "syslog"; + case VIR_LOG_TO_FILE: + return "file"; + case VIR_LOG_TO_JOURNALD: + return "journald"; + } + return "unknown"; +} + + +static const char * +virLogPriorityString(virLogPriority lvl) +{ + switch (lvl) { + case VIR_LOG_DEBUG: + return "debug"; + case VIR_LOG_INFO: + return "info"; + case VIR_LOG_WARN: + return "warning"; + case VIR_LOG_ERROR: + return "error"; + } + return "unknown"; +} + + +static int +virLogOnceInit(void) +{ + const char *pbm = NULL; + + if (virMutexInit(&virLogMutex) < 0) + return -1; + + virLogLock(); + if (VIR_ALLOC_N(virLogBuffer, virLogSize + 1) < 0) { + /* + * The debug buffer is not a critical component, allow startup + * even in case of failure to allocate it in case of a + * configuration mistake. + */ + virLogSize = 64 * 1024; + if (VIR_ALLOC_N(virLogBuffer, virLogSize + 1) < 0) { + pbm = "Failed to allocate debug buffer: deactivating debug log\n"; + virLogSize = 0; + } else { + pbm = "Failed to allocate debug buffer: reduced to 64 kB\n"; + } + } + virLogLen = 0; + virLogStart = 0; + virLogEnd = 0; + virLogDefaultPriority = VIR_LOG_DEFAULT; + virLogUnlock(); + if (pbm) + VIR_WARN("%s", pbm); + return 0; +} + +VIR_ONCE_GLOBAL_INIT(virLog) + + +/** + * virLogSetBufferSize: + * @size: size of the buffer in kilobytes or <= 0 to deactivate + * + * Dynamically set the size or deactivate the logging buffer used to keep + * a trace of all recent debug output. Note that the content of the buffer + * is lost if it gets reallocated. + * + * Return -1 in case of failure or 0 in case of success + */ +int +virLogSetBufferSize(int size) +{ + int ret = 0; + int oldsize; + char *oldLogBuffer; + const char *pbm = NULL; + + if (size < 0) + size = 0; + + if (virLogInitialize() < 0) + return -1; + + if (size * 1024 == virLogSize) + return ret; + + virLogLock(); + + oldsize = virLogSize; + oldLogBuffer = virLogBuffer; + + if (INT_MAX / 1024 <= size) { + pbm = "Requested log size of %d kB too large\n"; + ret = -1; + goto error; + } + + virLogSize = size * 1024; + if (VIR_ALLOC_N(virLogBuffer, virLogSize + 1) < 0) { + pbm = "Failed to allocate debug buffer of %d kB\n"; + virLogBuffer = oldLogBuffer; + virLogSize = oldsize; + ret = -1; + goto error; + } + VIR_FREE(oldLogBuffer); + virLogLen = 0; + virLogStart = 0; + virLogEnd = 0; + +error: + virLogUnlock(); + if (pbm) + VIR_ERROR(pbm, size); + return ret; +} + + +/** + * virLogReset: + * + * Reset the logging module to its default initial state + * + * Returns 0 if successful, and -1 in case or error + */ +int +virLogReset(void) +{ + if (virLogInitialize() < 0) + return -1; + + virLogLock(); + virLogResetFilters(); + virLogResetOutputs(); + virLogLen = 0; + virLogStart = 0; + virLogEnd = 0; + virLogDefaultPriority = VIR_LOG_DEFAULT; + virLogUnlock(); + return 0; +} + + +/* + * Store a string in the ring buffer + */ +static void +virLogStr(const char *str) +{ + int tmp; + int len; + + if ((str == NULL) || (virLogBuffer == NULL) || (virLogSize <= 0)) + return; + len = strlen(str); + if (len >= virLogSize) + return; + + /* + * copy the data and reset the end, we cycle over the end of the buffer + */ + if (virLogEnd + len >= virLogSize) { + tmp = virLogSize - virLogEnd; + memcpy(&virLogBuffer[virLogEnd], str, tmp); + memcpy(&virLogBuffer[0], &str[tmp], len - tmp); + virLogEnd = len - tmp; + } else { + memcpy(&virLogBuffer[virLogEnd], str, len); + virLogEnd += len; + } + virLogBuffer[virLogEnd] = 0; + /* + * Update the log length, and if full move the start index + */ + virLogLen += len; + if (virLogLen > virLogSize) { + tmp = virLogLen - virLogSize; + virLogLen = virLogSize; + virLogStart += tmp; + if (virLogStart >= virLogSize) + virLogStart -= virLogSize; + } +} + + +static void +virLogDumpAllFD(const char *msg, int len) +{ + int i, found = 0; + + if (len <= 0) + len = strlen(msg); + + for (i = 0; i < virLogNbOutputs;i++) { + if (virLogOutputs[i].f == virLogOutputToFd) { + int fd = (intptr_t) virLogOutputs[i].data; + + if (fd >= 0) { + ignore_value(safewrite(fd, msg, len)); + found = 1; + } + } + } + if (!found) + ignore_value(safewrite(STDERR_FILENO, msg, len)); +} + + +/** + * virLogEmergencyDumpAll: + * @signum: the signal number + * + * Emergency function called, possibly from a signal handler. + * It need to output the debug ring buffer through the log + * output which are safe to use from a signal handler. + * In case none is found it is emitted to standard error. + */ +void +virLogEmergencyDumpAll(int signum) +{ + int len; + int oldLogStart, oldLogLen; + + switch (signum) { +#ifdef SIGFPE + case SIGFPE: + virLogDumpAllFD("Caught signal Floating-point exception", -1); + break; +#endif +#ifdef SIGSEGV + case SIGSEGV: + virLogDumpAllFD("Caught Segmentation violation", -1); + break; +#endif +#ifdef SIGILL + case SIGILL: + virLogDumpAllFD("Caught illegal instruction", -1); + break; +#endif +#ifdef SIGABRT + case SIGABRT: + virLogDumpAllFD("Caught abort signal", -1); + break; +#endif +#ifdef SIGBUS + case SIGBUS: + virLogDumpAllFD("Caught bus error", -1); + break; +#endif +#ifdef SIGUSR2 + case SIGUSR2: + virLogDumpAllFD("Caught User-defined signal 2", -1); + break; +#endif + default: + virLogDumpAllFD("Caught unexpected signal", -1); + break; + } + if ((virLogBuffer == NULL) || (virLogSize <= 0)) { + virLogDumpAllFD(" internal log buffer deactivated\n", -1); + return; + } + + virLogDumpAllFD(" dumping internal log buffer:\n", -1); + virLogDumpAllFD("\n\n ====== start of log =====\n\n", -1); + + /* + * Since we can't lock the buffer safely from a signal handler + * we mark it as empty in case of concurrent access, and proceed + * with the data, at worse we will output something a bit weird + * if another thread start logging messages at the same time. + * Note that virLogStr() uses virLogEnd for the computations and + * writes to the buffer and only then updates virLogLen and virLogStart + * so it's best to reset it first. + */ + oldLogStart = virLogStart; + oldLogLen = virLogLen; + virLogEnd = 0; + virLogLen = 0; + virLogStart = 0; + + while (oldLogLen > 0) { + if (oldLogStart + oldLogLen < virLogSize) { + virLogBuffer[oldLogStart + oldLogLen] = 0; + virLogDumpAllFD(&virLogBuffer[oldLogStart], oldLogLen); + oldLogStart += oldLogLen; + oldLogLen = 0; + } else { + len = virLogSize - oldLogStart; + virLogBuffer[virLogSize] = 0; + virLogDumpAllFD(&virLogBuffer[oldLogStart], len); + oldLogLen -= len; + oldLogStart = 0; + } + } + virLogDumpAllFD("\n\n ====== end of log =====\n\n", -1); +} + + +/** + * virLogSetDefaultPriority: + * @priority: the default priority level + * + * Set the default priority level, i.e. any logged data of a priority + * equal or superior to this level will be logged, unless a specific rule + * was defined for the log category of the message. + * + * Returns 0 if successful, -1 in case of error. + */ +int +virLogSetDefaultPriority(virLogPriority priority) +{ + if ((priority < VIR_LOG_DEBUG) || (priority > VIR_LOG_ERROR)) { + VIR_WARN("Ignoring invalid log level setting."); + return -1; + } + if (virLogInitialize() < 0) + return -1; + + virLogDefaultPriority = priority; + return 0; +} + + +/** + * virLogResetFilters: + * + * Removes the set of logging filters defined. + * + * Returns the number of filters removed + */ +static int +virLogResetFilters(void) +{ + int i; + + for (i = 0; i < virLogNbFilters;i++) + VIR_FREE(virLogFilters[i].match); + VIR_FREE(virLogFilters); + virLogNbFilters = 0; + return i; +} + + +/** + * virLogDefineFilter: + * @match: the pattern to match + * @priority: the priority to give to messages matching the pattern + * @flags: extra flags, see virLogFilterFlags enum + * + * Defines a pattern used for log filtering, it allow to select or + * reject messages independently of the default priority. + * The filter defines a rules that will apply only to messages matching + * the pattern (currently if @match is a substring of the message category) + * + * Returns -1 in case of failure or the filter number if successful + */ +int +virLogDefineFilter(const char *match, + virLogPriority priority, + unsigned int flags) +{ + int i; + char *mdup = NULL; + + virCheckFlags(VIR_LOG_STACK_TRACE, -1); + + if ((match == NULL) || (priority < VIR_LOG_DEBUG) || + (priority > VIR_LOG_ERROR)) + return -1; + + virLogLock(); + for (i = 0;i < virLogNbFilters;i++) { + if (STREQ(virLogFilters[i].match, match)) { + virLogFilters[i].priority = priority; + goto cleanup; + } + } + + mdup = strdup(match); + if (mdup == NULL) { + i = -1; + goto cleanup; + } + i = virLogNbFilters; + if (VIR_REALLOC_N(virLogFilters, virLogNbFilters + 1)) { + i = -1; + VIR_FREE(mdup); + goto cleanup; + } + virLogFilters[i].match = mdup; + virLogFilters[i].priority = priority; + virLogFilters[i].flags = flags; + virLogNbFilters++; +cleanup: + virLogUnlock(); + return i; +} + + +/** + * virLogFiltersCheck: + * @input: the input string + * + * Check the input of the message against the existing filters. Currently + * the match is just a substring check of the category used as the input + * string, a more subtle approach could be used instead + * + * Returns 0 if not matched or the new priority if found. + */ +static int +virLogFiltersCheck(const char *input, + unsigned int *flags) +{ + int ret = 0; + int i; + + virLogLock(); + for (i = 0;i < virLogNbFilters;i++) { + if (strstr(input, virLogFilters[i].match)) { + ret = virLogFilters[i].priority; + *flags = virLogFilters[i].flags; + break; + } + } + virLogUnlock(); + return ret; +} + + +/** + * virLogResetOutputs: + * + * Removes the set of logging output defined. + * + * Returns the number of output removed + */ +static int +virLogResetOutputs(void) +{ + int i; + + for (i = 0;i < virLogNbOutputs;i++) { + if (virLogOutputs[i].c != NULL) + virLogOutputs[i].c(virLogOutputs[i].data); + VIR_FREE(virLogOutputs[i].name); + } + VIR_FREE(virLogOutputs); + i = virLogNbOutputs; + virLogNbOutputs = 0; + return i; +} + + +/** + * virLogDefineOutput: + * @f: the function to call to output a message + * @c: the function to call to close the output (or NULL) + * @data: extra data passed as first arg to the function + * @priority: minimal priority for this filter, use 0 for none + * @dest: where to send output of this priority + * @name: optional name data associated with an output + * @flags: extra flag, currently unused + * + * Defines an output function for log messages. Each message once + * gone though filtering is emitted through each registered output. + * + * Returns -1 in case of failure or the output number if successful + */ +int +virLogDefineOutput(virLogOutputFunc f, + virLogCloseFunc c, + void *data, + virLogPriority priority, + virLogDestination dest, + const char *name, + unsigned int flags) +{ + int ret = -1; + char *ndup = NULL; + + virCheckFlags(0, -1); + + if (f == NULL) + return -1; + + if (dest == VIR_LOG_TO_SYSLOG || dest == VIR_LOG_TO_FILE) { + if (name == NULL) + return -1; + ndup = strdup(name); + if (ndup == NULL) + return -1; + } + + virLogLock(); + if (VIR_REALLOC_N(virLogOutputs, virLogNbOutputs + 1)) { + VIR_FREE(ndup); + goto cleanup; + } + ret = virLogNbOutputs++; + virLogOutputs[ret].logVersion = true; + virLogOutputs[ret].f = f; + virLogOutputs[ret].c = c; + virLogOutputs[ret].data = data; + virLogOutputs[ret].priority = priority; + virLogOutputs[ret].dest = dest; + virLogOutputs[ret].name = ndup; +cleanup: + virLogUnlock(); + return ret; +} + + +static int +virLogFormatString(char **msg, + int linenr, + const char *funcname, + virLogPriority priority, + const char *str) +{ + int ret; + + /* + * Be careful when changing the following log message formatting, we rely + * on it when stripping libvirt debug messages from qemu log files. So when + * changing this, you might also need to change the code there. + * virLogFormatString() function name is mentioned there so it's sufficient + * to just grep for it to find the right place. + */ + if ((funcname != NULL)) { + ret = virAsprintf(msg, "%d: %s : %s:%d : %s\n", + virThreadSelfID(), virLogPriorityString(priority), + funcname, linenr, str); + } else { + ret = virAsprintf(msg, "%d: %s : %s\n", + virThreadSelfID(), virLogPriorityString(priority), + str); + } + return ret; +} + + +static int +virLogVersionString(const char **rawmsg, + char **msg) +{ +#ifdef PACKAGER_VERSION +# ifdef PACKAGER +# define LOG_VERSION_STRING \ + "libvirt version: " VERSION ", package: " PACKAGER_VERSION " (" PACKAGER ")" +# else +# define LOG_VERSION_STRING \ + "libvirt version: " VERSION ", package: " PACKAGER_VERSION +# endif +#else +# define LOG_VERSION_STRING \ + "libvirt version: " VERSION +#endif + + *rawmsg = LOG_VERSION_STRING; + return virLogFormatString(msg, 0, NULL, VIR_LOG_INFO, LOG_VERSION_STRING); +} + + +/** + * virLogMessage: + * @source: where is that message coming from + * @priority: the priority level + * @filename: file where the message was emitted + * @linenr: line where the message was emitted + * @funcname: the function emitting the (debug) message + * @metadata: NULL or metadata array, terminated by an item with NULL key + * @fmt: the string format + * @...: the arguments + * + * Call the libvirt logger with some information. Based on the configuration + * the message may be stored, sent to output or just discarded + */ +void +virLogMessage(virLogSource source, + virLogPriority priority, + const char *filename, + int linenr, + const char *funcname, + virLogMetadataPtr metadata, + const char *fmt, ...) +{ + va_list ap; + va_start(ap, fmt); + virLogVMessage(source, priority, + filename, linenr, funcname, + metadata, fmt, ap); + va_end(ap); +} + + +/** + * virLogVMessage: + * @source: where is that message coming from + * @priority: the priority level + * @filename: file where the message was emitted + * @linenr: line where the message was emitted + * @funcname: the function emitting the (debug) message + * @metadata: NULL or metadata array, terminated by an item with NULL key + * @fmt: the string format + * @vargs: format args + * + * Call the libvirt logger with some information. Based on the configuration + * the message may be stored, sent to output or just discarded + */ +void +virLogVMessage(virLogSource source, + virLogPriority priority, + const char *filename, + int linenr, + const char *funcname, + virLogMetadataPtr metadata, + const char *fmt, + va_list vargs) +{ + static bool logVersionStderr = true; + char *str = NULL; + char *msg = NULL; + char timestamp[VIR_TIME_STRING_BUFLEN]; + int fprio, i, ret; + int saved_errno = errno; + int emit = 1; + unsigned int filterflags = 0; + + if (virLogInitialize() < 0) + return; + + if (fmt == NULL) + goto cleanup; + + /* + * check against list of specific logging patterns + */ + fprio = virLogFiltersCheck(filename, &filterflags); + if (fprio == 0) { + if (priority < virLogDefaultPriority) + emit = 0; + } else if (priority < fprio) { + emit = 0; + } + + if ((emit == 0) && ((virLogBuffer == NULL) || (virLogSize <= 0))) + goto cleanup; + + /* + * serialize the error message, add level and timestamp + */ + if (virVasprintf(&str, fmt, vargs) < 0) { + goto cleanup; + } + + ret = virLogFormatString(&msg, linenr, funcname, priority, str); + if (ret < 0) + goto cleanup; + + if (virTimeStringNowRaw(timestamp) < 0) + timestamp[0] = '\0'; + + /* + * Log based on defaults, first store in the history buffer, + * then if emit push the message on the outputs defined, if none + * use stderr. + * NOTE: the locking is a single point of contention for multiple + * threads, but avoid intermixing. Maybe set up locks per output + * to improve paralellism. + */ + virLogLock(); + virLogStr(timestamp); + virLogStr(msg); + virLogUnlock(); + if (emit == 0) + goto cleanup; + + virLogLock(); + for (i = 0; i < virLogNbOutputs; i++) { + if (priority >= virLogOutputs[i].priority) { + if (virLogOutputs[i].logVersion) { + const char *rawver; + char *ver = NULL; + if (virLogVersionString(&rawver, &ver) >= 0) + virLogOutputs[i].f(VIR_LOG_FROM_FILE, VIR_LOG_INFO, + __FILE__, __LINE__, __func__, + timestamp, NULL, 0, rawver, ver, + virLogOutputs[i].data); + VIR_FREE(ver); + virLogOutputs[i].logVersion = false; + } + virLogOutputs[i].f(source, priority, + filename, linenr, funcname, + timestamp, metadata, filterflags, + str, msg, virLogOutputs[i].data); + } + } + if ((virLogNbOutputs == 0) && (source != VIR_LOG_FROM_ERROR)) { + if (logVersionStderr) { + const char *rawver; + char *ver = NULL; + if (virLogVersionString(&rawver, &ver) >= 0) + virLogOutputToFd(VIR_LOG_FROM_FILE, VIR_LOG_INFO, + __FILE__, __LINE__, __func__, + timestamp, NULL, 0, rawver, ver, + (void *) STDERR_FILENO); + VIR_FREE(ver); + logVersionStderr = false; + } + virLogOutputToFd(source, priority, + filename, linenr, funcname, + timestamp, metadata, filterflags, + str, msg, (void *) STDERR_FILENO); + } + virLogUnlock(); + +cleanup: + VIR_FREE(str); + VIR_FREE(msg); + errno = saved_errno; +} + + +static void +virLogStackTraceToFd(int fd) +{ + void *array[100]; + int size; + static bool doneWarning = false; + const char *msg = "Stack trace not available on this platform\n"; + +#define STRIP_DEPTH 3 + size = backtrace(array, ARRAY_CARDINALITY(array)); + if (size) { + backtrace_symbols_fd(array + STRIP_DEPTH, size - STRIP_DEPTH, fd); + ignore_value(safewrite(fd, "\n", 1)); + } else if (!doneWarning) { + ignore_value(safewrite(fd, msg, strlen(msg))); + doneWarning = true; + } +#undef STRIP_DEPTH +} + +static void +virLogOutputToFd(virLogSource source ATTRIBUTE_UNUSED, + virLogPriority priority ATTRIBUTE_UNUSED, + const char *filename ATTRIBUTE_UNUSED, + int linenr ATTRIBUTE_UNUSED, + const char *funcname ATTRIBUTE_UNUSED, + const char *timestamp, + virLogMetadataPtr metadata ATTRIBUTE_UNUSED, + unsigned int flags, + const char *rawstr ATTRIBUTE_UNUSED, + const char *str, + void *data) +{ + int fd = (intptr_t) data; + char *msg; + + if (fd < 0) + return; + + if (virAsprintf(&msg, "%s: %s", timestamp, str) < 0) + return; + + ignore_value(safewrite(fd, msg, strlen(msg))); + VIR_FREE(msg); + + if (flags & VIR_LOG_STACK_TRACE) + virLogStackTraceToFd(fd); +} + + +static void +virLogCloseFd(void *data) +{ + int fd = (intptr_t) data; + + VIR_LOG_CLOSE(fd); +} + + +static int +virLogAddOutputToStderr(virLogPriority priority) +{ + if (virLogDefineOutput(virLogOutputToFd, NULL, (void *)2L, priority, + VIR_LOG_TO_STDERR, NULL, 0) < 0) + return -1; + return 0; +} + + +static int +virLogAddOutputToFile(virLogPriority priority, + const char *file) +{ + int fd; + + fd = open(file, O_CREAT | O_APPEND | O_WRONLY, S_IRUSR | S_IWUSR); + if (fd < 0) + return -1; + if (virLogDefineOutput(virLogOutputToFd, virLogCloseFd, + (void *)(intptr_t)fd, + priority, VIR_LOG_TO_FILE, file, 0) < 0) { + VIR_FORCE_CLOSE(fd); + return -1; + } + return 0; +} + + +#if HAVE_SYSLOG_H +static int +virLogPrioritySyslog(virLogPriority priority) +{ + switch (priority) { + case VIR_LOG_DEBUG: + return LOG_DEBUG; + case VIR_LOG_INFO: + return LOG_INFO; + case VIR_LOG_WARN: + return LOG_WARNING; + case VIR_LOG_ERROR: + return LOG_ERR; + default: + return LOG_ERR; + } +} + + +static void +virLogOutputToSyslog(virLogSource source ATTRIBUTE_UNUSED, + virLogPriority priority, + const char *filename ATTRIBUTE_UNUSED, + int linenr ATTRIBUTE_UNUSED, + const char *funcname ATTRIBUTE_UNUSED, + const char *timestamp ATTRIBUTE_UNUSED, + virLogMetadataPtr metadata ATTRIBUTE_UNUSED, + unsigned int flags, + const char *rawstr ATTRIBUTE_UNUSED, + const char *str, + void *data ATTRIBUTE_UNUSED) +{ + virCheckFlags(VIR_LOG_STACK_TRACE,); + + syslog(virLogPrioritySyslog(priority), "%s", str); +} + +static char *current_ident = NULL; + + +static void +virLogCloseSyslog(void *data ATTRIBUTE_UNUSED) +{ + closelog(); + VIR_FREE(current_ident); +} + + +static int +virLogAddOutputToSyslog(virLogPriority priority, + const char *ident) +{ + /* + * ident needs to be kept around on Solaris + */ + VIR_FREE(current_ident); + current_ident = strdup(ident); + if (current_ident == NULL) + return -1; + + openlog(current_ident, 0, 0); + if (virLogDefineOutput(virLogOutputToSyslog, virLogCloseSyslog, NULL, + priority, VIR_LOG_TO_SYSLOG, ident, 0) < 0) { + closelog(); + VIR_FREE(current_ident); + return -1; + } + return 0; +} + + +# if USE_JOURNALD +# define IOVEC_SET(iov, data, size) \ + do { \ + struct iovec *_i = &(iov); \ + _i->iov_base = (void*)(data); \ + _i->iov_len = (size); \ + } while (0) + +# define IOVEC_SET_STRING(iov, str) IOVEC_SET(iov, str, strlen(str)) + +/* Used for conversion of numbers to strings, and for length of binary data */ +# define JOURNAL_BUF_SIZE (MAX(INT_BUFSIZE_BOUND(int), sizeof(uint64_t))) + +struct journalState +{ + struct iovec *iov, *iov_end; + char (*bufs)[JOURNAL_BUF_SIZE], (*bufs_end)[JOURNAL_BUF_SIZE]; +}; + +static void +journalAddString(struct journalState *state, const char *field, + const char *value) +{ + static const char newline = '\n', equals = '='; + + if (strchr(value, '\n') != NULL) { + uint64_t nstr; + + /* If 'str' contains a newline, then we must + * encode the string length, since we can't + * rely on the newline for the field separator + */ + if (state->iov_end - state->iov < 5 || state->bufs == state->bufs_end) + return; /* Silently drop */ + nstr = htole64(strlen(value)); + memcpy(state->bufs[0], &nstr, sizeof(nstr)); + + IOVEC_SET_STRING(state->iov[0], field); + IOVEC_SET(state->iov[1], &newline, sizeof(newline)); + IOVEC_SET(state->iov[2], state->bufs[0], sizeof(nstr)); + state->bufs++; + state->iov += 3; + } else { + if (state->iov_end - state->iov < 4) + return; /* Silently drop */ + IOVEC_SET_STRING(state->iov[0], field); + IOVEC_SET(state->iov[1], (void *)&equals, sizeof(equals)); + state->iov += 2; + } + IOVEC_SET_STRING(state->iov[0], value); + IOVEC_SET(state->iov[1], (void *)&newline, sizeof(newline)); + state->iov += 2; +} + +static void +journalAddInt(struct journalState *state, const char *field, int value) +{ + static const char newline = '\n', equals = '='; + + char *num; + + if (state->iov_end - state->iov < 4 || state->bufs == state->bufs_end) + return; /* Silently drop */ + + num = virFormatIntDecimal(state->bufs[0], sizeof(state->bufs[0]), value); + + IOVEC_SET_STRING(state->iov[0], field); + IOVEC_SET(state->iov[1], (void *)&equals, sizeof(equals)); + IOVEC_SET_STRING(state->iov[2], num); + IOVEC_SET(state->iov[3], (void *)&newline, sizeof(newline)); + state->bufs++; + state->iov += 4; +} + +static int journalfd = -1; + +static void +virLogOutputToJournald(virLogSource source, + virLogPriority priority, + const char *filename, + int linenr, + const char *funcname, + const char *timestamp ATTRIBUTE_UNUSED, + virLogMetadataPtr metadata ATTRIBUTE_UNUSED, + unsigned int flags, + const char *rawstr, + const char *str ATTRIBUTE_UNUSED, + void *data ATTRIBUTE_UNUSED) +{ + virCheckFlags(VIR_LOG_STACK_TRACE,); + int buffd = -1; + struct msghdr mh; + struct sockaddr_un sa; + union { + struct cmsghdr cmsghdr; + uint8_t buf[CMSG_SPACE(sizeof(int))]; + } control; + struct cmsghdr *cmsg; + /* We use /dev/shm instead of /tmp here, since we want this to + * be a tmpfs, and one that is available from early boot on + * and where unprivileged users can create files. */ + char path[] = "/dev/shm/journal.XXXXXX"; + +# define NUM_FIELDS 6 + struct iovec iov[NUM_FIELDS * 5]; + char iov_bufs[NUM_FIELDS][JOURNAL_BUF_SIZE]; + struct journalState state; + + state.iov = iov; + state.iov_end = iov + ARRAY_CARDINALITY(iov); + state.bufs = iov_bufs; + state.bufs_end = iov_bufs + ARRAY_CARDINALITY(iov_bufs); + + journalAddString(&state ,"MESSAGE", rawstr); + journalAddInt(&state, "PRIORITY", priority); + journalAddString(&state, "LIBVIRT_SOURCE", + virLogSourceTypeToString(source)); + journalAddString(&state, "CODE_FILE", filename); + journalAddInt(&state, "CODE_LINE", linenr); + journalAddString(&state, "CODE_FUNC", funcname); + + memset(&sa, 0, sizeof(sa)); + sa.sun_family = AF_UNIX; + if (!virStrcpy(sa.sun_path, "/run/systemd/journal/socket", sizeof(sa.sun_path))) + return; + + memset(&mh, 0, sizeof(mh)); + mh.msg_name = &sa; + mh.msg_namelen = offsetof(struct sockaddr_un, sun_path) + strlen(sa.sun_path); + mh.msg_iov = iov; + mh.msg_iovlen = state.iov - iov; + + if (sendmsg(journalfd, &mh, MSG_NOSIGNAL) >= 0) + return; + + if (errno != EMSGSIZE && errno != ENOBUFS) + return; + + /* Message was too large, so dump to temporary file + * and pass an FD to the journal + */ + + /* NB: mkostemp is not declared async signal safe by + * POSIX, but this is Linux only code and the GLibc + * impl is safe enough, only using open() and inline + * asm to read a timestamp (falling back to gettimeofday + * on some arches + */ + if ((buffd = mkostemp(path, O_CLOEXEC|O_RDWR)) < 0) + return; + + if (unlink(path) < 0) + goto cleanup; + + if (writev(buffd, iov, state.iov - iov) < 0) + goto cleanup; + + mh.msg_iov = NULL; + mh.msg_iovlen = 0; + + memset(&control, 0, sizeof(control)); + mh.msg_control = &control; + mh.msg_controllen = sizeof(control); + + cmsg = CMSG_FIRSTHDR(&mh); + cmsg->cmsg_level = SOL_SOCKET; + cmsg->cmsg_type = SCM_RIGHTS; + cmsg->cmsg_len = CMSG_LEN(sizeof(int)); + memcpy(CMSG_DATA(cmsg), &buffd, sizeof(int)); + + mh.msg_controllen = cmsg->cmsg_len; + + sendmsg(journalfd, &mh, MSG_NOSIGNAL); + +cleanup: + VIR_LOG_CLOSE(buffd); +} + + +static void virLogCloseJournald(void *data ATTRIBUTE_UNUSED) +{ + VIR_LOG_CLOSE(journalfd); +} + + +static int virLogAddOutputToJournald(int priority) +{ + if ((journalfd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0) + return -1; + if (virSetInherit(journalfd, false) < 0) { + VIR_LOG_CLOSE(journalfd); + return -1; + } + if (virLogDefineOutput(virLogOutputToJournald, virLogCloseJournald, NULL, + priority, VIR_LOG_TO_JOURNALD, NULL, 0) < 0) { + return -1; + } + return 0; +} +# endif /* USE_JOURNALD */ +#endif /* HAVE_SYSLOG_H */ + +#define IS_SPACE(cur) \ + ((*cur == ' ') || (*cur == '\t') || (*cur == '\n') || \ + (*cur == '\r') || (*cur == '\\')) + + +/** + * virLogParseOutputs: + * @outputs: string defining a (set of) output(s) + * + * The format for an output can be: + * x:stderr + * output goes to stderr + * x:syslog:name + * use syslog for the output and use the given name as the ident + * x:file:file_path + * output to a file, with the given filepath + * In all case the x prefix is the minimal level, acting as a filter + * 0: everything + * 1: DEBUG + * 2: INFO + * 3: WARNING + * 4: ERROR + * + * Multiple output can be defined in a single @output, they just need to be + * separated by spaces. + * + * Returns the number of output parsed and installed or -1 in case of error + */ +int +virLogParseOutputs(const char *outputs) +{ + const char *cur = outputs, *str; + char *name; + char *abspath; + virLogPriority prio; + int ret = -1; + int count = 0; + + if (cur == NULL) + return -1; + + VIR_DEBUG("outputs=%s", outputs); + + virSkipSpaces(&cur); + while (*cur != 0) { + prio= virParseNumber(&cur); + if ((prio < VIR_LOG_DEBUG) || (prio > VIR_LOG_ERROR)) + goto cleanup; + if (*cur != ':') + goto cleanup; + cur++; + if (STREQLEN(cur, "stderr", 6)) { + cur += 6; + if (virLogAddOutputToStderr(prio) == 0) + count++; + } else if (STREQLEN(cur, "syslog", 6)) { + cur += 6; + if (*cur != ':') + goto cleanup; + cur++; + str = cur; + while ((*cur != 0) && (!IS_SPACE(cur))) + cur++; + if (str == cur) + goto cleanup; +#if HAVE_SYSLOG_H + name = strndup(str, cur - str); + if (name == NULL) + goto cleanup; + if (virLogAddOutputToSyslog(prio, name) == 0) + count++; + VIR_FREE(name); +#endif /* HAVE_SYSLOG_H */ + } else if (STREQLEN(cur, "file", 4)) { + cur += 4; + if (*cur != ':') + goto cleanup; + cur++; + str = cur; + while ((*cur != 0) && (!IS_SPACE(cur))) + cur++; + if (str == cur) + goto cleanup; + name = strndup(str, cur - str); + if (name == NULL) + goto cleanup; + if (virFileAbsPath(name, &abspath) < 0) { + VIR_FREE(name); + return -1; /* skip warning here because setting was fine */ + } + if (virLogAddOutputToFile(prio, abspath) == 0) + count++; + VIR_FREE(name); + VIR_FREE(abspath); + } else if (STREQLEN(cur, "journald", 8)) { + cur += 8; +#if USE_JOURNALD + if (virLogAddOutputToJournald(prio) == 0) + count++; +#endif /* USE_JOURNALD */ + } else { + goto cleanup; + } + virSkipSpaces(&cur); + } + ret = count; +cleanup: + if (ret == -1) + VIR_WARN("Ignoring invalid log output setting."); + return ret; +} + + +/** + * virLogParseFilters: + * @filters: string defining a (set of) filter(s) + * + * The format for a filter is: + * x:name + * where name is a match string + * the x prefix is the minimal level where the messages should be logged + * 1: DEBUG + * 2: INFO + * 3: WARNING + * 4: ERROR + * + * Multiple filter can be defined in a single @filters, they just need to be + * separated by spaces. + * + * Returns the number of filter parsed and installed or -1 in case of error + */ +int +virLogParseFilters(const char *filters) +{ + const char *cur = filters, *str; + char *name; + virLogPriority prio; + int ret = -1; + int count = 0; + + if (cur == NULL) + return -1; + + virSkipSpaces(&cur); + while (*cur != 0) { + unsigned int flags = 0; + prio= virParseNumber(&cur); + if ((prio < VIR_LOG_DEBUG) || (prio > VIR_LOG_ERROR)) + goto cleanup; + if (*cur != ':') + goto cleanup; + cur++; + if (*cur == '+') { + flags |= VIR_LOG_STACK_TRACE; + cur++; + } + str = cur; + while ((*cur != 0) && (!IS_SPACE(cur))) + cur++; + if (str == cur) + goto cleanup; + name = strndup(str, cur - str); + if (name == NULL) + goto cleanup; + if (virLogDefineFilter(name, prio, flags) >= 0) + count++; + VIR_FREE(name); + virSkipSpaces(&cur); + } + ret = count; +cleanup: + if (ret == -1) + VIR_WARN("Ignoring invalid log filter setting."); + return ret; +} + + +/** + * virLogGetDefaultPriority: + * + * Returns the current logging priority level. + */ +virLogPriority +virLogGetDefaultPriority(void) +{ + return virLogDefaultPriority; +} + + +/** + * virLogGetFilters: + * + * Returns a string listing the current filters, in the format originally + * specified in the config file or environment. Caller must free the + * result. + */ +char * +virLogGetFilters(void) +{ + int i; + virBuffer filterbuf = VIR_BUFFER_INITIALIZER; + + virLogLock(); + for (i = 0; i < virLogNbFilters; i++) { + const char *sep = ":"; + if (virLogFilters[i].flags & VIR_LOG_STACK_TRACE) + sep = ":+"; + virBufferAsprintf(&filterbuf, "%d%s%s ", + virLogFilters[i].priority, + sep, + virLogFilters[i].match); + } + virLogUnlock(); + + if (virBufferError(&filterbuf)) { + virBufferFreeAndReset(&filterbuf); + return NULL; + } + + return virBufferContentAndReset(&filterbuf); +} + + +/** + * virLogGetOutputs: + * + * Returns a string listing the current outputs, in the format originally + * specified in the config file or environment. Caller must free the + * result. + */ +char * +virLogGetOutputs(void) +{ + int i; + virBuffer outputbuf = VIR_BUFFER_INITIALIZER; + + virLogLock(); + for (i = 0; i < virLogNbOutputs; i++) { + virLogDestination dest = virLogOutputs[i].dest; + if (i) + virBufferAsprintf(&outputbuf, " "); + switch (dest) { + case VIR_LOG_TO_SYSLOG: + case VIR_LOG_TO_FILE: + virBufferAsprintf(&outputbuf, "%d:%s:%s", + virLogOutputs[i].priority, + virLogOutputString(dest), + virLogOutputs[i].name); + break; + default: + virBufferAsprintf(&outputbuf, "%d:%s", + virLogOutputs[i].priority, + virLogOutputString(dest)); + } + } + virLogUnlock(); + + if (virBufferError(&outputbuf)) { + virBufferFreeAndReset(&outputbuf); + return NULL; + } + + return virBufferContentAndReset(&outputbuf); +} + + +/** + * virLogGetNbFilters: + * + * Returns the current number of defined log filters. + */ +int +virLogGetNbFilters(void) +{ + return virLogNbFilters; +} + + +/** + * virLogGetNbOutputs: + * + * Returns the current number of defined log outputs. + */ +int +virLogGetNbOutputs(void) +{ + return virLogNbOutputs; +} + + +/** + * virLogParseDefaultPriority: + * @priority: string defining the desired logging level + * + * Parses and sets the default log priority level. It can take a string or + * number corresponding to the following levels: + * 1: DEBUG + * 2: INFO + * 3: WARNING + * 4: ERROR + * + * Returns the parsed log level or -1 on error. + */ +int +virLogParseDefaultPriority(const char *priority) +{ + int ret = -1; + + if (STREQ(priority, "1") || STREQ(priority, "debug")) + ret = virLogSetDefaultPriority(VIR_LOG_DEBUG); + else if (STREQ(priority, "2") || STREQ(priority, "info")) + ret = virLogSetDefaultPriority(VIR_LOG_INFO); + else if (STREQ(priority, "3") || STREQ(priority, "warning")) + ret = virLogSetDefaultPriority(VIR_LOG_WARN); + else if (STREQ(priority, "4") || STREQ(priority, "error")) + ret = virLogSetDefaultPriority(VIR_LOG_ERROR); + else + VIR_WARN("Ignoring invalid log level setting"); + + return ret; +} + + +/** + * virLogSetFromEnv: + * + * Sets virLogDefaultPriority, virLogFilters and virLogOutputs based on + * environment variables. + */ +void +virLogSetFromEnv(void) +{ + char *debugEnv; + + debugEnv = getenv("LIBVIRT_DEBUG"); + if (debugEnv && *debugEnv) + virLogParseDefaultPriority(debugEnv); + debugEnv = getenv("LIBVIRT_LOG_FILTERS"); + if (debugEnv && *debugEnv) + virLogParseFilters(debugEnv); + debugEnv = getenv("LIBVIRT_LOG_OUTPUTS"); + if (debugEnv && *debugEnv) + virLogParseOutputs(debugEnv); +} diff --git a/src/util/virlog.h b/src/util/virlog.h new file mode 100644 index 0000000..028b791 --- /dev/null +++ b/src/util/virlog.h @@ -0,0 +1,191 @@ +/* + * logging.h: internal logging and debugging + * + * Copyright (C) 2006-2008, 2011-2012 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + */ + +#ifndef __VIRTLOG_H_ +# define __VIRTLOG_H_ + +# include "internal.h" +# include "virbuffer.h" + +/* + * To be made public + */ +typedef enum { + VIR_LOG_DEBUG = 1, + VIR_LOG_INFO, + VIR_LOG_WARN, + VIR_LOG_ERROR, +} virLogPriority; + +# define VIR_LOG_DEFAULT VIR_LOG_WARN + +typedef enum { + VIR_LOG_TO_STDERR = 1, + VIR_LOG_TO_SYSLOG, + VIR_LOG_TO_FILE, + VIR_LOG_TO_JOURNALD, +} virLogDestination; + +typedef enum { + VIR_LOG_FROM_FILE, + VIR_LOG_FROM_ERROR, + VIR_LOG_FROM_AUDIT, + VIR_LOG_FROM_TRACE, + VIR_LOG_FROM_LIBRARY, + + VIR_LOG_FROM_LAST, +} virLogSource; + +/* + * If configured with --enable-debug=yes then library calls + * are printed to stderr for debugging or to an appropriate channel + * defined at runtime from the libvirt daemon configuration file + */ +# ifdef ENABLE_DEBUG +# define VIR_DEBUG_INT(src, filename, linenr, funcname, ...) \ + virLogMessage(src, VIR_LOG_DEBUG, filename, linenr, funcname, NULL, __VA_ARGS__) +# else +/** + * virLogEatParams: + * + * Do nothing but eat parameters. + */ +static inline void virLogEatParams(virLogSource unused, ...) +{ + /* Silence gcc */ + unused = unused; +} +# define VIR_DEBUG_INT(src, filename, linenr, funcname, ...) \ + virLogEatParams(src, filename, linenr, funcname, __VA_ARGS__) +# endif /* !ENABLE_DEBUG */ + +# define VIR_INFO_INT(src, filename, linenr, funcname, ...) \ + virLogMessage(src, VIR_LOG_INFO, filename, linenr, funcname, NULL, __VA_ARGS__) +# define VIR_WARN_INT(src, filename, linenr, funcname, ...) \ + virLogMessage(src, VIR_LOG_WARN, filename, linenr, funcname, NULL, __VA_ARGS__) +# define VIR_ERROR_INT(src, filename, linenr, funcname, ...) \ + virLogMessage(src, VIR_LOG_ERROR, filename, linenr, funcname, NULL, __VA_ARGS__) + +# define VIR_DEBUG(...) \ + VIR_DEBUG_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__) +# define VIR_INFO(...) \ + VIR_INFO_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__) +# define VIR_WARN(...) \ + VIR_WARN_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__) +# define VIR_ERROR(...) \ + VIR_ERROR_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__) + + +struct _virLogMetadata { + const char *key; + const char *s; /* String value, or NULL to use "i" */ + int i; +}; + +typedef struct _virLogMetadata virLogMetadata; +typedef struct _virLogMetadata *virLogMetadataPtr; + +/** + * virLogOutputFunc: + * @src: the src for the message + * @priority: the priority for the message + * @filename: file where the message was emitted + * @linenr: line where the message was emitted + * @funcname: the function emitting the message + * @timestamp: zero terminated string with timestamp of the message + * @metadata: NULL or metadata array, terminated by an item with NULL key + * @flags: flags associated with the message + * @rawstr: the unformatted message to log, zero terminated + * @str: the message to log, preformatted and zero terminated + * @data: extra output logging data + * + * Callback function used to output messages + */ +typedef void (*virLogOutputFunc) (virLogSource src, + virLogPriority priority, + const char *filename, + int linenr, + const char *funcname, + const char *timestamp, + virLogMetadataPtr metadata, + unsigned int flags, + const char *rawstr, + const char *str, + void *data); + +/** + * virLogCloseFunc: + * @data: extra output logging data + * + * Callback function used to close a log output + */ +typedef void (*virLogCloseFunc) (void *data); + +typedef enum { + VIR_LOG_STACK_TRACE = (1 << 0), +} virLogFlags; + +extern int virLogGetNbFilters(void); +extern int virLogGetNbOutputs(void); +extern char *virLogGetFilters(void); +extern char *virLogGetOutputs(void); +extern virLogPriority virLogGetDefaultPriority(void); +extern int virLogSetDefaultPriority(virLogPriority priority); +extern void virLogSetFromEnv(void); +extern int virLogDefineFilter(const char *match, + virLogPriority priority, + unsigned int flags); +extern int virLogDefineOutput(virLogOutputFunc f, + virLogCloseFunc c, + void *data, + virLogPriority priority, + virLogDestination dest, + const char *name, + unsigned int flags); + +/* + * Internal logging API + */ + +extern void virLogLock(void); +extern void virLogUnlock(void); +extern int virLogReset(void); +extern int virLogParseDefaultPriority(const char *priority); +extern int virLogParseFilters(const char *filters); +extern int virLogParseOutputs(const char *output); +extern void virLogMessage(virLogSource src, + virLogPriority priority, + const char *filename, + int linenr, + const char *funcname, + virLogMetadataPtr metadata, + const char *fmt, ...) ATTRIBUTE_FMT_PRINTF(7, 8); +extern void virLogVMessage(virLogSource src, + virLogPriority priority, + const char *filename, + int linenr, + const char *funcname, + virLogMetadataPtr metadata, + const char *fmt, + va_list vargs) ATTRIBUTE_FMT_PRINTF(7, 0); +extern int virLogSetBufferSize(int size); +extern void virLogEmergencyDumpAll(int signum); +#endif diff --git a/src/util/virnetdev.c b/src/util/virnetdev.c index e98a2ca..a1d1c12 100644 --- a/src/util/virnetdev.c +++ b/src/util/virnetdev.c @@ -29,7 +29,7 @@ #include "vircommand.h" #include "memory.h" #include "pci.h" -#include "logging.h" +#include "virlog.h" #include <sys/ioctl.h> #include <net/if.h> diff --git a/src/util/virnetdevmacvlan.c b/src/util/virnetdevmacvlan.c index 657c484..8d2574c 100644 --- a/src/util/virnetdevmacvlan.c +++ b/src/util/virnetdevmacvlan.c @@ -57,7 +57,7 @@ VIR_ENUM_IMPL(virNetDevMacVLanMode, VIR_NETDEV_MACVLAN_MODE_LAST, # endif # include "memory.h" -# include "logging.h" +# include "virlog.h" # include "uuid.h" # include "virfile.h" # include "virnetlink.h" diff --git a/src/util/virnetdevtap.c b/src/util/virnetdevtap.c index 0eadd6c..644e9a4 100644 --- a/src/util/virnetdevtap.c +++ b/src/util/virnetdevtap.c @@ -31,7 +31,7 @@ #include "virfile.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include <sys/ioctl.h> diff --git a/src/util/virnetdevveth.c b/src/util/virnetdevveth.c index 3261337..630b7c9 100644 --- a/src/util/virnetdevveth.c +++ b/src/util/virnetdevveth.c @@ -27,7 +27,7 @@ #include "virnetdevveth.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "vircommand.h" #include "virterror_internal.h" diff --git a/src/util/virnetdevvportprofile.c b/src/util/virnetdevvportprofile.c index ac7aa5f..834b9b9 100644 --- a/src/util/virnetdevvportprofile.c +++ b/src/util/virnetdevvportprofile.c @@ -53,7 +53,7 @@ VIR_ENUM_IMPL(virNetDevVPortProfileOp, VIR_NETDEV_VPORT_PROFILE_OP_LAST, # include "virnetlink.h" # include "virfile.h" -# include "logging.h" +# include "virlog.h" # include "virnetdev.h" # define MICROSEC_PER_SEC (1000 * 1000) diff --git a/src/util/virnetlink.c b/src/util/virnetlink.c index 8a8bfae..830e9b9 100644 --- a/src/util/virnetlink.c +++ b/src/util/virnetlink.c @@ -36,7 +36,7 @@ #include <sys/socket.h> #include "virnetlink.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "threads.h" #include "virmacaddr.h" diff --git a/src/util/virnodesuspend.c b/src/util/virnodesuspend.c index a34ca6a..e37a2d6 100644 --- a/src/util/virnodesuspend.c +++ b/src/util/virnodesuspend.c @@ -27,7 +27,7 @@ #include "datatypes.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/src/util/virobject.c b/src/util/virobject.c index 101507f..aa80cab 100644 --- a/src/util/virobject.c +++ b/src/util/virobject.c @@ -26,7 +26,7 @@ #include "memory.h" #include "viratomic.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/src/util/virpidfile.c b/src/util/virpidfile.c index 90a79c5..6ec9760 100644 --- a/src/util/virpidfile.c +++ b/src/util/virpidfile.c @@ -32,7 +32,7 @@ #include "memory.h" #include "util.h" #include "intprops.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "c-ctype.h" #include "areadlink.h" diff --git a/src/util/virprocess.c b/src/util/virprocess.c index f8a8a49..3c0ed8a 100644 --- a/src/util/virprocess.c +++ b/src/util/virprocess.c @@ -29,7 +29,7 @@ #include "virprocess.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/src/util/virrandom.c b/src/util/virrandom.c index 002f655..c24bf3b 100644 --- a/src/util/virrandom.c +++ b/src/util/virrandom.c @@ -31,7 +31,7 @@ #include "count-one-bits.h" #include "util.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/src/util/virterror.c b/src/util/virterror.c index 1142c40..6e3301b 100644 --- a/src/util/virterror.c +++ b/src/util/virterror.c @@ -29,7 +29,7 @@ #include "virterror_internal.h" #include "datatypes.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "threads.h" #include "util.h" diff --git a/src/util/virusb.c b/src/util/virusb.c index b9c81ed..ebc1af5 100644 --- a/src/util/virusb.c +++ b/src/util/virusb.c @@ -32,7 +32,7 @@ #include <unistd.h> #include "virusb.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" #include "util.h" #include "virterror_internal.h" diff --git a/src/vbox/vbox_MSCOMGlue.c b/src/vbox/vbox_MSCOMGlue.c index 9ddc89c..3194b7c 100644 --- a/src/vbox/vbox_MSCOMGlue.c +++ b/src/vbox/vbox_MSCOMGlue.c @@ -32,7 +32,7 @@ #include "internal.h" #include "memory.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "vbox_MSCOMGlue.h" diff --git a/src/vbox/vbox_XPCOMCGlue.c b/src/vbox/vbox_XPCOMCGlue.c index 63470ae..5f70283 100644 --- a/src/vbox/vbox_XPCOMCGlue.c +++ b/src/vbox/vbox_XPCOMCGlue.c @@ -39,7 +39,7 @@ #include "internal.h" #include "memory.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #define VIR_FROM_THIS VIR_FROM_VBOX diff --git a/src/vbox/vbox_driver.c b/src/vbox/vbox_driver.c index 56726ed..cd29e19 100644 --- a/src/vbox/vbox_driver.c +++ b/src/vbox/vbox_driver.c @@ -34,7 +34,7 @@ #include "internal.h" #include "datatypes.h" -#include "logging.h" +#include "virlog.h" #include "vbox_driver.h" #include "vbox_glue.h" #include "virterror_internal.h" diff --git a/src/vbox/vbox_tmpl.c b/src/vbox/vbox_tmpl.c index e0f9b6f..847af35 100644 --- a/src/vbox/vbox_tmpl.c +++ b/src/vbox/vbox_tmpl.c @@ -52,7 +52,7 @@ #include "uuid.h" #include "memory.h" #include "nodeinfo.h" -#include "logging.h" +#include "virlog.h" #include "vbox_driver.h" #include "configmake.h" #include "virfile.h" diff --git a/src/vmx/vmx.c b/src/vmx/vmx.c index 0d34453..e74e9ed 100644 --- a/src/vmx/vmx.c +++ b/src/vmx/vmx.c @@ -29,7 +29,7 @@ #include "virterror_internal.h" #include "virconf.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "vmx.h" #include "viruri.h" diff --git a/src/xen/xen_driver.c b/src/xen/xen_driver.c index d9174b6..c281c00 100644 --- a/src/xen/xen_driver.c +++ b/src/xen/xen_driver.c @@ -40,7 +40,7 @@ #include <xen/dom0_ops.h> #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "xen_driver.h" diff --git a/src/xen/xen_hypervisor.c b/src/xen/xen_hypervisor.c index 1aa2b73..b094313 100644 --- a/src/xen/xen_hypervisor.c +++ b/src/xen/xen_hypervisor.c @@ -64,7 +64,7 @@ #include <xen/sched.h> #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "driver.h" #include "util.h" diff --git a/src/xen/xen_inotify.c b/src/xen/xen_inotify.c index bcafdd0..073663f 100644 --- a/src/xen/xen_inotify.c +++ b/src/xen/xen_inotify.c @@ -36,7 +36,7 @@ #include "domain_conf.h" #include "xen_inotify.h" #include "xend_internal.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "virfile.h" diff --git a/src/xen/xend_internal.c b/src/xen/xend_internal.c index 9407e95..0364f84 100644 --- a/src/xen/xend_internal.c +++ b/src/xen/xend_internal.c @@ -30,7 +30,7 @@ #include <errno.h> #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "datatypes.h" #include "xend_internal.h" #include "driver.h" diff --git a/src/xen/xm_internal.c b/src/xen/xm_internal.c index 2cd4b95..fc7b581 100644 --- a/src/xen/xm_internal.c +++ b/src/xen/xm_internal.c @@ -47,7 +47,7 @@ #include "uuid.h" #include "util.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "count-one-bits.h" #define VIR_FROM_THIS VIR_FROM_XENXM diff --git a/src/xen/xs_internal.c b/src/xen/xs_internal.c index 8a0af62..4cc82d8 100644 --- a/src/xen/xs_internal.c +++ b/src/xen/xs_internal.c @@ -45,7 +45,7 @@ #include "datatypes.h" #include "driver.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "uuid.h" #include "xen_driver.h" #include "xs_internal.h" diff --git a/src/xenapi/xenapi_utils.c b/src/xenapi/xenapi_utils.c index dbdb22d..6f51100 100644 --- a/src/xenapi/xenapi_utils.c +++ b/src/xenapi/xenapi_utils.c @@ -33,7 +33,7 @@ #include "uuid.h" #include "memory.h" #include "virbuffer.h" -#include "logging.h" +#include "virlog.h" #include "viruri.h" #include "xenapi_driver_private.h" #include "xenapi_utils.h" diff --git a/src/xenxs/xen_sxpr.c b/src/xenxs/xen_sxpr.c index ed0c9e1..2aa384d 100644 --- a/src/xenxs/xen_sxpr.c +++ b/src/xenxs/xen_sxpr.c @@ -32,7 +32,7 @@ #include "memory.h" #include "verify.h" #include "uuid.h" -#include "logging.h" +#include "virlog.h" #include "count-one-bits.h" #include "xenxs_private.h" #include "xen_sxpr.h" diff --git a/tests/eventtest.c b/tests/eventtest.c index bc8d443..cd36a2d 100644 --- a/tests/eventtest.c +++ b/tests/eventtest.c @@ -29,7 +29,7 @@ #include "testutils.h" #include "internal.h" #include "threads.h" -#include "logging.h" +#include "virlog.h" #include "util.h" #include "vireventpoll.h" diff --git a/tests/libvirtdconftest.c b/tests/libvirtdconftest.c index c2b02a6..0365ade 100644 --- a/tests/libvirtdconftest.c +++ b/tests/libvirtdconftest.c @@ -27,7 +27,7 @@ #include "util.h" #include "c-ctype.h" #include "virterror_internal.h" -#include "logging.h" +#include "virlog.h" #include "virconf.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/tests/qemumonitortestutils.c b/tests/qemumonitortestutils.c index b55d867..e4194de 100644 --- a/tests/qemumonitortestutils.c +++ b/tests/qemumonitortestutils.c @@ -31,7 +31,7 @@ #include "rpc/virnetsocket.h" #include "memory.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/tests/securityselinuxtest.c b/tests/securityselinuxtest.c index 8bcf3a1..c021480 100644 --- a/tests/securityselinuxtest.c +++ b/tests/securityselinuxtest.c @@ -32,7 +32,7 @@ #include "testutils.h" #include "memory.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #include "virterror_internal.h" #include "security/security_manager.h" diff --git a/tests/sockettest.c b/tests/sockettest.c index 2f85307..c6a175f 100644 --- a/tests/sockettest.c +++ b/tests/sockettest.c @@ -27,7 +27,7 @@ #include "virsocketaddr.h" #include "testutils.h" -#include "logging.h" +#include "virlog.h" #include "memory.h" static void testQuietError(void *userData ATTRIBUTE_UNUSED, diff --git a/tests/testutils.c b/tests/testutils.c index 1315cb5..96e24d4 100644 --- a/tests/testutils.c +++ b/tests/testutils.c @@ -44,7 +44,7 @@ #include "threads.h" #include "virterror_internal.h" #include "virbuffer.h" -#include "logging.h" +#include "virlog.h" #include "vircommand.h" #include "virrandom.h" #include "dirname.h" diff --git a/tests/virauthconfigtest.c b/tests/virauthconfigtest.c index 4d37af6..74cc187 100644 --- a/tests/virauthconfigtest.c +++ b/tests/virauthconfigtest.c @@ -27,7 +27,7 @@ #include "util.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virauthconfig.h" diff --git a/tests/virdrivermoduletest.c b/tests/virdrivermoduletest.c index 53a772e..440ee8e 100644 --- a/tests/virdrivermoduletest.c +++ b/tests/virdrivermoduletest.c @@ -24,7 +24,7 @@ #include "util.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "driver.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/tests/virhashtest.c b/tests/virhashtest.c index 721e877..7de16d0 100644 --- a/tests/virhashtest.c +++ b/tests/virhashtest.c @@ -11,7 +11,7 @@ #include "testutils.h" #include "memory.h" #include "util.h" -#include "logging.h" +#include "virlog.h" #define testError(...) \ diff --git a/tests/virkeyfiletest.c b/tests/virkeyfiletest.c index 3667c8c..c6aca86 100644 --- a/tests/virkeyfiletest.c +++ b/tests/virkeyfiletest.c @@ -27,7 +27,7 @@ #include "util.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virkeyfile.h" diff --git a/tests/virlockspacetest.c b/tests/virlockspacetest.c index ee58f95..c95f5d8 100644 --- a/tests/virlockspacetest.c +++ b/tests/virlockspacetest.c @@ -28,7 +28,7 @@ #include "util.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virlockspace.h" diff --git a/tests/virnetmessagetest.c b/tests/virnetmessagetest.c index eff8ea7..c20f5e6 100644 --- a/tests/virnetmessagetest.c +++ b/tests/virnetmessagetest.c @@ -27,7 +27,7 @@ #include "util.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "rpc/virnetmessage.h" diff --git a/tests/virnetsockettest.c b/tests/virnetsockettest.c index e31f19a..ba281e9 100644 --- a/tests/virnetsockettest.c +++ b/tests/virnetsockettest.c @@ -31,7 +31,7 @@ #include "util.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "rpc/virnetsocket.h" diff --git a/tests/virnettlscontexttest.c b/tests/virnettlscontexttest.c index d421feb..0236659 100644 --- a/tests/virnettlscontexttest.c +++ b/tests/virnettlscontexttest.c @@ -30,7 +30,7 @@ #include "util.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virfile.h" #include "vircommand.h" #include "virsocketaddr.h" diff --git a/tests/virstringtest.c b/tests/virstringtest.c index 7e726c6..27e490f 100644 --- a/tests/virstringtest.c +++ b/tests/virstringtest.c @@ -26,7 +26,7 @@ #include "util.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virstring.h" diff --git a/tests/virtimetest.c b/tests/virtimetest.c index dca4efb..c8e9a2e 100644 --- a/tests/virtimetest.c +++ b/tests/virtimetest.c @@ -27,7 +27,7 @@ #include "util.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "virtime.h" diff --git a/tests/viruritest.c b/tests/viruritest.c index 430bcb6..46964b3 100644 --- a/tests/viruritest.c +++ b/tests/viruritest.c @@ -27,7 +27,7 @@ #include "util.h" #include "virterror_internal.h" #include "memory.h" -#include "logging.h" +#include "virlog.h" #include "viruri.h" diff --git a/tools/console.c b/tools/console.c index 40de8eb..dbdaab7 100644 --- a/tools/console.c +++ b/tools/console.c @@ -38,7 +38,7 @@ # include "internal.h" # include "console.h" -# include "logging.h" +# include "virlog.h" # include "util.h" # include "virfile.h" # include "memory.h" -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- po/POTFILES.in | 2 +- src/Makefile.am | 2 +- src/conf/node_device_conf.c | 2 +- src/network/bridge_driver.c | 2 +- src/node_device/node_device_hal.c | 2 +- src/node_device/node_device_udev.c | 2 +- src/qemu/qemu_conf.h | 2 +- src/qemu/qemu_driver.c | 2 +- src/qemu/qemu_hostdev.c | 2 +- src/qemu/qemu_hotplug.c | 2 +- src/security/security_apparmor.c | 2 +- src/security/security_dac.c | 2 +- src/security/security_selinux.c | 2 +- src/security/virt-aa-helper.c | 2 +- src/util/pci.c | 2285 ------------------------------------ src/util/pci.h | 136 --- src/util/virnetdev.c | 2 +- src/util/virnetdev.h | 2 +- src/util/virpci.c | 2285 ++++++++++++++++++++++++++++++++++++ src/util/virpci.h | 136 +++ src/xen/xen_driver.c | 2 +- 21 files changed, 2438 insertions(+), 2438 deletions(-) delete mode 100644 src/util/pci.c delete mode 100644 src/util/pci.h create mode 100644 src/util/virpci.c create mode 100644 src/util/virpci.h diff --git a/po/POTFILES.in b/po/POTFILES.in index a9dfcf4..18db09b 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -138,7 +138,6 @@ src/test/test_driver.c src/uml/uml_conf.c src/uml/uml_driver.c src/util/iohelper.c -src/util/pci.c src/util/processinfo.c src/util/sexpr.c src/util/stats_linux.c @@ -171,6 +170,7 @@ src/util/virnetdevtap.c src/util/virnetdevvportprofile.c src/util/virnetlink.c src/util/virnodesuspend.c +src/util/virpci.c src/util/virpidfile.c src/util/virprocess.c src/util/virrandom.c diff --git a/src/Makefile.am b/src/Makefile.am index 64f117d..d9f621f 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -53,7 +53,6 @@ augeastest_DATA = # These files are not related to driver APIs. Simply generic # helper APIs for various purposes UTIL_SOURCES = \ - util/pci.c util/pci.h \ util/processinfo.c util/processinfo.h \ util/sexpr.c util/sexpr.h \ util/stats_linux.c util/stats_linux.h \ @@ -85,6 +84,7 @@ UTIL_SOURCES = \ util/virjson.c util/virjson.h \ util/virlog.c util/virlog.h \ util/virobject.c util/virobject.h \ + util/virpci.c util/virpci.h \ util/virpidfile.c util/virpidfile.h \ util/virprocess.c util/virprocess.h \ util/virtypedparam.c util/virtypedparam.h \ diff --git a/src/conf/node_device_conf.c b/src/conf/node_device_conf.c index 85de50f..045f05d 100644 --- a/src/conf/node_device_conf.c +++ b/src/conf/node_device_conf.c @@ -36,7 +36,7 @@ #include "util.h" #include "virbuffer.h" #include "uuid.h" -#include "pci.h" +#include "virpci.h" #include "virrandom.h" #define VIR_FROM_THIS VIR_FROM_NODEDEV diff --git a/src/network/bridge_driver.c b/src/network/bridge_driver.c index 52b36a1..2db9197 100644 --- a/src/network/bridge_driver.c +++ b/src/network/bridge_driver.c @@ -61,7 +61,7 @@ #include "virdnsmasq.h" #include "configmake.h" #include "virnetdev.h" -#include "pci.h" +#include "virpci.h" #include "virnetdevbridge.h" #include "virnetdevtap.h" #include "virnetdevvportprofile.h" diff --git a/src/node_device/node_device_hal.c b/src/node_device/node_device_hal.c index 6f89f16..257a363 100644 --- a/src/node_device/node_device_hal.c +++ b/src/node_device/node_device_hal.c @@ -35,7 +35,7 @@ #include "datatypes.h" #include "viralloc.h" #include "uuid.h" -#include "pci.h" +#include "virpci.h" #include "virlog.h" #include "node_device_driver.h" #include "virdbus.h" diff --git a/src/node_device/node_device_udev.c b/src/node_device/node_device_udev.c index 81a11d7..7289a72 100644 --- a/src/node_device/node_device_udev.c +++ b/src/node_device/node_device_udev.c @@ -37,7 +37,7 @@ #include "uuid.h" #include "util.h" #include "virbuffer.h" -#include "pci.h" +#include "virpci.h" #define VIR_FROM_THIS VIR_FROM_NODEDEV diff --git a/src/qemu/qemu_conf.h b/src/qemu/qemu_conf.h index 283251a..f928c29 100644 --- a/src/qemu/qemu_conf.h +++ b/src/qemu/qemu_conf.h @@ -35,7 +35,7 @@ # include "threads.h" # include "security/security_manager.h" # include "vircgroup.h" -# include "pci.h" +# include "virpci.h" # include "virusb.h" # include "cpu_conf.h" # include "driver.h" diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c index 65254b6..14a5e44 100644 --- a/src/qemu/qemu_driver.c +++ b/src/qemu/qemu_driver.c @@ -72,7 +72,7 @@ #include "domain_conf.h" #include "domain_audit.h" #include "node_device_conf.h" -#include "pci.h" +#include "virpci.h" #include "virusb.h" #include "processinfo.h" #include "libvirt_internal.h" diff --git a/src/qemu/qemu_hostdev.c b/src/qemu/qemu_hostdev.c index 754f8d0..5c23ccb 100644 --- a/src/qemu/qemu_hostdev.c +++ b/src/qemu/qemu_hostdev.c @@ -27,7 +27,7 @@ #include "virlog.h" #include "virterror_internal.h" #include "viralloc.h" -#include "pci.h" +#include "virpci.h" #include "virusb.h" #include "virnetdev.h" diff --git a/src/qemu/qemu_hotplug.c b/src/qemu/qemu_hotplug.c index c432a32..e120988 100644 --- a/src/qemu/qemu_hotplug.c +++ b/src/qemu/qemu_hotplug.c @@ -36,7 +36,7 @@ #include "datatypes.h" #include "virterror_internal.h" #include "viralloc.h" -#include "pci.h" +#include "virpci.h" #include "virfile.h" #include "qemu_cgroup.h" #include "locking/domain_lock.h" diff --git a/src/security/security_apparmor.c b/src/security/security_apparmor.c index b65384e..d28189f 100644 --- a/src/security/security_apparmor.c +++ b/src/security/security_apparmor.c @@ -43,7 +43,7 @@ #include "virterror_internal.h" #include "datatypes.h" #include "uuid.h" -#include "pci.h" +#include "virpci.h" #include "virusb.h" #include "virfile.h" #include "configmake.h" diff --git a/src/security/security_dac.c b/src/security/security_dac.c index bdb29c7..e4f016a 100644 --- a/src/security/security_dac.c +++ b/src/security/security_dac.c @@ -28,7 +28,7 @@ #include "util.h" #include "viralloc.h" #include "virlog.h" -#include "pci.h" +#include "virpci.h" #include "virusb.h" #include "storage_file.h" diff --git a/src/security/security_selinux.c b/src/security/security_selinux.c index 3a1548d..2adf5c9 100644 --- a/src/security/security_selinux.c +++ b/src/security/security_selinux.c @@ -37,7 +37,7 @@ #include "util.h" #include "viralloc.h" #include "virlog.h" -#include "pci.h" +#include "virpci.h" #include "virusb.h" #include "storage_file.h" #include "virfile.h" diff --git a/src/security/virt-aa-helper.c b/src/security/virt-aa-helper.c index c9c222a..4945f7c 100644 --- a/src/security/virt-aa-helper.c +++ b/src/security/virt-aa-helper.c @@ -51,7 +51,7 @@ #include "xml.h" #include "uuid.h" #include "virusb.h" -#include "pci.h" +#include "virpci.h" #include "virfile.h" #include "configmake.h" #include "virrandom.h" diff --git a/src/util/pci.c b/src/util/pci.c deleted file mode 100644 index e4009fa..0000000 --- a/src/util/pci.c +++ /dev/null @@ -1,2285 +0,0 @@ -/* - * Copyright (C) 2009-2012 Red Hat, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Authors: - * Mark McLoughlin <markmc(a)redhat.com&gt; - */ - -#include <config.h> - -#include "pci.h" - -#include <dirent.h> -#include <fcntl.h> -#include <inttypes.h> -#include <limits.h> -#include <stdio.h> -#include <string.h> -#include <sys/types.h> -#include <sys/stat.h> -#include <unistd.h> -#include <stdlib.h> - -#include "virlog.h" -#include "viralloc.h" -#include "vircommand.h" -#include "virterror_internal.h" -#include "virfile.h" - -#define PCI_SYSFS "/sys/bus/pci/" -#define PCI_ID_LEN 10 /* "XXXX XXXX" */ -#define PCI_ADDR_LEN 13 /* "XXXX:XX:XX.X" */ - -#define SRIOV_FOUND 0 -#define SRIOV_NOT_FOUND 1 -#define SRIOV_ERROR -1 - -struct _pciDevice { - unsigned domain; - unsigned bus; - unsigned slot; - unsigned function; - - char name[PCI_ADDR_LEN]; /* domain:bus:slot.function */ - char id[PCI_ID_LEN]; /* product vendor */ - char *path; - const char *used_by; /* The domain which uses the device */ - - unsigned pcie_cap_pos; - unsigned pci_pm_cap_pos; - unsigned has_flr : 1; - unsigned has_pm_reset : 1; - unsigned managed : 1; - - /* used by reattach function */ - unsigned unbind_from_stub : 1; - unsigned remove_slot : 1; - unsigned reprobe : 1; -}; - -struct _pciDeviceList { - unsigned count; - pciDevice **devs; -}; - - -/* For virReportOOMError() and virReportSystemError() */ -#define VIR_FROM_THIS VIR_FROM_NONE - -/* Specifications referenced in comments: - * PCI30 - PCI Local Bus Specification 3.0 - * PCIe20 - PCI Express Base Specification 2.0 - * BR12 - PCI-to-PCI Bridge Architecture Specification 1.2 - * PM12 - PCI Bus Power Management Interface Specification 1.2 - * ECN_AF - Advanced Capabilities for Conventional PCI ECN - */ - -/* Type 0 config space header length; PCI30 Section 6.1 Configuration Space Organization */ -#define PCI_CONF_LEN 0x100 -#define PCI_CONF_HEADER_LEN 0x40 - -/* PCI30 6.2.1 */ -#define PCI_HEADER_TYPE 0x0e /* Header type */ -#define PCI_HEADER_TYPE_BRIDGE 0x1 -#define PCI_HEADER_TYPE_MASK 0x7f -#define PCI_HEADER_TYPE_MULTI 0x80 - -/* PCI30 6.2.1 Device Identification */ -#define PCI_CLASS_DEVICE 0x0a /* Device class */ - -/* Class Code for bridge; PCI30 D.7 Base Class 06h */ -#define PCI_CLASS_BRIDGE_PCI 0x0604 - -/* PCI30 6.2.3 Device Status */ -#define PCI_STATUS 0x06 /* 16 bits */ -#define PCI_STATUS_CAP_LIST 0x10 /* Support Capability List */ - -/* PCI30 6.7 Capabilities List */ -#define PCI_CAPABILITY_LIST 0x34 /* Offset of first capability list entry */ - -/* PM12 3.2.1 Capability Identifier */ -#define PCI_CAP_ID_PM 0x01 /* Power Management */ -/* PCI30 H Capability IDs */ -#define PCI_CAP_ID_EXP 0x10 /* PCI Express */ -/* ECN_AF 6.x.1.1 Capability ID for AF */ -#define PCI_CAP_ID_AF 0x13 /* Advanced Features */ - -/* PCIe20 7.8.3 Device Capabilities Register (Offset 04h) */ -#define PCI_EXP_DEVCAP 0x4 /* Device capabilities */ -#define PCI_EXP_DEVCAP_FLR (1<<28) /* Function Level Reset */ - -/* Header type 1 BR12 3.2 PCI-to-PCI Bridge Configuration Space Header Format */ -#define PCI_PRIMARY_BUS 0x18 /* BR12 3.2.5.2 Primary bus number */ -#define PCI_SECONDARY_BUS 0x19 /* BR12 3.2.5.3 Secondary bus number */ -#define PCI_SUBORDINATE_BUS 0x1a /* BR12 3.2.5.4 Highest bus number behind the bridge */ -#define PCI_BRIDGE_CONTROL 0x3e -/* BR12 3.2.5.18 Bridge Control Register */ -#define PCI_BRIDGE_CTL_RESET 0x40 /* Secondary bus reset */ - -/* PM12 3.2.4 Power Management Control/Status (Offset = 4) */ -#define PCI_PM_CTRL 4 /* PM control and status register */ -#define PCI_PM_CTRL_STATE_MASK 0x3 /* Current power state (D0 to D3) */ -#define PCI_PM_CTRL_STATE_D0 0x0 /* D0 state */ -#define PCI_PM_CTRL_STATE_D3hot 0x3 /* D3 state */ -#define PCI_PM_CTRL_NO_SOFT_RESET 0x8 /* No reset for D3hot->D0 */ - -/* ECN_AF 6.x.1 Advanced Features Capability Structure */ -#define PCI_AF_CAP 0x3 /* Advanced features capabilities */ -#define PCI_AF_CAP_FLR 0x2 /* Function Level Reset */ - -#define PCI_EXP_FLAGS 0x2 -#define PCI_EXP_FLAGS_TYPE 0x00f0 -#define PCI_EXP_TYPE_DOWNSTREAM 0x6 - -#define PCI_EXT_CAP_BASE 0x100 -#define PCI_EXT_CAP_LIMIT 0x1000 -#define PCI_EXT_CAP_ID_MASK 0x0000ffff -#define PCI_EXT_CAP_OFFSET_SHIFT 20 -#define PCI_EXT_CAP_OFFSET_MASK 0x00000ffc - -#define PCI_EXT_CAP_ID_ACS 0x000d -#define PCI_EXT_ACS_CTRL 0x06 - -#define PCI_EXT_CAP_ACS_SV 0x01 -#define PCI_EXT_CAP_ACS_RR 0x04 -#define PCI_EXT_CAP_ACS_CR 0x08 -#define PCI_EXT_CAP_ACS_UF 0x10 -#define PCI_EXT_CAP_ACS_ENABLED (PCI_EXT_CAP_ACS_SV | \ - PCI_EXT_CAP_ACS_RR | \ - PCI_EXT_CAP_ACS_CR | \ - PCI_EXT_CAP_ACS_UF) - -static int -pciConfigOpen(pciDevice *dev, bool fatal) -{ - int fd; - - fd = open(dev->path, O_RDWR); - - if (fd < 0) { - if (fatal) { - virReportSystemError(errno, - _("Failed to open config space file '%s'"), - dev->path); - } else { - char ebuf[1024]; - VIR_WARN("Failed to open config space file '%s': %s", - dev->path, virStrerror(errno, ebuf, sizeof(ebuf))); - } - return -1; - } - - VIR_DEBUG("%s %s: opened %s", dev->id, dev->name, dev->path); - return fd; -} - -static void -pciConfigClose(pciDevice *dev, int cfgfd) -{ - if (VIR_CLOSE(cfgfd) < 0) { - char ebuf[1024]; - VIR_WARN("Failed to close config space file '%s': %s", - dev->path, virStrerror(errno, ebuf, sizeof(ebuf))); - } -} - - -static int -pciRead(pciDevice *dev, - int cfgfd, - unsigned pos, - uint8_t *buf, - unsigned buflen) -{ - memset(buf, 0, buflen); - - if (lseek(cfgfd, pos, SEEK_SET) != pos || - saferead(cfgfd, buf, buflen) != buflen) { - char ebuf[1024]; - VIR_WARN("Failed to read from '%s' : %s", dev->path, - virStrerror(errno, ebuf, sizeof(ebuf))); - return -1; - } - return 0; -} - -static uint8_t -pciRead8(pciDevice *dev, int cfgfd, unsigned pos) -{ - uint8_t buf; - pciRead(dev, cfgfd, pos, &buf, sizeof(buf)); - return buf; -} - -static uint16_t -pciRead16(pciDevice *dev, int cfgfd, unsigned pos) -{ - uint8_t buf[2]; - pciRead(dev, cfgfd, pos, &buf[0], sizeof(buf)); - return (buf[0] << 0) | (buf[1] << 8); -} - -static uint32_t -pciRead32(pciDevice *dev, int cfgfd, unsigned pos) -{ - uint8_t buf[4]; - pciRead(dev, cfgfd, pos, &buf[0], sizeof(buf)); - return (buf[0] << 0) | (buf[1] << 8) | (buf[2] << 16) | (buf[3] << 24); -} - -static int -pciWrite(pciDevice *dev, - int cfgfd, - unsigned pos, - uint8_t *buf, - unsigned buflen) -{ - if (lseek(cfgfd, pos, SEEK_SET) != pos || - safewrite(cfgfd, buf, buflen) != buflen) { - char ebuf[1024]; - VIR_WARN("Failed to write to '%s' : %s", dev->path, - virStrerror(errno, ebuf, sizeof(ebuf))); - return -1; - } - return 0; -} - -static void -pciWrite16(pciDevice *dev, int cfgfd, unsigned pos, uint16_t val) -{ - uint8_t buf[2] = { (val >> 0), (val >> 8) }; - pciWrite(dev, cfgfd, pos, &buf[0], sizeof(buf)); -} - -static void -pciWrite32(pciDevice *dev, int cfgfd, unsigned pos, uint32_t val) -{ - uint8_t buf[4] = { (val >> 0), (val >> 8), (val >> 16), (val >> 24) }; - pciWrite(dev, cfgfd, pos, &buf[0], sizeof(buf)); -} - -typedef int (*pciIterPredicate)(pciDevice *, pciDevice *, void *); - -/* Iterate over available PCI devices calling @predicate - * to compare each one to @dev. - * Return -1 on error since we don't want to assume it is - * safe to reset if there is an error. - */ -static int -pciIterDevices(pciIterPredicate predicate, - pciDevice *dev, - pciDevice **matched, - void *data) -{ - DIR *dir; - struct dirent *entry; - int ret = 0; - int rc; - - *matched = NULL; - - VIR_DEBUG("%s %s: iterating over " PCI_SYSFS "devices", dev->id, dev->name); - - dir = opendir(PCI_SYSFS "devices"); - if (!dir) { - VIR_WARN("Failed to open " PCI_SYSFS "devices"); - return -1; - } - - while ((entry = readdir(dir))) { - unsigned int domain, bus, slot, function; - pciDevice *check; - char *tmp; - - /* Ignore '.' and '..' */ - if (entry->d_name[0] == '.') - continue; - - /* expected format: <domain>:<bus>:<slot>.<function> */ - if (/* domain */ - virStrToLong_ui(entry->d_name, &tmp, 16, &domain) < 0 || *tmp != ':' || - /* bus */ - virStrToLong_ui(tmp + 1, &tmp, 16, &bus) < 0 || *tmp != ':' || - /* slot */ - virStrToLong_ui(tmp + 1, &tmp, 16, &slot) < 0 || *tmp != '.' || - /* function */ - virStrToLong_ui(tmp + 1, NULL, 16, &function) < 0) { - VIR_WARN("Unusual entry in " PCI_SYSFS "devices: %s", entry->d_name); - continue; - } - - check = pciGetDevice(domain, bus, slot, function); - if (!check) { - ret = -1; - break; - } - - rc = predicate(dev, check, data); - if (rc < 0) { - /* the predicate returned an error, bail */ - pciFreeDevice(check); - ret = -1; - break; - } - else if (rc == 1) { - VIR_DEBUG("%s %s: iter matched on %s", dev->id, dev->name, check->name); - *matched = check; - ret = 1; - break; - } - - pciFreeDevice(check); - } - closedir(dir); - return ret; -} - -static uint8_t -pciFindCapabilityOffset(pciDevice *dev, int cfgfd, unsigned capability) -{ - uint16_t status; - uint8_t pos; - - status = pciRead16(dev, cfgfd, PCI_STATUS); - if (!(status & PCI_STATUS_CAP_LIST)) - return 0; - - pos = pciRead8(dev, cfgfd, PCI_CAPABILITY_LIST); - - /* Zero indicates last capability, capabilities can't - * be in the config space header and 0xff is returned - * by the kernel if we don't have access to this region - * - * Note: we're not handling loops or extended - * capabilities here. - */ - while (pos >= PCI_CONF_HEADER_LEN && pos != 0xff) { - uint8_t capid = pciRead8(dev, cfgfd, pos); - if (capid == capability) { - VIR_DEBUG("%s %s: found cap 0x%.2x at 0x%.2x", - dev->id, dev->name, capability, pos); - return pos; - } - - pos = pciRead8(dev, cfgfd, pos + 1); - } - - VIR_DEBUG("%s %s: failed to find cap 0x%.2x", dev->id, dev->name, capability); - - return 0; -} - -static unsigned int -pciFindExtendedCapabilityOffset(pciDevice *dev, - int cfgfd, - unsigned capability) -{ - int ttl; - unsigned int pos; - uint32_t header; - - /* minimum 8 bytes per capability */ - ttl = (PCI_EXT_CAP_LIMIT - PCI_EXT_CAP_BASE) / 8; - pos = PCI_EXT_CAP_BASE; - - while (ttl > 0 && pos >= PCI_EXT_CAP_BASE) { - header = pciRead32(dev, cfgfd, pos); - - if ((header & PCI_EXT_CAP_ID_MASK) == capability) - return pos; - - pos = (header >> PCI_EXT_CAP_OFFSET_SHIFT) & PCI_EXT_CAP_OFFSET_MASK; - ttl--; - } - - return 0; -} - -/* detects whether this device has FLR. Returns 0 if the device does - * not have FLR, 1 if it does, and -1 on error - */ -static int -pciDetectFunctionLevelReset(pciDevice *dev, int cfgfd) -{ - uint32_t caps; - uint8_t pos; - char *path; - int found; - - /* The PCIe Function Level Reset capability allows - * individual device functions to be reset without - * affecting any other functions on the device or - * any other devices on the bus. This is only common - * on SR-IOV NICs at the moment. - */ - if (dev->pcie_cap_pos) { - caps = pciRead32(dev, cfgfd, dev->pcie_cap_pos + PCI_EXP_DEVCAP); - if (caps & PCI_EXP_DEVCAP_FLR) { - VIR_DEBUG("%s %s: detected PCIe FLR capability", dev->id, dev->name); - return 1; - } - } - - /* The PCI AF Function Level Reset capability is - * the same thing, except for conventional PCI - * devices. This is not common yet. - */ - pos = pciFindCapabilityOffset(dev, cfgfd, PCI_CAP_ID_AF); - if (pos) { - caps = pciRead16(dev, cfgfd, pos + PCI_AF_CAP); - if (caps & PCI_AF_CAP_FLR) { - VIR_DEBUG("%s %s: detected PCI FLR capability", dev->id, dev->name); - return 1; - } - } - - /* there are some buggy devices that do support FLR, but forget to - * advertise that fact in their capabilities. However, FLR is *required* - * to be present for virtual functions (VFs), so if we see that this - * device is a VF, we just assume FLR works - */ - - if (virAsprintf(&path, PCI_SYSFS "devices/%s/physfn", dev->name) < 0) { - virReportOOMError(); - return -1; - } - - found = virFileExists(path); - VIR_FREE(path); - if (found) { - VIR_DEBUG("%s %s: buggy device didn't advertise FLR, but is a VF; forcing flr on", - dev->id, dev->name); - return 1; - } - - VIR_DEBUG("%s %s: no FLR capability found", dev->id, dev->name); - - return 0; -} - -/* Require the device has the PCI Power Management capability - * and that a D3hot->D0 transition will results in a full - * internal reset, not just a soft reset. - */ -static unsigned -pciDetectPowerManagementReset(pciDevice *dev, int cfgfd) -{ - if (dev->pci_pm_cap_pos) { - uint32_t ctl; - - /* require the NO_SOFT_RESET bit is clear */ - ctl = pciRead32(dev, cfgfd, dev->pci_pm_cap_pos + PCI_PM_CTRL); - if (!(ctl & PCI_PM_CTRL_NO_SOFT_RESET)) { - VIR_DEBUG("%s %s: detected PM reset capability", dev->id, dev->name); - return 1; - } - } - - VIR_DEBUG("%s %s: no PM reset capability found", dev->id, dev->name); - - return 0; -} - -/* Any active devices on the same domain/bus ? */ -static int -pciSharesBusWithActive(pciDevice *dev, pciDevice *check, void *data) -{ - pciDeviceList *inactiveDevs = data; - - /* Different domain, different bus, or simply identical device */ - if (dev->domain != check->domain || - dev->bus != check->bus || - (dev->slot == check->slot && - dev->function == check->function)) - return 0; - - /* same bus, but inactive, i.e. about to be assigned to guest */ - if (inactiveDevs && pciDeviceListFind(inactiveDevs, check)) - return 0; - - return 1; -} - -static pciDevice * -pciBusContainsActiveDevices(pciDevice *dev, - pciDeviceList *inactiveDevs) -{ - pciDevice *active = NULL; - if (pciIterDevices(pciSharesBusWithActive, - dev, &active, inactiveDevs) < 0) - return NULL; - return active; -} - -/* Is @check the parent of @dev ? */ -static int -pciIsParent(pciDevice *dev, pciDevice *check, void *data) -{ - uint16_t device_class; - uint8_t header_type, secondary, subordinate; - pciDevice **best = data; - int ret = 0; - int fd; - - if (dev->domain != check->domain) - return 0; - - if ((fd = pciConfigOpen(check, false)) < 0) - return 0; - - /* Is it a bridge? */ - device_class = pciRead16(check, fd, PCI_CLASS_DEVICE); - if (device_class != PCI_CLASS_BRIDGE_PCI) - goto cleanup; - - /* Is it a plane? */ - header_type = pciRead8(check, fd, PCI_HEADER_TYPE); - if ((header_type & PCI_HEADER_TYPE_MASK) != PCI_HEADER_TYPE_BRIDGE) - goto cleanup; - - secondary = pciRead8(check, fd, PCI_SECONDARY_BUS); - subordinate = pciRead8(check, fd, PCI_SUBORDINATE_BUS); - - VIR_DEBUG("%s %s: found parent device %s", dev->id, dev->name, check->name); - - /* if the secondary bus exactly equals the device's bus, then we found - * the direct parent. No further work is necessary - */ - if (dev->bus == secondary) { - ret = 1; - goto cleanup; - } - - /* otherwise, SRIOV allows VFs to be on different busses then their PFs. - * In this case, what we need to do is look for the "best" match; i.e. - * the most restrictive match that still satisfies all of the conditions. - */ - if (dev->bus > secondary && dev->bus <= subordinate) { - if (*best == NULL) { - *best = pciGetDevice(check->domain, check->bus, check->slot, - check->function); - if (*best == NULL) { - ret = -1; - goto cleanup; - } - } else { - /* OK, we had already recorded a previous "best" match for the - * parent. See if the current device is more restrictive than the - * best, and if so, make it the new best - */ - int bestfd; - uint8_t best_secondary; - - if ((bestfd = pciConfigOpen(*best, false)) < 0) - goto cleanup; - best_secondary = pciRead8(*best, bestfd, PCI_SECONDARY_BUS); - pciConfigClose(*best, bestfd); - - if (secondary > best_secondary) { - pciFreeDevice(*best); - *best = pciGetDevice(check->domain, check->bus, check->slot, - check->function); - if (*best == NULL) { - ret = -1; - goto cleanup; - } - } - } - } - -cleanup: - pciConfigClose(check, fd); - return ret; -} - -static int -pciGetParentDevice(pciDevice *dev, pciDevice **parent) -{ - pciDevice *best = NULL; - int ret; - - *parent = NULL; - ret = pciIterDevices(pciIsParent, dev, parent, &best); - if (ret == 1) - pciFreeDevice(best); - else if (ret == 0) - *parent = best; - return ret; -} - -/* Secondary Bus Reset is our sledgehammer - it resets all - * devices behind a bus. - */ -static int -pciTrySecondaryBusReset(pciDevice *dev, - int cfgfd, - pciDeviceList *inactiveDevs) -{ - pciDevice *parent, *conflict; - uint8_t config_space[PCI_CONF_LEN]; - uint16_t ctl; - int ret = -1; - int parentfd; - - /* Refuse to do a secondary bus reset if there are other - * devices/functions behind the bus are used by the host - * or other guests. - */ - if ((conflict = pciBusContainsActiveDevices(dev, inactiveDevs))) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Active %s devices on bus with %s, not doing bus reset"), - conflict->name, dev->name); - return -1; - } - - /* Find the parent bus */ - if (pciGetParentDevice(dev, &parent) < 0) - return -1; - if (!parent) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to find parent device for %s"), - dev->name); - return -1; - } - if ((parentfd = pciConfigOpen(parent, true)) < 0) - goto out; - - VIR_DEBUG("%s %s: doing a secondary bus reset", dev->id, dev->name); - - /* Save and restore the device's config space; we only do this - * for the supplied device since we refuse to do a reset if there - * are multiple devices/functions - */ - if (pciRead(dev, cfgfd, 0, config_space, PCI_CONF_LEN) < 0) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to read PCI config space for %s"), - dev->name); - goto out; - } - - /* Read the control register, set the reset flag, wait 200ms, - * unset the reset flag and wait 200ms. - */ - ctl = pciRead16(dev, cfgfd, PCI_BRIDGE_CONTROL); - - pciWrite16(parent, parentfd, PCI_BRIDGE_CONTROL, - ctl | PCI_BRIDGE_CTL_RESET); - - usleep(200 * 1000); /* sleep 200ms */ - - pciWrite16(parent, parentfd, PCI_BRIDGE_CONTROL, ctl); - - usleep(200 * 1000); /* sleep 200ms */ - - if (pciWrite(dev, cfgfd, 0, config_space, PCI_CONF_LEN) < 0) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to restore PCI config space for %s"), - dev->name); - goto out; - } - ret = 0; - -out: - pciConfigClose(parent, parentfd); - pciFreeDevice(parent); - return ret; -} - -/* Power management reset attempts to reset a device using a - * D-state transition from D3hot to D0. Note, in detect_pm_reset() - * above we require the device supports a full internal reset. - */ -static int -pciTryPowerManagementReset(pciDevice *dev, int cfgfd) -{ - uint8_t config_space[PCI_CONF_LEN]; - uint32_t ctl; - - if (!dev->pci_pm_cap_pos) - return -1; - - /* Save and restore the device's config space. */ - if (pciRead(dev, cfgfd, 0, &config_space[0], PCI_CONF_LEN) < 0) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to read PCI config space for %s"), - dev->name); - return -1; - } - - VIR_DEBUG("%s %s: doing a power management reset", dev->id, dev->name); - - ctl = pciRead32(dev, cfgfd, dev->pci_pm_cap_pos + PCI_PM_CTRL); - ctl &= ~PCI_PM_CTRL_STATE_MASK; - - pciWrite32(dev, cfgfd, dev->pci_pm_cap_pos + PCI_PM_CTRL, - ctl | PCI_PM_CTRL_STATE_D3hot); - - usleep(10 * 1000); /* sleep 10ms */ - - pciWrite32(dev, cfgfd, dev->pci_pm_cap_pos + PCI_PM_CTRL, - ctl | PCI_PM_CTRL_STATE_D0); - - usleep(10 * 1000); /* sleep 10ms */ - - if (pciWrite(dev, cfgfd, 0, &config_space[0], PCI_CONF_LEN) < 0) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to restore PCI config space for %s"), - dev->name); - return -1; - } - - return 0; -} - -static int -pciInitDevice(pciDevice *dev, int cfgfd) -{ - int flr; - - dev->pcie_cap_pos = pciFindCapabilityOffset(dev, cfgfd, PCI_CAP_ID_EXP); - dev->pci_pm_cap_pos = pciFindCapabilityOffset(dev, cfgfd, PCI_CAP_ID_PM); - flr = pciDetectFunctionLevelReset(dev, cfgfd); - if (flr < 0) - return flr; - dev->has_flr = flr; - dev->has_pm_reset = pciDetectPowerManagementReset(dev, cfgfd); - - return 0; -} - -int -pciResetDevice(pciDevice *dev, - pciDeviceList *activeDevs, - pciDeviceList *inactiveDevs) -{ - int ret = -1; - int fd; - - if (activeDevs && pciDeviceListFind(activeDevs, dev)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Not resetting active device %s"), dev->name); - return -1; - } - - if ((fd = pciConfigOpen(dev, true)) < 0) - return -1; - - if (pciInitDevice(dev, fd) < 0) - goto cleanup; - - /* KVM will perform FLR when starting and stopping - * a guest, so there is no need for us to do it here. - */ - if (dev->has_flr) { - ret = 0; - goto cleanup; - } - - /* If the device supports PCI power management reset, - * that's the next best thing because it only resets - * the function, not the whole device. - */ - if (dev->has_pm_reset) - ret = pciTryPowerManagementReset(dev, fd); - - /* Bus reset is not an option with the root bus */ - if (ret < 0 && dev->bus != 0) - ret = pciTrySecondaryBusReset(dev, fd, inactiveDevs); - - if (ret < 0) { - virErrorPtr err = virGetLastError(); - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Unable to reset PCI device %s: %s"), - dev->name, - err ? err->message : _("no FLR, PM reset or bus reset available")); - } - -cleanup: - pciConfigClose(dev, fd); - return ret; -} - - -static int -pciDriverDir(char **buffer, const char *driver) -{ - VIR_FREE(*buffer); - - if (virAsprintf(buffer, PCI_SYSFS "drivers/%s", driver) < 0) { - virReportOOMError(); - return -1; - } - - return 0; -} - -static int -pciDriverFile(char **buffer, const char *driver, const char *file) -{ - VIR_FREE(*buffer); - - if (virAsprintf(buffer, PCI_SYSFS "drivers/%s/%s", driver, file) < 0) { - virReportOOMError(); - return -1; - } - - return 0; -} - -static int -pciDeviceFile(char **buffer, const char *device, const char *file) -{ - VIR_FREE(*buffer); - - if (virAsprintf(buffer, PCI_SYSFS "devices/%s/%s", device, file) < 0) { - virReportOOMError(); - return -1; - } - - return 0; -} - - -static const char * -pciFindStubDriver(void) -{ - char *drvpath = NULL; - int probed = 0; - -recheck: - if (pciDriverDir(&drvpath, "pci-stub") < 0) { - return NULL; - } - - if (virFileExists(drvpath)) { - VIR_FREE(drvpath); - return "pci-stub"; - } - - if (pciDriverDir(&drvpath, "pciback") < 0) { - return NULL; - } - - if (virFileExists(drvpath)) { - VIR_FREE(drvpath); - return "pciback"; - } - - VIR_FREE(drvpath); - - if (!probed) { - const char *const stubprobe[] = { MODPROBE, "pci-stub", NULL }; - const char *const backprobe[] = { MODPROBE, "pciback", NULL }; - - probed = 1; - /* - * Probing for pci-stub will succeed regardless of whether - * on native or Xen kernels. - * On Xen though, we want to prefer pciback, so probe - * for that first, because that will only work on Xen - */ - if (virRun(backprobe, NULL) < 0 && - virRun(stubprobe, NULL) < 0) { - char ebuf[1024]; - VIR_WARN("failed to load pci-stub or pciback drivers: %s", - virStrerror(errno, ebuf, sizeof(ebuf))); - return NULL; - } - - goto recheck; - } - - return NULL; -} - -static int -pciUnbindDeviceFromStub(pciDevice *dev, const char *driver) -{ - int result = -1; - char *drvdir = NULL; - char *path = NULL; - - if (pciDriverDir(&drvdir, driver) < 0) - goto cleanup; - - if (!dev->unbind_from_stub) - goto remove_slot; - - /* If the device is bound to stub, unbind it. - */ - if (pciDeviceFile(&path, dev->name, "driver") < 0) - goto cleanup; - - if (virFileExists(drvdir) && virFileLinkPointsTo(path, drvdir)) { - if (pciDriverFile(&path, driver, "unbind") < 0) { - goto cleanup; - } - - if (virFileWriteStr(path, dev->name, 0) < 0) { - virReportSystemError(errno, - _("Failed to unbind PCI device '%s' from %s"), - dev->name, driver); - goto cleanup; - } - } - dev->unbind_from_stub = 0; - -remove_slot: - if (!dev->remove_slot) - goto reprobe; - - /* Xen's pciback.ko wants you to use remove_slot on the specific device */ - if (pciDriverFile(&path, driver, "remove_slot") < 0) { - goto cleanup; - } - - if (virFileExists(path) && virFileWriteStr(path, dev->name, 0) < 0) { - virReportSystemError(errno, - _("Failed to remove slot for PCI device '%s' from %s"), - dev->name, driver); - goto cleanup; - } - dev->remove_slot = 0; - -reprobe: - if (!dev->reprobe) { - result = 0; - goto cleanup; - } - - /* Trigger a re-probe of the device is not in the stub's dynamic - * ID table. If the stub is available, but 'remove_id' isn't - * available, then re-probing would just cause the device to be - * re-bound to the stub. - */ - if (pciDriverFile(&path, driver, "remove_id") < 0) { - goto cleanup; - } - - if (!virFileExists(drvdir) || virFileExists(path)) { - if (virFileWriteStr(PCI_SYSFS "drivers_probe", dev->name, 0) < 0) { - virReportSystemError(errno, - _("Failed to trigger a re-probe for PCI device '%s'"), - dev->name); - goto cleanup; - } - } - - result = 0; - -cleanup: - /* do not do it again */ - dev->unbind_from_stub = 0; - dev->remove_slot = 0; - dev->reprobe = 0; - - VIR_FREE(drvdir); - VIR_FREE(path); - - return result; -} - - -static int -pciBindDeviceToStub(pciDevice *dev, const char *driver) -{ - int result = -1; - char *drvdir = NULL; - char *path = NULL; - int reprobe = 0; - - /* check whether the device is already bound to a driver */ - if (pciDriverDir(&drvdir, driver) < 0 || - pciDeviceFile(&path, dev->name, "driver") < 0) { - goto cleanup; - } - - if (virFileExists(path)) { - if (virFileLinkPointsTo(path, drvdir)) { - /* The device is already bound to pci-stub */ - result = 0; - goto cleanup; - } - reprobe = 1; - } - - /* Add the PCI device ID to the stub's dynamic ID table; - * this is needed to allow us to bind the device to the stub. - * Note: if the device is not currently bound to any driver, - * stub will immediately be bound to the device. Also, note - * that if a new device with this ID is hotplugged, or if a probe - * is triggered for such a device, it will also be immediately - * bound by the stub. - */ - if (pciDriverFile(&path, driver, "new_id") < 0) { - goto cleanup; - } - - if (virFileWriteStr(path, dev->id, 0) < 0) { - virReportSystemError(errno, - _("Failed to add PCI device ID '%s' to %s"), - dev->id, driver); - goto cleanup; - } - - /* check whether the device is bound to pci-stub when we write dev->id to - * new_id. - */ - if (pciDriverDir(&drvdir, driver) < 0 || - pciDeviceFile(&path, dev->name, "driver") < 0) { - goto remove_id; - } - - if (virFileLinkPointsTo(path, drvdir)) { - dev->unbind_from_stub = 1; - dev->remove_slot = 1; - goto remove_id; - } - - /* If the device is already bound to a driver, unbind it. - * Note, this will have rather unpleasant side effects if this - * PCI device happens to be IDE controller for the disk hosting - * your root filesystem. - */ - if (pciDeviceFile(&path, dev->name, "driver/unbind") < 0) { - goto cleanup; - } - - if (virFileExists(path)) { - if (virFileWriteStr(path, dev->name, 0) < 0) { - virReportSystemError(errno, - _("Failed to unbind PCI device '%s'"), - dev->name); - goto cleanup; - } - dev->reprobe = reprobe; - } - - /* If the device isn't already bound to pci-stub, try binding it now. - */ - if (pciDriverDir(&drvdir, driver) < 0 || - pciDeviceFile(&path, dev->name, "driver") < 0) { - goto remove_id; - } - - if (!virFileLinkPointsTo(path, drvdir)) { - /* Xen's pciback.ko wants you to use new_slot first */ - if (pciDriverFile(&path, driver, "new_slot") < 0) { - goto remove_id; - } - - if (virFileExists(path) && virFileWriteStr(path, dev->name, 0) < 0) { - virReportSystemError(errno, - _("Failed to add slot for PCI device '%s' to %s"), - dev->name, driver); - goto remove_id; - } - dev->remove_slot = 1; - - if (pciDriverFile(&path, driver, "bind") < 0) { - goto remove_id; - } - - if (virFileWriteStr(path, dev->name, 0) < 0) { - virReportSystemError(errno, - _("Failed to bind PCI device '%s' to %s"), - dev->name, driver); - goto remove_id; - } - dev->unbind_from_stub = 1; - } - -remove_id: - /* If 'remove_id' exists, remove the device id from pci-stub's dynamic - * ID table so that 'drivers_probe' works below. - */ - if (pciDriverFile(&path, driver, "remove_id") < 0) { - /* We do not remove PCI ID from pci-stub, and we cannot reprobe it */ - if (dev->reprobe) { - VIR_WARN("Could not remove PCI ID '%s' from %s, and the device " - "cannot be probed again.", dev->id, driver); - } - dev->reprobe = 0; - goto cleanup; - } - - if (virFileExists(path) && virFileWriteStr(path, dev->id, 0) < 0) { - virReportSystemError(errno, - _("Failed to remove PCI ID '%s' from %s"), - dev->id, driver); - - /* remove PCI ID from pci-stub failed, and we cannot reprobe it */ - if (dev->reprobe) { - VIR_WARN("Failed to remove PCI ID '%s' from %s, and the device " - "cannot be probed again.", dev->id, driver); - } - dev->reprobe = 0; - goto cleanup; - } - - result = 0; - -cleanup: - VIR_FREE(drvdir); - VIR_FREE(path); - - if (result < 0) { - pciUnbindDeviceFromStub(dev, driver); - } - - return result; -} - -int -pciDettachDevice(pciDevice *dev, - pciDeviceList *activeDevs, - pciDeviceList *inactiveDevs) -{ - const char *driver = pciFindStubDriver(); - if (!driver) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("cannot find any PCI stub module")); - return -1; - } - - if (activeDevs && pciDeviceListFind(activeDevs, dev)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Not detaching active device %s"), dev->name); - return -1; - } - - if (pciBindDeviceToStub(dev, driver) < 0) - return -1; - - /* Add the dev into list inactiveDevs */ - if (inactiveDevs && !pciDeviceListFind(inactiveDevs, dev)) { - if (pciDeviceListAdd(inactiveDevs, dev) < 0) - return -1; - } - - return 0; -} - -int -pciReAttachDevice(pciDevice *dev, - pciDeviceList *activeDevs, - pciDeviceList *inactiveDevs) -{ - const char *driver = pciFindStubDriver(); - if (!driver) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("cannot find any PCI stub module")); - return -1; - } - - if (activeDevs && pciDeviceListFind(activeDevs, dev)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Not reattaching active device %s"), dev->name); - return -1; - } - - if (pciUnbindDeviceFromStub(dev, driver) < 0) - return -1; - - /* Steal the dev from list inactiveDevs */ - if (inactiveDevs) - pciDeviceListSteal(inactiveDevs, dev); - - return 0; -} - -/* Certain hypervisors (like qemu/kvm) map the PCI bar(s) on - * the host when doing device passthrough. This can lead to a race - * condition where the hypervisor is still cleaning up the device while - * libvirt is trying to re-attach it to the host device driver. To avoid - * this situation, we look through /proc/iomem, and if the hypervisor is - * still holding onto the bar (denoted by the string in the matcher variable), - * then we can wait around a bit for that to clear up. - * - * A typical /proc/iomem looks like this (snipped for brevity): - * 00010000-0008efff : System RAM - * 0008f000-0008ffff : reserved - * ... - * 00100000-cc9fcfff : System RAM - * 00200000-00483d3b : Kernel code - * 00483d3c-005c88df : Kernel data - * cc9fd000-ccc71fff : ACPI Non-volatile Storage - * ... - * d0200000-d02fffff : PCI Bus #05 - * d0200000-d021ffff : 0000:05:00.0 - * d0200000-d021ffff : e1000e - * d0220000-d023ffff : 0000:05:00.0 - * d0220000-d023ffff : e1000e - * ... - * f0000000-f0003fff : 0000:00:1b.0 - * f0000000-f0003fff : kvm_assigned_device - * - * Returns 0 if we are clear to continue, and 1 if the hypervisor is still - * holding onto the resource. - */ -int -pciWaitForDeviceCleanup(pciDevice *dev, const char *matcher) -{ - FILE *fp; - char line[160]; - char *tmp; - unsigned long long start, end; - unsigned int domain, bus, slot, function; - int in_matching_device; - int ret; - size_t match_depth; - - fp = fopen("/proc/iomem", "r"); - if (!fp) { - /* If we failed to open iomem, we just basically ignore the error. The - * unbind might succeed anyway, and besides, it's very likely we have - * no way to report the error - */ - VIR_DEBUG("Failed to open /proc/iomem, trying to continue anyway"); - return 0; - } - - ret = 0; - in_matching_device = 0; - match_depth = 0; - while (fgets(line, sizeof(line), fp) != 0) { - /* the logic here is a bit confusing. For each line, we look to - * see if it matches the domain:bus:slot.function we were given. - * If this line matches the DBSF, then any subsequent lines indented - * by 2 spaces are the PCI regions for this device. It's also - * possible that none of the PCI regions are currently mapped, in - * which case we have no indented regions. This code handles all - * of these situations - */ - if (in_matching_device && (strspn(line, " ") == (match_depth + 2))) { - /* expected format: <start>-<end> : <suffix> */ - if (/* start */ - virStrToLong_ull(line, &tmp, 16, &start) < 0 || *tmp != '-' || - /* end */ - virStrToLong_ull(tmp + 1, &tmp, 16, &end) < 0 || - (tmp = STRSKIP(tmp, " : ")) == NULL) - continue; - - if (STRPREFIX(tmp, matcher)) { - ret = 1; - break; - } - } - else { - in_matching_device = 0; - - /* expected format: <start>-<end> : <domain>:<bus>:<slot>.<function> */ - if (/* start */ - virStrToLong_ull(line, &tmp, 16, &start) < 0 || *tmp != '-' || - /* end */ - virStrToLong_ull(tmp + 1, &tmp, 16, &end) < 0 || - (tmp = STRSKIP(tmp, " : ")) == NULL || - /* domain */ - virStrToLong_ui(tmp, &tmp, 16, &domain) < 0 || *tmp != ':' || - /* bus */ - virStrToLong_ui(tmp + 1, &tmp, 16, &bus) < 0 || *tmp != ':' || - /* slot */ - virStrToLong_ui(tmp + 1, &tmp, 16, &slot) < 0 || *tmp != '.' || - /* function */ - virStrToLong_ui(tmp + 1, &tmp, 16, &function) < 0 || *tmp != '\n') - continue; - - if (domain != dev->domain || bus != dev->bus || slot != dev->slot || - function != dev->function) - continue; - in_matching_device = 1; - match_depth = strspn(line, " "); - } - } - - VIR_FORCE_FCLOSE(fp); - - return ret; -} - -static char * -pciReadDeviceID(pciDevice *dev, const char *id_name) -{ - char *path = NULL; - char *id_str; - - if (pciDeviceFile(&path, dev->name, id_name) < 0) { - return NULL; - } - - /* ID string is '0xNNNN\n' ... i.e. 7 bytes */ - if (virFileReadAll(path, 7, &id_str) < 0) { - VIR_FREE(path); - return NULL; - } - - VIR_FREE(path); - - /* Check for 0x suffix */ - if (id_str[0] != '0' || id_str[1] != 'x') { - VIR_FREE(id_str); - return NULL; - } - - /* Chop off the newline; we know the string is 7 bytes */ - id_str[6] = '\0'; - - return id_str; -} - -int -pciGetDeviceAddrString(unsigned domain, - unsigned bus, - unsigned slot, - unsigned function, - char **pciConfigAddr) -{ - pciDevice *dev = NULL; - int ret = -1; - - dev = pciGetDevice(domain, bus, slot, function); - if (dev != NULL) { - if ((*pciConfigAddr = strdup(dev->name)) == NULL) { - virReportOOMError(); - goto cleanup; - } - ret = 0; - } - -cleanup: - pciFreeDevice(dev); - return ret; -} - -pciDevice * -pciGetDevice(unsigned domain, - unsigned bus, - unsigned slot, - unsigned function) -{ - pciDevice *dev; - char *vendor = NULL; - char *product = NULL; - - if (VIR_ALLOC(dev) < 0) { - virReportOOMError(); - return NULL; - } - - dev->domain = domain; - dev->bus = bus; - dev->slot = slot; - dev->function = function; - - if (snprintf(dev->name, sizeof(dev->name), "%.4x:%.2x:%.2x.%.1x", - dev->domain, dev->bus, dev->slot, - dev->function) >= sizeof(dev->name)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("dev->name buffer overflow: %.4x:%.2x:%.2x.%.1x"), - dev->domain, dev->bus, dev->slot, dev->function); - goto error; - } - if (virAsprintf(&dev->path, PCI_SYSFS "devices/%s/config", - dev->name) < 0) { - virReportOOMError(); - goto error; - } - - if (access(dev->path, F_OK) != 0) { - virReportSystemError(errno, - _("Device %s not found: could not access %s"), - dev->name, dev->path); - goto error; - } - - vendor = pciReadDeviceID(dev, "vendor"); - product = pciReadDeviceID(dev, "device"); - - if (!vendor || !product) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to read product/vendor ID for %s"), - dev->name); - goto error; - } - - /* strings contain '0x' prefix */ - if (snprintf(dev->id, sizeof(dev->id), "%s %s", &vendor[2], - &product[2]) >= sizeof(dev->id)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("dev->id buffer overflow: %s %s"), - &vendor[2], &product[2]); - goto error; - } - - VIR_DEBUG("%s %s: initialized", dev->id, dev->name); - -cleanup: - VIR_FREE(product); - VIR_FREE(vendor); - return dev; - -error: - pciFreeDevice(dev); - dev = NULL; - goto cleanup; -} - -void -pciFreeDevice(pciDevice *dev) -{ - if (!dev) - return; - VIR_DEBUG("%s %s: freeing", dev->id, dev->name); - VIR_FREE(dev->path); - VIR_FREE(dev); -} - -const char * -pciDeviceGetName(pciDevice *dev) -{ - return dev->name; -} - -void pciDeviceSetManaged(pciDevice *dev, unsigned managed) -{ - dev->managed = !!managed; -} - -unsigned pciDeviceGetManaged(pciDevice *dev) -{ - return dev->managed; -} - -unsigned -pciDeviceGetUnbindFromStub(pciDevice *dev) -{ - return dev->unbind_from_stub; -} - -void -pciDeviceSetUnbindFromStub(pciDevice *dev, unsigned unbind) -{ - dev->unbind_from_stub = !!unbind; -} - -unsigned -pciDeviceGetRemoveSlot(pciDevice *dev) -{ - return dev->remove_slot; -} - -void -pciDeviceSetRemoveSlot(pciDevice *dev, unsigned remove_slot) -{ - dev->remove_slot = !!remove_slot; -} - -unsigned -pciDeviceGetReprobe(pciDevice *dev) -{ - return dev->reprobe; -} - -void -pciDeviceSetReprobe(pciDevice *dev, unsigned reprobe) -{ - dev->reprobe = !!reprobe; -} - -void -pciDeviceSetUsedBy(pciDevice *dev, const char *name) -{ - dev->used_by = name; -} - -const char * -pciDeviceGetUsedBy(pciDevice *dev) -{ - return dev->used_by; -} - -void pciDeviceReAttachInit(pciDevice *pci) -{ - pci->unbind_from_stub = 1; - pci->remove_slot = 1; - pci->reprobe = 1; -} - - -pciDeviceList * -pciDeviceListNew(void) -{ - pciDeviceList *list; - - if (VIR_ALLOC(list) < 0) { - virReportOOMError(); - return NULL; - } - - return list; -} - -void -pciDeviceListFree(pciDeviceList *list) -{ - int i; - - if (!list) - return; - - for (i = 0; i < list->count; i++) { - pciFreeDevice(list->devs[i]); - list->devs[i] = NULL; - } - - list->count = 0; - VIR_FREE(list->devs); - VIR_FREE(list); -} - -int -pciDeviceListAdd(pciDeviceList *list, - pciDevice *dev) -{ - if (pciDeviceListFind(list, dev)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Device %s is already in use"), dev->name); - return -1; - } - - if (VIR_REALLOC_N(list->devs, list->count+1) < 0) { - virReportOOMError(); - return -1; - } - - list->devs[list->count++] = dev; - - return 0; -} - -pciDevice * -pciDeviceListGet(pciDeviceList *list, - int idx) -{ - if (idx >= list->count) - return NULL; - if (idx < 0) - return NULL; - - return list->devs[idx]; -} - -int -pciDeviceListCount(pciDeviceList *list) -{ - return list->count; -} - -pciDevice * -pciDeviceListStealIndex(pciDeviceList *list, - int idx) -{ - pciDevice *ret; - - if (idx < 0 || idx >= list->count) - return NULL; - - ret = list->devs[idx]; - - if (idx != --list->count) { - memmove(&list->devs[idx], - &list->devs[idx + 1], - sizeof(*list->devs) * (list->count - idx)); - } - - if (VIR_REALLOC_N(list->devs, list->count) < 0) { - ; /* not fatal */ - } - - return ret; -} - -pciDevice * -pciDeviceListSteal(pciDeviceList *list, - pciDevice *dev) -{ - return pciDeviceListStealIndex(list, pciDeviceListFindIndex(list, dev)); -} - -void -pciDeviceListDel(pciDeviceList *list, - pciDevice *dev) -{ - pciDevice *ret = pciDeviceListSteal(list, dev); - if (ret) - pciFreeDevice(ret); -} - -int -pciDeviceListFindIndex(pciDeviceList *list, pciDevice *dev) -{ - int i; - - for (i = 0; i < list->count; i++) - if (list->devs[i]->domain == dev->domain && - list->devs[i]->bus == dev->bus && - list->devs[i]->slot == dev->slot && - list->devs[i]->function == dev->function) - return i; - return -1; -} - -pciDevice * -pciDeviceListFind(pciDeviceList *list, pciDevice *dev) -{ - int i; - - if ((i = pciDeviceListFindIndex(list, dev)) >= 0) - return list->devs[i]; - else - return NULL; -} - - -int pciDeviceFileIterate(pciDevice *dev, - pciDeviceFileActor actor, - void *opaque) -{ - char *pcidir = NULL; - char *file = NULL; - DIR *dir = NULL; - int ret = -1; - struct dirent *ent; - - if (virAsprintf(&pcidir, "/sys/bus/pci/devices/%04x:%02x:%02x.%x", - dev->domain, dev->bus, dev->slot, dev->function) < 0) { - virReportOOMError(); - goto cleanup; - } - - if (!(dir = opendir(pcidir))) { - virReportSystemError(errno, - _("cannot open %s"), pcidir); - goto cleanup; - } - - while ((ent = readdir(dir)) != NULL) { - /* Device assignment requires: - * $PCIDIR/config, $PCIDIR/resource, $PCIDIR/resourceNNN, - * $PCIDIR/rom, $PCIDIR/reset - */ - if (STREQ(ent->d_name, "config") || - STRPREFIX(ent->d_name, "resource") || - STREQ(ent->d_name, "rom") || - STREQ(ent->d_name, "reset")) { - if (virAsprintf(&file, "%s/%s", pcidir, ent->d_name) < 0) { - virReportOOMError(); - goto cleanup; - } - if ((actor)(dev, file, opaque) < 0) - goto cleanup; - - VIR_FREE(file); - } - } - - ret = 0; - -cleanup: - if (dir) - closedir(dir); - VIR_FREE(file); - VIR_FREE(pcidir); - return ret; -} - -static int -pciDeviceDownstreamLacksACS(pciDevice *dev) -{ - uint16_t flags; - uint16_t ctrl; - unsigned int pos; - int fd; - int ret = 0; - - if ((fd = pciConfigOpen(dev, true)) < 0) - return -1; - - if (pciInitDevice(dev, fd) < 0) { - ret = -1; - goto cleanup; - } - - pos = dev->pcie_cap_pos; - if (!pos || pciRead16(dev, fd, PCI_CLASS_DEVICE) != PCI_CLASS_BRIDGE_PCI) - goto cleanup; - - flags = pciRead16(dev, fd, pos + PCI_EXP_FLAGS); - if (((flags & PCI_EXP_FLAGS_TYPE) >> 4) != PCI_EXP_TYPE_DOWNSTREAM) - goto cleanup; - - pos = pciFindExtendedCapabilityOffset(dev, fd, PCI_EXT_CAP_ID_ACS); - if (!pos) { - VIR_DEBUG("%s %s: downstream port lacks ACS", dev->id, dev->name); - ret = 1; - goto cleanup; - } - - ctrl = pciRead16(dev, fd, pos + PCI_EXT_ACS_CTRL); - if ((ctrl & PCI_EXT_CAP_ACS_ENABLED) != PCI_EXT_CAP_ACS_ENABLED) { - VIR_DEBUG("%s %s: downstream port has ACS disabled", - dev->id, dev->name); - ret = 1; - goto cleanup; - } - -cleanup: - pciConfigClose(dev, fd); - return ret; -} - -static int -pciDeviceIsBehindSwitchLackingACS(pciDevice *dev) -{ - pciDevice *parent; - - if (pciGetParentDevice(dev, &parent) < 0) - return -1; - if (!parent) { - /* if we have no parent, and this is the root bus, ACS doesn't come - * into play since devices on the root bus can't P2P without going - * through the root IOMMU. - */ - if (dev->bus == 0) - return 0; - else { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to find parent device for %s"), - dev->name); - return -1; - } - } - - /* XXX we should rather fail when we can't find device's parent and - * stop the loop when we get to root instead of just stopping when no - * parent can be found - */ - do { - pciDevice *tmp; - int acs; - int ret; - - acs = pciDeviceDownstreamLacksACS(parent); - - if (acs) { - pciFreeDevice(parent); - if (acs < 0) - return -1; - else - return 1; - } - - tmp = parent; - ret = pciGetParentDevice(parent, &parent); - pciFreeDevice(tmp); - if (ret < 0) - return -1; - } while (parent); - - return 0; -} - -int pciDeviceIsAssignable(pciDevice *dev, - int strict_acs_check) -{ - int ret; - - /* XXX This could be a great place to actually check that a non-managed - * device isn't in use, e.g. by checking that device is either un-bound - * or bound to a stub driver. - */ - - ret = pciDeviceIsBehindSwitchLackingACS(dev); - if (ret < 0) - return 0; - - if (ret) { - if (!strict_acs_check) { - VIR_DEBUG("%s %s: strict ACS check disabled; device assignment allowed", - dev->id, dev->name); - } else { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Device %s is behind a switch lacking ACS and " - "cannot be assigned"), - dev->name); - return 0; - } - } - - return 1; -} - -#ifdef __linux__ - -/* - * returns true if equal - */ -static bool -pciConfigAddressEqual(struct pci_config_address *bdf1, - struct pci_config_address *bdf2) -{ - return ((bdf1->domain == bdf2->domain) && - (bdf1->bus == bdf2->bus) && - (bdf1->slot == bdf2->slot) && - (bdf1->function == bdf2->function)); -} - -static int -logStrToLong_ui(char const *s, - char **end_ptr, - int base, - unsigned int *result) -{ - int ret = 0; - - ret = virStrToLong_ui(s, end_ptr, base, result); - if (ret != 0) { - VIR_ERROR(_("Failed to convert '%s' to unsigned int"), s); - } else { - VIR_DEBUG("Converted '%s' to unsigned int %u", s, *result); - } - - return ret; -} - -static int -pciParsePciConfigAddress(char *address, - struct pci_config_address *bdf) -{ - char *p = NULL; - int ret = -1; - - if ((address == NULL) || (logStrToLong_ui(address, &p, 16, - &bdf->domain) == -1)) { - goto out; - } - - if ((p == NULL) || (logStrToLong_ui(p+1, &p, 16, - &bdf->bus) == -1)) { - goto out; - } - - if ((p == NULL) || (logStrToLong_ui(p+1, &p, 16, - &bdf->slot) == -1)) { - goto out; - } - - if ((p == NULL) || (logStrToLong_ui(p+1, &p, 16, - &bdf->function) == -1)) { - goto out; - } - - ret = 0; - -out: - return ret; -} - -static int -pciGetPciConfigAddressFromSysfsDeviceLink(const char *device_link, - struct pci_config_address **bdf) -{ - char *config_address = NULL; - char *device_path = NULL; - char errbuf[64]; - int ret = -1; - - VIR_DEBUG("Attempting to resolve device path from device link '%s'", - device_link); - - if (!virFileExists(device_link)) { - VIR_DEBUG("sysfs_path '%s' does not exist", device_link); - return ret; - } - - device_path = canonicalize_file_name(device_link); - if (device_path == NULL) { - memset(errbuf, '\0', sizeof(errbuf)); - virReportSystemError(errno, - _("Failed to resolve device link '%s'"), - device_link); - return ret; - } - - config_address = basename(device_path); - if (VIR_ALLOC(*bdf) != 0) { - virReportOOMError(); - goto out; - } - - if (pciParsePciConfigAddress(config_address, *bdf) != 0) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to parse PCI config address '%s'"), - config_address); - VIR_FREE(*bdf); - goto out; - } - - VIR_DEBUG("pci_config_address %.4x:%.2x:%.2x.%.1x", - (*bdf)->domain, - (*bdf)->bus, - (*bdf)->slot, - (*bdf)->function); - - ret = 0; - -out: - VIR_FREE(device_path); - - return ret; -} - -/* - * Returns Physical function given a virtual function - */ -int -pciGetPhysicalFunction(const char *vf_sysfs_path, - struct pci_config_address **physical_function) -{ - int ret = -1; - char *device_link = NULL; - - VIR_DEBUG("Attempting to get SR IOV physical function for device " - "with sysfs path '%s'", vf_sysfs_path); - - if (virBuildPath(&device_link, vf_sysfs_path, "physfn") == -1) { - virReportOOMError(); - return ret; - } else { - ret = pciGetPciConfigAddressFromSysfsDeviceLink(device_link, - physical_function); - } - - VIR_FREE(device_link); - - return ret; -} - -/* - * Returns virtual functions of a physical function - */ -int -pciGetVirtualFunctions(const char *sysfs_path, - struct pci_config_address ***virtual_functions, - unsigned int *num_virtual_functions) -{ - int ret = -1; - DIR *dir = NULL; - struct dirent *entry = NULL; - char *device_link = NULL; - char errbuf[64]; - - VIR_DEBUG("Attempting to get SR IOV virtual functions for device" - "with sysfs path '%s'", sysfs_path); - - dir = opendir(sysfs_path); - if (dir == NULL) { - memset(errbuf, '\0', sizeof(errbuf)); - virReportSystemError(errno, - _("Failed to open dir '%s'"), - sysfs_path); - return ret; - } - - *virtual_functions = NULL; - *num_virtual_functions = 0; - while ((entry = readdir(dir))) { - if (STRPREFIX(entry->d_name, "virtfn")) { - - if (virBuildPath(&device_link, sysfs_path, entry->d_name) == -1) { - virReportOOMError(); - goto out; - } - - VIR_DEBUG("Number of virtual functions: %d", - *num_virtual_functions); - if (VIR_REALLOC_N(*virtual_functions, - (*num_virtual_functions) + 1) != 0) { - virReportOOMError(); - VIR_FREE(device_link); - goto out; - } - - if (pciGetPciConfigAddressFromSysfsDeviceLink(device_link, - &((*virtual_functions)[*num_virtual_functions])) != - SRIOV_FOUND) { - /* We should not get back SRIOV_NOT_FOUND in this - * case, so if we do, it's an error. */ - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Failed to get SR IOV function from device " - "link '%s'"), device_link); - VIR_FREE(device_link); - goto out; - } else { - (*num_virtual_functions)++; - } - VIR_FREE(device_link); - } - } - - ret = 0; - -out: - if (dir) - closedir(dir); - - return ret; -} - -/* - * Returns 1 if vf device is a virtual function, 0 if not, -1 on error - */ -int -pciDeviceIsVirtualFunction(const char *vf_sysfs_device_link) -{ - char *vf_sysfs_physfn_link = NULL; - int ret = -1; - - if (virAsprintf(&vf_sysfs_physfn_link, "%s/physfn", - vf_sysfs_device_link) < 0) { - virReportOOMError(); - return ret; - } - - ret = virFileExists(vf_sysfs_physfn_link); - - VIR_FREE(vf_sysfs_physfn_link); - - return ret; -} - -/* - * Returns the sriov virtual function index of vf given its pf - */ -int -pciGetVirtualFunctionIndex(const char *pf_sysfs_device_link, - const char *vf_sysfs_device_link, - int *vf_index) -{ - int ret = -1, i; - unsigned int num_virt_fns = 0; - struct pci_config_address *vf_bdf = NULL; - struct pci_config_address **virt_fns = NULL; - - if (pciGetPciConfigAddressFromSysfsDeviceLink(vf_sysfs_device_link, - &vf_bdf) < 0) - return ret; - - if (pciGetVirtualFunctions(pf_sysfs_device_link, &virt_fns, - &num_virt_fns) < 0) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Error getting physical function's '%s' " - "virtual_functions"), pf_sysfs_device_link); - goto out; - } - - for (i = 0; i < num_virt_fns; i++) { - if (pciConfigAddressEqual(vf_bdf, virt_fns[i])) { - *vf_index = i; - ret = 0; - break; - } - } - -out: - - /* free virtual functions */ - for (i = 0; i < num_virt_fns; i++) - VIR_FREE(virt_fns[i]); - - VIR_FREE(virt_fns); - VIR_FREE(vf_bdf); - - return ret; -} - -/* - * Returns a path to the PCI sysfs file given the BDF of the PCI function - */ - -int -pciSysfsFile(char *pciDeviceName, char **pci_sysfs_device_link) -{ - if (virAsprintf(pci_sysfs_device_link, PCI_SYSFS "devices/%s", - pciDeviceName) < 0) { - virReportOOMError(); - return -1; - } - - return 0; -} - -int -pciConfigAddressToSysfsFile(struct pci_config_address *dev, - char **pci_sysfs_device_link) -{ - if (virAsprintf(pci_sysfs_device_link, - PCI_SYSFS "devices/%04x:%02x:%02x.%x", dev->domain, - dev->bus, dev->slot, dev->function) < 0) { - virReportOOMError(); - return -1; - } - - return 0; -} - -/* - * Returns the network device name of a pci device - */ -int -pciDeviceNetName(char *device_link_sysfs_path, char **netname) -{ - char *pcidev_sysfs_net_path = NULL; - int ret = -1; - DIR *dir = NULL; - struct dirent *entry = NULL; - - if (virBuildPath(&pcidev_sysfs_net_path, device_link_sysfs_path, - "net") == -1) { - virReportOOMError(); - return -1; - } - - dir = opendir(pcidev_sysfs_net_path); - if (dir == NULL) - goto out; - - while ((entry = readdir(dir))) { - if (STREQ(entry->d_name, ".") || - STREQ(entry->d_name, "..")) - continue; - - /* Assume a single directory entry */ - *netname = strdup(entry->d_name); - if (!*netname) - virReportOOMError(); - else - ret = 0; - break; - } - - closedir(dir); - -out: - VIR_FREE(pcidev_sysfs_net_path); - - return ret; -} - -int -pciDeviceGetVirtualFunctionInfo(const char *vf_sysfs_device_path, - char **pfname, int *vf_index) -{ - struct pci_config_address *pf_config_address = NULL; - char *pf_sysfs_device_path = NULL; - int ret = -1; - - if (pciGetPhysicalFunction(vf_sysfs_device_path, &pf_config_address) < 0) - return ret; - - if (pciConfigAddressToSysfsFile(pf_config_address, - &pf_sysfs_device_path) < 0) { - - VIR_FREE(pf_config_address); - return ret; - } - - if (pciGetVirtualFunctionIndex(pf_sysfs_device_path, vf_sysfs_device_path, - vf_index) < 0) - goto cleanup; - - ret = pciDeviceNetName(pf_sysfs_device_path, pfname); - -cleanup: - VIR_FREE(pf_config_address); - VIR_FREE(pf_sysfs_device_path); - - return ret; -} - -#else -static const char *unsupported = N_("not supported on non-linux platforms"); - -int -pciGetPhysicalFunction(const char *vf_sysfs_path ATTRIBUTE_UNUSED, - struct pci_config_address **physical_function ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); - return -1; -} - -int -pciGetVirtualFunctions(const char *sysfs_path ATTRIBUTE_UNUSED, - struct pci_config_address ***virtual_functions ATTRIBUTE_UNUSED, - unsigned int *num_virtual_functions ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); - return -1; -} - -int -pciDeviceIsVirtualFunction(const char *vf_sysfs_device_link ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); - return -1; -} - -int -pciGetVirtualFunctionIndex(const char *pf_sysfs_device_link ATTRIBUTE_UNUSED, - const char *vf_sysfs_device_link ATTRIBUTE_UNUSED, - int *vf_index ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); - return -1; - -} - -int -pciConfigAddressToSysfsFile(struct pci_config_address *dev ATTRIBUTE_UNUSED, - char **pci_sysfs_device_link ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); - return -1; -} - -int -pciDeviceNetName(char *device_link_sysfs_path ATTRIBUTE_UNUSED, - char **netname ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); - return -1; -} - -int -pciDeviceGetVirtualFunctionInfo(const char *vf_sysfs_device_path ATTRIBUTE_UNUSED, - char **pfname ATTRIBUTE_UNUSED, - int *vf_index ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); - return -1; -} -#endif /* __linux__ */ diff --git a/src/util/pci.h b/src/util/pci.h deleted file mode 100644 index 814c24e..0000000 --- a/src/util/pci.h +++ /dev/null @@ -1,136 +0,0 @@ -/* - * Copyright (C) 2009, 2011-2012 Red Hat, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Authors: - * Mark McLoughlin <markmc(a)redhat.com&gt; - */ - -#ifndef __VIR_PCI_H__ -# define __VIR_PCI_H__ - -# include "internal.h" - -typedef struct _pciDevice pciDevice; -typedef struct _pciDeviceList pciDeviceList; - -struct pci_config_address { - unsigned int domain; - unsigned int bus; - unsigned int slot; - unsigned int function; -}; - -pciDevice *pciGetDevice (unsigned domain, - unsigned bus, - unsigned slot, - unsigned function); -void pciFreeDevice (pciDevice *dev); -const char *pciDeviceGetName (pciDevice *dev); -int pciDettachDevice (pciDevice *dev, - pciDeviceList *activeDevs, - pciDeviceList *inactiveDevs); -int pciReAttachDevice (pciDevice *dev, - pciDeviceList *activeDevs, - pciDeviceList *inactiveDevs); -int pciResetDevice (pciDevice *dev, - pciDeviceList *activeDevs, - pciDeviceList *inactiveDevs); -void pciDeviceSetManaged(pciDevice *dev, - unsigned managed); -unsigned pciDeviceGetManaged(pciDevice *dev); -void pciDeviceSetUsedBy(pciDevice *dev, - const char *used_by); -const char *pciDeviceGetUsedBy(pciDevice *dev); -unsigned pciDeviceGetUnbindFromStub(pciDevice *dev); -void pciDeviceSetUnbindFromStub(pciDevice *dev, - unsigned unbind); -unsigned pciDeviceGetRemoveSlot(pciDevice *dev); -void pciDeviceSetRemoveSlot(pciDevice *dev, - unsigned remove_slot); -unsigned pciDeviceGetReprobe(pciDevice *dev); -void pciDeviceSetReprobe(pciDevice *dev, - unsigned reprobe); -void pciDeviceReAttachInit(pciDevice *dev); - -pciDeviceList *pciDeviceListNew (void); -void pciDeviceListFree (pciDeviceList *list); -int pciDeviceListAdd (pciDeviceList *list, - pciDevice *dev); -pciDevice * pciDeviceListGet (pciDeviceList *list, - int idx); -int pciDeviceListCount (pciDeviceList *list); -pciDevice * pciDeviceListSteal (pciDeviceList *list, - pciDevice *dev); -pciDevice * pciDeviceListStealIndex(pciDeviceList *list, - int idx); -void pciDeviceListDel (pciDeviceList *list, - pciDevice *dev); -pciDevice * pciDeviceListFind (pciDeviceList *list, - pciDevice *dev); -int pciDeviceListFindIndex(pciDeviceList *list, - pciDevice *dev); - -/* - * Callback that will be invoked once for each file - * associated with / used for PCI host device access. - * - * Should return 0 if successfully processed, or - * -1 to indicate error and abort iteration - */ -typedef int (*pciDeviceFileActor)(pciDevice *dev, - const char *path, void *opaque); - -int pciDeviceFileIterate(pciDevice *dev, - pciDeviceFileActor actor, - void *opaque); - -int pciDeviceIsAssignable(pciDevice *dev, - int strict_acs_check); -int pciWaitForDeviceCleanup(pciDevice *dev, const char *matcher); - -int pciGetPhysicalFunction(const char *sysfs_path, - struct pci_config_address **phys_fn); - -int pciGetVirtualFunctions(const char *sysfs_path, - struct pci_config_address ***virtual_functions, - unsigned int *num_virtual_functions); - -int pciDeviceIsVirtualFunction(const char *vf_sysfs_device_link); - -int pciGetVirtualFunctionIndex(const char *pf_sysfs_device_link, - const char *vf_sysfs_device_link, - int *vf_index); - -int pciConfigAddressToSysfsFile(struct pci_config_address *dev, - char **pci_sysfs_device_link); - -int pciDeviceNetName(char *device_link_sysfs_path, char **netname); - -int pciSysfsFile(char *pciDeviceName, char **pci_sysfs_device_link) - ATTRIBUTE_RETURN_CHECK; - -int pciGetDeviceAddrString(unsigned domain, - unsigned bus, - unsigned slot, - unsigned function, - char **pciConfigAddr) - ATTRIBUTE_NONNULL(5) ATTRIBUTE_RETURN_CHECK; - -int pciDeviceGetVirtualFunctionInfo(const char *vf_sysfs_device_path, - char **pfname, int *vf_index); - -#endif /* __VIR_PCI_H__ */ diff --git a/src/util/virnetdev.c b/src/util/virnetdev.c index 88a2e4b..3ea0e39 100644 --- a/src/util/virnetdev.c +++ b/src/util/virnetdev.c @@ -28,7 +28,7 @@ #include "virterror_internal.h" #include "vircommand.h" #include "viralloc.h" -#include "pci.h" +#include "virpci.h" #include "virlog.h" #include <sys/ioctl.h> diff --git a/src/util/virnetdev.h b/src/util/virnetdev.h index 123667c..d588e89 100644 --- a/src/util/virnetdev.h +++ b/src/util/virnetdev.h @@ -26,7 +26,7 @@ # include "virsocketaddr.h" # include "virnetlink.h" # include "virmacaddr.h" -# include "pci.h" +# include "virpci.h" int virNetDevExists(const char *brname) ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; diff --git a/src/util/virpci.c b/src/util/virpci.c new file mode 100644 index 0000000..8875aa6 --- /dev/null +++ b/src/util/virpci.c @@ -0,0 +1,2285 @@ +/* + * Copyright (C) 2009-2012 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Authors: + * Mark McLoughlin <markmc(a)redhat.com&gt; + */ + +#include <config.h> + +#include "virpci.h" + +#include <dirent.h> +#include <fcntl.h> +#include <inttypes.h> +#include <limits.h> +#include <stdio.h> +#include <string.h> +#include <sys/types.h> +#include <sys/stat.h> +#include <unistd.h> +#include <stdlib.h> + +#include "virlog.h" +#include "viralloc.h" +#include "vircommand.h" +#include "virterror_internal.h" +#include "virfile.h" + +#define PCI_SYSFS "/sys/bus/pci/" +#define PCI_ID_LEN 10 /* "XXXX XXXX" */ +#define PCI_ADDR_LEN 13 /* "XXXX:XX:XX.X" */ + +#define SRIOV_FOUND 0 +#define SRIOV_NOT_FOUND 1 +#define SRIOV_ERROR -1 + +struct _pciDevice { + unsigned domain; + unsigned bus; + unsigned slot; + unsigned function; + + char name[PCI_ADDR_LEN]; /* domain:bus:slot.function */ + char id[PCI_ID_LEN]; /* product vendor */ + char *path; + const char *used_by; /* The domain which uses the device */ + + unsigned pcie_cap_pos; + unsigned pci_pm_cap_pos; + unsigned has_flr : 1; + unsigned has_pm_reset : 1; + unsigned managed : 1; + + /* used by reattach function */ + unsigned unbind_from_stub : 1; + unsigned remove_slot : 1; + unsigned reprobe : 1; +}; + +struct _pciDeviceList { + unsigned count; + pciDevice **devs; +}; + + +/* For virReportOOMError() and virReportSystemError() */ +#define VIR_FROM_THIS VIR_FROM_NONE + +/* Specifications referenced in comments: + * PCI30 - PCI Local Bus Specification 3.0 + * PCIe20 - PCI Express Base Specification 2.0 + * BR12 - PCI-to-PCI Bridge Architecture Specification 1.2 + * PM12 - PCI Bus Power Management Interface Specification 1.2 + * ECN_AF - Advanced Capabilities for Conventional PCI ECN + */ + +/* Type 0 config space header length; PCI30 Section 6.1 Configuration Space Organization */ +#define PCI_CONF_LEN 0x100 +#define PCI_CONF_HEADER_LEN 0x40 + +/* PCI30 6.2.1 */ +#define PCI_HEADER_TYPE 0x0e /* Header type */ +#define PCI_HEADER_TYPE_BRIDGE 0x1 +#define PCI_HEADER_TYPE_MASK 0x7f +#define PCI_HEADER_TYPE_MULTI 0x80 + +/* PCI30 6.2.1 Device Identification */ +#define PCI_CLASS_DEVICE 0x0a /* Device class */ + +/* Class Code for bridge; PCI30 D.7 Base Class 06h */ +#define PCI_CLASS_BRIDGE_PCI 0x0604 + +/* PCI30 6.2.3 Device Status */ +#define PCI_STATUS 0x06 /* 16 bits */ +#define PCI_STATUS_CAP_LIST 0x10 /* Support Capability List */ + +/* PCI30 6.7 Capabilities List */ +#define PCI_CAPABILITY_LIST 0x34 /* Offset of first capability list entry */ + +/* PM12 3.2.1 Capability Identifier */ +#define PCI_CAP_ID_PM 0x01 /* Power Management */ +/* PCI30 H Capability IDs */ +#define PCI_CAP_ID_EXP 0x10 /* PCI Express */ +/* ECN_AF 6.x.1.1 Capability ID for AF */ +#define PCI_CAP_ID_AF 0x13 /* Advanced Features */ + +/* PCIe20 7.8.3 Device Capabilities Register (Offset 04h) */ +#define PCI_EXP_DEVCAP 0x4 /* Device capabilities */ +#define PCI_EXP_DEVCAP_FLR (1<<28) /* Function Level Reset */ + +/* Header type 1 BR12 3.2 PCI-to-PCI Bridge Configuration Space Header Format */ +#define PCI_PRIMARY_BUS 0x18 /* BR12 3.2.5.2 Primary bus number */ +#define PCI_SECONDARY_BUS 0x19 /* BR12 3.2.5.3 Secondary bus number */ +#define PCI_SUBORDINATE_BUS 0x1a /* BR12 3.2.5.4 Highest bus number behind the bridge */ +#define PCI_BRIDGE_CONTROL 0x3e +/* BR12 3.2.5.18 Bridge Control Register */ +#define PCI_BRIDGE_CTL_RESET 0x40 /* Secondary bus reset */ + +/* PM12 3.2.4 Power Management Control/Status (Offset = 4) */ +#define PCI_PM_CTRL 4 /* PM control and status register */ +#define PCI_PM_CTRL_STATE_MASK 0x3 /* Current power state (D0 to D3) */ +#define PCI_PM_CTRL_STATE_D0 0x0 /* D0 state */ +#define PCI_PM_CTRL_STATE_D3hot 0x3 /* D3 state */ +#define PCI_PM_CTRL_NO_SOFT_RESET 0x8 /* No reset for D3hot->D0 */ + +/* ECN_AF 6.x.1 Advanced Features Capability Structure */ +#define PCI_AF_CAP 0x3 /* Advanced features capabilities */ +#define PCI_AF_CAP_FLR 0x2 /* Function Level Reset */ + +#define PCI_EXP_FLAGS 0x2 +#define PCI_EXP_FLAGS_TYPE 0x00f0 +#define PCI_EXP_TYPE_DOWNSTREAM 0x6 + +#define PCI_EXT_CAP_BASE 0x100 +#define PCI_EXT_CAP_LIMIT 0x1000 +#define PCI_EXT_CAP_ID_MASK 0x0000ffff +#define PCI_EXT_CAP_OFFSET_SHIFT 20 +#define PCI_EXT_CAP_OFFSET_MASK 0x00000ffc + +#define PCI_EXT_CAP_ID_ACS 0x000d +#define PCI_EXT_ACS_CTRL 0x06 + +#define PCI_EXT_CAP_ACS_SV 0x01 +#define PCI_EXT_CAP_ACS_RR 0x04 +#define PCI_EXT_CAP_ACS_CR 0x08 +#define PCI_EXT_CAP_ACS_UF 0x10 +#define PCI_EXT_CAP_ACS_ENABLED (PCI_EXT_CAP_ACS_SV | \ + PCI_EXT_CAP_ACS_RR | \ + PCI_EXT_CAP_ACS_CR | \ + PCI_EXT_CAP_ACS_UF) + +static int +pciConfigOpen(pciDevice *dev, bool fatal) +{ + int fd; + + fd = open(dev->path, O_RDWR); + + if (fd < 0) { + if (fatal) { + virReportSystemError(errno, + _("Failed to open config space file '%s'"), + dev->path); + } else { + char ebuf[1024]; + VIR_WARN("Failed to open config space file '%s': %s", + dev->path, virStrerror(errno, ebuf, sizeof(ebuf))); + } + return -1; + } + + VIR_DEBUG("%s %s: opened %s", dev->id, dev->name, dev->path); + return fd; +} + +static void +pciConfigClose(pciDevice *dev, int cfgfd) +{ + if (VIR_CLOSE(cfgfd) < 0) { + char ebuf[1024]; + VIR_WARN("Failed to close config space file '%s': %s", + dev->path, virStrerror(errno, ebuf, sizeof(ebuf))); + } +} + + +static int +pciRead(pciDevice *dev, + int cfgfd, + unsigned pos, + uint8_t *buf, + unsigned buflen) +{ + memset(buf, 0, buflen); + + if (lseek(cfgfd, pos, SEEK_SET) != pos || + saferead(cfgfd, buf, buflen) != buflen) { + char ebuf[1024]; + VIR_WARN("Failed to read from '%s' : %s", dev->path, + virStrerror(errno, ebuf, sizeof(ebuf))); + return -1; + } + return 0; +} + +static uint8_t +pciRead8(pciDevice *dev, int cfgfd, unsigned pos) +{ + uint8_t buf; + pciRead(dev, cfgfd, pos, &buf, sizeof(buf)); + return buf; +} + +static uint16_t +pciRead16(pciDevice *dev, int cfgfd, unsigned pos) +{ + uint8_t buf[2]; + pciRead(dev, cfgfd, pos, &buf[0], sizeof(buf)); + return (buf[0] << 0) | (buf[1] << 8); +} + +static uint32_t +pciRead32(pciDevice *dev, int cfgfd, unsigned pos) +{ + uint8_t buf[4]; + pciRead(dev, cfgfd, pos, &buf[0], sizeof(buf)); + return (buf[0] << 0) | (buf[1] << 8) | (buf[2] << 16) | (buf[3] << 24); +} + +static int +pciWrite(pciDevice *dev, + int cfgfd, + unsigned pos, + uint8_t *buf, + unsigned buflen) +{ + if (lseek(cfgfd, pos, SEEK_SET) != pos || + safewrite(cfgfd, buf, buflen) != buflen) { + char ebuf[1024]; + VIR_WARN("Failed to write to '%s' : %s", dev->path, + virStrerror(errno, ebuf, sizeof(ebuf))); + return -1; + } + return 0; +} + +static void +pciWrite16(pciDevice *dev, int cfgfd, unsigned pos, uint16_t val) +{ + uint8_t buf[2] = { (val >> 0), (val >> 8) }; + pciWrite(dev, cfgfd, pos, &buf[0], sizeof(buf)); +} + +static void +pciWrite32(pciDevice *dev, int cfgfd, unsigned pos, uint32_t val) +{ + uint8_t buf[4] = { (val >> 0), (val >> 8), (val >> 16), (val >> 24) }; + pciWrite(dev, cfgfd, pos, &buf[0], sizeof(buf)); +} + +typedef int (*pciIterPredicate)(pciDevice *, pciDevice *, void *); + +/* Iterate over available PCI devices calling @predicate + * to compare each one to @dev. + * Return -1 on error since we don't want to assume it is + * safe to reset if there is an error. + */ +static int +pciIterDevices(pciIterPredicate predicate, + pciDevice *dev, + pciDevice **matched, + void *data) +{ + DIR *dir; + struct dirent *entry; + int ret = 0; + int rc; + + *matched = NULL; + + VIR_DEBUG("%s %s: iterating over " PCI_SYSFS "devices", dev->id, dev->name); + + dir = opendir(PCI_SYSFS "devices"); + if (!dir) { + VIR_WARN("Failed to open " PCI_SYSFS "devices"); + return -1; + } + + while ((entry = readdir(dir))) { + unsigned int domain, bus, slot, function; + pciDevice *check; + char *tmp; + + /* Ignore '.' and '..' */ + if (entry->d_name[0] == '.') + continue; + + /* expected format: <domain>:<bus>:<slot>.<function> */ + if (/* domain */ + virStrToLong_ui(entry->d_name, &tmp, 16, &domain) < 0 || *tmp != ':' || + /* bus */ + virStrToLong_ui(tmp + 1, &tmp, 16, &bus) < 0 || *tmp != ':' || + /* slot */ + virStrToLong_ui(tmp + 1, &tmp, 16, &slot) < 0 || *tmp != '.' || + /* function */ + virStrToLong_ui(tmp + 1, NULL, 16, &function) < 0) { + VIR_WARN("Unusual entry in " PCI_SYSFS "devices: %s", entry->d_name); + continue; + } + + check = pciGetDevice(domain, bus, slot, function); + if (!check) { + ret = -1; + break; + } + + rc = predicate(dev, check, data); + if (rc < 0) { + /* the predicate returned an error, bail */ + pciFreeDevice(check); + ret = -1; + break; + } + else if (rc == 1) { + VIR_DEBUG("%s %s: iter matched on %s", dev->id, dev->name, check->name); + *matched = check; + ret = 1; + break; + } + + pciFreeDevice(check); + } + closedir(dir); + return ret; +} + +static uint8_t +pciFindCapabilityOffset(pciDevice *dev, int cfgfd, unsigned capability) +{ + uint16_t status; + uint8_t pos; + + status = pciRead16(dev, cfgfd, PCI_STATUS); + if (!(status & PCI_STATUS_CAP_LIST)) + return 0; + + pos = pciRead8(dev, cfgfd, PCI_CAPABILITY_LIST); + + /* Zero indicates last capability, capabilities can't + * be in the config space header and 0xff is returned + * by the kernel if we don't have access to this region + * + * Note: we're not handling loops or extended + * capabilities here. + */ + while (pos >= PCI_CONF_HEADER_LEN && pos != 0xff) { + uint8_t capid = pciRead8(dev, cfgfd, pos); + if (capid == capability) { + VIR_DEBUG("%s %s: found cap 0x%.2x at 0x%.2x", + dev->id, dev->name, capability, pos); + return pos; + } + + pos = pciRead8(dev, cfgfd, pos + 1); + } + + VIR_DEBUG("%s %s: failed to find cap 0x%.2x", dev->id, dev->name, capability); + + return 0; +} + +static unsigned int +pciFindExtendedCapabilityOffset(pciDevice *dev, + int cfgfd, + unsigned capability) +{ + int ttl; + unsigned int pos; + uint32_t header; + + /* minimum 8 bytes per capability */ + ttl = (PCI_EXT_CAP_LIMIT - PCI_EXT_CAP_BASE) / 8; + pos = PCI_EXT_CAP_BASE; + + while (ttl > 0 && pos >= PCI_EXT_CAP_BASE) { + header = pciRead32(dev, cfgfd, pos); + + if ((header & PCI_EXT_CAP_ID_MASK) == capability) + return pos; + + pos = (header >> PCI_EXT_CAP_OFFSET_SHIFT) & PCI_EXT_CAP_OFFSET_MASK; + ttl--; + } + + return 0; +} + +/* detects whether this device has FLR. Returns 0 if the device does + * not have FLR, 1 if it does, and -1 on error + */ +static int +pciDetectFunctionLevelReset(pciDevice *dev, int cfgfd) +{ + uint32_t caps; + uint8_t pos; + char *path; + int found; + + /* The PCIe Function Level Reset capability allows + * individual device functions to be reset without + * affecting any other functions on the device or + * any other devices on the bus. This is only common + * on SR-IOV NICs at the moment. + */ + if (dev->pcie_cap_pos) { + caps = pciRead32(dev, cfgfd, dev->pcie_cap_pos + PCI_EXP_DEVCAP); + if (caps & PCI_EXP_DEVCAP_FLR) { + VIR_DEBUG("%s %s: detected PCIe FLR capability", dev->id, dev->name); + return 1; + } + } + + /* The PCI AF Function Level Reset capability is + * the same thing, except for conventional PCI + * devices. This is not common yet. + */ + pos = pciFindCapabilityOffset(dev, cfgfd, PCI_CAP_ID_AF); + if (pos) { + caps = pciRead16(dev, cfgfd, pos + PCI_AF_CAP); + if (caps & PCI_AF_CAP_FLR) { + VIR_DEBUG("%s %s: detected PCI FLR capability", dev->id, dev->name); + return 1; + } + } + + /* there are some buggy devices that do support FLR, but forget to + * advertise that fact in their capabilities. However, FLR is *required* + * to be present for virtual functions (VFs), so if we see that this + * device is a VF, we just assume FLR works + */ + + if (virAsprintf(&path, PCI_SYSFS "devices/%s/physfn", dev->name) < 0) { + virReportOOMError(); + return -1; + } + + found = virFileExists(path); + VIR_FREE(path); + if (found) { + VIR_DEBUG("%s %s: buggy device didn't advertise FLR, but is a VF; forcing flr on", + dev->id, dev->name); + return 1; + } + + VIR_DEBUG("%s %s: no FLR capability found", dev->id, dev->name); + + return 0; +} + +/* Require the device has the PCI Power Management capability + * and that a D3hot->D0 transition will results in a full + * internal reset, not just a soft reset. + */ +static unsigned +pciDetectPowerManagementReset(pciDevice *dev, int cfgfd) +{ + if (dev->pci_pm_cap_pos) { + uint32_t ctl; + + /* require the NO_SOFT_RESET bit is clear */ + ctl = pciRead32(dev, cfgfd, dev->pci_pm_cap_pos + PCI_PM_CTRL); + if (!(ctl & PCI_PM_CTRL_NO_SOFT_RESET)) { + VIR_DEBUG("%s %s: detected PM reset capability", dev->id, dev->name); + return 1; + } + } + + VIR_DEBUG("%s %s: no PM reset capability found", dev->id, dev->name); + + return 0; +} + +/* Any active devices on the same domain/bus ? */ +static int +pciSharesBusWithActive(pciDevice *dev, pciDevice *check, void *data) +{ + pciDeviceList *inactiveDevs = data; + + /* Different domain, different bus, or simply identical device */ + if (dev->domain != check->domain || + dev->bus != check->bus || + (dev->slot == check->slot && + dev->function == check->function)) + return 0; + + /* same bus, but inactive, i.e. about to be assigned to guest */ + if (inactiveDevs && pciDeviceListFind(inactiveDevs, check)) + return 0; + + return 1; +} + +static pciDevice * +pciBusContainsActiveDevices(pciDevice *dev, + pciDeviceList *inactiveDevs) +{ + pciDevice *active = NULL; + if (pciIterDevices(pciSharesBusWithActive, + dev, &active, inactiveDevs) < 0) + return NULL; + return active; +} + +/* Is @check the parent of @dev ? */ +static int +pciIsParent(pciDevice *dev, pciDevice *check, void *data) +{ + uint16_t device_class; + uint8_t header_type, secondary, subordinate; + pciDevice **best = data; + int ret = 0; + int fd; + + if (dev->domain != check->domain) + return 0; + + if ((fd = pciConfigOpen(check, false)) < 0) + return 0; + + /* Is it a bridge? */ + device_class = pciRead16(check, fd, PCI_CLASS_DEVICE); + if (device_class != PCI_CLASS_BRIDGE_PCI) + goto cleanup; + + /* Is it a plane? */ + header_type = pciRead8(check, fd, PCI_HEADER_TYPE); + if ((header_type & PCI_HEADER_TYPE_MASK) != PCI_HEADER_TYPE_BRIDGE) + goto cleanup; + + secondary = pciRead8(check, fd, PCI_SECONDARY_BUS); + subordinate = pciRead8(check, fd, PCI_SUBORDINATE_BUS); + + VIR_DEBUG("%s %s: found parent device %s", dev->id, dev->name, check->name); + + /* if the secondary bus exactly equals the device's bus, then we found + * the direct parent. No further work is necessary + */ + if (dev->bus == secondary) { + ret = 1; + goto cleanup; + } + + /* otherwise, SRIOV allows VFs to be on different busses then their PFs. + * In this case, what we need to do is look for the "best" match; i.e. + * the most restrictive match that still satisfies all of the conditions. + */ + if (dev->bus > secondary && dev->bus <= subordinate) { + if (*best == NULL) { + *best = pciGetDevice(check->domain, check->bus, check->slot, + check->function); + if (*best == NULL) { + ret = -1; + goto cleanup; + } + } else { + /* OK, we had already recorded a previous "best" match for the + * parent. See if the current device is more restrictive than the + * best, and if so, make it the new best + */ + int bestfd; + uint8_t best_secondary; + + if ((bestfd = pciConfigOpen(*best, false)) < 0) + goto cleanup; + best_secondary = pciRead8(*best, bestfd, PCI_SECONDARY_BUS); + pciConfigClose(*best, bestfd); + + if (secondary > best_secondary) { + pciFreeDevice(*best); + *best = pciGetDevice(check->domain, check->bus, check->slot, + check->function); + if (*best == NULL) { + ret = -1; + goto cleanup; + } + } + } + } + +cleanup: + pciConfigClose(check, fd); + return ret; +} + +static int +pciGetParentDevice(pciDevice *dev, pciDevice **parent) +{ + pciDevice *best = NULL; + int ret; + + *parent = NULL; + ret = pciIterDevices(pciIsParent, dev, parent, &best); + if (ret == 1) + pciFreeDevice(best); + else if (ret == 0) + *parent = best; + return ret; +} + +/* Secondary Bus Reset is our sledgehammer - it resets all + * devices behind a bus. + */ +static int +pciTrySecondaryBusReset(pciDevice *dev, + int cfgfd, + pciDeviceList *inactiveDevs) +{ + pciDevice *parent, *conflict; + uint8_t config_space[PCI_CONF_LEN]; + uint16_t ctl; + int ret = -1; + int parentfd; + + /* Refuse to do a secondary bus reset if there are other + * devices/functions behind the bus are used by the host + * or other guests. + */ + if ((conflict = pciBusContainsActiveDevices(dev, inactiveDevs))) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Active %s devices on bus with %s, not doing bus reset"), + conflict->name, dev->name); + return -1; + } + + /* Find the parent bus */ + if (pciGetParentDevice(dev, &parent) < 0) + return -1; + if (!parent) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to find parent device for %s"), + dev->name); + return -1; + } + if ((parentfd = pciConfigOpen(parent, true)) < 0) + goto out; + + VIR_DEBUG("%s %s: doing a secondary bus reset", dev->id, dev->name); + + /* Save and restore the device's config space; we only do this + * for the supplied device since we refuse to do a reset if there + * are multiple devices/functions + */ + if (pciRead(dev, cfgfd, 0, config_space, PCI_CONF_LEN) < 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to read PCI config space for %s"), + dev->name); + goto out; + } + + /* Read the control register, set the reset flag, wait 200ms, + * unset the reset flag and wait 200ms. + */ + ctl = pciRead16(dev, cfgfd, PCI_BRIDGE_CONTROL); + + pciWrite16(parent, parentfd, PCI_BRIDGE_CONTROL, + ctl | PCI_BRIDGE_CTL_RESET); + + usleep(200 * 1000); /* sleep 200ms */ + + pciWrite16(parent, parentfd, PCI_BRIDGE_CONTROL, ctl); + + usleep(200 * 1000); /* sleep 200ms */ + + if (pciWrite(dev, cfgfd, 0, config_space, PCI_CONF_LEN) < 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to restore PCI config space for %s"), + dev->name); + goto out; + } + ret = 0; + +out: + pciConfigClose(parent, parentfd); + pciFreeDevice(parent); + return ret; +} + +/* Power management reset attempts to reset a device using a + * D-state transition from D3hot to D0. Note, in detect_pm_reset() + * above we require the device supports a full internal reset. + */ +static int +pciTryPowerManagementReset(pciDevice *dev, int cfgfd) +{ + uint8_t config_space[PCI_CONF_LEN]; + uint32_t ctl; + + if (!dev->pci_pm_cap_pos) + return -1; + + /* Save and restore the device's config space. */ + if (pciRead(dev, cfgfd, 0, &config_space[0], PCI_CONF_LEN) < 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to read PCI config space for %s"), + dev->name); + return -1; + } + + VIR_DEBUG("%s %s: doing a power management reset", dev->id, dev->name); + + ctl = pciRead32(dev, cfgfd, dev->pci_pm_cap_pos + PCI_PM_CTRL); + ctl &= ~PCI_PM_CTRL_STATE_MASK; + + pciWrite32(dev, cfgfd, dev->pci_pm_cap_pos + PCI_PM_CTRL, + ctl | PCI_PM_CTRL_STATE_D3hot); + + usleep(10 * 1000); /* sleep 10ms */ + + pciWrite32(dev, cfgfd, dev->pci_pm_cap_pos + PCI_PM_CTRL, + ctl | PCI_PM_CTRL_STATE_D0); + + usleep(10 * 1000); /* sleep 10ms */ + + if (pciWrite(dev, cfgfd, 0, &config_space[0], PCI_CONF_LEN) < 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to restore PCI config space for %s"), + dev->name); + return -1; + } + + return 0; +} + +static int +pciInitDevice(pciDevice *dev, int cfgfd) +{ + int flr; + + dev->pcie_cap_pos = pciFindCapabilityOffset(dev, cfgfd, PCI_CAP_ID_EXP); + dev->pci_pm_cap_pos = pciFindCapabilityOffset(dev, cfgfd, PCI_CAP_ID_PM); + flr = pciDetectFunctionLevelReset(dev, cfgfd); + if (flr < 0) + return flr; + dev->has_flr = flr; + dev->has_pm_reset = pciDetectPowerManagementReset(dev, cfgfd); + + return 0; +} + +int +pciResetDevice(pciDevice *dev, + pciDeviceList *activeDevs, + pciDeviceList *inactiveDevs) +{ + int ret = -1; + int fd; + + if (activeDevs && pciDeviceListFind(activeDevs, dev)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Not resetting active device %s"), dev->name); + return -1; + } + + if ((fd = pciConfigOpen(dev, true)) < 0) + return -1; + + if (pciInitDevice(dev, fd) < 0) + goto cleanup; + + /* KVM will perform FLR when starting and stopping + * a guest, so there is no need for us to do it here. + */ + if (dev->has_flr) { + ret = 0; + goto cleanup; + } + + /* If the device supports PCI power management reset, + * that's the next best thing because it only resets + * the function, not the whole device. + */ + if (dev->has_pm_reset) + ret = pciTryPowerManagementReset(dev, fd); + + /* Bus reset is not an option with the root bus */ + if (ret < 0 && dev->bus != 0) + ret = pciTrySecondaryBusReset(dev, fd, inactiveDevs); + + if (ret < 0) { + virErrorPtr err = virGetLastError(); + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Unable to reset PCI device %s: %s"), + dev->name, + err ? err->message : _("no FLR, PM reset or bus reset available")); + } + +cleanup: + pciConfigClose(dev, fd); + return ret; +} + + +static int +pciDriverDir(char **buffer, const char *driver) +{ + VIR_FREE(*buffer); + + if (virAsprintf(buffer, PCI_SYSFS "drivers/%s", driver) < 0) { + virReportOOMError(); + return -1; + } + + return 0; +} + +static int +pciDriverFile(char **buffer, const char *driver, const char *file) +{ + VIR_FREE(*buffer); + + if (virAsprintf(buffer, PCI_SYSFS "drivers/%s/%s", driver, file) < 0) { + virReportOOMError(); + return -1; + } + + return 0; +} + +static int +pciDeviceFile(char **buffer, const char *device, const char *file) +{ + VIR_FREE(*buffer); + + if (virAsprintf(buffer, PCI_SYSFS "devices/%s/%s", device, file) < 0) { + virReportOOMError(); + return -1; + } + + return 0; +} + + +static const char * +pciFindStubDriver(void) +{ + char *drvpath = NULL; + int probed = 0; + +recheck: + if (pciDriverDir(&drvpath, "pci-stub") < 0) { + return NULL; + } + + if (virFileExists(drvpath)) { + VIR_FREE(drvpath); + return "pci-stub"; + } + + if (pciDriverDir(&drvpath, "pciback") < 0) { + return NULL; + } + + if (virFileExists(drvpath)) { + VIR_FREE(drvpath); + return "pciback"; + } + + VIR_FREE(drvpath); + + if (!probed) { + const char *const stubprobe[] = { MODPROBE, "pci-stub", NULL }; + const char *const backprobe[] = { MODPROBE, "pciback", NULL }; + + probed = 1; + /* + * Probing for pci-stub will succeed regardless of whether + * on native or Xen kernels. + * On Xen though, we want to prefer pciback, so probe + * for that first, because that will only work on Xen + */ + if (virRun(backprobe, NULL) < 0 && + virRun(stubprobe, NULL) < 0) { + char ebuf[1024]; + VIR_WARN("failed to load pci-stub or pciback drivers: %s", + virStrerror(errno, ebuf, sizeof(ebuf))); + return NULL; + } + + goto recheck; + } + + return NULL; +} + +static int +pciUnbindDeviceFromStub(pciDevice *dev, const char *driver) +{ + int result = -1; + char *drvdir = NULL; + char *path = NULL; + + if (pciDriverDir(&drvdir, driver) < 0) + goto cleanup; + + if (!dev->unbind_from_stub) + goto remove_slot; + + /* If the device is bound to stub, unbind it. + */ + if (pciDeviceFile(&path, dev->name, "driver") < 0) + goto cleanup; + + if (virFileExists(drvdir) && virFileLinkPointsTo(path, drvdir)) { + if (pciDriverFile(&path, driver, "unbind") < 0) { + goto cleanup; + } + + if (virFileWriteStr(path, dev->name, 0) < 0) { + virReportSystemError(errno, + _("Failed to unbind PCI device '%s' from %s"), + dev->name, driver); + goto cleanup; + } + } + dev->unbind_from_stub = 0; + +remove_slot: + if (!dev->remove_slot) + goto reprobe; + + /* Xen's pciback.ko wants you to use remove_slot on the specific device */ + if (pciDriverFile(&path, driver, "remove_slot") < 0) { + goto cleanup; + } + + if (virFileExists(path) && virFileWriteStr(path, dev->name, 0) < 0) { + virReportSystemError(errno, + _("Failed to remove slot for PCI device '%s' from %s"), + dev->name, driver); + goto cleanup; + } + dev->remove_slot = 0; + +reprobe: + if (!dev->reprobe) { + result = 0; + goto cleanup; + } + + /* Trigger a re-probe of the device is not in the stub's dynamic + * ID table. If the stub is available, but 'remove_id' isn't + * available, then re-probing would just cause the device to be + * re-bound to the stub. + */ + if (pciDriverFile(&path, driver, "remove_id") < 0) { + goto cleanup; + } + + if (!virFileExists(drvdir) || virFileExists(path)) { + if (virFileWriteStr(PCI_SYSFS "drivers_probe", dev->name, 0) < 0) { + virReportSystemError(errno, + _("Failed to trigger a re-probe for PCI device '%s'"), + dev->name); + goto cleanup; + } + } + + result = 0; + +cleanup: + /* do not do it again */ + dev->unbind_from_stub = 0; + dev->remove_slot = 0; + dev->reprobe = 0; + + VIR_FREE(drvdir); + VIR_FREE(path); + + return result; +} + + +static int +pciBindDeviceToStub(pciDevice *dev, const char *driver) +{ + int result = -1; + char *drvdir = NULL; + char *path = NULL; + int reprobe = 0; + + /* check whether the device is already bound to a driver */ + if (pciDriverDir(&drvdir, driver) < 0 || + pciDeviceFile(&path, dev->name, "driver") < 0) { + goto cleanup; + } + + if (virFileExists(path)) { + if (virFileLinkPointsTo(path, drvdir)) { + /* The device is already bound to pci-stub */ + result = 0; + goto cleanup; + } + reprobe = 1; + } + + /* Add the PCI device ID to the stub's dynamic ID table; + * this is needed to allow us to bind the device to the stub. + * Note: if the device is not currently bound to any driver, + * stub will immediately be bound to the device. Also, note + * that if a new device with this ID is hotplugged, or if a probe + * is triggered for such a device, it will also be immediately + * bound by the stub. + */ + if (pciDriverFile(&path, driver, "new_id") < 0) { + goto cleanup; + } + + if (virFileWriteStr(path, dev->id, 0) < 0) { + virReportSystemError(errno, + _("Failed to add PCI device ID '%s' to %s"), + dev->id, driver); + goto cleanup; + } + + /* check whether the device is bound to pci-stub when we write dev->id to + * new_id. + */ + if (pciDriverDir(&drvdir, driver) < 0 || + pciDeviceFile(&path, dev->name, "driver") < 0) { + goto remove_id; + } + + if (virFileLinkPointsTo(path, drvdir)) { + dev->unbind_from_stub = 1; + dev->remove_slot = 1; + goto remove_id; + } + + /* If the device is already bound to a driver, unbind it. + * Note, this will have rather unpleasant side effects if this + * PCI device happens to be IDE controller for the disk hosting + * your root filesystem. + */ + if (pciDeviceFile(&path, dev->name, "driver/unbind") < 0) { + goto cleanup; + } + + if (virFileExists(path)) { + if (virFileWriteStr(path, dev->name, 0) < 0) { + virReportSystemError(errno, + _("Failed to unbind PCI device '%s'"), + dev->name); + goto cleanup; + } + dev->reprobe = reprobe; + } + + /* If the device isn't already bound to pci-stub, try binding it now. + */ + if (pciDriverDir(&drvdir, driver) < 0 || + pciDeviceFile(&path, dev->name, "driver") < 0) { + goto remove_id; + } + + if (!virFileLinkPointsTo(path, drvdir)) { + /* Xen's pciback.ko wants you to use new_slot first */ + if (pciDriverFile(&path, driver, "new_slot") < 0) { + goto remove_id; + } + + if (virFileExists(path) && virFileWriteStr(path, dev->name, 0) < 0) { + virReportSystemError(errno, + _("Failed to add slot for PCI device '%s' to %s"), + dev->name, driver); + goto remove_id; + } + dev->remove_slot = 1; + + if (pciDriverFile(&path, driver, "bind") < 0) { + goto remove_id; + } + + if (virFileWriteStr(path, dev->name, 0) < 0) { + virReportSystemError(errno, + _("Failed to bind PCI device '%s' to %s"), + dev->name, driver); + goto remove_id; + } + dev->unbind_from_stub = 1; + } + +remove_id: + /* If 'remove_id' exists, remove the device id from pci-stub's dynamic + * ID table so that 'drivers_probe' works below. + */ + if (pciDriverFile(&path, driver, "remove_id") < 0) { + /* We do not remove PCI ID from pci-stub, and we cannot reprobe it */ + if (dev->reprobe) { + VIR_WARN("Could not remove PCI ID '%s' from %s, and the device " + "cannot be probed again.", dev->id, driver); + } + dev->reprobe = 0; + goto cleanup; + } + + if (virFileExists(path) && virFileWriteStr(path, dev->id, 0) < 0) { + virReportSystemError(errno, + _("Failed to remove PCI ID '%s' from %s"), + dev->id, driver); + + /* remove PCI ID from pci-stub failed, and we cannot reprobe it */ + if (dev->reprobe) { + VIR_WARN("Failed to remove PCI ID '%s' from %s, and the device " + "cannot be probed again.", dev->id, driver); + } + dev->reprobe = 0; + goto cleanup; + } + + result = 0; + +cleanup: + VIR_FREE(drvdir); + VIR_FREE(path); + + if (result < 0) { + pciUnbindDeviceFromStub(dev, driver); + } + + return result; +} + +int +pciDettachDevice(pciDevice *dev, + pciDeviceList *activeDevs, + pciDeviceList *inactiveDevs) +{ + const char *driver = pciFindStubDriver(); + if (!driver) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("cannot find any PCI stub module")); + return -1; + } + + if (activeDevs && pciDeviceListFind(activeDevs, dev)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Not detaching active device %s"), dev->name); + return -1; + } + + if (pciBindDeviceToStub(dev, driver) < 0) + return -1; + + /* Add the dev into list inactiveDevs */ + if (inactiveDevs && !pciDeviceListFind(inactiveDevs, dev)) { + if (pciDeviceListAdd(inactiveDevs, dev) < 0) + return -1; + } + + return 0; +} + +int +pciReAttachDevice(pciDevice *dev, + pciDeviceList *activeDevs, + pciDeviceList *inactiveDevs) +{ + const char *driver = pciFindStubDriver(); + if (!driver) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("cannot find any PCI stub module")); + return -1; + } + + if (activeDevs && pciDeviceListFind(activeDevs, dev)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Not reattaching active device %s"), dev->name); + return -1; + } + + if (pciUnbindDeviceFromStub(dev, driver) < 0) + return -1; + + /* Steal the dev from list inactiveDevs */ + if (inactiveDevs) + pciDeviceListSteal(inactiveDevs, dev); + + return 0; +} + +/* Certain hypervisors (like qemu/kvm) map the PCI bar(s) on + * the host when doing device passthrough. This can lead to a race + * condition where the hypervisor is still cleaning up the device while + * libvirt is trying to re-attach it to the host device driver. To avoid + * this situation, we look through /proc/iomem, and if the hypervisor is + * still holding onto the bar (denoted by the string in the matcher variable), + * then we can wait around a bit for that to clear up. + * + * A typical /proc/iomem looks like this (snipped for brevity): + * 00010000-0008efff : System RAM + * 0008f000-0008ffff : reserved + * ... + * 00100000-cc9fcfff : System RAM + * 00200000-00483d3b : Kernel code + * 00483d3c-005c88df : Kernel data + * cc9fd000-ccc71fff : ACPI Non-volatile Storage + * ... + * d0200000-d02fffff : PCI Bus #05 + * d0200000-d021ffff : 0000:05:00.0 + * d0200000-d021ffff : e1000e + * d0220000-d023ffff : 0000:05:00.0 + * d0220000-d023ffff : e1000e + * ... + * f0000000-f0003fff : 0000:00:1b.0 + * f0000000-f0003fff : kvm_assigned_device + * + * Returns 0 if we are clear to continue, and 1 if the hypervisor is still + * holding onto the resource. + */ +int +pciWaitForDeviceCleanup(pciDevice *dev, const char *matcher) +{ + FILE *fp; + char line[160]; + char *tmp; + unsigned long long start, end; + unsigned int domain, bus, slot, function; + int in_matching_device; + int ret; + size_t match_depth; + + fp = fopen("/proc/iomem", "r"); + if (!fp) { + /* If we failed to open iomem, we just basically ignore the error. The + * unbind might succeed anyway, and besides, it's very likely we have + * no way to report the error + */ + VIR_DEBUG("Failed to open /proc/iomem, trying to continue anyway"); + return 0; + } + + ret = 0; + in_matching_device = 0; + match_depth = 0; + while (fgets(line, sizeof(line), fp) != 0) { + /* the logic here is a bit confusing. For each line, we look to + * see if it matches the domain:bus:slot.function we were given. + * If this line matches the DBSF, then any subsequent lines indented + * by 2 spaces are the PCI regions for this device. It's also + * possible that none of the PCI regions are currently mapped, in + * which case we have no indented regions. This code handles all + * of these situations + */ + if (in_matching_device && (strspn(line, " ") == (match_depth + 2))) { + /* expected format: <start>-<end> : <suffix> */ + if (/* start */ + virStrToLong_ull(line, &tmp, 16, &start) < 0 || *tmp != '-' || + /* end */ + virStrToLong_ull(tmp + 1, &tmp, 16, &end) < 0 || + (tmp = STRSKIP(tmp, " : ")) == NULL) + continue; + + if (STRPREFIX(tmp, matcher)) { + ret = 1; + break; + } + } + else { + in_matching_device = 0; + + /* expected format: <start>-<end> : <domain>:<bus>:<slot>.<function> */ + if (/* start */ + virStrToLong_ull(line, &tmp, 16, &start) < 0 || *tmp != '-' || + /* end */ + virStrToLong_ull(tmp + 1, &tmp, 16, &end) < 0 || + (tmp = STRSKIP(tmp, " : ")) == NULL || + /* domain */ + virStrToLong_ui(tmp, &tmp, 16, &domain) < 0 || *tmp != ':' || + /* bus */ + virStrToLong_ui(tmp + 1, &tmp, 16, &bus) < 0 || *tmp != ':' || + /* slot */ + virStrToLong_ui(tmp + 1, &tmp, 16, &slot) < 0 || *tmp != '.' || + /* function */ + virStrToLong_ui(tmp + 1, &tmp, 16, &function) < 0 || *tmp != '\n') + continue; + + if (domain != dev->domain || bus != dev->bus || slot != dev->slot || + function != dev->function) + continue; + in_matching_device = 1; + match_depth = strspn(line, " "); + } + } + + VIR_FORCE_FCLOSE(fp); + + return ret; +} + +static char * +pciReadDeviceID(pciDevice *dev, const char *id_name) +{ + char *path = NULL; + char *id_str; + + if (pciDeviceFile(&path, dev->name, id_name) < 0) { + return NULL; + } + + /* ID string is '0xNNNN\n' ... i.e. 7 bytes */ + if (virFileReadAll(path, 7, &id_str) < 0) { + VIR_FREE(path); + return NULL; + } + + VIR_FREE(path); + + /* Check for 0x suffix */ + if (id_str[0] != '0' || id_str[1] != 'x') { + VIR_FREE(id_str); + return NULL; + } + + /* Chop off the newline; we know the string is 7 bytes */ + id_str[6] = '\0'; + + return id_str; +} + +int +pciGetDeviceAddrString(unsigned domain, + unsigned bus, + unsigned slot, + unsigned function, + char **pciConfigAddr) +{ + pciDevice *dev = NULL; + int ret = -1; + + dev = pciGetDevice(domain, bus, slot, function); + if (dev != NULL) { + if ((*pciConfigAddr = strdup(dev->name)) == NULL) { + virReportOOMError(); + goto cleanup; + } + ret = 0; + } + +cleanup: + pciFreeDevice(dev); + return ret; +} + +pciDevice * +pciGetDevice(unsigned domain, + unsigned bus, + unsigned slot, + unsigned function) +{ + pciDevice *dev; + char *vendor = NULL; + char *product = NULL; + + if (VIR_ALLOC(dev) < 0) { + virReportOOMError(); + return NULL; + } + + dev->domain = domain; + dev->bus = bus; + dev->slot = slot; + dev->function = function; + + if (snprintf(dev->name, sizeof(dev->name), "%.4x:%.2x:%.2x.%.1x", + dev->domain, dev->bus, dev->slot, + dev->function) >= sizeof(dev->name)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("dev->name buffer overflow: %.4x:%.2x:%.2x.%.1x"), + dev->domain, dev->bus, dev->slot, dev->function); + goto error; + } + if (virAsprintf(&dev->path, PCI_SYSFS "devices/%s/config", + dev->name) < 0) { + virReportOOMError(); + goto error; + } + + if (access(dev->path, F_OK) != 0) { + virReportSystemError(errno, + _("Device %s not found: could not access %s"), + dev->name, dev->path); + goto error; + } + + vendor = pciReadDeviceID(dev, "vendor"); + product = pciReadDeviceID(dev, "device"); + + if (!vendor || !product) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to read product/vendor ID for %s"), + dev->name); + goto error; + } + + /* strings contain '0x' prefix */ + if (snprintf(dev->id, sizeof(dev->id), "%s %s", &vendor[2], + &product[2]) >= sizeof(dev->id)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("dev->id buffer overflow: %s %s"), + &vendor[2], &product[2]); + goto error; + } + + VIR_DEBUG("%s %s: initialized", dev->id, dev->name); + +cleanup: + VIR_FREE(product); + VIR_FREE(vendor); + return dev; + +error: + pciFreeDevice(dev); + dev = NULL; + goto cleanup; +} + +void +pciFreeDevice(pciDevice *dev) +{ + if (!dev) + return; + VIR_DEBUG("%s %s: freeing", dev->id, dev->name); + VIR_FREE(dev->path); + VIR_FREE(dev); +} + +const char * +pciDeviceGetName(pciDevice *dev) +{ + return dev->name; +} + +void pciDeviceSetManaged(pciDevice *dev, unsigned managed) +{ + dev->managed = !!managed; +} + +unsigned pciDeviceGetManaged(pciDevice *dev) +{ + return dev->managed; +} + +unsigned +pciDeviceGetUnbindFromStub(pciDevice *dev) +{ + return dev->unbind_from_stub; +} + +void +pciDeviceSetUnbindFromStub(pciDevice *dev, unsigned unbind) +{ + dev->unbind_from_stub = !!unbind; +} + +unsigned +pciDeviceGetRemoveSlot(pciDevice *dev) +{ + return dev->remove_slot; +} + +void +pciDeviceSetRemoveSlot(pciDevice *dev, unsigned remove_slot) +{ + dev->remove_slot = !!remove_slot; +} + +unsigned +pciDeviceGetReprobe(pciDevice *dev) +{ + return dev->reprobe; +} + +void +pciDeviceSetReprobe(pciDevice *dev, unsigned reprobe) +{ + dev->reprobe = !!reprobe; +} + +void +pciDeviceSetUsedBy(pciDevice *dev, const char *name) +{ + dev->used_by = name; +} + +const char * +pciDeviceGetUsedBy(pciDevice *dev) +{ + return dev->used_by; +} + +void pciDeviceReAttachInit(pciDevice *pci) +{ + pci->unbind_from_stub = 1; + pci->remove_slot = 1; + pci->reprobe = 1; +} + + +pciDeviceList * +pciDeviceListNew(void) +{ + pciDeviceList *list; + + if (VIR_ALLOC(list) < 0) { + virReportOOMError(); + return NULL; + } + + return list; +} + +void +pciDeviceListFree(pciDeviceList *list) +{ + int i; + + if (!list) + return; + + for (i = 0; i < list->count; i++) { + pciFreeDevice(list->devs[i]); + list->devs[i] = NULL; + } + + list->count = 0; + VIR_FREE(list->devs); + VIR_FREE(list); +} + +int +pciDeviceListAdd(pciDeviceList *list, + pciDevice *dev) +{ + if (pciDeviceListFind(list, dev)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Device %s is already in use"), dev->name); + return -1; + } + + if (VIR_REALLOC_N(list->devs, list->count+1) < 0) { + virReportOOMError(); + return -1; + } + + list->devs[list->count++] = dev; + + return 0; +} + +pciDevice * +pciDeviceListGet(pciDeviceList *list, + int idx) +{ + if (idx >= list->count) + return NULL; + if (idx < 0) + return NULL; + + return list->devs[idx]; +} + +int +pciDeviceListCount(pciDeviceList *list) +{ + return list->count; +} + +pciDevice * +pciDeviceListStealIndex(pciDeviceList *list, + int idx) +{ + pciDevice *ret; + + if (idx < 0 || idx >= list->count) + return NULL; + + ret = list->devs[idx]; + + if (idx != --list->count) { + memmove(&list->devs[idx], + &list->devs[idx + 1], + sizeof(*list->devs) * (list->count - idx)); + } + + if (VIR_REALLOC_N(list->devs, list->count) < 0) { + ; /* not fatal */ + } + + return ret; +} + +pciDevice * +pciDeviceListSteal(pciDeviceList *list, + pciDevice *dev) +{ + return pciDeviceListStealIndex(list, pciDeviceListFindIndex(list, dev)); +} + +void +pciDeviceListDel(pciDeviceList *list, + pciDevice *dev) +{ + pciDevice *ret = pciDeviceListSteal(list, dev); + if (ret) + pciFreeDevice(ret); +} + +int +pciDeviceListFindIndex(pciDeviceList *list, pciDevice *dev) +{ + int i; + + for (i = 0; i < list->count; i++) + if (list->devs[i]->domain == dev->domain && + list->devs[i]->bus == dev->bus && + list->devs[i]->slot == dev->slot && + list->devs[i]->function == dev->function) + return i; + return -1; +} + +pciDevice * +pciDeviceListFind(pciDeviceList *list, pciDevice *dev) +{ + int i; + + if ((i = pciDeviceListFindIndex(list, dev)) >= 0) + return list->devs[i]; + else + return NULL; +} + + +int pciDeviceFileIterate(pciDevice *dev, + pciDeviceFileActor actor, + void *opaque) +{ + char *pcidir = NULL; + char *file = NULL; + DIR *dir = NULL; + int ret = -1; + struct dirent *ent; + + if (virAsprintf(&pcidir, "/sys/bus/pci/devices/%04x:%02x:%02x.%x", + dev->domain, dev->bus, dev->slot, dev->function) < 0) { + virReportOOMError(); + goto cleanup; + } + + if (!(dir = opendir(pcidir))) { + virReportSystemError(errno, + _("cannot open %s"), pcidir); + goto cleanup; + } + + while ((ent = readdir(dir)) != NULL) { + /* Device assignment requires: + * $PCIDIR/config, $PCIDIR/resource, $PCIDIR/resourceNNN, + * $PCIDIR/rom, $PCIDIR/reset + */ + if (STREQ(ent->d_name, "config") || + STRPREFIX(ent->d_name, "resource") || + STREQ(ent->d_name, "rom") || + STREQ(ent->d_name, "reset")) { + if (virAsprintf(&file, "%s/%s", pcidir, ent->d_name) < 0) { + virReportOOMError(); + goto cleanup; + } + if ((actor)(dev, file, opaque) < 0) + goto cleanup; + + VIR_FREE(file); + } + } + + ret = 0; + +cleanup: + if (dir) + closedir(dir); + VIR_FREE(file); + VIR_FREE(pcidir); + return ret; +} + +static int +pciDeviceDownstreamLacksACS(pciDevice *dev) +{ + uint16_t flags; + uint16_t ctrl; + unsigned int pos; + int fd; + int ret = 0; + + if ((fd = pciConfigOpen(dev, true)) < 0) + return -1; + + if (pciInitDevice(dev, fd) < 0) { + ret = -1; + goto cleanup; + } + + pos = dev->pcie_cap_pos; + if (!pos || pciRead16(dev, fd, PCI_CLASS_DEVICE) != PCI_CLASS_BRIDGE_PCI) + goto cleanup; + + flags = pciRead16(dev, fd, pos + PCI_EXP_FLAGS); + if (((flags & PCI_EXP_FLAGS_TYPE) >> 4) != PCI_EXP_TYPE_DOWNSTREAM) + goto cleanup; + + pos = pciFindExtendedCapabilityOffset(dev, fd, PCI_EXT_CAP_ID_ACS); + if (!pos) { + VIR_DEBUG("%s %s: downstream port lacks ACS", dev->id, dev->name); + ret = 1; + goto cleanup; + } + + ctrl = pciRead16(dev, fd, pos + PCI_EXT_ACS_CTRL); + if ((ctrl & PCI_EXT_CAP_ACS_ENABLED) != PCI_EXT_CAP_ACS_ENABLED) { + VIR_DEBUG("%s %s: downstream port has ACS disabled", + dev->id, dev->name); + ret = 1; + goto cleanup; + } + +cleanup: + pciConfigClose(dev, fd); + return ret; +} + +static int +pciDeviceIsBehindSwitchLackingACS(pciDevice *dev) +{ + pciDevice *parent; + + if (pciGetParentDevice(dev, &parent) < 0) + return -1; + if (!parent) { + /* if we have no parent, and this is the root bus, ACS doesn't come + * into play since devices on the root bus can't P2P without going + * through the root IOMMU. + */ + if (dev->bus == 0) + return 0; + else { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to find parent device for %s"), + dev->name); + return -1; + } + } + + /* XXX we should rather fail when we can't find device's parent and + * stop the loop when we get to root instead of just stopping when no + * parent can be found + */ + do { + pciDevice *tmp; + int acs; + int ret; + + acs = pciDeviceDownstreamLacksACS(parent); + + if (acs) { + pciFreeDevice(parent); + if (acs < 0) + return -1; + else + return 1; + } + + tmp = parent; + ret = pciGetParentDevice(parent, &parent); + pciFreeDevice(tmp); + if (ret < 0) + return -1; + } while (parent); + + return 0; +} + +int pciDeviceIsAssignable(pciDevice *dev, + int strict_acs_check) +{ + int ret; + + /* XXX This could be a great place to actually check that a non-managed + * device isn't in use, e.g. by checking that device is either un-bound + * or bound to a stub driver. + */ + + ret = pciDeviceIsBehindSwitchLackingACS(dev); + if (ret < 0) + return 0; + + if (ret) { + if (!strict_acs_check) { + VIR_DEBUG("%s %s: strict ACS check disabled; device assignment allowed", + dev->id, dev->name); + } else { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Device %s is behind a switch lacking ACS and " + "cannot be assigned"), + dev->name); + return 0; + } + } + + return 1; +} + +#ifdef __linux__ + +/* + * returns true if equal + */ +static bool +pciConfigAddressEqual(struct pci_config_address *bdf1, + struct pci_config_address *bdf2) +{ + return ((bdf1->domain == bdf2->domain) && + (bdf1->bus == bdf2->bus) && + (bdf1->slot == bdf2->slot) && + (bdf1->function == bdf2->function)); +} + +static int +logStrToLong_ui(char const *s, + char **end_ptr, + int base, + unsigned int *result) +{ + int ret = 0; + + ret = virStrToLong_ui(s, end_ptr, base, result); + if (ret != 0) { + VIR_ERROR(_("Failed to convert '%s' to unsigned int"), s); + } else { + VIR_DEBUG("Converted '%s' to unsigned int %u", s, *result); + } + + return ret; +} + +static int +pciParsePciConfigAddress(char *address, + struct pci_config_address *bdf) +{ + char *p = NULL; + int ret = -1; + + if ((address == NULL) || (logStrToLong_ui(address, &p, 16, + &bdf->domain) == -1)) { + goto out; + } + + if ((p == NULL) || (logStrToLong_ui(p+1, &p, 16, + &bdf->bus) == -1)) { + goto out; + } + + if ((p == NULL) || (logStrToLong_ui(p+1, &p, 16, + &bdf->slot) == -1)) { + goto out; + } + + if ((p == NULL) || (logStrToLong_ui(p+1, &p, 16, + &bdf->function) == -1)) { + goto out; + } + + ret = 0; + +out: + return ret; +} + +static int +pciGetPciConfigAddressFromSysfsDeviceLink(const char *device_link, + struct pci_config_address **bdf) +{ + char *config_address = NULL; + char *device_path = NULL; + char errbuf[64]; + int ret = -1; + + VIR_DEBUG("Attempting to resolve device path from device link '%s'", + device_link); + + if (!virFileExists(device_link)) { + VIR_DEBUG("sysfs_path '%s' does not exist", device_link); + return ret; + } + + device_path = canonicalize_file_name(device_link); + if (device_path == NULL) { + memset(errbuf, '\0', sizeof(errbuf)); + virReportSystemError(errno, + _("Failed to resolve device link '%s'"), + device_link); + return ret; + } + + config_address = basename(device_path); + if (VIR_ALLOC(*bdf) != 0) { + virReportOOMError(); + goto out; + } + + if (pciParsePciConfigAddress(config_address, *bdf) != 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to parse PCI config address '%s'"), + config_address); + VIR_FREE(*bdf); + goto out; + } + + VIR_DEBUG("pci_config_address %.4x:%.2x:%.2x.%.1x", + (*bdf)->domain, + (*bdf)->bus, + (*bdf)->slot, + (*bdf)->function); + + ret = 0; + +out: + VIR_FREE(device_path); + + return ret; +} + +/* + * Returns Physical function given a virtual function + */ +int +pciGetPhysicalFunction(const char *vf_sysfs_path, + struct pci_config_address **physical_function) +{ + int ret = -1; + char *device_link = NULL; + + VIR_DEBUG("Attempting to get SR IOV physical function for device " + "with sysfs path '%s'", vf_sysfs_path); + + if (virBuildPath(&device_link, vf_sysfs_path, "physfn") == -1) { + virReportOOMError(); + return ret; + } else { + ret = pciGetPciConfigAddressFromSysfsDeviceLink(device_link, + physical_function); + } + + VIR_FREE(device_link); + + return ret; +} + +/* + * Returns virtual functions of a physical function + */ +int +pciGetVirtualFunctions(const char *sysfs_path, + struct pci_config_address ***virtual_functions, + unsigned int *num_virtual_functions) +{ + int ret = -1; + DIR *dir = NULL; + struct dirent *entry = NULL; + char *device_link = NULL; + char errbuf[64]; + + VIR_DEBUG("Attempting to get SR IOV virtual functions for device" + "with sysfs path '%s'", sysfs_path); + + dir = opendir(sysfs_path); + if (dir == NULL) { + memset(errbuf, '\0', sizeof(errbuf)); + virReportSystemError(errno, + _("Failed to open dir '%s'"), + sysfs_path); + return ret; + } + + *virtual_functions = NULL; + *num_virtual_functions = 0; + while ((entry = readdir(dir))) { + if (STRPREFIX(entry->d_name, "virtfn")) { + + if (virBuildPath(&device_link, sysfs_path, entry->d_name) == -1) { + virReportOOMError(); + goto out; + } + + VIR_DEBUG("Number of virtual functions: %d", + *num_virtual_functions); + if (VIR_REALLOC_N(*virtual_functions, + (*num_virtual_functions) + 1) != 0) { + virReportOOMError(); + VIR_FREE(device_link); + goto out; + } + + if (pciGetPciConfigAddressFromSysfsDeviceLink(device_link, + &((*virtual_functions)[*num_virtual_functions])) != + SRIOV_FOUND) { + /* We should not get back SRIOV_NOT_FOUND in this + * case, so if we do, it's an error. */ + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Failed to get SR IOV function from device " + "link '%s'"), device_link); + VIR_FREE(device_link); + goto out; + } else { + (*num_virtual_functions)++; + } + VIR_FREE(device_link); + } + } + + ret = 0; + +out: + if (dir) + closedir(dir); + + return ret; +} + +/* + * Returns 1 if vf device is a virtual function, 0 if not, -1 on error + */ +int +pciDeviceIsVirtualFunction(const char *vf_sysfs_device_link) +{ + char *vf_sysfs_physfn_link = NULL; + int ret = -1; + + if (virAsprintf(&vf_sysfs_physfn_link, "%s/physfn", + vf_sysfs_device_link) < 0) { + virReportOOMError(); + return ret; + } + + ret = virFileExists(vf_sysfs_physfn_link); + + VIR_FREE(vf_sysfs_physfn_link); + + return ret; +} + +/* + * Returns the sriov virtual function index of vf given its pf + */ +int +pciGetVirtualFunctionIndex(const char *pf_sysfs_device_link, + const char *vf_sysfs_device_link, + int *vf_index) +{ + int ret = -1, i; + unsigned int num_virt_fns = 0; + struct pci_config_address *vf_bdf = NULL; + struct pci_config_address **virt_fns = NULL; + + if (pciGetPciConfigAddressFromSysfsDeviceLink(vf_sysfs_device_link, + &vf_bdf) < 0) + return ret; + + if (pciGetVirtualFunctions(pf_sysfs_device_link, &virt_fns, + &num_virt_fns) < 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Error getting physical function's '%s' " + "virtual_functions"), pf_sysfs_device_link); + goto out; + } + + for (i = 0; i < num_virt_fns; i++) { + if (pciConfigAddressEqual(vf_bdf, virt_fns[i])) { + *vf_index = i; + ret = 0; + break; + } + } + +out: + + /* free virtual functions */ + for (i = 0; i < num_virt_fns; i++) + VIR_FREE(virt_fns[i]); + + VIR_FREE(virt_fns); + VIR_FREE(vf_bdf); + + return ret; +} + +/* + * Returns a path to the PCI sysfs file given the BDF of the PCI function + */ + +int +pciSysfsFile(char *pciDeviceName, char **pci_sysfs_device_link) +{ + if (virAsprintf(pci_sysfs_device_link, PCI_SYSFS "devices/%s", + pciDeviceName) < 0) { + virReportOOMError(); + return -1; + } + + return 0; +} + +int +pciConfigAddressToSysfsFile(struct pci_config_address *dev, + char **pci_sysfs_device_link) +{ + if (virAsprintf(pci_sysfs_device_link, + PCI_SYSFS "devices/%04x:%02x:%02x.%x", dev->domain, + dev->bus, dev->slot, dev->function) < 0) { + virReportOOMError(); + return -1; + } + + return 0; +} + +/* + * Returns the network device name of a pci device + */ +int +pciDeviceNetName(char *device_link_sysfs_path, char **netname) +{ + char *pcidev_sysfs_net_path = NULL; + int ret = -1; + DIR *dir = NULL; + struct dirent *entry = NULL; + + if (virBuildPath(&pcidev_sysfs_net_path, device_link_sysfs_path, + "net") == -1) { + virReportOOMError(); + return -1; + } + + dir = opendir(pcidev_sysfs_net_path); + if (dir == NULL) + goto out; + + while ((entry = readdir(dir))) { + if (STREQ(entry->d_name, ".") || + STREQ(entry->d_name, "..")) + continue; + + /* Assume a single directory entry */ + *netname = strdup(entry->d_name); + if (!*netname) + virReportOOMError(); + else + ret = 0; + break; + } + + closedir(dir); + +out: + VIR_FREE(pcidev_sysfs_net_path); + + return ret; +} + +int +pciDeviceGetVirtualFunctionInfo(const char *vf_sysfs_device_path, + char **pfname, int *vf_index) +{ + struct pci_config_address *pf_config_address = NULL; + char *pf_sysfs_device_path = NULL; + int ret = -1; + + if (pciGetPhysicalFunction(vf_sysfs_device_path, &pf_config_address) < 0) + return ret; + + if (pciConfigAddressToSysfsFile(pf_config_address, + &pf_sysfs_device_path) < 0) { + + VIR_FREE(pf_config_address); + return ret; + } + + if (pciGetVirtualFunctionIndex(pf_sysfs_device_path, vf_sysfs_device_path, + vf_index) < 0) + goto cleanup; + + ret = pciDeviceNetName(pf_sysfs_device_path, pfname); + +cleanup: + VIR_FREE(pf_config_address); + VIR_FREE(pf_sysfs_device_path); + + return ret; +} + +#else +static const char *unsupported = N_("not supported on non-linux platforms"); + +int +pciGetPhysicalFunction(const char *vf_sysfs_path ATTRIBUTE_UNUSED, + struct pci_config_address **physical_function ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); + return -1; +} + +int +pciGetVirtualFunctions(const char *sysfs_path ATTRIBUTE_UNUSED, + struct pci_config_address ***virtual_functions ATTRIBUTE_UNUSED, + unsigned int *num_virtual_functions ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); + return -1; +} + +int +pciDeviceIsVirtualFunction(const char *vf_sysfs_device_link ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); + return -1; +} + +int +pciGetVirtualFunctionIndex(const char *pf_sysfs_device_link ATTRIBUTE_UNUSED, + const char *vf_sysfs_device_link ATTRIBUTE_UNUSED, + int *vf_index ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); + return -1; + +} + +int +pciConfigAddressToSysfsFile(struct pci_config_address *dev ATTRIBUTE_UNUSED, + char **pci_sysfs_device_link ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); + return -1; +} + +int +pciDeviceNetName(char *device_link_sysfs_path ATTRIBUTE_UNUSED, + char **netname ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); + return -1; +} + +int +pciDeviceGetVirtualFunctionInfo(const char *vf_sysfs_device_path ATTRIBUTE_UNUSED, + char **pfname ATTRIBUTE_UNUSED, + int *vf_index ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", _(unsupported)); + return -1; +} +#endif /* __linux__ */ diff --git a/src/util/virpci.h b/src/util/virpci.h new file mode 100644 index 0000000..814c24e --- /dev/null +++ b/src/util/virpci.h @@ -0,0 +1,136 @@ +/* + * Copyright (C) 2009, 2011-2012 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Authors: + * Mark McLoughlin <markmc(a)redhat.com&gt; + */ + +#ifndef __VIR_PCI_H__ +# define __VIR_PCI_H__ + +# include "internal.h" + +typedef struct _pciDevice pciDevice; +typedef struct _pciDeviceList pciDeviceList; + +struct pci_config_address { + unsigned int domain; + unsigned int bus; + unsigned int slot; + unsigned int function; +}; + +pciDevice *pciGetDevice (unsigned domain, + unsigned bus, + unsigned slot, + unsigned function); +void pciFreeDevice (pciDevice *dev); +const char *pciDeviceGetName (pciDevice *dev); +int pciDettachDevice (pciDevice *dev, + pciDeviceList *activeDevs, + pciDeviceList *inactiveDevs); +int pciReAttachDevice (pciDevice *dev, + pciDeviceList *activeDevs, + pciDeviceList *inactiveDevs); +int pciResetDevice (pciDevice *dev, + pciDeviceList *activeDevs, + pciDeviceList *inactiveDevs); +void pciDeviceSetManaged(pciDevice *dev, + unsigned managed); +unsigned pciDeviceGetManaged(pciDevice *dev); +void pciDeviceSetUsedBy(pciDevice *dev, + const char *used_by); +const char *pciDeviceGetUsedBy(pciDevice *dev); +unsigned pciDeviceGetUnbindFromStub(pciDevice *dev); +void pciDeviceSetUnbindFromStub(pciDevice *dev, + unsigned unbind); +unsigned pciDeviceGetRemoveSlot(pciDevice *dev); +void pciDeviceSetRemoveSlot(pciDevice *dev, + unsigned remove_slot); +unsigned pciDeviceGetReprobe(pciDevice *dev); +void pciDeviceSetReprobe(pciDevice *dev, + unsigned reprobe); +void pciDeviceReAttachInit(pciDevice *dev); + +pciDeviceList *pciDeviceListNew (void); +void pciDeviceListFree (pciDeviceList *list); +int pciDeviceListAdd (pciDeviceList *list, + pciDevice *dev); +pciDevice * pciDeviceListGet (pciDeviceList *list, + int idx); +int pciDeviceListCount (pciDeviceList *list); +pciDevice * pciDeviceListSteal (pciDeviceList *list, + pciDevice *dev); +pciDevice * pciDeviceListStealIndex(pciDeviceList *list, + int idx); +void pciDeviceListDel (pciDeviceList *list, + pciDevice *dev); +pciDevice * pciDeviceListFind (pciDeviceList *list, + pciDevice *dev); +int pciDeviceListFindIndex(pciDeviceList *list, + pciDevice *dev); + +/* + * Callback that will be invoked once for each file + * associated with / used for PCI host device access. + * + * Should return 0 if successfully processed, or + * -1 to indicate error and abort iteration + */ +typedef int (*pciDeviceFileActor)(pciDevice *dev, + const char *path, void *opaque); + +int pciDeviceFileIterate(pciDevice *dev, + pciDeviceFileActor actor, + void *opaque); + +int pciDeviceIsAssignable(pciDevice *dev, + int strict_acs_check); +int pciWaitForDeviceCleanup(pciDevice *dev, const char *matcher); + +int pciGetPhysicalFunction(const char *sysfs_path, + struct pci_config_address **phys_fn); + +int pciGetVirtualFunctions(const char *sysfs_path, + struct pci_config_address ***virtual_functions, + unsigned int *num_virtual_functions); + +int pciDeviceIsVirtualFunction(const char *vf_sysfs_device_link); + +int pciGetVirtualFunctionIndex(const char *pf_sysfs_device_link, + const char *vf_sysfs_device_link, + int *vf_index); + +int pciConfigAddressToSysfsFile(struct pci_config_address *dev, + char **pci_sysfs_device_link); + +int pciDeviceNetName(char *device_link_sysfs_path, char **netname); + +int pciSysfsFile(char *pciDeviceName, char **pci_sysfs_device_link) + ATTRIBUTE_RETURN_CHECK; + +int pciGetDeviceAddrString(unsigned domain, + unsigned bus, + unsigned slot, + unsigned function, + char **pciConfigAddr) + ATTRIBUTE_NONNULL(5) ATTRIBUTE_RETURN_CHECK; + +int pciDeviceGetVirtualFunctionInfo(const char *vf_sysfs_device_path, + char **pfname, int *vf_index); + +#endif /* __VIR_PCI_H__ */ diff --git a/src/xen/xen_driver.c b/src/xen/xen_driver.c index 94df116..9b2fcf3 100644 --- a/src/xen/xen_driver.c +++ b/src/xen/xen_driver.c @@ -57,7 +57,7 @@ #include "util.h" #include "viralloc.h" #include "node_device_conf.h" -#include "pci.h" +#include "virpci.h" #include "uuid.h" #include "fdstream.h" #include "virfile.h" -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- cfg.mk | 2 +- po/POTFILES.in | 2 +- src/Makefile.am | 2 +- src/util/sexpr.c | 625 ------------------------------------------------ src/util/sexpr.h | 58 ----- src/util/virsexpr.c | 625 ++++++++++++++++++++++++++++++++++++++++++++++++ src/util/virsexpr.h | 58 +++++ src/xen/xend_internal.c | 2 +- src/xenxs/xen_sxpr.h | 2 +- src/xenxs/xen_xm.c | 2 +- 10 files changed, 689 insertions(+), 689 deletions(-) delete mode 100644 src/util/sexpr.c delete mode 100644 src/util/sexpr.h create mode 100644 src/util/virsexpr.c create mode 100644 src/util/virsexpr.h diff --git a/cfg.mk b/cfg.mk index e23f1c5..0a66797 100644 --- a/cfg.mk +++ b/cfg.mk @@ -807,7 +807,7 @@ exclude_file_name_regexp--sc_prohibit_sprintf = \ exclude_file_name_regexp--sc_prohibit_strncpy = ^src/util/util\.c$$ exclude_file_name_regexp--sc_prohibit_strtol = \ - ^src/(util/sexpr|(vbox|xen|xenxs)/.*)\.c$$ + ^src/(util/virsexpr|(vbox|xen|xenxs)/.*)\.c$$ exclude_file_name_regexp--sc_prohibit_xmlGetProp = ^src/util/xml\.c$$ diff --git a/po/POTFILES.in b/po/POTFILES.in index fb73807..2b09531 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -138,7 +138,6 @@ src/test/test_driver.c src/uml/uml_conf.c src/uml/uml_driver.c src/util/iohelper.c -src/util/sexpr.c src/util/stats_linux.c src/util/storage_file.c src/util/sysinfo.c @@ -173,6 +172,7 @@ src/util/virpci.c src/util/virpidfile.c src/util/virprocess.c src/util/virrandom.c +src/util/virsexpr.c src/util/virsocketaddr.c src/util/virterror.c src/util/virterror_internal.h diff --git a/src/Makefile.am b/src/Makefile.am index c0e35dc..c0dfd38 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -53,7 +53,6 @@ augeastest_DATA = # These files are not related to driver APIs. Simply generic # helper APIs for various purposes UTIL_SOURCES = \ - util/sexpr.c util/sexpr.h \ util/stats_linux.c util/stats_linux.h \ util/storage_file.c util/storage_file.h \ util/sysinfo.c util/sysinfo.h \ @@ -86,6 +85,7 @@ UTIL_SOURCES = \ util/virpci.c util/virpci.h \ util/virpidfile.c util/virpidfile.h \ util/virprocess.c util/virprocess.h \ + util/virsexpr.c util/virsexpr.h \ util/virtypedparam.c util/virtypedparam.h \ util/xml.c util/xml.h \ util/virterror.c util/virterror_internal.h \ diff --git a/src/util/sexpr.c b/src/util/sexpr.c deleted file mode 100644 index ae0cc18..0000000 --- a/src/util/sexpr.c +++ /dev/null @@ -1,625 +0,0 @@ -/* - * sexpr.c : S-Expression routines to communicate with the Xen Daemon - * - * Copyright (C) 2010-2011 Red Hat, Inc. - * Copyright (C) 2005 Anthony Liguori <aliguori(a)us.ibm.com&gt; - * - * This file is subject to the terms and conditions of the GNU Lesser General - * Public License. See the file COPYING.LIB in the main directory of this - * archive for more details. - */ - -#include <config.h> - -#include <stdio.h> -#include <stdlib.h> -#include <string.h> -#include "c-ctype.h" -#include <errno.h> - -#include "virterror_internal.h" -#include "sexpr.h" -#include "util.h" -#include "viralloc.h" - -#define VIR_FROM_THIS VIR_FROM_SEXPR - - -/** - * sexpr_new: - * - * Create a new S-Expression - * - * Returns the new node or NULL in case of memory allocation error - */ -static struct sexpr * -sexpr_new(void) -{ - struct sexpr *ret; - - if (VIR_ALLOC(ret) < 0) { - virReportOOMError(); - return NULL; - } - ret->kind = SEXPR_NIL; - return ret; -} - -/** - * sexpr_free: - * @sexpr: the S-Expression pointer - * - * Free an S-Expression - */ -void -sexpr_free(struct sexpr *sexpr) -{ - int serrno = errno; - - if (sexpr == NULL) { - return; - } - - switch (sexpr->kind) { - case SEXPR_CONS: - sexpr_free(sexpr->u.s.car); - sexpr_free(sexpr->u.s.cdr); - break; - case SEXPR_VALUE: - VIR_FREE(sexpr->u.value); - break; - case SEXPR_NIL: - break; - } - - VIR_FREE(sexpr); - - errno = serrno; -} - -/** - * sexpr_nil: - * - * Provide a NIL S-Expression (the pointer is not shared so NIL equality - * testing won't work at the pointer level). - * - * Returns a new NIL S-Expression of NULL in case of error. - */ -struct sexpr * -sexpr_nil(void) -{ - return sexpr_new(); -} - -/** - * sexpr_string: - * @str: the input string, assumed to be UTF-8 - * @len: the length in bytes of the input - * - * Parse the input S-Expression and return a pointer to the result - * - * Returns the S-Expression pointer or NULL in case of error - */ -struct sexpr * -sexpr_string(const char *str, ssize_t len) -{ - struct sexpr *ret = sexpr_new(); - - if (ret == NULL) - return ret; - ret->kind = SEXPR_VALUE; - if (len > 0) { - ret->u.value = strndup(str, len); - } else { - ret->u.value = strdup(str); - } - - if (ret->u.value == NULL) { - VIR_FREE(ret); - return NULL; - } - - return ret; -} - -/** - * sexpr_cons: - * @car: the left operand - * @cdr: the right operand - * - * Implement the CONS operation assembling 2 existing S-Expressions. - * Note that in case of error the input data are not freed. - * - * Returns the resulting S-Expression pointer or NULL in case of error. - */ -struct sexpr * -sexpr_cons(const struct sexpr *car, const struct sexpr *cdr) -{ - struct sexpr *ret = sexpr_new(); - - if (ret == NULL) - return ret; - ret->kind = SEXPR_CONS; - ret->u.s.car = (struct sexpr *) car; - ret->u.s.cdr = (struct sexpr *) cdr; - - return ret; -} - -/** - * append: - * @lst: an existing list - * @value: the value - * - * Internal operation appending a value at the end of an existing list - */ -static int -append(struct sexpr *lst, const struct sexpr *value) -{ - struct sexpr *nil = sexpr_nil(); - - if (nil == NULL) - return -1; - - while (lst->kind != SEXPR_NIL) { - lst = lst->u.s.cdr; - } - - lst->kind = SEXPR_CONS; - lst->u.s.car = (struct sexpr *) value; - lst->u.s.cdr = nil; - - return 0; -} - -/** - * @lst: an existing list - * @value: the value - * - * Append a value at the end of an existing list - * - * Returns lst or NULL in case of error - */ -struct sexpr * -sexpr_append(struct sexpr *lst, const struct sexpr *value) -{ - if (lst == NULL) - return NULL; - if (value == NULL) - return lst; - if (append(lst, value) < 0) - return NULL; - return lst; -} - -/** - * sexpr2string: - * @sexpr: an S-Expression pointer - * @buffer: the output buffer - * - * Serialize the S-Expression in the buffer. - * - * Returns 0 on success, -1 on error. - */ -int -sexpr2string(const struct sexpr *sexpr, virBufferPtr buffer) -{ - if ((sexpr == NULL) || (buffer == NULL)) - return -1; - - switch (sexpr->kind) { - case SEXPR_CONS: - virBufferAddChar(buffer, '('); - - if (sexpr2string(sexpr->u.s.car, buffer) < 0) - return -1; - - while (sexpr->u.s.cdr->kind != SEXPR_NIL) { - sexpr = sexpr->u.s.cdr; - - virBufferAddChar(buffer, ' '); - - if (sexpr2string(sexpr->u.s.car, buffer) < 0) - return -1; - } - - virBufferAddChar(buffer, ')'); - break; - case SEXPR_VALUE: - if (strchr(sexpr->u.value, ' ') || - strchr(sexpr->u.value, ')') || - strchr(sexpr->u.value, '(')) - virBufferAsprintf(buffer, "'%s'", sexpr->u.value); - else - virBufferAdd(buffer, sexpr->u.value, -1); - - break; - case SEXPR_NIL: - virBufferAddLit(buffer, "()"); - break; - default: - virReportError(VIR_ERR_SEXPR_SERIAL, - _("unknown s-expression kind %d"), sexpr->kind); - return -1; - } - - return 0; -} - -#define IS_SPACE(c) ((c == 0x20) || (c == 0x9) || (c == 0xD) || (c == 0xA)) - -static const char * -trim(const char *string) -{ - while (IS_SPACE(*string)) - string++; - return string; -} - -/** - * _string2sexpr: - * @buffer: a zero terminated buffer containing an S-Expression in UTF-8 - * @end: pointer to an index in the buffer for the already parsed bytes - * - * Internal routine implementing the parse of S-Expression - * Note that failure in this function is catastrophic. If it returns - * NULL, you've leaked memory and you're currently OOM. It will always - * parse an SEXPR given a buffer - * - * Returns a pointer to the resulting parsed S-Expression, or NULL in case of - * hard error. - */ -static struct sexpr * -_string2sexpr(const char *buffer, size_t * end) -{ - const char *ptr = buffer + *end; - struct sexpr *ret = sexpr_new(); - - if (ret == NULL) - return NULL; - - ptr = trim(ptr); - - if (ptr[0] == '(') { - ret->kind = SEXPR_NIL; - - ptr = trim(ptr + 1); - while (*ptr && *ptr != ')') { - struct sexpr *tmp; - size_t tmp_len = 0; - - tmp = _string2sexpr(ptr, &tmp_len); - if (tmp == NULL) - goto error; - if (append(ret, tmp) < 0) { - sexpr_free(tmp); - goto error; - } - ptr = trim(ptr + tmp_len); - } - - if (*ptr == ')') { - ptr++; - } - } else { - const char *start; - - if (*ptr == '\'') { - ptr++; - start = ptr; - - while (*ptr && *ptr != '\'') { - if (*ptr == '\\' && ptr[1]) - ptr++; - ptr++; - } - - ret->u.value = strndup(start, ptr - start); - if (ret->u.value == NULL) { - virReportOOMError(); - goto error; - } - - if (*ptr == '\'') - ptr++; - } else { - start = ptr; - - while (*ptr && !c_isspace(*ptr) - && *ptr != ')' && *ptr != '(') { - ptr++; - } - - ret->u.value = strndup(start, ptr - start); - if (ret->u.value == NULL) { - virReportOOMError(); - goto error; - } - } - - ret->kind = SEXPR_VALUE; - if (ret->u.value == NULL) - goto error; - } - - *end = ptr - buffer; - - return ret; - - error: - sexpr_free(ret); - return NULL; -} - -/** - * string2sexpr: - * @buffer: a zero terminated buffer containing an S-Expression in UTF-8 - * - * Parse the S-Expression in the buffer. - * Note that failure in this function is catastrophic. If it returns - * NULL, you've leaked memory and you're currently OOM. It will always - * parse an SEXPR given a buffer - * - * Returns a pointer to the resulting parsed S-Expression, or NULL in case of - * hard error. - */ -struct sexpr * -string2sexpr(const char *buffer) -{ - size_t dummy = 0; - - return _string2sexpr(buffer, &dummy); -} - - -/** - * sexpr_lookup_key: - * @sexpr: a pointer to a parsed S-Expression - * @node: a path for the sub expression to lookup in the S-Expression - * - * Search a sub expression in the S-Expression based on its path - * Returns the key node, rather than the data node. - * NOTE: path are limited to 4096 bytes. - * - * Returns the pointer to the sub expression or NULL if not found. - */ -static struct sexpr * -sexpr_lookup_key(const struct sexpr *sexpr, const char *node) -{ - struct sexpr *result = NULL; - char *buffer, *ptr, *token; - - if ((node == NULL) || (sexpr == NULL)) - return NULL; - - buffer = strdup(node); - - if (buffer == NULL) { - virReportOOMError(); - return NULL; - } - - ptr = buffer; - token = strsep(&ptr, "/"); - - if (sexpr->kind != SEXPR_CONS || sexpr->u.s.car->kind != SEXPR_VALUE) { - goto cleanup; - } - - if (STRNEQ(sexpr->u.s.car->u.value, token)) { - goto cleanup; - } - - for (token = strsep(&ptr, "/"); token; token = strsep(&ptr, "/")) { - const struct sexpr *i; - - sexpr = sexpr->u.s.cdr; - for (i = sexpr; i->kind != SEXPR_NIL; i = i->u.s.cdr) { - if (i->kind != SEXPR_CONS || - i->u.s.car->kind != SEXPR_CONS || - i->u.s.car->u.s.car->kind != SEXPR_VALUE) { - continue; - } - - if (STREQ(i->u.s.car->u.s.car->u.value, token)) { - sexpr = i->u.s.car; - break; - } - } - - if (i->kind == SEXPR_NIL) { - break; - } - } - - if (token != NULL) { - goto cleanup; - } - - result = (struct sexpr *) sexpr; - -cleanup: - VIR_FREE(buffer); - - return result; -} - -/** - * sexpr_lookup: - * @sexpr: a pointer to a parsed S-Expression - * @node: a path for the sub expression to lookup in the S-Expression - * - * Search a sub expression in the S-Expression based on its path. - * NOTE: path are limited to 4096 bytes. - * - * Returns the pointer to the sub expression or NULL if not found. - */ -struct sexpr * -sexpr_lookup(const struct sexpr *sexpr, const char *node) -{ - struct sexpr *s = sexpr_lookup_key(sexpr, node); - - if (s == NULL) - return NULL; - - if (s->kind != SEXPR_CONS || s->u.s.cdr->kind != SEXPR_CONS) - return NULL; - - return s->u.s.cdr; -} - -/** - * sexpr_has: - * @sexpr: a pointer to a parsed S-Expression - * @node: a path for the sub expression to lookup in the S-Expression - * - * Search a sub expression in the S-Expression based on its path. - * NOTE: path are limited to 4096 bytes. - * NB, even if the key was found sexpr_lookup may return NULL if - * the corresponding value was empty - * - * Returns true if the key was found, false otherwise - */ -int -sexpr_has(const struct sexpr *sexpr, const char *node) -{ - struct sexpr *s = sexpr_lookup_key(sexpr, node); - - if (s == NULL) - return 0; - - if (s->kind != SEXPR_CONS) - return 0; - - return 1; -} - -/** - * sexpr_node: - * @sexpr: a pointer to a parsed S-Expression - * @node: a path for the node to lookup in the S-Expression - * - * Search a node value in the S-Expression based on its path - * NOTE: path are limited to 4096 bytes. - * - * Returns the value of the node or NULL if not found. - */ -const char * -sexpr_node(const struct sexpr *sexpr, const char *node) -{ - struct sexpr *n = sexpr_lookup(sexpr, node); - - return (n && n->u.s.car->kind == SEXPR_VALUE) ? n->u.s.car->u.value : NULL; -} - -int sexpr_node_copy(const struct sexpr *sexpr, const char *node, char **dst) -{ - const char *val = sexpr_node(sexpr, node); - - if (val && *val) { - *dst = strdup(val); - if (!(*dst)) - return -1; - } else { - *dst = NULL; - } - return 0; -} - - -/** - * sexpr_fmt_node: - * @sexpr: a pointer to a parsed S-Expression - * @fmt: a path for the node to lookup in the S-Expression - * @... extra data to build the path - * - * Search a node value in the S-Expression based on its path - * - * Returns the value of the node or NULL if not found. - */ -const char * -sexpr_fmt_node(const struct sexpr *sexpr, const char *fmt, ...) -{ - int result; - va_list ap; - char *node; - const char *value; - - va_start(ap, fmt); - result = virVasprintf(&node, fmt, ap); - va_end(ap); - - if (result < 0) { - return NULL; - } - - value = sexpr_node(sexpr, node); - - VIR_FREE(node); - - return value; -} - -/** - * sexpr_int: - * @sexpr: an S-Expression - * @name: the name for the value - * - * convenience function to lookup an int value in the S-Expression - * - * Returns the value found or 0 if not found (but may not be an error). - * This function suffers from the flaw that zero is both a correct - * return value and an error indicator: careful! - */ -int -sexpr_int(const struct sexpr *sexpr, const char *name) -{ - const char *value = sexpr_node(sexpr, name); - - if (value) { - return strtol(value, NULL, 0); - } - return 0; -} - - -/** - * sexpr_float: - * @sexpr: an S-Expression - * @name: the name for the value - * - * convenience function to lookup a float value in the S-Expression - * - * Returns the value found or 0 if not found (but may not be an error) - */ -double -sexpr_float(const struct sexpr *sexpr, const char *name) -{ - const char *value = sexpr_node(sexpr, name); - - if (value) { - return strtod(value, NULL); - } - return 0; -} - -/** - * sexpr_u64: - * @sexpr: an S-Expression - * @name: the name for the value - * - * convenience function to lookup a 64bits unsigned int value in the - * S-Expression - * - * Returns the value found or 0 if not found (but may not be an error) - */ -uint64_t -sexpr_u64(const struct sexpr *sexpr, const char *name) -{ - const char *value = sexpr_node(sexpr, name); - - if (value) { - return strtoll(value, NULL, 0); - } - return 0; -} diff --git a/src/util/sexpr.h b/src/util/sexpr.h deleted file mode 100644 index 13ec481..0000000 --- a/src/util/sexpr.h +++ /dev/null @@ -1,58 +0,0 @@ -/* - * sexpr.h : S-Expression interfaces needed to communicate with the Xen Daemon - * - * Copyright (C) 2012 Red Hat, Inc. - * Copyright (C) 2005 Anthony Liguori <aliguori(a)us.ibm.com&gt; - * - * This file is subject to the terms and conditions of the GNU Lesser General - * Public License. See the file COPYING.LIB in the main directory of this - * archive for more details. - */ - -#ifndef _LIBVIR_SEXPR_H_ -# define _LIBVIR_SEXPR_H_ - -# include "internal.h" -# include "virbuffer.h" - -enum sexpr_type { - SEXPR_NIL, - SEXPR_CONS, - SEXPR_VALUE, -}; - -struct sexpr { - enum sexpr_type kind; - union { - struct { - struct sexpr *car; - struct sexpr *cdr; - } s; - char *value; - } u; -}; - -/* conversion to/from strings */ -int sexpr2string(const struct sexpr *sexpr, virBufferPtr buffer); -struct sexpr *string2sexpr(const char *buffer); - -/* constructors and destructors */ -struct sexpr *sexpr_nil(void); -struct sexpr *sexpr_string(const char *str, ssize_t len); -struct sexpr *sexpr_cons(const struct sexpr *car, const struct sexpr *cdr); -struct sexpr *sexpr_append(struct sexpr *lst, const struct sexpr *item); -void sexpr_free(struct sexpr *sexpr); - -/* lookup in S-Expressions */ -const char *sexpr_node(const struct sexpr *sexpr, const char *node); -int sexpr_node_copy(const struct sexpr *sexpr, const char *node, char **dst); -const char *sexpr_fmt_node(const struct sexpr *sexpr, const char *fmt, ...) - ATTRIBUTE_FMT_PRINTF(2,3); -struct sexpr *sexpr_lookup(const struct sexpr *sexpr, const char *node); -int sexpr_has(const struct sexpr *sexpr, const char *node); - -int sexpr_int(const struct sexpr *sexpr, const char *name); -double sexpr_float(const struct sexpr *sexpr, const char *name); -uint64_t sexpr_u64(const struct sexpr *sexpr, const char *name); - -#endif diff --git a/src/util/virsexpr.c b/src/util/virsexpr.c new file mode 100644 index 0000000..80c24c4 --- /dev/null +++ b/src/util/virsexpr.c @@ -0,0 +1,625 @@ +/* + * sexpr.c : S-Expression routines to communicate with the Xen Daemon + * + * Copyright (C) 2010-2011 Red Hat, Inc. + * Copyright (C) 2005 Anthony Liguori <aliguori(a)us.ibm.com&gt; + * + * This file is subject to the terms and conditions of the GNU Lesser General + * Public License. See the file COPYING.LIB in the main directory of this + * archive for more details. + */ + +#include <config.h> + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include "c-ctype.h" +#include <errno.h> + +#include "virterror_internal.h" +#include "virsexpr.h" +#include "util.h" +#include "viralloc.h" + +#define VIR_FROM_THIS VIR_FROM_SEXPR + + +/** + * sexpr_new: + * + * Create a new S-Expression + * + * Returns the new node or NULL in case of memory allocation error + */ +static struct sexpr * +sexpr_new(void) +{ + struct sexpr *ret; + + if (VIR_ALLOC(ret) < 0) { + virReportOOMError(); + return NULL; + } + ret->kind = SEXPR_NIL; + return ret; +} + +/** + * sexpr_free: + * @sexpr: the S-Expression pointer + * + * Free an S-Expression + */ +void +sexpr_free(struct sexpr *sexpr) +{ + int serrno = errno; + + if (sexpr == NULL) { + return; + } + + switch (sexpr->kind) { + case SEXPR_CONS: + sexpr_free(sexpr->u.s.car); + sexpr_free(sexpr->u.s.cdr); + break; + case SEXPR_VALUE: + VIR_FREE(sexpr->u.value); + break; + case SEXPR_NIL: + break; + } + + VIR_FREE(sexpr); + + errno = serrno; +} + +/** + * sexpr_nil: + * + * Provide a NIL S-Expression (the pointer is not shared so NIL equality + * testing won't work at the pointer level). + * + * Returns a new NIL S-Expression of NULL in case of error. + */ +struct sexpr * +sexpr_nil(void) +{ + return sexpr_new(); +} + +/** + * sexpr_string: + * @str: the input string, assumed to be UTF-8 + * @len: the length in bytes of the input + * + * Parse the input S-Expression and return a pointer to the result + * + * Returns the S-Expression pointer or NULL in case of error + */ +struct sexpr * +sexpr_string(const char *str, ssize_t len) +{ + struct sexpr *ret = sexpr_new(); + + if (ret == NULL) + return ret; + ret->kind = SEXPR_VALUE; + if (len > 0) { + ret->u.value = strndup(str, len); + } else { + ret->u.value = strdup(str); + } + + if (ret->u.value == NULL) { + VIR_FREE(ret); + return NULL; + } + + return ret; +} + +/** + * sexpr_cons: + * @car: the left operand + * @cdr: the right operand + * + * Implement the CONS operation assembling 2 existing S-Expressions. + * Note that in case of error the input data are not freed. + * + * Returns the resulting S-Expression pointer or NULL in case of error. + */ +struct sexpr * +sexpr_cons(const struct sexpr *car, const struct sexpr *cdr) +{ + struct sexpr *ret = sexpr_new(); + + if (ret == NULL) + return ret; + ret->kind = SEXPR_CONS; + ret->u.s.car = (struct sexpr *) car; + ret->u.s.cdr = (struct sexpr *) cdr; + + return ret; +} + +/** + * append: + * @lst: an existing list + * @value: the value + * + * Internal operation appending a value at the end of an existing list + */ +static int +append(struct sexpr *lst, const struct sexpr *value) +{ + struct sexpr *nil = sexpr_nil(); + + if (nil == NULL) + return -1; + + while (lst->kind != SEXPR_NIL) { + lst = lst->u.s.cdr; + } + + lst->kind = SEXPR_CONS; + lst->u.s.car = (struct sexpr *) value; + lst->u.s.cdr = nil; + + return 0; +} + +/** + * @lst: an existing list + * @value: the value + * + * Append a value at the end of an existing list + * + * Returns lst or NULL in case of error + */ +struct sexpr * +sexpr_append(struct sexpr *lst, const struct sexpr *value) +{ + if (lst == NULL) + return NULL; + if (value == NULL) + return lst; + if (append(lst, value) < 0) + return NULL; + return lst; +} + +/** + * sexpr2string: + * @sexpr: an S-Expression pointer + * @buffer: the output buffer + * + * Serialize the S-Expression in the buffer. + * + * Returns 0 on success, -1 on error. + */ +int +sexpr2string(const struct sexpr *sexpr, virBufferPtr buffer) +{ + if ((sexpr == NULL) || (buffer == NULL)) + return -1; + + switch (sexpr->kind) { + case SEXPR_CONS: + virBufferAddChar(buffer, '('); + + if (sexpr2string(sexpr->u.s.car, buffer) < 0) + return -1; + + while (sexpr->u.s.cdr->kind != SEXPR_NIL) { + sexpr = sexpr->u.s.cdr; + + virBufferAddChar(buffer, ' '); + + if (sexpr2string(sexpr->u.s.car, buffer) < 0) + return -1; + } + + virBufferAddChar(buffer, ')'); + break; + case SEXPR_VALUE: + if (strchr(sexpr->u.value, ' ') || + strchr(sexpr->u.value, ')') || + strchr(sexpr->u.value, '(')) + virBufferAsprintf(buffer, "'%s'", sexpr->u.value); + else + virBufferAdd(buffer, sexpr->u.value, -1); + + break; + case SEXPR_NIL: + virBufferAddLit(buffer, "()"); + break; + default: + virReportError(VIR_ERR_SEXPR_SERIAL, + _("unknown s-expression kind %d"), sexpr->kind); + return -1; + } + + return 0; +} + +#define IS_SPACE(c) ((c == 0x20) || (c == 0x9) || (c == 0xD) || (c == 0xA)) + +static const char * +trim(const char *string) +{ + while (IS_SPACE(*string)) + string++; + return string; +} + +/** + * _string2sexpr: + * @buffer: a zero terminated buffer containing an S-Expression in UTF-8 + * @end: pointer to an index in the buffer for the already parsed bytes + * + * Internal routine implementing the parse of S-Expression + * Note that failure in this function is catastrophic. If it returns + * NULL, you've leaked memory and you're currently OOM. It will always + * parse an SEXPR given a buffer + * + * Returns a pointer to the resulting parsed S-Expression, or NULL in case of + * hard error. + */ +static struct sexpr * +_string2sexpr(const char *buffer, size_t * end) +{ + const char *ptr = buffer + *end; + struct sexpr *ret = sexpr_new(); + + if (ret == NULL) + return NULL; + + ptr = trim(ptr); + + if (ptr[0] == '(') { + ret->kind = SEXPR_NIL; + + ptr = trim(ptr + 1); + while (*ptr && *ptr != ')') { + struct sexpr *tmp; + size_t tmp_len = 0; + + tmp = _string2sexpr(ptr, &tmp_len); + if (tmp == NULL) + goto error; + if (append(ret, tmp) < 0) { + sexpr_free(tmp); + goto error; + } + ptr = trim(ptr + tmp_len); + } + + if (*ptr == ')') { + ptr++; + } + } else { + const char *start; + + if (*ptr == '\'') { + ptr++; + start = ptr; + + while (*ptr && *ptr != '\'') { + if (*ptr == '\\' && ptr[1]) + ptr++; + ptr++; + } + + ret->u.value = strndup(start, ptr - start); + if (ret->u.value == NULL) { + virReportOOMError(); + goto error; + } + + if (*ptr == '\'') + ptr++; + } else { + start = ptr; + + while (*ptr && !c_isspace(*ptr) + && *ptr != ')' && *ptr != '(') { + ptr++; + } + + ret->u.value = strndup(start, ptr - start); + if (ret->u.value == NULL) { + virReportOOMError(); + goto error; + } + } + + ret->kind = SEXPR_VALUE; + if (ret->u.value == NULL) + goto error; + } + + *end = ptr - buffer; + + return ret; + + error: + sexpr_free(ret); + return NULL; +} + +/** + * string2sexpr: + * @buffer: a zero terminated buffer containing an S-Expression in UTF-8 + * + * Parse the S-Expression in the buffer. + * Note that failure in this function is catastrophic. If it returns + * NULL, you've leaked memory and you're currently OOM. It will always + * parse an SEXPR given a buffer + * + * Returns a pointer to the resulting parsed S-Expression, or NULL in case of + * hard error. + */ +struct sexpr * +string2sexpr(const char *buffer) +{ + size_t dummy = 0; + + return _string2sexpr(buffer, &dummy); +} + + +/** + * sexpr_lookup_key: + * @sexpr: a pointer to a parsed S-Expression + * @node: a path for the sub expression to lookup in the S-Expression + * + * Search a sub expression in the S-Expression based on its path + * Returns the key node, rather than the data node. + * NOTE: path are limited to 4096 bytes. + * + * Returns the pointer to the sub expression or NULL if not found. + */ +static struct sexpr * +sexpr_lookup_key(const struct sexpr *sexpr, const char *node) +{ + struct sexpr *result = NULL; + char *buffer, *ptr, *token; + + if ((node == NULL) || (sexpr == NULL)) + return NULL; + + buffer = strdup(node); + + if (buffer == NULL) { + virReportOOMError(); + return NULL; + } + + ptr = buffer; + token = strsep(&ptr, "/"); + + if (sexpr->kind != SEXPR_CONS || sexpr->u.s.car->kind != SEXPR_VALUE) { + goto cleanup; + } + + if (STRNEQ(sexpr->u.s.car->u.value, token)) { + goto cleanup; + } + + for (token = strsep(&ptr, "/"); token; token = strsep(&ptr, "/")) { + const struct sexpr *i; + + sexpr = sexpr->u.s.cdr; + for (i = sexpr; i->kind != SEXPR_NIL; i = i->u.s.cdr) { + if (i->kind != SEXPR_CONS || + i->u.s.car->kind != SEXPR_CONS || + i->u.s.car->u.s.car->kind != SEXPR_VALUE) { + continue; + } + + if (STREQ(i->u.s.car->u.s.car->u.value, token)) { + sexpr = i->u.s.car; + break; + } + } + + if (i->kind == SEXPR_NIL) { + break; + } + } + + if (token != NULL) { + goto cleanup; + } + + result = (struct sexpr *) sexpr; + +cleanup: + VIR_FREE(buffer); + + return result; +} + +/** + * sexpr_lookup: + * @sexpr: a pointer to a parsed S-Expression + * @node: a path for the sub expression to lookup in the S-Expression + * + * Search a sub expression in the S-Expression based on its path. + * NOTE: path are limited to 4096 bytes. + * + * Returns the pointer to the sub expression or NULL if not found. + */ +struct sexpr * +sexpr_lookup(const struct sexpr *sexpr, const char *node) +{ + struct sexpr *s = sexpr_lookup_key(sexpr, node); + + if (s == NULL) + return NULL; + + if (s->kind != SEXPR_CONS || s->u.s.cdr->kind != SEXPR_CONS) + return NULL; + + return s->u.s.cdr; +} + +/** + * sexpr_has: + * @sexpr: a pointer to a parsed S-Expression + * @node: a path for the sub expression to lookup in the S-Expression + * + * Search a sub expression in the S-Expression based on its path. + * NOTE: path are limited to 4096 bytes. + * NB, even if the key was found sexpr_lookup may return NULL if + * the corresponding value was empty + * + * Returns true if the key was found, false otherwise + */ +int +sexpr_has(const struct sexpr *sexpr, const char *node) +{ + struct sexpr *s = sexpr_lookup_key(sexpr, node); + + if (s == NULL) + return 0; + + if (s->kind != SEXPR_CONS) + return 0; + + return 1; +} + +/** + * sexpr_node: + * @sexpr: a pointer to a parsed S-Expression + * @node: a path for the node to lookup in the S-Expression + * + * Search a node value in the S-Expression based on its path + * NOTE: path are limited to 4096 bytes. + * + * Returns the value of the node or NULL if not found. + */ +const char * +sexpr_node(const struct sexpr *sexpr, const char *node) +{ + struct sexpr *n = sexpr_lookup(sexpr, node); + + return (n && n->u.s.car->kind == SEXPR_VALUE) ? n->u.s.car->u.value : NULL; +} + +int sexpr_node_copy(const struct sexpr *sexpr, const char *node, char **dst) +{ + const char *val = sexpr_node(sexpr, node); + + if (val && *val) { + *dst = strdup(val); + if (!(*dst)) + return -1; + } else { + *dst = NULL; + } + return 0; +} + + +/** + * sexpr_fmt_node: + * @sexpr: a pointer to a parsed S-Expression + * @fmt: a path for the node to lookup in the S-Expression + * @... extra data to build the path + * + * Search a node value in the S-Expression based on its path + * + * Returns the value of the node or NULL if not found. + */ +const char * +sexpr_fmt_node(const struct sexpr *sexpr, const char *fmt, ...) +{ + int result; + va_list ap; + char *node; + const char *value; + + va_start(ap, fmt); + result = virVasprintf(&node, fmt, ap); + va_end(ap); + + if (result < 0) { + return NULL; + } + + value = sexpr_node(sexpr, node); + + VIR_FREE(node); + + return value; +} + +/** + * sexpr_int: + * @sexpr: an S-Expression + * @name: the name for the value + * + * convenience function to lookup an int value in the S-Expression + * + * Returns the value found or 0 if not found (but may not be an error). + * This function suffers from the flaw that zero is both a correct + * return value and an error indicator: careful! + */ +int +sexpr_int(const struct sexpr *sexpr, const char *name) +{ + const char *value = sexpr_node(sexpr, name); + + if (value) { + return strtol(value, NULL, 0); + } + return 0; +} + + +/** + * sexpr_float: + * @sexpr: an S-Expression + * @name: the name for the value + * + * convenience function to lookup a float value in the S-Expression + * + * Returns the value found or 0 if not found (but may not be an error) + */ +double +sexpr_float(const struct sexpr *sexpr, const char *name) +{ + const char *value = sexpr_node(sexpr, name); + + if (value) { + return strtod(value, NULL); + } + return 0; +} + +/** + * sexpr_u64: + * @sexpr: an S-Expression + * @name: the name for the value + * + * convenience function to lookup a 64bits unsigned int value in the + * S-Expression + * + * Returns the value found or 0 if not found (but may not be an error) + */ +uint64_t +sexpr_u64(const struct sexpr *sexpr, const char *name) +{ + const char *value = sexpr_node(sexpr, name); + + if (value) { + return strtoll(value, NULL, 0); + } + return 0; +} diff --git a/src/util/virsexpr.h b/src/util/virsexpr.h new file mode 100644 index 0000000..13ec481 --- /dev/null +++ b/src/util/virsexpr.h @@ -0,0 +1,58 @@ +/* + * sexpr.h : S-Expression interfaces needed to communicate with the Xen Daemon + * + * Copyright (C) 2012 Red Hat, Inc. + * Copyright (C) 2005 Anthony Liguori <aliguori(a)us.ibm.com&gt; + * + * This file is subject to the terms and conditions of the GNU Lesser General + * Public License. See the file COPYING.LIB in the main directory of this + * archive for more details. + */ + +#ifndef _LIBVIR_SEXPR_H_ +# define _LIBVIR_SEXPR_H_ + +# include "internal.h" +# include "virbuffer.h" + +enum sexpr_type { + SEXPR_NIL, + SEXPR_CONS, + SEXPR_VALUE, +}; + +struct sexpr { + enum sexpr_type kind; + union { + struct { + struct sexpr *car; + struct sexpr *cdr; + } s; + char *value; + } u; +}; + +/* conversion to/from strings */ +int sexpr2string(const struct sexpr *sexpr, virBufferPtr buffer); +struct sexpr *string2sexpr(const char *buffer); + +/* constructors and destructors */ +struct sexpr *sexpr_nil(void); +struct sexpr *sexpr_string(const char *str, ssize_t len); +struct sexpr *sexpr_cons(const struct sexpr *car, const struct sexpr *cdr); +struct sexpr *sexpr_append(struct sexpr *lst, const struct sexpr *item); +void sexpr_free(struct sexpr *sexpr); + +/* lookup in S-Expressions */ +const char *sexpr_node(const struct sexpr *sexpr, const char *node); +int sexpr_node_copy(const struct sexpr *sexpr, const char *node, char **dst); +const char *sexpr_fmt_node(const struct sexpr *sexpr, const char *fmt, ...) + ATTRIBUTE_FMT_PRINTF(2,3); +struct sexpr *sexpr_lookup(const struct sexpr *sexpr, const char *node); +int sexpr_has(const struct sexpr *sexpr, const char *node); + +int sexpr_int(const struct sexpr *sexpr, const char *name); +double sexpr_float(const struct sexpr *sexpr, const char *name); +uint64_t sexpr_u64(const struct sexpr *sexpr, const char *name); + +#endif diff --git a/src/xen/xend_internal.c b/src/xen/xend_internal.c index a4005f4..6e8bc2f 100644 --- a/src/xen/xend_internal.c +++ b/src/xen/xend_internal.c @@ -35,7 +35,7 @@ #include "xend_internal.h" #include "driver.h" #include "util.h" -#include "sexpr.h" +#include "virsexpr.h" #include "xen_sxpr.h" #include "virbuffer.h" #include "uuid.h" diff --git a/src/xenxs/xen_sxpr.h b/src/xenxs/xen_sxpr.h index 4ff640c..d7ce46a 100644 --- a/src/xenxs/xen_sxpr.h +++ b/src/xenxs/xen_sxpr.h @@ -30,7 +30,7 @@ # include "internal.h" # include "virconf.h" # include "domain_conf.h" -# include "sexpr.h" +# include "virsexpr.h" typedef enum { XEND_CONFIG_VERSION_3_0_2 = 1, diff --git a/src/xenxs/xen_xm.c b/src/xenxs/xen_xm.c index 7d67bbe..c29df1c 100644 --- a/src/xenxs/xen_xm.c +++ b/src/xenxs/xen_xm.c @@ -31,7 +31,7 @@ #include "viralloc.h" #include "verify.h" #include "uuid.h" -#include "sexpr.h" +#include "virsexpr.h" #include "count-one-bits.h" #include "xenxs_private.h" #include "xen_xm.h" -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- po/POTFILES.in | 2 +- src/Makefile.am | 2 +- src/conf/domain_conf.c | 2 +- src/conf/domain_conf.h | 2 +- src/conf/snapshot_conf.c | 2 +- src/conf/storage_conf.c | 2 +- src/esx/esx_storage_backend_iscsi.c | 2 +- src/esx/esx_storage_backend_vmfs.c | 2 +- src/libxl/libxl_conf.c | 2 +- src/parallels/parallels_driver.c | 2 +- src/parallels/parallels_storage.c | 2 +- src/qemu/qemu_command.c | 2 +- src/qemu/qemu_domain.c | 2 +- src/qemu/qemu_driver.c | 2 +- src/qemu/qemu_hotplug.c | 2 +- src/qemu/qemu_migration.c | 2 +- src/security/security_dac.c | 2 +- src/security/security_selinux.c | 2 +- src/storage/storage_backend.c | 2 +- src/storage/storage_backend_fs.c | 2 +- src/util/storage_file.c | 1397 ----------------------------------- src/util/storage_file.h | 109 --- src/util/util.c | 2 +- src/util/virstoragefile.c | 1397 +++++++++++++++++++++++++++++++++++ src/util/virstoragefile.h | 109 +++ src/vbox/vbox_tmpl.c | 2 +- src/xenxs/xen_sxpr.c | 2 +- src/xenxs/xen_xm.c | 2 +- 28 files changed, 1530 insertions(+), 1530 deletions(-) delete mode 100644 src/util/storage_file.c delete mode 100644 src/util/storage_file.h create mode 100644 src/util/virstoragefile.c create mode 100644 src/util/virstoragefile.h diff --git a/po/POTFILES.in b/po/POTFILES.in index ecb4498..417f128 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -138,7 +138,6 @@ src/test/test_driver.c src/uml/uml_conf.c src/uml/uml_driver.c src/util/iohelper.c -src/util/storage_file.c src/util/sysinfo.c src/util/util.c src/util/viraudit.c @@ -174,6 +173,7 @@ src/util/virrandom.c src/util/virsexpr.c src/util/virsocketaddr.c src/util/virstatslinux.c +src/util/virstoragefile.c src/util/virterror.c src/util/virterror_internal.h src/util/virtime.c diff --git a/src/Makefile.am b/src/Makefile.am index feb4b77..911c041 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -53,7 +53,6 @@ augeastest_DATA = # These files are not related to driver APIs. Simply generic # helper APIs for various purposes UTIL_SOURCES = \ - util/storage_file.c util/storage_file.h \ util/sysinfo.c util/sysinfo.h \ util/threads.c util/threads.h \ util/threads-pthread.h \ @@ -86,6 +85,7 @@ UTIL_SOURCES = \ util/virprocess.c util/virprocess.h \ util/virsexpr.c util/virsexpr.h \ util/virstatslinux.c util/virstatslinux.h \ + util/virstoragefile.c util/virstoragefile.h \ util/virtypedparam.c util/virtypedparam.h \ util/xml.c util/xml.h \ util/virterror.c util/virterror_internal.h \ diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c index f80f5f1..b3c3557 100644 --- a/src/conf/domain_conf.c +++ b/src/conf/domain_conf.c @@ -42,7 +42,7 @@ #include "virbuffer.h" #include "virlog.h" #include "nwfilter_conf.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "virfile.h" #include "virbitmap.h" #include "count-one-bits.h" diff --git a/src/conf/domain_conf.h b/src/conf/domain_conf.h index 26d2264..6bac92f 100644 --- a/src/conf/domain_conf.h +++ b/src/conf/domain_conf.h @@ -47,7 +47,7 @@ # include "virobject.h" # include "device_conf.h" # include "virbitmap.h" -# include "storage_file.h" +# include "virstoragefile.h" /* forward declarations of all device types, required by * virDomainDeviceDef diff --git a/src/conf/snapshot_conf.c b/src/conf/snapshot_conf.c index 9c16a88..5c40e97 100644 --- a/src/conf/snapshot_conf.c +++ b/src/conf/snapshot_conf.c @@ -41,7 +41,7 @@ #include "nwfilter_conf.h" #include "secret_conf.h" #include "snapshot_conf.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "util.h" #include "uuid.h" #include "virfile.h" diff --git a/src/conf/storage_conf.c b/src/conf/storage_conf.c index 0e00588..5cd2393 100644 --- a/src/conf/storage_conf.c +++ b/src/conf/storage_conf.c @@ -36,7 +36,7 @@ #include "virterror_internal.h" #include "datatypes.h" #include "storage_conf.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "xml.h" #include "uuid.h" diff --git a/src/esx/esx_storage_backend_iscsi.c b/src/esx/esx_storage_backend_iscsi.c index 9d481d2..5ad885a 100644 --- a/src/esx/esx_storage_backend_iscsi.c +++ b/src/esx/esx_storage_backend_iscsi.c @@ -33,7 +33,7 @@ #include "virlog.h" #include "uuid.h" #include "storage_conf.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "esx_storage_backend_iscsi.h" #include "esx_private.h" #include "esx_vi.h" diff --git a/src/esx/esx_storage_backend_vmfs.c b/src/esx/esx_storage_backend_vmfs.c index bca637b..4886fc3 100644 --- a/src/esx/esx_storage_backend_vmfs.c +++ b/src/esx/esx_storage_backend_vmfs.c @@ -36,7 +36,7 @@ #include "virlog.h" #include "uuid.h" #include "storage_conf.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "esx_storage_backend_vmfs.h" #include "esx_private.h" #include "esx_vi.h" diff --git a/src/libxl/libxl_conf.c b/src/libxl/libxl_conf.c index ac55cf3..eb6738c 100644 --- a/src/libxl/libxl_conf.c +++ b/src/libxl/libxl_conf.c @@ -43,7 +43,7 @@ #include "libxl_driver.h" #include "libxl_conf.h" #include "libxl_utils.h" -#include "storage_file.h" +#include "virstoragefile.h" #define VIR_FROM_THIS VIR_FROM_LIBXL diff --git a/src/parallels/parallels_driver.c b/src/parallels/parallels_driver.c index 2d3dc4a..07c1463 100644 --- a/src/parallels/parallels_driver.c +++ b/src/parallels/parallels_driver.c @@ -48,7 +48,7 @@ #include "virlog.h" #include "vircommand.h" #include "configmake.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "nodeinfo.h" #include "c-ctype.h" diff --git a/src/parallels/parallels_storage.c b/src/parallels/parallels_storage.c index f546d28..0e6c100 100644 --- a/src/parallels/parallels_storage.c +++ b/src/parallels/parallels_storage.c @@ -33,7 +33,7 @@ #include "datatypes.h" #include "viralloc.h" #include "configmake.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "virterror_internal.h" #include "parallels_utils.h" diff --git a/src/qemu/qemu_command.c b/src/qemu/qemu_command.c index 8a57cb5..464288f 100644 --- a/src/qemu/qemu_command.c +++ b/src/qemu/qemu_command.c @@ -43,7 +43,7 @@ #include "virnetdevtap.h" #include "base64.h" #include "device_conf.h" -#include "storage_file.h" +#include "virstoragefile.h" #include <sys/utsname.h> #include <sys/stat.h> diff --git a/src/qemu/qemu_domain.c b/src/qemu/qemu_domain.c index 8dcadbc..3e1081a 100644 --- a/src/qemu/qemu_domain.c +++ b/src/qemu/qemu_domain.c @@ -36,7 +36,7 @@ #include "virfile.h" #include "domain_event.h" #include "virtime.h" -#include "storage_file.h" +#include "virstoragefile.h" #include <sys/time.h> #include <fcntl.h> diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c index c5bd054..fd36dfc 100644 --- a/src/qemu/qemu_driver.c +++ b/src/qemu/qemu_driver.c @@ -81,7 +81,7 @@ #include "sysinfo.h" #include "domain_nwfilter.h" #include "virhooks.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "virfile.h" #include "fdstream.h" #include "configmake.h" diff --git a/src/qemu/qemu_hotplug.c b/src/qemu/qemu_hotplug.c index e120988..e5b28da 100644 --- a/src/qemu/qemu_hotplug.c +++ b/src/qemu/qemu_hotplug.c @@ -45,7 +45,7 @@ #include "virnetdevbridge.h" #include "virnetdevtap.h" #include "device_conf.h" -#include "storage_file.h" +#include "virstoragefile.h" #define VIR_FROM_THIS VIR_FROM_QEMU diff --git a/src/qemu/qemu_migration.c b/src/qemu/qemu_migration.c index 3e9ff03..a77beb6 100644 --- a/src/qemu/qemu_migration.c +++ b/src/qemu/qemu_migration.c @@ -47,7 +47,7 @@ #include "virtime.h" #include "locking/domain_lock.h" #include "rpc/virnetsocket.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "viruri.h" #include "virhooks.h" diff --git a/src/security/security_dac.c b/src/security/security_dac.c index e4f016a..f9752ef 100644 --- a/src/security/security_dac.c +++ b/src/security/security_dac.c @@ -30,7 +30,7 @@ #include "virlog.h" #include "virpci.h" #include "virusb.h" -#include "storage_file.h" +#include "virstoragefile.h" #define VIR_FROM_THIS VIR_FROM_SECURITY #define SECURITY_DAC_NAME "dac" diff --git a/src/security/security_selinux.c b/src/security/security_selinux.c index 2adf5c9..8918257 100644 --- a/src/security/security_selinux.c +++ b/src/security/security_selinux.c @@ -39,7 +39,7 @@ #include "virlog.h" #include "virpci.h" #include "virusb.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "virfile.h" #include "virhash.h" #include "virrandom.h" diff --git a/src/storage/storage_backend.c b/src/storage/storage_backend.c index cdc5bda..9b98dbb 100644 --- a/src/storage/storage_backend.c +++ b/src/storage/storage_backend.c @@ -52,7 +52,7 @@ #include "internal.h" #include "secret_conf.h" #include "uuid.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "storage_backend.h" #include "virlog.h" #include "virfile.h" diff --git a/src/storage/storage_backend_fs.c b/src/storage/storage_backend_fs.c index f7b4656..b744fb4 100644 --- a/src/storage/storage_backend_fs.c +++ b/src/storage/storage_backend_fs.c @@ -44,7 +44,7 @@ #include "virterror_internal.h" #include "storage_backend_fs.h" #include "storage_conf.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "vircommand.h" #include "viralloc.h" #include "xml.h" diff --git a/src/util/storage_file.c b/src/util/storage_file.c deleted file mode 100644 index a020bb2..0000000 --- a/src/util/storage_file.c +++ /dev/null @@ -1,1397 +0,0 @@ -/* - * storage_file.c: file utility functions for FS storage backend - * - * Copyright (C) 2007-2012 Red Hat, Inc. - * Copyright (C) 2007-2008 Daniel P. Berrange - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Author: Daniel P. Berrange <berrange(a)redhat.com&gt; - */ - -#include <config.h> -#include "storage_file.h" - -#include <sys/stat.h> -#include <unistd.h> -#include <fcntl.h> -#include <stdlib.h> -#ifdef __linux__ -# if HAVE_LINUX_MAGIC_H -# include <linux/magic.h> -# endif -# include <sys/statfs.h> -#endif -#include "dirname.h" -#include "viralloc.h" -#include "virterror_internal.h" -#include "virlog.h" -#include "virfile.h" -#include "c-ctype.h" -#include "vircommand.h" -#include "virhash.h" - -#define VIR_FROM_THIS VIR_FROM_STORAGE - -VIR_ENUM_IMPL(virStorageFileFormat, - VIR_STORAGE_FILE_LAST, - "none", - "raw", "dir", "bochs", - "cloop", "cow", "dmg", "iso", - "qcow", "qcow2", "qed", "vmdk", "vpc", - "fat", "vhd") - -enum lv_endian { - LV_LITTLE_ENDIAN = 1, /* 1234 */ - LV_BIG_ENDIAN /* 4321 */ -}; - -enum { - BACKING_STORE_OK, - BACKING_STORE_INVALID, - BACKING_STORE_ERROR, -}; - -/* Either 'magic' or 'extension' *must* be provided */ -struct FileTypeInfo { - const char *magic; /* Optional string of file magic - * to check at head of file */ - const char *extension; /* Optional file extension to check */ - enum lv_endian endian; /* Endianness of file format */ - int versionOffset; /* Byte offset from start of file - * where we find version number, - * -1 to skip version test */ - int versionNumber; /* Version number to validate */ - int sizeOffset; /* Byte offset from start of file - * where we find capacity info, - * -1 to use st_size as capacity */ - int sizeBytes; /* Number of bytes for size field */ - int sizeMultiplier; /* A scaling factor if size is not in bytes */ - /* Store a COW base image path (possibly relative), - * or NULL if there is no COW base image, to RES; - * return BACKING_STORE_* */ - int qcowCryptOffset; /* Byte offset from start of file - * where to find encryption mode, - * -1 if encryption is not used */ - int (*getBackingStore)(char **res, int *format, - const unsigned char *buf, size_t buf_size); -}; - -static int cowGetBackingStore(char **, int *, - const unsigned char *, size_t); -static int qcow1GetBackingStore(char **, int *, - const unsigned char *, size_t); -static int qcow2GetBackingStore(char **, int *, - const unsigned char *, size_t); -static int vmdk4GetBackingStore(char **, int *, - const unsigned char *, size_t); -static int -qedGetBackingStore(char **, int *, const unsigned char *, size_t); - -#define QCOWX_HDR_VERSION (4) -#define QCOWX_HDR_BACKING_FILE_OFFSET (QCOWX_HDR_VERSION+4) -#define QCOWX_HDR_BACKING_FILE_SIZE (QCOWX_HDR_BACKING_FILE_OFFSET+8) -#define QCOWX_HDR_IMAGE_SIZE (QCOWX_HDR_BACKING_FILE_SIZE+4+4) - -#define QCOW1_HDR_CRYPT (QCOWX_HDR_IMAGE_SIZE+8+1+1) -#define QCOW2_HDR_CRYPT (QCOWX_HDR_IMAGE_SIZE+8) - -#define QCOW1_HDR_TOTAL_SIZE (QCOW1_HDR_CRYPT+4+8) -#define QCOW2_HDR_TOTAL_SIZE (QCOW2_HDR_CRYPT+4+4+8+8+4+4+8) - -#define QCOW2_HDR_EXTENSION_END 0 -#define QCOW2_HDR_EXTENSION_BACKING_FORMAT 0xE2792ACA - -#define QED_HDR_FEATURES_OFFSET (4+4+4+4) -#define QED_HDR_IMAGE_SIZE (QED_HDR_FEATURES_OFFSET+8+8+8+8) -#define QED_HDR_BACKING_FILE_OFFSET (QED_HDR_IMAGE_SIZE+8) -#define QED_HDR_BACKING_FILE_SIZE (QED_HDR_BACKING_FILE_OFFSET+4) -#define QED_F_BACKING_FILE 0x01 -#define QED_F_BACKING_FORMAT_NO_PROBE 0x04 - -/* VMDK needs at least this to find backing store, - * other formats need less */ -#define STORAGE_MAX_HEAD (20*512) - - -static struct FileTypeInfo const fileTypeInfo[] = { - [VIR_STORAGE_FILE_NONE] = { NULL, NULL, LV_LITTLE_ENDIAN, - -1, 0, 0, 0, 0, 0, NULL }, - [VIR_STORAGE_FILE_RAW] = { NULL, NULL, LV_LITTLE_ENDIAN, - -1, 0, 0, 0, 0, 0, NULL }, - [VIR_STORAGE_FILE_DIR] = { NULL, NULL, LV_LITTLE_ENDIAN, - -1, 0, 0, 0, 0, 0, NULL }, - [VIR_STORAGE_FILE_BOCHS] = { - /*"Bochs Virtual HD Image", */ /* Untested */ NULL, - NULL, - LV_LITTLE_ENDIAN, 64, 0x20000, - 32+16+16+4+4+4+4+4, 8, 1, -1, NULL - }, - [VIR_STORAGE_FILE_CLOOP] = { - /*"#!/bin/sh\n#V2.0 Format\nmodprobe cloop file=$0 && mount -r -t iso9660 /dev/cloop $1\n", */ /* Untested */ NULL, - NULL, - LV_LITTLE_ENDIAN, -1, 0, - -1, 0, 0, -1, NULL - }, - [VIR_STORAGE_FILE_COW] = { - "OOOM", NULL, - LV_BIG_ENDIAN, 4, 2, - 4+4+1024+4, 8, 1, -1, cowGetBackingStore - }, - [VIR_STORAGE_FILE_DMG] = { - NULL, /* XXX QEMU says there's no magic for dmg, but we should check... */ - ".dmg", - 0, -1, 0, - -1, 0, 0, -1, NULL - }, - [VIR_STORAGE_FILE_ISO] = { - NULL, /* XXX there's probably some magic for iso we can validate too... */ - ".iso", - 0, -1, 0, - -1, 0, 0, -1, NULL - }, - [VIR_STORAGE_FILE_QCOW] = { - "QFI", NULL, - LV_BIG_ENDIAN, 4, 1, - QCOWX_HDR_IMAGE_SIZE, 8, 1, QCOW1_HDR_CRYPT, qcow1GetBackingStore, - }, - [VIR_STORAGE_FILE_QCOW2] = { - "QFI", NULL, - LV_BIG_ENDIAN, 4, 2, - QCOWX_HDR_IMAGE_SIZE, 8, 1, QCOW2_HDR_CRYPT, qcow2GetBackingStore, - }, - [VIR_STORAGE_FILE_QED] = { - /* http://wiki.qemu.org/Features/QED */ - "QED", NULL, - LV_LITTLE_ENDIAN, -2, -1, - QED_HDR_IMAGE_SIZE, 8, 1, -1, qedGetBackingStore, - }, - [VIR_STORAGE_FILE_VMDK] = { - "KDMV", NULL, - LV_LITTLE_ENDIAN, 4, 1, - 4+4+4, 8, 512, -1, vmdk4GetBackingStore - }, - [VIR_STORAGE_FILE_VPC] = { - "conectix", NULL, - LV_BIG_ENDIAN, 12, 0x10000, - 8 + 4 + 4 + 8 + 4 + 4 + 2 + 2 + 4, 8, 1, -1, NULL - }, - /* Not direct file formats, but used for various drivers */ - [VIR_STORAGE_FILE_FAT] = { NULL, NULL, LV_LITTLE_ENDIAN, - -1, 0, 0, 0, 0, 0, NULL }, - [VIR_STORAGE_FILE_VHD] = { NULL, NULL, LV_LITTLE_ENDIAN, - -1, 0, 0, 0, 0, 0, NULL }, -}; -verify(ARRAY_CARDINALITY(fileTypeInfo) == VIR_STORAGE_FILE_LAST); - -static int -cowGetBackingStore(char **res, - int *format, - const unsigned char *buf, - size_t buf_size) -{ -#define COW_FILENAME_MAXLEN 1024 - *res = NULL; - *format = VIR_STORAGE_FILE_AUTO; - - if (buf_size < 4+4+ COW_FILENAME_MAXLEN) - return BACKING_STORE_INVALID; - if (buf[4+4] == '\0') { /* cow_header_v2.backing_file[0] */ - *format = VIR_STORAGE_FILE_NONE; - return BACKING_STORE_OK; - } - - *res = strndup((const char*)buf + 4+4, COW_FILENAME_MAXLEN); - if (*res == NULL) { - virReportOOMError(); - return BACKING_STORE_ERROR; - } - return BACKING_STORE_OK; -} - - -static int -qcow2GetBackingStoreFormat(int *format, - const unsigned char *buf, - size_t buf_size, - size_t extension_start, - size_t extension_end) -{ - size_t offset = extension_start; - - /* - * The extensions take format of - * - * int32: magic - * int32: length - * byte[length]: payload - * - * Unknown extensions can be ignored by skipping - * over "length" bytes in the data stream. - */ - while (offset < (buf_size-8) && - offset < (extension_end-8)) { - unsigned int magic = - (buf[offset] << 24) + - (buf[offset+1] << 16) + - (buf[offset+2] << 8) + - (buf[offset+3]); - unsigned int len = - (buf[offset+4] << 24) + - (buf[offset+5] << 16) + - (buf[offset+6] << 8) + - (buf[offset+7]); - - offset += 8; - - if ((offset + len) < offset) - break; - - if ((offset + len) > buf_size) - break; - - switch (magic) { - case QCOW2_HDR_EXTENSION_END: - goto done; - - case QCOW2_HDR_EXTENSION_BACKING_FORMAT: - if (buf[offset+len] != '\0') - break; - *format = virStorageFileFormatTypeFromString( - ((const char *)buf)+offset); - if (*format <= VIR_STORAGE_FILE_NONE) - return -1; - } - - offset += len; - } - -done: - - return 0; -} - - -static int -qcowXGetBackingStore(char **res, - int *format, - const unsigned char *buf, - size_t buf_size, - bool isQCow2) -{ - unsigned long long offset; - unsigned int size; - - *res = NULL; - if (format) - *format = VIR_STORAGE_FILE_AUTO; - - if (buf_size < QCOWX_HDR_BACKING_FILE_OFFSET+8+4) - return BACKING_STORE_INVALID; - offset = (((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET] << 56) - | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+1] << 48) - | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+2] << 40) - | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+3] << 32) - | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+4] << 24) - | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+5] << 16) - | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+6] << 8) - | buf[QCOWX_HDR_BACKING_FILE_OFFSET+7]); /* QCowHeader.backing_file_offset */ - if (offset > buf_size) - return BACKING_STORE_INVALID; - size = ((buf[QCOWX_HDR_BACKING_FILE_SIZE] << 24) - | (buf[QCOWX_HDR_BACKING_FILE_SIZE+1] << 16) - | (buf[QCOWX_HDR_BACKING_FILE_SIZE+2] << 8) - | buf[QCOWX_HDR_BACKING_FILE_SIZE+3]); /* QCowHeader.backing_file_size */ - if (size == 0) { - if (format) - *format = VIR_STORAGE_FILE_NONE; - return BACKING_STORE_OK; - } - if (offset + size > buf_size || offset + size < offset) - return BACKING_STORE_INVALID; - if (size + 1 == 0) - return BACKING_STORE_INVALID; - if (VIR_ALLOC_N(*res, size + 1) < 0) { - virReportOOMError(); - return BACKING_STORE_ERROR; - } - memcpy(*res, buf + offset, size); - (*res)[size] = '\0'; - - /* - * Traditionally QCow2 files had a layout of - * - * [header] - * [backingStoreName] - * - * Although the backingStoreName typically followed - * the header immediately, this was not required by - * the format. By specifying a higher byte offset for - * the backing file offset in the header, it was - * possible to leave space between the header and - * start of backingStore. - * - * This hack is now used to store extensions to the - * qcow2 format: - * - * [header] - * [extensions] - * [backingStoreName] - * - * Thus the file region to search for extensions is - * between the end of the header (QCOW2_HDR_TOTAL_SIZE) - * and the start of the backingStoreName (offset) - */ - if (isQCow2 && format && - qcow2GetBackingStoreFormat(format, buf, buf_size, QCOW2_HDR_TOTAL_SIZE, - offset) < 0) - return BACKING_STORE_INVALID; - - return BACKING_STORE_OK; -} - - -static int -qcow1GetBackingStore(char **res, - int *format, - const unsigned char *buf, - size_t buf_size) -{ - int ret; - - /* QCow1 doesn't have the extensions capability - * used to store backing format */ - *format = VIR_STORAGE_FILE_AUTO; - ret = qcowXGetBackingStore(res, NULL, buf, buf_size, false); - if (ret == 0 && *buf == '\0') - *format = VIR_STORAGE_FILE_NONE; - return ret; -} - -static int -qcow2GetBackingStore(char **res, - int *format, - const unsigned char *buf, - size_t buf_size) -{ - return qcowXGetBackingStore(res, format, buf, buf_size, true); -} - - -static int -vmdk4GetBackingStore(char **res, - int *format, - const unsigned char *buf, - size_t buf_size) -{ - static const char prefix[] = "parentFileNameHint=\""; - char *desc, *start, *end; - size_t len; - int ret = BACKING_STORE_ERROR; - - if (VIR_ALLOC_N(desc, STORAGE_MAX_HEAD + 1) < 0) { - virReportOOMError(); - goto cleanup; - } - - *res = NULL; - /* - * Technically this should have been VMDK, since - * VMDK spec / VMWare impl only support VMDK backed - * by VMDK. QEMU isn't following this though and - * does probing on VMDK backing files, hence we set - * AUTO - */ - *format = VIR_STORAGE_FILE_AUTO; - - if (buf_size <= 0x200) { - ret = BACKING_STORE_INVALID; - goto cleanup; - } - len = buf_size - 0x200; - if (len > STORAGE_MAX_HEAD) - len = STORAGE_MAX_HEAD; - memcpy(desc, buf + 0x200, len); - desc[len] = '\0'; - start = strstr(desc, prefix); - if (start == NULL) { - *format = VIR_STORAGE_FILE_NONE; - ret = BACKING_STORE_OK; - goto cleanup; - } - start += strlen(prefix); - end = strchr(start, '"'); - if (end == NULL) { - ret = BACKING_STORE_INVALID; - goto cleanup; - } - if (end == start) { - *format = VIR_STORAGE_FILE_NONE; - ret = BACKING_STORE_OK; - goto cleanup; - } - *end = '\0'; - *res = strdup(start); - if (*res == NULL) { - virReportOOMError(); - goto cleanup; - } - - ret = BACKING_STORE_OK; - -cleanup: - VIR_FREE(desc); - return ret; -} - -static unsigned long -qedGetHeaderUL(const unsigned char *loc) -{ - return (((unsigned long)loc[3] << 24) | - ((unsigned long)loc[2] << 16) | - ((unsigned long)loc[1] << 8) | - ((unsigned long)loc[0] << 0)); -} - -static unsigned long long -qedGetHeaderULL(const unsigned char *loc) -{ - return (((unsigned long long)loc[7] << 56) | - ((unsigned long long)loc[6] << 48) | - ((unsigned long long)loc[5] << 40) | - ((unsigned long long)loc[4] << 32) | - ((unsigned long long)loc[3] << 24) | - ((unsigned long long)loc[2] << 16) | - ((unsigned long long)loc[1] << 8) | - ((unsigned long long)loc[0] << 0)); -} - -static int -qedGetBackingStore(char **res, - int *format, - const unsigned char *buf, - size_t buf_size) -{ - unsigned long long flags; - unsigned long offset, size; - - *res = NULL; - /* Check if this image has a backing file */ - if (buf_size < QED_HDR_FEATURES_OFFSET+8) - return BACKING_STORE_INVALID; - flags = qedGetHeaderULL(buf + QED_HDR_FEATURES_OFFSET); - if (!(flags & QED_F_BACKING_FILE)) { - *format = VIR_STORAGE_FILE_NONE; - return BACKING_STORE_OK; - } - - /* Parse the backing file */ - if (buf_size < QED_HDR_BACKING_FILE_OFFSET+8) - return BACKING_STORE_INVALID; - offset = qedGetHeaderUL(buf + QED_HDR_BACKING_FILE_OFFSET); - if (offset > buf_size) - return BACKING_STORE_INVALID; - size = qedGetHeaderUL(buf + QED_HDR_BACKING_FILE_SIZE); - if (size == 0) - return BACKING_STORE_OK; - if (offset + size > buf_size || offset + size < offset) - return BACKING_STORE_INVALID; - if (VIR_ALLOC_N(*res, size + 1) < 0) { - virReportOOMError(); - return BACKING_STORE_ERROR; - } - memcpy(*res, buf + offset, size); - (*res)[size] = '\0'; - - if (flags & QED_F_BACKING_FORMAT_NO_PROBE) - *format = VIR_STORAGE_FILE_RAW; - else - *format = VIR_STORAGE_FILE_AUTO_SAFE; - - return BACKING_STORE_OK; -} - -/** - * Return an absolute path corresponding to PATH, which is absolute or relative - * to the directory containing BASE_FILE, or NULL on error - */ -static char * -absolutePathFromBaseFile(const char *base_file, const char *path) -{ - char *res = NULL; - char *tmp = NULL; - size_t d_len = dir_len(base_file); - - /* If path is already absolute, or if dirname(base_file) is ".", - just return a copy of path. */ - if (*path == '/' || d_len == 0) { - if (!(res = canonicalize_file_name(path))) - virReportSystemError(errno, - _("Can't canonicalize path '%s'"), path); - - goto cleanup; - } - - /* Ensure that the following cast-to-int is valid. */ - if (d_len > INT_MAX) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Directory name too long: '%s'"), base_file); - goto cleanup; - } - - if (virAsprintf(&tmp, "%.*s/%s", (int) d_len, base_file, path) < 0) { - virReportOOMError(); - goto cleanup; - } - - if (!(res = canonicalize_file_name(tmp))) - virReportSystemError(errno, _("Can't canonicalize path '%s'"), path); - -cleanup: - VIR_FREE(tmp); - return res; -} - - -static bool -virStorageFileMatchesMagic(int format, - unsigned char *buf, - size_t buflen) -{ - int mlen; - - if (fileTypeInfo[format].magic == NULL) - return false; - - /* Validate magic data */ - mlen = strlen(fileTypeInfo[format].magic); - if (mlen > buflen) - return false; - - if (memcmp(buf, fileTypeInfo[format].magic, mlen) != 0) - return false; - - return true; -} - - -static bool -virStorageFileMatchesExtension(int format, - const char *path) -{ - if (fileTypeInfo[format].extension == NULL) - return false; - - if (virFileHasSuffix(path, fileTypeInfo[format].extension)) - return true; - - return false; -} - - -static bool -virStorageFileMatchesVersion(int format, - unsigned char *buf, - size_t buflen) -{ - int version; - - /* Validate version number info */ - if (fileTypeInfo[format].versionOffset == -1) - return false; - - /* -2 == non-versioned file format, so trivially match */ - if (fileTypeInfo[format].versionOffset == -2) - return true; - - if ((fileTypeInfo[format].versionOffset + 4) > buflen) - return false; - - if (fileTypeInfo[format].endian == LV_LITTLE_ENDIAN) { - version = - (buf[fileTypeInfo[format].versionOffset+3] << 24) | - (buf[fileTypeInfo[format].versionOffset+2] << 16) | - (buf[fileTypeInfo[format].versionOffset+1] << 8) | - (buf[fileTypeInfo[format].versionOffset]); - } else { - version = - (buf[fileTypeInfo[format].versionOffset] << 24) | - (buf[fileTypeInfo[format].versionOffset+1] << 16) | - (buf[fileTypeInfo[format].versionOffset+2] << 8) | - (buf[fileTypeInfo[format].versionOffset+3]); - } - - VIR_DEBUG("Compare detected version %d vs expected version %d", - version, fileTypeInfo[format].versionNumber); - if (version != fileTypeInfo[format].versionNumber) - return false; - - return true; -} - -static bool -virBackingStoreIsFile(const char *backing) -{ - /* Backing store is a network block device or Rados block device */ - if (STRPREFIX(backing, "nbd:") || STRPREFIX(backing, "rbd:")) - return false; - return true; -} - -static int -virStorageFileGetMetadataFromBuf(int format, - const char *path, - unsigned char *buf, - size_t buflen, - virStorageFileMetadata *meta) -{ - VIR_DEBUG("path=%s format=%d", path, format); - - /* XXX we should consider moving virStorageBackendUpdateVolInfo - * code into this method, for non-magic files - */ - if (format <= VIR_STORAGE_FILE_NONE || - format >= VIR_STORAGE_FILE_LAST || - !fileTypeInfo[format].magic) { - return 0; - } - - /* Optionally extract capacity from file */ - if (fileTypeInfo[format].sizeOffset != -1) { - if ((fileTypeInfo[format].sizeOffset + 8) > buflen) - return 1; - - if (fileTypeInfo[format].endian == LV_LITTLE_ENDIAN) { - meta->capacity = - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+7] << 56) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+6] << 48) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+5] << 40) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+4] << 32) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+3] << 24) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+2] << 16) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+1] << 8) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset]); - } else { - meta->capacity = - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset] << 56) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+1] << 48) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+2] << 40) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+3] << 32) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+4] << 24) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+5] << 16) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+6] << 8) | - ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+7]); - } - /* Avoid unlikely, but theoretically possible overflow */ - if (meta->capacity > (ULLONG_MAX / fileTypeInfo[format].sizeMultiplier)) - return 1; - meta->capacity *= fileTypeInfo[format].sizeMultiplier; - } - - if (fileTypeInfo[format].qcowCryptOffset != -1) { - int crypt_format; - - crypt_format = - (buf[fileTypeInfo[format].qcowCryptOffset] << 24) | - (buf[fileTypeInfo[format].qcowCryptOffset+1] << 16) | - (buf[fileTypeInfo[format].qcowCryptOffset+2] << 8) | - (buf[fileTypeInfo[format].qcowCryptOffset+3]); - meta->encrypted = crypt_format != 0; - } - - if (fileTypeInfo[format].getBackingStore != NULL) { - char *backing; - int backingFormat; - int ret = fileTypeInfo[format].getBackingStore(&backing, - &backingFormat, - buf, buflen); - if (ret == BACKING_STORE_INVALID) - return 1; - - if (ret == BACKING_STORE_ERROR) - return -1; - - meta->backingStoreIsFile = false; - if (backing != NULL) { - meta->backingStore = strdup(backing); - if (meta->backingStore == NULL) { - virReportOOMError(); - VIR_FREE(backing); - return -1; - } - if (virBackingStoreIsFile(backing)) { - meta->backingStoreIsFile = true; - meta->backingStoreRaw = meta->backingStore; - meta->backingStore = absolutePathFromBaseFile(path, backing); - if (meta->backingStore == NULL) { - /* the backing file is (currently) unavailable, treat this - * file as standalone: - * backingStoreRaw is kept to mark broken image chains */ - meta->backingStoreIsFile = false; - backingFormat = VIR_STORAGE_FILE_NONE; - VIR_WARN("Backing file '%s' of image '%s' is missing.", - meta->backingStoreRaw, path); - - } - } - VIR_FREE(backing); - meta->backingStoreFormat = backingFormat; - } else { - meta->backingStore = NULL; - meta->backingStoreFormat = VIR_STORAGE_FILE_NONE; - } - } - - return 0; -} - - -static int -virStorageFileProbeFormatFromBuf(const char *path, - unsigned char *buf, - size_t buflen) -{ - int format = VIR_STORAGE_FILE_RAW; - int i; - int possibleFormat = VIR_STORAGE_FILE_RAW; - VIR_DEBUG("path=%s", path); - - /* First check file magic */ - for (i = 0 ; i < VIR_STORAGE_FILE_LAST ; i++) { - if (virStorageFileMatchesMagic(i, buf, buflen)) { - if (!virStorageFileMatchesVersion(i, buf, buflen)) { - possibleFormat = i; - continue; - } - format = i; - goto cleanup; - } - } - - if (possibleFormat != VIR_STORAGE_FILE_RAW) - VIR_WARN("File %s matches %s magic, but version is wrong. " - "Please report new version to libvir-list(a)redhat.com&quot;, - path, virStorageFileFormatTypeToString(possibleFormat)); - - /* No magic, so check file extension */ - for (i = 0 ; i < VIR_STORAGE_FILE_LAST ; i++) { - if (virStorageFileMatchesExtension(i, path)) { - format = i; - goto cleanup; - } - } - -cleanup: - VIR_DEBUG("format=%d", format); - return format; -} - - -/** - * virStorageFileProbeFormatFromFD: - * - * Probe for the format of 'fd' (which is an open file descriptor - * pointing to 'path'), returning the detected disk format. - * - * Callers are advised never to trust the returned 'format' - * unless it is listed as VIR_STORAGE_FILE_RAW, since a - * malicious guest can turn a file into any other non-raw - * format at will. - * - * Best option: Don't use this function - */ -int -virStorageFileProbeFormatFromFD(const char *path, int fd) -{ - unsigned char *head; - ssize_t len = STORAGE_MAX_HEAD; - int ret = -1; - struct stat sb; - - if (fstat(fd, &sb) < 0) { - virReportSystemError(errno, - _("cannot stat file '%s'"), - path); - return -1; - } - - /* No header to probe for directories */ - if (S_ISDIR(sb.st_mode)) { - return VIR_STORAGE_FILE_DIR; - } - - if (VIR_ALLOC_N(head, len) < 0) { - virReportOOMError(); - return -1; - } - - if (lseek(fd, 0, SEEK_SET) == (off_t)-1) { - virReportSystemError(errno, _("cannot set to start of '%s'"), path); - goto cleanup; - } - - if ((len = read(fd, head, len)) < 0) { - virReportSystemError(errno, _("cannot read header '%s'"), path); - goto cleanup; - } - - ret = virStorageFileProbeFormatFromBuf(path, head, len); - -cleanup: - VIR_FREE(head); - return ret; -} - - -/** - * virStorageFileProbeFormat: - * - * Probe for the format of 'path', returning the detected - * disk format. - * - * Callers are advised never to trust the returned 'format' - * unless it is listed as VIR_STORAGE_FILE_RAW, since a - * malicious guest can turn a raw file into any other non-raw - * format at will. - * - * Best option: Don't use this function - */ -int -virStorageFileProbeFormat(const char *path, uid_t uid, gid_t gid) -{ - int fd, ret; - - if ((fd = virFileOpenAs(path, O_RDONLY, 0, uid, gid, 0)) < 0) { - virReportSystemError(errno, _("cannot open file '%s'"), path); - return -1; - } - - ret = virStorageFileProbeFormatFromFD(path, fd); - - VIR_FORCE_CLOSE(fd); - - return ret; -} - -/** - * virStorageFileGetMetadataFromFD: - * - * Extract metadata about the storage volume with the specified - * image format. If image format is VIR_STORAGE_FILE_AUTO, it - * will probe to automatically identify the format. Does not recurse. - * - * Callers are advised never to use VIR_STORAGE_FILE_AUTO as a - * format, since a malicious guest can turn a raw file into any - * other non-raw format at will. - * - * If the returned meta.backingStoreFormat is VIR_STORAGE_FILE_AUTO - * it indicates the image didn't specify an explicit format for its - * backing store. Callers are advised against probing for the - * backing store format in this case. - * - * Caller MUST free the result after use via virStorageFileFreeMetadata. - */ -virStorageFileMetadataPtr -virStorageFileGetMetadataFromFD(const char *path, - int fd, - int format) -{ - virStorageFileMetadata *meta = NULL; - unsigned char *head = NULL; - ssize_t len = STORAGE_MAX_HEAD; - virStorageFileMetadata *ret = NULL; - struct stat sb; - - if (VIR_ALLOC(meta) < 0) { - virReportOOMError(); - return NULL; - } - - if (fstat(fd, &sb) < 0) { - virReportSystemError(errno, - _("cannot stat file '%s'"), - path); - goto cleanup; - } - - /* No header to probe for directories, but also no backing file */ - if (S_ISDIR(sb.st_mode)) - return meta; - - if (lseek(fd, 0, SEEK_SET) == (off_t)-1) { - virReportSystemError(errno, _("cannot seek to start of '%s'"), path); - goto cleanup; - } - - if (VIR_ALLOC_N(head, len) < 0) { - virReportOOMError(); - goto cleanup; - } - - if ((len = read(fd, head, len)) < 0) { - virReportSystemError(errno, _("cannot read header '%s'"), path); - goto cleanup; - } - - if (format == VIR_STORAGE_FILE_AUTO) - format = virStorageFileProbeFormatFromBuf(path, head, len); - - if (format <= VIR_STORAGE_FILE_NONE || - format >= VIR_STORAGE_FILE_LAST) { - virReportSystemError(EINVAL, _("unknown storage file format %d"), - format); - goto cleanup; - } - - if (virStorageFileGetMetadataFromBuf(format, path, head, len, meta) < 0) - goto cleanup; - ret = meta; - meta = NULL; - -cleanup: - virStorageFileFreeMetadata(meta); - VIR_FREE(head); - return ret; -} - -/* Recursive workhorse for virStorageFileGetMetadata. */ -static virStorageFileMetadataPtr -virStorageFileGetMetadataRecurse(const char *path, int format, - uid_t uid, gid_t gid, - bool allow_probe, virHashTablePtr cycle) -{ - int fd; - VIR_DEBUG("path=%s format=%d uid=%d gid=%d probe=%d", - path, format, (int)uid, (int)gid, allow_probe); - - virStorageFileMetadataPtr ret = NULL; - - if (virHashLookup(cycle, path)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("backing store for %s is self-referential"), - path); - return NULL; - } - if (virHashAddEntry(cycle, path, (void *)1) < 0) - return NULL; - - if ((fd = virFileOpenAs(path, O_RDONLY, 0, uid, gid, 0)) < 0) { - virReportSystemError(-fd, _("cannot open file '%s'"), path); - return NULL; - } - - ret = virStorageFileGetMetadataFromFD(path, fd, format); - - if (VIR_CLOSE(fd) < 0) - VIR_WARN("could not close file %s", path); - - if (ret && ret->backingStoreIsFile) { - if (ret->backingStoreFormat == VIR_STORAGE_FILE_AUTO && !allow_probe) - ret->backingStoreFormat = VIR_STORAGE_FILE_RAW; - else if (ret->backingStoreFormat == VIR_STORAGE_FILE_AUTO_SAFE) - ret->backingStoreFormat = VIR_STORAGE_FILE_AUTO; - format = ret->backingStoreFormat; - ret->backingMeta = virStorageFileGetMetadataRecurse(ret->backingStore, - format, - uid, gid, - allow_probe, - cycle); - } - - return ret; -} - -/** - * virStorageFileGetMetadata: - * - * Extract metadata about the storage volume with the specified - * image format. If image format is VIR_STORAGE_FILE_AUTO, it - * will probe to automatically identify the format. Recurses through - * the entire chain. - * - * Open files using UID and GID (or pass -1 for the current user/group). - * Treat any backing files without explicit type as raw, unless ALLOW_PROBE. - * - * Callers are advised never to use VIR_STORAGE_FILE_AUTO as a - * format, since a malicious guest can turn a raw file into any - * other non-raw format at will. - * - * If the returned meta.backingStoreFormat is VIR_STORAGE_FILE_AUTO - * it indicates the image didn't specify an explicit format for its - * backing store. Callers are advised against using ALLOW_PROBE, as - * it would probe the backing store format in this case. - * - * Caller MUST free result after use via virStorageFileFreeMetadata. - */ -virStorageFileMetadataPtr -virStorageFileGetMetadata(const char *path, int format, - uid_t uid, gid_t gid, - bool allow_probe) -{ - VIR_DEBUG("path=%s format=%d uid=%d gid=%d probe=%d", - path, format, (int)uid, (int)gid, allow_probe); - - virHashTablePtr cycle = virHashCreate(5, NULL); - virStorageFileMetadataPtr ret; - - if (!cycle) - return NULL; - - if (format <= VIR_STORAGE_FILE_NONE) - format = allow_probe ? VIR_STORAGE_FILE_AUTO : VIR_STORAGE_FILE_RAW; - ret = virStorageFileGetMetadataRecurse(path, format, uid, gid, - allow_probe, cycle); - virHashFree(cycle); - return ret; -} - -/** - * virStorageFileFreeMetadata: - * - * Free pointers in passed structure and structure itself. - */ -void -virStorageFileFreeMetadata(virStorageFileMetadata *meta) -{ - if (!meta) - return; - - virStorageFileFreeMetadata(meta->backingMeta); - VIR_FREE(meta->backingStore); - VIR_FREE(meta->backingStoreRaw); - VIR_FREE(meta); -} - -/** - * virStorageFileResize: - * - * Change the capacity of the raw storage file at 'path'. - */ -int -virStorageFileResize(const char *path, unsigned long long capacity) -{ - int fd = -1; - int ret = -1; - - if ((fd = open(path, O_RDWR)) < 0) { - virReportSystemError(errno, _("Unable to open '%s'"), path); - goto cleanup; - } - - if (ftruncate(fd, capacity) < 0) { - virReportSystemError(errno, _("Failed to truncate file '%s'"), path); - goto cleanup; - } - - if (VIR_CLOSE(fd) < 0) { - virReportSystemError(errno, _("Unable to save '%s'"), path); - goto cleanup; - } - - ret = 0; - -cleanup: - VIR_FORCE_CLOSE(fd); - return ret; -} - -#ifdef __linux__ - -# ifndef NFS_SUPER_MAGIC -# define NFS_SUPER_MAGIC 0x6969 -# endif -# ifndef OCFS2_SUPER_MAGIC -# define OCFS2_SUPER_MAGIC 0x7461636f -# endif -# ifndef GFS2_MAGIC -# define GFS2_MAGIC 0x01161970 -# endif -# ifndef AFS_FS_MAGIC -# define AFS_FS_MAGIC 0x6B414653 -# endif - - -int virStorageFileIsSharedFSType(const char *path, - int fstypes) -{ - char *dirpath, *p; - struct statfs sb; - int statfs_ret; - - if ((dirpath = strdup(path)) == NULL) { - virReportOOMError(); - return -1; - } - - do { - - /* Try less and less of the path until we get to a - * directory we can stat. Even if we don't have 'x' - * permission on any directory in the path on the NFS - * server (assuming it's NFS), we will be able to stat the - * mount point, and that will properly tell us if the - * fstype is NFS. - */ - - if ((p = strrchr(dirpath, '/')) == NULL) { - virReportSystemError(EINVAL, - _("Invalid relative path '%s'"), path); - VIR_FREE(dirpath); - return -1; - } - - if (p == dirpath) - *(p+1) = '\0'; - else - *p = '\0'; - - statfs_ret = statfs(dirpath, &sb); - - } while ((statfs_ret < 0) && (p != dirpath)); - - VIR_FREE(dirpath); - - if (statfs_ret < 0) { - virReportSystemError(errno, - _("cannot determine filesystem for '%s'"), - path); - return -1; - } - - VIR_DEBUG("Check if path %s with FS magic %lld is shared", - path, (long long int)sb.f_type); - - if ((fstypes & VIR_STORAGE_FILE_SHFS_NFS) && - (sb.f_type == NFS_SUPER_MAGIC)) - return 1; - - if ((fstypes & VIR_STORAGE_FILE_SHFS_GFS2) && - (sb.f_type == GFS2_MAGIC)) - return 1; - if ((fstypes & VIR_STORAGE_FILE_SHFS_OCFS) && - (sb.f_type == OCFS2_SUPER_MAGIC)) - return 1; - if ((fstypes & VIR_STORAGE_FILE_SHFS_AFS) && - (sb.f_type == AFS_FS_MAGIC)) - return 1; - - return 0; -} -#else -int virStorageFileIsSharedFSType(const char *path ATTRIBUTE_UNUSED, - int fstypes ATTRIBUTE_UNUSED) -{ - /* XXX implement me :-) */ - return 0; -} -#endif - -int virStorageFileIsSharedFS(const char *path) -{ - return virStorageFileIsSharedFSType(path, - VIR_STORAGE_FILE_SHFS_NFS | - VIR_STORAGE_FILE_SHFS_GFS2 | - VIR_STORAGE_FILE_SHFS_OCFS | - VIR_STORAGE_FILE_SHFS_AFS); -} - -int virStorageFileIsClusterFS(const char *path) -{ - /* These are coherent cluster filesystems known to be safe for - * migration with cache != none - */ - return virStorageFileIsSharedFSType(path, - VIR_STORAGE_FILE_SHFS_GFS2 | - VIR_STORAGE_FILE_SHFS_OCFS); -} - -#ifdef LVS -int virStorageFileGetLVMKey(const char *path, - char **key) -{ - /* - * # lvs --noheadings --unbuffered --nosuffix --options "uuid" LVNAME - * 06UgP5-2rhb-w3Bo-3mdR-WeoL-pytO-SAa2ky - */ - int status; - virCommandPtr cmd = virCommandNewArgList( - LVS, - "--noheadings", "--unbuffered", "--nosuffix", - "--options", "uuid", path, - NULL - ); - int ret = -1; - - *key = NULL; - - /* Run the program and capture its output */ - virCommandSetOutputBuffer(cmd, key); - if (virCommandRun(cmd, &status) < 0) - goto cleanup; - - /* Explicitly check status == 0, rather than passing NULL - * to virCommandRun because we don't want to raise an actual - * error in this scenario, just return a NULL key. - */ - - if (status == 0 && *key) { - char *nl; - char *tmp = *key; - - /* Find first non-space character */ - while (*tmp && c_isspace(*tmp)) { - tmp++; - } - /* Kill leading spaces */ - if (tmp != *key) - memmove(*key, tmp, strlen(tmp)+1); - - /* Kill trailing newline */ - if ((nl = strchr(*key, '\n'))) - *nl = '\0'; - } - - ret = 0; - -cleanup: - if (*key && STREQ(*key, "")) - VIR_FREE(*key); - - virCommandFree(cmd); - - return ret; -} -#else -int virStorageFileGetLVMKey(const char *path, - char **key ATTRIBUTE_UNUSED) -{ - virReportSystemError(ENOSYS, _("Unable to get LVM key for %s"), path); - return -1; -} -#endif - -#ifdef HAVE_UDEV -int virStorageFileGetSCSIKey(const char *path, - char **key) -{ - int status; - virCommandPtr cmd = virCommandNewArgList( - "/lib/udev/scsi_id", - "--replace-whitespace", - "--whitelisted", - "--device", path, - NULL - ); - int ret = -1; - - *key = NULL; - - /* Run the program and capture its output */ - virCommandSetOutputBuffer(cmd, key); - if (virCommandRun(cmd, &status) < 0) - goto cleanup; - - /* Explicitly check status == 0, rather than passing NULL - * to virCommandRun because we don't want to raise an actual - * error in this scenario, just return a NULL key. - */ - if (status == 0 && *key) { - char *nl = strchr(*key, '\n'); - if (nl) - *nl = '\0'; - } - - ret = 0; - -cleanup: - if (*key && STREQ(*key, "")) - VIR_FREE(*key); - - virCommandFree(cmd); - - return ret; -} -#else -int virStorageFileGetSCSIKey(const char *path, - char **key ATTRIBUTE_UNUSED) -{ - virReportSystemError(ENOSYS, _("Unable to get SCSI key for %s"), path); - return -1; -} -#endif - -/* Given a CHAIN that starts at the named file START, return a string - * pointing to either START or within CHAIN that gives the preferred - * name for the backing file NAME within that chain. Pass NULL for - * NAME to find the base of the chain. If META is not NULL, set *META - * to the point in the chain that describes NAME (or to NULL if the - * backing element is not a file). If PARENT is not NULL, set *PARENT - * to the preferred name of the parent (or to NULL if NAME matches - * START). Since the results point within CHAIN, they must not be - * independently freed. */ -const char * -virStorageFileChainLookup(virStorageFileMetadataPtr chain, const char *start, - const char *name, virStorageFileMetadataPtr *meta, - const char **parent) -{ - virStorageFileMetadataPtr owner; - const char *tmp; - - if (!parent) - parent = &tmp; - - *parent = NULL; - if (name ? STREQ(start, name) || virFileLinkPointsTo(start, name) : - !chain->backingStore) { - if (meta) - *meta = chain; - return start; - } - - owner = chain; - *parent = start; - while (owner) { - if (!owner->backingStore) - goto error; - if (!name) { - if (!owner->backingMeta || - !owner->backingMeta->backingStore) - break; - } else if (STREQ_NULLABLE(name, owner->backingStoreRaw) || - STREQ(name, owner->backingStore)) { - break; - } else if (owner->backingStoreIsFile) { - char *absName = absolutePathFromBaseFile(*parent, name); - if (absName && STREQ(absName, owner->backingStore)) { - VIR_FREE(absName); - break; - } - VIR_FREE(absName); - } - *parent = owner->backingStore; - owner = owner->backingMeta; - } - if (!owner) - goto error; - if (meta) - *meta = owner->backingMeta; - return owner->backingStore; - -error: - *parent = NULL; - if (meta) - *meta = NULL; - return NULL; -} diff --git a/src/util/storage_file.h b/src/util/storage_file.h deleted file mode 100644 index 6fbd275..0000000 --- a/src/util/storage_file.h +++ /dev/null @@ -1,109 +0,0 @@ -/* - * storage_file.c: file utility functions for FS storage backend - * - * Copyright (C) 2007-2009, 2012 Red Hat, Inc. - * Copyright (C) 2007-2008 Daniel P. Berrange - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Author: Daniel P. Berrange <berrange(a)redhat.com&gt; - */ - -#ifndef __VIR_STORAGE_FILE_H__ -# define __VIR_STORAGE_FILE_H__ - -# include "util.h" - -enum virStorageFileFormat { - VIR_STORAGE_FILE_AUTO_SAFE = -2, - VIR_STORAGE_FILE_AUTO = -1, - VIR_STORAGE_FILE_NONE = 0, - VIR_STORAGE_FILE_RAW, - VIR_STORAGE_FILE_DIR, - VIR_STORAGE_FILE_BOCHS, - VIR_STORAGE_FILE_CLOOP, - VIR_STORAGE_FILE_COW, - VIR_STORAGE_FILE_DMG, - VIR_STORAGE_FILE_ISO, - VIR_STORAGE_FILE_QCOW, - VIR_STORAGE_FILE_QCOW2, - VIR_STORAGE_FILE_QED, - VIR_STORAGE_FILE_VMDK, - VIR_STORAGE_FILE_VPC, - VIR_STORAGE_FILE_FAT, - VIR_STORAGE_FILE_VHD, - - VIR_STORAGE_FILE_LAST, -}; - -VIR_ENUM_DECL(virStorageFileFormat); - -typedef struct _virStorageFileMetadata virStorageFileMetadata; -typedef virStorageFileMetadata *virStorageFileMetadataPtr; -struct _virStorageFileMetadata { - char *backingStore; /* Canonical name (absolute file, or protocol) */ - char *backingStoreRaw; /* If file, original name, possibly relative */ - int backingStoreFormat; /* enum virStorageFileFormat */ - bool backingStoreIsFile; - virStorageFileMetadataPtr backingMeta; - unsigned long long capacity; - bool encrypted; -}; - -# ifndef DEV_BSIZE -# define DEV_BSIZE 512 -# endif - -int virStorageFileProbeFormat(const char *path, uid_t uid, gid_t gid); -int virStorageFileProbeFormatFromFD(const char *path, - int fd); - -virStorageFileMetadataPtr virStorageFileGetMetadata(const char *path, - int format, - uid_t uid, gid_t gid, - bool allow_probe); -virStorageFileMetadataPtr virStorageFileGetMetadataFromFD(const char *path, - int fd, - int format); - -const char *virStorageFileChainLookup(virStorageFileMetadataPtr chain, - const char *start, - const char *name, - virStorageFileMetadataPtr *meta, - const char **parent) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2); - -void virStorageFileFreeMetadata(virStorageFileMetadataPtr meta); - -int virStorageFileResize(const char *path, unsigned long long capacity); - -enum { - VIR_STORAGE_FILE_SHFS_NFS = (1 << 0), - VIR_STORAGE_FILE_SHFS_GFS2 = (1 << 1), - VIR_STORAGE_FILE_SHFS_OCFS = (1 << 2), - VIR_STORAGE_FILE_SHFS_AFS = (1 << 3), -}; - -int virStorageFileIsSharedFS(const char *path); -int virStorageFileIsClusterFS(const char *path); -int virStorageFileIsSharedFSType(const char *path, - int fstypes); - -int virStorageFileGetLVMKey(const char *path, - char **key); -int virStorageFileGetSCSIKey(const char *path, - char **key); - -#endif /* __VIR_STORAGE_FILE_H__ */ diff --git a/src/util/util.c b/src/util/util.c index c070d94..5d32995 100644 --- a/src/util/util.c +++ b/src/util/util.c @@ -79,7 +79,7 @@ #include "virlog.h" #include "virbuffer.h" #include "util.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "viralloc.h" #include "threads.h" #include "verify.h" diff --git a/src/util/virstoragefile.c b/src/util/virstoragefile.c new file mode 100644 index 0000000..f183f19 --- /dev/null +++ b/src/util/virstoragefile.c @@ -0,0 +1,1397 @@ +/* + * storage_file.c: file utility functions for FS storage backend + * + * Copyright (C) 2007-2012 Red Hat, Inc. + * Copyright (C) 2007-2008 Daniel P. Berrange + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Author: Daniel P. Berrange <berrange(a)redhat.com&gt; + */ + +#include <config.h> +#include "virstoragefile.h" + +#include <sys/stat.h> +#include <unistd.h> +#include <fcntl.h> +#include <stdlib.h> +#ifdef __linux__ +# if HAVE_LINUX_MAGIC_H +# include <linux/magic.h> +# endif +# include <sys/statfs.h> +#endif +#include "dirname.h" +#include "viralloc.h" +#include "virterror_internal.h" +#include "virlog.h" +#include "virfile.h" +#include "c-ctype.h" +#include "vircommand.h" +#include "virhash.h" + +#define VIR_FROM_THIS VIR_FROM_STORAGE + +VIR_ENUM_IMPL(virStorageFileFormat, + VIR_STORAGE_FILE_LAST, + "none", + "raw", "dir", "bochs", + "cloop", "cow", "dmg", "iso", + "qcow", "qcow2", "qed", "vmdk", "vpc", + "fat", "vhd") + +enum lv_endian { + LV_LITTLE_ENDIAN = 1, /* 1234 */ + LV_BIG_ENDIAN /* 4321 */ +}; + +enum { + BACKING_STORE_OK, + BACKING_STORE_INVALID, + BACKING_STORE_ERROR, +}; + +/* Either 'magic' or 'extension' *must* be provided */ +struct FileTypeInfo { + const char *magic; /* Optional string of file magic + * to check at head of file */ + const char *extension; /* Optional file extension to check */ + enum lv_endian endian; /* Endianness of file format */ + int versionOffset; /* Byte offset from start of file + * where we find version number, + * -1 to skip version test */ + int versionNumber; /* Version number to validate */ + int sizeOffset; /* Byte offset from start of file + * where we find capacity info, + * -1 to use st_size as capacity */ + int sizeBytes; /* Number of bytes for size field */ + int sizeMultiplier; /* A scaling factor if size is not in bytes */ + /* Store a COW base image path (possibly relative), + * or NULL if there is no COW base image, to RES; + * return BACKING_STORE_* */ + int qcowCryptOffset; /* Byte offset from start of file + * where to find encryption mode, + * -1 if encryption is not used */ + int (*getBackingStore)(char **res, int *format, + const unsigned char *buf, size_t buf_size); +}; + +static int cowGetBackingStore(char **, int *, + const unsigned char *, size_t); +static int qcow1GetBackingStore(char **, int *, + const unsigned char *, size_t); +static int qcow2GetBackingStore(char **, int *, + const unsigned char *, size_t); +static int vmdk4GetBackingStore(char **, int *, + const unsigned char *, size_t); +static int +qedGetBackingStore(char **, int *, const unsigned char *, size_t); + +#define QCOWX_HDR_VERSION (4) +#define QCOWX_HDR_BACKING_FILE_OFFSET (QCOWX_HDR_VERSION+4) +#define QCOWX_HDR_BACKING_FILE_SIZE (QCOWX_HDR_BACKING_FILE_OFFSET+8) +#define QCOWX_HDR_IMAGE_SIZE (QCOWX_HDR_BACKING_FILE_SIZE+4+4) + +#define QCOW1_HDR_CRYPT (QCOWX_HDR_IMAGE_SIZE+8+1+1) +#define QCOW2_HDR_CRYPT (QCOWX_HDR_IMAGE_SIZE+8) + +#define QCOW1_HDR_TOTAL_SIZE (QCOW1_HDR_CRYPT+4+8) +#define QCOW2_HDR_TOTAL_SIZE (QCOW2_HDR_CRYPT+4+4+8+8+4+4+8) + +#define QCOW2_HDR_EXTENSION_END 0 +#define QCOW2_HDR_EXTENSION_BACKING_FORMAT 0xE2792ACA + +#define QED_HDR_FEATURES_OFFSET (4+4+4+4) +#define QED_HDR_IMAGE_SIZE (QED_HDR_FEATURES_OFFSET+8+8+8+8) +#define QED_HDR_BACKING_FILE_OFFSET (QED_HDR_IMAGE_SIZE+8) +#define QED_HDR_BACKING_FILE_SIZE (QED_HDR_BACKING_FILE_OFFSET+4) +#define QED_F_BACKING_FILE 0x01 +#define QED_F_BACKING_FORMAT_NO_PROBE 0x04 + +/* VMDK needs at least this to find backing store, + * other formats need less */ +#define STORAGE_MAX_HEAD (20*512) + + +static struct FileTypeInfo const fileTypeInfo[] = { + [VIR_STORAGE_FILE_NONE] = { NULL, NULL, LV_LITTLE_ENDIAN, + -1, 0, 0, 0, 0, 0, NULL }, + [VIR_STORAGE_FILE_RAW] = { NULL, NULL, LV_LITTLE_ENDIAN, + -1, 0, 0, 0, 0, 0, NULL }, + [VIR_STORAGE_FILE_DIR] = { NULL, NULL, LV_LITTLE_ENDIAN, + -1, 0, 0, 0, 0, 0, NULL }, + [VIR_STORAGE_FILE_BOCHS] = { + /*"Bochs Virtual HD Image", */ /* Untested */ NULL, + NULL, + LV_LITTLE_ENDIAN, 64, 0x20000, + 32+16+16+4+4+4+4+4, 8, 1, -1, NULL + }, + [VIR_STORAGE_FILE_CLOOP] = { + /*"#!/bin/sh\n#V2.0 Format\nmodprobe cloop file=$0 && mount -r -t iso9660 /dev/cloop $1\n", */ /* Untested */ NULL, + NULL, + LV_LITTLE_ENDIAN, -1, 0, + -1, 0, 0, -1, NULL + }, + [VIR_STORAGE_FILE_COW] = { + "OOOM", NULL, + LV_BIG_ENDIAN, 4, 2, + 4+4+1024+4, 8, 1, -1, cowGetBackingStore + }, + [VIR_STORAGE_FILE_DMG] = { + NULL, /* XXX QEMU says there's no magic for dmg, but we should check... */ + ".dmg", + 0, -1, 0, + -1, 0, 0, -1, NULL + }, + [VIR_STORAGE_FILE_ISO] = { + NULL, /* XXX there's probably some magic for iso we can validate too... */ + ".iso", + 0, -1, 0, + -1, 0, 0, -1, NULL + }, + [VIR_STORAGE_FILE_QCOW] = { + "QFI", NULL, + LV_BIG_ENDIAN, 4, 1, + QCOWX_HDR_IMAGE_SIZE, 8, 1, QCOW1_HDR_CRYPT, qcow1GetBackingStore, + }, + [VIR_STORAGE_FILE_QCOW2] = { + "QFI", NULL, + LV_BIG_ENDIAN, 4, 2, + QCOWX_HDR_IMAGE_SIZE, 8, 1, QCOW2_HDR_CRYPT, qcow2GetBackingStore, + }, + [VIR_STORAGE_FILE_QED] = { + /* http://wiki.qemu.org/Features/QED */ + "QED", NULL, + LV_LITTLE_ENDIAN, -2, -1, + QED_HDR_IMAGE_SIZE, 8, 1, -1, qedGetBackingStore, + }, + [VIR_STORAGE_FILE_VMDK] = { + "KDMV", NULL, + LV_LITTLE_ENDIAN, 4, 1, + 4+4+4, 8, 512, -1, vmdk4GetBackingStore + }, + [VIR_STORAGE_FILE_VPC] = { + "conectix", NULL, + LV_BIG_ENDIAN, 12, 0x10000, + 8 + 4 + 4 + 8 + 4 + 4 + 2 + 2 + 4, 8, 1, -1, NULL + }, + /* Not direct file formats, but used for various drivers */ + [VIR_STORAGE_FILE_FAT] = { NULL, NULL, LV_LITTLE_ENDIAN, + -1, 0, 0, 0, 0, 0, NULL }, + [VIR_STORAGE_FILE_VHD] = { NULL, NULL, LV_LITTLE_ENDIAN, + -1, 0, 0, 0, 0, 0, NULL }, +}; +verify(ARRAY_CARDINALITY(fileTypeInfo) == VIR_STORAGE_FILE_LAST); + +static int +cowGetBackingStore(char **res, + int *format, + const unsigned char *buf, + size_t buf_size) +{ +#define COW_FILENAME_MAXLEN 1024 + *res = NULL; + *format = VIR_STORAGE_FILE_AUTO; + + if (buf_size < 4+4+ COW_FILENAME_MAXLEN) + return BACKING_STORE_INVALID; + if (buf[4+4] == '\0') { /* cow_header_v2.backing_file[0] */ + *format = VIR_STORAGE_FILE_NONE; + return BACKING_STORE_OK; + } + + *res = strndup((const char*)buf + 4+4, COW_FILENAME_MAXLEN); + if (*res == NULL) { + virReportOOMError(); + return BACKING_STORE_ERROR; + } + return BACKING_STORE_OK; +} + + +static int +qcow2GetBackingStoreFormat(int *format, + const unsigned char *buf, + size_t buf_size, + size_t extension_start, + size_t extension_end) +{ + size_t offset = extension_start; + + /* + * The extensions take format of + * + * int32: magic + * int32: length + * byte[length]: payload + * + * Unknown extensions can be ignored by skipping + * over "length" bytes in the data stream. + */ + while (offset < (buf_size-8) && + offset < (extension_end-8)) { + unsigned int magic = + (buf[offset] << 24) + + (buf[offset+1] << 16) + + (buf[offset+2] << 8) + + (buf[offset+3]); + unsigned int len = + (buf[offset+4] << 24) + + (buf[offset+5] << 16) + + (buf[offset+6] << 8) + + (buf[offset+7]); + + offset += 8; + + if ((offset + len) < offset) + break; + + if ((offset + len) > buf_size) + break; + + switch (magic) { + case QCOW2_HDR_EXTENSION_END: + goto done; + + case QCOW2_HDR_EXTENSION_BACKING_FORMAT: + if (buf[offset+len] != '\0') + break; + *format = virStorageFileFormatTypeFromString( + ((const char *)buf)+offset); + if (*format <= VIR_STORAGE_FILE_NONE) + return -1; + } + + offset += len; + } + +done: + + return 0; +} + + +static int +qcowXGetBackingStore(char **res, + int *format, + const unsigned char *buf, + size_t buf_size, + bool isQCow2) +{ + unsigned long long offset; + unsigned int size; + + *res = NULL; + if (format) + *format = VIR_STORAGE_FILE_AUTO; + + if (buf_size < QCOWX_HDR_BACKING_FILE_OFFSET+8+4) + return BACKING_STORE_INVALID; + offset = (((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET] << 56) + | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+1] << 48) + | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+2] << 40) + | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+3] << 32) + | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+4] << 24) + | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+5] << 16) + | ((unsigned long long)buf[QCOWX_HDR_BACKING_FILE_OFFSET+6] << 8) + | buf[QCOWX_HDR_BACKING_FILE_OFFSET+7]); /* QCowHeader.backing_file_offset */ + if (offset > buf_size) + return BACKING_STORE_INVALID; + size = ((buf[QCOWX_HDR_BACKING_FILE_SIZE] << 24) + | (buf[QCOWX_HDR_BACKING_FILE_SIZE+1] << 16) + | (buf[QCOWX_HDR_BACKING_FILE_SIZE+2] << 8) + | buf[QCOWX_HDR_BACKING_FILE_SIZE+3]); /* QCowHeader.backing_file_size */ + if (size == 0) { + if (format) + *format = VIR_STORAGE_FILE_NONE; + return BACKING_STORE_OK; + } + if (offset + size > buf_size || offset + size < offset) + return BACKING_STORE_INVALID; + if (size + 1 == 0) + return BACKING_STORE_INVALID; + if (VIR_ALLOC_N(*res, size + 1) < 0) { + virReportOOMError(); + return BACKING_STORE_ERROR; + } + memcpy(*res, buf + offset, size); + (*res)[size] = '\0'; + + /* + * Traditionally QCow2 files had a layout of + * + * [header] + * [backingStoreName] + * + * Although the backingStoreName typically followed + * the header immediately, this was not required by + * the format. By specifying a higher byte offset for + * the backing file offset in the header, it was + * possible to leave space between the header and + * start of backingStore. + * + * This hack is now used to store extensions to the + * qcow2 format: + * + * [header] + * [extensions] + * [backingStoreName] + * + * Thus the file region to search for extensions is + * between the end of the header (QCOW2_HDR_TOTAL_SIZE) + * and the start of the backingStoreName (offset) + */ + if (isQCow2 && format && + qcow2GetBackingStoreFormat(format, buf, buf_size, QCOW2_HDR_TOTAL_SIZE, + offset) < 0) + return BACKING_STORE_INVALID; + + return BACKING_STORE_OK; +} + + +static int +qcow1GetBackingStore(char **res, + int *format, + const unsigned char *buf, + size_t buf_size) +{ + int ret; + + /* QCow1 doesn't have the extensions capability + * used to store backing format */ + *format = VIR_STORAGE_FILE_AUTO; + ret = qcowXGetBackingStore(res, NULL, buf, buf_size, false); + if (ret == 0 && *buf == '\0') + *format = VIR_STORAGE_FILE_NONE; + return ret; +} + +static int +qcow2GetBackingStore(char **res, + int *format, + const unsigned char *buf, + size_t buf_size) +{ + return qcowXGetBackingStore(res, format, buf, buf_size, true); +} + + +static int +vmdk4GetBackingStore(char **res, + int *format, + const unsigned char *buf, + size_t buf_size) +{ + static const char prefix[] = "parentFileNameHint=\""; + char *desc, *start, *end; + size_t len; + int ret = BACKING_STORE_ERROR; + + if (VIR_ALLOC_N(desc, STORAGE_MAX_HEAD + 1) < 0) { + virReportOOMError(); + goto cleanup; + } + + *res = NULL; + /* + * Technically this should have been VMDK, since + * VMDK spec / VMWare impl only support VMDK backed + * by VMDK. QEMU isn't following this though and + * does probing on VMDK backing files, hence we set + * AUTO + */ + *format = VIR_STORAGE_FILE_AUTO; + + if (buf_size <= 0x200) { + ret = BACKING_STORE_INVALID; + goto cleanup; + } + len = buf_size - 0x200; + if (len > STORAGE_MAX_HEAD) + len = STORAGE_MAX_HEAD; + memcpy(desc, buf + 0x200, len); + desc[len] = '\0'; + start = strstr(desc, prefix); + if (start == NULL) { + *format = VIR_STORAGE_FILE_NONE; + ret = BACKING_STORE_OK; + goto cleanup; + } + start += strlen(prefix); + end = strchr(start, '"'); + if (end == NULL) { + ret = BACKING_STORE_INVALID; + goto cleanup; + } + if (end == start) { + *format = VIR_STORAGE_FILE_NONE; + ret = BACKING_STORE_OK; + goto cleanup; + } + *end = '\0'; + *res = strdup(start); + if (*res == NULL) { + virReportOOMError(); + goto cleanup; + } + + ret = BACKING_STORE_OK; + +cleanup: + VIR_FREE(desc); + return ret; +} + +static unsigned long +qedGetHeaderUL(const unsigned char *loc) +{ + return (((unsigned long)loc[3] << 24) | + ((unsigned long)loc[2] << 16) | + ((unsigned long)loc[1] << 8) | + ((unsigned long)loc[0] << 0)); +} + +static unsigned long long +qedGetHeaderULL(const unsigned char *loc) +{ + return (((unsigned long long)loc[7] << 56) | + ((unsigned long long)loc[6] << 48) | + ((unsigned long long)loc[5] << 40) | + ((unsigned long long)loc[4] << 32) | + ((unsigned long long)loc[3] << 24) | + ((unsigned long long)loc[2] << 16) | + ((unsigned long long)loc[1] << 8) | + ((unsigned long long)loc[0] << 0)); +} + +static int +qedGetBackingStore(char **res, + int *format, + const unsigned char *buf, + size_t buf_size) +{ + unsigned long long flags; + unsigned long offset, size; + + *res = NULL; + /* Check if this image has a backing file */ + if (buf_size < QED_HDR_FEATURES_OFFSET+8) + return BACKING_STORE_INVALID; + flags = qedGetHeaderULL(buf + QED_HDR_FEATURES_OFFSET); + if (!(flags & QED_F_BACKING_FILE)) { + *format = VIR_STORAGE_FILE_NONE; + return BACKING_STORE_OK; + } + + /* Parse the backing file */ + if (buf_size < QED_HDR_BACKING_FILE_OFFSET+8) + return BACKING_STORE_INVALID; + offset = qedGetHeaderUL(buf + QED_HDR_BACKING_FILE_OFFSET); + if (offset > buf_size) + return BACKING_STORE_INVALID; + size = qedGetHeaderUL(buf + QED_HDR_BACKING_FILE_SIZE); + if (size == 0) + return BACKING_STORE_OK; + if (offset + size > buf_size || offset + size < offset) + return BACKING_STORE_INVALID; + if (VIR_ALLOC_N(*res, size + 1) < 0) { + virReportOOMError(); + return BACKING_STORE_ERROR; + } + memcpy(*res, buf + offset, size); + (*res)[size] = '\0'; + + if (flags & QED_F_BACKING_FORMAT_NO_PROBE) + *format = VIR_STORAGE_FILE_RAW; + else + *format = VIR_STORAGE_FILE_AUTO_SAFE; + + return BACKING_STORE_OK; +} + +/** + * Return an absolute path corresponding to PATH, which is absolute or relative + * to the directory containing BASE_FILE, or NULL on error + */ +static char * +absolutePathFromBaseFile(const char *base_file, const char *path) +{ + char *res = NULL; + char *tmp = NULL; + size_t d_len = dir_len(base_file); + + /* If path is already absolute, or if dirname(base_file) is ".", + just return a copy of path. */ + if (*path == '/' || d_len == 0) { + if (!(res = canonicalize_file_name(path))) + virReportSystemError(errno, + _("Can't canonicalize path '%s'"), path); + + goto cleanup; + } + + /* Ensure that the following cast-to-int is valid. */ + if (d_len > INT_MAX) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Directory name too long: '%s'"), base_file); + goto cleanup; + } + + if (virAsprintf(&tmp, "%.*s/%s", (int) d_len, base_file, path) < 0) { + virReportOOMError(); + goto cleanup; + } + + if (!(res = canonicalize_file_name(tmp))) + virReportSystemError(errno, _("Can't canonicalize path '%s'"), path); + +cleanup: + VIR_FREE(tmp); + return res; +} + + +static bool +virStorageFileMatchesMagic(int format, + unsigned char *buf, + size_t buflen) +{ + int mlen; + + if (fileTypeInfo[format].magic == NULL) + return false; + + /* Validate magic data */ + mlen = strlen(fileTypeInfo[format].magic); + if (mlen > buflen) + return false; + + if (memcmp(buf, fileTypeInfo[format].magic, mlen) != 0) + return false; + + return true; +} + + +static bool +virStorageFileMatchesExtension(int format, + const char *path) +{ + if (fileTypeInfo[format].extension == NULL) + return false; + + if (virFileHasSuffix(path, fileTypeInfo[format].extension)) + return true; + + return false; +} + + +static bool +virStorageFileMatchesVersion(int format, + unsigned char *buf, + size_t buflen) +{ + int version; + + /* Validate version number info */ + if (fileTypeInfo[format].versionOffset == -1) + return false; + + /* -2 == non-versioned file format, so trivially match */ + if (fileTypeInfo[format].versionOffset == -2) + return true; + + if ((fileTypeInfo[format].versionOffset + 4) > buflen) + return false; + + if (fileTypeInfo[format].endian == LV_LITTLE_ENDIAN) { + version = + (buf[fileTypeInfo[format].versionOffset+3] << 24) | + (buf[fileTypeInfo[format].versionOffset+2] << 16) | + (buf[fileTypeInfo[format].versionOffset+1] << 8) | + (buf[fileTypeInfo[format].versionOffset]); + } else { + version = + (buf[fileTypeInfo[format].versionOffset] << 24) | + (buf[fileTypeInfo[format].versionOffset+1] << 16) | + (buf[fileTypeInfo[format].versionOffset+2] << 8) | + (buf[fileTypeInfo[format].versionOffset+3]); + } + + VIR_DEBUG("Compare detected version %d vs expected version %d", + version, fileTypeInfo[format].versionNumber); + if (version != fileTypeInfo[format].versionNumber) + return false; + + return true; +} + +static bool +virBackingStoreIsFile(const char *backing) +{ + /* Backing store is a network block device or Rados block device */ + if (STRPREFIX(backing, "nbd:") || STRPREFIX(backing, "rbd:")) + return false; + return true; +} + +static int +virStorageFileGetMetadataFromBuf(int format, + const char *path, + unsigned char *buf, + size_t buflen, + virStorageFileMetadata *meta) +{ + VIR_DEBUG("path=%s format=%d", path, format); + + /* XXX we should consider moving virStorageBackendUpdateVolInfo + * code into this method, for non-magic files + */ + if (format <= VIR_STORAGE_FILE_NONE || + format >= VIR_STORAGE_FILE_LAST || + !fileTypeInfo[format].magic) { + return 0; + } + + /* Optionally extract capacity from file */ + if (fileTypeInfo[format].sizeOffset != -1) { + if ((fileTypeInfo[format].sizeOffset + 8) > buflen) + return 1; + + if (fileTypeInfo[format].endian == LV_LITTLE_ENDIAN) { + meta->capacity = + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+7] << 56) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+6] << 48) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+5] << 40) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+4] << 32) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+3] << 24) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+2] << 16) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+1] << 8) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset]); + } else { + meta->capacity = + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset] << 56) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+1] << 48) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+2] << 40) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+3] << 32) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+4] << 24) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+5] << 16) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+6] << 8) | + ((unsigned long long)buf[fileTypeInfo[format].sizeOffset+7]); + } + /* Avoid unlikely, but theoretically possible overflow */ + if (meta->capacity > (ULLONG_MAX / fileTypeInfo[format].sizeMultiplier)) + return 1; + meta->capacity *= fileTypeInfo[format].sizeMultiplier; + } + + if (fileTypeInfo[format].qcowCryptOffset != -1) { + int crypt_format; + + crypt_format = + (buf[fileTypeInfo[format].qcowCryptOffset] << 24) | + (buf[fileTypeInfo[format].qcowCryptOffset+1] << 16) | + (buf[fileTypeInfo[format].qcowCryptOffset+2] << 8) | + (buf[fileTypeInfo[format].qcowCryptOffset+3]); + meta->encrypted = crypt_format != 0; + } + + if (fileTypeInfo[format].getBackingStore != NULL) { + char *backing; + int backingFormat; + int ret = fileTypeInfo[format].getBackingStore(&backing, + &backingFormat, + buf, buflen); + if (ret == BACKING_STORE_INVALID) + return 1; + + if (ret == BACKING_STORE_ERROR) + return -1; + + meta->backingStoreIsFile = false; + if (backing != NULL) { + meta->backingStore = strdup(backing); + if (meta->backingStore == NULL) { + virReportOOMError(); + VIR_FREE(backing); + return -1; + } + if (virBackingStoreIsFile(backing)) { + meta->backingStoreIsFile = true; + meta->backingStoreRaw = meta->backingStore; + meta->backingStore = absolutePathFromBaseFile(path, backing); + if (meta->backingStore == NULL) { + /* the backing file is (currently) unavailable, treat this + * file as standalone: + * backingStoreRaw is kept to mark broken image chains */ + meta->backingStoreIsFile = false; + backingFormat = VIR_STORAGE_FILE_NONE; + VIR_WARN("Backing file '%s' of image '%s' is missing.", + meta->backingStoreRaw, path); + + } + } + VIR_FREE(backing); + meta->backingStoreFormat = backingFormat; + } else { + meta->backingStore = NULL; + meta->backingStoreFormat = VIR_STORAGE_FILE_NONE; + } + } + + return 0; +} + + +static int +virStorageFileProbeFormatFromBuf(const char *path, + unsigned char *buf, + size_t buflen) +{ + int format = VIR_STORAGE_FILE_RAW; + int i; + int possibleFormat = VIR_STORAGE_FILE_RAW; + VIR_DEBUG("path=%s", path); + + /* First check file magic */ + for (i = 0 ; i < VIR_STORAGE_FILE_LAST ; i++) { + if (virStorageFileMatchesMagic(i, buf, buflen)) { + if (!virStorageFileMatchesVersion(i, buf, buflen)) { + possibleFormat = i; + continue; + } + format = i; + goto cleanup; + } + } + + if (possibleFormat != VIR_STORAGE_FILE_RAW) + VIR_WARN("File %s matches %s magic, but version is wrong. " + "Please report new version to libvir-list(a)redhat.com&quot;, + path, virStorageFileFormatTypeToString(possibleFormat)); + + /* No magic, so check file extension */ + for (i = 0 ; i < VIR_STORAGE_FILE_LAST ; i++) { + if (virStorageFileMatchesExtension(i, path)) { + format = i; + goto cleanup; + } + } + +cleanup: + VIR_DEBUG("format=%d", format); + return format; +} + + +/** + * virStorageFileProbeFormatFromFD: + * + * Probe for the format of 'fd' (which is an open file descriptor + * pointing to 'path'), returning the detected disk format. + * + * Callers are advised never to trust the returned 'format' + * unless it is listed as VIR_STORAGE_FILE_RAW, since a + * malicious guest can turn a file into any other non-raw + * format at will. + * + * Best option: Don't use this function + */ +int +virStorageFileProbeFormatFromFD(const char *path, int fd) +{ + unsigned char *head; + ssize_t len = STORAGE_MAX_HEAD; + int ret = -1; + struct stat sb; + + if (fstat(fd, &sb) < 0) { + virReportSystemError(errno, + _("cannot stat file '%s'"), + path); + return -1; + } + + /* No header to probe for directories */ + if (S_ISDIR(sb.st_mode)) { + return VIR_STORAGE_FILE_DIR; + } + + if (VIR_ALLOC_N(head, len) < 0) { + virReportOOMError(); + return -1; + } + + if (lseek(fd, 0, SEEK_SET) == (off_t)-1) { + virReportSystemError(errno, _("cannot set to start of '%s'"), path); + goto cleanup; + } + + if ((len = read(fd, head, len)) < 0) { + virReportSystemError(errno, _("cannot read header '%s'"), path); + goto cleanup; + } + + ret = virStorageFileProbeFormatFromBuf(path, head, len); + +cleanup: + VIR_FREE(head); + return ret; +} + + +/** + * virStorageFileProbeFormat: + * + * Probe for the format of 'path', returning the detected + * disk format. + * + * Callers are advised never to trust the returned 'format' + * unless it is listed as VIR_STORAGE_FILE_RAW, since a + * malicious guest can turn a raw file into any other non-raw + * format at will. + * + * Best option: Don't use this function + */ +int +virStorageFileProbeFormat(const char *path, uid_t uid, gid_t gid) +{ + int fd, ret; + + if ((fd = virFileOpenAs(path, O_RDONLY, 0, uid, gid, 0)) < 0) { + virReportSystemError(errno, _("cannot open file '%s'"), path); + return -1; + } + + ret = virStorageFileProbeFormatFromFD(path, fd); + + VIR_FORCE_CLOSE(fd); + + return ret; +} + +/** + * virStorageFileGetMetadataFromFD: + * + * Extract metadata about the storage volume with the specified + * image format. If image format is VIR_STORAGE_FILE_AUTO, it + * will probe to automatically identify the format. Does not recurse. + * + * Callers are advised never to use VIR_STORAGE_FILE_AUTO as a + * format, since a malicious guest can turn a raw file into any + * other non-raw format at will. + * + * If the returned meta.backingStoreFormat is VIR_STORAGE_FILE_AUTO + * it indicates the image didn't specify an explicit format for its + * backing store. Callers are advised against probing for the + * backing store format in this case. + * + * Caller MUST free the result after use via virStorageFileFreeMetadata. + */ +virStorageFileMetadataPtr +virStorageFileGetMetadataFromFD(const char *path, + int fd, + int format) +{ + virStorageFileMetadata *meta = NULL; + unsigned char *head = NULL; + ssize_t len = STORAGE_MAX_HEAD; + virStorageFileMetadata *ret = NULL; + struct stat sb; + + if (VIR_ALLOC(meta) < 0) { + virReportOOMError(); + return NULL; + } + + if (fstat(fd, &sb) < 0) { + virReportSystemError(errno, + _("cannot stat file '%s'"), + path); + goto cleanup; + } + + /* No header to probe for directories, but also no backing file */ + if (S_ISDIR(sb.st_mode)) + return meta; + + if (lseek(fd, 0, SEEK_SET) == (off_t)-1) { + virReportSystemError(errno, _("cannot seek to start of '%s'"), path); + goto cleanup; + } + + if (VIR_ALLOC_N(head, len) < 0) { + virReportOOMError(); + goto cleanup; + } + + if ((len = read(fd, head, len)) < 0) { + virReportSystemError(errno, _("cannot read header '%s'"), path); + goto cleanup; + } + + if (format == VIR_STORAGE_FILE_AUTO) + format = virStorageFileProbeFormatFromBuf(path, head, len); + + if (format <= VIR_STORAGE_FILE_NONE || + format >= VIR_STORAGE_FILE_LAST) { + virReportSystemError(EINVAL, _("unknown storage file format %d"), + format); + goto cleanup; + } + + if (virStorageFileGetMetadataFromBuf(format, path, head, len, meta) < 0) + goto cleanup; + ret = meta; + meta = NULL; + +cleanup: + virStorageFileFreeMetadata(meta); + VIR_FREE(head); + return ret; +} + +/* Recursive workhorse for virStorageFileGetMetadata. */ +static virStorageFileMetadataPtr +virStorageFileGetMetadataRecurse(const char *path, int format, + uid_t uid, gid_t gid, + bool allow_probe, virHashTablePtr cycle) +{ + int fd; + VIR_DEBUG("path=%s format=%d uid=%d gid=%d probe=%d", + path, format, (int)uid, (int)gid, allow_probe); + + virStorageFileMetadataPtr ret = NULL; + + if (virHashLookup(cycle, path)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("backing store for %s is self-referential"), + path); + return NULL; + } + if (virHashAddEntry(cycle, path, (void *)1) < 0) + return NULL; + + if ((fd = virFileOpenAs(path, O_RDONLY, 0, uid, gid, 0)) < 0) { + virReportSystemError(-fd, _("cannot open file '%s'"), path); + return NULL; + } + + ret = virStorageFileGetMetadataFromFD(path, fd, format); + + if (VIR_CLOSE(fd) < 0) + VIR_WARN("could not close file %s", path); + + if (ret && ret->backingStoreIsFile) { + if (ret->backingStoreFormat == VIR_STORAGE_FILE_AUTO && !allow_probe) + ret->backingStoreFormat = VIR_STORAGE_FILE_RAW; + else if (ret->backingStoreFormat == VIR_STORAGE_FILE_AUTO_SAFE) + ret->backingStoreFormat = VIR_STORAGE_FILE_AUTO; + format = ret->backingStoreFormat; + ret->backingMeta = virStorageFileGetMetadataRecurse(ret->backingStore, + format, + uid, gid, + allow_probe, + cycle); + } + + return ret; +} + +/** + * virStorageFileGetMetadata: + * + * Extract metadata about the storage volume with the specified + * image format. If image format is VIR_STORAGE_FILE_AUTO, it + * will probe to automatically identify the format. Recurses through + * the entire chain. + * + * Open files using UID and GID (or pass -1 for the current user/group). + * Treat any backing files without explicit type as raw, unless ALLOW_PROBE. + * + * Callers are advised never to use VIR_STORAGE_FILE_AUTO as a + * format, since a malicious guest can turn a raw file into any + * other non-raw format at will. + * + * If the returned meta.backingStoreFormat is VIR_STORAGE_FILE_AUTO + * it indicates the image didn't specify an explicit format for its + * backing store. Callers are advised against using ALLOW_PROBE, as + * it would probe the backing store format in this case. + * + * Caller MUST free result after use via virStorageFileFreeMetadata. + */ +virStorageFileMetadataPtr +virStorageFileGetMetadata(const char *path, int format, + uid_t uid, gid_t gid, + bool allow_probe) +{ + VIR_DEBUG("path=%s format=%d uid=%d gid=%d probe=%d", + path, format, (int)uid, (int)gid, allow_probe); + + virHashTablePtr cycle = virHashCreate(5, NULL); + virStorageFileMetadataPtr ret; + + if (!cycle) + return NULL; + + if (format <= VIR_STORAGE_FILE_NONE) + format = allow_probe ? VIR_STORAGE_FILE_AUTO : VIR_STORAGE_FILE_RAW; + ret = virStorageFileGetMetadataRecurse(path, format, uid, gid, + allow_probe, cycle); + virHashFree(cycle); + return ret; +} + +/** + * virStorageFileFreeMetadata: + * + * Free pointers in passed structure and structure itself. + */ +void +virStorageFileFreeMetadata(virStorageFileMetadata *meta) +{ + if (!meta) + return; + + virStorageFileFreeMetadata(meta->backingMeta); + VIR_FREE(meta->backingStore); + VIR_FREE(meta->backingStoreRaw); + VIR_FREE(meta); +} + +/** + * virStorageFileResize: + * + * Change the capacity of the raw storage file at 'path'. + */ +int +virStorageFileResize(const char *path, unsigned long long capacity) +{ + int fd = -1; + int ret = -1; + + if ((fd = open(path, O_RDWR)) < 0) { + virReportSystemError(errno, _("Unable to open '%s'"), path); + goto cleanup; + } + + if (ftruncate(fd, capacity) < 0) { + virReportSystemError(errno, _("Failed to truncate file '%s'"), path); + goto cleanup; + } + + if (VIR_CLOSE(fd) < 0) { + virReportSystemError(errno, _("Unable to save '%s'"), path); + goto cleanup; + } + + ret = 0; + +cleanup: + VIR_FORCE_CLOSE(fd); + return ret; +} + +#ifdef __linux__ + +# ifndef NFS_SUPER_MAGIC +# define NFS_SUPER_MAGIC 0x6969 +# endif +# ifndef OCFS2_SUPER_MAGIC +# define OCFS2_SUPER_MAGIC 0x7461636f +# endif +# ifndef GFS2_MAGIC +# define GFS2_MAGIC 0x01161970 +# endif +# ifndef AFS_FS_MAGIC +# define AFS_FS_MAGIC 0x6B414653 +# endif + + +int virStorageFileIsSharedFSType(const char *path, + int fstypes) +{ + char *dirpath, *p; + struct statfs sb; + int statfs_ret; + + if ((dirpath = strdup(path)) == NULL) { + virReportOOMError(); + return -1; + } + + do { + + /* Try less and less of the path until we get to a + * directory we can stat. Even if we don't have 'x' + * permission on any directory in the path on the NFS + * server (assuming it's NFS), we will be able to stat the + * mount point, and that will properly tell us if the + * fstype is NFS. + */ + + if ((p = strrchr(dirpath, '/')) == NULL) { + virReportSystemError(EINVAL, + _("Invalid relative path '%s'"), path); + VIR_FREE(dirpath); + return -1; + } + + if (p == dirpath) + *(p+1) = '\0'; + else + *p = '\0'; + + statfs_ret = statfs(dirpath, &sb); + + } while ((statfs_ret < 0) && (p != dirpath)); + + VIR_FREE(dirpath); + + if (statfs_ret < 0) { + virReportSystemError(errno, + _("cannot determine filesystem for '%s'"), + path); + return -1; + } + + VIR_DEBUG("Check if path %s with FS magic %lld is shared", + path, (long long int)sb.f_type); + + if ((fstypes & VIR_STORAGE_FILE_SHFS_NFS) && + (sb.f_type == NFS_SUPER_MAGIC)) + return 1; + + if ((fstypes & VIR_STORAGE_FILE_SHFS_GFS2) && + (sb.f_type == GFS2_MAGIC)) + return 1; + if ((fstypes & VIR_STORAGE_FILE_SHFS_OCFS) && + (sb.f_type == OCFS2_SUPER_MAGIC)) + return 1; + if ((fstypes & VIR_STORAGE_FILE_SHFS_AFS) && + (sb.f_type == AFS_FS_MAGIC)) + return 1; + + return 0; +} +#else +int virStorageFileIsSharedFSType(const char *path ATTRIBUTE_UNUSED, + int fstypes ATTRIBUTE_UNUSED) +{ + /* XXX implement me :-) */ + return 0; +} +#endif + +int virStorageFileIsSharedFS(const char *path) +{ + return virStorageFileIsSharedFSType(path, + VIR_STORAGE_FILE_SHFS_NFS | + VIR_STORAGE_FILE_SHFS_GFS2 | + VIR_STORAGE_FILE_SHFS_OCFS | + VIR_STORAGE_FILE_SHFS_AFS); +} + +int virStorageFileIsClusterFS(const char *path) +{ + /* These are coherent cluster filesystems known to be safe for + * migration with cache != none + */ + return virStorageFileIsSharedFSType(path, + VIR_STORAGE_FILE_SHFS_GFS2 | + VIR_STORAGE_FILE_SHFS_OCFS); +} + +#ifdef LVS +int virStorageFileGetLVMKey(const char *path, + char **key) +{ + /* + * # lvs --noheadings --unbuffered --nosuffix --options "uuid" LVNAME + * 06UgP5-2rhb-w3Bo-3mdR-WeoL-pytO-SAa2ky + */ + int status; + virCommandPtr cmd = virCommandNewArgList( + LVS, + "--noheadings", "--unbuffered", "--nosuffix", + "--options", "uuid", path, + NULL + ); + int ret = -1; + + *key = NULL; + + /* Run the program and capture its output */ + virCommandSetOutputBuffer(cmd, key); + if (virCommandRun(cmd, &status) < 0) + goto cleanup; + + /* Explicitly check status == 0, rather than passing NULL + * to virCommandRun because we don't want to raise an actual + * error in this scenario, just return a NULL key. + */ + + if (status == 0 && *key) { + char *nl; + char *tmp = *key; + + /* Find first non-space character */ + while (*tmp && c_isspace(*tmp)) { + tmp++; + } + /* Kill leading spaces */ + if (tmp != *key) + memmove(*key, tmp, strlen(tmp)+1); + + /* Kill trailing newline */ + if ((nl = strchr(*key, '\n'))) + *nl = '\0'; + } + + ret = 0; + +cleanup: + if (*key && STREQ(*key, "")) + VIR_FREE(*key); + + virCommandFree(cmd); + + return ret; +} +#else +int virStorageFileGetLVMKey(const char *path, + char **key ATTRIBUTE_UNUSED) +{ + virReportSystemError(ENOSYS, _("Unable to get LVM key for %s"), path); + return -1; +} +#endif + +#ifdef HAVE_UDEV +int virStorageFileGetSCSIKey(const char *path, + char **key) +{ + int status; + virCommandPtr cmd = virCommandNewArgList( + "/lib/udev/scsi_id", + "--replace-whitespace", + "--whitelisted", + "--device", path, + NULL + ); + int ret = -1; + + *key = NULL; + + /* Run the program and capture its output */ + virCommandSetOutputBuffer(cmd, key); + if (virCommandRun(cmd, &status) < 0) + goto cleanup; + + /* Explicitly check status == 0, rather than passing NULL + * to virCommandRun because we don't want to raise an actual + * error in this scenario, just return a NULL key. + */ + if (status == 0 && *key) { + char *nl = strchr(*key, '\n'); + if (nl) + *nl = '\0'; + } + + ret = 0; + +cleanup: + if (*key && STREQ(*key, "")) + VIR_FREE(*key); + + virCommandFree(cmd); + + return ret; +} +#else +int virStorageFileGetSCSIKey(const char *path, + char **key ATTRIBUTE_UNUSED) +{ + virReportSystemError(ENOSYS, _("Unable to get SCSI key for %s"), path); + return -1; +} +#endif + +/* Given a CHAIN that starts at the named file START, return a string + * pointing to either START or within CHAIN that gives the preferred + * name for the backing file NAME within that chain. Pass NULL for + * NAME to find the base of the chain. If META is not NULL, set *META + * to the point in the chain that describes NAME (or to NULL if the + * backing element is not a file). If PARENT is not NULL, set *PARENT + * to the preferred name of the parent (or to NULL if NAME matches + * START). Since the results point within CHAIN, they must not be + * independently freed. */ +const char * +virStorageFileChainLookup(virStorageFileMetadataPtr chain, const char *start, + const char *name, virStorageFileMetadataPtr *meta, + const char **parent) +{ + virStorageFileMetadataPtr owner; + const char *tmp; + + if (!parent) + parent = &tmp; + + *parent = NULL; + if (name ? STREQ(start, name) || virFileLinkPointsTo(start, name) : + !chain->backingStore) { + if (meta) + *meta = chain; + return start; + } + + owner = chain; + *parent = start; + while (owner) { + if (!owner->backingStore) + goto error; + if (!name) { + if (!owner->backingMeta || + !owner->backingMeta->backingStore) + break; + } else if (STREQ_NULLABLE(name, owner->backingStoreRaw) || + STREQ(name, owner->backingStore)) { + break; + } else if (owner->backingStoreIsFile) { + char *absName = absolutePathFromBaseFile(*parent, name); + if (absName && STREQ(absName, owner->backingStore)) { + VIR_FREE(absName); + break; + } + VIR_FREE(absName); + } + *parent = owner->backingStore; + owner = owner->backingMeta; + } + if (!owner) + goto error; + if (meta) + *meta = owner->backingMeta; + return owner->backingStore; + +error: + *parent = NULL; + if (meta) + *meta = NULL; + return NULL; +} diff --git a/src/util/virstoragefile.h b/src/util/virstoragefile.h new file mode 100644 index 0000000..6fbd275 --- /dev/null +++ b/src/util/virstoragefile.h @@ -0,0 +1,109 @@ +/* + * storage_file.c: file utility functions for FS storage backend + * + * Copyright (C) 2007-2009, 2012 Red Hat, Inc. + * Copyright (C) 2007-2008 Daniel P. Berrange + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Author: Daniel P. Berrange <berrange(a)redhat.com&gt; + */ + +#ifndef __VIR_STORAGE_FILE_H__ +# define __VIR_STORAGE_FILE_H__ + +# include "util.h" + +enum virStorageFileFormat { + VIR_STORAGE_FILE_AUTO_SAFE = -2, + VIR_STORAGE_FILE_AUTO = -1, + VIR_STORAGE_FILE_NONE = 0, + VIR_STORAGE_FILE_RAW, + VIR_STORAGE_FILE_DIR, + VIR_STORAGE_FILE_BOCHS, + VIR_STORAGE_FILE_CLOOP, + VIR_STORAGE_FILE_COW, + VIR_STORAGE_FILE_DMG, + VIR_STORAGE_FILE_ISO, + VIR_STORAGE_FILE_QCOW, + VIR_STORAGE_FILE_QCOW2, + VIR_STORAGE_FILE_QED, + VIR_STORAGE_FILE_VMDK, + VIR_STORAGE_FILE_VPC, + VIR_STORAGE_FILE_FAT, + VIR_STORAGE_FILE_VHD, + + VIR_STORAGE_FILE_LAST, +}; + +VIR_ENUM_DECL(virStorageFileFormat); + +typedef struct _virStorageFileMetadata virStorageFileMetadata; +typedef virStorageFileMetadata *virStorageFileMetadataPtr; +struct _virStorageFileMetadata { + char *backingStore; /* Canonical name (absolute file, or protocol) */ + char *backingStoreRaw; /* If file, original name, possibly relative */ + int backingStoreFormat; /* enum virStorageFileFormat */ + bool backingStoreIsFile; + virStorageFileMetadataPtr backingMeta; + unsigned long long capacity; + bool encrypted; +}; + +# ifndef DEV_BSIZE +# define DEV_BSIZE 512 +# endif + +int virStorageFileProbeFormat(const char *path, uid_t uid, gid_t gid); +int virStorageFileProbeFormatFromFD(const char *path, + int fd); + +virStorageFileMetadataPtr virStorageFileGetMetadata(const char *path, + int format, + uid_t uid, gid_t gid, + bool allow_probe); +virStorageFileMetadataPtr virStorageFileGetMetadataFromFD(const char *path, + int fd, + int format); + +const char *virStorageFileChainLookup(virStorageFileMetadataPtr chain, + const char *start, + const char *name, + virStorageFileMetadataPtr *meta, + const char **parent) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2); + +void virStorageFileFreeMetadata(virStorageFileMetadataPtr meta); + +int virStorageFileResize(const char *path, unsigned long long capacity); + +enum { + VIR_STORAGE_FILE_SHFS_NFS = (1 << 0), + VIR_STORAGE_FILE_SHFS_GFS2 = (1 << 1), + VIR_STORAGE_FILE_SHFS_OCFS = (1 << 2), + VIR_STORAGE_FILE_SHFS_AFS = (1 << 3), +}; + +int virStorageFileIsSharedFS(const char *path); +int virStorageFileIsClusterFS(const char *path); +int virStorageFileIsSharedFSType(const char *path, + int fstypes); + +int virStorageFileGetLVMKey(const char *path, + char **key); +int virStorageFileGetSCSIKey(const char *path, + char **key); + +#endif /* __VIR_STORAGE_FILE_H__ */ diff --git a/src/vbox/vbox_tmpl.c b/src/vbox/vbox_tmpl.c index daa90bf..923ff04 100644 --- a/src/vbox/vbox_tmpl.c +++ b/src/vbox/vbox_tmpl.c @@ -48,7 +48,7 @@ #include "virterror_internal.h" #include "domain_event.h" #include "storage_conf.h" -#include "storage_file.h" +#include "virstoragefile.h" #include "uuid.h" #include "viralloc.h" #include "nodeinfo.h" diff --git a/src/xenxs/xen_sxpr.c b/src/xenxs/xen_sxpr.c index 0cbc248..b28c538 100644 --- a/src/xenxs/xen_sxpr.c +++ b/src/xenxs/xen_sxpr.c @@ -36,7 +36,7 @@ #include "count-one-bits.h" #include "xenxs_private.h" #include "xen_sxpr.h" -#include "storage_file.h" +#include "virstoragefile.h" /* Get a domain id from a S-expression string */ int xenGetDomIdFromSxprString(const char *sexpr, int xendConfigVersion) diff --git a/src/xenxs/xen_xm.c b/src/xenxs/xen_xm.c index c29df1c..007036b 100644 --- a/src/xenxs/xen_xm.c +++ b/src/xenxs/xen_xm.c @@ -37,7 +37,7 @@ #include "xen_xm.h" #include "xen_sxpr.h" #include "domain_conf.h" -#include "storage_file.h" +#include "virstoragefile.h" /* Convenience method to grab a long int from the config file object */ static int xenXMConfigGetBool(virConfPtr conf, -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- src/Makefile.am | 2 +- src/nwfilter/nwfilter_dhcpsnoop.c | 2 +- src/qemu/qemu_conf.h | 2 +- src/qemu/qemu_driver.c | 2 +- src/rpc/virnetserver.c | 2 +- src/util/threadpool.c | 371 -------------------------------------- src/util/threadpool.h | 53 ------ src/util/virthreadpool.c | 371 ++++++++++++++++++++++++++++++++++++++ src/util/virthreadpool.h | 53 ++++++ 9 files changed, 429 insertions(+), 429 deletions(-) delete mode 100644 src/util/threadpool.c delete mode 100644 src/util/threadpool.h create mode 100644 src/util/virthreadpool.c create mode 100644 src/util/virthreadpool.h diff --git a/src/Makefile.am b/src/Makefile.am index 376c543..e74a3a3 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -56,7 +56,6 @@ UTIL_SOURCES = \ util/threads.c util/threads.h \ util/threads-pthread.h \ util/threads-win32.h \ - util/threadpool.c util/threadpool.h \ util/uuid.c util/uuid.h \ util/util.c util/util.h \ util/viralloc.c util/viralloc.h \ @@ -86,6 +85,7 @@ UTIL_SOURCES = \ util/virstatslinux.c util/virstatslinux.h \ util/virstoragefile.c util/virstoragefile.h \ util/virsysinfo.c util/virsysinfo.h \ + util/virthreadpool.c util/virthreadpool.h \ util/virtypedparam.c util/virtypedparam.h \ util/xml.c util/xml.h \ util/virterror.c util/virterror_internal.h \ diff --git a/src/nwfilter/nwfilter_dhcpsnoop.c b/src/nwfilter/nwfilter_dhcpsnoop.c index a798e95..c1ab622 100644 --- a/src/nwfilter/nwfilter_dhcpsnoop.c +++ b/src/nwfilter/nwfilter_dhcpsnoop.c @@ -65,7 +65,7 @@ #include "virnetdev.h" #include "virfile.h" #include "viratomic.h" -#include "threadpool.h" +#include "virthreadpool.h" #include "configmake.h" #include "virtime.h" diff --git a/src/qemu/qemu_conf.h b/src/qemu/qemu_conf.h index f928c29..0d4816e 100644 --- a/src/qemu/qemu_conf.h +++ b/src/qemu/qemu_conf.h @@ -41,7 +41,7 @@ # include "driver.h" # include "virbitmap.h" # include "vircommand.h" -# include "threadpool.h" +# include "virthreadpool.h" # include "locking/lock_manager.h" # include "qemu_capabilities.h" diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c index 0038d95..170f15d 100644 --- a/src/qemu/qemu_driver.c +++ b/src/qemu/qemu_driver.c @@ -85,7 +85,7 @@ #include "virfile.h" #include "fdstream.h" #include "configmake.h" -#include "threadpool.h" +#include "virthreadpool.h" #include "locking/lock_manager.h" #include "locking/domain_lock.h" #include "virkeycode.h" diff --git a/src/rpc/virnetserver.c b/src/rpc/virnetserver.c index 67cd4b5..26ceb0c 100644 --- a/src/rpc/virnetserver.c +++ b/src/rpc/virnetserver.c @@ -32,7 +32,7 @@ #include "viralloc.h" #include "virterror_internal.h" #include "threads.h" -#include "threadpool.h" +#include "virthreadpool.h" #include "util.h" #include "virfile.h" #include "virnetservermdns.h" diff --git a/src/util/threadpool.c b/src/util/threadpool.c deleted file mode 100644 index 9d3d5d2..0000000 --- a/src/util/threadpool.c +++ /dev/null @@ -1,371 +0,0 @@ -/* - * threadpool.c: a generic thread pool implementation - * - * Copyright (C) 2010 Hu Tao - * Copyright (C) 2010 Daniel P. Berrange - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Authors: - * Hu Tao <hutao(a)cn.fujitsu.com&gt; - * Daniel P. Berrange <berrange(a)redhat.com&gt; - */ - -#include <config.h> - -#include "threadpool.h" -#include "viralloc.h" -#include "threads.h" -#include "virterror_internal.h" - -#define VIR_FROM_THIS VIR_FROM_NONE - -typedef struct _virThreadPoolJob virThreadPoolJob; -typedef virThreadPoolJob *virThreadPoolJobPtr; - -struct _virThreadPoolJob { - virThreadPoolJobPtr prev; - virThreadPoolJobPtr next; - unsigned int priority; - - void *data; -}; - -typedef struct _virThreadPoolJobList virThreadPoolJobList; -typedef virThreadPoolJobList *virThreadPoolJobListPtr; - -struct _virThreadPoolJobList { - virThreadPoolJobPtr head; - virThreadPoolJobPtr tail; - virThreadPoolJobPtr firstPrio; -}; - - -struct _virThreadPool { - bool quit; - - virThreadPoolJobFunc jobFunc; - void *jobOpaque; - virThreadPoolJobList jobList; - size_t jobQueueDepth; - - virMutex mutex; - virCond cond; - virCond quit_cond; - - size_t maxWorkers; - size_t minWorkers; - size_t freeWorkers; - size_t nWorkers; - virThreadPtr workers; - - size_t nPrioWorkers; - virThreadPtr prioWorkers; - virCond prioCond; -}; - -struct virThreadPoolWorkerData { - virThreadPoolPtr pool; - virCondPtr cond; - bool priority; -}; - -static void virThreadPoolWorker(void *opaque) -{ - struct virThreadPoolWorkerData *data = opaque; - virThreadPoolPtr pool = data->pool; - virCondPtr cond = data->cond; - bool priority = data->priority; - virThreadPoolJobPtr job = NULL; - - VIR_FREE(data); - - virMutexLock(&pool->mutex); - - while (1) { - while (!pool->quit && - ((!priority && !pool->jobList.head) || - (priority && !pool->jobList.firstPrio))) { - if (!priority) - pool->freeWorkers++; - if (virCondWait(cond, &pool->mutex) < 0) { - if (!priority) - pool->freeWorkers--; - goto out; - } - if (!priority) - pool->freeWorkers--; - } - - if (pool->quit) - break; - - if (priority) { - job = pool->jobList.firstPrio; - } else { - job = pool->jobList.head; - } - - if (job == pool->jobList.firstPrio) { - virThreadPoolJobPtr tmp = job->next; - while (tmp) { - if (tmp->priority) { - break; - } - tmp = tmp->next; - } - pool->jobList.firstPrio = tmp; - } - - if (job->prev) - job->prev->next = job->next; - else - pool->jobList.head = job->next; - if (job->next) - job->next->prev = job->prev; - else - pool->jobList.tail = job->prev; - - pool->jobQueueDepth--; - - virMutexUnlock(&pool->mutex); - (pool->jobFunc)(job->data, pool->jobOpaque); - VIR_FREE(job); - virMutexLock(&pool->mutex); - } - -out: - if (priority) - pool->nPrioWorkers--; - else - pool->nWorkers--; - if (pool->nWorkers == 0 && pool->nPrioWorkers==0) - virCondSignal(&pool->quit_cond); - virMutexUnlock(&pool->mutex); -} - -virThreadPoolPtr virThreadPoolNew(size_t minWorkers, - size_t maxWorkers, - size_t prioWorkers, - virThreadPoolJobFunc func, - void *opaque) -{ - virThreadPoolPtr pool; - size_t i; - struct virThreadPoolWorkerData *data = NULL; - - if (minWorkers > maxWorkers) - minWorkers = maxWorkers; - - if (VIR_ALLOC(pool) < 0) { - virReportOOMError(); - return NULL; - } - - pool->jobList.tail = pool->jobList.head = NULL; - - pool->jobFunc = func; - pool->jobOpaque = opaque; - - if (virMutexInit(&pool->mutex) < 0) - goto error; - if (virCondInit(&pool->cond) < 0) - goto error; - if (virCondInit(&pool->quit_cond) < 0) - goto error; - - if (VIR_ALLOC_N(pool->workers, minWorkers) < 0) - goto error; - - pool->minWorkers = minWorkers; - pool->maxWorkers = maxWorkers; - - for (i = 0; i < minWorkers; i++) { - if (VIR_ALLOC(data) < 0) { - virReportOOMError(); - goto error; - } - data->pool = pool; - data->cond = &pool->cond; - - if (virThreadCreate(&pool->workers[i], - true, - virThreadPoolWorker, - data) < 0) { - goto error; - } - pool->nWorkers++; - } - - if (prioWorkers) { - if (virCondInit(&pool->prioCond) < 0) - goto error; - if (VIR_ALLOC_N(pool->prioWorkers, prioWorkers) < 0) - goto error; - - for (i = 0; i < prioWorkers; i++) { - if (VIR_ALLOC(data) < 0) { - virReportOOMError(); - goto error; - } - data->pool = pool; - data->cond = &pool->prioCond; - data->priority = true; - - if (virThreadCreate(&pool->prioWorkers[i], - true, - virThreadPoolWorker, - data) < 0) { - goto error; - } - pool->nPrioWorkers++; - } - } - - return pool; - -error: - VIR_FREE(data); - virThreadPoolFree(pool); - return NULL; - -} - -void virThreadPoolFree(virThreadPoolPtr pool) -{ - virThreadPoolJobPtr job; - bool priority = false; - - if (!pool) - return; - - virMutexLock(&pool->mutex); - pool->quit = true; - if (pool->nWorkers > 0) - virCondBroadcast(&pool->cond); - if (pool->nPrioWorkers > 0) { - priority = true; - virCondBroadcast(&pool->prioCond); - } - - while (pool->nWorkers > 0 || pool->nPrioWorkers > 0) - ignore_value(virCondWait(&pool->quit_cond, &pool->mutex)); - - while ((job = pool->jobList.head)) { - pool->jobList.head = pool->jobList.head->next; - VIR_FREE(job); - } - - VIR_FREE(pool->workers); - virMutexUnlock(&pool->mutex); - virMutexDestroy(&pool->mutex); - ignore_value(virCondDestroy(&pool->quit_cond)); - ignore_value(virCondDestroy(&pool->cond)); - if (priority) { - VIR_FREE(pool->prioWorkers); - ignore_value(virCondDestroy(&pool->prioCond)); - } - VIR_FREE(pool); -} - - -size_t virThreadPoolGetMinWorkers(virThreadPoolPtr pool) -{ - return pool->minWorkers; -} - -size_t virThreadPoolGetMaxWorkers(virThreadPoolPtr pool) -{ - return pool->maxWorkers; -} - -size_t virThreadPoolGetPriorityWorkers(virThreadPoolPtr pool) -{ - return pool->nPrioWorkers; -} - -/* - * @priority - job priority - * Return: 0 on success, -1 otherwise - */ -int virThreadPoolSendJob(virThreadPoolPtr pool, - unsigned int priority, - void *jobData) -{ - virThreadPoolJobPtr job; - struct virThreadPoolWorkerData *data = NULL; - - virMutexLock(&pool->mutex); - if (pool->quit) - goto error; - - if (pool->freeWorkers - pool->jobQueueDepth <= 0 && - pool->nWorkers < pool->maxWorkers) { - if (VIR_EXPAND_N(pool->workers, pool->nWorkers, 1) < 0) { - virReportOOMError(); - goto error; - } - - if (VIR_ALLOC(data) < 0) { - pool->nWorkers--; - virReportOOMError(); - goto error; - } - - data->pool = pool; - data->cond = &pool->cond; - - if (virThreadCreate(&pool->workers[pool->nWorkers - 1], - true, - virThreadPoolWorker, - data) < 0) { - VIR_FREE(data); - pool->nWorkers--; - goto error; - } - } - - if (VIR_ALLOC(job) < 0) { - virReportOOMError(); - goto error; - } - - job->data = jobData; - job->priority = priority; - - job->prev = pool->jobList.tail; - if (pool->jobList.tail) - pool->jobList.tail->next = job; - pool->jobList.tail = job; - - if (!pool->jobList.head) - pool->jobList.head = job; - - if (priority && !pool->jobList.firstPrio) - pool->jobList.firstPrio = job; - - pool->jobQueueDepth++; - - virCondSignal(&pool->cond); - if (priority) - virCondSignal(&pool->prioCond); - - virMutexUnlock(&pool->mutex); - return 0; - -error: - virMutexUnlock(&pool->mutex); - return -1; -} diff --git a/src/util/threadpool.h b/src/util/threadpool.h deleted file mode 100644 index 4479647..0000000 --- a/src/util/threadpool.h +++ /dev/null @@ -1,53 +0,0 @@ -/* - * threadpool.h: a generic thread pool implementation - * - * Copyright (C) 2010 Hu Tao - * Copyright (C) 2010 Daniel P. Berrange - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Author: - * Hu Tao <hutao(a)cn.fujitsu.com&gt; - * Daniel P. Berrange <berrange(a)redhat.com&gt; - */ - -#ifndef __VIR_THREADPOOL_H__ -# define __VIR_THREADPOOL_H__ - -# include "internal.h" - -typedef struct _virThreadPool virThreadPool; -typedef virThreadPool *virThreadPoolPtr; - -typedef void (*virThreadPoolJobFunc)(void *jobdata, void *opaque); - -virThreadPoolPtr virThreadPoolNew(size_t minWorkers, - size_t maxWorkers, - size_t prioWorkers, - virThreadPoolJobFunc func, - void *opaque) ATTRIBUTE_NONNULL(4); - -size_t virThreadPoolGetMinWorkers(virThreadPoolPtr pool); -size_t virThreadPoolGetMaxWorkers(virThreadPoolPtr pool); -size_t virThreadPoolGetPriorityWorkers(virThreadPoolPtr pool); - -void virThreadPoolFree(virThreadPoolPtr pool); - -int virThreadPoolSendJob(virThreadPoolPtr pool, - unsigned int priority, - void *jobdata) ATTRIBUTE_NONNULL(1) - ATTRIBUTE_RETURN_CHECK; - -#endif diff --git a/src/util/virthreadpool.c b/src/util/virthreadpool.c new file mode 100644 index 0000000..c13b078 --- /dev/null +++ b/src/util/virthreadpool.c @@ -0,0 +1,371 @@ +/* + * threadpool.c: a generic thread pool implementation + * + * Copyright (C) 2010 Hu Tao + * Copyright (C) 2010 Daniel P. Berrange + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Authors: + * Hu Tao <hutao(a)cn.fujitsu.com&gt; + * Daniel P. Berrange <berrange(a)redhat.com&gt; + */ + +#include <config.h> + +#include "virthreadpool.h" +#include "viralloc.h" +#include "threads.h" +#include "virterror_internal.h" + +#define VIR_FROM_THIS VIR_FROM_NONE + +typedef struct _virThreadPoolJob virThreadPoolJob; +typedef virThreadPoolJob *virThreadPoolJobPtr; + +struct _virThreadPoolJob { + virThreadPoolJobPtr prev; + virThreadPoolJobPtr next; + unsigned int priority; + + void *data; +}; + +typedef struct _virThreadPoolJobList virThreadPoolJobList; +typedef virThreadPoolJobList *virThreadPoolJobListPtr; + +struct _virThreadPoolJobList { + virThreadPoolJobPtr head; + virThreadPoolJobPtr tail; + virThreadPoolJobPtr firstPrio; +}; + + +struct _virThreadPool { + bool quit; + + virThreadPoolJobFunc jobFunc; + void *jobOpaque; + virThreadPoolJobList jobList; + size_t jobQueueDepth; + + virMutex mutex; + virCond cond; + virCond quit_cond; + + size_t maxWorkers; + size_t minWorkers; + size_t freeWorkers; + size_t nWorkers; + virThreadPtr workers; + + size_t nPrioWorkers; + virThreadPtr prioWorkers; + virCond prioCond; +}; + +struct virThreadPoolWorkerData { + virThreadPoolPtr pool; + virCondPtr cond; + bool priority; +}; + +static void virThreadPoolWorker(void *opaque) +{ + struct virThreadPoolWorkerData *data = opaque; + virThreadPoolPtr pool = data->pool; + virCondPtr cond = data->cond; + bool priority = data->priority; + virThreadPoolJobPtr job = NULL; + + VIR_FREE(data); + + virMutexLock(&pool->mutex); + + while (1) { + while (!pool->quit && + ((!priority && !pool->jobList.head) || + (priority && !pool->jobList.firstPrio))) { + if (!priority) + pool->freeWorkers++; + if (virCondWait(cond, &pool->mutex) < 0) { + if (!priority) + pool->freeWorkers--; + goto out; + } + if (!priority) + pool->freeWorkers--; + } + + if (pool->quit) + break; + + if (priority) { + job = pool->jobList.firstPrio; + } else { + job = pool->jobList.head; + } + + if (job == pool->jobList.firstPrio) { + virThreadPoolJobPtr tmp = job->next; + while (tmp) { + if (tmp->priority) { + break; + } + tmp = tmp->next; + } + pool->jobList.firstPrio = tmp; + } + + if (job->prev) + job->prev->next = job->next; + else + pool->jobList.head = job->next; + if (job->next) + job->next->prev = job->prev; + else + pool->jobList.tail = job->prev; + + pool->jobQueueDepth--; + + virMutexUnlock(&pool->mutex); + (pool->jobFunc)(job->data, pool->jobOpaque); + VIR_FREE(job); + virMutexLock(&pool->mutex); + } + +out: + if (priority) + pool->nPrioWorkers--; + else + pool->nWorkers--; + if (pool->nWorkers == 0 && pool->nPrioWorkers==0) + virCondSignal(&pool->quit_cond); + virMutexUnlock(&pool->mutex); +} + +virThreadPoolPtr virThreadPoolNew(size_t minWorkers, + size_t maxWorkers, + size_t prioWorkers, + virThreadPoolJobFunc func, + void *opaque) +{ + virThreadPoolPtr pool; + size_t i; + struct virThreadPoolWorkerData *data = NULL; + + if (minWorkers > maxWorkers) + minWorkers = maxWorkers; + + if (VIR_ALLOC(pool) < 0) { + virReportOOMError(); + return NULL; + } + + pool->jobList.tail = pool->jobList.head = NULL; + + pool->jobFunc = func; + pool->jobOpaque = opaque; + + if (virMutexInit(&pool->mutex) < 0) + goto error; + if (virCondInit(&pool->cond) < 0) + goto error; + if (virCondInit(&pool->quit_cond) < 0) + goto error; + + if (VIR_ALLOC_N(pool->workers, minWorkers) < 0) + goto error; + + pool->minWorkers = minWorkers; + pool->maxWorkers = maxWorkers; + + for (i = 0; i < minWorkers; i++) { + if (VIR_ALLOC(data) < 0) { + virReportOOMError(); + goto error; + } + data->pool = pool; + data->cond = &pool->cond; + + if (virThreadCreate(&pool->workers[i], + true, + virThreadPoolWorker, + data) < 0) { + goto error; + } + pool->nWorkers++; + } + + if (prioWorkers) { + if (virCondInit(&pool->prioCond) < 0) + goto error; + if (VIR_ALLOC_N(pool->prioWorkers, prioWorkers) < 0) + goto error; + + for (i = 0; i < prioWorkers; i++) { + if (VIR_ALLOC(data) < 0) { + virReportOOMError(); + goto error; + } + data->pool = pool; + data->cond = &pool->prioCond; + data->priority = true; + + if (virThreadCreate(&pool->prioWorkers[i], + true, + virThreadPoolWorker, + data) < 0) { + goto error; + } + pool->nPrioWorkers++; + } + } + + return pool; + +error: + VIR_FREE(data); + virThreadPoolFree(pool); + return NULL; + +} + +void virThreadPoolFree(virThreadPoolPtr pool) +{ + virThreadPoolJobPtr job; + bool priority = false; + + if (!pool) + return; + + virMutexLock(&pool->mutex); + pool->quit = true; + if (pool->nWorkers > 0) + virCondBroadcast(&pool->cond); + if (pool->nPrioWorkers > 0) { + priority = true; + virCondBroadcast(&pool->prioCond); + } + + while (pool->nWorkers > 0 || pool->nPrioWorkers > 0) + ignore_value(virCondWait(&pool->quit_cond, &pool->mutex)); + + while ((job = pool->jobList.head)) { + pool->jobList.head = pool->jobList.head->next; + VIR_FREE(job); + } + + VIR_FREE(pool->workers); + virMutexUnlock(&pool->mutex); + virMutexDestroy(&pool->mutex); + ignore_value(virCondDestroy(&pool->quit_cond)); + ignore_value(virCondDestroy(&pool->cond)); + if (priority) { + VIR_FREE(pool->prioWorkers); + ignore_value(virCondDestroy(&pool->prioCond)); + } + VIR_FREE(pool); +} + + +size_t virThreadPoolGetMinWorkers(virThreadPoolPtr pool) +{ + return pool->minWorkers; +} + +size_t virThreadPoolGetMaxWorkers(virThreadPoolPtr pool) +{ + return pool->maxWorkers; +} + +size_t virThreadPoolGetPriorityWorkers(virThreadPoolPtr pool) +{ + return pool->nPrioWorkers; +} + +/* + * @priority - job priority + * Return: 0 on success, -1 otherwise + */ +int virThreadPoolSendJob(virThreadPoolPtr pool, + unsigned int priority, + void *jobData) +{ + virThreadPoolJobPtr job; + struct virThreadPoolWorkerData *data = NULL; + + virMutexLock(&pool->mutex); + if (pool->quit) + goto error; + + if (pool->freeWorkers - pool->jobQueueDepth <= 0 && + pool->nWorkers < pool->maxWorkers) { + if (VIR_EXPAND_N(pool->workers, pool->nWorkers, 1) < 0) { + virReportOOMError(); + goto error; + } + + if (VIR_ALLOC(data) < 0) { + pool->nWorkers--; + virReportOOMError(); + goto error; + } + + data->pool = pool; + data->cond = &pool->cond; + + if (virThreadCreate(&pool->workers[pool->nWorkers - 1], + true, + virThreadPoolWorker, + data) < 0) { + VIR_FREE(data); + pool->nWorkers--; + goto error; + } + } + + if (VIR_ALLOC(job) < 0) { + virReportOOMError(); + goto error; + } + + job->data = jobData; + job->priority = priority; + + job->prev = pool->jobList.tail; + if (pool->jobList.tail) + pool->jobList.tail->next = job; + pool->jobList.tail = job; + + if (!pool->jobList.head) + pool->jobList.head = job; + + if (priority && !pool->jobList.firstPrio) + pool->jobList.firstPrio = job; + + pool->jobQueueDepth++; + + virCondSignal(&pool->cond); + if (priority) + virCondSignal(&pool->prioCond); + + virMutexUnlock(&pool->mutex); + return 0; + +error: + virMutexUnlock(&pool->mutex); + return -1; +} diff --git a/src/util/virthreadpool.h b/src/util/virthreadpool.h new file mode 100644 index 0000000..4479647 --- /dev/null +++ b/src/util/virthreadpool.h @@ -0,0 +1,53 @@ +/* + * threadpool.h: a generic thread pool implementation + * + * Copyright (C) 2010 Hu Tao + * Copyright (C) 2010 Daniel P. Berrange + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Author: + * Hu Tao <hutao(a)cn.fujitsu.com&gt; + * Daniel P. Berrange <berrange(a)redhat.com&gt; + */ + +#ifndef __VIR_THREADPOOL_H__ +# define __VIR_THREADPOOL_H__ + +# include "internal.h" + +typedef struct _virThreadPool virThreadPool; +typedef virThreadPool *virThreadPoolPtr; + +typedef void (*virThreadPoolJobFunc)(void *jobdata, void *opaque); + +virThreadPoolPtr virThreadPoolNew(size_t minWorkers, + size_t maxWorkers, + size_t prioWorkers, + virThreadPoolJobFunc func, + void *opaque) ATTRIBUTE_NONNULL(4); + +size_t virThreadPoolGetMinWorkers(virThreadPoolPtr pool); +size_t virThreadPoolGetMaxWorkers(virThreadPoolPtr pool); +size_t virThreadPoolGetPriorityWorkers(virThreadPoolPtr pool); + +void virThreadPoolFree(virThreadPoolPtr pool); + +int virThreadPoolSendJob(virThreadPoolPtr pool, + unsigned int priority, + void *jobdata) ATTRIBUTE_NONNULL(1) + ATTRIBUTE_RETURN_CHECK; + +#endif -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- cfg.mk | 16 +- daemon/libvirtd.c | 2 +- daemon/remote.c | 2 +- po/POTFILES.in | 2 +- python/libvirt-override.c | 2 +- src/Makefile.am | 5 +- src/conf/capabilities.c | 2 +- src/conf/cpu_conf.c | 2 +- src/conf/cpu_conf.h | 2 +- src/conf/device_conf.c | 2 +- src/conf/device_conf.h | 2 +- src/conf/domain_conf.c | 2 +- src/conf/domain_conf.h | 2 +- src/conf/interface_conf.c | 2 +- src/conf/interface_conf.h | 2 +- src/conf/netdev_bandwidth_conf.c | 2 +- src/conf/network_conf.c | 2 +- src/conf/node_device_conf.c | 2 +- src/conf/node_device_conf.h | 2 +- src/conf/nwfilter_conf.h | 2 +- src/conf/secret_conf.c | 2 +- src/conf/secret_conf.h | 2 +- src/conf/snapshot_conf.c | 2 +- src/conf/storage_conf.c | 2 +- src/conf/storage_conf.h | 2 +- src/conf/storage_encryption_conf.c | 2 +- src/conf/storage_encryption_conf.h | 2 +- src/cpu/cpu_powerpc.c | 2 +- src/cpu/cpu_x86.c | 2 +- src/datatypes.c | 2 +- src/driver.c | 2 +- src/esx/esx_device_monitor.c | 2 +- src/esx/esx_driver.c | 2 +- src/esx/esx_interface_driver.c | 2 +- src/esx/esx_network_driver.c | 2 +- src/esx/esx_nwfilter_driver.c | 2 +- src/esx/esx_secret_driver.c | 2 +- src/esx/esx_storage_backend_iscsi.c | 2 +- src/esx/esx_storage_backend_vmfs.c | 2 +- src/esx/esx_util.c | 2 +- src/esx/esx_vi.c | 2 +- src/esx/esx_vi_types.c | 2 +- src/fdstream.c | 2 +- src/hyperv/hyperv_device_monitor.c | 2 +- src/hyperv/hyperv_driver.c | 2 +- src/hyperv/hyperv_interface_driver.c | 2 +- src/hyperv/hyperv_network_driver.c | 2 +- src/hyperv/hyperv_nwfilter_driver.c | 2 +- src/hyperv/hyperv_secret_driver.c | 2 +- src/hyperv/hyperv_storage_driver.c | 2 +- src/hyperv/hyperv_util.c | 2 +- src/hyperv/hyperv_wmi.c | 2 +- src/locking/lock_daemon.c | 2 +- src/locking/lock_daemon_dispatch.c | 2 +- src/locking/lock_driver_lockd.c | 2 +- src/locking/lock_driver_sanlock.c | 2 +- src/locking/lock_manager.c | 2 +- src/lxc/lxc_container.c | 2 +- src/lxc/lxc_controller.c | 4 +- src/lxc/lxc_driver.c | 2 +- src/lxc/lxc_fuse.h | 2 +- src/network/bridge_driver.c | 2 +- src/node_device/node_device_driver.c | 2 +- src/node_device/node_device_udev.c | 2 +- src/nodeinfo.c | 2 +- src/openvz/openvz_conf.c | 2 +- src/openvz/openvz_driver.c | 2 +- src/parallels/parallels_driver.c | 2 +- src/phyp/phyp_driver.c | 2 +- src/qemu/qemu_bridge_filter.c | 2 +- src/qemu/qemu_capabilities.c | 2 +- src/qemu/qemu_cgroup.c | 2 +- src/qemu/qemu_command.c | 2 +- src/qemu/qemu_conf.c | 2 +- src/qemu/qemu_driver.c | 2 +- src/qemu/qemu_migration.c | 2 +- src/qemu/qemu_process.c | 2 +- src/remote/remote_driver.c | 2 +- src/rpc/virkeepalive.c | 2 +- src/rpc/virnetclient.c | 2 +- src/rpc/virnetclientprogram.c | 2 +- src/rpc/virnetmessage.c | 2 +- src/rpc/virnetserver.c | 2 +- src/rpc/virnetsocket.c | 2 +- src/rpc/virnetsshsession.c | 2 +- src/rpc/virnettlscontext.c | 2 +- src/secret/secret_driver.c | 2 +- src/security/security_apparmor.c | 2 +- src/security/security_dac.c | 2 +- src/security/security_selinux.c | 4 +- src/security/virt-aa-helper.c | 2 +- src/storage/parthelper.c | 2 +- src/storage/storage_backend.c | 2 +- src/storage/storage_backend_disk.c | 2 +- src/storage/storage_backend_iscsi.c | 2 +- src/storage/storage_backend_rbd.c | 2 +- src/storage/storage_backend_sheepdog.c | 2 +- src/storage/storage_driver.c | 2 +- src/test/test_driver.c | 2 +- src/uml/uml_conf.c | 2 +- src/uml/uml_driver.c | 2 +- src/util/iohelper.c | 2 +- src/util/util.c | 3131 -------------------------------- src/util/util.h | 284 --- src/util/uuid.c | 2 +- src/util/viraudit.c | 2 +- src/util/virauth.c | 2 +- src/util/virauthconfig.c | 2 +- src/util/virbitmap.c | 2 +- src/util/vircgroup.c | 2 +- src/util/vircommand.c | 2 +- src/util/vircommand.h | 2 +- src/util/virconf.c | 2 +- src/util/virdnsmasq.c | 2 +- src/util/vireventpoll.c | 2 +- src/util/virhooks.c | 2 +- src/util/virhooks.h | 2 +- src/util/virinitctl.c | 2 +- src/util/virjson.c | 2 +- src/util/virkeycode.h | 2 +- src/util/virkeyfile.c | 2 +- src/util/virlockspace.c | 2 +- src/util/virlog.c | 2 +- src/util/virnetdevbridge.c | 2 +- src/util/virnetdevmacvlan.c | 2 +- src/util/virnetdevopenvswitch.h | 2 +- src/util/virnetdevtap.c | 2 +- src/util/virnetdevvportprofile.h | 2 +- src/util/virpidfile.c | 2 +- src/util/virprocess.c | 2 +- src/util/virrandom.c | 2 +- src/util/virsexpr.c | 2 +- src/util/virsocketaddr.c | 2 +- src/util/virstatslinux.c | 2 +- src/util/virstoragefile.h | 2 +- src/util/virsysinfo.c | 2 +- src/util/virsysinfo.h | 2 +- src/util/virterror.c | 2 +- src/util/virtime.c | 2 +- src/util/virtypedparam.c | 2 +- src/util/viruri.c | 2 +- src/util/virusb.c | 2 +- src/util/virutil.c | 3131 ++++++++++++++++++++++++++++++++ src/util/virutil.h | 284 +++ src/util/xml.c | 2 +- src/vbox/vbox_MSCOMGlue.c | 2 +- src/vbox/vbox_XPCOMCGlue.c | 2 +- src/vbox/vbox_driver.c | 2 +- src/vmware/vmware_driver.c | 2 +- src/xen/block_stats.c | 2 +- src/xen/xen_driver.c | 2 +- src/xen/xen_hypervisor.c | 2 +- src/xen/xend_internal.c | 2 +- src/xen/xm_internal.c | 2 +- src/xenapi/xenapi_driver.c | 2 +- src/xenapi/xenapi_utils.c | 2 +- tests/commandhelper.c | 2 +- tests/commandtest.c | 2 +- tests/esxutilstest.c | 2 +- tests/eventtest.c | 2 +- tests/libvirtdconftest.c | 2 +- tests/nodeinfotest.c | 2 +- tests/openvzutilstest.c | 2 +- tests/qemumonitortest.c | 2 +- tests/qemumonitortestutils.c | 2 +- tests/securityselinuxtest.c | 2 +- tests/testutils.c | 2 +- tests/utiltest.c | 2 +- tests/virauthconfigtest.c | 2 +- tests/virbuftest.c | 2 +- tests/virdrivermoduletest.c | 2 +- tests/virhashtest.c | 2 +- tests/virkeyfiletest.c | 2 +- tests/virlockspacetest.c | 2 +- tests/virnetmessagetest.c | 2 +- tests/virnetsockettest.c | 2 +- tests/virnettlscontexttest.c | 2 +- tests/virshtest.c | 2 +- tests/virstringtest.c | 2 +- tests/virtimetest.c | 2 +- tests/viruritest.c | 2 +- tools/console.c | 2 +- tools/virsh-domain.c | 2 +- tools/virsh-host.c | 2 +- tools/virsh-interface.c | 2 +- tools/virsh-network.c | 2 +- tools/virsh-nodedev.c | 2 +- tools/virsh-nwfilter.c | 2 +- tools/virsh-pool.c | 2 +- tools/virsh-secret.c | 2 +- tools/virsh-snapshot.c | 2 +- tools/virsh-volume.c | 2 +- tools/virsh.c | 2 +- tools/virt-host-validate-common.c | 2 +- 194 files changed, 3616 insertions(+), 3615 deletions(-) delete mode 100644 src/util/util.c delete mode 100644 src/util/util.h create mode 100644 src/util/virutil.c create mode 100644 src/util/virutil.h diff --git a/cfg.mk b/cfg.mk index 0a66797..a269f77 100644 --- a/cfg.mk +++ b/cfg.mk @@ -745,7 +745,7 @@ $(srcdir)/src/remote/remote_client_bodies.h: $(srcdir)/src/remote/remote_protoco # List all syntax-check exemptions: exclude_file_name_regexp--sc_avoid_strcase = ^tools/virsh\.h$$ -_src1=libvirt|fdstream|qemu/qemu_monitor|util/(vircommand|util)|xen/xend_internal|rpc/virnetsocket|lxc/lxc_controller|locking/lock_daemon +_src1=libvirt|fdstream|qemu/qemu_monitor|util/(vircommand|virutil)|xen/xend_internal|rpc/virnetsocket|lxc/lxc_controller|locking/lock_daemon exclude_file_name_regexp--sc_avoid_write = \ ^(src/($(_src1))|daemon/libvirtd|tools/console|tests/(shunload|virnettlscontext)test)\.c$$ @@ -764,13 +764,13 @@ exclude_file_name_regexp--sc_po_check = ^(docs/|src/rpc/gendispatch\.pl$$) exclude_file_name_regexp--sc_prohibit_VIR_ERR_NO_MEMORY = \ ^(include/libvirt/virterror\.h|daemon/dispatch\.c|src/util/virterror\.c)$$ -exclude_file_name_regexp--sc_prohibit_access_xok = ^src/util/util\.c$$ +exclude_file_name_regexp--sc_prohibit_access_xok = ^src/util/virutil\.c$$ exclude_file_name_regexp--sc_prohibit_always_true_header_tests = \ ^python/(libvirt-(qemu-)?override|typewrappers)\.c$$ exclude_file_name_regexp--sc_prohibit_asprintf = \ - ^(bootstrap.conf$$|src/util/util\.c$$|examples/domain-events/events-c/event-test\.c$$) + ^(bootstrap.conf$$|src/util/virutil\.c$$|examples/domain-events/events-c/event-test\.c$$) exclude_file_name_regexp--sc_prohibit_close = \ (\.p[yl]$$|^docs/|^(src/util/virfile\.c|src/libvirt\.c)$$) @@ -782,10 +782,10 @@ _src2=src/(util/vircommand|libvirt|lxc/lxc_controller|locking/lock_daemon) exclude_file_name_regexp--sc_prohibit_fork_wrappers = \ (^($(_src2)|tests/testutils|daemon/libvirtd)\.c$$) -exclude_file_name_regexp--sc_prohibit_gethostname = ^src/util/util\.c$$ +exclude_file_name_regexp--sc_prohibit_gethostname = ^src/util/virutil\.c$$ exclude_file_name_regexp--sc_prohibit_internal_functions = \ - ^src/(util/(viralloc|util|virfile)\.[hc]|esx/esx_vi\.c)$$ + ^src/(util/(viralloc|virutil|virfile)\.[hc]|esx/esx_vi\.c)$$ exclude_file_name_regexp--sc_prohibit_newline_at_end_of_diagnostic = \ ^src/rpc/gendispatch\.pl$$ @@ -797,14 +797,14 @@ exclude_file_name_regexp--sc_prohibit_raw_allocation = \ ^(src/util/viralloc\.[ch]|examples/.*)$$ exclude_file_name_regexp--sc_prohibit_readlink = \ - ^src/(util/util|lxc/lxc_container)\.c$$ + ^src/(util/virutil|lxc/lxc_container)\.c$$ -exclude_file_name_regexp--sc_prohibit_setuid = ^src/util/util\.c$$ +exclude_file_name_regexp--sc_prohibit_setuid = ^src/util/virutil\.c$$ exclude_file_name_regexp--sc_prohibit_sprintf = \ ^(docs/hacking\.html\.in)|(examples/systemtap/.*stp)|(src/dtrace2systemtap\.pl)|(src/rpc/gensystemtap\.pl)$$ -exclude_file_name_regexp--sc_prohibit_strncpy = ^src/util/util\.c$$ +exclude_file_name_regexp--sc_prohibit_strncpy = ^src/util/virutil\.c$$ exclude_file_name_regexp--sc_prohibit_strtol = \ ^src/(util/virsexpr|(vbox|xen|xenxs)/.*)\.c$$ diff --git a/daemon/libvirtd.c b/daemon/libvirtd.c index dc1d2c5..edc899e 100644 --- a/daemon/libvirtd.c +++ b/daemon/libvirtd.c @@ -43,7 +43,7 @@ #include "libvirtd.h" #include "libvirtd-config.h" -#include "util.h" +#include "virutil.h" #include "uuid.h" #include "remote_driver.h" #include "viralloc.h" diff --git a/daemon/remote.c b/daemon/remote.c index eb75281..0b5a3db 100644 --- a/daemon/remote.c +++ b/daemon/remote.c @@ -35,7 +35,7 @@ #include "datatypes.h" #include "viralloc.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include "stream.h" #include "uuid.h" #include "libvirt/libvirt-qemu.h" diff --git a/po/POTFILES.in b/po/POTFILES.in index c17c63c..8a24fd4 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -138,7 +138,6 @@ src/test/test_driver.c src/uml/uml_conf.c src/uml/uml_driver.c src/util/iohelper.c -src/util/util.c src/util/viraudit.c src/util/virauth.c src/util/virauthconfig.c @@ -180,6 +179,7 @@ src/util/virtime.c src/util/virtypedparam.c src/util/viruri.c src/util/virusb.c +src/util/virutil.c src/util/xml.c src/vbox/vbox_MSCOMGlue.c src/vbox/vbox_XPCOMCGlue.c diff --git a/python/libvirt-override.c b/python/libvirt-override.c index 644f34d..91e82c6 100644 --- a/python/libvirt-override.c +++ b/python/libvirt-override.c @@ -27,7 +27,7 @@ #include "viralloc.h" #include "virtypedparam.h" #include "ignore-value.h" -#include "util.h" +#include "virutil.h" #ifndef __CYGWIN__ extern void initlibvirtmod(void); diff --git a/src/Makefile.am b/src/Makefile.am index d8d96f8..1303edd 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -54,7 +54,6 @@ augeastest_DATA = # helper APIs for various purposes UTIL_SOURCES = \ util/uuid.c util/uuid.h \ - util/util.c util/util.h \ util/viralloc.c util/viralloc.h \ util/viratomic.h util/viratomic.c \ util/viraudit.c util/viraudit.h \ @@ -114,7 +113,9 @@ UTIL_SOURCES = \ util/virstring.h util/virstring.c \ util/virtime.h util/virtime.c \ util/virusb.c util/virusb.h \ - util/viruri.h util/viruri.c + util/viruri.h util/viruri.c \ + util/virutil.c util/virutil.h \ + $(NULL) EXTRA_DIST += $(srcdir)/util/virkeymaps.h $(srcdir)/util/keymaps.csv \ $(srcdir)/util/virkeycode-mapgen.py diff --git a/src/conf/capabilities.c b/src/conf/capabilities.c index 9ac18e2..e46a594 100644 --- a/src/conf/capabilities.c +++ b/src/conf/capabilities.c @@ -28,7 +28,7 @@ #include "capabilities.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "uuid.h" #include "cpu_conf.h" #include "virterror_internal.h" diff --git a/src/conf/cpu_conf.c b/src/conf/cpu_conf.c index 23941c5..95c6ca1 100644 --- a/src/conf/cpu_conf.c +++ b/src/conf/cpu_conf.c @@ -25,7 +25,7 @@ #include "virterror_internal.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virbuffer.h" #include "cpu_conf.h" #include "domain_conf.h" diff --git a/src/conf/cpu_conf.h b/src/conf/cpu_conf.h index 357057d..7bec912 100644 --- a/src/conf/cpu_conf.h +++ b/src/conf/cpu_conf.h @@ -24,7 +24,7 @@ #ifndef __VIR_CPU_CONF_H__ # define __VIR_CPU_CONF_H__ -# include "util.h" +# include "virutil.h" # include "virbuffer.h" # include "xml.h" # include "virbitmap.h" diff --git a/src/conf/device_conf.c b/src/conf/device_conf.c index c3ca2d6..4efafc4 100644 --- a/src/conf/device_conf.c +++ b/src/conf/device_conf.c @@ -26,7 +26,7 @@ #include "viralloc.h" #include "xml.h" #include "uuid.h" -#include "util.h" +#include "virutil.h" #include "virbuffer.h" #include "device_conf.h" diff --git a/src/conf/device_conf.h b/src/conf/device_conf.h index c1bf096..52e4ac5 100644 --- a/src/conf/device_conf.h +++ b/src/conf/device_conf.h @@ -28,7 +28,7 @@ # include <libxml/xpath.h> # include "internal.h" -# include "util.h" +# include "virutil.h" # include "virthread.h" # include "virbuffer.h" diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c index b3c3557..ab1fe2a 100644 --- a/src/conf/domain_conf.c +++ b/src/conf/domain_conf.c @@ -38,7 +38,7 @@ #include "verify.h" #include "xml.h" #include "uuid.h" -#include "util.h" +#include "virutil.h" #include "virbuffer.h" #include "virlog.h" #include "nwfilter_conf.h" diff --git a/src/conf/domain_conf.h b/src/conf/domain_conf.h index 56aece2..df6e376 100644 --- a/src/conf/domain_conf.h +++ b/src/conf/domain_conf.h @@ -32,7 +32,7 @@ # include "capabilities.h" # include "storage_encryption_conf.h" # include "cpu_conf.h" -# include "util.h" +# include "virutil.h" # include "virthread.h" # include "virhash.h" # include "virsocketaddr.h" diff --git a/src/conf/interface_conf.c b/src/conf/interface_conf.c index 046a8a1..e4b088a 100644 --- a/src/conf/interface_conf.c +++ b/src/conf/interface_conf.c @@ -30,7 +30,7 @@ #include "viralloc.h" #include "xml.h" #include "uuid.h" -#include "util.h" +#include "virutil.h" #include "virbuffer.h" #define VIR_FROM_THIS VIR_FROM_INTERFACE diff --git a/src/conf/interface_conf.h b/src/conf/interface_conf.h index d6f98f1..e636c35 100644 --- a/src/conf/interface_conf.h +++ b/src/conf/interface_conf.h @@ -29,7 +29,7 @@ # include <libxml/xpath.h> # include "internal.h" -# include "util.h" +# include "virutil.h" # include "virthread.h" /* There is currently 3 types of interfaces */ diff --git a/src/conf/netdev_bandwidth_conf.c b/src/conf/netdev_bandwidth_conf.c index 35f067c..e64aeff 100644 --- a/src/conf/netdev_bandwidth_conf.c +++ b/src/conf/netdev_bandwidth_conf.c @@ -24,7 +24,7 @@ #include "netdev_bandwidth_conf.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "domain_conf.h" diff --git a/src/conf/network_conf.c b/src/conf/network_conf.c index 1932851..42f3593 100644 --- a/src/conf/network_conf.c +++ b/src/conf/network_conf.c @@ -40,7 +40,7 @@ #include "viralloc.h" #include "xml.h" #include "uuid.h" -#include "util.h" +#include "virutil.h" #include "virbuffer.h" #include "c-ctype.h" #include "virfile.h" diff --git a/src/conf/node_device_conf.c b/src/conf/node_device_conf.c index 045f05d..12819c8 100644 --- a/src/conf/node_device_conf.c +++ b/src/conf/node_device_conf.c @@ -33,7 +33,7 @@ #include "node_device_conf.h" #include "viralloc.h" #include "xml.h" -#include "util.h" +#include "virutil.h" #include "virbuffer.h" #include "uuid.h" #include "virpci.h" diff --git a/src/conf/node_device_conf.h b/src/conf/node_device_conf.h index 9860f67..12c36d8 100644 --- a/src/conf/node_device_conf.h +++ b/src/conf/node_device_conf.h @@ -26,7 +26,7 @@ # define __VIR_NODE_DEVICE_CONF_H__ # include "internal.h" -# include "util.h" +# include "virutil.h" # include "virthread.h" # include <libxml/tree.h> diff --git a/src/conf/nwfilter_conf.h b/src/conf/nwfilter_conf.h index d597064..2ca44b3 100644 --- a/src/conf/nwfilter_conf.h +++ b/src/conf/nwfilter_conf.h @@ -28,7 +28,7 @@ # include "internal.h" -# include "util.h" +# include "virutil.h" # include "virhash.h" # include "xml.h" # include "virbuffer.h" diff --git a/src/conf/secret_conf.c b/src/conf/secret_conf.c index 5188c7a..a65cf92 100644 --- a/src/conf/secret_conf.c +++ b/src/conf/secret_conf.c @@ -29,7 +29,7 @@ #include "viralloc.h" #include "secret_conf.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "xml.h" #include "uuid.h" diff --git a/src/conf/secret_conf.h b/src/conf/secret_conf.h index 2064286..6079d5b 100644 --- a/src/conf/secret_conf.h +++ b/src/conf/secret_conf.h @@ -24,7 +24,7 @@ # define __VIR_SECRET_CONF_H__ # include "internal.h" -# include "util.h" +# include "virutil.h" VIR_ENUM_DECL(virSecretUsageType) diff --git a/src/conf/snapshot_conf.c b/src/conf/snapshot_conf.c index 5c40e97..810d2bf 100644 --- a/src/conf/snapshot_conf.c +++ b/src/conf/snapshot_conf.c @@ -42,7 +42,7 @@ #include "secret_conf.h" #include "snapshot_conf.h" #include "virstoragefile.h" -#include "util.h" +#include "virutil.h" #include "uuid.h" #include "virfile.h" #include "virterror_internal.h" diff --git a/src/conf/storage_conf.c b/src/conf/storage_conf.c index 5cd2393..38bb471 100644 --- a/src/conf/storage_conf.c +++ b/src/conf/storage_conf.c @@ -41,7 +41,7 @@ #include "xml.h" #include "uuid.h" #include "virbuffer.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virfile.h" diff --git a/src/conf/storage_conf.h b/src/conf/storage_conf.h index 573c3db..ad16eca 100644 --- a/src/conf/storage_conf.h +++ b/src/conf/storage_conf.h @@ -25,7 +25,7 @@ # define __VIR_STORAGE_CONF_H__ # include "internal.h" -# include "util.h" +# include "virutil.h" # include "storage_encryption_conf.h" # include "virthread.h" diff --git a/src/conf/storage_encryption_conf.c b/src/conf/storage_encryption_conf.c index 8d3ceac..139c37c 100644 --- a/src/conf/storage_encryption_conf.c +++ b/src/conf/storage_encryption_conf.c @@ -31,7 +31,7 @@ #include "viralloc.h" #include "storage_conf.h" #include "storage_encryption_conf.h" -#include "util.h" +#include "virutil.h" #include "xml.h" #include "virterror_internal.h" #include "uuid.h" diff --git a/src/conf/storage_encryption_conf.h b/src/conf/storage_encryption_conf.h index 40a8497..57ab1a0 100644 --- a/src/conf/storage_encryption_conf.h +++ b/src/conf/storage_encryption_conf.h @@ -25,7 +25,7 @@ # include "internal.h" # include "virbuffer.h" -# include "util.h" +# include "virutil.h" # include <libxml/tree.h> diff --git a/src/cpu/cpu_powerpc.c b/src/cpu/cpu_powerpc.c index 6b6c325..40a2d88 100644 --- a/src/cpu/cpu_powerpc.c +++ b/src/cpu/cpu_powerpc.c @@ -28,7 +28,7 @@ #include "virlog.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "cpu.h" #include "cpu_map.h" diff --git a/src/cpu/cpu_x86.c b/src/cpu/cpu_x86.c index 93ee111..b932b93 100644 --- a/src/cpu/cpu_x86.c +++ b/src/cpu/cpu_x86.c @@ -27,7 +27,7 @@ #include "virlog.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "cpu.h" #include "cpu_map.h" #include "cpu_x86.h" diff --git a/src/datatypes.c b/src/datatypes.c index 0907c7d..07aefcc 100644 --- a/src/datatypes.c +++ b/src/datatypes.c @@ -27,7 +27,7 @@ #include "virlog.h" #include "viralloc.h" #include "uuid.h" -#include "util.h" +#include "virutil.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/src/driver.c b/src/driver.c index 23dc329..0a5fe05 100644 --- a/src/driver.c +++ b/src/driver.c @@ -27,7 +27,7 @@ #include "driver.h" #include "viralloc.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include "configmake.h" #define DEFAULT_DRIVER_DIR LIBDIR "/libvirt/connection-driver" diff --git a/src/esx/esx_device_monitor.c b/src/esx/esx_device_monitor.c index 854fc38..7cc6ac0 100644 --- a/src/esx/esx_device_monitor.c +++ b/src/esx/esx_device_monitor.c @@ -25,7 +25,7 @@ #include <config.h> #include "internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/esx/esx_driver.c b/src/esx/esx_driver.c index 0fe9a67..2c0297c 100644 --- a/src/esx/esx_driver.c +++ b/src/esx/esx_driver.c @@ -28,7 +28,7 @@ #include "domain_conf.h" #include "snapshot_conf.h" #include "virauth.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/esx/esx_interface_driver.c b/src/esx/esx_interface_driver.c index fea67ab..524886f 100644 --- a/src/esx/esx_interface_driver.c +++ b/src/esx/esx_interface_driver.c @@ -25,7 +25,7 @@ #include <config.h> #include "internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/esx/esx_network_driver.c b/src/esx/esx_network_driver.c index fec7e72..0fc2603 100644 --- a/src/esx/esx_network_driver.c +++ b/src/esx/esx_network_driver.c @@ -26,7 +26,7 @@ #include "md5.h" #include "internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/esx/esx_nwfilter_driver.c b/src/esx/esx_nwfilter_driver.c index 7a05a5a..ecee0fb 100644 --- a/src/esx/esx_nwfilter_driver.c +++ b/src/esx/esx_nwfilter_driver.c @@ -25,7 +25,7 @@ #include <config.h> #include "internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/esx/esx_secret_driver.c b/src/esx/esx_secret_driver.c index 2969b19..722d3f7 100644 --- a/src/esx/esx_secret_driver.c +++ b/src/esx/esx_secret_driver.c @@ -24,7 +24,7 @@ #include <config.h> #include "internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/esx/esx_storage_backend_iscsi.c b/src/esx/esx_storage_backend_iscsi.c index 5ad885a..3c3ab7d 100644 --- a/src/esx/esx_storage_backend_iscsi.c +++ b/src/esx/esx_storage_backend_iscsi.c @@ -28,7 +28,7 @@ #include "internal.h" #include "md5.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/esx/esx_storage_backend_vmfs.c b/src/esx/esx_storage_backend_vmfs.c index 4886fc3..c57e070 100644 --- a/src/esx/esx_storage_backend_vmfs.c +++ b/src/esx/esx_storage_backend_vmfs.c @@ -31,7 +31,7 @@ #include "internal.h" #include "md5.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/esx/esx_util.c b/src/esx/esx_util.c index bcda9df..9b2e576 100644 --- a/src/esx/esx_util.c +++ b/src/esx/esx_util.c @@ -28,7 +28,7 @@ #include "internal.h" #include "datatypes.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/esx/esx_vi.c b/src/esx/esx_vi.c index 37b6e0f..2cc8002 100644 --- a/src/esx/esx_vi.c +++ b/src/esx/esx_vi.c @@ -29,7 +29,7 @@ #include "virbuffer.h" #include "viralloc.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include "uuid.h" #include "vmx.h" #include "xml.h" diff --git a/src/esx/esx_vi_types.c b/src/esx/esx_vi_types.c index b93223d..d1f91ff 100644 --- a/src/esx/esx_vi_types.c +++ b/src/esx/esx_vi_types.c @@ -31,7 +31,7 @@ #include "datatypes.h" #include "viralloc.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include "esx_vi.h" #include "esx_vi_types.h" diff --git a/src/fdstream.c b/src/fdstream.c index 39e92b8..f7f101e 100644 --- a/src/fdstream.c +++ b/src/fdstream.c @@ -37,7 +37,7 @@ #include "datatypes.h" #include "virlog.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "configmake.h" diff --git a/src/hyperv/hyperv_device_monitor.c b/src/hyperv/hyperv_device_monitor.c index d6edb76..10d559f 100644 --- a/src/hyperv/hyperv_device_monitor.c +++ b/src/hyperv/hyperv_device_monitor.c @@ -26,7 +26,7 @@ #include "internal.h" #include "virterror_internal.h" #include "datatypes.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/hyperv/hyperv_driver.c b/src/hyperv/hyperv_driver.c index 749c7f0..d777bd8 100644 --- a/src/hyperv/hyperv_driver.c +++ b/src/hyperv/hyperv_driver.c @@ -27,7 +27,7 @@ #include "datatypes.h" #include "domain_conf.h" #include "virauth.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/hyperv/hyperv_interface_driver.c b/src/hyperv/hyperv_interface_driver.c index 43c7dd7..af37de3 100644 --- a/src/hyperv/hyperv_interface_driver.c +++ b/src/hyperv/hyperv_interface_driver.c @@ -26,7 +26,7 @@ #include "internal.h" #include "virterror_internal.h" #include "datatypes.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/hyperv/hyperv_network_driver.c b/src/hyperv/hyperv_network_driver.c index 06b051b..cafc956 100644 --- a/src/hyperv/hyperv_network_driver.c +++ b/src/hyperv/hyperv_network_driver.c @@ -26,7 +26,7 @@ #include "internal.h" #include "virterror_internal.h" #include "datatypes.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/hyperv/hyperv_nwfilter_driver.c b/src/hyperv/hyperv_nwfilter_driver.c index 7452b7a..46c57b7 100644 --- a/src/hyperv/hyperv_nwfilter_driver.c +++ b/src/hyperv/hyperv_nwfilter_driver.c @@ -26,7 +26,7 @@ #include "internal.h" #include "virterror_internal.h" #include "datatypes.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/hyperv/hyperv_secret_driver.c b/src/hyperv/hyperv_secret_driver.c index 04a6ada..ea8fa7e 100644 --- a/src/hyperv/hyperv_secret_driver.c +++ b/src/hyperv/hyperv_secret_driver.c @@ -26,7 +26,7 @@ #include "internal.h" #include "virterror_internal.h" #include "datatypes.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/hyperv/hyperv_storage_driver.c b/src/hyperv/hyperv_storage_driver.c index b2817a2..7549801 100644 --- a/src/hyperv/hyperv_storage_driver.c +++ b/src/hyperv/hyperv_storage_driver.c @@ -26,7 +26,7 @@ #include "internal.h" #include "virterror_internal.h" #include "datatypes.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/hyperv/hyperv_util.c b/src/hyperv/hyperv_util.c index 016d415..69a57c6 100644 --- a/src/hyperv/hyperv_util.c +++ b/src/hyperv/hyperv_util.c @@ -24,7 +24,7 @@ #include "internal.h" #include "datatypes.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "uuid.h" diff --git a/src/hyperv/hyperv_wmi.c b/src/hyperv/hyperv_wmi.c index 69e7283..f4afdce 100644 --- a/src/hyperv/hyperv_wmi.c +++ b/src/hyperv/hyperv_wmi.c @@ -29,7 +29,7 @@ #include "datatypes.h" #include "virlog.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "uuid.h" #include "virbuffer.h" #include "hyperv_private.h" diff --git a/src/locking/lock_daemon.c b/src/locking/lock_daemon.c index 3d90c57..df9923e 100644 --- a/src/locking/lock_daemon.c +++ b/src/locking/lock_daemon.c @@ -33,7 +33,7 @@ #include "lock_daemon.h" #include "lock_daemon_config.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "virpidfile.h" #include "virprocess.h" diff --git a/src/locking/lock_daemon_dispatch.c b/src/locking/lock_daemon_dispatch.c index 78c9726..def7c2f 100644 --- a/src/locking/lock_daemon_dispatch.c +++ b/src/locking/lock_daemon_dispatch.c @@ -24,7 +24,7 @@ #include "rpc/virnetserver.h" #include "rpc/virnetserverclient.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "lock_daemon.h" diff --git a/src/locking/lock_driver_lockd.c b/src/locking/lock_driver_lockd.c index cee530d..547db85 100644 --- a/src/locking/lock_driver_lockd.c +++ b/src/locking/lock_driver_lockd.c @@ -26,7 +26,7 @@ #include "viralloc.h" #include "virlog.h" #include "uuid.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "virterror_internal.h" #include "rpc/virnetclient.h" diff --git a/src/locking/lock_driver_sanlock.c b/src/locking/lock_driver_sanlock.c index e520444..511543a 100644 --- a/src/locking/lock_driver_sanlock.c +++ b/src/locking/lock_driver_sanlock.c @@ -40,7 +40,7 @@ #include "virlog.h" #include "virterror_internal.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "md5.h" #include "virconf.h" diff --git a/src/locking/lock_manager.c b/src/locking/lock_manager.c index f938b04..d73e184 100644 --- a/src/locking/lock_manager.c +++ b/src/locking/lock_manager.c @@ -25,7 +25,7 @@ #include "lock_driver_nop.h" #include "virterror_internal.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "uuid.h" diff --git a/src/lxc/lxc_container.c b/src/lxc/lxc_container.c index f3c6e19..050a4c1 100644 --- a/src/lxc/lxc_container.c +++ b/src/lxc/lxc_container.c @@ -56,7 +56,7 @@ #include "virterror_internal.h" #include "virlog.h" #include "lxc_container.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virnetdevveth.h" #include "uuid.h" diff --git a/src/lxc/lxc_controller.c b/src/lxc/lxc_controller.c index 6b6ec82..a8e99f2 100644 --- a/src/lxc/lxc_controller.c +++ b/src/lxc/lxc_controller.c @@ -54,7 +54,7 @@ #include "virterror_internal.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include "lxc_conf.h" #include "lxc_container.h" @@ -64,7 +64,7 @@ #include "virnetdev.h" #include "virnetdevveth.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "virpidfile.h" #include "vircommand.h" diff --git a/src/lxc/lxc_driver.c b/src/lxc/lxc_driver.c index 57c1767..e513b76 100644 --- a/src/lxc/lxc_driver.c +++ b/src/lxc/lxc_driver.c @@ -44,7 +44,7 @@ #include "lxc_driver.h" #include "lxc_process.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virnetdevbridge.h" #include "virnetdevveth.h" #include "nodeinfo.h" diff --git a/src/lxc/lxc_fuse.h b/src/lxc/lxc_fuse.h index 9878017..93964a4 100644 --- a/src/lxc/lxc_fuse.h +++ b/src/lxc/lxc_fuse.h @@ -32,7 +32,7 @@ # endif # include "lxc_conf.h" -# include "util.h" +# include "virutil.h" # include "viralloc.h" struct virLXCMeminfo { diff --git a/src/network/bridge_driver.c b/src/network/bridge_driver.c index 2db9197..dbbd49c 100644 --- a/src/network/bridge_driver.c +++ b/src/network/bridge_driver.c @@ -52,7 +52,7 @@ #include "driver.h" #include "virbuffer.h" #include "virpidfile.h" -#include "util.h" +#include "virutil.h" #include "vircommand.h" #include "viralloc.h" #include "uuid.h" diff --git a/src/node_device/node_device_driver.c b/src/node_device/node_device_driver.c index d914816..6cc1837 100644 --- a/src/node_device/node_device_driver.c +++ b/src/node_device/node_device_driver.c @@ -37,7 +37,7 @@ #include "node_device_conf.h" #include "node_device_hal.h" #include "node_device_driver.h" -#include "util.h" +#include "virutil.h" #define VIR_FROM_THIS VIR_FROM_NODEDEV diff --git a/src/node_device/node_device_udev.c b/src/node_device/node_device_udev.c index 7289a72..d350955 100644 --- a/src/node_device/node_device_udev.c +++ b/src/node_device/node_device_udev.c @@ -35,7 +35,7 @@ #include "virlog.h" #include "viralloc.h" #include "uuid.h" -#include "util.h" +#include "virutil.h" #include "virbuffer.h" #include "virpci.h" diff --git a/src/nodeinfo.c b/src/nodeinfo.c index b14e63b..65f4431 100644 --- a/src/nodeinfo.c +++ b/src/nodeinfo.c @@ -42,7 +42,7 @@ #include "viralloc.h" #include "nodeinfo.h" #include "physmem.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "virterror_internal.h" #include "count-one-bits.h" diff --git a/src/openvz/openvz_conf.c b/src/openvz/openvz_conf.c index 6e0f6eb..b0c9c5f 100644 --- a/src/openvz/openvz_conf.c +++ b/src/openvz/openvz_conf.c @@ -49,7 +49,7 @@ #include "uuid.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "nodeinfo.h" #include "virfile.h" #include "vircommand.h" diff --git a/src/openvz/openvz_driver.c b/src/openvz/openvz_driver.c index a35a6b1..a407193 100644 --- a/src/openvz/openvz_driver.c +++ b/src/openvz/openvz_driver.c @@ -50,7 +50,7 @@ #include "openvz_driver.h" #include "openvz_util.h" #include "virbuffer.h" -#include "util.h" +#include "virutil.h" #include "openvz_conf.h" #include "nodeinfo.h" #include "viralloc.h" diff --git a/src/parallels/parallels_driver.c b/src/parallels/parallels_driver.c index 07c1463..87d098e 100644 --- a/src/parallels/parallels_driver.c +++ b/src/parallels/parallels_driver.c @@ -44,7 +44,7 @@ #include "datatypes.h" #include "virterror_internal.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "vircommand.h" #include "configmake.h" diff --git a/src/phyp/phyp_driver.c b/src/phyp/phyp_driver.c index ad56686..25b96b4 100644 --- a/src/phyp/phyp_driver.c +++ b/src/phyp/phyp_driver.c @@ -45,7 +45,7 @@ #include "internal.h" #include "virauth.h" -#include "util.h" +#include "virutil.h" #include "datatypes.h" #include "virbuffer.h" #include "viralloc.h" diff --git a/src/qemu/qemu_bridge_filter.c b/src/qemu/qemu_bridge_filter.c index 08a9f1a..6d84f47 100644 --- a/src/qemu/qemu_bridge_filter.c +++ b/src/qemu/qemu_bridge_filter.c @@ -25,7 +25,7 @@ #include "virebtables.h" #include "qemu_conf.h" #include "qemu_driver.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "virlog.h" diff --git a/src/qemu/qemu_capabilities.c b/src/qemu/qemu_capabilities.c index 46f8540..7a27183 100644 --- a/src/qemu/qemu_capabilities.c +++ b/src/qemu/qemu_capabilities.c @@ -27,7 +27,7 @@ #include "viralloc.h" #include "virlog.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "virpidfile.h" #include "virprocess.h" diff --git a/src/qemu/qemu_cgroup.c b/src/qemu/qemu_cgroup.c index b47fb78..9db7ad9 100644 --- a/src/qemu/qemu_cgroup.c +++ b/src/qemu/qemu_cgroup.c @@ -30,7 +30,7 @@ #include "virlog.h" #include "viralloc.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "domain_audit.h" #define VIR_FROM_THIS VIR_FROM_QEMU diff --git a/src/qemu/qemu_command.c b/src/qemu/qemu_command.c index 464288f..23ccffe 100644 --- a/src/qemu/qemu_command.c +++ b/src/qemu/qemu_command.c @@ -31,7 +31,7 @@ #include "viralloc.h" #include "virlog.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "uuid.h" #include "c-ctype.h" diff --git a/src/qemu/qemu_conf.c b/src/qemu/qemu_conf.c index d6bc1fc..be88d77 100644 --- a/src/qemu/qemu_conf.c +++ b/src/qemu/qemu_conf.c @@ -43,7 +43,7 @@ #include "uuid.h" #include "virbuffer.h" #include "virconf.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "datatypes.h" #include "xml.h" diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c index 170f15d..15b773b 100644 --- a/src/qemu/qemu_driver.c +++ b/src/qemu/qemu_driver.c @@ -63,7 +63,7 @@ #include "virlog.h" #include "datatypes.h" #include "virbuffer.h" -#include "util.h" +#include "virutil.h" #include "nodeinfo.h" #include "virstatslinux.h" #include "capabilities.h" diff --git a/src/qemu/qemu_migration.c b/src/qemu/qemu_migration.c index a77beb6..1e83e3c 100644 --- a/src/qemu/qemu_migration.c +++ b/src/qemu/qemu_migration.c @@ -39,7 +39,7 @@ #include "virlog.h" #include "virterror_internal.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "datatypes.h" #include "fdstream.h" diff --git a/src/qemu/qemu_process.c b/src/qemu/qemu_process.c index 794596b..d4eaa9e 100644 --- a/src/qemu/qemu_process.c +++ b/src/qemu/qemu_process.c @@ -57,7 +57,7 @@ #include "virhooks.h" #include "virfile.h" #include "virpidfile.h" -#include "util.h" +#include "virutil.h" #include "c-ctype.h" #include "nodeinfo.h" #include "domain_audit.h" diff --git a/src/remote/remote_driver.c b/src/remote/remote_driver.c index 2edf6e6..ac7dc87 100644 --- a/src/remote/remote_driver.c +++ b/src/remote/remote_driver.c @@ -39,7 +39,7 @@ #include "remote_protocol.h" #include "qemu_protocol.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "vircommand.h" #include "intprops.h" diff --git a/src/rpc/virkeepalive.c b/src/rpc/virkeepalive.c index 5c14e14..18be350 100644 --- a/src/rpc/virkeepalive.c +++ b/src/rpc/virkeepalive.c @@ -26,7 +26,7 @@ #include "virthread.h" #include "virfile.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "virnetsocket.h" #include "virkeepaliveprotocol.h" diff --git a/src/rpc/virnetclient.c b/src/rpc/virnetclient.c index 85787f0..9347f0b 100644 --- a/src/rpc/virnetclient.c +++ b/src/rpc/virnetclient.c @@ -34,7 +34,7 @@ #include "virthread.h" #include "virfile.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #define VIR_FROM_THIS VIR_FROM_RPC diff --git a/src/rpc/virnetclientprogram.c b/src/rpc/virnetclientprogram.c index 00948e0..eff4a4c 100644 --- a/src/rpc/virnetclientprogram.c +++ b/src/rpc/virnetclientprogram.c @@ -31,7 +31,7 @@ #include "viralloc.h" #include "virterror_internal.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "virthread.h" diff --git a/src/rpc/virnetmessage.c b/src/rpc/virnetmessage.c index f273811..b2da65b 100644 --- a/src/rpc/virnetmessage.c +++ b/src/rpc/virnetmessage.c @@ -28,7 +28,7 @@ #include "virterror_internal.h" #include "virlog.h" #include "virfile.h" -#include "util.h" +#include "virutil.h" #define VIR_FROM_THIS VIR_FROM_RPC diff --git a/src/rpc/virnetserver.c b/src/rpc/virnetserver.c index b48af5e..47a6293 100644 --- a/src/rpc/virnetserver.c +++ b/src/rpc/virnetserver.c @@ -33,7 +33,7 @@ #include "virterror_internal.h" #include "virthread.h" #include "virthreadpool.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "virnetservermdns.h" #include "virdbus.h" diff --git a/src/rpc/virnetsocket.c b/src/rpc/virnetsocket.c index 442850a..a959c30 100644 --- a/src/rpc/virnetsocket.c +++ b/src/rpc/virnetsocket.c @@ -41,7 +41,7 @@ #include "c-ctype.h" #include "virnetsocket.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virterror_internal.h" #include "virlog.h" diff --git a/src/rpc/virnetsshsession.c b/src/rpc/virnetsshsession.c index 663b7cd..ad8bd48 100644 --- a/src/rpc/virnetsshsession.c +++ b/src/rpc/virnetsshsession.c @@ -31,7 +31,7 @@ #include "virlog.h" #include "configmake.h" #include "virthread.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "virobject.h" diff --git a/src/rpc/virnettlscontext.c b/src/rpc/virnettlscontext.c index 1ff40cf..b01de8c 100644 --- a/src/rpc/virnettlscontext.c +++ b/src/rpc/virnettlscontext.c @@ -32,7 +32,7 @@ #include "viralloc.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "virthread.h" #include "configmake.h" diff --git a/src/secret/secret_driver.c b/src/secret/secret_driver.c index 672ff54..8dfd921 100644 --- a/src/secret/secret_driver.c +++ b/src/secret/secret_driver.c @@ -37,7 +37,7 @@ #include "secret_conf.h" #include "secret_driver.h" #include "virthread.h" -#include "util.h" +#include "virutil.h" #include "uuid.h" #include "virterror_internal.h" #include "virfile.h" diff --git a/src/security/security_apparmor.c b/src/security/security_apparmor.c index d28189f..4027cdf 100644 --- a/src/security/security_apparmor.c +++ b/src/security/security_apparmor.c @@ -38,7 +38,7 @@ #include "internal.h" #include "security_apparmor.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virterror_internal.h" #include "datatypes.h" diff --git a/src/security/security_dac.c b/src/security/security_dac.c index f9752ef..3104f42 100644 --- a/src/security/security_dac.c +++ b/src/security/security_dac.c @@ -25,7 +25,7 @@ #include "security_dac.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "virpci.h" diff --git a/src/security/security_selinux.c b/src/security/security_selinux.c index 8918257..ccba258 100644 --- a/src/security/security_selinux.c +++ b/src/security/security_selinux.c @@ -34,7 +34,7 @@ #include "security_driver.h" #include "security_selinux.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "virpci.h" @@ -43,7 +43,7 @@ #include "virfile.h" #include "virhash.h" #include "virrandom.h" -#include "util.h" +#include "virutil.h" #include "virconf.h" #define VIR_FROM_THIS VIR_FROM_SECURITY diff --git a/src/security/virt-aa-helper.c b/src/security/virt-aa-helper.c index 4945f7c..5cfa3ff 100644 --- a/src/security/virt-aa-helper.c +++ b/src/security/virt-aa-helper.c @@ -41,7 +41,7 @@ #include "internal.h" #include "virbuffer.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "vircommand.h" diff --git a/src/storage/parthelper.c b/src/storage/parthelper.c index 5417ced..83f8279 100644 --- a/src/storage/parthelper.c +++ b/src/storage/parthelper.c @@ -41,7 +41,7 @@ #include <unistd.h> #include <locale.h> -#include "util.h" +#include "virutil.h" #include "c-ctype.h" #include "configmake.h" diff --git a/src/storage/storage_backend.c b/src/storage/storage_backend.c index 9b98dbb..29272f1 100644 --- a/src/storage/storage_backend.c +++ b/src/storage/storage_backend.c @@ -47,7 +47,7 @@ #include "datatypes.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "internal.h" #include "secret_conf.h" diff --git a/src/storage/storage_backend_disk.c b/src/storage/storage_backend_disk.c index 8759b3a..aceb82b 100644 --- a/src/storage/storage_backend_disk.c +++ b/src/storage/storage_backend_disk.c @@ -29,7 +29,7 @@ #include "virterror_internal.h" #include "virlog.h" #include "storage_backend_disk.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "vircommand.h" #include "configmake.h" diff --git a/src/storage/storage_backend_iscsi.c b/src/storage/storage_backend_iscsi.c index ecb8f8e..e91c4b1 100644 --- a/src/storage/storage_backend_iscsi.c +++ b/src/storage/storage_backend_iscsi.c @@ -37,7 +37,7 @@ #include "virterror_internal.h" #include "storage_backend_scsi.h" #include "storage_backend_iscsi.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "virfile.h" diff --git a/src/storage/storage_backend_rbd.c b/src/storage/storage_backend_rbd.c index e1f07ab..ffa3234 100644 --- a/src/storage/storage_backend_rbd.c +++ b/src/storage/storage_backend_rbd.c @@ -25,7 +25,7 @@ #include "virterror_internal.h" #include "storage_backend_rbd.h" #include "storage_conf.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "base64.h" diff --git a/src/storage/storage_backend_sheepdog.c b/src/storage/storage_backend_sheepdog.c index d3b9d87..1046ac9 100644 --- a/src/storage/storage_backend_sheepdog.c +++ b/src/storage/storage_backend_sheepdog.c @@ -30,7 +30,7 @@ #include "storage_backend_sheepdog.h" #include "storage_conf.h" #include "vircommand.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" diff --git a/src/storage/storage_driver.c b/src/storage/storage_driver.c index aebf8bb..d93617c 100644 --- a/src/storage/storage_driver.c +++ b/src/storage/storage_driver.c @@ -39,7 +39,7 @@ #include "virterror_internal.h" #include "datatypes.h" #include "driver.h" -#include "util.h" +#include "virutil.h" #include "storage_driver.h" #include "storage_conf.h" #include "viralloc.h" diff --git a/src/test/test_driver.c b/src/test/test_driver.c index 185bb3b..da76367 100644 --- a/src/test/test_driver.c +++ b/src/test/test_driver.c @@ -36,7 +36,7 @@ #include "datatypes.h" #include "test_driver.h" #include "virbuffer.h" -#include "util.h" +#include "virutil.h" #include "uuid.h" #include "capabilities.h" #include "viralloc.h" diff --git a/src/uml/uml_conf.c b/src/uml/uml_conf.c index 6da311b..b2057e8 100644 --- a/src/uml/uml_conf.c +++ b/src/uml/uml_conf.c @@ -39,7 +39,7 @@ #include "uuid.h" #include "virbuffer.h" #include "virconf.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "nodeinfo.h" #include "virlog.h" diff --git a/src/uml/uml_driver.c b/src/uml/uml_driver.c index b20998f..05fb7f2 100644 --- a/src/uml/uml_driver.c +++ b/src/uml/uml_driver.c @@ -47,7 +47,7 @@ #include "uml_driver.h" #include "uml_conf.h" #include "virbuffer.h" -#include "util.h" +#include "virutil.h" #include "nodeinfo.h" #include "virstatslinux.h" #include "capabilities.h" diff --git a/src/util/iohelper.c b/src/util/iohelper.c index dcb5c14..40b04f9 100644 --- a/src/util/iohelper.c +++ b/src/util/iohelper.c @@ -33,7 +33,7 @@ #include <stdio.h> #include <stdlib.h> -#include "util.h" +#include "virutil.h" #include "virthread.h" #include "virfile.h" #include "viralloc.h" diff --git a/src/util/util.c b/src/util/util.c deleted file mode 100644 index c7d4aa5..0000000 --- a/src/util/util.c +++ /dev/null @@ -1,3131 +0,0 @@ -/* - * utils.c: common, generic utility functions - * - * Copyright (C) 2006-2012 Red Hat, Inc. - * Copyright (C) 2006 Daniel P. Berrange - * Copyright (C) 2006, 2007 Binary Karma - * Copyright (C) 2006 Shuveb Hussain - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Author: Daniel P. Berrange <berrange(a)redhat.com&gt; - * File created Jul 18, 2007 - Shuveb Hussain <shuveb(a)binarykarma.com&gt; - */ - -#include <config.h> - -#include <stdio.h> -#include <stdarg.h> -#include <stdlib.h> -#include <unistd.h> -#include <fcntl.h> -#include <errno.h> -#include <poll.h> -#include <sys/stat.h> -#include <sys/types.h> -#include <sys/ioctl.h> -#include <sys/wait.h> -#if HAVE_MMAP -# include <sys/mman.h> -#endif -#include <string.h> -#include <signal.h> -#include <termios.h> -#include <pty.h> -#include <locale.h> - -#if HAVE_LIBDEVMAPPER_H -# include <libdevmapper.h> -#endif - -#ifdef HAVE_PATHS_H -# include <paths.h> -#endif -#include <netdb.h> -#ifdef HAVE_GETPWUID_R -# include <pwd.h> -# include <grp.h> -#endif -#if HAVE_CAPNG -# include <cap-ng.h> -#endif -#if defined HAVE_MNTENT_H && defined HAVE_GETMNTENT_R -# include <mntent.h> -#endif - -#ifdef WIN32 -# ifdef HAVE_WINSOCK2_H -# include <winsock2.h> -# endif -# include <windows.h> -# include <shlobj.h> -#endif - -#include "c-ctype.h" -#include "dirname.h" -#include "virterror_internal.h" -#include "virlog.h" -#include "virbuffer.h" -#include "util.h" -#include "virstoragefile.h" -#include "viralloc.h" -#include "virthread.h" -#include "verify.h" -#include "virfile.h" -#include "vircommand.h" -#include "nonblocking.h" -#include "passfd.h" -#include "virprocess.h" - -#ifndef NSIG -# define NSIG 32 -#endif - -verify(sizeof(gid_t) <= sizeof(unsigned int) && - sizeof(uid_t) <= sizeof(unsigned int)); - -#define VIR_FROM_THIS VIR_FROM_NONE - -/* Like read(), but restarts after EINTR */ -ssize_t -saferead(int fd, void *buf, size_t count) -{ - size_t nread = 0; - while (count > 0) { - ssize_t r = read(fd, buf, count); - if (r < 0 && errno == EINTR) - continue; - if (r < 0) - return r; - if (r == 0) - return nread; - buf = (char *)buf + r; - count -= r; - nread += r; - } - return nread; -} - -/* Like write(), but restarts after EINTR */ -ssize_t -safewrite(int fd, const void *buf, size_t count) -{ - size_t nwritten = 0; - while (count > 0) { - ssize_t r = write(fd, buf, count); - - if (r < 0 && errno == EINTR) - continue; - if (r < 0) - return r; - if (r == 0) - return nwritten; - buf = (const char *)buf + r; - count -= r; - nwritten += r; - } - return nwritten; -} - -#ifdef HAVE_POSIX_FALLOCATE -int safezero(int fd, off_t offset, off_t len) -{ - int ret = posix_fallocate(fd, offset, len); - if (ret == 0) - return 0; - errno = ret; - return -1; -} -#else - -# ifdef HAVE_MMAP -int safezero(int fd, off_t offset, off_t len) -{ - int r; - char *buf; - - /* memset wants the mmap'ed file to be present on disk so create a - * sparse file - */ - r = ftruncate(fd, offset + len); - if (r < 0) - return -1; - - buf = mmap(NULL, len, PROT_READ | PROT_WRITE, MAP_SHARED, fd, offset); - if (buf == MAP_FAILED) - return -1; - - memset(buf, 0, len); - munmap(buf, len); - - return 0; -} - -# else /* HAVE_MMAP */ - -int safezero(int fd, off_t offset, off_t len) -{ - int r; - char *buf; - unsigned long long remain, bytes; - - if (lseek(fd, offset, SEEK_SET) < 0) - return -1; - - /* Split up the write in small chunks so as not to allocate lots of RAM */ - remain = len; - bytes = 1024 * 1024; - - r = VIR_ALLOC_N(buf, bytes); - if (r < 0) { - errno = ENOMEM; - return -1; - } - - while (remain) { - if (bytes > remain) - bytes = remain; - - r = safewrite(fd, buf, bytes); - if (r < 0) { - VIR_FREE(buf); - return -1; - } - - /* safewrite() guarantees all data will be written */ - remain -= bytes; - } - VIR_FREE(buf); - return 0; -} -# endif /* HAVE_MMAP */ -#endif /* HAVE_POSIX_FALLOCATE */ - -int virFileStripSuffix(char *str, - const char *suffix) -{ - int len = strlen(str); - int suffixlen = strlen(suffix); - - if (len < suffixlen) - return 0; - - if (!STREQ(str + len - suffixlen, suffix)) - return 0; - - str[len-suffixlen] = '\0'; - - return 1; -} - -char * -virArgvToString(const char *const *argv) -{ - int len, i; - char *ret, *p; - - for (len = 1, i = 0; argv[i]; i++) - len += strlen(argv[i]) + 1; - - if (VIR_ALLOC_N(ret, len) < 0) - return NULL; - p = ret; - - for (i = 0; argv[i]; i++) { - if (i != 0) - *(p++) = ' '; - - strcpy(p, argv[i]); - p += strlen(argv[i]); - } - - *p = '\0'; - - return ret; -} - -#ifndef WIN32 - -int virSetInherit(int fd, bool inherit) { - int fflags; - if ((fflags = fcntl(fd, F_GETFD)) < 0) - return -1; - if (inherit) - fflags &= ~FD_CLOEXEC; - else - fflags |= FD_CLOEXEC; - if ((fcntl(fd, F_SETFD, fflags)) < 0) - return -1; - return 0; -} - -#else /* WIN32 */ - -int virSetInherit(int fd ATTRIBUTE_UNUSED, bool inherit ATTRIBUTE_UNUSED) -{ - /* FIXME: Currently creating child processes is not supported on - * Win32, so there is no point in failing calls that are only relevant - * when creating child processes. So just pretend that we changed the - * inheritance property of the given fd as requested. */ - return 0; -} - -#endif /* WIN32 */ - -int virSetBlocking(int fd, bool blocking) { - return set_nonblocking_flag(fd, !blocking); -} - -int virSetNonBlock(int fd) { - return virSetBlocking(fd, false); -} - -int virSetCloseExec(int fd) -{ - return virSetInherit(fd, false); -} - -int -virPipeReadUntilEOF(int outfd, int errfd, - char **outbuf, char **errbuf) { - - struct pollfd fds[2]; - int i; - int finished[2]; - - fds[0].fd = outfd; - fds[0].events = POLLIN; - fds[0].revents = 0; - finished[0] = 0; - fds[1].fd = errfd; - fds[1].events = POLLIN; - fds[1].revents = 0; - finished[1] = 0; - - while (!(finished[0] && finished[1])) { - - if (poll(fds, ARRAY_CARDINALITY(fds), -1) < 0) { - if ((errno == EAGAIN) || (errno == EINTR)) - continue; - goto pollerr; - } - - for (i = 0; i < ARRAY_CARDINALITY(fds); ++i) { - char data[1024], **buf; - int got, size; - - if (!(fds[i].revents)) - continue; - else if (fds[i].revents & POLLHUP) - finished[i] = 1; - - if (!(fds[i].revents & POLLIN)) { - if (fds[i].revents & POLLHUP) - continue; - - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("Unknown poll response.")); - goto error; - } - - got = read(fds[i].fd, data, sizeof(data)); - - if (got == sizeof(data)) - finished[i] = 0; - - if (got == 0) { - finished[i] = 1; - continue; - } - if (got < 0) { - if (errno == EINTR) - continue; - if (errno == EAGAIN) - break; - goto pollerr; - } - - buf = ((fds[i].fd == outfd) ? outbuf : errbuf); - size = (*buf ? strlen(*buf) : 0); - if (VIR_REALLOC_N(*buf, size+got+1) < 0) { - virReportOOMError(); - goto error; - } - memmove(*buf+size, data, got); - (*buf)[size+got] = '\0'; - } - continue; - - pollerr: - virReportSystemError(errno, - "%s", _("poll error")); - goto error; - } - - return 0; - -error: - VIR_FREE(*outbuf); - VIR_FREE(*errbuf); - return -1; -} - -/* Like gnulib's fread_file, but read no more than the specified maximum - number of bytes. If the length of the input is <= max_len, and - upon error while reading that data, it works just like fread_file. */ -static char * -saferead_lim(int fd, size_t max_len, size_t *length) -{ - char *buf = NULL; - size_t alloc = 0; - size_t size = 0; - int save_errno; - - for (;;) { - int count; - int requested; - - if (size + BUFSIZ + 1 > alloc) { - alloc += alloc / 2; - if (alloc < size + BUFSIZ + 1) - alloc = size + BUFSIZ + 1; - - if (VIR_REALLOC_N(buf, alloc) < 0) { - save_errno = errno; - break; - } - } - - /* Ensure that (size + requested <= max_len); */ - requested = MIN(size < max_len ? max_len - size : 0, - alloc - size - 1); - count = saferead(fd, buf + size, requested); - size += count; - - if (count != requested || requested == 0) { - save_errno = errno; - if (count < 0) - break; - buf[size] = '\0'; - *length = size; - return buf; - } - } - - VIR_FREE(buf); - errno = save_errno; - return NULL; -} - -/* A wrapper around saferead_lim that maps a failure due to - exceeding the maximum size limitation to EOVERFLOW. */ -int -virFileReadLimFD(int fd, int maxlen, char **buf) -{ - size_t len; - char *s; - - if (maxlen <= 0) { - errno = EINVAL; - return -1; - } - s = saferead_lim(fd, maxlen+1, &len); - if (s == NULL) - return -1; - if (len > maxlen || (int)len != len) { - VIR_FREE(s); - /* There was at least one byte more than MAXLEN. - Set errno accordingly. */ - errno = EOVERFLOW; - return -1; - } - *buf = s; - return len; -} - -int virFileReadAll(const char *path, int maxlen, char **buf) -{ - int fd = open(path, O_RDONLY); - if (fd < 0) { - virReportSystemError(errno, _("Failed to open file '%s'"), path); - return -1; - } - - int len = virFileReadLimFD(fd, maxlen, buf); - VIR_FORCE_CLOSE(fd); - if (len < 0) { - virReportSystemError(errno, _("Failed to read file '%s'"), path); - return -1; - } - - return len; -} - -/* Truncate @path and write @str to it. If @mode is 0, ensure that - @path exists; otherwise, use @mode if @path must be created. - Return 0 for success, nonzero for failure. - Be careful to preserve any errno value upon failure. */ -int virFileWriteStr(const char *path, const char *str, mode_t mode) -{ - int fd; - - if (mode) - fd = open(path, O_WRONLY|O_TRUNC|O_CREAT, mode); - else - fd = open(path, O_WRONLY|O_TRUNC); - if (fd == -1) - return -1; - - if (safewrite(fd, str, strlen(str)) < 0) { - VIR_FORCE_CLOSE(fd); - return -1; - } - - /* Use errno from failed close only if there was no write error. */ - if (VIR_CLOSE(fd) != 0) - return -1; - - return 0; -} - -int virFileMatchesNameSuffix(const char *file, - const char *name, - const char *suffix) -{ - int filelen = strlen(file); - int namelen = strlen(name); - int suffixlen = strlen(suffix); - - if (filelen == (namelen + suffixlen) && - STREQLEN(file, name, namelen) && - STREQLEN(file + namelen, suffix, suffixlen)) - return 1; - else - return 0; -} - -int virFileHasSuffix(const char *str, - const char *suffix) -{ - int len = strlen(str); - int suffixlen = strlen(suffix); - - if (len < suffixlen) - return 0; - - return STRCASEEQ(str + len - suffixlen, suffix); -} - -#define SAME_INODE(Stat_buf_1, Stat_buf_2) \ - ((Stat_buf_1).st_ino == (Stat_buf_2).st_ino \ - && (Stat_buf_1).st_dev == (Stat_buf_2).st_dev) - -/* Return nonzero if checkLink and checkDest - refer to the same file. Otherwise, return 0. */ -int virFileLinkPointsTo(const char *checkLink, - const char *checkDest) -{ - struct stat src_sb; - struct stat dest_sb; - - return (stat(checkLink, &src_sb) == 0 - && stat(checkDest, &dest_sb) == 0 - && SAME_INODE(src_sb, dest_sb)); -} - - - -static int -virFileResolveLinkHelper(const char *linkpath, - bool intermediatePaths, - char **resultpath) -{ - struct stat st; - - *resultpath = NULL; - - /* We don't need the full canonicalization of intermediate - * directories, if linkpath is absolute and the basename is - * already a non-symlink. */ - if (IS_ABSOLUTE_FILE_NAME(linkpath) && !intermediatePaths) { - if (lstat(linkpath, &st) < 0) - return -1; - - if (!S_ISLNK(st.st_mode)) { - if (!(*resultpath = strdup(linkpath))) - return -1; - return 0; - } - } - - *resultpath = canonicalize_file_name(linkpath); - - return *resultpath == NULL ? -1 : 0; -} - -/* - * Attempt to resolve a symbolic link, returning an - * absolute path where only the last component is guaranteed - * not to be a symlink. - * - * Return 0 if path was not a symbolic, or the link was - * resolved. Return -1 with errno set upon error - */ -int virFileResolveLink(const char *linkpath, - char **resultpath) -{ - return virFileResolveLinkHelper(linkpath, false, resultpath); -} - -/* - * Attempt to resolve a symbolic link, returning an - * absolute path where every component is guaranteed - * not to be a symlink. - * - * Return 0 if path was not a symbolic, or the link was - * resolved. Return -1 with errno set upon error - */ -int virFileResolveAllLinks(const char *linkpath, - char **resultpath) -{ - return virFileResolveLinkHelper(linkpath, true, resultpath); -} - -/* - * Check whether the given file is a link. - * Returns 1 in case of the file being a link, 0 in case it is not - * a link and the negative errno in all other cases. - */ -int virFileIsLink(const char *linkpath) -{ - struct stat st; - - if (lstat(linkpath, &st) < 0) - return -errno; - - return S_ISLNK(st.st_mode) != 0; -} - - -/* - * Finds a requested executable file in the PATH env. e.g.: - * "kvm-img" will return "/usr/bin/kvm-img" - * - * You must free the result - */ -char *virFindFileInPath(const char *file) -{ - char *path = NULL; - char *pathiter; - char *pathseg; - char *fullpath = NULL; - - if (file == NULL) - return NULL; - - /* if we are passed an absolute path (starting with /), return a - * copy of that path, after validating that it is executable - */ - if (IS_ABSOLUTE_FILE_NAME(file)) { - if (virFileIsExecutable(file)) - return strdup(file); - else - return NULL; - } - - /* If we are passed an anchored path (containing a /), then there - * is no path search - it must exist in the current directory - */ - if (strchr(file, '/')) { - if (virFileIsExecutable(file)) - ignore_value(virFileAbsPath(file, &path)); - return path; - } - - /* copy PATH env so we can tweak it */ - path = getenv("PATH"); - - if (path == NULL || (path = strdup(path)) == NULL) - return NULL; - - /* for each path segment, append the file to search for and test for - * it. return it if found. - */ - pathiter = path; - while ((pathseg = strsep(&pathiter, ":")) != NULL) { - if (virAsprintf(&fullpath, "%s/%s", pathseg, file) < 0 || - virFileIsExecutable(fullpath)) - break; - VIR_FREE(fullpath); - } - - VIR_FREE(path); - return fullpath; -} - -bool virFileIsDir(const char *path) -{ - struct stat s; - return (stat(path, &s) == 0) && S_ISDIR(s.st_mode); -} - -bool virFileExists(const char *path) -{ - return access(path, F_OK) == 0; -} - -/* Check that a file is regular and has executable bits. If false is - * returned, errno is valid. - * - * Note: In the presence of ACLs, this may return true for a file that - * would actually fail with EACCES for a given user, or false for a - * file that the user could actually execute, but setups with ACLs - * that weird are unusual. */ -bool -virFileIsExecutable(const char *file) -{ - struct stat sb; - - /* We would also want to check faccessat if we cared about ACLs, - * but we don't. */ - if (stat(file, &sb) < 0) - return false; - if (S_ISREG(sb.st_mode) && (sb.st_mode & 0111) != 0) - return true; - errno = S_ISDIR(sb.st_mode) ? EISDIR : EACCES; - return false; -} - -#ifndef WIN32 -/* Check that a file is accessible under certain - * user & gid. - * @mode can be F_OK, or a bitwise combination of R_OK, W_OK, and X_OK. - * see 'man access' for more details. - * Returns 0 on success, -1 on fail with errno set. - */ -int -virFileAccessibleAs(const char *path, int mode, - uid_t uid, gid_t gid) -{ - pid_t pid = 0; - int status, ret = 0; - int forkRet = 0; - - if (uid == getuid() && - gid == getgid()) - return access(path, mode); - - forkRet = virFork(&pid); - - if (pid < 0) { - return -1; - } - - if (pid) { /* parent */ - if (virProcessWait(pid, &status) < 0) { - /* virProcessWait() already - * reported error */ - return -1; - } - - if (!WIFEXITED(status)) { - errno = EINTR; - return -1; - } - - if (status) { - errno = WEXITSTATUS(status); - return -1; - } - - return 0; - } - - /* child. - * Return positive value here. Parent - * will change it to negative one. */ - - if (forkRet < 0) { - ret = errno; - goto childerror; - } - - if (virSetUIDGID(uid, gid) < 0) { - ret = errno; - goto childerror; - } - - if (access(path, mode) < 0) - ret = errno; - -childerror: - if ((ret & 0xFF) != ret) { - VIR_WARN("unable to pass desired return value %d", ret); - ret = 0xFF; - } - - _exit(ret); -} - -/* virFileOpenForceOwnerMode() - an internal utility function called - * only by virFileOpenAs(). Sets the owner and mode of the file - * opened as "fd" if it's not correct AND the flags say it should be - * forced. */ -static int -virFileOpenForceOwnerMode(const char *path, int fd, mode_t mode, - uid_t uid, gid_t gid, unsigned int flags) -{ - int ret = 0; - struct stat st; - - if (!(flags & (VIR_FILE_OPEN_FORCE_OWNER | VIR_FILE_OPEN_FORCE_MODE))) - return 0; - - if (fstat(fd, &st) == -1) { - ret = -errno; - virReportSystemError(errno, _("stat of '%s' failed"), path); - return ret; - } - /* NB: uid:gid are never "-1" (default) at this point - the caller - * has always changed -1 to the value of get[gu]id(). - */ - if ((flags & VIR_FILE_OPEN_FORCE_OWNER) && - ((st.st_uid != uid) || (st.st_gid != gid)) && - (fchown(fd, uid, gid) < 0)) { - ret = -errno; - virReportSystemError(errno, - _("cannot chown '%s' to (%u, %u)"), - path, (unsigned int) uid, - (unsigned int) gid); - return ret; - } - if ((flags & VIR_FILE_OPEN_FORCE_MODE) && - ((mode & (S_IRWXU|S_IRWXG|S_IRWXO)) != - (st.st_mode & (S_IRWXU|S_IRWXG|S_IRWXO))) && - (fchmod(fd, mode) < 0)) { - ret = -errno; - virReportSystemError(errno, - _("cannot set mode of '%s' to %04o"), - path, mode); - return ret; - } - return ret; -} - -/* virFileOpenForked() - an internal utility function called only by - * virFileOpenAs(). It forks, then the child does setuid+setgid to - * given uid:gid and attempts to open the file, while the parent just - * calls recvfd to get the open fd back from the child. returns the - * fd, or -errno if there is an error. */ -static int -virFileOpenForked(const char *path, int openflags, mode_t mode, - uid_t uid, gid_t gid, unsigned int flags) -{ - pid_t pid; - int waitret, status, ret = 0; - int fd = -1; - int pair[2] = { -1, -1 }; - int forkRet; - - /* parent is running as root, but caller requested that the - * file be opened as some other user and/or group). The - * following dance avoids problems caused by root-squashing - * NFS servers. */ - - if (socketpair(AF_UNIX, SOCK_STREAM, 0, pair) < 0) { - ret = -errno; - virReportSystemError(errno, - _("failed to create socket needed for '%s'"), - path); - return ret; - } - - forkRet = virFork(&pid); - if (pid < 0) - return -errno; - - if (pid == 0) { - - /* child */ - - VIR_FORCE_CLOSE(pair[0]); /* preserves errno */ - if (forkRet < 0) { - /* error encountered and logged in virFork() after the fork. */ - ret = -errno; - goto childerror; - } - - /* set desired uid/gid, then attempt to create the file */ - - if (virSetUIDGID(uid, gid) < 0) { - ret = -errno; - goto childerror; - } - - if ((fd = open(path, openflags, mode)) < 0) { - ret = -errno; - virReportSystemError(errno, - _("child process failed to create file '%s'"), - path); - goto childerror; - } - - /* File is successfully open. Set permissions if requested. */ - ret = virFileOpenForceOwnerMode(path, fd, mode, uid, gid, flags); - if (ret < 0) - goto childerror; - - do { - ret = sendfd(pair[1], fd); - } while (ret < 0 && errno == EINTR); - - if (ret < 0) { - ret = -errno; - virReportSystemError(errno, "%s", - _("child process failed to send fd to parent")); - goto childerror; - } - - childerror: - /* ret tracks -errno on failure, but exit value must be positive. - * If the child exits with EACCES, then the parent tries again. */ - /* XXX This makes assumptions about errno being < 255, which is - * not true on Hurd. */ - VIR_FORCE_CLOSE(pair[1]); - if (ret < 0) { - VIR_FORCE_CLOSE(fd); - } - ret = -ret; - if ((ret & 0xff) != ret) { - VIR_WARN("unable to pass desired return value %d", ret); - ret = 0xff; - } - _exit(ret); - } - - /* parent */ - - VIR_FORCE_CLOSE(pair[1]); - - do { - fd = recvfd(pair[0], 0); - } while (fd < 0 && errno == EINTR); - VIR_FORCE_CLOSE(pair[0]); /* NB: this preserves errno */ - - if (fd < 0 && errno != EACCES) { - ret = -errno; - while (waitpid(pid, NULL, 0) == -1 && errno == EINTR); - return ret; - } - - /* wait for child to complete, and retrieve its exit code */ - while ((waitret = waitpid(pid, &status, 0) == -1) - && (errno == EINTR)); - if (waitret == -1) { - ret = -errno; - virReportSystemError(errno, - _("failed to wait for child creating '%s'"), - path); - VIR_FORCE_CLOSE(fd); - return ret; - } - if (!WIFEXITED(status) || (ret = -WEXITSTATUS(status)) == -EACCES || - fd == -1) { - /* fall back to the simpler method, which works better in - * some cases */ - VIR_FORCE_CLOSE(fd); - if (flags & VIR_FILE_OPEN_NOFORK) { - /* If we had already tried opening w/o fork+setuid and - * failed, no sense trying again. Just set return the - * original errno that we got at that time (by - * definition, always either EACCES or EPERM - EACCES - * is close enough). - */ - return -EACCES; - } - if ((fd = open(path, openflags, mode)) < 0) - return -errno; - ret = virFileOpenForceOwnerMode(path, fd, mode, uid, gid, flags); - if (ret < 0) { - VIR_FORCE_CLOSE(fd); - return ret; - } - } - return fd; -} - -/** - * virFileOpenAs: - * @path: file to open or create - * @openflags: flags to pass to open - * @mode: mode to use on creation or when forcing permissions - * @uid: uid that should own file on creation - * @gid: gid that should own file - * @flags: bit-wise or of VIR_FILE_OPEN_* flags - * - * Open @path, and return an fd to the open file. @openflags contains - * the flags normally passed to open(2), while those in @flags are - * used internally. If @flags includes VIR_FILE_OPEN_NOFORK, then try - * opening the file while executing with the current uid:gid - * (i.e. don't fork+setuid+setgid before the call to open()). If - * @flags includes VIR_FILE_OPEN_FORK, then try opening the file while - * the effective user id is @uid (by forking a child process); this - * allows one to bypass root-squashing NFS issues; NOFORK is always - * tried before FORK (the absence of both flags is treated identically - * to (VIR_FILE_OPEN_NOFORK | VIR_FILE_OPEN_FORK)). If @flags includes - * VIR_FILE_OPEN_FORCE_OWNER, then ensure that @path is owned by - * uid:gid before returning (even if it already existed with a - * different owner). If @flags includes VIR_FILE_OPEN_FORCE_MODE, - * ensure it has those permissions before returning (again, even if - * the file already existed with different permissions). The return - * value (if non-negative) is the file descriptor, left open. Returns - * -errno on failure. */ -int -virFileOpenAs(const char *path, int openflags, mode_t mode, - uid_t uid, gid_t gid, unsigned int flags) -{ - int ret = 0, fd = -1; - - /* allow using -1 to mean "current value" */ - if (uid == (uid_t) -1) - uid = getuid(); - if (gid == (gid_t) -1) - gid = getgid(); - - /* treat absence of both flags as presence of both for simpler - * calling. */ - if (!(flags & (VIR_FILE_OPEN_NOFORK|VIR_FILE_OPEN_FORK))) - flags |= VIR_FILE_OPEN_NOFORK|VIR_FILE_OPEN_FORK; - - if ((flags & VIR_FILE_OPEN_NOFORK) - || (getuid() != 0) - || ((uid == 0) && (gid == 0))) { - - if ((fd = open(path, openflags, mode)) < 0) { - ret = -errno; - } else { - ret = virFileOpenForceOwnerMode(path, fd, mode, uid, gid, flags); - if (ret < 0) - goto error; - } - } - - /* If we either 1) didn't try opening as current user at all, or - * 2) failed, and errno/virStorageFileIsSharedFS indicate we might - * be successful if we try as a different uid, then try doing - * fork+setuid+setgid before opening. - */ - if ((fd < 0) && (flags & VIR_FILE_OPEN_FORK)) { - - if (ret < 0) { - /* An open(2) that failed due to insufficient permissions - * could return one or the other of these depending on OS - * version and circumstances. Any other errno indicates a - * problem that couldn't be remedied by fork+setuid - * anyway. */ - if (ret != -EACCES && ret != -EPERM) - goto error; - - /* On Linux we can also verify the FS-type of the - * directory. (this is a NOP on other platforms). */ - switch (virStorageFileIsSharedFS(path)) { - case 1: - /* it was on a network share, so we'll re-try */ - break; - case -1: - /* failure detecting fstype */ - virReportSystemError(errno, _("couldn't determine fs type " - "of mount containing '%s'"), path); - goto error; - case 0: - default: - /* file isn't on a recognized network FS */ - goto error; - } - } - - /* passed all prerequisites - retry the open w/fork+setuid */ - if ((fd = virFileOpenForked(path, openflags, mode, uid, gid, flags)) < 0) { - ret = fd; - fd = -1; - goto error; - } - } - - /* File is successfully opened */ - - return fd; - -error: - if (fd < 0) { - /* whoever failed the open last has already set ret = -errno */ - virReportSystemError(-ret, openflags & O_CREAT - ? _("failed to create file '%s'") - : _("failed to open file '%s'"), - path); - } else { - /* some other failure after the open succeeded */ - VIR_FORCE_CLOSE(fd); - } - return ret; -} - -/* return -errno on failure, or 0 on success */ -static int virDirCreateNoFork(const char *path, mode_t mode, uid_t uid, gid_t gid, - unsigned int flags) { - int ret = 0; - struct stat st; - - if ((mkdir(path, mode) < 0) - && !((errno == EEXIST) && (flags & VIR_DIR_CREATE_ALLOW_EXIST))) { - ret = -errno; - virReportSystemError(errno, _("failed to create directory '%s'"), - path); - goto error; - } - - if (stat(path, &st) == -1) { - ret = -errno; - virReportSystemError(errno, _("stat of '%s' failed"), path); - goto error; - } - if (((st.st_uid != uid) || (st.st_gid != gid)) - && (chown(path, uid, gid) < 0)) { - ret = -errno; - virReportSystemError(errno, _("cannot chown '%s' to (%u, %u)"), - path, (unsigned int) uid, (unsigned int) gid); - goto error; - } - if ((flags & VIR_DIR_CREATE_FORCE_PERMS) - && (chmod(path, mode) < 0)) { - ret = -errno; - virReportSystemError(errno, - _("cannot set mode of '%s' to %04o"), - path, mode); - goto error; - } -error: - return ret; -} - -/* return -errno on failure, or 0 on success */ -int virDirCreate(const char *path, mode_t mode, - uid_t uid, gid_t gid, unsigned int flags) { - struct stat st; - pid_t pid; - int waitret; - int status, ret = 0; - - /* allow using -1 to mean "current value" */ - if (uid == (uid_t) -1) - uid = getuid(); - if (gid == (gid_t) -1) - gid = getgid(); - - if ((!(flags & VIR_DIR_CREATE_AS_UID)) - || (getuid() != 0) - || ((uid == 0) && (gid == 0)) - || ((flags & VIR_DIR_CREATE_ALLOW_EXIST) && (stat(path, &st) >= 0))) { - return virDirCreateNoFork(path, mode, uid, gid, flags); - } - - int forkRet = virFork(&pid); - - if (pid < 0) { - ret = -errno; - return ret; - } - - if (pid) { /* parent */ - /* wait for child to complete, and retrieve its exit code */ - while ((waitret = waitpid(pid, &status, 0) == -1) && (errno == EINTR)); - if (waitret == -1) { - ret = -errno; - virReportSystemError(errno, - _("failed to wait for child creating '%s'"), - path); - goto parenterror; - } - if (!WIFEXITED(status) || (ret = -WEXITSTATUS(status)) == -EACCES) { - /* fall back to the simpler method, which works better in - * some cases */ - return virDirCreateNoFork(path, mode, uid, gid, flags); - } -parenterror: - return ret; - } - - /* child */ - - if (forkRet < 0) { - /* error encountered and logged in virFork() after the fork. */ - goto childerror; - } - - /* set desired uid/gid, then attempt to create the directory */ - - if (virSetUIDGID(uid, gid) < 0) { - ret = -errno; - goto childerror; - } - if (mkdir(path, mode) < 0) { - ret = -errno; - if (ret != -EACCES) { - /* in case of EACCES, the parent will retry */ - virReportSystemError(errno, _("child failed to create directory '%s'"), - path); - } - goto childerror; - } - /* check if group was set properly by creating after - * setgid. If not, try doing it with chown */ - if (stat(path, &st) == -1) { - ret = -errno; - virReportSystemError(errno, - _("stat of '%s' failed"), path); - goto childerror; - } - if ((st.st_gid != gid) && (chown(path, -1, gid) < 0)) { - ret = -errno; - virReportSystemError(errno, - _("cannot chown '%s' to group %u"), - path, (unsigned int) gid); - goto childerror; - } - if ((flags & VIR_DIR_CREATE_FORCE_PERMS) - && chmod(path, mode) < 0) { - virReportSystemError(errno, - _("cannot set mode of '%s' to %04o"), - path, mode); - goto childerror; - } -childerror: - _exit(ret); -} - -#else /* WIN32 */ - -int -virFileAccessibleAs(const char *path, - int mode, - uid_t uid ATTRIBUTE_UNUSED, - gid_t gid ATTRIBUTE_UNUSED) -{ - - VIR_WARN("Ignoring uid/gid due to WIN32"); - - return access(path, mode); -} - -/* return -errno on failure, or 0 on success */ -int virFileOpenAs(const char *path ATTRIBUTE_UNUSED, - int openflags ATTRIBUTE_UNUSED, - mode_t mode ATTRIBUTE_UNUSED, - uid_t uid ATTRIBUTE_UNUSED, - gid_t gid ATTRIBUTE_UNUSED, - unsigned int flags_unused ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virFileOpenAs is not implemented for WIN32")); - - return -ENOSYS; -} - -int virDirCreate(const char *path ATTRIBUTE_UNUSED, - mode_t mode ATTRIBUTE_UNUSED, - uid_t uid ATTRIBUTE_UNUSED, - gid_t gid ATTRIBUTE_UNUSED, - unsigned int flags_unused ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virDirCreate is not implemented for WIN32")); - - return -ENOSYS; -} -#endif /* WIN32 */ - -static int virFileMakePathHelper(char *path, mode_t mode) -{ - struct stat st; - char *p; - - VIR_DEBUG("path=%s mode=0%o", path, mode); - - if (stat(path, &st) >= 0) { - if (S_ISDIR(st.st_mode)) - return 0; - - errno = ENOTDIR; - return -1; - } - - if (errno != ENOENT) - return -1; - - if ((p = strrchr(path, '/')) == NULL) { - errno = EINVAL; - return -1; - } - - if (p != path) { - *p = '\0'; - - if (virFileMakePathHelper(path, mode) < 0) - return -1; - - *p = '/'; - } - - if (mkdir(path, mode) < 0 && errno != EEXIST) - return -1; - - return 0; -} - -/** - * Creates the given directory with mode 0777 if it's not already existing. - * - * Returns 0 on success, or -1 if an error occurred (in which case, errno - * is set appropriately). - */ -int virFileMakePath(const char *path) -{ - return virFileMakePathWithMode(path, 0777); -} - -int -virFileMakePathWithMode(const char *path, - mode_t mode) -{ - int ret = -1; - char *tmp; - - if ((tmp = strdup(path)) == NULL) - goto cleanup; - - ret = virFileMakePathHelper(tmp, mode); - -cleanup: - VIR_FREE(tmp); - return ret; -} - -/* Build up a fully qualified path for a config file to be - * associated with a persistent guest or network */ -char * -virFileBuildPath(const char *dir, const char *name, const char *ext) -{ - char *path; - - if (ext == NULL) { - if (virAsprintf(&path, "%s/%s", dir, name) < 0) { - virReportOOMError(); - return NULL; - } - } else { - if (virAsprintf(&path, "%s/%s%s", dir, name, ext) < 0) { - virReportOOMError(); - return NULL; - } - } - - return path; -} - -/* Open a non-blocking master side of a pty. If ttyName is not NULL, - * then populate it with the name of the slave. If rawmode is set, - * also put the master side into raw mode before returning. */ -#ifndef WIN32 -int virFileOpenTty(int *ttymaster, - char **ttyName, - int rawmode) -{ - /* XXX A word of caution - on some platforms (Solaris and HP-UX), - * additional ioctl() calls are needs after opening the slave - * before it will cause isatty() to return true. Should we make - * virFileOpenTty also return the opened slave fd, so the caller - * doesn't have to worry about that mess? */ - int ret = -1; - int slave = -1; - char *name = NULL; - - /* Unfortunately, we can't use the name argument of openpty, since - * there is no guarantee on how large the buffer has to be. - * Likewise, we can't use the termios argument: we have to use - * read-modify-write since there is no portable way to initialize - * a struct termios without use of tcgetattr. */ - if (openpty(ttymaster, &slave, NULL, NULL, NULL) < 0) - return -1; - - /* What a shame that openpty cannot atomically set FD_CLOEXEC, but - * that using posix_openpt/grantpt/unlockpt/ptsname is not - * thread-safe, and that ptsname_r is not portable. */ - if (virSetNonBlock(*ttymaster) < 0 || - virSetCloseExec(*ttymaster) < 0) - goto cleanup; - - /* While Linux supports tcgetattr on either the master or the - * slave, Solaris requires it to be on the slave. */ - if (rawmode) { - struct termios ttyAttr; - if (tcgetattr(slave, &ttyAttr) < 0) - goto cleanup; - - cfmakeraw(&ttyAttr); - - if (tcsetattr(slave, TCSADRAIN, &ttyAttr) < 0) - goto cleanup; - } - - /* ttyname_r on the slave is required by POSIX, while ptsname_r on - * the master is a glibc extension, and the POSIX ptsname is not - * thread-safe. Since openpty gave us both descriptors, guess - * which way we will determine the name? :) */ - if (ttyName) { - /* Initial guess of 64 is generally sufficient; rely on ERANGE - * to tell us if we need to grow. */ - size_t len = 64; - int rc; - - if (VIR_ALLOC_N(name, len) < 0) - goto cleanup; - - while ((rc = ttyname_r(slave, name, len)) == ERANGE) { - if (VIR_RESIZE_N(name, len, len, len) < 0) - goto cleanup; - } - if (rc != 0) { - errno = rc; - goto cleanup; - } - *ttyName = name; - name = NULL; - } - - ret = 0; - -cleanup: - if (ret != 0) - VIR_FORCE_CLOSE(*ttymaster); - VIR_FORCE_CLOSE(slave); - VIR_FREE(name); - - return ret; -} -#else /* WIN32 */ -int virFileOpenTty(int *ttymaster ATTRIBUTE_UNUSED, - char **ttyName ATTRIBUTE_UNUSED, - int rawmode ATTRIBUTE_UNUSED) -{ - /* mingw completely lacks pseudo-terminals, and the gnulib - * replacements are not (yet) license compatible. */ - errno = ENOSYS; - return -1; -} -#endif /* WIN32 */ - -bool virFileIsAbsPath(const char *path) -{ - if (!path) - return false; - - if (VIR_FILE_IS_DIR_SEPARATOR(path[0])) - return true; - -#ifdef WIN32 - if (c_isalpha(path[0]) && - path[1] == ':' && - VIR_FILE_IS_DIR_SEPARATOR(path[2])) - return true; -#endif - - return false; -} - - -const char *virFileSkipRoot(const char *path) -{ -#ifdef WIN32 - /* Skip \\server\share or //server/share */ - if (VIR_FILE_IS_DIR_SEPARATOR(path[0]) && - VIR_FILE_IS_DIR_SEPARATOR(path[1]) && - path[2] && - !VIR_FILE_IS_DIR_SEPARATOR(path[2])) - { - const char *p = strchr(path + 2, VIR_FILE_DIR_SEPARATOR); - const char *q = strchr(path + 2, '/'); - - if (p == NULL || (q != NULL && q < p)) - p = q; - - if (p && p > path + 2 && p[1]) { - path = p + 1; - - while (path[0] && - !VIR_FILE_IS_DIR_SEPARATOR(path[0])) - path++; - - /* Possibly skip a backslash after the share name */ - if (VIR_FILE_IS_DIR_SEPARATOR(path[0])) - path++; - - return path; - } - } -#endif - - /* Skip initial slashes */ - if (VIR_FILE_IS_DIR_SEPARATOR(path[0])) { - while (VIR_FILE_IS_DIR_SEPARATOR(path[0])) - path++; - - return path; - } - -#ifdef WIN32 - /* Skip X:\ */ - if (c_isalpha(path[0]) && - path[1] == ':' && - VIR_FILE_IS_DIR_SEPARATOR(path[2])) - return path + 3; -#endif - - return path; -} - - - -/* - * Creates an absolute path for a potentially relative path. - * Return 0 if the path was not relative, or on success. - * Return -1 on error. - * - * You must free the result. - */ -int virFileAbsPath(const char *path, char **abspath) -{ - char *buf; - - if (path[0] == '/') { - if (!(*abspath = strdup(path))) - return -1; - } else { - buf = getcwd(NULL, 0); - if (buf == NULL) - return -1; - - if (virAsprintf(abspath, "%s/%s", buf, path) < 0) { - VIR_FREE(buf); - return -1; - } - VIR_FREE(buf); - } - - return 0; -} - -/* Remove spurious / characters from a path. The result must be freed */ -char * -virFileSanitizePath(const char *path) -{ - const char *cur = path; - char *cleanpath; - int idx = 0; - - cleanpath = strdup(path); - if (!cleanpath) { - virReportOOMError(); - return NULL; - } - - /* Need to sanitize: - * // -> // - * /// -> / - * /../foo -> /../foo - * /foo///bar/ -> /foo/bar - */ - - /* Starting with // is valid posix, but ///foo == /foo */ - if (cur[0] == '/' && cur[1] == '/' && cur[2] != '/') { - idx = 2; - cur += 2; - } - - /* Sanitize path in place */ - while (*cur != '\0') { - if (*cur != '/') { - cleanpath[idx++] = *cur++; - continue; - } - - /* Skip all extra / */ - while (*++cur == '/') - continue; - - /* Don't add a trailing / */ - if (idx != 0 && *cur == '\0') - break; - - cleanpath[idx++] = '/'; - } - cleanpath[idx] = '\0'; - - return cleanpath; -} - -/* Like strtol, but produce an "int" result, and check more carefully. - Return 0 upon success; return -1 to indicate failure. - When END_PTR is NULL, the byte after the final valid digit must be NUL. - Otherwise, it's like strtol and lets the caller check any suffix for - validity. This function is careful to return -1 when the string S - represents a number that is not representable as an "int". */ -int -virStrToLong_i(char const *s, char **end_ptr, int base, int *result) -{ - long int val; - char *p; - int err; - - errno = 0; - val = strtol(s, &p, base); /* exempt from syntax-check */ - err = (errno || (!end_ptr && *p) || p == s || (int) val != val); - if (end_ptr) - *end_ptr = p; - if (err) - return -1; - *result = val; - return 0; -} - -/* Just like virStrToLong_i, above, but produce an "unsigned int" value. */ -int -virStrToLong_ui(char const *s, char **end_ptr, int base, unsigned int *result) -{ - unsigned long int val; - char *p; - int err; - - errno = 0; - val = strtoul(s, &p, base); /* exempt from syntax-check */ - err = (errno || (!end_ptr && *p) || p == s || (unsigned int) val != val); - if (end_ptr) - *end_ptr = p; - if (err) - return -1; - *result = val; - return 0; -} - -/* Just like virStrToLong_i, above, but produce a "long" value. */ -int -virStrToLong_l(char const *s, char **end_ptr, int base, long *result) -{ - long int val; - char *p; - int err; - - errno = 0; - val = strtol(s, &p, base); /* exempt from syntax-check */ - err = (errno || (!end_ptr && *p) || p == s); - if (end_ptr) - *end_ptr = p; - if (err) - return -1; - *result = val; - return 0; -} - -/* Just like virStrToLong_i, above, but produce an "unsigned long" value. */ -int -virStrToLong_ul(char const *s, char **end_ptr, int base, unsigned long *result) -{ - unsigned long int val; - char *p; - int err; - - errno = 0; - val = strtoul(s, &p, base); /* exempt from syntax-check */ - err = (errno || (!end_ptr && *p) || p == s); - if (end_ptr) - *end_ptr = p; - if (err) - return -1; - *result = val; - return 0; -} - -/* Just like virStrToLong_i, above, but produce a "long long" value. */ -int -virStrToLong_ll(char const *s, char **end_ptr, int base, long long *result) -{ - long long val; - char *p; - int err; - - errno = 0; - val = strtoll(s, &p, base); /* exempt from syntax-check */ - err = (errno || (!end_ptr && *p) || p == s); - if (end_ptr) - *end_ptr = p; - if (err) - return -1; - *result = val; - return 0; -} - -/* Just like virStrToLong_i, above, but produce an "unsigned long long" value. */ -int -virStrToLong_ull(char const *s, char **end_ptr, int base, unsigned long long *result) -{ - unsigned long long val; - char *p; - int err; - - errno = 0; - val = strtoull(s, &p, base); /* exempt from syntax-check */ - err = (errno || (!end_ptr && *p) || p == s); - if (end_ptr) - *end_ptr = p; - if (err) - return -1; - *result = val; - return 0; -} - -int -virStrToDouble(char const *s, - char **end_ptr, - double *result) -{ - double val; - char *p; - int err; - - errno = 0; - val = strtod(s, &p); /* exempt from syntax-check */ - err = (errno || (!end_ptr && *p) || p == s); - if (end_ptr) - *end_ptr = p; - if (err) - return -1; - *result = val; - return 0; -} - -/* Convert C from hexadecimal character to integer. */ -int -virHexToBin(unsigned char c) -{ - switch (c) { - default: return c - '0'; - case 'a': case 'A': return 10; - case 'b': case 'B': return 11; - case 'c': case 'C': return 12; - case 'd': case 'D': return 13; - case 'e': case 'E': return 14; - case 'f': case 'F': return 15; - } -} - -/* Scale an integer VALUE in-place by an optional case-insensitive - * SUFFIX, defaulting to SCALE if suffix is NULL or empty (scale is - * typically 1 or 1024). Recognized suffixes include 'b' or 'bytes', - * as well as power-of-two scaling via binary abbreviations ('KiB', - * 'MiB', ...) or their one-letter counterpart ('k', 'M', ...), and - * power-of-ten scaling via SI abbreviations ('KB', 'MB', ...). - * Ensure that the result does not exceed LIMIT. Return 0 on success, - * -1 with error message raised on failure. */ -int -virScaleInteger(unsigned long long *value, const char *suffix, - unsigned long long scale, unsigned long long limit) -{ - if (!suffix || !*suffix) { - if (!scale) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("invalid scale %llu"), scale); - return -1; - } - suffix = ""; - } else if (STRCASEEQ(suffix, "b") || STRCASEEQ(suffix, "byte") || - STRCASEEQ(suffix, "bytes")) { - scale = 1; - } else { - int base; - - if (!suffix[1] || STRCASEEQ(suffix + 1, "iB")) { - base = 1024; - } else if (c_tolower(suffix[1]) == 'b' && !suffix[2]) { - base = 1000; - } else { - virReportError(VIR_ERR_INVALID_ARG, - _("unknown suffix '%s'"), suffix); - return -1; - } - scale = 1; - switch (c_tolower(*suffix)) { - case 'e': - scale *= base; - /* fallthrough */ - case 'p': - scale *= base; - /* fallthrough */ - case 't': - scale *= base; - /* fallthrough */ - case 'g': - scale *= base; - /* fallthrough */ - case 'm': - scale *= base; - /* fallthrough */ - case 'k': - scale *= base; - break; - default: - virReportError(VIR_ERR_INVALID_ARG, - _("unknown suffix '%s'"), suffix); - return -1; - } - } - - if (*value && *value >= (limit / scale)) { - virReportError(VIR_ERR_OVERFLOW, _("value too large: %llu%s"), - *value, suffix); - return -1; - } - *value *= scale; - return 0; -} - -/** - * virSkipSpaces: - * @str: pointer to the char pointer used - * - * Skip potential blanks, this includes space tabs, line feed, - * carriage returns. - */ -void -virSkipSpaces(const char **str) -{ - const char *cur = *str; - - while (c_isspace(*cur)) - cur++; - *str = cur; -} - -/** - * virSkipSpacesAndBackslash: - * @str: pointer to the char pointer used - * - * Like virSkipSpaces, but also skip backslashes erroneously emitted - * by xend - */ -void -virSkipSpacesAndBackslash(const char **str) -{ - const char *cur = *str; - - while (c_isspace(*cur) || *cur == '\\') - cur++; - *str = cur; -} - -/** - * virTrimSpaces: - * @str: string to modify to remove all trailing spaces - * @endp: track the end of the string - * - * If @endp is NULL on entry, then all spaces prior to the trailing - * NUL in @str are removed, by writing NUL into the appropriate - * location. If @endp is non-NULL but points to a NULL pointer, - * then all spaces prior to the trailing NUL in @str are removed, - * NUL is written to the new string end, and endp is set to the - * location of the (new) string end. If @endp is non-NULL and - * points to a non-NULL pointer, then that pointer is used as - * the end of the string, endp is set to the (new) location, but - * no NUL pointer is written into the string. - */ -void -virTrimSpaces(char *str, char **endp) -{ - char *end; - - if (!endp || !*endp) - end = str + strlen(str); - else - end = *endp; - while (end > str && c_isspace(end[-1])) - end--; - if (endp) { - if (!*endp) - *end = '\0'; - *endp = end; - } else { - *end = '\0'; - } -} - -/** - * virSkipSpacesBackwards: - * @str: start of string - * @endp: on entry, *endp must be NULL or a location within @str, on exit, - * will be adjusted to skip trailing spaces, or to NULL if @str had nothing - * but spaces. - */ -void -virSkipSpacesBackwards(const char *str, char **endp) -{ - /* Casting away const is safe, since virTrimSpaces does not - * modify string with this particular usage. */ - char *s = (char*) str; - - if (!*endp) - *endp = s + strlen(s); - virTrimSpaces(s, endp); - if (s == *endp) - *endp = NULL; -} - -/** - * virParseNumber: - * @str: pointer to the char pointer used - * - * Parse an unsigned number - * - * Returns the unsigned number or -1 in case of error. @str will be - * updated to skip the number. - */ -int -virParseNumber(const char **str) -{ - int ret = 0; - const char *cur = *str; - - if ((*cur < '0') || (*cur > '9')) - return -1; - - while (c_isdigit(*cur)) { - unsigned int c = *cur - '0'; - - if ((ret > INT_MAX / 10) || - ((ret == INT_MAX / 10) && (c > INT_MAX % 10))) - return -1; - ret = ret * 10 + c; - cur++; - } - *str = cur; - return ret; -} - - -/** - * virParseVersionString: - * @str: const char pointer to the version string - * @version: unsigned long pointer to output the version number - * @allowMissing: true to treat 3 like 3.0.0, false to error out on - * missing minor or micro - * - * Parse an unsigned version number from a version string. Expecting - * 'major.minor.micro' format, ignoring an optional suffix. - * - * The major, minor and micro numbers are encoded into a single version number: - * - * 1000000 * major + 1000 * minor + micro - * - * Returns the 0 for success, -1 for error. - */ -int -virParseVersionString(const char *str, unsigned long *version, - bool allowMissing) -{ - unsigned int major, minor = 0, micro = 0; - char *tmp; - - if (virStrToLong_ui(str, &tmp, 10, &major) < 0) - return -1; - - if (!allowMissing && *tmp != '.') - return -1; - - if ((*tmp == '.') && virStrToLong_ui(tmp + 1, &tmp, 10, &minor) < 0) - return -1; - - if (!allowMissing && *tmp != '.') - return -1; - - if ((*tmp == '.') && virStrToLong_ui(tmp + 1, &tmp, 10, &micro) < 0) - return -1; - - if (major > UINT_MAX / 1000000 || minor > 999 || micro > 999) - return -1; - - *version = 1000000 * major + 1000 * minor + micro; - - return 0; -} - -/** - * virVasprintf - * - * like glibc's vasprintf but makes sure *strp == NULL on failure - */ -int -virVasprintf(char **strp, const char *fmt, va_list list) -{ - int ret; - - if ((ret = vasprintf(strp, fmt, list)) == -1) - *strp = NULL; - - return ret; -} - -/** - * virAsprintf - * - * like glibc's_asprintf but makes sure *strp == NULL on failure - */ -int -virAsprintf(char **strp, const char *fmt, ...) -{ - va_list ap; - int ret; - - va_start(ap, fmt); - ret = virVasprintf(strp, fmt, ap); - va_end(ap); - return ret; -} - -/** - * virStrncpy - * - * A safe version of strncpy. The last parameter is the number of bytes - * available in the destination string, *not* the number of bytes you want - * to copy. If the destination is not large enough to hold all n of the - * src string bytes plus a \0, NULL is returned and no data is copied. - * If the destination is large enough to hold the n bytes plus \0, then the - * string is copied and a pointer to the destination string is returned. - */ -char * -virStrncpy(char *dest, const char *src, size_t n, size_t destbytes) -{ - char *ret; - - if (n > (destbytes - 1)) - return NULL; - - ret = strncpy(dest, src, n); - /* strncpy NULL terminates iff the last character is \0. Therefore - * force the last byte to be \0 - */ - dest[n] = '\0'; - - return ret; -} - -/** - * virStrcpy - * - * A safe version of strcpy. The last parameter is the number of bytes - * available in the destination string, *not* the number of bytes you want - * to copy. If the destination is not large enough to hold all n of the - * src string bytes plus a \0, NULL is returned and no data is copied. - * If the destination is large enough to hold the source plus \0, then the - * string is copied and a pointer to the destination string is returned. - */ -char * -virStrcpy(char *dest, const char *src, size_t destbytes) -{ - return virStrncpy(dest, src, strlen(src), destbytes); -} - -int virEnumFromString(const char *const*types, - unsigned int ntypes, - const char *type) -{ - unsigned int i; - if (!type) - return -1; - - for (i = 0 ; i < ntypes ; i++) - if (STREQ(types[i], type)) - return i; - - return -1; -} - -/* In case thread-safe locales are available */ -#if HAVE_NEWLOCALE - -static locale_t virLocale; - -static int -virLocaleOnceInit(void) -{ - virLocale = newlocale(LC_ALL_MASK, "C", (locale_t)0); - if (!virLocale) - return -1; - return 0; -} - -VIR_ONCE_GLOBAL_INIT(virLocale) -#endif - -/** - * virDoubleToStr - * - * converts double to string with C locale (thread-safe). - * - * Returns -1 on error, size of the string otherwise. - */ -int -virDoubleToStr(char **strp, double number) -{ - int ret = -1; - -#if HAVE_NEWLOCALE - - locale_t old_loc; - - if (virLocaleInitialize() < 0) - goto error; - - old_loc = uselocale(virLocale); - ret = virAsprintf(strp, "%lf", number); - uselocale(old_loc); - -#else - - char *radix, *tmp; - struct lconv *lc; - - if ((ret = virAsprintf(strp, "%lf", number) < 0)) - goto error; - - lc = localeconv(); - radix = lc->decimal_point; - tmp = strstr(*strp, radix); - if (tmp) { - *tmp = '.'; - if (strlen(radix) > 1) - memmove(tmp + 1, tmp + strlen(radix), strlen(*strp) - (tmp - *strp)); - } - -#endif /* HAVE_NEWLOCALE */ - error: - return ret; -} - - -/** - * Format @val as a base-10 decimal number, in the - * buffer @buf of size @buflen. To allocate a suitable - * sized buffer, the INT_BUFLEN(int) macro should be - * used - * - * Returns pointer to start of the number in @buf - */ -char * -virFormatIntDecimal(char *buf, size_t buflen, int val) -{ - char *p = buf + buflen - 1; - *p = '\0'; - if (val >= 0) { - do { - *--p = '0' + (val % 10); - val /= 10; - } while (val != 0); - } else { - do { - *--p = '0' - (val % 10); - val /= 10; - } while (val != 0); - *--p = '-'; - } - return p; -} - - -const char *virEnumToString(const char *const*types, - unsigned int ntypes, - int type) -{ - if (type < 0 || type >= ntypes) - return NULL; - - return types[type]; -} - -/* Translates a device name of the form (regex) /^[fhv]d[a-z]+[0-9]*$/ - * into the corresponding index (e.g. sda => 0, hdz => 25, vdaa => 26) - * Note that any trailing string of digits is simply ignored. - * @param name The name of the device - * @return name's index, or -1 on failure - */ -int virDiskNameToIndex(const char *name) { - const char *ptr = NULL; - int idx = 0; - static char const* const drive_prefix[] = {"fd", "hd", "vd", "sd", "xvd", "ubd"}; - unsigned int i; - - for (i = 0; i < ARRAY_CARDINALITY(drive_prefix); i++) { - if (STRPREFIX(name, drive_prefix[i])) { - ptr = name + strlen(drive_prefix[i]); - break; - } - } - - if (!ptr) - return -1; - - for (i = 0; *ptr; i++) { - if (!c_islower(*ptr)) - break; - - idx = (idx + (i < 1 ? 0 : 1)) * 26; - idx += *ptr - 'a'; - ptr++; - } - - /* Count the trailing digits. */ - size_t n_digits = strspn(ptr, "0123456789"); - if (ptr[n_digits] != '\0') - return -1; - - return idx; -} - -char *virIndexToDiskName(int idx, const char *prefix) -{ - char *name = NULL; - int i, k, offset; - - if (idx < 0) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Disk index %d is negative"), idx); - return NULL; - } - - for (i = 0, k = idx; k >= 0; ++i, k = k / 26 - 1) { } - - offset = strlen(prefix); - - if (VIR_ALLOC_N(name, offset + i + 1)) { - virReportOOMError(); - return NULL; - } - - strcpy(name, prefix); - name[offset + i] = '\0'; - - for (i = i - 1, k = idx; k >= 0; --i, k = k / 26 - 1) { - name[offset + i] = 'a' + (k % 26); - } - - return name; -} - -#ifndef AI_CANONIDN -# define AI_CANONIDN 0 -#endif - -/* Who knew getting a hostname could be so delicate. In Linux (and Unices - * in general), many things depend on "hostname" returning a value that will - * resolve one way or another. In the modern world where networks frequently - * come and go this is often being hard-coded to resolve to "localhost". If - * it *doesn't* resolve to localhost, then we would prefer to have the FQDN. - * That leads us to 3 possibilities: - * - * 1) gethostname() returns an FQDN (not localhost) - we return the string - * as-is, it's all of the information we want - * 2) gethostname() returns "localhost" - we return localhost; doing further - * work to try to resolve it is pointless - * 3) gethostname() returns a shortened hostname - in this case, we want to - * try to resolve this to a fully-qualified name. Therefore we pass it - * to getaddrinfo(). There are two possible responses: - * a) getaddrinfo() resolves to a FQDN - return the FQDN - * b) getaddrinfo() fails or resolves to localhost - in this case, the - * data we got from gethostname() is actually more useful than what - * we got from getaddrinfo(). Return the value from gethostname() - * and hope for the best. - */ -char *virGetHostname(virConnectPtr conn ATTRIBUTE_UNUSED) -{ - int r; - char hostname[HOST_NAME_MAX+1], *result; - struct addrinfo hints, *info; - - r = gethostname(hostname, sizeof(hostname)); - if (r == -1) { - virReportSystemError(errno, - "%s", _("failed to determine host name")); - return NULL; - } - NUL_TERMINATE(hostname); - - if (STRPREFIX(hostname, "localhost") || strchr(hostname, '.')) { - /* in this case, gethostname returned localhost (meaning we can't - * do any further canonicalization), or it returned an FQDN (and - * we don't need to do any further canonicalization). Return the - * string as-is; it's up to callers to check whether "localhost" - * is allowed. - */ - result = strdup(hostname); - goto check_and_return; - } - - /* otherwise, it's a shortened, non-localhost, hostname. Attempt to - * canonicalize the hostname by running it through getaddrinfo - */ - - memset(&hints, 0, sizeof(hints)); - hints.ai_flags = AI_CANONNAME|AI_CANONIDN; - hints.ai_family = AF_UNSPEC; - r = getaddrinfo(hostname, NULL, &hints, &info); - if (r != 0) { - VIR_WARN("getaddrinfo failed for '%s': %s", - hostname, gai_strerror(r)); - result = strdup(hostname); - goto check_and_return; - } - - /* Tell static analyzers about getaddrinfo semantics. */ - sa_assert(info); - - if (info->ai_canonname == NULL || - STRPREFIX(info->ai_canonname, "localhost")) - /* in this case, we tried to canonicalize and we ended up back with - * localhost. Ignore the canonicalized name and just return the - * original hostname - */ - result = strdup(hostname); - else - /* Caller frees this string. */ - result = strdup(info->ai_canonname); - - freeaddrinfo(info); - -check_and_return: - if (result == NULL) - virReportOOMError(); - return result; -} - -#ifdef HAVE_GETPWUID_R -enum { - VIR_USER_ENT_DIRECTORY, - VIR_USER_ENT_NAME, -}; - -static char *virGetUserEnt(uid_t uid, - int field) -{ - char *strbuf; - char *ret; - struct passwd pwbuf; - struct passwd *pw = NULL; - long val = sysconf(_SC_GETPW_R_SIZE_MAX); - size_t strbuflen = val; - int rc; - - /* sysconf is a hint; if it fails, fall back to a reasonable size */ - if (val < 0) - strbuflen = 1024; - - if (VIR_ALLOC_N(strbuf, strbuflen) < 0) { - virReportOOMError(); - return NULL; - } - - /* - * From the manpage (terrifying but true): - * - * ERRORS - * 0 or ENOENT or ESRCH or EBADF or EPERM or ... - * The given name or uid was not found. - */ - while ((rc = getpwuid_r(uid, &pwbuf, strbuf, strbuflen, &pw)) == ERANGE) { - if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0) { - virReportOOMError(); - VIR_FREE(strbuf); - return NULL; - } - } - if (rc != 0 || pw == NULL) { - virReportSystemError(rc, - _("Failed to find user record for uid '%u'"), - (unsigned int) uid); - VIR_FREE(strbuf); - return NULL; - } - - if (field == VIR_USER_ENT_DIRECTORY) - ret = strdup(pw->pw_dir); - else - ret = strdup(pw->pw_name); - - VIR_FREE(strbuf); - if (!ret) - virReportOOMError(); - - return ret; -} - -static char *virGetGroupEnt(gid_t gid) -{ - char *strbuf; - char *ret; - struct group grbuf; - struct group *gr = NULL; - long val = sysconf(_SC_GETGR_R_SIZE_MAX); - size_t strbuflen = val; - int rc; - - /* sysconf is a hint; if it fails, fall back to a reasonable size */ - if (val < 0) - strbuflen = 1024; - - if (VIR_ALLOC_N(strbuf, strbuflen) < 0) { - virReportOOMError(); - return NULL; - } - - /* - * From the manpage (terrifying but true): - * - * ERRORS - * 0 or ENOENT or ESRCH or EBADF or EPERM or ... - * The given name or gid was not found. - */ - while ((rc = getgrgid_r(gid, &grbuf, strbuf, strbuflen, &gr)) == ERANGE) { - if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0) { - virReportOOMError(); - VIR_FREE(strbuf); - return NULL; - } - } - if (rc != 0 || gr == NULL) { - virReportSystemError(rc, - _("Failed to find group record for gid '%u'"), - (unsigned int) gid); - VIR_FREE(strbuf); - return NULL; - } - - ret = strdup(gr->gr_name); - - VIR_FREE(strbuf); - if (!ret) - virReportOOMError(); - - return ret; -} - -char *virGetUserDirectory(void) -{ - return virGetUserEnt(geteuid(), VIR_USER_ENT_DIRECTORY); -} - -static char *virGetXDGDirectory(const char *xdgenvname, const char *xdgdefdir) -{ - const char *path = getenv(xdgenvname); - char *ret = NULL; - char *home = virGetUserEnt(geteuid(), VIR_USER_ENT_DIRECTORY); - - if (path && path[0]) { - if (virAsprintf(&ret, "%s/libvirt", path) < 0) - goto no_memory; - } else { - if (virAsprintf(&ret, "%s/%s/libvirt", home, xdgdefdir) < 0) - goto no_memory; - } - - cleanup: - VIR_FREE(home); - return ret; - no_memory: - virReportOOMError(); - goto cleanup; -} - -char *virGetUserConfigDirectory(void) -{ - return virGetXDGDirectory("XDG_CONFIG_HOME", ".config"); -} - -char *virGetUserCacheDirectory(void) -{ - return virGetXDGDirectory("XDG_CACHE_HOME", ".cache"); -} - -char *virGetUserRuntimeDirectory(void) -{ - const char *path = getenv("XDG_RUNTIME_DIR"); - - if (!path || !path[0]) { - return virGetUserCacheDirectory(); - } else { - char *ret; - - if (virAsprintf(&ret, "%s/libvirt", path) < 0) { - virReportOOMError(); - return NULL; - } - - return ret; - } -} - -char *virGetUserName(uid_t uid) -{ - return virGetUserEnt(uid, VIR_USER_ENT_NAME); -} - -char *virGetGroupName(gid_t gid) -{ - return virGetGroupEnt(gid); -} - -/* Search in the password database for a user id that matches the user name - * `name`. Returns 0 on success, -1 on failure or 1 if name cannot be found. - */ -static int -virGetUserIDByName(const char *name, uid_t *uid) -{ - char *strbuf = NULL; - struct passwd pwbuf; - struct passwd *pw = NULL; - long val = sysconf(_SC_GETPW_R_SIZE_MAX); - size_t strbuflen = val; - int rc; - int ret = -1; - - /* sysconf is a hint; if it fails, fall back to a reasonable size */ - if (val < 0) - strbuflen = 1024; - - if (VIR_ALLOC_N(strbuf, strbuflen) < 0) { - virReportOOMError(); - goto cleanup; - } - - while ((rc = getpwnam_r(name, &pwbuf, strbuf, strbuflen, &pw)) == ERANGE) { - if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0) { - virReportOOMError(); - goto cleanup; - } - } - - if (!pw) { - if (rc != 0) { - char buf[1024]; - /* log the possible error from getpwnam_r. Unfortunately error - * reporting from this function is bad and we can't really - * rely on it, so we just report that the user wasn't found */ - VIR_WARN("User record for user '%s' was not found: %s", - name, virStrerror(rc, buf, sizeof(buf))); - } - - ret = 1; - goto cleanup; - } - - *uid = pw->pw_uid; - ret = 0; - -cleanup: - VIR_FREE(strbuf); - - return ret; -} - -/* Try to match a user id based on `user`. The default behavior is to parse - * `user` first as a user name and then as a user id. However if `user` - * contains a leading '+', the rest of the string is always parsed as a uid. - * - * Returns 0 on success and -1 otherwise. - */ -int -virGetUserID(const char *user, uid_t *uid) -{ - unsigned int uint_uid; - - if (*user == '+') { - user++; - } else { - int rc = virGetUserIDByName(user, uid); - if (rc <= 0) - return rc; - } - - if (virStrToLong_ui(user, NULL, 10, &uint_uid) < 0 || - ((uid_t) uint_uid) != uint_uid) { - virReportError(VIR_ERR_INVALID_ARG, _("Failed to parse user '%s'"), - user); - return -1; - } - - *uid = uint_uid; - - return 0; -} - -/* Search in the group database for a group id that matches the group name - * `name`. Returns 0 on success, -1 on failure or 1 if name cannot be found. - */ -static int -virGetGroupIDByName(const char *name, gid_t *gid) -{ - char *strbuf = NULL; - struct group grbuf; - struct group *gr = NULL; - long val = sysconf(_SC_GETGR_R_SIZE_MAX); - size_t strbuflen = val; - int rc; - int ret = -1; - - /* sysconf is a hint; if it fails, fall back to a reasonable size */ - if (val < 0) - strbuflen = 1024; - - if (VIR_ALLOC_N(strbuf, strbuflen) < 0) { - virReportOOMError(); - goto cleanup; - } - - while ((rc = getgrnam_r(name, &grbuf, strbuf, strbuflen, &gr)) == ERANGE) { - if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0) { - virReportOOMError(); - goto cleanup; - } - } - - if (!gr) { - if (rc != 0) { - char buf[1024]; - /* log the possible error from getgrnam_r. Unfortunately error - * reporting from this function is bad and we can't really - * rely on it, so we just report that the user wasn't found */ - VIR_WARN("Group record for user '%s' was not found: %s", - name, virStrerror(rc, buf, sizeof(buf))); - } - - ret = 1; - goto cleanup; - } - - *gid = gr->gr_gid; - ret = 0; - -cleanup: - VIR_FREE(strbuf); - - return ret; -} - -/* Try to match a group id based on `group`. The default behavior is to parse - * `group` first as a group name and then as a group id. However if `group` - * contains a leading '+', the rest of the string is always parsed as a guid. - * - * Returns 0 on success and -1 otherwise. - */ -int -virGetGroupID(const char *group, gid_t *gid) -{ - unsigned int uint_gid; - - if (*group == '+') { - group++; - } else { - int rc = virGetGroupIDByName(group, gid); - if (rc <= 0) - return rc; - } - - if (virStrToLong_ui(group, NULL, 10, &uint_gid) < 0 || - ((gid_t) uint_gid) != uint_gid) { - virReportError(VIR_ERR_INVALID_ARG, _("Failed to parse group '%s'"), - group); - return -1; - } - - *gid = uint_gid; - - return 0; -} - -/* Set the real and effective uid and gid to the given values, and call - * initgroups so that the process has all the assumed group membership of - * that uid. return 0 on success, -1 on failure (the original system error - * remains in errno). - */ -int -virSetUIDGID(uid_t uid, gid_t gid) -{ - int err; - char *buf = NULL; - - if (gid > 0) { - if (setregid(gid, gid) < 0) { - virReportSystemError(err = errno, - _("cannot change to '%d' group"), - (unsigned int) gid); - goto error; - } - } - - if (uid > 0) { -# ifdef HAVE_INITGROUPS - struct passwd pwd, *pwd_result; - size_t bufsize; - int rc; - - bufsize = sysconf(_SC_GETPW_R_SIZE_MAX); - if (bufsize == -1) - bufsize = 16384; - - if (VIR_ALLOC_N(buf, bufsize) < 0) { - virReportOOMError(); - err = ENOMEM; - goto error; - } - while ((rc = getpwuid_r(uid, &pwd, buf, bufsize, - &pwd_result)) == ERANGE) { - if (VIR_RESIZE_N(buf, bufsize, bufsize, bufsize) < 0) { - virReportOOMError(); - err = ENOMEM; - goto error; - } - } - - if (rc) { - virReportSystemError(err = rc, _("cannot getpwuid_r(%d)"), - (unsigned int) uid); - goto error; - } - - if (!pwd_result) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("getpwuid_r failed to retrieve data " - "for uid '%d'"), - (unsigned int) uid); - err = EINVAL; - goto error; - } - - if (initgroups(pwd.pw_name, pwd.pw_gid) < 0) { - virReportSystemError(err = errno, - _("cannot initgroups(\"%s\", %d)"), - pwd.pw_name, (unsigned int) pwd.pw_gid); - goto error; - } -# endif - if (setreuid(uid, uid) < 0) { - virReportSystemError(err = errno, - _("cannot change to uid to '%d'"), - (unsigned int) uid); - goto error; - } - } - - VIR_FREE(buf); - return 0; - -error: - VIR_FREE(buf); - errno = err; - return -1; -} - -#else /* ! HAVE_GETPWUID_R */ - -# ifdef WIN32 -/* These methods are adapted from GLib2 under terms of LGPLv2+ */ -static int -virGetWin32SpecialFolder(int csidl, char **path) -{ - char buf[MAX_PATH+1]; - LPITEMIDLIST pidl = NULL; - int ret = 0; - - *path = NULL; - - if (SHGetSpecialFolderLocation(NULL, csidl, &pidl) == S_OK) { - if (SHGetPathFromIDList(pidl, buf)) { - if (!(*path = strdup(buf))) { - virReportOOMError(); - ret = -1; - } - } - CoTaskMemFree(pidl); - } - return ret; -} - -static int -virGetWin32DirectoryRoot(char **path) -{ - char windowsdir[MAX_PATH]; - int ret = 0; - - *path = NULL; - - if (GetWindowsDirectory(windowsdir, ARRAY_CARDINALITY(windowsdir))) - { - const char *tmp; - /* Usually X:\Windows, but in terminal server environments - * might be an UNC path, AFAIK. - */ - tmp = virFileSkipRoot(windowsdir); - if (VIR_FILE_IS_DIR_SEPARATOR(tmp[-1]) && - tmp[-2] != ':') - tmp--; - - windowsdir[tmp - windowsdir] = '\0'; - } else { - strcpy(windowsdir, "C:\\"); - } - - if (!(*path = strdup(windowsdir))) { - virReportOOMError(); - ret = -1; - } - - return ret; -} - - - -char * -virGetUserDirectory(void) -{ - const char *dir; - char *ret; - - dir = getenv("HOME"); - - /* Only believe HOME if it is an absolute path and exists */ - if (dir) { - if (!virFileIsAbsPath(dir) || - !virFileExists(dir)) - dir = NULL; - } - - /* In case HOME is Unix-style (it happens), convert it to - * Windows style. - */ - if (dir) { - char *p; - while ((p = strchr(dir, '/')) != NULL) - *p = '\\'; - } - - if (!dir) - /* USERPROFILE is probably the closest equivalent to $HOME? */ - dir = getenv("USERPROFILE"); - - if (dir) { - if (!(ret = strdup(dir))) { - virReportOOMError(); - return NULL; - } - } - - if (!ret && - virGetWin32SpecialFolder(CSIDL_PROFILE, &ret) < 0) - return NULL; - - if (!ret && - virGetWin32DirectoryRoot(&ret) < 0) - return NULL; - - if (!ret) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("Unable to determine home directory")); - return NULL; - } - - return ret; -} - -char * -virGetUserConfigDirectory(void) -{ - char *ret; - if (virGetWin32SpecialFolder(CSIDL_LOCAL_APPDATA, &ret) < 0) - return NULL; - - if (!ret) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("Unable to determine config directory")); - return NULL; - } - return ret; -} - -char * -virGetUserCacheDirectory(void) -{ - char *ret; - if (virGetWin32SpecialFolder(CSIDL_INTERNET_CACHE, &ret) < 0) - return NULL; - - if (!ret) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("Unable to determine config directory")); - return NULL; - } - return ret; -} - -char * -virGetUserRuntimeDirectory(void) -{ - return virGetUserCacheDirectory(); -} -# else /* !HAVE_GETPWUID_R && !WIN32 */ -char * -virGetUserDirectory(void) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virGetUserDirectory is not available")); - - return NULL; -} - -char * -virGetUserConfigDirectory(void) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virGetUserConfigDirectory is not available")); - - return NULL; -} - -char * -virGetUserCacheDirectory(void) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virGetUserCacheDirectory is not available")); - - return NULL; -} - -char * -virGetUserRuntimeDirectory(void) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virGetUserRuntimeDirectory is not available")); - - return NULL; -} -# endif /* ! HAVE_GETPWUID_R && ! WIN32 */ - -char * -virGetUserName(uid_t uid ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virGetUserName is not available")); - - return NULL; -} - -int virGetUserID(const char *name ATTRIBUTE_UNUSED, - uid_t *uid ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virGetUserID is not available")); - - return 0; -} - - -int virGetGroupID(const char *name ATTRIBUTE_UNUSED, - gid_t *gid ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virGetGroupID is not available")); - - return 0; -} - -int -virSetUIDGID(uid_t uid ATTRIBUTE_UNUSED, - gid_t gid ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virSetUIDGID is not available")); - return -1; -} - -char * -virGetGroupName(gid_t gid ATTRIBUTE_UNUSED) -{ - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("virGetGroupName is not available")); - - return NULL; -} -#endif /* HAVE_GETPWUID_R */ - - -#if defined HAVE_MNTENT_H && defined HAVE_GETMNTENT_R -/* search /proc/mounts for mount point of *type; return pointer to - * malloc'ed string of the path if found, otherwise return NULL - * with errno set to an appropriate value. - */ -char *virFileFindMountPoint(const char *type) -{ - FILE *f; - struct mntent mb; - char mntbuf[1024]; - char *ret = NULL; - - f = setmntent("/proc/mounts", "r"); - if (!f) - return NULL; - - while (getmntent_r(f, &mb, mntbuf, sizeof(mntbuf))) { - if (STREQ(mb.mnt_type, type)) { - ret = strdup(mb.mnt_dir); - goto cleanup; - } - } - - if (!ret) - errno = ENOENT; - -cleanup: - endmntent(f); - - return ret; -} - -#else /* defined HAVE_MNTENT_H && defined HAVE_GETMNTENT_R */ - -char * -virFileFindMountPoint(const char *type ATTRIBUTE_UNUSED) -{ - errno = ENOSYS; - - return NULL; -} - -#endif /* defined HAVE_MNTENT_H && defined HAVE_GETMNTENT_R */ - -#if defined(UDEVADM) || defined(UDEVSETTLE) -void virFileWaitForDevices(void) -{ -# ifdef UDEVADM - const char *const settleprog[] = { UDEVADM, "settle", NULL }; -# else - const char *const settleprog[] = { UDEVSETTLE, NULL }; -# endif - int exitstatus; - - if (access(settleprog[0], X_OK) != 0) - return; - - /* - * NOTE: we ignore errors here; this is just to make sure that any device - * nodes that are being created finish before we try to scan them. - * If this fails for any reason, we still have the backup of polling for - * 5 seconds for device nodes. - */ - if (virRun(settleprog, &exitstatus) < 0) - {} -} -#else -void virFileWaitForDevices(void) {} -#endif - -int virBuildPathInternal(char **path, ...) -{ - char *path_component = NULL; - virBuffer buf = VIR_BUFFER_INITIALIZER; - va_list ap; - int ret = 0; - - va_start(ap, path); - - path_component = va_arg(ap, char *); - virBufferAdd(&buf, path_component, -1); - - while ((path_component = va_arg(ap, char *)) != NULL) - { - virBufferAddChar(&buf, '/'); - virBufferAdd(&buf, path_component, -1); - } - - va_end(ap); - - *path = virBufferContentAndReset(&buf); - if (*path == NULL) { - ret = -1; - } - - return ret; -} - -#if HAVE_LIBDEVMAPPER_H -bool -virIsDevMapperDevice(const char *dev_name) -{ - struct stat buf; - - if (!stat(dev_name, &buf) && - S_ISBLK(buf.st_mode) && - dm_is_dm_major(major(buf.st_rdev))) - return true; - - return false; -} -#else -bool virIsDevMapperDevice(const char *dev_name ATTRIBUTE_UNUSED) -{ - return false; -} -#endif - -bool -virValidateWWN(const char *wwn) { - int i; - - for (i = 0; wwn[i]; i++) - if (!c_isxdigit(wwn[i])) - break; - - if (i != 16 || wwn[i]) { - virReportError(VIR_ERR_INTERNAL_ERROR, "%s", - _("Malformed wwn: %s")); - return false; - } - - return true; -} - -bool -virStrIsPrint(const char *str) -{ - int i; - - for (i = 0; str[i]; i++) - if (!c_isprint(str[i])) - return false; - - return true; -} diff --git a/src/util/util.h b/src/util/util.h deleted file mode 100644 index 6d5dd03..0000000 --- a/src/util/util.h +++ /dev/null @@ -1,284 +0,0 @@ -/* - * utils.h: common, generic utility functions - * - * Copyright (C) 2010-2012 Red Hat, Inc. - * Copyright (C) 2006, 2007 Binary Karma - * Copyright (C) 2006 Shuveb Hussain - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * File created Jul 18, 2007 - Shuveb Hussain <shuveb(a)binarykarma.com&gt; - */ - -#ifndef __VIR_UTIL_H__ -# define __VIR_UTIL_H__ - -# include "verify.h" -# include "internal.h" -# include <unistd.h> -# include <sys/select.h> -# include <sys/types.h> -# include <stdarg.h> - -# ifndef MIN -# define MIN(a, b) ((a) < (b) ? (a) : (b)) -# endif -# ifndef MAX -# define MAX(a, b) ((a) > (b) ? (a) : (b)) -# endif - -ssize_t saferead(int fd, void *buf, size_t count) ATTRIBUTE_RETURN_CHECK; -ssize_t safewrite(int fd, const void *buf, size_t count) - ATTRIBUTE_RETURN_CHECK; -int safezero(int fd, off_t offset, off_t len) - ATTRIBUTE_RETURN_CHECK; - -int virSetBlocking(int fd, bool blocking) ATTRIBUTE_RETURN_CHECK; -int virSetNonBlock(int fd) ATTRIBUTE_RETURN_CHECK; -int virSetInherit(int fd, bool inherit) ATTRIBUTE_RETURN_CHECK; -int virSetCloseExec(int fd) ATTRIBUTE_RETURN_CHECK; - -int virPipeReadUntilEOF(int outfd, int errfd, - char **outbuf, char **errbuf); - -int virSetUIDGID(uid_t uid, gid_t gid); - -int virFileReadLimFD(int fd, int maxlen, char **buf) ATTRIBUTE_RETURN_CHECK; - -int virFileReadAll(const char *path, int maxlen, char **buf) ATTRIBUTE_RETURN_CHECK; - -int virFileWriteStr(const char *path, const char *str, mode_t mode) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK; - -int virFileMatchesNameSuffix(const char *file, - const char *name, - const char *suffix); - -int virFileHasSuffix(const char *str, - const char *suffix); - -int virFileStripSuffix(char *str, - const char *suffix) ATTRIBUTE_RETURN_CHECK; - -int virFileLinkPointsTo(const char *checkLink, - const char *checkDest); - -int virFileResolveLink(const char *linkpath, - char **resultpath) ATTRIBUTE_RETURN_CHECK; -int virFileResolveAllLinks(const char *linkpath, - char **resultpath) ATTRIBUTE_RETURN_CHECK; - -int virFileIsLink(const char *linkpath) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; - -char *virFindFileInPath(const char *file); - -bool virFileIsDir (const char *file) ATTRIBUTE_NONNULL(1); -bool virFileExists(const char *file) ATTRIBUTE_NONNULL(1); -bool virFileIsExecutable(const char *file) ATTRIBUTE_NONNULL(1); - -char *virFileSanitizePath(const char *path); - -enum { - VIR_FILE_OPEN_NONE = 0, - VIR_FILE_OPEN_NOFORK = (1 << 0), - VIR_FILE_OPEN_FORK = (1 << 1), - VIR_FILE_OPEN_FORCE_MODE = (1 << 2), - VIR_FILE_OPEN_FORCE_OWNER = (1 << 3), -}; -int virFileAccessibleAs(const char *path, int mode, - uid_t uid, gid_t gid) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; -int virFileOpenAs(const char *path, int openflags, mode_t mode, - uid_t uid, gid_t gid, - unsigned int flags) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; - -enum { - VIR_DIR_CREATE_NONE = 0, - VIR_DIR_CREATE_AS_UID = (1 << 0), - VIR_DIR_CREATE_FORCE_PERMS = (1 << 1), - VIR_DIR_CREATE_ALLOW_EXIST = (1 << 2), -}; -int virDirCreate(const char *path, mode_t mode, uid_t uid, gid_t gid, - unsigned int flags) ATTRIBUTE_RETURN_CHECK; -int virFileMakePath(const char *path) ATTRIBUTE_RETURN_CHECK; -int virFileMakePathWithMode(const char *path, - mode_t mode) ATTRIBUTE_RETURN_CHECK; - -char *virFileBuildPath(const char *dir, - const char *name, - const char *ext) ATTRIBUTE_RETURN_CHECK; - - -# ifdef WIN32 -/* On Win32, the canonical directory separator is the backslash, and - * the search path separator is the semicolon. Note that also the - * (forward) slash works as directory separator. - */ -# define VIR_FILE_DIR_SEPARATOR '\\' -# define VIR_FILE_DIR_SEPARATOR_S "\\" -# define VIR_FILE_IS_DIR_SEPARATOR(c) ((c) == VIR_FILE_DIR_SEPARATOR || (c) == '/') -# define VIR_FILE_PATH_SEPARATOR ';' -# define VIR_FILE_PATH_SEPARATOR_S ";" - -# else /* !WIN32 */ - -# define VIR_FILE_DIR_SEPARATOR '/' -# define VIR_FILE_DIR_SEPARATOR_S "/" -# define VIR_FILE_IS_DIR_SEPARATOR(c) ((c) == VIR_FILE_DIR_SEPARATOR) -# define VIR_FILE_PATH_SEPARATOR ':' -# define VIR_FILE_PATH_SEPARATOR_S ":" - -# endif /* !WIN32 */ - -bool virFileIsAbsPath(const char *path); -int virFileAbsPath(const char *path, - char **abspath) ATTRIBUTE_RETURN_CHECK; -const char *virFileSkipRoot(const char *path); - -int virFileOpenTty(int *ttymaster, - char **ttyName, - int rawmode); - -char *virArgvToString(const char *const *argv); - -int virStrToLong_i(char const *s, - char **end_ptr, - int base, - int *result); - -int virStrToLong_ui(char const *s, - char **end_ptr, - int base, - unsigned int *result); -int virStrToLong_l(char const *s, - char **end_ptr, - int base, - long *result); -int virStrToLong_ul(char const *s, - char **end_ptr, - int base, - unsigned long *result); -int virStrToLong_ll(char const *s, - char **end_ptr, - int base, - long long *result); -int virStrToLong_ull(char const *s, - char **end_ptr, - int base, - unsigned long long *result); -int virStrToDouble(char const *s, - char **end_ptr, - double *result); - -int virScaleInteger(unsigned long long *value, const char *suffix, - unsigned long long scale, unsigned long long limit) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; - -int virHexToBin(unsigned char c); - -void virSkipSpaces(const char **str) ATTRIBUTE_NONNULL(1); -void virSkipSpacesAndBackslash(const char **str) ATTRIBUTE_NONNULL(1); -void virTrimSpaces(char *str, char **endp) ATTRIBUTE_NONNULL(1); -void virSkipSpacesBackwards(const char *str, char **endp) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2); - -int virParseNumber(const char **str); -int virParseVersionString(const char *str, unsigned long *version, - bool allowMissing); -int virAsprintf(char **strp, const char *fmt, ...) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_FMT_PRINTF(2, 3); -int virVasprintf(char **strp, const char *fmt, va_list list) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_FMT_PRINTF(2, 0); -char *virStrncpy(char *dest, const char *src, size_t n, size_t destbytes) - ATTRIBUTE_RETURN_CHECK; -char *virStrcpy(char *dest, const char *src, size_t destbytes) - ATTRIBUTE_RETURN_CHECK; -# define virStrcpyStatic(dest, src) virStrcpy((dest), (src), sizeof(dest)) - -int virDoubleToStr(char **strp, double number) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; - -char *virFormatIntDecimal(char *buf, size_t buflen, int val) - ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; - -int virDiskNameToIndex(const char* str); -char *virIndexToDiskName(int idx, const char *prefix); - -int virEnumFromString(const char *const*types, - unsigned int ntypes, - const char *type); - -const char *virEnumToString(const char *const*types, - unsigned int ntypes, - int type); - -# define VIR_ENUM_IMPL(name, lastVal, ...) \ - static const char *const name ## TypeList[] = { __VA_ARGS__ }; \ - verify(ARRAY_CARDINALITY(name ## TypeList) == lastVal); \ - const char *name ## TypeToString(int type) { \ - return virEnumToString(name ## TypeList, \ - ARRAY_CARDINALITY(name ## TypeList), \ - type); \ - } \ - int name ## TypeFromString(const char *type) { \ - return virEnumFromString(name ## TypeList, \ - ARRAY_CARDINALITY(name ## TypeList), \ - type); \ - } - -# define VIR_ENUM_DECL(name) \ - const char *name ## TypeToString(int type); \ - int name ## TypeFromString(const char*type); - -# ifndef HAVE_GETUID -static inline int getuid (void) { return 0; } -# endif - -# ifndef HAVE_GETEUID -static inline int geteuid (void) { return 0; } -# endif - -# ifndef HAVE_GETGID -static inline int getgid (void) { return 0; } -# endif - -char *virGetHostname(virConnectPtr conn); - -char *virGetUserDirectory(void); -char *virGetUserConfigDirectory(void); -char *virGetUserCacheDirectory(void); -char *virGetUserRuntimeDirectory(void); -char *virGetUserName(uid_t uid); -char *virGetGroupName(gid_t gid); -int virGetUserID(const char *name, - uid_t *uid) ATTRIBUTE_RETURN_CHECK; -int virGetGroupID(const char *name, - gid_t *gid) ATTRIBUTE_RETURN_CHECK; - -char *virFileFindMountPoint(const char *type); - -void virFileWaitForDevices(void); - -# define virBuildPath(path, ...) virBuildPathInternal(path, __VA_ARGS__, NULL) -int virBuildPathInternal(char **path, ...) ATTRIBUTE_SENTINEL; - -bool virIsDevMapperDevice(const char *dev_name) ATTRIBUTE_NONNULL(1); - -bool virValidateWWN(const char *wwn); - -bool virStrIsPrint(const char *str); -#endif /* __VIR_UTIL_H__ */ diff --git a/src/util/uuid.c b/src/util/uuid.c index 5232ba9..57cfaa6 100644 --- a/src/util/uuid.c +++ b/src/util/uuid.c @@ -35,7 +35,7 @@ #include "c-ctype.h" #include "internal.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "virlog.h" #include "viralloc.h" diff --git a/src/util/viraudit.c b/src/util/viraudit.c index a807b76..05189d5 100644 --- a/src/util/viraudit.c +++ b/src/util/viraudit.c @@ -30,7 +30,7 @@ #include "virterror_internal.h" #include "virlog.h" #include "viraudit.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "viralloc.h" diff --git a/src/util/virauth.c b/src/util/virauth.c index c4c5676..cbb16ec 100644 --- a/src/util/virauth.c +++ b/src/util/virauth.c @@ -25,7 +25,7 @@ #include <stdlib.h> #include "virauth.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "datatypes.h" diff --git a/src/util/virauthconfig.c b/src/util/virauthconfig.c index a0f0be5..d60f7bf 100644 --- a/src/util/virauthconfig.c +++ b/src/util/virauthconfig.c @@ -26,7 +26,7 @@ #include "virkeyfile.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "virterror_internal.h" diff --git a/src/util/virbitmap.c b/src/util/virbitmap.c index cb9606b..b4ba3ef 100644 --- a/src/util/virbitmap.c +++ b/src/util/virbitmap.c @@ -33,7 +33,7 @@ #include "virbitmap.h" #include "viralloc.h" #include "virbuffer.h" -#include "util.h" +#include "virutil.h" #include "c-ctype.h" #include "count-one-bits.h" diff --git a/src/util/vircgroup.c b/src/util/vircgroup.c index 5c628cc..48cba93 100644 --- a/src/util/vircgroup.c +++ b/src/util/vircgroup.c @@ -38,7 +38,7 @@ #include <dirent.h> #include "internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "vircgroup.h" #include "virlog.h" diff --git a/src/util/vircommand.c b/src/util/vircommand.c index 6e17a8d..d059586 100644 --- a/src/util/vircommand.c +++ b/src/util/vircommand.c @@ -36,7 +36,7 @@ #include "vircommand.h" #include "viralloc.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "virfile.h" #include "virpidfile.h" diff --git a/src/util/vircommand.h b/src/util/vircommand.h index 4c88165..9b7117d 100644 --- a/src/util/vircommand.h +++ b/src/util/vircommand.h @@ -23,7 +23,7 @@ # define __VIR_COMMAND_H__ # include "internal.h" -# include "util.h" +# include "virutil.h" # include "virbuffer.h" typedef struct _virCommand virCommand; diff --git a/src/util/virconf.c b/src/util/virconf.c index 2f6d60e..7e4c8c1 100644 --- a/src/util/virconf.c +++ b/src/util/virconf.c @@ -33,7 +33,7 @@ #include "virterror_internal.h" #include "virbuffer.h" #include "virconf.h" -#include "util.h" +#include "virutil.h" #include "c-ctype.h" #include "virlog.h" #include "viralloc.h" diff --git a/src/util/virdnsmasq.c b/src/util/virdnsmasq.c index 918610a..6b9abd9 100644 --- a/src/util/virdnsmasq.c +++ b/src/util/virdnsmasq.c @@ -41,7 +41,7 @@ #include "datatypes.h" #include "virbitmap.h" #include "virdnsmasq.h" -#include "util.h" +#include "virutil.h" #include "vircommand.h" #include "viralloc.h" #include "virterror_internal.h" diff --git a/src/util/vireventpoll.c b/src/util/vireventpoll.c index 1180fda..afb0e05 100644 --- a/src/util/vireventpoll.c +++ b/src/util/vireventpoll.c @@ -35,7 +35,7 @@ #include "virlog.h" #include "vireventpoll.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "virterror_internal.h" #include "virtime.h" diff --git a/src/util/virhooks.c b/src/util/virhooks.c index ad3a371..54a869a 100644 --- a/src/util/virhooks.c +++ b/src/util/virhooks.c @@ -32,7 +32,7 @@ #include "virterror_internal.h" #include "virhooks.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "viralloc.h" #include "virfile.h" diff --git a/src/util/virhooks.h b/src/util/virhooks.h index 0ca376f..56573df 100644 --- a/src/util/virhooks.h +++ b/src/util/virhooks.h @@ -25,7 +25,7 @@ # define __VIR_HOOKS_H__ # include "internal.h" -# include "util.h" +# include "virutil.h" enum virHookDriverType { VIR_HOOK_DRIVER_DAEMON = 0, /* Daemon related events */ diff --git a/src/util/virinitctl.c b/src/util/virinitctl.c index 91a948f..f8ac673 100644 --- a/src/util/virinitctl.c +++ b/src/util/virinitctl.c @@ -29,7 +29,7 @@ #include "internal.h" #include "virinitctl.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virfile.h" diff --git a/src/util/virjson.c b/src/util/virjson.c index 4fa5363..4c9797c 100644 --- a/src/util/virjson.c +++ b/src/util/virjson.c @@ -27,7 +27,7 @@ #include "viralloc.h" #include "virterror_internal.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #if HAVE_YAJL # include <yajl/yajl_gen.h> diff --git a/src/util/virkeycode.h b/src/util/virkeycode.h index 1522f77..a2e1391 100644 --- a/src/util/virkeycode.h +++ b/src/util/virkeycode.h @@ -22,7 +22,7 @@ #ifndef __VIR_UTIL_VIRTKEYCODE_H__ # define __VIR_UTIL_VIRTKEYCODE_H__ -# include "util.h" +# include "virutil.h" # include "libvirt/libvirt.h" VIR_ENUM_DECL(virKeycodeSet); diff --git a/src/util/virkeyfile.c b/src/util/virkeyfile.c index fc61cf5..99e5cd7 100644 --- a/src/util/virkeyfile.c +++ b/src/util/virkeyfile.c @@ -28,7 +28,7 @@ #include "c-ctype.h" #include "virlog.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virhash.h" #include "virkeyfile.h" #include "virterror_internal.h" diff --git a/src/util/virlockspace.c b/src/util/virlockspace.c index 961e171..81a1d81 100644 --- a/src/util/virlockspace.c +++ b/src/util/virlockspace.c @@ -25,7 +25,7 @@ #include "virlog.h" #include "viralloc.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "virhash.h" #include "virthread.h" diff --git a/src/util/virlog.c b/src/util/virlog.c index 0c6c13a..43a59b4 100644 --- a/src/util/virlog.c +++ b/src/util/virlog.c @@ -43,7 +43,7 @@ #include "virterror_internal.h" #include "virlog.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virbuffer.h" #include "virthread.h" #include "virfile.h" diff --git a/src/util/virnetdevbridge.c b/src/util/virnetdevbridge.c index eb341a2..4de88e3 100644 --- a/src/util/virnetdevbridge.c +++ b/src/util/virnetdevbridge.c @@ -24,7 +24,7 @@ #include "virnetdevbridge.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "viralloc.h" #include "intprops.h" diff --git a/src/util/virnetdevmacvlan.c b/src/util/virnetdevmacvlan.c index 0f7107b..953d76b 100644 --- a/src/util/virnetdevmacvlan.c +++ b/src/util/virnetdevmacvlan.c @@ -29,7 +29,7 @@ #include "virnetdevmacvlan.h" #include "virmacaddr.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #define VIR_FROM_THIS VIR_FROM_NET diff --git a/src/util/virnetdevopenvswitch.h b/src/util/virnetdevopenvswitch.h index 147cd6f..3216ea0 100644 --- a/src/util/virnetdevopenvswitch.h +++ b/src/util/virnetdevopenvswitch.h @@ -25,7 +25,7 @@ # define __VIR_NETDEV_OPENVSWITCH_H__ # include "internal.h" -# include "util.h" +# include "virutil.h" # include "virnetdevvportprofile.h" # include "virnetdevvlan.h" diff --git a/src/util/virnetdevtap.c b/src/util/virnetdevtap.c index 339d636..3565bbd 100644 --- a/src/util/virnetdevtap.c +++ b/src/util/virnetdevtap.c @@ -32,7 +32,7 @@ #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include <sys/ioctl.h> #include <net/if.h> diff --git a/src/util/virnetdevvportprofile.h b/src/util/virnetdevvportprofile.h index c4585a8..cc106b8 100644 --- a/src/util/virnetdevvportprofile.h +++ b/src/util/virnetdevvportprofile.h @@ -25,7 +25,7 @@ # include "internal.h" # include "uuid.h" -# include "util.h" +# include "virutil.h" # include "virmacaddr.h" # define LIBVIRT_IFLA_VF_PORT_PROFILE_MAX 40 diff --git a/src/util/virpidfile.c b/src/util/virpidfile.c index 3b3322b..29097e3 100644 --- a/src/util/virpidfile.c +++ b/src/util/virpidfile.c @@ -30,7 +30,7 @@ #include "virpidfile.h" #include "virfile.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "intprops.h" #include "virlog.h" #include "virterror_internal.h" diff --git a/src/util/virprocess.c b/src/util/virprocess.c index 155e4e2..b276643 100644 --- a/src/util/virprocess.c +++ b/src/util/virprocess.c @@ -31,7 +31,7 @@ #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/src/util/virrandom.c b/src/util/virrandom.c index 1dd96cf..1b6de6b 100644 --- a/src/util/virrandom.c +++ b/src/util/virrandom.c @@ -29,7 +29,7 @@ #include "virrandom.h" #include "virthread.h" #include "count-one-bits.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "virlog.h" diff --git a/src/util/virsexpr.c b/src/util/virsexpr.c index 80c24c4..8b70404 100644 --- a/src/util/virsexpr.c +++ b/src/util/virsexpr.c @@ -19,7 +19,7 @@ #include "virterror_internal.h" #include "virsexpr.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #define VIR_FROM_THIS VIR_FROM_SEXPR diff --git a/src/util/virsocketaddr.c b/src/util/virsocketaddr.c index 488ff4b..0f2f23d 100644 --- a/src/util/virsocketaddr.c +++ b/src/util/virsocketaddr.c @@ -25,7 +25,7 @@ #include "virsocketaddr.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #include <netdb.h> diff --git a/src/util/virstatslinux.c b/src/util/virstatslinux.c index 9359db9..135df75 100644 --- a/src/util/virstatslinux.c +++ b/src/util/virstatslinux.c @@ -34,7 +34,7 @@ # include "virterror_internal.h" # include "datatypes.h" -# include "util.h" +# include "virutil.h" # include "virstatslinux.h" # include "viralloc.h" # include "virfile.h" diff --git a/src/util/virstoragefile.h b/src/util/virstoragefile.h index 6fbd275..abf319a 100644 --- a/src/util/virstoragefile.h +++ b/src/util/virstoragefile.h @@ -24,7 +24,7 @@ #ifndef __VIR_STORAGE_FILE_H__ # define __VIR_STORAGE_FILE_H__ -# include "util.h" +# include "virutil.h" enum virStorageFileFormat { VIR_STORAGE_FILE_AUTO_SAFE = -2, diff --git a/src/util/virsysinfo.c b/src/util/virsysinfo.c index 13d3c22..88e4f5c 100644 --- a/src/util/virsysinfo.c +++ b/src/util/virsysinfo.c @@ -32,7 +32,7 @@ #include "virterror_internal.h" #include "virsysinfo.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "viralloc.h" #include "vircommand.h" diff --git a/src/util/virsysinfo.h b/src/util/virsysinfo.h index 0b1f000..dded51b 100644 --- a/src/util/virsysinfo.h +++ b/src/util/virsysinfo.h @@ -25,7 +25,7 @@ # define __VIR_SYSINFOS_H__ # include "internal.h" -# include "util.h" +# include "virutil.h" # include "virbuffer.h" enum virSysinfoType { diff --git a/src/util/virterror.c b/src/util/virterror.c index 6c773d3..a586738 100644 --- a/src/util/virterror.c +++ b/src/util/virterror.c @@ -32,7 +32,7 @@ #include "virlog.h" #include "viralloc.h" #include "virthread.h" -#include "util.h" +#include "virutil.h" virThreadLocal virLastErr; diff --git a/src/util/virtime.c b/src/util/virtime.c index f9fc282..c614380 100644 --- a/src/util/virtime.c +++ b/src/util/virtime.c @@ -37,7 +37,7 @@ #include <sys/time.h> #include "virtime.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virterror_internal.h" diff --git a/src/util/virtypedparam.c b/src/util/virtypedparam.c index e08530e..60fb485 100644 --- a/src/util/virtypedparam.c +++ b/src/util/virtypedparam.c @@ -25,7 +25,7 @@ #include <stdarg.h> #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #define VIR_FROM_THIS VIR_FROM_NONE diff --git a/src/util/viruri.c b/src/util/viruri.c index f48079d..e59cd5a 100644 --- a/src/util/viruri.c +++ b/src/util/viruri.c @@ -23,7 +23,7 @@ #include "viruri.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "virbuffer.h" diff --git a/src/util/virusb.c b/src/util/virusb.c index 9786e86..c053c44 100644 --- a/src/util/virusb.c +++ b/src/util/virusb.c @@ -34,7 +34,7 @@ #include "virusb.h" #include "virlog.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #define USB_SYSFS "/sys/bus/usb" diff --git a/src/util/virutil.c b/src/util/virutil.c new file mode 100644 index 0000000..9fb1c6f --- /dev/null +++ b/src/util/virutil.c @@ -0,0 +1,3131 @@ +/* + * utils.c: common, generic utility functions + * + * Copyright (C) 2006-2012 Red Hat, Inc. + * Copyright (C) 2006 Daniel P. Berrange + * Copyright (C) 2006, 2007 Binary Karma + * Copyright (C) 2006 Shuveb Hussain + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Author: Daniel P. Berrange <berrange(a)redhat.com&gt; + * File created Jul 18, 2007 - Shuveb Hussain <shuveb(a)binarykarma.com&gt; + */ + +#include <config.h> + +#include <stdio.h> +#include <stdarg.h> +#include <stdlib.h> +#include <unistd.h> +#include <fcntl.h> +#include <errno.h> +#include <poll.h> +#include <sys/stat.h> +#include <sys/types.h> +#include <sys/ioctl.h> +#include <sys/wait.h> +#if HAVE_MMAP +# include <sys/mman.h> +#endif +#include <string.h> +#include <signal.h> +#include <termios.h> +#include <pty.h> +#include <locale.h> + +#if HAVE_LIBDEVMAPPER_H +# include <libdevmapper.h> +#endif + +#ifdef HAVE_PATHS_H +# include <paths.h> +#endif +#include <netdb.h> +#ifdef HAVE_GETPWUID_R +# include <pwd.h> +# include <grp.h> +#endif +#if HAVE_CAPNG +# include <cap-ng.h> +#endif +#if defined HAVE_MNTENT_H && defined HAVE_GETMNTENT_R +# include <mntent.h> +#endif + +#ifdef WIN32 +# ifdef HAVE_WINSOCK2_H +# include <winsock2.h> +# endif +# include <windows.h> +# include <shlobj.h> +#endif + +#include "c-ctype.h" +#include "dirname.h" +#include "virterror_internal.h" +#include "virlog.h" +#include "virbuffer.h" +#include "virutil.h" +#include "virstoragefile.h" +#include "viralloc.h" +#include "virthread.h" +#include "verify.h" +#include "virfile.h" +#include "vircommand.h" +#include "nonblocking.h" +#include "passfd.h" +#include "virprocess.h" + +#ifndef NSIG +# define NSIG 32 +#endif + +verify(sizeof(gid_t) <= sizeof(unsigned int) && + sizeof(uid_t) <= sizeof(unsigned int)); + +#define VIR_FROM_THIS VIR_FROM_NONE + +/* Like read(), but restarts after EINTR */ +ssize_t +saferead(int fd, void *buf, size_t count) +{ + size_t nread = 0; + while (count > 0) { + ssize_t r = read(fd, buf, count); + if (r < 0 && errno == EINTR) + continue; + if (r < 0) + return r; + if (r == 0) + return nread; + buf = (char *)buf + r; + count -= r; + nread += r; + } + return nread; +} + +/* Like write(), but restarts after EINTR */ +ssize_t +safewrite(int fd, const void *buf, size_t count) +{ + size_t nwritten = 0; + while (count > 0) { + ssize_t r = write(fd, buf, count); + + if (r < 0 && errno == EINTR) + continue; + if (r < 0) + return r; + if (r == 0) + return nwritten; + buf = (const char *)buf + r; + count -= r; + nwritten += r; + } + return nwritten; +} + +#ifdef HAVE_POSIX_FALLOCATE +int safezero(int fd, off_t offset, off_t len) +{ + int ret = posix_fallocate(fd, offset, len); + if (ret == 0) + return 0; + errno = ret; + return -1; +} +#else + +# ifdef HAVE_MMAP +int safezero(int fd, off_t offset, off_t len) +{ + int r; + char *buf; + + /* memset wants the mmap'ed file to be present on disk so create a + * sparse file + */ + r = ftruncate(fd, offset + len); + if (r < 0) + return -1; + + buf = mmap(NULL, len, PROT_READ | PROT_WRITE, MAP_SHARED, fd, offset); + if (buf == MAP_FAILED) + return -1; + + memset(buf, 0, len); + munmap(buf, len); + + return 0; +} + +# else /* HAVE_MMAP */ + +int safezero(int fd, off_t offset, off_t len) +{ + int r; + char *buf; + unsigned long long remain, bytes; + + if (lseek(fd, offset, SEEK_SET) < 0) + return -1; + + /* Split up the write in small chunks so as not to allocate lots of RAM */ + remain = len; + bytes = 1024 * 1024; + + r = VIR_ALLOC_N(buf, bytes); + if (r < 0) { + errno = ENOMEM; + return -1; + } + + while (remain) { + if (bytes > remain) + bytes = remain; + + r = safewrite(fd, buf, bytes); + if (r < 0) { + VIR_FREE(buf); + return -1; + } + + /* safewrite() guarantees all data will be written */ + remain -= bytes; + } + VIR_FREE(buf); + return 0; +} +# endif /* HAVE_MMAP */ +#endif /* HAVE_POSIX_FALLOCATE */ + +int virFileStripSuffix(char *str, + const char *suffix) +{ + int len = strlen(str); + int suffixlen = strlen(suffix); + + if (len < suffixlen) + return 0; + + if (!STREQ(str + len - suffixlen, suffix)) + return 0; + + str[len-suffixlen] = '\0'; + + return 1; +} + +char * +virArgvToString(const char *const *argv) +{ + int len, i; + char *ret, *p; + + for (len = 1, i = 0; argv[i]; i++) + len += strlen(argv[i]) + 1; + + if (VIR_ALLOC_N(ret, len) < 0) + return NULL; + p = ret; + + for (i = 0; argv[i]; i++) { + if (i != 0) + *(p++) = ' '; + + strcpy(p, argv[i]); + p += strlen(argv[i]); + } + + *p = '\0'; + + return ret; +} + +#ifndef WIN32 + +int virSetInherit(int fd, bool inherit) { + int fflags; + if ((fflags = fcntl(fd, F_GETFD)) < 0) + return -1; + if (inherit) + fflags &= ~FD_CLOEXEC; + else + fflags |= FD_CLOEXEC; + if ((fcntl(fd, F_SETFD, fflags)) < 0) + return -1; + return 0; +} + +#else /* WIN32 */ + +int virSetInherit(int fd ATTRIBUTE_UNUSED, bool inherit ATTRIBUTE_UNUSED) +{ + /* FIXME: Currently creating child processes is not supported on + * Win32, so there is no point in failing calls that are only relevant + * when creating child processes. So just pretend that we changed the + * inheritance property of the given fd as requested. */ + return 0; +} + +#endif /* WIN32 */ + +int virSetBlocking(int fd, bool blocking) { + return set_nonblocking_flag(fd, !blocking); +} + +int virSetNonBlock(int fd) { + return virSetBlocking(fd, false); +} + +int virSetCloseExec(int fd) +{ + return virSetInherit(fd, false); +} + +int +virPipeReadUntilEOF(int outfd, int errfd, + char **outbuf, char **errbuf) { + + struct pollfd fds[2]; + int i; + int finished[2]; + + fds[0].fd = outfd; + fds[0].events = POLLIN; + fds[0].revents = 0; + finished[0] = 0; + fds[1].fd = errfd; + fds[1].events = POLLIN; + fds[1].revents = 0; + finished[1] = 0; + + while (!(finished[0] && finished[1])) { + + if (poll(fds, ARRAY_CARDINALITY(fds), -1) < 0) { + if ((errno == EAGAIN) || (errno == EINTR)) + continue; + goto pollerr; + } + + for (i = 0; i < ARRAY_CARDINALITY(fds); ++i) { + char data[1024], **buf; + int got, size; + + if (!(fds[i].revents)) + continue; + else if (fds[i].revents & POLLHUP) + finished[i] = 1; + + if (!(fds[i].revents & POLLIN)) { + if (fds[i].revents & POLLHUP) + continue; + + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("Unknown poll response.")); + goto error; + } + + got = read(fds[i].fd, data, sizeof(data)); + + if (got == sizeof(data)) + finished[i] = 0; + + if (got == 0) { + finished[i] = 1; + continue; + } + if (got < 0) { + if (errno == EINTR) + continue; + if (errno == EAGAIN) + break; + goto pollerr; + } + + buf = ((fds[i].fd == outfd) ? outbuf : errbuf); + size = (*buf ? strlen(*buf) : 0); + if (VIR_REALLOC_N(*buf, size+got+1) < 0) { + virReportOOMError(); + goto error; + } + memmove(*buf+size, data, got); + (*buf)[size+got] = '\0'; + } + continue; + + pollerr: + virReportSystemError(errno, + "%s", _("poll error")); + goto error; + } + + return 0; + +error: + VIR_FREE(*outbuf); + VIR_FREE(*errbuf); + return -1; +} + +/* Like gnulib's fread_file, but read no more than the specified maximum + number of bytes. If the length of the input is <= max_len, and + upon error while reading that data, it works just like fread_file. */ +static char * +saferead_lim(int fd, size_t max_len, size_t *length) +{ + char *buf = NULL; + size_t alloc = 0; + size_t size = 0; + int save_errno; + + for (;;) { + int count; + int requested; + + if (size + BUFSIZ + 1 > alloc) { + alloc += alloc / 2; + if (alloc < size + BUFSIZ + 1) + alloc = size + BUFSIZ + 1; + + if (VIR_REALLOC_N(buf, alloc) < 0) { + save_errno = errno; + break; + } + } + + /* Ensure that (size + requested <= max_len); */ + requested = MIN(size < max_len ? max_len - size : 0, + alloc - size - 1); + count = saferead(fd, buf + size, requested); + size += count; + + if (count != requested || requested == 0) { + save_errno = errno; + if (count < 0) + break; + buf[size] = '\0'; + *length = size; + return buf; + } + } + + VIR_FREE(buf); + errno = save_errno; + return NULL; +} + +/* A wrapper around saferead_lim that maps a failure due to + exceeding the maximum size limitation to EOVERFLOW. */ +int +virFileReadLimFD(int fd, int maxlen, char **buf) +{ + size_t len; + char *s; + + if (maxlen <= 0) { + errno = EINVAL; + return -1; + } + s = saferead_lim(fd, maxlen+1, &len); + if (s == NULL) + return -1; + if (len > maxlen || (int)len != len) { + VIR_FREE(s); + /* There was at least one byte more than MAXLEN. + Set errno accordingly. */ + errno = EOVERFLOW; + return -1; + } + *buf = s; + return len; +} + +int virFileReadAll(const char *path, int maxlen, char **buf) +{ + int fd = open(path, O_RDONLY); + if (fd < 0) { + virReportSystemError(errno, _("Failed to open file '%s'"), path); + return -1; + } + + int len = virFileReadLimFD(fd, maxlen, buf); + VIR_FORCE_CLOSE(fd); + if (len < 0) { + virReportSystemError(errno, _("Failed to read file '%s'"), path); + return -1; + } + + return len; +} + +/* Truncate @path and write @str to it. If @mode is 0, ensure that + @path exists; otherwise, use @mode if @path must be created. + Return 0 for success, nonzero for failure. + Be careful to preserve any errno value upon failure. */ +int virFileWriteStr(const char *path, const char *str, mode_t mode) +{ + int fd; + + if (mode) + fd = open(path, O_WRONLY|O_TRUNC|O_CREAT, mode); + else + fd = open(path, O_WRONLY|O_TRUNC); + if (fd == -1) + return -1; + + if (safewrite(fd, str, strlen(str)) < 0) { + VIR_FORCE_CLOSE(fd); + return -1; + } + + /* Use errno from failed close only if there was no write error. */ + if (VIR_CLOSE(fd) != 0) + return -1; + + return 0; +} + +int virFileMatchesNameSuffix(const char *file, + const char *name, + const char *suffix) +{ + int filelen = strlen(file); + int namelen = strlen(name); + int suffixlen = strlen(suffix); + + if (filelen == (namelen + suffixlen) && + STREQLEN(file, name, namelen) && + STREQLEN(file + namelen, suffix, suffixlen)) + return 1; + else + return 0; +} + +int virFileHasSuffix(const char *str, + const char *suffix) +{ + int len = strlen(str); + int suffixlen = strlen(suffix); + + if (len < suffixlen) + return 0; + + return STRCASEEQ(str + len - suffixlen, suffix); +} + +#define SAME_INODE(Stat_buf_1, Stat_buf_2) \ + ((Stat_buf_1).st_ino == (Stat_buf_2).st_ino \ + && (Stat_buf_1).st_dev == (Stat_buf_2).st_dev) + +/* Return nonzero if checkLink and checkDest + refer to the same file. Otherwise, return 0. */ +int virFileLinkPointsTo(const char *checkLink, + const char *checkDest) +{ + struct stat src_sb; + struct stat dest_sb; + + return (stat(checkLink, &src_sb) == 0 + && stat(checkDest, &dest_sb) == 0 + && SAME_INODE(src_sb, dest_sb)); +} + + + +static int +virFileResolveLinkHelper(const char *linkpath, + bool intermediatePaths, + char **resultpath) +{ + struct stat st; + + *resultpath = NULL; + + /* We don't need the full canonicalization of intermediate + * directories, if linkpath is absolute and the basename is + * already a non-symlink. */ + if (IS_ABSOLUTE_FILE_NAME(linkpath) && !intermediatePaths) { + if (lstat(linkpath, &st) < 0) + return -1; + + if (!S_ISLNK(st.st_mode)) { + if (!(*resultpath = strdup(linkpath))) + return -1; + return 0; + } + } + + *resultpath = canonicalize_file_name(linkpath); + + return *resultpath == NULL ? -1 : 0; +} + +/* + * Attempt to resolve a symbolic link, returning an + * absolute path where only the last component is guaranteed + * not to be a symlink. + * + * Return 0 if path was not a symbolic, or the link was + * resolved. Return -1 with errno set upon error + */ +int virFileResolveLink(const char *linkpath, + char **resultpath) +{ + return virFileResolveLinkHelper(linkpath, false, resultpath); +} + +/* + * Attempt to resolve a symbolic link, returning an + * absolute path where every component is guaranteed + * not to be a symlink. + * + * Return 0 if path was not a symbolic, or the link was + * resolved. Return -1 with errno set upon error + */ +int virFileResolveAllLinks(const char *linkpath, + char **resultpath) +{ + return virFileResolveLinkHelper(linkpath, true, resultpath); +} + +/* + * Check whether the given file is a link. + * Returns 1 in case of the file being a link, 0 in case it is not + * a link and the negative errno in all other cases. + */ +int virFileIsLink(const char *linkpath) +{ + struct stat st; + + if (lstat(linkpath, &st) < 0) + return -errno; + + return S_ISLNK(st.st_mode) != 0; +} + + +/* + * Finds a requested executable file in the PATH env. e.g.: + * "kvm-img" will return "/usr/bin/kvm-img" + * + * You must free the result + */ +char *virFindFileInPath(const char *file) +{ + char *path = NULL; + char *pathiter; + char *pathseg; + char *fullpath = NULL; + + if (file == NULL) + return NULL; + + /* if we are passed an absolute path (starting with /), return a + * copy of that path, after validating that it is executable + */ + if (IS_ABSOLUTE_FILE_NAME(file)) { + if (virFileIsExecutable(file)) + return strdup(file); + else + return NULL; + } + + /* If we are passed an anchored path (containing a /), then there + * is no path search - it must exist in the current directory + */ + if (strchr(file, '/')) { + if (virFileIsExecutable(file)) + ignore_value(virFileAbsPath(file, &path)); + return path; + } + + /* copy PATH env so we can tweak it */ + path = getenv("PATH"); + + if (path == NULL || (path = strdup(path)) == NULL) + return NULL; + + /* for each path segment, append the file to search for and test for + * it. return it if found. + */ + pathiter = path; + while ((pathseg = strsep(&pathiter, ":")) != NULL) { + if (virAsprintf(&fullpath, "%s/%s", pathseg, file) < 0 || + virFileIsExecutable(fullpath)) + break; + VIR_FREE(fullpath); + } + + VIR_FREE(path); + return fullpath; +} + +bool virFileIsDir(const char *path) +{ + struct stat s; + return (stat(path, &s) == 0) && S_ISDIR(s.st_mode); +} + +bool virFileExists(const char *path) +{ + return access(path, F_OK) == 0; +} + +/* Check that a file is regular and has executable bits. If false is + * returned, errno is valid. + * + * Note: In the presence of ACLs, this may return true for a file that + * would actually fail with EACCES for a given user, or false for a + * file that the user could actually execute, but setups with ACLs + * that weird are unusual. */ +bool +virFileIsExecutable(const char *file) +{ + struct stat sb; + + /* We would also want to check faccessat if we cared about ACLs, + * but we don't. */ + if (stat(file, &sb) < 0) + return false; + if (S_ISREG(sb.st_mode) && (sb.st_mode & 0111) != 0) + return true; + errno = S_ISDIR(sb.st_mode) ? EISDIR : EACCES; + return false; +} + +#ifndef WIN32 +/* Check that a file is accessible under certain + * user & gid. + * @mode can be F_OK, or a bitwise combination of R_OK, W_OK, and X_OK. + * see 'man access' for more details. + * Returns 0 on success, -1 on fail with errno set. + */ +int +virFileAccessibleAs(const char *path, int mode, + uid_t uid, gid_t gid) +{ + pid_t pid = 0; + int status, ret = 0; + int forkRet = 0; + + if (uid == getuid() && + gid == getgid()) + return access(path, mode); + + forkRet = virFork(&pid); + + if (pid < 0) { + return -1; + } + + if (pid) { /* parent */ + if (virProcessWait(pid, &status) < 0) { + /* virProcessWait() already + * reported error */ + return -1; + } + + if (!WIFEXITED(status)) { + errno = EINTR; + return -1; + } + + if (status) { + errno = WEXITSTATUS(status); + return -1; + } + + return 0; + } + + /* child. + * Return positive value here. Parent + * will change it to negative one. */ + + if (forkRet < 0) { + ret = errno; + goto childerror; + } + + if (virSetUIDGID(uid, gid) < 0) { + ret = errno; + goto childerror; + } + + if (access(path, mode) < 0) + ret = errno; + +childerror: + if ((ret & 0xFF) != ret) { + VIR_WARN("unable to pass desired return value %d", ret); + ret = 0xFF; + } + + _exit(ret); +} + +/* virFileOpenForceOwnerMode() - an internal utility function called + * only by virFileOpenAs(). Sets the owner and mode of the file + * opened as "fd" if it's not correct AND the flags say it should be + * forced. */ +static int +virFileOpenForceOwnerMode(const char *path, int fd, mode_t mode, + uid_t uid, gid_t gid, unsigned int flags) +{ + int ret = 0; + struct stat st; + + if (!(flags & (VIR_FILE_OPEN_FORCE_OWNER | VIR_FILE_OPEN_FORCE_MODE))) + return 0; + + if (fstat(fd, &st) == -1) { + ret = -errno; + virReportSystemError(errno, _("stat of '%s' failed"), path); + return ret; + } + /* NB: uid:gid are never "-1" (default) at this point - the caller + * has always changed -1 to the value of get[gu]id(). + */ + if ((flags & VIR_FILE_OPEN_FORCE_OWNER) && + ((st.st_uid != uid) || (st.st_gid != gid)) && + (fchown(fd, uid, gid) < 0)) { + ret = -errno; + virReportSystemError(errno, + _("cannot chown '%s' to (%u, %u)"), + path, (unsigned int) uid, + (unsigned int) gid); + return ret; + } + if ((flags & VIR_FILE_OPEN_FORCE_MODE) && + ((mode & (S_IRWXU|S_IRWXG|S_IRWXO)) != + (st.st_mode & (S_IRWXU|S_IRWXG|S_IRWXO))) && + (fchmod(fd, mode) < 0)) { + ret = -errno; + virReportSystemError(errno, + _("cannot set mode of '%s' to %04o"), + path, mode); + return ret; + } + return ret; +} + +/* virFileOpenForked() - an internal utility function called only by + * virFileOpenAs(). It forks, then the child does setuid+setgid to + * given uid:gid and attempts to open the file, while the parent just + * calls recvfd to get the open fd back from the child. returns the + * fd, or -errno if there is an error. */ +static int +virFileOpenForked(const char *path, int openflags, mode_t mode, + uid_t uid, gid_t gid, unsigned int flags) +{ + pid_t pid; + int waitret, status, ret = 0; + int fd = -1; + int pair[2] = { -1, -1 }; + int forkRet; + + /* parent is running as root, but caller requested that the + * file be opened as some other user and/or group). The + * following dance avoids problems caused by root-squashing + * NFS servers. */ + + if (socketpair(AF_UNIX, SOCK_STREAM, 0, pair) < 0) { + ret = -errno; + virReportSystemError(errno, + _("failed to create socket needed for '%s'"), + path); + return ret; + } + + forkRet = virFork(&pid); + if (pid < 0) + return -errno; + + if (pid == 0) { + + /* child */ + + VIR_FORCE_CLOSE(pair[0]); /* preserves errno */ + if (forkRet < 0) { + /* error encountered and logged in virFork() after the fork. */ + ret = -errno; + goto childerror; + } + + /* set desired uid/gid, then attempt to create the file */ + + if (virSetUIDGID(uid, gid) < 0) { + ret = -errno; + goto childerror; + } + + if ((fd = open(path, openflags, mode)) < 0) { + ret = -errno; + virReportSystemError(errno, + _("child process failed to create file '%s'"), + path); + goto childerror; + } + + /* File is successfully open. Set permissions if requested. */ + ret = virFileOpenForceOwnerMode(path, fd, mode, uid, gid, flags); + if (ret < 0) + goto childerror; + + do { + ret = sendfd(pair[1], fd); + } while (ret < 0 && errno == EINTR); + + if (ret < 0) { + ret = -errno; + virReportSystemError(errno, "%s", + _("child process failed to send fd to parent")); + goto childerror; + } + + childerror: + /* ret tracks -errno on failure, but exit value must be positive. + * If the child exits with EACCES, then the parent tries again. */ + /* XXX This makes assumptions about errno being < 255, which is + * not true on Hurd. */ + VIR_FORCE_CLOSE(pair[1]); + if (ret < 0) { + VIR_FORCE_CLOSE(fd); + } + ret = -ret; + if ((ret & 0xff) != ret) { + VIR_WARN("unable to pass desired return value %d", ret); + ret = 0xff; + } + _exit(ret); + } + + /* parent */ + + VIR_FORCE_CLOSE(pair[1]); + + do { + fd = recvfd(pair[0], 0); + } while (fd < 0 && errno == EINTR); + VIR_FORCE_CLOSE(pair[0]); /* NB: this preserves errno */ + + if (fd < 0 && errno != EACCES) { + ret = -errno; + while (waitpid(pid, NULL, 0) == -1 && errno == EINTR); + return ret; + } + + /* wait for child to complete, and retrieve its exit code */ + while ((waitret = waitpid(pid, &status, 0) == -1) + && (errno == EINTR)); + if (waitret == -1) { + ret = -errno; + virReportSystemError(errno, + _("failed to wait for child creating '%s'"), + path); + VIR_FORCE_CLOSE(fd); + return ret; + } + if (!WIFEXITED(status) || (ret = -WEXITSTATUS(status)) == -EACCES || + fd == -1) { + /* fall back to the simpler method, which works better in + * some cases */ + VIR_FORCE_CLOSE(fd); + if (flags & VIR_FILE_OPEN_NOFORK) { + /* If we had already tried opening w/o fork+setuid and + * failed, no sense trying again. Just set return the + * original errno that we got at that time (by + * definition, always either EACCES or EPERM - EACCES + * is close enough). + */ + return -EACCES; + } + if ((fd = open(path, openflags, mode)) < 0) + return -errno; + ret = virFileOpenForceOwnerMode(path, fd, mode, uid, gid, flags); + if (ret < 0) { + VIR_FORCE_CLOSE(fd); + return ret; + } + } + return fd; +} + +/** + * virFileOpenAs: + * @path: file to open or create + * @openflags: flags to pass to open + * @mode: mode to use on creation or when forcing permissions + * @uid: uid that should own file on creation + * @gid: gid that should own file + * @flags: bit-wise or of VIR_FILE_OPEN_* flags + * + * Open @path, and return an fd to the open file. @openflags contains + * the flags normally passed to open(2), while those in @flags are + * used internally. If @flags includes VIR_FILE_OPEN_NOFORK, then try + * opening the file while executing with the current uid:gid + * (i.e. don't fork+setuid+setgid before the call to open()). If + * @flags includes VIR_FILE_OPEN_FORK, then try opening the file while + * the effective user id is @uid (by forking a child process); this + * allows one to bypass root-squashing NFS issues; NOFORK is always + * tried before FORK (the absence of both flags is treated identically + * to (VIR_FILE_OPEN_NOFORK | VIR_FILE_OPEN_FORK)). If @flags includes + * VIR_FILE_OPEN_FORCE_OWNER, then ensure that @path is owned by + * uid:gid before returning (even if it already existed with a + * different owner). If @flags includes VIR_FILE_OPEN_FORCE_MODE, + * ensure it has those permissions before returning (again, even if + * the file already existed with different permissions). The return + * value (if non-negative) is the file descriptor, left open. Returns + * -errno on failure. */ +int +virFileOpenAs(const char *path, int openflags, mode_t mode, + uid_t uid, gid_t gid, unsigned int flags) +{ + int ret = 0, fd = -1; + + /* allow using -1 to mean "current value" */ + if (uid == (uid_t) -1) + uid = getuid(); + if (gid == (gid_t) -1) + gid = getgid(); + + /* treat absence of both flags as presence of both for simpler + * calling. */ + if (!(flags & (VIR_FILE_OPEN_NOFORK|VIR_FILE_OPEN_FORK))) + flags |= VIR_FILE_OPEN_NOFORK|VIR_FILE_OPEN_FORK; + + if ((flags & VIR_FILE_OPEN_NOFORK) + || (getuid() != 0) + || ((uid == 0) && (gid == 0))) { + + if ((fd = open(path, openflags, mode)) < 0) { + ret = -errno; + } else { + ret = virFileOpenForceOwnerMode(path, fd, mode, uid, gid, flags); + if (ret < 0) + goto error; + } + } + + /* If we either 1) didn't try opening as current user at all, or + * 2) failed, and errno/virStorageFileIsSharedFS indicate we might + * be successful if we try as a different uid, then try doing + * fork+setuid+setgid before opening. + */ + if ((fd < 0) && (flags & VIR_FILE_OPEN_FORK)) { + + if (ret < 0) { + /* An open(2) that failed due to insufficient permissions + * could return one or the other of these depending on OS + * version and circumstances. Any other errno indicates a + * problem that couldn't be remedied by fork+setuid + * anyway. */ + if (ret != -EACCES && ret != -EPERM) + goto error; + + /* On Linux we can also verify the FS-type of the + * directory. (this is a NOP on other platforms). */ + switch (virStorageFileIsSharedFS(path)) { + case 1: + /* it was on a network share, so we'll re-try */ + break; + case -1: + /* failure detecting fstype */ + virReportSystemError(errno, _("couldn't determine fs type " + "of mount containing '%s'"), path); + goto error; + case 0: + default: + /* file isn't on a recognized network FS */ + goto error; + } + } + + /* passed all prerequisites - retry the open w/fork+setuid */ + if ((fd = virFileOpenForked(path, openflags, mode, uid, gid, flags)) < 0) { + ret = fd; + fd = -1; + goto error; + } + } + + /* File is successfully opened */ + + return fd; + +error: + if (fd < 0) { + /* whoever failed the open last has already set ret = -errno */ + virReportSystemError(-ret, openflags & O_CREAT + ? _("failed to create file '%s'") + : _("failed to open file '%s'"), + path); + } else { + /* some other failure after the open succeeded */ + VIR_FORCE_CLOSE(fd); + } + return ret; +} + +/* return -errno on failure, or 0 on success */ +static int virDirCreateNoFork(const char *path, mode_t mode, uid_t uid, gid_t gid, + unsigned int flags) { + int ret = 0; + struct stat st; + + if ((mkdir(path, mode) < 0) + && !((errno == EEXIST) && (flags & VIR_DIR_CREATE_ALLOW_EXIST))) { + ret = -errno; + virReportSystemError(errno, _("failed to create directory '%s'"), + path); + goto error; + } + + if (stat(path, &st) == -1) { + ret = -errno; + virReportSystemError(errno, _("stat of '%s' failed"), path); + goto error; + } + if (((st.st_uid != uid) || (st.st_gid != gid)) + && (chown(path, uid, gid) < 0)) { + ret = -errno; + virReportSystemError(errno, _("cannot chown '%s' to (%u, %u)"), + path, (unsigned int) uid, (unsigned int) gid); + goto error; + } + if ((flags & VIR_DIR_CREATE_FORCE_PERMS) + && (chmod(path, mode) < 0)) { + ret = -errno; + virReportSystemError(errno, + _("cannot set mode of '%s' to %04o"), + path, mode); + goto error; + } +error: + return ret; +} + +/* return -errno on failure, or 0 on success */ +int virDirCreate(const char *path, mode_t mode, + uid_t uid, gid_t gid, unsigned int flags) { + struct stat st; + pid_t pid; + int waitret; + int status, ret = 0; + + /* allow using -1 to mean "current value" */ + if (uid == (uid_t) -1) + uid = getuid(); + if (gid == (gid_t) -1) + gid = getgid(); + + if ((!(flags & VIR_DIR_CREATE_AS_UID)) + || (getuid() != 0) + || ((uid == 0) && (gid == 0)) + || ((flags & VIR_DIR_CREATE_ALLOW_EXIST) && (stat(path, &st) >= 0))) { + return virDirCreateNoFork(path, mode, uid, gid, flags); + } + + int forkRet = virFork(&pid); + + if (pid < 0) { + ret = -errno; + return ret; + } + + if (pid) { /* parent */ + /* wait for child to complete, and retrieve its exit code */ + while ((waitret = waitpid(pid, &status, 0) == -1) && (errno == EINTR)); + if (waitret == -1) { + ret = -errno; + virReportSystemError(errno, + _("failed to wait for child creating '%s'"), + path); + goto parenterror; + } + if (!WIFEXITED(status) || (ret = -WEXITSTATUS(status)) == -EACCES) { + /* fall back to the simpler method, which works better in + * some cases */ + return virDirCreateNoFork(path, mode, uid, gid, flags); + } +parenterror: + return ret; + } + + /* child */ + + if (forkRet < 0) { + /* error encountered and logged in virFork() after the fork. */ + goto childerror; + } + + /* set desired uid/gid, then attempt to create the directory */ + + if (virSetUIDGID(uid, gid) < 0) { + ret = -errno; + goto childerror; + } + if (mkdir(path, mode) < 0) { + ret = -errno; + if (ret != -EACCES) { + /* in case of EACCES, the parent will retry */ + virReportSystemError(errno, _("child failed to create directory '%s'"), + path); + } + goto childerror; + } + /* check if group was set properly by creating after + * setgid. If not, try doing it with chown */ + if (stat(path, &st) == -1) { + ret = -errno; + virReportSystemError(errno, + _("stat of '%s' failed"), path); + goto childerror; + } + if ((st.st_gid != gid) && (chown(path, -1, gid) < 0)) { + ret = -errno; + virReportSystemError(errno, + _("cannot chown '%s' to group %u"), + path, (unsigned int) gid); + goto childerror; + } + if ((flags & VIR_DIR_CREATE_FORCE_PERMS) + && chmod(path, mode) < 0) { + virReportSystemError(errno, + _("cannot set mode of '%s' to %04o"), + path, mode); + goto childerror; + } +childerror: + _exit(ret); +} + +#else /* WIN32 */ + +int +virFileAccessibleAs(const char *path, + int mode, + uid_t uid ATTRIBUTE_UNUSED, + gid_t gid ATTRIBUTE_UNUSED) +{ + + VIR_WARN("Ignoring uid/gid due to WIN32"); + + return access(path, mode); +} + +/* return -errno on failure, or 0 on success */ +int virFileOpenAs(const char *path ATTRIBUTE_UNUSED, + int openflags ATTRIBUTE_UNUSED, + mode_t mode ATTRIBUTE_UNUSED, + uid_t uid ATTRIBUTE_UNUSED, + gid_t gid ATTRIBUTE_UNUSED, + unsigned int flags_unused ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virFileOpenAs is not implemented for WIN32")); + + return -ENOSYS; +} + +int virDirCreate(const char *path ATTRIBUTE_UNUSED, + mode_t mode ATTRIBUTE_UNUSED, + uid_t uid ATTRIBUTE_UNUSED, + gid_t gid ATTRIBUTE_UNUSED, + unsigned int flags_unused ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virDirCreate is not implemented for WIN32")); + + return -ENOSYS; +} +#endif /* WIN32 */ + +static int virFileMakePathHelper(char *path, mode_t mode) +{ + struct stat st; + char *p; + + VIR_DEBUG("path=%s mode=0%o", path, mode); + + if (stat(path, &st) >= 0) { + if (S_ISDIR(st.st_mode)) + return 0; + + errno = ENOTDIR; + return -1; + } + + if (errno != ENOENT) + return -1; + + if ((p = strrchr(path, '/')) == NULL) { + errno = EINVAL; + return -1; + } + + if (p != path) { + *p = '\0'; + + if (virFileMakePathHelper(path, mode) < 0) + return -1; + + *p = '/'; + } + + if (mkdir(path, mode) < 0 && errno != EEXIST) + return -1; + + return 0; +} + +/** + * Creates the given directory with mode 0777 if it's not already existing. + * + * Returns 0 on success, or -1 if an error occurred (in which case, errno + * is set appropriately). + */ +int virFileMakePath(const char *path) +{ + return virFileMakePathWithMode(path, 0777); +} + +int +virFileMakePathWithMode(const char *path, + mode_t mode) +{ + int ret = -1; + char *tmp; + + if ((tmp = strdup(path)) == NULL) + goto cleanup; + + ret = virFileMakePathHelper(tmp, mode); + +cleanup: + VIR_FREE(tmp); + return ret; +} + +/* Build up a fully qualified path for a config file to be + * associated with a persistent guest or network */ +char * +virFileBuildPath(const char *dir, const char *name, const char *ext) +{ + char *path; + + if (ext == NULL) { + if (virAsprintf(&path, "%s/%s", dir, name) < 0) { + virReportOOMError(); + return NULL; + } + } else { + if (virAsprintf(&path, "%s/%s%s", dir, name, ext) < 0) { + virReportOOMError(); + return NULL; + } + } + + return path; +} + +/* Open a non-blocking master side of a pty. If ttyName is not NULL, + * then populate it with the name of the slave. If rawmode is set, + * also put the master side into raw mode before returning. */ +#ifndef WIN32 +int virFileOpenTty(int *ttymaster, + char **ttyName, + int rawmode) +{ + /* XXX A word of caution - on some platforms (Solaris and HP-UX), + * additional ioctl() calls are needs after opening the slave + * before it will cause isatty() to return true. Should we make + * virFileOpenTty also return the opened slave fd, so the caller + * doesn't have to worry about that mess? */ + int ret = -1; + int slave = -1; + char *name = NULL; + + /* Unfortunately, we can't use the name argument of openpty, since + * there is no guarantee on how large the buffer has to be. + * Likewise, we can't use the termios argument: we have to use + * read-modify-write since there is no portable way to initialize + * a struct termios without use of tcgetattr. */ + if (openpty(ttymaster, &slave, NULL, NULL, NULL) < 0) + return -1; + + /* What a shame that openpty cannot atomically set FD_CLOEXEC, but + * that using posix_openpt/grantpt/unlockpt/ptsname is not + * thread-safe, and that ptsname_r is not portable. */ + if (virSetNonBlock(*ttymaster) < 0 || + virSetCloseExec(*ttymaster) < 0) + goto cleanup; + + /* While Linux supports tcgetattr on either the master or the + * slave, Solaris requires it to be on the slave. */ + if (rawmode) { + struct termios ttyAttr; + if (tcgetattr(slave, &ttyAttr) < 0) + goto cleanup; + + cfmakeraw(&ttyAttr); + + if (tcsetattr(slave, TCSADRAIN, &ttyAttr) < 0) + goto cleanup; + } + + /* ttyname_r on the slave is required by POSIX, while ptsname_r on + * the master is a glibc extension, and the POSIX ptsname is not + * thread-safe. Since openpty gave us both descriptors, guess + * which way we will determine the name? :) */ + if (ttyName) { + /* Initial guess of 64 is generally sufficient; rely on ERANGE + * to tell us if we need to grow. */ + size_t len = 64; + int rc; + + if (VIR_ALLOC_N(name, len) < 0) + goto cleanup; + + while ((rc = ttyname_r(slave, name, len)) == ERANGE) { + if (VIR_RESIZE_N(name, len, len, len) < 0) + goto cleanup; + } + if (rc != 0) { + errno = rc; + goto cleanup; + } + *ttyName = name; + name = NULL; + } + + ret = 0; + +cleanup: + if (ret != 0) + VIR_FORCE_CLOSE(*ttymaster); + VIR_FORCE_CLOSE(slave); + VIR_FREE(name); + + return ret; +} +#else /* WIN32 */ +int virFileOpenTty(int *ttymaster ATTRIBUTE_UNUSED, + char **ttyName ATTRIBUTE_UNUSED, + int rawmode ATTRIBUTE_UNUSED) +{ + /* mingw completely lacks pseudo-terminals, and the gnulib + * replacements are not (yet) license compatible. */ + errno = ENOSYS; + return -1; +} +#endif /* WIN32 */ + +bool virFileIsAbsPath(const char *path) +{ + if (!path) + return false; + + if (VIR_FILE_IS_DIR_SEPARATOR(path[0])) + return true; + +#ifdef WIN32 + if (c_isalpha(path[0]) && + path[1] == ':' && + VIR_FILE_IS_DIR_SEPARATOR(path[2])) + return true; +#endif + + return false; +} + + +const char *virFileSkipRoot(const char *path) +{ +#ifdef WIN32 + /* Skip \\server\share or //server/share */ + if (VIR_FILE_IS_DIR_SEPARATOR(path[0]) && + VIR_FILE_IS_DIR_SEPARATOR(path[1]) && + path[2] && + !VIR_FILE_IS_DIR_SEPARATOR(path[2])) + { + const char *p = strchr(path + 2, VIR_FILE_DIR_SEPARATOR); + const char *q = strchr(path + 2, '/'); + + if (p == NULL || (q != NULL && q < p)) + p = q; + + if (p && p > path + 2 && p[1]) { + path = p + 1; + + while (path[0] && + !VIR_FILE_IS_DIR_SEPARATOR(path[0])) + path++; + + /* Possibly skip a backslash after the share name */ + if (VIR_FILE_IS_DIR_SEPARATOR(path[0])) + path++; + + return path; + } + } +#endif + + /* Skip initial slashes */ + if (VIR_FILE_IS_DIR_SEPARATOR(path[0])) { + while (VIR_FILE_IS_DIR_SEPARATOR(path[0])) + path++; + + return path; + } + +#ifdef WIN32 + /* Skip X:\ */ + if (c_isalpha(path[0]) && + path[1] == ':' && + VIR_FILE_IS_DIR_SEPARATOR(path[2])) + return path + 3; +#endif + + return path; +} + + + +/* + * Creates an absolute path for a potentially relative path. + * Return 0 if the path was not relative, or on success. + * Return -1 on error. + * + * You must free the result. + */ +int virFileAbsPath(const char *path, char **abspath) +{ + char *buf; + + if (path[0] == '/') { + if (!(*abspath = strdup(path))) + return -1; + } else { + buf = getcwd(NULL, 0); + if (buf == NULL) + return -1; + + if (virAsprintf(abspath, "%s/%s", buf, path) < 0) { + VIR_FREE(buf); + return -1; + } + VIR_FREE(buf); + } + + return 0; +} + +/* Remove spurious / characters from a path. The result must be freed */ +char * +virFileSanitizePath(const char *path) +{ + const char *cur = path; + char *cleanpath; + int idx = 0; + + cleanpath = strdup(path); + if (!cleanpath) { + virReportOOMError(); + return NULL; + } + + /* Need to sanitize: + * // -> // + * /// -> / + * /../foo -> /../foo + * /foo///bar/ -> /foo/bar + */ + + /* Starting with // is valid posix, but ///foo == /foo */ + if (cur[0] == '/' && cur[1] == '/' && cur[2] != '/') { + idx = 2; + cur += 2; + } + + /* Sanitize path in place */ + while (*cur != '\0') { + if (*cur != '/') { + cleanpath[idx++] = *cur++; + continue; + } + + /* Skip all extra / */ + while (*++cur == '/') + continue; + + /* Don't add a trailing / */ + if (idx != 0 && *cur == '\0') + break; + + cleanpath[idx++] = '/'; + } + cleanpath[idx] = '\0'; + + return cleanpath; +} + +/* Like strtol, but produce an "int" result, and check more carefully. + Return 0 upon success; return -1 to indicate failure. + When END_PTR is NULL, the byte after the final valid digit must be NUL. + Otherwise, it's like strtol and lets the caller check any suffix for + validity. This function is careful to return -1 when the string S + represents a number that is not representable as an "int". */ +int +virStrToLong_i(char const *s, char **end_ptr, int base, int *result) +{ + long int val; + char *p; + int err; + + errno = 0; + val = strtol(s, &p, base); /* exempt from syntax-check */ + err = (errno || (!end_ptr && *p) || p == s || (int) val != val); + if (end_ptr) + *end_ptr = p; + if (err) + return -1; + *result = val; + return 0; +} + +/* Just like virStrToLong_i, above, but produce an "unsigned int" value. */ +int +virStrToLong_ui(char const *s, char **end_ptr, int base, unsigned int *result) +{ + unsigned long int val; + char *p; + int err; + + errno = 0; + val = strtoul(s, &p, base); /* exempt from syntax-check */ + err = (errno || (!end_ptr && *p) || p == s || (unsigned int) val != val); + if (end_ptr) + *end_ptr = p; + if (err) + return -1; + *result = val; + return 0; +} + +/* Just like virStrToLong_i, above, but produce a "long" value. */ +int +virStrToLong_l(char const *s, char **end_ptr, int base, long *result) +{ + long int val; + char *p; + int err; + + errno = 0; + val = strtol(s, &p, base); /* exempt from syntax-check */ + err = (errno || (!end_ptr && *p) || p == s); + if (end_ptr) + *end_ptr = p; + if (err) + return -1; + *result = val; + return 0; +} + +/* Just like virStrToLong_i, above, but produce an "unsigned long" value. */ +int +virStrToLong_ul(char const *s, char **end_ptr, int base, unsigned long *result) +{ + unsigned long int val; + char *p; + int err; + + errno = 0; + val = strtoul(s, &p, base); /* exempt from syntax-check */ + err = (errno || (!end_ptr && *p) || p == s); + if (end_ptr) + *end_ptr = p; + if (err) + return -1; + *result = val; + return 0; +} + +/* Just like virStrToLong_i, above, but produce a "long long" value. */ +int +virStrToLong_ll(char const *s, char **end_ptr, int base, long long *result) +{ + long long val; + char *p; + int err; + + errno = 0; + val = strtoll(s, &p, base); /* exempt from syntax-check */ + err = (errno || (!end_ptr && *p) || p == s); + if (end_ptr) + *end_ptr = p; + if (err) + return -1; + *result = val; + return 0; +} + +/* Just like virStrToLong_i, above, but produce an "unsigned long long" value. */ +int +virStrToLong_ull(char const *s, char **end_ptr, int base, unsigned long long *result) +{ + unsigned long long val; + char *p; + int err; + + errno = 0; + val = strtoull(s, &p, base); /* exempt from syntax-check */ + err = (errno || (!end_ptr && *p) || p == s); + if (end_ptr) + *end_ptr = p; + if (err) + return -1; + *result = val; + return 0; +} + +int +virStrToDouble(char const *s, + char **end_ptr, + double *result) +{ + double val; + char *p; + int err; + + errno = 0; + val = strtod(s, &p); /* exempt from syntax-check */ + err = (errno || (!end_ptr && *p) || p == s); + if (end_ptr) + *end_ptr = p; + if (err) + return -1; + *result = val; + return 0; +} + +/* Convert C from hexadecimal character to integer. */ +int +virHexToBin(unsigned char c) +{ + switch (c) { + default: return c - '0'; + case 'a': case 'A': return 10; + case 'b': case 'B': return 11; + case 'c': case 'C': return 12; + case 'd': case 'D': return 13; + case 'e': case 'E': return 14; + case 'f': case 'F': return 15; + } +} + +/* Scale an integer VALUE in-place by an optional case-insensitive + * SUFFIX, defaulting to SCALE if suffix is NULL or empty (scale is + * typically 1 or 1024). Recognized suffixes include 'b' or 'bytes', + * as well as power-of-two scaling via binary abbreviations ('KiB', + * 'MiB', ...) or their one-letter counterpart ('k', 'M', ...), and + * power-of-ten scaling via SI abbreviations ('KB', 'MB', ...). + * Ensure that the result does not exceed LIMIT. Return 0 on success, + * -1 with error message raised on failure. */ +int +virScaleInteger(unsigned long long *value, const char *suffix, + unsigned long long scale, unsigned long long limit) +{ + if (!suffix || !*suffix) { + if (!scale) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("invalid scale %llu"), scale); + return -1; + } + suffix = ""; + } else if (STRCASEEQ(suffix, "b") || STRCASEEQ(suffix, "byte") || + STRCASEEQ(suffix, "bytes")) { + scale = 1; + } else { + int base; + + if (!suffix[1] || STRCASEEQ(suffix + 1, "iB")) { + base = 1024; + } else if (c_tolower(suffix[1]) == 'b' && !suffix[2]) { + base = 1000; + } else { + virReportError(VIR_ERR_INVALID_ARG, + _("unknown suffix '%s'"), suffix); + return -1; + } + scale = 1; + switch (c_tolower(*suffix)) { + case 'e': + scale *= base; + /* fallthrough */ + case 'p': + scale *= base; + /* fallthrough */ + case 't': + scale *= base; + /* fallthrough */ + case 'g': + scale *= base; + /* fallthrough */ + case 'm': + scale *= base; + /* fallthrough */ + case 'k': + scale *= base; + break; + default: + virReportError(VIR_ERR_INVALID_ARG, + _("unknown suffix '%s'"), suffix); + return -1; + } + } + + if (*value && *value >= (limit / scale)) { + virReportError(VIR_ERR_OVERFLOW, _("value too large: %llu%s"), + *value, suffix); + return -1; + } + *value *= scale; + return 0; +} + +/** + * virSkipSpaces: + * @str: pointer to the char pointer used + * + * Skip potential blanks, this includes space tabs, line feed, + * carriage returns. + */ +void +virSkipSpaces(const char **str) +{ + const char *cur = *str; + + while (c_isspace(*cur)) + cur++; + *str = cur; +} + +/** + * virSkipSpacesAndBackslash: + * @str: pointer to the char pointer used + * + * Like virSkipSpaces, but also skip backslashes erroneously emitted + * by xend + */ +void +virSkipSpacesAndBackslash(const char **str) +{ + const char *cur = *str; + + while (c_isspace(*cur) || *cur == '\\') + cur++; + *str = cur; +} + +/** + * virTrimSpaces: + * @str: string to modify to remove all trailing spaces + * @endp: track the end of the string + * + * If @endp is NULL on entry, then all spaces prior to the trailing + * NUL in @str are removed, by writing NUL into the appropriate + * location. If @endp is non-NULL but points to a NULL pointer, + * then all spaces prior to the trailing NUL in @str are removed, + * NUL is written to the new string end, and endp is set to the + * location of the (new) string end. If @endp is non-NULL and + * points to a non-NULL pointer, then that pointer is used as + * the end of the string, endp is set to the (new) location, but + * no NUL pointer is written into the string. + */ +void +virTrimSpaces(char *str, char **endp) +{ + char *end; + + if (!endp || !*endp) + end = str + strlen(str); + else + end = *endp; + while (end > str && c_isspace(end[-1])) + end--; + if (endp) { + if (!*endp) + *end = '\0'; + *endp = end; + } else { + *end = '\0'; + } +} + +/** + * virSkipSpacesBackwards: + * @str: start of string + * @endp: on entry, *endp must be NULL or a location within @str, on exit, + * will be adjusted to skip trailing spaces, or to NULL if @str had nothing + * but spaces. + */ +void +virSkipSpacesBackwards(const char *str, char **endp) +{ + /* Casting away const is safe, since virTrimSpaces does not + * modify string with this particular usage. */ + char *s = (char*) str; + + if (!*endp) + *endp = s + strlen(s); + virTrimSpaces(s, endp); + if (s == *endp) + *endp = NULL; +} + +/** + * virParseNumber: + * @str: pointer to the char pointer used + * + * Parse an unsigned number + * + * Returns the unsigned number or -1 in case of error. @str will be + * updated to skip the number. + */ +int +virParseNumber(const char **str) +{ + int ret = 0; + const char *cur = *str; + + if ((*cur < '0') || (*cur > '9')) + return -1; + + while (c_isdigit(*cur)) { + unsigned int c = *cur - '0'; + + if ((ret > INT_MAX / 10) || + ((ret == INT_MAX / 10) && (c > INT_MAX % 10))) + return -1; + ret = ret * 10 + c; + cur++; + } + *str = cur; + return ret; +} + + +/** + * virParseVersionString: + * @str: const char pointer to the version string + * @version: unsigned long pointer to output the version number + * @allowMissing: true to treat 3 like 3.0.0, false to error out on + * missing minor or micro + * + * Parse an unsigned version number from a version string. Expecting + * 'major.minor.micro' format, ignoring an optional suffix. + * + * The major, minor and micro numbers are encoded into a single version number: + * + * 1000000 * major + 1000 * minor + micro + * + * Returns the 0 for success, -1 for error. + */ +int +virParseVersionString(const char *str, unsigned long *version, + bool allowMissing) +{ + unsigned int major, minor = 0, micro = 0; + char *tmp; + + if (virStrToLong_ui(str, &tmp, 10, &major) < 0) + return -1; + + if (!allowMissing && *tmp != '.') + return -1; + + if ((*tmp == '.') && virStrToLong_ui(tmp + 1, &tmp, 10, &minor) < 0) + return -1; + + if (!allowMissing && *tmp != '.') + return -1; + + if ((*tmp == '.') && virStrToLong_ui(tmp + 1, &tmp, 10, &micro) < 0) + return -1; + + if (major > UINT_MAX / 1000000 || minor > 999 || micro > 999) + return -1; + + *version = 1000000 * major + 1000 * minor + micro; + + return 0; +} + +/** + * virVasprintf + * + * like glibc's vasprintf but makes sure *strp == NULL on failure + */ +int +virVasprintf(char **strp, const char *fmt, va_list list) +{ + int ret; + + if ((ret = vasprintf(strp, fmt, list)) == -1) + *strp = NULL; + + return ret; +} + +/** + * virAsprintf + * + * like glibc's_asprintf but makes sure *strp == NULL on failure + */ +int +virAsprintf(char **strp, const char *fmt, ...) +{ + va_list ap; + int ret; + + va_start(ap, fmt); + ret = virVasprintf(strp, fmt, ap); + va_end(ap); + return ret; +} + +/** + * virStrncpy + * + * A safe version of strncpy. The last parameter is the number of bytes + * available in the destination string, *not* the number of bytes you want + * to copy. If the destination is not large enough to hold all n of the + * src string bytes plus a \0, NULL is returned and no data is copied. + * If the destination is large enough to hold the n bytes plus \0, then the + * string is copied and a pointer to the destination string is returned. + */ +char * +virStrncpy(char *dest, const char *src, size_t n, size_t destbytes) +{ + char *ret; + + if (n > (destbytes - 1)) + return NULL; + + ret = strncpy(dest, src, n); + /* strncpy NULL terminates iff the last character is \0. Therefore + * force the last byte to be \0 + */ + dest[n] = '\0'; + + return ret; +} + +/** + * virStrcpy + * + * A safe version of strcpy. The last parameter is the number of bytes + * available in the destination string, *not* the number of bytes you want + * to copy. If the destination is not large enough to hold all n of the + * src string bytes plus a \0, NULL is returned and no data is copied. + * If the destination is large enough to hold the source plus \0, then the + * string is copied and a pointer to the destination string is returned. + */ +char * +virStrcpy(char *dest, const char *src, size_t destbytes) +{ + return virStrncpy(dest, src, strlen(src), destbytes); +} + +int virEnumFromString(const char *const*types, + unsigned int ntypes, + const char *type) +{ + unsigned int i; + if (!type) + return -1; + + for (i = 0 ; i < ntypes ; i++) + if (STREQ(types[i], type)) + return i; + + return -1; +} + +/* In case thread-safe locales are available */ +#if HAVE_NEWLOCALE + +static locale_t virLocale; + +static int +virLocaleOnceInit(void) +{ + virLocale = newlocale(LC_ALL_MASK, "C", (locale_t)0); + if (!virLocale) + return -1; + return 0; +} + +VIR_ONCE_GLOBAL_INIT(virLocale) +#endif + +/** + * virDoubleToStr + * + * converts double to string with C locale (thread-safe). + * + * Returns -1 on error, size of the string otherwise. + */ +int +virDoubleToStr(char **strp, double number) +{ + int ret = -1; + +#if HAVE_NEWLOCALE + + locale_t old_loc; + + if (virLocaleInitialize() < 0) + goto error; + + old_loc = uselocale(virLocale); + ret = virAsprintf(strp, "%lf", number); + uselocale(old_loc); + +#else + + char *radix, *tmp; + struct lconv *lc; + + if ((ret = virAsprintf(strp, "%lf", number) < 0)) + goto error; + + lc = localeconv(); + radix = lc->decimal_point; + tmp = strstr(*strp, radix); + if (tmp) { + *tmp = '.'; + if (strlen(radix) > 1) + memmove(tmp + 1, tmp + strlen(radix), strlen(*strp) - (tmp - *strp)); + } + +#endif /* HAVE_NEWLOCALE */ + error: + return ret; +} + + +/** + * Format @val as a base-10 decimal number, in the + * buffer @buf of size @buflen. To allocate a suitable + * sized buffer, the INT_BUFLEN(int) macro should be + * used + * + * Returns pointer to start of the number in @buf + */ +char * +virFormatIntDecimal(char *buf, size_t buflen, int val) +{ + char *p = buf + buflen - 1; + *p = '\0'; + if (val >= 0) { + do { + *--p = '0' + (val % 10); + val /= 10; + } while (val != 0); + } else { + do { + *--p = '0' - (val % 10); + val /= 10; + } while (val != 0); + *--p = '-'; + } + return p; +} + + +const char *virEnumToString(const char *const*types, + unsigned int ntypes, + int type) +{ + if (type < 0 || type >= ntypes) + return NULL; + + return types[type]; +} + +/* Translates a device name of the form (regex) /^[fhv]d[a-z]+[0-9]*$/ + * into the corresponding index (e.g. sda => 0, hdz => 25, vdaa => 26) + * Note that any trailing string of digits is simply ignored. + * @param name The name of the device + * @return name's index, or -1 on failure + */ +int virDiskNameToIndex(const char *name) { + const char *ptr = NULL; + int idx = 0; + static char const* const drive_prefix[] = {"fd", "hd", "vd", "sd", "xvd", "ubd"}; + unsigned int i; + + for (i = 0; i < ARRAY_CARDINALITY(drive_prefix); i++) { + if (STRPREFIX(name, drive_prefix[i])) { + ptr = name + strlen(drive_prefix[i]); + break; + } + } + + if (!ptr) + return -1; + + for (i = 0; *ptr; i++) { + if (!c_islower(*ptr)) + break; + + idx = (idx + (i < 1 ? 0 : 1)) * 26; + idx += *ptr - 'a'; + ptr++; + } + + /* Count the trailing digits. */ + size_t n_digits = strspn(ptr, "0123456789"); + if (ptr[n_digits] != '\0') + return -1; + + return idx; +} + +char *virIndexToDiskName(int idx, const char *prefix) +{ + char *name = NULL; + int i, k, offset; + + if (idx < 0) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Disk index %d is negative"), idx); + return NULL; + } + + for (i = 0, k = idx; k >= 0; ++i, k = k / 26 - 1) { } + + offset = strlen(prefix); + + if (VIR_ALLOC_N(name, offset + i + 1)) { + virReportOOMError(); + return NULL; + } + + strcpy(name, prefix); + name[offset + i] = '\0'; + + for (i = i - 1, k = idx; k >= 0; --i, k = k / 26 - 1) { + name[offset + i] = 'a' + (k % 26); + } + + return name; +} + +#ifndef AI_CANONIDN +# define AI_CANONIDN 0 +#endif + +/* Who knew getting a hostname could be so delicate. In Linux (and Unices + * in general), many things depend on "hostname" returning a value that will + * resolve one way or another. In the modern world where networks frequently + * come and go this is often being hard-coded to resolve to "localhost". If + * it *doesn't* resolve to localhost, then we would prefer to have the FQDN. + * That leads us to 3 possibilities: + * + * 1) gethostname() returns an FQDN (not localhost) - we return the string + * as-is, it's all of the information we want + * 2) gethostname() returns "localhost" - we return localhost; doing further + * work to try to resolve it is pointless + * 3) gethostname() returns a shortened hostname - in this case, we want to + * try to resolve this to a fully-qualified name. Therefore we pass it + * to getaddrinfo(). There are two possible responses: + * a) getaddrinfo() resolves to a FQDN - return the FQDN + * b) getaddrinfo() fails or resolves to localhost - in this case, the + * data we got from gethostname() is actually more useful than what + * we got from getaddrinfo(). Return the value from gethostname() + * and hope for the best. + */ +char *virGetHostname(virConnectPtr conn ATTRIBUTE_UNUSED) +{ + int r; + char hostname[HOST_NAME_MAX+1], *result; + struct addrinfo hints, *info; + + r = gethostname(hostname, sizeof(hostname)); + if (r == -1) { + virReportSystemError(errno, + "%s", _("failed to determine host name")); + return NULL; + } + NUL_TERMINATE(hostname); + + if (STRPREFIX(hostname, "localhost") || strchr(hostname, '.')) { + /* in this case, gethostname returned localhost (meaning we can't + * do any further canonicalization), or it returned an FQDN (and + * we don't need to do any further canonicalization). Return the + * string as-is; it's up to callers to check whether "localhost" + * is allowed. + */ + result = strdup(hostname); + goto check_and_return; + } + + /* otherwise, it's a shortened, non-localhost, hostname. Attempt to + * canonicalize the hostname by running it through getaddrinfo + */ + + memset(&hints, 0, sizeof(hints)); + hints.ai_flags = AI_CANONNAME|AI_CANONIDN; + hints.ai_family = AF_UNSPEC; + r = getaddrinfo(hostname, NULL, &hints, &info); + if (r != 0) { + VIR_WARN("getaddrinfo failed for '%s': %s", + hostname, gai_strerror(r)); + result = strdup(hostname); + goto check_and_return; + } + + /* Tell static analyzers about getaddrinfo semantics. */ + sa_assert(info); + + if (info->ai_canonname == NULL || + STRPREFIX(info->ai_canonname, "localhost")) + /* in this case, we tried to canonicalize and we ended up back with + * localhost. Ignore the canonicalized name and just return the + * original hostname + */ + result = strdup(hostname); + else + /* Caller frees this string. */ + result = strdup(info->ai_canonname); + + freeaddrinfo(info); + +check_and_return: + if (result == NULL) + virReportOOMError(); + return result; +} + +#ifdef HAVE_GETPWUID_R +enum { + VIR_USER_ENT_DIRECTORY, + VIR_USER_ENT_NAME, +}; + +static char *virGetUserEnt(uid_t uid, + int field) +{ + char *strbuf; + char *ret; + struct passwd pwbuf; + struct passwd *pw = NULL; + long val = sysconf(_SC_GETPW_R_SIZE_MAX); + size_t strbuflen = val; + int rc; + + /* sysconf is a hint; if it fails, fall back to a reasonable size */ + if (val < 0) + strbuflen = 1024; + + if (VIR_ALLOC_N(strbuf, strbuflen) < 0) { + virReportOOMError(); + return NULL; + } + + /* + * From the manpage (terrifying but true): + * + * ERRORS + * 0 or ENOENT or ESRCH or EBADF or EPERM or ... + * The given name or uid was not found. + */ + while ((rc = getpwuid_r(uid, &pwbuf, strbuf, strbuflen, &pw)) == ERANGE) { + if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0) { + virReportOOMError(); + VIR_FREE(strbuf); + return NULL; + } + } + if (rc != 0 || pw == NULL) { + virReportSystemError(rc, + _("Failed to find user record for uid '%u'"), + (unsigned int) uid); + VIR_FREE(strbuf); + return NULL; + } + + if (field == VIR_USER_ENT_DIRECTORY) + ret = strdup(pw->pw_dir); + else + ret = strdup(pw->pw_name); + + VIR_FREE(strbuf); + if (!ret) + virReportOOMError(); + + return ret; +} + +static char *virGetGroupEnt(gid_t gid) +{ + char *strbuf; + char *ret; + struct group grbuf; + struct group *gr = NULL; + long val = sysconf(_SC_GETGR_R_SIZE_MAX); + size_t strbuflen = val; + int rc; + + /* sysconf is a hint; if it fails, fall back to a reasonable size */ + if (val < 0) + strbuflen = 1024; + + if (VIR_ALLOC_N(strbuf, strbuflen) < 0) { + virReportOOMError(); + return NULL; + } + + /* + * From the manpage (terrifying but true): + * + * ERRORS + * 0 or ENOENT or ESRCH or EBADF or EPERM or ... + * The given name or gid was not found. + */ + while ((rc = getgrgid_r(gid, &grbuf, strbuf, strbuflen, &gr)) == ERANGE) { + if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0) { + virReportOOMError(); + VIR_FREE(strbuf); + return NULL; + } + } + if (rc != 0 || gr == NULL) { + virReportSystemError(rc, + _("Failed to find group record for gid '%u'"), + (unsigned int) gid); + VIR_FREE(strbuf); + return NULL; + } + + ret = strdup(gr->gr_name); + + VIR_FREE(strbuf); + if (!ret) + virReportOOMError(); + + return ret; +} + +char *virGetUserDirectory(void) +{ + return virGetUserEnt(geteuid(), VIR_USER_ENT_DIRECTORY); +} + +static char *virGetXDGDirectory(const char *xdgenvname, const char *xdgdefdir) +{ + const char *path = getenv(xdgenvname); + char *ret = NULL; + char *home = virGetUserEnt(geteuid(), VIR_USER_ENT_DIRECTORY); + + if (path && path[0]) { + if (virAsprintf(&ret, "%s/libvirt", path) < 0) + goto no_memory; + } else { + if (virAsprintf(&ret, "%s/%s/libvirt", home, xdgdefdir) < 0) + goto no_memory; + } + + cleanup: + VIR_FREE(home); + return ret; + no_memory: + virReportOOMError(); + goto cleanup; +} + +char *virGetUserConfigDirectory(void) +{ + return virGetXDGDirectory("XDG_CONFIG_HOME", ".config"); +} + +char *virGetUserCacheDirectory(void) +{ + return virGetXDGDirectory("XDG_CACHE_HOME", ".cache"); +} + +char *virGetUserRuntimeDirectory(void) +{ + const char *path = getenv("XDG_RUNTIME_DIR"); + + if (!path || !path[0]) { + return virGetUserCacheDirectory(); + } else { + char *ret; + + if (virAsprintf(&ret, "%s/libvirt", path) < 0) { + virReportOOMError(); + return NULL; + } + + return ret; + } +} + +char *virGetUserName(uid_t uid) +{ + return virGetUserEnt(uid, VIR_USER_ENT_NAME); +} + +char *virGetGroupName(gid_t gid) +{ + return virGetGroupEnt(gid); +} + +/* Search in the password database for a user id that matches the user name + * `name`. Returns 0 on success, -1 on failure or 1 if name cannot be found. + */ +static int +virGetUserIDByName(const char *name, uid_t *uid) +{ + char *strbuf = NULL; + struct passwd pwbuf; + struct passwd *pw = NULL; + long val = sysconf(_SC_GETPW_R_SIZE_MAX); + size_t strbuflen = val; + int rc; + int ret = -1; + + /* sysconf is a hint; if it fails, fall back to a reasonable size */ + if (val < 0) + strbuflen = 1024; + + if (VIR_ALLOC_N(strbuf, strbuflen) < 0) { + virReportOOMError(); + goto cleanup; + } + + while ((rc = getpwnam_r(name, &pwbuf, strbuf, strbuflen, &pw)) == ERANGE) { + if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0) { + virReportOOMError(); + goto cleanup; + } + } + + if (!pw) { + if (rc != 0) { + char buf[1024]; + /* log the possible error from getpwnam_r. Unfortunately error + * reporting from this function is bad and we can't really + * rely on it, so we just report that the user wasn't found */ + VIR_WARN("User record for user '%s' was not found: %s", + name, virStrerror(rc, buf, sizeof(buf))); + } + + ret = 1; + goto cleanup; + } + + *uid = pw->pw_uid; + ret = 0; + +cleanup: + VIR_FREE(strbuf); + + return ret; +} + +/* Try to match a user id based on `user`. The default behavior is to parse + * `user` first as a user name and then as a user id. However if `user` + * contains a leading '+', the rest of the string is always parsed as a uid. + * + * Returns 0 on success and -1 otherwise. + */ +int +virGetUserID(const char *user, uid_t *uid) +{ + unsigned int uint_uid; + + if (*user == '+') { + user++; + } else { + int rc = virGetUserIDByName(user, uid); + if (rc <= 0) + return rc; + } + + if (virStrToLong_ui(user, NULL, 10, &uint_uid) < 0 || + ((uid_t) uint_uid) != uint_uid) { + virReportError(VIR_ERR_INVALID_ARG, _("Failed to parse user '%s'"), + user); + return -1; + } + + *uid = uint_uid; + + return 0; +} + +/* Search in the group database for a group id that matches the group name + * `name`. Returns 0 on success, -1 on failure or 1 if name cannot be found. + */ +static int +virGetGroupIDByName(const char *name, gid_t *gid) +{ + char *strbuf = NULL; + struct group grbuf; + struct group *gr = NULL; + long val = sysconf(_SC_GETGR_R_SIZE_MAX); + size_t strbuflen = val; + int rc; + int ret = -1; + + /* sysconf is a hint; if it fails, fall back to a reasonable size */ + if (val < 0) + strbuflen = 1024; + + if (VIR_ALLOC_N(strbuf, strbuflen) < 0) { + virReportOOMError(); + goto cleanup; + } + + while ((rc = getgrnam_r(name, &grbuf, strbuf, strbuflen, &gr)) == ERANGE) { + if (VIR_RESIZE_N(strbuf, strbuflen, strbuflen, strbuflen) < 0) { + virReportOOMError(); + goto cleanup; + } + } + + if (!gr) { + if (rc != 0) { + char buf[1024]; + /* log the possible error from getgrnam_r. Unfortunately error + * reporting from this function is bad and we can't really + * rely on it, so we just report that the user wasn't found */ + VIR_WARN("Group record for user '%s' was not found: %s", + name, virStrerror(rc, buf, sizeof(buf))); + } + + ret = 1; + goto cleanup; + } + + *gid = gr->gr_gid; + ret = 0; + +cleanup: + VIR_FREE(strbuf); + + return ret; +} + +/* Try to match a group id based on `group`. The default behavior is to parse + * `group` first as a group name and then as a group id. However if `group` + * contains a leading '+', the rest of the string is always parsed as a guid. + * + * Returns 0 on success and -1 otherwise. + */ +int +virGetGroupID(const char *group, gid_t *gid) +{ + unsigned int uint_gid; + + if (*group == '+') { + group++; + } else { + int rc = virGetGroupIDByName(group, gid); + if (rc <= 0) + return rc; + } + + if (virStrToLong_ui(group, NULL, 10, &uint_gid) < 0 || + ((gid_t) uint_gid) != uint_gid) { + virReportError(VIR_ERR_INVALID_ARG, _("Failed to parse group '%s'"), + group); + return -1; + } + + *gid = uint_gid; + + return 0; +} + +/* Set the real and effective uid and gid to the given values, and call + * initgroups so that the process has all the assumed group membership of + * that uid. return 0 on success, -1 on failure (the original system error + * remains in errno). + */ +int +virSetUIDGID(uid_t uid, gid_t gid) +{ + int err; + char *buf = NULL; + + if (gid > 0) { + if (setregid(gid, gid) < 0) { + virReportSystemError(err = errno, + _("cannot change to '%d' group"), + (unsigned int) gid); + goto error; + } + } + + if (uid > 0) { +# ifdef HAVE_INITGROUPS + struct passwd pwd, *pwd_result; + size_t bufsize; + int rc; + + bufsize = sysconf(_SC_GETPW_R_SIZE_MAX); + if (bufsize == -1) + bufsize = 16384; + + if (VIR_ALLOC_N(buf, bufsize) < 0) { + virReportOOMError(); + err = ENOMEM; + goto error; + } + while ((rc = getpwuid_r(uid, &pwd, buf, bufsize, + &pwd_result)) == ERANGE) { + if (VIR_RESIZE_N(buf, bufsize, bufsize, bufsize) < 0) { + virReportOOMError(); + err = ENOMEM; + goto error; + } + } + + if (rc) { + virReportSystemError(err = rc, _("cannot getpwuid_r(%d)"), + (unsigned int) uid); + goto error; + } + + if (!pwd_result) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("getpwuid_r failed to retrieve data " + "for uid '%d'"), + (unsigned int) uid); + err = EINVAL; + goto error; + } + + if (initgroups(pwd.pw_name, pwd.pw_gid) < 0) { + virReportSystemError(err = errno, + _("cannot initgroups(\"%s\", %d)"), + pwd.pw_name, (unsigned int) pwd.pw_gid); + goto error; + } +# endif + if (setreuid(uid, uid) < 0) { + virReportSystemError(err = errno, + _("cannot change to uid to '%d'"), + (unsigned int) uid); + goto error; + } + } + + VIR_FREE(buf); + return 0; + +error: + VIR_FREE(buf); + errno = err; + return -1; +} + +#else /* ! HAVE_GETPWUID_R */ + +# ifdef WIN32 +/* These methods are adapted from GLib2 under terms of LGPLv2+ */ +static int +virGetWin32SpecialFolder(int csidl, char **path) +{ + char buf[MAX_PATH+1]; + LPITEMIDLIST pidl = NULL; + int ret = 0; + + *path = NULL; + + if (SHGetSpecialFolderLocation(NULL, csidl, &pidl) == S_OK) { + if (SHGetPathFromIDList(pidl, buf)) { + if (!(*path = strdup(buf))) { + virReportOOMError(); + ret = -1; + } + } + CoTaskMemFree(pidl); + } + return ret; +} + +static int +virGetWin32DirectoryRoot(char **path) +{ + char windowsdir[MAX_PATH]; + int ret = 0; + + *path = NULL; + + if (GetWindowsDirectory(windowsdir, ARRAY_CARDINALITY(windowsdir))) + { + const char *tmp; + /* Usually X:\Windows, but in terminal server environments + * might be an UNC path, AFAIK. + */ + tmp = virFileSkipRoot(windowsdir); + if (VIR_FILE_IS_DIR_SEPARATOR(tmp[-1]) && + tmp[-2] != ':') + tmp--; + + windowsdir[tmp - windowsdir] = '\0'; + } else { + strcpy(windowsdir, "C:\\"); + } + + if (!(*path = strdup(windowsdir))) { + virReportOOMError(); + ret = -1; + } + + return ret; +} + + + +char * +virGetUserDirectory(void) +{ + const char *dir; + char *ret; + + dir = getenv("HOME"); + + /* Only believe HOME if it is an absolute path and exists */ + if (dir) { + if (!virFileIsAbsPath(dir) || + !virFileExists(dir)) + dir = NULL; + } + + /* In case HOME is Unix-style (it happens), convert it to + * Windows style. + */ + if (dir) { + char *p; + while ((p = strchr(dir, '/')) != NULL) + *p = '\\'; + } + + if (!dir) + /* USERPROFILE is probably the closest equivalent to $HOME? */ + dir = getenv("USERPROFILE"); + + if (dir) { + if (!(ret = strdup(dir))) { + virReportOOMError(); + return NULL; + } + } + + if (!ret && + virGetWin32SpecialFolder(CSIDL_PROFILE, &ret) < 0) + return NULL; + + if (!ret && + virGetWin32DirectoryRoot(&ret) < 0) + return NULL; + + if (!ret) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Unable to determine home directory")); + return NULL; + } + + return ret; +} + +char * +virGetUserConfigDirectory(void) +{ + char *ret; + if (virGetWin32SpecialFolder(CSIDL_LOCAL_APPDATA, &ret) < 0) + return NULL; + + if (!ret) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Unable to determine config directory")); + return NULL; + } + return ret; +} + +char * +virGetUserCacheDirectory(void) +{ + char *ret; + if (virGetWin32SpecialFolder(CSIDL_INTERNET_CACHE, &ret) < 0) + return NULL; + + if (!ret) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Unable to determine config directory")); + return NULL; + } + return ret; +} + +char * +virGetUserRuntimeDirectory(void) +{ + return virGetUserCacheDirectory(); +} +# else /* !HAVE_GETPWUID_R && !WIN32 */ +char * +virGetUserDirectory(void) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virGetUserDirectory is not available")); + + return NULL; +} + +char * +virGetUserConfigDirectory(void) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virGetUserConfigDirectory is not available")); + + return NULL; +} + +char * +virGetUserCacheDirectory(void) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virGetUserCacheDirectory is not available")); + + return NULL; +} + +char * +virGetUserRuntimeDirectory(void) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virGetUserRuntimeDirectory is not available")); + + return NULL; +} +# endif /* ! HAVE_GETPWUID_R && ! WIN32 */ + +char * +virGetUserName(uid_t uid ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virGetUserName is not available")); + + return NULL; +} + +int virGetUserID(const char *name ATTRIBUTE_UNUSED, + uid_t *uid ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virGetUserID is not available")); + + return 0; +} + + +int virGetGroupID(const char *name ATTRIBUTE_UNUSED, + gid_t *gid ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virGetGroupID is not available")); + + return 0; +} + +int +virSetUIDGID(uid_t uid ATTRIBUTE_UNUSED, + gid_t gid ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virSetUIDGID is not available")); + return -1; +} + +char * +virGetGroupName(gid_t gid ATTRIBUTE_UNUSED) +{ + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("virGetGroupName is not available")); + + return NULL; +} +#endif /* HAVE_GETPWUID_R */ + + +#if defined HAVE_MNTENT_H && defined HAVE_GETMNTENT_R +/* search /proc/mounts for mount point of *type; return pointer to + * malloc'ed string of the path if found, otherwise return NULL + * with errno set to an appropriate value. + */ +char *virFileFindMountPoint(const char *type) +{ + FILE *f; + struct mntent mb; + char mntbuf[1024]; + char *ret = NULL; + + f = setmntent("/proc/mounts", "r"); + if (!f) + return NULL; + + while (getmntent_r(f, &mb, mntbuf, sizeof(mntbuf))) { + if (STREQ(mb.mnt_type, type)) { + ret = strdup(mb.mnt_dir); + goto cleanup; + } + } + + if (!ret) + errno = ENOENT; + +cleanup: + endmntent(f); + + return ret; +} + +#else /* defined HAVE_MNTENT_H && defined HAVE_GETMNTENT_R */ + +char * +virFileFindMountPoint(const char *type ATTRIBUTE_UNUSED) +{ + errno = ENOSYS; + + return NULL; +} + +#endif /* defined HAVE_MNTENT_H && defined HAVE_GETMNTENT_R */ + +#if defined(UDEVADM) || defined(UDEVSETTLE) +void virFileWaitForDevices(void) +{ +# ifdef UDEVADM + const char *const settleprog[] = { UDEVADM, "settle", NULL }; +# else + const char *const settleprog[] = { UDEVSETTLE, NULL }; +# endif + int exitstatus; + + if (access(settleprog[0], X_OK) != 0) + return; + + /* + * NOTE: we ignore errors here; this is just to make sure that any device + * nodes that are being created finish before we try to scan them. + * If this fails for any reason, we still have the backup of polling for + * 5 seconds for device nodes. + */ + if (virRun(settleprog, &exitstatus) < 0) + {} +} +#else +void virFileWaitForDevices(void) {} +#endif + +int virBuildPathInternal(char **path, ...) +{ + char *path_component = NULL; + virBuffer buf = VIR_BUFFER_INITIALIZER; + va_list ap; + int ret = 0; + + va_start(ap, path); + + path_component = va_arg(ap, char *); + virBufferAdd(&buf, path_component, -1); + + while ((path_component = va_arg(ap, char *)) != NULL) + { + virBufferAddChar(&buf, '/'); + virBufferAdd(&buf, path_component, -1); + } + + va_end(ap); + + *path = virBufferContentAndReset(&buf); + if (*path == NULL) { + ret = -1; + } + + return ret; +} + +#if HAVE_LIBDEVMAPPER_H +bool +virIsDevMapperDevice(const char *dev_name) +{ + struct stat buf; + + if (!stat(dev_name, &buf) && + S_ISBLK(buf.st_mode) && + dm_is_dm_major(major(buf.st_rdev))) + return true; + + return false; +} +#else +bool virIsDevMapperDevice(const char *dev_name ATTRIBUTE_UNUSED) +{ + return false; +} +#endif + +bool +virValidateWWN(const char *wwn) { + int i; + + for (i = 0; wwn[i]; i++) + if (!c_isxdigit(wwn[i])) + break; + + if (i != 16 || wwn[i]) { + virReportError(VIR_ERR_INTERNAL_ERROR, "%s", + _("Malformed wwn: %s")); + return false; + } + + return true; +} + +bool +virStrIsPrint(const char *str) +{ + int i; + + for (i = 0; str[i]; i++) + if (!c_isprint(str[i])) + return false; + + return true; +} diff --git a/src/util/virutil.h b/src/util/virutil.h new file mode 100644 index 0000000..6d5dd03 --- /dev/null +++ b/src/util/virutil.h @@ -0,0 +1,284 @@ +/* + * utils.h: common, generic utility functions + * + * Copyright (C) 2010-2012 Red Hat, Inc. + * Copyright (C) 2006, 2007 Binary Karma + * Copyright (C) 2006 Shuveb Hussain + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * File created Jul 18, 2007 - Shuveb Hussain <shuveb(a)binarykarma.com&gt; + */ + +#ifndef __VIR_UTIL_H__ +# define __VIR_UTIL_H__ + +# include "verify.h" +# include "internal.h" +# include <unistd.h> +# include <sys/select.h> +# include <sys/types.h> +# include <stdarg.h> + +# ifndef MIN +# define MIN(a, b) ((a) < (b) ? (a) : (b)) +# endif +# ifndef MAX +# define MAX(a, b) ((a) > (b) ? (a) : (b)) +# endif + +ssize_t saferead(int fd, void *buf, size_t count) ATTRIBUTE_RETURN_CHECK; +ssize_t safewrite(int fd, const void *buf, size_t count) + ATTRIBUTE_RETURN_CHECK; +int safezero(int fd, off_t offset, off_t len) + ATTRIBUTE_RETURN_CHECK; + +int virSetBlocking(int fd, bool blocking) ATTRIBUTE_RETURN_CHECK; +int virSetNonBlock(int fd) ATTRIBUTE_RETURN_CHECK; +int virSetInherit(int fd, bool inherit) ATTRIBUTE_RETURN_CHECK; +int virSetCloseExec(int fd) ATTRIBUTE_RETURN_CHECK; + +int virPipeReadUntilEOF(int outfd, int errfd, + char **outbuf, char **errbuf); + +int virSetUIDGID(uid_t uid, gid_t gid); + +int virFileReadLimFD(int fd, int maxlen, char **buf) ATTRIBUTE_RETURN_CHECK; + +int virFileReadAll(const char *path, int maxlen, char **buf) ATTRIBUTE_RETURN_CHECK; + +int virFileWriteStr(const char *path, const char *str, mode_t mode) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK; + +int virFileMatchesNameSuffix(const char *file, + const char *name, + const char *suffix); + +int virFileHasSuffix(const char *str, + const char *suffix); + +int virFileStripSuffix(char *str, + const char *suffix) ATTRIBUTE_RETURN_CHECK; + +int virFileLinkPointsTo(const char *checkLink, + const char *checkDest); + +int virFileResolveLink(const char *linkpath, + char **resultpath) ATTRIBUTE_RETURN_CHECK; +int virFileResolveAllLinks(const char *linkpath, + char **resultpath) ATTRIBUTE_RETURN_CHECK; + +int virFileIsLink(const char *linkpath) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; + +char *virFindFileInPath(const char *file); + +bool virFileIsDir (const char *file) ATTRIBUTE_NONNULL(1); +bool virFileExists(const char *file) ATTRIBUTE_NONNULL(1); +bool virFileIsExecutable(const char *file) ATTRIBUTE_NONNULL(1); + +char *virFileSanitizePath(const char *path); + +enum { + VIR_FILE_OPEN_NONE = 0, + VIR_FILE_OPEN_NOFORK = (1 << 0), + VIR_FILE_OPEN_FORK = (1 << 1), + VIR_FILE_OPEN_FORCE_MODE = (1 << 2), + VIR_FILE_OPEN_FORCE_OWNER = (1 << 3), +}; +int virFileAccessibleAs(const char *path, int mode, + uid_t uid, gid_t gid) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; +int virFileOpenAs(const char *path, int openflags, mode_t mode, + uid_t uid, gid_t gid, + unsigned int flags) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; + +enum { + VIR_DIR_CREATE_NONE = 0, + VIR_DIR_CREATE_AS_UID = (1 << 0), + VIR_DIR_CREATE_FORCE_PERMS = (1 << 1), + VIR_DIR_CREATE_ALLOW_EXIST = (1 << 2), +}; +int virDirCreate(const char *path, mode_t mode, uid_t uid, gid_t gid, + unsigned int flags) ATTRIBUTE_RETURN_CHECK; +int virFileMakePath(const char *path) ATTRIBUTE_RETURN_CHECK; +int virFileMakePathWithMode(const char *path, + mode_t mode) ATTRIBUTE_RETURN_CHECK; + +char *virFileBuildPath(const char *dir, + const char *name, + const char *ext) ATTRIBUTE_RETURN_CHECK; + + +# ifdef WIN32 +/* On Win32, the canonical directory separator is the backslash, and + * the search path separator is the semicolon. Note that also the + * (forward) slash works as directory separator. + */ +# define VIR_FILE_DIR_SEPARATOR '\\' +# define VIR_FILE_DIR_SEPARATOR_S "\\" +# define VIR_FILE_IS_DIR_SEPARATOR(c) ((c) == VIR_FILE_DIR_SEPARATOR || (c) == '/') +# define VIR_FILE_PATH_SEPARATOR ';' +# define VIR_FILE_PATH_SEPARATOR_S ";" + +# else /* !WIN32 */ + +# define VIR_FILE_DIR_SEPARATOR '/' +# define VIR_FILE_DIR_SEPARATOR_S "/" +# define VIR_FILE_IS_DIR_SEPARATOR(c) ((c) == VIR_FILE_DIR_SEPARATOR) +# define VIR_FILE_PATH_SEPARATOR ':' +# define VIR_FILE_PATH_SEPARATOR_S ":" + +# endif /* !WIN32 */ + +bool virFileIsAbsPath(const char *path); +int virFileAbsPath(const char *path, + char **abspath) ATTRIBUTE_RETURN_CHECK; +const char *virFileSkipRoot(const char *path); + +int virFileOpenTty(int *ttymaster, + char **ttyName, + int rawmode); + +char *virArgvToString(const char *const *argv); + +int virStrToLong_i(char const *s, + char **end_ptr, + int base, + int *result); + +int virStrToLong_ui(char const *s, + char **end_ptr, + int base, + unsigned int *result); +int virStrToLong_l(char const *s, + char **end_ptr, + int base, + long *result); +int virStrToLong_ul(char const *s, + char **end_ptr, + int base, + unsigned long *result); +int virStrToLong_ll(char const *s, + char **end_ptr, + int base, + long long *result); +int virStrToLong_ull(char const *s, + char **end_ptr, + int base, + unsigned long long *result); +int virStrToDouble(char const *s, + char **end_ptr, + double *result); + +int virScaleInteger(unsigned long long *value, const char *suffix, + unsigned long long scale, unsigned long long limit) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; + +int virHexToBin(unsigned char c); + +void virSkipSpaces(const char **str) ATTRIBUTE_NONNULL(1); +void virSkipSpacesAndBackslash(const char **str) ATTRIBUTE_NONNULL(1); +void virTrimSpaces(char *str, char **endp) ATTRIBUTE_NONNULL(1); +void virSkipSpacesBackwards(const char *str, char **endp) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2); + +int virParseNumber(const char **str); +int virParseVersionString(const char *str, unsigned long *version, + bool allowMissing); +int virAsprintf(char **strp, const char *fmt, ...) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_FMT_PRINTF(2, 3); +int virVasprintf(char **strp, const char *fmt, va_list list) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_FMT_PRINTF(2, 0); +char *virStrncpy(char *dest, const char *src, size_t n, size_t destbytes) + ATTRIBUTE_RETURN_CHECK; +char *virStrcpy(char *dest, const char *src, size_t destbytes) + ATTRIBUTE_RETURN_CHECK; +# define virStrcpyStatic(dest, src) virStrcpy((dest), (src), sizeof(dest)) + +int virDoubleToStr(char **strp, double number) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; + +char *virFormatIntDecimal(char *buf, size_t buflen, int val) + ATTRIBUTE_NONNULL(1) ATTRIBUTE_RETURN_CHECK; + +int virDiskNameToIndex(const char* str); +char *virIndexToDiskName(int idx, const char *prefix); + +int virEnumFromString(const char *const*types, + unsigned int ntypes, + const char *type); + +const char *virEnumToString(const char *const*types, + unsigned int ntypes, + int type); + +# define VIR_ENUM_IMPL(name, lastVal, ...) \ + static const char *const name ## TypeList[] = { __VA_ARGS__ }; \ + verify(ARRAY_CARDINALITY(name ## TypeList) == lastVal); \ + const char *name ## TypeToString(int type) { \ + return virEnumToString(name ## TypeList, \ + ARRAY_CARDINALITY(name ## TypeList), \ + type); \ + } \ + int name ## TypeFromString(const char *type) { \ + return virEnumFromString(name ## TypeList, \ + ARRAY_CARDINALITY(name ## TypeList), \ + type); \ + } + +# define VIR_ENUM_DECL(name) \ + const char *name ## TypeToString(int type); \ + int name ## TypeFromString(const char*type); + +# ifndef HAVE_GETUID +static inline int getuid (void) { return 0; } +# endif + +# ifndef HAVE_GETEUID +static inline int geteuid (void) { return 0; } +# endif + +# ifndef HAVE_GETGID +static inline int getgid (void) { return 0; } +# endif + +char *virGetHostname(virConnectPtr conn); + +char *virGetUserDirectory(void); +char *virGetUserConfigDirectory(void); +char *virGetUserCacheDirectory(void); +char *virGetUserRuntimeDirectory(void); +char *virGetUserName(uid_t uid); +char *virGetGroupName(gid_t gid); +int virGetUserID(const char *name, + uid_t *uid) ATTRIBUTE_RETURN_CHECK; +int virGetGroupID(const char *name, + gid_t *gid) ATTRIBUTE_RETURN_CHECK; + +char *virFileFindMountPoint(const char *type); + +void virFileWaitForDevices(void); + +# define virBuildPath(path, ...) virBuildPathInternal(path, __VA_ARGS__, NULL) +int virBuildPathInternal(char **path, ...) ATTRIBUTE_SENTINEL; + +bool virIsDevMapperDevice(const char *dev_name) ATTRIBUTE_NONNULL(1); + +bool virValidateWWN(const char *wwn); + +bool virStrIsPrint(const char *str); +#endif /* __VIR_UTIL_H__ */ diff --git a/src/util/xml.c b/src/util/xml.c index caf26a3..05c7f33 100644 --- a/src/util/xml.c +++ b/src/util/xml.c @@ -33,7 +33,7 @@ #include "virterror_internal.h" #include "xml.h" #include "virbuffer.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virfile.h" diff --git a/src/vbox/vbox_MSCOMGlue.c b/src/vbox/vbox_MSCOMGlue.c index cab4398..36539f6 100644 --- a/src/vbox/vbox_MSCOMGlue.c +++ b/src/vbox/vbox_MSCOMGlue.c @@ -31,7 +31,7 @@ #include "internal.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "virterror_internal.h" #include "vbox_MSCOMGlue.h" diff --git a/src/vbox/vbox_XPCOMCGlue.c b/src/vbox/vbox_XPCOMCGlue.c index 5296127..1954ddb 100644 --- a/src/vbox/vbox_XPCOMCGlue.c +++ b/src/vbox/vbox_XPCOMCGlue.c @@ -38,7 +38,7 @@ #include "vbox_XPCOMCGlue.h" #include "internal.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "virterror_internal.h" diff --git a/src/vbox/vbox_driver.c b/src/vbox/vbox_driver.c index cd29e19..f2a0c8f 100644 --- a/src/vbox/vbox_driver.c +++ b/src/vbox/vbox_driver.c @@ -38,7 +38,7 @@ #include "vbox_driver.h" #include "vbox_glue.h" #include "virterror_internal.h" -#include "util.h" +#include "virutil.h" #define VIR_FROM_THIS VIR_FROM_VBOX diff --git a/src/vmware/vmware_driver.c b/src/vmware/vmware_driver.c index 233804e..12195bf 100644 --- a/src/vmware/vmware_driver.c +++ b/src/vmware/vmware_driver.c @@ -28,7 +28,7 @@ #include "datatypes.h" #include "virfile.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "uuid.h" #include "vircommand.h" #include "vmx.h" diff --git a/src/xen/block_stats.c b/src/xen/block_stats.c index 126283b..3f7c97b 100644 --- a/src/xen/block_stats.c +++ b/src/xen/block_stats.c @@ -40,7 +40,7 @@ # include "virterror_internal.h" # include "datatypes.h" -# include "util.h" +# include "virutil.h" # include "block_stats.h" # include "viralloc.h" # include "virfile.h" diff --git a/src/xen/xen_driver.c b/src/xen/xen_driver.c index 9b2fcf3..2b8496c 100644 --- a/src/xen/xen_driver.c +++ b/src/xen/xen_driver.c @@ -54,7 +54,7 @@ # include "xen_inotify.h" #endif #include "xml.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "node_device_conf.h" #include "virpci.h" diff --git a/src/xen/xen_hypervisor.c b/src/xen/xen_hypervisor.c index 5c8fe37..f804620 100644 --- a/src/xen/xen_hypervisor.c +++ b/src/xen/xen_hypervisor.c @@ -67,7 +67,7 @@ #include "virlog.h" #include "datatypes.h" #include "driver.h" -#include "util.h" +#include "virutil.h" #include "xen_driver.h" #include "xen_hypervisor.h" #include "xs_internal.h" diff --git a/src/xen/xend_internal.c b/src/xen/xend_internal.c index 6e8bc2f..7ffc5bb 100644 --- a/src/xen/xend_internal.c +++ b/src/xen/xend_internal.c @@ -34,7 +34,7 @@ #include "datatypes.h" #include "xend_internal.h" #include "driver.h" -#include "util.h" +#include "virutil.h" #include "virsexpr.h" #include "xen_sxpr.h" #include "virbuffer.h" diff --git a/src/xen/xm_internal.c b/src/xen/xm_internal.c index 2109972..e3206eb 100644 --- a/src/xen/xm_internal.c +++ b/src/xen/xm_internal.c @@ -45,7 +45,7 @@ #include "virhash.h" #include "virbuffer.h" #include "uuid.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virlog.h" #include "count-one-bits.h" diff --git a/src/xenapi/xenapi_driver.c b/src/xenapi/xenapi_driver.c index 0a0ac0e..04b24ab 100644 --- a/src/xenapi/xenapi_driver.c +++ b/src/xenapi/xenapi_driver.c @@ -31,7 +31,7 @@ #include "virterror_internal.h" #include "datatypes.h" #include "virauth.h" -#include "util.h" +#include "virutil.h" #include "uuid.h" #include "viralloc.h" #include "virbuffer.h" diff --git a/src/xenapi/xenapi_utils.c b/src/xenapi/xenapi_utils.c index 33aa4d7..15be403 100644 --- a/src/xenapi/xenapi_utils.c +++ b/src/xenapi/xenapi_utils.c @@ -29,7 +29,7 @@ #include "domain_conf.h" #include "virterror_internal.h" #include "datatypes.h" -#include "util.h" +#include "virutil.h" #include "uuid.h" #include "viralloc.h" #include "virbuffer.h" diff --git a/tests/commandhelper.c b/tests/commandhelper.c index 3c7fef5..39f3c53 100644 --- a/tests/commandhelper.c +++ b/tests/commandhelper.c @@ -27,7 +27,7 @@ #include <string.h> #include "internal.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virfile.h" #include "testutils.h" diff --git a/tests/commandtest.c b/tests/commandtest.c index b15c168..d6a285e 100644 --- a/tests/commandtest.c +++ b/tests/commandtest.c @@ -31,7 +31,7 @@ #include "testutils.h" #include "internal.h" #include "nodeinfo.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "vircommand.h" #include "virfile.h" diff --git a/tests/esxutilstest.c b/tests/esxutilstest.c index b65009b..55b3623 100644 --- a/tests/esxutilstest.c +++ b/tests/esxutilstest.c @@ -9,7 +9,7 @@ # include "internal.h" # include "viralloc.h" # include "testutils.h" -# include "util.h" +# include "virutil.h" # include "vmx/vmx.h" # include "esx/esx_util.h" # include "esx/esx_vi_types.h" diff --git a/tests/eventtest.c b/tests/eventtest.c index 6d00ea8..16a693c 100644 --- a/tests/eventtest.c +++ b/tests/eventtest.c @@ -30,7 +30,7 @@ #include "internal.h" #include "virthread.h" #include "virlog.h" -#include "util.h" +#include "virutil.h" #include "vireventpoll.h" #define NUM_FDS 31 diff --git a/tests/libvirtdconftest.c b/tests/libvirtdconftest.c index 0365ade..c1d94d2 100644 --- a/tests/libvirtdconftest.c +++ b/tests/libvirtdconftest.c @@ -24,7 +24,7 @@ #include "testutils.h" #include "daemon/libvirtd-config.h" -#include "util.h" +#include "virutil.h" #include "c-ctype.h" #include "virterror_internal.h" #include "virlog.h" diff --git a/tests/nodeinfotest.c b/tests/nodeinfotest.c index c79788e..d900eb9 100644 --- a/tests/nodeinfotest.c +++ b/tests/nodeinfotest.c @@ -8,7 +8,7 @@ #include "testutils.h" #include "internal.h" #include "nodeinfo.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #if ! (defined __linux__ && (defined(__x86_64__) || \ diff --git a/tests/openvzutilstest.c b/tests/openvzutilstest.c index 80701a2..9fb7178 100644 --- a/tests/openvzutilstest.c +++ b/tests/openvzutilstest.c @@ -9,7 +9,7 @@ # include "internal.h" # include "viralloc.h" # include "testutils.h" -# include "util.h" +# include "virutil.h" # include "openvz/openvz_conf.h" static int diff --git a/tests/qemumonitortest.c b/tests/qemumonitortest.c index 21a6828..285dfa8 100644 --- a/tests/qemumonitortest.c +++ b/tests/qemumonitortest.c @@ -10,7 +10,7 @@ # include "internal.h" # include "viralloc.h" # include "testutils.h" -# include "util.h" +# include "virutil.h" # include "qemu/qemu_monitor.h" struct testEscapeString diff --git a/tests/qemumonitortestutils.c b/tests/qemumonitortestutils.c index cc38803..b82eb5d 100644 --- a/tests/qemumonitortestutils.c +++ b/tests/qemumonitortestutils.c @@ -30,7 +30,7 @@ #include "qemu/qemu_monitor.h" #include "rpc/virnetsocket.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "virterror_internal.h" diff --git a/tests/securityselinuxtest.c b/tests/securityselinuxtest.c index 045c9c0..b523c79 100644 --- a/tests/securityselinuxtest.c +++ b/tests/securityselinuxtest.c @@ -31,7 +31,7 @@ #include "internal.h" #include "testutils.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" #include "virterror_internal.h" #include "security/security_manager.h" diff --git a/tests/testutils.c b/tests/testutils.c index c6b1d23..d88af21 100644 --- a/tests/testutils.c +++ b/tests/testutils.c @@ -40,7 +40,7 @@ #include "testutils.h" #include "internal.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virthread.h" #include "virterror_internal.h" #include "virbuffer.h" diff --git a/tests/utiltest.c b/tests/utiltest.c index 4fbb25c..9d18652 100644 --- a/tests/utiltest.c +++ b/tests/utiltest.c @@ -8,7 +8,7 @@ #include "internal.h" #include "viralloc.h" #include "testutils.h" -#include "util.h" +#include "virutil.h" static void diff --git a/tests/virauthconfigtest.c b/tests/virauthconfigtest.c index 9e7dac5..2ad237d 100644 --- a/tests/virauthconfigtest.c +++ b/tests/virauthconfigtest.c @@ -24,7 +24,7 @@ #include <signal.h> #include "testutils.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" diff --git a/tests/virbuftest.c b/tests/virbuftest.c index ec93939..7f9ee66 100644 --- a/tests/virbuftest.c +++ b/tests/virbuftest.c @@ -5,7 +5,7 @@ #include <string.h> #include "internal.h" -#include "util.h" +#include "virutil.h" #include "testutils.h" #include "virbuffer.h" #include "viralloc.h" diff --git a/tests/virdrivermoduletest.c b/tests/virdrivermoduletest.c index e06179f..cab47d3 100644 --- a/tests/virdrivermoduletest.c +++ b/tests/virdrivermoduletest.c @@ -21,7 +21,7 @@ #include <config.h> #include "testutils.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" diff --git a/tests/virhashtest.c b/tests/virhashtest.c index a2a40c6..6e4f267 100644 --- a/tests/virhashtest.c +++ b/tests/virhashtest.c @@ -10,7 +10,7 @@ #include "virhashdata.h" #include "testutils.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virlog.h" diff --git a/tests/virkeyfiletest.c b/tests/virkeyfiletest.c index ad5a516..33f64c1 100644 --- a/tests/virkeyfiletest.c +++ b/tests/virkeyfiletest.c @@ -24,7 +24,7 @@ #include <signal.h> #include "testutils.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" diff --git a/tests/virlockspacetest.c b/tests/virlockspacetest.c index 80478d9..c434f47 100644 --- a/tests/virlockspacetest.c +++ b/tests/virlockspacetest.c @@ -25,7 +25,7 @@ #include <sys/stat.h> #include "testutils.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" diff --git a/tests/virnetmessagetest.c b/tests/virnetmessagetest.c index e3517e8..4e7a1fd 100644 --- a/tests/virnetmessagetest.c +++ b/tests/virnetmessagetest.c @@ -24,7 +24,7 @@ #include <signal.h> #include "testutils.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" diff --git a/tests/virnetsockettest.c b/tests/virnetsockettest.c index 399c4fd..819257b 100644 --- a/tests/virnetsockettest.c +++ b/tests/virnetsockettest.c @@ -28,7 +28,7 @@ #include <netdb.h> #include "testutils.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" diff --git a/tests/virnettlscontexttest.c b/tests/virnettlscontexttest.c index 27078ea..d945181 100644 --- a/tests/virnettlscontexttest.c +++ b/tests/virnettlscontexttest.c @@ -27,7 +27,7 @@ #include <gnutls/x509.h> #include "testutils.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" diff --git a/tests/virshtest.c b/tests/virshtest.c index 72f2a1e..8741d47 100644 --- a/tests/virshtest.c +++ b/tests/virshtest.c @@ -6,7 +6,7 @@ #include "internal.h" #include "xml.h" -#include "util.h" +#include "virutil.h" #include "testutils.h" #ifdef WIN32 diff --git a/tests/virstringtest.c b/tests/virstringtest.c index a8f4c79..58ab843 100644 --- a/tests/virstringtest.c +++ b/tests/virstringtest.c @@ -23,7 +23,7 @@ #include <stdlib.h> #include "testutils.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" diff --git a/tests/virtimetest.c b/tests/virtimetest.c index 7d7a2d6..1c22d07 100644 --- a/tests/virtimetest.c +++ b/tests/virtimetest.c @@ -24,7 +24,7 @@ #include <signal.h> #include "testutils.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" diff --git a/tests/viruritest.c b/tests/viruritest.c index 57d3895..ad59270 100644 --- a/tests/viruritest.c +++ b/tests/viruritest.c @@ -24,7 +24,7 @@ #include <signal.h> #include "testutils.h" -#include "util.h" +#include "virutil.h" #include "virterror_internal.h" #include "viralloc.h" #include "virlog.h" diff --git a/tools/console.c b/tools/console.c index d031308..d024d38 100644 --- a/tools/console.c +++ b/tools/console.c @@ -39,7 +39,7 @@ # include "internal.h" # include "console.h" # include "virlog.h" -# include "util.h" +# include "virutil.h" # include "virfile.h" # include "viralloc.h" # include "virthread.h" diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c index b0b0c94..244ffb8 100644 --- a/tools/virsh-domain.c +++ b/tools/virsh-domain.c @@ -43,7 +43,7 @@ #include "conf/domain_conf.h" #include "console.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "virkeycode.h" #include "virmacaddr.h" diff --git a/tools/virsh-host.c b/tools/virsh-host.c index 2d59a75..0ad4296 100644 --- a/tools/virsh-host.c +++ b/tools/virsh-host.c @@ -34,7 +34,7 @@ #include "internal.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virsh-domain.h" #include "xml.h" #include "virtypedparam.h" diff --git a/tools/virsh-interface.c b/tools/virsh-interface.c index 40216c6..ea8a6c5 100644 --- a/tools/virsh-interface.c +++ b/tools/virsh-interface.c @@ -34,7 +34,7 @@ #include "internal.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "xml.h" virInterfacePtr diff --git a/tools/virsh-network.c b/tools/virsh-network.c index 66ee7e3..918dee6 100644 --- a/tools/virsh-network.c +++ b/tools/virsh-network.c @@ -34,7 +34,7 @@ #include "internal.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "xml.h" #include "conf/network_conf.h" diff --git a/tools/virsh-nodedev.c b/tools/virsh-nodedev.c index 7e569b3..974e495 100644 --- a/tools/virsh-nodedev.c +++ b/tools/virsh-nodedev.c @@ -34,7 +34,7 @@ #include "internal.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "xml.h" #include "conf/node_device_conf.h" diff --git a/tools/virsh-nwfilter.c b/tools/virsh-nwfilter.c index c3dba0c..1480d13 100644 --- a/tools/virsh-nwfilter.c +++ b/tools/virsh-nwfilter.c @@ -34,7 +34,7 @@ #include "internal.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "xml.h" virNWFilterPtr diff --git a/tools/virsh-pool.c b/tools/virsh-pool.c index 6e29604..b3177e0 100644 --- a/tools/virsh-pool.c +++ b/tools/virsh-pool.c @@ -34,7 +34,7 @@ #include "internal.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "xml.h" #include "conf/storage_conf.h" diff --git a/tools/virsh-secret.c b/tools/virsh-secret.c index d81e8ce..a29454f 100644 --- a/tools/virsh-secret.c +++ b/tools/virsh-secret.c @@ -35,7 +35,7 @@ #include "base64.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "xml.h" static virSecretPtr diff --git a/tools/virsh-snapshot.c b/tools/virsh-snapshot.c index 3fecde6..8428282 100644 --- a/tools/virsh-snapshot.c +++ b/tools/virsh-snapshot.c @@ -36,7 +36,7 @@ #include "internal.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virsh-domain.h" #include "xml.h" #include "conf/snapshot_conf.h" diff --git a/tools/virsh-volume.c b/tools/virsh-volume.c index ebfe52d..6f2c591 100644 --- a/tools/virsh-volume.c +++ b/tools/virsh-volume.c @@ -36,7 +36,7 @@ #include "internal.h" #include "virbuffer.h" #include "viralloc.h" -#include "util.h" +#include "virutil.h" #include "virfile.h" #include "virsh-pool.h" #include "xml.h" diff --git a/tools/virsh.c b/tools/virsh.c index 91a9677..bfeaaa1 100644 --- a/tools/virsh.c +++ b/tools/virsh.c @@ -58,7 +58,7 @@ #include "base64.h" #include "virbuffer.h" #include "console.h" -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "xml.h" #include "libvirt/libvirt-qemu.h" diff --git a/tools/virt-host-validate-common.c b/tools/virt-host-validate-common.c index cd75eba..34a527f 100644 --- a/tools/virt-host-validate-common.c +++ b/tools/virt-host-validate-common.c @@ -27,7 +27,7 @@ #include <unistd.h> #include <sys/utsname.h> -#include "util.h" +#include "virutil.h" #include "viralloc.h" #include "virfile.h" #include "virt-host-validate-common.h" -- 1.7.11.7

On Mon, Dec 17, 2012 at 10:22:11PM +0100, Michal Privoznik wrote: No idea, I did a global search-replace so didn't notice these kind of issues myself. BTW, if replying to large patches like this, please trim the text you quote, to only leave context for either the file, or method you are referring to. It took me a while to find your one line comment ! Regards, Danel -- |: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|

On 17.12.2012 15:57, Daniel P. Berrange wrote: Same comment from previous patch applies here as well ....

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- cfg.mk | 2 +- po/POTFILES.in | 2 +- src/Makefile.am | 2 +- src/conf/cpu_conf.h | 2 +- src/conf/device_conf.c | 2 +- src/conf/domain_conf.c | 2 +- src/conf/interface_conf.c | 2 +- src/conf/netdev_bandwidth_conf.h | 2 +- src/conf/netdev_vlan_conf.h | 2 +- src/conf/netdev_vport_profile_conf.h | 2 +- src/conf/network_conf.c | 2 +- src/conf/node_device_conf.c | 2 +- src/conf/nwfilter_conf.h | 2 +- src/conf/secret_conf.c | 2 +- src/conf/snapshot_conf.c | 2 +- src/conf/storage_conf.c | 2 +- src/conf/storage_encryption_conf.c | 2 +- src/cpu/cpu.c | 2 +- src/cpu/cpu_map.h | 2 +- src/esx/esx_vi.c | 2 +- src/qemu/qemu_conf.c | 2 +- src/qemu/qemu_driver.c | 2 +- src/security/virt-aa-helper.c | 2 +- src/storage/storage_backend_fs.c | 2 +- src/test/test_driver.c | 2 +- src/util/virxml.c | 890 +++++++++++++++++++++++++++++++++++ src/util/virxml.h | 148 ++++++ src/util/xml.c | 890 ----------------------------------- src/util/xml.h | 148 ------ src/xen/xen_driver.c | 2 +- tests/cputest.c | 2 +- tests/nwfilterxml2xmltest.c | 2 +- tests/sexpr2xmltest.c | 2 +- tests/virshtest.c | 2 +- tests/xencapstest.c | 2 +- tools/virsh-domain-monitor.c | 2 +- tools/virsh-domain.c | 2 +- tools/virsh-host.c | 2 +- tools/virsh-interface.c | 2 +- tools/virsh-network.c | 2 +- tools/virsh-nodedev.c | 2 +- tools/virsh-nwfilter.c | 2 +- tools/virsh-pool.c | 2 +- tools/virsh-secret.c | 2 +- tools/virsh-snapshot.c | 2 +- tools/virsh-volume.c | 2 +- tools/virsh.c | 2 +- 47 files changed, 1081 insertions(+), 1081 deletions(-) create mode 100644 src/util/virxml.c create mode 100644 src/util/virxml.h delete mode 100644 src/util/xml.c delete mode 100644 src/util/xml.h diff --git a/cfg.mk b/cfg.mk index a269f77..2fcb444 100644 --- a/cfg.mk +++ b/cfg.mk @@ -809,7 +809,7 @@ exclude_file_name_regexp--sc_prohibit_strncpy = ^src/util/virutil\.c$$ exclude_file_name_regexp--sc_prohibit_strtol = \ ^src/(util/virsexpr|(vbox|xen|xenxs)/.*)\.c$$ -exclude_file_name_regexp--sc_prohibit_xmlGetProp = ^src/util/xml\.c$$ +exclude_file_name_regexp--sc_prohibit_xmlGetProp = ^src/util/virxml\.c$$ exclude_file_name_regexp--sc_prohibit_xmlURI = ^src/util/viruri\.c$$ diff --git a/po/POTFILES.in b/po/POTFILES.in index 8a24fd4..1afdca5 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -180,7 +180,7 @@ src/util/virtypedparam.c src/util/viruri.c src/util/virusb.c src/util/virutil.c -src/util/xml.c +src/util/virxml.c src/vbox/vbox_MSCOMGlue.c src/vbox/vbox_XPCOMCGlue.c src/vbox/vbox_driver.c diff --git a/src/Makefile.am b/src/Makefile.am index dd5a1bd..dddd162 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -85,7 +85,6 @@ UTIL_SOURCES = \ util/virthreadwin32.h \ util/virthreadpool.c util/virthreadpool.h \ util/virtypedparam.c util/virtypedparam.h \ - util/xml.c util/xml.h \ util/virterror.c util/virterror_internal.h \ util/vircgroup.c util/vircgroup.h \ util/virdbus.c util/virdbus.h \ @@ -115,6 +114,7 @@ UTIL_SOURCES = \ util/viruri.h util/viruri.c \ util/virutil.c util/virutil.h \ util/viruuid.c util/viruuid.h \ + util/virxml.c util/virxml.h \ $(NULL) EXTRA_DIST += $(srcdir)/util/virkeymaps.h $(srcdir)/util/keymaps.csv \ diff --git a/src/conf/cpu_conf.h b/src/conf/cpu_conf.h index 7bec912..616d813 100644 --- a/src/conf/cpu_conf.h +++ b/src/conf/cpu_conf.h @@ -26,7 +26,7 @@ # include "virutil.h" # include "virbuffer.h" -# include "xml.h" +# include "virxml.h" # include "virbitmap.h" # define VIR_CPU_VENDOR_ID_LENGTH 12 diff --git a/src/conf/device_conf.c b/src/conf/device_conf.c index ecfaf30..45ecb28 100644 --- a/src/conf/device_conf.c +++ b/src/conf/device_conf.c @@ -24,7 +24,7 @@ #include "virterror_internal.h" #include "datatypes.h" #include "viralloc.h" -#include "xml.h" +#include "virxml.h" #include "viruuid.h" #include "virutil.h" #include "virbuffer.h" diff --git a/src/conf/domain_conf.c b/src/conf/domain_conf.c index 2943fe3..a4f33ed 100644 --- a/src/conf/domain_conf.c +++ b/src/conf/domain_conf.c @@ -36,7 +36,7 @@ #include "snapshot_conf.h" #include "viralloc.h" #include "verify.h" -#include "xml.h" +#include "virxml.h" #include "viruuid.h" #include "virutil.h" #include "virbuffer.h" diff --git a/src/conf/interface_conf.c b/src/conf/interface_conf.c index 6a53bda..3867274 100644 --- a/src/conf/interface_conf.c +++ b/src/conf/interface_conf.c @@ -28,7 +28,7 @@ #include "interface_conf.h" #include "viralloc.h" -#include "xml.h" +#include "virxml.h" #include "viruuid.h" #include "virutil.h" #include "virbuffer.h" diff --git a/src/conf/netdev_bandwidth_conf.h b/src/conf/netdev_bandwidth_conf.h index 216a540..23aaaf3 100644 --- a/src/conf/netdev_bandwidth_conf.h +++ b/src/conf/netdev_bandwidth_conf.h @@ -26,7 +26,7 @@ # include "internal.h" # include "virnetdevbandwidth.h" # include "virbuffer.h" -# include "xml.h" +# include "virxml.h" virNetDevBandwidthPtr virNetDevBandwidthParse(xmlNodePtr node, int net_type) diff --git a/src/conf/netdev_vlan_conf.h b/src/conf/netdev_vlan_conf.h index 19b50cc..480d6c6 100644 --- a/src/conf/netdev_vlan_conf.h +++ b/src/conf/netdev_vlan_conf.h @@ -25,7 +25,7 @@ # include "internal.h" # include "virnetdevvlan.h" # include "virbuffer.h" -# include "xml.h" +# include "virxml.h" int virNetDevVlanParse(xmlNodePtr node, xmlXPathContextPtr ctxt, virNetDevVlanPtr def); int virNetDevVlanFormat(virNetDevVlanPtr def, virBufferPtr buf); diff --git a/src/conf/netdev_vport_profile_conf.h b/src/conf/netdev_vport_profile_conf.h index 15ecbd6..a70256d 100644 --- a/src/conf/netdev_vport_profile_conf.h +++ b/src/conf/netdev_vport_profile_conf.h @@ -26,7 +26,7 @@ # include "internal.h" # include "virnetdevvportprofile.h" # include "virbuffer.h" -# include "xml.h" +# include "virxml.h" typedef enum { /* generate random defaults for interfaceID/interfaceID diff --git a/src/conf/network_conf.c b/src/conf/network_conf.c index 01a6f2e..2bd04c5 100644 --- a/src/conf/network_conf.c +++ b/src/conf/network_conf.c @@ -38,7 +38,7 @@ #include "netdev_bandwidth_conf.h" #include "netdev_vlan_conf.h" #include "viralloc.h" -#include "xml.h" +#include "virxml.h" #include "viruuid.h" #include "virutil.h" #include "virbuffer.h" diff --git a/src/conf/node_device_conf.c b/src/conf/node_device_conf.c index 67d743e..3c68011 100644 --- a/src/conf/node_device_conf.c +++ b/src/conf/node_device_conf.c @@ -32,7 +32,7 @@ #include "node_device_conf.h" #include "viralloc.h" -#include "xml.h" +#include "virxml.h" #include "virutil.h" #include "virbuffer.h" #include "viruuid.h" diff --git a/src/conf/nwfilter_conf.h b/src/conf/nwfilter_conf.h index 2ca44b3..ca2c070 100644 --- a/src/conf/nwfilter_conf.h +++ b/src/conf/nwfilter_conf.h @@ -30,7 +30,7 @@ # include "virutil.h" # include "virhash.h" -# include "xml.h" +# include "virxml.h" # include "virbuffer.h" # include "virsocketaddr.h" # include "virmacaddr.h" diff --git a/src/conf/secret_conf.c b/src/conf/secret_conf.c index 2abb95a..46d2ae5 100644 --- a/src/conf/secret_conf.c +++ b/src/conf/secret_conf.c @@ -30,7 +30,7 @@ #include "secret_conf.h" #include "virterror_internal.h" #include "virutil.h" -#include "xml.h" +#include "virxml.h" #include "viruuid.h" #define VIR_FROM_THIS VIR_FROM_SECRET diff --git a/src/conf/snapshot_conf.c b/src/conf/snapshot_conf.c index 3ad74d6..f7f8f63 100644 --- a/src/conf/snapshot_conf.c +++ b/src/conf/snapshot_conf.c @@ -46,7 +46,7 @@ #include "viruuid.h" #include "virfile.h" #include "virterror_internal.h" -#include "xml.h" +#include "virxml.h" #define VIR_FROM_THIS VIR_FROM_DOMAIN_SNAPSHOT diff --git a/src/conf/storage_conf.c b/src/conf/storage_conf.c index 4239e49..04b2581 100644 --- a/src/conf/storage_conf.c +++ b/src/conf/storage_conf.c @@ -38,7 +38,7 @@ #include "storage_conf.h" #include "virstoragefile.h" -#include "xml.h" +#include "virxml.h" #include "viruuid.h" #include "virbuffer.h" #include "virutil.h" diff --git a/src/conf/storage_encryption_conf.c b/src/conf/storage_encryption_conf.c index 8ea54fa..35e9da4 100644 --- a/src/conf/storage_encryption_conf.c +++ b/src/conf/storage_encryption_conf.c @@ -32,7 +32,7 @@ #include "storage_conf.h" #include "storage_encryption_conf.h" #include "virutil.h" -#include "xml.h" +#include "virxml.h" #include "virterror_internal.h" #include "viruuid.h" #include "virfile.h" diff --git a/src/cpu/cpu.c b/src/cpu/cpu.c index 2222a91..3e25f7d 100644 --- a/src/cpu/cpu.c +++ b/src/cpu/cpu.c @@ -25,7 +25,7 @@ #include "virlog.h" #include "viralloc.h" -#include "xml.h" +#include "virxml.h" #include "cpu.h" #include "cpu_x86.h" #include "cpu_powerpc.h" diff --git a/src/cpu/cpu_map.h b/src/cpu/cpu_map.h index 9120513..8d27bcd 100644 --- a/src/cpu/cpu_map.h +++ b/src/cpu/cpu_map.h @@ -24,7 +24,7 @@ #ifndef __VIR_CPU_MAP_H__ # define __VIR_CPU_MAP_H__ -# include "xml.h" +# include "virxml.h" enum cpuMapElement { diff --git a/src/esx/esx_vi.c b/src/esx/esx_vi.c index 92ac8f8..99c1eb1 100644 --- a/src/esx/esx_vi.c +++ b/src/esx/esx_vi.c @@ -32,7 +32,7 @@ #include "virutil.h" #include "viruuid.h" #include "vmx.h" -#include "xml.h" +#include "virxml.h" #include "esx_vi.h" #include "esx_vi_methods.h" #include "esx_util.h" diff --git a/src/qemu/qemu_conf.c b/src/qemu/qemu_conf.c index 8d05b4c..56c93a8 100644 --- a/src/qemu/qemu_conf.c +++ b/src/qemu/qemu_conf.c @@ -46,7 +46,7 @@ #include "virutil.h" #include "viralloc.h" #include "datatypes.h" -#include "xml.h" +#include "virxml.h" #include "nodeinfo.h" #include "virlog.h" #include "cpu/cpu.h" diff --git a/src/qemu/qemu_driver.c b/src/qemu/qemu_driver.c index 3821d74..d24527b 100644 --- a/src/qemu/qemu_driver.c +++ b/src/qemu/qemu_driver.c @@ -76,7 +76,7 @@ #include "virusb.h" #include "virprocess.h" #include "libvirt_internal.h" -#include "xml.h" +#include "virxml.h" #include "cpu/cpu.h" #include "virsysinfo.h" #include "domain_nwfilter.h" diff --git a/src/security/virt-aa-helper.c b/src/security/virt-aa-helper.c index 3c15226..ffd3f71 100644 --- a/src/security/virt-aa-helper.c +++ b/src/security/virt-aa-helper.c @@ -48,7 +48,7 @@ #include "security_driver.h" #include "security_apparmor.h" #include "domain_conf.h" -#include "xml.h" +#include "virxml.h" #include "viruuid.h" #include "virusb.h" #include "virpci.h" diff --git a/src/storage/storage_backend_fs.c b/src/storage/storage_backend_fs.c index b744fb4..23fa0f5 100644 --- a/src/storage/storage_backend_fs.c +++ b/src/storage/storage_backend_fs.c @@ -47,7 +47,7 @@ #include "virstoragefile.h" #include "vircommand.h" #include "viralloc.h" -#include "xml.h" +#include "virxml.h" #include "virfile.h" #include "virlog.h" diff --git a/src/test/test_driver.c b/src/test/test_driver.c index 1a85eb3..bd557d6 100644 --- a/src/test/test_driver.c +++ b/src/test/test_driver.c @@ -46,7 +46,7 @@ #include "domain_event.h" #include "storage_conf.h" #include "node_device_conf.h" -#include "xml.h" +#include "virxml.h" #include "virthread.h" #include "virlog.h" #include "virfile.h" diff --git a/src/util/virxml.c b/src/util/virxml.c new file mode 100644 index 0000000..02f7d1a --- /dev/null +++ b/src/util/virxml.c @@ -0,0 +1,890 @@ +/* + * xml.c: XML based interfaces for the libvir library + * + * Copyright (C) 2005, 2007-2012 Red Hat, Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library. If not, see + * <http://www.gnu.org/licenses/>;. + * + * Daniel Veillard <veillard(a)redhat.com&gt; + */ + +#include <config.h> + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <stdarg.h> +#include <limits.h> +#include <math.h> /* for isnan() */ +#include <sys/stat.h> + +#include "virterror_internal.h" +#include "virxml.h" +#include "virbuffer.h" +#include "virutil.h" +#include "viralloc.h" +#include "virfile.h" + +#define VIR_FROM_THIS VIR_FROM_XML + +#define virGenericReportError(from, code, ...) \ + virReportErrorHelper(from, code, __FILE__, \ + __FUNCTION__, __LINE__, __VA_ARGS__) + +/* Internal data to be passed to SAX parser and used by error handler. */ +struct virParserData { + int domcode; +}; + + +/************************************************************************ + * * + * Wrappers around libxml2 XPath specific functions * + * * + ************************************************************************/ + +/** + * virXPathString: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * + * Convenience function to evaluate an XPath string + * + * Returns a new string which must be deallocated by the caller or NULL + * if the evaluation failed. + */ +char * +virXPathString(const char *xpath, + xmlXPathContextPtr ctxt) +{ + xmlXPathObjectPtr obj; + xmlNodePtr relnode; + char *ret; + + if ((ctxt == NULL) || (xpath == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("Invalid parameter to virXPathString()")); + return NULL; + } + relnode = ctxt->node; + obj = xmlXPathEval(BAD_CAST xpath, ctxt); + ctxt->node = relnode; + if ((obj == NULL) || (obj->type != XPATH_STRING) || + (obj->stringval == NULL) || (obj->stringval[0] == 0)) { + xmlXPathFreeObject(obj); + return NULL; + } + ret = strdup((char *) obj->stringval); + xmlXPathFreeObject(obj); + if (ret == NULL) { + virReportOOMError(); + } + return ret; +} + +/** + * virXPathStringLimit: + * @xpath: the XPath string to evaluate + * @maxlen: maximum length permittred string + * @ctxt: an XPath context + * + * Wrapper for virXPathString, which validates the length of the returned + * string. + * + * Returns a new string which must be deallocated by the caller or NULL if + * the evaluation failed. + */ +char * +virXPathStringLimit(const char *xpath, + size_t maxlen, + xmlXPathContextPtr ctxt) +{ + char *tmp = virXPathString(xpath, ctxt); + + if (tmp != NULL && strlen(tmp) >= maxlen) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("\'%s\' value longer than %zu bytes"), + xpath, maxlen); + VIR_FREE(tmp); + return NULL; + } + + return tmp; +} + +/** + * virXPathNumber: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * @value: the returned double value + * + * Convenience function to evaluate an XPath number + * + * Returns 0 in case of success in which case @value is set, + * or -1 if the evaluation failed. + */ +int +virXPathNumber(const char *xpath, + xmlXPathContextPtr ctxt, + double *value) +{ + xmlXPathObjectPtr obj; + xmlNodePtr relnode; + + if ((ctxt == NULL) || (xpath == NULL) || (value == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("Invalid parameter to virXPathNumber()")); + return -1; + } + relnode = ctxt->node; + obj = xmlXPathEval(BAD_CAST xpath, ctxt); + ctxt->node = relnode; + if ((obj == NULL) || (obj->type != XPATH_NUMBER) || + (isnan(obj->floatval))) { + xmlXPathFreeObject(obj); + return -1; + } + + *value = obj->floatval; + xmlXPathFreeObject(obj); + return 0; +} + +static int +virXPathLongBase(const char *xpath, + xmlXPathContextPtr ctxt, + int base, + long *value) +{ + xmlXPathObjectPtr obj; + xmlNodePtr relnode; + int ret = 0; + + if ((ctxt == NULL) || (xpath == NULL) || (value == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("Invalid parameter to virXPathLong()")); + return -1; + } + relnode = ctxt->node; + obj = xmlXPathEval(BAD_CAST xpath, ctxt); + ctxt->node = relnode; + if ((obj != NULL) && (obj->type == XPATH_STRING) && + (obj->stringval != NULL) && (obj->stringval[0] != 0)) { + if (virStrToLong_l((char *) obj->stringval, NULL, base, value) < 0) + ret = -2; + } else if ((obj != NULL) && (obj->type == XPATH_NUMBER) && + (!(isnan(obj->floatval)))) { + *value = (long) obj->floatval; + if (*value != obj->floatval) { + ret = -2; + } + } else { + ret = -1; + } + + xmlXPathFreeObject(obj); + return ret; +} + +/** + * virXPathInt: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * @value: the returned int value + * + * Convenience function to evaluate an XPath number + * + * Returns 0 in case of success in which case @value is set, + * or -1 if the XPath evaluation failed or -2 if the + * value doesn't have an int format. + */ +int +virXPathInt(const char *xpath, + xmlXPathContextPtr ctxt, + int *value) +{ + long tmp; + int ret; + + ret = virXPathLongBase(xpath, ctxt, 10, &tmp); + if (ret < 0) + return ret; + if ((int) tmp != tmp) + return -2; + *value = tmp; + return 0; +} + +/** + * virXPathLong: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * @value: the returned long value + * + * Convenience function to evaluate an XPath number + * + * Returns 0 in case of success in which case @value is set, + * or -1 if the XPath evaluation failed or -2 if the + * value doesn't have a long format. + */ +int +virXPathLong(const char *xpath, + xmlXPathContextPtr ctxt, + long *value) +{ + return virXPathLongBase(xpath, ctxt, 10, value); +} + +/** + * virXPathLongHex: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * @value: the returned long value + * + * Convenience function to evaluate an XPath number + * according to a base of 16 + * + * Returns 0 in case of success in which case @value is set, + * or -1 if the XPath evaluation failed or -2 if the + * value doesn't have a long format. + */ +int +virXPathLongHex(const char *xpath, + xmlXPathContextPtr ctxt, + long *value) +{ + return virXPathLongBase(xpath, ctxt, 16, value); +} + +static int +virXPathULongBase(const char *xpath, + xmlXPathContextPtr ctxt, + int base, + unsigned long *value) +{ + xmlXPathObjectPtr obj; + xmlNodePtr relnode; + int ret = 0; + + if ((ctxt == NULL) || (xpath == NULL) || (value == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("Invalid parameter to virXPathULong()")); + return -1; + } + relnode = ctxt->node; + obj = xmlXPathEval(BAD_CAST xpath, ctxt); + ctxt->node = relnode; + if ((obj != NULL) && (obj->type == XPATH_STRING) && + (obj->stringval != NULL) && (obj->stringval[0] != 0)) { + if (virStrToLong_ul((char *) obj->stringval, NULL, base, value) < 0) + ret = -2; + } else if ((obj != NULL) && (obj->type == XPATH_NUMBER) && + (!(isnan(obj->floatval)))) { + *value = (unsigned long) obj->floatval; + if (*value != obj->floatval) { + ret = -2; + } + } else { + ret = -1; + } + + xmlXPathFreeObject(obj); + return ret; +} + +/** + * virXPathUInt: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * @value: the returned int value + * + * Convenience function to evaluate an XPath number + * + * Returns 0 in case of success in which case @value is set, + * or -1 if the XPath evaluation failed or -2 if the + * value doesn't have an int format. + */ +int +virXPathUInt(const char *xpath, + xmlXPathContextPtr ctxt, + unsigned int *value) +{ + unsigned long tmp; + int ret; + + ret = virXPathULongBase(xpath, ctxt, 10, &tmp); + if (ret < 0) + return ret; + if ((unsigned int) tmp != tmp) + return -2; + *value = tmp; + return 0; +} + +/** + * virXPathULong: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * @value: the returned long value + * + * Convenience function to evaluate an XPath number + * + * Returns 0 in case of success in which case @value is set, + * or -1 if the XPath evaluation failed or -2 if the + * value doesn't have a long format. + */ +int +virXPathULong(const char *xpath, + xmlXPathContextPtr ctxt, + unsigned long *value) +{ + return virXPathULongBase(xpath, ctxt, 10, value); +} + +/** + * virXPathUHex: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * @value: the returned long value + * + * Convenience function to evaluate an XPath number + * according to base of 16 + * + * Returns 0 in case of success in which case @value is set, + * or -1 if the XPath evaluation failed or -2 if the + * value doesn't have a long format. + */ +int +virXPathULongHex(const char *xpath, + xmlXPathContextPtr ctxt, + unsigned long *value) +{ + return virXPathULongBase(xpath, ctxt, 16, value); +} + +/** + * virXPathULongLong: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * @value: the returned long long value + * + * Convenience function to evaluate an XPath number + * + * Returns 0 in case of success in which case @value is set, + * or -1 if the XPath evaluation failed or -2 if the + * value doesn't have a long format. + */ +int +virXPathULongLong(const char *xpath, + xmlXPathContextPtr ctxt, + unsigned long long *value) +{ + xmlXPathObjectPtr obj; + xmlNodePtr relnode; + int ret = 0; + + if ((ctxt == NULL) || (xpath == NULL) || (value == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("Invalid parameter to virXPathULong()")); + return -1; + } + relnode = ctxt->node; + obj = xmlXPathEval(BAD_CAST xpath, ctxt); + ctxt->node = relnode; + if ((obj != NULL) && (obj->type == XPATH_STRING) && + (obj->stringval != NULL) && (obj->stringval[0] != 0)) { + if (virStrToLong_ull((char *) obj->stringval, NULL, 10, value) < 0) + ret = -2; + } else if ((obj != NULL) && (obj->type == XPATH_NUMBER) && + (!(isnan(obj->floatval)))) { + *value = (unsigned long long) obj->floatval; + if (*value != obj->floatval) { + ret = -2; + } + } else { + ret = -1; + } + + xmlXPathFreeObject(obj); + return ret; +} + +/** + * virXPathULongLong: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * @value: the returned long long value + * + * Convenience function to evaluate an XPath number + * + * Returns 0 in case of success in which case @value is set, + * or -1 if the XPath evaluation failed or -2 if the + * value doesn't have a long format. + */ +int +virXPathLongLong(const char *xpath, + xmlXPathContextPtr ctxt, + long long *value) +{ + xmlXPathObjectPtr obj; + xmlNodePtr relnode; + int ret = 0; + + if ((ctxt == NULL) || (xpath == NULL) || (value == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("Invalid parameter to virXPathLongLong()")); + return -1; + } + relnode = ctxt->node; + obj = xmlXPathEval(BAD_CAST xpath, ctxt); + ctxt->node = relnode; + if ((obj != NULL) && (obj->type == XPATH_STRING) && + (obj->stringval != NULL) && (obj->stringval[0] != 0)) { + if (virStrToLong_ll((char *) obj->stringval, NULL, 10, value) < 0) + ret = -2; + } else if ((obj != NULL) && (obj->type == XPATH_NUMBER) && + (!(isnan(obj->floatval)))) { + *value = (long long) obj->floatval; + if (*value != obj->floatval) { + ret = -2; + } + } else { + ret = -1; + } + + xmlXPathFreeObject(obj); + return ret; +} + +char * +virXMLPropString(xmlNodePtr node, + const char *name) +{ + return (char *)xmlGetProp(node, BAD_CAST name); +} + +/** + * virXPathBoolean: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * + * Convenience function to evaluate an XPath boolean + * + * Returns 0 if false, 1 if true, or -1 if the evaluation failed. + */ +int +virXPathBoolean(const char *xpath, + xmlXPathContextPtr ctxt) +{ + xmlXPathObjectPtr obj; + xmlNodePtr relnode; + int ret; + + if ((ctxt == NULL) || (xpath == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("Invalid parameter to virXPathBoolean()")); + return -1; + } + relnode = ctxt->node; + obj = xmlXPathEval(BAD_CAST xpath, ctxt); + ctxt->node = relnode; + if ((obj == NULL) || (obj->type != XPATH_BOOLEAN) || + (obj->boolval < 0) || (obj->boolval > 1)) { + xmlXPathFreeObject(obj); + return -1; + } + ret = obj->boolval; + + xmlXPathFreeObject(obj); + return ret; +} + +/** + * virXPathNode: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * + * Convenience function to evaluate an XPath node set and returning + * only one node, the first one in the set if any + * + * Returns a pointer to the node or NULL if the evaluation failed. + */ +xmlNodePtr +virXPathNode(const char *xpath, + xmlXPathContextPtr ctxt) +{ + xmlXPathObjectPtr obj; + xmlNodePtr relnode; + xmlNodePtr ret; + + if ((ctxt == NULL) || (xpath == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("Invalid parameter to virXPathNode()")); + return NULL; + } + relnode = ctxt->node; + obj = xmlXPathEval(BAD_CAST xpath, ctxt); + ctxt->node = relnode; + if ((obj == NULL) || (obj->type != XPATH_NODESET) || + (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr <= 0) || + (obj->nodesetval->nodeTab == NULL)) { + xmlXPathFreeObject(obj); + return NULL; + } + + ret = obj->nodesetval->nodeTab[0]; + xmlXPathFreeObject(obj); + return ret; +} + +/** + * virXPathNodeSet: + * @xpath: the XPath string to evaluate + * @ctxt: an XPath context + * @list: the returned list of nodes (or NULL if only count matters) + * + * Convenience function to evaluate an XPath node set + * + * Returns the number of nodes found in which case @list is set (and + * must be freed) or -1 if the evaluation failed. + */ +int +virXPathNodeSet(const char *xpath, + xmlXPathContextPtr ctxt, + xmlNodePtr **list) +{ + xmlXPathObjectPtr obj; + xmlNodePtr relnode; + int ret; + + if ((ctxt == NULL) || (xpath == NULL)) { + virReportError(VIR_ERR_INTERNAL_ERROR, + "%s", _("Invalid parameter to virXPathNodeSet()")); + return -1; + } + + if (list != NULL) + *list = NULL; + + relnode = ctxt->node; + obj = xmlXPathEval(BAD_CAST xpath, ctxt); + ctxt->node = relnode; + if (obj == NULL) + return 0; + + if (obj->type != XPATH_NODESET) { + virReportError(VIR_ERR_INTERNAL_ERROR, + _("Incorrect xpath '%s'"), xpath); + xmlXPathFreeObject(obj); + return -1; + } + + if ((obj->nodesetval == NULL) || (obj->nodesetval->nodeNr < 0)) { + xmlXPathFreeObject(obj); + return 0; + } + + ret = obj->nodesetval->nodeNr; + if (list != NULL && ret) { + if (VIR_ALLOC_N(*list, ret) < 0) { + virReportOOMError(); + ret = -1; + } else { + memcpy(*list, obj->nodesetval->nodeTab, + ret * sizeof(xmlNodePtr)); + } + } + xmlXPathFreeObject(obj); + return ret; +} + + +/** + * catchXMLError: + * + * Called from SAX on parsing errors in the XML. + * + * This version is heavily based on xmlParserPrintFileContextInternal from libxml2. + */ +static void +catchXMLError(void *ctx, const char *msg ATTRIBUTE_UNUSED, ...) +{ + xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx; + + const xmlChar *cur, *base; + unsigned int n, col; /* GCC warns if signed, because compared with sizeof() */ + int domcode = VIR_FROM_XML; + + virBuffer buf = VIR_BUFFER_INITIALIZER; + char *contextstr = NULL; + char *pointerstr = NULL; + + + /* conditions for error printing */ + if (!ctxt || + (virGetLastError() != NULL) || + ctxt->input == NULL || + ctxt->lastError.level != XML_ERR_FATAL || + ctxt->lastError.message == NULL) + return; + + if (ctxt->_private) + domcode = ((struct virParserData *) ctxt->_private)->domcode; + + + cur = ctxt->input->cur; + base = ctxt->input->base; + + /* skip backwards over any end-of-lines */ + while ((cur > base) && ((*(cur) == '\n') || (*(cur) == '\r'))) { + cur--; + } + + /* search backwards for beginning-of-line (to max buff size) */ + while ((cur > base) && (*(cur) != '\n') && (*(cur) != '\r')) + cur--; + if ((*(cur) == '\n') || (*(cur) == '\r')) cur++; + + /* calculate the error position in terms of the current position */ + col = ctxt->input->cur - cur; + + /* search forward for end-of-line (to max buff size) */ + /* copy selected text to our buffer */ + while ((*cur != 0) && (*(cur) != '\n') && (*(cur) != '\r')) { + virBufferAddChar(&buf, *cur++); + } + + /* create blank line with problem pointer */ + contextstr = virBufferContentAndReset(&buf); + + /* (leave buffer space for pointer + line terminator) */ + for (n = 0; (n<col) && (contextstr[n] != 0); n++) { + if (contextstr[n] == '\t') + virBufferAddChar(&buf, '\t'); + else + virBufferAddChar(&buf, '-'); + } + + virBufferAddChar(&buf, '^'); + + pointerstr = virBufferContentAndReset(&buf); + + if (ctxt->lastError.file) { + virGenericReportError(domcode, VIR_ERR_XML_DETAIL, + _("%s:%d: %s%s\n%s"), + ctxt->lastError.file, + ctxt->lastError.line, + ctxt->lastError.message, + contextstr, + pointerstr); + } else { + virGenericReportError(domcode, VIR_ERR_XML_DETAIL, + _("at line %d: %s%s\n%s"), + ctxt->lastError.line, + ctxt->lastError.message, + contextstr, + pointerstr); + } + + VIR_FREE(contextstr); + VIR_FREE(pointerstr); +} + +/** + * virXMLParseHelper: + * @domcode: error domain of the caller, usually VIR_FROM_THIS + * @filename: file to be parsed or NULL if string parsing is requested + * @xmlStr: XML string to be parsed in case filename is NULL + * @url: URL of XML document for string parser + * @ctxt: optional pointer to populate with new context pointer + * + * Parse XML document provided either as a file or a string. The function + * guarantees that the XML document contains a root element. + * + * Returns parsed XML document. + */ +xmlDocPtr +virXMLParseHelper(int domcode, + const char *filename, + const char *xmlStr, + const char *url, + xmlXPathContextPtr *ctxt) +{ + struct virParserData private; + xmlParserCtxtPtr pctxt; + xmlDocPtr xml = NULL; + + /* Set up a parser context so we can catch the details of XML errors. */ + pctxt = xmlNewParserCtxt(); + if (!pctxt || !pctxt->sax) { + virReportOOMError(); + goto error; + } + + private.domcode = domcode; + pctxt->_private = &private; + pctxt->sax->error = catchXMLError; + + if (filename) { + xml = xmlCtxtReadFile(pctxt, filename, NULL, + XML_PARSE_NOENT | XML_PARSE_NONET | + XML_PARSE_NOWARNING); + } else { + xml = xmlCtxtReadDoc(pctxt, BAD_CAST xmlStr, url, NULL, + XML_PARSE_NOENT | XML_PARSE_NONET | + XML_PARSE_NOWARNING); + } + if (!xml) + goto error; + + if (xmlDocGetRootElement(xml) == NULL) { + virGenericReportError(domcode, VIR_ERR_INTERNAL_ERROR, + "%s", _("missing root element")); + goto error; + } + + if (ctxt) { + *ctxt = xmlXPathNewContext(xml); + if (!*ctxt) { + virReportOOMError(); + goto error; + } + (*ctxt)->node = xmlDocGetRootElement(xml); + } + +cleanup: + xmlFreeParserCtxt(pctxt); + + return xml; + +error: + xmlFreeDoc(xml); + xml = NULL; + + if (virGetLastError() == NULL) { + virGenericReportError(domcode, VIR_ERR_XML_ERROR, + "%s", _("failed to parse xml document")); + } + goto cleanup; +} + +const char *virXMLPickShellSafeComment(const char *str1, const char *str2) +{ + if (str1 && !strpbrk(str1, "\r\t\n !\"#$&'()*;<>?[\\]^`{|}~") && + !strstr(str1, "--")) + return str1; + if (str2 && !strpbrk(str2, "\r\t\n !\"#$&'()*;<>?[\\]^`{|}~") && + !strstr(str2, "--")) + return str2; + return NULL; +} + +static int virXMLEmitWarning(int fd, + const char *name, + const char *cmd) +{ + size_t len; + const char *prologue = + "<!--\n" + "WARNING: THIS IS AN AUTO-GENERATED FILE. CHANGES TO IT ARE LIKELY TO BE\n" + "OVERWRITTEN AND LOST. Changes to this xml configuration should be made using:\n" + " virsh "; + const char *epilogue = + "\n" + "or other application using the libvirt API.\n" + "-->\n\n"; + + if (fd < 0 || !cmd) { + errno = EINVAL; + return -1; + } + + len = strlen(prologue); + if (safewrite(fd, prologue, len) != len) + return -1; + + len = strlen(cmd); + if (safewrite(fd, cmd, len) != len) + return -1; + + if (name) { + if (safewrite(fd, " ", 1) != 1) + return -1; + + len = strlen(name); + if (safewrite(fd, name, len) != len) + return -1; + } + + len = strlen(epilogue); + if (safewrite(fd, epilogue, len) != len) + return -1; + + return 0; +} + + +struct virXMLRewriteFileData { + const char *warnName; + const char *warnCommand; + const char *xml; +}; + +static int +virXMLRewriteFile(int fd, void *opaque) +{ + struct virXMLRewriteFileData *data = opaque; + + if (data->warnCommand) { + if (virXMLEmitWarning(fd, data->warnName, data->warnCommand) < 0) + return -1; + } + + if (safewrite(fd, data->xml, strlen(data->xml)) < 0) + return -1; + + return 0; +} + +int +virXMLSaveFile(const char *path, + const char *warnName, + const char *warnCommand, + const char *xml) +{ + struct virXMLRewriteFileData data = { warnName, warnCommand, xml }; + + return virFileRewrite(path, S_IRUSR | S_IWUSR, virXMLRewriteFile, &data); +} + +/* Returns the number of children of node, or -1 on error. */ +long +virXMLChildElementCount(xmlNodePtr node) +{ + long ret = 0; + xmlNodePtr cur = NULL; + + /* xmlChildElementCount returns 0 on error, which isn't helpful; + * besides, it is not available in libxml2 2.6. */ + if (!node || node->type != XML_ELEMENT_NODE) + return -1; + cur = node->children; + while (cur) { + if (cur->type == XML_ELEMENT_NODE) + ret++; + cur = cur->next; + } + return ret; +} diff --git a/src/util/virxml.h b/src/util/virxml.h new file mode 100644 index 0000000..c3b05df --- /dev/null +++ b/src/util/virxml.h @@ -0,0 +1,148 @@ +/* + * xml.h: internal definitions used for XML parsing routines. + */ + +#ifndef __VIR_XML_H__ +# define __VIR_XML_H__ + +# include "internal.h" + +# include <libxml/parser.h> +# include <libxml/tree.h> +# include <libxml/xpath.h> + +int virXPathBoolean(const char *xpath, + xmlXPathContextPtr ctxt); +char * virXPathString(const char *xpath, + xmlXPathContextPtr ctxt); +char * virXPathStringLimit(const char *xpath, + size_t maxlen, + xmlXPathContextPtr ctxt); +int virXPathNumber(const char *xpath, + xmlXPathContextPtr ctxt, + double *value); +int virXPathInt(const char *xpath, + xmlXPathContextPtr ctxt, + int *value); +int virXPathUInt(const char *xpath, + xmlXPathContextPtr ctxt, + unsigned int *value); +int virXPathLong(const char *xpath, + xmlXPathContextPtr ctxt, + long *value); +int virXPathULong(const char *xpath, + xmlXPathContextPtr ctxt, + unsigned long *value); +int virXPathULongLong(const char *xpath, + xmlXPathContextPtr ctxt, + unsigned long long *value); +int virXPathLongLong(const char *xpath, + xmlXPathContextPtr ctxt, + long long *value); +int virXPathLongHex(const char *xpath, + xmlXPathContextPtr ctxt, + long *value); +int virXPathULongHex(const char *xpath, + xmlXPathContextPtr ctxt, + unsigned long *value); +xmlNodePtr virXPathNode(const char *xpath, + xmlXPathContextPtr ctxt); +int virXPathNodeSet(const char *xpath, + xmlXPathContextPtr ctxt, + xmlNodePtr **list); +char * virXMLPropString(xmlNodePtr node, + const char *name); +long virXMLChildElementCount(xmlNodePtr node); + +/* Internal function; prefer the macros below. */ +xmlDocPtr virXMLParseHelper(int domcode, + const char *filename, + const char *xmlStr, + const char *url, + xmlXPathContextPtr *pctxt); + +const char *virXMLPickShellSafeComment(const char *str1, const char *str2); +/** + * virXMLParse: + * @filename: file to parse, or NULL for string parsing + * @xmlStr: if @filename is NULL, a string to parse + * @url: if @filename is NULL, an optional filename to attribute the parse to + * + * Parse xml from either a file or a string. + * + * Return the parsed document object, or NULL on failure. + */ +# define virXMLParse(filename, xmlStr, url) \ + virXMLParseHelper(VIR_FROM_THIS, filename, xmlStr, url, NULL) + +/** + * virXMLParseString: + * @xmlStr: a string to parse + * @url: an optional filename to attribute the parse to + * + * Parse xml from a string. + * + * Return the parsed document object, or NULL on failure. + */ +# define virXMLParseString(xmlStr, url) \ + virXMLParseHelper(VIR_FROM_THIS, NULL, xmlStr, url, NULL) + +/** + * virXMLParseFile: + * @filename: file to parse + * + * Parse xml from a file. + * + * Return the parsed document object, or NULL on failure. + */ +# define virXMLParseFile(filename) \ + virXMLParseHelper(VIR_FROM_THIS, filename, NULL, NULL, NULL) + +/** + * virXMLParseCtxt: + * @filename: file to parse, or NULL for string parsing + * @xmlStr: if @filename is NULL, a string to parse + * @url: if @filename is NULL, an optional filename to attribute the parse to + * @pctxt: if non-NULL, populate with a new context object on success, + * with (*pctxt)->node pre-set to the root node + * + * Parse xml from either a file or a string. + * + * Return the parsed document object, or NULL on failure. + */ +# define virXMLParseCtxt(filename, xmlStr, url, pctxt) \ + virXMLParseHelper(VIR_FROM_THIS, filename, xmlStr, url, pctxt) + +/** + * virXMLParseStringCtxt: + * @xmlStr: a string to parse + * @url: an optional filename to attribute the parse to + * @pctxt: if non-NULL, populate with a new context object on success, + * with (*pctxt)->node pre-set to the root node + * + * Parse xml from a string. + * + * Return the parsed document object, or NULL on failure. + */ +# define virXMLParseStringCtxt(xmlStr, url, pctxt) \ + virXMLParseHelper(VIR_FROM_THIS, NULL, xmlStr, url, pctxt) + +/** + * virXMLParseFileCtxt: + * @filename: file to parse + * @pctxt: if non-NULL, populate with a new context object on success, + * with (*pctxt)->node pre-set to the root node + * + * Parse xml from a file. + * + * Return the parsed document object, or NULL on failure. + */ +# define virXMLParseFileCtxt(filename, pctxt) \ + virXMLParseHelper(VIR_FROM_THIS, filename, NULL, NULL, pctxt) + +int virXMLSaveFile(const char *path, + const char *warnName, + const char *warnCommand, + const char *xml); + +#endif /* __VIR_XML_H__ */ diff --git a/src/util/xml.c b/src/util/xml.c deleted file mode 100644 index 05c7f33..0000000 --- a/src/util/xml.c +++ /dev/null @@ -1,890 +0,0 @@ -/* - * xml.c: XML based interfaces for the libvir library - * - * Copyright (C) 2005, 2007-2012 Red Hat, Inc. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library. If not, see - * <http://www.gnu.org/licenses/>;. - * - * Daniel Veillard <veillard(a)redhat.com&gt; - */ - -#include <config.h> - -#include <stdio.h> -#include <stdlib.h> -#include <string.h> -#include <stdarg.h> -#include <limits.h> -#include <math.h> /* for isnan() */ -#include <sys/stat.h> - -#include "virterror_internal.h" -#include "xml.h" -#include "virbuffer.h" -#include "virutil.h" -#include "viralloc.h" -#include "virfile.h" - -#define VIR_FROM_THIS VIR_FROM_XML - -#define virGenericReportError(from, code, ...) \ - virReportErrorHelper(from, code, __FILE__, \ - __FUNCTION__, __LINE__, __VA_ARGS__) - -/* Internal data to be passed to SAX parser and used by error handler. */ -struct virParserData { - int domcode; -}; - - -/************************************************************************ - * * - * Wrappers around libxml2 XPath specific functions * - * * - ************************************************************************/ - -/** - * virXPathString: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * - * Convenience function to evaluate an XPath string - * - * Returns a new string which must be deallocated by the caller or NULL - * if the evaluation failed. - */ -char * -virXPathString(const char *xpath, - xmlXPathContextPtr ctxt) -{ - xmlXPathObjectPtr obj; - xmlNodePtr relnode; - char *ret; - - if ((ctxt == NULL) || (xpath == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("Invalid parameter to virXPathString()")); - return NULL; - } - relnode = ctxt->node; - obj = xmlXPathEval(BAD_CAST xpath, ctxt); - ctxt->node = relnode; - if ((obj == NULL) || (obj->type != XPATH_STRING) || - (obj->stringval == NULL) || (obj->stringval[0] == 0)) { - xmlXPathFreeObject(obj); - return NULL; - } - ret = strdup((char *) obj->stringval); - xmlXPathFreeObject(obj); - if (ret == NULL) { - virReportOOMError(); - } - return ret; -} - -/** - * virXPathStringLimit: - * @xpath: the XPath string to evaluate - * @maxlen: maximum length permittred string - * @ctxt: an XPath context - * - * Wrapper for virXPathString, which validates the length of the returned - * string. - * - * Returns a new string which must be deallocated by the caller or NULL if - * the evaluation failed. - */ -char * -virXPathStringLimit(const char *xpath, - size_t maxlen, - xmlXPathContextPtr ctxt) -{ - char *tmp = virXPathString(xpath, ctxt); - - if (tmp != NULL && strlen(tmp) >= maxlen) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("\'%s\' value longer than %zu bytes"), - xpath, maxlen); - VIR_FREE(tmp); - return NULL; - } - - return tmp; -} - -/** - * virXPathNumber: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * @value: the returned double value - * - * Convenience function to evaluate an XPath number - * - * Returns 0 in case of success in which case @value is set, - * or -1 if the evaluation failed. - */ -int -virXPathNumber(const char *xpath, - xmlXPathContextPtr ctxt, - double *value) -{ - xmlXPathObjectPtr obj; - xmlNodePtr relnode; - - if ((ctxt == NULL) || (xpath == NULL) || (value == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("Invalid parameter to virXPathNumber()")); - return -1; - } - relnode = ctxt->node; - obj = xmlXPathEval(BAD_CAST xpath, ctxt); - ctxt->node = relnode; - if ((obj == NULL) || (obj->type != XPATH_NUMBER) || - (isnan(obj->floatval))) { - xmlXPathFreeObject(obj); - return -1; - } - - *value = obj->floatval; - xmlXPathFreeObject(obj); - return 0; -} - -static int -virXPathLongBase(const char *xpath, - xmlXPathContextPtr ctxt, - int base, - long *value) -{ - xmlXPathObjectPtr obj; - xmlNodePtr relnode; - int ret = 0; - - if ((ctxt == NULL) || (xpath == NULL) || (value == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("Invalid parameter to virXPathLong()")); - return -1; - } - relnode = ctxt->node; - obj = xmlXPathEval(BAD_CAST xpath, ctxt); - ctxt->node = relnode; - if ((obj != NULL) && (obj->type == XPATH_STRING) && - (obj->stringval != NULL) && (obj->stringval[0] != 0)) { - if (virStrToLong_l((char *) obj->stringval, NULL, base, value) < 0) - ret = -2; - } else if ((obj != NULL) && (obj->type == XPATH_NUMBER) && - (!(isnan(obj->floatval)))) { - *value = (long) obj->floatval; - if (*value != obj->floatval) { - ret = -2; - } - } else { - ret = -1; - } - - xmlXPathFreeObject(obj); - return ret; -} - -/** - * virXPathInt: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * @value: the returned int value - * - * Convenience function to evaluate an XPath number - * - * Returns 0 in case of success in which case @value is set, - * or -1 if the XPath evaluation failed or -2 if the - * value doesn't have an int format. - */ -int -virXPathInt(const char *xpath, - xmlXPathContextPtr ctxt, - int *value) -{ - long tmp; - int ret; - - ret = virXPathLongBase(xpath, ctxt, 10, &tmp); - if (ret < 0) - return ret; - if ((int) tmp != tmp) - return -2; - *value = tmp; - return 0; -} - -/** - * virXPathLong: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * @value: the returned long value - * - * Convenience function to evaluate an XPath number - * - * Returns 0 in case of success in which case @value is set, - * or -1 if the XPath evaluation failed or -2 if the - * value doesn't have a long format. - */ -int -virXPathLong(const char *xpath, - xmlXPathContextPtr ctxt, - long *value) -{ - return virXPathLongBase(xpath, ctxt, 10, value); -} - -/** - * virXPathLongHex: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * @value: the returned long value - * - * Convenience function to evaluate an XPath number - * according to a base of 16 - * - * Returns 0 in case of success in which case @value is set, - * or -1 if the XPath evaluation failed or -2 if the - * value doesn't have a long format. - */ -int -virXPathLongHex(const char *xpath, - xmlXPathContextPtr ctxt, - long *value) -{ - return virXPathLongBase(xpath, ctxt, 16, value); -} - -static int -virXPathULongBase(const char *xpath, - xmlXPathContextPtr ctxt, - int base, - unsigned long *value) -{ - xmlXPathObjectPtr obj; - xmlNodePtr relnode; - int ret = 0; - - if ((ctxt == NULL) || (xpath == NULL) || (value == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("Invalid parameter to virXPathULong()")); - return -1; - } - relnode = ctxt->node; - obj = xmlXPathEval(BAD_CAST xpath, ctxt); - ctxt->node = relnode; - if ((obj != NULL) && (obj->type == XPATH_STRING) && - (obj->stringval != NULL) && (obj->stringval[0] != 0)) { - if (virStrToLong_ul((char *) obj->stringval, NULL, base, value) < 0) - ret = -2; - } else if ((obj != NULL) && (obj->type == XPATH_NUMBER) && - (!(isnan(obj->floatval)))) { - *value = (unsigned long) obj->floatval; - if (*value != obj->floatval) { - ret = -2; - } - } else { - ret = -1; - } - - xmlXPathFreeObject(obj); - return ret; -} - -/** - * virXPathUInt: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * @value: the returned int value - * - * Convenience function to evaluate an XPath number - * - * Returns 0 in case of success in which case @value is set, - * or -1 if the XPath evaluation failed or -2 if the - * value doesn't have an int format. - */ -int -virXPathUInt(const char *xpath, - xmlXPathContextPtr ctxt, - unsigned int *value) -{ - unsigned long tmp; - int ret; - - ret = virXPathULongBase(xpath, ctxt, 10, &tmp); - if (ret < 0) - return ret; - if ((unsigned int) tmp != tmp) - return -2; - *value = tmp; - return 0; -} - -/** - * virXPathULong: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * @value: the returned long value - * - * Convenience function to evaluate an XPath number - * - * Returns 0 in case of success in which case @value is set, - * or -1 if the XPath evaluation failed or -2 if the - * value doesn't have a long format. - */ -int -virXPathULong(const char *xpath, - xmlXPathContextPtr ctxt, - unsigned long *value) -{ - return virXPathULongBase(xpath, ctxt, 10, value); -} - -/** - * virXPathUHex: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * @value: the returned long value - * - * Convenience function to evaluate an XPath number - * according to base of 16 - * - * Returns 0 in case of success in which case @value is set, - * or -1 if the XPath evaluation failed or -2 if the - * value doesn't have a long format. - */ -int -virXPathULongHex(const char *xpath, - xmlXPathContextPtr ctxt, - unsigned long *value) -{ - return virXPathULongBase(xpath, ctxt, 16, value); -} - -/** - * virXPathULongLong: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * @value: the returned long long value - * - * Convenience function to evaluate an XPath number - * - * Returns 0 in case of success in which case @value is set, - * or -1 if the XPath evaluation failed or -2 if the - * value doesn't have a long format. - */ -int -virXPathULongLong(const char *xpath, - xmlXPathContextPtr ctxt, - unsigned long long *value) -{ - xmlXPathObjectPtr obj; - xmlNodePtr relnode; - int ret = 0; - - if ((ctxt == NULL) || (xpath == NULL) || (value == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("Invalid parameter to virXPathULong()")); - return -1; - } - relnode = ctxt->node; - obj = xmlXPathEval(BAD_CAST xpath, ctxt); - ctxt->node = relnode; - if ((obj != NULL) && (obj->type == XPATH_STRING) && - (obj->stringval != NULL) && (obj->stringval[0] != 0)) { - if (virStrToLong_ull((char *) obj->stringval, NULL, 10, value) < 0) - ret = -2; - } else if ((obj != NULL) && (obj->type == XPATH_NUMBER) && - (!(isnan(obj->floatval)))) { - *value = (unsigned long long) obj->floatval; - if (*value != obj->floatval) { - ret = -2; - } - } else { - ret = -1; - } - - xmlXPathFreeObject(obj); - return ret; -} - -/** - * virXPathULongLong: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * @value: the returned long long value - * - * Convenience function to evaluate an XPath number - * - * Returns 0 in case of success in which case @value is set, - * or -1 if the XPath evaluation failed or -2 if the - * value doesn't have a long format. - */ -int -virXPathLongLong(const char *xpath, - xmlXPathContextPtr ctxt, - long long *value) -{ - xmlXPathObjectPtr obj; - xmlNodePtr relnode; - int ret = 0; - - if ((ctxt == NULL) || (xpath == NULL) || (value == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("Invalid parameter to virXPathLongLong()")); - return -1; - } - relnode = ctxt->node; - obj = xmlXPathEval(BAD_CAST xpath, ctxt); - ctxt->node = relnode; - if ((obj != NULL) && (obj->type == XPATH_STRING) && - (obj->stringval != NULL) && (obj->stringval[0] != 0)) { - if (virStrToLong_ll((char *) obj->stringval, NULL, 10, value) < 0) - ret = -2; - } else if ((obj != NULL) && (obj->type == XPATH_NUMBER) && - (!(isnan(obj->floatval)))) { - *value = (long long) obj->floatval; - if (*value != obj->floatval) { - ret = -2; - } - } else { - ret = -1; - } - - xmlXPathFreeObject(obj); - return ret; -} - -char * -virXMLPropString(xmlNodePtr node, - const char *name) -{ - return (char *)xmlGetProp(node, BAD_CAST name); -} - -/** - * virXPathBoolean: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * - * Convenience function to evaluate an XPath boolean - * - * Returns 0 if false, 1 if true, or -1 if the evaluation failed. - */ -int -virXPathBoolean(const char *xpath, - xmlXPathContextPtr ctxt) -{ - xmlXPathObjectPtr obj; - xmlNodePtr relnode; - int ret; - - if ((ctxt == NULL) || (xpath == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("Invalid parameter to virXPathBoolean()")); - return -1; - } - relnode = ctxt->node; - obj = xmlXPathEval(BAD_CAST xpath, ctxt); - ctxt->node = relnode; - if ((obj == NULL) || (obj->type != XPATH_BOOLEAN) || - (obj->boolval < 0) || (obj->boolval > 1)) { - xmlXPathFreeObject(obj); - return -1; - } - ret = obj->boolval; - - xmlXPathFreeObject(obj); - return ret; -} - -/** - * virXPathNode: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * - * Convenience function to evaluate an XPath node set and returning - * only one node, the first one in the set if any - * - * Returns a pointer to the node or NULL if the evaluation failed. - */ -xmlNodePtr -virXPathNode(const char *xpath, - xmlXPathContextPtr ctxt) -{ - xmlXPathObjectPtr obj; - xmlNodePtr relnode; - xmlNodePtr ret; - - if ((ctxt == NULL) || (xpath == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("Invalid parameter to virXPathNode()")); - return NULL; - } - relnode = ctxt->node; - obj = xmlXPathEval(BAD_CAST xpath, ctxt); - ctxt->node = relnode; - if ((obj == NULL) || (obj->type != XPATH_NODESET) || - (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr <= 0) || - (obj->nodesetval->nodeTab == NULL)) { - xmlXPathFreeObject(obj); - return NULL; - } - - ret = obj->nodesetval->nodeTab[0]; - xmlXPathFreeObject(obj); - return ret; -} - -/** - * virXPathNodeSet: - * @xpath: the XPath string to evaluate - * @ctxt: an XPath context - * @list: the returned list of nodes (or NULL if only count matters) - * - * Convenience function to evaluate an XPath node set - * - * Returns the number of nodes found in which case @list is set (and - * must be freed) or -1 if the evaluation failed. - */ -int -virXPathNodeSet(const char *xpath, - xmlXPathContextPtr ctxt, - xmlNodePtr **list) -{ - xmlXPathObjectPtr obj; - xmlNodePtr relnode; - int ret; - - if ((ctxt == NULL) || (xpath == NULL)) { - virReportError(VIR_ERR_INTERNAL_ERROR, - "%s", _("Invalid parameter to virXPathNodeSet()")); - return -1; - } - - if (list != NULL) - *list = NULL; - - relnode = ctxt->node; - obj = xmlXPathEval(BAD_CAST xpath, ctxt); - ctxt->node = relnode; - if (obj == NULL) - return 0; - - if (obj->type != XPATH_NODESET) { - virReportError(VIR_ERR_INTERNAL_ERROR, - _("Incorrect xpath '%s'"), xpath); - xmlXPathFreeObject(obj); - return -1; - } - - if ((obj->nodesetval == NULL) || (obj->nodesetval->nodeNr < 0)) { - xmlXPathFreeObject(obj); - return 0; - } - - ret = obj->nodesetval->nodeNr; - if (list != NULL && ret) { - if (VIR_ALLOC_N(*list, ret) < 0) { - virReportOOMError(); - ret = -1; - } else { - memcpy(*list, obj->nodesetval->nodeTab, - ret * sizeof(xmlNodePtr)); - } - } - xmlXPathFreeObject(obj); - return ret; -} - - -/** - * catchXMLError: - * - * Called from SAX on parsing errors in the XML. - * - * This version is heavily based on xmlParserPrintFileContextInternal from libxml2. - */ -static void -catchXMLError(void *ctx, const char *msg ATTRIBUTE_UNUSED, ...) -{ - xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx; - - const xmlChar *cur, *base; - unsigned int n, col; /* GCC warns if signed, because compared with sizeof() */ - int domcode = VIR_FROM_XML; - - virBuffer buf = VIR_BUFFER_INITIALIZER; - char *contextstr = NULL; - char *pointerstr = NULL; - - - /* conditions for error printing */ - if (!ctxt || - (virGetLastError() != NULL) || - ctxt->input == NULL || - ctxt->lastError.level != XML_ERR_FATAL || - ctxt->lastError.message == NULL) - return; - - if (ctxt->_private) - domcode = ((struct virParserData *) ctxt->_private)->domcode; - - - cur = ctxt->input->cur; - base = ctxt->input->base; - - /* skip backwards over any end-of-lines */ - while ((cur > base) && ((*(cur) == '\n') || (*(cur) == '\r'))) { - cur--; - } - - /* search backwards for beginning-of-line (to max buff size) */ - while ((cur > base) && (*(cur) != '\n') && (*(cur) != '\r')) - cur--; - if ((*(cur) == '\n') || (*(cur) == '\r')) cur++; - - /* calculate the error position in terms of the current position */ - col = ctxt->input->cur - cur; - - /* search forward for end-of-line (to max buff size) */ - /* copy selected text to our buffer */ - while ((*cur != 0) && (*(cur) != '\n') && (*(cur) != '\r')) { - virBufferAddChar(&buf, *cur++); - } - - /* create blank line with problem pointer */ - contextstr = virBufferContentAndReset(&buf); - - /* (leave buffer space for pointer + line terminator) */ - for (n = 0; (n<col) && (contextstr[n] != 0); n++) { - if (contextstr[n] == '\t') - virBufferAddChar(&buf, '\t'); - else - virBufferAddChar(&buf, '-'); - } - - virBufferAddChar(&buf, '^'); - - pointerstr = virBufferContentAndReset(&buf); - - if (ctxt->lastError.file) { - virGenericReportError(domcode, VIR_ERR_XML_DETAIL, - _("%s:%d: %s%s\n%s"), - ctxt->lastError.file, - ctxt->lastError.line, - ctxt->lastError.message, - contextstr, - pointerstr); - } else { - virGenericReportError(domcode, VIR_ERR_XML_DETAIL, - _("at line %d: %s%s\n%s"), - ctxt->lastError.line, - ctxt->lastError.message, - contextstr, - pointerstr); - } - - VIR_FREE(contextstr); - VIR_FREE(pointerstr); -} - -/** - * virXMLParseHelper: - * @domcode: error domain of the caller, usually VIR_FROM_THIS - * @filename: file to be parsed or NULL if string parsing is requested - * @xmlStr: XML string to be parsed in case filename is NULL - * @url: URL of XML document for string parser - * @ctxt: optional pointer to populate with new context pointer - * - * Parse XML document provided either as a file or a string. The function - * guarantees that the XML document contains a root element. - * - * Returns parsed XML document. - */ -xmlDocPtr -virXMLParseHelper(int domcode, - const char *filename, - const char *xmlStr, - const char *url, - xmlXPathContextPtr *ctxt) -{ - struct virParserData private; - xmlParserCtxtPtr pctxt; - xmlDocPtr xml = NULL; - - /* Set up a parser context so we can catch the details of XML errors. */ - pctxt = xmlNewParserCtxt(); - if (!pctxt || !pctxt->sax) { - virReportOOMError(); - goto error; - } - - private.domcode = domcode; - pctxt->_private = &private; - pctxt->sax->error = catchXMLError; - - if (filename) { - xml = xmlCtxtReadFile(pctxt, filename, NULL, - XML_PARSE_NOENT | XML_PARSE_NONET | - XML_PARSE_NOWARNING); - } else { - xml = xmlCtxtReadDoc(pctxt, BAD_CAST xmlStr, url, NULL, - XML_PARSE_NOENT | XML_PARSE_NONET | - XML_PARSE_NOWARNING); - } - if (!xml) - goto error; - - if (xmlDocGetRootElement(xml) == NULL) { - virGenericReportError(domcode, VIR_ERR_INTERNAL_ERROR, - "%s", _("missing root element")); - goto error; - } - - if (ctxt) { - *ctxt = xmlXPathNewContext(xml); - if (!*ctxt) { - virReportOOMError(); - goto error; - } - (*ctxt)->node = xmlDocGetRootElement(xml); - } - -cleanup: - xmlFreeParserCtxt(pctxt); - - return xml; - -error: - xmlFreeDoc(xml); - xml = NULL; - - if (virGetLastError() == NULL) { - virGenericReportError(domcode, VIR_ERR_XML_ERROR, - "%s", _("failed to parse xml document")); - } - goto cleanup; -} - -const char *virXMLPickShellSafeComment(const char *str1, const char *str2) -{ - if (str1 && !strpbrk(str1, "\r\t\n !\"#$&'()*;<>?[\\]^`{|}~") && - !strstr(str1, "--")) - return str1; - if (str2 && !strpbrk(str2, "\r\t\n !\"#$&'()*;<>?[\\]^`{|}~") && - !strstr(str2, "--")) - return str2; - return NULL; -} - -static int virXMLEmitWarning(int fd, - const char *name, - const char *cmd) -{ - size_t len; - const char *prologue = - "<!--\n" - "WARNING: THIS IS AN AUTO-GENERATED FILE. CHANGES TO IT ARE LIKELY TO BE\n" - "OVERWRITTEN AND LOST. Changes to this xml configuration should be made using:\n" - " virsh "; - const char *epilogue = - "\n" - "or other application using the libvirt API.\n" - "-->\n\n"; - - if (fd < 0 || !cmd) { - errno = EINVAL; - return -1; - } - - len = strlen(prologue); - if (safewrite(fd, prologue, len) != len) - return -1; - - len = strlen(cmd); - if (safewrite(fd, cmd, len) != len) - return -1; - - if (name) { - if (safewrite(fd, " ", 1) != 1) - return -1; - - len = strlen(name); - if (safewrite(fd, name, len) != len) - return -1; - } - - len = strlen(epilogue); - if (safewrite(fd, epilogue, len) != len) - return -1; - - return 0; -} - - -struct virXMLRewriteFileData { - const char *warnName; - const char *warnCommand; - const char *xml; -}; - -static int -virXMLRewriteFile(int fd, void *opaque) -{ - struct virXMLRewriteFileData *data = opaque; - - if (data->warnCommand) { - if (virXMLEmitWarning(fd, data->warnName, data->warnCommand) < 0) - return -1; - } - - if (safewrite(fd, data->xml, strlen(data->xml)) < 0) - return -1; - - return 0; -} - -int -virXMLSaveFile(const char *path, - const char *warnName, - const char *warnCommand, - const char *xml) -{ - struct virXMLRewriteFileData data = { warnName, warnCommand, xml }; - - return virFileRewrite(path, S_IRUSR | S_IWUSR, virXMLRewriteFile, &data); -} - -/* Returns the number of children of node, or -1 on error. */ -long -virXMLChildElementCount(xmlNodePtr node) -{ - long ret = 0; - xmlNodePtr cur = NULL; - - /* xmlChildElementCount returns 0 on error, which isn't helpful; - * besides, it is not available in libxml2 2.6. */ - if (!node || node->type != XML_ELEMENT_NODE) - return -1; - cur = node->children; - while (cur) { - if (cur->type == XML_ELEMENT_NODE) - ret++; - cur = cur->next; - } - return ret; -} diff --git a/src/util/xml.h b/src/util/xml.h deleted file mode 100644 index c3b05df..0000000 --- a/src/util/xml.h +++ /dev/null @@ -1,148 +0,0 @@ -/* - * xml.h: internal definitions used for XML parsing routines. - */ - -#ifndef __VIR_XML_H__ -# define __VIR_XML_H__ - -# include "internal.h" - -# include <libxml/parser.h> -# include <libxml/tree.h> -# include <libxml/xpath.h> - -int virXPathBoolean(const char *xpath, - xmlXPathContextPtr ctxt); -char * virXPathString(const char *xpath, - xmlXPathContextPtr ctxt); -char * virXPathStringLimit(const char *xpath, - size_t maxlen, - xmlXPathContextPtr ctxt); -int virXPathNumber(const char *xpath, - xmlXPathContextPtr ctxt, - double *value); -int virXPathInt(const char *xpath, - xmlXPathContextPtr ctxt, - int *value); -int virXPathUInt(const char *xpath, - xmlXPathContextPtr ctxt, - unsigned int *value); -int virXPathLong(const char *xpath, - xmlXPathContextPtr ctxt, - long *value); -int virXPathULong(const char *xpath, - xmlXPathContextPtr ctxt, - unsigned long *value); -int virXPathULongLong(const char *xpath, - xmlXPathContextPtr ctxt, - unsigned long long *value); -int virXPathLongLong(const char *xpath, - xmlXPathContextPtr ctxt, - long long *value); -int virXPathLongHex(const char *xpath, - xmlXPathContextPtr ctxt, - long *value); -int virXPathULongHex(const char *xpath, - xmlXPathContextPtr ctxt, - unsigned long *value); -xmlNodePtr virXPathNode(const char *xpath, - xmlXPathContextPtr ctxt); -int virXPathNodeSet(const char *xpath, - xmlXPathContextPtr ctxt, - xmlNodePtr **list); -char * virXMLPropString(xmlNodePtr node, - const char *name); -long virXMLChildElementCount(xmlNodePtr node); - -/* Internal function; prefer the macros below. */ -xmlDocPtr virXMLParseHelper(int domcode, - const char *filename, - const char *xmlStr, - const char *url, - xmlXPathContextPtr *pctxt); - -const char *virXMLPickShellSafeComment(const char *str1, const char *str2); -/** - * virXMLParse: - * @filename: file to parse, or NULL for string parsing - * @xmlStr: if @filename is NULL, a string to parse - * @url: if @filename is NULL, an optional filename to attribute the parse to - * - * Parse xml from either a file or a string. - * - * Return the parsed document object, or NULL on failure. - */ -# define virXMLParse(filename, xmlStr, url) \ - virXMLParseHelper(VIR_FROM_THIS, filename, xmlStr, url, NULL) - -/** - * virXMLParseString: - * @xmlStr: a string to parse - * @url: an optional filename to attribute the parse to - * - * Parse xml from a string. - * - * Return the parsed document object, or NULL on failure. - */ -# define virXMLParseString(xmlStr, url) \ - virXMLParseHelper(VIR_FROM_THIS, NULL, xmlStr, url, NULL) - -/** - * virXMLParseFile: - * @filename: file to parse - * - * Parse xml from a file. - * - * Return the parsed document object, or NULL on failure. - */ -# define virXMLParseFile(filename) \ - virXMLParseHelper(VIR_FROM_THIS, filename, NULL, NULL, NULL) - -/** - * virXMLParseCtxt: - * @filename: file to parse, or NULL for string parsing - * @xmlStr: if @filename is NULL, a string to parse - * @url: if @filename is NULL, an optional filename to attribute the parse to - * @pctxt: if non-NULL, populate with a new context object on success, - * with (*pctxt)->node pre-set to the root node - * - * Parse xml from either a file or a string. - * - * Return the parsed document object, or NULL on failure. - */ -# define virXMLParseCtxt(filename, xmlStr, url, pctxt) \ - virXMLParseHelper(VIR_FROM_THIS, filename, xmlStr, url, pctxt) - -/** - * virXMLParseStringCtxt: - * @xmlStr: a string to parse - * @url: an optional filename to attribute the parse to - * @pctxt: if non-NULL, populate with a new context object on success, - * with (*pctxt)->node pre-set to the root node - * - * Parse xml from a string. - * - * Return the parsed document object, or NULL on failure. - */ -# define virXMLParseStringCtxt(xmlStr, url, pctxt) \ - virXMLParseHelper(VIR_FROM_THIS, NULL, xmlStr, url, pctxt) - -/** - * virXMLParseFileCtxt: - * @filename: file to parse - * @pctxt: if non-NULL, populate with a new context object on success, - * with (*pctxt)->node pre-set to the root node - * - * Parse xml from a file. - * - * Return the parsed document object, or NULL on failure. - */ -# define virXMLParseFileCtxt(filename, pctxt) \ - virXMLParseHelper(VIR_FROM_THIS, filename, NULL, NULL, pctxt) - -int virXMLSaveFile(const char *path, - const char *warnName, - const char *warnCommand, - const char *xml); - -#endif /* __VIR_XML_H__ */ diff --git a/src/xen/xen_driver.c b/src/xen/xen_driver.c index 4cbe827..c35695a 100644 --- a/src/xen/xen_driver.c +++ b/src/xen/xen_driver.c @@ -53,7 +53,7 @@ #if WITH_XEN_INOTIFY # include "xen_inotify.h" #endif -#include "xml.h" +#include "virxml.h" #include "virutil.h" #include "viralloc.h" #include "node_device_conf.h" diff --git a/tests/cputest.c b/tests/cputest.c index ee1a608..6505367 100644 --- a/tests/cputest.c +++ b/tests/cputest.c @@ -31,7 +31,7 @@ #include <fcntl.h> #include "internal.h" -#include "xml.h" +#include "virxml.h" #include "viralloc.h" #include "virbuffer.h" #include "testutils.h" diff --git a/tests/nwfilterxml2xmltest.c b/tests/nwfilterxml2xmltest.c index 8c29a46..a215bf8 100644 --- a/tests/nwfilterxml2xmltest.c +++ b/tests/nwfilterxml2xmltest.c @@ -10,7 +10,7 @@ #include "internal.h" #include "testutils.h" -#include "xml.h" +#include "virxml.h" #include "virthread.h" #include "nwfilter_params.h" #include "nwfilter_conf.h" diff --git a/tests/sexpr2xmltest.c b/tests/sexpr2xmltest.c index 9b9b09d..07f6f8e 100644 --- a/tests/sexpr2xmltest.c +++ b/tests/sexpr2xmltest.c @@ -5,7 +5,7 @@ #include <unistd.h> #include "internal.h" -#include "xml.h" +#include "virxml.h" #include "datatypes.h" #include "xen/xen_driver.h" #include "xen/xend_internal.h" diff --git a/tests/virshtest.c b/tests/virshtest.c index 8741d47..b82a4c4 100644 --- a/tests/virshtest.c +++ b/tests/virshtest.c @@ -5,7 +5,7 @@ #include <unistd.h> #include "internal.h" -#include "xml.h" +#include "virxml.h" #include "virutil.h" #include "testutils.h" diff --git a/tests/xencapstest.c b/tests/xencapstest.c index 387e278..b3f7d62 100644 --- a/tests/xencapstest.c +++ b/tests/xencapstest.c @@ -6,7 +6,7 @@ #include <unistd.h> #include "internal.h" -#include "xml.h" +#include "virxml.h" #include "testutils.h" #include "xen/xen_hypervisor.h" #include "virfile.h" diff --git a/tools/virsh-domain-monitor.c b/tools/virsh-domain-monitor.c index a443988..f4940fa 100644 --- a/tools/virsh-domain-monitor.c +++ b/tools/virsh-domain-monitor.c @@ -37,7 +37,7 @@ #include "viralloc.h" #include "virmacaddr.h" #include "virsh-domain.h" -#include "xml.h" +#include "virxml.h" static const char * vshDomainIOErrorToString(int error) diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c index 244ffb8..3a9cebe 100644 --- a/tools/virsh-domain.c +++ b/tools/virsh-domain.c @@ -51,7 +51,7 @@ #include "virsh-domain-monitor.h" #include "virterror_internal.h" #include "virtypedparam.h" -#include "xml.h" +#include "virxml.h" /* Gnulib doesn't guarantee SA_SIGINFO support. */ #ifndef SA_SIGINFO diff --git a/tools/virsh-host.c b/tools/virsh-host.c index 0ad4296..45b89a8 100644 --- a/tools/virsh-host.c +++ b/tools/virsh-host.c @@ -36,7 +36,7 @@ #include "viralloc.h" #include "virutil.h" #include "virsh-domain.h" -#include "xml.h" +#include "virxml.h" #include "virtypedparam.h" #include "virjson.h" diff --git a/tools/virsh-interface.c b/tools/virsh-interface.c index ea8a6c5..cd14e89 100644 --- a/tools/virsh-interface.c +++ b/tools/virsh-interface.c @@ -35,7 +35,7 @@ #include "virbuffer.h" #include "viralloc.h" #include "virutil.h" -#include "xml.h" +#include "virxml.h" virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd, diff --git a/tools/virsh-network.c b/tools/virsh-network.c index 918dee6..c9cd15a 100644 --- a/tools/virsh-network.c +++ b/tools/virsh-network.c @@ -35,7 +35,7 @@ #include "virbuffer.h" #include "viralloc.h" #include "virutil.h" -#include "xml.h" +#include "virxml.h" #include "conf/network_conf.h" virNetworkPtr diff --git a/tools/virsh-nodedev.c b/tools/virsh-nodedev.c index 974e495..f9517cc 100644 --- a/tools/virsh-nodedev.c +++ b/tools/virsh-nodedev.c @@ -35,7 +35,7 @@ #include "virbuffer.h" #include "viralloc.h" #include "virutil.h" -#include "xml.h" +#include "virxml.h" #include "conf/node_device_conf.h" /* diff --git a/tools/virsh-nwfilter.c b/tools/virsh-nwfilter.c index 1480d13..9341ea7 100644 --- a/tools/virsh-nwfilter.c +++ b/tools/virsh-nwfilter.c @@ -35,7 +35,7 @@ #include "virbuffer.h" #include "viralloc.h" #include "virutil.h" -#include "xml.h" +#include "virxml.h" virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd, diff --git a/tools/virsh-pool.c b/tools/virsh-pool.c index b3177e0..adac7f1 100644 --- a/tools/virsh-pool.c +++ b/tools/virsh-pool.c @@ -35,7 +35,7 @@ #include "virbuffer.h" #include "viralloc.h" #include "virutil.h" -#include "xml.h" +#include "virxml.h" #include "conf/storage_conf.h" virStoragePoolPtr diff --git a/tools/virsh-secret.c b/tools/virsh-secret.c index a29454f..8297743 100644 --- a/tools/virsh-secret.c +++ b/tools/virsh-secret.c @@ -36,7 +36,7 @@ #include "virbuffer.h" #include "viralloc.h" #include "virutil.h" -#include "xml.h" +#include "virxml.h" static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name) diff --git a/tools/virsh-snapshot.c b/tools/virsh-snapshot.c index 8428282..3b179e2 100644 --- a/tools/virsh-snapshot.c +++ b/tools/virsh-snapshot.c @@ -38,7 +38,7 @@ #include "viralloc.h" #include "virutil.h" #include "virsh-domain.h" -#include "xml.h" +#include "virxml.h" #include "conf/snapshot_conf.h" /* Helper for snapshot-create and snapshot-create-as */ diff --git a/tools/virsh-volume.c b/tools/virsh-volume.c index 6f2c591..a57fc28 100644 --- a/tools/virsh-volume.c +++ b/tools/virsh-volume.c @@ -39,7 +39,7 @@ #include "virutil.h" #include "virfile.h" #include "virsh-pool.h" -#include "xml.h" +#include "virxml.h" virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd, diff --git a/tools/virsh.c b/tools/virsh.c index bfeaaa1..790cf56 100644 --- a/tools/virsh.c +++ b/tools/virsh.c @@ -60,7 +60,7 @@ #include "console.h" #include "virutil.h" #include "viralloc.h" -#include "xml.h" +#include "virxml.h" #include "libvirt/libvirt-qemu.h" #include "virfile.h" #include "configmake.h" -- 1.7.11.7

From: "Daniel P. Berrange" <berrange(a)redhat.com&gt; --- src/Makefile.am | 53 +++++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/src/Makefile.am b/src/Makefile.am index 0c77062..19a5b09 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -60,41 +60,27 @@ UTIL_SOURCES = \ util/virauthconfig.c util/virauthconfig.h \ util/virbitmap.c util/virbitmap.h \ util/virbuffer.c util/virbuffer.h \ + util/vircgroup.c util/vircgroup.h \ util/vircommand.c util/vircommand.h \ util/virconf.c util/virconf.h \ - util/virdnsmasq.c util/virdnsmasq.h \ + util/virdbus.c util/virdbus.h \ + util/virdnsmasq.c util/virdnsmasq.h \ util/virebtables.c util/virebtables.h \ util/virerror.c util/virerror.h \ util/virevent.c util/virevent.h \ util/vireventpoll.c util/vireventpoll.h \ util/virfile.c util/virfile.h \ + util/virhash.c util/virhash.h \ + util/virhashcode.c util/virhashcode.h \ util/virhooks.c util/virhooks.h \ - util/virnodesuspend.c util/virnodesuspend.h \ + util/virinitctl.c util/virinitctl.h \ util/viriptables.c util/viriptables.h \ util/virjson.c util/virjson.h \ - util/virlog.c util/virlog.h \ - util/virobject.c util/virobject.h \ - util/virpci.c util/virpci.h \ - util/virpidfile.c util/virpidfile.h \ - util/virprocess.c util/virprocess.h \ - util/virsexpr.c util/virsexpr.h \ - util/virstatslinux.c util/virstatslinux.h \ - util/virstoragefile.c util/virstoragefile.h \ - util/virsysinfo.c util/virsysinfo.h \ - util/virthread.c util/virthread.h \ - util/virthreadpthread.h \ - util/virthreadwin32.h \ - util/virthreadpool.c util/virthreadpool.h \ - util/virtypedparam.c util/virtypedparam.h \ - util/vircgroup.c util/vircgroup.h \ - util/virdbus.c util/virdbus.h \ - util/virhash.c util/virhash.h \ - util/virhashcode.c util/virhashcode.h \ - util/virinitctl.c util/virinitctl.h \ util/virkeycode.c util/virkeycode.h \ util/virkeyfile.c util/virkeyfile.h \ util/virkeymaps.h \ util/virlockspace.c util/virlockspace.h \ + util/virlog.c util/virlog.h \ util/virmacaddr.h util/virmacaddr.c \ util/virnetdev.h util/virnetdev.c \ util/virnetdevbandwidth.h util/virnetdevbandwidth.c \ @@ -102,14 +88,28 @@ UTIL_SOURCES = \ util/virnetdevmacvlan.c util/virnetdevmacvlan.h \ util/virnetdevopenvswitch.h util/virnetdevopenvswitch.c \ util/virnetdevtap.h util/virnetdevtap.c \ - util/virnetdevveth.h util/virnetdevveth.c \ - util/virnetdevvlan.h util/virnetdevvlan.c \ + util/virnetdevveth.h util/virnetdevveth.c \ + util/virnetdevvlan.h util/virnetdevvlan.c \ util/virnetdevvportprofile.h util/virnetdevvportprofile.c \ util/virnetlink.c util/virnetlink.h \ + util/virnodesuspend.c util/virnodesuspend.h \ + util/virobject.c util/virobject.h \ + util/virpci.c util/virpci.h \ + util/virpidfile.c util/virpidfile.h \ + util/virprocess.c util/virprocess.h \ util/virrandom.h util/virrandom.c \ - util/virsocketaddr.h util/virsocketaddr.c \ - util/virstring.h util/virstring.c \ - util/virtime.h util/virtime.c \ + util/virsexpr.c util/virsexpr.h \ + util/virsocketaddr.h util/virsocketaddr.c \ + util/virstatslinux.c util/virstatslinux.h \ + util/virstoragefile.c util/virstoragefile.h \ + util/virstring.h util/virstring.c \ + util/virsysinfo.c util/virsysinfo.h \ + util/virthread.c util/virthread.h \ + util/virthreadpthread.h \ + util/virthreadwin32.h \ + util/virthreadpool.c util/virthreadpool.h \ + util/virtime.h util/virtime.c \ + util/virtypedparam.c util/virtypedparam.h \ util/virusb.c util/virusb.h \ util/viruri.h util/viruri.c \ util/virutil.c util/virutil.h \ @@ -117,6 +117,7 @@ UTIL_SOURCES = \ util/virxml.c util/virxml.h \ $(NULL) + EXTRA_DIST += $(srcdir)/util/virkeymaps.h $(srcdir)/util/keymaps.csv \ $(srcdir)/util/virkeycode-mapgen.py -- 1.7.11.7