1 /* Copyright (c) 2016-2023. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_MC_REMOTE_APP_HPP
7 #define SIMGRID_MC_REMOTE_APP_HPP
9 #include "simgrid/forward.h"
10 #include "src/mc/ModelChecker.hpp"
11 #include "src/mc/api/ActorState.hpp"
12 #include "src/mc/remote/RemotePtr.hpp"
16 namespace simgrid::mc {
18 /** High-level view of the verified application, from the model-checker POV
20 * This is expected to become the interface used by model-checking
21 * algorithms to control the execution of the model-checked process
22 * and the exploration of the execution graph. Model-checking
23 * algorithms should be able to be written in high-level languages
24 * (e.g. Python) using bindings on this interface.
26 class XBT_PUBLIC RemoteApp {
28 std::unique_ptr<ModelChecker> model_checker_;
29 std::shared_ptr<simgrid::mc::Snapshot> initial_snapshot_;
32 RemoteApp(RemoteApp const&) = delete;
33 RemoteApp& operator=(RemoteApp const&) = delete;
36 /** Create a new session by executing the provided code in a fork()
38 * This sets up the environment for the model-checked process
39 * (environment variables, sockets, etc.).
41 * The code is expected to `exec` the model-checked application.
43 explicit RemoteApp(const std::vector<char*>& args);
47 void restore_initial_state() const;
49 /** Ask to the application to check for a deadlock. If so, do an error message and throw a DeadlockError. */
50 void check_deadlock() const;
52 /** Retrieve the max PID of the running actors */
53 unsigned long get_maxpid() const;
55 /* Get the list of actors that are ready to run at that step. Usually shorter than maxpid */
56 void get_actors_status(std::map<aid_t, simgrid::mc::ActorState>& whereto) const;
58 /* Get the remote process */
59 RemoteProcess& get_remote_process() { return model_checker_->get_remote_process(); }
61 } // namespace simgrid::mc