SConscript revision 1127
1# -*- mode:python -*-
2
3# Copyright (c) 2004 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
29import os
30import sys
31
32# This file defines how to build a particular configuration of M5
33# based on variable settings in the 'env' build environment.
34
35# Import build environment variable from SConstruct.
36Import('env')
37
38###################################################
39#
40# Define needed sources.
41#
42###################################################
43
44# Base sources used by all configurations.
45base_sources = Split('''
46	arch/alpha/decoder.cc
47	arch/alpha/fast_cpu_exec.cc
48	arch/alpha/simple_cpu_exec.cc
49	arch/alpha/full_cpu_exec.cc
50	arch/alpha/faults.cc
51	arch/alpha/isa_traits.cc
52
53	base/circlebuf.cc
54	base/copyright.cc
55	base/cprintf.cc
56	base/fast_alloc.cc
57	base/fifo_buffer.cc
58	base/hostinfo.cc
59	base/hybrid_pred.cc
60	base/inifile.cc
61	base/intmath.cc
62	base/match.cc
63	base/misc.cc
64	base/pollevent.cc
65	base/python.cc
66	base/range.cc
67	base/sat_counter.cc
68	base/socket.cc
69	base/statistics.cc
70	base/str.cc
71	base/time.cc
72	base/trace.cc
73	base/traceflags.cc
74	base/userinfo.cc
75	base/compression/lzss_compression.cc
76	base/loader/aout_object.cc
77	base/loader/ecoff_object.cc
78	base/loader/elf_object.cc
79	base/loader/object_file.cc
80	base/loader/symtab.cc
81	base/stats/events.cc
82	base/stats/python.cc
83	base/stats/statdb.cc
84	base/stats/visit.cc
85	base/stats/text.cc
86
87	cpu/base_cpu.cc
88	cpu/exec_context.cc
89	cpu/exetrace.cc
90	cpu/pc_event.cc
91	cpu/static_inst.cc
92	cpu/fast_cpu/fast_cpu.cc
93	cpu/full_cpu/bpred.cc
94	cpu/full_cpu/commit.cc
95	cpu/full_cpu/create_vector.cc
96	cpu/full_cpu/cv_spec_state.cc
97	cpu/full_cpu/dd_queue.cc
98	cpu/full_cpu/dep_link.cc
99	cpu/full_cpu/dispatch.cc
100	cpu/full_cpu/dyn_inst.cc
101	cpu/full_cpu/execute.cc
102	cpu/full_cpu/fetch.cc
103	cpu/full_cpu/floss_reasons.cc
104	cpu/full_cpu/fu_pool.cc
105	cpu/full_cpu/full_cpu.cc
106	cpu/full_cpu/inst_fifo.cc
107	cpu/full_cpu/instpipe.cc
108	cpu/full_cpu/issue.cc
109	cpu/full_cpu/ls_queue.cc
110	cpu/full_cpu/machine_queue.cc
111	cpu/full_cpu/pipetrace.cc
112	cpu/full_cpu/readyq.cc
113	cpu/full_cpu/reg_info.cc
114	cpu/full_cpu/rob_station.cc
115	cpu/full_cpu/spec_memory.cc
116	cpu/full_cpu/spec_state.cc
117	cpu/full_cpu/storebuffer.cc
118	cpu/full_cpu/writeback.cc
119	cpu/full_cpu/iq/iq_station.cc
120	cpu/full_cpu/iq/iqueue.cc
121	cpu/full_cpu/iq/segmented/chain_info.cc
122	cpu/full_cpu/iq/segmented/chain_wire.cc
123	cpu/full_cpu/iq/segmented/iq_seg.cc
124	cpu/full_cpu/iq/segmented/iq_segmented.cc
125	cpu/full_cpu/iq/segmented/seg_chain.cc
126	cpu/full_cpu/iq/seznec/iq_seznec.cc
127	cpu/full_cpu/iq/standard/iq_standard.cc
128	cpu/sampling_cpu/sampling_cpu.cc
129	cpu/simple_cpu/simple_cpu.cc
130	cpu/trace/reader/mem_trace_reader.cc
131	cpu/trace/reader/ibm_reader.cc
132	cpu/trace/reader/itx_reader.cc
133	cpu/trace/reader/m5_reader.cc
134
135	mem/base_hier.cc
136	mem/base_mem.cc
137	mem/hier_params.cc
138	mem/mem_cmd.cc
139	mem/mem_debug.cc
140	mem/mem_req.cc
141	mem/memory_interface.cc
142	mem/bus/base_interface.cc
143	mem/bus/bus.cc
144	mem/bus/bus_bridge.cc
145	mem/bus/bus_bridge_master.cc
146	mem/bus/bus_bridge_slave.cc
147	mem/bus/bus_interface.cc
148	mem/bus/dma_bus_interface.cc
149	mem/bus/dma_interface.cc
150	mem/bus/master_interface.cc
151	mem/bus/slave_interface.cc
152	mem/cache/base_cache.cc
153	mem/cache/cache.cc
154	mem/cache/cache_builder.cc
155	mem/cache/coherence/coherence_protocol.cc
156	mem/cache/coherence/uni_coherence.cc
157	mem/cache/miss/blocking_buffer.cc
158	mem/cache/miss/miss_queue.cc
159	mem/cache/miss/mshr.cc
160	mem/cache/miss/mshr_queue.cc
161	mem/cache/tags/base_tags.cc
162	mem/cache/tags/cache_tags.cc
163	mem/cache/tags/fa_lru.cc
164	mem/cache/tags/iic.cc
165	mem/cache/tags/lru.cc
166	mem/cache/tags/split.cc
167	mem/cache/tags/split_lifo.cc
168	mem/cache/tags/split_lru.cc
169	mem/cache/tags/repl/gen.cc
170	mem/cache/tags/repl/repl.cc
171	mem/functional_mem/functional_memory.cc
172	mem/functional_mem/main_memory.cc
173	mem/timing_mem/base_memory.cc
174	mem/timing_mem/memory_builder.cc
175	mem/timing_mem/simple_mem_bank.cc
176        mem/trace/itx_writer.cc
177	mem/trace/mem_trace_writer.cc
178	mem/trace/m5_writer.cc
179
180	sim/builder.cc
181	sim/configfile.cc
182	sim/debug.cc
183	sim/eventq.cc
184	sim/main.cc
185	sim/param.cc
186	sim/profile.cc
187	sim/serialize.cc
188	sim/sim_events.cc
189	sim/sim_exit.cc
190	sim/sim_object.cc
191	sim/startup.cc
192	sim/stat_context.cc
193	sim/stat_control.cc
194	sim/trace_context.cc
195	sim/universe.cc
196        sim/pyconfig/pyconfig.cc
197        sim/pyconfig/code.cc
198        ''')
199
200base_obj_desc_files = Split('''
201        cpu/full_cpu/iq/segmented/SegmentedIQ.od
202        cpu/full_cpu/iq/seznec/SeznecIQ.od
203        cpu/full_cpu/iq/standard/StandardIQ.od
204        cpu/full_cpu/iq/BaseIQ.od
205        cpu/full_cpu/BranchPred.od
206        cpu/full_cpu/FUDesc.od
207        cpu/full_cpu/FullCPU.od
208        cpu/full_cpu/FuncUnitPool.od
209        cpu/full_cpu/OpDesc.od
210        cpu/full_cpu/PipeTrace.od
211        cpu/sampling_cpu/SamplingCPU.od
212        cpu/simple_cpu/SimpleCPU.od
213        cpu/BaseCPU.od
214        cpu/IntrControl.od
215        mem/bus/Bus.od
216        mem/bus/BusBridge.od
217        mem/cache/coherence/CoherenceProtocol.od
218        mem/cache/tags/repl/GenRepl.od
219        mem/cache/tags/repl/Repl.od
220        mem/cache/BaseCache.od
221        mem/functional_mem/FunctionalMemory.od
222        mem/functional_mem/MainMemory.od
223        mem/functional_mem/MemoryController.od
224        mem/functional_mem/PhysicalMemory.od
225        mem/timing_mem/BaseMemory.od
226        mem/BaseHier.od
227        mem/BaseMem.od
228        mem/HierParams.od
229        ''')
230
231
232# MySql sources
233mysql_sources = Split('''
234	base/mysql.cc
235	base/stats/mysql.cc
236        ''')
237
238# Full-system sources
239full_system_sources = Split('''
240	arch/alpha/alpha_memory.cc
241	arch/alpha/arguments.cc
242	arch/alpha/ev5.cc
243	arch/alpha/osfpal.cc
244	arch/alpha/pseudo_inst.cc
245	arch/alpha/vtophys.cc
246
247	base/crc.cc
248	base/inet.cc
249	base/remote_gdb.cc
250
251	cpu/intr_control.cc
252
253	dev/alpha_console.cc
254	dev/baddev.cc
255        dev/simconsole.cc
256	dev/disk_image.cc
257	dev/dma.cc
258	dev/etherbus.cc
259	dev/etherdump.cc
260	dev/etherint.cc
261	dev/etherlink.cc
262	dev/etherpkt.cc
263	dev/ethertap.cc
264	dev/ide_ctrl.cc
265	dev/ide_disk.cc
266	dev/io_device.cc
267	dev/ns_gige.cc
268	dev/etherdev.cc
269	dev/pciconfigall.cc
270	dev/pcidev.cc
271	dev/scsi.cc
272	dev/scsi_ctrl.cc
273	dev/scsi_disk.cc
274	dev/scsi_none.cc
275	dev/simple_disk.cc
276	dev/tlaser_clock.cc
277	dev/tlaser_ipi.cc
278	dev/tlaser_mbox.cc
279	dev/tlaser_mc146818.cc
280	dev/tlaser_node.cc
281	dev/tlaser_pcia.cc
282	dev/tlaser_pcidev.cc
283	dev/tlaser_serial.cc
284	dev/turbolaser.cc
285	dev/tsunami.cc
286	dev/tsunami_cchip.cc
287	dev/tsunami_fake.cc
288	dev/tsunami_io.cc
289	dev/tsunami_pchip.cc
290	dev/uart.cc
291
292	kern/kernel_binning.cc
293	kern/kernel_stats.cc
294	kern/system_events.cc
295	kern/linux/linux_events.cc
296	kern/linux/linux_syscalls.cc
297	kern/linux/linux_system.cc
298	kern/linux/printk.cc
299	kern/tru64/dump_mbuf.cc
300	kern/tru64/printf.cc
301	kern/tru64/tru64_events.cc
302	kern/tru64/tru64_syscalls.cc
303	kern/tru64/tru64_system.cc
304
305	mem/functional_mem/memory_control.cc
306	mem/functional_mem/physical_memory.cc
307        dev/platform.cc
308
309	sim/system.cc
310        ''')
311
312full_system_obj_desc_files = Split('''
313        arch/alpha/AlphaDTB.od
314        arch/alpha/AlphaITB.od
315        arch/alpha/AlphaTLB.od
316        dev/AlphaConsole.od
317        dev/ConsoleListener.od
318        dev/CowDiskImage.od
319        dev/DiskImage.od
320        dev/DmaDevice.od
321        dev/DmaEngine.od
322        dev/EtherBus.od
323        dev/EtherDev.od
324        dev/EtherDevInt.od
325        dev/EtherDump.od
326        dev/EtherInt.od
327        dev/EtherLink.od
328        dev/EtherTap.od
329        dev/PioDevice.od
330        dev/RawDiskImage.od
331        dev/ScsiController.od
332        dev/ScsiDevice.od
333        dev/ScsiDisk.od
334        dev/SimConsole.od
335        dev/SimpleDisk.od
336        dev/TlaserClock.od
337        dev/TlaserIpi.od
338        dev/TlaserMBox.od
339        dev/TlaserMC146818.od
340        dev/TlaserNode.od
341        dev/TlaserPciDev.od
342        dev/TlaserPcia.od
343        dev/TlaserSerial.od
344        dev/TlaserUart.od
345        dev/Turbolaser.od
346        kern/tru64/Tru64System.od
347        sim/System.od
348	''')
349
350# Syscall emulation (non-full-system) sources
351syscall_emulation_sources = Split('''
352	arch/alpha/alpha_common_syscall_emul.cc
353	arch/alpha/alpha_linux_process.cc
354	arch/alpha/alpha_tru64_process.cc
355	cpu/memtest/memtest.cc
356        cpu/trace/opt_cpu.cc
357	cpu/trace/trace_cpu.cc
358	eio/eio.cc
359	eio/exolex.cc
360	eio/libexo.cc
361	sim/process.cc
362	sim/syscall_emul.cc
363        ''')
364
365syscall_emulation_obj_desc_files = Split('''
366        cpu/memtest/MemTest.od
367        eio/EioProcess.od
368        sim/LiveProcess.od
369        sim/Process.od
370	''')
371
372targetarch_files = Split('''
373        alpha_common_syscall_emul.hh
374        alpha_linux_process.hh
375        alpha_memory.hh
376        alpha_tru64_process.hh
377        aout_machdep.h
378        arguments.hh
379        byte_swap.hh
380        ecoff_machdep.h
381        elf_machdep.h
382        ev5.hh
383        faults.hh
384        isa_fullsys_traits.hh
385        isa_traits.hh
386        machine_exo.h
387        osfpal.hh
388        pseudo_inst.hh
389        vptr.hh
390        vtophys.hh
391        ''')
392
393for f in targetarch_files:
394    env.Command('targetarch/' + f, 'arch/alpha/' + f,
395                '''echo '#include "arch/alpha/%s"' > $TARGET''' % f)
396
397
398# Set up complete list of sources based on configuration.
399sources = base_sources
400obj_desc_files = base_obj_desc_files
401
402if env['FULL_SYSTEM']:
403    sources += full_system_sources
404    obj_desc_files += full_system_obj_desc_files
405else:
406    sources += syscall_emulation_sources
407    obj_desc_files += syscall_emulation_obj_desc_files
408
409extra_libraries = []
410if env['USE_MYSQL']:
411    sources += mysql_sources
412    env.Append(CPPDEFINES = 'USE_MYSQL')
413    env.Append(CPPDEFINES = 'STATS_BINNING')
414    env.Append(CPPPATH=['/usr/local/include/mysql', '/usr/include/mysql'])
415    env.Append(LIBS=['z'])
416    if os.path.isdir('/usr/lib64'):
417        env.Append(LIBPATH=['/usr/lib64/mysql'])
418    else:
419        env.Append(LIBPATH=['/usr/lib/mysql/'])
420    env.Append(LIBS=['mysqlclient'])
421
422
423###################################################
424#
425# Special build rules.
426#
427###################################################
428
429# base/traceflags.{cc,hh} are generated from base/traceflags.py.
430# $TARGET.base will expand to "<build-dir>/base/traceflags".
431env.Command(Split('base/traceflags.hh base/traceflags.cc'),
432            'base/traceflags.py',
433            'python $SOURCE $TARGET.base')
434
435# several files are generated from arch/$TARGET_ISA/isa_desc.
436env.Command(Split('''arch/alpha/decoder.cc
437		     arch/alpha/decoder.hh
438		     arch/alpha/fast_cpu_exec.cc
439                     arch/alpha/simple_cpu_exec.cc
440                     arch/alpha/full_cpu_exec.cc'''),
441            Split('''arch/alpha/isa_desc
442		     arch/isa_parser.py'''),
443            '$SRCDIR/arch/isa_parser.py $SOURCE $TARGET.dir arch/alpha')
444
445
446# libelf build is described in its own SConscript file.
447# SConscript-local is the per-config build, which just copies some
448# header files into a place where they can be found.
449SConscript('libelf/SConscript-local', exports = 'env', duplicate=0)
450
451SConscript('sim/pyconfig/SConscript', exports = ['env', 'obj_desc_files'],
452           duplicate=0)
453
454
455# This function adds the specified sources to the given build
456# environment, and returns a list of all the corresponding SCons
457# Object nodes (including an extra one for date.cc).  We explicitly
458# add the Object nodes so we can set up special dependencies for
459# date.cc.
460def make_objs(sources, env):
461    objs = [env.Object(s) for s in sources]
462    # make date.cc depend on all other objects so it always gets
463    # recompiled whenever anything else does
464    date_obj = env.Object('base/date.cc')
465    env.Depends(date_obj, objs)
466    objs.append(date_obj)
467    objs.extend(extra_libraries)
468    return objs
469
470###################################################
471#
472# Define binaries.  Each different build type (debug, opt, etc.) gets
473# a slightly different build environment.
474#
475###################################################
476
477# Include file paths are rooted in this directory.  SCons will
478# automatically expand '.' to refer to both the source directory and
479# the corresponding build directory to pick up generated include
480# files.
481env.Append(CPPPATH='.')
482
483# Debug binary
484debug = env.Copy(OBJSUFFIX='.do')
485debug.Append(CCFLAGS=Split('-g -gstabs+ -O0'))
486debug.Append(CPPDEFINES='DEBUG')
487debug.Program(target = 'm5.debug', source = make_objs(sources, debug))
488
489# Optimized binary
490opt = env.Copy()
491opt.Append(CCFLAGS=Split('-g -O5'))
492opt.Program(target = 'm5.opt', source = make_objs(sources, opt))
493
494# "Fast" binary
495fast = env.Copy(OBJSUFFIX='.fo')
496fast.Append(CCFLAGS=Split('-O5'))
497fast.Append(CPPDEFINES='NDEBUG')
498fast.Program(target = 'm5.fast.unstripped', source = make_objs(sources, fast))
499fast.Command(target = 'm5.fast', source = 'm5.fast.unstripped',
500             action = 'strip $SOURCE -o $TARGET')
501
502# Profiled binary
503prof = env.Copy(OBJSUFFIX='.po')
504prof.Append(CCFLAGS=Split('-O5 -g -pg'), LINKFLAGS='-pg')
505prof.Program(target = 'm5.prof', source = make_objs(sources, prof))
506