ipshm.hxx

Go to the documentation of this file.

/*
 *   anvil
 *   Copyright (C) 2007    Karl W. Pfalzer
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the
 *   Free Software Foundation, Inc.
 *   51 Franklin Street, Fifth Floor
 *   Boston, MA  02110-1301, USA.
 */
#if !defined(_anvil_ipshm_hxx_)
#    define  _anvil_ipshm_hxx_

extern "C"
{
#include "vpi_user.h"
}
#include <iostream>
#include "xyzzy/shmalloc.hxx"
#include "xyzzy/semaphore.hxx"
#include "xyzzy/exception.hxx"
#include "anvil/object.hxx"

namespace anvil
{

using namespace xyzzy;
using std::ostream;

class TShared;

class XValueException : public TException {};

class TShmObject
{
public:
    const char* getName() const;

    s_vpi_vecval& vectorAt(unsigned ix) {return m_value[ix];}

    int getNumBits() const {return m_numBits;}

    ostream& print(ostream &os);

    bool isInput() const {return m_isInput;}

    // Xfer to m_value through handle (i.e., dut -> shared mem)
    void xferToValue();

    // Xfer from m_value/shared throug handle to dut.
    // Set getTime 1st time through iteration (only).
    void xferFromValue(bool getTime = false);

private:
    explicit TShmObject(const TRcObject obj);

    void* operator new(size_t sz);

    PTShmObj<const char*>   m_name;

    bool        m_isInput;
    int         m_numBits;
    vpiHandle   m_hnd;

    // Cant have union w/ object w/ copy constructor, so we'll just 
    // take the worst case and always use vectors.
    PTShmObjAr<s_vpi_vecval> m_value;

    friend class TShared;
};

class TShared
{
public:
    explicit TShared(TRcObjectSet set);

    static TShared* asShared(const char *keyAndSize);

    void* operator new(size_t szThis, TRcObjectSet set);

    TShmObject& objectAt(unsigned ix);

    ostream& print(ostream &os);

public:
    PTShmObjAr<PTShmObj<TShmObject*> > m_objs;
    // wakeupX: wait on X side, post on non-X side (X is one of Dut|Tb)
    TSemaphore  m_wakeupDut, m_wakeupTb;

    // tb notify of time to run for (0 == stop).
    // dut uses for current sim time.
    s_vpi_time  m_timeVal;

    // tb signal delay; as in "lhs = #assignDelay rhs"
    s_vpi_time  m_assignDelay;

    // Throw exception on X values on (any) output.
    bool m_exceptionOnX;
};

};

#endif //_anvil_ipshm_hxx_

---