prometheus-client-mmap 0.19.1 → 0.20.0

data/ext/fast_mmaped_file_rs/src/util.rs

@@ -0,0 +1,121 @@
+use nix::errno::Errno;
+use nix::libc::c_long;
+use std::fmt::Display;
+use std::io;
+use std::mem::size_of;
+
+use crate::error::MmapError;
+use crate::Result;
+
+/// Wrapper around `checked_add()` that converts failures
+/// to `MmapError::Overflow`.
+pub trait CheckedOps: Sized {
+    fn add_chk(self, rhs: Self) -> Result<Self>;
+    fn mul_chk(self, rhs: Self) -> Result<Self>;
+}
+
+impl CheckedOps for usize {
+    fn add_chk(self, rhs: Self) -> Result<Self> {
+        self.checked_add(rhs)
+            .ok_or_else(|| MmapError::overflowed(self, rhs, "adding"))
+    }
+
+    fn mul_chk(self, rhs: Self) -> Result<Self> {
+        self.checked_mul(rhs)
+            .ok_or_else(|| MmapError::overflowed(self, rhs, "multiplying"))
+    }
+}
+
+impl CheckedOps for c_long {
+    fn add_chk(self, rhs: Self) -> Result<Self> {
+        self.checked_add(rhs)
+            .ok_or_else(|| MmapError::overflowed(self, rhs, "adding"))
+    }
+
+    fn mul_chk(self, rhs: Self) -> Result<Self> {
+        self.checked_mul(rhs)
+            .ok_or_else(|| MmapError::overflowed(self, rhs, "multiplying"))
+    }
+}
+
+/// A wrapper around `TryFrom`, returning `MmapError::FailedCast` on error.
+pub fn cast_chk<T, U>(val: T, name: &str) -> Result<U>
+where
+    T: Copy + Display,
+    U: std::convert::TryFrom<T>,
+{
+    U::try_from(val).map_err(|_| MmapError::failed_cast::<T, U>(val, name))
+}
+
+/// Retrieve errno(3).
+pub fn errno() -> i32 {
+    // UNWRAP: This will always return `Some` when called from `last_os_error()`.
+    io::Error::last_os_error().raw_os_error().unwrap()
+}
+
+/// Get the error string associated with errno(3).
+/// Equivalent to strerror(3).
+pub fn strerror(errno: i32) -> &'static str {
+    Errno::from_i32(errno).desc()
+}
+
+/// Read a `u32` value from a byte slice starting from `offset`.
+#[inline]
+pub fn read_u32(buf: &[u8], offset: usize) -> Result<u32> {
+    if let Some(slice) = buf.get(offset..offset + size_of::<u32>()) {
+        // UNWRAP: We can safely unwrap the conversion from slice to array as we
+        // the source and targets are constructed here with the same length.
+        let out: &[u8; size_of::<u32>()] = slice.try_into().unwrap();
+
+        return Ok(u32::from_ne_bytes(*out));
+    }
+    Err(MmapError::out_of_bounds(offset, buf.len()))
+}
+
+/// Read an `f64` value from a byte slice starting from `offset`.
+#[inline]
+pub fn read_f64(buf: &[u8], offset: usize) -> Result<f64> {
+    if let Some(slice) = buf.get(offset..offset + size_of::<f64>()) {
+        // UNWRAP: We can safely unwrap the conversion from slice to array as we
+        // can be sure the target array has same length as the source slice.
+        let out: &[u8; size_of::<f64>()] = slice.try_into().unwrap();
+
+        return Ok(f64::from_ne_bytes(*out));
+    }
+    Err(MmapError::out_of_bounds(
+        offset + size_of::<f64>(),
+        buf.len(),
+    ))
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn test_read_u32() {
+        let buf = 1u32.to_ne_bytes();
+
+        assert!(matches!(read_u32(&buf, 0), Ok(1)), "index ok");
+        assert!(read_u32(&buf, 10).is_err(), "index out of range");
+        assert!(
+            read_u32(&buf, 1).is_err(),
+            "index in range but end out of range"
+        );
+    }
+
+    #[test]
+    fn test_read_f64() {
+        let buf = 1.00f64.to_ne_bytes();
+
+        let ok = read_f64(&buf, 0);
+        assert!(ok.is_ok());
+        assert_eq!(ok.unwrap(), 1.00);
+
+        assert!(read_f64(&buf, 10).is_err(), "index out of range");
+        assert!(
+            read_f64(&buf, 1).is_err(),
+            "index in range but end out of range"
+        );
+    }
+}

data/lib/prometheus/client/configuration.rb

@@ -1,5 +1,6 @@
 require 'prometheus/client/registry'
 require 'prometheus/client/mmaped_value'
+require 'prometheus/client/page_size'
 require 'logger'
 require 'tmpdir'
 
@@ -10,7 +11,7 @@ module Prometheus
 
       def initialize
         @value_class = ::Prometheus::Client::MmapedValue
-        @initial_mmap_file_size = 4 * 1024
+        @initial_mmap_file_size = ::Prometheus::Client::PageSize.page_size(fallback_page_size: 4096)
         @logger = Logger.new($stdout)
         @pid_provider = Process.method(:pid)
         @multiprocess_files_dir = ENV.fetch('prometheus_multiproc_dir') do

data/lib/prometheus/client/formats/text.rb

@@ -26,16 +26,40 @@ module Prometheus
             Helper::MetricsRepresentation.to_text(metrics)
           end
 
