Separate bootstrapped build from final build
[platform/upstream/ninja.git] / configure.py
1 #!/usr/bin/env python
2 #
3 # Copyright 2001 Google Inc. All Rights Reserved.
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 #     http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 """Script that generates the build.ninja for ninja itself.
18
19 Projects that use ninja themselves should either write a similar script
20 or use a meta-build system that supports Ninja output."""
21
22 from __future__ import print_function
23
24 from optparse import OptionParser
25 import os
26 import pipes
27 import string
28 import subprocess
29 import sys
30
31 sourcedir = os.path.dirname(os.path.realpath(__file__))
32 sys.path.insert(0, os.path.join(sourcedir, 'misc'))
33 import ninja_syntax
34
35
36 class Platform(object):
37     """Represents a host/target platform and its specific build attributes."""
38     def __init__(self, platform):
39         self._platform = platform
40         if self._platform is not None:
41             return
42         self._platform = sys.platform
43         if self._platform.startswith('linux'):
44             self._platform = 'linux'
45         elif self._platform.startswith('freebsd'):
46             self._platform = 'freebsd'
47         elif self._platform.startswith('gnukfreebsd'):
48             self._platform = 'freebsd'
49         elif self._platform.startswith('openbsd'):
50             self._platform = 'openbsd'
51         elif self._platform.startswith('solaris') or self._platform == 'sunos5':
52             self._platform = 'solaris'
53         elif self._platform.startswith('mingw'):
54             self._platform = 'mingw'
55         elif self._platform.startswith('win'):
56             self._platform = 'msvc'
57         elif self._platform.startswith('bitrig'):
58             self._platform = 'bitrig'
59         elif self._platform.startswith('netbsd'):
60             self._platform = 'netbsd'
61         elif self._platform.startswith('aix'):
62             self._platform = 'aix'
63
64     @staticmethod
65     def known_platforms():
66       return ['linux', 'darwin', 'freebsd', 'openbsd', 'solaris', 'sunos5',
67               'mingw', 'msvc', 'gnukfreebsd', 'bitrig', 'netbsd', 'aix']
68
69     def platform(self):
70         return self._platform
71
72     def is_linux(self):
73         return self._platform == 'linux'
74
75     def is_mingw(self):
76         return self._platform == 'mingw'
77
78     def is_msvc(self):
79         return self._platform == 'msvc'
80
81     def msvc_needs_fs(self):
82         popen = subprocess.Popen(['cl', '/nologo', '/?'],
83                                  stdout=subprocess.PIPE,
84                                  stderr=subprocess.PIPE)
85         out, err = popen.communicate()
86         return '/FS ' in str(out)
87
88     def is_windows(self):
89         return self.is_mingw() or self.is_msvc()
90
91     def is_solaris(self):
92         return self._platform == 'solaris'
93
94     def is_aix(self):
95         return self._platform == 'aix'
96
97     def uses_usr_local(self):
98         return self._platform in ('freebsd', 'openbsd', 'bitrig')
99
100     def supports_ppoll(self):
101         return self._platform in ('linux', 'openbsd', 'bitrig')
102
103     def supports_ninja_browse(self):
104         return (not self.is_windows()
105                 and not self.is_solaris()
106                 and not self.is_aix())
107
108     def can_rebuild_in_place(self):
109         return not (self.is_windows() or self.is_aix())
110
111 class Bootstrap:
112     """API shim for ninja_syntax.Writer that instead runs the commands.
113
114     Used to bootstrap Ninja from scratch.  In --bootstrap mode this
115     class is used to execute all the commands to build an executable.
116     It also proxies all calls to an underlying ninja_syntax.Writer, to
117     behave like non-bootstrap mode.
118     """
119     def __init__(self, writer, verbose=False):
120         self.writer = writer
121         self.verbose = verbose
122         # Map of variable name => expanded variable value.
123         self.vars = {}
124         # Map of rule name => dict of rule attributes.
125         self.rules = {
126             'phony': {}
127         }
128
129     def comment(self, text):
130         return self.writer.comment(text)
131
132     def newline(self):
133         return self.writer.newline()
134
135     def variable(self, key, val):
136         self.vars[key] = self._expand(val)
137         return self.writer.variable(key, val)
138
139     def rule(self, name, **kwargs):
140         self.rules[name] = kwargs
141         return self.writer.rule(name, **kwargs)
142
143     def build(self, outputs, rule, inputs=None, **kwargs):
144         ruleattr = self.rules[rule]
145         cmd = ruleattr.get('command')
146         if cmd is None:  # A phony rule, for example.
147             return
148
149         # Implement just enough of Ninja variable expansion etc. to
150         # make the bootstrap build work.
151         local_vars = {
152             'in': self._expand_paths(inputs),
153             'out': self._expand_paths(outputs)
154         }
155         for key, val in kwargs.get('variables', []):
156             local_vars[key] = ' '.join(ninja_syntax.as_list(val))
157
158         self._run_command(self._expand(cmd, local_vars))
159
160         return self.writer.build(outputs, rule, inputs, **kwargs)
161
162     def default(self, paths):
163         return self.writer.default(paths)
164
165     def _expand_paths(self, paths):
166         """Expand $vars in an array of paths, e.g. from a 'build' block."""
167         paths = ninja_syntax.as_list(paths)
168         return ' '.join(map(self._shell_escape, (map(self._expand, paths))))
169
170     def _expand(self, str, local_vars={}):
171         """Expand $vars in a string."""
172         return ninja_syntax.expand(str, self.vars, local_vars)
173
174     def _shell_escape(self, path):
175         """Quote paths containing spaces."""
176         return '"%s"' % path if ' ' in path else path
177
178     def _run_command(self, cmdline):
179         """Run a subcommand, quietly.  Prints the full command on error."""
180         try:
181             if self.verbose:
182                 print(cmdline)
183             subprocess.check_call(cmdline, shell=True)
184         except subprocess.CalledProcessError:
185             print('when running: ', cmdline)
186             raise
187
188
189 parser = OptionParser()
190 profilers = ['gmon', 'pprof']
191 parser.add_option('--bootstrap', action='store_true',
192                   help='bootstrap a ninja binary from nothing')
193 parser.add_option('--verbose', action='store_true',
194                   help='enable verbose build')
195 parser.add_option('--platform',
196                   help='target platform (' +
197                        '/'.join(Platform.known_platforms()) + ')',
198                   choices=Platform.known_platforms())
199 parser.add_option('--host',
200                   help='host platform (' +
201                        '/'.join(Platform.known_platforms()) + ')',
202                   choices=Platform.known_platforms())
203 parser.add_option('--debug', action='store_true',
204                   help='enable debugging extras',)
205 parser.add_option('--profile', metavar='TYPE',
206                   choices=profilers,
207                   help='enable profiling (' + '/'.join(profilers) + ')',)
208 parser.add_option('--with-gtest', metavar='PATH', help='ignored')
209 parser.add_option('--with-python', metavar='EXE',
210                   help='use EXE as the Python interpreter',
211                   default=os.path.basename(sys.executable))
212 parser.add_option('--force-pselect', action='store_true',
213                   help='ppoll() is used by default where available, '
214                        'but some platforms may need to use pselect instead',)
215 (options, args) = parser.parse_args()
216 if args:
217     print('ERROR: extra unparsed command-line arguments:', args)
218     sys.exit(1)
219
220 platform = Platform(options.platform)
221 if options.host:
222     host = Platform(options.host)
223 else:
224     host = platform
225
226 BUILD_FILENAME = 'build.ninja'
227 ninja_writer = ninja_syntax.Writer(open(BUILD_FILENAME, 'w'))
228 n = ninja_writer
229
230 if options.bootstrap:
231     # Make the build directory.
232     try:
233         os.mkdir('build')
234     except OSError:
235         pass
236     # Wrap ninja_writer with the Bootstrapper, which also executes the
237     # commands.
238     print('bootstrapping ninja...')
239     n = Bootstrap(n, verbose=options.verbose)
240
241 n.comment('This file is used to build ninja itself.')
242 n.comment('It is generated by ' + os.path.basename(__file__) + '.')
243 n.newline()
244
245 n.variable('ninja_required_version', '1.3')
246 n.newline()
247
248 n.comment('The arguments passed to configure.py, for rerunning it.')
249 configure_args = sys.argv[1:]
250 if '--bootstrap' in configure_args:
251     configure_args.remove('--bootstrap')
252 n.variable('configure_args', ' '.join(configure_args))
253 env_keys = set(['CXX', 'AR', 'CFLAGS', 'LDFLAGS'])
254 configure_env = dict((k, os.environ[k]) for k in os.environ if k in env_keys)
255 if configure_env:
256     config_str = ' '.join([k + '=' + pipes.quote(configure_env[k])
257                            for k in configure_env])
258     n.variable('configure_env', config_str + '$ ')
259 n.newline()
260
261 CXX = configure_env.get('CXX', 'g++')
262 objext = '.o'
263 if platform.is_msvc():
264     CXX = 'cl'
265     objext = '.obj'
266
267 def src(filename):
268     return os.path.join('$sourcedir', 'src', filename)
269 def built(filename):
270     return os.path.join('$builddir', filename)
271 def doc(filename):
272     return os.path.join('$sourcedir', 'doc', filename)
273 def cc(name, **kwargs):
274     return n.build(built(name + objext), 'cxx', src(name + '.c'), **kwargs)
275 def cxx(name, **kwargs):
276     return n.build(built(name + objext), 'cxx', src(name + '.cc'), **kwargs)
277 def binary(name):
278     if platform.is_windows():
279         exe = name + '.exe'
280         n.build(name, 'phony', exe)
281         return exe
282     return name
283
284 n.variable('sourcedir', sourcedir)
285 n.variable('builddir', 'build')
286 n.variable('cxx', CXX)
287 if platform.is_msvc():
288     n.variable('ar', 'link')
289 else:
290     n.variable('ar', configure_env.get('AR', 'ar'))
291
292 if platform.is_msvc():
293     cflags = ['/showIncludes',
294               '/nologo',  # Don't print startup banner.
295               '/Zi',  # Create pdb with debug info.
296               '/W4',  # Highest warning level.
297               '/WX',  # Warnings as errors.
298               '/wd4530', '/wd4100', '/wd4706',
299               '/wd4512', '/wd4800', '/wd4702', '/wd4819',
300               # Disable warnings about passing "this" during initialization.
301               '/wd4355',
302               # Disable warnings about ignored typedef in DbgHelp.h
303               '/wd4091',
304               '/GR-',  # Disable RTTI.
305               # Disable size_t -> int truncation warning.
306               # We never have strings or arrays larger than 2**31.
307               '/wd4267',
308               '/DNOMINMAX', '/D_CRT_SECURE_NO_WARNINGS',
309               '/D_HAS_EXCEPTIONS=0',
310               '/DNINJA_PYTHON="%s"' % options.with_python]
311     if options.bootstrap:
312         # In bootstrap mode, we have no ninja process to catch /showIncludes
313         # output.
314         cflags.remove('/showIncludes')
315     if platform.msvc_needs_fs():
316         cflags.append('/FS')
317     ldflags = ['/DEBUG', '/libpath:$builddir']
318     if not options.debug:
319         cflags += ['/Ox', '/DNDEBUG', '/GL']
320         ldflags += ['/LTCG', '/OPT:REF', '/OPT:ICF']
321 else:
322     cflags = ['-g', '-Wall', '-Wextra',
323               '-Wno-deprecated',
324               '-Wno-unused-parameter',
325               '-fno-rtti',
326               '-fno-exceptions',
327               '-fvisibility=hidden', '-pipe',
328               '-Wno-missing-field-initializers',
329               '-DNINJA_PYTHON="%s"' % options.with_python]
330     if options.debug:
331         cflags += ['-D_GLIBCXX_DEBUG', '-D_GLIBCXX_DEBUG_PEDANTIC']
332         cflags.remove('-fno-rtti')  # Needed for above pedanticness.
333     else:
334         cflags += ['-O2', '-DNDEBUG']
335     try:
336         proc = subprocess.Popen(
337             [CXX, '-fdiagnostics-color', '-c', '-x', 'c++', '/dev/null'],
338             stdout=open(os.devnull, 'wb'), stderr=subprocess.STDOUT)
339         if proc.wait() == 0:
340             cflags += ['-fdiagnostics-color']
341     except:
342         pass
343     if platform.is_mingw():
344         cflags += ['-D_WIN32_WINNT=0x0501']
345     ldflags = ['-L$builddir']
346     if platform.uses_usr_local():
347         cflags.append('-I/usr/local/include')
348         ldflags.append('-L/usr/local/lib')
349
350 libs = []
351
352 if platform.is_mingw():
353     cflags.remove('-fvisibility=hidden');
354     ldflags.append('-static')
355 elif platform.is_solaris():
356     cflags.remove('-fvisibility=hidden')
357 elif platform.is_aix():
358     cflags.remove('-fvisibility=hidden')
359 elif platform.is_msvc():
360     pass
361 else:
362     if options.profile == 'gmon':
363         cflags.append('-pg')
364         ldflags.append('-pg')
365     elif options.profile == 'pprof':
366         cflags.append('-fno-omit-frame-pointer')
367         libs.extend(['-Wl,--no-as-needed', '-lprofiler'])
368
369 if platform.supports_ppoll() and not options.force_pselect:
370     cflags.append('-DUSE_PPOLL')
371 if platform.supports_ninja_browse():
372     cflags.append('-DNINJA_HAVE_BROWSE')
373
374 # Search for generated headers relative to build dir.
375 cflags.append('-I.')
376
377 def shell_escape(str):
378     """Escape str such that it's interpreted as a single argument by
379     the shell."""
380
381     # This isn't complete, but it's just enough to make NINJA_PYTHON work.
382     if platform.is_windows():
383       return str
384     if '"' in str:
385         return "'%s'" % str.replace("'", "\\'")
386     return str
387
388 if 'CFLAGS' in configure_env:
389     cflags.append(configure_env['CFLAGS'])
390 n.variable('cflags', ' '.join(shell_escape(flag) for flag in cflags))
391 if 'LDFLAGS' in configure_env:
392     ldflags.append(configure_env['LDFLAGS'])
393 n.variable('ldflags', ' '.join(shell_escape(flag) for flag in ldflags))
394 n.newline()
395
396 if platform.is_msvc():
397     n.rule('cxx',
398         command='$cxx $cflags -c $in /Fo$out',
399         description='CXX $out',
400         deps='msvc'  # /showIncludes is included in $cflags.
401     )
402 else:
403     n.rule('cxx',
404         command='$cxx -MMD -MT $out -MF $out.d $cflags -c $in -o $out',
405         depfile='$out.d',
406         deps='gcc',
407         description='CXX $out')
408 n.newline()
409
410 if host.is_msvc():
411     n.rule('ar',
412            command='lib /nologo /ltcg /out:$out $in',
413            description='LIB $out')
414 elif host.is_mingw():
415     n.rule('ar',
416            command='cmd /c $ar cqs $out.tmp $in && move /Y $out.tmp $out',
417            description='AR $out')
418 else:
419     n.rule('ar',
420            command='rm -f $out && $ar crs $out $in',
421            description='AR $out')
422 n.newline()
423
424 if platform.is_msvc():
425     n.rule('link',
426         command='$cxx $in $libs /nologo /link $ldflags /out:$out',
427         description='LINK $out')
428 else:
429     n.rule('link',
430         command='$cxx $ldflags -o $out $in $libs',
431         description='LINK $out')
432 n.newline()
433
434 objs = []
435
436 if platform.supports_ninja_browse():
437     n.comment('browse_py.h is used to inline browse.py.')
438     n.rule('inline',
439            command='"%s"' % src('inline.sh') + ' $varname < $in > $out',
440            description='INLINE $out')
441     n.build(built('browse_py.h'), 'inline', src('browse.py'),
442             implicit=src('inline.sh'),
443             variables=[('varname', 'kBrowsePy')])
444     n.newline()
445
446     objs += cxx('browse', order_only=built('browse_py.h'))
447     n.newline()
448
449 n.comment('the depfile parser and ninja lexers are generated using re2c.')
450 def has_re2c():
451     try:
452         proc = subprocess.Popen(['re2c', '-V'], stdout=subprocess.PIPE)
453         return int(proc.communicate()[0], 10) >= 1103
454     except OSError:
455         return False
456 if has_re2c():
457     n.rule('re2c',
458            command='re2c -b -i --no-generation-date -o $out $in',
459            description='RE2C $out')
460     # Generate the .cc files in the source directory so we can check them in.
461     n.build(src('depfile_parser.cc'), 're2c', src('depfile_parser.in.cc'))
462     n.build(src('lexer.cc'), 're2c', src('lexer.in.cc'))
463 else:
464     print("warning: A compatible version of re2c (>= 0.11.3) was not found; "
465            "changes to src/*.in.cc will not affect your build.")
466 n.newline()
467
468 n.comment('Core source files all build into ninja library.')
469 for name in ['build',
470              'build_log',
471              'clean',
472              'debug_flags',
473              'depfile_parser',
474              'deps_log',
475              'disk_interface',
476              'edit_distance',
477              'eval_env',
478              'graph',
479              'graphviz',
480              'lexer',
481              'line_printer',
482              'manifest_parser',
483              'metrics',
484              'state',
485              'util',
486              'version']:
487     objs += cxx(name)
488 if platform.is_windows():
489     for name in ['subprocess-win32',
490                  'includes_normalize-win32',
491                  'msvc_helper-win32',
492                  'msvc_helper_main-win32']:
493         objs += cxx(name)
494     if platform.is_msvc():
495         objs += cxx('minidump-win32')
496     objs += cc('getopt')
497 else:
498     objs += cxx('subprocess-posix')
499 if platform.is_aix():
500     objs += cc('getopt')
501 if platform.is_msvc():
502     ninja_lib = n.build(built('ninja.lib'), 'ar', objs)
503 else:
504     ninja_lib = n.build(built('libninja.a'), 'ar', objs)
505 n.newline()
506
507 if platform.is_msvc():
508     libs.append('ninja.lib')
509 else:
510     libs.append('-lninja')
511
512 if platform.is_aix():
513     libs.append('-lperfstat')
514
515 all_targets = []
516
517 n.comment('Main executable is library plus main() function.')
518 objs = cxx('ninja')
519 ninja = n.build(binary('ninja'), 'link', objs, implicit=ninja_lib,
520                 variables=[('libs', libs)])
521 n.newline()
522 all_targets += ninja
523
524 if options.bootstrap:
525     # We've built the ninja binary.  Don't run any more commands
526     # through the bootstrap executor, but continue writing the
527     # build.ninja file.
528     n = ninja_writer
529
530 n.comment('Tests all build into ninja_test executable.')
531
532 objs = []
533
534 for name in ['build_log_test',
535              'build_test',
536              'clean_test',
537              'depfile_parser_test',
538              'deps_log_test',
539              'disk_interface_test',
540              'edit_distance_test',
541              'graph_test',
542              'lexer_test',
543              'manifest_parser_test',
544              'ninja_test',
545              'state_test',
546              'subprocess_test',
547              'test',
548              'util_test']:
549     objs += cxx(name)
550 if platform.is_windows():
551     for name in ['includes_normalize_test', 'msvc_helper_test']:
552         objs += cxx(name)
553
554 ninja_test = n.build(binary('ninja_test'), 'link', objs, implicit=ninja_lib,
555                      variables=[('libs', libs)])
556 n.newline()
557 all_targets += ninja_test
558
559
560 n.comment('Ancillary executables.')
561 objs = cxx('build_log_perftest')
562 all_targets += n.build(binary('build_log_perftest'), 'link', objs,
563                        implicit=ninja_lib, variables=[('libs', libs)])
564 objs = cxx('canon_perftest')
565 all_targets += n.build(binary('canon_perftest'), 'link', objs,
566                        implicit=ninja_lib, variables=[('libs', libs)])
567 objs = cxx('depfile_parser_perftest')
568 all_targets += n.build(binary('depfile_parser_perftest'), 'link', objs,
569                        implicit=ninja_lib, variables=[('libs', libs)])
570 objs = cxx('hash_collision_bench')
571 all_targets += n.build(binary('hash_collision_bench'), 'link', objs,
572                               implicit=ninja_lib, variables=[('libs', libs)])
573 objs = cxx('manifest_parser_perftest')
574 all_targets += n.build(binary('manifest_parser_perftest'), 'link', objs,
575                               implicit=ninja_lib, variables=[('libs', libs)])
576 n.newline()
577
578 n.comment('Generate a graph using the "graph" tool.')
579 n.rule('gendot',
580        command='./ninja -t graph all > $out')
581 n.rule('gengraph',
582        command='dot -Tpng $in > $out')
583 dot = n.build(built('graph.dot'), 'gendot', ['ninja', 'build.ninja'])
584 n.build('graph.png', 'gengraph', dot)
585 n.newline()
586
587 n.comment('Generate the manual using asciidoc.')
588 n.rule('asciidoc',
589        command='asciidoc -b docbook -d book -o $out $in',
590        description='ASCIIDOC $out')
591 n.rule('xsltproc',
592        command='xsltproc --nonet doc/docbook.xsl $in > $out',
593        description='XSLTPROC $out')
594 xml = n.build(built('manual.xml'), 'asciidoc', doc('manual.asciidoc'))
595 manual = n.build(doc('manual.html'), 'xsltproc', xml,
596                  implicit=doc('style.css'))
597 n.build('manual', 'phony',
598         order_only=manual)
599 n.newline()
600
601 n.comment('Generate Doxygen.')
602 n.rule('doxygen',
603        command='doxygen $in',
604        description='DOXYGEN $in')
605 n.variable('doxygen_mainpage_generator',
606            src('gen_doxygen_mainpage.sh'))
607 n.rule('doxygen_mainpage',
608        command='$doxygen_mainpage_generator $in > $out',
609        description='DOXYGEN_MAINPAGE $out')
610 mainpage = n.build(built('doxygen_mainpage'), 'doxygen_mainpage',
611                    ['README', 'COPYING'],
612                    implicit=['$doxygen_mainpage_generator'])
613 n.build('doxygen', 'doxygen', doc('doxygen.config'),
614         implicit=mainpage)
615 n.newline()
616
617 if not host.is_mingw():
618     n.comment('Regenerate build files if build script changes.')
619     n.rule('configure',
620            command='${configure_env}%s $sourcedir/configure.py $configure_args' %
621                options.with_python,
622            generator=True)
623     n.build('build.ninja', 'configure',
624             implicit=['$sourcedir/configure.py',
625                       os.path.normpath('$sourcedir/misc/ninja_syntax.py')])
626     n.newline()
627
628 n.default(ninja)
629 n.newline()
630
631 if host.is_linux():
632     n.comment('Packaging')
633     n.rule('rpmbuild',
634            command="misc/packaging/rpmbuild.sh",
635            description='Building rpms..')
636     n.build('rpm', 'rpmbuild')
637     n.newline()
638
639 n.build('all', 'phony', all_targets)
640
641 n.close()
642 print('wrote %s.' % BUILD_FILENAME)
643
644 if options.bootstrap:
645     print('bootstrap complete.  rebuilding...')
646
647     rebuild_args = []
648
649     if platform.can_rebuild_in_place():
650         rebuild_args.append('./ninja')
651     else:
652         if platform.is_windows():
653             bootstrap_exe = 'ninja.bootstrap.exe'
654             final_exe = 'ninja.exe'
655         else:
656             bootstrap_exe = './ninja.bootstrap'
657             final_exe = './ninja'
658
659         if os.path.exists(bootstrap_exe):
660             os.unlink(bootstrap_exe)
661         os.rename(final_exe, bootstrap_exe)
662
663         rebuild_args.append(bootstrap_exe)
664
665     if options.verbose:
666         rebuild_args.append('-v')
667
668     subprocess.check_call(rebuild_args)