Skip to content

[5.9][IRGen] Add flags to enable or disable generation of layout string va… #64821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 10, 2023
Merged

[5.9][IRGen] Add flags to enable or disable generation of layout string va… #64821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions include/swift/AST/DiagnosticsFrontend.def
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,5 +529,9 @@ WARNING(enable_interop_flag_deprecated,none,
"the -enable-experimental-cxx-interop flag is deprecated. Please pass "
"'-cxx-interoperability-mode=' instead.", ())

ERROR(layout_string_instantiation_without_layout_strings,none,
"-enable-layout-string-value-witnesses-instantiation can not be enabled "
"without -enable-layout-string-value-witnesses.", ())

#define UNDEFINE_DIAGNOSTIC_MACROS
#include "DefineDiagnosticMacros.h"
8 changes: 8 additions & 0 deletions include/swift/AST/IRGenOptions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,12 @@ class IRGenOptions {
/// using TypeInfo entries.
unsigned ForceStructTypeLayouts : 1;

/// Enable generation and use of layout string based value witnesses
unsigned EnableLayoutStringValueWitnesses : 1;

/// Enable runtime instantiation of value witness strings for generic types
unsigned EnableLayoutStringValueWitnessesInstantiation : 1;

/// Instrument code to generate profiling information.
unsigned GenerateProfile : 1;

Expand Down Expand Up @@ -493,6 +499,8 @@ class IRGenOptions {
CompactAbsoluteFunctionPointer(false), DisableLegacyTypeInfo(false),
PrespecializeGenericMetadata(false), UseIncrementalLLVMCodeGen(true),
UseTypeLayoutValueHandling(true), ForceStructTypeLayouts(false),
EnableLayoutStringValueWitnesses(false),
EnableLayoutStringValueWitnessesInstantiation(false),
GenerateProfile(false), EnableDynamicReplacementChaining(false),
DisableDebuggerShadowCopies(false),
DisableConcreteTypeMetadataMangledNameAccessors(false),
Expand Down
12 changes: 12 additions & 0 deletions include/swift/Option/FrontendOptions.td
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1022,6 +1022,18 @@ def disable_type_layouts : Flag<["-"], "disable-type-layout">,
def force_struct_type_layouts : Flag<["-"], "force-struct-type-layouts">,
HelpText<"Force type layout based lowering for structs">;

def enable_layout_string_value_witnesses : Flag<["-"], "enable-layout-string-value-witnesses">,
HelpText<"Enable layout string based value witnesses">;

def disable_layout_string_value_witnesses : Flag<["-"], "disable-layout-string-value-witnesses">,
HelpText<"Disable layout string based value witnesses">;

def enable_layout_string_value_witnesses_instantiation : Flag<["-"], "enable-layout-string-value-witnesses-instantiation">,
HelpText<"Enable runtime instantiation of layout string value witnesses for generic types">;

def disable_layout_string_value_witnesses_instantiation : Flag<["-"], "disable-layout-string-value-witnesses-instantiation">,
HelpText<"Disable runtime instantiation of layout string value witnesses for generic types">;

def disable_interface_lockfile : Flag<["-"], "disable-interface-lock">,
HelpText<"Don't lock interface file when building module">;

Expand Down
15 changes: 15 additions & 0 deletions lib/Frontend/CompilerInvocation.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2646,6 +2646,21 @@ static bool ParseIRGenArgs(IRGenOptions &Opts, ArgList &Args,
Args.hasFlag(OPT_enable_relative_protocol_witness_tables,
OPT_disable_relative_protocol_witness_tables,
Opts.UseRelativeProtocolWitnessTables);

Opts.EnableLayoutStringValueWitnesses = Args.hasFlag(OPT_enable_layout_string_value_witnesses,
OPT_disable_layout_string_value_witnesses,
Opts.EnableLayoutStringValueWitnesses);

Opts.EnableLayoutStringValueWitnessesInstantiation = Args.hasFlag(OPT_enable_layout_string_value_witnesses_instantiation,
OPT_disable_layout_string_value_witnesses_instantiation,
Opts.EnableLayoutStringValueWitnessesInstantiation);

if (Opts.EnableLayoutStringValueWitnessesInstantiation &&
!Opts.EnableLayoutStringValueWitnesses) {
Diags.diagnose(SourceLoc(), diag::layout_string_instantiation_without_layout_strings);
return true;
}

return false;
}

Expand Down
38 changes: 26 additions & 12 deletions lib/IRGen/GenMeta.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2591,15 +2591,17 @@ void irgen::emitLazyTypeContextDescriptor(IRGenModule &IGM,
auto &ti = IGM.getTypeInfo(lowered);
auto *typeLayoutEntry =
ti.buildTypeLayoutEntry(IGM, lowered, /*useStructLayouts*/ true);
if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses)) {
if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) &&
IGM.getOptions().EnableLayoutStringValueWitnesses) {

auto genericSig =
lowered.getNominalOrBoundGenericNominal()->getGenericSignature();
hasLayoutString = !!typeLayoutEntry->layoutString(IGM, genericSig);
}

