wscript

#!/usr/bin/env python
# encoding: utf-8

import os

APPNAME = 'libcsp'
VERSION = '2.1'

valid_os = ['posix', 'freertos']

def options(ctx):
    # Load compiler
    ctx.load('compiler_c')

    ctx.add_option('--toolchain', default=None, help='Set toolchain prefix')

    # Set libcsp options
    gr = ctx.add_option_group('libcsp options')
    gr.add_option('--includes', default='', help='Add additional include paths, separate with comma')

    gr.add_option('--enable-reproducible-builds', action='store_true', help='Enable reproducible builds')

    gr.add_option('--disable-output', action='store_true', help='Disable CSP output')
    gr.add_option('--disable-print-stdio', action='store_true', help='Disable vprintf for csp_print_func')
    gr.add_option('--disable-stlib', action='store_true', help='Build objects only')
    gr.add_option('--disable-buffer-zero-clear', action='store_false', help='Zero out the packet buffer upon allocation')
    gr.add_option('--enable-shlib', action='store_true', help='Build shared library')
    gr.add_option('--enable-rdp', action='store_true', help='Enable RDP support')
    gr.add_option('--enable-promisc', action='store_true', help='Enable promiscuous support')
    gr.add_option('--enable-crc32', action='store_true', help='Enable CRC32 support')
    gr.add_option('--enable-hmac', action='store_true', help='Enable HMAC-SHA1 support')
    gr.add_option('--enable-rtable', action='store_true', help='Allows to setup a list of static routes')
    gr.add_option('--enable-python3-bindings', action='store_true', help='Enable Python3 bindings')
    gr.add_option('--enable-examples', action='store_true', help='Enable examples')
    gr.add_option('--enable-dedup', action='store_true', help='Enable packet deduplicator')
    gr.add_option('--enable-yaml', action='store_true', help='Enable YAML configurator')
    gr.add_option('--with-rdp-max-window', type=int, default=5, help='Set maximum window size for RDP')
    gr.add_option('--with-max-bind-port', type=int, default=16, help='Set maximum bindable port')
    gr.add_option('--with-max-connections', type=int, default=8, help='Set maximum number of connections')
    gr.add_option('--with-conn-queue-length', type=int, default=15, help='Set max connection queue length')
    gr.add_option('--with-router-queue-length', type=int, default=15, help='Set max router queue length')
    gr.add_option('--with-buffer-size', type=int, default=256, help='Set size of csp buffers')
    gr.add_option('--with-buffer-count', type=int, default=15, help='Set number of csp buffers')
    gr.add_option('--with-rtable-size', type=int, default=10, help='Set max number of entries in route table')

    # Drivers and interfaces (requires external dependencies)
    gr.add_option('--enable-if-zmqhub', action='store_true', help='Enable ZMQ interface')
    gr.add_option('--enable-can-socketcan', action='store_true', help='Enable Linux socketcan driver')
    gr.add_option('--with-driver-usart', default=None, metavar='DRIVER', help='Build USART driver. [linux, None]')

    # OS
    gr.add_option('--with-os', metavar='OS', default='posix', help='Set operating system. Must be one of: ' + str(valid_os))

    # Fixup
    gr.add_option('--fixup-v1-zmq-little-endian', action='store_true', help='Use little-endian CSP ID for ZMQ with CSPv1')

