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