if (auto sd = dyn_cast<StructDecl>(type)) {
if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnessesInstantiation)) {
if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnessesInstantiation) &&
IGM.getOptions().EnableLayoutStringValueWitnessesInstantiation) {
hasLayoutString |= requiresForeignTypeMetadata(type) ||
needsSingletonMetadataInitialization(IGM, type) ||
(type->isGenericContext() && !isa<FixedTypeInfo>(ti));
Expand Down Expand Up @@ -2896,7 +2898,8 @@ static void emitInitializeFieldOffsetVectorWithLayoutString(
bool isVWTMutable, MetadataDependencyCollector *collector) {
auto &IGM = IGF.IGM;
assert(IGM.Context.LangOpts.hasFeature(
Feature::LayoutStringValueWitnessesInstantiation));
Feature::LayoutStringValueWitnessesInstantiation) &&
IGM.getOptions().EnableLayoutStringValueWitnesses);

auto *target = T.getStructOrBoundGenericStruct();

Expand Down Expand Up @@ -3008,7 +3011,9 @@ static void emitInitializeValueMetadata(IRGenFunction &IGF,

if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) &&
IGM.Context.LangOpts.hasFeature(
Feature::LayoutStringValueWitnessesInstantiation)) {
Feature::LayoutStringValueWitnessesInstantiation) &&
IGM.getOptions().EnableLayoutStringValueWitnesses &&
IGM.getOptions().EnableLayoutStringValueWitnessesInstantiation) {
emitInitializeFieldOffsetVectorWithLayoutString(IGF, loweredTy, metadata,
isVWTMutable, collector);
} else {
Expand Down Expand Up @@ -3123,7 +3128,8 @@ namespace {
Impl &asImpl() { return *static_cast<Impl*>(this); }

llvm::Constant *emitLayoutString() {
if (!IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses))
if (!IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) ||
!IGM.getOptions().EnableLayoutStringValueWitnesses)
return nullptr;
auto lowered = getLoweredTypeInPrimaryContext(
IGM, Target->getDeclaredType()->getCanonicalType());
Expand Down Expand Up @@ -3206,7 +3212,8 @@ namespace {
asImpl().emitInitializeMetadata(IGF, metadata, false, collector);

if (IGM.Context.LangOpts.hasFeature(
Feature::LayoutStringValueWitnesses)) {
Feature::LayoutStringValueWitnesses) &&
IGM.getOptions().EnableLayoutStringValueWitnesses) {
if (auto *layoutString = getLayoutString()) {
auto layoutStringCast = IGF.Builder.CreateBitCast(layoutString,
IGM.Int8PtrTy);
Expand Down Expand Up @@ -3782,7 +3789,8 @@ namespace {
}

llvm::Constant *emitLayoutString() {
if (!IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses))
if (!IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) ||
!IGM.getOptions().EnableLayoutStringValueWitnesses)
return nullptr;
auto lowered = getLoweredTypeInPrimaryContext(
IGM, Target->getDeclaredType()->getCanonicalType());
Expand Down Expand Up @@ -4986,11 +4994,13 @@ namespace {
}

bool hasLayoutString() {
if (!IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses)) {
if (!IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) ||
!IGM.getOptions().EnableLayoutStringValueWitnesses) {
return false;
}

if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnessesInstantiation)) {
if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnessesInstantiation) &&
IGM.getOptions().EnableLayoutStringValueWitnessesInstantiation) {
return !!getLayoutString() || needsSingletonMetadataInitialization(IGM, Target);
}

Expand Down Expand Up @@ -5029,7 +5039,8 @@ namespace {
}

llvm::Constant *emitLayoutString() {
if (!IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses))
if (!IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) ||
!IGM.getOptions().EnableLayoutStringValueWitnesses)
return nullptr;
auto lowered = getLoweredTypeInPrimaryContext(
IGM, Target->getDeclaredType()->getCanonicalType());
Expand Down Expand Up @@ -5180,12 +5191,14 @@ namespace {

bool hasLayoutString() {
if (!IGM.Context.LangOpts.hasFeature(
Feature::LayoutStringValueWitnesses)) {
Feature::LayoutStringValueWitnesses) ||
!IGM.getOptions().EnableLayoutStringValueWitnesses) {
return false;
}
return !!getLayoutString() ||
(IGM.Context.LangOpts.hasFeature(
Feature::LayoutStringValueWitnessesInstantiation) &&
IGM.getOptions().EnableLayoutStringValueWitnessesInstantiation &&
(HasDependentVWT || HasDependentMetadata) &&
!isa<FixedTypeInfo>(IGM.getTypeInfo(getLoweredType())));
}
Expand Down Expand Up @@ -5445,7 +5458,8 @@ namespace {
}

