openapi_ip6map.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***********************************************************************
*
* @filename  openapi_ip6map.h
*
* @purpose   This code implements the OpEN IP6MAP API
*
* @component OPEN
*
* @create    01/10/2023
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_IP6MAP_H_INCLUDED
#define OPENAPI_IP6MAP_H_INCLUDED

#include "openapi_common.h"
#include "openapi_routing.h"
#include "openapi_mpls.h"
#include "openapi_routing_config.h"

#define OPEN_RTR6_MAX_INTF_ADDRS         4
#define OPEN_IP6_ND_DAD_ATTEMPTS_MAX     600
#define OPEN_IP6_NDNS_INTERVAL_MIN       1000
#define OPEN_IP6_NDNS_INTERVAL_MAX       4294967295U
#define OPEN_IP6_ND_REACHABLE_MAX        3600000UL

typedef struct
{
  uint64_t  ipv6IfIcmpInMsgs;
  uint64_t  ipv6IfIcmpInErrors;
  uint64_t  ipv6IfIcmpInDestUnreachs;
  uint64_t  ipv6IfIcmpInAdminProhibs;
  uint64_t  ipv6IfIcmpInTimeExcds;
  uint64_t  ipv6IfIcmpInParmProblems;
  uint64_t  ipv6IfIcmpInPktTooBigs;
  uint64_t  ipv6IfIcmpInEchos;
  uint64_t  ipv6IfIcmpInEchoReplies;
  uint64_t  ipv6IfIcmpInRouterSolicits;
  uint64_t  ipv6IfIcmpInRouterAdvertisements;
  uint64_t  ipv6IfIcmpInNeighborSolicits;
  uint64_t  ipv6IfIcmpInNeighborAdvertisements;
  uint64_t  ipv6IfIcmpInRedirects;
  uint64_t  ipv6IfIcmpInGroupMembQueries;
  uint64_t  ipv6IfIcmpInGroupMembResponses;
  uint64_t  ipv6IfIcmpInGroupMembReductions;

  uint64_t  ipv6IfIcmpOutMsgs;
  uint64_t  ipv6IfIcmpOutErrors;
  uint64_t  ipv6IfIcmpOutDestUnreachs;
  uint64_t  ipv6IfIcmpOutAdminProhibs;
  uint64_t  ipv6IfIcmpOutTimeExcds;
  uint64_t  ipv6IfIcmpOutParmProblems;
  uint64_t  ipv6IfIcmpOutPktTooBigs;
  uint64_t  ipv6IfIcmpOutEchos;
  uint64_t  ipv6IfIcmpOutEchoReplies;
  uint64_t  ipv6IfIcmpOutRouterSolicits;
  uint64_t  ipv6IfIcmpOutRouterAdvertisements;
  uint64_t  ipv6IfIcmpOutNeighborSolicits;
  uint64_t  ipv6IfIcmpOutNeighborAdvertisements;
  uint64_t  ipv6IfIcmpOutRedirects;
  uint64_t  ipv6IfIcmpOutGroupMembQueries;
  uint64_t  ipv6IfIcmpOutGroupMembResponses;
  uint64_t  ipv6IfIcmpOutGroupMembReductions;

  uint64_t  ipv6IfIcmpDupAddrDetects;

  uint64_t  ipv6IfIcmpInCsumErrors;
  uint64_t  ipv6IfIcmpInMLDv2Reports;
  uint64_t  ipv6IfIcmpOutMLDv2Reports;
  uint64_t  ipv6IfIcmpInType134;
  uint64_t  ipv6IfIcmpInType135;
  uint64_t  ipv6IfIcmpInType136;
  uint64_t  ipv6IfIcmpOutType1;
  uint64_t  ipv6IfIcmpOutType133;
  uint64_t  ipv6IfIcmpOutType135;
  uint64_t  ipv6IfIcmpOutType136;
  uint64_t  ipv6IfIcmpOutType143;

} openapiIpstkIpv6IfIcmpStats_t;

