#680 enforce that type_info is set before component is used

SanderMertens · Mar 19, 2022 · d2a170f · d2a170f
1 parent 280bc4e
commit d2a170f
Show file tree

Hide file tree

Showing 15 changed files with 313 additions and 257 deletions.
diff --git a/flecs.c b/flecs.c
diff --git a/flecs.h b/flecs.h
@@ -8103,6 +8103,7 @@ int ecs_log_last_error(void);
 #define ECS_INCONSISTENT_COMPONENT_ACTION (27)
 #define ECS_MODULE_UNDEFINED (28)
 #define ECS_MISSING_SYMBOL (29)
+#define ECS_ALREADY_IN_USE (30)
 
 #define ECS_COLUMN_ACCESS_VIOLATION (40)
 #define ECS_COLUMN_INDEX_OUT_OF_RANGE (41)

diff --git a/include/flecs/addons/log.h b/include/flecs/addons/log.h
@@ -455,6 +455,7 @@ int ecs_log_last_error(void);
 #define ECS_INCONSISTENT_COMPONENT_ACTION (27)
 #define ECS_MODULE_UNDEFINED (28)
 #define ECS_MISSING_SYMBOL (29)
+#define ECS_ALREADY_IN_USE (30)
 
 #define ECS_COLUMN_ACCESS_VIOLATION (40)
 #define ECS_COLUMN_INDEX_OUT_OF_RANGE (41)

