Add always_inline annotation to performance critical functions

SanderMertens · SanderMertens · commit bb5d29610765 · 2025-03-13T17:04:51.000-07:00
diff --git a/distr/flecs.c b/distr/flecs.c
@@ -2948,6 +2948,82 @@ uint32_t flecs_get_table_version(
 
 #endif
 
+/**
+ * @file addons/journal.h
+ * @brief Journaling addon that logs API functions.
+ *
+ * The journaling addon traces API calls. The trace is formatted as runnable
+ * C code, which allows for (partially) reproducing the behavior of an app
+ * with the journaling trace.
+ *
+ * The journaling addon is disabled by default. Enabling it can have a
+ * significant impact on performance.
+ */
+
+#ifdef FLECS_JOURNAL
+
+#ifndef FLECS_LOG
+#define FLECS_LOG
+#endif
+
+#ifndef FLECS_JOURNAL_H
+#define FLECS_JOURNAL_H
+
+/**
+ * @defgroup c_addons_journal Journal
+ * @ingroup c_addons
+ * Journaling addon (disabled by default).
+ *
+ *
+ * @{
+ */
+
+/* Trace when log level is at or higher than level */
+#define FLECS_JOURNAL_LOG_LEVEL (0)
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Journaling API, meant to be used by internals. */
+
+typedef enum ecs_journal_kind_t {
+    EcsJournalNew,
+    EcsJournalMove,
+    EcsJournalClear,
+    EcsJournalDelete,
+    EcsJournalDeleteWith,
+    EcsJournalRemoveAll,
+    EcsJournalTableEvents
+} ecs_journal_kind_t;
+
+FLECS_DBG_API
+void flecs_journal_begin(
+    ecs_world_t *world,
+    ecs_journal_kind_t kind,
+    ecs_entity_t entity,
+    ecs_type_t *add,
+    ecs_type_t *remove);
+
+FLECS_DBG_API
+void flecs_journal_end(void);
+
+#define flecs_journal(...)\
+    flecs_journal_begin(__VA_ARGS__);\
+    flecs_journal_end();
+
+#ifdef __cplusplus
+}
+#endif // __cplusplus
+/** @} */
+#endif // FLECS_JOURNAL_H
+#else
+#define flecs_journal_begin(...)
+#define flecs_journal_end(...)
+#define flecs_journal(...)
+
+#endif // FLECS_JOURNAL
+
 /**
  * @file datastructures/name_index.h
  * @brief Data structure for resolving 64bit keys by string (name).
diff --git a/distr/flecs.h b/distr/flecs.h
@@ -173,6 +173,12 @@
  */
 // #define FLECS_CPP_NO_ENUM_REFLECTION
 
+/** @def FLECS_NO_ALWAYS_INLINE
+ * When set, this will prevent functions from being annotated with always_inline
+ * which can improve performance at the cost of increased binary footprint.
+ */
+// #define FLECS_NO_ALWAYS_INLINE
+
 /** @def FLECS_CUSTOM_BUILD
  * This macro lets you customize which addons to build flecs with.
  * Without any addons Flecs is just a minimal ECS storage, but addons add
@@ -883,6 +889,18 @@ typedef struct ecs_allocator_t ecs_allocator_t;
 #define ECS_ALIGNOF(T) ((int64_t)&((struct { char c; T d; } *)0)->d)
 #endif
 
+#ifndef FLECS_NO_ALWAYS_INLINE
+    #if defined(ECS_TARGET_CLANG) || defined(ECS_TARGET_GCC)
+        #define FLECS_ALWAYS_INLINE __attribute__((always_inline))
+    #elif defined(ECS_TARGET_MSVC)
+        #define FLECS_ALWAYS_INLINE __forceinline
+    #else
+        #define FLECS_ALWAYS_INLINE
+    #endif
+#else
+    #define FLECS_ALWAYS_INLINE
+#endif
+
 #ifndef FLECS_NO_DEPRECATED_WARNINGS
 #if defined(ECS_TARGET_GNU)
 #define ECS_DEPRECATED(msg) __attribute__((deprecated(msg)))
@@ -6523,7 +6541,7 @@ bool ecs_is_enabled_id(
  * @see ecs_get_mut_id()
  */
 FLECS_API
