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

celerity / celerity-runtime / 11665018161

04 Nov 2024 01:17PM UTC coverage: 95.167% (-0.08%) from 95.251%
11665018161

push

github

fknorr
Update benchmark results for region_builder

3016 of 3412 branches covered (88.39%)

Branch coverage included in aggregate %.

6691 of 6788 relevant lines covered (98.57%)

1312478.22 hits per line

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

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

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

24
#include <matchbox.hh>
25

26

27
namespace celerity::detail::live_executor_detail {
28

29
#if CELERITY_TRACY_SUPPORT
30

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

96

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

121
tracy_integration::async_lane_cursor tracy_integration::get_async_lane_cursor(const out_of_order_engine::assignment& assignment) {
122
        const auto target = assignment.target;
123
        // on alloc_queue, assignment.device signals on which device to allocate memory, not on which device to queue the instruction
124
        const auto device = assignment.target == out_of_order_engine::target::device_queue ? assignment.device : std::nullopt;
125
        // 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`,
126
        // to continue using `nullopt` to pick an arbitrary empty lane in the code below for the immediate-but-async send / receive instruction types.
127
        const auto local_lane_id = assignment.target == out_of_order_engine::target::alloc_queue ? std::optional<size_t>(0) : assignment.lane;
128

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

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

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

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

178
#undef CELERITY_DETAIL_BEGIN_INSTRUCTION_ZONE
179

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

192
        return info;
193
}
194

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

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

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

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

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

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

234
        TracyCZoneEnd(ctx);
235
}
236

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

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

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

260
        return cursor;
261
}
262

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

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

286
#endif // CELERITY_DETAIL_ENABLE_TRACY
287

288

289
#if CELERITY_ACCESSOR_BOUNDARY_CHECK
290

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

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

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

305
        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,926✔
306
};
307

308
#endif // CELERITY_ACCESSOR_BOUNDARY_CHECK
309

310

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

315

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

