Fix use after free in BinaryStream library.
[lldb.git] / llvm / include / llvm / DebugInfo / CodeView / CVRecord.h
1 //===- RecordIterator.h -----------------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #ifndef LLVM_DEBUGINFO_CODEVIEW_RECORDITERATOR_H
11 #define LLVM_DEBUGINFO_CODEVIEW_RECORDITERATOR_H
12
13 #include "llvm/ADT/ArrayRef.h"
14 #include "llvm/ADT/Optional.h"
15 #include "llvm/DebugInfo/CodeView/CodeViewError.h"
16 #include "llvm/DebugInfo/CodeView/RecordSerialization.h"
17 #include "llvm/Support/BinaryStreamReader.h"
18 #include "llvm/Support/BinaryStreamRef.h"
19 #include "llvm/Support/Endian.h"
20 #include "llvm/Support/Error.h"
21 #include <cstdint>
22
23 namespace llvm {
24
25 namespace codeview {
26
27 template <typename Kind> class CVRecord {
28 public:
29   CVRecord() = default;
30   CVRecord(Kind K, ArrayRef<uint8_t> Data) : Type(K), RecordData(Data) {}
31
32   uint32_t length() const { return RecordData.size(); }
33   Kind kind() const { return Type; }
34   ArrayRef<uint8_t> data() const { return RecordData; }
35
36   ArrayRef<uint8_t> content() const {
37     return RecordData.drop_front(sizeof(RecordPrefix));
38   }
39
40   Optional<uint32_t> hash() const { return Hash; }
41
42   void setHash(uint32_t Value) { Hash = Value; }
43
44   Kind Type;
45   ArrayRef<uint8_t> RecordData;
46   Optional<uint32_t> Hash;
47 };
48
49 } // end namespace codeview
50
51 template <typename Kind>
52 struct VarStreamArrayExtractor<codeview::CVRecord<Kind>> {
53   typedef void ContextType;
54
55   static Error extract(BinaryStreamRef Stream, uint32_t &Len,
56                        codeview::CVRecord<Kind> &Item) {
57     using namespace codeview;
58     const RecordPrefix *Prefix = nullptr;
59     BinaryStreamReader Reader(Stream);
60     uint32_t Offset = Reader.getOffset();
61
62     if (auto EC = Reader.readObject(Prefix))
63       return EC;
64     if (Prefix->RecordLen < 2)
65       return make_error<CodeViewError>(cv_error_code::corrupt_record);
66     Kind K = static_cast<Kind>(uint16_t(Prefix->RecordKind));
67
68     Reader.setOffset(Offset);
69     ArrayRef<uint8_t> RawData;
70     if (auto EC =
71             Reader.readBytes(RawData, Prefix->RecordLen + sizeof(uint16_t)))
72       return EC;
73     Item = codeview::CVRecord<Kind>(K, RawData);
74     Len = Item.length();
75     return Error::success();
76   }
77 };
78
79 } // end namespace llvm
80
81 #endif // LLVM_DEBUGINFO_CODEVIEW_RECORDITERATOR_H