github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-09-22 12:44:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

net_shaper: clarify the kernel API / comments

Browse Source 
The shaper API takes some getting used to. Try to improve
the doc on struct net_shaper_ops to help driver developers.

Link: https://patch.msgid.link/20260724210756.1553565-3-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Jakub Kicinski 2026-07-24 14:07:55 -07:00
parent 16812d9674
commit 26bc4cfb17
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
include/net/net_shaper.h
View File

@ -68,7 +68,7 @@ struct net_shaper {
* The operations are serialized via a per device lock.
*
* Device not supporting any kind of nesting should not provide the
* group operation.
* @group operation.
*
* Each shaper is uniquely identified within the device with a 'handle'
* comprising the shaper scope and a scope-specific id.
@ -84,16 +84,30 @@ struct net_shaper {
* only allowed to construct groups with queues as leaves)
* - @group calls may update leaf's parent if the parent is about
* to be removed (re-parenting nodes explicitly is not supported in the uAPI)
*
* Implicit creation
* -----------------
* Shapers are created implicitly, meaning that @set and @group operations
* are called both for existing and new shapers. The driver has to infer
* whether the operation is an update or a creation by tracking the handles.
* Removal of shapers is explicit and done with a @delete call.
*
* The @set operation implicitly creates NET_SHAPER_SCOPE_NETDEV and
* NET_SHAPER_SCOPE_QUEUE shapers.
* The @group operation implicitly creates NET_SHAPER_SCOPE_NETDEV and
* NET_SHAPER_SCOPE_NODE shapers (the group shaper itself), as well as
* NET_SHAPER_SCOPE_QUEUE shapers (leaves).
*/
struct net_shaper_ops {
/**
* @group: create the specified shapers scheduling group
* @group: create a scheduling group or add leaves
*
* Nest the @leaves shapers identified under the * @node shaper.
* Nest the @leaves shapers identified under the @node shaper.
* All the shapers belong to the device specified by @binding.
* The @leaves arrays size is specified by @leaves_count.
* Create either the @leaves and the @node shaper; or if they already
* exists, links them together in the desired way.
* The @leaves array's size is specified by @leaves_count.
*
* @node and @leaves may or may not already exist
* (see the "Implicit creation" note).
*/
int (*group)(struct net_shaper_binding *binding, int leaves_count,
const struct net_shaper *leaves,