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
  25 namespace simgrid {
  26 namespace mc {
  27
  28 /** An element in the recorded path
  29  *
  30  *  At each decision point, we need to record which process transition
  31  *  is trigerred and potentially which value is associated with this
  32  *  transition. The value is used to find which communication is triggerred
  33  *  in things like waitany and for associating a given value of MC_random()
  34  *  calls.
  35  */
  36 struct RecordTraceElement {
  37   int pid = 0;
  38   int value = 0;
  39   RecordTraceElement() {}
  40   RecordTraceElement(int pid, int value) : pid(pid), value(value) {}
  41 };
  42
  43 typedef std::vector<RecordTraceElement> RecordTrace;
  44
  45 /** Convert a string representation of the path into a array of `simgrid::mc::RecordTraceElement`
  46  */
  47 XBT_PRIVATE RecordTrace parseRecordTrace(const char* data);
  48 XBT_PRIVATE std::string traceToString(simgrid::mc::RecordTrace const& trace);
  49 XBT_PRIVATE void dumpRecordPath();
  50
  51 XBT_PRIVATE void replay(RecordTrace const& trace);
  52 XBT_PRIVATE void replay(const char* trace);
  53
  54 }
  55 }
  56
  57 SG_BEGIN_DECL()
  58
  59 /** Whether the MC record mode is enabled
  60  *
  61  *  The behaviour is not changed. The only real difference is that
  62  *  the path is writtent in the log when an interesting path is found.
  63  */
  64 #define MC_record_is_active() _sg_do_model_check_record
  65
  66 // **** Data conversion
  67
  68 SG_END_DECL()
  69
  70 #endif