lib/ofp-actions.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "ofp-actions.h"
  19 #include "bundle.h"
  20 #include "byte-order.h"
  21 #include "compiler.h"
  22 #include "dynamic-string.h"
  23 #include "learn.h"
  24 #include "meta-flow.h"
  25 #include "multipath.h"
  26 #include "nx-match.h"
  27 #include "ofp-util.h"
  28 #include "ofpbuf.h"
  29 #include "util.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 union ofp_action {
  39     ovs_be16 type;
  40     struct ofp_action_header header;
  41     struct ofp_action_vendor_header vendor;
  42     struct ofp10_action_output output10;
  43     struct ofp_action_vlan_vid vlan_vid;
  44     struct ofp_action_vlan_pcp vlan_pcp;
  45     struct ofp_action_nw_addr nw_addr;
  46     struct ofp_action_nw_tos nw_tos;
  47     struct ofp11_action_nw_ecn nw_ecn;
  48     struct ofp11_action_nw_ttl nw_ttl;
  49     struct ofp_action_tp_port tp_port;
  50     struct ofp_action_dl_addr dl_addr;
  51     struct ofp10_action_enqueue enqueue;
  52     struct ofp11_action_output ofp11_output;
  53     struct ofp11_action_push push;
  54     struct ofp11_action_pop_mpls ofp11_pop_mpls;
  55     struct ofp11_action_set_queue ofp11_set_queue;
  56     struct ofp11_action_mpls_label ofp11_mpls_label;
  57     struct ofp11_action_mpls_tc ofp11_mpls_tc;
  58     struct ofp11_action_mpls_ttl ofp11_mpls_ttl;
  59     struct ofp11_action_group group;
  60     struct ofp12_action_set_field set_field;
  61     struct nx_action_header nxa_header;
  62     struct nx_action_resubmit resubmit;
  63     struct nx_action_set_tunnel set_tunnel;
  64     struct nx_action_set_tunnel64 set_tunnel64;
  65     struct nx_action_write_metadata write_metadata;
  66     struct nx_action_set_queue set_queue;
  67     struct nx_action_reg_move reg_move;
  68     struct nx_action_reg_load reg_load;
  69     struct nx_action_stack stack;
  70     struct nx_action_note note;
  71     struct nx_action_multipath multipath;
  72     struct nx_action_bundle bundle;
  73     struct nx_action_output_reg output_reg;
  74     struct nx_action_cnt_ids cnt_ids;
  75     struct nx_action_fin_timeout fin_timeout;
  76     struct nx_action_controller controller;
  77     struct nx_action_push_mpls push_mpls;
  78     struct nx_action_mpls_ttl mpls_ttl;
  79     struct nx_action_pop_mpls pop_mpls;
  80     struct nx_action_sample sample;
  81     struct nx_action_learn learn;
  82     struct nx_action_mpls_label mpls_label;
  83     struct nx_action_mpls_tc mpls_tc;
  84 };
  85
  86 static enum ofperr
  87 output_from_openflow10(const struct ofp10_action_output *oao,
  88                        struct ofpbuf *out)
  89 {
  90     struct ofpact_output *output;
  91
  92     output = ofpact_put_OUTPUT(out);
  93     output->port = u16_to_ofp(ntohs(oao->port));
  94     output->max_len = ntohs(oao->max_len);
  95
  96     return ofpact_check_output_port(output->port, OFPP_MAX);
  97 }
  98
  99 static enum ofperr
 100 enqueue_from_openflow10(const struct ofp10_action_enqueue *oae,
 101                         struct ofpbuf *out)
 102 {
 103     struct ofpact_enqueue *enqueue;
 104
 105     enqueue = ofpact_put_ENQUEUE(out);
 106     enqueue->port = u16_to_ofp(ntohs(oae->port));
 107     enqueue->queue = ntohl(oae->queue_id);
 108     if (ofp_to_u16(enqueue->port) >= ofp_to_u16(OFPP_MAX)
 109         && enqueue->port != OFPP_IN_PORT
 110         && enqueue->port != OFPP_LOCAL) {
 111         return OFPERR_OFPBAC_BAD_OUT_PORT;
 112     }
 113     return 0;
 114 }
 115
 116 static void
 117 resubmit_from_openflow(const struct nx_action_resubmit *nar,
 118                        struct ofpbuf *out)
 119 {
 120     struct ofpact_resubmit *resubmit;
 121
 122     resubmit = ofpact_put_RESUBMIT(out);
 123     resubmit->ofpact.compat = OFPUTIL_NXAST_RESUBMIT;
 124     resubmit->in_port = u16_to_ofp(ntohs(nar->in_port));
 125     resubmit->table_id = 0xff;
 126 }
 127
 128 static enum ofperr
 129 resubmit_table_from_openflow(const struct nx_action_resubmit *nar,
 130                              struct ofpbuf *out)
 131 {
 132     struct ofpact_resubmit *resubmit;
 133
 134     if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
 135         return OFPERR_OFPBAC_BAD_ARGUMENT;
 136     }
 137
 138     resubmit = ofpact_put_RESUBMIT(out);
 139     resubmit->ofpact.compat = OFPUTIL_NXAST_RESUBMIT_TABLE;
 140     resubmit->in_port = u16_to_ofp(ntohs(nar->in_port));
 141     resubmit->table_id = nar->table;
 142     return 0;
 143 }
 144
 145 static enum ofperr
 146 output_reg_from_openflow(const struct nx_action_output_reg *naor,
 147                          struct ofpbuf *out)
 148 {
 149     struct ofpact_output_reg *output_reg;
 150
 151     if (!is_all_zeros(naor->zero, sizeof naor->zero)) {
 152         return OFPERR_OFPBAC_BAD_ARGUMENT;
 153     }
 154
 155     output_reg = ofpact_put_OUTPUT_REG(out);
 156     output_reg->src.field = mf_from_nxm_header(ntohl(naor->src));
 157     output_reg->src.ofs = nxm_decode_ofs(naor->ofs_nbits);
 158     output_reg->src.n_bits = nxm_decode_n_bits(naor->ofs_nbits);
 159     output_reg->max_len = ntohs(naor->max_len);
 160
 161     return mf_check_src(&output_reg->src, NULL);
 162 }
 163
 164 static void
 165 fin_timeout_from_openflow(const struct nx_action_fin_timeout *naft,
 166                           struct ofpbuf *out)
 167 {
 168     struct ofpact_fin_timeout *oft;
 169
 170     oft = ofpact_put_FIN_TIMEOUT(out);
 171     oft->fin_idle_timeout = ntohs(naft->fin_idle_timeout);
 172     oft->fin_hard_timeout = ntohs(naft->fin_hard_timeout);
 173 }
 174
 175 static void
 176 controller_from_openflow(const struct nx_action_controller *nac,
 177                          struct ofpbuf *out)
 178 {
 179     struct ofpact_controller *oc;
 180
 181     oc = ofpact_put_CONTROLLER(out);
 182     oc->max_len = ntohs(nac->max_len);
 183     oc->controller_id = ntohs(nac->controller_id);
 184     oc->reason = nac->reason;
 185 }
 186
 187 static enum ofperr
 188 metadata_from_nxast(const struct nx_action_write_metadata *nawm,
 189                     struct ofpbuf *out)
 190 {
 191     struct ofpact_metadata *om;
 192
 193     if (!is_all_zeros(nawm->zeros, sizeof nawm->zeros)) {
 194         return OFPERR_NXBRC_MUST_BE_ZERO;
 195     }
 196
 197     om = ofpact_put_WRITE_METADATA(out);
 198     om->metadata = nawm->metadata;
 199     om->mask = nawm->mask;
 200
 201     return 0;
 202 }
 203
 204 static void
 205 note_from_openflow(const struct nx_action_note *nan, struct ofpbuf *out)
 206 {
 207     struct ofpact_note *note;
 208     unsigned int length;
 209
 210     length = ntohs(nan->len) - offsetof(struct nx_action_note, note);
 211     note = ofpact_put(out, OFPACT_NOTE,
 212                       offsetof(struct ofpact_note, data) + length);
 213     note->length = length;
 214     memcpy(note->data, nan->note, length);
 215 }
 216
 217 static enum ofperr
 218 dec_ttl_from_openflow(struct ofpbuf *out, enum ofputil_action_code compat)
 219 {
 220     uint16_t id = 0;
 221     struct ofpact_cnt_ids *ids;
 222     enum ofperr error = 0;
 223
 224     ids = ofpact_put_DEC_TTL(out);
 225     ids->ofpact.compat = compat;
 226     ids->n_controllers = 1;
 227     ofpbuf_put(out, &id, sizeof id);
 228     ids = out->l2;
 229     ofpact_update_len(out, &ids->ofpact);
 230     return error;
 231 }
 232
 233 static enum ofperr
 234 dec_ttl_cnt_ids_from_openflow(const struct nx_action_cnt_ids *nac_ids,
 235                               struct ofpbuf *out)
 236 {
 237     struct ofpact_cnt_ids *ids;
 238     size_t ids_size;
 239     int i;
 240
 241     ids = ofpact_put_DEC_TTL(out);
 242     ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
 243     ids->n_controllers = ntohs(nac_ids->n_controllers);
 244     ids_size = ntohs(nac_ids->len) - sizeof *nac_ids;
 245
 246     if (!is_all_zeros(nac_ids->zeros, sizeof nac_ids->zeros)) {
 247         return OFPERR_NXBRC_MUST_BE_ZERO;
 248     }
 249
 250     if (ids_size < ids->n_controllers * sizeof(ovs_be16)) {
 251         VLOG_WARN_RL(&rl, "Nicira action dec_ttl_cnt_ids only has %"PRIuSIZE" bytes "
 252                      "allocated for controller ids.  %"PRIuSIZE" bytes are required for "
 253                      "%"PRIu16" controllers.", ids_size,
 254                      ids->n_controllers * sizeof(ovs_be16), ids->n_controllers);
 255         return OFPERR_OFPBAC_BAD_LEN;
 256     }
 257
 258     for (i = 0; i < ids->n_controllers; i++) {
 259         uint16_t id = ntohs(((ovs_be16 *)(nac_ids + 1))[i]);
 260         ofpbuf_put(out, &id, sizeof id);
 261         ids = out->l2;
 262     }
 263
 264     ofpact_update_len(out, &ids->ofpact);
 265
 266     return 0;
 267 }
 268
 269 static enum ofperr
 270 sample_from_openflow(const struct nx_action_sample *nas,
 271                      struct ofpbuf *out)
 272 {
 273     struct ofpact_sample *sample;
 274
 275     sample = ofpact_put_SAMPLE(out);
 276     sample->probability = ntohs(nas->probability);
 277     sample->collector_set_id = ntohl(nas->collector_set_id);
 278     sample->obs_domain_id = ntohl(nas->obs_domain_id);
 279     sample->obs_point_id = ntohl(nas->obs_point_id);
 280
 281     if (sample->probability == 0) {
 282         return OFPERR_OFPBAC_BAD_ARGUMENT;
 283     }
 284
 285     return 0;
 286 }
 287
 288 static enum ofperr
 289 push_mpls_from_openflow(ovs_be16 ethertype, struct ofpbuf *out)
 290 {
 291     struct ofpact_push_mpls *oam;
 292
 293     if (!eth_type_mpls(ethertype)) {
 294         return OFPERR_OFPBAC_BAD_ARGUMENT;
 295     }
 296     oam = ofpact_put_PUSH_MPLS(out);
 297     oam->ethertype = ethertype;
 298
 299     return 0;
 300 }
 301
 302 static enum ofperr
 303 decode_nxast_action(const union ofp_action *a, enum ofputil_action_code *code)
 304 {
 305     const struct nx_action_header *nah = &a->nxa_header;
 306     uint16_t len = ntohs(a->header.len);
 307
 308     if (len < sizeof(struct nx_action_header)) {
 309         return OFPERR_OFPBAC_BAD_LEN;
 310     } else if (a->vendor.vendor != CONSTANT_HTONL(NX_VENDOR_ID)) {
 311         return OFPERR_OFPBAC_BAD_VENDOR;
 312     }
 313
 314     switch (nah->subtype) {
 315 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 316         case CONSTANT_HTONS(ENUM):                      \
 317             if (EXTENSIBLE                              \
 318                 ? len >= sizeof(struct STRUCT)          \
 319                 : len == sizeof(struct STRUCT)) {       \
 320                 *code = OFPUTIL_##ENUM;                 \
 321                 return 0;                               \
 322             } else {                                    \
 323                 return OFPERR_OFPBAC_BAD_LEN;           \
 324             }                                           \
 325             OVS_NOT_REACHED();
 326 #include "ofp-util.def"
 327
 328     case CONSTANT_HTONS(NXAST_SNAT__OBSOLETE):
 329     case CONSTANT_HTONS(NXAST_DROP_SPOOFED_ARP__OBSOLETE):
 330     default:
 331         return OFPERR_OFPBAC_BAD_TYPE;
 332     }
 333 }
 334
 335 /* Parses 'a' to determine its type.  On success stores the correct type into
 336  * '*code' and returns 0.  On failure returns an OFPERR_* error code and
 337  * '*code' is indeterminate.
 338  *
 339  * The caller must have already verified that 'a''s length is potentially
 340  * correct (that is, a->header.len is nonzero and a multiple of
 341  * OFP_ACTION_ALIGN and no longer than the amount of space allocated to 'a').
 342  *
 343  * This function verifies that 'a''s length is correct for the type of action
 344  * that it represents. */
 345 static enum ofperr
 346 decode_openflow10_action(const union ofp_action *a,
 347                          enum ofputil_action_code *code)
 348 {
 349     switch (a->type) {
 350     case CONSTANT_HTONS(OFPAT10_VENDOR):
 351         return decode_nxast_action(a, code);
 352
 353 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                          \
 354         case CONSTANT_HTONS(ENUM):                                  \
 355             if (a->header.len == htons(sizeof(struct STRUCT))) {    \
 356                 *code = OFPUTIL_##ENUM;                             \
 357                 return 0;                                           \
 358             } else {                                                \
 359                 return OFPERR_OFPBAC_BAD_LEN;                       \
 360             }                                                       \
 361             break;
 362 #include "ofp-util.def"
 363
 364     default:
 365         return OFPERR_OFPBAC_BAD_TYPE;
 366     }
 367 }
 368
 369 static enum ofperr
 370 ofpact_from_nxast(const union ofp_action *a, enum ofputil_action_code code,
 371                   struct ofpbuf *out)
 372 {
 373     struct ofpact_tunnel *tunnel;
 374     enum ofperr error = 0;
 375
 376     switch (code) {
 377     case OFPUTIL_ACTION_INVALID:
 378 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
 379 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 380 #include "ofp-util.def"
 381         OVS_NOT_REACHED();
 382
 383     case OFPUTIL_NXAST_RESUBMIT:
 384         resubmit_from_openflow(&a->resubmit, out);
 385         break;
 386
 387     case OFPUTIL_NXAST_SET_TUNNEL:
 388         tunnel = ofpact_put_SET_TUNNEL(out);
 389         tunnel->ofpact.compat = code;
 390         tunnel->tun_id = ntohl(a->set_tunnel.tun_id);
 391         break;
 392
 393     case OFPUTIL_NXAST_WRITE_METADATA:
 394         error = metadata_from_nxast(&a->write_metadata, out);
 395         break;
 396
 397     case OFPUTIL_NXAST_SET_QUEUE:
 398         ofpact_put_SET_QUEUE(out)->queue_id = ntohl(a->set_queue.queue_id);
 399         break;
 400
 401     case OFPUTIL_NXAST_POP_QUEUE:
 402         ofpact_put_POP_QUEUE(out);
 403         break;
 404
 405     case OFPUTIL_NXAST_REG_MOVE:
 406         error = nxm_reg_move_from_openflow(&a->reg_move, out);
 407         break;
 408
 409     case OFPUTIL_NXAST_REG_LOAD:
 410         error = nxm_reg_load_from_openflow(&a->reg_load, out);
 411         break;
 412
 413     case OFPUTIL_NXAST_STACK_PUSH:
 414         error = nxm_stack_push_from_openflow(&a->stack, out);
 415         break;
 416
 417     case OFPUTIL_NXAST_STACK_POP:
 418         error = nxm_stack_pop_from_openflow(&a->stack, out);
 419         break;
 420
 421     case OFPUTIL_NXAST_NOTE:
 422         note_from_openflow(&a->note, out);
 423         break;
 424
 425     case OFPUTIL_NXAST_SET_TUNNEL64:
 426         tunnel = ofpact_put_SET_TUNNEL(out);
 427         tunnel->ofpact.compat = code;
 428         tunnel->tun_id = ntohll(a->set_tunnel64.tun_id);
 429         break;
 430
 431     case OFPUTIL_NXAST_MULTIPATH:
 432         error = multipath_from_openflow(&a->multipath,
 433                                         ofpact_put_MULTIPATH(out));
 434         break;
 435
 436     case OFPUTIL_NXAST_BUNDLE:
 437     case OFPUTIL_NXAST_BUNDLE_LOAD:
 438         error = bundle_from_openflow(&a->bundle, out);
 439         break;
 440
 441     case OFPUTIL_NXAST_OUTPUT_REG:
 442         error = output_reg_from_openflow(&a->output_reg, out);
 443         break;
 444
 445     case OFPUTIL_NXAST_RESUBMIT_TABLE:
 446         error = resubmit_table_from_openflow(&a->resubmit, out);
 447         break;
 448
 449     case OFPUTIL_NXAST_LEARN:
 450         error = learn_from_openflow(&a->learn, out);
 451         break;
 452
 453     case OFPUTIL_NXAST_EXIT:
 454         ofpact_put_EXIT(out);
 455         break;
 456
 457     case OFPUTIL_NXAST_DEC_TTL:
 458         error = dec_ttl_from_openflow(out, code);
 459         break;
 460
 461     case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
 462         error = dec_ttl_cnt_ids_from_openflow(&a->cnt_ids, out);
 463         break;
 464
 465     case OFPUTIL_NXAST_FIN_TIMEOUT:
 466         fin_timeout_from_openflow(&a->fin_timeout, out);
 467         break;
 468
 469     case OFPUTIL_NXAST_CONTROLLER:
 470         controller_from_openflow(&a->controller, out);
 471         break;
 472
 473     case OFPUTIL_NXAST_PUSH_MPLS:
 474         error = push_mpls_from_openflow(a->push_mpls.ethertype, out);
 475         break;
 476
 477     case OFPUTIL_NXAST_SET_MPLS_LABEL:
 478         ofpact_put_SET_MPLS_LABEL(out)->label = a->mpls_label.label;
 479         break;
 480
 481     case OFPUTIL_NXAST_SET_MPLS_TC:
 482         ofpact_put_SET_MPLS_TC(out)->tc = a->mpls_tc.tc;
 483         break;
 484
 485     case OFPUTIL_NXAST_SET_MPLS_TTL:
 486         ofpact_put_SET_MPLS_TTL(out)->ttl = a->mpls_ttl.ttl;
 487         break;
 488
 489     case OFPUTIL_NXAST_DEC_MPLS_TTL:
 490         ofpact_put_DEC_MPLS_TTL(out);
 491         break;
 492
 493     case OFPUTIL_NXAST_POP_MPLS:
 494         if (eth_type_mpls(a->pop_mpls.ethertype)) {
 495             return OFPERR_OFPBAC_BAD_ARGUMENT;
 496         }
 497         ofpact_put_POP_MPLS(out)->ethertype = a->pop_mpls.ethertype;
 498         break;
 499
 500     case OFPUTIL_NXAST_SAMPLE:
 501         error = sample_from_openflow(&a->sample, out);
 502         break;
 503     }
 504
 505     return error;
 506 }
 507
 508 static enum ofperr
 509 ofpact_from_openflow10(const union ofp_action *a,
 510                        enum ofp_version version OVS_UNUSED,
 511                        struct ofpbuf *out)
 512 {
 513     enum ofputil_action_code code;
 514     enum ofperr error;
 515     struct ofpact_vlan_vid *vlan_vid;
 516     struct ofpact_vlan_pcp *vlan_pcp;
 517
 518     error = decode_openflow10_action(a, &code);
 519     if (error) {
 520         return error;
 521     }
 522
 523     switch (code) {
 524     case OFPUTIL_ACTION_INVALID:
 525 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 526 #include "ofp-util.def"
 527         OVS_NOT_REACHED();
 528
 529     case OFPUTIL_OFPAT10_OUTPUT:
 530         return output_from_openflow10(&a->output10, out);
 531
 532     case OFPUTIL_OFPAT10_SET_VLAN_VID:
 533         if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
 534             return OFPERR_OFPBAC_BAD_ARGUMENT;
 535         }
 536         vlan_vid = ofpact_put_SET_VLAN_VID(out);
 537         vlan_vid->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
 538         vlan_vid->push_vlan_if_needed = true;
 539         vlan_vid->ofpact.compat = code;
 540         break;
 541
 542     case OFPUTIL_OFPAT10_SET_VLAN_PCP:
 543         if (a->vlan_pcp.vlan_pcp & ~7) {
 544             return OFPERR_OFPBAC_BAD_ARGUMENT;
 545         }
 546         vlan_pcp = ofpact_put_SET_VLAN_PCP(out);
 547         vlan_pcp->vlan_pcp = a->vlan_pcp.vlan_pcp;
 548         vlan_pcp->push_vlan_if_needed = true;
 549         vlan_pcp->ofpact.compat = code;
 550         break;
 551
 552     case OFPUTIL_OFPAT10_STRIP_VLAN:
 553         ofpact_put_STRIP_VLAN(out)->ofpact.compat = code;
 554         break;
 555
 556     case OFPUTIL_OFPAT10_SET_DL_SRC:
 557         memcpy(ofpact_put_SET_ETH_SRC(out)->mac, a->dl_addr.dl_addr,
 558                ETH_ADDR_LEN);
 559         break;
 560
 561     case OFPUTIL_OFPAT10_SET_DL_DST:
 562         memcpy(ofpact_put_SET_ETH_DST(out)->mac, a->dl_addr.dl_addr,
 563                ETH_ADDR_LEN);
 564         break;
 565
 566     case OFPUTIL_OFPAT10_SET_NW_SRC:
 567         ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
 568         break;
 569
 570     case OFPUTIL_OFPAT10_SET_NW_DST:
 571         ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
 572         break;
 573
 574     case OFPUTIL_OFPAT10_SET_NW_TOS:
 575         if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
 576             return OFPERR_OFPBAC_BAD_ARGUMENT;
 577         }
 578         ofpact_put_SET_IP_DSCP(out)->dscp = a->nw_tos.nw_tos;
 579         break;
 580
 581     case OFPUTIL_OFPAT10_SET_TP_SRC:
 582         ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
 583         break;
 584
 585     case OFPUTIL_OFPAT10_SET_TP_DST:
 586         ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
 587
 588         break;
 589
 590     case OFPUTIL_OFPAT10_ENQUEUE:
 591         error = enqueue_from_openflow10(&a->enqueue, out);
 592         break;
 593
 594 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 595 #include "ofp-util.def"
 596         return ofpact_from_nxast(a, code, out);
 597     }
 598
 599     return error;
 600 }
 601
 602 static enum ofperr ofpact_from_openflow11(const union ofp_action *,
 603                                           enum ofp_version,
 604                                           struct ofpbuf *out);
 605
 606 static inline union ofp_action *
 607 action_next(const union ofp_action *a)
 608 {
 609     return ((union ofp_action *) (void *)
 610             ((uint8_t *) a + ntohs(a->header.len)));
 611 }
 612
 613 static inline bool
 614 action_is_valid(const union ofp_action *a, size_t max_actions)
 615 {
 616     uint16_t len = ntohs(a->header.len);
 617     return (!(len % OFP_ACTION_ALIGN)
 618             && len >= OFP_ACTION_ALIGN
 619             && len / OFP_ACTION_ALIGN <= max_actions);
 620 }
 621
 622 /* This macro is careful to check for actions with bad lengths. */
 623 #define ACTION_FOR_EACH(ITER, LEFT, ACTIONS, MAX_ACTIONS)                 \
 624     for ((ITER) = (ACTIONS), (LEFT) = (MAX_ACTIONS);                      \
 625          (LEFT) > 0 && action_is_valid(ITER, LEFT);                     \
 626          ((LEFT) -= ntohs((ITER)->header.len) / OFP_ACTION_ALIGN, \
 627           (ITER) = action_next(ITER)))
 628
 629 static void
 630 log_bad_action(const union ofp_action *actions, size_t max_actions,
 631                const union ofp_action *bad_action, enum ofperr error)
 632 {
 633     if (!VLOG_DROP_WARN(&rl)) {
 634         struct ds s;
 635
 636         ds_init(&s);
 637         ds_put_hex_dump(&s, actions, max_actions * OFP_ACTION_ALIGN, 0, false);
 638         VLOG_WARN("bad action at offset %#"PRIxPTR" (%s):\n%s",
 639                   (char *)bad_action - (char *)actions,
 640                   ofperr_get_name(error), ds_cstr(&s));
 641         ds_destroy(&s);
 642     }
 643 }
 644
 645 static enum ofperr
 646 ofpacts_from_openflow(const union ofp_action *in, size_t n_in,
 647                       enum ofp_version version, struct ofpbuf *out)
 648 {
 649     const union ofp_action *a;
 650     size_t left;
 651
 652     enum ofperr (*ofpact_from_openflow)(const union ofp_action *a,
 653                                         enum ofp_version,
 654                                         struct ofpbuf *out) =
 655         (version == OFP10_VERSION) ?
 656         ofpact_from_openflow10 : ofpact_from_openflow11;
 657
 658     ACTION_FOR_EACH (a, left, in, n_in) {
 659         enum ofperr error = ofpact_from_openflow(a, version, out);
 660         if (error) {
 661             log_bad_action(in, n_in, a, error);
 662             return error;
 663         }
 664     }
 665     if (left) {
 666         enum ofperr error = OFPERR_OFPBAC_BAD_LEN;
 667         log_bad_action(in, n_in, a, error);
 668         return error;
 669     }
 670
 671     ofpact_pad(out);
 672     return 0;
 673 }
 674
 675 /* Attempts to convert 'actions_len' bytes of OpenFlow actions from the
 676  * front of 'openflow' into ofpacts.  On success, replaces any existing content
 677  * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
 678  * Returns 0 if successful, otherwise an OpenFlow error.
 679  *
 680  * Actions are processed according to their OpenFlow version which
 681  * is provided in the 'version' parameter.
 682  *
 683  * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
 684  * instructions, so you should call ofpacts_pull_openflow_instructions()
 685  * instead of this function.
 686  *
 687  * The parsed actions are valid generically, but they may not be valid in a
 688  * specific context.  For example, port numbers up to OFPP_MAX are valid
 689  * generically, but specific datapaths may only support port numbers in a
 690  * smaller range.  Use ofpacts_check() to additional check whether actions are
 691  * valid in a specific context. */
 692 enum ofperr
 693 ofpacts_pull_openflow_actions(struct ofpbuf *openflow,
 694                               unsigned int actions_len,
 695                               enum ofp_version version,
 696                               struct ofpbuf *ofpacts) {
 697     const union ofp_action *actions;
 698     enum ofperr error;
 699
 700     ofpbuf_clear(ofpacts);
 701
 702     if (actions_len % OFP_ACTION_ALIGN != 0) {
 703         VLOG_WARN_RL(&rl, "OpenFlow message actions length %u is not a "
 704                      "multiple of %d", actions_len, OFP_ACTION_ALIGN);
 705         return OFPERR_OFPBRC_BAD_LEN;
 706     }
 707
 708     actions = ofpbuf_try_pull(openflow, actions_len);
 709     if (actions == NULL) {
 710         VLOG_WARN_RL(&rl, "OpenFlow message actions length %u exceeds "
 711                      "remaining message length (%"PRIuSIZE")",
 712                      actions_len, openflow->size);
 713         return OFPERR_OFPBRC_BAD_LEN;
 714     }
 715
 716     error = ofpacts_from_openflow(actions, actions_len / OFP_ACTION_ALIGN,
 717                                   version, ofpacts);
 718     if (error) {
 719         ofpbuf_clear(ofpacts);
 720         return error;
 721     }
 722
 723     error = ofpacts_verify(ofpacts->data, ofpacts->size);
 724     if (error) {
 725         ofpbuf_clear(ofpacts);
 726     }
 727     return error;
 728 }
 729
 730 \f
 731 /* OpenFlow 1.1 actions. */
 732
 733 /* Parses 'a' to determine its type.  On success stores the correct type into
 734  * '*code' and returns 0.  On failure returns an OFPERR_* error code and
 735  * '*code' is indeterminate.
 736  *
 737  * The caller must have already verified that 'a''s length is potentially
 738  * correct (that is, a->header.len is nonzero and a multiple of
 739  * OFP_ACTION_ALIGN and no longer than the amount of space allocated to 'a').
 740  *
 741  * This function verifies that 'a''s length is correct for the type of action
 742  * that it represents. */
 743 static enum ofperr
 744 decode_openflow11_action(const union ofp_action *a,
 745                          enum ofputil_action_code *code)
 746 {
 747     uint16_t len;
 748
 749     switch (a->type) {
 750     case CONSTANT_HTONS(OFPAT11_EXPERIMENTER):
 751         return decode_nxast_action(a, code);
 752
 753 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)  \
 754         case CONSTANT_HTONS(ENUM):                      \
 755             len = ntohs(a->header.len);                 \
 756             if (EXTENSIBLE                              \
 757                 ? len >= sizeof(struct STRUCT)          \
 758                 : len == sizeof(struct STRUCT)) {       \
 759                 *code = OFPUTIL_##ENUM;                 \
 760                 return 0;                               \
 761             } else {                                    \
 762                 return OFPERR_OFPBAC_BAD_LEN;           \
 763             }                                           \
 764             OVS_NOT_REACHED();
 765 #include "ofp-util.def"
 766
 767     default:
 768         return OFPERR_OFPBAC_BAD_TYPE;
 769     }
 770 }
 771
 772 static enum ofperr
 773 set_field_from_openflow(const struct ofp12_action_set_field *oasf,
 774                         struct ofpbuf *ofpacts)
 775 {
 776     uint16_t oasf_len = ntohs(oasf->len);
 777     uint32_t oxm_header = ntohl(oasf->dst);
 778     uint8_t oxm_length = NXM_LENGTH(oxm_header);
 779     struct ofpact_set_field *sf;
 780     const struct mf_field *mf;
 781
 782     /* ofp12_action_set_field is padded to 64 bits by zero */
 783     if (oasf_len != ROUND_UP(sizeof *oasf + oxm_length, 8)) {
 784         return OFPERR_OFPBAC_BAD_SET_LEN;
 785     }
 786     if (!is_all_zeros((const uint8_t *)oasf + sizeof *oasf + oxm_length,
 787                       oasf_len - oxm_length - sizeof *oasf)) {
 788         return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
 789     }
 790
 791     if (NXM_HASMASK(oxm_header)) {
 792         return OFPERR_OFPBAC_BAD_SET_TYPE;
 793     }
 794     mf = mf_from_nxm_header(oxm_header);
 795     if (!mf) {
 796         return OFPERR_OFPBAC_BAD_SET_TYPE;
 797     }
 798     ovs_assert(mf->n_bytes == oxm_length);
 799     /* oxm_length is now validated to be compatible with mf_value. */
 800     if (!mf->writable) {
 801         VLOG_WARN_RL(&rl, "destination field %s is not writable", mf->name);
 802         return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
 803     }
 804     sf = ofpact_put_SET_FIELD(ofpacts);
 805     sf->field = mf;
 806     memcpy(&sf->value, oasf + 1, mf->n_bytes);
 807
 808     /* The value must be valid for match and must have the OFPVID_PRESENT bit
 809      * on for OXM_OF_VLAN_VID. */
 810     if (!mf_is_value_valid(mf, &sf->value)
 811         || (mf->id == MFF_VLAN_VID
 812             && !(sf->value.be16 & htons(OFPVID12_PRESENT)))) {
 813         struct ds ds = DS_EMPTY_INITIALIZER;
 814         mf_format(mf, &sf->value, NULL, &ds);
 815         VLOG_WARN_RL(&rl, "Invalid value for set field %s: %s",
 816                      mf->name, ds_cstr(&ds));
 817         ds_destroy(&ds);
 818
 819         return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
 820     }
 821     return 0;
 822 }
 823
 824 static void
 825 set_field_to_openflow12(const struct ofpact_set_field *sf,
 826                         struct ofpbuf *openflow)
 827 {
 828     uint16_t padded_value_len = ROUND_UP(sf->field->n_bytes, 8);
 829     struct ofp12_action_set_field *oasf;
 830     char *value;
 831
 832     oasf = ofputil_put_OFPAT12_SET_FIELD(openflow);
 833     oasf->dst = htonl(sf->field->oxm_header);
 834     oasf->len = htons(sizeof *oasf + padded_value_len);
 835
 836     value = ofpbuf_put_zeros(openflow, padded_value_len);
 837     memcpy(value, &sf->value, sf->field->n_bytes);
 838 }
 839
 840 /* Convert 'sf' to one or two REG_LOADs. */
 841 static void
 842 set_field_to_nxast(const struct ofpact_set_field *sf, struct ofpbuf *openflow)
 843 {
 844     const struct mf_field *mf = sf->field;
 845     struct nx_action_reg_load *narl;
 846
 847     if (mf->n_bits > 64) {
 848         ovs_assert(mf->n_bytes == 16); /* IPv6 addr. */
 849         /* Split into 64bit chunks */
 850         /* Lower bits first. */
 851         narl = ofputil_put_NXAST_REG_LOAD(openflow);
 852         narl->ofs_nbits = nxm_encode_ofs_nbits(0, 64);
 853         narl->dst = htonl(mf->nxm_header);
 854         memcpy(&narl->value, &sf->value.ipv6.s6_addr[8], sizeof narl->value);
 855         /* Higher bits next. */
 856         narl = ofputil_put_NXAST_REG_LOAD(openflow);
 857         narl->ofs_nbits = nxm_encode_ofs_nbits(64, mf->n_bits - 64);
 858         narl->dst = htonl(mf->nxm_header);
 859         memcpy(&narl->value, &sf->value.ipv6.s6_addr[0], sizeof narl->value);
 860     } else {
 861         narl = ofputil_put_NXAST_REG_LOAD(openflow);
 862         narl->ofs_nbits = nxm_encode_ofs_nbits(0, mf->n_bits);
 863         narl->dst = htonl(mf->nxm_header);
 864         memset(&narl->value, 0, 8 - mf->n_bytes);
 865         memcpy((char*)&narl->value + (8 - mf->n_bytes),
 866                &sf->value, mf->n_bytes);
 867     }
 868 }
 869
 870 /* Convert 'sf' to standard OpenFlow 1.1 actions, if we can, falling back
 871  * to Nicira extensions if we must.
 872  *
 873  * We check only meta-flow types that can appear within set field actions and
 874  * that have a mapping to compatible action types.  These struct mf_field
 875  * definitions have a defined OXM or NXM header value and specify the field as
 876  * writable. */
 877 static void
 878 set_field_to_openflow11(const struct ofpact_set_field *sf,
 879                         struct ofpbuf *openflow)
 880 {
 881     switch ((int) sf->field->id) {
 882     case MFF_VLAN_TCI:
 883         /* NXM_OF_VLAN_TCI to OpenFlow 1.1 mapping:
 884          *
 885          * If CFI=1, Add or modify VLAN VID & PCP.
 886          *    OpenFlow 1.1 set actions only apply if the packet
 887          *    already has VLAN tags.  To be sure that is the case
 888          *    we have to push a VLAN header.  As we do not support
 889          *    multiple layers of VLANs, this is a no-op, if a VLAN
 890          *    header already exists.  This may backfire, however,
 891          *    when we start supporting multiple layers of VLANs.
 892          * If CFI=0, strip VLAN header, if any.
 893          */
 894         if (sf->value.be16 & htons(VLAN_CFI)) {
 895             /* Push a VLAN tag, if one was not seen at action validation
 896              * time. */
 897             if (!sf->flow_has_vlan) {
 898                 ofputil_put_OFPAT11_PUSH_VLAN(openflow)->ethertype
 899                     = htons(ETH_TYPE_VLAN_8021Q);
 900             }
 901             ofputil_put_OFPAT11_SET_VLAN_VID(openflow)->vlan_vid
 902                 = sf->value.be16 & htons(VLAN_VID_MASK);
 903             ofputil_put_OFPAT11_SET_VLAN_PCP(openflow)->vlan_pcp
 904                 = vlan_tci_to_pcp(sf->value.be16);
 905         } else {
 906             /* If the flow did not match on vlan, we have no way of
 907              * knowing if the vlan tag exists, so we must POP just to be
 908              * sure. */
 909             ofputil_put_OFPAT11_POP_VLAN(openflow);
 910         }
 911         break;
 912
 913     case MFF_VLAN_VID:
 914         /* OXM VLAN_PCP to OpenFlow 1.1.
 915          * Set field on OXM_OF_VLAN_VID onlyapplies to an existing vlan
 916          * tag.  Clear the OFPVID_PRESENT bit.
 917          */
 918         ofputil_put_OFPAT11_SET_VLAN_VID(openflow)->vlan_vid
 919             = sf->value.be16 & htons(VLAN_VID_MASK);
 920         break;
 921
 922     case MFF_VLAN_PCP:
 923         /* OXM VLAN_PCP to OpenFlow 1.1.
 924          * OXM_OF_VLAN_PCP only applies to existing vlan tag. */
 925         ofputil_put_OFPAT11_SET_VLAN_PCP(openflow)->vlan_pcp = sf->value.u8;
 926         break;
 927
 928     case MFF_ETH_SRC:
 929         memcpy(ofputil_put_OFPAT11_SET_DL_SRC(openflow)->dl_addr,
 930                sf->value.mac, ETH_ADDR_LEN);
 931         break;
 932
 933     case MFF_ETH_DST:
 934         memcpy(ofputil_put_OFPAT11_SET_DL_DST(openflow)->dl_addr,
 935                sf->value.mac, ETH_ADDR_LEN);
 936         break;
 937
 938     case MFF_MPLS_LABEL:
 939         ofputil_put_OFPAT11_SET_MPLS_LABEL(openflow)->mpls_label =
 940             sf->value.be32;
 941         break;
 942
 943     case MFF_MPLS_TC:
 944         ofputil_put_OFPAT11_SET_MPLS_TC(openflow)->mpls_tc = sf->value.u8;
 945         break;
 946
 947     case MFF_IPV4_SRC:
 948         ofputil_put_OFPAT11_SET_NW_SRC(openflow)->nw_addr = sf->value.be32;
 949         break;
 950
 951     case MFF_IPV4_DST:
 952         ofputil_put_OFPAT11_SET_NW_DST(openflow)->nw_addr = sf->value.be32;
 953         break;
 954
 955     case MFF_IP_DSCP:
 956         ofputil_put_OFPAT11_SET_NW_TOS(openflow)->nw_tos = sf->value.u8;
 957         break;
 958
 959     case MFF_IP_DSCP_SHIFTED:
 960         ofputil_put_OFPAT11_SET_NW_TOS(openflow)->nw_tos = sf->value.u8 << 2;
 961         break;
 962
 963     case MFF_IP_ECN:
 964         ofputil_put_OFPAT11_SET_NW_ECN(openflow)->nw_ecn = sf->value.u8;
 965         break;
 966
 967     case MFF_IP_TTL:
 968         ofputil_put_OFPAT11_SET_NW_TTL(openflow)->nw_ttl = sf->value.u8;
 969         break;
 970
 971     case MFF_TCP_SRC:
 972     case MFF_UDP_SRC:
 973     case MFF_SCTP_SRC:
 974         ofputil_put_OFPAT11_SET_TP_SRC(openflow)->tp_port = sf->value.be16;
 975         break;
 976
 977     case MFF_TCP_DST:
 978     case MFF_UDP_DST:
 979     case MFF_SCTP_DST:
 980         ofputil_put_OFPAT11_SET_TP_DST(openflow)->tp_port = sf->value.be16;
 981         break;
 982
 983     default:
 984         set_field_to_nxast(sf, openflow);
 985         break;
 986     }
 987 }
 988
 989 /* Convert 'sf' to standard OpenFlow 1.0 actions, if we can, falling back
 990  * to Nicira extensions if we must.
 991  *
 992  * We check only meta-flow types that can appear within set field actions and
 993  * that have a mapping to compatible action types.  These struct mf_field
 994  * definitions have a defined OXM or NXM header value and specify the field as
 995  * writable. */
 996 static void
 997 set_field_to_openflow10(const struct ofpact_set_field *sf,
 998                         struct ofpbuf *openflow)
 999 {
1000     switch ((int) sf->field->id) {
1001     case MFF_VLAN_TCI:
1002         /* NXM_OF_VLAN_TCI to OpenFlow 1.0 mapping:
1003          *
1004          * If CFI=1, Add or modify VLAN VID & PCP.
1005          * If CFI=0, strip VLAN header, if any.
1006          */
1007         if (sf->value.be16 & htons(VLAN_CFI)) {
1008             ofputil_put_OFPAT10_SET_VLAN_VID(openflow)->vlan_vid
1009                 = sf->value.be16 & htons(VLAN_VID_MASK);
1010             ofputil_put_OFPAT10_SET_VLAN_PCP(openflow)->vlan_pcp
1011                 = vlan_tci_to_pcp(sf->value.be16);
1012         } else {
1013             ofputil_put_OFPAT10_STRIP_VLAN(openflow);
1014         }
1015         break;
1016
1017     case MFF_VLAN_VID:
1018         /* OXM VLAN_VID to OpenFlow 1.0.
1019          * Set field on OXM_OF_VLAN_VID onlyapplies to an existing vlan
1020          * tag.  Clear the OFPVID_PRESENT bit.
1021          */
1022         ofputil_put_OFPAT10_SET_VLAN_VID(openflow)->vlan_vid
1023             = sf->value.be16 & htons(VLAN_VID_MASK);
1024         break;
1025
1026     case MFF_VLAN_PCP:
1027         /* OXM VLAN_PCP to OpenFlow 1.0.
1028          * OXM_OF_VLAN_PCP only applies to existing vlan tag. */
1029         ofputil_put_OFPAT10_SET_VLAN_PCP(openflow)->vlan_pcp = sf->value.u8;
1030         break;
1031
1032     case MFF_ETH_SRC:
1033         memcpy(ofputil_put_OFPAT10_SET_DL_SRC(openflow)->dl_addr,
1034                sf->value.mac, ETH_ADDR_LEN);
1035         break;
1036
1037     case MFF_ETH_DST:
1038         memcpy(ofputil_put_OFPAT10_SET_DL_DST(openflow)->dl_addr,
1039                sf->value.mac, ETH_ADDR_LEN);
1040         break;
1041
1042     case MFF_IPV4_SRC:
1043         ofputil_put_OFPAT10_SET_NW_SRC(openflow)->nw_addr = sf->value.be32;
1044         break;
1045
1046     case MFF_IPV4_DST:
1047         ofputil_put_OFPAT10_SET_NW_DST(openflow)->nw_addr = sf->value.be32;
1048         break;
1049
1050     case MFF_IP_DSCP:
1051         ofputil_put_OFPAT10_SET_NW_TOS(openflow)->nw_tos = sf->value.u8;
1052         break;
1053
1054     case MFF_IP_DSCP_SHIFTED:
1055         ofputil_put_OFPAT10_SET_NW_TOS(openflow)->nw_tos = sf->value.u8 << 2;
1056         break;
1057
1058     case MFF_TCP_SRC:
1059     case MFF_UDP_SRC:
1060         ofputil_put_OFPAT10_SET_TP_SRC(openflow)->tp_port = sf->value.be16;
1061         break;
1062
1063     case MFF_TCP_DST:
1064     case MFF_UDP_DST:
1065         ofputil_put_OFPAT10_SET_TP_DST(openflow)->tp_port = sf->value.be16;
1066         break;
1067
1068     default:
1069         set_field_to_nxast(sf, openflow);
1070         break;
1071     }
1072 }
1073
1074 static void
1075 set_field_to_openflow(const struct ofpact_set_field *sf,
1076                       struct ofpbuf *openflow)
1077 {
1078     struct ofp_header *oh = (struct ofp_header *)openflow->l2;
1079
1080     if (oh->version >= OFP12_VERSION) {
1081         set_field_to_openflow12(sf, openflow);
1082     } else if (oh->version == OFP11_VERSION) {
1083         set_field_to_openflow11(sf, openflow);
1084     } else if (oh->version == OFP10_VERSION) {
1085         set_field_to_openflow10(sf, openflow);
1086     } else {
1087         OVS_NOT_REACHED();
1088     }
1089 }
1090
1091 static enum ofperr
1092 output_from_openflow11(const struct ofp11_action_output *oao,
1093                        struct ofpbuf *out)
1094 {
1095     struct ofpact_output *output;
1096     enum ofperr error;
1097
1098     output = ofpact_put_OUTPUT(out);
1099     output->max_len = ntohs(oao->max_len);
1100
1101     error = ofputil_port_from_ofp11(oao->port, &output->port);
1102     if (error) {
1103         return error;
1104     }
1105
1106     return ofpact_check_output_port(output->port, OFPP_MAX);
1107 }
1108
1109 static enum ofperr
1110 ofpact_from_openflow11(const union ofp_action *a, enum ofp_version version,
1111                        struct ofpbuf *out)
1112 {
1113     enum ofputil_action_code code;
1114     enum ofperr error;
1115     struct ofpact_vlan_vid *vlan_vid;
1116     struct ofpact_vlan_pcp *vlan_pcp;
1117
1118     error = decode_openflow11_action(a, &code);
1119     if (error) {
1120         return error;
1121     }
1122
1123     if (version >= OFP12_VERSION) {
1124         switch ((int)code) {
1125         case OFPUTIL_OFPAT11_SET_VLAN_VID:
1126         case OFPUTIL_OFPAT11_SET_VLAN_PCP:
1127         case OFPUTIL_OFPAT11_SET_DL_SRC:
1128         case OFPUTIL_OFPAT11_SET_DL_DST:
1129         case OFPUTIL_OFPAT11_SET_NW_SRC:
1130         case OFPUTIL_OFPAT11_SET_NW_DST:
1131         case OFPUTIL_OFPAT11_SET_NW_TOS:
1132         case OFPUTIL_OFPAT11_SET_NW_ECN:
1133         case OFPUTIL_OFPAT11_SET_TP_SRC:
1134         case OFPUTIL_OFPAT11_SET_TP_DST:
1135             VLOG_WARN_RL(&rl, "Deprecated action %s received over %s",
1136                          ofputil_action_name_from_code(code),
1137                          ofputil_version_to_string(version));
1138         }
1139     }
1140
1141     switch (code) {
1142     case OFPUTIL_ACTION_INVALID:
1143 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
1144 #include "ofp-util.def"
1145         OVS_NOT_REACHED();
1146
1147     case OFPUTIL_OFPAT11_OUTPUT:
1148         return output_from_openflow11(&a->ofp11_output, out);
1149
1150     case OFPUTIL_OFPAT11_SET_VLAN_VID:
1151         if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
1152             return OFPERR_OFPBAC_BAD_ARGUMENT;
1153         }
1154         vlan_vid = ofpact_put_SET_VLAN_VID(out);
1155         vlan_vid->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
1156         vlan_vid->push_vlan_if_needed = false;
1157         vlan_vid->ofpact.compat = code;
1158         break;
1159
1160     case OFPUTIL_OFPAT11_SET_VLAN_PCP:
1161         if (a->vlan_pcp.vlan_pcp & ~7) {
1162             return OFPERR_OFPBAC_BAD_ARGUMENT;
1163         }
1164         vlan_pcp = ofpact_put_SET_VLAN_PCP(out);
1165         vlan_pcp->vlan_pcp = a->vlan_pcp.vlan_pcp;
1166         vlan_pcp->push_vlan_if_needed = false;
1167         vlan_pcp->ofpact.compat = code;
1168         break;
1169
1170     case OFPUTIL_OFPAT11_PUSH_VLAN:
1171         if (a->push.ethertype != htons(ETH_TYPE_VLAN_8021Q)) {
1172             /* XXX 802.1AD(QinQ) isn't supported at the moment */
1173             return OFPERR_OFPBAC_BAD_ARGUMENT;
1174         }
1175         ofpact_put_PUSH_VLAN(out);
1176         break;
1177
1178     case OFPUTIL_OFPAT11_POP_VLAN:
1179         ofpact_put_STRIP_VLAN(out)->ofpact.compat = code;
1180         break;
1181
1182     case OFPUTIL_OFPAT11_SET_QUEUE:
1183         ofpact_put_SET_QUEUE(out)->queue_id =
1184             ntohl(a->ofp11_set_queue.queue_id);
1185         break;
1186
1187     case OFPUTIL_OFPAT11_SET_DL_SRC:
1188         memcpy(ofpact_put_SET_ETH_SRC(out)->mac, a->dl_addr.dl_addr,
1189                ETH_ADDR_LEN);
1190         break;
1191
1192     case OFPUTIL_OFPAT11_SET_DL_DST:
1193         memcpy(ofpact_put_SET_ETH_DST(out)->mac, a->dl_addr.dl_addr,
1194                ETH_ADDR_LEN);
1195         break;
1196
1197     case OFPUTIL_OFPAT11_DEC_NW_TTL:
1198         dec_ttl_from_openflow(out, code);
1199         break;
1200
1201     case OFPUTIL_OFPAT11_SET_NW_SRC:
1202         ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
1203         break;
1204
1205     case OFPUTIL_OFPAT11_SET_NW_DST:
1206         ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
1207         break;
1208
1209     case OFPUTIL_OFPAT11_SET_NW_TOS:
1210         if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
1211             return OFPERR_OFPBAC_BAD_ARGUMENT;
1212         }
1213         ofpact_put_SET_IP_DSCP(out)->dscp = a->nw_tos.nw_tos;
1214         break;
1215
1216     case OFPUTIL_OFPAT11_SET_NW_ECN:
1217         if (a->nw_ecn.nw_ecn & ~IP_ECN_MASK) {
1218             return OFPERR_OFPBAC_BAD_ARGUMENT;
1219         }
1220         ofpact_put_SET_IP_ECN(out)->ecn = a->nw_ecn.nw_ecn;
1221         break;
1222
1223     case OFPUTIL_OFPAT11_SET_NW_TTL:
1224         ofpact_put_SET_IP_TTL(out)->ttl = a->nw_ttl.nw_ttl;
1225         break;
1226
1227     case OFPUTIL_OFPAT11_SET_TP_SRC:
1228         ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
1229         break;
1230
1231     case OFPUTIL_OFPAT11_SET_TP_DST:
1232         ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
1233         break;
1234
1235     case OFPUTIL_OFPAT12_SET_FIELD:
1236         return set_field_from_openflow(&a->set_field, out);
1237
1238     case OFPUTIL_OFPAT11_SET_MPLS_LABEL:
1239         ofpact_put_SET_MPLS_LABEL(out)->label = a->ofp11_mpls_label.mpls_label;
1240         break;
1241
1242     case OFPUTIL_OFPAT11_SET_MPLS_TC:
1243         ofpact_put_SET_MPLS_TC(out)->tc = a->ofp11_mpls_tc.mpls_tc;
1244         break;
1245
1246     case OFPUTIL_OFPAT11_SET_MPLS_TTL:
1247         ofpact_put_SET_MPLS_TTL(out)->ttl = a->ofp11_mpls_ttl.mpls_ttl;
1248         break;
1249
1250     case OFPUTIL_OFPAT11_DEC_MPLS_TTL:
1251         ofpact_put_DEC_MPLS_TTL(out);
1252         break;
1253
1254     case OFPUTIL_OFPAT11_PUSH_MPLS:
1255         error = push_mpls_from_openflow(a->push.ethertype, out);
1256         break;
1257
1258     case OFPUTIL_OFPAT11_POP_MPLS:
1259         if (eth_type_mpls(a->ofp11_pop_mpls.ethertype)) {
1260             return OFPERR_OFPBAC_BAD_ARGUMENT;
1261         }
1262         ofpact_put_POP_MPLS(out)->ethertype = a->ofp11_pop_mpls.ethertype;
1263         break;
1264
1265     case OFPUTIL_OFPAT11_GROUP:
1266         ofpact_put_GROUP(out)->group_id = ntohl(a->group.group_id);
1267         break;
1268
1269 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
1270 #include "ofp-util.def"
1271         return ofpact_from_nxast(a, code, out);
1272     }
1273
1274     return error;
1275 }
1276
1277 /* True if an action sets the value of a field
1278  * in a way that is compatibile with the action set.
1279  * False otherwise. */
1280 static bool
1281 ofpact_is_set_action(const struct ofpact *a)
1282 {
1283     switch (a->type) {
1284     case OFPACT_SET_FIELD:
1285     case OFPACT_REG_LOAD:
1286     case OFPACT_SET_ETH_DST:
1287     case OFPACT_SET_ETH_SRC:
1288     case OFPACT_SET_IP_DSCP:
1289     case OFPACT_SET_IP_ECN:
1290     case OFPACT_SET_IP_TTL:
1291     case OFPACT_SET_IPV4_DST:
1292     case OFPACT_SET_IPV4_SRC:
1293     case OFPACT_SET_L4_DST_PORT:
1294     case OFPACT_SET_L4_SRC_PORT:
1295     case OFPACT_SET_MPLS_LABEL:
1296     case OFPACT_SET_MPLS_TC:
1297     case OFPACT_SET_MPLS_TTL:
1298     case OFPACT_SET_QUEUE:
1299     case OFPACT_SET_TUNNEL:
1300     case OFPACT_SET_VLAN_PCP:
1301     case OFPACT_SET_VLAN_VID:
1302         return true;
1303     case OFPACT_BUNDLE:
1304     case OFPACT_CLEAR_ACTIONS:
1305     case OFPACT_CONTROLLER:
1306     case OFPACT_DEC_MPLS_TTL:
1307     case OFPACT_DEC_TTL:
1308     case OFPACT_ENQUEUE:
1309     case OFPACT_EXIT:
1310     case OFPACT_FIN_TIMEOUT:
1311     case OFPACT_GOTO_TABLE:
1312     case OFPACT_GROUP:
1313     case OFPACT_LEARN:
1314     case OFPACT_METER:
1315     case OFPACT_MULTIPATH:
1316     case OFPACT_NOTE:
1317     case OFPACT_OUTPUT:
1318     case OFPACT_OUTPUT_REG:
1319     case OFPACT_POP_MPLS:
1320     case OFPACT_POP_QUEUE:
1321     case OFPACT_PUSH_MPLS:
1322     case OFPACT_PUSH_VLAN:
1323     case OFPACT_REG_MOVE:
1324     case OFPACT_RESUBMIT:
1325     case OFPACT_SAMPLE:
1326     case OFPACT_STACK_POP:
1327     case OFPACT_STACK_PUSH:
1328     case OFPACT_STRIP_VLAN:
1329     case OFPACT_WRITE_ACTIONS:
1330     case OFPACT_WRITE_METADATA:
1331         return false;
1332     default:
1333         OVS_NOT_REACHED();
1334     }
1335 }
1336
1337 /* True if an action is allowed in the action set.
1338  * False otherwise. */
1339 static bool
1340 ofpact_is_allowed_in_actions_set(const struct ofpact *a)
1341 {
1342     switch (a->type) {
1343     case OFPACT_DEC_MPLS_TTL:
1344     case OFPACT_DEC_TTL:
1345     case OFPACT_GROUP:
1346     case OFPACT_OUTPUT:
1347     case OFPACT_POP_MPLS:
1348     case OFPACT_PUSH_MPLS:
1349     case OFPACT_PUSH_VLAN:
1350     case OFPACT_REG_LOAD:
1351     case OFPACT_SET_FIELD:
1352     case OFPACT_SET_ETH_DST:
1353     case OFPACT_SET_ETH_SRC:
1354     case OFPACT_SET_IP_DSCP:
1355     case OFPACT_SET_IP_ECN:
1356     case OFPACT_SET_IP_TTL:
1357     case OFPACT_SET_IPV4_DST:
1358     case OFPACT_SET_IPV4_SRC:
1359     case OFPACT_SET_L4_DST_PORT:
1360     case OFPACT_SET_L4_SRC_PORT:
1361     case OFPACT_SET_MPLS_LABEL:
1362     case OFPACT_SET_MPLS_TC:
1363     case OFPACT_SET_MPLS_TTL:
1364     case OFPACT_SET_QUEUE:
1365     case OFPACT_SET_TUNNEL:
1366     case OFPACT_SET_VLAN_PCP:
1367     case OFPACT_SET_VLAN_VID:
1368     case OFPACT_STRIP_VLAN:
1369         return true;
1370
1371     /* In general these actions are excluded because they are not part of
1372      * the OpenFlow specification nor map to actions that are defined in
1373      * the specification.  Thus the order in which they should be applied
1374      * in the action set is undefined. */
1375     case OFPACT_BUNDLE:
1376     case OFPACT_CONTROLLER:
1377     case OFPACT_ENQUEUE:
1378     case OFPACT_EXIT:
1379     case OFPACT_FIN_TIMEOUT:
1380     case OFPACT_LEARN:
1381     case OFPACT_MULTIPATH:
1382     case OFPACT_NOTE:
1383     case OFPACT_OUTPUT_REG:
1384     case OFPACT_POP_QUEUE:
1385     case OFPACT_REG_MOVE:
1386     case OFPACT_RESUBMIT:
1387     case OFPACT_SAMPLE:
1388     case OFPACT_STACK_POP:
1389     case OFPACT_STACK_PUSH:
1390
1391     /* The action set may only include actions and thus
1392      * may not include any instructions */
1393     case OFPACT_CLEAR_ACTIONS:
1394     case OFPACT_GOTO_TABLE:
1395     case OFPACT_METER:
1396     case OFPACT_WRITE_ACTIONS:
1397     case OFPACT_WRITE_METADATA:
1398         return false;
1399     default:
1400         OVS_NOT_REACHED();
1401     }
1402 }
1403
1404 /* Append ofpact 'a' onto the tail of 'out' */
1405 static void
1406 ofpact_copy(struct ofpbuf *out, const struct ofpact *a)
1407 {
1408     ofpbuf_put(out, a, OFPACT_ALIGN(a->len));
1409 }
1410
1411 /* Copies the last ofpact whose type is 'filter' from 'in' to 'out'. */
1412 static bool
1413 ofpacts_copy_last(struct ofpbuf *out, const struct ofpbuf *in,
1414                   enum ofpact_type filter)
1415 {
1416     const struct ofpact *target;
1417     const struct ofpact *a;
1418
1419     target = NULL;
1420     OFPACT_FOR_EACH (a, in->data, in->size) {
1421         if (a->type == filter) {
1422             target = a;
1423         }
1424     }
1425     if (target) {
1426         ofpact_copy(out, target);
1427     }
1428     return target != NULL;
1429 }
1430
1431 /* Append all ofpacts, for which 'filter' returns true, from 'in' to 'out'.
1432  * The order of appended ofpacts is preserved between 'in' and 'out' */
1433 static void
1434 ofpacts_copy_all(struct ofpbuf *out, const struct ofpbuf *in,
1435                  bool (*filter)(const struct ofpact *))
1436 {
1437     const struct ofpact *a;
1438
1439     OFPACT_FOR_EACH (a, in->data, in->size) {
1440         if (filter(a)) {
1441             ofpact_copy(out, a);
1442         }
1443     }
1444 }
1445
1446 /* Reads 'action_set', which contains ofpacts accumulated by
1447  * OFPACT_WRITE_ACTIONS instructions, and writes equivalent actions to be
1448  * executed directly into 'action_list'.  (These names correspond to the
1449  * "Action Set" and "Action List" terms used in OpenFlow 1.1+.)
1450  *
1451  * In general this involves appending the last instance of each action that is
1452  * adimissible in the action set in the order described in the OpenFlow
1453  * specification.
1454  *
1455  * Exceptions:
1456  * + output action is only appended if no group action was present in 'in'.
1457  * + As a simplification all set actions are copied in the order the are
1458  *   provided in 'in' as many set actions applied to a field has the same
1459  *   affect as only applying the last action that sets a field and
1460  *   duplicates are removed by do_xlate_actions().
1461  *   This has an unwanted side-effect of compsoting multiple
1462  *   LOAD_REG actions that touch different regions of the same field. */
1463 void
1464 ofpacts_execute_action_set(struct ofpbuf *action_list,
1465                            const struct ofpbuf *action_set)
1466 {
1467     /* The OpenFlow spec "Action Set" section specifies this order. */
1468     ofpacts_copy_last(action_list, action_set, OFPACT_STRIP_VLAN);
1469     ofpacts_copy_last(action_list, action_set, OFPACT_POP_MPLS);
1470     ofpacts_copy_last(action_list, action_set, OFPACT_PUSH_MPLS);
1471     ofpacts_copy_last(action_list, action_set, OFPACT_PUSH_VLAN);
1472     ofpacts_copy_last(action_list, action_set, OFPACT_DEC_TTL);
1473     ofpacts_copy_last(action_list, action_set, OFPACT_DEC_MPLS_TTL);
1474     ofpacts_copy_all(action_list, action_set, ofpact_is_set_action);
1475     ofpacts_copy_last(action_list, action_set, OFPACT_SET_QUEUE);
1476
1477     /* If both OFPACT_GROUP and OFPACT_OUTPUT are present, OpenFlow says that
1478      * we should execute only OFPACT_GROUP.
1479      *
1480      * If neither OFPACT_GROUP nor OFPACT_OUTPUT is present, then we can drop
1481      * all the actions because there's no point in modifying a packet that will
1482      * not be sent anywhere. */
1483     if (!ofpacts_copy_last(action_list, action_set, OFPACT_GROUP) &&
1484         !ofpacts_copy_last(action_list, action_set, OFPACT_OUTPUT)) {
1485         ofpbuf_clear(action_list);
1486     }
1487 }
1488
1489
1490 static enum ofperr
1491 ofpacts_from_openflow11_for_action_set(const union ofp_action *in,
1492                                        size_t n_in, enum ofp_version version,
1493                                        struct ofpbuf *out)
1494 {
1495     enum ofperr error;
1496     struct ofpact *a;
1497     size_t start = out->size;
1498
1499     error = ofpacts_from_openflow(in, n_in, version, out);
1500
1501     if (error) {
1502         return error;
1503     }
1504
1505     OFPACT_FOR_EACH (a, ofpact_end(out->data, start), out->size - start) {
1506         if (!ofpact_is_allowed_in_actions_set(a)) {
1507             VLOG_WARN_RL(&rl, "disallowed action in action set");
1508             return OFPERR_OFPBAC_BAD_TYPE;
1509         }
1510     }
1511
1512     return 0;
1513 }
1514
1515 \f
1516 /* OpenFlow 1.1 instructions. */
1517
1518 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)             \
1519     static inline const struct STRUCT * OVS_UNUSED              \
1520     instruction_get_##ENUM(const struct ofp11_instruction *inst)\
1521     {                                                           \
1522         ovs_assert(inst->type == htons(ENUM));                  \
1523         return ALIGNED_CAST(struct STRUCT *, inst);             \
1524     }                                                           \
1525                                                                 \
1526     static inline void OVS_UNUSED                               \
1527     instruction_init_##ENUM(struct STRUCT *s)                   \
1528     {                                                           \
1529         memset(s, 0, sizeof *s);                                \
1530         s->type = htons(ENUM);                                  \
1531         s->len = htons(sizeof *s);                              \
1532     }                                                           \
1533                                                                 \
1534     static inline struct STRUCT * OVS_UNUSED                    \
1535     instruction_put_##ENUM(struct ofpbuf *buf)                  \
1536     {                                                           \
1537         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
1538         instruction_init_##ENUM(s);                             \
1539         return s;                                               \
1540     }
1541 OVS_INSTRUCTIONS
1542 #undef DEFINE_INST
1543
1544 struct instruction_type_info {
1545     enum ovs_instruction_type type;
1546     const char *name;
1547 };
1548
1549 static const struct instruction_type_info inst_info[] = {
1550 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)    {OVSINST_##ENUM, NAME},
1551 OVS_INSTRUCTIONS
1552 #undef DEFINE_INST
1553 };
1554
1555 const char *
1556 ovs_instruction_name_from_type(enum ovs_instruction_type type)
1557 {
1558     return inst_info[type].name;
1559 }
1560
1561 int
1562 ovs_instruction_type_from_name(const char *name)
1563 {
1564     const struct instruction_type_info *p;
1565     for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
1566         if (!strcasecmp(name, p->name)) {
1567             return p->type;
1568         }
1569     }
1570     return -1;
1571 }
1572
1573 enum ovs_instruction_type
1574 ovs_instruction_type_from_ofpact_type(enum ofpact_type type)
1575 {
1576     switch (type) {
1577     case OFPACT_METER:
1578         return OVSINST_OFPIT13_METER;
1579     case OFPACT_CLEAR_ACTIONS:
1580         return OVSINST_OFPIT11_CLEAR_ACTIONS;
1581     case OFPACT_WRITE_ACTIONS:
1582         return OVSINST_OFPIT11_WRITE_ACTIONS;
1583     case OFPACT_WRITE_METADATA:
1584         return OVSINST_OFPIT11_WRITE_METADATA;
1585     case OFPACT_GOTO_TABLE:
1586         return OVSINST_OFPIT11_GOTO_TABLE;
1587     case OFPACT_OUTPUT:
1588     case OFPACT_GROUP:
1589     case OFPACT_CONTROLLER:
1590     case OFPACT_ENQUEUE:
1591     case OFPACT_OUTPUT_REG:
1592     case OFPACT_BUNDLE:
1593     case OFPACT_SET_VLAN_VID:
1594     case OFPACT_SET_VLAN_PCP:
1595     case OFPACT_STRIP_VLAN:
1596     case OFPACT_PUSH_VLAN:
1597     case OFPACT_SET_ETH_SRC:
1598     case OFPACT_SET_ETH_DST:
1599     case OFPACT_SET_IPV4_SRC:
1600     case OFPACT_SET_IPV4_DST:
1601     case OFPACT_SET_IP_DSCP:
1602     case OFPACT_SET_IP_ECN:
1603     case OFPACT_SET_IP_TTL:
1604     case OFPACT_SET_L4_SRC_PORT:
1605     case OFPACT_SET_L4_DST_PORT:
1606     case OFPACT_REG_MOVE:
1607     case OFPACT_REG_LOAD:
1608     case OFPACT_SET_FIELD:
1609     case OFPACT_STACK_PUSH:
1610     case OFPACT_STACK_POP:
1611     case OFPACT_DEC_TTL:
1612     case OFPACT_SET_MPLS_LABEL:
1613     case OFPACT_SET_MPLS_TC:
1614     case OFPACT_SET_MPLS_TTL:
1615     case OFPACT_DEC_MPLS_TTL:
1616     case OFPACT_PUSH_MPLS:
1617     case OFPACT_POP_MPLS:
1618     case OFPACT_SET_TUNNEL:
1619     case OFPACT_SET_QUEUE:
1620     case OFPACT_POP_QUEUE:
1621     case OFPACT_FIN_TIMEOUT:
1622     case OFPACT_RESUBMIT:
1623     case OFPACT_LEARN:
1624     case OFPACT_MULTIPATH:
1625     case OFPACT_NOTE:
1626     case OFPACT_EXIT:
1627     case OFPACT_SAMPLE:
1628     default:
1629         return OVSINST_OFPIT11_APPLY_ACTIONS;
1630     }
1631 }
1632
1633 static inline struct ofp11_instruction *
1634 instruction_next(const struct ofp11_instruction *inst)
1635 {
1636     return ((struct ofp11_instruction *) (void *)
1637             ((uint8_t *) inst + ntohs(inst->len)));
1638 }
1639
1640 static inline bool
1641 instruction_is_valid(const struct ofp11_instruction *inst,
1642                      size_t n_instructions)
1643 {
1644     uint16_t len = ntohs(inst->len);
1645     return (!(len % OFP11_INSTRUCTION_ALIGN)
1646             && len >= sizeof *inst
1647             && len / sizeof *inst <= n_instructions);
1648 }
1649
1650 /* This macro is careful to check for instructions with bad lengths. */
1651 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS)  \
1652     for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS);            \
1653          (LEFT) > 0 && instruction_is_valid(ITER, LEFT);                \
1654          ((LEFT) -= (ntohs((ITER)->len)                                 \
1655                      / sizeof(struct ofp11_instruction)),               \
1656           (ITER) = instruction_next(ITER)))
1657
1658 static enum ofperr
1659 decode_openflow11_instruction(const struct ofp11_instruction *inst,
1660                               enum ovs_instruction_type *type)
1661 {
1662     uint16_t len = ntohs(inst->len);
1663
1664     switch (inst->type) {
1665     case CONSTANT_HTONS(OFPIT11_EXPERIMENTER):
1666         return OFPERR_OFPBIC_BAD_EXPERIMENTER;
1667
1668 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)     \
1669         case CONSTANT_HTONS(ENUM):                      \
1670             if (EXTENSIBLE                              \
1671                 ? len >= sizeof(struct STRUCT)          \
1672                 : len == sizeof(struct STRUCT)) {       \
1673                 *type = OVSINST_##ENUM;                 \
1674                 return 0;                               \
1675             } else {                                    \
1676                 return OFPERR_OFPBIC_BAD_LEN;           \
1677             }
1678 OVS_INSTRUCTIONS
1679 #undef DEFINE_INST
1680
1681     default:
1682         return OFPERR_OFPBIC_UNKNOWN_INST;
1683     }
1684 }
1685
1686 static enum ofperr
1687 decode_openflow11_instructions(const struct ofp11_instruction insts[],
1688                                size_t n_insts,
1689                                const struct ofp11_instruction *out[])
1690 {
1691     const struct ofp11_instruction *inst;
1692     size_t left;
1693
1694     memset(out, 0, N_OVS_INSTRUCTIONS * sizeof *out);
1695     INSTRUCTION_FOR_EACH (inst, left, insts, n_insts) {
1696         enum ovs_instruction_type type;
1697         enum ofperr error;
1698
1699         error = decode_openflow11_instruction(inst, &type);
1700         if (error) {
1701             return error;
1702         }
1703
1704         if (out[type]) {
1705             return OFPERR_ONFBIC_DUP_INSTRUCTION;
1706         }
1707         out[type] = inst;
1708     }
1709
1710     if (left) {
1711         VLOG_WARN_RL(&rl, "bad instruction format at offset %"PRIuSIZE,
1712                      (n_insts - left) * sizeof *inst);
1713         return OFPERR_OFPBIC_BAD_LEN;
1714     }
1715     return 0;
1716 }
1717
1718 static void
1719 get_actions_from_instruction(const struct ofp11_instruction *inst,
1720                              const union ofp_action **actions,
1721                              size_t *max_actions)
1722 {
1723     *actions = ALIGNED_CAST(const union ofp_action *, inst + 1);
1724     *max_actions = (ntohs(inst->len) - sizeof *inst) / OFP11_INSTRUCTION_ALIGN;
1725 }
1726
1727 enum ofperr
1728 ofpacts_pull_openflow_instructions(struct ofpbuf *openflow,
1729                                    unsigned int instructions_len,
1730                                    enum ofp_version version,
1731                                    struct ofpbuf *ofpacts)
1732 {
1733     const struct ofp11_instruction *instructions;
1734     const struct ofp11_instruction *insts[N_OVS_INSTRUCTIONS];
1735     enum ofperr error;
1736
1737     ofpbuf_clear(ofpacts);
1738
1739     if (instructions_len % OFP11_INSTRUCTION_ALIGN != 0) {
1740         VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u is not a "
1741                      "multiple of %d",
1742                      instructions_len, OFP11_INSTRUCTION_ALIGN);
1743         error = OFPERR_OFPBIC_BAD_LEN;
1744         goto exit;
1745     }
1746
1747     instructions = ofpbuf_try_pull(openflow, instructions_len);
1748     if (instructions == NULL) {
1749         VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u exceeds "
1750                      "remaining message length (%"PRIuSIZE")",
1751                      instructions_len, openflow->size);
1752         error = OFPERR_OFPBIC_BAD_LEN;
1753         goto exit;
1754     }
1755
1756     error = decode_openflow11_instructions(
1757         instructions, instructions_len / OFP11_INSTRUCTION_ALIGN,
1758         insts);
1759     if (error) {
1760         goto exit;
1761     }
1762
1763     if (insts[OVSINST_OFPIT13_METER]) {
1764         const struct ofp13_instruction_meter *oim;
1765         struct ofpact_meter *om;
1766
1767         oim = ALIGNED_CAST(const struct ofp13_instruction_meter *,
1768                            insts[OVSINST_OFPIT13_METER]);
1769
1770         om = ofpact_put_METER(ofpacts);
1771         om->meter_id = ntohl(oim->meter_id);
1772     }
1773     if (insts[OVSINST_OFPIT11_APPLY_ACTIONS]) {
1774         const union ofp_action *actions;
1775         size_t max_actions;
1776
1777         get_actions_from_instruction(insts[OVSINST_OFPIT11_APPLY_ACTIONS],
1778                                      &actions, &max_actions);
1779         error = ofpacts_from_openflow(actions, max_actions, version, ofpacts);
1780         if (error) {
1781             goto exit;
1782         }
1783     }
1784     if (insts[OVSINST_OFPIT11_CLEAR_ACTIONS]) {
1785         instruction_get_OFPIT11_CLEAR_ACTIONS(
1786             insts[OVSINST_OFPIT11_CLEAR_ACTIONS]);
1787         ofpact_put_CLEAR_ACTIONS(ofpacts);
1788     }
1789     if (insts[OVSINST_OFPIT11_WRITE_ACTIONS]) {
1790         struct ofpact_nest *on;
1791         const union ofp_action *actions;
1792         size_t max_actions;
1793         size_t start;
1794
1795         ofpact_pad(ofpacts);
1796         start = ofpacts->size;
1797         on = ofpact_put(ofpacts, OFPACT_WRITE_ACTIONS,
1798                         offsetof(struct ofpact_nest, actions));
1799         get_actions_from_instruction(insts[OVSINST_OFPIT11_WRITE_ACTIONS],
1800                                      &actions, &max_actions);
1801         error = ofpacts_from_openflow11_for_action_set(actions, max_actions,
1802                                                        version, ofpacts);
1803         if (error) {
1804             goto exit;
1805         }
1806         on = ofpbuf_at_assert(ofpacts, start, sizeof *on);
1807         on->ofpact.len = ofpacts->size - start;
1808     }
1809     if (insts[OVSINST_OFPIT11_WRITE_METADATA]) {
1810         const struct ofp11_instruction_write_metadata *oiwm;
1811         struct ofpact_metadata *om;
1812
1813         oiwm = ALIGNED_CAST(const struct ofp11_instruction_write_metadata *,
1814                             insts[OVSINST_OFPIT11_WRITE_METADATA]);
1815
1816         om = ofpact_put_WRITE_METADATA(ofpacts);
1817         om->metadata = oiwm->metadata;
1818         om->mask = oiwm->metadata_mask;
1819     }
1820     if (insts[OVSINST_OFPIT11_GOTO_TABLE]) {
1821         const struct ofp11_instruction_goto_table *oigt;
1822         struct ofpact_goto_table *ogt;
1823
1824         oigt = instruction_get_OFPIT11_GOTO_TABLE(
1825             insts[OVSINST_OFPIT11_GOTO_TABLE]);
1826         ogt = ofpact_put_GOTO_TABLE(ofpacts);
1827         ogt->table_id = oigt->table_id;
1828     }
1829
1830     error = ofpacts_verify(ofpacts->data, ofpacts->size);
1831 exit:
1832     if (error) {
1833         ofpbuf_clear(ofpacts);
1834     }
1835     return error;
1836 }
1837 \f
1838 /* Checks that 'port' is a valid output port for OFPACT_OUTPUT, given that the
1839  * switch will never have more than 'max_ports' ports.  Returns 0 if 'port' is
1840  * valid, otherwise an OpenFlow error code. */
1841 enum ofperr
1842 ofpact_check_output_port(ofp_port_t port, ofp_port_t max_ports)
1843 {
1844     switch (port) {
1845     case OFPP_IN_PORT:
1846     case OFPP_TABLE:
1847     case OFPP_NORMAL:
1848     case OFPP_FLOOD:
1849     case OFPP_ALL:
1850     case OFPP_CONTROLLER:
1851     case OFPP_NONE:
1852     case OFPP_LOCAL:
1853         return 0;
1854
1855     default:
1856         if (ofp_to_u16(port) < ofp_to_u16(max_ports)) {
1857             return 0;
1858         }
1859         return OFPERR_OFPBAC_BAD_OUT_PORT;
1860     }
1861 }
1862
1863 /* Removes the protocols that require consistency between match and actions
1864  * (that's everything but OpenFlow 1.0) from '*usable_protocols'.
1865  *
1866  * (An example of an inconsistency between match and actions is a flow that
1867  * does not match on an MPLS Ethertype but has an action that pops an MPLS
1868  * label.) */
1869 static void
1870 inconsistent_match(enum ofputil_protocol *usable_protocols)
1871 {
1872     *usable_protocols &= OFPUTIL_P_OF10_ANY;
1873 }
1874
1875 /* May modify flow->dl_type, flow->nw_proto and flow->vlan_tci,
1876  * caller must restore them.
1877  *
1878  * Modifies some actions, filling in fields that could not be properly set
1879  * without context. */
1880 static enum ofperr
1881 ofpact_check__(enum ofputil_protocol *usable_protocols, struct ofpact *a,
1882                struct flow *flow, ofp_port_t max_ports,
1883                uint8_t table_id, uint8_t n_tables)
1884 {
1885     const struct ofpact_enqueue *enqueue;
1886     const struct mf_field *mf;
1887
1888     switch (a->type) {
1889     case OFPACT_OUTPUT:
1890         return ofpact_check_output_port(ofpact_get_OUTPUT(a)->port,
1891                                         max_ports);
1892
1893     case OFPACT_CONTROLLER:
1894         return 0;
1895
1896     case OFPACT_ENQUEUE:
1897         enqueue = ofpact_get_ENQUEUE(a);
1898         if (ofp_to_u16(enqueue->port) >= ofp_to_u16(max_ports)
1899             && enqueue->port != OFPP_IN_PORT
1900             && enqueue->port != OFPP_LOCAL) {
1901             return OFPERR_OFPBAC_BAD_OUT_PORT;
1902         }
1903         return 0;
1904
1905     case OFPACT_OUTPUT_REG:
1906         return mf_check_src(&ofpact_get_OUTPUT_REG(a)->src, flow);
1907
1908     case OFPACT_BUNDLE:
1909         return bundle_check(ofpact_get_BUNDLE(a), max_ports, flow);
1910
1911     case OFPACT_SET_VLAN_VID:
1912         /* Remember if we saw a vlan tag in the flow to aid translating to
1913          * OpenFlow 1.1+ if need be. */
1914         ofpact_get_SET_VLAN_VID(a)->flow_has_vlan =
1915             (flow->vlan_tci & htons(VLAN_CFI)) == htons(VLAN_CFI);
1916         if (!(flow->vlan_tci & htons(VLAN_CFI)) &&
1917             !ofpact_get_SET_VLAN_VID(a)->push_vlan_if_needed) {
1918             inconsistent_match(usable_protocols);
1919         }
1920         /* Temporary mark that we have a vlan tag. */
1921         flow->vlan_tci |= htons(VLAN_CFI);
1922         return 0;
1923
1924     case OFPACT_SET_VLAN_PCP:
1925         /* Remember if we saw a vlan tag in the flow to aid translating to
1926          * OpenFlow 1.1+ if need be. */
1927         ofpact_get_SET_VLAN_PCP(a)->flow_has_vlan =
1928             (flow->vlan_tci & htons(VLAN_CFI)) == htons(VLAN_CFI);
1929         if (!(flow->vlan_tci & htons(VLAN_CFI)) &&
1930             !ofpact_get_SET_VLAN_PCP(a)->push_vlan_if_needed) {
1931             inconsistent_match(usable_protocols);
1932         }
1933         /* Temporary mark that we have a vlan tag. */
1934         flow->vlan_tci |= htons(VLAN_CFI);
1935         return 0;
1936
1937     case OFPACT_STRIP_VLAN:
1938         if (!(flow->vlan_tci & htons(VLAN_CFI))) {
1939             inconsistent_match(usable_protocols);
1940         }
1941         /* Temporary mark that we have no vlan tag. */
1942         flow->vlan_tci = htons(0);
1943         return 0;
1944
1945     case OFPACT_PUSH_VLAN:
1946         if (flow->vlan_tci & htons(VLAN_CFI)) {
1947             /* Multiple VLAN headers not supported. */
1948             return OFPERR_OFPBAC_BAD_TAG;
1949         }
1950         /* Temporary mark that we have a vlan tag. */
1951         flow->vlan_tci |= htons(VLAN_CFI);
1952         return 0;
1953
1954     case OFPACT_SET_ETH_SRC:
1955     case OFPACT_SET_ETH_DST:
1956         return 0;
1957
1958     case OFPACT_SET_IPV4_SRC:
1959     case OFPACT_SET_IPV4_DST:
1960         if (flow->dl_type != htons(ETH_TYPE_IP)) {
1961             inconsistent_match(usable_protocols);
1962         }
1963         return 0;
1964
1965     case OFPACT_SET_IP_DSCP:
1966     case OFPACT_SET_IP_ECN:
1967     case OFPACT_SET_IP_TTL:
1968     case OFPACT_DEC_TTL:
1969         if (!is_ip_any(flow)) {
1970             inconsistent_match(usable_protocols);
1971         }
1972         return 0;
1973
1974     case OFPACT_SET_L4_SRC_PORT:
1975         if (!is_ip_any(flow) ||
1976             (flow->nw_proto != IPPROTO_TCP && flow->nw_proto != IPPROTO_UDP
1977              && flow->nw_proto != IPPROTO_SCTP)) {
1978             inconsistent_match(usable_protocols);
1979         }
1980         /* Note on which transport protocol the port numbers are set.
1981          * This allows this set action to be converted to an OF1.2 set field
1982          * action. */
1983         ofpact_get_SET_L4_SRC_PORT(a)->flow_ip_proto = flow->nw_proto;
1984         return 0;
1985
1986     case OFPACT_SET_L4_DST_PORT:
1987         if (!is_ip_any(flow) ||
1988             (flow->nw_proto != IPPROTO_TCP && flow->nw_proto != IPPROTO_UDP
1989              && flow->nw_proto != IPPROTO_SCTP)) {
1990             inconsistent_match(usable_protocols);
1991         }
1992         /* Note on which transport protocol the port numbers are set.
1993          * This allows this set action to be converted to an OF1.2 set field
1994          * action. */
1995         ofpact_get_SET_L4_DST_PORT(a)->flow_ip_proto = flow->nw_proto;
1996         return 0;
1997
1998     case OFPACT_REG_MOVE:
1999         return nxm_reg_move_check(ofpact_get_REG_MOVE(a), flow);
2000
2001     case OFPACT_REG_LOAD:
2002         return nxm_reg_load_check(ofpact_get_REG_LOAD(a), flow);
2003
2004     case OFPACT_SET_FIELD:
2005         mf = ofpact_get_SET_FIELD(a)->field;
2006         /* Require OXM_OF_VLAN_VID to have an existing VLAN header. */
2007         if (!mf_are_prereqs_ok(mf, flow) ||
2008             (mf->id == MFF_VLAN_VID && !(flow->vlan_tci & htons(VLAN_CFI)))) {
2009             VLOG_WARN_RL(&rl, "set_field %s lacks correct prerequisities",
2010                          mf->name);
2011             return OFPERR_OFPBAC_MATCH_INCONSISTENT;
2012         }
2013         /* Remember if we saw a vlan tag in the flow to aid translating to
2014          * OpenFlow 1.1 if need be. */
2015         ofpact_get_SET_FIELD(a)->flow_has_vlan =
2016             (flow->vlan_tci & htons(VLAN_CFI)) == htons(VLAN_CFI);
2017         if (mf->id == MFF_VLAN_TCI) {
2018             /* The set field may add or remove the vlan tag,
2019              * Mark the status temporarily. */
2020             flow->vlan_tci = ofpact_get_SET_FIELD(a)->value.be16;
2021         }
2022         return 0;
2023
2024     case OFPACT_STACK_PUSH:
2025         return nxm_stack_push_check(ofpact_get_STACK_PUSH(a), flow);
2026
2027     case OFPACT_STACK_POP:
2028         return nxm_stack_pop_check(ofpact_get_STACK_POP(a), flow);
2029
2030     case OFPACT_SET_MPLS_LABEL:
2031     case OFPACT_SET_MPLS_TC:
2032     case OFPACT_SET_MPLS_TTL:
2033     case OFPACT_DEC_MPLS_TTL:
2034         if (!eth_type_mpls(flow->dl_type)) {
2035             inconsistent_match(usable_protocols);
2036         }
2037         return 0;
2038
2039     case OFPACT_SET_TUNNEL:
2040     case OFPACT_SET_QUEUE:
2041     case OFPACT_POP_QUEUE:
2042     case OFPACT_RESUBMIT:
2043         return 0;
2044
2045     case OFPACT_FIN_TIMEOUT:
2046         if (flow->nw_proto != IPPROTO_TCP) {
2047             inconsistent_match(usable_protocols);
2048         }
2049         return 0;
2050
2051     case OFPACT_LEARN:
2052         return learn_check(ofpact_get_LEARN(a), flow);
2053
2054     case OFPACT_MULTIPATH:
2055         return multipath_check(ofpact_get_MULTIPATH(a), flow);
2056
2057     case OFPACT_NOTE:
2058     case OFPACT_EXIT:
2059         return 0;
2060
2061     case OFPACT_PUSH_MPLS:
2062         flow->dl_type = ofpact_get_PUSH_MPLS(a)->ethertype;
2063         /* The packet is now MPLS and the MPLS payload is opaque.
2064          * Thus nothing can be assumed about the network protocol.
2065          * Temporarily mark that we have no nw_proto. */
2066         flow->nw_proto = 0;
2067         return 0;
2068
2069     case OFPACT_POP_MPLS:
2070         flow->dl_type = ofpact_get_POP_MPLS(a)->ethertype;
2071         if (!eth_type_mpls(flow->dl_type)) {
2072             inconsistent_match(usable_protocols);
2073         }
2074         return 0;
2075
2076     case OFPACT_SAMPLE:
2077         return 0;
2078
2079     case OFPACT_CLEAR_ACTIONS:
2080         return 0;
2081
2082     case OFPACT_WRITE_ACTIONS: {
2083         /* Use a temporary copy of 'usable_protocols' because we can't check
2084          * consistency of an action set. */
2085         struct ofpact_nest *on = ofpact_get_WRITE_ACTIONS(a);
2086         enum ofputil_protocol p = *usable_protocols;
2087         return ofpacts_check(on->actions, ofpact_nest_get_action_len(on),
2088                              flow, max_ports, table_id, n_tables, &p);
2089     }
2090
2091     case OFPACT_WRITE_METADATA:
2092         return 0;
2093
2094     case OFPACT_METER: {
2095         uint32_t mid = ofpact_get_METER(a)->meter_id;
2096         if (mid == 0 || mid > OFPM13_MAX) {
2097             return OFPERR_OFPMMFC_INVALID_METER;
2098         }
2099         return 0;
2100     }
2101
2102     case OFPACT_GOTO_TABLE: {
2103         uint8_t goto_table = ofpact_get_GOTO_TABLE(a)->table_id;
2104         if ((table_id != 255 && goto_table <= table_id)
2105             || (n_tables != 255 && goto_table >= n_tables)) {
2106             return OFPERR_OFPBRC_BAD_TABLE_ID;
2107         }
2108         return 0;
2109     }
2110
2111     case OFPACT_GROUP:
2112         return 0;
2113
2114     default:
2115         OVS_NOT_REACHED();
2116     }
2117 }
2118
2119 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
2120  * appropriate for a packet with the prerequisites satisfied by 'flow' in a
2121  * switch with no more than 'max_ports' ports.
2122  *
2123  * If 'ofpacts' and 'flow' are inconsistent with one another, un-sets in
2124  * '*usable_protocols' the protocols that forbid the inconsistency.  (An
2125  * example of an inconsistency between match and actions is a flow that does
2126  * not match on an MPLS Ethertype but has an action that pops an MPLS label.)
2127  *
2128  * May annotate ofpacts with information gathered from the 'flow'.
2129  *
2130  * May temporarily modify 'flow', but restores the changes before returning. */
2131 enum ofperr
2132 ofpacts_check(struct ofpact ofpacts[], size_t ofpacts_len,
2133               struct flow *flow, ofp_port_t max_ports,
2134               uint8_t table_id, uint8_t n_tables,
2135               enum ofputil_protocol *usable_protocols)
2136 {
2137     struct ofpact *a;
2138     ovs_be16 dl_type = flow->dl_type;
2139     ovs_be16 vlan_tci = flow->vlan_tci;
2140     uint8_t nw_proto = flow->nw_proto;
2141     enum ofperr error = 0;
2142
2143     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2144         error = ofpact_check__(usable_protocols, a, flow,
2145                                max_ports, table_id, n_tables);
2146         if (error) {
2147             break;
2148         }
2149     }
2150     /* Restore fields that may have been modified. */
2151     flow->dl_type = dl_type;
2152     flow->vlan_tci = vlan_tci;
2153     flow->nw_proto = nw_proto;
2154     return error;
2155 }
2156
2157 /* Like ofpacts_check(), but reports inconsistencies as
2158  * OFPERR_OFPBAC_MATCH_INCONSISTENT rather than clearing bits. */
2159 enum ofperr
2160 ofpacts_check_consistency(struct ofpact ofpacts[], size_t ofpacts_len,
2161                           struct flow *flow, ofp_port_t max_ports,
2162                           uint8_t table_id, uint8_t n_tables,
2163                           enum ofputil_protocol usable_protocols)
2164 {
2165     enum ofputil_protocol p = usable_protocols;
2166     enum ofperr error;
2167
2168     error = ofpacts_check(ofpacts, ofpacts_len, flow, max_ports,
2169                           table_id, n_tables, &p);
2170     return (error ? error
2171             : p != usable_protocols ? OFPERR_OFPBAC_MATCH_INCONSISTENT
2172             : 0);
2173 }
2174
2175 /* Verifies that the 'ofpacts_len' bytes of actions in 'ofpacts' are
2176  * in the appropriate order as defined by the OpenFlow spec. */
2177 enum ofperr
2178 ofpacts_verify(const struct ofpact ofpacts[], size_t ofpacts_len)
2179 {
2180     const struct ofpact *a;
2181     enum ovs_instruction_type inst;
2182
2183     inst = OVSINST_OFPIT13_METER;
2184     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2185         enum ovs_instruction_type next;
2186
2187         next = ovs_instruction_type_from_ofpact_type(a->type);
2188         if (a > ofpacts
2189             && (inst == OVSINST_OFPIT11_APPLY_ACTIONS
2190                 ? next < inst
2191                 : next <= inst)) {
2192             const char *name = ovs_instruction_name_from_type(inst);
2193             const char *next_name = ovs_instruction_name_from_type(next);
2194
2195             if (next == inst) {
2196                 VLOG_WARN("duplicate %s instruction not allowed, for OpenFlow "
2197                           "1.1+ compatibility", name);
2198             } else {
2199                 VLOG_WARN("invalid instruction ordering: %s must appear "
2200                           "before %s, for OpenFlow 1.1+ compatibility",
2201                           next_name, name);
2202             }
2203             return OFPERR_OFPBAC_UNSUPPORTED_ORDER;
2204         }
2205
2206         inst = next;
2207     }
2208
2209     return 0;
2210 }
2211 \f
2212 /* Converting ofpacts to Nicira OpenFlow extensions. */
2213
2214 static void
2215 ofpact_output_reg_to_nxast(const struct ofpact_output_reg *output_reg,
2216                                 struct ofpbuf *out)
2217 {
2218     struct nx_action_output_reg *naor = ofputil_put_NXAST_OUTPUT_REG(out);
2219
2220     naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
2221                                            output_reg->src.n_bits);
2222     naor->src = htonl(output_reg->src.field->nxm_header);
2223     naor->max_len = htons(output_reg->max_len);
2224 }
2225
2226 static void
2227 ofpact_resubmit_to_nxast(const struct ofpact_resubmit *resubmit,
2228                          struct ofpbuf *out)
2229 {
2230     struct nx_action_resubmit *nar;
2231
2232     if (resubmit->table_id == 0xff
2233         && resubmit->ofpact.compat != OFPUTIL_NXAST_RESUBMIT_TABLE) {
2234         nar = ofputil_put_NXAST_RESUBMIT(out);
2235     } else {
2236         nar = ofputil_put_NXAST_RESUBMIT_TABLE(out);
2237         nar->table = resubmit->table_id;
2238     }
2239     nar->in_port = htons(ofp_to_u16(resubmit->in_port));
2240 }
2241
2242 static void
2243 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel *tunnel,
2244                            struct ofpbuf *out)
2245 {
2246     uint64_t tun_id = tunnel->tun_id;
2247
2248     if (tun_id <= UINT32_MAX
2249         && tunnel->ofpact.compat != OFPUTIL_NXAST_SET_TUNNEL64) {
2250         ofputil_put_NXAST_SET_TUNNEL(out)->tun_id = htonl(tun_id);
2251     } else {
2252         ofputil_put_NXAST_SET_TUNNEL64(out)->tun_id = htonll(tun_id);
2253     }
2254 }
2255
2256 static void
2257 ofpact_write_metadata_to_nxast(const struct ofpact_metadata *om,
2258                                struct ofpbuf *out)
2259 {
2260     struct nx_action_write_metadata *nawm;
2261
2262     nawm = ofputil_put_NXAST_WRITE_METADATA(out);
2263     nawm->metadata = om->metadata;
2264     nawm->mask = om->mask;
2265 }
2266
2267 static void
2268 ofpact_note_to_nxast(const struct ofpact_note *note, struct ofpbuf *out)
2269 {
2270     size_t start_ofs = out->size;
2271     struct nx_action_note *nan;
2272     unsigned int remainder;
2273     unsigned int len;
2274
2275     nan = ofputil_put_NXAST_NOTE(out);
2276     out->size -= sizeof nan->note;
2277
2278     ofpbuf_put(out, note->data, note->length);
2279
2280     len = out->size - start_ofs;
2281     remainder = len % OFP_ACTION_ALIGN;
2282     if (remainder) {
2283         ofpbuf_put_zeros(out, OFP_ACTION_ALIGN - remainder);
2284     }
2285     nan = ofpbuf_at(out, start_ofs, sizeof *nan);
2286     nan->len = htons(out->size - start_ofs);
2287 }
2288
2289 static void
2290 ofpact_controller_to_nxast(const struct ofpact_controller *oc,
2291                            struct ofpbuf *out)
2292 {
2293     struct nx_action_controller *nac;
2294
2295     nac = ofputil_put_NXAST_CONTROLLER(out);
2296     nac->max_len = htons(oc->max_len);
2297     nac->controller_id = htons(oc->controller_id);
2298     nac->reason = oc->reason;
2299 }
2300
2301 static void
2302 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids *oc_ids,
2303                         struct ofpbuf *out)
2304 {
2305     if (oc_ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL) {
2306         ofputil_put_NXAST_DEC_TTL(out);
2307     } else {
2308         struct nx_action_cnt_ids *nac_ids =
2309             ofputil_put_NXAST_DEC_TTL_CNT_IDS(out);
2310         int ids_len = ROUND_UP(2 * oc_ids->n_controllers, OFP_ACTION_ALIGN);
2311         ovs_be16 *ids;
2312         size_t i;
2313
2314         nac_ids->len = htons(ntohs(nac_ids->len) + ids_len);
2315         nac_ids->n_controllers = htons(oc_ids->n_controllers);
2316
2317         ids = ofpbuf_put_zeros(out, ids_len);
2318         for (i = 0; i < oc_ids->n_controllers; i++) {
2319             ids[i] = htons(oc_ids->cnt_ids[i]);
2320         }
2321     }
2322 }
2323
2324 static void
2325 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout *fin_timeout,
2326                             struct ofpbuf *out)
2327 {
2328     struct nx_action_fin_timeout *naft = ofputil_put_NXAST_FIN_TIMEOUT(out);
2329     naft->fin_idle_timeout = htons(fin_timeout->fin_idle_timeout);
2330     naft->fin_hard_timeout = htons(fin_timeout->fin_hard_timeout);
2331 }
2332
2333 static void
2334 ofpact_sample_to_nxast(const struct ofpact_sample *os,
2335                        struct ofpbuf *out)
2336 {
2337     struct nx_action_sample *nas;
2338
2339     nas = ofputil_put_NXAST_SAMPLE(out);
2340     nas->probability = htons(os->probability);
2341     nas->collector_set_id = htonl(os->collector_set_id);
2342     nas->obs_domain_id = htonl(os->obs_domain_id);
2343     nas->obs_point_id = htonl(os->obs_point_id);
2344 }
2345
2346 static void
2347 ofpact_to_nxast(const struct ofpact *a, struct ofpbuf *out)
2348 {
2349     switch (a->type) {
2350     case OFPACT_CONTROLLER:
2351         ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a), out);
2352         break;
2353
2354     case OFPACT_OUTPUT_REG:
2355         ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a), out);
2356         break;
2357
2358     case OFPACT_BUNDLE:
2359         bundle_to_nxast(ofpact_get_BUNDLE(a), out);
2360         break;
2361
2362     case OFPACT_REG_MOVE:
2363         nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a), out);
2364         break;
2365
2366     case OFPACT_REG_LOAD:
2367         nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a), out);
2368         break;
2369
2370     case OFPACT_STACK_PUSH:
2371         nxm_stack_push_to_nxast(ofpact_get_STACK_PUSH(a), out);
2372         break;
2373
2374     case OFPACT_STACK_POP:
2375         nxm_stack_pop_to_nxast(ofpact_get_STACK_POP(a), out);
2376         break;
2377
2378     case OFPACT_DEC_TTL:
2379         ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a), out);
2380         break;
2381
2382     case OFPACT_SET_MPLS_LABEL:
2383         ofputil_put_NXAST_SET_MPLS_LABEL(out)->label
2384             = ofpact_get_SET_MPLS_LABEL(a)->label;
2385         break;
2386
2387     case OFPACT_SET_MPLS_TC:
2388         ofputil_put_NXAST_SET_MPLS_TC(out)->tc
2389             = ofpact_get_SET_MPLS_TC(a)->tc;
2390         break;
2391
2392     case OFPACT_SET_MPLS_TTL:
2393         ofputil_put_NXAST_SET_MPLS_TTL(out)->ttl
2394             = ofpact_get_SET_MPLS_TTL(a)->ttl;
2395         break;
2396
2397     case OFPACT_DEC_MPLS_TTL:
2398         ofputil_put_NXAST_DEC_MPLS_TTL(out);
2399         break;
2400
2401     case OFPACT_SET_TUNNEL:
2402         ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a), out);
2403         break;
2404
2405     case OFPACT_WRITE_METADATA:
2406         ofpact_write_metadata_to_nxast(ofpact_get_WRITE_METADATA(a), out);
2407         break;
2408
2409     case OFPACT_SET_QUEUE:
2410         ofputil_put_NXAST_SET_QUEUE(out)->queue_id
2411             = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
2412         break;
2413
2414     case OFPACT_POP_QUEUE:
2415         ofputil_put_NXAST_POP_QUEUE(out);
2416         break;
2417
2418     case OFPACT_FIN_TIMEOUT:
2419         ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a), out);
2420         break;
2421
2422     case OFPACT_RESUBMIT:
2423         ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a), out);
2424         break;
2425
2426     case OFPACT_LEARN:
2427         learn_to_nxast(ofpact_get_LEARN(a), out);
2428         break;
2429
2430     case OFPACT_MULTIPATH:
2431         multipath_to_nxast(ofpact_get_MULTIPATH(a), out);
2432         break;
2433
2434     case OFPACT_NOTE:
2435         ofpact_note_to_nxast(ofpact_get_NOTE(a), out);
2436         break;
2437
2438     case OFPACT_EXIT:
2439         ofputil_put_NXAST_EXIT(out);
2440         break;
2441
2442     case OFPACT_PUSH_MPLS:
2443         ofputil_put_NXAST_PUSH_MPLS(out)->ethertype =
2444             ofpact_get_PUSH_MPLS(a)->ethertype;
2445         break;
2446
2447     case OFPACT_POP_MPLS:
2448         ofputil_put_NXAST_POP_MPLS(out)->ethertype =
2449             ofpact_get_POP_MPLS(a)->ethertype;
2450         break;
2451
2452     case OFPACT_SAMPLE:
2453         ofpact_sample_to_nxast(ofpact_get_SAMPLE(a), out);
2454         break;
2455
2456     case OFPACT_GROUP:
2457     case OFPACT_OUTPUT:
2458     case OFPACT_ENQUEUE:
2459     case OFPACT_SET_VLAN_VID:
2460     case OFPACT_SET_VLAN_PCP:
2461     case OFPACT_STRIP_VLAN:
2462     case OFPACT_PUSH_VLAN:
2463     case OFPACT_SET_ETH_SRC:
2464     case OFPACT_SET_ETH_DST:
2465     case OFPACT_SET_IPV4_SRC:
2466     case OFPACT_SET_IPV4_DST:
2467     case OFPACT_SET_IP_DSCP:
2468     case OFPACT_SET_IP_ECN:
2469     case OFPACT_SET_IP_TTL:
2470     case OFPACT_SET_L4_SRC_PORT:
2471     case OFPACT_SET_L4_DST_PORT:
2472     case OFPACT_WRITE_ACTIONS:
2473     case OFPACT_CLEAR_ACTIONS:
2474     case OFPACT_GOTO_TABLE:
2475     case OFPACT_METER:
2476     case OFPACT_SET_FIELD:
2477         OVS_NOT_REACHED();
2478     }
2479 }
2480 \f
2481 /* Converting ofpacts to OpenFlow 1.0. */
2482
2483 static void
2484 ofpact_output_to_openflow10(const struct ofpact_output *output,
2485                             struct ofpbuf *out)
2486 {
2487     struct ofp10_action_output *oao;
2488
2489     oao = ofputil_put_OFPAT10_OUTPUT(out);
2490     oao->port = htons(ofp_to_u16(output->port));
2491     oao->max_len = htons(output->max_len);
2492 }
2493
2494 static void
2495 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue *enqueue,
2496                              struct ofpbuf *out)
2497 {
2498     struct ofp10_action_enqueue *oae;
2499
2500     oae = ofputil_put_OFPAT10_ENQUEUE(out);
2501     oae->port = htons(ofp_to_u16(enqueue->port));
2502     oae->queue_id = htonl(enqueue->queue);
2503 }
2504
2505 static void
2506 ofpact_to_openflow10(const struct ofpact *a, struct ofpbuf *out)
2507 {
2508     switch (a->type) {
2509     case OFPACT_OUTPUT:
2510         ofpact_output_to_openflow10(ofpact_get_OUTPUT(a), out);
2511         break;
2512
2513     case OFPACT_ENQUEUE:
2514         ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a), out);
2515         break;
2516
2517     case OFPACT_SET_VLAN_VID:
2518         ofputil_put_OFPAT10_SET_VLAN_VID(out)->vlan_vid
2519             = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
2520         break;
2521
2522     case OFPACT_SET_VLAN_PCP:
2523         ofputil_put_OFPAT10_SET_VLAN_PCP(out)->vlan_pcp
2524             = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
2525         break;
2526
2527     case OFPACT_STRIP_VLAN:
2528         ofputil_put_OFPAT10_STRIP_VLAN(out);
2529         break;
2530
2531     case OFPACT_SET_ETH_SRC:
2532         memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out)->dl_addr,
2533                ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
2534         break;
2535
2536     case OFPACT_SET_ETH_DST:
2537         memcpy(ofputil_put_OFPAT10_SET_DL_DST(out)->dl_addr,
2538                ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
2539         break;
2540
2541     case OFPACT_SET_IPV4_SRC:
2542         ofputil_put_OFPAT10_SET_NW_SRC(out)->nw_addr
2543             = ofpact_get_SET_IPV4_SRC(a)->ipv4;
2544         break;
2545
2546     case OFPACT_SET_IPV4_DST:
2547         ofputil_put_OFPAT10_SET_NW_DST(out)->nw_addr
2548             = ofpact_get_SET_IPV4_DST(a)->ipv4;
2549         break;
2550
2551     case OFPACT_SET_IP_DSCP:
2552         ofputil_put_OFPAT10_SET_NW_TOS(out)->nw_tos
2553             = ofpact_get_SET_IP_DSCP(a)->dscp;
2554         break;
2555
2556     case OFPACT_SET_L4_SRC_PORT:
2557         ofputil_put_OFPAT10_SET_TP_SRC(out)->tp_port
2558             = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
2559         break;
2560
2561     case OFPACT_SET_L4_DST_PORT:
2562         ofputil_put_OFPAT10_SET_TP_DST(out)->tp_port
2563             = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
2564         break;
2565
2566     case OFPACT_PUSH_VLAN:
2567         /* PUSH is a side effect of a SET_VLAN_VID/PCP, which should
2568          * follow this action. */
2569         break;
2570
2571     case OFPACT_CLEAR_ACTIONS:
2572     case OFPACT_WRITE_ACTIONS:
2573     case OFPACT_GOTO_TABLE:
2574     case OFPACT_METER:
2575         /* XXX */
2576         break;
2577
2578     case OFPACT_GROUP:
2579         break;
2580
2581     case OFPACT_SET_FIELD:
2582         set_field_to_openflow(ofpact_get_SET_FIELD(a), out);
2583         break;
2584
2585     case OFPACT_CONTROLLER:
2586     case OFPACT_OUTPUT_REG:
2587     case OFPACT_BUNDLE:
2588     case OFPACT_REG_MOVE:
2589     case OFPACT_REG_LOAD:
2590     case OFPACT_STACK_PUSH:
2591     case OFPACT_STACK_POP:
2592     case OFPACT_DEC_TTL:
2593     case OFPACT_SET_IP_ECN:
2594     case OFPACT_SET_IP_TTL:
2595     case OFPACT_SET_MPLS_LABEL:
2596     case OFPACT_SET_MPLS_TC:
2597     case OFPACT_SET_MPLS_TTL:
2598     case OFPACT_DEC_MPLS_TTL:
2599     case OFPACT_SET_TUNNEL:
2600     case OFPACT_WRITE_METADATA:
2601     case OFPACT_SET_QUEUE:
2602     case OFPACT_POP_QUEUE:
2603     case OFPACT_FIN_TIMEOUT:
2604     case OFPACT_RESUBMIT:
2605     case OFPACT_LEARN:
2606     case OFPACT_MULTIPATH:
2607     case OFPACT_NOTE:
2608     case OFPACT_EXIT:
2609     case OFPACT_PUSH_MPLS:
2610     case OFPACT_POP_MPLS:
2611     case OFPACT_SAMPLE:
2612         ofpact_to_nxast(a, out);
2613         break;
2614     }
2615 }
2616 \f
2617 /* Converting ofpacts to OpenFlow 1.1. */
2618
2619 static void
2620 ofpact_output_to_openflow11(const struct ofpact_output *output,
2621                             struct ofpbuf *out)
2622 {
2623     struct ofp11_action_output *oao;
2624
2625     oao = ofputil_put_OFPAT11_OUTPUT(out);
2626     oao->port = ofputil_port_to_ofp11(output->port);
2627     oao->max_len = htons(output->max_len);
2628 }
2629
2630 static void
2631 ofpact_dec_ttl_to_openflow11(const struct ofpact_cnt_ids *dec_ttl,
2632                              struct ofpbuf *out)
2633 {
2634     if (dec_ttl->n_controllers == 1 && dec_ttl->cnt_ids[0] == 0
2635         && (!dec_ttl->ofpact.compat ||
2636             dec_ttl->ofpact.compat == OFPUTIL_OFPAT11_DEC_NW_TTL)) {
2637         ofputil_put_OFPAT11_DEC_NW_TTL(out);
2638     } else {
2639         ofpact_dec_ttl_to_nxast(dec_ttl, out);
2640     }
2641 }
2642
2643 static void
2644 ofpact_to_openflow11(const struct ofpact *a, struct ofpbuf *out)
2645 {
2646     switch (a->type) {
2647     case OFPACT_OUTPUT:
2648         return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a), out);
2649
2650     case OFPACT_ENQUEUE:
2651         /* XXX */
2652         break;
2653
2654     case OFPACT_SET_VLAN_VID:
2655         /* Push a VLAN tag, if one was not seen at action validation time. */
2656         if (!ofpact_get_SET_VLAN_VID(a)->flow_has_vlan
2657             && ofpact_get_SET_VLAN_VID(a)->push_vlan_if_needed) {
2658             ofputil_put_OFPAT11_PUSH_VLAN(out)->ethertype
2659                 = htons(ETH_TYPE_VLAN_8021Q);
2660         }
2661         ofputil_put_OFPAT11_SET_VLAN_VID(out)->vlan_vid
2662             = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
2663         break;
2664
2665     case OFPACT_SET_VLAN_PCP:
2666         /* Push a VLAN tag, if one was not seen at action validation time. */
2667         if (!ofpact_get_SET_VLAN_PCP(a)->flow_has_vlan
2668             && ofpact_get_SET_VLAN_PCP(a)->push_vlan_if_needed) {
2669             ofputil_put_OFPAT11_PUSH_VLAN(out)->ethertype
2670                 = htons(ETH_TYPE_VLAN_8021Q);
2671         }
2672         ofputil_put_OFPAT11_SET_VLAN_PCP(out)->vlan_pcp
2673             = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
2674         break;
2675
2676     case OFPACT_STRIP_VLAN:
2677         ofputil_put_OFPAT11_POP_VLAN(out);
2678         break;
2679
2680     case OFPACT_PUSH_VLAN:
2681         /* XXX ETH_TYPE_VLAN_8021AD case */
2682         ofputil_put_OFPAT11_PUSH_VLAN(out)->ethertype =
2683             htons(ETH_TYPE_VLAN_8021Q);
2684         break;
2685
2686     case OFPACT_SET_QUEUE:
2687         ofputil_put_OFPAT11_SET_QUEUE(out)->queue_id
2688             = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
2689         break;
2690
2691     case OFPACT_SET_ETH_SRC:
2692         memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out)->dl_addr,
2693                ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
2694         break;
2695
2696     case OFPACT_SET_ETH_DST:
2697         memcpy(ofputil_put_OFPAT11_SET_DL_DST(out)->dl_addr,
2698                ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
2699         break;
2700
2701     case OFPACT_SET_IPV4_SRC:
2702         ofputil_put_OFPAT11_SET_NW_SRC(out)->nw_addr
2703             = ofpact_get_SET_IPV4_SRC(a)->ipv4;
2704         break;
2705
2706     case OFPACT_SET_IPV4_DST:
2707         ofputil_put_OFPAT11_SET_NW_DST(out)->nw_addr
2708             = ofpact_get_SET_IPV4_DST(a)->ipv4;
2709         break;
2710
2711     case OFPACT_SET_IP_DSCP:
2712         ofputil_put_OFPAT11_SET_NW_TOS(out)->nw_tos
2713             = ofpact_get_SET_IP_DSCP(a)->dscp;
2714         break;
2715
2716     case OFPACT_SET_IP_ECN:
2717         ofputil_put_OFPAT11_SET_NW_ECN(out)->nw_ecn
2718             = ofpact_get_SET_IP_ECN(a)->ecn;
2719         break;
2720
2721     case OFPACT_SET_IP_TTL:
2722         ofputil_put_OFPAT11_SET_NW_TTL(out)->nw_ttl
2723             = ofpact_get_SET_IP_TTL(a)->ttl;
2724         break;
2725
2726     case OFPACT_SET_L4_SRC_PORT:
2727         ofputil_put_OFPAT11_SET_TP_SRC(out)->tp_port
2728             = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
2729         break;
2730
2731     case OFPACT_SET_L4_DST_PORT:
2732         ofputil_put_OFPAT11_SET_TP_DST(out)->tp_port
2733             = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
2734         break;
2735
2736     case OFPACT_DEC_TTL:
2737         ofpact_dec_ttl_to_openflow11(ofpact_get_DEC_TTL(a), out);
2738         break;
2739
2740     case OFPACT_SET_MPLS_LABEL:
2741         ofputil_put_OFPAT11_SET_MPLS_LABEL(out)->mpls_label
2742             = ofpact_get_SET_MPLS_LABEL(a)->label;
2743         break;
2744
2745     case OFPACT_SET_MPLS_TC:
2746         ofputil_put_OFPAT11_SET_MPLS_TC(out)->mpls_tc
2747             = ofpact_get_SET_MPLS_TC(a)->tc;
2748         break;
2749
2750     case OFPACT_SET_MPLS_TTL:
2751         ofputil_put_OFPAT11_SET_MPLS_TTL(out)->mpls_ttl
2752             = ofpact_get_SET_MPLS_TTL(a)->ttl;
2753         break;
2754
2755     case OFPACT_DEC_MPLS_TTL:
2756         ofputil_put_OFPAT11_DEC_MPLS_TTL(out);
2757         break;
2758
2759     case OFPACT_WRITE_METADATA:
2760         /* OpenFlow 1.1 uses OFPIT_WRITE_METADATA to express this action. */
2761         break;
2762
2763     case OFPACT_PUSH_MPLS:
2764         ofputil_put_OFPAT11_PUSH_MPLS(out)->ethertype =
2765             ofpact_get_PUSH_MPLS(a)->ethertype;
2766         break;
2767
2768     case OFPACT_POP_MPLS:
2769         ofputil_put_OFPAT11_POP_MPLS(out)->ethertype =
2770             ofpact_get_POP_MPLS(a)->ethertype;
2771
2772         break;
2773
2774     case OFPACT_CLEAR_ACTIONS:
2775     case OFPACT_WRITE_ACTIONS:
2776     case OFPACT_GOTO_TABLE:
2777     case OFPACT_METER:
2778         OVS_NOT_REACHED();
2779
2780     case OFPACT_GROUP:
2781         ofputil_put_OFPAT11_GROUP(out)->group_id =
2782             htonl(ofpact_get_GROUP(a)->group_id);
2783         break;
2784
2785     case OFPACT_SET_FIELD:
2786         set_field_to_openflow(ofpact_get_SET_FIELD(a), out);
2787         break;
2788
2789     case OFPACT_CONTROLLER:
2790     case OFPACT_OUTPUT_REG:
2791     case OFPACT_BUNDLE:
2792     case OFPACT_REG_MOVE:
2793     case OFPACT_REG_LOAD:
2794     case OFPACT_STACK_PUSH:
2795     case OFPACT_STACK_POP:
2796     case OFPACT_SET_TUNNEL:
2797     case OFPACT_POP_QUEUE:
2798     case OFPACT_FIN_TIMEOUT:
2799     case OFPACT_RESUBMIT:
2800     case OFPACT_LEARN:
2801     case OFPACT_MULTIPATH:
2802     case OFPACT_NOTE:
2803     case OFPACT_EXIT:
2804     case OFPACT_SAMPLE:
2805         ofpact_to_nxast(a, out);
2806         break;
2807     }
2808 }
2809
2810 /* Output deprecated set actions as set_field actions. */
2811 static void
2812 ofpact_to_openflow12(const struct ofpact *a, struct ofpbuf *out)
2813 {
2814     enum mf_field_id field;
2815     union mf_value value;
2816     struct ofpact_l4_port *l4port;
2817     uint8_t proto;
2818
2819     /*
2820      * Convert actions deprecated in OpenFlow 1.2 to Set Field actions,
2821      * if possible.
2822      */
2823     switch ((int)a->type) {
2824     case OFPACT_SET_VLAN_VID:
2825     case OFPACT_SET_VLAN_PCP:
2826     case OFPACT_SET_ETH_SRC:
2827     case OFPACT_SET_ETH_DST:
2828     case OFPACT_SET_IPV4_SRC:
2829     case OFPACT_SET_IPV4_DST:
2830     case OFPACT_SET_IP_DSCP:
2831     case OFPACT_SET_IP_ECN:
2832     case OFPACT_SET_L4_SRC_PORT:
2833     case OFPACT_SET_L4_DST_PORT:
2834     case OFPACT_SET_MPLS_LABEL:
2835     case OFPACT_SET_MPLS_TC:
2836     case OFPACT_SET_TUNNEL:  /* Convert to a set_field, too. */
2837
2838         switch ((int)a->type) {
2839
2840         case OFPACT_SET_VLAN_VID:
2841             if (!ofpact_get_SET_VLAN_VID(a)->flow_has_vlan &&
2842                 ofpact_get_SET_VLAN_VID(a)->push_vlan_if_needed) {
2843                 ofputil_put_OFPAT11_PUSH_VLAN(out)->ethertype
2844                     = htons(ETH_TYPE_VLAN_8021Q);
2845             }
2846             field = MFF_VLAN_VID;
2847             /* Set-Field on OXM_OF_VLAN_VID must have OFPVID_PRESENT set. */
2848             value.be16 = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid
2849                                | OFPVID12_PRESENT);
2850             break;
2851
2852         case OFPACT_SET_VLAN_PCP:
2853             if (!ofpact_get_SET_VLAN_PCP(a)->flow_has_vlan &&
2854                 ofpact_get_SET_VLAN_PCP(a)->push_vlan_if_needed) {
2855                 ofputil_put_OFPAT11_PUSH_VLAN(out)->ethertype
2856                     = htons(ETH_TYPE_VLAN_8021Q);
2857             }
2858             field = MFF_VLAN_PCP;
2859             value.u8 = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
2860             break;
2861
2862         case OFPACT_SET_ETH_SRC:
2863             field = MFF_ETH_SRC;
2864             memcpy(value.mac, ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
2865             break;
2866
2867         case OFPACT_SET_ETH_DST:
2868             field = MFF_ETH_DST;
2869             memcpy(value.mac, ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
2870             break;
2871
2872         case OFPACT_SET_IPV4_SRC:
2873             field = MFF_IPV4_SRC;
2874             value.be32 = ofpact_get_SET_IPV4_SRC(a)->ipv4;
2875             break;
2876
2877         case OFPACT_SET_IPV4_DST:
2878             field = MFF_IPV4_DST;
2879             value.be32 = ofpact_get_SET_IPV4_DST(a)->ipv4;
2880             break;
2881
2882         case OFPACT_SET_IP_DSCP:
2883             field = MFF_IP_DSCP_SHIFTED; /* OXM_OF_IP_DSCP */
2884             value.u8 = ofpact_get_SET_IP_DSCP(a)->dscp >> 2;
2885             break;
2886
2887         case OFPACT_SET_IP_ECN:
2888             field = MFF_IP_ECN;
2889             value.u8 = ofpact_get_SET_IP_ECN(a)->ecn;
2890             break;
2891
2892         case OFPACT_SET_L4_SRC_PORT:
2893             /* We keep track of IP protocol while translating actions to be
2894              * able to translate to the proper OXM type.
2895              * If the IP protocol type is unknown, the translation cannot
2896              * be performed and we will send the action using the original
2897              * action type. */
2898             l4port = ofpact_get_SET_L4_SRC_PORT(a);
2899             proto = l4port->flow_ip_proto;
2900             field = proto == IPPROTO_TCP ? MFF_TCP_SRC
2901                 : proto == IPPROTO_UDP ? MFF_UDP_SRC
2902                 : proto == IPPROTO_SCTP ? MFF_SCTP_SRC
2903                 : MFF_N_IDS; /* RFC: Unknown IP proto, do not translate. */
2904             value.be16 = htons(l4port->port);
2905             break;
2906
2907         case OFPACT_SET_L4_DST_PORT:
2908             l4port = ofpact_get_SET_L4_DST_PORT(a);
2909             proto = l4port->flow_ip_proto;
2910             field = proto == IPPROTO_TCP ? MFF_TCP_DST
2911                 : proto == IPPROTO_UDP ? MFF_UDP_DST
2912                 : proto == IPPROTO_SCTP ? MFF_SCTP_DST
2913                 : MFF_N_IDS; /* RFC: Unknown IP proto, do not translate. */
2914             value.be16 = htons(l4port->port);
2915             break;
2916
2917         case OFPACT_SET_MPLS_LABEL:
2918             field = MFF_MPLS_LABEL;
2919             value.be32 = ofpact_get_SET_MPLS_LABEL(a)->label;
2920             break;
2921
2922         case OFPACT_SET_MPLS_TC:
2923             field = MFF_MPLS_TC;
2924             value.u8 = ofpact_get_SET_MPLS_TC(a)->tc;
2925             break;
2926
2927         case OFPACT_SET_TUNNEL:
2928             field = MFF_TUN_ID;
2929             value.be64 = htonll(ofpact_get_SET_TUNNEL(a)->tun_id);
2930             break;
2931
2932         default:
2933             field = MFF_N_IDS;
2934         }
2935
2936         /* Put the action out as a set field action, if possible. */
2937         if (field < MFF_N_IDS) {
2938             uint64_t ofpacts_stub[128 / 8];
2939             struct ofpbuf sf_act;
2940             struct ofpact_set_field *sf;
2941
2942             ofpbuf_use_stub(&sf_act, ofpacts_stub, sizeof ofpacts_stub);
2943             sf = ofpact_put_SET_FIELD(&sf_act);
2944             sf->field = mf_from_id(field);
2945             memcpy(&sf->value, &value, sf->field->n_bytes);
2946             set_field_to_openflow(sf, out);
2947             return;
2948         }
2949     }
2950
2951     ofpact_to_openflow11(a, out);
2952 }
2953
2954 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow
2955  * actions in 'openflow', appending the actions to any existing data in
2956  * 'openflow'. */
2957 size_t
2958 ofpacts_put_openflow_actions(const struct ofpact ofpacts[], size_t ofpacts_len,
2959                              struct ofpbuf *openflow,
2960                              enum ofp_version ofp_version)
2961 {
2962     const struct ofpact *a;
2963     size_t start_size = openflow->size;
2964
2965     void (*translate)(const struct ofpact *a, struct ofpbuf *out) =
2966         (ofp_version == OFP10_VERSION) ? ofpact_to_openflow10 :
2967         (ofp_version == OFP11_VERSION) ? ofpact_to_openflow11 :
2968         ofpact_to_openflow12;
2969
2970     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2971         translate(a, openflow);
2972     }
2973     return openflow->size - start_size;
2974 }
2975
2976 static void
2977 ofpacts_update_instruction_actions(struct ofpbuf *openflow, size_t ofs)
2978 {
2979     struct ofp11_instruction_actions *oia;
2980
2981     /* Update the instruction's length (or, if it's empty, delete it). */
2982     oia = ofpbuf_at_assert(openflow, ofs, sizeof *oia);
2983     if (openflow->size > ofs + sizeof *oia) {
2984         oia->len = htons(openflow->size - ofs);
2985     } else {
2986         openflow->size = ofs;
2987     }
2988 }
2989
2990 void
2991 ofpacts_put_openflow_instructions(const struct ofpact ofpacts[],
2992                                   size_t ofpacts_len,
2993                                   struct ofpbuf *openflow,
2994                                   enum ofp_version ofp_version)
2995 {
2996     const struct ofpact *a;
2997
2998     ovs_assert(ofp_version >= OFP11_VERSION);
2999
3000     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3001         switch (ovs_instruction_type_from_ofpact_type(a->type)) {
3002         case OVSINST_OFPIT11_CLEAR_ACTIONS:
3003             instruction_put_OFPIT11_CLEAR_ACTIONS(openflow);
3004             break;
3005
3006         case OVSINST_OFPIT11_GOTO_TABLE: {
3007             struct ofp11_instruction_goto_table *oigt;
3008             oigt = instruction_put_OFPIT11_GOTO_TABLE(openflow);
3009             oigt->table_id = ofpact_get_GOTO_TABLE(a)->table_id;
3010             memset(oigt->pad, 0, sizeof oigt->pad);
3011             break;
3012         }
3013
3014         case OVSINST_OFPIT11_WRITE_METADATA: {
3015             const struct ofpact_metadata *om;
3016             struct ofp11_instruction_write_metadata *oiwm;
3017
3018             om = ofpact_get_WRITE_METADATA(a);
3019             oiwm = instruction_put_OFPIT11_WRITE_METADATA(openflow);
3020             oiwm->metadata = om->metadata;
3021             oiwm->metadata_mask = om->mask;
3022             break;
3023         }
3024
3025         case OVSINST_OFPIT13_METER:
3026             if (ofp_version >= OFP13_VERSION) {
3027                 const struct ofpact_meter *om;
3028                 struct ofp13_instruction_meter *oim;
3029
3030                 om = ofpact_get_METER(a);
3031                 oim = instruction_put_OFPIT13_METER(openflow);
3032                 oim->meter_id = htonl(om->meter_id);
3033             }
3034             break;
3035
3036         case OVSINST_OFPIT11_APPLY_ACTIONS: {
3037             const size_t ofs = openflow->size;
3038             const size_t ofpacts_len_left =
3039                 (uint8_t*)ofpact_end(ofpacts, ofpacts_len) - (uint8_t*)a;
3040             const struct ofpact *action;
3041             const struct ofpact *processed = a;
3042
3043             instruction_put_OFPIT11_APPLY_ACTIONS(openflow);
3044             OFPACT_FOR_EACH(action, a, ofpacts_len_left) {
3045                 if (ovs_instruction_type_from_ofpact_type(action->type)
3046                     != OVSINST_OFPIT11_APPLY_ACTIONS) {
3047                     break;
3048                 }
3049                 if (ofp_version == OFP11_VERSION) {
3050                     ofpact_to_openflow11(action, openflow);
3051                 } else {
3052                     ofpact_to_openflow12(action, openflow);
3053                 }
3054                 processed = action;
3055             }
3056             ofpacts_update_instruction_actions(openflow, ofs);
3057             a = processed;
3058             break;
3059         }
3060
3061         case OVSINST_OFPIT11_WRITE_ACTIONS: {
3062             const size_t ofs = openflow->size;
3063             const struct ofpact_nest *on;
3064
3065             on = ofpact_get_WRITE_ACTIONS(a);
3066             instruction_put_OFPIT11_WRITE_ACTIONS(openflow);
3067             ofpacts_put_openflow_actions(on->actions,
3068                                          ofpact_nest_get_action_len(on),
3069                                          openflow, ofp_version);
3070             ofpacts_update_instruction_actions(openflow, ofs);
3071
3072             break;
3073         }
3074         }
3075     }
3076 }
3077 \f
3078 /* Returns true if 'action' outputs to 'port', false otherwise. */
3079 static bool
3080 ofpact_outputs_to_port(const struct ofpact *ofpact, ofp_port_t port)
3081 {
3082     switch (ofpact->type) {
3083     case OFPACT_OUTPUT:
3084         return ofpact_get_OUTPUT(ofpact)->port == port;
3085     case OFPACT_ENQUEUE:
3086         return ofpact_get_ENQUEUE(ofpact)->port == port;
3087     case OFPACT_CONTROLLER:
3088         return port == OFPP_CONTROLLER;
3089
3090     case OFPACT_OUTPUT_REG:
3091     case OFPACT_BUNDLE:
3092     case OFPACT_SET_VLAN_VID:
3093     case OFPACT_SET_VLAN_PCP:
3094     case OFPACT_STRIP_VLAN:
3095     case OFPACT_PUSH_VLAN:
3096     case OFPACT_SET_ETH_SRC:
3097     case OFPACT_SET_ETH_DST:
3098     case OFPACT_SET_IPV4_SRC:
3099     case OFPACT_SET_IPV4_DST:
3100     case OFPACT_SET_IP_DSCP:
3101     case OFPACT_SET_IP_ECN:
3102     case OFPACT_SET_IP_TTL:
3103     case OFPACT_SET_L4_SRC_PORT:
3104     case OFPACT_SET_L4_DST_PORT:
3105     case OFPACT_REG_MOVE:
3106     case OFPACT_REG_LOAD:
3107     case OFPACT_SET_FIELD:
3108     case OFPACT_STACK_PUSH:
3109     case OFPACT_STACK_POP:
3110     case OFPACT_DEC_TTL:
3111     case OFPACT_SET_MPLS_LABEL:
3112     case OFPACT_SET_MPLS_TC:
3113     case OFPACT_SET_MPLS_TTL:
3114     case OFPACT_DEC_MPLS_TTL:
3115     case OFPACT_SET_TUNNEL:
3116     case OFPACT_WRITE_METADATA:
3117     case OFPACT_SET_QUEUE:
3118     case OFPACT_POP_QUEUE:
3119     case OFPACT_FIN_TIMEOUT:
3120     case OFPACT_RESUBMIT:
3121     case OFPACT_LEARN:
3122     case OFPACT_MULTIPATH:
3123     case OFPACT_NOTE:
3124     case OFPACT_EXIT:
3125     case OFPACT_PUSH_MPLS:
3126     case OFPACT_POP_MPLS:
3127     case OFPACT_SAMPLE:
3128     case OFPACT_CLEAR_ACTIONS:
3129     case OFPACT_WRITE_ACTIONS:
3130     case OFPACT_GOTO_TABLE:
3131     case OFPACT_METER:
3132     case OFPACT_GROUP:
3133     default:
3134         return false;
3135     }
3136 }
3137
3138 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
3139  * to 'port', false otherwise. */
3140 bool
3141 ofpacts_output_to_port(const struct ofpact *ofpacts, size_t ofpacts_len,
3142                        ofp_port_t port)
3143 {
3144     const struct ofpact *a;
3145
3146     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3147         if (ofpact_outputs_to_port(a, port)) {
3148             return true;
3149         }
3150     }
3151
3152     return false;
3153 }
3154
3155 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
3156  * to 'group', false otherwise. */
3157 bool
3158 ofpacts_output_to_group(const struct ofpact *ofpacts, size_t ofpacts_len,
3159                         uint32_t group_id)
3160 {
3161     const struct ofpact *a;
3162
3163     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3164         if (a->type == OFPACT_GROUP
3165             && ofpact_get_GROUP(a)->group_id == group_id) {
3166             return true;
3167         }
3168     }
3169
3170     return false;
3171 }
3172
3173 bool
3174 ofpacts_equal(const struct ofpact *a, size_t a_len,
3175               const struct ofpact *b, size_t b_len)
3176 {
3177     return a_len == b_len && !memcmp(a, b, a_len);
3178 }
3179
3180 /* Finds the OFPACT_METER action, if any, in the 'ofpacts_len' bytes of
3181  * 'ofpacts'.  If found, returns its meter ID; if not, returns 0.
3182  *
3183  * This function relies on the order of 'ofpacts' being correct (as checked by
3184  * ofpacts_verify()). */
3185 uint32_t
3186 ofpacts_get_meter(const struct ofpact ofpacts[], size_t ofpacts_len)
3187 {
3188     const struct ofpact *a;
3189
3190     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3191         enum ovs_instruction_type inst;
3192
3193         inst = ovs_instruction_type_from_ofpact_type(a->type);
3194         if (a->type == OFPACT_METER) {
3195             return ofpact_get_METER(a)->meter_id;
3196         } else if (inst > OVSINST_OFPIT13_METER) {
3197             break;
3198         }
3199     }
3200
3201     return 0;
3202 }
3203 \f
3204 /* Formatting ofpacts. */
3205
3206 static void
3207 print_note(const struct ofpact_note *note, struct ds *string)
3208 {
3209     size_t i;
3210
3211     ds_put_cstr(string, "note:");
3212     for (i = 0; i < note->length; i++) {
3213         if (i) {
3214             ds_put_char(string, '.');
3215         }
3216         ds_put_format(string, "%02"PRIx8, note->data[i]);
3217     }
3218 }
3219
3220 static void
3221 print_dec_ttl(const struct ofpact_cnt_ids *ids,
3222               struct ds *s)
3223 {
3224     size_t i;
3225
3226     ds_put_cstr(s, "dec_ttl");
3227     if (ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL_CNT_IDS) {
3228         ds_put_cstr(s, "(");
3229         for (i = 0; i < ids->n_controllers; i++) {
3230             if (i) {
3231                 ds_put_cstr(s, ",");
3232             }
3233             ds_put_format(s, "%"PRIu16, ids->cnt_ids[i]);
3234         }
3235         ds_put_cstr(s, ")");
3236     }
3237 }
3238
3239 static void
3240 print_fin_timeout(const struct ofpact_fin_timeout *fin_timeout,
3241                   struct ds *s)
3242 {
3243     ds_put_cstr(s, "fin_timeout(");
3244     if (fin_timeout->fin_idle_timeout) {
3245         ds_put_format(s, "idle_timeout=%"PRIu16",",
3246                       fin_timeout->fin_idle_timeout);
3247     }
3248     if (fin_timeout->fin_hard_timeout) {
3249         ds_put_format(s, "hard_timeout=%"PRIu16",",
3250                       fin_timeout->fin_hard_timeout);
3251     }
3252     ds_chomp(s, ',');
3253     ds_put_char(s, ')');
3254 }
3255
3256 static void
3257 ofpact_format(const struct ofpact *a, struct ds *s)
3258 {
3259     const struct ofpact_enqueue *enqueue;
3260     const struct ofpact_resubmit *resubmit;
3261     const struct ofpact_controller *controller;
3262     const struct ofpact_metadata *metadata;
3263     const struct ofpact_tunnel *tunnel;
3264     const struct ofpact_sample *sample;
3265     const struct ofpact_set_field *set_field;
3266     const struct mf_field *mf;
3267     ofp_port_t port;
3268
3269     switch (a->type) {
3270     case OFPACT_OUTPUT:
3271         port = ofpact_get_OUTPUT(a)->port;
3272         if (ofp_to_u16(port) < ofp_to_u16(OFPP_MAX)) {
3273             ds_put_format(s, "output:%"PRIu16, port);
3274         } else {
3275             ofputil_format_port(port, s);
3276             if (port == OFPP_CONTROLLER) {
3277                 ds_put_format(s, ":%"PRIu16, ofpact_get_OUTPUT(a)->max_len);
3278             }
3279         }
3280         break;
3281
3282     case OFPACT_CONTROLLER:
3283         controller = ofpact_get_CONTROLLER(a);
3284         if (controller->reason == OFPR_ACTION &&
3285             controller->controller_id == 0) {
3286             ds_put_format(s, "CONTROLLER:%"PRIu16,
3287                           ofpact_get_CONTROLLER(a)->max_len);
3288         } else {
3289             enum ofp_packet_in_reason reason = controller->reason;
3290
3291             ds_put_cstr(s, "controller(");
3292             if (reason != OFPR_ACTION) {
3293                 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
3294
3295                 ds_put_format(s, "reason=%s,",
3296                               ofputil_packet_in_reason_to_string(
3297                                   reason, reasonbuf, sizeof reasonbuf));
3298             }
3299             if (controller->max_len != UINT16_MAX) {
3300                 ds_put_format(s, "max_len=%"PRIu16",", controller->max_len);
3301             }
3302             if (controller->controller_id != 0) {
3303                 ds_put_format(s, "id=%"PRIu16",", controller->controller_id);
3304             }
3305             ds_chomp(s, ',');
3306             ds_put_char(s, ')');
3307         }
3308         break;
3309
3310     case OFPACT_ENQUEUE:
3311         enqueue = ofpact_get_ENQUEUE(a);
3312         ds_put_format(s, "enqueue:");
3313         ofputil_format_port(enqueue->port, s);
3314         ds_put_format(s, ":%"PRIu32, enqueue->queue);
3315         break;
3316
3317     case OFPACT_OUTPUT_REG:
3318         ds_put_cstr(s, "output:");
3319         mf_format_subfield(&ofpact_get_OUTPUT_REG(a)->src, s);
3320         break;
3321
3322     case OFPACT_BUNDLE:
3323         bundle_format(ofpact_get_BUNDLE(a), s);
3324         break;
3325
3326     case OFPACT_SET_VLAN_VID:
3327         ds_put_format(s, "%s:%"PRIu16,
3328                       (a->compat == OFPUTIL_OFPAT11_SET_VLAN_VID
3329                        ? "set_vlan_vid"
3330                        : "mod_vlan_vid"),
3331                       ofpact_get_SET_VLAN_VID(a)->vlan_vid);
3332         break;
3333
3334     case OFPACT_SET_VLAN_PCP:
3335         ds_put_format(s, "%s:%"PRIu8,
3336                       (a->compat == OFPUTIL_OFPAT11_SET_VLAN_PCP
3337                        ? "set_vlan_pcp"
3338                        : "mod_vlan_pcp"),
3339                       ofpact_get_SET_VLAN_PCP(a)->vlan_pcp);
3340         break;
3341
3342     case OFPACT_STRIP_VLAN:
3343         ds_put_cstr(s, a->compat == OFPUTIL_OFPAT11_POP_VLAN
3344                     ? "pop_vlan" : "strip_vlan");
3345         break;
3346
3347     case OFPACT_PUSH_VLAN:
3348         /* XXX 802.1AD case*/
3349         ds_put_format(s, "push_vlan:%#"PRIx16, ETH_TYPE_VLAN_8021Q);
3350         break;
3351
3352     case OFPACT_SET_ETH_SRC:
3353         ds_put_format(s, "mod_dl_src:"ETH_ADDR_FMT,
3354                       ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a)->mac));
3355         break;
3356
3357     case OFPACT_SET_ETH_DST:
3358         ds_put_format(s, "mod_dl_dst:"ETH_ADDR_FMT,
3359                       ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a)->mac));
3360         break;
3361
3362     case OFPACT_SET_IPV4_SRC:
3363         ds_put_format(s, "mod_nw_src:"IP_FMT,
3364                       IP_ARGS(ofpact_get_SET_IPV4_SRC(a)->ipv4));
3365         break;
3366
3367     case OFPACT_SET_IPV4_DST:
3368         ds_put_format(s, "mod_nw_dst:"IP_FMT,
3369                       IP_ARGS(ofpact_get_SET_IPV4_DST(a)->ipv4));
3370         break;
3371
3372     case OFPACT_SET_IP_DSCP:
3373         ds_put_format(s, "mod_nw_tos:%d", ofpact_get_SET_IP_DSCP(a)->dscp);
3374         break;
3375
3376     case OFPACT_SET_IP_ECN:
3377         ds_put_format(s, "mod_nw_ecn:%d", ofpact_get_SET_IP_ECN(a)->ecn);
3378         break;
3379
3380     case OFPACT_SET_IP_TTL:
3381         ds_put_format(s, "mod_nw_ttl:%d", ofpact_get_SET_IP_TTL(a)->ttl);
3382         break;
3383
3384     case OFPACT_SET_L4_SRC_PORT:
3385         ds_put_format(s, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a)->port);
3386         break;
3387
3388     case OFPACT_SET_L4_DST_PORT:
3389         ds_put_format(s, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a)->port);
3390         break;
3391
3392     case OFPACT_REG_MOVE:
3393         nxm_format_reg_move(ofpact_get_REG_MOVE(a), s);
3394         break;
3395
3396     case OFPACT_REG_LOAD:
3397         nxm_format_reg_load(ofpact_get_REG_LOAD(a), s);
3398         break;
3399
3400     case OFPACT_SET_FIELD:
3401         set_field = ofpact_get_SET_FIELD(a);
3402         mf = set_field->field;
3403         ds_put_format(s, "set_field:");
3404         mf_format(mf, &set_field->value, NULL, s);
3405         ds_put_format(s, "->%s", mf->name);
3406         break;
3407
3408     case OFPACT_STACK_PUSH:
3409         nxm_format_stack_push(ofpact_get_STACK_PUSH(a), s);
3410         break;
3411
3412     case OFPACT_STACK_POP:
3413         nxm_format_stack_pop(ofpact_get_STACK_POP(a), s);
3414         break;
3415
3416     case OFPACT_DEC_TTL:
3417         print_dec_ttl(ofpact_get_DEC_TTL(a), s);
3418         break;
3419
3420     case OFPACT_SET_MPLS_LABEL:
3421         ds_put_format(s, "set_mpls_label(%"PRIu32")",
3422                       ntohl(ofpact_get_SET_MPLS_LABEL(a)->label));
3423         break;
3424
3425     case OFPACT_SET_MPLS_TC:
3426         ds_put_format(s, "set_mpls_ttl(%"PRIu8")",
3427                       ofpact_get_SET_MPLS_TC(a)->tc);
3428         break;
3429
3430     case OFPACT_SET_MPLS_TTL:
3431         ds_put_format(s, "set_mpls_ttl(%"PRIu8")",
3432                       ofpact_get_SET_MPLS_TTL(a)->ttl);
3433         break;
3434
3435     case OFPACT_DEC_MPLS_TTL:
3436         ds_put_cstr(s, "dec_mpls_ttl");
3437         break;
3438
3439     case OFPACT_SET_TUNNEL:
3440         tunnel = ofpact_get_SET_TUNNEL(a);
3441         ds_put_format(s, "set_tunnel%s:%#"PRIx64,
3442                       (tunnel->tun_id > UINT32_MAX
3443                        || a->compat == OFPUTIL_NXAST_SET_TUNNEL64 ? "64" : ""),
3444                       tunnel->tun_id);
3445         break;
3446
3447     case OFPACT_SET_QUEUE:
3448         ds_put_format(s, "set_queue:%"PRIu32,
3449                       ofpact_get_SET_QUEUE(a)->queue_id);
3450         break;
3451
3452     case OFPACT_POP_QUEUE:
3453         ds_put_cstr(s, "pop_queue");
3454         break;
3455
3456     case OFPACT_FIN_TIMEOUT:
3457         print_fin_timeout(ofpact_get_FIN_TIMEOUT(a), s);
3458         break;
3459
3460     case OFPACT_RESUBMIT:
3461         resubmit = ofpact_get_RESUBMIT(a);
3462         if (resubmit->in_port != OFPP_IN_PORT && resubmit->table_id == 255) {
3463             ds_put_cstr(s, "resubmit:");
3464             ofputil_format_port(resubmit->in_port, s);
3465         } else {
3466             ds_put_format(s, "resubmit(");
3467             if (resubmit->in_port != OFPP_IN_PORT) {
3468                 ofputil_format_port(resubmit->in_port, s);
3469             }
3470             ds_put_char(s, ',');
3471             if (resubmit->table_id != 255) {
3472                 ds_put_format(s, "%"PRIu8, resubmit->table_id);
3473             }
3474             ds_put_char(s, ')');
3475         }
3476         break;
3477
3478     case OFPACT_LEARN:
3479         learn_format(ofpact_get_LEARN(a), s);
3480         break;
3481
3482     case OFPACT_MULTIPATH:
3483         multipath_format(ofpact_get_MULTIPATH(a), s);
3484         break;
3485
3486     case OFPACT_NOTE:
3487         print_note(ofpact_get_NOTE(a), s);
3488         break;
3489
3490     case OFPACT_PUSH_MPLS:
3491         ds_put_format(s, "push_mpls:0x%04"PRIx16,
3492                       ntohs(ofpact_get_PUSH_MPLS(a)->ethertype));
3493         break;
3494
3495     case OFPACT_POP_MPLS:
3496         ds_put_format(s, "pop_mpls:0x%04"PRIx16,
3497                       ntohs(ofpact_get_POP_MPLS(a)->ethertype));
3498         break;
3499
3500     case OFPACT_EXIT:
3501         ds_put_cstr(s, "exit");
3502         break;
3503
3504     case OFPACT_SAMPLE:
3505         sample = ofpact_get_SAMPLE(a);
3506         ds_put_format(
3507             s, "sample(probability=%"PRIu16",collector_set_id=%"PRIu32
3508             ",obs_domain_id=%"PRIu32",obs_point_id=%"PRIu32")",
3509             sample->probability, sample->collector_set_id,
3510             sample->obs_domain_id, sample->obs_point_id);
3511         break;
3512
3513     case OFPACT_WRITE_ACTIONS: {
3514         struct ofpact_nest *on = ofpact_get_WRITE_ACTIONS(a);
3515         ds_put_format(s, "%s(",
3516                       ovs_instruction_name_from_type(
3517                           OVSINST_OFPIT11_WRITE_ACTIONS));
3518         ofpacts_format(on->actions, ofpact_nest_get_action_len(on), s);
3519         ds_put_char(s, ')');
3520         break;
3521     }
3522
3523     case OFPACT_CLEAR_ACTIONS:
3524         ds_put_format(s, "%s",
3525                       ovs_instruction_name_from_type(
3526                           OVSINST_OFPIT11_CLEAR_ACTIONS));
3527         break;
3528
3529     case OFPACT_WRITE_METADATA:
3530         metadata = ofpact_get_WRITE_METADATA(a);
3531         ds_put_format(s, "%s:%#"PRIx64,
3532                       ovs_instruction_name_from_type(
3533                           OVSINST_OFPIT11_WRITE_METADATA),
3534                       ntohll(metadata->metadata));
3535         if (metadata->mask != OVS_BE64_MAX) {
3536             ds_put_format(s, "/%#"PRIx64, ntohll(metadata->mask));
3537         }
3538         break;
3539
3540     case OFPACT_GOTO_TABLE:
3541         ds_put_format(s, "%s:%"PRIu8,
3542                       ovs_instruction_name_from_type(
3543                           OVSINST_OFPIT11_GOTO_TABLE),
3544                       ofpact_get_GOTO_TABLE(a)->table_id);
3545         break;
3546
3547     case OFPACT_METER:
3548         ds_put_format(s, "%s:%"PRIu32,
3549                       ovs_instruction_name_from_type(OVSINST_OFPIT13_METER),
3550                       ofpact_get_METER(a)->meter_id);
3551         break;
3552
3553     case OFPACT_GROUP:
3554         ds_put_format(s, "group:%"PRIu32,
3555                       ofpact_get_GROUP(a)->group_id);
3556         break;
3557     }
3558 }
3559
3560 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
3561  * 'ofpacts' to 'string'. */
3562 void
3563 ofpacts_format(const struct ofpact *ofpacts, size_t ofpacts_len,
3564                struct ds *string)
3565 {
3566     if (!ofpacts_len) {
3567         ds_put_cstr(string, "drop");
3568     } else {
3569         const struct ofpact *a;
3570
3571         OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
3572             if (a != ofpacts) {
3573                 ds_put_cstr(string, ",");
3574             }
3575
3576             /* XXX write-actions */
3577             ofpact_format(a, string);
3578         }
3579     }
3580 }
3581 \f
3582 /* Internal use by helpers. */
3583
3584 void *
3585 ofpact_put(struct ofpbuf *ofpacts, enum ofpact_type type, size_t len)
3586 {
3587     struct ofpact *ofpact;
3588
3589     ofpact_pad(ofpacts);
3590     ofpact = ofpacts->l2 = ofpbuf_put_uninit(ofpacts, len);
3591     ofpact_init(ofpact, type, len);
3592     return ofpact;
3593 }
3594
3595 void
3596 ofpact_init(struct ofpact *ofpact, enum ofpact_type type, size_t len)
3597 {
3598     memset(ofpact, 0, len);
3599     ofpact->type = type;
3600     ofpact->compat = OFPUTIL_ACTION_INVALID;
3601     ofpact->len = len;
3602 }
3603 \f
3604 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
3605  * starting at 'ofpact'.
3606  *
3607  * This is the correct way to update a variable-length ofpact's length after
3608  * adding the variable-length part of the payload.  (See the large comment
3609  * near the end of ofp-actions.h for more information.) */
3610 void
3611 ofpact_update_len(struct ofpbuf *ofpacts, struct ofpact *ofpact)
3612 {
3613     ovs_assert(ofpact == ofpacts->l2);
3614     ofpact->len = (char *) ofpbuf_tail(ofpacts) - (char *) ofpact;
3615 }
3616
3617 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length.  Each
3618  * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
3619  * client must call this itself after adding the final ofpact to an array of
3620  * them.
3621  *
3622  * (The consequences of failing to call this function are probably not dire.
3623  * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
3624  * not dereference it.  That's undefined behavior, technically, but it will not
3625  * cause a real problem on common systems.  Still, it seems better to call
3626  * it.) */
3627 void
3628 ofpact_pad(struct ofpbuf *ofpacts)
3629 {
3630     unsigned int rem = ofpacts->size % OFPACT_ALIGNTO;
3631     if (rem) {
3632         ofpbuf_put_zeros(ofpacts, OFPACT_ALIGNTO - rem);
3633     }
3634 }