blob: 17ec19e9b5bf6a93e95e224cc21c88320c5ad4ba [file] [log] [blame]
Jan Kiszka7704d582015-02-17 13:47:07 -08001#
2# gdb helper commands and functions for Linux kernel debugging
3#
4# task & thread tools
5#
6# Copyright (c) Siemens AG, 2011-2013
7#
8# Authors:
9# Jan Kiszka <jan.kiszka@siemens.com>
10#
11# This work is licensed under the terms of the GNU GPL version 2.
12#
13
14import gdb
15
16from linux import utils
17
18
19task_type = utils.CachedType("struct task_struct")
20
Thiébaud Weksteen6ad18b72015-06-30 14:58:18 -070021
Daniel Wagner54e22892015-02-17 13:47:41 -080022def task_lists():
Daniel Wagner54e22892015-02-17 13:47:41 -080023 task_ptr_type = task_type.get_type().pointer()
24 init_task = gdb.parse_and_eval("init_task").address
25 t = g = init_task
Jan Kiszka7704d582015-02-17 13:47:07 -080026
Daniel Wagner54e22892015-02-17 13:47:41 -080027 while True:
28 while True:
29 yield t
Jan Kiszka7704d582015-02-17 13:47:07 -080030
Daniel Wagner54e22892015-02-17 13:47:41 -080031 t = utils.container_of(t['thread_group']['next'],
32 task_ptr_type, "thread_group")
33 if t == g:
34 break
Jan Kiszka7704d582015-02-17 13:47:07 -080035
Daniel Wagner54e22892015-02-17 13:47:41 -080036 t = g = utils.container_of(g['tasks']['next'],
37 task_ptr_type, "tasks")
38 if t == init_task:
39 return
Jan Kiszka47528712015-02-17 13:47:10 -080040
Thiébaud Weksteen6ad18b72015-06-30 14:58:18 -070041
Jan Kiszka47528712015-02-17 13:47:10 -080042def get_task_by_pid(pid):
Daniel Wagner54e22892015-02-17 13:47:41 -080043 for task in task_lists():
Jan Kiszka47528712015-02-17 13:47:10 -080044 if int(task['pid']) == pid:
45 return task
46 return None
47
48
49class LxTaskByPidFunc(gdb.Function):
50 """Find Linux task by PID and return the task_struct variable.
51
52$lx_task_by_pid(PID): Given PID, iterate over all tasks of the target and
53return that task_struct variable which PID matches."""
54
55 def __init__(self):
56 super(LxTaskByPidFunc, self).__init__("lx_task_by_pid")
57
58 def invoke(self, pid):
59 task = get_task_by_pid(pid)
60 if task:
61 return task.dereference()
62 else:
63 raise gdb.GdbError("No task of PID " + str(pid))
64
65
66LxTaskByPidFunc()
Jan Kiszkacf7492e2015-02-17 13:47:15 -080067
68
Thiébaud Weksteena9308502015-06-30 14:58:21 -070069class LxPs(gdb.Command):
70 """Dump Linux tasks."""
71
72 def __init__(self):
73 super(LxPs, self).__init__("lx-ps", gdb.COMMAND_DATA)
74
75 def invoke(self, arg, from_tty):
Ritesh Harjani4fbe3102020-10-15 20:13:32 -070076 gdb.write("{:>10} {:>12} {:>7}\n".format("TASK", "PID", "COMM"))
Thiébaud Weksteena9308502015-06-30 14:58:21 -070077 for task in task_lists():
Ritesh Harjani4fbe3102020-10-15 20:13:32 -070078 gdb.write("{} {:^5} {}\n".format(
79 task.format_string().split()[0],
80 task["pid"].format_string(),
81 task["comm"].string()))
Thiébaud Weksteena9308502015-06-30 14:58:21 -070082
Stephen Boyd494dbe02019-05-14 15:46:02 -070083
Thiébaud Weksteena9308502015-06-30 14:58:21 -070084LxPs()
85
86
Jan Kiszkacf7492e2015-02-17 13:47:15 -080087thread_info_type = utils.CachedType("struct thread_info")
88
89ia64_task_size = None
90
91
92def get_thread_info(task):
Jan Kiszkacf7492e2015-02-17 13:47:15 -080093 thread_info_ptr_type = thread_info_type.get_type().pointer()
94 if utils.is_target_arch("ia64"):
95 global ia64_task_size
96 if ia64_task_size is None:
97 ia64_task_size = gdb.parse_and_eval("sizeof(struct task_struct)")
98 thread_info_addr = task.address + ia64_task_size
99 thread_info = thread_info_addr.cast(thread_info_ptr_type)
100 else:
Xi Kangjie883d50f2018-01-18 16:34:00 -0800101 if task.type.fields()[0].type == thread_info_type.get_type():
102 return task['thread_info']
Jan Kiszkacf7492e2015-02-17 13:47:15 -0800103 thread_info = task['stack'].cast(thread_info_ptr_type)
104 return thread_info.dereference()
105
106
107class LxThreadInfoFunc (gdb.Function):
108 """Calculate Linux thread_info from task variable.
109
110$lx_thread_info(TASK): Given TASK, return the corresponding thread_info
111variable."""
112
113 def __init__(self):
114 super(LxThreadInfoFunc, self).__init__("lx_thread_info")
115
116 def invoke(self, task):
117 return get_thread_info(task)
118
119
120LxThreadInfoFunc()
Kieran Bingham9f66dee2016-05-23 16:25:13 -0700121
122
123class LxThreadInfoByPidFunc (gdb.Function):
124 """Calculate Linux thread_info from task variable found by pid
125
126$lx_thread_info_by_pid(PID): Given PID, return the corresponding thread_info
127variable."""
128
129 def __init__(self):
130 super(LxThreadInfoByPidFunc, self).__init__("lx_thread_info_by_pid")
131
132 def invoke(self, pid):
133 task = get_task_by_pid(pid)
134 if task:
135 return get_thread_info(task.dereference())
136 else:
137 raise gdb.GdbError("No task of PID " + str(pid))
138
Stephen Boyd494dbe02019-05-14 15:46:02 -0700139
Kieran Bingham9f66dee2016-05-23 16:25:13 -0700140LxThreadInfoByPidFunc()