nl-linux 0.3.0 → 0.4.1

data/generated/nl/linux/ovs_packet.rb

@@ -3,7 +3,6 @@
 # This file is based on Documentation/netlink/specs/ovs_packet.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
-# rbs_inline: enabled
 # This code is generated by Ynl::Generator. DO NOT EDIT.
 require 'nl'
 module Nl; module Linux
@@ -18,257 +17,433 @@ module Nl; module Linux
 # exist for the upcall path and are not used by the EXECUTE operation.
 # For EXECUTE, packet, key, and actions are mandatory (kernel returns
 # -EINVAL without them).
-class OvsPacket < ::Nl::Family
+class OvsPacket < ::Nl::Genl::Family
   NAME = "ovs_packet"
-  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("ovs_packet"))
+  VERSION = 1
+  # @rbs (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+  # @rbs | [R] (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) { (instance) -> R } -> R
+  # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+  #   @param [#call] resolver
+  #   @param [Symbol, nil] executor
+  #   @param [Integer, nil] notification_capacity
+  #   @return [OvsPacket]
+  # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY, &block)
+  #   @param [#call] resolver
+  #   @param [Symbol, nil] executor
+  #   @param [Integer, nil] notification_capacity
+  #   @yieldparam [OvsPacket] family
+  #   @return [Object] the result of the block
+  def self.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+    super
+  end
+  # @private
   MCAST_GROUPS = Ractor.make_shareable({}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
     OvsHeader = Struct.new(
       :"dp_ifindex", #: ::Integer
     )
     class OvsHeader
-      # :nodoc:
-      MEMBERS = Ractor.make_shareable({dp_ifindex: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
+      # @!attribute [rw] dp_ifindex
+      #   @return [Integer]
+      # @private
+      MEMBERS = Ractor.make_shareable({dp_ifindex: ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
       # Decodes the struct.
-      #--
       # @rbs decoder: ::Nl::Decoder
       # @rbs return: instance
+      # @param [Nl::Decoder] decoder
+      # @return [self]
       def self.decode(decoder)
         self.new(*MEMBERS.map {|name, datatype| datatype.decode(decoder) })
       end
       # Encodes the struct.
-      #--
       # @rbs encoder: ::Nl::Encoder
       # @rbs return: void
+      # @param [Nl::Encoder] encoder
+      # @return [void]
       def encode(encoder)
         MEMBERS.each {|name, datatype| datatype.encode(encoder, self.public_send(name)) }
       end
     end
   end
   module AttributeSets
-    class Packet < ::Nl::Protocols::Genl::AttributeSet
+    class Packet < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
+      # Packet data, from the start of the Ethernet header.
       class Packet < Attribute
         TYPE = 1
         NAME = :"packet"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is shorter than minimum length 14" unless it.bytesize >= 14 })
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: -> { raise ArgumentError, "Value #{it.inspect} is shorter than minimum length 14" unless it.bytesize >= 14 })
       end
+      # Nested OVS_KEY_ATTR_* attributes, extracted flow key.
+      # Defined as binary because the key attribute-set belongs to the
+      # ovs_flow family spec; cross-spec references are not supported.
       class Key < Attribute
         TYPE = 2
         NAME = :"key"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: nil)
       end
+      # Nested OVS_ACTION_ATTR_* attributes.
+      # Defined as binary for the same reason as key.
       class Actions < Attribute
         TYPE = 3
         NAME = :"actions"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: nil)
       end
+      # Opaque userspace cookie from OVS_USERSPACE_ATTR_USERDATA.
       class Userdata < Attribute
         TYPE = 4
         NAME = :"userdata"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: nil)
       end
+      # Nested OVS_TUNNEL_KEY_ATTR_* for output tunnel metadata.
       class EgressTunKey < Attribute
         TYPE = 5
         NAME = :"egress_tun_key"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: nil)
+        # @private
+        ORDER = 4
+        # @private
+        DATATYPE = ::Nl::DataTypes::Binary.new(check: nil)
       end
+      # Packet operation is a feature probe, error logging suppressed.
       class Probe < Attribute
         TYPE = 8
         NAME = :"probe"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Flag.new
+        # @private
+        ORDER = 5
+        # @private
+        DATATYPE = ::Nl::DataTypes::Flag.new
       end
+      # Maximum received IP fragment size.
       class Mru < Attribute
         TYPE = 9
         NAME = :"mru"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
+        # @private
+        ORDER = 6
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U16, check: nil)
       end
