ospf_mib_helper.h

vxworks下ospf协议栈

    ulong_t              ospfHostMetric;        /* read-create */
    mApiOspfRowStatus_t  ospfHostStatus;        /* read-create */
    ulong_t              ospfHostAreaId;        /* read-only */
} mApiOspfHost_t;

/* objects associate with the ospfIfMetricTable */
typedef struct mApiOspfIfMetric
{
    AVL_NODE             node;            /* AVL Tree node */
    void                 *pIf;            /* interface associated with this metric */
    rsAction_t           createdAs;       /* the method this row is created */

    ulong_t              ospfIfMetricIpAddress;        /* index object, read-only */
    ulong_t              ospfIfMetricAddressLessIf;    /* index object, read-only */
    ulong_t              ospfIfMetricTOS;              /* index object, read-only */
    ulong_t              ospfIfMetricValue;            /* read-create */
    mApiOspfRowStatus_t  ospfIfMetricStatus;           /* read-create */
} mApiOspfIfMetric_t;

typedef struct mApiOspfCryptKey
{
    uchar_t       authKeyId;
    uchar_t       authKey[OSPF_AUTH_MD5_SIZE+1];
    uchar_t       authLen;  /* md5 authKey length, not including the key id */
} mApiOspfCryptKey_t;


/* objects associate with the ospfIfTable */
typedef struct mApiOspfIf
{
    AVL_NODE      node;              /* AVL Tree node */
    LIST          listNbrAttached;   /* neighbors attached to this interface, unsorted */
    ushort_t      numNbrAttached;    /* number of neighbors attached to this interface */
    ulong_t       defaultMtu;        /* default mtu from in_ifaddr structure */
    ulong_t       defaultNetmask;    /* default netmask from in_ifaddr structure */
    ulong_t       defaultMetric;     /* default metric from in_ifaddr structure */
    rsAction_t    createdAs;         /* the method this row is created */

    void          *pIfMetric;        /* metric associate with this interface */
    void          *pArea;            /* pointer to area this interface connects */
    char          sysIfName[IFNAMSIZ];  /* interface name, e.g. `en'' or ``lo'' */
    ushort_t      sysIfIndex;        /* numeric abbreviation for this interface */
    int           sysIfFlags;        /* interface flags */

    ulong_t              ospfIfIpAddress;               /* index object, read-only */
    ulong_t              ospfAddressLessIf;             /* index object, read-only */
    ulong_t              ospfIfAreaId;                  /* read-create */
    mApiOspfIfType_t     ospfIfType;                    /* read-create */
    mApiOspfStatus_t     ospfIfAdminStat;               /* read-create */
    ulong_t              ospfIfRtrPriority;             /* read-create */
    ulong_t              ospfIfTransitDelay;            /* read-create */
    ulong_t              ospfIfRetransInterval;         /* read-create */
    ulong_t              ospfIfHelloInterval;           /* read-create */
    ulong_t              ospfIfRtrDeadInterval;         /* read-create */
    ulong_t              ospfIfPollInterval;            /* read-create */
    mApiOspfIfState_t    ospfIfState;                   /* read-only */
    ulong_t              ospfIfDesignatedRouter;        /* read-only */
    ulong_t              ospfIfBackupDesignatedRouter;  /* read-only */
    ulong_t              ospfIfEvents;                  /* read-only */
    mApiOspfAuthType_t   ospfIfAuthType;                /* read-create */
    mApiOspfRowStatus_t  ospfIfStatus;                  /* read-create */
    
    /* read-create ospfIfAuthKey */
    uchar_t              ospfIfSimpleAuthKey[OSPF_AUTH_SIMPLE_SIZE +1]; 
    mApiOspfCryptKey_t   ospfIfMd5AuthKey;
    ulong_t              authKeyLen;  /* simple authKey length, not a MIB object */

    /* the following read-create objects are implemented as read-only */
    mApiOspfIfMcastType_t  ospfIfMulticastForwarding;
    mApiOspfTrueValue_t    ospfIfDemand;      
} mApiOspfIf_t;