def configure(ctx):
    # Validate options
    if ctx.options.with_os not in valid_os:
        ctx.fatal('--with-os must be either: ' + str(valid_os))

    # Setup and validate toolchain
    if (len(ctx.stack_path) <= 1) and ctx.options.toolchain:
        ctx.env.CC = ctx.options.toolchain + 'gcc'
        ctx.env.AR = ctx.options.toolchain + 'ar'

    ctx.load('compiler_c python')

    # Set git revision define
    git_rev = os.popen('git describe --long --always 2> /dev/null || echo unknown').read().strip()
    ctx.define('GIT_REV', git_rev)

    # Set build output format
    ctx.env.FEATURES = ['c']
    if not ctx.options.disable_stlib:
        ctx.env.FEATURES += ['cstlib']

    ctx.env.LIBCSP_SHLIB = ctx.options.enable_shlib

    # Setup CFLAGS
    if (len(ctx.stack_path) <= 1) and (len(ctx.env.CFLAGS) == 0):
        ctx.env.prepend_value('CFLAGS', ["-std=gnu11", "-g", "-Os", "-Wall", "-Wextra", "-Wshadow", "-Wcast-align",
                                         "-Wpointer-arith", "-Wpedantic",
                                         "-Wwrite-strings", "-Wno-unused-parameter", "-Werror"])
        if ctx.env.CC_NAME == 'clang':
            ctx.env.append_value('CFLAGS', ["-Wno-gnu-zero-variadic-macro-arguments"])

    # Setup default include path and any extra defined
    ctx.env.append_unique('INCLUDES_CSP', ['include', 'src'] + ctx.options.includes.split(','))

    # Platform/OS specifics
    if ctx.options.with_os == 'posix':
        ctx.env.append_unique('LIBS', ['rt', 'pthread', 'util'])

    ctx.define_cond('CSP_FREERTOS', ctx.options.with_os == 'freertos')
    ctx.define_cond('CSP_POSIX', ctx.options.with_os == 'posix')


    # Add files
    ctx.env.append_unique('FILES_CSP', ['src/crypto/csp_hmac.c',
                                        'src/crypto/csp_sha1.c',
                                        'src/csp_buffer.c',
                                        'src/csp_bridge.c',
                                        'src/csp_conn.c',
                                        'src/csp_crc32.c',
                                        'src/csp_debug.c',
                                        'src/csp_dedup.c',
                                        'src/csp_iflist.c',
                                        'src/csp_init.c',
                                        'src/csp_io.c',
                                        'src/csp_port.c',
                                        'src/csp_qfifo.c',
                                        'src/csp_route.c',
                                        'src/csp_service_handler.c',
                                        'src/csp_services.c',
                                        'src/csp_id.c',
                                        'src/csp_sfp.c',
                                        'src/interfaces/csp_if_lo.c',
                                        'src/interfaces/csp_if_can.c',
                                        'src/interfaces/csp_if_can_pbuf.c',
                                        'src/interfaces/csp_if_kiss.c',
                                        'src/interfaces/csp_if_i2c.c',
                                        'src/interfaces/csp_if_tun.c',
                                        'src/arch/{0}/**/*.c'.format(ctx.options.with_os),
                                        ])

    # Add if rtable
    if ctx.options.enable_rtable:
        ctx.env.append_unique('FILES_CSP', ['src/csp_rtable_cidr.c'])
        # Add if stdio
        if ctx.check(header_name="stdio.h", mandatory=False):
            ctx.define('CSP_HAVE_STDIO', True)
            ctx.env.append_unique('FILES_CSP', ['src/csp_rtable_stdio.c'])

    # Add if UDP
    if ctx.check(header_name="sys/socket.h", mandatory=False) and ctx.check(header_name="arpa/inet.h", mandatory=False):
        ctx.env.append_unique('FILES_CSP', ['src/interfaces/csp_if_udp.c'])

    if not ctx.options.disable_output:
        ctx.env.append_unique('FILES_CSP', ['src/csp_hex_dump.c'])

    if ctx.options.enable_promisc:
        ctx.env.append_unique('FILES_CSP', ['src/csp_promisc.c'])

    if ctx.options.enable_rdp:
        ctx.env.append_unique('FILES_CSP', ['src/csp_rdp.c',
                                            'src/csp_rdp_queue.c'])

    # Add YAML
    if ctx.options.enable_yaml:
        ctx.check_cfg(package='yaml-0.1', args='--cflags --libs', define_name='CSP_HAVE_LIBYAML')
        ctx.env.append_unique('LIBS', ctx.env.LIB_LIBYAML)
        ctx.env.append_unique('FILES_CSP', 'src/csp_yaml.c')

    # Add socketcan
    if ctx.options.enable_can_socketcan:
        ctx.env.append_unique('FILES_CSP', 'src/drivers/can/can_socketcan.c')
        ctx.check_cfg(package='libsocketcan', args='--cflags --libs', define_name='CSP_HAVE_LIBSOCKETCAN')
        ctx.env.append_unique('LIBS', ctx.env.LIB_LIBSOCKETCAN)

    # Add USART driver
    if ctx.options.with_driver_usart:
        ctx.env.append_unique('FILES_CSP', ['src/drivers/usart/usart_kiss.c',
                                            'src/drivers/usart/usart_{0}.c'.format(ctx.options.with_driver_usart)])

    # Add ZMQ
    if ctx.options.enable_if_zmqhub:
        ctx.check_cfg(package='libzmq', args='--cflags --libs', define_name='CSP_HAVE_LIBZMQ')
        ctx.env.append_unique('LIBS', ctx.env.LIB_LIBZMQ)
        ctx.env.append_unique('FILES_CSP', 'src/interfaces/csp_if_zmqhub.c')

    # Store configuration options
    ctx.env.ENABLE_EXAMPLES = ctx.options.enable_examples

    # Add Python bindings
    if ctx.options.enable_python3_bindings:
        ctx.check_python_version((3,5))
        ctx.check_python_headers(features='pyext')

    # Set defines for customizable parameters
    ctx.define('CSP_QFIFO_LEN', ctx.options.with_router_queue_length)
    ctx.define('CSP_PORT_MAX_BIND', ctx.options.with_max_bind_port)
    ctx.define('CSP_CONN_RXQUEUE_LEN', ctx.options.with_conn_queue_length)
    ctx.define('CSP_CONN_MAX', ctx.options.with_max_connections)
    ctx.define('CSP_BUFFER_SIZE', ctx.options.with_buffer_size)
    ctx.define('CSP_BUFFER_COUNT', ctx.options.with_buffer_count)
    ctx.define('CSP_RDP_MAX_WINDOW', ctx.options.with_rdp_max_window)
    ctx.define('CSP_RTABLE_SIZE', ctx.options.with_rtable_size)

    # Set defines for enabling features
    ctx.define('CSP_REPRODUCIBLE_BUILDS', ctx.options.enable_reproducible_builds)
    ctx.define('CSP_ENABLE_CSP_PRINT', not ctx.options.disable_output)
    ctx.define('CSP_PRINT_STDIO', not ctx.options.disable_print_stdio)
    ctx.define('CSP_USE_RDP', ctx.options.enable_rdp)
    ctx.define('CSP_USE_HMAC', ctx.options.enable_hmac)
    ctx.define('CSP_USE_PROMISC', ctx.options.enable_promisc)
    ctx.define('CSP_USE_RTABLE', ctx.options.enable_rtable)
    ctx.define('CSP_BUFFER_ZERO_CLEAR', ctx.options.disable_buffer_zero_clear)

    ctx.define('CSP_FIXUP_V1_ZMQ_LITTLE_ENDIAN', ctx.options.fixup_v1_zmq_little_endian)

    ctx.write_config_header('include/csp/autoconfig.h')

