mirror of
https://github.com/jerryscript-project/jerryscript.git
synced 2025-12-15 16:29:21 +00:00
b61d0ed856
In `tools/build.py`: - For the sake of readability, group CLI arguments as general build options, options to control the building of components, and component-specific options. - To prevent duplications, remove the defaults from those CLI arguments that correspond to CMake options and have defaults in any of the CMakeLists. Should any of the defaults change, they will have to be changed at a single place only. (Those options that are not set on the command line of `tools/build.py` are not passed as options to `cmake` either.) - Convert `--unittests` and `--doctests` to ON/OFF options like the rest of the component switches. - Touch on some of the help messages of the CLI arguments. Other changes: - The change in `--unittests` and `--doctests` is a slightly CLI- breaking change of `tools/build.py`. Thus, follow up on this in `tools/run-tests.py`. - Move `ENABLE_ALL_IN_ONE` into `jerry-core` as it is not a general option but specific to that component. - Remove the forcing of `ENABLE_ALL_IN_ONE` for some compilers/ platforms as it is still an option, not a hard requirement. JerryScript-DCO-1.0-Signed-off-by: Akos Kiss akiss@inf.u-szeged.hu
271 lines
14 KiB
Python
Executable File
271 lines
14 KiB
Python
Executable File
#!/usr/bin/env python
|
|
|
|
# Copyright JS Foundation and other contributors, http://js.foundation
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from __future__ import print_function
|
|
|
|
import argparse
|
|
import multiprocessing
|
|
import os
|
|
import shutil
|
|
import subprocess
|
|
import sys
|
|
import settings
|
|
|
|
def default_toolchain():
|
|
(sysname, _, _, _, machine) = os.uname()
|
|
toolchain = os.path.join(settings.PROJECT_DIR,
|
|
'cmake',
|
|
'toolchain_%s_%s.cmake' % (sysname.lower(), machine.lower()))
|
|
return toolchain if os.path.isfile(toolchain) else None
|
|
|
|
def get_arguments():
|
|
devhelp_preparser = argparse.ArgumentParser(add_help=False)
|
|
devhelp_preparser.add_argument('--devhelp', action='store_true', default=False,
|
|
help='show help with all options '
|
|
'(including those, which are useful for developers only)')
|
|
|
|
devhelp_arguments, args = devhelp_preparser.parse_known_args()
|
|
if devhelp_arguments.devhelp:
|
|
args.append('--devhelp')
|
|
|
|
def devhelp(helpstring):
|
|
return helpstring if devhelp_arguments.devhelp else argparse.SUPPRESS
|
|
|
|
parser = argparse.ArgumentParser(parents=[devhelp_preparser], epilog="""
|
|
This tool is a thin wrapper around cmake and make to help build the
|
|
project easily. All the real build logic is in the CMakeLists.txt files.
|
|
For most of the options, the defaults are also defined there.
|
|
""")
|
|
|
|
buildgrp = parser.add_argument_group('general build options')
|
|
buildgrp.add_argument('--builddir', metavar='DIR', default=os.path.join(settings.PROJECT_DIR, 'build'),
|
|
help='specify build directory (default: %(default)s)')
|
|
buildgrp.add_argument('--clean', action='store_true', default=False,
|
|
help='clean build')
|
|
buildgrp.add_argument('--cmake-param', metavar='OPT', action='append', default=[],
|
|
help='add custom argument to CMake')
|
|
buildgrp.add_argument('--compile-flag', metavar='OPT', action='append', default=[],
|
|
help='add custom compile flag')
|
|
buildgrp.add_argument('--debug', action='store_const', const='Debug', dest='build_type',
|
|
help='debug build')
|
|
buildgrp.add_argument('--install', metavar='DIR', nargs='?', default=None, const=False,
|
|
help='install after build (default: don\'t install; '
|
|
'default directory if install: OS-specific)')
|
|
buildgrp.add_argument('-j', '--jobs', metavar='N', type=int, default=multiprocessing.cpu_count() + 1,
|
|
help='number of parallel build jobs (default: %(default)s)')
|
|
buildgrp.add_argument('--link-lib', metavar='OPT', action='append', default=[],
|
|
help='add custom library to be linked')
|
|
buildgrp.add_argument('--linker-flag', metavar='OPT', action='append', default=[],
|
|
help='add custom linker flag')
|
|
buildgrp.add_argument('--lto', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable link-time optimizations (%(choices)s)')
|
|
buildgrp.add_argument('--shared-libs', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable building of shared libraries (%(choices)s)')
|
|
buildgrp.add_argument('--strip', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='strip release binaries (%(choices)s)')
|
|
buildgrp.add_argument('--toolchain', metavar='FILE', default=default_toolchain(),
|
|
help='specify toolchain file (default: %(default)s)')
|
|
buildgrp.add_argument('-v', '--verbose', action='store_const', const='ON',
|
|
help='increase verbosity')
|
|
|
|
compgrp = parser.add_argument_group('optional components')
|
|
compgrp.add_argument('--doctests', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help=devhelp('build doctests (%(choices)s)'))
|
|
compgrp.add_argument('--jerry-cmdline', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='build jerry command line tool (%(choices)s)')
|
|
compgrp.add_argument('--jerry-cmdline-snapshot', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='build snapshot command line tool (%(choices)s)')
|
|
compgrp.add_argument('--jerry-cmdline-test', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help=devhelp('build test version of the jerry command line tool (%(choices)s)'))
|
|
compgrp.add_argument('--jerry-ext', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='build jerry-ext (%(choices)s)')
|
|
compgrp.add_argument('--jerry-libc', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='build and use jerry-libc (%(choices)s)')
|
|
compgrp.add_argument('--jerry-libm', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='build and use jerry-libm (%(choices)s)')
|
|
compgrp.add_argument('--jerry-port-default', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='build default jerry port implementation (%(choices)s)')
|
|
compgrp.add_argument('--unittests', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help=devhelp('build unittests (%(choices)s)'))
|
|
|
|
coregrp = parser.add_argument_group('jerry-core options')
|
|
coregrp.add_argument('--all-in-one', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='all-in-one build (%(choices)s)')
|
|
coregrp.add_argument('--cpointer-32bit', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable 32 bit compressed pointers (%(choices)s)')
|
|
coregrp.add_argument('--error-messages', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable error messages (%(choices)s)')
|
|
coregrp.add_argument('--external-context', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable external context (%(choices)s)')
|
|
coregrp.add_argument('--jerry-debugger', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable the jerry debugger (%(choices)s)')
|
|
coregrp.add_argument('--js-parser', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable js-parser (%(choices)s)')
|
|
coregrp.add_argument('--line-info', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='provide line info (%(choices)s)')
|
|
coregrp.add_argument('--mem-heap', metavar='SIZE', type=int,
|
|
help='size of memory heap (in kilobytes)')
|
|
coregrp.add_argument('--mem-stats', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help=devhelp('enable memory statistics (%(choices)s)'))
|
|
coregrp.add_argument('--mem-stress-test', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help=devhelp('enable mem-stress test (%(choices)s)'))
|
|
coregrp.add_argument('--profile', metavar='FILE',
|
|
help='specify profile file')
|
|
coregrp.add_argument('--regexp-strict-mode', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help=devhelp('enable regexp strict mode (%(choices)s)'))
|
|
coregrp.add_argument('--show-opcodes', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help=devhelp('enable parser byte-code dumps (%(choices)s)'))
|
|
coregrp.add_argument('--show-regexp-opcodes', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help=devhelp('enable regexp byte-code dumps (%(choices)s)'))
|
|
coregrp.add_argument('--snapshot-exec', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable executing snapshot files (%(choices)s)')
|
|
coregrp.add_argument('--snapshot-save', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable saving snapshot files (%(choices)s)')
|
|
coregrp.add_argument('--system-allocator', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable system allocator (%(choices)s)')
|
|
coregrp.add_argument('--valgrind', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help=devhelp('enable Valgrind support (%(choices)s)'))
|
|
coregrp.add_argument('--vm-exec-stop', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help='enable VM execution stopping (%(choices)s)')
|
|
|
|
maingrp = parser.add_argument_group('jerry-main options')
|
|
maingrp.add_argument('--link-map', metavar='X', choices=['ON', 'OFF'], type=str.upper,
|
|
help=devhelp('enable the generation of link map for jerry command line tool (%(choices)s)'))
|
|
|
|
arguments = parser.parse_args(args)
|
|
if arguments.devhelp:
|
|
parser.print_help()
|
|
sys.exit(0)
|
|
|
|
return arguments
|
|
|
|
def generate_build_options(arguments):
|
|
build_options = []
|
|
|
|
def build_options_append(cmakeopt, cliarg):
|
|
if cliarg:
|
|
build_options.append('-D%s=%s' % (cmakeopt, cliarg))
|
|
|
|
# general build options
|
|
build_options_append('CMAKE_BUILD_TYPE', arguments.build_type)
|
|
build_options_append('EXTERNAL_COMPILE_FLAGS', ' '.join(arguments.compile_flag))
|
|
build_options_append('EXTERNAL_LINK_LIBS', ' '.join(arguments.link_lib))
|
|
build_options_append('EXTERNAL_LINKER_FLAGS', ' '.join(arguments.linker_flag))
|
|
build_options_append('ENABLE_LTO', arguments.lto)
|
|
build_options_append('BUILD_SHARED_LIBS', arguments.shared_libs)
|
|
build_options_append('ENABLE_STRIP', arguments.strip)
|
|
build_options_append('CMAKE_TOOLCHAIN_FILE', arguments.toolchain)
|
|
build_options_append('CMAKE_VERBOSE_MAKEFILE', arguments.verbose)
|
|
|
|
# optional components
|
|
build_options_append('DOCTESTS', arguments.doctests)
|
|
build_options_append('JERRY_CMDLINE', arguments.jerry_cmdline)
|
|
build_options_append('JERRY_CMDLINE_SNAPSHOT', arguments.jerry_cmdline_snapshot)
|
|
build_options_append('JERRY_CMDLINE_TEST', arguments.jerry_cmdline_test)
|
|
build_options_append('JERRY_EXT', arguments.jerry_ext)
|
|
build_options_append('JERRY_LIBC', arguments.jerry_libc)
|
|
build_options_append('JERRY_LIBM', arguments.jerry_libm)
|
|
build_options_append('JERRY_PORT_DEFAULT', arguments.jerry_port_default)
|
|
build_options_append('UNITTESTS', arguments.unittests)
|
|
|
|
# jerry-core options
|
|
build_options_append('ENABLE_ALL_IN_ONE', arguments.all_in_one)
|
|
build_options_append('FEATURE_CPOINTER_32_BIT', arguments.cpointer_32bit)
|
|
build_options_append('FEATURE_ERROR_MESSAGES', arguments.error_messages)
|
|
build_options_append('FEATURE_EXTERNAL_CONTEXT', arguments.external_context)
|
|
build_options_append('FEATURE_DEBUGGER', arguments.jerry_debugger)
|
|
build_options_append('FEATURE_JS_PARSER', arguments.js_parser)
|
|
build_options_append('FEATURE_LINE_INFO', arguments.line_info)
|
|
build_options_append('MEM_HEAP_SIZE_KB', arguments.mem_heap)
|
|
build_options_append('FEATURE_MEM_STATS', arguments.mem_stats)
|
|
build_options_append('FEATURE_MEM_STRESS_TEST', arguments.mem_stress_test)
|
|
build_options_append('FEATURE_PROFILE', arguments.profile)
|
|
build_options_append('FEATURE_REGEXP_STRICT_MODE', arguments.regexp_strict_mode)
|
|
build_options_append('FEATURE_PARSER_DUMP', arguments.show_opcodes)
|
|
build_options_append('FEATURE_REGEXP_DUMP', arguments.show_regexp_opcodes)
|
|
build_options_append('FEATURE_SNAPSHOT_EXEC', arguments.snapshot_exec)
|
|
build_options_append('FEATURE_SNAPSHOT_SAVE', arguments.snapshot_save)
|
|
build_options_append('FEATURE_SYSTEM_ALLOCATOR', arguments.system_allocator)
|
|
build_options_append('FEATURE_VALGRIND', arguments.valgrind)
|
|
build_options_append('FEATURE_VM_EXEC_STOP', arguments.vm_exec_stop)
|
|
|
|
# jerry-main options
|
|
build_options_append('ENABLE_LINK_MAP', arguments.link_map)
|
|
|
|
# general build options (final step)
|
|
if arguments.cmake_param:
|
|
build_options.extend(arguments.cmake_param)
|
|
|
|
return build_options
|
|
|
|
def configure_output_dir(arguments):
|
|
if not os.path.isabs(arguments.builddir):
|
|
arguments.builddir = os.path.join(settings.PROJECT_DIR, arguments.builddir)
|
|
|
|
if arguments.clean and os.path.exists(arguments.builddir):
|
|
shutil.rmtree(arguments.builddir)
|
|
|
|
if not os.path.exists(arguments.builddir):
|
|
os.makedirs(arguments.builddir)
|
|
|
|
def configure_jerry(arguments):
|
|
configure_output_dir(arguments)
|
|
|
|
build_options = generate_build_options(arguments)
|
|
|
|
cmake_cmd = ['cmake', '-B' + arguments.builddir, '-H' + settings.PROJECT_DIR]
|
|
|
|
if arguments.install:
|
|
cmake_cmd.append('-DCMAKE_INSTALL_PREFIX=%s' % arguments.install)
|
|
|
|
cmake_cmd.extend(build_options)
|
|
|
|
return subprocess.call(cmake_cmd)
|
|
|
|
def make_jerry(arguments, target=None):
|
|
make_cmd = ['make', '--no-print-directory', '-j', str(arguments.jobs), '-C', arguments.builddir]
|
|
|
|
if target:
|
|
make_cmd.append(target)
|
|
|
|
return subprocess.call(make_cmd)
|
|
|
|
def print_result(ret):
|
|
print('=' * 30)
|
|
if ret:
|
|
print('Build failed with exit code: %s' % (ret))
|
|
else:
|
|
print('Build succeeded!')
|
|
print('=' * 30)
|
|
|
|
def main():
|
|
arguments = get_arguments()
|
|
|
|
ret = configure_jerry(arguments)
|
|
|
|
if not ret:
|
|
ret = make_jerry(arguments)
|
|
|
|
if not ret and arguments.install is not None:
|
|
ret = make_jerry(arguments, 'install')
|
|
|
|
print_result(ret)
|
|
sys.exit(ret)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|