1 /* Copyright (c) 2014-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
12 #include "mc_private.h"
13 #include "mc/datatypes.h"
15 #include "mc_hash.hpp"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_hash, mc, "Logging specific to mc_hash");
23 #define MC_HASH_INIT ((simgrid::mc::hash_type)5381)
26 static void hash_update(hash_type& hash, T const& value)
28 hash = (hash << 5) + hash + (uint64_t) value;
34 typedef struct s_mc_hashing_state {
35 // Set of pointers/addresses already processed (avoid loops):
36 mc_address_set_t handled_addresses;
39 void mc_hash_state_init(mc_hashing_state * state);
40 void mc_hash_state_destroy(mc_hashing_state * state);
42 void mc_hash_state_init(mc_hashing_state * state)
44 state->handled_addresses = mc_address_set_new();
47 void mc_hash_state_destroy(mc_hashing_state * state)
49 mc_address_set_free(&state->handled_addresses);
52 // TODO, detect and avoid loops
54 static bool mc_ignored(const void *address, size_t size)
56 mc_heap_ignore_region_t region;
57 unsigned int cursor = 0;
58 const void *end = (char *) address + size;
59 xbt_dynar_foreach(mc_heap_comparison_ignore, cursor, region) {
60 void *istart = region->address;
61 void *iend = (char *) region->address + region->size;
63 if (address >= istart && address < iend && end >= istart && end < iend)
70 static void mc_hash_binary(hash_type * hash, const void *s, size_t len)
72 const char *p = (const char*) s;
73 for (size_t i = 0; i != len; ++i) {
74 hash_update(*hash, p[i]);
78 /** \brief Compute a hash for a given value of a given type
80 * We try to be very conservative (do not hash too ambiguous things).
82 * \param address address of the variable
83 * \param type type of the variable
85 static void mc_hash_value(hash_type * hash, mc_hashing_state * state,
86 simgrid::mc::ObjectInformation* info, const void *address,
87 simgrid::mc::Type* type)
89 simgrid::mc::Process* process = &mc_model_checker->process();
94 // Not relevant, do nothing:
95 case DW_TAG_unspecified_type:
98 // Simple case, hash this has binary:
99 case DW_TAG_base_type:
100 case DW_TAG_enumeration_type:
102 if (mc_ignored(address, 1))
104 mc_hash_binary(hash, address, type->byte_size);
108 case DW_TAG_array_type:
110 if (mc_ignored(address, type->byte_size))
113 long element_count = type->element_count;
114 simgrid::mc::Type* subtype = type->subtype;
115 if (subtype == NULL) {
116 XBT_DEBUG("Hash array without subtype");
120 for (i = 0; i != element_count; ++i) {
121 XBT_DEBUG("Hash array element %i", i);
122 void *subaddress = ((char *) address) + i * subtype->byte_size;
123 mc_hash_value(hash, state, info, subaddress, subtype);
130 case DW_TAG_volatile_type:
131 case DW_TAG_const_type:
132 case DW_TAG_restrict_type:
134 type = type->subtype;
141 case DW_TAG_structure_type:
142 case DW_TAG_class_type:
144 if (mc_ignored(address, type->byte_size))
147 unsigned int cursor = 0;
148 simgrid::mc::Type* member;
149 xbt_dynar_foreach(type->members, cursor, member) {
150 XBT_DEBUG("Hash struct member %s", member->name);
151 if (type->subtype == NULL)
153 void *member_variable = mc_member_resolve(address, type, member, NULL);
154 mc_hash_value(hash, state, info, member_variable, type->subtype);
159 // Pointer, we hash a single value but it might be an array.
160 case DW_TAG_pointer_type:
161 case DW_TAG_reference_type:
162 case DW_TAG_rvalue_reference_type:
164 if (mc_ignored(address, 1))
167 void *pointed = *(void **) address;
168 if (pointed == NULL) {
169 XBT_DEBUG("Hashed pinter is NULL");
173 if (mc_address_test(state->handled_addresses, pointed)) {
174 XBT_DEBUG("Hashed pointed data %p already hashed", pointed);
177 mc_address_add(state->handled_addresses, pointed);
179 // Anything outside the R/W segments and the heap is not hashed:
180 bool valid_pointer = (pointed >= (void *) binary_info->start_rw
181 && pointed <= (void *) binary_info->end_rw)
182 || (pointed >= (void *) libsimgrid_info->start_rw
183 && pointed <= (void *) libsimgrid_info->end_rw)
184 || (pointed >= process->heap_address
185 && pointed < (void *) ((const char *) process->heap_address + STD_HEAP_SIZE));
186 if (!valid_pointer) {
187 XBT_DEBUG("Hashed pointed data %p is in an ignored range", pointed);
191 if (type->subtype == NULL) {
192 XBT_DEBUG("Missing type for %p (type=%s)",
193 pointed, type->type_id.c_str());
198 type = type->subtype;
203 case DW_TAG_union_type:
204 case DW_TAG_subroutine_type:
210 static void mc_hash_object_globals(hash_type * hash, mc_hashing_state * state,
211 simgrid::mc::ObjectInformation* info)
213 unsigned int cursor = 0;
214 simgrid::mc::Variable* variable;
215 xbt_dynar_foreach(info->global_variables, cursor, variable) {
216 XBT_DEBUG("Hash global variable %s", variable->name);
218 if (variable->type_id == NULL) {
223 simgrid::mc::Type* type = variable->type;
229 const char *address = variable->address;
230 bool valid_pointer = (address >= binary_info->start_rw
231 && address <= binary_info->end_rw)
232 || (address >= libsimgrid_info->start_rw
233 && address <= libsimgrid_info->end_rw)
234 || (address >= (const char *) process->heap_address
235 && address < (const char *) process->heap_address + STD_HEAP_SIZE);
239 mc_hash_value(hash, state, info, variable->address, type);
243 static void mc_hash_stack_frame(mc_hash_t * hash,
244 simgrid::mc::ObjectInformation* info,
245 unw_cursor_t * unw_cursor, simgrid::mc::Frame* frame,
246 char *frame_pointer, mc_hashing_state * state)
251 unsigned int cursor = 0;
252 simgrid::mc::Variable* variable;
253 xbt_dynar_foreach(frame->variables, cursor, variable) {
255 if (variable->type_id == NULL) {
256 XBT_DEBUG("Hash local variable %s without type", variable->name);
259 if (variable->locations.size == 0) {
260 XBT_DEBUG("Hash local variable %s without location", variable->name);
264 XBT_DEBUG("Hash local variable %s", variable->name);
266 void *variable_address =
267 (void *) mc_dwarf_resolve_locations(&variable->locations,
268 variable->object_info, unw_cursor,
269 frame_pointer, NULL);
271 simgrid::mc::Type* type = variable->type;
273 XBT_DEBUG("Hash local variable %s without loctypeation", variable->name);
277 mc_hash_value(hash, state, info, variable_address, type);
280 // TODO, handle nested scopes
283 static void mc_hash_stack(mc_hash_t * hash, mc_snapshot_stack_t stack,
284 mc_hashing_state * state)
288 mc_stack_frame_t stack_frame;
290 for(s_mc_stack_frame_t const& stack_frame : stack->stack_frames) {
292 hash_update(*hash, stack_frame.ip);
294 simgrid::mc::ObjectInformation* info;
295 if (stack_frame.ip >= (unw_word_t) libsimgrid_info->start_exec
296 && stack_frame.ip < (unw_word_t) libsimgrid_info->end_exec)
297 info = libsimgrid_info;
298 else if (stack_frame.ip >= (unw_word_t) binary_info->start_exec
299 && stack_frame.ip < (unw_word_t) binary_info->end_exec)
304 mc_hash_stack_frame(hash, info, &(stack_frame.unw_cursor),
305 stack_frame.frame, (void *) stack_frame.frame_base,
311 static void mc_hash_stacks(mc_hash_t * hash, mc_hashing_state * state,
314 unsigned int cursor = 0;
315 mc_snapshot_stack_t current_stack;
317 hash_update(*hash, xbt_dynar_length(stacks_areas));
320 xbt_dynar_foreach(stacks, cursor, current_stack) {
321 XBT_DEBUG("Stack %i", i);
322 mc_hash_stack(hash, current_stack, state);
328 static hash_type hash(std::vector<s_mc_snapshot_stack_t> const& stacks)
331 mc_hashing_state state;
332 mc_hash_state_init(&state);
335 hash_type hash = MC_HASH_INIT;
337 hash_update(hash, xbt_swag_size(simix_global->process_list));
339 // mc_hash_object_globals(&hash, &state, binary_info);
340 // mc_hash_object_globals(&hash, &state, libsimgrid_info);
341 // mc_hash_stacks(&hash, &state, stacks);
342 mc_hash_state_destroy(&state);
349 hash_type hash(Snapshot const& snapshot)
351 XBT_DEBUG("START hash %i", snapshot.num_state);
352 hash_type res = simgrid::mc::hash(snapshot.stacks);
353 XBT_DEBUG("END hash %i", snapshot.num_state);