of1x_instruction.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_INSTRUCTION_H__
#define __OF1X_INSTRUCTION_H__

#include <inttypes.h> 
#include <stdbool.h>
#include "rofl.h"
#include "of1x_action.h"
#include "../../../common/datapacket.h"

typedef enum {
        OF1X_IT_NO_INSTRUCTION  = 0,            /* Setup the metadata field for use later in pipeline */
        OF1X_IT_APPLY_ACTIONS   = 1,            /* Applies the action(s) immediately */
        OF1X_IT_CLEAR_ACTIONS   = 2,            /* Clears all actions from the datapath action set */
        OF1X_IT_WRITE_ACTIONS   = 3,            /* Write the action(s) onto the datapath action set */
        OF1X_IT_WRITE_METADATA  = 4,            /* Setup the metadata field for use later in pipeline */

        OF1X_IT_EXPERIMENTER    = 5,            /* Experimenter instruction */
        OF1X_IT_METER           = 6,            /* Meters */
        OF1X_IT_GOTO_TABLE      = 7,            /* Setup the next table in the lookup pipeline: MUST BE the last one */
}of1x_instruction_type_t;

#define OF1X_IT_MAX OF1X_IT_GOTO_TABLE+1

//Write metadata instruction
typedef struct of1x_write_metadata{
        uint64_t metadata;
        uint64_t metadata_mask;
}of1x_write_metadata_t;


/* Instruction abstraction data structure */
typedef struct of1x_instruction{
        //Type and value(for set fields and push)
        of1x_instruction_type_t type;

        //Action group for APPLY_ACTIONS type only 
        of1x_action_group_t* apply_actions;

        //WRITE_ACTIONS type only actions       
        of1x_write_actions_t* write_actions;
 
        //WRITE_METADATA type only metadata
        of1x_write_metadata_t write_metadata;

        //GO-TO-TABLE
        unsigned int go_to_table;       
}of1x_instruction_t;

/* Instruction group, using a double-linked-list */ 
typedef struct of1x_instruction_group{
        //Number of actions in the list
        unsigned int num_of_instructions;

        of1x_instruction_t instructions[OF1X_IT_MAX]; //Latest must ALWAYS be MAX
        
        //Flag indicating that there are multiple 
        //outputs in several instructions/in an apply 
        //actions group.
        //Note: this does NOT reflect the exact number of output 
        //actions when groups are used
        unsigned int num_of_outputs;
        
}of1x_instruction_group_t;

//Fwd declaration
struct of1x_switch;
struct of1x_pipeline;
struct of1x_flow_entry;
struct of1x_group_table;

/*
*
* Function prototypes
*
*/

//C++ extern C
ROFL_BEGIN_DECLS

//Instruction group

void __of1x_init_instruction_group(of1x_instruction_group_t* group);
void __of1x_destroy_instruction_group(of1x_instruction_group_t* group);

//Add/remove instructions to/from group
void of1x_add_instruction_to_group(of1x_instruction_group_t* group, of1x_instruction_type_t type, of1x_action_group_t* apply_actions, of1x_write_actions_t* write_actions, of1x_write_metadata_t* write_metadata, unsigned int go_to_table);
void of1x_remove_instruction_from_the_group(of1x_instruction_group_t* group, of1x_instruction_type_t type);

//Update instructions
rofl_result_t __of1x_update_instructions(of1x_instruction_group_t* group, of1x_instruction_group_t* new_group);

//Check whether instructions contain group
bool __of1x_instructions_contain_group(struct of1x_flow_entry *const entry, const unsigned int group_id);

//Copy (clone) instructions: TODO evaluate if is necessary to check for errors
void __of1x_copy_instruction_group(of1x_instruction_group_t* origin, of1x_instruction_group_t* dest);

bool __of1x_instruction_has(of1x_instruction_group_t *inst_grp, of1x_packet_action_type_t type, uint64_t value);

rofl_result_t __of1x_validate_instructions(of1x_instruction_group_t* inst_grp, struct of1x_pipeline* pipeline, unsigned int table_id);

//Dump
void __of1x_dump_instructions(of1x_instruction_group_t group, bool raw_nbo);

//C++ extern C
ROFL_END_DECLS

#endif //OF1X_INSTRUCTION