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/misc.cc
  63         base/pollevent.cc
  64         base/python.cc
  65         base/range.cc
  66         base/sat_counter.cc
  67         base/socket.cc
  68         base/statistics.cc
  69         base/str.cc
  70         base/time.cc
  71         base/trace.cc
  72         base/traceflags.cc
  73         base/userinfo.cc
  74         base/compression/lzss_compression.cc
  75         base/loader/aout_object.cc
  76         base/loader/ecoff_object.cc
  77         base/loader/elf_object.cc
  78         base/loader/object_file.cc
  79         base/loader/symtab.cc
  80         base/stats/events.cc
  81         base/stats/python.cc
  82         base/stats/statdb.cc
  83         base/stats/visit.cc
  84         base/stats/text.cc
  85
  86         cpu/base_cpu.cc
  87         cpu/exec_context.cc
  88         cpu/exetrace.cc
  89         cpu/pc_event.cc
  90         cpu/static_inst.cc
  91         cpu/fast_cpu/fast_cpu.cc
  92         cpu/full_cpu/bpred.cc
  93         cpu/full_cpu/commit.cc
  94         cpu/full_cpu/create_vector.cc
  95         cpu/full_cpu/cv_spec_state.cc
  96         cpu/full_cpu/dd_queue.cc
  97         cpu/full_cpu/dep_link.cc
  98         cpu/full_cpu/dispatch.cc
  99         cpu/full_cpu/dyn_inst.cc
 100         cpu/full_cpu/execute.cc
 101         cpu/full_cpu/fetch.cc
 102         cpu/full_cpu/floss_reasons.cc
 103         cpu/full_cpu/fu_pool.cc
 104         cpu/full_cpu/full_cpu.cc
 105         cpu/full_cpu/inst_fifo.cc
 106         cpu/full_cpu/instpipe.cc
 107         cpu/full_cpu/issue.cc
 108         cpu/full_cpu/ls_queue.cc
 109         cpu/full_cpu/machine_queue.cc
 110         cpu/full_cpu/pipetrace.cc
 111         cpu/full_cpu/readyq.cc
 112         cpu/full_cpu/reg_info.cc
 113         cpu/full_cpu/rob_station.cc
 114         cpu/full_cpu/spec_memory.cc
 115         cpu/full_cpu/spec_state.cc
 116         cpu/full_cpu/storebuffer.cc
 117         cpu/full_cpu/writeback.cc
 118         cpu/full_cpu/iq/iq_station.cc
 119         cpu/full_cpu/iq/iqueue.cc
 120         cpu/full_cpu/iq/segmented/chain_info.cc
 121         cpu/full_cpu/iq/segmented/chain_wire.cc
 122         cpu/full_cpu/iq/segmented/iq_seg.cc
 123         cpu/full_cpu/iq/segmented/iq_segmented.cc
 124         cpu/full_cpu/iq/segmented/seg_chain.cc
 125         cpu/full_cpu/iq/seznec/iq_seznec.cc
 126         cpu/full_cpu/iq/standard/iq_standard.cc
 127         cpu/sampling_cpu/sampling_cpu.cc
 128         cpu/simple_cpu/simple_cpu.cc
 129         cpu/trace/reader/mem_trace_reader.cc
 130         cpu/trace/reader/ibm_reader.cc
 131         cpu/trace/reader/itx_reader.cc
 132         cpu/trace/reader/m5_reader.cc
 133
 134         mem/base_hier.cc
 135         mem/base_mem.cc
 136         mem/hier_params.cc
 137         mem/mem_cmd.cc
 138         mem/mem_debug.cc
 139         mem/mem_req.cc
 140         mem/memory_interface.cc
 141         mem/bus/base_interface.cc
 142         mem/bus/bus.cc
 143         mem/bus/bus_bridge.cc
 144         mem/bus/bus_bridge_master.cc
 145         mem/bus/bus_bridge_slave.cc
 146         mem/bus/bus_interface.cc
 147         mem/bus/dma_bus_interface.cc
 148         mem/bus/dma_interface.cc
 149         mem/bus/master_interface.cc
 150         mem/bus/slave_interface.cc
 151         mem/cache/base_cache.cc
 152         mem/cache/cache.cc
 153         mem/cache/cache_builder.cc
 154         mem/cache/coherence/coherence_protocol.cc
 155         mem/cache/coherence/uni_coherence.cc
 156         mem/cache/miss/blocking_buffer.cc
 157         mem/cache/miss/miss_queue.cc
 158         mem/cache/miss/mshr.cc
 159         mem/cache/miss/mshr_queue.cc
 160         mem/cache/tags/base_tags.cc
 161         mem/cache/tags/cache_tags.cc
 162         mem/cache/tags/fa_lru.cc
 163         mem/cache/tags/iic.cc
 164         mem/cache/tags/lru.cc
 165         mem/cache/tags/split.cc
 166         mem/cache/tags/split_lifo.cc
 167         mem/cache/tags/split_lru.cc
 168         mem/cache/tags/repl/gen.cc
 169         mem/cache/tags/repl/repl.cc
 170         mem/functional_mem/functional_memory.cc
 171         mem/functional_mem/main_memory.cc
 172         mem/timing_mem/base_memory.cc
 173         mem/timing_mem/memory_builder.cc
 174         mem/timing_mem/simple_mem_bank.cc
 175         mem/trace/mem_trace_writer.cc
 176         mem/trace/m5_writer.cc
 177
 178         sim/builder.cc
 179         sim/configfile.cc
 180         sim/debug.cc
 181         sim/eventq.cc
 182         sim/main.cc
 183         sim/param.cc
 184         sim/profile.cc
 185         sim/serialize.cc
 186         sim/sim_events.cc
 187         sim/sim_exit.cc
 188         sim/sim_init.cc
 189         sim/sim_object.cc
 190         sim/stat_context.cc
 191         sim/stat_control.cc
 192         sim/sw_context.cc
 193         sim/trace_context.cc
 194         sim/universe.cc
 195         ''')
 196
 197 # MySql sources
 198 mysql_sources = Split('''
 199         base/mysql.cc
 200         base/stats/mysql.cc
 201         ''')
 202
 203 # Full-system sources
 204 full_system_sources = Split('''
 205         arch/alpha/alpha_memory.cc
 206         arch/alpha/arguments.cc
 207         arch/alpha/ev5.cc
 208         arch/alpha/osfpal.cc
 209         arch/alpha/pseudo_inst.cc
 210         arch/alpha/vtophys.cc
 211
 212         base/inet.cc
 213         base/remote_gdb.cc
 214
 215         cpu/intr_control.cc
 216
 217         dev/alpha_console.cc
 218         dev/baddev.cc
 219         dev/simconsole.cc
 220         dev/disk_image.cc
 221         dev/dma.cc
 222         dev/etherbus.cc
 223         dev/etherdump.cc
 224         dev/etherint.cc
 225         dev/etherlink.cc
 226         dev/etherpkt.cc
 227         dev/ethertap.cc
 228         dev/ide_ctrl.cc
 229         dev/ide_disk.cc
 230         dev/io_device.cc
 231         dev/ns_gige.cc
 232         dev/etherdev.cc
 233         dev/pciconfigall.cc
 234         dev/pcidev.cc
 235         dev/scsi.cc
 236         dev/scsi_ctrl.cc
 237         dev/scsi_disk.cc
 238         dev/scsi_none.cc
 239         dev/simple_disk.cc
 240         dev/tlaser_clock.cc
 241         dev/tlaser_ipi.cc
 242         dev/tlaser_mbox.cc
 243         dev/tlaser_mc146818.cc
 244         dev/tlaser_node.cc
 245         dev/tlaser_pcia.cc
 246         dev/tlaser_pcidev.cc
 247         dev/tlaser_serial.cc
 248         dev/turbolaser.cc
 249         dev/tsunami.cc
 250         dev/tsunami_cchip.cc
 251         dev/tsunami_fake.cc
 252         dev/tsunami_io.cc
 253         dev/tsunami_pchip.cc
 254         dev/uart.cc
 255
 256         kern/kernel_stats.cc
 257         kern/system_events.cc
 258         kern/linux/linux_events.cc
 259         kern/linux/linux_syscalls.cc
 260         kern/linux/linux_system.cc
 261         kern/tru64/dump_mbuf.cc
 262         kern/tru64/printf.cc
 263         kern/tru64/tru64_events.cc
 264         kern/tru64/tru64_syscalls.cc
 265         kern/tru64/tru64_system.cc
 266
 267         mem/functional_mem/memory_control.cc
 268         mem/functional_mem/physical_memory.cc
 269         dev/platform.cc
 270
 271         sim/system.cc
 272         ''')
 273
 274 # Syscall emulation (non-full-system) sources
 275 syscall_emulation_sources = Split('''
 276         arch/alpha/alpha_common_syscall_emul.cc
 277         arch/alpha/alpha_linux_process.cc
 278         arch/alpha/alpha_tru64_process.cc
 279         cpu/memtest/memtest.cc
 280         cpu/trace/trace_cpu.cc
 281         eio/eio.cc
 282         eio/exolex.cc
 283         eio/libexo.cc
 284         sim/process.cc
 285         sim/syscall_emul.cc
 286         ''')
 287
 288 # Set up complete list of sources based on configuration.
 289 sources = base_sources
 290
 291 if env['FULL_SYSTEM']:
 292     sources += full_system_sources
 293 else:
 294     sources += syscall_emulation_sources
 295
 296 if env['USE_MYSQL']:
 297     sources += mysql_sources
 298
 299 ###################################################
 300 #
 301 # Special build rules.
 302 #
 303 ###################################################
 304
 305 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
 306 # $TARGET.base will expand to "<build-dir>/base/traceflags".
 307 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
 308             'base/traceflags.py',
 309             'python $SOURCE $TARGET.base')
 310
 311 # several files are generated from arch/$TARGET_ISA/isa_desc.
 312 env.Command(Split('''arch/alpha/decoder.cc
 313                      arch/alpha/decoder.hh
 314                      arch/alpha/fast_cpu_exec.cc
 315                      arch/alpha/simple_cpu_exec.cc
 316                      arch/alpha/full_cpu_exec.cc'''),
 317             'arch/alpha/isa_desc',
 318             '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/alpha')
 319
 320
 321 # 'targetarch' is a symlink to arch/$TARGET_ISA.
 322 def link_targetarch(target, source, env):
 323     link_target = str(target[0])
 324     link_source = env.subst('$SRCDIR/arch/$TARGET_ISA')
 325     if not os.path.isdir(link_target):
 326         print "symlinking", link_source, "to", link_target
 327         try:
 328             os.symlink(link_source, link_target)
 329         except OSError, desc:
 330             print "Error creating symlink %s: %s" % (link_target, desc)
 331             sys.exit(-1)
 332
 333 # Tell SCons to use the link_targetarch function to make 'targetarch'
 334 env.Command('targetarch', None, link_targetarch)
 335
 336
 337 # This function adds the specified sources to the given build
 338 # environment, and returns a list of all the corresponding SCons
 339 # Object nodes (including an extra one for date.cc).  We explicitly
 340 # add the Object nodes so we can set up special dependencies for
 341 # targetarch and date.cc.
 342 def make_objs(sources, env):
 343     objs = [env.Object(s) for s in sources]
 344     # make all objects depend on the targetarch link so it gets made first.
 345     env.Depends(objs, 'targetarch')
 346     # make date.cc depend on all other objects so it always gets
 347     # recompiled whenever anything else does
 348     date_obj = env.Object('base/date.cc')
 349     env.Depends(date_obj, objs)
 350     objs.append(date_obj)
 351     return objs
 352
 353 ###################################################
 354 #
 355 # Define binaries.  Each different build type (debug, opt, etc.) gets
 356 # a slightly different build environment.
 357 #
 358 ###################################################
 359
 360 # Include file paths are rooted in this directory.  SCons will
 361 # automatically expand '.' to refer to both the source directory and
 362 # the corresponding build directory to pick up generated include
 363 # files.
 364 env.Append(CPPPATH='.')
 365
 366 # Debug binary
 367 debug = env.Copy(OBJSUFFIX='.do')
 368 debug.Append(CCFLAGS=Split('-g -gstabs+ -O0'))
 369 debug.Append(CPPDEFINES='DEBUG')
 370 debug.Program(target = 'm5.debug', source = make_objs(sources, debug))
 371
 372 # Optimized binary
 373 opt = env.Copy()
 374 opt.Append(CCFLAGS=Split('-g -O5'))
 375 opt.Program(target = 'm5.opt', source = make_objs(sources, opt))
 376
 377 # "Fast" binary
 378 fast = env.Copy(OBJSUFFIX='.fo')
 379 fast.Append(CCFLAGS=Split('-O5'))
 380 fast.Append(CPPDEFINES='NDEBUG')
 381 fast.Program(target = 'm5.fast.unstripped', source = make_objs(sources, fast))
 382 fast.Command(target = 'm5.fast', source = 'm5.fast.unstripped',
 383              action = 'strip $SOURCE -o $TARGET')
 384
 385 # Profiled binary
 386 prof = env.Copy(OBJSUFFIX='.po')
 387 prof.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
 388 prof.Program(target = 'm5.prof', source = make_objs(sources, prof))