ospf_mib_helper.h

vxworks下ospf协议栈

/* ospf_mib_helper.h - header file for OSPF-MIB Helper Module */

/* Copyright 1998-2003 Wind River Systems, Inc. */

/* 
modification history
--------------------
02l,09may03,kc  Fixed SPR#88389 - added ospfExtLsdbProtoId to mApiOspfExtLsdb_t.
02k,07feb03,kc  Fixed SPR#86144 - removed the mApiReqType_t argument from all the
                ospf_mApi_xxxHelperCreate() prototypes.
02j,19nov02,mwv Merge TMS code SPR 84284
02i,12nov02,kc  Added ospf_mApi_nbrHelperDeregister() prototype.
02h,14apr02,kc  Renamed EmapiOspfAuthType_simplePasswd mApiOspfAuthType_t to
                EmApiOspfAuthType_simplePasswd.
02g,11apr02,kc  Added ospf_mApi_ifHelperDelete() and ospf_mApi_areaHelperRegisterIf()
                prototypes.
02f,10apr02,kc  Added ospf_mApi_avlTreeWalk() prototype and AVL_WALK_FUNC typdedef.
02e,06apr02,kc  Added sysIfName, sysIfIndex and sysIfFlags members to mApiOspfIf_t
                structure.
02d,28mar02,kc  Added oldStatus member to mApiOspfClient_t structure. Also added
                numIfAttached, numVirtIfAttached and numHostAttached members to
                mApiOspfArea_t structure.
02c,27mar02,kc  Changed the createdAs variable type from mApiOspfRowStatus_t to
                rsAction_t.
02b,22mar02,kc  Removed ospf_mApi_initBackbone() prototype.
02a,09jan02,kc  Added host netmask define.
01z,14dec01,kc  Added resetAllToDefault boolean flag argument to 
                ospf_mApi_initGeneralGroup(). Also added prototype for 
                ospf_mApi_reset().
01y,12dec01,kc  Added defaultStubMetric to mApiOspfArea_t and defined WindNet OSPF
                specific DEFVAL_mApiOspfMetric.
01x,03dec01,kc  Redefined ospfVirtNbrTable OID instance length.
01w,29nov01,kc  For consistency, renamed OSPF_AREA_AGGREGATE_TABLE_LEN define to 
                OSPF_AREA_AGGREGATE_INSTANCE_LEN.
01v,28nov01,kc  Changed ospfLsdbAdvertisement and ospfExtLsdbAdvertisement from
                uchar_t to char.
01u,23oct01,kc  Changed ospfLsdbAge, ospfLsdbChecksum, ospfExtLsdbAge, and
                ospfExtLsdbChecksum from ushort_t to ulong_t.
01t,21oct01,kc  Added ospf_mApi_configurationGet() prototype.
01s,20oct01,kc  Added Area Aggregation related prototypes and mApiOspfClient_t.
01r,18oct01,kc  Modified arguments for ospfMapiOidCompare() prototype.
01q,14oct01,kc  Added createdAs member to mApiOspfArea_t, mApiOspfStub_t, mApiOspfIf_t,
                mApiOspfIfMetric_t, mApiOspfVirtIf_t and mApiOspfNbr_t to remove the 
                chicken and egg problem.
01p,14oct01,kc  Added ospf_mApi_nbrHelperRegister() prototype.
01o,13oct01,kc  Added defaultMtu, defaultNetmask and defaultMetric to mApiOspfHost_t.
01n,13oct01,kc  Added pointer to Type-10 Opaque LSA Area to mApiOspfArea_t.
01m,11oct01,kc  Added mApiOspfClientType_t and mApiOspfClient_t (moved from 
                ospf_mib_api.h).
01l,11oct01,kc  Changed isTransitArea in mApiOspfArea_t from BOOL to TrueValue type.
01k,10oct01,kc  Added ospf_mApi_nbrHelperSet() prototype.
01j,08oct01,kc  Added ospfMapiOidCompare() prototype.
01i,06oct01,kc  Added netmask, mtu and default metric to mApiOspfIf_t structure.
01h,05oct01,kc  Added ospf_mApi_hostHelperCreate prototype.
01g,04oct01,kc  Added ospf_mApi_xxxHelperCreate() prototypes for area, stub area,
                interface and virtual interface.
01f,18sep01,kc  Changed ospfVirtIfRetransInterval, ospfNbrPriority to ulong_t.
01e,14sep01,kc  Added default mtu, netmask and metric to mApiOspfIf_t structure.
01d,12sep01,kc  Added listIfAttached to mApiOspfArea_t structure. Also added 
                listNbrAttached to mApiOspfIf_t structure.
01c,28aug01,kc  Added prototypes for TEST/SET routines.
01b,22aug01,kc  Added prototypes for GET routines.
01a,16aug01,kc  Initial file creation.
*/

