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
112 python/swig/main_wrap.cc
126 # Old FullCPU sources
127 full_cpu_sources = Split('''
128 encumbered/cpu/full/bpred.cc
129 encumbered/cpu/full/commit.cc
130 encumbered/cpu/full/cpu.cc
131 encumbered/cpu/full/create_vector.cc
132 encumbered/cpu/full/cv_spec_state.cc
133 encumbered/cpu/full/dd_queue.cc
134 encumbered/cpu/full/dep_link.cc
135 encumbered/cpu/full/dispatch.cc
136 encumbered/cpu/full/dyn_inst.cc
137 encumbered/cpu/full/execute.cc
138 encumbered/cpu/full/fetch.cc
139 encumbered/cpu/full/floss_reasons.cc
140 encumbered/cpu/full/fu_pool.cc
141 encumbered/cpu/full/inst_fifo.cc
142 encumbered/cpu/full/instpipe.cc
143 encumbered/cpu/full/issue.cc
144 encumbered/cpu/full/ls_queue.cc
145 encumbered/cpu/full/machine_queue.cc
146 encumbered/cpu/full/pipetrace.cc
147 encumbered/cpu/full/readyq.cc
148 encumbered/cpu/full/reg_info.cc
149 encumbered/cpu/full/rob_station.cc
150 encumbered/cpu/full/spec_memory.cc
151 encumbered/cpu/full/spec_state.cc
152 encumbered/cpu/full/storebuffer.cc
153 encumbered/cpu/full/writeback.cc
154 encumbered/cpu/full/iq/iq_station.cc
155 encumbered/cpu/full/iq/iqueue.cc
156 encumbered/cpu/full/iq/segmented/chain_info.cc
157 encumbered/cpu/full/iq/segmented/chain_wire.cc
158 encumbered/cpu/full/iq/segmented/iq_seg.cc
159 encumbered/cpu/full/iq/segmented/iq_segmented.cc
160 encumbered/cpu/full/iq/segmented/seg_chain.cc
161 encumbered/cpu/full/iq/seznec/iq_seznec.cc
162 encumbered/cpu/full/iq/standard/iq_standard.cc
165 trace_reader_sources = Split('''
166 cpu/trace/reader/mem_trace_reader.cc
167 cpu/trace/reader/ibm_reader.cc
168 cpu/trace/reader/itx_reader.cc
169 cpu/trace/reader/m5_reader.cc
171 cpu/trace/trace_cpu.cc
177 mysql_sources = Split('''
182 # Full-system sources
183 full_system_sources = Split('''
222 kern/kernel_binning.cc
224 kern/system_events.cc
226 kern/linux/linux_syscalls.cc
235 if env['TARGET_ISA'] == 'alpha':
236 full_system_sources += Split('''
237 kern/tru64/dump_mbuf.cc
239 kern/tru64/tru64_events.cc
240 kern/tru64/tru64_syscalls.cc
243 # turbolaser encumbered sources
244 turbolaser_sources = Split('''
245 encumbered/dev/dma.cc
246 encumbered/dev/etherdev.cc
247 encumbered/dev/scsi.cc
248 encumbered/dev/scsi_ctrl.cc
249 encumbered/dev/scsi_disk.cc
250 encumbered/dev/scsi_none.cc
251 encumbered/dev/tlaser_clock.cc
252 encumbered/dev/tlaser_ipi.cc
253 encumbered/dev/tlaser_mbox.cc
254 encumbered/dev/tlaser_mc146818.cc
255 encumbered/dev/tlaser_node.cc
256 encumbered/dev/tlaser_pcia.cc
257 encumbered/dev/tlaser_pcidev.cc
258 encumbered/dev/tlaser_serial.cc
259 encumbered/dev/turbolaser.cc
260 encumbered/dev/uart8530.cc
263 # Syscall emulation (non-full-system) sources
264 syscall_emulation_sources = Split('''
265 mem/translating_port.cc
271 #if env['TARGET_ISA'] == 'alpha':
272 # syscall_emulation_sources += Split('''
273 # kern/tru64/tru64.cc
276 alpha_eio_sources = Split('''
277 encumbered/eio/exolex.cc
278 encumbered/eio/libexo.cc
279 encumbered/eio/eio.cc
282 if env['TARGET_ISA'] == 'ALPHA_ISA':
283 syscall_emulation_sources += alpha_eio_sources
285 memtest_sources = Split('''
286 cpu/memtest/memtest.cc
289 # Include file paths are rooted in this directory. SCons will
290 # automatically expand '.' to refer to both the source directory and
291 # the corresponding build directory to pick up generated include
293 env.Append(CPPPATH=Dir('.'))
295 # Add a flag defining what THE_ISA should be for all compilation
296 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
298 arch_sources = SConscript('arch/SConscript', exports = 'env')
300 cpu_sources = SConscript('cpu/SConscript', exports = 'env')
302 # This is outside of cpu/SConscript since the source directory isn't
304 if 'FullCPU' in env['CPU_MODELS']:
305 cpu_sources += full_cpu_sources
307 # Set up complete list of sources based on configuration.
308 sources = base_sources + arch_sources + cpu_sources
310 if env['FULL_SYSTEM']:
311 sources += full_system_sources
312 if env['ALPHA_TLASER']:
313 sources += turbolaser_sources
315 sources += syscall_emulation_sources
318 sources += mysql_sources
320 for opt in env.ExportOptions:
323 ###################################################
325 # Special build rules.
327 ###################################################
329 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
330 # $TARGET.base will expand to "<build-dir>/base/traceflags".
331 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
332 'base/traceflags.py',
333 'python $SOURCE $TARGET.base')
335 SConscript('python/SConscript', exports = ['env'])
337 # This function adds the specified sources to the given build
338 # environment, and returns a list of all the corresponding SCons
339 # Object nodes (including an extra one for date.cc). We explicitly
340 # add the Object nodes so we can set up special dependencies for
342 def make_objs(sources, env):
343 objs = [env.Object(s) for s in sources]
344 # make date.cc depend on all other objects so it always gets
345 # recompiled whenever anything else does
346 date_obj = env.Object('base/date.cc')
347 env.Depends(date_obj, objs)
348 objs.append(date_obj)
351 ###################################################
353 # Define binaries. Each different build type (debug, opt, etc.) gets
354 # a slightly different build environment.
356 ###################################################
358 # List of constructed environments to pass back to SConstruct
361 # Function to create a new build environment as clone of current
362 # environment 'env' with modified object suffix and optional stripped
363 # binary. Additional keyword arguments are appended to corresponding
364 # build environment vars.
365 def makeEnv(label, objsfx, strip = False, **kwargs):
366 newEnv = env.Copy(OBJSUFFIX=objsfx)
368 newEnv.Append(**kwargs)
369 exe = 'm5.' + label # final executable
370 bin = exe + '.bin' # executable w/o appended Python zip archive
371 newEnv.Program(bin, make_objs(sources, newEnv))
373 stripped_bin = bin + '.stripped'
374 newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
376 targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
377 newEnv.M5Binary = targets[0]
378 envList.append(newEnv)
381 makeEnv('debug', '.do',
382 CCFLAGS = Split('-g3 -gdwarf-2 -O0'),
383 CPPDEFINES = 'DEBUG')
387 CCFLAGS = Split('-g -O3'))
390 makeEnv('fast', '.fo', strip = True,
391 CCFLAGS = Split('-O3'),
392 CPPDEFINES = 'NDEBUG')
395 makeEnv('prof', '.po',
396 CCFLAGS = Split('-O3 -g -pg'),