flecs_ecs 0.2.1

Rust API for the C/CPP flecs ECS library <https://github.com/SanderMertens/flecs>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

use crate::core::*;
use crate::sys;

pub(crate) fn rw_locking<T: GetTuple, Return, const MULTITHREADED: bool>(
    world: &WorldRef,
    callback: impl FnOnce(<T as GetTuple>::TupleType<'_>) -> Return,
    tuple_data: <T as GetTuple>::Pointers,
    tuple: <T as GetTuple>::TupleType<'_>,
) -> Return {
    let components = tuple_data.component_ptrs();
    let safety_info = tuple_data.safety_info();
    let world = world.real_world();
    let stage_id = if MULTITHREADED {
        world.stage_id()
    } else {
        0 // stage_id is not used in single-threaded mode
    };

    for (index, si) in safety_info.iter().enumerate() {
        use crate::core::SafetyInfo;

        if unsafe { components.get_unchecked(index).is_null() } {
            continue;
        }
        match si {
            SafetyInfo::Read(si) => {
                if !si.cr.is_null() {
                    use crate::core::sparse_id_record_lock_read_begin;

                    sparse_id_record_lock_read_begin::<MULTITHREADED>(&world, si.cr);
                } else {
                    use crate::core::get_table_column_lock_read_begin;

                    get_table_column_lock_read_begin::<MULTITHREADED>(
                        &world,
                        si.table,
                        si.column_index,
                        stage_id,
                    );
                }
            }
            SafetyInfo::Write(si) => {
                if !si.cr.is_null() {
                    sparse_id_record_lock_write_begin::<MULTITHREADED>(&world, si.cr);
                } else {
                    get_table_column_lock_write_begin::<MULTITHREADED>(
                        &world,
                        si.table,
                        si.column_index,
                        stage_id,
                    );
                }
            }
        }
    }

    world.defer_begin();
    let ret = callback(tuple);
    world.defer_end();

    for (index, si) in safety_info.iter().enumerate() {
        if unsafe { components.get_unchecked(index).is_null() } {
            continue;
        }
        match si {
            SafetyInfo::Read(si) => {
                if !si.cr.is_null() {
                    sparse_id_record_lock_read_end::<MULTITHREADED>(si.cr);
                } else {
                    table_column_lock_read_end::<MULTITHREADED>(
                        si.table,
                        si.column_index,
                        stage_id,
                    );
                }
            }
            SafetyInfo::Write(si) => {
                if !si.cr.is_null() {
                    sparse_id_record_lock_write_end::<MULTITHREADED>(si.cr);
                } else {
                    table_column_lock_write_end::<MULTITHREADED>(
                        si.table,
                        si.column_index,
                        stage_id,
                    );
                }
            }
        }
    }
    ret
}

#[cfg(feature = "flecs_safety_locks")]
#[inline(always)]
pub(crate) fn clone_locking<const MULTITHREADED: bool>(
    world: WorldRef<'_>,
    components: &[*mut core::ffi::c_void],
    safety_info: &[sys::ecs_lock_target_t],
) {
    let stage_id = if MULTITHREADED {
        world.stage_id()
    } else {
        0 // stage_id is not used in single-threaded mode
    };

    for (index, si) in safety_info.iter().enumerate() {
        // skip missing components
        if unsafe { components.get_unchecked(index).is_null() } {
            continue;
        }

        if !si.cr.is_null() {
            sparse_id_record_lock_read_begin::<MULTITHREADED>(&world, si.cr);
            sparse_id_record_lock_read_end::<MULTITHREADED>(si.cr);
            continue;
        }

        //check if no writes are present so we can clone
        get_table_column_lock_read_begin::<MULTITHREADED>(
            &world,
            si.table,
            si.column_index,
            stage_id,
        );
        table_column_lock_read_end::<MULTITHREADED>(si.table, si.column_index, stage_id);
    }
}