1 /* Copyright (c) 2016-2020. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #ifndef SIMGRID_MC_CHECKER_HPP
8 #define SIMGRID_MC_CHECKER_HPP
10 #include "src/mc/mc_api.hpp"
15 /** A model-checking algorithm
17 * This is an abstract base class used to group the data, state, configuration
18 * of a model-checking algorithm.
20 * Implementing this interface will probably not be really mandatory,
21 * you might be able to write your model-checking algorithm as plain
22 * imperative code instead.
24 * It is expected to interact with the model-checking core through the
25 * `Session` interface (but currently the `Session` interface does not
26 * have all the necessary features). */
30 inline explicit Checker() { mc_api::get().set_checker(this); }
33 Checker(Checker const&) = delete;
34 Checker& operator=(Checker const&) = delete;
36 virtual ~Checker() = default;
38 /** Main function of this algorithm */
39 virtual void run() = 0;
41 /* These methods are callbacks called by the model-checking engine
42 * to get and display information about the current state of the
43 * model-checking algorithm: */
45 /** Show the current trace/stack
47 * Could this be handled in the Session/ModelChecker instead? */
48 virtual RecordTrace get_record_trace() = 0;
50 /** Generate a textual execution trace of the simulated application */
51 virtual std::vector<std::string> get_textual_trace() = 0;
53 /** Log additional information about the state of the model-checker */
54 virtual void log_state() = 0;
57 // External constructors so that the types (and the types of their content) remain hidden
58 XBT_PUBLIC Checker* createLivenessChecker();
59 XBT_PUBLIC Checker* createSafetyChecker();
60 XBT_PUBLIC Checker* createCommunicationDeterminismChecker();
63 } // namespace simgrid