EventList.hpp

Go to the documentation of this file.

// -------------------------------------------------------//
//
// SHAMROCK code for hydrodynamics
// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
//
// -------------------------------------------------------//
 
#pragma once

 
#include "shambase/stacktrace.hpp"
#include "sham/format/format.hpp"
#include "shambackends/DeviceContext.hpp"
 
namespace sham {
 
    namespace details {
        // forward declare BufferEventHandler
        class BufferEventHandler;
    } // namespace details

    class EventList {
        public:
        inline void apply_dependency(sycl::handler &h) { h.depends_on(events); }

        inline void wait() {
            StackEntry __s{};
            for (auto &e : events) {
                e.wait();
            }
            consumed = true;
        }

        inline void wait_and_throw() {
            StackEntry __s{};
            for (auto &e : events) {
                e.wait_and_throw();
            }
            consumed = true;
        }

        inline void add_event(sycl::event e) {
            events.push_back(e);
            consumed = false;
        }

        inline void add_events(std::vector<sycl::event> &e) {
            events.insert(events.end(), e.begin(), e.end());
            consumed = false;
        }

        inline void add_events(sham::EventList &e) {
            events.insert(events.end(), e.events.begin(), e.events.end());
            consumed   = false;
            e.consumed = true;
        }

        inline std::string get_state() {
            return sham::format("events : {}, consumed : {}", events.size(), consumed);
        }

        EventList(SourceLocation loc = SourceLocation{}) : loc_build(loc) {}

        EventList(std::initializer_list<sycl::event> e, SourceLocation loc = SourceLocation{})
            : events(e), loc_build(loc) {}

        ~EventList() noexcept(false);

        inline std::vector<sycl::event> &get_events() { return events; }

        inline const std::vector<sycl::event> &get_events() const { return events; }

        inline void set_consumed(bool consumed) { this->consumed = consumed; }
 
        private:
        std::vector<sycl::event> events = {};    
        bool consumed                   = false; 
        SourceLocation loc_build;                
 
        friend class DeviceQueue;
        friend class details::BufferEventHandler;
    };
} // namespace sham