---

yaml
---
r: 340947
b: refs/heads/rxwei-patch-1
c: c834a27
h: refs/heads/master
i:
  340945: df0f190
  340943: 97af6d8

Author: pschuh

[refs]

@@ -1015,7 +1015,7 @@ refs/tags/swift-DEVELOPMENT-SNAPSHOT-2018-08-18-a: b10b1fce14385faa6d44f6b933e95
 refs/heads/rdar-43033749-fix-batch-mode-no-diags-swift-5.0-branch: a14e64eaad30de89f0f5f0b2a782eed7ecdcb255
 refs/heads/revert-19006-error-bridging-integer-type: 8a9065a3696535305ea53fe9b71f91cbe6702019
 refs/heads/revert-19050-revert-19006-error-bridging-integer-type: ecf752d54b05dd0a20f510f0bfa54a3fec3bcaca
-refs/heads/rxwei-patch-1: bcdd46cdfe5348bc4c65ed964de8acf794be1cf4
+refs/heads/rxwei-patch-1: c834a27076ab8b12a054ff43a6f8d98006eed533
 refs/heads/shahmishal-patch-1: e58ec0f7488258d42bef51bc3e6d7b3dc74d7b2a
 refs/heads/typelist-existential: 4046359efd541fb5c72d69a92eefc0a784df8f5e
 refs/tags/swift-4.2-DEVELOPMENT-SNAPSHOT-2018-08-20-a: 4319ba09e4fb8650ee86061075c74a016b6baab9

branches/rxwei-patch-1/.gitignore

@@ -18,6 +18,7 @@
 # vim swap files
 .*.sw[a-z]
 .sw?
+*.vscode
 
 #==============================================================================#
 # Explicit files to ignore (only matches one).

branches/rxwei-patch-1/CMakeLists.txt

@@ -61,6 +61,10 @@ option(SWIFT_BUILD_STATIC_SDK_OVERLAY
     "Build static variants of the Swift SDK overlay"
     FALSE)
 
+option(SWIFT_ENABLE_TENSORFLOW
+    "Enable TensorFlow in the compiler and build the Swift TensorFlow library"
+    FALSE)
+
 # In many cases, the CMake build system needs to determine whether to include
 # a directory, or perform other actions, based on whether the stdlib or SDK is
 # being built at all -- statically or dynamically. Please note that these
@@ -342,6 +346,19 @@ option(SWIFT_REPORT_STATISTICS
     "Create json files which contain internal compilation statistics"
     FALSE)
 
+#
+# User-configurable TensorFlow specific options.
+#
+set(SWIFT_TENSORFLOW_HOST_LIB_DIR "" CACHE PATH
+    "If set, directory with TensorFlow host libraries to be linked into swiftc.")
+set(SWIFT_TENSORFLOW_TARGET_LIB_DIR "" CACHE PATH
+    "If set, directory with TensorFlow target libraries to be linked into swift programs.")
+
+set(SWIFT_TENSORFLOW_HOST_INCLUDE_DIR "" CACHE PATH
+    "If set, directory with host TensorFlow headers.")
+set(SWIFT_TENSORFLOW_TARGET_INCLUDE_DIR "" CACHE PATH
+    "If set, directory with target TensorFlow headers.")
+
 #
 # User-configurable experimental options.  Do not use in production builds.
 #
@@ -1054,6 +1071,11 @@ if(SWIFT_NEED_EXPLICIT_LIBDISPATCH)
                         ${SWIFT_PATH_TO_LIBDISPATCH_SOURCE})
 endif()
 
+# Enable TensorFlow in compiler code.
+if(SWIFT_ENABLE_TENSORFLOW)
+  add_definitions(-DSWIFT_ENABLE_TENSORFLOW)
+endif()
+
 # Add all of the subdirectories, where we actually do work.
 
 ###############

branches/rxwei-patch-1/CONTRIBUTING.md

