prometheus-client-mmap 0.28.1 → 1.0.0

data/ext/fast_mmaped_file/utils.c

@@ -1,56 +0,0 @@
-#include "utils.h"
-
-#include <errno.h>
-
-static void rb_save_exception(VALUE exception, VALUE message) {
-    VALUE current_thread = rb_thread_current();
-
-    rb_thread_local_aset(current_thread, rb_intern("prometheus_last_exception"), exception);
-    rb_thread_local_aset(current_thread, rb_intern("prometheus_last_exception_message"), message);
-}
-/* @deprecated - use with_exception ignoring return value */
-void save_exception(VALUE exception, const char *fmt, ...) {
-    va_list args;
-
-    va_start(args, fmt);
-    VALUE message = rb_vsprintf(fmt, args);
-
-    rb_save_exception(exception, message);
-    va_end(args);
-}
-
-int with_exception(VALUE exception, const char *fmt, ...) {
-    va_list args;
-
-    va_start(args, fmt);
-    VALUE message = rb_vsprintf(fmt, args);
-
-    rb_save_exception(exception, message);
-    va_end(args);
-
-    return FAILURE;
-}
-
-int with_exception_errno(VALUE exception, const char *fmt, ...) {
-    va_list args;
-
-    va_start(args, fmt);
-    VALUE message = rb_vsprintf(fmt, args);
-    rb_str_catf(message, " (%s)", strerror(errno));
-
-    rb_save_exception(exception, message);
-    va_end(args);
-
-    return FAILURE;
-}
-
-NORETURN(void raise_last_exception()) {
-    VALUE current_thread = rb_thread_current();
-    VALUE exception = rb_thread_local_aref(current_thread, rb_intern("prometheus_last_exception"));
-    VALUE message = rb_thread_local_aref(current_thread, rb_intern("prometheus_last_exception_message"));
-    if (exception != Qnil) {
-        rb_raise(exception, "%s", StringValueCStr(message));
-    } else {
-        rb_raise(rb_eRuntimeError, "no exception found in thread local");
-    }
-}

data/ext/fast_mmaped_file/utils.h

@@ -1,22 +0,0 @@
-#ifndef UNUSED_H
-#define UNUSED_H
-#include <ruby.h>
-
-#ifdef UNUSED
-#elif defined(__GNUC__)
-#define UNUSED(x) UNUSED_##x __attribute__((unused))
-#elif defined(__LCLINT__)
-#define UNUSED(x) /*@unused@*/ x
-#else
-#define UNUSED(x) x
-#endif
-
-#define SUCCESS 1
-#define FAILURE 0
-
-NORETURN(void raise_last_exception());
-void save_exception(VALUE exception, const char *fmt, ...);
-int with_exception(VALUE exception, const char *fmt, ...);
-int with_exception_errno(VALUE exception, const char *fmt, ...);
-
-#endif

data/ext/fast_mmaped_file/value_access.c

