Skip to contentSkip to conversation

xen: fix a potential crash in xen-bus

PATCH In review Paul Durrant 1 participant 5 messages Sep 13, 2019

lore
Share & tools
lore
#0 lore raw

v3 cover xen: fix a potential crash in xen-bus

This series fixes a potential segfault caused by NotifierList corruption in xen-bus. The first two patches lay the groundwork and the third actually fixes the problem.

Paul Durrant (3):
xen / notify: introduce a new XenWatchList abstraction
xen: introduce separate XenWatchList for XenDevice objects
xen: perform XenDevice clean-up in XenBus watch handler

 hw/xen/trace-events      |   9 +-
 hw/xen/xen-bus.c         | 277 ++++++++++++++++++++++++++++-----------
 include/hw/xen/xen-bus.h |   8 +-
 include/qemu/notify.h    |   2 +
 util/notify.c            |   5 +
 5 files changed, 220 insertions(+), 81 deletions(-)

---
Cc: Anthony Perard <[email protected]>
Cc: Stefano Stabellini <[email protected]>

Signature · 1 line
2.20.1.2.gb21ebb6
#1 lore raw

PATCH v3 1/3 xen / notify: introduce a new XenWatchList abstraction

Xenstore watch call-backs are already abstracted away from XenBus using the XenWatch data structure but the associated NotifierList manipulation and file handle registration is still open coded in various xen_bus_...() functions.
This patch creates a new XenWatchList data structure to allow these interactions to be abstracted away from XenBus as well. This is in preparation for a subsequent patch which will introduce separate watch lists for XenBus and XenDevice objects.

NOTE: This patch also introduces a new notifier_list_empty() helper function
for the purposes of adding an assertion that a XenWatchList is not freed whilst its associated NotifierList is still occupied.

---
Cc: Stefano Stabellini <[email protected]>

---
 hw/xen/trace-events      |   5 +-
 hw/xen/xen-bus.c         | 117 +++++++++++++++++++++++++--------------
 include/hw/xen/xen-bus.h |   3 +-
 include/qemu/notify.h    |   2 +
 util/notify.c            |   5 ++
 5 files changed, 87 insertions(+), 45 deletions(-)
hw/xen/trace-events +2 -3
index bc82ecb1a5..ac8d9c20d2 100644
@@ -19,9 +19,8 @@ xen_bus_unrealize(void) ""
 xen_bus_enumerate(void) ""
 xen_bus_type_enumerate(const char *type) "type: %s"
 xen_bus_backend_create(const char *type, const char *path) "type: %s path: %s"
-xen_bus_add_watch(const char *node, const char *key, char *token) "node: %s key: %s token: %s"
-xen_bus_remove_watch(const char *node, const char *key, char *token) "node: %s key: %s token: %s"
-xen_bus_watch(const char *token) "token: %s"
+xen_bus_add_watch(const char *node, const char *key) "node: %s key: %s"
+xen_bus_remove_watch(const char *node, const char *key) "node: %s key: %s"
 xen_device_realize(const char *type, char *name) "type: %s name: %s"
 xen_device_unrealize(const char *type, char *name) "type: %s name: %s"
 xen_device_backend_state(const char *type, char *name, const char *state) "type: %s name: %s -> %s"
hw/xen/xen-bus.c +76 -41

156 lines not on this page · raw message

include/hw/xen/xen-bus.h +2 -1
index 1c2d9dfdb8..88b84e29bb 100644
@@ -14,6 +14,7 @@
 
 typedef void (*XenWatchHandler)(void *opaque);
 
+typedef struct XenWatchList XenWatchList;
 typedef struct XenWatch XenWatch;
 typedef struct XenEventChannel XenEventChannel;
 
@@ -63,7 +64,7 @@ typedef struct XenBus {
     BusState qbus;
     domid_t backend_id;
     struct xs_handle *xsh;
-    NotifierList watch_notifiers;
+    XenWatchList *watch_list;
     XenWatch *backend_watch;
 } XenBus;
 
