## -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-

# python lib modules

import sys

import shutil

import types

import optparse

import os.path

# WAF modules

import pproc as subprocess

import Options

import Logs

import TaskGen

import ccroot

ccroot.USE_TOP_LEVEL = True

import Task

import Constants

import Utils

import Build

import Configure

import cflags # override the build profiles from waf

cflags.profiles = {

	# profile name: [optimization_level, warnings_level, debug_level]

	'debug':     [0, 2, 3],

	'optimized': [3, 2, 1],

	}

cflags.default_profile = 'debug'

# local modules

import wutils

import regression

Configure.autoconfig = 1

# the following two variables are used by the target "waf dist"

VERSION = file("VERSION", "rt").read().strip()

APPNAME = 'ns'

wutils.VERSION = VERSION

wutils.APPNAME = APPNAME

#

# The last part of the path name to use to find the regression traces.  The

# path will be APPNAME + '-' + VERSION + REGRESSION_SUFFIX, e.g.,

# ns-3-dev-ref-traces

#

REGRESSION_SUFFIX = "-ref-traces"

# these variables are mandatory ('/' are converted automatically)

srcdir = '.'

blddir = 'build'

def dist_hook():

    import tarfile

    shutil.rmtree("doc/html", True)

    shutil.rmtree("doc/latex", True)

    shutil.rmtree("nsc", True)

    ## build the name of the traces subdirectory.  Will be something like

    ## ns-3-dev-ref-traces

    traces_name = APPNAME + '-' + VERSION + regression.REGRESSION_SUFFIX

    ## Create a tar.bz2 file with the traces

    traces_dir = os.path.join(regression.REGRESSION_DIR, traces_name)

    if not os.path.isdir(traces_dir):

        Logs.warn("Not creating traces archive: the %s directory does not exist" % traces_dir)

    else:

        traceball = traces_name + wutils.TRACEBALL_SUFFIX

        tar = tarfile.open(os.path.join("..", traceball), 'w:bz2')

        tar.add(traces_dir)

        tar.close()

        ## Now remove it; we do not ship the traces with the main tarball...

        shutil.rmtree(traces_dir, True)

def set_options(opt):

    # options provided by the modules

    opt.tool_options('compiler_cxx')

    opt.tool_options('cflags')

    opt.add_option('--cwd',

                   help=('Set the working directory for a program.'),

                   action="store", type="string", default=None,

                   dest='cwd_launch')

    opt.add_option('--enable-gcov',

                   help=('Enable code coverage analysis.'

                         ' WARNING: this option only has effect '

                         'with the configure command.'),

                   action="store_true", default=False,

                   dest='enable_gcov')

    opt.add_option('--no-task-lines',

                   help=("Don't print task lines, i.e. messages saying which tasks are being executed by WAF."

                         "  Coupled with a single -v will cause WAF to output only the executed commands,"

                         " just like 'make' does by default."),

                   action="store_true", default=False,

                   dest='no_task_lines')

    opt.add_option('--lcov-report',

                   help=('Generate a code coverage report '

                         '(use this option at build time, not in configure)'),

                   action="store_true", default=False,

                   dest='lcov_report')

    opt.add_option('--doxygen',

                   help=('Run doxygen to generate html documentation from source comments'),

                   action="store_true", default=False,

                   dest='doxygen')

    opt.add_option('--run',

                   help=('Run a locally built program; argument can be a program name,'

                         ' or a command starting with the program name.'),

                   type="string", default='', dest='run')

    opt.add_option('--command-template',

                   help=('Template of the command used to run the program given by --run;'

                         ' It should be a shell command string containing %s inside,'

                         ' which will be replaced by the actual program.'),

                   type="string", default=None, dest='command_template')

    opt.add_option('--pyrun',

                   help=('Run a python program using locally built ns3 python module;'

                         ' argument is the path to the python program, optionally followed'

                         ' by command-line options that are passed to the program.'),

                   type="string", default='', dest='pyrun')

    opt.add_option('--valgrind',

                   help=('Change the default command template to run programs and unit tests with valgrind'),

                   action="store_true", default=False,

                   dest='valgrind')

    opt.add_option('--shell',

                   help=('Run a shell with an environment suitably modified to run locally built programs'),

                   action="store_true", default=False,

                   dest='shell')

    opt.add_option('--enable-sudo',

                   help=('Use sudo to setup suid bits on ns3 executables.'),

                   dest='enable_sudo', action='store_true',

                   default=False)

    opt.add_option('--regression',

                   help=("Enable regression testing; only used for the 'check' target"),

                   default=False, dest='regression', action="store_true")

    opt.add_option('--regression-generate',

                   help=("Generate new regression test traces."),

                   default=False, dest='regression_generate', action="store_true")

    opt.add_option('--regression-tests',

                   help=('For regression testing, only run/generate the indicated regression tests, '

                         'specified as a comma separated list of test names'),

                   dest='regression_tests', type="string")

    opt.add_option('--with-regression-traces',

                   help=('Path to the regression reference traces directory'),

                   default=None,

                   dest='regression_traces', type="string")

    # options provided in a script in a subdirectory named "src"

    opt.sub_options('src')

    opt.sub_options('bindings/python')

    opt.sub_options('src/internet-stack')

