src/mem/protocol/MOSI_SMP_directory_1level-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: MOSI_directory-msg.sm 1.9 04/08/09 16:11:38-05:00 mikem@maya.cs.wisc.edu $
  32  *
  33  */
  34
  35 // CoherenceRequestType
  36 enumeration(CoherenceRequestType, desc="...") {
  37   GETX,      desc="Get eXclusive";
  38   GETS,      desc="Get Shared";
  39   GET_INSTR, desc="Get Instruction";
  40   PUTX,      desc="Put eXclusive";
  41   INV,       desc="INValidate";
  42   WB_ACK,    desc="Write Back ACKnowledgment";
  43 }
  44
  45 // CoherenceResponseType
  46 enumeration(CoherenceResponseType, desc="...") {
  47   ACK,       desc="ACKnowledgment";
  48   NACK,      desc="Negative ACKnowledgment";
  49   DATA,      desc="Data";
  50 }
  51
  52 // RequestMsg
  53 structure(RequestMsg, desc="...", interface="NetworkMessage") {
  54   Address Address,             desc="Physical address for this request";
  55   CoherenceRequestType Type,   desc="Type of request (GetS, GetX, PutX, etc)";
  56   MachineID Requestor,            desc="Node who initiated the request";
  57   NetDest Destination,             desc="Multicast destination mask";
  58   DataBlock DataBlk,           desc="Data for the cache line (if PUTX)";
  59   int NumPendingAcks,          desc="Number of acks to wait for"; // Needed for forwarded responses only
  60   MessageSizeType MessageSize, desc="size category of the message";
  61 }
  62
  63 // ResponseMsg
  64 structure(ResponseMsg, desc="...", interface="NetworkMessage") {
  65   Address Address,             desc="Physical address for this request";
  66   CoherenceResponseType Type,  desc="Type of response (Ack, Data, etc)";
  67   MachineID Sender,               desc="Node who sent the data";
  68   MachineType SenderMachine,   desc="What component sent the data";
  69   NetDest Destination,             desc="Node to whom the data is sent";
  70   MachineType DestMachine,     desc="What component receives the data";
  71   DataBlock DataBlk,           desc="data for the cache line";
  72   int NumPendingAcks,          desc="Number of acks to wait for";
  73   MessageSizeType MessageSize, desc="size category of the message";
  74 }