nl-linux 0.2.4 → 0.3.0

data/generated/nl/linux/netdev.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/netdev.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
 # rbs_inline: enabled
@@ -9,6 +11,7 @@ module Nl; module Linux
 class Netdev < ::Nl::Family
   NAME = "netdev"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("netdev"))
+  MCAST_GROUPS = Ractor.make_shareable({:"mgmt" => ::Nl::McastGroup.new("mgmt", nil), :"page_pool" => ::Nl::McastGroup.new("page-pool", nil)}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
   end
   module AttributeSets
@@ -743,6 +746,13 @@ class Netdev < ::Nl::Family
       def xsk_features; attributes[:"xsk_features"]&.value; end
     end
     # Get / dump information about a netdev.
+    class DumpDevGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # Get / dump information about a netdev.
     class DumpDevGetReply < ::Nl::Protocols::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
@@ -1368,6 +1378,8 @@ class Netdev < ::Nl::Family
       def tx_wake; attributes[:"tx_wake"]&.value; end
     end
     # Bind dmabuf to netdev
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoBindRxRequest < ::Nl::Protocols::Genl::Message
       TYPE = 13
       FIXED_HEADER = nil
@@ -1387,6 +1399,8 @@ class Netdev < ::Nl::Family
       def fd; attributes[:"fd"]&.value; end
     end
     # Bind dmabuf to netdev
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
     class DoBindRxReply < ::Nl::Protocols::Genl::Message
       TYPE = 13
       FIXED_HEADER = nil
@@ -1398,6 +1412,8 @@ class Netdev < ::Nl::Family
       def id; attributes[:"id"]&.value; end
     end
     # Set configurable NAPI instance settings.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoNapiSetRequest < ::Nl::Protocols::Genl::Message
       TYPE = 14
       FIXED_HEADER = nil
@@ -1452,6 +1468,9 @@ class Netdev < ::Nl::Family
     end
     # Create a new queue for the given netdevice. Whether this operation
     # is supported depends on the device and the driver.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoQueueCreateRequest < ::Nl::Protocols::Genl::Message
       TYPE = 16
       FIXED_HEADER = nil
@@ -1472,6 +1491,9 @@ class Netdev < ::Nl::Family
     end
     # Create a new queue for the given netdevice. Whether this operation
     # is supported depends on the device and the driver.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoQueueCreateReply < ::Nl::Protocols::Genl::Message
       TYPE = 16
       FIXED_HEADER = nil
@@ -1483,12 +1505,232 @@ class Netdev < ::Nl::Family
       def id; attributes[:"id"]&.value; end
     end
   end
+  module Notifications
+    # Notification about device appearing.
+    # 
+    # Multicast group: `mgmt`.
+    class DevAddNtf < ::Nl::Protocols::Genl::Message
+      TYPE = 2
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[ifindex xdp_features xdp_zc_max_segs xdp_rx_metadata_features xsk_features])
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `xdp-features` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xdp_features; attributes[:"xdp_features"]&.value; end
+      # Gets the value of `xdp-zc-max-segs` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xdp_zc_max_segs; attributes[:"xdp_zc_max_segs"]&.value; end
+      # Gets the value of `xdp-rx-metadata-features` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xdp_rx_metadata_features; attributes[:"xdp_rx_metadata_features"]&.value; end
+      # Gets the value of `xsk-features` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xsk_features; attributes[:"xsk_features"]&.value; end
+    end
+    # Notification about device disappearing.
+    # 
+    # Multicast group: `mgmt`.
+    class DevDelNtf < ::Nl::Protocols::Genl::Message
+      TYPE = 3
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[ifindex xdp_features xdp_zc_max_segs xdp_rx_metadata_features xsk_features])
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `xdp-features` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xdp_features; attributes[:"xdp_features"]&.value; end
+      # Gets the value of `xdp-zc-max-segs` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xdp_zc_max_segs; attributes[:"xdp_zc_max_segs"]&.value; end
+      # Gets the value of `xdp-rx-metadata-features` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xdp_rx_metadata_features; attributes[:"xdp_rx_metadata_features"]&.value; end
+      # Gets the value of `xsk-features` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xsk_features; attributes[:"xsk_features"]&.value; end
+    end
+    # Notification about device configuration being changed.
+    # 
+    # Multicast group: `mgmt`.
+    class DevChangeNtf < ::Nl::Protocols::Genl::Message
+      TYPE = 4
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Dev
+      ATTRIBUTES = Ractor.make_shareable(%i[ifindex xdp_features xdp_zc_max_segs xdp_rx_metadata_features xsk_features])
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `xdp-features` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xdp_features; attributes[:"xdp_features"]&.value; end
+      # Gets the value of `xdp-zc-max-segs` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xdp_zc_max_segs; attributes[:"xdp_zc_max_segs"]&.value; end
+      # Gets the value of `xdp-rx-metadata-features` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xdp_rx_metadata_features; attributes[:"xdp_rx_metadata_features"]&.value; end
+      # Gets the value of `xsk-features` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def xsk_features; attributes[:"xsk_features"]&.value; end
+    end
+    # Notification about page pool appearing.
+    # 
+    # Multicast group: `page-pool`.
+    class PagePoolAddNtf < ::Nl::Protocols::Genl::Message
+      TYPE = 6
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::PagePool
+      ATTRIBUTES = Ractor.make_shareable(%i[id ifindex napi_id inflight inflight_mem detach_time dmabuf io_uring])
+      # Gets the value of `id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def id; attributes[:"id"]&.value; end
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `napi-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def napi_id; attributes[:"napi_id"]&.value; end
+      # Gets the value of `inflight` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def inflight; attributes[:"inflight"]&.value; end
+      # Gets the value of `inflight-mem` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def inflight_mem; attributes[:"inflight_mem"]&.value; end
+      # Gets the value of `detach-time` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def detach_time; attributes[:"detach_time"]&.value; end
+      # Gets the value of `dmabuf` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dmabuf; attributes[:"dmabuf"]&.value; end
+      # Gets the value of `io-uring` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::IoUringProviderInfo
+      def io_uring; attributes[:"io_uring"]&.value; end
+    end
+    # Notification about page pool disappearing.
+    # 
+    # Multicast group: `page-pool`.
+    class PagePoolDelNtf < ::Nl::Protocols::Genl::Message
+      TYPE = 7
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::PagePool
+      ATTRIBUTES = Ractor.make_shareable(%i[id ifindex napi_id inflight inflight_mem detach_time dmabuf io_uring])
+      # Gets the value of `id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def id; attributes[:"id"]&.value; end
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `napi-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def napi_id; attributes[:"napi_id"]&.value; end
+      # Gets the value of `inflight` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def inflight; attributes[:"inflight"]&.value; end
+      # Gets the value of `inflight-mem` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def inflight_mem; attributes[:"inflight_mem"]&.value; end
+      # Gets the value of `detach-time` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def detach_time; attributes[:"detach_time"]&.value; end
+      # Gets the value of `dmabuf` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dmabuf; attributes[:"dmabuf"]&.value; end
+      # Gets the value of `io-uring` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::IoUringProviderInfo
+      def io_uring; attributes[:"io_uring"]&.value; end
+    end
+    # Notification about page pool configuration being changed.
+    # 
+    # Multicast group: `page-pool`.
+    class PagePoolChangeNtf < ::Nl::Protocols::Genl::Message
+      TYPE = 8
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::PagePool
+      ATTRIBUTES = Ractor.make_shareable(%i[id ifindex napi_id inflight inflight_mem detach_time dmabuf io_uring])
+      # Gets the value of `id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def id; attributes[:"id"]&.value; end
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `napi-id` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def napi_id; attributes[:"napi_id"]&.value; end
+      # Gets the value of `inflight` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def inflight; attributes[:"inflight"]&.value; end
+      # Gets the value of `inflight-mem` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def inflight_mem; attributes[:"inflight_mem"]&.value; end
+      # Gets the value of `detach-time` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def detach_time; attributes[:"detach_time"]&.value; end
+      # Gets the value of `dmabuf` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def dmabuf; attributes[:"dmabuf"]&.value; end
+      # Gets the value of `io-uring` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::IoUringProviderInfo
+      def io_uring; attributes[:"io_uring"]&.value; end
+    end
+  end
+  NOTIFICATIONS = Ractor.make_shareable({2 => Notifications::DevAddNtf, 3 => Notifications::DevDelNtf, 4 => Notifications::DevChangeNtf, 6 => Notifications::PagePoolAddNtf, 7 => Notifications::PagePoolDelNtf, 8 => Notifications::PagePoolChangeNtf}) #: Hash[::Integer, ::Class]
   # Get / dump information about a netdev.
   #--
   # @rbs (?ifindex: ::Integer) -> Messages::DoDevGetReply
   def do_dev_get(**args)
     exchange_message(:"do", Messages::DoDevGetRequest, Messages::DoDevGetReply, args)
   end
