lib/ofp-actions.h

   1 /*
   2  * Copyright (c) 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 #ifndef OFP_ACTIONS_H
  18 #define OFP_ACTIONS_H 1
  19
  20 #include <stddef.h>
  21 #include <stdint.h>
  22 #include "meta-flow.h"
  23 #include "ofp-errors.h"
  24 #include "ofp-util.h"
  25 #include "openflow/openflow.h"
  26 #include "openflow/nicira-ext.h"
  27 #include "openvswitch/types.h"
  28
  29 /* List of OVS abstracted actions.
  30  *
  31  * This macro is used directly only internally by this header, but the list is
  32  * still of interest to developers.
  33  *
  34  * Each DEFINE_OFPACT invocation has the following parameters:
  35  *
  36  * 1. <ENUM>, used below in the enum definition of OFPACT_<ENUM>, and
  37  *    elsewhere.
  38  *
  39  * 2. <STRUCT> corresponding to a structure "struct <STRUCT>", that must be
  40  *    defined below.  This structure must be an abstract definition of the
  41  *    action.  Its first member must have type "struct ofpact" and name
  42  *    "ofpact".  It may be fixed length or end with a flexible array member
  43  *    (e.g. "int member[];").
  44  *
  45  * 3. <MEMBER>, which has one of two possible values:
  46  *
  47  *        - If "struct <STRUCT>" is fixed-length, it must be "ofpact".
  48  *
  49  *        - If "struct <STRUCT>" is variable-length, it must be the name of the
  50  *          flexible array member.
  51  */
  52 #define OFPACTS                                                     \
  53     /* Output. */                                                   \
  54     DEFINE_OFPACT(OUTPUT,          ofpact_output,        ofpact)    \
  55     DEFINE_OFPACT(GROUP,           ofpact_group,         ofpact)    \
  56     DEFINE_OFPACT(CONTROLLER,      ofpact_controller,    ofpact)    \
  57     DEFINE_OFPACT(ENQUEUE,         ofpact_enqueue,       ofpact)    \
  58     DEFINE_OFPACT(OUTPUT_REG,      ofpact_output_reg,    ofpact)    \
  59     DEFINE_OFPACT(BUNDLE,          ofpact_bundle,        slaves)    \
  60                                                                     \
  61     /* Header changes. */                                           \
  62     DEFINE_OFPACT(SET_VLAN_VID,    ofpact_vlan_vid,      ofpact)    \
  63     DEFINE_OFPACT(SET_VLAN_PCP,    ofpact_vlan_pcp,      ofpact)    \
  64     DEFINE_OFPACT(STRIP_VLAN,      ofpact_null,          ofpact)    \
  65     DEFINE_OFPACT(PUSH_VLAN,       ofpact_null,          ofpact)    \
  66     DEFINE_OFPACT(SET_ETH_SRC,     ofpact_mac,           ofpact)    \
  67     DEFINE_OFPACT(SET_ETH_DST,     ofpact_mac,           ofpact)    \
  68     DEFINE_OFPACT(SET_IPV4_SRC,    ofpact_ipv4,          ofpact)    \
  69     DEFINE_OFPACT(SET_IPV4_DST,    ofpact_ipv4,          ofpact)    \
  70     DEFINE_OFPACT(SET_IP_DSCP,     ofpact_dscp,          ofpact)    \
  71     DEFINE_OFPACT(SET_IP_ECN,      ofpact_ecn,           ofpact)    \
  72     DEFINE_OFPACT(SET_IP_TTL,      ofpact_ip_ttl,        ofpact)    \
  73     DEFINE_OFPACT(SET_L4_SRC_PORT, ofpact_l4_port,       ofpact)    \
  74     DEFINE_OFPACT(SET_L4_DST_PORT, ofpact_l4_port,       ofpact)    \
  75     DEFINE_OFPACT(REG_MOVE,        ofpact_reg_move,      ofpact)    \
  76     DEFINE_OFPACT(REG_LOAD,        ofpact_reg_load,      ofpact)    \
  77     DEFINE_OFPACT(STACK_PUSH,      ofpact_stack,         ofpact)    \
  78     DEFINE_OFPACT(STACK_POP,       ofpact_stack,         ofpact)    \
  79     DEFINE_OFPACT(DEC_TTL,         ofpact_cnt_ids,       cnt_ids)   \
  80     DEFINE_OFPACT(SET_MPLS_TTL,    ofpact_mpls_ttl,      ofpact)    \
  81     DEFINE_OFPACT(DEC_MPLS_TTL,    ofpact_null,          ofpact)    \
  82     DEFINE_OFPACT(PUSH_MPLS,       ofpact_push_mpls,     ofpact)    \
  83     DEFINE_OFPACT(POP_MPLS,        ofpact_pop_mpls,      ofpact)    \
  84                                                                     \
  85     /* Metadata. */                                                 \
  86     DEFINE_OFPACT(SET_TUNNEL,      ofpact_tunnel,        ofpact)    \
  87     DEFINE_OFPACT(SET_QUEUE,       ofpact_queue,         ofpact)    \
  88     DEFINE_OFPACT(POP_QUEUE,       ofpact_null,          ofpact)    \
  89     DEFINE_OFPACT(FIN_TIMEOUT,     ofpact_fin_timeout,   ofpact)    \
  90                                                                     \
  91     /* Flow table interaction. */                                   \
  92     DEFINE_OFPACT(RESUBMIT,        ofpact_resubmit,      ofpact)    \
  93     DEFINE_OFPACT(LEARN,           ofpact_learn,         specs)     \
  94                                                                     \
  95     /* Arithmetic. */                                               \
  96     DEFINE_OFPACT(MULTIPATH,       ofpact_multipath,     ofpact)    \
  97                                                                     \
  98     /* Other. */                                                    \
  99     DEFINE_OFPACT(NOTE,            ofpact_note,          data)      \
 100     DEFINE_OFPACT(EXIT,            ofpact_null,          ofpact)    \
 101     DEFINE_OFPACT(SAMPLE,          ofpact_sample,        ofpact)    \
 102                                                                     \
 103     /* Instructions */                                              \
 104     DEFINE_OFPACT(METER,           ofpact_meter,         ofpact)    \
 105     DEFINE_OFPACT(CLEAR_ACTIONS,   ofpact_null,          ofpact)    \
 106     DEFINE_OFPACT(WRITE_ACTIONS,   ofpact_nest,          ofpact)    \
 107     DEFINE_OFPACT(WRITE_METADATA,  ofpact_metadata,      ofpact)    \
 108     DEFINE_OFPACT(GOTO_TABLE,      ofpact_goto_table,    ofpact)
 109
 110 /* enum ofpact_type, with a member OFPACT_<ENUM> for each action. */
 111 enum OVS_PACKED_ENUM ofpact_type {
 112 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) OFPACT_##ENUM,
 113     OFPACTS
 114 #undef DEFINE_OFPACT
 115 };
 116
 117 /* N_OFPACTS, the number of values of "enum ofpact_type". */
 118 enum {
 119     N_OFPACTS =
 120 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER) + 1
 121     OFPACTS
 122 #undef DEFINE_OFPACT
 123 };
 124
 125 /* Header for an action.
 126  *
 127  * Each action is a structure "struct ofpact_*" that begins with "struct
 128  * ofpact", usually followed by other data that describes the action.  Actions
 129  * are padded out to a multiple of OFPACT_ALIGNTO bytes in length.
 130  *
 131  * The 'compat' member is special:
 132  *
 133  *     - Most "struct ofpact"s correspond to one particular kind of OpenFlow
 134  *       action, at least in a given OpenFlow version.  For example,
 135  *       OFPACT_SET_VLAN_VID corresponds to OFPAT10_SET_VLAN_VID in OpenFlow
 136  *       1.0.
 137  *
 138  *       For such actions, the 'compat' member is not meaningful and generally
 139  *       should be zero.
 140  *
 141  *     - A few "struct ofpact"s correspond to multiple OpenFlow actions.  For
 142  *       example, OFPACT_SET_TUNNEL can be NXAST_SET_TUNNEL or
 143  *       NXAST_SET_TUNNEL64.  In these cases, if the "struct ofpact" originated
 144  *       from OpenFlow, then we want to make sure that, if it gets translated
 145  *       back to OpenFlow later, it is translated back to the same action type.
 146  *       (Otherwise, we'd violate the promise made in DESIGN, in the "Action
 147  *       Reproduction" section.)
 148  *
 149  *       For such actions, the 'compat' member should be the original action
 150  *       type.  (If the action didn't originate from OpenFlow, then setting
 151  *       'compat' to zero should be fine: code to translate the ofpact to
 152  *       OpenFlow must tolerate this case.)
 153  */
 154 struct ofpact {
 155     enum ofpact_type type;      /* OFPACT_*. */
 156     enum ofputil_action_code compat; /* Original type when added, if any. */
 157     uint16_t len;               /* Length of the action, in bytes, including
 158                                  * struct ofpact, excluding padding. */
 159 };
 160
 161 #ifdef __GNUC__
 162 /* Make sure that OVS_PACKED_ENUM really worked. */
 163 BUILD_ASSERT_DECL(sizeof(struct ofpact) == 4);
 164 #endif
 165
 166 /* Alignment. */
 167 #define OFPACT_ALIGNTO 8
 168 #define OFPACT_ALIGN(SIZE) ROUND_UP(SIZE, OFPACT_ALIGNTO)
 169
 170 static inline struct ofpact *
 171 ofpact_next(const struct ofpact *ofpact)
 172 {
 173     return (void *) ((uint8_t *) ofpact + OFPACT_ALIGN(ofpact->len));
 174 }
 175
 176 static inline struct ofpact *
 177 ofpact_end(const struct ofpact *ofpacts, size_t ofpacts_len)
 178 {
 179     return (void *) ((uint8_t *) ofpacts + ofpacts_len);
 180 }
 181
 182 /* Assigns POS to each ofpact, in turn, in the OFPACTS_LEN bytes of ofpacts
 183  * starting at OFPACTS. */
 184 #define OFPACT_FOR_EACH(POS, OFPACTS, OFPACTS_LEN)                      \
 185     for ((POS) = (OFPACTS); (POS) < ofpact_end(OFPACTS, OFPACTS_LEN);  \
 186          (POS) = ofpact_next(POS))
 187 \f
 188 /* Action structure for each OFPACT_*. */
 189
 190 /* OFPACT_STRIP_VLAN, OFPACT_POP_QUEUE, OFPACT_EXIT, OFPACT_CLEAR_ACTIONS.
 191  *
 192  * Used for OFPAT10_STRIP_VLAN, NXAST_POP_QUEUE, NXAST_EXIT,
 193  * OFPAT11_POP_VLAN, OFPIT11_CLEAR_ACTIONS.
 194  *
 195  * Action structure for actions that do not have any extra data beyond the
 196  * action type. */
 197 struct ofpact_null {
 198     struct ofpact ofpact;
 199 };
 200
 201 /* OFPACT_OUTPUT.
 202  *
 203  * Used for OFPAT10_OUTPUT. */
 204 struct ofpact_output {
 205     struct ofpact ofpact;
 206     ofp_port_t port;            /* Output port. */
 207     uint16_t max_len;           /* Max send len, for port OFPP_CONTROLLER. */
 208 };
 209
 210 /* OFPACT_CONTROLLER.
 211  *
 212  * Used for NXAST_CONTROLLER. */
 213 struct ofpact_controller {
 214     struct ofpact ofpact;
 215     uint16_t max_len;           /* Maximum length to send to controller. */
 216     uint16_t controller_id;     /* Controller ID to send packet-in. */
 217     enum ofp_packet_in_reason reason; /* Reason to put in packet-in. */
 218 };
 219
 220 /* OFPACT_ENQUEUE.
 221  *
 222  * Used for OFPAT10_ENQUEUE. */
 223 struct ofpact_enqueue {
 224     struct ofpact ofpact;
 225     ofp_port_t port;
 226     uint32_t queue;
 227 };
 228
 229 /* OFPACT_OUTPUT_REG.
 230  *
 231  * Used for NXAST_OUTPUT_REG. */
 232 struct ofpact_output_reg {
 233     struct ofpact ofpact;
 234     struct mf_subfield src;
 235     uint16_t max_len;
 236 };
 237
 238 /* OFPACT_BUNDLE.
 239  *
 240  * Used for NXAST_BUNDLE. */
 241 struct ofpact_bundle {
 242     struct ofpact ofpact;
 243
 244     /* Slave choice algorithm to apply to hash value. */
 245     enum nx_bd_algorithm algorithm;
 246
 247     /* What fields to hash and how. */
 248     enum nx_hash_fields fields;
 249     uint16_t basis;             /* Universal hash parameter. */
 250
 251     struct mf_subfield dst;
 252
 253     /* Slaves for output. */
 254     unsigned int n_slaves;
 255     ofp_port_t slaves[];
 256 };
 257
 258 /* OFPACT_SET_VLAN_VID.
 259  *
 260  * We keep track if vlan was present at action validation time to avoid a
 261  * PUSH_VLAN when translating to OpenFlow 1.1+.
 262  *
 263  * We also keep the originating OFPUTIL action code in ofpact.compat.
 264  *
 265  * Used for OFPAT10_SET_VLAN_VID and OFPAT11_SET_VLAN_VID. */
 266 struct ofpact_vlan_vid {
 267     struct ofpact ofpact;
 268     uint16_t vlan_vid;          /* VLAN VID in low 12 bits, 0 in other bits. */
 269     bool push_vlan_if_needed;   /* OF 1.0 semantics if true. */
 270     bool flow_has_vlan;         /* VLAN present at action validation time? */
 271 };
 272
 273 /* OFPACT_SET_VLAN_PCP.
 274  *
 275  * We keep track if vlan was present at action validation time to avoid a
 276  * PUSH_VLAN when translating to OpenFlow 1.1+.
 277  *
 278  * We also keep the originating OFPUTIL action code in ofpact.compat.
 279  *
 280  * Used for OFPAT10_SET_VLAN_PCP and OFPAT11_SET_VLAN_PCP. */
 281 struct ofpact_vlan_pcp {
 282     struct ofpact ofpact;
 283     uint8_t vlan_pcp;           /* VLAN PCP in low 3 bits, 0 in other bits. */
 284     bool push_vlan_if_needed;   /* OF 1.0 semantics if true. */
 285     bool flow_has_vlan;         /* VLAN present at action validation time? */
 286 };
 287
 288 /* OFPACT_SET_ETH_SRC, OFPACT_SET_ETH_DST.
 289  *
 290  * Used for OFPAT10_SET_DL_SRC, OFPAT10_SET_DL_DST. */
 291 struct ofpact_mac {
 292     struct ofpact ofpact;
 293     uint8_t mac[ETH_ADDR_LEN];
 294 };
 295
 296 /* OFPACT_SET_IPV4_SRC, OFPACT_SET_IPV4_DST.
 297  *
 298  * Used for OFPAT10_SET_NW_SRC, OFPAT10_SET_NW_DST. */
 299 struct ofpact_ipv4 {
 300     struct ofpact ofpact;
 301     ovs_be32 ipv4;
 302 };
 303
 304 /* OFPACT_SET_IP_DSCP.
 305  *
 306  * Used for OFPAT10_SET_NW_TOS. */
 307 struct ofpact_dscp {
 308     struct ofpact ofpact;
 309     uint8_t dscp;               /* DSCP in high 6 bits, rest ignored. */
 310 };
 311
 312 /* OFPACT_SET_IP_ECN.
 313  *
 314  * Used for OFPAT11_SET_NW_ECN. */
 315 struct ofpact_ecn {
 316     struct ofpact ofpact;
 317     uint8_t ecn;               /* ECN in low 2 bits, rest ignored. */
 318 };
 319
 320 /* OFPACT_SET_IP_TTL.
 321  *
 322  * Used for OFPAT11_SET_NW_TTL. */
 323 struct ofpact_ip_ttl {
 324     struct ofpact ofpact;
 325     uint8_t ttl;
 326 };
 327
 328 /* OFPACT_SET_L4_SRC_PORT, OFPACT_SET_L4_DST_PORT.
 329  *
 330  * Used for OFPAT10_SET_TP_SRC, OFPAT10_SET_TP_DST. */
 331 struct ofpact_l4_port {
 332     struct ofpact ofpact;
 333     uint16_t port;              /* TCP or UDP port number. */
 334 };
 335
 336 /* OFPACT_REG_MOVE.
 337  *
 338  * Used for NXAST_REG_MOVE. */
 339 struct ofpact_reg_move {
 340     struct ofpact ofpact;
 341     struct mf_subfield src;
 342     struct mf_subfield dst;
 343 };
 344
 345 /* OFPACT_STACK_PUSH.
 346  *
 347  * Used for NXAST_STACK_PUSH and NXAST_STACK_POP. */
 348 struct ofpact_stack {
 349     struct ofpact ofpact;
 350     struct mf_subfield subfield;
 351 };
 352
 353 /* OFPACT_REG_LOAD.
 354  *
 355  * Used for NXAST_REG_LOAD, OFPAT12_SET_FIELD. */
 356 struct ofpact_reg_load {
 357     struct ofpact ofpact;
 358     struct mf_subfield dst;
 359     union mf_subvalue subvalue; /* Least-significant bits are used. */
 360 };
 361
 362 /* The position in the packet at which to insert an MPLS header.
 363  *
 364  * Used NXAST_PUSH_MPLS, OFPAT11_PUSH_MPLS. */
 365 enum ofpact_mpls_position {
 366     /* Add the MPLS LSE after the Ethernet header but before any VLAN tags.
 367      * OpenFlow 1.3+ requires this behavior. */
 368    OFPACT_MPLS_BEFORE_VLAN,
 369
 370    /* Add the MPLS LSE after the Ethernet header and any VLAN tags.
 371     * OpenFlow 1.1 and 1.2 require this behavior. */
 372    OFPACT_MPLS_AFTER_VLAN
 373 };
 374
 375 /* OFPACT_PUSH_VLAN/MPLS/PBB
 376  *
 377  * Used for NXAST_PUSH_MPLS, OFPAT11_PUSH_MPLS. */
 378 struct ofpact_push_mpls {
 379     struct ofpact ofpact;
 380     ovs_be16 ethertype;
 381     enum ofpact_mpls_position position;
 382 };
 383
 384 /* OFPACT_POP_MPLS
 385  *
 386  * Used for NXAST_POP_MPLS, OFPAT11_POP_MPLS.. */
 387 struct ofpact_pop_mpls {
 388     struct ofpact ofpact;
 389     ovs_be16 ethertype;
 390 };
 391
 392 /* OFPACT_SET_TUNNEL.
 393  *
 394  * Used for NXAST_SET_TUNNEL, NXAST_SET_TUNNEL64. */
 395 struct ofpact_tunnel {
 396     struct ofpact ofpact;
 397     uint64_t tun_id;
 398 };
 399
 400 /* OFPACT_SET_QUEUE.
 401  *
 402  * Used for NXAST_SET_QUEUE. */
 403 struct ofpact_queue {
 404     struct ofpact ofpact;
 405     uint32_t queue_id;
 406 };
 407
 408 /* OFPACT_FIN_TIMEOUT.
 409  *
 410  * Used for NXAST_FIN_TIMEOUT. */
 411 struct ofpact_fin_timeout {
 412     struct ofpact ofpact;
 413     uint16_t fin_idle_timeout;
 414     uint16_t fin_hard_timeout;
 415 };
 416
 417 /* OFPACT_WRITE_METADATA.
 418  *
 419  * Used for NXAST_WRITE_METADATA. */
 420 struct ofpact_metadata {
 421     struct ofpact ofpact;
 422     ovs_be64 metadata;
 423     ovs_be64 mask;
 424 };
 425
 426 /* OFPACT_METER.
 427  *
 428  * Used for OFPIT13_METER. */
 429 struct ofpact_meter {
 430     struct ofpact ofpact;
 431     uint32_t meter_id;
 432 };
 433
 434 /* OFPACT_WRITE_ACTIONS.
 435  *
 436  * Used for OFPIT11_WRITE_ACTIONS. */
 437 struct ofpact_nest {
 438     struct ofpact ofpact;
 439     uint8_t pad[OFPACT_ALIGN(sizeof(struct ofpact)) - sizeof(struct ofpact)];
 440     struct ofpact actions[];
 441 };
 442 BUILD_ASSERT_DECL(offsetof(struct ofpact_nest, actions) == OFPACT_ALIGNTO);
 443
 444 static inline size_t
 445 ofpact_nest_get_action_len(const struct ofpact_nest *on)
 446 {
 447     return on->ofpact.len - offsetof(struct ofpact_nest, actions);
 448 }
 449
 450 void ofpacts_execute_action_set(struct ofpbuf *action_list,
 451                                 const struct ofpbuf *action_set);
 452
 453 /* OFPACT_RESUBMIT.
 454  *
 455  * Used for NXAST_RESUBMIT, NXAST_RESUBMIT_TABLE. */
 456 struct ofpact_resubmit {
 457     struct ofpact ofpact;
 458     ofp_port_t in_port;
 459     uint8_t table_id;
 460 };
 461
 462 /* Part of struct ofpact_learn, below. */
 463 struct ofpact_learn_spec {
 464     int n_bits;                 /* Number of bits in source and dest. */
 465
 466     int src_type;               /* One of NX_LEARN_SRC_*. */
 467     struct mf_subfield src;     /* NX_LEARN_SRC_FIELD only. */
 468     union mf_subvalue src_imm;  /* NX_LEARN_SRC_IMMEDIATE only. */
 469
 470     int dst_type;             /* One of NX_LEARN_DST_*. */
 471     struct mf_subfield dst;   /* NX_LEARN_DST_MATCH, NX_LEARN_DST_LOAD only. */
 472 };
 473
 474 /* OFPACT_LEARN.
 475  *
 476  * Used for NXAST_LEARN. */
 477 struct ofpact_learn {
 478     struct ofpact ofpact;
 479
 480     uint16_t idle_timeout;      /* Idle time before discarding (seconds). */
 481     uint16_t hard_timeout;      /* Max time before discarding (seconds). */
 482     uint16_t priority;          /* Priority level of flow entry. */
 483     uint64_t cookie;            /* Cookie for new flow. */
 484     enum ofputil_flow_mod_flags flags;
 485     uint8_t table_id;           /* Table to insert flow entry. */
 486     uint16_t fin_idle_timeout;  /* Idle timeout after FIN, if nonzero. */
 487     uint16_t fin_hard_timeout;  /* Hard timeout after FIN, if nonzero. */
 488
 489     unsigned int n_specs;
 490     struct ofpact_learn_spec specs[];
 491 };
 492
 493 /* OFPACT_MULTIPATH.
 494  *
 495  * Used for NXAST_MULTIPATH. */
 496 struct ofpact_multipath {
 497     struct ofpact ofpact;
 498
 499     /* What fields to hash and how. */
 500     enum nx_hash_fields fields;
 501     uint16_t basis;             /* Universal hash parameter. */
 502
 503     /* Multipath link choice algorithm to apply to hash value. */
 504     enum nx_mp_algorithm algorithm;
 505     uint16_t max_link;          /* Number of output links, minus 1. */
 506     uint32_t arg;               /* Algorithm-specific argument. */
 507
 508     /* Where to store the result. */
 509     struct mf_subfield dst;
 510 };
 511
 512 /* OFPACT_NOTE.
 513  *
 514  * Used for NXAST_NOTE. */
 515 struct ofpact_note {
 516     struct ofpact ofpact;
 517     size_t length;
 518     uint8_t data[];
 519 };
 520
 521 /* OFPACT_SAMPLE.
 522  *
 523  * Used for NXAST_SAMPLE. */
 524 struct ofpact_sample {
 525     struct ofpact ofpact;
 526     uint16_t probability;  // Always >0.
 527     uint32_t collector_set_id;
 528     uint32_t obs_domain_id;
 529     uint32_t obs_point_id;
 530 };
 531
 532 /* OFPACT_DEC_TTL.
 533  *
 534  * Used for OFPAT11_DEC_NW_TTL, NXAST_DEC_TTL and NXAST_DEC_TTL_CNT_IDS. */
 535 struct ofpact_cnt_ids {
 536     struct ofpact ofpact;
 537
 538     /* Controller ids. */
 539     unsigned int n_controllers;
 540     uint16_t cnt_ids[];
 541 };
 542
 543 /* OFPACT_SET_MPLS_TTL.
 544  *
 545  * Used for NXAST_SET_MPLS_TTL */
 546 struct ofpact_mpls_ttl {
 547     struct ofpact ofpact;
 548
 549     uint8_t ttl;
 550 };
 551
 552 /* OFPACT_GOTO_TABLE
 553  *
 554  * Used for OFPIT11_GOTO_TABLE */
 555 struct ofpact_goto_table {
 556     struct ofpact ofpact;
 557     uint8_t table_id;
 558 };
 559
 560 /* OFPACT_GROUP.
 561  *
 562  * Used for OFPAT11_GROUP. */
 563 struct ofpact_group {
 564     struct ofpact ofpact;
 565     uint32_t group_id;
 566 };
 567
 568 /* Converting OpenFlow to ofpacts. */
 569 enum ofperr ofpacts_pull_openflow10(struct ofpbuf *openflow,
 570                                     unsigned int actions_len,
 571                                     struct ofpbuf *ofpacts);
 572 enum ofperr ofpacts_pull_openflow11_actions(struct ofpbuf *openflow,
 573                                             enum ofp_version version,
 574                                             unsigned int actions_len,
 575                                             struct ofpbuf *ofpacts);
 576 enum ofperr ofpacts_pull_openflow11_instructions(struct ofpbuf *openflow,
 577                                                  enum ofp_version version,
 578                                                  unsigned int instructions_len,
 579                                                  struct ofpbuf *ofpacts);
 580 enum ofperr ofpacts_check(struct ofpact[], size_t ofpacts_len,
 581                           struct flow *, ofp_port_t max_ports,
 582                           uint8_t table_id, bool enforce_consistency);
 583 enum ofperr ofpacts_verify(const struct ofpact ofpacts[], size_t ofpacts_len);
 584
 585 /* Converting ofpacts to OpenFlow. */
 586 void ofpacts_put_openflow10(const struct ofpact[], size_t ofpacts_len,
 587                             struct ofpbuf *openflow);
 588 size_t ofpacts_put_openflow11_actions(const struct ofpact[], size_t ofpacts_len,
 589                                       struct ofpbuf *openflow);
 590 void ofpacts_put_openflow11_instructions(const struct ofpact[],
 591                                          size_t ofpacts_len,
 592                                          struct ofpbuf *openflow);
 593
 594 /* Working with ofpacts. */
 595 bool ofpacts_output_to_port(const struct ofpact[], size_t ofpacts_len,
 596                             ofp_port_t port);
 597 bool ofpacts_output_to_group(const struct ofpact[], size_t ofpacts_len,
 598                              uint32_t group_id);
 599 bool ofpacts_equal(const struct ofpact a[], size_t a_len,
 600                    const struct ofpact b[], size_t b_len);
 601 uint32_t ofpacts_get_meter(const struct ofpact[], size_t ofpacts_len);
 602
 603 /* Formatting ofpacts.
 604  *
 605  * (For parsing ofpacts, see ofp-parse.h.) */
 606 void ofpacts_format(const struct ofpact[], size_t ofpacts_len, struct ds *);
 607
 608 /* Internal use by the helpers below. */
 609 void ofpact_init(struct ofpact *, enum ofpact_type, size_t len);
 610 void *ofpact_put(struct ofpbuf *, enum ofpact_type, size_t len);
 611
 612 /* For each OFPACT_<ENUM> with a corresponding struct <STRUCT>, this defines
 613  * the following commonly useful functions:
 614  *
 615  *   struct <STRUCT> *ofpact_put_<ENUM>(struct ofpbuf *ofpacts);
 616  *
 617  *     Appends a new 'ofpact', of length OFPACT_<ENUM>_RAW_SIZE, to 'ofpacts',
 618  *     initializes it with ofpact_init_<ENUM>(), and returns it.  Also sets
 619  *     'ofpacts->l2' to the returned action.
 620  *
 621  *     After using this function to add a variable-length action, add the
 622  *     elements of the flexible array (e.g. with ofpbuf_put()), then use
 623  *     ofpact_update_len() to update the length embedded into the action.
 624  *     (Keep in mind the need to refresh the structure from 'ofpacts->l2' after
 625  *     adding data to 'ofpacts'.)
 626  *
 627  *   struct <STRUCT> *ofpact_get_<ENUM>(const struct ofpact *ofpact);
 628  *
 629  *     Returns 'ofpact' cast to "struct <STRUCT> *".  'ofpact->type' must be
 630  *     OFPACT_<ENUM>.
 631  *
 632  * as well as the following more rarely useful definitions:
 633  *
 634  *   void ofpact_init_<ENUM>(struct <STRUCT> *ofpact);
 635  *
 636  *     Initializes the parts of 'ofpact' that identify it as having type
 637  *     OFPACT_<ENUM> and length OFPACT_<ENUM>_RAW_SIZE and zeros the rest.
 638  *
 639  *   <ENUM>_RAW_SIZE
 640  *
 641  *     The size of the action structure.  For a fixed-length action, this is
 642  *     sizeof(struct <STRUCT>).  For a variable-length action, this is the
 643  *     offset to the variable-length part.
 644  *
 645  *   <ENUM>_SIZE
 646  *
 647  *     An integer constant, the value of OFPACT_<ENUM>_RAW_SIZE rounded up to a
 648  *     multiple of OFPACT_ALIGNTO.
 649  */
 650 #define DEFINE_OFPACT(ENUM, STRUCT, MEMBER)                             \
 651     BUILD_ASSERT_DECL(offsetof(struct STRUCT, ofpact) == 0);            \
 652                                                                         \
 653     enum { OFPACT_##ENUM##_RAW_SIZE                                     \
 654            = (offsetof(struct STRUCT, MEMBER)                           \
 655               ? offsetof(struct STRUCT, MEMBER)                         \
 656               : sizeof(struct STRUCT)) };                               \
 657                                                                         \
 658     enum { OFPACT_##ENUM##_SIZE                                         \
 659            = ROUND_UP(OFPACT_##ENUM##_RAW_SIZE, OFPACT_ALIGNTO) };      \
 660                                                                         \
 661     static inline struct STRUCT *                                       \
 662     ofpact_get_##ENUM(const struct ofpact *ofpact)                      \
 663     {                                                                   \
 664         ovs_assert(ofpact->type == OFPACT_##ENUM);                      \
 665         return ALIGNED_CAST(struct STRUCT *, ofpact);                   \
 666     }                                                                   \
 667                                                                         \
 668     static inline struct STRUCT *                                       \
 669     ofpact_put_##ENUM(struct ofpbuf *ofpacts)                           \
 670     {                                                                   \
 671         return ofpact_put(ofpacts, OFPACT_##ENUM,                       \
 672                           OFPACT_##ENUM##_RAW_SIZE);                    \
 673     }                                                                   \
 674                                                                         \
 675     static inline void                                                  \
 676     ofpact_init_##ENUM(struct STRUCT *ofpact)                           \
 677     {                                                                   \
 678         ofpact_init(&ofpact->ofpact, OFPACT_##ENUM,                     \
 679                     OFPACT_##ENUM##_RAW_SIZE);                          \
 680     }
 681 OFPACTS
 682 #undef DEFINE_OFPACT
 683
 684 /* Functions to use after adding ofpacts to a buffer. */
 685 void ofpact_update_len(struct ofpbuf *, struct ofpact *);
 686 void ofpact_pad(struct ofpbuf *);
 687
 688 /* OpenFlow 1.1 instructions.
 689  * The order is sorted in execution order. Not in the value of OFPIT11_xxx.
 690  * It is enforced on parser from text string.
 691  */
 692 #define OVS_INSTRUCTIONS                                    \
 693     DEFINE_INST(OFPIT13_METER,                              \
 694                 ofp13_instruction_meter,          false,    \
 695                 "meter")                                    \
 696                                                             \
 697     DEFINE_INST(OFPIT11_APPLY_ACTIONS,                      \
 698                 ofp11_instruction_actions,        true,     \
 699                 "apply_actions")                            \
 700                                                             \
 701     DEFINE_INST(OFPIT11_CLEAR_ACTIONS,                      \
 702                 ofp11_instruction,                false,    \
 703                 "clear_actions")                            \
 704                                                             \
 705     DEFINE_INST(OFPIT11_WRITE_ACTIONS,                      \
 706                 ofp11_instruction_actions,        true,     \
 707                 "write_actions")                            \
 708                                                             \
 709     DEFINE_INST(OFPIT11_WRITE_METADATA,                     \
 710                 ofp11_instruction_write_metadata, false,    \
 711                 "write_metadata")                           \
 712                                                             \
 713     DEFINE_INST(OFPIT11_GOTO_TABLE,                         \
 714                 ofp11_instruction_goto_table,     false,    \
 715                 "goto_table")
 716
 717 enum ovs_instruction_type {
 718 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) OVSINST_##ENUM,
 719     OVS_INSTRUCTIONS
 720 #undef DEFINE_INST
 721 };
 722
 723 enum {
 724 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
 725     N_OVS_INSTRUCTIONS = OVS_INSTRUCTIONS
 726 #undef DEFINE_INST
 727 };
 728
 729 const char *ovs_instruction_name_from_type(enum ovs_instruction_type type);
 730 int ovs_instruction_type_from_name(const char *name);
 731 enum ovs_instruction_type ovs_instruction_type_from_ofpact_type(
 732     enum ofpact_type);
 733
 734 void ofpact_set_field_init(struct ofpact_reg_load *load,
 735                            const struct mf_field *mf, const void *src);
 736 #endif /* ofp-actions.h */