+      # Packet size before truncation.
       class Len < Attribute
         TYPE = 10
         NAME = :"len"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 7
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # Packet hash, low 32 bits are skb hash, upper bits are flags.
       class Hash < Attribute
         TYPE = 11
         NAME = :"hash"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+        # @private
+        ORDER = 8
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
       end
+      # Netlink PID to use for upcalls during EXECUTE processing.
       class UpcallPid < Attribute
         TYPE = 12
         NAME = :"upcall_pid"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 9
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"packet" => Packet, :"key" => Key, :"actions" => Actions, :"userdata" => Userdata, :"egress_tun_key" => EgressTunKey, :"probe" => Probe, :"mru" => Mru, :"len" => Len, :"hash" => Hash, :"upcall_pid" => UpcallPid}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Packet, 2 => Key, 3 => Actions, 4 => Userdata, 5 => EgressTunKey, 8 => Probe, 9 => Mru, 10 => Len, 11 => Hash, 12 => UpcallPid}) #: Hash[::Integer, Attribute]
+      # Packet data, from the start of the Ethernet header.
+      # @rbs return: ::String
+      # @return [String]
+      # @see Packet
+      def packet; self[:"packet"]&.value; end
+      # Nested OVS_KEY_ATTR_* attributes, extracted flow key.
+      # Defined as binary because the key attribute-set belongs to the
+      # ovs_flow family spec; cross-spec references are not supported.
+      # @rbs return: ::String
+      # @return [String]
+      # @see Key
+      def key; self[:"key"]&.value; end
+      # Nested OVS_ACTION_ATTR_* attributes.
+      # Defined as binary for the same reason as key.
+      # @rbs return: ::String
+      # @return [String]
+      # @see Actions
+      def actions; self[:"actions"]&.value; end
+      # Opaque userspace cookie from OVS_USERSPACE_ATTR_USERDATA.
+      # @rbs return: ::String
+      # @return [String]
+      # @see Userdata
+      def userdata; self[:"userdata"]&.value; end
+      # Nested OVS_TUNNEL_KEY_ATTR_* for output tunnel metadata.
+      # @rbs return: ::String
+      # @return [String]
+      # @see EgressTunKey
+      def egress_tun_key; self[:"egress_tun_key"]&.value; end
+      # Packet operation is a feature probe, error logging suppressed.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Probe
+      def probe; self[:"probe"]&.value; end
+      # Maximum received IP fragment size.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Mru
+      def mru; self[:"mru"]&.value; end
+      # Packet size before truncation.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Len
+      def len; self[:"len"]&.value; end
+      # Packet hash, low 32 bits are skb hash, upper bits are flags.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Hash
+      def hash; self[:"hash"]&.value; end
+      # Netlink PID to use for upcalls during EXECUTE processing.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see UpcallPid
+      def upcall_pid; self[:"upcall_pid"]&.value; end
       class << self
         # Looks up Attribute class by name.
-        #--
         # @rbs name: Symbol
         # @rbs return: Attribute
+        # @param [Symbol] name
+        # @return [Attribute]
         def by_name(name); BY_NAME.fetch(name); end
         # Looks up Attribute class by type value.
-        #--
         # @rbs type: Integer
         # @rbs return: Attribute
+        # @param [Integer] type
+        # @return [Attribute]
         def by_type(type); BY_TYPE.fetch(type); end
       end
     end
   end
   module Messages
     # Apply actions to a packet.
-    class DoExecuteRequest < ::Nl::Protocols::Genl::Message
+    class DoExecuteRequest < ::Nl::Genl::Message
       TYPE = 3
       FIXED_HEADER = Structs::OvsHeader
       ATTRIBUTE_SET = AttributeSets::Packet
       ATTRIBUTES = Ractor.make_shareable(%i[packet key actions probe mru hash upcall_pid])
-      # Gets the value of `dp-ifindex` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def dp_ifindex; fixed_header.dp_ifindex; end
-      # Gets the value of `packet` attribute in the message.
-      #--
+      # Packet data, from the start of the Ethernet header.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Packet
       def packet; attributes[:"packet"]&.value; end
-      # Gets the value of `key` attribute in the message.
-      #--
+      # Nested OVS_KEY_ATTR_* attributes, extracted flow key.
+      # Defined as binary because the key attribute-set belongs to the
+      # ovs_flow family spec; cross-spec references are not supported.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Key
       def key; attributes[:"key"]&.value; end
-      # Gets the value of `actions` attribute in the message.
-      #--
+      # Nested OVS_ACTION_ATTR_* attributes.
+      # Defined as binary for the same reason as key.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Actions
       def actions; attributes[:"actions"]&.value; end
