Report fatal translator errors to the browser

lib/Bitcode/NaCl/Reader/NaClBitcodeHeader.cpp

 //===- NaClBitcodeHeader.cpp ----------------------------------------------===//
 //     PNaCl bitcode header reader.
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Bitcode/NaCl/NaClBitcodeHeader.h"
 #include "llvm/Bitcode/NaCl/NaClReaderWriter.h"
+#include "llvm/Bitcode/ReaderWriter.h"
 #include "llvm/Support/ErrorHandling.h"
 #include "llvm/Support/Format.h"
 #include "llvm/Support/raw_ostream.h"
 #include "llvm/Support/StreamableMemoryObject.h"
 
 #include <limits>
 #include <cstring>
 #include <iomanip>
 
 using namespace llvm;
@@ skipping 88 matching lines @@
   case kBufferType:
     ss << "[";
     for (size_t i = 0; i < Len; ++i) {
       if (i)
         ss << " ";
       ss << format("%02x", Data[i]);
     }
     ss << "]";
     break;
   default:
-    report_fatal_error("PNaCL bitcode file contains unknown field type");
+    report_fatal_error("PNaCl bitcode file contains unknown field type");
   }
   return ss.str();
 }
 
 NaClBitcodeHeader::NaClBitcodeHeader()
     : HeaderSize(0), UnsupportedMessage(), IsSupportedFlag(false),
       IsReadableFlag(false), PNaClVersion(0) {}
 
 NaClBitcodeHeader::~NaClBitcodeHeader() {
   for (std::vector<NaClBitcodeHeaderField *>::const_iterator
            Iter = Fields.begin(),
            IterEnd = Fields.end();
        Iter != IterEnd; ++Iter) {
     delete *Iter;
   }
 }
 
 bool NaClBitcodeHeader::ReadPrefix(const unsigned char *BufPtr,
                                    const unsigned char *BufEnd,
                                    unsigned &NumFields, unsigned &NumBytes) {
   // Must contain PEXE.
-  if (!isNaClBitcode(BufPtr, BufEnd))
+  if (!isNaClBitcode(BufPtr, BufEnd)) {
+    UnsupportedMessage = "Invalid PNaCl bitcode header";
+    if (isBitcode(BufPtr, BufEnd)) {
+      UnsupportedMessage += " (to run in Chrome, bitcode files must be "
+          "finalized using pnacl-finalize)";
+    }
     return true;
+  }
   BufPtr += WordSize;
 
   // Read #Fields and number of bytes needed for the header.
   if (BufPtr + WordSize > BufEnd)
-    return true;
+    return UnsupportedError("Bitcode read failure");
   NumFields = static_cast<unsigned>(BufPtr[0]) |
       (static_cast<unsigned>(BufPtr[1]) << 8);
   NumBytes = static_cast<unsigned>(BufPtr[2]) |
       (static_cast<unsigned>(BufPtr[3]) << 8);
   BufPtr += WordSize;
   return false;
 }
 
 bool NaClBitcodeHeader::ReadFields(const unsigned char *BufPtr,
                                    const unsigned char *BufEnd,
                                    unsigned NumFields, unsigned NumBytes) {
   HeaderSize = NumBytes + (2 * WordSize);
 
   // Read in each field.
   for (size_t i = 0; i < NumFields; ++i) {
     NaClBitcodeHeaderField *Field = new NaClBitcodeHeaderField();
     Fields.push_back(Field);
     if (!Field->Read(BufPtr, BufEnd - BufPtr))
-      return true;
+      return UnsupportedError("Bitcode read failure");
     size_t FieldSize = Field->GetTotalSize();
     BufPtr += FieldSize;
   }
   return false;
 }
 
 bool NaClBitcodeHeader::Read(const unsigned char *&BufPtr,
                              const unsigned char *&BufEnd) {
   unsigned NumFields;
   unsigned NumBytes;
   if (ReadPrefix(BufPtr, BufEnd, NumFields, NumBytes))
-    return true;
+    return true; // ReadPrefix sets UnsupportedMessage
   BufPtr += 2 * WordSize;
 
   if (ReadFields(BufPtr, BufEnd, NumFields, NumBytes))
-    return true;
+    return true; // ReadFields sets UnsupportedMessage
   BufPtr += NumBytes;
   InstallFields();
   return false;
 }
 
 bool NaClBitcodeHeader::Read(StreamableMemoryObject *Bytes) {
   unsigned NumFields;
   unsigned NumBytes;
   {
     unsigned char Buffer[2 * WordSize];
     if (Bytes->readBytes(0, sizeof(Buffer), Buffer, NULL) ||
         ReadPrefix(Buffer, Buffer + sizeof(Buffer), NumFields, NumBytes))
-      return true;
+      // ReadPrefix sets UnsupportedMessage but readBytes does not

[jvoung (off chromium), 2013/09/13 20:20:23]

readBytes could happen first w/ a chance to set the message, then ReadPrefix()
w/out needing to set the message ?

[Derek Schuff, 2013/09/13 20:33:15]

I mean that if If readBytes fails, ReadPrefix will not run and the message will
not be set. So it is set explicitly here.

[jvoung (off chromium), 2013/09/13 20:35:25]

but is there a case where readBytes doesn't fail, but ReadPrefix does fail -- in
that case, does the "return UnsupportedError" end up giving us a less detailed
error message?

+      return UnsupportedError("Bitcode read failure");
   }
   uint8_t *Header = new uint8_t[NumBytes];
   bool failed =
       Bytes->readBytes(2 * WordSize, NumBytes, Header, NULL) ||
       ReadFields(Header, Header + NumBytes, NumFields, NumBytes);
   delete[] Header;
   if (failed)
-    return true;
+    return UnsupportedError("Bitcode read failure");
   InstallFields();
   return false;
 }
 
 NaClBitcodeHeaderField *
 NaClBitcodeHeader::GetTaggedField(NaClBitcodeHeaderField::Tag ID) const {
   for (std::vector<NaClBitcodeHeaderField *>::const_iterator
            Iter = Fields.begin(),
            IterEnd = Fields.end();
        Iter != IterEnd; ++Iter) {
@@ skipping 40 matching lines @@
                       << PNaClVersion << "\n";
     UnsupportedStream.flush();
   }
   if (Fields.size() != 1) {
     IsSupportedFlag = false;
     IsReadableFlag = false;
     if (!UpdatedUnsupportedMessage)
       UnsupportedMessage = "Unknown header field(s) found";
   }
 }