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