/*
DESCRIPTION:

This file defines the RFC1850 MIB specific Manamgenet Interface Local ID enumerations, 
the MIB object enumerations, the MIB object sizes and some MIB API helper function
prototypes.

*/
 
#ifndef __INCospf_mib_helperh
#define __INCospf_mib_helperh

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */




/***************************************************************************************
 * Management Interface RFC1850 MIB Definitions
 */

/* OSPF Version Number */
#define OSPF_VERSION             2

/* OSPF Area Backbone, ospfAreaId = 0.0.0.0 */
#define OSPF_BACKBONE_AREA       00000000L

/* NOTE: This is an internal define for Virtual Interface, shall not be used by 
 *       application utilizing the MIB API
 */
#define OSPF_VIRTUAL_IF_TYPE      100

 
#define MIN_OSPF_EXT_LSDB_LIMIT               -1L        
#define MAX_OSPF_EXT_LSDB_LIMIT               2147483647L
#define MAX_OSPF_EXIT_OVERFLOW_INTERVAL       2147483647L
#define MAX_OSPF_STUB_METRIC                  16777215L
#define MIN_OSPF_LSDB_SIZE                    1L
#define MAX_OSPF_LSDB_SIZE                    65535L
#define MAX_OSPF_PRIORITY                     255L
#define MAX_OSPF_POLL_INTERVAL                2147483647L
#define MAX_OSPF_AGE                          3600L
#define MIN_OSPF_HELLO_INTERVAL               1L           
#define MAX_OSPF_HELLO_INTERVAL               65535L       
#define MAX_OSPF_DEAD_INTERVAL                2147483647L 
#define MAX_OSPF_AUTH_KEY                     256L         
#define MAX_OSPF_METRIC_VALUE                 65535L
#define MAX_EXTERNAL_LSDB_SIZE                36L

#define OSPF_AUTH_SIMPLE_SIZE                  8
#define OSPF_AUTH_MD5_SIZE                     16

/* RFC1850 MIB default value */
#define DEFVAL_mApiOspfExtLsdbLimit            -1L
#define DEFVAL_mApiOspfExitOverflowInterval    0

#define DEFVAL_mApiOspfIfRtrPriority           1
#define DEFVAL_mApiOspfIfTransitDelay          1
#define DEFVAL_mApiOspfIfRetransInterval       5
#define DEFVAL_mApiOspfIfHelloInterval         10
#define DEFVAL_mApiOspfIfRtrDeadInterval       40
#define DEFVAL_mApiOspfIfPollInterval          120

#define DEFVAL_mApiOspfVirtIfTransitDelay      1
#define DEFVAL_mApiOspfVirtIfRetransInterval   5
#define DEFVAL_mApiOspfVirtIfHelloInterval     10
#define DEFVAL_mApiOspfVirtIfRtrDeadInterval   60
            
#define DEFVAL_mApiHostNetMask                 0xFFFFFFFF

/* WindNet OSPF default value */
#define DEFVAL_mApiOspfIfType                 EmApiOspfIfType_broadcast
#define DEFVAL_mApiOspfMetric                  1


/* the following defines provides the number of sub-identifier (the instance length)
 * of each table in RFC1850 MIB  
 */
#define OSPF_AREA_INSTANCE_LEN                  4
#define OSPF_STUB_INSTANCE_LEN                  5
#define OSPF_LSDB_INSTANCE_LEN                  13
#define OSPF_HOST_INSTANCE_LEN                  5
#define OSPF_INTF_INSTANCE_LEN                  5
#define OSPF_METRIC_INSTANCE_LEN                6
#define OSPF_VIRT_INTF_INSTANCE_LEN             8
#define OSPF_NBR_INSTANCE_LEN                   5
#define OSPF_VIRT_NBR_INSTANCE_LEN              8
#define OSPF_EXT_LSDB_INSTANCE_LEN              9
#define OSPF_AREA_AGGREGATE_INSTANCE_LEN        13