/* objects associate with the ospfVirtIfTable */
typedef struct mApiOspfVirtIf
{
    AVL_NODE               node;                 /* AVL Tree node */
    void                   *pArea;               /* pointer to transit area */
    rsAction_t             createdAs;            /* the method this row is created */

    ulong_t                ospfVirtIfAreaId;            /* index object, read-only */
    ulong_t                ospfVirtIfNeighbor;          /* index object, read-only */
    ulong_t                ospfVirtIfTransitDelay;      /* read-create */
    ulong_t                ospfVirtIfRetransInterval;   /* read-create */
    ulong_t                ospfVirtIfHelloInterval;     /* read-create */
    ulong_t                ospfVirtIfRtrDeadInterval;   /* read-create */
    mApiOspfVirtIfState_t  ospfVirtIfState;             /* read-only */
    ulong_t                ospfVirtIfEvents;            /* read-only */
    mApiOspfAuthType_t     ospfVirtIfAuthType;          /* read-create */
    mApiOspfRowStatus_t    ospfVirtIfStatus;            /* read-create */

    /* read-create ospfVirtIfAuthKey */
    uchar_t                ospfVirtIfSimpleAuthKey[OSPF_AUTH_SIMPLE_SIZE+1]; 
    mApiOspfCryptKey_t     ospfVirtIfMd5AuthKey;
    ulong_t                authKeyLen;  /* simple authKey length, not a MIB object */
} mApiOspfVirtIf_t;


/* objects associate with the ospfNbrTable */
typedef struct mApiOspfNbr
{
    AVL_NODE               node;            /* AVL Tree node */
    void                   *pIf;            /* interface associated with */
    rsAction_t             createdAs;       /* the method this row is created */

    ulong_t                ospfNbrIpAddr;            /* index object, read-only */
    ulong_t                ospfNbrAddressLessIndex;  /* index object, read-only */
    ulong_t                ospfNbrRtrId;             /* read-only */
    ulong_t                ospfNbrOptions;           /* read-only */
    ulong_t                ospfNbrPriority;          /* read-create */
    mApiOspfNbrState_t     ospfNbrState;             /* read-only */
    ulong_t                ospfNbrEvents;            /* read-only */
    ulong_t                ospfNbrLsRetransQLen;     /* read-only */
    mApiOspfRowStatus_t    ospfNbmaNbrStatus;        /* read-create */
    mApiOspfNbmaNbrPermanence_t  ospfNbmaNbrPermanence;    /* read-only */
    mApiOspfTrueValue_t     ospfNbrHelloSuppressed;   /* read-only */
} mApiOspfNbr_t;

/* objects associate with the ospfVirtNbrTable */
typedef struct mApiOspfVirtNbr
{
    AVL_NODE             node;                         /* AVL Tree node */
    ulong_t              ospfVirtNbrArea;              /* index object, read-only */
    ulong_t              ospfVirtNbrRtrId;             /* index object, read-only */
    ulong_t              ospfVirtNbrIpAddr;            /* read-only */
    ulong_t              ospfVirtNbrOptions;           /* read-only */
    mApiOspfNbrState_t   ospfVirtNbrState;             /* read-only */
    ulong_t              ospfVirtNbrEvents;            /* read-only */
    ulong_t              ospfVirtNbrLsRetransQLen;     /* read-only */
    mApiOspfTrueValue_t  ospfVirtNbrHelloSuppressed;   /* read-only */
} mApiOspfVirtNbr_t;

