1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
|
//===--- ConstantBuilder.h - IR generation for constant structs -*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// This file implements IR generation of constant packed LLVM structs.
//===----------------------------------------------------------------------===//
#include "swift/ABI/MetadataValues.h"
#include "swift/AST/IRGenOptions.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DerivedTypes.h"
#include "llvm/IR/GlobalVariable.h"
#include "llvm/IR/Instructions.h"
#include "clang/CodeGen/ConstantInitBuilder.h"
#include "Address.h"
#include "IRGenModule.h"
#include "IRGenFunction.h"
namespace clang {
class PointerAuthSchema;
}
namespace swift {
namespace irgen {
class PointerAuthEntity;
class ConstantAggregateBuilderBase;
class ConstantStructBuilder;
class ConstantArrayBuilder;
class ConstantInitBuilder;
struct ConstantInitBuilderTraits {
using InitBuilder = ConstantInitBuilder;
using AggregateBuilderBase = ConstantAggregateBuilderBase;
using ArrayBuilder = ConstantArrayBuilder;
using StructBuilder = ConstantStructBuilder;
};
/// A Swift customization of Clang's ConstantInitBuilder.
class ConstantInitBuilder
: public clang::CodeGen::ConstantInitBuilderTemplateBase<
ConstantInitBuilderTraits> {
public:
IRGenModule &IGM;
ConstantInitBuilder(IRGenModule &IGM)
: ConstantInitBuilderTemplateBase(IGM.getClangCGM()),
IGM(IGM) {}
};
class ConstantAggregateBuilderBase
: public clang::CodeGen::ConstantAggregateBuilderBase {
using super = clang::CodeGen::ConstantAggregateBuilderBase;
protected:
ConstantAggregateBuilderBase(ConstantInitBuilder &builder,
ConstantAggregateBuilderBase *parent)
: super(builder, parent) {}
ConstantInitBuilder &getBuilder() const {
return static_cast<ConstantInitBuilder&>(Builder);
}
IRGenModule &IGM() const { return getBuilder().IGM; }
public:
void addInt16(uint16_t value) {
addInt(IGM().Int16Ty, value);
}
void addInt32(uint32_t value) {
addInt(IGM().Int32Ty, value);
}
void addInt64(uint64_t value) { addInt(IGM().Int64Ty, value); }
void addSize(Size size) { addInt(IGM().SizeTy, size.getValue()); }
void addCompactFunctionReferenceOrNull(llvm::Function *function) {
if (function) {
addCompactFunctionReference(function);
} else {
addInt(IGM().RelativeAddressTy, 0);
}
}
/// Add a 32-bit function reference to the given function. The reference
/// is direct relative pointer whenever possible. Otherwise, it is a
/// absolute pointer assuming the function address is 32-bit.
void addCompactFunctionReference(llvm::Function *function) {
if (IGM().getOptions().CompactAbsoluteFunctionPointer) {
// Assume that the function address is 32-bit.
add(llvm::ConstantExpr::getPtrToInt(function, IGM().RelativeAddressTy));
} else {
addRelativeOffset(IGM().RelativeAddressTy, function);
}
}
void addRelativeAddressOrNull(llvm::Constant *target) {
if (target) {
addRelativeAddress(target);
} else {
addInt(IGM().RelativeAddressTy, 0);
}
}
void addRelativeAddress(llvm::Constant *target) {
assert(!isa<llvm::ConstantPointerNull>(target));
assert((!IGM().getOptions().CompactAbsoluteFunctionPointer ||
!isa<llvm::Function>(target)) && "use addCompactFunctionReference");
addRelativeOffset(IGM().RelativeAddressTy, target);
}
/// Add a tagged relative reference to the given address. The direct
/// target must be defined within the current image, but it might be
/// a "GOT-equivalent", i.e. a pointer to an external object; if so,
/// set the low bit of the offset to indicate that this is true.
void addRelativeAddress(ConstantReference reference) {
addTaggedRelativeOffset(IGM().RelativeAddressTy,
reference.getValue(),
unsigned(reference.isIndirect()));
}
/// Add an indirect relative reference to the given address.
/// The target must be a "GOT-equivalent", i.e. a pointer to an
/// external object.
void addIndirectRelativeAddress(ConstantReference reference) {
assert(reference.isIndirect());
addRelativeOffset(IGM().RelativeAddressTy,
reference.getValue());
}
Size getNextOffsetFromGlobal() const {
return Size(super::getNextOffsetFromGlobal().getQuantity());
}
void addAlignmentPadding(Alignment align) {
auto misalignment = getNextOffsetFromGlobal() % align;
if (misalignment != Size(0))
add(llvm::ConstantAggregateZero::get(
llvm::ArrayType::get(IGM().Int8Ty,
align.getValue() - misalignment.getValue())));
}
using super::addSignedPointer;
void addSignedPointer(llvm::Constant *pointer,
const clang::PointerAuthSchema &schema,
const PointerAuthEntity &entity);
void addSignedPointer(llvm::Constant *pointer,
const clang::PointerAuthSchema &schema,
uint16_t otherDiscriminator);
/// Add a UniqueHash metadata structure to this builder which stores
/// a hash of the given string.
void addUniqueHash(StringRef ofString);
};
class ConstantArrayBuilder
: public clang::CodeGen::ConstantArrayBuilderTemplateBase<
ConstantInitBuilderTraits> {
private:
llvm::Type *EltTy;
public:
ConstantArrayBuilder(InitBuilder &builder,
AggregateBuilderBase *parent,
llvm::Type *eltTy)
: ConstantArrayBuilderTemplateBase(builder, parent, eltTy), EltTy(eltTy) {}
void addAlignmentPadding(Alignment align) {
auto misalignment = getNextOffsetFromGlobal() % align;
if (misalignment == Size(0))
return;
auto eltSize = IGM().DataLayout.getTypeStoreSize(EltTy);
assert(misalignment.getValue() % eltSize == 0);
for (unsigned i = 0, n = misalignment.getValue() / eltSize; i != n; ++i)
add(llvm::Constant::getNullValue(EltTy));
}
};
class ConstantStructBuilder
: public clang::CodeGen::ConstantStructBuilderTemplateBase<
ConstantInitBuilderTraits> {
public:
template <class... As>
ConstantStructBuilder(As &&... args)
: ConstantStructBuilderTemplateBase(std::forward<As>(args)...) {}
};
} // end namespace irgen
} // end namespace swift
|