1#!/usr/bin/env python
2#
3# Copyright 2009 the V8 project authors. All rights reserved.
4# Redistribution and use in source and binary forms, with or without
5# modification, are permitted provided that the following conditions are
6# met:
7#
8#     * Redistributions of source code must retain the above copyright
9#       notice, this list of conditions and the following disclaimer.
10#     * Redistributions in binary form must reproduce the above
11#       copyright notice, this list of conditions and the following
12#       disclaimer in the documentation and/or other materials provided
13#       with the distribution.
14#     * Neither the name of Google Inc. nor the names of its
15#       contributors may be used to endorse or promote products derived
16#       from this software without specific prior written permission.
17#
18# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30# Simple wrapper for running valgrind and checking the output on
31# stderr for memory leaks.
32# Uses valgrind from third_party/valgrind. Assumes the executable is passed
33# with a path relative to the v8 root.
34
35
36from os import path
37import platform
38import re
39import subprocess
40import sys
41
42V8_ROOT = path.dirname(path.dirname(path.abspath(__file__)))
43MACHINE = 'linux_x64' if platform.machine() == 'x86_64' else 'linux_x86'
44VALGRIND_ROOT = path.join(V8_ROOT, 'third_party', 'valgrind', MACHINE)
45VALGRIND_BIN = path.join(VALGRIND_ROOT, 'bin', 'valgrind')
46VALGRIND_LIB = path.join(VALGRIND_ROOT, 'lib', 'valgrind')
47
48VALGRIND_ARGUMENTS = [
49  VALGRIND_BIN,
50  '--error-exitcode=1',
51  '--leak-check=full',
52  '--smc-check=all',
53]
54
55if len(sys.argv) < 2:
56  print 'Please provide an executable to analyze.'
57  sys.exit(1)
58
59executable = path.join(V8_ROOT, sys.argv[1])
60if not path.exists(executable):
61  print 'Cannot find the file specified: %s' % executable
62  sys.exit(1)
63
64# Compute the command line.
65command = VALGRIND_ARGUMENTS + [executable] + sys.argv[2:]
66
67# Run valgrind.
68process = subprocess.Popen(
69    command,
70    stderr=subprocess.PIPE,
71    env={'VALGRIND_LIB': VALGRIND_LIB}
72)
73code = process.wait();
74errors = process.stderr.readlines();
75
76# If valgrind produced an error, we report that to the user.
77if code != 0:
78  sys.stderr.writelines(errors)
79  sys.exit(code)
80
81# Look through the leak details and make sure that we don't
82# have any definitely, indirectly, and possibly lost bytes.
83LEAK_RE = r"(?:definitely|indirectly|possibly) lost: "
84LEAK_LINE_MATCHER = re.compile(LEAK_RE)
85LEAK_OKAY_MATCHER = re.compile(r"lost: 0 bytes in 0 blocks")
86leaks = []
87for line in errors:
88  if LEAK_LINE_MATCHER.search(line):
89    leaks.append(line)
90    if not LEAK_OKAY_MATCHER.search(line):
91      sys.stderr.writelines(errors)
92      sys.exit(1)
93
94# Make sure we found between 2 and 3 leak lines.
95if len(leaks) < 2 or len(leaks) > 3:
96  sys.stderr.writelines(errors)
97  sys.stderr.write('\n\n#### Malformed valgrind output.\n#### Exiting.\n')
98  sys.exit(1)
99
100# No leaks found.
101sys.stderr.writelines(errors)
102sys.exit(0)
103