-/* Copyright (c) 2016-2022. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2016-2023. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef SIMGRID_MC_CHECKER_HPP
#define SIMGRID_MC_CHECKER_HPP
-#include "src/mc/api.hpp"
+#include "simgrid/forward.h"
+#include "src/mc/api/RemoteApp.hpp"
+#include "src/mc/mc_config.hpp"
+#include "src/mc/mc_exit.hpp"
+#include "src/mc/mc_record.hpp"
+#include <xbt/Extendable.hpp>
+
+#include <memory>
namespace simgrid::mc {
* you might be able to write your model-checking algorithm as plain
* imperative code instead.
*
- * It is expected to interact with the model-checking core through the
- * `Session` interface (but currently the `Session` interface does not
- * have all the necessary features). */
+ * It is expected to interact with the model-checked application through the
+ * `RemoteApp` interface (that is currently not perfectly sufficient to that extend). */
// abstract
class Exploration : public xbt::Extendable<Exploration> {
- Session* session_;
+ std::unique_ptr<RemoteApp> remote_app_;
+ static Exploration* instance_;
+
+ FILE* dot_output_ = nullptr;
public:
- explicit Exploration(Session* session) : session_(session) {}
+ explicit Exploration(const std::vector<char*>& args, bool need_memory_introspection);
+ virtual ~Exploration();
+ static Exploration* get_instance() { return instance_; }
// No copy:
- Exploration(Exploration const&) = delete;
+ Exploration(Exploration const&) = delete;
Exploration& operator=(Exploration const&) = delete;
- virtual ~Exploration() = default;
-
/** Main function of this algorithm */
virtual void run() = 0;
+ /** Produce an error message indicating that the application crashed (status was produced by waitpid) */
+ XBT_ATTRIB_NORETURN void report_crash(int status);
+ /** Produce an error message indicating that a property was violated */
+ XBT_ATTRIB_NORETURN void report_assertion_failure();
+
/* These methods are callbacks called by the model-checking engine
* to get and display information about the current state of the
* model-checking algorithm: */
- /** Show the current trace/stack
- *
- * Could this be handled in the Session/ModelChecker instead? */
+ /** Retrieve the current stack to build an execution trace */
virtual RecordTrace get_record_trace() = 0;
/** Generate a textual execution trace of the simulated application */
- virtual std::vector<std::string> get_textual_trace() = 0;
+ std::vector<std::string> get_textual_trace();
/** Log additional information about the state of the model-checker */
- virtual void log_state() = 0;
+ virtual void log_state();
+
+ RemoteApp& get_remote_app() { return *remote_app_.get(); }
- Session& get_session() { return *session_; }
+ /** Print something to the dot output file*/
+ void dot_output(const char* fmt, ...) XBT_ATTRIB_PRINTF(2, 3);
};
// External constructors so that the types (and the types of their content) remain hidden
-XBT_PUBLIC Exploration* create_liveness_checker(Session* session);
-XBT_PUBLIC Exploration* create_dfs_exploration(Session* session);
-XBT_PUBLIC Exploration* create_communication_determinism_checker(Session* session);
-XBT_PUBLIC Exploration* create_udpor_checker(Session* session);
+XBT_PUBLIC Exploration* create_liveness_checker(const std::vector<char*>& args);
+XBT_PUBLIC Exploration* create_dfs_exploration(const std::vector<char*>& args, ReductionMode mode);
+XBT_PUBLIC Exploration* create_communication_determinism_checker(const std::vector<char*>& args, ReductionMode mode);
+XBT_PUBLIC Exploration* create_udpor_checker(const std::vector<char*>& args);
} // namespace simgrid::mc