404
void executor_impl::run() {
231✔
405
        closure_hydrator::make_available();
231✔
406
        backend->init();
231✔
407

408
        uint8_t check_overflow_counter = 0;
231✔
409
        for(;;) {
410
                if(engine.is_idle()) {
4,366,127✔
411
                        if(!expecting_more_submissions) break; // shutdown complete
2,317✔
412

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

418
                recv_arbiter.poll_communicator();
4,365,896✔
419
                poll_in_flight_async_instructions();
4,365,896✔
420
                poll_submission_queue();
4,365,896✔
421
                try_issue_one_instruction(); // potentially expensive, so only issue one per loop to continue checking for async completion in between
4,365,896✔
422

423
                if(++check_overflow_counter == 0) { // once every 256 iterations
4,365,896✔
424
                        backend->check_async_errors();
16,995✔
425
                        check_progress();
16,995✔
426
                }
427
        }
428

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

436
        closure_hydrator::teardown();
231✔
437
}
231✔
438

439
void executor_impl::poll_in_flight_async_instructions() {
4,365,896✔
440
        // collect completed instruction ids up-front, since retire_async_instruction would alter the execution front
441
        std::vector<instruction_id> completed_now; // std::vector because it will be empty in the common case
4,365,896✔
442
        for(const auto iid : engine.get_execution_front()) {
12,888,982✔
443
                if(in_flight_async_instructions.at(iid).event.is_complete()) { completed_now.push_back(iid); }
8,523,086✔
444
        }
445
        for(const auto iid : completed_now) {
4,373,536✔
446
                retire_async_instruction(iid, in_flight_async_instructions.at(iid));
7,640✔
447
                in_flight_async_instructions.erase(iid);
7,640✔
448
                made_progress = true;
7,640✔
449
        }
450

451
        CELERITY_DETAIL_IF_TRACY_ENABLED(tracy->assigned_instructions_plot.update(in_flight_async_instructions.size()));
452
}
8,731,792✔
453

454
void executor_impl::poll_submission_queue() {
4,365,896✔
455
        for(auto& submission : submission_queue->pop_all()) {
4,370,016✔
456
                CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::fetch", Gray);
457
                matchbox::match(
4,120✔
458
                    submission,
459
                    [&](const instruction_pilot_batch& batch) {
4,120✔
460
                            for(const auto incoming_instr : batch.instructions) {
13,139✔
461
                                    engine.submit(incoming_instr);
9,224✔
462
                            }
463
                            for(const auto& pilot : batch.pilots) {
4,577✔
464
                                    root_communicator->send_outbound_pilot(pilot);
662✔
465
                            }
466
                            CELERITY_DETAIL_IF_TRACY_ENABLED(tracy->assignment_queue_length_plot.update(engine.get_assignment_queue_length()));
467
                    },
3,915✔
468
                    [&](const user_allocation_transfer& uat) {
8,240✔
469
                            assert(uat.aid != null_allocation_id);
107✔
470
                            assert(uat.aid.get_memory_id() == user_memory_id);
107✔
471
                            assert(allocations.count(uat.aid) == 0);
107✔
472
                            allocations.emplace(uat.aid, uat.ptr);
107✔
473
                    },
107✔
474
                    [&](host_object_transfer& hot) {
8,240✔
475
                            assert(host_object_instances.count(hot.hoid) == 0);
30✔
476
                            host_object_instances.emplace(hot.hoid, std::move(hot.instance));
30✔
477
                    },
30✔
478
                    [&](reducer_transfer& rt) {
8,240✔
479
                            assert(reducers.count(rt.rid) == 0);
68✔
480
                            reducers.emplace(rt.rid, std::move(rt.reduction));
68✔
481
                    });
68✔
482
        }
483
}
4,365,896✔
484

485
void executor_impl::retire_async_instruction(const instruction_id iid, async_instruction_state& async) {
7,640✔
486
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::retire", Brown);
487

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

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

515
        CELERITY_DETAIL_IF_TRACY_ENABLED(tracy->retire_async_instruction(*async.tracy_lane_cursor, async.event));
516

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

525
        engine.complete_assigned(iid);
7,640✔
526

527
        CELERITY_DETAIL_IF_TRACY_ENABLED(tracy->assignment_queue_length_plot.update(engine.get_assignment_queue_length()));
528
}
7,640✔
529

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

538
        const auto iid = instr.get_id(); // instr may dangle after issue()
1,584✔
539

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

549
        issue(instr); // completes immediately - instr may now dangle
1,584✔
550

551
        CELERITY_DETAIL_IF_TRACY_ENABLED({
552
                tracy->end_instruction_zone(ctx, info, tracy->last_instruction_trace);
553
                TracyFiberLeave;
554
        })
555

556
        engine.complete_assigned(iid);
1,584✔
557

558
        CELERITY_DETAIL_IF_TRACY_ENABLED({
559
                tracy->assigned_instructions_plot.update(in_flight_async_instructions.size());
560
                tracy->assignment_queue_length_plot.update(engine.get_assignment_queue_length());
561
        })
562
}
1,584✔
563

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

572
        auto& async = in_flight_async_instructions.emplace(assignment.instruction->get_id(), async_instruction_state{}).first->second;
15,280✔
573
        issue_async(instr, assignment, async); // stores event in `async` and completes asynchronously
7,640✔
574
        // instr may now dangle
575

576
        CELERITY_DETAIL_IF_TRACY_ENABLED({
577
                async.tracy_lane_cursor = tracy->issue_async_instruction(std::move(info), assignment, std::move(tracy->last_instruction_trace));
578
                tracy->assigned_instructions_plot.update(in_flight_async_instructions.size());
579
        })
580
}
15,280✔
581