@@ -1,242 +0,0 @@
-#include "value_access.h"
-
-#include <errno.h>
-#include <fcntl.h>
-#include <ruby/intern.h>
-#include <sys/mman.h>
-#include <unistd.h>
-
-#include "file_format.h"
-#include "mmap.h"
-#include "utils.h"
-
-static void close_file(mm_ipc *i_mm) {
-    close(i_mm->t->fd);
-    i_mm->t->fd = -1;
-}
-
-static int open_and_extend_file(mm_ipc *i_mm, size_t len) {
-    if (i_mm->t->fd < 0) {
-        int fd;
-
-        if ((fd = open(i_mm->t->path, i_mm->t->smode)) == -1) {
-            return with_exception_errno(rb_eArgError, "%s: Can't open %s", __FILE__, i_mm->t->path);
-        }
-        i_mm->t->fd = fd;
-    }
-
-    if (lseek(i_mm->t->fd, len - 1, SEEK_SET) == -1) {
-        close_file(i_mm);
-        return with_exception_errno(rb_eIOError, "Can't lseek %zu", len - 1);
-    }
-
-    if (write(i_mm->t->fd, "\000", 1) != 1) {
-        close_file(i_mm);
-        return with_exception_errno(rb_eIOError, "Can't extend %s", i_mm->t->path);
-    }
-    i_mm->t->len = len;
-
-    return SUCCESS;
-}
-
-static int perform_munmap(mm_ipc *i_mm) {
-    if (i_mm->t->addr != NULL && munmap(i_mm->t->addr, i_mm->t->len)) {
-        i_mm->t->addr = NULL;
-        return with_exception_errno(rb_eArgError, "munmap failed");
-    }
-
-    i_mm->t->addr = NULL;
-    i_mm->t->len = 0;
-    i_mm->t->real = 0;
-
-    return SUCCESS;
-}
-
-static int perform_mmap(mm_ipc *i_mm, size_t len) {
-    MMAP_RETTYPE addr = mmap(0, len, i_mm->t->pmode, i_mm->t->vscope, i_mm->t->fd, i_mm->t->offset);
-
-    if (addr == MAP_FAILED) {
-        return with_exception_errno(rb_eArgError, "mmap failed");
-    }
-
-    i_mm->t->addr = addr;
-    i_mm->t->len = len;
-    i_mm->t->real = len;
-
-    return SUCCESS;
-}
-
-static int expand(VALUE self, mm_ipc *i_mm, size_t len) {
-    if (len < i_mm->t->len) {
-        return with_exception(rb_eArgError, "Can't reduce the size of mmap");
-    }
-
-    if (!perform_munmap(i_mm)) {
-        return FAILURE;
-    }
-
-    if (!open_and_extend_file(i_mm, len)) {
-        return FAILURE;
-    }
-
-    if (!perform_mmap(i_mm, len)) {
-        close_file(i_mm);
-        return FAILURE;
-    }
-
-    if ((i_mm->t->flag & MM_LOCK) && mlock(i_mm->t->addr, len) == -1) {
-        return with_exception_errno(rb_eArgError, "mlock(%d)", errno);
-    }
-
-    mm_update(self);
-
-    return SUCCESS;
-}
-
-static void save_entry(mm_ipc *i_mm, size_t offset, VALUE key, VALUE value) {
-    uint32_t key_length = (uint32_t)RSTRING_LEN(key);
-
-    char *pos = (char *)i_mm->t->addr + offset;
-
-    memcpy(pos, &key_length, sizeof(uint32_t));
-    pos += sizeof(uint32_t);
-
-    memmove(pos, StringValuePtr(key), key_length);
-    pos += key_length;
-
-    memset(pos, ' ', padding_length(key_length));  // TODO: considder padding with /0
-    pos += padding_length(key_length);
-
-    double val = NUM2DBL(value);
-    memcpy(pos, &val, sizeof(double));
-}
-
-static void save_value(mm_ipc *i_mm, VALUE _offset, VALUE value) {
-    Check_Type(_offset, T_FIXNUM);
-    size_t offset = NUM2UINT(_offset);
-    if ((i_mm->t->real + sizeof(double)) <= offset) {
-        rb_raise(rb_eIndexError, "offset %zu out of string", offset);
-    }
-
-    if (i_mm->t->flag & MM_FROZEN) {
-        rb_error_frozen("mmap");
-    }
-
-    char *pos = (char *)i_mm->t->addr + offset;
-
-    double val = NUM2DBL(value);
-    memcpy(pos, &val, sizeof(double));
-}
-
-static VALUE load_value(mm_ipc *i_mm, VALUE _offset) {
-    Check_Type(_offset, T_FIXNUM);
-    size_t offset = NUM2UINT(_offset);
-    if ((i_mm->t->real + sizeof(double)) <= offset) {
-        rb_raise(rb_eIndexError, "offset %zu out of string", offset);
-    }
-
-    char *pos = (char *)i_mm->t->addr + offset;
-
-    double value;
-    memcpy(&value, pos, sizeof(double));
-    return DBL2NUM(value);
-}
-
-uint32_t load_used(mm_ipc *i_mm) {
-    uint32_t used = *((uint32_t *)i_mm->t->addr);
-
-    if (used == 0) {
-        used = START_POSITION;
-    }
-    return used;
-}
-
-void save_used(mm_ipc *i_mm, uint32_t used) { *((uint32_t *)i_mm->t->addr) = used; }
-
-static VALUE initialize_entry(VALUE self, mm_ipc *i_mm, VALUE positions, VALUE key, VALUE value) {
-    if (i_mm->t->flag & MM_FROZEN) {
-        rb_error_frozen("mmap");
-    }
-
-    if (RSTRING_LEN(key) > INT32_MAX) {
-        rb_raise(rb_eArgError, "string length gt %d", INT32_MAX);
-    }
-
-    uint32_t key_length = (uint32_t)RSTRING_LEN(key);
-    uint32_t value_offset = sizeof(uint32_t) + key_length + padding_length(key_length);
-    uint32_t entry_length = value_offset + sizeof(double);
-
-    uint32_t used = load_used(i_mm);
-    while (i_mm->t->len < (used + entry_length)) {
-        if (!expand(self, i_mm, i_mm->t->len * 2)) {
-            raise_last_exception();
-        }
-    }
-
-    save_entry(i_mm, used, key, value);
-    save_used(i_mm, used + entry_length);
-
-    return rb_hash_aset(positions, key, INT2NUM(used + value_offset));
-}
-
-VALUE method_fetch_entry(VALUE self, VALUE positions, VALUE key, VALUE default_value) {
-    Check_Type(positions, T_HASH);
-    Check_Type(key, T_STRING);
-
-    mm_ipc *i_mm;
-    GET_MMAP(self, i_mm, MM_MODIFY);
-
-    VALUE position = rb_hash_lookup(positions, key);
-
-    if (position != Qnil) {
-        return load_value(i_mm, position);
-    }
-
-    position = initialize_entry(self, i_mm, positions, key, default_value);
-    return load_value(i_mm, position);
-}
-
-VALUE method_upsert_entry(VALUE self, VALUE positions, VALUE key, VALUE value) {
-    Check_Type(positions, T_HASH);
-    Check_Type(key, T_STRING);
-
-    mm_ipc *i_mm;
-    GET_MMAP(self, i_mm, MM_MODIFY);
-
-    VALUE position = rb_hash_lookup(positions, key);
-
-    if (position != Qnil) {
-        save_value(i_mm, position, value);
-        return load_value(i_mm, position);
-    }
-
-    position = initialize_entry(self, i_mm, positions, key, value);
-    return load_value(i_mm, position);
-}
-
-VALUE method_load_used(VALUE self) {
-    mm_ipc *i_mm;
-
-    GET_MMAP(self, i_mm, MM_MODIFY);
-    return UINT2NUM(load_used(i_mm));
-}
-
-VALUE method_save_used(VALUE self, VALUE value) {
-    Check_Type(value, T_FIXNUM);
-    mm_ipc *i_mm;
-
-    GET_MMAP(self, i_mm, MM_MODIFY);
-
-    if (i_mm->t->flag & MM_FROZEN) {
-        rb_error_frozen("mmap");
-    }
-
-    if (i_mm->t->len < INITIAL_SIZE) {
-        if (!expand(self, i_mm, INITIAL_SIZE)) {
-            raise_last_exception();
-        }
-    }
-
-    save_used(i_mm, NUM2UINT(value));
-    return value;
-}

