rbs 3.6.1 → 3.9.5

data/src/util/rbs_constant_pool.c

@@ -0,0 +1,342 @@
+#include "rbs/util/rbs_constant_pool.h"
+
+/**
+ * Initialize a list of constant ids.
+ */
+void
+rbs_constant_id_list_init(rbs_constant_id_list_t *list) {
+    list->ids = NULL;
+    list->size = 0;
+    list->capacity = 0;
+}
+
+/**
+ * Initialize a list of constant ids with a given capacity.
+ */
+void
+rbs_constant_id_list_init_capacity(rbs_constant_id_list_t *list, size_t capacity) {
+    list->ids = calloc(capacity, sizeof(rbs_constant_id_t));
+    if (list->ids == NULL) abort();
+
+    list->size = 0;
+    list->capacity = capacity;
+}
+
+/**
+ * Append a constant id to a list of constant ids. Returns false if any
+ * potential reallocations fail.
+ */
+bool
+rbs_constant_id_list_append(rbs_constant_id_list_t *list, rbs_constant_id_t id) {
+    if (list->size >= list->capacity) {
+        list->capacity = list->capacity == 0 ? 8 : list->capacity * 2;
+        list->ids = (rbs_constant_id_t *) realloc(list->ids, sizeof(rbs_constant_id_t) * list->capacity);
+        if (list->ids == NULL) return false;
+    }
+
+    list->ids[list->size++] = id;
+    return true;
+}
+
+/**
+ * Insert a constant id into a list of constant ids at the specified index.
+ */
+void
+rbs_constant_id_list_insert(rbs_constant_id_list_t *list, size_t index, rbs_constant_id_t id) {
+    assert(index < list->capacity);
+    assert(list->ids[index] == RBS_CONSTANT_ID_UNSET);
+
+    list->ids[index] = id;
+    list->size++;
+}
+
+/**
+ * Checks if the current constant id list includes the given constant id.
+ */
+bool
+rbs_constant_id_list_includes(rbs_constant_id_list_t *list, rbs_constant_id_t id) {
+    for (size_t index = 0; index < list->size; index++) {
+        if (list->ids[index] == id) return true;
+    }
+    return false;
+}
+
+/**
+ * Free the memory associated with a list of constant ids.
+ */
+void
+rbs_constant_id_list_free(rbs_constant_id_list_t *list) {
+    if (list->ids != NULL) {
+        free(list->ids);
+    }
+}
+
+/**
+ * A relatively simple hash function (djb2) that is used to hash strings. We are
+ * optimizing here for simplicity and speed.
+ */
+static inline uint32_t
+rbs_constant_pool_hash(const uint8_t *start, size_t length) {
+    // This is a prime number used as the initial value for the hash function.
+    uint32_t value = 5381;
+
+    for (size_t index = 0; index < length; index++) {
+        value = ((value << 5) + value) + start[index];
+    }
+
+    return value;
+}
+
+/**
+ * https://graphics.stanford.edu/~seander/bithacks.html#RoundUpPowerOf2
+ */
+static uint32_t
+next_power_of_two(uint32_t v) {
+    // Avoid underflow in subtraction on next line.
+    if (v == 0) {
+        // 1 is the nearest power of 2 to 0 (2^0)
+        return 1;
+    }
+    v--;
+    v |= v >> 1;
+    v |= v >> 2;
+    v |= v >> 4;
+    v |= v >> 8;
+    v |= v >> 16;
+    v++;
+    return v;
+}
+
+#ifndef NDEBUG
+static bool
+is_power_of_two(uint32_t size) {
+    return (size & (size - 1)) == 0;
+}
+#endif
+
+/**
+ * Resize a constant pool to a given capacity.
+ */
+static inline bool
+rbs_constant_pool_resize(rbs_constant_pool_t *pool) {
+    assert(is_power_of_two(pool->capacity));
+
+    uint32_t next_capacity = pool->capacity * 2;
+    if (next_capacity < pool->capacity) return false;
+
+    const uint32_t mask = next_capacity - 1;
+    const size_t element_size = sizeof(rbs_constant_pool_bucket_t) + sizeof(rbs_constant_t);
+
+    void *next = calloc(next_capacity, element_size);
+    if (next == NULL) return false;
+
+    rbs_constant_pool_bucket_t *next_buckets = next;
+    rbs_constant_t *next_constants = (void *)(((char *) next) + next_capacity * sizeof(rbs_constant_pool_bucket_t));
+
+    // For each bucket in the current constant pool, find the index in the
+    // next constant pool, and insert it.
+    for (uint32_t index = 0; index < pool->capacity; index++) {
+        rbs_constant_pool_bucket_t *bucket = &pool->buckets[index];
+
+        // If an id is set on this constant, then we know we have content here.
+        // In this case we need to insert it into the next constant pool.
+        if (bucket->id != RBS_CONSTANT_ID_UNSET) {
+            uint32_t next_index = bucket->hash & mask;
+
+            // This implements linear scanning to find the next available slot
+            // in case this index is already taken. We don't need to bother
+            // comparing the values since we know that the hash is unique.
+            while (next_buckets[next_index].id != RBS_CONSTANT_ID_UNSET) {
+                next_index = (next_index + 1) & mask;
+            }
+
+            // Here we copy over the entire bucket, which includes the id so
+            // that they are consistent between resizes.
+            next_buckets[next_index] = *bucket;
+        }
+    }
+
+    // The constants are stable with respect to hash table resizes.
+    memcpy(next_constants, pool->constants, pool->size * sizeof(rbs_constant_t));
+
+    // pool->constants and pool->buckets are allocated out of the same chunk
+    // of memory, with the buckets coming first.
+    free(pool->buckets);
+    pool->constants = next_constants;
+    pool->buckets = next_buckets;
+    pool->capacity = next_capacity;
+    return true;
+}
+
+// This storage is initialized by `Init_rbs_extension()` in `main.c`.
+static rbs_constant_pool_t RBS_GLOBAL_CONSTANT_POOL_STORAGE = { 0 };
+rbs_constant_pool_t *RBS_GLOBAL_CONSTANT_POOL = &RBS_GLOBAL_CONSTANT_POOL_STORAGE;
+
+/**
+ * Initialize a new constant pool with a given capacity.
+ */
+bool
+rbs_constant_pool_init(rbs_constant_pool_t *pool, uint32_t capacity) {
+    const uint32_t maximum = (~((uint32_t) 0));
+    if (capacity >= ((maximum / 2) + 1)) return false;
+
+    capacity = next_power_of_two(capacity);
+    const size_t element_size = sizeof(rbs_constant_pool_bucket_t) + sizeof(rbs_constant_t);
+    void *memory = calloc(capacity, element_size);
+    if (memory == NULL) return false;
+
+    pool->buckets = memory;
+    pool->constants = (void *)(((char *)memory) + capacity * sizeof(rbs_constant_pool_bucket_t));
+    pool->size = 0;
+    pool->capacity = capacity;
+    return true;
+}
+
+/**
+ * Return a pointer to the constant indicated by the given constant id.
+ */
+rbs_constant_t *
+rbs_constant_pool_id_to_constant(const rbs_constant_pool_t *pool, rbs_constant_id_t constant_id) {
+    assert(constant_id != RBS_CONSTANT_ID_UNSET && constant_id <= pool->size);
+    return &pool->constants[constant_id - 1];
+}
+
+/**
+ * Find a constant in a constant pool. Returns the id of the constant, or 0 if
+ * the constant is not found.
+ */
+rbs_constant_id_t
+rbs_constant_pool_find(const rbs_constant_pool_t *pool, const uint8_t *start, size_t length) {
+    assert(is_power_of_two(pool->capacity));
+    const uint32_t mask = pool->capacity - 1;
+
+    uint32_t hash = rbs_constant_pool_hash(start, length);
+    uint32_t index = hash & mask;
+    rbs_constant_pool_bucket_t *bucket;
+
+    while (bucket = &pool->buckets[index], bucket->id != RBS_CONSTANT_ID_UNSET) {
+        rbs_constant_t *constant = &pool->constants[bucket->id - 1];
+        if ((constant->length == length) && memcmp(constant->start, start, length) == 0) {
+            return bucket->id;
+        }
+
+        index = (index + 1) & mask;
+    }
+
+    return RBS_CONSTANT_ID_UNSET;
+}
+
+/**
+ * Insert a constant into a constant pool and return its index in the pool.
+ */
+static inline rbs_constant_id_t
+rbs_constant_pool_insert(rbs_constant_pool_t *pool, const uint8_t *start, size_t length, rbs_constant_pool_bucket_type_t type) {
+    if (pool->size >= (pool->capacity / 4 * 3)) {
+        if (!rbs_constant_pool_resize(pool)) return RBS_CONSTANT_ID_UNSET;
+    }
+
+    assert(is_power_of_two(pool->capacity));
+    const uint32_t mask = pool->capacity - 1;
+
+    uint32_t hash = rbs_constant_pool_hash(start, length);
+    uint32_t index = hash & mask;
+    rbs_constant_pool_bucket_t *bucket;
+
+    while (bucket = &pool->buckets[index], bucket->id != RBS_CONSTANT_ID_UNSET) {
+        // If there is a collision, then we need to check if the content is the
+        // same as the content we are trying to insert. If it is, then we can
+        // return the id of the existing constant.
+        rbs_constant_t *constant = &pool->constants[bucket->id - 1];
+
+        if ((constant->length == length) && memcmp(constant->start, start, length) == 0) {
+            // Since we have found a match, we need to check if this is
+            // attempting to insert a shared or an owned constant. We want to
+            // prefer shared constants since they don't require allocations.
+            if (type == RBS_CONSTANT_POOL_BUCKET_OWNED) {
+                // If we're attempting to insert an owned constant and we have
+                // an existing constant, then either way we don't want the given
+                // memory. Either it's duplicated with the existing constant or
+                // it's not necessary because we have a shared version.
+                free((void *) start);
+            } else if (bucket->type == RBS_CONSTANT_POOL_BUCKET_OWNED) {
+                // If we're attempting to insert a shared constant and the
+                // existing constant is owned, then we can free the owned
+                // constant and replace it with the shared constant.
+                free((void *) constant->start);
+                constant->start = start;
+                bucket->type = (unsigned int) (RBS_CONSTANT_POOL_BUCKET_DEFAULT & 0x3);
+            }
+
+            return bucket->id;
+        }
+
+        index = (index + 1) & mask;
+    }
+
+    // IDs are allocated starting at 1, since the value 0 denotes a non-existent
+    // constant.
+    uint32_t id = ++pool->size;
+    assert(pool->size < ((uint32_t) (1 << 30)));
+
+    *bucket = (rbs_constant_pool_bucket_t) {
+        .id = (unsigned int) (id & 0x3fffffff),
+        .type = (unsigned int) (type & 0x3),
+        .hash = hash
+    };
+
+    pool->constants[id - 1] = (rbs_constant_t) {
+        .start = start,
+        .length = length,
+    };
+
+    return id;
+}
+
+/**
+ * Insert a constant into a constant pool. Returns the id of the constant, or
+ * RBS_CONSTANT_ID_UNSET if any potential calls to resize fail.
+ */
+rbs_constant_id_t
+rbs_constant_pool_insert_shared(rbs_constant_pool_t *pool, const uint8_t *start, size_t length) {
+    return rbs_constant_pool_insert(pool, start, length, RBS_CONSTANT_POOL_BUCKET_DEFAULT);
+}
+
+/**
+ * Insert a constant into a constant pool from memory that is now owned by the
+ * constant pool. Returns the id of the constant, or RBS_CONSTANT_ID_UNSET if any
+ * potential calls to resize fail.
+ */
+rbs_constant_id_t
+rbs_constant_pool_insert_owned(rbs_constant_pool_t *pool, uint8_t *start, size_t length) {
+    return rbs_constant_pool_insert(pool, start, length, RBS_CONSTANT_POOL_BUCKET_OWNED);
+}
+
+/**
+ * Insert a constant into a constant pool from memory that is constant. Returns
+ * the id of the constant, or RBS_CONSTANT_ID_UNSET if any potential calls to
+ * resize fail.
+ */
+rbs_constant_id_t
+rbs_constant_pool_insert_constant(rbs_constant_pool_t *pool, const uint8_t *start, size_t length) {
+    return rbs_constant_pool_insert(pool, start, length, RBS_CONSTANT_POOL_BUCKET_CONSTANT);
+}
+
+/**
+ * Free the memory associated with a constant pool.
+ */
+void
+rbs_constant_pool_free(rbs_constant_pool_t *pool) {
+    // For each constant in the current constant pool, free the contents if the
+    // contents are owned.
+    for (uint32_t index = 0; index < pool->capacity; index++) {
+        rbs_constant_pool_bucket_t *bucket = &pool->buckets[index];
+
+        // If an id is set on this constant, then we know we have content here.
+        if (bucket->id != RBS_CONSTANT_ID_UNSET && bucket->type == RBS_CONSTANT_POOL_BUCKET_OWNED) {
+            rbs_constant_t *constant = &pool->constants[bucket->id - 1];
+            free((void *) constant->start);
+        }
+    }
+
+    free(pool->buckets);
+}

