prometheus-client-mmap 0.20.1 → 0.20.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c348888918d1d6d2ff4334aa37e1ca1b27275246050db022db7723e220613717
-  data.tar.gz: 6f082d9c9d3bb0b1181817b1ebfde447912ad8b23209e93d24350526e2118c36
+  metadata.gz: a044be30f61b4d49820eb47e00c524ba90c3bb15ad8f6ddb97c0106eecda2839
+  data.tar.gz: aa953907ebd58fe257cb0f894e8d997746c61f38e1b45e3500e288fc5a3c54e2
 SHA512:
-  metadata.gz: 2824ca427aab9d85d0516c4d8f4c42bc7dfd67995a1f208dc6cd2eefcfab71716ed202de22549943b7538ff5bb87aeb94d1d9e6e1ce476bb466292f3e2679a3e
-  data.tar.gz: 0ccb59ead46f5047cea39cddcd89d55516e30b0a09e92b25aa940b39e589b991e314264630c808b85bc3460f778ec2833d4a1111b40d82bb45fb99fe92aeb7a2
+  metadata.gz: c499ccd0dc2442f9a5ffd0cab890a1f462a0f086bf818cb2af61c9533170fe6f0d6c5a84124053838c4be0a180ec8be29c114de45785c6066841fe88282628d0
+  data.tar.gz: 4bac46af2fff3c5d2332199c69ba78e625015bf5820089e295462a6d22d4f7ecab023ae138628f9e582c4738e97a4d77d939082993625a3d5a9a5ff9a448feb8

data/ext/fast_mmaped_file_rs/Cargo.lock

@@ -9,7 +9,6 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "2c99f64d1e06488f620f932677e24bc6e2897582980441ae90a671415bd7ec2f"
 dependencies = [
  "cfg-if",
- "getrandom",
  "once_cell",
  "version_check",
 ]
