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/api/ActorState.hpp"
11 #include "src/mc/remote/CheckerSide.hpp"
12 #include "src/mc/remote/RemotePtr.hpp"
13 #include "src/mc/sosp/PageStore.hpp"
17 namespace simgrid::mc {
19 /** High-level view of the verified application, from the model-checker POV
21 * This is expected to become the interface used by model-checking algorithms to control the execution of
22 * the application process during the exploration of the execution graph.
24 * One day, this will allow parallel exploration, ie, the handling of several application processes (each encapsulated
25 * in a separate CheckerSide objects) that explore several parts of the exploration graph.
27 class XBT_PUBLIC RemoteApp {
29 std::unique_ptr<CheckerSide> checker_side_;
30 PageStore page_store_{500};
31 std::shared_ptr<simgrid::mc::Snapshot> initial_snapshot_;
34 RemoteApp(RemoteApp const&) = delete;
35 RemoteApp& operator=(RemoteApp const&) = delete;
38 /** Create a new session by executing the provided code in a fork()
40 * This sets up the environment for the model-checked process
41 * (environment variables, sockets, etc.).
43 * The code is expected to `exec` the model-checked application.
45 explicit RemoteApp(const std::vector<char*>& args);
49 void restore_initial_state() const;
50 void wait_for_requests();
52 /** Ask to the application to check for a deadlock. If so, do an error message and throw a DeadlockError. */
53 void check_deadlock() const;
55 /** Ask the application to run post-mortem analysis, and maybe to stop ASAP */
56 void finalize_app(bool terminate_asap = false);
57 /** Forcefully kill the application (after running post-mortem analysis)*/
60 /** Retrieve the max PID of the running actors */
61 unsigned long get_maxpid() const;
63 /* Get the list of actors that are ready to run at that step. Usually shorter than maxpid */
64 void get_actors_status(std::map<aid_t, simgrid::mc::ActorState>& whereto) const;
66 /** Take a transition. A new Transition is created iff the last parameter is true */
67 Transition* handle_simcall(aid_t aid, int times_considered, bool new_transition);
69 /* Get the memory of the remote process */
70 RemoteProcessMemory& get_remote_process_memory() { return checker_side_->get_remote_memory(); }
72 PageStore& get_page_store() { return page_store_; }
74 } // namespace simgrid::mc