1 //===- Error.h - system_error extensions for Object -------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This declares a new error_category for the Object library.
10 //
11 //===----------------------------------------------------------------------===//
12
13 #ifndef LLVM_OBJECT_ERROR_H
14 #define LLVM_OBJECT_ERROR_H
15
16 #include "llvm/Support/Compiler.h"
17 #include "llvm/Support/Error.h"
18 #include <system_error>
19
20 namespace llvm {
21
22 class Twine;
23
24 namespace object {
25
26 LLVM_ABI const std::error_category &object_category();
27
28 enum class object_error {
29 // Error code 0 is absent. Use std::error_code() instead.
30 arch_not_found = 1,
31 invalid_file_type,
32 parse_failed,
33 unexpected_eof,
34 string_table_non_null_end,
35 invalid_section_index,
36 bitcode_section_not_found,
37 invalid_symbol_index,
38 section_stripped,
39 };
40
make_error_code(object_error e)41 inline std::error_code make_error_code(object_error e) {
42 return std::error_code(static_cast<int>(e), object_category());
43 }
44
45 /// Base class for all errors indicating malformed binary files.
46 ///
47 /// Having a subclass for all malformed binary files allows archive-walking
48 /// code to skip malformed files without having to understand every possible
49 /// way that a binary file might be malformed.
50 ///
51 /// Currently inherits from ECError for easy interoperability with
52 /// std::error_code, but this will be removed in the future.
53 class LLVM_ABI BinaryError : public ErrorInfo<BinaryError, ECError> {
54 void anchor() override;
55 public:
56 static char ID;
BinaryError()57 BinaryError() {
58 // Default to parse_failed, can be overridden with setErrorCode.
59 setErrorCode(make_error_code(object_error::parse_failed));
60 }
61 };
62
63 /// Generic binary error.
64 ///
65 /// For errors that don't require their own specific sub-error (most errors)
66 /// this class can be used to describe the error via a string message.
67 class LLVM_ABI GenericBinaryError
68 : public ErrorInfo<GenericBinaryError, BinaryError> {
69 public:
70 static char ID;
71 GenericBinaryError(const Twine &Msg);
72 GenericBinaryError(const Twine &Msg, object_error ECOverride);
getMessage()73 const std::string &getMessage() const { return Msg; }
74 void log(raw_ostream &OS) const override;
75 private:
76 std::string Msg;
77 };
78
79 /// isNotObjectErrorInvalidFileType() is used when looping through the children
80 /// of an archive after calling getAsBinary() on the child and it returns an
81 /// llvm::Error. In the cases we want to loop through the children and ignore the
82 /// non-objects in the archive this is used to test the error to see if an
83 /// error() function needs to called on the llvm::Error.
84 LLVM_ABI Error isNotObjectErrorInvalidFileType(llvm::Error Err);
85
createError(const Twine & Err)86 inline Error createError(const Twine &Err) {
87 return make_error<StringError>(Err, object_error::parse_failed);
88 }
89
90 } // end namespace object.
91
92 } // end namespace llvm.
93
94 namespace std {
95 template <>
96 struct is_error_code_enum<llvm::object::object_error> : std::true_type {};
97 }
98
99 #endif
100