goto-analyzer --reachable-functions

Provide the complement of --unreachable-functions

Author: tautschnig

CHANGELOG

@@ -3,7 +3,7 @@
 
 * GOTO-INSTRUMENT: New option --list-calls-args
 * GOTO-INSTRUMENT: New option --print-path-lenghts
-* GOTO-ANALYZER: New option --unreachable-functions
+* GOTO-ANALYZER: New option --unreachable-functions, --reachable-functions
 
 
 5.7

src/goto-analyzer/goto_analyzer_parse_options.cpp

@@ -289,6 +289,30 @@ int goto_analyzer_parse_optionst::doit()
     return 0;
   }
 
+  if(cmdline.isset("reachable-functions"))
+  {
+    const std::string json_file=cmdline.get_value("json");
+
+    if(json_file.empty())
+      reachable_functions(goto_model, false, std::cout);
+    else if(json_file=="-")
+      reachable_functions(goto_model, true, std::cout);
+    else
+    {
+      std::ofstream ofs(json_file);
+      if(!ofs)
+      {
+        error() << "Failed to open json output `"
+                << json_file << "'" << eom;
+        return 6;
+      }
+
+      reachable_functions(goto_model, true, ofs);
+    }
+
+    return 0;
+  }
+
   if(cmdline.isset("show-local-may-alias"))
   {
     namespacet ns(goto_model.symbol_table);
@@ -515,6 +539,8 @@ void goto_analyzer_parse_optionst::help()
     " --unreachable-instructions   list dead code\n"
     // NOLINTNEXTLINE(whitespace/line_length)
     " --unreachable-functions      list functions unreachable from the entry point\n"
+    // NOLINTNEXTLINE(whitespace/line_length)
+    " --reachable-functions        list functions reachable from the entry point\n"
     " --intervals                  interval analysis\n"
     " --non-null                   non-null analysis\n"
     "\n"

src/goto-analyzer/goto_analyzer_parse_options.h

@@ -37,6 +37,7 @@ class optionst;
   "(show-local-may-alias)" \
   "(json):(xml):" \
   "(unreachable-instructions)(unreachable-functions)" \
+  "(reachable-functions)" \
   "(intervals)(show-intervals)" \
   "(non-null)(show-non-null)"
 

src/goto-analyzer/unreachable_instructions.cpp

@@ -223,7 +223,7 @@ void unreachable_instructions(
 
 /*******************************************************************\
 
-Function: output_unreachable_function
+Function: json_output_function
 
   Inputs:
 
@@ -233,7 +233,7 @@ Function: output_unreachable_function
 
 \*******************************************************************/
 
-static void json_output_unreachable_function(
+static void json_output_function(
   const irep_idt &function,
   const source_locationt &first_location,
   const source_locationt &last_location,
@@ -254,7 +254,7 @@ static void json_output_unreachable_function(
 
 /*******************************************************************\
 
-Function: unreachable_functions
+Function: list_functions
 
   Inputs:
 
@@ -264,10 +264,11 @@ Function: unreachable_functions
 
 \*******************************************************************/
 
-void unreachable_functions(
+static void list_functions(
   const goto_modelt &goto_model,
   const bool json,
-  std::ostream &os)
+  std::ostream &os,
+  bool unreachable)
 {
   json_arrayt json_result;
 
@@ -282,8 +283,9 @@ void unreachable_functions(
 
     // f_it->first may be a link-time renamed version, use the
     // base_name instead; do not list inlined functions
-    if(called.find(decl.base_name)!=called.end() ||
-       f_it->second.is_inlined())
+    if(unreachable ==
+       (called.find(decl.base_name)!=called.end() ||
+        f_it->second.is_inlined()))
       continue;
 
     source_locationt first_location=decl.location;
@@ -315,7 +317,7 @@ void unreachable_functions(
          << last_location.get_line() << "\n";
     }
     else
-      json_output_unreachable_function(
+      json_output_function(
         decl.base_name,
         first_location,
         last_location,
@@ -325,3 +327,43 @@ void unreachable_functions(
   if(json && !json_result.array.empty())
     os << json_result << std::endl;
 }
+
+/*******************************************************************\
+
+Function: unreachable_functions
+
+  Inputs:
+
+ Outputs:
+
+ Purpose:
+
+\*******************************************************************/
+
+void unreachable_functions(
+  const goto_modelt &goto_model,
+  const bool json,
+  std::ostream &os)
+{
+  list_functions(goto_model, json, os, true);
+}
+
+/*******************************************************************\
+
+Function: reachable_functions
+
+  Inputs:
+
+ Outputs:
+
+ Purpose:
+
+\*******************************************************************/
+
+void reachable_functions(
+  const goto_modelt &goto_model,
+  const bool json,
+  std::ostream &os)
+{
+  list_functions(goto_model, json, os, false);
+}

src/goto-analyzer/unreachable_instructions.h

@@ -25,4 +25,9 @@ void unreachable_functions(
   const bool json,
   std::ostream &os);
 
+void reachable_functions(
+  const goto_modelt &,
+  const bool json,
+  std::ostream &os);
+
 #endif // CPROVER_GOTO_ANALYZER_UNREACHABLE_INSTRUCTIONS_H