From: Donald Hunter <donald.hunter@gmail.com>
To: netdev@vger.kernel.org, Jakub Kicinski <kuba@kernel.org>,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Paolo Abeni <pabeni@redhat.com>, Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org
Cc: donald.hunter@redhat.com, Donald Hunter <donald.hunter@gmail.com>
Subject: [PATCH net-next v5 7/7] docs: netlink: document the sub-type attribute property
Date: Mon, 27 Mar 2023 09:31:38 +0100 [thread overview]
Message-ID: <20230327083138.96044-8-donald.hunter@gmail.com> (raw)
In-Reply-To: <20230327083138.96044-1-donald.hunter@gmail.com>
Add a definition for sub-type to the protocol spec doc and a description of
its usage for C arrays in genetlink-legacy.
Signed-off-by: Donald Hunter <donald.hunter@gmail.com>
---
.../userspace-api/netlink/genetlink-legacy.rst | 14 ++++++++++++++
Documentation/userspace-api/netlink/specs.rst | 10 ++++++++++
2 files changed, 24 insertions(+)
diff --git a/Documentation/userspace-api/netlink/genetlink-legacy.rst b/Documentation/userspace-api/netlink/genetlink-legacy.rst
index b8fdcf7f6615..802875a37a27 100644
--- a/Documentation/userspace-api/netlink/genetlink-legacy.rst
+++ b/Documentation/userspace-api/netlink/genetlink-legacy.rst
@@ -234,6 +234,20 @@ specify a sub-type.
type: binary
struct: vport-stats
+C Arrays
+--------
+
+Legacy families also use ``binary`` attributes to encapsulate C arrays. The
+``sub-type`` is used to identify the type of scalar to extract.
+
+.. code-block:: yaml
+
+ attributes:
+ -
+ name: ports
+ type: binary
+ sub-type: u32
+
Multi-message DO
----------------
diff --git a/Documentation/userspace-api/netlink/specs.rst b/Documentation/userspace-api/netlink/specs.rst
index a22442ba1d30..2e4acde890b7 100644
--- a/Documentation/userspace-api/netlink/specs.rst
+++ b/Documentation/userspace-api/netlink/specs.rst
@@ -254,6 +254,16 @@ rather than depend on what is specified in the spec file.
The validation policy in the kernel is formed by combining the type
definition (``type`` and ``nested-attributes``) and the ``checks``.
+sub-type
+~~~~~~~~
+
+Legacy families have special ways of expressing arrays. ``sub-type`` can be
+used to define the type of array members in case array members are not
+fully defined as attributes (in a bona fide attribute space). For instance
+a C array of u32 values can be specified with ``type: binary`` and
+``sub-type: u32``. Binary types and legacy array formats are described in
+more detail in :doc:`genetlink-legacy`.
+
operations
----------
--
2.39.0
next prev parent reply other threads:[~2023-03-27 8:38 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-27 8:31 [PATCH net-next v5 0/7] ynl: add support for user headers and struct attrs Donald Hunter
2023-03-27 8:31 ` [PATCH net-next v5 1/7] tools: ynl: Add struct parsing to nlspec Donald Hunter
2023-03-27 8:31 ` [PATCH net-next v5 2/7] tools: ynl: Add C array attribute decoding to ynl Donald Hunter
2023-03-27 8:31 ` [PATCH net-next v5 3/7] tools: ynl: Add struct attr " Donald Hunter
2023-03-27 8:31 ` [PATCH net-next v5 4/7] tools: ynl: Add fixed-header support " Donald Hunter
2023-03-27 8:31 ` [PATCH net-next v5 5/7] netlink: specs: add partial specification for openvswitch Donald Hunter
2023-03-27 8:31 ` [PATCH net-next v5 6/7] docs: netlink: document struct support for genetlink-legacy Donald Hunter
2023-03-27 12:44 ` Bagas Sanjaya
2023-03-27 14:39 ` Akira Yokosawa
2023-03-28 8:38 ` Bagas Sanjaya
2023-03-27 8:31 ` Donald Hunter [this message]
2023-03-27 12:45 ` [PATCH net-next v5 7/7] docs: netlink: document the sub-type attribute property Bagas Sanjaya
2023-03-29 7:00 ` [PATCH net-next v5 0/7] ynl: add support for user headers and struct attrs patchwork-bot+netdevbpf
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230327083138.96044-8-donald.hunter@gmail.com \
--to=donald.hunter@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=donald.hunter@redhat.com \
--cc=edumazet@google.com \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.