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