src/mc/api/RemoteApp.hpp

   1 /* Copyright (c) 2016-2023. The SimGrid Team. All rights reserved.          */
   2
   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. */
   5
   6 #ifndef SIMGRID_MC_REMOTE_APP_HPP
   7 #define SIMGRID_MC_REMOTE_APP_HPP
   8
   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"
  14
  15 #include <functional>
  16
  17 namespace simgrid::mc {
  18
  19 /** High-level view of the verified application, from the model-checker POV
  20  *
  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.
  23  *
  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.
  26  */
  27 class XBT_PUBLIC RemoteApp {
  28 private:
  29   std::unique_ptr<CheckerSide> checker_side_;
  30   PageStore page_store_{500};
  31   std::shared_ptr<simgrid::mc::Snapshot> initial_snapshot_;
  32
  33   std::vector<char*> app_args_;
  34
  35   // No copy:
  36   RemoteApp(RemoteApp const&) = delete;
  37   RemoteApp& operator=(RemoteApp const&) = delete;
  38
  39 public:
  40   /** Create a new session by executing the provided code in a fork()
  41    *
  42    *  This sets up the environment for the model-checked process
  43    *  (environment variables, sockets, etc.).
  44    *
  45    *  The code is expected to `exec` the model-checked application.
  46    */
  47   explicit RemoteApp(const std::vector<char*>& args, bool need_memory_introspection);
  48
  49   ~RemoteApp();
  50
  51   void restore_initial_state();
  52   void wait_for_requests();
  53
  54   /** Ask to the application to check for a deadlock. If so, do an error message and throw a DeadlockError. */
  55   void check_deadlock() const;
  56
  57   /** Ask the application to run post-mortem analysis, and maybe to stop ASAP */
  58   void finalize_app(bool terminate_asap = false);
  59   /** Forcefully kill the application (after running post-mortem analysis)*/
  60   void shutdown();
  61
  62   /** Retrieve the max PID of the running actors */
  63   unsigned long get_maxpid() const;
  64
  65   /* Get the list of actors that are ready to run at that step. Usually shorter than maxpid */
  66   void get_actors_status(std::map<aid_t, simgrid::mc::ActorState>& whereto) const;
  67
  68   /** Take a transition. A new Transition is created iff the last parameter is true */
  69   Transition* handle_simcall(aid_t aid, int times_considered, bool new_transition);
  70
  71   /* Get the memory of the remote process */
  72   RemoteProcessMemory& get_remote_process_memory() { return checker_side_->get_remote_memory(); }
  73
  74   PageStore& get_page_store() { return page_store_; }
  75 };
  76 } // namespace simgrid::mc
  77
  78 #endif