Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Avoid unsafe things
[simgrid.git] / src / mc / mc_state.h
1 /* Copyright (c) 2007-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #ifndef SIMGRID_MC_STATE_H
8 #define SIMGRID_MC_STATE_H
9
10 #include <list>
11 #include <memory>
12
13 #include <xbt/base.h>
14 #include <xbt/dynar.h>
15
16 #include <simgrid_config.h>
17 #include "src/simix/smx_private.h"
18 #include "src/kernel/activity/SynchroIo.hpp"
19 #include "src/kernel/activity/SynchroComm.hpp"
20 #include "src/kernel/activity/SynchroRaw.hpp"
21 #include "src/kernel/activity/SynchroSleep.hpp"
22 #include "src/kernel/activity/SynchroExec.hpp"
23 #include "src/mc/mc_snapshot.h"
24 #include "src/mc/mc_record.h"
25 #include "src/mc/Transition.hpp"
26
27 namespace simgrid {
28 namespace mc {
29
30 enum class PatternCommunicationType {
31   none = 0,
32   send = 1,
33   receive = 2,
34 };
35
36 struct PatternCommunication {
37   int num = 0;
38   smx_activity_t comm_addr;
39   PatternCommunicationType type = PatternCommunicationType::send;
40   unsigned long src_proc = 0;
41   unsigned long dst_proc = 0;
42   const char *src_host = nullptr;
43   const char *dst_host = nullptr;
44   std::string rdv;
45   std::vector<char> data;
46   int tag = 0;
47   int index = 0;
48
49   PatternCommunication()
50   {
51     std::memset(&comm_addr, 0, sizeof(comm_addr));
52   }
53
54   PatternCommunication dup() const
55   {
56     simgrid::mc::PatternCommunication res;
57     // num?
58     res.comm_addr = this->comm_addr;
59     res.type = this->type;
60     // src_proc?
61     // dst_proc?
62     res.dst_proc = this->dst_proc;
63     res.dst_host = this->dst_host;
64     res.rdv = this->rdv;
65     res.data = this->data;
66     // tag?
67     res.index = this->index;
68     return res;
69   }
70
71 };
72
73 /* On every state, each process has an entry of the following type.
74  * This represents both the process and its transition because
75  *   a process cannot have more than one enabled transition at a given time.
76  */
77 class ProcessState {
78   /* Possible exploration status of a process transition in a state.
79    * Either the checker did not consider the transition, or it was considered and to do, or considered and done.
80    */
81   enum class InterleavingType {
82     /** This process transition is not considered by the checker (yet?) */
83     disabled = 0,
84     /** The checker algorithm decided that this process transitions should be done at some point */
85     todo,
86     /** The checker algorithm decided that this should be done, but it was done in the meanwhile */
87     done,
88   };
89
90   /** Exploration control information */
91   InterleavingType state = InterleavingType::disabled;
92 public:
93   /** Number of times that the process was considered to be executed */
94   // TODO, make this private
95   unsigned int times_considered = 0;
96
97   bool isDisabled() const {
98     return this->state == InterleavingType::disabled;
99   }
100   bool isDone() const {
101     return this->state == InterleavingType::done;
102   }
103   bool isTodo() const {
104     return this->state == InterleavingType::todo;
105   }
106   /** Mark that we should try executing this process at some point in the future of the checker algorithm */
107   void consider() {
108     this->state            = InterleavingType::todo;
109     this->times_considered = 0;
110   }
111   void setDone() {
112     this->state = InterleavingType::done;
113   }
114 };
115
116 /* A node in the exploration graph (kind-of)
117  */
118 struct XBT_PRIVATE State {
119
120   /** Sequential state number (used for debugging) */
121   int num = 0;
122
123   /** State's exploration status by process */
124   std::vector<ProcessState> actorStates;
125
126   Transition transition;
127
128   /** The simcall which was executed, going out of that state */
129   s_smx_simcall_t executed_req;
130
131   /* Internal translation of the executed_req simcall
132    *
133    * SIMCALL_COMM_TESTANY is translated to a SIMCALL_COMM_TEST
134    * and SIMCALL_COMM_WAITANY to a SIMCALL_COMM_WAIT.
135    */
136   s_smx_simcall_t internal_req;
137
138   /* Can be used as a copy of the remote synchro object */
139   simgrid::mc::Remote<simgrid::kernel::activity::Comm> internal_comm;
140
141   /** Snapshot of system state (if needed) */
142   std::shared_ptr<simgrid::mc::Snapshot> system_state;
143
144   // For CommunicationDeterminismChecker
145   std::vector<std::vector<simgrid::mc::PatternCommunication>> incomplete_comm_pattern;
146   std::vector<unsigned> communicationIndices;
147
148   State(unsigned long state_number);
149
150   std::size_t interleaveSize() const;
151   void interleave(smx_actor_t actor) {
152     this->actorStates[actor->pid].consider();
153   }
154   Transition getTransition() const;
155 };
156
157 }
158 }
159
160 XBT_PRIVATE smx_simcall_t MC_state_get_request(simgrid::mc::State* state);
161
162 #endif