lib/ofp-actions.h

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