of1x_utils.h

Go to the documentation of this file.

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef __OF1X_UTILS_H__
#define __OF1X_UTILS_H__

#include <inttypes.h>
#include "../../of_switch.h" 

//
// OpenFlow 1.X specific return values
//

typedef enum rofl_of1x_fm_result{
        ROFL_OF1X_FM_SUCCESS    = EXIT_SUCCESS,
        ROFL_OF1X_FM_FAILURE    = EXIT_FAILURE,
        ROFL_OF1X_FM_OVERLAP
}rofl_of1x_fm_result_t;


//
// Removal mutex management
//

/*
* Mutex state for flow_entry_removal 
*/
typedef enum of1x_mutex_acquisition_required{
        MUTEX_NOT_ACQUIRED = 0,                         /*mutex has not been acquired and we must take it*/
        MUTEX_ALREADY_ACQUIRED_BY_TIMER_EXPIRATION,     /*mutex was taken when checking for expirations. We shouldn't call the timers functions*/
        MUTEX_ALREADY_ACQUIRED_NON_STRICT_SEARCH        /*mutex was taken when looking for entries with a non strict definition*/
}of1x_mutex_acquisition_required_t;

//
// Pipeline version
//

/*
* Required pipeline version
*/
typedef struct of1x_ver_req_t{
        of_version_t min_ver;   //of_version_t
        of_version_t max_ver;   //of_version_t
}of1x_ver_req_t;

#define OF1X_MIN_VERSION OF_VERSION_10
#define OF1X_MAX_VERSION OF_VERSION_13


//
// Match/Actions masks
//
#if defined(BIG_ENDIAN_DETECTED)
        /*
        * Useful masks
        */
        //Byte masks
        #define OF1X_8_BYTE_MASK        0xFFFFFFFFFFFFFFFFULL 
        #define OF1X_6_BYTE_MASK        0xFFFFFFFFFFFF0000ULL
        #define OF1X_4_BYTE_MASK        0xFFFFFFFF
        #define OF1X_3_BYTE_MASK        0xFFFFFF00
        #define OF1X_2_BYTE_MASK        0xFFFF
        #define OF1X_1_BYTE_MASK        0xFF
          
        //Non-multiple of byte masks
        #define OF1X_48_BITS_MASK       0xFFFFFFFFFFFF0000ULL 
        #define OF1X_20_BITS_MASK       0xFFFFF000
        #define OF1X_14_BITS_MASK       0xFFFC
        #define OF1X_13_BITS_MASK       0xFFF8
        #define OF1X_12_BITS_MASK       0xFFF0
        #define OF1X_9_BITS_MASK        0xFF80
        #define OF1X_6_BITS_MASK        0xFC
        #define OF1X_4_BITS_MASK        0xF0
        #define OF1X_3_BITS_MASK        0xE0

        #define OF1X_VLAN_PRESENT_MASK  0x0008
        #define OF1X_VLAN_ID_MASK       0x0FFF
        
        #define OF1X_8MIDDLE_BITS_MASK 0x0FF0 //ipv6 TC
        #define OF1X_20_BITS_IPV6_FLABEL_MASK 0x0FFFFF00
        
#elif defined(LITTLE_ENDIAN_DETECTED)
        /*
        * Useful masks
        */
        //Byte masks
        #define OF1X_8_BYTE_MASK        0xFFFFFFFFFFFFFFFFULL 
        #define OF1X_6_BYTE_MASK        0x0000FFFFFFFFFFFFULL
        #define OF1X_4_BYTE_MASK        0x00000000FFFFFFFF
        #define OF1X_3_BYTE_MASK        0x0000000000FFFFFF
        #define OF1X_2_BYTE_MASK        0x000000000000FFFF
        #define OF1X_1_BYTE_MASK        0x00000000000000FF
          
        //Non-multiple of byte masks
        #define OF1X_48_BITS_MASK       0x0000FFFFFFFFFFFFULL 
        #define OF1X_20_BITS_MASK       0x0000000000F0FFFF
        #define OF1X_14_BITS_MASK       0x0000000000003FFF
        #define OF1X_13_BITS_MASK       0x0000000000001FFF
        #define OF1X_12_BITS_MASK       0x000000000000FF0F
        #define OF1X_9_BITS_MASK        0x00000000000001FF
        #define OF1X_6_BITS_MASK        0x000000000000003F
        #define OF1X_4_BITS_MASK        0x000000000000000F
        #define OF1X_3_BITS_MASK        0x0000000000000007
        
        #define OF1X_VLAN_PRESENT_MASK  0x0010
        #define OF1X_VLAN_ID_MASK       0xFF0F
        
        #define OF1X_8MIDDLE_BITS_MASK 0xF00F
        #define OF1X_20_BITS_IPV6_FLABEL_MASK 0x00FFFF0F
        
