oflops-turbo/module_default.h at wip_of13 · rsanger/oflops-turbo · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
#ifndef MODULE_DEFAULT_H
#define MODULE_DEFAULT_H

#include "context.h"

/** @defgroup modules
 *
 * Modules for different oflops runs.
 */

// Set of default operations for modules

/**
 * Default code to execute for the init phase of the module.
 * \param ctx module context.
 * \param param a string with the configurtion params
 */
int default_module_init(struct oflops_context *ctx, char *param);

/**
 * A default function to be called when a a module is destroyed.
 * \param ctx module context.
 */
int default_module_destroy(struct oflops_context *ctx);

/**
 * a method to be called when a pcap filter is request for a speciic module.
 * \param ct module context.
 * \param ofc channel type
 * \param filter a string to store the filter.
 * \param buflien maximum sze of the string buffer.
 */
int default_module_get_pcap_filter(struct oflops_context *ctx, oflops_channel_name ofc,
    char * filter, int buflen);

/**
* A method exectued when a module start running (pre-test flow step, etc.).
* \param ctx the context of the module
*/
int default_module_start(struct oflops_context * ctx);

/**
* A default method to be called when a pcap packet is pushed to the module.
* \param pe a struct to stoe pcap data.
* \param ch the id of the channel from which we received the packet.
*/
int default_module_handle_pcap_event(struct oflops_context *ctx, struct pcap_event * pe, oflops_channel_name ch);

/**
*  Adefault method to be callen when a packet in event cocurs.
* \param ctx muodule context
*\param  pktin a method to sterw tre :w

*/
int default_module_of_event_packet_in(struct oflops_context *ctx, const struct ofp_packet_in * pktin);

#ifdef HAVE_OFP_FLOW_EXPIRED
	int default_module_of_event_flow_removed(struct oflops_context *ctx, const struct ofp_flow_expired * ofph);
#elif defined(HAVE_OFP_FLOW_REMOVED)
	int default_module_of_event_flow_removed(struct oflops_context *ctx, const struct ofp_flow_removed * ofph);
#else
#error "Unknown version of openflow"
#endif

int default_module_of_event_echo_request(struct oflops_context *ctx, const struct ofp_header * ofph);
int default_module_of_event_port_status(struct oflops_context *ctx, const struct ofp_port_status * ofph);
int default_module_of_event_other(struct oflops_context *ctx, const struct ofp_header * ofph);
int default_module_handle_timer_event(struct oflops_context * ctx, struct timer_event * te);
int default_module_handle_snmp_event(struct oflops_context * ctx, struct snmp_event * se);
int default_module_handle_traffic_generation(struct oflops_context * ctx);
void default_module_of_message(struct oflops_context *ctx, uint8_t of_version, uint8_t type, void *data, size_t len);

const uint8_t *default_module_get_openflow_versions();
#endif