1
//===- llvm/ADT/PointerIntPair.h - Pair for pointer and int -----*- C++ -*-===//
3
// The LLVM Compiler Infrastructure
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
8
//===----------------------------------------------------------------------===//
10
// This file defines the PointerIntPair class.
12
//===----------------------------------------------------------------------===//
14
#ifndef LLVM_ADT_POINTERINTPAIR_H
15
#define LLVM_ADT_POINTERINTPAIR_H
17
#include "llvm/Support/PointerLikeTypeTraits.h"
25
/// PointerIntPair - This class implements a pair of a pointer and small
26
/// integer. It is designed to represent this in the space required by one
27
/// pointer by bitmangling the integer into the low part of the pointer. This
28
/// can only be done for small integers: typically up to 3 bits, but it depends
29
/// on the number of bits available according to PointerLikeTypeTraits for the
32
/// Note that PointerIntPair always puts the Int part in the highest bits
33
/// possible. For example, PointerIntPair<void*, 1, bool> will put the bit for
34
/// the bool into bit #2, not bit #0, which allows the low two bits to be used
35
/// for something else. For example, this allows:
36
/// PointerIntPair<PointerIntPair<void*, 1, bool>, 1, bool>
37
/// ... and the two bools will land in different bits.
39
template <typename PointerTy, unsigned IntBits, typename IntType=unsigned,
40
typename PtrTraits = PointerLikeTypeTraits<PointerTy> >
41
class PointerIntPair {
44
/// PointerBitMask - The bits that come from the pointer.
46
~(uintptr_t)(((intptr_t)1 << PtrTraits::NumLowBitsAvailable)-1),
48
/// IntShift - The number of low bits that we reserve for other uses, and
50
IntShift = (uintptr_t)PtrTraits::NumLowBitsAvailable-IntBits,
52
/// IntMask - This is the unshifted mask for valid bits of the int type.
53
IntMask = (uintptr_t)(((intptr_t)1 << IntBits)-1),
55
// ShiftedIntMask - This is the bits for the integer shifted in place.
56
ShiftedIntMask = (uintptr_t)(IntMask << IntShift)
59
PointerIntPair() : Value(0) {}
60
PointerIntPair(PointerTy Ptr, IntType Int) : Value(0) {
61
assert(IntBits <= PtrTraits::NumLowBitsAvailable &&
62
"PointerIntPair formed with integer size too large for pointer");
67
PointerTy getPointer() const {
68
return PtrTraits::getFromVoidPointer(
69
reinterpret_cast<void*>(Value & PointerBitMask));
72
IntType getInt() const {
73
return (IntType)((Value >> IntShift) & IntMask);
76
void setPointer(PointerTy Ptr) {
78
= reinterpret_cast<intptr_t>(PtrTraits::getAsVoidPointer(Ptr));
79
assert((PtrVal & ((1 << PtrTraits::NumLowBitsAvailable)-1)) == 0 &&
80
"Pointer is not sufficiently aligned");
81
// Preserve all low bits, just update the pointer.
82
Value = PtrVal | (Value & ~PointerBitMask);
85
void setInt(IntType Int) {
86
intptr_t IntVal = Int;
87
assert(IntVal < (1 << IntBits) && "Integer too large for field");
89
// Preserve all bits other than the ones we are updating.
90
Value &= ~ShiftedIntMask; // Remove integer field.
91
Value |= IntVal << IntShift; // Set new integer.
94
void *getOpaqueValue() const { return reinterpret_cast<void*>(Value); }
95
void setFromOpaqueValue(void *Val) { Value = reinterpret_cast<intptr_t>(Val);}
97
static PointerIntPair getFromOpaqueValue(void *V) {
98
PointerIntPair P; P.setFromOpaqueValue(V); return P;
101
bool operator==(const PointerIntPair &RHS) const {return Value == RHS.Value;}
102
bool operator!=(const PointerIntPair &RHS) const {return Value != RHS.Value;}
103
bool operator<(const PointerIntPair &RHS) const {return Value < RHS.Value;}
104
bool operator>(const PointerIntPair &RHS) const {return Value > RHS.Value;}
105
bool operator<=(const PointerIntPair &RHS) const {return Value <= RHS.Value;}
106
bool operator>=(const PointerIntPair &RHS) const {return Value >= RHS.Value;}
109
template <typename T> struct isPodLike;
110
template<typename PointerTy, unsigned IntBits, typename IntType>
111
struct isPodLike<PointerIntPair<PointerTy, IntBits, IntType> > {
112
static const bool value = true;
115
// Provide specialization of DenseMapInfo for PointerIntPair.
116
template<typename PointerTy, unsigned IntBits, typename IntType>
117
struct DenseMapInfo<PointerIntPair<PointerTy, IntBits, IntType> > {
118
typedef PointerIntPair<PointerTy, IntBits, IntType> Ty;
119
static Ty getEmptyKey() {
121
Val <<= PointerLikeTypeTraits<PointerTy>::NumLowBitsAvailable;
122
return Ty(reinterpret_cast<PointerTy>(Val), IntType((1 << IntBits)-1));
124
static Ty getTombstoneKey() {
126
Val <<= PointerLikeTypeTraits<PointerTy>::NumLowBitsAvailable;
127
return Ty(reinterpret_cast<PointerTy>(Val), IntType(0));
129
static unsigned getHashValue(Ty V) {
130
uintptr_t IV = reinterpret_cast<uintptr_t>(V.getOpaqueValue());
131
return unsigned(IV) ^ unsigned(IV >> 9);
133
static bool isEqual(const Ty &LHS, const Ty &RHS) { return LHS == RHS; }
136
// Teach SmallPtrSet that PointerIntPair is "basically a pointer".
137
template<typename PointerTy, unsigned IntBits, typename IntType,
139
class PointerLikeTypeTraits<PointerIntPair<PointerTy, IntBits, IntType,
143
getAsVoidPointer(const PointerIntPair<PointerTy, IntBits, IntType> &P) {
144
return P.getOpaqueValue();
146
static inline PointerIntPair<PointerTy, IntBits, IntType>
147
getFromVoidPointer(void *P) {
148
return PointerIntPair<PointerTy, IntBits, IntType>::getFromOpaqueValue(P);
151
NumLowBitsAvailable = PtrTraits::NumLowBitsAvailable - IntBits
155
} // end namespace llvm