nl-linux 0.2.3 → 0.3.0

data/generated/nl/linux/sunrpc_cache.rb

@@ -0,0 +1,423 @@
+# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
+#
+# This file is based on Documentation/netlink/specs/sunrpc_cache.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
+# SUNRPC cache upcall support over generic netlink.
+class Sunrpc < ::Nl::Family
+  NAME = "sunrpc"
+  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("sunrpc"))
+  MCAST_GROUPS = Ractor.make_shareable({:"none" => ::Nl::McastGroup.new("none", nil), :"exportd" => ::Nl::McastGroup.new("exportd", nil)}) #: Hash[::Symbol, ::Nl::McastGroup]
+  module Structs
+  end
+  module AttributeSets
+    class CacheNotify < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class CacheType < Attribute
+        TYPE = 1
+        NAME = :"cache_type"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"cache_type" => CacheType}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => CacheType}) #: 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 IpMap < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class Seqno < Attribute
+        TYPE = 1
+        NAME = :"seqno"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+      end
+      class Class < Attribute
+        TYPE = 2
+        NAME = :"class"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+      end
+      class Addr < Attribute
+        TYPE = 3
+        NAME = :"addr"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+      end
+      class Domain < Attribute
+        TYPE = 4
+        NAME = :"domain"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+      end
+      class Negative < Attribute
+        TYPE = 5
+        NAME = :"negative"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Flag.new
+      end
+      class Expiry < Attribute
+        TYPE = 6
+        NAME = :"expiry"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"seqno" => Seqno, :"class" => Class, :"addr" => Addr, :"domain" => Domain, :"negative" => Negative, :"expiry" => Expiry}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => Seqno, 2 => Class, 3 => Addr, 4 => Domain, 5 => Negative, 6 => Expiry}) #: 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 IpMapReqs < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class Requests < Attribute
+        TYPE = 1
+        NAME = :"requests"
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"requests" => Requests}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => Requests}) #: 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 UnixGid < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class Seqno < Attribute
+        TYPE = 1
+        NAME = :"seqno"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+      end
+      class Uid < Attribute
+        TYPE = 2
+        NAME = :"uid"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class Gids < Attribute
+        TYPE = 3
+        NAME = :"gids"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      class Negative < Attribute
+        TYPE = 4
+        NAME = :"negative"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Flag.new
+      end
+      class Expiry < Attribute
+        TYPE = 5
+        NAME = :"expiry"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U64, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"seqno" => Seqno, :"uid" => Uid, :"gids" => Gids, :"negative" => Negative, :"expiry" => Expiry}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => Seqno, 2 => Uid, 3 => Gids, 4 => Negative, 5 => Expiry}) #: 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 UnixGidReqs < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class Requests < Attribute
+        TYPE = 1
+        NAME = :"requests"
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"requests" => Requests}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => Requests}) #: 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 CacheFlush < ::Nl::Protocols::Genl::AttributeSet
+      # Abstract class
+      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      end
+      class Mask < Attribute
+        TYPE = 1
+        NAME = :"mask"
+        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+      end
+      # :nodoc:
+      BY_NAME = Ractor.make_shareable({:"mask" => Mask}) #: Hash[::Symbol, Attribute]
+      # :nodoc:
+      BY_TYPE = Ractor.make_shareable({1 => Mask}) #: 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
+    IpMapReqs::Requests::DATATYPE = ::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(IpMap)
+    UnixGidReqs::Requests::DATATYPE = ::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(UnixGid)
+  end
+  module Messages
+    # Dump all pending ip_map requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DumpIpMapGetReqsRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 2
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::IpMapReqs
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # Dump all pending ip_map requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DumpIpMapGetReqsReply < ::Nl::Protocols::Genl::Message
+      TYPE = 2
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::IpMapReqs
+      ATTRIBUTES = Ractor.make_shareable(%i[requests])
+      # Gets the value of `requests` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::IpMap
+      def requests; attributes[:"requests"]&.value; end
+    end
+    # Respond to one or more ip_map requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DoIpMapSetReqsRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 3
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::IpMapReqs
+      ATTRIBUTES = Ractor.make_shareable(%i[requests])
+      # Gets the value of `requests` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::IpMap
+      def requests; attributes[:"requests"]&.value; end
+    end
+    # Dump all pending unix_gid requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DumpUnixGidGetReqsRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 4
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::UnixGidReqs
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # Dump all pending unix_gid requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DumpUnixGidGetReqsReply < ::Nl::Protocols::Genl::Message
+      TYPE = 4
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::UnixGidReqs
+      ATTRIBUTES = Ractor.make_shareable(%i[requests])
+      # Gets the value of `requests` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::UnixGid
+      def requests; attributes[:"requests"]&.value; end
+    end
+    # Respond to one or more unix_gid requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DoUnixGidSetReqsRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 5
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::UnixGidReqs
+      ATTRIBUTES = Ractor.make_shareable(%i[requests])
+      # Gets the value of `requests` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::UnixGid
+      def requests; attributes[:"requests"]&.value; end
+    end
+    # Flush sunrpc caches (ip_map and/or unix_gid)
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DoCacheFlushRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 6
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::CacheFlush
+      ATTRIBUTES = Ractor.make_shareable(%i[mask])
+      # Gets the value of `mask` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def mask; attributes[:"mask"]&.value; end
+    end
+  end
+  module Notifications
+    # Notification that there are cache requests that need servicing
+    # 
+    # Multicast group: `exportd`.
+    class CacheNotify < ::Nl::Protocols::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::CacheNotify
+      ATTRIBUTES = Ractor.make_shareable(%i[cache_type])
+      # Gets the value of `cache-type` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def cache_type; attributes[:"cache_type"]&.value; end
+    end
+  end
+  NOTIFICATIONS = Ractor.make_shareable({1 => Notifications::CacheNotify}) #: Hash[::Integer, ::Class]
+  # Dump all pending ip_map requests
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs () -> Enumerable[Messages::DumpIpMapGetReqsReply]
+  #   | () { (Messages::DumpIpMapGetReqsReply) -> void } -> void
+  def dump_ip_map_get_reqs(**args, &block)
+    exchange_message(:"dump", Messages::DumpIpMapGetReqsRequest, Messages::DumpIpMapGetReqsReply, args, &block)
+  end
+  # Respond to one or more ip_map requests
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs (?requests: AttributeSets::IpMap) -> void
+  def do_ip_map_set_reqs(**args)
+    exchange_message(:"do", Messages::DoIpMapSetReqsRequest, nil, args)
+  end
+  # Dump all pending unix_gid requests
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs () -> Enumerable[Messages::DumpUnixGidGetReqsReply]
+  #   | () { (Messages::DumpUnixGidGetReqsReply) -> void } -> void
+  def dump_unix_gid_get_reqs(**args, &block)
+    exchange_message(:"dump", Messages::DumpUnixGidGetReqsRequest, Messages::DumpUnixGidGetReqsReply, args, &block)
+  end
+  # Respond to one or more unix_gid requests
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs (?requests: AttributeSets::UnixGid) -> void
+  def do_unix_gid_set_reqs(**args)
+    exchange_message(:"do", Messages::DoUnixGidSetReqsRequest, nil, args)
+  end
+  # Flush sunrpc caches (ip_map and/or unix_gid)
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs (?mask: ::Integer) -> void
+  def do_cache_flush(**args)
+    exchange_message(:"do", Messages::DoCacheFlushRequest, nil, args)
+  end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # Dump all pending ip_map requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs () -> ::Nl::Async::Stream[Messages::DumpIpMapGetReqsReply]
+    def dump_ip_map_get_reqs(**args)
+      @exchange.call(:"dump", Messages::DumpIpMapGetReqsRequest, Messages::DumpIpMapGetReqsReply, args)
+    end
+    # Respond to one or more ip_map requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?requests: AttributeSets::IpMap) -> ::Nl::Async::Future[void]
+    def do_ip_map_set_reqs(**args)
+      @exchange.call(:"do", Messages::DoIpMapSetReqsRequest, nil, args)
+    end
+    # Dump all pending unix_gid requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs () -> ::Nl::Async::Stream[Messages::DumpUnixGidGetReqsReply]
+    def dump_unix_gid_get_reqs(**args)
+      @exchange.call(:"dump", Messages::DumpUnixGidGetReqsRequest, Messages::DumpUnixGidGetReqsReply, args)
+    end
+    # Respond to one or more unix_gid requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?requests: AttributeSets::UnixGid) -> ::Nl::Async::Future[void]
+    def do_unix_gid_set_reqs(**args)
+      @exchange.call(:"do", Messages::DoUnixGidSetReqsRequest, nil, args)
+    end
+    # Flush sunrpc caches (ip_map and/or unix_gid)
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?mask: ::Integer) -> ::Nl::Async::Future[void]
+    def do_cache_flush(**args)
+      @exchange.call(:"do", Messages::DoCacheFlushRequest, 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
+  #--
+  # @rbs (*(:none | :exportd) groups) -> self
+  def subscribe(*groups) = super
+  #--
+  # @rbs (*(:none | :exportd) groups) -> self
+  def unsubscribe(*groups) = super
+end
+end; end