Do not cache overall class

gzm0 · gzm0 · commit 49479e48da5f · 2023-12-31T16:00:06.000+01:00
This reduces some memory overhead for negligible performance cost.

Residual (post link memory) benchmarks for the test suite:
Baseline: 1.13 GB, new 1.01 GB
diff --git a/linker/shared/src/main/scala/org/scalajs/linker/backend/emitter/Emitter.scala b/linker/shared/src/main/scala/org/scalajs/linker/backend/emitter/Emitter.scala
@@ -620,9 +620,9 @@ final class Emitter[E >: Null <: js.Transformed.Value](
       }
 
       val fullClass = extractChanged {
-        val fullClassCache = classCache.getFullClassCache()
+        val fullClassChangeTracker = classCache.getFullClassChangeTracker()
 
-        fullClassCache.getOrElseUpdate(linkedClass.version, ctorWithGlobals,
+        fullClassChangeTracker.trackChanged(linkedClass.version, ctorWithGlobals,
             memberMethodsWithGlobals, exportedMembersWithGlobals, {
           for {
             ctor <- ctorWithGlobals
@@ -639,7 +639,7 @@ final class Emitter[E >: Null <: js.Transformed.Value](
               storeJSSuperClass.map(js.Transformed(_)), // invalidated by class version
               useESClass, // invalidated by class version (depends on kind, config and ancestry only)
               membersAsTrees // invalidated directly
-            )(moduleContext, fullClassCache, linkedClass.pos) // pos invalidated by class version
+            )(moduleContext, fullClassChangeTracker, linkedClass.pos) // pos invalidated by class version
           } yield {
             // Avoid a nested post transform if we just got the original members back.
             if (clazz eq membersAsTrees) {
@@ -863,7 +863,7 @@ final class Emitter[E >: Null <: js.Transformed.Value](
     private[this] val _exportedMembersCache =
       mutable.Map.empty[Int, MethodCache[E]]
 
-    private[this] var _fullClassCache: Option[FullClassCache] = None
+    private[this] var _fullClassChangeTracker: Option[FullClassChangeTracker] = None
 
     override def invalidate(): Unit = {
       /* Do not invalidate contained methods, as they have their own
@@ -879,7 +879,7 @@ final class Emitter[E >: Null <: js.Transformed.Value](
       _methodCaches.foreach(_.valuesIterator.foreach(_.startRun()))
       _memberMethodCache.valuesIterator.foreach(_.startRun())
       _constructorCache.foreach(_.startRun())
-      _fullClassCache.foreach(_.startRun())
+      _fullClassChangeTracker.foreach(_.startRun())
     }
 
     def getCache(version: Version): (DesugaredClassCache[E], Boolean) = {
@@ -918,10 +918,10 @@ final class Emitter[E >: Null <: js.Transformed.Value](
     def getExportedMemberCache(idx: Int): MethodCache[E] =
       _exportedMembersCache.getOrElseUpdate(idx, new MethodCache)
 
-    def getFullClassCache(): FullClassCache = {
-      _fullClassCache.getOrElse {
-        val cache = new FullClassCache
-        _fullClassCache = Some(cache)
+    def getFullClassChangeTracker(): FullClassChangeTracker = {
+      _fullClassChangeTracker.getOrElse {
+        val cache = new FullClassChangeTracker
+        _fullClassChangeTracker = Some(cache)
         cache
       }
     }
@@ -935,8 +935,8 @@ final class Emitter[E >: Null <: js.Transformed.Value](
 
       _exportedMembersCache.filterInPlace((_, c) => c.cleanAfterRun())
 
-      if (_fullClassCache.exists(!_.cleanAfterRun()))
-        _fullClassCache = None
+      if (_fullClassChangeTracker.exists(!_.cleanAfterRun()))
+        _fullClassChangeTracker = None
 
       if (!_cacheUsed)
         invalidate()
@@ -981,26 +981,24 @@ final class Emitter[E >: Null <: js.Transformed.Value](
     }
   }
 
-  private class FullClassCache extends knowledgeGuardian.KnowledgeAccessor {
-    private[this] var _tree: WithGlobals[List[E]] = null
+  private class FullClassChangeTracker extends knowledgeGuardian.KnowledgeAccessor {
     private[this] var _lastVersion: Version = Version.Unversioned
     private[this] var _lastCtor: WithGlobals[E] = null
     private[this] var _lastMemberMethods: List[WithGlobals[E]] = null
     private[this] var _lastExportedMembers: List[WithGlobals[E]] = null
-    private[this] var _cacheUsed = false
+    private[this] var _trackerUsed = false
 
     override def invalidate(): Unit = {
       super.invalidate()
-      _tree = null
       _lastVersion = Version.Unversioned
       _lastCtor = null
       _lastMemberMethods = null
       _lastExportedMembers = null
     }
 
-    def startRun(): Unit = _cacheUsed = false
+    def startRun(): Unit = _trackerUsed = false
 
-    def getOrElseUpdate(version: Version, ctor: WithGlobals[E],
+    def trackChanged(version: Version, ctor: WithGlobals[E],
         memberMethods: List[WithGlobals[E]], exportedMembers: List[WithGlobals[E]],
         compute: => WithGlobals[List[E]]): (WithGlobals[List[E]], Boolean) = {
 
@@ -1012,28 +1010,32 @@ final class Emitter[E >: Null <: js.Transformed.Value](
         }
       }
 
-      _cacheUsed = true
+      _trackerUsed = true
 
-      if (_tree == null || !version.sameVersion(_lastVersion) || (_lastCtor ne ctor) ||
+      if (!version.sameVersion(_lastVersion) || (_lastCtor ne ctor) ||
           !allSame(_lastMemberMethods, memberMethods) ||
           !allSame(_lastExportedMembers, exportedMembers)) {
+        // Input has changed or we were invalidated.
+        // Clean knowledge tracking and re-track dependencies.
         invalidate()
-        _tree = compute
         _lastVersion = version
         _lastCtor = ctor
         _lastMemberMethods = memberMethods
         _lastExportedMembers = exportedMembers
-        (_tree, true)
+
+        (compute, true)
       } else {
-        (_tree, false)
+        // Input has not changed and we were not invalidated.
+        // --> nothing has changed (we recompute to save memory).
+        (compute, false)
       }
     }
 
     def cleanAfterRun(): Boolean = {
-      if (!_cacheUsed)
+      if (!_trackerUsed)
         invalidate()
 
-      _cacheUsed
+      _trackerUsed
     }
   }
 
diff --git a/linker/shared/src/test/scala/org/scalajs/linker/EmitterTest.scala b/linker/shared/src/test/scala/org/scalajs/linker/EmitterTest.scala
@@ -208,18 +208,21 @@ class EmitterTest {
 
       // Post transforms
 
-      val Seq(postTransforms1, _, _) =
+      val Seq(postTransforms1, nestedPostTransforms1, _) =
         lines1.assertContainsMatch(EmitterPostTransformStatsMessage).map(_.toInt)
 
-      val Seq(postTransforms2, _, _) =
+      val Seq(postTransforms2, nestedPostTransforms2, _) =
         lines2.assertContainsMatch(EmitterPostTransformStatsMessage).map(_.toInt)
 
-      // At the time of writing this test, postTransformsTotal1 reports 216
+      // At the time of writing this test, postTransforms1 reports 216
       assertTrue(
           s"Not enough post transforms (got $postTransforms1); extraction must have gone wrong",
           postTransforms1 > 200)
 
-      assertEquals("Second run must not have any post transforms", 0, postTransforms2)
+      assertEquals("Second run must only have nested post transforms",
+          nestedPostTransforms2, postTransforms2)
+      assertEquals("Both runs must have the same number of nested post transforms",
+          nestedPostTransforms1, nestedPostTransforms2)
     }
   }
 }
