procfs2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f375fcd2d93a0c3a12c604830459e97eda2d4c744b8e07287755dd034e32630
+  data.tar.gz: cad7c93a47748b62840015a1bceb80d9c731d32999f8c5ad322558173d4b5599
+SHA512:
+  metadata.gz: 7dfdfe59866bf4783b82c0a22b8fdd9faae9bccec54fb118a59ef216775f2b7f8d4df4dbd0edbe2eea4b8eec57f791363e93ad8cb703c4f02a596552771a3dce
+  data.tar.gz: 25797138a244a267e4d8cf36959c4429c7a4d3d24369bfefefe97a8403fab419cbcc0d53950b44e710971b80ef323a1dd261463901f395601e841aee67886f86

data/.rubocop.yml

@@ -0,0 +1,24 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+# Style/StringLiterals:
+#   Enabled: true
+#   EnforcedStyle: double_quotes
+
+# Style/StringLiteralsInInterpolation:
+#   Enabled: true
+#   EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Thomas Tych
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Procfs2
+
+Browse /proc fs on Linux.
+
+This is a draft version.
+
+
+## Installation
+
+Manual install, with:
+
+    $ gem install procfs2
+
+Add to Gemfile with:
+
+    $ bundle add procfs2
+
+
+## Usage
+
+This is a draft version.
+
+It may change or not.
+
+Comments / PR welcome !
+
+Example of usage:
+
+``` ruby
+@p = Procfs2.proc
+
+puts @p
+puts @p.version._path
+puts @p.version._raw_content
+puts @p.version.version
+puts @p.version.timestamp
+
+puts @p.pid('self').fd._path
+puts @p.pid('self').fd.id(0)
+
+puts @p.pid(1091714).fd.id(3).type
+puts @p.pid(1091714).fd.select { |fd| fd.type == 'socket' }
+puts @p.pid(1091714).fd.select { |fd| fd.type == 'socket' }.map { |fd| fd.inode }
+
+puts @p.net.tcp.by_inode(2235042).id
+puts @p.net.tcp.by_inode(2235042).remote_address
+puts @p.net.tcp.by_inode(2235042).remote_port
+puts @p.net.tcp.by_inode(2235042).state_str
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/procfs2.
+
+
+## References
+
+- https://www.kernel.org/doc/html/latest/filesystems/proc.html
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'minitest/test_task'
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'bump/tasks'
+
+task default: %i[test rubocop]

data/lib/procfs2/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Procfs2
+  class Error < StandardError
+  end
+end

data/lib/procfs2/proc.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'proc_module'
+require_relative 'proc_version'
+require_relative 'proc_pid'
+require_relative 'proc_net'
+
+module Procfs2
+  class Proc < ProcModule
+    attr_reader :root
+
+    def initialize(root:)
+      @root = root
+
+      super(parent: nil)
+    end
+
+    def _path
+      root.to_s
+    end
+
+    provide ProcVersion
+    provide ProcPid
+    provide ProcNet
+  end
+end

data/lib/procfs2/proc_fd.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'proc_item'
+require_relative 'proc_fd_id'
+
+module Procfs2
+  class ProcFd < ProcItem
+    LABEL = :fd
+
+    def _load_content
+      @_data = []
+      Dir.foreach(_path) do |fd_entry|
+        next if ['.', '..'].include?(fd_entry)
+
+        fd_path = File.join(_path, fd_entry)
+        fd_stat = File.stat(fd_path)
+
+        @_data << ProcFdId.new(id: fd_entry, path: fd_path, stat: fd_stat)
+      end
+    end
+
+    def id(id)
+      return unless _data
+
+      _data.find { |element| element.id.to_s == id.to_s }
+    end
+
+    def each(&block)
+      _data&.each(&block)
+    end
+
+    include Enumerable
+  end
+end

data/lib/procfs2/proc_fd_id.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Procfs2
+  class ProcFdId
+    attr_reader :id, :_path, :_stat
+
+    def initialize(id:, path:, stat:)
+      @id = id
+      @_path = path
+      @_stat = stat
+    end
+
+    def type
+      _stat&.ftype
+    end
+
+    def inode
+      _stat.ino
+    end
+  end
+end

data/lib/procfs2/proc_item.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Procfs2
+  class ProcItem
+    attr_reader :_parent, :_raw_content, :_data
+
+    def initialize(parent:)
+      @_parent = parent
+      @_data = nil
+
+      _initialize_content
+    end
+
+    def _filename
+      self.class::LABEL.to_s
+    end
+
+    def _path
+      File.join([_parent&._path, _filename].compact)
+    end
+
+    def _raw_content
+      @_raw_content ||= File.read(_path) if File.file?(_path)
+      @_raw_content ||= ''
+      @_raw_content
+    end
+
+    private
+
+    def _initialize_content
+      _load_content
+      _parse_content
+    end
+
+    def _load_content
+      raise Procfs2::Error, "proc resource at `#{_path}` does not exist" unless File.exist?(_path)
+
+      _raw_content
+    end
+
+    def _parse_content; end
+
+    def method_missing(method_name, *args, **kwargs)
+      return unless _data
+
+      return _data[method_name.to_sym] if _data.key?(method_name.to_sym)
+      return _data[method_name.to_s] if _data.key?(method_name.to_s)
+
+      super
+    end
+
+    class << self
+      def build(parent:)
+        new(parent: parent)
+      end
+    end
+  end
+end

