nl 0.3.0 → 0.4.1

data/sig/generated/nl/raw/wire.rbs

@@ -0,0 +1,151 @@
+# Generated from lib/nl/raw/wire.rb with RBS::Inline
+
+module Nl
+  module Raw
+    # Constants from <linux/netlink.h>
+    module Constants
+      NETLINK_ROUTE: ::Integer
+
+      NETLINK_NETFILTER: ::Integer
+
+      NETLINK_GENERIC: ::Integer
+
+      NLM_F_REQUEST: ::Integer
+
+      NLM_F_MULTI: ::Integer
+
+      NLM_F_ACK: ::Integer
+
+      NLM_F_ECHO: ::Integer
+
+      NLM_F_DUMP_INTR: ::Integer
+
+      NLM_F_DUMP_FILTERED: ::Integer
+
+      NLM_F_ROOT: ::Integer
+
+      NLM_F_MATCH: ::Integer
+
+      NLM_F_ATOMIC: ::Integer
+
+      NLM_F_DUMP: untyped
+
+      NLM_F_REPLACE: ::Integer
+
+      NLM_F_EXCL: ::Integer
+
+      NLM_F_CREATE: ::Integer
+
+      NLM_F_APPEND: ::Integer
+
+      NLMSG_ALIGNTO: ::Integer
+
+      NLMSG_HDRLEN: ::Integer
+
+      NLMSG_NOOP: ::Integer
+
+      NLMSG_ERROR: ::Integer
+
+      NLMSG_DONE: ::Integer
+
+      NLMSG_OVERRUN: ::Integer
+
+      NLMSG_MIN_TYPE: ::Integer
+
+      NLA_F_NESTED: untyped
+
+      NLA_F_NET_BYTEORDER: untyped
+
+      NLA_TYPE_MASK: untyped
+
+      NLA_ALIGNTO: ::Integer
+
+      NLA_HDRLEN: ::Integer
+    end
+
+    include Constants
+
+    # Fixed-format metadata header prepended to every Netlink message.
+    #
+    # This corresponds to Linux's +struct nlmsghdr+.
+    #
+    # @!attribute [rw] len
+    #   @return [Integer] message length in bytes, including this header
+    # @!attribute [rw] type
+    #   @return [Integer] message content type
+    # @!attribute [rw] flags
+    #   @return [Integer] bitwise combination of +NLM_F_+ flags
+    # @!attribute [rw] seq
+    #   @return [Integer] sequence number used to correlate requests and replies
+    # @!attribute [rw] pid
+    #   @return [Integer] sender's Netlink port ID
+    class NlMsgHdr < Struct[Integer]
+      attr_accessor len(): Integer
+
+      attr_accessor type(): Integer
+
+      attr_accessor flags(): Integer
+
+      attr_accessor seq(): Integer
+
+      attr_accessor pid(): Integer
+
+      def self.new: (?Integer len, ?Integer type, ?Integer flags, ?Integer seq, ?Integer pid) -> instance
+                  | (?len: Integer, ?type: Integer, ?flags: Integer, ?seq: Integer, ?pid: Integer) -> instance
+    end
+
+    class NlMsgHdr
+      FORMAT: untyped
+
+      # Decodes a header from the decoder's current position.
+      #
+      # @param [Decoder] decoder the source decoder
+      # @return [NlMsgHdr] the decoded header
+      # @rbs (Decoder decoder) -> instance
+      def self.decode: (Decoder decoder) -> instance
+
+      # Encodes this header at the encoder's current position.
+      #
+      # @param [Encoder] encoder the destination encoder
+      # @return [void]
+      # @rbs (Encoder encoder) -> void
+      def encode: (Encoder encoder) -> void
+    end
+
+    # Fixed-format header prepended to every Netlink attribute.
+    #
+    # This corresponds to Linux's +struct nlattr+.
+    #
+    # @!attribute [rw] len
+    #   @return [Integer] attribute length in bytes, including this header but
+    #     excluding trailing alignment padding
+    # @!attribute [rw] type
+    #   @return [Integer] attribute type combined with optional +NLA_F_+ flags
+    class NlAttr < Struct[Integer]
+      attr_accessor len(): Integer
+
+      attr_accessor type(): Integer
+
+      def self.new: (?Integer len, ?Integer type) -> instance
+                  | (?len: Integer, ?type: Integer) -> instance
+    end
+
+    class NlAttr
+      FORMAT: untyped
+
+      # Decodes an attribute header from the decoder's current position.
+      #
+      # @param [Decoder] decoder the source decoder
+      # @return [NlAttr] the decoded header
+      # @rbs (Decoder decoder) -> instance
+      def self.decode: (Decoder decoder) -> instance
+
+      # Encodes this attribute header at the encoder's current position.
+      #
+      # @param [Encoder] encoder the destination encoder
+      # @return [void]
+      # @rbs (Encoder encoder) -> void
+      def encode: (Encoder encoder) -> void
+    end
+  end
+end

