Patchwork [2,of,3,STABLE] repoview: fix memory leak of filtered repo classes

login
register
mail settings
Submitter Georges Racinet
Date April 26, 2021, 10:19 a.m.
Message ID <46db86edf8f279063d6f.1619432382@purity.tombe.racinet.fr>
Download mbox | patch
Permalink /patch/48823/
State New
Headers show

Comments

Georges Racinet - April 26, 2021, 10:19 a.m.
# HG changeset patch
# User Georges Racinet <georges.racinet@octobus.net>
# Date 1619195453 -7200
#      Fri Apr 23 18:30:53 2021 +0200
# Branch stable
# Node ID 46db86edf8f279063d6f9d5dd673dc88da8b83cf
# Parent  125fe190f484d396abc93428e3bd58b0b7455c24
# EXP-Topic memleak-repo-class
repoview: fix memory leak of filtered repo classes

The leak occurs in long-running server processes with
extensions, and is measured at 110kB per request.

Before this change, the contents of the `_filteredrepotypes`
cache are not properly garbage collected, despite it begin
a `WeakKeyDictionary`.

Extensions have a tendency to generate a new repository class
for each `localrepo` instantiation. Server processes based
on `hgwebdir_mod` will instantiate a new `localrepo` for each
HTTP request that involves a repository.

As a result, with a testing process that repeatedly opens a
repository with several extensions activated
(`topic` notably among them), we see a steady increase in
resident memory of 110kB per repository instantiation before this
change. This is also true, if we call `gc.collect()` at each
instantiation, like `hgwebdir_mod` does, or not.

The cause of the leak is that the *values* aren't weak references.
This change uses `weakref.ref` for the values, and this makes
in our measurements the resident size increase drop to 5kB per
repository instantiation, with no explicit call of `gc.collect()`
at all.
There is currently no reason to believe that this remaining leak
of 5kB is related to or even due to Mercurial core.

We've also seen evidence that `ui.ui` instances weren't properly
garbage collected before the change (with the change, they are).
This could explain why the figures are relatively high.

In theory, the collection of weak references could lead to
much more misses in the cache, so we measured the impact on
the original case that was motivation for introducing that cache
in 7e89bd0cfb86 (see also issue5043): `hg convert` of the
mozilla-central repository. The bad news here is that there is a
major memory leak there, both with and without the present changeset.
There were no more cache misses, and we could see no
more memory leak with this change: the resident size after importing
roughly 100000 changesets was at 12.4GB before, and 12.5GB after.
The small increase is mentioned for completeness only, and we
believe that it should be ignored, at least as long as the main
leak isn't fixed. At less than 1% of the main leak, even finding out
whether it is merely noise would be wasteful.

Original context where this was spotted and first mitigated:
  https://foss.heptapod.net/heptapod/heptapod/-/issues/466

The leak reduction was also obtained in Heptapod inner HTTP server,
which amounts to the same as `hgwebdir_mod` for these questions.

The measurements done with Python 3.9, similar figures seen with 3.8.
More work on our side would be needed to give measurements with 2.7,
because of testing server process does not support it.

Patch

diff -r 125fe190f484 -r 46db86edf8f2 mercurial/repoview.py
--- a/mercurial/repoview.py	Sat Apr 24 15:46:39 2021 +0200
+++ b/mercurial/repoview.py	Fri Apr 23 18:30:53 2021 +0200
@@ -472,12 +472,15 @@ 
 
 def newtype(base):
     """Create a new type with the repoview mixin and the given base class"""
-    cls = _filteredrepotypes.get(base)
-    if cls is not None:
-        return cls
+    ref = _filteredrepotypes.get(base)
+    if ref is not None:
+        cls = ref()
+        if cls is not None:
+            return cls
 
     class filteredrepo(repoview, base):
         pass
 
-    _filteredrepotypes[base] = filteredrepo
+    _filteredrepotypes[base] = weakref.ref(filteredrepo)
+    # do not reread from weakref to be 100% sure not to return None
     return filteredrepo