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   DMA_READ,  desc="DMA Read";
  49   DMA_WRITE, desc="DMA Write";
  50 }
  51
  52 // CoherenceResponseType
  53 enumeration(CoherenceResponseType, desc="...") {
  54   ACK,               desc="ACKnowledgment, responder doesn't have a copy";
  55   DATA,              desc="Data";
  56   DATA_EXCLUSIVE,    desc="Data, no processor has a copy";
  57   UNBLOCK,           desc="Unblock";
  58   UNBLOCK_EXCLUSIVE, desc="Unblock, we're in E/M";
  59   WRITEBACK_CLEAN_DATA,   desc="Clean writeback (contains data)";
  60   WRITEBACK_CLEAN_ACK,   desc="Clean writeback (contains no data)";
  61   WRITEBACK_DIRTY_DATA,   desc="Dirty writeback (contains data)";
  62
  63   DMA_ACK,           desc="Ack that a DMA write completed";
  64 }
  65
  66 // TriggerType
  67 enumeration(TriggerType, desc="...") {
  68   ALL_ACKS,            desc="See corresponding event";
  69 }
  70
  71 // TriggerMsg
  72 structure(TriggerMsg, desc="...", interface="Message") {
  73   Address Address,             desc="Physical address for this request";
  74   TriggerType Type,            desc="Type of trigger";
  75 }
  76
  77 // RequestMsg (and also forwarded requests)
  78 structure(RequestMsg, desc="...", interface="NetworkMessage") {
  79   Address Address,             desc="Physical address for this request";
  80   int Len,                     desc="Length of Request";
  81   CoherenceRequestType Type,   desc="Type of request (GetS, GetX, PutX, etc)";
  82   MachineID Requestor,            desc="Node who initiated the request";
  83   MachineType RequestorMachine,   desc="type of component";
  84   NetDest Destination,             desc="Multicast destination mask";
  85   DataBlock DataBlk,           desc="data for the cache line (DMA WRITE request)";
  86   int Acks,                    desc="How many acks to expect";
  87   MessageSizeType MessageSize, desc="size category of the message";
  88   AccessModeType AccessMode,    desc="user/supervisor access type";
  89   PrefetchBit Prefetch,         desc="Is this a prefetch request";
  90 }
  91
  92 // ResponseMsg (and also unblock requests)
  93 structure(ResponseMsg, desc="...", interface="NetworkMessage") {
  94   Address Address,             desc="Physical address for this request";
  95   CoherenceResponseType Type,  desc="Type of response (Ack, Data, etc)";
  96   MachineID Sender,               desc="Node who sent the data";
  97   MachineType SenderMachine,   desc="type of component sending msg";
  98   NetDest Destination,             desc="Node to whom the data is sent";
  99   DataBlock DataBlk,           desc="data for the cache line";
 100   bool Dirty,                  desc="Is the data dirty (different than memory)?";
 101   int Acks,                    desc="How many acks to expect";
 102   MessageSizeType MessageSize, desc="size category of the message";
 103 }
 104
 105