+  # Get / dump information about a netdev.
+  #--
+  # @rbs () -> Enumerable[Messages::DumpDevGetReply]
+  #   | () { (Messages::DumpDevGetReply) -> void } -> void
+  def dump_dev_get(**args, &block)
+    exchange_message(:"dump", Messages::DumpDevGetRequest, Messages::DumpDevGetReply, args, &block)
+  end
   # Get / dump information about Page Pools.
   # Only Page Pools associated by the driver with a net_device
   # can be listed. ifindex will not be reported if the net_device
@@ -1557,12 +1799,16 @@ class Netdev < ::Nl::Family
     exchange_message(:"dump", Messages::DumpQstatsGetRequest, Messages::DumpQstatsGetReply, args, &block)
   end
   # Bind dmabuf to netdev
+  # 
+  # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
   #--
   # @rbs (?ifindex: ::Integer, ?queues: AttributeSets::QueueId, ?fd: ::Integer) -> Messages::DoBindRxReply
   def do_bind_rx(**args)
     exchange_message(:"do", Messages::DoBindRxRequest, Messages::DoBindRxReply, args)
   end
   # Set configurable NAPI instance settings.
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?id: ::Integer, ?defer_hard_irqs: ::Integer, ?gro_flush_timeout: ::Integer, ?irq_suspend_timeout: ::Integer, ?threaded: ::Integer) -> void
   def do_napi_set(**args)