582
void executor_impl::try_issue_one_instruction() {
4,365,896✔
583
        auto assignment = engine.assign_one();
4,365,896✔
584
        if(!assignment.has_value()) return;
4,365,896✔
585

586
        CELERITY_DETAIL_IF_TRACY_ENABLED(tracy->assignment_queue_length_plot.update(engine.get_assignment_queue_length()));
587

588
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::issue", Blue);
589
        matchbox::match(*assignment->instruction, [&](const auto& instr) { dispatch(instr, *assignment); });
18,448✔
590
        made_progress = true;
9,224✔
591
}
592

593
void executor_impl::check_progress() {
16,995✔
594
        if(!policy.progress_warning_timeout.has_value()) return;
16,995!
595

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

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

621
        const auto new_cgid = ccginstr.get_new_collective_group_id();
33✔
622
        assert(new_cgid != non_collective_group_id && new_cgid != root_collective_group_id);
33✔
623
        assert(cloned_communicators.count(new_cgid) == 0);
33✔
624

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

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

631

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

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

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

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

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

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

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

663
        finstr.get_promise()->fulfill();
63✔
664
}
63✔
665

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

670
        host_object_instances.erase(dhoinstr.get_host_object_id());
30✔
671
}
30✔
672

673
void executor_impl::issue(const horizon_instruction& hinstr) {
582✔
674
        CELERITY_DETAIL_TRACE_INSTRUCTION(hinstr, "horizon");
582✔
675

676
        if(delegate != nullptr) { delegate->horizon_reached(hinstr.get_horizon_task_id()); }
582!
677
        collect(hinstr.get_garbage());
582✔
678

679
        CELERITY_DETAIL_IF_TRACY_ENABLED(FrameMarkNamed("Horizon"));
680
}
582✔
681

682
void executor_impl::issue(const epoch_instruction& einstr) {
790✔
683
        switch(einstr.get_epoch_action()) {
790!
684
        case epoch_action::none: //
326✔
685
                CELERITY_DETAIL_TRACE_INSTRUCTION(einstr, "epoch");
326✔
686
                break;
326✔
687
        case epoch_action::init: //
231✔
688
                CELERITY_DETAIL_TRACE_INSTRUCTION(einstr, "epoch (init)");
231✔
689
                break;
231✔
690
        case epoch_action::barrier: //
2✔
691
                CELERITY_DETAIL_TRACE_INSTRUCTION(einstr, "epoch (barrier)");
2✔
692
                root_communicator->collective_barrier();
2✔
693
                break;
2✔
694
        case epoch_action::shutdown: //
231✔
695
                CELERITY_DETAIL_TRACE_INSTRUCTION(einstr, "epoch (shutdown)");
231✔
696
                expecting_more_submissions = false;
231✔
697
                break;
231✔
698
        }
699
        if(delegate != nullptr) { delegate->epoch_reached(einstr.get_epoch_task_id()); }
790!
700
        collect(einstr.get_garbage());
790✔
701

702
        CELERITY_DETAIL_IF_TRACY_ENABLED(FrameMarkNamed("Horizon"));
703
        CELERITY_DETAIL_IF_TRACY_ENABLED(FrameMark); // top-level "Frame"
704
}
790✔
705

706
void executor_impl::issue_async(const alloc_instruction& ainstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async) {
1,096✔
707
        assert(ainstr.get_allocation_id().get_memory_id() != user_memory_id);
1,096✔
708
        assert(assignment.target == out_of_order_engine::target::alloc_queue);
1,096✔
709
        assert(!assignment.lane.has_value());
1,096✔
710
        assert(assignment.device.has_value() == (ainstr.get_allocation_id().get_memory_id() > host_memory_id));
1,096✔
711

712
        CELERITY_DETAIL_TRACE_INSTRUCTION(ainstr, "alloc {}, {} % {} bytes", ainstr.get_allocation_id(), ainstr.get_size_bytes(), ainstr.get_alignment_bytes());
1,096✔
713

714
        if(assignment.device.has_value()) {
1,096✔
715
                async.event = backend->enqueue_device_alloc(*assignment.device, ainstr.get_size_bytes(), ainstr.get_alignment_bytes());
551✔
716
        } else {
717
                async.event = backend->enqueue_host_alloc(ainstr.get_size_bytes(), ainstr.get_alignment_bytes());
545✔
718
        }
719
        async.alloc_aid = ainstr.get_allocation_id(); // setting alloc_aid != null will make `retire_async_instruction` insert the result into `allocations`
1,096✔
720
}
1,096✔
721

