nl-linux 0.2.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bea36721f23b526f593ceee10b7fbe2c420e511a3574e49134982af1d354ee2
-  data.tar.gz: 07b51dcce909e7df313cd4bbef6eeaa8d1bbae82ed36258d75dc0f4bbd9f845d
+  metadata.gz: e70391884268288b55d3d2edfc5c1d6098d9e024f5f3fed11c5bffa3cc5e126d
+  data.tar.gz: 1cea0a6656c54771123617dc4cb9bcd9a9d977008cabe156257642b3c39e2bb7
 SHA512:
-  metadata.gz: a3155f82614682291afe91ebe8d59858888fd25c7a12ce45d19b323a06463f78e301194303a4b378ca80b17d4c9f22fbc4a9388823b9066470afb8bc101c150a
-  data.tar.gz: aef40e37d4591c13f65cdb02ab7bb9963dda593be5a726981bd267b48170e312257d1e2ab02a1806089cf77ec6b522840ee77caff660e44b2b10d3b77e5f2a53
+  metadata.gz: dcdce1ce44505fa4b856e3d50f573f1fb2314b856b36c42bc3e777b86af125aa3981dcc93860480c0cdaf909ecea9c9b2d3ff6c4422c4d27d1e77ce2440b3857
+  data.tar.gz: 7d3d92cb1104e2eb8d1e35521d62030e60d1f521498400fb55d518b1d8cc6b3c7485ee2a2e2e0fdd702ef3fd9dca5fe9d1202e3b6ae88feccdbfbbf43b3b4407

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1,5 @@
+--tag rbs:RBS
+--hide-tag rbs
+--no-private
+lib/**/*.rb
+generated/**/*.rb

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+## v0.4.1 (2026-09-08)
+
+## v0.4.0 (2026-09-08)
+
+- Generate sub-messages.
+
+## v0.3.0 (2026-09-01)
+
 ## v0.2.4 (2026-08-22)
 
 - Update kernel YNL specification from Linux 7.2.

data/Rakefile

@@ -1,5 +1,8 @@
 require 'rspec/core/rake_task'
 
+NLSPEC_PATH = 'Documentation/netlink/specs'
+NLSPEC_VERSION = File.read('NLSPEC_VERSION').chomp
+
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
@@ -20,24 +23,35 @@ end
 specs.each do |spec, h|
   h => {source:, target:}
   task :generate => target
-  task target => [source, 'generated/nl/linux'] do
+  task target => [source, 'generated/nl/linux', 'NLSPEC_VERSION', 'Rakefile'] do
     require 'ynl'
     File.open(source, 'r') do |src|
