gem5  [DEVELOP-FOR-23.0]
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
port_proxy.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, 2018 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 #include "mem/port_proxy.hh"
39 
40 #include "base/chunk_generator.hh"
41 #include "cpu/thread_context.hh"
42 #include "mem/port.hh"
43 
44 namespace gem5
45 {
46 
47 PortProxy::PortProxy(ThreadContext *tc, unsigned int cache_line_size) :
48  PortProxy([tc](PacketPtr pkt)->void { tc->sendFunctional(pkt); },
49  cache_line_size)
50 {}
51 
52 PortProxy::PortProxy(const RequestPort &port, unsigned int cache_line_size) :
53  PortProxy([&port](PacketPtr pkt)->void { port.sendFunctional(pkt); },
54  cache_line_size)
55 {}
56 
57 void
59  void *p, int size) const
60 {
61  for (ChunkGenerator gen(addr, size, _cacheLineSize); !gen.done();
62  gen.next()) {
63 
64  auto req = std::make_shared<Request>(
65  gen.addr(), gen.size(), flags, Request::funcRequestorId);
66 
67  Packet pkt(req, MemCmd::ReadReq);
68  pkt.dataStatic(static_cast<uint8_t *>(p));
69  sendFunctional(&pkt);
70  p = static_cast<uint8_t *>(p) + gen.size();
71  }
72 }
73 
74 void
76  const void *p, int size) const
77 {
78  for (ChunkGenerator gen(addr, size, _cacheLineSize); !gen.done();
79  gen.next()) {
80 
81  auto req = std::make_shared<Request>(
82  gen.addr(), gen.size(), flags, Request::funcRequestorId);
83 
84  Packet pkt(req, MemCmd::WriteReq);
85  pkt.dataStaticConst(static_cast<const uint8_t *>(p));
86  sendFunctional(&pkt);
87  p = static_cast<const uint8_t *>(p) + gen.size();
88  }
89 }
90 
91 void
93  uint8_t v, int size) const
94 {
95  // quick and dirty...
96  uint8_t *buf = new uint8_t[size];
97 
98  std::memset(buf, v, size);
99  PortProxy::writeBlobPhys(addr, flags, buf, size);
100 
101  delete [] buf;
102 }
103 
104 bool
105 PortProxy::tryWriteString(Addr addr, const char *str) const
106 {
107  do {
108  if (!tryWriteBlob(addr++, str, 1))
109  return false;
110  } while (*str++);
111  return true;
112 }
113 
114 bool
115 PortProxy::tryReadString(std::string &str, Addr addr) const
116 {
117  while (true) {
118  uint8_t c;
119  if (!tryReadBlob(addr++, &c, 1))
120  return false;
121  if (!c)
122  return true;
123  str += c;
124  }
125 }
126 
127 bool
128 PortProxy::tryReadString(char *str, Addr addr, size_t maxlen) const
129 {
130  assert(maxlen);
131  while (maxlen--) {
132  if (!tryReadBlob(addr++, str, 1))
133  return false;
134  if (!*str++)
135  return true;
136  }
137  // We ran out of room, so back up and add a terminator.
138  *--str = '\0';
139  return true;
140 }
141 
142 } // namespace gem5
gem5::PortProxy::tryWriteBlob
virtual bool tryWriteBlob(Addr addr, const void *p, int size) const
Write size bytes from p to address.
Definition: port_proxy.hh:157
gem5::Request::funcRequestorId
@ funcRequestorId
This requestor id is used for functional requests that don't come from a particular device.
Definition: request.hh:279
gem5::PortProxy::tryReadBlob
virtual bool tryReadBlob(Addr addr, void *p, int size) const
Methods to override in base classes.
Definition: port_proxy.hh:146
gem5::PortProxy::tryReadString
bool tryReadString(std::string &str, Addr addr) const
Reads the string at guest address addr into the std::string str.
Definition: port_proxy.cc:115
gem5::PortProxy::memsetBlobPhys
void memsetBlobPhys(Addr addr, Request::Flags flags, uint8_t v, int size) const
Fill size bytes starting at physical addr with byte value val.
Definition: port_proxy.cc:92
gem5::PortProxy::sendFunctional
SendFunctionalFunc sendFunctional
Definition: port_proxy.hh:92
gem5::RequestPort
A RequestPort is a specialisation of a Port, which implements the default protocol for the three diff...
Definition: port.hh:118
gem5::ChunkGenerator
This class takes an arbitrary memory region (address/length pair) and generates a series of appropria...
Definition: chunk_generator.hh:59
gem5::Packet::dataStatic
void dataStatic(T *p)
Set the data pointer to the following value that should not be freed.
Definition: packet.hh:1175
gem5::VegaISA::c
Bitfield< 2 > c
Definition: pagetable.hh:63
gem5::Flags< FlagsType >
gem5::RequestPort::sendFunctional
void sendFunctional(PacketPtr pkt) const
Send a functional request packet, where the data is instantly updated everywhere in the memory system...
Definition: port.hh:563
gem5::ChunkGenerator::done
bool done() const
Are we done? That is, did the last call to next() advance past the end of the region?
Definition: chunk_generator.hh:141
gem5::ThreadContext
ThreadContext is the external interface to all thread state for anything outside of the CPU.
Definition: thread_context.hh:88
gem5::VegaISA::p
Bitfield< 54 > p
Definition: pagetable.hh:70
gem5::PortProxy::tryWriteString
bool tryWriteString(Addr addr, const char *str) const
Write the string str into guest memory at address addr.
Definition: port_proxy.cc:105
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:294
gem5::MemCmd::ReadReq
@ ReadReq
Definition: packet.hh:87
port_proxy.hh
gem5::PortProxy
This object is a proxy for a port or other object which implements the functional response protocol,...
Definition: port_proxy.hh:86
port.hh
flags
uint8_t flags
Definition: helpers.cc:66
gem5::ThreadContext::sendFunctional
virtual void sendFunctional(PacketPtr pkt)
Definition: thread_context.cc:158
gem5::PortProxy::writeBlobPhys
void writeBlobPhys(Addr addr, Request::Flags flags, const void *p, int size) const
Write size bytes from p to physical address.
Definition: port_proxy.cc:75
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::PortProxy::PortProxy
PortProxy(SendFunctionalFunc func, unsigned int cache_line_size)
Definition: port_proxy.hh:106
gem5::PortProxy::_cacheLineSize
const unsigned int _cacheLineSize
Granularity of any transactions issued through this proxy.
Definition: port_proxy.hh:95
gem5::Packet::dataStaticConst
void dataStaticConst(const T *p)
Set the data pointer to the following value that should not be freed.
Definition: packet.hh:1192
gem5::VegaISA::v
Bitfield< 0 > v
Definition: pagetable.hh:65
gem5::MemCmd::WriteReq
@ WriteReq
Definition: packet.hh:90
gem5::PortProxy::readBlobPhys
void readBlobPhys(Addr addr, Request::Flags flags, void *p, int size) const
Fixed functionality for use in base classes.
Definition: port_proxy.cc:58
chunk_generator.hh
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: gpu_translation_state.hh:37
thread_context.hh
gem5::X86ISA::addr
Bitfield< 3 > addr
Definition: types.hh:84

Generated on Sun Jul 30 2023 01:56:58 for gem5 by doxygen 1.8.17