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 {
30 PageStore page_store_{500};
31 std::shared_ptr<simgrid::mc::Snapshot> initial_snapshot_;
33 void* initial_snapshot_ = nullptr; // The code tests it to decide whether to use the refork exec path
35 std::unique_ptr<CheckerSide> checker_side_;
36 std::unique_ptr<CheckerSide> application_factory_; // when no meminfo, create checker_side_ by cloning this one
37 int master_socket_ = -1;
39 const std::vector<char*> app_args_;
42 RemoteApp(RemoteApp const&) = delete;
43 RemoteApp& operator=(RemoteApp const&) = delete;
46 /** Create a new session by executing the provided code in a fork()
48 * This sets up the environment for the model-checked process
49 * (environment variables, sockets, etc.).
51 * The code is expected to `exec` the model-checked application.
53 explicit RemoteApp(const std::vector<char*>& args, bool need_memory_introspection);
57 void restore_initial_state();
58 void wait_for_requests();
60 /** Ask to the application to check for a deadlock. If so, do an error message and throw a DeadlockError. */
61 void check_deadlock() const;
63 /** Ask the application to run post-mortem analysis, and maybe to stop ASAP */
64 void finalize_app(bool terminate_asap = false);
66 /** Retrieve the max PID of the running actors */
67 unsigned long get_maxpid() const;
69 /* Get the list of actors that are ready to run at that step. Usually shorter than maxpid */
70 void get_actors_status(std::map<aid_t, simgrid::mc::ActorState>& whereto) const;
72 /** Take a transition. A new Transition is created iff the last parameter is true */
73 Transition* handle_simcall(aid_t aid, int times_considered, bool new_transition);
76 /* Get the memory of the remote process */
77 RemoteProcessMemory* get_remote_process_memory() { return checker_side_->get_remote_memory(); }
79 PageStore& get_page_store() { return page_store_; }
82 } // namespace simgrid::mc