722
void executor_impl::issue_async(const free_instruction& finstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async) {
1,096✔
723
        const auto it = allocations.find(finstr.get_allocation_id());
1,096✔
724
        assert(it != allocations.end());
1,096✔
725
        const auto ptr = it->second;
1,096✔
726
        allocations.erase(it);
1,096✔
727

728
        CELERITY_DETAIL_TRACE_INSTRUCTION(finstr, "free {}", finstr.get_allocation_id());
1,096✔
729

730
        if(assignment.device.has_value()) {
1,096✔
731
                async.event = backend->enqueue_device_free(*assignment.device, ptr);
551✔
732
        } else {
733
                async.event = backend->enqueue_host_free(ptr);
545✔
734
        }
735
}
1,096✔
736

737
void executor_impl::issue_async(const copy_instruction& cinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async) {
2,319✔
738
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::issue_copy", Green4);
739

740
        assert(assignment.target == out_of_order_engine::target::host_queue || assignment.target == out_of_order_engine::target::device_queue);
2,319✔
741
        assert((assignment.target == out_of_order_engine::target::device_queue) == assignment.device.has_value());
2,319✔
742
        assert(assignment.lane.has_value());
2,319✔
743

744
        CELERITY_DETAIL_TRACE_INSTRUCTION(cinstr, "copy {} ({}) -> {} ({}); {}x{} bytes, {} bytes total", cinstr.get_source_allocation_id(),
2,319✔
745
            cinstr.get_source_layout(), cinstr.get_dest_allocation_id(), cinstr.get_dest_layout(), cinstr.get_copy_region(), cinstr.get_element_size(),
746
            cinstr.get_copy_region().get_area() * cinstr.get_element_size());
747

748
        const auto source_base = allocations.at(cinstr.get_source_allocation_id());
2,319✔
749
        const auto dest_base = allocations.at(cinstr.get_dest_allocation_id());
2,319✔
750

751
        if(assignment.device.has_value()) {
2,319✔
752
                async.event = backend->enqueue_device_copy(*assignment.device, *assignment.lane, source_base, dest_base, cinstr.get_source_layout(),
4,258✔
753
                    cinstr.get_dest_layout(), cinstr.get_copy_region(), cinstr.get_element_size());
2,129✔
754
        } else {
755
                async.event = backend->enqueue_host_copy(*assignment.lane, source_base, dest_base, cinstr.get_source_layout(), cinstr.get_dest_layout(),
380✔
756
                    cinstr.get_copy_region(), cinstr.get_element_size());
190✔
757
        }
758
}
2,319✔
759

760
std::string format_access_log(const buffer_access_allocation_map& map) {
1,426✔
761
        std::string acc_log;
1,426✔
762
        for(size_t i = 0; i < map.size(); ++i) {
2,852✔
763
                auto& aa = map[i];
1,426✔
764
                const auto accessed_bounding_box_in_allocation = box(aa.accessed_bounding_box_in_buffer.get_min() - aa.allocated_box_in_buffer.get_offset(),
4,278✔
765
                    aa.accessed_bounding_box_in_buffer.get_max() - aa.allocated_box_in_buffer.get_offset());
4,278✔
766
                fmt::format_to(std::back_inserter(acc_log), "{} {} {}", i == 0 ? "; accessing" : ",", aa.allocation_id, accessed_bounding_box_in_allocation);
2,852✔
767
        }
768
        return acc_log;
1,426✔
769
}
×
770

