Files
swift-mirror/lib/Serialization/SILFormat.h
Alejandro Alonso 75c2cbf593 Implement value generics
Some requirement machine work

Rename requirement to Value

Rename more things to Value

Fix integer checking for requirement

some docs and parser changes

Minor fixes
2024-09-04 15:13:25 -07:00

607 lines
19 KiB
C++

//===--- SILFormat.h - The internals of serialized SILs ---------*- 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
//
//===----------------------------------------------------------------------===//
///
/// \file Contains various constants and helper types to deal with serialized
/// SILs.
///
//===----------------------------------------------------------------------===//
#ifndef SWIFT_SERIALIZATION_SILFORMAT_H
#define SWIFT_SERIALIZATION_SILFORMAT_H
#include "ModuleFormat.h"
namespace swift {
namespace serialization {
using ValueID = DeclID;
using ValueIDField = DeclIDField;
using SILInstOpCodeField = BCFixed<8>;
using SILTypeCategoryField = BCFixed<2>;
using SILValueOwnershipField = BCFixed<2>;
enum SILStringEncoding : uint8_t {
SIL_UTF8,
SIL_OBJC_SELECTOR,
SIL_BYTES,
SIL_UTF8_OSLOG
};
enum SILLinkageEncoding : uint8_t {
SIL_LINKAGE_PUBLIC,
SIL_LINKAGE_PUBLIC_NON_ABI,
SIL_LINKAGE_PACKAGE,
SIL_LINKAGE_PACKAGE_NON_ABI,
SIL_LINKAGE_HIDDEN,
SIL_LINKAGE_SHARED,
SIL_LINKAGE_PRIVATE,
SIL_LINKAGE_PUBLIC_EXTERNAL,
SIL_LINKAGE_PACKAGE_EXTERNAL,
SIL_LINKAGE_HIDDEN_EXTERNAL,
};
using SILLinkageField = BCFixed<4>;
enum SILVTableEntryKindEncoding : uint8_t {
SIL_VTABLE_ENTRY_NORMAL,
SIL_VTABLE_ENTRY_INHERITED,
SIL_VTABLE_ENTRY_OVERRIDE,
};
using SILVTableEntryKindField = BCFixed<2>;
enum CastConsumptionKindEncoding : uint8_t {
SIL_CAST_CONSUMPTION_TAKE_ALWAYS,
SIL_CAST_CONSUMPTION_TAKE_ON_SUCCESS,
SIL_CAST_CONSUMPTION_COPY_ON_SUCCESS,
SIL_CAST_CONSUMPTION_BORROW_ALWAYS,
};
enum class KeyPathComponentKindEncoding : uint8_t {
StoredProperty,
TupleElement,
GettableProperty,
SettableProperty,
OptionalChain,
OptionalForce,
OptionalWrap,
Trivial,
};
enum class KeyPathComputedComponentIdKindEncoding : uint8_t {
Property,
Function,
DeclRef,
};
/// The record types within the "sil-index" block.
///
/// \sa SIL_INDEX_BLOCK_ID
namespace sil_index_block {
// clang-format off
// These IDs must \em not be renumbered or reordered without incrementing
// the module version.
enum RecordKind {
SIL_FUNC_NAMES = 1,
SIL_FUNC_OFFSETS,
SIL_VTABLE_NAMES,
SIL_VTABLE_OFFSETS,
SIL_MOVEONLYDEINIT_NAMES,
SIL_MOVEONLYDEINIT_OFFSETS,
SIL_GLOBALVAR_NAMES,
SIL_GLOBALVAR_OFFSETS,
SIL_WITNESS_TABLE_NAMES,
SIL_WITNESS_TABLE_OFFSETS,
SIL_DEFAULT_WITNESS_TABLE_NAMES,
SIL_DEFAULT_WITNESS_TABLE_OFFSETS,
SIL_PROPERTY_OFFSETS,
SIL_DIFFERENTIABILITY_WITNESS_NAMES,
SIL_DIFFERENTIABILITY_WITNESS_OFFSETS,
};
using ListLayout = BCGenericRecordLayout<
BCFixed<4>, // record ID
BCVBR<16>, // table offset within the blob
BCBlob // map from identifier strings to IDs.
>;
using OffsetLayout = BCGenericRecordLayout<
BCFixed<4>, // record ID
BCArray<BitOffsetField>
>;
// clang-format on
}
/// The record types within the "sil" block.
///
/// \sa SIL_BLOCK_ID
namespace sil_block {
// clang-format off
// These IDs must \em not be renumbered or reordered without incrementing
// the module version.
enum RecordKind : uint8_t {
SIL_FUNCTION = 1,
SIL_BASIC_BLOCK,
SIL_ONE_VALUE_ONE_OPERAND,
SIL_ONE_TYPE,
SIL_ONE_OPERAND,
SIL_ONE_TYPE_ONE_OPERAND,
SIL_ONE_TYPE_VALUES,
SIL_ONE_TYPE_OWNERSHIP_VALUES,
SIL_ONE_TYPE_VALUES_CATEGORIES,
SIL_TWO_OPERANDS,
SIL_TAIL_ADDR,
SIL_INST_APPLY,
SIL_INST_NO_OPERAND,
SIL_VTABLE,
SIL_VTABLE_ENTRY,
SIL_GLOBALVAR,
SIL_INIT_EXISTENTIAL,
SIL_WITNESS_TABLE,
SIL_WITNESS_METHOD_ENTRY,
SIL_WITNESS_BASE_ENTRY,
SIL_WITNESS_ASSOC_PROTOCOL,
SIL_WITNESS_ASSOC_ENTRY,
SIL_WITNESS_CONDITIONAL_CONFORMANCE,
SIL_DEFAULT_WITNESS_TABLE,
SIL_DEFAULT_WITNESS_TABLE_NO_ENTRY,
SIL_DIFFERENTIABILITY_WITNESS,
SIL_INST_WITNESS_METHOD,
SIL_SPECIALIZE_ATTR,
SIL_ARG_EFFECTS_ATTR,
SIL_PROPERTY,
SIL_ONE_OPERAND_EXTRA_ATTR,
SIL_ONE_TYPE_ONE_OPERAND_EXTRA_ATTR,
SIL_TWO_OPERANDS_EXTRA_ATTR,
SIL_INST_DIFFERENTIABLE_FUNCTION,
SIL_INST_LINEAR_FUNCTION,
SIL_INST_DIFFERENTIABLE_FUNCTION_EXTRACT,
SIL_INST_LINEAR_FUNCTION_EXTRACT,
SIL_INST_INCREMENT_PROFILER_COUNTER,
SIL_MOVEONLY_DEINIT,
SIL_INST_HAS_SYMBOL,
SIL_OPEN_PACK_ELEMENT,
SIL_PACK_ELEMENT_GET,
SIL_PACK_ELEMENT_SET,
SIL_TYPE_VALUE,
};
using SILInstNoOperandLayout = BCRecordLayout<
SIL_INST_NO_OPERAND,
SILInstOpCodeField
>;
using VTableLayout = BCRecordLayout<
SIL_VTABLE,
DeclIDField, // Class Decl
BCFixed<2> // SerializedKind.
>;
using VTableEntryLayout = BCRecordLayout<
SIL_VTABLE_ENTRY,
DeclIDField, // SILFunction name
SILVTableEntryKindField, // Kind
BCFixed<1>, // NonOverridden
BCArray<ValueIDField> // SILDeclRef
>;
using MoveOnlyDeinitLayout = BCRecordLayout<
SIL_MOVEONLY_DEINIT,
DeclIDField, // Class Decl
DeclIDField, // SILFunction name
BCFixed<2> // SerializedKind.
>;
using PropertyLayout = BCRecordLayout<
SIL_PROPERTY,
DeclIDField, // Property decl
BCFixed<2>, // SerializedKind
BCArray<ValueIDField> // Encoded key path component
// Any substitutions or conformances required for the key path component
// follow.
>;
using WitnessTableLayout = BCRecordLayout<
SIL_WITNESS_TABLE,
SILLinkageField, // Linkage
BCFixed<1>, // Is this a declaration. We represent this separately
// from whether or not we have entries since we can
// have empty witness tables.
BCFixed<2>, // SerializedKind.
ProtocolConformanceIDField // conformance
// Witness table entries will be serialized after.
>;
using WitnessMethodEntryLayout = BCRecordLayout<
SIL_WITNESS_METHOD_ENTRY,
DeclIDField, // SILFunction name
BCArray<ValueIDField> // SILDeclRef
>;
using WitnessBaseEntryLayout = BCRecordLayout<
SIL_WITNESS_BASE_ENTRY,
DeclIDField, // ID of protocol decl
ProtocolConformanceIDField // ID of conformance
>;
using WitnessAssocProtocolLayout = BCRecordLayout<
SIL_WITNESS_ASSOC_PROTOCOL,
TypeIDField, // ID of associated type
DeclIDField, // ID of ProtocolDecl
ProtocolConformanceIDField
>;
using WitnessAssocEntryLayout = BCRecordLayout<
SIL_WITNESS_ASSOC_ENTRY,
DeclIDField, // ID of AssociatedTypeDecl
TypeIDField
>;
using WitnessConditionalConformanceLayout = BCRecordLayout<
SIL_WITNESS_CONDITIONAL_CONFORMANCE,
TypeIDField, // ID of associated type
ProtocolConformanceIDField // ID of conformance
>;
using DefaultWitnessTableLayout = BCRecordLayout<
SIL_DEFAULT_WITNESS_TABLE,
DeclIDField, // ID of ProtocolDecl
SILLinkageField // Linkage
// Default witness table entries will be serialized after.
>;
using DefaultWitnessTableNoEntryLayout = BCRecordLayout<
SIL_DEFAULT_WITNESS_TABLE_NO_ENTRY
>;
using SILGlobalVarLayout = BCRecordLayout<
SIL_GLOBALVAR,
SILLinkageField,
BCFixed<2>, // serialized
BCFixed<1>, // Is this a declaration.
BCFixed<1>, // Is this a let variable.
TypeIDField,
DeclIDField
>;
using DifferentiabilityWitnessLayout = BCRecordLayout<
SIL_DIFFERENTIABILITY_WITNESS,
DeclIDField, // Original function name
SILLinkageField, // Linkage
BCFixed<1>, // Is declaration?
BCFixed<2>, // Is serialized?
DifferentiabilityKindField, // Differentiability kind
GenericSignatureIDField, // Derivative function generic signature
DeclIDField, // JVP function name
DeclIDField, // VJP function name
BCVBR<8>, // Number of parameter indices
BCVBR<8>, // Number of result indices
BCArray<ValueIDField> // Parameter and result indices
>;
using SILFunctionLayout =
BCRecordLayout<SIL_FUNCTION, SILLinkageField,
BCFixed<1>, // transparent
BCFixed<2>, // serializedKind
BCFixed<3>, // thunk kind
BCFixed<1>, // without_actually_escaping
BCFixed<3>, // specialPurpose
BCFixed<2>, // inlineStrategy
BCFixed<2>, // optimizationMode
BCFixed<3>, // perfConstraints
BCFixed<2>, // classSubclassScope
BCFixed<1>, // hasCReferences
BCFixed<3>, // side effect info.
BCVBR<8>, // number of specialize attributes
BCFixed<1>, // has qualified ownership
BCFixed<1>, // force weak linking
BC_AVAIL_TUPLE, // availability for weak linking
BCFixed<1>, // is dynamically replacable
BCFixed<1>, // exact self class
BCFixed<1>, // is distributed
BCFixed<1>, // is runtime accessible
BCFixed<1>, // are lexical lifetimes force-enabled
TypeIDField, // SILFunctionType
DeclIDField, // SILFunction name or 0 (replaced function)
DeclIDField, // SILFunction name or 0 (used ad-hoc requirement witness function)
GenericSignatureIDField,
DeclIDField, // ClangNode owner
ModuleIDField, // Parent ModuleDecl *
BCArray<IdentifierIDField> // Semantics Attribute
// followed by specialize and argument effects attributes
// followed by generic param list, if any
>;
using SILSpecializeAttrLayout =
BCRecordLayout<SIL_SPECIALIZE_ATTR,
BCFixed<1>, // exported
BCFixed<1>, // specialization kind
GenericSignatureIDField, // specialized signature
DeclIDField, // Target SILFunction name or 0.
DeclIDField, // SPIGroup or 0.
DeclIDField, // SPIGroup Module name id.
BC_AVAIL_TUPLE, // Availability
BCArray<IdentifierIDField> // type erased params
>;
using SILArgEffectsAttrLayout =
BCRecordLayout<SIL_ARG_EFFECTS_ATTR,
IdentifierIDField, // argument effects string
BCVBR<8>, // argumentIndex
BCFixed<1>, // argumentIndexValid
BCFixed<1> // isDerived
>;
// Has an optional argument list where each argument is a typed valueref.
using SILBasicBlockLayout = BCRecordLayout<
SIL_BASIC_BLOCK,
BCArray<DeclIDField> // The array contains type-value pairs.
>;
// SIL instructions with one valueref and one typed valueref.
// (store)
using SILOneValueOneOperandLayout = BCRecordLayout<
SIL_ONE_VALUE_ONE_OPERAND,
SILInstOpCodeField,
BCFixed<2>, // Optional attributes
ValueIDField,
TypeIDField,
SILTypeCategoryField,
ValueIDField
>;
// SIL instructions with one type and one typed valueref.
using SILOneTypeOneOperandLayout = BCRecordLayout<
SIL_ONE_TYPE_ONE_OPERAND,
SILInstOpCodeField,
BCFixed<2>, // Optional attribute
TypeIDField,
SILTypeCategoryField,
TypeIDField,
SILTypeCategoryField,
ValueIDField
>;
// SIL instructions that construct existential values.
using SILInitExistentialLayout = BCRecordLayout<
SIL_INIT_EXISTENTIAL,
SILInstOpCodeField, // opcode
TypeIDField, // result type
SILTypeCategoryField, // result type category
TypeIDField, // operand type
SILTypeCategoryField, // operand type category
ValueIDField, // operand id
TypeIDField, // formal concrete type
BCArray<ProtocolConformanceIDField> // protocol conformances
>;
// SIL instructions with one type and a list of values.
using SILOneTypeValuesLayout = BCRecordLayout<
SIL_ONE_TYPE_VALUES,
SILInstOpCodeField, // opcode
TypeIDField, // destType
SILTypeCategoryField, // destCategory
BCArray<ValueIDField> // operand ids
>;
// SIL instructions with one type, forwarding ownership, and a list of values.
// For OwnershipForwardingTermInst.
using SILOneTypeOwnershipValuesLayout = BCRecordLayout<
SIL_ONE_TYPE_OWNERSHIP_VALUES,
SILInstOpCodeField,
SILValueOwnershipField,
TypeIDField,
SILTypeCategoryField,
BCArray<ValueIDField>>;
using SILOneTypeValuesCategoriesLayout = BCRecordLayout<
SIL_ONE_TYPE_VALUES_CATEGORIES,
SILInstOpCodeField, // opcode
TypeIDField, // destType
SILTypeCategoryField, // destCategory
BCFixed<1>, // options
BCArray<BCFixed<32>> // operand id and categories.
>;
enum ApplyKind : unsigned {
SIL_APPLY = 0,
SIL_PARTIAL_APPLY,
SIL_BUILTIN,
SIL_TRY_APPLY,
SIL_BEGIN_APPLY
};
using SILInstApplyLayout = BCRecordLayout<
SIL_INST_APPLY,
BCFixed<3>, // ApplyKind
BCFixed<2>, // ApplyOptions
SubstitutionMapIDField, // substitution map
TypeIDField, // callee unsubstituted type
TypeIDField, // callee substituted type
ValueIDField, // callee value
ActorIsolationField, // Caller Isolation if we have one. Unspecified otherwise.
ActorIsolationField, // Callee Isolation if we have one. Unspecified otherwise.
BCArray<ValueIDField> // a list of arguments
>;
// SIL instructions with one type. (alloc_stack)
using SILOneTypeLayout = BCRecordLayout<SIL_ONE_TYPE, SILInstOpCodeField,
BCFixed<4>, // Optional attributes
TypeIDField, SILTypeCategoryField>;
// SIL instructions with one typed valueref. (dealloc_stack, return)
using SILOneOperandLayout =
BCRecordLayout<SIL_ONE_OPERAND, SILInstOpCodeField,
BCFixed<4>, // Optional attributes
TypeIDField, SILTypeCategoryField, ValueIDField>;
using SILOneOperandExtraAttributeLayout = BCRecordLayout<
SIL_ONE_OPERAND_EXTRA_ATTR,
SILInstOpCodeField,
BCFixed<7>, // Optional attributes
TypeIDField, SILTypeCategoryField, ValueIDField
>;
// SIL instructions with one type, one typed valueref, and extra bits.
using SILOneTypeOneOperandExtraAttributeLayout =
BCRecordLayout<SIL_ONE_TYPE_ONE_OPERAND_EXTRA_ATTR, SILInstOpCodeField,
BCFixed<10>, // Optional attributes
TypeIDField, SILTypeCategoryField, TypeIDField,
SILTypeCategoryField, ValueIDField>;
// SIL instructions with two typed values.
using SILTwoOperandsLayout = BCRecordLayout<
SIL_TWO_OPERANDS,
SILInstOpCodeField,
BCFixed<2>, // Optional attributes
TypeIDField,
SILTypeCategoryField,
ValueIDField,
TypeIDField,
SILTypeCategoryField,
ValueIDField
>;
using SILTwoOperandsExtraAttributeLayout = BCRecordLayout<
SIL_TWO_OPERANDS_EXTRA_ATTR,
SILInstOpCodeField,
BCFixed<7>, // Optional attributes
TypeIDField,
SILTypeCategoryField,
ValueIDField,
TypeIDField,
SILTypeCategoryField,
ValueIDField
>;
// The pack_element_get instruction.
using SILOpenPackElementLayout = BCRecordLayout<
SIL_OPEN_PACK_ELEMENT,
GenericEnvironmentIDField,
TypeIDField,
SILTypeCategoryField,
ValueIDField
>;
// The pack_element_get instruction.
using SILPackElementGetLayout = BCRecordLayout<
SIL_PACK_ELEMENT_GET,
SILInstOpCodeField,
TypeIDField, // element type
SILTypeCategoryField, // element type category
TypeIDField, // pack type
SILTypeCategoryField, // pack type category
ValueIDField, // pack value
ValueIDField // index value
>;
// The pack_element_set instruction.
using SILPackElementSetLayout = BCRecordLayout<
SIL_PACK_ELEMENT_SET,
TypeIDField, // element type
SILTypeCategoryField, // element type category
ValueIDField, // element value
TypeIDField, // pack type
SILTypeCategoryField, // pack type category
ValueIDField, // pack value
ValueIDField // index value
>;
// The tail_addr instruction.
using SILTailAddrLayout = BCRecordLayout<
SIL_TAIL_ADDR,
SILInstOpCodeField,
TypeIDField, // Base operand
ValueIDField,
TypeIDField, // Count operand
ValueIDField,
TypeIDField // Result type
>;
using SILInstWitnessMethodLayout = BCRecordLayout<
SIL_INST_WITNESS_METHOD,
TypeIDField, // result type
SILTypeCategoryField,
BCFixed<1>, // volatile?
TypeIDField, // lookup type
SILTypeCategoryField,
TypeIDField, // Optional
SILTypeCategoryField, // opened
ValueIDField, // existential
ProtocolConformanceIDField, // conformance
BCArray<ValueIDField> // SILDeclRef
>;
using SILInstDifferentiableFunctionLayout = BCRecordLayout<
SIL_INST_DIFFERENTIABLE_FUNCTION,
BCVBR<8>, // number of function parameters
BCVBR<8>, // number of function results
BCVBR<8>, // number of differentiability parameters
BCFixed<1>, // has derivative functions?
BCArray<ValueIDField> // parameter indices and operands
>;
using SILInstLinearFunctionLayout = BCRecordLayout<
SIL_INST_LINEAR_FUNCTION,
BCVBR<8>, // number of function parameters
BCFixed<1>, // has transpose function?
BCArray<ValueIDField> // parameter indices and operands
>;
using SILInstDifferentiableFunctionExtractLayout = BCRecordLayout<
SIL_INST_DIFFERENTIABLE_FUNCTION_EXTRACT,
TypeIDField,
SILTypeCategoryField,
ValueIDField,
BCFixed<2>, // extractee
BCFixed<1>, // has explicit extractee type?
TypeIDField // explicit extractee type
>;
using SILInstLinearFunctionExtractLayout = BCRecordLayout<
SIL_INST_LINEAR_FUNCTION_EXTRACT,
TypeIDField,
SILTypeCategoryField,
ValueIDField,
BCFixed<1> // extractee
>;
using SILInstIncrementProfilerCounterLayout = BCRecordLayout<
SIL_INST_INCREMENT_PROFILER_COUNTER,
IdentifierIDField, // PGO func name
IdentifierIDField, // PGO func hash
BCVBR<8>, // counter index
BCVBR<8> // num counters
>;
using SILInstHasSymbolLayout = BCRecordLayout<
SIL_INST_HAS_SYMBOL,
ValueIDField, // decl
BCArray<IdentifierIDField> // referenced functions
>;
using SILTypeValueLayout = BCRecordLayout<
SIL_TYPE_VALUE,
TypeIDField, // Value type
SILTypeCategoryField,
TypeIDField // Generic type
>;
// clang-format on
}
} // end namespace serialization
} // end namespace swift
#endif