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 sys
  28 import platform_helper
  29 sys.path.insert(0, 'misc')
  30
  31 import ninja_syntax
  32
  33 parser = OptionParser()
  34 profilers = ['gmon', 'pprof']
  35 parser.add_option('--platform',
  36                   help='target platform (' +
  37                        '/'.join(platform_helper.platforms()) + ')',
  38                   choices=platform_helper.platforms())
  39 parser.add_option('--host',
  40                   help='host platform (' +
  41                        '/'.join(platform_helper.platforms()) + ')',
  42                   choices=platform_helper.platforms())
  43 parser.add_option('--debug', action='store_true',
  44                   help='enable debugging extras',)
  45 parser.add_option('--profile', metavar='TYPE',
  46                   choices=profilers,
  47                   help='enable profiling (' + '/'.join(profilers) + ')',)
  48 parser.add_option('--with-gtest', metavar='PATH', help='ignored')
  49 parser.add_option('--with-python', metavar='EXE',
  50                   help='use EXE as the Python interpreter',
  51                   default=os.path.basename(sys.executable))
  52 parser.add_option('--force-pselect', action='store_true',
  53                   help='ppoll() is used by default where available, '
  54                        'but some platforms may need to use pselect instead',)
  55 (options, args) = parser.parse_args()
  56 if args:
  57     print('ERROR: extra unparsed command-line arguments:', args)
  58     sys.exit(1)
  59
  60 platform = platform_helper.Platform(options.platform)
  61 if options.host:
  62     host = platform_helper.Platform(options.host)
  63 else:
  64     host = platform
  65
  66 BUILD_FILENAME = 'build.ninja'
  67 buildfile = open(BUILD_FILENAME, 'w')
  68 n = ninja_syntax.Writer(buildfile)
  69 n.comment('This file is used to build ninja itself.')
  70 n.comment('It is generated by ' + os.path.basename(__file__) + '.')
  71 n.newline()
  72
  73 n.variable('ninja_required_version', '1.3')
  74 n.newline()
  75
  76 n.comment('The arguments passed to configure.py, for rerunning it.')
  77 n.variable('configure_args', ' '.join(sys.argv[1:]))
  78 env_keys = set(['CXX', 'AR', 'CFLAGS', 'LDFLAGS'])
  79 configure_env = dict((k, os.environ[k]) for k in os.environ if k in env_keys)
  80 if configure_env:
  81     config_str = ' '.join([k + '=' + pipes.quote(configure_env[k])
  82                            for k in configure_env])
  83     n.variable('configure_env', config_str + '$ ')
  84 n.newline()
  85
  86 CXX = configure_env.get('CXX', 'g++')
  87 objext = '.o'
  88 if platform.is_msvc():
  89     CXX = 'cl'
  90     objext = '.obj'
  91
  92 def src(filename):
  93     return os.path.join('src', filename)
  94 def built(filename):
  95     return os.path.join('$builddir', filename)
  96 def doc(filename):
  97     return os.path.join('doc', filename)
  98 def cc(name, **kwargs):
  99     return n.build(built(name + objext), 'cxx', src(name + '.c'), **kwargs)
 100 def cxx(name, **kwargs):
 101     return n.build(built(name + objext), 'cxx', src(name + '.cc'), **kwargs)
 102 def binary(name):
 103     if platform.is_windows():
 104         exe = name + '.exe'
 105         n.build(name, 'phony', exe)
 106         return exe
 107     return name
 108
 109 n.variable('builddir', 'build')
 110 n.variable('cxx', CXX)
 111 if platform.is_msvc():
 112     n.variable('ar', 'link')
 113 else:
 114     n.variable('ar', configure_env.get('AR', 'ar'))
 115
 116 if platform.is_msvc():
 117     cflags = ['/nologo',  # Don't print startup banner.
 118               '/Zi',  # Create pdb with debug info.
 119               '/W4',  # Highest warning level.
 120               '/WX',  # Warnings as errors.
 121               '/wd4530', '/wd4100', '/wd4706',
 122               '/wd4512', '/wd4800', '/wd4702', '/wd4819',
 123               # Disable warnings about passing "this" during initialization.
 124               '/wd4355',
 125               '/GR-',  # Disable RTTI.
 126               # Disable size_t -> int truncation warning.
 127               # We never have strings or arrays larger than 2**31.
 128               '/wd4267',
 129               '/DNOMINMAX', '/D_CRT_SECURE_NO_WARNINGS',
 130               '/D_VARIADIC_MAX=10',
 131               '/DNINJA_PYTHON="%s"' % options.with_python]
 132     if platform.msvc_needs_fs():
 133         cflags.append('/FS')
 134     ldflags = ['/DEBUG', '/libpath:$builddir']
 135     if not options.debug:
 136         cflags += ['/Ox', '/DNDEBUG', '/GL']
 137         ldflags += ['/LTCG', '/OPT:REF', '/OPT:ICF']
 138 else:
 139     cflags = ['-g', '-Wall', '-Wextra',
 140               '-Wno-deprecated',
 141               '-Wno-unused-parameter',
 142               '-fno-rtti',
 143               '-fno-exceptions',
 144               '-fvisibility=hidden', '-pipe',
 145               '-Wno-missing-field-initializers',
 146               '-DNINJA_PYTHON="%s"' % options.with_python]
 147     if options.debug:
 148         cflags += ['-D_GLIBCXX_DEBUG', '-D_GLIBCXX_DEBUG_PEDANTIC']
 149         cflags.remove('-fno-rtti')  # Needed for above pedanticness.
 150     else:
 151         cflags += ['-O2', '-DNDEBUG']
 152     if 'clang' in os.path.basename(CXX):
 153         cflags += ['-fcolor-diagnostics']
 154     if platform.is_mingw():
 155         cflags += ['-D_WIN32_WINNT=0x0501']
 156     ldflags = ['-L$builddir']
 157 libs = []
 158
 159 if platform.is_mingw():
 160     cflags.remove('-fvisibility=hidden');
 161     ldflags.append('-static')
 162 elif platform.is_sunos5():
 163     cflags.remove('-fvisibility=hidden')
 164 elif platform.is_msvc():
 165     pass
 166 else:
 167     if options.profile == 'gmon':
 168         cflags.append('-pg')
 169         ldflags.append('-pg')
 170     elif options.profile == 'pprof':
 171         cflags.append('-fno-omit-frame-pointer')
 172         libs.extend(['-Wl,--no-as-needed', '-lprofiler'])
 173
 174 if (platform.is_linux() or platform.is_openbsd() or platform.is_bitrig()) and \
 175         not options.force_pselect:
 176     cflags.append('-DUSE_PPOLL')
 177
 178 have_browse = not platform.is_windows() and not platform.is_solaris()
 179 if have_browse:
 180     cflags.append('-DNINJA_HAVE_BROWSE')
 181
 182 def shell_escape(str):
 183     """Escape str such that it's interpreted as a single argument by
 184     the shell."""
 185
 186     # This isn't complete, but it's just enough to make NINJA_PYTHON work.
 187     if platform.is_windows():
 188       return str
 189     if '"' in str:
 190         return "'%s'" % str.replace("'", "\\'")
 191     return str
 192
 193 if 'CFLAGS' in configure_env:
 194     cflags.append(configure_env['CFLAGS'])
 195 n.variable('cflags', ' '.join(shell_escape(flag) for flag in cflags))
 196 if 'LDFLAGS' in configure_env:
 197     ldflags.append(configure_env['LDFLAGS'])
 198 n.variable('ldflags', ' '.join(shell_escape(flag) for flag in ldflags))
 199 n.newline()
 200
 201 if platform.is_msvc():
 202     n.rule('cxx',
 203         command='$cxx /showIncludes $cflags -c $in /Fo$out',
 204         description='CXX $out',
 205         deps='msvc')
 206 else:
 207     n.rule('cxx',
 208         command='$cxx -MMD -MT $out -MF $out.d $cflags -c $in -o $out',
 209         depfile='$out.d',
 210         deps='gcc',
 211         description='CXX $out')
 212 n.newline()
 213
 214 if host.is_msvc():
 215     n.rule('ar',
 216            command='lib /nologo /ltcg /out:$out $in',
 217            description='LIB $out')
 218 elif host.is_mingw():
 219     n.rule('ar',
 220            command='cmd /c $ar cqs $out.tmp $in && move /Y $out.tmp $out',
 221            description='AR $out')
 222 else:
 223     n.rule('ar',
 224            command='rm -f $out && $ar crs $out $in',
 225            description='AR $out')
 226 n.newline()
 227
 228 if platform.is_msvc():
 229     n.rule('link',
 230         command='$cxx $in $libs /nologo /link $ldflags /out:$out',
 231         description='LINK $out')
 232 else:
 233     n.rule('link',
 234         command='$cxx $ldflags -o $out $in $libs',
 235         description='LINK $out')
 236 n.newline()
 237
 238 objs = []
 239
 240 if have_browse:
 241     n.comment('browse_py.h is used to inline browse.py.')
 242     n.rule('inline',
 243            command='src/inline.sh $varname < $in > $out',
 244            description='INLINE $out')
 245     n.build(built('browse_py.h'), 'inline', src('browse.py'),
 246             implicit='src/inline.sh',
 247             variables=[('varname', 'kBrowsePy')])
 248     n.newline()
 249
 250     objs += cxx('browse', order_only=built('browse_py.h'))
 251     n.newline()
 252
 253 n.comment('the depfile parser and ninja lexers are generated using re2c.')
 254 def has_re2c():
 255     import subprocess
 256     try:
 257         proc = subprocess.Popen(['re2c', '-V'], stdout=subprocess.PIPE)
 258         return int(proc.communicate()[0], 10) >= 1103
 259     except OSError:
 260         return False
 261 if has_re2c():
 262     n.rule('re2c',
 263            command='re2c -b -i --no-generation-date -o $out $in',
 264            description='RE2C $out')
 265     # Generate the .cc files in the source directory so we can check them in.
 266     n.build(src('depfile_parser.cc'), 're2c', src('depfile_parser.in.cc'))
 267     n.build(src('lexer.cc'), 're2c', src('lexer.in.cc'))
 268 else:
 269     print("warning: A compatible version of re2c (>= 0.11.3) was not found; "
 270            "changes to src/*.in.cc will not affect your build.")
 271 n.newline()
 272
 273 n.comment('Core source files all build into ninja library.')
 274 for name in ['build',
 275              'build_log',
 276              'clean',
 277              'debug_flags',
 278              'depfile_parser',
 279              'deps_log',
 280              'disk_interface',
 281              'edit_distance',
 282              'eval_env',
 283              'graph',
 284              'graphviz',
 285              'lexer',
 286              'line_printer',
 287              'manifest_parser',
 288              'metrics',
 289              'state',
 290              'util',
 291              'version']:
 292     objs += cxx(name)
 293 if platform.is_windows():
 294     for name in ['subprocess-win32',
 295                  'includes_normalize-win32',
 296                  'msvc_helper-win32',
 297                  'msvc_helper_main-win32']:
 298         objs += cxx(name)
 299     if platform.is_msvc():
 300         objs += cxx('minidump-win32')
 301     objs += cc('getopt')
 302 else:
 303     objs += cxx('subprocess-posix')
 304 if platform.is_msvc():
 305     ninja_lib = n.build(built('ninja.lib'), 'ar', objs)
 306 else:
 307     ninja_lib = n.build(built('libninja.a'), 'ar', objs)
 308 n.newline()
 309
 310 if platform.is_msvc():
 311     libs.append('ninja.lib')
 312 else:
 313     libs.append('-lninja')
 314
 315 all_targets = []
 316
 317 n.comment('Main executable is library plus main() function.')
 318 objs = cxx('ninja')
 319 ninja = n.build(binary('ninja'), 'link', objs, implicit=ninja_lib,
 320                 variables=[('libs', libs)])
 321 n.newline()
 322 all_targets += ninja
 323
 324 n.comment('Tests all build into ninja_test executable.')
 325
 326 test_libs = libs
 327 objs = []
 328
 329 for name in ['build_log_test',
 330              'build_test',
 331              'clean_test',
 332              'depfile_parser_test',
 333              'deps_log_test',
 334              'disk_interface_test',
 335              'edit_distance_test',
 336              'graph_test',
 337              'lexer_test',
 338              'manifest_parser_test',
 339              'ninja_test',
 340              'state_test',
 341              'subprocess_test',
 342              'test',
 343              'util_test']:
 344     objs += cxx(name)
 345 if platform.is_windows():
 346     for name in ['includes_normalize_test', 'msvc_helper_test']:
 347         objs += cxx(name)
 348
 349 if not platform.is_windows():
 350     test_libs.append('-lpthread')
 351 ninja_test = n.build(binary('ninja_test'), 'link', objs, implicit=ninja_lib,
 352                      variables=[('libs', test_libs)])
 353 n.newline()
 354 all_targets += ninja_test
 355
 356
 357 n.comment('Ancillary executables.')
 358 objs = cxx('build_log_perftest')
 359 all_targets += n.build(binary('build_log_perftest'), 'link', objs,
 360                        implicit=ninja_lib, variables=[('libs', libs)])
 361 objs = cxx('canon_perftest')
 362 all_targets += n.build(binary('canon_perftest'), 'link', objs,
 363                        implicit=ninja_lib, variables=[('libs', libs)])
 364 objs = cxx('depfile_parser_perftest')
 365 all_targets += n.build(binary('depfile_parser_perftest'), 'link', objs,
 366                        implicit=ninja_lib, variables=[('libs', libs)])
 367 objs = cxx('hash_collision_bench')
 368 all_targets += n.build(binary('hash_collision_bench'), 'link', objs,
 369                               implicit=ninja_lib, variables=[('libs', libs)])
 370 objs = cxx('manifest_parser_perftest')
 371 all_targets += n.build(binary('manifest_parser_perftest'), 'link', objs,
 372                               implicit=ninja_lib, variables=[('libs', libs)])
 373 n.newline()
 374
 375 n.comment('Generate a graph using the "graph" tool.')
 376 n.rule('gendot',
 377        command='./ninja -t graph all > $out')
 378 n.rule('gengraph',
 379        command='dot -Tpng $in > $out')
 380 dot = n.build(built('graph.dot'), 'gendot', ['ninja', 'build.ninja'])
 381 n.build('graph.png', 'gengraph', dot)
 382 n.newline()
 383
 384 n.comment('Generate the manual using asciidoc.')
 385 n.rule('asciidoc',
 386        command='asciidoc -b docbook -d book -o $out $in',
 387        description='ASCIIDOC $out')
 388 n.rule('xsltproc',
 389        command='xsltproc --nonet doc/docbook.xsl $in > $out',
 390        description='XSLTPROC $out')
 391 xml = n.build(built('manual.xml'), 'asciidoc', doc('manual.asciidoc'))
 392 manual = n.build(doc('manual.html'), 'xsltproc', xml,
 393                  implicit=doc('style.css'))
 394 n.build('manual', 'phony',
 395         order_only=manual)
 396 n.newline()
 397
 398 n.comment('Generate Doxygen.')
 399 n.rule('doxygen',
 400        command='doxygen $in',
 401        description='DOXYGEN $in')
 402 n.variable('doxygen_mainpage_generator',
 403            src('gen_doxygen_mainpage.sh'))
 404 n.rule('doxygen_mainpage',
 405        command='$doxygen_mainpage_generator $in > $out',
 406        description='DOXYGEN_MAINPAGE $out')
 407 mainpage = n.build(built('doxygen_mainpage'), 'doxygen_mainpage',
 408                    ['README', 'COPYING'],
 409                    implicit=['$doxygen_mainpage_generator'])
 410 n.build('doxygen', 'doxygen', doc('doxygen.config'),
 411         implicit=mainpage)
 412 n.newline()
 413
 414 if not host.is_mingw():
 415     n.comment('Regenerate build files if build script changes.')
 416     n.rule('configure',
 417            command='${configure_env}%s configure.py $configure_args' %
 418                options.with_python,
 419            generator=True)
 420     n.build('build.ninja', 'configure',
 421             implicit=['configure.py', os.path.normpath('misc/ninja_syntax.py')])
 422     n.newline()
 423
 424 n.default(ninja)
 425 n.newline()
 426
 427 if host.is_linux():
 428     n.comment('Packaging')
 429     n.rule('rpmbuild',
 430            command="misc/packaging/rpmbuild.sh",
 431            description='Building rpms..')
 432     n.build('rpm', 'rpmbuild')
 433     n.newline()
 434
 435 n.build('all', 'phony', all_targets)
 436
 437 print('wrote %s.' % BUILD_FILENAME)