lib/ofp-actions.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks.
   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, 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:
 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, 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     switch (a->type) {
 611     case CONSTANT_HTONS(OFPAT11_EXPERIMENTER):
 612         return decode_nxast_action(a, code);
 613
 614 #define OFPAT11_ACTION(ENUM, STRUCT, NAME)                          \
 615         case CONSTANT_HTONS(ENUM):                                  \
 616             if (a->header.len == htons(sizeof(struct STRUCT))) {    \
 617                 *code = OFPUTIL_##ENUM;                             \
 618                 return 0;                                           \
 619             } else {                                                \
 620                 return OFPERR_OFPBAC_BAD_LEN;                       \
 621             }                                                       \
 622             break;
 623 #include "ofp-util.def"
 624
 625     default:
 626         return OFPERR_OFPBAC_BAD_TYPE;
 627     }
 628 }
 629
 630 static enum ofperr
 631 output_from_openflow11(const struct ofp11_action_output *oao,
 632                        struct ofpbuf *out)
 633 {
 634     struct ofpact_output *output;
 635     enum ofperr error;
 636
 637     output = ofpact_put_OUTPUT(out);
 638     output->max_len = ntohs(oao->max_len);
 639
 640     error = ofputil_port_from_ofp11(oao->port, &output->port);
 641     if (error) {
 642         return error;
 643     }
 644
 645     return ofputil_check_output_port(output->port, OFPP_MAX);
 646 }
 647
 648 static enum ofperr
 649 ofpact_from_openflow11(const union ofp_action *a, struct ofpbuf *out)
 650 {
 651     enum ofputil_action_code code;
 652     enum ofperr error;
 653
 654     error = decode_openflow11_action(a, &code);
 655     if (error) {
 656         return error;
 657     }
 658
 659     switch (code) {
 660     case OFPUTIL_ACTION_INVALID:
 661 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
 662 #include "ofp-util.def"
 663         NOT_REACHED();
 664
 665     case OFPUTIL_OFPAT11_OUTPUT:
 666         return output_from_openflow11((const struct ofp11_action_output *) a,
 667                                       out);
 668
 669     case OFPUTIL_OFPAT11_SET_VLAN_VID:
 670         if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
 671             return OFPERR_OFPBAC_BAD_ARGUMENT;
 672         }
 673         ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
 674         break;
 675
 676     case OFPUTIL_OFPAT11_SET_VLAN_PCP:
 677         if (a->vlan_pcp.vlan_pcp & ~7) {
 678             return OFPERR_OFPBAC_BAD_ARGUMENT;
 679         }
 680         ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
 681         break;
 682
 683     case OFPUTIL_OFPAT11_SET_DL_SRC:
 684         memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
 685                ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
 686         break;
 687
 688     case OFPUTIL_OFPAT11_SET_DL_DST:
 689         memcpy(ofpact_put_SET_ETH_DST(out)->mac,
 690                ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
 691         break;
 692
 693     case OFPUTIL_OFPAT11_SET_NW_SRC:
 694         ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
 695         break;
 696
 697     case OFPUTIL_OFPAT11_SET_NW_DST:
 698         ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
 699         break;
 700
 701     case OFPUTIL_OFPAT11_SET_NW_TOS:
 702         if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
 703             return OFPERR_OFPBAC_BAD_ARGUMENT;
 704         }
 705         ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
 706         break;
 707
 708     case OFPUTIL_OFPAT11_SET_TP_SRC:
 709         ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
 710         break;
 711
 712     case OFPUTIL_OFPAT11_SET_TP_DST:
 713         ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
 714         break;
 715
 716 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 717 #include "ofp-util.def"
 718         return ofpact_from_nxast(a, code, out);
 719     }
 720
 721     return error;
 722 }
 723
 724 static enum ofperr
 725 ofpacts_from_openflow11(const union ofp_action *in, size_t n_in,
 726                         struct ofpbuf *out)
 727 {
 728     return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow11);
 729 }
 730 \f
 731 /* OpenFlow 1.1 instructions. */
 732
 733 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)             \
 734     static inline const struct STRUCT *                         \
 735     instruction_get_##ENUM(const struct ofp11_instruction *inst)\
 736     {                                                           \
 737         assert(inst->type == htons(ENUM));                      \
 738         return (struct STRUCT *)inst;                           \
 739     }                                                           \
 740                                                                 \
 741     static inline void                                          \
 742     instruction_init_##ENUM(struct STRUCT *s)                   \
 743     {                                                           \
 744         memset(s, 0, sizeof *s);                                \
 745         s->type = htons(ENUM);                                  \
 746         s->len = htons(sizeof *s);                              \
 747     }                                                           \
 748                                                                 \
 749     static inline struct STRUCT *                               \
 750     instruction_put_##ENUM(struct ofpbuf *buf)                  \
 751     {                                                           \
 752         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
 753         instruction_init_##ENUM(s);                             \
 754         return s;                                               \
 755     }
 756 OVS_INSTRUCTIONS
 757 #undef DEFINE_INST
 758
 759 struct instruction_type_info {
 760     enum ovs_instruction_type type;
 761     const char *name;
 762 };
 763
 764 static const struct instruction_type_info inst_info[] = {
 765 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)    {OVSINST_##ENUM, NAME},
 766 OVS_INSTRUCTIONS
 767 #undef DEFINE_INST
 768 };
 769
 770 const char *
 771 ofpact_instruction_name_from_type(enum ovs_instruction_type type)
 772 {
 773     const struct instruction_type_info *p;
 774     for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
 775         if (p->type == type) {
 776             return p->name;
 777         }
 778     }
 779     return NULL;
 780 }
 781
 782 int
 783 ofpact_instruction_type_from_name(const char *name)
 784 {
 785     const struct instruction_type_info *p;
 786     for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
 787         if (!strcasecmp(name, p->name)) {
 788             return p->type;
 789         }
 790     }
 791     return -1;
 792 }
 793
 794 static inline struct ofp11_instruction *
 795 instruction_next(const struct ofp11_instruction *inst)
 796 {
 797     return ((struct ofp11_instruction *) (void *)
 798             ((uint8_t *) inst + ntohs(inst->len)));
 799 }
 800
 801 static inline bool
 802 instruction_is_valid(const struct ofp11_instruction *inst,
 803                      size_t n_instructions)
 804 {
 805     uint16_t len = ntohs(inst->len);
 806     return (!(len % OFP11_INSTRUCTION_ALIGN)
 807             && len >= sizeof *inst
 808             && len / sizeof *inst <= n_instructions);
 809 }
 810
 811 /* This macro is careful to check for instructions with bad lengths. */
 812 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS)  \
 813     for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS);            \
 814          (LEFT) > 0 && instruction_is_valid(ITER, LEFT);                \
 815          ((LEFT) -= (ntohs((ITER)->len)                                 \
 816                      / sizeof(struct ofp11_instruction)),               \
 817           (ITER) = instruction_next(ITER)))
 818
 819 static enum ofperr
 820 decode_openflow11_instruction(const struct ofp11_instruction *inst,
 821                               enum ovs_instruction_type *type)
 822 {
 823     uint16_t len = ntohs(inst->len);
 824
 825     switch (inst->type) {
 826     case CONSTANT_HTONS(OFPIT11_EXPERIMENTER):
 827         return OFPERR_OFPBIC_BAD_EXPERIMENTER;
 828
 829 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)     \
 830         case CONSTANT_HTONS(ENUM):                      \
 831             if (EXTENSIBLE                              \
 832                 ? len >= sizeof(struct STRUCT)          \
 833                 : len == sizeof(struct STRUCT)) {       \
 834                 *type = OVSINST_##ENUM;                 \
 835                 return 0;                               \
 836             } else {                                    \
 837                 return OFPERR_OFPBIC_BAD_LEN;           \
 838             }
 839 OVS_INSTRUCTIONS
 840 #undef DEFINE_INST
 841
 842     default:
 843         return OFPERR_OFPBIC_UNKNOWN_INST;
 844     }
 845 }
 846
 847 static enum ofperr
 848 decode_openflow11_instructions(const struct ofp11_instruction insts[],
 849                                size_t n_insts,
 850                                const struct ofp11_instruction *out[])
 851 {
 852     const struct ofp11_instruction *inst;
 853     size_t left;
 854
 855     memset(out, 0, N_OVS_INSTRUCTIONS * sizeof *out);
 856     INSTRUCTION_FOR_EACH (inst, left, insts, n_insts) {
 857         enum ovs_instruction_type type;
 858         enum ofperr error;
 859
 860         error = decode_openflow11_instruction(inst, &type);
 861         if (error) {
 862             return error;
 863         }
 864
 865         if (out[type]) {
 866             return OFPERR_NXBIC_DUP_TYPE;
 867         }
 868         out[type] = inst;
 869     }
 870
 871     if (left) {
 872         VLOG_WARN_RL(&rl, "bad instruction format at offset %zu",
 873                      (n_insts - left) * sizeof *inst);
 874         return OFPERR_OFPBIC_BAD_LEN;
 875     }
 876     return 0;
 877 }
 878
 879 static void
 880 get_actions_from_instruction(const struct ofp11_instruction *inst,
 881                          const union ofp_action **actions,
 882                          size_t *n_actions)
 883 {
 884     *actions = (const union ofp_action *) (inst + 1);
 885     *n_actions = (ntohs(inst->len) - sizeof *inst) / OFP11_INSTRUCTION_ALIGN;
 886 }
 887
 888 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.1 actions from the
 889  * front of 'openflow' into ofpacts.  On success, replaces any existing content
 890  * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
 891  * Returns 0 if successful, otherwise an OpenFlow error.
 892  *
 893  * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
 894  * instructions, so you should call ofpacts_pull_openflow11_instructions()
 895  * instead of this function.
 896  *
 897  * The parsed actions are valid generically, but they may not be valid in a
 898  * specific context.  For example, port numbers up to OFPP_MAX are valid
 899  * generically, but specific datapaths may only support port numbers in a
 900  * smaller range.  Use ofpacts_check() to additional check whether actions are
 901  * valid in a specific context. */
 902 enum ofperr
 903 ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
 904                                 unsigned int actions_len,
 905                                 struct ofpbuf *ofpacts)
 906 {
 907     return ofpacts_pull_actions(openflow, actions_len, ofpacts,
 908                                 ofpacts_from_openflow11);
 909 }
 910
 911 enum ofperr
 912 ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
 913                                      unsigned int instructions_len,
 914                                      struct ofpbuf *ofpacts)
 915 {
 916     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 917     const struct ofp11_instruction *instructions;
 918     const struct ofp11_instruction *insts[N_OVS_INSTRUCTIONS];
 919     enum ofperr error;
 920
 921     ofpbuf_clear(ofpacts);
 922
 923     if (instructions_len % OFP11_INSTRUCTION_ALIGN != 0) {
 924         VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u is not a "
 925                      "multiple of %d",
 926                      instructions_len, OFP11_INSTRUCTION_ALIGN);
 927         error = OFPERR_OFPBIC_BAD_LEN;
 928         goto exit;
 929     }
 930
 931     instructions = ofpbuf_try_pull(openflow, instructions_len);
 932     if (instructions == NULL) {
 933         VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u exceeds "
 934                      "remaining message length (%zu)",
 935                      instructions_len, openflow->size);
 936         error = OFPERR_OFPBIC_BAD_LEN;
 937         goto exit;
 938     }
 939
 940     error = decode_openflow11_instructions(
 941         instructions, instructions_len / OFP11_INSTRUCTION_ALIGN,
 942         insts);
 943     if (error) {
 944         goto exit;
 945     }
 946
 947     if (insts[OVSINST_OFPIT11_APPLY_ACTIONS]) {
 948         const union ofp_action *actions;
 949         size_t n_actions;
 950
 951         get_actions_from_instruction(insts[OVSINST_OFPIT11_APPLY_ACTIONS],
 952                                      &actions, &n_actions);
 953         error = ofpacts_from_openflow11(actions, n_actions, ofpacts);
 954         if (error) {
 955             goto exit;
 956         }
 957     }
 958
 959     if (insts[OVSINST_OFPIT11_GOTO_TABLE] ||
 960         insts[OVSINST_OFPIT11_WRITE_METADATA] ||
 961         insts[OVSINST_OFPIT11_WRITE_ACTIONS] ||
 962         insts[OVSINST_OFPIT11_CLEAR_ACTIONS]) {
 963         error = OFPERR_OFPBIC_UNSUP_INST;
 964         goto exit;
 965     }
 966
 967 exit:
 968     if (error) {
 969         ofpbuf_clear(ofpacts);
 970     }
 971     return error;
 972 }
 973 \f
 974 static enum ofperr
 975 ofpact_check__(const struct ofpact *a, const struct flow *flow, int max_ports)
 976 {
 977     const struct ofpact_enqueue *enqueue;
 978
 979     switch (a->type) {
 980     case OFPACT_OUTPUT:
 981         return ofputil_check_output_port(ofpact_get_OUTPUT(a)->port,
 982                                          max_ports);
 983
 984     case OFPACT_CONTROLLER:
 985         return 0;
 986
 987     case OFPACT_ENQUEUE:
 988         enqueue = ofpact_get_ENQUEUE(a);
 989         if (enqueue->port >= max_ports && enqueue->port != OFPP_IN_PORT
 990             && enqueue->port != OFPP_LOCAL) {
 991             return OFPERR_OFPBAC_BAD_OUT_PORT;
 992         }
 993         return 0;
 994
 995     case OFPACT_OUTPUT_REG:
 996         return mf_check_src(&ofpact_get_OUTPUT_REG(a)->src, flow);
 997
 998     case OFPACT_BUNDLE:
 999         return bundle_check(ofpact_get_BUNDLE(a), max_ports, flow);
1000
1001     case OFPACT_SET_VLAN_VID:
1002     case OFPACT_SET_VLAN_PCP:
1003     case OFPACT_STRIP_VLAN:
1004     case OFPACT_SET_ETH_SRC:
1005     case OFPACT_SET_ETH_DST:
1006     case OFPACT_SET_IPV4_SRC:
1007     case OFPACT_SET_IPV4_DST:
1008     case OFPACT_SET_IPV4_DSCP:
1009     case OFPACT_SET_L4_SRC_PORT:
1010     case OFPACT_SET_L4_DST_PORT:
1011         return 0;
1012
1013     case OFPACT_REG_MOVE:
1014         return nxm_reg_move_check(ofpact_get_REG_MOVE(a), flow);
1015
1016     case OFPACT_REG_LOAD:
1017         return nxm_reg_load_check(ofpact_get_REG_LOAD(a), flow);
1018
1019     case OFPACT_DEC_TTL:
1020     case OFPACT_SET_TUNNEL:
1021     case OFPACT_SET_QUEUE:
1022     case OFPACT_POP_QUEUE:
1023     case OFPACT_FIN_TIMEOUT:
1024     case OFPACT_RESUBMIT:
1025         return 0;
1026
1027     case OFPACT_LEARN:
1028         return learn_check(ofpact_get_LEARN(a), flow);
1029
1030     case OFPACT_MULTIPATH:
1031         return multipath_check(ofpact_get_MULTIPATH(a), flow);
1032
1033     case OFPACT_AUTOPATH:
1034         return autopath_check(ofpact_get_AUTOPATH(a), flow);
1035
1036     case OFPACT_NOTE:
1037     case OFPACT_EXIT:
1038         return 0;
1039
1040     default:
1041         NOT_REACHED();
1042     }
1043 }
1044
1045 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1046  * appropriate for a packet with the prerequisites satisfied by 'flow' in a
1047  * switch with no more than 'max_ports' ports. */
1048 enum ofperr
1049 ofpacts_check(const struct ofpact ofpacts[], size_t ofpacts_len,
1050               const struct flow *flow, int max_ports)
1051 {
1052     const struct ofpact *a;
1053
1054     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1055         enum ofperr error = ofpact_check__(a, flow, max_ports);
1056         if (error) {
1057             return error;
1058         }
1059     }
1060
1061     return 0;
1062 }
1063 \f
1064 /* Converting ofpacts to Nicira OpenFlow extensions. */
1065
1066 static void
1067 ofpact_output_reg_to_nxast(const struct ofpact_output_reg *output_reg,
1068                                 struct ofpbuf *out)
1069 {
1070     struct nx_action_output_reg *naor = ofputil_put_NXAST_OUTPUT_REG(out);
1071
1072     naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
1073                                            output_reg->src.n_bits);
1074     naor->src = htonl(output_reg->src.field->nxm_header);
1075     naor->max_len = htons(output_reg->max_len);
1076 }
1077
1078 static void
1079 ofpact_resubmit_to_nxast(const struct ofpact_resubmit *resubmit,
1080                          struct ofpbuf *out)
1081 {
1082     struct nx_action_resubmit *nar;
1083
1084     if (resubmit->table_id == 0xff
1085         && resubmit->ofpact.compat != OFPUTIL_NXAST_RESUBMIT_TABLE) {
1086         nar = ofputil_put_NXAST_RESUBMIT(out);
1087     } else {
1088         nar = ofputil_put_NXAST_RESUBMIT_TABLE(out);
1089         nar->table = resubmit->table_id;
1090     }
1091     nar->in_port = htons(resubmit->in_port);
1092 }
1093
1094 static void
1095 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel *tunnel,
1096                            struct ofpbuf *out)
1097 {
1098     uint64_t tun_id = tunnel->tun_id;
1099
1100     if (tun_id <= UINT32_MAX
1101         && tunnel->ofpact.compat != OFPUTIL_NXAST_SET_TUNNEL64) {
1102         ofputil_put_NXAST_SET_TUNNEL(out)->tun_id = htonl(tun_id);
1103     } else {
1104         ofputil_put_NXAST_SET_TUNNEL64(out)->tun_id = htonll(tun_id);
1105     }
1106 }
1107
1108 static void
1109 ofpact_note_to_nxast(const struct ofpact_note *note, struct ofpbuf *out)
1110 {
1111     size_t start_ofs = out->size;
1112     struct nx_action_note *nan;
1113     unsigned int remainder;
1114     unsigned int len;
1115
1116     nan = ofputil_put_NXAST_NOTE(out);
1117     out->size -= sizeof nan->note;
1118
1119     ofpbuf_put(out, note->data, note->length);
1120
1121     len = out->size - start_ofs;
1122     remainder = len % OFP_ACTION_ALIGN;
1123     if (remainder) {
1124         ofpbuf_put_zeros(out, OFP_ACTION_ALIGN - remainder);
1125     }
1126     nan = (struct nx_action_note *)((char *)out->data + start_ofs);
1127     nan->len = htons(out->size - start_ofs);
1128 }
1129
1130 static void
1131 ofpact_controller_to_nxast(const struct ofpact_controller *oc,
1132                            struct ofpbuf *out)
1133 {
1134     struct nx_action_controller *nac;
1135
1136     nac = ofputil_put_NXAST_CONTROLLER(out);
1137     nac->max_len = htons(oc->max_len);
1138     nac->controller_id = htons(oc->controller_id);
1139     nac->reason = oc->reason;
1140 }
1141
1142 static void
1143 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids *oc_ids,
1144                         struct ofpbuf *out)
1145 {
1146     if (oc_ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL) {
1147         ofputil_put_NXAST_DEC_TTL(out);
1148     } else {
1149         struct nx_action_cnt_ids *nac_ids =
1150             ofputil_put_NXAST_DEC_TTL_CNT_IDS(out);
1151         int ids_len = ROUND_UP(2 * oc_ids->n_controllers, OFP_ACTION_ALIGN);
1152         ovs_be16 *ids;
1153         size_t i;
1154
1155         nac_ids->len = htons(ntohs(nac_ids->len) + ids_len);
1156         nac_ids->n_controllers = htons(oc_ids->n_controllers);
1157
1158         ids = ofpbuf_put_zeros(out, ids_len);
1159         for (i = 0; i < oc_ids->n_controllers; i++) {
1160             ids[i] = htons(oc_ids->cnt_ids[i]);
1161         }
1162     }
1163 }
1164
1165 static void
1166 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout *fin_timeout,
1167                             struct ofpbuf *out)
1168 {
1169     struct nx_action_fin_timeout *naft = ofputil_put_NXAST_FIN_TIMEOUT(out);
1170     naft->fin_idle_timeout = htons(fin_timeout->fin_idle_timeout);
1171     naft->fin_hard_timeout = htons(fin_timeout->fin_hard_timeout);
1172 }
1173
1174 static void
1175 ofpact_to_nxast(const struct ofpact *a, struct ofpbuf *out)
1176 {
1177     switch (a->type) {
1178     case OFPACT_CONTROLLER:
1179         ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a), out);
1180         break;
1181
1182     case OFPACT_OUTPUT_REG:
1183         ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a), out);
1184         break;
1185
1186     case OFPACT_BUNDLE:
1187         bundle_to_nxast(ofpact_get_BUNDLE(a), out);
1188         break;
1189
1190     case OFPACT_REG_MOVE:
1191         nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a), out);
1192         break;
1193
1194     case OFPACT_REG_LOAD:
1195         nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a), out);
1196         break;
1197
1198     case OFPACT_DEC_TTL:
1199         ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a), out);
1200         break;
1201
1202     case OFPACT_SET_TUNNEL:
1203         ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a), out);
1204         break;
1205
1206     case OFPACT_SET_QUEUE:
1207         ofputil_put_NXAST_SET_QUEUE(out)->queue_id
1208             = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1209         break;
1210
1211     case OFPACT_POP_QUEUE:
1212         ofputil_put_NXAST_POP_QUEUE(out);
1213         break;
1214
1215     case OFPACT_FIN_TIMEOUT:
1216         ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a), out);
1217         break;
1218
1219     case OFPACT_RESUBMIT:
1220         ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a), out);
1221         break;
1222
1223     case OFPACT_LEARN:
1224         learn_to_nxast(ofpact_get_LEARN(a), out);
1225         break;
1226
1227     case OFPACT_MULTIPATH:
1228         multipath_to_nxast(ofpact_get_MULTIPATH(a), out);
1229         break;
1230
1231     case OFPACT_AUTOPATH:
1232         autopath_to_nxast(ofpact_get_AUTOPATH(a), out);
1233         break;
1234
1235     case OFPACT_NOTE:
1236         ofpact_note_to_nxast(ofpact_get_NOTE(a), out);
1237         break;
1238
1239     case OFPACT_EXIT:
1240         ofputil_put_NXAST_EXIT(out);
1241         break;
1242
1243     case OFPACT_OUTPUT:
1244     case OFPACT_ENQUEUE:
1245     case OFPACT_SET_VLAN_VID:
1246     case OFPACT_SET_VLAN_PCP:
1247     case OFPACT_STRIP_VLAN:
1248     case OFPACT_SET_ETH_SRC:
1249     case OFPACT_SET_ETH_DST:
1250     case OFPACT_SET_IPV4_SRC:
1251     case OFPACT_SET_IPV4_DST:
1252     case OFPACT_SET_IPV4_DSCP:
1253     case OFPACT_SET_L4_SRC_PORT:
1254     case OFPACT_SET_L4_DST_PORT:
1255         NOT_REACHED();
1256     }
1257 }
1258 \f
1259 /* Converting ofpacts to OpenFlow 1.0. */
1260
1261 static void
1262 ofpact_output_to_openflow10(const struct ofpact_output *output,
1263                             struct ofpbuf *out)
1264 {
1265     struct ofp10_action_output *oao;
1266
1267     oao = ofputil_put_OFPAT10_OUTPUT(out);
1268     oao->port = htons(output->port);
1269     oao->max_len = htons(output->max_len);
1270 }
1271
1272 static void
1273 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue *enqueue,
1274                              struct ofpbuf *out)
1275 {
1276     struct ofp_action_enqueue *oae;
1277
1278     oae = ofputil_put_OFPAT10_ENQUEUE(out);
1279     oae->port = htons(enqueue->port);
1280     oae->queue_id = htonl(enqueue->queue);
1281 }
1282
1283 static void
1284 ofpact_to_openflow10(const struct ofpact *a, struct ofpbuf *out)
1285 {
1286     switch (a->type) {
1287     case OFPACT_OUTPUT:
1288         ofpact_output_to_openflow10(ofpact_get_OUTPUT(a), out);
1289         break;
1290
1291     case OFPACT_ENQUEUE:
1292         ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a), out);
1293         break;
1294
1295     case OFPACT_SET_VLAN_VID:
1296         ofputil_put_OFPAT10_SET_VLAN_VID(out)->vlan_vid
1297             = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1298         break;
1299
1300     case OFPACT_SET_VLAN_PCP:
1301         ofputil_put_OFPAT10_SET_VLAN_PCP(out)->vlan_pcp
1302             = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1303         break;
1304
1305     case OFPACT_STRIP_VLAN:
1306         ofputil_put_OFPAT10_STRIP_VLAN(out);
1307         break;
1308
1309     case OFPACT_SET_ETH_SRC:
1310         memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out)->dl_addr,
1311                ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1312         break;
1313
1314     case OFPACT_SET_ETH_DST:
1315         memcpy(ofputil_put_OFPAT10_SET_DL_DST(out)->dl_addr,
1316                ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1317         break;
1318
1319     case OFPACT_SET_IPV4_SRC:
1320         ofputil_put_OFPAT10_SET_NW_SRC(out)->nw_addr
1321             = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1322         break;
1323
1324     case OFPACT_SET_IPV4_DST:
1325         ofputil_put_OFPAT10_SET_NW_DST(out)->nw_addr
1326             = ofpact_get_SET_IPV4_DST(a)->ipv4;
1327         break;
1328
1329     case OFPACT_SET_IPV4_DSCP:
1330         ofputil_put_OFPAT10_SET_NW_TOS(out)->nw_tos
1331             = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1332         break;
1333
1334     case OFPACT_SET_L4_SRC_PORT:
1335         ofputil_put_OFPAT10_SET_TP_SRC(out)->tp_port
1336             = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1337         break;
1338
1339     case OFPACT_SET_L4_DST_PORT:
1340         ofputil_put_OFPAT10_SET_TP_DST(out)->tp_port
1341             = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1342         break;
1343
1344     case OFPACT_CONTROLLER:
1345     case OFPACT_OUTPUT_REG:
1346     case OFPACT_BUNDLE:
1347     case OFPACT_REG_MOVE:
1348     case OFPACT_REG_LOAD:
1349     case OFPACT_DEC_TTL:
1350     case OFPACT_SET_TUNNEL:
1351     case OFPACT_SET_QUEUE:
1352     case OFPACT_POP_QUEUE:
1353     case OFPACT_FIN_TIMEOUT:
1354     case OFPACT_RESUBMIT:
1355     case OFPACT_LEARN:
1356     case OFPACT_MULTIPATH:
1357     case OFPACT_AUTOPATH:
1358     case OFPACT_NOTE:
1359     case OFPACT_EXIT:
1360         ofpact_to_nxast(a, out);
1361         break;
1362     }
1363 }
1364
1365 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow 1.0
1366  * actions in 'openflow', appending the actions to any existing data in
1367  * 'openflow'. */
1368 void
1369 ofpacts_put_openflow10(const struct ofpact ofpacts[], size_t ofpacts_len,
1370                        struct ofpbuf *openflow)
1371 {
1372     const struct ofpact *a;
1373
1374     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1375         ofpact_to_openflow10(a, openflow);
1376     }
1377 }
1378 \f
1379 /* Converting ofpacts to OpenFlow 1.1. */
1380
1381 static void
1382 ofpact_output_to_openflow11(const struct ofpact_output *output,
1383                             struct ofpbuf *out)
1384 {
1385     struct ofp11_action_output *oao;
1386
1387     oao = ofputil_put_OFPAT11_OUTPUT(out);
1388     oao->port = ofputil_port_to_ofp11(output->port);
1389     oao->max_len = htons(output->max_len);
1390 }
1391
1392 static void
1393 ofpact_to_openflow11(const struct ofpact *a, struct ofpbuf *out)
1394 {
1395     switch (a->type) {
1396     case OFPACT_OUTPUT:
1397         return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a), out);
1398
1399     case OFPACT_ENQUEUE:
1400         /* XXX */
1401         break;
1402
1403     case OFPACT_SET_VLAN_VID:
1404         ofputil_put_OFPAT11_SET_VLAN_VID(out)->vlan_vid
1405             = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1406         break;
1407
1408     case OFPACT_SET_VLAN_PCP:
1409         ofputil_put_OFPAT11_SET_VLAN_PCP(out)->vlan_pcp
1410             = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1411         break;
1412
1413     case OFPACT_STRIP_VLAN:
1414         /* XXX */
1415         break;
1416
1417     case OFPACT_SET_ETH_SRC:
1418         memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out)->dl_addr,
1419                ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1420         break;
1421
1422     case OFPACT_SET_ETH_DST:
1423         memcpy(ofputil_put_OFPAT11_SET_DL_DST(out)->dl_addr,
1424                ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1425         break;
1426
1427     case OFPACT_SET_IPV4_SRC:
1428         ofputil_put_OFPAT11_SET_NW_SRC(out)->nw_addr
1429             = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1430         break;
1431
1432     case OFPACT_SET_IPV4_DST:
1433         ofputil_put_OFPAT11_SET_NW_DST(out)->nw_addr
1434             = ofpact_get_SET_IPV4_DST(a)->ipv4;
1435         break;
1436
1437     case OFPACT_SET_IPV4_DSCP:
1438         ofputil_put_OFPAT11_SET_NW_TOS(out)->nw_tos
1439             = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1440         break;
1441
1442     case OFPACT_SET_L4_SRC_PORT:
1443         ofputil_put_OFPAT11_SET_TP_SRC(out)->tp_port
1444             = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1445         break;
1446
1447     case OFPACT_SET_L4_DST_PORT:
1448         ofputil_put_OFPAT11_SET_TP_DST(out)->tp_port
1449             = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1450         break;
1451
1452     case OFPACT_CONTROLLER:
1453     case OFPACT_OUTPUT_REG:
1454     case OFPACT_BUNDLE:
1455     case OFPACT_REG_MOVE:
1456     case OFPACT_REG_LOAD:
1457     case OFPACT_DEC_TTL:
1458     case OFPACT_SET_TUNNEL:
1459     case OFPACT_SET_QUEUE:
1460     case OFPACT_POP_QUEUE:
1461     case OFPACT_FIN_TIMEOUT:
1462     case OFPACT_RESUBMIT:
1463     case OFPACT_LEARN:
1464     case OFPACT_MULTIPATH:
1465     case OFPACT_AUTOPATH:
1466     case OFPACT_NOTE:
1467     case OFPACT_EXIT:
1468         ofpact_to_nxast(a, out);
1469         break;
1470     }
1471 }
1472
1473 /* Converts the ofpacts in 'ofpacts' (terminated by OFPACT_END) into OpenFlow
1474  * 1.1 actions in 'openflow', appending the actions to any existing data in
1475  * 'openflow'. */
1476 size_t
1477 ofpacts_put_openflow11_actions(const struct ofpact ofpacts[],
1478                                size_t ofpacts_len, struct ofpbuf *openflow)
1479 {
1480     const struct ofpact *a;
1481     size_t start_size = openflow->size;
1482
1483     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1484         ofpact_to_openflow11(a, openflow);
1485     }
1486
1487     return openflow->size - start_size;
1488 }
1489
1490 void
1491 ofpacts_put_openflow11_instructions(const struct ofpact ofpacts[],
1492                                     size_t ofpacts_len,
1493                                     struct ofpbuf *openflow)
1494 {
1495     struct ofp11_instruction_actions *oia;
1496     size_t ofs;
1497
1498     /* Put an OFPIT11_APPLY_ACTIONS instruction and fill it in. */
1499     ofs = openflow->size;
1500     instruction_put_OFPIT11_APPLY_ACTIONS(openflow);
1501     ofpacts_put_openflow11_actions(ofpacts, ofpacts_len, openflow);
1502
1503     /* Update the instruction's length (or, if it's empty, delete it). */
1504     oia = ofpbuf_at_assert(openflow, ofs, sizeof *oia);
1505     if (openflow->size > ofs + sizeof *oia) {
1506         oia->len = htons(openflow->size - ofs);
1507     } else {
1508         openflow->size = ofs;
1509     }
1510 }
1511 \f
1512 /* Returns true if 'action' outputs to 'port', false otherwise. */
1513 static bool
1514 ofpact_outputs_to_port(const struct ofpact *ofpact, uint16_t port)
1515 {
1516     switch (ofpact->type) {
1517     case OFPACT_OUTPUT:
1518         return ofpact_get_OUTPUT(ofpact)->port == port;
1519     case OFPACT_ENQUEUE:
1520         return ofpact_get_ENQUEUE(ofpact)->port == port;
1521     case OFPACT_CONTROLLER:
1522         return port == OFPP_CONTROLLER;
1523
1524     case OFPACT_OUTPUT_REG:
1525     case OFPACT_BUNDLE:
1526     case OFPACT_SET_VLAN_VID:
1527     case OFPACT_SET_VLAN_PCP:
1528     case OFPACT_STRIP_VLAN:
1529     case OFPACT_SET_ETH_SRC:
1530     case OFPACT_SET_ETH_DST:
1531     case OFPACT_SET_IPV4_SRC:
1532     case OFPACT_SET_IPV4_DST:
1533     case OFPACT_SET_IPV4_DSCP:
1534     case OFPACT_SET_L4_SRC_PORT:
1535     case OFPACT_SET_L4_DST_PORT:
1536     case OFPACT_REG_MOVE:
1537     case OFPACT_REG_LOAD:
1538     case OFPACT_DEC_TTL:
1539     case OFPACT_SET_TUNNEL:
1540     case OFPACT_SET_QUEUE:
1541     case OFPACT_POP_QUEUE:
1542     case OFPACT_FIN_TIMEOUT:
1543     case OFPACT_RESUBMIT:
1544     case OFPACT_LEARN:
1545     case OFPACT_MULTIPATH:
1546     case OFPACT_AUTOPATH:
1547     case OFPACT_NOTE:
1548     case OFPACT_EXIT:
1549     default:
1550         return false;
1551     }
1552 }
1553
1554 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
1555  * to 'port', false otherwise. */
1556 bool
1557 ofpacts_output_to_port(const struct ofpact *ofpacts, size_t ofpacts_len,
1558                        uint16_t port)
1559 {
1560     const struct ofpact *a;
1561
1562     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1563         if (ofpact_outputs_to_port(a, port)) {
1564             return true;
1565         }
1566     }
1567
1568     return false;
1569 }
1570
1571 bool
1572 ofpacts_equal(const struct ofpact *a, size_t a_len,
1573               const struct ofpact *b, size_t b_len)
1574 {
1575     return a_len == b_len && !memcmp(a, b, a_len);
1576 }
1577 \f
1578 /* Formatting ofpacts. */
1579
1580 static void
1581 print_note(const struct ofpact_note *note, struct ds *string)
1582 {
1583     size_t i;
1584
1585     ds_put_cstr(string, "note:");
1586     for (i = 0; i < note->length; i++) {
1587         if (i) {
1588             ds_put_char(string, '.');
1589         }
1590         ds_put_format(string, "%02"PRIx8, note->data[i]);
1591     }
1592 }
1593
1594 static void
1595 print_dec_ttl(const struct ofpact_cnt_ids *ids,
1596               struct ds *s)
1597 {
1598     size_t i;
1599
1600     ds_put_cstr(s, "dec_ttl");
1601     if (ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL_CNT_IDS) {
1602         ds_put_cstr(s, "(");
1603         for (i = 0; i < ids->n_controllers; i++) {
1604             if (i) {
1605                 ds_put_cstr(s, ",");
1606             }
1607             ds_put_format(s, "%"PRIu16, ids->cnt_ids[i]);
1608         }
1609         ds_put_cstr(s, ")");
1610     }
1611 }
1612
1613 static void
1614 print_fin_timeout(const struct ofpact_fin_timeout *fin_timeout,
1615                   struct ds *s)
1616 {
1617     ds_put_cstr(s, "fin_timeout(");
1618     if (fin_timeout->fin_idle_timeout) {
1619         ds_put_format(s, "idle_timeout=%"PRIu16",",
1620                       fin_timeout->fin_idle_timeout);
1621     }
1622     if (fin_timeout->fin_hard_timeout) {
1623         ds_put_format(s, "hard_timeout=%"PRIu16",",
1624                       fin_timeout->fin_hard_timeout);
1625     }
1626     ds_chomp(s, ',');
1627     ds_put_char(s, ')');
1628 }
1629
1630 static void
1631 ofpact_format(const struct ofpact *a, struct ds *s)
1632 {
1633     const struct ofpact_enqueue *enqueue;
1634     const struct ofpact_resubmit *resubmit;
1635     const struct ofpact_autopath *autopath;
1636     const struct ofpact_controller *controller;
1637     const struct ofpact_tunnel *tunnel;
1638     uint16_t port;
1639
1640     switch (a->type) {
1641     case OFPACT_OUTPUT:
1642         port = ofpact_get_OUTPUT(a)->port;
1643         if (port < OFPP_MAX) {
1644             ds_put_format(s, "output:%"PRIu16, port);
1645         } else {
1646             ofputil_format_port(port, s);
1647             if (port == OFPP_CONTROLLER) {
1648                 ds_put_format(s, ":%"PRIu16, ofpact_get_OUTPUT(a)->max_len);
1649             }
1650         }
1651         break;
1652
1653     case OFPACT_CONTROLLER:
1654         controller = ofpact_get_CONTROLLER(a);
1655         if (controller->reason == OFPR_ACTION &&
1656             controller->controller_id == 0) {
1657             ds_put_format(s, "CONTROLLER:%"PRIu16,
1658                           ofpact_get_CONTROLLER(a)->max_len);
1659         } else {
1660             enum ofp_packet_in_reason reason = controller->reason;
1661
1662             ds_put_cstr(s, "controller(");
1663             if (reason != OFPR_ACTION) {
1664                 ds_put_format(s, "reason=%s,",
1665                               ofputil_packet_in_reason_to_string(reason));
1666             }
1667             if (controller->max_len != UINT16_MAX) {
1668                 ds_put_format(s, "max_len=%"PRIu16",", controller->max_len);
1669             }
1670             if (controller->controller_id != 0) {
1671                 ds_put_format(s, "id=%"PRIu16",", controller->controller_id);
1672             }
1673             ds_chomp(s, ',');
1674             ds_put_char(s, ')');
1675         }
1676         break;
1677
1678     case OFPACT_ENQUEUE:
1679         enqueue = ofpact_get_ENQUEUE(a);
1680         ds_put_format(s, "enqueue:");
1681         ofputil_format_port(enqueue->port, s);
1682         ds_put_format(s, "q%"PRIu32, enqueue->queue);
1683         break;
1684
1685     case OFPACT_OUTPUT_REG:
1686         ds_put_cstr(s, "output:");
1687         mf_format_subfield(&ofpact_get_OUTPUT_REG(a)->src, s);
1688         break;
1689
1690     case OFPACT_BUNDLE:
1691         bundle_format(ofpact_get_BUNDLE(a), s);
1692         break;
1693
1694     case OFPACT_SET_VLAN_VID:
1695         ds_put_format(s, "mod_vlan_vid:%"PRIu16,
1696                       ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1697         break;
1698
1699     case OFPACT_SET_VLAN_PCP:
1700         ds_put_format(s, "mod_vlan_pcp:%"PRIu8,
1701                       ofpact_get_SET_VLAN_PCP(a)->vlan_pcp);
1702         break;
1703
1704     case OFPACT_STRIP_VLAN:
1705         ds_put_cstr(s, "strip_vlan");
1706         break;
1707
1708     case OFPACT_SET_ETH_SRC:
1709         ds_put_format(s, "mod_dl_src:"ETH_ADDR_FMT,
1710                       ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a)->mac));
1711         break;
1712
1713     case OFPACT_SET_ETH_DST:
1714         ds_put_format(s, "mod_dl_dst:"ETH_ADDR_FMT,
1715                       ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a)->mac));
1716         break;
1717
1718     case OFPACT_SET_IPV4_SRC:
1719         ds_put_format(s, "mod_nw_src:"IP_FMT,
1720                       IP_ARGS(&ofpact_get_SET_IPV4_SRC(a)->ipv4));
1721         break;
1722
1723     case OFPACT_SET_IPV4_DST:
1724         ds_put_format(s, "mod_nw_dst:"IP_FMT,
1725                       IP_ARGS(&ofpact_get_SET_IPV4_DST(a)->ipv4));
1726         break;
1727
1728     case OFPACT_SET_IPV4_DSCP:
1729         ds_put_format(s, "mod_nw_tos:%d", ofpact_get_SET_IPV4_DSCP(a)->dscp);
1730         break;
1731
1732     case OFPACT_SET_L4_SRC_PORT:
1733         ds_put_format(s, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a)->port);
1734         break;
1735
1736     case OFPACT_SET_L4_DST_PORT:
1737         ds_put_format(s, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a)->port);
1738         break;
1739
1740     case OFPACT_REG_MOVE:
1741         nxm_format_reg_move(ofpact_get_REG_MOVE(a), s);
1742         break;
1743
1744     case OFPACT_REG_LOAD:
1745         nxm_format_reg_load(ofpact_get_REG_LOAD(a), s);
1746         break;
1747
1748     case OFPACT_DEC_TTL:
1749         print_dec_ttl(ofpact_get_DEC_TTL(a), s);
1750         break;
1751
1752     case OFPACT_SET_TUNNEL:
1753         tunnel = ofpact_get_SET_TUNNEL(a);
1754         ds_put_format(s, "set_tunnel%s:%#"PRIx64,
1755                       (tunnel->tun_id > UINT32_MAX
1756                        || a->compat == OFPUTIL_NXAST_SET_TUNNEL64 ? "64" : ""),
1757                       tunnel->tun_id);
1758         break;
1759
1760     case OFPACT_SET_QUEUE:
1761         ds_put_format(s, "set_queue:%"PRIu32,
1762                       ofpact_get_SET_QUEUE(a)->queue_id);
1763         break;
1764
1765     case OFPACT_POP_QUEUE:
1766         ds_put_cstr(s, "pop_queue");
1767         break;
1768
1769     case OFPACT_FIN_TIMEOUT:
1770         print_fin_timeout(ofpact_get_FIN_TIMEOUT(a), s);
1771         break;
1772
1773     case OFPACT_RESUBMIT:
1774         resubmit = ofpact_get_RESUBMIT(a);
1775         if (resubmit->in_port != OFPP_IN_PORT && resubmit->table_id == 255) {
1776             ds_put_format(s, "resubmit:%"PRIu16, resubmit->in_port);
1777         } else {
1778             ds_put_format(s, "resubmit(");
1779             if (resubmit->in_port != OFPP_IN_PORT) {
1780                 ofputil_format_port(resubmit->in_port, s);
1781             }
1782             ds_put_char(s, ',');
1783             if (resubmit->table_id != 255) {
1784                 ds_put_format(s, "%"PRIu8, resubmit->table_id);
1785             }
1786             ds_put_char(s, ')');
1787         }
1788         break;
1789
1790     case OFPACT_LEARN:
1791         learn_format(ofpact_get_LEARN(a), s);
1792         break;
1793
1794     case OFPACT_MULTIPATH:
1795         multipath_format(ofpact_get_MULTIPATH(a), s);
1796         break;
1797
1798     case OFPACT_AUTOPATH:
1799         autopath = ofpact_get_AUTOPATH(a);
1800         ds_put_format(s, "autopath(%u,", autopath->port);
1801         mf_format_subfield(&autopath->dst, s);
1802         ds_put_char(s, ')');
1803         break;
1804
1805     case OFPACT_NOTE:
1806         print_note(ofpact_get_NOTE(a), s);
1807         break;
1808
1809     case OFPACT_EXIT:
1810         ds_put_cstr(s, "exit");
1811         break;
1812     }
1813 }
1814
1815 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
1816  * 'ofpacts' to 'string'. */
1817 void
1818 ofpacts_format(const struct ofpact *ofpacts, size_t ofpacts_len,
1819                struct ds *string)
1820 {
1821     ds_put_cstr(string, "actions=");
1822     if (!ofpacts_len) {
1823         ds_put_cstr(string, "drop");
1824     } else {
1825         const struct ofpact *a;
1826
1827         OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1828             if (a != ofpacts) {
1829                 ds_put_cstr(string, ",");
1830             }
1831             ofpact_format(a, string);
1832         }
1833     }
1834 }
1835 \f
1836 /* Internal use by helpers. */
1837
1838 void *
1839 ofpact_put(struct ofpbuf *ofpacts, enum ofpact_type type, size_t len)
1840 {
1841     struct ofpact *ofpact;
1842
1843     ofpact_pad(ofpacts);
1844     ofpact = ofpacts->l2 = ofpbuf_put_uninit(ofpacts, len);
1845     ofpact_init(ofpact, type, len);
1846     return ofpact;
1847 }
1848
1849 void
1850 ofpact_init(struct ofpact *ofpact, enum ofpact_type type, size_t len)
1851 {
1852     memset(ofpact, 0, len);
1853     ofpact->type = type;
1854     ofpact->compat = OFPUTIL_ACTION_INVALID;
1855     ofpact->len = len;
1856 }
1857 \f
1858 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
1859  * starting at 'ofpact'.
1860  *
1861  * This is the correct way to update a variable-length ofpact's length after
1862  * adding the variable-length part of the payload.  (See the large comment
1863  * near the end of ofp-actions.h for more information.) */
1864 void
1865 ofpact_update_len(struct ofpbuf *ofpacts, struct ofpact *ofpact)
1866 {
1867     assert(ofpact == ofpacts->l2);
1868     ofpact->len = (char *) ofpbuf_tail(ofpacts) - (char *) ofpact;
1869 }
1870
1871 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length.  Each
1872  * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
1873  * client must call this itself after adding the final ofpact to an array of
1874  * them.
1875  *
1876  * (The consequences of failing to call this function are probably not dire.
1877  * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
1878  * not dereference it.  That's undefined behavior, technically, but it will not
1879  * cause a real problem on common systems.  Still, it seems better to call
1880  * it.) */
1881 void
1882 ofpact_pad(struct ofpbuf *ofpacts)
1883 {
1884     unsigned int rem = ofpacts->size % OFPACT_ALIGNTO;
1885     if (rem) {
1886         ofpbuf_put_zeros(ofpacts, OFPACT_ALIGNTO - rem);
1887     }
1888 }