nl-linux 0.2.4 → 0.3.0

data/generated/nl/linux/fou.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/fou.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
 # rbs_inline: enabled
@@ -9,6 +11,7 @@ module Nl; module Linux
 class Fou < ::Nl::Family
   NAME = "fou"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("fou"))
+  MCAST_GROUPS = Ractor.make_shareable({}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
   end
   module AttributeSets
@@ -91,6 +94,8 @@ class Fou < ::Nl::Family
   end
   module Messages
     # Add port.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoAddRequest < ::Nl::Protocols::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
@@ -118,7 +123,7 @@ class Fou < ::Nl::Family
       def local_v4; attributes[:"local_v4"]&.value; end
       # Gets the value of `local-v6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def local_v6; attributes[:"local_v6"]&.value; end
       # Gets the value of `peer-v4` attribute in the message.
       #--
@@ -126,7 +131,7 @@ class Fou < ::Nl::Family
       def peer_v4; attributes[:"peer_v4"]&.value; end
       # Gets the value of `peer-v6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def peer_v6; attributes[:"peer_v6"]&.value; end
       # Gets the value of `peer-port` attribute in the message.
       #--
@@ -138,6 +143,8 @@ class Fou < ::Nl::Family
       def ifindex; attributes[:"ifindex"]&.value; end
     end
     # Delete port.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoDelRequest < ::Nl::Protocols::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
@@ -157,7 +164,7 @@ class Fou < ::Nl::Family
       def local_v4; attributes[:"local_v4"]&.value; end
       # Gets the value of `local-v6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def local_v6; attributes[:"local_v6"]&.value; end
       # Gets the value of `peer-v4` attribute in the message.
       #--
@@ -165,7 +172,7 @@ class Fou < ::Nl::Family
       def peer_v4; attributes[:"peer_v4"]&.value; end
       # Gets the value of `peer-v6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def peer_v6; attributes[:"peer_v6"]&.value; end
       # Gets the value of `peer-port` attribute in the message.
       #--
@@ -196,7 +203,7 @@ class Fou < ::Nl::Family
       def local_v4; attributes[:"local_v4"]&.value; end
       # Gets the value of `local-v6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def local_v6; attributes[:"local_v6"]&.value; end
       # Gets the value of `peer-v4` attribute in the message.
       #--
@@ -204,7 +211,7 @@ class Fou < ::Nl::Family
       def peer_v4; attributes[:"peer_v4"]&.value; end
       # Gets the value of `peer-v6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def peer_v6; attributes[:"peer_v6"]&.value; end
       # Gets the value of `peer-port` attribute in the message.
       #--
@@ -243,7 +250,7 @@ class Fou < ::Nl::Family
       def local_v4; attributes[:"local_v4"]&.value; end
       # Gets the value of `local-v6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def local_v6; attributes[:"local_v6"]&.value; end
       # Gets the value of `peer-v4` attribute in the message.
       #--
@@ -251,7 +258,7 @@ class Fou < ::Nl::Family
       def peer_v4; attributes[:"peer_v4"]&.value; end
       # Gets the value of `peer-v6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def peer_v6; attributes[:"peer_v6"]&.value; end
       # Gets the value of `peer-port` attribute in the message.
       #--
@@ -263,6 +270,13 @@ class Fou < ::Nl::Family
       def ifindex; attributes[:"ifindex"]&.value; end
     end
     # Get tunnel info.
+    class DumpGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 3
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Fou
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # Get tunnel info.
     class DumpGetReply < ::Nl::Protocols::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
@@ -290,7 +304,7 @@ class Fou < ::Nl::Family
       def local_v4; attributes[:"local_v4"]&.value; end
       # Gets the value of `local-v6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def local_v6; attributes[:"local_v6"]&.value; end
       # Gets the value of `peer-v4` attribute in the message.
       #--
@@ -298,7 +312,7 @@ class Fou < ::Nl::Family
       def peer_v4; attributes[:"peer_v4"]&.value; end
       # Gets the value of `peer-v6` attribute in the message.
       #--
-      # @rbs return: untyped
+      # @rbs return: ::String
       def peer_v6; attributes[:"peer_v6"]&.value; end
       # Gets the value of `peer-port` attribute in the message.
       #--
@@ -310,23 +324,78 @@ class Fou < ::Nl::Family
       def ifindex; attributes[:"ifindex"]&.value; end
     end
   end
+  module Notifications
+  end
+  NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # Add port.
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
-  # @rbs (?port: ::Integer, ?ipproto: ::Integer, ?type: ::Integer, ?remcsum_nopartial: ::Integer, ?local_v4: ::Integer, ?local_v6: untyped, ?peer_v4: ::Integer, ?peer_v6: untyped, ?peer_port: ::Integer, ?ifindex: ::Integer) -> void
+  # @rbs (?port: ::Integer, ?ipproto: ::Integer, ?type: ::Integer, ?remcsum_nopartial: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> void
   def do_add(**args)
     exchange_message(:"do", Messages::DoAddRequest, nil, args)
   end
   # Delete port.
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
-  # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: untyped, ?peer_v4: ::Integer, ?peer_v6: untyped, ?peer_port: ::Integer, ?ifindex: ::Integer) -> void
+  # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> void
   def do_del(**args)
     exchange_message(:"do", Messages::DoDelRequest, nil, args)
   end
   # Get tunnel info.
   #--
-  # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: untyped, ?peer_v4: ::Integer, ?peer_v6: untyped, ?peer_port: ::Integer, ?ifindex: ::Integer) -> Messages::DoGetReply
+  # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> Messages::DoGetReply
   def do_get(**args)
     exchange_message(:"do", Messages::DoGetRequest, Messages::DoGetReply, args)
   end
+  # Get tunnel info.
+  #--
+  # @rbs () -> Enumerable[Messages::DumpGetReply]
+  #   | () { (Messages::DumpGetReply) -> void } -> void
+  def dump_get(**args, &block)
+    exchange_message(:"dump", Messages::DumpGetRequest, Messages::DumpGetReply, args, &block)
+  end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # Add port.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?port: ::Integer, ?ipproto: ::Integer, ?type: ::Integer, ?remcsum_nopartial: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+    def do_add(**args)
+      @exchange.call(:"do", Messages::DoAddRequest, nil, args)
+    end
+    # Delete port.
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[void]
+    def do_del(**args)
+      @exchange.call(:"do", Messages::DoDelRequest, nil, args)
+    end
+    # Get tunnel info.
+    #--
+    # @rbs (?port: ::Integer, ?af: ::Integer, ?local_v4: ::Integer, ?local_v6: ::String, ?peer_v4: ::Integer, ?peer_v6: ::String, ?peer_port: ::Integer, ?ifindex: ::Integer) -> ::Nl::Async::Future[Messages::DoGetReply]
+    def do_get(**args)
+      @exchange.call(:"do", Messages::DoGetRequest, Messages::DoGetReply, args)
+    end
+    # Get tunnel info.
+    #--
+    # @rbs () -> ::Nl::Async::Stream[Messages::DumpGetReply]
+    def dump_get(**args)
+      @exchange.call(:"dump", Messages::DumpGetRequest, Messages::DumpGetReply, 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
 end
 end; end

data/generated/nl/linux/handshake.rb

@@ -1,5 +1,9 @@
 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
 #
+# This file is based on Documentation/netlink/specs/handshake.yaml from Linux v7.2.
+#
+# Original YNL comment:
+#
 # Author: Chuck Lever <chuck.lever@oracle.com>
 #
 # Copyright (c) 2023, Oracle and/or its affiliates.
@@ -14,6 +18,7 @@ module Nl; module Linux
 class Handshake < ::Nl::Family
   NAME = "handshake"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("handshake"))
+  MCAST_GROUPS = Ractor.make_shareable({:"none" => ::Nl::McastGroup.new("none", nil), :"tlshd" => ::Nl::McastGroup.new("tlshd", nil)}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
   end
   module AttributeSets
@@ -153,6 +158,8 @@ class Handshake < ::Nl::Family
   end
   module Messages
     # Handler retrieves next queued handshake request
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoAcceptRequest < ::Nl::Protocols::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
@@ -164,6 +171,8 @@ class Handshake < ::Nl::Family
       def handler_class; attributes[:"handler_class"]&.value; end
     end
     # Handler retrieves next queued handshake request
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoAcceptReply < ::Nl::Protocols::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
@@ -203,6 +212,8 @@ class Handshake < ::Nl::Family
       def keyring; attributes[:"keyring"]&.value; end
     end
     # Handler reports handshake completion
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoDoneRequest < ::Nl::Protocols::Genl::Message
       TYPE = 3
       FIXED_HEADER = nil
@@ -222,17 +233,98 @@ class Handshake < ::Nl::Family
       def remote_auth; attributes[:"remote_auth"]&.value; end
     end
   end
+  module Notifications
+    # Notify handlers that a new handshake request is waiting
+    class Ready < ::Nl::Protocols::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Accept
+      ATTRIBUTES = Ractor.make_shareable(%i[sockfd message_type timeout auth_mode peer_identity certificate peername keyring])
+      # Gets the value of `sockfd` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def sockfd; attributes[:"sockfd"]&.value; end
+      # Gets the value of `message-type` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def message_type; attributes[:"message_type"]&.value; end
+      # Gets the value of `timeout` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def timeout; attributes[:"timeout"]&.value; end
+      # Gets the value of `auth-mode` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def auth_mode; attributes[:"auth_mode"]&.value; end
+      # Gets the value of `peer-identity` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def peer_identity; attributes[:"peer_identity"]&.value; end
+      # Gets the value of `certificate` attribute in the message.
+      #--
+      # @rbs return: AttributeSets::X509
+      def certificate; attributes[:"certificate"]&.value; end
+      # Gets the value of `peername` attribute in the message.
+      #--
+      # @rbs return: ::String
+      def peername; attributes[:"peername"]&.value; end
+      # Gets the value of `keyring` attribute in the message.
+      #--
+      # @rbs return: ::Integer
+      def keyring; attributes[:"keyring"]&.value; end
+    end
+  end
+  NOTIFICATIONS = Ractor.make_shareable({1 => Notifications::Ready}) #: Hash[::Integer, ::Class]
   # Handler retrieves next queued handshake request
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?handler_class: ::Integer) -> Messages::DoAcceptReply
   def do_accept(**args)
     exchange_message(:"do", Messages::DoAcceptRequest, Messages::DoAcceptReply, args)
   end
   # Handler reports handshake completion
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?status: ::Integer, ?sockfd: ::Integer, ?remote_auth: ::Integer) -> void
   def do_done(**args)
     exchange_message(:"do", Messages::DoDoneRequest, nil, args)
   end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # Handler retrieves next queued handshake request
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?handler_class: ::Integer) -> ::Nl::Async::Future[Messages::DoAcceptReply]
+    def do_accept(**args)
+      @exchange.call(:"do", Messages::DoAcceptRequest, Messages::DoAcceptReply, args)
+    end
+    # Handler reports handshake completion
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?status: ::Integer, ?sockfd: ::Integer, ?remote_auth: ::Integer) -> ::Nl::Async::Future[void]
+    def do_done(**args)
+      @exchange.call(:"do", Messages::DoDoneRequest, 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 | :tlshd) groups) -> self
+  def subscribe(*groups) = super
+  #--
+  # @rbs (*(:none | :tlshd) groups) -> self
+  def unsubscribe(*groups) = super
 end
 end; end

