mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
1898b01ce6
This library will likely become home to other fast-path-in-client functions, so give it a more general name.
128 lines
4.3 KiB
C++
128 lines
4.3 KiB
C++
//===--- SwiftTargetInfo.h --------------------------------------*- 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 declares the SwiftTargetInfo abstract base class. This class
|
|
// provides an interface to target-dependent attributes of interest to Swift.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_IRGEN_SWIFTTARGETINFO_H
|
|
#define SWIFT_IRGEN_SWIFTTARGETINFO_H
|
|
|
|
#include "swift/Basic/LLVM.h"
|
|
#include "swift/Basic/ClusteredBitVector.h"
|
|
#include "llvm/TargetParser/Triple.h"
|
|
#include "IRGen.h"
|
|
|
|
namespace swift {
|
|
namespace irgen {
|
|
class IRGenModule;
|
|
|
|
class SwiftTargetInfo {
|
|
explicit SwiftTargetInfo(llvm::Triple::ObjectFormatType outputObjectFormat,
|
|
unsigned numPointerBits);
|
|
|
|
public:
|
|
|
|
/// Produces a SwiftTargetInfo object appropriate to the target.
|
|
static SwiftTargetInfo get(IRGenModule &IGM);
|
|
|
|
/// True if the ObjC runtime for the chosen platform supports tagged pointers.
|
|
bool hasObjCTaggedPointers() const;
|
|
|
|
/// True if the ObjC runtime for the chosen platform requires ISA masking.
|
|
bool hasISAMasking() const {
|
|
return ObjCUseISAMask;
|
|
}
|
|
|
|
/// True if the ObjC runtime for the chosen platform has opaque ISAs. This
|
|
/// means that even masking the ISA may not return a pointer value. The ObjC
|
|
/// runtime should be used for all accesses to get the ISA from a value.
|
|
bool hasOpaqueISAs() const {
|
|
return ObjCHasOpaqueISAs;
|
|
}
|
|
|
|
bool canUseSwiftAsyncContextAddrIntrinsic() const {
|
|
return UsableSwiftAsyncContextAddrIntrinsic;
|
|
}
|
|
|
|
/// The target's object format type.
|
|
llvm::Triple::ObjectFormatType OutputObjectFormat;
|
|
|
|
/// The spare bit mask for pointers. Bits set in this mask are unused by
|
|
/// pointers of any alignment.
|
|
SpareBitVector PointerSpareBits;
|
|
|
|
/// The spare bit mask for (ordinary C) thin function pointers.
|
|
SpareBitVector FunctionPointerSpareBits;
|
|
|
|
/// The reserved bit mask for Objective-C pointers. Pointer values with
|
|
/// bits from this mask set are reserved by the ObjC runtime and cannot be
|
|
/// used for Swift value layout when a reference type may reference ObjC
|
|
/// objects.
|
|
SpareBitVector ObjCPointerReservedBits;
|
|
|
|
/// These bits, if set, indicate that a Builtin.BridgeObject value is holding
|
|
/// an Objective-C object.
|
|
SpareBitVector IsObjCPointerBit;
|
|
|
|
|
|
/// The alignment of heap objects. By default, assume pointer alignment.
|
|
Alignment HeapObjectAlignment;
|
|
|
|
/// The least integer value that can theoretically form a valid pointer.
|
|
/// By default, assume that there's an entire page free.
|
|
///
|
|
/// This excludes addresses in the null page(s) guaranteed to be
|
|
/// unmapped by the platform.
|
|
///
|
|
/// Changes to this must be kept in sync with swift/Runtime/Metadata.h.
|
|
uint64_t LeastValidPointerValue;
|
|
|
|
/// Poison sentinel value recognized by LLDB as a former reference to a
|
|
/// potentially deinitialized object. It uses no spare bits and cannot point
|
|
/// to readable memory.
|
|
uint64_t ReferencePoisonDebugValue;
|
|
|
|
/// The maximum number of scalars that we allow to be returned directly.
|
|
unsigned MaxScalarsForDirectResult = 3;
|
|
|
|
/// Inline assembly to mark a call to objc_retainAutoreleasedReturnValue.
|
|
llvm::StringRef ObjCRetainAutoreleasedReturnValueMarker;
|
|
|
|
/// Some architectures have specialized objc_msgSend variants.
|
|
bool ObjCUseStret = true;
|
|
bool ObjCUseFPRet = false;
|
|
bool ObjCUseFP2Ret = false;
|
|
bool ObjCUseISAMask = false;
|
|
bool ObjCHasOpaqueISAs = false;
|
|
|
|
/// The value stored in a Builtin.once predicate to indicate that an
|
|
/// initialization has already happened, if known.
|
|
std::optional<int64_t> OnceDonePredicateValue = std::nullopt;
|
|
|
|
/// True if `swift_retain` and `swift_release` are no-ops when passed
|
|
/// "negative" pointer values.
|
|
bool SwiftRetainIgnoresNegativeValues = false;
|
|
|
|
/// True if the swiftSwiftDirectRuntime static library is available.
|
|
bool HasSwiftSwiftDirectRuntimeLibrary = false;
|
|
|
|
bool UsableSwiftAsyncContextAddrIntrinsic = false;
|
|
};
|
|
|
|
}
|
|
}
|
|
|
|
#endif
|
|
|