* [PATCH 01/10] libxl: make LIBXL_INIT_GC a statement, not an initialiser
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
@ 2012-01-06 20:34 ` Ian Jackson
2012-01-06 20:34 ` [PATCH 02/10] xenstore: New function xs_path_is_subpath Ian Jackson
` (14 subsequent siblings)
15 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-06 20:34 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
Previously LIBXL_INIT_GC was an initialiser, which you were expected
to use like this:
libxl__gc gc = LIBXL_INIT_GC(ctx);
But we are going to want to put things in the gc which are to be
initialised using other macros. That means that LIBXL_INIT_GC has to
become a statement too. So instead, we make it so that it's used like this:
libxl_gc gc;
LIBXL_INIT_GC(gc,ctx);
In fact there are only a couple of callers now,
including GC_INIT which uses this trick:
libxl_gc gc[1];
LIBXL_INIT_GC(gc[0],ctx);
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
---
tools/libxl/libxl_internal.h | 9 +++++++--
tools/libxl/libxl_qmp.c | 2 +-
2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index fa7fb16..1bca869 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -147,7 +147,12 @@ typedef struct {
libxl_ctx *owner;
} libxl__gc;
-#define LIBXL_INIT_GC(ctx) (libxl__gc){ .alloc_maxsize = 0, .alloc_ptrs = 0, .owner = ctx }
+#define LIBXL_INIT_GC(gc,ctx) do{ \
+ (gc).alloc_maxsize = 0; \
+ (gc).alloc_ptrs = 0; \
+ (gc).owner = (ctx); \
+ } while(0)
+
static inline libxl_ctx *libxl__gc_owner(libxl__gc *gc)
{
return gc->owner;
@@ -721,7 +726,7 @@ libxl__device_model_version_running(libxl__gc *gc, uint32_t domid);
* as a local variable.
*/
-#define GC_INIT(ctx) libxl__gc gc[1] = { LIBXL_INIT_GC(ctx) }
+#define GC_INIT(ctx) libxl__gc gc[1]; LIBXL_INIT_GC(gc[0],ctx)
#define GC_FREE libxl__free_all(gc)
#define CTX libxl__gc_owner(gc)
diff --git a/tools/libxl/libxl_qmp.c b/tools/libxl/libxl_qmp.c
index 1777e44..3dfa43a 100644
--- a/tools/libxl/libxl_qmp.c
+++ b/tools/libxl/libxl_qmp.c
@@ -513,7 +513,7 @@ static int qmp_send(libxl__qmp_handler *qmp,
{
char *buf = NULL;
int rc = -1;
- libxl__gc gc = LIBXL_INIT_GC(qmp->ctx);
+ libxl__gc gc; LIBXL_INIT_GC(gc,qmp->ctx);
buf = qmp_send_prepare(&gc, qmp, cmd, args, callback, opaque, context);
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* [PATCH 02/10] xenstore: New function xs_path_is_subpath
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
2012-01-06 20:34 ` [PATCH 01/10] libxl: make LIBXL_INIT_GC a statement, not an initialiser Ian Jackson
@ 2012-01-06 20:34 ` Ian Jackson
2012-01-13 10:39 ` Ian Campbell
2012-01-06 20:35 ` [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h Ian Jackson
` (13 subsequent siblings)
15 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-06 20:34 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
This utility function compares two paths, textually and reports
whether one is a subpath (a child path) of the other.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/xenstore/xs.c | 17 +++++++++++++++++
tools/xenstore/xs.h | 7 +++++++
2 files changed, 24 insertions(+), 0 deletions(-)
diff --git a/tools/xenstore/xs.c b/tools/xenstore/xs.c
index 8e54fe0..0a01675 100644
--- a/tools/xenstore/xs.c
+++ b/tools/xenstore/xs.c
@@ -950,6 +950,23 @@ char *xs_get_domain_path(struct xs_handle *h, unsigned int domid)
return xs_single(h, XBT_NULL, XS_GET_DOMAIN_PATH, domid_str, NULL);
}
+bool xs_path_is_subpath(const char *parent, const char *child)
+{
+ size_t childlen = strlen(child);
+ size_t parentlen = strlen(parent);
+
+ if (childlen < parentlen)
+ return false;
+
+ if (memcmp(child, parent, parentlen))
+ return false;
+
+ if (childlen > parentlen && child[parentlen] != '/')
+ return false;
+
+ return true;
+}
+
bool xs_is_domain_introduced(struct xs_handle *h, unsigned int domid)
{
char *domain = single_with_domid(h, XS_IS_DOMAIN_INTRODUCED, domid);
diff --git a/tools/xenstore/xs.h b/tools/xenstore/xs.h
index 63f535d..8d49e50 100644
--- a/tools/xenstore/xs.h
+++ b/tools/xenstore/xs.h
@@ -207,6 +207,13 @@ bool xs_release_domain(struct xs_handle *h, unsigned int domid);
*/
char *xs_get_domain_path(struct xs_handle *h, unsigned int domid);
+/* Returns true if child is either equal to parent, or a node underneath
+ * parent; or false otherwise. Done by string comparison, so relative and
+ * absolute pathnames never in a parent/child relationship by this
+ * definition. Cannot fail.
+ */
+bool xs_path_is_subpath(const char *parent, const char *child);
+
/* Return whether the domain specified has been introduced to xenstored.
*/
bool xs_is_domain_introduced(struct xs_handle *h, unsigned int domid);
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* Re: [PATCH 02/10] xenstore: New function xs_path_is_subpath
2012-01-06 20:34 ` [PATCH 02/10] xenstore: New function xs_path_is_subpath Ian Jackson
@ 2012-01-13 10:39 ` Ian Campbell
0 siblings, 0 replies; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 10:39 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-06 at 20:34 +0000, Ian Jackson wrote:
> This utility function compares two paths, textually and reports
> whether one is a subpath (a child path) of the other.
>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
> ---
> tools/xenstore/xs.c | 17 +++++++++++++++++
> tools/xenstore/xs.h | 7 +++++++
> 2 files changed, 24 insertions(+), 0 deletions(-)
>
> diff --git a/tools/xenstore/xs.c b/tools/xenstore/xs.c
> index 8e54fe0..0a01675 100644
> --- a/tools/xenstore/xs.c
> +++ b/tools/xenstore/xs.c
> @@ -950,6 +950,23 @@ char *xs_get_domain_path(struct xs_handle *h, unsigned int domid)
> return xs_single(h, XBT_NULL, XS_GET_DOMAIN_PATH, domid_str, NULL);
> }
>
> +bool xs_path_is_subpath(const char *parent, const char *child)
> +{
> + size_t childlen = strlen(child);
> + size_t parentlen = strlen(parent);
> +
> + if (childlen < parentlen)
> + return false;
> +
> + if (memcmp(child, parent, parentlen))
> + return false;
> +
> + if (childlen > parentlen && child[parentlen] != '/')
> + return false;
> +
> + return true;
> +}
> +
> bool xs_is_domain_introduced(struct xs_handle *h, unsigned int domid)
> {
> char *domain = single_with_domid(h, XS_IS_DOMAIN_INTRODUCED, domid);
> diff --git a/tools/xenstore/xs.h b/tools/xenstore/xs.h
> index 63f535d..8d49e50 100644
> --- a/tools/xenstore/xs.h
> +++ b/tools/xenstore/xs.h
> @@ -207,6 +207,13 @@ bool xs_release_domain(struct xs_handle *h, unsigned int domid);
> */
> char *xs_get_domain_path(struct xs_handle *h, unsigned int domid);
>
> +/* Returns true if child is either equal to parent, or a node underneath
> + * parent; or false otherwise. Done by string comparison, so relative and
> + * absolute pathnames never in a parent/child relationship by this
> + * definition. Cannot fail.
> + */
> +bool xs_path_is_subpath(const char *parent, const char *child);
> +
> /* Return whether the domain specified has been introduced to xenstored.
> */
> bool xs_is_domain_introduced(struct xs_handle *h, unsigned int domid);
^ permalink raw reply [flat|nested] 43+ messages in thread
* [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
2012-01-06 20:34 ` [PATCH 01/10] libxl: make LIBXL_INIT_GC a statement, not an initialiser Ian Jackson
2012-01-06 20:34 ` [PATCH 02/10] xenstore: New function xs_path_is_subpath Ian Jackson
@ 2012-01-06 20:35 ` Ian Jackson
2012-01-13 10:41 ` Ian Campbell
2012-01-06 20:35 ` [PATCH 04/10] libxl: Provide more formal libxl__ctx_lock and _unlock Ian Jackson
` (12 subsequent siblings)
15 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-06 20:35 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
Move a lot of
#include <stdfoo.h>
from individual files into libxl_internal.h. This helps avoid
portability mistakes where necessary system headers are omitted from
individual files, and is also of course a convenience when developing.
Also add
#include "libxl_osdeps.h" /* must come before any other headers */
to the top of most libxl*.c files, so that anyone who adds any headers
before libxl_internal.h will put the in the right place.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl.c | 15 ---------------
tools/libxl/libxl_blktap2.c | 4 +---
tools/libxl/libxl_bootloader.c | 7 +------
tools/libxl/libxl_cpuid.c | 2 ++
tools/libxl/libxl_create.c | 13 +++----------
tools/libxl/libxl_device.c | 10 +---------
tools/libxl/libxl_dm.c | 10 +---------
tools/libxl/libxl_dom.c | 11 +----------
tools/libxl/libxl_exec.c | 13 +------------
tools/libxl/libxl_flask.c | 8 +-------
tools/libxl/libxl_internal.c | 10 +---------
tools/libxl/libxl_internal.h | 22 +++++++++++++++++++---
tools/libxl/libxl_json.c | 4 +---
tools/libxl/libxl_linux.c | 2 +-
tools/libxl/libxl_netbsd.c | 2 +-
tools/libxl/libxl_noblktap2.c | 2 ++
tools/libxl/libxl_nocpuid.c | 2 ++
tools/libxl/libxl_paths.c | 1 +
tools/libxl/libxl_pci.c | 16 +---------------
tools/libxl/libxl_qmp.c | 4 +---
tools/libxl/libxl_utils.c | 13 +------------
tools/libxl/libxl_uuid.c | 2 +-
tools/libxl/libxl_xshelp.c | 8 +-------
tools/libxl/libxlu_cfg.c | 2 ++
tools/libxl/libxlu_cfg_i.h | 1 +
tools/libxl/libxlu_disk.c | 1 +
tools/libxl/libxlu_disk_i.h | 2 ++
27 files changed, 51 insertions(+), 136 deletions(-)
diff --git a/tools/libxl/libxl.c b/tools/libxl/libxl.c
index 2b8f8f4..2d3e8cd 100644
--- a/tools/libxl/libxl.c
+++ b/tools/libxl/libxl.c
@@ -16,21 +16,6 @@
#include "libxl_osdeps.h"
-#include <stdio.h>
-#include <string.h>
-#include <stdlib.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <fcntl.h>
-#include <sys/select.h>
-#include <sys/wait.h>
-#include <sys/time.h>
-#include <signal.h>
-#include <unistd.h> /* for write, unlink and close */
-#include <stdint.h>
-#include <inttypes.h>
-#include <assert.h>
-
#include "libxl_internal.h"
#define PAGE_TO_MEMKB(pages) ((pages) * 4)
diff --git a/tools/libxl/libxl_blktap2.c b/tools/libxl/libxl_blktap2.c
index acf4110..2c40182 100644
--- a/tools/libxl/libxl_blktap2.c
+++ b/tools/libxl/libxl_blktap2.c
@@ -12,13 +12,11 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
#include "tap-ctl.h"
-#include <string.h>
-
int libxl__blktap_enabled(libxl__gc *gc)
{
const char *msg;
diff --git a/tools/libxl/libxl_bootloader.c b/tools/libxl/libxl_bootloader.c
index ce83b8e..2da1d90 100644
--- a/tools/libxl/libxl_bootloader.c
+++ b/tools/libxl/libxl_bootloader.c
@@ -12,15 +12,10 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
+#include "libxl_osdeps.h" /* must come before any other headers */
-#include <unistd.h>
-#include <fcntl.h>
#include <termios.h>
-#include <sys/stat.h>
-#include <sys/types.h>
-
#include "libxl_internal.h"
#define XENCONSOLED_BUF_SIZE 16
diff --git a/tools/libxl/libxl_cpuid.c b/tools/libxl/libxl_cpuid.c
index 56a00cd..dcdb9d02 100644
--- a/tools/libxl/libxl_cpuid.c
+++ b/tools/libxl/libxl_cpuid.c
@@ -10,6 +10,8 @@
* GNU Lesser General Public License for more details.
*/
+#include "libxl_osdeps.h" /* must come before any other headers */
+
#include "libxl_internal.h"
void libxl_cpuid_dispose(libxl_cpuid_policy_list *p_cpuid_list)
diff --git a/tools/libxl/libxl_create.c b/tools/libxl/libxl_create.c
index ebf2ed7..9a6a94a 100644
--- a/tools/libxl/libxl_create.c
+++ b/tools/libxl/libxl_create.c
@@ -15,20 +15,13 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
-
-#include <stdio.h>
-#include <string.h>
-#include <stdlib.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <xenctrl.h>
-#include <xc_dom.h>
-#include <xenguest.h>
-#include <assert.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
+#include <xc_dom.h>
+#include <xenguest.h>
+
void libxl_domain_config_dispose(libxl_domain_config *d_config)
{
int i;
diff --git a/tools/libxl/libxl_device.c b/tools/libxl/libxl_device.c
index 9b1fc57..5d05e90 100644
--- a/tools/libxl/libxl_device.c
+++ b/tools/libxl/libxl_device.c
@@ -14,15 +14,7 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
-
-#include <string.h>
-#include <stdio.h>
-#include <sys/time.h> /* for struct timeval */
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <unistd.h>
-#include <fcntl.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
diff --git a/tools/libxl/libxl_dm.c b/tools/libxl/libxl_dm.c
index 97d91b4..f0bf014 100644
--- a/tools/libxl/libxl_dm.c
+++ b/tools/libxl/libxl_dm.c
@@ -15,15 +15,7 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
-
-#include <stdio.h>
-#include <string.h>
-#include <stdlib.h>
-#include <signal.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <assert.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
diff --git a/tools/libxl/libxl_dom.c b/tools/libxl/libxl_dom.c
index c898d89..b2259f8 100644
--- a/tools/libxl/libxl_dom.c
+++ b/tools/libxl/libxl_dom.c
@@ -13,22 +13,13 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
+#include "libxl_osdeps.h" /* must come before any other headers */
-#include <stdio.h>
-#include <assert.h>
#include <glob.h>
-#include <inttypes.h>
-#include <string.h>
-#include <sys/mman.h>
-#include <sys/time.h> /* for struct timeval */
-#include <sys/stat.h> /* for stat */
-#include <unistd.h> /* for sleep(2) */
#include <xenctrl.h>
#include <xc_dom.h>
#include <xenguest.h>
-#include <fcntl.h>
#include <xen/hvm/hvm_info_table.h>
diff --git a/tools/libxl/libxl_exec.c b/tools/libxl/libxl_exec.c
index 52d40d1..b10e79f 100644
--- a/tools/libxl/libxl_exec.c
+++ b/tools/libxl/libxl_exec.c
@@ -15,18 +15,7 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
-
-#include <stdio.h>
-#include <string.h>
-#include <unistd.h>
-#include <stdlib.h>
-#include <unistd.h>
-#include <assert.h>
-#include <sys/types.h>
-#include <sys/wait.h>
-#include <signal.h> /* for SIGKILL */
-#include <fcntl.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
diff --git a/tools/libxl/libxl_flask.c b/tools/libxl/libxl_flask.c
index 6b548dd..23f2476 100644
--- a/tools/libxl/libxl_flask.c
+++ b/tools/libxl/libxl_flask.c
@@ -7,13 +7,7 @@
* as published by the Free Software Foundation.
*/
-#include "libxl_osdeps.h"
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <errno.h>
-#include <xenctrl.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
diff --git a/tools/libxl/libxl_internal.c b/tools/libxl/libxl_internal.c
index cfa8c61..49b0dab 100644
--- a/tools/libxl/libxl_internal.c
+++ b/tools/libxl/libxl_internal.c
@@ -13,15 +13,7 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
-
-#include <stdio.h>
-
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <fcntl.h>
-#include <sys/mman.h>
-#include <unistd.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index 1bca869..d681d73 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -17,17 +17,33 @@
#ifndef LIBXL_INTERNAL_H
#define LIBXL_INTERNAL_H
-#include "libxl_osdeps.h"
+#include "libxl_osdeps.h" /* must come before any other headers */
-#include <stdint.h>
+#include <assert.h>
+#include <dirent.h>
+#include <errno.h>
+#include <fcntl.h>
+#include <inttypes.h>
+#include <pthread.h>
+#include <signal.h>
#include <stdarg.h>
+#include <stddef.h>
+#include <stdint.h>
+#include <stdio.h>
#include <stdlib.h>
#include <string.h>
-#include <pthread.h>
+#include <unistd.h>
+
+#include <sys/mman.h>
+#include <sys/select.h>
+#include <sys/stat.h>
#include <sys/time.h>
+#include <sys/types.h>
+#include <sys/wait.h>
#include <xs.h>
#include <xenctrl.h>
+
#include "xentoollog.h"
#include <xen/io/xenbus.h>
diff --git a/tools/libxl/libxl_json.c b/tools/libxl/libxl_json.c
index c0f869e..6ff2910 100644
--- a/tools/libxl/libxl_json.c
+++ b/tools/libxl/libxl_json.c
@@ -12,10 +12,8 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
+#include "libxl_osdeps.h" /* must come before any other headers */
-#include <assert.h>
-#include <string.h>
#include <math.h>
#include <yajl/yajl_parse.h>
diff --git a/tools/libxl/libxl_linux.c b/tools/libxl/libxl_linux.c
index 786c6b5..925248b 100644
--- a/tools/libxl/libxl_linux.c
+++ b/tools/libxl/libxl_linux.c
@@ -13,7 +13,7 @@
* GNU Lesser General Public License for more details.
*/
-#include <sys/stat.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
diff --git a/tools/libxl/libxl_netbsd.c b/tools/libxl/libxl_netbsd.c
index 1e8d622..9e0ed6d 100644
--- a/tools/libxl/libxl_netbsd.c
+++ b/tools/libxl/libxl_netbsd.c
@@ -13,7 +13,7 @@
* GNU Lesser General Public License for more details.
*/
-#include <sys/stat.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
diff --git a/tools/libxl/libxl_noblktap2.c b/tools/libxl/libxl_noblktap2.c
index 3307551..246b0de 100644
--- a/tools/libxl/libxl_noblktap2.c
+++ b/tools/libxl/libxl_noblktap2.c
@@ -12,6 +12,8 @@
* GNU Lesser General Public License for more details.
*/
+#include "libxl_osdeps.h" /* must come before any other headers */
+
#include "libxl_internal.h"
int libxl__blktap_enabled(libxl__gc *gc)
diff --git a/tools/libxl/libxl_nocpuid.c b/tools/libxl/libxl_nocpuid.c
index 2e9490c..9e52f8d 100644
--- a/tools/libxl/libxl_nocpuid.c
+++ b/tools/libxl/libxl_nocpuid.c
@@ -10,6 +10,8 @@
* GNU Lesser General Public License for more details.
*/
+#include "libxl_osdeps.h" /* must come before any other headers */
+
#include "libxl_internal.h"
void libxl_cpuid_destroy(libxl_cpuid_policy_list *p_cpuid_list)
diff --git a/tools/libxl/libxl_paths.c b/tools/libxl/libxl_paths.c
index e7bd1a2..a95d29f 100644
--- a/tools/libxl/libxl_paths.c
+++ b/tools/libxl/libxl_paths.c
@@ -12,6 +12,7 @@
* GNU Lesser General Public License for more details.
*/
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
#include "_libxl_paths.h"
diff --git a/tools/libxl/libxl_pci.c b/tools/libxl/libxl_pci.c
index 8b2a1c5..c3828f6 100644
--- a/tools/libxl/libxl_pci.c
+++ b/tools/libxl/libxl_pci.c
@@ -14,21 +14,7 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <sys/types.h>
-#include <fcntl.h>
-#include <sys/select.h>
-#include <sys/mman.h>
-#include <sys/wait.h>
-#include <sys/stat.h>
-#include <signal.h>
-#include <unistd.h> /* for write, unlink and close */
-#include <inttypes.h>
-#include <dirent.h>
-#include <assert.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
diff --git a/tools/libxl/libxl_qmp.c b/tools/libxl/libxl_qmp.c
index 3dfa43a..61d9769 100644
--- a/tools/libxl/libxl_qmp.c
+++ b/tools/libxl/libxl_qmp.c
@@ -18,12 +18,10 @@
* Specification, see in the QEMU repository.
*/
-#include "libxl_osdeps.h"
+#include "libxl_osdeps.h" /* must come before any other headers */
-#include <unistd.h>
#include <sys/un.h>
#include <sys/queue.h>
-#include <fcntl.h>
#include <yajl/yajl_gen.h>
diff --git a/tools/libxl/libxl_utils.c b/tools/libxl/libxl_utils.c
index d36c737..dbe8891 100644
--- a/tools/libxl/libxl_utils.c
+++ b/tools/libxl/libxl_utils.c
@@ -13,20 +13,9 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <string.h>
-#include <xs.h>
-#include <xenctrl.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
+
#include <ctype.h>
-#include <errno.h>
-#include <sys/stat.h>
-#include <sys/types.h>
-#include <unistd.h>
-#include <assert.h>
#include "libxl_internal.h"
diff --git a/tools/libxl/libxl_uuid.c b/tools/libxl/libxl_uuid.c
index 80ab789..7c18d71 100644
--- a/tools/libxl/libxl_uuid.c
+++ b/tools/libxl/libxl_uuid.c
@@ -12,7 +12,7 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
+#include "libxl_osdeps.h" /* must come before any other headers */
#include <libxl_uuid.h>
diff --git a/tools/libxl/libxl_xshelp.c b/tools/libxl/libxl_xshelp.c
index ea835e2..6958d21 100644
--- a/tools/libxl/libxl_xshelp.c
+++ b/tools/libxl/libxl_xshelp.c
@@ -13,13 +13,7 @@
* GNU Lesser General Public License for more details.
*/
-#include "libxl_osdeps.h"
-
-#include <string.h>
-#include <stddef.h>
-#include <stdio.h>
-#include <stdarg.h>
-#include <inttypes.h>
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxl_internal.h"
diff --git a/tools/libxl/libxlu_cfg.c b/tools/libxl/libxlu_cfg.c
index 0d1c5d3..e3659c7 100644
--- a/tools/libxl/libxlu_cfg.c
+++ b/tools/libxl/libxlu_cfg.c
@@ -16,6 +16,8 @@
*/
+#include "libxl_osdeps.h" /* must come before any other headers */
+
#include <limits.h>
#include "libxlu_internal.h"
diff --git a/tools/libxl/libxlu_cfg_i.h b/tools/libxl/libxlu_cfg_i.h
index ea6a326..54d033c 100644
--- a/tools/libxl/libxlu_cfg_i.h
+++ b/tools/libxl/libxlu_cfg_i.h
@@ -18,6 +18,7 @@
#ifndef LIBXLU_CFG_I_H
#define LIBXLU_CFG_I_H
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxlu_internal.h"
#include "libxlu_cfg_y.h"
diff --git a/tools/libxl/libxlu_disk.c b/tools/libxl/libxlu_disk.c
index 88b79ac..6cd86e9 100644
--- a/tools/libxl/libxlu_disk.c
+++ b/tools/libxl/libxlu_disk.c
@@ -1,3 +1,4 @@
+#include "libxl_osdeps.h" /* must come before any other headers */
#include "libxlu_internal.h"
#include "libxlu_disk_l.h"
#include "libxlu_disk_i.h"
diff --git a/tools/libxl/libxlu_disk_i.h b/tools/libxl/libxlu_disk_i.h
index 4fccd4a..37246f2 100644
--- a/tools/libxl/libxlu_disk_i.h
+++ b/tools/libxl/libxlu_disk_i.h
@@ -1,6 +1,8 @@
#ifndef LIBXLU_DISK_I_H
#define LIBXLU_DISK_I_H
+#include "libxl_osdeps.h" /* must come before any other headers */
+
#include "libxlu_internal.h"
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* Re: [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h
2012-01-06 20:35 ` [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h Ian Jackson
@ 2012-01-13 10:41 ` Ian Campbell
2012-01-13 13:37 ` Ian Jackson
0 siblings, 1 reply; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 10:41 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-06 at 20:35 +0000, Ian Jackson wrote:
> Move a lot of
> #include <stdfoo.h>
> from individual files into libxl_internal.h. This helps avoid
> portability mistakes where necessary system headers are omitted from
> individual files, and is also of course a convenience when developing.
>
> Also add
> #include "libxl_osdeps.h" /* must come before any other headers */
> to the top of most libxl*.c files, so that anyone who adds any headers
> before libxl_internal.h will put the in the right place.
Could we put this first in libxl_internal.h and apply that constraint to
that header instead?
Either way I don't mind this patch so:
Acked-by: Ian Campbell <ian.campbell@citrix.com>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
> ---
> tools/libxl/libxl.c | 15 ---------------
> tools/libxl/libxl_blktap2.c | 4 +---
> tools/libxl/libxl_bootloader.c | 7 +------
> tools/libxl/libxl_cpuid.c | 2 ++
> tools/libxl/libxl_create.c | 13 +++----------
> tools/libxl/libxl_device.c | 10 +---------
> tools/libxl/libxl_dm.c | 10 +---------
> tools/libxl/libxl_dom.c | 11 +----------
> tools/libxl/libxl_exec.c | 13 +------------
> tools/libxl/libxl_flask.c | 8 +-------
> tools/libxl/libxl_internal.c | 10 +---------
> tools/libxl/libxl_internal.h | 22 +++++++++++++++++++---
> tools/libxl/libxl_json.c | 4 +---
> tools/libxl/libxl_linux.c | 2 +-
> tools/libxl/libxl_netbsd.c | 2 +-
> tools/libxl/libxl_noblktap2.c | 2 ++
> tools/libxl/libxl_nocpuid.c | 2 ++
> tools/libxl/libxl_paths.c | 1 +
> tools/libxl/libxl_pci.c | 16 +---------------
> tools/libxl/libxl_qmp.c | 4 +---
> tools/libxl/libxl_utils.c | 13 +------------
> tools/libxl/libxl_uuid.c | 2 +-
> tools/libxl/libxl_xshelp.c | 8 +-------
> tools/libxl/libxlu_cfg.c | 2 ++
> tools/libxl/libxlu_cfg_i.h | 1 +
> tools/libxl/libxlu_disk.c | 1 +
> tools/libxl/libxlu_disk_i.h | 2 ++
> 27 files changed, 51 insertions(+), 136 deletions(-)
>
> diff --git a/tools/libxl/libxl.c b/tools/libxl/libxl.c
> index 2b8f8f4..2d3e8cd 100644
> --- a/tools/libxl/libxl.c
> +++ b/tools/libxl/libxl.c
> @@ -16,21 +16,6 @@
>
> #include "libxl_osdeps.h"
>
> -#include <stdio.h>
> -#include <string.h>
> -#include <stdlib.h>
> -#include <sys/types.h>
> -#include <sys/stat.h>
> -#include <fcntl.h>
> -#include <sys/select.h>
> -#include <sys/wait.h>
> -#include <sys/time.h>
> -#include <signal.h>
> -#include <unistd.h> /* for write, unlink and close */
> -#include <stdint.h>
> -#include <inttypes.h>
> -#include <assert.h>
> -
> #include "libxl_internal.h"
>
> #define PAGE_TO_MEMKB(pages) ((pages) * 4)
> diff --git a/tools/libxl/libxl_blktap2.c b/tools/libxl/libxl_blktap2.c
> index acf4110..2c40182 100644
> --- a/tools/libxl/libxl_blktap2.c
> +++ b/tools/libxl/libxl_blktap2.c
> @@ -12,13 +12,11 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> +#include "libxl_osdeps.h" /* must come before any other headers */
> #include "libxl_internal.h"
>
> #include "tap-ctl.h"
>
> -#include <string.h>
> -
> int libxl__blktap_enabled(libxl__gc *gc)
> {
> const char *msg;
> diff --git a/tools/libxl/libxl_bootloader.c b/tools/libxl/libxl_bootloader.c
> index ce83b8e..2da1d90 100644
> --- a/tools/libxl/libxl_bootloader.c
> +++ b/tools/libxl/libxl_bootloader.c
> @@ -12,15 +12,10 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> -#include <unistd.h>
> -#include <fcntl.h>
> #include <termios.h>
>
> -#include <sys/stat.h>
> -#include <sys/types.h>
> -
> #include "libxl_internal.h"
>
> #define XENCONSOLED_BUF_SIZE 16
> diff --git a/tools/libxl/libxl_cpuid.c b/tools/libxl/libxl_cpuid.c
> index 56a00cd..dcdb9d02 100644
> --- a/tools/libxl/libxl_cpuid.c
> +++ b/tools/libxl/libxl_cpuid.c
> @@ -10,6 +10,8 @@
> * GNU Lesser General Public License for more details.
> */
>
> +#include "libxl_osdeps.h" /* must come before any other headers */
> +
> #include "libxl_internal.h"
>
> void libxl_cpuid_dispose(libxl_cpuid_policy_list *p_cpuid_list)
> diff --git a/tools/libxl/libxl_create.c b/tools/libxl/libxl_create.c
> index ebf2ed7..9a6a94a 100644
> --- a/tools/libxl/libxl_create.c
> +++ b/tools/libxl/libxl_create.c
> @@ -15,20 +15,13 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> -
> -#include <stdio.h>
> -#include <string.h>
> -#include <stdlib.h>
> -#include <unistd.h>
> -#include <fcntl.h>
> -#include <xenctrl.h>
> -#include <xc_dom.h>
> -#include <xenguest.h>
> -#include <assert.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include "libxl_internal.h"
>
> +#include <xc_dom.h>
> +#include <xenguest.h>
> +
> void libxl_domain_config_dispose(libxl_domain_config *d_config)
> {
> int i;
> diff --git a/tools/libxl/libxl_device.c b/tools/libxl/libxl_device.c
> index 9b1fc57..5d05e90 100644
> --- a/tools/libxl/libxl_device.c
> +++ b/tools/libxl/libxl_device.c
> @@ -14,15 +14,7 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> -
> -#include <string.h>
> -#include <stdio.h>
> -#include <sys/time.h> /* for struct timeval */
> -#include <sys/types.h>
> -#include <sys/stat.h>
> -#include <unistd.h>
> -#include <fcntl.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include "libxl_internal.h"
>
> diff --git a/tools/libxl/libxl_dm.c b/tools/libxl/libxl_dm.c
> index 97d91b4..f0bf014 100644
> --- a/tools/libxl/libxl_dm.c
> +++ b/tools/libxl/libxl_dm.c
> @@ -15,15 +15,7 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> -
> -#include <stdio.h>
> -#include <string.h>
> -#include <stdlib.h>
> -#include <signal.h>
> -#include <unistd.h>
> -#include <fcntl.h>
> -#include <assert.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include "libxl_internal.h"
>
> diff --git a/tools/libxl/libxl_dom.c b/tools/libxl/libxl_dom.c
> index c898d89..b2259f8 100644
> --- a/tools/libxl/libxl_dom.c
> +++ b/tools/libxl/libxl_dom.c
> @@ -13,22 +13,13 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> -#include <stdio.h>
> -#include <assert.h>
> #include <glob.h>
> -#include <inttypes.h>
> -#include <string.h>
> -#include <sys/mman.h>
> -#include <sys/time.h> /* for struct timeval */
> -#include <sys/stat.h> /* for stat */
> -#include <unistd.h> /* for sleep(2) */
>
> #include <xenctrl.h>
> #include <xc_dom.h>
> #include <xenguest.h>
> -#include <fcntl.h>
>
> #include <xen/hvm/hvm_info_table.h>
>
> diff --git a/tools/libxl/libxl_exec.c b/tools/libxl/libxl_exec.c
> index 52d40d1..b10e79f 100644
> --- a/tools/libxl/libxl_exec.c
> +++ b/tools/libxl/libxl_exec.c
> @@ -15,18 +15,7 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> -
> -#include <stdio.h>
> -#include <string.h>
> -#include <unistd.h>
> -#include <stdlib.h>
> -#include <unistd.h>
> -#include <assert.h>
> -#include <sys/types.h>
> -#include <sys/wait.h>
> -#include <signal.h> /* for SIGKILL */
> -#include <fcntl.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include "libxl_internal.h"
>
> diff --git a/tools/libxl/libxl_flask.c b/tools/libxl/libxl_flask.c
> index 6b548dd..23f2476 100644
> --- a/tools/libxl/libxl_flask.c
> +++ b/tools/libxl/libxl_flask.c
> @@ -7,13 +7,7 @@
> * as published by the Free Software Foundation.
> */
>
> -#include "libxl_osdeps.h"
> -
> -#include <stdio.h>
> -#include <stdlib.h>
> -#include <string.h>
> -#include <errno.h>
> -#include <xenctrl.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include "libxl_internal.h"
>
> diff --git a/tools/libxl/libxl_internal.c b/tools/libxl/libxl_internal.c
> index cfa8c61..49b0dab 100644
> --- a/tools/libxl/libxl_internal.c
> +++ b/tools/libxl/libxl_internal.c
> @@ -13,15 +13,7 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> -
> -#include <stdio.h>
> -
> -#include <sys/types.h>
> -#include <sys/stat.h>
> -#include <fcntl.h>
> -#include <sys/mman.h>
> -#include <unistd.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include "libxl_internal.h"
>
> diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
> index 1bca869..d681d73 100644
> --- a/tools/libxl/libxl_internal.h
> +++ b/tools/libxl/libxl_internal.h
> @@ -17,17 +17,33 @@
> #ifndef LIBXL_INTERNAL_H
> #define LIBXL_INTERNAL_H
>
> -#include "libxl_osdeps.h"
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> -#include <stdint.h>
> +#include <assert.h>
> +#include <dirent.h>
> +#include <errno.h>
> +#include <fcntl.h>
> +#include <inttypes.h>
> +#include <pthread.h>
> +#include <signal.h>
> #include <stdarg.h>
> +#include <stddef.h>
> +#include <stdint.h>
> +#include <stdio.h>
> #include <stdlib.h>
> #include <string.h>
> -#include <pthread.h>
> +#include <unistd.h>
> +
> +#include <sys/mman.h>
> +#include <sys/select.h>
> +#include <sys/stat.h>
> #include <sys/time.h>
> +#include <sys/types.h>
> +#include <sys/wait.h>
>
> #include <xs.h>
> #include <xenctrl.h>
> +
> #include "xentoollog.h"
>
> #include <xen/io/xenbus.h>
> diff --git a/tools/libxl/libxl_json.c b/tools/libxl/libxl_json.c
> index c0f869e..6ff2910 100644
> --- a/tools/libxl/libxl_json.c
> +++ b/tools/libxl/libxl_json.c
> @@ -12,10 +12,8 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> -#include <assert.h>
> -#include <string.h>
> #include <math.h>
>
> #include <yajl/yajl_parse.h>
> diff --git a/tools/libxl/libxl_linux.c b/tools/libxl/libxl_linux.c
> index 786c6b5..925248b 100644
> --- a/tools/libxl/libxl_linux.c
> +++ b/tools/libxl/libxl_linux.c
> @@ -13,7 +13,7 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include <sys/stat.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include "libxl_internal.h"
>
> diff --git a/tools/libxl/libxl_netbsd.c b/tools/libxl/libxl_netbsd.c
> index 1e8d622..9e0ed6d 100644
> --- a/tools/libxl/libxl_netbsd.c
> +++ b/tools/libxl/libxl_netbsd.c
> @@ -13,7 +13,7 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include <sys/stat.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include "libxl_internal.h"
>
> diff --git a/tools/libxl/libxl_noblktap2.c b/tools/libxl/libxl_noblktap2.c
> index 3307551..246b0de 100644
> --- a/tools/libxl/libxl_noblktap2.c
> +++ b/tools/libxl/libxl_noblktap2.c
> @@ -12,6 +12,8 @@
> * GNU Lesser General Public License for more details.
> */
>
> +#include "libxl_osdeps.h" /* must come before any other headers */
> +
> #include "libxl_internal.h"
>
> int libxl__blktap_enabled(libxl__gc *gc)
> diff --git a/tools/libxl/libxl_nocpuid.c b/tools/libxl/libxl_nocpuid.c
> index 2e9490c..9e52f8d 100644
> --- a/tools/libxl/libxl_nocpuid.c
> +++ b/tools/libxl/libxl_nocpuid.c
> @@ -10,6 +10,8 @@
> * GNU Lesser General Public License for more details.
> */
>
> +#include "libxl_osdeps.h" /* must come before any other headers */
> +
> #include "libxl_internal.h"
>
> void libxl_cpuid_destroy(libxl_cpuid_policy_list *p_cpuid_list)
> diff --git a/tools/libxl/libxl_paths.c b/tools/libxl/libxl_paths.c
> index e7bd1a2..a95d29f 100644
> --- a/tools/libxl/libxl_paths.c
> +++ b/tools/libxl/libxl_paths.c
> @@ -12,6 +12,7 @@
> * GNU Lesser General Public License for more details.
> */
>
> +#include "libxl_osdeps.h" /* must come before any other headers */
> #include "libxl_internal.h"
> #include "_libxl_paths.h"
>
> diff --git a/tools/libxl/libxl_pci.c b/tools/libxl/libxl_pci.c
> index 8b2a1c5..c3828f6 100644
> --- a/tools/libxl/libxl_pci.c
> +++ b/tools/libxl/libxl_pci.c
> @@ -14,21 +14,7 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> -
> -#include <stdio.h>
> -#include <stdlib.h>
> -#include <sys/types.h>
> -#include <fcntl.h>
> -#include <sys/select.h>
> -#include <sys/mman.h>
> -#include <sys/wait.h>
> -#include <sys/stat.h>
> -#include <signal.h>
> -#include <unistd.h> /* for write, unlink and close */
> -#include <inttypes.h>
> -#include <dirent.h>
> -#include <assert.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include "libxl_internal.h"
>
> diff --git a/tools/libxl/libxl_qmp.c b/tools/libxl/libxl_qmp.c
> index 3dfa43a..61d9769 100644
> --- a/tools/libxl/libxl_qmp.c
> +++ b/tools/libxl/libxl_qmp.c
> @@ -18,12 +18,10 @@
> * Specification, see in the QEMU repository.
> */
>
> -#include "libxl_osdeps.h"
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> -#include <unistd.h>
> #include <sys/un.h>
> #include <sys/queue.h>
> -#include <fcntl.h>
>
> #include <yajl/yajl_gen.h>
>
> diff --git a/tools/libxl/libxl_utils.c b/tools/libxl/libxl_utils.c
> index d36c737..dbe8891 100644
> --- a/tools/libxl/libxl_utils.c
> +++ b/tools/libxl/libxl_utils.c
> @@ -13,20 +13,9 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> -
> -#include <stdio.h>
> -#include <stdlib.h>
> -#include <stdint.h>
> -#include <string.h>
> -#include <xs.h>
> -#include <xenctrl.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
> +
> #include <ctype.h>
> -#include <errno.h>
> -#include <sys/stat.h>
> -#include <sys/types.h>
> -#include <unistd.h>
> -#include <assert.h>
>
> #include "libxl_internal.h"
>
> diff --git a/tools/libxl/libxl_uuid.c b/tools/libxl/libxl_uuid.c
> index 80ab789..7c18d71 100644
> --- a/tools/libxl/libxl_uuid.c
> +++ b/tools/libxl/libxl_uuid.c
> @@ -12,7 +12,7 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include <libxl_uuid.h>
>
> diff --git a/tools/libxl/libxl_xshelp.c b/tools/libxl/libxl_xshelp.c
> index ea835e2..6958d21 100644
> --- a/tools/libxl/libxl_xshelp.c
> +++ b/tools/libxl/libxl_xshelp.c
> @@ -13,13 +13,7 @@
> * GNU Lesser General Public License for more details.
> */
>
> -#include "libxl_osdeps.h"
> -
> -#include <string.h>
> -#include <stddef.h>
> -#include <stdio.h>
> -#include <stdarg.h>
> -#include <inttypes.h>
> +#include "libxl_osdeps.h" /* must come before any other headers */
>
> #include "libxl_internal.h"
>
> diff --git a/tools/libxl/libxlu_cfg.c b/tools/libxl/libxlu_cfg.c
> index 0d1c5d3..e3659c7 100644
> --- a/tools/libxl/libxlu_cfg.c
> +++ b/tools/libxl/libxlu_cfg.c
> @@ -16,6 +16,8 @@
> */
>
>
> +#include "libxl_osdeps.h" /* must come before any other headers */
> +
> #include <limits.h>
>
> #include "libxlu_internal.h"
> diff --git a/tools/libxl/libxlu_cfg_i.h b/tools/libxl/libxlu_cfg_i.h
> index ea6a326..54d033c 100644
> --- a/tools/libxl/libxlu_cfg_i.h
> +++ b/tools/libxl/libxlu_cfg_i.h
> @@ -18,6 +18,7 @@
> #ifndef LIBXLU_CFG_I_H
> #define LIBXLU_CFG_I_H
>
> +#include "libxl_osdeps.h" /* must come before any other headers */
> #include "libxlu_internal.h"
> #include "libxlu_cfg_y.h"
>
> diff --git a/tools/libxl/libxlu_disk.c b/tools/libxl/libxlu_disk.c
> index 88b79ac..6cd86e9 100644
> --- a/tools/libxl/libxlu_disk.c
> +++ b/tools/libxl/libxlu_disk.c
> @@ -1,3 +1,4 @@
> +#include "libxl_osdeps.h" /* must come before any other headers */
> #include "libxlu_internal.h"
> #include "libxlu_disk_l.h"
> #include "libxlu_disk_i.h"
> diff --git a/tools/libxl/libxlu_disk_i.h b/tools/libxl/libxlu_disk_i.h
> index 4fccd4a..37246f2 100644
> --- a/tools/libxl/libxlu_disk_i.h
> +++ b/tools/libxl/libxlu_disk_i.h
> @@ -1,6 +1,8 @@
> #ifndef LIBXLU_DISK_I_H
> #define LIBXLU_DISK_I_H
>
> +#include "libxl_osdeps.h" /* must come before any other headers */
> +
> #include "libxlu_internal.h"
>
>
> --
> 1.7.2.5
>
>
> _______________________________________________
> Xen-devel mailing list
> Xen-devel@lists.xensource.com
> http://lists.xensource.com/xen-devel
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h
2012-01-13 10:41 ` Ian Campbell
@ 2012-01-13 13:37 ` Ian Jackson
2012-01-13 13:39 ` Ian Campbell
0 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-13 13:37 UTC (permalink / raw)
To: Ian Campbell; +Cc: xen-devel@lists.xensource.com
Ian Campbell writes ("Re: [Xen-devel] [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h"):
> Could we put this first in libxl_internal.h and apply that constraint to
> that header instead?
In theory, yes. But in practice people very much seem to like to add
new system headers to individual files. And if you forget and add
them in the wrong place it can lead to subtle portability bugs which
you might not notice.
So I think this is a more obvious way to do it, even though it's an
extra #include line in each file.
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h
2012-01-13 13:37 ` Ian Jackson
@ 2012-01-13 13:39 ` Ian Campbell
2012-01-13 16:23 ` Ian Jackson
0 siblings, 1 reply; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 13:39 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-13 at 13:37 +0000, Ian Jackson wrote:
> Ian Campbell writes ("Re: [Xen-devel] [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h"):
> > Could we put this first in libxl_internal.h and apply that constraint to
> > that header instead?
>
> In theory, yes. But in practice people very much seem to like to add
> new system headers to individual files. And if you forget and add
> them in the wrong place it can lead to subtle portability bugs which
> you might not notice.
>
> So I think this is a more obvious way to do it, even though it's an
> extra #include line in each file.
Sure, that fine.
I suppose using -include (or whatever its real name is) on the compiler
command line is too skanky?
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h
2012-01-13 13:39 ` Ian Campbell
@ 2012-01-13 16:23 ` Ian Jackson
0 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-13 16:23 UTC (permalink / raw)
To: Ian Campbell; +Cc: xen-devel@lists.xensource.com
Ian Campbell writes ("Re: [Xen-devel] [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h"):
> On Fri, 2012-01-13 at 13:37 +0000, Ian Jackson wrote:
> > So I think this is a more obvious way to do it, even though it's an
> > extra #include line in each file.
>
> Sure, that fine.
>
> I suppose using -include (or whatever its real name is) on the compiler
> command line is too skanky?
Personally I think that's a very annoying hack and should be avoided.
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread
* [PATCH 04/10] libxl: Provide more formal libxl__ctx_lock and _unlock
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (2 preceding siblings ...)
2012-01-06 20:35 ` [PATCH 03/10] libxl: move a lot more includes into libxl_internal.h Ian Jackson
@ 2012-01-06 20:35 ` Ian Jackson
2012-01-13 10:42 ` Ian Campbell
2012-01-06 20:35 ` [PATCH 05/10] libxl: Fix leaks on context init failure Ian Jackson
` (11 subsequent siblings)
15 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-06 20:35 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
Previously the only official interface for the ctx lock was the
CTX_LOCK and CTX_UNLOCK convenience macros, which assume and use "ctx"
from the surrounding scope.
Instead, provide libxl__ctx_lock and _unlock functions which can be
used by these convenience macros, and other callers who have
nonstandard requirements.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl_internal.h | 23 +++++++++++++----------
1 files changed, 13 insertions(+), 10 deletions(-)
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index d681d73..1dadf15 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -115,7 +115,8 @@ struct libxl__ctx {
struct xs_handle *xsh;
pthread_mutex_t lock; /* protects data structures hanging off the ctx */
- /* Always use CTX_LOCK and CTX_UNLOCK to manipulate this.
+ /* Always use libxl__ctx_lock and _unlock (or the convenience
+ * macors CTX_LOCK and CTX_UNLOCK) to manipulate this.
*
* You may acquire this mutex recursively if it is convenient to
* do so. You may not acquire this lock at the same time as any
@@ -749,16 +750,18 @@ libxl__device_model_version_running(libxl__gc *gc, uint32_t domid);
/* Locking functions. See comment for "lock" member of libxl__ctx. */
-#define CTX_LOCK do { \
- int mutex_r = pthread_mutex_lock(&CTX->lock); \
- assert(!mutex_r); \
- } while(0)
+static inline void libxl__ctx_lock(libxl_ctx *ctx) {
+ int r = pthread_mutex_lock(&ctx->lock);
+ assert(!r);
+}
-#define CTX_UNLOCK do { \
- int mutex_r = pthread_mutex_unlock(&CTX->lock); \
- assert(!mutex_r); \
- } while(0)
-
+static inline void libxl__ctx_unlock(libxl_ctx *ctx) {
+ int r = pthread_mutex_unlock(&ctx->lock);
+ assert(!r);
+}
+
+#define CTX_LOCK (libxl__ctx_lock(CTX))
+#define CTX_UNLOCK (libxl__ctx_unlock(CTX))
/*
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* Re: [PATCH 04/10] libxl: Provide more formal libxl__ctx_lock and _unlock
2012-01-06 20:35 ` [PATCH 04/10] libxl: Provide more formal libxl__ctx_lock and _unlock Ian Jackson
@ 2012-01-13 10:42 ` Ian Campbell
0 siblings, 0 replies; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 10:42 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-06 at 20:35 +0000, Ian Jackson wrote:
> Previously the only official interface for the ctx lock was the
> CTX_LOCK and CTX_UNLOCK convenience macros, which assume and use "ctx"
> from the surrounding scope.
>
> Instead, provide libxl__ctx_lock and _unlock functions which can be
> used by these convenience macros, and other callers who have
> nonstandard requirements.
>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
> ---
> tools/libxl/libxl_internal.h | 23 +++++++++++++----------
> 1 files changed, 13 insertions(+), 10 deletions(-)
>
> diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
> index d681d73..1dadf15 100644
> --- a/tools/libxl/libxl_internal.h
> +++ b/tools/libxl/libxl_internal.h
> @@ -115,7 +115,8 @@ struct libxl__ctx {
> struct xs_handle *xsh;
>
> pthread_mutex_t lock; /* protects data structures hanging off the ctx */
> - /* Always use CTX_LOCK and CTX_UNLOCK to manipulate this.
> + /* Always use libxl__ctx_lock and _unlock (or the convenience
> + * macors CTX_LOCK and CTX_UNLOCK) to manipulate this.
> *
> * You may acquire this mutex recursively if it is convenient to
> * do so. You may not acquire this lock at the same time as any
> @@ -749,16 +750,18 @@ libxl__device_model_version_running(libxl__gc *gc, uint32_t domid);
>
> /* Locking functions. See comment for "lock" member of libxl__ctx. */
>
> -#define CTX_LOCK do { \
> - int mutex_r = pthread_mutex_lock(&CTX->lock); \
> - assert(!mutex_r); \
> - } while(0)
> +static inline void libxl__ctx_lock(libxl_ctx *ctx) {
> + int r = pthread_mutex_lock(&ctx->lock);
> + assert(!r);
> +}
>
> -#define CTX_UNLOCK do { \
> - int mutex_r = pthread_mutex_unlock(&CTX->lock); \
> - assert(!mutex_r); \
> - } while(0)
> -
> +static inline void libxl__ctx_unlock(libxl_ctx *ctx) {
> + int r = pthread_mutex_unlock(&ctx->lock);
> + assert(!r);
> +}
> +
> +#define CTX_LOCK (libxl__ctx_lock(CTX))
> +#define CTX_UNLOCK (libxl__ctx_unlock(CTX))
>
>
> /*
^ permalink raw reply [flat|nested] 43+ messages in thread
* [PATCH 05/10] libxl: Fix leaks on context init failure
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (3 preceding siblings ...)
2012-01-06 20:35 ` [PATCH 04/10] libxl: Provide more formal libxl__ctx_lock and _unlock Ian Jackson
@ 2012-01-06 20:35 ` Ian Jackson
2012-01-13 10:43 ` Ian Campbell
2012-01-06 20:35 ` [PATCH 06/10] DROP: libxl: rename libxl__free_all Ian Jackson
` (10 subsequent siblings)
15 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-06 20:35 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
Several of the error exits from libxl_ctx_alloc leaked the context
struct itself and sometimes other resources too.
Fix this by using the standard "rc = ERROR_FOO; goto out" error
handling style throughout.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl.c | 20 ++++++++++++--------
1 files changed, 12 insertions(+), 8 deletions(-)
diff --git a/tools/libxl/libxl.c b/tools/libxl/libxl.c
index 2d3e8cd..8ecce26 100644
--- a/tools/libxl/libxl.c
+++ b/tools/libxl/libxl.c
@@ -24,17 +24,17 @@
int libxl_ctx_alloc(libxl_ctx **pctx, int version,
unsigned flags, xentoollog_logger * lg)
{
- libxl_ctx *ctx;
+ libxl_ctx *ctx = NULL;
struct stat stat_buf;
const pthread_mutex_t mutex_value = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;
+ int rc;
- if (version != LIBXL_VERSION)
- return ERROR_VERSION;
+ if (version != LIBXL_VERSION) { rc = ERROR_VERSION; goto out; }
ctx = malloc(sizeof(*ctx));
if (!ctx) {
LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "Failed to allocate context\n");
- return ERROR_NOMEM;
+ rc = ERROR_NOMEM; goto out;
}
memset(ctx, 0, sizeof(libxl_ctx));
@@ -48,14 +48,14 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
if ( stat(XENSTORE_PID_FILE, &stat_buf) != 0 ) {
LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "Is xenstore daemon running?\n"
"failed to stat %s", XENSTORE_PID_FILE);
- return ERROR_FAIL;
+ rc = ERROR_FAIL; goto out;
}
ctx->xch = xc_interface_open(lg,lg,0);
if (!ctx->xch) {
LIBXL__LOG_ERRNOVAL(ctx, LIBXL__LOG_ERROR, errno,
"cannot open libxc handle");
- return ERROR_FAIL;
+ rc = ERROR_FAIL; goto out;
}
ctx->xsh = xs_daemon_open();
@@ -64,12 +64,16 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
if (!ctx->xsh) {
LIBXL__LOG_ERRNOVAL(ctx, LIBXL__LOG_ERROR, errno,
"cannot connect to xenstore");
- xc_interface_close(ctx->xch);
- return ERROR_FAIL;
+ rc = ERROR_FAIL; goto out;
}
*pctx = ctx;
return 0;
+
+ out:
+ libxl_ctx_free(ctx);
+ *pctx = NULL;
+ return rc;
}
int libxl_ctx_free(libxl_ctx *ctx)
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* Re: [PATCH 05/10] libxl: Fix leaks on context init failure
2012-01-06 20:35 ` [PATCH 05/10] libxl: Fix leaks on context init failure Ian Jackson
@ 2012-01-13 10:43 ` Ian Campbell
2012-01-13 15:58 ` Ian Jackson
0 siblings, 1 reply; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 10:43 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-06 at 20:35 +0000, Ian Jackson wrote:
> Several of the error exits from libxl_ctx_alloc leaked the context
> struct itself and sometimes other resources too.
>
> Fix this by using the standard "rc = ERROR_FOO; goto out" error
> handling style throughout.
>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
> ---
> tools/libxl/libxl.c | 20 ++++++++++++--------
> 1 files changed, 12 insertions(+), 8 deletions(-)
>
> diff --git a/tools/libxl/libxl.c b/tools/libxl/libxl.c
> index 2d3e8cd..8ecce26 100644
> --- a/tools/libxl/libxl.c
> +++ b/tools/libxl/libxl.c
> @@ -24,17 +24,17 @@
> int libxl_ctx_alloc(libxl_ctx **pctx, int version,
> unsigned flags, xentoollog_logger * lg)
> {
> - libxl_ctx *ctx;
> + libxl_ctx *ctx = NULL;
> struct stat stat_buf;
> const pthread_mutex_t mutex_value = PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP;
> + int rc;
>
> - if (version != LIBXL_VERSION)
> - return ERROR_VERSION;
> + if (version != LIBXL_VERSION) { rc = ERROR_VERSION; goto out; }
Aside: we really ought to have been cranking this number and probably
the SONAME too. 4.2 should definitely differ from 4.1 in at least one of
those, if not both.
Ian.
>
> ctx = malloc(sizeof(*ctx));
> if (!ctx) {
> LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "Failed to allocate context\n");
> - return ERROR_NOMEM;
> + rc = ERROR_NOMEM; goto out;
> }
>
> memset(ctx, 0, sizeof(libxl_ctx));
> @@ -48,14 +48,14 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
> if ( stat(XENSTORE_PID_FILE, &stat_buf) != 0 ) {
> LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "Is xenstore daemon running?\n"
> "failed to stat %s", XENSTORE_PID_FILE);
> - return ERROR_FAIL;
> + rc = ERROR_FAIL; goto out;
> }
>
> ctx->xch = xc_interface_open(lg,lg,0);
> if (!ctx->xch) {
> LIBXL__LOG_ERRNOVAL(ctx, LIBXL__LOG_ERROR, errno,
> "cannot open libxc handle");
> - return ERROR_FAIL;
> + rc = ERROR_FAIL; goto out;
> }
>
> ctx->xsh = xs_daemon_open();
> @@ -64,12 +64,16 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
> if (!ctx->xsh) {
> LIBXL__LOG_ERRNOVAL(ctx, LIBXL__LOG_ERROR, errno,
> "cannot connect to xenstore");
> - xc_interface_close(ctx->xch);
> - return ERROR_FAIL;
> + rc = ERROR_FAIL; goto out;
> }
>
> *pctx = ctx;
> return 0;
> +
> + out:
> + libxl_ctx_free(ctx);
> + *pctx = NULL;
> + return rc;
> }
>
> int libxl_ctx_free(libxl_ctx *ctx)
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 05/10] libxl: Fix leaks on context init failure
2012-01-13 10:43 ` Ian Campbell
@ 2012-01-13 15:58 ` Ian Jackson
0 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-13 15:58 UTC (permalink / raw)
To: Ian Campbell; +Cc: xen-devel@lists.xensource.com
Ian Campbell writes ("Re: [Xen-devel] [PATCH 05/10] libxl: Fix leaks on context init failure"):
> Aside: we really ought to have been cranking this number and probably
> the SONAME too. 4.2 should definitely differ from 4.1 in at least one of
> those, if not both.
Makefile's MAJOR has already been updated AFAICT:
commit 8d3cedd3b6719d1a1f4a962f4ffece1355d77642
Author: Ian Campbell <ian.campbell@citrix.com>
Date: Fri Apr 8 16:17:18 2011 +0100
libxl: bump SONAME after binary incompatible change.
mariner:libxl> git-describe --tags 8d3cedd3
4.1.0-branched-212-g8d3cedd
mariner:libxl>
I'm not sure the version checking stuff in libxl_init serves any
useful function.
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread
* [PATCH 06/10] DROP: libxl: rename libxl__free_all
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (4 preceding siblings ...)
2012-01-06 20:35 ` [PATCH 05/10] libxl: Fix leaks on context init failure Ian Jackson
@ 2012-01-06 20:35 ` Ian Jackson
2012-01-06 20:35 ` [PATCH 07/10] libxl: New API for providing OS events to libxl Ian Jackson
` (9 subsequent siblings)
15 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-06 20:35 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
*** THIS PATCH WILL PROBABLY BE DROPPED as it is no longer needed
in the current version of later patches. ***
libxl__free_all is going to gain some extra functionality, which will
mean that the name is no longer accurate. Rename it to
libxl__gc_cleanup.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
---
tools/libxl/libxl.h | 2 +-
tools/libxl/libxl_internal.c | 2 +-
tools/libxl/libxl_internal.h | 4 ++--
tools/libxl/libxl_qmp.c | 2 +-
4 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h
index 723eac2..9ae7cea 100644
--- a/tools/libxl/libxl.h
+++ b/tools/libxl/libxl.h
@@ -119,7 +119,7 @@
*
* No temporary objects allocated from the pool may be explicitly freed.
* Therefore public functions which initialize a libxl__gc MUST call
- * libxl__free_all() before returning.
+ * libxl__gc_cleanup() before returning.
*/
#ifndef LIBXL_H
#define LIBXL_H
diff --git a/tools/libxl/libxl_internal.c b/tools/libxl/libxl_internal.c
index 49b0dab..cc98d86 100644
--- a/tools/libxl/libxl_internal.c
+++ b/tools/libxl/libxl_internal.c
@@ -53,7 +53,7 @@ int libxl__ptr_add(libxl__gc *gc, void *ptr)
return 0;
}
-void libxl__free_all(libxl__gc *gc)
+void libxl__gc_cleanup(libxl__gc *gc)
{
void *ptr;
int i;
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index 1dadf15..df1dfde 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -190,7 +190,7 @@ static inline libxl_ctx *libxl__gc_owner(libxl__gc *gc)
/* register @ptr in @gc for free on exit from outermost libxl callframe. */
_hidden int libxl__ptr_add(libxl__gc *gc, void *ptr);
/* if this is the outermost libxl callframe then free all pointers in @gc */
-_hidden void libxl__free_all(libxl__gc *gc);
+_hidden void libxl__gc_cleanup(libxl__gc *gc);
/* allocate and zero @bytes. (similar to a gc'd malloc(3)+memzero()) */
_hidden void *libxl__zalloc(libxl__gc *gc, int bytes);
/* allocate and zero memory for an array of @nmemb members of @size each.
@@ -744,7 +744,7 @@ libxl__device_model_version_running(libxl__gc *gc, uint32_t domid);
*/
#define GC_INIT(ctx) libxl__gc gc[1]; LIBXL_INIT_GC(gc[0],ctx)
-#define GC_FREE libxl__free_all(gc)
+#define GC_FREE libxl__gc_cleanup(gc)
#define CTX libxl__gc_owner(gc)
diff --git a/tools/libxl/libxl_qmp.c b/tools/libxl/libxl_qmp.c
index 61d9769..58f5283 100644
--- a/tools/libxl/libxl_qmp.c
+++ b/tools/libxl/libxl_qmp.c
@@ -528,7 +528,7 @@ static int qmp_send(libxl__qmp_handler *qmp,
rc = qmp->last_id_used;
out:
- libxl__free_all(&gc);
+ libxl__gc_cleanup(&gc);
return rc;
}
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* [PATCH 07/10] libxl: New API for providing OS events to libxl
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (5 preceding siblings ...)
2012-01-06 20:35 ` [PATCH 06/10] DROP: libxl: rename libxl__free_all Ian Jackson
@ 2012-01-06 20:35 ` Ian Jackson
2012-01-11 17:32 ` Stefano Stabellini
2012-01-13 15:07 ` Ian Campbell
2012-01-06 20:35 ` [PATCH 08/10] libxl: New event generation API Ian Jackson
` (8 subsequent siblings)
15 siblings, 2 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-06 20:35 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
We provide a new set of functions and related structures
libxl_osevent_*
which are to be used by event-driven applications to receive
information from libxl about which fds libxl is interested in, and
what timeouts libxl is waiting for, and to pass back to libxl
information about which fds are readable/writeable etc., and which
timeouts have occurred. Ie, low-level events.
In this patch, this new machinery is still all unused. Callers will
appear in the next patch in the series, which introduces a new API for
applications to receive high-level events about actual domains etc.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/Makefile | 2 +-
tools/libxl/libxl.c | 30 ++
tools/libxl/libxl.h | 6 +
tools/libxl/libxl_event.c | 748 ++++++++++++++++++++++++++++++++++++++++++
tools/libxl/libxl_event.h | 204 ++++++++++++
tools/libxl/libxl_internal.h | 266 +++++++++++++++-
6 files changed, 1252 insertions(+), 4 deletions(-)
create mode 100644 tools/libxl/libxl_event.c
create mode 100644 tools/libxl/libxl_event.h
diff --git a/tools/libxl/Makefile b/tools/libxl/Makefile
index 78bc589..8bdc308 100644
--- a/tools/libxl/Makefile
+++ b/tools/libxl/Makefile
@@ -47,7 +47,7 @@ LIBXL_LIBS += -lyajl
LIBXL_OBJS = flexarray.o libxl.o libxl_create.o libxl_dm.o libxl_pci.o \
libxl_dom.o libxl_exec.o libxl_xshelp.o libxl_device.o \
libxl_internal.o libxl_utils.o libxl_uuid.o libxl_json.o \
- libxl_qmp.o $(LIBXL_OBJS-y)
+ libxl_qmp.o libxl_event.o $(LIBXL_OBJS-y)
LIBXL_OBJS += _libxl_types.o libxl_flask.o _libxl_types_internal.o
$(LIBXL_OBJS): CFLAGS += $(CFLAGS_libxenctrl) $(CFLAGS_libxenguest) $(CFLAGS_libxenstore) $(CFLAGS_libblktapctl)
diff --git a/tools/libxl/libxl.c b/tools/libxl/libxl.c
index 8ecce26..c0024af 100644
--- a/tools/libxl/libxl.c
+++ b/tools/libxl/libxl.c
@@ -45,6 +45,16 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
* only as an initialiser, not as an expression. */
memcpy(&ctx->lock, &mutex_value, sizeof(ctx->lock));
+ ctx->osevent_hooks = 0;
+
+ ctx->fd_rindex = 0;
+ LIBXL_LIST_INIT(&ctx->efds);
+ LIBXL_TAILQ_INIT(&ctx->etimes);
+
+ ctx->watch_slots = 0;
+ LIBXL_SLIST_INIT(&ctx->watch_freeslots);
+ libxl__ev_fd_init(&ctx->watch_efd);
+
if ( stat(XENSTORE_PID_FILE, &stat_buf) != 0 ) {
LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "Is xenstore daemon running?\n"
"failed to stat %s", XENSTORE_PID_FILE);
@@ -79,9 +89,29 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
int libxl_ctx_free(libxl_ctx *ctx)
{
if (!ctx) return 0;
+
+ int i;
+ GC_INIT(ctx);
+
+ /* Deregister all libxl__ev_KINDs: */
+
+ for (i = 0; i < ctx->watch_nslots; i++)
+ assert(!libxl__watch_slot_contents(gc, i));
+ libxl__ev_fd_deregister(gc, &ctx->watch_efd);
+
+ /* Now there should be no more events requested from the application: */
+
+ assert(LIBXL_LIST_EMPTY(&ctx->efds));
+ assert(LIBXL_TAILQ_EMPTY(&ctx->etimes));
+
if (ctx->xch) xc_interface_close(ctx->xch);
libxl_version_info_dispose(&ctx->version_info);
if (ctx->xsh) xs_daemon_close(ctx->xsh);
+
+ free(ctx->fd_rindex);
+ free(ctx->watch_slots);
+
+ GC_FREE;
free(ctx);
return 0;
}
diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h
index 9ae7cea..c0a4373 100644
--- a/tools/libxl/libxl.h
+++ b/tools/libxl/libxl.h
@@ -137,6 +137,7 @@
#include <xen/sysctl.h>
#include <libxl_uuid.h>
+#include <_libxl_list.h>
typedef uint8_t libxl_mac[6];
#define LIBXL_MAC_FMT "%02hhx:%02hhx:%02hhx:%02hhx:%02hhx:%02hhx"
@@ -223,6 +224,9 @@ enum {
ERROR_GUEST_TIMEDOUT = -8,
ERROR_TIMEDOUT = -9,
ERROR_NOPARAVIRT = -10,
+ ERROR_NOT_READY = -11,
+ ERROR_OSEVENT_REG_FAIL = -12,
+ ERROR_BUFFERFULL = -13,
};
#define LIBXL_VERSION 0
@@ -648,6 +652,8 @@ const char *libxl_xenpaging_dir_path(void);
/* misc */
int libxl_fd_set_cloexec(int fd);
+#include <libxl_event.h>
+
#endif /* LIBXL_H */
/*
diff --git a/tools/libxl/libxl_event.c b/tools/libxl/libxl_event.c
new file mode 100644
index 0000000..e71ab66
--- /dev/null
+++ b/tools/libxl/libxl_event.c
@@ -0,0 +1,748 @@
+/*
+ * Copyright (C) 2011 Citrix Ltd.
+ *
+ * This program 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; version 2.1 only. with the special
+ * exception on linking described in file LICENSE.
+ *
+ * This program 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.
+ */
+/*
+ * Internal event machinery for use by other parts of libxl
+ */
+
+#include <poll.h>
+
+#include "libxl_internal.h"
+
+/*
+ * The counter osevent_in_hook is used to ensure that the application
+ * honours the reentrancy restriction documented in libxl_event.h.
+ *
+ * The application's registration hooks should be called ONLY via
+ * these macros, with the ctx locked. Likewise all the "occurred"
+ * entrypoints from the application should assert(!in_hook);
+ */
+#define OSEVENT_HOOK_INTERN(defval, hookname, ...) \
+ (CTX->osevent_hooks \
+ ? (CTX->osevent_in_hook++, \
+ CTX->osevent_hooks->hookname(CTX->osevent_user, __VA_ARGS__), \
+ CTX->osevent_in_hook--) \
+ : defval)
+
+#define OSEVENT_HOOK(hookname,...) \
+ OSEVENT_HOOK_INTERN(0, hookname, __VA_ARGS__)
+
+#define OSEVENT_HOOK_VOID(hookname,...) \
+ OSEVENT_HOOK_INTERN((void)0, hookname, __VA_ARGS__)
+
+/*
+ * fd events
+ */
+
+int libxl__ev_fd_register(libxl__gc *gc, libxl__ev_fd *ev,
+ libxl__ev_fd_callback *func,
+ int fd, short events)
+{
+ int rc;
+
+ assert(fd >= 0);
+
+ CTX_LOCK;
+
+ rc = OSEVENT_HOOK(fd_register, fd, &ev->for_app_reg, events, ev);
+ if (rc) goto out;
+
+ ev->fd = fd;
+ ev->events = events;
+ ev->func = func;
+
+ LIBXL_LIST_INSERT_HEAD(&CTX->efds, ev, entry);
+
+ rc = 0;
+
+ out:
+ CTX_UNLOCK;
+ return rc;
+}
+
+int libxl__ev_fd_modify(libxl__gc *gc, libxl__ev_fd *ev, short events)
+{
+ int rc;
+
+ CTX_LOCK;
+ assert(libxl__ev_fd_isregistered(ev));
+
+ rc = OSEVENT_HOOK(fd_modify, ev->fd, &ev->for_app_reg, events);
+ if (rc) goto out;
+
+ ev->events = events;
+
+ rc = 0;
+ out:
+ CTX_UNLOCK;
+ return rc;
+}
+
+void libxl__ev_fd_deregister(libxl__gc *gc, libxl__ev_fd *ev)
+{
+ CTX_LOCK;
+
+ if (!libxl__ev_fd_isregistered(ev))
+ goto out;
+
+ OSEVENT_HOOK_VOID(fd_deregister, ev->fd, ev->for_app_reg);
+ LIBXL_LIST_REMOVE(ev, entry);
+ ev->fd = -1;
+
+ out:
+ CTX_UNLOCK;
+}
+
+/*
+ * timeouts
+ */
+
+
+int libxl__gettimeofday(libxl__gc *gc, struct timeval *now_r)
+{
+ int rc = gettimeofday(now_r, 0);
+ if (rc) {
+ LIBXL__LOG_ERRNO(CTX, LIBXL__LOG_ERROR, "gettimeofday failed");
+ return ERROR_FAIL;
+ }
+ return 0;
+}
+
+static int time_rel_to_abs(libxl__gc *gc, int ms, struct timeval *abs_out)
+{
+ int rc;
+ struct timeval additional = {
+ .tv_sec = ms / 1000,
+ .tv_usec = (ms % 1000) * 1000
+ };
+ struct timeval now;
+
+ rc = libxl__gettimeofday(gc, &now);
+ if (rc) return rc;
+
+ timeradd(&now, &additional, abs_out);
+ return 0;
+}
+
+static void time_insert_finite(libxl__gc *gc, libxl__ev_time *ev)
+{
+ libxl__ev_time *evsearch;
+ LIBXL_TAILQ_INSERT_SORTED(&CTX->etimes, entry, ev, evsearch, /*empty*/,
+ timercmp(&ev->abs, &evsearch->abs, >));
+ ev->infinite = 0;
+}
+
+static int time_register_finite(libxl__gc *gc, libxl__ev_time *ev,
+ struct timeval abs) {
+ int rc;
+
+ rc = OSEVENT_HOOK(timeout_register, &ev->for_app_reg, abs, ev);
+ if (rc) return rc;
+
+ ev->infinite = 0;
+ ev->abs = abs;
+ time_insert_finite(gc, ev);
+
+ return 0;
+}
+
+static void time_deregister(libxl__gc *gc, libxl__ev_time *ev)
+{
+ if (!ev->infinite) {
+ OSEVENT_HOOK_VOID(timeout_deregister, &ev->for_app_reg);
+ LIBXL_TAILQ_REMOVE(&CTX->etimes, ev, entry);
+ }
+}
+
+
+int libxl__ev_time_register_abs(libxl__gc *gc, libxl__ev_time *ev,
+ libxl__ev_time_callback *func,
+ struct timeval abs)
+{
+ int rc;
+
+ CTX_LOCK;
+
+ rc = time_register_finite(gc, ev, abs);
+ if (rc) goto out;
+
+ ev->func = func;
+
+ rc = 0;
+ out:
+ CTX_UNLOCK;
+ return rc;
+}
+
+
+int libxl__ev_time_register_rel(libxl__gc *gc, libxl__ev_time *ev,
+ libxl__ev_time_callback *func,
+ int milliseconds /* as for poll(2) */)
+{
+ struct timeval abs;
+ int rc;
+
+ CTX_LOCK;
+
+ if (milliseconds < 0) {
+ ev->infinite = 1;
+ } else {
+ rc = time_rel_to_abs(gc, milliseconds, &abs);
+ if (rc) goto out;
+
+ rc = time_register_finite(gc, ev, abs);
+ if (rc) goto out;
+ }
+
+ ev->func = func;
+ rc = 0;
+
+ out:
+ CTX_UNLOCK;
+ return rc;
+}
+
+int libxl__ev_time_modify_abs(libxl__gc *gc, libxl__ev_time *ev,
+ struct timeval abs)
+{
+ int rc;
+
+ CTX_LOCK;
+
+ assert(libxl__ev_time_isregistered(ev));
+
+ if (ev->infinite) {
+ rc = time_register_finite(gc, ev, abs);
+ if (rc) goto out;
+ } else {
+ rc = OSEVENT_HOOK(timeout_modify, &ev->for_app_reg, abs);
+ if (rc) goto out;
+
+ LIBXL_TAILQ_REMOVE(&CTX->etimes, ev, entry);
+ ev->abs = abs;
+ time_insert_finite(gc, ev);
+ }
+
+ rc = 0;
+ out:
+ CTX_UNLOCK;
+ return rc;
+}
+
+int libxl__ev_time_modify_rel(libxl__gc *gc, libxl__ev_time *ev,
+ int milliseconds)
+{
+ struct timeval abs;
+ int rc;
+
+ CTX_LOCK;
+
+ assert(libxl__ev_time_isregistered(ev));
+
+ if (milliseconds < 0) {
+ time_deregister(gc, ev);
+ ev->infinite = 1;
+ rc = 0;
+ goto out;
+ }
+
+ rc = time_rel_to_abs(gc, milliseconds, &abs);
+ if (rc) goto out;
+
+ rc = libxl__ev_time_modify_abs(gc, ev, abs);
+ if (rc) goto out;
+
+ rc = 0;
+ out:
+ CTX_UNLOCK;
+ return rc;
+}
+
+void libxl__ev_time_deregister(libxl__gc *gc, libxl__ev_time *ev)
+{
+ CTX_LOCK;
+
+ if (!libxl__ev_time_isregistered(ev))
+ goto out;
+
+ time_deregister(gc, ev);
+ ev->func = 0;
+
+ out:
+ CTX_UNLOCK;
+ return;
+}
+
+
+/*
+ * xenstore watches
+ */
+
+libxl__ev_xswatch *libxl__watch_slot_contents(libxl__gc *gc, int slotnum)
+{
+ libxl__ev_watch_slot *slot = &CTX->watch_slots[slotnum];
+ libxl__ev_watch_slot *slotcontents = LIBXL_SLIST_NEXT(slot, empty);
+
+ if (slotcontents == NULL ||
+ ((uintptr_t)slotcontents >= (uintptr_t)CTX->watch_slots &&
+ (uintptr_t)slotcontents < (uintptr_t)(CTX->watch_slots +
+ CTX->watch_nslots)))
+ /* An empty slot has either a NULL pointer (end of the
+ * free list), or a pointer to another entry in the array.
+ * So we can do a bounds check to distinguish empty from
+ * full slots.
+ */
+ /* We need to do the comparisons as uintptr_t because
+ * comparing pointers which are not in the same object is
+ * undefined behaviour; if the compiler managed to figure
+ * out that watch_slots[0..watch_nslots-1] is all of the
+ * whole array object it could prove that the above bounds
+ * check was always true if it was legal, and remove it!
+ *
+ * uintptr_t because even on a machine with signed
+ * pointers, objects do not cross zero; whereas on
+ * machines with unsigned pointers, they may cross
+ * 0x8bazillion.
+ */
+ return NULL;
+
+ /* see comment near libxl__ev_watch_slot definition */
+ return (void*)slotcontents;
+}
+
+static void libxl__set_watch_slot_contents(libxl__ev_watch_slot *slot,
+ libxl__ev_xswatch *w)
+{
+ /* we look a bit behind the curtain of LIBXL_SLIST, to explicitly
+ * assign to the pointer that's the next link. See the comment
+ * by the definition of libxl__ev_watch_slot */
+ slot->empty.sle_next = (void*)w;
+}
+
+static void watchfd_callback(libxl__egc *egc, libxl__ev_fd *ev,
+ int fd, short events, short revents)
+{
+ libxl__gc *gc = &egc->gc;
+
+ for (;;) {
+ char **event = xs_check_watch(CTX->xsh);
+ if (!event) {
+ if (errno == EAGAIN) break;
+ if (errno == EINTR) continue;
+ LIBXL__EVENT_DISASTER(egc, "cannot check/read watches", errno, 0);
+ return;
+ }
+
+ const char *epath = event[0];
+ const char *token = event[1];
+ int slotnum;
+ uint32_t counterval;
+ int rc = sscanf(token, "%d/%"SCNx32, &slotnum, &counterval);
+ if (rc != 2) {
+ LIBXL__LOG(CTX, LIBXL__LOG_ERROR,
+ "watch epath=%s token=%s: failed to parse token",
+ epath, token);
+ /* oh well */
+ goto ignore;
+ }
+ if (slotnum < 0 || slotnum >= CTX->watch_nslots) {
+ /* perhaps in the future we will make the watchslots array shrink */
+ LIBXL__LOG(CTX, LIBXL__LOG_DEBUG, "watch epath=%s token=%s:"
+ " slotnum %d out of range [0,%d>",
+ epath, token, slotnum, CTX->watch_nslots);
+ goto ignore;
+ }
+
+ libxl__ev_xswatch *w = libxl__watch_slot_contents(gc, slotnum);
+
+ if (!w) {
+ LIBXL__LOG(CTX, LIBXL__LOG_DEBUG,
+ "watch epath=%s token=%s: empty slot",
+ epath, token);
+ goto ignore;
+ }
+
+ if (w->counterval != counterval) {
+ LIBXL__LOG(CTX, LIBXL__LOG_DEBUG,
+ "watch epath=%s token=%s: counter != %"PRIx32,
+ epath, token, w->counterval);
+ goto ignore;
+ }
+
+ /* Now it's possible, though unlikely, that this was an event
+ * from a previous use of the same slot with the same counterval.
+ *
+ * In that case either:
+ * - the event path is a child of the watch path, in
+ * which case this watch would really have generated this
+ * event if it had been registered soon enough and we are
+ * OK to give this possibly-spurious event to the caller; or
+ * - it is not, in which case we must suppress it as the
+ * caller should not see events for unrelated paths.
+ *
+ * See also docs/misc/xenstore.txt.
+ */
+ if (!xs_path_is_subpath(w->path, epath)) {
+ LIBXL__LOG(CTX, LIBXL__LOG_DEBUG,
+ "watch epath=%s token=%s: not child of wpath=%s",
+ epath, token, w->path);
+ goto ignore;
+ }
+
+ /* At last, we have checked everything! */
+ LIBXL__LOG(CTX, LIBXL__LOG_DEBUG,
+ "watch event: epath=%s token=%s wpath=%s w=%p",
+ epath, token, w->path, w);
+ w->callback(egc, w, w->path, epath);
+
+ ignore:
+ free(event);
+ }
+}
+
+static char *watch_token(libxl__gc *gc, int slotnum, uint32_t counterval)
+{
+ return libxl__sprintf(gc, "%d/%"PRIx32, slotnum, counterval);
+}
+
+int libxl__ev_xswatch_register(libxl__gc *gc, libxl__ev_xswatch *w,
+ libxl__ev_xswatch_callback *func,
+ const char *path /* copied */)
+{
+ libxl__ev_watch_slot *use = NULL;
+ char *path_copy = NULL;
+ int rc;
+
+ CTX_LOCK;
+
+ if (!libxl__ev_fd_isregistered(&CTX->watch_efd)) {
+ rc = libxl__ev_fd_register(gc, &CTX->watch_efd, watchfd_callback,
+ xs_fileno(CTX->xsh), POLLIN);
+ if (rc) goto out_rc;
+ }
+
+ if (LIBXL_SLIST_EMPTY(&CTX->watch_freeslots)) {
+ /* Free list is empty so there is not in fact a linked
+ * free list in the array and we can safely realloc it */
+ int newarraysize = (CTX->watch_nslots + 1) << 2;
+ int i;
+ libxl__ev_watch_slot *newarray =
+ realloc(CTX->watch_slots, sizeof(*newarray) * newarraysize);
+ if (!newarray) goto out_nomem;
+ for (i = CTX->watch_nslots; i < newarraysize; i++)
+ LIBXL_SLIST_INSERT_HEAD(&CTX->watch_freeslots,
+ &newarray[i], empty);
+ CTX->watch_slots = newarray;
+ CTX->watch_nslots = newarraysize;
+ }
+ use = LIBXL_SLIST_FIRST(&CTX->watch_freeslots);
+ assert(use);
+ LIBXL_SLIST_REMOVE_HEAD(&CTX->watch_freeslots, empty);
+
+ path_copy = strdup(path);
+ if (!path_copy) goto out_nomem;
+
+ int slotnum = use - CTX->watch_slots;
+ w->counterval = CTX->watch_counter++;
+
+ if (!xs_watch(CTX->xsh, path, watch_token(gc, slotnum, w->counterval))) {
+ LIBXL__LOG_ERRNOVAL(CTX, LIBXL__LOG_ERROR, errno,
+ "create watch for path %s", path);
+ rc = ERROR_FAIL;
+ goto out_rc;
+ }
+
+ w->slotnum = slotnum;
+ w->path = path_copy;
+ w->callback = func;
+ libxl__set_watch_slot_contents(use, w);
+
+ CTX_UNLOCK;
+ return 0;
+
+ out_nomem:
+ rc = ERROR_NOMEM;
+ out_rc:
+ if (use)
+ LIBXL_SLIST_INSERT_HEAD(&CTX->watch_freeslots, use, empty);
+ if (path_copy)
+ free(path_copy);
+ CTX_UNLOCK;
+ return rc;
+}
+
+void libxl__ev_xswatch_deregister(libxl__gc *gc, libxl__ev_xswatch *w)
+{
+ /* it is legal to deregister from within _callback */
+ CTX_LOCK;
+
+ if (w->slotnum >= 0) {
+ char *token = watch_token(gc, w->slotnum, w->counterval);
+ if (!xs_unwatch(CTX->xsh, w->path, token))
+ /* Oh well, we will just get watch events forever more
+ * and ignore them. But we should complain to the log. */
+ LIBXL__LOG_ERRNOVAL(CTX, LIBXL__LOG_ERROR, errno,
+ "remove watch for path %s", w->path);
+
+ libxl__ev_watch_slot *slot = &CTX->watch_slots[w->slotnum];
+ LIBXL_SLIST_INSERT_HEAD(&CTX->watch_freeslots, slot, empty);
+ }
+
+ free(w->path);
+ w->path = NULL;
+
+ CTX_UNLOCK;
+}
+
+/*
+ * osevent poll
+ */
+
+int libxl_osevent_beforepoll(libxl_ctx *ctx, int *nfds_io,
+ struct pollfd *fds, int *timeout_upd,
+ struct timeval now)
+{
+ libxl__ev_fd *efd;
+ int rc;
+
+ /*
+ * In order to be able to efficiently find the libxl__ev_fd
+ * for a struct poll during _afterpoll, we maintain a shadow
+ * data structure in CTX->fd_beforepolled: each slot in
+ * the fds array corresponds to a slot in fd_beforepolled.
+ */
+
+ GC_INIT(ctx);
+ CTX_LOCK;
+
+ if (*nfds_io) {
+ /*
+ * As an optimisation, we don't touch fd_rindex
+ * if *nfds_io is zero on entry, since in that case the
+ * caller just wanted to know how big an array to give us.
+ *
+ * If !*nfds_io, the unconditional parts below are guaranteed
+ * not to mess with fd_rindex.
+ */
+
+ int maxfd = 0;
+ LIBXL_LIST_FOREACH(efd, &CTX->efds, entry) {
+ if (!efd->events)
+ continue;
+ if (efd->fd >= maxfd)
+ maxfd = efd->fd + 1;
+ }
+ /* make sure our array is as big as *nfds_io */
+ if (CTX->fd_rindex_allocd < maxfd) {
+ assert(maxfd < INT_MAX / sizeof(int) / 2);
+ int *newarray = realloc(CTX->fd_rindex, sizeof(int) * maxfd);
+ if (!newarray) { rc = ERROR_NOMEM; goto out; }
+ memset(newarray + CTX->fd_rindex_allocd, 0,
+ sizeof(int) * (maxfd - CTX->fd_rindex_allocd));
+ CTX->fd_rindex = newarray;
+ CTX->fd_rindex_allocd = maxfd;
+ }
+ }
+
+ int used = 0;
+ LIBXL_LIST_FOREACH(efd, &CTX->efds, entry) {
+ if (!efd->events)
+ continue;
+ if (used < *nfds_io) {
+ fds[used].fd = efd->fd;
+ fds[used].events = efd->events;
+ fds[used].revents = 0;
+ assert(efd->fd < CTX->fd_rindex_allocd);
+ CTX->fd_rindex[efd->fd] = used;
+ }
+ used++;
+ }
+ rc = used <= *nfds_io ? 0 : ERROR_BUFFERFULL;
+
+ *nfds_io = used;
+
+ libxl__ev_time *etime = LIBXL_TAILQ_FIRST(&CTX->etimes);
+ if (etime) {
+ int our_timeout;
+ struct timeval rel;
+ static struct timeval zero;
+
+ timersub(&etime->abs, &now, &rel);
+
+ if (timercmp(&rel, &zero, <)) {
+ our_timeout = 0;
+ } else if (rel.tv_sec >= 2000000) {
+ our_timeout = 2000000000;
+ } else {
+ our_timeout = rel.tv_sec * 1000 + (rel.tv_usec + 999) / 1000;
+ }
+ if (*timeout_upd < 0 || our_timeout < *timeout_upd)
+ *timeout_upd = our_timeout;
+ }
+
+ out:
+ CTX_UNLOCK;
+ GC_FREE;
+ return rc;
+}
+
+static int afterpoll_check_fd(libxl_ctx *ctx,
+ const struct pollfd *fds, int nfds,
+ int fd, int events)
+ /* returns mask of events which were requested and occurred */
+{
+ if (fd >= ctx->fd_rindex_allocd)
+ /* added after we went into poll, have to try again */
+ return 0;
+
+ int slot = ctx->fd_rindex[fd];
+
+ if (slot >= nfds)
+ /* stale slot entry; again, added afterwards */
+ return 0;
+
+ if (fds[slot].fd != fd)
+ /* again, stale slot entry */
+ return 0;
+
+ int revents = fds[slot].revents & events;
+ /* we mask in case requested events have changed */
+
+ return revents;
+}
+
+void libxl_osevent_afterpoll(libxl_ctx *ctx, int nfds, const struct pollfd *fds,
+ struct timeval now)
+{
+ EGC_INIT(ctx);
+ CTX_LOCK;
+ libxl__ev_fd *efd;
+
+ LIBXL_LIST_FOREACH(efd, &CTX->efds, entry) {
+ if (!efd->events)
+ continue;
+
+ int revents = afterpoll_check_fd(CTX,fds,nfds, efd->fd,efd->events);
+ if (revents)
+ efd->func(egc, efd, efd->fd, efd->events, revents);
+ }
+
+ for (;;) {
+ libxl__ev_time *etime = LIBXL_TAILQ_FIRST(&CTX->etimes);
+ if (!etime)
+ break;
+
+ assert(!etime->infinite);
+
+ if (timercmp(&etime->abs, &now, >))
+ break;
+
+ time_deregister(gc, etime);
+
+ etime->func(egc, etime, &etime->abs);
+ }
+
+ CTX_UNLOCK;
+ EGC_FREE;
+}
+
+
+/*
+ * osevent hook and callback machinery
+ */
+
+void libxl_osevent_register_hooks(libxl_ctx *ctx,
+ const libxl_osevent_hooks *hooks,
+ void *user)
+{
+ GC_INIT(ctx);
+ CTX_LOCK;
+ ctx->osevent_hooks = hooks;
+ ctx->osevent_user = user;
+ CTX_UNLOCK;
+ GC_FREE;
+}
+
+
+void libxl_osevent_occurred_fd(libxl_ctx *ctx, void *for_libxl,
+ int fd, short events, short revents)
+{
+ libxl__ev_fd *ev = for_libxl;
+
+ EGC_INIT(ctx);
+ CTX_LOCK;
+ assert(!CTX->osevent_in_hook);
+
+ assert(fd == ev->fd);
+ revents &= ev->events;
+ if (revents)
+ ev->func(egc, ev, fd, ev->events, revents);
+
+ CTX_UNLOCK;
+ EGC_FREE;
+}
+
+void libxl_osevent_occurred_timeout(libxl_ctx *ctx, void *for_libxl)
+{
+ libxl__ev_time *ev = for_libxl;
+
+ EGC_INIT(ctx);
+ CTX_LOCK;
+ assert(!CTX->osevent_in_hook);
+
+ assert(!ev->infinite);
+ LIBXL_TAILQ_REMOVE(&CTX->etimes, ev, entry);
+ ev->func(egc, ev, &ev->abs);
+
+ CTX_UNLOCK;
+ EGC_FREE;
+}
+
+void libxl__event_disaster(libxl__egc *egc, const char *msg, int errnoval,
+ libxl_event_type type /* may be 0 */,
+ const char *file, int line, const char *func)
+{
+ libxl__gc *gc = &egc->gc;
+
+ libxl__log(CTX, XTL_CRITICAL, errnoval, file, line, func,
+ "DISASTER in event loop: %s%s%s%s",
+ msg,
+ type ? " (relates to event type " : "",
+ type ? libxl_event_type_to_string(type) : "",
+ type ? ")" : "");
+
+ /*
+ * FIXME: This should call the "disaster" hook supplied to
+ * libxl_event_register_callbacks, which will be introduced in the
+ * next patch.
+ */
+
+ const char verybad[] =
+ "DISASTER in event loop not handled by libxl application";
+ LIBXL__LOG(CTX, XTL_CRITICAL, verybad);
+ fprintf(stderr, "libxl: fatal error, exiting program: %s\n", verybad);
+ exit(-1);
+}
+
+void libxl__egc_cleanup(libxl__egc *egc)
+{
+ libxl__gc_cleanup(&egc->gc);
+}
+
+/*
+ * Local variables:
+ * mode: C
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ */
diff --git a/tools/libxl/libxl_event.h b/tools/libxl/libxl_event.h
new file mode 100644
index 0000000..a7e8240
--- /dev/null
+++ b/tools/libxl/libxl_event.h
@@ -0,0 +1,204 @@
+/*
+ * Copyright (C) 2011 Citrix Ltd.
+ * Author Ian Jackson <ian.jackson@eu.citrix.com>
+ *
+ * This program 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; version 2.1 only. with the special
+ * exception on linking described in file LICENSE.
+ *
+ * This program 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.
+ */
+
+#ifndef LIBXL_EVENT_H
+#define LIBXL_EVENT_H
+
+#include <libxl.h>
+
+
+/*======================================================================*/
+
+/*
+ * OS event handling - passing low-level OS events to libxl
+ *
+ * Event-driven programs must use these facilities to allow libxl
+ * to become aware of readability/writeability of file descriptors
+ * and the occurrence of timeouts.
+ *
+ * There are two approaches available. The first is appropriate for
+ * simple programs handling reasonably small numbers of domains:
+ *
+ * for (;;) {
+ * libxl_osevent_beforepoll(...)
+ * poll();
+ * libxl_osevent_afterpoll(...);
+ * for (;;) {
+ * r=libxl_event_check(...);
+ * if (r==LIBXL_NOT_READY) break;
+ * if (r) handle failure;
+ * do something with the event;
+ * }
+ * }
+ *
+ * The second approach uses libxl_osevent_register_hooks and is
+ * suitable for programs which are already using a callback-based
+ * event library.
+ *
+ * An application may freely mix the two styles of interaction.
+ *
+ * (Callers inside libxl may not call libxl_osevent_... functions.)
+ */
+
+struct pollfd;
+
+int libxl_osevent_beforepoll(libxl_ctx *ctx, int *nfds_io,
+ struct pollfd *fds, int *timeout_upd,
+ struct timeval now);
+ /* The caller should provide beforepoll with some space for libxl's
+ * fds, and tell libxl how much space is available by setting *nfds_io.
+ * fds points to the start of this space (and fds may be a pointer into
+ * a larger array, for example, if the application has some fds of
+ * its own that it is interested in).
+ *
+ * On return *nfds_io will in any case have been updated by libxl
+ * according to how many fds libxl wants to poll on.
+ *
+ * If the space was sufficient, libxl fills in fds[0..<new
+ * *nfds_io>] suitably for poll(2), updates *timeout_upd if needed,
+ * and returns ok.
+ *
+ * If space was insufficient, fds[0..<old *nfds_io>] is undefined on
+ * return; *nfds_io on return will be greater than the value on
+ * entry; *timeout_upd may or may not have been updated; and
+ * libxl_osevent_beforepoll returns ERROR_BUFERFULL. In this case
+ * the application needs to make more space (enough space for
+ * *nfds_io struct pollfd) and then call beforepoll again, before
+ * entering poll(2). Typically this will involve calling realloc.
+ *
+ * The application may call beforepoll with fds==NULL and
+ * *nfds_io==0 in order to find out how much space is needed.
+ *
+ * *timeout_upd is as for poll(2): it's in milliseconds, and
+ * negative values mean no timeout (infinity).
+ * libxl_osevent_beforepoll will only reduce the timeout, naturally.
+ */
+void libxl_osevent_afterpoll(libxl_ctx *ctx, int nfds, const struct pollfd *fds,
+ struct timeval now);
+ /* nfds and fds[0..nfds] must be from the most recent call to
+ * _beforepoll, as modified by poll. (It is therefore not possible
+ * to have multiple threads simultaneously polling using this
+ * interface.)
+ *
+ * This function actually performs all of the IO and other actions,
+ * and generates events (libxl_event), which are implied by either
+ * (a) the time of day or (b) both (i) the returned information from
+ * _beforepoll, and (ii) the results from poll specified in
+ * fds[0..nfds-1]. Generated events can then be retrieved by
+ * libxl_event_check.
+ */
+
+
+typedef struct libxl_osevent_hooks {
+ int (*fd_register)(void *user, int fd, void **for_app_registration_out,
+ short events, void *for_libxl);
+ int (*fd_modify)(void *user, int fd, void **for_app_registration_update,
+ short events);
+ void (*fd_deregister)(void *user, int fd, void *for_app_registration);
+ int (*timeout_register)(void *user, void **for_app_registration_out,
+ struct timeval abs, void *for_libxl);
+ int (*timeout_modify)(void *user, void **for_app_registration_update,
+ struct timeval abs);
+ void (*timeout_deregister)(void *user, void *for_app_registration);
+} libxl_osevent_hooks;
+
+void libxl_osevent_register_hooks(libxl_ctx *ctx,
+ const libxl_osevent_hooks *hooks,
+ void *user);
+ /* The application which calls register_fd_hooks promises to
+ * maintain a register of fds and timeouts that libxl is interested
+ * in, and make calls into libxl (libxl_osevent_occurred_*)
+ * when those fd events and timeouts occur. This is more efficient
+ * than _beforepoll/_afterpoll if there are many fds (which can
+ * happen if the same libxl application is managing many domains).
+ *
+ * For an fd event, events is as for poll(). register or modify may
+ * be called with events==0, in which case it must still work
+ * normally, just not generate any events.
+ *
+ * For a timeout event, milliseconds is as for poll().
+ * Specifically, negative values of milliseconds mean NO TIMEOUT.
+ * This is used by libxl to temporarily disable a timeout.
+ *
+ * If the register or modify hook succeeds it may update
+ * *for_app_registration_out/_update and must then return 0.
+ * On entry to register, *for_app_registration_out is always NULL.
+ *
+ * A registration or modification hook may fail, in which case it
+ * must leave the registration state of the fd or timeout unchanged.
+ * It may then either return ERROR_OSEVENT_REG_FAIL or any positive
+ * int. The value returned will be passed up through libxl and
+ * eventually returned back to the application. When register
+ * fails, any value stored into *for_registration_out is ignored by
+ * libxl; when modify fails, any changed value stored into
+ * *for_registration_update is honoured by libxl and will be passed
+ * to future modify or deregister calls.
+ *
+ * libxl will only attempt to register one callback for any one fd.
+ * libxl will remember the value stored in *for_app_registration_out
+ * (or *for_app_registration_update) by a successful call to
+ * register (or modify), and pass it to subsequent calls to modify
+ * or deregister.
+ *
+ * register_fd_hooks may be called only once for each libxl_ctx.
+ * libxl may make calls to register/modify/deregister from within
+ * any libxl function (indeed, it will usually call register from
+ * register_event_hooks). Conversely, the application MUST NOT make
+ * the event occurrence calls (libxl_osevent_occurred_*) into libxl
+ * reentrantly from within libxl (for example, from within the
+ * register/modify functions).
+ *
+ * Lock hierarchy: the register/modify/deregister functions may be
+ * called with locks held. These locks (the "libxl internal locks")
+ * are inside the libxl_ctx. Therefore, if those register functions
+ * acquire any locks of their own ("caller register locks") outside
+ * libxl, to avoid deadlock one of the following must hold for each
+ * such caller register lock:
+ * (a) "acquire libxl internal locks before caller register lock":
+ * No libxl function may be called with the caller register
+ * lock held.
+ * (b) "acquire caller register lock before libxl internal locks":
+ * No libxl function may be called _without_ the caller
+ * register lock held.
+ * Of these we would normally recommend (a).
+ *
+ * The value *hooks is not copied and must outlast the libxl_ctx.
+ */
+
+/* It is NOT legal to call _occurred_ reentrantly within any libxl
+ * function. Specifically it is NOT legal to call it from within
+ * a register callback. Conversely, libxl MAY call register/deregister
+ * from within libxl_event_registered_call_*.
+ */
+
+void libxl_osevent_occurred_fd(libxl_ctx *ctx, void *for_libxl,
+ int fd, short events, short revents);
+
+void libxl_osevent_occurred_timeout(libxl_ctx *ctx, void *for_libxl);
+ /* Implicitly, on entry to this function the timeout has been
+ * deregistered. If _occurred_timeout is called, libxl will not
+ * call timeout_deregister; if it wants to requeue the timeout it
+ * will call timeout_register again.
+ */
+
+#endif
+
+/*
+ * Local variables:
+ * mode: C
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ */
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index df1dfde..fdfcf9d 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -35,6 +35,7 @@
#include <unistd.h>
#include <sys/mman.h>
+#include <sys/poll.h>
#include <sys/select.h>
#include <sys/stat.h>
#include <sys/time.h>
@@ -109,6 +110,66 @@ _hidden void libxl__log(libxl_ctx *ctx, xentoollog_level msglevel, int errnoval,
/* these functions preserve errno (saving and restoring) */
+typedef struct libxl__gc libxl__gc;
+typedef struct libxl__egc libxl__egc;
+
+typedef struct libxl__ev_fd libxl__ev_fd;
+typedef void libxl__ev_fd_callback(libxl__egc *egc, libxl__ev_fd *ev,
+ int fd, short events, short revents);
+struct libxl__ev_fd {
+ /* all private for libxl__ev_fd... */
+ LIBXL_LIST_ENTRY(libxl__ev_fd) entry;
+ int fd;
+ short events;
+ void *for_app_reg;
+ libxl__ev_fd_callback *func;
+};
+
+
+typedef struct libxl__ev_time libxl__ev_time;
+typedef void libxl__ev_time_callback(libxl__egc *egc, libxl__ev_time *ev,
+ const struct timeval *requested_abs);
+struct libxl__ev_time {
+ /* all private for libxl__ev_time... */
+ int infinite; /* not registered in list or with app if infinite */
+ LIBXL_TAILQ_ENTRY(libxl__ev_time) entry;
+ struct timeval abs;
+ void *for_app_reg;
+ libxl__ev_time_callback *func;
+};
+
+typedef struct libxl__ev_xswatch libxl__ev_xswatch;
+typedef void libxl__ev_xswatch_callback(libxl__egc *egc, libxl__ev_xswatch*,
+ const char *watch_path, const char *event_path);
+struct libxl__ev_xswatch {
+ /* caller should include this in their own struct */
+ /* contents are private to xswatch_register */
+ int slotnum;
+ uint32_t counterval;
+ char *path;
+ libxl__ev_xswatch_callback *callback;
+};
+
+/*
+ * An entry in the watch_slots table is either:
+ * 1. an entry in the free list, ie NULL or pointer to next free list entry
+ * 2. an pointer to a libxl__ev_xswatch
+ *
+ * But we don't want to use unions or type-punning because the
+ * compiler might "prove" that our code is wrong and misoptimise it.
+ *
+ * The rules say that all struct pointers have identical
+ * representation and alignment requirements (C99+TC1+TC2 6.2.5p26) so
+ * what we do is simply declare our array as containing only the free
+ * list pointers, and explicitly convert from and to our actual
+ * xswatch pointers when we store and retrieve them.
+ */
+typedef struct libxl__ev_watch_slot {
+ LIBXL_SLIST_ENTRY(struct libxl__ev_watch_slot) empty;
+} libxl__ev_watch_slot;
+
+libxl__ev_xswatch *libxl__watch_slot_contents(libxl__gc *gc, int slotnum);
+
struct libxl__ctx {
xentoollog_logger *lg;
xc_interface *xch;
@@ -127,6 +188,23 @@ struct libxl__ctx {
* documented in the libxl public interface.
*/
+ int osevent_in_hook;
+ const libxl_osevent_hooks *osevent_hooks;
+ void *osevent_user;
+ /* See the comment for OSEVENT_HOOK_INTERN in libxl_event.c
+ * for restrictions on the use of the osevent fields. */
+
+ int fd_rindex_allocd;
+ int *fd_rindex; /* see libxl_osevent_beforepoll */
+ LIBXL_LIST_HEAD(, libxl__ev_fd) efds;
+ LIBXL_TAILQ_HEAD(, libxl__ev_time) etimes;
+
+ libxl__ev_watch_slot *watch_slots;
+ int watch_nslots;
+ LIBXL_SLIST_HEAD(, libxl__ev_watch_slot) watch_freeslots;
+ uint32_t watch_counter; /* helps disambiguate slot reuse */
+ libxl__ev_fd watch_efd;
+
/* for callers who reap children willy-nilly; caller must only
* set this after libxl_init and before any other call - or
* may leave them untouched */
@@ -157,12 +235,17 @@ typedef struct {
#define PRINTF_ATTRIBUTE(x, y) __attribute__((format(printf, x, y)))
-typedef struct {
+struct libxl__gc {
/* mini-GC */
int alloc_maxsize;
void **alloc_ptrs;
libxl_ctx *owner;
-} libxl__gc;
+};
+
+struct libxl__egc {
+ /* for event-generating functions only */
+ struct libxl__gc gc;
+};
#define LIBXL_INIT_GC(gc,ctx) do{ \
(gc).alloc_maxsize = 0; \
@@ -228,9 +311,141 @@ _hidden char *libxl__xs_read(libxl__gc *gc, xs_transaction_t t,
_hidden char **libxl__xs_directory(libxl__gc *gc, xs_transaction_t t,
const char *path, unsigned int *nb);
/* On error: returns NULL, sets errno (no logging) */
-
_hidden char *libxl__xs_libxl_path(libxl__gc *gc, uint32_t domid);
+
+/*
+ * Event generation functions provided by the libxl event core to the
+ * rest of libxl. Implemented in terms of _beforepoll/_afterpoll
+ * and/or the fd registration machinery, as provided by the
+ * application.
+ *
+ * Semantics are similar to those of the fd and timeout registration
+ * functions provided to libxl_osevent_register_hooks.
+ *
+ * Non-0 returns from libxl__ev_{modify,deregister} have already been
+ * logged by the core and should be returned unmodified to libxl's
+ * caller; NB that they may be valid libxl error codes but they may
+ * also be positive numbers supplied by the caller.
+ *
+ * In each case, there is a libxl__ev_FOO structure which can be in
+ * one of three states:
+ *
+ * Undefined - Might contain anything. All-bits-zero is
+ * an undefined state.
+ *
+ * Idle - Struct contents are defined enough to pass to any
+ * libxl__ev_FOO function but not registered and
+ * callback will not be called. The struct does not
+ * contain references to any allocated resources so
+ * can be thrown away.
+ *
+ * Active - Request for events has been registered and events
+ * may be generated. _deregister must be called to
+ * reclaim resources.
+ *
+ * These functions are provided for each kind of event KIND:
+ *
+ * int libxl__ev_KIND_register(libxl__gc *gc, libxl__ev_KIND *GEN,
+ * libxl__ev_KIND_callback *FUNC,
+ * DETAILS);
+ * On entry *GEN must be in state Undefined or Idle.
+ * Returns a libxl error code; on error return *GEN is Idle.
+ * On successful return *GEN is Active and FUNC wil be
+ * called by the event machinery in future. FUNC will
+ * not be called from within the call to _register.
+ * FUNC will be called with the context locked (with CTX_LOCK).
+ *
+ * void libxl__ev_KIND_deregister(libxl__gc *gc, libxl__ev_KIND *GEN_upd);
+ * On entry *GEN must be in state Active or Idle.
+ * On return it is Idle. (Idempotent.)
+ *
+ * void libxl__ev_KIND_init(libxl__ev_KIND *GEN);
+ * Provided for initialising an Undefined KIND.
+ * On entry *GEN must be in state Idle or Undefined.
+ * On return it is Idle. (Idempotent.)
+ *
+ * int libxl__ev_KIND_isregistered(const libxl__ev_KIND *GEN);
+ * On entry *GEN must be Idle or Active.
+ * Returns nonzero if it is Active, zero otherwise.
+ * Cannot fail.
+ *
+ * int libxl__ev_KIND_modify(libxl__gc*, libxl__ev_KIND *GEN,
+ * DETAILS);
+ * Only provided for some kinds of generator.
+ * On entry *GEN must be Active and on return, whether successful
+ * or not, it will be Active.
+ * Returns a libxl error code; on error the modification
+ * is not effective.
+ *
+ * All of these functions are fully threadsafe and may be called by
+ * general code in libxl even from within event callback FUNCs.
+ *
+ * Callers of libxl__ev_KIND_register must ensure that the
+ * registration is undone, with _deregister, in libxl_ctx_free.
+ */
+
+
+_hidden int libxl__ev_fd_register(libxl__gc*, libxl__ev_fd *ev_out,
+ libxl__ev_fd_callback*,
+ int fd, short events /* as for poll(2) */);
+_hidden int libxl__ev_fd_modify(libxl__gc*, libxl__ev_fd *ev,
+ short events);
+_hidden void libxl__ev_fd_deregister(libxl__gc*, libxl__ev_fd *ev);
+static inline void libxl__ev_fd_init(libxl__ev_fd *efd)
+ { efd->fd = -1; }
+static inline int libxl__ev_fd_isregistered(libxl__ev_fd *efd)
+ { return efd->fd >= 0; }
+
+_hidden int libxl__ev_time_register_rel(libxl__gc*, libxl__ev_time *ev_out,
+ libxl__ev_time_callback*,
+ int milliseconds /* as for poll(2) */);
+_hidden int libxl__ev_time_register_abs(libxl__gc*, libxl__ev_time *ev_out,
+ libxl__ev_time_callback*,
+ struct timeval);
+_hidden int libxl__ev_time_modify_rel(libxl__gc*, libxl__ev_time *ev,
+ int milliseconds /* as for poll(2) */);
+_hidden int libxl__ev_time_modify_abs(libxl__gc*, libxl__ev_time *ev,
+ struct timeval);
+_hidden void libxl__ev_time_deregister(libxl__gc*, libxl__ev_time *ev);
+static inline void libxl__ev_time_init(libxl__ev_time *ev)
+ { ev->func = 0; }
+static inline int libxl__ev_time_isregistered(libxl__ev_time *ev)
+ { return !!ev->func; }
+
+
+_hidden int libxl__ev_xswatch_register(libxl__gc*, libxl__ev_xswatch *xsw_out,
+ libxl__ev_xswatch_callback*,
+ const char *path /* copied */);
+_hidden void libxl__ev_xswatch_deregister(libxl__gc *gc, libxl__ev_xswatch*);
+
+static inline void libxl__ev_xswatch_init(libxl__ev_xswatch *xswatch_out)
+ { xswatch_out->slotnum = -1; }
+static inline int libxl__ev_xswatch_isregistered(const libxl__ev_xswatch *xw)
+ { return xw->slotnum >= 0; }
+
+
+
+_hidden void libxl__event_disaster(libxl__egc*, const char *msg, int errnoval,
+ libxl_event_type type /* may be 0 */,
+ const char *file, int line,
+ const char *func);
+ /*
+ * In general, call this via the macro LIBXL__EVENT_DISASTER.
+ *
+ * Event-generating functions may call this if they might have
+ * wanted to generate an event (either an internal one ie a
+ * libxl__ev_FOO_callback or an application event), but are
+ * prevented from doing so due to eg lack of memory.
+ *
+ * NB that this function may return and the caller isn't supposed to
+ * then crash, although it may fail (and henceforth leave things in
+ * a state where many or all calls fail).
+ */
+#define LIBXL__EVENT_DISASTER(egc, msg, errnoval, type) \
+ libxl__event_disaster(egc, msg, errnoval, type, __FILE__,__LINE__,__func__)
+
+
/* from xl_dom */
_hidden libxl_domain_type libxl__domain_type(libxl__gc *gc, uint32_t domid);
_hidden int libxl__domain_shutdown_reason(libxl__gc *gc, uint32_t domid);
@@ -596,6 +811,8 @@ _hidden int libxl__parse_mac(const char *s, libxl_mac mac);
/* compare mac address @a and @b. 0 if the same, -ve if a<b and +ve if a>b */
_hidden int libxl__compare_macs(libxl_mac *a, libxl_mac *b);
+_hidden int libxl__gettimeofday(libxl__gc *gc, struct timeval *now_r);
+
#define STRINGIFY(x) #x
#define TOSTRING(x) STRINGIFY(x)
@@ -733,6 +950,49 @@ libxl__device_model_version_running(libxl__gc *gc, uint32_t domid);
/*
+ * Calling context and GC for event-generating functions:
+ *
+ * These are for use by parts of libxl which directly or indirectly
+ * call libxl__event_occurred. These contain a gc but also a list of
+ * deferred events.
+ *
+ * Most code in libxlshould not need to initialise their own egc.
+ * Even functions which generate specific kinds of events don't need
+ * to - rather, they will be passed an egc into their own callback
+ * function and should just use the one they're given.
+ *
+ * A handy idiom for functions taking an egc is:
+ * libxl__gc *gc = &egc->gc;
+ *
+ * Functions using LIBXL__INIT_EGC may *not* generally be called from
+ * within libxl, because libxl__egc_cleanup may call back into the
+ * application. This should be documented near the function
+ * prototype(s) for callers of LIBXL__INIT_EGC and EGC_INIT.
+ *
+ * For the same reason libxl__egc_cleanup (or EGC_FREE) must be called
+ * with the ctx *unlocked*. So the right pattern has the EGC_...
+ * macro calls on the outside of the CTX_... ones.
+ */
+
+/* egc initialisation and destruction: */
+
+#define LIBXL_INIT_EGC(egc,ctx) do{ \
+ LIBXL_INIT_GC((egc).gc,ctx); \
+ /* list of occurred events tbd */ \
+ } while(0)
+
+_hidden void libxl__egc_cleanup(libxl__egc *egc);
+
+/* convenience macros: */
+
+#define EGC_INIT(ctx) \
+ libxl__egc egc[1]; LIBXL_INIT_EGC(egc[0],ctx); \
+ libxl__gc *gc = &egc->gc
+
+#define EGC_FREE libxl__egc_cleanup(egc)
+
+
+/*
* Convenience macros.
*/
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* Re: [PATCH 07/10] libxl: New API for providing OS events to libxl
2012-01-06 20:35 ` [PATCH 07/10] libxl: New API for providing OS events to libxl Ian Jackson
@ 2012-01-11 17:32 ` Stefano Stabellini
2012-01-12 11:28 ` Ian Campbell
2012-01-12 15:56 ` Ian Jackson
2012-01-13 15:07 ` Ian Campbell
1 sibling, 2 replies; 43+ messages in thread
From: Stefano Stabellini @ 2012-01-11 17:32 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com, Ian Campbell
On Fri, 6 Jan 2012, Ian Jackson wrote:
> +struct libxl__egc {
> + /* for event-generating functions only */
> + struct libxl__gc gc;
> +};
[...]
> /*
> + * Calling context and GC for event-generating functions:
> + *
> + * These are for use by parts of libxl which directly or indirectly
> + * call libxl__event_occurred. These contain a gc but also a list of
> + * deferred events.
> + *
> + * Most code in libxlshould not need to initialise their own egc.
> + * Even functions which generate specific kinds of events don't need
> + * to - rather, they will be passed an egc into their own callback
> + * function and should just use the one they're given.
> + *
> + * A handy idiom for functions taking an egc is:
> + * libxl__gc *gc = &egc->gc;
> + *
> + * Functions using LIBXL__INIT_EGC may *not* generally be called from
> + * within libxl, because libxl__egc_cleanup may call back into the
> + * application. This should be documented near the function
> + * prototype(s) for callers of LIBXL__INIT_EGC and EGC_INIT.
> + *
> + * For the same reason libxl__egc_cleanup (or EGC_FREE) must be called
> + * with the ctx *unlocked*. So the right pattern has the EGC_...
> + * macro calls on the outside of the CTX_... ones.
> + */
> +
> +/* egc initialisation and destruction: */
> +
> +#define LIBXL_INIT_EGC(egc,ctx) do{ \
> + LIBXL_INIT_GC((egc).gc,ctx); \
> + /* list of occurred events tbd */ \
> + } while(0)
> +
> +_hidden void libxl__egc_cleanup(libxl__egc *egc);
> +
> +/* convenience macros: */
> +
> +#define EGC_INIT(ctx) \
> + libxl__egc egc[1]; LIBXL_INIT_EGC(egc[0],ctx); \
> + libxl__gc *gc = &egc->gc
> +
> +#define EGC_FREE libxl__egc_cleanup(egc)
I still prefer the approach prototyped in
http://marc.info/?l=xen-devel&m=132371797519877: avoid introducing
restrictions on how libxl functions have to be called, unify egc and gc,
make it possible to take the lock recursively and use the nested counter
to figure out when to call the callbacks.
It would make my head hurt less when I have to read/write this code,
however others might react differently.
I don't think we'll ever get an agreement on this so I'll just step back
and let other people decide what is the right approach.
Only one more thing: I would kindly ask to move all these event related
functions to a different source file, to make it easier for people to
understand which ones are different from the rest of the library.
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 07/10] libxl: New API for providing OS events to libxl
2012-01-11 17:32 ` Stefano Stabellini
@ 2012-01-12 11:28 ` Ian Campbell
2012-01-12 13:49 ` Stefano Stabellini
2012-01-12 15:49 ` Ian Jackson
2012-01-12 15:56 ` Ian Jackson
1 sibling, 2 replies; 43+ messages in thread
From: Ian Campbell @ 2012-01-12 11:28 UTC (permalink / raw)
To: Stefano Stabellini; +Cc: xen-devel@lists.xensource.com, Ian Jackson
On Wed, 2012-01-11 at 17:32 +0000, Stefano Stabellini wrote:
> On Fri, 6 Jan 2012, Ian Jackson wrote:
> > +struct libxl__egc {
> > + /* for event-generating functions only */
> > + struct libxl__gc gc;
> > +};
>
> [...]
>
> > /*
> > + * Calling context and GC for event-generating functions:
> > + *
> > + * These are for use by parts of libxl which directly or indirectly
> > + * call libxl__event_occurred. These contain a gc but also a list of
> > + * deferred events.
> > + *
> > + * Most code in libxlshould not need to initialise their own egc.
> > + * Even functions which generate specific kinds of events don't need
> > + * to - rather, they will be passed an egc into their own callback
> > + * function and should just use the one they're given.
> > + *
> > + * A handy idiom for functions taking an egc is:
> > + * libxl__gc *gc = &egc->gc;
> > + *
> > + * Functions using LIBXL__INIT_EGC may *not* generally be called from
> > + * within libxl, because libxl__egc_cleanup may call back into the
> > + * application. This should be documented near the function
> > + * prototype(s) for callers of LIBXL__INIT_EGC and EGC_INIT.
> > + *
> > + * For the same reason libxl__egc_cleanup (or EGC_FREE) must be called
> > + * with the ctx *unlocked*. So the right pattern has the EGC_...
> > + * macro calls on the outside of the CTX_... ones.
> > + */
> > +
> > +/* egc initialisation and destruction: */
> > +
> > +#define LIBXL_INIT_EGC(egc,ctx) do{ \
> > + LIBXL_INIT_GC((egc).gc,ctx); \
> > + /* list of occurred events tbd */ \
> > + } while(0)
> > +
> > +_hidden void libxl__egc_cleanup(libxl__egc *egc);
> > +
> > +/* convenience macros: */
> > +
> > +#define EGC_INIT(ctx) \
> > + libxl__egc egc[1]; LIBXL_INIT_EGC(egc[0],ctx); \
> > + libxl__gc *gc = &egc->gc
> > +
> > +#define EGC_FREE libxl__egc_cleanup(egc)
>
> I still prefer the approach prototyped in
> http://marc.info/?l=xen-devel&m=132371797519877
I pointed out some issues with this in
http://marc.info/?l=xen-devel&m=132378496608354&w=2 which have gone
unanswered.
In particular error handling for the pthread_setspecific in
libxl__free_all seems pretty nasty to me since you would be introducing
a new failure path at the end of pretty much every libxl function. Worse
it is after the actual action of each function is otherwise complete so
you may end up having to undo stuff. I think it is going to be a lot of
work to fix all of those up properly.
Having frequently used pro/epilogue code (especially epilogue) which
cannot fail seems much simpler in general to me.
It occurred to me just now that having a different type of this type of
gc has the benefit that since libxl__event_occurred takes one it will
necessarily filter back up the call chain and help enforce/highlight the
requirement that functions which directly or indirectly call
libxl__event_occurred use an egc.
Ian.
> : avoid introducing
> restrictions on how libxl functions have to be called, unify egc and gc,
> make it possible to take the lock recursively and use the nested counter
> to figure out when to call the callbacks.
> It would make my head hurt less when I have to read/write this code,
> however others might react differently.
>
> I don't think we'll ever get an agreement on this so I'll just step back
> and let other people decide what is the right approach.
>
> Only one more thing: I would kindly ask to move all these event related
> functions to a different source file, to make it easier for people to
> understand which ones are different from the rest of the library.
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 07/10] libxl: New API for providing OS events to libxl
2012-01-12 11:28 ` Ian Campbell
@ 2012-01-12 13:49 ` Stefano Stabellini
2012-01-12 15:49 ` Ian Jackson
1 sibling, 0 replies; 43+ messages in thread
From: Stefano Stabellini @ 2012-01-12 13:49 UTC (permalink / raw)
To: Ian Campbell
Cc: xen-devel@lists.xensource.com, Ian Jackson, Stefano Stabellini
On Thu, 12 Jan 2012, Ian Campbell wrote:
> > I still prefer the approach prototyped in
> > http://marc.info/?l=xen-devel&m=132371797519877
>
> I pointed out some issues with this in
> http://marc.info/?l=xen-devel&m=132378496608354&w=2 which have gone
> unanswered.
I was asked by Ian to wait for his next version and so I did.
> In particular error handling for the pthread_setspecific in
> libxl__free_all seems pretty nasty to me since you would be introducing
> a new failure path at the end of pretty much every libxl function. Worse
> it is after the actual action of each function is otherwise complete so
> you may end up having to undo stuff. I think it is going to be a lot of
> work to fix all of those up properly.
>
> Having frequently used pro/epilogue code (especially epilogue) which
> cannot fail seems much simpler in general to me.
The epilogue is not a problem because pthread_setspecific could only
fail if the key is invalid so we don't need to handle that error.
However the prologue still needs error handling.
Personally I don't think there is anything wrong with a GC_INIT that can
fail. We can decide whether to handle the error within the macro (like
it is done now in the new updated patch) or outside the macro. Both are
fine by me.
diff -r 5b2676ac1321 tools/libxl/libxl.c
--- a/tools/libxl/libxl.c Mon Jan 09 16:01:44 2012 +0100
+++ b/tools/libxl/libxl.c Thu Jan 12 13:44:16 2012 +0000
@@ -60,6 +60,12 @@ int libxl_ctx_alloc(libxl_ctx **pctx, in
* only as an initialiser, not as an expression. */
memcpy(&ctx->lock, &mutex_value, sizeof(ctx->lock));
+ if(pthread_key_create(&ctx->tls_key, NULL) < 0) {
+ LIBXL__LOG_ERRNOVAL(ctx, LIBXL__LOG_ERROR, errno,
+ "cannot create tls key");
+ return ERROR_FAIL;
+ }
+
if ( stat(XENSTORE_PID_FILE, &stat_buf) != 0 ) {
LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "Is xenstore daemon running?\n"
"failed to stat %s", XENSTORE_PID_FILE);
@@ -93,6 +99,8 @@ int libxl_ctx_free(libxl_ctx *ctx)
if (ctx->xch) xc_interface_close(ctx->xch);
libxl_version_info_dispose(&ctx->version_info);
if (ctx->xsh) xs_daemon_close(ctx->xsh);
+ if (pthread_key_delete(ctx->tls_key) < 0)
+ return ERROR_FAIL;
free(ctx);
return 0;
}
diff -r 5b2676ac1321 tools/libxl/libxl_internal.c
--- a/tools/libxl/libxl_internal.c Mon Jan 09 16:01:44 2012 +0100
+++ b/tools/libxl/libxl_internal.c Thu Jan 12 13:44:16 2012 +0000
@@ -17,6 +17,7 @@
#include <stdio.h>
+#include <pthread.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
@@ -61,11 +62,38 @@ int libxl__ptr_add(libxl__gc *gc, void *
return 0;
}
+libxl__gc *libxl__init_gc(libxl_ctx *ctx)
+{
+ libxl__gc *gc = (libxl__gc *) pthread_getspecific(ctx->tls_key);
+ if (gc == NULL) {
+ gc = (libxl__gc *) malloc(sizeof(libxl__gc));
+ if (gc == NULL)
+ return NULL;
+ gc->alloc_maxsize = 0;
+ gc->alloc_ptrs = 0;
+ gc->nested = 0;
+ gc->owner = ctx;
+ gc->nested = 1;
+ if (pthread_setspecific(ctx->tls_key, gc) < 0) {
+ free(gc);
+ return NULL;
+ }
+ } else {
+ gc->nested++;
+ }
+ return gc;
+}
+
+
void libxl__free_all(libxl__gc *gc)
{
void *ptr;
int i;
+ gc->nested--;
+ if (gc->nested > 0)
+ return;
+
for (i = 0; i < gc->alloc_maxsize; i++) {
ptr = gc->alloc_ptrs[i];
gc->alloc_ptrs[i] = NULL;
@@ -74,6 +102,8 @@ void libxl__free_all(libxl__gc *gc)
free(gc->alloc_ptrs);
gc->alloc_ptrs = 0;
gc->alloc_maxsize = 0;
+ pthread_setspecific(CTX->tls_key, NULL);
+ free(gc);
}
void *libxl__zalloc(libxl__gc *gc, int bytes)
diff -r 5b2676ac1321 tools/libxl/libxl_internal.h
--- a/tools/libxl/libxl_internal.h Mon Jan 09 16:01:44 2012 +0100
+++ b/tools/libxl/libxl_internal.h Thu Jan 12 13:44:16 2012 +0000
@@ -98,6 +98,8 @@ struct libxl__ctx {
xc_interface *xch;
struct xs_handle *xsh;
+ pthread_key_t tls_key;
+
pthread_mutex_t lock; /* protects data structures hanging off the ctx */
/* Always use CTX_LOCK and CTX_UNLOCK to manipulate this.
*
@@ -145,9 +147,9 @@ typedef struct {
int alloc_maxsize;
void **alloc_ptrs;
libxl_ctx *owner;
+ int nested;
} libxl__gc;
-#define LIBXL_INIT_GC(ctx) (libxl__gc){ .alloc_maxsize = 0, .alloc_ptrs = 0, .owner = ctx }
static inline libxl_ctx *libxl__gc_owner(libxl__gc *gc)
{
return gc->owner;
@@ -721,7 +723,8 @@ libxl__device_model_version_running(libx
* as a local variable.
*/
-#define GC_INIT(ctx) libxl__gc gc[1] = { LIBXL_INIT_GC(ctx) }
+_hidden libxl__gc *libxl__init_gc(struct libxl__ctx *ctx);
+#define GC_INIT(ctx) libxl__gc *gc = libxl__init_gc(ctx); if (gc == NULL) return ERROR_NOMEM;
#define GC_FREE libxl__free_all(gc)
#define CTX libxl__gc_owner(gc)
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 07/10] libxl: New API for providing OS events to libxl
2012-01-12 11:28 ` Ian Campbell
2012-01-12 13:49 ` Stefano Stabellini
@ 2012-01-12 15:49 ` Ian Jackson
1 sibling, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-12 15:49 UTC (permalink / raw)
To: Ian Campbell
Cc: xen-devel@lists.xensource.com, Ian Jackson, Stefano Stabellini
Ian Campbell writes ("Re: [Xen-devel] [PATCH 07/10] libxl: New API for providing OS events to libxl"):
> It occurred to me just now that having a different type of this type of
> gc has the benefit that since libxl__event_occurred takes one it will
> necessarily filter back up the call chain and help enforce/highlight the
> requirement that functions which directly or indirectly call
> libxl__event_occurred use an egc.
Yes, exactly. This is a very helpful consequence of using a different
type.
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread
* Re: [PATCH 07/10] libxl: New API for providing OS events to libxl
2012-01-11 17:32 ` Stefano Stabellini
2012-01-12 11:28 ` Ian Campbell
@ 2012-01-12 15:56 ` Ian Jackson
1 sibling, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-12 15:56 UTC (permalink / raw)
To: Stefano Stabellini; +Cc: xen-devel@lists.xensource.com, Ian Campbell
Stefano Stabellini writes ("Re: [Xen-devel] [PATCH 07/10] libxl: New API for providing OS events to libxl"):
> I still prefer the approach prototyped in
> http://marc.info/?l=xen-devel&m=132371797519877: avoid introducing
> restrictions on how libxl functions have to be called, unify egc and gc,
> make it possible to take the lock recursively and use the nested counter
> to figure out when to call the callbacks.
> It would make my head hurt less when I have to read/write this code,
> however others might react differently.
I would agree with you if it were the case that editing general code
in libxl might involve adding new event-generating functions, or
indeed might involve turning existing functions into event-generating
ones.
But this is not the case. The event-generating portions of the code
end up completely separate in any correct implementation - and someone
using this machinery doesn't even need to be very aware of this.
> Only one more thing: I would kindly ask to move all these event related
> functions to a different source file, to make it easier for people to
> understand which ones are different from the rest of the library.
They are, in libxl_event.c. Unless by "event related" you meant
"event generating", in which case I disagree, because I don't think
that's the most relevant distinction.
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread
* Re: [PATCH 07/10] libxl: New API for providing OS events to libxl
2012-01-06 20:35 ` [PATCH 07/10] libxl: New API for providing OS events to libxl Ian Jackson
2012-01-11 17:32 ` Stefano Stabellini
@ 2012-01-13 15:07 ` Ian Campbell
2012-01-13 15:47 ` Ian Jackson
1 sibling, 1 reply; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 15:07 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-06 at 20:35 +0000, Ian Jackson wrote:
> We provide a new set of functions and related structures
> libxl_osevent_*
> which are to be used by event-driven applications to receive
> information from libxl about which fds libxl is interested in, and
> what timeouts libxl is waiting for, and to pass back to libxl
> information about which fds are readable/writeable etc., and which
> timeouts have occurred. Ie, low-level events.
>
> In this patch, this new machinery is still all unused. Callers will
> appear in the next patch in the series, which introduces a new API for
> applications to receive high-level events about actual domains etc.
>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
I think I've mostly looked at this already so I only glanced through it
this time.
> [...]
> +int libxl_osevent_beforepoll(libxl_ctx *ctx, int *nfds_io,
> + struct pollfd *fds, int *timeout_upd,
> + struct timeval now);
> + /* The caller should provide beforepoll with some space for libxl's
> + * fds, and tell libxl how much space is available by setting *nfds_io.
> + * fds points to the start of this space (and fds may be a pointer into
> + * a larger array, for example, if the application has some fds of
> + * its own that it is interested in).
I think you were going to move the comments (sorry).
> [...]
> @@ -733,6 +950,49 @@ libxl__device_model_version_running(libxl__gc *gc, uint32_t domid);
>
>
> /*
> + * Calling context and GC for event-generating functions:
> + *
> + * These are for use by parts of libxl which directly or indirectly
> + * call libxl__event_occurred. These contain a gc but also a list of
> + * deferred events.
> + *
> + * Most code in libxlshould not need to initialise their own egc.
Missing space. ^
Will any function even need to initialise their own egc and/or is it
normally provided by infrastructure code? Otherwise when should a
function initialise their own egc? Is it simply that you know if you
need to initialise one because you are calling a function which takes
one?
> + * Even functions which generate specific kinds of events don't need
> + * to - rather, they will be passed an egc into their own callback
> + * function and should just use the one they're given.
> + *
> + * A handy idiom for functions taking an egc is:
> + * libxl__gc *gc = &egc->gc;
You've provided lots of handy macros for other things like this, perhaps
EGC by comparison with CTX. Using GC seems better on the face of it but
since it will only work in a context with an egc that is actually
confusing.
> + * Functions using LIBXL__INIT_EGC may *not* generally be called from
> + * within libxl, because libxl__egc_cleanup may call back into the
> + * application. This should be documented near the function
> + * prototype(s) for callers of LIBXL__INIT_EGC and EGC_INIT.
Can we also enforce/check this with a flag in the ctx? I guess not since
multiple threads might call into libxl with the same ctx and each may
legitimately setup an egc.?
> + *
> + * For the same reason libxl__egc_cleanup (or EGC_FREE) must be called
> + * with the ctx *unlocked*. So the right pattern has the EGC_...
> + * macro calls on the outside of the CTX_... ones.
> + */
> +
> +/* egc initialisation and destruction: */
> +
> +#define LIBXL_INIT_EGC(egc,ctx) do{ \
> + LIBXL_INIT_GC((egc).gc,ctx); \
> + /* list of occurred events tbd */ \
> + } while(0)
> +
> +_hidden void libxl__egc_cleanup(libxl__egc *egc);
> +
> +/* convenience macros: */
> +
> +#define EGC_INIT(ctx) \
> + libxl__egc egc[1]; LIBXL_INIT_EGC(egc[0],ctx); \
> + libxl__gc *gc = &egc->gc
> +
> +#define EGC_FREE libxl__egc_cleanup(egc)
> +
> +
> +/*
> * Convenience macros.
> */
>
> --
> 1.7.2.5
>
>
> _______________________________________________
> Xen-devel mailing list
> Xen-devel@lists.xensource.com
> http://lists.xensource.com/xen-devel
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 07/10] libxl: New API for providing OS events to libxl
2012-01-13 15:07 ` Ian Campbell
@ 2012-01-13 15:47 ` Ian Jackson
2012-01-13 15:56 ` Ian Campbell
0 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-13 15:47 UTC (permalink / raw)
To: Ian Campbell; +Cc: xen-devel@lists.xensource.com
Ian Campbell writes ("Re: [Xen-devel] [PATCH 07/10] libxl: New API for providing OS events to libxl"):
> On Fri, 2012-01-06 at 20:35 +0000, Ian Jackson wrote:
> > +int libxl_osevent_beforepoll(libxl_ctx *ctx, int *nfds_io,
> > + struct pollfd *fds, int *timeout_upd,
> > + struct timeval now);
> > + /* The caller should provide beforepoll with some space for libxl's
> > + * fds, and tell libxl how much space is available by setting *nfds_io.
> > + * fds points to the start of this space (and fds may be a pointer into
> > + * a larger array, for example, if the application has some fds of
> > + * its own that it is interested in).
>
> I think you were going to move the comments (sorry).
*sigh* OK, I will do that.
> > + * Most code in libxlshould not need to initialise their own egc.
>
> Missing space. ^
Fixed.
> Will any function even need to initialise their own egc and/or is it
> normally provided by infrastructure code? Otherwise when should a
> function initialise their own egc? Is it simply that you know if you
> need to initialise one because you are calling a function which takes
> one?
You don't need to because you should never end up calling a function
that takes an egc unless you've got one already from the event
machinery.
> > + * Even functions which generate specific kinds of events don't need
> > + * to - rather, they will be passed an egc into their own callback
> > + * function and should just use the one they're given.
> > + *
> > + * A handy idiom for functions taking an egc is:
> > + * libxl__gc *gc = &egc->gc;
>
> You've provided lots of handy macros for other things like this, perhaps
> EGC by comparison with CTX. Using GC seems better on the face of it but
> since it will only work in a context with an egc that is actually
> confusing.
How about:
#define EGC_GC libxl__gc *gc = &egc->gc
?
> > + * Functions using LIBXL__INIT_EGC may *not* generally be called from
> > + * within libxl, because libxl__egc_cleanup may call back into the
> > + * application. This should be documented near the function
> > + * prototype(s) for callers of LIBXL__INIT_EGC and EGC_INIT.
>
> Can we also enforce/check this with a flag in the ctx? I guess not since
> multiple threads might call into libxl with the same ctx and each may
> legitimately setup an egc.?
Exactly. This is the same disagreement I'm having with Stefano.
But this restriction is not difficult in practice because functions
that want to generate events are almost[1] invariably functions which
were themselves called in response to an OS event, and they get an egc
provided by the event machinery.
See for example disk_eject_xswatch_callback, which is the thing which
generates events of type DISK_EJECT. It's a xenstore watch callback
function, so it gets an egc provided by the event machinery and uses
that for NEW_EVENT etc.
The code which sets up the callback, libxl_evenable_disk_eject,
doesn't need an egc because setting up a callback only needs a gc. So
you never need to construct an egc yourself.
The functions which make their own egc, and which are therefore
forbidden for other callers inside libxl, are things like
libxl_osevent_beforepoll
libxl_event_wait
and if you're calling those from within libxl you are definitely doing
the whole thing entirely wrong.
Ian.
[1] libxl__ao_inprogress is a counterexample, but it's part of the
event machinery, not a normal function implementing some actual
domain-related functionality.
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 07/10] libxl: New API for providing OS events to libxl
2012-01-13 15:47 ` Ian Jackson
@ 2012-01-13 15:56 ` Ian Campbell
2012-01-13 16:34 ` Ian Jackson
0 siblings, 1 reply; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 15:56 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-13 at 15:47 +0000, Ian Jackson wrote:
> Ian Campbell writes ("Re: [Xen-devel] [PATCH 07/10] libxl: New API for providing OS events to libxl"):
> > On Fri, 2012-01-06 at 20:35 +0000, Ian Jackson wrote:
> > Will any function even need to initialise their own egc and/or is it
> > normally provided by infrastructure code? Otherwise when should a
> > function initialise their own egc? Is it simply that you know if you
> > need to initialise one because you are calling a function which takes
> > one?
>
> You don't need to because you should never end up calling a function
> that takes an egc unless you've got one already from the event
> machinery.
I think it is worth stating explicitly. e.g. "You should never need to
initialise an egc unless you are part of the event machinery itself,
Otherwise you will always be given an egc if you need one". I might even
go as far as s/should never/will never/.
> > > + * Even functions which generate specific kinds of events don't need
> > > + * to - rather, they will be passed an egc into their own callback
> > > + * function and should just use the one they're given.
> > > + *
> > > + * A handy idiom for functions taking an egc is:
> > > + * libxl__gc *gc = &egc->gc;
> >
> > You've provided lots of handy macros for other things like this, perhaps
> > EGC by comparison with CTX. Using GC seems better on the face of it but
> > since it will only work in a context with an egc that is actually
> > confusing.
>
> How about:
> #define EGC_GC libxl__gc *gc = &egc->gc
> ?
Works for me.
>
> > > + * Functions using LIBXL__INIT_EGC may *not* generally be called from
> > > + * within libxl, because libxl__egc_cleanup may call back into the
> > > + * application. This should be documented near the function
> > > + * prototype(s) for callers of LIBXL__INIT_EGC and EGC_INIT.
> >
> > Can we also enforce/check this with a flag in the ctx? I guess not since
> > multiple threads might call into libxl with the same ctx and each may
> > legitimately setup an egc.?
>
> Exactly. This is the same disagreement I'm having with Stefano.
>
> But this restriction is not difficult in practice because functions
> that want to generate events are almost[1] invariably functions which
> were themselves called in response to an OS event, and they get an egc
> provided by the event machinery.
>
> See for example disk_eject_xswatch_callback, which is the thing which
> generates events of type DISK_EJECT. It's a xenstore watch callback
> function, so it gets an egc provided by the event machinery and uses
> that for NEW_EVENT etc.
>
> The code which sets up the callback, libxl_evenable_disk_eject,
> doesn't need an egc because setting up a callback only needs a gc. So
> you never need to construct an egc yourself.
>
> The functions which make their own egc, and which are therefore
> forbidden for other callers inside libxl, are things like
> libxl_osevent_beforepoll
> libxl_event_wait
> and if you're calling those from within libxl you are definitely doing
> the whole thing entirely wrong.
>
> Ian.
>
> [1] libxl__ao_inprogress is a counterexample, but it's part of the
> event machinery, not a normal function implementing some actual
> domain-related functionality.
Makes sense, I think the wording I proposed above describes this?
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 07/10] libxl: New API for providing OS events to libxl
2012-01-13 15:56 ` Ian Campbell
@ 2012-01-13 16:34 ` Ian Jackson
0 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-13 16:34 UTC (permalink / raw)
To: Ian Campbell; +Cc: xen-devel@lists.xensource.com
Ian Campbell writes ("Re: [Xen-devel] [PATCH 07/10] libxl: New API for providing OS events to libxl"):
> I think it is worth stating explicitly. e.g. "You should never need to
> initialise an egc unless you are part of the event machinery itself,
> Otherwise you will always be given an egc if you need one". I might even
> go as far as s/should never/will never/.
Right, that's good wording, thanks.
> > How about:
> > #define EGC_GC libxl__gc *gc = &egc->gc
> > ?
>
> Works for me.
I will do this.
> > The functions which make their own egc, and which are therefore
> > forbidden for other callers inside libxl, are things like
> > libxl_osevent_beforepoll
> > libxl_event_wait
> > and if you're calling those from within libxl you are definitely doing
> > the whole thing entirely wrong.
...
> Makes sense, I think the wording I proposed above describes this?
Right.
Ian.
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index e03a5d6..c50c058 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -967,10 +967,12 @@ libxl__device_model_version_running(libxl__gc *gc, uint32_t domid);
* call libxl__event_occurred. These contain a gc but also a list of
* deferred events.
*
- * Most code in libxl should not need to initialise their own egc.
- * Even functions which generate specific kinds of events don't need
- * to - rather, they will be passed an egc into their own callback
- * function and should just use the one they're given.
+ * You should never need to initialise an egc unless you are part of
+ * the event machinery itself. Otherwise you will always be given an
+ * egc if you need one. Even functions which generate specific kinds
+ * of events don't need to - rather, they will be passed an egc into
+ * their own callback function and should just use the one they're
+ * given.
*
* A handy idiom for functions taking an egc is:
* libxl__gc *gc = &egc->gc;
@@ -978,7 +980,9 @@ libxl__device_model_version_running(libxl__gc *gc, uint32_t domid);
* Functions using LIBXL__INIT_EGC may *not* generally be called from
* within libxl, because libxl__egc_cleanup may call back into the
* application. This should be documented near the function
- * prototype(s) for callers of LIBXL__INIT_EGC and EGC_INIT.
+ * prototype(s) for callers of LIBXL__INIT_EGC and EGC_INIT. You
+ * should in any case not find it necessary to call egc-creators from
+ * within libxl.
*
* For the same reason libxl__egc_cleanup (or EGC_FREE) must be called
* with the ctx *unlocked*. So the right pattern has the EGC_...
^ permalink raw reply related [flat|nested] 43+ messages in thread
* [PATCH 08/10] libxl: New event generation API
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (6 preceding siblings ...)
2012-01-06 20:35 ` [PATCH 07/10] libxl: New API for providing OS events to libxl Ian Jackson
@ 2012-01-06 20:35 ` Ian Jackson
2012-01-13 15:22 ` Ian Campbell
2012-01-06 20:35 ` [PATCH 09/10] libxl: introduce libxl_fd_set_nonblock, rationalise _cloexec Ian Jackson
` (7 subsequent siblings)
15 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-06 20:35 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
Replace the existing API for retrieving high-level events (events
about domains, etc.) from libxl with a new one.
This changes the definition and semantics of the `libxl_event'
structure, and replaces the calls for obtaining information about
domain death and disk eject events.
This is an incompatible change, sorry. The alternative was to try to
provide both the previous horrid API and the new one, and would also
involve never using the name `libxl_event' for the new interface.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl.c | 327 ++++++++++++++++++++++++++++++-----------
tools/libxl/libxl.h | 55 ++------
tools/libxl/libxl_event.c | 239 ++++++++++++++++++++++++++++---
tools/libxl/libxl_event.h | 184 +++++++++++++++++++++++-
tools/libxl/libxl_internal.h | 82 ++++++++++-
tools/libxl/libxl_types.idl | 34 ++++-
tools/libxl/xl_cmdimpl.c | 270 ++++++++++++++++++++---------------
7 files changed, 912 insertions(+), 279 deletions(-)
diff --git a/tools/libxl/libxl.c b/tools/libxl/libxl.c
index c0024af..f6370d4 100644
--- a/tools/libxl/libxl.c
+++ b/tools/libxl/libxl.c
@@ -45,8 +45,11 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
* only as an initialiser, not as an expression. */
memcpy(&ctx->lock, &mutex_value, sizeof(ctx->lock));
+ LIBXL_TAILQ_INIT(&ctx->occurred);
+
ctx->osevent_hooks = 0;
+ ctx->fd_polls = 0;
ctx->fd_rindex = 0;
LIBXL_LIST_INIT(&ctx->efds);
LIBXL_TAILQ_INIT(&ctx->etimes);
@@ -55,6 +58,9 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
LIBXL_SLIST_INIT(&ctx->watch_freeslots);
libxl__ev_fd_init(&ctx->watch_efd);
+ LIBXL_TAILQ_INIT(&ctx->death_list);
+ libxl__ev_xswatch_init(&ctx->death_watch);
+
if ( stat(XENSTORE_PID_FILE, &stat_buf) != 0 ) {
LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "Is xenstore daemon running?\n"
"failed to stat %s", XENSTORE_PID_FILE);
@@ -86,6 +92,20 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
return rc;
}
+static void free_disable_deaths(libxl__gc *gc,
+ struct libxl__evgen_domain_death_list *l) {
+ libxl_evgen_domain_death *death;
+ while ((death = LIBXL_TAILQ_FIRST(l)))
+ libxl__evdisable_domain_death(gc, death);
+}
+
+static void discard_events(struct libxl__event_list *l) {
+ /* doesn't bother unlinking from the list, so l is corrupt on return */
+ libxl_event *ev;
+ LIBXL_TAILQ_FOREACH(ev, l, link)
+ libxl_event_free(0, ev);
+}
+
int libxl_ctx_free(libxl_ctx *ctx)
{
if (!ctx) return 0;
@@ -95,6 +115,13 @@ int libxl_ctx_free(libxl_ctx *ctx)
/* Deregister all libxl__ev_KINDs: */
+ free_disable_deaths(gc, &CTX->death_list);
+ free_disable_deaths(gc, &CTX->death_reported);
+
+ libxl_evgen_disk_eject *eject;
+ while ((eject = LIBXL_LIST_FIRST(&CTX->disk_eject_evgens)))
+ libxl__evdisable_disk_eject(gc, eject);
+
for (i = 0; i < ctx->watch_nslots; i++)
assert(!libxl__watch_slot_contents(gc, i));
libxl__ev_fd_deregister(gc, &ctx->watch_efd);
@@ -108,9 +135,12 @@ int libxl_ctx_free(libxl_ctx *ctx)
libxl_version_info_dispose(&ctx->version_info);
if (ctx->xsh) xs_daemon_close(ctx->xsh);
+ free(ctx->fd_polls);
free(ctx->fd_rindex);
free(ctx->watch_slots);
+ discard_events(&ctx->occurred);
+
GC_FREE;
free(ctx);
return 0;
@@ -646,117 +676,175 @@ int libxl_domain_reboot(libxl_ctx *ctx, uint32_t domid)
return ret;
}
-int libxl_get_wait_fd(libxl_ctx *ctx, int *fd)
-{
- *fd = xs_fileno(ctx->xsh);
- return 0;
-}
+static void domain_death_xswatch_callback(libxl__egc *egc, libxl__ev_xswatch *w,
+ const char *wpath, const char *epath) {
+ libxl__gc *gc = &egc->gc;
+ libxl_evgen_domain_death *evg;
+ uint32_t domid;
+ int rc;
-int libxl_wait_for_domain_death(libxl_ctx *ctx, uint32_t domid, libxl_waiter *waiter)
-{
- waiter->path = strdup("@releaseDomain");
- if (asprintf(&(waiter->token), "%d", LIBXL_EVENT_TYPE_DOMAIN_DEATH) < 0)
- return -1;
- if (!xs_watch(ctx->xsh, waiter->path, waiter->token))
- return -1;
- return 0;
-}
+ CTX_LOCK;
-int libxl_wait_for_disk_ejects(libxl_ctx *ctx, uint32_t guest_domid, libxl_device_disk *disks, int num_disks, libxl_waiter *waiter)
-{
- GC_INIT(ctx);
- int i, rc = -1;
- uint32_t domid = libxl_get_stubdom_id(ctx, guest_domid);
+ evg = LIBXL_TAILQ_FIRST(&CTX->death_list);
+ if (!evg) goto out;
- if (!domid)
- domid = guest_domid;
+ domid = evg->domid;
- for (i = 0; i < num_disks; i++) {
- if (asprintf(&(waiter[i].path), "%s/device/vbd/%d/eject",
- libxl__xs_get_dompath(gc, domid),
- libxl__device_disk_dev_number(disks[i].vdev,
- NULL, NULL)) < 0)
- goto out;
- if (asprintf(&(waiter[i].token), "%d", LIBXL_EVENT_TYPE_DISK_EJECT) < 0)
+ for (;;) {
+ int nentries = LIBXL_TAILQ_NEXT(evg, entry) ? 200 : 1;
+ xc_domaininfo_t domaininfos[nentries];
+ const xc_domaininfo_t *got = domaininfos, *gotend;
+
+ rc = xc_domain_getinfolist(CTX->xch, domid, nentries, domaininfos);
+ if (rc == -1) {
+ LIBXL__EVENT_DISASTER(egc, "xc_domain_getinfolist failed while"
+ " processing @releaseDomain watch event",
+ errno, 0);
goto out;
- xs_watch(ctx->xsh, waiter[i].path, waiter[i].token);
+ }
+ gotend = &domaininfos[rc];
+
+ for (;;) {
+ if (!evg)
+ goto all_reported;
+
+ if (!rc || got->domain > evg->domid) {
+ /* ie, the list doesn't contain evg->domid any more so
+ * the domain has been destroyed */
+ libxl_evgen_domain_death *evg_next;
+
+ libxl_event *ev = NEW_EVENT(egc, DOMAIN_DESTROY, evg->domid);
+ if (!ev) goto out;
+
+ libxl__event_occurred(egc, ev);
+
+ evg->death_reported = 1;
+ evg_next = LIBXL_TAILQ_NEXT(evg, entry);
+ LIBXL_TAILQ_REMOVE(&CTX->death_list, evg, entry);
+ LIBXL_TAILQ_INSERT_HEAD(&CTX->death_reported, evg, entry);
+ evg = evg_next;
+
+ continue;
+ }
+
+ if (got == gotend)
+ break;
+
+ if (got->domain < evg->domid) {
+ got++;
+ continue;
+ }
+
+ assert(evg->domid == got->domain);
+
+ if (!evg->shutdown_reported &&
+ (got->flags & XEN_DOMINF_shutdown)) {
+ libxl_event *ev = NEW_EVENT(egc, DOMAIN_SHUTDOWN, got->domain);
+ if (!ev) goto out;
+
+ ev->u.domain_shutdown.shutdown_reason =
+ (got->flags >> XEN_DOMINF_shutdownshift) &
+ XEN_DOMINF_shutdownmask;
+ libxl__event_occurred(egc, ev);
+
+ evg->shutdown_reported = 1;
+ }
+ evg = LIBXL_TAILQ_NEXT(evg, entry);
+ }
+
+ assert(rc); /* rc==0 results in us eating all evgs and quitting */
+ domid = gotend[-1].domain;
}
- rc = 0;
-out:
- GC_FREE;
- return rc;
+ all_reported:
+ out:
+
+ CTX_UNLOCK;
}
-int libxl_get_event(libxl_ctx *ctx, libxl_event *event)
-{
- unsigned int num;
- char **events = xs_read_watch(ctx->xsh, &num);
- if (num != 2) {
- free(events);
- return ERROR_FAIL;
+int libxl_evenable_domain_death(libxl_ctx *ctx, uint32_t domid,
+ libxl_ev_user user, libxl_evgen_domain_death **evgen_out) {
+ GC_INIT(ctx);
+ libxl_evgen_domain_death *evg, *evg_search;
+ int rc;
+
+ CTX_LOCK;
+
+ evg = malloc(sizeof(*evg)); if (!evg) { rc = ERROR_NOMEM; goto out; }
+ memset(evg, 0, sizeof(*evg));
+ evg->domid = domid;
+ evg->user = user;
+
+ LIBXL_TAILQ_INSERT_SORTED(&ctx->death_list, entry, evg, evg_search, ,
+ evg->domid > evg_search->domid);
+
+ if (!libxl__ev_xswatch_isregistered(&ctx->death_watch)) {
+ rc = libxl__ev_xswatch_register(gc, &ctx->death_watch,
+ domain_death_xswatch_callback, "@releaseDomain");
+ if (rc) { libxl__evdisable_domain_death(gc, evg); goto out; }
}
- event->path = strdup(events[XS_WATCH_PATH]);
- event->token = strdup(events[XS_WATCH_TOKEN]);
- event->type = atoi(event->token);
- free(events);
- return 0;
-}
-int libxl_stop_waiting(libxl_ctx *ctx, libxl_waiter *waiter)
-{
- if (!xs_unwatch(ctx->xsh, waiter->path, waiter->token))
- return ERROR_FAIL;
- else
- return 0;
-}
+ rc = 0;
-int libxl_free_event(libxl_event *event)
-{
- free(event->path);
- free(event->token);
- return 0;
-}
+ out:
+ CTX_UNLOCK;
+ return rc;
+};
-int libxl_free_waiter(libxl_waiter *waiter)
-{
- free(waiter->path);
- free(waiter->token);
- return 0;
-}
+void libxl__evdisable_domain_death(libxl__gc *gc,
+ libxl_evgen_domain_death *evg) {
+ CTX_LOCK;
-int libxl_event_get_domain_death_info(libxl_ctx *ctx, uint32_t domid, libxl_event *event, libxl_dominfo *info)
-{
- if (libxl_domain_info(ctx, info, domid) < 0)
- return 0;
+ if (!evg->death_reported)
+ LIBXL_TAILQ_REMOVE(&CTX->death_list, evg, entry);
+ else
+ LIBXL_TAILQ_REMOVE(&CTX->death_reported, evg, entry);
- if (info->running || (!info->shutdown && !info->dying))
- return ERROR_INVAL;
+ free(evg);
- return 1;
+ if (!LIBXL_TAILQ_FIRST(&CTX->death_list) &&
+ libxl__ev_xswatch_isregistered(&CTX->death_watch))
+ libxl__ev_xswatch_deregister(gc, &CTX->death_watch);
+
+ CTX_UNLOCK;
}
-int libxl_event_get_disk_eject_info(libxl_ctx *ctx, uint32_t domid, libxl_event *event, libxl_device_disk *disk)
-{
+void libxl_evdisable_domain_death(libxl_ctx *ctx,
+ libxl_evgen_domain_death *evg) {
GC_INIT(ctx);
- char *path;
+ libxl__evdisable_domain_death(gc, evg);
+ GC_FREE;
+}
+
+static void disk_eject_xswatch_callback(libxl__egc *egc, libxl__ev_xswatch *w,
+ const char *wpath, const char *epath) {
+ libxl__gc *gc = &egc->gc;
+ libxl_evgen_disk_eject *evg = (void*)w;
char *backend;
char *value;
char backend_type[BACKEND_STRING_SIZE+1];
- value = libxl__xs_read(gc, XBT_NULL, event->path);
+ value = libxl__xs_read(gc, XBT_NULL, wpath);
- if (!value || strcmp(value, "eject")) {
- GC_FREE;
- return 0;
+ if (!value || strcmp(value, "eject"))
+ return;
+
+ if (libxl__xs_write(gc, XBT_NULL, wpath, "")) {
+ LIBXL__EVENT_DISASTER(egc, "xs_write failed acknowledging eject",
+ errno, LIBXL_EVENT_TYPE_DISK_EJECT);
+ return;
}
- path = strdup(event->path);
- path[strlen(path) - 6] = '\0';
- backend = libxl__xs_read(gc, XBT_NULL, libxl__sprintf(gc, "%s/backend", path));
+ libxl_event *ev = NEW_EVENT(egc, DISK_EJECT, evg->domid);
+ libxl_device_disk *disk = &ev->u.disk_eject.disk;
+
+ backend = libxl__xs_read(gc, XBT_NULL,
+ libxl__sprintf(gc, "%.*s/backend",
+ (int)strlen(wpath)-6, wpath));
sscanf(backend,
- "/local/domain/%d/backend/%" TOSTRING(BACKEND_STRING_SIZE) "[a-z]/%*d/%*d",
- &disk->backend_domid, backend_type);
+ "/local/domain/%d/backend/%" TOSTRING(BACKEND_STRING_SIZE)
+ "[a-z]/%*d/%*d",
+ &disk->backend_domid, backend_type);
if (!strcmp(backend_type, "tap") || !strcmp(backend_type, "vbd")) {
disk->backend = LIBXL_DISK_BACKEND_TAP;
} else if (!strcmp(backend_type, "qdisk")) {
@@ -765,19 +853,82 @@ int libxl_event_get_disk_eject_info(libxl_ctx *ctx, uint32_t domid, libxl_event
disk->backend = LIBXL_DISK_BACKEND_UNKNOWN;
}
- disk->pdev_path = strdup("");
+ disk->pdev_path = strdup(""); /* xxx fixme malloc failure */
disk->format = LIBXL_DISK_FORMAT_EMPTY;
/* this value is returned to the user: do not free right away */
- disk->vdev = xs_read(ctx->xsh, XBT_NULL, libxl__sprintf(gc, "%s/dev", backend), NULL);
+ disk->vdev = xs_read(CTX->xsh, XBT_NULL,
+ libxl__sprintf(gc, "%s/dev", backend), NULL);
disk->removable = 1;
disk->readwrite = 0;
disk->is_cdrom = 1;
- free(path);
+ libxl__event_occurred(egc, ev);
+}
+
+int libxl_evenable_disk_eject(libxl_ctx *ctx, uint32_t guest_domid,
+ const char *vdev, libxl_ev_user user,
+ libxl_evgen_disk_eject **evgen_out) {
+ GC_INIT(ctx);
+ CTX_LOCK;
+ int rc;
+ char *path;
+ libxl_evgen_disk_eject *evg = NULL;
+
+ evg = malloc(sizeof(*evg)); if (!evg) { rc = ERROR_NOMEM; goto out; }
+ memset(evg, 0, sizeof(*evg));
+ evg->user = user;
+ evg->domid = guest_domid;
+ LIBXL_LIST_INSERT_HEAD(&CTX->disk_eject_evgens, evg, entry);
+
+ evg->vdev = strdup(vdev);
+ if (!evg->vdev) { rc = ERROR_NOMEM; goto out; }
+
+ uint32_t domid = libxl_get_stubdom_id(ctx, guest_domid);
+
+ if (!domid)
+ domid = guest_domid;
+
+ path = libxl__sprintf(gc, "%s/device/vbd/%d/eject",
+ libxl__xs_get_dompath(gc, domid),
+ libxl__device_disk_dev_number(vdev, NULL, NULL));
+ if (!path) { rc = ERROR_NOMEM; goto out; }
+
+ rc = libxl__ev_xswatch_register(gc, &evg->watch,
+ disk_eject_xswatch_callback, path);
+ if (rc) goto out;
+
+ CTX_UNLOCK;
GC_FREE;
- return 1;
+ return 0;
+
+ out:
+ if (evg)
+ libxl__evdisable_disk_eject(gc, evg);
+ CTX_UNLOCK;
+ GC_FREE;
+ return rc;
+}
+
+void libxl__evdisable_disk_eject(libxl__gc *gc, libxl_evgen_disk_eject *evg) {
+ CTX_LOCK;
+
+ LIBXL_LIST_REMOVE(evg, entry);
+
+ if (libxl__ev_xswatch_isregistered(&evg->watch))
+ libxl__ev_xswatch_deregister(gc, &evg->watch);
+
+ free(evg->vdev);
+ free(evg);
+
+ CTX_UNLOCK;
}
+void libxl_evdisable_disk_eject(libxl_ctx *ctx, libxl_evgen_disk_eject *evg) {
+ GC_INIT(ctx);
+ libxl__evdisable_disk_eject(gc, evg);
+ GC_FREE;
+}
+
int libxl_domain_destroy(libxl_ctx *ctx, uint32_t domid)
{
GC_INIT(ctx);
diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h
index c0a4373..97ca25e 100644
--- a/tools/libxl/libxl.h
+++ b/tools/libxl/libxl.h
@@ -53,7 +53,10 @@
* A public function may be called from within libxl; the call
* context initialisation macros will make sure that the internal
* caller's context is reused (eg, so that the same xenstore
- * transaction is used).
+ * transaction is used). But in-libxl callers of libxl public
+ * functions should note that any libxl public function may cause
+ * recursively reentry into libxl via the application's event
+ * callback hook.
*
* Public functions have names like libxl_foobar.
*
@@ -152,6 +155,8 @@ void libxl_key_value_list_dispose(libxl_key_value_list *kvl);
typedef uint32_t libxl_hwcap[8];
+typedef uint64_t libxl_ev_user;
+
typedef struct {
uint32_t size; /* number of bytes in map */
uint8_t *map;
@@ -200,6 +205,9 @@ typedef struct {
int v;
} libxl_enum_string_table;
+struct libxl_event;
+typedef LIBXL_TAILQ_ENTRY(struct libxl_event) libxl_ev_link;
+
typedef struct libxl__ctx libxl_ctx;
#include "_libxl_types.h"
@@ -300,51 +308,6 @@ int libxl_run_bootloader(libxl_ctx *ctx,
/* 0 means ERROR_ENOMEM, which we have logged */
-/* events handling */
-
-typedef struct {
- /* event type */
- libxl_event_type type;
- /* data for internal use of the library */
- char *path;
- char *token;
-} libxl_event;
-
-typedef struct {
- char *path;
- char *token;
-} libxl_waiter;
-
-
-int libxl_get_wait_fd(libxl_ctx *ctx, int *fd);
-/* waiter is allocated by the caller */
-int libxl_wait_for_domain_death(libxl_ctx *ctx, uint32_t domid, libxl_waiter *waiter);
-/* waiter is a preallocated array of num_disks libxl_waiter elements */
-int libxl_wait_for_disk_ejects(libxl_ctx *ctx, uint32_t domid, libxl_device_disk *disks, int num_disks, libxl_waiter *waiter);
-int libxl_get_event(libxl_ctx *ctx, libxl_event *event);
-int libxl_stop_waiting(libxl_ctx *ctx, libxl_waiter *waiter);
-int libxl_free_event(libxl_event *event);
-int libxl_free_waiter(libxl_waiter *waiter);
-
-/*
- * Returns:
- * - 0 if the domain is dead but there is no cleanup to be done. e.g
- * because someone else has already done it.
- * - 1 if the domain is dead and there is cleanup to be done.
- *
- * Can return error if the domain exists and is still running.
- *
- * *info will contain valid domain state iff 1 is returned. In
- * particular if 1 is returned then info->shutdown_reason is
- * guaranteed to be valid since by definition the domain is
- * (shutdown||dying))
- */
-int libxl_event_get_domain_death_info(libxl_ctx *ctx, uint32_t domid, libxl_event *event, libxl_dominfo *info);
-
-/*
- * Returns true and fills *disk if the caller should eject the disk
- */
-int libxl_event_get_disk_eject_info(libxl_ctx *ctx, uint32_t domid, libxl_event *event, libxl_device_disk *disk);
int libxl_domain_rename(libxl_ctx *ctx, uint32_t domid,
const char *old_name, const char *new_name);
diff --git a/tools/libxl/libxl_event.c b/tools/libxl/libxl_event.c
index e71ab66..c42b565 100644
--- a/tools/libxl/libxl_event.c
+++ b/tools/libxl/libxl_event.c
@@ -143,7 +143,8 @@ static void time_insert_finite(libxl__gc *gc, libxl__ev_time *ev)
}
static int time_register_finite(libxl__gc *gc, libxl__ev_time *ev,
- struct timeval abs) {
+ struct timeval abs)
+{
int rc;
rc = OSEVENT_HOOK(timeout_register, &ev->for_app_reg, abs, ev);
@@ -508,9 +509,9 @@ void libxl__ev_xswatch_deregister(libxl__gc *gc, libxl__ev_xswatch *w)
* osevent poll
*/
-int libxl_osevent_beforepoll(libxl_ctx *ctx, int *nfds_io,
- struct pollfd *fds, int *timeout_upd,
- struct timeval now)
+static int beforepoll_internal(libxl__gc *gc, int *nfds_io,
+ struct pollfd *fds, int *timeout_upd,
+ struct timeval now)
{
libxl__ev_fd *efd;
int rc;
@@ -522,9 +523,6 @@ int libxl_osevent_beforepoll(libxl_ctx *ctx, int *nfds_io,
* the fds array corresponds to a slot in fd_beforepolled.
*/
- GC_INIT(ctx);
- CTX_LOCK;
-
if (*nfds_io) {
/*
* As an optimisation, we don't touch fd_rindex
@@ -591,8 +589,18 @@ int libxl_osevent_beforepoll(libxl_ctx *ctx, int *nfds_io,
}
out:
+ return rc;
+}
+
+int libxl_osevent_beforepoll(libxl_ctx *ctx, int *nfds_io,
+ struct pollfd *fds, int *timeout_upd,
+ struct timeval now)
+{
+ EGC_INIT(ctx);
+ CTX_LOCK;
+ int rc = beforepoll_internal(gc, nfds_io, fds, timeout_upd, now);
CTX_UNLOCK;
- GC_FREE;
+ EGC_FREE;
return rc;
}
@@ -621,11 +629,11 @@ static int afterpoll_check_fd(libxl_ctx *ctx,
return revents;
}
-void libxl_osevent_afterpoll(libxl_ctx *ctx, int nfds, const struct pollfd *fds,
- struct timeval now)
+static void afterpoll_internal(libxl__egc *egc,
+ int nfds, const struct pollfd *fds,
+ struct timeval now)
{
- EGC_INIT(ctx);
- CTX_LOCK;
+ libxl__gc *gc = &egc->gc;
libxl__ev_fd *efd;
LIBXL_LIST_FOREACH(efd, &CTX->efds, entry) {
@@ -651,12 +659,18 @@ void libxl_osevent_afterpoll(libxl_ctx *ctx, int nfds, const struct pollfd *fds,
etime->func(egc, etime, &etime->abs);
}
+}
+void libxl_osevent_afterpoll(libxl_ctx *ctx, int nfds, const struct pollfd *fds,
+ struct timeval now)
+{
+ EGC_INIT(ctx);
+ CTX_LOCK;
+ afterpoll_internal(egc, nfds, fds, now);
CTX_UNLOCK;
EGC_FREE;
}
-
/*
* osevent hook and callback machinery
*/
@@ -721,11 +735,10 @@ void libxl__event_disaster(libxl__egc *egc, const char *msg, int errnoval,
type ? libxl_event_type_to_string(type) : "",
type ? ")" : "");
- /*
- * FIXME: This should call the "disaster" hook supplied to
- * libxl_event_register_callbacks, which will be introduced in the
- * next patch.
- */
+ if (CTX->event_hooks && CTX->event_hooks->disaster) {
+ CTX->event_hooks->disaster(CTX->event_hooks_user, type, msg, errnoval);
+ return;
+ }
const char verybad[] =
"DISASTER in event loop not handled by libxl application";
@@ -734,9 +747,197 @@ void libxl__event_disaster(libxl__egc *egc, const char *msg, int errnoval,
exit(-1);
}
+static void egc_run_callbacks(libxl__egc *egc)
+{
+ libxl__gc *gc = &egc->gc;
+ libxl_event *ev, *ev_tmp;
+ LIBXL_TAILQ_FOREACH_SAFE(ev, &egc->occurred_for_callback, link, ev_tmp) {
+ LIBXL_TAILQ_REMOVE(&egc->occurred_for_callback, ev, link);
+ CTX->event_hooks->event_occurs(CTX->event_hooks_user, ev);
+ }
+}
+
void libxl__egc_cleanup(libxl__egc *egc)
{
- libxl__gc_cleanup(&egc->gc);
+ libxl__gc *gc = &egc->gc;
+ libxl__gc_cleanup(gc);
+
+ egc_run_callbacks(egc);
+}
+
+/*
+ * Event retrieval etc.
+ */
+
+void libxl_event_register_callbacks(libxl_ctx *ctx,
+ const libxl_event_hooks *hooks, void *user)
+{
+ ctx->event_hooks = hooks;
+ ctx->event_hooks_user = user;
+}
+
+void libxl__event_occurred(libxl__egc *egc, libxl_event *event)
+{
+ libxl__gc *gc = &egc->gc;
+
+ if (CTX->event_hooks &&
+ (CTX->event_hooks->event_occurs_mask & (1UL << event->type))) {
+ /* libxl__egc_cleanup will call the callback, just before exit
+ * from libxl. This helps avoid reentrancy bugs: parts of
+ * libxl that call libxl__event_occurred do not have to worry
+ * that libxl might be reentered at that point. */
+ LIBXL_TAILQ_INSERT_TAIL(&egc->occurred_for_callback, event, link);
+ return;
+ } else {
+ LIBXL_TAILQ_INSERT_TAIL(&CTX->occurred, event, link);
+ }
+}
+
+void libxl_event_free(libxl_ctx *ctx, libxl_event *event)
+{
+ /* Exceptionally, this function may be called from libxl, with ctx==0 */
+ libxl_event_dispose(event);
+ free(event);
+}
+
+libxl_event *libxl__event_new(libxl__egc *egc,
+ libxl_event_type type, uint32_t domid)
+{
+ libxl_event *ev;
+
+ ev = malloc(sizeof(*ev));
+ if (!ev) {
+ LIBXL__EVENT_DISASTER(egc, "allocate new event", errno, type);
+ return NULL;
+ }
+
+ memset(ev, 0, sizeof(*ev));
+ ev->type = type;
+ ev->domid = domid;
+
+ return ev;
+}
+
+static int event_check_internal(libxl__egc *egc, libxl_event **event_r,
+ unsigned long typemask,
+ libxl_event_predicate *pred, void *pred_user)
+{
+ libxl__gc *gc = &egc->gc;
+ libxl_event *ev;
+ int rc;
+
+ LIBXL_TAILQ_FOREACH(ev, &CTX->occurred, link) {
+ if (!(typemask & (1UL << ev->type)))
+ continue;
+
+ if (pred && !pred(ev, pred_user))
+ continue;
+
+ /* got one! */
+ LIBXL_TAILQ_REMOVE(&CTX->occurred, ev, link);
+ *event_r = ev;
+ rc = 0;
+ goto out;
+ }
+ rc = ERROR_NOT_READY;
+
+ out:
+ return rc;
+}
+
+int libxl_event_check(libxl_ctx *ctx, libxl_event **event_r,
+ unsigned long typemask,
+ libxl_event_predicate *pred, void *pred_user)
+{
+ EGC_INIT(ctx);
+ CTX_LOCK;
+ int rc = event_check_internal(egc, event_r, typemask, pred, pred_user);
+ CTX_UNLOCK;
+ EGC_FREE;
+ return rc;
+}
+
+static int eventloop_iteration(libxl__egc *egc) {
+ libxl__gc *gc = &egc->gc;
+ int rc;
+ struct timeval now;
+
+ CTX_LOCK;
+
+ rc = libxl__gettimeofday(gc, &now);
+ if (rc) goto out;
+
+ int timeout;
+
+ for (;;) {
+ int nfds = CTX->fd_polls_allocd;
+ timeout = -1;
+ rc = beforepoll_internal(gc, &nfds, CTX->fd_polls, &timeout, now);
+ if (!rc) break;
+ if (rc != ERROR_BUFFERFULL) goto out;
+
+ struct pollfd *newarray =
+ (nfds > INT_MAX / sizeof(struct pollfd) / 2) ? 0 :
+ realloc(CTX->fd_polls, sizeof(*newarray) * nfds);
+
+ if (!newarray) { rc = ERROR_NOMEM; goto out; }
+
+ CTX->fd_polls = newarray;
+ CTX->fd_polls_allocd = nfds;
+ }
+
+ rc = poll(CTX->fd_polls, CTX->fd_polls_allocd, timeout);
+ if (rc < 0) {
+ if (errno == EINTR)
+ return 0; /* will go round again if caller requires */
+
+ LIBXL__LOG_ERRNOVAL(CTX, LIBXL__LOG_ERROR, errno, "poll failed");
+ rc = ERROR_FAIL;
+ goto out;
+ }
+
+ rc = libxl__gettimeofday(gc, &now);
+ if (rc) goto out;
+
+ afterpoll_internal(egc, CTX->fd_polls_allocd, CTX->fd_polls, now);
+
+ CTX_UNLOCK;
+
+ rc = 0;
+ out:
+ return rc;
+}
+
+int libxl_event_wait(libxl_ctx *ctx, libxl_event **event_r,
+ unsigned long typemask,
+ libxl_event_predicate *pred, void *pred_user)
+{
+ int rc;
+
+ EGC_INIT(ctx);
+ CTX_LOCK;
+
+ for (;;) {
+ rc = event_check_internal(egc, event_r, typemask, pred, pred_user);
+ if (rc != ERROR_NOT_READY) goto out;
+
+ rc = eventloop_iteration(egc);
+ if (rc) goto out;
+
+ /* we unlock and cleanup the egc each time we go through this loop,
+ * so that (a) we don't accumulate garbage and (b) any events
+ * which are to be dispatched by callback are actually delivered
+ * in a timely fashion.
+ */
+ CTX_UNLOCK;
+ libxl__egc_cleanup(egc);
+ CTX_LOCK;
+ }
+
+ out:
+ CTX_UNLOCK;
+ EGC_FREE;
+ return rc;
}
/*
diff --git a/tools/libxl/libxl_event.h b/tools/libxl/libxl_event.h
index a7e8240..dd6e6ed 100644
--- a/tools/libxl/libxl_event.h
+++ b/tools/libxl/libxl_event.h
@@ -18,6 +18,180 @@
#include <libxl.h>
+/*======================================================================*/
+
+/*
+ * Domain event handling - getting Xen events from libxl
+ *
+ * (Callers inside libxl may not call libxl_event_check or _wait.)
+ */
+
+#define LIBXL_EVENTMASK_ALL (~(unsigned long)0)
+
+typedef int libxl_event_predicate(const libxl_event*, void *user);
+ /* Return value is 0 if the event is unwanted or non-0 if it is.
+ * Predicates are not allowed to fail.
+ */
+
+int libxl_event_check(libxl_ctx *ctx, libxl_event **event_r,
+ unsigned long typemask,
+ libxl_event_predicate *predicate, void *predicate_user);
+ /* Searches for an event, already-happened, which matches typemask
+ * and predicate. predicate==0 matches any event.
+ * libxl_event_check returns the event, which must then later be
+ * freed by the caller using libxl_event_free.
+ *
+ * Returns ERROR_NOT_READY if no such event has happened.
+ */
+
+int libxl_event_wait(libxl_ctx *ctx, libxl_event **event_r,
+ unsigned long typemask,
+ libxl_event_predicate *predicate, void *predicate_user);
+ /* Like libxl_event_check but blocks if no suitable events are
+ * available, until some are. Uses libxl_osevent_beforepoll/
+ * _afterpoll so may be inefficient if very many domains are being
+ * handled by a single program.
+ */
+
+void libxl_event_free(libxl_ctx *ctx, libxl_event *event);
+
+
+/* Alternatively or additionally, the application may also use this: */
+
+typedef struct libxl_event_hooks {
+ uint64_t event_occurs_mask;
+ void (*event_occurs)(void *user, const libxl_event *event);
+ void (*disaster)(void *user, libxl_event_type type,
+ const char *msg, int errnoval);
+} libxl_event_hooks;
+
+void libxl_event_register_callbacks(libxl_ctx *ctx,
+ const libxl_event_hooks *hooks, void *user);
+ /*
+ * Arranges that libxl will henceforth call event_occurs for any
+ * events whose type is set in event_occurs_mask, rather than
+ * queueing the event for retrieval by libxl_event_check/wait.
+ * Events whose bit is clear in mask are not affected.
+ *
+ * event becomes owned by the application and must be freed, either
+ * by event_occurs or later.
+ *
+ * event_occurs may be NULL if mask is 0.
+ *
+ * libxl_event_register_callback also provides a way for libxl to
+ * report to the application that there was a problem reporting
+ * events; this can occur due to lack of host memory during event
+ * handling, or other wholly unrecoverable errors from system calls
+ * made by libxl. This will not happen for frivolous reasons - only
+ * if the system, or the Xen components of it, are badly broken.
+ *
+ * msg and errnoval will describe the action that libxl was trying
+ * to do, and type specifies the type of libxl events which may be
+ * missing. type may be 0 in which case events of all types may be
+ * missing.
+ *
+ * disaster may be NULL. If it is, or if _register_callbacks has
+ * not been called, errors of this kind are fatal to the entire
+ * application: libxl will print messages to its logs and to stderr
+ * and call exit(-1).
+ *
+ * If disaster returns, it may be the case that some or all future
+ * libxl calls will return errors; likewise it may be the case that
+ * no more events (of the specified type, if applicable) can be
+ * produced. An application which supplies a disaster function
+ * should normally react either by exiting, or by (when it has
+ * returned to its main event loop) shutting down libxl with
+ * libxl_ctx_free and perhaps trying to restart it with
+ * libxl_ctx_init.
+ *
+ * In any case before calling disaster, libxl will have logged a
+ * message with level XTL_CRITICAL.
+ *
+ * Reentrancy: it IS permitted to call libxl from within
+ * event_occurs. It is NOT permitted to call libxl from within
+ * disaster.
+ *
+ * libxl_event_register_callbacks may be called as many times, with
+ * different parameters, as the application likes; the most recent
+ * call determines the libxl behaviour. However it is NOT safe to
+ * call _register_callbacks concurrently with, or reentrantly from,
+ * any other libxl function.
+ *
+ * Calls to _register_callbacks do not affect events which have
+ * already occurred.
+ */
+
+
+/*
+ * Events are only generated if they have been requested.
+ * The following functions request the generation of specific events.
+ *
+ * Each set of functions for controlling event generation has this form:
+ *
+ * typedef struct libxl__evgen_FOO libxl__evgen_FOO;
+ * int libxl_evenable_FOO(libxl_ctx *ctx, FURTHER PARAMETERS,
+ * libxl_ev_user user, libxl__evgen_FOO **evgen_out);
+ * void libxl_evdisable_FOO(libxl_ctx *ctx, libxl__evgen_FOO *evgen);
+ *
+ * The evenable function arranges that the events (as described in the
+ * doc comment for the individual function) will start to be generated
+ * by libxl. On success, *evgen_out is set to a non-null pointer to
+ * an opaque struct.
+ *
+ * The user value is returned in the generated events and may be
+ * used by the caller for whatever it likes. The type ev_user is
+ * guaranteed to be an unsigned integer type which is at least
+ * as big as uint64_t and is also guaranteed to be big enough to
+ * contain any intptr_t value.
+ *
+ * If it becomes desirable to stop generation of the relevant events,
+ * or to reclaim the resources in libxl associated with the evgen
+ * structure, the same evgen value should be passed to the evdisable
+ * function. However, note that events which occurred prior to the
+ * evdisable call may still be returned.
+ *
+ * The caller may enable identical events more than once. If they do
+ * so, each actual occurrence will generate several events to be
+ * returned by libxl_event_check, with the appropriate user value(s).
+ * Aside from this, each occurrence of each event is returned by
+ * libxl_event_check exactly once.
+ *
+ * An evgen is associated with the libxl_ctx used for its creation.
+ * After libxl_ctx_free, all corresponding evgen handles become
+ * invalid and must no longer be passed to evdisable.
+ *
+ * Events enabled with evenable prior to a fork and libxl_ctx_postfork
+ * are no longer generated after the fork/postfork; however the evgen
+ * structures are still valid and must be passed to evdisable if the
+ * memory they use should not be leaked.
+ *
+ * Applications should ensure that they eventually retrieve every
+ * event using libxl_event_check or libxl_event_wait, since events
+ * which occur but are not retreived by the application will be queued
+ * inside libxl indefinitely. libxl_event_check/_wait may be O(n)
+ * where n is the number of queued events which do not match the
+ * criteria specified in the arguments to check/wait.
+ */
+
+typedef struct libxl__evgen_domain_death libxl_evgen_domain_death;
+int libxl_evenable_domain_death(libxl_ctx *ctx, uint32_t domid,
+ libxl_ev_user, libxl_evgen_domain_death **evgen_out);
+void libxl_evdisable_domain_death(libxl_ctx *ctx, libxl_evgen_domain_death*);
+ /* Arranges for the generation of DOMAIN_SHUTDOWN and DOMAIN_DESTROY
+ * events. A domain which is destroyed before it shuts down
+ * may generate only a DESTROY event.
+ */
+
+typedef struct libxl__evgen_disk_eject libxl_evgen_disk_eject;
+int libxl_evenable_disk_eject(libxl_ctx *ctx, uint32_t domid, const char *vdev,
+ libxl_ev_user, libxl_evgen_disk_eject **evgen_out);
+void libxl_evdisable_disk_eject(libxl_ctx *ctx, libxl_evgen_disk_eject*);
+ /* Arranges for the generation of DISK_EJECT events. A copy of the
+ * string *vdev will be made for libxl's internal use, and a pointer
+ * to this (or some other) copy will be returned as the vdev
+ * member of event.u.
+ */
+
/*======================================================================*/
@@ -36,10 +210,10 @@
* poll();
* libxl_osevent_afterpoll(...);
* for (;;) {
- * r=libxl_event_check(...);
- * if (r==LIBXL_NOT_READY) break;
- * if (r) handle failure;
- * do something with the event;
+ * r = libxl_event_check(...);
+ * if (r==LIBXL_NOT_READY) break;
+ * if (r) goto error_out;
+ * do something with the event;
* }
* }
*
@@ -175,6 +349,8 @@ void libxl_osevent_register_hooks(libxl_ctx *ctx,
* Of these we would normally recommend (a).
*
* The value *hooks is not copied and must outlast the libxl_ctx.
+ *
+ * The value of user is stored by libxl and passed to the callbacks.
*/
/* It is NOT legal to call _occurred_ reentrantly within any libxl
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index fdfcf9d..8cb6cdb 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -170,11 +170,45 @@ typedef struct libxl__ev_watch_slot {
libxl__ev_xswatch *libxl__watch_slot_contents(libxl__gc *gc, int slotnum);
+
+/*
+ * evgen structures, which are the state we use for generating
+ * events for the caller.
+ *
+ * In general in each case there's an internal and an external
+ * version of the _evdisable_FOO function; the internal one is
+ * used during cleanup.
+ */
+
+struct libxl__evgen_domain_death {
+ uint32_t domid;
+ unsigned shutdown_reported:1, death_reported:1;
+ LIBXL_TAILQ_ENTRY(libxl_evgen_domain_death) entry;
+ /* on list .death_reported ? CTX->death_list : CTX->death_reported */
+ libxl_ev_user user;
+};
+_hidden void
+libxl__evdisable_domain_death(libxl__gc*, libxl_evgen_domain_death*);
+
+struct libxl__evgen_disk_eject {
+ libxl__ev_xswatch watch;
+ uint32_t domid;
+ LIBXL_LIST_ENTRY(libxl_evgen_disk_eject) entry;
+ libxl_ev_user user;
+ char *vdev;
+};
+_hidden void
+libxl__evdisable_disk_eject(libxl__gc*, libxl_evgen_disk_eject*);
+
+
struct libxl__ctx {
xentoollog_logger *lg;
xc_interface *xch;
struct xs_handle *xsh;
+ const libxl_event_hooks *event_hooks;
+ void *event_hooks_user;
+
pthread_mutex_t lock; /* protects data structures hanging off the ctx */
/* Always use libxl__ctx_lock and _unlock (or the convenience
* macors CTX_LOCK and CTX_UNLOCK) to manipulate this.
@@ -188,12 +222,16 @@ struct libxl__ctx {
* documented in the libxl public interface.
*/
+ LIBXL_TAILQ_HEAD(libxl__event_list, libxl_event) occurred;
+
int osevent_in_hook;
const libxl_osevent_hooks *osevent_hooks;
void *osevent_user;
/* See the comment for OSEVENT_HOOK_INTERN in libxl_event.c
* for restrictions on the use of the osevent fields. */
+ struct pollfd *fd_polls;
+ int fd_polls_allocd;
int fd_rindex_allocd;
int *fd_rindex; /* see libxl_osevent_beforepoll */
LIBXL_LIST_HEAD(, libxl__ev_fd) efds;
@@ -205,6 +243,13 @@ struct libxl__ctx {
uint32_t watch_counter; /* helps disambiguate slot reuse */
libxl__ev_fd watch_efd;
+ LIBXL_TAILQ_HEAD(libxl__evgen_domain_death_list, libxl_evgen_domain_death)
+ death_list /* sorted by domid */,
+ death_reported;
+ libxl__ev_xswatch death_watch;
+
+ LIBXL_LIST_HEAD(, libxl_evgen_disk_eject) disk_eject_evgens;
+
/* for callers who reap children willy-nilly; caller must only
* set this after libxl_init and before any other call - or
* may leave them untouched */
@@ -245,6 +290,7 @@ struct libxl__gc {
struct libxl__egc {
/* for event-generating functions only */
struct libxl__gc gc;
+ struct libxl__event_list occurred_for_callback;
};
#define LIBXL_INIT_GC(gc,ctx) do{ \
@@ -383,6 +429,9 @@ _hidden char *libxl__xs_libxl_path(libxl__gc *gc, uint32_t domid);
*
* Callers of libxl__ev_KIND_register must ensure that the
* registration is undone, with _deregister, in libxl_ctx_free.
+ * This means that normally each kind of libxl__evgen (ie each
+ * application-requested event source) needs to be on a list so that
+ * it can be automatically deregistered as promised in libxl_event.h.
*/
@@ -426,6 +475,25 @@ static inline int libxl__ev_xswatch_isregistered(const libxl__ev_xswatch *xw)
+/*
+ * Other event-handling support provided by the libxl event core to
+ * the rest of libxl.
+ */
+
+_hidden void libxl__event_occurred(libxl__egc*, libxl_event *event);
+ /* Arranges to notify the application that the event has occurred.
+ * event should be suitable for passing to libxl_event_free. */
+
+_hidden libxl_event *libxl__event_new(libxl__egc*, libxl_event_type,
+ uint32_t domid);
+ /* Convenience function.
+ * Allocates a new libxl_event, fills in domid and type.
+ * If allocation fails, calls _disaster, and returns NULL. */
+
+#define NEW_EVENT(egc, type, domid) \
+ libxl__event_new((egc), LIBXL_EVENT_TYPE_##type, (domid));
+ /* Convenience macro. */
+
_hidden void libxl__event_disaster(libxl__egc*, const char *msg, int errnoval,
libxl_event_type type /* may be 0 */,
const char *file, int line,
@@ -438,6 +506,9 @@ _hidden void libxl__event_disaster(libxl__egc*, const char *msg, int errnoval,
* libxl__ev_FOO_callback or an application event), but are
* prevented from doing so due to eg lack of memory.
*
+ * See the "disaster" member of libxl_event_hooks and associated
+ * comment in libxl_event.h.
+ *
* NB that this function may return and the caller isn't supposed to
* then crash, although it may fail (and henceforth leave things in
* a state where many or all calls fail).
@@ -976,12 +1047,15 @@ libxl__device_model_version_running(libxl__gc *gc, uint32_t domid);
/* egc initialisation and destruction: */
-#define LIBXL_INIT_EGC(egc,ctx) do{ \
- LIBXL_INIT_GC((egc).gc,ctx); \
- /* list of occurred events tbd */ \
+#define LIBXL_INIT_EGC(egc,ctx) do{ \
+ LIBXL_INIT_GC((egc).gc,ctx); \
+ LIBXL_TAILQ_INIT(&(egc).occurred_for_callback); \
} while(0)
_hidden void libxl__egc_cleanup(libxl__egc *egc);
+ /* Frees memory allocated within this egc's gc, and and report all
+ * occurred events via callback, if applicable. May reenter the
+ * application; see restrictions above. */
/* convenience macros: */
@@ -1004,7 +1078,7 @@ _hidden void libxl__egc_cleanup(libxl__egc *egc);
*/
#define GC_INIT(ctx) libxl__gc gc[1]; LIBXL_INIT_GC(gc[0],ctx)
-#define GC_FREE libxl__gc_cleanup(gc)
+#define GC_FREE libxl__gc_cleanup(gc) /* MUST NOT CALL WITH CTX LOCKED */
#define CTX libxl__gc_owner(gc)
diff --git a/tools/libxl/libxl_types.idl b/tools/libxl/libxl_types.idl
index 78a1cc6..6728479 100644
--- a/tools/libxl/libxl_types.idl
+++ b/tools/libxl/libxl_types.idl
@@ -75,11 +75,6 @@ libxl_action_on_shutdown = Enumeration("action_on_shutdown", [
(6, "COREDUMP_RESTART"),
])
-libxl_event_type = Enumeration("event_type", [
- (1, "DOMAIN_DEATH"),
- (2, "DISK_EJECT"),
- ])
-
libxl_button = Enumeration("button", [
(1, "POWER"),
(2, "SLEEP"),
@@ -394,3 +389,32 @@ libxl_sched_sedf = Struct("sched_sedf", [
("extratime", integer),
("weight", integer),
], dispose_fn=None)
+
+libxl_event_type = Enumeration("event_type", [
+ (1, "DOMAIN_SHUTDOWN"),
+ (2, "DOMAIN_DESTROY"),
+ (3, "DISK_EJECT"),
+ ])
+
+libxl_ev_user = Number("libxl_ev_user")
+
+libxl_ev_link = Builtin("ev_link", passby=PASS_BY_REFERENCE, private=True)
+
+libxl_event = Struct("event",[
+ ("link", libxl_ev_link,0,
+ "for use by libxl; caller may use this once the event has been"
+ " returned by libxl_event_{check,wait}"),
+ ("domid", libxl_domid),
+ ("domuuid", libxl_uuid),
+ ("for_user", libxl_ev_user),
+ ("type", libxl_event_type),
+ ("u", KeyedUnion(None, libxl_event_type, "type",
+ [("domain_shutdown", Struct(None, [
+ ("shutdown_reason", uint8),
+ ])),
+ ("domain_destroy", Struct(None, [])),
+ ("disk_eject", Struct(None, [
+ ("vdev", string),
+ ("disk", libxl_device_disk),
+ ])),
+ ]))])
diff --git a/tools/libxl/xl_cmdimpl.c b/tools/libxl/xl_cmdimpl.c
index 8270f34..a18c6b2 100644
--- a/tools/libxl/xl_cmdimpl.c
+++ b/tools/libxl/xl_cmdimpl.c
@@ -1221,14 +1221,16 @@ skip_vfb:
xlu_cfg_destroy(config);
}
-/* Returns 1 if domain should be restarted, 2 if domain should be renamed then restarted */
-static int handle_domain_death(libxl_ctx *ctx, uint32_t domid, libxl_event *event,
- libxl_domain_config *d_config, libxl_dominfo *info)
+/* Returns 1 if domain should be restarted,
+ * 2 if domain should be renamed then restarted, or 0 */
+static int handle_domain_death(libxl_ctx *ctx, uint32_t domid,
+ libxl_event *event,
+ libxl_domain_config *d_config)
{
int restart = 0;
libxl_action_on_shutdown action;
- switch (info->shutdown_reason) {
+ switch (event->u.domain_shutdown.shutdown_reason) {
case SHUTDOWN_poweroff:
action = d_config->on_poweroff;
break;
@@ -1245,11 +1247,14 @@ static int handle_domain_death(libxl_ctx *ctx, uint32_t domid, libxl_event *even
action = d_config->on_watchdog;
break;
default:
- LOG("Unknown shutdown reason code %d. Destroying domain.", info->shutdown_reason);
+ LOG("Unknown shutdown reason code %d. Destroying domain.",
+ event->u.domain_shutdown.shutdown_reason);
action = LIBXL_ACTION_ON_SHUTDOWN_DESTROY;
}
- LOG("Action for shutdown reason code %d is %s", info->shutdown_reason, action_on_shutdown_names[action]);
+ LOG("Action for shutdown reason code %d is %s",
+ event->u.domain_shutdown.shutdown_reason,
+ action_on_shutdown_names[action]);
if (action == LIBXL_ACTION_ON_SHUTDOWN_COREDUMP_DESTROY || action == LIBXL_ACTION_ON_SHUTDOWN_COREDUMP_RESTART) {
char *corefile;
@@ -1314,7 +1319,7 @@ static void replace_string(char **str, const char *val)
static int preserve_domain(libxl_ctx *ctx, uint32_t domid, libxl_event *event,
- libxl_domain_config *d_config, libxl_dominfo *info)
+ libxl_domain_config *d_config)
{
time_t now;
struct tm tm;
@@ -1426,6 +1431,27 @@ static int autoconnect_console(libxl_ctx *ctx, uint32_t domid, void *priv)
_exit(1);
}
+static int domain_wait_event(libxl_event **event_r) {
+ int ret;
+ for (;;) {
+ ret = libxl_event_wait(ctx, event_r, LIBXL_EVENTMASK_ALL, 0,0);
+ if (ret) {
+ LOG("Domain %d, failed to get event, quitting (rc=%d)", domid, ret);
+ return ret;
+ }
+ if ((*event_r)->domid != domid) {
+ char *evstr = libxl_event_to_json(ctx, *event_r);
+ LOG("INTERNAL PROBLEM - ignoring unexpected event for"
+ " domain %d (expected %d): event=%s",
+ (*event_r)->domid, domid, evstr);
+ free(evstr);
+ libxl_event_free(ctx, *event_r);
+ continue;
+ }
+ return ret;
+ }
+}
+
static int create_domain(struct domain_create *dom_info)
{
libxl_domain_config d_config;
@@ -1439,10 +1465,11 @@ static int create_domain(struct domain_create *dom_info)
const char *restore_file = dom_info->restore_file;
int migrate_fd = dom_info->migrate_fd;
- int fd, i;
+ int i;
int need_daemon = daemonize;
int ret, rc;
- libxl_waiter *w1 = NULL, *w2 = NULL;
+ libxl_evgen_domain_death *deathw = NULL;
+ libxl_evgen_disk_eject **diskws = NULL; /* one per disk */
void *config_data = 0;
int config_len = 0;
int restore_fd = -1;
@@ -1651,14 +1678,14 @@ start:
if (errno != EINTR) {
perror("failed to wait for daemonizing child");
ret = ERROR_FAIL;
- goto error_out;
+ goto out;
}
}
if (status) {
libxl_report_child_exitstatus(ctx, XTL_ERROR,
"daemonizing child", child1, status);
ret = ERROR_FAIL;
- goto error_out;
+ goto out;
}
ret = domid;
goto out;
@@ -1695,92 +1722,106 @@ start:
}
LOG("Waiting for domain %s (domid %d) to die [pid %ld]",
d_config.c_info.name, domid, (long)getpid());
- w1 = (libxl_waiter*) xmalloc(sizeof(libxl_waiter) * d_config.num_disks);
- w2 = (libxl_waiter*) xmalloc(sizeof(libxl_waiter));
- libxl_wait_for_disk_ejects(ctx, domid, d_config.disks, d_config.num_disks, w1);
- libxl_wait_for_domain_death(ctx, domid, w2);
- libxl_get_wait_fd(ctx, &fd);
- while (1) {
- int ret;
- fd_set rfds;
- libxl_dominfo info;
- libxl_event event;
- libxl_device_disk disk;
- FD_ZERO(&rfds);
- FD_SET(fd, &rfds);
+ ret = libxl_evenable_domain_death(ctx, domid, 0, &deathw);
+ if (ret) goto out;
- ret = select(fd + 1, &rfds, NULL, NULL, NULL);
- if (!ret)
- continue;
- libxl_get_event(ctx, &event);
- switch (event.type) {
- case LIBXL_EVENT_TYPE_DOMAIN_DEATH:
- ret = libxl_event_get_domain_death_info(ctx, domid, &event, &info);
-
- if (ret < 0) {
- libxl_free_event(&event);
- continue;
+ if (!diskws) {
+ diskws = xmalloc(sizeof(*diskws) * d_config.num_disks);
+ for (i = 0; i < d_config.num_disks; i++)
+ diskws[i] = NULL;
+ }
+ for (i = 0; i < d_config.num_disks; i++) {
+ ret = libxl_evenable_disk_eject(ctx, domid, d_config.disks[i].vdev,
+ 0, &diskws[i]);
+ if (ret) goto out;
+ }
+ while (1) {
+ libxl_event *event;
+ ret = domain_wait_event(&event);
+ if (ret) goto out;
+
+ switch (event->type) {
+
+ case LIBXL_EVENT_TYPE_DOMAIN_SHUTDOWN:
+ LOG("Domain %d has shut down, reason code %d 0x%x", domid,
+ event->u.domain_shutdown.shutdown_reason,
+ event->u.domain_shutdown.shutdown_reason);
+ switch (handle_domain_death(ctx, domid, event, &d_config)) {
+ case 2:
+ if (!preserve_domain(ctx, domid, event, &d_config)) {
+ /* If we fail then exit leaving the old domain in place. */
+ ret = -1;
+ goto out;
}
- LOG("Domain %d is dead", domid);
-
- if (ret) {
- switch (handle_domain_death(ctx, domid, &event, &d_config, &info)) {
- case 2:
- if (!preserve_domain(ctx, domid, &event, &d_config, &info)) {
- /* If we fail then exit leaving the old domain in place. */
- ret = -1;
- goto out;
- }
-
- /* Otherwise fall through and restart. */
- case 1:
-
- for (i = 0; i < d_config.num_disks; i++)
- libxl_free_waiter(&w1[i]);
- libxl_free_waiter(w2);
- free(w1);
- free(w2);
-
- /*
- * Do not attempt to reconnect if we come round again due to a
- * guest reboot -- the stdin/out will be disconnected by then.
- */
- dom_info->console_autoconnect = 0;
-
- /* Some settings only make sense on first boot. */
- paused = 0;
- if (common_domname
- && strcmp(d_config.c_info.name, common_domname)) {
- d_config.c_info.name = strdup(common_domname);
- }
-
- /*
- * XXX FIXME: If this sleep is not there then domain
- * re-creation fails sometimes.
- */
- LOG("Done. Rebooting now");
- sleep(2);
- goto start;
- case 0:
- LOG("Done. Exiting now");
- ret = 0;
- goto out;
- }
- } else {
- LOG("Unable to get domain death info, quitting");
- goto out;
+ /* Otherwise fall through and restart. */
+ case 1:
+ libxl_event_free(ctx, event);
+ libxl_evdisable_domain_death(ctx, deathw);
+ deathw = NULL;
+ for (i = 0; i < d_config.num_disks; i++) {
+ libxl_evdisable_disk_eject(ctx, diskws[i]);
+ diskws[i] = NULL;
}
- break;
- case LIBXL_EVENT_TYPE_DISK_EJECT:
- if (libxl_event_get_disk_eject_info(ctx, domid, &event, &disk)) {
- libxl_cdrom_insert(ctx, domid, &disk);
- libxl_device_disk_dispose(&disk);
+ /* discard any other events which may have been generated */
+ while (!(ret = libxl_event_check(ctx, &event,
+ LIBXL_EVENTMASK_ALL, 0,0))) {
+ libxl_event_free(ctx, event);
}
- break;
+ if (ret != ERROR_NOT_READY) {
+ LOG("warning, libxl_event_check (cleanup) failed (rc=%d)",
+ ret);
+ }
+
+ /*
+ * Do not attempt to reconnect if we come round again due to a
+ * guest reboot -- the stdin/out will be disconnected by then.
+ */
+ dom_info->console_autoconnect = 0;
+
+ /* Some settings only make sense on first boot. */
+ paused = 0;
+ if (common_domname
+ && strcmp(d_config.c_info.name, common_domname)) {
+ d_config.c_info.name = strdup(common_domname);
+ }
+
+ /*
+ * XXX FIXME: If this sleep is not there then domain
+ * re-creation fails sometimes.
+ */
+ LOG("Done. Rebooting now");
+ sleep(2);
+ goto start;
+
+ case 0:
+ LOG("Done. Exiting now");
+ ret = 0;
+ goto out;
+
+ default:
+ abort();
+ }
+
+ case LIBXL_EVENT_TYPE_DOMAIN_DESTROY:
+ LOG("Domain %d has been destroyed.", domid);
+ ret = 0;
+ goto out;
+
+ case LIBXL_EVENT_TYPE_DISK_EJECT:
+ /* XXX what is this for? */
+ libxl_cdrom_insert(ctx, domid, &event->u.disk_eject.disk);
+ break;
+
+ default:;
+ char *evstr = libxl_event_to_json(ctx, event);
+ LOG("warning, got unexpected event type %d, event=%s",
+ event->type, evstr);
+ free(evstr);
}
- libxl_free_event(&event);
+
+ libxl_event_free(ctx, event);
}
error_out:
@@ -2263,6 +2304,7 @@ static void destroy_domain(const char *p)
static void shutdown_domain(const char *p, int wait)
{
int rc;
+ libxl_event *event;
find_domain(p);
rc=libxl_domain_shutdown(ctx, domid);
@@ -2277,37 +2319,39 @@ static void shutdown_domain(const char *p, int wait)
}
if (wait) {
- libxl_waiter waiter;
- int fd;
-
- libxl_wait_for_domain_death(ctx, domid, &waiter);
+ libxl_evgen_domain_death *deathw;
- libxl_get_wait_fd(ctx, &fd);
-
- while (wait) {
- fd_set rfds;
- libxl_event event;
- libxl_dominfo info;
+ rc = libxl_evenable_domain_death(ctx, domid, 0, &deathw);
+ if (rc) {
+ fprintf(stderr,"wait for death failed (evgen, rc=%d)\n",rc);
+ exit(-1);
+ }
- FD_ZERO(&rfds);
- FD_SET(fd, &rfds);
+ for (;;) {
+ rc = domain_wait_event(&event);
+ if (rc) exit(-1);
- if (!select(fd + 1, &rfds, NULL, NULL, NULL))
- continue;
+ switch (event->type) {
- libxl_get_event(ctx, &event);
+ case LIBXL_EVENT_TYPE_DOMAIN_DESTROY:
+ LOG("Domain %d has been destroyed", domid);
+ goto done;
- if (event.type == LIBXL_EVENT_TYPE_DOMAIN_DEATH) {
- if (libxl_event_get_domain_death_info(ctx, domid, &event, &info) < 0)
- continue;
+ case LIBXL_EVENT_TYPE_DOMAIN_SHUTDOWN:
+ LOG("Domain %d has been shut down, reason code %d %x", domid,
+ event->u.domain_shutdown.shutdown_reason,
+ event->u.domain_shutdown.shutdown_reason);
+ goto done;
- LOG("Domain %d is dead", domid);
- wait = 0;
+ default:
+ LOG("Unexpected event type %d", event->type);
+ break;
}
-
- libxl_free_event(&event);
+ libxl_event_free(ctx, event);
}
- libxl_free_waiter(&waiter);
+ done:
+ libxl_event_free(ctx, event);
+ libxl_evdisable_domain_death(ctx, deathw);
}
}
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* Re: [PATCH 08/10] libxl: New event generation API
2012-01-06 20:35 ` [PATCH 08/10] libxl: New event generation API Ian Jackson
@ 2012-01-13 15:22 ` Ian Campbell
2012-01-13 15:49 ` Ian Jackson
0 siblings, 1 reply; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 15:22 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-06 at 20:35 +0000, Ian Jackson wrote:
> Replace the existing API for retrieving high-level events (events
> about domains, etc.) from libxl with a new one.
>
> This changes the definition and semantics of the `libxl_event'
> structure, and replaces the calls for obtaining information about
> domain death and disk eject events.
>
> This is an incompatible change, sorry. The alternative was to try to
> provide both the previous horrid API and the new one, and would also
> involve never using the name `libxl_event' for the new interface.
>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
I think I've seen most of this before too so again I only skimmed it.
Nothing much jumped out but I must admit I'm suffering from Friday
afternoon review fatigue...
> diff --git a/tools/libxl/libxl_types.idl b/tools/libxl/libxl_types.idl
> index 78a1cc6..6728479 100644
> --- a/tools/libxl/libxl_types.idl
> +++ b/tools/libxl/libxl_types.idl
> @@ -75,11 +75,6 @@ libxl_action_on_shutdown = Enumeration("action_on_shutdown", [
> (6, "COREDUMP_RESTART"),
> ])
>
> -libxl_event_type = Enumeration("event_type", [
> - (1, "DOMAIN_DEATH"),
> - (2, "DISK_EJECT"),
> - ])
> -
> libxl_button = Enumeration("button", [
> (1, "POWER"),
> (2, "SLEEP"),
> @@ -394,3 +389,32 @@ libxl_sched_sedf = Struct("sched_sedf", [
> ("extratime", integer),
> ("weight", integer),
> ], dispose_fn=None)
> +
> +libxl_event_type = Enumeration("event_type", [
> + (1, "DOMAIN_SHUTDOWN"),
> + (2, "DOMAIN_DESTROY"),
> + (3, "DISK_EJECT"),
> + ])
> +
> +libxl_ev_user = Number("libxl_ev_user")
This doesn't turn into libxl_libxl_ev_user in the code, does it?
No, I checked, It's right, Good ;-)
> +
> +libxl_ev_link = Builtin("ev_link", passby=PASS_BY_REFERENCE, private=True)
> +
> +libxl_event = Struct("event",[
> + ("link", libxl_ev_link,0,
> + "for use by libxl; caller may use this once the event has been"
> + " returned by libxl_event_{check,wait}"),
I've got a pending patch which does away with comments in the IDL syntax
in favour of source level comments (e.g. "# for use by...."). I don't
think anyone reads the comments in generated code in preference to the
comments in the IDL source...
Either we race here or you can just go straight for the source level
comments.
> + ("domid", libxl_domid),
> + ("domuuid", libxl_uuid),
> + ("for_user", libxl_ev_user),
> + ("type", libxl_event_type),
> + ("u", KeyedUnion(None, libxl_event_type, "type",
> + [("domain_shutdown", Struct(None, [
> + ("shutdown_reason", uint8),
> + ])),
> + ("domain_destroy", Struct(None, [])),
> + ("disk_eject", Struct(None, [
> + ("vdev", string),
> + ("disk", libxl_device_disk),
> + ])),
> + ]))])
> diff --git a/tools/libxl/xl_cmdimpl.c b/tools/libxl/xl_cmdimpl.c
> index 8270f34..a18c6b2 100644
> --- a/tools/libxl/xl_cmdimpl.c
> +++ b/tools/libxl/xl_cmdimpl.c
[...]
> + case LIBXL_EVENT_TYPE_DISK_EJECT:
> + /* XXX what is this for? */
This is signalled by qemu when the guest opens the CD-ROM drive.
(not sure if this is your comment or an existing one which got
reindented.)
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 08/10] libxl: New event generation API
2012-01-13 15:22 ` Ian Campbell
@ 2012-01-13 15:49 ` Ian Jackson
0 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-13 15:49 UTC (permalink / raw)
To: Ian Campbell; +Cc: xen-devel@lists.xensource.com
Ian Campbell writes ("Re: [Xen-devel] [PATCH 08/10] libxl: New event generation API"):
> I think I've seen most of this before too so again I only skimmed it.
> Nothing much jumped out but I must admit I'm suffering from Friday
> afternoon review fatigue...
Heh.
> On Fri, 2012-01-06 at 20:35 +0000, Ian Jackson wrote:
> > diff --git a/tools/libxl/libxl_types.idl b/tools/libxl/libxl_types.idl
> > index 78a1cc6..6728479 100644
...
> > +libxl_event_type = Enumeration("event_type", [
> > + (1, "DOMAIN_SHUTDOWN"),
> > + (2, "DOMAIN_DESTROY"),
> > + (3, "DISK_EJECT"),
> > + ])
> > +
> > +libxl_ev_user = Number("libxl_ev_user")
>
> This doesn't turn into libxl_libxl_ev_user in the code, does it?
>
> No, I checked, It's right, Good ;-)
In fact to make the ocaml binding work it is necessary to write this
as
libxl_ev_user = UInt(64);
but we can keep the typedef. This is because the ocaml idl generator
wants to know the size of the integer. I think this is not an
unreasonable requirement so I will keep that change even though I'm
about to disable the generation of an ocaml binding for libxl_event
for other reasons (mainly, the lack of KeyedUnion).
> > +libxl_ev_link = Builtin("ev_link", passby=PASS_BY_REFERENCE, private=True)
> > +
> > +libxl_event = Struct("event",[
> > + ("link", libxl_ev_link,0,
> > + "for use by libxl; caller may use this once the event has been"
> > + " returned by libxl_event_{check,wait}"),
>
> I've got a pending patch which does away with comments in the IDL syntax
> in favour of source level comments (e.g. "# for use by...."). I don't
> think anyone reads the comments in generated code in preference to the
> comments in the IDL source...
>
> Either we race here or you can just go straight for the source level
> comments.
I'll do the latter.
> > diff --git a/tools/libxl/xl_cmdimpl.c b/tools/libxl/xl_cmdimpl.c
> > index 8270f34..a18c6b2 100644
> > --- a/tools/libxl/xl_cmdimpl.c
> > +++ b/tools/libxl/xl_cmdimpl.c
> [...]
> > + case LIBXL_EVENT_TYPE_DISK_EJECT:
> > + /* XXX what is this for? */
>
> This is signalled by qemu when the guest opens the CD-ROM drive.
>
> (not sure if this is your comment or an existing one which got
> reindented.)
It's an existing comment, which I didn't feel confident to remove.
I guess if we're happy with all the code here I could delete it.
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread
* [PATCH 09/10] libxl: introduce libxl_fd_set_nonblock, rationalise _cloexec
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (7 preceding siblings ...)
2012-01-06 20:35 ` [PATCH 08/10] libxl: New event generation API Ian Jackson
@ 2012-01-06 20:35 ` Ian Jackson
2012-01-13 10:45 ` Ian Campbell
2012-01-06 20:35 ` [PATCH 10/10] libxl: Permit multithreaded event waiting Ian Jackson
` (6 subsequent siblings)
15 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-06 20:35 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
We want a function for setting fds to nonblocking, so introduce one.
This is a very similar requirement to that for libxl_fd_set_cloexec,
so make it common with that.
While we're at it, fix a few deficiences that make this latter
function less desirable than it could be:
* Change the return from 0/-1 (like a syscall) to a libxl error code
* Take a boolean parameter for turning the flag on and off
* Log on error (and so, take a ctx for this purpose)
Change callers of libxl_fd_set_cloexec to notice errors. (Although,
such errors are highly unlikely.)
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl.c | 33 ++++++++++++++++++++++++++-------
tools/libxl/libxl.h | 6 +++++-
tools/libxl/libxl_qmp.c | 3 ++-
tools/libxl/xl_cmdimpl.c | 3 ++-
4 files changed, 35 insertions(+), 10 deletions(-)
diff --git a/tools/libxl/libxl.c b/tools/libxl/libxl.c
index f6370d4..42b64d8 100644
--- a/tools/libxl/libxl.c
+++ b/tools/libxl/libxl.c
@@ -3647,19 +3647,38 @@ int libxl_cpupool_movedomain(libxl_ctx *ctx, uint32_t poolid, uint32_t domid)
return 0;
}
-int libxl_fd_set_cloexec(int fd)
+static int fd_set_flags(libxl_ctx *ctx, int fd,
+ int fcntlgetop, int fcntlsetop, const char *fl,
+ int flagmask, int set_p)
{
- int flags = 0;
+ int flags, r;
- if ((flags = fcntl(fd, F_GETFD)) == -1) {
- flags = 0;
+ flags = fcntl(fd, fcntlgetop);
+ if (flags == -1) {
+ LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "fcntl(,F_GET%s) failed",fl);
+ return ERROR_FAIL;
}
- if ((flags & FD_CLOEXEC)) {
- return 0;
+
+ if (set_p)
+ flags |= flagmask;
+ else
+ flags &= ~flagmask;
+
+ r = fcntl(fd, fcntlsetop, flags);
+ if (r == -1) {
+ LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "fcntl(,F_SET%s) failed",fl);
+ return ERROR_FAIL;
}
- return fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
+
+ return 0;
}
+int libxl_fd_set_cloexec(libxl_ctx *ctx, int fd, int cloexec)
+ { return fd_set_flags(ctx,fd, F_GETFD,F_SETFD,"FD", FD_CLOEXEC, cloexec); }
+
+int libxl_fd_set_nonblock(libxl_ctx *ctx, int fd, int nonblock)
+ { return fd_set_flags(ctx,fd, F_GETFL,F_SETFL,"FL", O_NONBLOCK, nonblock); }
+
/*
* Local variables:
* mode: C
diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h
index 97ca25e..5396ba8 100644
--- a/tools/libxl/libxl.h
+++ b/tools/libxl/libxl.h
@@ -613,7 +613,11 @@ const char *libxl_run_dir_path(void);
const char *libxl_xenpaging_dir_path(void);
/* misc */
-int libxl_fd_set_cloexec(int fd);
+int libxl_fd_set_cloexec(libxl_ctx *ctx, int fd, int cloexec);
+int libxl_fd_set_nonblock(libxl_ctx *ctx, int fd, int nonblock);
+ /* Each of these sets or clears the flag according to whether the
+ * 2nd parameter is nonzero. On failure, they log, and
+ * return ERROR_FAIL, but also leave errno valid. */
#include <libxl_event.h>
diff --git a/tools/libxl/libxl_qmp.c b/tools/libxl/libxl_qmp.c
index 58f5283..05df4d7 100644
--- a/tools/libxl/libxl_qmp.c
+++ b/tools/libxl/libxl_qmp.c
@@ -324,7 +324,8 @@ static int qmp_open(libxl__qmp_handler *qmp, const char *qmp_socket_path,
if (fcntl(qmp->qmp_fd, F_SETFL, flags | O_NONBLOCK) == -1) {
return -1;
}
- libxl_fd_set_cloexec(qmp->qmp_fd);
+ ret = libxl_fd_set_cloexec(qmp->ctx, qmp->qmp_fd, 1);
+ if (ret) return -1;
memset(&qmp->addr, 0, sizeof (&qmp->addr));
qmp->addr.sun_family = AF_UNIX;
diff --git a/tools/libxl/xl_cmdimpl.c b/tools/libxl/xl_cmdimpl.c
index a18c6b2..b88fc8a 100644
--- a/tools/libxl/xl_cmdimpl.c
+++ b/tools/libxl/xl_cmdimpl.c
@@ -1490,7 +1490,8 @@ static int create_domain(struct domain_create *dom_info)
restore_fd = migrate_fd;
} else {
restore_fd = open(restore_file, O_RDONLY);
- libxl_fd_set_cloexec(restore_fd);
+ rc = libxl_fd_set_cloexec(ctx, restore_fd, 1);
+ if (rc) return rc;
}
CHK_ERRNO( libxl_read_exactly(ctx, restore_fd, &hdr,
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* Re: [PATCH 09/10] libxl: introduce libxl_fd_set_nonblock, rationalise _cloexec
2012-01-06 20:35 ` [PATCH 09/10] libxl: introduce libxl_fd_set_nonblock, rationalise _cloexec Ian Jackson
@ 2012-01-13 10:45 ` Ian Campbell
2012-01-13 15:54 ` Ian Jackson
0 siblings, 1 reply; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 10:45 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-06 at 20:35 +0000, Ian Jackson wrote:
> We want a function for setting fds to nonblocking, so introduce one.
>
> This is a very similar requirement to that for libxl_fd_set_cloexec,
> so make it common with that.
>
> While we're at it, fix a few deficiences that make this latter
> function less desirable than it could be:
> * Change the return from 0/-1 (like a syscall) to a libxl error code
> * Take a boolean parameter for turning the flag on and off
> * Log on error (and so, take a ctx for this purpose)
>
> Change callers of libxl_fd_set_cloexec to notice errors. (Although,
> such errors are highly unlikely.)
>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
(although I notice that you've slipped back into the
comment-follows-prototype style...)
> ---
> tools/libxl/libxl.c | 33 ++++++++++++++++++++++++++-------
> tools/libxl/libxl.h | 6 +++++-
> tools/libxl/libxl_qmp.c | 3 ++-
> tools/libxl/xl_cmdimpl.c | 3 ++-
> 4 files changed, 35 insertions(+), 10 deletions(-)
>
> diff --git a/tools/libxl/libxl.c b/tools/libxl/libxl.c
> index f6370d4..42b64d8 100644
> --- a/tools/libxl/libxl.c
> +++ b/tools/libxl/libxl.c
> @@ -3647,19 +3647,38 @@ int libxl_cpupool_movedomain(libxl_ctx *ctx, uint32_t poolid, uint32_t domid)
> return 0;
> }
>
> -int libxl_fd_set_cloexec(int fd)
> +static int fd_set_flags(libxl_ctx *ctx, int fd,
> + int fcntlgetop, int fcntlsetop, const char *fl,
> + int flagmask, int set_p)
> {
> - int flags = 0;
> + int flags, r;
>
> - if ((flags = fcntl(fd, F_GETFD)) == -1) {
> - flags = 0;
> + flags = fcntl(fd, fcntlgetop);
> + if (flags == -1) {
> + LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "fcntl(,F_GET%s) failed",fl);
> + return ERROR_FAIL;
> }
> - if ((flags & FD_CLOEXEC)) {
> - return 0;
> +
> + if (set_p)
> + flags |= flagmask;
> + else
> + flags &= ~flagmask;
> +
> + r = fcntl(fd, fcntlsetop, flags);
> + if (r == -1) {
> + LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "fcntl(,F_SET%s) failed",fl);
> + return ERROR_FAIL;
> }
> - return fcntl(fd, F_SETFD, flags | FD_CLOEXEC);
> +
> + return 0;
> }
>
> +int libxl_fd_set_cloexec(libxl_ctx *ctx, int fd, int cloexec)
> + { return fd_set_flags(ctx,fd, F_GETFD,F_SETFD,"FD", FD_CLOEXEC, cloexec); }
> +
> +int libxl_fd_set_nonblock(libxl_ctx *ctx, int fd, int nonblock)
> + { return fd_set_flags(ctx,fd, F_GETFL,F_SETFL,"FL", O_NONBLOCK, nonblock); }
> +
> /*
> * Local variables:
> * mode: C
> diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h
> index 97ca25e..5396ba8 100644
> --- a/tools/libxl/libxl.h
> +++ b/tools/libxl/libxl.h
> @@ -613,7 +613,11 @@ const char *libxl_run_dir_path(void);
> const char *libxl_xenpaging_dir_path(void);
>
> /* misc */
> -int libxl_fd_set_cloexec(int fd);
> +int libxl_fd_set_cloexec(libxl_ctx *ctx, int fd, int cloexec);
> +int libxl_fd_set_nonblock(libxl_ctx *ctx, int fd, int nonblock);
> + /* Each of these sets or clears the flag according to whether the
> + * 2nd parameter is nonzero. On failure, they log, and
> + * return ERROR_FAIL, but also leave errno valid. */
>
> #include <libxl_event.h>
>
> diff --git a/tools/libxl/libxl_qmp.c b/tools/libxl/libxl_qmp.c
> index 58f5283..05df4d7 100644
> --- a/tools/libxl/libxl_qmp.c
> +++ b/tools/libxl/libxl_qmp.c
> @@ -324,7 +324,8 @@ static int qmp_open(libxl__qmp_handler *qmp, const char *qmp_socket_path,
> if (fcntl(qmp->qmp_fd, F_SETFL, flags | O_NONBLOCK) == -1) {
> return -1;
> }
> - libxl_fd_set_cloexec(qmp->qmp_fd);
> + ret = libxl_fd_set_cloexec(qmp->ctx, qmp->qmp_fd, 1);
> + if (ret) return -1;
>
> memset(&qmp->addr, 0, sizeof (&qmp->addr));
> qmp->addr.sun_family = AF_UNIX;
> diff --git a/tools/libxl/xl_cmdimpl.c b/tools/libxl/xl_cmdimpl.c
> index a18c6b2..b88fc8a 100644
> --- a/tools/libxl/xl_cmdimpl.c
> +++ b/tools/libxl/xl_cmdimpl.c
> @@ -1490,7 +1490,8 @@ static int create_domain(struct domain_create *dom_info)
> restore_fd = migrate_fd;
> } else {
> restore_fd = open(restore_file, O_RDONLY);
> - libxl_fd_set_cloexec(restore_fd);
> + rc = libxl_fd_set_cloexec(ctx, restore_fd, 1);
> + if (rc) return rc;
> }
>
> CHK_ERRNO( libxl_read_exactly(ctx, restore_fd, &hdr,
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 09/10] libxl: introduce libxl_fd_set_nonblock, rationalise _cloexec
2012-01-13 10:45 ` Ian Campbell
@ 2012-01-13 15:54 ` Ian Jackson
0 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-13 15:54 UTC (permalink / raw)
To: Ian Campbell; +Cc: xen-devel@lists.xensource.com
Ian Campbell writes ("Re: [Xen-devel] [PATCH 09/10] libxl: introduce libxl_fd_set_nonblock, rationalise _cloexec"):
> On Fri, 2012-01-06 at 20:35 +0000, Ian Jackson wrote:
> > We want a function for setting fds to nonblocking, so introduce one.
...
> (although I notice that you've slipped back into the
> comment-follows-prototype style...)
Fixed.
(I still think it's ridiculous.)
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread
* [PATCH 10/10] libxl: Permit multithreaded event waiting
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (8 preceding siblings ...)
2012-01-06 20:35 ` [PATCH 09/10] libxl: introduce libxl_fd_set_nonblock, rationalise _cloexec Ian Jackson
@ 2012-01-06 20:35 ` Ian Jackson
2012-01-09 17:34 ` [PATCH RFC v6.1 11-14/10] libxl: asynchronous operations Ian Jackson
` (5 subsequent siblings)
15 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-06 20:35 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
Previously, the context would be locked whenever we were waiting in
libxl's own call to poll (waiting for operating system events).
This would mean that multiple simultaneous calls to libxl_event_wait
in different threads with different parameters would not work
properly.
If we simply unlock the context, it would be possible for another
thread to discover the occurrence of the event we were waiting for,
without us even waking up, and we would remain in poll. So we need a
way to wake up other threads: a pipe, one for each thread in poll.
We also need to move some variables from globals in the ctx to be
per-polling-thread.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl.c | 18 +++-
tools/libxl/libxl_event.c | 196 ++++++++++++++++++++++++++++++++++--------
tools/libxl/libxl_internal.h | 51 ++++++++++-
3 files changed, 219 insertions(+), 46 deletions(-)
diff --git a/tools/libxl/libxl.c b/tools/libxl/libxl.c
index 42b64d8..b8167b3 100644
--- a/tools/libxl/libxl.c
+++ b/tools/libxl/libxl.c
@@ -49,8 +49,9 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
ctx->osevent_hooks = 0;
- ctx->fd_polls = 0;
- ctx->fd_rindex = 0;
+ LIBXL_LIST_INIT(&ctx->pollers_event);
+ LIBXL_LIST_INIT(&ctx->pollers_idle);
+
LIBXL_LIST_INIT(&ctx->efds);
LIBXL_TAILQ_INIT(&ctx->etimes);
@@ -61,6 +62,9 @@ int libxl_ctx_alloc(libxl_ctx **pctx, int version,
LIBXL_TAILQ_INIT(&ctx->death_list);
libxl__ev_xswatch_init(&ctx->death_watch);
+ rc = libxl__poller_init(ctx, &ctx->poller_app);
+ if (rc) goto out;
+
if ( stat(XENSTORE_PID_FILE, &stat_buf) != 0 ) {
LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "Is xenstore daemon running?\n"
"failed to stat %s", XENSTORE_PID_FILE);
@@ -135,8 +139,14 @@ int libxl_ctx_free(libxl_ctx *ctx)
libxl_version_info_dispose(&ctx->version_info);
if (ctx->xsh) xs_daemon_close(ctx->xsh);
- free(ctx->fd_polls);
- free(ctx->fd_rindex);
+ libxl__poller_dispose(&ctx->poller_app);
+ assert(LIBXL_LIST_EMPTY(&ctx->pollers_event));
+ libxl__poller *poller, *poller_tmp;
+ LIBXL_LIST_FOREACH_SAFE(poller, &ctx->pollers_idle, entry, poller_tmp) {
+ libxl__poller_dispose(poller);
+ free(poller);
+ }
+
free(ctx->watch_slots);
discard_events(&ctx->occurred);
diff --git a/tools/libxl/libxl_event.c b/tools/libxl/libxl_event.c
index c42b565..704e734 100644
--- a/tools/libxl/libxl_event.c
+++ b/tools/libxl/libxl_event.c
@@ -509,9 +509,9 @@ void libxl__ev_xswatch_deregister(libxl__gc *gc, libxl__ev_xswatch *w)
* osevent poll
*/
-static int beforepoll_internal(libxl__gc *gc, int *nfds_io,
- struct pollfd *fds, int *timeout_upd,
- struct timeval now)
+static int beforepoll_internal(libxl__gc *gc, libxl__poller *poller,
+ int *nfds_io, struct pollfd *fds,
+ int *timeout_upd, struct timeval now)
{
libxl__ev_fd *efd;
int rc;
@@ -533,7 +533,7 @@ static int beforepoll_internal(libxl__gc *gc, int *nfds_io,
* not to mess with fd_rindex.
*/
- int maxfd = 0;
+ int maxfd = poller->wakeup_pipe[0] + 1;
LIBXL_LIST_FOREACH(efd, &CTX->efds, entry) {
if (!efd->events)
continue;
@@ -541,30 +541,39 @@ static int beforepoll_internal(libxl__gc *gc, int *nfds_io,
maxfd = efd->fd + 1;
}
/* make sure our array is as big as *nfds_io */
- if (CTX->fd_rindex_allocd < maxfd) {
+ if (poller->fd_rindex_allocd < maxfd) {
assert(maxfd < INT_MAX / sizeof(int) / 2);
- int *newarray = realloc(CTX->fd_rindex, sizeof(int) * maxfd);
+ int *newarray = realloc(poller->fd_rindex, sizeof(int) * maxfd);
if (!newarray) { rc = ERROR_NOMEM; goto out; }
- memset(newarray + CTX->fd_rindex_allocd, 0,
- sizeof(int) * (maxfd - CTX->fd_rindex_allocd));
- CTX->fd_rindex = newarray;
- CTX->fd_rindex_allocd = maxfd;
+ memset(newarray + poller->fd_rindex_allocd, 0,
+ sizeof(int) * (maxfd - poller->fd_rindex_allocd));
+ poller->fd_rindex = newarray;
+ poller->fd_rindex_allocd = maxfd;
}
}
int used = 0;
- LIBXL_LIST_FOREACH(efd, &CTX->efds, entry) {
- if (!efd->events)
- continue;
- if (used < *nfds_io) {
- fds[used].fd = efd->fd;
- fds[used].events = efd->events;
- fds[used].revents = 0;
- assert(efd->fd < CTX->fd_rindex_allocd);
- CTX->fd_rindex[efd->fd] = used;
- }
- used++;
- }
+
+#define REQUIRE_FD(req_fd, req_events, efd) do{ \
+ if ((req_events)) { \
+ if (used < *nfds_io) { \
+ fds[used].fd = (req_fd); \
+ fds[used].events = (req_events); \
+ fds[used].revents = 0; \
+ assert((req_fd) < poller->fd_rindex_allocd); \
+ poller->fd_rindex[(req_fd)] = used; \
+ } \
+ used++; \
+ } \
+ }while(0)
+
+ LIBXL_LIST_FOREACH(efd, &CTX->efds, entry)
+ REQUIRE_FD(efd->fd, efd->events, efd);
+
+ REQUIRE_FD(poller->wakeup_pipe[0], POLLIN, 0);
+
+#undef REQUIRE_FD
+
rc = used <= *nfds_io ? 0 : ERROR_BUFFERFULL;
*nfds_io = used;
@@ -598,22 +607,23 @@ int libxl_osevent_beforepoll(libxl_ctx *ctx, int *nfds_io,
{
EGC_INIT(ctx);
CTX_LOCK;
- int rc = beforepoll_internal(gc, nfds_io, fds, timeout_upd, now);
+ int rc = beforepoll_internal(gc, &ctx->poller_app,
+ nfds_io, fds, timeout_upd, now);
CTX_UNLOCK;
EGC_FREE;
return rc;
}
-static int afterpoll_check_fd(libxl_ctx *ctx,
+static int afterpoll_check_fd(libxl__poller *poller,
const struct pollfd *fds, int nfds,
int fd, int events)
/* returns mask of events which were requested and occurred */
{
- if (fd >= ctx->fd_rindex_allocd)
+ if (fd >= poller->fd_rindex_allocd)
/* added after we went into poll, have to try again */
return 0;
- int slot = ctx->fd_rindex[fd];
+ int slot = poller->fd_rindex[fd];
if (slot >= nfds)
/* stale slot entry; again, added afterwards */
@@ -629,22 +639,31 @@ static int afterpoll_check_fd(libxl_ctx *ctx,
return revents;
}
-static void afterpoll_internal(libxl__egc *egc,
+static void afterpoll_internal(libxl__egc *egc, libxl__poller *poller,
int nfds, const struct pollfd *fds,
struct timeval now)
{
libxl__gc *gc = &egc->gc;
libxl__ev_fd *efd;
+
LIBXL_LIST_FOREACH(efd, &CTX->efds, entry) {
if (!efd->events)
continue;
- int revents = afterpoll_check_fd(CTX,fds,nfds, efd->fd,efd->events);
+ int revents = afterpoll_check_fd(poller,fds,nfds, efd->fd,efd->events);
if (revents)
efd->func(egc, efd, efd->fd, efd->events, revents);
}
+ if (afterpoll_check_fd(poller,fds,nfds, poller->wakeup_pipe[0],POLLIN)) {
+ char buf[256];
+ int r = read(poller->wakeup_pipe[0], buf, sizeof(buf));
+ if (r < 0)
+ if (errno != EINTR && errno != EWOULDBLOCK)
+ LIBXL__EVENT_DISASTER(egc, "read wakeup", errno, 0);
+ }
+
for (;;) {
libxl__ev_time *etime = LIBXL_TAILQ_FIRST(&CTX->etimes);
if (!etime)
@@ -666,7 +685,7 @@ void libxl_osevent_afterpoll(libxl_ctx *ctx, int nfds, const struct pollfd *fds,
{
EGC_INIT(ctx);
CTX_LOCK;
- afterpoll_internal(egc, nfds, fds, now);
+ afterpoll_internal(egc, &ctx->poller_app, nfds, fds, now);
CTX_UNLOCK;
EGC_FREE;
}
@@ -789,7 +808,10 @@ void libxl__event_occurred(libxl__egc *egc, libxl_event *event)
LIBXL_TAILQ_INSERT_TAIL(&egc->occurred_for_callback, event, link);
return;
} else {
+ libxl__poller *poller;
LIBXL_TAILQ_INSERT_TAIL(&CTX->occurred, event, link);
+ LIBXL_LIST_FOREACH(poller, &CTX->pollers_event, entry)
+ libxl__poller_wakeup(egc, poller);
}
}
@@ -857,7 +879,94 @@ int libxl_event_check(libxl_ctx *ctx, libxl_event **event_r,
return rc;
}
-static int eventloop_iteration(libxl__egc *egc) {
+/*
+ * Manipulation of pollers
+ */
+
+int libxl__poller_init(libxl_ctx *ctx, libxl__poller *p)
+{
+ int r, rc;
+ p->fd_polls = 0;
+ p->fd_rindex = 0;
+
+ r = pipe(p->wakeup_pipe);
+ if (r) {
+ LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "cannot create poller pipe");
+ rc = ERROR_FAIL;
+ goto out;
+ }
+
+ rc = libxl_fd_set_nonblock(ctx, p->wakeup_pipe[0], 1);
+ if (rc) goto out;
+
+ rc = libxl_fd_set_nonblock(ctx, p->wakeup_pipe[1], 1);
+ if (rc) goto out;
+
+ return 0;
+
+ out:
+ libxl__poller_dispose(p);
+ return rc;
+}
+
+void libxl__poller_dispose(libxl__poller *p)
+{
+ if (p->wakeup_pipe[1] > 0) close(p->wakeup_pipe[1]);
+ if (p->wakeup_pipe[0] > 0) close(p->wakeup_pipe[0]);
+ free(p->fd_polls);
+ free(p->fd_rindex);
+}
+
+libxl__poller *libxl__poller_get(libxl_ctx *ctx)
+{
+ /* must be called with ctx locked */
+ int rc;
+
+ libxl__poller *p = LIBXL_LIST_FIRST(&ctx->pollers_idle);
+ if (p)
+ return p;
+
+ p = malloc(sizeof(*p));
+ if (!p) {
+ LIBXL__LOG_ERRNO(ctx, LIBXL__LOG_ERROR, "cannot allocate poller");
+ return 0;
+ }
+ memset(p, 0, sizeof(*p));
+
+ rc = libxl__poller_init(ctx, p);
+ if (rc) return NULL;
+
+ return p;
+}
+
+void libxl__poller_put(libxl_ctx *ctx, libxl__poller *p)
+{
+ LIBXL_LIST_INSERT_HEAD(&ctx->pollers_idle, p, entry);
+}
+
+void libxl__poller_wakeup(libxl__egc *egc, libxl__poller *p)
+{
+ static const char buf[1] = "";
+
+ for (;;) {
+ int r = write(p->wakeup_pipe[1], buf, 1);
+ if (r==1) return;
+ assert(r==-1);
+ if (errno == EINTR) continue;
+ if (errno == EWOULDBLOCK) return;
+ LIBXL__EVENT_DISASTER(egc, "cannot poke watch pipe", errno, 0);
+ return;
+ }
+}
+
+/*
+ * Main event loop iteration
+ */
+
+static int eventloop_iteration(libxl__egc *egc, libxl__poller *poller) {
+ /* The CTX must be locked EXACTLY ONCE so that this function
+ * can unlock it when it polls.
+ */
libxl__gc *gc = &egc->gc;
int rc;
struct timeval now;
@@ -870,23 +979,27 @@ static int eventloop_iteration(libxl__egc *egc) {
int timeout;
for (;;) {
- int nfds = CTX->fd_polls_allocd;
+ int nfds = poller->fd_polls_allocd;
timeout = -1;
- rc = beforepoll_internal(gc, &nfds, CTX->fd_polls, &timeout, now);
+ rc = beforepoll_internal(gc, poller, &nfds, poller->fd_polls,
+ &timeout, now);
if (!rc) break;
if (rc != ERROR_BUFFERFULL) goto out;
struct pollfd *newarray =
(nfds > INT_MAX / sizeof(struct pollfd) / 2) ? 0 :
- realloc(CTX->fd_polls, sizeof(*newarray) * nfds);
+ realloc(poller->fd_polls, sizeof(*newarray) * nfds);
if (!newarray) { rc = ERROR_NOMEM; goto out; }
- CTX->fd_polls = newarray;
- CTX->fd_polls_allocd = nfds;
+ poller->fd_polls = newarray;
+ poller->fd_polls_allocd = nfds;
}
- rc = poll(CTX->fd_polls, CTX->fd_polls_allocd, timeout);
+ CTX_UNLOCK;
+ rc = poll(poller->fd_polls, poller->fd_polls_allocd, timeout);
+ CTX_LOCK;
+
if (rc < 0) {
if (errno == EINTR)
return 0; /* will go round again if caller requires */
@@ -899,7 +1012,8 @@ static int eventloop_iteration(libxl__egc *egc) {
rc = libxl__gettimeofday(gc, &now);
if (rc) goto out;
- afterpoll_internal(egc, CTX->fd_polls_allocd, CTX->fd_polls, now);
+ afterpoll_internal(egc, poller,
+ poller->fd_polls_allocd, poller->fd_polls, now);
CTX_UNLOCK;
@@ -913,15 +1027,19 @@ int libxl_event_wait(libxl_ctx *ctx, libxl_event **event_r,
libxl_event_predicate *pred, void *pred_user)
{
int rc;
+ libxl__poller *poller = NULL;
EGC_INIT(ctx);
CTX_LOCK;
+ poller = libxl__poller_get(ctx);
+ if (!poller) { rc = ERROR_FAIL; goto out; }
+
for (;;) {
rc = event_check_internal(egc, event_r, typemask, pred, pred_user);
if (rc != ERROR_NOT_READY) goto out;
- rc = eventloop_iteration(egc);
+ rc = eventloop_iteration(egc, poller);
if (rc) goto out;
/* we unlock and cleanup the egc each time we go through this loop,
@@ -935,6 +1053,8 @@ int libxl_event_wait(libxl_ctx *ctx, libxl_event **event_r,
}
out:
+ libxl__poller_put(ctx, poller);
+
CTX_UNLOCK;
EGC_FREE;
return rc;
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index 8cb6cdb..546f300 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -200,6 +200,33 @@ struct libxl__evgen_disk_eject {
_hidden void
libxl__evdisable_disk_eject(libxl__gc*, libxl_evgen_disk_eject*);
+typedef struct libxl__poller libxl__poller;
+struct libxl__poller {
+ /*
+ * These are used to allow other threads to wake up a thread which
+ * may be stuck in poll, because whatever it was waiting for
+ * hadn't happened yet. Threads which generate events will write
+ * a byte to each pipe. A threads which is waiting will empty its
+ * own pipe, and put its poller on the pollers_event list, before
+ * releasing the ctx lock and going into poll; when it comes out
+ * of poll it will take the poller off the pollers_event list.
+ *
+ * When a thread is done with a poller it should put it onto
+ * pollers_idle, where it can be reused later.
+ *
+ * The "poller_app" is never idle, but is sometimes on
+ * pollers_event.
+ */
+ LIBXL_LIST_ENTRY(libxl__poller) entry;
+
+ struct pollfd *fd_polls;
+ int fd_polls_allocd;
+
+ int fd_rindex_allocd;
+ int *fd_rindex; /* see libxl_osevent_beforepoll */
+
+ int wakeup_pipe[2]; /* 0 means no fd allocated */
+};
struct libxl__ctx {
xentoollog_logger *lg;
@@ -230,10 +257,9 @@ struct libxl__ctx {
/* See the comment for OSEVENT_HOOK_INTERN in libxl_event.c
* for restrictions on the use of the osevent fields. */
- struct pollfd *fd_polls;
- int fd_polls_allocd;
- int fd_rindex_allocd;
- int *fd_rindex; /* see libxl_osevent_beforepoll */
+ libxl__poller poller_app; /* libxl_osevent_beforepoll and _afterpoll */
+ LIBXL_LIST_HEAD(, libxl__poller) pollers_event, pollers_idle;
+
LIBXL_LIST_HEAD(, libxl__ev_fd) efds;
LIBXL_TAILQ_HEAD(, libxl__ev_time) etimes;
@@ -517,6 +543,23 @@ _hidden void libxl__event_disaster(libxl__egc*, const char *msg, int errnoval,
libxl__event_disaster(egc, msg, errnoval, type, __FILE__,__LINE__,__func__)
+int libxl__poller_init(libxl_ctx *ctx, libxl__poller *p);
+void libxl__poller_dispose(libxl__poller *p);
+ /* Fills in, or disposes of the resources held by, a poller whose
+ * space the caller has allocated. ctx must be locked.
+ */
+
+libxl__poller *libxl__poller_get(libxl_ctx *ctx);
+void libxl__poller_put(libxl_ctx *ctx, libxl__poller *p);
+ /* Obtain a fresh poller from malloc or the idle list, and put it
+ * away again afterwards. _get can fail, returning NULL.
+ * ctx must be locked. */
+
+void libxl__poller_wakeup(libxl__egc *egc, libxl__poller *p);
+ /* Notifies whoever is polling using p that they should wake up.
+ * ctx must be locked. */
+
+
/* from xl_dom */
_hidden libxl_domain_type libxl__domain_type(libxl__gc *gc, uint32_t domid);
_hidden int libxl__domain_shutdown_reason(libxl__gc *gc, uint32_t domid);
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* [PATCH RFC v6.1 11-14/10] libxl: asynchronous operations
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (9 preceding siblings ...)
2012-01-06 20:35 ` [PATCH 10/10] libxl: Permit multithreaded event waiting Ian Jackson
@ 2012-01-09 17:34 ` Ian Jackson
2012-01-09 17:34 ` [PATCH 11/10] libxl: Asynchronous/long-running operation infrastructure Ian Jackson
` (4 subsequent siblings)
15 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-09 17:34 UTC (permalink / raw)
To: xen-devel
Here are four more patches to go onto the end of my previous 10-patch
event series posting:
11/10 libxl: Asynchronous/long-running operation infrastructure
12/10 libxl: New convenience macro CONTAINING_STRUCT
13/10 libxl: Introduce libxl__ev_devstate
14/10 libxl: Convert to asynchronous: device removal
This introduces a standard way for the same libxl function to be
useable both by simple-minded callers who want to wait synchronously,
and by advanced callers who want to the function to return immediately
and arrange a callback or event later.
^ permalink raw reply [flat|nested] 43+ messages in thread* [PATCH 11/10] libxl: Asynchronous/long-running operation infrastructure
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (10 preceding siblings ...)
2012-01-09 17:34 ` [PATCH RFC v6.1 11-14/10] libxl: asynchronous operations Ian Jackson
@ 2012-01-09 17:34 ` Ian Jackson
2012-01-09 17:34 ` [PATCH 12/10] libxl: New convenience macro CONTAINING_STRUCT Ian Jackson
` (3 subsequent siblings)
15 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-09 17:34 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
Provide a new set of machinery for writing public libxl functions
which may take a long time. The application gets to decide whether
they want the function to be synchronous, or whether they'd prefer to
get a callback, or an event, when the operation is complete.
User(s) of this machinery will be introduced in later patch(es).
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl.h | 50 ++++++++++++
tools/libxl/libxl_event.c | 183 ++++++++++++++++++++++++++++++++++++++++++
tools/libxl/libxl_internal.h | 105 ++++++++++++++++++++++++
tools/libxl/libxl_types.idl | 4 +
4 files changed, 342 insertions(+), 0 deletions(-)
diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h
index 5396ba8..e8fed73 100644
--- a/tools/libxl/libxl.h
+++ b/tools/libxl/libxl.h
@@ -235,8 +235,58 @@ enum {
ERROR_NOT_READY = -11,
ERROR_OSEVENT_REG_FAIL = -12,
ERROR_BUFFERFULL = -13,
+ ERROR_ASYNC_INPROGRESS = -14,
};
+
+/*
+ * Some libxl operations can take a long time. These functions take a
+ * parameter to control their concurrency:
+ * libxl_asyncop_how *ao_how
+ *
+ * If ao_how==NULL, the function will be synchronous.
+ *
+ * If ao_how!=NULL, the function will set the operation going, and
+ * if this is successful will return ERROR_ASYNCH_INPROGRESS.
+ *
+ * If ao_how->callback!=NULL, the callback will be called when the
+ * operation completes. The same rules as for libxl_event_hooks
+ * apply, including the reentrancy rules and the possibility of
+ * "disaster", except that libxl calls ao_how->callback instead of
+ * libxl_event_hooks.event_occurs.
+ *
+ * If ao_how->callback==NULL, a libxl_event will be generated which
+ * can be obtained from libxl_event_wait or libxl_event_check. The
+ * event will have type OPERATION_COMPLETE (which is not used
+ * elsewhere).
+ *
+ * Note that it is possible for an asynchronous operation which is to
+ * result in a callback to complete during its initiating function
+ * call. In this case the initating function will return
+ * ERROR_ASYNCH_INPROGRESS, even though by the time it returns the
+ * operation is complete and the callback has already happened.
+ *
+ * The application must set and use ao_how->for_event (which will be
+ * copied into libxl_event.for_user) or ao_how->for_callback (passed
+ * to the callback) to determine which operation finished, and it must
+ * of course check the rc value for errors.
+ *
+ * *ao_how does not need to remain valid after the initiating function
+ * returns.
+ *
+ * Callbacks may occur on any thread in which the application calls
+ * libxl.
+ */
+
+typedef struct {
+ void (*callback)(libxl_ctx *ctx, int rc, void *for_callback);
+ union {
+ libxl_ev_user for_event; /* used if callback==NULL */
+ void *for_callback; /* passed to callback */
+ } u;
+} libxl_asyncop_how;
+
+
#define LIBXL_VERSION 0
typedef struct {
diff --git a/tools/libxl/libxl_event.c b/tools/libxl/libxl_event.c
index 84aa489..c594494 100644
--- a/tools/libxl/libxl_event.c
+++ b/tools/libxl/libxl_event.c
@@ -770,10 +770,21 @@ static void egc_run_callbacks(libxl__egc *egc)
{
libxl__gc *gc = &egc->gc;
libxl_event *ev, *ev_tmp;
+
LIBXL_TAILQ_FOREACH_SAFE(ev, &egc->occurred_for_callback, link, ev_tmp) {
LIBXL_TAILQ_REMOVE(&egc->occurred_for_callback, ev, link);
CTX->event_hooks->event_occurs(CTX->event_hooks_user, ev);
}
+
+ libxl__ao *ao, *ao_tmp;
+ LIBXL_TAILQ_FOREACH_SAFE(ao, &egc->aos_for_callback,
+ entry_for_callback, ao_tmp) {
+ LIBXL_TAILQ_REMOVE(&egc->aos_for_callback, ao, entry_for_callback);
+ ao->how.callback(CTX, ao->rc, ao->how.u.for_callback);
+ ao->notified = 1;
+ if (!ao->in_initiator)
+ libxl__ao__destroy(libxl__gc_owner(&egc->gc), ao);
+ }
}
void libxl__egc_cleanup(libxl__egc *egc)
@@ -1060,6 +1071,178 @@ int libxl_event_wait(libxl_ctx *ctx, libxl_event **event_r,
return rc;
}
+
+
+/*
+ * The two possible state flow of an ao:
+ *
+ * Completion before initiator return:
+ *
+ * Initiator thread Possible other threads
+ *
+ * * ao_create allocates memory and
+ * initialises the struct
+ *
+ * * the initiator function does its
+ * work, setting up various internal
+ * asynchronous operations -----------> * asynchronous operations
+ * start to take place and
+ * might cause ao completion
+ * |
+ * * initiator calls ao_complete: |
+ * - if synchronous, run event loop |
+ * until the ao completes |
+ * - ao completes on some thread
+ * - completing thread releases the lock
+ * <--------------'
+ * - ao_complete takes the lock
+ * - destroy the ao
+ *
+ *
+ * Completion after initiator return (asynch. only):
+ *
+ *
+ * Initiator thread Possible other threads
+ *
+ * * ao_create allocates memory and
+ * initialises the struct
+ *
+ * * the initiator function does its
+ * work, setting up various internal
+ * asynchronous operations -----------> * asynchronous operations
+ * start to take place and
+ * might cause ao completion
+ * |
+ * * initiator calls ao_complete: |
+ * - observes event not net done, |
+ * - returns to caller |
+ * |
+ * - ao completes on some thread
+ * - generate the event or call the callback
+ * - destroy the ao
+ */
+
+void libxl__ao__destroy(libxl_ctx *ctx, libxl__ao *ao) {
+ if (!ao) return;
+ if (ao->poller) libxl__poller_put(ctx, ao->poller);
+ ao->magic = LIBXL__AO_MAGIC_DESTROYED;
+ libxl__gc_cleanup(&ao->gc);
+ free(ao);
+}
+
+void libxl__ao_abort(libxl__ao *ao) {
+ AO_GC;
+ assert(ao->magic == LIBXL__AO_MAGIC);
+ assert(ao->in_initiator);
+ assert(!ao->complete);
+ libxl__ao__destroy(CTX, ao);
+}
+
+void libxl__ao_complete(libxl__egc *egc, libxl__ao *ao, int rc) {
+ assert(ao->magic == LIBXL__AO_MAGIC);
+ assert(!ao->complete);
+ ao->complete = 1;
+ ao->rc = rc;
+
+ if (ao->poller) {
+ assert(ao->in_initiator);
+ libxl__poller_wakeup(egc, ao->poller);
+ } else if (ao->how.callback) {
+ LIBXL_TAILQ_INSERT_TAIL(&egc->aos_for_callback, ao, entry_for_callback);
+ } else {
+ libxl_event *ev;
+ ev = NEW_EVENT(egc, OPERATION_COMPLETE, ao->domid);
+ if (ev) {
+ ev->for_user = ao->how.u.for_event;
+ ev->u.operation_complete.rc = ao->rc;
+ libxl__event_occurred(egc, ev);
+ }
+ ao->notified = 1;
+ }
+ if (!ao->in_initiator && ao->notified)
+ libxl__ao__destroy(libxl__gc_owner(&egc->gc), ao);
+}
+
+libxl__ao *libxl__ao_create(libxl_ctx *ctx, uint32_t domid,
+ const libxl_asyncop_how *how) {
+ libxl__ao *ao;
+
+ ao = calloc(sizeof(*ao),1);
+ if (!ao) goto out;
+
+ ao->magic = LIBXL__AO_MAGIC;
+ ao->in_initiator = 1;
+ ao->poller = 0;
+ ao->domid = domid;
+ LIBXL_INIT_GC(ao->gc, ctx);
+
+ if (how) {
+ ao->how = *how;
+ } else {
+ ao->poller = libxl__poller_get(ctx);
+ if (!ao->poller) goto out;
+ }
+ return ao;
+
+ out:
+ if (ao) libxl__ao__destroy(ctx, ao);
+ return NULL;
+}
+
+int libxl__ao_inprogress(libxl__ao *ao) {
+ AO_GC;
+ int rc;
+
+ /* We use a fresh gc, so that we can free things
+ * each time round the loop. */
+ assert(ao->magic == LIBXL__AO_MAGIC);
+ assert(ao->in_initiator);
+
+ if (ao->poller) {
+ /* Caller wants it done synchronously. */
+ libxl__egc egc;
+ LIBXL_INIT_EGC(egc,CTX);
+
+ for (;;) {
+ assert(ao->magic == LIBXL__AO_MAGIC);
+
+ if (ao->complete) {
+ rc = ao->rc;
+ ao->notified = 1;
+ break;
+ }
+
+ rc = eventloop_iteration(&egc,ao->poller);
+ if (rc) {
+ /* Oh dear, this is quite unfortunate. */
+ LIBXL__LOG(CTX, LIBXL__LOG_ERROR, "Error waiting for"
+ " event during long-running operation (rc=%d)", rc);
+ sleep(1);
+ /* It's either this or return ERROR_I_DONT_KNOW_WHETHER
+ * _THE_THING_YOU_ASKED_FOR_WILL_BE_DONE_LATER_WHEN
+ * _YOU_DIDNT_EXPECT_IT, since we don't have any kind of
+ * cancellation ability. */
+ }
+
+ CTX_UNLOCK;
+ libxl__egc_cleanup(&egc);
+ CTX_LOCK;
+ }
+ } else {
+ rc = ERROR_ASYNC_INPROGRESS;
+ }
+
+ ao->in_initiator = 0;
+
+ if (ao->notified) {
+ assert(ao->complete);
+ libxl__ao__destroy(CTX,ao);
+ }
+
+ return rc;
+}
+
+
/*
* Local variables:
* mode: C
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index 1fc3487..e0ff15c 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -112,6 +112,7 @@ _hidden void libxl__log(libxl_ctx *ctx, xentoollog_level msglevel, int errnoval,
typedef struct libxl__gc libxl__gc;
typedef struct libxl__egc libxl__egc;
+typedef struct libxl__ao libxl__ao;
typedef struct libxl__ev_fd libxl__ev_fd;
typedef void libxl__ev_fd_callback(libxl__egc *egc, libxl__ev_fd *ev,
@@ -216,6 +217,10 @@ struct libxl__poller {
* releasing the ctx lock and going into poll; when it comes out
* of poll it will take the poller off the pollers_event list.
*
+ * A thread which is waiting for completion of a synchronous ao
+ * will allocate a poller and record it in the ao, so that other
+ * threads can wake it up.
+ *
* When a thread is done with a poller it should put it onto
* pollers_idle, where it can be reused later.
*
@@ -322,6 +327,21 @@ struct libxl__egc {
/* for event-generating functions only */
struct libxl__gc gc;
struct libxl__event_list occurred_for_callback;
+ LIBXL_TAILQ_HEAD(, libxl__ao) aos_for_callback;
+};
+
+#define LIBXL__AO_MAGIC 0xA0FACE00ul
+#define LIBXL__AO_MAGIC_DESTROYED 0xA0DEAD00ul
+
+struct libxl__ao {
+ uint32_t magic;
+ unsigned in_initiator:1, complete:1, notified:1;
+ int rc;
+ libxl__gc gc;
+ libxl_asyncop_how how;
+ libxl__poller *poller;
+ uint32_t domid;
+ LIBXL_TAILQ_ENTRY(libxl__ao) entry_for_callback;
};
#define LIBXL_INIT_GC(gc,ctx) do{ \
@@ -1116,6 +1136,91 @@ _hidden void libxl__egc_cleanup(libxl__egc *egc);
/*
+ * Machinery for asynchronous operations ("ao")
+ *
+ * All "slow" functions (includes anything that might block on a
+ * guest or an external script) need to use the asynchronous
+ * operation ("ao") machinery. The function should take a parameter
+ * const libxl_asyncop_how *ao_how and must start with a call to
+ * AO_INITIATOR_ENTRY. These functions MAY NOT be called from
+ * outside libxl, because they can cause reentrancy callbacks.
+ *
+ * No functions called internally within libxl should ever return
+ * ERROR_ASYNCH_INPROGRESS.
+ *
+ * Lifecycle of an ao:
+ *
+ * - Created by libxl__ao_create (or the AO_CREATE convenience macro).
+ *
+ * - After creation, can be used by code which implements
+ * the operation as follows:
+ * - the ao's gc, for allocating memory for the lifetime
+ * of the operation (possibly with the help of the AO_GC
+ * macro to introduce the gc into scope)
+ * - the ao itself may be passed about to sub-functions
+ * so that they can stash it away etc.
+ * - in particular, the ao pointer must be stashed in some
+ * per-operation structure which is also passed as a user
+ * pointer to the internal event generation request routines
+ * libxl__evgen_FOO, so that at some point a CALLBACK will be
+ * made when the operation is complete.
+ *
+ * - If initiation is successful, the initiating function needs
+ * to run libxl__ao_inprogress right before unlocking and
+ * returning, and return whatever it returns (AO_INPROGRESS macro).
+ *
+ * - If the initiation is unsuccessful, the initiating function must
+ * call libxl__ao_abort before unlocking and returning whatever
+ * error code is appropriate (AO_ABORT macro).
+ *
+ * - Later, some callback function, whose callback has been requested
+ * directly or indirectly, should call libxl__ao_complete (with the
+ * ctx locked, as it will generally already be in any event callback
+ * function). This must happen exactly once for each ao (and not if
+ * the ao has been destroyed, obviously), and it may not happen
+ * until libxl__ao_inprogress has been called on the ao.
+ *
+ * - NOTE RE MULTIPLE GCS
+ */
+
+#define AO_CREATE(ctx, domid, ao_how) \
+ libxl__ao *ao = libxl__ao_create(ctx, domid, ao_how); \
+ if (!ao) return ERROR_NOMEM; \
+ AO_GC; \
+ CTX_LOCK;
+
+#define AO_INPROGRESS do{ \
+ int ao_inprogress_rc = libxl__ao_inprogress(ao); \
+ CTX_UNLOCK; \
+ return ao_inprogress_rc; \
+ }while(0)
+
+
+#define AO_ABORT(rc) do{ \
+ assert(rc); \
+ assert(rc != ERROR_ASYNC_INPROGRESS); \
+ libxl__ao_abort(ao); \
+ CTX_UNLOCK; \
+ return (rc); \
+ }while(0)
+
+#define AO_GC \
+ libxl__gc *const gc = &ao->gc
+
+
+_hidden libxl__ao *libxl__ao_create(libxl_ctx*, uint32_t domid,
+ const libxl_asyncop_how*);
+_hidden int libxl__ao_inprogress(libxl__ao *ao);
+_hidden void libxl__ao_abort(libxl__ao *ao);
+_hidden void libxl__ao_complete(libxl__egc *egc, libxl__ao *ao, int rc);
+ /* All of these MUST be called with the ctx locked.
+ * libxl__ao_wait MUST be called with the ctx locked exactly once.
+ */
+
+_hidden void libxl__ao__destroy(libxl_ctx*, libxl__ao *ao);
+ /* for use by ao machinery ONLY */
+
+/*
* Convenience macros.
*/
diff --git a/tools/libxl/libxl_types.idl b/tools/libxl/libxl_types.idl
index 6728479..eff4d43 100644
--- a/tools/libxl/libxl_types.idl
+++ b/tools/libxl/libxl_types.idl
@@ -394,6 +394,7 @@ libxl_event_type = Enumeration("event_type", [
(1, "DOMAIN_SHUTDOWN"),
(2, "DOMAIN_DESTROY"),
(3, "DISK_EJECT"),
+ (4, "OPERATION_COMPLETE"),
])
libxl_ev_user = Number("libxl_ev_user")
@@ -417,4 +418,7 @@ libxl_event = Struct("event",[
("vdev", string),
("disk", libxl_device_disk),
])),
+ ("operation_complete", Struct(None, [
+ ("rc", integer),
+ ])),
]))])
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* [PATCH 12/10] libxl: New convenience macro CONTAINING_STRUCT
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (11 preceding siblings ...)
2012-01-09 17:34 ` [PATCH 11/10] libxl: Asynchronous/long-running operation infrastructure Ian Jackson
@ 2012-01-09 17:34 ` Ian Jackson
2012-01-13 10:49 ` Ian Campbell
2012-01-09 17:34 ` [PATCH 13/10] libxl: Introduce libxl__ev_devstate Ian Jackson
` (2 subsequent siblings)
15 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-09 17:34 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
Provide a convenient and type-safe wrapper which does the correct
dance to subtract offsetof.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl_internal.h | 35 +++++++++++++++++++++++++++++++++++
1 files changed, 35 insertions(+), 0 deletions(-)
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index e0ff15c..e0c2ad6 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -1224,6 +1224,41 @@ _hidden void libxl__ao__destroy(libxl_ctx*, libxl__ao *ao);
* Convenience macros.
*/
+/*
+ * [GET_]CONTAINING_STRUCT work like this. Given:
+ * typedef struct {
+ * ...
+ * member_type member_name;
+ * ...
+ * } outer_type;
+ * Then:
+ * void GET_CONTAINING_STRUCT(outer_type *outer_var [NB:UPDATED],
+ * some_type *inner_ptr,
+ * member_name);
+ * outer_type *CONTAINING_STRUCT(outer_type,
+ * some_type *inner_ptr,
+ * member_name);
+ * The semantics are that after:
+ * outer_type outer, *outer_var;
+ * member_type *inner_ptr = &outer->member_name;
+ * GET_CONTAINING_STRUCT(outer_var, &outer_ptr->member_name, member_name)
+ * The following hold:
+ * CONTAINING_STRUCT(inner_ptr, outer_type, member_name) == outer_ptr
+ * outer_var == &outer
+ */
+#define GET_CONTAINING_STRUCT(outer_var, inner_ptr, member_name) \
+ ((outer_var) = (void*)((char*)(inner_ptr) - \
+ offsetof(typeof(*(outer_var)), member_name)), \
+ (void)(&(outer_var)->member_name == \
+ (typeof(inner_ptr))0) /* type check */, \
+ (void)0)
+#define CONTAINING_STRUCT(outer_type, inner_ptr, member_name) \
+ ({ \
+ typeof(outer_type) *containing_struct; \
+ GET_CONTAINING_STRUCT(containing_struct, inner_ptr, member_name); \
+ containing_struct; \
+ })
+
/*
* All of these assume (or define)
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* Re: [PATCH 12/10] libxl: New convenience macro CONTAINING_STRUCT
2012-01-09 17:34 ` [PATCH 12/10] libxl: New convenience macro CONTAINING_STRUCT Ian Jackson
@ 2012-01-13 10:49 ` Ian Campbell
2012-01-13 13:53 ` Ian Jackson
0 siblings, 1 reply; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 10:49 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Mon, 2012-01-09 at 17:34 +0000, Ian Jackson wrote:
> Provide a convenient and type-safe wrapper which does the correct
> dance to subtract offsetof.
>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
> ---
> tools/libxl/libxl_internal.h | 35 +++++++++++++++++++++++++++++++++++
> 1 files changed, 35 insertions(+), 0 deletions(-)
>
> diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
> index e0ff15c..e0c2ad6 100644
> --- a/tools/libxl/libxl_internal.h
> +++ b/tools/libxl/libxl_internal.h
> @@ -1224,6 +1224,41 @@ _hidden void libxl__ao__destroy(libxl_ctx*, libxl__ao *ao);
> * Convenience macros.
> */
>
> +/*
> + * [GET_]CONTAINING_STRUCT work like this. Given:
> + * typedef struct {
> + * ...
> + * member_type member_name;
> + * ...
> + * } outer_type;
> + * Then:
> + * void GET_CONTAINING_STRUCT(outer_type *outer_var [NB:UPDATED],
> + * some_type *inner_ptr,
> + * member_name);
> + * outer_type *CONTAINING_STRUCT(outer_type,
> + * some_type *inner_ptr,
> + * member_name);
> + * The semantics are that after:
> + * outer_type outer, *outer_var;
> + * member_type *inner_ptr = &outer->member_name;
> + * GET_CONTAINING_STRUCT(outer_var, &outer_ptr->member_name, member_name)
> + * The following hold:
> + * CONTAINING_STRUCT(inner_ptr, outer_type, member_name) == outer_ptr
There is no outer_ptr in the givens, did you mean outer_var or something
else?
It's not entirely clear to me what the distinction between the GET_ and
non GET_ variant is (just that one returns the thing and the other
updates a variable?) and/or why we would need both. The common operation
is to go from inner_ptr to outer_ptr I think and CONTAINING_STRUCT seems
to fill that niche just fine.
BTW, in Linux this is called container_of, which is maybe more familiar
to people?
> + * outer_var == &outer
> + */
> +#define GET_CONTAINING_STRUCT(outer_var, inner_ptr, member_name) \
> + ((outer_var) = (void*)((char*)(inner_ptr) - \
> + offsetof(typeof(*(outer_var)), member_name)), \
> + (void)(&(outer_var)->member_name == \
> + (typeof(inner_ptr))0) /* type check */, \
> + (void)0)
> +#define CONTAINING_STRUCT(outer_type, inner_ptr, member_name) \
> + ({ \
> + typeof(outer_type) *containing_struct; \
> + GET_CONTAINING_STRUCT(containing_struct, inner_ptr, member_name); \
> + containing_struct; \
> + })
> +
>
> /*
> * All of these assume (or define)
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 12/10] libxl: New convenience macro CONTAINING_STRUCT
2012-01-13 10:49 ` Ian Campbell
@ 2012-01-13 13:53 ` Ian Jackson
2012-01-13 15:06 ` Ian Campbell
0 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-13 13:53 UTC (permalink / raw)
To: Ian Campbell; +Cc: xen-devel@lists.xensource.com, Ian Jackson
Ian Campbell writes ("Re: [Xen-devel] [PATCH 12/10] libxl: New convenience macro CONTAINING_STRUCT"):
> On Mon, 2012-01-09 at 17:34 +0000, Ian Jackson wrote:
> > Provide a convenient and type-safe wrapper which does the correct
> > dance to subtract offsetof.
...
> > + * void GET_CONTAINING_STRUCT(outer_type *outer_var [NB:UPDATED],
> > + * some_type *inner_ptr,
> > + * member_name);
> > + * outer_type *CONTAINING_STRUCT(outer_type,
> > + * some_type *inner_ptr,
> > + * member_name);
> > + * The semantics are that after:
> > + * outer_type outer, *outer_var;
> > + * member_type *inner_ptr = &outer->member_name;
> > + * GET_CONTAINING_STRUCT(outer_var, &outer_ptr->member_name, member_name)
> > + * The following hold:
> > + * CONTAINING_STRUCT(inner_ptr, outer_type, member_name) == outer_ptr
>
> There is no outer_ptr in the givens, did you mean outer_var or something
> else?
I meant &outer. Fixed.
> It's not entirely clear to me what the distinction between the GET_ and
> non GET_ variant is (just that one returns the thing and the other
> updates a variable?) and/or why we would need both.
That's exactly the difference.
> The common operation is to go from inner_ptr to outer_ptr I think
> and CONTAINING_STRUCT seems to fill that niche just fine.
The reason we need GET_CONTAINING_STRUCT is because we want to write
this:
libxl__ev_devstate *ds;
GET_CONTAINING_STRUCT(ds, watch, watch);
If we have to use CONTAINING_STRUCT, we have to write:
libxl__ev_devstate *ds =
CONTAINING_STRUCT(libxl__ev_devstate, watch, watch);
which is really unnecessarily verbose, because of the repetition of
libxl__ev_devstate.
> BTW, in Linux this is called container_of, which is maybe more familiar
> to people?
I'm not attached to the name. If we pick Linux's name we should make
sure its semantics are identical, so the argument order should change.
Should it be called "container_of" or "CONTAINER_OF" ?
I still think we need something like the GET_... version, or some
other construct that allows us to avoid writing out the type name
twice.
Hmm, actually, in our version, you can write,
libxl__ev_devstate *ds = CONTAINING_STRUCT(ds, watch, watch);
since we call typeof on the type argument.
So how about I change everything to use that pattern, rename it
CONTAINER_OF, and remove the GET_ version ?
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH 12/10] libxl: New convenience macro CONTAINING_STRUCT
2012-01-13 13:53 ` Ian Jackson
@ 2012-01-13 15:06 ` Ian Campbell
0 siblings, 0 replies; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 15:06 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-13 at 13:53 +0000, Ian Jackson wrote:
> Ian Campbell writes ("Re: [Xen-devel] [PATCH 12/10] libxl: New convenience macro CONTAINING_STRUCT"):
> > On Mon, 2012-01-09 at 17:34 +0000, Ian Jackson wrote:
> > > Provide a convenient and type-safe wrapper which does the correct
> > > dance to subtract offsetof.
> ...
> > > + * void GET_CONTAINING_STRUCT(outer_type *outer_var [NB:UPDATED],
> > > + * some_type *inner_ptr,
> > > + * member_name);
> > > + * outer_type *CONTAINING_STRUCT(outer_type,
> > > + * some_type *inner_ptr,
> > > + * member_name);
> > > + * The semantics are that after:
> > > + * outer_type outer, *outer_var;
> > > + * member_type *inner_ptr = &outer->member_name;
> > > + * GET_CONTAINING_STRUCT(outer_var, &outer_ptr->member_name, member_name)
> > > + * The following hold:
> > > + * CONTAINING_STRUCT(inner_ptr, outer_type, member_name) == outer_ptr
> >
> > There is no outer_ptr in the givens, did you mean outer_var or something
> > else?
>
> I meant &outer. Fixed.
>
> > It's not entirely clear to me what the distinction between the GET_ and
> > non GET_ variant is (just that one returns the thing and the other
> > updates a variable?) and/or why we would need both.
>
> That's exactly the difference.
>
> > The common operation is to go from inner_ptr to outer_ptr I think
> > and CONTAINING_STRUCT seems to fill that niche just fine.
>
> The reason we need GET_CONTAINING_STRUCT is because we want to write
> this:
>
> libxl__ev_devstate *ds;
> GET_CONTAINING_STRUCT(ds, watch, watch);
>
> If we have to use CONTAINING_STRUCT, we have to write:
>
> libxl__ev_devstate *ds =
> CONTAINING_STRUCT(libxl__ev_devstate, watch, watch);
>
> which is really unnecessarily verbose, because of the repetition of
> libxl__ev_devstate.
>
> > BTW, in Linux this is called container_of, which is maybe more familiar
> > to people?
>
> I'm not attached to the name. If we pick Linux's name we should make
> sure its semantics are identical, so the argument order should change.
>
> Should it be called "container_of" or "CONTAINER_OF" ?
>
> I still think we need something like the GET_... version, or some
> other construct that allows us to avoid writing out the type name
> twice.
>
> Hmm, actually, in our version, you can write,
>
> libxl__ev_devstate *ds = CONTAINING_STRUCT(ds, watch, watch);
>
> since we call typeof on the type argument.
>
> So how about I change everything to use that pattern, rename it
> CONTAINER_OF, and remove the GET_ version ?
Sounds good.
RE "container_of" vs. "CONTAINER_OF" -- Linux uses lowercase but that is
against the usual style of macros being caps. I don't mind which.
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread
* [PATCH 13/10] libxl: Introduce libxl__ev_devstate
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (12 preceding siblings ...)
2012-01-09 17:34 ` [PATCH 12/10] libxl: New convenience macro CONTAINING_STRUCT Ian Jackson
@ 2012-01-09 17:34 ` Ian Jackson
2012-01-09 17:34 ` [PATCH 14/10] libxl: Convert to asynchronous: device removal Ian Jackson
2012-01-13 14:50 ` [PATCH v6 00/10] libxl: event API Ian Campbell
15 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-09 17:34 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
Provide a new-style asynchronous facility for waiting for device
states on xenbus. This will replace libxl__wait_for_device_state,
after the callers have been updated in later patches.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl_event.c | 74 ++++++++++++++++++++++++++++++++++++++++++
tools/libxl/libxl_internal.h | 41 +++++++++++++++++++++++
2 files changed, 115 insertions(+), 0 deletions(-)
diff --git a/tools/libxl/libxl_event.c b/tools/libxl/libxl_event.c
index c594494..c26210b 100644
--- a/tools/libxl/libxl_event.c
+++ b/tools/libxl/libxl_event.c
@@ -506,6 +506,80 @@ void libxl__ev_xswatch_deregister(libxl__gc *gc, libxl__ev_xswatch *w)
}
/*
+ * waiting for device state
+ */
+
+static void devstate_watch_callback(libxl__egc *egc, libxl__ev_xswatch *watch,
+ const char *watch_path, const char *event_path)
+{
+ libxl__ev_devstate *ds;
+ libxl__gc *gc = &egc->gc;
+ GET_CONTAINING_STRUCT(ds, watch, watch);
+ int rc;
+
+ char *sstate = libxl__xs_read(&egc->gc, XBT_NULL, watch_path);
+ if (!sstate) {
+ if (errno == ENOENT) {
+ LIBXL__LOG(CTX, LIBXL__LOG_DEBUG, "backend %s wanted state %d"
+ " but it was removed", watch_path, ds->wanted);
+ rc = ERROR_INVAL;
+ } else {
+ LIBXL__LOG_ERRNO(CTX, LIBXL__LOG_ERROR, "backend %s wanted state"
+ " %d but read failed", watch_path, ds->wanted);
+ rc = ERROR_FAIL;
+ }
+ } else {
+ int got = atoi(sstate);
+ if (got == ds->wanted) {
+ LIBXL__LOG(CTX, LIBXL__LOG_DEBUG, "backend %s wanted state %d ok",
+ watch_path, ds->wanted);
+ rc = 0;
+ } else {
+ LIBXL__LOG(CTX, LIBXL__LOG_DEBUG, "backend %s wanted state %d "
+ " still waiting state %d", watch_path, ds->wanted, got);
+ return;
+ }
+ }
+ libxl__ev_devstate_cancel(&egc->gc, ds);
+ ds->callback(egc, ds, rc);
+}
+
+static void devstate_timeout(libxl__egc *egc, libxl__ev_time *ev,
+ const struct timeval *requested_abs)
+{
+ libxl__ev_devstate *ds;
+ libxl__gc *gc = &egc->gc;
+ GET_CONTAINING_STRUCT(ds, ev, timeout);
+ LIBXL__LOG(CTX, LIBXL__LOG_DEBUG, "backend %s wanted state %d "
+ " timed out", ds->watch.path, ds->wanted);
+ libxl__ev_devstate_cancel(&egc->gc, ds);
+ ds->callback(egc, ds, ERROR_TIMEDOUT);
+}
+
+int libxl__ev_devstate_wait(libxl__gc *gc, libxl__ev_devstate *ds,
+ libxl__ev_devstate_callback cb,
+ const char *state_path, int state, int milliseconds)
+{
+ int rc;
+
+ ds->wanted = state;
+
+ rc = libxl__ev_time_register_rel(gc, &ds->timeout, devstate_timeout,
+ milliseconds);
+ if (rc) goto out;
+
+ rc = libxl__ev_xswatch_register(gc, &ds->watch, devstate_watch_callback,
+ state_path);
+ if (rc) goto out;
+
+ return 0;
+
+ out:
+ libxl__ev_devstate_cancel(gc, ds);
+ return rc;
+}
+
+/*
* osevent poll
*/
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index e0c2ad6..6c87290 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -683,6 +683,47 @@ _hidden int libxl__wait_for_device_state(libxl__gc *gc, struct timeval *tv,
libxl__device_state_handler handler);
/*
+ * libxl__ev_devstate - waits a given time for a device to
+ * reach a given state. Follows the libxl_ev_* conventions.
+ * Will generate only one event, and after that is automatically
+ * cancelled.
+ */
+typedef struct libxl__ev_devstate libxl__ev_devstate;
+typedef void libxl__ev_devstate_callback(libxl__egc *egc, libxl__ev_devstate*,
+ int rc);
+ /* rc will be 0, ERROR_TIMEDOUT, ERROR_INVAL (meaning path was removed),
+ * or ERROR_FAIL if other stuff went wrong (in which latter case, logged) */
+
+struct libxl__ev_devstate {
+ /* read-only for caller, who may read only when waiting: */
+ int wanted;
+ libxl__ev_devstate_callback *callback;
+ /* as for the remainder, read-only public parts may also be
+ * read by the caller (notably, watch.path), but only when waiting: */
+ libxl__ev_xswatch watch;
+ libxl__ev_time timeout;
+};
+
+static inline void libxl__ev_devstate_init(libxl__ev_devstate *ds)
+{
+ libxl__ev_time_init(&ds->timeout);
+ libxl__ev_xswatch_init(&ds->watch);
+}
+
+static inline void libxl__ev_devstate_cancel(libxl__gc *gc,
+ libxl__ev_devstate *ds)
+{
+ libxl__ev_time_deregister(gc,&ds->timeout);
+ libxl__ev_xswatch_deregister(gc,&ds->watch);
+}
+
+_hidden int libxl__ev_devstate_wait(libxl__gc *gc, libxl__ev_devstate *ds,
+ libxl__ev_devstate_callback cb,
+ const char *state_path,
+ int state, int milliseconds);
+
+
+/*
* libxl__try_phy_backend - Check if there's support for the passed
* type of file using the PHY backend
* st_mode: mode_t of the file, as returned by stat function
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* [PATCH 14/10] libxl: Convert to asynchronous: device removal
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (13 preceding siblings ...)
2012-01-09 17:34 ` [PATCH 13/10] libxl: Introduce libxl__ev_devstate Ian Jackson
@ 2012-01-09 17:34 ` Ian Jackson
2012-01-13 14:50 ` [PATCH v6 00/10] libxl: event API Ian Campbell
15 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-09 17:34 UTC (permalink / raw)
To: xen-devel; +Cc: Ian Jackson
Convert libxl_FOO_device_remove, and the function which does the bulk
of the work, libxl__device_remove, to the new async ops scheme.
Adjust all callers.
Also remove libxl__wait_for_device_state which is now obsolete.
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
tools/libxl/libxl.c | 60 +++++++++++++--------
tools/libxl/libxl.h | 16 ++++--
tools/libxl/libxl_device.c | 119 +++++++++++++-----------------------------
tools/libxl/libxl_internal.h | 31 ++---------
tools/libxl/xl_cmdimpl.c | 4 +-
5 files changed, 95 insertions(+), 135 deletions(-)
diff --git a/tools/libxl/libxl.c b/tools/libxl/libxl.c
index b8167b3..ce9aef2 100644
--- a/tools/libxl/libxl.c
+++ b/tools/libxl/libxl.c
@@ -1308,19 +1308,23 @@ out:
}
int libxl_device_disk_remove(libxl_ctx *ctx, uint32_t domid,
- libxl_device_disk *disk)
+ libxl_device_disk *disk,
+ const libxl_asyncop_how *ao_how)
{
- GC_INIT(ctx);
+ AO_CREATE(ctx, domid, ao_how);
libxl__device device;
int rc;
rc = libxl__device_from_disk(gc, domid, disk, &device);
if (rc != 0) goto out;
- rc = libxl__device_remove(gc, &device, 1);
+ rc = libxl__initiate_device_remove(ao, &device);
+ if (rc) goto out;
+
+ AO_INPROGRESS;
+
out:
- GC_FREE;
- return rc;
+ AO_ABORT(rc);
}
int libxl_device_disk_destroy(libxl_ctx *ctx, uint32_t domid,
@@ -1534,11 +1538,11 @@ int libxl_cdrom_insert(libxl_ctx *ctx, uint32_t domid, libxl_device_disk *disk)
ret = 0;
- libxl_device_disk_remove(ctx, domid, disks + i);
+ libxl_device_disk_remove(ctx, domid, disks + i, 0);
libxl_device_disk_add(ctx, domid, disk);
stubdomid = libxl_get_stubdom_id(ctx, domid);
if (stubdomid) {
- libxl_device_disk_remove(ctx, stubdomid, disks + i);
+ libxl_device_disk_remove(ctx, stubdomid, disks + i, 0);
libxl_device_disk_add(ctx, stubdomid, disk);
}
out:
@@ -1751,19 +1755,23 @@ out:
}
int libxl_device_nic_remove(libxl_ctx *ctx, uint32_t domid,
- libxl_device_nic *nic)
+ libxl_device_nic *nic,
+ const libxl_asyncop_how *ao_how)
{
- GC_INIT(ctx);
+ AO_CREATE(ctx, domid, ao_how);
libxl__device device;
int rc;
rc = libxl__device_from_nic(gc, domid, nic, &device);
if (rc != 0) goto out;
- rc = libxl__device_remove(gc, &device, 1);
+ rc = libxl__initiate_device_remove(ao, &device);
+ if (rc) goto out;
+
+ AO_INPROGRESS;
+
out:
- GC_FREE;
- return rc;
+ AO_ABORT(rc);
}
int libxl_device_nic_destroy(libxl_ctx *ctx, uint32_t domid,
@@ -2091,19 +2099,23 @@ out:
}
int libxl_device_vkb_remove(libxl_ctx *ctx, uint32_t domid,
- libxl_device_vkb *vkb)
+ libxl_device_vkb *vkb,
+ const libxl_asyncop_how *ao_how)
{
- GC_INIT(ctx);
+ AO_CREATE(ctx, domid, ao_how);
libxl__device device;
int rc;
rc = libxl__device_from_vkb(gc, domid, vkb, &device);
if (rc != 0) goto out;
- rc = libxl__device_remove(gc, &device, 1);
+ rc = libxl__initiate_device_remove(ao, &device);
+ if (rc) goto out;
+
+ AO_INPROGRESS;
+
out:
- GC_FREE;
- return rc;
+ AO_ABORT(rc);
}
int libxl_device_vkb_destroy(libxl_ctx *ctx, uint32_t domid,
@@ -2208,19 +2220,23 @@ out:
}
int libxl_device_vfb_remove(libxl_ctx *ctx, uint32_t domid,
- libxl_device_vfb *vfb)
+ libxl_device_vfb *vfb,
+ const libxl_asyncop_how *ao_how)
{
- GC_INIT(ctx);
+ AO_CREATE(ctx, domid, ao_how);
libxl__device device;
int rc;
rc = libxl__device_from_vfb(gc, domid, vfb, &device);
if (rc != 0) goto out;
- rc = libxl__device_remove(gc, &device, 1);
+ rc = libxl__initiate_device_remove(ao, &device);
+ if (rc) goto out;
+
+ AO_INPROGRESS;
+
out:
- GC_FREE;
- return rc;
+ AO_ABORT(rc);
}
int libxl_device_vfb_destroy(libxl_ctx *ctx, uint32_t domid,
diff --git a/tools/libxl/libxl.h b/tools/libxl/libxl.h
index e8fed73..207288e 100644
--- a/tools/libxl/libxl.h
+++ b/tools/libxl/libxl.h
@@ -464,7 +464,9 @@ libxl_vminfo * libxl_list_vm(libxl_ctx *ctx, int *nb_vm);
/* Disks */
int libxl_device_disk_init(libxl_ctx *ctx, libxl_device_disk *disk);
int libxl_device_disk_add(libxl_ctx *ctx, uint32_t domid, libxl_device_disk *disk);
-int libxl_device_disk_remove(libxl_ctx *ctx, uint32_t domid, libxl_device_disk *disk);
+int libxl_device_disk_remove(libxl_ctx *ctx, uint32_t domid,
+ libxl_device_disk *disk,
+ const libxl_asyncop_how *ao_how);
int libxl_device_disk_destroy(libxl_ctx *ctx, uint32_t domid,
libxl_device_disk *disk);
@@ -488,7 +490,9 @@ int libxl_device_disk_local_detach(libxl_ctx *ctx, libxl_device_disk *disk);
/* Network Interfaces */
int libxl_device_nic_init(libxl_ctx *ctx, libxl_device_nic *nic);
int libxl_device_nic_add(libxl_ctx *ctx, uint32_t domid, libxl_device_nic *nic);
-int libxl_device_nic_remove(libxl_ctx *ctx, uint32_t domid, libxl_device_nic *nic);
+int libxl_device_nic_remove(libxl_ctx *ctx, uint32_t domid,
+ libxl_device_nic *nic,
+ const libxl_asyncop_how *ao_how);
int libxl_device_nic_destroy(libxl_ctx *ctx, uint32_t domid, libxl_device_nic *nic);
libxl_device_nic *libxl_device_nic_list(libxl_ctx *ctx, uint32_t domid, int *num);
@@ -498,13 +502,17 @@ int libxl_device_nic_getinfo(libxl_ctx *ctx, uint32_t domid,
/* Keyboard */
int libxl_device_vkb_init(libxl_ctx *ctx, libxl_device_vkb *vkb);
int libxl_device_vkb_add(libxl_ctx *ctx, uint32_t domid, libxl_device_vkb *vkb);
-int libxl_device_vkb_remove(libxl_ctx *ctx, uint32_t domid, libxl_device_vkb *vkb);
+int libxl_device_vkb_remove(libxl_ctx *ctx, uint32_t domid,
+ libxl_device_vkb *vkb,
+ const libxl_asyncop_how *ao_how);
int libxl_device_vkb_destroy(libxl_ctx *ctx, uint32_t domid, libxl_device_vkb *vkb);
/* Framebuffer */
int libxl_device_vfb_init(libxl_ctx *ctx, libxl_device_vfb *vfb);
int libxl_device_vfb_add(libxl_ctx *ctx, uint32_t domid, libxl_device_vfb *vfb);
-int libxl_device_vfb_remove(libxl_ctx *ctx, uint32_t domid, libxl_device_vfb *vfb);
+int libxl_device_vfb_remove(libxl_ctx *ctx, uint32_t domid,
+ libxl_device_vfb *vfb,
+ const libxl_asyncop_how *ao_how);
int libxl_device_vfb_destroy(libxl_ctx *ctx, uint32_t domid, libxl_device_vfb *vfb);
/* PCI Passthrough */
diff --git a/tools/libxl/libxl_device.c b/tools/libxl/libxl_device.c
index 5d05e90..fd27ce5 100644
--- a/tools/libxl/libxl_device.c
+++ b/tools/libxl/libxl_device.c
@@ -357,85 +357,42 @@ int libxl__device_disk_dev_number(const char *virtpath, int *pdisk,
return -1;
}
-/*
- * Returns 0 if a device is removed, ERROR_* if an error
- * or timeout occurred.
- */
-int libxl__wait_for_device_state(libxl__gc *gc, struct timeval *tv,
- XenbusState state,
- libxl__device_state_handler handler)
-{
- libxl_ctx *ctx = libxl__gc_owner(gc);
- int nfds, rc;
- unsigned int n;
- fd_set rfds;
- char **l1 = NULL;
-
-start:
- rc = 1;
- nfds = xs_fileno(ctx->xsh) + 1;
- FD_ZERO(&rfds);
- FD_SET(xs_fileno(ctx->xsh), &rfds);
- switch (select(nfds, &rfds, NULL, NULL, tv)) {
- case -1:
- if (errno == EINTR)
- goto start;
- rc = ERROR_FAIL;
- break;
- case 0:
- rc = ERROR_TIMEDOUT;
- break;
- default:
- l1 = xs_read_watch(ctx->xsh, &n);
- if (l1 != NULL) {
- char *sstate = libxl__xs_read(gc, XBT_NULL,
- l1[XS_WATCH_PATH]);
- if (!sstate || atoi(sstate) == state) {
- /* Call handler function if present */
- if (handler)
- rc = handler(gc, l1, sstate);
- } else {
- /* State is different than expected, continue waiting... */
- goto start;
- }
- free(l1);
- } else {
- rc = ERROR_FAIL;
- }
- break;
- }
- return rc;
-}
-/*
- * Handler function for device destruction to be passed to
- * libxl__wait_for_device_state
- */
-static int destroy_device(libxl__gc *gc, char **l1, char *state)
-{
- libxl_ctx *ctx = libxl__gc_owner(gc);
-
- xs_unwatch(ctx->xsh, l1[0], l1[1]);
- xs_rm(ctx->xsh, XBT_NULL, l1[XS_WATCH_TOKEN]);
- LIBXL__LOG(ctx, LIBXL__LOG_DEBUG,
- "Destroyed device backend at %s",
- l1[XS_WATCH_TOKEN]);
+typedef struct {
+ libxl__ao *ao;
+ libxl__ev_devstate ds;
+} libxl__ao_device_remove;
+
+static void device_remove_cleanup(libxl__gc *gc,
+ libxl__ao_device_remove *aorm) {
+ if (!aorm) return;
+ libxl__ev_devstate_cancel(gc, &aorm->ds);
+ free(aorm);
+}
- return 0;
+static void device_remove_callback(libxl__egc *egc, libxl__ev_devstate *ds,
+ int rc) {
+ libxl__ao_device_remove *aorm;
+ GET_CONTAINING_STRUCT(aorm, ds, ds);
+ libxl__ao_complete(egc, aorm->ao, rc);
+ device_remove_cleanup(&egc->gc, aorm);
}
-/*
- * Returns 0 (device already destroyed) or 1 (caller must
- * wait_for_dev_destroy) on success, ERROR_* on fail.
- */
-int libxl__device_remove(libxl__gc *gc, libxl__device *dev, int wait)
+int libxl__initiate_device_remove(libxl__ao *ao, libxl__device *dev)
{
+ /* Arranges that dev will be removed from its guest. When
+ * this is done, the ao will be completed. An error
+ * return from libxl__device_remove means that the ao
+ * will _not_ be completed and the caller must do so.
+ */
+ AO_GC;
libxl_ctx *ctx = libxl__gc_owner(gc);
xs_transaction_t t;
char *be_path = libxl__device_backend_path(gc, dev);
char *state_path = libxl__sprintf(gc, "%s/state", be_path);
char *state = libxl__xs_read(gc, XBT_NULL, state_path);
int rc = 0;
+ libxl__ao_device_remove *aorm = 0;
if (!state)
goto out;
@@ -458,23 +415,21 @@ retry_transaction:
}
}
- xs_watch(ctx->xsh, state_path, be_path);
libxl__device_destroy_tapdisk(gc, be_path);
- if (wait) {
- struct timeval tv;
- tv.tv_sec = LIBXL_DESTROY_TIMEOUT;
- tv.tv_usec = 0;
- rc = libxl__wait_for_device_state(gc, &tv, XenbusStateClosed,
- destroy_device);
- if (rc < 0) /* an error or timeout occurred, clear watches */
- xs_unwatch(ctx->xsh, state_path, be_path);
- xs_rm(ctx->xsh, XBT_NULL, libxl__device_frontend_path(gc, dev));
- } else {
- rc = 1; /* Caller must wait_for_dev_destroy */
- }
+ aorm = libxl__zalloc(gc, sizeof(*aorm));
+ aorm->ao = ao;
+ libxl__ev_devstate_init(&aorm->ds);
-out:
+ rc = libxl__ev_devstate_wait(gc, &aorm->ds, device_remove_callback,
+ state_path, XenbusStateClosed,
+ LIBXL_DESTROY_TIMEOUT * 1000);
+ if (rc) goto out;
+
+ return 0;
+
+ out:
+ device_remove_cleanup(gc, aorm);
return rc;
}
diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index 6c87290..94ab681 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -652,35 +652,16 @@ _hidden char *libxl__device_backend_path(libxl__gc *gc, libxl__device *device);
_hidden char *libxl__device_frontend_path(libxl__gc *gc, libxl__device *device);
_hidden int libxl__parse_backend_path(libxl__gc *gc, const char *path,
libxl__device *dev);
-_hidden int libxl__device_remove(libxl__gc *gc, libxl__device *dev, int wait);
_hidden int libxl__device_destroy(libxl__gc *gc, libxl__device *dev);
_hidden int libxl__devices_destroy(libxl__gc *gc, uint32_t domid);
_hidden int libxl__wait_for_backend(libxl__gc *gc, char *be_path, char *state);
-/* Handler for the libxl__wait_for_device_state callback */
-/*
- * libxl__device_state_handler - Handler for the libxl__wait_for_device_state
- * gc: allocation pool
- * l1: array containing the path and token
- * state: string that contains the state of the device
- *
- * Returns 0 on success, and < 0 on error.
- */
-typedef int libxl__device_state_handler(libxl__gc *gc, char **l1, char *state);
-
-/*
- * libxl__wait_for_device_state - waits a given time for a device to
- * reach a given state
- * gc: allocation pool
- * tv: timeval struct containing the maximum time to wait
- * state: state to wait for (check xen/io/xenbus.h)
- * handler: callback function to execute when state is reached
- *
- * Returns 0 on success, and < 0 on error.
- */
-_hidden int libxl__wait_for_device_state(libxl__gc *gc, struct timeval *tv,
- XenbusState state,
- libxl__device_state_handler handler);
+_hidden int libxl__initiate_device_remove(libxl__ao*, libxl__device *dev);
+ /* Arranges that dev will be removed from its guest. When
+ * this is done, the ao will be completed. An error
+ * return from libxl__device_remove means that the ao
+ * will _not_ be completed and the caller must do so.
+ */
/*
* libxl__ev_devstate - waits a given time for a device to
diff --git a/tools/libxl/xl_cmdimpl.c b/tools/libxl/xl_cmdimpl.c
index b88fc8a..dda74b9 100644
--- a/tools/libxl/xl_cmdimpl.c
+++ b/tools/libxl/xl_cmdimpl.c
@@ -4616,7 +4616,7 @@ int main_networkdetach(int argc, char **argv)
return 1;
}
}
- if (libxl_device_nic_remove(ctx, domid, &nic)) {
+ if (libxl_device_nic_remove(ctx, domid, &nic, 0)) {
fprintf(stderr, "libxl_device_nic_del failed.\n");
return 1;
}
@@ -4711,7 +4711,7 @@ int main_blockdetach(int argc, char **argv)
fprintf(stderr, "Error: Device %s not connected.\n", argv[optind+1]);
return 1;
}
- if (libxl_device_disk_remove(ctx, domid, &disk)) {
+ if (libxl_device_disk_remove(ctx, domid, &disk, 0)) {
fprintf(stderr, "libxl_device_disk_remove failed.\n");
}
return 0;
--
1.7.2.5
^ permalink raw reply related [flat|nested] 43+ messages in thread* Re: [PATCH v6 00/10] libxl: event API
2012-01-06 20:34 [PATCH v6 00/10] libxl: event API Ian Jackson
` (14 preceding siblings ...)
2012-01-09 17:34 ` [PATCH 14/10] libxl: Convert to asynchronous: device removal Ian Jackson
@ 2012-01-13 14:50 ` Ian Campbell
2012-01-13 15:03 ` Ian Jackson
15 siblings, 1 reply; 43+ messages in thread
From: Ian Campbell @ 2012-01-13 14:50 UTC (permalink / raw)
To: Ian Jackson; +Cc: xen-devel@lists.xensource.com
On Fri, 2012-01-06 at 20:34 +0000, Ian Jackson wrote:
> This series is the latest revision of my event handling API. It
> includes changes in response to a number of comments made. It also
> includes a few new consequential patches and unrelated
> fixes/improvements, as usual.
>
> The most significant difference is the new "libxl__egc" type which is
> used instead of libxl__gc by event-generating functions. This
> prevents accidental violation of the callback reentrancy rules.
>
> I'm still working on this series. At the moment I'm working on
> providing asynchronous calls for long-running operations; this
> requires more support machinery which is still not finalised.
Do we require that the async stuff is complete before we can commit the
event stuff? Obviously the former makes heavy use of the later so I
guess there will be "knock-back" effects as you implement it but the
series is becoming quite unwieldy (and long lived) so maybe it'd be
better to push part 1 and fix it up as necessary when you do the async
stuff?
>
> Of the resulting patches in this series,
>
> These should perhaps go in soon:
> 01/10 libxl: make LIBXL_INIT_GC a statement, not an initialiser
> 03/10 libxl: move a lot more includes into libxl_internal.h
> 04/10 libxl: Provide more formal libxl__ctx_lock and _unlock
> 05/10 libxl: Fix leaks on context init failure
> 09/10 libxl: introduce libxl_fd_set_nonblock, rationalise _cloexec
>
> This one has now been tested and can go in IMO:
> 02/10 xenstore: New function xs_path_is_subpath
I agree that all the above can go in. I think I've acked them all.
> These are the meat:
> 07/10 libxl: New API for providing OS events to libxl
> 08/10 libxl: New event generation API
> 10/10 libxl: Permit multithreaded event waiting
>
> And this one has become rendered obsolete. If we are to retain the
> new libxl__egc structure, I will drop it. Otherwise it may still be
> needed, and it's disruptive, which is why I haven't dropped it from my
> series yet:
> 06/10 DROP: libxl: rename libxl__free_all
>
> _______________________________________________
> Xen-devel mailing list
> Xen-devel@lists.xensource.com
> http://lists.xensource.com/xen-devel
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH v6 00/10] libxl: event API
2012-01-13 14:50 ` [PATCH v6 00/10] libxl: event API Ian Campbell
@ 2012-01-13 15:03 ` Ian Jackson
2012-01-13 17:43 ` Ian Jackson
0 siblings, 1 reply; 43+ messages in thread
From: Ian Jackson @ 2012-01-13 15:03 UTC (permalink / raw)
To: Ian Campbell; +Cc: xen-devel@lists.xensource.com
Ian Campbell writes ("Re: [Xen-devel] [PATCH v6 00/10] libxl: event API"):
> Do we require that the async stuff is complete before we can commit the
> event stuff? Obviously the former makes heavy use of the later so I
> guess there will be "knock-back" effects as you implement it but the
> series is becoming quite unwieldy (and long lived) so maybe it'd be
> better to push part 1 and fix it up as necessary when you do the async
> stuff?
That's probably a good idea. I'm refreshing it and testing it.
> > These should perhaps go in soon:
> > 01/10 libxl: make LIBXL_INIT_GC a statement, not an initialiser
> > 03/10 libxl: move a lot more includes into libxl_internal.h
> > 04/10 libxl: Provide more formal libxl__ctx_lock and _unlock
> > 05/10 libxl: Fix leaks on context init failure
> > 09/10 libxl: introduce libxl_fd_set_nonblock, rationalise _cloexec
> >
> > This one has now been tested and can go in IMO:
> > 02/10 xenstore: New function xs_path_is_subpath
>
> I agree that all the above can go in. I think I've acked them all.
Right.
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread* Re: [PATCH v6 00/10] libxl: event API
2012-01-13 15:03 ` Ian Jackson
@ 2012-01-13 17:43 ` Ian Jackson
0 siblings, 0 replies; 43+ messages in thread
From: Ian Jackson @ 2012-01-13 17:43 UTC (permalink / raw)
To: Ian Campbell, xen-devel@lists.xensource.com
Ian Jackson writes ("Re: [Xen-devel] [PATCH v6 00/10] libxl: event API"):
> > > These should perhaps go in soon:
> > > 01/10 libxl: make LIBXL_INIT_GC a statement, not an initialiser
> > > 03/10 libxl: move a lot more includes into libxl_internal.h
> > > 04/10 libxl: Provide more formal libxl__ctx_lock and _unlock
> > > 05/10 libxl: Fix leaks on context init failure
> > > 09/10 libxl: introduce libxl_fd_set_nonblock, rationalise _cloexec
> > >
> > > This one has now been tested and can go in IMO:
> > > 02/10 xenstore: New function xs_path_is_subpath
> >
> > I agree that all the above can go in. I think I've acked them all.
I have applied 01-05 to xen-unstable. 09 has not yet been executed
(by me at least) so I think it should wait.
Thanks,
Ian.
^ permalink raw reply [flat|nested] 43+ messages in thread