~ubuntu-branches/ubuntu/wily/openvswitch/wily

« back to all changes in this revision

Viewing changes to ofproto/ofproto-dpif.h

  • Committer: Package Import Robot
  • Author(s): James Page
  • Date: 2015-08-10 11:35:15 UTC
  • mfrom: (1.1.30)
  • Revision ID: package-import@ubuntu.com-20150810113515-575vj06oq29emxsn
Tags: 2.4.0~git20150810.97bab95-0ubuntu1
* New upstream snapshot from 2.4 branch:
  - d/*: Align any relevant packaging changes with upstream.
* d/*: wrap-and-sort.
* d/openvswitch-{common,vswitch}.install: Correct install location for
  bash completion files.
* d/tests/openflow.py: Explicitly use ovs-testcontroller as provided
  by 2.4.0 release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
/* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
 
1
/* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
2
2
 *
3
3
 * Licensed under the Apache License, Version 2.0 (the "License");
4
4
 * you may not use this file except in compliance with the License.
27
27
#include "util.h"
28
28
#include "ovs-thread.h"
29
29
 
 
30
/* Priority for internal rules created to handle recirculation */
 
31
#define RECIRC_RULE_PRIORITY 20
 
32
 
30
33
union user_action_cookie;
31
34
struct dpif_flow_stats;
32
35
struct ofproto;
37
40
struct OVS_LOCKABLE rule_dpif;
38
41
struct OVS_LOCKABLE group_dpif;
39
42
 
40
 
enum rule_dpif_lookup_verdict {
41
 
    RULE_DPIF_LOOKUP_VERDICT_MATCH,         /* A match occurred. */
42
 
    RULE_DPIF_LOOKUP_VERDICT_CONTROLLER,    /* A miss occurred and the packet
43
 
                                             * should be passed to
44
 
                                             * the controller. */
45
 
    RULE_DPIF_LOOKUP_VERDICT_DROP,          /* A miss occurred and the packet
46
 
                                             * should be dropped. */
47
 
    RULE_DPIF_LOOKUP_VERDICT_DEFAULT,       /* A miss occurred and the packet
48
 
                                             * should handled by the default
49
 
                                             * miss behaviour.
50
 
                                             * For pre-OF1.3 it should be
51
 
                                             * forwarded to the controller.
52
 
                                             * For OF1.3+ it should be
53
 
                                             * dropped. */
54
 
};
55
 
 
56
43
/* Number of implemented OpenFlow tables. */
57
44
enum { N_TABLES = 255 };
58
45
enum { TBL_INTERNAL = N_TABLES - 1 };    /* Used for internal hidden rules. */
59
46
BUILD_ASSERT_DECL(N_TABLES >= 2 && N_TABLES <= 255);
60
47
 
61
 
/* For lock annotation below only. */
62
 
extern struct fat_rwlock xlate_rwlock;
63
 
 
64
48
/* Ofproto-dpif -- DPIF based ofproto implementation.
65
49
 *
66
50
 * Ofproto-dpif provides an ofproto implementation for those platforms which
89
73
 *   Ofproto-dpif-xlate is responsible for translating OpenFlow actions into
90
74
 *   datapath actions. */
91
75
 
 
76
/* Stores the various features which the corresponding backer supports. */
 
77
struct dpif_backer_support {
 
78
    /* True if the datapath supports variable-length
 
79
     * OVS_USERSPACE_ATTR_USERDATA in OVS_ACTION_ATTR_USERSPACE actions.
 
80
     * False if the datapath supports only 8-byte (or shorter) userdata. */
 
81
    bool variable_length_userdata;
 
82
 
 
83
    /* Maximum number of MPLS label stack entries that the datapath supports
 
84
     * in a match */
 
85
    size_t max_mpls_depth;
 
86
 
 
87
    /* True if the datapath supports masked data in OVS_ACTION_ATTR_SET
 
88
     * actions. */
 
89
    bool masked_set_action;
 
90
 
 
91
    /* True if the datapath supports recirculation. */
 
92
    bool recirc;
 
93
 
 
94
    /* True if the datapath supports tnl_push and pop actions. */
 
95
    bool tnl_push_pop;
 
96
 
 
97
    /* True if the datapath supports OVS_FLOW_ATTR_UFID. */
 
98
    bool ufid;
 
99
};
 
