Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Rework state's implementation to better support waitany and testany type of transitions
[simgrid.git] / src / mc / private.h
1 /*      $Id: private.h 5497 2008-05-26 12:19:15Z cristianrosa $  */
2
3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
4    All rights reserved.                                          */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #ifndef MC_PRIVATE_H
10 #define MC_PRIVATE_H
11
12 #include <stdio.h>
13 #include <sys/mman.h>
14 #include "mc/mc.h"
15 #include "mc/datatypes.h"
16 #include "xbt/fifo.h"
17 #include "xbt/config.h"
18 #include "xbt/function_types.h"
19 #include "xbt/mmalloc.h"
20 #include "../simix/private.h"
21
22 /****************************** Snapshots ***********************************/
23
24 typedef struct s_mc_mem_region{
25   void *start_addr;
26   void *data;
27   size_t size;
28 } s_mc_mem_region_t, *mc_mem_region_t;
29
30 typedef struct s_mc_snapshot{
31   unsigned int num_reg;
32   mc_mem_region_t *regions;
33 } s_mc_snapshot_t, *mc_snapshot_t;
34
35 void MC_take_snapshot(mc_snapshot_t);
36 void MC_restore_snapshot(mc_snapshot_t);
37 void MC_free_snapshot(mc_snapshot_t);
38
39 /********************************* MC Global **********************************/
40
41 /* Bound of the MC depth-first search algorithm */
42 #define MAX_DEPTH 1000
43
44 int MC_deadlock_check(void);
45 void MC_replay(xbt_fifo_t stack);
46 void MC_wait_for_requests(void);
47 void MC_get_enabled_processes();
48 void MC_show_deadlock(smx_req_t req);
49 void MC_show_stack(xbt_fifo_t stack);
50 void MC_dump_stack(xbt_fifo_t stack);
51
52 /********************************* Requests ***********************************/
53 int MC_request_depend(smx_req_t req1, smx_req_t req2);
54 char* MC_request_to_string(smx_req_t req);
55
56 /********************************** DPOR **************************************/
57 void MC_dpor_init(void);
58 void MC_dpor(void);
59 void MC_dpor_exit(void);
60
61 /******************************** States **************************************/
62 /* Possible exploration status of a process in a state */
63 typedef enum {
64   MC_NOT_INTERLEAVE = 0,    /* Do not interleave (do not execute) */
65   MC_INTERLEAVE,            /* Interleave the process (one or more request) */
66   MC_DONE                   /* Already interleaved */
67 } e_mc_process_state_t;
68
69 /* On every state, each process has an entry of the following type */
70 typedef struct mc_procstate{
71   e_mc_process_state_t state;       /* Exploration control information */
72   unsigned int num_to_interleave;   /* Number of request to interleave */
73   /* If a process has a request with multiple possible responses like a */
74   /* "WaitAny", then the following vector with the indexes to interleave */
75   /* is additionally used. */
76   unsigned int *requests_indexes;   /* Indexes of the requests to interleave */
77 } s_mc_procstate_t, *mc_procstate_t;
78
79 /* An exploration state is composed of: */
80 typedef struct mc_state {
81   unsigned long max_pid;            /* Maximum pid at state's creation time */
82   mc_procstate_t proc_status;       /* State's exploration status by process */
83   s_smx_req_t executed;             /* The executed request of the state */
84 } s_mc_state_t, *mc_state_t;
85
86 extern xbt_fifo_t mc_stack;
87
88 mc_state_t MC_state_new(void);
89 void MC_state_delete(mc_state_t state);
90 void MC_state_add_to_interleave(mc_state_t state, smx_process_t process);
91 unsigned int MC_state_interleave_size(mc_state_t state);
92 int MC_state_process_is_done(mc_state_t state, smx_process_t process);
93 void MC_state_set_executed_request(mc_state_t state, smx_req_t req);
94 smx_req_t MC_state_get_executed_request(mc_state_t state);
95 smx_req_t MC_state_get_request(mc_state_t state, char *value);
96
97 /****************************** Statistics ************************************/
98 typedef struct mc_stats {
99   unsigned long state_size;
100   unsigned long visited_states;
101   unsigned long expanded_states;
102   unsigned long executed_transitions;
103 } s_mc_stats_t, *mc_stats_t;
104
105 extern mc_stats_t mc_stats;
106
107 void MC_print_statistics(mc_stats_t);
108
109 /********************************** MEMORY ******************************/
110 /* The possible memory modes for the modelchecker are standard and raw. */
111 /* Normally the system should operate in std, for switching to raw mode */
112 /* you must wrap the code between MC_SET_RAW_MODE and MC_UNSET_RAW_MODE */
113
114 extern void *std_heap;
115 extern void *raw_heap;
116 int raw_heap_fd;
117 #define STD_HEAP_SIZE   20480000        /* Maximum size of the system's heap */
118
119 /* FIXME: Horrible hack! because the mmalloc library doesn't provide yet of */
120 /* an API to query about the status of a heap, we simply call mmstats and */
121 /* because I now how does structure looks like, then I redefine it here */
122
123 struct mstats {
124   size_t bytes_total;           /* Total size of the heap. */
125   size_t chunks_used;           /* Chunks allocated by the user. */
126   size_t bytes_used;            /* Byte total of user-allocated chunks. */
127   size_t chunks_free;           /* Chunks in the free list. */
128   size_t bytes_free;            /* Byte total of chunks in the free list. */
129 };
130
131 #define MC_SET_RAW_MEM    mmalloc_set_current_heap(raw_heap)
132 #define MC_UNSET_RAW_MEM    mmalloc_set_current_heap(std_heap)
133
134 /******************************* MEMORY MAPPINGS ***************************/
135 /* These functions and data structures implements a binary interface for   */
136 /* the proc maps ascii interface                                           */
137
138 /* Each field is defined as documented in proc's manual page  */
139 typedef struct s_map_region {
140
141   void *start_addr;             /* Start address of the map */
142   void *end_addr;               /* End address of the map */
143   int prot;                     /* Memory protection */
144   int flags;                    /* Aditional memory flags */
145   void *offset;                 /* Offset in the file/whatever */
146   char dev_major;               /* Major of the device */
147   char dev_minor;               /* Minor of the device */
148   unsigned long inode;          /* Inode in the device */
149   char *pathname;               /* Path name of the mapped file */
150
151 } s_map_region;
152
153 typedef struct s_memory_map {
154
155   s_map_region *regions;        /* Pointer to an array of regions */
156   int mapsize;                  /* Number of regions in the memory */
157
158 } s_memory_map_t, *memory_map_t;
159
160 memory_map_t get_memory_map(void);
161
162
163 #endif