3 # Copyright 2001 Google Inc. All Rights Reserved.
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
9 # http://www.apache.org/licenses/LICENSE-2.0
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.
17 """Script that generates the build.ninja for ninja itself.
19 Projects that use ninja themselves should either write a similar script
20 or use a meta-build system that supports Ninja output."""
22 from __future__ import print_function
24 from optparse import OptionParser
31 sourcedir = os.path.dirname(os.path.realpath(__file__))
32 sys.path.insert(0, os.path.join(sourcedir, 'misc'))
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:
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'
65 def known_platforms():
66 return ['linux', 'darwin', 'freebsd', 'openbsd', 'solaris', 'sunos5',
67 'mingw', 'msvc', 'gnukfreebsd', 'bitrig', 'netbsd', 'aix']
73 return self._platform == 'linux'
76 return self._platform == 'mingw'
79 return self._platform == 'msvc'
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)
89 return self.is_mingw() or self.is_msvc()
92 return self._platform == 'solaris'
95 return self._platform == 'aix'
97 def uses_usr_local(self):
98 return self._platform in ('freebsd', 'openbsd', 'bitrig')
100 def supports_ppoll(self):
101 return self._platform in ('linux', 'openbsd', 'bitrig')
103 def supports_ninja_browse(self):
104 return (not self.is_windows()
105 and not self.is_solaris()
106 and not self.is_aix())
110 """API shim for ninja_syntax.Writer that instead runs the commands.
112 Used to bootstrap Ninja from scratch. In --bootstrap mode this
113 class is used to execute all the commands to build an executable.
114 It also proxies all calls to an underlying ninja_syntax.Writer, to
115 behave like non-bootstrap mode.
117 def __init__(self, writer, verbose=False):
119 self.verbose = verbose
120 # Map of variable name => expanded variable value.
122 # Map of rule name => dict of rule attributes.
127 def comment(self, text):
128 return self.writer.comment(text)
131 return self.writer.newline()
133 def variable(self, key, val):
134 self.vars[key] = self._expand(val)
135 return self.writer.variable(key, val)
137 def rule(self, name, **kwargs):
138 self.rules[name] = kwargs
139 return self.writer.rule(name, **kwargs)
141 def build(self, outputs, rule, inputs=None, **kwargs):
142 ruleattr = self.rules[rule]
143 cmd = ruleattr.get('command')
144 if cmd is None: # A phony rule, for example.
147 # Implement just enough of Ninja variable expansion etc. to
148 # make the bootstrap build work.
150 'in': self._expand_paths(inputs),
151 'out': self._expand_paths(outputs)
153 for key, val in kwargs.get('variables', []):
154 local_vars[key] = ' '.join(ninja_syntax.as_list(val))
156 self._run_command(self._expand(cmd, local_vars))
158 return self.writer.build(outputs, rule, inputs, **kwargs)
160 def default(self, paths):
161 return self.writer.default(paths)
163 def _expand_paths(self, paths):
164 """Expand $vars in an array of paths, e.g. from a 'build' block."""
165 paths = ninja_syntax.as_list(paths)
166 return ' '.join(map(self._shell_escape, (map(self._expand, paths))))
168 def _expand(self, str, local_vars={}):
169 """Expand $vars in a string."""
170 return ninja_syntax.expand(str, self.vars, local_vars)
172 def _shell_escape(self, path):
173 """Quote paths containing spaces."""
174 return '"%s"' % path if ' ' in path else path
176 def _run_command(self, cmdline):
177 """Run a subcommand, quietly. Prints the full command on error."""
181 subprocess.check_call(cmdline, shell=True)
182 except subprocess.CalledProcessError:
183 print('when running: ', cmdline)
187 parser = OptionParser()
188 profilers = ['gmon', 'pprof']
189 parser.add_option('--bootstrap', action='store_true',
190 help='bootstrap a ninja binary from nothing')
191 parser.add_option('--verbose', action='store_true',
192 help='enable verbose build')
193 parser.add_option('--platform',
194 help='target platform (' +
195 '/'.join(Platform.known_platforms()) + ')',
196 choices=Platform.known_platforms())
197 parser.add_option('--host',
198 help='host platform (' +
199 '/'.join(Platform.known_platforms()) + ')',
200 choices=Platform.known_platforms())
201 parser.add_option('--debug', action='store_true',
202 help='enable debugging extras',)
203 parser.add_option('--profile', metavar='TYPE',
205 help='enable profiling (' + '/'.join(profilers) + ')',)
206 parser.add_option('--with-gtest', metavar='PATH', help='ignored')
207 parser.add_option('--with-python', metavar='EXE',
208 help='use EXE as the Python interpreter',
209 default=os.path.basename(sys.executable))
210 parser.add_option('--force-pselect', action='store_true',
211 help='ppoll() is used by default where available, '
212 'but some platforms may need to use pselect instead',)
213 (options, args) = parser.parse_args()
215 print('ERROR: extra unparsed command-line arguments:', args)
218 platform = Platform(options.platform)
220 host = Platform(options.host)
224 BUILD_FILENAME = 'build.ninja'
225 ninja_writer = ninja_syntax.Writer(open(BUILD_FILENAME, 'w'))
228 if options.bootstrap:
229 # Make the build directory.
234 # Wrap ninja_writer with the Bootstrapper, which also executes the
236 print('bootstrapping ninja...')
237 n = Bootstrap(n, verbose=options.verbose)
239 n.comment('This file is used to build ninja itself.')
240 n.comment('It is generated by ' + os.path.basename(__file__) + '.')
243 n.variable('ninja_required_version', '1.3')
246 n.comment('The arguments passed to configure.py, for rerunning it.')
247 configure_args = sys.argv[1:]
248 if '--bootstrap' in configure_args:
249 configure_args.remove('--bootstrap')
250 n.variable('configure_args', ' '.join(configure_args))
251 env_keys = set(['CXX', 'AR', 'CFLAGS', 'LDFLAGS'])
252 configure_env = dict((k, os.environ[k]) for k in os.environ if k in env_keys)
254 config_str = ' '.join([k + '=' + pipes.quote(configure_env[k])
255 for k in configure_env])
256 n.variable('configure_env', config_str + '$ ')
259 CXX = configure_env.get('CXX', 'g++')
261 if platform.is_msvc():
266 return os.path.join('$sourcedir', 'src', filename)
268 return os.path.join('$builddir', filename)
270 return os.path.join('$sourcedir', 'doc', filename)
271 def cc(name, **kwargs):
272 return n.build(built(name + objext), 'cxx', src(name + '.c'), **kwargs)
273 def cxx(name, **kwargs):
274 return n.build(built(name + objext), 'cxx', src(name + '.cc'), **kwargs)
276 if platform.is_windows():
278 n.build(name, 'phony', exe)
282 n.variable('sourcedir', sourcedir)
283 n.variable('builddir', 'build')
284 n.variable('cxx', CXX)
285 if platform.is_msvc():
286 n.variable('ar', 'link')
288 n.variable('ar', configure_env.get('AR', 'ar'))
290 if platform.is_msvc():
291 cflags = ['/showIncludes',
292 '/nologo', # Don't print startup banner.
293 '/Zi', # Create pdb with debug info.
294 '/W4', # Highest warning level.
295 '/WX', # Warnings as errors.
296 '/wd4530', '/wd4100', '/wd4706',
297 '/wd4512', '/wd4800', '/wd4702', '/wd4819',
298 # Disable warnings about passing "this" during initialization.
300 # Disable warnings about ignored typedef in DbgHelp.h
302 '/GR-', # Disable RTTI.
303 # Disable size_t -> int truncation warning.
304 # We never have strings or arrays larger than 2**31.
306 '/DNOMINMAX', '/D_CRT_SECURE_NO_WARNINGS',
307 '/D_HAS_EXCEPTIONS=0',
308 '/DNINJA_PYTHON="%s"' % options.with_python]
309 if options.bootstrap:
310 # In bootstrap mode, we have no ninja process to catch /showIncludes
312 cflags.remove('/showIncludes')
313 if platform.msvc_needs_fs():
315 ldflags = ['/DEBUG', '/libpath:$builddir']
316 if not options.debug:
317 cflags += ['/Ox', '/DNDEBUG', '/GL']
318 ldflags += ['/LTCG', '/OPT:REF', '/OPT:ICF']
320 cflags = ['-g', '-Wall', '-Wextra',
322 '-Wno-unused-parameter',
325 '-fvisibility=hidden', '-pipe',
326 '-Wno-missing-field-initializers',
327 '-DNINJA_PYTHON="%s"' % options.with_python]
329 cflags += ['-D_GLIBCXX_DEBUG', '-D_GLIBCXX_DEBUG_PEDANTIC']
330 cflags.remove('-fno-rtti') # Needed for above pedanticness.
332 cflags += ['-O2', '-DNDEBUG']
334 proc = subprocess.Popen(
335 [CXX, '-fdiagnostics-color', '-c', '-x', 'c++', '/dev/null'],
336 stdout=open(os.devnull, 'wb'), stderr=subprocess.STDOUT)
338 cflags += ['-fdiagnostics-color']
341 if platform.is_mingw():
342 cflags += ['-D_WIN32_WINNT=0x0501']
343 ldflags = ['-L$builddir']
344 if platform.uses_usr_local():
345 cflags.append('-I/usr/local/include')
346 ldflags.append('-L/usr/local/lib')
350 if platform.is_mingw():
351 cflags.remove('-fvisibility=hidden');
352 ldflags.append('-static')
353 elif platform.is_solaris():
354 cflags.remove('-fvisibility=hidden')
355 elif platform.is_aix():
356 cflags.remove('-fvisibility=hidden')
357 elif platform.is_msvc():
360 if options.profile == 'gmon':
362 ldflags.append('-pg')
363 elif options.profile == 'pprof':
364 cflags.append('-fno-omit-frame-pointer')
365 libs.extend(['-Wl,--no-as-needed', '-lprofiler'])
367 if platform.supports_ppoll() and not options.force_pselect:
368 cflags.append('-DUSE_PPOLL')
369 if platform.supports_ninja_browse():
370 cflags.append('-DNINJA_HAVE_BROWSE')
372 # Search for generated headers relative to build dir.
375 def shell_escape(str):
376 """Escape str such that it's interpreted as a single argument by
379 # This isn't complete, but it's just enough to make NINJA_PYTHON work.
380 if platform.is_windows():
383 return "'%s'" % str.replace("'", "\\'")
386 if 'CFLAGS' in configure_env:
387 cflags.append(configure_env['CFLAGS'])
388 n.variable('cflags', ' '.join(shell_escape(flag) for flag in cflags))
389 if 'LDFLAGS' in configure_env:
390 ldflags.append(configure_env['LDFLAGS'])
391 n.variable('ldflags', ' '.join(shell_escape(flag) for flag in ldflags))
394 if platform.is_msvc():
396 command='$cxx $cflags -c $in /Fo$out',
397 description='CXX $out',
398 deps='msvc' # /showIncludes is included in $cflags.
402 command='$cxx -MMD -MT $out -MF $out.d $cflags -c $in -o $out',
405 description='CXX $out')
410 command='lib /nologo /ltcg /out:$out $in',
411 description='LIB $out')
412 elif host.is_mingw():
414 command='cmd /c $ar cqs $out.tmp $in && move /Y $out.tmp $out',
415 description='AR $out')
418 command='rm -f $out && $ar crs $out $in',
419 description='AR $out')
422 if platform.is_msvc():
424 command='$cxx $in $libs /nologo /link $ldflags /out:$out',
425 description='LINK $out')
428 command='$cxx $ldflags -o $out $in $libs',
429 description='LINK $out')
434 if platform.supports_ninja_browse():
435 n.comment('browse_py.h is used to inline browse.py.')
437 command='"%s"' % src('inline.sh') + ' $varname < $in > $out',
438 description='INLINE $out')
439 n.build(built('browse_py.h'), 'inline', src('browse.py'),
440 implicit=src('inline.sh'),
441 variables=[('varname', 'kBrowsePy')])
444 objs += cxx('browse', order_only=built('browse_py.h'))
447 n.comment('the depfile parser and ninja lexers are generated using re2c.')
450 proc = subprocess.Popen(['re2c', '-V'], stdout=subprocess.PIPE)
451 return int(proc.communicate()[0], 10) >= 1103
456 command='re2c -b -i --no-generation-date -o $out $in',
457 description='RE2C $out')
458 # Generate the .cc files in the source directory so we can check them in.
459 n.build(src('depfile_parser.cc'), 're2c', src('depfile_parser.in.cc'))
460 n.build(src('lexer.cc'), 're2c', src('lexer.in.cc'))
462 print("warning: A compatible version of re2c (>= 0.11.3) was not found; "
463 "changes to src/*.in.cc will not affect your build.")
466 n.comment('Core source files all build into ninja library.')
467 for name in ['build',
486 if platform.is_windows():
487 for name in ['subprocess-win32',
488 'includes_normalize-win32',
490 'msvc_helper_main-win32']:
492 if platform.is_msvc():
493 objs += cxx('minidump-win32')
496 objs += cxx('subprocess-posix')
497 if platform.is_msvc():
498 ninja_lib = n.build(built('ninja.lib'), 'ar', objs)
500 ninja_lib = n.build(built('libninja.a'), 'ar', objs)
503 if platform.is_msvc():
504 libs.append('ninja.lib')
506 libs.append('-lninja')
510 n.comment('Main executable is library plus main() function.')
512 ninja = n.build(binary('ninja'), 'link', objs, implicit=ninja_lib,
513 variables=[('libs', libs)])
517 if options.bootstrap:
518 # We've built the ninja binary. Don't run any more commands
519 # through the bootstrap executor, but continue writing the
523 n.comment('Tests all build into ninja_test executable.')
527 for name in ['build_log_test',
530 'depfile_parser_test',
532 'disk_interface_test',
533 'edit_distance_test',
536 'manifest_parser_test',
543 if platform.is_windows():
544 for name in ['includes_normalize_test', 'msvc_helper_test']:
547 ninja_test = n.build(binary('ninja_test'), 'link', objs, implicit=ninja_lib,
548 variables=[('libs', libs)])
550 all_targets += ninja_test
553 n.comment('Ancillary executables.')
554 objs = cxx('build_log_perftest')
555 all_targets += n.build(binary('build_log_perftest'), 'link', objs,
556 implicit=ninja_lib, variables=[('libs', libs)])
557 objs = cxx('canon_perftest')
558 all_targets += n.build(binary('canon_perftest'), 'link', objs,
559 implicit=ninja_lib, variables=[('libs', libs)])
560 objs = cxx('depfile_parser_perftest')
561 all_targets += n.build(binary('depfile_parser_perftest'), 'link', objs,
562 implicit=ninja_lib, variables=[('libs', libs)])
563 objs = cxx('hash_collision_bench')
564 all_targets += n.build(binary('hash_collision_bench'), 'link', objs,
565 implicit=ninja_lib, variables=[('libs', libs)])
566 objs = cxx('manifest_parser_perftest')
567 all_targets += n.build(binary('manifest_parser_perftest'), 'link', objs,
568 implicit=ninja_lib, variables=[('libs', libs)])
571 n.comment('Generate a graph using the "graph" tool.')
573 command='./ninja -t graph all > $out')
575 command='dot -Tpng $in > $out')
576 dot = n.build(built('graph.dot'), 'gendot', ['ninja', 'build.ninja'])
577 n.build('graph.png', 'gengraph', dot)
580 n.comment('Generate the manual using asciidoc.')
582 command='asciidoc -b docbook -d book -o $out $in',
583 description='ASCIIDOC $out')
585 command='xsltproc --nonet doc/docbook.xsl $in > $out',
586 description='XSLTPROC $out')
587 xml = n.build(built('manual.xml'), 'asciidoc', doc('manual.asciidoc'))
588 manual = n.build(doc('manual.html'), 'xsltproc', xml,
589 implicit=doc('style.css'))
590 n.build('manual', 'phony',
594 n.comment('Generate Doxygen.')
596 command='doxygen $in',
597 description='DOXYGEN $in')
598 n.variable('doxygen_mainpage_generator',
599 src('gen_doxygen_mainpage.sh'))
600 n.rule('doxygen_mainpage',
601 command='$doxygen_mainpage_generator $in > $out',
602 description='DOXYGEN_MAINPAGE $out')
603 mainpage = n.build(built('doxygen_mainpage'), 'doxygen_mainpage',
604 ['README', 'COPYING'],
605 implicit=['$doxygen_mainpage_generator'])
606 n.build('doxygen', 'doxygen', doc('doxygen.config'),
610 if not host.is_mingw():
611 n.comment('Regenerate build files if build script changes.')
613 command='${configure_env}%s $sourcedir/configure.py $configure_args' %
616 n.build('build.ninja', 'configure',
617 implicit=['$sourcedir/configure.py',
618 os.path.normpath('$sourcedir/misc/ninja_syntax.py')])
625 n.comment('Packaging')
627 command="misc/packaging/rpmbuild.sh",
628 description='Building rpms..')
629 n.build('rpm', 'rpmbuild')
632 n.build('all', 'phony', all_targets)
635 print('wrote %s.' % BUILD_FILENAME)
641 if options.bootstrap:
642 print('bootstrap complete. rebuilding...')
643 if platform.is_windows():
644 bootstrap_exe = 'ninja.bootstrap.exe'
645 if os.path.exists(bootstrap_exe):
646 os.unlink(bootstrap_exe)
647 os.rename('ninja.exe', bootstrap_exe)
648 subprocess.check_call('ninja.bootstrap.exe%s' % verbose, shell=True)
650 subprocess.check_call('./ninja%s' % verbose, shell=True)