| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-Id: <20220811022304.583300-3-kuba@kernel.org>
Date: Wed, 10 Aug 2022 19:23:02 -0700
From: Jakub Kicinski <kuba@...nel.org>
To: netdev@...r.kernel.org, davem@...emloft.net, edumazet@...gle.com,
pabeni@...hat.com
Cc: sdf@...gle.com, jacob.e.keller@...el.com, vadfed@...com,
johannes@...solutions.net, jiri@...nulli.us, dsahern@...nel.org,
stephen@...workplumber.org, fw@...len.de,
linux-doc@...r.kernel.org, Jakub Kicinski <kuba@...nel.org>
Subject: [RFC net-next 2/4] ynl: add the schema for the schemas
A schema in jsonschema format which should be familiar
to dt-bindings writers. It looks kinda hard to read, TBH,
I'm not sure how to make it better.
Signed-off-by: Jakub Kicinski <kuba@...nel.org>
---
Documentation/netlink/schema.yaml | 242 ++++++++++++++++++++++++++++++
1 file changed, 242 insertions(+)
create mode 100644 Documentation/netlink/schema.yaml
diff --git a/Documentation/netlink/schema.yaml b/Documentation/netlink/schema.yaml
new file mode 100644
index 000000000000..1290aa4794ba
--- /dev/null
+++ b/Documentation/netlink/schema.yaml
@@ -0,0 +1,242 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: "http://kernel.org/schemas/netlink/schema.yaml#"
+$schema: "http://kernel.org/meta-schemas/core.yaml#"
+
+title: Protocol
+description: Specification of a genetlink protocol
+type: object
+required: [ name, description, attribute-spaces, operations ]
+additionalProperties: False
+properties:
+ name:
+ description: Name of the genetlink family
+ type: string
+ description:
+ description: Description of the family
+ type: string
+ version:
+ description: Version of the family as defined by genetlink.
+ type: integer
+ attr-cnt-suffix:
+ description: Suffix for last member of attribute enum, default is "MAX".
+ type: string
+ headers:
+ description: C headers defining the protocol
+ type: object
+ additionalProperties: False
+ properties:
+ uapi:
+ description: Path under include/uapi where protocol definition is placed
+ type: string
+ kernel:
+ description: Additional headers on which the protocol definition depends (kernel side)
+ anyOf: &str-or-arrstr
+ -
+ type: array
+ items:
+ type: string
+ -
+ type: string
+ user:
+ description: Additional headers on which the protocol definition depends (user side)
+ anyOf: *str-or-arrstr
+ constants:
+ description: Enums and defines of the protocol
+ type: array
+ items:
+ type: object
+ required: [ type, name ]
+ additionalProperties: False
+ properties:
+ name:
+ type: string
+ type:
+ enum: [ enum, flags ]
+ value-prefix:
+ description: For enum the prefix of the values, optional.
+ type: string
+ value-start:
+ description: For enum the literal initializer for the first value.
+ oneOf: [ { type: string }, { type: integer }]
+ values:
+ description: For enum array of values
+ type: array
+ items:
+ type: string
+
+ attribute-spaces:
+ description: Definition of attribute spaces for this family.
+ type: array
+ items:
+ description: Definition of a single attribute space.
+ type: object
+ required: [ name, attributes ]
+ additionalProperties: False
+ properties:
+ name:
+ description: |
+ Name used when referring to this space in other definitions, not used outside of YAML.
+ type: string
+ # Strictly speaking 'name-prefix' and 'subspace-of' should be mutually exclusive.
+ name-prefix:
+ description: Prefix for the C enum name of the attributes.
+ type: string
+ name-enum:
+ description: Name for the enum type of the attribute.
+ type: string
+ description:
+ description: Documentation of the space.
+ type: string
+ subspace-of:
+ description: |
+ Name of another space which this is a logical part of. Sub-spaces can be used to define
+ a limitted group of attributes which are used in a nest.
+ type: string
+ attributes:
+ description: List of attributes in the space.
+ type: array
+ items:
+ type: object
+ required: [ name, type ]
+ additionalProperties: False
+ properties:
+ name:
+ type: string
+ type: &attr-type
+ enum: [ unused, flag, binary, u8, u16, u32, u64, s32, s64,
+ nul-string, multi-attr, nest, array-nest, nest-type-value ]
+ description:
+ description: Documentation of the attribute.
+ type: string
+ type-value:
+ description: Name of the value extracted from the type of a nest-type-value attribute.
+ type: array
+ items:
+ type: string
+ len:
+ oneOf: [ { type: string }, { type: integer }]
+ sub-type: *attr-type
+ nested-attributes:
+ description: Name of the space (sub-space) used inside the attribute.
+ type: string
+ enum:
+ description: Name of the enum used for the atttribute.
+ type: string
+ flags-mask:
+ description: Name of the flags constant on which to base mask (unsigned scalar types only).
+ type: string
+ operations:
+ description: Operations supported by the protocol.
+ type: object
+ required: [ name-prefix, list ]
+ additionalProperties: False
+ properties:
+ name-prefix:
+ description: |
+ Prefix for the C enum name of the command. The name is formed by concatenating
+ the prefix with the upper case name of the command, with dashes replaced by underscores.
+ type: string
+ name-enum:
+ description: Name for the enum type with commands.
+ type: string
+ async-prefix:
+ description: Same as name-prefix but used to render notifications and events to separate enum.
+ type: string
+ async-enum:
+ description: Name for the enum type with notifications/events.
+ type: string
+ list:
+ description: List of commands
+ type: array
+ items:
+ type: object
+ additionalProperties: False
+ required: [ name, description ]
+ properties:
+ name:
+ description: Name of the operation, also defining its C enum value in uAPI.
+ type: string
+ description:
+ description: Documentation for the command.
+ type: string
+ value:
+ description: Value for the enum in the uAPI.
+ type: integer
+ attribute-space:
+ description: |
+ Attribute space from which attributes directly in the requests and replies
+ to this command are defined.
+ type: string
+ flags: &cmd_flags
+ description: Command flags.
+ type: array
+ items:
+ enum: [ admin-perm ]
+ dont-validate:
+ description: Kernel attribute validation flags.
+ type: array
+ items:
+ enum: [ strict, dump ]
+ do: &subop-type
+ description: Main command handler.
+ type: object
+ additionalProperties: False
+ properties:
+ request: &subop-attr-list
+ description: Definition of the request message for a given command.
+ type: object
+ additionalProperties: False
+ properties:
+ attributes:
+ description: |
+ Names of attributes from the attribute-space (not full attribute
+ definitions, just names).
+ type: array
+ items:
+ type: string
+ reply: *subop-attr-list
+ dump: *subop-type
+ notify:
+ description: Name of the command sharing the reply type with this notification.
+ type: string
+ event:
+ description: Explicit list of the attributes for the notification.
+ type: array
+ items:
+ type: string
+ mcgrp:
+ description: Name of the multicast group generating given notification.
+ type: string
+ mcast-groups:
+ description: List of multicast groups.
+ type: object
+ required: [ name-prefix, list ]
+ additionalProperties: False
+ properties:
+ name-prefix:
+ description: Name prefix for the define associated with the group.
+ type: string
+ name-suffix:
+ description: |
+ Name suffix for the define associated with the group. Multicast group defines seem to be unique
+ in having a name-prefix as well as suffix.
+ type: string
+ list:
+ description: List of groups.
+ type: array
+ items:
+ type: object
+ required: [ name ]
+ additionalProperties: False
+ properties:
+ name:
+ description: |
+ The name for the group, used to form the define and the value of the define, unless value
+ is specified separately.
+ type: string
+ value:
+ description: String value for the define and group name.
+ type: string
+ flags: *cmd_flags
--
2.37.1
Powered by blists - more mailing lists