typedef struct
{
  uint64_t  ipv6IfStatsInReceives;
  uint64_t  ipv6IfStatsInMcastPkts;
  uint64_t  ipv6IfStatsInDelivers;
  uint64_t  ipv6IfStatsInUnknownProtos;
  uint64_t  ipv6IfStatsInAddrErrors;
  uint64_t  ipv6IfStatsInHdrErrors;
  uint64_t  ipv6IfStatsInNoRoutes;
  uint64_t  ipv6IfStatsInTooBigErrors;
  uint64_t  ipv6IfStatsInTruncatedPkts;
  uint64_t  ipv6IfStatsReasmReqds;
  uint64_t  ipv6IfStatsReasmOKs;
  uint64_t  ipv6IfStatsReasmFails;
  uint64_t  ipv6IfStatsInDiscards;

  uint64_t  ipv6IfStatsOutRequests;
  uint64_t  ipv6IfStatsOutMcastPkts;
  uint64_t  ipv6IfStatsOutForwDatagrams;
  uint64_t  ipv6IfStatsOutFragCreates;
  uint64_t  ipv6IfStatsOutFragOKs;
  uint64_t  ipv6IfStatsOutFragFails;
  uint64_t  ipv6IfStatsOutDiscards;

  uint64_t  ipv6IfStatsOutNoRoutes;
  uint64_t  ipv6IfStatsReasmTimeout;
  uint64_t  ipv6IfStatsInOctets;
  uint64_t  ipv6IfStatsOutOctets;
  uint64_t  ipv6IfStatsInMcastOctets;
  uint64_t  ipv6IfStatsOutMcastOctets;
  uint64_t  ipv6IfStatsInBcastOctets;
  uint64_t  ipv6IfStatsOutBcastOctets;
  uint64_t  ipv6IfStatsInNoECTPkts;
  uint64_t  ipv6IfStatsInECT1Pkts;
  uint64_t  ipv6IfStatsInECT0Pkts;
  uint64_t  ipv6IfStatsInCEPkts;
} openapiIpv6IfStats_t;


typedef struct openapiEqualCostPath6_s 
{
  open_in6_addr_t     ip6Addr;        
  uint32_t            intIfNum;       
  uint32_t            flags;          
  OPEN_MPLS_LABELS_t  mplsLabelStack; 
  uint32_t            updateTime;     
} openapiEqualCostPath6_t;

typedef struct openapiECMPRoute6_s
{
  openapiEqualCostPath6_t   equalCostPath[OPENR_PLAT_MAX_ECMP_NEXTHOPS]; 
  uint32_t                  numOfRoutes; 
} openapiECMPRoute6_t;

typedef struct openapiRoute6Entry_s
{
  open_in6_addr_t       ip6Addr;      
  int32_t               ip6PrefixLen; 
  uint32_t              vrfId;        
  uint32_t              protocol;     
  uint32_t              metric;       
  openapiECMPRoute6_t   ecmpRoutes;   
  uint32_t              flags;        
  uint8_t               pref;         
  uint32_t              updateTime;   
  uint32_t              tableId;      
  OPEN_BOOL_t           hwFailure;    
  uint32_t              seqNum;       
  OPEN_BOOL_t           ip_anycast;   
} openapiRoute6Entry_t;

typedef struct openapi_ip6_cfg_addr_list_s
{
  open_in6_addr_t ipAddrList[OPEN_RTR6_MAX_INTF_ADDRS];
  uint32_t        pLen[OPEN_RTR6_MAX_INTF_ADDRS];
  uint32_t        pEuiFlag[OPEN_RTR6_MAX_INTF_ADDRS];
} openapi_ip6_cfg_addr_list_t;