771
void executor_impl::issue_async(const device_kernel_instruction& dkinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async) {
853✔
772
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::issue_device_kernel", Yellow2);
773

774
        assert(assignment.target == out_of_order_engine::target::device_queue);
853✔
775
        assert(assignment.device == dkinstr.get_device_id());
853✔
776
        assert(assignment.lane.has_value());
853✔
777

778
        CELERITY_DETAIL_TRACE_INSTRUCTION(dkinstr, "device kernel on D{}, {}{}; estimated global memory traffic: {:.2f}", dkinstr.get_device_id(),
853✔
779
            dkinstr.get_execution_range(), format_access_log(dkinstr.get_access_allocations()),
780
            as_decimal_size(dkinstr.get_estimated_global_memory_traffic_bytes()));
781

782
        auto accessor_infos = make_accessor_infos(dkinstr.get_access_allocations());
853✔
783
#if CELERITY_ACCESSOR_BOUNDARY_CHECK
784
        async.oob_info = attach_boundary_check_info(
1,706✔
785
            accessor_infos, dkinstr.get_access_allocations(), dkinstr.get_oob_task_type(), dkinstr.get_oob_task_id(), dkinstr.get_oob_task_name());
853✔
786
#endif
787

788
        const auto& reduction_allocs = dkinstr.get_reduction_allocations();
853✔
789
        std::vector<void*> reduction_ptrs(reduction_allocs.size());
2,559✔
790
        for(size_t i = 0; i < reduction_allocs.size(); ++i) {
958✔
791
                reduction_ptrs[i] = allocations.at(reduction_allocs[i].allocation_id);
105✔
792
        }
793

794
        async.event = backend->enqueue_device_kernel(
3,412✔
795
            dkinstr.get_device_id(), *assignment.lane, dkinstr.get_launcher(), std::move(accessor_infos), dkinstr.get_execution_range(), reduction_ptrs);
2,559✔
796
}
1,706✔
797

