nl-linux 0.2.0 → 0.2.1

data/generated/nl/linux/ovs_vport.rb

@@ -0,0 +1,389 @@
+# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
+#--
+# frozen_string_literal: true
+# rbs_inline: enabled
+# This code is generated by Ynl::Generator. DO NOT EDIT.
+require 'nl'
+# OVS vport configuration over generic netlink.
+class Nl::Linux::OvsVport < ::Nl::Family
+  NAME = "ovs_vport"
+  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("ovs_vport"))
+  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]
+      # Decodes the struct.
+      #--
+      # @rbs decoder: ::Nl::Decoder
+      # @rbs return: instance
+      def self.decode(decoder)
+        self.new(*MEMBERS.map {|name, datatype| datatype.decode(decoder) })
+      end
+      # Encodes the struct.
+      #--
+      # @rbs encoder: ::Nl::Encoder
+      # @rbs return: void
+      def encode(encoder)
+        MEMBERS.each {|name, datatype| datatype.encode(encoder, self.public_send(name)) }
+      end
+    end
+    OvsVportStats = Struct.new(
+      :"rx_packets", #: ::Integer
+      :"tx_packets", #: ::Integer
+      :"rx_bytes", #: ::Integer
+      :"tx_bytes", #: ::Integer
+      :"rx_errors", #: ::Integer
+      :"tx_errors", #: ::Integer
+      :"rx_dropped", #: ::Integer
+      :"tx_dropped", #: ::Integer
+    )
+    class OvsVportStats
+      # :nodoc:
+      MEMBERS = Ractor.make_shareable({rx_packets: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), tx_packets: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), rx_bytes: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), tx_bytes: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), rx_errors: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), tx_errors: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), rx_dropped: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil), tx_dropped: ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)}) #: Hash[::Symbol, ::Nl::_DataType]
+      # Decodes the struct.
+      #--
+      # @rbs decoder: ::Nl::Decoder
+      # @rbs return: instance
+      def self.decode(decoder)
+        self.new(*MEMBERS.map {|name, datatype| datatype.decode(decoder) })
+      end
+      # Encodes the struct.
+      #--
+      # @rbs encoder: ::Nl::Encoder
+      # @rbs return: void
+      def encode(encoder)
+        MEMBERS.each {|name, datatype| datatype.encode(encoder, self.public_send(name)) }
+      end
+    end
+  end
+  module AttributeSets
+    class VportOptions < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class DstPort < Attribute
+        TYPE = 1
+        NAME = :"dst_port"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class Extension < Attribute
+        TYPE = 2
+        NAME = :"extension"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"dst_port" => DstPort, :"extension" => Extension}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => DstPort, 2 => Extension}) #: Hash[::Integer, Attribute]
+      class << self
+        # Looks up Attribute class by name.
+        #--
+        # @rbs name: Symbol
+        # @rbs return: Attribute
+        def by_name(name); BY_NAME.fetch(name); end
+        # Looks up Attribute class by type value.
+        #--
+        # @rbs type: Integer
+        # @rbs return: Attribute
+        def by_type(type); BY_TYPE.fetch(type); end
+      end
+    end
+    class UpcallStats < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class Success < Attribute
+        TYPE = 0
+        NAME = :"success"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+      end
+      class Fail < Attribute
+        TYPE = 1
+        NAME = :"fail"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"success" => Success, :"fail" => Fail}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({0 => Success, 1 => Fail}) #: Hash[::Integer, Attribute]
+      class << self
+        # Looks up Attribute class by name.
+        #--
+        # @rbs name: Symbol
+        # @rbs return: Attribute
+        def by_name(name); BY_NAME.fetch(name); end
+        # Looks up Attribute class by type value.
+        #--
+        # @rbs type: Integer
+        # @rbs return: Attribute
+        def by_type(type); BY_TYPE.fetch(type); end
+      end
+    end
+    class Vport < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class PortNo < Attribute
+        TYPE = 1
+        NAME = :"port_no"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class Type < Attribute
+        TYPE = 2
+        NAME = :"type"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class Name < Attribute
+        TYPE = 3
+        NAME = :"name"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+      end
+      class Options < Attribute
+        TYPE = 4
+        NAME = :"options"
+      end
+      class UpcallPid < Attribute
+        TYPE = 5
+        NAME = :"upcall_pid"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: nil)
+      end
+      class Stats < Attribute
+        TYPE = 6
+        NAME = :"stats"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Binary.new(check: nil)
+      end
+      class Ifindex < Attribute
+        TYPE = 7
+        NAME = :"ifindex"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class Netnsid < Attribute
+        TYPE = 8
+        NAME = :"netnsid"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class UpcallStats < Attribute
+        TYPE = 9
+        NAME = :"upcall_stats"
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"port_no" => PortNo, :"type" => Type, :"name" => Name, :"options" => Options, :"upcall_pid" => UpcallPid, :"stats" => Stats, :"ifindex" => Ifindex, :"netnsid" => Netnsid, :"upcall_stats" => UpcallStats}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => PortNo, 2 => Type, 3 => Name, 4 => Options, 5 => UpcallPid, 6 => Stats, 7 => Ifindex, 8 => Netnsid, 9 => UpcallStats}) #: Hash[::Integer, Attribute]
+      class << self
+        # Looks up Attribute class by name.
+        #--
+        # @rbs name: Symbol
+        # @rbs return: Attribute
+        def by_name(name); BY_NAME.fetch(name); end
+        # Looks up Attribute class by type value.
+        #--
+        # @rbs type: Integer
+        # @rbs return: Attribute
+        def by_type(type); BY_TYPE.fetch(type); end
+      end
+    end
+    Vport::Options::DATATYPE = ::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(VportOptions)
+    Vport::UpcallStats::DATATYPE = ::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(UpcallStats)
+  end
+  module Messages
+    # Create a new OVS vport
+    class DoNewRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = Structs::OvsHeader
+      ATTRIBUTE_SET = AttributeSets::Vport
+      ATTRIBUTES = Ractor.make_shareable(%i[type name options upcall_pid ifindex])
+      # Gets the value of `dp-ifindex` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def dp_ifindex; fixed_header.dp_ifindex; end
+      # Gets the value of `type` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def type; attributes[:"type"]&.value; end
+      # Gets the value of `name` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def name; attributes[:"name"]&.value; end
+      # Gets the value of `options` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::VportOptions
+      def options; attributes[:"options"]&.value; end
+      # Gets the value of `upcall-pid` attribute in the message.
+      #--
+      # @rbs return: untyped
+      def upcall_pid; attributes[:"upcall_pid"]&.value; end
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+    end
+    # Delete existing OVS vport from a data path
+    class DoDelRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 2
+      FIXED_HEADER = Structs::OvsHeader
+      ATTRIBUTE_SET = AttributeSets::Vport
+      ATTRIBUTES = Ractor.make_shareable(%i[port_no type name])
+      # Gets the value of `dp-ifindex` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def dp_ifindex; fixed_header.dp_ifindex; end
+      # Gets the value of `port-no` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def port_no; attributes[:"port_no"]&.value; end
+      # Gets the value of `type` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def type; attributes[:"type"]&.value; end
+      # Gets the value of `name` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def name; attributes[:"name"]&.value; end
+    end
+    # Get / dump OVS vport configuration and state
+    class DoGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 3
+      FIXED_HEADER = Structs::OvsHeader
+      ATTRIBUTE_SET = AttributeSets::Vport
+      ATTRIBUTES = Ractor.make_shareable(%i[name])
+      # Gets the value of `dp-ifindex` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def dp_ifindex; fixed_header.dp_ifindex; end
+      # Gets the value of `name` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def name; attributes[:"name"]&.value; end
+    end
+    # Get / dump OVS vport configuration and state
+    class DoGetReply < ::Nl::Protocols::Genl::Message
+      TYPE = 3
+      FIXED_HEADER = Structs::OvsHeader
+      ATTRIBUTE_SET = AttributeSets::Vport
+      ATTRIBUTES = Ractor.make_shareable(%i[port_no type name upcall_pid stats ifindex netnsid upcall_stats])
+      # Gets the value of `dp-ifindex` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def dp_ifindex; fixed_header.dp_ifindex; end
+      # Gets the value of `port-no` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def port_no; attributes[:"port_no"]&.value; end
+      # Gets the value of `type` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def type; attributes[:"type"]&.value; end
+      # Gets the value of `name` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def name; attributes[:"name"]&.value; end
+      # Gets the value of `upcall-pid` attribute in the message.
+      #--
+      # @rbs return: untyped
+      def upcall_pid; attributes[:"upcall_pid"]&.value; end
+      # Gets the value of `stats` attribute in the message.
+      #--
+      # @rbs return: untyped
+      def stats; attributes[:"stats"]&.value; end
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `netnsid` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def netnsid; attributes[:"netnsid"]&.value; end
+      # Gets the value of `upcall-stats` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::UpcallStats
+      def upcall_stats; attributes[:"upcall_stats"]&.value; end
+    end
+    # Get / dump OVS vport configuration and state
+    class DumpGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 3
+      FIXED_HEADER = Structs::OvsHeader
+      ATTRIBUTE_SET = AttributeSets::Vport
+      ATTRIBUTES = Ractor.make_shareable(%i[name])
+      # Gets the value of `dp-ifindex` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def dp_ifindex; fixed_header.dp_ifindex; end
+      # Gets the value of `name` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def name; attributes[:"name"]&.value; end
+    end
+    # Get / dump OVS vport configuration and state
+    class DumpGetReply < ::Nl::Protocols::Genl::Message
+      TYPE = 3
+      FIXED_HEADER = Structs::OvsHeader
+      ATTRIBUTE_SET = AttributeSets::Vport
+      ATTRIBUTES = Ractor.make_shareable(%i[port_no type name upcall_pid stats ifindex netnsid upcall_stats])
+      # Gets the value of `dp-ifindex` field in the message's fixed header.
+      #--
+      # @rbs return: ::Integer
+      def dp_ifindex; fixed_header.dp_ifindex; end
+      # Gets the value of `port-no` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def port_no; attributes[:"port_no"]&.value; end
+      # Gets the value of `type` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def type; attributes[:"type"]&.value; end
+      # Gets the value of `name` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def name; attributes[:"name"]&.value; end
+      # Gets the value of `upcall-pid` attribute in the message.
+      #--
+      # @rbs return: untyped
+      def upcall_pid; attributes[:"upcall_pid"]&.value; end
+      # Gets the value of `stats` attribute in the message.
+      #--
+      # @rbs return: untyped
+      def stats; attributes[:"stats"]&.value; end
+      # Gets the value of `ifindex` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def ifindex; attributes[:"ifindex"]&.value; end
+      # Gets the value of `netnsid` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def netnsid; attributes[:"netnsid"]&.value; end
+      # Gets the value of `upcall-stats` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::UpcallStats
+      def upcall_stats; attributes[:"upcall_stats"]&.value; end
+    end
+  end
+  # Create a new OVS vport
+  #--
+  # @rbs (?dp_ifindex: ::Integer, ?type: ::Integer, ?name: ::String, ?options: AttributeSets::VportOptions, ?upcall_pid: untyped, ?ifindex: ::Integer) -> void
+  def do_new(**args)
+    exchange_message(:"do", Messages::DoNewRequest, nil, args)
+  end
+  # Delete existing OVS vport from a data path
+  #--
+  # @rbs (?dp_ifindex: ::Integer, ?port_no: ::Integer, ?type: ::Integer, ?name: ::String) -> void
+  def do_del(**args)
+    exchange_message(:"do", Messages::DoDelRequest, nil, args)
+  end
+  # Get / dump OVS vport configuration and state
+  #--
+  # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> Messages::DoGetReply
+  def do_get(**args)
+    exchange_message(:"do", Messages::DoGetRequest, Messages::DoGetReply, args)
+  end
+  # Get / dump OVS vport configuration and state
+  #--
+  # @rbs (?dp_ifindex: ::Integer, ?name: ::String) -> Enumerable[Messages::DumpGetReply]
+  #   | (?dp_ifindex: ::Integer, ?name: ::String) { (Messages::DumpGetReply) -> void } -> void
+  def dump_get(**args, &block)
+    exchange_message(:"dump", Messages::DumpGetRequest, Messages::DumpGetReply, args, &block)
+  end
+end