data/sig/generated/nl/raw.rbs

@@ -0,0 +1,70 @@
+# Generated from lib/nl/raw.rb with RBS::Inline
+
+module Nl
+  # Classic (Raw) Netlink families.
+  module Raw
+    # Base class for Raw Netlink families.
+    class Family < Nl::Family
+      # Opens a session for this raw Netlink family.
+      #
+      # @overload open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+      #   The caller is responsible for closing the session.
+      #   @param [:thread, :fiber, nil] executor the asynchronous executor, or `nil` for blocking operation
+      #   @param [Integer] notification_capacity the maximum number of queued notifications
+      #   @return [Family] the opened family session
+      # @overload open(executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY, &block)
+      #   The session is automatically closed after the block returns.
+      #   @param [:thread, :fiber, nil] executor the asynchronous executor, or `nil` for blocking operation
+      #   @param [Integer] notification_capacity the maximum number of queued notifications
+      #   @yieldparam [Family] session the opened family session
+      #   @return [Object] the value returned from the block
+      # @rbs (?executor: executor?, ?notification_capacity: Integer?) -> (Nl::Family::Session & instance)
+      #    | [R] (?executor: executor?, ?notification_capacity: Integer?) { (instance) -> R } -> R
+      def self.open: (?executor: executor?, ?notification_capacity: Integer?) -> (Nl::Family::Session & instance)
+                   | [R] (?executor: executor?, ?notification_capacity: Integer?) { (instance) -> R } -> R
+
+      # Builds a session that owns its underlying client.
+      #
+      # @param [:thread, :fiber, nil] executor the asynchronous executor, or `nil` for blocking operation
+      # @param [Integer] notification_capacity the maximum number of queued notifications
+      # @return [Family] the opened family session
+      # @rbs (executor: executor?, notification_capacity: Integer) -> (Nl::Family::Session & instance)
+      private def self.build_session: (executor: executor?, notification_capacity: Integer) -> (Nl::Family::Session & instance)
+    end
+
+    # Base class for raw Netlink messages.
+    #
+    # A message may contain a fixed header followed by a set of Netlink
+    # attributes.
+    class Message
+      include Nl::StructuredPayload
+
+      # @param [Object, nil] fixed_header the family-specific fixed header
+      # @param [AttributeSet, nil] attributes the message's attributes
+      # @rbs (?untyped fixed_header, ?AttributeSet? attributes) -> void
+      def initialize: (?untyped fixed_header, ?AttributeSet? attributes) -> void
+
+      # Appends an attribute to the message.
+      #
+      # @param [AttributeSet::Attribute] attribute the attribute to append
+      # @return [void]
+      # @rbs (AttributeSet::Attribute attribute) -> void
+      def append_attribute: (AttributeSet::Attribute attribute) -> void
+
+      # Decodes a raw Netlink message payload.
+      #
+      # @param [Decoder] decoder the source decoder
+      # @param [Integer] type the message type from its Netlink header
+      # @return [Message] the decoded message
+      # @raise [RuntimeError] if +type+ does not match the message class's type
+      # @rbs (Decoder decoder, type: Integer) -> instance
+      def self.decode: (Decoder decoder, type: Integer) -> instance
+
+      # Returns the attribute names accepted by this message.
+      #
+      # @return [Array<Symbol>] the attribute names
+      # @rbs () -> Array[Symbol]
+      private def self.attribute_names: () -> Array[Symbol]
+    end
+  end
+end

