3 # Copyright (c) 2004-2005 The Regents of The University of Michigan
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.
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.
29 # Authors: Steve Reinhardt
33 from os.path import isdir
35 # This file defines how to build a particular configuration of M5
36 # based on variable settings in the 'env' build environment.
38 # Import build environment variable from SConstruct.
41 ###################################################
43 # Define needed sources.
45 ###################################################
47 # Base sources used by all configurations.
49 base_sources = Split('''
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
92 cpu/sampler/sampler.cc
96 encumbered/cpu/full/fu_pool.cc
110 python/swig/main_wrap.cc
124 # Old FullCPU sources
125 full_cpu_sources = Split('''
126 encumbered/cpu/full/bpred.cc
127 encumbered/cpu/full/commit.cc
128 encumbered/cpu/full/cpu.cc
129 encumbered/cpu/full/create_vector.cc
130 encumbered/cpu/full/cv_spec_state.cc
131 encumbered/cpu/full/dd_queue.cc
132 encumbered/cpu/full/dep_link.cc
133 encumbered/cpu/full/dispatch.cc
134 encumbered/cpu/full/dyn_inst.cc
135 encumbered/cpu/full/execute.cc
136 encumbered/cpu/full/fetch.cc
137 encumbered/cpu/full/floss_reasons.cc
138 encumbered/cpu/full/fu_pool.cc
139 encumbered/cpu/full/inst_fifo.cc
140 encumbered/cpu/full/instpipe.cc
141 encumbered/cpu/full/issue.cc
142 encumbered/cpu/full/ls_queue.cc
143 encumbered/cpu/full/machine_queue.cc
144 encumbered/cpu/full/pipetrace.cc
145 encumbered/cpu/full/readyq.cc
146 encumbered/cpu/full/reg_info.cc
147 encumbered/cpu/full/rob_station.cc
148 encumbered/cpu/full/spec_memory.cc
149 encumbered/cpu/full/spec_state.cc
150 encumbered/cpu/full/storebuffer.cc
151 encumbered/cpu/full/writeback.cc
152 encumbered/cpu/full/iq/iq_station.cc
153 encumbered/cpu/full/iq/iqueue.cc
154 encumbered/cpu/full/iq/segmented/chain_info.cc
155 encumbered/cpu/full/iq/segmented/chain_wire.cc
156 encumbered/cpu/full/iq/segmented/iq_seg.cc
157 encumbered/cpu/full/iq/segmented/iq_segmented.cc
158 encumbered/cpu/full/iq/segmented/seg_chain.cc
159 encumbered/cpu/full/iq/seznec/iq_seznec.cc
160 encumbered/cpu/full/iq/standard/iq_standard.cc
163 trace_reader_sources = Split('''
164 cpu/trace/reader/mem_trace_reader.cc
165 cpu/trace/reader/ibm_reader.cc
166 cpu/trace/reader/itx_reader.cc
167 cpu/trace/reader/m5_reader.cc
169 cpu/trace/trace_cpu.cc
175 mysql_sources = Split('''
180 # Full-system sources
181 full_system_sources = Split('''
221 kern/system_events.cc
223 kern/linux/linux_syscalls.cc
232 if env['TARGET_ISA'] == 'alpha':
233 full_system_sources += Split('''
234 kern/tru64/dump_mbuf.cc
236 kern/tru64/tru64_events.cc
237 kern/tru64/tru64_syscalls.cc
240 # turbolaser encumbered sources
241 turbolaser_sources = Split('''
242 encumbered/dev/dma.cc
243 encumbered/dev/etherdev.cc
244 encumbered/dev/scsi.cc
245 encumbered/dev/scsi_ctrl.cc
246 encumbered/dev/scsi_disk.cc
247 encumbered/dev/scsi_none.cc
248 encumbered/dev/tlaser_clock.cc
249 encumbered/dev/tlaser_ipi.cc
250 encumbered/dev/tlaser_mbox.cc
251 encumbered/dev/tlaser_mc146818.cc
252 encumbered/dev/tlaser_node.cc
253 encumbered/dev/tlaser_pcia.cc
254 encumbered/dev/tlaser_pcidev.cc
255 encumbered/dev/tlaser_serial.cc
256 encumbered/dev/turbolaser.cc
257 encumbered/dev/uart8530.cc
260 # Syscall emulation (non-full-system) sources
261 syscall_emulation_sources = Split('''
262 mem/translating_port.cc
268 #if env['TARGET_ISA'] == 'alpha':
269 # syscall_emulation_sources += Split('''
270 # kern/tru64/tru64.cc
273 alpha_eio_sources = Split('''
274 encumbered/eio/exolex.cc
275 encumbered/eio/libexo.cc
276 encumbered/eio/eio.cc
279 if env['TARGET_ISA'] == 'ALPHA_ISA':
280 syscall_emulation_sources += alpha_eio_sources
282 memtest_sources = Split('''
283 cpu/memtest/memtest.cc
286 # Include file paths are rooted in this directory. SCons will
287 # automatically expand '.' to refer to both the source directory and
288 # the corresponding build directory to pick up generated include
290 env.Append(CPPPATH=Dir('.'))
292 # Add a flag defining what THE_ISA should be for all compilation
293 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
295 arch_sources = SConscript('arch/SConscript', exports = 'env')
297 cpu_sources = SConscript('cpu/SConscript', exports = 'env')
299 # This is outside of cpu/SConscript since the source directory isn't
301 if 'FullCPU' in env['CPU_MODELS']:
302 cpu_sources += full_cpu_sources
304 # Set up complete list of sources based on configuration.
305 sources = base_sources + arch_sources + cpu_sources
307 if env['FULL_SYSTEM']:
308 sources += full_system_sources
309 if env['ALPHA_TLASER']:
310 sources += turbolaser_sources
312 sources += syscall_emulation_sources
315 sources += mysql_sources
317 for opt in env.ExportOptions:
320 ###################################################
322 # Special build rules.
324 ###################################################
326 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
327 # $TARGET.base will expand to "<build-dir>/base/traceflags".
328 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
329 'base/traceflags.py',
330 'python $SOURCE $TARGET.base')
332 SConscript('python/SConscript', exports = ['env'])
334 # This function adds the specified sources to the given build
335 # environment, and returns a list of all the corresponding SCons
336 # Object nodes (including an extra one for date.cc). We explicitly
337 # add the Object nodes so we can set up special dependencies for
339 def make_objs(sources, env):
340 objs = [env.Object(s) for s in sources]
341 # make date.cc depend on all other objects so it always gets
342 # recompiled whenever anything else does
343 date_obj = env.Object('base/date.cc')
344 env.Depends(date_obj, objs)
345 objs.append(date_obj)
348 ###################################################
350 # Define binaries. Each different build type (debug, opt, etc.) gets
351 # a slightly different build environment.
353 ###################################################
355 # List of constructed environments to pass back to SConstruct
358 # Function to create a new build environment as clone of current
359 # environment 'env' with modified object suffix and optional stripped
360 # binary. Additional keyword arguments are appended to corresponding
361 # build environment vars.
362 def makeEnv(label, objsfx, strip = False, **kwargs):
363 newEnv = env.Copy(OBJSUFFIX=objsfx)
365 newEnv.Append(**kwargs)
366 exe = 'm5.' + label # final executable
367 bin = exe + '.bin' # executable w/o appended Python zip archive
368 newEnv.Program(bin, make_objs(sources, newEnv))
370 stripped_bin = bin + '.stripped'
371 newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
373 targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
374 newEnv.M5Binary = targets[0]
375 envList.append(newEnv)
378 makeEnv('debug', '.do',
379 CCFLAGS = Split('-g3 -gdwarf-2 -O0'),
380 CPPDEFINES = 'DEBUG')
384 CCFLAGS = Split('-g -O3'))
387 makeEnv('fast', '.fo', strip = True,
388 CCFLAGS = Split('-O3'),
389 CPPDEFINES = 'NDEBUG')
392 makeEnv('prof', '.po',
393 CCFLAGS = Split('-O3 -g -pg'),