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