fs_translating_port_proxy.hh revision 8229 
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 Declaration. 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 "arch/vtophys.hh"
42#include "config/full_system.hh"
43#include "mem/port_impl.hh"
44
45/** A class that translates a virtual address to a physical address and then
46 * calls the above read/write functions. If a thread context is provided the
47 * address can alway be translated, If not it can only be translated if it is a
48 * simple address masking operation (such as alpha super page accesses).
49 */
50
51
52class VirtualPort  : public FunctionalPort
53{
54  private:
55    ThreadContext *tc;
56
57  public:
58    VirtualPort(const std::string &_name, ThreadContext *_tc = NULL)
59        : FunctionalPort(_name), tc(_tc)
60    {}
61
62    /** Return true if we have an thread context. This is used to
63     * prevent someone from accidently deleting the cpus statically
64     * allocated vport.
65     * @return true if a thread context isn't valid
66     */
67    bool nullThreadContext() { return tc != NULL; }
68
69    /** Version of readblob that translates virt->phys and deals
70      * with page boundries. */
71    virtual void readBlob(Addr addr, uint8_t *p, int size);
72
73    /** Version of writeBlob that translates virt->phys and deals
74      * with page boundries. */
75    virtual void writeBlob(Addr addr, uint8_t *p, int size);
76};
77
78
79void CopyOut(ThreadContext *tc, void *dest, Addr src, size_t cplen);
80void CopyIn(ThreadContext *tc, Addr dest, void *source, size_t cplen);
81void CopyStringOut(ThreadContext *tc, char *dst, Addr vaddr, size_t maxlen);
82void CopyStringIn(ThreadContext *tc, char *src, Addr vaddr);
83
84#endif //__MEM_VPORT_HH__
85
86