src/mc/ModelChecker.hpp

   1 /* Copyright (c) 2007-2022. 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_MODEL_CHECKER_HPP
   7 #define SIMGRID_MC_MODEL_CHECKER_HPP
   8
   9 #include "src/mc/remote/CheckerSide.hpp"
  10 #include "src/mc/remote/RemotePtr.hpp"
  11 #include "src/mc/sosp/PageStore.hpp"
  12 #include "xbt/base.h"
  13
  14 #include <memory>
  15 #include <set>
  16
  17 namespace simgrid::mc {
  18
  19 /** State of the model-checker (global variables for the model checker)
  20  */
  21 class ModelChecker {
  22   CheckerSide checker_side_;
  23   /** String pool for host names */
  24   std::set<std::string, std::less<>> hostnames_;
  25   // This is the parent snapshot of the current state:
  26   PageStore page_store_{500};
  27   std::unique_ptr<RemoteProcess> remote_process_;
  28   Exploration* exploration_ = nullptr;
  29
  30   FILE* dot_output_ = nullptr;
  31
  32   unsigned long visited_states_ = 0;
  33
  34 public:
  35   ModelChecker(ModelChecker const&) = delete;
  36   ModelChecker& operator=(ModelChecker const&) = delete;
  37   explicit ModelChecker(std::unique_ptr<RemoteProcess> remote_simulation, int sockfd);
  38
  39   RemoteProcess& get_remote_process() { return *remote_process_; }
  40   Channel& channel() { return checker_side_.get_channel(); }
  41   PageStore& page_store() { return page_store_; }
  42
  43   std::string const& get_host_name(const char* hostname)
  44   {
  45     return *this->hostnames_.insert(std::string(hostname)).first;
  46   }
  47
  48   void start();
  49   void shutdown();
  50   void resume();
  51   void wait_for_requests();
  52
  53   /** Let the application take a transition. A new Transition is created iff the last parameter is true */
  54   Transition* handle_simcall(aid_t aid, int times_considered, bool new_transition);
  55
  56   /* Interactions with the simcall observer */
  57   XBT_ATTRIB_NORETURN void exit(int status);
  58
  59   void finalize_app(bool terminate_asap = false);
  60
  61   Exploration* get_exploration() const { return exploration_; }
  62   void set_exploration(Exploration* exploration) { exploration_ = exploration; }
  63
  64   unsigned long get_visited_states() const { return visited_states_; }
  65   void inc_visited_states() { visited_states_++; }
  66
  67   void dot_output(const char* fmt, ...) XBT_ATTRIB_PRINTF(2, 3);
  68   void dot_output_flush()
  69   {
  70     if (dot_output_ != nullptr)
  71       fflush(dot_output_);
  72   }
  73   void dot_output_close()
  74   {
  75     if (dot_output_ != nullptr)
  76       fclose(dot_output_);
  77   }
  78
  79 private:
  80   void setup_ignore();
  81   bool handle_message(const char* buffer, ssize_t size);
  82   void handle_waitpid();
  83 };
  84
  85 } // namespace simgrid::mc
  86
  87 #endif