kernel-sanitizers/kernel_symbolize.py at master · gitcollect/kernel-sanitizers · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
#!/usr/bin/python

import getopt
import os
import re
import sys
import subprocess

time_re = re.compile(
  '^(?P<time>\[[ ]*[0-9\.]+\]) ?(?P<body>.*)$'
)

frame_re = re.compile(
  '^'                                  +
  '(?P<prefix>[^\[\t]*)'               +
  '(\[\<(?P<addr>[0-9A-Fa-f]+)\>\])?'  +
  '( |\t)'                             +
  '((?P<precise>\?) )?'                +
  '(?P<body>'                          +
    '(?P<function>[^\+]+)'             +
    '\+'                               +
    '0x(?P<offset>[0-9A-Fa-f]+)'       +
    '/'                                +
    '0x(?P<size>[0-9A-Fa-f]+)'         +
    '( \[(?P<module>.+)\])?'           +
  ')$'
)

nm_re = re.compile(
  '^(?P<offset>[0-9A-Fa-f]+) [a-zA-Z] (?P<symbol>[^ ]+)$'
)

class Symbolizer:
  def __init__(self, binary_path):
    self.proc = subprocess.Popen(['addr2line', '-f', '-i', '-e', binary_path],
                                 stdin=subprocess.PIPE, stdout=subprocess.PIPE)

  def __enter__(self):
    return self

  def __exit__(self, type, value, traceback):
    self.Close()

  def Process(self, addr):
    self.proc.stdin.write(addr + '\n')
    self.proc.stdin.write('ffffffffffffffff\n')
    self.proc.stdin.flush()

    result = []
    while True:
      func = self.proc.stdout.readline().rstrip()
      fileline = self.proc.stdout.readline().rstrip()
      if func == '??':
        if len(result) == 0:
          self.proc.stdout.readline()
          self.proc.stdout.readline()
        return result
      result.append((func, fileline))

  def Close(self):
    self.proc.kill()
    self.proc.wait()

def FindFile(path, name):
  path = os.path.expanduser(path)
  for root, dirs, files in os.walk(path):
    if name in files:
      return os.path.join(root, name)
  return None

class SymbolOffsetLoader:
  def __init__(self, binary_path):
    output = subprocess.check_output(['nm', binary_path])
    self.offsets = {}
    for line in output.split('\n'):
      match = nm_re.match(line)
      if match != None:
        self.offsets[match.group('symbol')] = int(match.group('offset'), 16)

  def LookupOffset(self, symbol):
    return self.offsets.get(symbol)

class ReportProcesser:
  def __init__(self, linux_path, strip_path):
    self.strip_path = strip_path
    self.linux_path = linux_path
    self.module_symbolizers = {}
    self.module_offset_loaders = {}
    self.loaded_files = {}

  def ProcessInput(self, lines_before, lines_after):
    for line in sys.stdin:
      line = line.rstrip()
      line = self.StripTime(line)
      self.ProcessLine(line, lines_before, lines_after)

  def StripTime(self, line):
    match = time_re.match(line)
    if match != None:
      line = match.group('body')
    return line

  def ProcessLine(self, line, lines_before, lines_after):
    match = frame_re.match(line)
    if match == None:
      print line
      return

    prefix = match.group('prefix')

    addr = match.group('addr')
    body = match.group('body')

    precise = match.group('precise')
    assert precise == None or precise == '?'
    precise = True if precise == None else False

    function = match.group('function')
    offset = match.group('offset')
    size = match.group('size')
    module = match.group('module')

    if module == None:
      module = 'vmlinux'
    else:
      module += '.ko'

    frames = []

    if not self.LoadModule(module):
      print line
      return

    symbolizer = self.module_symbolizers[module]
    loader = self.module_offset_loaders[module]

    symbol_offset = loader.LookupOffset(function)
    if not symbol_offset:
      print line
      return

    instruction_offset = int(offset, 16)
    module_addr = hex(symbol_offset + instruction_offset - 1);

    frames = symbolizer.Process(module_addr)

    if len(frames) == 0:
      print line
      return

    for i, frame in enumerate(frames):
      inlined = (i + 1 != len(frames))
      func, fileline = frame[0], frame[1]
      fileline = fileline.split(' (')[0] # strip ' (discriminator N)'
      self.PrintFrame(inlined, precise, prefix, addr, func, fileline, body)
      self.PrintLines(fileline, lines_before, lines_after)

  def LoadModule(self, module):
    if module in self.module_symbolizers.keys():
      return True

    module_path = FindFile(self.linux_path, module)
    if module_path == None:
      return False

    self.module_symbolizers[module] = Symbolizer(module_path)
    self.module_offset_loaders[module] = SymbolOffsetLoader(module_path)
    return True

  def LoadFile(self, path):
    if path in self.loaded_files.keys():
      return self.loaded_files[path]
    try:
      with open(path) as f:
        self.loaded_files[path] = f.readlines()
        return self.loaded_files[path]
    except:
      return None

  def PrintFrame(self, inlined, precise, prefix, addr, func, fileline, body):
    if self.strip_path != None:
      fileline_parts = fileline.split(self.strip_path, 1)
      if len(fileline_parts) >= 2:
        fileline = fileline_parts[1].lstrip('/')
    if inlined:
      addr = '     inline     ';
    elif addr == None:
      addr = '      none      ';
    precise = '' if precise else '? '
    if inlined:
      print '%s[<%s>] %s%s %s' % (prefix, addr, precise, func, fileline)
    else:
      print '%s[<%s>] %s%s %s' % (prefix, addr, precise, body, fileline)

  def PrintLines(self, fileline, lines_before, lines_after):
    if lines_before == None and lines_after == None:
      return
    lines_before = 0 if lines_before == None else lines_before
    lines_after = 0 if lines_after == None else lines_after

    fileline = fileline.split(':')
    filename, linenum = fileline[0], fileline[1]

    try:
      linenum = int(linenum)
    except:
      return
    assert linenum >= 1
    linenum -= 1

    start = max(0, linenum - lines_before)
    end = linenum + lines_after + 1
    lines = self.LoadFile(filename)
    if not lines:
      return

    for i, line in enumerate(lines[start:end]):
      print '  {0:5d} {1}'.format(i + start + 1, line),

  def Finalize(self):
    for module, symbolizer in self.module_symbolizers.items():
      symbolizer.Close()

def print_usage():
  print 'Usage: {0} --linux=<linux path>'.format(sys.argv[0]),
  print '[--strip=<strip path>]',
  print '[--before=<lines before>]',
  print '[--after=<lines after>]',
  print

def main():
  try:
    opts, args = getopt.getopt(sys.argv[1:], 'l:s:b:a:',
		    ['linux=', 'strip=', 'before=', 'after='])
  except:
    print_usage()
    sys.exit(1)

  linux_path = None
  strip_path = None
  lines_before = None
  lines_after = None

  for opt, arg in opts:
    if opt in ('-l', '--linux'):
      linux_path = arg
    elif opt in ('-s', '--strip'):
      strip_path = arg
    elif opt in ('-b', '--before'):
      lines_before = arg
    elif opt in ('-a', '--after'):
      lines_after = arg

  if not linux_path:
    print_usage()
    sys.exit(1)

  try:
    lines_before = None if lines_before == None else int(lines_before)
    lines_after = None if lines_after == None else int(lines_after)
  except:
    print_usage()
    sys.exit(1)

  processer = ReportProcesser(linux_path, strip_path)
  processer.ProcessInput(lines_before, lines_after)
  processer.Finalize()

  sys.exit(0)

if __name__ == '__main__':
  main()