ospf_mib_api.h

vxworks下ospf协议栈

    int mApiOspfMaxVirtNbr;  /* max numbr of instances for ospfVirtNbrTable */
    int mApiOspfMaxExtLsdb;  /* max number of instances for ospfExtLsdbTable */
    int mApiOspfMaxAreaAg;   /* max number of instances for ospfAreaAggregateTable */
    
    /* current system capacities */
    int mApiOspfCurrAreaCnt;      /* current number of instances in ospfAreaTable */
    int mApiOspfCurrStubCnt;      /* current number of instances in ospfStubTable */
    int mApiOspfCurrLsdbCnt;      /* current number of instances in ospfLsdbTable */
    int mApiOspfCurrHostCnt;      /* current number of instances in ospfHostTable */
    int mApiOspfCurrIfCnt;        /* current number of instances in ospfIfTable */
    int mApiOspfCurrIfMetricCnt;  /* current number of instances in ospfIfTable */
    int mApiOspfCurrVirtIfCnt;    /* current number of isntances in ospfVirtIfTable */
    int mApiOspfCurrNbrCnt;       /* current number of instances in ospfNbrTable */
    int mApiOspfCurrVirtNbrCnt;   /* current number of instances in ospfVirtNbrTable */
    int mApiOspfCurrExtLsdbCnt;   /* current number of instances in ospfExtLsdbTable */
    int mApiOspfCurrAreaAgCnt; /* current number of instances in ospfAreaAggregateTable */

    /* interanl operational erros statistics due to max capacity reached */
    int mApiOspfAreaMaxReached;      /* max capacility for ospfAreaTable reached */
    int mApiOspfStubMaxReached;      /* max capacility for ospfStubTable reached */
    int mApiOspfLsdbMaxReached;      /* max capacility for ospfLsdbTable reached */
    int mApiOspfHostMaxReached;      /* max capacility for ospfHostTable reached */
    int mApiOspfIfMaxReached;        /* max capacility for ospfIfTable reached */
    int mApiOspfIfMetricMaxReached;  /* max capacility for ospfIfMetricTable reached */
    int mApiOspfVirtIfMaxReached;    /* max capacility for ospfVirtIfTable reached */
    int mApiOspfNbrMaxReached;       /* max capacility for ospfNbrTable reached */
    int mApiOspfVirtNbrMaxReached;   /* max capacility for ospfVirtNbrTable reached */
    int mApiOspfExtLsdbMaxReached;   /* max capacility for ospfExtLsdbTable reached */
    int mApiOspfAreaAgMaxReached;  /* max capacility for ospfAreaAggregateTable reached */

    /* internal operational error statistics due to reasons other than max capacity 
     * problem (resulted in instance not being created)
     */
    int mApiOspfAreaFailedCnt;       /* number of creation failure for ospfAreaTable */
    int mApiOspfStubFailedCnt;       /* number of creation failure for ospfStubTable */
    int mApiOspfLsdbFailedCnt;       /* number of creation failure for ospfLsdbTable */
    int mApiOspfHostFailedCnt;       /* number of creation failure for ospfHostTable */
    int mApiOspfIfFailedCnt;         /* number of creation failure for ospfIfTable */
    int mApiOspfIfMetricFailedCnt;  /* number of creation failure for ospfIfMetricTable */
    int mApiOspfVirtIfFailedCnt;     /* number of creation failure for ospfVirtIfTable */
    int mApiOspfNbrFailedCnt;        /* number of creation failure for ospfNbrTable */
    int mApiOspfVirtNbrFailedCnt;    /* number of creation failure for ospfVirtNbrTable */
    int mApiOspfExtLsdbFailedCnt;    /* number of creation failure for ospfExtLsdbTable */
    int mApiOspfAreaAgFailedCnt;  /* num of creation failure for ospfAreaAggregateTable */

    /* OSPF-MIB data strctures */
    void *pMapiOspfGenGroup;   /* ospf general group scalar objects */

    mApiOspfAvlClass_t  ospfAreaAvl;     /* AVL tree for ospfAreaTable */
    mApiOspfAvlClass_t  ospfStubAvl;     /* AVL tree for ospfStubTable */
    mApiOspfAvlClass_t  ospfLsdbAvl;     /* AVL tree for ospfLsdbTable */
    mApiOspfAvlClass_t  ospfHostAvl;     /* AVL tree for ospfHostTable */
    mApiOspfAvlClass_t  ospfIfAvl;       /* AVL tree for ospfIfTable */
    mApiOspfAvlClass_t  ospfIfMetricAvl; /* AVL tree for ospfIfMetric */
    mApiOspfAvlClass_t  ospfVirtIfAvl;   /* AVL tree for ospfVirtIfTable */
    mApiOspfAvlClass_t  ospfNbrAvl;      /* AVL tree for ospfNbrTable */  
    mApiOspfAvlClass_t  ospfVirtNbrAvl;  /* AVL tree for ospfVirtNbrTable */
    mApiOspfAvlClass_t  ospfExtLsdbAvl;  /* AVL tree for ospfExtLsdbTable */
    mApiOspfAvlClass_t  ospfAreaAgAvl;   /* AVL tree for ospfAreaAggregateTable */
    
    /* rowStatus library handlers */
    rsParams_t   *pMapiOspfAreaRs;       /* ospfAreaTable Row Status handler */
    rsParams_t   *pMapiOspfStubRs;       /* ospfStubTable Row Status handler */
    rsParams_t   *pMapiOspfHostRs;       /* ospfHostTable Row Status handler */
    rsParams_t   *pMapiOspfIfRs;         /* ospfIfTable Row Status handler */
    rsParams_t   *pMapiOspfIfmRs;        /* ospfIfMetricTable Row Status handler */
    rsParams_t   *pMapiOspfVirtIfRs;     /* ospfVirtIfTable Row Status handler */
    rsParams_t   *pMapiOspfNbrRs;        /* ospfNbrTable Row Status handler */
    rsParams_t   *pMapiOspfAreaAgRs;     /* ospfAreaAggregateTable Row Status handler */
    

    ulong_t       currObjInProcess;       /* current varbind to process */
    mApiObject_t  *pMapiCurrObj;          /* current varbind to process */
    mApiReqType_t currMapiReqType;        /* current mApi request type to process */

    /* system dependent configuration parameters for WRN OSPF Enterprise MIB */
    int mApiWrnOspfMaxArea;       /* max number of instances for wrnOspfAreaTable */
    int mApiWrnOspfMaxLsdb;       /* max number of instances for wrnOspfLsdbTable */
    int mApiWrnOspfMaxLocalLsdb;  /* max number of instances for wrnOspfLocalLsdbTable */
    int mApiWrnOspfMaxExtLsdb;    /* max number of instances for wrnOspfExtLsdbTable */
    int mApiWrnOspfMaxIf;         /* max number of instances for wrnOspfIfTable */

    /* current system capacities */
    int mApiWrnOspfCurrAreaCnt;      /* curr. num of instances in wrnOspfAreaTable */
    int mApiWrnOspfCurrLsdbCnt;      /* curr. num of instances in wrnOspfLsdbTable */
    int mApiWrnOspfCurrLocalLsdbCnt; /* curr. num of instances in wrnOspfLocalLsdbTable */
    int mApiWrnOspfCurrExtLsdbCnt;   /* cur. num of instances in wrnOspfExtLsdbTable */
    int mApiWrnOspfCurrIfCnt;        /* curr. number of instances in wrnOspfIfTable */
    
    /* interanl operational erros statistics due to max capacity reached */
    int mApiWrnOspfAreaMaxReached;      /* max for wrnOspfAreaTable reached */
    int mApiWrnOspfLsdbMaxReached;      /* max for wrnOspfLsdbTable reached */
    int mApiWrnOspfLocalLsdbMaxReached; /* max for wrnOspfLocalLsdbTable reached */
    int mApiWrnOspfExtLsdMaxReached;    /* max for wrnOspfExtTable reached */
    int mApiWrnOspfIfMaxReached;        /* max for wrnOspfIfTable reached */

    /* internal operational error statistics due to reasons other than max capacity 
     * problem (resulted in instance not being created)
     */
    int mApiWrnOspfAreaFailedCnt;    /* num of failure for wrnOspfAreaTable */
    int mApiWrnOspfLsdbFailedCnt;    /* num of failure for wrnOspfLsdbTable */
    int mApiWrnOspfLocalLsdbFailedCnt; /* num of failure for wrnOspfLocalLsdbTable */
    int mApiWrnOspfExtLsdbFailedCnt;   /* number of failure for wrnOspfExtLsdbTable */
    int mApiWrnOspfIfFailedCnt;        /* number of failure for wrnOspfIfTable */

    void *pMapiWrnOspfGenGroup;   /* wrn ospf general group scalar objects */

    mApiOspfAvlClass_t  wrnOspfAreaAvl;     /* AVL tree for ospfAreaTable */
    mApiOspfAvlClass_t  wrnOspfLsdbAvl;     /* AVL tree for ospfLsdbTable */
    mApiOspfAvlClass_t  wrnOspfLocalLsdbAvl; /* AVL tree for wrnOspfLocLsdbTable */
    mApiOspfAvlClass_t  wrnOspfExtLsdbAvl; /* AVL tree for wrnOspfExtLsdbTable */
    mApiOspfAvlClass_t  wrnOspfIfAvl;        /* AVL tree for wrnOspfIfTable */

    /* rowStatus library handlers for wrn-ospf enterprise mib */
    rsParams_t   *pMapiWrnOspfIfRs;         /* wrnOspfIfTable Row Status handler */

    /* number of active area. An area is said to be active if there is at least one
     * operational interfaces belonging to the area. If the value is greater than
     * one, the router is an area border router
     */
    ushort_t  numActiveArea;  

    /* SNMP TEST/COMMIT/UNDO/COMPLETE counters, for state transition monitoring */
    int mApiTestReqCnt;          /* number of SNMP TEST requests processed */
    int mApiCommitReqCnt;        /* number of SNMP COMMIT requests processed */
    int mApiUndoReqCnt;          /* number of SNMP UNDO requests processed */
    int mApiCompleteReqCnt;      /* number of SNMP COMMIT succeed, for debugging */
    int mApiBogusReqCnt;         /* number of incorrect SNMP requests, for debugging */
    int mApiTestReqFailedCnt;    /* number of SNMP TEST failed, for debugging */
    int mApiCommitReqFailedCnt;  /* number of SNMP COMMIT failed, for debugging */
    int mApiNvmSetReqFailedCnt;  /* number of MAPI NVM SET failed, for debugging */
    int mApiGetReqFailedCnt;     /* number of SNMP GET failed, for debugging */
    int mApiGetNextReqFailedCnt; /* number of SNMP GET_NEXT failed, for debugging */
    int mApiDynConfigReqFailedCnt; /* number of dynamic reconfig failed, for debugging */
    
} mApiOspfClass_t;

