mem.hh revision 11139
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 * Authors: Andreas Sandberg 38 */ 39#ifndef __SIM_PROBE_MEM_HH__ 40#define __SIM_PROBE_MEM_HH__ 41 42#include <memory> 43 44#include "mem/packet.hh" 45#include "sim/probe/probe.hh" 46 47namespace ProbePoints { 48 49/** 50 * A struct to hold on to the essential fields from a packet, so that 51 * the packet and underlying request can be safely passed on, and 52 * consequently modified or even deleted. 53 */ 54struct PacketInfo { 55 MemCmd cmd; 56 Addr addr; 57 uint32_t size; 58 Request::FlagsType flags; 59 60 explicit PacketInfo(const PacketPtr& pkt) : 61 cmd(pkt->cmd), 62 addr(pkt->getAddr()), 63 size(pkt->getSize()), 64 flags(pkt->req->getFlags()) { } 65}; 66 67/** 68 * Packet probe point 69 * 70 * This probe point provides a unified interface for components that 71 * want to instrument Packets in the memory system. Components should 72 * when possible adhere to the following naming scheme: 73 * 74 * <ul> 75 * 76 * <li>PktRequest: Requests sent out on the memory side of a normal 77 * components and incoming requests for memories. Packets should 78 * not be duplicated (i.e., a packet should only appear once 79 * irrespective of the receiving end requesting a retry). 80 * 81 * <li>PktResponse: Response received from the memory side of a 82 * normal component or a response being sent out from a memory. 83 * 84 * <li>PktRequestCPU: Incoming, accepted, memory request on the CPU 85 * side of a two-sided component. This probe point is primarily 86 * intended for components that cache or forward requests (e.g., 87 * caches and XBars), single-sided components should use 88 * PktRequest instead. The probe point should only be called 89 * when a packet is accepted. 90 * 91 * <li>PktResponseCPU: Outgoing response memory request on the CPU 92 * side of a two-sided component. This probe point is primarily 93 * intended for components that cache or forward requests (e.g., 94 * caches and XBars), single-sided components should use 95 * PktRequest instead. 96 * 97 * </ul> 98 * 99 */ 100typedef ProbePointArg<PacketInfo> Packet; 101typedef std::unique_ptr<Packet> PacketUPtr; 102 103} 104 105#endif 106