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