src/mem/protocol/MOESI_hammer-msg.sm

   1 /*
   2  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   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  * AMD's contributions to the MOESI hammer protocol do not constitute an
  29  * endorsement of its similarity to any AMD products.
  30  */
  31
  32 // CoherenceRequestType
  33 enumeration(CoherenceRequestType, desc="...") {
  34   GETX,      desc="Get eXclusive";
  35   GETS,      desc="Get Shared";
  36   MERGED_GETS, desc="Get Shared";
  37   PUT,       desc="Put Ownership";
  38   WB_ACK,    desc="Writeback ack";
  39   WB_NACK,   desc="Writeback neg. ack";
  40   INV,       desc="Invalidate";
  41 }
  42
  43 // CoherenceResponseType
  44 enumeration(CoherenceResponseType, desc="...") {
  45   ACK,                desc="ACKnowledgment, responder does not have a copy";
  46   ACK_SHARED,         desc="ACKnowledgment, responder has a shared copy";
  47   DATA,               desc="Data, responder does not have a copy";
  48   DATA_SHARED,        desc="Data, responder has a shared copy";
  49   DATA_EXCLUSIVE,     desc="Data, responder was exclusive, gave us a copy, and they went to invalid";
  50   WB_CLEAN,           desc="Clean writeback";
  51   WB_DIRTY,           desc="Dirty writeback";
  52   WB_EXCLUSIVE_CLEAN, desc="Clean writeback of exclusive data";
  53   WB_EXCLUSIVE_DIRTY, desc="Dirty writeback of exclusive data";
  54   UNBLOCK,            desc="Unblock for writeback";
  55   UNBLOCKS,            desc="Unblock now in S";
  56   UNBLOCKM,            desc="Unblock now in M/O/E";
  57   NULL,               desc="Null value";
  58 }
  59
  60 // TriggerType
  61 enumeration(TriggerType, desc="...") {
  62   L2_to_L1,            desc="L2 to L1 transfer";
  63   ALL_ACKS,            desc="See corresponding event";
  64   ALL_ACKS_OWNER_EXISTS,desc="See corresponding event";
  65   ALL_ACKS_NO_SHARERS, desc="See corresponding event";
  66   ALL_UNBLOCKS,        desc="all unblockS received";
  67 }
  68
  69 // TriggerMsg
  70 structure(TriggerMsg, desc="...", interface="Message") {
  71   Address Address,             desc="Physical address for this request";
  72   TriggerType Type,            desc="Type of trigger";
  73 }
  74
  75 // RequestMsg (and also forwarded requests)
  76 structure(RequestMsg, desc="...", interface="NetworkMessage") {
  77   Address Address,             desc="Physical address for this request";
  78   CoherenceRequestType Type,   desc="Type of request (GetS, GetX, PutX, etc)";
  79   MachineID Requestor,            desc="Node who initiated the request";
  80   NetDest MergedRequestors,    desc="Merge set of read requestors";
  81   NetDest Destination,             desc="Multicast destination mask";
  82   MessageSizeType MessageSize, desc="size category of the message";
  83   bool DirectedProbe, default="false", desc="probe filter directed probe";
  84   Time InitialRequestTime, default="0", desc="time the initial requests was sent from the L1Cache";
  85   Time ForwardRequestTime, default="0", desc="time the dir forwarded the request";
  86   int SilentAcks, default="0", desc="silent acks from the full-bit directory";
  87 }
  88
  89 // ResponseMsg (and also unblock requests)
  90 structure(ResponseMsg, desc="...", interface="NetworkMessage") {
  91   Address Address,             desc="Physical address for this request";
  92   CoherenceResponseType Type,  desc="Type of response (Ack, Data, etc)";
  93   MachineID Sender,               desc="Node who sent the data";
  94   MachineID CurOwner,      desc="current owner of the block, used for UnblockS responses";
  95   NetDest Destination,             desc="Node to whom the data is sent";
  96   DataBlock DataBlk,           desc="data for the cache line";
  97   bool Dirty,                  desc="Is the data dirty (different than memory)?";
  98   int Acks, default="0",    desc="How many messages this counts as";
  99   MessageSizeType MessageSize, desc="size category of the message";
 100   Time InitialRequestTime, default="0", desc="time the initial requests was sent from the L1Cache";
 101   Time ForwardRequestTime, default="0", desc="time the dir forwarded the request";
 102   int SilentAcks, default="0", desc="silent acks from the full-bit directory";
 103 }
 104
 105 enumeration(DMARequestType, desc="...", default="DMARequestType_NULL") {
 106   READ,          desc="Memory Read";
 107   WRITE,         desc="Memory Write";
 108   NULL,          desc="Invalid";
 109 }
 110
 111 enumeration(DMAResponseType, desc="...", default="DMAResponseType_NULL") {
 112   DATA,          desc="DATA read";
 113   ACK,           desc="ACK write";
 114   NULL,          desc="Invalid";
 115 }
 116
 117 structure(DMARequestMsg, desc="...", interface="NetworkMessage") {
 118   DMARequestType Type,       desc="Request type (read/write)";
 119   Address PhysicalAddress,   desc="Physical address for this request";
 120   Address LineAddress,       desc="Line address for this request";
 121   MachineID Requestor,            desc="Node who initiated the request";
 122   NetDest Destination,       desc="Destination";
 123   DataBlock DataBlk,         desc="DataBlk attached to this request";
 124   int Len,                   desc="The length of the request";
 125   MessageSizeType MessageSize, desc="size category of the message";
 126 }
 127
 128 structure(DMAResponseMsg, desc="...", interface="NetworkMessage") {
 129   DMAResponseType Type,      desc="Response type (DATA/ACK)";
 130   Address PhysicalAddress,   desc="Physical address for this request";
 131   Address LineAddress,       desc="Line address for this request";
 132   NetDest Destination,       desc="Destination";
 133   DataBlock DataBlk,         desc="DataBlk attached to this request";
 134   MessageSizeType MessageSize, desc="size category of the message";
 135 }