mallocng ¤

search_on_fail = add_param(
    "ng-search-on-fail",
    True,
    "let the ng-slot* commands search the heap if necessary",
    help_docstring="\nFor freed, avail(able) and corrupted slots, it may be\nimpossible to recover the start of the group and meta.\n\nWhen this option is set to True, the ng-slotu and ng-slots\ncommands will search the heap to try to find the correct meta/group.\n    ",
    param_class=PARAM_BOOLEAN,
    scope=heap,
)

state_alloc_color = BLUE

state_alloc_color_alt = CYAN

state_freed_color = RED

state_freed_color_alt = LIGHT_RED

state_avail_color = GRAY

state_avail_color_alt = LIGHT_GRAY

VALID_CHARS = list(map(ord, set(printable) - set('\t\r\n\x0c\x0b')))

vis_cyclic_offset_color = YELLOW

vis_offset_color = LIGHT_YELLOW

vis_cycled_mark_color = PURPLE

vis_pn3_reserved_color = LIGHT_CYAN

vis_big_offset_check_color = BLACK

vis_ftr_reserved_color = GREEN

default_vis_count = add_param(
    "ng-vis-count",
    10,
    "default count for ng-vis",
    param_class=PARAM_UINTEGER,
    scope=heap,
)

parser = ArgumentParser(
    description="Utility for inspecting the mallocng (musl) allocator."
)

subparsers = add_subparsers(dest='command')

explain_parser = add_parser(
    "explain",
    description="Gives a quick explanation of musl's mallocng allocator.",
    help="Gives a quick explanation of musl's mallocng allocator.",
)

dump_parser = add_parser('dump', description=f'
Dump the mallocng heap.

Since the command may produce lots of output, you may want to pipe it to
less with `| ng-dump | less -R`.

The [index] next to the metas is their index in the doubly linked list
pointed to by ctx.freed_meta_head. The [index] next to the slots is
the slot's index inside of its group (thus, these will always be sequential).

Notice that the pointers in the output of this command aren't colored according
to their mapping's color but rather according to the object's allocation status.
Color legend: {colorize('allocated', state_alloc_color)}; {colorize('freed', state_freed_color)}; {colorize('available', state_avail_color)}.
', help='Dump the mallocng heap.')

vis_parser = add_parser(
    "vis",
    description="Visualize slots in a group.",
    help="Visualize slots in a group.",
)

find_parser = add_parser(
    "find",
    description="\nFind slot which contains the given address.\n\nReturns the `start` of the slot. We say a slot 'contains'\nan address if the address is in [start, start + stride).\n    ",
    help="Find slot which contains the given address.",
)

ctx_parser = add_parser(
    "ctx",
    description="Print out the mallocng __malloc_context (ctx) object.",
    help="Print out the mallocng __malloc_context (ctx) object.",
)

metaarea_parser = add_parser(
    "metaarea",
    aliases=["ma"],
    description="Print out a mallocng meta_area object at the given address.",
    help="Print out a mallocng meta_area object at the given address.",
)

group_parser = add_parser(
    "group",
    description="Print out information about a mallocng group at the given address.",
    help="Print out information about a mallocng group at the given address.",
)

meta_parser = add_parser(
    "meta",
    description="Print out information about a mallocng group given the address of its meta.",
    help="Print out information about a mallocng group given the address of its meta.",
)

slots_parser = add_parser(
    "slots",
    description="Dump information about a mallocng slot, given its start address.",
    help="Dump information about a mallocng slot, given its start address.",
)

slotu_parser = add_parser(
    "slotu",
    description="Dump information about a mallocng slot, given its user address.",
    help="Dump information about a mallocng slot, given its user address.",
)