[all-commits] [llvm/llvm-project] ea8a0b: [llvm-readelf/obj] - Allow dumping of ELF header e...

[Georgii Rymar via All-commits]

  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: ea8a0b8b29eb08d3f0f6ac40942a2d8e98ab57ee
      https://github.com/llvm/llvm-project/commit/ea8a0b8b29eb08d3f0f6ac40942a2d8e98ab57ee
  Author: Georgii Rymar <grimar at accesssoftek.com>
  Date:   2020-11-09 (Mon, 09 Nov 2020)

  Changed paths:
    M llvm/include/llvm/Object/Binary.h
    M llvm/include/llvm/Object/ELFObjectFile.h
    M llvm/include/llvm/Object/ObjectFile.h
    M llvm/include/llvm/Object/SymbolicFile.h
    M llvm/lib/Object/Binary.cpp
    M llvm/lib/Object/ELFObjectFile.cpp
    M llvm/lib/Object/ObjectFile.cpp
    M llvm/lib/Object/SymbolicFile.cpp
    M llvm/test/Object/invalid.test
    M llvm/test/tools/llvm-readobj/ELF/file-headers.test
    M llvm/test/tools/yaml2obj/ELF/section-headers.yaml
    M llvm/tools/llvm-readobj/ELFDumper.cpp
    M llvm/tools/llvm-readobj/ObjDumper.h
    M llvm/tools/llvm-readobj/llvm-readobj.cpp

  Log Message:
  -----------
  [llvm-readelf/obj] - Allow dumping of ELF header even if some elements are corrupt.

For creating `ELFObjectFile` instances we have the factory method
`ELFObjectFile<ELFT>::create(MemoryBufferRef Object)`.

The problem of this method is that it scans the section header to locate some sections.
When a file is truncated or has broken fields in the ELF header, this approach does
not allow us to create the `ELFObjectFile` and dump the ELF header.

This is https://bugs.llvm.org/show_bug.cgi?id=40804

This patch suggests a solution - it allows to delay scaning sections in the
`ELFObjectFile<ELFT>::create`. It now allows user code to call an object
initialization (`initContent()`) later. With that it is possible,
for example, for dumpers just to dump the file header and exit.
By default initialization is still performed as before, what helps to keep
the logic of existent callers untouched.

I've experimented with different approaches when worked on this patch.
I think this approach is better than doing initialization of sections (i.e. scan of them)
on demand, because normally users of `ELFObjectFile` API expect to work with a valid object.
In most cases when a section header table can't be read (because of an error), we don't
have to continue to work with object. So we probably don't need to implement a more complex API.

Differential revision: https://reviews.llvm.org/D90903