Implementation for /most/ of SE-0192 (frozen and non-frozen enums) #14945

jrose-apple · Mar 3, 2018

An alternative to #11961 that only makes a frozen / non-frozen distinction for imported C enums and for Swift enums in the stdlib/overlays. (Really, it's "libraries compiled with -enable-resilience", and exactly what that means has not been discussed publicly and is not part of SE-0192.)

This does not include the implementation of unknown case, or whatever we end up naming it. That's a big enough change on its own that it deserves its own PR, and this part can land first.

The diagnostics part of this is behind a frontend flag, -enable-nonfrozen-enum-exhaustivity-diagnostics.

jrose-apple · Mar 3, 2018

@swift-ci Please test

jrose-apple · Mar 3, 2018

@swift-ci Please test source compatibility

jrose-apple · Mar 3, 2018

@swift-ci Please test compiler performance

swift-ci · Mar 3, 2018

Build failed
Swift Test Linux Platform
Git Sha - 323abe749e92c655446f025896a21cfc590bbf6c

swift-ci · Mar 3, 2018

Build comment file:

Compilation-performance test failed

jrose-apple · Mar 3, 2018

@swift-ci Please test

jrose-apple · Mar 3, 2018

@swift-ci Please test compiler performance

jrose-apple · Mar 3, 2018

@swift-ci Please test source compatibility

swift-ci · Mar 3, 2018

Build failed
Swift Test OS X Platform
Git Sha - 323abe749e92c655446f025896a21cfc590bbf6c

jrose-apple · Mar 3, 2018

@swift-ci Please test source compatibility

jrose-apple · Mar 3, 2018

@swift-ci Please test compiler performance

jrose-apple · Mar 3, 2018

@swift-ci Please test

swift-ci · Mar 3, 2018

Build failed
Swift Test OS X Platform
Git Sha - 323abe749e92c655446f025896a21cfc590bbf6c

swift-ci · Mar 3, 2018

Build failed
Swift Test Linux Platform
Git Sha - 323abe749e92c655446f025896a21cfc590bbf6c

swift-ci · Mar 3, 2018

Build comment file:

Compilation-performance test failed

jrose-apple · Mar 5, 2018

@swift-ci Please test

swift-ci · Mar 5, 2018

Build failed
Swift Test OS X Platform
Git Sha - 094ea9cc2d9bd12436229dbdfec45dc12ca907da

swift-ci · Mar 5, 2018

Build failed
Swift Test Linux Platform
Git Sha - 094ea9cc2d9bd12436229dbdfec45dc12ca907da

jrose-apple · Mar 5, 2018

@swift-ci Please test

swift-ci · Mar 5, 2018

Build failed
Swift Test Linux Platform
Git Sha - a98032b19ea6c4dc78a3b835b1c6a277f8f48068

swift-ci · Mar 5, 2018

Build failed
Swift Test OS X Platform
Git Sha - a98032b19ea6c4dc78a3b835b1c6a277f8f48068

jrose-apple · Mar 5, 2018

@swift-ci Please clean test macOS

swift-ci · Mar 6, 2018

Build failed
Swift Test OS X Platform
Git Sha - 906af8ee3b9951cee00c26382e8762f8ccde9d1c

jrose-apple · Mar 6, 2018

@swift-ci Please test macOS

jrose-apple · Mar 6, 2018

@swift-ci Please test compiler performance

jrose-apple · Mar 6, 2018

@swift-ci Please test source compatibility

jrose-apple · Mar 6, 2018

Compiler performance (still running)
Source compat suite (passed)

swift-ci · Mar 6, 2018

Build comment file:

Summary for master smoketest

No regressions above thresholds

Debug
- debug brief
- debug detailed
Release
- release brief
- release detailed

Debug

debug brief

Regressed (0)

name	old	new	delta	delta_pct

Improved (0)

name	old	new	delta	delta_pct

Unchanged (delta < 1.0% or delta < 100.0ms) (2)

name	old	new	delta	delta_pct
LLVM.NumLLVMBytesOutput	46,401,160	46,401,104	-56	-0.0%
time.swift-driver.wall	79.3s	79.8s	573.7ms	0.72%

debug detailed

Regressed (0)

name	old	new	delta	delta_pct

Improved (0)

name	old	new	delta	delta_pct

Unchanged (delta < 1.0% or delta < 100.0ms) (23)