diff --git a/src/addons/log.c b/src/addons/log.c
@@ -380,6 +380,7 @@ const char* ecs_strerror(
     ECS_ERR_STR(ECS_INVALID_CONVERSION);
     ECS_ERR_STR(ECS_MODULE_UNDEFINED);
     ECS_ERR_STR(ECS_MISSING_SYMBOL);
+    ECS_ERR_STR(ECS_ALREADY_IN_USE);
     ECS_ERR_STR(ECS_COLUMN_INDEX_OUT_OF_RANGE);
     ECS_ERR_STR(ECS_COLUMN_IS_NOT_SHARED);
     ECS_ERR_STR(ECS_COLUMN_IS_SHARED);

diff --git a/src/addons/meta/meta.c b/src/addons/meta/meta.c
@@ -938,17 +938,16 @@ void unit_quantity_monitor(ecs_iter_t *it) {
 static
 void ecs_meta_type_init_default_ctor(ecs_iter_t *it) {
     ecs_world_t *world = it->world;
+    EcsMetaType *type = ecs_term(it, EcsMetaType, 1);
 
     int i;
     for (i = 0; i < it->count; i ++) {
-        ecs_entity_t type = it->entities[i];
-
-        /* If component has no component actions (which is typical if a type is
-         * created with reflection data) make sure its values are always 
-         * initialized with zero. This prevents the injection of invalid data 
-         * through generic APIs after adding a component without setting it. */
-        if (!ecs_component_has_actions(world, type)) {
-            ecs_set_component_actions_w_id(world, type, 
+        /* If a component is defined from reflection data, configure it with the
+         * default constructor. This ensures that a new component value does not
+         * contain uninitialized memory, which could cause serializers to crash
+         * when for example inspecting string fields. */
+        if (!type->existing) {
+            ecs_set_component_actions_w_id(world, it->entities[i], 
                 &(EcsComponentLifecycle){ 
                     .ctor = ecs_default_ctor
                 });

diff --git a/src/addons/snapshot.c b/src/addons/snapshot.c
@@ -56,7 +56,7 @@ ecs_data_t* duplicate_data(
 
         component = ecs_get_typeid(world, component);
 
-        const ecs_type_info_t *ti = flecs_get_c_info(world, component);
+        const ecs_type_info_t *ti = flecs_get_type_info(world, component);
         int16_t size = column->size;
         int16_t alignment = column->alignment;
         ecs_copy_t copy;

diff --git a/src/bootstrap.c b/src/bootstrap.c
@@ -584,21 +584,16 @@ void flecs_bootstrap(
 
     ecs_set_name_prefix(world, "Ecs");
 
-    /* Create table for initial components */
-    ecs_table_t *table = bootstrap_component_table(world);
-    assert(table != NULL);
-
-    bootstrap_component(world, table, EcsIdentifier);
-    bootstrap_component(world, table, EcsComponent);
-    bootstrap_component(world, table, EcsComponentLifecycle);
-
-    bootstrap_component(world, table, EcsType);
-    bootstrap_component(world, table, EcsQuery);
-    bootstrap_component(world, table, EcsTrigger);
-    bootstrap_component(world, table, EcsObserver);
-    bootstrap_component(world, table, EcsIterable);
-
-    ecs_set_component_actions(world, EcsComponent, { .ctor = ecs_default_ctor });
+    /* Bootstrap type info (otherwise initialized by setting EcsComponent) */
+    flecs_init_type_info_t(world, EcsComponent);
+    flecs_init_type_info_t(world, EcsIdentifier);
+    flecs_init_type_info_t(world, EcsTrigger);
+    flecs_init_type_info_t(world, EcsObserver);
+
+    /* Setup component lifecycle actions */
+    ecs_set_component_actions(world, EcsComponent, { 
+        .ctor = ecs_default_ctor
+    });
 
     ecs_set_component_actions(world, EcsIdentifier, {
         .ctor = ecs_ctor(EcsIdentifier),
@@ -623,6 +618,20 @@ void flecs_bootstrap(
         .move = ecs_move(EcsObserver)
     });            
 
+    /* Create table for initial components */
+    ecs_table_t *table = bootstrap_component_table(world);
+    assert(table != NULL);
+
+    bootstrap_component(world, table, EcsIdentifier);
+    bootstrap_component(world, table, EcsComponent);
+    bootstrap_component(world, table, EcsComponentLifecycle);
+
+    bootstrap_component(world, table, EcsType);
+    bootstrap_component(world, table, EcsQuery);
+    bootstrap_component(world, table, EcsTrigger);
+    bootstrap_component(world, table, EcsObserver);
+    bootstrap_component(world, table, EcsIterable);
+
     world->stats.last_component_id = EcsFirstUserComponentId;
     world->stats.last_id = EcsFirstUserEntityId;
     world->stats.min_id = 0;

diff --git a/src/entity.c b/src/entity.c
@@ -188,7 +188,7 @@ const ecs_type_info_t *get_c_info(
 {
     ecs_entity_t real_id = ecs_get_typeid(world, component);
     if (real_id) {
-        return flecs_get_c_info(world, real_id);
+        return flecs_get_type_info(world, real_id);
     } else {
         return NULL;
     }
@@ -500,7 +500,7 @@ bool override_from_base(
         void *data_ptr = ECS_OFFSET(data_array, data_size * row);
 
         component = ecs_get_typeid(world, component);
-        const ecs_type_info_t *ti = flecs_get_c_info(world, component);
+        const ecs_type_info_t *ti = flecs_get_type_info(world, component);
         int32_t index;
 
         ecs_copy_t copy = ti ? ti->lifecycle.copy : NULL;
@@ -3988,7 +3988,7 @@ void free_value(
     int32_t count)
 {
     ecs_entity_t real_id = ecs_get_typeid(world, id);
-    const ecs_type_info_t *ti = flecs_get_c_info(world, real_id);
+    const ecs_type_info_t *ti = flecs_get_type_info(world, real_id);
     ecs_xtor_t dtor;
 
     if (ti && (dtor = ti->lifecycle.dtor)) {

diff --git a/src/private_api.h b/src/private_api.h
@@ -76,15 +76,24 @@ const ecs_stage_t* flecs_stage_from_readonly_world(
     const ecs_world_t *world);
 
 /* Get component callbacks */
-const ecs_type_info_t *flecs_get_c_info(
+const ecs_type_info_t *flecs_get_type_info(
     const ecs_world_t *world,
     ecs_entity_t component);
 
 /* Get or create component callbacks */
-ecs_type_info_t* flecs_get_or_create_c_info(
+ecs_type_info_t* flecs_ensure_type_info(
     ecs_world_t *world,
     ecs_entity_t component);
 
+void flecs_init_type_info(
+    ecs_world_t *world,
+    ecs_entity_t component,
+    ecs_size_t size,
+    ecs_size_t alignment);
+
+#define flecs_init_type_info_t(world, T)\
+    flecs_init_type_info(world, ecs_id(T), ECS_SIZEOF(T), ECS_ALIGNOF(T))
+
 void flecs_eval_component_monitors(
     ecs_world_t *world);
 
@@ -183,6 +192,10 @@ void flecs_clear_id_record(
     ecs_id_t id,
     ecs_id_record_t *idr);
 
+bool flecs_id_existst(
+    ecs_world_t *world,
+    ecs_id_t id);
+
 void flecs_remove_id_record(
     ecs_world_t *world,
     ecs_id_t id,

diff --git a/src/stage.c b/src/stage.c
@@ -327,7 +327,7 @@ bool flecs_defer_set(
         const ecs_type_info_t *ti = NULL;
         ecs_entity_t real_id = ecs_get_typeid(world, id);
         if (real_id) {
-            ti = flecs_get_c_info(world, real_id);
+            ti = flecs_get_type_info(world, real_id);
         }
 
         if (value) {

diff --git a/src/table.c b/src/table.c
@@ -406,7 +406,7 @@ void notify_component_info(
             }
             ecs_assert(c != 0, ECS_INTERNAL_ERROR, NULL);
 
-            const ecs_type_info_t *c_info = flecs_get_c_info(world, c);
+            const ecs_type_info_t *c_info = flecs_get_type_info(world, c);
             if (c_info) {
                 ecs_flags32_t flags = get_component_action_flags(c_info);
                 table->flags |= flags;