/* objects associate with the ospfExtLsdbTable */
typedef struct mApiOspfExtLsdb
{
    AVL_NODE               node;                        /* AVL Tree node */
    mApiOspfExtLsdbType_t  ospfExtLsdbType;             /* index object, read-only */
    ulong_t                ospfExtLsdbLsid;             /* index object, read-only */
    ulong_t                ospfExtLsdbRouterId;         /* index object, read-only */
    ulong_t                ospfExtLsdbSequence;         /* read-only */
    ulong_t                ospfExtLsdbAge;              /* read-only */
    ulong_t                ospfExtLsdbChecksum;         /* read-only */
    ulong_t                ospfExtLsdbProtoId;          /* route protocol ID, interanl use */
    char                   ospfExtLsdbAdvertisement[MAX_EXTERNAL_LSDB_SIZE];   /* read-only */
    ushort_t               lsdbLen;   /* length of ospfExtLsdbAdvertisement */
} mApiOspfExtLsdb_t;

/* objects associate with the ospfAreaAggregateTable */
typedef struct mApiOspfAreaAggregate
{
    AVL_NODE                     node;            /* AVL Tree node */
    void                         *pArea;          /* area associated with */
    rsAction_t                   createdAs;       /* the method this row is created */

    ulong_t                      ospfAreaAggregateAreaID;   /* index object, read-only */
    mApiOspfAggregateLsdbType_t  ospfAreaAggregateLsdbType; /* index object, read-only */
    ulong_t                      ospfAreaAggregateNet;      /* index object, read-only */
    ulong_t                      ospfAreaAggregateMask;     /* index object, read-only */
    mApiOspfRowStatus_t          ospfAreaAggregateStatus;   /* read-create */
    mApiOspfAggregateEffect_t    ospfAreaAggregateEffect;   /* read-create */
} mApiOspfAreaAggregate_t;


/* function pointer requires by ospf_mApi_avlTreeWalk() routine */
typedef STATUS (* AVL_WALK_FUNC)(void *pNode, void *arg);

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

/* ospfGeneralGroup helper routines */
IMPORT STATUS ospf_mApi_globalParmGet(mApiOspfGenGroup_t *thisGenGroup, 
                                       mApiRequest_t *pRequest, mApiObject_t *pObject);
IMPORT STATUS ospf_mApi_globalParmSet(mApiRequest_t *pRequest, mApiObject_t *pObject,
                                       mApiReqType_t reqType);

/* ospfAreaTable helper routines */
IMPORT STATUS ospf_mApi_areaHelperGet( void *pRow, mApiRequest_t *pRequest,
                                       mApiObject_t *pObject );
IMPORT STATUS ospf_mApi_areaHelperSet(mApiRequest_t *pRequest, rsRequest_t rsReqType );
IMPORT STATUS ospf_mApi_areaHelperRegisterIf( mApiOspfIf_t *pIf, int oldStatus );

/* ospfStubTable helper routines */
IMPORT STATUS ospf_mApi_stubHelperGet( void *pRow, mApiRequest_t *pRequest,
                                       mApiObject_t *pObject );
IMPORT STATUS ospf_mApi_stubHelperSet( mApiRequest_t *pRequest, rsRequest_t rsReqType );

/* ospfLasbTable helper routine */
IMPORT STATUS ospf_mApi_lsdbHelperGet( void *pRow, mApiRequest_t *pRequest,
                                       mApiObject_t *pObject );

/* ospfHostTable helper functions */
IMPORT STATUS ospf_mApi_hostHelperGet( void *pRow, mApiRequest_t *pRequest,
                                       mApiObject_t *pObject );
IMPORT STATUS ospf_mApi_hostHelperSet( mApiRequest_t *pRequest, rsRequest_t rsReqType );

/* ospfIfTable helper routines */
IMPORT STATUS ospf_mApi_ifHelperGet( void *pRow, mApiRequest_t *pRequest,
                                     mApiObject_t *pObject );
IMPORT STATUS ospf_mApi_ifHelperSet(mApiRequest_t *pRequest, rsRequest_t rsReqType );
IMPORT void ospf_mApi_ifHelperDelete( ulong_t ospfIfIpAddr, ulong_t ospfAddrLessIf );

