driver.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 HAL_DRIVER_H
#define HAL_DRIVER_H 

#include <stdbool.h>
#include <rofl/datapath/pipeline/monitoring.h>
#include <rofl/datapath/pipeline/physical_switch.h>
#include <rofl/datapath/pipeline/switch_port.h>
#include <rofl/datapath/pipeline/openflow/of_switch.h>
#include <rofl/datapath/pipeline/openflow/openflow1x/pipeline/matching_algorithms/matching_algorithms.h>

#include "hal.h"
#include "hal_utils.h"
#include "extensions/extensions.h"

//driver_info_t char array lengths
#define DRIVER_CODE_NAME_MAX_LEN 16
#define DRIVER_VERSION_MAX_LEN 16 
#define DRIVER_DESCRIPTION_MAX_LEN 2048*4
#define DRIVER_USAGE_MAX_LEN 2048*4
#define DRIVER_EXTRA_PARAMS_MAX_LEN 2048*4

typedef struct{
        char code_name[DRIVER_CODE_NAME_MAX_LEN];
        char version[DRIVER_VERSION_MAX_LEN];
        char description[DRIVER_DESCRIPTION_MAX_LEN];
        char usage[DRIVER_USAGE_MAX_LEN];
        char extra_params[DRIVER_EXTRA_PARAMS_MAX_LEN]; 
}driver_info_t;

//C++ extern C
HAL_BEGIN_DECLS

//Init&destroy driver
hal_result_t hal_driver_init(hal_extension_ops_t* extensions, const char* extra_params);

void hal_driver_get_info(driver_info_t* info);

hal_result_t hal_driver_destroy(void);

//Monitroing 

monitored_entity_t* hal_driver_get_chassis_info(void);

bool hal_driver_switch_exists(uint64_t dpid); 

dpid_list_t* hal_driver_get_all_lsi_dpids(void);

hal_result_t hal_driver_create_switch(char* name, uint64_t dpid, of_version_t of_version, unsigned int num_of_tables, int* ma_list);

of_switch_snapshot_t* hal_driver_get_switch_snapshot_by_dpid(uint64_t dpid);

hal_result_t hal_driver_destroy_switch_by_dpid(uint64_t dpid);


bool hal_driver_port_exists(const char *name);

switch_port_name_list_t* hal_driver_get_all_port_names(void);

switch_port_snapshot_t* hal_driver_get_port_snapshot_by_name(const char *name);

switch_port_snapshot_t* hal_driver_get_port_snapshot_by_num(uint64_t dpid, unsigned int port_num);


//Attachment

hal_result_t hal_driver_attach_port_to_switch(uint64_t dpid, const char* name, unsigned int* port_num);

hal_result_t hal_driver_connect_switches(uint64_t dpid_lsi1, unsigned int* port_num1, switch_port_snapshot_t** port1, uint64_t dpid_lsi2, unsigned int* port_num2, switch_port_snapshot_t** port2);


hal_result_t hal_driver_detach_port_from_switch(uint64_t dpid, const char* name);

hal_result_t hal_driver_detach_port_from_switch_at_port_num(uint64_t dpid, const unsigned int port_num);

//Port control

hal_result_t hal_driver_bring_port_up(const char* name);

hal_result_t hal_driver_bring_port_down(const char* name);

hal_result_t hal_driver_bring_port_up_by_num(uint64_t dpid, unsigned int port_num);

hal_result_t hal_driver_bring_port_down_by_num(uint64_t dpid, unsigned int port_num);


monitoring_snapshot_state_t* hal_driver_get_monitoring_snapshot(uint64_t rev);

hal_result_t hal_driver_list_matching_algorithms(of_version_t of_version, const char * const** name_list, int *count);


//C++ extern C
HAL_END_DECLS

/* OpenFlow related events */
#include "openflow/openflow1x/of1x_driver.h"
// [+] Add more versions here...

#endif /* HAL_DRIVER_H */