syscall_emul_buf.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __SIM_SYSCALL_EMUL_BUF_HH__
#define __SIM_SYSCALL_EMUL_BUF_HH__

 
#include <cstring>
 
#include "base/types.hh"
#include "mem/se_translating_port_proxy.hh"
 
namespace gem5
{

class BaseBufferArg
{
 
  public:

    BaseBufferArg(Addr _addr, uint64_t _size)
        : addr(_addr), size(_size), bufPtr(new uint8_t[size])
    {
        // clear out buffer: in case we only partially populate this,
        // and then do a copyOut(), we want to make sure we don't
        // introduce any random junk into the simulated address space
        memset(bufPtr, 0, size);
    }
 
    ~BaseBufferArg() { delete [] bufPtr; }

    bool
    copyIn(const PortProxy &memproxy)
    {
        memproxy.readBlob(addr, bufPtr, size);
        return true;    // no EFAULT detection for now
    }

    bool
    copyOut(const PortProxy &memproxy)
    {
        memproxy.writeBlob(addr, bufPtr, size);
        return true;    // no EFAULT detection for now
    }
 
  protected:
    const Addr addr;        
    const uint64_t size;         
    uint8_t * const bufPtr; 
};

class BufferArg : public BaseBufferArg
{
  public:
    BufferArg(Addr _addr, uint64_t _size) : BaseBufferArg(_addr, _size) { }

    void *bufferPtr() { return bufPtr; }
};

template <class T>
class TypedBufferArg : public BaseBufferArg
{
  public:
    TypedBufferArg(Addr _addr, uint64_t _size = sizeof(T))
        : BaseBufferArg(_addr, _size)
    { }

    operator T*() { return (T *)bufPtr; }

    T &operator*()       { return *((T *)bufPtr); }
 

    T* operator->()      { return (T *)bufPtr; }

    T &operator[](int i) { return ((T *)bufPtr)[i]; }
};
 
} // namespace gem5
 
#endif // __SIM_SYSCALL_EMUL_BUF_HH__