LLVM  15.0.0git
RecordSerialization.h
Go to the documentation of this file.
1 //===- RecordSerialization.h ------------------------------------*- 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 #ifndef LLVM_DEBUGINFO_CODEVIEW_RECORDSERIALIZATION_H
10 #define LLVM_DEBUGINFO_CODEVIEW_RECORDSERIALIZATION_H
11 
12 #include "llvm/ADT/ArrayRef.h"
13 #include "llvm/ADT/StringRef.h"
17 #include "llvm/Support/Endian.h"
18 #include "llvm/Support/Error.h"
19 #include <cinttypes>
20 
21 namespace llvm {
22 class APSInt;
23 namespace codeview {
27 
28 /// Limit on the size of all codeview symbol and type records, including the
29 /// RecordPrefix. MSVC does not emit any records larger than this.
30 enum : unsigned { MaxRecordLength = 0xFF00 };
31 
32 struct RecordPrefix {
33  RecordPrefix() = default;
35 
36  ulittle16_t RecordLen; // Record length, starting from &RecordKind.
37  ulittle16_t RecordKind; // Record kind enum (SymRecordKind or TypeRecordKind)
38 };
39 
40 /// Reinterpret a byte array as an array of characters. Does not interpret as
41 /// a C string, as StringRef has several helpers (split) that make that easy.
44 
45 inline Error consume(BinaryStreamReader &Reader) { return Error::success(); }
46 
47 /// Decodes a numeric "leaf" value. These are integer literals encountered in
48 /// the type stream. If the value is positive and less than LF_NUMERIC (1 <<
49 /// 15), it is emitted directly in Data. Otherwise, it has a tag like LF_CHAR
50 /// that indicates the bitwidth and sign of the numeric data.
51 Error consume(BinaryStreamReader &Reader, APSInt &Num);
52 
53 /// Decodes a numeric leaf value that is known to be a particular type.
55 
56 /// Decodes signed and unsigned fixed-length integers.
58 Error consume(BinaryStreamReader &Reader, int32_t &Item);
59 
60 /// Decodes a null terminated string.
62 
63 Error consume(StringRef &Data, APSInt &Num);
64 Error consume(StringRef &Data, uint32_t &Item);
65 
66 /// Decodes an arbitrary object whose layout matches that of the underlying
67 /// byte sequence, and returns a pointer to the object.
68 template <typename T> Error consume(BinaryStreamReader &Reader, T *&Item) {
69  return Reader.readObject(Item);
70 }
71 
72 template <typename T, typename U> struct serialize_conditional_impl {
74 
76  if (!Func())
77  return Error::success();
78  return consume(Reader, Item);
79  }
80 
81  T &Item;
82  U Func;
83 };
84 
85 template <typename T, typename U>
87  return serialize_conditional_impl<T, U>(Item, Func);
88 }
89 
90 template <typename T, typename U> struct serialize_array_impl {
92 
94  return Reader.readArray(Item, Func());
95  }
96 
98  U Func;
99 };
100 
101 template <typename T> struct serialize_vector_tail_impl {
102  serialize_vector_tail_impl(std::vector<T> &Item) : Item(Item) {}
103 
105  T Field;
106  // Stop when we run out of bytes or we hit record padding bytes.
107  while (!Reader.empty() && Reader.peek() < LF_PAD0) {
108  if (auto EC = consume(Reader, Field))
109  return EC;
110  Item.push_back(Field);
111  }
112  return Error::success();
113  }
114 
115  std::vector<T> &Item;
116 };
117 
120  : Item(Item) {}
121 
123  if (Reader.empty())
124  return make_error<CodeViewError>(cv_error_code::insufficient_buffer,
125  "Null terminated string is empty!");
126 
127  while (Reader.peek() != 0) {
129  if (auto EC = Reader.readCString(Field))
130  return EC;
131  Item.push_back(Field);
132  }
133  return Reader.skip(1);
134  }
135 
136  std::vector<StringRef> &Item;
137 };
138 
139 template <typename T> struct serialize_arrayref_tail_impl {
141 
143  uint32_t Count = Reader.bytesRemaining() / sizeof(T);
144  return Reader.readArray(Item, Count);
145  }
146 
148 };
149 
150 template <typename T> struct serialize_numeric_impl {
152 
154  return consume_numeric(Reader, Item);
155  }
156 
157  T &Item;
158 };
159 
160 template <typename T, typename U>
162  return serialize_array_impl<T, U>(Item, Func);
163 }
164 
165 inline serialize_null_term_string_array_impl
166 serialize_null_term_string_array(std::vector<StringRef> &Item) {
168 }
169 
170 template <typename T>
172  return serialize_vector_tail_impl<T>(Item);
173 }
174 
175 template <typename T>
177  return serialize_arrayref_tail_impl<T>(Item);
178 }
179 
180 template <typename T> serialize_numeric_impl<T> serialize_numeric(T &Item) {
181  return serialize_numeric_impl<T>(Item);
182 }
183 
184 template <typename T, typename U>
186  const serialize_conditional_impl<T, U> &Item) {
187  return Item.deserialize(Reader);
188 }
189 
190 template <typename T, typename U>
192  const serialize_array_impl<T, U> &Item) {
193  return Item.deserialize(Reader);
194 }
195 
198  return Item.deserialize(Reader);
199 }
200 
201 template <typename T>
203  const serialize_vector_tail_impl<T> &Item) {
204  return Item.deserialize(Reader);
205 }
206 
207 template <typename T>
209  const serialize_arrayref_tail_impl<T> &Item) {
210  return Item.deserialize(Reader);
211 }
212 
213 template <typename T>
215  const serialize_numeric_impl<T> &Item) {
216  return Item.deserialize(Reader);
217 }
218 
219 template <typename T, typename U, typename... Args>
220 Error consume(BinaryStreamReader &Reader, T &&X, U &&Y, Args &&... Rest) {
221  if (auto EC = consume(Reader, X))
222  return EC;
223  return consume(Reader, Y, std::forward<Args>(Rest)...);
224 }
225 
226 }
227 }
228 
229 #endif
BinaryStreamReader.h
llvm::BinaryStreamReader::empty
bool empty() const
Definition: BinaryStreamReader.h:246
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:17
llvm::codeview::serialize_null_term_string_array_impl::Item
std::vector< StringRef > & Item
Definition: RecordSerialization.h:136
llvm::codeview::serialize_array_impl
Definition: RecordSerialization.h:90
StringRef.h
Field
OptimizedStructLayoutField Field
Definition: OptimizedStructLayout.cpp:17
llvm::BinaryStreamReader::skip
Error skip(uint64_t Amount)
Advance the stream's offset by Amount bytes.
Definition: BinaryStreamReader.cpp:148
llvm::codeview::serialize_numeric_impl
Definition: RecordSerialization.h:150
llvm::codeview::serialize_null_term_string_array_impl::deserialize
Error deserialize(BinaryStreamReader &Reader) const
Definition: RecordSerialization.h:122
llvm::Error::success
static ErrorSuccess success()
Create a success value.
Definition: Error.h:329
llvm::codeview::serialize_array_impl::Item
ArrayRef< T > & Item
Definition: RecordSerialization.h:97
llvm::codeview::serialize_numeric_impl::Item
T & Item
Definition: RecordSerialization.h:157
Error.h
llvm::lltok::APSInt
@ APSInt
Definition: LLToken.h:426
llvm::codeview::serialize_conditional_impl::Item
T & Item
Definition: RecordSerialization.h:81
llvm::codeview::serialize_arrayref_tail_impl::serialize_arrayref_tail_impl
serialize_arrayref_tail_impl(ArrayRef< T > &Item)
Definition: RecordSerialization.h:140
llvm::codeview::serialize_array_tail
serialize_vector_tail_impl< T > serialize_array_tail(std::vector< T > &Item)
Definition: RecordSerialization.h:171
llvm::BinaryStreamReader::bytesRemaining
uint64_t bytesRemaining() const
Definition: BinaryStreamReader.h:250
T
#define T
Definition: Mips16ISelLowering.cpp:341
llvm::codeview::serialize_conditional
serialize_conditional_impl< T, U > serialize_conditional(T &Item, U Func)
Definition: RecordSerialization.h:86
llvm::codeview::cv_error_code::insufficient_buffer
@ insufficient_buffer
llvm::codeview::RecordPrefix
Definition: RecordSerialization.h:32
llvm::codeview::serialize_vector_tail_impl::Item
std::vector< T > & Item
Definition: RecordSerialization.h:115
llvm::codeview::MaxRecordLength
@ MaxRecordLength
Definition: RecordSerialization.h:30
llvm::codeview::serialize_array_impl::Func
U Func
Definition: RecordSerialization.h:98
Y
static GCMetadataPrinterRegistry::Add< OcamlGCMetadataPrinter > Y("ocaml", "ocaml 3.10-compatible collector")
llvm::codeview::serialize_null_term_string_array_impl
Definition: RecordSerialization.h:118
llvm::APSInt
An arbitrary precision integer that knows its signedness.
Definition: APSInt.h:23
CodeView.h
llvm::lltok::Kind
Kind
Definition: LLToken.h:18
llvm::codeview::serialize_numeric_impl::serialize_numeric_impl
serialize_numeric_impl(T &Item)
Definition: RecordSerialization.h:151
llvm::codeview::serialize_numeric_impl::deserialize
Error deserialize(BinaryStreamReader &Reader) const
Definition: RecordSerialization.h:153
X
static GCMetadataPrinterRegistry::Add< ErlangGCPrinter > X("erlang", "erlang-compatible garbage collector")
llvm::codeview::RecordPrefix::RecordPrefix
RecordPrefix()=default
llvm::BinaryStreamReader
Provides read only access to a subclass of BinaryStream.
Definition: BinaryStreamReader.h:29
llvm::support::ulittle32_t
detail::packed_endian_specific_integral< uint32_t, little, unaligned > ulittle32_t
Definition: Endian.h:272
llvm::codeview::serialize_array
serialize_array_impl< T, U > serialize_array(ArrayRef< T > &Item, U Func)
Definition: RecordSerialization.h:161
llvm::support::ulittle16_t
detail::packed_endian_specific_integral< uint16_t, little, unaligned > ulittle16_t
Definition: Endian.h:270
llvm::codeview::serialize_null_term_string_array_impl::serialize_null_term_string_array_impl
serialize_null_term_string_array_impl(std::vector< StringRef > &Item)
Definition: RecordSerialization.h:119
uint64_t
llvm::codeview::serialize_arrayref_tail_impl::deserialize
Error deserialize(BinaryStreamReader &Reader) const
Definition: RecordSerialization.h:142
llvm::BinaryStreamReader::readCString
Error readCString(StringRef &Dest)
Read a null terminated string from Dest.
Definition: BinaryStreamReader.cpp:74
llvm::codeview::serialize_arrayref_tail_impl
Definition: RecordSerialization.h:139
ArrayRef.h
llvm::codeview::getBytesAsCString
StringRef getBytesAsCString(ArrayRef< uint8_t > LeafData)
Definition: RecordSerialization.cpp:32
llvm::codeview::serialize_conditional_impl::serialize_conditional_impl
serialize_conditional_impl(T &Item, U Func)
Definition: RecordSerialization.h:73
llvm::codeview::serialize_vector_tail_impl
Definition: RecordSerialization.h:101
llvm::codeview::CompileSym2Flags::EC
@ EC
llvm::BinaryStreamReader::readObject
Error readObject(const T *&Dest)
Get a pointer to an object of type T from the underlying stream, as if by memcpy, and store the resul...
Definition: BinaryStreamReader.h:162
llvm::codeview::consume
Error consume(BinaryStreamReader &Reader)
Definition: RecordSerialization.h:45
llvm::ArrayRef< uint8_t >
llvm::StringRef
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:58
uint32_t
llvm::codeview::serialize_null_term_string_array
serialize_null_term_string_array_impl serialize_null_term_string_array(std::vector< StringRef > &Item)
Definition: RecordSerialization.h:166
llvm::codeview::serialize_conditional_impl::Func
U Func
Definition: RecordSerialization.h:82
llvm::codeview::serialize_vector_tail_impl::serialize_vector_tail_impl
serialize_vector_tail_impl(std::vector< T > &Item)
Definition: RecordSerialization.h:102
llvm::codeview::serialize_array_impl::serialize_array_impl
serialize_array_impl(ArrayRef< T > &Item, U Func)
Definition: RecordSerialization.h:91
llvm::codeview::serialize_numeric
serialize_numeric_impl< T > serialize_numeric(T &Item)
Definition: RecordSerialization.h:180
llvm::codeview::serialize_vector_tail_impl::deserialize
Error deserialize(BinaryStreamReader &Reader) const
Definition: RecordSerialization.h:104
uint16_t
llvm::codeview::RecordPrefix::RecordKind
ulittle16_t RecordKind
Definition: RecordSerialization.h:37
llvm::Error
Lightweight error class with error context and mandatory checking.
Definition: Error.h:155
llvm::support::little32_t
detail::packed_endian_specific_integral< int32_t, little, unaligned > little32_t
Definition: Endian.h:279
llvm::codeview::RecordPrefix::RecordPrefix
RecordPrefix(uint16_t Kind)
Definition: RecordSerialization.h:34
llvm::codeview::serialize_conditional_impl::deserialize
Error deserialize(BinaryStreamReader &Reader) const
Definition: RecordSerialization.h:75
llvm::codeview::serialize_arrayref_tail_impl::Item
ArrayRef< T > & Item
Definition: RecordSerialization.h:147
llvm::codeview::getBytesAsCharacters
StringRef getBytesAsCharacters(ArrayRef< uint8_t > LeafData)
Reinterpret a byte array as an array of characters.
Definition: RecordSerialization.cpp:27
llvm::codeview::serialize_array_impl::deserialize
Error deserialize(BinaryStreamReader &Reader) const
Definition: RecordSerialization.h:93
llvm::BinaryStreamReader::peek
uint8_t peek() const
Examine the next byte of the underlying stream without advancing the stream's offset.
Definition: BinaryStreamReader.cpp:160
llvm::codeview::RecordPrefix::RecordLen
ulittle16_t RecordLen
Definition: RecordSerialization.h:36
llvm::codeview::serialize_conditional_impl
Definition: RecordSerialization.h:72
llvm::OptimizedStructLayoutField
A field in a structure.
Definition: OptimizedStructLayout.h:45
llvm::AMDGPU::HSAMD::Kernel::Key::Args
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
Definition: AMDGPUMetadata.h:394
CodeViewError.h
llvm::codeview::consume_numeric
Error consume_numeric(BinaryStreamReader &Reader, uint64_t &Value)
Decodes a numeric leaf value that is known to be a particular type.
Definition: RecordSerialization.cpp:114
Endian.h
llvm::Value
LLVM Value Representation.
Definition: Value.h:74
llvm::BinaryStreamReader::readArray
Error readArray(ArrayRef< T > &Array, uint32_t NumElements)
Get a reference to a NumElements element array of objects of type T from the underlying stream as if ...
Definition: BinaryStreamReader.h:180