/****************************************************************************************
* Management Interface 1-based local ID enumerations for RFC1850 MIB.
*/
typedef enum {
    mApiOspfRouterId = 1,
    mApiOspfAdminStat,
    mApiOspfVersionNumber,         
    mApiOspfAreaBdrRtrStatus,     
    mApiOspfASBdrRtrStatus,
    mApiOspfExternLsaCount,         
    mApiOspfExternLsaCksumSum,       
    mApiOspfTOSSupport,
    mApiOspfOriginateNewLsas,       
    mApiOspfRxNewLsas, 
    mApiOspfExtLsdbLimit,
    mApiOspfMulticastExtensions,
    mApiOspfExitOverflowInterval,
    mApiOspfDemandExtensions,
    mApiOspfAreaId,                        /* mApiOspf_t enumeration value = 15 */
    mApiOspfAuthType,
    mApiOspfImportAsExtern,
    mApiOspfSpfRuns,
    mApiOspfAreaBdrRtrCount,
    mApiOspfAsBdrRtrCount,
    mApiOspfAreaLsaCount,
    mApiOspfAreaLsaCksumSum,
    mApiOspfAreaSummary,
    mApiOspfAreaStatus,
    mApiOspfStubAreaId,                    /* mApiOspf_t enumeration value = 25 */
    mApiOspfStubTOS,
    mApiOspfStubMetric,
    mApiOspfStubStatus,
    mApiOspfStubMetricType,
    mApiOspfLsdbAreaId,                    /* mApiOspf_t enumeration value = 30 */
    mApiOspfLsdbType,
    mApiOspfLsdbLsid,
    mApiOspfLsdbRouterId,
    mApiOspfLsdbSequence,
    mApiOspfLsdbAge,
    mApiOspfLsdbChecksum,
    mApiOspfLsdbAdvertisement,
    mApiOspfAreaRangeAreaId,               /* mApiOspf_t enumeration value = 38 */
    mApiOspfAreaRangeNet,
    mApiOspfAreaRangeMask,
    mApiOspfAreaRangeStatus,
    mApiOspfAreaRangeEffect,
    mApiOspfHostIpAddress,                 /* mApiOspf_t enumeration value = 43 */
    mApiOspfHostTOS,
    mApiOspfHostMetric,
    mApiOspfHostStatus,
    mApiOspfHostAreaID,
    mApiOspfIfIpAddress,                   /* mApiOspf_t enumeration value = 48 */
    mApiOspfAddressLessIf,
    mApiOspfIfAreaId,
    mApiOspfIfType,
    mApiOspfIfAdminStat,
    mApiOspfIfRtrPriority,
    mApiOspfIfTransitDelay,
    mApiOspfIfRetransInterval,
    mApiOspfIfHelloInterval,
    mApiOspfIfRtrDeadInterval,
    mApiOspfIfPollInterval,
    mApiOspfIfState,
    mApiOspfIfDesignatedRouter,
    mApiOspfIfBackupDesignatedRouter,
    mApiOspfIfEvents,
    mApiOspfIfAuthKey,
    mApiOspfIfStatus,
    mApiOspfIfMulticastForwarding,
    mApiOspfIfDemand,
    mApiOspfIfAuthType,
    mApiOspfIfMetricIpAddress,             /* mApiOspf_t enumeration value =68 */
    mApiOspfIfMetricAddressLessIf,
    mApiOspfIfMetricTOS,
    mApiOspfIfMetricValue,
    mApiOspfIfMetricStatus,
    mApiOspfVirtIfAreaId,                  /* mApiOspf_t enumeration value = 73 */
    mApiOspfVirtIfNeighbor,
    mApiOspfVirtIfTransitDelay,
    mApiOspfVirtIfRetransInterval,
    mApiOspfVirtIfHelloInterval,
    mApiOspfVirtIfRtrDeadInterval,
    mApiOspfVirtIfState,
    mApiOspfVirtIfEvents,
    mApiOspfVirtIfAuthKey,
    mApiOspfVirtIfStatus,
    mApiOspfVirtIfAuthType,
    mApiOspfNbrIpAddr,                     /* mApiOspf_t enumeration value = 84 */
    mApiOspfNbrAddressLessIndex,
    mApiOspfNbrRtrId,
    mApiOspfNbrOptions,
    mApiOspfNbrPriority,
    mApiOspfNbrState,
    mApiOspfNbrEvents,
    mApiOspfNbrLsRetransQLen,
    mApiOspfNbmaNbrStatus,
    mApiOspfNbmaNbrPermanence,
    mApiOspfNbrHelloSuppressed,
    mApiOspfVirtNbrArea,                   /* mApiOspf_t enumeration value = 95 */
    mApiOspfVirtNbrRtrId,
    mApiOspfVirtNbrIpAddr,
    mApiOspfVirtNbrOptions,
    mApiOspfVirtNbrState,
    mApiOspfVirtNbrEvents,
    mApiOspfVirtNbrLsRetransQLen,
    mApiOspfVirtNbrHelloSuppressed,
    mApiOspfExtLsdbType,                   /* mApiOspf_t enumeration value = 103 */
    mApiOspfExtLsdbLsid,
    mApiOspfExtLsdbRouterId,
    mApiOspfExtLsdbSequence,
    mApiOspfExtLsdbAge,