def check_compilation_flag(conf, flag):

    """

    Checks if the C++ compiler accepts a certain compilation flag or flags

    flag: can be a string or a list of strings

    """

    env = conf.env.copy()

    env.append_value('CXXFLAGS', flag)

    try:

        retval = conf.run_c_code(code='#include <stdio.h>\nint main() { return 0; }\n',

                                 env=env, compile_filename='test.cc',

                                 compile_mode='cxx',type='program', execute=False)

    except Configure.ConfigurationError:

        ok = False

    else:

        ok = (retval == 0)

    conf.check_message_custom(flag, 'support', (ok and 'yes' or 'no'))

    return ok

def report_optional_feature(conf, name, caption, was_enabled, reason_not_enabled):

    conf.env.append_value('NS3_OPTIONAL_FEATURES', (name, caption, was_enabled, reason_not_enabled))

def configure(conf):

    # attach some extra methods

    conf.check_compilation_flag = types.MethodType(check_compilation_flag, conf)

    conf.report_optional_feature = types.MethodType(report_optional_feature, conf)

    conf.env['NS3_OPTIONAL_FEATURES'] = []

    conf.env['NS3_BUILDDIR'] = conf.blddir

    conf.check_tool('compiler_cxx')

    conf.check_tool('cflags')

    try:

        conf.check_tool('pkgconfig')

    except Configure.ConfigurationError:

        pass

    conf.check_tool('command')

    # create the second environment, set the variant and set its name

    variant_env = conf.env.copy()

    variant_name = Options.options.build_profile

    # Check for the location of regression reference traces

    if Options.options.regression_traces is not None:

        if os.path.isdir(Options.options.regression_traces):

            conf.check_message("regression traces location", '', True, ("%s (given)" % Options.options.regression_traces))

            variant_env['REGRESSION_TRACES'] = os.path.abspath(Options.options.regression_traces)

    else:

        traces = os.path.join('..', "%s-%s%s" % (APPNAME, VERSION, REGRESSION_SUFFIX))

        if os.path.isdir(traces):

            conf.check_message("regression reference traces", '', True, ("%s (guessed)" % traces))

            variant_env['REGRESSION_TRACES'] = os.path.abspath(traces)

        del traces

    if not variant_env['REGRESSION_TRACES']:

        conf.check_message("regression reference traces", '', False)

    if Options.options.enable_gcov:

        variant_name += '-gcov'

        variant_env.append_value('CCFLAGS', '-fprofile-arcs')

        variant_env.append_value('CCFLAGS', '-ftest-coverage')

        variant_env.append_value('CXXFLAGS', '-fprofile-arcs')

        variant_env.append_value('CXXFLAGS', '-ftest-coverage')

        variant_env.append_value('LINKFLAGS', '-fprofile-arcs')

    conf.env['NS3_ACTIVE_VARIANT'] = variant_name

    variant_env['NS3_ACTIVE_VARIANT'] = variant_name

    variant_env.set_variant(variant_name)

    conf.set_env_name(variant_name, variant_env)

    conf.setenv(variant_name)

    env = variant_env

    env.append_value('CXXDEFINES', 'RUN_SELF_TESTS')

    if env['COMPILER_CXX'] == 'g++' and 'CXXFLAGS' not in os.environ:

        if check_compilation_flag(conf, '-Wno-error=deprecated-declarations'):

            env.append_value('CXXFLAGS', '-Wno-error=deprecated-declarations')

    if Options.options.build_profile == 'debug':

        env.append_value('CXXDEFINES', 'NS3_ASSERT_ENABLE')

        env.append_value('CXXDEFINES', 'NS3_LOG_ENABLE')

    if sys.platform == 'win32':

        if env['COMPILER_CXX'] == 'g++':

            env.append_value("LINKFLAGS", "-Wl,--enable-runtime-pseudo-reloc")

    conf.sub_config('src')

    conf.sub_config('utils')

    conf.sub_config('bindings/python')

    if Options.options.enable_modules:

        conf.env['NS3_ENABLED_MODULES'] = ['ns3-'+mod for mod in

                                           Options.options.enable_modules.split(',')]

    # we cannot run regression tests without diff

    conf.find_program('diff', var='DIFF')

    # for suid bits

    conf.find_program('sudo', var='SUDO')

    why_not_sudo = "because we like it"

    if Options.options.enable_sudo and conf.env['SUDO']:

        env['ENABLE_SUDO'] = True

    else:

        env['ENABLE_SUDO'] = False

        if Options.options.enable_sudo:

            why_not_sudo = "program sudo not found"

        else:

            why_not_sudo = "option --enable-sudo not selected"

    conf.report_optional_feature("ENABLE_SUDO", "Use sudo to set suid bit", env['ENABLE_SUDO'], why_not_sudo)

    # we cannot pull regression traces without mercurial

    conf.find_program('hg', var='MERCURIAL')

    conf.find_program('valgrind', var='VALGRIND')

    # Write a summary of optional features status

    print "---- Summary of optional NS-3 features:"

    for (name, caption, was_enabled, reason_not_enabled) in conf.env['NS3_OPTIONAL_FEATURES']:

        if was_enabled:

            status = 'enabled'

        else:

            status = 'not enabled (%s)' % reason_not_enabled

        print "%-30s: %s" % (caption, status)

