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