physical.cc revision 3012:1d5e18f6a100 
1/*
2 * Copyright (c) 2001-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 *          Ali Saidi
30 */
31
32#include <sys/types.h>
33#include <sys/mman.h>
34#include <errno.h>
35#include <fcntl.h>
36#include <unistd.h>
37#include <zlib.h>
38
39#include <iostream>
40#include <string>
41
42
43#include "base/misc.hh"
44#include "config/full_system.hh"
45#include "mem/packet_impl.hh"
46#include "mem/physical.hh"
47#include "sim/host.hh"
48#include "sim/builder.hh"
49#include "sim/eventq.hh"
50#include "arch/isa_traits.hh"
51
52
53using namespace std;
54using namespace TheISA;
55
56
57PhysicalMemory::PhysicalMemory(Params *p)
58    : MemObject(p->name), pmemAddr(NULL), port(NULL), lat(p->latency), _params(p)
59{
60    if (params()->addrRange.size() % TheISA::PageBytes != 0)
61        panic("Memory Size not divisible by page size\n");
62
63    int map_flags = MAP_ANON | MAP_PRIVATE;
64    pmemAddr = (uint8_t *)mmap(NULL, params()->addrRange.size(), PROT_READ | PROT_WRITE,
65                                map_flags, -1, 0);
66
67    if (pmemAddr == (void *)MAP_FAILED) {
68        perror("mmap");
69        fatal("Could not mmap!\n");
70    }
71
72    pagePtr = 0;
73}
74
75void
76PhysicalMemory::init()
77{
78    if (!port)
79        panic("PhysicalMemory not connected to anything!");
80    port->sendStatusChange(Port::RangeChange);
81}
82
83PhysicalMemory::~PhysicalMemory()
84{
85    if (pmemAddr)
86        munmap(pmemAddr, params()->addrRange.size());
87    //Remove memPorts?
88}
89
90Addr
91PhysicalMemory::new_page()
92{
93    Addr return_addr = pagePtr << LogVMPageSize;
94    return_addr += params()->addrRange.start;
95
96    ++pagePtr;
97    return return_addr;
98}
99
100int
101PhysicalMemory::deviceBlockSize()
102{
103    //Can accept anysize request
104    return 0;
105}
106
107Tick
108PhysicalMemory::calculateLatency(Packet *pkt)
109{
110    return lat;
111}
112
113Tick
114PhysicalMemory::doFunctionalAccess(Packet *pkt)
115{
116    assert(pkt->getAddr() + pkt->getSize() < params()->addrRange.size());
117
118    switch (pkt->cmd) {
119      case Packet::ReadReq:
120        memcpy(pkt->getPtr<uint8_t>(),
121               pmemAddr + pkt->getAddr() - params()->addrRange.start,
122               pkt->getSize());
123        break;
124      case Packet::WriteReq:
125        memcpy(pmemAddr + pkt->getAddr() - params()->addrRange.start,
126               pkt->getPtr<uint8_t>(),
127               pkt->getSize());
128        // temporary hack: will need to add real LL/SC implementation
129        // for cacheless systems later.
130        if (pkt->req->getFlags() & LOCKED) {
131            pkt->req->setScResult(1);
132        }
133        break;
134      default:
135        panic("unimplemented");
136    }
137
138    pkt->result = Packet::Success;
139    return calculateLatency(pkt);
140}
141
142Port *
143PhysicalMemory::getPort(const std::string &if_name, int idx)
144{
145    if (if_name == "port" && idx == -1) {
146        if (port != NULL)
147           panic("PhysicalMemory::getPort: additional port requested to memory!");
148        port = new MemoryPort(name() + "-port", this);
149        return port;
150    } else if (if_name == "functional") {
151        /* special port for functional writes at startup. */
152        return new MemoryPort(name() + "-funcport", this);
153    } else {
154        panic("PhysicalMemory::getPort: unknown port %s requested", if_name);
155    }
156}
157
158void
159PhysicalMemory::recvStatusChange(Port::Status status)
160{
161}
162
163PhysicalMemory::MemoryPort::MemoryPort(const std::string &_name,
164                                       PhysicalMemory *_memory)
165    : SimpleTimingPort(_name), memory(_memory)
166{ }
167
168void
169PhysicalMemory::MemoryPort::recvStatusChange(Port::Status status)
170{
171    memory->recvStatusChange(status);
172}
173
174void
175PhysicalMemory::MemoryPort::getDeviceAddressRanges(AddrRangeList &resp,
176                                            AddrRangeList &snoop)
177{
178    memory->getAddressRanges(resp, snoop);
179}
180
181void
182PhysicalMemory::getAddressRanges(AddrRangeList &resp, AddrRangeList &snoop)
183{
184    snoop.clear();
185    resp.clear();
186    resp.push_back(RangeSize(params()->addrRange.start, params()->addrRange.size()));
187}
188
189int
190PhysicalMemory::MemoryPort::deviceBlockSize()
191{
192    return memory->deviceBlockSize();
193}
194
195bool
196PhysicalMemory::MemoryPort::recvTiming(Packet *pkt)
197{
198    assert(pkt->result != Packet::Nacked);
199
200    Tick latency = memory->doFunctionalAccess(pkt);
201
202    pkt->makeTimingResponse();
203    sendTiming(pkt, latency);
204
205    return true;
206}
207
208Tick
209PhysicalMemory::MemoryPort::recvAtomic(Packet *pkt)
210{
211    return memory->doFunctionalAccess(pkt);
212}
213
214void
215PhysicalMemory::MemoryPort::recvFunctional(Packet *pkt)
216{
217    memory->doFunctionalAccess(pkt);
218}
219
220unsigned int
221PhysicalMemory::drain(Event *de)
222{
223    int count = port->drain(de);
224    if (count)
225        changeState(Draining);
226    else
227        changeState(Drained);
228    return count;
229}
230
231void
232PhysicalMemory::serialize(ostream &os)
233{
234    gzFile compressedMem;
235    string filename = name() + ".physmem";
236
237    SERIALIZE_SCALAR(filename);
238
239    // write memory file
240    string thefile = Checkpoint::dir() + "/" + filename.c_str();
241    int fd = creat(thefile.c_str(), 0664);
242    if (fd < 0) {
243        perror("creat");
244        fatal("Can't open physical memory checkpoint file '%s'\n", filename);
245    }
246
247    compressedMem = gzdopen(fd, "wb");
248    if (compressedMem == NULL)
249        fatal("Insufficient memory to allocate compression state for %s\n",
250                filename);
251
252    if (gzwrite(compressedMem, pmemAddr, params()->addrRange.size()) != params()->addrRange.size()) {
253        fatal("Write failed on physical memory checkpoint file '%s'\n",
254              filename);
255    }
256
257    if (gzclose(compressedMem))
258        fatal("Close failed on physical memory checkpoint file '%s'\n",
259              filename);
260}
261
262void
263PhysicalMemory::unserialize(Checkpoint *cp, const string &section)
264{
265    gzFile compressedMem;
266    long *tempPage;
267    long *pmem_current;
268    uint64_t curSize;
269    uint32_t bytesRead;
270    const int chunkSize = 16384;
271
272
273    string filename;
274
275    UNSERIALIZE_SCALAR(filename);
276
277    filename = cp->cptDir + "/" + filename;
278
279    // mmap memoryfile
280    int fd = open(filename.c_str(), O_RDONLY);
281    if (fd < 0) {
282        perror("open");
283        fatal("Can't open physical memory checkpoint file '%s'", filename);
284    }
285
286    compressedMem = gzdopen(fd, "rb");
287    if (compressedMem == NULL)
288        fatal("Insufficient memory to allocate compression state for %s\n",
289                filename);
290
291    // unmap file that was mmaped in the constructor
292    // This is done here to make sure that gzip and open don't muck with our
293    // nice large space of memory before we reallocate it
294    munmap(pmemAddr, params()->addrRange.size());
295
296    pmemAddr = (uint8_t *)mmap(NULL, params()->addrRange.size(), PROT_READ | PROT_WRITE,
297                                MAP_ANON | MAP_PRIVATE, -1, 0);
298
299    if (pmemAddr == (void *)MAP_FAILED) {
300        perror("mmap");
301        fatal("Could not mmap physical memory!\n");
302    }
303
304    curSize = 0;
305    tempPage = (long*)malloc(chunkSize);
306    if (tempPage == NULL)
307        fatal("Unable to malloc memory to read file %s\n", filename);
308
309    /* Only copy bytes that are non-zero, so we don't give the VM system hell */
310    while (curSize < params()->addrRange.size()) {
311        bytesRead = gzread(compressedMem, tempPage, chunkSize);
312        if (bytesRead != chunkSize && bytesRead != params()->addrRange.size() - curSize)
313            fatal("Read failed on physical memory checkpoint file '%s'"
314                  " got %d bytes, expected %d or %d bytes\n",
315                  filename, bytesRead, chunkSize, params()->addrRange.size()-curSize);
316
317        assert(bytesRead % sizeof(long) == 0);
318
319        for (int x = 0; x < bytesRead/sizeof(long); x++)
320        {
321             if (*(tempPage+x) != 0) {
322                 pmem_current = (long*)(pmemAddr + curSize + x * sizeof(long));
323                 *pmem_current = *(tempPage+x);
324             }
325        }
326        curSize += bytesRead;
327    }
328
329    free(tempPage);
330
331    if (gzclose(compressedMem))
332        fatal("Close failed on physical memory checkpoint file '%s'\n",
333              filename);
334
335}
336
337
338BEGIN_DECLARE_SIM_OBJECT_PARAMS(PhysicalMemory)
339
340    Param<string> file;
341    Param<Range<Addr> > range;
342    Param<Tick> latency;
343
344END_DECLARE_SIM_OBJECT_PARAMS(PhysicalMemory)
345
346BEGIN_INIT_SIM_OBJECT_PARAMS(PhysicalMemory)
347
348    INIT_PARAM_DFLT(file, "memory mapped file", ""),
349    INIT_PARAM(range, "Device Address Range"),
350    INIT_PARAM(latency, "Memory access latency")
351
352END_INIT_SIM_OBJECT_PARAMS(PhysicalMemory)
353
354CREATE_SIM_OBJECT(PhysicalMemory)
355{
356    PhysicalMemory::Params *p = new PhysicalMemory::Params;
357    p->name = getInstanceName();
358    p->addrRange = range;
359    p->latency = latency;
360    return new PhysicalMemory(p);
361}
362
363REGISTER_SIM_OBJECT("PhysicalMemory", PhysicalMemory)
364