name	old	new	delta	delta_pct
AST.NumImportedExternalDefinitions	112,854	112,854	0	0.0%
AST.NumLoadedModules	16,158	16,158	0	0.0%
AST.NumTotalClangImportedEntities	332,837	332,837	0	0.0%
AST.NumUsedConformances	9,378	9,378	0	0.0%
IRModule.NumIRBasicBlocks	155,717	155,717	0	0.0%
IRModule.NumIRFunctions	84,191	84,191	0	0.0%
IRModule.NumIRGlobals	71,479	71,479	0	0.0%
IRModule.NumIRInsts	1,531,605	1,531,605	0	0.0%
IRModule.NumIRValueSymbols	140,694	140,694	0	0.0%
LLVM.NumLLVMBytesOutput	46,401,160	46,401,104	-56	-0.0%
SILModule.NumSILGenFunctions	50,146	50,146	0	0.0%
SILModule.NumSILOptFunctions	90,001	90,001	0	0.0%
Sema.NumConformancesDeserialized	459,094	459,094	0	0.0%
Sema.NumConstraintScopes	1,046,545	1,046,545	0	0.0%
Sema.NumDeclsDeserialized	2,985,001	2,985,001	0	0.0%
Sema.NumDeclsValidated	184,557	184,557	0	0.0%
Sema.NumFunctionsTypechecked	64,396	64,396	0	0.0%
Sema.NumGenericSignatureBuilders	86,155	86,155	0	0.0%
Sema.NumLazyGenericEnvironments	592,926	592,926	0	0.0%
Sema.NumLazyGenericEnvironmentsLoaded	50,877	50,877	0	0.0%
Sema.NumLazyIterableDeclContexts	430,908	430,908	0	0.0%
Sema.NumTypesDeserialized	3,201,944	3,201,944	0	0.0%
Sema.NumTypesValidated	273,531	273,531	0	0.0%

Release

release brief

Regressed (0)

name	old	new	delta	delta_pct

Improved (0)

name	old	new	delta	delta_pct

Unchanged (delta < 1.0% or delta < 100.0ms) (2)

name	old	new	delta	delta_pct
LLVM.NumLLVMBytesOutput	38,687,956	38,687,952	-4	-0.0%
time.swift-driver.wall	168.9s	169.5s	638.3ms	0.38%

release detailed

Regressed (0)

name	old	new	delta	delta_pct

Improved (0)

name	old	new	delta	delta_pct

Unchanged (delta < 1.0% or delta < 100.0ms) (23)

name	old	new	delta	delta_pct
AST.NumImportedExternalDefinitions	11,180	11,180	0	0.0%
AST.NumLoadedModules	462	462	0	0.0%
AST.NumTotalClangImportedEntities	32,180	32,180	0	0.0%
AST.NumUsedConformances	9,383	9,383	0	0.0%
IRModule.NumIRBasicBlocks	175,319	175,319	0	0.0%
IRModule.NumIRFunctions	60,588	60,588	0	0.0%
IRModule.NumIRGlobals	58,324	58,324	0	0.0%
IRModule.NumIRInsts	1,344,811	1,344,811	0	0.0%
IRModule.NumIRValueSymbols	107,610	107,610	0	0.0%
LLVM.NumLLVMBytesOutput	38,687,956	38,687,952	-4	-0.0%
SILModule.NumSILGenFunctions	25,087	25,087	0	0.0%
SILModule.NumSILOptFunctions	43,011	43,011	0	0.0%
Sema.NumConformancesDeserialized	154,896	154,896	0	0.0%
Sema.NumConstraintScopes	903,286	903,286	0	0.0%
Sema.NumDeclsDeserialized	255,208	255,208	0	0.0%
Sema.NumDeclsValidated	37,442	37,442	0	0.0%
Sema.NumFunctionsTypechecked	12,616	12,616	0	0.0%
Sema.NumGenericSignatureBuilders	7,680	7,680	0	0.0%
Sema.NumLazyGenericEnvironments	39,262	39,262	0	0.0%
Sema.NumLazyGenericEnvironmentsLoaded	5,093	5,093	0	0.0%
Sema.NumLazyIterableDeclContexts	24,374	24,374	0	0.0%
Sema.NumTypesDeserialized	309,127	309,127	0	0.0%
Sema.NumTypesValidated	44,462	44,462	0	0.0%

jrose-apple · Mar 20, 2018

Rebased.

@swift-ci Please test

jrose-apple · Mar 20, 2018

@swift-ci Please test source compatibility

DougGregor · Mar 20, 2018

DougGregor approved these changes Mar 20, 2018

View changes

This looks good. The space engine part is appropriately mind-boggling, but I've convinced myself it looks good. Nice work!

DougGregor · Mar 20, 2018

Sign in to view