data/sig/generated/nl/sequence_allocator.rbs

@@ -0,0 +1,15 @@
+# Generated from lib/nl/sequence_allocator.rb with RBS::Inline
+
+module Nl
+  # Allocates nonzero 32-bit Netlink sequence numbers.
+  class SequenceAllocator
+    MAX: ::Integer
+
+    def initialize: () -> untyped
+
+    # Returns the next sequence number not rejected by the optional block.
+    def next: () -> untyped
+
+    private def advance: () -> untyped
+  end
+end

data/sig/generated/nl/socket.rbs

@@ -0,0 +1,40 @@
+# Generated from lib/nl/socket.rb with RBS::Inline
+
+module Nl
+  # Netlink socket
+  class Socket < ::Socket
+    module Constants
+      # From include/linux/socket.h
+      PF_NETLINK: untyped
+
+      # From include/uapi/linux/netlink.h
+      SOL_NETLINK: ::Integer
+
+      NETLINK_ADD_MEMBERSHIP: ::Integer
+
+      NETLINK_DROP_MEMBERSHIP: ::Integer
+    end
+
+    include Constants
+
+    def self.pack_sockaddr_nl: (untyped pid, untyped groups) -> untyped
+
+    alias self.sockaddr_nl self.pack_sockaddr_nl
+
+    def self.unpack_sockaddr_nl: (untyped sockaddr) -> untyped
+
+    # @param protonum [Integer] Netlink protocol number
+    def initialize: (untyped protonum) -> untyped
+
+    def self.open: (untyped protonum) -> untyped
+
+    # @return [Integer] Local Netlink port ID assigned to this socket
+    def local_port_id: () -> untyped
+
+    # Adds this socket to a Netlink multicast group.
+    def add_membership: (untyped group_id) -> untyped
+
+    # Removes this socket from a Netlink multicast group.
+    def drop_membership: (untyped group_id) -> untyped
+  end
+end

data/sig/generated/nl/structured_payload.rbs

@@ -0,0 +1,25 @@
+# Generated from lib/nl/structured_payload.rb with RBS::Inline
+
+module Nl
+  # Shared handling for a payload containing an optional fixed header followed
+  # by an optional attribute set.
+  module StructuredPayload
+    def self.included: (untyped base) -> untyped
+
+    attr_accessor fixed_header: untyped
+
+    attr_accessor attributes: untyped
+
+    def initialize: (?untyped fixed_header, ?untyped attributes) -> untyped
+
+    module ClassMethods
+      def from_params: (?untyped params, ?external_selectors: untyped, **untyped keywords) -> untyped
+
+      def decode: (untyped decoder, ?external_selectors: untyped) -> untyped
+
+      private def attribute_names: () -> untyped
+    end
+
+    def encode: (untyped encoder, ?external_selectors: untyped) -> untyped
+  end
+end

data/sig/generated/nl/sub_message.rbs