-      front = src.readlines.take_while {|l| !l.start_with?('---') }.grep(/\A\#/).join
+      comments = src.readlines.take_while {|l| !l.start_with?('---') }.grep(/\A\#/)
 
       File.open(target, 'w') do |out|
-        out << front
+        out << comments.shift
+        out << "#\n"
+        out << "# This file is based on #{NLSPEC_PATH}/#{spec} from Linux v#{NLSPEC_VERSION}.\n"
+        unless comments.empty?
+          out << "#\n"
+          out << "# Original YNL comment:\n"
+          out << comments.join
+        end
         out << "#--\n"
         out << Ynl::Generator::PRELUDE
         out << "module Nl; module Linux\n"
-        Ynl::Family.generate(src.tap(&:rewind), out)
+        Ynl::Family.generate(
+          src.tap(&:rewind),
+          out,
+          default_resolver: '::Nl::Linux::DEFAULT_RESOLVER',
+        )
         out << "end; end\n"
       end
     end
   end
 end
 
-task 'generated/nl/linux.rb' => specs.values.map { it[:target] } do |t|
+task 'generated/nl/linux.rb' => [*specs.values.map { it[:target] }, 'Rakefile'] do |t|
   File.open(t.name, 'w') do |out|
     out << "require 'nl/linux/version'\n"
     out << "module Nl\n"
@@ -50,8 +64,16 @@ task 'generated/nl/linux.rb' => specs.values.map { it[:target] } do |t|
     end
     out << "  end\n"
     out << "end\n"
+    out << "require 'nl/linux/nlctrl_resolver'\n"
   end
 end
 task :generate => 'generated/nl/linux.rb'
 
+desc 'Generate RBS signatures from inline annotations'
+task :rbs => :generate do
+  sh '../bin/rbs-inline', '--output=sig/generated', '--opt-out', '--base=lib:generated', 'lib', 'generated'
+end
+
+task :build => :rbs
+
 task :default => :generate

data/generated/nl/linux/binder.rb

@@ -1,96 +1,304 @@
 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
 #
+# This file is based on Documentation/netlink/specs/binder.yaml from Linux v7.2.
+#
+# Original YNL comment:
+#
 # Copyright 2025 Google LLC
 #
 #--
 # frozen_string_literal: true
-# rbs_inline: enabled
 # This code is generated by Ynl::Generator. DO NOT EDIT.
 require 'nl'
 module Nl; module Linux
 # Binder interface over generic netlink
-class Binder < ::Nl::Family
+class Binder < ::Nl::Genl::Family
   NAME = "binder"
-  PROTOCOL = Ractor.make_shareable(::Nl::Protocols::Genl.new("binder"))
+  VERSION = 1
+  # @rbs (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+  # @rbs | [R] (?resolver: ^(::Nl::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) { (instance) -> R } -> R
+  # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+  #   @param [#call] resolver
+  #   @param [Symbol, nil] executor
+  #   @param [Integer, nil] notification_capacity
+  #   @return [Binder]
+  # @overload open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY, &block)
+  #   @param [#call] resolver
+  #   @param [Symbol, nil] executor
+  #   @param [Integer, nil] notification_capacity
+  #   @yieldparam [Binder] family
+  #   @return [Object] the result of the block
+  def self.open(resolver: ::Nl::Linux::DEFAULT_RESOLVER, executor: nil, notification_capacity: DEFAULT_NOTIFICATION_CAPACITY)
+    super
+  end
+  # @private
+  MCAST_GROUPS = Ractor.make_shareable({:"report" => ::Nl::McastGroup.new("report", nil)}) #: Hash[::Symbol, ::Nl::McastGroup]
   module Structs
   end
   module AttributeSets
     # Attributes included within a transaction failure report. The elements
     # correspond directly with the specific transaction that failed, along
     # with the error returned to the sender e.g. BR_DEAD_REPLY.
-    class Report < ::Nl::Protocols::Genl::AttributeSet
+    class Report < ::Nl::AttributeSet
       # Abstract class
-      class Attribute < ::Nl::Protocols::Genl::AttributeSet::Attribute
+      class Attribute < ::Nl::AttributeSet::Attribute
       end
+      # The enum binder_driver_return_protocol returned to the sender.
       class Error < Attribute
         TYPE = 1
         NAME = :"error"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 0
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # The binder context where the transaction occurred.
       class Context < Attribute
         TYPE = 2
         NAME = :"context"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::String.new(check: nil)
+        # @private
+        ORDER = 1
+        # @private
+        DATATYPE = ::Nl::DataTypes::String.new(check: nil)
       end
+      # The PID of the sender process.
       class FromPid < Attribute
         TYPE = 3
         NAME = :"from_pid"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 2
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # The TID of the sender thread.
       class FromTid < Attribute
         TYPE = 4
         NAME = :"from_tid"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 3
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # The PID of the recipient process. This attribute may not be present
+      # if the target could not be determined.
       class ToPid < Attribute
         TYPE = 5
         NAME = :"to_pid"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 4
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # The TID of the recipient thread. This attribute may not be present
+      # if the target could not be determined.
       class ToTid < Attribute
         TYPE = 6
         NAME = :"to_tid"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 5
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # When present, indicates the failed transaction is a reply.
       class IsReply < Attribute
         TYPE = 7
         NAME = :"is_reply"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Flag.new
+        # @private
+        ORDER = 6
+        # @private
+        DATATYPE = ::Nl::DataTypes::Flag.new
       end
+      # The bitmask of enum transaction_flags from the transaction.
       class Flags < Attribute
         TYPE = 8
         NAME = :"flags"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 7
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # The application-defined code from the transaction.
       class Code < Attribute
         TYPE = 9
         NAME = :"code"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 8
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
+      # The transaction payload size in bytes.
       class DataSize < Attribute
         TYPE = 10
         NAME = :"data_size"
-        DATATYPE = ::Nl::Protocols::Genl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
+        # @private
+        ORDER = 9
+        # @private
+        DATATYPE = ::Nl::DataTypes::Scalar.new(::Nl::Endian::Host::U32, check: nil)
       end
-      # :nodoc:
+      # @private
       BY_NAME = Ractor.make_shareable({:"error" => Error, :"context" => Context, :"from_pid" => FromPid, :"from_tid" => FromTid, :"to_pid" => ToPid, :"to_tid" => ToTid, :"is_reply" => IsReply, :"flags" => Flags, :"code" => Code, :"data_size" => DataSize}) #: Hash[::Symbol, Attribute]
-      # :nodoc:
+      # @private
       BY_TYPE = Ractor.make_shareable({1 => Error, 2 => Context, 3 => FromPid, 4 => FromTid, 5 => ToPid, 6 => ToTid, 7 => IsReply, 8 => Flags, 9 => Code, 10 => DataSize}) #: Hash[::Integer, Attribute]
+      # The enum binder_driver_return_protocol returned to the sender.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Error
+      def error; self[:"error"]&.value; end
+      # The binder context where the transaction occurred.
+      # @rbs return: ::String
+      # @return [String]
+      # @see Context
+      def context; self[:"context"]&.value; end
+      # The PID of the sender process.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see FromPid
+      def from_pid; self[:"from_pid"]&.value; end
+      # The TID of the sender thread.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see FromTid
+      def from_tid; self[:"from_tid"]&.value; end
+      # The PID of the recipient process. This attribute may not be present
+      # if the target could not be determined.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see ToPid
+      def to_pid; self[:"to_pid"]&.value; end
+      # The TID of the recipient thread. This attribute may not be present
+      # if the target could not be determined.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see ToTid
+      def to_tid; self[:"to_tid"]&.value; end
+      # When present, indicates the failed transaction is a reply.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see IsReply
+      def is_reply; self[:"is_reply"]&.value; end
+      # The bitmask of enum transaction_flags from the transaction.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Flags
+      def flags; self[:"flags"]&.value; end
+      # The application-defined code from the transaction.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see Code
+      def code; self[:"code"]&.value; end
+      # The transaction payload size in bytes.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see DataSize
+      def data_size; self[:"data_size"]&.value; end
       class << self
         # Looks up Attribute class by name.
-        #--
         # @rbs name: Symbol
         # @rbs return: Attribute
+        # @param [Symbol] name
+        # @return [Attribute]
         def by_name(name); BY_NAME.fetch(name); end
         # Looks up Attribute class by type value.
-        #--
         # @rbs type: Integer
         # @rbs return: Attribute
+        # @param [Integer] type
+        # @return [Attribute]
         def by_type(type); BY_TYPE.fetch(type); end
       end
     end
   end
   module Messages
   end
+  module Notifications
+    # A multicast event sent to userspace subscribers to notify them about
+    # binder transaction failures. The generated report provides the full
+    # details of the specific transaction that failed. The intention is for
+    # programs to monitor these events and react to the failures as needed.
+    # 
+    # 
+    # Multicast group: `report`.
+    class Report < ::Nl::Genl::Message
+      TYPE = 1
+      FIXED_HEADER = nil
+      ATTRIBUTE_SET = AttributeSets::Report
+      ATTRIBUTES = Ractor.make_shareable(%i[error context from_pid from_tid to_pid to_tid is_reply flags code data_size])
+      # The enum binder_driver_return_protocol returned to the sender.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Report::Error
+      def error; attributes[:"error"]&.value; end
+      # The binder context where the transaction occurred.
+      # @rbs return: ::String
+      # @return [String]
+      # @see AttributeSets::Report::Context
+      def context; attributes[:"context"]&.value; end
+      # The PID of the sender process.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Report::FromPid
+      def from_pid; attributes[:"from_pid"]&.value; end
+      # The TID of the sender thread.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Report::FromTid
+      def from_tid; attributes[:"from_tid"]&.value; end
+      # The PID of the recipient process. This attribute may not be present
+      # if the target could not be determined.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Report::ToPid
+      def to_pid; attributes[:"to_pid"]&.value; end
+      # The TID of the recipient thread. This attribute may not be present
+      # if the target could not be determined.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Report::ToTid
+      def to_tid; attributes[:"to_tid"]&.value; end
+      # When present, indicates the failed transaction is a reply.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Report::IsReply
+      def is_reply; attributes[:"is_reply"]&.value; end
+      # The bitmask of enum transaction_flags from the transaction.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Report::Flags
+      def flags; attributes[:"flags"]&.value; end
+      # The application-defined code from the transaction.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Report::Code
+      def code; attributes[:"code"]&.value; end
+      # The transaction payload size in bytes.
+      # @rbs return: ::Integer
+      # @return [Integer]
+      # @see AttributeSets::Report::DataSize
+      def data_size; attributes[:"data_size"]&.value; end
+    end
+  end
+  # @private
+  NOTIFICATIONS = Ractor.make_shareable({1 => Notifications::Report}) #: Hash[::Integer, ::Class]
+  class AsyncOperations
+    # @private
+    def initialize(&exchange)
+      @exchange = exchange
+    end
+  end
+  # Returns the asynchronous operation facade for this family.
+  # @rbs (?stream_capacity: ::Integer?) -> AsyncOperations
+  # @param [::Integer, nil] stream_capacity
+  # @return [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 (*(:report) groups) -> self
+  # @param [Array<:report>] groups
+  # @return [self]
+  def subscribe(*groups) = super
+  # @rbs (*(:report) groups) -> self
+  # @param [Array<:report>] groups
+  # @return [self]
+  def unsubscribe(*groups) = super
 end
 end; end