2 * Copyright (c) 2010-2012,2017-2019 ARM Limited
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.
14 * Copyright (c) 2001-2005 The Regents of The University of Michigan
15 * All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 #include "mem/abstract_mem.hh"
45 #include "arch/locked_mem.hh"
46 #include "base/loader/memory_image.hh"
47 #include "base/loader/object_file.hh"
48 #include "cpu/thread_context.hh"
49 #include "debug/LLSC.hh"
50 #include "debug/MemoryAccess.hh"
51 #include "mem/packet_access.hh"
52 #include "sim/system.hh"
56 AbstractMemory::AbstractMemory(const Params
&p
) :
57 ClockedObject(p
), range(p
.range
), pmemAddr(NULL
),
58 backdoor(params().range
, nullptr,
59 (MemBackdoor::Flags
)(MemBackdoor::Readable
|
60 MemBackdoor::Writeable
)),
61 confTableReported(p
.conf_table_reported
), inAddrMap(p
.in_addr_map
),
62 kvmMap(p
.kvm_map
), _system(NULL
),
65 panic_if(!range
.valid() || !range
.size(),
66 "Memory range %s must be valid with non-zero size.",
71 AbstractMemory::initState()
73 ClockedObject::initState();
75 const auto &file
= params().image_file
;
79 auto *object
= Loader::createObjectFile(file
, true);
80 fatal_if(!object
, "%s: Could not load %s.", name(), file
);
82 Loader::debugSymbolTable
.insert(*object
->symtab().globals());
83 Loader::MemoryImage image
= object
->buildImage();
85 AddrRange
image_range(image
.minAddr(), image
.maxAddr());
86 if (!range
.contains(image_range
.start())) {
87 warn("%s: Moving image from %s to memory address range %s.",
88 name(), image_range
.to_string(), range
.to_string());
89 image
= image
.offset(range
.start());
90 image_range
= AddrRange(image
.minAddr(), image
.maxAddr());
92 panic_if(!image_range
.isSubset(range
), "%s: memory image %s doesn't fit.",
95 PortProxy
proxy([this](PacketPtr pkt
) { functionalAccess(pkt
); },
96 system()->cacheLineSize());
98 panic_if(!image
.write(proxy
), "%s: Unable to write image.");
102 AbstractMemory::setBackingStore(uint8_t* pmem_addr
)
104 // If there was an existing backdoor, let everybody know it's going away.
106 backdoor
.invalidate();
108 // The back door can't handle interleaved memory.
109 backdoor
.ptr(range
.interleaved() ? nullptr : pmem_addr
);
111 pmemAddr
= pmem_addr
;
114 AbstractMemory::MemStats::MemStats(AbstractMemory
&_mem
)
115 : Stats::Group(&_mem
), mem(_mem
),
116 bytesRead(this, "bytes_read",
117 "Number of bytes read from this memory"),
118 bytesInstRead(this, "bytes_inst_read",
119 "Number of instructions bytes read from this memory"),
120 bytesWritten(this, "bytes_written",
121 "Number of bytes written to this memory"),
122 numReads(this, "num_reads",
123 "Number of read requests responded to by this memory"),
124 numWrites(this, "num_writes",
125 "Number of write requests responded to by this memory"),
126 numOther(this, "num_other",
127 "Number of other requests responded to by this memory"),
128 bwRead(this, "bw_read",
129 "Total read bandwidth from this memory (bytes/s)"),
130 bwInstRead(this, "bw_inst_read",
131 "Instruction read bandwidth from this memory (bytes/s)"),
132 bwWrite(this, "bw_write",
133 "Write bandwidth from this memory (bytes/s)"),
134 bwTotal(this, "bw_total",
135 "Total bandwidth to/from this memory (bytes/s)")
140 AbstractMemory::MemStats::regStats()
142 using namespace Stats
;
144 Stats::Group::regStats();
146 System
*sys
= mem
.system();
148 const auto max_requestors
= sys
->maxRequestors();
151 .init(max_requestors
)
152 .flags(total
| nozero
| nonan
)
154 for (int i
= 0; i
< max_requestors
; i
++) {
155 bytesRead
.subname(i
, sys
->getRequestorName(i
));
159 .init(max_requestors
)
160 .flags(total
| nozero
| nonan
)
162 for (int i
= 0; i
< max_requestors
; i
++) {
163 bytesInstRead
.subname(i
, sys
->getRequestorName(i
));
167 .init(max_requestors
)
168 .flags(total
| nozero
| nonan
)
170 for (int i
= 0; i
< max_requestors
; i
++) {
171 bytesWritten
.subname(i
, sys
->getRequestorName(i
));
175 .init(max_requestors
)
176 .flags(total
| nozero
| nonan
)
178 for (int i
= 0; i
< max_requestors
; i
++) {
179 numReads
.subname(i
, sys
->getRequestorName(i
));
183 .init(max_requestors
)
184 .flags(total
| nozero
| nonan
)
186 for (int i
= 0; i
< max_requestors
; i
++) {
187 numWrites
.subname(i
, sys
->getRequestorName(i
));
191 .init(max_requestors
)
192 .flags(total
| nozero
| nonan
)
194 for (int i
= 0; i
< max_requestors
; i
++) {
195 numOther
.subname(i
, sys
->getRequestorName(i
));
201 .flags(total
| nozero
| nonan
)
203 for (int i
= 0; i
< max_requestors
; i
++) {
204 bwRead
.subname(i
, sys
->getRequestorName(i
));
209 .prereq(bytesInstRead
)
210 .flags(total
| nozero
| nonan
)
212 for (int i
= 0; i
< max_requestors
; i
++) {
213 bwInstRead
.subname(i
, sys
->getRequestorName(i
));
218 .prereq(bytesWritten
)
219 .flags(total
| nozero
| nonan
)
221 for (int i
= 0; i
< max_requestors
; i
++) {
222 bwWrite
.subname(i
, sys
->getRequestorName(i
));
228 .flags(total
| nozero
| nonan
)
230 for (int i
= 0; i
< max_requestors
; i
++) {
231 bwTotal
.subname(i
, sys
->getRequestorName(i
));
234 bwRead
= bytesRead
/ simSeconds
;
235 bwInstRead
= bytesInstRead
/ simSeconds
;
236 bwWrite
= bytesWritten
/ simSeconds
;
237 bwTotal
= (bytesRead
+ bytesWritten
) / simSeconds
;
241 AbstractMemory::getAddrRange() const
246 // Add load-locked to tracking list. Should only be called if the
247 // operation is a load and the LLSC flag is set.
249 AbstractMemory::trackLoadLocked(PacketPtr pkt
)
251 const RequestPtr
&req
= pkt
->req
;
252 Addr paddr
= LockedAddr::mask(req
->getPaddr());
254 // first we check if we already have a locked addr for this
255 // xc. Since each xc only gets one, we just update the
256 // existing record with the new address.
257 list
<LockedAddr
>::iterator i
;
259 for (i
= lockedAddrList
.begin(); i
!= lockedAddrList
.end(); ++i
) {
260 if (i
->matchesContext(req
)) {
261 DPRINTF(LLSC
, "Modifying lock record: context %d addr %#x\n",
262 req
->contextId(), paddr
);
268 // no record for this xc: need to allocate a new one
269 DPRINTF(LLSC
, "Adding lock record: context %d addr %#x\n",
270 req
->contextId(), paddr
);
271 lockedAddrList
.push_front(LockedAddr(req
));
275 // Called on *writes* only... both regular stores and
276 // store-conditional operations. Check for conventional stores which
277 // conflict with locked addresses, and for success/failure of store
280 AbstractMemory::checkLockedAddrList(PacketPtr pkt
)
282 const RequestPtr
&req
= pkt
->req
;
283 Addr paddr
= LockedAddr::mask(req
->getPaddr());
284 bool isLLSC
= pkt
->isLLSC();
286 // Initialize return value. Non-conditional stores always
287 // succeed. Assume conditional stores will fail until proven
289 bool allowStore
= !isLLSC
;
291 // Iterate over list. Note that there could be multiple matching records,
292 // as more than one context could have done a load locked to this location.
293 // Only remove records when we succeed in finding a record for (xc, addr);
294 // then, remove all records with this address. Failed store-conditionals do
295 // not blow unrelated reservations.
296 list
<LockedAddr
>::iterator i
= lockedAddrList
.begin();
299 while (i
!= lockedAddrList
.end()) {
300 if (i
->addr
== paddr
&& i
->matchesContext(req
)) {
301 // it's a store conditional, and as far as the memory system can
302 // tell, the requesting context's lock is still valid.
303 DPRINTF(LLSC
, "StCond success: context %d addr %#x\n",
304 req
->contextId(), paddr
);
308 // If we didn't find a match, keep searching! Someone else may well
309 // have a reservation on this line here but we may find ours in just
313 req
->setExtraData(allowStore
? 1 : 0);
315 // LLSCs that succeeded AND non-LLSC stores both fall into here:
317 // We write address paddr. However, there may be several entries with a
318 // reservation on this address (for other contextIds) and they must all
320 i
= lockedAddrList
.begin();
321 while (i
!= lockedAddrList
.end()) {
322 if (i
->addr
== paddr
) {
323 DPRINTF(LLSC
, "Erasing lock record: context %d addr %#x\n",
324 i
->contextId
, paddr
);
325 ContextID owner_cid
= i
->contextId
;
326 assert(owner_cid
!= InvalidContextID
);
327 ContextID requestor_cid
= req
->hasContextId() ?
330 if (owner_cid
!= requestor_cid
) {
331 ThreadContext
* ctx
= system()->threads
[owner_cid
];
332 TheISA::globalClearExclusive(ctx
);
334 i
= lockedAddrList
.erase(i
);
346 tracePacket(System
*sys
, const char *label
, PacketPtr pkt
)
348 int size
= pkt
->getSize();
349 if (size
== 1 || size
== 2 || size
== 4 || size
== 8) {
350 ByteOrder byte_order
= sys
->getGuestByteOrder();
351 DPRINTF(MemoryAccess
, "%s from %s of size %i on address %#x data "
352 "%#x %c\n", label
, sys
->getRequestorName(pkt
->req
->
353 requestorId()), size
, pkt
->getAddr(),
354 size
, pkt
->getAddr(), pkt
->getUintX(byte_order
),
355 pkt
->req
->isUncacheable() ? 'U' : 'C');
358 DPRINTF(MemoryAccess
, "%s from %s of size %i on address %#x %c\n",
359 label
, sys
->getRequestorName(pkt
->req
->requestorId()),
360 size
, pkt
->getAddr(), pkt
->req
->isUncacheable() ? 'U' : 'C');
361 DDUMP(MemoryAccess
, pkt
->getConstPtr
<uint8_t>(), pkt
->getSize());
364 # define TRACE_PACKET(A) tracePacket(system(), A, pkt)
366 # define TRACE_PACKET(A)
370 AbstractMemory::access(PacketPtr pkt
)
372 if (pkt
->cacheResponding()) {
373 DPRINTF(MemoryAccess
, "Cache responding to %#llx: not responding\n",
378 if (pkt
->cmd
== MemCmd::CleanEvict
|| pkt
->cmd
== MemCmd::WritebackClean
) {
379 DPRINTF(MemoryAccess
, "CleanEvict on 0x%x: not responding\n",
384 assert(pkt
->getAddrRange().isSubset(range
));
386 uint8_t *host_addr
= toHostAddr(pkt
->getAddr());
388 if (pkt
->cmd
== MemCmd::SwapReq
) {
389 if (pkt
->isAtomicOp()) {
391 pkt
->setData(host_addr
);
392 (*(pkt
->getAtomicOp()))(host_addr
);
395 std::vector
<uint8_t> overwrite_val(pkt
->getSize());
396 uint64_t condition_val64
;
397 uint32_t condition_val32
;
399 panic_if(!pmemAddr
, "Swap only works if there is real memory " \
400 "(i.e. null=False)");
402 bool overwrite_mem
= true;
403 // keep a copy of our possible write value, and copy what is at the
404 // memory address into the packet
405 pkt
->writeData(&overwrite_val
[0]);
406 pkt
->setData(host_addr
);
408 if (pkt
->req
->isCondSwap()) {
409 if (pkt
->getSize() == sizeof(uint64_t)) {
410 condition_val64
= pkt
->req
->getExtraData();
411 overwrite_mem
= !std::memcmp(&condition_val64
, host_addr
,
413 } else if (pkt
->getSize() == sizeof(uint32_t)) {
414 condition_val32
= (uint32_t)pkt
->req
->getExtraData();
415 overwrite_mem
= !std::memcmp(&condition_val32
, host_addr
,
418 panic("Invalid size for conditional read/write\n");
422 std::memcpy(host_addr
, &overwrite_val
[0], pkt
->getSize());
424 assert(!pkt
->req
->isInstFetch());
425 TRACE_PACKET("Read/Write");
426 stats
.numOther
[pkt
->req
->requestorId()]++;
428 } else if (pkt
->isRead()) {
429 assert(!pkt
->isWrite());
431 assert(!pkt
->fromCache());
432 // if the packet is not coming from a cache then we have
433 // to do the LL/SC tracking here
434 trackLoadLocked(pkt
);
437 pkt
->setData(host_addr
);
439 TRACE_PACKET(pkt
->req
->isInstFetch() ? "IFetch" : "Read");
440 stats
.numReads
[pkt
->req
->requestorId()]++;
441 stats
.bytesRead
[pkt
->req
->requestorId()] += pkt
->getSize();
442 if (pkt
->req
->isInstFetch())
443 stats
.bytesInstRead
[pkt
->req
->requestorId()] += pkt
->getSize();
444 } else if (pkt
->isInvalidate() || pkt
->isClean()) {
445 assert(!pkt
->isWrite());
446 // in a fastmem system invalidating and/or cleaning packets
447 // can be seen due to cache maintenance requests
449 // no need to do anything
450 } else if (pkt
->isWrite()) {
453 pkt
->writeData(host_addr
);
454 DPRINTF(MemoryAccess
, "%s write due to %s\n",
455 __func__
, pkt
->print());
457 assert(!pkt
->req
->isInstFetch());
458 TRACE_PACKET("Write");
459 stats
.numWrites
[pkt
->req
->requestorId()]++;
460 stats
.bytesWritten
[pkt
->req
->requestorId()] += pkt
->getSize();
463 panic("Unexpected packet %s", pkt
->print());
466 if (pkt
->needsResponse()) {
472 AbstractMemory::functionalAccess(PacketPtr pkt
)
474 assert(pkt
->getAddrRange().isSubset(range
));
476 uint8_t *host_addr
= toHostAddr(pkt
->getAddr());
480 pkt
->setData(host_addr
);
482 TRACE_PACKET("Read");
484 } else if (pkt
->isWrite()) {
486 pkt
->writeData(host_addr
);
488 TRACE_PACKET("Write");
490 } else if (pkt
->isPrint()) {
491 Packet::PrintReqState
*prs
=
492 dynamic_cast<Packet::PrintReqState
*>(pkt
->senderState
);
494 // Need to call printLabels() explicitly since we're not going
495 // through printObj().
497 // Right now we just print the single byte at the specified address.
498 ccprintf(prs
->os
, "%s%#x\n", prs
->curPrefix(), *host_addr
);
500 panic("AbstractMemory: unimplemented functional command %s",