2 * Copyright (c) 2011, 2012, 2013, 2014 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
21 #include "byte-order.h"
22 #include "dynamic-string.h"
24 #include "meta-flow.h"
26 #include "ofp-actions.h"
27 #include "ofp-errors.h"
30 #include "openflow/openflow.h"
31 #include "unaligned.h"
34 /* Checks that 'learn' is a valid action on 'flow'. Returns 0 if it is valid,
35 * otherwise an OFPERR_*. */
37 learn_check(const struct ofpact_learn *learn, const struct flow *flow)
39 const struct ofpact_learn_spec *spec;
42 match_init_catchall(&match);
43 for (spec = learn->specs; spec < &learn->specs[learn->n_specs]; spec++) {
46 /* Check the source. */
47 if (spec->src_type == NX_LEARN_SRC_FIELD) {
48 error = mf_check_src(&spec->src, flow);
54 /* Check the destination. */
55 switch (spec->dst_type) {
56 case NX_LEARN_DST_MATCH:
57 error = mf_check_src(&spec->dst, &match.flow);
62 mf_write_subfield(&spec->dst, &spec->src_imm, &match);
65 case NX_LEARN_DST_LOAD:
66 error = mf_check_dst(&spec->dst, &match.flow);
72 case NX_LEARN_DST_OUTPUT:
80 /* Composes 'fm' so that executing it will implement 'learn' given that the
81 * packet being processed has 'flow' as its flow.
83 * Uses 'ofpacts' to store the flow mod's actions. The caller must initialize
84 * 'ofpacts' and retains ownership of it. 'fm->ofpacts' will point into the
87 * The caller has to actually execute 'fm'. */
89 learn_execute(const struct ofpact_learn *learn, const struct flow *flow,
90 struct ofputil_flow_mod *fm, struct ofpbuf *ofpacts)
92 const struct ofpact_learn_spec *spec;
94 match_init_catchall(&fm->match);
95 fm->priority = learn->priority;
96 fm->cookie = htonll(0);
97 fm->cookie_mask = htonll(0);
98 fm->new_cookie = learn->cookie;
99 fm->modify_cookie = fm->new_cookie != OVS_BE64_MAX;
100 fm->table_id = learn->table_id;
101 fm->command = OFPFC_MODIFY_STRICT;
102 fm->idle_timeout = learn->idle_timeout;
103 fm->hard_timeout = learn->hard_timeout;
104 fm->buffer_id = UINT32_MAX;
105 fm->out_port = OFPP_NONE;
107 if (learn->flags & NX_LEARN_F_SEND_FLOW_REM) {
108 fm->flags |= OFPUTIL_FF_SEND_FLOW_REM;
112 fm->delete_reason = OFPRR_DELETE;
114 if (learn->fin_idle_timeout || learn->fin_hard_timeout) {
115 struct ofpact_fin_timeout *oft;
117 oft = ofpact_put_FIN_TIMEOUT(ofpacts);
118 oft->fin_idle_timeout = learn->fin_idle_timeout;
119 oft->fin_hard_timeout = learn->fin_hard_timeout;
122 for (spec = learn->specs; spec < &learn->specs[learn->n_specs]; spec++) {
123 union mf_subvalue value;
126 if (spec->src_type == NX_LEARN_SRC_FIELD) {
127 mf_read_subfield(&spec->src, flow, &value);
129 value = spec->src_imm;
132 switch (spec->dst_type) {
133 case NX_LEARN_DST_MATCH:
134 mf_write_subfield(&spec->dst, &value, &fm->match);
137 case NX_LEARN_DST_LOAD:
138 for (ofs = 0; ofs < spec->n_bits; ofs += chunk) {
139 struct ofpact_reg_load *load;
141 chunk = MIN(spec->n_bits - ofs, 64);
143 load = ofpact_put_REG_LOAD(ofpacts);
144 load->dst.field = spec->dst.field;
145 load->dst.ofs = spec->dst.ofs + ofs;
146 load->dst.n_bits = chunk;
147 bitwise_copy(&value, sizeof value, ofs,
148 &load->subvalue, sizeof load->subvalue, 0,
153 case NX_LEARN_DST_OUTPUT:
154 if (spec->n_bits <= 16
155 || is_all_zeros(value.u8, sizeof value - 2)) {
156 ofp_port_t port = u16_to_ofp(ntohs(value.be16[7]));
158 if (ofp_to_u16(port) < ofp_to_u16(OFPP_MAX)
159 || port == OFPP_IN_PORT
160 || port == OFPP_FLOOD
161 || port == OFPP_LOCAL
162 || port == OFPP_ALL) {
163 ofpact_put_OUTPUT(ofpacts)->port = port;
171 fm->ofpacts = ofpbuf_data(ofpacts);
172 fm->ofpacts_len = ofpbuf_size(ofpacts);
175 /* Perform a bitwise-OR on 'wc''s fields that are relevant as sources in
176 * the learn action 'learn'. */
178 learn_mask(const struct ofpact_learn *learn, struct flow_wildcards *wc)
180 const struct ofpact_learn_spec *spec;
181 union mf_subvalue value;
183 memset(&value, 0xff, sizeof value);
184 for (spec = learn->specs; spec < &learn->specs[learn->n_specs]; spec++) {
185 if (spec->src_type == NX_LEARN_SRC_FIELD) {
186 mf_write_subfield_flow(&spec->src, &value, &wc->masks);
191 /* Returns NULL if successful, otherwise a malloc()'d string describing the
192 * error. The caller is responsible for freeing the returned string. */
193 static char * WARN_UNUSED_RESULT
194 learn_parse_load_immediate(const char *s, struct ofpact_learn_spec *spec)
196 const char *full_s = s;
197 const char *arrow = strstr(s, "->");
198 struct mf_subfield dst;
199 union mf_subvalue imm;
202 memset(&imm, 0, sizeof imm);
203 if (s[0] == '0' && (s[1] == 'x' || s[1] == 'X') && arrow) {
204 const char *in = arrow - 1;
205 uint8_t *out = imm.u8 + sizeof imm.u8 - 1;
206 int n = arrow - (s + 2);
209 for (i = 0; i < n; i++) {
210 int hexit = hexit_value(in[-i]);
212 return xasprintf("%s: bad hex digit in value", full_s);
214 out[-(i / 2)] |= i % 2 ? hexit << 4 : hexit;
218 imm.be64[1] = htonll(strtoull(s, (char **) &s, 0));
221 if (strncmp(s, "->", 2)) {
222 return xasprintf("%s: missing `->' following value", full_s);
226 error = mf_parse_subfield(&dst, s);
231 if (!bitwise_is_all_zeros(&imm, sizeof imm, dst.n_bits,
232 (8 * sizeof imm) - dst.n_bits)) {
233 return xasprintf("%s: value does not fit into %u bits",
237 spec->n_bits = dst.n_bits;
238 spec->src_type = NX_LEARN_SRC_IMMEDIATE;
240 spec->dst_type = NX_LEARN_DST_LOAD;
245 /* Returns NULL if successful, otherwise a malloc()'d string describing the
246 * error. The caller is responsible for freeing the returned string. */
247 static char * WARN_UNUSED_RESULT
248 learn_parse_spec(const char *orig, char *name, char *value,
249 struct ofpact_learn_spec *spec)
251 if (mf_from_name(name)) {
252 const struct mf_field *dst = mf_from_name(name);
256 error = mf_parse_value(dst, value, &imm);
261 spec->n_bits = dst->n_bits;
262 spec->src_type = NX_LEARN_SRC_IMMEDIATE;
263 memset(&spec->src_imm, 0, sizeof spec->src_imm);
264 memcpy(&spec->src_imm.u8[sizeof spec->src_imm - dst->n_bytes],
266 spec->dst_type = NX_LEARN_DST_MATCH;
267 spec->dst.field = dst;
269 spec->dst.n_bits = dst->n_bits;
270 } else if (strchr(name, '[')) {
271 /* Parse destination and check prerequisites. */
274 error = mf_parse_subfield(&spec->dst, name);
279 /* Parse source and check prerequisites. */
280 if (value[0] != '\0') {
281 error = mf_parse_subfield(&spec->src, value);
285 if (spec->src.n_bits != spec->dst.n_bits) {
286 return xasprintf("%s: bit widths of %s (%u) and %s (%u) "
287 "differ", orig, name, spec->src.n_bits, value,
291 spec->src = spec->dst;
294 spec->n_bits = spec->src.n_bits;
295 spec->src_type = NX_LEARN_SRC_FIELD;
296 spec->dst_type = NX_LEARN_DST_MATCH;
297 } else if (!strcmp(name, "load")) {
298 if (value[strcspn(value, "[-")] == '-') {
299 char *error = learn_parse_load_immediate(value, spec);
304 struct ofpact_reg_move move;
307 error = nxm_parse_reg_move(&move, value);
312 spec->n_bits = move.src.n_bits;
313 spec->src_type = NX_LEARN_SRC_FIELD;
314 spec->src = move.src;
315 spec->dst_type = NX_LEARN_DST_LOAD;
316 spec->dst = move.dst;
318 } else if (!strcmp(name, "output")) {
319 char *error = mf_parse_subfield(&spec->src, value);
324 spec->n_bits = spec->src.n_bits;
325 spec->src_type = NX_LEARN_SRC_FIELD;
326 spec->dst_type = NX_LEARN_DST_OUTPUT;
328 return xasprintf("%s: unknown keyword %s", orig, name);
334 /* Returns NULL if successful, otherwise a malloc()'d string describing the
335 * error. The caller is responsible for freeing the returned string. */
336 static char * WARN_UNUSED_RESULT
337 learn_parse__(char *orig, char *arg, struct ofpbuf *ofpacts)
339 struct ofpact_learn *learn;
343 learn = ofpact_put_LEARN(ofpacts);
344 learn->idle_timeout = OFP_FLOW_PERMANENT;
345 learn->hard_timeout = OFP_FLOW_PERMANENT;
346 learn->priority = OFP_DEFAULT_PRIORITY;
349 match_init_catchall(&match);
350 while (ofputil_parse_key_value(&arg, &name, &value)) {
351 if (!strcmp(name, "table")) {
352 learn->table_id = atoi(value);
353 if (learn->table_id == 255) {
354 return xasprintf("%s: table id 255 not valid for `learn' "
357 } else if (!strcmp(name, "priority")) {
358 learn->priority = atoi(value);
359 } else if (!strcmp(name, "idle_timeout")) {
360 learn->idle_timeout = atoi(value);
361 } else if (!strcmp(name, "hard_timeout")) {
362 learn->hard_timeout = atoi(value);
363 } else if (!strcmp(name, "fin_idle_timeout")) {
364 learn->fin_idle_timeout = atoi(value);
365 } else if (!strcmp(name, "fin_hard_timeout")) {
366 learn->fin_hard_timeout = atoi(value);
367 } else if (!strcmp(name, "cookie")) {
368 learn->cookie = htonll(strtoull(value, NULL, 0));
369 } else if (!strcmp(name, "send_flow_rem")) {
370 learn->flags |= NX_LEARN_F_SEND_FLOW_REM;
371 } else if (!strcmp(name, "delete_learned")) {
372 learn->flags |= NX_LEARN_F_DELETE_LEARNED;
374 struct ofpact_learn_spec *spec;
377 spec = ofpbuf_put_zeros(ofpacts, sizeof *spec);
378 learn = ofpacts->frame;
381 error = learn_parse_spec(orig, name, value, spec);
386 /* Update 'match' to allow for satisfying destination
388 if (spec->src_type == NX_LEARN_SRC_IMMEDIATE
389 && spec->dst_type == NX_LEARN_DST_MATCH) {
390 mf_write_subfield(&spec->dst, &spec->src_imm, &match);
394 ofpact_update_len(ofpacts, &learn->ofpact);
399 /* Parses 'arg' as a set of arguments to the "learn" action and appends a
400 * matching OFPACT_LEARN action to 'ofpacts'. ovs-ofctl(8) describes the
403 * Returns NULL if successful, otherwise a malloc()'d string describing the
404 * error. The caller is responsible for freeing the returned string.
406 * If 'flow' is nonnull, then it should be the flow from a struct match that is
407 * the matching rule for the learning action. This helps to better validate
408 * the action's arguments.
411 char * WARN_UNUSED_RESULT
412 learn_parse(char *arg, struct ofpbuf *ofpacts)
414 char *orig = xstrdup(arg);
415 char *error = learn_parse__(orig, arg, ofpacts);
420 /* Appends a description of 'learn' to 's', in the format that ovs-ofctl(8)
423 learn_format(const struct ofpact_learn *learn, struct ds *s)
425 const struct ofpact_learn_spec *spec;
428 match_init_catchall(&match);
430 ds_put_format(s, "learn(table=%"PRIu8, learn->table_id);
431 if (learn->idle_timeout != OFP_FLOW_PERMANENT) {
432 ds_put_format(s, ",idle_timeout=%"PRIu16, learn->idle_timeout);
434 if (learn->hard_timeout != OFP_FLOW_PERMANENT) {
435 ds_put_format(s, ",hard_timeout=%"PRIu16, learn->hard_timeout);
437 if (learn->fin_idle_timeout) {
438 ds_put_format(s, ",fin_idle_timeout=%"PRIu16, learn->fin_idle_timeout);
440 if (learn->fin_hard_timeout) {
441 ds_put_format(s, ",fin_hard_timeout=%"PRIu16, learn->fin_hard_timeout);
443 if (learn->priority != OFP_DEFAULT_PRIORITY) {
444 ds_put_format(s, ",priority=%"PRIu16, learn->priority);
446 if (learn->flags & NX_LEARN_F_SEND_FLOW_REM) {
447 ds_put_cstr(s, ",send_flow_rem");
449 if (learn->flags & NX_LEARN_F_DELETE_LEARNED) {
450 ds_put_cstr(s, ",delete_learned");
452 if (learn->cookie != 0) {
453 ds_put_format(s, ",cookie=%#"PRIx64, ntohll(learn->cookie));
456 for (spec = learn->specs; spec < &learn->specs[learn->n_specs]; spec++) {
459 switch (spec->src_type | spec->dst_type) {
460 case NX_LEARN_SRC_IMMEDIATE | NX_LEARN_DST_MATCH:
461 if (spec->dst.ofs == 0
462 && spec->dst.n_bits == spec->dst.field->n_bits) {
463 union mf_value value;
465 memset(&value, 0, sizeof value);
466 bitwise_copy(&spec->src_imm, sizeof spec->src_imm, 0,
467 &value, spec->dst.field->n_bytes, 0,
468 spec->dst.field->n_bits);
469 ds_put_format(s, "%s=", spec->dst.field->name);
470 mf_format(spec->dst.field, &value, NULL, s);
472 mf_format_subfield(&spec->dst, s);
474 mf_format_subvalue(&spec->src_imm, s);
478 case NX_LEARN_SRC_FIELD | NX_LEARN_DST_MATCH:
479 mf_format_subfield(&spec->dst, s);
480 if (spec->src.field != spec->dst.field ||
481 spec->src.ofs != spec->dst.ofs) {
483 mf_format_subfield(&spec->src, s);
487 case NX_LEARN_SRC_IMMEDIATE | NX_LEARN_DST_LOAD:
488 ds_put_format(s, "load:");
489 mf_format_subvalue(&spec->src_imm, s);
490 ds_put_cstr(s, "->");
491 mf_format_subfield(&spec->dst, s);
494 case NX_LEARN_SRC_FIELD | NX_LEARN_DST_LOAD:
495 ds_put_cstr(s, "load:");
496 mf_format_subfield(&spec->src, s);
497 ds_put_cstr(s, "->");
498 mf_format_subfield(&spec->dst, s);
501 case NX_LEARN_SRC_FIELD | NX_LEARN_DST_OUTPUT:
502 ds_put_cstr(s, "output:");
503 mf_format_subfield(&spec->src, s);