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_CHECKER_HPP
7 #define SIMGRID_MC_CHECKER_HPP
9 #include "simgrid/forward.h"
10 #include "src/mc/api/RemoteApp.hpp"
11 #include "src/mc/mc_exit.hpp"
12 #include "src/mc/mc_record.hpp"
13 #include <xbt/Extendable.hpp>
17 namespace simgrid::mc {
19 /** A model-checking exploration algorithm
21 * This is an abstract base class used to group the data, state, configuration
22 * of a model-checking algorithm.
24 * Implementing this interface will probably not be really mandatory,
25 * you might be able to write your model-checking algorithm as plain
26 * imperative code instead.
28 * It is expected to interact with the model-checked application through the
29 * `RemoteApp` interface (that is currently not perfectly sufficient to that extend). */
31 class Exploration : public xbt::Extendable<Exploration> {
32 std::unique_ptr<RemoteApp> remote_app_;
33 static Exploration* instance_;
35 FILE* dot_output_ = nullptr;
38 explicit Exploration(const std::vector<char*>& args, bool need_memory_introspection);
39 virtual ~Exploration();
41 static Exploration* get_instance() { return instance_; }
43 Exploration(Exploration const&) = delete;
44 Exploration& operator=(Exploration const&) = delete;
46 /** Main function of this algorithm */
47 virtual void run() = 0;
49 /** Produce an error message indicating that the application crashed (status was produced by waitpid) */
50 XBT_ATTRIB_NORETURN void report_crash(int status);
51 /** Produce an error message indicating that a property was violated */
52 XBT_ATTRIB_NORETURN void report_assertion_failure();
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: */
58 /** Retrieve the current stack to build an execution trace */
59 virtual RecordTrace get_record_trace() = 0;
61 /** Generate a textual execution trace of the simulated application */
62 std::vector<std::string> get_textual_trace();
64 /** Log additional information about the state of the model-checker */
65 virtual void log_state();
67 RemoteApp& get_remote_app() { return *remote_app_.get(); }
69 /** Print something to the dot output file*/
70 void dot_output(const char* fmt, ...) XBT_ATTRIB_PRINTF(2, 3);
73 // External constructors so that the types (and the types of their content) remain hidden
74 XBT_PUBLIC Exploration* create_liveness_checker(const std::vector<char*>& args);
75 XBT_PUBLIC Exploration* create_dfs_exploration(const std::vector<char*>& args, bool with_dpor);
76 XBT_PUBLIC Exploration* create_communication_determinism_checker(const std::vector<char*>& args, bool with_dpor);
77 XBT_PUBLIC Exploration* create_udpor_checker(const std::vector<char*>& args);
79 } // namespace simgrid::mc