lib/ofp-actions.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #include <config.h>
  18 #include "ofp-actions.h"
  19 #include "autopath.h"
  20 #include "bundle.h"
  21 #include "byte-order.h"
  22 #include "compiler.h"
  23 #include "dynamic-string.h"
  24 #include "learn.h"
  25 #include "meta-flow.h"
  26 #include "multipath.h"
  27 #include "nx-match.h"
  28 #include "ofp-util.h"
  29 #include "ofpbuf.h"
  30 #include "vlog.h"
  31
  32 VLOG_DEFINE_THIS_MODULE(ofp_actions);
  33
  34 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
  35 \f
  36 /* Converting OpenFlow 1.0 to ofpacts. */
  37
  38 static enum ofperr
  39 output_from_openflow10(const struct ofp10_action_output *oao,
  40                        struct ofpbuf *out)
  41 {
  42     struct ofpact_output *output;
  43
  44     output = ofpact_put_OUTPUT(out);
  45     output->port = ntohs(oao->port);
  46     output->max_len = ntohs(oao->max_len);
  47
  48     return ofputil_check_output_port(output->port, OFPP_MAX);
  49 }
  50
  51 static enum ofperr
  52 enqueue_from_openflow10(const struct ofp_action_enqueue *oae,
  53                         struct ofpbuf *out)
  54 {
  55     struct ofpact_enqueue *enqueue;
  56
  57     enqueue = ofpact_put_ENQUEUE(out);
  58     enqueue->port = ntohs(oae->port);
  59     enqueue->queue = ntohl(oae->queue_id);
  60     if (enqueue->port >= OFPP_MAX && enqueue->port != OFPP_IN_PORT
  61         && enqueue->port != OFPP_LOCAL) {
  62         return OFPERR_OFPBAC_BAD_OUT_PORT;
  63     }
  64     return 0;
  65 }
  66
  67 static void
  68 resubmit_from_openflow(const struct nx_action_resubmit *nar,
  69                        struct ofpbuf *out)
  70 {
  71     struct ofpact_resubmit *resubmit;
  72
  73     resubmit = ofpact_put_RESUBMIT(out);
  74     resubmit->ofpact.compat = OFPUTIL_NXAST_RESUBMIT;
  75     resubmit->in_port = ntohs(nar->in_port);
  76     resubmit->table_id = 0xff;
  77 }
  78
  79 static enum ofperr
  80 resubmit_table_from_openflow(const struct nx_action_resubmit *nar,
  81                              struct ofpbuf *out)
  82 {
  83     struct ofpact_resubmit *resubmit;
  84
  85     if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
  86         return OFPERR_OFPBAC_BAD_ARGUMENT;
  87     }
  88
  89     resubmit = ofpact_put_RESUBMIT(out);
  90     resubmit->ofpact.compat = OFPUTIL_NXAST_RESUBMIT_TABLE;
  91     resubmit->in_port = ntohs(nar->in_port);
  92     resubmit->table_id = nar->table;
  93     return 0;
  94 }
  95
  96 static enum ofperr
  97 output_reg_from_openflow(const struct nx_action_output_reg *naor,
  98                          struct ofpbuf *out)
  99 {
 100     struct ofpact_output_reg *output_reg;
 101
 102     if (!is_all_zeros(naor->zero, sizeof naor->zero)) {
 103         return OFPERR_OFPBAC_BAD_ARGUMENT;
 104     }
 105
 106     output_reg = ofpact_put_OUTPUT_REG(out);
 107     output_reg->src.field = mf_from_nxm_header(ntohl(naor->src));
 108     output_reg->src.ofs = nxm_decode_ofs(naor->ofs_nbits);
 109     output_reg->src.n_bits = nxm_decode_n_bits(naor->ofs_nbits);
 110     output_reg->max_len = ntohs(naor->max_len);
 111
 112     return mf_check_src(&output_reg->src, NULL);
 113 }
 114
 115 static void
 116 fin_timeout_from_openflow(const struct nx_action_fin_timeout *naft,
 117                           struct ofpbuf *out)
 118 {
 119     struct ofpact_fin_timeout *oft;
 120
 121     oft = ofpact_put_FIN_TIMEOUT(out);
 122     oft->fin_idle_timeout = ntohs(naft->fin_idle_timeout);
 123     oft->fin_hard_timeout = ntohs(naft->fin_hard_timeout);
 124 }
 125
 126 static void
 127 controller_from_openflow(const struct nx_action_controller *nac,
 128                          struct ofpbuf *out)
 129 {
 130     struct ofpact_controller *oc;
 131
 132     oc = ofpact_put_CONTROLLER(out);
 133     oc->max_len = ntohs(nac->max_len);
 134     oc->controller_id = ntohs(nac->controller_id);
 135     oc->reason = nac->reason;
 136 }
 137
 138 static void
 139 note_from_openflow(const struct nx_action_note *nan, struct ofpbuf *out)
 140 {
 141     struct ofpact_note *note;
 142     unsigned int length;
 143
 144     length = ntohs(nan->len) - offsetof(struct nx_action_note, note);
 145     note = ofpact_put(out, OFPACT_NOTE,
 146                       offsetof(struct ofpact_note, data) + length);
 147     note->length = length;
 148     memcpy(note->data, nan->note, length);
 149 }
 150
 151 static enum ofperr
 152 dec_ttl_from_openflow(struct ofpbuf *out)
 153 {
 154     uint16_t id = 0;
 155     struct ofpact_cnt_ids *ids;
 156     enum ofperr error = 0;
 157
 158     ids = ofpact_put_DEC_TTL(out);
 159     ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL;
 160     ids->n_controllers = 1;
 161     ofpbuf_put(out, &id, sizeof id);
 162     ids = out->l2;
 163     ofpact_update_len(out, &ids->ofpact);
 164     return error;
 165 }
 166
 167 static enum ofperr
 168 dec_ttl_cnt_ids_from_openflow(const struct nx_action_cnt_ids *nac_ids,
 169                       struct ofpbuf *out)
 170 {
 171     struct ofpact_cnt_ids *ids;
 172     size_t ids_size;
 173     int i;
 174
 175     ids = ofpact_put_DEC_TTL(out);
 176     ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
 177     ids->n_controllers = ntohs(nac_ids->n_controllers);
 178     ids_size = ntohs(nac_ids->len) - sizeof *nac_ids;
 179
 180     if (!is_all_zeros(nac_ids->zeros, sizeof nac_ids->zeros)) {
 181         return OFPERR_NXBRC_MUST_BE_ZERO;
 182     }
 183
 184     if (ids_size < ids->n_controllers * sizeof(ovs_be16)) {
 185         VLOG_WARN_RL(&rl, "Nicira action dec_ttl_cnt_ids only has %zu bytes "
 186                      "allocated for controller ids.  %zu bytes are required for "
 187                      "%"PRIu16" controllers.", ids_size,
 188                      ids->n_controllers * sizeof(ovs_be16), ids->n_controllers);
 189         return OFPERR_OFPBAC_BAD_LEN;
 190     }
 191
 192     for (i = 0; i < ids->n_controllers; i++) {
 193         uint16_t id = ntohs(((ovs_be16 *)(nac_ids + 1))[i]);
 194         ofpbuf_put(out, &id, sizeof id);
 195     }
 196
 197     ids = out->l2;
 198     ofpact_update_len(out, &ids->ofpact);
 199
 200     return 0;
 201 }
 202
 203 static enum ofperr
 204 decode_nxast_action(const union ofp_action *a, enum ofputil_action_code *code)
 205 {
 206     const struct nx_action_header *nah = (const struct nx_action_header *) a;
 207     uint16_t len = ntohs(a->header.len);
 208
 209     if (len < sizeof(struct nx_action_header)) {
 210         return OFPERR_OFPBAC_BAD_LEN;
 211     } else if (a->vendor.vendor != CONSTANT_HTONL(NX_VENDOR_ID)) {
 212         return OFPERR_OFPBAC_BAD_VENDOR;
 213     }
 214
 215     switch (nah->subtype) {
 216 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 217         case CONSTANT_HTONS(ENUM):                      \
 218             if (EXTENSIBLE                              \
 219                 ? len >= sizeof(struct STRUCT)          \
 220                 : len == sizeof(struct STRUCT)) {       \
 221                 *code = OFPUTIL_##ENUM;                 \
 222                 return 0;                               \
 223             } else {                                    \
 224                 return OFPERR_OFPBAC_BAD_LEN;           \
 225             }                                           \
 226             NOT_REACHED();
 227 #include "ofp-util.def"
 228
 229     case CONSTANT_HTONS(NXAST_SNAT__OBSOLETE):
 230     case CONSTANT_HTONS(NXAST_DROP_SPOOFED_ARP__OBSOLETE):
 231     default:
 232         return OFPERR_OFPBAC_BAD_TYPE;
 233     }
 234 }
 235
 236 /* Parses 'a' to determine its type.  On success stores the correct type into
 237  * '*code' and returns 0.  On failure returns an OFPERR_* error code and
 238  * '*code' is indeterminate.
 239  *
 240  * The caller must have already verified that 'a''s length is potentially
 241  * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
 242  * ofp_action) and no longer than the amount of space allocated to 'a').
 243  *
 244  * This function verifies that 'a''s length is correct for the type of action
 245  * that it represents. */
 246 static enum ofperr
 247 decode_openflow10_action(const union ofp_action *a,
 248                          enum ofputil_action_code *code)
 249 {
 250     switch (a->type) {
 251     case CONSTANT_HTONS(OFPAT10_VENDOR):
 252         return decode_nxast_action(a, code);
 253
 254 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                          \
 255         case CONSTANT_HTONS(ENUM):                                  \
 256             if (a->header.len == htons(sizeof(struct STRUCT))) {    \
 257                 *code = OFPUTIL_##ENUM;                             \
 258                 return 0;                                           \
 259             } else {                                                \
 260                 return OFPERR_OFPBAC_BAD_LEN;                       \
 261             }                                                       \
 262             break;
 263 #include "ofp-util.def"
 264
 265     default:
 266         return OFPERR_OFPBAC_BAD_TYPE;
 267     }
 268 }
 269
 270 static enum ofperr
 271 ofpact_from_nxast(const union ofp_action *a, enum ofputil_action_code code,
 272                   struct ofpbuf *out)
 273 {
 274     const struct nx_action_resubmit *nar;
 275     const struct nx_action_set_tunnel *nast;
 276     const struct nx_action_set_queue *nasq;
 277     const struct nx_action_note *nan;
 278     const struct nx_action_set_tunnel64 *nast64;
 279     struct ofpact_tunnel *tunnel;
 280     enum ofperr error = 0;
 281
 282     switch (code) {
 283     case OFPUTIL_ACTION_INVALID:
 284 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
 285 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 286 #include "ofp-util.def"
 287         NOT_REACHED();
 288
 289     case OFPUTIL_NXAST_RESUBMIT:
 290         resubmit_from_openflow((const struct nx_action_resubmit *) a, out);
 291         break;
 292
 293     case OFPUTIL_NXAST_SET_TUNNEL:
 294         nast = (const struct nx_action_set_tunnel *) a;
 295         tunnel = ofpact_put_SET_TUNNEL(out);
 296         tunnel->ofpact.compat = code;
 297         tunnel->tun_id = ntohl(nast->tun_id);
 298         break;
 299
 300     case OFPUTIL_NXAST_SET_QUEUE:
 301         nasq = (const struct nx_action_set_queue *) a;
 302         ofpact_put_SET_QUEUE(out)->queue_id = ntohl(nasq->queue_id);
 303         break;
 304
 305     case OFPUTIL_NXAST_POP_QUEUE:
 306         ofpact_put_POP_QUEUE(out);
 307         break;
 308
 309     case OFPUTIL_NXAST_REG_MOVE:
 310         error = nxm_reg_move_from_openflow(
 311             (const struct nx_action_reg_move *) a, out);
 312         break;
 313
 314     case OFPUTIL_NXAST_REG_LOAD:
 315         error = nxm_reg_load_from_openflow(
 316             (const struct nx_action_reg_load *) a, out);
 317         break;
 318
 319     case OFPUTIL_NXAST_NOTE:
 320         nan = (const struct nx_action_note *) a;
 321         note_from_openflow(nan, out);
 322         break;
 323
 324     case OFPUTIL_NXAST_SET_TUNNEL64:
 325         nast64 = (const struct nx_action_set_tunnel64 *) a;
 326         tunnel = ofpact_put_SET_TUNNEL(out);
 327         tunnel->ofpact.compat = code;
 328         tunnel->tun_id = ntohll(nast64->tun_id);
 329         break;
 330
 331     case OFPUTIL_NXAST_MULTIPATH:
 332         error = multipath_from_openflow((const struct nx_action_multipath *) a,
 333                                         ofpact_put_MULTIPATH(out));
 334         break;
 335
 336     case OFPUTIL_NXAST_AUTOPATH__DEPRECATED:
 337         error = autopath_from_openflow((const struct nx_action_autopath *) a,
 338                                        ofpact_put_AUTOPATH(out));
 339         break;
 340
 341     case OFPUTIL_NXAST_BUNDLE:
 342     case OFPUTIL_NXAST_BUNDLE_LOAD:
 343         error = bundle_from_openflow((const struct nx_action_bundle *) a, out);
 344         break;
 345
 346     case OFPUTIL_NXAST_OUTPUT_REG:
 347         error = output_reg_from_openflow(
 348             (const struct nx_action_output_reg *) a, out);
 349         break;
 350
 351     case OFPUTIL_NXAST_RESUBMIT_TABLE:
 352         nar = (const struct nx_action_resubmit *) a;
 353         error = resubmit_table_from_openflow(nar, out);
 354         break;
 355
 356     case OFPUTIL_NXAST_LEARN:
 357         error = learn_from_openflow((const struct nx_action_learn *) a, out);
 358         break;
 359
 360     case OFPUTIL_NXAST_EXIT:
 361         ofpact_put_EXIT(out);
 362         break;
 363
 364     case OFPUTIL_NXAST_DEC_TTL:
 365         error = dec_ttl_from_openflow(out);
 366         break;
 367
 368     case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
 369         error = dec_ttl_cnt_ids_from_openflow(
 370                     (const struct nx_action_cnt_ids *) a, out);
 371         break;
 372
 373     case OFPUTIL_NXAST_FIN_TIMEOUT:
 374         fin_timeout_from_openflow(
 375             (const struct nx_action_fin_timeout *) a, out);
 376         break;
 377
 378     case OFPUTIL_NXAST_CONTROLLER:
 379         controller_from_openflow((const struct nx_action_controller *) a, out);
 380         break;
 381     }
 382
 383     return error;
 384 }
 385
 386 static enum ofperr
 387 ofpact_from_openflow10(const union ofp_action *a, struct ofpbuf *out)
 388 {
 389     enum ofputil_action_code code;
 390     enum ofperr error;
 391
 392     error = decode_openflow10_action(a, &code);
 393     if (error) {
 394         return error;
 395     }
 396
 397     switch (code) {
 398     case OFPUTIL_ACTION_INVALID:
 399 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 400 #include "ofp-util.def"
 401         NOT_REACHED();
 402
 403     case OFPUTIL_OFPAT10_OUTPUT:
 404         return output_from_openflow10(&a->output10, out);
 405
 406     case OFPUTIL_OFPAT10_SET_VLAN_VID:
 407         if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
 408             return OFPERR_OFPBAC_BAD_ARGUMENT;
 409         }
 410         ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
 411         break;
 412
 413     case OFPUTIL_OFPAT10_SET_VLAN_PCP:
 414         if (a->vlan_pcp.vlan_pcp & ~7) {
 415             return OFPERR_OFPBAC_BAD_ARGUMENT;
 416         }
 417         ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
 418         break;
 419
 420     case OFPUTIL_OFPAT10_STRIP_VLAN:
 421         ofpact_put_STRIP_VLAN(out);
 422         break;
 423
 424     case OFPUTIL_OFPAT10_SET_DL_SRC:
 425         memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
 426                ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
 427         break;
 428
 429     case OFPUTIL_OFPAT10_SET_DL_DST:
 430         memcpy(ofpact_put_SET_ETH_DST(out)->mac,
 431                ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
 432         break;
 433
 434     case OFPUTIL_OFPAT10_SET_NW_SRC:
 435         ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
 436         break;
 437
 438     case OFPUTIL_OFPAT10_SET_NW_DST:
 439         ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
 440         break;
 441
 442     case OFPUTIL_OFPAT10_SET_NW_TOS:
 443         if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
 444             return OFPERR_OFPBAC_BAD_ARGUMENT;
 445         }
 446         ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
 447         break;
 448
 449     case OFPUTIL_OFPAT10_SET_TP_SRC:
 450         ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
 451         break;
 452
 453     case OFPUTIL_OFPAT10_SET_TP_DST:
 454         ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
 455
 456         break;
 457
 458     case OFPUTIL_OFPAT10_ENQUEUE:
 459         error = enqueue_from_openflow10((const struct ofp_action_enqueue *) a,
 460                                         out);
 461         break;
 462
 463 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 464 #include "ofp-util.def"
 465         return ofpact_from_nxast(a, code, out);
 466     }
 467
 468     return error;
 469 }
 470
 471 static inline union ofp_action *
 472 action_next(const union ofp_action *a)
 473 {
 474     return ((union ofp_action *) (void *)
 475             ((uint8_t *) a + ntohs(a->header.len)));
 476 }
 477
 478 static inline bool
 479 action_is_valid(const union ofp_action *a, size_t n_actions)
 480 {
 481     uint16_t len = ntohs(a->header.len);
 482     return (!(len % OFP_ACTION_ALIGN)
 483             && len >= sizeof *a
 484             && len / sizeof *a <= n_actions);
 485 }
 486
 487 /* This macro is careful to check for actions with bad lengths. */
 488 #define ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS)                 \
 489     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 490          (LEFT) > 0 && action_is_valid(ITER, LEFT);                     \
 491          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 492           (ITER) = action_next(ITER)))
 493
 494 static void
 495 log_bad_action(const union ofp_action *actions, size_t n_actions, size_t ofs,
 496                enum ofperr error)
 497 {
 498     if (!VLOG_DROP_WARN(&rl)) {
 499         struct ds s;
 500
 501         ds_init(&s);
 502         ds_put_hex_dump(&s, actions, n_actions * sizeof *actions, 0, false);
 503         VLOG_WARN("bad action at offset %#zx (%s):\n%s",
 504                   ofs * sizeof *actions, ofperr_get_name(error), ds_cstr(&s));
 505         ds_destroy(&s);
 506     }
 507 }
 508
 509 static enum ofperr
 510 ofpacts_from_openflow(const union ofp_action *in, size_t n_in,
 511                       struct ofpbuf *out,
 512                       enum ofperr (*ofpact_from_openflow)(
 513                           const union ofp_action *a, struct ofpbuf *out))
 514 {
 515     const union ofp_action *a;
 516     size_t left;
 517
 518     ACTION_FOR_EACH (a, left, in, n_in) {
 519         enum ofperr error = ofpact_from_openflow(a, out);
 520         if (error) {
 521             log_bad_action(in, n_in, a - in, error);
 522             return error;
 523         }
 524     }
 525     if (left) {
 526         enum ofperr error = OFPERR_OFPBAC_BAD_LEN;
 527         log_bad_action(in, n_in, n_in - left, error);
 528         return error;
 529     }
 530
 531     ofpact_pad(out);
 532     return 0;
 533 }
 534
 535 static enum ofperr
 536 ofpacts_from_openflow10(const union ofp_action *in, size_t n_in,
 537                         struct ofpbuf *out)
 538 {
 539     return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow10);
 540 }
 541
 542 static enum ofperr
 543 ofpacts_pull_actions(struct ofpbuf *openflow, unsigned int actions_len,
 544                      struct ofpbuf *ofpacts,
 545                      enum ofperr (*translate)(const union ofp_action *actions,
 546                                               size_t n_actions,
 547                                               struct ofpbuf *ofpacts))
 548 {
 549     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 550     const union ofp_action *actions;
 551     enum ofperr error;
 552
 553     ofpbuf_clear(ofpacts);
 554
 555     if (actions_len % OFP_ACTION_ALIGN != 0) {
 556         VLOG_WARN_RL(&rl, "OpenFlow message actions length %u is not a "
 557                      "multiple of %d", actions_len, OFP_ACTION_ALIGN);
 558         return OFPERR_OFPBRC_BAD_LEN;
 559     }
 560
 561     actions = ofpbuf_try_pull(openflow, actions_len);
 562     if (actions == NULL) {
 563         VLOG_WARN_RL(&rl, "OpenFlow message actions length %u exceeds "
 564                      "remaining message length (%zu)",
 565                      actions_len, openflow->size);
 566         return OFPERR_OFPBRC_BAD_LEN;
 567     }
 568
 569     error = translate(actions, actions_len / OFP_ACTION_ALIGN, ofpacts);
 570     if (error) {
 571         ofpbuf_clear(ofpacts);
 572     }
 573     return error;
 574 }
 575
 576 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.0 actions from the
 577  * front of 'openflow' into ofpacts.  On success, replaces any existing content
 578  * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
 579  * Returns 0 if successful, otherwise an OpenFlow error.
 580  *
 581  * The parsed actions are valid generically, but they may not be valid in a
 582  * specific context.  For example, port numbers up to OFPP_MAX are valid
 583  * generically, but specific datapaths may only support port numbers in a
 584  * smaller range.  Use ofpacts_check() to additional check whether actions are
 585  * valid in a specific context. */
 586 enum ofperr
 587 ofpacts_pull_openflow10(struct ofpbuf *openflow, unsigned int actions_len,
 588                         struct ofpbuf *ofpacts)
 589 {
 590     return ofpacts_pull_actions(openflow, actions_len, ofpacts,
 591                                 ofpacts_from_openflow10);
 592 }
 593 \f
 594 /* OpenFlow 1.1 actions. */
 595
 596 /* Parses 'a' to determine its type.  On success stores the correct type into
 597  * '*code' and returns 0.  On failure returns an OFPERR_* error code and
 598  * '*code' is indeterminate.
 599  *
 600  * The caller must have already verified that 'a''s length is potentially
 601  * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
 602  * ofp_action) and no longer than the amount of space allocated to 'a').
 603  *
 604  * This function verifies that 'a''s length is correct for the type of action
 605  * that it represents. */
 606 static enum ofperr
 607 decode_openflow11_action(const union ofp_action *a,
 608                          enum ofputil_action_code *code)
 609 {
 610     uint16_t len;
 611
 612     switch (a->type) {
 613     case CONSTANT_HTONS(OFPAT11_EXPERIMENTER):
 614         return decode_nxast_action(a, code);
 615
 616 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)  \
 617         case CONSTANT_HTONS(ENUM):                      \
 618             len = ntohs(a->header.len);                 \
 619             if (EXTENSIBLE                              \
 620                 ? len >= sizeof(struct STRUCT)          \
 621                 : len == sizeof(struct STRUCT)) {       \
 622                 *code = OFPUTIL_##ENUM;                 \
 623                 return 0;                               \
 624             } else {                                    \
 625                 return OFPERR_OFPBAC_BAD_LEN;           \
 626             }                                           \
 627             NOT_REACHED();
 628 #include "ofp-util.def"
 629
 630     default:
 631         return OFPERR_OFPBAC_BAD_TYPE;
 632     }
 633 }
 634
 635 static enum ofperr
 636 output_from_openflow11(const struct ofp11_action_output *oao,
 637                        struct ofpbuf *out)
 638 {
 639     struct ofpact_output *output;
 640     enum ofperr error;
 641
 642     output = ofpact_put_OUTPUT(out);
 643     output->max_len = ntohs(oao->max_len);
 644
 645     error = ofputil_port_from_ofp11(oao->port, &output->port);
 646     if (error) {
 647         return error;
 648     }
 649
 650     return ofputil_check_output_port(output->port, OFPP_MAX);
 651 }
 652
 653 static enum ofperr
 654 ofpact_from_openflow11(const union ofp_action *a, struct ofpbuf *out)
 655 {
 656     enum ofputil_action_code code;
 657     enum ofperr error;
 658
 659     error = decode_openflow11_action(a, &code);
 660     if (error) {
 661         return error;
 662     }
 663
 664     switch (code) {
 665     case OFPUTIL_ACTION_INVALID:
 666 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
 667 #include "ofp-util.def"
 668         NOT_REACHED();
 669
 670     case OFPUTIL_OFPAT11_OUTPUT:
 671         return output_from_openflow11((const struct ofp11_action_output *) a,
 672                                       out);
 673
 674     case OFPUTIL_OFPAT11_SET_VLAN_VID:
 675         if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
 676             return OFPERR_OFPBAC_BAD_ARGUMENT;
 677         }
 678         ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
 679         break;
 680
 681     case OFPUTIL_OFPAT11_SET_VLAN_PCP:
 682         if (a->vlan_pcp.vlan_pcp & ~7) {
 683             return OFPERR_OFPBAC_BAD_ARGUMENT;
 684         }
 685         ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
 686         break;
 687
 688     case OFPUTIL_OFPAT11_SET_DL_SRC:
 689         memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
 690                ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
 691         break;
 692
 693     case OFPUTIL_OFPAT11_SET_DL_DST:
 694         memcpy(ofpact_put_SET_ETH_DST(out)->mac,
 695                ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
 696         break;
 697
 698     case OFPUTIL_OFPAT11_SET_NW_SRC:
 699         ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
 700         break;
 701
 702     case OFPUTIL_OFPAT11_SET_NW_DST:
 703         ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
 704         break;
 705
 706     case OFPUTIL_OFPAT11_SET_NW_TOS:
 707         if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
 708             return OFPERR_OFPBAC_BAD_ARGUMENT;
 709         }
 710         ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
 711         break;
 712
 713     case OFPUTIL_OFPAT11_SET_TP_SRC:
 714         ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
 715         break;
 716
 717     case OFPUTIL_OFPAT11_SET_TP_DST:
 718         ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
 719         break;
 720
 721     case OFPUTIL_OFPAT12_SET_FIELD:
 722         return nxm_reg_load_from_openflow12_set_field(
 723             (const struct ofp12_action_set_field *)a, out);
 724
 725 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 726 #include "ofp-util.def"
 727         return ofpact_from_nxast(a, code, out);
 728     }
 729
 730     return error;
 731 }
 732
 733 static enum ofperr
 734 ofpacts_from_openflow11(const union ofp_action *in, size_t n_in,
 735                         struct ofpbuf *out)
 736 {
 737     return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow11);
 738 }
 739 \f
 740 /* OpenFlow 1.1 instructions. */
 741
 742 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)             \
 743     static inline const struct STRUCT *                         \
 744     instruction_get_##ENUM(const struct ofp11_instruction *inst)\
 745     {                                                           \
 746         assert(inst->type == htons(ENUM));                      \
 747         return (struct STRUCT *)inst;                           \
 748     }                                                           \
 749                                                                 \
 750     static inline void                                          \
 751     instruction_init_##ENUM(struct STRUCT *s)                   \
 752     {                                                           \
 753         memset(s, 0, sizeof *s);                                \
 754         s->type = htons(ENUM);                                  \
 755         s->len = htons(sizeof *s);                              \
 756     }                                                           \
 757                                                                 \
 758     static inline struct STRUCT *                               \
 759     instruction_put_##ENUM(struct ofpbuf *buf)                  \
 760     {                                                           \
 761         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
 762         instruction_init_##ENUM(s);                             \
 763         return s;                                               \
 764     }
 765 OVS_INSTRUCTIONS
 766 #undef DEFINE_INST
 767
 768 struct instruction_type_info {
 769     enum ovs_instruction_type type;
 770     const char *name;
 771 };
 772
 773 static const struct instruction_type_info inst_info[] = {
 774 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)    {OVSINST_##ENUM, NAME},
 775 OVS_INSTRUCTIONS
 776 #undef DEFINE_INST
 777 };
 778
 779 const char *
 780 ofpact_instruction_name_from_type(enum ovs_instruction_type type)
 781 {
 782     return inst_info[type].name;
 783 }
 784
 785 int
 786 ofpact_instruction_type_from_name(const char *name)
 787 {
 788     const struct instruction_type_info *p;
 789     for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
 790         if (!strcasecmp(name, p->name)) {
 791             return p->type;
 792         }
 793     }
 794     return -1;
 795 }
 796
 797 static inline struct ofp11_instruction *
 798 instruction_next(const struct ofp11_instruction *inst)
 799 {
 800     return ((struct ofp11_instruction *) (void *)
 801             ((uint8_t *) inst + ntohs(inst->len)));
 802 }
 803
 804 static inline bool
 805 instruction_is_valid(const struct ofp11_instruction *inst,
 806                      size_t n_instructions)
 807 {
 808     uint16_t len = ntohs(inst->len);
 809     return (!(len % OFP11_INSTRUCTION_ALIGN)
 810             && len >= sizeof *inst
 811             && len / sizeof *inst <= n_instructions);
 812 }
 813
 814 /* This macro is careful to check for instructions with bad lengths. */
 815 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS)  \
 816     for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS);            \
 817          (LEFT) > 0 && instruction_is_valid(ITER, LEFT);                \
 818          ((LEFT) -= (ntohs((ITER)->len)                                 \
 819                      / sizeof(struct ofp11_instruction)),               \
 820           (ITER) = instruction_next(ITER)))
 821
 822 static enum ofperr
 823 decode_openflow11_instruction(const struct ofp11_instruction *inst,
 824                               enum ovs_instruction_type *type)
 825 {
 826     uint16_t len = ntohs(inst->len);
 827
 828     switch (inst->type) {
 829     case CONSTANT_HTONS(OFPIT11_EXPERIMENTER):
 830         return OFPERR_OFPBIC_BAD_EXPERIMENTER;
 831
 832 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)     \
 833         case CONSTANT_HTONS(ENUM):                      \
 834             if (EXTENSIBLE                              \
 835                 ? len >= sizeof(struct STRUCT)          \
 836                 : len == sizeof(struct STRUCT)) {       \
 837                 *type = OVSINST_##ENUM;                 \
 838                 return 0;                               \
 839             } else {                                    \
 840                 return OFPERR_OFPBIC_BAD_LEN;           \
 841             }
 842 OVS_INSTRUCTIONS
 843 #undef DEFINE_INST
 844
 845     default:
 846         return OFPERR_OFPBIC_UNKNOWN_INST;
 847     }
 848 }
 849
 850 static enum ofperr
 851 decode_openflow11_instructions(const struct ofp11_instruction insts[],
 852                                size_t n_insts,
 853                                const struct ofp11_instruction *out[])
 854 {
 855     const struct ofp11_instruction *inst;
 856     size_t left;
 857
 858     memset(out, 0, N_OVS_INSTRUCTIONS * sizeof *out);
 859     INSTRUCTION_FOR_EACH (inst, left, insts, n_insts) {
 860         enum ovs_instruction_type type;
 861         enum ofperr error;
 862
 863         error = decode_openflow11_instruction(inst, &type);
 864         if (error) {
 865             return error;
 866         }
 867
 868         if (out[type]) {
 869             return OFPERR_OFPIT_BAD_INSTRUCTION;
 870         }
 871         out[type] = inst;
 872     }
 873
 874     if (left) {
 875         VLOG_WARN_RL(&rl, "bad instruction format at offset %zu",
 876                      (n_insts - left) * sizeof *inst);
 877         return OFPERR_OFPBIC_BAD_LEN;
 878     }
 879     return 0;
 880 }
 881
 882 static void
 883 get_actions_from_instruction(const struct ofp11_instruction *inst,
 884                          const union ofp_action **actions,
 885                          size_t *n_actions)
 886 {
 887     *actions = (const union ofp_action *) (inst + 1);
 888     *n_actions = (ntohs(inst->len) - sizeof *inst) / OFP11_INSTRUCTION_ALIGN;
 889 }
 890
 891 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.1 actions from the
 892  * front of 'openflow' into ofpacts.  On success, replaces any existing content
 893  * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
 894  * Returns 0 if successful, otherwise an OpenFlow error.
 895  *
 896  * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
 897  * instructions, so you should call ofpacts_pull_openflow11_instructions()
 898  * instead of this function.
 899  *
 900  * The parsed actions are valid generically, but they may not be valid in a
 901  * specific context.  For example, port numbers up to OFPP_MAX are valid
 902  * generically, but specific datapaths may only support port numbers in a
 903  * smaller range.  Use ofpacts_check() to additional check whether actions are
 904  * valid in a specific context. */
 905 enum ofperr
 906 ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
 907                                 unsigned int actions_len,
 908                                 struct ofpbuf *ofpacts)
 909 {
 910     return ofpacts_pull_actions(openflow, actions_len, ofpacts,
 911                                 ofpacts_from_openflow11);
 912 }
 913
 914 enum ofperr
 915 ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
 916                                      unsigned int instructions_len,
 917                                      struct ofpbuf *ofpacts)
 918 {
 919     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 920     const struct ofp11_instruction *instructions;
 921     const struct ofp11_instruction *insts[N_OVS_INSTRUCTIONS];
 922     enum ofperr error;
 923
 924     ofpbuf_clear(ofpacts);
 925
 926     if (instructions_len % OFP11_INSTRUCTION_ALIGN != 0) {
 927         VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u is not a "
 928                      "multiple of %d",
 929                      instructions_len, OFP11_INSTRUCTION_ALIGN);
 930         error = OFPERR_OFPBIC_BAD_LEN;
 931         goto exit;
 932     }
 933
 934     instructions = ofpbuf_try_pull(openflow, instructions_len);
 935     if (instructions == NULL) {
 936         VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u exceeds "
 937                      "remaining message length (%zu)",
 938                      instructions_len, openflow->size);
 939         error = OFPERR_OFPBIC_BAD_LEN;
 940         goto exit;
 941     }
 942
 943     error = decode_openflow11_instructions(
 944         instructions, instructions_len / OFP11_INSTRUCTION_ALIGN,
 945         insts);
 946     if (error) {
 947         goto exit;
 948     }
 949
 950     if (insts[OVSINST_OFPIT11_APPLY_ACTIONS]) {
 951         const union ofp_action *actions;
 952         size_t n_actions;
 953
 954         get_actions_from_instruction(insts[OVSINST_OFPIT11_APPLY_ACTIONS],
 955                                      &actions, &n_actions);
 956         error = ofpacts_from_openflow11(actions, n_actions, ofpacts);
 957         if (error) {
 958             goto exit;
 959         }
 960     }
 961
 962     if (insts[OVSINST_OFPIT11_GOTO_TABLE] ||
 963         insts[OVSINST_OFPIT11_WRITE_METADATA] ||
 964         insts[OVSINST_OFPIT11_WRITE_ACTIONS] ||
 965         insts[OVSINST_OFPIT11_CLEAR_ACTIONS]) {
 966         error = OFPERR_OFPBIC_UNSUP_INST;
 967         goto exit;
 968     }
 969
 970 exit:
 971     if (error) {
 972         ofpbuf_clear(ofpacts);
 973     }
 974     return error;
 975 }
 976 \f
 977 static enum ofperr
 978 ofpact_check__(const struct ofpact *a, const struct flow *flow, int max_ports)
 979 {
 980     const struct ofpact_enqueue *enqueue;
 981
 982     switch (a->type) {
 983     case OFPACT_OUTPUT:
 984         return ofputil_check_output_port(ofpact_get_OUTPUT(a)->port,
 985                                          max_ports);
 986
 987     case OFPACT_CONTROLLER:
 988         return 0;
 989
 990     case OFPACT_ENQUEUE:
 991         enqueue = ofpact_get_ENQUEUE(a);
 992         if (enqueue->port >= max_ports && enqueue->port != OFPP_IN_PORT
 993             && enqueue->port != OFPP_LOCAL) {
 994             return OFPERR_OFPBAC_BAD_OUT_PORT;
 995         }
 996         return 0;
 997
 998     case OFPACT_OUTPUT_REG:
 999         return mf_check_src(&ofpact_get_OUTPUT_REG(a)->src, flow);
1000
1001     case OFPACT_BUNDLE:
1002         return bundle_check(ofpact_get_BUNDLE(a), max_ports, flow);
1003
1004     case OFPACT_SET_VLAN_VID:
1005     case OFPACT_SET_VLAN_PCP:
1006     case OFPACT_STRIP_VLAN:
1007     case OFPACT_SET_ETH_SRC:
1008     case OFPACT_SET_ETH_DST:
1009     case OFPACT_SET_IPV4_SRC:
1010     case OFPACT_SET_IPV4_DST:
1011     case OFPACT_SET_IPV4_DSCP:
1012     case OFPACT_SET_L4_SRC_PORT:
1013     case OFPACT_SET_L4_DST_PORT:
1014         return 0;
1015
1016     case OFPACT_REG_MOVE:
1017         return nxm_reg_move_check(ofpact_get_REG_MOVE(a), flow);
1018
1019     case OFPACT_REG_LOAD:
1020         return nxm_reg_load_check(ofpact_get_REG_LOAD(a), flow);
1021
1022     case OFPACT_DEC_TTL:
1023     case OFPACT_SET_TUNNEL:
1024     case OFPACT_SET_QUEUE:
1025     case OFPACT_POP_QUEUE:
1026     case OFPACT_FIN_TIMEOUT:
1027     case OFPACT_RESUBMIT:
1028         return 0;
1029
1030     case OFPACT_LEARN:
1031         return learn_check(ofpact_get_LEARN(a), flow);
1032
1033     case OFPACT_MULTIPATH:
1034         return multipath_check(ofpact_get_MULTIPATH(a), flow);
1035
1036     case OFPACT_AUTOPATH:
1037         return autopath_check(ofpact_get_AUTOPATH(a), flow);
1038
1039     case OFPACT_NOTE:
1040     case OFPACT_EXIT:
1041         return 0;
1042
1043     default:
1044         NOT_REACHED();
1045     }
1046 }
1047
1048 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1049  * appropriate for a packet with the prerequisites satisfied by 'flow' in a
1050  * switch with no more than 'max_ports' ports. */
1051 enum ofperr
1052 ofpacts_check(const struct ofpact ofpacts[], size_t ofpacts_len,
1053               const struct flow *flow, int max_ports)
1054 {
1055     const struct ofpact *a;
1056
1057     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1058         enum ofperr error = ofpact_check__(a, flow, max_ports);
1059         if (error) {
1060             return error;
1061         }
1062     }
1063
1064     return 0;
1065 }
1066 \f
1067 /* Converting ofpacts to Nicira OpenFlow extensions. */
1068
1069 static void
1070 ofpact_output_reg_to_nxast(const struct ofpact_output_reg *output_reg,
1071                                 struct ofpbuf *out)
1072 {
1073     struct nx_action_output_reg *naor = ofputil_put_NXAST_OUTPUT_REG(out);
1074
1075     naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
1076                                            output_reg->src.n_bits);
1077     naor->src = htonl(output_reg->src.field->nxm_header);
1078     naor->max_len = htons(output_reg->max_len);
1079 }
1080
1081 static void
1082 ofpact_resubmit_to_nxast(const struct ofpact_resubmit *resubmit,
1083                          struct ofpbuf *out)
1084 {
1085     struct nx_action_resubmit *nar;
1086
1087     if (resubmit->table_id == 0xff
1088         && resubmit->ofpact.compat != OFPUTIL_NXAST_RESUBMIT_TABLE) {
1089         nar = ofputil_put_NXAST_RESUBMIT(out);
1090     } else {
1091         nar = ofputil_put_NXAST_RESUBMIT_TABLE(out);
1092         nar->table = resubmit->table_id;
1093     }
1094     nar->in_port = htons(resubmit->in_port);
1095 }
1096
1097 static void
1098 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel *tunnel,
1099                            struct ofpbuf *out)
1100 {
1101     uint64_t tun_id = tunnel->tun_id;
1102
1103     if (tun_id <= UINT32_MAX
1104         && tunnel->ofpact.compat != OFPUTIL_NXAST_SET_TUNNEL64) {
1105         ofputil_put_NXAST_SET_TUNNEL(out)->tun_id = htonl(tun_id);
1106     } else {
1107         ofputil_put_NXAST_SET_TUNNEL64(out)->tun_id = htonll(tun_id);
1108     }
1109 }
1110
1111 static void
1112 ofpact_note_to_nxast(const struct ofpact_note *note, struct ofpbuf *out)
1113 {
1114     size_t start_ofs = out->size;
1115     struct nx_action_note *nan;
1116     unsigned int remainder;
1117     unsigned int len;
1118
1119     nan = ofputil_put_NXAST_NOTE(out);
1120     out->size -= sizeof nan->note;
1121
1122     ofpbuf_put(out, note->data, note->length);
1123
1124     len = out->size - start_ofs;
1125     remainder = len % OFP_ACTION_ALIGN;
1126     if (remainder) {
1127         ofpbuf_put_zeros(out, OFP_ACTION_ALIGN - remainder);
1128     }
1129     nan = (struct nx_action_note *)((char *)out->data + start_ofs);
1130     nan->len = htons(out->size - start_ofs);
1131 }
1132
1133 static void
1134 ofpact_controller_to_nxast(const struct ofpact_controller *oc,
1135                            struct ofpbuf *out)
1136 {
1137     struct nx_action_controller *nac;
1138
1139     nac = ofputil_put_NXAST_CONTROLLER(out);
1140     nac->max_len = htons(oc->max_len);
1141     nac->controller_id = htons(oc->controller_id);
1142     nac->reason = oc->reason;
1143 }
1144
1145 static void
1146 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids *oc_ids,
1147                         struct ofpbuf *out)
1148 {
1149     if (oc_ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL) {
1150         ofputil_put_NXAST_DEC_TTL(out);
1151     } else {
1152         struct nx_action_cnt_ids *nac_ids =
1153             ofputil_put_NXAST_DEC_TTL_CNT_IDS(out);
1154         int ids_len = ROUND_UP(2 * oc_ids->n_controllers, OFP_ACTION_ALIGN);
1155         ovs_be16 *ids;
1156         size_t i;
1157
1158         nac_ids->len = htons(ntohs(nac_ids->len) + ids_len);
1159         nac_ids->n_controllers = htons(oc_ids->n_controllers);
1160
1161         ids = ofpbuf_put_zeros(out, ids_len);
1162         for (i = 0; i < oc_ids->n_controllers; i++) {
1163             ids[i] = htons(oc_ids->cnt_ids[i]);
1164         }
1165     }
1166 }
1167
1168 static void
1169 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout *fin_timeout,
1170                             struct ofpbuf *out)
1171 {
1172     struct nx_action_fin_timeout *naft = ofputil_put_NXAST_FIN_TIMEOUT(out);
1173     naft->fin_idle_timeout = htons(fin_timeout->fin_idle_timeout);
1174     naft->fin_hard_timeout = htons(fin_timeout->fin_hard_timeout);
1175 }
1176
1177 static void
1178 ofpact_to_nxast(const struct ofpact *a, struct ofpbuf *out)
1179 {
1180     switch (a->type) {
1181     case OFPACT_CONTROLLER:
1182         ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a), out);
1183         break;
1184
1185     case OFPACT_OUTPUT_REG:
1186         ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a), out);
1187         break;
1188
1189     case OFPACT_BUNDLE:
1190         bundle_to_nxast(ofpact_get_BUNDLE(a), out);
1191         break;
1192
1193     case OFPACT_REG_MOVE:
1194         nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a), out);
1195         break;
1196
1197     case OFPACT_REG_LOAD:
1198         nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a), out);
1199         break;
1200
1201     case OFPACT_DEC_TTL:
1202         ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a), out);
1203         break;
1204
1205     case OFPACT_SET_TUNNEL:
1206         ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a), out);
1207         break;
1208
1209     case OFPACT_SET_QUEUE:
1210         ofputil_put_NXAST_SET_QUEUE(out)->queue_id
1211             = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1212         break;
1213
1214     case OFPACT_POP_QUEUE:
1215         ofputil_put_NXAST_POP_QUEUE(out);
1216         break;
1217
1218     case OFPACT_FIN_TIMEOUT:
1219         ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a), out);
1220         break;
1221
1222     case OFPACT_RESUBMIT:
1223         ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a), out);
1224         break;
1225
1226     case OFPACT_LEARN:
1227         learn_to_nxast(ofpact_get_LEARN(a), out);
1228         break;
1229
1230     case OFPACT_MULTIPATH:
1231         multipath_to_nxast(ofpact_get_MULTIPATH(a), out);
1232         break;
1233
1234     case OFPACT_AUTOPATH:
1235         autopath_to_nxast(ofpact_get_AUTOPATH(a), out);
1236         break;
1237
1238     case OFPACT_NOTE:
1239         ofpact_note_to_nxast(ofpact_get_NOTE(a), out);
1240         break;
1241
1242     case OFPACT_EXIT:
1243         ofputil_put_NXAST_EXIT(out);
1244         break;
1245
1246     case OFPACT_OUTPUT:
1247     case OFPACT_ENQUEUE:
1248     case OFPACT_SET_VLAN_VID:
1249     case OFPACT_SET_VLAN_PCP:
1250     case OFPACT_STRIP_VLAN:
1251     case OFPACT_SET_ETH_SRC:
1252     case OFPACT_SET_ETH_DST:
1253     case OFPACT_SET_IPV4_SRC:
1254     case OFPACT_SET_IPV4_DST:
1255     case OFPACT_SET_IPV4_DSCP:
1256     case OFPACT_SET_L4_SRC_PORT:
1257     case OFPACT_SET_L4_DST_PORT:
1258         NOT_REACHED();
1259     }
1260 }
1261 \f
1262 /* Converting ofpacts to OpenFlow 1.0. */
1263
1264 static void
1265 ofpact_output_to_openflow10(const struct ofpact_output *output,
1266                             struct ofpbuf *out)
1267 {
1268     struct ofp10_action_output *oao;
1269
1270     oao = ofputil_put_OFPAT10_OUTPUT(out);
1271     oao->port = htons(output->port);
1272     oao->max_len = htons(output->max_len);
1273 }
1274
1275 static void
1276 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue *enqueue,
1277                              struct ofpbuf *out)
1278 {
1279     struct ofp_action_enqueue *oae;
1280
1281     oae = ofputil_put_OFPAT10_ENQUEUE(out);
1282     oae->port = htons(enqueue->port);
1283     oae->queue_id = htonl(enqueue->queue);
1284 }
1285
1286 static void
1287 ofpact_to_openflow10(const struct ofpact *a, struct ofpbuf *out)
1288 {
1289     switch (a->type) {
1290     case OFPACT_OUTPUT:
1291         ofpact_output_to_openflow10(ofpact_get_OUTPUT(a), out);
1292         break;
1293
1294     case OFPACT_ENQUEUE:
1295         ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a), out);
1296         break;
1297
1298     case OFPACT_SET_VLAN_VID:
1299         ofputil_put_OFPAT10_SET_VLAN_VID(out)->vlan_vid
1300             = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1301         break;
1302
1303     case OFPACT_SET_VLAN_PCP:
1304         ofputil_put_OFPAT10_SET_VLAN_PCP(out)->vlan_pcp
1305             = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1306         break;
1307
1308     case OFPACT_STRIP_VLAN:
1309         ofputil_put_OFPAT10_STRIP_VLAN(out);
1310         break;
1311
1312     case OFPACT_SET_ETH_SRC:
1313         memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out)->dl_addr,
1314                ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1315         break;
1316
1317     case OFPACT_SET_ETH_DST:
1318         memcpy(ofputil_put_OFPAT10_SET_DL_DST(out)->dl_addr,
1319                ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1320         break;
1321
1322     case OFPACT_SET_IPV4_SRC:
1323         ofputil_put_OFPAT10_SET_NW_SRC(out)->nw_addr
1324             = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1325         break;
1326
1327     case OFPACT_SET_IPV4_DST:
1328         ofputil_put_OFPAT10_SET_NW_DST(out)->nw_addr
1329             = ofpact_get_SET_IPV4_DST(a)->ipv4;
1330         break;
1331
1332     case OFPACT_SET_IPV4_DSCP:
1333         ofputil_put_OFPAT10_SET_NW_TOS(out)->nw_tos
1334             = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1335         break;
1336
1337     case OFPACT_SET_L4_SRC_PORT:
1338         ofputil_put_OFPAT10_SET_TP_SRC(out)->tp_port
1339             = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1340         break;
1341
1342     case OFPACT_SET_L4_DST_PORT:
1343         ofputil_put_OFPAT10_SET_TP_DST(out)->tp_port
1344             = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1345         break;
1346
1347     case OFPACT_CONTROLLER:
1348     case OFPACT_OUTPUT_REG:
1349     case OFPACT_BUNDLE:
1350     case OFPACT_REG_MOVE:
1351     case OFPACT_REG_LOAD:
1352     case OFPACT_DEC_TTL:
1353     case OFPACT_SET_TUNNEL:
1354     case OFPACT_SET_QUEUE:
1355     case OFPACT_POP_QUEUE:
1356     case OFPACT_FIN_TIMEOUT:
1357     case OFPACT_RESUBMIT:
1358     case OFPACT_LEARN:
1359     case OFPACT_MULTIPATH:
1360     case OFPACT_AUTOPATH:
1361     case OFPACT_NOTE:
1362     case OFPACT_EXIT:
1363         ofpact_to_nxast(a, out);
1364         break;
1365     }
1366 }
1367
1368 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow 1.0
1369  * actions in 'openflow', appending the actions to any existing data in
1370  * 'openflow'. */
1371 void
1372 ofpacts_put_openflow10(const struct ofpact ofpacts[], size_t ofpacts_len,
1373                        struct ofpbuf *openflow)
1374 {
1375     const struct ofpact *a;
1376
1377     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1378         ofpact_to_openflow10(a, openflow);
1379     }
1380 }
1381 \f
1382 /* Converting ofpacts to OpenFlow 1.1. */
1383
1384 static void
1385 ofpact_output_to_openflow11(const struct ofpact_output *output,
1386                             struct ofpbuf *out)
1387 {
1388     struct ofp11_action_output *oao;
1389
1390     oao = ofputil_put_OFPAT11_OUTPUT(out);
1391     oao->port = ofputil_port_to_ofp11(output->port);
1392     oao->max_len = htons(output->max_len);
1393 }
1394
1395 static void
1396 ofpact_to_openflow11(const struct ofpact *a, struct ofpbuf *out)
1397 {
1398     switch (a->type) {
1399     case OFPACT_OUTPUT:
1400         return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a), out);
1401
1402     case OFPACT_ENQUEUE:
1403         /* XXX */
1404         break;
1405
1406     case OFPACT_SET_VLAN_VID:
1407         ofputil_put_OFPAT11_SET_VLAN_VID(out)->vlan_vid
1408             = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1409         break;
1410
1411     case OFPACT_SET_VLAN_PCP:
1412         ofputil_put_OFPAT11_SET_VLAN_PCP(out)->vlan_pcp
1413             = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1414         break;
1415
1416     case OFPACT_STRIP_VLAN:
1417         /* XXX */
1418         break;
1419
1420     case OFPACT_SET_ETH_SRC:
1421         memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out)->dl_addr,
1422                ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1423         break;
1424
1425     case OFPACT_SET_ETH_DST:
1426         memcpy(ofputil_put_OFPAT11_SET_DL_DST(out)->dl_addr,
1427                ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1428         break;
1429
1430     case OFPACT_SET_IPV4_SRC:
1431         ofputil_put_OFPAT11_SET_NW_SRC(out)->nw_addr
1432             = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1433         break;
1434
1435     case OFPACT_SET_IPV4_DST:
1436         ofputil_put_OFPAT11_SET_NW_DST(out)->nw_addr
1437             = ofpact_get_SET_IPV4_DST(a)->ipv4;
1438         break;
1439
1440     case OFPACT_SET_IPV4_DSCP:
1441         ofputil_put_OFPAT11_SET_NW_TOS(out)->nw_tos
1442             = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1443         break;
1444
1445     case OFPACT_SET_L4_SRC_PORT:
1446         ofputil_put_OFPAT11_SET_TP_SRC(out)->tp_port
1447             = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1448         break;
1449
1450     case OFPACT_SET_L4_DST_PORT:
1451         ofputil_put_OFPAT11_SET_TP_DST(out)->tp_port
1452             = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1453         break;
1454
1455     case OFPACT_CONTROLLER:
1456     case OFPACT_OUTPUT_REG:
1457     case OFPACT_BUNDLE:
1458     case OFPACT_REG_MOVE:
1459     case OFPACT_REG_LOAD:
1460     case OFPACT_DEC_TTL:
1461     case OFPACT_SET_TUNNEL:
1462     case OFPACT_SET_QUEUE:
1463     case OFPACT_POP_QUEUE:
1464     case OFPACT_FIN_TIMEOUT:
1465     case OFPACT_RESUBMIT:
1466     case OFPACT_LEARN:
1467     case OFPACT_MULTIPATH:
1468     case OFPACT_AUTOPATH:
1469     case OFPACT_NOTE:
1470     case OFPACT_EXIT:
1471         ofpact_to_nxast(a, out);
1472         break;
1473     }
1474 }
1475
1476 /* Converts the ofpacts in 'ofpacts' (terminated by OFPACT_END) into OpenFlow
1477  * 1.1 actions in 'openflow', appending the actions to any existing data in
1478  * 'openflow'. */
1479 size_t
1480 ofpacts_put_openflow11_actions(const struct ofpact ofpacts[],
1481                                size_t ofpacts_len, struct ofpbuf *openflow)
1482 {
1483     const struct ofpact *a;
1484     size_t start_size = openflow->size;
1485
1486     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1487         ofpact_to_openflow11(a, openflow);
1488     }
1489
1490     return openflow->size - start_size;
1491 }
1492
1493 void
1494 ofpacts_put_openflow11_instructions(const struct ofpact ofpacts[],
1495                                     size_t ofpacts_len,
1496                                     struct ofpbuf *openflow)
1497 {
1498     struct ofp11_instruction_actions *oia;
1499     size_t ofs;
1500
1501     /* Put an OFPIT11_APPLY_ACTIONS instruction and fill it in. */
1502     ofs = openflow->size;
1503     instruction_put_OFPIT11_APPLY_ACTIONS(openflow);
1504     ofpacts_put_openflow11_actions(ofpacts, ofpacts_len, openflow);
1505
1506     /* Update the instruction's length (or, if it's empty, delete it). */
1507     oia = ofpbuf_at_assert(openflow, ofs, sizeof *oia);
1508     if (openflow->size > ofs + sizeof *oia) {
1509         oia->len = htons(openflow->size - ofs);
1510     } else {
1511         openflow->size = ofs;
1512     }
1513 }
1514 \f
1515 /* Returns true if 'action' outputs to 'port', false otherwise. */
1516 static bool
1517 ofpact_outputs_to_port(const struct ofpact *ofpact, uint16_t port)
1518 {
1519     switch (ofpact->type) {
1520     case OFPACT_OUTPUT:
1521         return ofpact_get_OUTPUT(ofpact)->port == port;
1522     case OFPACT_ENQUEUE:
1523         return ofpact_get_ENQUEUE(ofpact)->port == port;
1524     case OFPACT_CONTROLLER:
1525         return port == OFPP_CONTROLLER;
1526
1527     case OFPACT_OUTPUT_REG:
1528     case OFPACT_BUNDLE:
1529     case OFPACT_SET_VLAN_VID:
1530     case OFPACT_SET_VLAN_PCP:
1531     case OFPACT_STRIP_VLAN:
1532     case OFPACT_SET_ETH_SRC:
1533     case OFPACT_SET_ETH_DST:
1534     case OFPACT_SET_IPV4_SRC:
1535     case OFPACT_SET_IPV4_DST:
1536     case OFPACT_SET_IPV4_DSCP:
1537     case OFPACT_SET_L4_SRC_PORT:
1538     case OFPACT_SET_L4_DST_PORT:
1539     case OFPACT_REG_MOVE:
1540     case OFPACT_REG_LOAD:
1541     case OFPACT_DEC_TTL:
1542     case OFPACT_SET_TUNNEL:
1543     case OFPACT_SET_QUEUE:
1544     case OFPACT_POP_QUEUE:
1545     case OFPACT_FIN_TIMEOUT:
1546     case OFPACT_RESUBMIT:
1547     case OFPACT_LEARN:
1548     case OFPACT_MULTIPATH:
1549     case OFPACT_AUTOPATH:
1550     case OFPACT_NOTE:
1551     case OFPACT_EXIT:
1552     default:
1553         return false;
1554     }
1555 }
1556
1557 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
1558  * to 'port', false otherwise. */
1559 bool
1560 ofpacts_output_to_port(const struct ofpact *ofpacts, size_t ofpacts_len,
1561                        uint16_t port)
1562 {
1563     const struct ofpact *a;
1564
1565     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1566         if (ofpact_outputs_to_port(a, port)) {
1567             return true;
1568         }
1569     }
1570
1571     return false;
1572 }
1573
1574 bool
1575 ofpacts_equal(const struct ofpact *a, size_t a_len,
1576               const struct ofpact *b, size_t b_len)
1577 {
1578     return a_len == b_len && !memcmp(a, b, a_len);
1579 }
1580 \f
1581 /* Formatting ofpacts. */
1582
1583 static void
1584 print_note(const struct ofpact_note *note, struct ds *string)
1585 {
1586     size_t i;
1587
1588     ds_put_cstr(string, "note:");
1589     for (i = 0; i < note->length; i++) {
1590         if (i) {
1591             ds_put_char(string, '.');
1592         }
1593         ds_put_format(string, "%02"PRIx8, note->data[i]);
1594     }
1595 }
1596
1597 static void
1598 print_dec_ttl(const struct ofpact_cnt_ids *ids,
1599               struct ds *s)
1600 {
1601     size_t i;
1602
1603     ds_put_cstr(s, "dec_ttl");
1604     if (ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL_CNT_IDS) {
1605         ds_put_cstr(s, "(");
1606         for (i = 0; i < ids->n_controllers; i++) {
1607             if (i) {
1608                 ds_put_cstr(s, ",");
1609             }
1610             ds_put_format(s, "%"PRIu16, ids->cnt_ids[i]);
1611         }
1612         ds_put_cstr(s, ")");
1613     }
1614 }
1615
1616 static void
1617 print_fin_timeout(const struct ofpact_fin_timeout *fin_timeout,
1618                   struct ds *s)
1619 {
1620     ds_put_cstr(s, "fin_timeout(");
1621     if (fin_timeout->fin_idle_timeout) {
1622         ds_put_format(s, "idle_timeout=%"PRIu16",",
1623                       fin_timeout->fin_idle_timeout);
1624     }
1625     if (fin_timeout->fin_hard_timeout) {
1626         ds_put_format(s, "hard_timeout=%"PRIu16",",
1627                       fin_timeout->fin_hard_timeout);
1628     }
1629     ds_chomp(s, ',');
1630     ds_put_char(s, ')');
1631 }
1632
1633 static void
1634 ofpact_format(const struct ofpact *a, struct ds *s)
1635 {
1636     const struct ofpact_enqueue *enqueue;
1637     const struct ofpact_resubmit *resubmit;
1638     const struct ofpact_autopath *autopath;
1639     const struct ofpact_controller *controller;
1640     const struct ofpact_tunnel *tunnel;
1641     uint16_t port;
1642
1643     switch (a->type) {
1644     case OFPACT_OUTPUT:
1645         port = ofpact_get_OUTPUT(a)->port;
1646         if (port < OFPP_MAX) {
1647             ds_put_format(s, "output:%"PRIu16, port);
1648         } else {
1649             ofputil_format_port(port, s);
1650             if (port == OFPP_CONTROLLER) {
1651                 ds_put_format(s, ":%"PRIu16, ofpact_get_OUTPUT(a)->max_len);
1652             }
1653         }
1654         break;
1655
1656     case OFPACT_CONTROLLER:
1657         controller = ofpact_get_CONTROLLER(a);
1658         if (controller->reason == OFPR_ACTION &&
1659             controller->controller_id == 0) {
1660             ds_put_format(s, "CONTROLLER:%"PRIu16,
1661                           ofpact_get_CONTROLLER(a)->max_len);
1662         } else {
1663             enum ofp_packet_in_reason reason = controller->reason;
1664
1665             ds_put_cstr(s, "controller(");
1666             if (reason != OFPR_ACTION) {
1667                 ds_put_format(s, "reason=%s,",
1668                               ofputil_packet_in_reason_to_string(reason));
1669             }
1670             if (controller->max_len != UINT16_MAX) {
1671                 ds_put_format(s, "max_len=%"PRIu16",", controller->max_len);
1672             }
1673             if (controller->controller_id != 0) {
1674                 ds_put_format(s, "id=%"PRIu16",", controller->controller_id);
1675             }
1676             ds_chomp(s, ',');
1677             ds_put_char(s, ')');
1678         }
1679         break;
1680
1681     case OFPACT_ENQUEUE:
1682         enqueue = ofpact_get_ENQUEUE(a);
1683         ds_put_format(s, "enqueue:");
1684         ofputil_format_port(enqueue->port, s);
1685         ds_put_format(s, "q%"PRIu32, enqueue->queue);
1686         break;
1687
1688     case OFPACT_OUTPUT_REG:
1689         ds_put_cstr(s, "output:");
1690         mf_format_subfield(&ofpact_get_OUTPUT_REG(a)->src, s);
1691         break;
1692
1693     case OFPACT_BUNDLE:
1694         bundle_format(ofpact_get_BUNDLE(a), s);
1695         break;
1696
1697     case OFPACT_SET_VLAN_VID:
1698         ds_put_format(s, "mod_vlan_vid:%"PRIu16,
1699                       ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1700         break;
1701
1702     case OFPACT_SET_VLAN_PCP:
1703         ds_put_format(s, "mod_vlan_pcp:%"PRIu8,
1704                       ofpact_get_SET_VLAN_PCP(a)->vlan_pcp);
1705         break;
1706
1707     case OFPACT_STRIP_VLAN:
1708         ds_put_cstr(s, "strip_vlan");
1709         break;
1710
1711     case OFPACT_SET_ETH_SRC:
1712         ds_put_format(s, "mod_dl_src:"ETH_ADDR_FMT,
1713                       ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a)->mac));
1714         break;
1715
1716     case OFPACT_SET_ETH_DST:
1717         ds_put_format(s, "mod_dl_dst:"ETH_ADDR_FMT,
1718                       ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a)->mac));
1719         break;
1720
1721     case OFPACT_SET_IPV4_SRC:
1722         ds_put_format(s, "mod_nw_src:"IP_FMT,
1723                       IP_ARGS(&ofpact_get_SET_IPV4_SRC(a)->ipv4));
1724         break;
1725
1726     case OFPACT_SET_IPV4_DST:
1727         ds_put_format(s, "mod_nw_dst:"IP_FMT,
1728                       IP_ARGS(&ofpact_get_SET_IPV4_DST(a)->ipv4));
1729         break;
1730
1731     case OFPACT_SET_IPV4_DSCP:
1732         ds_put_format(s, "mod_nw_tos:%d", ofpact_get_SET_IPV4_DSCP(a)->dscp);
1733         break;
1734
1735     case OFPACT_SET_L4_SRC_PORT:
1736         ds_put_format(s, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a)->port);
1737         break;
1738
1739     case OFPACT_SET_L4_DST_PORT:
1740         ds_put_format(s, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a)->port);
1741         break;
1742
1743     case OFPACT_REG_MOVE:
1744         nxm_format_reg_move(ofpact_get_REG_MOVE(a), s);
1745         break;
1746
1747     case OFPACT_REG_LOAD:
1748         nxm_format_reg_load(ofpact_get_REG_LOAD(a), s);
1749         break;
1750
1751     case OFPACT_DEC_TTL:
1752         print_dec_ttl(ofpact_get_DEC_TTL(a), s);
1753         break;
1754
1755     case OFPACT_SET_TUNNEL:
1756         tunnel = ofpact_get_SET_TUNNEL(a);
1757         ds_put_format(s, "set_tunnel%s:%#"PRIx64,
1758                       (tunnel->tun_id > UINT32_MAX
1759                        || a->compat == OFPUTIL_NXAST_SET_TUNNEL64 ? "64" : ""),
1760                       tunnel->tun_id);
1761         break;
1762
1763     case OFPACT_SET_QUEUE:
1764         ds_put_format(s, "set_queue:%"PRIu32,
1765                       ofpact_get_SET_QUEUE(a)->queue_id);
1766         break;
1767
1768     case OFPACT_POP_QUEUE:
1769         ds_put_cstr(s, "pop_queue");
1770         break;
1771
1772     case OFPACT_FIN_TIMEOUT:
1773         print_fin_timeout(ofpact_get_FIN_TIMEOUT(a), s);
1774         break;
1775
1776     case OFPACT_RESUBMIT:
1777         resubmit = ofpact_get_RESUBMIT(a);
1778         if (resubmit->in_port != OFPP_IN_PORT && resubmit->table_id == 255) {
1779             ds_put_cstr(s, "resubmit:");
1780             ofputil_format_port(resubmit->in_port, s);
1781         } else {
1782             ds_put_format(s, "resubmit(");
1783             if (resubmit->in_port != OFPP_IN_PORT) {
1784                 ofputil_format_port(resubmit->in_port, s);
1785             }
1786             ds_put_char(s, ',');
1787             if (resubmit->table_id != 255) {
1788                 ds_put_format(s, "%"PRIu8, resubmit->table_id);
1789             }
1790             ds_put_char(s, ')');
1791         }
1792         break;
1793
1794     case OFPACT_LEARN:
1795         learn_format(ofpact_get_LEARN(a), s);
1796         break;
1797
1798     case OFPACT_MULTIPATH:
1799         multipath_format(ofpact_get_MULTIPATH(a), s);
1800         break;
1801
1802     case OFPACT_AUTOPATH:
1803         autopath = ofpact_get_AUTOPATH(a);
1804         ds_put_cstr(s, "autopath(");
1805         ofputil_format_port(autopath->port, s);
1806         ds_put_char(s, ',');
1807         mf_format_subfield(&autopath->dst, s);
1808         ds_put_char(s, ')');
1809         break;
1810
1811     case OFPACT_NOTE:
1812         print_note(ofpact_get_NOTE(a), s);
1813         break;
1814
1815     case OFPACT_EXIT:
1816         ds_put_cstr(s, "exit");
1817         break;
1818     }
1819 }
1820
1821 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
1822  * 'ofpacts' to 'string'. */
1823 void
1824 ofpacts_format(const struct ofpact *ofpacts, size_t ofpacts_len,
1825                struct ds *string)
1826 {
1827     ds_put_cstr(string, "actions=");
1828     if (!ofpacts_len) {
1829         ds_put_cstr(string, "drop");
1830     } else {
1831         const struct ofpact *a;
1832
1833         OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1834             if (a != ofpacts) {
1835                 ds_put_cstr(string, ",");
1836             }
1837             ofpact_format(a, string);
1838         }
1839     }
1840 }
1841 \f
1842 /* Internal use by helpers. */
1843
1844 void *
1845 ofpact_put(struct ofpbuf *ofpacts, enum ofpact_type type, size_t len)
1846 {
1847     struct ofpact *ofpact;
1848
1849     ofpact_pad(ofpacts);
1850     ofpact = ofpacts->l2 = ofpbuf_put_uninit(ofpacts, len);
1851     ofpact_init(ofpact, type, len);
1852     return ofpact;
1853 }
1854
1855 void
1856 ofpact_init(struct ofpact *ofpact, enum ofpact_type type, size_t len)
1857 {
1858     memset(ofpact, 0, len);
1859     ofpact->type = type;
1860     ofpact->compat = OFPUTIL_ACTION_INVALID;
1861     ofpact->len = len;
1862 }
1863 \f
1864 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
1865  * starting at 'ofpact'.
1866  *
1867  * This is the correct way to update a variable-length ofpact's length after
1868  * adding the variable-length part of the payload.  (See the large comment
1869  * near the end of ofp-actions.h for more information.) */
1870 void
1871 ofpact_update_len(struct ofpbuf *ofpacts, struct ofpact *ofpact)
1872 {
1873     assert(ofpact == ofpacts->l2);
1874     ofpact->len = (char *) ofpbuf_tail(ofpacts) - (char *) ofpact;
1875 }
1876
1877 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length.  Each
1878  * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
1879  * client must call this itself after adding the final ofpact to an array of
1880  * them.
1881  *
1882  * (The consequences of failing to call this function are probably not dire.
1883  * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
1884  * not dereference it.  That's undefined behavior, technically, but it will not
1885  * cause a real problem on common systems.  Still, it seems better to call
1886  * it.) */
1887 void
1888 ofpact_pad(struct ofpbuf *ofpacts)
1889 {
1890     unsigned int rem = ofpacts->size % OFPACT_ALIGNTO;
1891     if (rem) {
1892         ofpbuf_put_zeros(ofpacts, OFPACT_ALIGNTO - rem);
1893     }
1894 }
1895
1896 void
1897 ofpact_set_field_init(struct ofpact_reg_load *load, const struct mf_field *mf,
1898                       const void *src)
1899 {
1900     load->ofpact.compat = OFPUTIL_OFPAT12_SET_FIELD;
1901     load->dst.field = mf;
1902     load->dst.ofs = 0;
1903     load->dst.n_bits = mf->n_bits;
1904     bitwise_copy(src, mf->n_bytes, load->dst.ofs,
1905                  &load->subvalue, sizeof load->subvalue, 0, mf->n_bits);
1906 }