hgweb: garbage collect on every request stable
authorGregory Szorc <gregory.szorc@gmail.com>
Mon, 12 Mar 2018 13:15:00 -0700
branchstable
changeset 36845 ff2370a70fe8
parent 36844 eeb87b24aea7
child 36978 c479692690ef
child 36979 b9a6ee2066f9
hgweb: garbage collect on every request There appears to be a cycle in localrepository or hgweb that is preventing repositories from being garbage collected when hgwebdir dispatches to hgweb. Every request creates a new repository instance and then leaks that object and other referenced objects. A periodic GC to find cycles will eventually collect the old repositories. But these don't run reliably and rapid requests to hgwebdir can result in rapidly increasing memory consumption. With the Firefox repository, repeated requests to raw-file URLs leak ~100 MB per hgwebdir request (most of this appears to be cached manifest data structures). WSGI processes quickly grow to >1 GB RSS. Breaking the cycles in localrepository is going to be a bit of work. Because we know that hgwebdir leaks localrepository instances, let's put a band aid on the problem in the form of an explicit gc.collect() on every hgwebdir request. As the inline comment states, ideally we'd do this in a finally block for the current request iff it dispatches to hgweb. But _runwsgi() returns an explicit value. We need the finally to run after generator exhaustion. So we'd need to refactor _runwsgi() to "yield" instead of "return." That's too much change for a patch to stable. So we implement this hack one function above and run it on every request. The performance impact of this change should be minimal. Any impact should be offset by benefits from not having hgwebdir processes leak memory.
mercurial/hgweb/hgwebdir_mod.py
--- a/mercurial/hgweb/hgwebdir_mod.py	Sun Mar 11 20:10:38 2018 +0900
+++ b/mercurial/hgweb/hgwebdir_mod.py	Mon Mar 12 13:15:00 2018 -0700
@@ -8,6 +8,7 @@
 
 from __future__ import absolute_import
 
+import gc
 import os
 import re
 import time
@@ -224,8 +225,18 @@
     def run_wsgi(self, req):
         profile = self.ui.configbool('profiling', 'enabled')
         with profiling.profile(self.ui, enabled=profile):
-            for r in self._runwsgi(req):
-                yield r
+            try:
+                for r in self._runwsgi(req):
+                    yield r
+            finally:
+                # There are known cycles in localrepository that prevent
+                # those objects (and tons of held references) from being
+                # collected through normal refcounting. We mitigate those
+                # leaks by performing an explicit GC on every request.
+                # TODO remove this once leaks are fixed.
+                # TODO only run this on requests that create localrepository
+                # instances instead of every request.
+                gc.collect()
 
     def _runwsgi(self, req):
         try: