| //===--- Private.h - Private runtime declarations ---------------*- C++ -*-===// |
| // |
| // This source file is part of the Swift.org open source project |
| // |
| // Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors |
| // Licensed under Apache License v2.0 with Runtime Library Exception |
| // |
| // See http://swift.org/LICENSE.txt for license information |
| // See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors |
| // |
| //===----------------------------------------------------------------------===// |
| // |
| // Private declarations of the Swift runtime. |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #ifndef SWIFT_RUNTIME_PRIVATE_H |
| #define SWIFT_RUNTIME_PRIVATE_H |
| |
| #include "swift/Basic/Demangle.h" |
| #include "swift/Runtime/Config.h" |
| #include "swift/Runtime/Metadata.h" |
| #include "llvm/Support/Compiler.h" |
| |
| namespace swift { |
| struct ProtocolDescriptor; |
| |
| #if SWIFT_HAS_ISA_MASKING |
| extern "C" uintptr_t swift_isaMask; |
| #endif |
| |
| #if SWIFT_OBJC_INTEROP |
| bool objectConformsToObjCProtocol(const void *theObject, |
| const ProtocolDescriptor *theProtocol); |
| |
| bool classConformsToObjCProtocol(const void *theClass, |
| const ProtocolDescriptor *theProtocol); |
| #endif |
| |
| extern "C" LLVM_LIBRARY_VISIBILITY LLVM_ATTRIBUTE_NORETURN |
| void _swift_abortRetainUnowned(const void *object); |
| |
| /// Is the given value a valid alignment mask? |
| static inline bool isAlignmentMask(size_t mask) { |
| // mask == xyz01111... |
| // mask+1 == xyz10000... |
| // mask&(mask+1) == xyz00000... |
| // So this is nonzero if and only if there any bits set |
| // other than an arbitrarily long sequence of low bits. |
| return (mask & (mask + 1)) == 0; |
| } |
| |
| /// Return the class of an object which is known to be an allocated |
| /// heap object. |
| static inline const ClassMetadata *_swift_getClassOfAllocated(const void *object) { |
| // Load the isa field. |
| uintptr_t bits = *reinterpret_cast<const uintptr_t*>(object); |
| |
| #if SWIFT_HAS_ISA_MASKING |
| // Apply the mask. |
| bits &= swift_isaMask; |
| #endif |
| |
| // The result is a class pointer. |
| return reinterpret_cast<const ClassMetadata *>(bits); |
| } |
| |
| /// Is the given value an Objective-C tagged pointer? |
| static inline bool isObjCTaggedPointer(const void *object) { |
| #if SWIFT_OBJC_INTEROP |
| return (((uintptr_t) object) & heap_object_abi::ObjCReservedBitsMask); |
| #else |
| assert(!(((uintptr_t) object) & heap_object_abi::ObjCReservedBitsMask)); |
| return false; |
| #endif |
| } |
| |
| static inline bool isObjCTaggedPointerOrNull(const void *object) { |
| return object == nullptr || isObjCTaggedPointer(object); |
| } |
| |
| LLVM_LIBRARY_VISIBILITY |
| const ClassMetadata *_swift_getClass(const void *object); |
| |
| static inline |
| const ClassMetadata *_swift_getSuperclass(const ClassMetadata *theClass) { |
| return theClass->SuperClass; |
| } |
| |
| LLVM_LIBRARY_VISIBILITY |
| bool usesNativeSwiftReferenceCounting(const ClassMetadata *theClass); |
| |
| /// Get the superclass pointer value used for Swift root classes. |
| /// Note that this function may return a nullptr on non-objc platforms, |
| /// where there is no common root class. rdar://problem/18987058 |
| const ClassMetadata *getRootSuperclass(); |
| |
| /// Check if a class has a formal superclass in the AST. |
| static inline |
| bool classHasSuperclass(const ClassMetadata *c) { |
| return (c->SuperClass && c->SuperClass != getRootSuperclass()); |
| } |
| |
| /// Replace entries of a freshly-instantiated value witness table with more |
| /// efficient common implementations where applicable. |
| /// |
| /// For instance, if the value witness table represents a POD type, this will |
| /// insert POD value witnesses into the table. The vwtable's flags must have |
| /// been initialized before calling this function. |
| /// |
| /// Returns true if common value witnesses were used, false otherwise. |
| void installCommonValueWitnesses(ValueWitnessTable *vwtable); |
| |
| #if SWIFT_OBJC_INTEROP |
| Demangle::NodePointer _swift_buildDemanglingForMetadata(const Metadata *type); |
| #endif |
| |
| } // end namespace swift |
| |
| #endif /* SWIFT_RUNTIME_PRIVATE_H */ |