Merge pull request PixarAnimationStudios#2794 from erikaharrison-adsk…

…/adsk/bugfix/WaitUntilCompleted Autodesk: WaitUntilCompleted on Metal (Internal change: 2332494)
christophezito · Jun 28, 2024 · ee337ef · ee337ef
2 parents 947c971 + 5da4e92
commit ee337ef
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 13 deletions.
diff --git a/pxr/imaging/hgiMetal/blitCmds.mm b/pxr/imaging/hgiMetal/blitCmds.mm
@@ -55,6 +55,9 @@
             [_label release];
             _label = nil;
         }
+        if (!_secondaryCommandBuffer) {
+            _hgi->SetHasWork();
+        }
     }
 }
 

diff --git a/pxr/imaging/hgiMetal/computeCmds.h b/pxr/imaging/hgiMetal/computeCmds.h
@@ -84,7 +84,6 @@ class HgiMetalComputeCmds final : public HgiComputeCmds
     id<MTLBuffer> _argumentBuffer;
     id<MTLComputeCommandEncoder> _encoder;
     bool _secondaryCommandBuffer;
-    bool _hasWork;
     HgiComputeDispatch _dispatchMethod;
 };
 

diff --git a/pxr/imaging/hgiMetal/computeCmds.mm b/pxr/imaging/hgiMetal/computeCmds.mm
@@ -27,7 +27,6 @@
     , _argumentBuffer(nil)
     , _encoder(nil)
     , _secondaryCommandBuffer(false)
-    , _hasWork(false)
     , _dispatchMethod(desc.dispatchMethod)
 {
     _CreateEncoder();
@@ -135,7 +134,10 @@
         threadsPerThreadgroup:MTLSizeMake(MIN(thread_width, dimX),
                                           MIN(thread_height, dimY), 1)];
 
-    _hasWork = true;
+    if (!_secondaryCommandBuffer) {
+        _hgi->SetHasWork();
+    }
+
     _argumentBuffer = nil;
 }
 
@@ -174,11 +176,9 @@
 bool
 HgiMetalComputeCmds::_Submit(Hgi* hgi, HgiSubmitWaitType wait)
 {
-    bool submittedWork = false;
     if (_encoder) {
         [_encoder endEncoding];
         _encoder = nil;
-        submittedWork = true;
 
         HgiMetal::CommitCommandBufferWaitType waitType;
         switch(wait) {
@@ -204,7 +204,7 @@
     _commandBuffer = nil;
     _argumentBuffer = nil;
 
-    return submittedWork;
+    return true;
 }
 
 HGIMETAL_API

diff --git a/pxr/imaging/hgiMetal/graphicsCmds.h b/pxr/imaging/hgiMetal/graphicsCmds.h
@@ -153,7 +153,6 @@ class HgiMetalGraphicsCmds final : public HgiGraphicsCmds
     uint32_t _primitiveIndexSize;
     uint32_t _drawBufferBindingIndex;
     NSString* _debugLabel;
-    bool _hasWork;
     bool _viewportSet;
     bool _scissorRectSet;
     bool _enableParallelEncoder;

diff --git a/pxr/imaging/hgiMetal/graphicsCmds.mm b/pxr/imaging/hgiMetal/graphicsCmds.mm
@@ -68,7 +68,6 @@
     , _primitiveIndexSize(0)
     , _drawBufferBindingIndex(0)
     , _debugLabel(nil)
-    , _hasWork(false)
     , _viewportSet(false)
     , _scissorRectSet(false)
     , _enableParallelEncoder(false)
@@ -549,7 +548,7 @@
         }
     }
 
-    _hasWork = true;
+    _hgi->SetHasWork();
 }
 
 void
@@ -619,6 +618,8 @@
             });
         }
     });
+
+    _hgi->SetHasWork();
 }
 
 void
@@ -668,7 +669,7 @@
                           baseInstance:baseInstance];
     }
 
-    _hasWork = true;
+    _hgi->SetHasWork();
 }
 
 void
@@ -761,6 +762,8 @@
             });
         }
     });
+
+    _hgi->SetHasWork();
 }
 
 void
@@ -858,7 +861,7 @@
     _encoders.clear();
     _CachedEncState.ResetCachedEncoderState();
 
-    return _hasWork;
+    return true;
 }
 
 PXR_NAMESPACE_CLOSE_SCOPE
diff --git a/pxr/imaging/hgiMetal/hgi.h b/pxr/imaging/hgiMetal/hgi.h
@@ -154,14 +154,19 @@ class HgiMetal final : public Hgi
     // So for the sake of efficiency, we try to create only one cmd buf and
     // only use the secondary command buffer when the client code requires it.
     // For example, the client code may record in a HgiBlitCmds and a
-    // HgiComputeCmds at the same time.
+    // HgiComputeCmds at the same time. It is the responsibility of the
+    // command buffer implementation to call SetHasWork() if there is
+    // work to be submitted from the primary command buffer.
     HGIMETAL_API
     id<MTLCommandBuffer> GetPrimaryCommandBuffer(HgiCmds *requester = nullptr,
                                                  bool flush = true);
 
     HGIMETAL_API
     id<MTLCommandBuffer> GetSecondaryCommandBuffer();
 
+    HGIMETAL_API
+    void SetHasWork();
+
     HGIMETAL_API
     int GetAPIVersion() const;
 

diff --git a/pxr/imaging/hgiMetal/hgi.mm b/pxr/imaging/hgiMetal/hgi.mm
@@ -404,6 +404,12 @@ void Drain() {}
     return commandBuffer;
 }
 
+void
+HgiMetal::SetHasWork()
+{
+    _workToFlush = true;
+}
+
 int
 HgiMetal::GetAPIVersion() const
 {
@@ -516,7 +522,7 @@ void Drain() {}
     TRACE_FUNCTION();
 
     if (cmds) {
-        _workToFlush = Hgi::_SubmitCmds(cmds, wait);
+        Hgi::_SubmitCmds(cmds, wait);
         if (cmds == _currentCmds) {
             _currentCmds = nullptr;
         }