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 isfile, join as joinpath
  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 trace_reader_sources = Split('''
 150         cpu/trace/reader/mem_trace_reader.cc
 151         cpu/trace/reader/ibm_reader.cc
 152         cpu/trace/reader/itx_reader.cc
 153         cpu/trace/reader/m5_reader.cc
 154         cpu/trace/opt_cpu.cc
 155         cpu/trace/trace_cpu.cc
 156         ''')
 157
 158
 159
 160 # MySql sources
 161 mysql_sources = Split('''
 162         base/mysql.cc
 163         base/stats/mysql.cc
 164         ''')
 165
 166 # Full-system sources
 167 full_system_sources = Split('''
 168         base/crc.cc
 169         base/inet.cc
 170         base/remote_gdb.cc
 171
 172         cpu/intr_control.cc
 173         cpu/profile.cc
 174
 175         dev/uart.cc
 176         dev/uart8250.cc
 177
 178         mem/vport.cc
 179
 180         sim/pseudo_inst.cc
 181         ''')
 182         #dev/sinic.cc
 183         #dev/i8254xGBe.cc
 184
 185 if env['TARGET_ISA'] == 'alpha':
 186     full_system_sources += Split('''
 187         kern/tru64/dump_mbuf.cc
 188         kern/tru64/printf.cc
 189         kern/tru64/tru64_events.cc
 190         kern/tru64/tru64_syscalls.cc
 191         ''')
 192
 193 # Syscall emulation (non-full-system) sources
 194 syscall_emulation_sources = Split('''
 195         mem/translating_port.cc
 196         mem/page_table.cc
 197         sim/process.cc
 198         sim/syscall_emul.cc
 199         ''')
 200
 201 #if env['TARGET_ISA'] == 'alpha':
 202 #    syscall_emulation_sources += Split('''
 203 #        kern/tru64/tru64.cc
 204 #        ''')
 205
 206 memtest_sources = Split('''
 207         cpu/memtest/memtest.cc
 208         ''')
 209
 210 # Include file paths are rooted in this directory.  SCons will
 211 # automatically expand '.' to refer to both the source directory and
 212 # the corresponding build directory to pick up generated include
 213 # files.
 214 env.Append(CPPPATH=Dir('.'))
 215
 216 # Add a flag defining what THE_ISA should be for all compilation
 217 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
 218
 219 arch_sources = SConscript(os.path.join('arch', 'SConscript'), exports = 'env')
 220
 221 cpu_sources = SConscript(os.path.join('cpu', 'SConscript'), exports = 'env')
 222
 223 if env['FULL_SYSTEM']:
 224     dev_sources = SConscript(os.path.join('dev', 'SConscript'),
 225                              exports = 'env')
 226     full_system_sources += dev_sources
 227
 228     kern_sources = SConscript(os.path.join('kern', 'SConscript'),
 229                               exports = 'env')
 230     full_system_sources += kern_sources
 231
 232 # Set up complete list of sources based on configuration.
 233 sources = base_sources + arch_sources + cpu_sources
 234
 235 # encumbered should be last because we're adding to some of the other groups
 236 if isfile(joinpath(env['SRCDIR'], 'encumbered/SConscript')):
 237     sources += SConscript('encumbered/SConscript', exports = 'env')
 238
 239
 240 if env['FULL_SYSTEM']:
 241     sources += full_system_sources
 242 else:
 243     sources += syscall_emulation_sources
 244
 245 if env['USE_MYSQL']:
 246     sources += mysql_sources
 247
 248 for opt in env.ExportOptions:
 249     env.ConfigFile(opt)
 250
 251 ###################################################
 252 #
 253 # Special build rules.
 254 #
 255 ###################################################
 256
 257 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
 258 # $TARGET.base will expand to "<build-dir>/base/traceflags".
 259 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
 260             'base/traceflags.py',
 261             'python $SOURCE $TARGET.base')
 262
 263 SConscript('python/SConscript', exports = ['env'])
 264
 265 # This function adds the specified sources to the given build
 266 # environment, and returns a list of all the corresponding SCons
 267 # Object nodes (including an extra one for date.cc).  We explicitly
 268 # add the Object nodes so we can set up special dependencies for
 269 # date.cc.
 270 def make_objs(sources, env):
 271     objs = [env.Object(s) for s in sources]
 272     # make date.cc depend on all other objects so it always gets
 273     # recompiled whenever anything else does
 274     date_obj = env.Object('base/date.cc')
 275     env.Depends(date_obj, objs)
 276     objs.append(date_obj)
 277     return objs
 278
 279 ###################################################
 280 #
 281 # Define binaries.  Each different build type (debug, opt, etc.) gets
 282 # a slightly different build environment.
 283 #
 284 ###################################################
 285
 286 # List of constructed environments to pass back to SConstruct
 287 envList = []
 288
 289 # Function to create a new build environment as clone of current
 290 # environment 'env' with modified object suffix and optional stripped
 291 # binary.  Additional keyword arguments are appended to corresponding
 292 # build environment vars.
 293 def makeEnv(label, objsfx, strip = False, **kwargs):
 294     newEnv = env.Copy(OBJSUFFIX=objsfx)
 295     newEnv.Label = label
 296     newEnv.Append(**kwargs)
 297     exe = 'm5.' + label  # final executable
 298     bin = exe + '.bin'   # executable w/o appended Python zip archive
 299     newEnv.Program(bin, make_objs(sources, newEnv))
 300     if strip:
 301         stripped_bin = bin + '.stripped'
 302         newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
 303         bin = stripped_bin
 304     targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
 305     newEnv.M5Binary = targets[0]
 306     envList.append(newEnv)
 307
 308 # Debug binary
 309 # Solaris seems to have some issue with DWARF2 debugging information, it's ok
 310 # with stabs though
 311 if sys.platform == 'sunos5':
 312    debug_flag = '-gstabs+'
 313 else:
 314    debug_flag = '-ggdb3'
 315
 316 makeEnv('debug', '.do',
 317         CCFLAGS = Split('%s -O0' % debug_flag),
 318         CPPDEFINES = 'DEBUG')
 319
 320 # Optimized binary
 321 makeEnv('opt', '.o',
 322         CCFLAGS = Split('-g -O3'))
 323
 324 # "Fast" binary
 325 makeEnv('fast', '.fo', strip = True,
 326         CCFLAGS = Split('-O3'),
 327         CPPDEFINES = 'NDEBUG')
 328
 329 # Profiled binary
 330 makeEnv('prof', '.po',
 331         CCFLAGS = Split('-O3 -g -pg'),
 332         LINKFLAGS = '-pg')
 333
 334 Return('envList')