data/ext/fast_mmaped_file/value_access.h

@@ -1,15 +0,0 @@
-#ifndef VALUE_ACCESS_H
-#define VALUE_ACCESS_H
-#include <ruby.h>
-
-VALUE method_load_used(VALUE self);
-
-VALUE method_save_used(VALUE self, VALUE value);
-
-VALUE method_get_double(VALUE self, VALUE index);
-
-VALUE method_fetch_entry(VALUE self, VALUE positions, VALUE key, VALUE default_value);
-
-VALUE method_upsert_entry(VALUE self, VALUE positions, VALUE key, VALUE value);
-
-#endif

data/lib/prometheus/client/helper/loader.rb

@@ -1,44 +0,0 @@
-module Prometheus
-  module Client
-    module Helper
-      module Loader
-        class << self
-          def rust_impl_available?
-            return @rust_available unless @rust_available.nil?
-
-            check_for_rust
-          end
-
-          private
-
-          def load_rust_extension
-            begin
-              ruby_version = /(\d+\.\d+)/.match(RUBY_VERSION)
-              require_relative "../../../#{ruby_version}/fast_mmaped_file_rs"
-            rescue LoadError
-              require 'fast_mmaped_file_rs'
-            end
-          end
-
-          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
-              load_rust_extension
-              true
-            rescue LoadError
-              warn <<~WARN
-WARNING: The Rust extension for prometheus-client-mmap is unavailable, falling back to the legacy C extension.
-  The Rust extension will be required in the next version. If you are compiling this gem from source,
-  ensure your build system has a Rust compiler and clang: https://gitlab.com/gitlab-org/ruby/gems/prometheus-client-mmap
-WARN
-              false
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/vendor/c/hashmap/.gitignore

@@ -1,52 +0,0 @@
-# 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/hashmap/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2016 David Leeds
-
-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/vendor/c/hashmap/README.md

