of_switch.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 __OF_SWITCH_H__
#define __OF_SWITCH_H__

#include <inttypes.h> 
#include "rofl.h"
#include "../switch_port.h"

typedef enum{
        OF_VERSION_10 = 0x01,
        OF_VERSION_11 = 0x02,
        OF_VERSION_12 = 0x03,
        OF_VERSION_13 = 0x04,
        //Add more here...
}of_version_t;

#define __OF_VERSION_MAX (OF_VERSION_13+1)

//String for nice dumping
extern const char* of_version_str[__OF_VERSION_MAX];

#ifndef LOGICAL_SWITCH_MAX_LOG_PORTS
        #define LOGICAL_SWITCH_MAX_LOG_PORTS 512 // 511, 0 slot NEVER used (has to be less than OF1X_PORT_MAX)
#endif

//Max length of the LSI name
#define LOGICAL_SWITCH_MAX_LEN_NAME 32

//Platform dependent opaque state
typedef void of_switch_platform_state_t;

//Fwd decl
struct datapacket;
struct of_switch; 

typedef struct of_switch{

        //Make sure ALL ofXX_switch_t contain this three fields
        //at the VERY beginning 

        /* This part is common and MUST be at the very beginning */ 
        of_version_t of_ver; 
        uint64_t dpid;
        char name[LOGICAL_SWITCH_MAX_LEN_NAME];
        unsigned int max_ports;
        unsigned int num_of_ports;
        
        //Switch logical ports 
        logical_switch_port_t logical_ports[LOGICAL_SWITCH_MAX_LOG_PORTS];
        
        of_switch_platform_state_t* platform_state;
        /* End of common part */

        //Version specific content...
}of_switch_t;

typedef of_switch_t of_switch_snapshot_t;

typedef int of_packet_in_reason_t;

//C++ extern C
ROFL_BEGIN_DECLS

//Wrapping destroy
rofl_result_t of_destroy_switch(const of_switch_t* sw);


rofl_result_t of_reconfigure_switch(of_switch_t* sw, of_version_t version);

//Wrapping timers
void of_process_pipeline_tables_timeout_expirations(const of_switch_t* sw);

//Wrapping port management
rofl_result_t __of_attach_port_to_switch_at_port_num(of_switch_t* sw, unsigned int port_num, switch_port_t* port);
rofl_result_t __of_attach_port_to_switch(of_switch_t* sw, switch_port_t* port, unsigned int* port_num);
rofl_result_t __of_detach_port_from_switch_by_port_num(of_switch_t* sw, unsigned int port_num);
rofl_result_t __of_detach_port_from_switch(of_switch_t* sw, switch_port_t* port);
rofl_result_t __of_detach_all_ports_from_switch(of_switch_t* sw);

rofl_result_t of_get_switch_matching_algorithms(of_version_t of_version, const char * const** name_list, int *count);

//
// Snapshots
//

//Creates a snapshot of the running of LSI 
of_switch_snapshot_t* __of_switch_get_snapshot(of_switch_t* sw);

void of_switch_destroy_snapshot(of_switch_snapshot_t* snapshot);

//C++ extern C
ROFL_END_DECLS

#endif //OF_SWITCH