src/mem/protocol/MOESI_CMP_token-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 }
  40
  41 // PersistentType
  42 enumeration(PersistentRequestType, desc="...") {
  43   GETX_PERSISTENT,  desc="...";
  44   GETS_PERSISTENT,  desc="...";
  45   DEACTIVATE_PERSISTENT,desc="...";
  46 }
  47
  48 // CoherenceResponseType
  49 enumeration(CoherenceResponseType, desc="...") {
  50   DATA_OWNER,  desc="Data";
  51   ACK_OWNER,  desc="data-less owner token";
  52   DATA_SHARED, desc="Data";
  53   ACK,         desc="ACKnowledgment";
  54   WB_TOKENS,   desc="L1 to L2 writeback";
  55   WB_SHARED_DATA,   desc="L1 to L2 writeback with data";
  56   WB_OWNED,    desc="L1 to L2 writeback with data";
  57   INV,         desc="L1 informing L2 of loss of all tokens";
  58 }
  59
  60 // TriggerType
  61 enumeration(TriggerType, desc="...") {
  62   REQUEST_TIMEOUT,         desc="See corresponding event";
  63   USE_TIMEOUT,             desc="See corresponding event";
  64   DATA,                    desc="data for dma read response";
  65   DATA_ALL_TOKENS,         desc="data and all tokens for dma write response";
  66 }
  67
  68 // TriggerMsg
  69 structure(TriggerMsg, desc="...", interface="Message") {
  70   Address Address,             desc="Physical address for this request";
  71   TriggerType Type,            desc="Type of trigger";
  72 }
  73
  74 // PersistentMsg
  75 structure(PersistentMsg, desc="...", interface="NetworkMessage") {
  76   Address Address,             desc="Physical address for this request";
  77   PersistentRequestType Type,  desc="Type of starvation request";
  78   MachineID Requestor,            desc="Node who initiated the request";
  79   MachineType RequestorMachine,   desc="Type of machine who requested";
  80   NetDest Destination,             desc="Destination set";
  81   MachineType DestMachine,         desc="type of destination component";
  82   MessageSizeType MessageSize, desc="size category of the message";
  83   AccessModeType AccessMode,    desc="user/supervisor access type";
  84   PrefetchBit Prefetch,         desc="Is this a prefetch request";
  85 }
  86
  87 // RequestMsg
  88 structure(RequestMsg, desc="...", interface="NetworkMessage") {
  89   Address Address,             desc="Physical address for this request";
  90   CoherenceRequestType Type,   desc="Type of request (GetS, GetX, PutX, etc)";
  91   MachineID Requestor,            desc="Node who initiated the request";
  92   MachineType RequestorMachine,   desc="Type of machine who requested";
  93   MachineType DestMachine,        desc="Type of destination machine";
  94   NetDest Destination,             desc="Multicast destination mask";
  95   bool isLocal,                    desc="Is this request from a local L1";
  96   int RetryNum,                    desc="retry sequence number";
  97   MessageSizeType MessageSize, desc="size category of the message";
  98   AccessModeType AccessMode,    desc="user/supervisor access type";
  99   PrefetchBit Prefetch,         desc="Is this a prefetch request";
 100 }
 101
 102 // ResponseMsg
 103 structure(ResponseMsg, desc="...", interface="NetworkMessage") {
 104   Address Address,             desc="Physical address for this request";
 105   CoherenceResponseType Type,  desc="Type of response (Ack, Data, etc)";
 106   MachineID Sender,               desc="Node who sent the data";
 107   MachineType SenderMachine,     desc="component that is sending";
 108   NetDest Destination,             desc="Node to whom the data is sent";
 109   MachineType DestMachine,     desc="What component receives the data";
 110   int Tokens,                  desc="Number of tokens being transfered for this line";
 111   DataBlock DataBlk,           desc="data for the cache line";
 112   bool Dirty,                  desc="Is the data dirty (different than memory)?";
 113   MessageSizeType MessageSize, desc="size category of the message";
 114 }
 115
 116 enumeration(DMARequestType, desc="...", default="DMARequestType_NULL") {
 117   READ,          desc="Memory Read";
 118   WRITE,         desc="Memory Write";
 119   NULL,          desc="Invalid";
 120 }
 121
 122 enumeration(DMAResponseType, desc="...", default="DMAResponseType_NULL") {
 123   DATA,          desc="DATA read";
 124   ACK,           desc="ACK write";
 125   NULL,          desc="Invalid";
 126 }
 127
 128 structure(DMARequestMsg, desc="...", interface="NetworkMessage") {
 129   DMARequestType Type,       desc="Request type (read/write)";
 130   Address PhysicalAddress,   desc="Physical address for this request";
 131   Address LineAddress,       desc="Line address for this request";
 132   MachineID Requestor,            desc="Node who initiated the request";
 133   NetDest Destination,       desc="Destination";
 134   DataBlock DataBlk,         desc="DataBlk attached to this request";
 135   int Len,                   desc="The length of the request";
 136   MessageSizeType MessageSize, desc="size category of the message";
 137 }
 138
 139 structure(DMAResponseMsg, desc="...", interface="NetworkMessage") {
 140   DMAResponseType Type,      desc="Response type (DATA/ACK)";
 141   Address PhysicalAddress,   desc="Physical address for this request";
 142   Address LineAddress,       desc="Line address for this request";
 143   NetDest Destination,       desc="Destination";
 144   DataBlock DataBlk,         desc="DataBlk attached to this request";
 145   MessageSizeType MessageSize, desc="size category of the message";
 146 }