nanosleep 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d40764c23991c17c5e86f6c2e085ab21c2915ae2088ae2555ff3f53b911134f2
+  data.tar.gz: 66411a727fd126abb3f93aa2d4685d5a87213565a83d49a84e9ef068f1fb97ec
+SHA512:
+  metadata.gz: d0109ab6e558b11f572b6190108c1a1ce38b87ad36c876ce9414d30f9930a2c1d870242b9fd521eb275d2a41083d2a98f641e25eb7eaba9923b2d6fa601ded15
+  data.tar.gz: 7b0e2308e3d9f4589718f3554954097c99fc93a31297c07a2814802ffe84c47718796348bc7a504686f1f1baab9a37ad2f36623f5855e0c61721f49d80317353

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos]
+        ruby: [ head, 3.4  ]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake test

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at aaron.patterson at gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Aaron Patterson
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,32 @@
+# Nanosleep
+
+This is a gem that wraps the `nanosleep` system call so you can sleep for
+a certain amount of time, but it also gives you control over whether or not
+the GVL is held during sleep.
+
+This is mostly useful for writing benchmarks where you want to hold the GVL for
+a specified amount of time.
+
+## Usage
+
+```ruby
+require "nanosleep"
+
+# Sleep for 2 seconds without holding the GVL
+Nanosleep.s(2)
+
+# Sleep for 2 seconds while holding the GVL
+Nanosleep.s(2, hold_gvl: true)
+
+# Sleep for 100 milliseconds without holding the GVL
+Nanosleep.ms(100)
+
+# Sleep for 100 milliseconds while holding the GVL
+Nanosleep.ms(100, hold_gvl: true)
+
+# Sleep for 100 nanoseconds without holding the GVL
+Nanosleep.ns(100)
+
+# Sleep for 100 nanoseconds while holding the GVL
+Nanosleep.ns(100, hold_gvl: true)
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require "rake/extensiontask"
+require "rake/testtask"
+
+Rake::ExtensionTask.new("nanosleep")
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :test => :compile

data/ext/nanosleep/extconf.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require "mkmf"
+
+abort unless have_func("nanosleep")
+abort unless find_header("time.h")
+
+create_makefile "nanosleep"

data/ext/nanosleep/nanosleep.c

@@ -0,0 +1,38 @@
+#include <ruby.h>
+#include <ruby/thread.h>
+#include <time.h>
+
+static void *
+do_sleep(void * _req)
+{
+    struct timespec * req = (struct timespec *)_req;
+
+    nanosleep(req, NULL);
+
+    return NULL;
+}
+
+static VALUE
+nsleep(VALUE mod, VALUE sec, VALUE nsec, VALUE hold_gvl)
+{
+    struct timespec req;
+
+    req.tv_sec = NUM2INT(sec);
+    req.tv_nsec = NUM2INT(nsec);
+
+    if (RTEST(hold_gvl)) {
+        do_sleep(&req);
+    } else {
+        rb_thread_call_without_gvl(do_sleep, &req, RUBY_UBF_PROCESS, 0);
+    }
+
+    return Qnil;
+}
+
+void Init_nanosleep() {
+    rb_ext_ractor_safe(true);
+
+    VALUE mNanosleep = rb_define_module("Nanosleep");
+
+    rb_define_method(mNanosleep, "nsleep", nsleep, 3);
+}

data/lib/nanosleep.rb

@@ -0,0 +1,28 @@
+require "nanosleep.so"
+
+module Nanosleep
+  NS_IN_S = 1000000000
+  private_constant :NS_IN_S
+
+  NS_IN_MS = 1000000
+  private_constant :NS_IN_MS
+
+  def ns amt, hold_gvl: false
+    seconds = amt / NS_IN_S
+    nsec = amt % NS_IN_S
+    nsleep(seconds, nsec, hold_gvl)
+  end
+  module_function :ns
+
+  def ms amt, hold_gvl: false
+    ns(amt * NS_IN_MS, hold_gvl:)
+  end
+  module_function :ms
+
+  def s amt, hold_gvl: false
+    ns(amt * NS_IN_S, hold_gvl:)
+  end
+  module_function :s
+
+  module_function :nsleep
+end

data/nanosleep.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "nanosleep"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Aaron Patterson"]
+  spec.email         = ["tenderlove@ruby-lang.org"]
+
+  spec.summary       = %q{A wrapper around nanosleep system call.}
+  spec.description   = %q{A wrapper around the nanosleep system call.}
+  spec.homepage      = "https://github.com/tenderlove/nanosleep"
+  spec.licenses      = ["Apache-2.0"]
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/nanosleep/extconf.rb"]
+
+  spec.add_development_dependency "rake", '~> 13.0'
+  spec.add_development_dependency "rake-compiler", '~> 1.1'
+  spec.add_development_dependency "minitest", '~> 5.25'
+end

data/test/nanosleep_test.rb

@@ -0,0 +1,65 @@
+require "nanosleep"
+require "minitest/autorun"
+
+class NanosleepTest < Minitest::Test
+  class Channel
+    def self.new
+      Ractor.new do
+        loop do
+          Ractor.yield Ractor.receive
+        end
+      end
+    end
+  end
+
+  def now
+    Process.clock_gettime(Process::CLOCK_MONOTONIC)
+  end
+
+  def test_hold_gvl
+    latch = Queue.new
+    t = Thread.new {
+      latch.pop
+      Nanosleep.s 1, hold_gvl: true
+    }
+    start = now
+    latch << true
+    Nanosleep.s 1, hold_gvl: true
+    t.join
+    elapsed = now - start
+    # should be about 2 seconds
+    assert_in_delta 2.0, elapsed, 0.2
+  end
+
+  def test_no_gvl
+    latch = Queue.new
+    t = Thread.new {
+      latch.pop
+      Nanosleep.s 1
+    }
+    start = now
+    latch << true
+    Nanosleep.s 1
+    t.join
+    elapsed = now - start
+    # should be about 1 seconds
+    assert_in_delta 1.0, elapsed, 0.2
+  end
+
+  def test_ractor_with_gvl
+    # even though we hold the GVL, the GVL is actually per Ractor, so
+    # we will see only 1 second elapse
+    channel = Channel.new
+    r = Ractor.new {
+      Ractor.receive # block until ready
+      Nanosleep.s 1, hold_gvl: true
+    }
+    start = now
+    r.send(true)
+    Nanosleep.s 1, hold_gvl: true
+    r.take
+    elapsed = now - start
+    # should be about 1 seconds
+    assert_in_delta 1.0, elapsed, 0.2
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: nanosleep
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Patterson
+bindir: bin
+cert_chain: []
+date: 2025-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+description: A wrapper around the nanosleep system call.
+email:
+- tenderlove@ruby-lang.org
+executables: []
+extensions:
+- ext/nanosleep/extconf.rb
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ext/nanosleep/extconf.rb
+- ext/nanosleep/nanosleep.c
+- lib/nanosleep.rb
+- nanosleep.gemspec
+- test/nanosleep_test.rb
+homepage: https://github.com/tenderlove/nanosleep
+licenses:
+- Apache-2.0
+metadata: {}
+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.7.0.dev
+specification_version: 4
+summary: A wrapper around nanosleep system call.
+test_files:
+- test/nanosleep_test.rb