SConscript

   1 # -*- mode:python -*-
   2
   3 # Copyright (c) 2004 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
  32 # This file defines how to build a particular configuration of M5
  33 # based on variable settings in the 'env' build environment.
  34
  35 # Import build environment variable from SConstruct.
  36 Import('env')
  37
  38 ###################################################
  39 #
  40 # Define needed sources.
  41 #
  42 ###################################################
  43
  44 # Base sources used by all configurations.
  45 base_sources = Split('''
  46         arch/alpha/decoder.cc
  47         arch/alpha/alpha_full_cpu_exec.cc
  48         arch/alpha/fast_cpu_exec.cc
  49         arch/alpha/simple_cpu_exec.cc
  50         arch/alpha/full_cpu_exec.cc
  51         arch/alpha/faults.cc
  52         arch/alpha/isa_traits.cc
  53
  54         base/circlebuf.cc
  55         base/copyright.cc
  56         base/cprintf.cc
  57         base/fast_alloc.cc
  58         base/fifo_buffer.cc
  59         base/hostinfo.cc
  60         base/hybrid_pred.cc
  61         base/inifile.cc
  62         base/intmath.cc
  63         base/match.cc
  64         base/misc.cc
  65         base/pollevent.cc
  66         base/python.cc
  67         base/range.cc
  68         base/sat_counter.cc
  69         base/socket.cc
  70         base/statistics.cc
  71         base/str.cc
  72         base/time.cc
  73         base/trace.cc
  74         base/traceflags.cc
  75         base/userinfo.cc
  76         base/compression/lzss_compression.cc
  77         base/loader/aout_object.cc
  78         base/loader/ecoff_object.cc
  79         base/loader/elf_object.cc
  80         base/loader/object_file.cc
  81         base/loader/symtab.cc
  82         base/stats/events.cc
  83         base/stats/python.cc
  84         base/stats/statdb.cc
  85         base/stats/visit.cc
  86         base/stats/text.cc
  87
  88         cpu/base_cpu.cc
  89         cpu/base_dyn_inst.cc
  90         cpu/exec_context.cc
  91         cpu/exetrace.cc
  92         cpu/pc_event.cc
  93         cpu/static_inst.cc
  94         cpu/beta_cpu/2bit_local_pred.cc
  95         cpu/beta_cpu/alpha_dyn_inst.cc
  96         cpu/beta_cpu/alpha_full_cpu.cc
  97         cpu/beta_cpu/alpha_full_cpu_builder.cc
  98         cpu/beta_cpu/bpred_unit.cc
  99         cpu/beta_cpu/btb.cc
 100         cpu/beta_cpu/commit.cc
 101         cpu/beta_cpu/decode.cc
 102         cpu/beta_cpu/fetch.cc
 103         cpu/beta_cpu/free_list.cc
 104         cpu/beta_cpu/full_cpu.cc
 105         cpu/beta_cpu/iew.cc
 106         cpu/beta_cpu/inst_queue.cc
 107         cpu/beta_cpu/ldstq.cc
 108         cpu/beta_cpu/mem_dep_unit.cc
 109         cpu/beta_cpu/ras.cc
 110         cpu/beta_cpu/rename.cc
 111         cpu/beta_cpu/rename_map.cc
 112         cpu/beta_cpu/rob.cc
 113         cpu/beta_cpu/store_set.cc
 114         cpu/beta_cpu/tournament_pred.cc
 115         cpu/fast_cpu/fast_cpu.cc
 116         cpu/full_cpu/bpred.cc
 117         cpu/full_cpu/commit.cc
 118         cpu/full_cpu/create_vector.cc
 119         cpu/full_cpu/cv_spec_state.cc
 120         cpu/full_cpu/dd_queue.cc
 121         cpu/full_cpu/dep_link.cc
 122         cpu/full_cpu/dispatch.cc
 123         cpu/full_cpu/dyn_inst.cc
 124         cpu/full_cpu/execute.cc
 125         cpu/full_cpu/fetch.cc
 126         cpu/full_cpu/floss_reasons.cc
 127         cpu/full_cpu/fu_pool.cc
 128         cpu/full_cpu/full_cpu.cc
 129         cpu/full_cpu/inst_fifo.cc
 130         cpu/full_cpu/instpipe.cc
 131         cpu/full_cpu/issue.cc
 132         cpu/full_cpu/ls_queue.cc
 133         cpu/full_cpu/machine_queue.cc
 134         cpu/full_cpu/pipetrace.cc
 135         cpu/full_cpu/readyq.cc
 136         cpu/full_cpu/reg_info.cc
 137         cpu/full_cpu/rob_station.cc
 138         cpu/full_cpu/spec_memory.cc
 139         cpu/full_cpu/spec_state.cc
 140         cpu/full_cpu/storebuffer.cc
 141         cpu/full_cpu/writeback.cc
 142         cpu/full_cpu/iq/iq_station.cc
 143         cpu/full_cpu/iq/iqueue.cc
 144         cpu/full_cpu/iq/segmented/chain_info.cc
 145         cpu/full_cpu/iq/segmented/chain_wire.cc
 146         cpu/full_cpu/iq/segmented/iq_seg.cc
 147         cpu/full_cpu/iq/segmented/iq_segmented.cc
 148         cpu/full_cpu/iq/segmented/seg_chain.cc
 149         cpu/full_cpu/iq/seznec/iq_seznec.cc
 150         cpu/full_cpu/iq/standard/iq_standard.cc
 151         cpu/sampling_cpu/sampling_cpu.cc
 152         cpu/simple_cpu/simple_cpu.cc
 153         cpu/trace/reader/mem_trace_reader.cc
 154         cpu/trace/reader/ibm_reader.cc
 155         cpu/trace/reader/itx_reader.cc
 156         cpu/trace/reader/m5_reader.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/tags/base_tags.cc
 185         mem/cache/tags/cache_tags.cc
 186         mem/cache/tags/fa_lru.cc
 187         mem/cache/tags/iic.cc
 188         mem/cache/tags/lru.cc
 189         mem/cache/tags/split.cc
 190         mem/cache/tags/split_lifo.cc
 191         mem/cache/tags/split_lru.cc
 192         mem/cache/tags/repl/gen.cc
 193         mem/cache/tags/repl/repl.cc
 194         mem/functional_mem/functional_memory.cc
 195         mem/functional_mem/main_memory.cc
 196         mem/timing_mem/base_memory.cc
 197         mem/timing_mem/memory_builder.cc
 198         mem/timing_mem/simple_mem_bank.cc
 199         mem/trace/mem_trace_writer.cc
 200         mem/trace/m5_writer.cc
 201
 202         sim/builder.cc
 203         sim/configfile.cc
 204         sim/debug.cc
 205         sim/eventq.cc
 206         sim/main.cc
 207         sim/param.cc
 208         sim/profile.cc
 209         sim/serialize.cc
 210         sim/sim_events.cc
 211         sim/sim_exit.cc
 212         sim/sim_init.cc
 213         sim/sim_object.cc
 214         sim/stat_context.cc
 215         sim/stat_control.cc
 216         sim/sw_context.cc
 217         sim/trace_context.cc
 218         sim/universe.cc
 219         sim/pyconfig/pyconfig.cc
 220         sim/pyconfig/code.cc
 221         ''')
 222
 223 base_obj_desc_files = Split('''
 224         cpu/full_cpu/iq/segmented/SegmentedIQ.od
 225         cpu/full_cpu/iq/seznec/SeznecIQ.od
 226         cpu/full_cpu/iq/standard/StandardIQ.od
 227         cpu/full_cpu/iq/BaseIQ.od
 228         cpu/full_cpu/BranchPred.od
 229         cpu/full_cpu/FUDesc.od
 230         cpu/full_cpu/FullCPU.od
 231         cpu/full_cpu/FuncUnitPool.od
 232         cpu/full_cpu/OpDesc.od
 233         cpu/full_cpu/PipeTrace.od
 234         cpu/sampling_cpu/SamplingCPU.od
 235         cpu/simple_cpu/SimpleCPU.od
 236         cpu/BaseCPU.od
 237         cpu/IntrControl.od
 238         mem/bus/Bus.od
 239         mem/bus/BusBridge.od
 240         mem/cache/coherence/CoherenceProtocol.od
 241         mem/cache/tags/repl/GenRepl.od
 242         mem/cache/tags/repl/Repl.od
 243         mem/cache/BaseCache.od
 244         mem/functional_mem/FunctionalMemory.od
 245         mem/functional_mem/MainMemory.od
 246         mem/functional_mem/MemoryController.od
 247         mem/functional_mem/PhysicalMemory.od
 248         mem/timing_mem/BaseMemory.od
 249         mem/BaseHier.od
 250         mem/BaseMem.od
 251         mem/HierParams.od
 252         ''')
 253
 254
 255 # MySql sources
 256 mysql_sources = Split('''
 257         base/mysql.cc
 258         base/stats/mysql.cc
 259         ''')
 260
 261 # Full-system sources
 262 full_system_sources = Split('''
 263         arch/alpha/alpha_memory.cc
 264         arch/alpha/arguments.cc
 265         arch/alpha/ev5.cc
 266         arch/alpha/osfpal.cc
 267         arch/alpha/pseudo_inst.cc
 268         arch/alpha/vtophys.cc
 269
 270         base/inet.cc
 271         base/remote_gdb.cc
 272
 273         cpu/intr_control.cc
 274
 275         dev/alpha_console.cc
 276         dev/baddev.cc
 277         dev/simconsole.cc
 278         dev/disk_image.cc
 279         dev/dma.cc
 280         dev/etherbus.cc
 281         dev/etherdump.cc
 282         dev/etherint.cc
 283         dev/etherlink.cc
 284         dev/etherpkt.cc
 285         dev/ethertap.cc
 286         dev/ide_ctrl.cc
 287         dev/ide_disk.cc
 288         dev/io_device.cc
 289         dev/ns_gige.cc
 290         dev/etherdev.cc
 291         dev/pciconfigall.cc
 292         dev/pcidev.cc
 293         dev/scsi.cc
 294         dev/scsi_ctrl.cc
 295         dev/scsi_disk.cc
 296         dev/scsi_none.cc
 297         dev/simple_disk.cc
 298         dev/tlaser_clock.cc
 299         dev/tlaser_ipi.cc
 300         dev/tlaser_mbox.cc
 301         dev/tlaser_mc146818.cc
 302         dev/tlaser_node.cc
 303         dev/tlaser_pcia.cc
 304         dev/tlaser_pcidev.cc
 305         dev/tlaser_serial.cc
 306         dev/turbolaser.cc
 307         dev/tsunami.cc
 308         dev/tsunami_cchip.cc
 309         dev/tsunami_fake.cc
 310         dev/tsunami_io.cc
 311         dev/tsunami_pchip.cc
 312         dev/uart.cc
 313
 314         kern/kernel_stats.cc
 315         kern/system_events.cc
 316         kern/linux/linux_events.cc
 317         kern/linux/linux_syscalls.cc
 318         kern/linux/linux_system.cc
 319         kern/linux/printk.cc
 320         kern/tru64/dump_mbuf.cc
 321         kern/tru64/printf.cc
 322         kern/tru64/tru64_events.cc
 323         kern/tru64/tru64_syscalls.cc
 324         kern/tru64/tru64_system.cc
 325
 326         mem/functional_mem/memory_control.cc
 327         mem/functional_mem/physical_memory.cc
 328         dev/platform.cc
 329
 330         sim/system.cc
 331         ''')
 332
 333 full_system_obj_desc_files = Split('''
 334         arch/alpha/AlphaDTB.od
 335         arch/alpha/AlphaITB.od
 336         arch/alpha/AlphaTLB.od
 337         dev/AlphaConsole.od
 338         dev/ConsoleListener.od
 339         dev/CowDiskImage.od
 340         dev/DiskImage.od
 341         dev/DmaDevice.od
 342         dev/DmaEngine.od
 343         dev/EtherBus.od
 344         dev/EtherDev.od
 345         dev/EtherDevInt.od
 346         dev/EtherDump.od
 347         dev/EtherInt.od
 348         dev/EtherLink.od
 349         dev/EtherTap.od
 350         dev/PioDevice.od
 351         dev/RawDiskImage.od
 352         dev/ScsiController.od
 353         dev/ScsiDevice.od
 354         dev/ScsiDisk.od
 355         dev/SimConsole.od
 356         dev/SimpleDisk.od
 357         dev/TlaserClock.od
 358         dev/TlaserIpi.od
 359         dev/TlaserMBox.od
 360         dev/TlaserMC146818.od
 361         dev/TlaserNode.od
 362         dev/TlaserPciDev.od
 363         dev/TlaserPcia.od
 364         dev/TlaserSerial.od
 365         dev/TlaserUart.od
 366         dev/Turbolaser.od
 367         kern/tru64/Tru64System.od
 368         sim/System.od
 369         ''')
 370
 371 # Syscall emulation (non-full-system) sources
 372 syscall_emulation_sources = Split('''
 373         arch/alpha/alpha_common_syscall_emul.cc
 374         arch/alpha/alpha_linux_process.cc
 375         arch/alpha/alpha_tru64_process.cc
 376         cpu/memtest/memtest.cc
 377         cpu/trace/trace_cpu.cc
 378         eio/eio.cc
 379         eio/exolex.cc
 380         eio/libexo.cc
 381         sim/process.cc
 382         sim/syscall_emul.cc
 383         ''')
 384
 385 syscall_emulation_obj_desc_files = Split('''
 386         cpu/memtest/MemTest.od
 387         eio/EioProcess.od
 388         sim/LiveProcess.od
 389         sim/Process.od
 390         ''')
 391
 392 # Set up complete list of sources based on configuration.
 393 sources = base_sources
 394 obj_desc_files = base_obj_desc_files
 395
 396 if env['FULL_SYSTEM']:
 397     sources += full_system_sources
 398     obj_desc_files += full_system_obj_desc_files
 399 else:
 400     sources += syscall_emulation_sources
 401     obj_desc_files += syscall_emulation_obj_desc_files
 402
 403 if env['USE_MYSQL']:
 404     sources += mysql_sources
 405
 406 ###################################################
 407 #
 408 # Special build rules.
 409 #
 410 ###################################################
 411
 412 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
 413 # $TARGET.base will expand to "<build-dir>/base/traceflags".
 414 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
 415             'base/traceflags.py',
 416             'python $SOURCE $TARGET.base')
 417
 418 # several files are generated from arch/$TARGET_ISA/isa_desc.
 419 env.Command(Split('''arch/alpha/decoder.cc
 420                      arch/alpha/decoder.hh
 421                      arch/alpha/alpha_full_cpu_exec.cc
 422                      arch/alpha/fast_cpu_exec.cc
 423                      arch/alpha/simple_cpu_exec.cc
 424                      arch/alpha/full_cpu_exec.cc'''),
 425             Split('''arch/alpha/isa_desc
 426                      arch/isa_parser.py'''),
 427             '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/alpha')
 428
 429
 430 # 'targetarch' is a symlink to arch/$TARGET_ISA.
 431 def link_targetarch(target, source, env):
 432     link_target = str(target[0])
 433     link_source = env.subst('$SRCDIR/arch/$TARGET_ISA')
 434     if not os.path.isdir(link_target):
 435         print "symlinking", link_source, "to", link_target
 436         try:
 437             os.symlink(link_source, link_target)
 438         except OSError, desc:
 439             print "Error creating symlink %s: %s" % (link_target, desc)
 440             sys.exit(-1)
 441
 442 # Tell SCons to use the link_targetarch function to make 'targetarch'
 443 env.Command('targetarch', None, link_targetarch)
 444
 445
 446 # libelf build is described in its own SConscript file.
 447 # SConscript-local is the per-config build, which just copies some
 448 # header files into a place where they can be found.
 449 SConscript('libelf/SConscript-local', exports = 'env', duplicate=0)
 450
 451 SConscript('sim/pyconfig/SConscript', exports = ['env', 'obj_desc_files'],
 452            duplicate=0)
 453
 454
 455 # This function adds the specified sources to the given build
 456 # environment, and returns a list of all the corresponding SCons
 457 # Object nodes (including an extra one for date.cc).  We explicitly
 458 # add the Object nodes so we can set up special dependencies for
 459 # targetarch and date.cc.
 460 def make_objs(sources, env):
 461     objs = [env.Object(s) for s in sources]
 462     # make all objects depend on the targetarch link so it gets made first.
 463     env.Depends(objs, 'targetarch')
 464     # make date.cc depend on all other objects so it always gets
 465     # recompiled whenever anything else does
 466     date_obj = env.Object('base/date.cc')
 467     env.Depends(date_obj, objs)
 468     objs.append(date_obj)
 469     return objs
 470
 471 ###################################################
 472 #
 473 # Define binaries.  Each different build type (debug, opt, etc.) gets
 474 # a slightly different build environment.
 475 #
 476 ###################################################
 477
 478 # Include file paths are rooted in this directory.  SCons will
 479 # automatically expand '.' to refer to both the source directory and
 480 # the corresponding build directory to pick up generated include
 481 # files.
 482 env.Append(CPPPATH='.')
 483
 484 # Debug binary
 485 debug = env.Copy(OBJSUFFIX='.do')
 486 debug.Append(CCFLAGS=Split('-g -gstabs+ -O0 -lefence'))
 487 debug.Append(CPPDEFINES='DEBUG')
 488 debug.Program(target = 'm5.debug', source = make_objs(sources, debug))
 489
 490 # Optimized binary
 491 opt = env.Copy()
 492 opt.Append(CCFLAGS=Split('-g -O5'))
 493 opt.Program(target = 'm5.opt', source = make_objs(sources, opt))
 494
 495 # "Fast" binary
 496 fast = env.Copy(OBJSUFFIX='.fo')
 497 fast.Append(CCFLAGS=Split('-O5'))
 498 fast.Append(CPPDEFINES='NDEBUG')
 499 fast.Program(target = 'm5.fast.unstripped', source = make_objs(sources, fast))
 500 fast.Command(target = 'm5.fast', source = 'm5.fast.unstripped',
 501              action = 'strip $SOURCE -o $TARGET')
 502
 503 # Profiled binary
 504 prof = env.Copy(OBJSUFFIX='.po')
 505 prof.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
 506 prof.Program(target = 'm5.prof', source = make_objs(sources, prof))