/* global variables */
mApiOspfClass_t *thisMapi;           /* the mib api object */

/***************************************************************************************
 * Management Interface Public Macro
 */
#define OSPF_MIB_BUFLEN_CHECK(pRequest, pObject, actualLen) \
       if ( ((pObject)->valueLen < actualLen) || \
            ((pObject)->pValueBuf == NULL) ) \
       { \
         (pObject)->valueLen = actualLen; \
         (pObject)->exception = MAPI_BUFFER_TOO_SHORT; \
         (pRequest)->errorObjIndex = (ushort_t)(pObject)->oidPrefixEnum; \
         (pRequest)->error = (int)0; \
         return OK; \
       }

       
#define OSPF_MIB_ERROR_SET(pRequest, mApiError, oidPrefixEnum) \
       (pRequest)->error = (int)mApiError; \
       (pRequest)->errorObjIndex = (ushort_t)oidPrefixEnum;

#define OSPF_MIB_EXCEPTION_SET( pObject, mApiException ) \
       (pObject)->exception = mApiException;


/****************************************************************************************
* Management Interface Public Function Prototypes
*/

/* OSPF MIB API init/destroy routines */
IMPORT STATUS ospfMapiInit( NVRAM_SAVE_FUNCPTR nvramSaveRtn,
                            NVRAM_DELETE_FUNCPTR nvramDelRtn,
                            NVRAM_RETRIEVE_FUNCPTR nvramRetrieveRtn
                          );