798
void executor_impl::issue_async(const host_task_instruction& htinstr, const out_of_order_engine::assignment& assignment, async_instruction_state& async) {
1,178✔
799
        assert(assignment.target == out_of_order_engine::target::host_queue);
1,178✔
800
        assert(!assignment.device.has_value());
1,178✔
801
        assert(assignment.lane.has_value());
1,178✔
802

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

805
        auto accessor_infos = make_accessor_infos(htinstr.get_access_allocations());
1,178✔
806
#if CELERITY_ACCESSOR_BOUNDARY_CHECK
807
        async.oob_info = attach_boundary_check_info(
2,356✔
808
            accessor_infos, htinstr.get_access_allocations(), htinstr.get_oob_task_type(), htinstr.get_oob_task_id(), htinstr.get_oob_task_name());
1,178✔
809
#endif
810

811
        const auto& execution_range = htinstr.get_execution_range();
1,178✔
812
        const auto collective_comm =
813
            htinstr.get_collective_group_id() != non_collective_group_id ? cloned_communicators.at(htinstr.get_collective_group_id()).get() : nullptr;
1,178!
814

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

818
void executor_impl::issue_async(
662✔
819
    const send_instruction& sinstr, [[maybe_unused]] const out_of_order_engine::assignment& assignment, async_instruction_state& async) //
820
{
821
        assert(assignment.target == out_of_order_engine::target::immediate);
662✔
822

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

826
        const auto allocation_base = allocations.at(sinstr.get_source_allocation_id());
662✔
827
        const communicator::stride stride{
662✔
828
            sinstr.get_source_allocation_range(),
662✔
829
            subrange<3>{sinstr.get_offset_in_source_allocation(), sinstr.get_send_range()},
830
            sinstr.get_element_size(),
662✔
831
        };
662✔
832
        async.event = root_communicator->send_payload(sinstr.get_dest_node_id(), sinstr.get_message_id(), allocation_base, stride);
662✔
833
}
662✔
834

835
void executor_impl::issue_async(
370✔
836
    const receive_instruction& rinstr, [[maybe_unused]] const out_of_order_engine::assignment& assignment, async_instruction_state& async) //
837
{
838
        assert(assignment.target == out_of_order_engine::target::immediate);
370✔
839

840
        CELERITY_DETAIL_TRACE_INSTRUCTION(rinstr, "receive {} {}x{} bytes into {} ({})", rinstr.get_transfer_id(), rinstr.get_requested_region(),
370✔
841
            rinstr.get_element_size(), rinstr.get_dest_allocation_id(), rinstr.get_allocated_box());
842

843
        const auto allocation = allocations.at(rinstr.get_dest_allocation_id());
370✔
844
        async.event =
370✔
845
            recv_arbiter.receive(rinstr.get_transfer_id(), rinstr.get_requested_region(), allocation, rinstr.get_allocated_box(), rinstr.get_element_size());
370✔
846
}
370✔
847

848
void executor_impl::issue_async(
48✔
849
    const await_receive_instruction& arinstr, [[maybe_unused]] const out_of_order_engine::assignment& assignment, async_instruction_state& async) //
850
{
851
        assert(assignment.target == out_of_order_engine::target::immediate);
48✔
852

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

855
        async.event = recv_arbiter.await_split_receive_subregion(arinstr.get_transfer_id(), arinstr.get_received_region());
48✔
856
}
48✔
857

858
void executor_impl::issue_async(
18✔
859
    const gather_receive_instruction& grinstr, [[maybe_unused]] const out_of_order_engine::assignment& assignment, async_instruction_state& async) //
860
{
861
        assert(assignment.target == out_of_order_engine::target::immediate);
18✔
862

863
        CELERITY_DETAIL_TRACE_INSTRUCTION(
18✔
864
            grinstr, "gather receive {} into {}, {} bytes / node", grinstr.get_transfer_id(), grinstr.get_dest_allocation_id(), grinstr.get_node_chunk_size());
865

866
        const auto allocation = allocations.at(grinstr.get_dest_allocation_id());
18✔
867
        async.event = recv_arbiter.gather_receive(grinstr.get_transfer_id(), allocation, grinstr.get_node_chunk_size());
18✔
868
}
18✔
869

870
void executor_impl::collect(const instruction_garbage& garbage) {
1,372✔
871
        for(const auto rid : garbage.reductions) {
1,439✔
872
                assert(reducers.count(rid) != 0);
67✔
873
                reducers.erase(rid);
67✔
874
        }
875
        for(const auto aid : garbage.user_allocations) {
1,479✔
876
                assert(aid.get_memory_id() == user_memory_id);
107✔
877
                assert(allocations.count(aid) != 0);
107✔
878
                allocations.erase(aid);
107✔
879
        }
880
}
1,372✔
881

882
std::vector<closure_hydrator::accessor_info> executor_impl::make_accessor_infos(const buffer_access_allocation_map& amap) const {
2,031✔
883
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::make_accessor_info", Magenta3);
884

885
        std::vector<closure_hydrator::accessor_info> accessor_infos(amap.size());
6,093✔
886
        for(size_t i = 0; i < amap.size(); ++i) {
4,563✔
887
                const auto ptr = allocations.at(amap[i].allocation_id);
2,532✔
888
                accessor_infos[i] = closure_hydrator::accessor_info{ptr, amap[i].allocated_box_in_buffer, amap[i].accessed_bounding_box_in_buffer};
2,532✔
889
        }
890
        return accessor_infos;
2,031✔
891
}
×
892

893
#if CELERITY_ACCESSOR_BOUNDARY_CHECK
894
std::unique_ptr<boundary_check_info> executor_impl::attach_boundary_check_info(std::vector<closure_hydrator::accessor_info>& accessor_infos,
2,031✔
895
    const buffer_access_allocation_map& amap, task_type tt, task_id tid, const std::string& task_name) const //
896
{
897
        if(amap.empty()) return nullptr;
2,031✔
898

899
        CELERITY_DETAIL_TRACY_ZONE_SCOPED("executor::oob_init", Red);
900
        auto oob_info = std::make_unique<boundary_check_info>(tt, tid, task_name);
1,926✔
901

902
        oob_info->illegal_access_bounding_boxes = static_cast<oob_bounding_box*>(backend->debug_alloc(amap.size() * sizeof(oob_bounding_box)));
1,926✔
903
        std::uninitialized_default_construct_n(oob_info->illegal_access_bounding_boxes, amap.size());
1,926✔
904

905
        oob_info->accessors.resize(amap.size());
1,926✔
906
        for(size_t i = 0; i < amap.size(); ++i) {
4,458✔
907
                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,532✔
908
                accessor_infos[i].out_of_bounds_indices = oob_info->illegal_access_bounding_boxes + i;
2,532✔
909
        }
910
        return oob_info;
1,926✔
911
}
1,926✔
912
#endif // CELERITY_ACCESSOR_BOUNDARY_CHECK
913

914
} // namespace celerity::detail::live_executor_detail
915

