SConscript revision 2670:9107b8bd08cd 
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#
29# Authors: Steve Reinhardt
30
31import os
32import sys
33from os.path import isdir
34
35# This file defines how to build a particular configuration of M5
36# based on variable settings in the 'env' build environment.
37
38# Import build environment variable from SConstruct.
39Import('env')
40
41###################################################
42#
43# Define needed sources.
44#
45###################################################
46
47# Base sources used by all configurations.
48
49base_sources = Split('''
50	base/circlebuf.cc
51	base/cprintf.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/serializer.cc
66	base/socket.cc
67	base/statistics.cc
68	base/str.cc
69	base/time.cc
70	base/trace.cc
71	base/traceflags.cc
72	base/userinfo.cc
73	base/compression/lzss_compression.cc
74	base/loader/aout_object.cc
75	base/loader/ecoff_object.cc
76	base/loader/elf_object.cc
77	base/loader/object_file.cc
78	base/loader/symtab.cc
79	base/stats/events.cc
80	base/stats/statdb.cc
81	base/stats/visit.cc
82	base/stats/text.cc
83
84        cpu/activity.cc
85	cpu/base.cc
86	cpu/cpu_exec_context.cc
87	cpu/cpuevent.cc
88	cpu/exetrace.cc
89        cpu/op_class.cc
90	cpu/pc_event.cc
91        cpu/quiesce_event.cc
92	cpu/static_inst.cc
93        cpu/sampler/sampler.cc
94
95        encumbered/cpu/full/fu_pool.cc
96        
97        mem/bridge.cc
98        mem/bus.cc
99        mem/connector.cc
100        mem/mem_object.cc
101        mem/packet.cc
102        mem/physical.cc
103        mem/port.cc
104
105	sim/builder.cc
106	sim/configfile.cc
107	sim/debug.cc
108	sim/eventq.cc
109	sim/faults.cc
110	sim/main.cc
111	sim/param.cc
112	sim/profile.cc
113	sim/root.cc
114	sim/serialize.cc
115	sim/sim_events.cc
116	sim/sim_exit.cc
117	sim/sim_object.cc
118	sim/startup.cc
119	sim/stat_context.cc
120	sim/stat_control.cc
121	sim/system.cc
122	sim/trace_context.cc
123        ''')
124
125# Old FullCPU sources
126full_cpu_sources = Split('''
127	encumbered/cpu/full/bpred.cc
128	encumbered/cpu/full/commit.cc
129	encumbered/cpu/full/cpu.cc
130	encumbered/cpu/full/create_vector.cc
131	encumbered/cpu/full/cv_spec_state.cc
132	encumbered/cpu/full/dd_queue.cc
133	encumbered/cpu/full/dep_link.cc
134	encumbered/cpu/full/dispatch.cc
135	encumbered/cpu/full/dyn_inst.cc
136	encumbered/cpu/full/execute.cc
137	encumbered/cpu/full/fetch.cc
138	encumbered/cpu/full/floss_reasons.cc
139	encumbered/cpu/full/fu_pool.cc
140	encumbered/cpu/full/inst_fifo.cc
141	encumbered/cpu/full/instpipe.cc
142	encumbered/cpu/full/issue.cc
143	encumbered/cpu/full/ls_queue.cc
144	encumbered/cpu/full/machine_queue.cc
145        encumbered/cpu/full/pipetrace.cc
146        encumbered/cpu/full/readyq.cc
147        encumbered/cpu/full/reg_info.cc
148        encumbered/cpu/full/rob_station.cc
149        encumbered/cpu/full/spec_memory.cc
150        encumbered/cpu/full/spec_state.cc
151        encumbered/cpu/full/storebuffer.cc
152        encumbered/cpu/full/writeback.cc
153        encumbered/cpu/full/iq/iq_station.cc
154        encumbered/cpu/full/iq/iqueue.cc
155        encumbered/cpu/full/iq/segmented/chain_info.cc
156        encumbered/cpu/full/iq/segmented/chain_wire.cc
157        encumbered/cpu/full/iq/segmented/iq_seg.cc
158        encumbered/cpu/full/iq/segmented/iq_segmented.cc
159        encumbered/cpu/full/iq/segmented/seg_chain.cc
160        encumbered/cpu/full/iq/seznec/iq_seznec.cc
161        encumbered/cpu/full/iq/standard/iq_standard.cc
162        ''')
163
164trace_reader_sources = Split('''
165        cpu/trace/reader/mem_trace_reader.cc
166        cpu/trace/reader/ibm_reader.cc
167        cpu/trace/reader/itx_reader.cc
168        cpu/trace/reader/m5_reader.cc
169        cpu/trace/opt_cpu.cc
170        cpu/trace/trace_cpu.cc
171        ''')
172
173
174
175# MySql sources
176mysql_sources = Split('''
177	base/mysql.cc
178	base/stats/mysql.cc
179        ''')
180
181# Full-system sources
182full_system_sources = Split('''
183	base/crc.cc
184	base/inet.cc
185	base/remote_gdb.cc
186
187	cpu/intr_control.cc
188        cpu/profile.cc
189
190	dev/alpha_console.cc
191	dev/baddev.cc
192	dev/disk_image.cc
193	dev/etherbus.cc
194	dev/etherdump.cc
195	dev/etherint.cc
196	dev/etherlink.cc
197	dev/etherpkt.cc
198	dev/ethertap.cc	
199        dev/ide_ctrl.cc
200	dev/ide_disk.cc
201	dev/io_device.cc
202	dev/isa_fake.cc
203	dev/ns_gige.cc
204	dev/pciconfigall.cc
205	dev/pcidev.cc
206	dev/pcifake.cc
207	dev/pktfifo.cc
208	dev/platform.cc
209        dev/simconsole.cc
210	dev/simple_disk.cc
211	dev/sinic.cc
212	dev/tsunami.cc
213	dev/tsunami_cchip.cc
214	dev/tsunami_io.cc
215	dev/tsunami_fake.cc
216	dev/tsunami_pchip.cc
217
218	dev/uart.cc
219	dev/uart8250.cc
220
221	kern/kernel_binning.cc
222	kern/kernel_stats.cc
223	kern/system_events.cc
224	kern/linux/events.cc
225	kern/linux/linux_syscalls.cc
226	kern/linux/printk.cc
227
228        mem/vport.cc
229
230	sim/pseudo_inst.cc
231        ''')
232
233
234if env['TARGET_ISA'] == 'alpha':
235    full_system_sources += Split('''
236	kern/tru64/dump_mbuf.cc
237	kern/tru64/printf.cc
238	kern/tru64/tru64_events.cc
239	kern/tru64/tru64_syscalls.cc
240        ''')
241
242# turbolaser encumbered sources
243turbolaser_sources = Split('''
244	encumbered/dev/dma.cc
245	encumbered/dev/etherdev.cc
246	encumbered/dev/scsi.cc
247	encumbered/dev/scsi_ctrl.cc
248	encumbered/dev/scsi_disk.cc
249	encumbered/dev/scsi_none.cc
250	encumbered/dev/tlaser_clock.cc
251	encumbered/dev/tlaser_ipi.cc
252	encumbered/dev/tlaser_mbox.cc
253	encumbered/dev/tlaser_mc146818.cc
254	encumbered/dev/tlaser_node.cc
255	encumbered/dev/tlaser_pcia.cc
256	encumbered/dev/tlaser_pcidev.cc
257	encumbered/dev/tlaser_serial.cc
258	encumbered/dev/turbolaser.cc
259	encumbered/dev/uart8530.cc
260        ''')
261
262# Syscall emulation (non-full-system) sources
263syscall_emulation_sources = Split('''
264        mem/translating_port.cc
265        mem/page_table.cc
266	sim/process.cc
267	sim/syscall_emul.cc
268        ''')
269
270#if env['TARGET_ISA'] == 'alpha':
271#    syscall_emulation_sources += Split('''
272#        kern/tru64/tru64.cc
273#        ''')
274
275alpha_eio_sources = Split('''
276	encumbered/eio/exolex.cc
277	encumbered/eio/libexo.cc
278	encumbered/eio/eio.cc
279        ''')
280
281if env['TARGET_ISA'] == 'ALPHA_ISA':
282    syscall_emulation_sources += alpha_eio_sources
283    
284memtest_sources = Split('''
285	cpu/memtest/memtest.cc
286        ''')
287
288# Add a flag defining what THE_ISA should be for all compilation
289env.Append(CPPDEFINES=[('THE_ISA','%s_ISA' % env['TARGET_ISA'].upper())])
290
291arch_sources = SConscript('arch/SConscript',
292                          exports = 'env', duplicate = False)
293
294cpu_sources = SConscript('cpu/SConscript',
295                         exports = 'env', duplicate = False)
296
297# This is outside of cpu/SConscript since the source directory isn't
298# underneath 'cpu'.
299if 'FullCPU' in env['CPU_MODELS']:
300    cpu_sources += full_cpu_sources
301
302# Set up complete list of sources based on configuration.
303sources = base_sources + arch_sources + cpu_sources
304
305if env['FULL_SYSTEM']:
306    sources += full_system_sources
307    if env['ALPHA_TLASER']:
308        sources += turbolaser_sources
309else:
310    sources += syscall_emulation_sources
311
312if env['USE_MYSQL']:
313    sources += mysql_sources
314
315for opt in env.ExportOptions:
316    env.ConfigFile(opt)
317
318###################################################
319#
320# Special build rules.
321#
322###################################################
323
324# base/traceflags.{cc,hh} are generated from base/traceflags.py.
325# $TARGET.base will expand to "<build-dir>/base/traceflags".
326env.Command(Split('base/traceflags.hh base/traceflags.cc'),
327            'base/traceflags.py',
328            'python $SOURCE $TARGET.base')
329
330SConscript('python/SConscript', exports = ['env'], duplicate=0)
331
332# This function adds the specified sources to the given build
333# environment, and returns a list of all the corresponding SCons
334# Object nodes (including an extra one for date.cc).  We explicitly
335# add the Object nodes so we can set up special dependencies for
336# date.cc.
337def make_objs(sources, env):
338    objs = [env.Object(s) for s in sources]
339    # make date.cc depend on all other objects so it always gets
340    # recompiled whenever anything else does
341    date_obj = env.Object('base/date.cc')
342    env.Depends(date_obj, objs)
343    objs.append(date_obj)
344    return objs
345
346###################################################
347#
348# Define binaries.  Each different build type (debug, opt, etc.) gets
349# a slightly different build environment.
350#
351###################################################
352
353# Include file paths are rooted in this directory.  SCons will
354# automatically expand '.' to refer to both the source directory and
355# the corresponding build directory to pick up generated include
356# files.
357env.Append(CPPPATH='.')
358
359# List of constructed environments to pass back to SConstruct
360envList = []
361
362# Function to create a new build environment as clone of current
363# environment 'env' with modified object suffix and optional stripped
364# binary.  Additional keyword arguments are appended to corresponding
365# build environment vars.
366def makeEnv(label, objsfx, strip = False, **kwargs):
367    newEnv = env.Copy(OBJSUFFIX=objsfx)
368    newEnv.Label = label
369    newEnv.Append(**kwargs)
370    exe = 'm5.' + label  # final executable
371    bin = exe + '.bin'   # executable w/o appended Python zip archive
372    newEnv.Program(bin, make_objs(sources, newEnv))
373    if strip:
374        stripped_bin = bin + '.stripped'
375        newEnv.Command(stripped_bin, bin, 'strip $SOURCE -o $TARGET')
376        bin = stripped_bin
377    targets = newEnv.Concat(exe, [bin, 'python/m5py.zip'])
378    newEnv.M5Binary = targets[0]
379    envList.append(newEnv)
380
381# Debug binary
382makeEnv('debug', '.do',
383        CCFLAGS = Split('-g3 -gdwarf-2 -O0'),
384        CPPDEFINES = 'DEBUG')
385
386# Optimized binary
387makeEnv('opt', '.o',
388        CCFLAGS = Split('-g -O3'))
389
390# "Fast" binary
391makeEnv('fast', '.fo', strip = True,
392        CCFLAGS = Split('-O3'),
393        CPPDEFINES = 'NDEBUG')
394
395# Profiled binary
396makeEnv('prof', '.po',
397        CCFLAGS = Split('-O3 -g -pg'),
398        LINKFLAGS = '-pg')
399
400Return('envList')
401