Skip to main content

malloc-tag tools

This README describes the Python-based tools to postprocess malloc-tag JSON snapshots:

  • mtag-json2dot
  • mtag-postprocess

How to install

Installing these utilities from pypi is really simple:

pip3 install --upgrade malloctag-tools

Rendering

A basic step to enable the visual inspection of the results of a malloc-tag instrumented application is to use the mtag-json2dot utility on the output JSON snapshots:

mtag-json2dot --output nice-picture.svg  <malloc-tag-snapshot-file.json>

Check the top-level README for example of generated SVG output. Note that despite the name mtag-json2dot can produce a variety of output file, supported by the Graphviz engine: .dot, .svg, .svgz, .jpeg, .png, etc.

Postprocess

It might happen that inside your C/C++ application you have several threads running the same code. In this case the pure snapshot provided by the malloc-tag framework (where 1 thread means 1 tree) can be hard to read/follow. In such cases you might want to aggregate together all memory operations done by hese identical threads.

The tool mtag-postprocess makes this very simple. An example usage follows.

Let's assume you need to aggregate the memory alloc/frees done by all threads having the prefix MyThreadPrefix. First of all create a suitable config agg_config.json:

{
    "comment": "This is a simple example of postprocessing rule",
    "rule0": {
        "aggregate_trees": {
            "matching_prefix": "MyThreadPrefix/*"
        }
    }
}

Then launch the postprocessing utility:

mtag-postprocess  --output post-process-out.json --config agg_config.json    <malloc-tag-snapshot-file.json>

The output file is a JSON file with the same identical format used by malloc-tag C++ library. This allows to easily chain and combine different post-processing steps.

The post-processed JSON file can then be used as input of the mtag-json2dot utility. As an example check this picture:

multithread_aggregated_example_svg

And compare it against the non-aggregated picture:

multithread_example_svg

You can see the configuration file used to produce such picture with the mtag-postprocess tool here.

Metadata

Release files for malloctag-tools 1.5.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for malloctag-tools 1.5.4
File Size Uploaded Provenance Actions
malloctag_tools-1.5.4.tar.gz 11.5 kB With provenance Details for malloctag_tools-1.5.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for malloctag-tools 1.5.4
File Interpreter ABI Platform Actions
malloctag_tools-1.5.4-py3-none-any.whl Python 3 none any Details for malloctag_tools-1.5.4-py3-none-any.whl

Total release size: 22.6 kB

Release files / malloctag_tools-1.5.4.tar.gz

Download URL malloctag_tools-1.5.4.tar.gz
Size 11.5 kB
Tags Source
SHA-256 checksum
How to use checksums
1e8de07e261cce45e582554c81b394d01d0ecc20eb53580feba827936077a470
BLAKE2b-256 checksum
How to use checksums
48364149e096082b2915f49332013d924b752740abc12066c5bfaeaaeff15e73
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 23, 2025.

Transparency log

Release files / malloctag_tools-1.5.4-py3-none-any.whl

Download URL malloctag_tools-1.5.4-py3-none-any.whl
Size 11.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
be116f52799a6c203a505cb81bedc4206a1e4b09a5edf79d351888b0750f5133
BLAKE2b-256 checksum
How to use checksums
bbde46d8f345c3a3d725eb4878caa13ab86f46eb0683d697cc0d02b176a86510
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 23, 2025.

Transparency log

Security for malloctag-tools 1.5.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for malloctag_tools-1.5.4.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Apr 23, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page