Mercurial > hg
annotate tests/test-hgwebdir-gc.py @ 47802:de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Forcing a systematic full garbage collection upon each request
can serioulsy harm performance. This is reported as
https://bz.mercurial-scm.org/show_bug.cgi?id=6075
With this change we're performing the full collection according
to a new setting, `experimental.web.full-garbage-collection-rate`.
The default value is 1, which doesn't change the behavior and will
allow us to test on real use cases. If the value is 0, no full garbage
collection occurs.
Regardless of the value of the setting, a partial garbage collection
still occurs upon each request (not attempting to collect objects from
the oldest generation). This should be enough to take care of
reference cycles that have been created by the last request
(assessment of this requires changing the setting, not to be 1).
In my experience chasing memory leaks in Mercurial servers,
the full collection never reclaimed any memory, but this is with
Python 3 and biased towards small repositories.
On the other hand, as explained in the Python developer docs [1],
frequent full collections are very harmful in terms of performance if
lots of objects survive the collection, and hence stay in the
oldest generation. Note that `gc.collect()` is indeed trying to
collect the oldest generation [2]. This happens usually in two cases:
- unwanted lingering objects (i.e., an actual memory leak that
the GC cannot do anything about). Sadly, we have lots of those
these days.
- desireable long-term objects, typically in caches (not inner caches
carried by repositories, which should be collected with them). This
is a subject of interest for the Heptapod project.
In short, the flat rate that this change still permits is
probably a bad idea in most cases, and the default value can
be tweaked later on (or even be set to 0) according to experiments
in the wild.
The test is inspired from test-hgwebdir-paths.py
[1] https://devguide.python.org/garbage_collector/#collecting-the-oldest-generation
[2] https://docs.python.org/3/library/gc.html#gc.collect
Differential Revision: https://phab.mercurial-scm.org/D11204
author | Georges Racinet <georges.racinet@octobus.net> |
---|---|
date | Tue, 20 Jul 2021 17:20:19 +0200 |
parents | |
children | 6000f5b25c9b |
rev | line source |
---|---|
47802
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
1 from __future__ import absolute_import |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
2 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
3 import os |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
4 from mercurial.hgweb import hgwebdir_mod |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
5 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
6 hgwebdir = hgwebdir_mod.hgwebdir |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
7 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
8 os.mkdir(b'webdir') |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
9 os.chdir(b'webdir') |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
10 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
11 webdir = os.path.realpath(b'.') |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
12 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
13 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
14 def trivial_response(req, res): |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
15 return [] |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
16 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
17 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
18 def make_hgwebdir(gc_rate=None): |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
19 config = os.path.join(webdir, b'hgwebdir.conf') |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
20 with open(config, 'wb') as configfile: |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
21 configfile.write(b'[experimental]\n') |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
22 if gc_rate is not None: |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
23 configfile.write(b'web.full-garbage-collection-rate=%d\n' % gc_rate) |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
24 hg_wd = hgwebdir(config) |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
25 hg_wd._runwsgi = trivial_response |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
26 return hg_wd |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
27 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
28 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
29 def process_requests(webdir_instance, number): |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
30 # we don't care for now about passing realistic arguments |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
31 for _ in range(number): |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
32 for chunk in webdir_instance.run_wsgi(None, None): |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
33 pass |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
34 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
35 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
36 without_gc = make_hgwebdir(gc_rate=0) |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
37 process_requests(without_gc, 5) |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
38 assert without_gc.requests_count == 5 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
39 assert without_gc.gc_full_collections_done == 0 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
40 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
41 with_gc = make_hgwebdir(gc_rate=2) |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
42 process_requests(with_gc, 5) |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
43 assert with_gc.requests_count == 5 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
44 assert with_gc.gc_full_collections_done == 2 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
45 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
46 with_systematic_gc = make_hgwebdir() # default value of the setting |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
47 process_requests(with_systematic_gc, 3) |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
48 assert with_systematic_gc.requests_count == 3 |
de2e04fe4897
hgwebdir: avoid systematic full garbage collection
Georges Racinet <georges.racinet@octobus.net>
parents:
diff
changeset
|
49 assert with_systematic_gc.gc_full_collections_done == 3 |