SConscript revision 1717
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
31from os.path import isdir
32
33# This file defines how to build a particular configuration of M5
34# based on variable settings in the 'env' build environment.
35
36# Import build environment variable from SConstruct.
37Import('env')
38
39###################################################
40#
41# Define needed sources.
42#
43###################################################
44
45# Base sources used by all configurations.
46base_sources = Split('''
47	arch/alpha/decoder.cc
48        arch/alpha/alpha_o3_exec.cc
49	arch/alpha/fast_cpu_exec.cc
50	arch/alpha/simple_cpu_exec.cc
51	arch/alpha/full_cpu_exec.cc
52	arch/alpha/faults.cc
53	arch/alpha/isa_traits.cc
54
55	base/circlebuf.cc
56	base/copyright.cc
57	base/cprintf.cc
58        base/embedfile.cc
59	base/fast_alloc.cc
60	base/fifo_buffer.cc
61	base/hostinfo.cc
62	base/hybrid_pred.cc
63	base/inifile.cc
64	base/intmath.cc
65	base/match.cc
66	base/misc.cc
67	base/output.cc
68	base/pollevent.cc
69	base/python.cc
70	base/range.cc
71	base/random.cc
72	base/sat_counter.cc
73	base/socket.cc
74	base/statistics.cc
75	base/str.cc
76	base/time.cc
77	base/trace.cc
78	base/traceflags.cc
79	base/userinfo.cc
80	base/compression/lzss_compression.cc
81	base/loader/aout_object.cc
82	base/loader/ecoff_object.cc
83	base/loader/elf_object.cc
84	base/loader/object_file.cc
85	base/loader/symtab.cc
86	base/stats/events.cc
87	base/stats/python.cc
88	base/stats/statdb.cc
89	base/stats/visit.cc
90	base/stats/text.cc
91
92	cpu/base.cc
93        cpu/base_dyn_inst.cc
94	cpu/exec_context.cc
95	cpu/exetrace.cc
96	cpu/pc_event.cc
97	cpu/static_inst.cc
98        cpu/o3/2bit_local_pred.cc
99        cpu/o3/alpha_dyn_inst.cc
100        cpu/o3/alpha_cpu.cc
101        cpu/o3/alpha_cpu_builder.cc
102        cpu/o3/bpred_unit.cc
103        cpu/o3/btb.cc
104        cpu/o3/commit.cc
105        cpu/o3/decode.cc
106        cpu/o3/fetch.cc
107        cpu/o3/free_list.cc
108        cpu/o3/cpu.cc
109        cpu/o3/iew.cc
110        cpu/o3/inst_queue.cc
111        cpu/o3/ldstq.cc
112        cpu/o3/mem_dep_unit.cc
113        cpu/o3/ras.cc
114        cpu/o3/rename.cc
115        cpu/o3/rename_map.cc
116        cpu/o3/rob.cc
117        cpu/o3/sat_counter.cc
118        cpu/o3/store_set.cc
119        cpu/o3/tournament_pred.cc
120	cpu/fast/cpu.cc
121        cpu/sampler/sampler.cc
122        cpu/simple/cpu.cc
123        cpu/trace/reader/mem_trace_reader.cc
124        cpu/trace/reader/ibm_reader.cc
125        cpu/trace/reader/itx_reader.cc
126        cpu/trace/reader/m5_reader.cc
127
128	encumbered/cpu/full/bpred.cc
129	encumbered/cpu/full/commit.cc
130	encumbered/cpu/full/cpu.cc
131	encumbered/cpu/full/create_vector.cc
132	encumbered/cpu/full/cv_spec_state.cc
133	encumbered/cpu/full/dd_queue.cc
134	encumbered/cpu/full/dep_link.cc
135	encumbered/cpu/full/dispatch.cc
136	encumbered/cpu/full/dyn_inst.cc
137	encumbered/cpu/full/execute.cc
138	encumbered/cpu/full/fetch.cc
139	encumbered/cpu/full/floss_reasons.cc
140	encumbered/cpu/full/fu_pool.cc
141	encumbered/cpu/full/inst_fifo.cc
142	encumbered/cpu/full/instpipe.cc
143	encumbered/cpu/full/issue.cc
144	encumbered/cpu/full/ls_queue.cc
145	encumbered/cpu/full/machine_queue.cc
146        encumbered/cpu/full/pc_sample_profile.cc
147        encumbered/cpu/full/pipetrace.cc
148        encumbered/cpu/full/readyq.cc
149        encumbered/cpu/full/reg_info.cc
150        encumbered/cpu/full/rob_station.cc
151        encumbered/cpu/full/spec_memory.cc
152        encumbered/cpu/full/spec_state.cc
153        encumbered/cpu/full/storebuffer.cc
154        encumbered/cpu/full/writeback.cc
155        encumbered/cpu/full/iq/iq_station.cc
156        encumbered/cpu/full/iq/iqueue.cc
157        encumbered/cpu/full/iq/segmented/chain_info.cc
158        encumbered/cpu/full/iq/segmented/chain_wire.cc
159        encumbered/cpu/full/iq/segmented/iq_seg.cc
160        encumbered/cpu/full/iq/segmented/iq_segmented.cc
161        encumbered/cpu/full/iq/segmented/seg_chain.cc
162        encumbered/cpu/full/iq/seznec/iq_seznec.cc
163        encumbered/cpu/full/iq/standard/iq_standard.cc
164	encumbered/mem/functional/main.cc
165
166	mem/base_hier.cc
167	mem/base_mem.cc
168	mem/hier_params.cc
169	mem/mem_cmd.cc
170	mem/mem_debug.cc
171	mem/mem_req.cc
172	mem/memory_interface.cc
173	mem/bus/base_interface.cc
174	mem/bus/bus.cc
175	mem/bus/bus_bridge.cc
176	mem/bus/bus_bridge_master.cc
177	mem/bus/bus_bridge_slave.cc
178	mem/bus/bus_interface.cc
179	mem/bus/dma_bus_interface.cc
180	mem/bus/dma_interface.cc
181	mem/bus/master_interface.cc
182	mem/bus/slave_interface.cc
183	mem/cache/base_cache.cc
184	mem/cache/cache.cc
185	mem/cache/cache_builder.cc
186	mem/cache/coherence/coherence_protocol.cc
187	mem/cache/coherence/uni_coherence.cc
188	mem/cache/miss/blocking_buffer.cc
189	mem/cache/miss/miss_queue.cc
190	mem/cache/miss/mshr.cc
191	mem/cache/miss/mshr_queue.cc
192        mem/cache/prefetch/base_prefetcher.cc
193        mem/cache/prefetch/ghb_prefetcher.cc
194        mem/cache/prefetch/prefetcher.cc
195        mem/cache/prefetch/stride_prefetcher.cc
196        mem/cache/prefetch/tagged_prefetcher.cc
197	mem/cache/tags/base_tags.cc
198	mem/cache/tags/cache_tags.cc
199	mem/cache/tags/fa_lru.cc
200	mem/cache/tags/iic.cc
201	mem/cache/tags/lru.cc
202	mem/cache/tags/split.cc
203	mem/cache/tags/split_lifo.cc
204	mem/cache/tags/split_lru.cc
205	mem/cache/tags/repl/gen.cc
206	mem/cache/tags/repl/repl.cc
207	mem/functional/functional.cc
208	mem/timing/base_memory.cc
209	mem/timing/memory_builder.cc
210	mem/timing/simple_mem_bank.cc
211        mem/trace/itx_writer.cc
212	mem/trace/mem_trace_writer.cc
213	mem/trace/m5_writer.cc
214
215        python/pyconfig.cc
216        python/embedded_py.cc
217
218	sim/builder.cc
219	sim/configfile.cc
220	sim/debug.cc
221	sim/eventq.cc
222	sim/main.cc
223	sim/param.cc
224	sim/profile.cc
225	sim/root.cc
226	sim/serialize.cc
227	sim/sim_events.cc
228	sim/sim_exit.cc
229	sim/sim_object.cc
230	sim/startup.cc
231	sim/stat_context.cc
232	sim/stat_control.cc
233	sim/trace_context.cc
234        ''')
235
236# MySql sources
237mysql_sources = Split('''
238	base/mysql.cc
239	base/stats/mysql.cc
240        ''')
241
242# Full-system sources
243full_system_sources = Split('''
244	arch/alpha/alpha_memory.cc
245	arch/alpha/arguments.cc
246	arch/alpha/ev5.cc
247	arch/alpha/osfpal.cc
248	arch/alpha/pseudo_inst.cc
249	arch/alpha/vtophys.cc
250
251	base/crc.cc
252	base/inet.cc
253	base/remote_gdb.cc
254
255	cpu/intr_control.cc
256
257	dev/alpha_console.cc
258	dev/baddev.cc
259        dev/simconsole.cc
260	dev/disk_image.cc
261	dev/etherbus.cc
262	dev/etherdump.cc
263	dev/etherint.cc
264	dev/etherlink.cc
265	dev/etherpkt.cc
266	dev/ethertap.cc
267	dev/ide_ctrl.cc
268	dev/ide_disk.cc
269	dev/io_device.cc
270	dev/ns_gige.cc
271	dev/pciconfigall.cc
272	dev/pcidev.cc
273	dev/pktfifo.cc
274        dev/platform.cc
275	dev/sinic.cc
276	dev/simple_disk.cc
277	dev/tsunami.cc
278	dev/tsunami_cchip.cc
279	dev/tsunami_fake.cc
280	dev/tsunami_io.cc
281	dev/tsunami_pchip.cc
282	dev/uart.cc
283
284	encumbered/dev/dma.cc
285	encumbered/dev/etherdev.cc
286	encumbered/dev/scsi.cc
287	encumbered/dev/scsi_ctrl.cc
288	encumbered/dev/scsi_disk.cc
289	encumbered/dev/scsi_none.cc
290	encumbered/dev/tlaser_clock.cc
291	encumbered/dev/tlaser_ipi.cc
292	encumbered/dev/tlaser_mbox.cc
293	encumbered/dev/tlaser_mc146818.cc
294	encumbered/dev/tlaser_node.cc
295	encumbered/dev/tlaser_pcia.cc
296	encumbered/dev/tlaser_pcidev.cc
297	encumbered/dev/tlaser_serial.cc
298	encumbered/dev/turbolaser.cc
299
300	kern/kernel_binning.cc
301	kern/kernel_stats.cc
302	kern/system_events.cc
303	kern/linux/linux_events.cc
304	kern/linux/linux_syscalls.cc
305	kern/linux/linux_system.cc
306	kern/linux/printk.cc
307	kern/tru64/dump_mbuf.cc
308	kern/tru64/printf.cc
309	kern/tru64/tru64_events.cc
310	kern/tru64/tru64_syscalls.cc
311	kern/tru64/tru64_system.cc
312
313	mem/functional/memory_control.cc
314	mem/functional/physical.cc
315
316	sim/system.cc
317        ''')
318
319# Syscall emulation (non-full-system) sources
320syscall_emulation_sources = Split('''
321	arch/alpha/alpha_common_syscall_emul.cc
322	arch/alpha/alpha_linux_process.cc
323	arch/alpha/alpha_tru64_process.cc
324	cpu/memtest/memtest.cc
325        cpu/trace/opt_cpu.cc
326	cpu/trace/trace_cpu.cc
327	eio/eio.cc
328	eio/exolex.cc
329	eio/libexo.cc
330	sim/process.cc
331	sim/syscall_emul.cc
332        ''')
333
334targetarch_files = Split('''
335        alpha_common_syscall_emul.hh
336        alpha_linux_process.hh
337        alpha_memory.hh
338        alpha_tru64_process.hh
339        aout_machdep.h
340        arguments.hh
341        byte_swap.hh
342        ecoff_machdep.h
343        elf_machdep.h
344        ev5.hh
345        faults.hh
346        isa_fullsys_traits.hh
347        isa_traits.hh
348        machine_exo.h
349        osfpal.hh
350        pseudo_inst.hh
351        vptr.hh
352        vtophys.hh
353        ''')
354
355for f in targetarch_files:
356    env.Command('targetarch/' + f, 'arch/alpha/' + f,
357                '''echo '#include "arch/alpha/%s"' > $TARGET''' % f)
358
359
360# Set up complete list of sources based on configuration.
361sources = base_sources
362
363if env['FULL_SYSTEM']:
364    sources += full_system_sources
365else:
366    sources += syscall_emulation_sources
367
368extra_libraries = []
369env.Append(LIBS=['z'])
370if isdir('/usr/lib64/mysql') or isdir('/usr/lib/mysql') or \
371   isdir('/usr/local/lib/mysql'):
372    print 'Compiling with MySQL support!'
373    env.Append(LIBPATH=['/usr/lib64/mysql', '/usr/local/lib/mysql/',
374                        '/usr/lib/mysql'])
375    env.Append(CPPPATH=['/usr/local/include/mysql', '/usr/include/mysql'])
376    sources += mysql_sources
377    env.Append(CPPDEFINES = 'USE_MYSQL')
378    env.Append(CPPDEFINES = 'STATS_BINNING')
379    env.Append(LIBS=['mysqlclient'])
380
381###################################################
382#
383# Special build rules.
384#
385###################################################
386
387# base/traceflags.{cc,hh} are generated from base/traceflags.py.
388# $TARGET.base will expand to "<build-dir>/base/traceflags".
389env.Command(Split('base/traceflags.hh base/traceflags.cc'),
390            'base/traceflags.py',
391            'python $SOURCE $TARGET.base')
392
393# several files are generated from arch/$TARGET_ISA/isa_desc.
394env.Command(Split('''arch/alpha/decoder.cc
395		     arch/alpha/decoder.hh
396                     arch/alpha/alpha_o3_exec.cc
397		     arch/alpha/fast_cpu_exec.cc
398                     arch/alpha/simple_cpu_exec.cc
399                     arch/alpha/full_cpu_exec.cc'''),
400            Split('''arch/alpha/isa_desc
401		     arch/isa_parser.py'''),
402            '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/alpha')
403
404
405# libelf build is described in its own SConscript file.
406# SConscript-local is the per-config build, which just copies some
407# header files into a place where they can be found.
408SConscript('libelf/SConscript-local', exports = 'env', duplicate=0)
409SConscript('python/SConscript', exports = ['env'], duplicate=0)
410
411# This function adds the specified sources to the given build
412# environment, and returns a list of all the corresponding SCons
413# Object nodes (including an extra one for date.cc).  We explicitly
414# add the Object nodes so we can set up special dependencies for
415# date.cc.
416def make_objs(sources, env):
417    objs = [env.Object(s) for s in sources]
418    # make date.cc depend on all other objects so it always gets
419    # recompiled whenever anything else does
420    date_obj = env.Object('base/date.cc')
421    env.Depends(date_obj, objs)
422    objs.append(date_obj)
423    objs.extend(extra_libraries)
424    return objs
425
426###################################################
427#
428# Define binaries.  Each different build type (debug, opt, etc.) gets
429# a slightly different build environment.
430#
431###################################################
432
433# Include file paths are rooted in this directory.  SCons will
434# automatically expand '.' to refer to both the source directory and
435# the corresponding build directory to pick up generated include
436# files.
437env.Append(CPPPATH='.')
438
439# Debug binary
440debug = env.Copy(OBJSUFFIX='.do')
441debug.Append(CCFLAGS=Split('-g -gstabs+ -O0'))
442debug.Append(CPPDEFINES='DEBUG')
443debug.Program(target = 'm5.debug', source = make_objs(sources, debug))
444
445# Optimized binary
446opt = env.Copy()
447opt.Append(CCFLAGS=Split('-g -O5'))
448opt.Program(target = 'm5.opt', source = make_objs(sources, opt))
449
450# "Fast" binary
451fast = env.Copy(OBJSUFFIX='.fo')
452fast.Append(CCFLAGS=Split('-O5'))
453fast.Append(CPPDEFINES='NDEBUG')
454fast.Program(target = 'm5.fast.unstripped', source = make_objs(sources, fast))
455fast.Command(target = 'm5.fast', source = 'm5.fast.unstripped',
456             action = 'strip $SOURCE -o $TARGET')
457
458# Profiled binary
459prof = env.Copy(OBJSUFFIX='.po')
460prof.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
461prof.Program(target = 'm5.prof', source = make_objs(sources, prof))
462