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
102 mem/cache/base_cache.cc
104 mem/cache/coherence/coherence_protocol.cc
105 mem/cache/coherence/uni_coherence.cc
106 mem/cache/miss/blocking_buffer.cc
107 mem/cache/miss/miss_queue.cc
108 mem/cache/miss/mshr.cc
109 mem/cache/miss/mshr_queue.cc
110 mem/cache/prefetch/base_prefetcher.cc
111 mem/cache/prefetch/ghb_prefetcher.cc
112 mem/cache/prefetch/prefetcher.cc
113 mem/cache/prefetch/stride_prefetcher.cc
114 mem/cache/prefetch/tagged_prefetcher.cc
115 mem/cache/tags/base_tags.cc
116 mem/cache/tags/cache_tags.cc
117 mem/cache/tags/fa_lru.cc
118 mem/cache/tags/iic.cc
119 mem/cache/tags/lru.cc
120 mem/cache/tags/repl/gen.cc
121 mem/cache/tags/repl/repl.cc
122 mem/cache/tags/split.cc
123 mem/cache/tags/split_lifo.cc
124 mem/cache/tags/split_lru.cc
126 mem/cache/cache_builder.cc
133 python/swig/cc_main_wrap.cc
146 # Old FullCPU sources
147 full_cpu_sources = Split('''
148 encumbered/cpu/full/bpred.cc
149 encumbered/cpu/full/commit.cc
150 encumbered/cpu/full/cpu.cc
151 encumbered/cpu/full/create_vector.cc
152 encumbered/cpu/full/cv_spec_state.cc
153 encumbered/cpu/full/dd_queue.cc
154 encumbered/cpu/full/dep_link.cc
155 encumbered/cpu/full/dispatch.cc
156 encumbered/cpu/full/dyn_inst.cc
157 encumbered/cpu/full/execute.cc
158 encumbered/cpu/full/fetch.cc
159 encumbered/cpu/full/floss_reasons.cc
160 encumbered/cpu/full/fu_pool.cc
161 encumbered/cpu/full/inst_fifo.cc
162 encumbered/cpu/full/instpipe.cc
163 encumbered/cpu/full/issue.cc
164 encumbered/cpu/full/ls_queue.cc
165 encumbered/cpu/full/machine_queue.cc
166 encumbered/cpu/full/pipetrace.cc
167 encumbered/cpu/full/readyq.cc
168 encumbered/cpu/full/reg_info.cc
169 encumbered/cpu/full/rob_station.cc
170 encumbered/cpu/full/spec_memory.cc
171 encumbered/cpu/full/spec_state.cc
172 encumbered/cpu/full/storebuffer.cc
173 encumbered/cpu/full/writeback.cc
174 encumbered/cpu/full/iq/iq_station.cc
175 encumbered/cpu/full/iq/iqueue.cc
176 encumbered/cpu/full/iq/segmented/chain_info.cc
177 encumbered/cpu/full/iq/segmented/chain_wire.cc
178 encumbered/cpu/full/iq/segmented/iq_seg.cc
179 encumbered/cpu/full/iq/segmented/iq_segmented.cc
180 encumbered/cpu/full/iq/segmented/seg_chain.cc
181 encumbered/cpu/full/iq/seznec/iq_seznec.cc
182 encumbered/cpu/full/iq/standard/iq_standard.cc
185 trace_reader_sources = Split('''
186 cpu/trace/reader/mem_trace_reader.cc
187 cpu/trace/reader/ibm_reader.cc
188 cpu/trace/reader/itx_reader.cc
189 cpu/trace/reader/m5_reader.cc
191 cpu/trace/trace_cpu.cc
197 mysql_sources = Split('''
202 # Full-system sources
203 full_system_sources = Split('''
243 kern/system_events.cc
245 kern/linux/linux_syscalls.cc
254 if env['TARGET_ISA'] == 'alpha':
255 full_system_sources += Split('''
256 kern/tru64/dump_mbuf.cc
258 kern/tru64/tru64_events.cc
259 kern/tru64/tru64_syscalls.cc
262 # turbolaser encumbered sources
263 turbolaser_sources = Split('''
264 encumbered/dev/dma.cc
265 encumbered/dev/etherdev.cc
266 encumbered/dev/scsi.cc
267 encumbered/dev/scsi_ctrl.cc
268 encumbered/dev/scsi_disk.cc
269 encumbered/dev/scsi_none.cc
270 encumbered/dev/tlaser_clock.cc
271 encumbered/dev/tlaser_ipi.cc
272 encumbered/dev/tlaser_mbox.cc
273 encumbered/dev/tlaser_mc146818.cc
274 encumbered/dev/tlaser_node.cc
275 encumbered/dev/tlaser_pcia.cc
276 encumbered/dev/tlaser_pcidev.cc
277 encumbered/dev/tlaser_serial.cc
278 encumbered/dev/turbolaser.cc
279 encumbered/dev/uart8530.cc
282 # Syscall emulation (non-full-system) sources
283 syscall_emulation_sources = Split('''
284 mem/translating_port.cc
290 #if env['TARGET_ISA'] == 'alpha':
291 # syscall_emulation_sources += Split('''
292 # kern/tru64/tru64.cc
295 alpha_eio_sources = Split('''
296 encumbered/eio/exolex.cc
297 encumbered/eio/libexo.cc
298 encumbered/eio/eio.cc
301 if env['TARGET_ISA'] == 'alpha':
302 syscall_emulation_sources += alpha_eio_sources
304 memtest_sources = Split('''
305 cpu/memtest/memtest.cc
308 # Include file paths are rooted in this directory. SCons will
309 # automatically expand '.' to refer to both the source directory and
310 # the corresponding build directory to pick up generated include
312 env.Append(CPPPATH=Dir('.'))
314 # Add a flag defining what THE_ISA should be for all compilation
315 env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
317 arch_sources = SConscript('arch/SConscript', exports = 'env')
319 cpu_sources = SConscript('cpu/SConscript', exports = 'env')
321 # This is outside of cpu/SConscript since the source directory isn't
323 if 'FullCPU' in env['CPU_MODELS']:
324 cpu_sources += full_cpu_sources
326 # Set up complete list of sources based on configuration.
327 sources = base_sources + arch_sources + cpu_sources
329 if env['FULL_SYSTEM']:
330 sources += full_system_sources
331 if env['ALPHA_TLASER']:
332 sources += turbolaser_sources
334 sources += syscall_emulation_sources
337 sources += mysql_sources
339 for opt in env.ExportOptions:
342 ###################################################
344 # Special build rules.
346 ###################################################
348 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
349 # $TARGET.base will expand to "<build-dir>/base/traceflags".
350 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
351 'base/traceflags.py',
352 'python $SOURCE $TARGET.base')
354 SConscript('python/SConscript', exports = ['env'])
356 # This function adds the specified sources to the given build
357 # environment, and returns a list of all the corresponding SCons
358 # Object nodes (including an extra one for date.cc). We explicitly
359 # add the Object nodes so we can set up special dependencies for
361 def make_objs(sources, env):
362 objs = [env.Object(s) for s in sources]
363 # make date.cc depend on all other objects so it always gets
364 # recompiled whenever anything else does
365 date_obj = env.Object('base/date.cc')
366 env.Depends(date_obj, objs)
367 objs.append(date_obj)
370 ###################################################
372 # Define binaries. Each different build type (debug, opt, etc.) gets
373 # a slightly different build environment.
375 ###################################################
377 # List of constructed environments to pass back to SConstruct
380 # Function to create a new build environment as clone of current
381 # environment 'env' with modified object suffix and optional stripped
382 # binary. Additional keyword arguments are appended to corresponding
383 # build environment vars.
384 def makeEnv(label, objsfx, strip = False, **kwargs):
385 newEnv = env.Copy(OBJSUFFIX=objsfx)
387 newEnv.Append(**kwargs)
388 exe = 'm5.' + label # final executable
389 bin = exe + '.bin' # executable w/o appended Python zip archive
390 newEnv.Program(bin, make_objs(sources, newEnv))
392 stripped_bin = bin + '.stripped'
393 newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
395 targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
396 newEnv.M5Binary = targets[0]
397 envList.append(newEnv)
400 makeEnv('debug', '.do',
401 CCFLAGS = Split('-g3 -gdwarf-2 -O0'),
402 CPPDEFINES = 'DEBUG')
406 CCFLAGS = Split('-g -O3'))
409 makeEnv('fast', '.fo', strip = True,
410 CCFLAGS = Split('-O3'),
411 CPPDEFINES = 'NDEBUG')
414 makeEnv('prof', '.po',
415 CCFLAGS = Split('-O3 -g -pg'),