gem5  v20.1.0.0
syscall_emul_buf.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2003-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 
29 #ifndef __SIM_SYSCALL_EMUL_BUF_HH__
30 #define __SIM_SYSCALL_EMUL_BUF_HH__
31 
37 
38 #include <cstring>
39 
40 #include "base/types.hh"
42 
55 
56  public:
57 
62  BaseBufferArg(Addr _addr, int _size)
63  : addr(_addr), size(_size), bufPtr(new uint8_t[size])
64  {
65  // clear out buffer: in case we only partially populate this,
66  // and then do a copyOut(), we want to make sure we don't
67  // introduce any random junk into the simulated address space
68  memset(bufPtr, 0, size);
69  }
70 
71  ~BaseBufferArg() { delete [] bufPtr; }
72 
76  bool
77  copyIn(PortProxy &memproxy)
78  {
79  memproxy.readBlob(addr, bufPtr, size);
80  return true; // no EFAULT detection for now
81  }
82 
86  bool
87  copyOut(PortProxy &memproxy)
88  {
89  memproxy.writeBlob(addr, bufPtr, size);
90  return true; // no EFAULT detection for now
91  }
92 
93  protected:
94  const Addr addr;
95  const int size;
96  uint8_t * const bufPtr;
97 };
98 
103 class BufferArg : public BaseBufferArg
104 {
105  public:
110  BufferArg(Addr _addr, int _size) : BaseBufferArg(_addr, _size) { }
111 
115  void *bufferPtr() { return bufPtr; }
116 };
117 
127 template <class T>
129 {
130  public:
137  TypedBufferArg(Addr _addr, int _size = sizeof(T))
138  : BaseBufferArg(_addr, _size)
139  { }
140 
145  operator T*() { return (T *)bufPtr; }
146 
151  T &operator*() { return *((T *)bufPtr); }
152 
153 
158  T* operator->() { return (T *)bufPtr; }
159 
164  T &operator[](int i) { return ((T *)bufPtr)[i]; }
165 };
166 
167 
168 #endif // __SIM_SYSCALL_EMUL_BUF_HH__
BaseBufferArg::~BaseBufferArg
~BaseBufferArg()
Definition: syscall_emul_buf.hh:71
ArmISA::i
Bitfield< 7 > i
Definition: miscregs_types.hh:63
TypedBufferArg::operator[]
T & operator[](int i)
Enable the use of '[]' to reference fields where T is an array type.
Definition: syscall_emul_buf.hh:164
TypedBufferArg::operator->
T * operator->()
Enable the use of '->' to reference fields where T is a struct type.
Definition: syscall_emul_buf.hh:158
BaseBufferArg
Base class for BufferArg and TypedBufferArg, Not intended to be used directly.
Definition: syscall_emul_buf.hh:54
PortProxy::writeBlob
void writeBlob(Addr addr, const void *p, int size) const
Same as tryWriteBlob, but insists on success.
Definition: port_proxy.hh:187
TypedBufferArg::TypedBufferArg
TypedBufferArg(Addr _addr, int _size=sizeof(T))
Allocate a buffer of type T representing the memory at target address 'addr'.
Definition: syscall_emul_buf.hh:137
Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:142
BaseBufferArg::copyIn
bool copyIn(PortProxy &memproxy)
copy data into simulator space (read from target memory)
Definition: syscall_emul_buf.hh:77
BufferArg::bufferPtr
void * bufferPtr()
Return a pointer to the internal simulator-space buffer.
Definition: syscall_emul_buf.hh:115
TypedBufferArg::operator*
T & operator*()
Convert TypedBufferArg<T> to a reference to T that references the internal buffer value.
Definition: syscall_emul_buf.hh:151
PortProxy
This object is a proxy for a port or other object which implements the functional response protocol,...
Definition: port_proxy.hh:80
BufferArg::BufferArg
BufferArg(Addr _addr, int _size)
Allocate a buffer of size 'size' representing the memory at target address 'addr'.
Definition: syscall_emul_buf.hh:110
types.hh
BaseBufferArg::BaseBufferArg
BaseBufferArg(Addr _addr, int _size)
Allocate a buffer of size 'size' representing the memory at target address 'addr'.
Definition: syscall_emul_buf.hh:62
BaseBufferArg::size
const int size
buffer size
Definition: syscall_emul_buf.hh:95
TypedBufferArg
TypedBufferArg is a class template; instances of this template represent typed buffers in target user...
Definition: syscall_emul_buf.hh:128
se_translating_port_proxy.hh
BaseBufferArg::addr
const Addr addr
address of buffer in target address space
Definition: syscall_emul_buf.hh:94
BufferArg
BufferArg represents an untyped buffer in target user space that is passed by reference to an (emulat...
Definition: syscall_emul_buf.hh:103
PortProxy::readBlob
void readBlob(Addr addr, void *p, int size) const
Higher level interfaces based on the above.
Definition: port_proxy.hh:177
BaseBufferArg::bufPtr
uint8_t *const bufPtr
pointer to buffer in simulator space
Definition: syscall_emul_buf.hh:96
BaseBufferArg::copyOut
bool copyOut(PortProxy &memproxy)
copy data out of simulator space (write to target memory)
Definition: syscall_emul_buf.hh:87

Generated on Wed Sep 30 2020 14:02:14 for gem5 by doxygen 1.8.17