src/mem/ruby/SConscript

   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
  31 from __future__ import print_function
  32
  33 import os
  34 import sys
  35
  36 from os.path import basename, isdir, join as joinpath
  37
  38 import SCons
  39
  40 from gem5_scons import Transform
  41
  42 Import('*')
  43
  44 if env['PROTOCOL'] == 'None':
  45     Return()
  46
  47 DebugFlag('ProtocolTrace')
  48 DebugFlag('RubyCache')
  49 DebugFlag('RubyCacheTrace')
  50 DebugFlag('RubyDma')
  51 DebugFlag('RubyGenerated')
  52 DebugFlag('RubyNetwork')
  53 DebugFlag('RubyPort')
  54 DebugFlag('RubyPrefetcher')
  55 DebugFlag('RubyQueue')
  56 DebugFlag('RubySequencer')
  57 DebugFlag('RubySlicc')
  58 DebugFlag('RubySystem')
  59 DebugFlag('RubyTester')
  60 DebugFlag('RubyStats')
  61 DebugFlag('RubyResourceStalls')
  62
  63 CompoundFlag('Ruby', [ 'RubyQueue', 'RubyNetwork', 'RubyTester',
  64     'RubyGenerated', 'RubySlicc', 'RubySystem', 'RubyCache',
  65     'RubyDma', 'RubyPort', 'RubySequencer', 'RubyCacheTrace',
  66     'RubyPrefetcher'])
  67
  68 def 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 #
 101 generated_dir = Dir('protocol')
 102
 103 def 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
 109 def 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
 114 MakeInclude('slicc_interface/AbstractCacheEntry.hh')
 115 MakeInclude('slicc_interface/Message.hh')
 116 MakeInclude('slicc_interface/RubyRequest.hh')
 117
 118 # External types
 119 MakeInclude('common/Address.hh')
 120 MakeInclude('common/BoolVec.hh')
 121 MakeInclude('common/DataBlock.hh')
 122 MakeInclude('common/IntVec.hh')
 123 MakeInclude('common/MachineID.hh')
 124 MakeInclude('common/NetDest.hh')
 125 MakeInclude('common/Set.hh')
 126 MakeInclude('common/WriteMask.hh')
 127 MakeInclude('network/MessageBuffer.hh')
 128 MakeInclude('structures/CacheMemory.hh')
 129 MakeInclude('structures/DirectoryMemory.hh')
 130 MakeInclude('structures/PerfectCacheMemory.hh')
 131 MakeInclude('structures/PersistentTable.hh')
 132 MakeInclude('structures/Prefetcher.hh')
 133 MakeInclude('structures/TBETable.hh')
 134 MakeInclude('structures/TimerTable.hh')
 135 MakeInclude('structures/WireBuffer.hh')
 136 MakeInclude('system/DMASequencer.hh')
 137 MakeInclude('system/Sequencer.hh')
 138
 139 # External types : Group "mem/ruby/protocol" : include "header.hh" to the
 140 # bottom of this MakeIncludes if it is referenced as
 141 # <# include "mem/ruby/protocol/header.hh"> in any file
 142 # generated_dir = Dir('protocol')
 143 MakeInclude('system/GPUCoalescer.hh')
 144 MakeInclude('system/VIPERCoalescer.hh')