Skip to content
Snippets Groups Projects
Select Git revision
  • 76fe732dd29d8b87ca8e2315fd915876659c4130
  • test default
2 results

linux-ramdump-parser-v2

  • Clone with SSH
  • Clone with HTTPS
  • user avatar
    Mitchel Humpherys authored
    We don't support python3 at all and python2.6 can only be used if the
    user installs an extra package (OrderedDict [1]). Ask for python2
    explicitly in the shebang line to resolve the python3 issues and print
    some instructions to the user regarding python2.6 when that is used.
    
    If the user insists on using python2.6, provide a command line
    switch (--force-26) to skip the version check. To reduce clutter, don't
    document this switch in the --help text but inform the user about its
    existence when we error out due to the python2.6 check.
    
    In order to even print an error message in python3 we have to first
    ensure that our code is valid in python3, otherwise the interpreter
    fails to even start executing our code (so we can't print any
    messages). Use 2to3 to patch up some print statements, etc. Also fix
    inconsistent whitespace, which is a syntax error on python3.
    
    [1] https://pypi.python.org/pypi/ordereddict
    
    Change-Id: Ie2c0a200e60ec90bf6cf49789f2cc75f181fa94b
    76fe732d
    History
    Python Linux Ramdump Parser
    
    What does this tool do?
    ----------------------------------
    This tool takes as its input a vmlinux symbol file, and files representing
    memory from devices that run Linux. It proceeds to dump useful information
    such as process stacks, IRQ and workqueue information.
    
    What does this tool need?
    ----------------------------------
    1) Python. This tool has been tested with Python 2.6.5 on both Linux and Windows
    1) a set of RAM dumps. Ideally, the load location of each dump as well.
    2) The corresponding vmlinux file
    
    How is this tool invoked?
    ----------------------------------
    python ramparse.py invokes the parser. Options:
    
    --ram-file <file path> <start> <end> : Add this ram file to be parsed.
    At least one of --ram-file and --auto-dump required
    
    --vmlinux <path> : path for vmlinux to use. This is required
    
    --auto-dump <path to folder> : Automatically find files for a RAM dump and
    detect useful informaton.
    
    --gdb-path <path> : path for the GNU gdb debugger. If no path is given, the
    path will be used from local_settings.py
    
    --gdb-path <path> : path for the nm tool. If no path is given, the
    path will be used from local_settings.py
    
    --outdir <path> : Output directory to store any files written. If no path is
    given, the ramfile directory will be used if given, else the current directory
    will be used.
    
    --out-file <path> : File to write all output to. If no path is given,
    linux-parser-output.txt is used
    
    --stdout : Write to stdout instead of the out-file. This overrides any
    --out-file given.
    
    The list of features parsed is constantly growing. Please use --help option
    to see the full list of features that can be parsed.
    
    System requirements
    -------------------------------
    Python 2.7 is required to run this tool. It can be downloaded and
    installed from https://www.python.org/ or through your system's
    software package manager.
    
    Setting up the toolchains
    -------------------------------
    The parser relies on having access to gdb and nm to work. You will need to
    specify the paths to these tools. This can be done in three ways
    
    1) Using --gdb-path and --nm-path to specify the absolute path
    2) Using CROSS_COMPILE to specify the prefix
    3) Using local_settings.py as described below
    
    Just having gdb/nm on the path is not supported as there are too many
    variations on names to invoke.
    
    local_settings.py
    -------------------------------
    The parser attempts to figure out most of the settings automatically but there
    are some settings that are unique to the environment of the running system.
    These must be specified in local_settings.py. The current format for the file
    is
    
    <setting name> = <string identifying the feaure>
    
    Currently supported features:
    gdb_path - absolute path to the gdb tool for the ramdumps
    nm_path - absolute path to the gdb tool for the ramdumps
    gdb64_path - absolute path to the 64-bit gdb tool for the ramdumps
    nm64_path - absolute path to the 64-bit nm tool for the ramdumps
    
    Note that local_settings.py is just a python file so the file may take advantage
    of python features.