Use the DiagnosticHandler to print diagnostics when reading bitcode.
authorRafael Espindola <rafael.espindola@gmail.com>
Sat, 10 Jan 2015 00:07:30 +0000 (00:07 +0000)
committerRafael Espindola <rafael.espindola@gmail.com>
Sat, 10 Jan 2015 00:07:30 +0000 (00:07 +0000)
commit68016e0a6e68335f6b9bff3cccd4f97bd82872dd
tree89086b154d17f091260569f628d600d88d37dc88
parentf79e2d40b278bf9d1f52dcb46035fc7aa453639f
Use the DiagnosticHandler to print diagnostics when reading bitcode.

The bitcode reading interface used std::error_code to report an error to the
callers and it is the callers job to print diagnostics.

This is not ideal for error handling or diagnostic reporting:

* For error handling, all that the callers care about is 3 possibilities:
  * It worked
  * The bitcode file is corrupted/invalid.
  * The file is not bitcode at all.

* For diagnostic, it is user friendly to include far more information
  about the invalid case so the user can find out what is wrong with the
  bitcode file. This comes up, for example, when a developer introduces a
  bug while extending the format.

The compromise we had was to have a lot of error codes.

With this patch we use the DiagnosticHandler to communicate with the
human and std::error_code to communicate with the caller.

This allows us to have far fewer error codes and adds the infrastructure to
print better diagnostics. This is so because the diagnostics are printed when
he issue is found. The code that detected the problem in alive in the stack and
can pass down as much context as needed. As an example the patch updates
test/Bitcode/invalid.ll.

Using a DiagnosticHandler also moves the fatal/non-fatal error decision to the
caller. A simple one like llvm-dis can just use fatal errors. The gold plugin
needs a bit more complex treatment because of being passed non-bitcode files. An
hypothetical interactive tool would make all bitcode errors non-fatal.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@225562 91177308-0d34-0410-b5e6-96231b3b80d8
include/llvm/Bitcode/ReaderWriter.h
include/llvm/IR/DiagnosticInfo.h
include/llvm/Linker/Linker.h
lib/Bitcode/Reader/BitcodeReader.cpp
lib/Bitcode/Reader/BitcodeReader.h
lib/LTO/LTOModule.cpp
lib/Linker/LinkModules.cpp
test/Bitcode/invalid.ll
test/LTO/invalid.ll
tools/gold/gold-plugin.cpp
tools/llvm-dis/llvm-dis.cpp