2 * Copyright (c) 2011 Nicira Networks.
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"
23 #include "meta-flow.h"
27 #include "openflow/openflow.h"
28 #include "unaligned.h"
31 get_be16(const void **pp)
33 const ovs_be16 *p = *pp;
40 get_be32(const void **pp)
42 const ovs_be32 *p = *pp;
43 ovs_be32 value = get_unaligned_be32(p);
49 get_bits(int n_bits, const void **p)
51 int n_segs = DIV_ROUND_UP(n_bits, 16);
55 while (n_segs-- > 0) {
56 value = (value << 16) | ntohs(get_be16(p));
62 learn_min_len(uint16_t header)
64 int n_bits = header & NX_LEARN_N_BITS_MASK;
65 int src_type = header & NX_LEARN_SRC_MASK;
66 int dst_type = header & NX_LEARN_DST_MASK;
70 if (src_type == NX_LEARN_SRC_FIELD) {
71 min_len += sizeof(ovs_be32); /* src_field */
72 min_len += sizeof(ovs_be16); /* src_ofs */
74 min_len += DIV_ROUND_UP(n_bits, 16);
76 if (dst_type == NX_LEARN_DST_MATCH ||
77 dst_type == NX_LEARN_DST_LOAD) {
78 min_len += sizeof(ovs_be32); /* dst_field */
79 min_len += sizeof(ovs_be16); /* dst_ofs */
85 learn_check_header(uint16_t header, size_t len)
87 int src_type = header & NX_LEARN_SRC_MASK;
88 int dst_type = header & NX_LEARN_DST_MASK;
90 /* Check for valid src and dst type combination. */
91 if (dst_type == NX_LEARN_DST_MATCH ||
92 dst_type == NX_LEARN_DST_LOAD ||
93 (dst_type == NX_LEARN_DST_OUTPUT &&
94 src_type == NX_LEARN_SRC_FIELD)) {
97 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
100 /* Check that the arguments don't overrun the end of the action. */
101 if (len < learn_min_len(header)) {
102 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN);
108 /* Checks that 'learn' (which must be at least 'sizeof *learn' bytes long) is a
109 * valid action on 'flow'. */
111 learn_check(const struct nx_action_learn *learn, const struct flow *flow)
113 struct cls_rule rule;
116 cls_rule_init_catchall(&rule, 0);
118 if (learn->flags & ~htons(OFPFF_SEND_FLOW_REM)
119 || !is_all_zeros(learn->pad, sizeof learn->pad)
120 || learn->table_id == 0xff) {
121 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
124 end = (char *) learn + ntohs(learn->len);
125 for (p = learn + 1; p != end; ) {
126 uint16_t header = ntohs(get_be16(&p));
127 int n_bits = header & NX_LEARN_N_BITS_MASK;
128 int src_type = header & NX_LEARN_SRC_MASK;
129 int dst_type = header & NX_LEARN_DST_MASK;
138 error = learn_check_header(header, (char *) end - (char *) p);
143 /* Check the source. */
144 if (src_type == NX_LEARN_SRC_FIELD) {
145 ovs_be32 src_field = get_be32(&p);
146 int src_ofs = ntohs(get_be16(&p));
148 error = nxm_src_check(src_field, src_ofs, n_bits, flow);
154 value = get_bits(n_bits, &p);
157 /* Check the destination. */
158 if (dst_type == NX_LEARN_DST_MATCH || dst_type == NX_LEARN_DST_LOAD) {
159 ovs_be32 dst_field = get_be32(&p);
160 int dst_ofs = ntohs(get_be16(&p));
163 error = nxm_dst_check(dst_field, dst_ofs, n_bits, &rule.flow);
168 if (dst_type == NX_LEARN_DST_MATCH
169 && src_type == NX_LEARN_SRC_IMMEDIATE) {
170 mf_set_subfield(nxm_field_to_mf_field(ntohl(dst_field)), value,
171 dst_ofs, n_bits, &rule);
175 if (!is_all_zeros(p, (char *) end - (char *) p)) {
176 return ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT);
183 learn_execute(const struct nx_action_learn *learn, const struct flow *flow,
184 struct ofputil_flow_mod *fm)
187 struct ofpbuf actions;
189 cls_rule_init_catchall(&fm->cr, ntohs(learn->priority));
190 fm->cookie = learn->cookie;
191 fm->table_id = learn->table_id;
192 fm->command = OFPFC_MODIFY_STRICT;
193 fm->idle_timeout = ntohs(learn->idle_timeout);
194 fm->hard_timeout = ntohs(learn->hard_timeout);
195 fm->buffer_id = UINT32_MAX;
196 fm->out_port = OFPP_NONE;
197 fm->flags = ntohs(learn->flags) & OFPFF_SEND_FLOW_REM;
201 ofpbuf_init(&actions, 64);
203 for (p = learn + 1, end = (char *) learn + ntohs(learn->len); p != end; ) {
204 uint16_t header = ntohs(get_be16(&p));
205 int n_bits = header & NX_LEARN_N_BITS_MASK;
206 int src_type = header & NX_LEARN_SRC_MASK;
207 int dst_type = header & NX_LEARN_DST_MASK;
210 struct nx_action_reg_load *load;
218 if (src_type == NX_LEARN_SRC_FIELD) {
219 ovs_be32 src_field = get_be32(&p);
220 int src_ofs = ntohs(get_be16(&p));
222 value = nxm_read_field_bits(src_field,
223 nxm_encode_ofs_nbits(src_ofs, n_bits),
226 value = get_bits(n_bits, &p);
230 case NX_LEARN_DST_MATCH:
231 dst_field = get_be32(&p);
232 dst_ofs = ntohs(get_be16(&p));
233 mf_set_subfield(nxm_field_to_mf_field(ntohl(dst_field)), value,
234 dst_ofs, n_bits, &fm->cr);
237 case NX_LEARN_DST_LOAD:
238 dst_field = get_be32(&p);
239 dst_ofs = ntohs(get_be16(&p));
240 load = ofputil_put_NXAST_REG_LOAD(&actions);
241 load->ofs_nbits = nxm_encode_ofs_nbits(dst_ofs, n_bits);
242 load->dst = dst_field;
243 load->value = htonll(value);
246 case NX_LEARN_DST_OUTPUT:
247 ofputil_put_OFPAT_OUTPUT(&actions)->port = htons(value);
252 fm->actions = ofpbuf_steal_data(&actions);
253 fm->n_actions = actions.size / sizeof(struct ofp_action_header);
257 put_be16(struct ofpbuf *b, ovs_be16 x)
259 ofpbuf_put(b, &x, sizeof x);
263 put_be32(struct ofpbuf *b, ovs_be32 x)
265 ofpbuf_put(b, &x, sizeof x);
269 put_u16(struct ofpbuf *b, uint16_t x)
271 put_be16(b, htons(x));
275 put_u32(struct ofpbuf *b, uint32_t x)
277 put_be32(b, htonl(x));
284 const struct mf_field *src;
286 uint8_t src_imm[sizeof(union mf_value)];
289 const struct mf_field *dst;
294 learn_parse_spec(const char *orig, char *name, char *value,
295 struct learn_spec *spec)
297 if (mf_from_name(name)) {
298 const struct mf_field *dst = mf_from_name(name);
302 error = mf_parse_value(dst, value, &imm);
304 ovs_fatal(0, "%s", error);
307 spec->n_bits = dst->n_bits;
308 spec->src_type = NX_LEARN_SRC_IMMEDIATE;
311 memcpy(spec->src_imm, &imm, dst->n_bytes);
312 spec->dst_type = NX_LEARN_DST_MATCH;
315 } else if (strchr(name, '[')) {
316 uint32_t src_header, dst_header;
317 int src_ofs, dst_ofs;
320 /* Parse destination and check prerequisites. */
321 if (nxm_parse_field_bits(name, &dst_header, &dst_ofs,
322 &n_bits)[0] != '\0') {
323 ovs_fatal(0, "%s: syntax error after NXM field name `%s'",
327 /* Parse source and check prerequisites. */
328 if (value[0] != '\0') {
331 if (nxm_parse_field_bits(value, &src_header, &src_ofs,
332 &src_nbits)[0] != '\0') {
333 ovs_fatal(0, "%s: syntax error after NXM field name `%s'",
336 if (src_nbits != n_bits) {
337 ovs_fatal(0, "%s: bit widths of %s (%d) and %s (%d) differ",
338 orig, name, dst_header, value, dst_header);
341 src_header = dst_header;
345 spec->n_bits = n_bits;
346 spec->src_type = NX_LEARN_SRC_FIELD;
347 spec->src = nxm_field_to_mf_field(src_header);
348 spec->src_ofs = src_ofs;
349 spec->dst_type = NX_LEARN_DST_MATCH;
350 spec->dst = nxm_field_to_mf_field(dst_header);
352 } else if (!strcmp(name, "load")) {
353 if (value[strcspn(value, "[-")] == '-') {
354 struct nx_action_reg_load load;
355 int nbits, imm_bytes;
359 nxm_parse_reg_load(&load, value);
360 nbits = nxm_decode_n_bits(load.ofs_nbits);
361 imm_bytes = DIV_ROUND_UP(nbits, 8);
362 imm = ntohll(load.value);
364 spec->n_bits = nbits;
365 spec->src_type = NX_LEARN_SRC_IMMEDIATE;
368 for (i = 0; i < imm_bytes; i++) {
369 spec->src_imm[i] = imm >> ((imm_bytes - i - 1) * 8);
371 spec->dst_type = NX_LEARN_DST_LOAD;
372 spec->dst = nxm_field_to_mf_field(ntohl(load.dst));
373 spec->dst_ofs = nxm_decode_ofs(load.ofs_nbits);
375 struct nx_action_reg_move move;
377 nxm_parse_reg_move(&move, value);
379 spec->n_bits = ntohs(move.n_bits);
380 spec->src_type = NX_LEARN_SRC_FIELD;
381 spec->src = nxm_field_to_mf_field(ntohl(move.src));
382 spec->src_ofs = ntohs(move.src_ofs);
383 spec->dst_type = NX_LEARN_DST_LOAD;
384 spec->dst = nxm_field_to_mf_field(ntohl(move.dst));
385 spec->dst_ofs = ntohs(move.dst_ofs);
387 } else if (!strcmp(name, "output")) {
391 if (nxm_parse_field_bits(value, &header, &ofs, &n_bits)[0] != '\0') {
392 ovs_fatal(0, "%s: syntax error after NXM field name `%s'",
396 spec->n_bits = n_bits;
397 spec->src_type = NX_LEARN_SRC_FIELD;
398 spec->src = nxm_field_to_mf_field(header);
400 spec->dst_type = NX_LEARN_DST_OUTPUT;
404 ovs_fatal(0, "%s: unknown keyword %s", orig, name);
409 learn_parse(struct ofpbuf *b, char *arg, const struct flow *flow)
411 char *orig = xstrdup(arg);
416 struct nx_action_learn *learn;
417 struct cls_rule rule;
420 learn = ofputil_put_NXAST_LEARN(b);
421 learn->idle_timeout = htons(OFP_FLOW_PERMANENT);
422 learn->hard_timeout = htons(OFP_FLOW_PERMANENT);
423 learn->priority = htons(OFP_DEFAULT_PRIORITY);
424 learn->cookie = htonll(0);
425 learn->flags = htons(0);
428 cls_rule_init_catchall(&rule, 0);
429 while (ofputil_parse_key_value(&arg, &name, &value)) {
430 learn = ofpbuf_at_assert(b, learn_ofs, sizeof *learn);
431 if (!strcmp(name, "table")) {
432 learn->table_id = atoi(value);
433 if (learn->table_id == 255) {
434 ovs_fatal(0, "%s: table id 255 not valid for `learn' action",
437 } else if (!strcmp(name, "priority")) {
438 learn->priority = htons(atoi(value));
439 } else if (!strcmp(name, "idle_timeout")) {
440 learn->idle_timeout = htons(atoi(value));
441 } else if (!strcmp(name, "hard_timeout")) {
442 learn->hard_timeout = htons(atoi(value));
443 } else if (!strcmp(name, "cookie")) {
444 learn->cookie = htonll(strtoull(value, NULL, 0));
446 struct learn_spec spec;
448 learn_parse_spec(orig, name, value, &spec);
450 /* Check prerequisites. */
451 if (spec.src_type == NX_LEARN_SRC_FIELD
452 && !mf_are_prereqs_ok(spec.src, flow)) {
453 ovs_fatal(0, "%s: cannot specify source field %s because "
454 "prerequisites are not satisfied",
455 orig, spec.src->name);
457 if ((spec.dst_type == NX_LEARN_DST_MATCH
458 || spec.dst_type == NX_LEARN_DST_LOAD)
459 && !mf_are_prereqs_ok(spec.dst, &rule.flow)) {
460 ovs_fatal(0, "%s: cannot specify destination field %s because "
461 "prerequisites are not satisfied",
462 orig, spec.dst->name);
465 /* Update 'rule' to allow for satisfying destination
467 if (spec.src_type == NX_LEARN_SRC_IMMEDIATE
468 && spec.dst_type == NX_LEARN_DST_MATCH
470 && spec.n_bits == spec.dst->n_bytes * 8) {
473 memcpy(&imm, spec.src_imm, spec.dst->n_bytes);
474 mf_set_value(spec.dst, &imm, &rule);
477 /* Output the flow_mod_spec. */
478 put_u16(b, spec.n_bits | spec.src_type | spec.dst_type);
479 if (spec.src_type == NX_LEARN_SRC_IMMEDIATE) {
480 int n_bytes = DIV_ROUND_UP(spec.n_bits, 8);
482 ofpbuf_put_zeros(b, 1);
484 ofpbuf_put(b, spec.src_imm, n_bytes);
486 put_u32(b, spec.src->nxm_header);
487 put_u16(b, spec.src_ofs);
489 if (spec.dst_type == NX_LEARN_DST_MATCH ||
490 spec.dst_type == NX_LEARN_DST_LOAD) {
491 put_u32(b, spec.dst->nxm_header);
492 put_u16(b, spec.dst_ofs);
494 assert(spec.dst_type == NX_LEARN_DST_OUTPUT);
502 len = b->size - learn_ofs;
504 ofpbuf_put_zeros(b, 8 - len % 8);
507 learn = ofpbuf_at_assert(b, learn_ofs, sizeof *learn);
508 learn->len = htons(b->size - learn_ofs);
512 learn_format(const struct nx_action_learn *learn, struct ds *s)
514 struct cls_rule rule;
517 cls_rule_init_catchall(&rule, 0);
519 ds_put_format(s, "learn(table=%"PRIu8, learn->table_id);
520 if (learn->idle_timeout != htons(OFP_FLOW_PERMANENT)) {
521 ds_put_format(s, ",idle_timeout=%"PRIu16, ntohs(learn->idle_timeout));
523 if (learn->hard_timeout != htons(OFP_FLOW_PERMANENT)) {
524 ds_put_format(s, ",hard_timeout=%"PRIu16, ntohs(learn->hard_timeout));
526 if (learn->priority != htons(OFP_DEFAULT_PRIORITY)) {
527 ds_put_format(s, ",priority=%"PRIu16, ntohs(learn->priority));
529 if (learn->flags & htons(OFPFF_SEND_FLOW_REM)) {
530 ds_put_cstr(s, ",OFPFF_SEND_FLOW_REM");
532 if (learn->flags & htons(~OFPFF_SEND_FLOW_REM)) {
533 ds_put_format(s, ",***flags=%"PRIu16"***",
534 ntohs(learn->flags) & ~OFPFF_SEND_FLOW_REM);
536 if (learn->cookie != htonll(0)) {
537 ds_put_format(s, ",cookie=0x%"PRIx64, ntohll(learn->cookie));
539 if (!is_all_zeros(learn->pad, sizeof learn->pad)) {
540 ds_put_cstr(s, ",***nonzero pad***");
543 end = (char *) learn + ntohs(learn->len);
544 for (p = learn + 1; p != end; ) {
545 uint16_t header = ntohs(get_be16(&p));
546 int n_bits = header & NX_LEARN_N_BITS_MASK;
548 int src_type = header & NX_LEARN_SRC_MASK;
551 const uint8_t *src_value;
554 int dst_type = header & NX_LEARN_DST_MASK;
557 const struct mf_field *dst_field;
566 error = learn_check_header(header, (char *) end - (char *) p);
567 if (error == ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT)) {
568 ds_put_format(s, ",***bad flow_mod_spec header %"PRIx16"***)",
571 } else if (error == ofp_mkerr(OFPET_BAD_ACTION, OFPBAC_BAD_LEN)) {
572 ds_put_format(s, ",***flow_mod_spec at offset %td is %u bytes "
573 "long but only %td bytes are left***)",
574 (char *) p - (char *) (learn + 1) - 2,
575 learn_min_len(header) + 2,
576 (char *) end - (char *) p + 2);
581 /* Get the source. */
582 if (src_type == NX_LEARN_SRC_FIELD) {
583 src_header = ntohl(get_be32(&p));
584 src_ofs = ntohs(get_be16(&p));
590 src_value_bytes = 2 * DIV_ROUND_UP(n_bits, 16);
592 p = (const void *) ((const uint8_t *) p + src_value_bytes);
595 /* Get the destination. */
596 if (dst_type == NX_LEARN_DST_MATCH || dst_type == NX_LEARN_DST_LOAD) {
597 dst_header = ntohl(get_be32(&p));
598 dst_field = nxm_field_to_mf_field(dst_header);
599 dst_ofs = ntohs(get_be16(&p));
608 switch (src_type | dst_type) {
609 case NX_LEARN_SRC_IMMEDIATE | NX_LEARN_DST_MATCH:
610 if (dst_field && dst_ofs == 0 && n_bits == dst_field->n_bits) {
611 union mf_value value;
612 uint8_t *bytes = (uint8_t *) &value;
614 memset(&value, 0, sizeof value);
615 memcpy(&bytes[dst_field->n_bytes - src_value_bytes],
616 src_value, src_value_bytes);
617 ds_put_format(s, "%s=", dst_field->name);
618 mf_format(dst_field, &value, NULL, s);
620 nxm_format_field_bits(s, dst_header, dst_ofs, n_bits);
621 ds_put_cstr(s, "=0x");
622 for (i = 0; i < src_value_bytes; i++) {
623 ds_put_format(s, "%02"PRIx8, src_value[i]);
628 case NX_LEARN_SRC_FIELD | NX_LEARN_DST_MATCH:
629 nxm_format_field_bits(s, dst_header, dst_ofs, n_bits);
630 if (src_header != dst_header || src_ofs != dst_ofs) {
632 nxm_format_field_bits(s, src_header, src_ofs, n_bits);
636 case NX_LEARN_SRC_IMMEDIATE | NX_LEARN_DST_LOAD:
637 ds_put_cstr(s, "load:0x");
638 for (i = 0; i < src_value_bytes; i++) {
639 ds_put_format(s, "%02"PRIx8, src_value[i]);
641 ds_put_cstr(s, "->");
642 nxm_format_field_bits(s, dst_header, dst_ofs, n_bits);
645 case NX_LEARN_SRC_FIELD | NX_LEARN_DST_LOAD:
646 ds_put_cstr(s, "load:");
647 nxm_format_field_bits(s, src_header, src_ofs, n_bits);
648 ds_put_cstr(s, "->");
649 nxm_format_field_bits(s, dst_header, dst_ofs, n_bits);
652 case NX_LEARN_SRC_FIELD | NX_LEARN_DST_OUTPUT:
653 ds_put_cstr(s, "output:");
654 nxm_format_field_bits(s, src_header, src_ofs, n_bits);
658 if (!is_all_zeros(p, (char *) end - (char *) p)) {
659 ds_put_cstr(s, ",***nonzero trailer***");