#define OPEN_RTR6_ADDR_LINK_LOCAL_ENA      0x01  
#define OPEN_RTR6_ADDR_EUI64               0x02  
#define OPEN_RTR6_ADDR_AUTOCONFIG_ENA      0x08  
#define OPEN_RTR6_ADDR_DHCP_ENA            0x10  
typedef enum openIp6IntfAddrStates {
  OPEN_IPV6_INTFADDR_INACTIVE = 1,   
  OPEN_IPV6_INTFADDR_TENTATIVE,      
  OPEN_IPV6_INTFADDR_ACTIVE,         
  OPEN_IPV6_INTFADDR_AUTOCONFIG,     
  OPEN_IPV6_INTFADDR_DHCP            
} OPEN_IPV6_INTFADDR_STATES;

typedef struct openapiIpv6AddrEntry_s
{
    uint32_t                   ipv6IfIndex;          
    open_in6_addr_t            ipv6Address;          
    uint32_t                   ipv6AddrPfxLength;    
    uint32_t                   ipv6AddrType;         
    uint32_t                   ipv6AddrAnycastFlag;  
    uint32_t                   ipv6AddrEui64Flag;    
    OPEN_IPV6_INTFADDR_STATES  ipv6AddrStatus;       
} openapiIpv6AddrEntry_t;

typedef struct openapiIpv6AddrPrefixEntry_s
{
    uint32_t          ipv6IfIndex;                          
    open_in6_addr_t   ipv6AddrPrefix;                       
    uint32_t          ipv6AddrPrefixLength;                 
    uint32_t          ipv6AddrPrefixOnLinkFlag;             
    uint32_t          ipv6AddrPrefixAutonomousFlag;         
    uint32_t          ipv6AddrPrefixAdvPreferredLifetime;   
    uint32_t          ipv6AddrPrefixAdvValidLifetime;       
} openapiIpv6AddrPrefixEntry_t;

typedef struct open_ipv6IntfAddr_s
{ 
    open_in6_addr_t             ipv6Addr;
    uint32_t                    ipv6PrefixLen;
    OPEN_IPV6_INTFADDR_STATES   ipv6AddrState;
} open_ipv6IntfAddr_t;

typedef struct openIpv6IntfAddrList_s
{
    open_ipv6IntfAddr_t   ipv6AddrList[OPEN_RTR6_MAX_INTF_ADDRS + 1]; 
} openIpv6IntfAddrList_t;

typedef struct openNullOid_s
{   
    uint32_t         len; 
    unsigned char    oid[2];
} openNullOid_t; 

typedef struct openIpv6RouteEntry_s
{   
    open_in6_addr_t  ipv6RouteDest;
    uint32_t         ipv6RoutePfxLength;
    uint32_t         ipv6RouteIndex;
    uint32_t         ipv6RouteIfIndex;             
    open_in6_addr_t  ipv6RouteNextHop;
    uint32_t         ipv6RouteType;
    uint32_t         ipv6RouteProtocol;
    uint32_t         ipv6RoutePolicy;
    uint32_t         ipv6RouteAge;
    uint32_t         ipv6RouteNextHopRDI;
    uint32_t         ipv6Metric;
    uint32_t         ipv6RouteWeight;
    openNullOid_t    ipv6RouteInfo;
    uint32_t         ipv6RouteValid;
    uint32_t         ipv6RouteProtocolType;
} openIpv6RouteEntry_t;


typedef enum
{
   OPEN_IP6_NBR_STATE_REACHABLE = 1,  
   OPEN_IP6_NBR_STATE_STALE,          
   OPEN_IP6_NBR_STATE_DELAY,          
   OPEN_IP6_NBR_STATE_PROBE,          
   OPEN_IP6_NBR_STATE_INCOMPLETE,     
   OPEN_IP6_NBR_STATE_UNKNOWN,        
   OPEN_IP6_NBR_STATE_UNREACHABLE,    
   OPEN_IP6_NBR_STATE_PERMANENT       
} OPEN_IP6_NBR_STATE_t;

typedef enum
{
   OPEN_IP6_NBR_TYPE_OTHER = 1, 
   OPEN_IP6_NBR_TYPE_DYNAMIC,   
   OPEN_IP6_NBR_TYPE_STATIC,    
   OPEN_IP6_NBR_TYPE_LOCAL      
} OPEN_IP6_NBR_TYPE_t;