data/generated/nl/linux/lockd.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/lockd.yaml from Linux v7.2.
 #--
 # frozen_string_literal: true
 # rbs_inline: enabled
@@ -9,6 +11,7 @@ module Nl; module Linux
 class Lockd < ::Nl::Family
   NAME = "lockd"
   PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("lockd"))
+  MCAST_GROUPS = Ractor.make_shareable({}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
   end
   module AttributeSets
@@ -51,6 +54,8 @@ class Lockd < ::Nl::Family
   end
   module Messages
     # set the lockd server parameters
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
     class DoServerSetRequest < ::Nl::Protocols::Genl::Message
       TYPE = 1
       FIXED_HEADER = nil
@@ -70,6 +75,13 @@ class Lockd < ::Nl::Family
       def udp_port; attributes[:"udp_port"]&.value; end
     end
     # get the lockd server parameters
+    class DoServerGetRequest < ::Nl::Protocols::Genl::Message
+      TYPE = 2
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Server
+      ATTRIBUTES = Ractor.make_shareable(%i[])
+    end
+    # get the lockd server parameters
     class DoServerGetReply < ::Nl::Protocols::Genl::Message
       TYPE = 2
       FIXED_HEADER = nil
@@ -89,11 +101,49 @@ class Lockd < ::Nl::Family
       def udp_port; attributes[:"udp_port"]&.value; end
     end
   end
+  module Notifications
+  end
+  NOTIFICATIONS = Ractor.make_shareable({}) #: Hash[::Integer, ::Class]
   # set the lockd server parameters
+  # 
+  # Requires CAP_NET_ADMIN in the initial user namespace.
   #--
   # @rbs (?gracetime: ::Integer, ?tcp_port: ::Integer, ?udp_port: ::Integer) -> void
   def do_server_set(**args)
     exchange_message(:"do", Messages::DoServerSetRequest, nil, args)
   end
+  # get the lockd server parameters
+  #--
+  # @rbs () -> Messages::DoServerGetReply
+  def do_server_get(**args)
+    exchange_message(:"do", Messages::DoServerGetRequest, Messages::DoServerGetReply, args)
+  end
+  class AsyncOperations
+    # :nodoc:
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+    # set the lockd server parameters
+    # 
+    # Requires CAP_NET_ADMIN in the initial user namespace.
+    #--
+    # @rbs (?gracetime: ::Integer, ?tcp_port: ::Integer, ?udp_port: ::Integer) -> ::Nl::Async::Future[void]
+    def do_server_set(**args)
+      @exchange.call(:"do", Messages::DoServerSetRequest, nil, args)
+    end
+    # get the lockd server parameters
+    #--
+    # @rbs () -> ::Nl::Async::Future[Messages::DoServerGetReply]
+    def do_server_get(**args)
+      @exchange.call(:"do", Messages::DoServerGetRequest, Messages::DoServerGetReply, 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
 end
 end; end