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