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