SignalHandling.H

Go to the documentation of this file.

/* Copyright 2022 Philip Miller
 *
 * This file is part of WarpX.
 *
 * License: BSD-3-Clause-LBNL
 */

#ifndef ABLASTR_SIGNAL_HANDLING_H_
#define ABLASTR_SIGNAL_HANDLING_H_

#include <AMReX_Config.H>

#if defined(AMREX_USE_MPI)
#   include <mpi.h>
#endif

#include <atomic>
#include <string>

namespace ablastr::utils {

class SignalHandling
{
public:
    static constexpr int NUM_SIGNALS = 32;

    enum signal_action_requested_labels {
        SIGNAL_REQUESTS_BREAK = 0,
        SIGNAL_REQUESTS_CHECKPOINT = 1,
        SIGNAL_REQUESTS_SIZE = 2 // This should always be 1 greater than the last valid value
    };

    static bool signal_conf_requests[SIGNAL_REQUESTS_SIZE][NUM_SIGNALS];

    static int parseSignalNameToNumber (const std::string &str);

    static void InitSignalHandling ();

    static void CheckSignals ();
    static void WaitSignals ();

    static bool TestAndResetActionRequestFlag (int action_to_test);

private:
    static bool m_any_signal_action_active;

    static std::atomic<bool> signal_received_flags[NUM_SIGNALS];

#if defined(AMREX_USE_MPI)
    static MPI_Request signal_mpi_ibcast_request;
#endif

    static void SignalSetFlag (int signal_number);

    static bool signal_actions_requested[SIGNAL_REQUESTS_SIZE];

     // Don't allow clients to incorrectly try to construct and use an instance of this type
    SignalHandling () = delete;
};

} // namespace ablastr::utils

#endif // ABLASTR_SIGNAL_HANDLING_H_