e08ca1b850f8a0f3239bdef7fd785677acbd0745
[c11tester.git] / funcnode.cc
1 #include "funcnode.h"
2
3 FuncNode::FuncNode(ModelHistory * history) :
4         history(history),
5         exit_count(0),
6         func_inst_map(),
7         inst_list(),
8         entry_insts(),
9         predicate_tree_position(),
10         edge_table(32),
11         out_edges()
12 {
13         predicate_tree_entry = new Predicate(NULL, true);
14         predicate_tree_entry->add_predicate_expr(NOPREDICATE, NULL, true);
15
16         // Memories that are reclaimed after each execution
17         action_list_buffer = new SnapList<action_list_t *>();
18         read_locations = new loc_set_t();
19         write_locations = new loc_set_t();
20         val_loc_map = new HashTable<uint64_t, loc_set_t *, uint64_t, 0>();
21         loc_may_equal_map = new HashTable<void *, loc_set_t *, uintptr_t, 0>();
22         thrd_inst_act_map = new SnapVector<inst_act_map_t *>();
23
24         //values_may_read_from = new value_set_t();
25 }
26
27 /* Reallocate snapshotted memories when new executions start */
28 void FuncNode::set_new_exec_flag()
29 {
30         for (mllnode<FuncInst *> * it = inst_list.begin(); it != NULL; it = it->getNext()) {
31                 FuncInst * inst = it->getVal();
32                 inst->unset_location();
33         }
34
35         action_list_buffer = new SnapList<action_list_t *>();
36         read_locations = new loc_set_t();
37         write_locations = new loc_set_t();
38         val_loc_map = new HashTable<uint64_t, loc_set_t *, uint64_t, 0>();
39         loc_may_equal_map = new HashTable<void *, loc_set_t *, uintptr_t, 0>();
40         thrd_inst_act_map = new SnapVector<inst_act_map_t *>();
41
42         //values_may_read_from = new value_set_t();
43 }
44
45 /* Check whether FuncInst with the same type, position, and location
46  * as act has been added to func_inst_map or not. If not, add it.
47  *
48  * Note: currently, actions with the same position are filtered out by process_action,
49  * so the collision list of FuncInst is not used. May remove it later. 
50  */
51 void FuncNode::add_inst(ModelAction *act)
52 {
53         ASSERT(act);
54         const char * position = act->get_position();
55
56         /* THREAD* actions, ATOMIC_LOCK, ATOMIC_TRYLOCK, and ATOMIC_UNLOCK
57          * actions are not tagged with their source line numbers
58          */
59         if (position == NULL)
60                 return;
61
62         if ( func_inst_map.contains(position) ) {
63                 FuncInst * inst = func_inst_map.get(position);
64
65                 ASSERT(inst->get_type() == act->get_type());
66
67                 // locations are set to NULL when new executions start
68                 if (inst->get_location() == NULL)
69                         inst->set_location(act->get_location());
70
71                 if (inst->get_location() != act->get_location())
72                         inst->not_single_location();
73
74                 return;
75         }
76
77         FuncInst * func_inst = new FuncInst(act, this);
78
79         func_inst_map.put(position, func_inst);
80         inst_list.push_back(func_inst);
81 }
82
83 /* Get the FuncInst with the same type, position, and location
84  * as act
85  *
86  * @return FuncInst with the same type, position, and location as act */
87 FuncInst * FuncNode::get_inst(ModelAction *act)
88 {
89         ASSERT(act);
90         const char * position = act->get_position();
91
92         /* THREAD* actions, ATOMIC_LOCK, ATOMIC_TRYLOCK, and ATOMIC_UNLOCK
93          * actions are not tagged with their source line numbers
94          */
95         if (position == NULL)
96                 return NULL;
97
98         FuncInst * inst = func_inst_map.get(position);
99         if (inst == NULL)
100                 return NULL;
101
102         action_type inst_type = inst->get_type();
103         action_type act_type = act->get_type();
104
105         // else if branch: an RMWRCAS action is converted to a RMW or READ action
106         if (inst_type == act_type)
107                 return inst;
108         else if (inst_type == ATOMIC_RMWRCAS &&
109                         (act_type == ATOMIC_RMW || act_type == ATOMIC_READ))
110                 return inst;
111
112         return NULL;
113 }
114
115
116 void FuncNode::add_entry_inst(FuncInst * inst)
117 {
118         if (inst == NULL)
119                 return;
120
121         mllnode<FuncInst *> * it;
122         for (it = entry_insts.begin(); it != NULL; it = it->getNext()) {
123                 if (inst == it->getVal())
124                         return;
125         }
126
127         entry_insts.push_back(inst);
128 }
129
130 /**
131  * @brief Convert ModelAdtion list to FuncInst list 
132  * @param act_list A list of ModelActions
133  */
134 void FuncNode::update_tree(action_list_t * act_list)
135 {
136         if (act_list == NULL || act_list->size() == 0)
137                 return;
138
139         HashTable<void *, value_set_t *, uintptr_t, 4> * write_history = history->getWriteHistory();
140
141         /* build inst_list from act_list for later processing */
142         func_inst_list_t inst_list;
143         action_list_t rw_act_list;
144
145         for (sllnode<ModelAction *> * it = act_list->begin(); it != NULL; it = it->getNext()) {
146                 ModelAction * act = it->getVal();
147                 FuncInst * func_inst = get_inst(act);
148                 void * loc = act->get_location();
149
150                 if (func_inst == NULL)
151                         continue;
152
153                 inst_list.push_back(func_inst);
154                 bool act_added = false;
155
156                 if (act->is_write()) {
157                         rw_act_list.push_back(act);
158                         act_added = true;
159                         if (!write_locations->contains(loc)) {
160                                 write_locations->add(loc);
161                                 history->update_loc_wr_func_nodes_map(loc, this);
162                         }
163
164                 }
165
166                 if (act->is_read()) {
167                         if (!act_added)
168                                 rw_act_list.push_back(act);
169
170                         /* If func_inst may only read_from a single location, then:
171                          *
172                          * The first time an action reads from some location,
173                          * import all the values that have been written to this
174                          * location from ModelHistory and notify ModelHistory
175                          * that this FuncNode may read from this location.
176                          */
177                         if (!read_locations->contains(loc) && func_inst->is_single_location()) {
178                                 read_locations->add(loc);
179                                 value_set_t * write_values = write_history->get(loc);
180                                 add_to_val_loc_map(write_values, loc);
181                                 history->update_loc_func_nodes_map(loc, this);
182                         }
183                 }
184         }
185
186 //      model_print("function %s\n", func_name);
187 //      print_val_loc_map();
188
189         update_inst_tree(&inst_list);
190         update_predicate_tree(&rw_act_list);
191
192 //      print_predicate_tree();
193 }
194
195 /** 
196  * @brief Link FuncInsts in inst_list  - add one FuncInst to another's predecessors and successors
197  * @param inst_list A list of FuncInsts
198  */
199 void FuncNode::update_inst_tree(func_inst_list_t * inst_list)
200 {
201         if (inst_list == NULL)
202                 return;
203         else if (inst_list->size() == 0)
204                 return;
205
206         /* start linking */
207         sllnode<FuncInst *>* it = inst_list->begin();
208         sllnode<FuncInst *>* prev;
209
210         /* add the first instruction to the list of entry insts */
211         FuncInst * entry_inst = it->getVal();
212         add_entry_inst(entry_inst);
213
214         it = it->getNext();
215         while (it != NULL) {
216                 prev = it->getPrev();
217
218                 FuncInst * prev_inst = prev->getVal();
219                 FuncInst * curr_inst = it->getVal();
220
221                 prev_inst->add_succ(curr_inst);
222                 curr_inst->add_pred(prev_inst);
223
224                 it = it->getNext();
225         }
226 }
227
228 void FuncNode::update_predicate_tree(action_list_t * act_list)
229 {
230         if (act_list == NULL || act_list->size() == 0)
231                 return;
232
233         /* Map a FuncInst to the its predicate */
234         HashTable<FuncInst *, Predicate *, uintptr_t, 0> inst_pred_map(128);
235
236         // Number FuncInsts to detect loops
237         HashTable<FuncInst *, uint32_t, uintptr_t, 0> inst_id_map(128);
238         uint32_t inst_counter = 0;
239
240         /* Only need to store the locations of read actions */
241         HashTable<void *, ModelAction *, uintptr_t, 0> loc_act_map(128);
242         HashTable<FuncInst *, ModelAction *, uintptr_t, 0> inst_act_map(128);
243
244         sllnode<ModelAction *> *it = act_list->begin();
245         Predicate * curr_pred = predicate_tree_entry;
246         while (it != NULL) {
247                 ModelAction * next_act = it->getVal();
248                 FuncInst * next_inst = get_inst(next_act);
249
250                 SnapVector<Predicate *> unset_predicates = SnapVector<Predicate *>();
251                 bool branch_found = follow_branch(&curr_pred, next_inst, next_act, &inst_act_map, &unset_predicates);
252
253                 // A branch with unset predicate expression is detected
254                 if (!branch_found && unset_predicates.size() != 0) {
255                         ASSERT(unset_predicates.size() == 1);
256                         Predicate * one_branch = unset_predicates[0];
257
258                         bool amended = amend_predicate_expr(&curr_pred, next_inst, next_act);
259                         if (amended)
260                                 continue;
261                         else {
262                                 curr_pred = one_branch;
263                                 branch_found = true;
264                         }
265                 }
266
267                 // Detect loops
268                 if (!branch_found && inst_id_map.contains(next_inst)) {
269                         FuncInst * curr_inst = curr_pred->get_func_inst();
270                         uint32_t curr_id = inst_id_map.get(curr_inst);
271                         uint32_t next_id = inst_id_map.get(next_inst);
272
273                         if (curr_id >= next_id) {
274                                 Predicate * old_pred = inst_pred_map.get(next_inst);
275                                 Predicate * back_pred = old_pred->get_parent();
276
277                                 curr_pred->add_backedge(back_pred);
278                                 curr_pred = back_pred;
279
280                                 continue;
281                         }
282                 }
283
284                 // Generate new branches
285                 if (!branch_found) {
286                         SnapVector<struct half_pred_expr *> half_pred_expressions;
287                         infer_predicates(next_inst, next_act, &loc_act_map, &half_pred_expressions);
288                         generate_predicates(&curr_pred, next_inst, &half_pred_expressions);
289                         continue;
290                 }
291
292                 if (next_act->is_write())
293                         curr_pred->set_write(true);
294
295                 if (next_act->is_read()) {
296                         loc_act_map.put(next_act->get_location(), next_act);
297                 }
298
299                 inst_act_map.put(next_inst, next_act);
300                 inst_pred_map.put(next_inst, curr_pred);
301                 if (!inst_id_map.contains(next_inst))
302                         inst_id_map.put(next_inst, inst_counter++);
303
304                 it = it->getNext();
305         }
306 }
307
308 /* Given curr_pred and next_inst, find the branch following curr_pred that
309  * contains next_inst and the correct predicate. 
310  * @return true if branch found, false otherwise.
311  */
312 bool FuncNode::follow_branch(Predicate ** curr_pred, FuncInst * next_inst, ModelAction * next_act,
313         HashTable<FuncInst *, ModelAction *, uintptr_t, 0> * inst_act_map,
314         SnapVector<Predicate *> * unset_predicates)
315 {
316         /* check if a branch with func_inst and corresponding predicate exists */
317         bool branch_found = false;
318         ModelVector<Predicate *> * branches = (*curr_pred)->get_children();
319         for (uint i = 0; i < branches->size(); i++) {
320                 Predicate * branch = (*branches)[i];
321                 if (branch->get_func_inst() != next_inst)
322                         continue;
323
324                 /* check against predicate expressions */
325                 bool predicate_correct = true;
326                 PredExprSet * pred_expressions = branch->get_pred_expressions();
327                 PredExprSetIter * pred_expr_it = pred_expressions->iterator();
328
329                 /* Only read and rmw actions my have unset predicate expressions */
330                 if (pred_expressions->getSize() == 0) {
331                         predicate_correct = false;
332                         unset_predicates->push_back(branch);
333                 }
334
335                 while (pred_expr_it->hasNext()) {
336                         pred_expr * pred_expression = pred_expr_it->next();
337                         uint64_t last_read, next_read;
338                         bool equality;
339
340                         switch(pred_expression->token) {
341                                 case NOPREDICATE:
342                                         predicate_correct = true;
343                                         break;
344                                 case EQUALITY:
345                                         FuncInst * to_be_compared;
346                                         ModelAction * last_act;
347
348                                         to_be_compared = pred_expression->func_inst;
349                                         last_act = inst_act_map->get(to_be_compared);
350
351                                         last_read = last_act->get_reads_from_value();
352                                         next_read = next_act->get_reads_from_value();
353                                         equality = (last_read == next_read);
354                                         if (equality != pred_expression->value)
355                                                 predicate_correct = false;
356
357                                         break;
358                                 case NULLITY:
359                                         next_read = next_act->get_reads_from_value();
360                                         equality = ((void*)next_read == NULL);
361                                         if (equality != pred_expression->value)
362                                                 predicate_correct = false;
363                                         break;
364                                 default:
365                                         predicate_correct = false;
366                                         model_print("unkown predicate token\n");
367                                         break;
368                         }
369                 }
370
371                 if (predicate_correct) {
372                         *curr_pred = branch;
373                         branch_found = true;
374                         break;
375                 }
376         }
377
378         return branch_found;
379 }
380
381 /* Infer predicate expressions, which are generated in FuncNode::generate_predicates */
382 void FuncNode::infer_predicates(FuncInst * next_inst, ModelAction * next_act,
383         HashTable<void *, ModelAction *, uintptr_t, 0> * loc_act_map,
384         SnapVector<struct half_pred_expr *> * half_pred_expressions)
385 {
386         void * loc = next_act->get_location();
387
388         if (next_inst->is_read()) {
389                 /* read + rmw */
390                 if ( loc_act_map->contains(loc) ) {
391                         ModelAction * last_act = loc_act_map->get(loc);
392                         FuncInst * last_inst = get_inst(last_act);
393                         struct half_pred_expr * expression = new half_pred_expr(EQUALITY, last_inst);
394                         half_pred_expressions->push_back(expression);
395                 } else if ( next_inst->is_single_location() ){
396                         loc_set_t * loc_may_equal = loc_may_equal_map->get(loc);
397
398                         if (loc_may_equal != NULL) {
399                                 loc_set_iter * loc_it = loc_may_equal->iterator();
400                                 while (loc_it->hasNext()) {
401                                         void * neighbor = loc_it->next();
402                                         if (loc_act_map->contains(neighbor)) {
403                                                 ModelAction * last_act = loc_act_map->get(neighbor);
404                                                 FuncInst * last_inst = get_inst(last_act);
405
406                                                 struct half_pred_expr * expression = new half_pred_expr(EQUALITY, last_inst);
407                                                 half_pred_expressions->push_back(expression);
408                                         }
409                                 }
410                         }
411                 } else {
412                         // next_inst is not single location
413                         uint64_t read_val = next_act->get_reads_from_value();
414
415                         // only infer NULLITY predicate when it is actually NULL.
416                         if ( (void*)read_val == NULL) {
417                                 struct half_pred_expr * expression = new half_pred_expr(NULLITY, NULL);
418                                 half_pred_expressions->push_back(expression);
419                         }
420                 }
421         } else {
422                 /* Pure writes */
423                 // TODO: do anything here?
424         }
425 }
426
427 /* Able to generate complex predicates when there are multiple predciate expressions */
428 void FuncNode::generate_predicates(Predicate ** curr_pred, FuncInst * next_inst,
429         SnapVector<struct half_pred_expr *> * half_pred_expressions)
430 {
431         if (half_pred_expressions->size() == 0) {
432                 Predicate * new_pred = new Predicate(next_inst);
433                 (*curr_pred)->add_child(new_pred);
434                 new_pred->set_parent(*curr_pred);
435
436                 /* entry predicates and predicates containing pure write actions
437                  * have no predicate expressions */
438                 if ( (*curr_pred)->is_entry_predicate() )
439                         new_pred->add_predicate_expr(NOPREDICATE, NULL, true);
440                 else if (next_inst->is_write()) {
441                         /* next_inst->is_write() <==> pure writes */
442                         new_pred->add_predicate_expr(NOPREDICATE, NULL, true);
443                 }
444
445                 return;
446         }
447
448         SnapVector<Predicate *> predicates;
449
450         struct half_pred_expr * half_expr = (*half_pred_expressions)[0];
451         predicates.push_back(new Predicate(next_inst));
452         predicates.push_back(new Predicate(next_inst));
453
454         predicates[0]->add_predicate_expr(half_expr->token, half_expr->func_inst, true);
455         predicates[1]->add_predicate_expr(half_expr->token, half_expr->func_inst, false);
456
457         for (uint i = 1; i < half_pred_expressions->size(); i++) {
458                 half_expr = (*half_pred_expressions)[i];
459
460                 uint old_size = predicates.size();
461                 for (uint j = 0; j < old_size; j++) {
462                         Predicate * pred = predicates[j];
463                         Predicate * new_pred = new Predicate(next_inst);
464                         new_pred->copy_predicate_expr(pred);
465
466                         pred->add_predicate_expr(half_expr->token, half_expr->func_inst, true);
467                         new_pred->add_predicate_expr(half_expr->token, half_expr->func_inst, false);
468
469                         predicates.push_back(new_pred);
470                 }
471         }
472
473         for (uint i = 0; i < predicates.size(); i++) {
474                 Predicate * pred= predicates[i];
475                 (*curr_pred)->add_child(pred);
476                 pred->set_parent(*curr_pred);
477         }
478
479         /* Free memories allocated by infer_predicate */
480         for (uint i = 0; i < half_pred_expressions->size(); i++) {
481                 struct half_pred_expr * tmp = (*half_pred_expressions)[i];
482                 snapshot_free(tmp);
483         }
484 }
485
486 /* Amend predicates that contain no predicate expressions. Currenlty only amend with NULLITY predicates */
487 bool FuncNode::amend_predicate_expr(Predicate ** curr_pred, FuncInst * next_inst, ModelAction * next_act)
488 {
489         // there should only be only child
490         Predicate * unset_pred = (*curr_pred)->get_children()->back();
491         uint64_t read_val = next_act->get_reads_from_value();
492
493         // only generate NULLITY predicate when it is actually NULL.
494         if ( !next_inst->is_single_location() && (void*)read_val == NULL ) {
495                 Predicate * new_pred = new Predicate(next_inst);
496
497                 (*curr_pred)->add_child(new_pred);
498                 new_pred->set_parent(*curr_pred);
499
500                 unset_pred->add_predicate_expr(NULLITY, NULL, false);
501                 new_pred->add_predicate_expr(NULLITY, NULL, true);
502
503                 return true;
504         }
505
506         return false;
507 }
508
509 void FuncNode::add_to_val_loc_map(uint64_t val, void * loc)
510 {
511         loc_set_t * locations = val_loc_map->get(val);
512
513         if (locations == NULL) {
514                 locations = new loc_set_t();
515                 val_loc_map->put(val, locations);
516         }
517
518         update_loc_may_equal_map(loc, locations);
519         locations->add(loc);
520         // values_may_read_from->add(val);
521 }
522
523 void FuncNode::add_to_val_loc_map(value_set_t * values, void * loc)
524 {
525         if (values == NULL)
526                 return;
527
528         value_set_iter * it = values->iterator();
529         while (it->hasNext()) {
530                 uint64_t val = it->next();
531                 add_to_val_loc_map(val, loc);
532         }
533 }
534
535 void FuncNode::update_loc_may_equal_map(void * new_loc, loc_set_t * old_locations)
536 {
537         if ( old_locations->contains(new_loc) )
538                 return;
539
540         loc_set_t * neighbors = loc_may_equal_map->get(new_loc);
541
542         if (neighbors == NULL) {
543                 neighbors = new loc_set_t();
544                 loc_may_equal_map->put(new_loc, neighbors);
545         }
546
547         loc_set_iter * loc_it = old_locations->iterator();
548         while (loc_it->hasNext()) {
549                 // new_loc: { old_locations, ... }
550                 void * member = loc_it->next();
551                 neighbors->add(member);
552
553                 // for each i in old_locations, i : { new_loc, ... }
554                 loc_set_t * _neighbors = loc_may_equal_map->get(member);
555                 if (_neighbors == NULL) {
556                         _neighbors = new loc_set_t();
557                         loc_may_equal_map->put(member, _neighbors);
558                 }
559                 _neighbors->add(new_loc);
560         }
561 }
562
563 /* Every time a thread enters a function, set its position to the predicate tree entry */
564 void FuncNode::init_predicate_tree_position(thread_id_t tid)
565 {
566         int thread_id = id_to_int(tid);
567         if (predicate_tree_position.size() <= (uint) thread_id)
568                 predicate_tree_position.resize(thread_id + 1);
569
570         predicate_tree_position[thread_id] = predicate_tree_entry;
571 }
572
573 void FuncNode::set_predicate_tree_position(thread_id_t tid, Predicate * pred)
574 {
575         int thread_id = id_to_int(tid);
576         predicate_tree_position[thread_id] = pred;
577 }
578
579 /* @return The position of a thread in a predicate tree */
580 Predicate * FuncNode::get_predicate_tree_position(thread_id_t tid)
581 {
582         int thread_id = id_to_int(tid);
583         return predicate_tree_position[thread_id];
584 }
585
586 /* Make sure elements of thrd_inst_act_map are initialized properly when threads enter functions */
587 void FuncNode::init_inst_act_map(thread_id_t tid)
588 {
589         int thread_id = id_to_int(tid);
590         uint old_size = thrd_inst_act_map->size();
591
592         if (thrd_inst_act_map->size() <= (uint) thread_id) {
593                 uint new_size = thread_id + 1;
594                 thrd_inst_act_map->resize(new_size);
595
596                 for (uint i = old_size; i < new_size; i++)
597                         (*thrd_inst_act_map)[i] = new inst_act_map_t(128);
598         }
599 }
600
601 /* Reset elements of thrd_inst_act_map when threads exit functions */
602 void FuncNode::reset_inst_act_map(thread_id_t tid)
603 {
604         int thread_id = id_to_int(tid);
605         inst_act_map_t * map = (*thrd_inst_act_map)[thread_id];
606         map->reset();
607 }
608
609 void FuncNode::update_inst_act_map(thread_id_t tid, ModelAction * read_act)
610 {
611         int thread_id = id_to_int(tid);
612         inst_act_map_t * map = (*thrd_inst_act_map)[thread_id];
613         FuncInst * read_inst = get_inst(read_act);
614         map->put(read_inst, read_act);
615 }
616
617 inst_act_map_t * FuncNode::get_inst_act_map(thread_id_t tid)
618 {
619         int thread_id = id_to_int(tid);
620         return (*thrd_inst_act_map)[thread_id];
621 }
622
623 /* Add FuncNodes that this node may follow */
624 void FuncNode::add_out_edge(FuncNode * other)
625 {
626         if ( !edge_table.contains(other) ) {
627                 edge_table.put(other, OUT_EDGE);
628                 out_edges.push_back(other);
629                 return;
630         }
631
632         edge_type_t edge = edge_table.get(other);
633         if (edge == IN_EDGE) {
634                 edge_table.put(other, BI_EDGE);
635                 out_edges.push_back(other);
636         }
637 }
638
639 void FuncNode::print_predicate_tree()
640 {
641         model_print("digraph function_%s {\n", func_name);
642         predicate_tree_entry->print_pred_subtree();
643         model_print("}\n");     // end of graph
644 }
645
646 void FuncNode::print_val_loc_map()
647 {
648 /*
649         value_set_iter * val_it = values_may_read_from->iterator();
650         while (val_it->hasNext()) {
651                 uint64_t value = val_it->next();
652                 model_print("val %llx: ", value);
653
654                 loc_set_t * locations = val_loc_map->get(value);
655                 loc_set_iter * loc_it = locations->iterator();
656                 while (loc_it->hasNext()) {
657                         void * location = loc_it->next();
658                         model_print("%p ", location);
659                 }
660                 model_print("\n");
661         }
662 */
663 }