3 FuncNode::FuncNode(ModelHistory * history) :
5 predicate_tree_initialized(false),
10 predicate_tree_position()
12 predicate_tree_entry = new Predicate(NULL, true);
13 predicate_tree_entry->add_predicate_expr(NOPREDICATE, NULL, true);
15 // memories that are reclaimed after each execution
16 action_list_buffer = new SnapList<action_list_t *>();
17 read_locations = new loc_set_t();
18 val_loc_map = new HashTable<uint64_t, loc_set_t *, uint64_t, 0>();
19 loc_may_equal_map = new HashTable<void *, loc_set_t *, uintptr_t, 0>();
20 thrd_inst_act_map = new SnapVector<inst_act_map_t *>();
22 //values_may_read_from = new value_set_t();
25 /* Reallocate snapshotted memories when new executions start */
26 void FuncNode::set_new_exec_flag()
28 for (mllnode<FuncInst *> * it = inst_list.begin(); it != NULL; it = it->getNext()) {
29 FuncInst * inst = it->getVal();
30 inst->unset_location();
33 action_list_buffer = new SnapList<action_list_t *>();
34 read_locations = new loc_set_t();
35 val_loc_map = new HashTable<uint64_t, loc_set_t *, uint64_t, 0>();
36 loc_may_equal_map = new HashTable<void *, loc_set_t *, uintptr_t, 0>();
37 thrd_inst_act_map = new SnapVector<inst_act_map_t *>();
39 //values_may_read_from = new value_set_t();
42 /* Check whether FuncInst with the same type, position, and location
43 * as act has been added to func_inst_map or not. If not, add it.
45 * Note: currently, actions with the same position are filtered out by process_action,
46 * so the collision list of FuncInst is not used. May remove it later.
48 void FuncNode::add_inst(ModelAction *act)
51 const char * position = act->get_position();
53 /* THREAD* actions, ATOMIC_LOCK, ATOMIC_TRYLOCK, and ATOMIC_UNLOCK
54 * actions are not tagged with their source line numbers
59 if ( func_inst_map.contains(position) ) {
60 FuncInst * inst = func_inst_map.get(position);
62 ASSERT(inst->get_type() == act->get_type());
64 // locations are set to NULL when new executions start
65 if (inst->get_location() == NULL)
66 inst->set_location(act->get_location());
68 if (inst->get_location() != act->get_location())
69 inst->not_single_location();
74 FuncInst * func_inst = new FuncInst(act, this);
76 func_inst_map.put(position, func_inst);
77 inst_list.push_back(func_inst);
80 /* Get the FuncInst with the same type, position, and location
83 * @return FuncInst with the same type, position, and location as act */
84 FuncInst * FuncNode::get_inst(ModelAction *act)
87 const char * position = act->get_position();
89 /* THREAD* actions, ATOMIC_LOCK, ATOMIC_TRYLOCK, and ATOMIC_UNLOCK
90 * actions are not tagged with their source line numbers
95 FuncInst * inst = func_inst_map.get(position);
99 action_type inst_type = inst->get_type();
100 action_type act_type = act->get_type();
102 // else if branch: an RMWRCAS action is converted to a RMW or READ action
103 if (inst_type == act_type)
105 else if (inst_type == ATOMIC_RMWRCAS &&
106 (act_type == ATOMIC_RMW || act_type == ATOMIC_READ))
113 void FuncNode::add_entry_inst(FuncInst * inst)
118 mllnode<FuncInst *> * it;
119 for (it = entry_insts.begin(); it != NULL; it = it->getNext()) {
120 if (inst == it->getVal())
124 entry_insts.push_back(inst);
128 * @brief Convert ModelAdtion list to FuncInst list
129 * @param act_list A list of ModelActions
131 void FuncNode::update_tree(action_list_t * act_list)
133 if (act_list == NULL || act_list->size() == 0)
136 HashTable<void *, value_set_t *, uintptr_t, 4> * write_history = history->getWriteHistory();
138 /* build inst_list from act_list for later processing */
139 func_inst_list_t inst_list;
140 action_list_t rw_act_list;
142 for (sllnode<ModelAction *> * it = act_list->begin(); it != NULL; it = it->getNext()) {
143 ModelAction * act = it->getVal();
144 FuncInst * func_inst = get_inst(act);
146 if (func_inst == NULL)
149 inst_list.push_back(func_inst);
151 /* NOTE: for rmw actions, func_inst and act may have different
152 * action types because of action type conversion in ModelExecution
153 * func_inst->is_write() <==> pure writes (excluding rmw) */
154 if (func_inst->is_write()) {
155 // model_print("write detected\n");
156 rw_act_list.push_back(act);
159 /* func_inst->is_read() <==> read + rmw */
160 if (func_inst->is_read()) {
161 rw_act_list.push_back(act);
162 /* If func_inst may only read_from a single location, then:
164 * The first time an action reads from some location,
165 * import all the values that have been written to this
166 * location from ModelHistory and notify ModelHistory
167 * that this FuncNode may read from this location.
169 void * loc = act->get_location();
170 if (!read_locations->contains(loc) && func_inst->is_single_location()) {
171 read_locations->add(loc);
172 value_set_t * write_values = write_history->get(loc);
173 add_to_val_loc_map(write_values, loc);
174 history->add_to_loc_func_nodes_map(loc, this);
179 // model_print("function %s\n", func_name);
180 // print_val_loc_map();
182 update_inst_tree(&inst_list);
183 update_predicate_tree(&rw_act_list);
185 // print_predicate_tree();
189 * @brief Link FuncInsts in inst_list - add one FuncInst to another's predecessors and successors
190 * @param inst_list A list of FuncInsts
192 void FuncNode::update_inst_tree(func_inst_list_t * inst_list)
194 if (inst_list == NULL)
196 else if (inst_list->size() == 0)
200 sllnode<FuncInst *>* it = inst_list->begin();
201 sllnode<FuncInst *>* prev;
203 /* add the first instruction to the list of entry insts */
204 FuncInst * entry_inst = it->getVal();
205 add_entry_inst(entry_inst);
209 prev = it->getPrev();
211 FuncInst * prev_inst = prev->getVal();
212 FuncInst * curr_inst = it->getVal();
214 prev_inst->add_succ(curr_inst);
215 curr_inst->add_pred(prev_inst);
221 void FuncNode::update_predicate_tree(action_list_t * act_list)
223 if (act_list == NULL || act_list->size() == 0)
226 /* map a FuncInst to the its predicate */
227 HashTable<FuncInst *, Predicate *, uintptr_t, 0> inst_pred_map(128);
229 // number FuncInsts to detect loops
230 HashTable<FuncInst *, uint32_t, uintptr_t, 0> inst_id_map(128);
231 uint32_t inst_counter = 0;
233 HashTable<void *, ModelAction *, uintptr_t, 0> loc_act_map(128);
234 HashTable<FuncInst *, ModelAction *, uintptr_t, 0> inst_act_map(128);
236 sllnode<ModelAction *> *it = act_list->begin();
237 Predicate * curr_pred = predicate_tree_entry;
239 ModelAction * next_act = it->getVal();
240 FuncInst * next_inst = get_inst(next_act);
242 SnapVector<Predicate *> unset_predicates = SnapVector<Predicate *>();
243 bool branch_found = follow_branch(&curr_pred, next_inst, next_act, &inst_act_map, &unset_predicates);
245 // A branch with unset predicate expression is detected
246 if (!branch_found && unset_predicates.size() != 0) {
247 ASSERT(unset_predicates.size() == 1);
248 Predicate * one_branch = unset_predicates[0];
250 bool amended = amend_predicate_expr(&curr_pred, next_inst, next_act);
254 curr_pred = one_branch;
260 if (!branch_found && inst_id_map.contains(next_inst)) {
261 FuncInst * curr_inst = curr_pred->get_func_inst();
262 uint32_t curr_id = inst_id_map.get(curr_inst);
263 uint32_t next_id = inst_id_map.get(next_inst);
265 if (curr_id >= next_id) {
266 Predicate * old_pred = inst_pred_map.get(next_inst);
267 Predicate * back_pred = old_pred->get_parent();
269 curr_pred->add_backedge(back_pred);
270 curr_pred = back_pred;
276 // Generate new branches
278 SnapVector<struct half_pred_expr *> half_pred_expressions;
279 infer_predicates(next_inst, next_act, &loc_act_map, &half_pred_expressions);
280 generate_predicates(&curr_pred, next_inst, &half_pred_expressions);
284 if (next_act->is_write())
285 curr_pred->set_write(true);
287 inst_pred_map.put(next_inst, curr_pred);
288 if (!inst_id_map.contains(next_inst))
289 inst_id_map.put(next_inst, inst_counter++);
291 loc_act_map.put(next_act->get_location(), next_act);
292 inst_act_map.put(next_inst, next_act);
297 /* Given curr_pred and next_inst, find the branch following curr_pred that
298 * contains next_inst and the correct predicate.
299 * @return true if branch found, false otherwise.
301 bool FuncNode::follow_branch(Predicate ** curr_pred, FuncInst * next_inst, ModelAction * next_act,
302 HashTable<FuncInst *, ModelAction *, uintptr_t, 0> * inst_act_map,
303 SnapVector<Predicate *> * unset_predicates)
305 /* check if a branch with func_inst and corresponding predicate exists */
306 bool branch_found = false;
307 ModelVector<Predicate *> * branches = (*curr_pred)->get_children();
308 for (uint i = 0; i < branches->size(); i++) {
309 Predicate * branch = (*branches)[i];
310 if (branch->get_func_inst() != next_inst)
313 /* check against predicate expressions */
314 bool predicate_correct = true;
315 PredExprSet * pred_expressions = branch->get_pred_expressions();
316 PredExprSetIter * pred_expr_it = pred_expressions->iterator();
318 /* Only read and rmw actions my have unset predicate expressions */
319 if (pred_expressions->getSize() == 0) {
320 predicate_correct = false;
321 unset_predicates->push_back(branch);
324 while (pred_expr_it->hasNext()) {
325 pred_expr * pred_expression = pred_expr_it->next();
326 uint64_t last_read, next_read;
329 switch(pred_expression->token) {
331 predicate_correct = true;
334 FuncInst * to_be_compared;
335 ModelAction * last_act;
337 to_be_compared = pred_expression->func_inst;
338 last_act = inst_act_map->get(to_be_compared);
340 last_read = last_act->get_reads_from_value();
341 next_read = next_act->get_reads_from_value();
342 equality = (last_read == next_read);
343 if (equality != pred_expression->value)
344 predicate_correct = false;
348 next_read = next_act->get_reads_from_value();
349 equality = ((void*)next_read == NULL);
350 if (equality != pred_expression->value)
351 predicate_correct = false;
354 predicate_correct = false;
355 model_print("unkown predicate token\n");
360 if (predicate_correct) {
370 /* Infer predicate expressions, which are generated in FuncNode::generate_predicates */
371 void FuncNode::infer_predicates(FuncInst * next_inst, ModelAction * next_act,
372 HashTable<void *, ModelAction *, uintptr_t, 0> * loc_act_map,
373 SnapVector<struct half_pred_expr *> * half_pred_expressions)
375 void * loc = next_act->get_location();
377 if (next_inst->is_read()) {
379 if ( loc_act_map->contains(loc) ) {
380 ModelAction * last_act = loc_act_map->get(loc);
381 FuncInst * last_inst = get_inst(last_act);
382 struct half_pred_expr * expression = new half_pred_expr(EQUALITY, last_inst);
383 half_pred_expressions->push_back(expression);
384 } else if ( next_inst->is_single_location() ){
385 loc_set_t * loc_may_equal = loc_may_equal_map->get(loc);
387 if (loc_may_equal != NULL) {
388 loc_set_iter * loc_it = loc_may_equal->iterator();
389 while (loc_it->hasNext()) {
390 void * neighbor = loc_it->next();
391 if (loc_act_map->contains(neighbor)) {
392 ModelAction * last_act = loc_act_map->get(neighbor);
393 FuncInst * last_inst = get_inst(last_act);
395 struct half_pred_expr * expression = new half_pred_expr(EQUALITY, last_inst);
396 half_pred_expressions->push_back(expression);
401 // next_inst is not single location
402 uint64_t read_val = next_act->get_reads_from_value();
404 // only infer NULLITY predicate when it is actually NULL.
405 if ( (void*)read_val == NULL) {
406 struct half_pred_expr * expression = new half_pred_expr(NULLITY, NULL);
407 half_pred_expressions->push_back(expression);
412 // TODO: do anything here?
416 /* Able to generate complex predicates when there are multiple predciate expressions */
417 void FuncNode::generate_predicates(Predicate ** curr_pred, FuncInst * next_inst,
418 SnapVector<struct half_pred_expr *> * half_pred_expressions)
420 if (half_pred_expressions->size() == 0) {
421 Predicate * new_pred = new Predicate(next_inst);
422 (*curr_pred)->add_child(new_pred);
423 new_pred->set_parent(*curr_pred);
425 /* entry predicates and predicates containing pure write actions
426 * have no predicate expressions */
427 if ( (*curr_pred)->is_entry_predicate() )
428 new_pred->add_predicate_expr(NOPREDICATE, NULL, true);
429 else if (next_inst->is_write()) {
430 /* next_inst->is_write() <==> pure writes */
431 new_pred->add_predicate_expr(NOPREDICATE, NULL, true);
437 SnapVector<Predicate *> predicates;
439 struct half_pred_expr * half_expr = (*half_pred_expressions)[0];
440 predicates.push_back(new Predicate(next_inst));
441 predicates.push_back(new Predicate(next_inst));
443 predicates[0]->add_predicate_expr(half_expr->token, half_expr->func_inst, true);
444 predicates[1]->add_predicate_expr(half_expr->token, half_expr->func_inst, false);
446 for (uint i = 1; i < half_pred_expressions->size(); i++) {
447 half_expr = (*half_pred_expressions)[i];
449 uint old_size = predicates.size();
450 for (uint j = 0; j < old_size; j++) {
451 Predicate * pred = predicates[j];
452 Predicate * new_pred = new Predicate(next_inst);
453 new_pred->copy_predicate_expr(pred);
455 pred->add_predicate_expr(half_expr->token, half_expr->func_inst, true);
456 new_pred->add_predicate_expr(half_expr->token, half_expr->func_inst, false);
458 predicates.push_back(new_pred);
462 for (uint i = 0; i < predicates.size(); i++) {
463 Predicate * pred= predicates[i];
464 (*curr_pred)->add_child(pred);
465 pred->set_parent(*curr_pred);
469 /* Amend predicates that contain no predicate expressions. Currenlty only amend with NULLITY predicates */
470 bool FuncNode::amend_predicate_expr(Predicate ** curr_pred, FuncInst * next_inst, ModelAction * next_act)
472 // there should only be only child
473 Predicate * unset_pred = (*curr_pred)->get_children()->back();
474 uint64_t read_val = next_act->get_reads_from_value();
476 // only generate NULLITY predicate when it is actually NULL.
477 if ( !next_inst->is_single_location() && (void*)read_val == NULL ) {
478 Predicate * new_pred = new Predicate(next_inst);
480 (*curr_pred)->add_child(new_pred);
481 new_pred->set_parent(*curr_pred);
483 unset_pred->add_predicate_expr(NULLITY, NULL, false);
484 new_pred->add_predicate_expr(NULLITY, NULL, true);
492 void FuncNode::add_to_val_loc_map(uint64_t val, void * loc)
494 loc_set_t * locations = val_loc_map->get(val);
496 if (locations == NULL) {
497 locations = new loc_set_t();
498 val_loc_map->put(val, locations);
501 update_loc_may_equal_map(loc, locations);
503 // values_may_read_from->add(val);
506 void FuncNode::add_to_val_loc_map(value_set_t * values, void * loc)
511 value_set_iter * it = values->iterator();
512 while (it->hasNext()) {
513 uint64_t val = it->next();
514 add_to_val_loc_map(val, loc);
518 void FuncNode::update_loc_may_equal_map(void * new_loc, loc_set_t * old_locations)
520 if ( old_locations->contains(new_loc) )
523 loc_set_t * neighbors = loc_may_equal_map->get(new_loc);
525 if (neighbors == NULL) {
526 neighbors = new loc_set_t();
527 loc_may_equal_map->put(new_loc, neighbors);
530 loc_set_iter * loc_it = old_locations->iterator();
531 while (loc_it->hasNext()) {
532 // new_loc: { old_locations, ... }
533 void * member = loc_it->next();
534 neighbors->add(member);
536 // for each i in old_locations, i : { new_loc, ... }
537 loc_set_t * _neighbors = loc_may_equal_map->get(member);
538 if (_neighbors == NULL) {
539 _neighbors = new loc_set_t();
540 loc_may_equal_map->put(member, _neighbors);
542 _neighbors->add(new_loc);
546 /* Every time a thread enters a function, set its position to the predicate tree entry */
547 void FuncNode::init_predicate_tree_position(thread_id_t tid)
549 int thread_id = id_to_int(tid);
550 if (predicate_tree_position.size() <= (uint) thread_id)
551 predicate_tree_position.resize(thread_id + 1);
553 predicate_tree_position[thread_id] = predicate_tree_entry;
556 void FuncNode::set_predicate_tree_position(thread_id_t tid, Predicate * pred)
558 int thread_id = id_to_int(tid);
559 predicate_tree_position[thread_id] = pred;
562 /* @return The position of a thread in a predicate tree */
563 Predicate * FuncNode::get_predicate_tree_position(thread_id_t tid)
565 int thread_id = id_to_int(tid);
566 return predicate_tree_position[thread_id];
569 /* Make sure elements of thrd_inst_act_map are initialized properly when threads enter functions */
570 void FuncNode::init_inst_act_map(thread_id_t tid)
572 int thread_id = id_to_int(tid);
573 uint old_size = thrd_inst_act_map->size();
575 if (thrd_inst_act_map->size() <= (uint) thread_id) {
576 uint new_size = thread_id + 1;
577 thrd_inst_act_map->resize(new_size);
579 for (uint i = old_size; i < new_size; i++)
580 (*thrd_inst_act_map)[i] = new inst_act_map_t(128);
584 /* Reset elements of thrd_inst_act_map when threads exit functions */
585 void FuncNode::reset_inst_act_map(thread_id_t tid)
587 int thread_id = id_to_int(tid);
588 inst_act_map_t * map = (*thrd_inst_act_map)[thread_id];
592 void FuncNode::update_inst_act_map(thread_id_t tid, ModelAction * read_act)
594 int thread_id = id_to_int(tid);
595 inst_act_map_t * map = (*thrd_inst_act_map)[thread_id];
596 FuncInst * read_inst = get_inst(read_act);
597 map->put(read_inst, read_act);
600 inst_act_map_t * FuncNode::get_inst_act_map(thread_id_t tid)
602 int thread_id = id_to_int(tid);
603 return (*thrd_inst_act_map)[thread_id];
606 void FuncNode::print_predicate_tree()
608 model_print("digraph function_%s {\n", func_name);
609 predicate_tree_entry->print_pred_subtree();
610 model_print("}\n"); // end of graph
613 void FuncNode::print_val_loc_map()
616 value_set_iter * val_it = values_may_read_from->iterator();
617 while (val_it->hasNext()) {
618 uint64_t value = val_it->next();
619 model_print("val %llx: ", value);
621 loc_set_t * locations = val_loc_map->get(value);
622 loc_set_iter * loc_it = locations->iterator();
623 while (loc_it->hasNext()) {
624 void * location = loc_it->next();
625 model_print("%p ", location);