Barman use case script

Streamline generates the file barman_in_memory_helpers.py with the Barman agent sources when you select an in-memory data storage backend. You can use it as a use case script in Arm® Development Studio to help you dump the contents of the in-memory capture buffer.

Run the script with the following command:

usecase run "barman_in_memory_helpers.py" <usecase_command>

Two use case commands are available:

get_parameters

Prints the current details of the buffer and information about how to dump it.

dump

Dumps the contents of the memory buffer in a file that you specify with the option --file <PATH> .

Examples

The following examples show how to use these use case commands.

  • To use the get_parameters use case command, enter:

    usecase run "barman_in_memory_helpers.py" get_parameters

    Output:

    Barman memory buffer details:
    Base address: 0x0000000000001580
    Dump length: 1787404
    Bytes written: 1785996 of 67099264 (2.7%)

To dump this buffer use the command:
    dump memory <PATH> 0x1580 +1787404
Or use the usecase command 'dump':
    usecase run "barman_in_memory_helpers.py" dump --file <PATH>

  • To use the dump use case command, enter:

    usecase run "barman_in_memory_helpers.py" dump --file barman.raw

    Output:

    Executing command:
    dump binary memory "barman.raw" 0x1580 +1787404

Memory successfully dumped to file barman.raw