Merge pull request #166 from diffblue/feature/wrap_entry_point_martin_changes

[TYT-5] Address Martin's comments of the Cyclic Dependency Analysis

Author: Thomas Kiley

regression/cbmc/wrap_entry_point_in_while_true/main.c

@@ -1,4 +1,7 @@
-int main(int argc, char **argv)
+int g = 0;
+
+int main(void)
 {
-    return 0;
+    assert(g == 0);
+    g = (g == 0) ? 1 : 0;
 }

regression/cbmc/wrap_entry_point_in_while_true/test.desc

@@ -1,8 +1,10 @@
 CORE
 main.c
---show-goto-functions --wrap-entry-point-in-while
-^EXIT=0$
+--wrap-entry-point-in-while --unwind 100
+^EXIT=10$
 ^SIGNAL=0$
-^     1: main\(argc', argv'\);$
-^        GOTO 1$
+^\[main.assertion.1\] assertion g == 0: FAILURE$
+^VERIFICATION FAILED$
+--
+^VERIFICATION SUCCESSFUL$
 --

regression/cbmc/wrap_entry_point_in_while_true_custom_entry_point/main.c

@@ -1,4 +1,7 @@
-int skipWhitespace()
+int g = 0;
+
+int skipWhitespace(void)
 {
-    return 120;
+    assert(g == 0);
+    g = (g == 0) ? 1 : 0;
 }

regression/cbmc/wrap_entry_point_in_while_true_custom_entry_point/test.desc

@@ -1,8 +1,10 @@
 CORE
 main.c
---show-goto-functions --wrap-entry-point-in-while --function skipWhitespace
-^EXIT=0$
+--wrap-entry-point-in-while --unwind 100 --function skipWhitespace
+^EXIT=10$
 ^SIGNAL=0$
-^     1: skipWhitespace\(\);$
-^        GOTO 1$
+^\[skipWhitespace.assertion.1\] assertion g == 0: FAILURE$
+^VERIFICATION FAILED$
+--
+^VERIFICATION SUCCESSFUL$
 --

regression/goto-analyzer/wrap_entry_point_in_while_true/main.c

@@ -1,4 +1,7 @@
-int main(int argc, char **argv)
+int g = 0;
+
+int main(void)
 {
-    return 0;
+    assert(g == 0);
+    g = (g == 0) ? 1 : 0;
 }

regression/goto-analyzer/wrap_entry_point_in_while_true/test.desc

@@ -1,9 +1,9 @@
 CORE
 main.c
---show-goto-functions --wrap-entry-point-in-while
+--wrap-entry-point-in-while --show-goto-functions
 ^EXIT=6$
 ^SIGNAL=0$
 ^     1: IF FALSE THEN GOTO 2$
-^        main\(argc', argv'\);$
+^        main\(\);$
 ^        GOTO 1$
 --

regression/goto-analyzer/wrap_entry_point_in_while_true_custom_entry_point/main.c

@@ -1,4 +1,7 @@
-int skipWhitespace()
+int g = 0;
+
+int skipWhitespace(void)
 {
-    return 120;
+    assert(g == 0);
+    g = (g == 0) ? 1 : 0;
 }

src/ansi-c/ansi_c_entry_point.cpp

@@ -22,13 +22,25 @@ Author: Daniel Kroening, [email protected]
 #include <ansi-c/string_constant.h>
 
 #include <goto-programs/goto_functions.h>
-#include <langapi/wrap_entry_point.h>
 #include <linking/static_lifetime_init.h>
 
 #include "ansi_c_entry_point.h"
 #include "ansi_c_language.h"
 #include "c_nondet_symbol_factory.h"
 
+// Build and return a while(true) statement nesting the function call
+// passed as a parameter.
+code_whilet wrap_entry_point_in_while(code_function_callt &call_main)
+{
+  exprt true_expr;
+  code_whilet while_expr;
+  true_expr.make_true();
+  while_expr.cond()=true_expr;
+  while_expr.body()=call_main;
+
+  return while_expr;
+}
+
 exprt::operandst build_function_environment(
   const code_typet::parameterst &parameters,
   code_blockt &init_code,
@@ -123,8 +135,7 @@ void record_function_outputs(
 bool ansi_c_entry_point(
   symbol_tablet &symbol_table,
   const std::string &standard_main,
-  message_handlert &message_handler,
-  bool wrap_entry_point)
+  message_handlert &message_handler)
 {
   // check if entry point is already there
   if(symbol_table.symbols.find(goto_functionst::entry_point())!=
@@ -447,7 +458,7 @@ bool ansi_c_entry_point(
         message_handler);
   }
 
-  if(wrap_entry_point)
+  if(config.ansi_c.wrap_entry_point_in_while)
   {
     code_whilet wrapped_main=wrap_entry_point_in_while(call_main);
     init_code.move_to_operands(wrapped_main);

src/ansi-c/ansi_c_entry_point.h

@@ -16,7 +16,6 @@ Author: Daniel Kroening, [email protected]
 bool ansi_c_entry_point(
   symbol_tablet &symbol_table,
   const std::string &standard_main,
-  message_handlert &message_handler,
-  bool wrap_entry_point);
+  message_handlert &message_handler);
 
 #endif // CPROVER_ANSI_C_ANSI_C_ENTRY_POINT_H

src/ansi-c/ansi_c_language.cpp

@@ -27,11 +27,6 @@ Author: Daniel Kroening, [email protected]
 #include "ansi_c_internal_additions.h"
 #include "type2name.h"
 
-void ansi_c_languaget::get_language_options(const cmdlinet &cmd)
-{
-  wrap_entry_point=cmd.isset("wrap-entry-point-in-while");
-}
-
 std::set<std::string> ansi_c_languaget::extensions() const
 {
   return { "c", "i" };
@@ -132,8 +127,7 @@ bool ansi_c_languaget::typecheck(
 
 bool ansi_c_languaget::final(symbol_tablet &symbol_table)
 {
-  if(ansi_c_entry_point(symbol_table, "main", get_message_handler(),
-     wrap_entry_point_in_while()))
+  if(ansi_c_entry_point(symbol_table, "main", get_message_handler()))
   {
     return true;
   }

src/ansi-c/ansi_c_language.h

@@ -22,9 +22,6 @@ Author: Daniel Kroening, [email protected]
 class ansi_c_languaget:public languaget
 {
 public:
-  virtual void get_language_options(
-    const cmdlinet &) override;
-
   bool preprocess(
     std::istream &instream,
     const std::string &path,
@@ -79,12 +76,6 @@ class ansi_c_languaget:public languaget
 protected:
   ansi_c_parse_treet parse_tree;
   std::string parse_path;
-
-  bool wrap_entry_point_in_while() const
-  { return wrap_entry_point; }
-
-private:
-  bool wrap_entry_point;
 };
 
 languaget *new_ansi_c_language();

src/cbmc/cbmc_parse_options.h

@@ -14,9 +14,9 @@ Author: Daniel Kroening, [email protected]
 
 #include <util/ui_message.h>
 #include <util/parse_options.h>
+#include <util/config.h>
 
 #include <langapi/language_ui.h>
-#include <langapi/wrap_entry_point.h>
 
 #include <analyses/goto_check.h>
 

src/cpp/cpp_language.cpp

@@ -29,11 +29,6 @@ Author: Daniel Kroening, [email protected]
 #include "cpp_typecheck.h"
 #include "cpp_type2name.h"
 
-void cpp_languaget::get_language_options(const cmdlinet &cmd)
-{
-  wrap_entry_point=cmd.isset("wrap-entry-point-in-while");
-}
-
 std::set<std::string> cpp_languaget::extensions() const
 {
   std::set<std::string> s;
@@ -140,8 +135,7 @@ bool cpp_languaget::typecheck(
 
 bool cpp_languaget::final(symbol_tablet &symbol_table)
 {
-  if(ansi_c_entry_point(symbol_table, "main", get_message_handler(),
-     wrap_entry_point_in_while()))
+  if(ansi_c_entry_point(symbol_table, "main", get_message_handler()))
   {
     return true;
   }

src/cpp/cpp_language.h

@@ -24,9 +24,6 @@ Author: Daniel Kroening, [email protected]
 class cpp_languaget:public languaget
 {
 public:
-  virtual void get_language_options(
-    const cmdlinet &cmd) override;
-
   bool preprocess(
     std::istream &instream,
     const std::string &path,
@@ -88,9 +85,6 @@ class cpp_languaget:public languaget
 
   void modules_provided(std::set<std::string> &modules) override;
 
-  bool wrap_entry_point_in_while() const
-  { return wrap_entry_point; }
-
 protected:
   cpp_parse_treet cpp_parse_tree;
   std::string parse_path;
@@ -101,9 +95,6 @@ class cpp_languaget:public languaget
   {
     return "main";
   }
-
-private:
-  bool wrap_entry_point;
 };
 
 languaget *new_cpp_language();

src/goto-analyzer/goto_analyzer_parse_options.h

@@ -106,10 +106,9 @@ graphs in DOT format.
 
 #include <util/ui_message.h>
 #include <util/parse_options.h>
+#include <util/config.h>
 
 #include <langapi/language_ui.h>
-#include <langapi/wrap_entry_point.h>
-
 #include <goto-programs/goto_model.h>
 #include <goto-programs/show_goto_functions.h>
 

src/goto-cc/compile.cpp

@@ -368,7 +368,7 @@ bool compilet::link()
     symbol_table.remove(goto_functionst::entry_point());
     compiled_functions.function_map.erase(goto_functionst::entry_point());
 
-    if(ansi_c_entry_point(symbol_table, "main", get_message_handler(), false))
+    if(ansi_c_entry_point(symbol_table, "main", get_message_handler()))
       return true;
 
     // entry_point may (should) add some more functions.

src/langapi/Makefile

@@ -2,7 +2,6 @@ SRC = language_ui.cpp \
       language_util.cpp \
       languages.cpp \
       mode.cpp \
-      wrap_entry_point.cpp \
       # Empty last line
 INCLUDES= -I ..
 

src/langapi/wrap_entry_point.cpp

@@ -757,6 +757,9 @@ bool configt::set(const cmdlinet &cmdline)
   if(cmdline.isset('I'))
     ansi_c.include_paths=cmdline.get_values('I');
 
+  ansi_c.wrap_entry_point_in_while=
+    cmdline.isset(WRAP_ENTRY_POINT_IN_WHILE_TRUE_STRING);
+
   if(cmdline.isset("classpath"))
   {
     // Specifying -classpath or -cp overrides any setting of the

src/langapi/wrap_entry_point.h

@@ -12,6 +12,8 @@ Author: Daniel Kroening, [email protected]
 
 #include <list>
 
+#include <util/std_code.h>
+
 #include "ieee_float.h"
 #include "irep.h"
 
@@ -44,6 +46,7 @@ class configt
     bool use_fixed_for_float;
     bool for_has_scope;
     bool single_precision_constant;
+    bool wrap_entry_point_in_while;
     enum class c_standardt { C89, C99, C11 } c_standard;
     static c_standardt default_c_standard();
 
@@ -160,4 +163,15 @@ class configt
 
 extern configt config;
 
+/// Command line option (to be shared by the different tools)
+/// (This contains the actual string, needed in config.cpp)
+#define WRAP_ENTRY_POINT_IN_WHILE_TRUE_STRING "wrap-entry-point-in-while"
+
+/// Command line option (to be shared by the different tools)
+#define WRAP_ENTRY_POINT_IN_WHILE_TRUE "(" WRAP_ENTRY_POINT_IN_WHILE_TRUE_STRING ")"
+
+/// Command line help text
+#define HELP_WRAP_ENTRY_POINT_IN_WHILE_TRUE \
+  " --wrap-entry-point-in-while  wrap the designated entry point function in a while(true) statement\n" // NOLINT(*)
+
 #endif // CPROVER_UTIL_CONFIG_H