src/mem/translating_port_proxy.hh

   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) 2006 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
  41 #ifndef __MEM_TRANSLATING_PORT_PROXY_HH__
  42 #define __MEM_TRANSLATING_PORT_PROXY_HH__
  43
  44 #include "arch/generic/tlb.hh"
  45 #include "mem/port_proxy.hh"
  46
  47 class ThreadContext;
  48
  49 /**
  50  * This proxy attempts to translate virtual addresses using the TLBs. If it
  51  * fails, subclasses can override the fixupAddr virtual method to try to
  52  * recover, and then attempt the translation again. If it still fails then the
  53  * access as a whole fails.
  54  */
  55 class TranslatingPortProxy : public PortProxy
  56 {
  57   private:
  58     bool tryTLBsOnce(RequestPtr req, BaseTLB::Mode) const;
  59     bool tryTLBs(RequestPtr req, BaseTLB::Mode) const;
  60
  61   protected:
  62     ThreadContext* _tc;
  63     const Addr pageBytes;
  64
  65     Request::Flags flags;
  66
  67     virtual bool
  68     fixupAddr(Addr addr, BaseTLB::Mode mode) const
  69     {
  70         return false;
  71     }
  72
  73   public:
  74
  75     TranslatingPortProxy(ThreadContext *tc, Request::Flags _flags=0);
  76
  77     /** Version of tryReadblob that translates virt->phys and deals
  78       * with page boundries. */
  79     bool tryReadBlob(Addr addr, void *p, int size) const override;
  80
  81     /** Version of tryWriteBlob that translates virt->phys and deals
  82       * with page boundries. */
  83     bool tryWriteBlob(Addr addr, const void *p, int size) const override;
  84
  85     /**
  86      * Fill size bytes starting at addr with byte value val.
  87      */
  88     bool tryMemsetBlob(Addr address, uint8_t  v, int size) const override;
  89 };
  90
  91 #endif //__MEM_TRANSLATING_PORT_PROXY_HH__