nl-linux 0.2.4 → 0.3.0

data/generated/nl/linux/nfsd.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/nfsd.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
 # rbs_inline: enabled
@@ -9,6 +11,7 @@ module Nl; module Linux
 class Nfsd < ::Nl::Family
   NAME = "nfsd"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("nfsd"))
+  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
@@ -718,6 +721,13 @@ class Nfsd < ::Nl::Family
     ExpkeyReqs::Requests::DATATYPE = ::Nl::Protocols::Genl::DataTypes::NestedAttributes.new(Expkey)
   end
   module Messages
+    # dump pending nfsd rpc
+    class DumpRpcStatusGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::RpcStatus
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
     # dump pending nfsd rpc
     class DumpRpcStatusGetReply < ::Nl::Protocols::Genl::Message
       TYPE = 1
@@ -758,11 +768,11 @@ class Nfsd < ::Nl::Family
       def daddr4; attributes[:"daddr4"]&.value; end
       # Gets the value of `saddr6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def saddr6; attributes[:"saddr6"]&.value; end
       # Gets the value of `daddr6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def daddr6; attributes[:"daddr6"]&.value; end
       # Gets the value of `sport` attribute in the message.
       #--
@@ -778,6 +788,8 @@ class Nfsd < ::Nl::Family
       def compound_ops; attributes[:"compound_ops"]&.value; end
     end
     # set the maximum number of running threads
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoThreadsSetRequest < ::Nl::Protocols::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
@@ -805,10 +817,17 @@ class Nfsd < ::Nl::Family
       def min_threads; attributes[:"min_threads"]&.value; end
       # Gets the value of `fh-key` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def fh_key; attributes[:"fh_key"]&.value; end
     end
     # get the maximum number of running threads
+    class DoThreadsGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 3
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Server
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # get the maximum number of running threads
     class DoThreadsGetReply < ::Nl::Protocols::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
@@ -836,6 +855,8 @@ class Nfsd < ::Nl::Family
       def min_threads; attributes[:"min_threads"]&.value; end
     end
     # set nfs enabled versions
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoVersionSetRequest < ::Nl::Protocols::Genl::Message
       TYPE = 4
       FIXED_HEADER = nil
@@ -847,6 +868,13 @@ class Nfsd < ::Nl::Family
       def version; attributes[:"version"]&.value; end
     end
     # get nfs enabled versions
+    class DoVersionGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 5
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::ServerProto
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # get nfs enabled versions
     class DoVersionGetReply < ::Nl::Protocols::Genl::Message
       TYPE = 5
       FIXED_HEADER = nil
@@ -858,6 +886,8 @@ class Nfsd < ::Nl::Family
       def version; attributes[:"version"]&.value; end
     end
     # set nfs running sockets
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoListenerSetRequest < ::Nl::Protocols::Genl::Message
       TYPE = 6
       FIXED_HEADER = nil
@@ -869,6 +899,13 @@ class Nfsd < ::Nl::Family
       def addr; attributes[:"addr"]&.value; end
     end
     # get nfs running listeners
+    class DoListenerGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 7
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::ServerSock
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # get nfs running listeners
     class DoListenerGetReply < ::Nl::Protocols::Genl::Message
       TYPE = 7
       FIXED_HEADER = nil
@@ -880,6 +917,8 @@ class Nfsd < ::Nl::Family
       def addr; attributes[:"addr"]&.value; end
     end
     # set the current server pool-mode
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoPoolModeSetRequest < ::Nl::Protocols::Genl::Message
       TYPE = 8
       FIXED_HEADER = nil
@@ -891,6 +930,13 @@ class Nfsd < ::Nl::Family
       def mode; attributes[:"mode"]&.value; end
     end
     # get info about server pool-mode
+    class DoPoolModeGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 9
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::PoolMode
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # get info about server pool-mode
     class DoPoolModeGetReply < ::Nl::Protocols::Genl::Message
       TYPE = 9
       FIXED_HEADER = nil
@@ -906,6 +952,17 @@ class Nfsd < ::Nl::Family
       def npools; attributes[:"npools"]&.value; end
     end
     # Dump all pending svc_export requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DumpSvcExportGetReqsRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 11
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::SvcExportReqs
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # Dump all pending svc_export requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DumpSvcExportGetReqsReply < ::Nl::Protocols::Genl::Message
       TYPE = 11
       FIXED_HEADER = nil
