flowbber.plugins.sources.valgrind.memcheck

Valgrind Memcheck

This source parses and collects information from the XML generated by Valgrind’s Memcheck tool.

Such XML file can be generated with:

$ valgrind \
    --tool=memcheck \
    --xml=yes \
    --xml-file=memcheck.xml \
    --leak-check=full \
    ./executable

Data collected:

Important

Sadly, Valgrind’s XML format doesn’t include a field with the total number of errors, just an array of which errors were found. A total_errors field is injected to allow the user to easily track the evolution of the amount of errors.

{
    "status":[
        {
            "state":"RUNNING",
            "time":"00:00:00:00.268"
        },
        {
            "state":"FINISHED",
            "time":"00:00:00:59.394"
        }
    ],
    "ppid":"4242",
    "preamble":{
        "line":[
            "Memcheck, a memory error detector",
            "Copyright (C) 2002-2015, and GNU GPL'd, by Julian Seward et al.",
            "Using Valgrind-3.11.0 and LibVEX; rerun with -h for copyright info",
            "Command: ./binary"
        ]
    },
    "suppcounts":{
        "pair":[
            {
                "name":"reachable memory from libstdc++ pool",
                "count":"1"
            }
        ]
    },
    "pid":"424242",
    "errorcounts":null,
    "protocoltool":"memcheck",
    "protocolversion":"4",
    "tool":"memcheck",
    "total_errors": 1,
    "error":[
        {
            "kind":"Leak_DefinitelyLost",
            "stack":{
                "frame":[
                    {
                        "obj":"/usr/lib/valgrind/vgpreload_memcheck-amd64-linux.so",
                        "ip":"0x4C2FB55",
                        "fn":"calloc"
                    },
                    {
                        "dir":"/home/library",
                        "obj":"/home/library/binary",
                        "line":"76",
                        "ip":"0xED467F",
                        "fn":"hello_world()",
                        "file":"hello.cpp"
                    },
                ]
            },
            "xwhat":{
                "leakedblocks":"1",
                "text":"8 bytes in 1 blocks are definitely lost in loss record 1 of 5",
                "leakedbytes":"8"
            },
            "tid":"1",
            "unique":"0x0"
        }
    ],
    "args":{
        "vargv":{
            "exe":"/usr/bin/valgrind.bin",
            "arg":[
                "--track-origins=yes",
                "--leak-check=full",
                "--show-leak-kinds=all",
                "--errors-for-leak-kinds=definite",
                "--error-exitcode=1",
                "--xml=yes",
                "--xml-file=memcheck.xml",
                "--suppressions=/home/library/suppressions.supp"
            ]
        },
        "argv":{
            "exe":"./binary",
            "arg":[]
        }
    }
}

Dependencies:

pip3 install flowbber[valgrind_memcheck]

Usage:

[[sources]]
type = "valgrind_memcheck"
id = "..."

    [sources.config]
    xmlpath = "memcheck.xml"

{
    "sources": [
        {
            "type": "valgrind_memcheck",
            "id": "...",
            "config": {
                "xmlpath": "memcheck.xml"
            }
        }
    ]
}

xmlpath

Path to Valgrind’s Memcheck XML output.

• Default: N/A

• Optional: False

• Schema:

  {
      'type': 'string',
      'empty': False,
  }
  

• Secret: False

Classes

• ValgrindMemcheckSource: Main base class to implement a Source.

class flowbber.plugins.sources.valgrind.memcheck.ValgrindMemcheckSource(index, type_, id_, optional=False, timeout=None, config=None)

Inheritance