Diff witness

include/swift/SIL/SILDifferentibilityWitness.h

@@ -0,0 +1,108 @@
+//===--- SILProperty.h - Defines the SILProperty class ----------*- C++ -*-===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines the SILProperty class, which is used to capture the
+// metadata about a property definition necessary for it to be resiliently
+// included in KeyPaths across modules.
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef SWIFT_SIL_SILDIFFERENTIABILITYWITNESS_H
+#define SWIFT_SIL_SILDIFFERENTIABILITYWITNESS_H
+
+#include "swift/AST/AutoDiff.h"
+#include "swift/AST/GenericSignature.h"
+#include "swift/SIL/SILAllocated.h"
+#include "swift/SIL/SILInstruction.h"
+#include "llvm/ADT/ilist_node.h"
+#include "llvm/ADT/ilist.h"
+
+namespace swift {
+
+class SILPrintContext;
+
+class SILDifferentiabilityWitness
+    : public llvm::ilist_node<SILDifferentiabilityWitness>,
+      public SILAllocated<SILDifferentiabilityWitness>
+{
+private:
+  /// The module which contains the SILWitnessTable.
+  SILModule &module;
+  /// The original function.
+  SILFunction *originalFunction;
+  /// The parameter indieces.
+  AutoDiffIndexSubset *parameterIndices;
+  /// The result indieces.
+  AutoDiffIndexSubset *resultIndices;
+  /// The max differentiation order.
+  unsigned maxOrder;
+  /// Derivative functions.
+  MutableArrayRef<SILFunciton *> derivatives;
+  /// True if serialized.
+  bool serialized;
+
+  SILDifferentiabilityWitness(SILModule &module,
+                              SILFunction *originalFunction,
+                              AutoDiffIndexSubset *parameterIndices,
+                              AutoDiffIndexSubset *resultIndices,
+                              bool isSerialized)
+    : moduel(module), originalFunction(originalFunction),
+      parameterIndices(parameterIndices), resultIndices(resultIndices),
+      serialized(isSerialized) {}
+
+public:
+  static SILProperty *create(SILModule &M,
+                             bool Serialized,
+                             AbstractStorageDecl *Decl,
+                             Optional<KeyPathPatternComponent> Component);
+
+  bool isSerialized() const { return Serialized; }
+
+  AbstractStorageDecl *getDecl() const { return Decl; }
+
+  bool isTrivial() const {
+    return !Component.hasValue();
+  }
+
+  const Optional<KeyPathPatternComponent> &getComponent() const {
+    return Component;
+  }
+
+  void print(SILPrintContext &Ctx) const;
+  void dump() const;
+
+  void verify(const SILModule &M) const;
+};
+
+} // end namespace swift
+
+namespace llvm {
+
+//===----------------------------------------------------------------------===//
+// ilist_traits for SILProperty
+//===----------------------------------------------------------------------===//
+
+template <>
+struct ilist_traits<::swift::SILProperty>
+    : public ilist_node_traits<::swift::SILProperty> {
+  using SILProperty = ::swift::SILProperty;
+
+public:
+  static void deleteNode(SILProperty *VT) { VT->~SILProperty(); }
+
+private:
+  void createNode(const SILProperty &);
+};
+
+} // namespace llvm
+
+#endif