Home

Types

• ContextDescriptor.Kind
• GenericContextDescriptor.GenericPrarameterKind
• GenericRequirementDescriptor.GenericRequirementKind
• GenericRequirementDescriptor.GenericRequirementLayoutKind
• ProtocolRequirement.Kind
• TypeDescriptor.TypeReferenceKind
• ExistentialMetadata.SpecialProtocol
• TypeMetadataKind
• ClassMetadata
• ClassMetadata.MetadataStructure
• ClassMetadata.Flags
• ClassDescriptor
• ClassDescriptor.InternalRepresentation
• ContextDescriptor
• ContextDescriptor.InternalRepresentation
• ContextDescriptor.Flags
• EnumDescriptor
• EnumDescriptor.InternalRepresentation
• ExtensionDescriptor
• ExtensionDescriptor.InternalRepresentation
• GenericContextDescriptor
• GenericContextDescriptor.InternalRepresentation
• GenericContextDescriptor.GenericParameterDescriptor
• GenericRequirementDescriptor
• GenericRequirementDescriptor.InternalRepresentation
• GenericRequirementDescriptor.Flags
• ModuleDescriptor
• ModuleDescriptor.InternalRepresentation
• ProtocolDescriptor
• ProtocolDescriptor.InternalRepresentation
• ProtocolDescriptor.Flags
• ProtocolRequirement
• ProtocolRequirement.InternalRepresentation
• ProtocolRequirement.Flags
• StructDescriptor
• StructDescriptor.InternalRepresentation
• TypeDescriptor
• TypeDescriptor.InternalRepresentation
• TypeDescriptor.Flags
• EnumMetadata
• EnumMetadata.MetadataStructure
• ExistentialMetadata
• ExistentialMetadata.InternalRepresentation
• ExistentialMetadata.Flags
• FunctionMetadata
• FunctionMetadata.MetadataStructure
• ProtocolMetadata
• ProtocolMetadata.MetadataStructure
• StructMetadata
• StructMetadata.MetadataStructure
• TupleElementMetadata
• TupleElementMetadata.InternalRepresentation
• TupleMetadata
• TupleMetadata.MetadataStructure
• TupleMetadata.TupleElement
• ValueWitnessTable
• ValueWitnessTable.InternalRepresentation
• ValueWitnessTable.Flags
• PointerAuthentication: A namespace for the pointer authentication builtins.
• SignedPointer
• RuntimeModifiableBuilder: A type to create a RuntimeModifiable from.

Protocols

• InternalStructureBase
• AnyContextDescriptor
• TypeMetadata
• AnyRuntimeModifiable: A protocol to which all RuntimeModifiable structures conform
• RuntimeModifiable: A structure that allows the dynamic get/set of a swift structs stored properties.
• StructureRepresentation

Global Typealiases

• getExtraInhabitantTag_t

Global Functions