@@ -0,0 +1,74 @@
+# Generated from lib/nl/sub_message.rb with RBS::Inline
+
+module Nl
+  module Selector
+    class MissingSelectorValueError < StandardError
+      attr_reader scope: untyped
+
+      attr_reader index: untyped
+
+      def initialize: (untyped scope, untyped index) -> untyped
+    end
+
+    class UnknownSelectorValueError < StandardError
+      attr_reader value: untyped
+
+      def initialize: (untyped value) -> untyped
+    end
+
+    module Reference
+      def select: (untyped context, untyped formats) -> untyped
+    end
+
+    class Local < Data
+      attr_reader index(): untyped
+
+      def self.new: (untyped index) -> instance
+                  | (index: untyped) -> instance
+
+      def self.members: () -> [ :index ]
+
+      def members: () -> [ :index ]
+    end
+
+    class External < Data
+      attr_reader index(): untyped
+
+      def self.new: (untyped index) -> instance
+                  | (index: untyped) -> instance
+
+      def self.members: () -> [ :index ]
+
+      def members: () -> [ :index ]
+    end
+
+    class State
+      def initialize: (untyped local_count, untyped external) -> untyped
+
+      def set_local: (untyped index, untyped value) -> untyped
+
+      def fetch_local: (untyped index) -> untyped
+
+      def fetch_external: (untyped index) -> untyped
+
+      def fetch: (untyped values, untyped key) -> untyped
+    end
+  end
+
+  # A selector-specific payload containing an optional fixed header followed by
+  # an optional set of Netlink attributes.
+  class SubMessage
+    include StructuredPayload
+  end
+
+  # An unrecognized selector-specific payload retained without interpretation.
+  class RawSubMessage < SubMessage
+    attr_reader payload: untyped
+
+    attr_reader nlattr_type_flags: untyped
+
+    def initialize: (untyped payload, nlattr_type_flags: untyped) -> untyped
+
+    def encode: (untyped encoder, ?external_selectors: untyped) -> untyped
+  end
+end

data/sig/generated/nl/version.rbs

@@ -0,0 +1,5 @@
+# Generated from lib/nl/version.rb with RBS::Inline
+
+module Nl
+  VERSION: ::String
+end

data/sig/generated/nl.rbs

@@ -0,0 +1,2 @@
+# Generated from lib/nl.rb with RBS::Inline
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Kasumi Hanazuki
@@ -28,10 +28,12 @@ files:
 - lib/nl/async/driver.rb
 - lib/nl/async/mailbox.rb
 - lib/nl/async/operation.rb
+- lib/nl/attribute_set.rb
+- lib/nl/bitfield32.rb
 - lib/nl/blocking_transport.rb
 - lib/nl/connection.rb
-- lib/nl/core.rb
 - lib/nl/datagram.rb
+- lib/nl/datatypes.rb
 - lib/nl/decoder.rb
 - lib/nl/encoder.rb
 - lib/nl/endian.rb
@@ -39,20 +41,59 @@ files:
 - lib/nl/exchange.rb
 - lib/nl/family.rb
 - lib/nl/genl.rb
-- lib/nl/genl/connection.rb
+- lib/nl/genl/client.rb
+- lib/nl/genl/protocol.rb
+- lib/nl/genl/wire.rb
 - lib/nl/notification.rb
 - lib/nl/notification_router.rb
-- lib/nl/protocols/genl.rb
-- lib/nl/protocols/raw.rb
+- lib/nl/raw.rb
+- lib/nl/raw/client.rb
+- lib/nl/raw/protocol.rb
+- lib/nl/raw/wire.rb
 - lib/nl/sequence_allocator.rb
 - lib/nl/socket.rb
+- lib/nl/structured_payload.rb
+- lib/nl/sub_message.rb
 - lib/nl/version.rb
