-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add thread tracking extension to myst-gdb
- Loading branch information
Zijie Wu
committed
Sep 13, 2022
1 parent
0fbb661
commit a2e83ec
Showing
8 changed files
with
301 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,283 @@ | ||
| import gdb | ||
| import math | ||
| import tempfile | ||
| from typing import List | ||
|
|
||
| DEBUG = False | ||
|
|
||
| INSTANCE_DEBUG_EXT = None | ||
|
|
||
| class ThreadCloneBreakpoint(gdb.Breakpoint): | ||
| def __init__(self): | ||
| """ | ||
| Set a breakpoint @ kernel/syscall.c::_SYS_myst_clone | ||
| Choosing this location because this is where the parent process/thread creates new process/thread | ||
| We can get the parent pid/tid from here | ||
| """ | ||
| super(ThreadCloneBreakpoint, self).__init__('kernel/syscall.c:4094', internal=False) | ||
|
|
||
| def stop(self): | ||
| # Get Parent thread info | ||
| ppid = int(gdb.parse_and_eval('myst_thread_self()->process->ppid')) | ||
| pid = int(gdb.parse_and_eval('myst_thread_self()->process->pid')) | ||
| tid = int(gdb.parse_and_eval('myst_thread_self()->tid')) | ||
| tid_target = int(gdb.parse_and_eval('myst_thread_self()->target_tid')) | ||
| print("Parent thread: ppid, pid, tid, tid_target", ppid, pid, tid, tid_target) | ||
|
|
||
| INSTANCE_DEBUG_EXT.add_thread(pid, tid, ppid, tid_target) | ||
| return False | ||
|
|
||
| class ThreadCreateBreakpoint(gdb.Breakpoint): | ||
| def __init__(self): | ||
| """ | ||
| Set a breakpoing @ kernel/thread.c::_run_thread, this should be right before myst_setjmp(&thread->jmpbuf) | ||
| Choosing this location because this is where the newly created thread about to run | ||
| We can get the new thread pid/tid here | ||
| """ | ||
| super(ThreadCreateBreakpoint, self).__init__('kernel/thread.c:978', internal=False) | ||
|
|
||
| def stop(self): | ||
| # New thread info | ||
| ppid = int(gdb.parse_and_eval('thread->process->ppid')) | ||
| pid = int(gdb.parse_and_eval('thread->process->pid')) | ||
| tid = int(gdb.parse_and_eval('thread->tid')) | ||
| tid_target = int(gdb.parse_and_eval('thread->target_tid')) | ||
| print("Created thread: ppid, pid, tid, tid_target", ppid, pid, tid, tid_target) | ||
| INSTANCE_DEBUG_EXT.add_thread(pid, tid, ppid, tid_target) | ||
|
|
||
| # Add _main_thread only once as it won't change often | ||
| if not INSTANCE_DEBUG_EXT.main_thread_tracked(): | ||
| ppid = int(gdb.parse_and_eval('_main_thread->process->ppid')) | ||
| pid = int(gdb.parse_and_eval('_main_thread->process->pid')) | ||
| tid = int(gdb.parse_and_eval('_main_thread->tid')) | ||
| tid_target = int(gdb.parse_and_eval('_main_thread->target_tid')) | ||
| print("Main thread: ppid, pid, tid, tid_target", ppid, pid, tid, tid_target) | ||
| INSTANCE_DEBUG_EXT.add_thread(pid, tid, ppid, tid_target) | ||
|
|
||
| return False | ||
|
|
||
| class ThreadExitBreakpoint(gdb.Breakpoint): | ||
| def __init__(self): | ||
| """ | ||
| Set a breakpoint @ kernel/thread.c::_run_thread, where myst_setjmp returns non-zero | ||
| Choosing this location because this is where the newly created thread terminates | ||
| """ | ||
| super(ThreadExitBreakpoint, self).__init__('kernel/thread.c:985', internal=False) | ||
|
|
||
| def stop(self): | ||
| # Get thread info that is about to terminate | ||
| ppid = int(gdb.parse_and_eval('thread->process->ppid')) | ||
| pid = int(gdb.parse_and_eval('thread->process->pid')) | ||
| tid = int(gdb.parse_and_eval('thread->tid')) | ||
| tid_target = int(gdb.parse_and_eval('thread->target_tid')) | ||
| print("Exit thread: ppid, pid, tid, tid_target", ppid, pid, tid, tid_target) | ||
|
|
||
| INSTANCE_DEBUG_EXT.remove_thread(pid, tid) | ||
| return False | ||
|
|
||
| class MystExecBreakpoint(gdb.Breakpoint): | ||
| def __init__(self): | ||
| """ | ||
| Set a breakpoint @ kernel/exec.c::myst_exec, right after `process = thread->process` | ||
| grab program and args to run in Enclave, and cwd | ||
| """ | ||
| super(MystExecBreakpoint, self).__init__('kernel/exec.c:1004', internal=False) | ||
|
|
||
| def parse_string_raw(self, str_raw): | ||
| """ | ||
| Parse the string given the gdb parse_and_eval result | ||
| Example input: | ||
| 0x104df31f0 "/bin/usr/some/path" | ||
| Example return: | ||
| /bin/usr/some/path | ||
| """ | ||
| val = str(str_raw) | ||
| if ' ' not in val: | ||
| return val | ||
|
|
||
| # Don't include " | ||
| return val[val.index(' ') + 2:-1] | ||
|
|
||
| def stop(self): | ||
| # Same as parse and eval *argv@argc | ||
| argc = int(gdb.parse_and_eval('argc')) | ||
|
|
||
| argv_raw = [gdb.parse_and_eval('argv[{0}]'.format(i)) for i in range(argc)] | ||
| cwd_raw = gdb.parse_and_eval('process->cwd') | ||
|
|
||
| argv = [self.parse_string_raw(each) for each in argv_raw] | ||
| cwd = self.parse_string_raw(cwd_raw) | ||
|
|
||
| # Get pid and ppid | ||
| ppid = int(gdb.parse_and_eval('process->ppid')) | ||
| pid = int(gdb.parse_and_eval('process->pid')) | ||
|
|
||
| INSTANCE_DEBUG_EXT.set_process_cmd_cwd(pid, ppid, argv, cwd) | ||
|
|
||
| return False | ||
|
|
||
| class DebugExtension: | ||
| """ | ||
| Manage all breakpoints and program info(process/thread/cmdline/etc) | ||
| """ | ||
|
|
||
| # Configure the default pid/tid for the main process | ||
| # We only gather _main_thread's information once | ||
| pid_main_process = 101 | ||
| tid_main_thread = 101 | ||
|
|
||
| def __init__(self): | ||
| # Disabled as calling 'myst_thread_self()' from gdb seems to cause issues | ||
| # self.bThreadBeforeCreate = ThreadCloneBreakpoint() | ||
|
|
||
| self.bp_thread_create = ThreadCreateBreakpoint() | ||
| self.bp_thread_exit = ThreadExitBreakpoint() | ||
| self.bp_myst_exec = MystExecBreakpoint() | ||
|
|
||
| self.map_commands = { | ||
| 'help': lambda: self._command_help(), | ||
| 'thread': lambda: self._command_list_thread(), | ||
| 'cmdline': lambda: self._command_cmdline(), | ||
| 'exe': lambda: self._command_exe(), | ||
| 'cwd': lambda: self._command_cwd() | ||
| } | ||
|
|
||
| # Store thread info | ||
| # Key: tuple (pid, tid) | ||
| # Value: tuple (pid, tid, ppid, tid_target) | ||
| self.threads = dict() | ||
|
|
||
| # Store process info | ||
| # Key: pid | ||
| # Value: tuple (pid, ppid, command line, cwd) | ||
| # where command line should be list of string | ||
| self.processes = dict() | ||
|
|
||
| self.clear() | ||
|
|
||
| def main_thread_tracked(self): | ||
| return (self.pid_main_process, self.tid_main_thread) in self.threads | ||
|
|
||
| def add_thread(self, pid: int, tid: int, ppid: int, tid_target: int): | ||
| """ | ||
| ppid: parent pid | ||
| tid_target: tid on host | ||
| """ | ||
| self.threads[(pid, tid)] = (pid, tid, ppid, tid_target) | ||
|
|
||
| def remove_thread(self, pid: int, tid: int): | ||
| _key = (pid, tid) | ||
| if _key not in self.threads: | ||
| print("DebugExtension Error: trying to remove non-exist thread ", _key) | ||
| return | ||
| del self.threads[_key] | ||
|
|
||
| def set_process_cmd_cwd(self, pid: int, ppid: int, argv: List[int], cwd: str): | ||
| self.processes[pid] = (pid, ppid, argv, cwd) | ||
|
|
||
| def clear(self): | ||
| self.threads = dict() | ||
| self.processes = dict() | ||
|
|
||
| def dispatch(self, command: str): | ||
| if command not in self.map_commands: | ||
| print("DebugExtension Error: Invalid command, should be one of ", sorted(list(self.map_commands.keys()))) | ||
| return | ||
|
|
||
| self.map_commands[command]() | ||
|
|
||
| def _command_help(self): | ||
| msg = """ | ||
| myst-debug: Mystikos thread tracker | ||
| Commands: | ||
| myst-debug help | ||
| Print this message | ||
| myst-debug thread | ||
| List all tracked threads | ||
| myst-debug cmdline | ||
| List the command line for each process | ||
| myst-debug exe | ||
| List the executable for each process | ||
| myst-debug cwd | ||
| List the current working directory for each process | ||
| """ | ||
| print(msg) | ||
|
|
||
| def _command_list_thread(self): | ||
| if not self.threads: | ||
| print("No threads tracked") | ||
| return | ||
|
|
||
| print("List of Mystikos controlled threads:") | ||
| print("ppid pid tid (target_tid)") | ||
| for key in sorted(self.threads.keys()): | ||
| pid, tid, ppid, target_tid = self.threads[key] | ||
| print("{0} {1} {2} ({3})".format(ppid, pid, tid, target_tid)) | ||
|
|
||
| def _command_cmdline(self): | ||
| """ | ||
| Similiar to gdb command 'info proc cmdline' | ||
| """ | ||
| if not self.processes: | ||
| print("No processes tracked") | ||
| return | ||
|
|
||
| for pid in sorted(self.processes.keys()): | ||
| pid, ppid, cmdline, _ = self.processes[pid] | ||
| print("Process {0} (Parent {1}) cmdline: {2}".format(pid, ppid, " ".join(cmdline))) | ||
|
|
||
| def _command_exe(self): | ||
| """ | ||
| Similiar to gdb command 'info proc exe' | ||
| """ | ||
| if not self.processes: | ||
| print("No processes tracked") | ||
| return | ||
|
|
||
| for pid in sorted(self.processes.keys()): | ||
| pid, ppid, cmdline, _ = self.processes[pid] | ||
| print("Process {0} (Parent {1}) exe: {2}".format(pid, ppid, cmdline[0])) | ||
|
|
||
| def _command_cwd(self): | ||
| """ | ||
| Similiar to gdb command 'info proc cwd' | ||
| """ | ||
| if not self.processes: | ||
| print("No processes tracked") | ||
| return | ||
|
|
||
| for pid in sorted(self.processes.keys()): | ||
| pid, ppid, _, cwd = self.processes[pid] | ||
| print("Process {0} (Parent {1}) cwd: {2}".format(pid, ppid, cwd)) | ||
|
|
||
| command = """ | ||
| define myst-debug | ||
| if $argc == 0 | ||
| python INSTANCE_DEBUG_EXT.dispatch("help") | ||
| end | ||
| if $argc == 1 | ||
| python INSTANCE_DEBUG_EXT.dispatch("$arg0") | ||
| end | ||
| end | ||
| """ | ||
|
|
||
| if __name__ == "__main__": | ||
| INSTANCE_DEBUG_EXT = DebugExtension() | ||
|
|
||
| # Register command with gdb. | ||
| with tempfile.NamedTemporaryFile('w') as f: | ||
| f.write(command) | ||
| f.flush() | ||
| gdb.execute('source %s' % f.name) | ||
|
|
||
| # Register exit_handler | ||
| def exit_handler(event): | ||
| global INSTANCE_DEBUG_EXT | ||
| INSTANCE_DEBUG_EXT.clear() | ||
| gdb.events.exited.connect(exit_handler) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters