LLVM 19.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
21namespace llvm {
22class APSInt;
23namespace 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.
30enum : unsigned { MaxRecordLength = 0xFF00 };
31
33 RecordPrefix() = default;
34 explicit RecordPrefix(uint16_t Kind) : RecordLen(2), RecordKind(Kind) {}
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
45inline 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.
52
53/// Decodes a numeric leaf value that is known to be a particular type.
55
56/// Decodes signed and unsigned fixed-length integers.
58Error consume(BinaryStreamReader &Reader, int32_t &Item);
59
60/// Decodes a null terminated string.
62
65
66/// Decodes an arbitrary object whose layout matches that of the underlying
67/// byte sequence, and returns a pointer to the object.
68template <typename T> Error consume(BinaryStreamReader &Reader, T *&Item) {
69 return Reader.readObject(Item);
70}
71
72template <typename T, typename U> struct serialize_conditional_impl {
74
76 if (!Func())
77 return Error::success();
78 return consume(Reader, Item);
79 }
80
83};
84
85template <typename T, typename U>
87 return serialize_conditional_impl<T, U>(Item, Func);
88}
89
90template <typename T, typename U> struct serialize_array_impl {
92
94 return Reader.readArray(Item, Func());
95 }
96
99};
100
101template <typename T> struct serialize_vector_tail_impl {
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
139template <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
150template <typename T> struct serialize_numeric_impl {
152
154 return consume_numeric(Reader, Item);
155 }
156
158};
159
160template <typename T, typename U>
162 return serialize_array_impl<T, U>(Item, Func);
163}
164
165inline serialize_null_term_string_array_impl
166serialize_null_term_string_array(std::vector<StringRef> &Item) {
168}
169
170template <typename T>
173}
174
175template <typename T>
178}
179
180template <typename T> serialize_numeric_impl<T> serialize_numeric(T &Item) {
181 return serialize_numeric_impl<T>(Item);
182}
183
184template <typename T, typename U>
187 return Item.deserialize(Reader);
188}
189
190template <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
201template <typename T>
203 const serialize_vector_tail_impl<T> &Item) {
204 return Item.deserialize(Reader);
205}
206
207template <typename T>
210 return Item.deserialize(Reader);
211}
212
213template <typename T>
215 const serialize_numeric_impl<T> &Item) {
216 return Item.deserialize(Reader);
217}
218
219template <typename T, typename U, typename... Args>
220Error 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
static GCMetadataPrinterRegistry::Add< ErlangGCPrinter > X("erlang", "erlang-compatible garbage collector")
#define T
static GCMetadataPrinterRegistry::Add< OcamlGCMetadataPrinter > Y("ocaml", "ocaml 3.10-compatible collector")
OptimizedStructLayoutField Field
An arbitrary precision integer that knows its signedness.
Definition: APSInt.h:23
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Definition: ArrayRef.h:41
Provides read only access to a subclass of BinaryStream.
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...
Error readCString(StringRef &Dest)
Read a null terminated string from Dest.
uint8_t peek() const
Examine the next byte of the underlying stream without advancing the stream's offset.
uint64_t bytesRemaining() const
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 ...
Error skip(uint64_t Amount)
Advance the stream's offset by Amount bytes.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:160
static ErrorSuccess success()
Create a success value.
Definition: Error.h:334
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
LLVM Value Representation.
Definition: Value.h:74
serialize_vector_tail_impl< T > serialize_array_tail(std::vector< T > &Item)
Error consume_numeric(BinaryStreamReader &Reader, uint64_t &Value)
Decodes a numeric leaf value that is known to be a particular type.
serialize_null_term_string_array_impl serialize_null_term_string_array(std::vector< StringRef > &Item)
StringRef getBytesAsCString(ArrayRef< uint8_t > LeafData)
serialize_array_impl< T, U > serialize_array(ArrayRef< T > &Item, U Func)
serialize_numeric_impl< T > serialize_numeric(T &Item)
StringRef getBytesAsCharacters(ArrayRef< uint8_t > LeafData)
Reinterpret a byte array as an array of characters.
serialize_conditional_impl< T, U > serialize_conditional(T &Item, U Func)
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
Error deserialize(BinaryStreamReader &Reader) const
serialize_array_impl(ArrayRef< T > &Item, U Func)
Error deserialize(BinaryStreamReader &Reader) const
Error deserialize(BinaryStreamReader &Reader) const
serialize_null_term_string_array_impl(std::vector< StringRef > &Item)
Error deserialize(BinaryStreamReader &Reader) const
Error deserialize(BinaryStreamReader &Reader) const
Error deserialize(BinaryStreamReader &Reader) const