nl-linux 0.3.0 → 0.4.1

data/generated/nl/linux.rb

@@ -36,3 +36,4 @@ module Nl
     autoload :Wireguard, "nl/linux/wireguard.rb"
   end
 end
+require 'nl/linux/nlctrl_resolver'

data/lib/nl/linux/nlctrl_resolver.rb

@@ -0,0 +1,31 @@
+require 'nl/linux/nlctrl'
+
+module Nl
+  module Linux
+    # Resolves Generic Netlink family metadata through nlctrl.
+    class NlctrlResolver
+      FAMILY_INFO_CTRL = Nl::Genl::FamilyInfo.new(
+        id: Genl::GENL_ID_CTRL,
+        multicast_groups: {}.freeze,
+      ).freeze
+
+      # Resolves a Generic Netlink family metadata through nlctrl.
+      #
+      # @param [Genl::Client] client
+      # @param [String] family_name
+      # @return [Genl::FamilyInfo]
+      # @rbs (Genl::Client client, String family_name) -> Genl::FamilyInfo
+      def call(client, family_name)
+        return FAMILY_INFO_CTRL if family_name == Nlctrl::NAME
+
+        reply = client.family(Nlctrl).do_getfamily(family_name:)
+        groups = (reply.mcast_groups || []).to_h do |attributes|
+          [attributes[:name].value, attributes[:id].value]
+        end
+        Genl::FamilyInfo.new(id: reply.family_id, multicast_groups: groups.freeze)
+      end
+    end
+
+    DEFAULT_RESOLVER = NlctrlResolver.new.freeze
+  end
+end

data/lib/nl/linux/version.rb

@@ -1,5 +1,5 @@
 module Nl
   module Linux
-    VERSION = '0.3.0'
+    VERSION = '0.4.1'
   end
 end

data/sig/generated/nl/linux/binder.rbs

@@ -0,0 +1,366 @@
+# Generated from generated/nl/linux/binder.rb with RBS::Inline
+
+module Nl
+  module Linux
+    # Binder interface over generic netlink
+    class Binder < ::Nl::Genl::Family
+      NAME: ::String
+
+      VERSION: ::Integer
+
+      # @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::Genl::Client, ::String) -> ::Nl::Genl::FamilyInfo, ?executor: executor?, ?notification_capacity: ::Integer?) -> (::Nl::Family::Session & instance)
+
+      # @private
+      MCAST_GROUPS: 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::AttributeSet
+          # Abstract class
+          class Attribute < ::Nl::AttributeSet::Attribute
+          end
+
+          # The enum binder_driver_return_protocol returned to the sender.
+          class Error < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The binder context where the transaction occurred.
+          class Context < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The PID of the sender process.
+          class FromPid < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The TID of the sender thread.
+          class FromTid < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The PID of the recipient process. This attribute may not be present
+          # if the target could not be determined.
+          class ToPid < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The TID of the recipient thread. This attribute may not be present
+          # if the target could not be determined.
+          class ToTid < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # When present, indicates the failed transaction is a reply.
+          class IsReply < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The bitmask of enum transaction_flags from the transaction.
+          class Flags < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The application-defined code from the transaction.
+          class Code < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # The transaction payload size in bytes.
+          class DataSize < Attribute
+            TYPE: ::Integer
+
+            NAME: ::Symbol
+
+            # @private
+            ORDER: ::Integer
+
+            # @private
+            DATATYPE: untyped
+          end
+
+          # @private
+          BY_NAME: Hash[::Symbol, Attribute]
+
+          # @private
+          BY_TYPE: Hash[::Integer, Attribute]
+
+          # The enum binder_driver_return_protocol returned to the sender.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Error
+          def error: () -> ::Integer
+
+          # The binder context where the transaction occurred.
+          # @rbs return: ::String
+          # @return [String]
+          # @see Context
+          def context: () -> ::String
+
+          # The PID of the sender process.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see FromPid
+          def from_pid: () -> ::Integer
+
+          # The TID of the sender thread.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see FromTid
+          def from_tid: () -> ::Integer
+
+          # 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: () -> ::Integer
+
+          # 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: () -> ::Integer
+
+          # When present, indicates the failed transaction is a reply.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see IsReply
+          def is_reply: () -> ::Integer
+
+          # The bitmask of enum transaction_flags from the transaction.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Flags
+          def flags: () -> ::Integer
+
+          # The application-defined code from the transaction.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see Code
+          def code: () -> ::Integer
+
+          # The transaction payload size in bytes.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see DataSize
+          def data_size: () -> ::Integer
+
+          # Looks up Attribute class by name.
+          # @rbs name: Symbol
+          # @rbs return: Attribute
+          # @param [Symbol] name
+          # @return [Attribute]
+          def self.by_name: (Symbol name) -> Attribute
+
+          # Looks up Attribute class by type value.
+          # @rbs type: Integer
+          # @rbs return: Attribute
+          # @param [Integer] type
+          # @return [Attribute]
+          def self.by_type: (Integer type) -> Attribute
+        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: ::Integer
+
+          FIXED_HEADER: untyped
+
+          ATTRIBUTE_SET: untyped
+
+          ATTRIBUTES: untyped
+
+          # The enum binder_driver_return_protocol returned to the sender.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Report::Error
+          def error: () -> ::Integer
+
+          # The binder context where the transaction occurred.
+          # @rbs return: ::String
+          # @return [String]
+          # @see AttributeSets::Report::Context
+          def context: () -> ::String
+
+          # The PID of the sender process.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Report::FromPid
+          def from_pid: () -> ::Integer
+
+          # The TID of the sender thread.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Report::FromTid
+          def from_tid: () -> ::Integer
+
+          # 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: () -> ::Integer
+
+          # 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: () -> ::Integer
+
+          # When present, indicates the failed transaction is a reply.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Report::IsReply
+          def is_reply: () -> ::Integer
+
+          # The bitmask of enum transaction_flags from the transaction.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Report::Flags
+          def flags: () -> ::Integer
+
+          # The application-defined code from the transaction.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Report::Code
+          def code: () -> ::Integer
+
+          # The transaction payload size in bytes.
+          # @rbs return: ::Integer
+          # @return [Integer]
+          # @see AttributeSets::Report::DataSize
+          def data_size: () -> ::Integer
+        end
+      end
+
+      # @private
+      NOTIFICATIONS: Hash[::Integer, ::Class]
+
+      class AsyncOperations
+        # @private
+        def initialize: () ?{ (?) -> untyped } -> untyped
+      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: ::Integer?) -> AsyncOperations
+
+      # @rbs (*(:report) groups) -> self
+      # @param [Array<:report>] groups
+      # @return [self]
+      def subscribe: (*:report groups) -> self
+
+      # @rbs (*(:report) groups) -> self
+      # @param [Array<:report>] groups
+      # @return [self]
+      def unsubscribe: (*:report groups) -> self
+    end
+  end
+end