1 /* Copyright (c) 2007-2017. 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_STATE_H
7 #define SIMGRID_MC_STATE_H
12 #include "src/mc/mc_snapshot.h"
13 #include "src/mc/mc_record.h"
14 #include "src/mc/Transition.hpp"
19 enum class PatternCommunicationType {
25 class PatternCommunication {
28 simgrid::kernel::activity::CommImpl* comm_addr;
29 PatternCommunicationType type = PatternCommunicationType::send;
30 unsigned long src_proc = 0;
31 unsigned long dst_proc = 0;
32 const char *src_host = nullptr;
33 const char *dst_host = nullptr;
35 std::vector<char> data;
39 PatternCommunication()
41 std::memset(&comm_addr, 0, sizeof(comm_addr));
44 PatternCommunication dup() const
46 simgrid::mc::PatternCommunication res;
48 res.comm_addr = this->comm_addr;
49 res.type = this->type;
52 res.dst_proc = this->dst_proc;
53 res.dst_host = this->dst_host;
55 res.data = this->data;
57 res.index = this->index;
63 /* On every state, each process has an entry of the following type.
64 * This represents both the process and its transition because
65 * a process cannot have more than one enabled transition at a given time.
68 /* Possible exploration status of a process transition in a state.
69 * Either the checker did not consider the transition, or it was considered and to do, or considered and done.
71 enum class InterleavingType {
72 /** This process transition is not considered by the checker (yet?) */
74 /** The checker algorithm decided that this process transitions should be done at some point */
76 /** The checker algorithm decided that this should be done, but it was done in the meanwhile */
80 /** Exploration control information */
81 InterleavingType state = InterleavingType::disabled;
83 /** Number of times that the process was considered to be executed */
84 // TODO, make this private
85 unsigned int times_considered = 0;
87 bool isDisabled() const {
88 return this->state == InterleavingType::disabled;
91 return this->state == InterleavingType::done;
94 return this->state == InterleavingType::todo;
96 /** Mark that we should try executing this process at some point in the future of the checker algorithm */
98 this->state = InterleavingType::todo;
99 this->times_considered = 0;
102 this->state = InterleavingType::done;
106 /* A node in the exploration graph (kind-of)
108 class XBT_PRIVATE State {
110 /** Sequential state number (used for debugging) */
113 /** State's exploration status by process */
114 std::vector<ProcessState> actorStates;
116 Transition transition;
118 /** The simcall which was executed, going out of that state */
119 s_smx_simcall_t executed_req;
121 /* Internal translation of the executed_req simcall
123 * SIMCALL_COMM_TESTANY is translated to a SIMCALL_COMM_TEST
124 * and SIMCALL_COMM_WAITANY to a SIMCALL_COMM_WAIT.
126 s_smx_simcall_t internal_req;
128 /* Can be used as a copy of the remote synchro object */
129 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> internal_comm;
131 /** Snapshot of system state (if needed) */
132 std::shared_ptr<simgrid::mc::Snapshot> system_state;
134 // For CommunicationDeterminismChecker
135 std::vector<std::vector<simgrid::mc::PatternCommunication>> incomplete_comm_pattern;
136 std::vector<unsigned> communicationIndices;
138 State(unsigned long state_number);
140 std::size_t interleaveSize() const;
141 void addInterleavingSet(smx_actor_t actor) { this->actorStates[actor->pid].consider(); }
142 Transition getTransition() const;
148 XBT_PRIVATE smx_simcall_t MC_state_get_request(simgrid::mc::State* state);