SConscript revision 2379
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/page_table.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/prefetcher.cc
194        mem/cache/prefetch/tagged_prefetcher.cc
195	mem/cache/tags/base_tags.cc
196	mem/cache/tags/cache_tags.cc	
197	mem/cache/tags/fa_lru.cc
198	mem/cache/tags/iic.cc
199	mem/cache/tags/lru.cc
200	mem/cache/tags/repl/gen.cc
201	mem/cache/tags/repl/repl.cc
202	mem/cache/tags/split.cc
203	mem/cache/tags/split_lru.cc
204	mem/cache/tags/split_lifo.cc
205	mem/functional/functional.cc
206	mem/functional/physical.cc
207	mem/functional/proxy.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/system.cc
234	sim/trace_context.cc
235        ''')
236
237# MySql sources
238mysql_sources = Split('''
239	base/mysql.cc
240	base/stats/mysql.cc
241        ''')
242
243# Full-system sources
244full_system_sources = Split('''
245	arch/alpha/alpha_memory.cc
246	arch/alpha/arguments.cc
247	arch/alpha/ev5.cc
248	arch/alpha/osfpal.cc
249	arch/alpha/pseudo_inst.cc
250	arch/alpha/stacktrace.cc
251	arch/alpha/vtophys.cc
252
253	base/crc.cc
254	base/inet.cc
255	base/remote_gdb.cc
256
257	cpu/intr_control.cc
258        cpu/profile.cc
259
260	dev/alpha_console.cc
261	dev/baddev.cc
262        dev/simconsole.cc
263	dev/disk_image.cc
264	dev/etherbus.cc
265	dev/etherdump.cc
266	dev/etherint.cc
267	dev/etherlink.cc
268	dev/etherpkt.cc
269	dev/ethertap.cc
270	dev/ide_ctrl.cc
271	dev/ide_disk.cc
272	dev/io_device.cc
273	dev/ns_gige.cc
274	dev/pciconfigall.cc
275	dev/pcidev.cc
276	dev/pcifake.cc
277	dev/pktfifo.cc
278	dev/platform.cc
279	dev/sinic.cc
280	dev/simple_disk.cc
281	dev/tsunami.cc
282	dev/tsunami_cchip.cc
283	dev/isa_fake.cc
284	dev/tsunami_io.cc
285	dev/tsunami_pchip.cc
286	dev/uart.cc
287	dev/uart8250.cc
288
289	kern/kernel_binning.cc
290	kern/kernel_stats.cc
291	kern/system_events.cc
292	kern/freebsd/freebsd_system.cc
293	kern/linux/linux_syscalls.cc
294	kern/linux/linux_system.cc
295	kern/linux/printk.cc
296	kern/tru64/dump_mbuf.cc
297	kern/tru64/printf.cc
298	kern/tru64/tru64_events.cc
299	kern/tru64/tru64_syscalls.cc
300	kern/tru64/tru64_system.cc
301
302	mem/functional/memory_control.cc
303        ''')
304
305# turbolaser encumbered sources
306turbolaser_sources = Split('''
307	encumbered/dev/dma.cc
308	encumbered/dev/etherdev.cc
309	encumbered/dev/scsi.cc
310	encumbered/dev/scsi_ctrl.cc
311	encumbered/dev/scsi_disk.cc
312	encumbered/dev/scsi_none.cc
313	encumbered/dev/tlaser_clock.cc
314	encumbered/dev/tlaser_ipi.cc
315	encumbered/dev/tlaser_mbox.cc
316	encumbered/dev/tlaser_mc146818.cc
317	encumbered/dev/tlaser_node.cc
318	encumbered/dev/tlaser_pcia.cc
319	encumbered/dev/tlaser_pcidev.cc
320	encumbered/dev/tlaser_serial.cc
321	encumbered/dev/turbolaser.cc
322	encumbered/dev/uart8530.cc
323        ''')
324
325# Syscall emulation (non-full-system) sources
326syscall_emulation_sources = Split('''
327	arch/alpha/alpha_common_syscall_emul.cc
328	arch/alpha/alpha_linux_process.cc
329	arch/alpha/alpha_tru64_process.cc
330	cpu/memtest/memtest.cc
331	encumbered/eio/eio.cc
332	encumbered/eio/exolex.cc
333	encumbered/eio/libexo.cc
334	sim/process.cc
335	sim/syscall_emul.cc
336        ''')
337
338targetarch_files = Split('''
339        alpha_common_syscall_emul.hh
340        alpha_linux_process.hh
341        alpha_memory.hh
342        alpha_tru64_process.hh
343        aout_machdep.h
344        arguments.hh
345        byte_swap.hh
346        ecoff_machdep.h
347        ev5.hh
348        faults.hh
349        isa_fullsys_traits.hh
350        isa_traits.hh
351        osfpal.hh
352        pseudo_inst.hh
353        stacktrace.hh
354        vptr.hh
355        vtophys.hh
356        ''')
357
358for f in targetarch_files:
359    env.Command('targetarch/' + f, 'arch/alpha/' + f,
360                '''echo '#include "arch/alpha/%s"' > $TARGET''' % f)
361
362
363# Set up complete list of sources based on configuration.
364sources = base_sources
365
366if env['FULL_SYSTEM']:
367    sources += full_system_sources
368    if env['ALPHA_TLASER']:
369        sources += turbolaser_sources
370else:
371    sources += syscall_emulation_sources
372
373if env['USE_MYSQL']:
374    sources += mysql_sources
375
376for opt in env.ExportOptions:
377    env.ConfigFile(opt)
378
379###################################################
380#
381# Special build rules.
382#
383###################################################
384
385# base/traceflags.{cc,hh} are generated from base/traceflags.py.
386# $TARGET.base will expand to "<build-dir>/base/traceflags".
387env.Command(Split('base/traceflags.hh base/traceflags.cc'),
388            'base/traceflags.py',
389            'python $SOURCE $TARGET.base')
390
391# several files are generated from arch/$TARGET_ISA/isa_desc.
392env.Command(Split('''arch/alpha/decoder.cc
393		     arch/alpha/decoder.hh
394                     arch/alpha/alpha_o3_exec.cc
395		     arch/alpha/fast_cpu_exec.cc
396                     arch/alpha/simple_cpu_exec.cc
397                     arch/alpha/full_cpu_exec.cc'''),
398            Split('''arch/alpha/isa_desc
399		     arch/isa_parser.py'''),
400            '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/alpha')
401
402
403# libelf build is described in its own SConscript file.
404# SConscript-local is the per-config build, which just copies some
405# header files into a place where they can be found.
406SConscript('libelf/SConscript-local', exports = 'env', duplicate=0)
407SConscript('python/SConscript', exports = ['env'], duplicate=0)
408
409# This function adds the specified sources to the given build
410# environment, and returns a list of all the corresponding SCons
411# Object nodes (including an extra one for date.cc).  We explicitly
412# add the Object nodes so we can set up special dependencies for
413# date.cc.
414def make_objs(sources, env):
415    objs = [env.Object(s) for s in sources]
416    # make date.cc depend on all other objects so it always gets
417    # recompiled whenever anything else does
418    date_obj = env.Object('base/date.cc')
419    env.Depends(date_obj, objs)
420    objs.append(date_obj)
421    return objs
422
423###################################################
424#
425# Define binaries.  Each different build type (debug, opt, etc.) gets
426# a slightly different build environment.
427#
428###################################################
429
430# Include file paths are rooted in this directory.  SCons will
431# automatically expand '.' to refer to both the source directory and
432# the corresponding build directory to pick up generated include
433# files.
434env.Append(CPPPATH='.')
435
436# Debug binary
437debugEnv = env.Copy(OBJSUFFIX='.do')
438debugEnv.Label = 'debug'
439debugEnv.Append(CCFLAGS=Split('-g -gstabs+ -O0'))
440debugEnv.Append(CPPDEFINES='DEBUG')
441tlist = debugEnv.Program(target = 'm5.debug',
442                         source = make_objs(sources, debugEnv))
443debugEnv.M5Binary = tlist[0]
444
445# Optimized binary
446optEnv = env.Copy()
447optEnv.Label = 'opt'
448optEnv.Append(CCFLAGS=Split('-g -O5'))
449tlist = optEnv.Program(target = 'm5.opt',
450                       source = make_objs(sources, optEnv))
451optEnv.M5Binary = tlist[0]
452
453# "Fast" binary
454fastEnv = env.Copy(OBJSUFFIX='.fo')
455fastEnv.Label = 'fast'
456fastEnv.Append(CCFLAGS=Split('-O5'))
457fastEnv.Append(CPPDEFINES='NDEBUG')
458fastEnv.Program(target = 'm5.fast.unstripped',
459                source = make_objs(sources, fastEnv))
460tlist = fastEnv.Command(target = 'm5.fast',
461                        source = 'm5.fast.unstripped',
462                        action = 'strip $SOURCE -o $TARGET')
463fastEnv.M5Binary = tlist[0]
464
465# Profiled binary
466profEnv = env.Copy(OBJSUFFIX='.po')
467profEnv.Label = 'prof'
468profEnv.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
469tlist = profEnv.Program(target = 'm5.prof',
470                        source = make_objs(sources, profEnv))
471profEnv.M5Binary = tlist[0]
472
473envList = [debugEnv, optEnv, fastEnv, profEnv]
474
475Return('envList')
476