matching_algorithms.h

/* 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 MATCHING_ALGORITHMS_H_
#define MATCHING_ALGORITHMS_H_

#include "rofl.h"
#include "../of1x_flow_entry.h"
#include "../of1x_statistics.h"
#include "../of1x_utils.h"
#include "available_ma.h"

/*
 * forward declarations
 */
struct of1x_flow_table;
enum of1x_mutex_acquisition_required;

#define OF1X_MATCHING_ALGORITHMS_MAX_DESCRIPTION_LENGTH 256

#define OF1X_REGISTER_MATCHING_ALGORITHM(NAME)\
                struct of1x_matching_algorithm_functions of1x_matching_algorithm_##NAME##_maf 


typedef struct of1x_matching_algorithm_functions{

        rofl_result_t
        (*init_hook)(struct of1x_flow_table *const table);

        rofl_result_t
        (*destroy_hook)(struct of1x_flow_table *const table); //Mutual exclusion will already be taken by the of1x_flow_table destructor


        // flow management
        rofl_of1x_fm_result_t
        (*add_flow_entry_hook)(struct of1x_flow_table *const table,
                        of1x_flow_entry_t *const entry,
                        bool check_overlap,
                        bool reset_counts);


        rofl_result_t
        (*modify_flow_entry_hook)(struct of1x_flow_table *const table,
                        of1x_flow_entry_t *const entry,
                        const enum of1x_flow_removal_strictness strict,
                        bool reset_counts);


        rofl_result_t
        (*remove_flow_entry_hook)(struct of1x_flow_table *const table,
                        of1x_flow_entry_t *const entry, 
                        of1x_flow_entry_t *const specific_entry,
                        const enum of1x_flow_removal_strictness strict,
                        uint32_t out_port,
                        uint32_t out_group,
                        of1x_flow_remove_reason_t reason,
                        of1x_mutex_acquisition_required_t mutex_acquired);



        //Packet matching lookup
        of1x_flow_entry_t*
        (*find_best_match_hook)(unsigned tid, struct of1x_flow_table *const table,
                        packet_matches_t *const pkt_matches);



        // flow stats
        rofl_result_t
        (*get_flow_stats_hook)(struct of1x_flow_table *const table,
                        uint64_t cookie,
                        uint64_t cookie_mask,
                        uint32_t out_port, 
                        uint32_t out_group,
                        of1x_match_group_t *const matches,
                        of1x_stats_flow_msg_t* msg);



        rofl_result_t   
        (*get_flow_aggregate_stats_hook)(struct of1x_flow_table *const table,
                        uint64_t cookie,
                        uint64_t cookie_mask,
                        uint32_t out_port, 
                        uint32_t out_group,
                        of1x_match_group_t *const matches,
                        of1x_stats_flow_aggregate_msg_t* msg);


        of1x_flow_entry_t*
        (*find_entry_using_group_hook)(struct of1x_flow_table *const table,
                        const unsigned int group_id);


        // dump flow table
        void
        (*dump_hook)(struct of1x_flow_table *const table, bool raw_nbo);

        
        char description[OF1X_MATCHING_ALGORITHMS_MAX_DESCRIPTION_LENGTH];
}of1x_matching_algorithms_functions_t;

extern of1x_matching_algorithms_functions_t of1x_matching_algorithms[];

void __of1x_generate_matching_algorithm_list(void);

#endif /* MATCHING_ALGORITHMS_H_ */