• Block_copy(:​): Copies an objective-c block given its pointer, then returns the block back to the caller. This can be used to take a compile time block literal, and elevate it to the runtime by moving it into the heap, or if already there, by incrementing the retain counter.
• Block_release(:​): Releases an objective-c block. If the block is in the heap, this will either (1) decrement the retain count and/or (2) free the memory at the location of the block if the retain count is 0.
• swift_allocObject(:​:​_:​): For swift_allocObject (in this version of the function signature) you pass in UnsafeRawPointer Once we get all the metadata bridged replace it with ClassMetadata or similar type. Also, I'm not sure enough about how the alignment mask works to explain it. If someone feels like documenting it, that would be amazing. (zoomer problem)
• swift_allocBox(_:​): Creates and returns a structure containing an allocated heap object as well as the value itself following it.
• swift_allocateGenericClassMetadata(:​:​_:​): Allocates a ClassMetadata and returns the new memory.
• swift_allocateGenericValueMetadata(:​:​_:​_:​): Allocate a GenericValueMetadata object. This is intended to be called by the metadata instantation function of a generic struct or enum.
• swift_arrayAssignWithCopyBackToFront(:​:​_:​_:​): The type UnsafeRawPointer in the case of the array function signatures actually represent OpaqueValue*. Until That is properly bridged over, it is what it is. Any.Type Represents the self parameter or Metadata. This follows the same principle. Until the proper Array metadata is bridged, we leave it be. This may not be the best solution so every suggestion is appreciated
• swift_arrayAssignWithCopyFrontToBack(:​:​_:​_:​): Using an already existant array and associated heap object, this assigns values from the source object to the destination object by copying them from the front of the object to the back. It does this using a memove when the witness table is POD, and by using a default witness function when not POD.
• swift_arrayAssignWithCopyNoAlias(:​:​_:​_:​): Using an already existant array and associated heap object, this assigns values from the source object object to the destination by defaulting to a witness function to copy the values when not POD, but using memcpy when it is POD.
• swift_arrayDestroy(:​:​_:​): Using an already existant array, it destorys a certain amount of values from inside of it. This is done using the destroy function of the arrays witness table function destroy. There is no alternative to this so non POD values will not be able to utilize the function.
• swift_arrayInitWithCopy(:​:​_:​_:​): Taking an empty heap object and an already initialized one, this initializes the empty one by copying a certain amount of children from the initialized one. If the source object is POD, it gets copied using memcpy. If not, it utilizes the provided witness functions located in the metadata's witness table.
• swift_initWithTakeBackToFront(:​:​_:​_:​): Using an empty heap object and an already existant array, this takes values from the existant one and fills the empty one. If the metadata is POD, this is done memmove; else it is done with a witness funcion.
• swift_initWithTakeFrontToBack(:​:​_:​_:​): Using an empty heap object and an already existant array, this takes values from the existant one and fills the empty one. If the metadata is POD, this is done memmove; else it is done with a witness funcion.
• swift_initWithTakeNoAlias(:​:​_:​_:​): Using an empty heap object and an already existant array, this takes values from the existant one and fills the empty one. If the metadata is POD, this is done memcpy; else it is done with a witness funcion.
• swift_autoDiffAllocateSubContext(:​:​): For this section, UnsafeRawPointer is in place of AutoDiffLinearMapContext; of course, this is here until we exchange the code with the type implementation. I'm thinking that it would be cool to just rewrite the AutoDiffLinearMapContext to tail allocate the initial slab. This would cover their TODO and it would be in swift. Two big bonuses.
• swift_autoDiffCreateLinearMapContext(_:​): malloc's a buffer suitable for the AutoDiffLinearMapContext and returns the initialized memory. The memory passed in increases the allocation internally at the tail.
• swift_autoDiffProjectTopLevelSubcontext(_:​): Calculates and returns the address to the start of the tail-allocated sub-context.
• swift_beginAccess(:​:​_:​): Starts dynamically tracking accesses to a variable for modification monitoring. This is to ensure the exclusivity rule. Learn more about it here at https://www.swift.org/blog/swift-5-exclusivity/
• swift_bridgeObjectRelease(_:​): Decrements the strong retain count of a bridged object by one, or frees the memory if there are no longer any retains.
• swift_bridgeObjectRelease_n(:​:​): Decrements the strong retain count of a bridged object by n, or frees the memory if there are no longer any retains.
• swift_bridgeObjectRetain(_:​): Increments the retain count of the passed in object by one. Nothing happens to the object if the retain count is zero.
• swift_bridgeObjectRetain_n(:​:​): Increments the retain count of the passed in object by n. Nothing happens to the object if the retain count is zero.
• swift_bridgeRelease(_:​): An alias of swift_bridgeObjectRelease
• swift_checkMetadataState(:​:​): Wraps and initializes the request object with a structure containing a range of functions available for getting the MetadataResponse's for the required metadata.
• swift_compareTypeContextDescriptors(:​:​): By comparing multiple features of a type descriptor such as pointer equality, being null, uniqueness, kinds, and parents, it determines whether they are the same and/or describe the same type context.
• swift_conformsToProtocol(:​:​): Checks and determines the protocol conformance of a given type.
• swift_continuation_await(_:​): Awaits a continuation on the current task until resumed. If it's pending, restore the state to the current task as resumed.
• swift_continuation_init(:​:​): Creates an async task around the flags/context and sets the default task values.
• swift_continuation_resume(_:​): Resumes an async continuation task that has a non throwing continuation.
• swift_continuation_throwingResume(_:​): Resumes an async continuation task that does have a throwing continuation.
• swift_continuation_throwingResumeWithError(:​:​): Resumes an async continuation task by throwing an error.
• swift_copyPOD(:​:​_:​): Preforms a memcpy of the source data into the address of the destination. It gets the size from the objectType parameter once it's cast to a metadata type with an attached witness table size.
• swift_deallocClassInstance(:​:​_:​): Deallocate the given memory.
• swift_deallocObject(:​:​_:​): Deallocate the given memory.
• swift_deallocPartialClassInstance(_:​): Deallocate the given memory after destroying instance variables.
• swift_deallocUninitializedObject(:​:​_:​): Deallocate an uninitialized object with a strong reference count of +1.
• swift_defaultActor_deallocate(_:​): Deallocates an instance of a default actor.
• swift_defaultActor_deallocateResilient(_:​): Deallocate a heap object that might be a default actor.
• swift_defaultActor_destroy(_:​): Destroys a default actor.
• swift_defaultActor_initialize(_:​): Initializes a default actor by calling its initializer.
• swift_deletedMethodError(): Crashes when a deleted method is called by accident.
• swift_distributedActor_remote_initialize(_:​): / void swift_distributedActor_destroy(DefaultActor actor); / OpaqueValue swift_distributedActor_remote_create( OpaqueValue *identity, OpaqueValue *transport);
• swift_dynamicCast(:​:​_:​_:​_:​): Tries to preform a cast on one value type to another with the possibility of failing.
• swift_dynamicCastClass(:​:​): Checked dynamic cast to a Swift class type.
• swift_dynamicCastClassUnconditional(:​:​_:​_:​_:​): Unconditional, checked dynamic cast to a Swift class type.
• swift_dynamicCastMetatype(:​:​): Check to determine if a cast will succeed from one type to a metatype.
• swift_dynamicCastMetatypeToObjectConditional(_:​): Takes an objective-c class object type and returns the underlying class.
• swift_dynamicCastMetatypeToObjectUnconditional(_:​): Takes an objective-c class object type and returns the underlying class.
• swift_dynamicCastMetatypeUnconditional(:​:​_:​_:​_:​): Check to determine if one type is compatable with another if casted.
• swift_dynamicCastObjCClass(:​:​): Checked Objective-C-style dynamic cast to a class type.
• swift_dynamicCastObjCClassMetatype(:​:​): Check to determine castability from a source type of objective-c origin to a target type also of the same origin.
• swift_dynamicCastObjCClassMetatypeUnconditional(:​:​_:​_:​_:​): Check to determine castability from a source type of objective-c origin to a target type also of the same origin.
• swift_dynamicCastObjCClassUnconditional(:​:​_:​_:​_:​): Checked Objective-C-style dynamic cast to a class type.
• swift_dynamicCastObjCProtocolConditional(:​:​_:​): Performs a check to determine if the object conforms the protocol(s).
• swift_dynamicCastObjCProtocolUnconditional(:​:​_:​_:​_:​_:​): Performs a check to determine if the object conforms the protocol(s).
• swift_dynamicCastTypeToObjCProtocolConditional(:​:​_:​): Performs a check to determine if the type conforms the protocol(s).
• swift_dynamicCastTypeToObjCProtocolUnconditional(:​:​_:​_:​_:​_:​): Performs a check to determine if the type conforms the protocol(s).
• swift_dynamicCastUnknownClass(:​:​): Checked dynamic cast of a class instance pointer to the given type.
• swift_dynamicCastUnknownClassUnconditional(:​:​_:​_:​_:​): Checked dynamic cast of a class instance pointer to the given type.
• swift_endAccess(_:​): Stop dynamically tracking an access
• swift_errorInMain(_:​): Invoked by the compiler when code at top level throws an error.
• swift_errorRelease(_:​): Decrements or deallocates the error object depending on the strong retain count.
• swift_errorRetain(_:​): Increments the strong retain count of the error object.
• swift_getAssociatedConformanceWitness(:​:​_:​_:​_:​): Retrieve an associated conformance witness table from the given witness table.
• swift_getAssociatedTypeWitness(:​:​_:​_:​_:​): Retrieve an associated type witness from the given witness table.
• swift_getCanonicalPrespecializedGenericMetadata(:​:​_:​_:​): Fetch a uniqued metadata object for the generic nominal type described by the provided description and arguments, adding the canonical prespecializations attached to the type descriptor to the metadata cache on first run.
• swift_getCanonicalSpecializedMetadata(:​:​_:​): Fetch a uniqued metadata object for the generic nominal type described by the provided candidate metadata, using that candidate metadata if there is not already a canonical metadata.
• swift_getDynamicType(:​:​_:​): Get the dynamic type of an opaque value.
• swift_getEnumCaseMultiPayload(:​:​): Returns an integer value representing which case of a multi-payload enum is inhabited.
• swift_getEnumTagSinglePayloadGeneric(:​:​_:​_:​): Implement getEnumTagSinglePayload generically in terms of a payload type with a getExtraInhabitantIndex function.
• swift_getExistentialMetatypeMetadata(_:​): Fetch a uniqued metadata for an existential metatype type.
• swift_getExistentialTypeMetadata(:​:​_:​_:​): Fetch a uniqued metadata for an existential type.
• swift_getForeignTypeMetadata(_:​): Fetch a unique type metadata object for a foreign type.
• swift_getFunctionTypeMetadata(_:​_:​_:​_:​)