-      # Gets the value of `probe` attribute in the message.
-      #--
+      # Packet operation is a feature probe, error logging suppressed.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Packet::Probe
       def probe; attributes[:"probe"]&.value; end
-      # Gets the value of `mru` attribute in the message.
-      #--
+      # Maximum received IP fragment size.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Packet::Mru
       def mru; attributes[:"mru"]&.value; end
-      # Gets the value of `hash` attribute in the message.
-      #--
+      # Packet hash, low 32 bits are skb hash, upper bits are flags.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Packet::Hash
       def hash; attributes[:"hash"]&.value; end
-      # Gets the value of `upcall-pid` attribute in the message.
-      #--
+      # Netlink PID to use for upcalls during EXECUTE processing.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Packet::UpcallPid
       def upcall_pid; attributes[:"upcall_pid"]&.value; end
     end
   end
   module Notifications
     # Notify userspace of a flow table miss for a received packet.
-    class Miss < ::Nl::Protocols::Genl::Message
+    class Miss < ::Nl::Genl::Message
       TYPE = 1
       FIXED_HEADER = Structs::OvsHeader
       ATTRIBUTE_SET = AttributeSets::Packet
       ATTRIBUTES = Ractor.make_shareable(%i[packet key actions userdata egress_tun_key mru len hash])
-      # Gets the value of `dp-ifindex` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def dp_ifindex; fixed_header.dp_ifindex; end
-      # Gets the value of `packet` attribute in the message.
-      #--
+      # Packet data, from the start of the Ethernet header.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Packet
       def packet; attributes[:"packet"]&.value; end
-      # Gets the value of `key` attribute in the message.
-      #--
+      # Nested OVS_KEY_ATTR_* attributes, extracted flow key.
+      # Defined as binary because the key attribute-set belongs to the
+      # ovs_flow family spec; cross-spec references are not supported.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Key
       def key; attributes[:"key"]&.value; end
-      # Gets the value of `actions` attribute in the message.
-      #--
+      # Nested OVS_ACTION_ATTR_* attributes.
+      # Defined as binary for the same reason as key.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Actions
       def actions; attributes[:"actions"]&.value; end
-      # Gets the value of `userdata` attribute in the message.
-      #--
+      # Opaque userspace cookie from OVS_USERSPACE_ATTR_USERDATA.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Userdata
       def userdata; attributes[:"userdata"]&.value; end
-      # Gets the value of `egress-tun-key` attribute in the message.
-      #--
+      # Nested OVS_TUNNEL_KEY_ATTR_* for output tunnel metadata.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::EgressTunKey
       def egress_tun_key; attributes[:"egress_tun_key"]&.value; end
-      # Gets the value of `mru` attribute in the message.
-      #--
+      # Maximum received IP fragment size.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Packet::Mru
       def mru; attributes[:"mru"]&.value; end
-      # Gets the value of `len` attribute in the message.
-      #--
+      # Packet size before truncation.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Packet::Len
       def len; attributes[:"len"]&.value; end
-      # Gets the value of `hash` attribute in the message.
-      #--
+      # Packet hash, low 32 bits are skb hash, upper bits are flags.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Packet::Hash
       def hash; attributes[:"hash"]&.value; end
     end
     # Notify userspace as requested by an OVS_ACTION_ATTR_USERSPACE action.
-    class Action < ::Nl::Protocols::Genl::Message
+    class Action < ::Nl::Genl::Message
       TYPE = 2
       FIXED_HEADER = Structs::OvsHeader
       ATTRIBUTE_SET = AttributeSets::Packet
       ATTRIBUTES = Ractor.make_shareable(%i[packet key actions userdata egress_tun_key mru len hash])
-      # Gets the value of `dp-ifindex` field in the message's fixed header.
-      #--
       # @rbs return: ::Integer
+      # @return [Integer]
       def dp_ifindex; fixed_header.dp_ifindex; end
-      # Gets the value of `packet` attribute in the message.
-      #--
+      # Packet data, from the start of the Ethernet header.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Packet
       def packet; attributes[:"packet"]&.value; end
-      # Gets the value of `key` attribute in the message.
-      #--
+      # Nested OVS_KEY_ATTR_* attributes, extracted flow key.
+      # Defined as binary because the key attribute-set belongs to the
+      # ovs_flow family spec; cross-spec references are not supported.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Key
       def key; attributes[:"key"]&.value; end
-      # Gets the value of `actions` attribute in the message.
-      #--
+      # Nested OVS_ACTION_ATTR_* attributes.
+      # Defined as binary for the same reason as key.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Actions
       def actions; attributes[:"actions"]&.value; end
