xref: /freebsd/contrib/llvm-project/llvm/lib/Object/Error.cpp (revision 53f151f90603580d0c0a8fa1840ba1262958a7c1)
1  //===- Error.cpp - 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 defines a new error_category for the Object library.
10  //
11  //===----------------------------------------------------------------------===//
12  
13  #include "llvm/Object/Error.h"
14  #include "llvm/Support/ErrorHandling.h"
15  #include "llvm/Support/ManagedStatic.h"
16  
17  using namespace llvm;
18  using namespace object;
19  
20  namespace {
21  // FIXME: This class is only here to support the transition to llvm::Error. It
22  // will be removed once this transition is complete. Clients should prefer to
23  // deal with the Error value directly, rather than converting to error_code.
24  class _object_error_category : public std::error_category {
25  public:
26    const char* name() const noexcept override;
27    std::string message(int ev) const override;
28  };
29  }
30  
31  const char *_object_error_category::name() const noexcept {
32    return "llvm.object";
33  }
34  
35  std::string _object_error_category::message(int EV) const {
36    object_error E = static_cast<object_error>(EV);
37    switch (E) {
38    case object_error::arch_not_found:
39      return "No object file for requested architecture";
40    case object_error::invalid_file_type:
41      return "The file was not recognized as a valid object file";
42    case object_error::parse_failed:
43      return "Invalid data was encountered while parsing the file";
44    case object_error::unexpected_eof:
45      return "The end of the file was unexpectedly encountered";
46    case object_error::string_table_non_null_end:
47      return "String table must end with a null terminator";
48    case object_error::invalid_section_index:
49      return "Invalid section index";
50    case object_error::bitcode_section_not_found:
51      return "Bitcode section not found in object file";
52    case object_error::invalid_symbol_index:
53      return "Invalid symbol index";
54    }
55    llvm_unreachable("An enumerator of object_error does not have a message "
56                     "defined.");
57  }
58  
59  void BinaryError::anchor() {}
60  char BinaryError::ID = 0;
61  char GenericBinaryError::ID = 0;
62  
63  GenericBinaryError::GenericBinaryError(Twine Msg) : Msg(Msg.str()) {}
64  
65  GenericBinaryError::GenericBinaryError(Twine Msg, object_error ECOverride)
66      : Msg(Msg.str()) {
67    setErrorCode(make_error_code(ECOverride));
68  }
69  
70  void GenericBinaryError::log(raw_ostream &OS) const {
71    OS << Msg;
72  }
73  
74  static ManagedStatic<_object_error_category> error_category;
75  
76  const std::error_category &object::object_category() {
77    return *error_category;
78  }
79  
80  llvm::Error llvm::object::isNotObjectErrorInvalidFileType(llvm::Error Err) {
81    return handleErrors(std::move(Err), [](std::unique_ptr<ECError> M) -> Error {
82      // Try to handle 'M'. If successful, return a success value from
83      // the handler.
84      if (M->convertToErrorCode() == object_error::invalid_file_type)
85        return Error::success();
86  
87      // We failed to handle 'M' - return it from the handler.
88      // This value will be passed back from catchErrors and
89      // wind up in Err2, where it will be returned from this function.
90      return Error(std::move(M));
91    });
92  }
93