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