lib/ofp-actions.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 static enum ofperr
  39 output_from_openflow10(const struct ofp10_action_output *oao,
  40                        struct ofpbuf *out)
  41 {
  42     struct ofpact_output *output;
  43
  44     output = ofpact_put_OUTPUT(out);
  45     output->port = u16_to_ofp(ntohs(oao->port));
  46     output->max_len = ntohs(oao->max_len);
  47
  48     return ofputil_check_output_port(output->port, OFPP_MAX);
  49 }
  50
  51 static enum ofperr
  52 enqueue_from_openflow10(const struct ofp10_action_enqueue *oae,
  53                         struct ofpbuf *out)
  54 {
  55     struct ofpact_enqueue *enqueue;
  56
  57     enqueue = ofpact_put_ENQUEUE(out);
  58     enqueue->port = u16_to_ofp(ntohs(oae->port));
  59     enqueue->queue = ntohl(oae->queue_id);
  60     if (ofp_to_u16(enqueue->port) >= ofp_to_u16(OFPP_MAX)
  61         && enqueue->port != OFPP_IN_PORT
  62         && enqueue->port != OFPP_LOCAL) {
  63         return OFPERR_OFPBAC_BAD_OUT_PORT;
  64     }
  65     return 0;
  66 }
  67
  68 static void
  69 resubmit_from_openflow(const struct nx_action_resubmit *nar,
  70                        struct ofpbuf *out)
  71 {
  72     struct ofpact_resubmit *resubmit;
  73
  74     resubmit = ofpact_put_RESUBMIT(out);
  75     resubmit->ofpact.compat = OFPUTIL_NXAST_RESUBMIT;
  76     resubmit->in_port = u16_to_ofp(ntohs(nar->in_port));
  77     resubmit->table_id = 0xff;
  78 }
  79
  80 static enum ofperr
  81 resubmit_table_from_openflow(const struct nx_action_resubmit *nar,
  82                              struct ofpbuf *out)
  83 {
  84     struct ofpact_resubmit *resubmit;
  85
  86     if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
  87         return OFPERR_OFPBAC_BAD_ARGUMENT;
  88     }
  89
  90     resubmit = ofpact_put_RESUBMIT(out);
  91     resubmit->ofpact.compat = OFPUTIL_NXAST_RESUBMIT_TABLE;
  92     resubmit->in_port = u16_to_ofp(ntohs(nar->in_port));
  93     resubmit->table_id = nar->table;
  94     return 0;
  95 }
  96
  97 static enum ofperr
  98 output_reg_from_openflow(const struct nx_action_output_reg *naor,
  99                          struct ofpbuf *out)
 100 {
 101     struct ofpact_output_reg *output_reg;
 102
 103     if (!is_all_zeros(naor->zero, sizeof naor->zero)) {
 104         return OFPERR_OFPBAC_BAD_ARGUMENT;
 105     }
 106
 107     output_reg = ofpact_put_OUTPUT_REG(out);
 108     output_reg->src.field = mf_from_nxm_header(ntohl(naor->src));
 109     output_reg->src.ofs = nxm_decode_ofs(naor->ofs_nbits);
 110     output_reg->src.n_bits = nxm_decode_n_bits(naor->ofs_nbits);
 111     output_reg->max_len = ntohs(naor->max_len);
 112
 113     return mf_check_src(&output_reg->src, NULL);
 114 }
 115
 116 static void
 117 fin_timeout_from_openflow(const struct nx_action_fin_timeout *naft,
 118                           struct ofpbuf *out)
 119 {
 120     struct ofpact_fin_timeout *oft;
 121
 122     oft = ofpact_put_FIN_TIMEOUT(out);
 123     oft->fin_idle_timeout = ntohs(naft->fin_idle_timeout);
 124     oft->fin_hard_timeout = ntohs(naft->fin_hard_timeout);
 125 }
 126
 127 static void
 128 controller_from_openflow(const struct nx_action_controller *nac,
 129                          struct ofpbuf *out)
 130 {
 131     struct ofpact_controller *oc;
 132
 133     oc = ofpact_put_CONTROLLER(out);
 134     oc->max_len = ntohs(nac->max_len);
 135     oc->controller_id = ntohs(nac->controller_id);
 136     oc->reason = nac->reason;
 137 }
 138
 139 static enum ofperr
 140 metadata_from_nxast(const struct nx_action_write_metadata *nawm,
 141                     struct ofpbuf *out)
 142 {
 143     struct ofpact_metadata *om;
 144
 145     if (!is_all_zeros(nawm->zeros, sizeof nawm->zeros)) {
 146         return OFPERR_NXBRC_MUST_BE_ZERO;
 147     }
 148
 149     om = ofpact_put_WRITE_METADATA(out);
 150     om->metadata = nawm->metadata;
 151     om->mask = nawm->mask;
 152
 153     return 0;
 154 }
 155
 156 static void
 157 note_from_openflow(const struct nx_action_note *nan, struct ofpbuf *out)
 158 {
 159     struct ofpact_note *note;
 160     unsigned int length;
 161
 162     length = ntohs(nan->len) - offsetof(struct nx_action_note, note);
 163     note = ofpact_put(out, OFPACT_NOTE,
 164                       offsetof(struct ofpact_note, data) + length);
 165     note->length = length;
 166     memcpy(note->data, nan->note, length);
 167 }
 168
 169 static enum ofperr
 170 dec_ttl_from_openflow(struct ofpbuf *out, enum ofputil_action_code compat)
 171 {
 172     uint16_t id = 0;
 173     struct ofpact_cnt_ids *ids;
 174     enum ofperr error = 0;
 175
 176     ids = ofpact_put_DEC_TTL(out);
 177     ids->ofpact.compat = compat;
 178     ids->n_controllers = 1;
 179     ofpbuf_put(out, &id, sizeof id);
 180     ids = out->l2;
 181     ofpact_update_len(out, &ids->ofpact);
 182     return error;
 183 }
 184
 185 static enum ofperr
 186 dec_ttl_cnt_ids_from_openflow(const struct nx_action_cnt_ids *nac_ids,
 187                       struct ofpbuf *out)
 188 {
 189     struct ofpact_cnt_ids *ids;
 190     size_t ids_size;
 191     int i;
 192
 193     ids = ofpact_put_DEC_TTL(out);
 194     ids->ofpact.compat = OFPUTIL_NXAST_DEC_TTL_CNT_IDS;
 195     ids->n_controllers = ntohs(nac_ids->n_controllers);
 196     ids_size = ntohs(nac_ids->len) - sizeof *nac_ids;
 197
 198     if (!is_all_zeros(nac_ids->zeros, sizeof nac_ids->zeros)) {
 199         return OFPERR_NXBRC_MUST_BE_ZERO;
 200     }
 201
 202     if (ids_size < ids->n_controllers * sizeof(ovs_be16)) {
 203         VLOG_WARN_RL(&rl, "Nicira action dec_ttl_cnt_ids only has %zu bytes "
 204                      "allocated for controller ids.  %zu bytes are required for "
 205                      "%"PRIu16" controllers.", ids_size,
 206                      ids->n_controllers * sizeof(ovs_be16), ids->n_controllers);
 207         return OFPERR_OFPBAC_BAD_LEN;
 208     }
 209
 210     for (i = 0; i < ids->n_controllers; i++) {
 211         uint16_t id = ntohs(((ovs_be16 *)(nac_ids + 1))[i]);
 212         ofpbuf_put(out, &id, sizeof id);
 213         ids = out->l2;
 214     }
 215
 216     ofpact_update_len(out, &ids->ofpact);
 217
 218     return 0;
 219 }
 220
 221 static enum ofperr
 222 sample_from_openflow(const struct nx_action_sample *nas,
 223                      struct ofpbuf *out)
 224 {
 225     struct ofpact_sample *sample;
 226
 227     sample = ofpact_put_SAMPLE(out);
 228     sample->probability = ntohs(nas->probability);
 229     sample->collector_set_id = ntohl(nas->collector_set_id);
 230     sample->obs_domain_id = ntohl(nas->obs_domain_id);
 231     sample->obs_point_id = ntohl(nas->obs_point_id);
 232
 233     if (sample->probability == 0) {
 234         return OFPERR_OFPBAC_BAD_ARGUMENT;
 235     }
 236
 237     return 0;
 238 }
 239
 240 static enum ofperr
 241 decode_nxast_action(const union ofp_action *a, enum ofputil_action_code *code)
 242 {
 243     const struct nx_action_header *nah = (const struct nx_action_header *) a;
 244     uint16_t len = ntohs(a->header.len);
 245
 246     if (len < sizeof(struct nx_action_header)) {
 247         return OFPERR_OFPBAC_BAD_LEN;
 248     } else if (a->vendor.vendor != CONSTANT_HTONL(NX_VENDOR_ID)) {
 249         return OFPERR_OFPBAC_BAD_VENDOR;
 250     }
 251
 252     switch (nah->subtype) {
 253 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 254         case CONSTANT_HTONS(ENUM):                      \
 255             if (EXTENSIBLE                              \
 256                 ? len >= sizeof(struct STRUCT)          \
 257                 : len == sizeof(struct STRUCT)) {       \
 258                 *code = OFPUTIL_##ENUM;                 \
 259                 return 0;                               \
 260             } else {                                    \
 261                 return OFPERR_OFPBAC_BAD_LEN;           \
 262             }                                           \
 263             NOT_REACHED();
 264 #include "ofp-util.def"
 265
 266     case CONSTANT_HTONS(NXAST_SNAT__OBSOLETE):
 267     case CONSTANT_HTONS(NXAST_DROP_SPOOFED_ARP__OBSOLETE):
 268     default:
 269         return OFPERR_OFPBAC_BAD_TYPE;
 270     }
 271 }
 272
 273 /* Parses 'a' to determine its type.  On success stores the correct type into
 274  * '*code' and returns 0.  On failure returns an OFPERR_* error code and
 275  * '*code' is indeterminate.
 276  *
 277  * The caller must have already verified that 'a''s length is potentially
 278  * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
 279  * ofp_action) and no longer than the amount of space allocated to 'a').
 280  *
 281  * This function verifies that 'a''s length is correct for the type of action
 282  * that it represents. */
 283 static enum ofperr
 284 decode_openflow10_action(const union ofp_action *a,
 285                          enum ofputil_action_code *code)
 286 {
 287     switch (a->type) {
 288     case CONSTANT_HTONS(OFPAT10_VENDOR):
 289         return decode_nxast_action(a, code);
 290
 291 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)                          \
 292         case CONSTANT_HTONS(ENUM):                                  \
 293             if (a->header.len == htons(sizeof(struct STRUCT))) {    \
 294                 *code = OFPUTIL_##ENUM;                             \
 295                 return 0;                                           \
 296             } else {                                                \
 297                 return OFPERR_OFPBAC_BAD_LEN;                       \
 298             }                                                       \
 299             break;
 300 #include "ofp-util.def"
 301
 302     default:
 303         return OFPERR_OFPBAC_BAD_TYPE;
 304     }
 305 }
 306
 307 static enum ofperr
 308 ofpact_from_nxast(const union ofp_action *a, enum ofputil_action_code code,
 309                   struct ofpbuf *out)
 310 {
 311     const struct nx_action_resubmit *nar;
 312     const struct nx_action_set_tunnel *nast;
 313     const struct nx_action_set_queue *nasq;
 314     const struct nx_action_note *nan;
 315     const struct nx_action_set_tunnel64 *nast64;
 316     const struct nx_action_write_metadata *nawm;
 317     struct ofpact_tunnel *tunnel;
 318     enum ofperr error = 0;
 319
 320     switch (code) {
 321     case OFPUTIL_ACTION_INVALID:
 322 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
 323 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 324 #include "ofp-util.def"
 325         NOT_REACHED();
 326
 327     case OFPUTIL_NXAST_RESUBMIT:
 328         resubmit_from_openflow((const struct nx_action_resubmit *) a, out);
 329         break;
 330
 331     case OFPUTIL_NXAST_SET_TUNNEL:
 332         nast = (const struct nx_action_set_tunnel *) a;
 333         tunnel = ofpact_put_SET_TUNNEL(out);
 334         tunnel->ofpact.compat = code;
 335         tunnel->tun_id = ntohl(nast->tun_id);
 336         break;
 337
 338     case OFPUTIL_NXAST_WRITE_METADATA:
 339         nawm = (const struct nx_action_write_metadata *) a;
 340         error = metadata_from_nxast(nawm, out);
 341         break;
 342
 343     case OFPUTIL_NXAST_SET_QUEUE:
 344         nasq = (const struct nx_action_set_queue *) a;
 345         ofpact_put_SET_QUEUE(out)->queue_id = ntohl(nasq->queue_id);
 346         break;
 347
 348     case OFPUTIL_NXAST_POP_QUEUE:
 349         ofpact_put_POP_QUEUE(out);
 350         break;
 351
 352     case OFPUTIL_NXAST_REG_MOVE:
 353         error = nxm_reg_move_from_openflow(
 354             (const struct nx_action_reg_move *) a, out);
 355         break;
 356
 357     case OFPUTIL_NXAST_REG_LOAD:
 358         error = nxm_reg_load_from_openflow(
 359             (const struct nx_action_reg_load *) a, out);
 360         break;
 361
 362     case OFPUTIL_NXAST_STACK_PUSH:
 363         error = nxm_stack_push_from_openflow(
 364             (const struct nx_action_stack *) a, out);
 365         break;
 366
 367     case OFPUTIL_NXAST_STACK_POP:
 368         error = nxm_stack_pop_from_openflow(
 369             (const struct nx_action_stack *) a, out);
 370         break;
 371
 372     case OFPUTIL_NXAST_NOTE:
 373         nan = (const struct nx_action_note *) a;
 374         note_from_openflow(nan, out);
 375         break;
 376
 377     case OFPUTIL_NXAST_SET_TUNNEL64:
 378         nast64 = (const struct nx_action_set_tunnel64 *) a;
 379         tunnel = ofpact_put_SET_TUNNEL(out);
 380         tunnel->ofpact.compat = code;
 381         tunnel->tun_id = ntohll(nast64->tun_id);
 382         break;
 383
 384     case OFPUTIL_NXAST_MULTIPATH:
 385         error = multipath_from_openflow((const struct nx_action_multipath *) a,
 386                                         ofpact_put_MULTIPATH(out));
 387         break;
 388
 389     case OFPUTIL_NXAST_BUNDLE:
 390     case OFPUTIL_NXAST_BUNDLE_LOAD:
 391         error = bundle_from_openflow((const struct nx_action_bundle *) a, out);
 392         break;
 393
 394     case OFPUTIL_NXAST_OUTPUT_REG:
 395         error = output_reg_from_openflow(
 396             (const struct nx_action_output_reg *) a, out);
 397         break;
 398
 399     case OFPUTIL_NXAST_RESUBMIT_TABLE:
 400         nar = (const struct nx_action_resubmit *) a;
 401         error = resubmit_table_from_openflow(nar, out);
 402         break;
 403
 404     case OFPUTIL_NXAST_LEARN:
 405         error = learn_from_openflow((const struct nx_action_learn *) a, out);
 406         break;
 407
 408     case OFPUTIL_NXAST_EXIT:
 409         ofpact_put_EXIT(out);
 410         break;
 411
 412     case OFPUTIL_NXAST_DEC_TTL:
 413         error = dec_ttl_from_openflow(out, code);
 414         break;
 415
 416     case OFPUTIL_NXAST_DEC_TTL_CNT_IDS:
 417         error = dec_ttl_cnt_ids_from_openflow(
 418                     (const struct nx_action_cnt_ids *) a, out);
 419         break;
 420
 421     case OFPUTIL_NXAST_FIN_TIMEOUT:
 422         fin_timeout_from_openflow(
 423             (const struct nx_action_fin_timeout *) a, out);
 424         break;
 425
 426     case OFPUTIL_NXAST_CONTROLLER:
 427         controller_from_openflow((const struct nx_action_controller *) a, out);
 428         break;
 429
 430     case OFPUTIL_NXAST_PUSH_MPLS: {
 431         struct nx_action_push_mpls *nxapm = (struct nx_action_push_mpls *)a;
 432         if (!eth_type_mpls(nxapm->ethertype)) {
 433             return OFPERR_OFPBAC_BAD_ARGUMENT;
 434         }
 435         ofpact_put_PUSH_MPLS(out)->ethertype = nxapm->ethertype;
 436         break;
 437     }
 438
 439     case OFPUTIL_NXAST_SET_MPLS_TTL: {
 440         struct nx_action_mpls_ttl *nxamt = (struct nx_action_mpls_ttl *)a;
 441         ofpact_put_SET_MPLS_TTL(out)->ttl = nxamt->ttl;
 442         break;
 443     }
 444
 445     case OFPUTIL_NXAST_DEC_MPLS_TTL:
 446         ofpact_put_DEC_MPLS_TTL(out);
 447         break;
 448
 449     case OFPUTIL_NXAST_POP_MPLS: {
 450         struct nx_action_pop_mpls *nxapm = (struct nx_action_pop_mpls *)a;
 451         if (eth_type_mpls(nxapm->ethertype)) {
 452             return OFPERR_OFPBAC_BAD_ARGUMENT;
 453         }
 454         ofpact_put_POP_MPLS(out)->ethertype = nxapm->ethertype;
 455         break;
 456     }
 457
 458     case OFPUTIL_NXAST_SAMPLE:
 459         error = sample_from_openflow(
 460             (const struct nx_action_sample *) a, out);
 461         break;
 462     }
 463
 464     return error;
 465 }
 466
 467 static enum ofperr
 468 ofpact_from_openflow10(const union ofp_action *a, struct ofpbuf *out)
 469 {
 470     enum ofputil_action_code code;
 471     enum ofperr error;
 472
 473     error = decode_openflow10_action(a, &code);
 474     if (error) {
 475         return error;
 476     }
 477
 478     switch (code) {
 479     case OFPUTIL_ACTION_INVALID:
 480 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 481 #include "ofp-util.def"
 482         NOT_REACHED();
 483
 484     case OFPUTIL_OFPAT10_OUTPUT:
 485         return output_from_openflow10(&a->output10, out);
 486
 487     case OFPUTIL_OFPAT10_SET_VLAN_VID:
 488         if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
 489             return OFPERR_OFPBAC_BAD_ARGUMENT;
 490         }
 491         ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
 492         break;
 493
 494     case OFPUTIL_OFPAT10_SET_VLAN_PCP:
 495         if (a->vlan_pcp.vlan_pcp & ~7) {
 496             return OFPERR_OFPBAC_BAD_ARGUMENT;
 497         }
 498         ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
 499         break;
 500
 501     case OFPUTIL_OFPAT10_STRIP_VLAN:
 502         ofpact_put_STRIP_VLAN(out);
 503         break;
 504
 505     case OFPUTIL_OFPAT10_SET_DL_SRC:
 506         memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
 507                ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
 508         break;
 509
 510     case OFPUTIL_OFPAT10_SET_DL_DST:
 511         memcpy(ofpact_put_SET_ETH_DST(out)->mac,
 512                ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
 513         break;
 514
 515     case OFPUTIL_OFPAT10_SET_NW_SRC:
 516         ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
 517         break;
 518
 519     case OFPUTIL_OFPAT10_SET_NW_DST:
 520         ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
 521         break;
 522
 523     case OFPUTIL_OFPAT10_SET_NW_TOS:
 524         if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
 525             return OFPERR_OFPBAC_BAD_ARGUMENT;
 526         }
 527         ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
 528         break;
 529
 530     case OFPUTIL_OFPAT10_SET_TP_SRC:
 531         ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
 532         break;
 533
 534     case OFPUTIL_OFPAT10_SET_TP_DST:
 535         ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
 536
 537         break;
 538
 539     case OFPUTIL_OFPAT10_ENQUEUE:
 540         error = enqueue_from_openflow10((const struct ofp10_action_enqueue *) a,
 541                                         out);
 542         break;
 543
 544 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 545 #include "ofp-util.def"
 546         return ofpact_from_nxast(a, code, out);
 547     }
 548
 549     return error;
 550 }
 551
 552 static inline union ofp_action *
 553 action_next(const union ofp_action *a)
 554 {
 555     return ((union ofp_action *) (void *)
 556             ((uint8_t *) a + ntohs(a->header.len)));
 557 }
 558
 559 static inline bool
 560 action_is_valid(const union ofp_action *a, size_t n_actions)
 561 {
 562     uint16_t len = ntohs(a->header.len);
 563     return (!(len % OFP_ACTION_ALIGN)
 564             && len >= sizeof *a
 565             && len / sizeof *a <= n_actions);
 566 }
 567
 568 /* This macro is careful to check for actions with bad lengths. */
 569 #define ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS)                 \
 570     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 571          (LEFT) > 0 && action_is_valid(ITER, LEFT);                     \
 572          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 573           (ITER) = action_next(ITER)))
 574
 575 static void
 576 log_bad_action(const union ofp_action *actions, size_t n_actions, size_t ofs,
 577                enum ofperr error)
 578 {
 579     if (!VLOG_DROP_WARN(&rl)) {
 580         struct ds s;
 581
 582         ds_init(&s);
 583         ds_put_hex_dump(&s, actions, n_actions * sizeof *actions, 0, false);
 584         VLOG_WARN("bad action at offset %#zx (%s):\n%s",
 585                   ofs * sizeof *actions, ofperr_get_name(error), ds_cstr(&s));
 586         ds_destroy(&s);
 587     }
 588 }
 589
 590 static enum ofperr
 591 ofpacts_from_openflow(const union ofp_action *in, size_t n_in,
 592                       struct ofpbuf *out,
 593                       enum ofperr (*ofpact_from_openflow)(
 594                           const union ofp_action *a, struct ofpbuf *out))
 595 {
 596     const union ofp_action *a;
 597     size_t left;
 598
 599     ACTION_FOR_EACH (a, left, in, n_in) {
 600         enum ofperr error = ofpact_from_openflow(a, out);
 601         if (error) {
 602             log_bad_action(in, n_in, a - in, error);
 603             return error;
 604         }
 605     }
 606     if (left) {
 607         enum ofperr error = OFPERR_OFPBAC_BAD_LEN;
 608         log_bad_action(in, n_in, n_in - left, error);
 609         return error;
 610     }
 611
 612     ofpact_pad(out);
 613     return 0;
 614 }
 615
 616 static enum ofperr
 617 ofpacts_from_openflow10(const union ofp_action *in, size_t n_in,
 618                         struct ofpbuf *out)
 619 {
 620     return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow10);
 621 }
 622
 623 static enum ofperr
 624 ofpacts_pull_actions(struct ofpbuf *openflow, unsigned int actions_len,
 625                      struct ofpbuf *ofpacts,
 626                      enum ofperr (*translate)(const union ofp_action *actions,
 627                                               size_t n_actions,
 628                                               struct ofpbuf *ofpacts))
 629 {
 630     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 631     const union ofp_action *actions;
 632     enum ofperr error;
 633
 634     ofpbuf_clear(ofpacts);
 635
 636     if (actions_len % OFP_ACTION_ALIGN != 0) {
 637         VLOG_WARN_RL(&rl, "OpenFlow message actions length %u is not a "
 638                      "multiple of %d", actions_len, OFP_ACTION_ALIGN);
 639         return OFPERR_OFPBRC_BAD_LEN;
 640     }
 641
 642     actions = ofpbuf_try_pull(openflow, actions_len);
 643     if (actions == NULL) {
 644         VLOG_WARN_RL(&rl, "OpenFlow message actions length %u exceeds "
 645                      "remaining message length (%zu)",
 646                      actions_len, openflow->size);
 647         return OFPERR_OFPBRC_BAD_LEN;
 648     }
 649
 650     error = translate(actions, actions_len / OFP_ACTION_ALIGN, ofpacts);
 651     if (error) {
 652         ofpbuf_clear(ofpacts);
 653         return error;
 654     }
 655
 656     error = ofpacts_verify(ofpacts->data, ofpacts->size);
 657     if (error) {
 658         ofpbuf_clear(ofpacts);
 659     }
 660     return error;
 661 }
 662
 663 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.0 actions from the
 664  * front of 'openflow' into ofpacts.  On success, replaces any existing content
 665  * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
 666  * Returns 0 if successful, otherwise an OpenFlow error.
 667  *
 668  * The parsed actions are valid generically, but they may not be valid in a
 669  * specific context.  For example, port numbers up to OFPP_MAX are valid
 670  * generically, but specific datapaths may only support port numbers in a
 671  * smaller range.  Use ofpacts_check() to additional check whether actions are
 672  * valid in a specific context. */
 673 enum ofperr
 674 ofpacts_pull_openflow10(struct ofpbuf *openflow, unsigned int actions_len,
 675                         struct ofpbuf *ofpacts)
 676 {
 677     return ofpacts_pull_actions(openflow, actions_len, ofpacts,
 678                                 ofpacts_from_openflow10);
 679 }
 680 \f
 681 /* OpenFlow 1.1 actions. */
 682
 683 /* Parses 'a' to determine its type.  On success stores the correct type into
 684  * '*code' and returns 0.  On failure returns an OFPERR_* error code and
 685  * '*code' is indeterminate.
 686  *
 687  * The caller must have already verified that 'a''s length is potentially
 688  * correct (that is, a->header.len is nonzero and a multiple of sizeof(union
 689  * ofp_action) and no longer than the amount of space allocated to 'a').
 690  *
 691  * This function verifies that 'a''s length is correct for the type of action
 692  * that it represents. */
 693 static enum ofperr
 694 decode_openflow11_action(const union ofp_action *a,
 695                          enum ofputil_action_code *code)
 696 {
 697     uint16_t len;
 698
 699     switch (a->type) {
 700     case CONSTANT_HTONS(OFPAT11_EXPERIMENTER):
 701         return decode_nxast_action(a, code);
 702
 703 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)  \
 704         case CONSTANT_HTONS(ENUM):                      \
 705             len = ntohs(a->header.len);                 \
 706             if (EXTENSIBLE                              \
 707                 ? len >= sizeof(struct STRUCT)          \
 708                 : len == sizeof(struct STRUCT)) {       \
 709                 *code = OFPUTIL_##ENUM;                 \
 710                 return 0;                               \
 711             } else {                                    \
 712                 return OFPERR_OFPBAC_BAD_LEN;           \
 713             }                                           \
 714             NOT_REACHED();
 715 #include "ofp-util.def"
 716
 717     default:
 718         return OFPERR_OFPBAC_BAD_TYPE;
 719     }
 720 }
 721
 722 static enum ofperr
 723 output_from_openflow11(const struct ofp11_action_output *oao,
 724                        struct ofpbuf *out)
 725 {
 726     struct ofpact_output *output;
 727     enum ofperr error;
 728
 729     output = ofpact_put_OUTPUT(out);
 730     output->max_len = ntohs(oao->max_len);
 731
 732     error = ofputil_port_from_ofp11(oao->port, &output->port);
 733     if (error) {
 734         return error;
 735     }
 736
 737     return ofputil_check_output_port(output->port, OFPP_MAX);
 738 }
 739
 740 static enum ofperr
 741 ofpact_from_openflow11(const union ofp_action *a, struct ofpbuf *out)
 742 {
 743     enum ofputil_action_code code;
 744     enum ofperr error;
 745
 746     error = decode_openflow11_action(a, &code);
 747     if (error) {
 748         return error;
 749     }
 750
 751     switch (code) {
 752     case OFPUTIL_ACTION_INVALID:
 753 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) case OFPUTIL_##ENUM:
 754 #include "ofp-util.def"
 755         NOT_REACHED();
 756
 757     case OFPUTIL_OFPAT11_OUTPUT:
 758         return output_from_openflow11((const struct ofp11_action_output *) a,
 759                                       out);
 760
 761     case OFPUTIL_OFPAT11_SET_VLAN_VID:
 762         if (a->vlan_vid.vlan_vid & ~htons(0xfff)) {
 763             return OFPERR_OFPBAC_BAD_ARGUMENT;
 764         }
 765         ofpact_put_SET_VLAN_VID(out)->vlan_vid = ntohs(a->vlan_vid.vlan_vid);
 766         break;
 767
 768     case OFPUTIL_OFPAT11_SET_VLAN_PCP:
 769         if (a->vlan_pcp.vlan_pcp & ~7) {
 770             return OFPERR_OFPBAC_BAD_ARGUMENT;
 771         }
 772         ofpact_put_SET_VLAN_PCP(out)->vlan_pcp = a->vlan_pcp.vlan_pcp;
 773         break;
 774
 775     case OFPUTIL_OFPAT11_PUSH_VLAN:
 776         if (((const struct ofp11_action_push *)a)->ethertype !=
 777             htons(ETH_TYPE_VLAN_8021Q)) {
 778             /* XXX 802.1AD(QinQ) isn't supported at the moment */
 779             return OFPERR_OFPBAC_BAD_ARGUMENT;
 780         }
 781         ofpact_put_PUSH_VLAN(out);
 782         break;
 783
 784     case OFPUTIL_OFPAT11_POP_VLAN:
 785         ofpact_put_STRIP_VLAN(out);
 786         break;
 787
 788     case OFPUTIL_OFPAT11_SET_QUEUE:
 789         ofpact_put_SET_QUEUE(out)->queue_id =
 790             ntohl(((const struct ofp11_action_set_queue *)a)->queue_id);
 791         break;
 792
 793     case OFPUTIL_OFPAT11_SET_DL_SRC:
 794         memcpy(ofpact_put_SET_ETH_SRC(out)->mac,
 795                ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
 796         break;
 797
 798     case OFPUTIL_OFPAT11_SET_DL_DST:
 799         memcpy(ofpact_put_SET_ETH_DST(out)->mac,
 800                ((const struct ofp_action_dl_addr *) a)->dl_addr, ETH_ADDR_LEN);
 801         break;
 802
 803     case OFPUTIL_OFPAT11_DEC_NW_TTL:
 804         dec_ttl_from_openflow(out, code);
 805         break;
 806
 807     case OFPUTIL_OFPAT11_SET_NW_SRC:
 808         ofpact_put_SET_IPV4_SRC(out)->ipv4 = a->nw_addr.nw_addr;
 809         break;
 810
 811     case OFPUTIL_OFPAT11_SET_NW_DST:
 812         ofpact_put_SET_IPV4_DST(out)->ipv4 = a->nw_addr.nw_addr;
 813         break;
 814
 815     case OFPUTIL_OFPAT11_SET_NW_TOS:
 816         if (a->nw_tos.nw_tos & ~IP_DSCP_MASK) {
 817             return OFPERR_OFPBAC_BAD_ARGUMENT;
 818         }
 819         ofpact_put_SET_IPV4_DSCP(out)->dscp = a->nw_tos.nw_tos;
 820         break;
 821
 822     case OFPUTIL_OFPAT11_SET_TP_SRC:
 823         ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(a->tp_port.tp_port);
 824         break;
 825
 826     case OFPUTIL_OFPAT11_SET_TP_DST:
 827         ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(a->tp_port.tp_port);
 828         break;
 829
 830     case OFPUTIL_OFPAT12_SET_FIELD:
 831         return nxm_reg_load_from_openflow12_set_field(
 832             (const struct ofp12_action_set_field *)a, out);
 833
 834     case OFPUTIL_OFPAT11_SET_MPLS_TTL: {
 835         struct ofp11_action_mpls_ttl *oamt = (struct ofp11_action_mpls_ttl *)a;
 836         ofpact_put_SET_MPLS_TTL(out)->ttl = oamt->mpls_ttl;
 837         break;
 838     }
 839
 840     case OFPUTIL_OFPAT11_DEC_MPLS_TTL:
 841         ofpact_put_DEC_MPLS_TTL(out);
 842         break;
 843
 844     case OFPUTIL_OFPAT11_PUSH_MPLS: {
 845         struct ofp11_action_push *oap = (struct ofp11_action_push *)a;
 846         if (!eth_type_mpls(oap->ethertype)) {
 847             return OFPERR_OFPBAC_BAD_ARGUMENT;
 848         }
 849         ofpact_put_PUSH_MPLS(out)->ethertype = oap->ethertype;
 850         break;
 851     }
 852
 853     case OFPUTIL_OFPAT11_POP_MPLS: {
 854         struct ofp11_action_pop_mpls *oapm = (struct ofp11_action_pop_mpls *)a;
 855         if (eth_type_mpls(oapm->ethertype)) {
 856             return OFPERR_OFPBAC_BAD_ARGUMENT;
 857         }
 858         ofpact_put_POP_MPLS(out)->ethertype = oapm->ethertype;
 859         break;
 860     }
 861
 862 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) case OFPUTIL_##ENUM:
 863 #include "ofp-util.def"
 864         return ofpact_from_nxast(a, code, out);
 865     }
 866
 867     return error;
 868 }
 869
 870 static enum ofperr
 871 ofpacts_from_openflow11(const union ofp_action *in, size_t n_in,
 872                         struct ofpbuf *out)
 873 {
 874     return ofpacts_from_openflow(in, n_in, out, ofpact_from_openflow11);
 875 }
 876 \f
 877 /* OpenFlow 1.1 instructions. */
 878
 879 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)             \
 880     static inline const struct STRUCT *                         \
 881     instruction_get_##ENUM(const struct ofp11_instruction *inst)\
 882     {                                                           \
 883         ovs_assert(inst->type == htons(ENUM));                  \
 884         return (struct STRUCT *)inst;                           \
 885     }                                                           \
 886                                                                 \
 887     static inline void                                          \
 888     instruction_init_##ENUM(struct STRUCT *s)                   \
 889     {                                                           \
 890         memset(s, 0, sizeof *s);                                \
 891         s->type = htons(ENUM);                                  \
 892         s->len = htons(sizeof *s);                              \
 893     }                                                           \
 894                                                                 \
 895     static inline struct STRUCT *                               \
 896     instruction_put_##ENUM(struct ofpbuf *buf)                  \
 897     {                                                           \
 898         struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s);   \
 899         instruction_init_##ENUM(s);                             \
 900         return s;                                               \
 901     }
 902 OVS_INSTRUCTIONS
 903 #undef DEFINE_INST
 904
 905 struct instruction_type_info {
 906     enum ovs_instruction_type type;
 907     const char *name;
 908 };
 909
 910 static const struct instruction_type_info inst_info[] = {
 911 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)    {OVSINST_##ENUM, NAME},
 912 OVS_INSTRUCTIONS
 913 #undef DEFINE_INST
 914 };
 915
 916 const char *
 917 ovs_instruction_name_from_type(enum ovs_instruction_type type)
 918 {
 919     return inst_info[type].name;
 920 }
 921
 922 int
 923 ovs_instruction_type_from_name(const char *name)
 924 {
 925     const struct instruction_type_info *p;
 926     for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
 927         if (!strcasecmp(name, p->name)) {
 928             return p->type;
 929         }
 930     }
 931     return -1;
 932 }
 933
 934 enum ovs_instruction_type
 935 ovs_instruction_type_from_ofpact_type(enum ofpact_type type)
 936 {
 937     switch (type) {
 938     case OFPACT_METER:
 939         return OVSINST_OFPIT13_METER;
 940     case OFPACT_CLEAR_ACTIONS:
 941         return OVSINST_OFPIT11_CLEAR_ACTIONS;
 942     case OFPACT_WRITE_METADATA:
 943         return OVSINST_OFPIT11_WRITE_METADATA;
 944     case OFPACT_GOTO_TABLE:
 945         return OVSINST_OFPIT11_GOTO_TABLE;
 946     case OFPACT_OUTPUT:
 947     case OFPACT_CONTROLLER:
 948     case OFPACT_ENQUEUE:
 949     case OFPACT_OUTPUT_REG:
 950     case OFPACT_BUNDLE:
 951     case OFPACT_SET_VLAN_VID:
 952     case OFPACT_SET_VLAN_PCP:
 953     case OFPACT_STRIP_VLAN:
 954     case OFPACT_PUSH_VLAN:
 955     case OFPACT_SET_ETH_SRC:
 956     case OFPACT_SET_ETH_DST:
 957     case OFPACT_SET_IPV4_SRC:
 958     case OFPACT_SET_IPV4_DST:
 959     case OFPACT_SET_IPV4_DSCP:
 960     case OFPACT_SET_L4_SRC_PORT:
 961     case OFPACT_SET_L4_DST_PORT:
 962     case OFPACT_REG_MOVE:
 963     case OFPACT_REG_LOAD:
 964     case OFPACT_STACK_PUSH:
 965     case OFPACT_STACK_POP:
 966     case OFPACT_DEC_TTL:
 967     case OFPACT_SET_MPLS_TTL:
 968     case OFPACT_DEC_MPLS_TTL:
 969     case OFPACT_PUSH_MPLS:
 970     case OFPACT_POP_MPLS:
 971     case OFPACT_SET_TUNNEL:
 972     case OFPACT_SET_QUEUE:
 973     case OFPACT_POP_QUEUE:
 974     case OFPACT_FIN_TIMEOUT:
 975     case OFPACT_RESUBMIT:
 976     case OFPACT_LEARN:
 977     case OFPACT_MULTIPATH:
 978     case OFPACT_NOTE:
 979     case OFPACT_EXIT:
 980     case OFPACT_SAMPLE:
 981     default:
 982         return OVSINST_OFPIT11_APPLY_ACTIONS;
 983     }
 984 }
 985
 986 static inline struct ofp11_instruction *
 987 instruction_next(const struct ofp11_instruction *inst)
 988 {
 989     return ((struct ofp11_instruction *) (void *)
 990             ((uint8_t *) inst + ntohs(inst->len)));
 991 }
 992
 993 static inline bool
 994 instruction_is_valid(const struct ofp11_instruction *inst,
 995                      size_t n_instructions)
 996 {
 997     uint16_t len = ntohs(inst->len);
 998     return (!(len % OFP11_INSTRUCTION_ALIGN)
 999             && len >= sizeof *inst
1000             && len / sizeof *inst <= n_instructions);
1001 }
1002
1003 /* This macro is careful to check for instructions with bad lengths. */
1004 #define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS)  \
1005     for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS);            \
1006          (LEFT) > 0 && instruction_is_valid(ITER, LEFT);                \
1007          ((LEFT) -= (ntohs((ITER)->len)                                 \
1008                      / sizeof(struct ofp11_instruction)),               \
1009           (ITER) = instruction_next(ITER)))
1010
1011 static enum ofperr
1012 decode_openflow11_instruction(const struct ofp11_instruction *inst,
1013                               enum ovs_instruction_type *type)
1014 {
1015     uint16_t len = ntohs(inst->len);
1016
1017     switch (inst->type) {
1018     case CONSTANT_HTONS(OFPIT11_EXPERIMENTER):
1019         return OFPERR_OFPBIC_BAD_EXPERIMENTER;
1020
1021 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME)     \
1022         case CONSTANT_HTONS(ENUM):                      \
1023             if (EXTENSIBLE                              \
1024                 ? len >= sizeof(struct STRUCT)          \
1025                 : len == sizeof(struct STRUCT)) {       \
1026                 *type = OVSINST_##ENUM;                 \
1027                 return 0;                               \
1028             } else {                                    \
1029                 return OFPERR_OFPBIC_BAD_LEN;           \
1030             }
1031 OVS_INSTRUCTIONS
1032 #undef DEFINE_INST
1033
1034     default:
1035         return OFPERR_OFPBIC_UNKNOWN_INST;
1036     }
1037 }
1038
1039 static enum ofperr
1040 decode_openflow11_instructions(const struct ofp11_instruction insts[],
1041                                size_t n_insts,
1042                                const struct ofp11_instruction *out[])
1043 {
1044     const struct ofp11_instruction *inst;
1045     size_t left;
1046
1047     memset(out, 0, N_OVS_INSTRUCTIONS * sizeof *out);
1048     INSTRUCTION_FOR_EACH (inst, left, insts, n_insts) {
1049         enum ovs_instruction_type type;
1050         enum ofperr error;
1051
1052         error = decode_openflow11_instruction(inst, &type);
1053         if (error) {
1054             return error;
1055         }
1056
1057         if (out[type]) {
1058             return OFPERR_ONFBIC_DUP_INSTRUCTION;
1059         }
1060         out[type] = inst;
1061     }
1062
1063     if (left) {
1064         VLOG_WARN_RL(&rl, "bad instruction format at offset %zu",
1065                      (n_insts - left) * sizeof *inst);
1066         return OFPERR_OFPBIC_BAD_LEN;
1067     }
1068     return 0;
1069 }
1070
1071 static void
1072 get_actions_from_instruction(const struct ofp11_instruction *inst,
1073                          const union ofp_action **actions,
1074                          size_t *n_actions)
1075 {
1076     *actions = (const union ofp_action *) (inst + 1);
1077     *n_actions = (ntohs(inst->len) - sizeof *inst) / OFP11_INSTRUCTION_ALIGN;
1078 }
1079
1080 /* Attempts to convert 'actions_len' bytes of OpenFlow 1.1 actions from the
1081  * front of 'openflow' into ofpacts.  On success, replaces any existing content
1082  * in 'ofpacts' by the converted ofpacts; on failure, clears 'ofpacts'.
1083  * Returns 0 if successful, otherwise an OpenFlow error.
1084  *
1085  * In most places in OpenFlow 1.1 and 1.2, actions appear encapsulated in
1086  * instructions, so you should call ofpacts_pull_openflow11_instructions()
1087  * instead of this function.
1088  *
1089  * The parsed actions are valid generically, but they may not be valid in a
1090  * specific context.  For example, port numbers up to OFPP_MAX are valid
1091  * generically, but specific datapaths may only support port numbers in a
1092  * smaller range.  Use ofpacts_check() to additional check whether actions are
1093  * valid in a specific context. */
1094 enum ofperr
1095 ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
1096                                 unsigned int actions_len,
1097                                 struct ofpbuf *ofpacts)
1098 {
1099     return ofpacts_pull_actions(openflow, actions_len, ofpacts,
1100                                 ofpacts_from_openflow11);
1101 }
1102
1103 enum ofperr
1104 ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
1105                                      unsigned int instructions_len,
1106                                      uint8_t table_id,
1107                                      struct ofpbuf *ofpacts)
1108 {
1109     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1110     const struct ofp11_instruction *instructions;
1111     const struct ofp11_instruction *insts[N_OVS_INSTRUCTIONS];
1112     enum ofperr error;
1113
1114     ofpbuf_clear(ofpacts);
1115
1116     if (instructions_len % OFP11_INSTRUCTION_ALIGN != 0) {
1117         VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u is not a "
1118                      "multiple of %d",
1119                      instructions_len, OFP11_INSTRUCTION_ALIGN);
1120         error = OFPERR_OFPBIC_BAD_LEN;
1121         goto exit;
1122     }
1123
1124     instructions = ofpbuf_try_pull(openflow, instructions_len);
1125     if (instructions == NULL) {
1126         VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u exceeds "
1127                      "remaining message length (%zu)",
1128                      instructions_len, openflow->size);
1129         error = OFPERR_OFPBIC_BAD_LEN;
1130         goto exit;
1131     }
1132
1133     error = decode_openflow11_instructions(
1134         instructions, instructions_len / OFP11_INSTRUCTION_ALIGN,
1135         insts);
1136     if (error) {
1137         goto exit;
1138     }
1139
1140     if (insts[OVSINST_OFPIT13_METER]) {
1141         const struct ofp13_instruction_meter *oim;
1142         struct ofpact_meter *om;
1143
1144         oim = (const struct ofp13_instruction_meter *)
1145             insts[OVSINST_OFPIT13_METER];
1146
1147         om = ofpact_put_METER(ofpacts);
1148         om->meter_id = ntohl(oim->meter_id);
1149     }
1150     if (insts[OVSINST_OFPIT11_APPLY_ACTIONS]) {
1151         const union ofp_action *actions;
1152         size_t n_actions;
1153
1154         get_actions_from_instruction(insts[OVSINST_OFPIT11_APPLY_ACTIONS],
1155                                      &actions, &n_actions);
1156         error = ofpacts_from_openflow11(actions, n_actions, ofpacts);
1157         if (error) {
1158             goto exit;
1159         }
1160     }
1161     if (insts[OVSINST_OFPIT11_CLEAR_ACTIONS]) {
1162         instruction_get_OFPIT11_CLEAR_ACTIONS(
1163             insts[OVSINST_OFPIT11_CLEAR_ACTIONS]);
1164         ofpact_put_CLEAR_ACTIONS(ofpacts);
1165     }
1166     /* XXX Write-Actions */
1167     if (insts[OVSINST_OFPIT11_WRITE_METADATA]) {
1168         const struct ofp11_instruction_write_metadata *oiwm;
1169         struct ofpact_metadata *om;
1170
1171         oiwm = (const struct ofp11_instruction_write_metadata *)
1172             insts[OVSINST_OFPIT11_WRITE_METADATA];
1173
1174         om = ofpact_put_WRITE_METADATA(ofpacts);
1175         om->metadata = oiwm->metadata;
1176         om->mask = oiwm->metadata_mask;
1177     }
1178     if (insts[OVSINST_OFPIT11_GOTO_TABLE]) {
1179         const struct ofp11_instruction_goto_table *oigt;
1180         struct ofpact_goto_table *ogt;
1181
1182         oigt = instruction_get_OFPIT11_GOTO_TABLE(
1183             insts[OVSINST_OFPIT11_GOTO_TABLE]);
1184         if (table_id >= oigt->table_id) {
1185             error = OFPERR_OFPBRC_BAD_TABLE_ID;
1186             goto exit;
1187         }
1188         ogt = ofpact_put_GOTO_TABLE(ofpacts);
1189         ogt->table_id = oigt->table_id;
1190     }
1191
1192     if (insts[OVSINST_OFPIT11_WRITE_ACTIONS]) {
1193         error = OFPERR_OFPBIC_UNSUP_INST;
1194         goto exit;
1195     }
1196
1197     error = ofpacts_verify(ofpacts->data, ofpacts->size);
1198 exit:
1199     if (error) {
1200         ofpbuf_clear(ofpacts);
1201     }
1202     return error;
1203 }
1204 \f
1205 /* May modify flow->dl_type, caller must restore it. */
1206 static enum ofperr
1207 ofpact_check__(const struct ofpact *a, struct flow *flow, ofp_port_t max_ports)
1208 {
1209     const struct ofpact_enqueue *enqueue;
1210
1211     switch (a->type) {
1212     case OFPACT_OUTPUT:
1213         return ofputil_check_output_port(ofpact_get_OUTPUT(a)->port,
1214                                          max_ports);
1215
1216     case OFPACT_CONTROLLER:
1217         return 0;
1218
1219     case OFPACT_ENQUEUE:
1220         enqueue = ofpact_get_ENQUEUE(a);
1221         if (ofp_to_u16(enqueue->port) >= ofp_to_u16(max_ports)
1222             && enqueue->port != OFPP_IN_PORT
1223             && enqueue->port != OFPP_LOCAL) {
1224             return OFPERR_OFPBAC_BAD_OUT_PORT;
1225         }
1226         return 0;
1227
1228     case OFPACT_OUTPUT_REG:
1229         return mf_check_src(&ofpact_get_OUTPUT_REG(a)->src, flow);
1230
1231     case OFPACT_BUNDLE:
1232         return bundle_check(ofpact_get_BUNDLE(a), max_ports, flow);
1233
1234     case OFPACT_SET_VLAN_VID:
1235     case OFPACT_SET_VLAN_PCP:
1236     case OFPACT_STRIP_VLAN:
1237     case OFPACT_PUSH_VLAN:
1238     case OFPACT_SET_ETH_SRC:
1239     case OFPACT_SET_ETH_DST:
1240     case OFPACT_SET_IPV4_SRC:
1241     case OFPACT_SET_IPV4_DST:
1242     case OFPACT_SET_IPV4_DSCP:
1243     case OFPACT_SET_L4_SRC_PORT:
1244     case OFPACT_SET_L4_DST_PORT:
1245         return 0;
1246
1247     case OFPACT_REG_MOVE:
1248         return nxm_reg_move_check(ofpact_get_REG_MOVE(a), flow);
1249
1250     case OFPACT_REG_LOAD:
1251         return nxm_reg_load_check(ofpact_get_REG_LOAD(a), flow);
1252
1253     case OFPACT_STACK_PUSH:
1254         return nxm_stack_push_check(ofpact_get_STACK_PUSH(a), flow);
1255
1256     case OFPACT_STACK_POP:
1257         return nxm_stack_pop_check(ofpact_get_STACK_POP(a), flow);
1258
1259     case OFPACT_DEC_TTL:
1260     case OFPACT_SET_MPLS_TTL:
1261     case OFPACT_DEC_MPLS_TTL:
1262     case OFPACT_SET_TUNNEL:
1263     case OFPACT_SET_QUEUE:
1264     case OFPACT_POP_QUEUE:
1265     case OFPACT_FIN_TIMEOUT:
1266     case OFPACT_RESUBMIT:
1267         return 0;
1268
1269     case OFPACT_LEARN:
1270         return learn_check(ofpact_get_LEARN(a), flow);
1271
1272     case OFPACT_MULTIPATH:
1273         return multipath_check(ofpact_get_MULTIPATH(a), flow);
1274
1275     case OFPACT_NOTE:
1276     case OFPACT_EXIT:
1277         return 0;
1278
1279     case OFPACT_PUSH_MPLS:
1280         flow->dl_type = ofpact_get_PUSH_MPLS(a)->ethertype;
1281         return 0;
1282
1283     case OFPACT_POP_MPLS:
1284         flow->dl_type = ofpact_get_POP_MPLS(a)->ethertype;
1285         return 0;
1286
1287     case OFPACT_SAMPLE:
1288         return 0;
1289
1290     case OFPACT_CLEAR_ACTIONS:
1291     case OFPACT_WRITE_METADATA:
1292     case OFPACT_METER:
1293     case OFPACT_GOTO_TABLE:
1294         return 0;
1295
1296     default:
1297         NOT_REACHED();
1298     }
1299 }
1300
1301 /* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1302  * appropriate for a packet with the prerequisites satisfied by 'flow' in a
1303  * switch with no more than 'max_ports' ports.
1304  *
1305  * May temporarily modify 'flow', but restores the changes before returning. */
1306 enum ofperr
1307 ofpacts_check(const struct ofpact ofpacts[], size_t ofpacts_len,
1308               struct flow *flow, ofp_port_t max_ports)
1309 {
1310     const struct ofpact *a;
1311     ovs_be16 dl_type = flow->dl_type;
1312     enum ofperr error = 0;
1313
1314     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1315         error = ofpact_check__(a, flow, max_ports);
1316         if (error) {
1317             break;
1318         }
1319     }
1320     flow->dl_type = dl_type; /* Restore. */
1321     return error;
1322 }
1323
1324 /* Verifies that the 'ofpacts_len' bytes of actions in 'ofpacts' are
1325  * in the appropriate order as defined by the OpenFlow spec. */
1326 enum ofperr
1327 ofpacts_verify(const struct ofpact ofpacts[], size_t ofpacts_len)
1328 {
1329     const struct ofpact *a;
1330     enum ovs_instruction_type inst;
1331
1332     inst = OVSINST_OFPIT11_APPLY_ACTIONS;
1333     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1334         enum ovs_instruction_type next;
1335
1336         next = ovs_instruction_type_from_ofpact_type(a->type);
1337         if (inst != OVSINST_OFPIT11_APPLY_ACTIONS && next <= inst) {
1338             const char *name = ovs_instruction_name_from_type(inst);
1339             const char *next_name = ovs_instruction_name_from_type(next);
1340
1341             if (next == inst) {
1342                 VLOG_WARN("duplicate %s instruction not allowed, for OpenFlow "
1343                           "1.1+ compatibility", name);
1344             } else {
1345                 VLOG_WARN("invalid instruction ordering: %s must appear "
1346                           "before %s, for OpenFlow 1.1+ compatibility",
1347                           next_name, name);
1348             }
1349             return OFPERR_OFPBAC_UNSUPPORTED_ORDER;
1350         }
1351
1352         inst = next;
1353     }
1354
1355     return 0;
1356 }
1357 \f
1358 /* Converting ofpacts to Nicira OpenFlow extensions. */
1359
1360 static void
1361 ofpact_output_reg_to_nxast(const struct ofpact_output_reg *output_reg,
1362                                 struct ofpbuf *out)
1363 {
1364     struct nx_action_output_reg *naor = ofputil_put_NXAST_OUTPUT_REG(out);
1365
1366     naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
1367                                            output_reg->src.n_bits);
1368     naor->src = htonl(output_reg->src.field->nxm_header);
1369     naor->max_len = htons(output_reg->max_len);
1370 }
1371
1372 static void
1373 ofpact_resubmit_to_nxast(const struct ofpact_resubmit *resubmit,
1374                          struct ofpbuf *out)
1375 {
1376     struct nx_action_resubmit *nar;
1377
1378     if (resubmit->table_id == 0xff
1379         && resubmit->ofpact.compat != OFPUTIL_NXAST_RESUBMIT_TABLE) {
1380         nar = ofputil_put_NXAST_RESUBMIT(out);
1381     } else {
1382         nar = ofputil_put_NXAST_RESUBMIT_TABLE(out);
1383         nar->table = resubmit->table_id;
1384     }
1385     nar->in_port = htons(ofp_to_u16(resubmit->in_port));
1386 }
1387
1388 static void
1389 ofpact_set_tunnel_to_nxast(const struct ofpact_tunnel *tunnel,
1390                            struct ofpbuf *out)
1391 {
1392     uint64_t tun_id = tunnel->tun_id;
1393
1394     if (tun_id <= UINT32_MAX
1395         && tunnel->ofpact.compat != OFPUTIL_NXAST_SET_TUNNEL64) {
1396         ofputil_put_NXAST_SET_TUNNEL(out)->tun_id = htonl(tun_id);
1397     } else {
1398         ofputil_put_NXAST_SET_TUNNEL64(out)->tun_id = htonll(tun_id);
1399     }
1400 }
1401
1402 static void
1403 ofpact_write_metadata_to_nxast(const struct ofpact_metadata *om,
1404                                struct ofpbuf *out)
1405 {
1406     struct nx_action_write_metadata *nawm;
1407
1408     nawm = ofputil_put_NXAST_WRITE_METADATA(out);
1409     nawm->metadata = om->metadata;
1410     nawm->mask = om->mask;
1411 }
1412
1413 static void
1414 ofpact_note_to_nxast(const struct ofpact_note *note, struct ofpbuf *out)
1415 {
1416     size_t start_ofs = out->size;
1417     struct nx_action_note *nan;
1418     unsigned int remainder;
1419     unsigned int len;
1420
1421     nan = ofputil_put_NXAST_NOTE(out);
1422     out->size -= sizeof nan->note;
1423
1424     ofpbuf_put(out, note->data, note->length);
1425
1426     len = out->size - start_ofs;
1427     remainder = len % OFP_ACTION_ALIGN;
1428     if (remainder) {
1429         ofpbuf_put_zeros(out, OFP_ACTION_ALIGN - remainder);
1430     }
1431     nan = (struct nx_action_note *)((char *)out->data + start_ofs);
1432     nan->len = htons(out->size - start_ofs);
1433 }
1434
1435 static void
1436 ofpact_controller_to_nxast(const struct ofpact_controller *oc,
1437                            struct ofpbuf *out)
1438 {
1439     struct nx_action_controller *nac;
1440
1441     nac = ofputil_put_NXAST_CONTROLLER(out);
1442     nac->max_len = htons(oc->max_len);
1443     nac->controller_id = htons(oc->controller_id);
1444     nac->reason = oc->reason;
1445 }
1446
1447 static void
1448 ofpact_dec_ttl_to_nxast(const struct ofpact_cnt_ids *oc_ids,
1449                         struct ofpbuf *out)
1450 {
1451     if (oc_ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL) {
1452         ofputil_put_NXAST_DEC_TTL(out);
1453     } else {
1454         struct nx_action_cnt_ids *nac_ids =
1455             ofputil_put_NXAST_DEC_TTL_CNT_IDS(out);
1456         int ids_len = ROUND_UP(2 * oc_ids->n_controllers, OFP_ACTION_ALIGN);
1457         ovs_be16 *ids;
1458         size_t i;
1459
1460         nac_ids->len = htons(ntohs(nac_ids->len) + ids_len);
1461         nac_ids->n_controllers = htons(oc_ids->n_controllers);
1462
1463         ids = ofpbuf_put_zeros(out, ids_len);
1464         for (i = 0; i < oc_ids->n_controllers; i++) {
1465             ids[i] = htons(oc_ids->cnt_ids[i]);
1466         }
1467     }
1468 }
1469
1470 static void
1471 ofpact_fin_timeout_to_nxast(const struct ofpact_fin_timeout *fin_timeout,
1472                             struct ofpbuf *out)
1473 {
1474     struct nx_action_fin_timeout *naft = ofputil_put_NXAST_FIN_TIMEOUT(out);
1475     naft->fin_idle_timeout = htons(fin_timeout->fin_idle_timeout);
1476     naft->fin_hard_timeout = htons(fin_timeout->fin_hard_timeout);
1477 }
1478
1479 static void
1480 ofpact_sample_to_nxast(const struct ofpact_sample *os,
1481                        struct ofpbuf *out)
1482 {
1483     struct nx_action_sample *nas;
1484
1485     nas = ofputil_put_NXAST_SAMPLE(out);
1486     nas->probability = htons(os->probability);
1487     nas->collector_set_id = htonl(os->collector_set_id);
1488     nas->obs_domain_id = htonl(os->obs_domain_id);
1489     nas->obs_point_id = htonl(os->obs_point_id);
1490 }
1491
1492 static void
1493 ofpact_to_nxast(const struct ofpact *a, struct ofpbuf *out)
1494 {
1495     switch (a->type) {
1496     case OFPACT_CONTROLLER:
1497         ofpact_controller_to_nxast(ofpact_get_CONTROLLER(a), out);
1498         break;
1499
1500     case OFPACT_OUTPUT_REG:
1501         ofpact_output_reg_to_nxast(ofpact_get_OUTPUT_REG(a), out);
1502         break;
1503
1504     case OFPACT_BUNDLE:
1505         bundle_to_nxast(ofpact_get_BUNDLE(a), out);
1506         break;
1507
1508     case OFPACT_REG_MOVE:
1509         nxm_reg_move_to_nxast(ofpact_get_REG_MOVE(a), out);
1510         break;
1511
1512     case OFPACT_REG_LOAD:
1513         nxm_reg_load_to_nxast(ofpact_get_REG_LOAD(a), out);
1514         break;
1515
1516     case OFPACT_STACK_PUSH:
1517         nxm_stack_push_to_nxast(ofpact_get_STACK_PUSH(a), out);
1518         break;
1519
1520     case OFPACT_STACK_POP:
1521         nxm_stack_pop_to_nxast(ofpact_get_STACK_POP(a), out);
1522         break;
1523
1524     case OFPACT_DEC_TTL:
1525         ofpact_dec_ttl_to_nxast(ofpact_get_DEC_TTL(a), out);
1526         break;
1527
1528     case OFPACT_SET_MPLS_TTL:
1529         ofputil_put_NXAST_SET_MPLS_TTL(out)->ttl
1530             = ofpact_get_SET_MPLS_TTL(a)->ttl;
1531         break;
1532
1533     case OFPACT_DEC_MPLS_TTL:
1534         ofputil_put_NXAST_DEC_MPLS_TTL(out);
1535         break;
1536
1537     case OFPACT_SET_TUNNEL:
1538         ofpact_set_tunnel_to_nxast(ofpact_get_SET_TUNNEL(a), out);
1539         break;
1540
1541     case OFPACT_WRITE_METADATA:
1542         ofpact_write_metadata_to_nxast(ofpact_get_WRITE_METADATA(a), out);
1543         break;
1544
1545     case OFPACT_SET_QUEUE:
1546         ofputil_put_NXAST_SET_QUEUE(out)->queue_id
1547             = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1548         break;
1549
1550     case OFPACT_POP_QUEUE:
1551         ofputil_put_NXAST_POP_QUEUE(out);
1552         break;
1553
1554     case OFPACT_FIN_TIMEOUT:
1555         ofpact_fin_timeout_to_nxast(ofpact_get_FIN_TIMEOUT(a), out);
1556         break;
1557
1558     case OFPACT_RESUBMIT:
1559         ofpact_resubmit_to_nxast(ofpact_get_RESUBMIT(a), out);
1560         break;
1561
1562     case OFPACT_LEARN:
1563         learn_to_nxast(ofpact_get_LEARN(a), out);
1564         break;
1565
1566     case OFPACT_MULTIPATH:
1567         multipath_to_nxast(ofpact_get_MULTIPATH(a), out);
1568         break;
1569
1570     case OFPACT_NOTE:
1571         ofpact_note_to_nxast(ofpact_get_NOTE(a), out);
1572         break;
1573
1574     case OFPACT_EXIT:
1575         ofputil_put_NXAST_EXIT(out);
1576         break;
1577
1578     case OFPACT_PUSH_MPLS:
1579         ofputil_put_NXAST_PUSH_MPLS(out)->ethertype =
1580             ofpact_get_PUSH_MPLS(a)->ethertype;
1581         break;
1582
1583     case OFPACT_POP_MPLS:
1584         ofputil_put_NXAST_POP_MPLS(out)->ethertype =
1585             ofpact_get_POP_MPLS(a)->ethertype;
1586         break;
1587
1588     case OFPACT_SAMPLE:
1589         ofpact_sample_to_nxast(ofpact_get_SAMPLE(a), out);
1590         break;
1591
1592     case OFPACT_OUTPUT:
1593     case OFPACT_ENQUEUE:
1594     case OFPACT_SET_VLAN_VID:
1595     case OFPACT_SET_VLAN_PCP:
1596     case OFPACT_STRIP_VLAN:
1597     case OFPACT_PUSH_VLAN:
1598     case OFPACT_SET_ETH_SRC:
1599     case OFPACT_SET_ETH_DST:
1600     case OFPACT_SET_IPV4_SRC:
1601     case OFPACT_SET_IPV4_DST:
1602     case OFPACT_SET_IPV4_DSCP:
1603     case OFPACT_SET_L4_SRC_PORT:
1604     case OFPACT_SET_L4_DST_PORT:
1605     case OFPACT_CLEAR_ACTIONS:
1606     case OFPACT_GOTO_TABLE:
1607     case OFPACT_METER:
1608         NOT_REACHED();
1609     }
1610 }
1611 \f
1612 /* Converting ofpacts to OpenFlow 1.0. */
1613
1614 static void
1615 ofpact_output_to_openflow10(const struct ofpact_output *output,
1616                             struct ofpbuf *out)
1617 {
1618     struct ofp10_action_output *oao;
1619
1620     oao = ofputil_put_OFPAT10_OUTPUT(out);
1621     oao->port = htons(ofp_to_u16(output->port));
1622     oao->max_len = htons(output->max_len);
1623 }
1624
1625 static void
1626 ofpact_enqueue_to_openflow10(const struct ofpact_enqueue *enqueue,
1627                              struct ofpbuf *out)
1628 {
1629     struct ofp10_action_enqueue *oae;
1630
1631     oae = ofputil_put_OFPAT10_ENQUEUE(out);
1632     oae->port = htons(ofp_to_u16(enqueue->port));
1633     oae->queue_id = htonl(enqueue->queue);
1634 }
1635
1636 static void
1637 ofpact_to_openflow10(const struct ofpact *a, struct ofpbuf *out)
1638 {
1639     switch (a->type) {
1640     case OFPACT_OUTPUT:
1641         ofpact_output_to_openflow10(ofpact_get_OUTPUT(a), out);
1642         break;
1643
1644     case OFPACT_ENQUEUE:
1645         ofpact_enqueue_to_openflow10(ofpact_get_ENQUEUE(a), out);
1646         break;
1647
1648     case OFPACT_SET_VLAN_VID:
1649         ofputil_put_OFPAT10_SET_VLAN_VID(out)->vlan_vid
1650             = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1651         break;
1652
1653     case OFPACT_SET_VLAN_PCP:
1654         ofputil_put_OFPAT10_SET_VLAN_PCP(out)->vlan_pcp
1655             = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1656         break;
1657
1658     case OFPACT_STRIP_VLAN:
1659         ofputil_put_OFPAT10_STRIP_VLAN(out);
1660         break;
1661
1662     case OFPACT_SET_ETH_SRC:
1663         memcpy(ofputil_put_OFPAT10_SET_DL_SRC(out)->dl_addr,
1664                ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1665         break;
1666
1667     case OFPACT_SET_ETH_DST:
1668         memcpy(ofputil_put_OFPAT10_SET_DL_DST(out)->dl_addr,
1669                ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1670         break;
1671
1672     case OFPACT_SET_IPV4_SRC:
1673         ofputil_put_OFPAT10_SET_NW_SRC(out)->nw_addr
1674             = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1675         break;
1676
1677     case OFPACT_SET_IPV4_DST:
1678         ofputil_put_OFPAT10_SET_NW_DST(out)->nw_addr
1679             = ofpact_get_SET_IPV4_DST(a)->ipv4;
1680         break;
1681
1682     case OFPACT_SET_IPV4_DSCP:
1683         ofputil_put_OFPAT10_SET_NW_TOS(out)->nw_tos
1684             = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1685         break;
1686
1687     case OFPACT_SET_L4_SRC_PORT:
1688         ofputil_put_OFPAT10_SET_TP_SRC(out)->tp_port
1689             = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1690         break;
1691
1692     case OFPACT_SET_L4_DST_PORT:
1693         ofputil_put_OFPAT10_SET_TP_DST(out)->tp_port
1694             = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1695         break;
1696
1697     case OFPACT_PUSH_VLAN:
1698     case OFPACT_CLEAR_ACTIONS:
1699     case OFPACT_GOTO_TABLE:
1700     case OFPACT_METER:
1701         /* XXX */
1702         break;
1703
1704     case OFPACT_CONTROLLER:
1705     case OFPACT_OUTPUT_REG:
1706     case OFPACT_BUNDLE:
1707     case OFPACT_REG_MOVE:
1708     case OFPACT_REG_LOAD:
1709     case OFPACT_STACK_PUSH:
1710     case OFPACT_STACK_POP:
1711     case OFPACT_DEC_TTL:
1712     case OFPACT_SET_MPLS_TTL:
1713     case OFPACT_DEC_MPLS_TTL:
1714     case OFPACT_SET_TUNNEL:
1715     case OFPACT_WRITE_METADATA:
1716     case OFPACT_SET_QUEUE:
1717     case OFPACT_POP_QUEUE:
1718     case OFPACT_FIN_TIMEOUT:
1719     case OFPACT_RESUBMIT:
1720     case OFPACT_LEARN:
1721     case OFPACT_MULTIPATH:
1722     case OFPACT_NOTE:
1723     case OFPACT_EXIT:
1724     case OFPACT_PUSH_MPLS:
1725     case OFPACT_POP_MPLS:
1726     case OFPACT_SAMPLE:
1727         ofpact_to_nxast(a, out);
1728         break;
1729     }
1730 }
1731
1732 /* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow 1.0
1733  * actions in 'openflow', appending the actions to any existing data in
1734  * 'openflow'. */
1735 void
1736 ofpacts_put_openflow10(const struct ofpact ofpacts[], size_t ofpacts_len,
1737                        struct ofpbuf *openflow)
1738 {
1739     const struct ofpact *a;
1740
1741     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1742         ofpact_to_openflow10(a, openflow);
1743     }
1744 }
1745 \f
1746 /* Converting ofpacts to OpenFlow 1.1. */
1747
1748 static void
1749 ofpact_output_to_openflow11(const struct ofpact_output *output,
1750                             struct ofpbuf *out)
1751 {
1752     struct ofp11_action_output *oao;
1753
1754     oao = ofputil_put_OFPAT11_OUTPUT(out);
1755     oao->port = ofputil_port_to_ofp11(output->port);
1756     oao->max_len = htons(output->max_len);
1757 }
1758
1759 static void
1760 ofpact_dec_ttl_to_openflow11(const struct ofpact_cnt_ids *dec_ttl,
1761                              struct ofpbuf *out)
1762 {
1763     if (dec_ttl->n_controllers == 1 && dec_ttl->cnt_ids[0] == 0
1764         && (!dec_ttl->ofpact.compat ||
1765             dec_ttl->ofpact.compat == OFPUTIL_OFPAT11_DEC_NW_TTL)) {
1766         ofputil_put_OFPAT11_DEC_NW_TTL(out);
1767     } else {
1768         ofpact_dec_ttl_to_nxast(dec_ttl, out);
1769     }
1770 }
1771
1772 static void
1773 ofpact_to_openflow11(const struct ofpact *a, struct ofpbuf *out)
1774 {
1775     switch (a->type) {
1776     case OFPACT_OUTPUT:
1777         return ofpact_output_to_openflow11(ofpact_get_OUTPUT(a), out);
1778
1779     case OFPACT_ENQUEUE:
1780         /* XXX */
1781         break;
1782
1783     case OFPACT_SET_VLAN_VID:
1784         ofputil_put_OFPAT11_SET_VLAN_VID(out)->vlan_vid
1785             = htons(ofpact_get_SET_VLAN_VID(a)->vlan_vid);
1786         break;
1787
1788     case OFPACT_SET_VLAN_PCP:
1789         ofputil_put_OFPAT11_SET_VLAN_PCP(out)->vlan_pcp
1790             = ofpact_get_SET_VLAN_PCP(a)->vlan_pcp;
1791         break;
1792
1793     case OFPACT_STRIP_VLAN:
1794         ofputil_put_OFPAT11_POP_VLAN(out);
1795         break;
1796
1797     case OFPACT_PUSH_VLAN:
1798         /* XXX ETH_TYPE_VLAN_8021AD case */
1799         ofputil_put_OFPAT11_PUSH_VLAN(out)->ethertype =
1800             htons(ETH_TYPE_VLAN_8021Q);
1801         break;
1802
1803     case OFPACT_SET_QUEUE:
1804         ofputil_put_OFPAT11_SET_QUEUE(out)->queue_id
1805             = htonl(ofpact_get_SET_QUEUE(a)->queue_id);
1806         break;
1807
1808     case OFPACT_SET_ETH_SRC:
1809         memcpy(ofputil_put_OFPAT11_SET_DL_SRC(out)->dl_addr,
1810                ofpact_get_SET_ETH_SRC(a)->mac, ETH_ADDR_LEN);
1811         break;
1812
1813     case OFPACT_SET_ETH_DST:
1814         memcpy(ofputil_put_OFPAT11_SET_DL_DST(out)->dl_addr,
1815                ofpact_get_SET_ETH_DST(a)->mac, ETH_ADDR_LEN);
1816         break;
1817
1818     case OFPACT_SET_IPV4_SRC:
1819         ofputil_put_OFPAT11_SET_NW_SRC(out)->nw_addr
1820             = ofpact_get_SET_IPV4_SRC(a)->ipv4;
1821         break;
1822
1823     case OFPACT_SET_IPV4_DST:
1824         ofputil_put_OFPAT11_SET_NW_DST(out)->nw_addr
1825             = ofpact_get_SET_IPV4_DST(a)->ipv4;
1826         break;
1827
1828     case OFPACT_SET_IPV4_DSCP:
1829         ofputil_put_OFPAT11_SET_NW_TOS(out)->nw_tos
1830             = ofpact_get_SET_IPV4_DSCP(a)->dscp;
1831         break;
1832
1833     case OFPACT_SET_L4_SRC_PORT:
1834         ofputil_put_OFPAT11_SET_TP_SRC(out)->tp_port
1835             = htons(ofpact_get_SET_L4_SRC_PORT(a)->port);
1836         break;
1837
1838     case OFPACT_SET_L4_DST_PORT:
1839         ofputil_put_OFPAT11_SET_TP_DST(out)->tp_port
1840             = htons(ofpact_get_SET_L4_DST_PORT(a)->port);
1841         break;
1842
1843     case OFPACT_DEC_TTL:
1844         ofpact_dec_ttl_to_openflow11(ofpact_get_DEC_TTL(a), out);
1845         break;
1846
1847     case OFPACT_SET_MPLS_TTL:
1848         ofputil_put_OFPAT11_SET_MPLS_TTL(out)->mpls_ttl
1849             = ofpact_get_SET_MPLS_TTL(a)->ttl;
1850         break;
1851
1852     case OFPACT_DEC_MPLS_TTL:
1853         ofputil_put_OFPAT11_DEC_MPLS_TTL(out);
1854         break;
1855
1856     case OFPACT_WRITE_METADATA:
1857         /* OpenFlow 1.1 uses OFPIT_WRITE_METADATA to express this action. */
1858         break;
1859
1860     case OFPACT_PUSH_MPLS:
1861         ofputil_put_OFPAT11_PUSH_MPLS(out)->ethertype =
1862             ofpact_get_PUSH_MPLS(a)->ethertype;
1863         break;
1864
1865     case OFPACT_POP_MPLS:
1866         ofputil_put_OFPAT11_POP_MPLS(out)->ethertype =
1867             ofpact_get_POP_MPLS(a)->ethertype;
1868
1869         break;
1870
1871     case OFPACT_CLEAR_ACTIONS:
1872     case OFPACT_GOTO_TABLE:
1873     case OFPACT_METER:
1874         NOT_REACHED();
1875
1876     case OFPACT_CONTROLLER:
1877     case OFPACT_OUTPUT_REG:
1878     case OFPACT_BUNDLE:
1879     case OFPACT_REG_MOVE:
1880     case OFPACT_REG_LOAD:
1881     case OFPACT_STACK_PUSH:
1882     case OFPACT_STACK_POP:
1883     case OFPACT_SET_TUNNEL:
1884     case OFPACT_POP_QUEUE:
1885     case OFPACT_FIN_TIMEOUT:
1886     case OFPACT_RESUBMIT:
1887     case OFPACT_LEARN:
1888     case OFPACT_MULTIPATH:
1889     case OFPACT_NOTE:
1890     case OFPACT_EXIT:
1891     case OFPACT_SAMPLE:
1892         ofpact_to_nxast(a, out);
1893         break;
1894     }
1895 }
1896
1897 /* Converts the ofpacts in 'ofpacts' (terminated by OFPACT_END) into OpenFlow
1898  * 1.1 actions in 'openflow', appending the actions to any existing data in
1899  * 'openflow'. */
1900 size_t
1901 ofpacts_put_openflow11_actions(const struct ofpact ofpacts[],
1902                                size_t ofpacts_len, struct ofpbuf *openflow)
1903 {
1904     const struct ofpact *a;
1905     size_t start_size = openflow->size;
1906
1907     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1908         ofpact_to_openflow11(a, openflow);
1909     }
1910
1911     return openflow->size - start_size;
1912 }
1913
1914 static void
1915 ofpacts_update_instruction_actions(struct ofpbuf *openflow, size_t ofs)
1916 {
1917     struct ofp11_instruction_actions *oia;
1918
1919     /* Update the instruction's length (or, if it's empty, delete it). */
1920     oia = ofpbuf_at_assert(openflow, ofs, sizeof *oia);
1921     if (openflow->size > ofs + sizeof *oia) {
1922         oia->len = htons(openflow->size - ofs);
1923     } else {
1924         openflow->size = ofs;
1925     }
1926 }
1927
1928 void
1929 ofpacts_put_openflow11_instructions(const struct ofpact ofpacts[],
1930                                     size_t ofpacts_len,
1931                                     struct ofpbuf *openflow)
1932 {
1933     const struct ofpact *a;
1934
1935     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
1936         switch (ovs_instruction_type_from_ofpact_type(a->type)) {
1937         case OVSINST_OFPIT11_CLEAR_ACTIONS:
1938             instruction_put_OFPIT11_CLEAR_ACTIONS(openflow);
1939             break;
1940
1941         case OVSINST_OFPIT11_GOTO_TABLE: {
1942             struct ofp11_instruction_goto_table *oigt;
1943             oigt = instruction_put_OFPIT11_GOTO_TABLE(openflow);
1944             oigt->table_id = ofpact_get_GOTO_TABLE(a)->table_id;
1945             memset(oigt->pad, 0, sizeof oigt->pad);
1946             break;
1947         }
1948
1949         case OVSINST_OFPIT11_WRITE_METADATA: {
1950             const struct ofpact_metadata *om;
1951             struct ofp11_instruction_write_metadata *oiwm;
1952
1953             om = ofpact_get_WRITE_METADATA(a);
1954             oiwm = instruction_put_OFPIT11_WRITE_METADATA(openflow);
1955             oiwm->metadata = om->metadata;
1956             oiwm->metadata_mask = om->mask;
1957             break;
1958         }
1959
1960         case OVSINST_OFPIT13_METER: {
1961             const struct ofpact_meter *om;
1962             struct ofp13_instruction_meter *oim;
1963
1964             om = ofpact_get_METER(a);
1965             oim = instruction_put_OFPIT13_METER(openflow);
1966             oim->meter_id = htonl(om->meter_id);
1967             break;
1968         }
1969
1970         case OVSINST_OFPIT11_APPLY_ACTIONS: {
1971             const size_t ofs = openflow->size;
1972             const size_t ofpacts_len_left =
1973                 (uint8_t*)ofpact_end(ofpacts, ofpacts_len) - (uint8_t*)a;
1974             const struct ofpact *action;
1975             const struct ofpact *processed = a;
1976
1977             instruction_put_OFPIT11_APPLY_ACTIONS(openflow);
1978             OFPACT_FOR_EACH(action, a, ofpacts_len_left) {
1979                 if (ovs_instruction_type_from_ofpact_type(action->type)
1980                     != OVSINST_OFPIT11_APPLY_ACTIONS) {
1981                     break;
1982                 }
1983                 ofpact_to_openflow11(action, openflow);
1984                 processed = action;
1985             }
1986             ofpacts_update_instruction_actions(openflow, ofs);
1987             a = processed;
1988             break;
1989         }
1990
1991         case OVSINST_OFPIT11_WRITE_ACTIONS:
1992             NOT_REACHED();
1993         }
1994     }
1995 }
1996 \f
1997 /* Returns true if 'action' outputs to 'port', false otherwise. */
1998 static bool
1999 ofpact_outputs_to_port(const struct ofpact *ofpact, ofp_port_t port)
2000 {
2001     switch (ofpact->type) {
2002     case OFPACT_OUTPUT:
2003         return ofpact_get_OUTPUT(ofpact)->port == port;
2004     case OFPACT_ENQUEUE:
2005         return ofpact_get_ENQUEUE(ofpact)->port == port;
2006     case OFPACT_CONTROLLER:
2007         return port == OFPP_CONTROLLER;
2008
2009     case OFPACT_OUTPUT_REG:
2010     case OFPACT_BUNDLE:
2011     case OFPACT_SET_VLAN_VID:
2012     case OFPACT_SET_VLAN_PCP:
2013     case OFPACT_STRIP_VLAN:
2014     case OFPACT_PUSH_VLAN:
2015     case OFPACT_SET_ETH_SRC:
2016     case OFPACT_SET_ETH_DST:
2017     case OFPACT_SET_IPV4_SRC:
2018     case OFPACT_SET_IPV4_DST:
2019     case OFPACT_SET_IPV4_DSCP:
2020     case OFPACT_SET_L4_SRC_PORT:
2021     case OFPACT_SET_L4_DST_PORT:
2022     case OFPACT_REG_MOVE:
2023     case OFPACT_REG_LOAD:
2024     case OFPACT_STACK_PUSH:
2025     case OFPACT_STACK_POP:
2026     case OFPACT_DEC_TTL:
2027     case OFPACT_SET_MPLS_TTL:
2028     case OFPACT_DEC_MPLS_TTL:
2029     case OFPACT_SET_TUNNEL:
2030     case OFPACT_WRITE_METADATA:
2031     case OFPACT_SET_QUEUE:
2032     case OFPACT_POP_QUEUE:
2033     case OFPACT_FIN_TIMEOUT:
2034     case OFPACT_RESUBMIT:
2035     case OFPACT_LEARN:
2036     case OFPACT_MULTIPATH:
2037     case OFPACT_NOTE:
2038     case OFPACT_EXIT:
2039     case OFPACT_PUSH_MPLS:
2040     case OFPACT_POP_MPLS:
2041     case OFPACT_SAMPLE:
2042     case OFPACT_CLEAR_ACTIONS:
2043     case OFPACT_GOTO_TABLE:
2044     case OFPACT_METER:
2045     default:
2046         return false;
2047     }
2048 }
2049
2050 /* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
2051  * to 'port', false otherwise. */
2052 bool
2053 ofpacts_output_to_port(const struct ofpact *ofpacts, size_t ofpacts_len,
2054                        ofp_port_t port)
2055 {
2056     const struct ofpact *a;
2057
2058     OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2059         if (ofpact_outputs_to_port(a, port)) {
2060             return true;
2061         }
2062     }
2063
2064     return false;
2065 }
2066
2067 bool
2068 ofpacts_equal(const struct ofpact *a, size_t a_len,
2069               const struct ofpact *b, size_t b_len)
2070 {
2071     return a_len == b_len && !memcmp(a, b, a_len);
2072 }
2073 \f
2074 /* Formatting ofpacts. */
2075
2076 static void
2077 print_note(const struct ofpact_note *note, struct ds *string)
2078 {
2079     size_t i;
2080
2081     ds_put_cstr(string, "note:");
2082     for (i = 0; i < note->length; i++) {
2083         if (i) {
2084             ds_put_char(string, '.');
2085         }
2086         ds_put_format(string, "%02"PRIx8, note->data[i]);
2087     }
2088 }
2089
2090 static void
2091 print_dec_ttl(const struct ofpact_cnt_ids *ids,
2092               struct ds *s)
2093 {
2094     size_t i;
2095
2096     ds_put_cstr(s, "dec_ttl");
2097     if (ids->ofpact.compat == OFPUTIL_NXAST_DEC_TTL_CNT_IDS) {
2098         ds_put_cstr(s, "(");
2099         for (i = 0; i < ids->n_controllers; i++) {
2100             if (i) {
2101                 ds_put_cstr(s, ",");
2102             }
2103             ds_put_format(s, "%"PRIu16, ids->cnt_ids[i]);
2104         }
2105         ds_put_cstr(s, ")");
2106     }
2107 }
2108
2109 static void
2110 print_fin_timeout(const struct ofpact_fin_timeout *fin_timeout,
2111                   struct ds *s)
2112 {
2113     ds_put_cstr(s, "fin_timeout(");
2114     if (fin_timeout->fin_idle_timeout) {
2115         ds_put_format(s, "idle_timeout=%"PRIu16",",
2116                       fin_timeout->fin_idle_timeout);
2117     }
2118     if (fin_timeout->fin_hard_timeout) {
2119         ds_put_format(s, "hard_timeout=%"PRIu16",",
2120                       fin_timeout->fin_hard_timeout);
2121     }
2122     ds_chomp(s, ',');
2123     ds_put_char(s, ')');
2124 }
2125
2126 static void
2127 ofpact_format(const struct ofpact *a, struct ds *s)
2128 {
2129     const struct ofpact_enqueue *enqueue;
2130     const struct ofpact_resubmit *resubmit;
2131     const struct ofpact_controller *controller;
2132     const struct ofpact_metadata *metadata;
2133     const struct ofpact_tunnel *tunnel;
2134     const struct ofpact_sample *sample;
2135     ofp_port_t port;
2136
2137     switch (a->type) {
2138     case OFPACT_OUTPUT:
2139         port = ofpact_get_OUTPUT(a)->port;
2140         if (ofp_to_u16(port) < ofp_to_u16(OFPP_MAX)) {
2141             ds_put_format(s, "output:%"PRIu16, port);
2142         } else {
2143             ofputil_format_port(port, s);
2144             if (port == OFPP_CONTROLLER) {
2145                 ds_put_format(s, ":%"PRIu16, ofpact_get_OUTPUT(a)->max_len);
2146             }
2147         }
2148         break;
2149
2150     case OFPACT_CONTROLLER:
2151         controller = ofpact_get_CONTROLLER(a);
2152         if (controller->reason == OFPR_ACTION &&
2153             controller->controller_id == 0) {
2154             ds_put_format(s, "CONTROLLER:%"PRIu16,
2155                           ofpact_get_CONTROLLER(a)->max_len);
2156         } else {
2157             enum ofp_packet_in_reason reason = controller->reason;
2158
2159             ds_put_cstr(s, "controller(");
2160             if (reason != OFPR_ACTION) {
2161                 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
2162
2163                 ds_put_format(s, "reason=%s,",
2164                               ofputil_packet_in_reason_to_string(
2165                                   reason, reasonbuf, sizeof reasonbuf));
2166             }
2167             if (controller->max_len != UINT16_MAX) {
2168                 ds_put_format(s, "max_len=%"PRIu16",", controller->max_len);
2169             }
2170             if (controller->controller_id != 0) {
2171                 ds_put_format(s, "id=%"PRIu16",", controller->controller_id);
2172             }
2173             ds_chomp(s, ',');
2174             ds_put_char(s, ')');
2175         }
2176         break;
2177
2178     case OFPACT_ENQUEUE:
2179         enqueue = ofpact_get_ENQUEUE(a);
2180         ds_put_format(s, "enqueue:");
2181         ofputil_format_port(enqueue->port, s);
2182         ds_put_format(s, "q%"PRIu32, enqueue->queue);
2183         break;
2184
2185     case OFPACT_OUTPUT_REG:
2186         ds_put_cstr(s, "output:");
2187         mf_format_subfield(&ofpact_get_OUTPUT_REG(a)->src, s);
2188         break;
2189
2190     case OFPACT_BUNDLE:
2191         bundle_format(ofpact_get_BUNDLE(a), s);
2192         break;
2193
2194     case OFPACT_SET_VLAN_VID:
2195         ds_put_format(s, "mod_vlan_vid:%"PRIu16,
2196                       ofpact_get_SET_VLAN_VID(a)->vlan_vid);
2197         break;
2198
2199     case OFPACT_SET_VLAN_PCP:
2200         ds_put_format(s, "mod_vlan_pcp:%"PRIu8,
2201                       ofpact_get_SET_VLAN_PCP(a)->vlan_pcp);
2202         break;
2203
2204     case OFPACT_STRIP_VLAN:
2205         ds_put_cstr(s, "strip_vlan");
2206         break;
2207
2208     case OFPACT_PUSH_VLAN:
2209         /* XXX 802.1AD case*/
2210         ds_put_format(s, "push_vlan:%#"PRIx16, ETH_TYPE_VLAN_8021Q);
2211         break;
2212
2213     case OFPACT_SET_ETH_SRC:
2214         ds_put_format(s, "mod_dl_src:"ETH_ADDR_FMT,
2215                       ETH_ADDR_ARGS(ofpact_get_SET_ETH_SRC(a)->mac));
2216         break;
2217
2218     case OFPACT_SET_ETH_DST:
2219         ds_put_format(s, "mod_dl_dst:"ETH_ADDR_FMT,
2220                       ETH_ADDR_ARGS(ofpact_get_SET_ETH_DST(a)->mac));
2221         break;
2222
2223     case OFPACT_SET_IPV4_SRC:
2224         ds_put_format(s, "mod_nw_src:"IP_FMT,
2225                       IP_ARGS(ofpact_get_SET_IPV4_SRC(a)->ipv4));
2226         break;
2227
2228     case OFPACT_SET_IPV4_DST:
2229         ds_put_format(s, "mod_nw_dst:"IP_FMT,
2230                       IP_ARGS(ofpact_get_SET_IPV4_DST(a)->ipv4));
2231         break;
2232
2233     case OFPACT_SET_IPV4_DSCP:
2234         ds_put_format(s, "mod_nw_tos:%d", ofpact_get_SET_IPV4_DSCP(a)->dscp);
2235         break;
2236
2237     case OFPACT_SET_L4_SRC_PORT:
2238         ds_put_format(s, "mod_tp_src:%d", ofpact_get_SET_L4_SRC_PORT(a)->port);
2239         break;
2240
2241     case OFPACT_SET_L4_DST_PORT:
2242         ds_put_format(s, "mod_tp_dst:%d", ofpact_get_SET_L4_DST_PORT(a)->port);
2243         break;
2244
2245     case OFPACT_REG_MOVE:
2246         nxm_format_reg_move(ofpact_get_REG_MOVE(a), s);
2247         break;
2248
2249     case OFPACT_REG_LOAD:
2250         nxm_format_reg_load(ofpact_get_REG_LOAD(a), s);
2251         break;
2252
2253     case OFPACT_STACK_PUSH:
2254         nxm_format_stack_push(ofpact_get_STACK_PUSH(a), s);
2255         break;
2256
2257     case OFPACT_STACK_POP:
2258         nxm_format_stack_pop(ofpact_get_STACK_POP(a), s);
2259         break;
2260
2261     case OFPACT_DEC_TTL:
2262         print_dec_ttl(ofpact_get_DEC_TTL(a), s);
2263         break;
2264
2265     case OFPACT_SET_MPLS_TTL:
2266         ds_put_format(s, "set_mpls_ttl(%"PRIu8")",
2267                       ofpact_get_SET_MPLS_TTL(a)->ttl);
2268         break;
2269
2270     case OFPACT_DEC_MPLS_TTL:
2271         ds_put_cstr(s, "dec_mpls_ttl");
2272         break;
2273
2274     case OFPACT_SET_TUNNEL:
2275         tunnel = ofpact_get_SET_TUNNEL(a);
2276         ds_put_format(s, "set_tunnel%s:%#"PRIx64,
2277                       (tunnel->tun_id > UINT32_MAX
2278                        || a->compat == OFPUTIL_NXAST_SET_TUNNEL64 ? "64" : ""),
2279                       tunnel->tun_id);
2280         break;
2281
2282     case OFPACT_SET_QUEUE:
2283         ds_put_format(s, "set_queue:%"PRIu32,
2284                       ofpact_get_SET_QUEUE(a)->queue_id);
2285         break;
2286
2287     case OFPACT_POP_QUEUE:
2288         ds_put_cstr(s, "pop_queue");
2289         break;
2290
2291     case OFPACT_FIN_TIMEOUT:
2292         print_fin_timeout(ofpact_get_FIN_TIMEOUT(a), s);
2293         break;
2294
2295     case OFPACT_RESUBMIT:
2296         resubmit = ofpact_get_RESUBMIT(a);
2297         if (resubmit->in_port != OFPP_IN_PORT && resubmit->table_id == 255) {
2298             ds_put_cstr(s, "resubmit:");
2299             ofputil_format_port(resubmit->in_port, s);
2300         } else {
2301             ds_put_format(s, "resubmit(");
2302             if (resubmit->in_port != OFPP_IN_PORT) {
2303                 ofputil_format_port(resubmit->in_port, s);
2304             }
2305             ds_put_char(s, ',');
2306             if (resubmit->table_id != 255) {
2307                 ds_put_format(s, "%"PRIu8, resubmit->table_id);
2308             }
2309             ds_put_char(s, ')');
2310         }
2311         break;
2312
2313     case OFPACT_LEARN:
2314         learn_format(ofpact_get_LEARN(a), s);
2315         break;
2316
2317     case OFPACT_MULTIPATH:
2318         multipath_format(ofpact_get_MULTIPATH(a), s);
2319         break;
2320
2321     case OFPACT_NOTE:
2322         print_note(ofpact_get_NOTE(a), s);
2323         break;
2324
2325     case OFPACT_PUSH_MPLS:
2326         ds_put_format(s, "push_mpls:0x%04"PRIx16,
2327                       ntohs(ofpact_get_PUSH_MPLS(a)->ethertype));
2328         break;
2329
2330     case OFPACT_POP_MPLS:
2331         ds_put_format(s, "pop_mpls:0x%04"PRIx16,
2332                       ntohs(ofpact_get_POP_MPLS(a)->ethertype));
2333         break;
2334
2335     case OFPACT_EXIT:
2336         ds_put_cstr(s, "exit");
2337         break;
2338
2339     case OFPACT_SAMPLE:
2340         sample = ofpact_get_SAMPLE(a);
2341         ds_put_format(
2342             s, "sample(probability=%"PRIu16",collector_set_id=%"PRIu32
2343             ",obs_domain_id=%"PRIu32",obs_point_id=%"PRIu32")",
2344             sample->probability, sample->collector_set_id,
2345             sample->obs_domain_id, sample->obs_point_id);
2346         break;
2347
2348     case OFPACT_CLEAR_ACTIONS:
2349         ds_put_format(s, "%s",
2350                       ovs_instruction_name_from_type(
2351                           OVSINST_OFPIT11_CLEAR_ACTIONS));
2352         break;
2353
2354     case OFPACT_WRITE_METADATA:
2355         metadata = ofpact_get_WRITE_METADATA(a);
2356         ds_put_format(s, "%s:%#"PRIx64,
2357                       ovs_instruction_name_from_type(
2358                           OVSINST_OFPIT11_WRITE_METADATA),
2359                       ntohll(metadata->metadata));
2360         if (metadata->mask != htonll(UINT64_MAX)) {
2361             ds_put_format(s, "/%#"PRIx64, ntohll(metadata->mask));
2362         }
2363         break;
2364
2365     case OFPACT_GOTO_TABLE:
2366         ds_put_format(s, "%s:%"PRIu8,
2367                       ovs_instruction_name_from_type(
2368                           OVSINST_OFPIT11_GOTO_TABLE),
2369                       ofpact_get_GOTO_TABLE(a)->table_id);
2370         break;
2371
2372     case OFPACT_METER:
2373         ds_put_format(s, "%s:%"PRIu32,
2374                       ovs_instruction_name_from_type(OVSINST_OFPIT13_METER),
2375                       ofpact_get_METER(a)->meter_id);
2376         break;
2377     }
2378 }
2379
2380 /* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
2381  * 'ofpacts' to 'string'. */
2382 void
2383 ofpacts_format(const struct ofpact *ofpacts, size_t ofpacts_len,
2384                struct ds *string)
2385 {
2386     ds_put_cstr(string, "actions=");
2387     if (!ofpacts_len) {
2388         ds_put_cstr(string, "drop");
2389     } else {
2390         const struct ofpact *a;
2391
2392         OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
2393             if (a != ofpacts) {
2394                 ds_put_cstr(string, ",");
2395             }
2396
2397             /* XXX write-actions */
2398             ofpact_format(a, string);
2399         }
2400     }
2401 }
2402 \f
2403 /* Internal use by helpers. */
2404
2405 void *
2406 ofpact_put(struct ofpbuf *ofpacts, enum ofpact_type type, size_t len)
2407 {
2408     struct ofpact *ofpact;
2409
2410     ofpact_pad(ofpacts);
2411     ofpact = ofpacts->l2 = ofpbuf_put_uninit(ofpacts, len);
2412     ofpact_init(ofpact, type, len);
2413     return ofpact;
2414 }
2415
2416 void
2417 ofpact_init(struct ofpact *ofpact, enum ofpact_type type, size_t len)
2418 {
2419     memset(ofpact, 0, len);
2420     ofpact->type = type;
2421     ofpact->compat = OFPUTIL_ACTION_INVALID;
2422     ofpact->len = len;
2423 }
2424 \f
2425 /* Updates 'ofpact->len' to the number of bytes in the tail of 'ofpacts'
2426  * starting at 'ofpact'.
2427  *
2428  * This is the correct way to update a variable-length ofpact's length after
2429  * adding the variable-length part of the payload.  (See the large comment
2430  * near the end of ofp-actions.h for more information.) */
2431 void
2432 ofpact_update_len(struct ofpbuf *ofpacts, struct ofpact *ofpact)
2433 {
2434     ovs_assert(ofpact == ofpacts->l2);
2435     ofpact->len = (char *) ofpbuf_tail(ofpacts) - (char *) ofpact;
2436 }
2437
2438 /* Pads out 'ofpacts' to a multiple of OFPACT_ALIGNTO bytes in length.  Each
2439  * ofpact_put_<ENUM>() calls this function automatically beforehand, but the
2440  * client must call this itself after adding the final ofpact to an array of
2441  * them.
2442  *
2443  * (The consequences of failing to call this function are probably not dire.
2444  * OFPACT_FOR_EACH will calculate a pointer beyond the end of the ofpacts, but
2445  * not dereference it.  That's undefined behavior, technically, but it will not
2446  * cause a real problem on common systems.  Still, it seems better to call
2447  * it.) */
2448 void
2449 ofpact_pad(struct ofpbuf *ofpacts)
2450 {
2451     unsigned int rem = ofpacts->size % OFPACT_ALIGNTO;
2452     if (rem) {
2453         ofpbuf_put_zeros(ofpacts, OFPACT_ALIGNTO - rem);
2454     }
2455 }
2456
2457 void
2458 ofpact_set_field_init(struct ofpact_reg_load *load, const struct mf_field *mf,
2459                       const void *src)
2460 {
2461     load->ofpact.compat = OFPUTIL_OFPAT12_SET_FIELD;
2462     load->dst.field = mf;
2463     load->dst.ofs = 0;
2464     load->dst.n_bits = mf->n_bits;
2465     bitwise_copy(src, mf->n_bytes, load->dst.ofs,
2466                  &load->subvalue, sizeof load->subvalue, 0, mf->n_bits);
2467 }