nl-linux 0.2.4 → 0.3.0

data/generated/nl/linux/mptcp_pm.rb

@@ -1,4 +1,6 @@
 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
+#
+# This file is based on Documentation/netlink/specs/mptcp_pm.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
 # rbs_inline: enabled
@@ -9,6 +11,7 @@ module Nl; module Linux
 class MptcpPm < ::Nl::Family
   NAME = "mptcp_pm"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("mptcp_pm"))
+  MCAST_GROUPS = Ractor.make_shareable({}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
   end
   module AttributeSets
@@ -335,6 +338,8 @@ class MptcpPm < ::Nl::Family
   end
   module Messages
     # Add endpoint
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoAddAddrRequest < ::Nl::Protocols::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
@@ -346,6 +351,8 @@ class MptcpPm < ::Nl::Family
       def addr; attributes[:"addr"]&.value; end
     end
     # Delete endpoint
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoDelAddrRequest < ::Nl::Protocols::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
@@ -383,6 +390,13 @@ class MptcpPm < ::Nl::Family
       def addr; attributes[:"addr"]&.value; end
     end
     # Get endpoint information
+    class DumpGetAddrRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 3
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Attr
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # Get endpoint information
     class DumpGetAddrReply < ::Nl::Protocols::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
@@ -394,6 +408,8 @@ class MptcpPm < ::Nl::Family
       def addr; attributes[:"addr"]&.value; end
     end
     # Flush addresses
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoFlushAddrsRequest < ::Nl::Protocols::Genl::Message
       TYPE = 4
       FIXED_HEADER = nil
@@ -405,6 +421,8 @@ class MptcpPm < ::Nl::Family
       def addr; attributes[:"addr"]&.value; end
     end
     # Set protocol limits
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoSetLimitsRequest < ::Nl::Protocols::Genl::Message
       TYPE = 5
       FIXED_HEADER = nil
@@ -450,6 +468,8 @@ class MptcpPm < ::Nl::Family
       def subflows; attributes[:"subflows"]&.value; end
     end
     # Change endpoint flags
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoSetFlagsRequest < ::Nl::Protocols::Genl::Message
       TYPE = 7
       FIXED_HEADER = nil
@@ -469,6 +489,8 @@ class MptcpPm < ::Nl::Family
       def addr_remote; attributes[:"addr_remote"]&.value; end
     end
     # Announce new address
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoAnnounceRequest < ::Nl::Protocols::Genl::Message
       TYPE = 8
       FIXED_HEADER = nil
@@ -484,6 +506,8 @@ class MptcpPm < ::Nl::Family
       def token; attributes[:"token"]&.value; end
     end
     # Announce removal
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoRemoveRequest < ::Nl::Protocols::Genl::Message
       TYPE = 9
       FIXED_HEADER = nil
@@ -499,6 +523,8 @@ class MptcpPm < ::Nl::Family
       def loc_id; attributes[:"loc_id"]&.value; end
     end
     # Create subflow
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoSubflowCreateRequest < ::Nl::Protocols::Genl::Message
       TYPE = 10
       FIXED_HEADER = nil
@@ -518,6 +544,8 @@ class MptcpPm < ::Nl::Family
       def addr_remote; attributes[:"addr_remote"]&.value; end
     end
     # Destroy subflow
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoSubflowDestroyRequest < ::Nl::Protocols::Genl::Message
       TYPE = 11
       FIXED_HEADER = nil
@@ -537,13 +565,20 @@ class MptcpPm < ::Nl::Family
       def addr_remote; attributes[:"addr_remote"]&.value; end
     end
   end
+  module Notifications
+  end
+  NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # Add endpoint
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?addr: AttributeSets::Address) -> void
   def do_add_addr(**args)
     exchange_message(:"do", Messages::DoAddAddrRequest, nil, args)
   end
   # Delete endpoint
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?addr: AttributeSets::Address) -> void
   def do_del_addr(**args)
@@ -555,13 +590,24 @@ class MptcpPm < ::Nl::Family
   def do_get_addr(**args)
     exchange_message(:"do", Messages::DoGetAddrRequest, Messages::DoGetAddrReply, args)
   end
+  # Get endpoint information
+  #--
+  # @rbs () -> Enumerable[Messages::DumpGetAddrReply]
+  #   | () { (Messages::DumpGetAddrReply) -> void } -> void
+  def dump_get_addr(**args, &block)
+    exchange_message(:"dump", Messages::DumpGetAddrRequest, Messages::DumpGetAddrReply, args, &block)
+  end
   # Flush addresses
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?addr: AttributeSets::Address) -> void
   def do_flush_addrs(**args)
     exchange_message(:"do", Messages::DoFlushAddrsRequest, nil, args)
   end
   # Set protocol limits
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?rcv_add_addrs: ::Integer, ?subflows: ::Integer) -> void
   def do_set_limits(**args)
