src/mem/protocol/MSI_MOSI_CMP_directory-msg.sm

   1
   2 /*
   3  * Copyright (c) 1999-2005 Mark D. Hill and David A. Wood
   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
  30 /*
  31  * $Id$
  32  *
  33  */
  34
  35 // CoherenceRequestType
  36 enumeration(CoherenceRequestType, desc="...") {
  37   GETX,      desc="Get eXclusive";
  38   UPGRADE,   desc="UPGRADE to exclusive";
  39   GETS,      desc="Get Shared";
  40   GET_INSTR, desc="Get Instruction";
  41   PUTX,      desc="Put eXclusive";
  42   PUTS,      desc="Put Shared";
  43   INV,       desc="INValidate";
  44   INV_S,     desc="INValidate the shared version";
  45   L1_DG,     desc="L1 cache DownGrade";
  46   WB_ACK,    desc="Write Back ACKnowledgment";
  47   EXE_ACK,   desc="EXclusivE ACKnowledgment";
  48 }
  49
  50 // CoherenceResponseType
  51 enumeration(CoherenceResponseType, desc="...") {
  52   ACK,       desc="ACKnowledgment";
  53   INV_ACK,   desc="INValidation ACKnowledgment";
  54   DG_ACK,    desc="DownGrade ACKnowledgment";
  55   NACK,      desc="Negative ACKnowledgment";
  56   DATA,      desc="Data";
  57   DATA_S,    desc="Data to L1 cache, then imediately go to shared state";
  58   DATA_I,    desc="Data to L1 cache, then imediately go to inv state";
  59   FINALACK,  desc="";
  60 }
  61
  62 // RequestMsg
  63 structure(RequestMsg, desc="...", interface="NetworkMessage") {
  64   Address Address,              desc="Physical address for this request";
  65   CoherenceRequestType Type,    desc="Type of request (GetS, GetX, PutX, etc)";
  66   AccessModeType AccessMode,    desc="user/supervisor access type";
  67   MachineID RequestorMachId,    desc="What component request";
  68   NetDest Destination,          desc="What components receive the request, includes MachineType and num";
  69   DataBlock DataBlk,            desc="Data for the cache line (if PUTX)";
  70   int NumPendingExtAcks,        desc="Number of acks to wait for"; // Needed for forwarded responses only
  71   MessageSizeType MessageSize,  desc="size category of the message";
  72   std::string L1CacheStateStr,  desc="describes L1 cache block state";
  73   std::string L2CacheStateStr,  desc="describes L2 cache block state";
  74   PrefetchBit Prefetch,         desc="Is this a prefetch request";
  75 }
  76
  77 // ResponseMsg
  78 structure(ResponseMsg, desc="...", interface="NetworkMessage") {
  79   Address Address,              desc="Physical address for this request";
  80   CoherenceResponseType Type,   desc="Type of response (Ack, Data, etc)";
  81   MachineID SenderMachId,     desc="What component sent the data";
  82   NetDest Destination,          desc="Node to whom the data is sent";
  83   DataBlock DataBlk,            desc="data for the cache line";
  84   int NumPendingExtAcks,        desc="Number of acks to wait for";
  85   MessageSizeType MessageSize,  desc="size category of the message";
  86 }
  87
  88 GenericRequestType convertToGenericType(CoherenceRequestType type) {
  89   if(type == CoherenceRequestType:PUTX) {
  90     return GenericRequestType:PUTX;
  91   } else if(type == CoherenceRequestType:GETS) {
  92     return GenericRequestType:GETS;
  93   } else if(type == CoherenceRequestType:GET_INSTR) {
  94     return GenericRequestType:GET_INSTR;
  95   } else if(type == CoherenceRequestType:GETX) {
  96     return GenericRequestType:GETX;
  97   } else if(type == CoherenceRequestType:UPGRADE) {
  98     return GenericRequestType:UPGRADE;
  99   } else if(type == CoherenceRequestType:PUTS) {
 100     return GenericRequestType:PUTS;
 101   } else if(type == CoherenceRequestType:INV) {
 102     return GenericRequestType:INV;
 103   } else if(type == CoherenceRequestType:INV_S) {
 104     return GenericRequestType:INV_S;
 105   } else if(type == CoherenceRequestType:L1_DG) {
 106     return GenericRequestType:DOWNGRADE;
 107   } else if(type == CoherenceRequestType:WB_ACK) {
 108     return GenericRequestType:WB_ACK;
 109   } else if(type == CoherenceRequestType:EXE_ACK) {
 110     return GenericRequestType:EXE_ACK;
 111   } else {
 112     DEBUG_EXPR(type);
 113     error("invalid CoherenceRequestType");
 114   }
 115 }