ioprio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b129691a70f5f478e494f438504b00e97785cdaf857268fe50c5d1b2ab8967e2
+  data.tar.gz: '08348146e70752eb0d96efe4b2a08dc37155f02b6d94e9a474f18e032b10c0c0'
+SHA512:
+  metadata.gz: 4ec6ad58a61c0bd1953bffa4b048b4d1d11d716fe96cb22fa560490d78dbbb53334a8464bfd4f9cd60c90d12e59ae95e80596e1b27a0d6977628c924cd3236f9
+  data.tar.gz: 3a4363c662ec98f25568f22810b69b2bb4e582a222932f0b0e076d14db71fa36b5a6f94c6ea22d1a0ced55f41927f1b82aaee1779665ed273c8dc758f3497266

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.0.0 (2025-04-02)
+
+
+### Features
+
+* ioprio ([#2](https://github.com/benmelz/ioprio/issues/2)) ([1f0d63d](https://github.com/benmelz/ioprio/commit/1f0d63dba8e83b35e3a6def8666e12b4fa410489))

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 benmelz
+
+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,48 @@
+# ioprio
+
+Simple wrappers for linux ioprio syscalls.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add ioprio
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install ioprio
+```
+
+## Usage
+
+The ioprio syscalls are only supported by linux systems and as such the following API methods will only be implemented when running on them.
+
+All behavior is delegated directly to the syscalls themselves. Refer to the linux syscall man pages for usage instructions.
+
+Wrapper methods and constants for which values are defined on the `Process` module:
+
+```ruby
+  Process::IOPRIO_WHO_PROCESS
+  Process::IOPRIO_WHO_PGRP
+  Process::IOPRIO_WHO_USER
+
+  Process.getiopriority(which, who)
+  Process.setiopriority(which, who, priority)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/benmelz/ioprio.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/ext/ioprio/extconf.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+# Makes all symbols private by default to avoid unintended conflict
+# with other gems. To explicitly export symbols you can use RUBY_FUNC_EXPORTED
+# selectively, or entirely remove this flag.
+append_cflags("-fvisibility=hidden")
+
+create_makefile("ioprio/ioprio")

data/ext/ioprio/ioprio.c

@@ -0,0 +1,64 @@
+#include "ioprio.h"
+#include <errno.h>
+#include <ruby.h>
+#include <sys/syscall.h>
+#include <unistd.h>
+
+enum
+{
+  IOPRIO_WHO_PROCESS = 1,
+  IOPRIO_WHO_PGRP,
+  IOPRIO_WHO_USER,
+};
+
+#ifdef SYS_ioprio_get
+static VALUE
+ioprio_get (VALUE obj, VALUE which, VALUE who)
+{
+  errno = 0;
+  int prio = syscall (SYS_ioprio_get, NUM2INT (which), NUM2INT (who));
+  if (errno)
+    rb_sys_fail (0);
+  return INT2NUM (prio);
+}
+#else
+#define ioprio_get rb_f_notimplement
+#endif
+
+#ifdef SYS_ioprio_set
+static VALUE
+ioprio_set (VALUE obj, VALUE which, VALUE who, VALUE priority)
+{
+  if (syscall (SYS_ioprio_set, NUM2INT (which), NUM2INT (who),
+               NUM2INT (priority))
+      < 0)
+    rb_sys_fail (0);
+  return INT2NUM (0);
+}
+#else
+#define ioprio_set rb_f_notimplement
+#endif
+
+RUBY_FUNC_EXPORTED void
+Init_ioprio (void)
+{
+  VALUE rb_mod_ioprio = rb_define_module ("Ioprio");
+  VALUE rb_mod_ioprio_core_ext
+      = rb_define_module_under (rb_mod_ioprio, "CoreExt");
+  VALUE rb_mod_ioprio_core_ext_process
+      = rb_define_module_under (rb_mod_ioprio_core_ext, "Process");
+  VALUE rb_mod_ioprio_core_ext_process_class_methods = rb_define_module_under (
+      rb_mod_ioprio_core_ext_process, "ClassMethods");
+
+  rb_define_const (rb_mod_ioprio_core_ext_process, "IOPRIO_WHO_PROCESS",
+                   INT2NUM (IOPRIO_WHO_PROCESS));
+  rb_define_const (rb_mod_ioprio_core_ext_process, "IOPRIO_WHO_PGRP",
+                   INT2NUM (IOPRIO_WHO_PGRP));
+  rb_define_const (rb_mod_ioprio_core_ext_process, "IOPRIO_WHO_USER",
+                   INT2NUM (IOPRIO_WHO_USER));
+
+  rb_define_method (rb_mod_ioprio_core_ext_process_class_methods, "ioprio_get",
+                    ioprio_get, 2);
+  rb_define_method (rb_mod_ioprio_core_ext_process_class_methods, "ioprio_set",
+                    ioprio_set, 3);
+}

data/ext/ioprio/ioprio.h

@@ -0,0 +1,3 @@
+#ifndef IOPRIO_H
+#define IOPRIO_H 1
+#endif

data/lib/ioprio/core_ext/process.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Ioprio
+  module CoreExt
+    module Process
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def ioprio_get(which, who); end
+
+        def ioprio_set(which, who, priority); end
+      end
+    end
+  end
+end
+
+Process.include Ioprio::CoreExt::Process

data/lib/ioprio/core_ext.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "core_ext/process"
+
+module Ioprio
+  module CoreExt
+  end
+end

data/lib/ioprio/version.rb

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

data/lib/ioprio.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "ioprio/core_ext"
+require_relative "ioprio/version"
+require_relative "ioprio/ioprio"
+
+module Ioprio
+end

data/sig/ioprio.rbs

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

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: ioprio
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- benmelz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-02 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- ben@melz.me
+executables: []
+extensions:
+- ext/ioprio/extconf.rb
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- ext/ioprio/extconf.rb
+- ext/ioprio/ioprio.c
+- ext/ioprio/ioprio.h
+- lib/ioprio.rb
+- lib/ioprio/core_ext.rb
+- lib/ioprio/core_ext/process.rb
+- lib/ioprio/version.rb
+- sig/ioprio.rbs
+homepage: https://github.com/benmelz/io_priority
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/benmelz/io_priority
+  source_code_uri: https://github.com/benmelz/io_priority
+  changelog_uri: https://github.com/benmelz/io_priority/blob/v1.0.0/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.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Simple wrappers for linux ioprio syscalls.
+test_files: []