gcmole.lua revision 257744e915dfc84d6d07a6b2accf8402d9ffc708
1-- Copyright 2011 the V8 project authors. All rights reserved. 2-- Redistribution and use in source and binary forms, with or without 3-- modification, are permitted provided that the following conditions are 4-- met: 5-- 6-- * Redistributions of source code must retain the above copyright 7-- notice, this list of conditions and the following disclaimer. 8-- * Redistributions in binary form must reproduce the above 9-- copyright notice, this list of conditions and the following 10-- disclaimer in the documentation and/or other materials provided 11-- with the distribution. 12-- * Neither the name of Google Inc. nor the names of its 13-- contributors may be used to endorse or promote products derived 14-- from this software without specific prior written permission. 15-- 16-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 17-- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 18-- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 19-- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 20-- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21-- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22-- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23-- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24-- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25-- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 26-- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 28-- This is main driver for gcmole tool. See README for more details. 29-- Usage: CLANG_BIN=clang-bin-dir lua tools/gcmole/gcmole.lua [arm|ia32|x64] 30 31local DIR = arg[0]:match("^(.+)/[^/]+$") 32 33local FLAGS = { 34 -- Do not build gcsuspects file and reuse previously generated one. 35 reuse_gcsuspects = false; 36 37 -- Print commands to console before executing them. 38 verbose = false; 39 40 -- Perform dead variable analysis (generates many false positives). 41 -- TODO add some sort of whiteliste to filter out false positives. 42 dead_vars = false; 43 44 -- When building gcsuspects whitelist certain functions as if they 45 -- can be causing GC. Currently used to reduce number of false 46 -- positives in dead variables analysis. See TODO for WHITELIST 47 -- below. 48 whitelist = true; 49} 50local ARGS = {} 51 52for i = 1, #arg do 53 local flag = arg[i]:match "^%-%-([%w_-]+)$" 54 if flag then 55 local no, real_flag = flag:match "^(no)([%w_-]+)$" 56 if real_flag then flag = real_flag end 57 58 flag = flag:gsub("%-", "_") 59 if FLAGS[flag] ~= nil then 60 FLAGS[flag] = (no ~= "no") 61 else 62 error("Unknown flag: " .. flag) 63 end 64 else 65 table.insert(ARGS, arg[i]) 66 end 67end 68 69local ARCHS = ARGS[1] and { ARGS[1] } or { 'ia32', 'arm', 'x64' } 70 71local io = require "io" 72local os = require "os" 73 74function log(...) 75 io.stderr:write(string.format(...)) 76 io.stderr:write "\n" 77end 78 79------------------------------------------------------------------------------- 80-- Clang invocation 81 82local CLANG_BIN = os.getenv "CLANG_BIN" 83 84if not CLANG_BIN or CLANG_BIN == "" then 85 error "CLANG_BIN not set" 86end 87 88local function MakeClangCommandLine(plugin, plugin_args, triple, arch_define) 89 if plugin_args then 90 for i = 1, #plugin_args do 91 plugin_args[i] = "-plugin-arg-" .. plugin .. " " .. plugin_args[i] 92 end 93 plugin_args = " " .. table.concat(plugin_args, " ") 94 end 95 return CLANG_BIN .. "/clang -cc1 -load " .. DIR .. "/libgcmole.so" 96 .. " -plugin " .. plugin 97 .. (plugin_args or "") 98 .. " -triple " .. triple 99 .. " -D" .. arch_define 100 .. " -DENABLE_VMSTATE_TRACKING" 101 .. " -DENABLE_LOGGING_AND_PROFILING" 102 .. " -DENABLE_DEBUGGER_SUPPORT" 103 .. " -Isrc" 104end 105 106function InvokeClangPluginForEachFile(filenames, cfg, func) 107 local cmd_line = MakeClangCommandLine(cfg.plugin, 108 cfg.plugin_args, 109 cfg.triple, 110 cfg.arch_define) 111 112 for _, filename in ipairs(filenames) do 113 log("-- %s", filename) 114 local action = cmd_line .. " src/" .. filename .. " 2>&1" 115 if FLAGS.verbose then print('popen ', action) end 116 local pipe = io.popen(action) 117 func(filename, pipe:lines()) 118 pipe:close() 119 end 120end 121 122------------------------------------------------------------------------------- 123-- SConscript parsing 124 125local function ParseSConscript() 126 local f = assert(io.open("src/SConscript"), "failed to open SConscript") 127 local sconscript = f:read('*a') 128 f:close() 129 130 local SOURCES = sconscript:match "SOURCES = {(.-)}"; 131 132 local sources = {} 133 134 for condition, list in 135 SOURCES:gmatch "'([^']-)': Split%(\"\"\"(.-)\"\"\"%)" do 136 local files = {} 137 for file in list:gmatch "[^%s]+" do table.insert(files, file) end 138 sources[condition] = files 139 end 140 141 for condition, list in SOURCES:gmatch "'([^']-)': %[(.-)%]" do 142 local files = {} 143 for file in list:gmatch "'([^']-)'" do table.insert(files, file) end 144 sources[condition] = files 145 end 146 147 return sources 148end 149 150local function EvaluateCondition(cond, props) 151 if cond == 'all' then return true end 152 153 local p, v = cond:match "(%w+):(%w+)" 154 155 assert(p and v, "failed to parse condition: " .. cond) 156 assert(props[p] ~= nil, "undefined configuration property: " .. p) 157 158 return props[p] == v 159end 160 161local function BuildFileList(sources, props) 162 local list = {} 163 for condition, files in pairs(sources) do 164 if EvaluateCondition(condition, props) then 165 for i = 1, #files do table.insert(list, files[i]) end 166 end 167 end 168 return list 169end 170 171local sources = ParseSConscript() 172 173local function FilesForArch(arch) 174 return BuildFileList(sources, { os = 'linux', 175 arch = arch, 176 mode = 'debug', 177 simulator = ''}) 178end 179 180local mtConfig = {} 181 182mtConfig.__index = mtConfig 183 184local function config (t) return setmetatable(t, mtConfig) end 185 186function mtConfig:extend(t) 187 local e = {} 188 for k, v in pairs(self) do e[k] = v end 189 for k, v in pairs(t) do e[k] = v end 190 return config(e) 191end 192 193local ARCHITECTURES = { 194 ia32 = config { triple = "i586-unknown-linux", 195 arch_define = "V8_TARGET_ARCH_IA32" }, 196 arm = config { triple = "i586-unknown-linux", 197 arch_define = "V8_TARGET_ARCH_ARM" }, 198 x64 = config { triple = "x86_64-unknown-linux", 199 arch_define = "V8_TARGET_ARCH_X64" } 200} 201 202------------------------------------------------------------------------------- 203-- GCSuspects Generation 204 205local gc, gc_caused, funcs 206 207local WHITELIST = { 208 -- The following functions call CEntryStub which is always present. 209 "MacroAssembler.*CallExternalReference", 210 "MacroAssembler.*CallRuntime", 211 "CompileCallLoadPropertyWithInterceptor", 212 "CallIC.*GenerateMiss", 213 214 -- DirectCEntryStub is a special stub used on ARM. 215 -- It is pinned and always present. 216 "DirectCEntryStub.*GenerateCall", 217 218 -- TODO GCMole currently is sensitive enough to understand that certain 219 -- functions only cause GC and return Failure simulataneously. 220 -- Callsites of such functions are safe as long as they are properly 221 -- check return value and propagate the Failure to the caller. 222 -- It should be possible to extend GCMole to understand this. 223 "Heap.*AllocateFunctionPrototype" 224}; 225 226local function AddCause(name, cause) 227 local t = gc_caused[name] 228 if not t then 229 t = {} 230 gc_caused[name] = t 231 end 232 table.insert(t, cause) 233end 234 235local function resolve(name) 236 local f = funcs[name] 237 238 if not f then 239 f = {} 240 funcs[name] = f 241 242 if name:match "Collect.*Garbage" then 243 gc[name] = true 244 AddCause(name, "<GC>") 245 end 246 247 if FLAGS.whitelist then 248 for i = 1, #WHITELIST do 249 if name:match(WHITELIST[i]) then 250 gc[name] = false 251 end 252 end 253 end 254 end 255 256 return f 257end 258 259local function parse (filename, lines) 260 local scope 261 262 for funcname in lines do 263 if funcname:sub(1, 1) ~= '\t' then 264 resolve(funcname) 265 scope = funcname 266 else 267 local name = funcname:sub(2) 268 resolve(name)[scope] = true 269 end 270 end 271end 272 273local function propagate () 274 log "** Propagating GC information" 275 276 local function mark(from, callers) 277 for caller, _ in pairs(callers) do 278 if gc[caller] == nil then 279 gc[caller] = true 280 mark(caller, funcs[caller]) 281 end 282 AddCause(caller, from) 283 end 284 end 285 286 for funcname, callers in pairs(funcs) do 287 if gc[funcname] then mark(funcname, callers) end 288 end 289end 290 291local function GenerateGCSuspects(arch, files, cfg) 292 -- Reset the global state. 293 gc, gc_caused, funcs = {}, {}, {} 294 295 log ("** Building GC Suspects for %s", arch) 296 InvokeClangPluginForEachFile (files, 297 cfg:extend { plugin = "dump-callees" }, 298 parse) 299 300 propagate() 301 302 local out = assert(io.open("gcsuspects", "w")) 303 for name, value in pairs(gc) do if value then out:write (name, '\n') end end 304 out:close() 305 306 local out = assert(io.open("gccauses", "w")) 307 out:write "GC = {" 308 for name, causes in pairs(gc_caused) do 309 out:write("['", name, "'] = {") 310 for i = 1, #causes do out:write ("'", causes[i], "';") end 311 out:write("};\n") 312 end 313 out:write "}" 314 out:close() 315 316 log ("** GCSuspects generated for %s", arch) 317end 318 319-------------------------------------------------------------------------------- 320-- Analysis 321 322local function CheckCorrectnessForArch(arch) 323 local files = FilesForArch(arch) 324 local cfg = ARCHITECTURES[arch] 325 326 if not FLAGS.reuse_gcsuspects then 327 GenerateGCSuspects(arch, files, cfg) 328 end 329 330 local processed_files = 0 331 local errors_found = false 332 local function SearchForErrors(filename, lines) 333 processed_files = processed_files + 1 334 for l in lines do 335 errors_found = errors_found or 336 l:match "^[^:]+:%d+:%d+:" or 337 l:match "error" or 338 l:match "warning" 339 print(l) 340 end 341 end 342 343 log("** Searching for evaluation order problems%s for %s", 344 FLAGS.dead_vars and " and dead variables" or "", 345 arch) 346 local plugin_args 347 if FLAGS.dead_vars then plugin_args = { "--dead-vars" } end 348 InvokeClangPluginForEachFile(files, 349 cfg:extend { plugin = "find-problems", 350 plugin_args = plugin_args }, 351 SearchForErrors) 352 log("** Done processing %d files. %s", 353 processed_files, 354 errors_found and "Errors found" or "No errors found") 355 356 return errors_found 357end 358 359local function SafeCheckCorrectnessForArch(arch) 360 local status, errors = pcall(CheckCorrectnessForArch, arch) 361 if not status then 362 print(string.format("There was an error: %s", errors)) 363 errors = true 364 end 365 return errors 366end 367 368local errors = false 369 370for _, arch in ipairs(ARCHS) do 371 if not ARCHITECTURES[arch] then 372 error ("Unknown arch: " .. arch) 373 end 374 375 errors = SafeCheckCorrectnessForArch(arch, report) or errors 376end 377 378os.exit(errors and 1 or 0) 379