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