/* ospfIfMetricTable helper functions */
IMPORT STATUS ospf_mApi_ifMetricHelperGet( void *pRow, mApiRequest_t *pRequest,
                                           mApiObject_t *pObject );
IMPORT STATUS ospf_mApi_ifMetricHelperSet( mApiRequest_t *pRequest, rsRequest_t rsReqType );

/* ospfVirtIfTable helper routines */
IMPORT STATUS ospf_mApi_virtIfHelperGet( void *pRow, mApiRequest_t *pRequest,
                                         mApiObject_t *pObject );
IMPORT STATUS ospf_mApi_virtIfHelperSet( mApiRequest_t *pRequest, rsRequest_t rsReqType );

/* ospfNbrTable helper routines */
IMPORT STATUS ospf_mApi_nbrHelperGet( void *pRow, mApiRequest_t *pRequest,
                                      mApiObject_t *pObject );
IMPORT STATUS ospf_mApi_nbrHelperSet( mApiRequest_t *pRequest, rsRequest_t rsReqType );
IMPORT STATUS ospf_mApi_nbrHelperRegister( mApiOspfNbr_t *pNbr, ulong_t ifIpAddress, 
                                           ulong_t ifIndex );
IMPORT void ospf_mApi_nbrHelperDeregister( mApiOspfNbr_t *pNbr, ulong_t ifIpAddress,
                                           ulong_t ifIndex );

/* ospfVirtNbrTable helper routines */
IMPORT STATUS ospf_mApi_virtNbrHelperGet( void *pRow, mApiRequest_t *pRequest,
                                          mApiObject_t *pObject );

/* ospfExtLsdbTable helper routines */
IMPORT STATUS ospf_mApi_extLsdbHelperGet(void *pRow, mApiRequest_t *pRequest, 
                                         mApiObject_t *pObject);

/* ospfAreaAggregateTable helper routines */
IMPORT STATUS ospf_mApi_areaAggregateHelperGet( void *pRow, mApiRequest_t *pRequest,
                                                mApiObject_t *pObject );
IMPORT STATUS ospf_mApi_areaAggregateHelperSet( mApiRequest_t *pRequest, 
                                                rsRequest_t rsReqType );

/* common AVL compare routine */
IMPORT int ospfMapiOidCompare( int oidLength, ulong_t *pOid1, ulong_t *pOid2 );

/* misc AVL routines */
IMPORT STATUS ospf_mApi_avlTreeWalk( AVL_TREE * pRoot, AVL_WALK_FUNC ospfMapiTreeWalk,
                                     void *arg );

/* rfc1850-specific helper initialization routine */
IMPORT STATUS ospf_mApi_configurationGet( void );
IMPORT void ospf_mApi_reset( void );
IMPORT void ospf_mApi_initGeneralGroup( BOOL resetAllToDefault );
IMPORT STATUS ospf_mApi_initRsLib(void);
IMPORT STATUS ospf_mApi_initAvlTree(void);

/***************************************************************************************
 * Function Prototypes for Management Interface for Public Routines that will
 * eventually be obsoleted. Third party applications that needs to integrate to 
 * MIB API must not use the following routines.
 */
IMPORT void ospf_mApi_areaHelperCreate( mApiOspfArea_t *pStaticArea );
IMPORT void ospf_mApi_stubHelperCreate( mApiOspfStub_t *pStaticStub );
IMPORT void ospf_mApi_hostHelperCreate( mApiOspfHost_t *pStaticHost );
IMPORT void ospf_mApi_ifHelperCreate( mApiOspfIf_t *pStaticIf );
IMPORT void ospf_mApi_ifMetricHelperCreate( mApiOspfIfMetric_t *pStaticIfm );
IMPORT void ospf_mApi_virtIfHelperCreate( mApiOspfVirtIf_t *pStaticVirtIf ); 
IMPORT void ospf_mApi_areaAggregateHelperCreate( mApiOspfAreaAggregate_t *pStaticAreaAg );

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* __INCospf_mib_helperh */