data/lib/procfs2/proc_module.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'proc_item'
+
+module Procfs2
+  class ProcModule < ProcItem
+    class << self
+      def provide(component, as: nil)
+        component_label = as || component::LABEL
+        define_method component_label do |*args, **kwargs|
+          component.build(*args, parent: self, **kwargs)
+        end
+      end
+    end
+  end
+end

data/lib/procfs2/proc_net.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'proc_module'
+require_relative 'proc_net_tcp'
+
+module Procfs2
+  class ProcNet < ProcModule
+    LABEL = :net
+
+    provide ProcNetTcp
+  end
+end

data/lib/procfs2/proc_net_tcp.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'proc_item'
+require_relative 'proc_net_tcp_socket'
+
+module Procfs2
+  class ProcNetTcp < ProcItem
+    LABEL = :tcp
+
+    def _load_content
+      @_data = []
+
+      lines = _raw_content.lines
+      lines.shift
+
+      @_data = lines.map { |socket_line| ProcNetTcpSocket.build_from_line(socket_line) }
+    end
+
+    def by_id(id)
+      @_data.find { |socket| socket.id == id.to_i }
+    end
+
+    def by_inode(inode)
+      @_data.find { |socket| socket.inode == inode.to_i }
+    end
+
+    def each(&block)
+      _data&.each(&block)
+    end
+
+    include Enumerable
+  end
+end

data/lib/procfs2/proc_net_tcp_socket.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Procfs2
+  class ProcNetTcpSocket
+    HEADERS = %i[
+      id
+      local_address_port
+      remote_address_port
+      state
+      transmit_receive_queue
+      timer_and_jiffies
+      unrecovered_rto_timeouts
+      uid
+      unanswered_0_window_probes
+      inode
+      socket_reference_count
+      socket_location
+      retransmit_timeout
+      soft_clock_predicted_tick
+      ack_pingpong
+      sending_congestion_window
+      slow_start_size_threshold
+    ].freeze
+
+    STATE_STR = {
+      0 => 'UNKNOWN',
+      1 => 'ESTABLISHED',
+      2 => 'SYN',
+      3 => 'SYN_RECV',
+      4 => 'FIN_WAIT1',
+      5 => 'FIN_WAIT2',
+      6 => 'TIME_WAIT',
+      7 => 'CLOSE',
+      8 => 'CLOSE_WAIT',
+      9 => 'LAST_ACK',
+      10 => 'LISTEN',
+      11 => 'CLOSING',
+      12 => 'NEW_SYN_RECV',
+      13 => 'MAX_STATE'
+    }.freeze
+
+    attr_reader :id, :local_address, :local_port, :remote_address, :remote_port, :state,
+                :transmit_queue, :receive_queue, :uid, :inode
+
+    def initialize(id:, local_address:, local_port:, remote_address:, remote_port:, state:,
+                   transmit_queue:, receive_queue:, uid:, inode:, **extra)
+      @id = id
+      @local_address = local_address
+      @local_port = local_port
+      @remote_address = remote_address
+      @remote_port = remote_port
+      @state = state
+      @transmit_queue = transmit_queue
+      @receive_queue = receive_queue
+      @uid = uid
+      @inode = inode
+
+      @extra = extra
+    end
+
+    def type
+      'tcp'
+    end
+
+    def state_str
+      STATE_STR[state]
+    end
+
+    class << self
+      def build_from_line(line)
+        info = HEADERS.zip(line.strip.split).to_h
+        options = {}
+
+        options[:id] = info[:id].chomp(':').to_i
+        options[:local_address], options[:local_port] = parse_address_hex(info[:local_address_port])
+        options[:remote_address], options[:remote_port] = parse_address_hex(info[:remote_address_port])
+        options[:state] = info[:state].hex
+        options[:transmit_queue], options[:receive_queue] = info[:transmit_receive_queue].split(':').map(&:hex)
+        options[:timer_active], options[:jiffries] = info[:timer_and_jiffies].split(':').map(&:hex)
+        options[:unrecovered_rto_timeouts] = info[:unrecovered_rto_timeouts].hex
+        options[:uid] = info[:uid].to_i
+        options[:unanswered_0_window_probes] = info[:unanswered_0_window_probes].hex
+        options[:inode] = info[:inode].to_i
+        options[:socket_reference_count] = info[:socket_reference_count].to_i
+        options[:socket_location] = info[:socket_location]
+        options[:retransmit_timeout] = info[:retransmit_timeout].to_i
+        options[:soft_clock_predicted_tick] = info[:soft_clock_predicted_tick].to_i
+        options[:ack_pingpong] = info[:ack_pingpong].to_i
+        options[:sending_congestion_window] = info[:sending_congestion_window].to_i
+        options[:slow_start_size_threshold] = info[:slow_start_size_threshold].to_i
+
+        new(**options)
+      end
+
+      def parse_address_hex(address_port_hex)
+        address_hex, port_hex = address_port_hex.split(':')
+        address = [address_hex[6..7],
+                   address_hex[5..4],
+                   address_hex[3..2],
+                   address_hex[1..0]].map(&:hex).join('.')
+        port = port_hex.hex
+        [address, port]
+      end
+    end
+  end
+end

