Skip to contentSkip to conversation

public/io/netif.h: document xenstore negotiation of multicast control

PATCH In review Paul Durrant 1 participant 2 messages Sep 2, 2015

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 public/io/netif.h: document xenstore negotiation of multicast control

netif.h contains a specification of the XEN_NETIF_EXTRA_TYPE_MCAST_{ADD,DEL} extra info messages require to manipulate a multicast filter list maintained by a backend but does not specify how the multicast contol feature should be negotiated in xenstore. This patch attempts to rectify that.

To determine the correct sequence I mined the xen-devel archives to ascertain the intention of the original submitter of the patch (see thread starting at
http://lists.xenproject.org/archives/html/xen-devel/2007-11/msg00687.html)
and also examined how the feature is implemented by the illumos xnb/xnf drivers, which I believe form the only concrete example.

Cc Ian Campbell <[email protected]>
Cc Ian Jackson <[email protected]>
Cc Jan Beulich <[email protected]>
Cc Keir Fraser <[email protected]>
Cc Tim Deegan <[email protected]>
---
 xen/include/public/io/netif.h |   13 +++++++++++++
 1 file changed, 13 insertions(+)
xen/include/public/io/netif.h +13 -0
index 353eab7..6599c5a 100644
@@ -136,6 +136,19 @@
  */
 
 /*
+ * "feature-multicast-control" advertises the capability to filter ethernet
+ * multicast packets in the backend. To enable use of this capability the
+ * frontend must set "request-multicast-control" before moving into the
+ * connected state.
+ * If "request-multicast-control" is set then the backend transmit side should
+ * drop any multicast packet that does not match in a filter list. The list is
+ * amended by the frontend by sending XEN_NETIF_EXTRA_TYPE_MCAST_{ADD,DEL}
+ * messages as specified below.
+ * Once enabled by the frontend, the feature cannot be disabled except by
+ * closing and re-connecting to the backend.
+ */
+
+/*
  * This is the 'wire' format for packets:
  *  Request 1: netif_tx_request_t -- NETTXF_* (any flags)
  * [Request 2: netif_extra_info_t] (only if request 1 has NETTXF_extra_info)
Signature · 1 line
1.7.10.4
#1 lore raw
Quoted 23 lines

-----Original Message-----
From: Paul Durrant [mailto:[email protected]]
Sent: 02 September 2015 11:24
To: [email protected]
Cc: Paul Durrant; Ian Campbell; Ian Jackson; Jan Beulich; Keir (Xen.org); Tim (Xen.org)
Subject: [PATCH] public/io/netif.h: document xenstore negotiation of multicast control

netif.h contains a specification of the XEN_NETIF_EXTRA_TYPE_MCAST_{ADD,DEL}
extra info messages require to manipulate a multicast filter list maintained by a backend but does not specify how the multicast contol feature should be negotiated in xenstore. This patch attempts to rectify that.

To determine the correct sequence I mined the xen-devel archives to ascertain the intention of the original submitter of the patch (see thread starting at
http://lists.xenproject.org/archives/html/xen-devel/2007-
11/msg00687.html)
and also examined how the feature is implemented by the illumos xnb/xnf drivers, which I believe form the only concrete example.

Quoted 6 lines
Cc Ian Campbell <[email protected]>
Cc Ian Jackson <[email protected]>
Cc Jan Beulich <[email protected]>
Cc Keir Fraser <[email protected]>
Cc Tim Deegan <[email protected]>

Sorry, I just missed the documentation as it's down with the extra type declaration. I'll re-factor this patch to move it.

Paul

Quoted 32 lines
---
 xen/include/public/io/netif.h |   13 +++++++++++++
 1 file changed, 13 insertions(+)
xen/include/public/io/netif.h +5 -0
index 353eab7..6599c5a 100644
@@ -136,6 +136,19 @@
  */
 
 /*
+ * "feature-multicast-control" advertises the capability to filter ethernet
+ * multicast packets in the backend. To enable use of this capability the
+ * frontend must set "request-multicast-control" before moving into the
+ * connected state.
+ * If "request-multicast-control" is set then the backend transmit side

should
+ * drop any multicast packet that does not match in a filter list. The list is
+ * amended by the frontend by sending XEN_NETIF_EXTRA_TYPE_MCAST_{ADD,DEL}
+ * messages as specified below.
+ * Once enabled by the frontend, the feature cannot be disabled except by
+ * closing and re-connecting to the backend.
+ */

xen/include/public/io/netif.h +2 -1
+
+/*
  * This is the 'wire' format for packets:
  *  Request 1: netif_tx_request_t -- NETTXF_* (any flags)
  * [Request 2: netif_extra_info_t] (only if request 1 has NETTXF_extra_info)
--

1.7.10.4