DebugInfo/CodeView/RecordSerialization.h

0001 //===- RecordSerialization.h ------------------------------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008
0009 #ifndef LLVM_DEBUGINFO_CODEVIEW_RECORDSERIALIZATION_H
0010 #define LLVM_DEBUGINFO_CODEVIEW_RECORDSERIALIZATION_H
0011
0012 #include "llvm/ADT/ArrayRef.h"
0013 #include "llvm/ADT/StringRef.h"
0014 #include "llvm/DebugInfo/CodeView/CodeView.h"
0015 #include "llvm/DebugInfo/CodeView/CodeViewError.h"
0016 #include "llvm/Support/BinaryStreamReader.h"
0017 #include "llvm/Support/Endian.h"
0018 #include "llvm/Support/Error.h"
0019 #include <cinttypes>
0020
0021 namespace llvm {
0022 class APSInt;
0023 namespace codeview {
0024 using llvm::support::little32_t;
0025 using llvm::support::ulittle16_t;
0026 using llvm::support::ulittle32_t;
0027
0028 /// Limit on the size of all codeview symbol and type records, including the
0029 /// RecordPrefix. MSVC does not emit any records larger than this.
0030 enum : unsigned { MaxRecordLength = 0xFF00 };
0031
0032 struct RecordPrefix {
0033   RecordPrefix() = default;
0034   explicit RecordPrefix(uint16_t Kind) : RecordLen(2), RecordKind(Kind) {}
0035
0036   ulittle16_t RecordLen;  // Record length, starting from &RecordKind.
0037   ulittle16_t RecordKind; // Record kind enum (SymRecordKind or TypeRecordKind)
0038 };
0039
0040 /// Reinterpret a byte array as an array of characters. Does not interpret as
0041 /// a C string, as StringRef has several helpers (split) that make that easy.
0042 StringRef getBytesAsCharacters(ArrayRef<uint8_t> LeafData);
0043 StringRef getBytesAsCString(ArrayRef<uint8_t> LeafData);
0044
0045 inline Error consume(BinaryStreamReader &Reader) { return Error::success(); }
0046
0047 /// Decodes a numeric "leaf" value. These are integer literals encountered in
0048 /// the type stream. If the value is positive and less than LF_NUMERIC (1 <<
0049 /// 15), it is emitted directly in Data. Otherwise, it has a tag like LF_CHAR
0050 /// that indicates the bitwidth and sign of the numeric data.
0051 Error consume(BinaryStreamReader &Reader, APSInt &Num);
0052
0053 /// Decodes a numeric leaf value that is known to be a particular type.
0054 Error consume_numeric(BinaryStreamReader &Reader, uint64_t &Value);
0055
0056 /// Decodes signed and unsigned fixed-length integers.
0057 Error consume(BinaryStreamReader &Reader, uint32_t &Item);
0058 Error consume(BinaryStreamReader &Reader, int32_t &Item);
0059
0060 /// Decodes a null terminated string.
0061 Error consume(BinaryStreamReader &Reader, StringRef &Item);
0062
0063 Error consume(StringRef &Data, APSInt &Num);
0064 Error consume(StringRef &Data, uint32_t &Item);
0065
0066 /// Decodes an arbitrary object whose layout matches that of the underlying
0067 /// byte sequence, and returns a pointer to the object.
0068 template <typename T> Error consume(BinaryStreamReader &Reader, T *&Item) {
0069   return Reader.readObject(Item);
0070 }
0071
0072 template <typename T, typename U> struct serialize_conditional_impl {
0073   serialize_conditional_impl(T &Item, U Func) : Item(Item), Func(Func) {}
0074
0075   Error deserialize(BinaryStreamReader &Reader) const {
0076     if (!Func())
0077       return Error::success();
0078     return consume(Reader, Item);
0079   }
0080
0081   T &Item;
0082   U Func;
0083 };
0084
0085 template <typename T, typename U>
0086 serialize_conditional_impl<T, U> serialize_conditional(T &Item, U Func) {
0087   return serialize_conditional_impl<T, U>(Item, Func);
0088 }
0089
0090 template <typename T, typename U> struct serialize_array_impl {
0091   serialize_array_impl(ArrayRef<T> &Item, U Func) : Item(Item), Func(Func) {}
0092
0093   Error deserialize(BinaryStreamReader &Reader) const {
0094     return Reader.readArray(Item, Func());
0095   }
0096
0097   ArrayRef<T> &Item;
0098   U Func;
0099 };
0100
0101 template <typename T> struct serialize_vector_tail_impl {
0102   serialize_vector_tail_impl(std::vector<T> &Item) : Item(Item) {}
0103
0104   Error deserialize(BinaryStreamReader &Reader) const {
0105     T Field;
0106     // Stop when we run out of bytes or we hit record padding bytes.
0107     while (!Reader.empty() && Reader.peek() < LF_PAD0) {
0108       if (auto EC = consume(Reader, Field))
0109         return EC;
0110       Item.push_back(Field);
0111     }
0112     return Error::success();
0113   }
0114
0115   std::vector<T> &Item;
0116 };
0117
0118 struct serialize_null_term_string_array_impl {
0119   serialize_null_term_string_array_impl(std::vector<StringRef> &Item)
0120       : Item(Item) {}
0121
0122   Error deserialize(BinaryStreamReader &Reader) const {
0123     if (Reader.empty())
0124       return make_error<CodeViewError>(cv_error_code::insufficient_buffer,
0125                                        "Null terminated string is empty!");
0126
0127     while (Reader.peek() != 0) {
0128       StringRef Field;
0129       if (auto EC = Reader.readCString(Field))
0130         return EC;
0131       Item.push_back(Field);
0132     }
0133     return Reader.skip(1);
0134   }
0135
0136   std::vector<StringRef> &Item;
0137 };
0138
0139 template <typename T> struct serialize_arrayref_tail_impl {
0140   serialize_arrayref_tail_impl(ArrayRef<T> &Item) : Item(Item) {}
0141
0142   Error deserialize(BinaryStreamReader &Reader) const {
0143     uint32_t Count = Reader.bytesRemaining() / sizeof(T);
0144     return Reader.readArray(Item, Count);
0145   }
0146
0147   ArrayRef<T> &Item;
0148 };
0149
0150 template <typename T> struct serialize_numeric_impl {
0151   serialize_numeric_impl(T &Item) : Item(Item) {}
0152
0153   Error deserialize(BinaryStreamReader &Reader) const {
0154     return consume_numeric(Reader, Item);
0155   }
0156
0157   T &Item;
0158 };
0159
0160 template <typename T, typename U>
0161 serialize_array_impl<T, U> serialize_array(ArrayRef<T> &Item, U Func) {
0162   return serialize_array_impl<T, U>(Item, Func);
0163 }
0164
0165 inline serialize_null_term_string_array_impl
0166 serialize_null_term_string_array(std::vector<StringRef> &Item) {
0167   return serialize_null_term_string_array_impl(Item);
0168 }
0169
0170 template <typename T>
0171 serialize_vector_tail_impl<T> serialize_array_tail(std::vector<T> &Item) {
0172   return serialize_vector_tail_impl<T>(Item);
0173 }
0174
0175 template <typename T>
0176 serialize_arrayref_tail_impl<T> serialize_array_tail(ArrayRef<T> &Item) {
0177   return serialize_arrayref_tail_impl<T>(Item);
0178 }
0179
0180 template <typename T> serialize_numeric_impl<T> serialize_numeric(T &Item) {
0181   return serialize_numeric_impl<T>(Item);
0182 }
0183
0184 template <typename T, typename U>
0185 Error consume(BinaryStreamReader &Reader,
0186               const serialize_conditional_impl<T, U> &Item) {
0187   return Item.deserialize(Reader);
0188 }
0189
0190 template <typename T, typename U>
0191 Error consume(BinaryStreamReader &Reader,
0192               const serialize_array_impl<T, U> &Item) {
0193   return Item.deserialize(Reader);
0194 }
0195
0196 inline Error consume(BinaryStreamReader &Reader,
0197                      const serialize_null_term_string_array_impl &Item) {
0198   return Item.deserialize(Reader);
0199 }
0200
0201 template <typename T>
0202 Error consume(BinaryStreamReader &Reader,
0203               const serialize_vector_tail_impl<T> &Item) {
0204   return Item.deserialize(Reader);
0205 }
0206
0207 template <typename T>
0208 Error consume(BinaryStreamReader &Reader,
0209               const serialize_arrayref_tail_impl<T> &Item) {
0210   return Item.deserialize(Reader);
0211 }
0212
0213 template <typename T>
0214 Error consume(BinaryStreamReader &Reader,
0215               const serialize_numeric_impl<T> &Item) {
0216   return Item.deserialize(Reader);
0217 }
0218
0219 template <typename T, typename U, typename... Args>
0220 Error consume(BinaryStreamReader &Reader, T &&X, U &&Y, Args &&... Rest) {
0221   if (auto EC = consume(Reader, X))
0222     return EC;
0223   return consume(Reader, Y, std::forward<Args>(Rest)...);
0224 }
0225
0226 }
0227 }
0228
0229 #endif