src/mem/protocol/MOSI_SMP_bcast-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   GET_INSTR, desc="Get Instruction";
  38   GETS,      desc="Get Shared";
  39   GETX,      desc="Get eXclusive";
  40   PUTX,      desc="Put eXclusive";
  41 }
  42
  43 // AddressMsg
  44 structure(AddressMsg, desc="...", interface="NetworkMessage") {
  45   Address Address,       desc="Physical address for this request";
  46   CoherenceRequestType Type, desc="Type of request (GetS, GetX, PutX, etc)";
  47   int CacheState, default="1000", desc="Hack to transfer the cache's state for profiling"; // The default of 1000 will generate an error if we forget to set this
  48   MachineID Requestor,     desc="Node who initiated the request";
  49   NetDest Destination,           desc="Multicast destination mask";
  50   DataBlock DataBlk,         desc="data for the cache line";  // This is used for PutX and Downgrades only
  51   MessageSizeType MessageSize, desc="size category of the message";
  52 }
  53
  54 // DataMsg
  55 structure(DataMsg, desc="...", interface="NetworkMessage") {
  56   Address Address,       desc="Physical address for this request";
  57   MachineID Sender,        desc="Node who sent the data";
  58   //  MachineType SenderType,    desc="Component who sent data";
  59   NetDest Destination,           desc="Node to whom the data is sent";
  60   MachineType DestMachine,   desc="What component receives the data";
  61   DataBlock DataBlk,         desc="data for the cache line";
  62   MessageSizeType MessageSize, desc="size category of the message";
  63 }
  64
  65 GenericRequestType convertToGenericType(CoherenceRequestType type) {
  66   if(type == CoherenceRequestType:PUTX) {
  67     return GenericRequestType:PUTX;
  68   } else if(type == CoherenceRequestType:GETS) {
  69     return GenericRequestType:GETS;
  70   } else if(type == CoherenceRequestType:GET_INSTR) {
  71     return GenericRequestType:GET_INSTR;
  72   } else if(type == CoherenceRequestType:GETX) {
  73     return GenericRequestType:GETX;
  74   } else {
  75     DEBUG_EXPR(type);
  76     error("invalid CoherenceRequestType");
  77   }
  78 }
  79