TensorFlow: annotate functions using _forEachFieldWithKeyPath (#1162)

Because the standard toolchain support requires the newest runtime in
order to have access to `_forEachFieldWithKeyPath` and the runtime is
bundled into the OS on macOS, we need to annotate the functions with
availability.

Author: compnerd

Sources/TensorFlow/Core/ElementaryFunctions.swift

@@ -13,12 +13,18 @@
 // limitations under the License.
 
 #if TENSORFLOW_USE_STANDARD_TOOLCHAIN
+
 import Numerics
 @_spi(Reflection) import Swift
+
 extension ElementaryFunctions {
   internal static func visitChildren(
     _ body: (PartialKeyPath<Self>, ElementaryFunctionsVisit.Type) -> Void
   ) {
+    guard #available(macOS 9999, *) else {
+      fatalError("\(#function) is unavailable")
+    }
+
     if !_forEachFieldWithKeyPath(
       of: Self.self,
       body: { name, kp in
@@ -164,4 +170,5 @@ extension ElementaryFunctions {
   public static func root(_ x: Self, _ n: Int) -> Self { .init(mapped: Functor_root(n: n), x) }
   public static func pow(_ x: Self, _ y: Self) -> Self { .init(mapped: Functor_pow2(), x, y) }
 }
+
 #endif

Sources/TensorFlow/Core/EuclideanDifferentiable.swift

@@ -15,9 +15,14 @@
 import _Differentiation
 
 #if TENSORFLOW_USE_STANDARD_TOOLCHAIN
+
 @_spi(Reflection) import Swift
 
 func listFields<Root>(of type: Root.Type) -> [(String, PartialKeyPath<Root>)] {
+  guard #available(macOS 9999, *) else {
+    fatalError("\(#function) is unavailable")
+  }
+
   var out = [(String, PartialKeyPath<Root>)]()
   _forEachFieldWithKeyPath(of: type, options: .ignoreUnknown) { name, kp in
     out.append((String(validatingUTF8: name)!, kp))
@@ -27,8 +32,11 @@ func listFields<Root>(of type: Root.Type) -> [(String, PartialKeyPath<Root>)] {
 }
 
 extension Differentiable {
-  static var differentiableFields: [(String, PartialKeyPath<Self>, PartialKeyPath<TangentVector>)]
-  {
+  static var differentiableFields: [(String, PartialKeyPath<Self>, PartialKeyPath<TangentVector>)] {
+    guard #available(macOS 9999, *) else {
+      fatalError("\(#function) is unavailable")
+    }
+
     let tangentFields = listFields(of: TangentVector.self)
     var i = 0
     var out = [(String, PartialKeyPath<Self>, PartialKeyPath<TangentVector>)]()

Sources/TensorFlow/Core/KeyPathIterable.swift

@@ -21,6 +21,7 @@
 import _Differentiation
 
 #if TENSORFLOW_USE_STANDARD_TOOLCHAIN
+
 @_spi(Reflection) import Swift
 
 /// An implementation detail of `KeyPathIterable`; do not use this protocol
@@ -42,6 +43,10 @@ public protocol KeyPathIterable: _KeyPathIterableBase {
 
 public extension KeyPathIterable {
   var allKeyPaths: [PartialKeyPath<Self>] {
+    guard #available(macOS 9999, *) else {
+      fatalError("\(#function) is unavailable")
+    }
+
     var out = [PartialKeyPath<Self>]()
     _forEachFieldWithKeyPath(of: Self.self, options: .ignoreUnknown) { name, kp in
       out.append(kp)
@@ -171,4 +176,5 @@ extension Optional.TangentVector: KeyPathIterable {
     return []
   }
 }
+
 #endif

Sources/TensorFlow/Core/PointwiseMultiplicative.swift

@@ -15,6 +15,7 @@
 import _Differentiation
 
 #if TENSORFLOW_USE_STANDARD_TOOLCHAIN
+
 @_spi(Reflection) import Swift
 
 infix operator .*: MultiplicationPrecedence
@@ -114,6 +115,10 @@ extension PointwiseMultiplicative {
   internal static func visitChildren(
     _ body: (PartialKeyPath<Self>, _PointwiseMultiplicative.Type) -> Void
   ) {
+    guard #available(macOS 9999, *) else {
+      fatalError("\(#function) is unavailable")
+    }
+
     if !_forEachFieldWithKeyPath(
       of: Self.self,
       body: { name, kp in
@@ -134,4 +139,5 @@ extension PointwiseMultiplicative {
 extension Array.DifferentiableView: _PointwiseMultiplicative
 where Element: Differentiable & PointwiseMultiplicative {}
 extension Tensor: _PointwiseMultiplicative where Scalar: Numeric {}
+
 #endif

Sources/TensorFlow/Core/TensorGroup.swift

@@ -340,9 +340,14 @@ extension Array: TensorArrayProtocol where Element: TensorGroup {
 }
 
 #if TENSORFLOW_USE_STANDARD_TOOLCHAIN
+
 @_spi(Reflection) import Swift
 
 func reflectionInit<T>(type: T.Type, body: (inout T, PartialKeyPath<T>) -> Void) -> T {
+  guard #available(macOS 9999, *) else {
+    fatalError("\(#function) is unavailable")
+  }
+
   let x = UnsafeMutablePointer<T>.allocate(capacity: 1)
   defer { x.deallocate() }
   if !_forEachFieldWithKeyPath(of: type, body: { name, kp in
@@ -356,6 +361,10 @@ func reflectionInit<T>(type: T.Type, body: (inout T, PartialKeyPath<T>) -> Void)
 
 extension TensorGroup {
   public static var _typeList: [TensorDataType] {
+    guard #available(macOS 9999, *) else {
+      fatalError("\(#function) is unavailable")
+    }
+
     var out = [TensorDataType]()
     if !(_forEachFieldWithKeyPath(of: Self.self) { name, kp in
       guard let valueType = type(of: kp).valueType as? TensorGroup.Type else { return false }
@@ -366,6 +375,7 @@ extension TensorGroup {
     }
     return out
   }
+
   public static func initialize<Root>(
     _ base: inout Root, _ kp: PartialKeyPath<Root>,
     _owning tensorHandles: UnsafePointer<CTensorHandle>?
@@ -377,6 +387,7 @@ extension TensorGroup {
       v.initialize(to: .init(_owning: tensorHandles))
     }
   }
+
   public init(_owning tensorHandles: UnsafePointer<CTensorHandle>?) {
     var i = 0
     self = reflectionInit(type: Self.self) { base, kp in
@@ -387,7 +398,12 @@ extension TensorGroup {
       i += Int(valueType._tensorHandleCount)
     }
   }
+
   public func _unpackTensorHandles(into address: UnsafeMutablePointer<CTensorHandle>?) {
+    guard #available(macOS 9999, *) else {
+      fatalError("\(#function) is unavailable")
+    }
+
     var i = 0
     if !_forEachFieldWithKeyPath(of: Self.self, body: { name, kp in
       guard let x = self[keyPath: kp] as? TensorGroup else { return false }
@@ -399,4 +415,5 @@ extension TensorGroup {
     }
   }
 }
+
 #endif

Sources/TensorFlow/Core/VectorProtocol.swift

@@ -15,6 +15,7 @@
 import _Differentiation
 
 #if TENSORFLOW_USE_STANDARD_TOOLCHAIN
+
 @_spi(Reflection) import Swift
 
 /// Implementation detail for reflection.
@@ -38,6 +39,10 @@ extension VectorProtocol {
   internal static func visitChildren(
     _ body: (PartialKeyPath<Self>, _VectorProtocol.Type) -> Void
   ) {
+    guard #available(macOS 9999, *) else {
+      fatalError("\(#function) is unavailable")
+    }
+
     if !_forEachFieldWithKeyPath(
       of: Self.self,
       body: { name, kp in
@@ -127,4 +132,5 @@ extension VectorProtocol {
 extension Tensor: _VectorProtocol where Scalar: TensorFlowFloatingPoint {}
 extension Array.DifferentiableView: _VectorProtocol
 where Element: Differentiable & VectorProtocol {}
+
 #endif