916
namespace celerity::detail {
917

918
live_executor::live_executor(std::unique_ptr<backend> backend, std::unique_ptr<communicator> root_comm, executor::delegate* const dlg, const policy_set& policy)
231✔
919
    : m_root_comm(std::move(root_comm)), m_thread(&live_executor::thread_main, this, std::move(backend), dlg, policy) //
231✔
920
{
921
        set_thread_name(m_thread.native_handle(), "cy-executor");
693✔
922
}
231✔
923

924
live_executor::~live_executor() {
462✔
925
        m_thread.join(); // thread_main will exit only after executing shutdown epoch
231✔
926
}
462✔
927

928
void live_executor::track_user_allocation(const allocation_id aid, void* const ptr) {
107✔
929
        m_submission_queue.push(live_executor_detail::user_allocation_transfer{aid, ptr});
107✔
930
}
107✔
931

932
void live_executor::track_host_object_instance(const host_object_id hoid, std::unique_ptr<host_object_instance> instance) {
30✔
933
        assert(instance != nullptr);
30✔
934
        m_submission_queue.push(live_executor_detail::host_object_transfer{hoid, std::move(instance)});
30✔
935
}
30✔
936

937
void live_executor::track_reducer(const reduction_id rid, std::unique_ptr<reducer> reducer) {
68✔
938
        assert(reducer != nullptr);
68✔
939
        m_submission_queue.push(live_executor_detail::reducer_transfer{rid, std::move(reducer)});
68✔
940
}
68✔
941

942
void live_executor::submit(std::vector<const instruction*> instructions, std::vector<outbound_pilot> pilots) {
3,915✔
943
        m_submission_queue.push(live_executor_detail::instruction_pilot_batch{std::move(instructions), std::move(pilots)});
3,915!
944
}
3,915✔
945

946
void live_executor::thread_main(std::unique_ptr<backend> backend, executor::delegate* const dlg, const policy_set& policy) {
231✔
947
        CELERITY_DETAIL_TRACY_SET_THREAD_NAME_AND_ORDER("cy-executor", tracy_detail::thread_order::executor);
948
        try {
949
                live_executor_detail::executor_impl(std::move(backend), m_root_comm.get(), m_submission_queue, dlg, policy).run();
231✔
950
        }
951
        // LCOV_EXCL_START
952
        catch(const std::exception& e) {
953
                CELERITY_CRITICAL("[executor] {}", e.what());
954
                std::abort();
955
        }
956
        // LCOV_EXCL_STOP
957
}
231✔
958

959
} // 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