@@ -574,34 +620,147 @@ class MptcpPm < ::Nl::Family
     exchange_message(:"do", Messages::DoGetLimitsRequest, Messages::DoGetLimitsReply, args)
   end
   # Change endpoint flags
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?addr: AttributeSets::Address, ?token: ::Integer, ?addr_remote: AttributeSets::Address) -> void
   def do_set_flags(**args)
     exchange_message(:"do", Messages::DoSetFlagsRequest, nil, args)
   end
   # Announce new address
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?addr: AttributeSets::Address, ?token: ::Integer) -> void
   def do_announce(**args)
     exchange_message(:"do", Messages::DoAnnounceRequest, nil, args)
   end
   # Announce removal
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?token: ::Integer, ?loc_id: ::Integer) -> void
   def do_remove(**args)
     exchange_message(:"do", Messages::DoRemoveRequest, nil, args)
   end
   # Create subflow
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?addr: AttributeSets::Address, ?token: ::Integer, ?addr_remote: AttributeSets::Address) -> void
   def do_subflow_create(**args)
     exchange_message(:"do", Messages::DoSubflowCreateRequest, nil, args)
   end
   # Destroy subflow
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?addr: AttributeSets::Address, ?token: ::Integer, ?addr_remote: AttributeSets::Address) -> void
   def do_subflow_destroy(**args)
     exchange_message(:"do", Messages::DoSubflowDestroyRequest, nil, args)
   end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # Add endpoint
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?addr: AttributeSets::Address) -> ::Nl::Async::Future[void]
+    def do_add_addr(**args)
+      @exchange.call(:"do", Messages::DoAddAddrRequest, nil, args)
+    end
+    # Delete endpoint
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?addr: AttributeSets::Address) -> ::Nl::Async::Future[void]
+    def do_del_addr(**args)
+      @exchange.call(:"do", Messages::DoDelAddrRequest, nil, args)
+    end
+    # Get endpoint information
+    #--
+    # @rbs (?addr: AttributeSets::Address, ?token: ::Integer) -> ::Nl::Async::Future[Messages::DoGetAddrReply]
+    def do_get_addr(**args)
+      @exchange.call(:"do", Messages::DoGetAddrRequest, Messages::DoGetAddrReply, args)
+    end
+    # Get endpoint information
+    #--
+    # @rbs () -> ::Nl::Async::Stream[Messages::DumpGetAddrReply]
+    def dump_get_addr(**args)
+      @exchange.call(:"dump", Messages::DumpGetAddrRequest, Messages::DumpGetAddrReply, args)
+    end
+    # Flush addresses
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?addr: AttributeSets::Address) -> ::Nl::Async::Future[void]
+    def do_flush_addrs(**args)
+      @exchange.call(:"do", Messages::DoFlushAddrsRequest, nil, args)
+    end
+    # Set protocol limits
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?rcv_add_addrs: ::Integer, ?subflows: ::Integer) -> ::Nl::Async::Future[void]
+    def do_set_limits(**args)
+      @exchange.call(:"do", Messages::DoSetLimitsRequest, nil, args)
+    end
+    # Get protocol limits
+    #--
+    # @rbs (?rcv_add_addrs: ::Integer, ?subflows: ::Integer) -> ::Nl::Async::Future[Messages::DoGetLimitsReply]
+    def do_get_limits(**args)
+      @exchange.call(:"do", Messages::DoGetLimitsRequest, Messages::DoGetLimitsReply, args)
+    end
+    # Change endpoint flags
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?addr: AttributeSets::Address, ?token: ::Integer, ?addr_remote: AttributeSets::Address) -> ::Nl::Async::Future[void]
+    def do_set_flags(**args)
+      @exchange.call(:"do", Messages::DoSetFlagsRequest, nil, args)
+    end
+    # Announce new address
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?addr: AttributeSets::Address, ?token: ::Integer) -> ::Nl::Async::Future[void]
+    def do_announce(**args)
+      @exchange.call(:"do", Messages::DoAnnounceRequest, nil, args)
+    end
+    # Announce removal
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?token: ::Integer, ?loc_id: ::Integer) -> ::Nl::Async::Future[void]
+    def do_remove(**args)
+      @exchange.call(:"do", Messages::DoRemoveRequest, nil, args)
+    end
+    # Create subflow
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?addr: AttributeSets::Address, ?token: ::Integer, ?addr_remote: AttributeSets::Address) -> ::Nl::Async::Future[void]
+    def do_subflow_create(**args)
+      @exchange.call(:"do", Messages::DoSubflowCreateRequest, nil, args)
+    end
+    # Destroy subflow
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?addr: AttributeSets::Address, ?token: ::Integer, ?addr_remote: AttributeSets::Address) -> ::Nl::Async::Future[void]
+    def do_subflow_destroy(**args)
+      @exchange.call(:"do", Messages::DoSubflowDestroyRequest, nil, args)
+    end
+  end
+  # Returns the asynchronous operation facade for this family.
+  #--
+  # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+  def async(stream_capacity: nil)
+    return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
+    build_async_facade(AsyncOperations, stream_capacity:)
+  end
 end
 end; end

data/generated/nl/linux/net_shaper.rb

@@ -1,4 +1,6 @@
 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
+#
+# This file is based on Documentation/netlink/specs/net_shaper.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
 # rbs_inline: enabled
@@ -36,6 +38,7 @@ module Nl; module Linux
 class NetShaper < ::Nl::Family
   NAME = "net-shaper"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("net-shaper"))
+  MCAST_GROUPS = Ractor.make_shareable({}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
   end
   module AttributeSets
@@ -365,6 +368,9 @@ class NetShaper < ::Nl::Family
     # Create or update the specified shaper.
     # The set operation can't be used to create a `node` scope shaper,
     # use the `group` operation instead.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoSetRequest < ::Nl::Protocols::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
@@ -414,6 +420,9 @@ class NetShaper < ::Nl::Family
     # queue/device can still send traffic: it has an implicit
     # node with infinite bandwidth. The queue's implicit node
     # feeds an implicit RR node at the root of the hierarchy.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoDeleteRequest < ::Nl::Protocols::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
@@ -447,6 +456,9 @@ class NetShaper < ::Nl::Family
     # the device shaping configuration, otherwise the `node` shaper
     # full identifier, comprising `binding` and `handle`, is provided
     # as the reply.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoGroupRequest < ::Nl::Protocols::Genl::Message
       TYPE = 4
       FIXED_HEADER = nil
@@ -512,6 +524,9 @@ class NetShaper < ::Nl::Family
     # the device shaping configuration, otherwise the `node` shaper
     # full identifier, comprising `binding` and `handle`, is provided
     # as the reply.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoGroupReply < ::Nl::Protocols::Genl::Message
       TYPE = 4
       FIXED_HEADER = nil
@@ -651,6 +666,9 @@ class NetShaper < ::Nl::Family
       def support_weight; attributes[:"support_weight"]&.value; end
     end
   end
+  module Notifications
+  end
+  NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # Get information about a shaper for a given device.
   #--
   # @rbs (?handle: AttributeSets::Handle, ?ifindex: ::Integer) -> Messages::DoGetReply
@@ -667,6 +685,9 @@ class NetShaper < ::Nl::Family
   # Create or update the specified shaper.
   # The set operation can't be used to create a `node` scope shaper,
   # use the `group` operation instead.
+  # 
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?handle: AttributeSets::Handle, ?metric: ::Integer, ?bw_min: ::Integer, ?bw_max: ::Integer, ?burst: ::Integer, ?priority: ::Integer, ?weight: ::Integer, ?ifindex: ::Integer) -> void
   def do_set(**args)
@@ -683,6 +704,9 @@ class NetShaper < ::Nl::Family
   # queue/device can still send traffic: it has an implicit
   # node with infinite bandwidth. The queue's implicit node
   # feeds an implicit RR node at the root of the hierarchy.
+  # 
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?handle: AttributeSets::Handle, ?ifindex: ::Integer) -> void
   def do_delete(**args)
@@ -707,6 +731,9 @@ class NetShaper < ::Nl::Family
   # the device shaping configuration, otherwise the `node` shaper
   # full identifier, comprising `binding` and `handle`, is provided
   # as the reply.
+  # 
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?handle: AttributeSets::Handle, ?metric: ::Integer, ?bw_min: ::Integer, ?bw_max: ::Integer, ?burst: ::Integer, ?priority: ::Integer, ?weight: ::Integer, ?ifindex: ::Integer, ?parent: AttributeSets::Handle, ?leaves: AttributeSets::LeafInfo) -> Messages::DoGroupReply
   def do_group(**args)
