summaryrefslogtreecommitdiff
path: root/src/mem/request.hh
blob: f60eb17facf7139f8ea43de4bd15a375060a3d4c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
/*
 * Copyright (c) 2002-2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Ron Dreslinski
 *          Steve Reinhardt
 *          Ali Saidi
 */

/**
 * @file
 * Declaration of a request, the overall memory request consisting of
 the parts of the request that are persistent throughout the transaction.
 */

#ifndef __MEM_REQUEST_HH__
#define __MEM_REQUEST_HH__

#include <cassert>

#include "base/fast_alloc.hh"
#include "base/flags.hh"
#include "base/misc.hh"
#include "sim/host.hh"
#include "sim/core.hh"

class Request;

typedef Request* RequestPtr;

class Request : public FastAlloc
{
    friend class Packet;

  public:
    typedef uint32_t FlagsType;
    typedef ::Flags<FlagsType> Flags;

    /** ASI information for this request if it exists. */
    static const FlagsType ASI_BITS                    = 0x000000FF;
    /** The request is a Load locked/store conditional. */
    static const FlagsType LOCKED                      = 0x00000100;
    /** The virtual address is also the physical address. */
    static const FlagsType PHYSICAL                    = 0x00000200;
    /** The request is an ALPHA VPTE pal access (hw_ld). */
    static const FlagsType VPTE                        = 0x00000400;
    /** Use the alternate mode bits in ALPHA. */
    static const FlagsType ALTMODE                     = 0x00000800;
    /** The request is to an uncacheable address. */
    static const FlagsType UNCACHEABLE                 = 0x00001000;
    /** The request should not cause a page fault. */
    static const FlagsType NO_FAULT                    = 0x00002000;
    /** The request should be prefetched into the exclusive state. */
    static const FlagsType PF_EXCLUSIVE                = 0x00010000;
    /** The request should be marked as LRU. */
    static const FlagsType EVICT_NEXT                  = 0x00020000;
    /** The request should ignore unaligned access faults */
    static const FlagsType NO_ALIGN_FAULT              = 0x00040000;
    /** The request was an instruction read. */
    static const FlagsType INST_READ                   = 0x00080000;
    /** This request is for a memory swap. */
    static const FlagsType MEM_SWAP                    = 0x00100000;
    static const FlagsType MEM_SWAP_COND               = 0x00200000;
    /** The request should ignore unaligned access faults */
    static const FlagsType NO_HALF_WORD_ALIGN_FAULT    = 0x00400000;
    /** This request is to a memory mapped register. */
    static const FlagsType MMAPED_IPR                  = 0x00800000;

  private:
    static const FlagsType PUBLIC_FLAGS                = 0x00FF3FFF;
    static const FlagsType PRIVATE_FLAGS               = 0xFF000000;

    /** Whether or not the size is valid. */
    static const FlagsType VALID_SIZE                  = 0x01000000;
    /** Whether or not paddr is valid (has been written yet). */
    static const FlagsType VALID_PADDR                 = 0x02000000;
    /** Whether or not the vaddr & asid are valid. */
    static const FlagsType VALID_VADDR                 = 0x04000000;
    /** Whether or not the pc is valid. */
    static const FlagsType VALID_PC                    = 0x10000000;
    /** Whether or not the context ID is valid. */
    static const FlagsType VALID_CONTEXT_ID            = 0x20000000;
    static const FlagsType VALID_THREAD_ID             = 0x40000000;
    /** Whether or not the sc result is valid. */
    static const FlagsType VALID_EXTRA_DATA            = 0x80000000;

  private:
    /**
     * The physical address of the request. Valid only if validPaddr
     * is set.
     */
    Addr paddr;

    /**
     * The size of the request. This field must be set when vaddr or
     * paddr is written via setVirt() or setPhys(), so it is always
     * valid as long as one of the address fields is valid.
     */
    int size;

    /** Flag structure for the request. */
    Flags flags;

    /**
     * The time this request was started. Used to calculate
     * latencies. This field is set to curTick any time paddr or vaddr
     * is written.
     */
    Tick time;

