aboutsummaryrefslogtreecommitdiffstats
path: root/tools/libxc/xc_private.h
diff options
context:
space:
mode:
authorkfraser@localhost.localdomain <kfraser@localhost.localdomain>2006-12-07 11:36:26 +0000
committerkfraser@localhost.localdomain <kfraser@localhost.localdomain>2006-12-07 11:36:26 +0000
commitb07ced9c1fa55ffab47e3789af1a9f9ba672ef39 (patch)
tree318a1ce46089f79fc55f73ca41b9e9731059517a /tools/libxc/xc_private.h
parentd3f023e9ade9d28b3af1e346c63f95e73ca345c0 (diff)
downloadxen-b07ced9c1fa55ffab47e3789af1a9f9ba672ef39.tar.gz
xen-b07ced9c1fa55ffab47e3789af1a9f9ba672ef39.tar.bz2
xen-b07ced9c1fa55ffab47e3789af1a9f9ba672ef39.zip
[LIBXC] Add an error reporting API to the libxc library.
- An 'xc_error' struct is used to pass around error details. Currently contains two members 'code' an enumeration of error types, and 'message' a free text description of the specific problem. - The xc_get_last_error() method returns a const pointer to the internal instance of this struct manged by libxc. By returning a const pointer we can add extra members to the end of the struct at any time without worrying about ABI of callers. This will let us provide more fine-grained info if needed in the future. - The xc_error instance is statically defined inside libxc and marked __thread. This ensures that errors are recorded per-thread, and that when dealing with errors we never need to call malloc - all storage needed is statically allocated. - The xc_clear_last_error() method resets any currently recorded error details - The xc_error_code_to_desc() method converts the integer error code into a generic user facing messsage. eg "Invalid kernel". Together with the 'message' field from xc_error, this provides the user visible feedback. eg "Invalid kernel: Non PAE-kernel on PAE host." - A callback can be registered with xc_set_error_handler to receive notification whenever an error is recorded, rather than querying for error details after the fact with xc_get_last_error - If built with -DDEBUG set, a default error handler will be registered which calls fprintf(stderr), thus maintaining current behaviour of logging errors to stderr during developer builds. - The python binding for libxc is updated to use xc_get_last_error to pull out error details whenever appropriate, instead of returning info based on 'errno' - The xc_set_error method is private to libxc internals, and is used for setting error details - The ERROR and PERROR macros have been updated to call xc_set_error automatically specifying XC_INTERNAL_ERROR as the error code. This gives a generic error report for all current failure points - Some uses of the ERROR macro have been replaced with explicit calls to xc_set_error to enable finer grained error reporting. In particular the code dealing with invalid kernel types uses this to report about PAE/architecture/wordsize mismatches The patch has been tested by calling xm create against a varietry of config files defining invalid kernels of various kinds. It has also been tested with libvirt talking to xend. In both cases the error messages were propagated all the way back up the stack. There is only one place where I need to do further work. The suspend & restore APIs in Xend invoke external helper programs rather than calling libxc directly. This means that error details are essentially lost. Since there is already code in XenD which scans STDERR from these programs I will investigate adapting this to extract actual error messages from these helpers. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
Diffstat (limited to 'tools/libxc/xc_private.h')
-rw-r--r--tools/libxc/xc_private.h19
1 files changed, 5 insertions, 14 deletions
diff --git a/tools/libxc/xc_private.h b/tools/libxc/xc_private.h
index 20f7a9b445..2ddec3f988 100644
--- a/tools/libxc/xc_private.h
+++ b/tools/libxc/xc_private.h
@@ -59,24 +59,15 @@
#define PPRINTF(_f, _a...)
#endif
-#define ERROR(_m, _a...) \
-do { \
- int __saved_errno = errno; \
- DPRINTF("ERROR: " _m "\n" , ## _a ); \
- errno = __saved_errno; \
-} while (0)
+void xc_set_error(int code, const char *fmt, ...);
+
+#define ERROR(_m, _a...) xc_set_error(XC_INTERNAL_ERROR, _m , ## _a )
+#define PERROR(_m, _a...) xc_set_error(XC_INTERNAL_ERROR, _m " (%d = %s)", \
+ _m , ## _a , errno, strerror(errno))
int lock_pages(void *addr, size_t len);
void unlock_pages(void *addr, size_t len);
-#define PERROR(_m, _a...) \
-do { \
- int __saved_errno = errno; \
- DPRINTF("ERROR: " _m " (%d = %s)\n" , ## _a , \
- __saved_errno, strerror(__saved_errno)); \
- errno = __saved_errno; \
-} while (0)
-
static inline void safe_munlock(const void *addr, size_t len)
{
int saved_errno = errno;