pid_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e6f4e7428e8b05e3e495a03e7f33d61630aec11f70f91da83500b417fa9d5fe
+  data.tar.gz: 03bed860fc75b2d20bbfd5363fbaf2ef93d592238c7a1efa8c582a25f2ea0758
+SHA512:
+  metadata.gz: 9319cc3774946d7bed55faf94055a8e9903fd8a29aa7355a94de1e38982e60841f6e9b2d106349a3adca63244d9d3c32641297bea8f1bdf66ba54b619433bb44
+  data.tar.gz: a1f4edf40740a435315f756336998f89f4993b7bb27e7dc12d94688bc7f52a9fbb05ecca48aa12fc02a57f74a94a319682643e5e07246487b9276752523e8672

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-20
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pid_cache.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    pid_cache (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.17.0)
+    rake (13.0.6)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  pid_cache!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Shopify
+
+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,51 @@
+# PIDCache
+
+Cache calls to `Process.pid` to avoid lots of useless system calls on modern Linux.
+
+Ruby's `Process.pid` calls the standard `libc` `getpid(2)`, historically pretty much all
+implementations of the `libc` have been caching this function to avoid doing a syscall everytime.
+
+However `glibc 2.25` released in 2017 removed that cache, causing a performance regression for application
+frequently monitoring the PID.
+
+The reason they removed it, is that some low-level libraries would `fork` by calling the syscall themselves,
+bypassing the code responsible for clearing the cache.
+
+But doing this in Ruby is impossible, so we can safely cache the PID and save some performance.
+
+This gem is a backport of [a proposed feature for Ruby 3.3](https://bugs.ruby-lang.org/issues/19443), hopefully
+as of Ruby 3.3 this gem may be useless.
+
+## Requirements
+
+This gem only work on Ruby 3.1+, on older rubies it has no effect.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add pid_cache
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install pid_cache
+
+## Usage
+
+That's it, the cache is applied immediately uppon requiring the gem, and is automatically flushed upon fork.
+
+Note that the caching only applies to `Process.pid`, the `$$` magic variable is unimpacted.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/pid_cache.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: %i[test]

data/lib/pid_cache/version.rb

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

data/lib/pid_cache.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "pid_cache/version"
+
+module PIDCache
+  if Process.respond_to?(:_fork) # Ruby 3.1+
+    ORIGINAL_METHOD = Process.method(:pid)
+
+    class << self
+      def pid
+        @pid ||= ORIGINAL_METHOD.call
+      end
+
+      def reset
+        @pid = nil
+      end
+    end
+
+    module CoreExt
+      def _fork
+        child_pid = super
+        ::PIDCache.reset if child_pid == 0
+        child_pid
+      end
+
+      def pid
+        ::PIDCache.pid
+      end
+    end
+
+    Process.singleton_class.prepend(PIDCache::CoreExt)
+  end
+end

data/pid_cache.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/pid_cache/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pid_cache"
+  spec.version = PIDCache::VERSION
+  spec.authors = ["Jean Boussier"]
+  spec.email = ["jean.boussier@gmail.com"]
+
+  spec.summary = "Cache calls to Process.pid"
+  spec.description = "On platforms using glibc 1.25+ Process.pid always issue a syscall which is wasteful. pid_cache prevents that."
+  spec.homepage = "https://gtihub.com/Shopify/pid_cache"
+  spec.license = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = File.join(spec.homepage, "blob/master/CHANGELOG.md")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: pid_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean Boussier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-20 00:00:00.000000000 Z
+dependencies: []
+description: On platforms using glibc 1.25+ Process.pid always issue a syscall which
+  is wasteful. pid_cache prevents that.
+email:
+- jean.boussier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pid_cache.rb
+- lib/pid_cache/version.rb
+- pid_cache.gemspec
+homepage: https://gtihub.com/Shopify/pid_cache
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gtihub.com/Shopify/pid_cache
+  source_code_uri: https://gtihub.com/Shopify/pid_cache
+  changelog_uri: https://gtihub.com/Shopify/pid_cache/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.4
+signing_key:
+specification_version: 4
+summary: Cache calls to Process.pid
+test_files: []