nl-linux 0.2.4 → 0.4.1

data/sig/generated/nl/linux/ovs_packet.rbs

@@ -0,0 +1,540 @@
+# Generated from generated/nl/linux/ovs_packet.rb with RBS::Inline
+
+module Nl
+  module Linux
+    # OVS packet execution over generic netlink.
+    #
+    # Only OVS_PACKET_CMD_EXECUTE is exposed as a genl operation.
+    # OVS_PACKET_CMD_MISS and OVS_PACKET_CMD_ACTION are kernel-to-userspace
+    # upcalls sent via genlmsg_unicast() to the vport's upcall_pid and have
+    # no associated genl_ops or multicast group.
+    #
+    # Several attributes in the attribute set (userdata, egress-tun-key, len)
+    # 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::Genl::Family
+      NAME: ::String
+
+      VERSION: ::Integer
+
+      # @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::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+
+      # @private
+      MCAST_GROUPS: Hash[::Symbol, ::Nl::McastGroup]
+
+      module Structs
+        class OvsHeader < Struct[::Integer]
+          attr_accessor dp_ifindex(): ::Integer
+
+          def self.new: (?::Integer dp_ifindex) -> instance
+                      | (?dp_ifindex: ::Integer) -> instance
+        end
+
+        class OvsHeader
+          # @!attribute [rw] dp_ifindex
+          #   @return [Integer]
+          # @private
+          MEMBERS: Hash[::Symbol, ::Nl::_DataType]
+
+          # Decodes the struct.
+          # @rbs decoder: ::Nl::Decoder
+          # @rbs return: instance
+          # @param [Nl::Decoder] decoder
+          # @return [self]
+          def self.decode: (::Nl::Decoder decoder) -> instance
+
+          # Encodes the struct.
+          # @rbs encoder: ::Nl::Encoder
+          # @rbs return: void
+          # @param [Nl::Encoder] encoder
+          # @return [void]
+          def encode: (::Nl::Encoder encoder) -> void
+        end
+      end
+
+      module AttributeSets
+        class Packet < ::Nl::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          # Packet data, from the start of the Ethernet header.
+          class Packet < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          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: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Nested OVS_ACTION_ATTR_* attributes.
+          # Defined as binary for the same reason as key.
+          class Actions < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Opaque userspace cookie from OVS_USERSPACE_ATTR_USERDATA.
+          class Userdata < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Nested OVS_TUNNEL_KEY_ATTR_* for output tunnel metadata.
+          class EgressTunKey < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Packet operation is a feature probe, error logging suppressed.
+          class Probe < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Maximum received IP fragment size.
+          class Mru < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Packet size before truncation.
+          class Len < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Packet hash, low 32 bits are skb hash, upper bits are flags.
+          class Hash < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # Netlink PID to use for upcalls during EXECUTE processing.
+          class UpcallPid < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # Packet data, from the start of the Ethernet header.
+          # @rbs return: ::String
+          # @return [String]
+          # @see Packet
+          def packet: () -> ::String
+
+          # 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: () -> ::String
+
+          # Nested OVS_ACTION_ATTR_* attributes.
+          # Defined as binary for the same reason as key.
+          # @rbs return: ::String
+          # @return [String]
+          # @see Actions
+          def actions: () -> ::String
+
+          # Opaque userspace cookie from OVS_USERSPACE_ATTR_USERDATA.
+          # @rbs return: ::String
+          # @return [String]
+          # @see Userdata
+          def userdata: () -> ::String
+
+          # Nested OVS_TUNNEL_KEY_ATTR_* for output tunnel metadata.
+          # @rbs return: ::String
+          # @return [String]
+          # @see EgressTunKey
+          def egress_tun_key: () -> ::String
+
+          # Packet operation is a feature probe, error logging suppressed.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Probe
+          def probe: () -> ::Integer
+
+          # Maximum received IP fragment size.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Mru
+          def mru: () -> ::Integer
+
+          # Packet size before truncation.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Len
+          def len: () -> ::Integer
+
+          # Packet hash, low 32 bits are skb hash, upper bits are flags.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Hash
+          def hash: () -> ::Integer
+
+          # Netlink PID to use for upcalls during EXECUTE processing.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see UpcallPid
+          def upcall_pid: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        end
+      end
+
+      module Messages
+        # Apply actions to a packet.
+        class DoExecuteRequest < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          def dp_ifindex: () -> ::Integer
+
+          # Packet data, from the start of the Ethernet header.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Packet::Packet
+          def packet: () -> ::String
+
+          # 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: () -> ::String
+
+          # 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: () -> ::String
+
+          # Packet operation is a feature probe, error logging suppressed.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Packet::Probe
+          def probe: () -> ::Integer
+
+          # Maximum received IP fragment size.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Packet::Mru
+          def mru: () -> ::Integer
+
+          # Packet hash, low 32 bits are skb hash, upper bits are flags.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Packet::Hash
+          def hash: () -> ::Integer
+
+          # Netlink PID to use for upcalls during EXECUTE processing.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Packet::UpcallPid
+          def upcall_pid: () -> ::Integer
+        end
+      end
+
+      module Notifications
+        # Notify userspace of a flow table miss for a received packet.
+        class Miss < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          def dp_ifindex: () -> ::Integer
+
+          # Packet data, from the start of the Ethernet header.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Packet::Packet
+          def packet: () -> ::String
+
+          # 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: () -> ::String
+
+          # 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: () -> ::String
+
+          # Opaque userspace cookie from OVS_USERSPACE_ATTR_USERDATA.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Packet::Userdata
+          def userdata: () -> ::String
+
+          # Nested OVS_TUNNEL_KEY_ATTR_* for output tunnel metadata.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Packet::EgressTunKey
+          def egress_tun_key: () -> ::String
+
+          # Maximum received IP fragment size.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Packet::Mru
+          def mru: () -> ::Integer
+
+          # Packet size before truncation.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Packet::Len
+          def len: () -> ::Integer
+
+          # Packet hash, low 32 bits are skb hash, upper bits are flags.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Packet::Hash
+          def hash: () -> ::Integer
+        end
+
+        # Notify userspace as requested by an OVS_ACTION_ATTR_USERSPACE action.
+        class Action < ::Nl::Genl::Message
+          TYPE: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # @rbs return: ::Integer
+          # @return [Integer]
+          def dp_ifindex: () -> ::Integer
+
+          # Packet data, from the start of the Ethernet header.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Packet::Packet
+          def packet: () -> ::String
+
+          # 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: () -> ::String
+
+          # 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: () -> ::String
+
+          # Opaque userspace cookie from OVS_USERSPACE_ATTR_USERDATA.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Packet::Userdata
+          def userdata: () -> ::String
+
+          # Nested OVS_TUNNEL_KEY_ATTR_* for output tunnel metadata.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Packet::EgressTunKey
+          def egress_tun_key: () -> ::String
+
+          # Maximum received IP fragment size.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Packet::Mru
+          def mru: () -> ::Integer
+
+          # Packet size before truncation.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Packet::Len
+          def len: () -> ::Integer
+
+          # Packet hash, low 32 bits are skb hash, upper bits are flags.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Packet::Hash
+          def hash: () -> ::Integer
+        end
+      end
+
+      # @private
+      NOTIFICATIONS: 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: (?dp_ifindex: ::Integer, ?packet: ::String, ?key: ::String, ?actions: ::String, ?probe: ::Integer, ?mru: ::Integer, ?hash: ::Integer, ?upcall_pid: ::Integer) -> void
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+
+        # 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: (?dp_ifindex: ::Integer, ?packet: ::String, ?key: ::String, ?actions: ::String, ?probe: ::Integer, ?mru: ::Integer, ?hash: ::Integer, ?upcall_pid: ::Integer) -> ::Nl::Async::Future[void]
+      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: ::Integer?) -> AsyncOperations
+    end
+  end
+end