include/qemu/notify.h +2 -0
index a3d73e4bc7..bcfa70fb2e 100644
@@ -40,6 +40,8 @@ void notifier_remove(Notifier *notifier);
 
 void notifier_list_notify(NotifierList *list, void *data);
 
+bool notifier_list_empty(NotifierList *list);
+
 /* Same as Notifier but allows .notify() to return errors */
 typedef struct NotifierWithReturn NotifierWithReturn;
 
util/notify.c +5 -0
index aee8d93cb0..76bab212ae 100644
@@ -40,6 +40,11 @@ void notifier_list_notify(NotifierList *list, void *data)
     }
 }
 
+bool notifier_list_empty(NotifierList *list)
+{
+    return QLIST_EMPTY(&list->notifiers);
+}
+
 void notifier_with_return_list_init(NotifierWithReturnList *list)
 {
     QLIST_INIT(&list->notifiers);
Signature · 1 line
2.20.1.2.gb21ebb6
#2 lore raw

PATCH v3 2/3 xen: introduce separate XenWatchList for XenDevice objects

In reply to Paul Durrant

This patch uses the XenWatchList abstraction to add a separate watch list for each device. This is more scalable than walking a single notifier list for all watches and is also necessary to implement a bug-fix in a subsequent patch.

---
Cc: Stefano Stabellini <[email protected]>

---
 hw/xen/trace-events      |  2 ++
 hw/xen/xen-bus.c         | 72 ++++++++++++++++++++++++++++++++--------
 include/hw/xen/xen-bus.h |  2 ++
 3 files changed, 62 insertions(+), 14 deletions(-)
hw/xen/trace-events +2 -0
index ac8d9c20d2..80ce3dafad 100644
@@ -29,6 +29,8 @@ xen_device_backend_changed(const char *type, char *name) "type: %s name: %s"
 xen_device_frontend_state(const char *type, char *name, const char *state) "type: %s name: %s -> %s"
 xen_device_frontend_changed(const char *type, char *name) "type: %s name: %s"
 xen_device_unplug(const char *type, char *name) "type: %s name: %s"
+xen_device_add_watch(const char *type, char *name, const char *node, const char *key) "type: %s name: %s node: %s key: %s"
+xen_device_remove_watch(const char *type, char *name, const char *node, const char *key) "type: %s name: %s node: %s key: %s"
 
 # xen-bus-helper.c
 xs_node_create(const char *node) "%s"
hw/xen/xen-bus.c +58 -14

139 lines not on this page · raw message

include/hw/xen/xen-bus.h +2 -0
index 88b84e29bb..0d198148f6 100644
@@ -22,6 +22,8 @@ typedef struct XenDevice {
     DeviceState qdev;
     domid_t frontend_id;
     char *name;
+    struct xs_handle *xsh;
+    XenWatchList *watch_list;
     char *backend_path, *frontend_path;
     enum xenbus_state backend_state, frontend_state;
     Notifier exit;
Signature · 1 line
2.20.1.2.gb21ebb6
#3 lore raw
In reply to Paul Durrant

I typo-ed 'xen-devel'. I'll re-send.

Paul

Quoted 28 lines

-----Original Message-----
From: Paul Durrant <[email protected]>
Sent: 13 September 2019 09:21
To: [email protected]; [email protected]
Cc: Paul Durrant <[email protected]>; Anthony Perard <[email protected]>; Stefano Stabellini <[email protected]>
Subject: [PATCH v3 0/3] xen: fix a potential crash in xen-bus

This series fixes a potential segfault caused by NotifierList corruption in xen-bus. The first two patches lay the groundwork and the third actually fixes the problem.

Paul Durrant (3):
xen / notify: introduce a new XenWatchList abstraction
xen: introduce separate XenWatchList for XenDevice objects
xen: perform XenDevice clean-up in XenBus watch handler

 hw/xen/trace-events      |   9 +-
 hw/xen/xen-bus.c         | 277 ++++++++++++++++++++++++++++-----------
 include/hw/xen/xen-bus.h |   8 +-
 include/qemu/notify.h    |   2 +
 util/notify.c            |   5 +
 5 files changed, 220 insertions(+), 81 deletions(-)

---
Cc: Anthony Perard <[email protected]>
Cc: Stefano Stabellini <[email protected]>
--
2.20.1.2.gb21ebb6

#4 lore raw

PATCH v3 3/3 xen: perform XenDevice clean-up in XenBus watch handler

In reply to Paul Durrant

Cleaning up offline XenDevice objects directly in xen_device_backend_changed() is dangerous as xen_device_unrealize() will modify the watch list that is being walked. Even the QLIST_FOREACH_SAFE() used in notifier_list_notify() is insufficient as *two* notifiers (for the frontend and backend watches) are removed, thus potentially rendering the 'next' pointer unsafe.

The solution is to use the XenBus backend_watch handler to do the clean-up instead, as it is invoked whilst walking a separate watch list.

This patch therefore adds a new 'inactive_devices' list to XenBus, to which offline devices are added by xen_device_backend_changed(). The XenBus backend_watch registration is also changed to not only invoke xen_bus_enumerate() but also a new xen_bus_cleanup() function, which will walk 'inactive_devices' and perform the necessary actions.
For safety an extra 'online' check is also added to xen_bus_type_enumerate() to make sure that no attempt is made to create a new XenDevice object for a backend that is offline.

NOTE: This patch also includes some cosmetic changes:
- substitute the local variable name 'backend_state'
in xen_bus_type_enumerate() with 'state', since there is no ambiguity with any other state in that context.
- change xen_device_state_is_active() to xen_device_frontend_is_active() (and pass a XenDevice directly) since the state tests contained therein only apply to a frontend.
- use 'state' rather then 'xendev->backend_state' in xen_device_backend_changed() to shorten the code.

---
Cc: Stefano Stabellini <[email protected]>
Cc: Anthony Perard <[email protected]>

v3:
- s/offline_devices/inactive_devices/g
- Also add an 'inactive' boolean to XenDevice which is set when the device is added to the inactive list so we really can make sure that it doesn't happen more than once

v2:
- Make sure we don't try to add a XenDevice to 'offline_devices' more than once

---
 hw/xen/trace-events      |  2 +
 hw/xen/xen-bus.c         | 94 +++++++++++++++++++++++++++++-----------
 include/hw/xen/xen-bus.h |  3 ++
 3 files changed, 74 insertions(+), 25 deletions(-)
hw/xen/trace-events +2 -0
index 80ce3dafad..e6885bc751 100644
@@ -17,8 +17,10 @@ xen_domid_restrict(int err) "err: %u"
 xen_bus_realize(void) ""
 xen_bus_unrealize(void) ""
 xen_bus_enumerate(void) ""
+xen_bus_cleanup(void) ""
 xen_bus_type_enumerate(const char *type) "type: %s"
 xen_bus_backend_create(const char *type, const char *path) "type: %s path: %s"
+xen_bus_device_cleanup(const char *type, char *name) "type: %s name: %s"
 xen_bus_add_watch(const char *node, const char *key) "node: %s key: %s"
 xen_bus_remove_watch(const char *node, const char *key) "node: %s key: %s"
 xen_device_realize(const char *type, char *name) "type: %s name: %s"
hw/xen/xen-bus.c +69 -25

143 lines not on this page · raw message

include/hw/xen/xen-bus.h +3 -0
index 0d198148f6..3d5532258d 100644
@@ -32,7 +32,9 @@ typedef struct XenDevice {
     XenWatch *backend_online_watch;
     xengnttab_handle *xgth;
     bool feature_grant_copy;
+    bool inactive;
     QLIST_HEAD(, XenEventChannel) event_channels;
+    QLIST_ENTRY(XenDevice) list;
 } XenDevice;
 
 typedef char *(*XenDeviceGetName)(XenDevice *xendev, Error **errp);
@@ -68,6 +70,7 @@ typedef struct XenBus {
     struct xs_handle *xsh;
     XenWatchList *watch_list;
     XenWatch *backend_watch;
+    QLIST_HEAD(, XenDevice) inactive_devices;
 } XenBus;
 
 typedef struct XenBusClass {
Signature · 1 line
2.20.1.2.gb21ebb6