gem5  v22.0.0.1
dist_packet.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 /* @file
39  * Header packet class for dist-gem5 runs.
40  *
41  * For a high level description about dist-gem5 see comments in
42  * header file dist_iface.hh.
43  *
44  * The DistHeaderPkt class defines the format of message headers
45  * sent among gem5 processes during a dist gem5 simulation. A header packet
46  * can either carry the description of data packet (i.e. a simulated Ethernet
47  * packet) or a synchronisation related control command. In case of
48  * data packet description, the corresponding data packet always follows
49  * the header packet back-to-back.
50  */
51 #ifndef __DEV_DIST_PACKET_HH__
52 #define __DEV_DIST_PACKET_HH__
53 
54 #include <cstring>
55 
56 #include "base/types.hh"
57 
58 namespace gem5
59 {
60 
62 {
63  private:
66 
67  public:
72  enum class MsgType
73  {
75  cmdSyncReq,
76  cmdSyncAck,
77  unknown
78  };
79 
80  struct Header
81  {
94  unsigned simLength;
95  union
96  {
99  };
100  union
101  {
107  struct
108  {
112  };
113  };
114  };
115 };
116 
117 } // namespace gem5
118 
119 #endif // __DEV_DIST_PACKET_HH__
gem5::DistHeaderPkt::Header
Definition: dist_packet.hh:80
gem5::DistHeaderPkt::MsgType::unknown
@ unknown
gem5::DistHeaderPkt::MsgType::cmdSyncAck
@ cmdSyncAck
gem5::DistHeaderPkt::MsgType::cmdSyncReq
@ cmdSyncReq
gem5::DistHeaderPkt::ReqType::collective
@ collective
gem5::DistHeaderPkt::DistHeaderPkt
DistHeaderPkt()
Definition: dist_packet.hh:64
gem5::DistHeaderPkt::ReqType
ReqType
Definition: dist_packet.hh:68
gem5::DistHeaderPkt::Header::needCkpt
ReqType needCkpt
Definition: dist_packet.hh:109
gem5::DistHeaderPkt::Header::syncRepeat
Tick syncRepeat
Definition: dist_packet.hh:98
gem5::DistHeaderPkt::Header::msgType
MsgType msgType
The msg type field is valid for all header packets.
Definition: dist_packet.hh:88
gem5::DistHeaderPkt::Header::needStopSync
ReqType needStopSync
Definition: dist_packet.hh:110
gem5::DistHeaderPkt
Definition: dist_packet.hh:61
gem5::DistHeaderPkt::ReqType::none
@ none
gem5::DistHeaderPkt::Header::simLength
unsigned simLength
Length used for modeling timing in the simulator.
Definition: dist_packet.hh:94
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::DistHeaderPkt::Header::sendTick
Tick sendTick
Definition: dist_packet.hh:89
gem5::DistHeaderPkt::MsgType
MsgType
The msg type defines what information a dist header packet carries.
Definition: dist_packet.hh:72
gem5::DistHeaderPkt::MsgType::dataDescriptor
@ dataDescriptor
gem5::DistHeaderPkt::ReqType::immediate
@ immediate
types.hh
gem5::DistHeaderPkt::Header::sendDelay
Tick sendDelay
Definition: dist_packet.hh:97
gem5::DistHeaderPkt::Header::dataPacketLength
unsigned dataPacketLength
Actual length of the simulated Ethernet packet.
Definition: dist_packet.hh:106
gem5::DistHeaderPkt::~DistHeaderPkt
~DistHeaderPkt()
Definition: dist_packet.hh:65
gem5::DistHeaderPkt::ReqType::pending
@ pending
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: gpu_translation_state.hh:37
gem5::DistHeaderPkt::Header::needExit
ReqType needExit
Definition: dist_packet.hh:111

Generated on Sat Jun 18 2022 08:12:24 for gem5 by doxygen 1.8.17