class SuidBuildTask(Task.TaskBase):

    """task that makes a binary Suid

    """

    after = 'cxx_link cc_link'

    maxjobs = 1

    def __init__(self, bld, program):

        self.m_display = 'build-suid'

        self.__program = program

        self.__env = bld.env.copy ()

        super(SuidBuildTask, self).__init__()

        try:

            program_obj = wutils.find_program(self.__program.target, self.__env)

        except ValueError, ex:

            raise Utils.WafError(str(ex))

        program_node = program_obj.path.find_or_declare(ccroot.get_target_name(program_obj))

        self.filename = program_node.abspath(self.__env)

    def run(self):

        print >> sys.stderr, 'setting suid bit on executable ' + self.filename

        if subprocess.Popen(['sudo', 'chown', 'root', self.filename]).wait():

            return 1

        if subprocess.Popen(['sudo', 'chmod', 'u+s', self.filename]).wait():

            return 1

        return 0

    def runnable_status(self):

        "RUN_ME SKIP_ME or ASK_LATER"

        st = os.stat(self.filename)

        if st.st_uid == 0:

            return Constants.SKIP_ME

        else:

            return Constants.RUN_ME

def create_suid_program(bld, name):

    program = bld.new_task_gen('cxx', 'program')

    program.is_ns3_program = True

    program.module_deps = list()

    program.name = name

    program.target = name

    if bld.env['ENABLE_SUDO']:

        SuidBuildTask(bld, program)

    return program

def create_ns3_program(bld, name, dependencies=('simulator',)):

    program = bld.new_task_gen('cxx', 'program')

    program.is_ns3_program = True

    program.name = name

    program.target = program.name

    program.uselib_local = 'ns3'

    program.ns3_module_dependencies = ['ns3-'+dep for dep in dependencies]

    return program

def add_scratch_programs(bld):

    all_modules = [mod[len("ns3-"):] for mod in bld.env['NS3_MODULES']]

    for filename in os.listdir("scratch"):

        if filename.startswith('.') or filename == 'CVS':

	    continue

        if os.path.isdir(os.path.join("scratch", filename)):

            obj = bld.create_ns3_program(filename, all_modules)

            obj.path = obj.path.find_dir('scratch').find_dir(filename)

            obj.find_sources_in_dirs('.')

            obj.target = filename

            obj.name = obj.target

        elif filename.endswith(".cc"):

            name = filename[:-len(".cc")]

            obj = bld.create_ns3_program(name, all_modules)

            obj.path = obj.path.find_dir('scratch')

            obj.source = filename

            obj.target = name

            obj.name = obj.target

def build(bld):

    if Options.options.no_task_lines:

        import Runner

        def null_printout(s):

            pass

        Runner.printout = null_printout

    Options.cwd_launch = bld.path.abspath()

    bld.create_ns3_program = types.MethodType(create_ns3_program, bld)

    bld.create_suid_program = types.MethodType(create_suid_program, bld)

    # switch default variant to the one matching our debug level

    variant_name = bld.env_of_name('default')['NS3_ACTIVE_VARIANT']

    variant_env = bld.env_of_name(variant_name)

    bld.all_envs['default'] = variant_env

    if Options.options.shell:

        run_shell()

        raise SystemExit(0)

    if Options.options.doxygen:

        doxygen()

        raise SystemExit(0)

    check_shell()

    if Options.options.doxygen:

        doxygen()

        raise SystemExit(0)

    print "Entering directory `%s'" % os.path.join(bld.path.abspath(), 'build')

    # process subfolders from here

    bld.add_subdirs('src')

    bld.add_subdirs('samples utils examples')

    add_scratch_programs(bld)

    ## if --enabled-modules option was given, we disable building the

    ## modules that were not enabled, and programs that depend on

    ## disabled modules.

    env = bld.env

    if Options.options.enable_modules:

        Logs.warn("the option --enable-modules is being applied to this build only;"

                       " to make it permanent it needs to be given to waf configure.")

        env['NS3_ENABLED_MODULES'] = ['ns3-'+mod for mod in

                                      Options.options.enable_modules.split(',')]

    if env['NS3_ENABLED_MODULES']:

        modules = env['NS3_ENABLED_MODULES']

        changed = True

        while changed:

            changed = False

            for module in modules:

                module_obj = Object.name_to_obj(module)

                if module_obj is None:

                    raise ValueError("module %s not found" % module)

                for dep in module_obj.add_objects:

                    if not dep.startswith('ns3-'):

                        continue

                    if dep not in modules:

                        modules.append(dep)

                        changed = True

        ## remove objects that depend on modules not listed

        for obj in list(Build.bld.all_task_gen):

            if hasattr(obj, 'ns3_module_dependencies'):

                for dep in obj.ns3_module_dependencies:

                    if dep not in modules:

                        Build.bld.all_task_gen.remove(obj)

                        break

            if obj.name in env['NS3_MODULES'] and obj.name not in modules:

                Build.bld.all_task_gen.remove(obj)

    ## Create a single ns3 library containing all enabled modules

    lib = bld.new_task_gen('cxx', 'shlib')

    lib.name = 'ns3'

    lib.target = 'ns3'

    if env['NS3_ENABLED_MODULES']:

        lib.add_objects = list(modules)

        env['NS3_ENABLED_MODULES'] = list(modules)

        lib.uselib_local = list(modules)

    else:

        lib.add_objects = list(env['NS3_MODULES'])

        lib.uselib_local = list(env['NS3_MODULES'])

    bld.add_subdirs('bindings/python')

    if Options.options.run:

        # Check that the requested program name is valid

        program_name, dummy_program_argv = wutils.get_run_program(Options.options.run, wutils.get_command_template(env))

        # When --run'ing a program, tell WAF to only build that program,

        # nothing more; this greatly speeds up compilation when all you

        # want to do is run a test program.

        if not Options.options.compile_targets:

            Options.options.compile_targets = os.path.basename(program_name)

    if Options.options.regression or Options.options.regression_generate:

        if not env['DIFF']:

            raise Utils.WafError("Cannot run regression tests: the 'diff' program is not installed.")

        regression_traces = env['REGRESSION_TRACES']

        if not regression_traces:

            raise Utils.WafError("Cannot run regression tests: reference traces directory not given"

                                 " (--with-regression-traces configure option)")

        regression.run_regression(bld, regression_traces)

def shutdown():

    env = Build.bld.env

    if Options.commands['check']:

        _run_waf_check()

    if Options.options.lcov_report:

        lcov_report()

    if Options.options.run:

        wutils.run_program(Options.options.run, wutils.get_command_template(env))