syren 0.6.0

A parallel Rust framework for agent-based models with ECS storage, scheduling, messaging, environments, and optional GPU execution.
Documentation 
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240

use std::hint::black_box;
use std::sync::{Arc, RwLock};

use criterion::{criterion_group, criterion_main, BatchSize, Criterion};
use syren::{
    advanced::EntityShards, Bundle, Command, ComponentRegistry, ECSManager, ECSResult, Entity,
};

const N: usize = 4096;

#[derive(Clone, Copy)]
struct CoreValue {
    _value: u32,
}

#[derive(Clone, Copy)]
struct AddedValue {
    _value: u32,
}

fn registry() -> (
    Arc<RwLock<ComponentRegistry>>,
    syren::ComponentID,
    syren::ComponentID,
) {
    let registry = Arc::new(RwLock::new(ComponentRegistry::new()));
    let ids = {
        let mut reg = registry.write().unwrap();
        let core = reg.register::<CoreValue>().unwrap();
        let added = reg.register::<AddedValue>().unwrap();
        reg.freeze();
        (core, added)
    };
    (registry, ids.0, ids.1)
}

fn world_with_core(
    registry: Arc<RwLock<ComponentRegistry>>,
    core_id: syren::ComponentID,
) -> ECSResult<(ECSManager, Vec<Entity>)> {
    let ecs = ECSManager::with_registry(EntityShards::new(4)?, registry);
    let world = ecs.world_ref();
    for i in 0..N {
        let mut bundle = Bundle::new();
        bundle.insert(core_id, CoreValue { _value: i as u32 });
        world.defer(Command::Spawn { bundle })?;
    }
    let events = ecs.apply_deferred_commands()?;
    Ok((
        ecs,
        events.spawned.iter().map(|event| event.entity).collect(),
    ))
}

fn structural_mutation_benchmarks(c: &mut Criterion) {
    let (registry, core_id, added_id) = registry();
    let mut group = c.benchmark_group("structural_mutation");

    group.bench_function("add_component_4096", |b| {
        let registry = Arc::clone(&registry);
        b.iter_batched(
            || world_with_core(Arc::clone(&registry), core_id).unwrap(),
            |(ecs, entities)| {
                let world = ecs.world_ref();
                for (i, entity) in entities.into_iter().enumerate() {
                    world
                        .defer(Command::Add {
                            entity,
                            component_id: added_id,
                            value: Box::new(AddedValue { _value: i as u32 }),
                        })
                        .unwrap();
                }
                ecs.apply_deferred_commands().unwrap();
                black_box(ecs);
            },
            BatchSize::SmallInput,
        );
    });

    group.bench_function("remove_component_4096", |b| {
        let registry = Arc::clone(&registry);
        b.iter_batched(
            || {
                let (ecs, entities) = world_with_core(Arc::clone(&registry), core_id).unwrap();
                let world = ecs.world_ref();
                for (i, entity) in entities.iter().copied().enumerate() {
                    world
                        .defer(Command::Add {
                            entity,
                            component_id: added_id,
                            value: Box::new(AddedValue { _value: i as u32 }),
                        })
                        .unwrap();
                }
                ecs.apply_deferred_commands().unwrap();
                (ecs, entities)
            },
            |(ecs, entities)| {
                let world = ecs.world_ref();
                for entity in entities {
                    world
                        .defer(Command::Remove {
                            entity,
                            component_id: added_id,
                        })
                        .unwrap();
                }
                ecs.apply_deferred_commands().unwrap();
                black_box(ecs);
            },
            BatchSize::SmallInput,
        );
    });

    group.bench_function("set_component_4096", |b| {
        let registry = Arc::clone(&registry);
        b.iter_batched(
            || world_with_core(Arc::clone(&registry), core_id).unwrap(),
            |(ecs, entities)| {
                let world = ecs.world_ref();
                for (i, entity) in entities.into_iter().enumerate() {
                    world
                        .defer(Command::Set {
                            entity,
                            component_id: core_id,
                            value: Box::new(CoreValue {
                                _value: (i as u32) + 1,
                            }),
                        })
                        .unwrap();
                }
                ecs.apply_deferred_commands().unwrap();
                black_box(ecs);
            },
            BatchSize::SmallInput,
        );
    });

    group.bench_function("despawn_4096", |b| {
        let registry = Arc::clone(&registry);
        b.iter_batched(
            || world_with_core(Arc::clone(&registry), core_id).unwrap(),
            |(ecs, entities)| {
                let world = ecs.world_ref();
                for entity in entities {
                    world.defer(Command::Despawn { entity }).unwrap();
                }
                ecs.apply_deferred_commands().unwrap();
                black_box(ecs);
            },
            BatchSize::SmallInput,
        );
    });

    // Columnar batch migration: one command, bitwise row moves, no boxing.
    group.bench_function("add_batch_4096", |b| {
        let registry = Arc::clone(&registry);
        b.iter_batched(
            || world_with_core(Arc::clone(&registry), core_id).unwrap(),
            |(ecs, entities)| {
                let world = ecs.world_ref();
                let n = entities.len();
                let values: Vec<AddedValue> =
                    (0..n).map(|i| AddedValue { _value: i as u32 }).collect();
                world
                    .defer(Command::AddComponentBatch {
                        entities,
                        component_id: added_id,
                        values: Box::new(values),
                        len: n,
                    })
                    .unwrap();
                ecs.apply_deferred_commands().unwrap();
                black_box(ecs);
            },
            BatchSize::SmallInput,
        );
    });

    group.bench_function("remove_batch_4096", |b| {
        let registry = Arc::clone(&registry);
        b.iter_batched(
            || {
                let (ecs, entities) = world_with_core(Arc::clone(&registry), core_id).unwrap();
                let world = ecs.world_ref();
                let n = entities.len();
                let values: Vec<AddedValue> =
                    (0..n).map(|i| AddedValue { _value: i as u32 }).collect();
                world
                    .defer(Command::AddComponentBatch {
                        entities: entities.clone(),
                        component_id: added_id,
                        values: Box::new(values),
                        len: n,
                    })
                    .unwrap();
                ecs.apply_deferred_commands().unwrap();
                (ecs, entities)
            },
            |(ecs, entities)| {
                let world = ecs.world_ref();
                world
                    .defer(Command::RemoveComponentBatch {
                        entities,
                        component_id: added_id,
                    })
                    .unwrap();
                ecs.apply_deferred_commands().unwrap();
                black_box(ecs);
            },
            BatchSize::SmallInput,
        );
    });

    // Batched despawn: one command, column locks taken once per archetype.
    group.bench_function("despawn_batch_4096", |b| {
        let registry = Arc::clone(&registry);
        b.iter_batched(
            || world_with_core(Arc::clone(&registry), core_id).unwrap(),
            |(ecs, entities)| {
                let world = ecs.world_ref();
                world
                    .defer(Command::DespawnBatchTagged {
                        entities,
                        template_id: syren::AgentTemplateId(0),
                    })
                    .unwrap();
                ecs.apply_deferred_commands().unwrap();
                black_box(ecs);
            },
            BatchSize::SmallInput,
        );
    });

    group.finish();
}

criterion_group!(benches, structural_mutation_benchmarks);
criterion_main!(benches);