SConscript revision 974
1# -*- mode:python -*-
2
3# Copyright (c) 2004 The Regents of The University of Michigan
4# All rights reserved.
5#
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.
16#
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.
28
29import os
30import sys
31
32# This file defines how to build a particular configuration of M5
33# based on variable settings in the 'env' build environment.
34
35# Import build environment variable from SConstruct.
36Import('env')
37
38###################################################
39#
40# Define needed sources.
41#
42###################################################
43
44# Base sources used by all configurations.
45base_sources = Split('''
46	arch/alpha/decoder.cc
47	arch/alpha/fast_cpu_exec.cc
48	arch/alpha/simple_cpu_exec.cc
49	arch/alpha/full_cpu_exec.cc
50	arch/alpha/faults.cc
51	arch/alpha/isa_traits.cc
52
53	base/circlebuf.cc
54	base/copyright.cc
55	base/cprintf.cc
56	base/fast_alloc.cc
57	base/fifo_buffer.cc
58	base/hostinfo.cc
59	base/hybrid_pred.cc
60	base/inifile.cc
61	base/intmath.cc
62	base/misc.cc
63	base/pollevent.cc
64	base/python.cc
65	base/range.cc
66	base/sat_counter.cc
67	base/socket.cc
68	base/statistics.cc
69	base/str.cc
70	base/time.cc
71	base/trace.cc
72	base/traceflags.cc
73	base/userinfo.cc
74	base/compression/lzss_compression.cc
75	base/loader/aout_object.cc
76	base/loader/ecoff_object.cc
77	base/loader/elf_object.cc
78	base/loader/object_file.cc
79	base/loader/symtab.cc
80	base/stats/events.cc
81	base/stats/python.cc
82	base/stats/statdb.cc
83	base/stats/visit.cc
84	base/stats/text.cc
85
86	cpu/base_cpu.cc
87	cpu/exec_context.cc
88	cpu/exetrace.cc
89	cpu/pc_event.cc
90	cpu/static_inst.cc
91	cpu/fast_cpu/fast_cpu.cc
92	cpu/full_cpu/bpred.cc
93	cpu/full_cpu/commit.cc
94	cpu/full_cpu/create_vector.cc
95	cpu/full_cpu/cv_spec_state.cc
96	cpu/full_cpu/dd_queue.cc
97	cpu/full_cpu/dep_link.cc
98	cpu/full_cpu/dispatch.cc
99	cpu/full_cpu/dyn_inst.cc
100	cpu/full_cpu/execute.cc
101	cpu/full_cpu/fetch.cc
102	cpu/full_cpu/floss_reasons.cc
103	cpu/full_cpu/fu_pool.cc
104	cpu/full_cpu/full_cpu.cc
105	cpu/full_cpu/inst_fifo.cc
106	cpu/full_cpu/instpipe.cc
107	cpu/full_cpu/issue.cc
108	cpu/full_cpu/ls_queue.cc
109	cpu/full_cpu/machine_queue.cc
110	cpu/full_cpu/pipetrace.cc
111	cpu/full_cpu/readyq.cc
112	cpu/full_cpu/reg_info.cc
113	cpu/full_cpu/rob_station.cc
114	cpu/full_cpu/spec_memory.cc
115	cpu/full_cpu/spec_state.cc
116	cpu/full_cpu/storebuffer.cc
117	cpu/full_cpu/writeback.cc
118	cpu/full_cpu/iq/iq_station.cc
119	cpu/full_cpu/iq/iqueue.cc
120	cpu/full_cpu/iq/segmented/chain_info.cc
121	cpu/full_cpu/iq/segmented/chain_wire.cc
122	cpu/full_cpu/iq/segmented/iq_seg.cc
123	cpu/full_cpu/iq/segmented/iq_segmented.cc
124	cpu/full_cpu/iq/segmented/seg_chain.cc
125	cpu/full_cpu/iq/seznec/iq_seznec.cc
126	cpu/full_cpu/iq/standard/iq_standard.cc
127	cpu/sampling_cpu/sampling_cpu.cc
128	cpu/simple_cpu/simple_cpu.cc
129	cpu/trace/reader/mem_trace_reader.cc
130	cpu/trace/reader/ibm_reader.cc
131	cpu/trace/reader/itx_reader.cc
132	cpu/trace/reader/m5_reader.cc
133
134	mem/base_hier.cc
135	mem/base_mem.cc
136	mem/hier_params.cc
137	mem/mem_cmd.cc
138	mem/mem_debug.cc
139	mem/mem_req.cc
140	mem/memory_interface.cc
141	mem/bus/base_interface.cc
142	mem/bus/bus.cc
143	mem/bus/bus_bridge.cc
144	mem/bus/bus_bridge_master.cc
145	mem/bus/bus_bridge_slave.cc
146	mem/bus/bus_interface.cc
147	mem/bus/dma_bus_interface.cc
148	mem/bus/dma_interface.cc
149	mem/bus/master_interface.cc
150	mem/bus/slave_interface.cc
151	mem/cache/base_cache.cc
152	mem/cache/cache.cc
153	mem/cache/cache_builder.cc
154	mem/cache/coherence/coherence_protocol.cc
155	mem/cache/coherence/uni_coherence.cc
156	mem/cache/miss/blocking_buffer.cc
157	mem/cache/miss/miss_queue.cc
158	mem/cache/miss/mshr.cc
159	mem/cache/miss/mshr_queue.cc
160	mem/cache/tags/base_tags.cc
161	mem/cache/tags/cache_tags.cc
162	mem/cache/tags/fa_lru.cc
163	mem/cache/tags/iic.cc
164	mem/cache/tags/lru.cc
165	mem/cache/tags/repl/gen.cc
166	mem/cache/tags/repl/repl.cc
167	mem/functional_mem/functional_memory.cc
168	mem/functional_mem/main_memory.cc
169	mem/timing_mem/base_memory.cc
170	mem/timing_mem/memory_builder.cc
171	mem/timing_mem/simple_mem_bank.cc
172	mem/trace/mem_trace_writer.cc
173	mem/trace/m5_writer.cc
174
175	sim/builder.cc
176	sim/configfile.cc
177	sim/debug.cc
178	sim/eventq.cc
179	sim/main.cc
180	sim/param.cc
181	sim/profile.cc
182	sim/serialize.cc
183	sim/sim_events.cc
184	sim/sim_exit.cc
185	sim/sim_init.cc
186	sim/sim_object.cc
187	sim/stat_context.cc
188	sim/stat_control.cc
189	sim/sw_context.cc
190	sim/trace_context.cc
191	sim/universe.cc
192        ''')
193
194# MySql sources
195mysql_sources = Split('''
196	base/mysql.cc
197	base/stats/mysql.cc
198        ''')
199
200# Full-system sources
201full_system_sources = Split('''
202	arch/alpha/alpha_memory.cc
203	arch/alpha/arguments.cc
204	arch/alpha/ev5.cc
205	arch/alpha/osfpal.cc
206	arch/alpha/pseudo_inst.cc
207	arch/alpha/vtophys.cc
208
209	base/inet.cc
210	base/remote_gdb.cc
211
212	cpu/intr_control.cc
213
214	dev/alpha_console.cc
215	dev/baddev.cc
216        dev/simconsole.cc
217	dev/disk_image.cc
218	dev/dma.cc
219	dev/etherbus.cc
220	dev/etherdump.cc
221	dev/etherint.cc
222	dev/etherlink.cc
223	dev/etherpkt.cc
224	dev/ethertap.cc
225	dev/ide_ctrl.cc
226	dev/ide_disk.cc
227	dev/io_device.cc
228	dev/ns_gige.cc
229	dev/etherdev.cc
230	dev/pciconfigall.cc
231	dev/pcidev.cc
232	dev/scsi.cc
233	dev/scsi_ctrl.cc
234	dev/scsi_disk.cc
235	dev/scsi_none.cc
236	dev/simple_disk.cc
237	dev/tlaser_clock.cc
238	dev/tlaser_ipi.cc
239	dev/tlaser_mbox.cc
240	dev/tlaser_mc146818.cc
241	dev/tlaser_node.cc
242	dev/tlaser_pcia.cc
243	dev/tlaser_pcidev.cc
244	dev/tlaser_serial.cc
245	dev/turbolaser.cc
246	dev/tsunami.cc
247	dev/tsunami_cchip.cc
248	dev/tsunami_fake.cc
249	dev/tsunami_io.cc
250	dev/tsunami_pchip.cc
251	dev/uart.cc
252
253	kern/kernel_stats.cc
254	kern/system_events.cc
255	kern/linux/linux_events.cc
256	kern/linux/linux_syscalls.cc
257	kern/linux/linux_system.cc
258	kern/tru64/dump_mbuf.cc
259	kern/tru64/printf.cc
260	kern/tru64/tru64_events.cc
261	kern/tru64/tru64_syscalls.cc
262	kern/tru64/tru64_system.cc
263
264	mem/functional_mem/memory_control.cc
265	mem/functional_mem/physical_memory.cc
266        dev/platform.cc
267
268	sim/system.cc
269        ''')
270
271# Syscall emulation (non-full-system) sources
272syscall_emulation_sources = Split('''
273	arch/alpha/alpha_common_syscall_emul.cc
274	arch/alpha/alpha_linux_process.cc
275	arch/alpha/alpha_tru64_process.cc
276	cpu/memtest/memtest.cc
277	cpu/trace/trace_cpu.cc
278	eio/eio.cc
279	eio/exolex.cc
280	eio/libexo.cc
281	sim/process.cc
282	sim/syscall_emul.cc
283        ''')
284
285# Set up complete list of sources based on configuration.
286sources = base_sources
287
288if env['FULL_SYSTEM']:
289    sources += full_system_sources
290else:
291    sources += syscall_emulation_sources
292
293if env['USE_MYSQL']:
294    sources += mysql_sources
295
296###################################################
297#
298# Special build rules.
299#
300###################################################
301
302# base/traceflags.{cc,hh} are generated from base/traceflags.py.
303# $TARGET.base will expand to "<build-dir>/base/traceflags".
304env.Command(Split('base/traceflags.hh base/traceflags.cc'),
305            'base/traceflags.py',
306            'python $SOURCE $TARGET.base')
307
308# several files are generated from arch/$TARGET_ISA/isa_desc.
309env.Command(Split('''arch/alpha/decoder.cc
310		     arch/alpha/decoder.hh
311		     arch/alpha/fast_cpu_exec.cc
312                     arch/alpha/simple_cpu_exec.cc
313                     arch/alpha/full_cpu_exec.cc'''),
314            'arch/alpha/isa_desc',
315            '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/alpha')
316
317
318# 'targetarch' is a symlink to arch/$TARGET_ISA.
319def link_targetarch(target, source, env):
320    link_target = str(target[0])
321    link_source = env.subst('$SRCDIR/arch/$TARGET_ISA')
322    if not os.path.isdir(link_target):
323        print "symlinking", link_source, "to", link_target
324        try:
325            os.symlink(link_source, link_target)
326        except OSError, desc:
327            print "Error creating symlink %s: %s" % (link_target, desc)
328            sys.exit(-1)
329
330# Tell SCons to use the link_targetarch function to make 'targetarch'
331env.Command('targetarch', None, link_targetarch)
332
333
334# This function adds the specified sources to the given build
335# environment, and returns a list of all the corresponding SCons
336# Object nodes (including an extra one for date.cc).  We explicitly
337# add the Object nodes so we can set up special dependencies for
338# targetarch and date.cc.
339def make_objs(sources, env):
340    objs = [env.Object(s) for s in sources]
341    # make all objects depend on the targetarch link so it gets made first.
342    env.Depends(objs, 'targetarch')
343    # make date.cc depend on all other objects so it always gets
344    # recompiled whenever anything else does
345    date_obj = env.Object('base/date.cc')
346    env.Depends(date_obj, objs)
347    objs.append(date_obj)
348    return objs
349
350###################################################
351#
352# Define binaries.  Each different build type (debug, opt, etc.) gets
353# a slightly different build environment.
354#
355###################################################
356
357# Include file paths are rooted in this directory.  SCons will
358# automatically expand '.' to refer to both the source directory and
359# the corresponding build directory to pick up generated include
360# files.
361env.Append(CPPPATH='.')
362
363# Debug binary
364debug = env.Copy(OBJSUFFIX='.do')
365debug.Append(CCFLAGS=Split('-g -gstabs+ -O0'))
366debug.Append(CPPDEFINES='DEBUG')
367debug.Program(target = 'm5.debug', source = make_objs(sources, debug))
368
369# Optimized binary
370opt = env.Copy()
371opt.Append(CCFLAGS=Split('-g -O5'))
372opt.Program(target = 'm5.opt', source = make_objs(sources, opt))
373
374# "Fast" binary
375fast = env.Copy(OBJSUFFIX='.fo')
376fast.Append(CCFLAGS=Split('-O5'))
377fast.Append(CPPDEFINES='NDEBUG')
378fast.Program(target = 'm5.fast.unstripped', source = make_objs(sources, fast))
379fast.Command(target = 'm5.fast', source = 'm5.fast.unstripped',
380             action = 'strip $SOURCE -o $TARGET')
381
382# Profiled binary
383prof = env.Copy(OBJSUFFIX='.po')
384prof.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
385prof.Program(target = 'm5.prof', source = make_objs(sources, prof))
386