ruby: abstract controller: mark some variables as const
[gem5.git] / src / mem / se_translating_port_proxy.cc
1 /*
2 * Copyright (c) 2011 ARM Limited
3 * All rights reserved
4 *
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.
13 *
14 * Copyright (c) 2001-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
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.
27 *
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.
39 *
40 * Authors: Ron Dreslinski
41 * Steve Reinhardt
42 * Andreas Hansson
43 */
44
45 #include <string>
46
47 #include "arch/isa_traits.hh"
48 #include "base/chunk_generator.hh"
49 #include "config/the_isa.hh"
50 #include "mem/page_table.hh"
51 #include "mem/se_translating_port_proxy.hh"
52 #include "sim/process.hh"
53 #include "sim/system.hh"
54
55 using namespace TheISA;
56
57 SETranslatingPortProxy::SETranslatingPortProxy(MasterPort& port, Process *p,
58 AllocType alloc)
59 : PortProxy(port, p->system->cacheLineSize()), pTable(p->pTable),
60 process(p), allocating(alloc)
61 { }
62
63 SETranslatingPortProxy::~SETranslatingPortProxy()
64 { }
65
66 bool
67 SETranslatingPortProxy::tryReadBlob(Addr addr, uint8_t *p, int size) const
68 {
69 int prevSize = 0;
70
71 for (ChunkGenerator gen(addr, size, PageBytes); !gen.done(); gen.next()) {
72 Addr paddr;
73
74 if (!pTable->translate(gen.addr(),paddr))
75 return false;
76
77 PortProxy::readBlob(paddr, p + prevSize, gen.size());
78 prevSize += gen.size();
79 }
80
81 return true;
82 }
83
84 void
85 SETranslatingPortProxy::readBlob(Addr addr, uint8_t *p, int size) const
86 {
87 if (!tryReadBlob(addr, p, size))
88 fatal("readBlob(0x%x, ...) failed", addr);
89 }
90
91
92 bool
93 SETranslatingPortProxy::tryWriteBlob(Addr addr, const uint8_t *p,
94 int size) const
95 {
96 int prevSize = 0;
97
98 for (ChunkGenerator gen(addr, size, PageBytes); !gen.done(); gen.next()) {
99 Addr paddr;
100
101 if (!pTable->translate(gen.addr(), paddr)) {
102 if (allocating == Always) {
103 process->allocateMem(roundDown(gen.addr(), PageBytes),
104 PageBytes);
105 } else if (allocating == NextPage) {
106 // check if we've accessed the next page on the stack
107 if (!process->fixupStackFault(gen.addr()))
108 panic("Page table fault when accessing virtual address %#x "
109 "during functional write\n", gen.addr());
110 } else {
111 return false;
112 }
113 pTable->translate(gen.addr(), paddr);
114 }
115
116 PortProxy::writeBlob(paddr, p + prevSize, gen.size());
117 prevSize += gen.size();
118 }
119
120 return true;
121 }
122
123
124 void
125 SETranslatingPortProxy::writeBlob(Addr addr, const uint8_t *p, int size) const
126 {
127 if (!tryWriteBlob(addr, p, size))
128 fatal("writeBlob(0x%x, ...) failed", addr);
129 }
130
131 bool
132 SETranslatingPortProxy::tryMemsetBlob(Addr addr, uint8_t val, int size) const
133 {
134 for (ChunkGenerator gen(addr, size, PageBytes); !gen.done(); gen.next()) {
135 Addr paddr;
136
137 if (!pTable->translate(gen.addr(), paddr)) {
138 if (allocating == Always) {
139 process->allocateMem(roundDown(gen.addr(), PageBytes),
140 PageBytes);
141 pTable->translate(gen.addr(), paddr);
142 } else {
143 return false;
144 }
145 }
146
147 PortProxy::memsetBlob(paddr, val, gen.size());
148 }
149
150 return true;
151 }
152
153 void
154 SETranslatingPortProxy::memsetBlob(Addr addr, uint8_t val, int size) const
155 {
156 if (!tryMemsetBlob(addr, val, size))
157 fatal("memsetBlob(0x%x, ...) failed", addr);
158 }
159
160
161 bool
162 SETranslatingPortProxy::tryWriteString(Addr addr, const char *str) const
163 {
164 uint8_t c;
165
166 Addr vaddr = addr;
167
168 do {
169 c = *str++;
170 Addr paddr;
171
172 if (!pTable->translate(vaddr++, paddr))
173 return false;
174
175 PortProxy::writeBlob(paddr, &c, 1);
176 } while (c);
177
178 return true;
179 }
180
181 void
182 SETranslatingPortProxy::writeString(Addr addr, const char *str) const
183 {
184 if (!tryWriteString(addr, str))
185 fatal("writeString(0x%x, ...) failed", addr);
186 }
187
188 bool
189 SETranslatingPortProxy::tryReadString(std::string &str, Addr addr) const
190 {
191 uint8_t c;
192
193 Addr vaddr = addr;
194
195 while (true) {
196 Addr paddr;
197
198 if (!pTable->translate(vaddr++, paddr))
199 return false;
200
201 PortProxy::readBlob(paddr, &c, 1);
202 if (c == '\0')
203 break;
204
205 str += c;
206 }
207
208 return true;
209 }
210
211 void
212 SETranslatingPortProxy::readString(std::string &str, Addr addr) const
213 {
214 if (!tryReadString(str, addr))
215 fatal("readString(0x%x, ...) failed", addr);
216 }
217