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('''
72 base/compression/lzss_compression.cc
73 base/loader/aout_object.cc
74 base/loader/ecoff_object.cc
75 base/loader/elf_object.cc
76 base/loader/object_file.cc
92 cpu/sampler/sampler.cc
108 python/swig/cc_main_wrap.cc
121 # Old FullCPU sources
122 full_cpu_sources = Split('''
123 encumbered/cpu/full/bpred.cc
124 encumbered/cpu/full/commit.cc
125 encumbered/cpu/full/cpu.cc
126 encumbered/cpu/full/create_vector.cc
127 encumbered/cpu/full/cv_spec_state.cc
128 encumbered/cpu/full/dd_queue.cc
129 encumbered/cpu/full/dep_link.cc
130 encumbered/cpu/full/dispatch.cc
131 encumbered/cpu/full/dyn_inst.cc
132 encumbered/cpu/full/execute.cc
133 encumbered/cpu/full/fetch.cc
134 encumbered/cpu/full/floss_reasons.cc
135 encumbered/cpu/full/fu_pool.cc
136 encumbered/cpu/full/inst_fifo.cc
137 encumbered/cpu/full/instpipe.cc
138 encumbered/cpu/full/issue.cc
139 encumbered/cpu/full/ls_queue.cc
140 encumbered/cpu/full/machine_queue.cc
141 encumbered/cpu/full/pipetrace.cc
142 encumbered/cpu/full/readyq.cc
143 encumbered/cpu/full/reg_info.cc
144 encumbered/cpu/full/rob_station.cc
145 encumbered/cpu/full/spec_memory.cc
146 encumbered/cpu/full/spec_state.cc
147 encumbered/cpu/full/storebuffer.cc
148 encumbered/cpu/full/writeback.cc
149 encumbered/cpu/full/iq/iq_station.cc
150 encumbered/cpu/full/iq/iqueue.cc
151 encumbered/cpu/full/iq/segmented/chain_info.cc
152 encumbered/cpu/full/iq/segmented/chain_wire.cc
153 encumbered/cpu/full/iq/segmented/iq_seg.cc
154 encumbered/cpu/full/iq/segmented/iq_segmented.cc
155 encumbered/cpu/full/iq/segmented/seg_chain.cc
156 encumbered/cpu/full/iq/seznec/iq_seznec.cc
157 encumbered/cpu/full/iq/standard/iq_standard.cc
160 trace_reader_sources = Split('''
161 cpu/trace/reader/mem_trace_reader.cc
162 cpu/trace/reader/ibm_reader.cc
163 cpu/trace/reader/itx_reader.cc
164 cpu/trace/reader/m5_reader.cc
166 cpu/trace/trace_cpu.cc
172 mysql_sources = Split('''
177 # Full-system sources
178 full_system_sources = Split('''
218 kern/system_events.cc
220 kern/linux/linux_syscalls.cc
229 if env['TARGET_ISA'] == 'alpha':
230 full_system_sources += Split('''
231 kern/tru64/dump_mbuf.cc
233 kern/tru64/tru64_events.cc
234 kern/tru64/tru64_syscalls.cc
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
257 # Syscall emulation (non-full-system) sources
258 syscall_emulation_sources = Split('''
259 mem/translating_port.cc
265 #if env['TARGET_ISA'] == 'alpha':
266 # syscall_emulation_sources += Split('''
267 # kern/tru64/tru64.cc
270 alpha_eio_sources = Split('''
271 encumbered/eio/exolex.cc
272 encumbered/eio/libexo.cc
273 encumbered/eio/eio.cc
276 if env['TARGET_ISA'] == 'ALPHA_ISA':
277 syscall_emulation_sources += alpha_eio_sources
279 memtest_sources = Split('''
280 cpu/memtest/memtest.cc
283 # Include file paths are rooted in this directory. SCons will
284 # automatically expand '.' to refer to both the source directory and
285 # the corresponding build directory to pick up generated include
287 env.Append(CPPPATH=Dir('.'))
289 # Add a flag defining what THE_ISA should be for all compilation
290 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
292 arch_sources = SConscript('arch/SConscript', exports = 'env')
294 cpu_sources = SConscript('cpu/SConscript', exports = 'env')
296 # This is outside of cpu/SConscript since the source directory isn't
298 if 'FullCPU' in env['CPU_MODELS']:
299 cpu_sources += full_cpu_sources
301 # Set up complete list of sources based on configuration.
302 sources = base_sources + arch_sources + cpu_sources
304 if env['FULL_SYSTEM']:
305 sources += full_system_sources
306 if env['ALPHA_TLASER']:
307 sources += turbolaser_sources
309 sources += syscall_emulation_sources
312 sources += mysql_sources
314 for opt in env.ExportOptions:
317 ###################################################
319 # Special build rules.
321 ###################################################
323 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
324 # $TARGET.base will expand to "<build-dir>/base/traceflags".
325 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
326 'base/traceflags.py',
327 'python $SOURCE $TARGET.base')
329 SConscript('python/SConscript', exports = ['env'])
331 # This function adds the specified sources to the given build
332 # environment, and returns a list of all the corresponding SCons
333 # Object nodes (including an extra one for date.cc). We explicitly
334 # add the Object nodes so we can set up special dependencies for
336 def make_objs(sources, env):
337 objs = [env.Object(s) for s in sources]
338 # make date.cc depend on all other objects so it always gets
339 # recompiled whenever anything else does
340 date_obj = env.Object('base/date.cc')
341 env.Depends(date_obj, objs)
342 objs.append(date_obj)
345 ###################################################
347 # Define binaries. Each different build type (debug, opt, etc.) gets
348 # a slightly different build environment.
350 ###################################################
352 # List of constructed environments to pass back to SConstruct
355 # Function to create a new build environment as clone of current
356 # environment 'env' with modified object suffix and optional stripped
357 # binary. Additional keyword arguments are appended to corresponding
358 # build environment vars.
359 def makeEnv(label, objsfx, strip = False, **kwargs):
360 newEnv = env.Copy(OBJSUFFIX=objsfx)
362 newEnv.Append(**kwargs)
363 exe = 'm5.' + label # final executable
364 bin = exe + '.bin' # executable w/o appended Python zip archive
365 newEnv.Program(bin, make_objs(sources, newEnv))
367 stripped_bin = bin + '.stripped'
368 newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
370 targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
371 newEnv.M5Binary = targets[0]
372 envList.append(newEnv)
375 makeEnv('debug', '.do',
376 CCFLAGS = Split('-g3 -gdwarf-2 -O0'),
377 CPPDEFINES = 'DEBUG')
381 CCFLAGS = Split('-g -O3'))
384 makeEnv('fast', '.fo', strip = True,
385 CCFLAGS = Split('-O3'),
386 CPPDEFINES = 'NDEBUG')
389 makeEnv('prof', '.po',
390 CCFLAGS = Split('-O3 -g -pg'),