request.hh revision 5875:d82be3235ab4 
1/*
2 * Copyright (c) 2002-2005 The Regents of The University of Michigan
3 * All rights reserved.
4 *
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.
15 *
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.
27 *
28 * Authors: Ron Dreslinski
29 *          Steve Reinhardt
30 *          Ali Saidi
31 */
32
33/**
34 * @file
35 * Declaration of a request, the overall memory request consisting of
36 the parts of the request that are persistent throughout the transaction.
37 */
38
39#ifndef __MEM_REQUEST_HH__
40#define __MEM_REQUEST_HH__
41
42#include <cassert>
43
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"
49
50class Request;
51
52typedef Request* RequestPtr;
53
54class Request : public FastAlloc
55{
56    friend class Packet;
57
58  public:
59    typedef uint32_t FlagsType;
60    typedef ::Flags<FlagsType> Flags;
61
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;
91
92  private:
93    static const FlagsType PUBLIC_FLAGS                = 0x00FF3FFF;
94    static const FlagsType PRIVATE_FLAGS               = 0xFF000000;
95
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;
109
110  private:
111    /**
112     * The physical address of the request. Valid only if validPaddr
113     * is set.
114     */
115    Addr paddr;
116
117    /**
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.
121     */
122    int size;
123
124    /** Flag structure for the request. */
125    Flags flags;
126
127    /**
128     * The time this request was started. Used to calculate
129     * latencies. This field is set to curTick any time paddr or vaddr
130     * is written.
131     */
132    Tick time;
133
134    /** The address space ID. */
135    int asid;
136
137    /** The virtual address of the request. */
138    Addr vaddr;
139
140    /**
141     * Extra data for the request, such as the return value of
142     * store conditional or the compare value for a CAS. */
143    uint64_t extraData;
144
145    /** The context ID (for statistics, typically). */
146    int _contextId;
147    /** The thread ID (id within this CPU) */
148    int _threadId;
149
150    /** program counter of initiating access; for tracing/debugging */
151    Addr pc;
152
153  public:
154    /** Minimal constructor.  No fields are initialized. */
155    Request()
156    {}
157
158    /**
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.
162     */
163    Request(Addr paddr, int size, Flags flags)
164    {
165        setPhys(paddr, size, flags);
166    }
167
168    Request(int asid, Addr vaddr, int size, Flags flags, Addr pc,
169            int cid, int tid)
170    {
171        setThreadContext(cid, tid);
172        setVirt(asid, vaddr, size, flags, pc);
173    }
174
175    ~Request() {}  // for FastAlloc
176
177    /**
178     * Set up CPU and thread numbers.
179     */
180    void
181    setThreadContext(int context_id, int thread_id)
182    {
183        _contextId = context_id;
184        _threadId = thread_id;
185        flags.set(VALID_CONTEXT_ID|VALID_THREAD_ID);
186    }
187
188    /**
189     * Set up a physical (e.g. device) request in a previously
190     * allocated Request object.
191     */
192    void
193    setPhys(Addr _paddr, int _size, Flags _flags)
194    {
195        assert(_size >= 0);
196        paddr = _paddr;
197        size = _size;
198        time = curTick;
199
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);
203    }
204
205    /**
206     * Set up a virtual (e.g., CPU) request in a previously
207     * allocated Request object.
208     */
209    void
210    setVirt(int _asid, Addr _vaddr, int _size, Flags _flags, Addr _pc)
211    {
212        assert(_size >= 0);
213        asid = _asid;
214        vaddr = _vaddr;
215        size = _size;
216        pc = _pc;
217        time = curTick;
218
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);
222    }
223
224    /**
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.
229     */
230    void
231    setPaddr(Addr _paddr)
232    {
233        assert(flags.isSet(VALID_VADDR));
234        paddr = _paddr;
235        flags.set(VALID_PADDR);
236    }
237
238    /**
239     * Generate two requests as if this request had been split into two
240     * pieces. The original request can't have been translated already.
241     */
242    void splitOnVaddr(Addr split_addr, RequestPtr &req1, RequestPtr &req2)
243    {
244        assert(flags.isSet(VALID_VADDR));
245        assert(flags.noneSet(VALID_PADDR));
246        assert(split_addr > vaddr && split_addr < vaddr + size);
247        req1 = new Request;
248        *req1 = *this;
249        req2 = new Request;
250        *req2 = *this;
251        req1->size = split_addr - vaddr;
252        req2->vaddr = split_addr;
253        req2->size = size - req1->size;
254    }
255
256    /**
257     * Accessor for paddr.
258     */
259    Addr
260    getPaddr()
261    {
262        assert(flags.isSet(VALID_PADDR));
263        return paddr;
264    }
265
266    /**
267     *  Accessor for size.
268     */
269    int
270    getSize()
271    {
272        assert(flags.isSet(VALID_SIZE));
273        return size;
274    }
275
276    /** Accessor for time. */
277    Tick
278    getTime()
279    {
280        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
281        return time;
282    }
283
284    void
285    setTime(Tick when)
286    {
287        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
288        time = when;
289    }
290
291    /** Accessor for flags. */
292    Flags
293    getFlags()
294    {
295        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
296        return flags & PUBLIC_FLAGS;
297    }
298
299    Flags
300    anyFlags(Flags _flags)
301    {
302        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
303        assert(_flags.noneSet(~PUBLIC_FLAGS));
304        return flags.isSet(_flags);
305    }
306
307    Flags
308    allFlags(Flags _flags)
309    {
310        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
311        assert(_flags.noneSet(~PUBLIC_FLAGS));
312        return flags.allSet(_flags);
313    }
314
315    /** Accessor for flags. */
316    void
317    setFlags(Flags _flags)
318    {
319        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
320        assert(_flags.noneSet(~PUBLIC_FLAGS));
321        flags.set(_flags);
322    }
323
324    void
325    clearFlags(Flags _flags)
326    {
327        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
328        assert(_flags.noneSet(~PUBLIC_FLAGS));
329        flags.clear(_flags);
330    }
331
332    void
333    clearFlags()
334    {
335        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
336        flags.clear(PUBLIC_FLAGS);
337    }
338
339    /** Accessor function for vaddr.*/
340    Addr
341    getVaddr()
342    {
343        assert(flags.isSet(VALID_VADDR));
344        return vaddr;
345    }
346
347    /** Accessor function for asid.*/
348    int
349    getAsid()
350    {
351        assert(flags.isSet(VALID_VADDR));
352        return asid;
353    }
354
355    /** Accessor function for asi.*/
356    uint8_t
357    getAsi()
358    {
359        assert(flags.isSet(VALID_VADDR));
360        return flags & ASI_BITS;
361    }
362
363    /** Accessor function for asi.*/
364    void
365    setAsi(uint8_t a)
366    {
367        assert(flags.isSet(VALID_VADDR));
368        flags.update(a, ASI_BITS);
369    }
370
371    /** Accessor function for asi.*/
372    bool
373    isMmapedIpr()
374    {
375        assert(flags.isSet(VALID_PADDR));
376        return flags.isSet(MMAPED_IPR);
377    }
378
379    /** Accessor function for asi.*/
380    void
381    setMmapedIpr(bool r)
382    {
383        assert(VALID_VADDR);
384        flags.set(MMAPED_IPR);
385    }
386
387    /** Accessor function to check if sc result is valid. */
388    bool
389    extraDataValid()
390    {
391        return flags.isSet(VALID_EXTRA_DATA);
392    }
393
394    /** Accessor function for store conditional return value.*/
395    uint64_t
396    getExtraData() const
397    {
398        assert(flags.isSet(VALID_EXTRA_DATA));
399        return extraData;
400    }
401
402    /** Accessor function for store conditional return value.*/
403    void
404    setExtraData(uint64_t _extraData)
405    {
406        extraData = _extraData;
407        flags.set(VALID_EXTRA_DATA);
408    }
409
410    /** Accessor function for context ID.*/
411    int
412    contextId() const
413    {
414        assert(flags.isSet(VALID_CONTEXT_ID));
415        return _contextId;
416    }
417
418    /** Accessor function for thread ID. */
419    int
420    threadId() const
421    {
422        assert(flags.isSet(VALID_THREAD_ID));
423        return _threadId;
424    }
425
426    /** Accessor function for pc.*/
427    bool
428    hasPC() const
429    {
430        return flags.isSet(VALID_PC);
431    }
432
433    Addr
434    getPC() const
435    {
436        assert(flags.isSet(VALID_PC));
437        return pc;
438    }
439
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); }
446
447    bool
448    isMisaligned() const
449    {
450        if (flags.isSet(NO_ALIGN_FAULT))
451            return false;
452
453        if ((vaddr & 0x1))
454            return true;
455
456        if (flags.isSet(NO_HALF_WORD_ALIGN_FAULT))
457            return false;
458
459        if ((vaddr & 0x2))
460            return true;
461
462        return false;
463    }
464};
465
466#endif // __MEM_REQUEST_HH__
467