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