def build(ctx):

    # Set install path for header files
    install_path = None
    if ctx.is_install:
        install_path = '${PREFIX}/lib'
        ctx.install_files('${PREFIX}/include/csp',
                          ctx.path.ant_glob('include/csp/**/*.h'),
                          cwd=ctx.path.find_dir('include/csp'),
                          relative_trick=True)
        ctx.install_files('${PREFIX}/include/csp', 'include/csp/autoconfig.h', cwd=ctx.bldnode)

    ctx(export_includes=ctx.env.INCLUDES_CSP, name='csp_h')

    ctx(features=ctx.env.FEATURES,
        source=ctx.path.ant_glob(ctx.env.FILES_CSP),
        target='csp',
        use=['csp_h', 'freertos_h', 'util'],
        install_path=install_path)

    # Build shared library
    if ctx.env.LIBCSP_SHLIB or ctx.env.HAVE_PYEXT:
        ctx.shlib(source=ctx.path.ant_glob(ctx.env.FILES_CSP),
                  name='csp_shlib',
                  target='csp',
                  use=['csp_h', 'util_shlib'],
                  lib=ctx.env.LIBS)

    # Build Python bindings
    if ctx.env.HAVE_PYEXT:
        ctx.shlib(source=ctx.path.ant_glob('src/bindings/python/**/*.c'),
                  target='libcsp_py3',
                  features='pyext',
                  use=['csp_shlib'],
                  pytest_path=[ctx.path.get_bld()])

    if ctx.env.ENABLE_EXAMPLES:
        ctx.objects(source='examples/csp_posix_helper.c',
                  target='csp_posix_helper',
                  use='csp_h')

        ctx.program(source='examples/csp_server_client.c',
                    target='examples/csp_server_client',
                    lib=ctx.env.LIBS,
                    use=['csp', 'csp_posix_helper'])

        ctx.program(source='examples/csp_server.c',
                    target='examples/csp_server',
                    lib=ctx.env.LIBS,
                    use=['csp', 'csp_posix_helper'])

        ctx.program(source='examples/csp_client.c',
                    target='examples/csp_client',
                    lib=ctx.env.LIBS,
                    use=['csp', 'csp_posix_helper'])

        ctx.program(source=['examples/csp_bridge_can2udp.c'],
                    target='examples/csp_bridge_can2udp',
                    lib=ctx.env.LIBS,
                    use='csp')

        ctx.program(source='examples/csp_arch.c',
                    target='examples/csp_arch',
                    lib=ctx.env.LIBS,
                    use='csp')

        if ctx.env.CSP_HAVE_LIBZMQ:
            ctx.program(source='examples/zmqproxy.c',
                        target='examples/zmqproxy',
                        lib=ctx.env.LIBS,
                        use='csp')


def dist(ctx):
    ctx.excl = 'build/* **/.* **/*.pyc **/*.o **/*~ *.tar.gz'