blob: 2015b2f0ed09d4cebe0ea918323fb20dd0d1577d [file] [log] [blame]
Daniel Dunbar378530c2009-01-05 19:53:30 +00001import os
Daniel Dunbar4ed45ea2009-01-09 01:00:40 +00002import platform
Daniel Dunbara95c6392009-02-19 22:59:57 +00003import subprocess
Daniel Dunbar378530c2009-01-05 19:53:30 +00004import sys
5import tempfile
6from pprint import pprint
7
8###
9
10import Arguments
11import Jobs
Daniel Dunbar4ed45ea2009-01-09 01:00:40 +000012import HostInfo
Daniel Dunbar378530c2009-01-05 19:53:30 +000013import Phases
14import Tools
15import Types
16import Util
17
18# FIXME: Clean up naming of options and arguments. Decide whether to
19# rename Option and be consistent about use of Option/Arg.
20
21####
22
Daniel Dunbar378530c2009-01-05 19:53:30 +000023class Driver(object):
Daniel Dunbara0026f22009-01-16 23:12:12 +000024 def __init__(self, driverName, driverDir):
25 self.driverName = driverName
26 self.driverDir = driverDir
Daniel Dunbar4ed45ea2009-01-09 01:00:40 +000027 self.hostInfo = None
Daniel Dunbare9f1a692009-01-06 06:12:13 +000028 self.parser = Arguments.OptionParser()
Daniel Dunbar7c2f91b2009-01-14 01:03:36 +000029 self.cccHostBits = self.cccHostMachine = None
30 self.cccHostSystem = self.cccHostRelease = None
31 self.cccCXX = False
Daniel Dunbar4c751dc2009-01-14 01:32:05 +000032 self.cccEcho = False
Daniel Dunbar7c2f91b2009-01-14 01:03:36 +000033 self.cccFallback = False
Daniel Dunbar72999172009-01-29 23:54:06 +000034 self.cccNoClang = self.cccNoClangCXX = self.cccNoClangPreprocessor = False
35 self.cccClangArchs = None
Daniel Dunbar378530c2009-01-05 19:53:30 +000036
Daniel Dunbar8fd28cd2009-01-28 19:26:20 +000037 # Certain options suppress the 'no input files' warning.
38 self.suppressMissingInputWarning = False
39
Daniel Dunbar61320532009-02-22 01:23:52 +000040 # Temporary files used in compilation, removed on exit.
41 self.tempFiles = []
42 # Result files produced by compilation, removed on error.
43 self.resultFiles = []
44
Daniel Dunbardbc9ee92009-01-09 22:21:24 +000045 # Host queries which can be forcibly over-riden by the user for
46 # testing purposes.
47 #
48 # FIXME: We should make sure these are drawn from a fixed set so
49 # that nothing downstream ever plays a guessing game.
50
51 def getHostBits(self):
52 if self.cccHostBits:
53 return self.cccHostBits
54
55 return platform.architecture()[0].replace('bit','')
56
57 def getHostMachine(self):
58 if self.cccHostMachine:
59 return self.cccHostMachine
60
61 machine = platform.machine()
62 # Normalize names.
63 if machine == 'Power Macintosh':
64 return 'ppc'
Daniel Dunbar405327e2009-01-27 19:29:51 +000065 if machine == 'x86_64':
66 return 'i386'
Daniel Dunbardbc9ee92009-01-09 22:21:24 +000067 return machine
68
69 def getHostSystemName(self):
70 if self.cccHostSystem:
71 return self.cccHostSystem
72
73 return platform.system().lower()
74
Daniel Dunbarc2148562009-01-12 04:21:12 +000075 def getHostReleaseName(self):
76 if self.cccHostRelease:
77 return self.cccHostRelease
78
79 return platform.release()
80
Daniel Dunbar4c751dc2009-01-14 01:32:05 +000081 def getenvBool(self, name):
82 var = os.getenv(name)
83 if not var:
84 return False
85
86 try:
87 return bool(int(var))
88 except:
89 return False
90
Daniel Dunbardbc9ee92009-01-09 22:21:24 +000091 ###
92
Daniel Dunbarf677a602009-01-21 02:03:52 +000093 def getFilePath(self, name, toolChain=None):
94 tc = toolChain or self.toolChain
95 for p in tc.filePathPrefixes:
96 path = os.path.join(p, name)
97 if os.path.exists(path):
98 return path
99 return name
100
101 def getProgramPath(self, name, toolChain=None):
102 tc = toolChain or self.toolChain
103 for p in tc.programPathPrefixes:
104 path = os.path.join(p, name)
105 if os.path.exists(path):
106 return path
107 return name
108
109 ###
110
Daniel Dunbar74727872009-01-06 01:35:44 +0000111 def run(self, argv):
Daniel Dunbar378530c2009-01-05 19:53:30 +0000112 # FIXME: Things to support from environment: GCC_EXEC_PREFIX,
113 # COMPILER_PATH, LIBRARY_PATH, LPATH, CC_PRINT_OPTIONS,
114 # QA_OVERRIDE_GCC3_OPTIONS, ...?
115
116 # FIXME: -V and -b processing
117
118 # Handle some special -ccc- options used for testing which are
119 # only allowed at the beginning of the command line.
120 cccPrintOptions = False
121 cccPrintPhases = False
Daniel Dunbardbc9ee92009-01-09 22:21:24 +0000122
123 # FIXME: How to handle override of host? ccc specific options?
124 # Abuse -b?
Daniel Dunbar72999172009-01-29 23:54:06 +0000125 arg = os.getenv('CCC_ADD_ARGS')
126 if arg:
127 args = filter(None, map(str.strip, arg.split(',')))
128 argv = args + argv
Daniel Dunbar4c751dc2009-01-14 01:32:05 +0000129
Daniel Dunbar74727872009-01-06 01:35:44 +0000130 while argv and argv[0].startswith('-ccc-'):
Daniel Dunbara0026f22009-01-16 23:12:12 +0000131 fullOpt,argv = argv[0],argv[1:]
132 opt = fullOpt[5:]
Daniel Dunbar378530c2009-01-05 19:53:30 +0000133
134 if opt == 'print-options':
135 cccPrintOptions = True
136 elif opt == 'print-phases':
137 cccPrintPhases = True
Daniel Dunbar7c2f91b2009-01-14 01:03:36 +0000138 elif opt == 'cxx':
139 self.cccCXX = True
Daniel Dunbar4c751dc2009-01-14 01:32:05 +0000140 elif opt == 'echo':
141 self.cccEcho = True
Daniel Dunbar7c2f91b2009-01-14 01:03:36 +0000142 elif opt == 'fallback':
143 self.cccFallback = True
Daniel Dunbar72999172009-01-29 23:54:06 +0000144
145 elif opt == 'no-clang':
146 self.cccNoClang = True
147 elif opt == 'no-clang-cxx':
148 self.cccNoClangCXX = True
149 elif opt == 'no-clang-cpp':
150 self.cccNoClangPreprocessor = True
151 elif opt == 'clang-archs':
152 self.cccClangArchs,argv = argv[0].split(','),argv[1:]
153
Daniel Dunbar4ed45ea2009-01-09 01:00:40 +0000154 elif opt == 'host-bits':
Daniel Dunbardbc9ee92009-01-09 22:21:24 +0000155 self.cccHostBits,argv = argv[0],argv[1:]
Daniel Dunbar4ed45ea2009-01-09 01:00:40 +0000156 elif opt == 'host-machine':
Daniel Dunbardbc9ee92009-01-09 22:21:24 +0000157 self.cccHostMachine,argv = argv[0],argv[1:]
Daniel Dunbar4ed45ea2009-01-09 01:00:40 +0000158 elif opt == 'host-system':
Daniel Dunbardbc9ee92009-01-09 22:21:24 +0000159 self.cccHostSystem,argv = argv[0],argv[1:]
Daniel Dunbarc2148562009-01-12 04:21:12 +0000160 elif opt == 'host-release':
161 self.cccHostRelease,argv = argv[0],argv[1:]
Daniel Dunbar378530c2009-01-05 19:53:30 +0000162 else:
Daniel Dunbara0026f22009-01-16 23:12:12 +0000163 raise Arguments.InvalidArgumentsError("invalid option: %r" % fullOpt)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000164
Daniel Dunbardbc9ee92009-01-09 22:21:24 +0000165 self.hostInfo = HostInfo.getHostInfo(self)
Daniel Dunbar08dea462009-01-10 02:07:54 +0000166 self.toolChain = self.hostInfo.getToolChain()
Daniel Dunbar4ed45ea2009-01-09 01:00:40 +0000167
Daniel Dunbar74727872009-01-06 01:35:44 +0000168 args = self.parser.parseArgs(argv)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000169
170 # FIXME: Ho hum I have just realized -Xarch_ is broken. We really
171 # need to reparse the Arguments after they have been expanded by
172 # -Xarch. How is this going to work?
173 #
174 # Scratch that, we aren't going to do that; it really disrupts the
175 # organization, doesn't consistently work with gcc-dd, and is
176 # confusing. Instead we are going to enforce that -Xarch_ is only
177 # used with options which do not alter the driver behavior. Let's
178 # hope this is ok, because the current architecture is a little
179 # tied to it.
180
181 if cccPrintOptions:
Daniel Dunbar74727872009-01-06 01:35:44 +0000182 self.printOptions(args)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000183 sys.exit(0)
184
Daniel Dunbar74727872009-01-06 01:35:44 +0000185 self.handleImmediateOptions(args)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000186
Daniel Dunbar4ed45ea2009-01-09 01:00:40 +0000187 if self.hostInfo.useDriverDriver():
Daniel Dunbar74727872009-01-06 01:35:44 +0000188 phases = self.buildPipeline(args)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000189 else:
Daniel Dunbar74727872009-01-06 01:35:44 +0000190 phases = self.buildNormalPipeline(args)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000191
192 if cccPrintPhases:
Daniel Dunbar74727872009-01-06 01:35:44 +0000193 self.printPhases(phases, args)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000194 sys.exit(0)
Daniel Dunbar4ed45ea2009-01-09 01:00:40 +0000195
Daniel Dunbar378530c2009-01-05 19:53:30 +0000196 if 0:
197 print Util.pprint(phases)
198
Daniel Dunbar74727872009-01-06 01:35:44 +0000199 jobs = self.bindPhases(phases, args)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000200
201 # FIXME: We should provide some basic sanity checking of the
202 # pipeline as a "verification" sort of stage. For example, the
203 # pipeline should never end up writing to an output file in two
204 # places (I think). The pipeline should also never end up writing
205 # to an output file that is an input.
206 #
207 # This is intended to just be a "verify" step, not a functionality
208 # step. It should catch things like the driver driver not
209 # preventing -save-temps, but it shouldn't change behavior (so we
210 # can turn it off in Release-Asserts builds).
211
212 # Print in -### syntax.
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000213 hasHashHashHash = args.getLastArg(self.parser.hashHashHashOption)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000214 if hasHashHashHash:
215 self.claim(hasHashHashHash)
216 for j in jobs.iterjobs():
217 if isinstance(j, Jobs.Command):
Daniel Dunbard87b6ec2009-01-12 19:36:35 +0000218 print >>sys.stderr, ' "%s"' % '" "'.join(j.getArgv())
Daniel Dunbar378530c2009-01-05 19:53:30 +0000219 elif isinstance(j, Jobs.PipedJob):
220 for c in j.commands:
Daniel Dunbard87b6ec2009-01-12 19:36:35 +0000221 print >>sys.stderr, ' "%s" %c' % ('" "'.join(c.getArgv()),
222 "| "[c is j.commands[-1]])
Daniel Dunbar378530c2009-01-05 19:53:30 +0000223 elif not isinstance(j, JobList):
224 raise ValueError,'Encountered unknown job.'
225 sys.exit(0)
226
Daniel Dunbar61320532009-02-22 01:23:52 +0000227 try:
228 try:
229 self.executeJobs(args, jobs)
230 except:
Daniel Dunbar5baec4d2009-02-23 23:37:18 +0000231 if not args.getLastArg(self.parser.saveTempsOption):
232 for f in self.resultFiles:
233 # Fail if removing a result fails:
234 if os.path.exists(f):
235 os.remove(f)
Daniel Dunbar61320532009-02-22 01:23:52 +0000236 raise
237 finally:
238 for f in self.tempFiles:
239 # Ignore failures in removing temporary files
240 try:
241 os.remove(f)
242 except:
243 pass
244
245 def executeJobs(self, args, jobs):
Daniel Dunbar8fd28cd2009-01-28 19:26:20 +0000246 vArg = args.getLastArg(self.parser.vOption)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000247 for j in jobs.iterjobs():
248 if isinstance(j, Jobs.Command):
Daniel Dunbar8fd28cd2009-01-28 19:26:20 +0000249 if vArg or self.cccEcho:
250 print >>sys.stderr, ' '.join(map(str,j.getArgv()))
Anders Carlsson76613bf2009-01-18 02:54:17 +0000251 sys.stderr.flush()
Daniel Dunbara95c6392009-02-19 22:59:57 +0000252 p = self.startSubprocess(j.getArgv(), j.executable)
253 res = p.wait()
Daniel Dunbar378530c2009-01-05 19:53:30 +0000254 if res:
255 sys.exit(res)
Daniel Dunbara95c6392009-02-19 22:59:57 +0000256
Daniel Dunbar378530c2009-01-05 19:53:30 +0000257 elif isinstance(j, Jobs.PipedJob):
Daniel Dunbare19ed8e2009-01-17 02:02:35 +0000258 procs = []
259 for sj in j.commands:
Daniel Dunbar8fd28cd2009-01-28 19:26:20 +0000260 if vArg or self.cccEcho:
261 print >> sys.stderr, ' '.join(map(str,sj.getArgv()))
Daniel Dunbare19ed8e2009-01-17 02:02:35 +0000262 sys.stdout.flush()
263
264 if not procs:
265 stdin = None
266 else:
267 stdin = procs[-1].stdout
268 if sj is j.commands[-1]:
269 stdout = None
270 else:
271 stdout = subprocess.PIPE
Daniel Dunbara95c6392009-02-19 22:59:57 +0000272
273 procs.append(self.startSubprocess(sj.getArgv(), sj.executable,
274 stdin=stdin,
275 stdout=stdout))
276
Daniel Dunbare19ed8e2009-01-17 02:02:35 +0000277 for proc in procs:
278 res = proc.wait()
279 if res:
280 sys.exit(res)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000281 else:
282 raise ValueError,'Encountered unknown job.'
283
Daniel Dunbara95c6392009-02-19 22:59:57 +0000284 def startSubprocess(self, argv, executable, **kwargs):
285 try:
286 return subprocess.Popen(argv, executable=executable, **kwargs)
287 except OSError, e:
288 self.warning("error trying to exec '%s': %s" %
289 (executable, e.args[1]))
290 sys.exit(1)
291
Daniel Dunbar378530c2009-01-05 19:53:30 +0000292 def claim(self, option):
293 # FIXME: Move to OptionList once introduced and implement.
294 pass
295
296 def warning(self, message):
Daniel Dunbara0026f22009-01-16 23:12:12 +0000297 print >>sys.stderr,'%s: %s' % (self.driverName, message)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000298
Daniel Dunbar74727872009-01-06 01:35:44 +0000299 def printOptions(self, args):
300 for i,arg in enumerate(args):
Daniel Dunbar74727872009-01-06 01:35:44 +0000301 if isinstance(arg, Arguments.MultipleValuesArg):
302 values = list(args.getValues(arg))
303 elif isinstance(arg, Arguments.ValueArg):
304 values = [args.getValue(arg)]
305 elif isinstance(arg, Arguments.JoinedAndSeparateValuesArg):
306 values = [args.getJoinedValue(arg), args.getSeparateValue(arg)]
Daniel Dunbar378530c2009-01-05 19:53:30 +0000307 else:
308 values = []
Daniel Dunbar927a5092009-01-06 02:30:10 +0000309 print 'Option %d - Name: "%s", Values: {%s}' % (i, arg.opt.name,
Daniel Dunbar378530c2009-01-05 19:53:30 +0000310 ', '.join(['"%s"' % v
311 for v in values]))
312
Daniel Dunbar74727872009-01-06 01:35:44 +0000313 def printPhases(self, phases, args):
Daniel Dunbar378530c2009-01-05 19:53:30 +0000314 def printPhase(p, f, steps, arch=None):
315 if p in steps:
316 return steps[p]
317 elif isinstance(p, Phases.BindArchAction):
318 for kid in p.inputs:
319 printPhase(kid, f, steps, p.arch)
320 steps[p] = len(steps)
321 return
322
323 if isinstance(p, Phases.InputAction):
324 phaseName = 'input'
Daniel Dunbar74727872009-01-06 01:35:44 +0000325 inputStr = '"%s"' % args.getValue(p.filename)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000326 else:
327 phaseName = p.phase.name
328 inputs = [printPhase(i, f, steps, arch)
329 for i in p.inputs]
330 inputStr = '{%s}' % ', '.join(map(str, inputs))
331 if arch is not None:
Daniel Dunbar74727872009-01-06 01:35:44 +0000332 phaseName += '-' + args.getValue(arch)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000333 steps[p] = index = len(steps)
334 print "%d: %s, %s, %s" % (index,phaseName,inputStr,p.type.name)
335 return index
336 steps = {}
337 for phase in phases:
338 printPhase(phase, sys.stdout, steps)
Daniel Dunbar8fd28cd2009-01-28 19:26:20 +0000339
340 def printVersion(self):
341 # FIXME: Print default target triple.
Mike Stump406abf62009-02-11 01:01:17 +0000342 vers = '$HeadURL$'
343 vers = vers.split('/tools/ccc')[0]
Mike Stump6bf3bd42009-02-11 01:11:36 +0000344 vers = vers.split('/clang/tools/clang')[0]
Mike Stump406abf62009-02-11 01:01:17 +0000345 vers = ' (' + vers[10:] + ')'
346 print >>sys.stderr,'ccc version 1.0' + vers
Daniel Dunbar378530c2009-01-05 19:53:30 +0000347
Daniel Dunbar74727872009-01-06 01:35:44 +0000348 def handleImmediateOptions(self, args):
Daniel Dunbar378530c2009-01-05 19:53:30 +0000349 # FIXME: Some driver Arguments are consumed right off the bat,
350 # like -dumpversion. Currently the gcc-dd handles these
351 # poorly, so we should be ok handling them upfront instead of
352 # after driver-driver level dispatching.
353 #
354 # FIXME: The actual order of these options in gcc is all over the
355 # place. The -dump ones seem to be first and in specification
356 # order, but there are other levels of precedence. For example,
357 # -print-search-dirs is evaluated before -print-prog-name=,
358 # regardless of order (and the last instance of -print-prog-name=
359 # wins verse itself).
360 #
361 # FIXME: Do we want to report "argument unused" type errors in the
362 # presence of things like -dumpmachine and -print-search-dirs?
363 # Probably not.
Daniel Dunbar8fd28cd2009-01-28 19:26:20 +0000364 if (args.getLastArg(self.parser.vOption) or
365 args.getLastArg(self.parser.hashHashHashOption)):
366 self.printVersion()
367 self.suppressMissingInputWarning = True
368
Daniel Dunbarf677a602009-01-21 02:03:52 +0000369 arg = (args.getLastArg(self.parser.dumpmachineOption) or
370 args.getLastArg(self.parser.dumpversionOption) or
371 args.getLastArg(self.parser.printSearchDirsOption))
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000372 if arg:
Daniel Dunbarf677a602009-01-21 02:03:52 +0000373 raise NotImplementedError('%s unsupported' % arg.opt.name)
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000374
Daniel Dunbarf677a602009-01-21 02:03:52 +0000375 arg = (args.getLastArg(self.parser.dumpspecsOption) or
376 args.getLastArg(self.parser.printMultiDirectoryOption) or
Daniel Dunbar73fb9072009-01-23 02:00:46 +0000377 args.getLastArg(self.parser.printMultiOsDirectoryOption) or
Daniel Dunbarf677a602009-01-21 02:03:52 +0000378 args.getLastArg(self.parser.printMultiLibOption))
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000379 if arg:
Daniel Dunbarf677a602009-01-21 02:03:52 +0000380 raise Arguments.InvalidArgumentsError('%s unsupported by this driver' % arg.opt.name)
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000381
382 arg = args.getLastArg(self.parser.printFileNameOption)
383 if arg:
Daniel Dunbarf677a602009-01-21 02:03:52 +0000384 print self.getFilePath(args.getValue(arg))
385 sys.exit(0)
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000386
387 arg = args.getLastArg(self.parser.printProgNameOption)
388 if arg:
Daniel Dunbarf677a602009-01-21 02:03:52 +0000389 print self.getProgramPath(args.getValue(arg))
390 sys.exit(0)
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000391
Daniel Dunbarf677a602009-01-21 02:03:52 +0000392 arg = args.getLastArg(self.parser.printLibgccFileNameOption)
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000393 if arg:
Daniel Dunbarf677a602009-01-21 02:03:52 +0000394 print self.getFilePath('libgcc.a')
395 sys.exit(0)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000396
Daniel Dunbar74727872009-01-06 01:35:44 +0000397 def buildNormalPipeline(self, args):
Daniel Dunbar90c72cd2009-01-21 01:07:49 +0000398 hasAnalyze = args.getLastArg(self.parser.analyzeOption)
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000399 hasCombine = args.getLastArg(self.parser.combineOption)
Daniel Dunbar34f60f62009-01-26 17:09:15 +0000400 hasEmitLLVM = args.getLastArg(self.parser.emitLLVMOption)
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000401 hasSyntaxOnly = args.getLastArg(self.parser.syntaxOnlyOption)
402 hasDashC = args.getLastArg(self.parser.cOption)
403 hasDashE = args.getLastArg(self.parser.EOption)
404 hasDashS = args.getLastArg(self.parser.SOption)
Daniel Dunbar445c46d2009-01-20 01:53:54 +0000405 hasDashM = args.getLastArg(self.parser.MOption)
406 hasDashMM = args.getLastArg(self.parser.MMOption)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000407
408 inputType = None
409 inputTypeOpt = None
410 inputs = []
411 for a in args:
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000412 if a.opt is self.parser.inputOption:
Daniel Dunbara0026f22009-01-16 23:12:12 +0000413 inputValue = args.getValue(a)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000414 if inputType is None:
Daniel Dunbara0026f22009-01-16 23:12:12 +0000415 base,ext = os.path.splitext(inputValue)
Daniel Dunbar6dbfa662009-02-05 23:44:44 +0000416 # stdin is handled specially.
417 if inputValue == '-':
418 if args.getLastArg(self.parser.EOption):
419 # Treat as a C input needing preprocessing
420 # (or Obj-C if over-ridden below).
421 klass = Types.CType
422 else:
423 raise Arguments.InvalidArgumentsError("-E or -x required when input is from standard input")
424 elif ext and ext in Types.kTypeSuffixMap:
Daniel Dunbar378530c2009-01-05 19:53:30 +0000425 klass = Types.kTypeSuffixMap[ext]
426 else:
427 # FIXME: Its not clear why we shouldn't just
428 # revert to unknown. I think this is more likely a
429 # bug / unintended behavior in gcc. Not very
430 # important though.
431 klass = Types.ObjectType
Daniel Dunbar6dbfa662009-02-05 23:44:44 +0000432
433 # -ObjC and -ObjC++ over-ride the default
434 # language, but only for "source files". We
435 # just treat everything that isn't a linker
436 # input as a source file.
437 #
438 # FIXME: Clean this up if we move the phase
439 # sequence into the type.
440 if klass is not Types.ObjectType:
441 if args.getLastArg(self.parser.ObjCOption):
442 klass = Types.ObjCType
443 elif args.getLastArg(self.parser.ObjCXXOption):
444 klass = Types.ObjCType
Daniel Dunbar378530c2009-01-05 19:53:30 +0000445 else:
446 assert inputTypeOpt is not None
447 self.claim(inputTypeOpt)
448 klass = inputType
Daniel Dunbara0026f22009-01-16 23:12:12 +0000449
450 # Check that the file exists. It isn't clear this is
451 # worth doing, since the tool presumably does this
452 # anyway, and this just adds an extra stat to the
453 # equation, but this is gcc compatible.
Daniel Dunbar34f60f62009-01-26 17:09:15 +0000454 if inputValue != '-' and not os.path.exists(inputValue):
Daniel Dunbara0026f22009-01-16 23:12:12 +0000455 self.warning("%s: No such file or directory" % inputValue)
456 else:
457 inputs.append((klass, a))
Daniel Dunbarfc2ad022009-01-12 03:33:58 +0000458 elif a.opt.isLinkerInput:
459 # Treat as a linker input.
Daniel Dunbar927a5092009-01-06 02:30:10 +0000460 #
461 # FIXME: This might not be good enough. We may
462 # need to introduce another type for this case, so
463 # that other code which needs to know the inputs
464 # handles this properly. Best not to try and lipo
465 # this, for example.
466 inputs.append((Types.ObjectType, a))
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000467 elif a.opt is self.parser.xOption:
Daniel Dunbar927a5092009-01-06 02:30:10 +0000468 inputTypeOpt = a
469 value = args.getValue(a)
470 if value in Types.kTypeSpecifierMap:
471 inputType = Types.kTypeSpecifierMap[value]
472 else:
473 # FIXME: How are we going to handle diagnostics.
474 self.warning("language %s not recognized" % value)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000475
Daniel Dunbar927a5092009-01-06 02:30:10 +0000476 # FIXME: Its not clear why we shouldn't just
477 # revert to unknown. I think this is more likely a
478 # bug / unintended behavior in gcc. Not very
479 # important though.
Daniel Dunbar6cb42052009-01-13 21:07:43 +0000480 inputType = Types.ObjectType
Daniel Dunbar378530c2009-01-05 19:53:30 +0000481
482 # We claim things here so that options for which we silently allow
483 # override only ever claim the used option.
484 if hasCombine:
485 self.claim(hasCombine)
486
487 finalPhase = Phases.Phase.eOrderPostAssemble
488 finalPhaseOpt = None
489
490 # Determine what compilation mode we are in.
Daniel Dunbar445c46d2009-01-20 01:53:54 +0000491 if hasDashE or hasDashM or hasDashMM:
Daniel Dunbar378530c2009-01-05 19:53:30 +0000492 finalPhase = Phases.Phase.eOrderPreprocess
493 finalPhaseOpt = hasDashE
Daniel Dunbar34f60f62009-01-26 17:09:15 +0000494 elif (hasAnalyze or hasSyntaxOnly or
495 hasEmitLLVM or hasDashS):
Daniel Dunbar90c72cd2009-01-21 01:07:49 +0000496 finalPhase = Phases.Phase.eOrderCompile
Daniel Dunbar34f60f62009-01-26 17:09:15 +0000497 finalPhaseOpt = (hasAnalyze or hasSyntaxOnly or
498 hasEmitLLVM or hasDashS)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000499 elif hasDashC:
500 finalPhase = Phases.Phase.eOrderAssemble
501 finalPhaseOpt = hasDashC
502
503 if finalPhaseOpt:
504 self.claim(finalPhaseOpt)
505
Daniel Dunbar80e48b72009-01-17 00:53:19 +0000506 # Reject -Z* at the top level for now.
507 arg = args.getLastArg(self.parser.ZOption)
508 if arg:
509 raise Arguments.InvalidArgumentsError("%s: unsupported use of internal gcc option" % ' '.join(args.render(arg)))
510
Daniel Dunbar8fd28cd2009-01-28 19:26:20 +0000511 if not inputs and not self.suppressMissingInputWarning:
Daniel Dunbara0026f22009-01-16 23:12:12 +0000512 raise Arguments.InvalidArgumentsError("no input files")
Daniel Dunbar378530c2009-01-05 19:53:30 +0000513
514 actions = []
515 linkerInputs = []
516 # FIXME: This is gross.
517 linkPhase = Phases.LinkPhase()
518 for klass,input in inputs:
519 # Figure out what step to start at.
520
521 # FIXME: This should be part of the input class probably?
522 # Altough it doesn't quite fit there either, things like
523 # asm-with-preprocess don't easily fit into a linear scheme.
524
525 # FIXME: I think we are going to end up wanting to just build
526 # a simple FSA which we run the inputs down.
527 sequence = []
528 if klass.preprocess:
529 sequence.append(Phases.PreprocessPhase())
530 if klass == Types.ObjectType:
531 sequence.append(linkPhase)
532 elif klass.onlyAssemble:
533 sequence.extend([Phases.AssemblePhase(),
534 linkPhase])
535 elif klass.onlyPrecompile:
536 sequence.append(Phases.PrecompilePhase())
Daniel Dunbar90c72cd2009-01-21 01:07:49 +0000537 elif hasAnalyze:
538 sequence.append(Phases.AnalyzePhase())
539 elif hasSyntaxOnly:
540 sequence.append(Phases.SyntaxOnlyPhase())
Daniel Dunbar34f60f62009-01-26 17:09:15 +0000541 elif hasEmitLLVM:
542 sequence.append(Phases.EmitLLVMPhase())
Daniel Dunbar378530c2009-01-05 19:53:30 +0000543 else:
544 sequence.extend([Phases.CompilePhase(),
545 Phases.AssemblePhase(),
546 linkPhase])
547
548 if sequence[0].order > finalPhase:
549 assert finalPhaseOpt and finalPhaseOpt.opt
550 # FIXME: Explain what type of input file is. Or just match
551 # gcc warning.
Daniel Dunbar74727872009-01-06 01:35:44 +0000552 self.warning("%s: %s input file unused when %s is present" % (args.getValue(input),
Daniel Dunbar378530c2009-01-05 19:53:30 +0000553 sequence[0].name,
554 finalPhaseOpt.opt.name))
555 else:
556 # Build the pipeline for this file.
557
558 current = Phases.InputAction(input, klass)
559 for transition in sequence:
560 # If the current action produces no output, or we are
561 # past what the user requested, we are done.
562 if (current.type is Types.NothingType or
563 transition.order > finalPhase):
564 break
565 else:
566 if isinstance(transition, Phases.PreprocessPhase):
567 assert isinstance(klass.preprocess, Types.InputType)
568 current = Phases.JobAction(transition,
569 [current],
570 klass.preprocess)
571 elif isinstance(transition, Phases.PrecompilePhase):
572 current = Phases.JobAction(transition,
573 [current],
574 Types.PCHType)
Daniel Dunbar90c72cd2009-01-21 01:07:49 +0000575 elif isinstance(transition, Phases.AnalyzePhase):
576 output = Types.PlistType
577 current = Phases.JobAction(transition,
578 [current],
579 output)
580 elif isinstance(transition, Phases.SyntaxOnlyPhase):
581 output = Types.NothingType
582 current = Phases.JobAction(transition,
583 [current],
584 output)
Daniel Dunbar34f60f62009-01-26 17:09:15 +0000585 elif isinstance(transition, Phases.EmitLLVMPhase):
586 if hasDashS:
587 output = Types.LLVMAsmType
588 else:
589 output = Types.LLVMBCType
590 current = Phases.JobAction(transition,
591 [current],
592 output)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000593 elif isinstance(transition, Phases.CompilePhase):
Daniel Dunbar90c72cd2009-01-21 01:07:49 +0000594 output = Types.AsmTypeNoPP
Daniel Dunbar378530c2009-01-05 19:53:30 +0000595 current = Phases.JobAction(transition,
596 [current],
597 output)
598 elif isinstance(transition, Phases.AssemblePhase):
599 current = Phases.JobAction(transition,
600 [current],
601 Types.ObjectType)
602 elif transition is linkPhase:
603 linkerInputs.append(current)
604 current = None
605 break
606 else:
607 raise RuntimeError,'Unrecognized transition: %s.' % transition
608 pass
609
610 if current is not None:
611 assert not isinstance(current, Phases.InputAction)
612 actions.append(current)
613
614 if linkerInputs:
615 actions.append(Phases.JobAction(linkPhase,
616 linkerInputs,
617 Types.ImageType))
618
619 return actions
620
Daniel Dunbar74727872009-01-06 01:35:44 +0000621 def buildPipeline(self, args):
Daniel Dunbar378530c2009-01-05 19:53:30 +0000622 # FIXME: We need to handle canonicalization of the specified arch.
623
Daniel Dunbar31c80812009-01-20 21:29:14 +0000624 archs = {}
Daniel Dunbar445c46d2009-01-20 01:53:54 +0000625 hasDashM = args.getLastArg(self.parser.MGroup)
Daniel Dunbara33176f2009-01-21 18:49:34 +0000626 hasSaveTemps = args.getLastArg(self.parser.saveTempsOption)
Daniel Dunbar74727872009-01-06 01:35:44 +0000627 for arg in args:
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000628 if arg.opt is self.parser.archOption:
Daniel Dunbar31c80812009-01-20 21:29:14 +0000629 # FIXME: Canonicalize this.
630 archName = args.getValue(arg)
631 archs[archName] = arg
632
633 archs = archs.values()
Daniel Dunbar378530c2009-01-05 19:53:30 +0000634 if not archs:
Daniel Dunbarf3d5ca02009-01-13 04:05:40 +0000635 archs.append(args.makeSeparateArg(self.hostInfo.getArchName(args),
Daniel Dunbar1ba90982009-01-07 18:54:26 +0000636 self.parser.archOption))
Daniel Dunbar378530c2009-01-05 19:53:30 +0000637
Daniel Dunbar74727872009-01-06 01:35:44 +0000638 actions = self.buildNormalPipeline(args)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000639
640 # FIXME: Use custom exception for this.
641 #
642 # FIXME: We killed off some others but these aren't yet detected in
643 # a functional manner. If we added information to jobs about which
644 # "auxiliary" files they wrote then we could detect the conflict
645 # these cause downstream.
646 if len(archs) > 1:
647 if hasDashM:
Daniel Dunbara0026f22009-01-16 23:12:12 +0000648 raise Arguments.InvalidArgumentsError("Cannot use -M options with multiple arch flags.")
Daniel Dunbar378530c2009-01-05 19:53:30 +0000649 elif hasSaveTemps:
Daniel Dunbara0026f22009-01-16 23:12:12 +0000650 raise Arguments.InvalidArgumentsError("Cannot use -save-temps with multiple arch flags.")
Daniel Dunbar378530c2009-01-05 19:53:30 +0000651
652 # Execute once per arch.
653 finalActions = []
654 for p in actions:
655 # Make sure we can lipo this kind of output. If not (and it
656 # is an actual output) then we disallow, since we can't
657 # create an output file with the right name without
658 # overwriting it. We could remove this oddity by just
659 # changing the output names to include the arch, which would
660 # also fix -save-temps. Compatibility wins for now.
661 #
662 # FIXME: Is this error substantially less useful than
663 # gcc-dd's? The main problem is that "Cannot use compiler
664 # output with multiple arch flags" won't make sense to most
665 # developers.
666 if (len(archs) > 1 and
667 p.type not in (Types.NothingType,Types.ObjectType,Types.ImageType)):
Daniel Dunbara0026f22009-01-16 23:12:12 +0000668 raise Arguments.InvalidArgumentsError('Cannot use %s output with multiple arch flags.' % p.type.name)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000669
670 inputs = []
671 for arch in archs:
672 inputs.append(Phases.BindArchAction(p, arch))
673
674 # Lipo if necessary. We do it this way because we need to set
675 # the arch flag so that -Xarch_ gets rewritten.
676 if len(inputs) == 1 or p.type == Types.NothingType:
677 finalActions.extend(inputs)
678 else:
679 finalActions.append(Phases.JobAction(Phases.LipoPhase(),
680 inputs,
681 p.type))
682
Daniel Dunbar378530c2009-01-05 19:53:30 +0000683 return finalActions
684
Daniel Dunbar74727872009-01-06 01:35:44 +0000685 def bindPhases(self, phases, args):
Daniel Dunbar378530c2009-01-05 19:53:30 +0000686 jobs = Jobs.JobList()
687
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000688 finalOutput = args.getLastArg(self.parser.oOption)
Daniel Dunbara33176f2009-01-21 18:49:34 +0000689 hasSaveTemps = args.getLastArg(self.parser.saveTempsOption)
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000690 hasNoIntegratedCPP = args.getLastArg(self.parser.noIntegratedCPPOption)
Daniel Dunbarf86e98a2009-01-12 09:23:15 +0000691 hasTraditionalCPP = args.getLastArg(self.parser.traditionalCPPOption)
Daniel Dunbare9f1a692009-01-06 06:12:13 +0000692 hasPipe = args.getLastArg(self.parser.pipeOption)
Daniel Dunbarfc2ad022009-01-12 03:33:58 +0000693
Daniel Dunbar378530c2009-01-05 19:53:30 +0000694 # We claim things here so that options for which we silently allow
695 # override only ever claim the used option.
696 if hasPipe:
697 self.claim(hasPipe)
698 # FIXME: Hack, override -pipe till we support it.
Daniel Dunbare19ed8e2009-01-17 02:02:35 +0000699 if hasSaveTemps:
700 self.warning('-pipe ignored because -save-temps specified')
701 hasPipe = None
Daniel Dunbar378530c2009-01-05 19:53:30 +0000702 # Claim these here. Its not completely accurate but any warnings
703 # about these being unused are likely to be noise anyway.
704 if hasSaveTemps:
705 self.claim(hasSaveTemps)
Daniel Dunbarf86e98a2009-01-12 09:23:15 +0000706
707 if hasTraditionalCPP:
708 self.claim(hasTraditionalCPP)
709 elif hasNoIntegratedCPP:
Daniel Dunbar378530c2009-01-05 19:53:30 +0000710 self.claim(hasNoIntegratedCPP)
Daniel Dunbarf86e98a2009-01-12 09:23:15 +0000711
Daniel Dunbare5fb6792009-01-13 06:25:31 +0000712 # FIXME: Move to... somewhere else.
Daniel Dunbar378530c2009-01-05 19:53:30 +0000713 class InputInfo:
714 def __init__(self, source, type, baseInput):
715 self.source = source
716 self.type = type
717 self.baseInput = baseInput
718
719 def __repr__(self):
720 return '%s(%r, %r, %r)' % (self.__class__.__name__,
721 self.source, self.type, self.baseInput)
Daniel Dunbare5fb6792009-01-13 06:25:31 +0000722
723 def isOriginalInput(self):
724 return self.source is self.baseInput
Daniel Dunbar378530c2009-01-05 19:53:30 +0000725
Daniel Dunbarb3492762009-01-13 18:51:26 +0000726 def createJobs(tc, phase,
727 canAcceptPipe=False, atTopLevel=False, arch=None,
Daniel Dunbar31c80812009-01-20 21:29:14 +0000728 tcArgs=None, linkingOutput=None):
Daniel Dunbar378530c2009-01-05 19:53:30 +0000729 if isinstance(phase, Phases.InputAction):
730 return InputInfo(phase.filename, phase.type, phase.filename)
731 elif isinstance(phase, Phases.BindArchAction):
Daniel Dunbar74727872009-01-06 01:35:44 +0000732 archName = args.getValue(phase.arch)
Daniel Dunbar758cf642009-01-11 22:06:22 +0000733 tc = self.hostInfo.getToolChainForArch(archName)
Daniel Dunbarb3492762009-01-13 18:51:26 +0000734 return createJobs(tc, phase.inputs[0],
735 canAcceptPipe, atTopLevel, phase.arch,
Daniel Dunbar31c80812009-01-20 21:29:14 +0000736 None, linkingOutput)
Daniel Dunbarb3492762009-01-13 18:51:26 +0000737
738 if tcArgs is None:
739 tcArgs = tc.translateArgs(args, arch)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000740
741 assert isinstance(phase, Phases.JobAction)
Daniel Dunbar758cf642009-01-11 22:06:22 +0000742 tool = tc.selectTool(phase)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000743
744 # See if we should use an integrated CPP. We only use an
745 # integrated cpp when we have exactly one input, since this is
746 # the only use case we care about.
747 useIntegratedCPP = False
748 inputList = phase.inputs
749 if (not hasNoIntegratedCPP and
Daniel Dunbarf86e98a2009-01-12 09:23:15 +0000750 not hasTraditionalCPP and
Daniel Dunbar378530c2009-01-05 19:53:30 +0000751 not hasSaveTemps and
752 tool.hasIntegratedCPP()):
753 if (len(phase.inputs) == 1 and
Daniel Dunbar7d494092009-01-20 00:47:24 +0000754 isinstance(phase.inputs[0], Phases.JobAction) and
Daniel Dunbar378530c2009-01-05 19:53:30 +0000755 isinstance(phase.inputs[0].phase, Phases.PreprocessPhase)):
756 useIntegratedCPP = True
757 inputList = phase.inputs[0].inputs
758
759 # Only try to use pipes when exactly one input.
Daniel Dunbar1e46f552009-01-22 23:19:32 +0000760 attemptToPipeInput = len(inputList) == 1 and tool.acceptsPipedInput()
761 inputs = [createJobs(tc, p, attemptToPipeInput, False,
Daniel Dunbar31c80812009-01-20 21:29:14 +0000762 arch, tcArgs, linkingOutput)
Daniel Dunbar758cf642009-01-11 22:06:22 +0000763 for p in inputList]
Daniel Dunbar378530c2009-01-05 19:53:30 +0000764
765 # Determine if we should output to a pipe.
766 canOutputToPipe = canAcceptPipe and tool.canPipeOutput()
767 outputToPipe = False
768 if canOutputToPipe:
769 # Some things default to writing to a pipe if the final
770 # phase and there was no user override.
771 #
772 # FIXME: What is the best way to handle this?
Daniel Dunbar1b391272009-01-18 21:35:24 +0000773 if atTopLevel:
774 if (isinstance(phase.phase, Phases.PreprocessPhase) and
775 not finalOutput):
776 outputToPipe = True
Daniel Dunbar378530c2009-01-05 19:53:30 +0000777 elif hasPipe:
778 outputToPipe = True
779
780 # Figure out where to put the job (pipes).
781 jobList = jobs
Daniel Dunbar1e46f552009-01-22 23:19:32 +0000782 if isinstance(inputs[0].source, Jobs.PipedJob):
Daniel Dunbar378530c2009-01-05 19:53:30 +0000783 jobList = inputs[0].source
Daniel Dunbar31c80812009-01-20 21:29:14 +0000784
Daniel Dunbar378530c2009-01-05 19:53:30 +0000785 baseInput = inputs[0].baseInput
Daniel Dunbard9b7a742009-01-21 00:05:15 +0000786 output,jobList = self.getOutputName(phase, outputToPipe, jobs, jobList, baseInput,
787 args, atTopLevel, hasSaveTemps, finalOutput)
Daniel Dunbarb421dba2009-01-07 18:40:45 +0000788 tool.constructJob(phase, arch, jobList, inputs, output, phase.type,
Daniel Dunbar31c80812009-01-20 21:29:14 +0000789 tcArgs, linkingOutput)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000790
791 return InputInfo(output, phase.type, baseInput)
792
793 # It is an error to provide a -o option if we are making multiple
794 # output files.
795 if finalOutput and len([a for a in phases if a.type is not Types.NothingType]) > 1:
Daniel Dunbara0026f22009-01-16 23:12:12 +0000796 raise Arguments.InvalidArgumentsError("cannot specify -o when generating multiple files")
Daniel Dunbar378530c2009-01-05 19:53:30 +0000797
798 for phase in phases:
Daniel Dunbar31c80812009-01-20 21:29:14 +0000799 # If we are linking an image for multiple archs then the
800 # linker wants -arch_multiple and -final_output <final image
801 # name>. Unfortunately this requires some gross contortions.
802 #
803 # FIXME: This is a hack; find a cleaner way to integrate this
804 # into the process.
805 linkingOutput = None
806 if (isinstance(phase, Phases.JobAction) and
807 isinstance(phase.phase, Phases.LipoPhase)):
808 finalOutput = args.getLastArg(self.parser.oOption)
809 if finalOutput:
810 linkingOutput = finalOutput
811 else:
812 linkingOutput = args.makeSeparateArg('a.out',
813 self.parser.oOption)
814
Daniel Dunbarb3492762009-01-13 18:51:26 +0000815 createJobs(self.toolChain, phase,
Daniel Dunbar31c80812009-01-20 21:29:14 +0000816 canAcceptPipe=True, atTopLevel=True,
817 linkingOutput=linkingOutput)
Daniel Dunbar378530c2009-01-05 19:53:30 +0000818
819 return jobs
Daniel Dunbar31c80812009-01-20 21:29:14 +0000820
821 def getOutputName(self, phase, outputToPipe, jobs, jobList, baseInput,
822 args, atTopLevel, hasSaveTemps, finalOutput):
823 # Figure out where to put the output.
824 if phase.type == Types.NothingType:
825 output = None
826 elif outputToPipe:
827 if isinstance(jobList, Jobs.PipedJob):
828 output = jobList
829 else:
830 jobList = output = Jobs.PipedJob([])
831 jobs.addJob(output)
832 else:
833 # Figure out what the derived output location would be.
Daniel Dunbar31c80812009-01-20 21:29:14 +0000834 if phase.type is Types.ImageType:
835 namedOutput = "a.out"
836 else:
Daniel Dunbar31c80812009-01-20 21:29:14 +0000837 assert phase.type.tempSuffix is not None
Daniel Dunbar0e8c48c2009-02-13 17:42:34 +0000838 inputName = args.getValue(baseInput)
839 if phase.type.appendSuffix:
840 namedOutput = inputName + '.' + phase.type.tempSuffix
841 else:
842 base,_ = os.path.splitext(inputName)
843 namedOutput = base + '.' + phase.type.tempSuffix
Daniel Dunbar31c80812009-01-20 21:29:14 +0000844
Daniel Dunbar61320532009-02-22 01:23:52 +0000845 isTemp = False
Daniel Dunbar31c80812009-01-20 21:29:14 +0000846 # Output to user requested destination?
847 if atTopLevel and finalOutput:
848 output = finalOutput
Daniel Dunbar61320532009-02-22 01:23:52 +0000849 self.resultFiles.append(args.getValue(finalOutput))
850
Daniel Dunbar31c80812009-01-20 21:29:14 +0000851 # Contruct a named destination?
852 elif atTopLevel or hasSaveTemps:
853 # As an annoying special case, pch generation
854 # doesn't strip the pathname.
855 if phase.type is Types.PCHType:
856 outputName = namedOutput
857 else:
858 outputName = os.path.basename(namedOutput)
859 output = args.makeSeparateArg(outputName,
860 self.parser.oOption)
Daniel Dunbar61320532009-02-22 01:23:52 +0000861 self.resultFiles.append(outputName)
862
Daniel Dunbar31c80812009-01-20 21:29:14 +0000863 else:
864 # Output to temp file...
865 fd,filename = tempfile.mkstemp(suffix='.'+phase.type.tempSuffix)
866 output = args.makeSeparateArg(filename,
867 self.parser.oOption)
Daniel Dunbar61320532009-02-22 01:23:52 +0000868 self.tempFiles.append(filename)
Daniel Dunbard9b7a742009-01-21 00:05:15 +0000869 return output,jobList