1 //===-- Address.h - An aligned address -------------------------*- 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 class provides a simple wrapper for a pair of a pointer and an
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_CLANG_LIB_CODEGEN_ADDRESS_H
16 #define LLVM_CLANG_LIB_CODEGEN_ADDRESS_H
18 #include "llvm/IR/Constants.h"
19 #include "clang/AST/CharUnits.h"
24 /// An aligned address.
29 Address(llvm::Value *pointer, CharUnits alignment)
30 : Pointer(pointer), Alignment(alignment) {
31 assert((!alignment.isZero() || pointer == nullptr) &&
32 "creating valid address with invalid alignment");
35 static Address invalid() { return Address(nullptr, CharUnits()); }
36 bool isValid() const { return Pointer != nullptr; }
38 llvm::Value *getPointer() const {
43 /// Return the type of the pointer value.
44 llvm::PointerType *getType() const {
45 return llvm::cast<llvm::PointerType>(getPointer()->getType());
48 /// Return the type of the values stored in this address.
50 /// When IR pointer types lose their element type, we should simply
51 /// store it in Address instead for the convenience of writing code.
52 llvm::Type *getElementType() const {
53 return getType()->getElementType();
56 /// Return the address space that this address resides in.
57 unsigned getAddressSpace() const {
58 return getType()->getAddressSpace();
61 /// Return the IR name of the pointer value.
62 llvm::StringRef getName() const {
63 return getPointer()->getName();
66 /// Return the alignment of this pointer.
67 CharUnits getAlignment() const {
73 /// A specialization of Address that requires the address to be an
75 class ConstantAddress : public Address {
77 ConstantAddress(llvm::Constant *pointer, CharUnits alignment)
78 : Address(pointer, alignment) {}
80 static ConstantAddress invalid() {
81 return ConstantAddress(nullptr, CharUnits());
84 llvm::Constant *getPointer() const {
85 return llvm::cast<llvm::Constant>(Address::getPointer());
88 ConstantAddress getBitCast(llvm::Type *ty) const {
89 return ConstantAddress(llvm::ConstantExpr::getBitCast(getPointer(), ty),
93 ConstantAddress getElementBitCast(llvm::Type *ty) const {
94 return getBitCast(ty->getPointerTo(getAddressSpace()));
97 static bool isaImpl(Address addr) {
98 return llvm::isa<llvm::Constant>(addr.getPointer());
100 static ConstantAddress castImpl(Address addr) {
101 return ConstantAddress(llvm::cast<llvm::Constant>(addr.getPointer()),
102 addr.getAlignment());
110 // Present a minimal LLVM-like casting interface.
111 template <class U> inline U cast(clang::CodeGen::Address addr) {
112 return U::castImpl(addr);
114 template <class U> inline bool isa(clang::CodeGen::Address addr) {
115 return U::isaImpl(addr);
120 // Make our custom isa and cast available in namespace clang, to mirror
121 // what we do for LLVM's versions in Basic/LLVM.h.