You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "LuciferYang (via GitHub)" <gi...@apache.org> on 2023/11/06 13:38:10 UTC

[PR] Refactor `StorageUtils#bufferCleaner` to avoid directly using classes under the `sun` package [spark]

LuciferYang opened a new pull request, #43675:
URL: https://github.com/apache/spark/pull/43675

   <!--
   Thanks for sending a pull request!  Here are some tips for you:
     1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
     2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
     3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
     4. Be sure to keep the PR description updated to reflect all changes.
     5. Please write your PR title to summarize what this PR proposes.
     6. If possible, provide a concise example to reproduce the issue for a faster review.
     7. If you want to add a new configuration, please read the guideline first for naming configurations in
        'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
     8. If you want to add or modify an error type or message, please read the guideline first in
        'core/src/main/resources/error/README.md'.
   -->
   
   ### What changes were proposed in this pull request?
   <!--
   Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue. 
   If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
     1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
     2. If you fix some SQL features, you can provide some references of other DBMSes.
     3. If there is design documentation, please add the link.
     4. If there is a discussion in the mailing list, please add the link.
   -->
   
   
   ### Why are the changes needed?
   <!--
   Please clarify why the changes are needed. For instance,
     1. If you propose a new API, clarify the use case for a new API.
     2. If you fix a bug, you can clarify why it is a bug.
   -->
   
   
   ### Does this PR introduce _any_ user-facing change?
   <!--
   Note that it means *any* user-facing change including all aspects such as the documentation fix.
   If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
   If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
   If no, write 'No'.
   -->
   
   
   ### How was this patch tested?
   <!--
   If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
   If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
   If tests were not added, please describe why they were not added and/or why it was difficult to add.
   If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
   -->
   
   
   ### Was this patch authored or co-authored using generative AI tooling?
   <!--
   If generative AI tooling has been used in the process of authoring this patch, please include the
   phrase: 'Generated-by: ' followed by the name of the tool and its version.
   If no, write 'No'.
   Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [CORE] Refactor `StorageUtils#bufferCleaner` to avoid directly using classes under the `sun` package [spark]

Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on PR #43675:
URL: https://github.com/apache/spark/pull/43675#issuecomment-1794847242

   Test first


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner` [spark]

Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on PR #43675:
URL: https://github.com/apache/spark/pull/43675#issuecomment-1807425884

   Thanks @dongjoon-hyun ~


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner` to avoid directly using classes under the `sun` package [spark]

Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #43675:
URL: https://github.com/apache/spark/pull/43675#discussion_r1387860580


