af941403114f3cda9305399ad2d97179c998f888
[WebKit-https.git] / Tools / Scripts / webkitpy / port / leakdetector.py
1 # Copyright (C) 2010 Google Inc. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or without
4 # modification, are permitted provided that the following conditions are
5 # met:
6 #
7 #     * Redistributions of source code must retain the above copyright
8 # notice, this list of conditions and the following disclaimer.
9 #     * Redistributions in binary form must reproduce the above
10 # copyright notice, this list of conditions and the following disclaimer
11 # in the documentation and/or other materials provided with the
12 # distribution.
13 #     * Neither the Google name nor the names of its
14 # contributors may be used to endorse or promote products derived from
15 # this software without specific prior written permission.
16 #
17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 import logging
30 import re
31
32 from webkitpy.common.system.executive import ScriptError
33
34 _log = logging.getLogger(__name__)
35
36
37 # If other ports/platforms decide to support --leaks, we should see about sharing as much of this code as possible.
38 # Right now this code is only used by Apple's MacPort.
39
40 class LeakDetector(object):
41     def __init__(self, port):
42         # We should operate on a "platform" not a port here.
43         self._port = port
44         self._executive = port._executive
45         self._filesystem = port._filesystem
46
47     # We exclude the following reported leaks so they do not get in our way when looking for WebKit leaks:
48     # This allows us ignore known leaks and only be alerted when new leaks occur. Some leaks are in the old
49     # versions of the system frameworks that are being used by the leaks bots. Even though a leak has been
50     # fixed, it will be listed here until the bot has been updated with the newer frameworks.
51     def _types_to_exlude_from_leaks(self):
52         # Currently we don't have any type excludes from OS leaks, but we will likely again in the future.
53         return []
54
55     def _callstacks_to_exclude_from_leaks(self):
56         callstacks = [
57             'TextCodecICU::registerCodecs',  # https://bugs.webkit.org/show_bug.cgi?id=118505
58         ]
59         if self._port.operating_system == 'mac' and self._port.is_mavericks():
60             callstacks += [
61                 'AVAssetResourceLoader _poseAuthenticationChallengeWithKey:data:requestDictionary:fallbackHandler:',  # <rdar://problem/19699887> leak in AVFoundation
62             ]
63         return callstacks
64
65     def _leaks_args(self, pid):
66         leaks_args = []
67         for callstack in self._callstacks_to_exclude_from_leaks():
68             leaks_args += ['--exclude-callstack=%s' % callstack]
69         for excluded_type in self._types_to_exlude_from_leaks():
70             leaks_args += ['--exclude-type=%s' % excluded_type]
71         leaks_args.append(pid)
72         return leaks_args
73
74     def _parse_leaks_output(self, leaks_output):
75         _, count, bytes = re.search(r'Process (?P<pid>\d+): (?P<count>\d+) leaks? for (?P<bytes>\d+) total', leaks_output).groups()
76         excluded_match = re.search(r'(?P<excluded>\d+) leaks? excluded', leaks_output)
77         excluded = excluded_match.group('excluded') if excluded_match else 0
78         return int(count), int(excluded), int(bytes)
79
80     def leaks_files_in_directory(self, directory):
81         return self._filesystem.glob(self._filesystem.join(directory, "*-leaks.txt"))
82
83     def leaks_file_name(self, process_name, process_pid):
84         # We include the number of files this worker has already written in the name to prevent overwritting previous leak results..
85         return "%s-%s-leaks.txt" % (process_name, process_pid)
86
87     def count_total_bytes_and_unique_leaks(self, leak_files):
88         merge_depth = 5  # ORWT had a --merge-leak-depth argument, but that seems out of scope for the run-webkit-tests tool.
89         args = [
90             '--merge-depth',
91             merge_depth,
92         ] + leak_files
93         try:
94             parse_malloc_history_output = self._port._run_script("parse-malloc-history", args, include_configuration_arguments=False)
95         except ScriptError, e:
96             _log.warn("Failed to parse leaks output: %s" % e.message_with_output())
97             return
98
99         # total: 5,888 bytes (0 bytes excluded).
100         unique_leak_count = len(re.findall(r'^(\d*)\scalls', parse_malloc_history_output, re.MULTILINE))
101         total_bytes_string = re.search(r'^total\:\s(.+)\s\(', parse_malloc_history_output, re.MULTILINE).group(1)
102         return (total_bytes_string, unique_leak_count)
103
104     def count_total_leaks(self, leak_file_paths):
105         total_leaks = 0
106         for leak_file_path in leak_file_paths:
107             # Leaks have been seen to include non-utf8 data, so we use read_binary_file.
108             # See https://bugs.webkit.org/show_bug.cgi?id=71112.
109             leaks_output = self._filesystem.read_binary_file(leak_file_path)
110             count, _, _ = self._parse_leaks_output(leaks_output)
111             total_leaks += count
112         return total_leaks
113
114     def check_for_leaks(self, process_name, process_pid):
115         _log.debug("Checking for leaks in %s" % process_name)
116         try:
117             # Oddly enough, run-leaks (or the underlying leaks tool) does not seem to always output utf-8,
118             # thus we pass decode_output=False.  Without this code we've seen errors like:
119             # "UnicodeDecodeError: 'utf8' codec can't decode byte 0x88 in position 779874: unexpected code byte"
120             leaks_output = self._port._run_script("run-leaks", self._leaks_args(process_pid), include_configuration_arguments=False, decode_output=False)
121         except ScriptError, e:
122             _log.warn("Failed to run leaks tool: %s" % e.message_with_output())
123             return
124
125         # FIXME: We end up parsing this output 3 times.  Once here and twice for summarizing.
126         count, excluded, bytes = self._parse_leaks_output(leaks_output)
127         adjusted_count = count - excluded
128         if not adjusted_count:
129             return
130
131         leaks_filename = self.leaks_file_name(process_name, process_pid)
132         leaks_output_path = self._filesystem.join(self._port.results_directory(), leaks_filename)
133         self._filesystem.write_binary_file(leaks_output_path, leaks_output)
134
135         # FIXME: Ideally we would not be logging from the worker process, but rather pass the leak
136         # information back to the manager and have it log.
137         if excluded:
138             _log.info("%s leaks (%s bytes including %s excluded leaks) were found, details in %s" % (adjusted_count, bytes, excluded, leaks_output_path))
139         else:
140             _log.info("%s leaks (%s bytes) were found, details in %s" % (count, bytes, leaks_output_path))