    /** The address space ID. */
    int asid;

    /** The virtual address of the request. */
    Addr vaddr;

    /**
     * Extra data for the request, such as the return value of
     * store conditional or the compare value for a CAS. */
    uint64_t extraData;

    /** The context ID (for statistics, typically). */
    int _contextId;
    /** The thread ID (id within this CPU) */
    int _threadId;

    /** program counter of initiating access; for tracing/debugging */
    Addr pc;

  public:
    /** Minimal constructor.  No fields are initialized. */
    Request()
    {}

    /**
     * Constructor for physical (e.g. device) requests.  Initializes
     * just physical address, size, flags, and timestamp (to curTick).
     * These fields are adequate to perform a request. 
     */
    Request(Addr paddr, int size, Flags flags)
    {
        setPhys(paddr, size, flags);
    }

    Request(int asid, Addr vaddr, int size, Flags flags, Addr pc,
            int cid, int tid)
    {
        setThreadContext(cid, tid);
        setVirt(asid, vaddr, size, flags, pc);
    }

    ~Request() {}  // for FastAlloc

    /**
     * Set up CPU and thread numbers.
     */
    void
    setThreadContext(int context_id, int thread_id)
    {
        _contextId = context_id;
        _threadId = thread_id;
        flags.set(VALID_CONTEXT_ID|VALID_THREAD_ID);
    }

    /**
     * Set up a physical (e.g. device) request in a previously
     * allocated Request object.
     */
    void
    setPhys(Addr _paddr, int _size, Flags _flags)
    {
        assert(_size >= 0);
        paddr = _paddr;
        size = _size;
        time = curTick;

        flags.set(VALID_PADDR|VALID_SIZE);
        flags.clear(VALID_VADDR|VALID_PC|VALID_EXTRA_DATA|MMAPED_IPR);
        flags.update(_flags, PUBLIC_FLAGS);
    }

    /**
     * Set up a virtual (e.g., CPU) request in a previously
     * allocated Request object.
     */
    void
    setVirt(int _asid, Addr _vaddr, int _size, Flags _flags, Addr _pc)
    {
        assert(_size >= 0);
        asid = _asid;
        vaddr = _vaddr;
        size = _size;
        pc = _pc;
        time = curTick;

        flags.set(VALID_VADDR|VALID_SIZE|VALID_PC);
        flags.clear(VALID_PADDR|VALID_EXTRA_DATA|MMAPED_IPR);
        flags.update(_flags, PUBLIC_FLAGS);
    }

    /**
     * Set just the physical address.  This should only be used to
     * record the result of a translation, and thus the vaddr must be
     * valid before this method is called.  Otherwise, use setPhys()
     * to guarantee that the size and flags are also set.
     */
    void
    setPaddr(Addr _paddr)
    {
        assert(flags.isSet(VALID_VADDR));
        paddr = _paddr;
        flags.set(VALID_PADDR);
    }

    /**
     * Generate two requests as if this request had been split into two
     * pieces. The original request can't have been translated already.
     */
    void splitOnVaddr(Addr split_addr, RequestPtr &req1, RequestPtr &req2)
    {
        assert(flags.isSet(VALID_VADDR));
        assert(flags.noneSet(VALID_PADDR));
        assert(split_addr > vaddr && split_addr < vaddr + size);
        req1 = new Request;
        *req1 = *this;
        req2 = new Request;
        *req2 = *this;
        req1->size = split_addr - vaddr;
        req2->vaddr = split_addr;
        req2->size = size - req1->size;
    }

    /**
     * Accessor for paddr.
     */
    Addr
    getPaddr()
    {
        assert(flags.isSet(VALID_PADDR));
        return paddr;
    }

    /**
     *  Accessor for size.
     */
    int
    getSize()
    {
        assert(flags.isSet(VALID_SIZE));
        return size;
    }

    /** Accessor for time. */
    Tick
    getTime()
    {
        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
        return time;
    }