data/lib/procfs2/proc_pid.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'proc_module'
+require_relative 'proc_fd'
+
+module Procfs2
+  class ProcPid < ProcModule
+    LABEL = :pid
+
+    attr_reader :pid
+
+    def initialize(pid:, parent:)
+      @pid = pid
+      super(parent: parent)
+    end
+
+    def _filename
+      pid.to_s
+    end
+
+    provide ProcFd
+
+    class << self
+      def build(pid, parent:)
+        new(pid: pid, parent: parent)
+      end
+    end
+  end
+end

data/lib/procfs2/proc_version.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'proc_item'
+
+module Procfs2
+  class ProcVersion < ProcItem
+    LABEL = :version
+
+    VERSION_RE = /
+      (?<kernel>\w+)
+      \sversion\s
+      (?<version>[\w.-]+)
+      \s
+      \((?<user>\w+)@(?<host>[\w.-]+)\)
+      \s
+      \((?<gcc_version>[\w\s\(\).,-]+)\)
+      \s
+      (?<kernel_type>[\w#\s-]+)
+      \s
+      (?<timestamp>\w+\s+\w+\s+\d+\s+[\d:]+\s+\w+\s+\d+)
+      /x
+
+    def _parse_content
+      return unless _raw_content
+      return unless (match = _raw_content.match(VERSION_RE))
+
+      @_data = match.names.zip(match.captures).to_h
+    end
+  end
+end

data/lib/procfs2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Procfs2
+  VERSION = '0.1.0'
+end

data/lib/procfs2.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'procfs2/version'
+require_relative 'procfs2/error'
+require_relative 'procfs2/proc'
+
+module Procfs2
+  ROOT = '/proc'
+
+  def self.proc(root: ROOT)
+    Proc.new(root: root)
+  end
+end

data/sig/procfs2.rbs

@@ -0,0 +1,4 @@
+module Procfs2
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: procfs2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Tych
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.6
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.1'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.56'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.56'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.35.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+description:
+email:
+- thomas.tych@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/procfs2.rb
+- lib/procfs2/error.rb
+- lib/procfs2/proc.rb
+- lib/procfs2/proc_fd.rb
+- lib/procfs2/proc_fd_id.rb
+- lib/procfs2/proc_item.rb
+- lib/procfs2/proc_module.rb
+- lib/procfs2/proc_net.rb
+- lib/procfs2/proc_net_tcp.rb
+- lib/procfs2/proc_net_tcp_socket.rb
+- lib/procfs2/proc_pid.rb
+- lib/procfs2/proc_version.rb
+- lib/procfs2/version.rb
+- sig/procfs2.rbs
+homepage: https://gitlab.com/ttych/procfs2
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/ttych/procfs2
+  source_code_uri: https://gitlab.com/ttych/procfs2
+  changelog_uri: https://gitlab.com/ttych/procfs2/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: read procfs or /proc pseudo-filesystem.
+test_files: []