@@ -1101,7 +1101,7 @@ public struct CodingUserInfoKey : RawRepresentable, Equatable, Hashable {
 //===----------------------------------------------------------------------===//

 /// An error that occurs during the encoding of a value.
-@_fixed_layout // FIXME(sil-serialize-all)
+@_frozen // FIXME(sil-serialize-all)


This is a surprise to me; why should encoding and decoding errors be frozen? I'd expect this to grow over time, like most error types.

They'll definitely get un-frozen. This commit did not remove any frozens that were currently there.

... it did in stdlib/public/Platform/POSIXError.swift

…oops. Okay, I'll be consistent.

DougGregor · Mar 20, 2018

stdlib/public/core/DebuggerSupport.swift

 public enum _DebuggerSupport {
-  @_fixed_layout // FIXME(sil-serialize-all)
+  @_frozen // FIXME(sil-serialize-all)
  @_versioned // FIXME(sil-serialize-all)
  internal enum CollectionStatus {


Is there any point to a frozen internal enum?

It's versioned, so yes.

DougGregor · Mar 20, 2018

test/ClangImporter/Inputs/custom-modules/EnumExhaustivity.apinotes

+Name: EnumExhaustivity
+Tags:
+- Name: RegularEnumTurnedExhaustiveThenBackViaAPINotes
+  EnumExtensibility: open


I'd never seen this cute "no newline at end of file" GitHub graphic before

DougGregor · Mar 20, 2018

include/swift/Basic/LangOptions.h

@@ -239,6 +242,10 @@ namespace swift {
    /// Diagnose uses of NSCoding with classes that have unstable mangled names.
    bool EnableNSKeyedArchiverDiagnostics = true;

+    /// Diagnose switches over non-frozen enums that do not have catch-all
+    /// cases.
+    bool EnableNonFrozenEnumExhaustivityDiagnostics = false;


This is for staging while we settle on the "unknown case" spelling, right? It'll go away then?

It's mainly so I can land this part before SE-0192's review period ends, but yes.

slavapestov · Mar 20, 2018

slavapestov reviewed Mar 20, 2018

View changes

Please add some code generation (SILGen) tests for -enable-testing. I imagine we'll want to trap if the original library evolves resiliently, right?

Also, library evolution tests for non-frozen @objc enums to ensure the unknown case is handled properly.

slavapestov · Mar 20, 2018

lib/AST/Decl.cpp

+
+  // All other checks are use-site specific; with no further information, the
+  // enum must be treated non-exhaustively.
+  if (!useDC)


Do we ever need to check exhaustiveness in SILGen or anything else that runs after Sema? Because we won't have a useDC anymore

I think we'll have a DC up through SILGen, but you do have me worried about optimizations. Unfortunately we don't actually the right API for that ("AvailabilityContext"); fortunately, it'll err on the side of "non-exhaustive". (That is, passing nullptr or the containing module or the containing source file might answer "non-exhaustive" when it could be "exhaustive", but never the other way around.)

slavapestov · Mar 20, 2018

Sign in to view

+void AttributeChecker::visitFrozenAttr(FrozenAttr *attr) {
+  switch (D->getModuleContext()->getResilienceStrategy()) {
+  case ResilienceStrategy::Default:
+    // FIXME: Don't warn about the use of this attribute in the standard


You might be able to get away with removing this now that resilience is on

Ah, yes, I forgot about this!

slavapestov · Mar 20, 2018

lib/Sema/TypeCheckSwitchStmt.cpp

@@ -121,25 +127,25 @@ namespace {
      // potentially push an enormous fixit on the user.
      static const size_t MAX_SPACE_SIZE = 128;

-      size_t computeSize(TypeChecker &TC,
+      size_t computeSize(TypeChecker &TC, const DeclContext *DC,


It's awkward to plumb the DC (and TC) through everything here -- can't we make them instance variables?

Sure, that makes sense. I'll save it for the next half, though, where I implement unknown:.

slavapestov · Mar 20, 2018

Sign in to view

@@ -1101,7 +1101,7 @@ public struct CodingUserInfoKey : RawRepresentable, Equatable, Hashable {
 //===----------------------------------------------------------------------===//

 /// An error that occurs during the encoding of a value.
-@_fixed_layout // FIXME(sil-serialize-all)
+@_frozen // FIXME(sil-serialize-all)


... it did in stdlib/public/Platform/POSIXError.swift

jrose-apple · Mar 20, 2018

We do have the "evolution" tests for non-frozen enums by testing private cases, but I'll add the ones for -enable-testing!

slavapestov · Mar 20, 2018

@jrose-apple The case I'm thinking of is when you switch over an @objc non-frozen enum, we want to make sure we don't hit UB if you pass in an unknown case

jrose-apple · Mar 20, 2018

Sorry, I forgot that one already landed. :-) See #14724.

jrose-apple · Mar 20, 2018

Addressed feedback.

@swift-ci Please smoke test

jrose-apple · Mar 21, 2018

Merging even though the proposal is still in review in order to get some living-on (and so that I don't have to keep rebasing it). Note that the diagnostics are still off and unknown is not yet implemented. (That's #14382, which I'm currently working on rebasing.)

jrose-apple force-pushed the jrose-apple:frozen-enums branch Mar 3, 2018

jrose-apple force-pushed the jrose-apple:frozen-enums branch Mar 5, 2018

jrose-apple force-pushed the jrose-apple:frozen-enums branch Mar 20, 2018

jrose-apple changed the title ~~[WIP] Implementation for SE-0192 (frozen and non-frozen enums)~~ Implementation for /most/ of SE-0192 (frozen and non-frozen enums) Mar 20, 2018

Add tests for -enable-testing silencing exhaustivity diagnostics

Loading status checks…

348f966

jrose-apple force-pushed the jrose-apple:frozen-enums branch to 348f966 Mar 20, 2018

jrose-apple merged commit d150f96 into apple:master Mar 21, 2018
2 checks passed

2 checks passed

Swift Test Linux Platform (smoke test)
Details

Swift Test OS X Platform (smoke test)
Details

jrose-apple deleted the jrose-apple:frozen-enums branch Mar 21, 2018

This was referenced Mar 21, 2018

Closed

[WIP] Implementation of non-exhaustive enums #11961

Merged

Fix test from 7e3aaff78d I forgot to update after 3cbabfd196 landed #15405

apple/swift

Join GitHub today

Implementation for /most/ of SE-0192 (frozen and non-frozen enums) #14945

Conversation

jrose-apple commented Mar 3, 2018

This comment has been minimized.

jrose-apple commented Mar 3, 2018

This comment has been minimized.

jrose-apple commented Mar 3, 2018

This comment has been minimized.

jrose-apple commented Mar 3, 2018

This comment has been minimized.

swift-ci commented Mar 3, 2018

This comment has been minimized.

swift-ci commented Mar 3, 2018

Build comment file:

Compilation-performance test failed

jrose-apple force-pushed the jrose-apple:frozen-enums branch Mar 3, 2018

This comment has been minimized.

jrose-apple commented Mar 3, 2018

This comment has been minimized.

jrose-apple commented Mar 3, 2018

This comment has been minimized.

jrose-apple commented Mar 3, 2018

This comment has been minimized.

swift-ci commented Mar 3, 2018

This comment has been minimized.

jrose-apple commented Mar 3, 2018

This comment has been minimized.

jrose-apple commented Mar 3, 2018

This comment has been minimized.

jrose-apple commented Mar 3, 2018

This comment has been minimized.

swift-ci commented Mar 3, 2018

This comment has been minimized.

swift-ci commented Mar 3, 2018

This comment has been minimized.

swift-ci commented Mar 3, 2018

Build comment file:

Compilation-performance test failed

jrose-apple force-pushed the jrose-apple:frozen-enums branch Mar 5, 2018

This comment has been minimized.

jrose-apple commented Mar 5, 2018

This comment has been minimized.

swift-ci commented Mar 5, 2018

This comment has been minimized.

swift-ci commented Mar 5, 2018

jrose-apple force-pushed the jrose-apple:frozen-enums branch Mar 5, 2018

This comment has been minimized.

jrose-apple commented Mar 5, 2018

This comment has been minimized.

swift-ci commented Mar 5, 2018

This comment has been minimized.

swift-ci commented Mar 5, 2018

This comment has been minimized.

jrose-apple commented Mar 5, 2018

This comment has been minimized.

swift-ci commented Mar 6, 2018

This comment has been minimized.

jrose-apple commented Mar 6, 2018

This comment has been minimized.

jrose-apple commented Mar 6, 2018

This comment has been minimized.

jrose-apple commented Mar 6, 2018

This comment has been minimized.

jrose-apple commented Mar 6, 2018

This comment has been minimized.

swift-ci commented Mar 6, 2018

Build comment file:

Summary for master smoketest

Debug

debug brief

debug detailed

Release

release brief

release detailed

jrose-apple added some commits Sep 14, 2017

jrose-apple force-pushed the jrose-apple:frozen-enums branch Mar 20, 2018

This comment has been minimized.

jrose-apple commented Mar 20, 2018

DougGregor approved these changes Mar 20, 2018

View changes

slavapestov reviewed Mar 20, 2018

View changes

jrose-apple force-pushed the jrose-apple:frozen-enums branch to `348f966` Mar 20, 2018

jrose-apple merged commit `d150f96` into apple:master Mar 21, 2018
2 checks passed