Merge pull request #21 from OliverKillane/enh/add-warning-checks

Improved testing with linting checks and higher instantiation coverage

Author: OliverKillane

.clang-tidy

@@ -8,6 +8,7 @@ Checks: >
   misc-*,
   -misc-no-recursion,
   performance-*,
+  -performance-no-int-to-ptr,
   portability-*,
   readability-*,
   -readability-braces-around-statements,
@@ -17,6 +18,7 @@ Checks: >
   -readability-avoid-const-params-in-decls,
   -readability-implicit-bool-conversion,
   -readability-duplicate-include,
+  -readability-redundant-casting,
   -bugprone-macro-parentheses,
   -misc-non-private-member-variables-in-classes,
   -clang-diagnostic-*,

CMakeLists.txt

@@ -19,6 +19,46 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
   set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "RelWithDebInfo" "MinSizeRel")
 endif()
 
+# Warnings
+# Applied to the derive-c (c compiled) examples, and for warning tests.
+#  - Not used for tests, as these are not a product of the library, and as rapidcheck and gtest 
+#    fail many stricter warnings.
+add_library(dc_warnings_c INTERFACE)
+target_compile_options(dc_warnings_c INTERFACE
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wall>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wextra>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wpedantic>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Werror>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wformat=2>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wformat-security>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wnull-dereference>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wvla>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wcast-align>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wwrite-strings>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wconversion>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wsign-conversion>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wshadow>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wundef>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wpointer-arith>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wswitch-enum>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wmissing-noreturn>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wimplicit-fallthrough>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wunreachable-code>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wdouble-promotion>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wfloat-equal>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wstrict-aliasing>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wstrict-prototypes>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wmissing-prototypes>
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wmissing-declarations>
+
+  # We expect to have unused functions when analysing the library without user code.
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wno-unused-function>
+
+  # We allow for empty structs (required to keep the release overhead of debug 
+  # only memory tracking, invalidation tracking zero)
+  $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Wno-gnu-empty-struct>
+)
+
 # Sanitizers
 #  - Supporting address,undefined by default. Msan and tsan are enableable separately.
 #  - Defaulted only in debug

docs/Doxyfile.in

@@ -64,4 +64,4 @@ HTML_EXTRA_FILES       = @AWESOME_CSS_DIR@/doxygen-awesome-darkmode-toggle.js \
                          @AWESOME_CSS_DIR@/doxygen-awesome-paragraph-link.js \
                          @AWESOME_CSS_DIR@/doxygen-custom/toggle-alternative-theme.js \
                          @AWESOME_CSS_DIR@/doxygen-awesome-interactive-toc.js \
-                         @AWESOME_CSS_DIR@/doxygen-awesome-tabs.js
+                         @AWESOME_CSS_DIR@/doxygen-awesome-tabs.js

examples/CMakeLists.txt

@@ -1,31 +1,23 @@
+# Examples
 
 # Optional toggle for dumping IR (very noisy)
 option(CLANG_IR_DUMPS "Dump IR before/after all passes" OFF)
 
-# TODO(oliverkillane): get the ui for opt reports working
 function(enable_clang_opt_reports target)
-  # C
   target_compile_options(${target} PRIVATE
-    $<$<COMPILE_LANG_AND_ID:C,Clang>:
-      -gline-tables-only
-      -Rpass=inline -Rpass-missed=inline -Rpass-analysis=inline
-      -Rpass=loop-vectorize -Rpass-missed=loop-vectorize -Rpass-analysis=loop-vectorize
-      -Rpass=slp-vectorizer -Rpass-missed=slp-vectorizer -Rpass-analysis=slp-vectorizer
-      -fsave-optimization-record
-      -Xclang -fdebug-pass-manager
-    >
-  )
-
-  # C++
-  target_compile_options(${target} PRIVATE
-    $<$<COMPILE_LANG_AND_ID:CXX,Clang>:
-      -gline-tables-only
-      -Rpass=inline -Rpass-missed=inline -Rpass-analysis=inline
-      -Rpass=loop-vectorize -Rpass-missed=loop-vectorize -Rpass-analysis=loop-vectorize
-      -Rpass=slp-vectorizer -Rpass-missed=slp-vectorizer -Rpass-analysis=slp-vectorizer
-      -fsave-optimization-record
-      -Xclang -fdebug-pass-manager
-    >
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-gline-tables-only>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Rpass=inline>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Rpass-missed=inline>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Rpass-analysis=inline>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Rpass=loop-vectorize>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Rpass-missed=loop-vectorize>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Rpass-analysis=loop-vectorize>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Rpass=slp-vectorizer>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Rpass-missed=slp-vectorizer>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Rpass-analysis=slp-vectorizer>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-fsave-optimization-record>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-Xclang>
+    $<$<COMPILE_LANG_AND_ID:C,Clang,AppleClang>:-fdebug-pass-manager>
   )
 endfunction()
 