@@ -1,90 +0,0 @@
-# hashmap
-Flexible hashmap implementation in C using open addressing and linear probing for collision resolution.
-
-### Summary
-This project came into existence because there are a notable lack of flexible and easy to use data structures available in C.  Sure, higher level languages have built-in libraries, but plenty of embedded projects or higher level libraries start with core C code.  It was undesirable to add a bulky library like Glib as a dependency to my projects, or grapple with a restrictive license agreement.  Searching for "C hashmap" yielded results with questionable algorithms and code quality, projects with difficult or inflexible interfaces, or projects with less desirable licenses.  I decided it was time to create my own.
-
-
-### Goals
-* **To scale gracefully to the full capacity of the numeric primitives in use.**  E.g. on a 32-bit machine, you should be able to load a billion+ entries without hitting any bugs relating to integer overflows.  Lookups on a hashtable with a billion entries should be performed in close to constant time, no different than lookups in a hashtable with 20 entries.  Automatic rehashing occurs and maintains a load factor of 0.75 or less.
-* **To provide a clean and easy-to-use interface.**  C data structures often struggle to strike a balance between flexibility and ease of use.  To this end, I provided a generic interface using void pointers for keys and data, and macros to generate type-specific wrapper functions, if desired.
-* **To enable easy iteration and safe entry removal during iteration.**  Applications often need these features, and the data structure should not hold them back.  Both an iterator interface and a foreach function was provided to satisfy various use-cases.  This hashmap also uses an open addressing scheme, which has superior iteration performance to a similar hashmap implemented using separate chaining (buckets with linked lists).  This is because fewer instructions are needed per iteration, and array traversal has superior cache performance than linked list traversal.
-* **To use a very unrestrictive software license.**  Using no license was an option, but I wanted to allow the code to be tracked, simply for my own edification.  I chose the MIT license because it is the most common open source license in use, and it grants full rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell the code.  Basically, take this code and do what you want with it.  Just be nice and leave the license comment and my name at top of the file.  Feel free to add your name if you are modifying and redistributing.
-
-### Code Example
-```C
-#include <stdlib.h>
-#include <stdio.h>
-
-#include <hashmap.h>
-
-/* Some sample data structure with a string key */
-struct blob {
-  char key[32];
-  size_t data_len;
-  unsigned char data[1024];
-};
-
-/* Declare type-specific blob_hashmap_* functions with this handy macro */
-HASHMAP_FUNCS_CREATE(blob, const char, struct blob)
-
-struct blob *blob_load(void)
-{
-  struct blob *b;
-  /*
-   * Hypothetical function that allocates and loads blob structures
-   * from somewhere.  Returns NULL when there are no more blobs to load.
-   */
-  return b;
-}
-
-/* Hashmap structure */
-struct hashmap map;
-
-int main(int argc, char **argv)
-{
-  struct blob *b;
-  struct hashmap_iter *iter;
-
-  /* Initialize with default string key functions and init size */
-  hashmap_init(&map, hashmap_hash_string, hashmap_compare_string, 0);
-
-  /* Load some sample data into the map and discard duplicates */
-  while ((b = blob_load()) != NULL) {
-    if (blob_hashmap_put(&map, b->key, b) != b) {
-      printf("discarding blob with duplicate key: %s\n", b->key);
-      free(b);
-    }
-  }
-
-  /* Lookup a blob with key "AbCdEf" */
-  b = blob_hashmap_get(&map, "AbCdEf");
-  if (b) {
-    printf("Found blob[%s]\n", b->key);
-  }
-
-  /* Iterate through all blobs and print each one */
-  for (iter = hashmap_iter(&map); iter; iter = hashmap_iter_next(&map, iter)) {
-    printf("blob[%s]: data_len %zu bytes\n", blob_hashmap_iter_get_key(iter),
-      blob_hashmap_iter_get_data(iter)->data_len);
-  }
-
-  /* Remove all blobs with no data */
-  iter = hashmap_iter(&map);
-  while (iter) {
-    b = blob_hashmap_iter_get_data(iter);
-    if (b->data_len == 0) {
-      iter = hashmap_iter_remove(&map, iter);
-      free(b);
-    } else {
-      iter = hashmap_iter_next(&map, iter);
-    }
-  }
-
-  /* Free all allocated resources associated with map and reset its state */
-  hashmap_destroy(&map);
-
-  return 0;
-}
-
-```

data/vendor/c/hashmap/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-slate