SConscript revision 2023
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 29import os 30import sys 31from 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. 37Import('env') 38 39################################################### 40# 41# Define needed sources. 42# 43################################################### 44 45# Base sources used by all configurations. 46 47base_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 235mysql_sources = Split(''' 236 base/mysql.cc 237 base/stats/mysql.cc 238 ''') 239 240# Full-system sources 241full_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 307turbolaser_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 327syscall_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 341targetarch_files = Split(''' 342 alpha_common_syscall_emul.hh 343 alpha_linux_process.hh 344 alpha_memory.hh 345 alpha_tru64_process.hh 346 aout_machdep.h 347 arguments.hh 348 byte_swap.hh 349 ecoff_machdep.h 350 ev5.hh 351 faults.hh 352 isa_fullsys_traits.hh 353 isa_traits.hh 354 osfpal.hh 355 pseudo_inst.hh 356 stacktrace.hh 357 vptr.hh 358 vtophys.hh 359 ''') 360 361# Set up bridging headers to the architecture specific versions 362for 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 367arch_source = SConscript('arch/%s/SConscript' % env['TARGET_ISA'], 368 build_dir = 'build/%s/' % env['BUILD_DIR'], 369 exports = 'env', duplicate = False) 370 371# Set up complete list of sources based on configuration. 372sources = base_sources + arch_source 373 374if env['FULL_SYSTEM']: 375 sources += full_system_sources 376 if env['ALPHA_TLASER']: 377 sources += turbolaser_sources 378else: 379 sources += syscall_emulation_sources 380 381if env['USE_MYSQL']: 382 sources += mysql_sources 383 384for opt in env.ExportOptions: 385 env.ConfigFile(opt) 386 387################################################### 388# 389# Special build rules. 390# 391################################################### 392 393# base/traceflags.{cc,hh} are generated from base/traceflags.py. 394# $TARGET.base will expand to "<build-dir>/base/traceflags". 395env.Command(Split('base/traceflags.hh base/traceflags.cc'), 396 'base/traceflags.py', 397 'python $SOURCE $TARGET.base') 398 399# several files are generated from arch/$TARGET_ISA/isa_desc. 400env.Command(Split(''' 401 arch/%s/decoder.cc 402 arch/%s/decoder.hh 403 arch/%s/alpha_o3_exec.cc 404 arch/%s/fast_cpu_exec.cc 405 arch/%s/simple_cpu_exec.cc 406 arch/%s/full_cpu_exec.cc''' % 407 (env['TARGET_ISA'], 408 env['TARGET_ISA'], 409 env['TARGET_ISA'], 410 env['TARGET_ISA'], 411 env['TARGET_ISA'], 412 env['TARGET_ISA'])), 413 Split(''' 414 arch/%s/isa_desc 415 arch/isa_parser.py''' % 416 env['TARGET_ISA']), 417 '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/%s' % env['TARGET_ISA']) 418 419 420# libelf build is described in its own SConscript file. 421# SConscript-local is the per-config build, which just copies some 422# header files into a place where they can be found. 423SConscript('libelf/SConscript-local', exports = 'env', duplicate=0) 424SConscript('python/SConscript', exports = ['env'], duplicate=0) 425 426# This function adds the specified sources to the given build 427# environment, and returns a list of all the corresponding SCons 428# Object nodes (including an extra one for date.cc). We explicitly 429# add the Object nodes so we can set up special dependencies for 430# date.cc. 431def make_objs(sources, env): 432 objs = [env.Object(s) for s in sources] 433 # make date.cc depend on all other objects so it always gets 434 # recompiled whenever anything else does 435 date_obj = env.Object('base/date.cc') 436 env.Depends(date_obj, objs) 437 objs.append(date_obj) 438 return objs 439 440################################################### 441# 442# Define binaries. Each different build type (debug, opt, etc.) gets 443# a slightly different build environment. 444# 445################################################### 446 447# Include file paths are rooted in this directory. SCons will 448# automatically expand '.' to refer to both the source directory and 449# the corresponding build directory to pick up generated include 450# files. 451env.Append(CPPPATH='.') 452 453# Debug binary 454debugEnv = env.Copy(OBJSUFFIX='.do') 455debugEnv.Label = 'debug' 456debugEnv.Append(CCFLAGS=Split('-g -gstabs+ -O0')) 457debugEnv.Append(CPPDEFINES='DEBUG') 458tlist = debugEnv.Program(target = 'm5.debug', 459 source = make_objs(sources, debugEnv)) 460debugEnv.M5Binary = tlist[0] 461 462# Optimized binary 463optEnv = env.Copy() 464optEnv.Label = 'opt' 465optEnv.Append(CCFLAGS=Split('-g -O5')) 466tlist = optEnv.Program(target = 'm5.opt', 467 source = make_objs(sources, optEnv)) 468optEnv.M5Binary = tlist[0] 469 470# "Fast" binary 471fastEnv = env.Copy(OBJSUFFIX='.fo') 472fastEnv.Label = 'fast' 473fastEnv.Append(CCFLAGS=Split('-O5')) 474fastEnv.Append(CPPDEFINES='NDEBUG') 475fastEnv.Program(target = 'm5.fast.unstripped', 476 source = make_objs(sources, fastEnv)) 477tlist = fastEnv.Command(target = 'm5.fast', 478 source = 'm5.fast.unstripped', 479 action = 'strip $SOURCE -o $TARGET') 480fastEnv.M5Binary = tlist[0] 481 482# Profiled binary 483profEnv = env.Copy(OBJSUFFIX='.po') 484profEnv.Label = 'prof' 485profEnv.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg') 486tlist = profEnv.Program(target = 'm5.prof', 487 source = make_objs(sources, profEnv)) 488profEnv.M5Binary = tlist[0] 489 490envList = [debugEnv, optEnv, fastEnv, profEnv] 491 492Return('envList') 493