gn 8.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
#!/usr/bin/env python
# Copyright 2015 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import argparse
import subprocess
import sys
import os

11
SRC_ROOT = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
12

13
def get_out_dir(args):
14 15 16 17 18 19
    if args.target_os is not None:
        target_dir = [args.target_os]
    else:
        target_dir = ['host']

    target_dir.append(args.runtime_mode)
20 21

    if args.simulator:
22
        target_dir.append('sim')
23

24 25
    if args.unoptimized:
        target_dir.append('unopt')
26

27
    if args.android_cpu != 'arm':
28
        target_dir.append(args.android_cpu)
29

30 31 32
    if args.ios_cpu != 'arm64':
        target_dir.append(args.ios_cpu)

33 34 35
    if args.linux_cpu is not None:
      target_dir.append(args.linux_cpu)

36 37 38
    if args.enable_vulkan:
        target_dir.append('vulkan')

39
    return os.path.join('out', '_'.join(target_dir))
40 41 42 43

def to_command_line(gn_args):
    def merge(key, value):
        if type(value) is bool:
44 45
            return '%s=%s' % (key, 'true' if value else 'false')
        return '%s="%s"' % (key, value)
46 47
    return [merge(x, y) for x, y in gn_args.iteritems()]

48 49 50 51 52 53 54 55
def cpu_for_target_arch(arch):
  if arch in ['ia32', 'arm', 'armv6', 'armv5te', 'mips',
              'simarm', 'simarmv6', 'simarmv5te', 'simmips', 'simdbc',
              'armsimdbc']:
    return 'x86'
  if arch in ['x64', 'arm64', 'simarm64', 'simdbc64', 'armsimdbc64']:
    return 'x64'

56
def to_gn_args(args):
57 58 59 60
    if args.simulator:
        if args.target_os == 'android':
            raise Exception('--simulator is not supported on Android')
        elif args.target_os == 'ios':
61 62
            if args.runtime_mode != 'debug':
                raise Exception('iOS simulator only supports the debug runtime mode')
63

64 65 66
    if args.target_os != 'android' and args.enable_vulkan:
      raise Exception('--enable-vulkan is only supported on Android')

67 68
    gn_args = {}

69
    # Skia GN args.
70
    gn_args['skia_enable_flutter_defines'] = True # Enable Flutter API guards in Skia.
71 72 73
    gn_args['skia_use_dng_sdk'] = False    # RAW image handling.
    gn_args['skia_use_sfntly'] = False     # PDF handling.
    gn_args['skia_use_fontconfig'] = False # Use the custom font manager instead.
74
    gn_args['is_official_build'] = True    # Disable Skia test utilities.
75

76
    gn_args['is_debug'] = args.unoptimized
77
    gn_args['android_full_debug'] = args.target_os == 'android' and args.unoptimized
78
    gn_args['is_clang'] = not sys.platform.startswith(('cygwin', 'win'))
79

80 81 82 83 84
    enable_lto = args.lto
    if args.unoptimized:
      # There is no point in enabling LTO in unoptimized builds.
      enable_lto = False

85
    if args.target_os != 'win':
86 87
      # The GN arg is not available in the windows toolchain.
      gn_args['enable_lto'] = enable_lto
88

89
    aot = args.runtime_mode != 'debug'
90
    if args.target_os == 'android':
91
        gn_args['target_os'] = 'android'
92
    elif args.target_os == 'ios':
93
        gn_args['target_os'] = 'ios'
94
        gn_args['use_ios_simulator'] = args.simulator
95
        if not args.simulator:
96
          aot = True
97
    else:
98
      aot = False
99

100 101 102 103 104
    if args.runtime_mode == 'debug':
        gn_args['dart_runtime_mode'] = 'develop'
    else:
        gn_args['dart_runtime_mode'] = args.runtime_mode

105 106 107 108 109 110
    if args.target_os == 'android':
        gn_args['target_cpu'] = args.android_cpu
    elif args.target_os == 'ios':
        if args.simulator:
            gn_args['target_cpu'] = 'x64'
        else:
111
            gn_args['target_cpu'] = args.ios_cpu
112 113
    elif args.target_os == 'linux':
      gn_args['target_cpu'] = args.linux_cpu
114 115 116
    else:
        # Building host artifacts
        gn_args['target_cpu'] = 'x64'
117

118 119 120 121
    # On iOS Devices, use the Dart bytecode interpreter so we don't incur
    # snapshotting and linking costs of the precompiler during development.
    # We can still use the JIT on the simulator though.
    use_dbc = args.target_os == 'ios' and not args.simulator and args.runtime_mode == 'debug'
122 123
    if use_dbc:
      gn_args['dart_target_arch'] = 'dbc'
124 125 126 127 128 129 130 131 132
    else:
      gn_args['dart_target_arch'] = gn_args['target_cpu']

    # No cross-compilation on Windows (for now).
    if sys.platform.startswith(('cygwin', 'win')):
      if 'target_os' in gn_args:
        gn_args['target_os'] = 'win'
      if 'target_cpu' in gn_args:
        gn_args['target_cpu'] = cpu_for_target_arch(gn_args['target_cpu'])
133

134 135 136 137 138
    if args.target_os is None:
      if sys.platform.startswith(('cygwin', 'win')):
        gn_args['dart_use_fallback_root_certificates'] = True


139 140
    gn_args['dart_custom_version_for_pub'] = 'flutter'

141
    # Make sure host_cpu matches the bit width of target_cpu.
142 143
    target_is_32_bit = gn_args['target_cpu'] == 'arm' or gn_args['target_cpu'] == 'x86'
    if target_is_32_bit:
144
      gn_args["host_cpu"] = "x86"
