exServer.cc

/*************************************************************************\
* Copyright (c) 2002 The University of Chicago, as Operator of Argonne
*     National Laboratory.
* Copyright (c) 2002 The Regents of the University of California, as
*     Operator of Los Alamos National Laboratory.
* EPICS BASE Versions 3.13.7
* and higher are distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/
//
// fileDescriptorManager.process(delay);
// (the name of the global symbol has leaked in here)
//

//
// Example EPICS CA server
//
#include "exServer.h"
#include "config.h"
#include "../../src/include/daqmap.h"
//#include "daqd.hh"
#include "epics_pvs.hh"
// extern daqd_c daqd;

char epicsDcuName[ DCU_COUNT ][ 40 ];

// First subscript is the variable index:
// DCU status is the first element
// CRC error counter is the second element.
// CRC accumulated error counter is the third element.
// Second subscript is the ifo number.
unsigned int epicsDcuStatus[ 3 ][ 2 ][ DCU_COUNT ];

//
// static list of pre-created PVs
//
pvInfo exServer::pvList[] = {
    pvInfo( 1, "CYCLE", 0xffffffff, 0, excasIoSync, 1, pvValue + PV::PV_CYCLE ),
    pvInfo( 1,
            "TOTAL_CHANS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_TOTAL_CHANS ),
    pvInfo( 1,
            "DATA_RATE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_DATA_RATE ),
    pvInfo( 1,
            "EDCU_CHANS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_EDCU_CHANS ),
    pvInfo( 1,
            "EDCU_CONN_CHANS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_EDCU_CONN_CHANS ),
    pvInfo( 1,
            "UPTIME_SECONDS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_UPTIME_SECONDS ),
    pvInfo( 1,
            "LOOKBACK_RAM",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_LOOKBACK_RAM ),
    pvInfo( 1,
            "LOOKBACK_FULL",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_LOOKBACK_FULL ),
    pvInfo( 1,
            "LOOKBACK_DIR",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_LOOKBACK_DIR ),
    pvInfo( 1,
            "LOOKBACK_STREND",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_LOOKBACK_STREND ),
    pvInfo( 1,
            "LOOKBACK_STREND_DIR",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_LOOKBACK_STREND_DIR ),
    pvInfo( 1,
            "LOOKBACK_MTREND",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_LOOKBACK_MTREND ),
    pvInfo( 1,
            "LOOKBACK_MTREND_DIR",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_LOOKBACK_MTREND_DIR ),
    pvInfo( 1,
            "FAST_DATA_CRC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_FAST_DATA_CRC ),
    pvInfo( 1, "FAULT", 0xffffffff, 0, excasIoSync, 1, pvValue + PV::PV_FAULT ),
    pvInfo( 1,
            "BCAST_RETR",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_BCAST_RETR ),
    pvInfo( 1,
            "BCAST_FAILED_RETR",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_BCAST_FAILED_RETR ),
    pvInfo( 0.5, "GPS", 0xffffffff, 0, excasIoSync, 1, pvValue + PV::PV_GPS ),
    pvInfo( 1,
            "CHANS_SAVED",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_CHANS_SAVED ),
    pvInfo( 1,
            "FRAME_SIZE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_FRAME_SIZE ),
    pvInfo( 1,
            "SCIENCE_FRAME_SIZE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SCIENCE_FRAME_SIZE ),
    pvInfo( 1,
            "SCIENCE_TOTAL_CHANS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SCIENCE_TOTAL_CHANS ),
    pvInfo( 1,
            "SCIENCE_CHANS_SAVED",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SCIENCE_CHANS_SAVED ),
    pvInfo( 1,
            "FRAME_WRITE_SEC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_FRAME_WRITE_SEC ),
    pvInfo( 1,
            "SCIENCE_FRAME_WRITE_SEC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SCIENCE_FRAME_WRITE_SEC ),
    pvInfo( 1,
            "SECOND_FRAME_WRITE_SEC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SECOND_FRAME_WRITE_SEC ),
    pvInfo( 1,
            "MINUTE_FRAME_WRITE_SEC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_MINUTE_FRAME_WRITE_SEC ),
    pvInfo( 1,
            "SECOND_FRAME_SIZE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SECOND_FRAME_SIZE ),
    pvInfo( 1,
            "MINUTE_FRAME_SIZE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_MINUTE_FRAME_SIZE ),
    pvInfo( 1,
            "RETRANSMIT_TOTAL",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_RETRANSMIT_TOTAL ),
    pvInfo( 1,
            "PRDCR_UNIQUE_DCU_REPORTED_PER_S",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_UNIQUE_DCU_REPORTED_PER_S ),
    pvInfo( 1,
            "PRDCR_TOTAL_DCU_REPORTED_PER_S",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_TOTAL_DCU_REPORTED_PER_S ),
    pvInfo( 1,
            "PRDCR_TOTAL_DATA_RATE_KB_PER_S",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_TOTAL_DATA_RATE_KB_PER_S ),
    pvInfo( 1,
            "PRDCR_TP_DATA_RATE_KB_PER_S",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_TP_DATA_RATE_KB_PER_S ),
    pvInfo( 1,
            "PRDCR_MODEL_DATA_RATE_KB_PER_S",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_MODEL_DATA_RATE_KB_PER_S ),
    pvInfo( 1,
            "PRDCR_OPEN_TP_COUNT",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_OPEN_TP_COUNT ),
    pvInfo( 1,
            "PRDCR_TIME_FULL_MEAN_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_TIME_FULL_MEAN_MS ),
    pvInfo( 1,
            "PRDCR_TIME_FULL_MIN_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_TIME_FULL_MIN_MS ),
    pvInfo( 1,
            "PRDCR_TIME_FULL_MAX_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_TIME_FULL_MAX_MS ),
    pvInfo( 1,
            "PRDCR_TIME_RECV_MEAN_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_TIME_RECV_MEAN_MS ),
    pvInfo( 1,
            "PRDCR_TIME_RECV_MIN_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_TIME_RECV_MIN_MS ),
    pvInfo( 1,
            "PRDCR_TIME_RECV_MAX_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_TIME_RECV_MAX_MS ),
    pvInfo( 1,
            "PRDCR_CRC_TIME_FULL_MEAN_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_CRC_TIME_FULL_MEAN_MS ),
    pvInfo( 1,
            "PRDCR_CRC_TIME_FULL_MIN_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_CRC_TIME_FULL_MIN_MS ),
    pvInfo( 1,
            "PRDCR_CRC_TIME_FULL_MAX_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_CRC_TIME_FULL_MAX_MS ),
    pvInfo( 1,
            "PRDCR_CRC_TIME_CRC_MEAN_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_CRC_TIME_CRC_MEAN_MS ),
    pvInfo( 1,
            "PRDCR_CRC_TIME_CRC_MIN_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_CRC_TIME_CRC_MIN_MS ),
    pvInfo( 1,
            "PRDCR_CRC_TIME_CRC_MAX_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_CRC_TIME_CRC_MAX_MS ),
    pvInfo( 1,
            "PRDCR_CRC_TIME_XFER_MEAN_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_CRC_TIME_XFER_MEAN_MS ),
    pvInfo( 1,
            "PRDCR_CRC_TIME_XFER_MIN_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_CRC_TIME_XFER_MIN_MS ),
    pvInfo( 1,
            "PRDCR_CRC_TIME_XFER_MAX_MS",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PRDCR_CRC_TIME_XFER_MAX_MS ),
    pvInfo( 1,
            "PROFILER_FREE_SEGMENTS_MAIN_BUF",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_PROFILER_FREE_SEGMENTS_MAIN_BUF ),
    pvInfo( 1,
            "RAW_FW_STATE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_RAW_FW_STATE ),
    pvInfo( 1,
            "RAW_FW_DATA_STATE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_RAW_FW_DATA_STATE ),
    pvInfo( 1,
            "RAW_FW_DATA_SEC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_RAW_FW_DATA_SEC ),
    pvInfo( 1,
            "SCIENCE_FW_STATE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SCIENCE_FW_STATE ),
    pvInfo( 1,
            "SCIENCE_FW_DATA_STATE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SCIENCE_FW_DATA_STATE ),
    pvInfo( 1,
            "SCIENCE_FW_DATA_SEC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SCIENCE_FW_DATA_SEC ),
    pvInfo( 1,
            "STREND_FW_STATE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_STREND_FW_STATE ),
    pvInfo( 1,
            "MTREND_FW_STATE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_MTREND_FW_STATE ),
    pvInfo( 1,
            "FRAME_CHECK_SUM_TRUNC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_FRAME_CHECK_SUM_TRUNC ),
    pvInfo( 1,
            "SCIENCE_FRAME_CHECK_SUM_TRUNC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SCIENCE_FRAME_CHECK_SUM_TRUNC ),
    pvInfo( 1,
            "SECOND_FRAME_CHECK_SUM_TRUNC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_SECOND_FRAME_CHECK_SUM_TRUNC ),
    pvInfo( 1,
            "MINUTE_FRAME_CHECK_SUM_TRUNC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_MINUTE_FRAME_CHECK_SUM_TRUNC ),
    pvInfo( 1,
            "CONFIGURATION_NUMBER",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_CONFIGURATION_NUMBER ),
    pvInfo( 1,
            "RAW_MTREND_TW_STATE",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_RAW_MTREND_TW_STATE ),
    pvInfo( 1,
            "RAW_MTREND_TW_WRITE_SEC",
            0xffffffff,
            0,
            excasIoSync,
            1,
            pvValue + PV::PV_RAW_MTREND_TW_WRITE_SEC )

};

const unsigned exServer::pvListNElem = NELEMENTS( exServer::pvList );

//
// exServer::exServer()
//
exServer::exServer( const char* const pvPrefix,
                    const char* const pvPrefix1,
                    const char* const pvPrefix2,
                    unsigned          aliasCount,
                    bool              scanOnIn )
    : simultAsychIOCount( 0u ), scanOn( scanOnIn )
{
    unsigned          i, j;
    exPV*             pPV;
    pvInfo*           pPVI;
    pvInfo*           pPVAfter = &exServer::pvList[ pvListNElem ];
    char              pvAlias[ 256 ];
    const char* const pNameFmtStr = "%.100s%.40s";
    const char* const pDcuNameFmtStr[ 3 ] = { "%.100s%.40s_STATUS",
                                              "%.100s%.40s_CRC_CPS",
                                              "%.100s%.40s_CRC_SUM" };
    const char* const pAliasFmtStr = "%.100s%.40s%u";

    exPV::initFT( );

    //
    // pre-create all of the simple PVs that this server will export
    //
    for ( pPVI = exServer::pvList; pPVI < pPVAfter; pPVI++ )
    {
        pPV = pPVI->createPV( *this, true, scanOnIn );
        if ( !pPV )
        {
            fprintf(
                stderr, "Unable to create new PV \"%s\"\n", pPVI->getName( ) );
        }

        //
        // Install canonical (root) name
        //
        sprintf( pvAlias, pNameFmtStr, pvPrefix, pPVI->getName( ) );
        this->installAliasName( *pPVI, pvAlias );
    }

    // Create DCU status channels
    for ( i = 0; i < DCU_COUNT; i++ )
    {
        for ( j = 0; j < 3; j++ )
        {
            if ( epicsDcuName[ i ][ 0 ] == 0 )
                continue;
            sprintf(
                pvAlias, pDcuNameFmtStr[ j ], pvPrefix1, epicsDcuName[ i ] );
            pvInfo* pPVI = new pvInfo( 1,
                                       pvAlias,
                                       0xffffffff,
                                       0,
                                       excasIoSync,
                                       1,
                                       epicsDcuStatus[ j ][ 0 ] + i );
            pPV = pPVI->createPV( *this, true, scanOnIn );
            if ( !pPV )
            {
                fprintf( stderr,
                         "Unable to create new PV \"%s\"\n",
                         pPVI->getName( ) );
                continue;
            }
            this->installAliasName( *pPVI, pvAlias );
            printf( "Creating %s\n", pvAlias );
        }
    }

    if ( strcmp( pvPrefix2, "" ) )
    {
        for ( i = 0; i < DCU_COUNT; i++ )
        {
            for ( j = 0; j < 3; j++ )
            {
                if ( epicsDcuName[ i ][ 0 ] == 0 )
                    continue;
                sprintf( pvAlias,
                         pDcuNameFmtStr[ j ],
                         pvPrefix2,
                         epicsDcuName[ i ] );
                pvInfo* pPVI = new pvInfo( 1,
                                           pvAlias,
                                           0xffffffff,
                                           0,
                                           excasIoSync,
                                           1,
                                           epicsDcuStatus[ j ][ 1 ] + i );
                pPV = pPVI->createPV( *this, true, scanOnIn );
                if ( !pPV )
                {
                    fprintf( stderr,
                             "Unable to create new PV \"%s\"\n",
                             pPVI->getName( ) );
                    continue;
                }
                this->installAliasName( *pPVI, pvAlias );
            }
        }
    }
}

//
// exServer::~exServer()
//
exServer::~exServer( )
{
    pvInfo* pPVI;
    pvInfo* pPVAfter = &exServer::pvList[ NELEMENTS( exServer::pvList ) ];

    //
    // delete all pre-created PVs (eliminate bounds-checker warnings)
    //
    for ( pPVI = exServer::pvList; pPVI < pPVAfter; pPVI++ )
    {
        pPVI->deletePV( );
    }

    this->stringResTbl.traverse( &pvEntry::destroy );
}

//
// exServer::installAliasName()
//
void
exServer::installAliasName( pvInfo& info, const char* pAliasName )
{
    pvEntry* pEntry;

    pEntry = new pvEntry( info, *this, pAliasName );
    if ( pEntry )
    {
        int resLibStatus;
        resLibStatus = this->stringResTbl.add( *pEntry );
        if ( resLibStatus == 0 )
        {
            return;
        }
        else
        {
            delete pEntry;
        }
    }
    fprintf(
        stderr,
        "Unable to enter PV=\"%s\" Alias=\"%s\" in PV name alias hash table\n",
        info.getName( ),
        pAliasName );
}

//
// exServer::pvExistTest()
//
pvExistReturn exServer::pvExistTest // X aCC 361
    ( const casCtx& ctxIn, const char* pPVName )
{
    //
    // lifetime of id is shorter than lifetime of pName
    //
    stringId id( pPVName, stringId::refString );
    pvEntry* pPVE;

    //
    // Look in hash table for PV name (or PV alias name)
    //
    pPVE = this->stringResTbl.lookup( id );
    if ( !pPVE )
    {
        return pverDoesNotExistHere;
    }

    pvInfo& pvi = pPVE->getInfo( );

    //
    // Initiate async IO if this is an async PV
    //
    if ( pvi.getIOType( ) == excasIoSync )
    {
        return pverExistsHere;
    }
    return pverDoesNotExistHere;
}

//
// exServer::pvAttach()
//
pvAttachReturn exServer::pvAttach // X aCC 361
    ( const casCtx& ctx, const char* pName )
{
    //
    // lifetime of id is shorter than lifetime of pName
    //
    stringId id( pName, stringId::refString );
    exPV*    pPV;
    pvEntry* pPVE;

    pPVE = this->stringResTbl.lookup( id );
    if ( !pPVE )
    {
        return S_casApp_pvNotFound;
    }

    pvInfo& pvi = pPVE->getInfo( );

    //
    // If this is a synchronous PV create the PV now
    //
    if ( pvi.getIOType( ) == excasIoSync )
    {
        pPV = pvi.createPV( *this, false, this->scanOn );
        if ( pPV )
        {
            return *pPV;
        }
        else
        {
            return S_casApp_noMemory;
        }
    }
}

//
// pvInfo::createPV()
//
exPV*
pvInfo::createPV( exServer& /*cas*/, bool preCreateFlag, bool scanOn )
{
    if ( this->pPV )
    {
        return this->pPV;
    }

    exPV* pNewPV;

    //
    // create an instance of the appropriate class
    // depending on the io type and the number
    // of elements
    //
    if ( this->elementCount == 1u )
    {
        switch ( this->ioType )
        {
        case excasIoSync:
            pNewPV = new exScalarPV( *this, preCreateFlag, scanOn );
            break;
        default:
            pNewPV = NULL;
            break;
        }
    }
    else
    {
        if ( this->ioType == excasIoSync )
        {
            pNewPV = new exVectorPV( *this, preCreateFlag, scanOn );
        }
        else
        {
            pNewPV = NULL;
        }
    }

    //
    // load initial value (this is not done in
    // the constructor because the base class's
    // pure virtual function would be called)
    //
    // We always perform this step even if
    // scanning is disable so that there will
    // always be an initial value
    //
    if ( pNewPV )
    {
        this->pPV = pNewPV;
        pNewPV->scan( );
    }

    return pNewPV;
}

//
// exServer::show()
//
void
exServer::show( unsigned level ) const
{
    //
    // server tool specific show code goes here
    //
    this->stringResTbl.show( level );

    //
    // print information about ca server libarary
    // internals
    //
    this->caServer::show( level );
}