---

yaml
---
r: 340990
b: refs/heads/rxwei-patch-1
c: 58ccca2
h: refs/heads/master

Author: bartchr808

[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: c1dfcde1a4ddc3a6aad97571aeb38fab5f9ce37d
+refs/heads/rxwei-patch-1: 58ccca2f6a1c5f75d186cbbc5466596a6bfc8f71
 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/lib/SILOptimizer/Mandatory/Differentiation.cpp

@@ -4378,8 +4378,8 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
   /// any error occurs.
   bool run() {
     auto &original = getOriginal();
-    auto &adjoint = getPullback();
-    auto adjLoc = getPullback().getLocation();
+    auto &pullback = getPullback();
+    auto pbLoc = getPullback().getLocation();
     LLVM_DEBUG(getADDebugStream() << "Running PullbackEmitter on\n" << original);
 
     auto *adjGenEnv = getPullback().getGenericEnvironment();
@@ -4446,7 +4446,7 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
     if (errorOccurred)
       return true;
 
-    // Create adjoint blocks and arguments, visiting original blocks in
+    // Create pullback blocks and arguments, visiting original blocks in
     // post-order post-dominance order.
     SmallVector<SILBasicBlock *, 8> postOrderPostDomOrder;
     // Start from the root node, which may have a marker `nullptr` block if
@@ -4462,17 +4462,17 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
       postOrderPostDomOrder.push_back(origBB);
     }
     for (auto *origBB : postOrderPostDomOrder) {
-      auto *adjointBB = adjoint.createBasicBlock();
-      adjointBBMap.insert({origBB, adjointBB});
+      auto *pullbackBB = pullback.createBasicBlock();
+      adjointBBMap.insert({origBB, pullbackBB});
       auto pbStructLoweredType =
           remapType(getPullbackInfo().getPullbackStructLoweredType(origBB));
-      // If the BB is the original exit, then the adjoint block that we just
-      // created must be the adjoint function's entry. For the adjoint entry,
+      // If the BB is the original exit, then the pullback block that we just
+      // created must be the pullback function's entry. For the pullback entry,
       // create entry arguments and continue to the next block.
       if (origBB == origExit) {
-        assert(adjointBB->isEntry());
+        assert(pullbackBB->isEntry());
         createEntryArguments(&getPullback());
-        auto *lastArg = adjointBB->getArguments().back();
+        auto *lastArg = pullbackBB->getArguments().back();
         assert(lastArg->getType() == pbStructLoweredType);
         pullbackStructArguments[origBB] = lastArg;
         continue;
@@ -4492,27 +4492,29 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
         if (activeValue->getType().isAddress()) {
           // Allocate and zero initialize a new local buffer using
           // `getAdjointBuffer`.
-          builder.setInsertionPoint(adjoint.getEntryBlock());
+          builder.setInsertionPoint(pullback.getEntryBlock());
           getAdjointBuffer(origBB, activeValue);
         } else {
-          // Create and register adjoint block argument for the active value.
-          auto *adjointArg = adjointBB->createPhiArgument(
+          // Create and register pullback block argument for the active value.
+          auto *adjointArg = pullbackBB->createPhiArgument(
               getRemappedTangentType(activeValue->getType()),
               ValueOwnershipKind::Guaranteed);
           activeValueAdjointBBArgumentMap[{origBB, activeValue}] = adjointArg;
         }
       }
       // Add a pullback struct argument.
-      auto *pbStructArg = adjointBB->createPhiArgument(
+      auto *pbStructArg = pullbackBB->createPhiArgument(
           pbStructLoweredType, ValueOwnershipKind::Guaranteed);
       pullbackStructArguments[origBB] = pbStructArg;
-      // - Create adjoint trampoline blocks for each successor block of the
+      // - Create pullback trampoline blocks for each successor block of the
       //   original block. Adjoint trampoline blocks only have a pullback
       //   struct argument, and branch from the adjoint successor block to the
       //   adjoint original block, trampoline adjoint values of active values.
       for (auto *succBB : origBB->getSuccessorBlocks()) {
-        auto *adjointTrampolineBB = adjoint.createBasicBlockBefore(adjointBB);
-        pullbackTrampolineBBMap.insert({{origBB, succBB}, adjointTrampolineBB});
+        auto *pullbackTrampolineBB =
+            pullback.createBasicBlockBefore(pullbackBB);
+        pullbackTrampolineBBMap.insert({{origBB, succBB},
+                                       pullbackTrampolineBB});
         // Get the enum element type (i.e. the pullback struct type). The enum
         // element type may be boxed if the enum is indirect.
         auto enumLoweredTy =
@@ -4521,16 +4523,16 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
             getPullbackInfo().lookUpPredecessorEnumElement(origBB, succBB);
         auto enumEltType = remapType(
             enumLoweredTy.getEnumElementType(enumEltDecl, getModule()));
-        adjointTrampolineBB->createPhiArgument(enumEltType,
+        pullbackTrampolineBB->createPhiArgument(enumEltType,
                                                ValueOwnershipKind::Guaranteed);
       }
     }
 
-    auto *adjointEntry = adjoint.getEntryBlock();
-    // The adjoint function has type (seed, exit_pbs) -> ([arg0], ..., [argn]).
-    auto adjParamArgs = adjoint.getArgumentsWithoutIndirectResults();
-    assert(adjParamArgs.size() == 2);
-    seed = adjParamArgs[0];
+    auto *pullbackEntry = pullback.getEntryBlock();
+    // The pullback function has type (seed, exit_pbs) -> ([arg0], ..., [argn]).
+    auto pbParamArgs = pullback.getArgumentsWithoutIndirectResults();
+    assert(pbParamArgs.size() == 2);
+    seed = pbParamArgs[0];
 
     // Assign adjoint for original result.
     SmallVector<SILValue, 8> origFormalResults;
@@ -4550,22 +4552,22 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
       }
     }
     builder.setInsertionPoint(
-        adjointEntry, getNextFunctionLocalAllocationInsertionPoint());
+        pullbackEntry, getNextFunctionLocalAllocationInsertionPoint());
     if (seed->getType().isAddress()) {
       // Create a local copy so that it can be written to by later adjoint
       // zero'ing logic.
-      auto *seedBufCopy = builder.createAllocStack(adjLoc, seed->getType());
-      builder.createCopyAddr(adjLoc, seed, seedBufCopy, IsNotTake,
+      auto *seedBufCopy = builder.createAllocStack(pbLoc, seed->getType());
+      builder.createCopyAddr(pbLoc, seed, seedBufCopy, IsNotTake,
                              IsInitialization);
       if (seed->getType().isLoadable(builder.getFunction()))
-        builder.createRetainValueAddr(adjLoc, seedBufCopy,
+        builder.createRetainValueAddr(pbLoc, seedBufCopy,
                                       builder.getDefaultAtomicity());
       ValueWithCleanup seedBufferCopyWithCleanup(
           seedBufCopy, makeCleanup(seedBufCopy, emitCleanup));
       setAdjointBuffer(origExit, origResult, seedBufferCopyWithCleanup);
       functionLocalAllocations.push_back(seedBufferCopyWithCleanup);
     } else {
-      builder.createRetainValue(adjLoc, seed, builder.getDefaultAtomicity());
+      builder.createRetainValue(pbLoc, seed, builder.getDefaultAtomicity());
       initializeAdjointValue(origExit, origResult, makeConcreteAdjointValue(
           ValueWithCleanup(seed, makeCleanup(seed, emitCleanup))));
     }
@@ -4615,7 +4617,7 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
       auto *predEnumField =
           getPullbackInfo().lookUpPullbackStructPredecessorField(bb);
       auto *predEnumVal =
-          builder.createStructExtract(adjLoc, pbStructVal, predEnumField);
+          builder.createStructExtract(pbLoc, pbStructVal, predEnumField);
 
       // Propagate adjoint values from active basic block arguments to
       // predecessor terminator operands.
@@ -4666,11 +4668,11 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
             if (activeValue->getType().isObject()) {
               auto activeValueAdj = getAdjointValue(bb, activeValue);
               auto concreteActiveValueAdj =
-                  materializeAdjointDirect(activeValueAdj, adjLoc);
+                  materializeAdjointDirect(activeValueAdj, pbLoc);
               // Emit cleanups for children.
               if (auto *cleanup = concreteActiveValueAdj.getCleanup()) {
                 cleanup->disable();
-                cleanup->applyRecursively(builder, adjLoc);
+                cleanup->applyRecursively(builder, pbLoc);
               }
               trampolineArguments.push_back(concreteActiveValueAdj);
               // If the adjoint block does not yet have a registered adjoint
@@ -4694,7 +4696,7 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
               predAdjBuf.setCleanup(makeCleanupFromChildren(
                   {adjBuf.getCleanup(), predAdjBuf.getCleanup()}));
               builder.createCopyAddr(
-                  adjLoc, adjBuf, predAdjBuf, IsNotTake, IsNotInitialization);
+                  pbLoc, adjBuf, predAdjBuf, IsNotTake, IsNotInitialization);
             }
           }
           // Propagate pullback struct argument.
@@ -4705,14 +4707,14 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
             trampolineArguments.push_back(predPBStructVal);
           } else {
             auto *projectBox = adjointTrampolineBBBuilder.createProjectBox(
-                adjLoc, predPBStructVal, /*index*/ 0);
+                pbLoc, predPBStructVal, /*index*/ 0);
             auto *loadInst = adjointTrampolineBBBuilder.createLoad(
-                adjLoc, projectBox,
-                getBufferLOQ(projectBox->getType().getASTType(), adjoint));
+                pbLoc, projectBox,
+                getBufferLOQ(projectBox->getType().getASTType(), pullback));
             trampolineArguments.push_back(loadInst);
           }
           // Branch from adjoint trampoline block to adjoint block.
