xref: /freebsd-src/contrib/llvm-project/llvm/lib/Bitcode/Reader/ValueList.h (revision 753f127f3ace09432b2baeffd71a308760641a62)
1 //===-- Bitcode/Reader/ValueList.h - Number values --------------*- 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 // This class gives values and types Unique ID's.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #ifndef LLVM_LIB_BITCODE_READER_VALUELIST_H
14 #define LLVM_LIB_BITCODE_READER_VALUELIST_H
15 
16 #include "llvm/IR/ValueHandle.h"
17 #include "llvm/Support/Error.h"
18 #include <cassert>
19 #include <utility>
20 #include <vector>
21 
22 namespace llvm {
23 
24 class Constant;
25 class Error;
26 class Type;
27 class Value;
28 
29 class BitcodeReaderValueList {
30   /// Maps Value ID to pair of Value* and Type ID.
31   std::vector<std::pair<WeakTrackingVH, unsigned>> ValuePtrs;
32 
33   /// Maximum number of valid references. Forward references exceeding the
34   /// maximum must be invalid.
35   unsigned RefsUpperBound;
36 
37   using MaterializeValueFnTy =
38       std::function<Expected<Value *>(unsigned, BasicBlock *)>;
39   MaterializeValueFnTy MaterializeValueFn;
40 
41 public:
42   BitcodeReaderValueList(size_t RefsUpperBound,
43                          MaterializeValueFnTy MaterializeValueFn)
44       : RefsUpperBound(std::min((size_t)std::numeric_limits<unsigned>::max(),
45                                 RefsUpperBound)),
46         MaterializeValueFn(MaterializeValueFn) {}
47 
48   // vector compatibility methods
49   unsigned size() const { return ValuePtrs.size(); }
50   void resize(unsigned N) {
51     ValuePtrs.resize(N);
52   }
53   void push_back(Value *V, unsigned TypeID) {
54     ValuePtrs.emplace_back(V, TypeID);
55   }
56 
57   void clear() {
58     ValuePtrs.clear();
59   }
60 
61   Value *operator[](unsigned i) const {
62     assert(i < ValuePtrs.size());
63     return ValuePtrs[i].first;
64   }
65 
66   unsigned getTypeID(unsigned ValNo) const {
67     assert(ValNo < ValuePtrs.size());
68     return ValuePtrs[ValNo].second;
69   }
70 
71   Value *back() const { return ValuePtrs.back().first; }
72   void pop_back() {
73     ValuePtrs.pop_back();
74   }
75   bool empty() const { return ValuePtrs.empty(); }
76 
77   void shrinkTo(unsigned N) {
78     assert(N <= size() && "Invalid shrinkTo request!");
79     ValuePtrs.resize(N);
80   }
81 
82   void replaceValueWithoutRAUW(unsigned ValNo, Value *NewV) {
83     assert(ValNo < ValuePtrs.size());
84     ValuePtrs[ValNo].first = NewV;
85   }
86 
87   Value *getValueFwdRef(unsigned Idx, Type *Ty, unsigned TyID,
88                         BasicBlock *ConstExprInsertBB);
89 
90   Error assignValue(unsigned Idx, Value *V, unsigned TypeID);
91 };
92 
93 } // end namespace llvm
94 
95 #endif // LLVM_LIB_BITCODE_READER_VALUELIST_H
96