src/mc/api.hpp

   1 /* Copyright (c) 2020-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_API_HPP
   7 #define SIMGRID_MC_API_HPP
   8
   9 #include <memory>
  10 #include <vector>
  11
  12 #include "simgrid/forward.h"
  13 #include "src/mc/Session.hpp"
  14 #include "src/mc/api/State.hpp"
  15 #include "src/mc/mc_forward.hpp"
  16 #include "src/mc/mc_record.hpp"
  17 #include "xbt/automaton.hpp"
  18 #include "xbt/base.h"
  19
  20 namespace simgrid::mc {
  21
  22 XBT_DECLARE_ENUM_CLASS(ExplorationAlgorithm, Safety, UDPOR, Liveness, CommDeterminism);
  23
  24 /*
  25 ** This class aimes to implement FACADE APIs for simgrid. The FACADE layer sits between the CheckerSide
  26 ** (Unfolding_Checker, DPOR, ...) layer and the
  27 ** AppSide layer. The goal is to drill down into the entagled details in the CheckerSide layer and break down the
  28 ** detailes in a way that the CheckerSide eventually
  29 ** be capable to acquire the required information through the FACADE layer rather than the direct access to the AppSide.
  30 */
  31
  32 class Api {
  33 private:
  34   Api() = default;
  35
  36   struct DerefAndCompareByActorsCountAndUsedHeap {
  37     template <class X, class Y> bool operator()(X const& a, Y const& b) const
  38     {
  39       return std::make_pair(a->actors_count, a->heap_bytes_used) < std::make_pair(b->actors_count, b->heap_bytes_used);
  40     }
  41   };
  42
  43   std::unique_ptr<simgrid::mc::Session> session_;
  44
  45 public:
  46   // No copy:
  47   Api(Api const&) = delete;
  48   void operator=(Api const&) = delete;
  49
  50   static Api& get()
  51   {
  52     static Api api;
  53     return api;
  54   }
  55
  56   simgrid::mc::Exploration* initialize(char** argv, simgrid::mc::ExplorationAlgorithm algo);
  57
  58   // ACTOR APIs
  59   std::vector<simgrid::mc::ActorInformation>& get_actors() const;
  60   unsigned long get_maxpid() const;
  61
  62   // REMOTE APIs
  63   std::size_t get_remote_heap_bytes() const;
  64
  65   // MODEL CHECKER APIs
  66   void mc_inc_visited_states() const;
  67   unsigned long mc_get_visited_states() const;
  68   XBT_ATTRIB_NORETURN void mc_exit(int status) const;
  69
  70   // STATE APIs
  71   void restore_state(const Snapshot* system_state) const;
  72
  73   // SNAPSHOT APIs
  74   bool snapshot_equal(const Snapshot* s1, const Snapshot* s2) const;
  75   simgrid::mc::Snapshot* take_snapshot(long num_state) const;
  76
  77   // SESSION APIs
  78   simgrid::mc::Session const& get_session() const { return *session_; }
  79   void s_close();
  80
  81   // AUTOMATION APIs
  82   void automaton_load(const char* file) const;
  83   std::vector<int> automaton_propositional_symbol_evaluate() const;
  84   std::vector<xbt_automaton_state_t> get_automaton_state() const;
  85   int compare_automaton_exp_label(const xbt_automaton_exp_label* l) const;
  86   void set_property_automaton(xbt_automaton_state_t const& automaton_state) const;
  87   inline DerefAndCompareByActorsCountAndUsedHeap compare_pair() const
  88   {
  89     return DerefAndCompareByActorsCountAndUsedHeap();
  90   }
  91   xbt_automaton_exp_label_t get_automaton_transition_label(xbt_dynar_t const& dynar, int index) const;
  92   xbt_automaton_state_t get_automaton_transition_dst(xbt_dynar_t const& dynar, int index) const;
  93 };
  94
  95 } // namespace simgrid::mc
  96
  97 #endif