/*************************************************************************/
open_error_t openapiIp6VrRtrAdminModeGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiIp6VrRtrAdminModeSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiIp6VrNbrsDynRenewGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiIp6VrNbrsDynRenewSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiIp6VrNudBackoffMultipleGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6VrNudBackoffMultipleSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val);

/*************************************************************************/
open_error_t openapiIp6VrNudMaxUnicastSolicitsGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6VrNudMaxUnicastSolicitsSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val);

/*************************************************************************/
open_error_t openapiIp6VrNudMaxMcastSolicitsGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6VrNudMaxMcastSolicitsSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val);

/*************************************************************************/
open_error_t openapiIp6UnresolvedRateLimitGet(openapiClientHandle_t *client_handle, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6UnresolvedRateLimitSet(openapiClientHandle_t *client_handle, uint32_t val);

/*************************************************************************/
open_error_t openapiIp6VrRtrDefaultTTLGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6VrRtrDefaultTTLSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t val);

/*************************************************************************/
open_error_t openapiIp6RtrIntfModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiIp6RtrIntfOperModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiIp6RtrIntfModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiIp6RtrIntfAutoStateModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiIp6RtrIntfAutoStateModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode);

/*************************************************************************/
OPEN_BOOL_t openapiIp6IntfExists(openapiClientHandle_t *client_handle, uint32_t ifNum);

/*************************************************************************/
OPEN_BOOL_t openapiIp6MapIntfIsValid(openapiClientHandle_t *client_handle, uint32_t ifNum);

/*************************************************************************/
OPEN_BOOL_t openapiIp6MapNbrIntfIsValid(openapiClientHandle_t *client_handle, uint32_t ifNum);

/*************************************************************************/
open_error_t openapiIp6RtrIntfIpv6MtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6RtrIntfIpv6EffectiveMtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6RtrIntfMaxIpv6MtuGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6RtrIntfIpv6MtuSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val);

/*************************************************************************/
open_error_t openapiIp6RtrIntfBandwidthGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6MapIntfValidFirstGet(openapiClientHandle_t *client_handle, uint32_t *ifNum);

/*************************************************************************/
open_error_t openapiIp6MapIntfValidNextGet(openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *ifNum);

/*************************************************************************/
open_error_t openapiIpv6IfStatsGet (openapiClientHandle_t *client_handle,
                                    uint32_t intIfNum,
                                    openapiIpv6IfStats_t *ipv6IfStats);

/*************************************************************************/
open_error_t openapiIpv6IfIcmpStatsGet (openapiClientHandle_t *client_handle,
                                        uint32_t intIfNum,
                                        openapiIpstkIpv6IfIcmpStats_t *ipv6IfIcmpStats);

/*************************************************************************/
open_error_t openapiIpv6IfStatsClear (openapiClientHandle_t *client_handle,
                                      uint32_t intIfNum);

/*************************************************************************/
open_error_t openapiIpv6TotalStatsGet (openapiClientHandle_t *client_handle,
                                       openapiIpv6IfStats_t *ipv6IfStats,
                                       openapiIpstkIpv6IfIcmpStats_t *ipv6IfIcmpStats);

/*************************************************************************/
open_error_t openapiIpv6TotalStatsClear (openapiClientHandle_t *client_handle);

/*************************************************************************/
open_error_t openapiIpv6RouteEntryGetNext (openapiClientHandle_t *client_handle,
                                           open_buffdesc *vrfName,
                                           openapiRoute6Entry_t *ipv6Route,
                                           OPEN_BOOL_t bestRouteOnly);

/*************************************************************************/
open_error_t openapiIpv6RouteCountGet (openapiClientHandle_t *client_handle,
                                       open_buffdesc *vrfName,
                                       uint32_t *count,
                                       OPEN_BOOL_t bestRouteOnly);

