Do not leak 64 bytes of heap memory every time a manual page calls
authorschwarze <schwarze@openbsd.org>
Mon, 4 Oct 2021 10:11:54 +0000 (10:11 +0000)
committerschwarze <schwarze@openbsd.org>
Mon, 4 Oct 2021 10:11:54 +0000 (10:11 +0000)
commitb69f004a27326b6737d1b66c7b547765be048e75
tree4ade4370d7acaa352223076a4815ba54c9abf1d8
parentd4689024703d32da7b227a1aca2c09ebbc74648d
Do not leak 64 bytes of heap memory every time a manual page calls
a user-defined macro.  Calls of standard mdoc(7) and man(7) macros
were unaffected, so the effect on OpenBSD manual pages was small,
about 80 Kilobytes grand total for a full run of "makewhatis
/usr/share/man".

Argument expansion contexts for user-defined macros are stored on
a stack that grows as needed if calls of user-defined macros are
nested or recursive.  Individual stack entries contain dynamically
allocated arrays of pointers to arguments; these argument arrays
also grow as needed if user-defined macros take more than eight
arguments.  The mistake was that argument arrays of already
initialized expansion contexts were leaked rather than reused on
subsequent macro calls.

I found this issue in a systematic hunt for memory leaks after
Michael <Stapelberg at Debian> reported memory exhaustion problems
on the production server manpages.debian.org.  This sub-Megabyte
leak is not the cause of Michael's trouble, though, where Gigabytes
of memory are being wasted.  We are still investigating whether the
original problem may be related to his supervisor process, which is
written in Go, rather than to mandoc.
usr.bin/mandoc/roff.c