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