openapi_mpls.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2016-2018 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_mpls.h
*
* @purpose   MPLS Configuration and Status 
*
* @component OpEN
*
* @create    01/16/2014
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_MPLS_H_INCLUDED
#define OPENAPI_MPLS_H_INCLUDED

#include <stdio.h>
#include <stddef.h>
#include <sys/un.h>

#include "openapi_common.h"

typedef enum
{
  OPEN_MPLS_PROTO_STATIC  = 1, 
  OPEN_MPLS_PROTO_DYNAMIC = 2, 
  OPEN_MPLS_PROTO_BGP     = 3, 
  OPEN_MPLS_PROTO_LAST    = 4  
} OPEN_MPLS_LFDB_PROTOCOL_t;

typedef enum
{
  OPEN_MPLS_TYPE_LAYER_2 = 1, 
  OPEN_MPLS_TYPE_IPV4    = 2, 
  OPEN_MPLS_TYPE_IPV6    = 3, 
  OPEN_MPLS_TYPE_LAST    = 4  
} OPEN_MPLS_LFDB_ENTRY_TYPE_t;

typedef enum
{
  OPEN_MPLS_LABEL_SWAP     = 1, 
  OPEN_MPLS_LABEL_POP      = 2, 
  OPEN_MPLS_LABEL_LAST_POP = 3  
} OPEN_MPLS_LFDB_LABEL_ACTION_t;

typedef enum
{
  OPEN_MPLS_LABEL_IN_HARDWARE     = 0, 
  OPEN_MPLS_LABEL_NOT_IN_HARDWARE = 1  
} OPEN_MPLS_LFDB_IN_HARDWARE_STATUS_t;

typedef enum
{
  OPEN_MPLS_NONE           = 0, 
  OPEN_MPLS_UNKNOWN_SUBNET = 1, 
  OPEN_MPLS_LOCAL_SUBNET   = 3, 
  OPEN_MPLS_NO_RESOURCES   = 4, 
  OPEN_MPLS_NO_VLAN        = 5, 
  OPEN_MPLS_NO_PORT        = 6  
} OPEN_MPLS_LFDB_NOT_INSERTED_REASON_t;

OPEN_PACKED_STRUCT
{
  uint32_t                      ingressLabel;     
  OPEN_MPLS_LFDB_PROTOCOL_t     protocol;         
  OPEN_MPLS_LFDB_ENTRY_TYPE_t   entryType;        
  OPEN_MPLS_LFDB_LABEL_ACTION_t labelAction;      
  /* LFDB entry status */
  OPEN_MPLS_LFDB_IN_HARDWARE_STATUS_t  inHardware;        
  OPEN_MPLS_LFDB_NOT_INSERTED_REASON_t notInsertedReason; 
  /* The following fields are applicable only for IPv4 label types */
  uint32_t        ipv4Addr;                      
  uint32_t        ipv4PrefixLen;                 
  /* The following fields are applicable only for IPv6 label types */
  open_in6_addr_t ipv6Subnet;                    
  uint32_t        ipv6PrefixLen;                 
  /* The following fields are applicable only for Layer-2 label types */
  unsigned char   egressMac[OPEN_MAC_ADDR_LEN];  
  uint32_t        egressVlan;                    
  uint32_t        egressLabel;                   
  uint32_t        egressInterface;               
  /* LFDB entry statistics */
  uint32_t        duplicateInsertions;           
  uint64_t        inBytes;                       
  uint64_t        inPackets;                     
} OPEN_MPLS_LFDB_ENTRY_t;

OPEN_PACKED_STRUCT
{
  unsigned char mplsMac[OPEN_MAC_ADDR_LEN];  
  uint32_t lfdbSize;                         
  uint32_t minLfdbLabel;                     
  uint32_t maxLfdbLabel;                     
  uint32_t numLfdbEntries;                   
  uint32_t numLfdbInHardware;                
  uint32_t numLfdbNotInHardware;             
  uint32_t numLfdbPerProto[OPEN_MPLS_PROTO_LAST]; 
  uint32_t numLfdbPerType[OPEN_MPLS_TYPE_LAST];   
  /* Statistics.
  ** These parameters are reset to 0 when the stats are cleared. */ 
  uint32_t dynamicLfdbInsertFailures;        
  uint32_t lfdbHighWaterMark;                
  uint64_t lfdbLookupFailurePackets;         
  /* ECMP Group Statistics. */
  uint32_t ecmpInUse;                        
  uint32_t ecmpHighInUse;                    
  uint32_t ecmpMax;                          
  uint32_t maxTunnelInitiators;              
  uint32_t numTunnelInitiators;              
  uint32_t numTunnelsOneLabel;               
  uint32_t numTunnelsTwoLabel;               
  uint32_t numTunnelsThreeLabel;             
} OPEN_MPLS_GLOBAL_STATS_t;

typedef struct
{
  open_inet_addr_t nextHop;   
  uint32_t       label[OPEN_MAX_MPLS_IMPOSE_LABELS];  
  uint32_t       egressIfNum; 
  uint16_t       egressVlan;  
  unsigned char  egressMac [OPEN_MAC_ADDR_LEN]; 
  uint32_t       numRoutes; 
  uint32_t       age; 
} OPEN_MPLS_TUNNEL_INITIATOR_t;

/*************************************************************************/
open_error_t openapiMplsBgpIntfLabelSet(openapiClientHandle_t *client_handle, 
                                        uint32_t intIfNum, OPEN_AFX_t type, uint32_t label);

/*************************************************************************/
open_error_t openapiMplsBgpIntfLabelGet(openapiClientHandle_t *client_handle, 
                                        uint32_t intIfNum, OPEN_AFX_t type, uint32_t *label);

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

/*************************************************************************/
open_error_t openapiMplsGlobalStatusGet(openapiClientHandle_t *client_handle, 
                                        OPEN_MPLS_GLOBAL_STATS_t *global_status);

/*************************************************************************/
open_error_t openapiMplsBgpLabelModeGet(openapiClientHandle_t *client_handle, 
                                        OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiMplsBgpLabelModeSet(openapiClientHandle_t *client_handle, 
                                        OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiMplsLfdbGet(openapiClientHandle_t *client_handle, 
                                uint32_t label, OPEN_MPLS_LFDB_ENTRY_t *lfdb_entry);

/*************************************************************************/
open_error_t openapiMplsLfdbNextGet(openapiClientHandle_t *client_handle, 
                                    uint32_t label, OPEN_MPLS_LFDB_ENTRY_t *lfdb_entry);

/*************************************************************************/
open_error_t openapiMplsLfdbCreate(openapiClientHandle_t *client_handle, 
                                   OPEN_MPLS_LFDB_ENTRY_t *lfdb_entry);

/*************************************************************************/
open_error_t openapiMplsLfdbDelete(openapiClientHandle_t *client_handle, 
                                   uint32_t label);

/*************************************************************************/
open_error_t openapiMplsTunnelInitiatorGet(openapiClientHandle_t *client_handle,
                                           OPEN_MPLS_TUNNEL_INITIATOR_t *tunnel_entry);

/*************************************************************************/
open_error_t openapiMplsTunnelInitiatorGetNext(openapiClientHandle_t *client_handle,
                                               OPEN_MPLS_TUNNEL_INITIATOR_t *tunnel_entry,
                                               OPEN_MPLS_TUNNEL_INITIATOR_t *next_tunnel_entry);
#endif /* OPENAPI_MPLS_H_INCLUDED */