SConscript revision 2770:07a93a0da45b 
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	sim/builder.cc
105	sim/debug.cc
106	sim/eventq.cc
107	sim/faults.cc
108	sim/main.cc
109        python/swig/cc_main_wrap.cc
110	sim/param.cc
111	sim/root.cc
112	sim/serialize.cc
113	sim/sim_events.cc
114	sim/sim_object.cc
115	sim/startup.cc
116	sim/stat_context.cc
117	sim/stat_control.cc
118	sim/system.cc
119	sim/trace_context.cc
120        ''')
121
122# Old FullCPU sources
123full_cpu_sources = Split('''
124	encumbered/cpu/full/bpred.cc
125	encumbered/cpu/full/commit.cc
126	encumbered/cpu/full/cpu.cc
127	encumbered/cpu/full/create_vector.cc
128	encumbered/cpu/full/cv_spec_state.cc
129	encumbered/cpu/full/dd_queue.cc
130	encumbered/cpu/full/dep_link.cc
131	encumbered/cpu/full/dispatch.cc
132	encumbered/cpu/full/dyn_inst.cc
133	encumbered/cpu/full/execute.cc
134	encumbered/cpu/full/fetch.cc
135	encumbered/cpu/full/floss_reasons.cc
136	encumbered/cpu/full/fu_pool.cc
137	encumbered/cpu/full/inst_fifo.cc
138	encumbered/cpu/full/instpipe.cc
139	encumbered/cpu/full/issue.cc
140	encumbered/cpu/full/ls_queue.cc
141	encumbered/cpu/full/machine_queue.cc
142        encumbered/cpu/full/pipetrace.cc
143        encumbered/cpu/full/readyq.cc
144        encumbered/cpu/full/reg_info.cc
145        encumbered/cpu/full/rob_station.cc
146        encumbered/cpu/full/spec_memory.cc
147        encumbered/cpu/full/spec_state.cc
148        encumbered/cpu/full/storebuffer.cc
149        encumbered/cpu/full/writeback.cc
150        encumbered/cpu/full/iq/iq_station.cc
151        encumbered/cpu/full/iq/iqueue.cc
152        encumbered/cpu/full/iq/segmented/chain_info.cc
153        encumbered/cpu/full/iq/segmented/chain_wire.cc
154        encumbered/cpu/full/iq/segmented/iq_seg.cc
155        encumbered/cpu/full/iq/segmented/iq_segmented.cc
156        encumbered/cpu/full/iq/segmented/seg_chain.cc
157        encumbered/cpu/full/iq/seznec/iq_seznec.cc
158        encumbered/cpu/full/iq/standard/iq_standard.cc
159        ''')
160
161trace_reader_sources = Split('''
162        cpu/trace/reader/mem_trace_reader.cc
163        cpu/trace/reader/ibm_reader.cc
164        cpu/trace/reader/itx_reader.cc
165        cpu/trace/reader/m5_reader.cc
166        cpu/trace/opt_cpu.cc
167        cpu/trace/trace_cpu.cc
168        ''')
169
170
171
172# MySql sources
173mysql_sources = Split('''
174	base/mysql.cc
175	base/stats/mysql.cc
176        ''')
177
178# Full-system sources
179full_system_sources = Split('''
180	base/crc.cc
181	base/inet.cc
182	base/remote_gdb.cc
183
184	cpu/intr_control.cc
185        cpu/profile.cc
186
187	dev/alpha_console.cc
188	dev/baddev.cc
189	dev/disk_image.cc
190	dev/etherbus.cc
191	dev/etherdump.cc
192	dev/etherint.cc
193	dev/etherlink.cc
194	dev/etherpkt.cc
195	dev/ethertap.cc	
196        dev/ide_ctrl.cc
197	dev/ide_disk.cc
198	dev/io_device.cc
199	dev/isa_fake.cc
200	dev/ns_gige.cc
201	dev/pciconfigall.cc
202	dev/pcidev.cc
203	dev/pcifake.cc
204	dev/pktfifo.cc
205	dev/platform.cc
206        dev/simconsole.cc
207	dev/simple_disk.cc
208	dev/sinic.cc
209	dev/tsunami.cc
210	dev/tsunami_cchip.cc
211	dev/tsunami_io.cc
212	dev/tsunami_fake.cc
213	dev/tsunami_pchip.cc
214
215	dev/uart.cc
216	dev/uart8250.cc
217
218	kern/kernel_stats.cc
219	kern/system_events.cc
220	kern/linux/events.cc
221	kern/linux/linux_syscalls.cc
222	kern/linux/printk.cc
223
224        mem/vport.cc
225
226	sim/pseudo_inst.cc
227        ''')
228
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_ISA':
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('arch/SConscript', exports = 'env')
294
295cpu_sources = SConscript('cpu/SConscript', exports = 'env')
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'])
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# 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