ldrp-v2: Add support for lockdep parsing of heldlocks.

Initial changes to add held locks parsing, if lockdep
is enabled. Enable extracting lockdep data structure
for held locks debugging.
usage: '--lockdep-heldlocks' can be added in parser configs
to extract lockdep held locks.

Change-Id: I6d137bda6be2d2ff7b6c6bf10eb6defad2ceef25
Signed-off-by: Mayank Grover <groverm@codeaurora.org>

linux-ramdump-parser-v2/parsers/lockdep.py

+# Copyright (c) 2019 The Linux Foundation. All rights reserved.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 and
+# only version 2 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+from parser_util import register_parser, RamParser, cleanupString
+from print_out import print_out_str
+
+def parse_held_locks(ramdump, task, my_task_out):
+	task_held_locks_offset = ramdump.field_offset('struct task_struct',  'held_locks')
+	held_locks = task + task_held_locks_offset
+	sizeof_held_lock = ramdump.sizeof('struct held_lock')
+	task_lockdep_depth = ramdump.read_structure_field(task, 'struct task_struct', 'lockdep_depth')
+	my_task_out.write('lockdep_depth: {0}\n'.format(hex(task_lockdep_depth)))
+
+	for i in range (0, task_lockdep_depth):
+		held_lock_indx = held_locks + (i * sizeof_held_lock)
+		hl_prev_chain_key = ramdump.read_structure_field(held_lock_indx, 'struct held_lock', 'prev_chain_key')
+		hl_acquire_ip = ramdump.read_structure_field(held_lock_indx, 'struct held_lock','acquire_ip')
+		hl_acquire_ip_caller = ramdump.read_structure_field(held_lock_indx, 'struct held_lock','acquire_ip_caller')
+		if hl_acquire_ip_caller is None:
+			hl_acquire_ip_caller = 0x0
+		hl_instance = ramdump.read_structure_field(held_lock_indx, 'struct held_lock', 'instance')
+		hl_nest_lock = ramdump.read_structure_field(held_lock_indx, 'struct held_lock', 'nest_lock')
+		if (ramdump.is_config_defined('CONFIG_LOCK_STAT')):
+			hl_waittime_stamp = ramdump.read_structure_field(held_lock_indx, 'struct held_lock', 'waittime_stamp')
+			hl_holdtime_stamp = ramdump.read_structure_field(held_lock_indx, 'struct held_lock', 'holdtime_stamp')
+		hl_class_idx_full = hl_class_idx = ramdump.read_structure_field(held_lock_indx, 'struct held_lock', 'class_idx')
+		hl_class_idx = hl_class_idx_full & 0x00001FFF
+		hl_irq_context = (hl_class_idx_full & 0x00006000) >> 13
+		hl_trylock = (hl_class_idx_full & 0x00008000) >> 15
+		hl_read = (hl_class_idx_full & 0x00030000) >> 16
+		hl_check = (hl_class_idx_full & 0x00040000) >> 18
+		hl_hardirqs_off = (hl_class_idx_full & 0x00080000) >> 19
+		hl_references = (hl_class_idx_full & 0xFFF00000) >> 20
+		hl_pin_count = ramdump.read_structure_field(held_lock_indx, 'struct held_lock', 'pin_count')
+		if (ramdump.is_config_defined('CONFIG_LOCKDEP_CROSSRELEASE')):
+			hl_gen_id = ramdump.read_structure_field(held_lock_indx, 'struct held_lock', 'gen_id')
+
+		my_task_out.write(
+				'held_locks[{0}] [0x{1:x}]:\
+				\n\tprev_chain_key = {2},\
+				\n\tacquire_ip = {3},\
+				\n\tacquire_ip_caller = {4},\
+				\n\tinstance = {5},\
+				\n\tnest_lock = {6}\
+				\n\tclass_idx = {7},\
+				\n\tirq_context = {8},\
+				\n\ttrylock = {9},\
+				\n\tread = {10},\
+				\n\tcheck = {11},\
+				\n\thardirqs_off = {12},\
+				\n\treferences = {13},\
+				\n\tpin_count = {14}'.format(
+							i, held_lock_indx,
+							hex(hl_prev_chain_key),
+							hex(hl_acquire_ip),
+							hex(hl_acquire_ip_caller),
+							hex(hl_instance),
+							hex(hl_nest_lock),
+							hex(hl_class_idx),
+							hex(hl_irq_context),
+							hex(hl_trylock),
+							hex(hl_read),
+							hex(hl_check),
+							hex(hl_hardirqs_off),
+							hex(hl_references),
+							hex(hl_pin_count)))
+		if (ramdump.is_config_defined('CONFIG_LOCK_STAT')):
+			my_task_out.write(
+				'\n\twaittime_stamp = {0},\
+				\n\tholdtime_stamp = {1}'.format(
+							hex(hl_waittime_stamp),
+							hex(hl_holdtime_stamp)))
+		if (ramdump.is_config_defined('CONFIG_LOCKDEP_CROSSRELEASE')):
+			my_task_out.write(
+				'\n\tgen_id = {0}'.format( hex(hl_gen_id)))
+		my_task_out.write('\n\n')
+
+def parse_mytaskstruct(ramdump):
+	my_task_out = ramdump.open_file('lockdep.txt')
+	my_task_out.write('============================================\n')
+	task_comm_offset = ramdump.field_offset('struct task_struct',  'comm')
+	task_pid_offset = ramdump.field_offset('struct task_struct',  'pid')
+	for task in ramdump.for_each_process():
+		next_thread_comm = task + task_comm_offset
+		thread_task_name = cleanupString(ramdump.read_cstring(next_thread_comm, 16))
+		next_thread_pid = task + task_pid_offset
+		thread_task_pid = ramdump.read_int(next_thread_pid)
+		my_task_out.write('\nProcess: {0}, [Pid: {1} Task: 0x{2:x}]\n'.format(
+													thread_task_name, thread_task_pid, task))
+		parse_held_locks(ramdump, task, my_task_out)
+	my_task_out.write('============================================\n')
+	my_task_out.close()
+	print_out_str('----wrote lockdep held locks info')
+
+@register_parser('--lockdep-heldlocks', 'Extract lockdep held locks info per task from ramdump')
+
+class MyTaskStruct(RamParser):
+		def parse(self):
+			if (self.ramdump.is_config_defined('CONFIG_LOCKDEP')):
+				print_out_str('----dumping lockdep held locks info')
+				parse_mytaskstruct(self.ramdump)