@@ -917,6 +974,8 @@ class Nfsd < ::Nl::Family
       def requests; attributes[:"requests"]&.value; end
     end
     # Respond to one or more svc_export requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoSvcExportSetReqsRequest < ::Nl::Protocols::Genl::Message
       TYPE = 12
       FIXED_HEADER = nil
@@ -928,6 +987,17 @@ class Nfsd < ::Nl::Family
       def requests; attributes[:"requests"]&.value; end
     end
     # Dump all pending expkey requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    class DumpExpkeyGetReqsRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 13
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::ExpkeyReqs
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # Dump all pending expkey requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DumpExpkeyGetReqsReply < ::Nl::Protocols::Genl::Message
       TYPE = 13
       FIXED_HEADER = nil
@@ -939,6 +1009,8 @@ class Nfsd < ::Nl::Family
       def requests; attributes[:"requests"]&.value; end
     end
     # Respond to one or more expkey requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoExpkeySetReqsRequest < ::Nl::Protocols::Genl::Message
       TYPE = 14
       FIXED_HEADER = nil
@@ -950,6 +1022,8 @@ class Nfsd < ::Nl::Family
       def requests; attributes[:"requests"]&.value; end
     end
     # Flush nfsd caches (svc_export and/or expkey)
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoCacheFlushRequest < ::Nl::Protocols::Genl::Message
       TYPE = 15
       FIXED_HEADER = nil
@@ -961,6 +1035,8 @@ class Nfsd < ::Nl::Family
       def mask; attributes[:"mask"]&.value; end
     end
     # release NLM locks held by an IP address
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoUnlockIpRequest < ::Nl::Protocols::Genl::Message
       TYPE = 16
       FIXED_HEADER = nil
@@ -968,10 +1044,12 @@ class Nfsd < ::Nl::Family
       ATTRIBUTES = Ractor.make_shareable(%i[address])
       # Gets the value of `address` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def address; attributes[:"address"]&.value; end
     end
     # revoke NFS state under a filesystem path
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoUnlockFilesystemRequest < ::Nl::Protocols::Genl::Message
       TYPE = 17
       FIXED_HEADER = nil
@@ -983,6 +1061,8 @@ class Nfsd < ::Nl::Family
       def path; attributes[:"path"]&.value; end
     end
     # Revoke NFSv4 state acquired through exports of a given path. Unlike unlock-filesystem, which operates at superblock granularity, this command targets only state associated with a specific export path. Userspace (exportfs -u) sends this after removing the last client for a path so the underlying filesystem can be unmounted.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoUnlockExportRequest < ::Nl::Protocols::Genl::Message
       TYPE = 18
       FIXED_HEADER = nil
@@ -994,65 +1074,295 @@ class Nfsd < ::Nl::Family
       def path; attributes[:"path"]&.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 = 10
+      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({10 => Notifications::CacheNotify}) #: Hash[::Integer, ::Class]
+  # dump pending nfsd rpc
+  #--
+  # @rbs () -> Enumerable[Messages::DumpRpcStatusGetReply]
+  #   | () { (Messages::DumpRpcStatusGetReply) -> void } -> void
+  def dump_rpc_status_get(**args, &block)
+    exchange_message(:"dump", Messages::DumpRpcStatusGetRequest, Messages::DumpRpcStatusGetReply, args, &block)
+  end
   # set the maximum number of running threads
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
-  # @rbs (?threads: ::Integer, ?gracetime: ::Integer, ?leasetime: ::Integer, ?scope: ::String, ?min_threads: ::Integer, ?fh_key: untyped) -> void
+  # @rbs (?threads: ::Integer, ?gracetime: ::Integer, ?leasetime: ::Integer, ?scope: ::String, ?min_threads: ::Integer, ?fh_key: ::String) -> void
   def do_threads_set(**args)
     exchange_message(:"do", Messages::DoThreadsSetRequest, nil, args)
   end
+  # get the maximum number of running threads
+  #--
+  # @rbs () -> Messages::DoThreadsGetReply
+  def do_threads_get(**args)
+    exchange_message(:"do", Messages::DoThreadsGetRequest, Messages::DoThreadsGetReply, args)
+  end
   # set nfs enabled versions
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?version: AttributeSets::Version) -> void
   def do_version_set(**args)
     exchange_message(:"do", Messages::DoVersionSetRequest, nil, args)
   end
+  # get nfs enabled versions
+  #--
+  # @rbs () -> Messages::DoVersionGetReply
+  def do_version_get(**args)
+    exchange_message(:"do", Messages::DoVersionGetRequest, Messages::DoVersionGetReply, args)
+  end
   # set nfs running sockets
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?addr: AttributeSets::Sock) -> void
   def do_listener_set(**args)
     exchange_message(:"do", Messages::DoListenerSetRequest, nil, args)
   end
+  # get nfs running listeners
+  #--
+  # @rbs () -> Messages::DoListenerGetReply
+  def do_listener_get(**args)
+    exchange_message(:"do", Messages::DoListenerGetRequest, Messages::DoListenerGetReply, args)
+  end
   # set the current server pool-mode
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?mode: ::String) -> void
   def do_pool_mode_set(**args)
     exchange_message(:"do", Messages::DoPoolModeSetRequest, nil, args)
   end
+  # get info about server pool-mode
+  #--
+  # @rbs () -> Messages::DoPoolModeGetReply
+  def do_pool_mode_get(**args)
+    exchange_message(:"do", Messages::DoPoolModeGetRequest, Messages::DoPoolModeGetReply, args)
+  end
+  # Dump all pending svc_export requests
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs () -> Enumerable[Messages::DumpSvcExportGetReqsReply]
+  #   | () { (Messages::DumpSvcExportGetReqsReply) -> void } -> void
+  def dump_svc_export_get_reqs(**args, &block)
+    exchange_message(:"dump", Messages::DumpSvcExportGetReqsRequest, Messages::DumpSvcExportGetReqsReply, args, &block)
+  end
   # Respond to one or more svc_export requests
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?requests: AttributeSets::SvcExport) -> void
   def do_svc_export_set_reqs(**args)
     exchange_message(:"do", Messages::DoSvcExportSetReqsRequest, nil, args)
   end
+  # Dump all pending expkey requests
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
+  #--
+  # @rbs () -> Enumerable[Messages::DumpExpkeyGetReqsReply]
+  #   | () { (Messages::DumpExpkeyGetReqsReply) -> void } -> void
+  def dump_expkey_get_reqs(**args, &block)
+    exchange_message(:"dump", Messages::DumpExpkeyGetReqsRequest, Messages::DumpExpkeyGetReqsReply, args, &block)
+  end
   # Respond to one or more expkey requests
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?requests: AttributeSets::Expkey) -> void
   def do_expkey_set_reqs(**args)
     exchange_message(:"do", Messages::DoExpkeySetReqsRequest, nil, args)
   end
   # Flush nfsd caches (svc_export and/or expkey)
+  # 
+  # 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
   # release NLM locks held by an IP address
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
-  # @rbs (?address: untyped) -> void
+  # @rbs (?address: ::String) -> void
   def do_unlock_ip(**args)
     exchange_message(:"do", Messages::DoUnlockIpRequest, nil, args)
   end
   # revoke NFS state under a filesystem path
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?path: ::String) -> void
   def do_unlock_filesystem(**args)
     exchange_message(:"do", Messages::DoUnlockFilesystemRequest, nil, args)
   end
   # Revoke NFSv4 state acquired through exports of a given path. Unlike unlock-filesystem, which operates at superblock granularity, this command targets only state associated with a specific export path. Userspace (exportfs -u) sends this after removing the last client for a path so the underlying filesystem can be unmounted.
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?path: ::String) -> void
   def do_unlock_export(**args)
     exchange_message(:"do", Messages::DoUnlockExportRequest, nil, args)
   end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # dump pending nfsd rpc