    void
    setTime(Tick when)
    {
        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
        time = when;
    }

    /** Accessor for flags. */
    Flags
    getFlags()
    {
        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
        return flags & PUBLIC_FLAGS;
    }

    Flags
    anyFlags(Flags _flags)
    {
        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
        assert(_flags.noneSet(~PUBLIC_FLAGS));
        return flags.isSet(_flags);
    }

    Flags
    allFlags(Flags _flags)
    {
        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
        assert(_flags.noneSet(~PUBLIC_FLAGS));
        return flags.allSet(_flags);
    }

    /** Accessor for flags. */
    void
    setFlags(Flags _flags)
    {
        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
        assert(_flags.noneSet(~PUBLIC_FLAGS));
        flags.set(_flags);
    }

    void
    clearFlags(Flags _flags)
    {
        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
        assert(_flags.noneSet(~PUBLIC_FLAGS));
        flags.clear(_flags);
    }

    void
    clearFlags()
    {
        assert(flags.isSet(VALID_PADDR|VALID_VADDR));
        flags.clear(PUBLIC_FLAGS);
    }

    /** Accessor function for vaddr.*/
    Addr
    getVaddr()
    {
        assert(flags.isSet(VALID_VADDR));
        return vaddr;
    }

    /** Accessor function for asid.*/
    int
    getAsid()
    {
        assert(flags.isSet(VALID_VADDR));
        return asid;
    }

    /** Accessor function for asi.*/
    uint8_t
    getAsi()
    {
        assert(flags.isSet(VALID_VADDR));
        return flags & ASI_BITS;
    }

    /** Accessor function for asi.*/
    void
    setAsi(uint8_t a)
    {
        assert(flags.isSet(VALID_VADDR));
        flags.update(a, ASI_BITS);
    }

    /** Accessor function for asi.*/
    bool
    isMmapedIpr()
    {
        assert(flags.isSet(VALID_PADDR));
        return flags.isSet(MMAPED_IPR);
    }

    /** Accessor function for asi.*/
    void
    setMmapedIpr(bool r)
    {
        assert(VALID_VADDR);
        flags.set(MMAPED_IPR);
    }

    /** Accessor function to check if sc result is valid. */
    bool
    extraDataValid()
    {
        return flags.isSet(VALID_EXTRA_DATA);
    }

    /** Accessor function for store conditional return value.*/
    uint64_t
    getExtraData() const
    {
        assert(flags.isSet(VALID_EXTRA_DATA));
        return extraData;
    }

    /** Accessor function for store conditional return value.*/
    void
    setExtraData(uint64_t _extraData)
    {
        extraData = _extraData;
        flags.set(VALID_EXTRA_DATA);
    }

    /** Accessor function for context ID.*/
    int
    contextId() const
    {
        assert(flags.isSet(VALID_CONTEXT_ID));
        return _contextId;
    }

    /** Accessor function for thread ID. */
    int
    threadId() const
    {
        assert(flags.isSet(VALID_THREAD_ID));
        return _threadId;
    }

    /** Accessor function for pc.*/
    Addr
    getPC() const
    {
        assert(flags.isSet(VALID_PC));
        return pc;
    }

    /** Accessor Function to Check Cacheability. */
    bool isUncacheable() const { return flags.isSet(UNCACHEABLE); }
    bool isInstRead() const { return flags.isSet(INST_READ); }
    bool isLocked() const { return flags.isSet(LOCKED); }
    bool isSwap() const { return flags.isSet(MEM_SWAP|MEM_SWAP_COND); }
    bool isCondSwap() const { return flags.isSet(MEM_SWAP_COND); }

    bool
    isMisaligned() const
    {
        if (flags.isSet(NO_ALIGN_FAULT))
            return false;

        if ((vaddr & 0x1))
            return true;

        if (flags.isSet(NO_HALF_WORD_ALIGN_FAULT))
            return false;

        if ((vaddr & 0x2))
            return true;

        return false;
    }
};

#endif // __MEM_REQUEST_HH__