flowbber.plugins.sources.valgrind.helgrind

Valgrind Helgrind

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

Such XML file can be generated with:

$ valgrind \
    --tool=helgrind \
    --gen-suppressions=all \
    --read-var-info=yes \
    --error-exitcode=1 \
    --xml=yes \
    --xml-file=helgrind.xml \
    ./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.

{
    "protocolversion":"4"
    "protocoltool":"helgrind"
    "preamble":{
        "line":[
            "Helgrind, a thread error detector",
            "Copyright (C) 2007-2015, and GNU GPL'd, by OpenWorks LLP et al.",
            "Using Valgrind-3.11.0 and LibVEX; rerun with -h for copyright info",
            "Command: ./binary"
        ]
    },
    "pid":"11023"
    "ppid":"2162",
    "tool": "helgrind"
    "args":{
        "vargv":{
            "exe":"/usr/bin/valgrind.bin",
            "arg":[
                "--tool=helgrind",
                "--gen-suppressions=all",
                "--read-var-info=yes",
                "--error-exitcode=1",
                "--xml=yes",
                "--xml-file=helgrind.xml",
            ]
        },
        "argv":{
            "exe":"./binary",
            "arg":[]
        }
    }
    "status":[
        {
            "state":"RUNNING",
            "time":"00:00:00:01.593"
        },
        {
            "state":"FINISHED",
            "time":"00:00:00:58.060"
        }
    ],
    "total_errors": 1,
    "error":[
        {
            "unique":"0x968"
            "tid":"4",
            "kind":"Race",
            "xwhat":[
                    {
                        "text":"Possible data race during write of size 1 at 0x12CD1C28 by thread #4",
                        "hthreadid":"4"
                    }
            ],
            "stack":[
                {
                    "frame":[
                        {
                            "ip":"0xED467F",
                            "obj":"/home/library/binary",
                            "fn":"check_thread",
                            "dir":"/home/library",
                            "file":"hello.cpp"
                            "line":"76",
                        },
                        {
                            "ip":"0xED4DF2",
                            "obj":"/home/library/binary",
                            "fn":"main",
                            "dir":"/home/library",
                            "file":"hello.cpp"
                            "line":"130",
                        },
                    ],
                    "frame":[
                        {
                            "ip":"0xED467F",
                            "obj":"/home/library/binary",
                            "fn":"thread_exists",
                            "dir":"/home/library",
                            "file":"hello.cpp"
                            "line":"234",
                        },
                        {
                            "ip":"0xED9402",
                            "obj":"/home/library/binary",
                            "fn":"main",
                            "dir":"/home/library",
                            "file":"hello.cpp"
                            "line":"130",
                        },
                    ],
                },
            ],
            "auxwhat":"Location 0x12cd1c28 is 0 bytes inside thread_data[1].valid,"
        }
    ],
}

Dependencies:

pip3 install flowbber[valgrind_helgrind]

Usage:

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

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

{
    "sources": [
        {
            "type": "valgrind_helgrind",
            "id": "...",
            "config": {
                "xmlpath": "helgrind.xml"
            }
        }
    ]
}

xmlpath

Path to Valgrind’s Helgrind XML output.

• Default: N/A

• Optional: False

• Schema:

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

• Secret: False

Classes

• ValgrindHelgrindSource: Main base class to implement a Source.

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

Inheritance