cprover
goto2graph.cpp
Go to the documentation of this file.
1 /*******************************************************************\
2 
3 Module: Turns a goto-program into an abstract event graph
4 
5 Author: Vincent Nimal
6 
7 Date: 2012
8 
9 \*******************************************************************/
10 
13 
14 #include "goto2graph.h"
15 
16 #include <vector>
17 #include <string>
18 #include <fstream>
19 
20 #include <util/options.h>
21 #include <util/prefix.h>
22 
24 
25 #include <goto-instrument/rw_set.h>
26 
27 #include "fence.h"
28 
29 // #define PRINT_UNSAFES
30 
31 
33 bool inline instrumentert::local(const irep_idt &id)
34 {
35  std::string identifier=id2string(id);
36 
37  if(has_prefix(identifier, "symex_invalid") ||
38  has_prefix(identifier, "symex::invalid"))
39  {
40  /* symex_invalid and symex::invalid_object generated when pointer analysis
41  fails */
42  return true;
43  }
44 
45  if(identifier==CPROVER_PREFIX "alloc" ||
46  identifier==CPROVER_PREFIX "alloc_size" ||
47  identifier=="stdin" ||
48  identifier=="stdout" ||
49  identifier=="stderr" ||
50  identifier=="sys_nerr" ||
51  has_prefix(identifier, "__unbuffered_"))
52  return true;
53 
54  const size_t pos=identifier.find("[]");
55 
56  if(pos!=std::string::npos)
57  {
58  /* we don't distinguish the members of an array for the moment */
59  identifier.erase(pos);
60  }
61 
62  try
63  {
64  const symbolt &symbol=ns.lookup(identifier);
65 
66  if(!symbol.is_static_lifetime)
67  return true; /* these are local */
68 
69  if(symbol.is_thread_local)
70  return true; /* these are local */
71 
72  return false;
73  }
74  catch(const std::string &exception)
75  {
76  message.debug()<<"Exception: "<<exception << messaget::eom;
77  return false;
78  }
79 }
80 
82 {
83  return instrumenter.local(i);
84 }
85 
89  value_setst &value_sets,
90  memory_modelt model,
91  bool no_dependencies,
92  loop_strategyt duplicate_body)
93 {
94  if(!no_dependencies)
95  message.status() << "Dependencies analysis enabled" << messaget::eom;
96 
97  /* builds the graph following the CFG */
98  cfg_visitort visitor(ns, *this);
99  visitor.visit_cfg(value_sets, model, no_dependencies, duplicate_body,
101 
102  std::vector<std::size_t> subgraph_index;
103  num_sccs=egraph_alt.SCCs(subgraph_index);
104  assert(egraph_SCCs.empty());
105  egraph_SCCs.resize(num_sccs, std::set<event_idt>());
106  for(std::map<event_idt, event_idt>::const_iterator
107  it=map_vertex_gnode.begin();
108  it!=map_vertex_gnode.end();
109  it++)
110  {
111  const std::size_t sg=subgraph_index[it->second];
112  egraph_SCCs[sg].insert(it->first);
113  }
114 
115  message.status() << "Number of threads detected: "
116  << visitor.max_thread << messaget::eom;
117 
118  /* SCCs which could host critical cycles */
119  unsigned interesting_sccs=0;
120  for(unsigned i=0; i<num_sccs; i++)
121  if(egraph_SCCs[i].size()>3)
122  interesting_sccs++;
123 
124  message.statistics() << "Graph with " << egraph_alt.size() << " nodes has "
125  << interesting_sccs << " interesting SCCs"
126  << messaget::eom;
127 
128  message.statistics() << "Number of reads: " << visitor.read_counter
129  << messaget::eom;
130  message.statistics() << "Number of writes: " << visitor.write_counter
131  << messaget::eom;
132  message.statistics() << "Number of wse: " << visitor.ws_counter
133  << messaget::eom;
134  message.statistics() << "Number of rfe/fre: " << visitor.fr_rf_counter
135  << messaget::eom;
136  std::size_t instr_counter=0;
137  for(goto_functionst::function_mapt::const_iterator
138  it=goto_functions.function_map.begin();
139  it!=goto_functions.function_map.end();
140  ++it)
141  instr_counter+=it->second.body.instructions.size();
142  message.statistics() << "Number of goto-instructions: "
143  << instr_counter<<messaget::eom;
144 
145  return visitor.max_thread;
146 }
147 
149  value_setst &value_sets,
150  memory_modelt model,
151  bool no_dependencies,
152  loop_strategyt replicate_body,
153  const irep_idt &function_id,
154  std::set<instrumentert::cfg_visitort::nodet> &ending_vertex)
155 {
156  /* flow: egraph */
157 
158  instrumenter.message.debug()
159  << "visit function " << function_id << messaget::eom;
160 
161  if(function_id == INITIALIZE_FUNCTION)
162  {
163  return;
164  }
165 
166 #ifdef LOCAL_MAY
167  local_may_aliast local_may(
168  instrumenter.goto_functions.function_map[function_id]);
169 #endif
170 
171  /* goes through the function */
172  goto_programt &goto_program =
173  instrumenter.goto_functions.function_map[function_id].body;
174  Forall_goto_program_instructions(i_it, goto_program)
175  {
176  goto_programt::instructiont &instruction=*i_it;
177 
178  /* thread marking */
179  if(instruction.is_start_thread())
180  {
181  max_thread=max_thread+1;
182  coming_from=current_thread;
183  current_thread=max_thread;
184  }
185  else if(instruction.is_end_thread())
186  current_thread=coming_from;
187  thread=current_thread;
188 
189  instrumenter.message.debug() << "visit instruction "<<instruction.type
190  << messaget::eom;
191 
192  if(instruction.is_start_thread() || instruction.is_end_thread())
193  {
194  /* break the flow */
195  visit_cfg_thread();
196  }
197  else if(instruction.is_atomic_begin() || instruction.is_atomic_end())
198  {
199  /* break the flow (def 1) or add full barrier (def 2) */
200  #ifdef ATOMIC_BREAK
201  visit_cfg_thread();
202  #elif defined ATOMIC_FENCE
203  visit_cfg_fence(i_it, function_id);
204 #else
205  /* propagates */
206  visit_cfg_propagate(i_it);
207 #endif
208  }
209  /* a:=b -o-> Rb -po-> Wa */
210  else if(instruction.is_assign())
211  {
212  visit_cfg_assign(
213  value_sets,
214  function_id,
215  i_it,
216  no_dependencies
217 #ifdef LOCAL_MAY
218  ,
219  local_may
220 #endif
221  ); // NOLINT(whitespace/parens)
222  }
223  else if(is_fence(instruction, instrumenter.ns))
224  {
225  instrumenter.message.debug() << "Constructing a fence" << messaget::eom;
226  visit_cfg_fence(i_it, function_id);
227  }
228  else if(model!=TSO && is_lwfence(instruction, instrumenter.ns))
229  {
230  visit_cfg_lwfence(i_it, function_id);
231  }
232  else if(model==TSO && is_lwfence(instruction, instrumenter.ns))
233  {
234  /* propagation */
235  visit_cfg_skip(i_it);
236  }
237  else if(
238  instruction.is_other() &&
239  instruction.get_code().get_statement() == ID_fence)
240  {
241  visit_cfg_asm_fence(i_it, function_id);
242  }
243  else if(instruction.is_function_call())
244  {
245  visit_cfg_function_call(value_sets, i_it, model,
246  no_dependencies, replicate_body);
247  }
248  else if(instruction.is_goto())
249  {
250  visit_cfg_goto(
251  function_id,
252  goto_program,
253  i_it,
254  replicate_body,
255  value_sets
256 #ifdef LOCAL_MAY
257  ,
258  local_may
259 #endif
260  ); // NOLINT(whitespace/parens)
261  }
262 #ifdef CONTEXT_INSENSITIVE
263  else if(instruction.is_set_return_value())
264  {
265  visit_cfg_propagate(i_it);
266  add_all_pos(it, out_nodes[function_id], in_pos[i_it]);
267  }
268 #endif
269  else
270  {
271  /* propagates */
272  visit_cfg_propagate(i_it);
273  }
274  }
275 
276  std::pair<unsigned, data_dpt> new_dp(thread, data_dp);
277  egraph.map_data_dp.insert(new_dp);
278  data_dp.print(instrumenter.message);
279 
280  if(instrumenter.goto_functions.function_map[function_id]
281  .body.instructions.empty())
282  {
283  /* empty set of ending edges */
284  }
285  else
286  {
287  goto_programt::instructionst::iterator it =
288  instrumenter.goto_functions.function_map[function_id]
289  .body.instructions.end();
290  --it;
291  ending_vertex=in_pos[it];
292  }
293 }
294 
296  goto_programt::instructionst::iterator i_it)
297 {
298  const goto_programt::instructiont &instruction=*i_it;
299  /* propagation */
300  in_pos[i_it].clear();
301  for(const auto &in : instruction.incoming_edges)
302  if(in_pos.find(in)!=in_pos.end())
303  for(const auto &node : in_pos[in])
304  in_pos[i_it].insert(node);
305 }
306 
308 {
309 }
310 
312 /* OBSOLETE */
313 /* Note: can be merged with visit_cfg_body */
314 /* Warning: we iterate here over the successive instructions of the
315  regardless of the gotos. This function has to be called *AFTER*
316  an exploration of the function constructing the graph. */
318  irep_idt id_function)
319 {
320  if(instrumenter.map_function_graph.find(id_function)!=
321  instrumenter.map_function_graph.end())
322  return;
323 
324  /* gets the body of the function */
325  goto_programt::instructionst &body=instrumenter.goto_functions
326  .function_map[id_function].body.instructions;
327 
328  if(body.empty())
329  return;
330 
331  /* end of function */
332  /* TODO: ensure that all the returns point to the last statement if the
333  function, or alternatively make i_it point to each return location in
334  the function */
335  goto_programt::instructionst::iterator i_it=body.end();
336  --i_it;
337 
338  /* beginning of the function */
339  goto_programt::instructionst::iterator targ=body.begin();
340 
341  std::set<event_idt> in_nodes;
342  std::set<event_idt> out_nodes;
343 
344  /* if the target has already been covered by fwd analysis */
345  if(in_pos.find(targ)!=in_pos.end())
346  {
347  /* if in_pos was updated at this program point */
348  if(updated.find(targ)!=updated.end())
349  {
350  /* connects the previous nodes to those ones */
351  for(std::set<nodet>::const_iterator to=in_pos[targ].begin();
352  to!=in_pos[targ].end(); ++to)
353  in_nodes.insert(to->first);
354  for(std::set<nodet>::const_iterator from=in_pos[i_it].begin();
355  from!=in_pos[i_it].end(); ++from)
356  out_nodes.insert(from->first);
357  }
358  else
359  {
360  instrumenter.message.debug() << "else case" << messaget::eom;
361  /* connects NEXT nodes following the targets -- bwd analysis */
362  for(goto_programt::instructionst::iterator cur=i_it;
363  cur!=targ; --cur)
364  {
365  instrumenter.message.debug() << "i" << messaget::eom;
366  for(const auto &in : cur->incoming_edges)
367  {
368  instrumenter.message.debug() << "t" << messaget::eom;
369  if(in_pos.find(in)!=in_pos.end() &&
370  updated.find(in)!=updated.end())
371  {
372  /* out_pos[in].insert(in_pos[in])*/
373  add_all_pos(it1, out_pos[in], in_pos[in]);
374  }
375  else if(in_pos.find(in)!=in_pos.end())
376  {
377  /* out_pos[in].insert(out_pos[cur])*/
378  add_all_pos(it2, out_pos[in], out_pos[cur]);
379  }
380  }
381  }
382 
383  /* connects the previous nodes to those ones */
384  if(out_pos.find(targ)!=out_pos.end())
385  {
386  for(std::set<nodet>::const_iterator to=out_pos[targ].begin();
387  to!=out_pos[targ].end(); ++to)
388  in_nodes.insert(to->first);
389  for(std::set<nodet>::const_iterator from=in_pos[i_it].begin();
390  from!=in_pos[i_it].end(); ++from)
391  out_nodes.insert(from->first);
392  }
393  }
394  }
395 
396  instrumenter.map_function_graph[id_function]=
397  std::make_pair(in_nodes, out_nodes);
398 }
399 
401  event_idt begin, event_idt end)
402 {
403  /* no need to duplicate the loop nodes for the SCC-detection graph -- a
404  single back-edge will ensure the same connectivity */
405  alt_egraph.add_edge(end, begin);
406  return end;
407 }
408 
410  const irep_idt &function_id,
413  value_setst &value_sets
414 #ifdef LOCAL_MAY
415  ,
416  local_may_aliast local_may
417 #endif
418  ) const // NOLINT(whitespace/parens)
419 {
420  instrumenter.message.debug() << "contains_shared_array called for "
421  << targ->source_location.get_line() << " and "
422  << i_it->source_location.get_line() << messaget::eom;
423  for(goto_programt::const_targett cur=targ; cur!=i_it; ++cur)
424  {
425  instrumenter.message.debug() << "Do we have an array at line "
426  <<cur->source_location.get_line()<<"?" << messaget::eom;
427  rw_set_loct rw_set(
428  ns,
429  value_sets,
430  function_id,
431  cur
432 #ifdef LOCAL_MAY
433  ,
434  local_may
435 #endif
436  ); // NOLINT(whitespace/parens)
437  instrumenter.message.debug() << "Writes: "<<rw_set.w_entries.size()
438  <<"; Reads:"<<rw_set.r_entries.size() << messaget::eom;
439 
440  for(const auto &r_entry : rw_set.r_entries)
441  {
442  const irep_idt var = r_entry.second.object;
443  instrumenter.message.debug() << "Is "<<var<<" an array?"
444  << messaget::eom;
445  if(id2string(var).find("[]")!=std::string::npos
446  && !instrumenter.local(var))
447  return true;
448  }
449 
450  for(const auto &w_entry : rw_set.w_entries)
451  {
452  const irep_idt var = w_entry.second.object;
453  instrumenter.message.debug()<<"Is "<<var<<" an array?"<<messaget::eom;
454  if(id2string(var).find("[]")!=std::string::npos
455  && !instrumenter.local(var))
456  return true;
457  }
458  }
459 
460  return false;
461 }
462 
463 
466  const irep_idt &function_id,
467  const goto_programt &goto_program,
469  loop_strategyt replicate_body,
470  value_setst &value_sets
471 #ifdef LOCAL_MAY
472  ,
473  local_may_aliast &local_may
474 #endif
475 )
476 {
477  /* for each target of the goto */
478  for(const auto &target : i_it->targets)
479  {
480  /* if the target has already been covered by fwd analysis */
481  if(in_pos.find(target)!=in_pos.end())
482  {
483  if(in_pos[i_it].empty())
484  continue;
485 
486  bool duplicate_this=false;
487 
488  switch(replicate_body)
489  {
490  case arrays_only:
491  duplicate_this = contains_shared_array(
492  function_id,
493  target,
494  i_it,
495  value_sets
496 #ifdef LOCAL_MAY
497  ,
498  local_may
499 #endif
500  ); // NOLINT(whitespace/parens)
501  break;
502  case all_loops:
503  duplicate_this=true;
504  break;
505  case no_loop:
506  duplicate_this=false;
507  break;
508  }
509 
510  if(duplicate_this)
511  visit_cfg_duplicate(goto_program, target, i_it);
512  else
513  visit_cfg_backedge(target, i_it);
514  }
515  }
516 }
517 
519  const goto_programt &goto_program,
522 {
523  instrumenter.message.status() << "Duplication..." << messaget::eom;
524 
525  bool found_pos=false;
526  goto_programt::const_targett new_targ=targ;
527 
528  if(in_pos[targ].empty())
529  {
530  /* tries to find the next node after the back edge */
531  for(; new_targ != goto_program.instructions.end(); ++new_targ)
532  {
533  if(in_pos.find(new_targ)!=in_pos.end() && !in_pos[new_targ].empty())
534  {
535  found_pos=true;
536  break;
537  }
538  }
539 
540  // The code below uses heuristics to limit false positives: no cycles across
541  // inlined functions, which we would detect when file names or
542  // (user-provided) function names change _within a single goto_program_.
543  if(!found_pos
544  || new_targ->source_location.get_function()
545  !=targ->source_location.get_function()
546  || new_targ->source_location.get_file()
547  !=targ->source_location.get_file())
548  return;
549  }
550 
551  /* appends the body once more */
552  const std::set<nodet> &up_set=in_pos[(found_pos ? new_targ : targ)];
553  const std::set<nodet> &down_set=in_pos[i_it];
554 
555  for(std::set<nodet>::const_iterator begin_it=up_set.begin();
556  begin_it!=up_set.end(); ++begin_it)
557  instrumenter.message.debug() << "Up " << begin_it->first << messaget::eom;
558 
559  for(std::set<nodet>::const_iterator begin_it=down_set.begin();
560  begin_it!=down_set.end(); ++begin_it)
561  instrumenter.message.debug() << "Down " << begin_it->first <<messaget::eom;
562 
563  for(std::set<nodet>::const_iterator begin_it=up_set.begin();
564  begin_it!=up_set.end(); ++begin_it)
565  {
566  for(std::set<nodet>::const_iterator end_it=down_set.begin();
567  end_it!=down_set.end(); ++end_it)
568  {
569  egraph.copy_segment(begin_it->first, end_it->first);
570  alt_copy_segment(egraph_alt, begin_it->second, end_it->second);
571 #if 0
572  const event_idt end=egraph.copy_segment(begin_it->first, end_it->first);
573  const event_idt alt_end=
574  alt_copy_segment(egraph_alt, begin_it->second, end_it->second);
575  // copied; no need for back-edge!
576  // in_pos[i_it].insert(nodet(end, alt_end));
577 #endif
578  }
579  }
580 }
581 
586 {
587  /* if in_pos was updated at this program point */
588  if(updated.find(targ)!=updated.end())
589  {
590  /* connects the previous nodes to those ones */
591  for(std::set<nodet>::const_iterator to=in_pos[targ].begin();
592  to!=in_pos[targ].end(); ++to)
593  for(std::set<nodet>::const_iterator from=in_pos[i_it].begin();
594  from!=in_pos[i_it].end(); ++from)
595  if(from->first!=to->first)
596  {
597  if(egraph[from->first].thread!=egraph[to->first].thread)
598  continue;
599  instrumenter.message.debug() << from->first << "-po->"
600  << to->first << messaget::eom;
601  egraph.add_po_back_edge(from->first, to->first);
602  egraph_alt.add_edge(from->second, to->second);
603  }
604  }
605  else
606  {
607  instrumenter.message.debug() << "else case" << messaget::eom;
608 
609  /* connects NEXT nodes following the targets -- bwd analysis */
610  for(goto_programt::const_targett cur=i_it;
611  cur!=targ; --cur)
612  {
613  for(const auto &in : cur->incoming_edges)
614  {
615  if(in_pos.find(in)!=in_pos.end()
616  && updated.find(in)!=updated.end())
617  {
618  /* out_pos[in].insert(in_pos[in])*/
619  add_all_pos(it1, out_pos[in], in_pos[in]);
620  }
621  else if(in_pos.find(in)!=in_pos.end())
622  {
623  /* out_pos[in].insert(in_pos[cur])*/
624  add_all_pos(it2, out_pos[in], out_pos[cur]);
625  }
626  }
627  }
628 
629  /* connects the previous nodes to those ones */
630  if(out_pos.find(targ)!=out_pos.end())
631  {
632  for(std::set<nodet>::const_iterator to=out_pos[targ].begin();
633  to!=out_pos[targ].end(); ++to)
634  for(std::set<nodet>::const_iterator from=in_pos[i_it].begin();
635  from!=in_pos[i_it].end(); ++from)
636  if(from->first!=to->first)
637  {
638  if(egraph[from->first].thread!=egraph[to->first].thread)
639  continue;
640  instrumenter.message.debug() << from->first<<"-po->"
641  <<to->first << messaget::eom;
642  egraph.add_po_back_edge(from->first, to->first);
643  egraph_alt.add_edge(from->second, to->second);
644  }
645  }
646  }
647 }
648 
650  const irep_idt &function_id,
651  const goto_programt &goto_program,
652  goto_programt::instructionst::iterator i_it,
653  loop_strategyt replicate_body,
654  value_setst &value_sets
655 #ifdef LOCAL_MAY
656  ,
657  local_may_aliast &local_may
658 #endif
659 )
660 {
661  const goto_programt::instructiont &instruction=*i_it;
662 
663  /* propagates */
664  visit_cfg_propagate(i_it);
665 
666  /* if back-edges, constructs them too:
667  if goto to event, connects previously propagated events to it;
668  if not, we need to find which events AFTER the target are to
669  be connected. We do a backward analysis. */
670  if(instruction.is_backwards_goto())
671  {
672  instrumenter.message.debug() << "backward goto" << messaget::eom;
673  visit_cfg_body(
674  function_id,
675  goto_program,
676  i_it,
677  replicate_body,
678  value_sets
679 #ifdef LOCAL_MAY
680  ,
681  local_may
682 #endif
683  ); // NOLINT(whitespace/parens)
684  }
685 }
686 
688  value_setst &value_sets,
689  goto_programt::instructionst::iterator i_it,
690  memory_modelt model,
691  bool no_dependencies,
692  loop_strategyt replicate_body)
693 {
694  const goto_programt::instructiont &instruction=*i_it;
695 
696  const exprt &fun = instruction.call_function();
697  const irep_idt &fun_id=to_symbol_expr(fun).get_identifier();
698  /* ignore recursive calls -- underapproximation */
699  try
700  {
701  enter_function(fun_id);
702  #ifdef CONTEXT_INSENSITIVE
703  stack_fun.push(cur_fun);
704  cur_fun=fun_id;
705  #endif
706 
707  #if 0
708  if(!inline_function_cond(fun_id))
709  {
710  /* do not inline it, connect to an existing subgraph or create a new
711  one */
712  if(instrumenter.map_function_graph.find(fun_id)!=
713  instrumenter.map_function_graph.end())
714  {
715  /* connects to existing */
716  /* TODO */
717  }
718  else
719  {
720  /* just inlines */
721  /* TODO */
722  visit_cfg_function(value_sets, model, no_dependencies, fun_id,
723  in_pos[i_it]);
724  updated.insert(i_it);
725  }
726  }
727  else // NOLINT(readability/braces)
728  #endif
729  {
730  /* normal inlining strategy */
731  visit_cfg_function(value_sets, model, no_dependencies, replicate_body,
732  fun_id, in_pos[i_it]);
733  updated.insert(i_it);
734  }
735 
736  leave_function(fun_id);
737  #ifdef CONTEXT_INSENSITIVE
738  cur_fun=stack_fun.pop();
739  #endif
740  }
741  catch(const std::string &s)
742  {
743  instrumenter.message.warning() << "sorry, doesn't handle recursion "
744  << "(function " << fun_id << "; .cpp) "
745  << s << messaget::eom;
746  }
747 }
748 
750  goto_programt::instructionst::iterator i_it,
751  const irep_idt &function_id)
752 {
753  const goto_programt::instructiont &instruction=*i_it;
754  const abstract_eventt new_fence_event(
756  thread,
757  "f",
758  instrumenter.unique_id++,
759  instruction.source_location,
760  function_id,
761  false);
762  const event_idt new_fence_node=egraph.add_node();
763  egraph[new_fence_node](new_fence_event);
764  const event_idt new_fence_gnode=egraph_alt.add_node();
765  egraph_alt[new_fence_gnode]=new_fence_event;
766  instrumenter.map_vertex_gnode.insert(
767  std::make_pair(new_fence_node, new_fence_gnode));
768 
769  for(const auto &in : instruction.incoming_edges)
770  if(in_pos.find(in)!=in_pos.end())
771  {
772  for(const auto &node : in_pos[in])
773  {
774  if(egraph[node.first].thread!=thread)
775  continue;
776  instrumenter.message.debug() << node.first<<"-po->"<<new_fence_node
777  << messaget::eom;
778  egraph.add_po_edge(node.first, new_fence_node);
779  egraph_alt.add_edge(node.second, new_fence_gnode);
780  }
781  }
782 
783  in_pos[i_it].clear();
784  in_pos[i_it].insert(nodet(new_fence_node, new_fence_gnode));
785  updated.insert(i_it);
786 }
787 
789  goto_programt::instructionst::iterator i_it,
790  const irep_idt &function_id)
791 {
792  const goto_programt::instructiont &instruction=*i_it;
793  bool WRfence = instruction.get_code().get_bool(ID_WRfence);
794  bool WWfence = instruction.get_code().get_bool(ID_WWfence);
795  bool RRfence = instruction.get_code().get_bool(ID_RRfence);
796  bool RWfence = instruction.get_code().get_bool(ID_RWfence);
797  bool WWcumul = instruction.get_code().get_bool(ID_WWcumul);
798  bool RRcumul = instruction.get_code().get_bool(ID_RRcumul);
799  bool RWcumul = instruction.get_code().get_bool(ID_RWcumul);
800  const abstract_eventt new_fence_event(
802  thread,
803  "asm",
804  instrumenter.unique_id++,
805  instruction.source_location,
806  function_id,
807  false,
808  WRfence,
809  WWfence,
810  RRfence,
811  RWfence,
812  WWcumul,
813  RWcumul,
814  RRcumul);
815  const event_idt new_fence_node=egraph.add_node();
816  egraph[new_fence_node](new_fence_event);
817  const event_idt new_fence_gnode=egraph_alt.add_node();
818  egraph_alt[new_fence_gnode]=new_fence_event;
819  instrumenter.map_vertex_gnode.insert(
820  std::make_pair(new_fence_node, new_fence_gnode));
821 
822  for(const auto &in : instruction.incoming_edges)
823  if(in_pos.find(in)!=in_pos.end())
824  {
825  for(const auto &node : in_pos[in])
826  {
827  if(egraph[node.first].thread!=thread)
828  continue;
829  instrumenter.message.debug() << node.first<<"-po->"<<new_fence_node
830  << messaget::eom;
831  egraph.add_po_edge(node.first, new_fence_node);
832  egraph_alt.add_edge(node.second, new_fence_gnode);
833  }
834  }
835 
836  in_pos[i_it].clear();
837  in_pos[i_it].insert(nodet(new_fence_node, new_fence_gnode));
838  updated.insert(i_it);
839 }
840 
842  value_setst &value_sets,
843  const irep_idt &function_id,
844  goto_programt::instructionst::iterator &i_it,
845  bool no_dependencies
846 #ifdef LOCAL_MAY
847  ,
848  local_may_aliast &local_may
849 #endif
850 )
851 {
852  goto_programt::instructiont &instruction=*i_it;
853 
854  /* Read (Rb) */
855  rw_set_loct rw_set(
856  ns,
857  value_sets,
858  function_id,
859  i_it
860 #ifdef LOCAL_MAY
861  ,
862  local_may
863 #endif
864  ); // NOLINT(whitespace/parens)
865 
866  event_idt previous=std::numeric_limits<event_idt>::max();
867  event_idt previous_gnode=std::numeric_limits<event_idt>::max();
868 
869 #if 0
870  /* for the moment, use labels ASSERT in front of the assertions
871  to prevent them from being instrumented */
872  if(instruction.is_assert())
873  continue; // return;
874  if(!instruction.labels.empty() && instruction.labels.front()=="ASSERT")
875  continue; // return;
876 #endif
877 
878  for(const auto &r_entry : rw_set.r_entries)
879  {
880  /* creates Read:
881  read is the irep_id of the read in the code;
882  new_read_event is the corresponding abstract event;
883  new_read_node is the node in the graph */
884  const irep_idt &read = r_entry.second.object;
885 
886  /* skip local variables */
887  if(local(read))
888  continue;
889 
890  read_counter++;
891 #if 0
892  assert(read_expr);
893 #endif
894 
895  const abstract_eventt new_read_event(
897  thread,
898  id2string(read),
899  instrumenter.unique_id++,
900  instruction.source_location,
901  function_id,
902  local(read));
903 
904  const event_idt new_read_node=egraph.add_node();
905  egraph[new_read_node]=new_read_event;
906  instrumenter.message.debug() << "new Read"<<read<<" @thread"
907  <<(thread)<<"("<<instruction.source_location<<","
908  <<(local(read)?"local":"shared")<<") #"<<new_read_node
909  << messaget::eom;
910 
911  if(read==ID_unknown)
912  unknown_read_nodes.insert(new_read_node);
913 
914  const event_idt new_read_gnode=egraph_alt.add_node();
915  egraph_alt[new_read_gnode]=new_read_event;
916  instrumenter.map_vertex_gnode.insert(
917  std::make_pair(new_read_node, new_read_gnode));
918 
919  /* creates ... -po-> Read */
920  for(const auto &in : instruction.incoming_edges)
921  {
922  if(in_pos.find(in)!=in_pos.end())
923  {
924  for(const auto &node : in_pos[in])
925  {
926  if(egraph[node.first].thread!=thread)
927  continue;
928  instrumenter.message.debug() << node.first<<"-po->"
929  <<new_read_node << messaget::eom;
930  egraph.add_po_edge(node.first, new_read_node);
931  egraph_alt.add_edge(node.second, new_read_gnode);
932  }
933  }
934  }
935 
936  map_reads.insert(id2node_pairt(read, new_read_node));
937  previous=new_read_node;
938  previous_gnode=new_read_gnode;
939 
940  /* creates Read <-com-> Write ... */
941  const std::pair<id2nodet::iterator, id2nodet::iterator>
942  with_same_var=map_writes.equal_range(read);
943  for(id2nodet::iterator id_it=with_same_var.first;
944  id_it!=with_same_var.second; id_it++)
945  if(egraph[id_it->second].thread!=new_read_event.thread)
946  {
947  instrumenter.message.debug() << id_it->second<<"<-com->"
948  <<new_read_node << messaget::eom;
949  std::map<event_idt, event_idt>::const_iterator entry=
950  instrumenter.map_vertex_gnode.find(id_it->second);
951  assert(entry!=instrumenter.map_vertex_gnode.end());
952  egraph.add_com_edge(new_read_node, id_it->second);
953  egraph_alt.add_edge(new_read_gnode, entry->second);
954  egraph.add_com_edge(id_it->second, new_read_node);
955  egraph_alt.add_edge(entry->second, new_read_gnode);
956  ++fr_rf_counter;
957  }
958 
959  /* for unknown writes */
960  for(std::set<event_idt>::const_iterator id_it=
961  unknown_write_nodes.begin();
962  id_it!=unknown_write_nodes.end();
963  ++id_it)
964  if(egraph[*id_it].thread!=new_read_event.thread)
965  {
966  instrumenter.message.debug() << *id_it<<"<-com->"
967  <<new_read_node << messaget::eom;
968  std::map<event_idt, event_idt>::const_iterator entry=
969  instrumenter.map_vertex_gnode.find(*id_it);
970  assert(entry!=instrumenter.map_vertex_gnode.end());
971  egraph.add_com_edge(new_read_node, *id_it);
972  egraph_alt.add_edge(new_read_gnode, entry->second);
973  egraph.add_com_edge(*id_it, new_read_node);
974  egraph_alt.add_edge(entry->second, new_read_gnode);
975  ++fr_rf_counter;
976  }
977  }
978 
979  /* Write (Wa) */
980  for(const auto &w_entry : rw_set.w_entries)
981  {
982  /* creates Write:
983  write is the irep_id in the code;
984  new_write_event is the corresponding abstract event;
985  new_write_node is the node in the graph */
986  const irep_idt &write = w_entry.second.object;
987 
988  instrumenter.message.debug() << "WRITE: " << write << messaget::eom;
989 
990  /* skip local variables */
991  if(local(write))
992  continue;
993 
994  ++write_counter;
995  // assert(write_expr);
996 
997  /* creates Write */
998  const abstract_eventt new_write_event(
1000  thread,
1001  id2string(write),
1002  instrumenter.unique_id++,
1003  instruction.source_location,
1004  function_id,
1005  local(write));
1006 
1007  const event_idt new_write_node=egraph.add_node();
1008  egraph[new_write_node](new_write_event);
1009  instrumenter.message.debug() << "new Write "<<write<<" @thread"<<(thread)
1010  <<"("<<instruction.source_location<<","
1011  << (local(write)?"local":"shared")<<") #"<<new_write_node
1012  << messaget::eom;
1013 
1014  if(write==ID_unknown)
1015  unknown_read_nodes.insert(new_write_node);
1016 
1017  const event_idt new_write_gnode=egraph_alt.add_node();
1018  egraph_alt[new_write_gnode]=new_write_event;
1019  instrumenter.map_vertex_gnode.insert(
1020  std::pair<event_idt, event_idt>(new_write_node, new_write_gnode));
1021 
1022  /* creates Read -po-> Write */
1023  if(previous!=std::numeric_limits<event_idt>::max())
1024  {
1025  instrumenter.message.debug() << previous<<"-po->"<<new_write_node
1026  << messaget::eom;
1027  egraph.add_po_edge(previous, new_write_node);
1028  egraph_alt.add_edge(previous_gnode, new_write_gnode);
1029  }
1030  else
1031  {
1032  for(const auto &in : instruction.incoming_edges)
1033  {
1034  if(in_pos.find(in)!=in_pos.end())
1035  {
1036  for(const auto &node : in_pos[in])
1037  {
1038  if(egraph[node.first].thread!=thread)
1039  continue;
1040  instrumenter.message.debug() << node.first<<"-po->"
1041  <<new_write_node << messaget::eom;
1042  egraph.add_po_edge(node.first, new_write_node);
1043  egraph_alt.add_edge(node.second, new_write_gnode);
1044  }
1045  }
1046  }
1047  }
1048 
1049  /* creates Write <-com-> Read */
1050  const std::pair<id2nodet::iterator, id2nodet::iterator>
1051  r_with_same_var=map_reads.equal_range(write);
1052  for(id2nodet::iterator idr_it=r_with_same_var.first;
1053  idr_it!=r_with_same_var.second; idr_it++)
1054  if(egraph[idr_it->second].thread!=new_write_event.thread)
1055  {
1056  instrumenter.message.debug() <<idr_it->second<<"<-com->"
1057  <<new_write_node << messaget::eom;
1058  std::map<event_idt, event_idt>::const_iterator entry=
1059  instrumenter.map_vertex_gnode.find(idr_it->second);
1060  assert(entry!=instrumenter.map_vertex_gnode.end());
1061  egraph.add_com_edge(new_write_node, idr_it->second);
1062  egraph_alt.add_edge(new_write_gnode, entry->second);
1063  egraph.add_com_edge(idr_it->second, new_write_node);
1064  egraph_alt.add_edge(entry->second, new_write_gnode);
1065  ++fr_rf_counter;
1066  }
1067 
1068  /* creates Write <-com-> Write */
1069  const std::pair<id2nodet::iterator, id2nodet::iterator>
1070  w_with_same_var=map_writes.equal_range(write);
1071  for(id2nodet::iterator idw_it=w_with_same_var.first;
1072  idw_it!=w_with_same_var.second; idw_it++)
1073  if(egraph[idw_it->second].thread!=new_write_event.thread)
1074  {
1075  instrumenter.message.debug() << idw_it->second<<"<-com->"
1076  <<new_write_node << messaget::eom;
1077  std::map<event_idt, event_idt>::const_iterator entry=
1078  instrumenter.map_vertex_gnode.find(idw_it->second);
1079  assert(entry!=instrumenter.map_vertex_gnode.end());
1080  egraph.add_com_edge(new_write_node, idw_it->second);
1081  egraph_alt.add_edge(new_write_gnode, entry->second);
1082  egraph.add_com_edge(idw_it->second, new_write_node);
1083  egraph_alt.add_edge(entry->second, new_write_gnode);
1084  ++ws_counter;
1085  }
1086 
1087  /* for unknown writes */
1088  for(std::set<event_idt>::const_iterator id_it=
1089  unknown_write_nodes.begin();
1090  id_it!=unknown_write_nodes.end();
1091  ++id_it)
1092  if(egraph[*id_it].thread!=new_write_event.thread)
1093  {
1094  instrumenter.message.debug() << *id_it<<"<-com->"
1095  <<new_write_node << messaget::eom;
1096  std::map<event_idt, event_idt>::const_iterator entry=
1097  instrumenter.map_vertex_gnode.find(*id_it);
1098  assert(entry!=instrumenter.map_vertex_gnode.end());
1099  egraph.add_com_edge(new_write_node, *id_it);
1100  egraph_alt.add_edge(new_write_gnode, entry->second);
1101  egraph.add_com_edge(*id_it, new_write_node);
1102  egraph_alt.add_edge(entry->second, new_write_gnode);
1103  ++fr_rf_counter;
1104  }
1105 
1106  /* for unknown reads */
1107  for(std::set<event_idt>::const_iterator id_it=
1108  unknown_read_nodes.begin();
1109  id_it!=unknown_read_nodes.end();
1110  ++id_it)
1111  if(egraph[*id_it].thread!=new_write_event.thread)
1112  {
1113  instrumenter.message.debug() << *id_it<<"<-com->"
1114  <<new_write_node << messaget::eom;
1115  std::map<event_idt, event_idt>::const_iterator entry=
1116  instrumenter.map_vertex_gnode.find(*id_it);
1117  assert(entry!=instrumenter.map_vertex_gnode.end());
1118  egraph.add_com_edge(new_write_node, *id_it);
1119  egraph_alt.add_edge(new_write_gnode, entry->second);
1120  egraph.add_com_edge(*id_it, new_write_node);
1121  egraph_alt.add_edge(entry->second, new_write_gnode);
1122  ++fr_rf_counter;
1123  }
1124 
1125 
1126  map_writes.insert(id2node_pairt(write, new_write_node));
1127  previous=new_write_node;
1128  previous_gnode=new_write_gnode;
1129  }
1130 
1131  if(previous!=std::numeric_limits<event_idt>::max())
1132  {
1133  in_pos[i_it].clear();
1134  in_pos[i_it].insert(nodet(previous, previous_gnode));
1135  updated.insert(i_it);
1136  }
1137  else
1138  {
1139  /* propagation */
1140  visit_cfg_skip(i_it);
1141  }
1142 
1143  /* data dependency analysis */
1144  if(!no_dependencies)
1145  {
1146  for(const auto &w_entry : rw_set.w_entries)
1147  {
1148  for(const auto &r_entry : rw_set.r_entries)
1149  {
1150  const irep_idt &write = w_entry.second.object;
1151  const irep_idt &read = r_entry.second.object;
1152  instrumenter.message.debug() << "dp: Write:"<<write<<"; Read:"<<read
1153  << messaget::eom;
1154  const datat read_p(read, instruction.source_location);
1155  const datat write_p(write, instruction.source_location);
1156  data_dp.dp_analysis(read_p, local(read), write_p, local(write));
1157  }
1158  }
1159  data_dp.dp_merge();
1160 
1161  for(const auto &r_entry : rw_set.r_entries)
1162  {
1163  for(const auto &r_entry2 : rw_set.r_entries)
1164  {
1165  const irep_idt &read2 = r_entry2.second.object;
1166  const irep_idt &read = r_entry.second.object;
1167  if(read2==read)
1168  continue;
1169  const datat read_p(read, instruction.source_location);
1170  const datat read2_p(read2, instruction.source_location);
1171  data_dp.dp_analysis(read_p, local(read), read2_p, local(read2));
1172  }
1173  }
1174  data_dp.dp_merge();
1175  }
1176 }
1177 
1179  goto_programt::instructionst::iterator i_it,
1180  const irep_idt &function_id)
1181 {
1182  const goto_programt::instructiont &instruction=*i_it;
1183  const abstract_eventt new_fence_event(
1185  thread,
1186  "F",
1187  instrumenter.unique_id++,
1188  instruction.source_location,
1189  function_id,
1190  false);
1191  const event_idt new_fence_node=egraph.add_node();
1192  egraph[new_fence_node](new_fence_event);
1193  const event_idt new_fence_gnode=egraph_alt.add_node();
1194  egraph_alt[new_fence_gnode]=new_fence_event;
1195  instrumenter.map_vertex_gnode.insert(
1196  std::make_pair(new_fence_node, new_fence_gnode));
1197 
1198  for(const auto &in : instruction.incoming_edges)
1199  if(in_pos.find(in)!=in_pos.end())
1200  {
1201  for(const auto &node : in_pos[in])
1202  {
1203  instrumenter.message.debug() << node.first<<"-po->"<<new_fence_node
1204  << messaget::eom;
1205  egraph.add_po_edge(node.first, new_fence_node);
1206  egraph_alt.add_edge(node.second, new_fence_gnode);
1207  }
1208  }
1209 #if 0
1210  std::set<nodet> s;
1211  s.insert(nodet(new_fence_node, new_fence_gnode));
1212  in_pos[i_it]=s;
1213  updated.insert(i_it);
1214 #endif
1215  in_pos[i_it].clear();
1216  in_pos[i_it].insert(nodet(new_fence_node, new_fence_gnode));
1217  updated.insert(i_it);
1218 }
1219 
1221  goto_programt::instructionst::iterator i_it)
1222 {
1223  visit_cfg_propagate(i_it);
1224 }
1225 
1227  goto_programt::instructionst::iterator it,
1228  goto_programt &interleaving)
1229 {
1230  if(
1231  it->is_set_return_value() || it->is_throw() || it->is_catch() ||
1232  it->is_skip() || it->is_dead() || it->is_start_thread() ||
1233  it->is_end_thread())
1234  return;
1235 
1236  if(it->is_atomic_begin() ||
1237  it->is_atomic_end())
1238  {
1239  /* atomicity not checked here for the moment */
1240  return;
1241  }
1242 
1243  if(it->is_function_call())
1244  {
1245  /* function call not supported for the moment */
1246  return;
1247  }
1248 
1249  /* add this instruction to the interleaving */
1250  interleaving.add(goto_programt::instructiont(*it));
1251 }
1252 
1254 {
1255  message.debug() << "spurious by CFG? " << messaget::eom;
1256  goto_programt interleaving;
1257 
1259  e_it!=cyc.end() && ++e_it!=cyc.end(); ++e_it)
1260  {
1261  --e_it;
1262 
1263  const abstract_eventt &current_event=egraph[*e_it];
1264  const source_locationt &current_location=current_event.source_location;
1265 
1266  /* select relevant thread (po) -- or function contained in this thread */
1267  goto_programt *current_po=nullptr;
1268  bool thread_found=false;
1269 
1270  for(auto &gf_entry : goto_functions.function_map)
1271  {
1272  for(const auto &instruction : gf_entry.second.body.instructions)
1273  {
1274  if(instruction.source_location == current_location)
1275  {
1276  current_po = &gf_entry.second.body;
1277  thread_found=true;
1278  break;
1279  }
1280  }
1281 
1282  if(thread_found)
1283  break;
1284  }
1285  assert(current_po);
1286 
1287  const wmm_grapht::edgest &pos_cur=egraph.po_out(*e_it);
1288  const wmm_grapht::edgest &pos_next=egraph.po_out(*(++e_it));
1289  --e_it;
1290 
1291  bool exists_n=false;
1292 
1293  for(wmm_grapht::edgest::const_iterator edge_it=pos_cur.begin();
1294  edge_it!=pos_cur.end(); edge_it++)
1295  {
1296  if(pos_next.find(edge_it->first)!=pos_next.end())
1297  {
1298  exists_n=true;
1299  break;
1300  }
1301  }
1302 
1303  /* !exists n, has_po_edge(*e_it,n) /\ has_po_edge(*(++it--),n) */
1304  if((++e_it)!=cyc.end() || !exists_n)
1305  {
1306  --e_it;
1307 
1308  /* add this instruction to the interleaving */
1309  Forall_goto_program_instructions(i_it, *current_po)
1310  if(i_it->source_location==current_location)
1311  {
1312  /* add all the instructions of this line */
1313  for(goto_programt::instructionst::iterator same_loc=i_it;
1314  same_loc!=current_po->instructions.end()
1315  && same_loc->source_location==i_it->source_location;
1316  same_loc++)
1317  add_instr_to_interleaving(same_loc, interleaving);
1318  break;
1319  }
1320  }
1321  else
1322  {
1323  --e_it;
1324 
1325  /* find the portion of the thread to add */
1326  const abstract_eventt &next_event=egraph[*(++e_it--)];
1327  const source_locationt &next_location=next_event.source_location;
1328 
1329  bool in_cycle=false;
1330  Forall_goto_program_instructions(it, *current_po)
1331  {
1332  if(it->source_location==current_location)
1333  in_cycle=true;
1334 
1335  /* do not add the last instruction now -- will be done at
1336  the next iteration */
1337  if(it->source_location==next_location)
1338  break;
1339 
1340  if(in_cycle)
1341  add_instr_to_interleaving(it, interleaving);
1342  }
1343  }
1344  }
1345 
1346  /* if a goto points to a label outside from this interleaving, replace it
1347  by an assert 0 */
1348  for(auto &instruction : interleaving.instructions)
1349  {
1350  if(instruction.is_goto())
1351  {
1352  for(const auto &t : instruction.targets)
1353  {
1354  bool target_in_cycle=false;
1355 
1356  forall_goto_program_instructions(targ, interleaving)
1357  {
1358  if(targ==t)
1359  {
1360  target_in_cycle=true;
1361  break;
1362  }
1363  }
1364 
1365  if(!target_in_cycle)
1366  {
1367  instruction = goto_programt::make_assertion(
1368  false_exprt(), instruction.source_location);
1369  break;
1370  }
1371  }
1372  }
1373  }
1374 
1375  /* now test whether this part of the code can exist */
1377  goto_functiont one_interleaving;
1378  one_interleaving.body.copy_from(interleaving);
1379  map.insert(std::make_pair(
1381  std::move(one_interleaving)));
1382 
1383  goto_functionst this_interleaving;
1384  this_interleaving.function_map=std::move(map);
1385  optionst no_option;
1386  null_message_handlert no_message;
1387 
1388  #if 0
1389  bmct bmc(no_option, symbol_table, no_message);
1390 
1391  bool is_spurious=bmc.run(this_interleaving);
1392 
1393  message.debug() << "CFG:"<<is_spurious << messaget::eom;
1394  return is_spurious;
1395  #else
1396 
1397  return false; // conservative for now
1398  #endif
1399 }
1400 
1402 {
1403  if(!set_of_cycles.empty())
1404  {
1405  for(std::set<event_grapht::critical_cyclet>::iterator
1406  it=set_of_cycles.begin();
1407  it!=set_of_cycles.end();
1408  )
1409  {
1410  bool erased=false;
1411  std::set<event_grapht::critical_cyclet>::iterator next=it;
1412  ++next;
1413  if(is_cfg_spurious(*it))
1414  {
1415  erased=true;
1416  set_of_cycles.erase(it);
1417  }
1418  it=next;
1419  if(!erased)
1420  ++it;
1421  }
1422  }
1423  else if(num_sccs > 0)
1424  {
1425  for(unsigned i=0; i<num_sccs; i++)
1426  for(std::set<event_grapht::critical_cyclet>::iterator it=
1427  set_of_cycles_per_SCC[i].begin();
1428  it!=set_of_cycles_per_SCC[i].end();
1429  )
1430  {
1431  bool erased=false;
1432  std::set<event_grapht::critical_cyclet>::iterator next=it;
1433  ++next;
1434  if(is_cfg_spurious(*it))
1435  {
1436  erased=true;
1437  set_of_cycles_per_SCC[i].erase(it);
1438  }
1439  it=next;
1440  if(!erased)
1441  ++it;
1442  }
1443  }
1444  else
1445  message.status() << "No cycle to filter" << messaget::eom;
1446 }
1447 
1449  const std::set<event_grapht::critical_cyclet> &set,
1450  std::ofstream &dot,
1451  std::ofstream &ref,
1452  std::ofstream &output,
1453  std::ofstream &all,
1454  std::ofstream &table,
1455  memory_modelt model,
1456  bool hide_internals)
1457 {
1458  /* to represent the po aligned in the dot */
1459  std::map<unsigned, std::set<event_idt> > same_po;
1460  unsigned max_thread=0;
1461  unsigned colour=0;
1462 
1463  /* to represent the files as clusters */
1464  std::map<irep_idt, std::set<event_idt> > same_file;
1465 
1466  /* to summarise in a table all the variables */
1467  std::map<std::string, std::string> map_id2var;
1468  std::map<std::string, std::string> map_var2id;
1469 
1470  for(std::set<event_grapht::critical_cyclet>::const_iterator it =
1471  set.begin(); it!=set.end(); it++)
1472  {
1473 #ifdef PRINT_UNSAFES
1474  message.debug() << it->print_unsafes() << messaget::eom;
1475 #endif
1476  it->print_dot(dot, colour++, model);
1477  ref << it->print_name(model, hide_internals) << '\n';
1478  output << it->print_output() << '\n';
1479  all << it->print_all(model, map_id2var, map_var2id, hide_internals)
1480  << '\n';
1481 
1482  /* emphasises instrumented events */
1483  for(std::list<event_idt>::const_iterator it_e=it->begin();
1484  it_e!=it->end(); it_e++)
1485  {
1486  const abstract_eventt &ev=egraph[*it_e];
1487 
1488  if(render_po_aligned)
1489  same_po[ev.thread].insert(*it_e);
1490  if(render_by_function)
1491  same_file[ev.function_id].insert(*it_e);
1492  else if(render_by_file)
1493  same_file[ev.source_location.get_file()].insert(*it_e);
1494  if(ev.thread>max_thread)
1495  max_thread=ev.thread;
1496 
1497  if(var_to_instr.find(ev.variable)!=var_to_instr.end()
1498  && id2loc.find(ev.variable)!=id2loc.end())
1499  {
1500  dot << ev.id << "[label=\"\\\\lb {" << ev.id << "}";
1501  dot << ev.get_operation() << "{" << ev.variable << "} {} @thread";
1502  dot << ev.thread << "\",color=red,shape=box];\n";
1503  }
1504  }
1505  }
1506 
1507  /* aligns events by po */
1508  if(render_po_aligned)
1509  {
1510  for(unsigned i=0; i<=max_thread; i++)
1511  if(!same_po[i].empty())
1512  {
1513  dot << "{rank=same; thread_" << i
1514  << "[shape=plaintext, label=\"thread " << i << "\"];";
1515  for(std::set<event_idt>::iterator it=same_po[i].begin();
1516  it!=same_po[i].end(); it++)
1517  dot << egraph[*it].id << ";";
1518  dot << "};\n";
1519  }
1520  }
1521 
1522  /* clusters events by file/function */
1524  {
1525  for(std::map<irep_idt, std::set<event_idt> >::const_iterator it=
1526  same_file.begin();
1527  it!=same_file.end(); it++)
1528  {
1529  dot << "subgraph cluster_" << irep_id_hash()(it->first) << "{\n";
1530  dot << " label=\"" << it->first << "\";\n";
1531  for(std::set<event_idt>::const_iterator ev_it=it->second.begin();
1532  ev_it!=it->second.end(); ev_it++)
1533  {
1534  dot << " " << egraph[*ev_it].id << ";\n";
1535  }
1536  dot << "};\n";
1537  }
1538  }
1539 
1540  /* variable table for "all" */
1541  table << std::string(80, '-');
1542  for(std::map<std::string, std::string>::const_iterator
1543  m_it=map_id2var.begin();
1544  m_it!=map_id2var.end();
1545  ++m_it)
1546  {
1547  table << "\n| " << m_it->first << " : " << m_it->second;
1548  }
1549  table << '\n';
1550  table << std::string(80, '-');
1551  table << '\n';
1552 }
1553 
1554 void instrumentert::print_outputs(memory_modelt model, bool hide_internals)
1555 {
1556  std::ofstream dot;
1557  std::ofstream ref;
1558  std::ofstream output;
1559  std::ofstream all;
1560  std::ofstream table;
1561 
1562  dot.open("cycles.dot");
1563  ref.open("ref.txt");
1564  output.open("output.txt");
1565  all.open("all.txt");
1566  table.open("table.txt");
1567 
1568  dot << "digraph G {\n";
1569  dot << "nodesep=1; ranksep=1;\n";
1570 
1571  /* prints cycles in the different outputs */
1572  if(!set_of_cycles.empty())
1573  print_outputs_local(set_of_cycles, dot, ref, output, all, table,
1574  model, hide_internals);
1575  else if(num_sccs!=0)
1576  {
1577  for(unsigned i=0; i<num_sccs; i++)
1578  {
1579  std::ofstream local_dot;
1580  std::string name="scc_" + std::to_string(i) + ".dot";
1581  local_dot.open(name.c_str());
1582 
1583  local_dot << "digraph G {\n";
1584  local_dot << "nodesep=1; ranksep=1;\n";
1585  print_outputs_local(set_of_cycles_per_SCC[i], local_dot, ref, output, all,
1586  table, model, hide_internals);
1587  local_dot << "}\n";
1588  local_dot.close();
1589 
1590  dot << i << "[label=\"SCC " << i << "\",link=\"" << "scc_" << i;
1591  dot << ".svg\"]\n";
1592  }
1593  }
1594  else
1595  message.debug() << "no cycles to output" << messaget::eom;
1596 
1597  dot << "}\n";
1598 
1599  dot.close();
1600  ref.close();
1601  output.close();
1602  all.close();
1603  table.close();
1604 }
1605 
1607 #if 1
1608 // #ifdef _WIN32
1610 {
1611  unsigned scc=0;
1613  std::set<event_grapht::critical_cyclet>());
1614  for(std::vector<std::set<event_idt> >::const_iterator it=egraph_SCCs.begin();
1615  it!=egraph_SCCs.end(); it++)
1616  if(it->size()>=4)
1617  egraph.collect_cycles(set_of_cycles_per_SCC[scc++], model, *it);
1618 }
1619 #else
1620 class pthread_argumentt
1621 {
1622 public:
1623  instrumentert &instr;
1624  memory_modelt mem;
1625  const std::set<event_idt> &filter;
1626  std::set<event_grapht::critical_cyclet> &cycles;
1627 
1628  pthread_argumentt(instrumentert &_instr,
1629  memory_modelt _mem,
1630  const std::set<event_idt> &_filter,
1631  std::set<event_grapht::critical_cyclet> &_cycles)
1632  :instr(_instr), mem(_mem), filter(_filter), cycles(_cycles)
1633  {
1634  }
1635 };
1636 
1637 /* wraper */
1638 void *collect_cycles_in_thread(void *arg)
1639 {
1640  /* arguments */
1641  pthread_argumentt *p_arg=reinterpret_cast<pthread_argumentt*>(arg);
1642  instrumentert &this_instrumenter=p_arg->instr;
1643  memory_modelt model=p_arg->mem;
1644  const std::set<event_idt> &filter=p_arg->filter;
1645  std::set<event_grapht::critical_cyclet> &cycles=p_arg->cycles;
1646 
1647  this_instrumenter.egraph.collect_cycles(cycles, model, filter);
1648 
1649  return NULL;
1650 }
1651 
1653 {
1654  const unsigned number_of_sccs=num_sccs;
1655  std::set<unsigned> interesting_SCCs;
1656 
1657  unsigned scc=0;
1658  pthread_t *threads=new pthread_t[num_sccs+1];
1659 
1661  std::set<event_grapht::critical_cyclet>());
1662 
1663  for(std::vector<std::set<unsigned> >::const_iterator it=egraph_SCCs.begin();
1664  it!=egraph_SCCs.end(); it++)
1665  if(it->size()>=4)
1666  {
1667  interesting_SCCs.insert(scc);
1668  pthread_argumentt arg(*this, model, *it, set_of_cycles_per_SCC[scc]);
1669 
1670  int rc=pthread_create(&threads[scc++], NULL,
1671  collect_cycles_in_thread, &arg);
1672 
1673  message.status()<<(rc!=0?"Failure ":"Success ")
1674  <<"in creating thread for SCC #"<<scc-1<<messaget::eom;
1675  }
1676 
1677  for(unsigned i=0; i<number_of_sccs; i++)
1678  if(interesting_SCCs.find(i)!=interesting_SCCs.end())
1679  {
1680  int rc=pthread_join(threads[i], NULL);
1681  message.status()<<(rc!=0?"Failure ":"Success ")
1682  <<"in joining thread for SCC #"<<i<<messaget::eom;
1683  }
1684 
1685  delete[] threads;
1686 }
1687 #endif
std::string get_operation() const
source_locationt source_location
irep_idt function_id
const irep_idt & get_statement() const
Definition: std_code.h:69
dstringt has one field, an unsigned integer no which is an index into a static table of strings.
Definition: dstring.h:37
std::string::const_iterator begin() const
Definition: dstring.h:176
data_typet::const_iterator const_iterator
Definition: event_graph.h:70
event_idt copy_segment(event_idt begin, event_idt end)
Definition: event_graph.cpp:91
const wmm_grapht::edgest & po_out(event_idt n) const
Definition: event_graph.h:438
void collect_cycles(std::set< critical_cyclet > &set_of_cycles, memory_modelt model, const std::set< event_idt > &filter)
Definition: event_graph.h:551
std::map< unsigned, data_dpt > map_data_dp
Definition: event_graph.h:397
void add_com_edge(event_idt a, event_idt b)
Definition: event_graph.h:473
messaget & message
Definition: event_graph.h:394
void add_po_edge(event_idt a, event_idt b)
Definition: event_graph.h:453
void add_po_back_edge(event_idt a, event_idt b)
Definition: event_graph.h:462
event_idt add_node()
Definition: event_graph.h:405
Base class for all expressions.
Definition: expr.h:54
const source_locationt & source_location() const
Definition: expr.h:230
The Boolean constant false.
Definition: std_expr.h:2811
A collection of goto functions.
std::map< irep_idt, goto_functiont > function_mapt
function_mapt function_map
static irep_idt entry_point()
Get the identifier of the entry point to a goto model.
A goto function, consisting of function body (see body) and parameter identifiers (see parameter_iden...
Definition: goto_function.h:24
goto_programt body
Definition: goto_function.h:26
This class represents an instruction in the GOTO intermediate representation.
Definition: goto_program.h:178
void clear(goto_program_instruction_typet _type)
Clear the node.
Definition: goto_program.h:503
bool is_set_return_value() const
Definition: goto_program.h:528
std::set< targett > incoming_edges
Definition: goto_program.h:496
source_locationt source_location
The location of the instruction in the source file.
Definition: goto_program.h:431
const exprt & call_function() const
Get the function that is called for FUNCTION_CALL.
Definition: goto_program.h:361
goto_program_instruction_typet type
What kind of instruction?
Definition: goto_program.h:434
const codet & get_code() const
Get the code represented by this instruction.
Definition: goto_program.h:185
bool is_backwards_goto() const
Returns true if the instruction is a backwards branch.
Definition: goto_program.h:604
A generic container class for the GOTO intermediate representation of one function.
Definition: goto_program.h:71
instructionst instructions
The list of instructions in the goto program.
Definition: goto_program.h:652
void copy_from(const goto_programt &src)
Copy a full goto program, preserving targets.
instructionst::const_iterator const_targett
Definition: goto_program.h:647
std::list< instructiont > instructionst
Definition: goto_program.h:644
targett add(instructiont &&instruction)
Adds a given instruction at the end.
Definition: goto_program.h:753
static instructiont make_assertion(const exprt &g, const source_locationt &l=source_locationt::nil())
Definition: goto_program.h:951
std::size_t SCCs(std::vector< node_indext > &subgraph_nr) const
Computes strongly-connected components of a graph and yields a vector expressing a mapping from nodes...
Definition: graph.h:832
nodet::edgest edgest
Definition: graph.h:170
node_indext add_node(arguments &&... values)
Definition: graph.h:180
void add_edge(node_indext a, node_indext b)
Definition: graph.h:232
std::size_t size() const
Definition: graph.h:212
void visit_cfg_backedge(goto_programt::const_targett targ, goto_programt::const_targett i_it)
strategy: fwd/bwd alternation
Definition: goto2graph.cpp:583
void visit_cfg_reference_function(irep_idt id_function)
references the first and last edges of the function
Definition: goto2graph.cpp:317
bool contains_shared_array(const irep_idt &function_id, goto_programt::const_targett targ, goto_programt::const_targett i_it, value_setst &value_sets) const
Definition: goto2graph.cpp:409
instrumentert & instrumenter
Definition: goto2graph.h:90
virtual void visit_cfg_function(value_setst &value_sets, memory_modelt model, bool no_dependencies, loop_strategyt duplicate_body, const irep_idt &function_id, std::set< nodet > &ending_vertex)
TODO: move the visitor outside, and inherit.
Definition: goto2graph.cpp:148
std::pair< irep_idt, event_idt > id2node_pairt
Definition: goto2graph.h:181
bool local(const irep_idt &i)
Definition: goto2graph.cpp:81
void visit_cfg_fence(goto_programt::instructionst::iterator i_it, const irep_idt &function_id)
void visit_cfg_goto(const irep_idt &function_id, const goto_programt &goto_program, goto_programt::instructionst::iterator i_it, loop_strategyt replicate_body, value_setst &value_sets)
Definition: goto2graph.cpp:649
void visit_cfg_function_call(value_setst &value_sets, goto_programt::instructionst::iterator i_it, memory_modelt model, bool no_dependenciess, loop_strategyt duplicate_body)
Definition: goto2graph.cpp:687
void visit_cfg_lwfence(goto_programt::instructionst::iterator i_it, const irep_idt &function_id)
Definition: goto2graph.cpp:749
void visit_cfg_propagate(goto_programt::instructionst::iterator i_it)
Definition: goto2graph.cpp:295
void visit_cfg_assign(value_setst &value_sets, const irep_idt &function_id, goto_programt::instructionst::iterator &i_it, bool no_dependencies)
Definition: goto2graph.cpp:841
void visit_cfg(value_setst &value_sets, memory_modelt model, bool no_dependencies, loop_strategyt duplicate_body, const irep_idt &function_id)
Definition: goto2graph.h:253
void visit_cfg_duplicate(const goto_programt &goto_program, goto_programt::const_targett targ, goto_programt::const_targett i_it)
Definition: goto2graph.cpp:518
void visit_cfg_body(const irep_idt &function_id, const goto_programt &goto_program, goto_programt::const_targett i_it, loop_strategyt replicate_body, value_setst &value_sets)
strategy: fwd/bwd alternation
Definition: goto2graph.cpp:465
std::pair< event_idt, event_idt > nodet
Definition: goto2graph.h:190
void visit_cfg_skip(goto_programt::instructionst::iterator i_it)
void visit_cfg_asm_fence(goto_programt::instructionst::iterator i_it, const irep_idt &function_id)
Definition: goto2graph.cpp:788
void print_outputs(memory_modelt model, bool hide_internals)
unsigned num_sccs
Definition: goto2graph.h:315
void collect_cycles_by_SCCs(memory_modelt model)
Note: can be distributed (#define DISTRIBUTED)
event_grapht egraph
Definition: goto2graph.h:305
std::set< event_grapht::critical_cyclet > set_of_cycles
Definition: goto2graph.h:311
bool render_po_aligned
Definition: goto2graph.h:45
std::set< irep_idt > var_to_instr
Definition: goto2graph.h:349
std::vector< std::set< event_idt > > egraph_SCCs
Definition: goto2graph.h:308
std::multimap< irep_idt, source_locationt > id2loc
Definition: goto2graph.h:350
bool is_cfg_spurious(const event_grapht::critical_cyclet &cyc)
bool render_by_function
Definition: goto2graph.h:47
goto_functionst & goto_functions
Definition: goto2graph.h:36
bool render_by_file
Definition: goto2graph.h:46
std::map< event_idt, event_idt > map_vertex_gnode
Definition: goto2graph.h:39
namespacet ns
Definition: goto2graph.h:33
std::vector< std::set< event_grapht::critical_cyclet > > set_of_cycles_per_SCC
Definition: goto2graph.h:314
wmm_grapht egraph_alt
Definition: goto2graph.h:40
void add_instr_to_interleaving(goto_programt::instructionst::iterator it, goto_programt &interleaving)
messaget & message
Definition: goto2graph.h:302
bool local(const irep_idt &id)
is local variable?
Definition: goto2graph.cpp:33
unsigned goto2graph_cfg(value_setst &value_sets, memory_modelt model, bool no_dependencies, loop_strategyt duplicate_body)
goes through CFG and build a static abstract event graph overapproximating the read/write relations f...
Definition: goto2graph.cpp:88
void cfg_cycles_filter()
void print_outputs_local(const std::set< event_grapht::critical_cyclet > &set, std::ofstream &dot, std::ofstream &ref, std::ofstream &output, std::ofstream &all, std::ofstream &table, memory_modelt model, bool hide_internals)
bool get_bool(const irep_namet &name) const
Definition: irep.cpp:58
mstreamt & statistics() const
Definition: message.h:419
mstreamt & status() const
Definition: message.h:414
mstreamt & debug() const
Definition: message.h:429
static eomt eom
Definition: message.h:297
bool lookup(const irep_idt &name, const symbolt *&symbol) const override
See documentation for namespace_baset::lookup().
Definition: namespace.cpp:138
entriest r_entries
Definition: rw_set.h:59
entriest w_entries
Definition: rw_set.h:59
const irep_idt & get_file() const
const irep_idt & get_identifier() const
Definition: std_expr.h:109
Symbol table entry.
Definition: symbol.h:28
bool is_static_lifetime
Definition: symbol.h:65
bool is_thread_local
Definition: symbol.h:65
bool has_prefix(const std::string &s, const std::string &prefix)
Definition: converter.cpp:13
#define CPROVER_PREFIX
void dot(const goto_modelt &src, std::ostream &out)
Definition: dot.cpp:352
wmm_grapht::node_indext event_idt
Definition: event_graph.h:32
bool is_fence(const goto_programt::instructiont &instruction, const namespacet &ns)
Definition: fence.cpp:19
bool is_lwfence(const goto_programt::instructiont &instruction, const namespacet &ns)
Definition: fence.cpp:35
Fences for instrumentation.
event_idt alt_copy_segment(wmm_grapht &alt_egraph, event_idt begin, event_idt end)
Definition: goto2graph.cpp:400
Instrumenter.
#define add_all_pos(it, target, source)
Definition: goto2graph.h:200
#define forall_goto_program_instructions(it, program)
#define Forall_goto_program_instructions(it, program)
dstring_hash irep_id_hash
Definition: irep.h:40
const std::string & id2string(const irep_idt &d)
Definition: irep.h:49
literalt pos(literalt a)
Definition: literal.h:194
Options.
Race Detection for Threaded Goto Programs.
#define INITIALIZE_FUNCTION
const symbol_exprt & to_symbol_expr(const exprt &expr)
Cast an exprt to a symbol_exprt.
Definition: std_expr.h:189
std::string to_string(const string_not_contains_constraintt &expr)
Used for debug printing.
Definition: data_dp.h:25
memory_modelt
Definition: wmm.h:18
@ TSO
Definition: wmm.h:20
loop_strategyt
Definition: wmm.h:37
@ all_loops
Definition: wmm.h:39
@ arrays_only
Definition: wmm.h:38
@ no_loop
Definition: wmm.h:40
@ all
Definition: wmm.h:28