-          adjointTrampolineBBBuilder.createBranch(adjLoc, adjointBB,
+          adjointTrampolineBBBuilder.createBranch(pbLoc, adjointBB,
                                                   trampolineArguments);
         }
         auto *enumEltDecl =
@@ -4734,15 +4736,15 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
         SILBasicBlock *adjointSuccBB;
         std::tie(enumEltDecl, adjointSuccBB) = adjointSuccessorCases.front();
         auto *predPBStructVal =
-            builder.createUncheckedEnumData(adjLoc, predEnumVal, enumEltDecl);
-        builder.createBranch(adjLoc, adjointSuccBB, {predPBStructVal});
+            builder.createUncheckedEnumData(pbLoc, predEnumVal, enumEltDecl);
+        builder.createBranch(pbLoc, adjointSuccBB, {predPBStructVal});
       }
       // - Otherwise, if the original block has multiple predecessors, then the
       //   adjoint block has multiple successors. Do `switch_enum` to branch on
       //   the predecessor enum values to adjoint successor blocks.
       else {
         builder.createSwitchEnum(
-            adjLoc, predEnumVal, /*DefaultBB*/ nullptr, adjointSuccessorCases);
+            pbLoc, predEnumVal, /*DefaultBB*/ nullptr, adjointSuccessorCases);
       }
     }
 
@@ -4769,14 +4771,14 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
       auto origParam = origParams[parameterIndex];
       if (origParam->getType().isObject()) {
         auto adjVal = getAdjointValue(origEntry, origParam);
-        auto val = materializeAdjointDirect(adjVal, adjLoc);
+        auto val = materializeAdjointDirect(adjVal, pbLoc);
         if (auto *cleanup = val.getCleanup()) {
           LLVM_DEBUG(getADDebugStream() << "Disabling cleanup for "
                      << val.getValue() << "for return\n");
           cleanup->disable();
           LLVM_DEBUG(getADDebugStream() << "Applying "
                      << cleanup->getNumChildren() << " child cleanups\n");
-          cleanup->applyRecursively(builder, adjLoc);
+          cleanup->applyRecursively(builder, pbLoc);
         }
         retElts.push_back(val);
       } else {
@@ -4795,12 +4797,12 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
 
     // Disable cleanup for original indirect parameter adjoint buffers.
     // Copy them to adjoint indirect results.
-    assert(indParamAdjoints.size() == adjoint.getIndirectResults().size() &&
+    assert(indParamAdjoints.size() == pullback.getIndirectResults().size() &&
            "Indirect parameter adjoint count mismatch");
-    for (auto pair : zip(indParamAdjoints, adjoint.getIndirectResults())) {
+    for (auto pair : zip(indParamAdjoints, pullback.getIndirectResults())) {
       auto &source = std::get<0>(pair);
       auto &dest = std::get<1>(pair);
-      builder.createCopyAddr(adjLoc, source, dest, IsTake, IsInitialization);
+      builder.createCopyAddr(pbLoc, source, dest, IsTake, IsInitialization);
       if (auto *cleanup = source.getCleanup())
         cleanup->disable();
     }
@@ -4812,13 +4814,13 @@ class PullbackEmitter final : public SILInstructionVisitor<PullbackEmitter> {
       // Buffers should not be allocated needlessly.
       assert(!alloc.getValue()->use_empty());
       if (auto *cleanup = alloc.getCleanup())
-        cleanup->applyRecursively(builder, adjLoc);
-      builder.createDeallocStack(adjLoc, alloc);
+        cleanup->applyRecursively(builder, pbLoc);
+      builder.createDeallocStack(pbLoc, alloc);
     }
-    builder.createReturn(adjLoc, joinElements(retElts, builder, adjLoc));
+    builder.createReturn(pbLoc, joinElements(retElts, builder, pbLoc));
 
-    LLVM_DEBUG(getADDebugStream() << "Generated adjoint for "
-                                  << original.getName() << ":\n" << adjoint);
+    LLVM_DEBUG(getADDebugStream() << "Generated pullback for "
+                                  << original.getName() << ":\n" << pullback);
     return errorOccurred;
   }