+    #--
+    # @rbs () -> ::Nl::Async::Stream[Messages::DumpRpcStatusGetReply]
+    def dump_rpc_status_get(**args)
+      @exchange.call(:"dump", Messages::DumpRpcStatusGetRequest, Messages::DumpRpcStatusGetReply, args)
+    end
+    # set the maximum number of running threads
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?threads: ::Integer, ?gracetime: ::Integer, ?leasetime: ::Integer, ?scope: ::String, ?min_threads: ::Integer, ?fh_key: ::String) -> ::Nl::Async::Future[void]
+    def do_threads_set(**args)
+      @exchange.call(:"do", Messages::DoThreadsSetRequest, nil, args)
+    end
+    # get the maximum number of running threads
+    #--
+    # @rbs () -> ::Nl::Async::Future[Messages::DoThreadsGetReply]
+    def do_threads_get(**args)
+      @exchange.call(:"do", Messages::DoThreadsGetRequest, Messages::DoThreadsGetReply, args)
+    end
+    # set nfs enabled versions
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?version: AttributeSets::Version) -> ::Nl::Async::Future[void]
+    def do_version_set(**args)
+      @exchange.call(:"do", Messages::DoVersionSetRequest, nil, args)
+    end
+    # get nfs enabled versions
+    #--
+    # @rbs () -> ::Nl::Async::Future[Messages::DoVersionGetReply]
+    def do_version_get(**args)
+      @exchange.call(:"do", Messages::DoVersionGetRequest, Messages::DoVersionGetReply, args)
+    end
+    # set nfs running sockets
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?addr: AttributeSets::Sock) -> ::Nl::Async::Future[void]
+    def do_listener_set(**args)
+      @exchange.call(:"do", Messages::DoListenerSetRequest, nil, args)
+    end
+    # get nfs running listeners
+    #--
+    # @rbs () -> ::Nl::Async::Future[Messages::DoListenerGetReply]
+    def do_listener_get(**args)
+      @exchange.call(:"do", Messages::DoListenerGetRequest, Messages::DoListenerGetReply, args)
+    end
+    # set the current server pool-mode
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?mode: ::String) -> ::Nl::Async::Future[void]
+    def do_pool_mode_set(**args)
+      @exchange.call(:"do", Messages::DoPoolModeSetRequest, nil, args)
+    end
+    # get info about server pool-mode
+    #--
+    # @rbs () -> ::Nl::Async::Future[Messages::DoPoolModeGetReply]
+    def do_pool_mode_get(**args)
+      @exchange.call(:"do", Messages::DoPoolModeGetRequest, Messages::DoPoolModeGetReply, args)
+    end
+    # Dump all pending svc_export requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs () -> ::Nl::Async::Stream[Messages::DumpSvcExportGetReqsReply]
+    def dump_svc_export_get_reqs(**args)
+      @exchange.call(:"dump", Messages::DumpSvcExportGetReqsRequest, Messages::DumpSvcExportGetReqsReply, args)
+    end
+    # Respond to one or more svc_export requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?requests: AttributeSets::SvcExport) -> ::Nl::Async::Future[void]
+    def do_svc_export_set_reqs(**args)
+      @exchange.call(:"do", Messages::DoSvcExportSetReqsRequest, nil, args)
+    end
+    # Dump all pending expkey requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs () -> ::Nl::Async::Stream[Messages::DumpExpkeyGetReqsReply]
+    def dump_expkey_get_reqs(**args)
+      @exchange.call(:"dump", Messages::DumpExpkeyGetReqsRequest, Messages::DumpExpkeyGetReqsReply, args)
+    end
+    # Respond to one or more expkey requests
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?requests: AttributeSets::Expkey) -> ::Nl::Async::Future[void]
+    def do_expkey_set_reqs(**args)
+      @exchange.call(:"do", Messages::DoExpkeySetReqsRequest, nil, args)
+    end
+    # Flush nfsd caches (svc_export and/or expkey)
+    # 
+    # 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
+    # release NLM locks held by an IP address
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?address: ::String) -> ::Nl::Async::Future[void]
+    def do_unlock_ip(**args)
+      @exchange.call(:"do", Messages::DoUnlockIpRequest, nil, args)
+    end
+    # revoke NFS state under a filesystem path
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?path: ::String) -> ::Nl::Async::Future[void]
+    def do_unlock_filesystem(**args)
+      @exchange.call(:"do", Messages::DoUnlockFilesystemRequest, nil, args)
+    end
+    # Revoke NFSv4 state acquired through exports of a given path. Unlike unlock-filesystem, which operates at superblock granularity, this command targets only state associated with a specific export path. Userspace (exportfs -u) sends this after removing the last client for a path so the underlying filesystem can be unmounted.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?path: ::String) -> ::Nl::Async::Future[void]
+    def do_unlock_export(**args)
+      @exchange.call(:"do", Messages::DoUnlockExportRequest, 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