@@ -727,5 +754,101 @@ class NetShaper < ::Nl::Family
   def dump_cap_get(**args, &block)
     exchange_message(:"dump", Messages::DumpCapGetRequest, Messages::DumpCapGetReply, args, &block)
   end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # Get information about a shaper for a given device.
+    #--
+    # @rbs (?handle: AttributeSets::Handle, ?ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoGetReply]
+    def do_get(**args)
+      @exchange.call(:"do", Messages::DoGetRequest, Messages::DoGetReply, args)
+    end
+    # Get information about a shaper for a given device.
+    #--
+    # @rbs (?ifindex: ::Integer) -> ::Nl::Async::Stream[Messages::DumpGetReply]
+    def dump_get(**args)
+      @exchange.call(:"dump", Messages::DumpGetRequest, Messages::DumpGetReply, args)
+    end
+    # Create or update the specified shaper.
+    # The set operation can't be used to create a `node` scope shaper,
+    # use the `group` operation instead.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?handle: AttributeSets::Handle, ?metric: ::Integer, ?bw_min: ::Integer, ?bw_max: ::Integer, ?burst: ::Integer, ?priority: ::Integer, ?weight: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+    def do_set(**args)
+      @exchange.call(:"do", Messages::DoSetRequest, nil, args)
+    end
+    # Clear (remove) the specified shaper. When deleting
+    # a `node` shaper, reattach all the node's leaves to the
+    # deleted node's parent.
+    # If, after the removal, the parent shaper has no more
+    # leaves and the parent shaper scope is `node`, the parent
+    # node is deleted, recursively.
+    # When deleting a `queue` shaper or a `netdev` shaper,
+    # the shaper disappears from the hierarchy, but the
+    # queue/device can still send traffic: it has an implicit
+    # node with infinite bandwidth. The queue's implicit node
+    # feeds an implicit RR node at the root of the hierarchy.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?handle: AttributeSets::Handle, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+    def do_delete(**args)
+      @exchange.call(:"do", Messages::DoDeleteRequest, nil, args)
+    end
+    # Create or update a scheduling group, attaching the specified
+    # `leaves` shapers under the specified node identified by `handle.`
+    # The `leaves` shapers scope must be `queue` and the node shaper
+    # scope must be either `node` or `netdev.`
+    # When the node shaper has `node` scope, if the `handle` `id` is not
+    # specified, a new shaper of such scope is created, otherwise the
+    # specified node must already exist.
+    # When updating an existing node shaper, the specified `leaves` are
+    # added to the existing node; such node will also retain any preexisting
+    # leave.
+    # The `parent` handle for a new node shaper defaults to the parent
+    # of all the leaves, provided all the leaves share the same parent.
+    # Otherwise `parent` handle must be specified.
+    # The user can optionally provide shaping attributes for the node
+    # shaper.
+    # The operation is atomic, on failure no change is applied to
+    # the device shaping configuration, otherwise the `node` shaper
+    # full identifier, comprising `binding` and `handle`, is provided
+    # as the reply.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?handle: AttributeSets::Handle, ?metric: ::Integer, ?bw_min: ::Integer, ?bw_max: ::Integer, ?burst: ::Integer, ?priority: ::Integer, ?weight: ::Integer, ?ifindex: ::Integer, ?parent: AttributeSets::Handle, ?leaves: AttributeSets::LeafInfo) -> ::Nl::Async::Future[Messages::DoGroupReply]
+    def do_group(**args)
+      @exchange.call(:"do", Messages::DoGroupRequest, Messages::DoGroupReply, args)
+    end
+    # Get the shaper capabilities supported by the given device
+    # for the specified scope.
+    #--
+    # @rbs (?ifindex: ::Integer, ?scope: ::Integer) -> ::Nl::Async::Future[Messages::DoCapGetReply]
+    def do_cap_get(**args)
+      @exchange.call(:"do", Messages::DoCapGetRequest, Messages::DoCapGetReply, args)
+    end
+    # Get the shaper capabilities supported by the given device
+    # for the specified scope.
+    #--
+    # @rbs (?ifindex: ::Integer) -> ::Nl::Async::Stream[Messages::DumpCapGetReply]
+    def dump_cap_get(**args)
+      @exchange.call(:"dump", Messages::DumpCapGetRequest, Messages::DumpCapGetReply, args)
+    end
+  end
+  # Returns the asynchronous operation facade for this family.
+  #--
+  # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+  def async(stream_capacity: nil)
+    return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
+    build_async_facade(AsyncOperations, stream_capacity:)
+  end
 end
 end; end