+- sig/generated/nl.rbs
+- sig/generated/nl/async.rbs
+- sig/generated/nl/async/dispatcher.rbs
+- sig/generated/nl/async/driver.rbs
+- sig/generated/nl/async/mailbox.rbs
+- sig/generated/nl/async/operation.rbs
+- sig/generated/nl/attribute_set.rbs
+- sig/generated/nl/bitfield32.rbs
+- sig/generated/nl/blocking_transport.rbs
+- sig/generated/nl/connection.rbs
+- sig/generated/nl/datagram.rbs
+- sig/generated/nl/datatypes.rbs
+- sig/generated/nl/decoder.rbs
+- sig/generated/nl/encoder.rbs
+- sig/generated/nl/endian.rbs
+- sig/generated/nl/error.rbs
+- sig/generated/nl/exchange.rbs
+- sig/generated/nl/family.rbs
+- sig/generated/nl/genl.rbs
+- sig/generated/nl/genl/client.rbs
+- sig/generated/nl/genl/protocol.rbs
+- sig/generated/nl/genl/wire.rbs
+- sig/generated/nl/notification.rbs
+- sig/generated/nl/notification_router.rbs
+- sig/generated/nl/raw.rbs
+- sig/generated/nl/raw/client.rbs
+- sig/generated/nl/raw/protocol.rbs
+- sig/generated/nl/raw/wire.rbs
+- sig/generated/nl/sequence_allocator.rbs
+- sig/generated/nl/socket.rbs
+- sig/generated/nl/structured_payload.rbs
+- sig/generated/nl/sub_message.rbs
+- sig/generated/nl/version.rbs
 homepage: https://github.com/hanazuki/nl
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/hanazuki/nl
-  source_code_uri: https://github.com/hanazuki/nl/tree/v0.3.0
+  source_code_uri: https://github.com/hanazuki/nl/tree/v0.4.1
   changelog_uri: https://github.com/hanazuki/nl/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -68,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Netlink protocol support for Ruby
 test_files: []

data/lib/nl/core.rb

@@ -1,94 +0,0 @@
-# Netlink wire definitions
-
-require_relative 'endian'
-
-module Nl
-  module Core
-    module Constants
-      # From include/uapi/linux/netlink.h
-      NETLINK_ROUTE = 0
-      NETLINK_NETFILTER = 12
-      NETLINK_GENERIC = 16
-
-      NLM_F_REQUEST = 1
-      NLM_F_MULTI = 2
-      NLM_F_ACK = 4
-      NLM_F_ECHO = 8
-      NLM_F_DUMP_INTR = 16
-      NLM_F_DUMP_FILTERED = 32
-      NLM_F_ROOT = 0x100
-      NLM_F_MATCH = 0x200
-      NLM_F_ATOMIC = 0x400
-      NLM_F_DUMP = NLM_F_ROOT | NLM_F_MATCH
-      NLM_F_REPLACE = 0x100
-      NLM_F_EXCL = 0x200
-      NLM_F_CREATE = 0x400
-      NLM_F_APPEND = 0x800
-
-      NLMSG_ALIGNTO = 4
-      NLMSG_HDRLEN = 16
-
-      NLMSG_NOOP = 0x1
-      NLMSG_ERROR = 0x2
-      NLMSG_DONE = 0x3
-      NLMSG_OVERRUN = 0x4
-
-      NLMSG_MIN_TYPE = 0x10
-
-      NLA_F_NESTED = 1 << 15
-      NLA_F_NET_BYTEORDER = 1 << 14
-      NLA_TYPE_MASK = ~(NLA_F_NESTED | NLA_F_NET_BYTEORDER)
-
-      NLA_ALIGNTO = 4
-      NLA_HDRLEN = 4
-    end
-    include Constants
-
-    NlMsgHdr = Struct.new(:len, :type, :flags, :seq, :pid)
-    # Message header
-    class NlMsgHdr
-      FORMAT = Ractor.make_shareable([
-        Endian::Host::U32,
-        Endian::Host::U16,
-        Endian::Host::U16,
-        Endian::Host::U32,
-        Endian::Host::U32,
-      ])
-      private_constant :FORMAT
-
-      def self.decode(decoder)
-        obj = new(*decoder.get_values(FORMAT))
-        decoder.align_to(Constants::NLMSG_ALIGNTO)
-        obj
-      end
-
-      def encode(encoder)
-        encoder.reserve(Constants::NLMSG_HDRLEN)
-        encoder.put_values(FORMAT, to_a)
-        encoder.align_to(Constants::NLMSG_ALIGNTO)
-      end
-    end
-
-    NlAttr = Struct.new(:len, :type)
-    # Attribute header
-    class NlAttr
-      FORMAT = Ractor.make_shareable([
-        Endian::Host::U16,
-        Endian::Host::U16,
-      ])
-      private_constant :FORMAT
-
-      def self.decode(decoder)
-        obj = new(*decoder.get_values(FORMAT))
-        decoder.align_to(Constants::NLA_ALIGNTO)
-        obj
-      end
-
-      def encode(encoder)
-        encoder.reserve(Constants::NLA_HDRLEN)
-        encoder.put_values(FORMAT, to_a)
-        encoder.align_to(Constants::NLA_ALIGNTO)
-      end
-    end
-  end
-end

