fluffos/docs/efun/internals/check_memory.md
gesslar 6e6d1c772b
docs: flesh out 31 TBW efun reference pages (#1248)
* empty

* docs: flesh out 31 TBW efun reference pages

Replace the placeholder "TBW" DESCRIPTION and type-only SYNOPSIS in 31
efun docs with real descriptions and named parameters, verified against
the driver source:

- math (general/): log10, log2, norm, dotprod, distance, angle
- matrix (general/): id_matrix, translate, scale, rotate_x/y/z,
  lookat_rotate, lookat_rotate2 -- note the in-place mutation of the
  passed matrix and that rotations are in degrees
- compress (general/): compress, uncompress, compress_file,
  uncompress_file -- note the file variants delete the source on success
- interactive/: send_zmp, act_mxp, request_term_type,
  start_request_term_type, request_term_size
- internals/: dump_trace, destructed_objects, check_memory (flag
  bitmask + DEBUGMALLOC build requirement), dump_stralloc, dump_jemalloc
- core: next_bit, explode_reversible, shallow_inherit_list

Each page keeps the existing manpage-style layout (4-space-indented
NAME/SYNOPSIS/DESCRIPTION, name(3) SEE ALSO). Example blocks are indented
to match, so all files are markdownlint-clean.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-11 22:07:47 -04:00

950 B

title
internals / check_memory

check_memory

NAME

check_memory() - verify tracked memory allocations and report

SYNOPSIS

string check_memory(int flag);

DESCRIPTION

Walks every tracked memory allocation, verifying block integrity and
reference counts, and returns the resulting report as a string.

`flag` is a bitmask, defaulting to 0 (a full report with no totals
table):

Bit 0 (value 1)  Additionally appends a per-source allocation totals
                 table, listing block counts and byte totals broken
                 down by allocation source.
Bit 1 (value 2)  Runs silently -- suppresses the warnings and report
                 and returns 0 instead of the report string.

This efun is available only in DEBUGMALLOC builds (compiled with
DEBUGMALLOC_EXTENSIONS); it does not exist in ordinary builds.

SEE ALSO

dump_stralloc(3), reclaim_objects(3)