llvm::Constant *emitLayoutString() {
if (!IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses))
if (!IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) ||
!IGM.getOptions().EnableLayoutStringValueWitnesses)
return nullptr;
auto lowered = getLoweredTypeInPrimaryContext(
IGM, Target->getDeclaredType()->getCanonicalType());
Expand Down
18 changes: 12 additions & 6 deletions lib/IRGen/GenValueWitness.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -921,7 +921,8 @@ bool isRuntimeInstatiatedLayoutString(IRGenModule &IGM,
const TypeLayoutEntry *typeLayoutEntry) {
if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) &&
IGM.Context.LangOpts.hasFeature(
Feature::LayoutStringValueWitnessesInstantiation)) {
Feature::LayoutStringValueWitnessesInstantiation) &&
IGM.getOptions().EnableLayoutStringValueWitnessesInstantiation) {
return (typeLayoutEntry->isAlignedGroup() &&
!typeLayoutEntry->isFixedSize(IGM));
}
Expand Down Expand Up @@ -986,7 +987,8 @@ static void addValueWitness(IRGenModule &IGM, ConstantStructBuilder &B,
return addFunction(getNoOpVoidFunction(IGM));
} else if (concreteTI.isSingleSwiftRetainablePointer(ResilienceExpansion::Maximal)) {
return addFunction(getDestroyStrongFunction(IGM));
} else if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses)) {
} else if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) &&
IGM.getOptions().EnableLayoutStringValueWitnesses) {
if (auto *typeLayoutEntry =
concreteTI.buildTypeLayoutEntry(IGM, concreteType,
/*useStructLayouts*/true)) {
Expand All @@ -1013,7 +1015,8 @@ static void addValueWitness(IRGenModule &IGM, ConstantStructBuilder &B,
case ValueWitness::InitializeWithTake:
if (concreteTI.isBitwiseTakable(ResilienceExpansion::Maximal)) {
return addFunction(getMemCpyFunction(IGM, concreteTI));
} else if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses)) {
} else if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) &&
IGM.getOptions().EnableLayoutStringValueWitnesses) {
if (auto *typeLayoutEntry =
concreteTI.buildTypeLayoutEntry(IGM, concreteType,
/*useStructLayouts*/true)) {
Expand All @@ -1032,7 +1035,8 @@ static void addValueWitness(IRGenModule &IGM, ConstantStructBuilder &B,
return addFunction(getMemCpyFunction(IGM, concreteTI));
} else if (concreteTI.isSingleSwiftRetainablePointer(ResilienceExpansion::Maximal)) {
return addFunction(getAssignWithCopyStrongFunction(IGM));
} else if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses)) {
} else if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) &&
IGM.getOptions().EnableLayoutStringValueWitnesses) {
if (auto *typeLayoutEntry =
concreteTI.buildTypeLayoutEntry(IGM, concreteType,
/*useStructLayouts*/true)) {
Expand All @@ -1051,7 +1055,8 @@ static void addValueWitness(IRGenModule &IGM, ConstantStructBuilder &B,
return addFunction(getMemCpyFunction(IGM, concreteTI));
} else if (concreteTI.isSingleSwiftRetainablePointer(ResilienceExpansion::Maximal)) {
return addFunction(getAssignWithTakeStrongFunction(IGM));
} else if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses)) {
} else if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) &&
IGM.getOptions().EnableLayoutStringValueWitnesses) {
if (auto *typeLayoutEntry =
concreteTI.buildTypeLayoutEntry(IGM, concreteType,
/*useStructLayouts*/true)) {
Expand All @@ -1070,7 +1075,8 @@ static void addValueWitness(IRGenModule &IGM, ConstantStructBuilder &B,
return addFunction(getMemCpyFunction(IGM, concreteTI));
} else if (concreteTI.isSingleSwiftRetainablePointer(ResilienceExpansion::Maximal)) {
return addFunction(getInitWithCopyStrongFunction(IGM));
} else if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses)) {
} else if (IGM.Context.LangOpts.hasFeature(Feature::LayoutStringValueWitnesses) &&
IGM.getOptions().EnableLayoutStringValueWitnesses) {
if (auto *typeLayoutEntry =
concreteTI.buildTypeLayoutEntry(IGM, concreteType,
/*useStructLayouts*/true)) {
Expand Down