data/stdlib/base64/0/base64.rbs

@@ -5,14 +5,12 @@
 #     printable ASCII characters.
 # *   Decoding such an encoded string.
 #
-#
 # Base64 is commonly used in contexts where binary data is not allowed or
 # supported:
 #
 # *   Images in HTML or CSS files, or in URLs.
 # *   Email attachments.
 #
-#
 # A Base64-encoded string is about one-third larger that its source. See the
 # [Wikipedia article](https://en.wikipedia.org/wiki/Base64) for more
 # information.
@@ -24,7 +22,6 @@
 # *   Whether "padding" is to be used.
 # *   Whether encoded strings are to contain newlines.
 #
-#
 # Note: Examples on this page assume that the including program has executed:
 #
 #     require 'base64'
@@ -45,22 +42,18 @@
 #         [RFC-4648-compliant](https://datatracker.ietf.org/doc/html/rfc4648);
 #         safe for URLs.
 #
-#
-#
 # If you are working with Base64-encoded strings that will come from or be put
 # into URLs, you should choose this encoder-decoder pair of RFC-4648-compliant
 # methods:
 #
 # *   Base64.urlsafe_encode64 and Base64.urlsafe_decode64.
 #
-#
 # Otherwise, you may choose any of the pairs in this module, including the pair
 # above, or the RFC-2045-compliant pairs:
 #
 # *   Base64.encode64 and Base64.decode64.
 # *   Base64.strict_encode64 and Base64.strict_decode64.
 #
