Merge pull request #2729 from ruby/rbs-assert

Make assertions macro

Author: soutaro

bin/benchmark-parse.rb

@@ -2,13 +2,37 @@
 require "benchmark/ips"
 require "csv"
 
+require "optparse"
+
+label = nil #: String?
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: benchmark-parse.rb [options] [file|directory]..."
+
+  opts.on("--label=LABEL", "Set the benchmark label") do |v|
+    label = v
+  end
+end.parse!(ARGV)
+
+file_names = []
 files = {}
 ARGV.each do |file|
+  path = Pathname(file)
+  if path.directory?
+    Pathname.glob(path.join("**", "*.rbs")).each do |p|
+      file_names << p.to_s
+    end
+  else
+    file_names << path.to_s
+  end
+end
+
+file_names.uniq.each do |file|
   content = File.read(file)
   files[file] = RBS::Buffer.new(content: content, name: Pathname(file))
 end
 
-puts "Benchmarking parsing #{files.size} files..."
+puts "Benchmarking RBS(#{RBS::VERSION} in #{Bundler.default_gemfile.basename}#{label ? " (#{label})" : ""}) parsing with #{files.size} files..."
 
 result = Benchmark.ips do |x|
   x.report("parsing") do

ext/rbs_extension/extconf.rb

@@ -18,7 +18,11 @@
   '-Wc++-compat',
 ]
 
-append_cflags ['-O0', '-pg'] if ENV['DEBUG']
+if ENV['DEBUG']
+  append_cflags ['-O0', '-pg']
+else
+  append_cflags ['-DNDEBUG']
+end
 if ENV["TEST_NO_C23"]
   puts "Adding -Wc2x-extensions to CFLAGS"
   $CFLAGS << " -Werror -Wc2x-extensions"

ext/rbs_extension/main.c

