[stdlib]String normalization functions (#21026) (#21744)

* [stdlib]String normalization functions (#21026)

* fast/foreignNormalize functions

* fix bad cherry-pick

Author: Lance Parker

benchmark/single-source/StringComparison.swift

@@ -30,8 +30,6 @@ extension String {
 }
 
 
-
-
 public let StringComparison: [BenchmarkInfo] = [
   BenchmarkInfo(
     name: "StringComparison_ascii",
@@ -140,52 +138,52 @@ public let StringHashing: [BenchmarkInfo] = [
   ),
 ]
 
-public let NormalizedIterator: [BenchmarkInfo] = [
+public let StringNormalization: [BenchmarkInfo] = [
   BenchmarkInfo(
     name: "NormalizedIterator_ascii",
-    runFunction: run_NormalizedIterator_ascii,
+    runFunction: run_StringNormalization_ascii,
     tags: [.validation, .String],
     setUpFunction: { blackHole(Workload_ascii) }
   ),
   BenchmarkInfo(
     name: "NormalizedIterator_latin1",
-    runFunction: run_NormalizedIterator_latin1,
+    runFunction: run_StringNormalization_latin1,
     tags: [.validation, .String],
     setUpFunction: { blackHole(Workload_latin1) }
   ),
   BenchmarkInfo(
     name: "NormalizedIterator_fastPrenormal",
-    runFunction: run_NormalizedIterator_fastPrenormal,
+    runFunction: run_StringNormalization_fastPrenormal,
     tags: [.validation, .String],
     setUpFunction: { blackHole(Workload_fastPrenormal) }
   ),
   BenchmarkInfo(
     name: "NormalizedIterator_slowerPrenormal",
-    runFunction: run_NormalizedIterator_slowerPrenormal,
+    runFunction: run_StringNormalization_slowerPrenormal,
     tags: [.validation, .String],
     setUpFunction: { blackHole(Workload_slowerPrenormal) }
   ),
   BenchmarkInfo(
     name: "NormalizedIterator_nonBMPSlowestPrenormal",
-    runFunction: run_NormalizedIterator_nonBMPSlowestPrenormal,
+    runFunction: run_StringNormalization_nonBMPSlowestPrenormal,
     tags: [.validation, .String],
     setUpFunction: { blackHole(Workload_nonBMPSlowestPrenormal) }
   ),
   BenchmarkInfo(
     name: "NormalizedIterator_emoji",
-    runFunction: run_NormalizedIterator_emoji,
+    runFunction: run_StringNormalization_emoji,
     tags: [.validation, .String],
     setUpFunction: { blackHole(Workload_emoji) }
   ),
   BenchmarkInfo(
     name: "NormalizedIterator_abnormal",
-    runFunction: run_NormalizedIterator_abnormal,
+    runFunction: run_StringNormalization_abnormal,
     tags: [.validation, .String],
     setUpFunction: { blackHole(Workload_abnormal) }
   ),
   BenchmarkInfo(
     name: "NormalizedIterator_zalgo",
-    runFunction: run_NormalizedIterator_zalgo,
+    runFunction: run_StringNormalization_zalgo,
     tags: [.validation, .String],
     setUpFunction: { blackHole(Workload_zalgo) }
   ),
@@ -435,7 +433,7 @@ public func run_StringHashing_zalgo(_ N: Int) {
 
 
 @inline(never)
-public func run_NormalizedIterator_ascii(_ N: Int) {
+public func run_StringNormalization_ascii(_ N: Int) {
   let workload: Workload = Workload.ascii
   let tripCount = workload.tripCount
   let payload = workload.payload
@@ -449,7 +447,7 @@ public func run_NormalizedIterator_ascii(_ N: Int) {
 }
 
 @inline(never)
-public func run_NormalizedIterator_latin1(_ N: Int) {
+public func run_StringNormalization_latin1(_ N: Int) {
   let workload: Workload = Workload.latin1
   let tripCount = workload.tripCount
   let payload = workload.payload
@@ -463,7 +461,7 @@ public func run_NormalizedIterator_latin1(_ N: Int) {
 }
 
 @inline(never)
-public func run_NormalizedIterator_fastPrenormal(_ N: Int) {
+public func run_StringNormalization_fastPrenormal(_ N: Int) {
   let workload: Workload = Workload.fastPrenormal
   let tripCount = workload.tripCount
   let payload = workload.payload
@@ -477,7 +475,7 @@ public func run_NormalizedIterator_fastPrenormal(_ N: Int) {
 }
 
 @inline(never)
-public func run_NormalizedIterator_slowerPrenormal(_ N: Int) {
+public func run_StringNormalization_slowerPrenormal(_ N: Int) {
   let workload: Workload = Workload.slowerPrenormal
   let tripCount = workload.tripCount
   let payload = workload.payload
@@ -491,7 +489,7 @@ public func run_NormalizedIterator_slowerPrenormal(_ N: Int) {
 }
 
 @inline(never)
-public func run_NormalizedIterator_nonBMPSlowestPrenormal(_ N: Int) {
+public func run_StringNormalization_nonBMPSlowestPrenormal(_ N: Int) {
   let workload: Workload = Workload.nonBMPSlowestPrenormal
   let tripCount = workload.tripCount
   let payload = workload.payload
@@ -505,7 +503,7 @@ public func run_NormalizedIterator_nonBMPSlowestPrenormal(_ N: Int) {
 }
 
 @inline(never)
-public func run_NormalizedIterator_emoji(_ N: Int) {
+public func run_StringNormalization_emoji(_ N: Int) {
   let workload: Workload = Workload.emoji
   let tripCount = workload.tripCount
   let payload = workload.payload
@@ -519,7 +517,7 @@ public func run_NormalizedIterator_emoji(_ N: Int) {
 }
 
 @inline(never)
-public func run_NormalizedIterator_abnormal(_ N: Int) {
+public func run_StringNormalization_abnormal(_ N: Int) {
   let workload: Workload = Workload.abnormal
   let tripCount = workload.tripCount
   let payload = workload.payload
@@ -533,7 +531,7 @@ public func run_NormalizedIterator_abnormal(_ N: Int) {
 }
 
 @inline(never)
-public func run_NormalizedIterator_zalgo(_ N: Int) {
+public func run_StringNormalization_zalgo(_ N: Int) {
   let workload: Workload = Workload.zalgo
   let tripCount = workload.tripCount
   let payload = workload.payload
@@ -547,6 +545,7 @@ public func run_NormalizedIterator_zalgo(_ N: Int) {
 }
 
 
+
 struct Workload {
   static let N = 100
 

benchmark/single-source/StringComparison.swift.gyb

@@ -30,12 +30,14 @@ extension String {
   }
 }
 
-% AllWorkloads = ["ascii", "latin1", "fastPrenormal", "slowerPrenormal", "nonBMPSlowestPrenormal", "emoji", "abnormal", "zalgo", "longSharedPrefix"]
-% ComparisonWorkloads = AllWorkloads
-% HashingWorkloads = ["ascii", "latin1", "fastPrenormal", "slowerPrenormal", "nonBMPSlowestPrenormal", "emoji", "abnormal", "zalgo"]
-
-
-% NormalizedIteratorWorkloads = ["ascii", "latin1", "fastPrenormal", "slowerPrenormal", "nonBMPSlowestPrenormal", "emoji", "abnormal", "zalgo"]
+%{
+AllWorkloads = ["ascii", "latin1", "fastPrenormal", "slowerPrenormal",
+                "nonBMPSlowestPrenormal", "emoji", "abnormal", "zalgo",
+                "longSharedPrefix"]
+ComparisonWorkloads = AllWorkloads
+HashingWorkloads = AllWorkloads[:-1]
+NormalizationWorkloads = AllWorkloads[:-1]
+}%
 
 public let StringComparison: [BenchmarkInfo] = [
 % for Name in ComparisonWorkloads:
@@ -59,15 +61,15 @@ public let StringHashing: [BenchmarkInfo] = [
 % end # HashingWorkloads
 ]
 
-public let NormalizedIterator: [BenchmarkInfo] = [
-% for Name in NormalizedIteratorWorkloads:
+public let StringNormalization: [BenchmarkInfo] = [
+% for Name in NormalizationWorkloads:
   BenchmarkInfo(
     name: "NormalizedIterator_${Name}",
-    runFunction: run_NormalizedIterator_${Name},
+    runFunction: run_StringNormalization_${Name},
     tags: [.validation, .String],
     setUpFunction: { blackHole(Workload_${Name}) }
   ),
-% end # NormalizedIteratorWorkloads
+% end # NormalizationWorkloads
 ]
 
 % for Name in AllWorkloads:
@@ -107,9 +109,9 @@ public func run_StringHashing_${Name}(_ N: Int) {
 
 % end # HashingWorkloads
 
-%for Name in NormalizedIteratorWorkloads:
+%for Name in NormalizationWorkloads:
 @inline(never)
-public func run_NormalizedIterator_${Name}(_ N: Int) {
+public func run_StringNormalization_${Name}(_ N: Int) {
   let workload: Workload = Workload.${Name}
   let tripCount = workload.tripCount
   let payload = workload.payload
@@ -122,7 +124,8 @@ public func run_NormalizedIterator_${Name}(_ N: Int) {
   }
 }
 
-% end # NormalizedIteratorWorkloads
+% end # NormalizationWorkloads
+
 
 struct Workload {
   static let N = 100

benchmark/utils/main.swift

@@ -266,7 +266,6 @@ registerBenchmark(NSErrorTest)
 registerBenchmark(NSStringConversion)
 registerBenchmark(NibbleSort)
 registerBenchmark(NopDeinit)
-registerBenchmark(NormalizedIterator)
 registerBenchmark(ObjectAllocation)
 #if os(macOS) || os(iOS) || os(watchOS) || os(tvOS)
 registerBenchmark(ObjectiveCBridging)
@@ -328,6 +327,7 @@ registerBenchmark(StringInterpolation)
 registerBenchmark(StringInterpolationSmall)
 registerBenchmark(StringInterpolationManySmallSegments)
 registerBenchmark(StringMatch)
+registerBenchmark(StringNormalization)
 registerBenchmark(StringRemoveDupes)
 registerBenchmark(StringTests)
 registerBenchmark(StringWalk)

stdlib/public/core/CMakeLists.txt

@@ -101,7 +101,6 @@ set(SWIFTLIB_ESSENTIAL
   NativeDictionary.swift
   NativeSet.swift
   NewtypeWrapper.swift
-  NormalizedCodeUnitIterator.swift
   ObjectIdentifier.swift
   Optional.swift
   OptionSet.swift