Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
dbe0e8674cf4249377dc654644d21216313b5819
[simgrid.git] / src / mc / mc_record.h
1 /* Copyright (c) 2014-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 /** \file
8  *  This file contains the MC replay/record functionnality.
9  *  A MC path may be recorded by using ``-cfg=model-check/record:1`'`.
10  *  The path is written in the log output and an be replayed with MC disabled
11  *  (even with an non-LC build) with `--cfg=model-check/replay:$replayPath`.
12  *
13  *  The same version of Simgrid should be used and the same arguments should be
14  *  passed to the application (without the MC specific arguments).
15  */
16
17 #ifndef SIMGRID_MC_RECORD_H
18 #define SIMGRID_MC_RECORD_H
19
20 #include <string>
21 #include <vector>
22
23 #include <xbt/base.h>
24 #include <xbt/dynar.h>
25
26 namespace simgrid {
27 namespace mc {
28
29 /** An element in the recorded path
30  *
31  *  At each decision point, we need to record which process transition
32  *  is trigerred and potentially which value is associated with this
33  *  transition. The value is used to find which communication is triggerred
34  *  in things like waitany and for associating a given value of MC_random()
35  *  calls.
36  */
37 struct RecordTraceElement {
38   int pid = 0;
39   int value = 0;
40   RecordTraceElement() {}
41   RecordTraceElement(int pid, int value) : pid(pid), value(value) {}
42 };
43
44 typedef std::vector<RecordTraceElement> RecordTrace;
45
46 /** Convert a string representation of the path into a array of `simgrid::mc::RecordTraceElement`
47  */
48 XBT_PRIVATE RecordTrace parseRecordTrace(const char* data);
49 XBT_PRIVATE std::string traceToString(simgrid::mc::RecordTrace const& trace);
50 XBT_PRIVATE void dumpRecordPath();
51
52 XBT_PRIVATE void replay(RecordTrace const& trace);
53 XBT_PRIVATE void replay(const char* trace);
54
55 }
56 }
57
58 SG_BEGIN_DECL()
59
60 /** Whether the MC record mode is enabled
61  *
62  *  The behaviour is not changed. The only real difference is that
63  *  the path is writtent in the log when an interesting path is found.
64  */
65 #define MC_record_is_active() _sg_do_model_check_record
66
67 // **** Data conversion
68
69 SG_END_DECL()
70
71 #endif