blob: 3b80c7983c4cad602aa619faaa9b2a67c3984865 [file] [log] [blame]
Mike Frysinger69cb41d2013-08-11 20:08:19 -04001# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
2# Use of this source code is governed by a BSD-style license that can be
3# found in the LICENSE file.
4
5"""Generate minidump symbols for use by the Crash server.
6
7Note: This should be run inside the chroot.
8
9This produces files in the breakpad format required by minidump_stackwalk and
10the crash server to dump stack information.
11
12Basically it scans all the split .debug files in /build/$BOARD/usr/lib/debug/
13and converts them over using the `dump_syms` programs. Those plain text .sym
14files are then stored in /build/$BOARD/usr/lib/debug/breakpad/.
15
Mike Frysinger02e1e072013-11-10 22:11:34 -050016If you want to actually upload things, see upload_symbols.py.
17"""
Mike Frysinger69cb41d2013-08-11 20:08:19 -040018
19import collections
20import ctypes
Mike Frysinger69cb41d2013-08-11 20:08:19 -040021import multiprocessing
22import os
Mike Frysinger69cb41d2013-08-11 20:08:19 -040023
Mike Frysinger06a51c82021-04-06 11:39:17 -040024from chromite.lib import build_target_lib
Mike Frysinger69cb41d2013-08-11 20:08:19 -040025from chromite.lib import commandline
26from chromite.lib import cros_build_lib
Ralph Nathan91874ca2015-03-19 13:29:41 -070027from chromite.lib import cros_logging as logging
Mike Frysinger69cb41d2013-08-11 20:08:19 -040028from chromite.lib import osutils
29from chromite.lib import parallel
Mike Frysinger96ad3f22014-04-24 23:27:27 -040030from chromite.lib import signals
Mike Frysinger69cb41d2013-08-11 20:08:19 -040031
32
33SymbolHeader = collections.namedtuple('SymbolHeader',
34 ('cpu', 'id', 'name', 'os',))
35
36
37def ReadSymsHeader(sym_file):
38 """Parse the header of the symbol file
39
40 The first line of the syms file will read like:
41 MODULE Linux arm F4F6FA6CCBDEF455039C8DE869C8A2F40 blkid
42
43 https://code.google.com/p/google-breakpad/wiki/SymbolFiles
44
45 Args:
46 sym_file: The symbol file to parse
Mike Frysinger1a736a82013-12-12 01:50:59 -050047
Mike Frysinger69cb41d2013-08-11 20:08:19 -040048 Returns:
49 A SymbolHeader object
Mike Frysinger1a736a82013-12-12 01:50:59 -050050
Mike Frysinger69cb41d2013-08-11 20:08:19 -040051 Raises:
52 ValueError if the first line of |sym_file| is invalid
53 """
Mike Frysinger374ba4f2019-11-14 23:45:15 -050054 with cros_build_lib.Open(sym_file, 'rb') as f:
55 header = f.readline().decode('utf-8').split()
Mike Frysinger69cb41d2013-08-11 20:08:19 -040056
57 if header[0] != 'MODULE' or len(header) != 5:
58 raise ValueError('header of sym file is invalid')
Mike Frysinger50cedd32014-02-09 23:03:18 -050059
Mike Frysinger69cb41d2013-08-11 20:08:19 -040060 return SymbolHeader(os=header[1], cpu=header[2], id=header[3], name=header[4])
61
62
63def GenerateBreakpadSymbol(elf_file, debug_file=None, breakpad_dir=None,
Don Garrett39f0dc62015-09-24 15:18:31 -070064 strip_cfi=False, num_errors=None,
65 dump_syms_cmd='dump_syms'):
Mike Frysinger69cb41d2013-08-11 20:08:19 -040066 """Generate the symbols for |elf_file| using |debug_file|
67
68 Args:
69 elf_file: The file to dump symbols for
70 debug_file: Split debug file to use for symbol information
71 breakpad_dir: The dir to store the output symbol file in
Mike Frysinger69cb41d2013-08-11 20:08:19 -040072 strip_cfi: Do not generate CFI data
73 num_errors: An object to update with the error count (needs a .value member)
Don Garrett39f0dc62015-09-24 15:18:31 -070074 dump_syms_cmd: Command to use for dumping symbols.
Mike Frysinger1a736a82013-12-12 01:50:59 -050075
Mike Frysinger69cb41d2013-08-11 20:08:19 -040076 Returns:
Don Garrettc9de3ac2015-10-01 15:40:10 -070077 The name of symbol file written out.
Mike Frysinger69cb41d2013-08-11 20:08:19 -040078 """
Don Garrette548cff2015-09-23 14:36:21 -070079 assert breakpad_dir
Mike Frysinger69cb41d2013-08-11 20:08:19 -040080 if num_errors is None:
81 num_errors = ctypes.c_int()
82
Mike Frysinger2808deb2016-01-28 01:22:13 -050083 cmd_base = [dump_syms_cmd, '-v']
Mike Frysinger69cb41d2013-08-11 20:08:19 -040084 if strip_cfi:
85 cmd_base += ['-c']
86 # Some files will not be readable by non-root (e.g. set*id /bin/su).
87 needs_sudo = not os.access(elf_file, os.R_OK)
88
89 def _DumpIt(cmd_args):
90 if needs_sudo:
Mike Frysinger45602c72019-09-22 02:15:11 -040091 run_command = cros_build_lib.sudo_run
Mike Frysinger69cb41d2013-08-11 20:08:19 -040092 else:
Mike Frysinger45602c72019-09-22 02:15:11 -040093 run_command = cros_build_lib.run
Mike Frysinger69cb41d2013-08-11 20:08:19 -040094 return run_command(
Mike Frysinger0282d222019-12-17 17:15:48 -050095 cmd_base + cmd_args, stderr=True, stdout=temp.name,
Mike Frysingerf5a3b2d2019-12-12 14:36:17 -050096 check=False, debug_level=logging.DEBUG)
Mike Frysinger69cb41d2013-08-11 20:08:19 -040097
98 def _CrashCheck(ret, msg):
99 if ret < 0:
Prathmesh Prabhu17f07422015-07-17 11:40:40 -0700100 logging.PrintBuildbotStepWarnings()
Ralph Nathan446aee92015-03-23 14:44:56 -0700101 logging.warning('dump_syms crashed with %s; %s',
102 signals.StrSignal(-ret), msg)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400103
104 osutils.SafeMakedirs(breakpad_dir)
Mike Frysinger374ba4f2019-11-14 23:45:15 -0500105 with cros_build_lib.UnbufferedNamedTemporaryFile(
106 dir=breakpad_dir, delete=False) as temp:
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400107 if debug_file:
108 # Try to dump the symbols using the debug file like normal.
109 cmd_args = [elf_file, os.path.dirname(debug_file)]
110 result = _DumpIt(cmd_args)
111
112 if result.returncode:
113 # Sometimes dump_syms can crash because there's too much info.
114 # Try dumping and stripping the extended stuff out. At least
Mike Frysingerdcad4e02018-08-03 16:20:02 -0400115 # this way we'll get the extended symbols. https://crbug.com/266064
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400116 _CrashCheck(result.returncode, 'retrying w/out CFI')
117 cmd_args = ['-c', '-r'] + cmd_args
118 result = _DumpIt(cmd_args)
119 _CrashCheck(result.returncode, 'retrying w/out debug')
120
121 basic_dump = result.returncode
122 else:
123 basic_dump = True
124
125 if basic_dump:
126 # If that didn't work (no debug, or dump_syms still failed), try
127 # dumping just the file itself directly.
128 result = _DumpIt([elf_file])
129 if result.returncode:
130 # A lot of files (like kernel files) contain no debug information,
131 # do not consider such occurrences as errors.
Prathmesh Prabhu17f07422015-07-17 11:40:40 -0700132 logging.PrintBuildbotStepWarnings()
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400133 _CrashCheck(result.returncode, 'giving up entirely')
Mike Frysinger374ba4f2019-11-14 23:45:15 -0500134 if b'file contains no debugging information' in result.stderr:
Ralph Nathan446aee92015-03-23 14:44:56 -0700135 logging.warning('no symbols found for %s', elf_file)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400136 else:
137 num_errors.value += 1
Ralph Nathan59900422015-03-24 10:41:17 -0700138 logging.error('dumping symbols for %s failed:\n%s', elf_file,
Mike Frysingerd1c188d2021-06-09 01:16:26 -0400139 result.error.decode('utf-8'))
Mike Frysinger374ba4f2019-11-14 23:45:15 -0500140 os.unlink(temp.name)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400141 return num_errors.value
142
143 # Move the dumped symbol file to the right place:
144 # /build/$BOARD/usr/lib/debug/breakpad/<module-name>/<id>/<module-name>.sym
145 header = ReadSymsHeader(temp)
Ralph Nathan03047282015-03-23 11:09:32 -0700146 logging.info('Dumped %s as %s : %s', elf_file, header.name, header.id)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400147 sym_file = os.path.join(breakpad_dir, header.name, header.id,
148 header.name + '.sym')
149 osutils.SafeMakedirs(os.path.dirname(sym_file))
150 os.rename(temp.name, sym_file)
Mike Frysinger60ec1012013-10-21 00:11:10 -0400151 os.chmod(sym_file, 0o644)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400152
Don Garrettc9de3ac2015-10-01 15:40:10 -0700153 return sym_file
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400154
155
156def GenerateBreakpadSymbols(board, breakpad_dir=None, strip_cfi=False,
Mike Frysingeref9ab2f2013-08-26 22:16:00 -0400157 generate_count=None, sysroot=None,
Shawn Nematbakhsh2c169cb2013-10-29 16:23:58 -0700158 num_processes=None, clean_breakpad=False,
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700159 exclude_dirs=(), file_list=None):
160 """Generate symbols for this board.
161
162 If |file_list| is None, symbols are generated for all executables, otherwise
163 only for the files included in |file_list|.
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400164
165 TODO(build):
166 This should be merged with buildbot_commands.GenerateBreakpadSymbols()
167 once we rewrite cros_generate_breakpad_symbols in python.
168
169 Args:
170 board: The board whose symbols we wish to generate
171 breakpad_dir: The full path to the breakpad directory where symbols live
172 strip_cfi: Do not generate CFI data
173 generate_count: If set, only generate this many symbols (meant for testing)
174 sysroot: The root where to find the corresponding ELFs
Mike Frysingeref9ab2f2013-08-26 22:16:00 -0400175 num_processes: Number of jobs to run in parallel
Mike Frysinger9a628bb2013-10-24 15:51:37 -0400176 clean_breakpad: Should we `rm -rf` the breakpad output dir first; note: we
177 do not do any locking, so do not run more than one in parallel when True
Shawn Nematbakhsh2c169cb2013-10-29 16:23:58 -0700178 exclude_dirs: List of dirs (relative to |sysroot|) to not search
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700179 file_list: Only generate symbols for files in this list. Each file must be a
180 full path (including |sysroot| prefix).
181 TODO(build): Support paths w/o |sysroot|.
Mike Frysinger1a736a82013-12-12 01:50:59 -0500182
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400183 Returns:
184 The number of errors that were encountered.
185 """
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400186 if sysroot is None:
Mike Frysinger06a51c82021-04-06 11:39:17 -0400187 sysroot = build_target_lib.get_default_sysroot_path(board)
Mike Frysinger3f571af2016-08-31 23:56:53 -0400188 if breakpad_dir is None:
189 breakpad_dir = FindBreakpadDir(board, sysroot=sysroot)
Mike Frysinger9a628bb2013-10-24 15:51:37 -0400190 if clean_breakpad:
Ralph Nathan03047282015-03-23 11:09:32 -0700191 logging.info('cleaning out %s first', breakpad_dir)
Mike Frysinger9a628bb2013-10-24 15:51:37 -0400192 osutils.RmDir(breakpad_dir, ignore_missing=True, sudo=True)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400193 # Make sure non-root can write out symbols as needed.
194 osutils.SafeMakedirs(breakpad_dir, sudo=True)
195 if not os.access(breakpad_dir, os.W_OK):
Mike Frysinger45602c72019-09-22 02:15:11 -0400196 cros_build_lib.sudo_run(['chown', '-R', str(os.getuid()), breakpad_dir])
Mike Frysinger3f571af2016-08-31 23:56:53 -0400197 debug_dir = FindDebugDir(board, sysroot=sysroot)
Shawn Nematbakhsh2c169cb2013-10-29 16:23:58 -0700198 exclude_paths = [os.path.join(debug_dir, x) for x in exclude_dirs]
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700199 if file_list is None:
200 file_list = []
201 file_filter = dict.fromkeys([os.path.normpath(x) for x in file_list], False)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400202
Ralph Nathan03047282015-03-23 11:09:32 -0700203 logging.info('generating breakpad symbols using %s', debug_dir)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400204
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700205 # Let's locate all the debug_files and elfs first along with the debug file
206 # sizes. This way we can start processing the largest files first in parallel
207 # with the small ones.
208 # If |file_list| was given, ignore all other files.
209 targets = []
Shawn Nematbakhsh2c169cb2013-10-29 16:23:58 -0700210 for root, dirs, files in os.walk(debug_dir):
211 if root in exclude_paths:
Ralph Nathan03047282015-03-23 11:09:32 -0700212 logging.info('Skipping excluded dir %s', root)
Shawn Nematbakhsh2c169cb2013-10-29 16:23:58 -0700213 del dirs[:]
214 continue
215
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400216 for debug_file in files:
217 debug_file = os.path.join(root, debug_file)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400218 # Turn /build/$BOARD/usr/lib/debug/sbin/foo.debug into
219 # /build/$BOARD/sbin/foo.
220 elf_file = os.path.join(sysroot, debug_file[len(debug_dir) + 1:-6])
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700221
222 if file_filter:
223 if elf_file in file_filter:
224 file_filter[elf_file] = True
225 elif debug_file in file_filter:
226 file_filter[debug_file] = True
227 else:
228 continue
229
230 # Filter out files based on common issues with the debug file.
231 if not debug_file.endswith('.debug'):
232 continue
233
234 elif debug_file.endswith('.ko.debug'):
Ralph Nathan5a582ff2015-03-20 18:18:30 -0700235 logging.debug('Skipping kernel module %s', debug_file)
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700236 continue
237
238 elif os.path.islink(debug_file):
239 # The build-id stuff is common enough to filter out by default.
240 if '/.build-id/' in debug_file:
Ralph Nathan5a582ff2015-03-20 18:18:30 -0700241 msg = logging.debug
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700242 else:
Ralph Nathan446aee92015-03-23 14:44:56 -0700243 msg = logging.warning
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700244 msg('Skipping symbolic link %s', debug_file)
245 continue
246
247 # Filter out files based on common issues with the elf file.
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400248 if not os.path.exists(elf_file):
249 # Sometimes we filter out programs from /usr/bin but leave behind
250 # the .debug file.
Ralph Nathan446aee92015-03-23 14:44:56 -0700251 logging.warning('Skipping missing %s', elf_file)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400252 continue
253
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700254 targets.append((os.path.getsize(debug_file), elf_file, debug_file))
255
256 bg_errors = multiprocessing.Value('i')
257 if file_filter:
Mike Frysinger0bdbc102019-06-13 15:27:29 -0400258 files_not_found = [x for x, found in file_filter.items() if not found]
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700259 bg_errors.value += len(files_not_found)
260 if files_not_found:
Ralph Nathan59900422015-03-24 10:41:17 -0700261 logging.error('Failed to find requested files: %s', files_not_found)
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700262
263 # Now start generating symbols for the discovered elfs.
264 with parallel.BackgroundTaskRunner(GenerateBreakpadSymbol,
Don Garrette548cff2015-09-23 14:36:21 -0700265 breakpad_dir=breakpad_dir,
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700266 strip_cfi=strip_cfi,
267 num_errors=bg_errors,
268 processes=num_processes) as queue:
269 for _, elf_file, debug_file in sorted(targets, reverse=True):
270 if generate_count == 0:
271 break
272
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400273 queue.put([elf_file, debug_file])
274 if generate_count is not None:
275 generate_count -= 1
276 if generate_count == 0:
277 break
278
279 return bg_errors.value
280
281
Mike Frysinger3f571af2016-08-31 23:56:53 -0400282def FindDebugDir(board, sysroot=None):
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400283 """Given a |board|, return the path to the split debug dir for it"""
Mike Frysinger3f571af2016-08-31 23:56:53 -0400284 if sysroot is None:
Mike Frysinger06a51c82021-04-06 11:39:17 -0400285 sysroot = build_target_lib.get_default_sysroot_path(board)
Yu-Ju Hongdd9bb2b2014-01-03 17:08:26 -0800286 return os.path.join(sysroot, 'usr', 'lib', 'debug')
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400287
288
Mike Frysinger3f571af2016-08-31 23:56:53 -0400289def FindBreakpadDir(board, sysroot=None):
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400290 """Given a |board|, return the path to the breakpad dir for it"""
Mike Frysinger3f571af2016-08-31 23:56:53 -0400291 return os.path.join(FindDebugDir(board, sysroot=sysroot), 'breakpad')
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400292
293
294def main(argv):
295 parser = commandline.ArgumentParser(description=__doc__)
296
297 parser.add_argument('--board', default=None,
298 help='board to generate symbols for')
299 parser.add_argument('--breakpad_root', type='path', default=None,
Mike Frysinger3f571af2016-08-31 23:56:53 -0400300 help='root output directory for breakpad symbols')
301 parser.add_argument('--sysroot', type='path', default=None,
302 help='root input directory for files')
Shawn Nematbakhsh2c169cb2013-10-29 16:23:58 -0700303 parser.add_argument('--exclude-dir', type=str, action='append',
304 default=[],
305 help='directory (relative to |board| root) to not search')
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400306 parser.add_argument('--generate-count', type=int, default=None,
307 help='only generate # number of symbols')
Mike Frysinger9a628bb2013-10-24 15:51:37 -0400308 parser.add_argument('--noclean', dest='clean', action='store_false',
309 default=True,
310 help='do not clean out breakpad dir before running')
Mike Frysingeref9ab2f2013-08-26 22:16:00 -0400311 parser.add_argument('--jobs', type=int, default=None,
312 help='limit number of parallel jobs')
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400313 parser.add_argument('--strip_cfi', action='store_true', default=False,
314 help='do not generate CFI data (pass -c to dump_syms)')
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700315 parser.add_argument('file_list', nargs='*', default=None,
316 help='generate symbols for only these files '
317 '(e.g. /build/$BOARD/usr/bin/foo)')
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400318
319 opts = parser.parse_args(argv)
Mike Frysinger90e49ca2014-01-14 14:42:07 -0500320 opts.Freeze()
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400321
Mike Frysinger3f571af2016-08-31 23:56:53 -0400322 if opts.board is None and opts.sysroot is None:
323 cros_build_lib.Die('--board or --sysroot is required')
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400324
325 ret = GenerateBreakpadSymbols(opts.board, breakpad_dir=opts.breakpad_root,
326 strip_cfi=opts.strip_cfi,
Mike Frysingeref9ab2f2013-08-26 22:16:00 -0400327 generate_count=opts.generate_count,
Mike Frysinger3f571af2016-08-31 23:56:53 -0400328 sysroot=opts.sysroot,
Mike Frysinger9a628bb2013-10-24 15:51:37 -0400329 num_processes=opts.jobs,
Shawn Nematbakhsh2c169cb2013-10-29 16:23:58 -0700330 clean_breakpad=opts.clean,
Prathmesh Prabhu9995e9b2013-10-31 16:43:55 -0700331 exclude_dirs=opts.exclude_dir,
332 file_list=opts.file_list)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400333 if ret:
Ralph Nathan59900422015-03-24 10:41:17 -0700334 logging.error('encountered %i problem(s)', ret)
Mike Frysinger69cb41d2013-08-11 20:08:19 -0400335 # Since exit(status) gets masked, clamp it to 1 so we don't inadvertently
336 # return 0 in case we are a multiple of the mask.
337 ret = 1
338
339 return ret