##########
core/src/main/scala/org/apache/spark/storage/StorageUtils.scala:
##########
@@ -197,13 +195,18 @@ private[spark] class StorageStatus(
 /** Helper methods for storage-related objects. */
 private[spark] object StorageUtils extends Logging {
 
-  private val bufferCleaner: DirectBuffer => Unit = {
-    val cleanerMethod =
-      Utils.classForName("sun.misc.Unsafe").getMethod("invokeCleaner", classOf[ByteBuffer])
-    val unsafeField = classOf[Unsafe].getDeclaredField("theUnsafe")
-    unsafeField.setAccessible(true)
-    val unsafe = unsafeField.get(null).asInstanceOf[Unsafe]
-    buffer: DirectBuffer => cleanerMethod.invoke(unsafe, buffer)
+  private val bufferCleaner: ByteBuffer => Unit = {
+    val cleanerClass = Utils.classForName("jdk.internal.ref.Cleaner")
+    val directBufferClass = Utils.classForName("sun.nio.ch.DirectBuffer")
+    val byteBufferLookup: MethodHandles.Lookup =
+      MethodHandles.privateLookupIn(directBufferClass, MethodHandles.lookup())
+    val cleanerMethod: MethodHandle = byteBufferLookup
+      .findVirtual(directBufferClass, "cleaner", MethodType.methodType(cleanerClass))
+    val cleanerLookup: MethodHandles.Lookup =
+      MethodHandles.privateLookupIn(cleanerClass, MethodHandles.lookup())
+    val cleanMethod: MethodHandle =
+      cleanerLookup.findVirtual(cleanerClass, "clean", MethodType.methodType(classOf[Unit]))
+    buffer: ByteBuffer => cleanMethod.invoke(cleanerMethod.invoke(buffer))

Review Comment:
   Let me test several cpu models more and feedback later



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner` to avoid directly using classes under the `sun` package [spark]

Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on PR #43675:
URL: https://github.com/apache/spark/pull/43675#issuecomment-1803202799

   convert to draft first, let me check the performance
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [CORE] Refactor `StorageUtils#bufferCleaner` to avoid directly using classes under the `sun` package [spark]

Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #43675:
URL: https://github.com/apache/spark/pull/43675#discussion_r1383348575


##########
core/src/main/scala/org/apache/spark/storage/StorageUtils.scala:
##########
@@ -197,13 +195,18 @@ private[spark] class StorageStatus(
 /** Helper methods for storage-related objects. */
 private[spark] object StorageUtils extends Logging {
 
-  private val bufferCleaner: DirectBuffer => Unit = {
-    val cleanerMethod =
-      Utils.classForName("sun.misc.Unsafe").getMethod("invokeCleaner", classOf[ByteBuffer])
-    val unsafeField = classOf[Unsafe].getDeclaredField("theUnsafe")
-    unsafeField.setAccessible(true)
-    val unsafe = unsafeField.get(null).asInstanceOf[Unsafe]
-    buffer: DirectBuffer => cleanerMethod.invoke(unsafe, buffer)
+  private val bufferCleaner: ByteBuffer => Unit = {
+    val cleanerClass = Utils.classForName("jdk.internal.ref.Cleaner")
+    val directBufferClass = Utils.classForName("sun.nio.ch.DirectBuffer")

Review Comment:
   I think this class can also be `java.nio.DirectByteBuffer` due to `MappedByteBuffer` has only two subclasses: `java.nio.DirectByteBuffer` and `java.nio.DirectByteBufferR`, and `java.nio.DirectByteBufferR` also inherits from `java.nio.DirectByteBuffer`. which one is better?
   
   
   
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner` to avoid directly using classes under the `sun` package [spark]

Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #43675:
URL: https://github.com/apache/spark/pull/43675#discussion_r1387574129


##########
core/src/main/scala/org/apache/spark/storage/StorageUtils.scala:
##########
@@ -197,13 +195,18 @@ private[spark] class StorageStatus(
 /** Helper methods for storage-related objects. */
 private[spark] object StorageUtils extends Logging {
 
-  private val bufferCleaner: DirectBuffer => Unit = {
-    val cleanerMethod =
-      Utils.classForName("sun.misc.Unsafe").getMethod("invokeCleaner", classOf[ByteBuffer])
-    val unsafeField = classOf[Unsafe].getDeclaredField("theUnsafe")
-    unsafeField.setAccessible(true)
-    val unsafe = unsafeField.get(null).asInstanceOf[Unsafe]
-    buffer: DirectBuffer => cleanerMethod.invoke(unsafe, buffer)
+  private val bufferCleaner: ByteBuffer => Unit = {
+    val cleanerClass = Utils.classForName("jdk.internal.ref.Cleaner")
+    val directBufferClass = Utils.classForName("sun.nio.ch.DirectBuffer")
+    val byteBufferLookup: MethodHandles.Lookup =
+      MethodHandles.privateLookupIn(directBufferClass, MethodHandles.lookup())
+    val cleanerMethod: MethodHandle = byteBufferLookup
+      .findVirtual(directBufferClass, "cleaner", MethodType.methodType(cleanerClass))
+    val cleanerLookup: MethodHandles.Lookup =
+      MethodHandles.privateLookupIn(cleanerClass, MethodHandles.lookup())
+    val cleanMethod: MethodHandle =
+      cleanerLookup.findVirtual(cleanerClass, "clean", MethodType.methodType(classOf[Unit]))
+    buffer: ByteBuffer => cleanMethod.invoke(cleanerMethod.invoke(buffer))

Review Comment:
   The new method is indeed slower than the old method because there are two calls to the method handle. Let me think about what to do. @dongjoon-hyun 
   
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner` [spark]

Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #43675:
URL: https://github.com/apache/spark/pull/43675#discussion_r1388835749


##########
core/src/main/scala/org/apache/spark/storage/StorageUtils.scala:
##########
@@ -197,13 +195,18 @@ private[spark] class StorageStatus(
 /** Helper methods for storage-related objects. */
 private[spark] object StorageUtils extends Logging {
 
-  private val bufferCleaner: DirectBuffer => Unit = {
-    val cleanerMethod =
-      Utils.classForName("sun.misc.Unsafe").getMethod("invokeCleaner", classOf[ByteBuffer])
-    val unsafeField = classOf[Unsafe].getDeclaredField("theUnsafe")
-    unsafeField.setAccessible(true)
-    val unsafe = unsafeField.get(null).asInstanceOf[Unsafe]
-    buffer: DirectBuffer => cleanerMethod.invoke(unsafe, buffer)
+  private val bufferCleaner: ByteBuffer => Unit = {
+    val cleanerClass = Utils.classForName("jdk.internal.ref.Cleaner")
+    val directBufferClass = Utils.classForName("sun.nio.ch.DirectBuffer")
+    val byteBufferLookup: MethodHandles.Lookup =
+      MethodHandles.privateLookupIn(directBufferClass, MethodHandles.lookup())
+    val cleanerMethod: MethodHandle = byteBufferLookup
+      .findVirtual(directBufferClass, "cleaner", MethodType.methodType(cleanerClass))
+    val cleanerLookup: MethodHandles.Lookup =
+      MethodHandles.privateLookupIn(cleanerClass, MethodHandles.lookup())
+    val cleanMethod: MethodHandle =
+      cleanerLookup.findVirtual(cleanerClass, "clean", MethodType.methodType(classOf[Unit]))
+    buffer: ByteBuffer => cleanMethod.invoke(cleanerMethod.invoke(buffer))

Review Comment:
   @dongjoon-hyun 
   
   I wrote a micro benchmark to test the initialization and invocation of bufferCleaner, observing their performance under different CPU models, including `AMD EPYC 7763`, `E5-2673`, `8171M`, and `E5-2673`. The test data reflects the following facts:
   
   1. Using the methodhandle method to initialize bufferCleaner is 60%~70% slower than base implementation
   
   2. The performance of using the methodhandle to call is basically the same as that of base implementation, with a single call delay difference of ~1ns
   
   3. The current pr implementation has a performance advantage of more than 10 times over base implementation in initializing bufferCleaner
   
   4. The performance of the current pr implementation call is at least 30% faster than that of base implementation
   
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner` to avoid directly using classes under the `sun` package [spark]

Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #43675:
URL: https://github.com/apache/spark/pull/43675#discussion_r1387574129


##########
core/src/main/scala/org/apache/spark/storage/StorageUtils.scala:
##########
@@ -197,13 +195,18 @@ private[spark] class StorageStatus(
 /** Helper methods for storage-related objects. */
 private[spark] object StorageUtils extends Logging {
 
-  private val bufferCleaner: DirectBuffer => Unit = {
-    val cleanerMethod =
-      Utils.classForName("sun.misc.Unsafe").getMethod("invokeCleaner", classOf[ByteBuffer])
-    val unsafeField = classOf[Unsafe].getDeclaredField("theUnsafe")
-    unsafeField.setAccessible(true)
-    val unsafe = unsafeField.get(null).asInstanceOf[Unsafe]
-    buffer: DirectBuffer => cleanerMethod.invoke(unsafe, buffer)
+  private val bufferCleaner: ByteBuffer => Unit = {
+    val cleanerClass = Utils.classForName("jdk.internal.ref.Cleaner")
+    val directBufferClass = Utils.classForName("sun.nio.ch.DirectBuffer")
+    val byteBufferLookup: MethodHandles.Lookup =
+      MethodHandles.privateLookupIn(directBufferClass, MethodHandles.lookup())
+    val cleanerMethod: MethodHandle = byteBufferLookup
+      .findVirtual(directBufferClass, "cleaner", MethodType.methodType(cleanerClass))
+    val cleanerLookup: MethodHandles.Lookup =
+      MethodHandles.privateLookupIn(cleanerClass, MethodHandles.lookup())
+    val cleanMethod: MethodHandle =
+      cleanerLookup.findVirtual(cleanerClass, "clean", MethodType.methodType(classOf[Unit]))
+    buffer: ByteBuffer => cleanMethod.invoke(cleanerMethod.invoke(buffer))

Review Comment:
   ~The new method is indeed slower than the old method because there are two calls to the method handle. Let me think about what to do.~ @dongjoon-hyun 
   
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner` [spark]

Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun commented on PR #43675:
URL: https://github.com/apache/spark/pull/43675#issuecomment-1807267811

   BTW, cc @rednaxelafx , too.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner` [spark]

Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #43675:
URL: https://github.com/apache/spark/pull/43675#discussion_r1388887861


##########
core/src/main/scala/org/apache/spark/storage/StorageUtils.scala:
##########
@@ -197,13 +195,18 @@ private[spark] class StorageStatus(
 /** Helper methods for storage-related objects. */
 private[spark] object StorageUtils extends Logging {
 
-  private val bufferCleaner: DirectBuffer => Unit = {
-    val cleanerMethod =
-      Utils.classForName("sun.misc.Unsafe").getMethod("invokeCleaner", classOf[ByteBuffer])
-    val unsafeField = classOf[Unsafe].getDeclaredField("theUnsafe")
-    unsafeField.setAccessible(true)
-    val unsafe = unsafeField.get(null).asInstanceOf[Unsafe]
-    buffer: DirectBuffer => cleanerMethod.invoke(unsafe, buffer)
+  private val bufferCleaner: ByteBuffer => Unit = {
+    val cleanerClass = Utils.classForName("jdk.internal.ref.Cleaner")
+    val directBufferClass = Utils.classForName("sun.nio.ch.DirectBuffer")
+    val byteBufferLookup: MethodHandles.Lookup =
+      MethodHandles.privateLookupIn(directBufferClass, MethodHandles.lookup())
+    val cleanerMethod: MethodHandle = byteBufferLookup
+      .findVirtual(directBufferClass, "cleaner", MethodType.methodType(cleanerClass))
+    val cleanerLookup: MethodHandles.Lookup =
+      MethodHandles.privateLookupIn(cleanerClass, MethodHandles.lookup())
+    val cleanMethod: MethodHandle =
+      cleanerLookup.findVirtual(cleanerClass, "clean", MethodType.methodType(classOf[Unit]))
+    buffer: ByteBuffer => cleanMethod.invoke(cleanerMethod.invoke(buffer))

Review Comment:
   In addition, `sun.misc.Unsafe` is exported, so it can still be used directly now
   
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner` [spark]

Posted by "dongjoon-hyun (via GitHub)" <gi...@apache.org>.
dongjoon-hyun closed pull request #43675: [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner`
URL: https://github.com/apache/spark/pull/43675


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org


Re: [PR] [SPARK-45830][CORE] Refactor `StorageUtils#bufferCleaner` to avoid directly using classes under the `sun` package [spark]

Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on PR #43675:
URL: https://github.com/apache/spark/pull/43675#issuecomment-1803110236

   > Do you think there is a chance of performance difference, @LuciferYang ?
   
   `cleanMethod.invoke(cleanerMethod.invoke(buffer))` vs `cleanerMethod.invoke(unsafe, buffer)`?
   
   Although the official recommendation is for the former rather than reflection, I have previously done some mircabenchmarks on Java 8 and there is no significant performance difference between the two. If necessary, I can write some more cases to compare them in Java 17.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org