@@ -37,11 +29,14 @@ function(add_example file)
   string(REPLACE "/" "_" example_target_safe "${example_target}")
 
   add_executable(${example_target_safe} ${file})
+
+  target_link_libraries(${example_target_safe} PRIVATE derivec dc_warnings_c)
+
   if(OPT_REPORTS)
     enable_clang_opt_reports(${example_target_safe})
   endif()
 
-  set_target_properties(${example_target_safe} PROPERTIES 
+  set_target_properties(${example_target_safe} PROPERTIES
     RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/${example_dir}"
     OUTPUT_NAME "${example_name_we}"
   )
@@ -52,14 +47,13 @@ function(add_example file)
   set_property(GLOBAL APPEND PROPERTY EXAMPLE_TARGETS ${example_target_safe})
 
   add_test(NAME examples/${example_target} COMMAND $<TARGET_FILE:${example_target_safe}>)
-  set_tests_properties(examples/${example_target} 
+  set_tests_properties(examples/${example_target}
     PROPERTIES
-      DEPENDS ${example_target_safe} 
+      DEPENDS ${example_target_safe}
       LABELS "examples"
   )
 endfunction()
 
-
 file(GLOB_RECURSE EXAMPLES "${CMAKE_CURRENT_SOURCE_DIR}/*.c")
 
 foreach(EXAMPLE_FILE ${EXAMPLES})
@@ -70,7 +64,7 @@ if(OPT_REPORTS)
   # (optional) ensure the tool exists
   find_program(LLVM_OPT_REPORT llvm-opt-report REQUIRED)
 
-  # NEW: fetch the list of example targets
+  # fetch the list of example targets
   get_property(_examples GLOBAL PROPERTY EXAMPLE_TARGETS)
 
   file(GLOB_RECURSE OPT_YAMLS "${CMAKE_BINARY_DIR}/*.opt.yaml")
@@ -86,4 +80,4 @@ if(OPT_REPORTS)
     COMMENT "Generating HTML optimization report"
     VERBATIM
   )
-endif()
+endif()

examples/basic/alloc/hybridstatic.c

@@ -1,14 +1,14 @@
 
 #include <stdio.h>
-#include <derive-c/core/prelude.h>
+#include <derive-c/prelude.h>
 #include <derive-c/alloc/std.h>
 
 #define ALLOC stdalloc
 #define CAPACITY 1024
 #define NAME foopool
 #include <derive-c/alloc/hybridstatic/template.h>
 
-void foopool_raw_example() {
+static void foopool_raw_example() {
     foopool_buffer buf;
     foopool pool = foopool_new(&buf, stdalloc_get_ref());
 

examples/basic/container/arena/basic.c

@@ -8,14 +8,14 @@
 #include <derive-c/utils/for.h>
 
 #include <derive-c/alloc/std.h>
-#include <derive-c/core/prelude.h>
+#include <derive-c/prelude.h>
 
 #define INDEX_BITS 32
 #define VALUE uint32_t
 #define NAME ints
 #include <derive-c/container/arena/contiguous/template.h>
 
-void int_example() {
+static void int_example() {
     ints arena = ints_new_with_capacity_for(12, stdalloc_get_ref());
     ints_insert(&arena, 23);
     ints_insert(&arena, 42);
@@ -48,15 +48,15 @@ struct foo {
     int* owned_data;
 };
 
-void my_foo_delete(struct foo* self) { free(self->owned_data); }
+static void my_foo_delete(struct foo* self) { free(self->owned_data); }
 
-void foo_debug(struct foo const* self, dc_debug_fmt fmt, FILE* stream) {
+static void foo_debug(struct foo const* self, dc_debug_fmt fmt, FILE* stream) {
     (void)fmt;
     fprintf(stream, "foo@%p { x: %d, y: \"%s\", owned_data: @%p { %d }, }", self, self->x, self->y,
             self->owned_data, *self->owned_data);
 }
 
-int* new_owned_int(int value) {
+static int* new_owned_int(int value) {
     int* v = (int*)malloc(sizeof(int));
     *v = value;
     return v;
@@ -69,7 +69,7 @@ int* new_owned_int(int value) {
 #define NAME foo_arena
 #include <derive-c/container/arena/contiguous/template.h>
 
-void foo_example() {
+static void foo_example() {
     foo_arena arena = foo_arena_new_with_capacity_for(12, stdalloc_get_ref());
     foo_arena_index_t index_a =
         foo_arena_insert(&arena, (struct foo){.x = 42, .y = "A", .owned_data = new_owned_int(3)});

examples/basic/container/map/decomposed.c

@@ -14,7 +14,7 @@
 #include <derive-c/algorithm/hash/combine.h>
 
 #include <derive-c/alloc/std.h>
-#include <derive-c/core/prelude.h>
+#include <derive-c/prelude.h>
 #include <derive-c/utils/for.h>
 
 #define KEY uint32_t
@@ -23,7 +23,7 @@
 #define NAME id_to_name
 #include <derive-c/container/map/decomposed/template.h>
 
-void print_map(id_to_name const* map) {
+static void print_map(id_to_name const* map) {
     printf("Map has items:\n");
     size_t pos = 0;
     DC_FOR_CONST(id_to_name, map, iter, entry) {
@@ -32,7 +32,7 @@ void print_map(id_to_name const* map) {
     }
 }
 
-void id_to_name_example() {
+static void id_to_name_example() {
     printf("Id to Name Map Example:\n");
     id_to_name map = id_to_name_new(stdalloc_get_ref());
 
@@ -59,34 +59,34 @@ struct report_id {
     uint32_t section;
 };
 
-void report_id_debug(struct report_id const* self, dc_debug_fmt fmt, FILE* stream) {
+static void report_id_debug(struct report_id const* self, dc_debug_fmt fmt, FILE* stream) {
     (void)fmt;
     fprintf(stream, " report_id@%p { name: \"%s\", section: %d}", self, self->name, self->section);
 }
 
-bool report_id_equality(struct report_id const* report_1, struct report_id const* report_2) {
+static bool report_id_equality(struct report_id const* report_1, struct report_id const* report_2) {
     return strcmp(report_1->name, report_2->name) == 0 && report_1->section == report_2->section;
 }
 
-size_t report_id_hash(struct report_id const* report_id) {
+static size_t report_id_hash(struct report_id const* report_id) {
     return dc_hash_combine(dc_murmur_hash_string(report_id->name),
                            uint32_t_hash_id(&report_id->section));
 }
 
-void report_id_delete(struct report_id* self) { free(self->name); }
+static void report_id_delete(struct report_id* self) { free(self->name); }
 
 struct report {
     char* description;
     int value;
 };
 
-void report_debug(struct report const* self, dc_debug_fmt fmt, FILE* stream) {
+static void report_debug(struct report const* self, dc_debug_fmt fmt, FILE* stream) {
     (void)fmt;
     fprintf(stream, " report@%p { description: \"%s\", value: %d}", self, self->description,
             self->value);
 }
 
-void report_delete(struct report* self) { free(self->description); }
+static void report_delete(struct report* self) { free(self->description); }
 
 #define KEY struct report_id
 #define KEY_EQ report_id_equality
@@ -99,7 +99,7 @@ void report_delete(struct report* self) { free(self->description); }
 #define NAME report_map
 #include <derive-c/container/map/decomposed/template.h>
 
-void report_map_example() {
+static void report_map_example() {
     printf("Report Map Example:\n");
     report_map map = report_map_new(stdalloc_get_ref());
 
@@ -136,16 +136,16 @@ struct fixed_string {
     char value[4];
 };
 
-void fixed_string_debug(struct fixed_string const* self, dc_debug_fmt fmt, FILE* stream) {
+static void fixed_string_debug(struct fixed_string const* self, dc_debug_fmt fmt, FILE* stream) {
     (void)fmt;
     fprintf(stream, "fixed_string@%p { value: \"%.*s\" }", self, 4, self->value);
 }
 
-bool fixed_string_eq(struct fixed_string const* str1, struct fixed_string const* str2) {
+static bool fixed_string_eq(struct fixed_string const* str1, struct fixed_string const* str2) {
     return memcmp(str1->value, str2->value, sizeof(str1->value)) == 0;
 }
 
-size_t fixed_string_hash(struct fixed_string const* str) {
+static size_t fixed_string_hash(struct fixed_string const* str) {
     return dc_murmur_hash_string_4(str->value);
 }
 
@@ -157,7 +157,7 @@ size_t fixed_string_hash(struct fixed_string const* str) {
 #define NAME fixed_string_map
 #include <derive-c/container/map/decomposed/template.h>
 
-void fixed_string_example() {
+static void fixed_string_example() {
     printf("Fixed Strings Example:\n");
     fixed_string_map map = fixed_string_map_new(stdalloc_get_ref());
 

examples/basic/container/queue/circular.c

@@ -1,5 +1,5 @@
 
-#include <derive-c/core/prelude.h>
+#include <derive-c/prelude.h>
 
 #define CAPACITY 300000
 #define NAME bump_alloc
@@ -10,7 +10,7 @@
 #define NAME int_queue
 #include <derive-c/container/queue/circular/template.h>
 
-void basic_example() {
+static void basic_example() {
     bump_alloc_buffer buffer = {};
     bump_alloc alloc = bump_alloc_new(&buffer, stdalloc_get_ref());
 

examples/basic/container/queue/deque.c

@@ -1,5 +1,5 @@
 
-#include <derive-c/core/prelude.h>
+#include <derive-c/prelude.h>
 
 #define CAPACITY 300000
 #define NAME bump_alloc
@@ -10,7 +10,7 @@
 #define NAME int_queue
 #include <derive-c/container/queue/deque/template.h>
 
-void basic_example() {
+static void basic_example() {
     bump_alloc_buffer buffer = {};
     bump_alloc alloc = bump_alloc_new(&buffer, stdalloc_get_ref());