@@ -16,7 +16,7 @@
  * ```
  * */
 static NORETURN(void) raise_error(rbs_error_t *error, VALUE buffer) {
-    rbs_assert(error != NULL, "raise_error() called with NULL error");
+    RBS_ASSERT(error != NULL, "raise_error() called with NULL error");
 
     if (!error->syntax_error) {
         rb_raise(rb_eRuntimeError, "Unexpected error");

include/rbs/defines.h

@@ -74,4 +74,13 @@
 #define NODISCARD __attribute__((warn_unused_result))
 #endif
 
+/**
+ * Mark a function or variable as potentially unused to suppress compiler warnings.
+ */
+#if defined(__GNUC__) || defined(__clang__)
+#define RBS_ATTRIBUTE_UNUSED __attribute__((unused))
+#else
+#define RBS_ATTRIBUTE_UNUSED
+#endif
+
 #endif

include/rbs/util/rbs_assert.h

@@ -4,6 +4,17 @@
 #include "rbs/defines.h"
 #include <stdbool.h>
 
-void rbs_assert(bool condition, const char *fmt, ...) RBS_ATTRIBUTE_FORMAT(2, 3);
+/**
+ * RBS_ASSERT macro that calls rbs_assert in debug builds and is removed in release builds.
+ * In debug mode, it forwards all arguments to the rbs_assert function.
+ * In release mode, it expands to nothing.
+ */
+#ifdef NDEBUG
+#define RBS_ASSERT(condition, ...) ((void) 0)
+#else
+#define RBS_ASSERT(condition, ...) rbs_assert_impl(condition, __VA_ARGS__)
+#endif
+
+void rbs_assert_impl(bool condition, const char *fmt, ...) RBS_ATTRIBUTE_FORMAT(2, 3);
 
 #endif

include/rbs/util/rbs_encoding.h

@@ -6,6 +6,8 @@
 #ifndef RBS_RBS_ENCODING_H
 #define RBS_RBS_ENCODING_H
 
+#include "rbs/defines.h"
+
 #include <assert.h>
 #include <stdbool.h>
 #include <stddef.h>

src/lexstate.c

@@ -143,7 +143,7 @@ bool rbs_next_char(rbs_lexer_t *lexer, unsigned int *codepoint, size_t *byte_len
 }
 
 void rbs_skip(rbs_lexer_t *lexer) {
-    rbs_assert(lexer->current_character_bytes > 0, "rbs_skip called with current_character_bytes == 0");
+    RBS_ASSERT(lexer->current_character_bytes > 0, "rbs_skip called with current_character_bytes == 0");
 
     if (RBS_UNLIKELY(lexer->current_code_point == '\0')) {
         return;

src/location.c

@@ -6,7 +6,7 @@
 #define RBS_LOC_CHILDREN_SIZE(cap) (sizeof(rbs_loc_children) + sizeof(rbs_loc_entry) * ((cap) - 1))
 
 void rbs_loc_alloc_children(rbs_allocator_t *allocator, rbs_location_t *loc, size_t capacity) {
-    rbs_assert(capacity <= sizeof(rbs_loc_entry_bitmap) * 8, "Capacity %zu is too large. Max is %zu", capacity, sizeof(rbs_loc_entry_bitmap) * 8);
+    RBS_ASSERT(capacity <= sizeof(rbs_loc_entry_bitmap) * 8, "Capacity %zu is too large. Max is %zu", capacity, sizeof(rbs_loc_entry_bitmap) * 8);
 
     loc->children = rbs_allocator_malloc_impl(allocator, RBS_LOC_CHILDREN_SIZE(capacity), rbs_alignof(rbs_loc_children));
 
@@ -16,8 +16,8 @@ void rbs_loc_alloc_children(rbs_allocator_t *allocator, rbs_location_t *loc, siz
 }
 
 void rbs_loc_add_optional_child(rbs_location_t *loc, rbs_constant_id_t name, rbs_range_t r) {
-    rbs_assert(loc->children != NULL, "All children should have been pre-allocated with rbs_loc_alloc_children()");
-    rbs_assert((loc->children->len + 1 <= loc->children->cap), "Not enough space was pre-allocated for the children. Children: %hu, Capacity: %hu", loc->children->len, loc->children->cap);
+    RBS_ASSERT(loc->children != NULL, "All children should have been pre-allocated with rbs_loc_alloc_children()");
+    RBS_ASSERT((loc->children->len + 1 <= loc->children->cap), "Not enough space was pre-allocated for the children. Children: %hu, Capacity: %hu", loc->children->len, loc->children->cap);
 
     unsigned short i = loc->children->len++;
     loc->children->entries[i].name = name;

src/parser.c

@@ -233,7 +233,7 @@ error_handling: {
         ids = "class/module/constant name";
     }
 
-    rbs_assert(ids != NULL, "Unknown kind of type: %i", kind);
+    RBS_ASSERT(ids != NULL, "Unknown kind of type: %i", kind);
 
     rbs_parser_set_error(parser, parser->current_token, true, "expected one of %s", ids);
     return false;

src/util/rbs_allocator.c

@@ -64,7 +64,7 @@ static rbs_allocator_page_t *rbs_allocator_page_new(size_t payload_size) {
     return page;
 }
 
-rbs_allocator_t *rbs_allocator_init() {
+rbs_allocator_t *rbs_allocator_init(void) {
     rbs_allocator_t *allocator = malloc(sizeof(rbs_allocator_t));
 
     const size_t system_page_size = get_system_page_size();
@@ -98,7 +98,7 @@ void *rbs_allocator_realloc_impl(rbs_allocator_t *allocator, void *ptr, size_t o
 
 // Allocates `size` bytes from `allocator`, aligned to an `alignment`-byte boundary.
 void *rbs_allocator_malloc_impl(rbs_allocator_t *allocator, size_t size, size_t alignment) {
-    rbs_assert(size % alignment == 0, "size must be a multiple of the alignment. size: %zu, alignment: %zu", size, alignment);
+    RBS_ASSERT(size % alignment == 0, "size must be a multiple of the alignment. size: %zu, alignment: %zu", size, alignment);
 
     if (allocator->default_page_payload_size < size) { // Big allocation, give it its own page.
         rbs_allocator_page_t *new_page = rbs_allocator_page_new(size);