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