teak-llvm/llvm/tools/llvm-elfabi/ErrorCollector.h
Armando Montanez 31f0f659a8 [elfabi] Introduce tool for ELF TextAPI
Follow up for D53051

This patch introduces the tool associated with the ELF implementation of
TextAPI (previously llvm-tapi, renamed for better distinction). This
tool will house a number of features related to enalysis and
manipulation of shared object's exposed interfaces. The first major
feature for this tool is support for producing binary stubs that are
useful for compile-time linking of shared objects. This patch introduces
beginnings of support for reading binary ELF objects to work towards
that goal.

Added:

 - elfabi tool.
 - support for reading architecture from a binary ELF file into an
 ELFStub.
 - Support for writing .tbe files.

Differential Revision: https://reviews.llvm.org/D55352

llvm-svn: 350341
2019-01-03 18:32:36 +00:00

76 lines
2.8 KiB
C++

//===- ErrorCollector.h -----------------------------------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===-----------------------------------------------------------------------===/
///
/// This class collects errors that should be reported or ignored in aggregate.
///
/// Like llvm::Error, an ErrorCollector cannot be copied. Unlike llvm::Error,
/// an ErrorCollector may be destroyed if it was originally constructed to treat
/// errors as non-fatal. In this case, all Errors are consumed upon destruction.
/// An ErrorCollector may be initially constructed (or escalated) such that
/// errors are treated as fatal. This causes a crash if an attempt is made to
/// delete the ErrorCollector when some Errors have not been retrieved via
/// makeError().
///
//===-----------------------------------------------------------------------===/
#ifndef LLVM_TOOLS_ELFABI_ERRORCOLLECTOR_H
#define LLVM_TOOLS_ELFABI_ERRORCOLLECTOR_H
#include "llvm/Support/Error.h"
#include <vector>
namespace llvm {
namespace elfabi {
class ErrorCollector {
public:
/// Upon destruction, an ErrorCollector will crash if UseFatalErrors=true and
/// there are remaining errors that haven't been fetched by makeError().
ErrorCollector(bool UseFatalErrors = true) : ErrorsAreFatal(UseFatalErrors) {}
// Don't allow copying.
ErrorCollector(const ErrorCollector &Stub) = delete;
ErrorCollector &operator=(const ErrorCollector &Other) = delete;
~ErrorCollector();
// TODO: Add move constructor and operator= when a testable situation arises.
/// Returns a single error that contains messages for all stored Errors.
Error makeError();
/// Adds an error with a descriptive tag that helps with identification.
/// If the error is an Error::success(), it is checked and discarded.
void addError(Error &&E, StringRef Tag);
/// This ensures an ErrorCollector will treat unhandled errors as fatal.
/// This function should be called if errors that usually can be ignored
/// are suddenly of concern (i.e. attempt multiple things that return Error,
/// but only care about the Errors if no attempt succeeds).
void escalateToFatal();
private:
/// Logs all errors to a raw_ostream.
void log(raw_ostream &OS);
/// Returns true if all errors have been retrieved through makeError(), or
/// false if errors have been added since the last makeError() call.
bool allErrorsHandled() const;
/// Dump output and crash.
LLVM_ATTRIBUTE_NORETURN void fatalUnhandledError();
bool ErrorsAreFatal;
std::vector<Error> Errors;
std::vector<std::string> Tags;
};
} // end namespace elfabi
} // end namespace llvm
#endif // LLVM_TOOLS_ELFABI_ERRORCOLLECTOR_H