2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Authors: Ron Dreslinski
35 * Declaration of a request, the overall memory request consisting of
36 the parts of the request that are persistent throughout the transaction.
39 #ifndef __MEM_REQUEST_HH__
40 #define __MEM_REQUEST_HH__
44 #include "base/fast_alloc.hh"
45 #include "base/flags.hh"
46 #include "base/misc.hh"
47 #include "sim/host.hh"
48 #include "sim/core.hh"
52 typedef Request* RequestPtr;
54 class Request : public FastAlloc
59 typedef uint32_t FlagsType;
60 typedef ::Flags<FlagsType> Flags;
62 /** ASI information for this request if it exists. */
63 static const FlagsType ASI_BITS = 0x000000FF;
64 /** The request is a Load locked/store conditional. */
65 static const FlagsType LOCKED = 0x00000100;
66 /** The virtual address is also the physical address. */
67 static const FlagsType PHYSICAL = 0x00000200;
68 /** The request is an ALPHA VPTE pal access (hw_ld). */
69 static const FlagsType VPTE = 0x00000400;
70 /** Use the alternate mode bits in ALPHA. */
71 static const FlagsType ALTMODE = 0x00000800;
72 /** The request is to an uncacheable address. */
73 static const FlagsType UNCACHEABLE = 0x00001000;
74 /** The request should not cause a page fault. */
75 static const FlagsType NO_FAULT = 0x00002000;
76 /** The request should be prefetched into the exclusive state. */
77 static const FlagsType PF_EXCLUSIVE = 0x00010000;
78 /** The request should be marked as LRU. */
79 static const FlagsType EVICT_NEXT = 0x00020000;
80 /** The request should ignore unaligned access faults */
81 static const FlagsType NO_ALIGN_FAULT = 0x00040000;
82 /** The request was an instruction read. */
83 static const FlagsType INST_READ = 0x00080000;
84 /** This request is for a memory swap. */
85 static const FlagsType MEM_SWAP = 0x00100000;
86 static const FlagsType MEM_SWAP_COND = 0x00200000;
87 /** The request should ignore unaligned access faults */
88 static const FlagsType NO_HALF_WORD_ALIGN_FAULT = 0x00400000;
89 /** This request is to a memory mapped register. */
90 static const FlagsType MMAPED_IPR = 0x00800000;
93 static const FlagsType PUBLIC_FLAGS = 0x00FF3FFF;
94 static const FlagsType PRIVATE_FLAGS = 0xFF000000;
96 /** Whether or not the size is valid. */
97 static const FlagsType VALID_SIZE = 0x01000000;
98 /** Whether or not paddr is valid (has been written yet). */
99 static const FlagsType VALID_PADDR = 0x02000000;
100 /** Whether or not the vaddr & asid are valid. */
101 static const FlagsType VALID_VADDR = 0x04000000;
102 /** Whether or not the pc is valid. */
103 static const FlagsType VALID_PC = 0x10000000;
104 /** Whether or not the context ID is valid. */
105 static const FlagsType VALID_CONTEXT_ID = 0x20000000;
106 static const FlagsType VALID_THREAD_ID = 0x40000000;
107 /** Whether or not the sc result is valid. */
108 static const FlagsType VALID_EXTRA_DATA = 0x80000000;
112 * The physical address of the request. Valid only if validPaddr
118 * The size of the request. This field must be set when vaddr or
119 * paddr is written via setVirt() or setPhys(), so it is always
120 * valid as long as one of the address fields is valid.
124 /** Flag structure for the request. */
128 * The time this request was started. Used to calculate
129 * latencies. This field is set to curTick any time paddr or vaddr
134 /** The address space ID. */
137 /** The virtual address of the request. */
141 * Extra data for the request, such as the return value of
142 * store conditional or the compare value for a CAS. */
145 /** The context ID (for statistics, typically). */
147 /** The thread ID (id within this CPU) */
150 /** program counter of initiating access; for tracing/debugging */
154 /** Minimal constructor. No fields are initialized. */
159 * Constructor for physical (e.g. device) requests. Initializes
160 * just physical address, size, flags, and timestamp (to curTick).
161 * These fields are adequate to perform a request.
163 Request(Addr paddr, int size, Flags flags)
165 setPhys(paddr, size, flags);
168 Request(int asid, Addr vaddr, int size, Flags flags, Addr pc,
171 setThreadContext(cid, tid);
172 setVirt(asid, vaddr, size, flags, pc);
175 ~Request() {} // for FastAlloc
178 * Set up CPU and thread numbers.
181 setThreadContext(int context_id, int thread_id)
183 _contextId = context_id;
184 _threadId = thread_id;
185 flags.set(VALID_CONTEXT_ID|VALID_THREAD_ID);
189 * Set up a physical (e.g. device) request in a previously
190 * allocated Request object.
193 setPhys(Addr _paddr, int _size, Flags _flags)
200 flags.set(VALID_PADDR|VALID_SIZE);
201 flags.clear(VALID_VADDR|VALID_PC|VALID_EXTRA_DATA|MMAPED_IPR);
202 flags.update(_flags, PUBLIC_FLAGS);
206 * Set up a virtual (e.g., CPU) request in a previously
207 * allocated Request object.
210 setVirt(int _asid, Addr _vaddr, int _size, Flags _flags, Addr _pc)
219 flags.set(VALID_VADDR|VALID_SIZE|VALID_PC);
220 flags.clear(VALID_PADDR|VALID_EXTRA_DATA|MMAPED_IPR);
221 flags.update(_flags, PUBLIC_FLAGS);
225 * Set just the physical address. This should only be used to
226 * record the result of a translation, and thus the vaddr must be
227 * valid before this method is called. Otherwise, use setPhys()
228 * to guarantee that the size and flags are also set.
231 setPaddr(Addr _paddr)
233 assert(flags.isSet(VALID_VADDR));
235 flags.set(VALID_PADDR);
239 * Generate two requests as if this request had been split into two
240 * pieces. The original request can't have been translated already.
242 void splitOnVaddr(Addr split_addr, RequestPtr &req1, RequestPtr &req2)
244 assert(flags.isSet(VALID_VADDR));
245 assert(flags.noneSet(VALID_PADDR));
246 assert(split_addr > vaddr && split_addr < vaddr + size);
251 req1->size = split_addr - vaddr;
252 req2->vaddr = split_addr;
253 req2->size = size - req1->size;
257 * Accessor for paddr.
262 assert(flags.isSet(VALID_PADDR));
272 assert(flags.isSet(VALID_SIZE));
276 /** Accessor for time. */
280 assert(flags.isSet(VALID_PADDR|VALID_VADDR));
287 assert(flags.isSet(VALID_PADDR|VALID_VADDR));
291 /** Accessor for flags. */
295 assert(flags.isSet(VALID_PADDR|VALID_VADDR));
296 return flags & PUBLIC_FLAGS;
300 anyFlags(Flags _flags)
302 assert(flags.isSet(VALID_PADDR|VALID_VADDR));
303 assert(_flags.noneSet(~PUBLIC_FLAGS));
304 return flags.isSet(_flags);
308 allFlags(Flags _flags)
310 assert(flags.isSet(VALID_PADDR|VALID_VADDR));
311 assert(_flags.noneSet(~PUBLIC_FLAGS));
312 return flags.allSet(_flags);
315 /** Accessor for flags. */
317 setFlags(Flags _flags)
319 assert(flags.isSet(VALID_PADDR|VALID_VADDR));
320 assert(_flags.noneSet(~PUBLIC_FLAGS));
325 clearFlags(Flags _flags)
327 assert(flags.isSet(VALID_PADDR|VALID_VADDR));
328 assert(_flags.noneSet(~PUBLIC_FLAGS));
335 assert(flags.isSet(VALID_PADDR|VALID_VADDR));
336 flags.clear(PUBLIC_FLAGS);
339 /** Accessor function for vaddr.*/
343 assert(flags.isSet(VALID_VADDR));
347 /** Accessor function for asid.*/
351 assert(flags.isSet(VALID_VADDR));
355 /** Accessor function for asi.*/
359 assert(flags.isSet(VALID_VADDR));
360 return flags & ASI_BITS;
363 /** Accessor function for asi.*/
367 assert(flags.isSet(VALID_VADDR));
368 flags.update(a, ASI_BITS);
371 /** Accessor function for asi.*/
375 assert(flags.isSet(VALID_PADDR));
376 return flags.isSet(MMAPED_IPR);
379 /** Accessor function for asi.*/
384 flags.set(MMAPED_IPR);
387 /** Accessor function to check if sc result is valid. */
391 return flags.isSet(VALID_EXTRA_DATA);
394 /** Accessor function for store conditional return value.*/
398 assert(flags.isSet(VALID_EXTRA_DATA));
402 /** Accessor function for store conditional return value.*/
404 setExtraData(uint64_t _extraData)
406 extraData = _extraData;
407 flags.set(VALID_EXTRA_DATA);
410 /** Accessor function for context ID.*/
414 assert(flags.isSet(VALID_CONTEXT_ID));
418 /** Accessor function for thread ID. */
422 assert(flags.isSet(VALID_THREAD_ID));
426 /** Accessor function for pc.*/
430 return flags.isSet(VALID_PC);
436 assert(flags.isSet(VALID_PC));
440 /** Accessor Function to Check Cacheability. */
441 bool isUncacheable() const { return flags.isSet(UNCACHEABLE); }
442 bool isInstRead() const { return flags.isSet(INST_READ); }
443 bool isLocked() const { return flags.isSet(LOCKED); }
444 bool isSwap() const { return flags.isSet(MEM_SWAP|MEM_SWAP_COND); }
445 bool isCondSwap() const { return flags.isSet(MEM_SWAP_COND); }
450 if (flags.isSet(NO_ALIGN_FAULT))
456 if (flags.isSet(NO_HALF_WORD_ALIGN_FAULT))
466 #endif // __MEM_REQUEST_HH__