SConscript revision 10310:61c7f1d06575 
1# -*- mode:python -*-
2
3# Copyright (c) 2009 The Hewlett-Packard Development Company
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: Nathan Binkert
30
31import os
32import sys
33
34from os.path import basename, isdir, join as joinpath
35
36import SCons
37
38Import('*')
39
40DebugFlag('ProtocolTrace')
41DebugFlag('RubyCache')
42DebugFlag('RubyCacheTrace')
43DebugFlag('RubyDma')
44DebugFlag('RubyGenerated')
45DebugFlag('RubyMemory')
46DebugFlag('RubyNetwork')
47DebugFlag('RubyPort')
48DebugFlag('RubyPrefetcher')
49DebugFlag('RubyQueue')
50DebugFlag('RubySequencer')
51DebugFlag('RubySlicc')
52DebugFlag('RubySystem')
53DebugFlag('RubyTester')
54DebugFlag('RubyStats')
55DebugFlag('RubyResourceStalls')
56
57CompoundFlag('Ruby', [ 'RubyQueue', 'RubyNetwork', 'RubyTester',
58    'RubyGenerated', 'RubySlicc', 'RubySystem', 'RubyCache',
59    'RubyMemory', 'RubyDma', 'RubyPort', 'RubySequencer', 'RubyCacheTrace',
60    'RubyPrefetcher'])
61
62if env['PROTOCOL'] == 'None':
63    Return()
64
65def do_embed_text(target, source, env):
66    """convert a text file into a file that can be embedded in C
67    using an #include statement, that defines a \"const char *\" pointing
68    to the same text.
69
70    This is useful to embed scripts and configuration files in object files.
71    """
72
73    escape = [ "\'", "\"", "\\", "\?" ]
74
75    # reads the text file in, line by line, converting it to a C string
76    fin = open(str(source[0]), 'r')
77    fout = open(str(target[0]), 'w' )
78    fout.write("static const char *%s =\n" % source[1].get_contents());
79    for l in fin:
80        # add escape sequences for the characters in escape
81        fout.write("\"")
82        for char in l:
83            if char == "\n":
84                break
85            if char in escape:
86                fout.write("\\")
87                fout.write(char)
88            else:
89                fout.write(char)
90        fout.write("\\n\"\n");
91    fout.write(";\n");
92    fin.close()
93    fout.close()
94
95#
96# Link includes
97#
98generated_dir = Dir('../protocol')
99
100def MakeIncludeAction(target, source, env):
101    f = file(str(target[0]), 'w')
102    for s in source:
103        print >>f, '#include "%s"' % str(s.abspath)
104    f.close()
105
106def MakeInclude(source):
107    target = generated_dir.File(basename(source))
108    include_action = MakeAction(MakeIncludeAction, Transform("MAKE INC", 1))
109    env.Command(target, source, include_action)
110
111MakeInclude('slicc_interface/AbstractEntry.hh')
112MakeInclude('slicc_interface/AbstractCacheEntry.hh')
113MakeInclude('slicc_interface/Message.hh')
114MakeInclude('slicc_interface/NetworkMessage.hh')
115MakeInclude('slicc_interface/RubyRequest.hh')
116
117# External types
118MakeInclude('common/Address.hh')
119MakeInclude('common/DataBlock.hh')
120MakeInclude('common/MachineID.hh')
121MakeInclude('common/NetDest.hh')
122MakeInclude('common/Set.hh')
123MakeInclude('filters/GenericBloomFilter.hh')
124MakeInclude('network/MessageBuffer.hh')
125MakeInclude('structures/Prefetcher.hh')
126MakeInclude('structures/CacheMemory.hh')
127MakeInclude('system/DMASequencer.hh')
128MakeInclude('structures/DirectoryMemory.hh')
129MakeInclude('structures/MemoryControl.hh')
130MakeInclude('structures/WireBuffer.hh')
131MakeInclude('structures/PerfectCacheMemory.hh')
132MakeInclude('structures/PersistentTable.hh')
133MakeInclude('system/Sequencer.hh')
134MakeInclude('structures/TBETable.hh')
135MakeInclude('structures/TimerTable.hh')
136