3 # Copyright (c) 2004 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.
32 # This file defines how to build a particular configuration of M5
33 # based on variable settings in the 'env' build environment.
35 # Import build environment variable from SConstruct.
38 ###################################################
40 # Define needed sources.
42 ###################################################
44 # Base sources used by all configurations.
45 base_sources = Split('''
47 arch/alpha/fast_cpu_exec.cc
48 arch/alpha/simple_cpu_exec.cc
49 arch/alpha/full_cpu_exec.cc
51 arch/alpha/isa_traits.cc
75 base/compression/lzss_compression.cc
76 base/loader/aout_object.cc
77 base/loader/ecoff_object.cc
78 base/loader/elf_object.cc
79 base/loader/object_file.cc
92 cpu/fast_cpu/fast_cpu.cc
94 cpu/full_cpu/commit.cc
95 cpu/full_cpu/create_vector.cc
96 cpu/full_cpu/cv_spec_state.cc
97 cpu/full_cpu/dd_queue.cc
98 cpu/full_cpu/dep_link.cc
99 cpu/full_cpu/dispatch.cc
100 cpu/full_cpu/dyn_inst.cc
101 cpu/full_cpu/execute.cc
102 cpu/full_cpu/fetch.cc
103 cpu/full_cpu/floss_reasons.cc
104 cpu/full_cpu/fu_pool.cc
105 cpu/full_cpu/full_cpu.cc
106 cpu/full_cpu/inst_fifo.cc
107 cpu/full_cpu/instpipe.cc
108 cpu/full_cpu/issue.cc
109 cpu/full_cpu/ls_queue.cc
110 cpu/full_cpu/machine_queue.cc
111 cpu/full_cpu/pipetrace.cc
112 cpu/full_cpu/readyq.cc
113 cpu/full_cpu/reg_info.cc
114 cpu/full_cpu/rob_station.cc
115 cpu/full_cpu/spec_memory.cc
116 cpu/full_cpu/spec_state.cc
117 cpu/full_cpu/storebuffer.cc
118 cpu/full_cpu/writeback.cc
119 cpu/full_cpu/iq/iq_station.cc
120 cpu/full_cpu/iq/iqueue.cc
121 cpu/full_cpu/iq/segmented/chain_info.cc
122 cpu/full_cpu/iq/segmented/chain_wire.cc
123 cpu/full_cpu/iq/segmented/iq_seg.cc
124 cpu/full_cpu/iq/segmented/iq_segmented.cc
125 cpu/full_cpu/iq/segmented/seg_chain.cc
126 cpu/full_cpu/iq/seznec/iq_seznec.cc
127 cpu/full_cpu/iq/standard/iq_standard.cc
128 cpu/sampling_cpu/sampling_cpu.cc
129 cpu/simple_cpu/simple_cpu.cc
130 cpu/trace/reader/mem_trace_reader.cc
131 cpu/trace/reader/ibm_reader.cc
132 cpu/trace/reader/itx_reader.cc
133 cpu/trace/reader/m5_reader.cc
141 mem/memory_interface.cc
142 mem/bus/base_interface.cc
144 mem/bus/bus_bridge.cc
145 mem/bus/bus_bridge_master.cc
146 mem/bus/bus_bridge_slave.cc
147 mem/bus/bus_interface.cc
148 mem/bus/dma_bus_interface.cc
149 mem/bus/dma_interface.cc
150 mem/bus/master_interface.cc
151 mem/bus/slave_interface.cc
152 mem/cache/base_cache.cc
154 mem/cache/cache_builder.cc
155 mem/cache/coherence/coherence_protocol.cc
156 mem/cache/coherence/uni_coherence.cc
157 mem/cache/miss/blocking_buffer.cc
158 mem/cache/miss/miss_queue.cc
159 mem/cache/miss/mshr.cc
160 mem/cache/miss/mshr_queue.cc
161 mem/cache/tags/base_tags.cc
162 mem/cache/tags/cache_tags.cc
163 mem/cache/tags/fa_lru.cc
164 mem/cache/tags/iic.cc
165 mem/cache/tags/lru.cc
166 mem/cache/tags/split.cc
167 mem/cache/tags/split_lifo.cc
168 mem/cache/tags/split_lru.cc
169 mem/cache/tags/repl/gen.cc
170 mem/cache/tags/repl/repl.cc
171 mem/functional_mem/functional_memory.cc
172 mem/functional_mem/main_memory.cc
173 mem/timing_mem/base_memory.cc
174 mem/timing_mem/memory_builder.cc
175 mem/timing_mem/simple_mem_bank.cc
176 mem/trace/itx_writer.cc
177 mem/trace/mem_trace_writer.cc
178 mem/trace/m5_writer.cc
196 sim/pyconfig/pyconfig.cc
200 base_obj_desc_files = Split('''
201 cpu/full_cpu/iq/segmented/SegmentedIQ.od
202 cpu/full_cpu/iq/seznec/SeznecIQ.od
203 cpu/full_cpu/iq/standard/StandardIQ.od
204 cpu/full_cpu/iq/BaseIQ.od
205 cpu/full_cpu/BranchPred.od
206 cpu/full_cpu/FUDesc.od
207 cpu/full_cpu/FullCPU.od
208 cpu/full_cpu/FuncUnitPool.od
209 cpu/full_cpu/OpDesc.od
210 cpu/full_cpu/PipeTrace.od
211 cpu/sampling_cpu/SamplingCPU.od
212 cpu/simple_cpu/SimpleCPU.od
217 mem/cache/coherence/CoherenceProtocol.od
218 mem/cache/tags/repl/GenRepl.od
219 mem/cache/tags/repl/Repl.od
220 mem/cache/BaseCache.od
221 mem/functional_mem/FunctionalMemory.od
222 mem/functional_mem/MainMemory.od
223 mem/functional_mem/MemoryController.od
224 mem/functional_mem/PhysicalMemory.od
225 mem/timing_mem/BaseMemory.od
233 mysql_sources = Split('''
238 # Full-system sources
239 full_system_sources = Split('''
240 arch/alpha/alpha_memory.cc
241 arch/alpha/arguments.cc
244 arch/alpha/pseudo_inst.cc
245 arch/alpha/vtophys.cc
279 dev/tlaser_mc146818.cc
292 kern/kernel_binning.cc
294 kern/system_events.cc
295 kern/linux/linux_events.cc
296 kern/linux/linux_syscalls.cc
297 kern/linux/linux_system.cc
299 kern/tru64/dump_mbuf.cc
301 kern/tru64/tru64_events.cc
302 kern/tru64/tru64_syscalls.cc
303 kern/tru64/tru64_system.cc
305 mem/functional_mem/memory_control.cc
306 mem/functional_mem/physical_memory.cc
312 full_system_obj_desc_files = Split('''
313 arch/alpha/AlphaDTB.od
314 arch/alpha/AlphaITB.od
315 arch/alpha/AlphaTLB.od
317 dev/ConsoleListener.od
331 dev/ScsiController.od
339 dev/TlaserMC146818.od
346 kern/tru64/Tru64System.od
350 # Syscall emulation (non-full-system) sources
351 syscall_emulation_sources = Split('''
352 arch/alpha/alpha_common_syscall_emul.cc
353 arch/alpha/alpha_linux_process.cc
354 arch/alpha/alpha_tru64_process.cc
355 cpu/memtest/memtest.cc
357 cpu/trace/trace_cpu.cc
365 syscall_emulation_obj_desc_files = Split('''
366 cpu/memtest/MemTest.od
372 # Set up complete list of sources based on configuration.
373 sources = base_sources
374 obj_desc_files = base_obj_desc_files
376 if env['FULL_SYSTEM']:
377 sources += full_system_sources
378 obj_desc_files += full_system_obj_desc_files
380 sources += syscall_emulation_sources
381 obj_desc_files += syscall_emulation_obj_desc_files
385 sources += mysql_sources
386 env.Append(CPPDEFINES = 'USE_MYSQL')
387 env.Append(CPPDEFINES = 'STATS_BINNING')
388 env.Append(CPPPATH=['/usr/local/include/mysql', '/usr/include/mysql'])
389 env.Append(LIBS=['z'])
390 if os.path.isdir('/usr/lib64'):
391 env.Append(LIBPATH=['/usr/lib64/mysql'])
393 env.Append(LIBPATH=['/usr/lib/mysql/'])
394 env.Append(LIBS=['mysqlclient'])
397 ###################################################
399 # Special build rules.
401 ###################################################
403 # base/traceflags.{cc,hh} are generated from base/traceflags.py.
404 # $TARGET.base will expand to "<build-dir>/base/traceflags".
405 env.Command(Split('base/traceflags.hh base/traceflags.cc'),
406 'base/traceflags.py',
407 'python $SOURCE $TARGET.base')
409 # several files are generated from arch/$TARGET_ISA/isa_desc.
410 env.Command(Split('''arch/alpha/decoder.cc
411 arch/alpha/decoder.hh
412 arch/alpha/fast_cpu_exec.cc
413 arch/alpha/simple_cpu_exec.cc
414 arch/alpha/full_cpu_exec.cc'''),
415 Split('''arch/alpha/isa_desc
416 arch/isa_parser.py'''),
417 '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/alpha')
420 # 'targetarch' is a symlink to arch/$TARGET_ISA.
421 def link_targetarch(target, source, env):
422 link_target = str(target[0])
423 link_source = env.subst('$SRCDIR/arch/$TARGET_ISA')
424 if not os.path.isdir(link_target):
425 print "symlinking", link_source, "to", link_target
427 os.symlink(link_source, link_target)
428 except OSError, desc:
429 print "Error creating symlink %s: %s" % (link_target, desc)
432 # Tell SCons to use the link_targetarch function to make 'targetarch'
433 env.Command('targetarch', None, link_targetarch)
436 # libelf build is described in its own SConscript file.
437 # SConscript-local is the per-config build, which just copies some
438 # header files into a place where they can be found.
439 SConscript('libelf/SConscript-local', exports = 'env', duplicate=0)
441 SConscript('sim/pyconfig/SConscript', exports = ['env', 'obj_desc_files'],
445 # This function adds the specified sources to the given build
446 # environment, and returns a list of all the corresponding SCons
447 # Object nodes (including an extra one for date.cc). We explicitly
448 # add the Object nodes so we can set up special dependencies for
449 # targetarch and date.cc.
450 def make_objs(sources, env):
451 objs = [env.Object(s) for s in sources]
452 # make all objects depend on the targetarch link so it gets made first.
453 env.Depends(objs, 'targetarch')
454 # make date.cc depend on all other objects so it always gets
455 # recompiled whenever anything else does
456 date_obj = env.Object('base/date.cc')
457 env.Depends(date_obj, objs)
458 objs.append(date_obj)
459 objs.extend(extra_libraries)
462 ###################################################
464 # Define binaries. Each different build type (debug, opt, etc.) gets
465 # a slightly different build environment.
467 ###################################################
469 # Include file paths are rooted in this directory. SCons will
470 # automatically expand '.' to refer to both the source directory and
471 # the corresponding build directory to pick up generated include
473 env.Append(CPPPATH='.')
476 debug = env.Copy(OBJSUFFIX='.do')
477 debug.Append(CCFLAGS=Split('-g -gstabs+ -O0'))
478 debug.Append(CPPDEFINES='DEBUG')
479 debug.Program(target = 'm5.debug', source = make_objs(sources, debug))
483 opt.Append(CCFLAGS=Split('-g -O5'))
484 opt.Program(target = 'm5.opt', source = make_objs(sources, opt))
487 fast = env.Copy(OBJSUFFIX='.fo')
488 fast.Append(CCFLAGS=Split('-O5'))
489 fast.Append(CPPDEFINES='NDEBUG')
490 fast.Program(target = 'm5.fast.unstripped', source = make_objs(sources, fast))
491 fast.Command(target = 'm5.fast', source = 'm5.fast.unstripped',
492 action = 'strip $SOURCE -o $TARGET')
495 prof = env.Copy(OBJSUFFIX='.po')
496 prof.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
497 prof.Program(target = 'm5.prof', source = make_objs(sources, prof))