100
 
92
101
size_t ofproto_dpif_get_max_mpls_depth(const struct ofproto_dpif *);
93
102
bool ofproto_dpif_get_enable_recirc(const struct ofproto_dpif *);
94
 
 
95
 
uint8_t rule_dpif_lookup(struct ofproto_dpif *, struct flow *,
96
 
                         struct flow_wildcards *, struct rule_dpif **rule,
97
 
                         bool take_ref);
98
 
 
99
 
/* If 'recirc_id' is set, starts looking up from internal table for
100
 
 * post recirculation flows or packets.  Otherwise, starts from table 0. */
101
 
static inline uint8_t
102
 
rule_dpif_lookup_get_init_table_id(const struct flow *flow)
103
 
{
104
 
    return flow->recirc_id ? TBL_INTERNAL : 0;
105
 
}
106
 
 
107
 
enum rule_dpif_lookup_verdict rule_dpif_lookup_from_table(struct ofproto_dpif *,
108
 
                                                          const struct flow *,
109
 
                                                          struct flow_wildcards *,
110
 
                                                          bool force_controller_on_miss,
111
 
                                                          uint8_t *table_id,
112
 
                                                          struct rule_dpif **rule, 
113
 
                                                          bool take_ref);
 
103
bool ofproto_dpif_get_enable_ufid(struct dpif_backer *backer);
 
104
 
 
105
cls_version_t ofproto_dpif_get_tables_version(struct ofproto_dpif *);
 
106
 
 
107
struct rule_dpif *rule_dpif_lookup_from_table(struct ofproto_dpif *,
 
108
                                              cls_version_t, struct flow *,
 
109
                                              struct flow_wildcards *,
 
110
                                              bool take_ref,
 
111
                                              const struct dpif_flow_stats *,
 
112
                                              uint8_t *table_id,
 
113
                                              ofp_port_t in_port,
 
114
                                              bool may_packet_in,
 
115
                                              bool honor_table_miss);
114
116
 
115
117
static inline void rule_dpif_ref(struct rule_dpif *);
116
118
static inline void rule_dpif_unref(struct rule_dpif *);
127
129
bool table_is_internal(uint8_t table_id);
128
130
 
129
131
const struct rule_actions *rule_dpif_get_actions(const struct rule_dpif *);
 
132
void rule_set_recirc_id(struct rule *, uint32_t id);
130
133
 
131
134
ovs_be64 rule_dpif_get_flow_cookie(const struct rule_dpif *rule);
132
135
 
138
141
                      struct rule_dpif *no_packet_in_rule,
139
142
                      struct rule_dpif **rule, bool take_ref);
140
143
 
 
144
void group_dpif_credit_stats(struct group_dpif *,
 
145
                             struct ofputil_bucket *,
 
146
                             const struct dpif_flow_stats *);
141
147
bool group_dpif_lookup(struct ofproto_dpif *ofproto, uint32_t group_id,
142
148
                       struct group_dpif **group);
143
149
 
144
 
void group_dpif_release(struct group_dpif *group);
145
 
 
146
150
void group_dpif_get_buckets(const struct group_dpif *group,
147
 
                            const struct list **buckets);
 
151
                            const struct ovs_list **buckets);
148
152
enum ofp11_group_type group_dpif_get_type(const struct group_dpif *group);
 
153
const char *group_dpif_get_selection_method(const struct group_dpif *group);
 
154
uint64_t group_dpif_get_selection_method_param(const struct group_dpif *group);
 
155
const struct field_array *group_dpif_get_fields(const struct group_dpif *group);
149
156
 