@@ -161,8 +160,8 @@ dependencies = [
 name = "fast_mmaped_file_rs"
 version = "0.1.0"
 dependencies = [
- "ahash",
  "bstr",
+ "hashbrown",
  "indoc",
  "libc",
  "magnus",
@@ -212,6 +211,15 @@ version = "0.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b"
 
+[[package]]
+name = "hashbrown"
+version = "0.13.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "43a3c133739dddd0d2990f9a4bdf8eb4b21ef50e4851ca85ab661199821d510e"
+dependencies = [
+ "ahash",
+]
+
 [[package]]
 name = "hermit-abi"
 version = "0.3.1"

data/ext/fast_mmaped_file_rs/Cargo.toml

@@ -6,7 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-ahash = "0.8"
+hashbrown = "0.13"
 libc = "0.2"
 magnus = { git = "https://github.com/matsadler/magnus", branch = "main", features = ["rb-sys"] }
 memmap2 = "0.5"

data/ext/fast_mmaped_file_rs/extconf.rb

@@ -1,22 +1,30 @@
 require "mkmf"
 require "rb_sys/mkmf"
 
-create_rust_makefile("fast_mmaped_file_rs") do |r|
-  if enable_config('fail-on-warning')
-    r.extra_rustflags = ["-Dwarnings"]
-  end
+if find_executable('rustc')
+  create_rust_makefile("fast_mmaped_file_rs") do |r|
+    r.auto_install_rust_toolchain = false
 
-  if enable_config('debug')
-    r.profile = :dev
-  end
+    if enable_config('fail-on-warning')
+      r.extra_rustflags = ["-Dwarnings"]
+    end
+
+    if enable_config('debug')
+      r.profile = :dev
+    end
+
+    if enable_config('address-sanitizer')
+      r.extra_rustflags = ["-Zsanitizer=address"]
+    end
 
-  if enable_config('address-sanitizer')
-    r.extra_rustflags = ["-Zsanitizer=address"]
+    # `rb_sys/mkmf` passes all arguments after `--` directly to `cargo rustc`.
+    # We use this awful hack to keep compatibility with existing flags used by
+    # the C implementation.
+    trimmed_argv = ARGV.take_while { |arg| arg != "--" }
+    ARGV = trimmed_argv
   end
+else
+  puts 'rustc not found, skipping Rust extension.'
 
-  # `rb_sys/mkmf` passes all arguments after `--` directly to `cargo rustc`.
-  # We use this awful hack to keep compatibility with existing flags used by
-  # the C implementation.
-  trimmed_argv = ARGV.take_while { |arg| arg != "--" }
-  ARGV = trimmed_argv
+  File.write('Makefile', dummy_makefile($srcdir).join(''))
 end

data/ext/fast_mmaped_file_rs/src/file_entry.rs

@@ -1,5 +1,6 @@
 use magnus::{StaticSymbol, Symbol};
 use std::fmt::Write;
+use std::str;
 
 use crate::error::{MmapError, RubyError};
 use crate::file_info::FileInfo;
@@ -23,27 +24,55 @@ pub struct EntryData {
     pub pid: Option<String>,
 }
 
-impl EntryData {
-    pub fn new(raw_entry: &RawEntry, file_info: &FileInfo, pid_significant: bool) -> Result<Self> {
-        let mut buf = Vec::new();
+impl<'a> PartialEq<BorrowedData<'a>> for EntryData {
+    fn eq(&self, other: &BorrowedData) -> bool {
+        self.pid.as_deref() == other.pid && self.json == other.json
+    }
+}
+
+impl<'a> TryFrom<BorrowedData<'a>> for EntryData {
+    type Error = MmapError;
 
-        if buf.try_reserve_exact(raw_entry.encoded_len()).is_err() {
-            return Err(MmapError::OutOfMemory(raw_entry.encoded_len()));
+    fn try_from(borrowed: BorrowedData) -> Result<Self> {
+        let mut json = String::new();
+        if json.try_reserve_exact(borrowed.json.len()).is_err() {
+            return Err(MmapError::OutOfMemory(borrowed.json.len()));
         }
+        json.push_str(borrowed.json);
 
-        buf.resize(raw_entry.encoded_len(), 0);
-        buf.copy_from_slice(raw_entry.json());
+        Ok(Self {
+            json,
+            // Don't bother checking for allocation failure, typically ~10 bytes
+            pid: borrowed.pid.map(|p| p.to_string()),
+        })
+    }
+}
+
+/// A borrowed copy of the JSON string and pid for a `FileEntry`. We use this
+/// to check if a given string/pid combination is present in the `EntryMap`,
+/// copying them to owned values only when needed.
+#[derive(Hash, PartialEq, Eq, PartialOrd, Ord, Clone, Debug)]
+pub struct BorrowedData<'a> {
+    pub json: &'a str,
+    pub pid: Option<&'a str>,
+}
 
-        let json = String::from_utf8(buf)
+impl<'a> BorrowedData<'a> {
+    pub fn new(
+        raw_entry: &'a RawEntry,
+        file_info: &'a FileInfo,
+        pid_significant: bool,
+    ) -> Result<Self> {
+        let json = str::from_utf8(raw_entry.json())
             .map_err(|e| MmapError::Encoding(format!("invalid UTF-8 in entry JSON: {e}")))?;
 
         let pid = if pid_significant {
-            Some(file_info.pid.clone())
+            Some(file_info.pid.as_str())
         } else {
             None
         };
 
-        Ok(EntryData { json, pid })
+        Ok(Self { json, pid })
     }
 }
 
@@ -421,7 +450,9 @@ mod test {
                 .zip(file_infos)
                 .map(|(entry, info)| {
                     let meta = EntryMetadata::new(&entry, &info).unwrap();
-                    let data = EntryData::new(&entry, &info, meta.is_pid_significant()).unwrap();
+                    let borrowed =
+                        BorrowedData::new(&entry, &info, meta.is_pid_significant()).unwrap();
+                    let data = EntryData::try_from(borrowed).unwrap();
                     FileEntry { data, meta }
                 })
                 .collect();
@@ -528,7 +559,9 @@ mod test {
                 .map(|s| RawEntry::from_slice(s).unwrap())
                 .map(|entry| {
                     let meta = EntryMetadata::new(&entry, &info).unwrap();
-                    let data = EntryData::new(&entry, &info, meta.is_pid_significant()).unwrap();
+                    let borrowed =
+                        BorrowedData::new(&entry, &info, meta.is_pid_significant()).unwrap();
+                    let data = EntryData::try_from(borrowed).unwrap();
                     FileEntry { data, meta }
                 })
                 .collect();

data/ext/fast_mmaped_file_rs/src/map.rs

@@ -1,9 +1,11 @@
-use ahash::AHashMap;
+use hashbrown::hash_map::RawEntryMut;
+use hashbrown::HashMap;
 use magnus::{exception::*, Error, RArray};
+use std::hash::{BuildHasher, Hash, Hasher};
 use std::mem::size_of;
 
 use crate::error::MmapError;
-use crate::file_entry::{EntryData, EntryMetadata, FileEntry};
+use crate::file_entry::{BorrowedData, EntryData, EntryMetadata, FileEntry};
 use crate::file_info::FileInfo;
 use crate::raw_entry::RawEntry;
 use crate::util::read_u32;
@@ -17,12 +19,12 @@ use crate::{err, HEADER_SIZE};
 /// allows us to have multiple entries on the map for multiple pids using the
 /// same string.
 #[derive(Default, Debug)]
-pub struct EntryMap(AHashMap<EntryData, EntryMetadata>);
+pub struct EntryMap(HashMap<EntryData, EntryMetadata>);
 
 impl EntryMap {
     /// Construct a new EntryMap.
     pub fn new() -> Self {
-        Self(AHashMap::new())
+        Self(HashMap::new())
     }
 
     /// Given a list of files, read each one into memory and parse the metrics it contains.
@@ -95,12 +97,28 @@ impl EntryMap {
     /// Check if the `EntryMap` already contains the JSON string.
     /// If yes, update the associated value, if not insert the
     /// entry into the map.
-    pub fn merge_or_store(&mut self, data: EntryData, meta: EntryMetadata) {
-        if let Some(existing) = self.0.get_mut(&data) {
-            existing.merge(&meta);
-        } else {
-            self.0.insert(data, meta);
+    pub fn merge_or_store(&mut self, data: BorrowedData, meta: EntryMetadata) -> Result<()> {
+        // Manually hash the `BorrowedData` and perform an equality check on the
+        // key. This allows us to perform the comparison without allocating a
+        // new `EntryData` that may not be needed.
+        let mut state = self.0.hasher().build_hasher();
+        data.hash(&mut state);
+        let hash = state.finish();
+
+        match self.0.raw_entry_mut().from_hash(hash, |k| k == &data) {
+            RawEntryMut::Vacant(entry) => {
+                // Allocate a new `EntryData` as the JSON/pid combination is
+                // not present in the map.
+                let owned = EntryData::try_from(data)?;
+                entry.insert(owned, meta);
+            }
+            RawEntryMut::Occupied(mut entry) => {
+                let existing = entry.get_mut();
+                existing.merge(&meta);
+            }
         }
+
+        Ok(())
     }
 
     /// Parse metrics data from a `.db` file and store in the `EntryMap`.
@@ -135,9 +153,9 @@ impl EntryMap {
             }
 
             let meta = EntryMetadata::new(&raw_entry, &file_info)?;
-            let data = EntryData::new(&raw_entry, &file_info, meta.is_pid_significant())?;
+            let data = BorrowedData::new(&raw_entry, &file_info, meta.is_pid_significant())?;
 
-            self.merge_or_store(data, meta);
+            self.merge_or_store(data, meta)?;
 
             pos += raw_entry.total_len();
         }
@@ -155,6 +173,16 @@ mod test {
     use crate::file_entry::FileEntry;
     use crate::testhelper::{self, TestFile};
 
+    impl EntryData {
+        /// A helper function for tests to convert owned data to references.
+        fn as_borrowed(&self) -> BorrowedData {
+            BorrowedData {
+                json: &self.json,
+                pid: self.pid.as_deref(),
+            }
+        }
+    }
+
     #[test]
     fn test_into_sorted() {
         let _cleanup = unsafe { magnus::embed::init() };
@@ -311,7 +339,9 @@ mod test {
         map.0
             .insert(starting_entry.data.clone(), starting_entry.meta.clone());
 
-        map.merge_or_store(matching_entry.data, matching_entry.meta);
+        let matching_borrowed = matching_entry.data.as_borrowed();
+        map.merge_or_store(matching_borrowed, matching_entry.meta)
+            .unwrap();
 
         assert_eq!(
             5.0,
@@ -320,10 +350,12 @@ mod test {
         );
         assert_eq!(1, map.0.len(), "no entry added");
 
+        let same_key_different_worker_borrowed = same_key_different_worker.data.as_borrowed();
         map.merge_or_store(
-            same_key_different_worker.data,
+            same_key_different_worker_borrowed,
             same_key_different_worker.meta,
-        );
+        )
+        .unwrap();
 
         assert_eq!(
             5.0,
@@ -333,7 +365,9 @@ mod test {
 
         assert_eq!(2, map.0.len(), "additional entry added");
 
-        map.merge_or_store(unmatched_entry.data, unmatched_entry.meta);
+        let unmatched_entry_borrowed = unmatched_entry.data.as_borrowed();
+        map.merge_or_store(unmatched_entry_borrowed, unmatched_entry.meta)
+            .unwrap();
 
         assert_eq!(
             5.0,

data/lib/prometheus/client/version.rb

@@ -1,5 +1,5 @@
 module Prometheus
   module Client
-    VERSION = '0.20.1'.freeze
+    VERSION = '0.20.3'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prometheus-client-mmap
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.20.3
 platform: ruby
 authors:
 - Tobias Schmidt
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-15 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rb_sys