-      # Gets the value of `userdata` attribute in the message.
-      #--
+      # Opaque userspace cookie from OVS_USERSPACE_ATTR_USERDATA.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::Userdata
       def userdata; attributes[:"userdata"]&.value; end
-      # Gets the value of `egress-tun-key` attribute in the message.
-      #--
+      # Nested OVS_TUNNEL_KEY_ATTR_* for output tunnel metadata.
       # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Packet::EgressTunKey
       def egress_tun_key; attributes[:"egress_tun_key"]&.value; end
-      # Gets the value of `mru` attribute in the message.
-      #--
+      # Maximum received IP fragment size.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Packet::Mru
       def mru; attributes[:"mru"]&.value; end
-      # Gets the value of `len` attribute in the message.
-      #--
+      # Packet size before truncation.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Packet::Len
       def len; attributes[:"len"]&.value; end
-      # Gets the value of `hash` attribute in the message.
-      #--
+      # Packet hash, low 32 bits are skb hash, upper bits are flags.
       # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Packet::Hash
       def hash; attributes[:"hash"]&.value; end
     end
   end
+  # @private
   NOTIFICATIONS = Ractor.make_shareable({1 => Notifications::Miss, 2 => Notifications::Action}) #: Hash[::Integer, ::Class]
   # Apply actions to a packet.
-  #--
   # @rbs (?dp_ifindex: ::Integer, ?packet: ::String, ?key: ::String, ?actions: ::String, ?probe: ::Integer, ?mru: ::Integer, ?hash: ::Integer, ?upcall_pid: ::Integer) -> void
+  # @param [Hash] args
+  # @option args [Integer] dp_ifindex
+  # @option args [String] packet Packet data, from the start of the Ethernet header.
+  # @option args [String] key Nested OVS_KEY_ATTR_* attributes, extracted flow key.
+  #   Defined as binary because the key attribute-set belongs to the
+  #   ovs_flow family spec; cross-spec references are not supported.
+  # @option args [String] actions Nested OVS_ACTION_ATTR_* attributes.
+  #   Defined as binary for the same reason as key.
+  # @option args [Integer] probe Packet operation is a feature probe, error logging suppressed.
+  # @option args [Integer] mru Maximum received IP fragment size.
+  # @option args [Integer] hash Packet hash, low 32 bits are skb hash, upper bits are flags.
+  # @option args [Integer] upcall_pid Netlink PID to use for upcalls during EXECUTE processing.
+  # @return [void]
+  # @see Messages::DoExecuteRequest
   def do_execute(**args)
     exchange_message(:"do", Messages::DoExecuteRequest, nil, args)
   end
   class AsyncOperations
-    # :nodoc:
+    # @private
     def initialize(&exchange)
       @exchange = exchange
     end
     # Apply actions to a packet.
-    #--
     # @rbs (?dp_ifindex: ::Integer, ?packet: ::String, ?key: ::String, ?actions: ::String, ?probe: ::Integer, ?mru: ::Integer, ?hash: ::Integer, ?upcall_pid: ::Integer) -> ::Nl::Async::Future[void]
+    # @param [Hash] args
+    # @option args [Integer] dp_ifindex
+    # @option args [String] packet Packet data, from the start of the Ethernet header.
+    # @option args [String] key Nested OVS_KEY_ATTR_* attributes, extracted flow key.
+    #   Defined as binary because the key attribute-set belongs to the
+    #   ovs_flow family spec; cross-spec references are not supported.
+    # @option args [String] actions Nested OVS_ACTION_ATTR_* attributes.
+    #   Defined as binary for the same reason as key.
+    # @option args [Integer] probe Packet operation is a feature probe, error logging suppressed.
+    # @option args [Integer] mru Maximum received IP fragment size.
+    # @option args [Integer] hash Packet hash, low 32 bits are skb hash, upper bits are flags.
+    # @option args [Integer] upcall_pid Netlink PID to use for upcalls during EXECUTE processing.
+    # @return [Nl::Async::Future<void>]
+    # @see Messages::DoExecuteRequest
     def do_execute(**args)
       @exchange.call(:"do", Messages::DoExecuteRequest, nil, args)
     end
   end
   # Returns the asynchronous operation facade for this family.
-  #--
   # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+  # @param [::Integer, nil] stream_capacity
+  # @return [AsyncOperations]
   def async(stream_capacity: nil)
     return @async_operations ||= build_async_facade(AsyncOperations) if stream_capacity.nil?
     build_async_facade(AsyncOperations, stream_capacity:)