src/mem/protocol/MESI_SCMP_bankdirectory-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: MSI_MOSI_CMP_directory-msg.sm 1.5 05/01/19 15:48:37-06:00 mikem@royal16.cs.wisc.edu $
  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   INV,       desc="INValidate";
  42   PUTX,      desc="replacement message";
  43 }
  44
  45 // CoherenceResponseType
  46 enumeration(CoherenceResponseType, desc="...") {
  47   MEMORY_ACK,  desc="Ack from memory controller";
  48   DATA,      desc="Data";
  49   DATA_EXCLUSIVE,      desc="Data";
  50   MEMORY_DATA,    desc="Data";
  51   ACK,            desc="Generic invalidate ack";
  52   WB_ACK,            desc="writeback ack";
  53   UNBLOCK,         desc="unblock";
  54   EXCLUSIVE_UNBLOCK,         desc="exclusive unblock";
  55 }
  56
  57 // RequestMsg
  58 structure(RequestMsg, desc="...", interface="NetworkMessage") {
  59   Address Address,              desc="Physical address for this request";
  60   CoherenceRequestType Type,    desc="Type of request (GetS, GetX, PutX, etc)";
  61   AccessModeType AccessMode,    desc="user/supervisor access type";
  62   MachineID Requestor      ,    desc="What component request";
  63   NetDest Destination,          desc="What components receive the request, includes MachineType and num";
  64   MessageSizeType MessageSize,  desc="size category of the message";
  65   DataBlock DataBlk,            desc="Data for the cache line (if PUTX)";
  66   bool Dirty, default="false",  desc="Dirty bit";
  67   PrefetchBit Prefetch,         desc="Is this a prefetch request";
  68 }
  69
  70 // ResponseMsg
  71 structure(ResponseMsg, desc="...", interface="NetworkMessage") {
  72   Address Address,              desc="Physical address for this request";
  73   CoherenceResponseType Type,   desc="Type of response (Ack, Data, etc)";
  74   MachineID Sender,             desc="What component sent the data";
  75   NetDest Destination,          desc="Node to whom the data is sent";
  76   DataBlock DataBlk,            desc="Data for the cache line";
  77   bool Dirty, default="false",  desc="Dirty bit";
  78   int AckCount, default="0",  desc="number of acks in this message";
  79   MessageSizeType MessageSize,  desc="size category of the message";
  80 }
  81
  82 /*
  83 GenericRequestType convertToGenericType(CoherenceRequestType type) {
  84   if(type == CoherenceRequestType:PUTX) {
  85     return GenericRequestType:PUTX;
  86   } else if(type == CoherenceRequestType:GETS) {
  87     return GenericRequestType:GETS;
  88   } else if(type == CoherenceRequestType:GET_INSTR) {
  89     return GenericRequestType:GET_INSTR;
  90   } else if(type == CoherenceRequestType:GETX) {
  91     return GenericRequestType:GETX;
  92   } else if(type == CoherenceRequestType:UPGRADE) {
  93     return GenericRequestType:UPGRADE;
  94   } else if(type == CoherenceRequestType:PUTS) {
  95     return GenericRequestType:PUTS;
  96   } else if(type == CoherenceRequestType:INV) {
  97     return GenericRequestType:INV;
  98   } else if(type == CoherenceRequestType:INV_S) {
  99     return GenericRequestType:INV_S;
 100   } else if(type == CoherenceRequestType:L1_DG) {
 101     return GenericRequestType:DOWNGRADE;
 102   } else if(type == CoherenceRequestType:WB_ACK) {
 103     return GenericRequestType:WB_ACK;
 104   } else if(type == CoherenceRequestType:EXE_ACK) {
 105     return GenericRequestType:EXE_ACK;
 106   } else {
 107     DEBUG_EXPR(type);
 108     error("invalid CoherenceRequestType");
 109   }
 110 }
 111 */
 112