8342146: Use dealloc method in MetalShader and fix leak

Author: jayathirthrao

modules/javafx.graphics/src/main/java/com/sun/prism/mtl/MTLContext.java

@@ -421,6 +421,8 @@ private static native void nBlit(long pContext, long nSrcRTT, long nDstRTT,
 
     private static native void nRelease(long pContext);
 
+    private static native void nDisposeShader(long nMetalShaderRef);
+
     @Override
     public void setDeviceParametersFor2D() {
         if (checkDisposed()) return;
@@ -622,6 +624,9 @@ private void updateRawMatrix(GeneralTransform3D src) {
         rawMatrix[15] = (float)src.get(15);
     }
 
+    public void disposeShader(long nMetalShaderRef) {
+        nDisposeShader(nMetalShaderRef);
+    }
 
     @Override
     public void dispose() {

modules/javafx.graphics/src/main/java/com/sun/prism/mtl/MTLShader.java

@@ -62,8 +62,6 @@ native private static long nSetTexture(long nMetalShader, int texID, int uniform
 
     native private static long nSetConstants(long nMetalShader, int uniformID, float[] values, int size);
 
-    native private static void nDispose(long nMetalShader);
-
     private MTLShader(MTLContext context, String fragmentFunctionName) {
         MTLLog.Debug(">>> MTLShader(): fragFuncName = " + fragmentFunctionName);
 
@@ -138,6 +136,10 @@ public void enable() {
     @Override
     public void disable() {
         MTLLog.Debug("MTLShader.disable()  fragFuncName = " + fragmentFunctionName);
+        // TODO: MTL: There are no disable calls coming from BaseShaderContext.
+        // So this is a no-op. We can call disable on lastShader in
+        // BaseShaderContext.checkState() but that will be a common change for
+        // all pipelines.
         nDisable(nMetalShaderRef);
     }
 
@@ -237,6 +239,6 @@ public void setConstants(String name, FloatBuffer buf, int off, int count) {
     @Override
     public void dispose() {
         MTLLog.Debug(">>> MTLShader.dispose() : fragmentFunctionName : " + this.fragmentFunctionName);
-        nDispose(nMetalShaderRef);
+        context.disposeShader(nMetalShaderRef);
     }
 }

modules/javafx.graphics/src/main/native-prism-mtl/MetalContext.m

@@ -290,6 +290,7 @@ - (void) commitCurrentCommandBuffer:(bool)waitUntilCompleted
     for (MetalShader* shader in shadersUsedInCB) {
         [shader setArgsUpdated:true];
     }
+    [shadersUsedInCB removeAllObjects];
 
     unsigned int rbid = [MetalRingBuffer getCurrentBufferIndex];
     [currentCommandBuffer addCompletedHandler:^(id<MTLCommandBuffer> cb) {
@@ -899,6 +900,11 @@ - (void)dealloc
         transientBuffersForCB = nil;
     }
 
+    if (shadersUsedInCB != nil) {
+        [shadersUsedInCB removeAllObjects];
+        [shadersUsedInCB release];
+        shadersUsedInCB = nil;
+    }
     if (identityMatrixBuf != nil) {
         [identityMatrixBuf release];
         identityMatrixBuf = nil;
@@ -969,6 +975,17 @@ - (void)dealloc
     return jContextPtr;
 }
 
+JNIEXPORT void JNICALL Java_com_sun_prism_mtl_MTLContext_nDisposeShader
+  (JNIEnv *env, jclass jClass, jlong shaderRef)
+{
+    CTX_LOG(@">>>> MTLContext_nDisposeShader");
+
+    MetalShader *shaderPtr = (MetalShader *)jlong_to_ptr(shaderRef);
+    if (shaderPtr != NULL) {
+        [shaderPtr release];
+    }
+    CTX_LOG(@"<<<< MTLContext_nDisposeShader");
+}
 
 JNIEXPORT void JNICALL Java_com_sun_prism_mtl_MTLContext_nRelease
   (JNIEnv *env, jclass jClass, jlong context)

modules/javafx.graphics/src/main/native-prism-mtl/MetalShader.h

@@ -72,6 +72,7 @@
 
 - (NSUInteger) getArgumentID:(NSString*) name;
 - (void) enable;
+- (void) disable;
 
 - (void) setTexture:(int)texID
           uniformID:(int)uniformID
@@ -87,6 +88,7 @@
 - (void) setFloat4:(int)uniformID f0:(float) f0 f1:(float) f1 f2:(float) f2  f3:(float) f3;
 
 - (void) setConstants:(int)uniformID values:(float[]) values size:(int) size;
+- (void) dealloc;
 
 @end
 

modules/javafx.graphics/src/main/native-prism-mtl/MetalShader.m

@@ -159,6 +159,14 @@ - (void) enable
     SHADER_LOG(@"<<<< MetalShader.enable()\n");
 }
 
+- (void) disable
+{
+    SHADER_LOG(@"\n");
+    SHADER_LOG(@">>>> MetalShader.disable()----> fragFuncName: %@", fragFuncName);
+    [context setCurrentShader:NULL];
+    SHADER_LOG(@"<<<< MetalShader.disable()\n");
+}
+
 - (id<MTLRenderPipelineState>) getPipelineState:(bool)isMSAA
                                   compositeMode:(int)compositeMode;
 {
@@ -413,7 +421,7 @@ - (void) setConstants:(int)uniformID values:(float[]) values size:(int) size
     SHADER_LOG(@"<<<< MetalShader.setConstants()");
 }
 
-- (void) dispose
+- (void) dealloc
 {
     SHADER_LOG(@"\n");
     SHADER_LOG(@">>>> MetalShader.dispose()----> fragFuncName: %@", fragFuncName);
@@ -490,7 +498,7 @@ - (void) dispose
     SHADER_LOG(@"\n");
     SHADER_LOG(@"-> JNICALL Native: MTLShader_nDisable");
     MetalShader *mtlShader = (MetalShader *)jlong_to_ptr(shader);
-    //[mtlShader disable];
+    [mtlShader disable];
     return 1;
 }
 
@@ -572,13 +580,3 @@ - (void) dispose
     (*env)->ReleaseFloatArrayElements(env, valuesArray, values, 0);
     return 1;
 }
-
-JNIEXPORT void JNICALL Java_com_sun_prism_mtl_MTLShader_nDispose
-  (JNIEnv *env, jclass jClass, jlong shader)
-{
-    SHADER_LOG(@"\n");
-    SHADER_LOG(@"-> JNICALL Native: MTLShader_nDispose");
-    MetalShader *mtlShader = (MetalShader *)jlong_to_ptr(shader);
-    [mtlShader dispose];
-    return;
-}