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