src/mem/protocol/MOESI_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   GETS,      desc="Get Shared";
  39   PUTX,      desc="Put eXclusive";
  40   PUTO,      desc="Put Owned";
  41   PUTO_SHARERS,      desc="Put Owned, but sharers exist so don't remove from sharers list";
  42   PUTS,      desc="Put Shared";
  43   WB_ACK,    desc="Writeback ack";
  44   WB_ACK_DATA,    desc="Writeback ack";
  45   WB_NACK,   desc="Writeback neg. ack";
  46   INV,       desc="Invalidation";
  47 }
  48
  49 // CoherenceResponseType
  50 enumeration(CoherenceResponseType, desc="...") {
  51   ACK,               desc="ACKnowledgment, responder doesn't have a copy";
  52   DATA,              desc="Data";
  53   DATA_EXCLUSIVE,    desc="Data, no processor has a copy";
  54   UNBLOCK,           desc="Unblock";
  55   UNBLOCK_EXCLUSIVE, desc="Unblock, we're in E/M";
  56   WRITEBACK_CLEAN_DATA,   desc="Clean writeback (contains data)";
  57   WRITEBACK_CLEAN_ACK,   desc="Clean writeback (contains no data)";
  58   WRITEBACK_DIRTY_DATA,   desc="Dirty writeback (contains data)";
  59 }
  60
  61 // TriggerType
  62 enumeration(TriggerType, desc="...") {
  63   ALL_ACKS,            desc="See corresponding event";
  64 }
  65
  66 // TriggerMsg
  67 structure(TriggerMsg, desc="...", interface="Message") {
  68   Address Address,             desc="Physical address for this request";
  69   TriggerType Type,            desc="Type of trigger";
  70 }
  71
  72 // RequestMsg (and also forwarded requests)
  73 structure(RequestMsg, desc="...", interface="NetworkMessage") {
  74   Address Address,             desc="Physical address for this request";
  75   CoherenceRequestType Type,   desc="Type of request (GetS, GetX, PutX, etc)";
  76   MachineID Requestor,            desc="Node who initiated the request";
  77   MachineType RequestorMachine,   desc="type of component";
  78   NetDest Destination,             desc="Multicast destination mask";
  79   int Acks,                    desc="How many acks to expect";
  80   MessageSizeType MessageSize, desc="size category of the message";
  81   AccessModeType AccessMode,    desc="user/supervisor access type";
  82   PrefetchBit Prefetch,         desc="Is this a prefetch request";
  83 }
  84
  85 // ResponseMsg (and also unblock requests)
  86 structure(ResponseMsg, desc="...", interface="NetworkMessage") {
  87   Address Address,             desc="Physical address for this request";
  88   CoherenceResponseType Type,  desc="Type of response (Ack, Data, etc)";
  89   MachineID Sender,               desc="Node who sent the data";
  90   MachineType SenderMachine,   desc="type of component sending msg";
  91   NetDest Destination,             desc="Node to whom the data is sent";
  92   DataBlock DataBlk,           desc="data for the cache line";
  93   bool Dirty,                  desc="Is the data dirty (different than memory)?";
  94   int Acks,                    desc="How many acks to expect";
  95   MessageSizeType MessageSize, desc="size category of the message";
  96 }
  97
  98 GenericRequestType convertToGenericType(CoherenceRequestType type) {
  99   if(type == CoherenceRequestType:PUTX) {
 100     return GenericRequestType:PUTX;
 101   } else if(type == CoherenceRequestType:GETS) {
 102     return GenericRequestType:GETS;
 103   } else if(type == CoherenceRequestType:GETX) {
 104     return GenericRequestType:GETX;
 105   } else if(type == CoherenceRequestType:PUTS) {
 106     return GenericRequestType:PUTS;
 107   } else if(type == CoherenceRequestType:PUTX) {
 108     return GenericRequestType:PUTS;
 109   } else if(type == CoherenceRequestType:PUTO) {
 110     return GenericRequestType:PUTO;
 111   } else if(type == CoherenceRequestType:PUTO_SHARERS) {
 112     return GenericRequestType:PUTO;
 113   } else if(type == CoherenceRequestType:INV) {
 114     return GenericRequestType:INV;
 115   } else if(type == CoherenceRequestType:WB_ACK) {
 116     return GenericRequestType:WB_ACK;
 117   } else if(type == CoherenceRequestType:WB_ACK_DATA) {
 118     return GenericRequestType:WB_ACK;
 119   } else if(type == CoherenceRequestType:WB_NACK) {
 120     return GenericRequestType:NACK;
 121   } else {
 122     DEBUG_EXPR(type);
 123     error("invalid CoherenceRequestType");
 124   }
 125 }
 126