IMPORT STATUS ospfMapiDestroy( void );
IMPORT BOOL ospfMapiIsInited( void );

/* prototype for retrieving an instance of columnar object from the OSPF-MIB */

/* ospfGeneralGroup GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetGenGroup(mApiRequest_t *pRequest, mApiReqType_t reqType);
IMPORT STATUS ospfMapiSetGenGroup(mApiRequest_t *pRequest, mApiReqType_t reqType);

/* ospfAreaTable GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetArea(mApiRequest_t *pRequest, mApiReqType_t reqType);
IMPORT STATUS ospfMapiSetArea(mApiRequest_t *pRequest, mApiReqType_t reqType);

/* ospfStubTable GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetStub( mApiRequest_t *pRequest, mApiReqType_t reqType );
IMPORT STATUS ospfMapiSetStub( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* ospfLsdbTable GET/GET_NEXT routine */
IMPORT STATUS ospfMapiGetLsdb(mApiRequest_t *pRequest, mApiReqType_t reqType);

/* ospfHostTable GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetHost( mApiRequest_t *pRequest, mApiReqType_t reqType );
IMPORT STATUS ospfMapiSetHost( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* ospfIfTable GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetIf(mApiRequest_t *pRequest, mApiReqType_t reqType);
IMPORT STATUS ospfMapiSetIf( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* ospfIfMetricTable GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetIfMetric( mApiRequest_t *pRequest, mApiReqType_t reqType );
IMPORT STATUS ospfMapiSetIfMetric( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* ospfVirtIfTable GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetVirtIf(mApiRequest_t *pRequest, mApiReqType_t reqType);
IMPORT STATUS ospfMapiSetVirtIf( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* ospfNbrTable GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetNbr(mApiRequest_t *pRequest, mApiReqType_t reqType);
IMPORT STATUS ospfMapiSetNbr( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* ospfVirtNbrTable GET/GET_NEXT routine */
IMPORT STATUS ospfMapiGetVirtNbr( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* ospfExtLsdbTable GET/GET_NEXT routine */
IMPORT STATUS ospfMapiGetExtLsdb(mApiRequest_t *pRequest, mApiReqType_t reqType);

/* ospfAreaAggregateTable GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetAreaAggregate( mApiRequest_t *pRequest, mApiReqType_t reqType);
IMPORT STATUS ospfMapiSetAreaAggregate( mApiRequest_t *pRequest, mApiReqType_t reqType);

/* wrnOspfGeneralGroup GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetWrnGenGroup( mApiRequest_t *pRequest, mApiReqType_t reqType );
IMPORT STATUS ospfMapiSetWrnGenGroup( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* wrnOspfAreaTable GET/GET_NEXT routine */
IMPORT STATUS ospfMapiGetWrnArea( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* wrnOspfLsdbTable GET/GET_NEXT routine */
IMPORT STATUS ospfMapiGetWrnLsdb(mApiRequest_t *pRequest, mApiReqType_t reqType);

/* wrnOspfLocalLsdbTable GET/GET_NEXT routine */
IMPORT STATUS ospfMapiGetWrnLocalLsdb( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* wrnOspfExtLsdbTable GET/GET_NEXT routine */
IMPORT STATUS ospfMapiGetWrnExtLsdb( mApiRequest_t *pRequest, mApiReqType_t reqType );

/* wrnOspfIFTable GET/GET_NEXT and TEST/COMMIT routines */
IMPORT STATUS ospfMapiGetWrnIf( mApiRequest_t *pRequest, mApiReqType_t reqType );
IMPORT STATUS ospfMapiSetWrnIf( mApiRequest_t *pRequest, mApiReqType_t reqType );     


/* misc conversions routines */
IMPORT STATUS ospf_rs2mApi_errorGet( void *pObjInfo, int rsError );
IMPORT STATUS ospf_rs2mApi_reqTypeGet( int rsRequest, mApiReqType_t *mApiReqType);
IMPORT void ospf_mApi_ipAddr2OctetString( ulong_t ipAddr, uchar_t *octetString );
IMPORT ulong_t ospf_mApi_octetString2IpAddr( uchar_t *octetString );
IMPORT void ospf_mApi_ipAddr2IpIndex( ulong_t ulIpAddr, ulong_t *pIndex );
IMPORT ulong_t ospf_mApi_ipIndex2IpAddr( ulong_t *pIndex );

/* prototype for OSPF MIB API helper wrapper routine to handle the SET operation */
IMPORT STATUS ospfMapiSetHelper();

#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __INCospf_mib_apih */