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