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 sys.path.insert(0, 'misc')
  32 import ninja_syntax
  33
  34
  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:
  40             return
  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'
  60
  61     @staticmethod
  62     def known_platforms():
  63       return ['linux', 'darwin', 'freebsd', 'openbsd', 'solaris', 'sunos5',
  64               'mingw', 'msvc', 'gnukfreebsd', 'bitrig', 'netbsd']
  65
  66     def platform(self):
  67         return self._platform
  68
  69     def is_linux(self):
  70         return self._platform == 'linux'
  71
  72     def is_mingw(self):
  73         return self._platform == 'mingw'
  74
  75     def is_msvc(self):
  76         return self._platform == 'msvc'
  77
  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)
  84
  85     def is_windows(self):
  86         return self.is_mingw() or self.is_msvc()
  87
  88     def is_solaris(self):
  89         return self._platform == 'solaris'
  90
  91     def uses_usr_local(self):
  92         return self._platform in ('freebsd', 'openbsd', 'bitrig')
  93
  94     def supports_ppoll(self):
  95         return self._platform in ('linux', 'openbsd', 'bitrig')
  96
  97     def supports_ninja_browse(self):
  98         return not self.is_windows() and not self.is_solaris()
  99
 100
 101 class Bootstrap:
 102     """API shim for ninja_syntax.Writer that instead runs the commands.
 103
 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.
 108     """
 109     def __init__(self, writer, verbose=False):
 110         self.writer = writer
 111         self.verbose = verbose
 112         # Map of variable name => expanded variable value.
 113         self.vars = {}
 114         # Map of rule name => dict of rule attributes.
 115         self.rules = {
 116             'phony': {}
 117         }
 118
 119     def comment(self, text):
 120         return self.writer.comment(text)
 121
 122     def newline(self):
 123         return self.writer.newline()
 124
 125     def variable(self, key, val):
 126         self.vars[key] = self._expand(val)
 127         return self.writer.variable(key, val)
 128
 129     def rule(self, name, **kwargs):
 130         self.rules[name] = kwargs
 131         return self.writer.rule(name, **kwargs)
 132
 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.
 137             return
 138
 139         # Implement just enough of Ninja variable expansion etc. to
 140         # make the bootstrap build work.
 141         local_vars = {
 142             'in': self._expand_paths(inputs),
 143             'out': self._expand_paths(outputs)
 144         }
 145         for key, val in kwargs.get('variables', []):
 146             local_vars[key] = ' '.join(ninja_syntax.as_list(val))
 147
 148         self._run_command(self._expand(cmd, local_vars))
 149
 150         return self.writer.build(outputs, rule, inputs, **kwargs)
 151
 152     def default(self, paths):
 153         return self.writer.default(paths)
 154
 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))
 159
 160     def _expand(self, str, local_vars={}):
 161         """Expand $vars in a string."""
 162         return ninja_syntax.expand(str, self.vars, local_vars)
 163
 164     def _run_command(self, cmdline):
 165         """Run a subcommand, quietly.  Prints the full command on error."""
 166         try:
 167             if self.verbose:
 168                 print(cmdline)
 169             subprocess.check_call(cmdline, shell=True)
 170         except subprocess.CalledProcessError:
 171             print('when running: ', cmdline)
 172             raise
 173
 174
 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',
 192                   choices=profilers,
 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()
 202 if args:
 203     print('ERROR: extra unparsed command-line arguments:', args)
 204     sys.exit(1)
 205
 206 platform = Platform(options.platform)
 207 if options.host:
 208     host = Platform(options.host)
 209 else:
 210     host = platform
 211
 212 BUILD_FILENAME = 'build.ninja'
 213 ninja_writer = ninja_syntax.Writer(open(BUILD_FILENAME, 'w'))
 214 n = ninja_writer
 215
 216 if options.bootstrap:
 217     # Make the build directory.
 218     try:
 219         os.mkdir('build')
 220     except OSError:
 221         pass
 222     # Wrap ninja_writer with the Bootstrapper, which also executes the
 223     # commands.
 224     print('bootstrapping ninja...')
 225     n = Bootstrap(n, verbose=options.verbose)
 226
 227 n.comment('This file is used to build ninja itself.')
 228 n.comment('It is generated by ' + os.path.basename(__file__) + '.')
 229 n.newline()
 230
 231 n.variable('ninja_required_version', '1.3')
 232 n.newline()
 233
 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)
 241 if configure_env:
 242     config_str = ' '.join([k + '=' + pipes.quote(configure_env[k])
 243                            for k in configure_env])
 244     n.variable('configure_env', config_str + '$ ')
 245 n.newline()
 246
 247 CXX = configure_env.get('CXX', 'g++')
 248 objext = '.o'
 249 if platform.is_msvc():
 250     CXX = 'cl'
 251     objext = '.obj'
 252
 253 def src(filename):
 254     return os.path.join('src', filename)
 255 def built(filename):
 256     return os.path.join('$builddir', filename)
 257 def doc(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)
 263 def binary(name):
 264     if platform.is_windows():
 265         exe = name + '.exe'
 266         n.build(name, 'phony', exe)
 267         return exe
 268     return name
 269
 270 n.variable('builddir', 'build')
 271 n.variable('cxx', CXX)
 272 if platform.is_msvc():
 273     n.variable('ar', 'link')
 274 else:
 275     n.variable('ar', configure_env.get('AR', 'ar'))
 276
 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.
 286               '/wd4355',
 287               # Disable warnings about ignored typedef in DbgHelp.h
 288               '/wd4091',
 289               '/GR-',  # Disable RTTI.
 290               # Disable size_t -> int truncation warning.
 291               # We never have strings or arrays larger than 2**31.
 292               '/wd4267',
 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
 298         # output.
 299         cflags.remove('/showIncludes')
 300     if platform.msvc_needs_fs():
 301         cflags.append('/FS')
 302     ldflags = ['/DEBUG', '/libpath:$builddir']
 303     if not options.debug:
 304         cflags += ['/Ox', '/DNDEBUG', '/GL']
 305         ldflags += ['/LTCG', '/OPT:REF', '/OPT:ICF']
 306 else:
 307     cflags = ['-g', '-Wall', '-Wextra',
 308               '-Wno-deprecated',
 309               '-Wno-unused-parameter',
 310               '-fno-rtti',
 311               '-fno-exceptions',
 312               '-fvisibility=hidden', '-pipe',
 313               '-Wno-missing-field-initializers',
 314               '-DNINJA_PYTHON="%s"' % options.with_python]
 315     if options.debug:
 316         cflags += ['-D_GLIBCXX_DEBUG', '-D_GLIBCXX_DEBUG_PEDANTIC']
 317         cflags.remove('-fno-rtti')  # Needed for above pedanticness.
 318     else:
 319         cflags += ['-O2', '-DNDEBUG']
 320     try:
 321         proc = subprocess.Popen([CXX, '--version'], stdout=subprocess.PIPE)
 322         if 'clang' in proc.communicate()[0].decode('utf-8'):
 323             cflags += ['-fcolor-diagnostics']
 324     except:
 325         pass
 326     if platform.is_mingw():
 327         cflags += ['-D_WIN32_WINNT=0x0501']
 328     ldflags = ['-L$builddir']
 329     if platform.uses_usr_local():
 330         cflags.append('-I/usr/local/include')
 331         ldflags.append('-L/usr/local/lib')
 332
 333 libs = []
 334
 335 if platform.is_mingw():
 336     cflags.remove('-fvisibility=hidden');
 337     ldflags.append('-static')
 338 elif platform.is_solaris():
 339     cflags.remove('-fvisibility=hidden')
 340 elif platform.is_msvc():
 341     pass
 342 else:
 343     if options.profile == 'gmon':
 344         cflags.append('-pg')
 345         ldflags.append('-pg')
 346     elif options.profile == 'pprof':
 347         cflags.append('-fno-omit-frame-pointer')
 348         libs.extend(['-Wl,--no-as-needed', '-lprofiler'])
 349
 350 if platform.supports_ppoll() and not options.force_pselect:
 351     cflags.append('-DUSE_PPOLL')
 352 if platform.supports_ninja_browse():
 353     cflags.append('-DNINJA_HAVE_BROWSE')
 354
 355 def shell_escape(str):
 356     """Escape str such that it's interpreted as a single argument by
 357     the shell."""
 358
 359     # This isn't complete, but it's just enough to make NINJA_PYTHON work.
 360     if platform.is_windows():
 361       return str
 362     if '"' in str:
 363         return "'%s'" % str.replace("'", "\\'")
 364     return str
 365
 366 if 'CFLAGS' in configure_env:
 367     cflags.append(configure_env['CFLAGS'])
 368 n.variable('cflags', ' '.join(shell_escape(flag) for flag in cflags))
 369 if 'LDFLAGS' in configure_env:
 370     ldflags.append(configure_env['LDFLAGS'])
 371 n.variable('ldflags', ' '.join(shell_escape(flag) for flag in ldflags))
 372 n.newline()
 373
 374 if platform.is_msvc():
 375     n.rule('cxx',
 376         command='$cxx $cflags -c $in /Fo$out',
 377         description='CXX $out',
 378         deps='msvc'  # /showIncludes is included in $cflags.
 379     )
 380 else:
 381     n.rule('cxx',
 382         command='$cxx -MMD -MT $out -MF $out.d $cflags -c $in -o $out',
 383         depfile='$out.d',
 384         deps='gcc',
 385         description='CXX $out')
 386 n.newline()
 387
 388 if host.is_msvc():
 389     n.rule('ar',
 390            command='lib /nologo /ltcg /out:$out $in',
 391            description='LIB $out')
 392 elif host.is_mingw():
 393     n.rule('ar',
 394            command='cmd /c $ar cqs $out.tmp $in && move /Y $out.tmp $out',
 395            description='AR $out')
 396 else:
 397     n.rule('ar',
 398            command='rm -f $out && $ar crs $out $in',
 399            description='AR $out')
 400 n.newline()
 401
 402 if platform.is_msvc():
 403     n.rule('link',
 404         command='$cxx $in $libs /nologo /link $ldflags /out:$out',
 405         description='LINK $out')
 406 else:
 407     n.rule('link',
 408         command='$cxx $ldflags -o $out $in $libs',
 409         description='LINK $out')
 410 n.newline()
 411
 412 objs = []
 413
 414 if platform.supports_ninja_browse():
 415     n.comment('browse_py.h is used to inline browse.py.')
 416     n.rule('inline',
 417            command='src/inline.sh $varname < $in > $out',
 418            description='INLINE $out')
 419     n.build(built('browse_py.h'), 'inline', src('browse.py'),
 420             implicit='src/inline.sh',
 421             variables=[('varname', 'kBrowsePy')])
 422     n.newline()
 423
 424     objs += cxx('browse', order_only=built('browse_py.h'))
 425     n.newline()
 426
 427 n.comment('the depfile parser and ninja lexers are generated using re2c.')
 428 def has_re2c():
 429     try:
 430         proc = subprocess.Popen(['re2c', '-V'], stdout=subprocess.PIPE)
 431         return int(proc.communicate()[0], 10) >= 1103
 432     except OSError:
 433         return False
 434 if has_re2c():
 435     n.rule('re2c',
 436            command='re2c -b -i --no-generation-date -o $out $in',
 437            description='RE2C $out')
 438     # Generate the .cc files in the source directory so we can check them in.
 439     n.build(src('depfile_parser.cc'), 're2c', src('depfile_parser.in.cc'))
 440     n.build(src('lexer.cc'), 're2c', src('lexer.in.cc'))
 441 else:
 442     print("warning: A compatible version of re2c (>= 0.11.3) was not found; "
 443            "changes to src/*.in.cc will not affect your build.")
 444 n.newline()
 445
 446 n.comment('Core source files all build into ninja library.')
 447 for name in ['build',
 448              'build_log',
 449              'clean',
 450              'debug_flags',
 451              'depfile_parser',
 452              'deps_log',
 453              'disk_interface',
 454              'edit_distance',
 455              'eval_env',
 456              'graph',
 457              'graphviz',
 458              'lexer',
 459              'line_printer',
 460              'manifest_parser',
 461              'metrics',
 462              'state',
 463              'util',
 464              'version']:
 465     objs += cxx(name)
 466 if platform.is_windows():
 467     for name in ['subprocess-win32',
 468                  'includes_normalize-win32',
 469                  'msvc_helper-win32',
 470                  'msvc_helper_main-win32']:
 471         objs += cxx(name)
 472     if platform.is_msvc():
 473         objs += cxx('minidump-win32')
 474     objs += cc('getopt')
 475 else:
 476     objs += cxx('subprocess-posix')
 477 if platform.is_msvc():
 478     ninja_lib = n.build(built('ninja.lib'), 'ar', objs)
 479 else:
 480     ninja_lib = n.build(built('libninja.a'), 'ar', objs)
 481 n.newline()
 482
 483 if platform.is_msvc():
 484     libs.append('ninja.lib')
 485 else:
 486     libs.append('-lninja')
 487
 488 all_targets = []
 489
 490 n.comment('Main executable is library plus main() function.')
 491 objs = cxx('ninja')
 492 ninja = n.build(binary('ninja'), 'link', objs, implicit=ninja_lib,
 493                 variables=[('libs', libs)])
 494 n.newline()
 495 all_targets += ninja
 496
 497 if options.bootstrap:
 498     # We've built the ninja binary.  Don't run any more commands
 499     # through the bootstrap executor, but continue writing the
 500     # build.ninja file.
 501     n = ninja_writer
 502
 503 n.comment('Tests all build into ninja_test executable.')
 504
 505 objs = []
 506
 507 for name in ['build_log_test',
 508              'build_test',
 509              'clean_test',
 510              'depfile_parser_test',
 511              'deps_log_test',
 512              'disk_interface_test',
 513              'edit_distance_test',
 514              'graph_test',
 515              'lexer_test',
 516              'manifest_parser_test',
 517              'ninja_test',
 518              'state_test',
 519              'subprocess_test',
 520              'test',
 521              'util_test']:
 522     objs += cxx(name)
 523 if platform.is_windows():
 524     for name in ['includes_normalize_test', 'msvc_helper_test']:
 525         objs += cxx(name)
 526
 527 ninja_test = n.build(binary('ninja_test'), 'link', objs, implicit=ninja_lib,
 528                      variables=[('libs', libs)])
 529 n.newline()
 530 all_targets += ninja_test
 531
 532
 533 n.comment('Ancillary executables.')
 534 objs = cxx('build_log_perftest')
 535 all_targets += n.build(binary('build_log_perftest'), 'link', objs,
 536                        implicit=ninja_lib, variables=[('libs', libs)])
 537 objs = cxx('canon_perftest')
 538 all_targets += n.build(binary('canon_perftest'), 'link', objs,
 539                        implicit=ninja_lib, variables=[('libs', libs)])
 540 objs = cxx('depfile_parser_perftest')
 541 all_targets += n.build(binary('depfile_parser_perftest'), 'link', objs,
 542                        implicit=ninja_lib, variables=[('libs', libs)])
 543 objs = cxx('hash_collision_bench')
 544 all_targets += n.build(binary('hash_collision_bench'), 'link', objs,
 545                               implicit=ninja_lib, variables=[('libs', libs)])
 546 objs = cxx('manifest_parser_perftest')
 547 all_targets += n.build(binary('manifest_parser_perftest'), 'link', objs,
 548                               implicit=ninja_lib, variables=[('libs', libs)])
 549 n.newline()
 550
 551 n.comment('Generate a graph using the "graph" tool.')
 552 n.rule('gendot',
 553        command='./ninja -t graph all > $out')
 554 n.rule('gengraph',
 555        command='dot -Tpng $in > $out')
 556 dot = n.build(built('graph.dot'), 'gendot', ['ninja', 'build.ninja'])
 557 n.build('graph.png', 'gengraph', dot)
 558 n.newline()
 559
 560 n.comment('Generate the manual using asciidoc.')
 561 n.rule('asciidoc',
 562        command='asciidoc -b docbook -d book -o $out $in',
 563        description='ASCIIDOC $out')
 564 n.rule('xsltproc',
 565        command='xsltproc --nonet doc/docbook.xsl $in > $out',
 566        description='XSLTPROC $out')
 567 xml = n.build(built('manual.xml'), 'asciidoc', doc('manual.asciidoc'))
 568 manual = n.build(doc('manual.html'), 'xsltproc', xml,
 569                  implicit=doc('style.css'))
 570 n.build('manual', 'phony',
 571         order_only=manual)
 572 n.newline()
 573
 574 n.comment('Generate Doxygen.')
 575 n.rule('doxygen',
 576        command='doxygen $in',
 577        description='DOXYGEN $in')
 578 n.variable('doxygen_mainpage_generator',
 579            src('gen_doxygen_mainpage.sh'))
 580 n.rule('doxygen_mainpage',
 581        command='$doxygen_mainpage_generator $in > $out',
 582        description='DOXYGEN_MAINPAGE $out')
 583 mainpage = n.build(built('doxygen_mainpage'), 'doxygen_mainpage',
 584                    ['README', 'COPYING'],
 585                    implicit=['$doxygen_mainpage_generator'])
 586 n.build('doxygen', 'doxygen', doc('doxygen.config'),
 587         implicit=mainpage)
 588 n.newline()
 589
 590 if not host.is_mingw():
 591     n.comment('Regenerate build files if build script changes.')
 592     n.rule('configure',
 593            command='${configure_env}%s configure.py $configure_args' %
 594                options.with_python,
 595            generator=True)
 596     n.build('build.ninja', 'configure',
 597             implicit=['configure.py', os.path.normpath('misc/ninja_syntax.py')])
 598     n.newline()
 599
 600 n.default(ninja)
 601 n.newline()
 602
 603 if host.is_linux():
 604     n.comment('Packaging')
 605     n.rule('rpmbuild',
 606            command="misc/packaging/rpmbuild.sh",
 607            description='Building rpms..')
 608     n.build('rpm', 'rpmbuild')
 609     n.newline()
 610
 611 n.build('all', 'phony', all_targets)
 612
 613 n.close()
 614 print('wrote %s.' % BUILD_FILENAME)
 615
 616 verbose = ''
 617 if options.verbose:
 618     verbose = ' -v'
 619
 620 if options.bootstrap:
 621     print('bootstrap complete.  rebuilding...')
 622     if platform.is_windows():
 623         bootstrap_exe = 'ninja.bootstrap.exe'
 624         if os.path.exists(bootstrap_exe):
 625             os.unlink(bootstrap_exe)
 626         os.rename('ninja.exe', bootstrap_exe)
 627         subprocess.check_call('ninja.bootstrap.exe%s' % verbose, shell=True)
 628     else:
 629         subprocess.check_call('./ninja%s' % verbose, shell=True)