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