xref: /xnu-8020.121.3/tools/lldbmacros/usertaskgdbserver.py (revision fdd8201d7b966f0c3ea610489d29bd841d358941)

from __future__ import absolute_import, print_function

from xnu import *
import logging
_usertaskdebugging_availabe = False
try:
    from usertaskdebugging import userprocess
    from usertaskdebugging import gdbserver
    _usertaskdebugging_availabe = True
except ImportError:
    pass

def setupLogging(debug_level):
    log_level = debug_level
    log_filename = "/tmp/kdbserver.log"
    logging.basicConfig(level=log_level,
                      format='%(asctime)s %(module)s %(levelname)s: %(message)s',
                      datefmt='%Y-%m-%d %H:%M:%S')


@lldb_command('beginusertaskdebugging', 'DW')
def DoUserTaskDebuggingServer(cmd_args = [], cmd_options ={}):
    """ starts a gdb protocol server that is backed by <task_t> in kernel debugging session.
        Usage: (lldb) beginusertaskdebugging <task_t>
        options: -D for debug level logging
                 -W for warning level logging.
        default is error level logging
    """
    if not _usertaskdebugging_availabe:
        print("You do not have the usertask debugging files available. ")
        return
    log_level = logging.INFO
    if '-D' in cmd_options:
        log_level = logging.DEBUG
    elif '-W' in cmd_options:
        log_level = logging.WARNING

    setupLogging(debug_level=log_level)
    if not cmd_args:
        raise ArgumentError("Please provide valid task argument.")

    t = kern.GetValueFromAddress(cmd_args[0], 'task_t')

    up = userprocess.UserProcess(t)
    gbs = gdbserver.GDBServer(up)
    print("Starting debug session for %s at localhost:%d." % (GetProcNameForTask(t), gbs.portnum))
    gbs.run()
    print("stopped the debug session")