150
157
bool ofproto_has_vlan_splinters(const struct ofproto_dpif *);
151
158
ofp_port_t vsp_realdev_to_vlandev(const struct ofproto_dpif *,
152
159
                                  ofp_port_t realdev_ofp_port,
153
160
                                  ovs_be16 vlan_tci);
154
 
bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *);
 
161
bool vsp_adjust_flow(const struct ofproto_dpif *, struct flow *,
 
162
                     struct dp_packet *packet);
155
163
 
156
164
int ofproto_dpif_execute_actions(struct ofproto_dpif *, const struct flow *,
157
165
                                 struct rule_dpif *, const struct ofpact *,
158
 
                                 size_t ofpacts_len, struct ofpbuf *)
159
 
    OVS_EXCLUDED(xlate_rwlock);
 
166
                                 size_t ofpacts_len, struct dp_packet *);
160
167
void ofproto_dpif_send_packet_in(struct ofproto_dpif *,
161
168
                                 struct ofproto_packet_in *);
162
169
bool ofproto_dpif_wants_packet_in_on_miss(struct ofproto_dpif *);
163
 
int ofproto_dpif_send_packet(const struct ofport_dpif *, struct ofpbuf *);
 
170
int ofproto_dpif_send_packet(const struct ofport_dpif *, struct dp_packet *);
164
171
void ofproto_dpif_flow_mod(struct ofproto_dpif *, struct ofputil_flow_mod *);
165
172
struct rule_dpif *ofproto_dpif_refresh_rule(struct rule_dpif *);
166
173
 
167
174
struct ofport_dpif *odp_port_to_ofport(const struct dpif_backer *, odp_port_t);
168
 
 
169
 
/*
170
 
 * Recirculation
171
 
 * =============
172
 
 *
173
 
 * Recirculation is a technique to allow a frame to re-enter the packet
174
 
 * processing path for one or multiple times to achieve more flexible packet
175
 
 * processing in the data path. MPLS handling and selecting bond slave port
176
 
 * of a bond ports.
177
 
 *
178
 
 * Data path and user space interface
179
 
 * -----------------------------------
180
 
 *
181
 
 * Two new fields, recirc_id and dp_hash, are added to the current flow data
182
 
 * structure. They are both of type uint32_t. In addition, a new action,
183
 
 * RECIRC, are added.
184
 
 *
185
 
 * The value recirc_id is used to distinguish a packet from multiple
186
 
 * iterations of recirculation. A packet initially received is considered of
187
 
 * having recirc_id of 0. Recirc_id is managed by the user space, opaque to
188
 
 * the data path.
189
 
 *
190
 
 * On the other hand, dp_hash can only be computed by the data path, opaque to
191
 
 * the user space. In fact, user space may not able to recompute the hash
192
 
 * value. The dp_hash value should be wildcarded when for a newly received
193
 
 * packet. RECIRC action specifies whether the hash is computed. If computed,
194
 
 * how many fields to be included in the hash computation. The computed hash
195
 
 * value is stored into the dp_hash field prior to recirculation.
196
 
 *
197
 
 * The RECIRC action computes and set the dp_hash field, set the recirc_id
198
 
 * field and then reprocess the packet as if it was received on the same input
199
 
 * port. RECIRC action works like a function call; actions listed behind the
200
 
 * RECIRC action will be executed after its execution.  RECIRC action can be
201
 
 * nested, data path implementation limits the number of recirculation executed
202
 
 * to prevent unreasonable nesting depth or infinite loop.
203
 
 *
204
 
 * Both flow fields and the RECIRC action are exposed as open flow fields via
205
 
 * Nicira extensions.
206
 
 *
207
 
 * Post recirculation flow
208
 
 * ------------------------
209
 
 *
210
 
 * At the open flow level, post recirculation rules are always hidden from the
211
 
 * controller.  They are installed in table 254 which is set up as a hidden
212
 
 * table during boot time. Those rules are managed by the local user space
213
 
 * program only.
214
 
 *
215
 
 * To speed up the classifier look up process, recirc_id is always reflected
216
 
 * into the metadata field, since recirc_id is required to be exactly matched.
217
 
 *
218
 
 * Classifier look up always starts with table 254. A post recirculation flow
219
 
 * lookup should find its hidden rule within this table. On the other hand, A
220
 
 * newly received packet should miss all post recirculation rules because its
221
 
 * recirc_id is zero, then hit a pre-installed lower priority rule to redirect
222
 
 * classifier to look up starting from table 0:
223
 
 *
224
 
 *       * , actions=resubmit(,0)
225
 
 *
226
 
 * Post recirculation data path flows are managed like other data path flows.
227
 
 * They are created on demand. Miss handling, stats collection and revalidation
228
 
 * work the same way as regular flows.
229
 
 *
230
 
 * If the bridge which originates the recirculation is different from the bridge
231
 
 * that receives the post recirculation packet (e.g. when patch port is used),
232
 
 * the packet will be processed directly by the recirculation bridge with
233
 
 * in_port set to OFPP_NONE.  Admittedly, doing this limits the recirculation
234
 
 * bridge from matching on in_port of post recirculation packets, and will be
235
 
 * fixed in the near future.
236
 
 *
237
 
 * TODO: Always restore the correct in_port.
238
 
 *
239
 
 */
