SConscript

   1 # -*- mode:python -*-
   2
   3 # Copyright (c) 2004-2005 The Regents of The University of Michigan
   4 # All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions are
   8 # met: redistributions of source code must retain the above copyright
   9 # notice, this list of conditions and the following disclaimer;
  10 # redistributions in binary form must reproduce the above copyright
  11 # notice, this list of conditions and the following disclaimer in the
  12 # documentation and/or other materials provided with the distribution;
  13 # neither the name of the copyright holders nor the names of its
  14 # contributors may be used to endorse or promote products derived from
  15 # this software without specific prior written permission.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 import os
  30 import sys
  31 from os.path import isdir
  32
  33 # This file defines how to build a particular configuration of M5
  34 # based on variable settings in the 'env' build environment.
  35
  36 # Import build environment variable from SConstruct.
  37 Import('env')
  38
  39 ###################################################
  40 #
  41 # Define needed sources.
  42 #
  43 ###################################################
  44
  45 # Base sources used by all configurations.
  46
  47 base_sources = Split('''
  48         base/circlebuf.cc
  49         base/copyright.cc
  50         base/cprintf.cc
  51         base/embedfile.cc
  52         base/fast_alloc.cc
  53         base/fifo_buffer.cc
  54         base/hostinfo.cc
  55         base/hybrid_pred.cc
  56         base/inifile.cc
  57         base/intmath.cc
  58         base/match.cc
  59         base/misc.cc
  60         base/output.cc
  61         base/pollevent.cc
  62         base/range.cc
  63         base/random.cc
  64         base/sat_counter.cc
  65         base/socket.cc
  66         base/statistics.cc
  67         base/str.cc
  68         base/time.cc
  69         base/trace.cc
  70         base/traceflags.cc
  71         base/userinfo.cc
  72         base/compression/lzss_compression.cc
  73         base/loader/aout_object.cc
  74         base/loader/ecoff_object.cc
  75         base/loader/elf_object.cc
  76         base/loader/object_file.cc
  77         base/loader/symtab.cc
  78         base/stats/events.cc
  79         base/stats/statdb.cc
  80         base/stats/visit.cc
  81         base/stats/text.cc
  82
  83         cpu/base.cc
  84         cpu/base_dyn_inst.cc
  85         cpu/exec_context.cc
  86         cpu/exetrace.cc
  87         cpu/pc_event.cc
  88         cpu/static_inst.cc
  89         cpu/o3/2bit_local_pred.cc
  90         cpu/o3/alpha_dyn_inst.cc
  91         cpu/o3/alpha_cpu.cc
  92         cpu/o3/alpha_cpu_builder.cc
  93         cpu/o3/bpred_unit.cc
  94         cpu/o3/btb.cc
  95         cpu/o3/commit.cc
  96         cpu/o3/decode.cc
  97         cpu/o3/fetch.cc
  98         cpu/o3/free_list.cc
  99         cpu/o3/cpu.cc
 100         cpu/o3/iew.cc
 101         cpu/o3/inst_queue.cc
 102         cpu/o3/ldstq.cc
 103         cpu/o3/mem_dep_unit.cc
 104         cpu/o3/ras.cc
 105         cpu/o3/rename.cc
 106         cpu/o3/rename_map.cc
 107         cpu/o3/rob.cc
 108         cpu/o3/sat_counter.cc
 109         cpu/o3/store_set.cc
 110         cpu/o3/tournament_pred.cc
 111         cpu/fast/cpu.cc
 112         cpu/sampler/sampler.cc
 113         cpu/simple/cpu.cc
 114         cpu/trace/reader/mem_trace_reader.cc
 115         cpu/trace/reader/ibm_reader.cc
 116         cpu/trace/reader/itx_reader.cc
 117         cpu/trace/reader/m5_reader.cc
 118         cpu/trace/opt_cpu.cc
 119         cpu/trace/trace_cpu.cc
 120
 121         encumbered/cpu/full/bpred.cc
 122         encumbered/cpu/full/commit.cc
 123         encumbered/cpu/full/cpu.cc
 124         encumbered/cpu/full/create_vector.cc
 125         encumbered/cpu/full/cv_spec_state.cc
 126         encumbered/cpu/full/dd_queue.cc
 127         encumbered/cpu/full/dep_link.cc
 128         encumbered/cpu/full/dispatch.cc
 129         encumbered/cpu/full/dyn_inst.cc
 130         encumbered/cpu/full/execute.cc
 131         encumbered/cpu/full/fetch.cc
 132         encumbered/cpu/full/floss_reasons.cc
 133         encumbered/cpu/full/fu_pool.cc
 134         encumbered/cpu/full/inst_fifo.cc
 135         encumbered/cpu/full/instpipe.cc
 136         encumbered/cpu/full/issue.cc
 137         encumbered/cpu/full/ls_queue.cc
 138         encumbered/cpu/full/machine_queue.cc
 139         encumbered/cpu/full/pipetrace.cc
 140         encumbered/cpu/full/readyq.cc
 141         encumbered/cpu/full/reg_info.cc
 142         encumbered/cpu/full/rob_station.cc
 143         encumbered/cpu/full/spec_memory.cc
 144         encumbered/cpu/full/spec_state.cc
 145         encumbered/cpu/full/storebuffer.cc
 146         encumbered/cpu/full/writeback.cc
 147         encumbered/cpu/full/iq/iq_station.cc
 148         encumbered/cpu/full/iq/iqueue.cc
 149         encumbered/cpu/full/iq/segmented/chain_info.cc
 150         encumbered/cpu/full/iq/segmented/chain_wire.cc
 151         encumbered/cpu/full/iq/segmented/iq_seg.cc
 152         encumbered/cpu/full/iq/segmented/iq_segmented.cc
 153         encumbered/cpu/full/iq/segmented/seg_chain.cc
 154         encumbered/cpu/full/iq/seznec/iq_seznec.cc
 155         encumbered/cpu/full/iq/standard/iq_standard.cc
 156         encumbered/mem/functional/main.cc
 157
 158         mem/base_hier.cc
 159         mem/base_mem.cc
 160         mem/hier_params.cc
 161         mem/mem_cmd.cc
 162         mem/mem_debug.cc
 163         mem/mem_req.cc
 164         mem/memory_interface.cc
 165         mem/bus/base_interface.cc
 166         mem/bus/bus.cc
 167         mem/bus/bus_bridge.cc
 168         mem/bus/bus_bridge_master.cc
 169         mem/bus/bus_bridge_slave.cc
 170         mem/bus/bus_interface.cc
 171         mem/bus/dma_bus_interface.cc
 172         mem/bus/dma_interface.cc
 173         mem/bus/master_interface.cc
 174         mem/bus/slave_interface.cc
 175         mem/cache/base_cache.cc
 176         mem/cache/cache.cc
 177         mem/cache/cache_builder.cc
 178         mem/cache/coherence/coherence_protocol.cc
 179         mem/cache/coherence/uni_coherence.cc
 180         mem/cache/miss/blocking_buffer.cc
 181         mem/cache/miss/miss_queue.cc
 182         mem/cache/miss/mshr.cc
 183         mem/cache/miss/mshr_queue.cc
 184         mem/cache/prefetch/base_prefetcher.cc
 185         mem/cache/prefetch/prefetcher.cc
 186         mem/cache/prefetch/tagged_prefetcher.cc
 187         mem/cache/tags/base_tags.cc
 188         mem/cache/tags/cache_tags.cc
 189         mem/cache/tags/fa_lru.cc
 190         mem/cache/tags/iic.cc
 191         mem/cache/tags/lru.cc
 192         mem/cache/tags/repl/gen.cc
 193         mem/cache/tags/repl/repl.cc
 194         mem/cache/tags/split.cc
 195         mem/cache/tags/split_lru.cc
 196         mem/cache/tags/split_lifo.cc
 197         mem/functional/functional.cc
 198         mem/timing/base_memory.cc
 199         mem/timing/memory_builder.cc
 200         mem/timing/simple_mem_bank.cc
 201         mem/trace/itx_writer.cc
 202         mem/trace/mem_trace_writer.cc
 203         mem/trace/m5_writer.cc
 204
 205         python/pyconfig.cc
 206         python/embedded_py.cc
 207
 208         sim/builder.cc
 209         sim/configfile.cc
 210         sim/debug.cc
 211         sim/eventq.cc
 212         sim/main.cc
 213         sim/param.cc
 214         sim/profile.cc
 215         sim/root.cc
 216         sim/serialize.cc
 217         sim/sim_events.cc
 218         sim/sim_exit.cc
 219         sim/sim_object.cc
 220         sim/startup.cc
 221         sim/stat_context.cc
 222         sim/stat_control.cc
 223         sim/trace_context.cc
 224         ''')
 225 # These are now included by the architecture specific SConscript
 226 #       arch/alpha/decoder.cc
 227 #       arch/alpha/alpha_o3_exec.cc
 228 #       arch/alpha/fast_cpu_exec.cc
 229 #       arch/alpha/simple_cpu_exec.cc
 230 #       arch/alpha/full_cpu_exec.cc
 231 #       arch/alpha/faults.cc
 232 #       arch/alpha/isa_traits.cc
 233
 234 # MySql sources
 235 mysql_sources = Split('''
 236         base/mysql.cc
 237         base/stats/mysql.cc
 238         ''')
 239
 240 # Full-system sources
 241 full_system_sources = Split('''
 242         base/crc.cc
 243         base/inet.cc
 244         base/remote_gdb.cc
 245
 246         cpu/intr_control.cc
 247         cpu/profile.cc
 248
 249         dev/alpha_console.cc
 250         dev/baddev.cc
 251         dev/simconsole.cc
 252         dev/disk_image.cc
 253         dev/etherbus.cc
 254         dev/etherdump.cc
 255         dev/etherint.cc
 256         dev/etherlink.cc
 257         dev/etherpkt.cc
 258         dev/ethertap.cc
 259         dev/ide_ctrl.cc
 260         dev/ide_disk.cc
 261         dev/io_device.cc
 262         dev/ns_gige.cc
 263         dev/pciconfigall.cc
 264         dev/pcidev.cc
 265         dev/pcifake.cc
 266         dev/pktfifo.cc
 267         dev/platform.cc
 268         dev/sinic.cc
 269         dev/simple_disk.cc
 270         dev/tsunami.cc
 271         dev/tsunami_cchip.cc
 272         dev/isa_fake.cc
 273         dev/tsunami_io.cc
 274         dev/tsunami_pchip.cc
 275         dev/uart.cc
 276         dev/uart8250.cc
 277
 278         kern/kernel_binning.cc
 279         kern/kernel_stats.cc
 280         kern/system_events.cc
 281         kern/freebsd/freebsd_system.cc
 282         kern/linux/linux_syscalls.cc
 283         kern/linux/linux_system.cc
 284         kern/linux/printk.cc
 285         kern/tru64/dump_mbuf.cc
 286         kern/tru64/printf.cc
 287         kern/tru64/tru64_events.cc
 288         kern/tru64/tru64_syscalls.cc
 289         kern/tru64/tru64_system.cc
 290
 291         mem/functional/memory_control.cc
 292         mem/functional/physical.cc
 293
 294         sim/system.cc
 295         ''')
 296
 297 # These are now included by the architecture specific SConscript
 298 #       arch/alpha/alpha_memory.cc
 299 #       arch/alpha/arguments.cc
 300 #       arch/alpha/ev5.cc
 301 #       arch/alpha/osfpal.cc
 302 #       arch/alpha/pseudo_inst.cc
 303 #       arch/alpha/stacktrace.cc
 304 #       arch/alpha/vtophys.cc
 305
 306 # turbolaser encumbered sources
 307 turbolaser_sources = Split('''
 308         encumbered/dev/dma.cc
 309         encumbered/dev/etherdev.cc
 310         encumbered/dev/scsi.cc
 311         encumbered/dev/scsi_ctrl.cc
 312         encumbered/dev/scsi_disk.cc
 313         encumbered/dev/scsi_none.cc
 314         encumbered/dev/tlaser_clock.cc
 315         encumbered/dev/tlaser_ipi.cc
 316         encumbered/dev/tlaser_mbox.cc
 317         encumbered/dev/tlaser_mc146818.cc
 318         encumbered/dev/tlaser_node.cc
 319         encumbered/dev/tlaser_pcia.cc
 320         encumbered/dev/tlaser_pcidev.cc
 321         encumbered/dev/tlaser_serial.cc
 322         encumbered/dev/turbolaser.cc
 323         encumbered/dev/uart8530.cc
 324         ''')
 325
 326 # Syscall emulation (non-full-system) sources
 327 syscall_emulation_sources = Split('''
 328         cpu/memtest/memtest.cc
 329         encumbered/eio/eio.cc
 330         encumbered/eio/exolex.cc
 331         encumbered/eio/libexo.cc
 332         sim/process.cc
 333         sim/syscall_emul.cc
 334         ''')
 335
 336 # These are now included by the architecture specific SConscript
 337 #       arch/alpha/alpha_common_syscall_emul.cc
 338 #       arch/alpha/alpha_linux_process.cc
 339 #       arch/alpha/alpha_tru64_process.cc
 340
 341 targetarch_files = Split('''
 342         alpha_linux_process.hh
 343         alpha_memory.hh
 344         alpha_tru64_process.hh
 345         aout_machdep.h
 346         arguments.hh
 347         ecoff_machdep.h
 348         ev5.hh
 349         faults.hh
 350         isa_fullsys_traits.hh
 351         isa_traits.hh
 352         pseudo_inst.hh
 353         stacktrace.hh
 354         vptr.hh
 355         vtophys.hh
 356         ''')
 357 #        osfpal.hh
 358 #        byte_swap.hh
 359 #        alpha_common_syscall_emul.hh
 360
 361 # Set up bridging headers to the architecture specific versions
 362 for f in targetarch_files:
 363     env.Command('targetarch/' + f, 'arch/%s/%s' % (env['TARGET_ISA'], f),
 364                 '''echo '#include "arch/%s/%s"' > $TARGET''' % (env['TARGET_ISA'], f))
 365
 366 # Let the target architecture define what sources it needs
 367 arch_source = SConscript('arch/%s/SConscript' % env['TARGET_ISA'],
 368         build_dir = 'build/%s/' % env['BUILD_DIR'],
 369         exports = 'env', duplicate = False)
 370
 371 # Add a flag defining what THE_ISA should be for all compilation
 372 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
 373
 374 # Set up complete list of sources based on configuration.
 375 sources = base_sources + arch_source
 376
 377 if env['FULL_SYSTEM']:
 378     sources += full_system_sources
 379     if env['ALPHA_TLASER']:
 380         sources += turbolaser_sources
 381 else:
 382     sources += syscall_emulation_sources
 383
 384 if env['USE_MYSQL']:
 385     sources += mysql_sources
 386
 387 for opt in env.ExportOptions:
 388     env.ConfigFile(opt)
 389
 390 ###################################################
 391 #
 392 # Add an SCons scanner for ISA files
 393 #
 394 ###################################################
 395 import SCons.Scanner
 396
 397 def ISAScan():
 398    return SCons.Scanner.Classic("ISAScan",
 399                                 "$ISASUFFIXES",
 400                                 "SRCDIR",
 401                                 '^[ \t]*##[ \t]*include[ \t]*"([^>"]+)"')
 402
 403 def ISAPath(env, dir, a=None):
 404    return (Dir(env['SRCDIR']), Dir('.'))
 405
 406 iscan = Scanner(function = ISAScan().scan, skeys = [".isa", ".ISA"],
 407                 path_function = ISAPath)
 408 env.Append(SCANNERS = iscan)
 409
 410
 411 ###################################################
 412 #
 413 # Special build rules.
 414 #
 415 ###################################################
 416
 417 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
 418 # $TARGET.base will expand to "<build-dir>/base/traceflags".
 419 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
 420             'base/traceflags.py',
 421             'python $SOURCE $TARGET.base')
 422
 423 # several files are generated from arch/$TARGET_ISA/isa_desc.
 424 env.Command(Split('''
 425         arch/%s/decoder.cc
 426         arch/%s/decoder.hh
 427         arch/%s/alpha_o3_exec.cc
 428         arch/%s/fast_cpu_exec.cc
 429         arch/%s/simple_cpu_exec.cc
 430         arch/%s/full_cpu_exec.cc''' %
 431         (env['TARGET_ISA'],
 432         env['TARGET_ISA'],
 433         env['TARGET_ISA'],
 434         env['TARGET_ISA'],
 435         env['TARGET_ISA'],
 436         env['TARGET_ISA'])),
 437         Split('''
 438         arch/%s/isa/main.isa
 439         arch/isa_parser.py''' %
 440         env['TARGET_ISA']),
 441         '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/%s' % env['TARGET_ISA'])
 442
 443
 444 # libelf build is described in its own SConscript file.
 445 # SConscript-local is the per-config build, which just copies some
 446 # header files into a place where they can be found.
 447 SConscript('libelf/SConscript-local', exports = 'env', duplicate=0)
 448 SConscript('python/SConscript', exports = ['env'], duplicate=0)
 449
 450 # This function adds the specified sources to the given build
 451 # environment, and returns a list of all the corresponding SCons
 452 # Object nodes (including an extra one for date.cc).  We explicitly
 453 # add the Object nodes so we can set up special dependencies for
 454 # date.cc.
 455 def make_objs(sources, env):
 456     objs = [env.Object(s) for s in sources]
 457     # make date.cc depend on all other objects so it always gets
 458     # recompiled whenever anything else does
 459     date_obj = env.Object('base/date.cc')
 460     env.Depends(date_obj, objs)
 461     objs.append(date_obj)
 462     return objs
 463
 464 ###################################################
 465 #
 466 # Define binaries.  Each different build type (debug, opt, etc.) gets
 467 # a slightly different build environment.
 468 #
 469 ###################################################
 470
 471 # Include file paths are rooted in this directory.  SCons will
 472 # automatically expand '.' to refer to both the source directory and
 473 # the corresponding build directory to pick up generated include
 474 # files.
 475 env.Append(CPPPATH='.')
 476
 477 # Debug binary
 478 debugEnv = env.Copy(OBJSUFFIX='.do')
 479 debugEnv.Label = 'debug'
 480 debugEnv.Append(CCFLAGS=Split('-g -gstabs+ -O0'))
 481 debugEnv.Append(CPPDEFINES='DEBUG')
 482 tlist = debugEnv.Program(target = 'm5.debug',
 483                          source = make_objs(sources, debugEnv))
 484 debugEnv.M5Binary = tlist[0]
 485
 486 # Optimized binary
 487 optEnv = env.Copy()
 488 optEnv.Label = 'opt'
 489 optEnv.Append(CCFLAGS=Split('-g -O5'))
 490 tlist = optEnv.Program(target = 'm5.opt',
 491                        source = make_objs(sources, optEnv))
 492 optEnv.M5Binary = tlist[0]
 493
 494 # "Fast" binary
 495 fastEnv = env.Copy(OBJSUFFIX='.fo')
 496 fastEnv.Label = 'fast'
 497 fastEnv.Append(CCFLAGS=Split('-O5'))
 498 fastEnv.Append(CPPDEFINES='NDEBUG')
 499 fastEnv.Program(target = 'm5.fast.unstripped',
 500                 source = make_objs(sources, fastEnv))
 501 tlist = fastEnv.Command(target = 'm5.fast',
 502                         source = 'm5.fast.unstripped',
 503                         action = 'strip $SOURCE -o $TARGET')
 504 fastEnv.M5Binary = tlist[0]
 505
 506 # Profiled binary
 507 profEnv = env.Copy(OBJSUFFIX='.po')
 508 profEnv.Label = 'prof'
 509 profEnv.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
 510 tlist = profEnv.Program(target = 'm5.prof',
 511                         source = make_objs(sources, profEnv))
 512 profEnv.M5Binary = tlist[0]
 513
 514 envList = [debugEnv, optEnv, fastEnv, profEnv]
 515
 516 Return('envList')