mbed-os/tools/build.py

#! /usr/bin/env python2
"""
mbed SDK
Copyright (c) 2011-2013 ARM Limited

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.

LIBRARIES BUILD
"""
import sys
from time import time
from os.path import join, abspath, dirname


# Be sure that the tools directory is in the search path
ROOT = abspath(join(dirname(__file__), ".."))
sys.path.insert(0, ROOT)


from tools.toolchains import TOOLCHAINS
from tools.targets import TARGET_NAMES, TARGET_MAP
from tools.options import get_default_options_parser
from tools.build_api import build_library, build_mbed_libs, build_lib
from tools.build_api import mcu_toolchain_matrix
from tools.build_api import static_analysis_scan, static_analysis_scan_lib, static_analysis_scan_library
from tools.build_api import print_build_results
from tools.settings import CPPCHECK_CMD, CPPCHECK_MSG_FORMAT
from utils import argparse_filestring_type

if __name__ == '__main__':
    start = time()

    # Parse Options
    parser = get_default_options_parser()

    parser.add_argument("--source", dest="source_dir", type=argparse_filestring_type,
                        default=None, help="The source (input) directory", nargs="*")

    parser.add_argument("--build", dest="build_dir", type=argparse_filestring_type,
                      default=None, help="The build (output) directory")

    parser.add_argument("--no-archive", dest="no_archive", action="store_true",
                      default=False, help="Do not produce archive (.ar) file, but rather .o")

    # Extra libraries
    parser.add_argument("-r", "--rtos",
                      action="store_true",
                      dest="rtos",
                      default=False,
                      help="Compile the rtos")

    parser.add_argument("--rpc",
                      action="store_true",
                      dest="rpc",
                      default=False,
                      help="Compile the rpc library")

    parser.add_argument("-e", "--eth",
                      action="store_true", dest="eth",
                      default=False,
                      help="Compile the ethernet library")

    parser.add_argument("-U", "--usb_host",
                      action="store_true",
                      dest="usb_host",
                      default=False,
                      help="Compile the USB Host library")

    parser.add_argument("-u", "--usb",
                      action="store_true",
                      dest="usb",
                      default=False,
                      help="Compile the USB Device library")

    parser.add_argument("-d", "--dsp",
                      action="store_true",
                      dest="dsp",
                      default=False,
                      help="Compile the DSP library")

    parser.add_argument("-F", "--fat",
                      action="store_true",
                      dest="fat",
                      default=False,
                      help="Compile FS and SD card file system library")

    parser.add_argument("-b", "--ublox",
                      action="store_true",
                      dest="ublox",
                      default=False,
                      help="Compile the u-blox library")

    parser.add_argument( "--cpputest",
                      action="store_true",
                      dest="cpputest_lib",
                      default=False,
                      help="Compiles 'cpputest' unit test library (library should be on the same directory level as mbed repository)")

    parser.add_argument("-D",
                      nargs="*",
                      dest="macros",
                      help="Add a macro definition")

    parser.add_argument("-S", "--supported-toolchains",
                      action="store_true",
                      dest="supported_toolchains",
                      default=False,
                      help="Displays supported matrix of MCUs and toolchains")

    parser.add_argument('-f', '--filter',
                      dest='general_filter_regex',
                      default=None,
                      help='For some commands you can use filter to filter out results')

    parser.add_argument("--cppcheck",
                      action="store_true",
                      dest="cppcheck_validation",
                      default=False,
                      help="Forces 'cppcheck' static code analysis")

    parser.add_argument("-j", "--jobs", type=int, dest="jobs",
                      default=0, help="Number of concurrent jobs. Default: 0/auto (based on host machine's number of CPUs)")
    parser.add_argument("-N", "--artifact-name", dest="artifact_name",
                      default=None, help="The built project's name")

    parser.add_argument("-v", "--verbose",
                      action="store_true",
                      dest="verbose",
                      default=False,
                      help="Verbose diagnostic output")

    parser.add_argument("--silent",
                      action="store_true",
                      dest="silent",
                      default=False,
                      help="Silent diagnostic output (no copy, compile notification)")

    parser.add_argument("-x", "--extra-verbose-notifications",
                      action="store_true",
                      dest="extra_verbose_notify",
                      default=False,
                      help="Makes compiler more verbose, CI friendly.")

    options = parser.parse_args()

    # Only prints matrix of supported toolchains
    if options.supported_toolchains:
        print mcu_toolchain_matrix(platform_filter=options.general_filter_regex)
        exit(0)

    # Get target list
    targets = options.mcu if options.mcu else TARGET_NAMES

    # Get toolchains list
    toolchains = options.tool if options.tool else TOOLCHAINS

    # Get libraries list
    libraries = []

    # Additional Libraries
    if options.rtos:
        libraries.extend(["rtx", "rtos"])
    if options.rpc:
        libraries.extend(["rpc"])
    if options.eth:
        libraries.append("eth")
    if options.usb:
        libraries.append("usb")
    if options.usb_host:
        libraries.append("usb_host")
    if options.dsp:
        libraries.extend(["dsp"])
    if options.fat:
        libraries.extend(["fat"])
    if options.ublox:
        libraries.extend(["rtx", "rtos", "usb_host", "ublox"])
    if options.cpputest_lib:
        libraries.extend(["cpputest"])

    # Build results
    failures = []
    successes = []
    skipped = []

    # CPPCHECK code validation
    if options.cppcheck_validation:
        for toolchain in toolchains:
            for target in targets:
                try:
                    mcu = TARGET_MAP[target]
                    # CMSIS and MBED libs analysis
                    static_analysis_scan(mcu, toolchain, CPPCHECK_CMD, CPPCHECK_MSG_FORMAT, verbose=options.verbose, jobs=options.jobs)
                    for lib_id in libraries:
                        # Static check for library
                        static_analysis_scan_lib(lib_id, mcu, toolchain, CPPCHECK_CMD, CPPCHECK_MSG_FORMAT,
                                  options=options.options,
                                  extra_verbose=options.extra_verbose_notify, verbose=options.verbose, jobs=options.jobs, clean=options.clean,
                                  macros=options.macros)
                        pass
                except Exception, e:
                    if options.verbose:
                        import traceback
                        traceback.print_exc(file=sys.stdout)
                        sys.exit(1)
                    print e
    else:
        # Build
        for toolchain in toolchains:
            for target in targets:
                tt_id = "%s::%s" % (toolchain, target)
                try:
                    mcu = TARGET_MAP[target]
                    if options.source_dir:
                        lib_build_res = build_library(options.source_dir, options.build_dir, mcu, toolchain,
                                                    options=options.options,
                                                    extra_verbose=options.extra_verbose_notify,
                                                    verbose=options.verbose,
                                                    silent=options.silent,
                                                    jobs=options.jobs,
                                                    clean=options.clean,
                                                    archive=(not options.no_archive),
                                                    macros=options.macros,
                                                    name=options.artifact_name)
                    else:
                        lib_build_res = build_mbed_libs(mcu, toolchain,
                                                    options=options.options,
                                                    extra_verbose=options.extra_verbose_notify,
                                                    verbose=options.verbose,
                                                    silent=options.silent,
                                                    jobs=options.jobs,
                                                    clean=options.clean,
                                                    macros=options.macros)

                    for lib_id in libraries:
                        build_lib(lib_id, mcu, toolchain,
                                  options=options.options,
                                  extra_verbose=options.extra_verbose_notify,
                                  verbose=options.verbose,
                                  silent=options.silent,
                                  clean=options.clean,
                                  macros=options.macros,
                                  jobs=options.jobs)
                    if lib_build_res:
                        successes.append(tt_id)
                    else:
                        skipped.append(tt_id)
                except Exception, e:
                    if options.verbose:
                        import traceback
                        traceback.print_exc(file=sys.stdout)
                        sys.exit(1)
                    failures.append(tt_id)
                    print e

    # Write summary of the builds
    print
    print "Completed in: (%.2f)s" % (time() - start)
    print

    for report, report_name in [(successes, "Build successes:"),
                                (skipped, "Build skipped:"),
                                (failures, "Build failures:"),
                               ]:
        if report:
            print print_build_results(report, report_name),

    if failures:
        sys.exit(1)