src/mem/protocol/MI_example-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: MOESI_SMP_directory-msg.sm 1.8 05/01/19 15:48:36-06:00 mikem@royal16.cs.wisc.edu $
  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   WB_ACK,    desc="Writeback ack";
  42   WB_NACK,   desc="Writeback neg. ack";
  43   INV,       desc="Invalidation";
  44   FWD,      desc="Generic FWD";
  45 }
  46
  47 // CoherenceResponseType
  48 enumeration(CoherenceResponseType, desc="...") {
  49   ACK,               desc="ACKnowledgment, responder doesn't have a copy";
  50   DATA,              desc="Data";
  51   DATA_EXCLUSIVE_CLEAN, desc="Data, no other processor has a copy, data is clean";
  52   DATA_EXCLUSIVE_DIRTY, desc="Data, no other processor has a copy, data is dirty";
  53   UNBLOCK,           desc="Unblock";
  54   UNBLOCK_EXCLUSIVE, desc="Unblock, we're in E/M";
  55   WRITEBACK_CLEAN,   desc="Clean writeback (no data)";
  56   WRITEBACK_DIRTY,   desc="Dirty writeback (contains data)";
  57   WRITEBACK,         desc="Generic writeback (contains data)";
  58 }
  59
  60 // TriggerType
  61 enumeration(TriggerType, desc="...") {
  62   ALL_ACKS,            desc="See corresponding event";
  63 }
  64
  65 // TriggerMsg
  66 structure(TriggerMsg, desc="...", interface="Message") {
  67   Address Address,             desc="Physical address for this request";
  68   TriggerType Type,            desc="Type of trigger";
  69 }
  70
  71 // RequestMsg (and also forwarded requests)
  72 structure(RequestMsg, desc="...", interface="NetworkMessage") {
  73   Address Address,             desc="Physical address for this request";
  74   CoherenceRequestType Type,   desc="Type of request (GetS, GetX, PutX, etc)";
  75   MachineID Requestor,            desc="Node who initiated the request";
  76   NetDest Destination,             desc="Multicast destination mask";
  77   DataBlock DataBlk,           desc="data for the cache line";
  78   MessageSizeType MessageSize, desc="size category of the message";
  79 }
  80
  81 // ResponseMsg (and also unblock requests)
  82 structure(ResponseMsg, desc="...", interface="NetworkMessage") {
  83   Address Address,             desc="Physical address for this request";
  84   CoherenceResponseType Type,  desc="Type of response (Ack, Data, etc)";
  85   MachineID Sender,               desc="Node who sent the data";
  86   NetDest Destination,             desc="Node to whom the data is sent";
  87   DataBlock DataBlk,           desc="data for the cache line";
  88   bool Dirty,                  desc="Is the data dirty (different than memory)?";
  89   MessageSizeType MessageSize, desc="size category of the message";
  90 }
  91
  92 enumeration(DMARequestType, desc="...", default="DMARequestType_NULL") {
  93   READ,          desc="Memory Read";
  94   WRITE,         desc="Memory Write";
  95   NULL,          desc="Invalid";
  96 }
  97
  98 enumeration(DMAResponseType, desc="...", default="DMAResponseType_NULL") {
  99   DATA,          desc="DATA read";
 100   ACK,           desc="ACK write";
 101   NULL,          desc="Invalid";
 102 }
 103
 104 structure(DMARequestMsg, desc="...", interface="NetworkMessage") {
 105   DMARequestType Type,       desc="Request type (read/write)";
 106   Address PhysicalAddress,   desc="Physical address for this request";
 107   Address LineAddress,       desc="Line address for this request";
 108   MachineID Requestor,            desc="Node who initiated the request";
 109   NetDest Destination,       desc="Destination";
 110   DataBlock DataBlk,         desc="DataBlk attached to this request";
 111   int Len,                   desc="The length of the request";
 112   MessageSizeType MessageSize, desc="size category of the message";
 113 }
 114
 115 structure(DMAResponseMsg, desc="...", interface="NetworkMessage") {
 116   DMAResponseType Type,      desc="Response type (DATA/ACK)";
 117   Address PhysicalAddress,   desc="Physical address for this request";
 118   Address LineAddress,       desc="Line address for this request";
 119   NetDest Destination,       desc="Destination";
 120   DataBlock DataBlk,         desc="DataBlk attached to this request";
 121   MessageSizeType MessageSize, desc="size category of the message";
 122 }