fs_translating_port_proxy.hh revision 2665
1/*
2 * Copyright (c) 2006 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: Ali Saidi
29 */
30
31/**
32 * @file
33 * Virtual Port Object Decleration. These ports incorporate some translation
34 * into their access methods. Thus you can use one to read and write data
35 * to/from virtual addresses.
36 */
37
38#ifndef __MEM_VPORT_HH__
39#define __MEM_VPORT_HH__
40
41#include "mem/port.hh"
42#include "config/full_system.hh"
43#include "arch/vtophys.hh"
44
45
46/** A class that translates a virtual address to a physical address and then
47 * calls the above read/write functions. If an execution context is provided the
48 * address can alway be translated, If not it can only be translated if it is a
49 * simple address masking operation (such as alpha super page accesses).
50 */
51
52class VirtualPort  : public FunctionalPort
53{
54  private:
55    ExecContext *xc;
56
57  public:
58    VirtualPort(const std::string &_name, ExecContext *_xc = NULL)
59        : FunctionalPort(_name), xc(_xc)
60    {}
61
62    /** Return true if we have an exec context. This is used to prevent someone
63     * from accidently deleting the cpus statically allocated vport.
64     * @return true if an execution context isn't valid
65     */
66    bool nullExecContext() { return xc != NULL; }
67
68    /** Version of readblob that translates virt->phys and deals
69      * with page boundries. */
70    virtual void readBlob(Addr addr, uint8_t *p, int size);
71
72    /** Version of writeBlob that translates virt->phys and deals
73      * with page boundries. */
74    virtual void writeBlob(Addr addr, uint8_t *p, int size);
75};
76
77#endif //__MEM_VPORT_HH__
78
79