-/* Copyright (c) 2007-2012 Da SimGrid Team. All rights reserved. */
+/* Copyright (c) 2007-2014. The SimGrid Team.
+ * All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef MC_PRIVATE_H
#define MC_PRIVATE_H
+#include "simgrid_config.h"
#include <stdio.h>
+#ifndef WIN32
#include <sys/mman.h>
+#endif
+#include <elfutils/libdw.h>
+
#include "mc/mc.h"
#include "mc/datatypes.h"
#include "xbt/fifo.h"
#include "xbt/hash.h"
#include "msg/msg.h"
#include "msg/datatypes.h"
+#include "xbt/strbuff.h"
+#include "xbt/parmap.h"
+
+typedef struct s_dw_frame s_dw_frame_t, *dw_frame_t;
+typedef struct s_mc_function_index_item s_mc_function_index_item_t, *mc_function_index_item_t;
/****************************** Snapshots ***********************************/
+#define NB_REGIONS 3 /* binary data (data + BSS) (type = 2), libsimgrid data (data + BSS) (type = 1), std_heap (type = 0)*/
+
typedef struct s_mc_mem_region{
- int type;
+ // Real address:
void *start_addr;
+ // Copy of the datra:
void *data;
+ // Size of the data region:
size_t size;
} s_mc_mem_region_t, *mc_mem_region_t;
typedef struct s_mc_snapshot{
- unsigned int num_reg;
- mc_mem_region_t *regions;
+ size_t heap_bytes_used;
+ mc_mem_region_t regions[NB_REGIONS];
+ int nb_processes;
+ size_t *stack_sizes;
+ xbt_dynar_t stacks;
+ xbt_dynar_t to_ignore;
+ uint64_t hash;
} s_mc_snapshot_t, *mc_snapshot_t;
-extern char *prog_name;
+/** Information about a given stack frame
+ *
+ */
+typedef struct s_mc_stack_frame {
+ /** Instruction pointer */
+ unw_word_t ip;
+ /** Stack pointer */
+ unw_word_t sp;
+ unw_word_t frame_base;
+ dw_frame_t frame;
+ char* frame_name;
+ unw_cursor_t unw_cursor;
+} s_mc_stack_frame_t, *mc_stack_frame_t;
+
+typedef struct s_mc_snapshot_stack{
+ xbt_dynar_t local_variables;
+ void *stack_pointer;
+ void *real_address;
+ xbt_dynar_t stack_frames; // mc_stack_frame_t
+}s_mc_snapshot_stack_t, *mc_snapshot_stack_t;
+
+typedef struct s_mc_global_t{
+ mc_snapshot_t snapshot;
+ int raw_mem_set;
+ int prev_pair;
+ char *prev_req;
+ int initial_communications_pattern_done;
+ int comm_deterministic;
+ int send_deterministic;
+}s_mc_global_t, *mc_global_t;
+
+typedef struct s_mc_checkpoint_ignore_region{
+ void *addr;
+ size_t size;
+}s_mc_checkpoint_ignore_region_t, *mc_checkpoint_ignore_region_t;
-void MC_take_snapshot(mc_snapshot_t);
-void MC_take_snapshot_liveness(mc_snapshot_t s);
+mc_snapshot_t SIMIX_pre_mc_snapshot(smx_simcall_t simcall);
+mc_snapshot_t MC_take_snapshot(int num_state);
void MC_restore_snapshot(mc_snapshot_t);
void MC_free_snapshot(mc_snapshot_t);
+void* mc_translate_address(uintptr_t addr, mc_snapshot_t snapshot);
+uintptr_t mc_untranslate_address(void* addr, mc_snapshot_t snapshot);
+
+extern xbt_dynar_t mc_checkpoint_ignore;
/********************************* MC Global **********************************/
+
extern double *mc_time;
+extern FILE *dot_output;
+extern const char* colors[13];
+extern xbt_parmap_t parmap;
-/* Bound of the MC depth-first search algorithm */
-#define MAX_DEPTH 1000
-#define MAX_DEPTH_LIVENESS 500
+extern int user_max_depth_reached;
int MC_deadlock_check(void);
void MC_replay(xbt_fifo_t stack, int start);
void MC_replay_liveness(xbt_fifo_t stack, int all_stack);
void MC_wait_for_requests(void);
-void MC_get_enabled_processes();
void MC_show_deadlock(smx_simcall_t req);
void MC_show_stack_safety(xbt_fifo_t stack);
void MC_dump_stack_safety(xbt_fifo_t stack);
+void MC_init(void);
+int SIMIX_pre_mc_random(smx_simcall_t simcall, int min, int max);
+
/********************************* Requests ***********************************/
+
int MC_request_depend(smx_simcall_t req1, smx_simcall_t req2);
char* MC_request_to_string(smx_simcall_t req, int value);
unsigned int MC_request_testany_fail(smx_simcall_t req);
int MC_request_is_enabled(smx_simcall_t req);
int MC_request_is_enabled_by_idx(smx_simcall_t req, unsigned int idx);
int MC_process_is_enabled(smx_process_t process);
+char *MC_request_get_dot_output(smx_simcall_t req, int value);
/******************************** States **************************************/
+
/* Possible exploration status of a process in a state */
typedef enum {
MC_NOT_INTERLEAVE=0, /* Do not interleave (do not execute) */
MC_INTERLEAVE, /* Interleave the process (one or more request) */
+ MC_MORE_INTERLEAVE, /* Interleave twice the process (for mc_random simcall) */
MC_DONE /* Already interleaved */
} e_mc_process_state_t;
int req_num; /* The request number (in the case of a
multi-request like waitany ) */
mc_snapshot_t system_state; /* Snapshot of system state */
+ int num;
} s_mc_state_t, *mc_state_t;
-extern xbt_fifo_t mc_stack_safety_stateless;
-
mc_state_t MC_state_new(void);
void MC_state_delete(mc_state_t state);
void MC_state_interleave_process(mc_state_t state, smx_process_t process);
smx_simcall_t MC_state_get_executed_request(mc_state_t state, int *value);
smx_simcall_t MC_state_get_internal_request(mc_state_t state);
smx_simcall_t MC_state_get_request(mc_state_t state, int *value);
+void MC_state_remove_interleave_process(mc_state_t state, smx_process_t process);
+
/****************************** Statistics ************************************/
+
typedef struct mc_stats {
unsigned long state_size;
unsigned long visited_states;
- unsigned long expanded_states;
- unsigned long executed_transitions;
-} s_mc_stats_t, *mc_stats_t;
-
-typedef struct mc_stats_pair {
- //unsigned long pair_size;
unsigned long visited_pairs;
+ unsigned long expanded_states;
unsigned long expanded_pairs;
unsigned long executed_transitions;
-} s_mc_stats_pair_t, *mc_stats_pair_t;
+} s_mc_stats_t, *mc_stats_t;
extern mc_stats_t mc_stats;
-extern mc_stats_pair_t mc_stats_pair;
void MC_print_statistics(mc_stats_t);
-void MC_print_statistics_pairs(mc_stats_pair_t);
+
/********************************** MEMORY ******************************/
/* The possible memory modes for the modelchecker are standard and raw. */
/* an API to query about the status of a heap, we simply call mmstats and */
/* because I now how does structure looks like, then I redefine it here */
-struct mstats {
- size_t bytes_total; /* Total size of the heap. */
- size_t chunks_used; /* Chunks allocated by the user. */
- size_t bytes_used; /* Byte total of user-allocated chunks. */
- size_t chunks_free; /* Chunks in the free list. */
- size_t bytes_free; /* Byte total of chunks in the free list. */
-};
+/* struct mstats { */
+/* size_t bytes_total; /\* Total size of the heap. *\/ */
+/* size_t chunks_used; /\* Chunks allocated by the user. *\/ */
+/* size_t bytes_used; /\* Byte total of user-allocated chunks. *\/ */
+/* size_t chunks_free; /\* Chunks in the free list. *\/ */
+/* size_t bytes_free; /\* Byte total of chunks in the free list. *\/ */
+/* }; */
#define MC_SET_RAW_MEM mmalloc_set_current_heap(raw_heap)
-#define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
+#define MC_UNSET_RAW_MEM mmalloc_set_current_heap(std_heap)
+
/******************************* MEMORY MAPPINGS ***************************/
/* These functions and data structures implements a binary interface for */
void *start_addr; /* Start address of the map */
void *end_addr; /* End address of the map */
int prot; /* Memory protection */
- int flags; /* Aditional memory flags */
+ int flags; /* Additional memory flags */
void *offset; /* Offset in the file/whatever */
char dev_major; /* Major of the device */
char dev_minor; /* Minor of the device */
} s_memory_map_t, *memory_map_t;
-memory_map_t get_memory_map(void);
+void MC_init_memory_map_info(void);
+memory_map_t MC_get_memory_map(void);
+void MC_free_memory_map(memory_map_t map);
-/********************************** DPOR for safety **************************************/
+extern char *libsimgrid_path;
-void MC_dpor_init(void);
-void MC_dpor(void);
-void MC_dpor_exit(void);
-void MC_init_safety(void);
+/********************************** Snapshot comparison **********************************/
+typedef struct s_mc_comparison_times{
+ double nb_processes_comparison_time;
+ double bytes_used_comparison_time;
+ double stacks_sizes_comparison_time;
+ double binary_global_variables_comparison_time;
+ double libsimgrid_global_variables_comparison_time;
+ double heap_comparison_time;
+ double stacks_comparison_time;
+}s_mc_comparison_times_t, *mc_comparison_times_t;
-/********************************** Double-DFS for liveness property**************************************/
+extern __thread mc_comparison_times_t mc_comp_times;
+extern __thread double mc_snapshot_comparison_time;
-extern mc_snapshot_t initial_snapshot_liveness;
-extern xbt_automaton_t _mc_property_automaton;
+int snapshot_compare(void *state1, void *state2);
+int SIMIX_pre_mc_compare_snapshots(smx_simcall_t simcall, mc_snapshot_t s1, mc_snapshot_t s2);
+void print_comparison_times(void);
-typedef struct s_mc_pair{
- mc_snapshot_t system_state;
- mc_state_t graph_state;
- xbt_state_t automaton_state;
-}s_mc_pair_t, *mc_pair_t;
+//#define MC_DEBUG 1
+#define MC_VERBOSE 1
-typedef struct s_mc_pair_reached{
- int nb;
- xbt_state_t automaton_state;
- xbt_dynar_t prop_ato;
- mc_snapshot_t system_state;
- //xbt_dict_t rdv_points;
-}s_mc_pair_reached_t, *mc_pair_reached_t;
+/********************************** DPOR for safety property **************************************/
+
+typedef enum {
+ e_mc_reduce_unset,
+ e_mc_reduce_none,
+ e_mc_reduce_dpor
+} e_mc_reduce_t;
+
+extern e_mc_reduce_t mc_reduce_kind;
+extern mc_global_t initial_state_safety;
+extern xbt_fifo_t mc_stack_safety;
+extern xbt_dict_t first_enabled_state;
-typedef struct s_mc_pair_visited{
- xbt_state_t automaton_state;
- xbt_dynar_t prop_ato;
+void MC_dpor_init(void);
+void MC_dpor(void);
+
+typedef struct s_mc_visited_state{
mc_snapshot_t system_state;
- int search_cycle;
-}s_mc_pair_visited_t, *mc_pair_visited_t;
+ size_t heap_bytes_used;
+ int nb_processes;
+ int num;
+ int other_num; // dot_output for
+}s_mc_visited_state_t, *mc_visited_state_t;
+
+
+/********************************** Double-DFS for liveness property **************************************/
-typedef struct s_mc_pair_visited_hash{
- xbt_state_t automaton_state;
- xbt_dynar_t prop_ato;
- unsigned int *hash_regions;
+extern xbt_fifo_t mc_stack_liveness;
+extern mc_global_t initial_state_liveness;
+extern xbt_automaton_t _mc_property_automaton;
+extern int compare;
+
+typedef struct s_mc_pair{
+ int num;
int search_cycle;
-}s_mc_pair_visited_hash_t, *mc_pair_visited_hash_t;
-
-typedef struct s_mc_pair_reached_hash{
- xbt_state_t automaton_state;
- xbt_dynar_t prop_ato;
- unsigned int *hash_regions;
-}s_mc_pair_reached_hash_t, *mc_pair_reached_hash_t;
-
-
-
-int MC_automaton_evaluate_label(xbt_exp_label_t l);
-mc_pair_t new_pair(mc_snapshot_t sn, mc_state_t sg, xbt_state_t st);
-
-int reached(xbt_state_t st);
-void set_pair_reached(xbt_state_t st);
-int reached_hash(xbt_state_t st);
-void set_pair_reached_hash(xbt_state_t st);
-int snapshot_compare(mc_snapshot_t s1, mc_snapshot_t s2);
-int data_program_region_compare(void *d1, void *d2, size_t size);
-int data_libsimgrid_region_compare(void *d1, void *d2, size_t size);
-void MC_pair_delete(mc_pair_t pair);
-void MC_exit_liveness(void);
-mc_state_t MC_state_pair_new(void);
-int visited(xbt_state_t st, int search_cycle);
-void set_pair_visited(xbt_state_t st, int search_cycle);
-int visited_hash(xbt_state_t st, int search_cycle);
-void set_pair_visited_hash(xbt_state_t st, int search_cycle);
-unsigned int hash_region(char *str, int str_len);
-int rdv_points_compare(xbt_dict_t d1, xbt_dict_t d2);
-
-/* **** Double-DFS stateless **** */
-
-typedef struct s_mc_pair_stateless{
- mc_state_t graph_state;
- xbt_state_t automaton_state;
+ mc_state_t graph_state; /* System state included */
+ xbt_automaton_state_t automaton_state;
+ xbt_dynar_t atomic_propositions;
int requests;
-}s_mc_pair_stateless_t, *mc_pair_stateless_t;
+}s_mc_pair_t, *mc_pair_t;
-extern xbt_fifo_t mc_stack_liveness;
+typedef struct s_mc_visited_pair{
+ int num;
+ int other_num; /* Dot output for */
+ int acceptance_pair;
+ mc_state_t graph_state; /* System state included */
+ xbt_automaton_state_t automaton_state;
+ xbt_dynar_t atomic_propositions;
+ size_t heap_bytes_used;
+ int nb_processes;
+ int acceptance_removed;
+ int visited_removed;
+}s_mc_visited_pair_t, *mc_visited_pair_t;
+
+mc_pair_t MC_pair_new(void);
+void MC_pair_delete(mc_pair_t);
+void mc_pair_free_voidp(void *p);
+mc_visited_pair_t MC_visited_pair_new(int pair_num, xbt_automaton_state_t automaton_state, xbt_dynar_t atomic_propositions);
+void MC_visited_pair_delete(mc_visited_pair_t p);
-mc_pair_stateless_t new_pair_stateless(mc_state_t sg, xbt_state_t st, int r);
void MC_ddfs_init(void);
-void MC_ddfs(int search_cycle);
+void MC_ddfs(void);
void MC_show_stack_liveness(xbt_fifo_t stack);
void MC_dump_stack_liveness(xbt_fifo_t stack);
-void MC_pair_stateless_delete(mc_pair_stateless_t pair);
-/********************************** Configuration of MC **************************************/
-extern int _surf_do_mc_checkpoint;
-extern xbt_fifo_t mc_stack_safety;
+/********************************** Variables with DWARF **********************************/
+
+#define MC_OBJECT_INFO_EXECUTABLE 1
+
+struct s_mc_object_info {
+ size_t flags;
+ char* file_name;
+ char *start_exec, *end_exec; // Executable segment
+ char *start_rw, *end_rw; // Read-write segment
+ char *start_ro, *end_ro; // read-only segment
+ xbt_dict_t subprograms; // xbt_dict_t<origin as hexadecimal string, dw_frame_t>
+ xbt_dynar_t global_variables; // xbt_dynar_t<dw_variable_t>
+ xbt_dict_t types; // xbt_dict_t<origin as hexadecimal string, dw_type_t>
+ xbt_dict_t full_types_by_name; // xbt_dict_t<name, dw_type_t> (full defined type only)
+
+ // Here we sort the minimal information for an efficient (and cache-efficient)
+ // lookup of a function given an instruction pointer.
+ // The entries are sorted by low_pc and a binary search can be used to look them up.
+ xbt_dynar_t functions_index;
+};
+
+mc_object_info_t MC_new_object_info(void);
+mc_object_info_t MC_find_object_info(memory_map_t maps, char* name, int executable);
+void MC_free_object_info(mc_object_info_t* p);
+
+void MC_dwarf_get_variables(mc_object_info_t info);
+void MC_dwarf_get_variables_libdw(mc_object_info_t info);
+const char* MC_dwarf_attrname(int attr);
+const char* MC_dwarf_tagname(int tag);
+
+dw_frame_t MC_find_function_by_ip(void* ip);
+mc_object_info_t MC_ip_find_object_info(void* ip);
+
+extern mc_object_info_t mc_libsimgrid_info;
+extern mc_object_info_t mc_binary_info;
+extern mc_object_info_t mc_object_infos[2];
+extern size_t mc_object_infos_size;
+
+void MC_find_object_address(memory_map_t maps, mc_object_info_t result);
+void MC_post_process_types(mc_object_info_t info);
+
+// ***** Expressions
+
+/** \brief a DWARF expression with optional validity contraints */
+typedef struct s_mc_expression {
+ size_t size;
+ Dwarf_Op* ops;
+ // Optional validity:
+ void* lowpc, *highpc;
+} s_mc_expression_t, *mc_expression_t;
+
+/** A location list (list of location expressions) */
+typedef struct s_mc_location_list {
+ size_t size;
+ mc_expression_t locations;
+} s_mc_location_list_t, *mc_location_list_t;
+
+Dwarf_Off mc_dwarf_resolve_location(mc_expression_t expression, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot);
+Dwarf_Off mc_dwarf_resolve_locations(mc_location_list_t locations, unw_cursor_t* c, void* frame_pointer_address, mc_snapshot_t snapshot);
+
+void mc_dwarf_expression_clear(mc_expression_t expression);
+void mc_dwarf_expression_init(mc_expression_t expression, size_t len, Dwarf_Op* ops);
+
+void mc_dwarf_location_list_clear(mc_location_list_t list);
+
+void mc_dwarf_location_list_init_from_expression(mc_location_list_t target, size_t len, Dwarf_Op* ops);
+void mc_dwarf_location_list_init(mc_location_list_t target, mc_object_info_t info, Dwarf_Die* die, Dwarf_Attribute* attr);
+
+// ***** Variables and functions
+
+struct s_dw_type{
+ e_dw_type_type type;
+ void *id; /* Offset in the section (in hexadecimal form) */
+ char *name; /* Name of the type */
+ int byte_size; /* Size in bytes */
+ int element_count; /* Number of elements for array type */
+ char *dw_type_id; /* DW_AT_type id */
+ xbt_dynar_t members; /* if DW_TAG_structure_type, DW_TAG_class_type, DW_TAG_union_type*/
+ int is_pointer_type;
+ // Location (for members) is either of:
+ struct s_mc_expression location;
+ int offset;
+
+ dw_type_t subtype; // DW_AT_type
+ dw_type_t full_type; // The same (but more complete) type
+};
+
+void* mc_member_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot);
+void* mc_member_snapshot_resolve(const void* base, dw_type_t type, dw_type_t member, mc_snapshot_t snapshot);
+
+typedef struct s_dw_variable{
+ Dwarf_Off dwarf_offset; /* Global offset of the field. */
+ int global;
+ char *name;
+ char *type_origin;
+ dw_type_t type;
+
+ // Use either of:
+ s_mc_location_list_t locations;
+ void* address;
+
+ size_t start_scope;
+
+}s_dw_variable_t, *dw_variable_t;
+
+struct s_dw_frame{
+ char *name;
+ void *low_pc;
+ void *high_pc;
+ s_mc_location_list_t frame_base;
+ xbt_dynar_t /* <dw_variable_t> */ variables; /* Cannot use dict, there may be several variables with the same name (in different lexical blocks)*/
+ unsigned long int start; /* DWARF offset of the subprogram */
+ unsigned long int end; /* Dwarf offset of the next sibling */
+};
+
+struct s_mc_function_index_item {
+ void* low_pc, *high_pc;
+ dw_frame_t function;
+};
+
+void mc_frame_free(dw_frame_t freme);
+
+void dw_type_free(dw_type_t t);
+void dw_variable_free(dw_variable_t v);
+void dw_variable_free_voidp(void *t);
+
+void MC_dwarf_register_global_variable(mc_object_info_t info, dw_variable_t variable);
+void MC_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
+void MC_dwarf_register_non_global_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
+void MC_dwarf_register_variable(mc_object_info_t info, dw_frame_t frame, dw_variable_t variable);
+void* MC_object_base_address(mc_object_info_t info);
+
+/********************************** DWARF **********************************/
+
+#define MC_EXPRESSION_STACK_SIZE 64
+
+#define MC_EXPRESSION_OK 0
+#define MC_EXPRESSION_E_UNSUPPORTED_OPERATION 1
+#define MC_EXPRESSION_E_STACK_OVERFLOW 2
+#define MC_EXPRESSION_E_STACK_UNDERFLOW 3
+#define MC_EXPRESSION_E_MISSING_STACK_CONTEXT 4
+#define MC_EXPRESSION_E_MISSING_FRAME_BASE 5
+
+typedef struct s_mc_expression_state {
+ uintptr_t stack[MC_EXPRESSION_STACK_SIZE];
+ size_t stack_size;
+
+ unw_cursor_t* cursor;
+ void* frame_base;
+ mc_snapshot_t snapshot;
+} s_mc_expression_state_t, *mc_expression_state_t;
+
+int mc_dwarf_execute_expression(size_t n, const Dwarf_Op* ops, mc_expression_state_t state);
+
+void* mc_find_frame_base(dw_frame_t frame, unw_cursor_t* unw_cursor);
+
+/********************************** Miscellaneous **********************************/
+
+typedef struct s_local_variable{
+ char *frame;
+ unsigned long ip;
+ char *name;
+ dw_type_t type;
+ void *address;
+ int region;
+}s_local_variable_t, *local_variable_t;
+
+/********************************* Communications pattern ***************************/
+
+typedef struct s_mc_comm_pattern{
+ int num;
+ smx_action_t comm;
+ e_smx_comm_type_t type;
+ int completed;
+ unsigned long src_proc;
+ unsigned long dst_proc;
+ const char *src_host;
+ const char *dst_host;
+ char *rdv;
+ size_t data_size;
+ void *data;
+ int matched_comm;
+}s_mc_comm_pattern_t, *mc_comm_pattern_t;
+
+extern xbt_dynar_t communications_pattern;
+
+void get_comm_pattern(xbt_dynar_t communications_pattern, smx_simcall_t request, int call);
+
+/* *********** Sets *********** */
+
+typedef struct s_mc_address_set *mc_address_set_t;
+
+mc_address_set_t mc_address_set_new();
+void mc_address_set_free(mc_address_set_t* p);
+void mc_address_add(mc_address_set_t p, const void* value);
+bool mc_address_test(mc_address_set_t p, const void* value);
+
+/* *********** Hash *********** */
+
+/** \brief Hash the current state
+ * \param num_state number of states
+ * \param stacks stacks (mc_snapshot_stak_t) used fot the stack unwinding informations
+ * \result resulting hash
+ * */
+uint64_t mc_hash_processes_state(int num_state, xbt_dynar_t stacks);
#endif
+