240
 
 
241
 
struct ofproto_dpif *ofproto_dpif_recirc_get_ofproto(const struct dpif_backer *ofproto,
242
 
                                                     uint32_t recirc_id);
243
 
uint32_t ofproto_dpif_alloc_recirc_id(struct ofproto_dpif *ofproto);
244
 
void ofproto_dpif_free_recirc_id(struct ofproto_dpif *ofproto, uint32_t recirc_id);
 
175
struct ofport_dpif *ofp_port_to_ofport(const struct ofproto_dpif *,
 
176
                                       ofp_port_t);
 
177
 
245
178
int ofproto_dpif_add_internal_flow(struct ofproto_dpif *,
246
179
                                   const struct match *, int priority,
 
180
                                   uint16_t idle_timeout,
247
181
                                   const struct ofpbuf *ofpacts,
248
182
                                   struct rule **rulep);
249
183
int ofproto_dpif_delete_internal_flow(struct ofproto_dpif *, struct match *,
251
185
 
252
186
/* struct rule_dpif has struct rule as it's first member. */
253
187
#define RULE_CAST(RULE) ((struct rule *)RULE)
 
188
#define GROUP_CAST(GROUP) ((struct ofgroup *)GROUP)
 
189
 
 
190
static inline struct group_dpif* group_dpif_ref(struct group_dpif *group)
 
191
{
 
192
    if (group) {
 
193
        ofproto_group_ref(GROUP_CAST(group));
 
194
    }
 
195
    return group;
 
196
}
 
197
 
 
198
static inline void group_dpif_unref(struct group_dpif *group)
 
199
{
 
200
    if (group) {
 
201
        ofproto_group_unref(GROUP_CAST(group));
 
202
    }
 
203
}
254
204
 
255
205
static inline void rule_dpif_ref(struct rule_dpif *rule)
256
206
{
259
209
    }
260
210
}
261
211
 
 
212
static inline bool rule_dpif_try_ref(struct rule_dpif *rule)
 
213
{
 
214
    if (rule) {
 
215
        return ofproto_rule_try_ref(RULE_CAST(rule));
 
216
    }
 
217
    return false;
 
218
}
 
219
 
 
220
 
262
221
static inline void rule_dpif_unref(struct rule_dpif *rule)
263
222
{
264
223
    if (rule) {
284
243
 
285
244
#undef RULE_CAST
286
245
 
 
246
bool ovs_native_tunneling_is_on(struct ofproto_dpif *ofproto);
287
247
#endif /* ofproto-dpif.h */