145

146
    gn_args['flutter_runtime_mode'] = args.runtime_mode
147
    gn_args['flutter_aot'] = aot
148

G
George Kulakowski 已提交
149 150 151 152 153 154
    if args.target_sysroot:
      gn_args['target_sysroot'] = args.target_sysroot

    if args.toolchain_prefix:
      gn_args['toolchain_prefix'] = args.toolchain_prefix

E
Eric Seidel 已提交
155 156 157 158 159 160 161 162 163 164 165 166
    goma_dir = os.environ.get('GOMA_DIR')
    goma_home_dir = os.path.join(os.getenv('HOME', ''), 'goma')
    if args.goma and goma_dir:
      gn_args['use_goma'] = True
      gn_args['goma_dir'] = goma_dir
    elif args.goma and os.path.exists(goma_home_dir):
      gn_args['use_goma'] = True
      gn_args['goma_dir'] = goma_home_dir
    else:
      gn_args['use_goma'] = False
      gn_args['goma_dir'] = None

167 168 169 170 171
    if args.enable_vulkan:
      # Enable vulkan in the Flutter shell.
      gn_args['shell_enable_vulkan'] = True
      # Configure Skia for Vulkan support.
      gn_args['skia_use_vulkan'] = True
172
      gn_args['skia_vulkan_header'] = "flutter/vulkan/skia_vulkan_header.h"
173

174 175
    # We should not need a special case for x86, but this seems to introduce text relocations
    # even with -fPIC everywhere.
176
    # gn_args['enable_profiling'] = args.runtime_mode != 'release' and args.android_cpu != 'x86'
177

178 179
    return gn_args

180
def parse_args(args):
E
Eric Seidel 已提交
181
  args = args[1:]
182
  parser = argparse.ArgumentParser(description='A script run` gn gen`.')
E
Eric Seidel 已提交
183

184
  parser.add_argument('--unoptimized', default=False, action='store_true')
185

186
  parser.add_argument('--runtime-mode', type=str, choices=['debug', 'profile', 'release'], default='debug')
E
Eric Seidel 已提交
187

188
  parser.add_argument('--target-os', type=str, choices=['android', 'ios', 'linux'])
189
  parser.add_argument('--android', dest='target_os', action='store_const', const='android')
190
  parser.add_argument('--android-cpu', type=str, choices=['arm', 'x64', 'x86', 'arm64'], default='arm')
191
  parser.add_argument('--ios', dest='target_os', action='store_const', const='ios')
192
  parser.add_argument('--ios-cpu', type=str, choices=['arm', 'arm64'], default='arm64')
E
Eric Seidel 已提交
193
  parser.add_argument('--simulator', action='store_true', default=False)
194
  parser.add_argument('--linux-cpu', type=str, choices=['x64', 'x86', 'arm64'])
E
Eric Seidel 已提交
195 196 197 198

  parser.add_argument('--goma', default=True, action='store_true')
  parser.add_argument('--no-goma', dest='goma', action='store_false')

199 200 201
  parser.add_argument('--lto', default=True, action='store_true')
  parser.add_argument('--no-lto', dest='lto', action='store_false')

A
Adam Barth 已提交
202 203 204
  parser.add_argument('--clang', default=True, action='store_true')
  parser.add_argument('--no-clang', dest='clang', action='store_false')

G
George Kulakowski 已提交
205 206 207
  parser.add_argument('--target-sysroot', type=str)
  parser.add_argument('--toolchain-prefix', type=str)

208
  parser.add_argument('--use-glfw', action='store_true', default=False)
209
  parser.add_argument('--enable-vulkan', action='store_true', default=False)
210

211
  return parser.parse_args(args)
212

213 214
def main(argv):
  args = parse_args(argv)
215 216 217 218 219 220 221 222 223 224 225 226 227

  if sys.platform.startswith(('cygwin', 'win')):
    subdir = 'win'
  elif sys.platform == 'darwin':
    subdir = 'mac'
  elif sys.platform.startswith('linux'):
     subdir = 'linux64'
  else:
    raise Error('Unknown platform: ' + sys.platform)

  command = [
    '%s/buildtools/%s/gn' % (SRC_ROOT, subdir),
    'gen',
228
    '--check',
229
  ]
230 231 232 233 234

  if sys.platform == 'darwin':
    # On the Mac, also generate Xcode projects for ease of editing.
    command.append('--ide=xcode')

235 236 237 238
  if sys.platform.startswith('win'):
    # On Windows, also generate Visual Studio project for ease of editing.
    command.append('--ide=vs')

239 240
  gn_args = to_command_line(to_gn_args(args))
  out_dir = get_out_dir(args)
E
Eric Seidel 已提交
241
  print "gn gen --check in %s" % out_dir
242 243
  command.append(out_dir)
  command.append('--args=%s' % ' '.join(gn_args))
244 245 246 247 248
  gn_call_result = subprocess.call(command, cwd=SRC_ROOT)

  if gn_call_result == 0:
    # Generate/Replace the compile commands database in out.
    compile_cmd_gen_cmd = [
249
      'ninja',
250 251 252 253 254
      '-C',
      out_dir,
      '-t',
      'compdb',
      'cc',
255 256 257 258
      'cxx',
      'objc',
      'objcxx',
      'asm',
259 260 261 262 263 264 265 266
    ]

    contents = subprocess.check_output(compile_cmd_gen_cmd, cwd=SRC_ROOT)
    compile_commands = open('%s/out/compile_commands.json' % SRC_ROOT, 'w+')
    compile_commands.write(contents)
    compile_commands.close()

  return gn_call_result
267 268

if __name__ == '__main__':
269
    sys.exit(main(sys.argv))