src/cpu/SConscript

   1 # -*- mode:python -*-
   2
   3 # Copyright (c) 2006 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
  31 Import('*')
  32
  33 #################################################################
  34 #
  35 # Generate StaticInst execute() method signatures.
  36 #
  37 # There must be one signature for each CPU model compiled in.
  38 # Since the set of compiled-in models is flexible, we generate a
  39 # header containing the appropriate set of signatures on the fly.
  40 #
  41 #################################################################
  42
  43 # CPU model-specific data is contained in cpu_models.py
  44 # Convert to SCons File node to get path handling
  45 models_db = File('cpu_models.py')
  46 # slurp in contents of file
  47 execfile(models_db.srcnode().abspath)
  48
  49 # Template for execute() signature.
  50 exec_sig_template = '''
  51 virtual Fault execute(%s *xc, Trace::InstRecord *traceData) const = 0;
  52 virtual Fault initiateAcc(%s *xc, Trace::InstRecord *traceData) const
  53 { panic("initiateAcc not defined!"); M5_DUMMY_RETURN };
  54 virtual Fault completeAcc(Packet *pkt, %s *xc,
  55                           Trace::InstRecord *traceData) const
  56 { panic("completeAcc not defined!"); M5_DUMMY_RETURN };
  57 '''
  58
  59 mem_ini_sig_template = '''
  60 virtual Fault initiateAcc(%s *xc, Trace::InstRecord *traceData) const { panic("Not defined!"); M5_DUMMY_RETURN };
  61 '''
  62
  63 mem_comp_sig_template = '''
  64 virtual Fault completeAcc(uint8_t *data, %s *xc, Trace::InstRecord *traceData) const { panic("Not defined!"); return NoFault; M5_DUMMY_RETURN };
  65 '''
  66
  67 # Generate a temporary CPU list, including the CheckerCPU if
  68 # it's enabled.  This isn't used for anything else other than StaticInst
  69 # headers.
  70 temp_cpu_list = env['CPU_MODELS'][:]
  71
  72 if env['USE_CHECKER']:
  73     temp_cpu_list.append('CheckerCPU')
  74
  75 # Generate header.
  76 def gen_cpu_exec_signatures(target, source, env):
  77     f = open(str(target[0]), 'w')
  78     print >> f, '''
  79 #ifndef __CPU_STATIC_INST_EXEC_SIGS_HH__
  80 #define __CPU_STATIC_INST_EXEC_SIGS_HH__
  81 '''
  82     for cpu in temp_cpu_list:
  83         xc_type = CpuModel.dict[cpu].strings['CPU_exec_context']
  84         print >> f, exec_sig_template % (xc_type, xc_type, xc_type)
  85     print >> f, '''
  86 #endif  // __CPU_STATIC_INST_EXEC_SIGS_HH__
  87 '''
  88
  89 # Generate string that gets printed when header is rebuilt
  90 def gen_sigs_string(target, source, env):
  91     return "Generating static_inst_exec_sigs.hh: " \
  92            + ', '.join(temp_cpu_list)
  93
  94 # Add command to generate header to environment.
  95 env.Command('static_inst_exec_sigs.hh', models_db,
  96             Action(gen_cpu_exec_signatures, gen_sigs_string,
  97                    varlist = temp_cpu_list))
  98
  99 env.Depends('static_inst_exec_sigs.hh', Value(env['USE_CHECKER']))
 100 env.Depends('static_inst_exec_sigs.hh', Value(env['CPU_MODELS']))
 101
 102 # List of suppported CPUs by the Checker.  Errors out if USE_CHECKER=True
 103 # and one of these are not being used.
 104 CheckerSupportedCPUList = ['O3CPU', 'OzoneCPU']
 105
 106 SimObject('BaseCPU.py')
 107 SimObject('FuncUnit.py')
 108 SimObject('ExeTracer.py')
 109 SimObject('IntelTrace.py')
 110
 111 Source('activity.cc')
 112 Source('base.cc')
 113 Source('cpuevent.cc')
 114 Source('exetrace.cc')
 115 Source('func_unit.cc')
 116 Source('inteltrace.cc')
 117 Source('pc_event.cc')
 118 Source('quiesce_event.cc')
 119 Source('static_inst.cc')
 120 Source('simple_thread.cc')
 121 Source('thread_state.cc')
 122
 123 if env['FULL_SYSTEM']:
 124     SimObject('IntrControl.py')
 125
 126     Source('intr_control.cc')
 127     Source('profile.cc')
 128
 129     if env['TARGET_ISA'] == 'sparc':
 130         SimObject('LegionTrace.py')
 131         Source('legiontrace.cc')
 132
 133 if env['TARGET_ISA'] == 'x86':
 134     SimObject('NativeTrace.py')
 135     Source('nativetrace.cc')
 136
 137 if env['USE_CHECKER']:
 138     Source('checker/cpu.cc')
 139     checker_supports = False
 140     for i in CheckerSupportedCPUList:
 141         if i in env['CPU_MODELS']:
 142             checker_supports = True
 143     if not checker_supports:
 144         print "Checker only supports CPU models",
 145         for i in CheckerSupportedCPUList:
 146             print i,
 147         print ", please set USE_CHECKER=False or use one of those CPU models"
 148         Exit(1)