RubyRequest.hh revision 8092 
1/*
2 * Copyright (c) 2009 Mark D. Hill and David A. Wood
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
29#ifndef __MEM_RUBY_SLICC_INTERFACE_RUBY_REQUEST_HH__
30#define __MEM_RUBY_SLICC_INTERFACE_RUBY_REQUEST_HH__
31
32#include <ostream>
33
34#include "mem/packet.hh"
35#include "mem/protocol/AccessModeType.hh"
36#include "mem/protocol/CacheRequestType.hh"
37#include "mem/protocol/Message.hh"
38#include "mem/protocol/PrefetchBit.hh"
39#include "mem/ruby/common/Address.hh"
40
41typedef void* RubyPortHandle;
42enum RubyRequestType {
43  RubyRequestType_NULL,
44  RubyRequestType_IFETCH,
45  RubyRequestType_LD,
46  RubyRequestType_ST,
47  RubyRequestType_Load_Linked,
48  RubyRequestType_Store_Conditional,
49  RubyRequestType_RMW_Read,
50  RubyRequestType_RMW_Write,
51  RubyRequestType_Locked_RMW_Read,
52  RubyRequestType_Locked_RMW_Write,
53  RubyRequestType_NUM
54};
55
56enum RubyAccessMode {
57  RubyAccessMode_User,
58  RubyAccessMode_Supervisor,
59  RubyAccessMode_Device
60};
61
62class RubyRequest
63{
64  public:
65    uint64_t paddr;
66    uint8_t* data;
67    int len;
68    uint64_t pc;
69    RubyRequestType type;
70    RubyAccessMode access_mode;
71    PacketPtr pkt;
72    unsigned proc_id;
73
74    RubyRequest() {}
75    RubyRequest(uint64_t _paddr,
76                uint8_t* _data,
77                int _len,
78                uint64_t _pc,
79                RubyRequestType _type,
80                RubyAccessMode _access_mode,
81                PacketPtr _pkt,
82                unsigned _proc_id = 100)
83        : paddr(_paddr),
84          data(_data),
85          len(_len),
86          pc(_pc),
87          type(_type),
88          access_mode(_access_mode),
89          pkt(_pkt),
90          proc_id(_proc_id)
91    {}
92
93    void print(std::ostream& out) const;
94};
95
96std::string RubyRequestType_to_string(const RubyRequestType& obj);
97RubyRequestType string_to_RubyRequestType(std::string);
98std::ostream& operator<<(std::ostream& out, const RubyRequestType& obj);
99std::ostream& operator<<(std::ostream& out, const RubyRequest& obj);
100
101#endif
102