-#
 # ## Padding
 #
 # Base64-encoding changes a triplet of input bytes into a quartet of output
@@ -104,7 +97,6 @@
 #         # n = 2:  8 bytes => 12 characters.
 #         Base64.strict_encode64('12345678') # => "MDEyMzQ1Njc="
 #
-#
 # When padding is suppressed, for a positive integer *n*:
 #
 # *   Input bytes of length *3n* generate unpadded output characters of length
@@ -131,7 +123,6 @@
 #         # m = 2:  8 bytes => 11 characters.
 #         Base64.urlsafe_encode64('12345678', padding: false) # => "MDEyMzQ1Njc"
 #
-#
 # **Padding in Decode Methods**
 #
 # All of the Base64 decode methods support (but do not require) padding.

data/stdlib/benchmark/0/benchmark.rbs

@@ -46,7 +46,6 @@
 #           x.report("upto:")  { 1.upto(n) do ; a = "1"; end }
 #         end
 #
-#
 # The result:
 #
 #                   user     system      total        real
@@ -241,7 +240,11 @@ module Benchmark
   #   rdoc-file=lib/benchmark.rb
   #   - realtime() { || ... }
   # -->
-  # Returns the elapsed real time used to execute the given block.
+  # Returns the elapsed real time used to execute the given block. The unit of
+  # time is seconds.
+  #
+  #     Benchmark.realtime { "a" * 1_000_000_000 }
+  #     #=> 0.5098029999935534
   #
   def self?.realtime: () { () -> void } -> Float
 
@@ -366,17 +369,23 @@ module Benchmark
     #
     # `%u`
     # :   Replaced by the user CPU time, as reported by Tms#utime.
+    #
     # `%y`
     # :   Replaced by the system CPU time, as reported by #stime (Mnemonic: y of
     #     "s*y*stem")
+    #
     # `%U`
     # :   Replaced by the children's user CPU time, as reported by Tms#cutime
+    #
     # `%Y`
     # :   Replaced by the children's system CPU time, as reported by Tms#cstime
+    #
     # `%t`
     # :   Replaced by the total CPU time, as reported by Tms#total
+    #
     # `%r`
     # :   Replaced by the elapsed real time, as reported by Tms#real
+    #
     # `%n`
     # :   Replaced by the label string, as reported by Tms#label (Mnemonic: n of
     #     "*n*ame")