src/mc/mc_state.h

   1 /* Copyright (c) 2007-2014. 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 MC_STATE_H
   8 #define MC_STATE_H
   9
  10 #include <simgrid_config.h>
  11 #include "../simix/smx_private.h"
  12 #include "mc_snapshot.h"
  13
  14 SG_BEGIN_DECL()
  15
  16 extern mc_global_t initial_global_state;
  17
  18 /* Possible exploration status of a process in a state */
  19 typedef enum {
  20   MC_NOT_INTERLEAVE=0,      /* Do not interleave (do not execute) */
  21   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
  22   MC_MORE_INTERLEAVE,       /* Interleave twice the process (for mc_random simcall) */
  23   MC_DONE                   /* Already interleaved */
  24 } e_mc_process_state_t;
  25
  26 /* On every state, each process has an entry of the following type */
  27 typedef struct mc_procstate{
  28   e_mc_process_state_t state;       /* Exploration control information */
  29   unsigned int interleave_count;    /* Number of times that the process was
  30                                        interleaved */
  31 } s_mc_procstate_t, *mc_procstate_t;
  32
  33 /* An exploration state.
  34  *
  35  *  The `executed_state` is sometimes transformed into another `internal_req`.
  36  *  For example WAITANY is transformes into a WAIT and TESTANY into TEST.
  37  *  See `MC_state_set_executed_request()`.
  38  */
  39 typedef struct mc_state {
  40   unsigned long max_pid;            /* Maximum pid at state's creation time */
  41   mc_procstate_t proc_status;       /* State's exploration status by process */
  42   s_smx_synchro_t internal_comm;     /* To be referenced by the internal_req */
  43   s_smx_simcall_t internal_req;         /* Internal translation of request */
  44   s_smx_simcall_t executed_req;         /* The executed request of the state */
  45   int req_num;                      /* The request number (in the case of a
  46                                        multi-request like waitany ) */
  47   mc_snapshot_t system_state;      /* Snapshot of system state */
  48   int num;
  49   int in_visited_states;
  50   // comm determinism verification (xbt_dynar_t<xbt_dynar_t<mc_comm_pattern_t>):
  51   xbt_dynar_t incomplete_comm_pattern;
  52   xbt_dynar_t index_comm; // comm determinism verification
  53 } s_mc_state_t, *mc_state_t;
  54
  55 mc_state_t MC_state_new(void);
  56 void MC_state_delete(mc_state_t state, int free_snapshot);
  57 void MC_state_interleave_process(mc_state_t state, smx_process_t process);
  58 unsigned int MC_state_interleave_size(mc_state_t state);
  59 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
  60 void MC_state_set_executed_request(mc_state_t state, smx_simcall_t req, int value);
  61 smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
  62 smx_simcall_t MC_state_get_internal_request(mc_state_t state);
  63 smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
  64 void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
  65
  66 SG_END_DECL()
  67
  68 #endif