@@ -1576,10 +1822,138 @@ class Netdev < ::Nl::Family
   end
   # Create a new queue for the given netdevice. Whether this operation
   # is supported depends on the device and the driver.
+  # 
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?ifindex: ::Integer, ?type: ::Integer, ?lease: AttributeSets::Lease) -> Messages::DoQueueCreateReply
   def do_queue_create(**args)
     exchange_message(:"do", Messages::DoQueueCreateRequest, Messages::DoQueueCreateReply, args)
   end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # Get / dump information about a netdev.
+    #--
+    # @rbs (?ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoDevGetReply]
+    def do_dev_get(**args)
+      @exchange.call(:"do", Messages::DoDevGetRequest, Messages::DoDevGetReply, args)
+    end
+    # Get / dump information about a netdev.
+    #--
+    # @rbs () -> ::Nl::Async::Stream[Messages::DumpDevGetReply]
+    def dump_dev_get(**args)
+      @exchange.call(:"dump", Messages::DumpDevGetRequest, Messages::DumpDevGetReply, args)
+    end
+    # Get / dump information about Page Pools.
+    # Only Page Pools associated by the driver with a net_device
+    # can be listed. ifindex will not be reported if the net_device
+    # no longer exists.
+    #--
+    # @rbs (?id: ::Integer) -> ::Nl::Async::Future[Messages::DoPagePoolGetReply]
+    def do_page_pool_get(**args)
+      @exchange.call(:"do", Messages::DoPagePoolGetRequest, Messages::DoPagePoolGetReply, args)
+    end
+    # Get / dump information about Page Pools.
+    # Only Page Pools associated by the driver with a net_device
+    # can be listed. ifindex will not be reported if the net_device
+    # no longer exists.
+    #--
+    # @rbs (?ifindex: ::Integer) -> ::Nl::Async::Stream[Messages::DumpPagePoolGetReply]
+    def dump_page_pool_get(**args)
+      @exchange.call(:"dump", Messages::DumpPagePoolGetRequest, Messages::DumpPagePoolGetReply, args)
+    end
+    # Get page pool statistics.
+    #--
+    # @rbs (?info: AttributeSets::PagePoolInfo) -> ::Nl::Async::Future[Messages::DoPagePoolStatsGetReply]
+    def do_page_pool_stats_get(**args)
+      @exchange.call(:"do", Messages::DoPagePoolStatsGetRequest, Messages::DoPagePoolStatsGetReply, args)
+    end
+    # Get page pool statistics.
+    #--
+    # @rbs (?info: AttributeSets::PagePoolInfo) -> ::Nl::Async::Stream[Messages::DumpPagePoolStatsGetReply]
+    def dump_page_pool_stats_get(**args)
+      @exchange.call(:"dump", Messages::DumpPagePoolStatsGetRequest, Messages::DumpPagePoolStatsGetReply, args)
+    end
+    # Get queue information from the kernel. Only configured queues will be reported (as opposed to all available hardware queues).
+    #--
+    # @rbs (?id: ::Integer, ?ifindex: ::Integer, ?type: ::Integer) -> ::Nl::Async::Future[Messages::DoQueueGetReply]
+    def do_queue_get(**args)
+      @exchange.call(:"do", Messages::DoQueueGetRequest, Messages::DoQueueGetReply, args)
+    end
+    # Get queue information from the kernel. Only configured queues will be reported (as opposed to all available hardware queues).
+    #--
+    # @rbs (?ifindex: ::Integer) -> ::Nl::Async::Stream[Messages::DumpQueueGetReply]
+    def dump_queue_get(**args)
+      @exchange.call(:"dump", Messages::DumpQueueGetRequest, Messages::DumpQueueGetReply, args)
+    end
+    # Get information about NAPI instances configured on the system.
+    #--
+    # @rbs (?id: ::Integer) -> ::Nl::Async::Future[Messages::DoNapiGetReply]
+    def do_napi_get(**args)
+      @exchange.call(:"do", Messages::DoNapiGetRequest, Messages::DoNapiGetReply, args)
+    end
+    # Get information about NAPI instances configured on the system.
+    #--
+    # @rbs (?ifindex: ::Integer) -> ::Nl::Async::Stream[Messages::DumpNapiGetReply]
+    def dump_napi_get(**args)
+      @exchange.call(:"dump", Messages::DumpNapiGetRequest, Messages::DumpNapiGetReply, args)
+    end
+    # Get / dump fine grained statistics. Which statistics are reported
+    # depends on the device and the driver, and whether the driver stores
+    # software counters per-queue.
+    #--
+    # @rbs (?ifindex: ::Integer, ?scope: ::Integer) -> ::Nl::Async::Stream[Messages::DumpQstatsGetReply]
+    def dump_qstats_get(**args)
+      @exchange.call(:"dump", Messages::DumpQstatsGetRequest, Messages::DumpQstatsGetReply, args)
+    end
+    # Bind dmabuf to netdev
+    # 
+    # Requires CAP_NET_ADMIN in the user namespace owning the network namespace.
+    #--
+    # @rbs (?ifindex: ::Integer, ?queues: AttributeSets::QueueId, ?fd: ::Integer) -> ::Nl::Async::Future[Messages::DoBindRxReply]
+    def do_bind_rx(**args)
+      @exchange.call(:"do", Messages::DoBindRxRequest, Messages::DoBindRxReply, args)
+    end
+    # Set configurable NAPI instance settings.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?id: ::Integer, ?defer_hard_irqs: ::Integer, ?gro_flush_timeout: ::Integer, ?irq_suspend_timeout: ::Integer, ?threaded: ::Integer) -> ::Nl::Async::Future[void]
+    def do_napi_set(**args)
+      @exchange.call(:"do", Messages::DoNapiSetRequest, nil, args)
+    end
+    # Bind dmabuf to netdev for TX
+    #--
+    # @rbs (?ifindex: ::Integer, ?fd: ::Integer) -> ::Nl::Async::Future[Messages::DoBindTxReply]
+    def do_bind_tx(**args)
+      @exchange.call(:"do", Messages::DoBindTxRequest, Messages::DoBindTxReply, args)
+    end
+    # Create a new queue for the given netdevice. Whether this operation
+    # is supported depends on the device and the driver.
+    # 
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?ifindex: ::Integer, ?type: ::Integer, ?lease: AttributeSets::Lease) -> ::Nl::Async::Future[Messages::DoQueueCreateReply]
+    def do_queue_create(**args)
+      @exchange.call(:"do", Messages::DoQueueCreateRequest, Messages::DoQueueCreateReply, 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
+  #--
+  # @rbs (*(:mgmt | :page_pool) groups) -> self
+  def subscribe(*groups) = super
+  #--
+  # @rbs (*(:mgmt | :page_pool) groups) -> self
+  def unsubscribe(*groups) = super
 end
 end; end