@@ -5,7 +5,23 @@ license](https://swift.org/LICENSE.txt).
 
 ---
 
-Before submitting the pull request, please make sure you have [tested your
-changes](https://github.com/apple/swift/blob/master/docs/ContinuousIntegration.md)
-and that they follow the Swift project [guidelines for contributing
-code](https://swift.org/contributing/#contributing-code).
+Before submitting a pull request, please make sure that your changes follow the
+[Swift project guidelines for contributing code](https://swift.org/contributing/#contributing-code).
+
+We request that code changes unrelated to Swift for TensorFlow be submitted to
+the [upstream Swift repository](https://github.com/apple/swift). For example,
+code formatting changes that do not affect Swift for TensorFlow source code
+should be submitted upstream.
+
+It is a good idea to discuss any non-trivial submissions with the project
+maintainers before submitting a pull request: please join the
+[[email protected]](https://groups.google.com/a/tensorflow.org/d/forum/swift)
+mailing list to participate in discussions.
+
+All changes to existing Swift source code should be marked clearly with a
+`SWIFT_ENABLE_TENSORFLOW` comment at the top of every diff hunk. This makes
+it easier to merge from upstream.
+
+Continuous integration (CI) is still being set up, so if you submit a pull
+request with non-trivial changes that require test coverage, please anticipate
+some delay before we can properly review and merge it.

branches/rxwei-patch-1/README.md

@@ -668,6 +668,9 @@ endfunction()
 #     [SWIFT_COMPILE_FLAGS flag1...]
 #     [LINK_FLAGS flag1...]
 #     [FILE_DEPENDS target1 ...]
+# SWIFT_ENABLE_TENSORFLOW
+#     [EXTRA_RPATHS rpath1 ...]
+# END SWIFT_ENABLE_TENSORFLOW
 #     [DONT_EMBED_BITCODE]
 #     [IS_STDLIB]
 #     [FORCE_BUILD_OPTIMIZED]
@@ -724,6 +727,11 @@ endfunction()
 # FILE_DEPENDS
 #   Additional files this library depends on.
 #
+# SWIFT_ENABLE_TENSORFLOW
+# EXTRA_RPATHS
+#   List of directories to add to this library's RPATH.
+# END SWIFT_ENABLE_TENSORFLOW
+#
 # DONT_EMBED_BITCODE
 #   Don't embed LLVM bitcode in this target, even if it is enabled globally.
 #
@@ -768,6 +776,9 @@ function(_add_swift_library_single target name)
         C_COMPILE_FLAGS
         DEPENDS
         FILE_DEPENDS
+        # SWIFT_ENABLE_TENSORFLOW
+        EXTRA_RPATHS
+        # END SWIFT_ENABLE_TENSORFLOW
         FRAMEWORK_DEPENDS
         FRAMEWORK_DEPENDS_WEAK
         GYB_SOURCES
@@ -1102,6 +1113,28 @@ function(_add_swift_library_single target name)
     set_target_properties("${target}" PROPERTIES NO_SONAME TRUE)
   endif()
 
+  # SWIFT_ENABLE_TENSORFLOW
+  # Hande extra RPATHs.
+  set(local_rpath "")
+  if("${SWIFTLIB_SINGLE_SDK}" STREQUAL "LINUX" AND NOT "${SWIFTLIB_SINGLE_SDK}" STREQUAL "ANDROID")
+    set(local_rpath "$ORIGIN:/usr/lib/swift/linux")
+  elseif("${SWIFTLIB_SINGLE_SDK}" STREQUAL "CYGWIN")
+    set(local_rpath "$ORIGIN:/usr/lib/swift/cygwin")
+  endif()
+  foreach(rpath_element ${SWIFTLIB_SINGLE_EXTRA_RPATHS})
+    if("${local_rpath}" STREQUAL "")
+      set(local_rpath "${rpath_element}")
+    else()
+      set(local_rpath "${local_rpath}:${rpath_element}")
+    endif()
+  endforeach()
+  if(NOT "${local_rpath}" STREQUAL "")
+    set_target_properties("${target}"
+      PROPERTIES
+      INSTALL_RPATH "${local_rpath}")
+  endif()
+  # END SWIFT_ENABLE_TENSORFLOW
+
   set_target_properties("${target}" PROPERTIES BUILD_WITH_INSTALL_RPATH YES)
   set_target_properties("${target}" PROPERTIES FOLDER "Swift libraries")
 
@@ -2305,6 +2338,18 @@ function(_add_swift_executable_single name)
         "-Xlinker" "@executable_path/../lib/swift/${SWIFT_SDK_${SWIFTEXE_SINGLE_SDK}_LIB_SUBDIR}")
   endif()
 
+  # SWIFT_ENABLE_TENSORFLOW
+  set(swift_relative_library_path "../lib/swift/${SWIFT_SDK_${SWIFTEXE_SINGLE_SDK}_LIB_SUBDIR}")
+  is_darwin_based_sdk("${SWIFTEXE_SINGLE_SDK}" IS_DARWIN)
+  # NOTE: Adding "${SWIFTLIB_DIR}/.." to the rpath was necessary to fix linker
+  # errors for Syntax/Parser tests on Linux.
+  if("${SWIFTEXE_SINGLE_SDK}" STREQUAL "LINUX" AND NOT "${SWIFTEXE_SINGLE_SDK}" STREQUAL "ANDROID")
+    set(local_rpath "$ORIGIN:$ORIGIN/${swift_relative_library_path}:${SWIFTLIB_DIR}/..:/usr/lib/swift/linux")
+  elseif("${SWIFTEXE_SINGLE_SDK}" STREQUAL "CYGWIN")
+    set(local_rpath "$ORIGIN:$ORIGIN/${swift_relative_library_path}:${SWIFTLIB_DIR}/..:/usr/lib/swift/cygwin")
+  endif()
+  # END SWIFT_ENABLE_TENSORFLOW
+
   _list_add_string_suffix(
       "${SWIFTEXE_SINGLE_LINK_LIBRARIES}"
       "-${SWIFT_SDK_${SWIFTEXE_SINGLE_SDK}_LIB_SUBDIR}-${SWIFTEXE_SINGLE_ARCHITECTURE}"
@@ -2372,6 +2417,13 @@ function(_add_swift_executable_single name)
   endif()
 
   set_target_properties(${name} PROPERTIES FOLDER "Swift executables")
+
+  # SWIFT_ENABLE_TENSORFLOW
+  if(NOT "${local_rpath}" STREQUAL "")
+    set_target_properties("${name}" PROPERTIES INSTALL_RPATH "${local_rpath}")
+  endif()
+  set_target_properties("${name}" PROPERTIES BUILD_WITH_INSTALL_RPATH YES)
+  # END SWIFT_ENABLE_TENSORFLOW
 endfunction()
 
 macro(add_swift_tool_subdirectory name)

branches/rxwei-patch-1/cmake/modules/AddSwift.cmake

@@ -0,0 +1,23 @@
+# SWIFT_ENABLE_TENSORFLOW
+# Find TensorFlow.
+
+include(FindPackageHandleStandardArgs)
+
+find_path(TF_INCLUDE_DIR
+  NAMES third_party/tensorflow/c tensorflow/c
+  HINTS ${SWIFT_TENSORFLOW_TARGET_INCLUDE_DIR} /usr/include /usr/local/include)
+if (EXISTS ${TF_INCLUDE_DIR}/third_party/tensorflow/c/c_api.h)
+  # This is experimental and not covered by CI.
+  set(TF_PATH_ADJUSTMENT "third_party")
+else()
+  # Note: This is the normal workflow.
+  set(TF_PATH_ADJUSTMENT "")
+endif()
+
+find_library(TF_LIBRARY
+  NAMES tensorflow
+  HINTS ${SWIFT_TENSORFLOW_TARGET_LIB_DIR} /usr/lib /usr/local/lib)
+set(TF_LIBRARIES ${TF_LIBRARY})
+
+find_package_handle_standard_args(TensorFlow DEFAULT_MSG TF_INCLUDE_DIR TF_LIBRARIES)
+mark_as_advanced(${TF_INCLUDE_DIR} ${TF_LIBRARIES})

branches/rxwei-patch-1/cmake/modules/FindTensorFlow.cmake

@@ -228,7 +228,16 @@ function(_compile_swift_files
 
   # The standard library and overlays are always built resiliently.
   if(SWIFTFILE_IS_STDLIB)
-    list(APPEND swift_flags "-enable-library-evolution")
+    # SWIFT_ENABLE_TENSORFLOW
+    # FIXME(TF-328): Resilience is currently disabled for the TensorFlow module
+    # because it causes compilation to crash during IRGen.
+    # Also, disable resilience for DifferentiationUnittest because resilience
+    # changes generated AD code, leading to additional leaks.
+    if(NOT "${SWIFTFILE_MODULE_NAME}" STREQUAL "TensorFlow" AND
+       NOT "${SWIFTFILE_MODULE_NAME}" STREQUAL "DifferentiationUnittest")
+      list(APPEND swift_flags "-enable-library-evolution")
+      list(APPEND swift_flags "-Xfrontend" "-enable-resilience")
+    endif()
   endif()
 
   if(SWIFT_STDLIB_USE_NONATOMIC_RC)

branches/rxwei-patch-1/cmake/modules/SwiftSource.cmake

@@ -25,7 +25,21 @@ This page is designed to assist in the understanding of proper practices for tes
 
 In order for the Swift project to be able to advance quickly, it is important that we maintain a green build [[1]](#footnote-1). In order to help maintain this green build, the Swift project heavily uses pull request (PR) testing. Specifically, an important general rule is that **all** non-trivial checkins to any Swift Project repository should at least perform a [smoke test](#smoke-testing) if simulators will not be impacted *or* a full [validation test](#validation-testing) if simulators may be impacted. If in addition one is attempting to make a source breaking change across multiple repositories, one should follow the cross repo source breaking changes workflow. We now continue by describing the Swift system for Pull Request testing, @swift-ci:
 
-### @swift-ci
+### @swift-ci (Swift for TensorFlow)
+
+
+Platform     | Comment
+------------ | -------
+All supported platforms     | @swift-ci Please test tensorflow
+All supported platforms     | @swift-ci Please clean test tensorflow
+Linux                       | @swift-ci Please test tensorflow Linux
+Linux GPU                   | @swift-ci Please test tensorflow Linux GPU
+macOS                       | @swift-ci Please test tensorflow macOS
+
+Status can be checked at https://ci-external.swift.org/view/Pull%20Request/.
+
+
+### @swift-ci (general Swift)
 
 Users with [commit access](https://swift.org/contributing/#commit-access) can trigger pull request testing by writing a comment on a PR addressed to the GitHub user @swift-ci. Different tests will run depending on the specific comment used. The current test types are:
 

branches/rxwei-patch-1/docs/ContinuousIntegration.md

@@ -5552,6 +5552,77 @@ destination (if it returns with ``throw``).
 
 The rules on generic substitutions are identical to those of ``apply``.
 
+.. SWIFT_ENABLE_TENSORFLOW
+
+Automatic Differentiation
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+autodiff_function
+`````````````````
+
+::
+
+  sil-instruction ::= 'autodiff_function'
+                      sil-autodiff-function-parameter-indices?
+                      sil-autodiff-function-order?
+                      sil-value ':' sil-type
+                      sil-autodiff-associated-functions-clause?
+                      
+  sil-autodiff-function-parameter-indices ::= '[' 'wrt' [0-9]+ (',', [0-9]+)* ']'
+  sil-autodiff-function-differentiation-order ::= '[' 'order' [0-9]+ ']'
+  sil-autodiff-associated-functions-clause ::= 'with' sil-autodiff-associated-function-list
+                                               (',' sil-autodiff-associated-function-list)*
+  sil-autodiff-associated-function-list ::= '{' sil-value ',' sil-value '}'
+
+
+  autodiff_function [wrt 0] [order 1] %0 : $(T) -> T \
+    with {%1 : $(T) -> (T) -> T, %2 : $(T) -> (T) -> T}
+
+Bundles a function with its associated differentiation functions up to a
+specified differentiation order into an ``@differentiable`` function. There are
+2 associated functions per differentiation order: a Jacobian-vector products
+(JVP) function and a vector-Jacobian products (VJP) function.
+
+``[wrt ...]`` specifies parameter indices that the original function is
+differentiable with respect to. When not specified, it defaults to all
+parameters.
+
+``[order ...]`` specifies the maximum differentiation order for the resulting
+function. The number of lists of associated functions is equal to the order.
+
+A ``with`` clause specifies the differentiation functions associated
+with the original function. When a ``with`` clause is not specified, the first
+operand will be differentiated to produce associated functions, and a ``with``
+clause will be added to the instruction.
+
+In raw SIL, it is optional to provide a ``with`` clause. In canonical SIL, a
+``with`` clause is mandatory.
+
+
+autodiff_function_extract
+`````````````````````````
+
+::
+
+  sil-instruction ::= 'autodiff_function_extract'
+                      sil-autodiff-associated-function-kind
+                      sil-autodiff-function-order
+                      sil-value ':' sil-type
+
+  sil-autodiff-function-extractee ::= '[' sil-autodiff-function-extractee ']'
+  sil-autodiff-function-extractee-name ::= 'original' | 'jvp' | 'vjp'
+  sil-autodiff-function-differentiation-order ::= '[' 'order' [0-9]+ ']'
+
+
+  autodiff_function_extract [original] %0 : $@differentiable (T) -> T
+  autodiff_function_extract [jvp] [order 1] %0 : $@differentiable (T) -> T
+  autodiff_function_extract [vjp] [order 1] %0 : $@differentiable (T) -> T
+
+Extracts the original function or an associated function from the given
+``@differentiable`` function at a specific differentiation order. It must be
+provided with an extractee: ``[original]``, ``[jvp]`` or ``[vjp]``.
+
+
 Assertion configuration
 ~~~~~~~~~~~~~~~~~~~~~~~
 

branches/rxwei-patch-1/docs/SIL.rst

@@ -746,6 +746,8 @@ class TargetFunctionTypeFlags {
     ThrowsMask        = 0x01000000U,
     ParamFlagsMask    = 0x02000000U,
     EscapingMask      = 0x04000000U,
+    // SWIFT_ENABLE_TENSORFLOW
+    DifferentiableMask  = 0x08000000U
   };
   int_type Data;
 
@@ -781,6 +783,13 @@ class TargetFunctionTypeFlags {
     return TargetFunctionTypeFlags<int_type>((Data & ~EscapingMask) |
                                              (isEscaping ? EscapingMask : 0));
   }
+  
+  // SWIFT_ENABLE_TENSORFLOW
+  constexpr TargetFunctionTypeFlags<int_type>
+  withDifferentiable(bool isDifferentiable) const {
+    return TargetFunctionTypeFlags<int_type>((Data & ~DifferentiableMask) |
+                                   (isDifferentiable ? DifferentiableMask : 0));
+  }
 
   unsigned getNumParameters() const { return Data & NumParametersMask; }
 
@@ -795,6 +804,11 @@ class TargetFunctionTypeFlags {
   bool isEscaping() const {
     return bool (Data & EscapingMask);
   }
+  
+  // SWIFT_ENABLE_TENSORFLOW
+  bool isDifferentiable() const {
+    return bool (Data & DifferentiableMask);
+  }
 
   bool hasParameterFlags() const { return bool(Data & ParamFlagsMask); }
 
@@ -818,9 +832,11 @@ using FunctionTypeFlags = TargetFunctionTypeFlags<size_t>;
 template <typename int_type>
 class TargetParameterTypeFlags {
   enum : int_type {
-    ValueOwnershipMask = 0x7F,
-    VariadicMask       = 0x80,
-    AutoClosureMask    = 0x100,
+    // SWIFT_ENABLE_TENSORFLOW
+    ValueOwnershipMask    = 0x7F,
+    VariadicMask          = 0x80,
+    AutoClosureMask       = 0x100,
+    NonDifferentiableMask = 0x200
   };
   int_type Data;
 
@@ -850,6 +866,8 @@ class TargetParameterTypeFlags {
   bool isNone() const { return Data == 0; }
   bool isVariadic() const { return Data & VariadicMask; }
   bool isAutoClosure() const { return Data & AutoClosureMask; }
+  // SWIFT_ENABLE_TENSORFLOW
+  bool isNonDifferentiable() const { return Data & NonDifferentiableMask; }
 
   ValueOwnership getValueOwnership() const {
     return (ValueOwnership)(Data & ValueOwnershipMask);