• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

celerity / celerity-runtime / 11954307236

21 Nov 2024 01:33PM UTC coverage: 94.802% (-0.2%) from 94.984%
11954307236

push

github

PeterTh
Incorporated additional review feedback, updated benchmark results with everything pinned

3114 of 3550 branches covered (87.72%)

Branch coverage included in aggregate %.

44 of 51 new or added lines in 3 files covered. (86.27%)

9 existing lines in 4 files now uncovered.

6898 of 7011 relevant lines covered (98.39%)

1262388.47 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.1
/src/live_executor.cc
1
#include "live_executor.h"
2
#include "affinity.h"
3
#include "backend/backend.h"
4
#include "closure_hydrator.h"
5
#include "communicator.h"
6
#include "grid.h"
7
#include "host_object.h"
8
#include "instruction_graph.h"
9
#include "named_threads.h"
10
#include "out_of_order_engine.h"
11
#include "receive_arbiter.h"
12
#include "system_info.h"
13
#include "tracy.h"
14
#include "types.h"
15
#include "utils.h"
16
#include "version.h"
17

18
#include <deque>
19
#include <memory>
20
#include <optional>
21
#include <string>
22
#include <unordered_map>
23
#include <vector>
24

25
#include <matchbox.hh>
26

27

28
namespace celerity::detail::live_executor_detail {
29

30
#if CELERITY_TRACY_SUPPORT
31

32
struct tracy_integration {
33
        struct instruction_info {
34
                instruction_id iid = -1;
35
                gch::small_vector<instruction_id> dependencies;
36
                int priority = -1;
37
                std::optional<size_t> bytes_processed;
38
                TracyCZoneCtx (*begin_zone)(const instruction_info& info, bool was_eagerly_submitted) = nullptr;
39
        };
40

41
        struct async_zone {
42
                size_t submission_idx_on_lane;
43
                instruction_info info;
44
                std::string trace;
45
        };
46

47
        /// References a position in an `async_lane_state::zone_queue` from within `executor_impl::async_instruction_state`
48
        struct async_lane_cursor {
49
                size_t global_lane_id = 0;
50
                size_t submission_idx_on_lane = 0;
51
        };
52

53
        /// Unique identifier for an `async_lane_state`.
54
        struct async_lane_id {
55
                out_of_order_engine::target target = out_of_order_engine::target::immediate;
56
                std::optional<device_id> device;
57
                size_t local_lane_id = 0;
58
        };
59

60
        /// State for an async (fiber) lane. Keeps the active (suspended) zone as well as the queue of eagerly submitted but not yet begun zones.
61
        struct async_lane_state {
62
                async_lane_id id;
63
                const char* fiber_name = nullptr;
64
                int32_t fiber_order = 0;
65
                size_t next_submission_idx = 0;
66
                std::optional<TracyCZoneCtx> active_zone_ctx;
67
                std::deque<async_zone> zone_queue; ///< front(): currently active zone, front() + 1: zone to start immediately after front() has ended
68

69
                explicit async_lane_state(const async_lane_id& id);
70
        };
71

72
        std::vector<async_lane_state> async_lanes; // vector instead of map, because elements need to be referenced to by global lane id
73

74
        std::string last_instruction_trace; ///< written by `CELERITY_DETAIL_TRACE_INSTRUCTION()`, read by `executor_impl::dispatch()`
75

76
        tracy_detail::plot<int64_t> assigned_instructions_plot{"assigned instructions"};
77
        tracy_detail::plot<int64_t> assignment_queue_length_plot{"assignment queue length"};
78

79
        static instruction_info make_instruction_info(const instruction& instr);
80

81
        /// Open a Tracy zone, setting tag, color - and name, if full tracing is enabled.
82
        static TracyCZoneCtx begin_instruction_zone(const instruction_info& info, bool was_eagerly_submitted);
83

84
        /// Close a Tracy zone - after emitting the instruction trace and generic instruction info if full tracing is enabled.
85
        static void end_instruction_zone(const TracyCZoneCtx& ctx, const instruction_info& info, const std::string& trace, const async_event* opt_event = nullptr);
86

87
        /// Picks the (optionally) pre-existing lane for an in-order queue submission, or an arbitrary free lane for async unordered send/receive instructions.
88
        async_lane_cursor get_async_lane_cursor(const out_of_order_engine::assignment& assignment);
89

90
        /// Adds an async instruction to its designated lane queue; beginning a Tracy zone immediately if it is the only instruction in the queue
91
        async_lane_cursor issue_async_instruction(instruction_info&& info, const out_of_order_engine::assignment& assignment, std::string&& trace);
92

93
        /// Closes the tracy zone for an active async instruction; beginning the next queued zone in the same lane, if any.
94
        void retire_async_instruction(const async_lane_cursor& cursor, const async_event& event);
95
};
96

97

98
tracy_integration::async_lane_state::async_lane_state(const async_lane_id& id) : id(id) {
99
        switch(id.target) {
100
        case out_of_order_engine::target::immediate: {
101
                fiber_name = tracy_detail::leak_name(fmt::format("cy-async-p2p #{}", id.local_lane_id));
102
                fiber_order = tracy_detail::thread_order::send_receive_first_lane + static_cast<int32_t>(id.local_lane_id);
103
                break;
104
        }
105
        case out_of_order_engine::target::alloc_queue:
106
                fiber_name = "cy-async-alloc";
107
                fiber_order = tracy_detail::thread_order::alloc_lane;
108
                break;
109
        case out_of_order_engine::target::host_queue:
110
                fiber_name = tracy_detail::leak_name(fmt::format("cy-async-host #{}", id.local_lane_id));
111
                fiber_order = tracy_detail::thread_order::host_first_lane + static_cast<int32_t>(id.local_lane_id);
112
                break;
113
        case out_of_order_engine::target::device_queue:
114
                fiber_name = tracy_detail::leak_name(fmt::format("cy-async-device D{} #{}", id.device.value(), id.local_lane_id));
115
                fiber_order = tracy_detail::thread_order::first_device_first_lane
116
                              + static_cast<int32_t>(id.device.value()) * tracy_detail::thread_order::num_lanes_per_device + static_cast<int32_t>(id.local_lane_id);
117
                break;
118
        default: utils::unreachable();
119
        }
120
}
121

122
tracy_integration::async_lane_cursor tracy_integration::get_async_lane_cursor(const out_of_order_engine::assignment& assignment) {
123
        const auto target = assignment.target;
124
        // on alloc_queue, assignment.device signals on which device to allocate memory, not on which device to queue the instruction
125
        const auto device = assignment.target == out_of_order_engine::target::device_queue ? assignment.device : std::nullopt;
126
        // out_of_order_engine does not assign a lane for alloc_queue, but there exists a single (in-order) one which we identify as `0`,
127
        // to continue using `nullopt` to pick an arbitrary empty lane in the code below for the immediate-but-async send / receive instruction types.
128
        const auto local_lane_id = assignment.target == out_of_order_engine::target::alloc_queue ? std::optional<size_t>(0) : assignment.lane;
129

130
        size_t next_local_lane_id = 0;
131
        auto lane_it = std::find_if(async_lanes.begin(), async_lanes.end(), [&](const async_lane_state& lane) {
132
                if(lane.id.target != target || lane.id.device != device) return false;
133
                ++next_local_lane_id; // if lambda never returns true, this will identify an unused local lane id for insertion below
134
                return local_lane_id.has_value() ? lane.id.local_lane_id == *local_lane_id /* exact match */ : lane.zone_queue.empty() /* arbitrary empty lane */;
135
        });
136
        if(lane_it == async_lanes.end()) {
137
                lane_it = async_lanes.emplace(async_lanes.end(), async_lane_id{target, device, local_lane_id.value_or(next_local_lane_id)});
138
        }
139
        const auto global_lane_id = static_cast<size_t>(lane_it - async_lanes.begin());
140
        return async_lane_cursor{global_lane_id, lane_it->next_submission_idx++};
141
}
142

143
tracy_integration::instruction_info tracy_integration::make_instruction_info(const instruction& instr) {
144
        tracy_integration::instruction_info info;
145
        info.iid = instr.get_id();
146

147
        // Tracy stages zone tag and color in a static local, so we can't move TracyCZoneNC out of match statement
148
#define CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(INSTR, COLOR)                                                                                                   \
149
        [&](const INSTR##_instruction& /* instr */) {                                                                                                              \
150
                return [](const instruction_info& info, bool was_eagerly_submitted) {                                                                                  \
151
                        TracyCZoneNC(ctx, "executor::" #INSTR, tracy::Color::COLOR, true /* active */);                                                                    \
152
                        if(tracy_detail::is_enabled_full()) {                                                                                                              \
153
                                const auto name = fmt::format("{}I{} " #INSTR, was_eagerly_submitted ? "+" : "", info.iid);                                                    \
154
                                TracyCZoneName(ctx, name.data(), name.size());                                                                                                 \
155
                        }                                                                                                                                                  \
156
                        return ctx;                                                                                                                                        \
157
                };                                                                                                                                                     \
158
        }
159

160
        info.begin_zone = matchbox::match(instr,                                   //
161
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(clone_collective_group, Brown), //
162
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(alloc, Turquoise),              //
163
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(free, Turquoise),               //
164
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(copy, Lime),                    //
165
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(device_kernel, Orange),         //
166
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(host_task, Orange),             //
167
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(send, Violet),                  //
168
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(receive, DarkViolet),           //
169
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(split_receive, DarkViolet),     //
170
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(await_receive, DarkViolet),     //
171
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(gather_receive, DarkViolet),    //
172
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(fill_identity, Blue),           //
173
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(reduce, Blue),                  //
174
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(fence, Blue),                   //
175
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(destroy_host_object, Gray),     //
176
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(horizon, Gray),                 //
177
            CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE(epoch, Gray));
178

179
#undef CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE
180

181
        CELERITY_DETAIL_IF_TRACY_ENABLED_FULL({
182
                info.dependencies = instr.get_dependencies();
183
                info.priority = instr.get_priority();
184
                info.bytes_processed = matchbox::match<std::optional<size_t>>(
185
                    instr,                                                                                                          //
186
                    [](const alloc_instruction& ainstr) { return ainstr.get_size_bytes(); },                                        //
187
                    [](const copy_instruction& cinstr) { return cinstr.get_copy_region().get_area() * cinstr.get_element_size(); }, //
188
                    [](const send_instruction& sinstr) { return sinstr.get_send_range().size() * sinstr.get_element_size(); },      //
189
                    [](const device_kernel_instruction& dkinstr) { return dkinstr.get_estimated_global_memory_traffic_bytes(); },   //
190
                    [](const auto& /* other */) { return std::nullopt; });
191
        })
192

193
        return info;
194
}
195

196
TracyCZoneCtx tracy_integration::begin_instruction_zone(const instruction_info& info, bool was_eagerly_submitted) {
197
        assert(info.begin_zone != nullptr);
198
        return info.begin_zone(info, was_eagerly_submitted);
199
}
200

201
void tracy_integration::end_instruction_zone(const TracyCZoneCtx& ctx, const instruction_info& info, const std::string& trace, const async_event* opt_event) {
202
        if(tracy_detail::is_enabled_full()) {
203
                std::string text;
204
                text.reserve(512); // Observation: typical size for kernel instructions is 200 - 300 characters
205

206
                // Dump the trace collected from CELERITY_DETAIL_TRACE_INSTRUCTION, replacing /; */ with '\n' for better legibility
207
                for(size_t trace_line_start = 0; trace_line_start < trace.size();) {
208
                        const auto trace_line_end = trace.find(';', trace_line_start);
209
                        text.append(trace, trace_line_start, trace_line_end - trace_line_start);
210
                        if(trace_line_end == std::string::npos) break;
211
                        text.push_back('\n');
212
                        trace_line_start = trace.find_first_not_of(' ', trace_line_end + 1);
213
                }
214

215
                // Dump time and throughput measures if available. We pass an `async_event*` instead of a `optional<duration>` to this function because querying
216
                // execution time of SYCL events is comparatively costly (~1µs) and can be skipped when CELERITY_TRACE=fast.
217
                if(opt_event != nullptr) {
218
                        if(const auto native_execution_time = opt_event->get_native_execution_time(); native_execution_time.has_value()) {
219
                                fmt::format_to(std::back_inserter(text), "\nnative execution time: {:.2f}", as_sub_second(*native_execution_time));
220
                                if(info.bytes_processed.has_value()) {
221
                                        fmt::format_to(std::back_inserter(text), "\nthroughput: {:.2f}", as_decimal_throughput(*info.bytes_processed, *native_execution_time));
222
                                }
223
                        }
224
                }
225

226
                for(size_t i = 0; i < info.dependencies.size(); ++i) {
227
                        text += i == 0 ? "\ndepends: " : ", ";
228
                        fmt::format_to(std::back_inserter(text), "I{}", info.dependencies[i]);
229
                }
230
                fmt::format_to(std::back_inserter(text), "\npriority: {}", info.priority);
231

232
                TracyCZoneText(ctx, text.data(), text.size());
233
        }
234

235
        TracyCZoneEnd(ctx);
236
}
237

238
tracy_integration::async_lane_cursor tracy_integration::issue_async_instruction(
239
    instruction_info&& info, const out_of_order_engine::assignment& assignment, std::string&& trace) //
240
{
241
        const auto cursor = get_async_lane_cursor(assignment);
242

243
        auto& lane = async_lanes[cursor.global_lane_id];
244
        lane.zone_queue.push_back({cursor.submission_idx_on_lane, std::move(info), std::move(trace)});
245
        auto& info_enqueued = lane.zone_queue.back().info;
246

247
        if(lane.zone_queue.size() == 1) {
248
                // zone_queue.back() == zone_queue.front(): The instruction starts immediately
249
                assert(!lane.active_zone_ctx.has_value());
250
                TracyFiberEnterHint(lane.fiber_name, lane.fiber_order);
251
                lane.active_zone_ctx = begin_instruction_zone(info_enqueued, false /* eager */);
252
                TracyFiberLeave;
253
        } else if(tracy_detail::is_enabled_full()) {
254
                // The instruction zone will be started as soon as its predecessor is retired - indicate when it was issued
255
                const auto mark = fmt::format("I{} issued", info_enqueued.iid);
256
                TracyFiberEnterHint(lane.fiber_name, lane.fiber_order);
257
                TracyMessageC(mark.data(), mark.size(), tracy::Color::DarkGray);
258
                TracyFiberLeave;
259
        }
260

261
        return cursor;
262
}
263

264
void tracy_integration::retire_async_instruction(const async_lane_cursor& cursor, const async_event& event) {
265
        auto& lane = async_lanes.at(cursor.global_lane_id);
266

267
        TracyFiberEnterHint(lane.fiber_name, lane.fiber_order);
268
        while(!lane.zone_queue.empty() && lane.zone_queue.front().submission_idx_on_lane <= cursor.submission_idx_on_lane) {
269
                // Complete the front() == active zone in the lane.
270
                {
271
                        auto& completed_zone = lane.zone_queue.front();
272
                        assert(lane.active_zone_ctx.has_value());
273
                        end_instruction_zone(*lane.active_zone_ctx, completed_zone.info, completed_zone.trace, &event);
274
                        lane.active_zone_ctx.reset();
275
                        lane.zone_queue.pop_front();
276
                }
277
                // If there remains another (eagerly issued) instruction in the queue after popping the active one, show it as having started immediately.
278
                if(!lane.zone_queue.empty()) {
279
                        auto& eagerly_following_zone = lane.zone_queue.front();
280
                        assert(!lane.active_zone_ctx.has_value());
281
                        lane.active_zone_ctx = begin_instruction_zone(eagerly_following_zone.info, true /* eager */);
282
                }
283
        }
284
        TracyFiberLeave;
285
}
286

287
#endif // CELERITY_DETAIL_ENABLE_TRACY
288

289

290
#if CELERITY_ACCESSOR_BOUNDARY_CHECK
291

292
struct boundary_check_info {
293
        struct accessor_info {
294
                detail::buffer_id buffer_id = 0;
295
                std::string buffer_name;
296
                box<3> accessible_box;
297
        };
298

299
        detail::task_type task_type;
300
        detail::task_id task_id;
301
        std::string task_name;
302

303
        oob_bounding_box* illegal_access_bounding_boxes = nullptr;
304
        std::vector<accessor_info> accessors;
305

306
        boundary_check_info(detail::task_type tt, detail::task_id tid, const std::string& task_name) : task_type(tt), task_id(tid), task_name(task_name) {}
1,934✔
307
};
308

309
#endif // CELERITY_ACCESSOR_BOUNDARY_CHECK
310

311

312
#define CELERITY_DETAIL_TRACE_INSTRUCTION(INSTR, FMT_STRING, ...)                                                                                              \
313
        CELERITY_TRACE("[executor] I{}: " FMT_STRING, INSTR.get_id(), ##__VA_ARGS__);                                                                              \
314
        CELERITY_DETAIL_IF_TRACY_ENABLED_FULL(tracy->last_instruction_trace = fmt::format(FMT_STRING, ##__VA_ARGS__))
315

316

317
struct async_instruction_state {
318
        allocation_id alloc_aid = null_allocation_id; ///< non-null iff instruction is an alloc_instruction
319
        async_event event;
320
        CELERITY_DETAIL_IF_ACCESSOR_BOUNDARY_CHECK(std::unique_ptr<boundary_check_info> oob_info;) // unique_ptr: oob_info is optional and rather large
321
        CELERITY_DETAIL_IF_TRACY_SUPPORTED(std::optional<tracy_integration::async_lane_cursor> tracy_lane_cursor;)
322
};
323

324
struct executor_impl {
325
        const std::unique_ptr<detail::backend> backend;
326
        communicator* const root_communicator;
327
        double_buffered_queue<submission>* const submission_queue;
328
        executor::delegate* const delegate;
329
        const live_executor::policy_set policy;
330

331
        receive_arbiter recv_arbiter{*root_communicator};
332
        out_of_order_engine engine{backend->get_system_info()};
333

334
        bool expecting_more_submissions = true; ///< shutdown epoch has not been executed yet
335
        std::unordered_map<instruction_id, async_instruction_state> in_flight_async_instructions;
336
        std::unordered_map<allocation_id, void*> allocations{{null_allocation_id, nullptr}}; ///< obtained from alloc_instruction or track_user_allocation
337
        std::unordered_map<host_object_id, std::unique_ptr<host_object_instance>> host_object_instances; ///< passed in through track_host_object_instance
338
        std::unordered_map<collective_group_id, std::unique_ptr<communicator>> cloned_communicators;     ///< transitive clones of root_communicator
339
        std::unordered_map<reduction_id, std::unique_ptr<reducer>> reducers; ///< passed in through track_reducer, erased on epochs / horizons
340

341
        std::optional<std::chrono::steady_clock::time_point> last_progress_timestamp; ///< last successful call to check_progress
342
        bool made_progress = false;                                                   ///< progress was made since `last_progress_timestamp`
343
        bool progress_warning_emitted = false;                                        ///< no progress was made since warning was emitted
344

345
        CELERITY_DETAIL_IF_TRACY_SUPPORTED(std::unique_ptr<tracy_integration> tracy;)
346

347
        executor_impl(std::unique_ptr<detail::backend> backend, communicator* root_comm, double_buffered_queue<submission>& submission_queue,
348
            executor::delegate* dlg, const live_executor::policy_set& policy);
349

350
        void run();
351
        void poll_in_flight_async_instructions();
352
        void poll_submission_queue();
353
        void try_issue_one_instruction();
354
        void retire_async_instruction(instruction_id iid, async_instruction_state& async);
355
        void check_progress();
356

357
        // Instruction types that complete synchronously within the executor.
358
        void issue(const clone_collective_group_instruction& ccginstr);
359
        void issue(const split_receive_instruction& srinstr);
360
        void issue(const fill_identity_instruction& fiinstr);
361
        void issue(const reduce_instruction& rinstr);
362
        void issue(const fence_instruction& finstr);
363
        void issue(const destroy_host_object_instruction& dhoinstr);
364
        void issue(const horizon_instruction& hinstr);
365
        void issue(const epoch_instruction& einstr);
366

367
        template <typename Instr>
368
        auto dispatch(const Instr& instr, const out_of_order_engine::assignment& assignment)
369
            // SFINAE: there is a (synchronous) `issue` overload above for the concrete Instr type
370
            -> decltype(issue(instr));
371

372
        // Instruction types that complete asynchronously via async_event, outside the executor.
373
        void issue_async(const alloc_instruction& ainstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async);
374
        void issue_async(const free_instruction& finstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async);
375
        void issue_async(const copy_instruction& cinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async);
376
        void issue_async(const device_kernel_instruction& dkinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async);
377
        void issue_async(const host_task_instruction& htinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async);
378
        void issue_async(const send_instruction& sinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async);
379
        void issue_async(const receive_instruction& rinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async);
380
        void issue_async(const await_receive_instruction& arinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async);
381
        void issue_async(const gather_receive_instruction& grinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async);
382

383
        template <typename Instr>
384
        auto dispatch(const Instr& instr, const out_of_order_engine::assignment& assignment)
385
            // SFINAE: there is an `issue_async` overload above for the concrete Instr type
386
            -> decltype(issue_async(instr, assignment, std::declval<async_instruction_state&>()));
387

388
        std::vector<closure_hydrator::accessor_info> make_accessor_infos(const buffer_access_allocation_map& amap) const;
389

390
#if CELERITY_ACCESSOR_BOUNDARY_CHECK
391
        std::unique_ptr<boundary_check_info> attach_boundary_check_info(std::vector<closure_hydrator::accessor_info>& accessor_infos,
392
            const buffer_access_allocation_map& amap, task_type tt, task_id tid, const std::string& task_name) const;
393
#endif
394

395
        void collect(const instruction_garbage& garbage);
396
};
397

398
executor_impl::executor_impl(std::unique_ptr<detail::backend> backend, communicator* const root_comm, double_buffered_queue<submission>& submission_queue,
236✔
399
    executor::delegate* const dlg, const live_executor::policy_set& policy)
236✔
400
    : backend(std::move(backend)), root_communicator(root_comm), submission_queue(&submission_queue), delegate(dlg), policy(policy) //
708✔
401
{
402
        CELERITY_DETAIL_IF_TRACY_ENABLED(tracy = std::make_unique<tracy_integration>();)
403
}
236✔
404

405
void executor_impl::run() {
236✔
406
        // this closure hydrator instantiation is not necessary in normal execution iff device submission threads are enabled,
407
        // but it is still required for testing purposes, so always making it available on this thread is the simplest solution
408
        closure_hydrator::make_available();
236✔
409
        backend->init();
236✔
410

411
        uint8_t check_overflow_counter = 0;
236✔
412
        for(;;) {
413
                if(engine.is_idle()) {
4,508,822✔
414
                        if(!expecting_more_submissions) break; // shutdown complete
2,388✔
415

416
                        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::starve", DarkSlateGray);
417
                        submission_queue->wait_while_empty(); // we are stalled on the scheduler, suspend thread
2,152✔
418
                        last_progress_timestamp.reset();      // do not treat suspension as being stuck
2,152✔
419
                }
420

421
                recv_arbiter.poll_communicator();
4,508,586✔
422
                poll_in_flight_async_instructions();
4,508,586✔
423
                poll_submission_queue();
4,508,586✔
424
                try_issue_one_instruction(); // potentially expensive, so only issue one per loop to continue checking for async completion in between
4,508,586✔
425

426
                if(++check_overflow_counter == 0) { // once every 256 iterations
4,508,586✔
427
                        backend->check_async_errors();
17,534✔
428
                        check_progress();
17,534✔
429
                }
430
        }
431

432
        assert(in_flight_async_instructions.empty());
236✔
433
        // check that for each alloc_instruction, we executed a corresponding free_instruction
434
        assert(std::all_of(allocations.begin(), allocations.end(),
472✔
435
            [](const std::pair<allocation_id, void*>& p) { return p.first == null_allocation_id || p.first.get_memory_id() == user_memory_id; }));
436
        // check that for each track_host_object_instance, we executed a destroy_host_object_instruction
437
        assert(host_object_instances.empty());
236✔
438

439
        closure_hydrator::teardown();
236✔
440
}
236✔
441

442
void executor_impl::poll_in_flight_async_instructions() {
4,508,586✔
443
        // collect completed instruction ids up-front, since retire_async_instruction would alter the execution front
444
        std::vector<instruction_id> completed_now; // std::vector because it will be empty in the common case
4,508,586✔
445
        for(const auto iid : engine.get_execution_front()) {
11,474,078✔
446
                if(in_flight_async_instructions.at(iid).event.is_complete()) { completed_now.push_back(iid); }
6,965,492✔
447
        }
448
        for(const auto iid : completed_now) {
4,516,252✔
449
                retire_async_instruction(iid, in_flight_async_instructions.at(iid));
7,666✔
450
                in_flight_async_instructions.erase(iid);
7,666✔
451
                made_progress = true;
7,666✔
452
        }
453

454
        CELERITY_DETAIL_IF_TRACY_ENABLED(tracy->assigned_instructions_plot.update(in_flight_async_instructions.size()));
455
}
9,017,172✔
456

457
void executor_impl::poll_submission_queue() {
4,508,586✔
458
        for(auto& submission : submission_queue->pop_all()) {
4,512,731✔
459
                CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::fetch", Gray);
460
                matchbox::match(
4,145✔
461
                    submission,
462
                    [&](const instruction_pilot_batch& batch) {
4,145✔
463
                            for(const auto incoming_instr : batch.instructions) {
13,204✔
464
                                    engine.submit(incoming_instr);
9,266✔
465
                            }
466
                            for(const auto& pilot : batch.pilots) {
4,600✔
467
                                    root_communicator->send_outbound_pilot(pilot);
662✔
468
                            }
469
                            CELERITY_DETAIL_IF_TRACY_ENABLED(tracy->assignment_queue_length_plot.update(engine.get_assignment_queue_length()));
470
                    },
3,938✔
471
                    [&](const user_allocation_transfer& uat) {
8,290✔
472
                            assert(uat.aid != null_allocation_id);
109✔
473
                            assert(uat.aid.get_memory_id() == user_memory_id);
109✔
474
                            assert(allocations.count(uat.aid) == 0);
109✔
475
                            allocations.emplace(uat.aid, uat.ptr);
109✔
476
                    },
109✔
477
                    [&](host_object_transfer& hot) {
8,290✔
478
                            assert(host_object_instances.count(hot.hoid) == 0);
30✔
479
                            host_object_instances.emplace(hot.hoid, std::move(hot.instance));
30✔
480
                    },
30✔
481
                    [&](reducer_transfer& rt) {
8,290✔
482
                            assert(reducers.count(rt.rid) == 0);
68✔
483
                            reducers.emplace(rt.rid, std::move(rt.reduction));
68✔
484
                    });
68✔
485
        }
486
}
4,508,586✔
487

488
void executor_impl::retire_async_instruction(const instruction_id iid, async_instruction_state& async) {
7,666✔
489
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::retire", Brown);
490

491
#if CELERITY_ACCESSOR_BOUNDARY_CHECK
492
        if(async.oob_info != nullptr) {
7,666✔
493
                CELERITY_DETAIL_TRACY_ZONE_SCOPED_V("executor::oob_check", Red, "I{} bounds check", iid);
494
                const auto& oob_info = *async.oob_info;
1,934✔
495
                for(size_t i = 0; i < oob_info.accessors.size(); ++i) {
4,478✔
496
                        if(const auto oob_box = oob_info.illegal_access_bounding_boxes[i].into_box(); !oob_box.empty()) {
2,544✔
497
                                const auto& accessor_info = oob_info.accessors[i];
12✔
498
                                CELERITY_ERROR("Out-of-bounds access detected in {}: accessor {} attempted to access buffer {} indicies between {} and outside the "
12✔
499
                                               "declared range {}.",
500
                                    utils::make_task_debug_label(oob_info.task_type, oob_info.task_id, oob_info.task_name), i,
501
                                    utils::make_buffer_debug_label(accessor_info.buffer_id, accessor_info.buffer_name), oob_box, accessor_info.accessible_box);
502
                        }
503
                }
504
                if(oob_info.illegal_access_bounding_boxes != nullptr /* i.e. there was at least one accessor */) {
1,934!
505
                        backend->debug_free(oob_info.illegal_access_bounding_boxes);
1,934✔
506
                }
507
        }
508
#endif
509

510
        if(spdlog::should_log(spdlog::level::trace)) {
7,666✔
511
                if(const auto native_time = async.event.get_native_execution_time(); native_time.has_value()) {
3,665!
UNCOV
512
                        CELERITY_TRACE("[executor] retired I{} after {:.2f}", iid, as_sub_second(*native_time));
×
513
                } else {
514
                        CELERITY_TRACE("[executor] retired I{}", iid);
3,665!
515
                }
516
        }
517

518
        CELERITY_DETAIL_IF_TRACY_ENABLED(tracy->retire_async_instruction(*async.tracy_lane_cursor, async.event));
519

520
        if(async.alloc_aid != null_allocation_id) {
7,666✔
521
                const auto ptr = async.event.get_result();
1,103✔
522
                assert(ptr != nullptr && "backend allocation returned nullptr");
1,103✔
523
                CELERITY_TRACE("[executor] {} allocated as {}", async.alloc_aid, ptr);
1,103!
524
                assert(allocations.count(async.alloc_aid) == 0);
1,103✔
525
                allocations.emplace(async.alloc_aid, ptr);
1,103✔
526
        }
527

528
        engine.complete_assigned(iid);
7,666✔
529

530
        CELERITY_DETAIL_IF_TRACY_ENABLED(tracy->assignment_queue_length_plot.update(engine.get_assignment_queue_length()));
531
}
7,666✔
532

533
template <typename Instr>
534
auto executor_impl::dispatch(const Instr& instr, const out_of_order_engine::assignment& assignment)
1,600✔
535
    // SFINAE: there is a (synchronous) `issue` overload above for the concrete Instr type
536
    -> decltype(issue(instr)) //
537
{
538
        assert(assignment.target == out_of_order_engine::target::immediate);
1,600✔
539
        assert(!assignment.lane.has_value());
1,600✔
540

541
        const auto iid = instr.get_id(); // instr may dangle after issue()
1,600✔
542

543
        CELERITY_DETAIL_IF_TRACY_SUPPORTED(TracyCZoneCtx ctx;)
544
        CELERITY_DETAIL_IF_TRACY_SUPPORTED(tracy_integration::instruction_info info);
545
        CELERITY_DETAIL_IF_TRACY_ENABLED({
546
                info = tracy_integration::make_instruction_info(instr);
547
                TracyFiberEnterHint("cy-immediate", tracy_detail::thread_order::immediate_lane);
548
                ctx = tracy->begin_instruction_zone(info, false /* eager */);
549
                tracy->assigned_instructions_plot.update(in_flight_async_instructions.size() + 1);
550
        })
551

552
        issue(instr); // completes immediately - instr may now dangle
1,600✔
553

554
        CELERITY_DETAIL_IF_TRACY_ENABLED({
555
                tracy->end_instruction_zone(ctx, info, tracy->last_instruction_trace);
556
                TracyFiberLeave;
557
        })
558

559
        engine.complete_assigned(iid);
1,600✔
560

561
        CELERITY_DETAIL_IF_TRACY_ENABLED({
562
                tracy->assigned_instructions_plot.update(in_flight_async_instructions.size());
563
                tracy->assignment_queue_length_plot.update(engine.get_assignment_queue_length());
564
        })
565
}
1,600✔
566

567
template <typename Instr>
568
auto executor_impl::dispatch(const Instr& instr, const out_of_order_engine::assignment& assignment)
7,666✔
569
    // SFINAE: there is an `issue_async` overload above for the concrete Instr type
570
    -> decltype(issue_async(instr, assignment, std::declval<async_instruction_state&>())) //
571
{
572
        CELERITY_DETAIL_IF_TRACY_SUPPORTED(tracy_integration::instruction_info info);
573
        CELERITY_DETAIL_IF_TRACY_ENABLED(info = tracy_integration::make_instruction_info(instr));
574

575
        auto& async = in_flight_async_instructions.emplace(assignment.instruction->get_id(), async_instruction_state{}).first->second;
15,332✔
576
        issue_async(instr, assignment, async); // stores event in `async` and completes asynchronously
7,666✔
577
        // instr may now dangle
578

579
        CELERITY_DETAIL_IF_TRACY_ENABLED({
580
                async.tracy_lane_cursor = tracy->issue_async_instruction(std::move(info), assignment, std::move(tracy->last_instruction_trace));
581
                tracy->assigned_instructions_plot.update(in_flight_async_instructions.size());
582
        })
583
}
15,332✔
584

585
void executor_impl::try_issue_one_instruction() {
4,508,586✔
586
        auto assignment = engine.assign_one();
4,508,586✔
587
        if(!assignment.has_value()) return;
4,508,586✔
588

589
        CELERITY_DETAIL_IF_TRACY_ENABLED(tracy->assignment_queue_length_plot.update(engine.get_assignment_queue_length()));
590

591
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::issue", Blue);
592
        matchbox::match(*assignment->instruction, [&](const auto& instr) { dispatch(instr, *assignment); });
18,532✔
593
        made_progress = true;
9,266✔
594
}
595

596
void executor_impl::check_progress() {
17,534✔
597
        if(!policy.progress_warning_timeout.has_value()) return;
17,534!
598

599
        if(made_progress) {
17,534✔
600
                last_progress_timestamp = std::chrono::steady_clock::now();
303✔
601
                progress_warning_emitted = false;
303✔
602
                made_progress = false;
303✔
603
        } else if(last_progress_timestamp.has_value()) {
17,231!
604
                // being stuck either means a deadlock in the user application, or a bug in Celerity.
605
                const auto elapsed_since_last_progress = std::chrono::steady_clock::now() - *last_progress_timestamp;
17,231✔
606
                if(elapsed_since_last_progress > *policy.progress_warning_timeout && !progress_warning_emitted) {
17,231✔
607
                        std::string instr_list;
1✔
608
                        for(auto& [iid, async] : in_flight_async_instructions) {
2✔
609
                                if(!instr_list.empty()) instr_list += ", ";
1!
610
                                fmt::format_to(std::back_inserter(instr_list), "I{}", iid);
1✔
611
                        }
612
                        CELERITY_WARN("[executor] no progress for {:.0f}, might be stuck. Active instructions: {}", as_sub_second(elapsed_since_last_progress),
1✔
613
                            in_flight_async_instructions.empty() ? "none" : instr_list);
614
                        progress_warning_emitted = true;
1✔
615
                }
1✔
616
        }
617
}
618

619
void executor_impl::issue(const clone_collective_group_instruction& ccginstr) {
33✔
620
        const auto original_cgid = ccginstr.get_original_collective_group_id();
33✔
621
        assert(original_cgid != non_collective_group_id);
33✔
622
        assert(original_cgid == root_collective_group_id || cloned_communicators.count(original_cgid) != 0);
33✔
623

624
        const auto new_cgid = ccginstr.get_new_collective_group_id();
33✔
625
        assert(new_cgid != non_collective_group_id && new_cgid != root_collective_group_id);
33✔
626
        assert(cloned_communicators.count(new_cgid) == 0);
33✔
627

628
        CELERITY_DETAIL_TRACE_INSTRUCTION(ccginstr, "clone collective group CG{} -> CG{}", original_cgid, new_cgid);
33✔
629

630
        const auto original_communicator = original_cgid == root_collective_group_id ? root_communicator : cloned_communicators.at(original_cgid).get();
33✔
631
        cloned_communicators.emplace(new_cgid, original_communicator->collective_clone());
33✔
632
}
33✔
633

634

635
void executor_impl::issue(const split_receive_instruction& srinstr) {
20✔
636
        CELERITY_DETAIL_TRACE_INSTRUCTION(srinstr, "split receive {} {}x{} bytes into {} ({}),", srinstr.get_transfer_id(), srinstr.get_requested_region(),
20✔
637
            srinstr.get_element_size(), srinstr.get_dest_allocation_id(), srinstr.get_allocated_box());
638

639
        const auto allocation = allocations.at(srinstr.get_dest_allocation_id());
20✔
640
        recv_arbiter.begin_split_receive(
20✔
641
            srinstr.get_transfer_id(), srinstr.get_requested_region(), allocation, srinstr.get_allocated_box(), srinstr.get_element_size());
642
}
20✔
643

644
void executor_impl::issue(const fill_identity_instruction& fiinstr) {
19✔
645
        CELERITY_DETAIL_TRACE_INSTRUCTION(
19✔
646
            fiinstr, "fill identity {} x{} values for R{}", fiinstr.get_allocation_id(), fiinstr.get_num_values(), fiinstr.get_reduction_id());
647

648
        const auto allocation = allocations.at(fiinstr.get_allocation_id());
19✔
649
        const auto& reduction = *reducers.at(fiinstr.get_reduction_id());
19✔
650
        reduction.fill_identity(allocation, fiinstr.get_num_values());
19✔
651
}
19✔
652

653
void executor_impl::issue(const reduce_instruction& rinstr) {
47✔
654
        CELERITY_DETAIL_TRACE_INSTRUCTION(rinstr, "reduce {} x{} values into {} for R{}", rinstr.get_source_allocation_id(), rinstr.get_num_source_values(),
47✔
655
            rinstr.get_dest_allocation_id(), rinstr.get_reduction_id());
656

657
        const auto gather_allocation = allocations.at(rinstr.get_source_allocation_id());
47✔
658
        const auto dest_allocation = allocations.at(rinstr.get_dest_allocation_id());
47✔
659
        const auto& reduction = *reducers.at(rinstr.get_reduction_id());
47✔
660
        reduction.reduce(dest_allocation, gather_allocation, rinstr.get_num_source_values());
47✔
661
}
47✔
662

663
void executor_impl::issue(const fence_instruction& finstr) { // NOLINT(readability-make-member-function-const, readability-convert-member-functions-to-static)
63✔
664
        CELERITY_DETAIL_TRACE_INSTRUCTION(finstr, "fence");
63✔
665

666
        finstr.get_promise()->fulfill();
63✔
667
}
63✔
668

669
void executor_impl::issue(const destroy_host_object_instruction& dhoinstr) {
30✔
670
        assert(host_object_instances.count(dhoinstr.get_host_object_id()) != 0);
30✔
671
        CELERITY_DETAIL_TRACE_INSTRUCTION(dhoinstr, "destroy H{}", dhoinstr.get_host_object_id());
30✔
672

673
        host_object_instances.erase(dhoinstr.get_host_object_id());
30✔
674
}
30✔
675

676
void executor_impl::issue(const horizon_instruction& hinstr) {
582✔
677
        CELERITY_DETAIL_TRACE_INSTRUCTION(hinstr, "horizon");
582✔
678

679
        if(delegate != nullptr) { delegate->horizon_reached(hinstr.get_horizon_task_id()); }
582!
680
        collect(hinstr.get_garbage());
582✔
681

682
        CELERITY_DETAIL_IF_TRACY_ENABLED(FrameMarkNamed("Horizon"));
683
}
582✔
684

685
void executor_impl::issue(const epoch_instruction& einstr) {
806✔
686
        switch(einstr.get_epoch_action()) {
806!
687
        case epoch_action::none: //
332✔
688
                CELERITY_DETAIL_TRACE_INSTRUCTION(einstr, "epoch");
332✔
689
                break;
332✔
690
        case epoch_action::init: //
236✔
691
                CELERITY_DETAIL_TRACE_INSTRUCTION(einstr, "epoch (init)");
236✔
692
                break;
236✔
693
        case epoch_action::barrier: //
2✔
694
                CELERITY_DETAIL_TRACE_INSTRUCTION(einstr, "epoch (barrier)");
2✔
695
                root_communicator->collective_barrier();
2✔
696
                break;
2✔
697
        case epoch_action::shutdown: //
236✔
698
                CELERITY_DETAIL_TRACE_INSTRUCTION(einstr, "epoch (shutdown)");
236✔
699
                expecting_more_submissions = false;
236✔
700
                break;
236✔
701
        }
702

703
        // Update the runtime last-epoch *before* fulfilling the promise to ensure that the new state can be observed as soon as runtime::sync returns.
704
        // This in turn allows the TDAG to be pruned before any new work is submitted after the epoch.
705
        if(delegate != nullptr) { delegate->epoch_reached(einstr.get_epoch_task_id()); }
806!
706

707
        if(einstr.get_promise() != nullptr) { einstr.get_promise()->fulfill(); }
806✔
708
        collect(einstr.get_garbage());
806✔
709

710
        CELERITY_DETAIL_IF_TRACY_ENABLED(FrameMarkNamed("Horizon"));
711
        CELERITY_DETAIL_IF_TRACY_ENABLED(FrameMark); // top-level "Frame"
712
}
806✔
713

714
void executor_impl::issue_async(const alloc_instruction& ainstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async) {
1,103✔
715
        assert(ainstr.get_allocation_id().get_memory_id() != user_memory_id);
1,103✔
716
        assert(assignment.target == out_of_order_engine::target::alloc_queue);
1,103✔
717
        assert(!assignment.lane.has_value());
1,103✔
718
        assert(assignment.device.has_value() == (ainstr.get_allocation_id().get_memory_id() > host_memory_id));
1,103✔
719

720
        CELERITY_DETAIL_TRACE_INSTRUCTION(ainstr, "alloc {}, {} % {} bytes", ainstr.get_allocation_id(), ainstr.get_size_bytes(), ainstr.get_alignment_bytes());
1,103✔
721

722
        if(assignment.device.has_value()) {
1,103✔
723
                async.event = backend->enqueue_device_alloc(*assignment.device, ainstr.get_size_bytes(), ainstr.get_alignment_bytes());
557✔
724
        } else {
725
                async.event = backend->enqueue_host_alloc(ainstr.get_size_bytes(), ainstr.get_alignment_bytes());
546✔
726
        }
727
        async.alloc_aid = ainstr.get_allocation_id(); // setting alloc_aid != null will make `retire_async_instruction` insert the result into `allocations`
1,103✔
728
}
1,103✔
729

730
void executor_impl::issue_async(const free_instruction& finstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async) {
1,103✔
731
        const auto it = allocations.find(finstr.get_allocation_id());
1,103✔
732
        assert(it != allocations.end());
1,103✔
733
        const auto ptr = it->second;
1,103✔
734
        allocations.erase(it);
1,103✔
735

736
        CELERITY_DETAIL_TRACE_INSTRUCTION(finstr, "free {}", finstr.get_allocation_id());
1,103✔
737

738
        if(assignment.device.has_value()) {
1,103✔
739
                async.event = backend->enqueue_device_free(*assignment.device, ptr);
557✔
740
        } else {
741
                async.event = backend->enqueue_host_free(ptr);
546✔
742
        }
743
}
1,103✔
744

745
void executor_impl::issue_async(const copy_instruction& cinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async) {
2,323✔
746
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::issue_copy", Green4);
747

748
        assert(assignment.target == out_of_order_engine::target::host_queue || assignment.target == out_of_order_engine::target::device_queue);
2,323✔
749
        assert((assignment.target == out_of_order_engine::target::device_queue) == assignment.device.has_value());
2,323✔
750
        assert(assignment.lane.has_value());
2,323✔
751

752
        CELERITY_DETAIL_TRACE_INSTRUCTION(cinstr, "copy {} ({}) -> {} ({}); {}x{} bytes, {} bytes total", cinstr.get_source_allocation_id(),
2,323✔
753
            cinstr.get_source_layout(), cinstr.get_dest_allocation_id(), cinstr.get_dest_layout(), cinstr.get_copy_region(), cinstr.get_element_size(),
754
            cinstr.get_copy_region().get_area() * cinstr.get_element_size());
755

756
        const auto source_base = allocations.at(cinstr.get_source_allocation_id());
2,323✔
757
        const auto dest_base = allocations.at(cinstr.get_dest_allocation_id());
2,323✔
758

759
        if(assignment.device.has_value()) {
2,323✔
760
                async.event = backend->enqueue_device_copy(*assignment.device, *assignment.lane, source_base, dest_base, cinstr.get_source_layout(),
4,262✔
761
                    cinstr.get_dest_layout(), cinstr.get_copy_region(), cinstr.get_element_size());
2,131✔
762
        } else {
763
                async.event = backend->enqueue_host_copy(*assignment.lane, source_base, dest_base, cinstr.get_source_layout(), cinstr.get_dest_layout(),
384✔
764
                    cinstr.get_copy_region(), cinstr.get_element_size());
192✔
765
        }
766
}
2,323✔
767

768
std::string format_access_log(const buffer_access_allocation_map& map) {
1,434✔
769
        std::string acc_log;
1,434✔
770
        for(size_t i = 0; i < map.size(); ++i) {
2,872✔
771
                auto& aa = map[i];
1,438✔
772
                const auto accessed_bounding_box_in_allocation = box(aa.accessed_bounding_box_in_buffer.get_min() - aa.allocated_box_in_buffer.get_offset(),
4,314✔
773
                    aa.accessed_bounding_box_in_buffer.get_max() - aa.allocated_box_in_buffer.get_offset());
4,314✔
774
                fmt::format_to(std::back_inserter(acc_log), "{} {} {}", i == 0 ? "; accessing" : ",", aa.allocation_id, accessed_bounding_box_in_allocation);
2,876✔
775
        }
776
        return acc_log;
1,434✔
UNCOV
777
}
×
778

779
void executor_impl::issue_async(const device_kernel_instruction& dkinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async) {
861✔
780
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::issue_device_kernel", Yellow2);
781

782
        assert(assignment.target == out_of_order_engine::target::device_queue);
861✔
783
        assert(assignment.device == dkinstr.get_device_id());
861✔
784
        assert(assignment.lane.has_value());
861✔
785

786
        CELERITY_DETAIL_TRACE_INSTRUCTION(dkinstr, "device kernel on D{}, {}{}; estimated global memory traffic: {:.2f}", dkinstr.get_device_id(),
861✔
787
            dkinstr.get_execution_range(), format_access_log(dkinstr.get_access_allocations()),
788
            as_decimal_size(dkinstr.get_estimated_global_memory_traffic_bytes()));
789

790
        auto accessor_infos = make_accessor_infos(dkinstr.get_access_allocations());
861✔
791
#if CELERITY_ACCESSOR_BOUNDARY_CHECK
792
        async.oob_info = attach_boundary_check_info(
1,722✔
793
            accessor_infos, dkinstr.get_access_allocations(), dkinstr.get_oob_task_type(), dkinstr.get_oob_task_id(), dkinstr.get_oob_task_name());
861✔
794
#endif
795

796
        const auto& reduction_allocs = dkinstr.get_reduction_allocations();
861✔
797
        std::vector<void*> reduction_ptrs(reduction_allocs.size());
2,583✔
798
        for(size_t i = 0; i < reduction_allocs.size(); ++i) {
966✔
799
                reduction_ptrs[i] = allocations.at(reduction_allocs[i].allocation_id);
105✔
800
        }
801

802
        async.event = backend->enqueue_device_kernel(
3,444✔
803
            dkinstr.get_device_id(), *assignment.lane, dkinstr.get_launcher(), std::move(accessor_infos), dkinstr.get_execution_range(), reduction_ptrs);
2,583✔
804
}
1,722✔
805

806
void executor_impl::issue_async(const host_task_instruction& htinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async) {
1,178✔
807
        assert(assignment.target == out_of_order_engine::target::host_queue);
1,178✔
808
        assert(!assignment.device.has_value());
1,178✔
809
        assert(assignment.lane.has_value());
1,178✔
810

811
        CELERITY_DETAIL_TRACE_INSTRUCTION(htinstr, "host task, {}{}", htinstr.get_execution_range(), format_access_log(htinstr.get_access_allocations()));
1,178✔
812

813
        auto accessor_infos = make_accessor_infos(htinstr.get_access_allocations());
1,178✔
814
#if CELERITY_ACCESSOR_BOUNDARY_CHECK
815
        async.oob_info = attach_boundary_check_info(
2,356✔
816
            accessor_infos, htinstr.get_access_allocations(), htinstr.get_oob_task_type(), htinstr.get_oob_task_id(), htinstr.get_oob_task_name());
1,178✔
817
#endif
818

819
        const auto& execution_range = htinstr.get_execution_range();
1,178✔
820
        const auto collective_comm =
821
            htinstr.get_collective_group_id() != non_collective_group_id ? cloned_communicators.at(htinstr.get_collective_group_id()).get() : nullptr;
1,178!
822

823
        async.event = backend->enqueue_host_task(*assignment.lane, htinstr.get_launcher(), std::move(accessor_infos), execution_range, collective_comm);
1,178✔
824
}
2,356✔
825

826
void executor_impl::issue_async(
662✔
827
    const send_instruction& sinstr, [[maybe_unused]] const out_of_order_engine::assignment& assignment, async_instruction_state& async) //
828
{
829
        assert(assignment.target == out_of_order_engine::target::immediate);
662✔
830

831
        CELERITY_DETAIL_TRACE_INSTRUCTION(sinstr, "send {}+{}, {}x{} bytes to N{} (MSG{})", sinstr.get_source_allocation_id(),
662✔
832
            sinstr.get_offset_in_source_allocation(), sinstr.get_send_range(), sinstr.get_element_size(), sinstr.get_dest_node_id(), sinstr.get_message_id());
833

834
        const auto allocation_base = allocations.at(sinstr.get_source_allocation_id());
662✔
835
        const communicator::stride stride{
662✔
836
            sinstr.get_source_allocation_range(),
662✔
837
            subrange<3>{sinstr.get_offset_in_source_allocation(), sinstr.get_send_range()},
838
            sinstr.get_element_size(),
662✔
839
        };
662✔
840
        async.event = root_communicator->send_payload(sinstr.get_dest_node_id(), sinstr.get_message_id(), allocation_base, stride);
662✔
841
}
662✔
842

843
void executor_impl::issue_async(
370✔
844
    const receive_instruction& rinstr, [[maybe_unused]] const out_of_order_engine::assignment& assignment, async_instruction_state& async) //
845
{
846
        assert(assignment.target == out_of_order_engine::target::immediate);
370✔
847

848
        CELERITY_DETAIL_TRACE_INSTRUCTION(rinstr, "receive {} {}x{} bytes into {} ({})", rinstr.get_transfer_id(), rinstr.get_requested_region(),
370✔
849
            rinstr.get_element_size(), rinstr.get_dest_allocation_id(), rinstr.get_allocated_box());
850

851
        const auto allocation = allocations.at(rinstr.get_dest_allocation_id());
370✔
852
        async.event =
370✔
853
            recv_arbiter.receive(rinstr.get_transfer_id(), rinstr.get_requested_region(), allocation, rinstr.get_allocated_box(), rinstr.get_element_size());
370✔
854
}
370✔
855

856
void executor_impl::issue_async(
48✔
857
    const await_receive_instruction& arinstr, [[maybe_unused]] const out_of_order_engine::assignment& assignment, async_instruction_state& async) //
858
{
859
        assert(assignment.target == out_of_order_engine::target::immediate);
48✔
860

861
        CELERITY_DETAIL_TRACE_INSTRUCTION(arinstr, "await receive {} {}", arinstr.get_transfer_id(), arinstr.get_received_region());
48✔
862

863
        async.event = recv_arbiter.await_split_receive_subregion(arinstr.get_transfer_id(), arinstr.get_received_region());
48✔
864
}
48✔
865

866
void executor_impl::issue_async(
18✔
867
    const gather_receive_instruction& grinstr, [[maybe_unused]] const out_of_order_engine::assignment& assignment, async_instruction_state& async) //
868
{
869
        assert(assignment.target == out_of_order_engine::target::immediate);
18✔
870

871
        CELERITY_DETAIL_TRACE_INSTRUCTION(
18✔
872
            grinstr, "gather receive {} into {}, {} bytes / node", grinstr.get_transfer_id(), grinstr.get_dest_allocation_id(), grinstr.get_node_chunk_size());
873

874
        const auto allocation = allocations.at(grinstr.get_dest_allocation_id());
18✔
875
        async.event = recv_arbiter.gather_receive(grinstr.get_transfer_id(), allocation, grinstr.get_node_chunk_size());
18✔
876
}
18✔
877

878
void executor_impl::collect(const instruction_garbage& garbage) {
1,388✔
879
        for(const auto rid : garbage.reductions) {
1,455✔
880
                assert(reducers.count(rid) != 0);
67✔
881
                reducers.erase(rid);
67✔
882
        }
883
        for(const auto aid : garbage.user_allocations) {
1,497✔
884
                assert(aid.get_memory_id() == user_memory_id);
109✔
885
                assert(allocations.count(aid) != 0);
109✔
886
                allocations.erase(aid);
109✔
887
        }
888
}
1,388✔
889

890
std::vector<closure_hydrator::accessor_info> executor_impl::make_accessor_infos(const buffer_access_allocation_map& amap) const {
2,039✔
891
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::make_accessor_info", Magenta3);
892

893
        std::vector<closure_hydrator::accessor_info> accessor_infos(amap.size());
6,117✔
894
        for(size_t i = 0; i < amap.size(); ++i) {
4,583✔
895
                const auto ptr = allocations.at(amap[i].allocation_id);
2,544✔
896
                accessor_infos[i] = closure_hydrator::accessor_info{ptr, amap[i].allocated_box_in_buffer, amap[i].accessed_bounding_box_in_buffer};
2,544✔
897
        }
898
        return accessor_infos;
2,039✔
UNCOV
899
}
×
900

901
#if CELERITY_ACCESSOR_BOUNDARY_CHECK
902
std::unique_ptr<boundary_check_info> executor_impl::attach_boundary_check_info(std::vector<closure_hydrator::accessor_info>& accessor_infos,
2,039✔
903
    const buffer_access_allocation_map& amap, task_type tt, task_id tid, const std::string& task_name) const //
904
{
905
        if(amap.empty()) return nullptr;
2,039✔
906

907
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::oob_init", Red);
908
        auto oob_info = std::make_unique<boundary_check_info>(tt, tid, task_name);
1,934✔
909

910
        oob_info->illegal_access_bounding_boxes = static_cast<oob_bounding_box*>(backend->debug_alloc(amap.size() * sizeof(oob_bounding_box)));
1,934✔
911
        std::uninitialized_default_construct_n(oob_info->illegal_access_bounding_boxes, amap.size());
1,934✔
912

913
        oob_info->accessors.resize(amap.size());
1,934✔
914
        for(size_t i = 0; i < amap.size(); ++i) {
4,478✔
915
                oob_info->accessors[i] = boundary_check_info::accessor_info{amap[i].oob_buffer_id, amap[i].oob_buffer_name, amap[i].accessed_bounding_box_in_buffer};
2,544✔
916
                accessor_infos[i].out_of_bounds_indices = oob_info->illegal_access_bounding_boxes + i;
2,544✔
917
        }
918
        return oob_info;
1,934✔
919
}
1,934✔
920
#endif // CELERITY_ACCESSOR_BOUNDARY_CHECK
921

922
} // namespace celerity::detail::live_executor_detail
923

924
namespace celerity::detail {
925

926
live_executor::live_executor(std::unique_ptr<backend> backend, std::unique_ptr<communicator> root_comm, executor::delegate* const dlg, const policy_set& policy)
236✔
927
    : m_root_comm(std::move(root_comm)), m_thread(&live_executor::thread_main, this, std::move(backend), dlg, policy) //
236✔
928
{
929
        set_thread_name(m_thread.native_handle(), "cy-executor");
708✔
930
}
236✔
931

932
live_executor::~live_executor() {
472✔
933
        m_thread.join(); // thread_main will exit only after executing shutdown epoch
236✔
934
}
472✔
935

936
void live_executor::track_user_allocation(const allocation_id aid, void* const ptr) {
109✔
937
        m_submission_queue.push(live_executor_detail::user_allocation_transfer{aid, ptr});
109✔
938
}
109✔
939

940
void live_executor::track_host_object_instance(const host_object_id hoid, std::unique_ptr<host_object_instance> instance) {
30✔
941
        assert(instance != nullptr);
30✔
942
        m_submission_queue.push(live_executor_detail::host_object_transfer{hoid, std::move(instance)});
30✔
943
}
30✔
944

945
void live_executor::track_reducer(const reduction_id rid, std::unique_ptr<reducer> reducer) {
68✔
946
        assert(reducer != nullptr);
68✔
947
        m_submission_queue.push(live_executor_detail::reducer_transfer{rid, std::move(reducer)});
68✔
948
}
68✔
949

950
void live_executor::submit(std::vector<const instruction*> instructions, std::vector<outbound_pilot> pilots) {
3,938✔
951
        m_submission_queue.push(live_executor_detail::instruction_pilot_batch{std::move(instructions), std::move(pilots)});
3,938!
952
}
3,938✔
953

954
void live_executor::thread_main(std::unique_ptr<backend> backend, executor::delegate* const dlg, const policy_set& policy) {
236✔
955
        CELERITY_DETAIL_TRACY_SET_THREAD_NAME_AND_ORDER("cy-executor", tracy_detail::thread_order::executor);
956

957
        thread_pinning::pin_this_thread(thread_pinning::thread_type::executor);
236✔
958

959
        try {
960
                live_executor_detail::executor_impl(std::move(backend), m_root_comm.get(), m_submission_queue, dlg, policy).run();
236✔
961
        }
962
        // LCOV_EXCL_START
963
        catch(const std::exception& e) {
964
                CELERITY_CRITICAL("[executor] {}", e.what());
965
                std::abort();
966
        }
967
        // LCOV_EXCL_STOP
968
}
236✔
969

970
} // namespace celerity::detail
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc