Merge pull request #4762 from smowton/smowton/fix/gbf-in-mach-o

Fix is_goto_binary to pass extended Mach-O header to osx_fat_reader

Author: peterschrammel

src/goto-programs/read_goto_binary.cpp

@@ -205,11 +205,10 @@ bool is_goto_binary(
   // 1. goto binaries, marked with 0x7f GBF
   // 2. ELF binaries, marked with 0x7f ELF
 
-  char hdr[4];
-  hdr[0]=in.get();
-  hdr[1]=in.get();
-  hdr[2]=in.get();
-  hdr[3]=in.get();
+  char hdr[8];
+  in.read(hdr, 8);
+  if(!in)
+    return false;
 
   if(hdr[0]==0x7f && hdr[1]=='G' && hdr[2]=='B' && hdr[3]=='F')
   {

unit/Makefile

@@ -27,6 +27,7 @@ SRC += analyses/ai/ai.cpp \
        goto-programs/goto_program_table_consistency.cpp \
        goto-programs/goto_program_validate.cpp \
        goto-programs/goto_trace_output.cpp \
+       goto-programs/is_goto_binary.cpp \
        goto-programs/osx_fat_reader.cpp \
        goto-programs/remove_returns.cpp \
        goto-programs/xml_expr.cpp \

unit/goto-programs/hello_elf

@@ -0,0 +1,72 @@
+/*******************************************************************\
+
+Module: Unit tests for is_goto_binary
+
+Author: Diffblue Ltd.
+
+\*******************************************************************/
+
+#include <testing-utils/use_catch.h>
+
+#include <goto-programs/read_goto_binary.h>
+#include <util/message.h>
+
+#include <sstream>
+
+TEST_CASE("is_goto_binary", "[core][goto-programs][is_goto_binary]")
+{
+  std::string class_file("goto-programs/Hello.class");
+  std::string fat_macho("goto-programs/hello_fat_macho");
+  std::string fat_macho_with_gbf("goto-programs/hello_fat_macho_with_gbf");
+  std::string elf("goto-programs/hello_elf");
+  std::string elf_with_gbf("goto-programs/hello_elf_with_gbf");
+
+  std::ostringstream fat_macho_output;
+  stream_message_handlert fat_macho_output_handler(fat_macho_output);
+  std::ostringstream fat_macho_with_gbf_output;
+  stream_message_handlert fat_macho_with_gbf_output_handler(
+    fat_macho_with_gbf_output);
+  std::ostringstream elf_output;
+  stream_message_handlert elf_output_handler(elf_output);
+  std::ostringstream elf_with_gbf_output;
+  stream_message_handlert elf_with_gbf_output_handler(elf_with_gbf_output);
+  std::ostringstream class_file_output;
+  stream_message_handlert class_file_output_handler(class_file_output);
+
+  bool class_file_is_gbf =
+    is_goto_binary(class_file, class_file_output_handler);
+  REQUIRE(!class_file_is_gbf);
+  REQUIRE(class_file_output.str().empty());
+
+  bool elf_has_gbf = is_goto_binary(elf, elf_output_handler);
+  bool elf_with_gbf_has_gbf =
+    is_goto_binary(elf_with_gbf, elf_with_gbf_output_handler);
+  REQUIRE(!elf_has_gbf);
+  REQUIRE(elf_with_gbf_has_gbf);
+  REQUIRE(elf_output.str().empty());
+  REQUIRE(elf_with_gbf_output.str().empty());
+
+  bool fat_macho_has_gbf = is_goto_binary(fat_macho, fat_macho_output_handler);
+  bool fat_macho_with_gbf_has_gbf =
+    is_goto_binary(fat_macho_with_gbf, fat_macho_with_gbf_output_handler);
+
+#ifdef __APPLE__
+
+  REQUIRE(!fat_macho_has_gbf);
+  REQUIRE(fat_macho_output.str().empty());
+  REQUIRE(fat_macho_with_gbf_has_gbf);
+  REQUIRE(fat_macho_with_gbf_output.str().empty());
+
+#else
+
+  REQUIRE(!fat_macho_has_gbf);
+  REQUIRE(
+    fat_macho_output.str() == "Cannot read OSX fat archive on this platform\n");
+
+  REQUIRE(!fat_macho_with_gbf_has_gbf);
+  REQUIRE(
+    fat_macho_with_gbf_output.str() ==
+    "Cannot read OSX fat archive on this platform\n");
+
+#endif
+}

unit/goto-programs/hello_elf_with_gbf

@@ -18,25 +18,34 @@ Author: Diffblue Ltd.
 TEST_CASE("OSX fat binary reader", "[core][goto-programs][osx_fat_reader]")
 {
   std::ifstream class_file("goto-programs/Hello.class");
-  std::ifstream fat_binary("goto-programs/hello_fat");
+  std::ifstream fat_macho("goto-programs/hello_fat_macho");
+  std::ifstream fat_macho_with_gbf("goto-programs/hello_fat_macho_with_gbf");
 
   char class_header[8];
-  char fat_binary_header[8];
+  char fat_macho_header[8];
+  char fat_macho_with_gbf_header[8];
 
   class_file.read(class_header, 8);
-  fat_binary.read(fat_binary_header, 8);
+  fat_macho.read(fat_macho_header, 8);
+  fat_macho_with_gbf.read(fat_macho_with_gbf_header, 8);
 
   REQUIRE(class_file);
-  REQUIRE(fat_binary);
+  REQUIRE(fat_macho);
+  REQUIRE(fat_macho_with_gbf);
 
-  REQUIRE(is_osx_fat_header(fat_binary_header));
+  REQUIRE(is_osx_fat_header(fat_macho_header));
+  REQUIRE(is_osx_fat_header(fat_macho_with_gbf_header));
   REQUIRE(!is_osx_fat_header(class_header));
 
   class_file.seekg(0);
-  fat_binary.seekg(0);
-
-  std::ostringstream fat_binary_output;
-  stream_message_handlert fat_binary_output_handler(fat_binary_output);
+  fat_macho.seekg(0);
+  fat_macho_with_gbf.seekg(0);
+
+  std::ostringstream fat_macho_output;
+  stream_message_handlert fat_macho_output_handler(fat_macho_output);
+  std::ostringstream fat_macho_with_gbf_output;
+  stream_message_handlert fat_macho_with_gbf_output_handler(
+    fat_macho_with_gbf_output);
   std::ostringstream class_file_output;
   stream_message_handlert class_file_output_handler(class_file_output);
 
@@ -45,9 +54,15 @@ TEST_CASE("OSX fat binary reader", "[core][goto-programs][osx_fat_reader]")
   REQUIRE_THROWS_AS(
     (osx_fat_readert{class_file, class_file_output_handler}),
     deserialization_exceptiont);
-  osx_fat_readert fat_binary_reader(fat_binary, fat_binary_output_handler);
-  REQUIRE(fat_binary_output.str().empty());
-  REQUIRE(!fat_binary_reader.has_gb());
+
+  osx_fat_readert fat_macho_reader(fat_macho, fat_macho_output_handler);
+  REQUIRE(fat_macho_output.str().empty());
+  REQUIRE(!fat_macho_reader.has_gb());
+
+  osx_fat_readert fat_macho_with_gbf_reader(
+    fat_macho_with_gbf, fat_macho_with_gbf_output_handler);
+  REQUIRE(fat_macho_with_gbf_output.str().empty());
+  REQUIRE(fat_macho_with_gbf_reader.has_gb());
 
 #else
 
@@ -57,10 +72,16 @@ TEST_CASE("OSX fat binary reader", "[core][goto-programs][osx_fat_reader]")
     class_file_output.str() ==
     "Cannot read OSX fat archive on this platform\n");
 
-  osx_fat_readert fat_binary_reader(fat_binary, fat_binary_output_handler);
-  REQUIRE(!fat_binary_reader.has_gb());
+  osx_fat_readert fat_macho_reader(fat_macho, fat_macho_output_handler);
+  REQUIRE(!fat_macho_reader.has_gb());
+  REQUIRE(
+    fat_macho_output.str() == "Cannot read OSX fat archive on this platform\n");
+
+  osx_fat_readert fat_macho_with_gbf_reader(
+    fat_macho_with_gbf, fat_macho_with_gbf_output_handler);
+  REQUIRE(!fat_macho_with_gbf_reader.has_gb());
   REQUIRE(
-    fat_binary_output.str() ==
+    fat_macho_with_gbf_output.str() ==
     "Cannot read OSX fat archive on this platform\n");
 
 #endif