data/lib/nl/genl/connection.rb

@@ -1,89 +0,0 @@
-# Generic Netlink connection handling
-#--
-# rbs_inline: enabled
-
-require_relative '../connection'
-require_relative '../core'
-require_relative '../protocols/genl'
-
-module Nl
-  module Genl
-    FamilyInfo = Data.define(:id, :multicast_groups) do
-      def self.from_reply(reply)
-        groups = (reply.mcast_groups || []).to_h do |attributes|
-          [attributes[:name].value.to_sym, attributes[:id].value]
-        end
-        new(id: reply.family_id, multicast_groups: groups.freeze)
-      end
-    end
-
-    class Connection
-      #--
-      # @rbs (resolver: ^(instance, ::String) -> (Integer | FamilyInfo | untyped), ?executor: executor?, ?notification_capacity: Integer?) -> instance
-      #  | [R] (resolver: ^(instance, ::String) -> (Integer | FamilyInfo | untyped), ?executor: executor?, ?notification_capacity: Integer?) { (instance) -> R } -> R
-      def self.open(resolver:, executor: nil, notification_capacity: Nl::Connection::DEFAULT_NOTIFICATION_CAPACITY)
-        conn = new(resolver:, executor:, notification_capacity:)
-        if block_given?
-          begin
-            yield conn
-          ensure
-            conn.close
-          end
-        else
-          conn
-        end
-      end
-
-      #--
-      # @rbs resolver: ^(instance, ::String) -> (Integer | FamilyInfo | untyped)
-      # @rbs executor: executor?
-      # @rbs return: instance
-      def initialize(resolver:, executor: nil, notification_capacity: Nl::Connection::DEFAULT_NOTIFICATION_CAPACITY)
-        @resolver = resolver
-        @family_cache = {}
-        @family_cache_mutex = Mutex.new
-        @connection = Nl::Connection.new(
-          protocol: Protocols::Genl,
-          executor:,
-          notification_capacity:,
-        )
-      end
-
-      def family(family_class)
-        proto = family_class::PROTOCOL
-        info = family_info(proto)
-        family_class.new(
-          @connection,
-          protocol: Protocols::Genl.new(
-            proto.name,
-            family_id: info.id,
-            multicast_groups: info.multicast_groups,
-          ),
-        )
-      end
-
-      def close
-        @connection.close
-      end
-
-      private def family_info(protocol)
-        id = protocol.family_id
-        FamilyInfo.new(id:, multicast_groups: {}.freeze)
-      rescue NotImplementedError
-        cached_info = @family_cache_mutex.synchronize { @family_cache[protocol.name] }
-        return cached_info if cached_info
-
-        resolved = @resolver.call(self, protocol.name)
-        info = case resolved
-        when Integer
-          FamilyInfo.new(id: resolved, multicast_groups: {}.freeze)
-        when FamilyInfo
-          resolved
-        else
-          FamilyInfo.from_reply(resolved)
-        end
-        @family_cache_mutex.synchronize { @family_cache[protocol.name] ||= info }
-      end
-    end
-  end
-end