| # Copyright (c) 2012 The Chromium Authors. All rights reserved. | |
| # Use of this source code is governed by a BSD-style license that can be | |
| # found in the LICENSE file. | |
| """Runs an exe through Valgrind and puts the intermediate files in a | |
| directory. | |
| """ | |
| import datetime | |
| import glob | |
| import logging | |
| import optparse | |
| import os | |
| import re | |
| import shutil | |
| import stat | |
| import subprocess | |
| import sys | |
| import tempfile | |
| import common | |
| import drmemory_analyze | |
| class BaseTool(object): | |
| """Abstract class for running dynamic error detection tools. | |
| Always subclass this and implement ToolCommand with framework- and | |
| tool-specific stuff. | |
| """ | |
| def __init__(self): | |
| temp_parent_dir = None | |
| self.log_parent_dir = "" | |
| if common.IsWindows(): | |
| # gpu process on Windows Vista+ runs at Low Integrity and can only | |
| # write to certain directories (http://crbug.com/119131) | |
| # | |
| # TODO(bruening): if scripts die in middle and don't clean up temp | |
| # dir, we'll accumulate files in profile dir. should remove | |
| # really old files automatically. | |
| profile = os.getenv("USERPROFILE") | |
| if profile: | |
| self.log_parent_dir = profile + "\\AppData\\LocalLow\\" | |
| if os.path.exists(self.log_parent_dir): | |
| self.log_parent_dir = common.NormalizeWindowsPath(self.log_parent_dir) | |
| temp_parent_dir = self.log_parent_dir | |
| # Generated every time (even when overridden) | |
| self.temp_dir = tempfile.mkdtemp(prefix="vg_logs_", dir=temp_parent_dir) | |
| self.log_dir = self.temp_dir # overridable by --keep_logs | |
| self.option_parser_hooks = [] | |
| # TODO(glider): we may not need some of the env vars on some of the | |
| # platforms. | |
| self._env = { | |
| "G_SLICE" : "always-malloc", | |
| "NSS_DISABLE_UNLOAD" : "1", | |
| "NSS_DISABLE_ARENA_FREE_LIST" : "1", | |
| "GTEST_DEATH_TEST_USE_FORK": "1", | |
| } | |
| def ToolName(self): | |
| raise NotImplementedError, "This method should be implemented " \ | |
| "in the tool-specific subclass" | |
| def Analyze(self, check_sanity=False): | |
| raise NotImplementedError, "This method should be implemented " \ | |
| "in the tool-specific subclass" | |
| def RegisterOptionParserHook(self, hook): | |
| # Frameworks and tools can add their own flags to the parser. | |
| self.option_parser_hooks.append(hook) | |
| def CreateOptionParser(self): | |
| # Defines Chromium-specific flags. | |
| self._parser = optparse.OptionParser("usage: %prog [options] <program to " | |
| "test>") | |
| self._parser.disable_interspersed_args() | |
| self._parser.add_option("-t", "--timeout", | |
| dest="timeout", metavar="TIMEOUT", default=100000, | |
| help="timeout in seconds for the run (default 100000)") | |
| self._parser.add_option("", "--build-dir", | |
| help="the location of the compiler output") | |
| self._parser.add_option("", "--source-dir", | |
| help="path to top of source tree for this build" | |
| "(used to normalize source paths in baseline)") | |
| self._parser.add_option("", "--gtest_filter", default="", | |
| help="which test case to run") | |
| self._parser.add_option("", "--gtest_repeat", | |
| help="how many times to run each test") | |
| self._parser.add_option("", "--gtest_print_time", action="store_true", | |
| default=False, | |
| help="show how long each test takes") | |
| self._parser.add_option("", "--ignore_exit_code", action="store_true", | |
| default=False, | |
| help="ignore exit code of the test " | |
| "(e.g. test failures)") | |
| self._parser.add_option("", "--keep_logs", action="store_true", | |
| default=False, | |
| help="store memory tool logs in the <tool>.logs " | |
| "directory instead of /tmp.\nThis can be " | |
| "useful for tool developers/maintainers.\n" | |
| "Please note that the <tool>.logs directory " | |
| "will be clobbered on tool startup.") | |
| # To add framework- or tool-specific flags, please add a hook using | |
| # RegisterOptionParserHook in the corresponding subclass. | |
| # See ValgrindTool for an example. | |
| for hook in self.option_parser_hooks: | |
| hook(self, self._parser) | |
| def ParseArgv(self, args): | |
| self.CreateOptionParser() | |
| # self._tool_flags will store those tool flags which we don't parse | |
| # manually in this script. | |
| self._tool_flags = [] | |
| known_args = [] | |
| """ We assume that the first argument not starting with "-" is a program | |
| name and all the following flags should be passed to the program. | |
| TODO(timurrrr): customize optparse instead | |
| """ | |
| while len(args) > 0 and args[0][:1] == "-": | |
| arg = args[0] | |
| if (arg == "--"): | |
| break | |
| if self._parser.has_option(arg.split("=")[0]): | |
| known_args += [arg] | |
| else: | |
| self._tool_flags += [arg] | |
| args = args[1:] | |
| if len(args) > 0: | |
| known_args += args | |
| self._options, self._args = self._parser.parse_args(known_args) | |
| self._timeout = int(self._options.timeout) | |
| self._source_dir = self._options.source_dir | |
| if self._options.keep_logs: | |
| # log_parent_dir has trailing slash if non-empty | |
| self.log_dir = self.log_parent_dir + "%s.logs" % self.ToolName() | |
| if os.path.exists(self.log_dir): | |
| shutil.rmtree(self.log_dir) | |
| os.mkdir(self.log_dir) | |
| logging.info("Logs are in " + self.log_dir) | |
| self._ignore_exit_code = self._options.ignore_exit_code | |
| if self._options.gtest_filter != "": | |
| self._args.append("--gtest_filter=%s" % self._options.gtest_filter) | |
| if self._options.gtest_repeat: | |
| self._args.append("--gtest_repeat=%s" % self._options.gtest_repeat) | |
| if self._options.gtest_print_time: | |
| self._args.append("--gtest_print_time") | |
| return True | |
| def Setup(self, args): | |
| return self.ParseArgv(args) | |
| def ToolCommand(self): | |
| raise NotImplementedError, "This method should be implemented " \ | |
| "in the tool-specific subclass" | |
| def Cleanup(self): | |
| # You may override it in the tool-specific subclass | |
| pass | |
| def Execute(self): | |
| """ Execute the app to be tested after successful instrumentation. | |
| Full execution command-line provided by subclassers via proc.""" | |
| logging.info("starting execution...") | |
| proc = self.ToolCommand() | |
| for var in self._env: | |
| common.PutEnvAndLog(var, self._env[var]) | |
| return common.RunSubprocess(proc, self._timeout) | |
| def RunTestsAndAnalyze(self, check_sanity): | |
| exec_retcode = self.Execute() | |
| analyze_retcode = self.Analyze(check_sanity) | |
| if analyze_retcode: | |
| logging.error("Analyze failed.") | |
| logging.info("Search the log for '[ERROR]' to see the error reports.") | |
| return analyze_retcode | |
| if exec_retcode: | |
| if self._ignore_exit_code: | |
| logging.info("Test execution failed, but the exit code is ignored.") | |
| else: | |
| logging.error("Test execution failed.") | |
| return exec_retcode | |
| else: | |
| logging.info("Test execution completed successfully.") | |
| if not analyze_retcode: | |
| logging.info("Analysis completed successfully.") | |
| return 0 | |
| def Main(self, args, check_sanity, min_runtime_in_seconds): | |
| """Call this to run through the whole process: Setup, Execute, Analyze""" | |
| start_time = datetime.datetime.now() | |
| retcode = -1 | |
| if self.Setup(args): | |
| retcode = self.RunTestsAndAnalyze(check_sanity) | |
| shutil.rmtree(self.temp_dir, ignore_errors=True) | |
| self.Cleanup() | |
| else: | |
| logging.error("Setup failed") | |
| end_time = datetime.datetime.now() | |
| runtime_in_seconds = (end_time - start_time).seconds | |
| hours = runtime_in_seconds / 3600 | |
| seconds = runtime_in_seconds % 3600 | |
| minutes = seconds / 60 | |
| seconds = seconds % 60 | |
| logging.info("elapsed time: %02d:%02d:%02d" % (hours, minutes, seconds)) | |
| if (min_runtime_in_seconds > 0 and | |
| runtime_in_seconds < min_runtime_in_seconds): | |
| logging.error("Layout tests finished too quickly. " | |
| "It should have taken at least %d seconds. " | |
| "Something went wrong?" % min_runtime_in_seconds) | |
| retcode = -1 | |
| return retcode | |
| def Run(self, args, module, min_runtime_in_seconds=0): | |
| MODULES_TO_SANITY_CHECK = ["base"] | |
| check_sanity = module in MODULES_TO_SANITY_CHECK | |
| return self.Main(args, check_sanity, min_runtime_in_seconds) | |
| class DrMemory(BaseTool): | |
| """Dr.Memory | |
| Dynamic memory error detector for Windows. | |
| http://dev.chromium.org/developers/how-tos/using-drmemory | |
| It is not very mature at the moment, some things might not work properly. | |
| """ | |
| def __init__(self, full_mode, pattern_mode): | |
| super(DrMemory, self).__init__() | |
| self.full_mode = full_mode | |
| self.pattern_mode = pattern_mode | |
| self.RegisterOptionParserHook(DrMemory.ExtendOptionParser) | |
| def ToolName(self): | |
| return "drmemory" | |
| def ExtendOptionParser(self, parser): | |
| parser.add_option("", "--suppressions", default=[], | |
| action="append", | |
| help="path to a drmemory suppression file") | |
| parser.add_option("", "--follow_python", action="store_true", | |
| default=False, dest="follow_python", | |
| help="Monitor python child processes. If off, neither " | |
| "python children nor any children of python children " | |
| "will be monitored.") | |
| parser.add_option("", "--indirect_pdfium_test", action="store_true", | |
| default=False, | |
| help="set --wrapper rather than running Dr. Memory " | |
| "directly.") | |
| parser.add_option("", "--use_debug", action="store_true", | |
| default=False, dest="use_debug", | |
| help="Run Dr. Memory debug build") | |
| parser.add_option("", "--trace_children", action="store_true", | |
| default=True, | |
| help="TODO: default value differs from Valgrind") | |
| def ToolCommand(self): | |
| """Get the tool command to run.""" | |
| # WINHEAP is what Dr. Memory supports as there are issues w/ both | |
| # jemalloc (https://github.com/DynamoRIO/drmemory/issues/320) and | |
| # tcmalloc (https://github.com/DynamoRIO/drmemory/issues/314) | |
| add_env = { | |
| "CHROME_ALLOCATOR" : "WINHEAP", | |
| "JSIMD_FORCEMMX" : "1", # https://github.com/DynamoRIO/drmemory/issues/540 | |
| } | |
| for k,v in add_env.iteritems(): | |
| logging.info("export %s=%s", k, v) | |
| os.putenv(k, v) | |
| drmem_cmd = os.getenv("DRMEMORY_COMMAND") | |
| if not drmem_cmd: | |
| raise RuntimeError, "Please set DRMEMORY_COMMAND environment variable " \ | |
| "with the path to drmemory.exe" | |
| proc = drmem_cmd.split(" ") | |
| # By default, don't run python (this will exclude python's children as well) | |
| # to reduce runtime. We're not really interested in spending time finding | |
| # bugs in the python implementation. | |
| # With file-based config we must update the file every time, and | |
| # it will affect simultaneous drmem uses by this user. While file-based | |
| # config has many advantages, here we may want this-instance-only | |
| # (https://github.com/DynamoRIO/drmemory/issues/334). | |
| drconfig_cmd = [ proc[0].replace("drmemory.exe", "drconfig.exe") ] | |
| drconfig_cmd += ["-quiet"] # suppress errors about no 64-bit libs | |
| run_drconfig = True | |
| if self._options.follow_python: | |
| logging.info("Following python children") | |
| # -unreg fails if not already registered so query for that first | |
| query_cmd = drconfig_cmd + ["-isreg", "python.exe"] | |
| query_proc = subprocess.Popen(query_cmd, stdout=subprocess.PIPE, | |
| shell=True) | |
| (query_out, query_err) = query_proc.communicate() | |
| if re.search("exe not registered", query_out): | |
| run_drconfig = False # all set | |
| else: | |
| drconfig_cmd += ["-unreg", "python.exe"] | |
| else: | |
| logging.info("Excluding python children") | |
| drconfig_cmd += ["-reg", "python.exe", "-norun"] | |
| if run_drconfig: | |
| drconfig_retcode = common.RunSubprocess(drconfig_cmd, self._timeout) | |
| if drconfig_retcode: | |
| logging.error("Configuring whether to follow python children failed " \ | |
| "with %d.", drconfig_retcode) | |
| raise RuntimeError, "Configuring python children failed " | |
| suppression_count = 0 | |
| supp_files = self._options.suppressions | |
| if self.full_mode: | |
| supp_files += [s.replace(".txt", "_full.txt") for s in supp_files] | |
| for suppression_file in supp_files: | |
| if os.path.exists(suppression_file): | |
| suppression_count += 1 | |
| proc += ["-suppress", common.NormalizeWindowsPath(suppression_file)] | |
| if not suppression_count: | |
| logging.warning("WARNING: NOT USING SUPPRESSIONS!") | |
| # Un-comment to dump Dr.Memory events on error | |
| #proc += ["-dr_ops", "-dumpcore_mask", "-dr_ops", "0x8bff"] | |
| # Un-comment and comment next line to debug Dr.Memory | |
| #proc += ["-dr_ops", "-no_hide"] | |
| #proc += ["-dr_ops", "-msgbox_mask", "-dr_ops", "15"] | |
| #Proc += ["-dr_ops", "-stderr_mask", "-dr_ops", "15"] | |
| # Ensure we see messages about Dr. Memory crashing! | |
| proc += ["-dr_ops", "-stderr_mask", "-dr_ops", "12"] | |
| if self._options.use_debug: | |
| proc += ["-debug"] | |
| proc += ["-logdir", common.NormalizeWindowsPath(self.log_dir)] | |
| if self.log_parent_dir: | |
| # gpu process on Windows Vista+ runs at Low Integrity and can only | |
| # write to certain directories (http://crbug.com/119131) | |
| symcache_dir = os.path.join(self.log_parent_dir, "drmemory.symcache") | |
| elif self._options.build_dir: | |
| # The other case is only possible with -t cmdline. | |
| # Anyways, if we omit -symcache_dir the -logdir's value is used which | |
| # should be fine. | |
| symcache_dir = os.path.join(self._options.build_dir, "drmemory.symcache") | |
| if symcache_dir: | |
| if not os.path.exists(symcache_dir): | |
| try: | |
| os.mkdir(symcache_dir) | |
| except OSError: | |
| logging.warning("Can't create symcache dir?") | |
| if os.path.exists(symcache_dir): | |
| proc += ["-symcache_dir", common.NormalizeWindowsPath(symcache_dir)] | |
| # Use -no_summary to suppress DrMemory's summary and init-time | |
| # notifications. We generate our own with drmemory_analyze.py. | |
| proc += ["-batch", "-no_summary"] | |
| # Un-comment to disable interleaved output. Will also suppress error | |
| # messages normally printed to stderr. | |
| #proc += ["-quiet", "-no_results_to_stderr"] | |
| proc += ["-callstack_max_frames", "40"] | |
| # disable leak scan for now | |
| proc += ["-no_count_leaks", "-no_leak_scan"] | |
| # disable warnings about unaddressable prefetches | |
| proc += ["-no_check_prefetch"] | |
| # crbug.com/413215, no heap mismatch check for Windows release build binary | |
| if common.IsWindows() and "Release" in self._options.build_dir: | |
| proc += ["-no_check_delete_mismatch"] | |
| # make callstacks easier to read | |
| proc += ["-callstack_srcfile_prefix", | |
| "build\\src,chromium\\src,crt_build\\self_x86"] | |
| proc += ["-callstack_modname_hide", | |
| "*drmemory*,chrome.dll"] | |
| boring_callers = common.BoringCallers(mangled=False, use_re_wildcards=False) | |
| # TODO(timurrrr): In fact, we want "starting from .." instead of "below .." | |
| proc += ["-callstack_truncate_below", ",".join(boring_callers)] | |
| if self.pattern_mode: | |
| proc += ["-pattern", "0xf1fd", "-no_count_leaks", "-redzone_size", "0x20"] | |
| elif not self.full_mode: | |
| proc += ["-light"] | |
| proc += self._tool_flags | |
| # Dr.Memory requires -- to separate tool flags from the executable name. | |
| proc += ["--"] | |
| if self._options.indirect_pdfium_test: | |
| wrapper = " ".join(proc) | |
| logging.info("pdfium wrapper = " + wrapper) | |
| proc = self._args | |
| proc += ["--wrapper", wrapper] | |
| return proc | |
| # Note that self._args begins with the name of the exe to be run. | |
| self._args[0] = common.NormalizeWindowsPath(self._args[0]) | |
| proc += self._args | |
| return proc | |
| def CreateBrowserWrapper(self, command): | |
| os.putenv("BROWSER_WRAPPER", command) | |
| def Analyze(self, check_sanity=False): | |
| # Use one analyzer for all the log files to avoid printing duplicate reports | |
| # | |
| # TODO(timurrrr): unify this with Valgrind and other tools when we have | |
| # https://github.com/DynamoRIO/drmemory/issues/684 | |
| analyzer = drmemory_analyze.DrMemoryAnalyzer() | |
| ret = 0 | |
| if not self._options.indirect_pdfium_test: | |
| filenames = glob.glob(self.log_dir + "/*/results.txt") | |
| ret = analyzer.Report(filenames, None, check_sanity) | |
| else: | |
| testcases = glob.glob(self.log_dir + "/testcase.*.logs") | |
| # If we have browser wrapper, the per-test logdirs are named as | |
| # "testcase.wrapper_PID.name". | |
| # Let's extract the list of wrapper_PIDs and name it ppids. | |
| # NOTE: ppids may contain '_', i.e. they are not ints! | |
| ppids = set([f.split(".")[-2] for f in testcases]) | |
| for ppid in ppids: | |
| testcase_name = None | |
| try: | |
| f = open("%s/testcase.%s.name" % (self.log_dir, ppid)) | |
| testcase_name = f.read().strip() | |
| f.close() | |
| except IOError: | |
| pass | |
| print "=====================================================" | |
| print " Below is the report for drmemory wrapper PID=%s." % ppid | |
| if testcase_name: | |
| print " It was used while running the `%s` test." % testcase_name | |
| else: | |
| # TODO(timurrrr): hm, the PID line is suppressed on Windows... | |
| print " You can find the corresponding test" | |
| print " by searching the above log for 'PID=%s'" % ppid | |
| sys.stdout.flush() | |
| ppid_filenames = glob.glob("%s/testcase.%s.logs/*/results.txt" % | |
| (self.log_dir, ppid)) | |
| ret |= analyzer.Report(ppid_filenames, testcase_name, False) | |
| print "=====================================================" | |
| sys.stdout.flush() | |
| logging.info("Please see http://dev.chromium.org/developers/how-tos/" | |
| "using-drmemory for the info on Dr. Memory") | |
| return ret | |
| class ToolFactory: | |
| def Create(self, tool_name): | |
| if tool_name == "drmemory" or tool_name == "drmemory_light": | |
| # TODO(timurrrr): remove support for "drmemory" when buildbots are | |
| # switched to drmemory_light OR make drmemory==drmemory_full the default | |
| # mode when the tool is mature enough. | |
| return DrMemory(False, False) | |
| if tool_name == "drmemory_full": | |
| return DrMemory(True, False) | |
| if tool_name == "drmemory_pattern": | |
| return DrMemory(False, True) | |
| try: | |
| platform_name = common.PlatformNames()[0] | |
| except common.NotImplementedError: | |
| platform_name = sys.platform + "(Unknown)" | |
| raise RuntimeError, "Unknown tool (tool=%s, platform=%s)" % (tool_name, | |
| platform_name) | |
| def CreateTool(tool): | |
| return ToolFactory().Create(tool) |