A Discrete-Event Network Simulator
API
openflow-interface.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License version 2 as
5 * published by the Free Software Foundation;
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15 *
16 * Author: Blake Hurd <naimorai@gmail.com>
17 */
18#ifndef OPENFLOW_INTERFACE_H
19#define OPENFLOW_INTERFACE_H
20
21#include <assert.h>
22#include <errno.h>
23
24// Include OFSI code
25#include "ns3/simulator.h"
26#include "ns3/log.h"
27#include "ns3/net-device.h"
28#include "ns3/packet.h"
29#include "ns3/address.h"
30#include "ns3/nstime.h"
31#include "ns3/mac48-address.h"
32
33#include <set>
34#include <map>
35#include <limits>
36
37// Include main header and Vendor Extension files
38#include "openflow/openflow.h"
39#include "openflow/nicira-ext.h"
40#include "openflow/ericsson-ext.h"
41
42extern "C"
43{
44// Inexplicably, the OpenFlow implementation uses these two reserved words as member names.
45#define private _private
46#define delete _delete
47#define list List
48
49// Include OFSI Library files
50#include "openflow/private/csum.h"
51#include "openflow/private/poll-loop.h"
52#include "openflow/private/rconn.h"
53#include "openflow/private/stp.h"
54#include "openflow/private/vconn.h"
55#include "openflow/private/xtoxll.h"
56
57// Include OFSI Switch files
58#include "openflow/private/chain.h"
59#include "openflow/private/table.h"
60#include "openflow/private/datapath.h" // The functions below are defined in datapath.c
64#include "openflow/private/dp_act.h" // The functions below are defined in dp_act.c
65void set_vlan_vid (ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah);
66void set_vlan_pcp (ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah);
67void strip_vlan (ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah);
68void set_dl_addr (ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah);
69void set_nw_addr (ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah);
70void set_tp_port (ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah);
71void set_mpls_label (ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah);
72void set_mpls_exp (ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah);
73#include "openflow/private/pt_act.h"
74
75#undef list
76#undef private
77#undef delete
78}
79
80// Capabilities supported by this implementation.
81#define OFP_SUPPORTED_CAPABILITIES ( OFPC_FLOW_STATS \
82 | OFPC_TABLE_STATS \
83 | OFPC_PORT_STATS \
84 | OFPC_MULTI_PHY_TX \
85 | OFPC_VPORT_TABLE)
86
87// Actions supported by this implementation.
88#define OFP_SUPPORTED_ACTIONS ( (1 << OFPAT_OUTPUT) \
89 | (1 << OFPAT_SET_VLAN_VID) \
90 | (1 << OFPAT_SET_VLAN_PCP) \
91 | (1 << OFPAT_STRIP_VLAN) \
92 | (1 << OFPAT_SET_DL_SRC) \
93 | (1 << OFPAT_SET_DL_DST) \
94 | (1 << OFPAT_SET_NW_SRC) \
95 | (1 << OFPAT_SET_NW_DST) \
96 | (1 << OFPAT_SET_TP_SRC) \
97 | (1 << OFPAT_SET_TP_DST) \
98 | (1 << OFPAT_SET_MPLS_LABEL) \
99 | (1 << OFPAT_SET_MPLS_EXP) )
100
101#define OFP_SUPPORTED_VPORT_TABLE_ACTIONS ( (1 << OFPPAT_OUTPUT) \
102 | (1 << OFPPAT_POP_MPLS) \
103 | (1 << OFPPAT_PUSH_MPLS) \
104 | (1 << OFPPAT_SET_MPLS_LABEL) \
105 | (1 << OFPPAT_SET_MPLS_EXP) ) \
106
107namespace ns3 {
108
109class OpenFlowSwitchNetDevice;
110
111namespace ofi {
112
122struct Port
123{
124 Port () : config (0),
125 state (0),
126 netdev (0),
127 rx_packets (0),
128 tx_packets (0),
129 rx_bytes (0),
130 tx_bytes (0),
131 tx_dropped (0),
133 {
134 }
135
139 unsigned long long int rx_packets;
140 unsigned long long int tx_packets;
141 unsigned long long int rx_bytes;
142 unsigned long long int tx_bytes;
143 unsigned long long int tx_dropped;
144 unsigned long long int mpls_ttl0_dropped;
145};
146
151class Stats
152{
153public:
159 Stats (ofp_stats_types _type, size_t body_len);
160
169 int DoInit (const void *body, int body_len, void **state);
170
179 int DoDump (Ptr<OpenFlowSwitchNetDevice> swtch, void *state, ofpbuf *buffer);
180
188 void DoCleanup (void *state);
189
194 {
196 sw_table_position position;
197 ofp_flow_stats_request rq;
198 time_t now;
199
200 ofpbuf *buffer;
201 };
202
208 {
211 };
212
213 ofp_stats_types type;
214private:
221 int DescStatsDump (void *state, ofpbuf *buffer);
222
231 int FlowStatsInit (const void *body, int body_len, void **state);
232 int AggregateStatsInit (const void *body, int body_len, void **state);
233 int PortStatsInit (const void *body, int body_len, void **state);
237 int (*FlowDumpCallback)(sw_flow *flow, void *state);
239 int (*AggregateDumpCallback)(sw_flow *flow, void *state);
240
250 int AggregateStatsDump (Ptr<OpenFlowSwitchNetDevice> dp, ofp_aggregate_stats_request *state, ofpbuf *buffer);
251 int TableStatsDump (Ptr<OpenFlowSwitchNetDevice> dp, void *state, ofpbuf *buffer);
253 int PortTableStatsDump (Ptr<OpenFlowSwitchNetDevice> dp, void *state, ofpbuf *buffer);
255};
256
261struct Action
262{
267 static bool IsValidType (ofp_action_type type);
268
278 static uint16_t Validate (ofp_action_type type, size_t len, const sw_flow_key *key, const ofp_action_header *ah);
279
288 static void Execute (ofp_action_type type, ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah);
289};
290
296{
301 static bool IsValidType (ofp_vport_action_type type);
302
311 static uint16_t Validate (ofp_vport_action_type type, size_t len, const ofp_action_header *ah);
312
321 static void Execute (ofp_vport_action_type type, ofpbuf *buffer, const sw_flow_key *key, const ofp_action_header *ah);
322};
323
329{
334 static bool IsValidType (er_action_type type);
335
343 static uint16_t Validate (er_action_type type, size_t len);
344
353 static void Execute (er_action_type type, ofpbuf *buffer, const sw_flow_key *key, const er_action_header *ah);
354};
355
361{
362 bool done;
363 ofp_stats_request *rq;
365 void *state;
367};
368
374{
376 ofpbuf* buffer;
377 uint16_t protocolNumber;
380};
381
388class Controller : public Object
389{
390public:
395 static TypeId GetTypeId (void);
397 virtual ~Controller ();
398
405
412 virtual void ReceiveFromSwitch (Ptr<OpenFlowSwitchNetDevice> swtch, ofpbuf* buffer)
413 {
414 }
415
434
435protected:
444 virtual void SendToSwitch (Ptr<OpenFlowSwitchNetDevice> swtch, void * msg, size_t length);
445
459 ofp_flow_mod* BuildFlow (sw_flow_key key, uint32_t buffer_id, uint16_t command, void* acts, size_t actions_len, int idle_timeout, int hard_timeout);
460
468 uint8_t GetPacketType (ofpbuf* buffer);
469
471 typedef std::set<Ptr<OpenFlowSwitchNetDevice> > Switches_t;
473};
474
482{
483public:
488 static TypeId GetTypeId (void);
489
491};
492
502{
503public:
508 static TypeId GetTypeId (void);
509
511 {
512 m_learnState.clear ();
513 }
514
516
517protected:
520 {
522 };
525 typedef std::map<Mac48Address, LearnedState> LearnState_t;
527};
528
540void ExecuteActions (Ptr<OpenFlowSwitchNetDevice> swtch, uint64_t packet_uid, ofpbuf* buffer, sw_flow_key *key, const ofp_action_header *actions, size_t actions_len, int ignore_no_fwd);
541
550uint16_t ValidateActions (const sw_flow_key *key, const ofp_action_header *actions, size_t actions_len);
551
562void ExecuteVPortActions (Ptr<OpenFlowSwitchNetDevice> swtch, uint64_t packet_uid, ofpbuf* buffer, sw_flow_key *key, const ofp_action_header *actions, size_t actions_len);
563
571uint16_t ValidateVPortActions (const ofp_action_header *actions, size_t actions_len);
572
580void ExecuteVendor (ofpbuf *buffer, const sw_flow_key *key, const ofp_action_header *ah);
581
590uint16_t ValidateVendor (const sw_flow_key *key, const ofp_action_header *ah, uint16_t len);
591
592/*
593 * From datapath.c
594 * Buffers are identified to userspace by a 31-bit opaque ID. We divide the ID
595 * into a buffer number (low bits) and a cookie (high bits). The buffer number
596 * is an index into an array of buffers. The cookie distinguishes between
597 * different packets that have occupied a single buffer. Thus, the more
598 * buffers we have, the lower-quality the cookie...
599 */
600#define PKT_BUFFER_BITS 8
601#define N_PKT_BUFFERS (1 << PKT_BUFFER_BITS)
602#define PKT_BUFFER_MASK (N_PKT_BUFFERS - 1)
603#define PKT_COOKIE_BITS (32 - PKT_BUFFER_BITS)
604
605}
606
607}
608
609#endif /* OPENFLOW_INTERFACE_H */
NS_ASSERT() and NS_ASSERT_MSG() macro definitions.
a polymophic address class
Definition: address.h:91
A base class which provides memory management and object aggregation.
Definition: object.h:88
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
a unique identifier for an interface.
Definition: type-id.h:59
An interface for a Controller of OpenFlowSwitchNetDevices.
uint8_t GetPacketType(ofpbuf *buffer)
Get the packet type on the buffer, which can then be used to determine how to handle the buffer.
Switches_t m_switches
The collection of switches registered to this controller.
static TypeId GetTypeId(void)
Register this type.
virtual void SendToSwitch(Ptr< OpenFlowSwitchNetDevice > swtch, void *msg, size_t length)
However the controller is implemented, this method is to be used to pass a message on to a switch.
virtual void ReceiveFromSwitch(Ptr< OpenFlowSwitchNetDevice > swtch, ofpbuf *buffer)
A switch calls this method to pass a message on to the Controller.
ofp_flow_mod * BuildFlow(sw_flow_key key, uint32_t buffer_id, uint16_t command, void *acts, size_t actions_len, int idle_timeout, int hard_timeout)
Construct flow data from a matching key to build a flow entry for adding, modifying,...
virtual ~Controller()
Destructor.
std::set< Ptr< OpenFlowSwitchNetDevice > > Switches_t
OpenFlowSwitchNetDevice container type.
void StartDump(StatsDumpCallback *cb)
Starts a callback-based, reliable, possibly multi-message reply to a request made by the controller.
virtual void AddSwitch(Ptr< OpenFlowSwitchNetDevice > swtch)
Adds a switch to the controller.
Demonstration of a Drop controller.
void ReceiveFromSwitch(Ptr< OpenFlowSwitchNetDevice > swtch, ofpbuf *buffer)
A switch calls this method to pass a message on to the Controller.
static TypeId GetTypeId(void)
Register this type.
Demonstration of a Learning controller.
static TypeId GetTypeId(void)
Register this type.
void ReceiveFromSwitch(Ptr< OpenFlowSwitchNetDevice > swtch, ofpbuf *buffer)
A switch calls this method to pass a message on to the Controller.
std::map< Mac48Address, LearnedState > LearnState_t
Learned state type.
Time m_expirationTime
Time it takes for learned MAC state entry/created flow to expire.
LearnState_t m_learnState
Learned state data.
OpenFlow statistics.
int PortStatsInit(const void *body, int body_len, void **state)
Initialize the stats.
int PortTableStatsDump(Ptr< OpenFlowSwitchNetDevice > dp, void *state, ofpbuf *buffer)
Dump the stats.
int FlowStatsDump(Ptr< OpenFlowSwitchNetDevice > dp, FlowStatsState *state, ofpbuf *buffer)
Dump the stats.
int(* AggregateDumpCallback)(sw_flow *flow, void *state)
Aggregate dump callback functor.
Stats(ofp_stats_types _type, size_t body_len)
Constructor.
void DoCleanup(void *state)
Cleans any state created by the init or dump functions.
int AggregateStatsInit(const void *body, int body_len, void **state)
Initialize the stats.
int DoDump(Ptr< OpenFlowSwitchNetDevice > swtch, void *state, ofpbuf *buffer)
Appends statistics for OpenFlowSwitchNetDevice to 'buffer'.
int DoInit(const void *body, int body_len, void **state)
Prepares to dump some kind of statistics on the connected OpenFlowSwitchNetDevice.
int AggregateStatsDump(Ptr< OpenFlowSwitchNetDevice > dp, ofp_aggregate_stats_request *state, ofpbuf *buffer)
Dump the stats.
int TableStatsDump(Ptr< OpenFlowSwitchNetDevice > dp, void *state, ofpbuf *buffer)
Dump the stats.
int PortStatsDump(Ptr< OpenFlowSwitchNetDevice > dp, PortStatsState *state, ofpbuf *buffer)
Dump the stats.
ofp_stats_types type
Status type.
int FlowStatsInit(const void *body, int body_len, void **state)
Initialize the stats.
int DescStatsDump(void *state, ofpbuf *buffer)
Dumps the stats description.
int(* FlowDumpCallback)(sw_flow *flow, void *state)
Flow dump callback functor.
void ExecuteVPortActions(Ptr< OpenFlowSwitchNetDevice > swtch, uint64_t packet_uid, ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *actions, size_t actions_len)
Executes a list of virtual port table entry actions.
void ExecuteActions(Ptr< OpenFlowSwitchNetDevice > swtch, uint64_t packet_uid, ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *actions, size_t actions_len, int ignore_no_fwd)
Executes a list of flow table actions.
uint16_t ValidateVendor(const sw_flow_key *key, const ofp_action_header *ah, uint16_t len)
Validates a vendor-defined action.
void ExecuteVendor(ofpbuf *buffer, const sw_flow_key *key, const ofp_action_header *ah)
Executes a vendor-defined action.
uint16_t ValidateActions(const sw_flow_key *key, const ofp_action_header *actions, size_t actions_len)
Validates a list of flow table actions.
uint16_t ValidateVPortActions(const ofp_action_header *actions, size_t actions_len)
Validates a list of virtual port table entry actions.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void discard_buffer(uint32_t id)
void strip_vlan(ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah)
void set_mpls_label(ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah)
void set_dl_addr(ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah)
uint32_t save_buffer(ofpbuf *)
void set_nw_addr(ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah)
ofpbuf * retrieve_buffer(uint32_t id)
void set_vlan_pcp(ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah)
void set_tp_port(ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah)
void set_mpls_exp(ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah)
void set_vlan_vid(ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah)
Class for handling flow table actions.
static bool IsValidType(ofp_action_type type)
static uint16_t Validate(ofp_action_type type, size_t len, const sw_flow_key *key, const ofp_action_header *ah)
Validates the action on whether its data is valid or not.
static void Execute(ofp_action_type type, ofpbuf *buffer, sw_flow_key *key, const ofp_action_header *ah)
Executes the action.
Class for handling Ericsson Vendor-defined actions.
static bool IsValidType(er_action_type type)
static uint16_t Validate(er_action_type type, size_t len)
Validates the action on whether its data is valid or not.
static void Execute(er_action_type type, ofpbuf *buffer, const sw_flow_key *key, const er_action_header *ah)
Executes the action.
Port and its metadata.
Ptr< NetDevice > netdev
NetDevice pointer.
unsigned long long int mpls_ttl0_dropped
Counter of packets dropped due to MPLS TTL.
unsigned long long int tx_packets
Counter of Tx packets.
unsigned long long int tx_bytes
Counter of Tx bytes.
unsigned long long int rx_packets
Counter of Rx packets.
unsigned long long int rx_bytes
Counter of Rx bytes.
uint32_t config
Some subset of OFPPC_* flags.
unsigned long long int tx_dropped
Counter of Tx dropped packets.
uint32_t state
Some subset of OFPPS_* flags.
State of the FlowStats request/reply.
ofp_flow_stats_request rq
Stats requests.
sw_table_position position
Table position.
State of the PortStats request/reply.
uint32_t * ports
Array of ports in network byte order.
uint32_t num_ports
Number of ports in host byte order.
Callback for a stats dump request.
ofp_stats_request * rq
Current stats request.
Stats * s
Handler of the stats request.
void * state
Stats request state data.
Ptr< OpenFlowSwitchNetDevice > swtch
The switch that we're requesting data from.
bool done
Whether we are done requesting stats.
Packet Metadata, allows us to track the packet's metadata as it passes through the switch.
Address src
Source Address of the Packet when the Packet is received.
uint16_t protocolNumber
Protocol type of the Packet when the Packet is received.
Address dst
Destination Address of the Packet when the Packet is received.
ofpbuf * buffer
The OpenFlow buffer as created from the Packet, with its data and headers.
Ptr< Packet > packet
The Packet itself.
Class for handling virtual port table actions.
static uint16_t Validate(ofp_vport_action_type type, size_t len, const ofp_action_header *ah)
Validates the action on whether its data is valid or not.
static bool IsValidType(ofp_vport_action_type type)
static void Execute(ofp_vport_action_type type, ofpbuf *buffer, const sw_flow_key *key, const ofp_action_header *ah)
Executes the action.