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
105 mem/cache/base_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
129 mem/cache/cache_builder.cc
136 python/swig/cc_main_wrap.cc
149 # Old FullCPU sources
150 full_cpu_sources = Split('''
151 encumbered/cpu/full/bpred.cc
152 encumbered/cpu/full/commit.cc
153 encumbered/cpu/full/cpu.cc
154 encumbered/cpu/full/create_vector.cc
155 encumbered/cpu/full/cv_spec_state.cc
156 encumbered/cpu/full/dd_queue.cc
157 encumbered/cpu/full/dep_link.cc
158 encumbered/cpu/full/dispatch.cc
159 encumbered/cpu/full/dyn_inst.cc
160 encumbered/cpu/full/execute.cc
161 encumbered/cpu/full/fetch.cc
162 encumbered/cpu/full/floss_reasons.cc
163 encumbered/cpu/full/fu_pool.cc
164 encumbered/cpu/full/inst_fifo.cc
165 encumbered/cpu/full/instpipe.cc
166 encumbered/cpu/full/issue.cc
167 encumbered/cpu/full/ls_queue.cc
168 encumbered/cpu/full/machine_queue.cc
169 encumbered/cpu/full/pipetrace.cc
170 encumbered/cpu/full/readyq.cc
171 encumbered/cpu/full/reg_info.cc
172 encumbered/cpu/full/rob_station.cc
173 encumbered/cpu/full/spec_memory.cc
174 encumbered/cpu/full/spec_state.cc
175 encumbered/cpu/full/storebuffer.cc
176 encumbered/cpu/full/writeback.cc
177 encumbered/cpu/full/iq/iq_station.cc
178 encumbered/cpu/full/iq/iqueue.cc
179 encumbered/cpu/full/iq/segmented/chain_info.cc
180 encumbered/cpu/full/iq/segmented/chain_wire.cc
181 encumbered/cpu/full/iq/segmented/iq_seg.cc
182 encumbered/cpu/full/iq/segmented/iq_segmented.cc
183 encumbered/cpu/full/iq/segmented/seg_chain.cc
184 encumbered/cpu/full/iq/seznec/iq_seznec.cc
185 encumbered/cpu/full/iq/standard/iq_standard.cc
188 trace_reader_sources = Split('''
189 cpu/trace/reader/mem_trace_reader.cc
190 cpu/trace/reader/ibm_reader.cc
191 cpu/trace/reader/itx_reader.cc
192 cpu/trace/reader/m5_reader.cc
194 cpu/trace/trace_cpu.cc
200 mysql_sources = Split('''
205 # Full-system sources
206 full_system_sources = Split('''
224 if env['TARGET_ISA'] == 'alpha':
225 full_system_sources += Split('''
226 kern/tru64/dump_mbuf.cc
228 kern/tru64/tru64_events.cc
229 kern/tru64/tru64_syscalls.cc
232 # turbolaser encumbered sources
233 turbolaser_sources = Split('''
234 encumbered/dev/dma.cc
235 encumbered/dev/etherdev.cc
236 encumbered/dev/scsi.cc
237 encumbered/dev/scsi_ctrl.cc
238 encumbered/dev/scsi_disk.cc
239 encumbered/dev/scsi_none.cc
240 encumbered/dev/tlaser_clock.cc
241 encumbered/dev/tlaser_ipi.cc
242 encumbered/dev/tlaser_mbox.cc
243 encumbered/dev/tlaser_mc146818.cc
244 encumbered/dev/tlaser_node.cc
245 encumbered/dev/tlaser_pcia.cc
246 encumbered/dev/tlaser_pcidev.cc
247 encumbered/dev/tlaser_serial.cc
248 encumbered/dev/turbolaser.cc
249 encumbered/dev/uart8530.cc
252 # Syscall emulation (non-full-system) sources
253 syscall_emulation_sources = Split('''
254 mem/translating_port.cc
260 #if env['TARGET_ISA'] == 'alpha':
261 # syscall_emulation_sources += Split('''
262 # kern/tru64/tru64.cc
265 alpha_eio_sources = Split('''
266 encumbered/eio/exolex.cc
267 encumbered/eio/libexo.cc
268 encumbered/eio/eio.cc
271 if env['TARGET_ISA'] == 'alpha':
272 syscall_emulation_sources += alpha_eio_sources
274 memtest_sources = Split('''
275 cpu/memtest/memtest.cc
278 # Include file paths are rooted in this directory. SCons will
279 # automatically expand '.' to refer to both the source directory and
280 # the corresponding build directory to pick up generated include
282 env.Append(CPPPATH=Dir('.'))
284 # Add a flag defining what THE_ISA should be for all compilation
285 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
287 arch_sources = SConscript(os.path.join('arch', 'SConscript'), exports = 'env')
289 cpu_sources = SConscript(os.path.join('cpu', 'SConscript'), exports = 'env')
291 if env['FULL_SYSTEM']:
292 dev_sources = SConscript(os.path.join('dev', 'SConscript'), exports = 'env')
293 full_system_sources += dev_sources
295 kern_sources = SConscript(os.path.join('kern', 'SConscript'), exports = 'env')
296 full_system_sources += kern_sources
298 # This is outside of cpu/SConscript since the source directory isn't
300 if 'FullCPU' in env['CPU_MODELS']:
301 cpu_sources += full_cpu_sources
303 # Set up complete list of sources based on configuration.
304 sources = base_sources + arch_sources + cpu_sources
306 if env['FULL_SYSTEM']:
307 sources += full_system_sources
308 if env['ALPHA_TLASER']:
309 sources += turbolaser_sources
311 sources += syscall_emulation_sources
314 sources += mysql_sources
316 for opt in env.ExportOptions:
319 ###################################################
321 # Special build rules.
323 ###################################################
325 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
326 # $TARGET.base will expand to "<build-dir>/base/traceflags".
327 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
328 'base/traceflags.py',
329 'python $SOURCE $TARGET.base')
331 SConscript('python/SConscript', exports = ['env'])
333 # This function adds the specified sources to the given build
334 # environment, and returns a list of all the corresponding SCons
335 # Object nodes (including an extra one for date.cc). We explicitly
336 # add the Object nodes so we can set up special dependencies for
338 def make_objs(sources, env):
339 objs = [env.Object(s) for s in sources]
340 # make date.cc depend on all other objects so it always gets
341 # recompiled whenever anything else does
342 date_obj = env.Object('base/date.cc')
343 env.Depends(date_obj, objs)
344 objs.append(date_obj)
347 ###################################################
349 # Define binaries. Each different build type (debug, opt, etc.) gets
350 # a slightly different build environment.
352 ###################################################
354 # List of constructed environments to pass back to SConstruct
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)
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))
369 stripped_bin = bin + '.stripped'
370 newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
372 targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
373 newEnv.M5Binary = targets[0]
374 envList.append(newEnv)
377 makeEnv('debug', '.do',
378 CCFLAGS = Split('-g3 -gdwarf-2 -O0'),
379 CPPDEFINES = 'DEBUG')
383 CCFLAGS = Split('-g -O3'))
386 makeEnv('fast', '.fo', strip = True,
387 CCFLAGS = Split('-O3'),
388 CPPDEFINES = 'NDEBUG')
391 makeEnv('prof', '.po',
392 CCFLAGS = Split('-O3 -g -pg'),