src/mc/explo/Exploration.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_CHECKER_HPP
   7 #define SIMGRID_MC_CHECKER_HPP
   8
   9 #include "simgrid/forward.h"
  10 #include "src/mc/api/RemoteApp.hpp"
  11 #include "src/mc/mc_record.hpp"
  12 #include <xbt/Extendable.hpp>
  13
  14 #include <memory>
  15
  16 namespace simgrid::mc {
  17
  18 /** A model-checking exploration algorithm
  19  *
  20  *  This is an abstract base class used to group the data, state, configuration
  21  *  of a model-checking algorithm.
  22  *
  23  *  Implementing this interface will probably not be really mandatory,
  24  *  you might be able to write your model-checking algorithm as plain
  25  *  imperative code instead.
  26  *
  27  *  It is expected to interact with the model-checked application through the
  28  * `RemoteApp` interface (that is currently not perfectly sufficient to that extend). */
  29 // abstract
  30 class Exploration : public xbt::Extendable<Exploration> {
  31   std::unique_ptr<RemoteApp> remote_app_;
  32
  33   FILE* dot_output_ = nullptr;
  34
  35 public:
  36   explicit Exploration(const std::vector<char*>& args);
  37   virtual ~Exploration();
  38
  39   // No copy:
  40   Exploration(Exploration const&) = delete;
  41   Exploration& operator=(Exploration const&) = delete;
  42
  43   /** Main function of this algorithm */
  44   virtual void run() = 0;
  45
  46   /** Produce an error message indicating that the application crashed (status was produced by waitpid) */
  47   void report_crash(int status);
  48   /** Produce an error message indicating that a property was violated */
  49   void report_assertion_failure();
  50
  51   /** Kill the application and the model-checker (which exits with `status`)*/
  52   XBT_ATTRIB_NORETURN void system_exit(int status);
  53
  54   /* These methods are callbacks called by the model-checking engine
  55    * to get and display information about the current state of the
  56    * model-checking algorithm: */
  57
  58   /** Show the current trace/stack
  59    *
  60    *  Could this be handled in the Session/ModelChecker instead? */
  61   virtual RecordTrace get_record_trace() = 0;
  62
  63   /** Generate a textual execution trace of the simulated application */
  64   virtual std::vector<std::string> get_textual_trace() = 0;
  65
  66   /** Log additional information about the state of the model-checker */
  67   virtual void log_state();
  68
  69   RemoteApp& get_remote_app() { return *remote_app_.get(); }
  70
  71   /** Print something to the dot output file*/
  72   void dot_output(const char* fmt, ...) XBT_ATTRIB_PRINTF(2, 3);
  73 };
  74
  75 // External constructors so that the types (and the types of their content) remain hidden
  76 XBT_PUBLIC Exploration* create_liveness_checker(const std::vector<char*>& args);
  77 XBT_PUBLIC Exploration* create_dfs_exploration(const std::vector<char*>& args, bool with_dpor);
  78 XBT_PUBLIC Exploration* create_communication_determinism_checker(const std::vector<char*>& args, bool with_dpor);
  79 XBT_PUBLIC Exploration* create_udpor_checker(const std::vector<char*>& args);
  80
  81 } // namespace simgrid::mc
  82
  83 #endif