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 sys.path.insert(0, 'misc')
35 class Platform(object):
36 """Represents a host/target platform and its specific build attributes."""
37 def __init__(self, platform):
38 self._platform = platform
39 if self._platform is not None:
41 self._platform = sys.platform
42 if self._platform.startswith('linux'):
43 self._platform = 'linux'
44 elif self._platform.startswith('freebsd'):
45 self._platform = 'freebsd'
46 elif self._platform.startswith('gnukfreebsd'):
47 self._platform = 'freebsd'
48 elif self._platform.startswith('openbsd'):
49 self._platform = 'openbsd'
50 elif self._platform.startswith('solaris') or self._platform == 'sunos5':
51 self._platform = 'solaris'
52 elif self._platform.startswith('mingw'):
53 self._platform = 'mingw'
54 elif self._platform.startswith('win'):
55 self._platform = 'msvc'
56 elif self._platform.startswith('bitrig'):
57 self._platform = 'bitrig'
58 elif self._platform.startswith('netbsd'):
59 self._platform = 'netbsd'
62 def known_platforms():
63 return ['linux', 'darwin', 'freebsd', 'openbsd', 'solaris', 'sunos5',
64 'mingw', 'msvc', 'gnukfreebsd', 'bitrig', 'netbsd']
70 return self._platform == 'linux'
73 return self._platform == 'mingw'
76 return self._platform == 'msvc'
78 def msvc_needs_fs(self):
79 popen = subprocess.Popen(['cl', '/nologo', '/?'],
80 stdout=subprocess.PIPE,
81 stderr=subprocess.PIPE)
82 out, err = popen.communicate()
83 return '/FS ' in str(out)
86 return self.is_mingw() or self.is_msvc()
89 return self._platform == 'solaris'
91 def uses_usr_local(self):
92 return self._platform in ('freebsd', 'openbsd', 'bitrig')
94 def supports_ppoll(self):
95 return self._platform in ('linux', 'openbsd', 'bitrig')
97 def supports_ninja_browse(self):
98 return not self.is_windows() and not self.is_solaris()
102 """API shim for ninja_syntax.Writer that instead runs the commands.
104 Used to bootstrap Ninja from scratch. In --bootstrap mode this
105 class is used to execute all the commands to build an executable.
106 It also proxies all calls to an underlying ninja_syntax.Writer, to
107 behave like non-bootstrap mode.
109 def __init__(self, writer, verbose=False):
111 self.verbose = verbose
112 # Map of variable name => expanded variable value.
114 # Map of rule name => dict of rule attributes.
119 def comment(self, text):
120 return self.writer.comment(text)
123 return self.writer.newline()
125 def variable(self, key, val):
126 self.vars[key] = self._expand(val)
127 return self.writer.variable(key, val)
129 def rule(self, name, **kwargs):
130 self.rules[name] = kwargs
131 return self.writer.rule(name, **kwargs)
133 def build(self, outputs, rule, inputs=None, **kwargs):
134 ruleattr = self.rules[rule]
135 cmd = ruleattr.get('command')
136 if cmd is None: # A phony rule, for example.
139 # Implement just enough of Ninja variable expansion etc. to
140 # make the bootstrap build work.
142 'in': self._expand_paths(inputs),
143 'out': self._expand_paths(outputs)
145 for key, val in kwargs.get('variables', []):
146 local_vars[key] = ' '.join(ninja_syntax.as_list(val))
148 self._run_command(self._expand(cmd, local_vars))
150 return self.writer.build(outputs, rule, inputs, **kwargs)
152 def default(self, paths):
153 return self.writer.default(paths)
155 def _expand_paths(self, paths):
156 """Expand $vars in an array of paths, e.g. from a 'build' block."""
157 paths = ninja_syntax.as_list(paths)
158 return ' '.join(map(self._expand, paths))
160 def _expand(self, str, local_vars={}):
161 """Expand $vars in a string."""
162 return ninja_syntax.expand(str, self.vars, local_vars)
164 def _run_command(self, cmdline):
165 """Run a subcommand, quietly. Prints the full command on error."""
169 subprocess.check_call(cmdline, shell=True)
170 except subprocess.CalledProcessError:
171 print('when running: ', cmdline)
175 parser = OptionParser()
176 profilers = ['gmon', 'pprof']
177 parser.add_option('--bootstrap', action='store_true',
178 help='bootstrap a ninja binary from nothing')
179 parser.add_option('--verbose', action='store_true',
180 help='enable verbose build')
181 parser.add_option('--platform',
182 help='target platform (' +
183 '/'.join(Platform.known_platforms()) + ')',
184 choices=Platform.known_platforms())
185 parser.add_option('--host',
186 help='host platform (' +
187 '/'.join(Platform.known_platforms()) + ')',
188 choices=Platform.known_platforms())
189 parser.add_option('--debug', action='store_true',
190 help='enable debugging extras',)
191 parser.add_option('--profile', metavar='TYPE',
193 help='enable profiling (' + '/'.join(profilers) + ')',)
194 parser.add_option('--with-gtest', metavar='PATH', help='ignored')
195 parser.add_option('--with-python', metavar='EXE',
196 help='use EXE as the Python interpreter',
197 default=os.path.basename(sys.executable))
198 parser.add_option('--force-pselect', action='store_true',
199 help='ppoll() is used by default where available, '
200 'but some platforms may need to use pselect instead',)
201 (options, args) = parser.parse_args()
203 print('ERROR: extra unparsed command-line arguments:', args)
206 platform = Platform(options.platform)
208 host = Platform(options.host)
212 BUILD_FILENAME = 'build.ninja'
213 ninja_writer = ninja_syntax.Writer(open(BUILD_FILENAME, 'w'))
216 if options.bootstrap:
217 # Make the build directory.
222 # Wrap ninja_writer with the Bootstrapper, which also executes the
224 print('bootstrapping ninja...')
225 n = Bootstrap(n, verbose=options.verbose)
227 n.comment('This file is used to build ninja itself.')
228 n.comment('It is generated by ' + os.path.basename(__file__) + '.')
231 n.variable('ninja_required_version', '1.3')
234 n.comment('The arguments passed to configure.py, for rerunning it.')
235 configure_args = sys.argv[1:]
236 if '--bootstrap' in configure_args:
237 configure_args.remove('--bootstrap')
238 n.variable('configure_args', ' '.join(configure_args))
239 env_keys = set(['CXX', 'AR', 'CFLAGS', 'LDFLAGS'])
240 configure_env = dict((k, os.environ[k]) for k in os.environ if k in env_keys)
242 config_str = ' '.join([k + '=' + pipes.quote(configure_env[k])
243 for k in configure_env])
244 n.variable('configure_env', config_str + '$ ')
247 CXX = configure_env.get('CXX', 'g++')
249 if platform.is_msvc():
254 return os.path.join('src', filename)
256 return os.path.join('$builddir', filename)
258 return os.path.join('doc', filename)
259 def cc(name, **kwargs):
260 return n.build(built(name + objext), 'cxx', src(name + '.c'), **kwargs)
261 def cxx(name, **kwargs):
262 return n.build(built(name + objext), 'cxx', src(name + '.cc'), **kwargs)
264 if platform.is_windows():
266 n.build(name, 'phony', exe)
270 n.variable('builddir', 'build')
271 n.variable('cxx', CXX)
272 if platform.is_msvc():
273 n.variable('ar', 'link')
275 n.variable('ar', configure_env.get('AR', 'ar'))
277 if platform.is_msvc():
278 cflags = ['/showIncludes',
279 '/nologo', # Don't print startup banner.
280 '/Zi', # Create pdb with debug info.
281 '/W4', # Highest warning level.
282 '/WX', # Warnings as errors.
283 '/wd4530', '/wd4100', '/wd4706',
284 '/wd4512', '/wd4800', '/wd4702', '/wd4819',
285 # Disable warnings about passing "this" during initialization.
287 # Disable warnings about ignored typedef in DbgHelp.h
289 '/GR-', # Disable RTTI.
290 # Disable size_t -> int truncation warning.
291 # We never have strings or arrays larger than 2**31.
293 '/DNOMINMAX', '/D_CRT_SECURE_NO_WARNINGS',
294 '/D_VARIADIC_MAX=10',
295 '/DNINJA_PYTHON="%s"' % options.with_python]
296 if options.bootstrap:
297 # In bootstrap mode, we have no ninja process to catch /showIncludes
299 cflags.remove('/showIncludes')
300 if platform.msvc_needs_fs():
302 ldflags = ['/DEBUG', '/libpath:$builddir']
303 if not options.debug:
304 cflags += ['/Ox', '/DNDEBUG', '/GL']
305 ldflags += ['/LTCG', '/OPT:REF', '/OPT:ICF']
307 cflags = ['-g', '-Wall', '-Wextra',
309 '-Wno-unused-parameter',
312 '-fvisibility=hidden', '-pipe',
313 '-Wno-missing-field-initializers',
314 '-DNINJA_PYTHON="%s"' % options.with_python]
316 cflags += ['-D_GLIBCXX_DEBUG', '-D_GLIBCXX_DEBUG_PEDANTIC']
317 cflags.remove('-fno-rtti') # Needed for above pedanticness.
319 cflags += ['-O2', '-DNDEBUG']
321 proc = subprocess.Popen(
322 [CXX, '-fdiagnostics-color', '-c', '-x', 'c++', '/dev/null'],
323 stdout=open(os.devnull, 'wb'), stderr=subprocess.STDOUT)
325 if proc.returncode == 0:
326 cflags += ['-fdiagnostics-color']
329 if platform.is_mingw():
330 cflags += ['-D_WIN32_WINNT=0x0501']
331 ldflags = ['-L$builddir']
332 if platform.uses_usr_local():
333 cflags.append('-I/usr/local/include')
334 ldflags.append('-L/usr/local/lib')
338 if platform.is_mingw():
339 cflags.remove('-fvisibility=hidden');
340 ldflags.append('-static')
341 elif platform.is_solaris():
342 cflags.remove('-fvisibility=hidden')
343 elif platform.is_msvc():
346 if options.profile == 'gmon':
348 ldflags.append('-pg')
349 elif options.profile == 'pprof':
350 cflags.append('-fno-omit-frame-pointer')
351 libs.extend(['-Wl,--no-as-needed', '-lprofiler'])
353 if platform.supports_ppoll() and not options.force_pselect:
354 cflags.append('-DUSE_PPOLL')
355 if platform.supports_ninja_browse():
356 cflags.append('-DNINJA_HAVE_BROWSE')
358 def shell_escape(str):
359 """Escape str such that it's interpreted as a single argument by
362 # This isn't complete, but it's just enough to make NINJA_PYTHON work.
363 if platform.is_windows():
366 return "'%s'" % str.replace("'", "\\'")
369 if 'CFLAGS' in configure_env:
370 cflags.append(configure_env['CFLAGS'])
371 n.variable('cflags', ' '.join(shell_escape(flag) for flag in cflags))
372 if 'LDFLAGS' in configure_env:
373 ldflags.append(configure_env['LDFLAGS'])
374 n.variable('ldflags', ' '.join(shell_escape(flag) for flag in ldflags))
377 if platform.is_msvc():
379 command='$cxx $cflags -c $in /Fo$out',
380 description='CXX $out',
381 deps='msvc' # /showIncludes is included in $cflags.
385 command='$cxx -MMD -MT $out -MF $out.d $cflags -c $in -o $out',
388 description='CXX $out')
393 command='lib /nologo /ltcg /out:$out $in',
394 description='LIB $out')
395 elif host.is_mingw():
397 command='cmd /c $ar cqs $out.tmp $in && move /Y $out.tmp $out',
398 description='AR $out')
401 command='rm -f $out && $ar crs $out $in',
402 description='AR $out')
405 if platform.is_msvc():
407 command='$cxx $in $libs /nologo /link $ldflags /out:$out',
408 description='LINK $out')
411 command='$cxx $ldflags -o $out $in $libs',
412 description='LINK $out')
417 if platform.supports_ninja_browse():
418 n.comment('browse_py.h is used to inline browse.py.')
420 command='src/inline.sh $varname < $in > $out',
421 description='INLINE $out')
422 n.build(built('browse_py.h'), 'inline', src('browse.py'),
423 implicit='src/inline.sh',
424 variables=[('varname', 'kBrowsePy')])
427 objs += cxx('browse', order_only=built('browse_py.h'))
430 n.comment('the depfile parser and ninja lexers are generated using re2c.')
433 proc = subprocess.Popen(['re2c', '-V'], stdout=subprocess.PIPE)
434 return int(proc.communicate()[0], 10) >= 1103
439 command='re2c -b -i --no-generation-date -o $out $in',
440 description='RE2C $out')
441 # Generate the .cc files in the source directory so we can check them in.
442 n.build(src('depfile_parser.cc'), 're2c', src('depfile_parser.in.cc'))
443 n.build(src('lexer.cc'), 're2c', src('lexer.in.cc'))
445 print("warning: A compatible version of re2c (>= 0.11.3) was not found; "
446 "changes to src/*.in.cc will not affect your build.")
449 n.comment('Core source files all build into ninja library.')
450 for name in ['build',
469 if platform.is_windows():
470 for name in ['subprocess-win32',
471 'includes_normalize-win32',
473 'msvc_helper_main-win32']:
475 if platform.is_msvc():
476 objs += cxx('minidump-win32')
479 objs += cxx('subprocess-posix')
480 if platform.is_msvc():
481 ninja_lib = n.build(built('ninja.lib'), 'ar', objs)
483 ninja_lib = n.build(built('libninja.a'), 'ar', objs)
486 if platform.is_msvc():
487 libs.append('ninja.lib')
489 libs.append('-lninja')
493 n.comment('Main executable is library plus main() function.')
495 ninja = n.build(binary('ninja'), 'link', objs, implicit=ninja_lib,
496 variables=[('libs', libs)])
500 if options.bootstrap:
501 # We've built the ninja binary. Don't run any more commands
502 # through the bootstrap executor, but continue writing the
506 n.comment('Tests all build into ninja_test executable.')
510 for name in ['build_log_test',
513 'depfile_parser_test',
515 'disk_interface_test',
516 'edit_distance_test',
519 'manifest_parser_test',
526 if platform.is_windows():
527 for name in ['includes_normalize_test', 'msvc_helper_test']:
530 ninja_test = n.build(binary('ninja_test'), 'link', objs, implicit=ninja_lib,
531 variables=[('libs', libs)])
533 all_targets += ninja_test
536 n.comment('Ancillary executables.')
537 objs = cxx('build_log_perftest')
538 all_targets += n.build(binary('build_log_perftest'), 'link', objs,
539 implicit=ninja_lib, variables=[('libs', libs)])
540 objs = cxx('canon_perftest')
541 all_targets += n.build(binary('canon_perftest'), 'link', objs,
542 implicit=ninja_lib, variables=[('libs', libs)])
543 objs = cxx('depfile_parser_perftest')
544 all_targets += n.build(binary('depfile_parser_perftest'), 'link', objs,
545 implicit=ninja_lib, variables=[('libs', libs)])
546 objs = cxx('hash_collision_bench')
547 all_targets += n.build(binary('hash_collision_bench'), 'link', objs,
548 implicit=ninja_lib, variables=[('libs', libs)])
549 objs = cxx('manifest_parser_perftest')
550 all_targets += n.build(binary('manifest_parser_perftest'), 'link', objs,
551 implicit=ninja_lib, variables=[('libs', libs)])
554 n.comment('Generate a graph using the "graph" tool.')
556 command='./ninja -t graph all > $out')
558 command='dot -Tpng $in > $out')
559 dot = n.build(built('graph.dot'), 'gendot', ['ninja', 'build.ninja'])
560 n.build('graph.png', 'gengraph', dot)
563 n.comment('Generate the manual using asciidoc.')
565 command='asciidoc -b docbook -d book -o $out $in',
566 description='ASCIIDOC $out')
568 command='xsltproc --nonet doc/docbook.xsl $in > $out',
569 description='XSLTPROC $out')
570 xml = n.build(built('manual.xml'), 'asciidoc', doc('manual.asciidoc'))
571 manual = n.build(doc('manual.html'), 'xsltproc', xml,
572 implicit=doc('style.css'))
573 n.build('manual', 'phony',
577 n.comment('Generate Doxygen.')
579 command='doxygen $in',
580 description='DOXYGEN $in')
581 n.variable('doxygen_mainpage_generator',
582 src('gen_doxygen_mainpage.sh'))
583 n.rule('doxygen_mainpage',
584 command='$doxygen_mainpage_generator $in > $out',
585 description='DOXYGEN_MAINPAGE $out')
586 mainpage = n.build(built('doxygen_mainpage'), 'doxygen_mainpage',
587 ['README', 'COPYING'],
588 implicit=['$doxygen_mainpage_generator'])
589 n.build('doxygen', 'doxygen', doc('doxygen.config'),
593 if not host.is_mingw():
594 n.comment('Regenerate build files if build script changes.')
596 command='${configure_env}%s configure.py $configure_args' %
599 n.build('build.ninja', 'configure',
600 implicit=['configure.py', os.path.normpath('misc/ninja_syntax.py')])
607 n.comment('Packaging')
609 command="misc/packaging/rpmbuild.sh",
610 description='Building rpms..')
611 n.build('rpm', 'rpmbuild')
614 n.build('all', 'phony', all_targets)
617 print('wrote %s.' % BUILD_FILENAME)
623 if options.bootstrap:
624 print('bootstrap complete. rebuilding...')
625 if platform.is_windows():
626 bootstrap_exe = 'ninja.bootstrap.exe'
627 if os.path.exists(bootstrap_exe):
628 os.unlink(bootstrap_exe)
629 os.rename('ninja.exe', bootstrap_exe)
630 subprocess.check_call('ninja.bootstrap.exe%s' % verbose, shell=True)
632 subprocess.check_call('./ninja%s' % verbose, shell=True)