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