SIL: Add a SILFunction::Purpose for global init once functions

jckarter · jckarter · commit d82a767e1396 · 2020-08-25T17:06:09.000-07:00
diff --git a/include/swift/SIL/SILFunction.h b/include/swift/SIL/SILFunction.h
@@ -121,6 +121,7 @@ class SILFunction
   enum class Purpose : uint8_t {
     None,
     GlobalInit,
+    GlobalInitOnceFunction,
     LazyPropertyGetter
   };
 
@@ -832,6 +833,10 @@ class SILFunction
   /// function itself does not need this attribute. It is private and only
   /// called within the addressor.
   bool isGlobalInit() const { return specialPurpose == Purpose::GlobalInit; }
+    
+  bool isGlobalInitOnceFunction() const {
+    return specialPurpose == Purpose::GlobalInitOnceFunction;
+  }
 
   bool isLazyPropertyGetter() const {
     return specialPurpose == Purpose::LazyPropertyGetter;
diff --git a/lib/SIL/IR/SILPrinter.cpp b/lib/SIL/IR/SILPrinter.cpp
@@ -2606,6 +2606,9 @@ void SILFunction::print(SILPrintContext &PrintCtx) const {
   case SILFunction::Purpose::GlobalInit:
     OS << "[global_init] ";
     break;
+  case SILFunction::Purpose::GlobalInitOnceFunction:
+    OS << "[global_init_once_fn] ";
+    break;
   case SILFunction::Purpose::LazyPropertyGetter:
     OS << "[lazy_getter] ";
     break;
diff --git a/lib/SIL/Parser/ParseSIL.cpp b/lib/SIL/Parser/ParseSIL.cpp
@@ -961,6 +961,8 @@ static bool parseDeclSILOptional(bool *isTransparent,
       *specialPurpose = SILFunction::Purpose::GlobalInit;
     else if (specialPurpose && SP.P.Tok.getText() == "lazy_getter")
       *specialPurpose = SILFunction::Purpose::LazyPropertyGetter;
+    else if (specialPurpose && SP.P.Tok.getText() == "global_init_once_fn")
+      *specialPurpose = SILFunction::Purpose::GlobalInitOnceFunction;
     else if (isWeakImported && SP.P.Tok.getText() == "weak_imported") {
       if (M.getASTContext().LangOpts.Target.isOSBinFormatCOFF())
         SP.P.diagnose(SP.P.Tok, diag::attr_unsupported_on_target,
diff --git a/lib/SILGen/SILGen.cpp b/lib/SILGen/SILGen.cpp
@@ -1366,6 +1366,7 @@ SILFunction *SILGenModule::emitLazyGlobalInitializer(StringRef funcName,
   auto *f = builder.createFunction(
       SILLinkage::Private, funcName, initSILType, nullptr, SILLocation(binding),
       IsNotBare, IsNotTransparent, IsNotSerialized, IsNotDynamic);
+  f->setSpecialPurpose(SILFunction::Purpose::GlobalInitOnceFunction);
   f->setDebugScope(new (M) SILDebugScope(RegularLocation(binding), f));
   auto dc = binding->getDeclContext();
   SILGenFunction(*this, *f, dc).emitLazyGlobalInitializer(binding, pbdEntry);
diff --git a/lib/Serialization/ModuleFormat.h b/lib/Serialization/ModuleFormat.h
@@ -55,7 +55,7 @@ const uint16_t SWIFTMODULE_VERSION_MAJOR = 0;
 /// describe what change you made. The content of this comment isn't important;
 /// it just ensures a conflict if two people change the module format.
 /// Don't worry about adhering to the 80-column limit for this line.
-const uint16_t SWIFTMODULE_VERSION_MINOR = 574; // reapply isUserAccessible
+const uint16_t SWIFTMODULE_VERSION_MINOR = 575; // GlobalInitOnceFunction SILFunction purpose
 
 /// A standard hash seed used for all string hashes in a serialized module.
 ///
diff --git a/test/SILGen/default_arguments.swift b/test/SILGen/default_arguments.swift
@@ -156,7 +156,7 @@ class Foo {
     return x
   }
  
-  // CHECK-LABEL: sil private [ossa] @globalinit_33_E52D764B1F2009F2390B2B8DF62DAEB8_func0
+  // CHECK-LABEL: sil private [global_init_once_fn] [ossa] @globalinit_33_E52D764B1F2009F2390B2B8DF62DAEB8_func0
   // CHECK:         string_literal utf8 "Foo" 
   static let x = Foo(int:0)
 
diff --git a/test/SILGen/global_resilience.swift b/test/SILGen/global_resilience.swift
@@ -43,7 +43,7 @@ public var myEmptyGlobal = MyEmptyStruct()
 
 // Mutable addressor for fixed-layout global
 
-// CHECK-LABEL: sil private [ossa] @globalinit_{{.*}}_func1
+// CHECK-LABEL: sil private [global_init_once_fn] [ossa] @globalinit_{{.*}}_func1
 // CHECK:         alloc_global @$s17global_resilience19myFixedLayoutGlobalAA13MyEmptyStructVv
 // CHECK:         return
 
@@ -52,7 +52,7 @@ public var myEmptyGlobal = MyEmptyStruct()
 // CHECK:         global_addr @$s17global_resilience19myFixedLayoutGlobalAA13MyEmptyStructVv
 // CHECK:         return
 
-// CHECK-OPT-LABEL: sil private @globalinit_{{.*}}_func1
+// CHECK-OPT-LABEL: sil private [global_init_once_fn] @globalinit_{{.*}}_func1
 // CHECK-OPT:     alloc_global @$s17global_resilience19myFixedLayoutGlobalAA13MyEmptyStructVv
 // CHECK-OPT:     return
 
diff --git a/test/SILGen/lazy_globals.swift b/test/SILGen/lazy_globals.swift
@@ -1,6 +1,6 @@
 // RUN: %target-swift-emit-silgen -parse-as-library %s | %FileCheck %s
 
-// CHECK: sil private [ossa] @globalinit_[[T:.*]]_func0 : $@convention(c) () -> () {
+// CHECK: sil private [global_init_once_fn] [ossa] @globalinit_[[T:.*]]_func0 : $@convention(c) () -> () {
 // CHECK:   alloc_global @$s12lazy_globals1xSiv
 // CHECK:   [[XADDR:%.*]] = global_addr @$s12lazy_globals1xSivp : $*Int
 // CHECK:   store {{%.*}} to [trivial] [[XADDR]] : $*Int
@@ -16,7 +16,7 @@
 // CHECK: }
 var x: Int = 0
 
-// CHECK: sil private [ossa] @globalinit_[[T:.*]]_func1 : $@convention(c) () -> () {
+// CHECK: sil private [global_init_once_fn] [ossa] @globalinit_[[T:.*]]_func1 : $@convention(c) () -> () {
 // CHECK:   alloc_global @$s12lazy_globals3FooV3fooSivpZ
 // CHECK:   [[XADDR:%.*]] = global_addr @$s12lazy_globals3FooV3fooSivpZ : $*Int
 // CHECK:   store {{.*}} to [trivial] [[XADDR]] : $*Int
@@ -40,7 +40,7 @@ struct Foo {
   static var initialized: Int = 57
 }
 
-// CHECK: sil private [ossa] @globalinit_[[T:.*]]_func3 : $@convention(c) () -> () {
+// CHECK: sil private [global_init_once_fn] [ossa] @globalinit_[[T:.*]]_func3 : $@convention(c) () -> () {
 // CHECK:   alloc_global @$s12lazy_globals3BarO3barSivpZ
 // CHECK:   [[XADDR:%.*]] = global_addr @$s12lazy_globals3BarO3barSivpZ : $*Int
 // CHECK:   store {{.*}} to [trivial] [[XADDR]] : $*Int
@@ -63,7 +63,7 @@ enum Bar {
 
 func f() -> (Int, Int) { return (1, 2) }
 
-// CHECK: sil private [ossa] @globalinit_[[T]]_func4 : $@convention(c) () -> () {
+// CHECK: sil private [global_init_once_fn] [ossa] @globalinit_[[T]]_func4 : $@convention(c) () -> () {
 // CHECK:   function_ref @$s12lazy_globals1fSi_SityF : $@convention(thin) () -> (Int, Int)
 // CHECK: sil hidden [global_init] [ossa] @$s12lazy_globals2a1Sivau : $@convention(thin) () -> Builtin.RawPointer
 // CHECK:   function_ref @globalinit_[[T]]_func4 : $@convention(c) () -> ()
diff --git a/test/SILGen/lazy_globals_multiple_vars.swift b/test/SILGen/lazy_globals_multiple_vars.swift
@@ -1,6 +1,6 @@
 // RUN: %target-swift-emit-silgen -parse-as-library %s | %FileCheck %s
 
-// CHECK:       sil private [ossa] [[INIT_A_B:@globalinit_.*]] :
+// CHECK:       sil private [global_init_once_fn] [ossa] [[INIT_A_B:@globalinit_.*]] :
 // CHECK:         alloc_global @$s26lazy_globals_multiple_vars1aSiv
 // CHECK:         global_addr @$s26lazy_globals_multiple_vars1aSiv
 // CHECK:         alloc_global @$s26lazy_globals_multiple_vars1bSiv
@@ -13,15 +13,15 @@
 // CHECK:         function_ref [[INIT_A_B]]
 var (a, b) = (1, 2)
 
-// CHECK:       sil private [ossa] [[INIT_C:@globalinit_.*]] :
+// CHECK:       sil private [global_init_once_fn] [ossa] [[INIT_C:@globalinit_.*]] :
 // CHECK-NOT:     global_addr @$s26lazy_globals_multiple_vars1dSiv
 // CHECK:         alloc_global @$s26lazy_globals_multiple_vars1cSiv
 // CHECK:         global_addr @$s26lazy_globals_multiple_vars1cSiv
 // CHECK-NOT:     global_addr @$s26lazy_globals_multiple_vars1dSiv
 // CHECK:       sil hidden [global_init] [ossa] @$s26lazy_globals_multiple_vars1cSivau
 // CHECK:         global_addr [[TOKEN_C:@globalinit_.*]] :
 // CHECK:         function_ref [[INIT_C]]
-// CHECK:       sil private [ossa] [[INIT_D:@globalinit_.*]] :
+// CHECK:       sil private [global_init_once_fn] [ossa] [[INIT_D:@globalinit_.*]] :
 // CHECK-NOT:     global_addr @$s26lazy_globals_multiple_vars1cSiv
 // CHECK:         alloc_global @$s26lazy_globals_multiple_vars1dSiv
 // CHECK:         global_addr @$s26lazy_globals_multiple_vars1dSiv
diff --git a/test/SILGen/observers.swift b/test/SILGen/observers.swift
@@ -171,7 +171,7 @@ public struct DidSetWillSetTests {
 
 var global_observing_property : Int = zero {
   // The variable is initialized with "zero".
-  // CHECK-LABEL: sil private [ossa] @globalinit_{{.*}}_func1 : $@convention(c) () -> () {
+  // CHECK-LABEL: sil private [global_init_once_fn] [ossa] @globalinit_{{.*}}_func1 : $@convention(c) () -> () {
   // CHECK: bb0:
   // CHECK-NEXT: alloc_global @$s9observers25global_observing_propertySiv
   // CHECK-NEXT: %1 = global_addr @$s9observers25global_observing_propertySivp : $*Int
diff --git a/test/SILOptimizer/access_marker_verify.swift b/test/SILOptimizer/access_marker_verify.swift
@@ -627,7 +627,7 @@ func testShims() -> UInt32 {
 
 // --- global variable initialization.
 var globalString1 = "⓪" // start non-empty
-// CHECK-LABEL: sil private [ossa] @globalinit_33_{{.*}}_func0 : $@convention(c) () -> () {
+// CHECK-LABEL: sil private [global_init_once_fn] [ossa] @globalinit_33_{{.*}}_func0 : $@convention(c) () -> () {
 // CHECK: alloc_global @$s20access_marker_verify13globalString1SSvp
 // CHECK: [[GA:%.*]] = global_addr @$s20access_marker_verify13globalString1SSvp : $*String
 // CHECK: apply
@@ -637,7 +637,7 @@ var globalString1 = "⓪" // start non-empty
 // CHECK-LABEL: } // end sil function 'globalinit_33_180BF7B9126DB0C8C6C26F15ACD01908_func0'
 
 var globalString2 = globalString1
-// CHECK-LABEL: sil private [ossa] @globalinit_33_180BF7B9126DB0C8C6C26F15ACD01908_func1 : $@convention(c) () -> () {
+// CHECK-LABEL: sil private [global_init_once_fn] [ossa] @globalinit_33_180BF7B9126DB0C8C6C26F15ACD01908_func1 : $@convention(c) () -> () {
 // CHECK: alloc_global @$s20access_marker_verify13globalString2SSvp
 // CHECK: [[GA:%.*]] = global_addr @$s20access_marker_verify13globalString2SSvp : $*String
 // CHECK: apply
@@ -1037,7 +1037,7 @@ func testPointerInit(x: Int, y: UnsafeMutablePointer<Int>) {
 class testInitExistentialGlobal {
   static var testProperty: P = StructP()
 }
-// CHECK-LABEL: sil private [ossa] @globalinit{{.*}} : $@convention(c) () -> () {
+// CHECK-LABEL: sil private [global_init_once_fn] [ossa] @globalinit{{.*}} : $@convention(c) () -> () {
 // CHECK:   alloc_global @$s20access_marker_verify25testInitExistentialGlobalC0D8PropertyAA1P_pvpZ
 // CHECK:   [[GADR:%.*]] = global_addr @$s20access_marker_verify25testInitExistentialGlobalC0D8PropertyAA1P_pvpZ : $*P
 // CHECK:   %{{.*}} = apply %{{.*}}({{.*}}) : $@convention(method) (@thin StructP.Type) -> StructP

Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,7 @@ class Foo {`
`156`	`156`	`return x`
`157`	`157`	`}`
`158`	`158`
`159`		`- // CHECK-LABEL: sil private [ossa] @globalinit_33_E52D764B1F2009F2390B2B8DF62DAEB8_func0`
	`159`	`+ // CHECK-LABEL: sil private [global_init_once_fn] [ossa] @globalinit_33_E52D764B1F2009F2390B2B8DF62DAEB8_func0`
`160`	`160`	`// CHECK: string_literal utf8 "Foo"`
`161`	`161`	`static let x = Foo(int:0)`
`162`	`162`