src/mem/cache/builder.cc

   1 /*
   2  * Copyright (c) 2003-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Erik Hallnor
  29  *          Nathan Binkert
  30  */
  31
  32 /**
  33  * @file
  34  * Simobject instatiation of caches.
  35  */
  36 #include <list>
  37 #include <vector>
  38
  39 #include "config/the_isa.hh"
  40 #include "mem/cache/base.hh"
  41 #include "mem/cache/cache.hh"
  42 #include "mem/config/cache.hh"
  43 #include "params/BaseCache.hh"
  44
  45 // Tag Templates
  46 #if defined(USE_CACHE_LRU)
  47 #include "mem/cache/tags/lru.hh"
  48 #endif
  49
  50 #if defined(USE_CACHE_FALRU)
  51 #include "mem/cache/tags/fa_lru.hh"
  52 #endif
  53
  54
  55 using namespace std;
  56
  57 #define BUILD_CACHE(TAGS, tags)                         \
  58     do {                                                \
  59         Cache<TAGS> *retval =                           \
  60             new Cache<TAGS>(this, tags);            \
  61         return retval;                                  \
  62     } while (0)
  63
  64 #define BUILD_CACHE_PANIC(x) do {                       \
  65         panic("%s not compiled into M5", x);            \
  66     } while (0)
  67
  68 #if defined(USE_CACHE_FALRU)
  69 #define BUILD_FALRU_CACHE do {                              \
  70         FALRU *tags = new FALRU(block_size, size, hit_latency); \
  71         BUILD_CACHE(FALRU, tags);                           \
  72     } while (0)
  73 #else
  74 #define BUILD_FALRU_CACHE BUILD_CACHE_PANIC("falru cache")
  75 #endif
  76
  77 #if defined(USE_CACHE_LRU)
  78 #define BUILD_LRU_CACHE do {                                            \
  79         LRU *tags = new LRU(numSets, block_size, assoc, hit_latency);       \
  80         BUILD_CACHE(LRU, tags);                                         \
  81     } while (0)
  82 #else
  83 #define BUILD_LRU_CACHE BUILD_CACHE_PANIC("lru cache")
  84 #endif
  85
  86 BaseCache *
  87 BaseCacheParams::create()
  88 {
  89     int numSets = size / (assoc * block_size);
  90
  91     if (numSets == 1) {
  92         BUILD_FALRU_CACHE;
  93     } else {
  94         BUILD_LRU_CACHE;
  95     }
  96
  97     return NULL;
  98 }