src/SConscript

   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 #
  29 # Authors: Steve Reinhardt
  30
  31 import os
  32 import sys
  33 from os.path import isdir
  34
  35 # This file defines how to build a particular configuration of M5
  36 # based on variable settings in the 'env' build environment.
  37
  38 # Import build environment variable from SConstruct.
  39 Import('env')
  40
  41 ###################################################
  42 #
  43 # Define needed sources.
  44 #
  45 ###################################################
  46
  47 # Base sources used by all configurations.
  48
  49 base_sources = Split('''
  50         base/annotate.cc
  51         base/circlebuf.cc
  52         base/cprintf.cc
  53         base/fast_alloc.cc
  54         base/fifo_buffer.cc
  55         base/hostinfo.cc
  56         base/hybrid_pred.cc
  57         base/inifile.cc
  58         base/intmath.cc
  59         base/match.cc
  60         base/misc.cc
  61         base/output.cc
  62         base/pollevent.cc
  63         base/range.cc
  64         base/random.cc
  65         base/sat_counter.cc
  66         base/socket.cc
  67         base/statistics.cc
  68         base/str.cc
  69         base/time.cc
  70         base/trace.cc
  71         base/traceflags.cc
  72         base/userinfo.cc
  73         base/compression/lzss_compression.cc
  74         base/loader/aout_object.cc
  75         base/loader/ecoff_object.cc
  76         base/loader/elf_object.cc
  77         base/loader/object_file.cc
  78         base/loader/symtab.cc
  79         base/stats/events.cc
  80         base/stats/statdb.cc
  81         base/stats/visit.cc
  82         base/stats/text.cc
  83
  84         cpu/activity.cc
  85         cpu/base.cc
  86         cpu/cpuevent.cc
  87         cpu/exetrace.cc
  88         cpu/func_unit.cc
  89         cpu/op_class.cc
  90         cpu/pc_event.cc
  91         cpu/quiesce_event.cc
  92         cpu/static_inst.cc
  93         cpu/simple_thread.cc
  94         cpu/thread_state.cc
  95
  96         mem/bridge.cc
  97         mem/bus.cc
  98         mem/dram.cc
  99         mem/mem_object.cc
 100         mem/packet.cc
 101         mem/physical.cc
 102         mem/port.cc
 103         mem/tport.cc
 104
 105         mem/cache/base_cache.cc
 106         mem/cache/cache.cc
 107         mem/cache/coherence/coherence_protocol.cc
 108         mem/cache/coherence/uni_coherence.cc
 109         mem/cache/miss/blocking_buffer.cc
 110         mem/cache/miss/miss_queue.cc
 111         mem/cache/miss/mshr.cc
 112         mem/cache/miss/mshr_queue.cc
 113         mem/cache/prefetch/base_prefetcher.cc
 114         mem/cache/prefetch/ghb_prefetcher.cc
 115         mem/cache/prefetch/prefetcher.cc
 116         mem/cache/prefetch/stride_prefetcher.cc
 117         mem/cache/prefetch/tagged_prefetcher.cc
 118         mem/cache/tags/base_tags.cc
 119         mem/cache/tags/cache_tags.cc
 120         mem/cache/tags/fa_lru.cc
 121         mem/cache/tags/iic.cc
 122         mem/cache/tags/lru.cc
 123         mem/cache/tags/repl/gen.cc
 124         mem/cache/tags/repl/repl.cc
 125         mem/cache/tags/split.cc
 126         mem/cache/tags/split_lifo.cc
 127         mem/cache/tags/split_lru.cc
 128
 129         mem/cache/cache_builder.cc
 130
 131         sim/builder.cc
 132         sim/debug.cc
 133         sim/eventq.cc
 134         sim/faults.cc
 135         sim/main.cc
 136         python/swig/cc_main_wrap.cc
 137         sim/param.cc
 138         sim/root.cc
 139         sim/serialize.cc
 140         sim/sim_events.cc
 141         sim/sim_object.cc
 142         sim/startup.cc
 143         sim/stat_context.cc
 144         sim/stat_control.cc
 145         sim/system.cc
 146         sim/trace_context.cc
 147         ''')
 148
 149 # Old FullCPU sources
 150 full_cpu_sources = Split('''
 151         encumbered/cpu/full/bpred.cc
 152         encumbered/cpu/full/commit.cc
 153         encumbered/cpu/full/cpu.cc
 154         encumbered/cpu/full/create_vector.cc
 155         encumbered/cpu/full/cv_spec_state.cc
 156         encumbered/cpu/full/dd_queue.cc
 157         encumbered/cpu/full/dep_link.cc
 158         encumbered/cpu/full/dispatch.cc
 159         encumbered/cpu/full/dyn_inst.cc
 160         encumbered/cpu/full/execute.cc
 161         encumbered/cpu/full/fetch.cc
 162         encumbered/cpu/full/floss_reasons.cc
 163         encumbered/cpu/full/fu_pool.cc
 164         encumbered/cpu/full/inst_fifo.cc
 165         encumbered/cpu/full/instpipe.cc
 166         encumbered/cpu/full/issue.cc
 167         encumbered/cpu/full/ls_queue.cc
 168         encumbered/cpu/full/machine_queue.cc
 169         encumbered/cpu/full/pipetrace.cc
 170         encumbered/cpu/full/readyq.cc
 171         encumbered/cpu/full/reg_info.cc
 172         encumbered/cpu/full/rob_station.cc
 173         encumbered/cpu/full/spec_memory.cc
 174         encumbered/cpu/full/spec_state.cc
 175         encumbered/cpu/full/storebuffer.cc
 176         encumbered/cpu/full/writeback.cc
 177         encumbered/cpu/full/iq/iq_station.cc
 178         encumbered/cpu/full/iq/iqueue.cc
 179         encumbered/cpu/full/iq/segmented/chain_info.cc
 180         encumbered/cpu/full/iq/segmented/chain_wire.cc
 181         encumbered/cpu/full/iq/segmented/iq_seg.cc
 182         encumbered/cpu/full/iq/segmented/iq_segmented.cc
 183         encumbered/cpu/full/iq/segmented/seg_chain.cc
 184         encumbered/cpu/full/iq/seznec/iq_seznec.cc
 185         encumbered/cpu/full/iq/standard/iq_standard.cc
 186         ''')
 187
 188 trace_reader_sources = Split('''
 189         cpu/trace/reader/mem_trace_reader.cc
 190         cpu/trace/reader/ibm_reader.cc
 191         cpu/trace/reader/itx_reader.cc
 192         cpu/trace/reader/m5_reader.cc
 193         cpu/trace/opt_cpu.cc
 194         cpu/trace/trace_cpu.cc
 195         ''')
 196
 197
 198
 199 # MySql sources
 200 mysql_sources = Split('''
 201         base/mysql.cc
 202         base/stats/mysql.cc
 203         ''')
 204
 205 # Full-system sources
 206 full_system_sources = Split('''
 207         base/crc.cc
 208         base/inet.cc
 209         base/remote_gdb.cc
 210
 211         cpu/intr_control.cc
 212         cpu/profile.cc
 213
 214         dev/alpha_console.cc
 215         dev/baddev.cc
 216         dev/disk_image.cc
 217         dev/etherbus.cc
 218         dev/etherdump.cc
 219         dev/etherint.cc
 220         dev/etherlink.cc
 221         dev/etherpkt.cc
 222         dev/ethertap.cc
 223         dev/ide_ctrl.cc
 224         dev/ide_disk.cc
 225         dev/io_device.cc
 226         dev/isa_fake.cc
 227         dev/ns_gige.cc
 228         dev/pciconfigall.cc
 229         dev/pcidev.cc
 230         dev/pktfifo.cc
 231         dev/platform.cc
 232         dev/simconsole.cc
 233         dev/simple_disk.cc
 234         dev/tsunami.cc
 235         dev/tsunami_cchip.cc
 236         dev/tsunami_io.cc
 237         dev/tsunami_pchip.cc
 238
 239         dev/uart.cc
 240         dev/uart8250.cc
 241
 242         kern/kernel_stats.cc
 243         kern/system_events.cc
 244         kern/linux/events.cc
 245         kern/linux/linux_syscalls.cc
 246         kern/linux/printk.cc
 247
 248         mem/vport.cc
 249
 250         sim/pseudo_inst.cc
 251         ''')
 252         #dev/sinic.cc
 253         #dev/i8254xGBe.cc
 254
 255
 256 if env['TARGET_ISA'] == 'alpha':
 257     full_system_sources += Split('''
 258         kern/tru64/dump_mbuf.cc
 259         kern/tru64/printf.cc
 260         kern/tru64/tru64_events.cc
 261         kern/tru64/tru64_syscalls.cc
 262         ''')
 263
 264 # turbolaser encumbered sources
 265 turbolaser_sources = Split('''
 266         encumbered/dev/dma.cc
 267         encumbered/dev/etherdev.cc
 268         encumbered/dev/scsi.cc
 269         encumbered/dev/scsi_ctrl.cc
 270         encumbered/dev/scsi_disk.cc
 271         encumbered/dev/scsi_none.cc
 272         encumbered/dev/tlaser_clock.cc
 273         encumbered/dev/tlaser_ipi.cc
 274         encumbered/dev/tlaser_mbox.cc
 275         encumbered/dev/tlaser_mc146818.cc
 276         encumbered/dev/tlaser_node.cc
 277         encumbered/dev/tlaser_pcia.cc
 278         encumbered/dev/tlaser_pcidev.cc
 279         encumbered/dev/tlaser_serial.cc
 280         encumbered/dev/turbolaser.cc
 281         encumbered/dev/uart8530.cc
 282         ''')
 283
 284 # Syscall emulation (non-full-system) sources
 285 syscall_emulation_sources = Split('''
 286         mem/translating_port.cc
 287         mem/page_table.cc
 288         sim/process.cc
 289         sim/syscall_emul.cc
 290         ''')
 291
 292 #if env['TARGET_ISA'] == 'alpha':
 293 #    syscall_emulation_sources += Split('''
 294 #        kern/tru64/tru64.cc
 295 #        ''')
 296
 297 alpha_eio_sources = Split('''
 298         encumbered/eio/exolex.cc
 299         encumbered/eio/libexo.cc
 300         encumbered/eio/eio.cc
 301         ''')
 302
 303 if env['TARGET_ISA'] == 'alpha':
 304     syscall_emulation_sources += alpha_eio_sources
 305
 306 memtest_sources = Split('''
 307         cpu/memtest/memtest.cc
 308         ''')
 309
 310 # Include file paths are rooted in this directory.  SCons will
 311 # automatically expand '.' to refer to both the source directory and
 312 # the corresponding build directory to pick up generated include
 313 # files.
 314 env.Append(CPPPATH=Dir('.'))
 315
 316 # Add a flag defining what THE_ISA should be for all compilation
 317 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
 318
 319 arch_sources = SConscript('arch/SConscript', exports = 'env')
 320
 321 cpu_sources = SConscript('cpu/SConscript', exports = 'env')
 322
 323 # This is outside of cpu/SConscript since the source directory isn't
 324 # underneath 'cpu'.
 325 if 'FullCPU' in env['CPU_MODELS']:
 326     cpu_sources += full_cpu_sources
 327
 328 # Set up complete list of sources based on configuration.
 329 sources = base_sources + arch_sources + cpu_sources
 330
 331 if env['FULL_SYSTEM']:
 332     sources += full_system_sources
 333     if env['ALPHA_TLASER']:
 334         sources += turbolaser_sources
 335 else:
 336     sources += syscall_emulation_sources
 337
 338 if env['USE_MYSQL']:
 339     sources += mysql_sources
 340
 341 for opt in env.ExportOptions:
 342     env.ConfigFile(opt)
 343
 344 ###################################################
 345 #
 346 # Special build rules.
 347 #
 348 ###################################################
 349
 350 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
 351 # $TARGET.base will expand to "<build-dir>/base/traceflags".
 352 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
 353             'base/traceflags.py',
 354             'python $SOURCE $TARGET.base')
 355
 356 SConscript('python/SConscript', exports = ['env'])
 357
 358 # This function adds the specified sources to the given build
 359 # environment, and returns a list of all the corresponding SCons
 360 # Object nodes (including an extra one for date.cc).  We explicitly
 361 # add the Object nodes so we can set up special dependencies for
 362 # date.cc.
 363 def make_objs(sources, env):
 364     objs = [env.Object(s) for s in sources]
 365     # make date.cc depend on all other objects so it always gets
 366     # recompiled whenever anything else does
 367     date_obj = env.Object('base/date.cc')
 368     env.Depends(date_obj, objs)
 369     objs.append(date_obj)
 370     return objs
 371
 372 ###################################################
 373 #
 374 # Define binaries.  Each different build type (debug, opt, etc.) gets
 375 # a slightly different build environment.
 376 #
 377 ###################################################
 378
 379 # List of constructed environments to pass back to SConstruct
 380 envList = []
 381
 382 # Function to create a new build environment as clone of current
 383 # environment 'env' with modified object suffix and optional stripped
 384 # binary.  Additional keyword arguments are appended to corresponding
 385 # build environment vars.
 386 def makeEnv(label, objsfx, strip = False, **kwargs):
 387     newEnv = env.Copy(OBJSUFFIX=objsfx)
 388     newEnv.Label = label
 389     newEnv.Append(**kwargs)
 390     exe = 'm5.' + label  # final executable
 391     bin = exe + '.bin'   # executable w/o appended Python zip archive
 392     newEnv.Program(bin, make_objs(sources, newEnv))
 393     if strip:
 394         stripped_bin = bin + '.stripped'
 395         newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
 396         bin = stripped_bin
 397     targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
 398     newEnv.M5Binary = targets[0]
 399     envList.append(newEnv)
 400
 401 # Debug binary
 402 # Solaris seems to have some issue with DWARF2 debugging information, it's ok
 403 # with stabs though
 404 if sys.platform == 'sunos5':
 405    debug_flag = '-gstabs+'
 406 else:
 407    debug_flag = '-ggdb3'
 408
 409 makeEnv('debug', '.do',
 410         CCFLAGS = Split('%s -O0' % debug_flag),
 411         CPPDEFINES = 'DEBUG')
 412
 413 # Optimized binary
 414 makeEnv('opt', '.o',
 415         CCFLAGS = Split('-g -O3'))
 416
 417 # "Fast" binary
 418 makeEnv('fast', '.fo', strip = True,
 419         CCFLAGS = Split('-O3'),
 420         CPPDEFINES = 'NDEBUG')
 421
 422 # Profiled binary
 423 makeEnv('prof', '.po',
 424         CCFLAGS = Split('-O3 -g -pg'),
 425         LINKFLAGS = '-pg')
 426
 427 Return('envList')