LLVM  10.0.0svn
RemarkParser.cpp
Go to the documentation of this file.
1 //===- RemarkParser.cpp --------------------------------------------------===//
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 file provides utility methods used by clients that want to use the
10 // parser for remark diagnostics in LLVM.
11 //
12 //===----------------------------------------------------------------------===//
13 
15 #include "YAMLRemarkParser.h"
16 #include "llvm-c/Remarks.h"
17 #include "llvm/ADT/STLExtras.h"
19 
20 using namespace llvm;
21 using namespace llvm::remarks;
22 
23 char EndOfFileError::ID = 0;
24 
25 ParsedStringTable::ParsedStringTable(StringRef InBuffer) : Buffer(InBuffer) {
26  while (!InBuffer.empty()) {
27  // Strings are separated by '\0' bytes.
28  std::pair<StringRef, StringRef> Split = InBuffer.split('\0');
29  // We only store the offset from the beginning of the buffer.
30  Offsets.push_back(Split.first.data() - Buffer.data());
31  InBuffer = Split.second;
32  }
33 }
34 
36  if (Index >= Offsets.size())
37  return createStringError(
38  std::make_error_code(std::errc::invalid_argument),
39  "String with index %u is out of bounds (size = %u).", Index,
40  Offsets.size());
41 
42  size_t Offset = Offsets[Index];
43  // If it's the last offset, we can't use the next offset to know the size of
44  // the string.
45  size_t NextOffset =
46  (Index == Offsets.size() - 1) ? Buffer.size() : Offsets[Index + 1];
47  return StringRef(Buffer.data() + Offset, NextOffset - Offset - 1);
48 }
49 
52  switch (ParserFormat) {
53  case Format::YAML:
54  return std::make_unique<YAMLRemarkParser>(Buf);
55  case Format::YAMLStrTab:
56  return createStringError(
57  std::make_error_code(std::errc::invalid_argument),
58  "The YAML with string table format requires a parsed string table.");
59  case Format::Bitstream:
60  return createStringError(std::make_error_code(std::errc::invalid_argument),
61  "Parsing bitstream remarks is not supported.");
62  case Format::Unknown:
63  return createStringError(std::make_error_code(std::errc::invalid_argument),
64  "Unknown remark parser format.");
65  }
66  llvm_unreachable("unhandled ParseFormat");
67 }
68 
71  ParsedStringTable StrTab) {
72  switch (ParserFormat) {
73  case Format::YAML:
74  return createStringError(std::make_error_code(std::errc::invalid_argument),
75  "The YAML format can't be used with a string "
76  "table. Use yaml-strtab instead.");
77  case Format::YAMLStrTab:
78  return std::make_unique<YAMLStrTabRemarkParser>(Buf, std::move(StrTab));
79  case Format::Bitstream:
80  return createStringError(std::make_error_code(std::errc::invalid_argument),
81  "Parsing bitstream remarks is not supported.");
82  case Format::Unknown:
83  return createStringError(std::make_error_code(std::errc::invalid_argument),
84  "Unknown remark parser format.");
85  }
86  llvm_unreachable("unhandled ParseFormat");
87 }
88 
92  switch (ParserFormat) {
93  // Depending on the metadata, the format can be either yaml or yaml-strtab,
94  // regardless of the input argument.
95  case Format::YAML:
96  case Format::YAMLStrTab:
97  return createYAMLParserFromMeta(Buf, std::move(StrTab));
98  case Format::Bitstream:
99  return createStringError(std::make_error_code(std::errc::invalid_argument),
100  "Parsing bitstream remarks is not supported.");
101  case Format::Unknown:
102  return createStringError(std::make_error_code(std::errc::invalid_argument),
103  "Unknown remark parser format.");
104  }
105  llvm_unreachable("unhandled ParseFormat");
106 }
107 
108 namespace {
109 // Wrapper that holds the state needed to interact with the C API.
110 struct CParser {
111  std::unique_ptr<RemarkParser> TheParser;
113 
114  CParser(Format ParserFormat, StringRef Buf,
116  : TheParser(cantFail(
117  StrTab ? createRemarkParser(ParserFormat, Buf, std::move(*StrTab))
118  : createRemarkParser(ParserFormat, Buf))) {}
119 
120  void handleError(Error E) { Err.emplace(toString(std::move(E))); }
121  bool hasError() const { return Err.hasValue(); }
122  const char *getMessage() const { return Err ? Err->c_str() : nullptr; };
123 };
124 } // namespace
125 
126 // Create wrappers for C Binding types (see CBindingWrapping.h).
128 
130  uint64_t Size) {
131  return wrap(new CParser(Format::YAML,
132  StringRef(static_cast<const char *>(Buf), Size)));
133 }
134 
135 extern "C" LLVMRemarkEntryRef
137  CParser &TheCParser = *unwrap(Parser);
138  remarks::RemarkParser &TheParser = *TheCParser.TheParser;
139 
140  Expected<std::unique_ptr<Remark>> MaybeRemark = TheParser.next();
141  if (Error E = MaybeRemark.takeError()) {
142  if (E.isA<EndOfFileError>()) {
143  consumeError(std::move(E));
144  return nullptr;
145  }
146 
147  // Handle the error. Allow it to be checked through HasError and
148  // GetErrorMessage.
149  TheCParser.handleError(std::move(E));
150  return nullptr;
151  }
152 
153  // Valid remark.
154  return wrap(MaybeRemark->release());
155 }
156 
158  return unwrap(Parser)->hasError();
159 }
160 
161 extern "C" const char *
163  return unwrap(Parser)->getMessage();
164 }
165 
167  delete unwrap(Parser);
168 }
std::vector< size_t > Offsets
This object has high changes to be std::move&#39;d around, so don&#39;t use a SmallVector for once...
Definition: RemarkParser.h:62
const NoneType None
Definition: None.h:23
void cantFail(Error Err, const char *Msg=nullptr)
Report a fatal error if Err is a failure value.
Definition: Error.h:703
uint64_t CallInst * C
This class represents lattice values for constants.
Definition: AllocatorList.h:23
void emplace(ArgTypes &&... Args)
Create a new object by constructing it in place with the given arguments.
Definition: Optional.h:237
struct LLVMRemarkOpaqueParser * LLVMRemarkParserRef
Definition: Remarks.h:227
Error takeError()
Take ownership of the stored error.
Definition: Error.h:552
Expected< std::unique_ptr< RemarkParser > > createRemarkParser(Format ParserFormat, StringRef Buf)
Format
The format used for serializing/deserializing remarks.
Definition: RemarkFormat.h:25
std::string toString(Error E)
Write all error messages (if any) in E to a string.
Definition: Error.h:966
#define DEFINE_SIMPLE_CONVERSION_FUNCTIONS(ty, ref)
Attribute unwrap(LLVMAttributeRef Attr)
Definition: Attributes.h:204
const char * LLVMRemarkParserGetErrorMessage(LLVMRemarkParserRef Parser)
Returns a null-terminated string containing an error message.
std::error_code make_error_code(BitcodeError E)
void LLVMRemarkParserDispose(LLVMRemarkParserRef Parser)
Releases all the resources used by Parser.
Tagged union holding either a T or a Error.
Definition: yaml2obj.h:21
LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:126
Expected< std::unique_ptr< YAMLRemarkParser > > createYAMLParserFromMeta(StringRef Buf, Optional< ParsedStringTable > StrTab=None)
LLVM_NODISCARD size_t size() const
size - Get the string size.
Definition: StringRef.h:130
In-memory representation of the string table parsed from a buffer (e.g.
Definition: RemarkParser.h:57
LLVMBool LLVMRemarkParserHasError(LLVMRemarkParserRef Parser)
Returns 1 if the parser encountered an error while parsing the buffer.
ParsedStringTable(StringRef Buffer)
StringRef Buffer
The buffer mapped from the section contents.
Definition: RemarkParser.h:59
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
LLVMRemarkEntryRef LLVMRemarkParserGetNext(LLVMRemarkParserRef Parser)
Returns the next remark in the file.
int LLVMBool
Definition: Types.h:29
void consumeError(Error Err)
Consume a Error without doing anything.
Definition: Error.h:981
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
virtual Expected< std::unique_ptr< Remark > > next()=0
If no error occurs, this returns a valid Remark object.
LLVM_NODISCARD std::pair< StringRef, StringRef > split(char Separator) const
Split into two substrings around the first occurrence of a separator character.
Definition: StringRef.h:696
bool hasValue() const
Definition: Optional.h:259
LLVMAttributeRef wrap(Attribute Attr)
Definition: Attributes.h:199
Parser used to parse a raw buffer to remarks::Remark objects.
Definition: RemarkParser.h:39
uint32_t Size
Definition: Profile.cpp:46
LLVMRemarkParserRef LLVMRemarkParserCreateYAML(const void *Buf, uint64_t Size)
Creates a remark parser that can be used to parse the buffer located in Buf of size Size bytes...
LLVM_NODISCARD const char * data() const
data - Get a pointer to the start of the string (which may not be null terminated).
Definition: StringRef.h:122
aarch64 promote const
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
struct LLVMRemarkOpaqueEntry * LLVMRemarkEntryRef
A remark emitted by the compiler.
Definition: Remarks.h:137
Expected< StringRef > operator[](size_t Index) const
Expected< std::unique_ptr< RemarkParser > > createRemarkParserFromMeta(Format ParserFormat, StringRef Buf, Optional< ParsedStringTable > StrTab=None)
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
Definition: Error.h:1163