-const void* ecs_get_id(
+FLECS_ALWAYS_INLINE const void* ecs_get_id(
     const ecs_world_t *world,
     ecs_entity_t entity,
     ecs_id_t id);
@@ -6540,7 +6558,7 @@ const void* ecs_get_id(
  * @return The component pointer, NULL if the entity does not have the component.
  */
 FLECS_API
-void* ecs_get_mut_id(
+FLECS_ALWAYS_INLINE void* ecs_get_mut_id(
     const ecs_world_t *world,
     ecs_entity_t entity,
     ecs_id_t id);
@@ -7111,7 +7129,7 @@ char* ecs_entity_str(
  * @see ecs_owns_id()
  */
 FLECS_API
-bool ecs_has_id(
+FLECS_ALWAYS_INLINE bool ecs_has_id(
     const ecs_world_t *world,
     ecs_entity_t entity,
     ecs_id_t id);
@@ -7127,7 +7145,7 @@ bool ecs_has_id(
  * @return True if the entity has the id, false if not.
  */
 FLECS_API
-bool ecs_owns_id(
+FLECS_ALWAYS_INLINE bool ecs_owns_id(
     const ecs_world_t *world,
     ecs_entity_t entity,
     ecs_id_t id);
@@ -10665,82 +10683,6 @@ int ecs_value_move_ctor(
 #endif
 
 /* Always included, if disabled functions are replaced with dummy macros */
-/**
- * @file addons/journal.h
- * @brief Journaling addon that logs API functions.
- *
- * The journaling addon traces API calls. The trace is formatted as runnable
- * C code, which allows for (partially) reproducing the behavior of an app
- * with the journaling trace.
- *
- * The journaling addon is disabled by default. Enabling it can have a
- * significant impact on performance.
- */
-
-#ifdef FLECS_JOURNAL
-
-#ifndef FLECS_LOG
-#define FLECS_LOG
-#endif
-
-#ifndef FLECS_JOURNAL_H
-#define FLECS_JOURNAL_H
-
-/**
- * @defgroup c_addons_journal Journal
- * @ingroup c_addons
- * Journaling addon (disabled by default).
- *
- *
- * @{
- */
-
-/* Trace when log level is at or higher than level */
-#define FLECS_JOURNAL_LOG_LEVEL (0)
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* Journaling API, meant to be used by internals. */
-
-typedef enum ecs_journal_kind_t {
-    EcsJournalNew,
-    EcsJournalMove,
-    EcsJournalClear,
-    EcsJournalDelete,
-    EcsJournalDeleteWith,
-    EcsJournalRemoveAll,
-    EcsJournalTableEvents
-} ecs_journal_kind_t;
-
-FLECS_DBG_API
-void flecs_journal_begin(
-    ecs_world_t *world,
-    ecs_journal_kind_t kind,
-    ecs_entity_t entity,
-    ecs_type_t *add,
-    ecs_type_t *remove);
-
-FLECS_DBG_API
-void flecs_journal_end(void);
-
-#define flecs_journal(...)\
-    flecs_journal_begin(__VA_ARGS__);\
-    flecs_journal_end();
-
-#ifdef __cplusplus
-}
-#endif // __cplusplus
-/** @} */
-#endif // FLECS_JOURNAL_H
-#else
-#define flecs_journal_begin(...)
-#define flecs_journal_end(...)
-#define flecs_journal(...)
-
-#endif // FLECS_JOURNAL
-
 /**
  * @file addons/log.h
  * @brief Logging addon.
diff --git a/include/flecs.h b/include/flecs.h
@@ -171,6 +171,12 @@
  */
 // #define FLECS_CPP_NO_ENUM_REFLECTION
 
+/** @def FLECS_NO_ALWAYS_INLINE
+ * When set, this will prevent functions from being annotated with always_inline
+ * which can improve performance at the cost of increased binary footprint.
+ */
+// #define FLECS_NO_ALWAYS_INLINE
+
 /** @def FLECS_CUSTOM_BUILD
  * This macro lets you customize which addons to build flecs with.
  * Without any addons Flecs is just a minimal ECS storage, but addons add
@@ -3158,7 +3164,7 @@ bool ecs_is_enabled_id(
  * @see ecs_get_mut_id()
  */
 FLECS_API
-const void* ecs_get_id(
+FLECS_ALWAYS_INLINE const void* ecs_get_id(
     const ecs_world_t *world,
     ecs_entity_t entity,
     ecs_id_t id);
@@ -3175,7 +3181,7 @@ const void* ecs_get_id(
  * @return The component pointer, NULL if the entity does not have the component.
  */
 FLECS_API
-void* ecs_get_mut_id(
+FLECS_ALWAYS_INLINE void* ecs_get_mut_id(
     const ecs_world_t *world,
     ecs_entity_t entity,
     ecs_id_t id);
@@ -3746,7 +3752,7 @@ char* ecs_entity_str(
  * @see ecs_owns_id()
  */
 FLECS_API
-bool ecs_has_id(
+FLECS_ALWAYS_INLINE bool ecs_has_id(
     const ecs_world_t *world,
     ecs_entity_t entity,
     ecs_id_t id);
@@ -3762,7 +3768,7 @@ bool ecs_has_id(
  * @return True if the entity has the id, false if not.
  */
 FLECS_API
-bool ecs_owns_id(
+FLECS_ALWAYS_INLINE bool ecs_owns_id(
     const ecs_world_t *world,
     ecs_entity_t entity,
     ecs_id_t id);
diff --git a/include/flecs/addons/os_api_impl.h b/include/flecs/addons/os_api_impl.h
diff --git a/include/flecs/private/addons.h b/include/flecs/private/addons.h
@@ -74,7 +74,6 @@
 #endif
 
 /* Always included, if disabled functions are replaced with dummy macros */
-#include "flecs/private/journal.h"
 #include "flecs/addons/log.h"
 
 /* Handle addon dependencies that need declarations to be visible in header */
@@ -217,7 +216,7 @@
 #ifdef FLECS_NO_OS_API_IMPL
 #error "FLECS_NO_OS_API_IMPL failed: OS_API_IMPL is required by other addons"
 #endif
-#include "../private/os_api_impl.h"
+#include "../addons/os_api_impl.h"
 #endif
 
 #ifdef FLECS_MODULE
diff --git a/include/flecs/private/api_defines.h b/include/flecs/private/api_defines.h
@@ -258,6 +258,18 @@ typedef struct ecs_allocator_t ecs_allocator_t;
 #define ECS_ALIGNOF(T) ((int64_t)&((struct { char c; T d; } *)0)->d)
 #endif
 
+#ifndef FLECS_NO_ALWAYS_INLINE
+    #if defined(ECS_TARGET_CLANG) || defined(ECS_TARGET_GCC)
+        #define FLECS_ALWAYS_INLINE __attribute__((always_inline))
+    #elif defined(ECS_TARGET_MSVC)
+        #define FLECS_ALWAYS_INLINE __forceinline
+    #else
+        #define FLECS_ALWAYS_INLINE
+    #endif
+#else
+    #define FLECS_ALWAYS_INLINE
+#endif
+
 #ifndef FLECS_NO_DEPRECATED_WARNINGS
 #if defined(ECS_TARGET_GNU)
 #define ECS_DEPRECATED(msg) __attribute__((deprecated(msg)))
diff --git a/src/journal.h b/src/journal.h
diff --git a/src/private_api.h b/src/private_api.h
@@ -15,6 +15,7 @@
 #include "poly.h"
 #include "stage.h"
 #include "world.h"
+#include "journal.h"
 #include "datastructures/name_index.h"
 
 
