• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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   -- Don't use parallel python runner.
38   sequential = false;
39
40   -- Print commands to console before executing them.
41   verbose = false;
42
43   -- Perform dead variable analysis (generates many false positives).
44   -- TODO add some sort of whiteliste to filter out false positives.
45   dead_vars = false;
46
47   -- When building gcsuspects whitelist certain functions as if they
48   -- can be causing GC. Currently used to reduce number of false
49   -- positives in dead variables analysis. See TODO for WHITELIST
50   -- below.
51   whitelist = true;
52}
53local ARGS = {}
54
55for i = 1, #arg do
56   local flag = arg[i]:match "^%-%-([%w_-]+)$"
57   if flag then
58      local no, real_flag = flag:match "^(no)([%w_-]+)$"
59      if real_flag then flag = real_flag end
60
61      flag = flag:gsub("%-", "_")
62      if FLAGS[flag] ~= nil then
63         FLAGS[flag] = (no ~= "no")
64      else
65         error("Unknown flag: " .. flag)
66      end
67   else
68      table.insert(ARGS, arg[i])
69   end
70end
71
72local ARCHS = ARGS[1] and { ARGS[1] } or { 'ia32', 'arm', 'x64', 'arm64' }
73
74local io = require "io"
75local os = require "os"
76
77function log(...)
78   io.stderr:write(string.format(...))
79   io.stderr:write "\n"
80end
81
82-------------------------------------------------------------------------------
83-- Clang invocation
84
85local CLANG_BIN = os.getenv "CLANG_BIN"
86local CLANG_PLUGINS = os.getenv "CLANG_PLUGINS"
87
88if not CLANG_BIN or CLANG_BIN == "" then
89   error "CLANG_BIN not set"
90end
91
92if not CLANG_PLUGINS or CLANG_PLUGINS == "" then
93   CLANG_PLUGINS = DIR
94end
95
96local function MakeClangCommandLine(
97      plugin, plugin_args, triple, arch_define, arch_options)
98   if plugin_args then
99     for i = 1, #plugin_args do
100        plugin_args[i] = "-Xclang -plugin-arg-" .. plugin
101           .. " -Xclang " .. plugin_args[i]
102     end
103     plugin_args = " " .. table.concat(plugin_args, " ")
104   end
105   return CLANG_BIN .. "/clang++ -std=c++11 -c "
106      .. " -Xclang -load -Xclang " .. CLANG_PLUGINS .. "/libgcmole.so"
107      .. " -Xclang -plugin -Xclang "  .. plugin
108      .. (plugin_args or "")
109      .. " -Xclang -triple -Xclang " .. triple
110      .. " -D" .. arch_define
111      .. " -DENABLE_DEBUGGER_SUPPORT"
112      .. " -DV8_I18N_SUPPORT"
113      .. " -I./"
114      .. " -Iinclude/"
115      .. " -Ithird_party/icu/source/common"
116      .. " -Ithird_party/icu/source/i18n"
117      .. " " .. arch_options
118end
119
120local function IterTable(t)
121  return coroutine.wrap(function ()
122    for i, v in ipairs(t) do
123      coroutine.yield(v)
124    end
125  end)
126end
127
128local function SplitResults(lines, func)
129   -- Splits the output of parallel.py and calls func on each result.
130   -- Bails out in case of an error in one of the executions.
131   local current = {}
132   local filename = ""
133   for line in lines do
134      local new_file = line:match "^______________ (.*)$"
135      local code = line:match "^______________ finish (%d+) ______________$"
136      if code then
137         if tonumber(code) > 0 then
138            log(table.concat(current, "\n"))
139            log("Failed to examine " .. filename)
140            return false
141         end
142         log("-- %s", filename)
143         func(filename, IterTable(current))
144      elseif new_file then
145         filename = new_file
146         current = {}
147      else
148         table.insert(current, line)
149      end
150   end
151   return true
152end
153
154function InvokeClangPluginForEachFile(filenames, cfg, func)
155   local cmd_line = MakeClangCommandLine(cfg.plugin,
156                                         cfg.plugin_args,
157                                         cfg.triple,
158                                         cfg.arch_define,
159                                         cfg.arch_options)
160   if FLAGS.sequential then
161      log("** Sequential execution.")
162      for _, filename in ipairs(filenames) do
163         log("-- %s", filename)
164         local action = cmd_line .. " " .. filename .. " 2>&1"
165         if FLAGS.verbose then print('popen ', action) end
166         local pipe = io.popen(action)
167         func(filename, pipe:lines())
168         local success = pipe:close()
169         if not success then error("Failed to run: " .. action) end
170      end
171   else
172      log("** Parallel execution.")
173      local action = "python tools/gcmole/parallel.py \""
174         .. cmd_line .. "\" " .. table.concat(filenames, " ")
175      if FLAGS.verbose then print('popen ', action) end
176      local pipe = io.popen(action)
177      local success = SplitResults(pipe:lines(), func)
178      local closed = pipe:close()
179      if not (success and closed) then error("Failed to run: " .. action) end
180   end
181end
182
183-------------------------------------------------------------------------------
184-- GYP file parsing
185
186local function ParseGYPFile()
187   local result = {}
188   local gyp_files = {
189       { "src/v8.gyp",             "'([^']-%.cc)'",      "src/"         },
190       { "test/cctest/cctest.gyp", "'(test-[^']-%.cc)'", "test/cctest/" }
191   }
192
193   for i = 1, #gyp_files do
194      local filename = gyp_files[i][1]
195      local pattern = gyp_files[i][2]
196      local prefix = gyp_files[i][3]
197      local gyp_file = assert(io.open(filename), "failed to open GYP file")
198      local gyp = gyp_file:read('*a')
199      for condition, sources in
200         gyp:gmatch "'sources': %[.-### gcmole%((.-)%) ###(.-)%]" do
201         if result[condition] == nil then result[condition] = {} end
202         for file in sources:gmatch(pattern) do
203            table.insert(result[condition], prefix .. file)
204         end
205      end
206      gyp_file:close()
207   end
208
209   return result
210end
211
212local function EvaluateCondition(cond, props)
213   if cond == 'all' then return true end
214
215   local p, v = cond:match "(%w+):(%w+)"
216
217   assert(p and v, "failed to parse condition: " .. cond)
218   assert(props[p] ~= nil, "undefined configuration property: " .. p)
219
220   return props[p] == v
221end
222
223local function BuildFileList(sources, props)
224   local list = {}
225   for condition, files in pairs(sources) do
226      if EvaluateCondition(condition, props) then
227         for i = 1, #files do table.insert(list, files[i]) end
228      end
229   end
230   return list
231end
232
233local sources = ParseGYPFile()
234
235local function FilesForArch(arch)
236   return BuildFileList(sources, { os = 'linux',
237                                   arch = arch,
238                                   mode = 'debug',
239                                   simulator = ''})
240end
241
242local mtConfig = {}
243
244mtConfig.__index = mtConfig
245
246local function config (t) return setmetatable(t, mtConfig) end
247
248function mtConfig:extend(t)
249   local e = {}
250   for k, v in pairs(self) do e[k] = v end
251   for k, v in pairs(t) do e[k] = v end
252   return config(e)
253end
254
255local ARCHITECTURES = {
256   ia32 = config { triple = "i586-unknown-linux",
257                   arch_define = "V8_TARGET_ARCH_IA32",
258                   arch_options = "-m32" },
259   arm = config { triple = "i586-unknown-linux",
260                  arch_define = "V8_TARGET_ARCH_ARM",
261                  arch_options = "-m32" },
262   x64 = config { triple = "x86_64-unknown-linux",
263                  arch_define = "V8_TARGET_ARCH_X64",
264                  arch_options = "" },
265   arm64 = config { triple = "x86_64-unknown-linux",
266                    arch_define = "V8_TARGET_ARCH_ARM64",
267                    arch_options = "" },
268}
269
270-------------------------------------------------------------------------------
271-- GCSuspects Generation
272
273local gc, gc_caused, funcs
274
275local WHITELIST = {
276   -- The following functions call CEntryStub which is always present.
277   "MacroAssembler.*CallExternalReference",
278   "MacroAssembler.*CallRuntime",
279   "CompileCallLoadPropertyWithInterceptor",
280   "CallIC.*GenerateMiss",
281
282   -- DirectCEntryStub is a special stub used on ARM.
283   -- It is pinned and always present.
284   "DirectCEntryStub.*GenerateCall",
285
286   -- TODO GCMole currently is sensitive enough to understand that certain
287   --      functions only cause GC and return Failure simulataneously.
288   --      Callsites of such functions are safe as long as they are properly
289   --      check return value and propagate the Failure to the caller.
290   --      It should be possible to extend GCMole to understand this.
291   "Heap.*AllocateFunctionPrototype",
292
293   -- Ignore all StateTag methods.
294   "StateTag",
295
296   -- Ignore printing of elements transition.
297   "PrintElementsTransition"
298};
299
300local function AddCause(name, cause)
301   local t = gc_caused[name]
302   if not t then
303      t = {}
304      gc_caused[name] = t
305   end
306   table.insert(t, cause)
307end
308
309local function resolve(name)
310   local f = funcs[name]
311
312   if not f then
313      f = {}
314      funcs[name] = f
315
316      if name:match "Collect.*Garbage" then
317         gc[name] = true
318         AddCause(name, "<GC>")
319      end
320
321      if FLAGS.whitelist then
322         for i = 1, #WHITELIST do
323            if name:match(WHITELIST[i]) then
324               gc[name] = false
325            end
326         end
327      end
328   end
329
330    return f
331end
332
333local function parse (filename, lines)
334   local scope
335
336   for funcname in lines do
337      if funcname:sub(1, 1) ~= '\t' then
338         resolve(funcname)
339         scope = funcname
340      else
341         local name = funcname:sub(2)
342         resolve(name)[scope] = true
343      end
344   end
345end
346
347local function propagate ()
348   log "** Propagating GC information"
349
350   local function mark(from, callers)
351      for caller, _ in pairs(callers) do
352         if gc[caller] == nil then
353            gc[caller] = true
354            mark(caller, funcs[caller])
355         end
356         AddCause(caller, from)
357      end
358   end
359
360   for funcname, callers in pairs(funcs) do
361      if gc[funcname] then mark(funcname, callers) end
362   end
363end
364
365local function GenerateGCSuspects(arch, files, cfg)
366   -- Reset the global state.
367   gc, gc_caused, funcs = {}, {}, {}
368
369   log ("** Building GC Suspects for %s", arch)
370   InvokeClangPluginForEachFile (files,
371                                 cfg:extend { plugin = "dump-callees" },
372                                 parse)
373
374   propagate()
375
376   local out = assert(io.open("gcsuspects", "w"))
377   for name, value in pairs(gc) do if value then out:write (name, '\n') end end
378   out:close()
379
380   local out = assert(io.open("gccauses", "w"))
381   out:write "GC = {"
382   for name, causes in pairs(gc_caused) do
383      out:write("['", name, "'] = {")
384      for i = 1, #causes do out:write ("'", causes[i], "';") end
385      out:write("};\n")
386   end
387   out:write "}"
388   out:close()
389
390   log ("** GCSuspects generated for %s", arch)
391end
392
393--------------------------------------------------------------------------------
394-- Analysis
395
396local function CheckCorrectnessForArch(arch)
397   local files = FilesForArch(arch)
398   local cfg = ARCHITECTURES[arch]
399
400   if not FLAGS.reuse_gcsuspects then
401      GenerateGCSuspects(arch, files, cfg)
402   end
403
404   local processed_files = 0
405   local errors_found = false
406   local function SearchForErrors(filename, lines)
407      processed_files = processed_files + 1
408      for l in lines do
409         errors_found = errors_found or
410            l:match "^[^:]+:%d+:%d+:" or
411            l:match "error" or
412            l:match "warning"
413         print(l)
414      end
415   end
416
417   log("** Searching for evaluation order problems%s for %s",
418       FLAGS.dead_vars and " and dead variables" or "",
419       arch)
420   local plugin_args
421   if FLAGS.dead_vars then plugin_args = { "--dead-vars" } end
422   InvokeClangPluginForEachFile(files,
423                                cfg:extend { plugin = "find-problems",
424                                             plugin_args = plugin_args },
425                                SearchForErrors)
426   log("** Done processing %d files. %s",
427       processed_files,
428       errors_found and "Errors found" or "No errors found")
429
430   return errors_found
431end
432
433local function SafeCheckCorrectnessForArch(arch)
434   local status, errors = pcall(CheckCorrectnessForArch, arch)
435   if not status then
436      print(string.format("There was an error: %s", errors))
437      errors = true
438   end
439   return errors
440end
441
442local errors = false
443
444for _, arch in ipairs(ARCHS) do
445   if not ARCHITECTURES[arch] then
446      error ("Unknown arch: " .. arch)
447   end
448
449   errors = SafeCheckCorrectnessForArch(arch, report) or errors
450end
451
452os.exit(errors and 1 or 0)
453