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