-          def marshal_multiprocess(path = Prometheus::Client.configuration.multiprocess_files_dir)
+          def marshal_multiprocess(path = Prometheus::Client.configuration.multiprocess_files_dir, use_rust: false)
             file_list = Dir.glob(File.join(path, '*.db')).sort
               .map {|f| Helper::PlainFile.new(f) }
               .map {|f| [f.filepath, f.multiprocess_mode.to_sym, f.type.to_sym, f.pid] }
 
-            FastMmapedFile.to_metrics(file_list.to_a)
+            if use_rust && rust_impl_available?
+              FastMmapedFileRs.to_metrics(file_list.to_a)
+            else
+              FastMmapedFile.to_metrics(file_list.to_a)
+            end
+          end
+
+          def rust_impl_available?
+            return @rust_available unless @rust_available.nil?
+
+            check_for_rust
           end
 
           private
 
+          def check_for_rust
+            # This will be evaluated on each invocation even with `||=` if
+            # `@rust_available` if false. Running a `require` statement is slow,
+            # so the `rust_impl_available?` method memoizes the result, external
+            # callers can only trigger this method a single time.
+            @rust_available = begin
+              require 'fast_mmaped_file_rs'
+              true
+            rescue LoadError
+              Prometheus::Client.logger.info('FastMmapedFileRs unavailable')
+              false
+            end
+          end
+
           def load_metrics(path)
             metrics = {}
             Dir.glob(File.join(path, '*.db')).sort.each do |f|

data/lib/prometheus/client/page_size.rb

@@ -0,0 +1,17 @@
+require 'open3'
+
+module Prometheus
+  module Client
+    module PageSize
+      def self.page_size(fallback_page_size: 4096)
+        stdout, status = Open3.capture2('getconf PAGESIZE')
+        return fallback_page_size if status.nil? || !status.success?
+
+        page_size = stdout.chomp.to_i
+        return fallback_page_size if page_size <= 0
+
+        page_size
+      end
+    end
+  end
+end

data/lib/prometheus/client/version.rb

@@ -1,5 +1,5 @@
 module Prometheus
   module Client
-    VERSION = '0.19.1'.freeze
+    VERSION = '0.20.0'.freeze
   end
 end

data/vendor/c/hashmap/.gitignore

@@ -0,0 +1,52 @@
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf

data/vendor/c/jsmn/.travis.yml

@@ -0,0 +1,4 @@
+language: c
+sudo: false
+script:
+  - make test

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-client-mmap
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Tobias Schmidt
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: fuzzbert
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,7 @@ email:
 executables: []
 extensions:
 - ext/fast_mmaped_file/extconf.rb
+- ext/fast_mmaped_file_rs/extconf.rb
 extra_rdoc_files: []
 files:
 - README.md
@@ -114,6 +129,23 @@ files:
 - ext/fast_mmaped_file/utils.h
 - ext/fast_mmaped_file/value_access.c
 - ext/fast_mmaped_file/value_access.h
+- ext/fast_mmaped_file_rs/.cargo/config.toml
+- ext/fast_mmaped_file_rs/.tool-versions
+- ext/fast_mmaped_file_rs/Cargo.lock
+- ext/fast_mmaped_file_rs/Cargo.toml
+- ext/fast_mmaped_file_rs/README.md
+- ext/fast_mmaped_file_rs/extconf.rb
+- ext/fast_mmaped_file_rs/src/error.rs
+- ext/fast_mmaped_file_rs/src/file_entry.rs
+- ext/fast_mmaped_file_rs/src/file_info.rs
+- ext/fast_mmaped_file_rs/src/lib.rs
+- ext/fast_mmaped_file_rs/src/macros.rs
+- ext/fast_mmaped_file_rs/src/map.rs
+- ext/fast_mmaped_file_rs/src/mmap.rs
+- ext/fast_mmaped_file_rs/src/parser.rs
+- ext/fast_mmaped_file_rs/src/raw_entry.rs
+- ext/fast_mmaped_file_rs/src/testhelper.rs
+- ext/fast_mmaped_file_rs/src/util.rs
 - lib/prometheus.rb
 - lib/prometheus/client.rb
 - lib/prometheus/client/configuration.rb
@@ -132,6 +164,7 @@ files:
 - lib/prometheus/client/metric.rb
 - lib/prometheus/client/mmaped_dict.rb
 - lib/prometheus/client/mmaped_value.rb
+- lib/prometheus/client/page_size.rb
 - lib/prometheus/client/push.rb
 - lib/prometheus/client/rack/collector.rb
 - lib/prometheus/client/rack/exporter.rb
@@ -141,6 +174,7 @@ files:
 - lib/prometheus/client/support/unicorn.rb
 - lib/prometheus/client/uses_value_type.rb
 - lib/prometheus/client/version.rb
+- vendor/c/hashmap/.gitignore
 - vendor/c/hashmap/LICENSE
 - vendor/c/hashmap/README.md
 - vendor/c/hashmap/_config.yml
@@ -148,6 +182,7 @@ files:
 - vendor/c/hashmap/src/hashmap.h
 - vendor/c/hashmap/test/Makefile
 - vendor/c/hashmap/test/hashmap_test.c
+- vendor/c/jsmn/.travis.yml
 - vendor/c/jsmn/LICENSE
 - vendor/c/jsmn/Makefile
 - vendor/c/jsmn/README.md
@@ -178,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A suite of instrumentation metric primitivesthat can be exposed through a