optimize ecs_get_ptr_t when locks are not active

Author: Indra-db

distr/flecs.c

@@ -2786,19 +2786,36 @@ void flecs_enqueue(
 #ifdef FLECS_MUT_ALIAS_LOCKS
     #define FLECS_LOCK_TARGET_INIT(cr_, table_, col_) \
      .lock_target = (ecs_lock_target_t){ .cr = (cr_), .table = (table_), .column_index = (int16_t)(col_) },
+    
+    /* Construct ecs_get_ptr_t with lock target info */
+    #define ECS_GET_PTR(ptr_, cr_, table_, col_) \
+        (ecs_get_ptr_t){ \
+            .ptr = (ptr_), \
+            .lock_target = (ecs_lock_target_t){ .cr = (cr_), .table = (table_), .column_index = (int16_t)(col_) } \
+        }
+    
+    /* Construct null ecs_get_ptr_t */
+    #define ECS_GET_PTR_NULL (ecs_get_ptr_t){0}
+    
+    /* Extract the pointer from ecs_get_ptr_t */
+    #define ECS_GET_PTR_PTR(get_ptr_) ((get_ptr_).ptr)
 #else
     #define FLECS_LOCK_TARGET_INIT(cr_, table_, col_) /* nothing */
+    
+    /* When FLECS_MUT_ALIAS_LOCKS is not defined, ecs_get_ptr_t is just void* */
+    #define ECS_GET_PTR(ptr_, cr_, table_, col_) ((ecs_get_ptr_t)(ptr_))
+    #define ECS_GET_PTR_NULL ((ecs_get_ptr_t)NULL)
+    #define ECS_GET_PTR_PTR(get_ptr_) (get_ptr_)
 #endif
 
 #define ecs_get_low_id(table, r, id)\
     ecs_assert(table->component_map != NULL, ECS_INTERNAL_ERROR, NULL);\
     int16_t column_index = table->component_map[id];\
     if (column_index > 0) {\
         ecs_column_t *column = &table->data.columns[--column_index];\
-        return (ecs_get_ptr_t){\
-            .ptr = ECS_ELEM(column->data, column->ti->size, ECS_RECORD_TO_ROW(r->row)),\
-            FLECS_LOCK_TARGET_INIT(NULL, table, column_index)\
-        };\
+        return ECS_GET_PTR(\
+            ECS_ELEM(column->data, column->ti->size, ECS_RECORD_TO_ROW(r->row)),\
+            NULL, table, column_index);\
     }
 
 typedef struct {
@@ -5687,7 +5704,7 @@ void* flecs_defer_ensure(
         void *base = NULL;
         if (table && (table->flags & EcsTableHasIsA)) {
             ecs_component_record_t *cr = flecs_components_get(world, id);
-            base = flecs_get_base_component(world, table, id, cr, 0).ptr;
+            base = ECS_GET_PTR_PTR(flecs_get_base_component(world, table, id, cr, 0));
         }
 
         if (!base) {
@@ -7527,16 +7544,16 @@ ecs_get_ptr_t flecs_get_base_component(
 
     /* Table (and thus entity) does not have component, look for base */
     if (!(table->flags & EcsTableHasIsA)) {
-        return (ecs_get_ptr_t){0};
+        return ECS_GET_PTR_NULL;
     }
 
     if (!(cr->flags & EcsIdOnInstantiateInherit)) {
-        return (ecs_get_ptr_t){0};
+        return ECS_GET_PTR_NULL;
     }
 
     /* Exclude Name */
     if (component == ecs_pair(ecs_id(EcsIdentifier), EcsName)) {
-        return (ecs_get_ptr_t){0};
+        return ECS_GET_PTR_NULL;
     }
 
     /* Table should always be in the table index for (IsA, *), otherwise the
@@ -7548,7 +7565,7 @@ ecs_get_ptr_t flecs_get_base_component(
     ecs_type_t type = table->type;
     ecs_id_t *ids = type.array;
     int32_t i = tr_isa->index, end = tr_isa->count + tr_isa->index;
-    ecs_get_ptr_t ptr = {0};
+    ecs_get_ptr_t ptr = ECS_GET_PTR_NULL;
 
     do {
         ecs_id_t pair = ids[i ++];
@@ -7563,36 +7580,33 @@ ecs_get_ptr_t flecs_get_base_component(
         const ecs_table_record_t *tr = flecs_component_get_table(cr, table);
         if (!tr) {
             if (cr->flags & EcsIdDontFragment) {
-                ptr = (ecs_get_ptr_t){
-                    .ptr = flecs_component_sparse_get(world, cr, table, base),
-                    FLECS_LOCK_TARGET_INIT(cr, NULL, -1)
-                };
+                ptr = ECS_GET_PTR(
+                    flecs_component_sparse_get(world, cr, table, base),
+                    cr, NULL, -1);
             }
 
-            if (!ptr.ptr) {
+            if (!ECS_GET_PTR_PTR(ptr)) {
                 ptr = flecs_get_base_component(world, table, component, cr, 
                     recur_depth + 1);
             }
         } else {
             if (cr->flags & EcsIdSparse) {
-                return (ecs_get_ptr_t){
-                    .ptr = flecs_component_sparse_get(world, cr, table, base),
-                    FLECS_LOCK_TARGET_INIT(cr, NULL, -1)
-                };
+                return ECS_GET_PTR(
+                    flecs_component_sparse_get(world, cr, table, base),
+                    cr, NULL, -1);
             } else {
                 int32_t row = ECS_RECORD_TO_ROW(r->row);
                 int16_t column = tr->column;
-                return (ecs_get_ptr_t){
-                    .ptr = flecs_table_get_component(table, column, row).ptr,
-                    FLECS_LOCK_TARGET_INIT(NULL, table, column)
-                };
+                return ECS_GET_PTR(
+                    flecs_table_get_component(table, column, row).ptr,
+                    NULL, table, column);
             }
         }
-    } while (!ptr.ptr && (i < end));
+    } while (!ECS_GET_PTR_PTR(ptr) && (i < end));
 
     return ptr;
 error:
-    return (ecs_get_ptr_t){0};
+    return ECS_GET_PTR_NULL;
 }
 
 ecs_entity_t flecs_new_id(
@@ -9377,22 +9391,19 @@ ecs_get_ptr_t flecs_record_get_id(
     if (component < FLECS_HI_COMPONENT_ID) {
         if (!world->non_trivial_lookup[component]) {
             ecs_get_low_id(table, r, component);
-            return (ecs_get_ptr_t){0};
+            return ECS_GET_PTR_NULL;
         }
     }
 
     ecs_component_record_t *cr = flecs_components_get(world, component);
     if (!cr) {
-        return (ecs_get_ptr_t){0};
+        return ECS_GET_PTR_NULL;
     }
 
     if (cr->flags & EcsIdDontFragment) {
         void *ptr = flecs_component_sparse_get(world, cr, table, entity);
         if (ptr) {
-            return (ecs_get_ptr_t){
-                .ptr = ptr,
-                FLECS_LOCK_TARGET_INIT(cr, NULL, -1)
-            };
+            return ECS_GET_PTR(ptr, cr, NULL, -1);
         }
     }
 
@@ -9401,10 +9412,9 @@ ecs_get_ptr_t flecs_record_get_id(
         return flecs_get_base_component(world, table, component, cr, 0);
     } else {
         if (cr->flags & EcsIdSparse) {
-            return (ecs_get_ptr_t){
-                .ptr = flecs_component_sparse_get(world, cr, table, entity),
-                FLECS_LOCK_TARGET_INIT(cr, NULL, -1)
-            };
+            return ECS_GET_PTR(
+                flecs_component_sparse_get(world, cr, table, entity),
+                cr, NULL, -1);
         }
         ecs_check(tr->column != -1, ECS_INVALID_PARAMETER,
             "component '%s' passed to get() is a tag/zero sized",
@@ -9413,12 +9423,11 @@ ecs_get_ptr_t flecs_record_get_id(
 
     int32_t row = ECS_RECORD_TO_ROW(r->row);
     int32_t column_index = tr->column;
-    return (ecs_get_ptr_t){
-        .ptr = flecs_table_get_component(table, column_index, row).ptr,
-        FLECS_LOCK_TARGET_INIT(NULL, table, column_index)
-    };
+    return ECS_GET_PTR(
+        flecs_table_get_component(table, column_index, row).ptr,
+        NULL, table, column_index);
 error:
-    return (ecs_get_ptr_t){0};
+    return ECS_GET_PTR_NULL;
 }
 
 const void* ecs_get_id(
@@ -9432,7 +9441,7 @@ const void* ecs_get_id(
 
     ecs_record_t *r = flecs_entities_get(world, entity);
 
-    return flecs_record_get_id(world, entity, r, component).ptr;
+    return ECS_GET_PTR_PTR(flecs_record_get_id(world, entity, r, component));
 error:
     return NULL;
 }
@@ -9473,21 +9482,23 @@ ecs_get_ptr_t flecs_record_get_mut_id(
     if (component < FLECS_HI_COMPONENT_ID) {
         if (!world->non_trivial_lookup[component]) {
             ecs_get_low_id(r->table, r, component);
-            return (ecs_get_ptr_t){0};
+            return ECS_GET_PTR_NULL;
         }
     }
 
     ecs_component_record_t *cr = flecs_components_get(world, component);
     int32_t row = ECS_RECORD_TO_ROW(r->row);
     flecs_component_ptr_t component_ptr = flecs_get_component_ptr(world, r->table, row, cr);
+#ifdef FLECS_MUT_ALIAS_LOCKS
     return (ecs_get_ptr_t) {
-        .ptr = component_ptr.ptr
-        #ifdef FLECS_MUT_ALIAS_LOCKS
-        , .lock_target = component_ptr.lock_target
-        #endif  
+        .ptr = component_ptr.ptr,
+        .lock_target = component_ptr.lock_target
     };
+#else
+    return (ecs_get_ptr_t)component_ptr.ptr;
+#endif
 error:
-    return (ecs_get_ptr_t){0};
+    return ECS_GET_PTR_NULL;
 }
 
 void* ecs_get_mut_id(
@@ -9503,7 +9514,7 @@ void* ecs_get_mut_id(
 
     ecs_record_t *r = flecs_entities_get(world, entity);
 
-    return flecs_record_get_mut_id(world, r, component).ptr;
+    return ECS_GET_PTR_PTR(flecs_record_get_mut_id(world, r, component));
 
 error:
     return NULL;
@@ -10099,8 +10110,8 @@ bool ecs_has_id(
             if (flecs_component_sparse_has(cr, entity)) {
                 return true;
             } else {
-                return flecs_get_base_component(
-                    world, table, component, cr, 0).ptr != NULL;
+                return ECS_GET_PTR_PTR(flecs_get_base_component(
+                    world, table, component, cr, 0)) != NULL;
             }
         }
 

distr/flecs.h

@@ -1270,7 +1270,9 @@ typedef struct ecs_record_t ecs_record_t;
 typedef struct ecs_component_record_t ecs_component_record_t;
 
 /** the void* returned from flecs_record_get_id fns which optionally returns origin of the ptr when FLECS_MUT_ALIAS_LOCKS is defined` */
+#ifdef FLECS_MUT_ALIAS_LOCKS
 typedef struct ecs_get_ptr_t ecs_get_ptr_t;
+#endif
 
 /** A poly object.
  * A poly (short for polymorph) object is an object that has a variable list of
@@ -4481,18 +4483,23 @@ typedef struct ecs_lock_target_t{
     ecs_table_t *table;
     int16_t column_index;
 } ecs_lock_target_t;
-#endif
 
 /* a wrapper around a void* which represents a component pointer. 
  * When FLECS_MUT_ALIAS_LOCKS is defined, then this also provides additional safety information about the pointer.
  */
 struct ecs_get_ptr_t{
     void *ptr;
-#ifdef FLECS_MUT_ALIAS_LOCKS
     ecs_lock_target_t lock_target;
-#endif
 };
 
+#else
+
+/* When FLECS_MUT_ALIAS_LOCKS is not defined, ecs_get_ptr_t is just a void* 
+ * for zero-overhead abstraction */
+typedef void* ecs_get_ptr_t;
+
+#endif
+
 
 
 /** Find record for entity. 

include/flecs.h

@@ -473,7 +473,9 @@ typedef struct ecs_record_t ecs_record_t;
 typedef struct ecs_component_record_t ecs_component_record_t;
 
 /** the void* returned from flecs_record_get_id fns which optionally returns origin of the ptr when FLECS_MUT_ALIAS_LOCKS is defined` */
+#ifdef FLECS_MUT_ALIAS_LOCKS
 typedef struct ecs_get_ptr_t ecs_get_ptr_t;
+#endif
 
 /** A poly object.
  * A poly (short for polymorph) object is an object that has a variable list of

include/flecs/private/api_internals.h

@@ -59,18 +59,23 @@ typedef struct ecs_lock_target_t{
     ecs_table_t *table;
     int16_t column_index;
 } ecs_lock_target_t;
-#endif
 
 /* a wrapper around a void* which represents a component pointer. 
  * When FLECS_MUT_ALIAS_LOCKS is defined, then this also provides additional safety information about the pointer.
  */
 struct ecs_get_ptr_t{
     void *ptr;
-#ifdef FLECS_MUT_ALIAS_LOCKS
     ecs_lock_target_t lock_target;
-#endif
 };
 
+#else
+
+/* When FLECS_MUT_ALIAS_LOCKS is not defined, ecs_get_ptr_t is just a void* 
+ * for zero-overhead abstraction */
+typedef void* ecs_get_ptr_t;
+
+#endif
+
 
 
 /** Find record for entity. 

src/commands.c

@@ -392,7 +392,7 @@ void* flecs_defer_ensure(
         void *base = NULL;
         if (table && (table->flags & EcsTableHasIsA)) {
             ecs_component_record_t *cr = flecs_components_get(world, id);
-            base = flecs_get_base_component(world, table, id, cr, 0).ptr;
+            base = ECS_GET_PTR_PTR(flecs_get_base_component(world, table, id, cr, 0));
         }
 
         if (!base) {