/*************************************************************************/
open_error_t openapiIp6RtrCfgIntfAddressesGet (openapiClientHandle_t *client_handle,
                                               uint32_t intIfNum,
                                               uint32_t *numAddr,
                                               openapi_ip6_cfg_addr_list_t *ipv6AddrList,
                                               OPEN_CONTROL_t *ipv6Mode,
                                               OPEN_CONTROL_t *autoConfigMode,
                                               OPEN_CONTROL_t *dhcpMode);

/*************************************************************************/
open_error_t openapiIp6RtrDadTransmitsGet (openapiClientHandle_t *client_handle,
                                           uint32_t intIfNum, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6RtrDadTransmitsSet (openapiClientHandle_t *client_handle,
                                           uint32_t intIfNum, uint32_t val);

/*************************************************************************/
open_error_t openapiIp6RtrNdNsIntervalGet (openapiClientHandle_t *client_handle,
                                           uint32_t intIfNum, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6RtrNdNsIntervalSet (openapiClientHandle_t *client_handle,
                                           uint32_t intIfNum, uint32_t val);

/*************************************************************************/
open_error_t openapiIp6RtrNdReachableTimeGet (openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t *val);

/*************************************************************************/
open_error_t openapiIp6RtrNdReachableTimeSet (openapiClientHandle_t *client_handle,
                                              uint32_t intIfNum, uint32_t val);

/*************************************************************************/
open_error_t openapiIp6RtrIntfICMPUnreachablesModeGet (openapiClientHandle_t *client_handle,
                                                       uint32_t intIfNum, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiIp6RtrIntfICMPUnreachablesModeSet (openapiClientHandle_t *client_handle,
                                                       uint32_t intIfNum, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiIpv6AddrEntryGet (openapiClientHandle_t *client_handle,
                                      uint32_t matchType,
                                      openapiIpv6AddrEntry_t *ipv6AddrEntry);

/*************************************************************************/
open_error_t openapiIpv6AddrEntryGetNext (openapiClientHandle_t *client_handle,
                                          uint32_t matchType,
                                          openapiIpv6AddrEntry_t *ipv6AddrEntry);

/*************************************************************************/
open_error_t openapiIpv6AddrPrefixEntryGet (openapiClientHandle_t *client_handle,
                                            uint32_t matchType,
                                            openapiIpv6AddrPrefixEntry_t *ipv6AddrPrefixEntry);

/*************************************************************************/
open_error_t openapiIp6RtrIntfAddressesGet (openapiClientHandle_t *client_handle,
                                            uint32_t intIfNum,
                                            uint32_t *numAddr,
                                            openIpv6IntfAddrList_t *ipv6AddrList);

/*************************************************************************/
open_error_t openapiIp6RtrIntfAddressGet (openapiClientHandle_t *client_handle,
                                          uint32_t intIfNum,
                                          open_inet_addr_t *inetAddr);

/*************************************************************************/
open_error_t openapiIpv6NbrTblEntryGet (openapiClientHandle_t *client_handle,
                                        open_buffdesc *vrfName,
                                        open_inet_addr_t *ipv6Addr,
                                        open_buffdesc *macAddr,
                                        uint32_t *intIfNum,
                                        OPEN_IP6_NBR_TYPE_t *ipv6Type,
                                        OPEN_IP6_NBR_STATE_t *nbrState,
                                        uint32_t *lastUpdate,
                                        OPEN_BOOL_t *isRouter,
                                        uint32_t *ipv6ScopeId);

/*************************************************************************/
open_error_t openapiIpv6NdpFlush (openapiClientHandle_t *client_handle,
                                  open_buffdesc *vrfName,
                                  uint32_t intIfNum,
                                  open_inet_addr_t *ipv6Addr);

/*************************************************************************/
open_error_t openapiSnmpIpv6StaticRouteGetNext (openapiClientHandle_t *client_handle,
                                                openIpv6RouteEntry_t *routeEntry);


#endif /* OPENAPI_IP6MAP_H_INCLUDED */