#else
        #error Unknwon endianness
#endif

// Masks and flags (intra byte => not dependent on endianness)
#define OF1X_BIT0_MASK 1<<0 // 0x01 // 0000 0001
#define OF1X_BIT1_MASK 1<<1 // 0x02 // 0000 0010
#define OF1X_BIT2_MASK 1<<2 // 0x04 // 0000 0100
#define OF1X_BIT3_MASK 1<<3 // 0x08 // 0000 1000
#define OF1X_BIT4_MASK 1<<4 // 0x10 // 0001 0000
#define OF1X_BIT5_MASK 1<<5 // 0x20 // 0010 0000
#define OF1X_BIT6_MASK 1<<6 // 0x40 // 0100 0000
#define OF1X_BIT7_MASK 1<<7 // 0x80 // 1000 0000

#define OF1X_4MSBITS_MASK 0xF0 // 1111 0000
#define OF1X_4LSBITS_MASK 0x0F // 0000 1111
#define OF1X_6MSBITS_MASK 0xFC // 1111 1100
#define OF1X_2LSBITS_MASK 0x03 // 0000 0011
#define OF1X_3LSBITS_MASK 0x07 // 0000 0111
#define OF1X_3MSBITS_MASK 0xE0 // 1110 0000
#define OF1X_2MSBITS_MASK 0xC0 // 1100 0000
#define OF1X_6LSBITS_MASK 0x3F // 0011 1111
#define OF1X_BITS_2AND3_MASK 0x30 // 0000 1100
#define OF1X_BITS_4AND5_MASK 0x30 // 0011 0000
#define OF1X_BITS_12AND3_MASK 0x0E // 0000 1110


//
// Bit alignement MACROS
//
#define OF1X_SHIFT_LEFT(x, y) (x<<y)
#define OF1X_SHIFT_RIGHT(x, y) (x>>y)

//aligment operations dependent on endiannes
#define OF1X_SWAP_AND_SHIFT_64(x, y) do{ \
                x=__bswap_64(x); \
                x>>=y; \
                }while(0)
//NOTE swapping will be done externally. DUMPING?



//Vlan pcp is found in the 3 most significant bits: 1110 0000
#define OF1X_MAC_ALIGN(x) OF1X_SHIFT_LEFT(x, 16)
#define OF1X_MAC_VALUE(x) OF1X_SHIFT_RIGHT(x, 16)

#define OF1X_VLAN_PCP_ALIGN(x) OF1X_SHIFT_LEFT(x, 5)
#define OF1X_VLAN_PCP_VALUE(x) OF1X_SHIFT_RIGHT(x, 5)

#define OF1X_MPLS_LABEL_ALIGN(x) OF1X_SHIFT_LEFT(x, 12)
#define OF1X_MPLS_LABEL_VALUE(x) OF1X_SHIFT_RIGHT(x, 12)

#define OF1X_MPLS_TC_ALIGN(x) OF1X_SHIFT_LEFT(x, 1)
#define OF1X_MPLS_TC_VALUE(x) OF1X_SHIFT_RIGHT(x, 1)

#define OF1X_IP_DSCP_ALIGN(x) OF1X_SHIFT_LEFT(x, 2)
#define OF1X_IP_DSCP_VALUE(x) OF1X_SHIFT_RIGHT(x, 2)

#define OF1X_IP6_FLABEL_ALIGN(x) OF1X_SHIFT_LEFT(x, 8)
#define OF1X_IP6_FLABEL_VALUE(x) OF1X_SHIFT_RIGHT(x, 8)
/*
* Align to 64bit
*/
#define OF1X_ALIGN_64_BIT(x) (((x/8)+1)*8)

#endif //OF1X_UTILS