lib/ofp-actions.h

   1 /*
   2  * Copyright (c) 2012, 2013, 2014, 2015, 2016 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 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  * 4. <NAME>, a quoted string that gives the name of the action, for use in
  53  *    parsing actions from text.
  54  */
  55 #define OFPACTS                                                         \
  56     /* Output. */                                                       \
  57     OFPACT(OUTPUT,          ofpact_output,      ofpact, "output")       \
  58     OFPACT(GROUP,           ofpact_group,       ofpact, "group")        \
  59     OFPACT(CONTROLLER,      ofpact_controller,  userdata, "controller") \
  60     OFPACT(ENQUEUE,         ofpact_enqueue,     ofpact, "enqueue")      \
  61     OFPACT(OUTPUT_REG,      ofpact_output_reg,  ofpact, "output_reg")   \
  62     OFPACT(BUNDLE,          ofpact_bundle,      slaves, "bundle")       \
  63                                                                         \
  64     /* Header changes. */                                               \
  65     OFPACT(SET_FIELD,       ofpact_set_field,   ofpact, "set_field")    \
  66     OFPACT(SET_VLAN_VID,    ofpact_vlan_vid,    ofpact, "set_vlan_vid") \
  67     OFPACT(SET_VLAN_PCP,    ofpact_vlan_pcp,    ofpact, "set_vlan_pcp") \
  68     OFPACT(STRIP_VLAN,      ofpact_null,        ofpact, "strip_vlan")   \
  69     OFPACT(PUSH_VLAN,       ofpact_null,        ofpact, "push_vlan")    \
  70     OFPACT(SET_ETH_SRC,     ofpact_mac,         ofpact, "mod_dl_src")   \
  71     OFPACT(SET_ETH_DST,     ofpact_mac,         ofpact, "mod_dl_dst")   \
  72     OFPACT(SET_IPV4_SRC,    ofpact_ipv4,        ofpact, "mod_nw_src")   \
  73     OFPACT(SET_IPV4_DST,    ofpact_ipv4,        ofpact, "mod_nw_dst")   \
  74     OFPACT(SET_IP_DSCP,     ofpact_dscp,        ofpact, "mod_nw_tos")   \
  75     OFPACT(SET_IP_ECN,      ofpact_ecn,         ofpact, "mod_nw_ecn")   \
  76     OFPACT(SET_IP_TTL,      ofpact_ip_ttl,      ofpact, "mod_nw_ttl")   \
  77     OFPACT(SET_L4_SRC_PORT, ofpact_l4_port,     ofpact, "mod_tp_src")   \
  78     OFPACT(SET_L4_DST_PORT, ofpact_l4_port,     ofpact, "mod_tp_dst")   \
  79     OFPACT(REG_MOVE,        ofpact_reg_move,    ofpact, "move")         \
  80     OFPACT(STACK_PUSH,      ofpact_stack,       ofpact, "push")         \
  81     OFPACT(STACK_POP,       ofpact_stack,       ofpact, "pop")          \
  82     OFPACT(DEC_TTL,         ofpact_cnt_ids,     cnt_ids, "dec_ttl")     \
  83     OFPACT(SET_MPLS_LABEL,  ofpact_mpls_label,  ofpact, "set_mpls_label") \
  84     OFPACT(SET_MPLS_TC,     ofpact_mpls_tc,     ofpact, "set_mpls_tc")  \
  85     OFPACT(SET_MPLS_TTL,    ofpact_mpls_ttl,    ofpact, "set_mpls_ttl") \
  86     OFPACT(DEC_MPLS_TTL,    ofpact_null,        ofpact, "dec_mpls_ttl") \
  87     OFPACT(PUSH_MPLS,       ofpact_push_mpls,   ofpact, "push_mpls")    \
  88     OFPACT(POP_MPLS,        ofpact_pop_mpls,    ofpact, "pop_mpls")     \
  89                                                                         \
  90     /* Metadata. */                                                     \
  91     OFPACT(SET_TUNNEL,      ofpact_tunnel,      ofpact, "set_tunnel")   \
  92     OFPACT(SET_QUEUE,       ofpact_queue,       ofpact, "set_queue")    \
  93     OFPACT(POP_QUEUE,       ofpact_null,        ofpact, "pop_queue")    \
  94     OFPACT(FIN_TIMEOUT,     ofpact_fin_timeout, ofpact, "fin_timeout")  \
  95                                                                         \
  96     /* Flow table interaction. */                                       \
  97     OFPACT(RESUBMIT,        ofpact_resubmit,    ofpact, "resubmit")     \
  98     OFPACT(LEARN,           ofpact_learn,       specs, "learn")         \
  99     OFPACT(CONJUNCTION,     ofpact_conjunction, ofpact, "conjunction")  \
 100                                                                         \
 101     /* Arithmetic. */                                                   \
 102     OFPACT(MULTIPATH,       ofpact_multipath,   ofpact, "multipath")    \
 103                                                                         \
 104     /* Other. */                                                        \
 105     OFPACT(NOTE,            ofpact_note,        data, "note")           \
 106     OFPACT(EXIT,            ofpact_null,        ofpact, "exit")         \
 107     OFPACT(SAMPLE,          ofpact_sample,      ofpact, "sample")       \
 108     OFPACT(UNROLL_XLATE,    ofpact_unroll_xlate, ofpact, "unroll_xlate") \
 109     OFPACT(CT,              ofpact_conntrack,   ofpact, "ct")           \
 110     OFPACT(NAT,             ofpact_nat,         ofpact, "nat")          \
 111                                                                         \
 112     /* Debugging actions.                                               \
 113      *                                                                  \
 114      * These are intentionally undocumented, subject to change, and     \
 115      * only accepted if ovs-vswitchd is started with --enable-dummy. */ \
 116     OFPACT(DEBUG_RECIRC, ofpact_null,           ofpact, "debug_recirc") \
 117                                                                         \
 118     /* Instructions. */                                                 \
 119     OFPACT(METER,           ofpact_meter,       ofpact, "meter")        \
 120     OFPACT(CLEAR_ACTIONS,   ofpact_null,        ofpact, "clear_actions") \
 121     OFPACT(WRITE_ACTIONS,   ofpact_nest,        ofpact, "write_actions") \
 122     OFPACT(WRITE_METADATA,  ofpact_metadata,    ofpact, "write_metadata") \
 123     OFPACT(GOTO_TABLE,      ofpact_goto_table,  ofpact, "goto_table")
 124
 125 /* enum ofpact_type, with a member OFPACT_<ENUM> for each action. */
 126 enum OVS_PACKED_ENUM ofpact_type {
 127 #define OFPACT(ENUM, STRUCT, MEMBER, NAME) OFPACT_##ENUM,
 128     OFPACTS
 129 #undef OFPACT
 130 };
 131
 132 /* Define N_OFPACTS to the number of types of ofpacts. */
 133 enum {
 134 #define OFPACT(ENUM, STRUCT, MEMBER, NAME) + 1
 135     N_OFPACTS = OFPACTS
 136 #undef OFPACT
 137 };
 138
 139 /* Header for an action.
 140  *
 141  * Each action is a structure "struct ofpact_*" that begins with "struct
 142  * ofpact", usually followed by other data that describes the action.  Actions
 143  * are padded out to a multiple of OFPACT_ALIGNTO bytes in length.
 144  *
 145  * The 'raw' member is special:
 146  *
 147  *     - Most "struct ofpact"s correspond to one particular kind of OpenFlow
 148  *       action, at least in a given OpenFlow version.  For example,
 149  *       OFPACT_SET_VLAN_VID corresponds to OFPAT10_SET_VLAN_VID in OpenFlow
 150  *       1.0.
 151  *
 152  *       For such actions, the 'raw' member is not meaningful and generally
 153  *       should be zero.
 154  *
 155  *     - A few "struct ofpact"s correspond to multiple OpenFlow actions.  For
 156  *       example, OFPACT_SET_TUNNEL can be NXAST_SET_TUNNEL or
 157  *       NXAST_SET_TUNNEL64.  In these cases, if the "struct ofpact" originated
 158  *       from OpenFlow, then we want to make sure that, if it gets translated
 159  *       back to OpenFlow later, it is translated back to the same action type.
 160  *       (Otherwise, we'd violate the promise made in DESIGN, in the "Action
 161  *       Reproduction" section.)
 162  *
 163  *       For such actions, the 'raw' member should be the "enum ofp_raw_action"
 164  *       originally extracted from the OpenFlow action.  (If the action didn't
 165  *       originate from OpenFlow, then setting 'raw' to zero should be fine:
 166  *       code to translate the ofpact to OpenFlow must tolerate this case.)
 167  */
 168 struct ofpact {
 169     /* We want the space advantage of an 8-bit type here on every
 170      * implementation, without giving up the advantage of having a useful type
 171      * on implementations that support packed enums. */
 172 #ifdef HAVE_PACKED_ENUM
 173     enum ofpact_type type;      /* OFPACT_*. */
 174 #else
 175     uint8_t type;               /* OFPACT_* */
 176 #endif
 177
 178     uint8_t raw;                /* Original type when added, if any. */
 179     uint16_t len;               /* Length of the action, in bytes, including
 180                                  * struct ofpact, excluding padding. */
 181 };
 182 BUILD_ASSERT_DECL(sizeof(struct ofpact) == 4);
 183
 184 /* Alignment. */
 185 #define OFPACT_ALIGNTO 8
 186 #define OFPACT_ALIGN(SIZE) ROUND_UP(SIZE, OFPACT_ALIGNTO)
 187
 188 /* Returns the ofpact following 'ofpact'. */
 189 static inline struct ofpact *
 190 ofpact_next(const struct ofpact *ofpact)
 191 {
 192     return (void *) ((uint8_t *) ofpact + OFPACT_ALIGN(ofpact->len));
 193 }
 194
 195 struct ofpact *ofpact_next_flattened(const struct ofpact *);
 196
 197 static inline struct ofpact *
 198 ofpact_end(const struct ofpact *ofpacts, size_t ofpacts_len)
 199 {
 200     return (void *) ((uint8_t *) ofpacts + ofpacts_len);
 201 }
 202
 203 /* Assigns POS to each ofpact, in turn, in the OFPACTS_LEN bytes of ofpacts
 204  * starting at OFPACTS. */
 205 #define OFPACT_FOR_EACH(POS, OFPACTS, OFPACTS_LEN)                      \
 206     for ((POS) = (OFPACTS); (POS) < ofpact_end(OFPACTS, OFPACTS_LEN);  \
 207          (POS) = ofpact_next(POS))
 208
 209 /* Assigns POS to each ofpact, in turn, in the OFPACTS_LEN bytes of ofpacts
 210  * starting at OFPACTS.
 211  *
 212  * For ofpacts that contain nested ofpacts, this visits each of the inner
 213  * ofpacts as well. */
 214 #define OFPACT_FOR_EACH_FLATTENED(POS, OFPACTS, OFPACTS_LEN)           \
 215     for ((POS) = (OFPACTS); (POS) < ofpact_end(OFPACTS, OFPACTS_LEN);  \
 216          (POS) = ofpact_next_flattened(POS))
 217 \f
 218 /* Action structure for each OFPACT_*. */
 219
 220 /* OFPACT_STRIP_VLAN, OFPACT_POP_QUEUE, OFPACT_EXIT, OFPACT_CLEAR_ACTIONS.
 221  *
 222  * Used for OFPAT10_STRIP_VLAN, NXAST_POP_QUEUE, NXAST_EXIT,
 223  * OFPAT11_POP_VLAN, OFPIT11_CLEAR_ACTIONS.
 224  *
 225  * Action structure for actions that do not have any extra data beyond the
 226  * action type. */
 227 struct ofpact_null {
 228     struct ofpact ofpact;
 229 };
 230
 231 /* OFPACT_OUTPUT.
 232  *
 233  * Used for OFPAT10_OUTPUT. */
 234 struct ofpact_output {
 235     struct ofpact ofpact;
 236     ofp_port_t port;            /* Output port. */
 237     uint16_t max_len;           /* Max send len, for port OFPP_CONTROLLER. */
 238 };
 239
 240 /* OFPACT_CONTROLLER.
 241  *
 242  * Used for NXAST_CONTROLLER. */
 243 struct ofpact_controller {
 244     struct ofpact ofpact;
 245     uint16_t max_len;           /* Maximum length to send to controller. */
 246     uint16_t controller_id;     /* Controller ID to send packet-in. */
 247     enum ofp_packet_in_reason reason; /* Reason to put in packet-in. */
 248
 249     /* Arbitrary data to include in the packet-in message (currently, only in
 250      * NXT_PACKET_IN2). */
 251     uint16_t userdata_len;
 252     uint8_t userdata[];
 253 };
 254
 255 /* OFPACT_ENQUEUE.
 256  *
 257  * Used for OFPAT10_ENQUEUE. */
 258 struct ofpact_enqueue {
 259     struct ofpact ofpact;
 260     ofp_port_t port;
 261     uint32_t queue;
 262 };
 263
 264 /* OFPACT_OUTPUT_REG.
 265  *
 266  * Used for NXAST_OUTPUT_REG. */
 267 struct ofpact_output_reg {
 268     struct ofpact ofpact;
 269     uint16_t max_len;
 270     struct mf_subfield src;
 271 };
 272
 273 /* Bundle slave choice algorithm to apply.
 274  *
 275  * In the descriptions below, 'slaves' is the list of possible slaves in the
 276  * order they appear in the OpenFlow action. */
 277 enum nx_bd_algorithm {
 278     /* Chooses the first live slave listed in the bundle.
 279      *
 280      * O(n_slaves) performance. */
 281     NX_BD_ALG_ACTIVE_BACKUP = 0,
 282
 283     /* Highest Random Weight.
 284      *
 285      * for i in [0,n_slaves):
 286      *   weights[i] = hash(flow, i)
 287      * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
 288      *
 289      * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
 290      * O(n_slaves) performance.
 291      *
 292      * Uses the 'fields' and 'basis' parameters. */
 293     NX_BD_ALG_HRW = 1
 294 };
 295
 296 /* OFPACT_BUNDLE.
 297  *
 298  * Used for NXAST_BUNDLE. */
 299 struct ofpact_bundle {
 300     struct ofpact ofpact;
 301
 302     /* Slave choice algorithm to apply to hash value. */
 303     enum nx_bd_algorithm algorithm;
 304
 305     /* What fields to hash and how. */
 306     enum nx_hash_fields fields;
 307     uint16_t basis;             /* Universal hash parameter. */
 308
 309     struct mf_subfield dst;
 310
 311     /* Slaves for output. */
 312     unsigned int n_slaves;
 313     ofp_port_t slaves[];
 314 };
 315
 316 /* OFPACT_SET_VLAN_VID.
 317  *
 318  * We keep track if vlan was present at action validation time to avoid a
 319  * PUSH_VLAN when translating to OpenFlow 1.1+.
 320  *
 321  * We also keep the originating OFPUTIL action code in ofpact.compat.
 322  *
 323  * Used for OFPAT10_SET_VLAN_VID and OFPAT11_SET_VLAN_VID. */
 324 struct ofpact_vlan_vid {
 325     struct ofpact ofpact;
 326     uint16_t vlan_vid;          /* VLAN VID in low 12 bits, 0 in other bits. */
 327     bool push_vlan_if_needed;   /* OF 1.0 semantics if true. */
 328     bool flow_has_vlan;         /* VLAN present at action validation time? */
 329 };
 330
 331 /* OFPACT_SET_VLAN_PCP.
 332  *
 333  * We keep track if vlan was present at action validation time to avoid a
 334  * PUSH_VLAN when translating to OpenFlow 1.1+.
 335  *
 336  * We also keep the originating OFPUTIL action code in ofpact.compat.
 337  *
 338  * Used for OFPAT10_SET_VLAN_PCP and OFPAT11_SET_VLAN_PCP. */
 339 struct ofpact_vlan_pcp {
 340     struct ofpact ofpact;
 341     uint8_t vlan_pcp;           /* VLAN PCP in low 3 bits, 0 in other bits. */
 342     bool push_vlan_if_needed;   /* OF 1.0 semantics if true. */
 343     bool flow_has_vlan;         /* VLAN present at action validation time? */
 344 };
 345
 346 /* OFPACT_SET_ETH_SRC, OFPACT_SET_ETH_DST.
 347  *
 348  * Used for OFPAT10_SET_DL_SRC, OFPAT10_SET_DL_DST. */
 349 struct ofpact_mac {
 350     struct ofpact ofpact;
 351     struct eth_addr mac;
 352 };
 353
 354 /* OFPACT_SET_IPV4_SRC, OFPACT_SET_IPV4_DST.
 355  *
 356  * Used for OFPAT10_SET_NW_SRC, OFPAT10_SET_NW_DST. */
 357 struct ofpact_ipv4 {
 358     struct ofpact ofpact;
 359     ovs_be32 ipv4;
 360 };
 361
 362 /* OFPACT_SET_IP_DSCP.
 363  *
 364  * Used for OFPAT10_SET_NW_TOS. */
 365 struct ofpact_dscp {
 366     struct ofpact ofpact;
 367     uint8_t dscp;               /* DSCP in high 6 bits, rest ignored. */
 368 };
 369
 370 /* OFPACT_SET_IP_ECN.
 371  *
 372  * Used for OFPAT11_SET_NW_ECN. */
 373 struct ofpact_ecn {
 374     struct ofpact ofpact;
 375     uint8_t ecn;               /* ECN in low 2 bits, rest ignored. */
 376 };
 377
 378 /* OFPACT_SET_IP_TTL.
 379  *
 380  * Used for OFPAT11_SET_NW_TTL. */
 381 struct ofpact_ip_ttl {
 382     struct ofpact ofpact;
 383     uint8_t ttl;
 384 };
 385
 386 /* OFPACT_SET_L4_SRC_PORT, OFPACT_SET_L4_DST_PORT.
 387  *
 388  * Used for OFPAT10_SET_TP_SRC, OFPAT10_SET_TP_DST. */
 389 struct ofpact_l4_port {
 390     struct ofpact ofpact;
 391     uint16_t port;              /* TCP, UDP or SCTP port number. */
 392     uint8_t  flow_ip_proto;     /* IP proto from corresponding match, or 0 */
 393 };
 394
 395 /* OFPACT_REG_MOVE.
 396  *
 397  * Used for NXAST_REG_MOVE. */
 398 struct ofpact_reg_move {
 399     struct ofpact ofpact;
 400     struct mf_subfield src;
 401     struct mf_subfield dst;
 402 };
 403
 404 /* OFPACT_STACK_PUSH.
 405  *
 406  * Used for NXAST_STACK_PUSH and NXAST_STACK_POP. */
 407 struct ofpact_stack {
 408     struct ofpact ofpact;
 409     struct mf_subfield subfield;
 410 };
 411
 412 /* OFPACT_SET_FIELD.
 413  *
 414  * Used for NXAST_REG_LOAD and OFPAT12_SET_FIELD. */
 415 struct ofpact_set_field {
 416     struct ofpact ofpact;
 417     const struct mf_field *field;
 418     bool flow_has_vlan;   /* VLAN present at action validation time. */
 419     union mf_value value;
 420     union mf_value mask;
 421 };
 422
 423 /* OFPACT_PUSH_VLAN/MPLS/PBB
 424  *
 425  * Used for NXAST_PUSH_MPLS, OFPAT11_PUSH_MPLS. */
 426 struct ofpact_push_mpls {
 427     struct ofpact ofpact;
 428     ovs_be16 ethertype;
 429 };
 430
 431 /* OFPACT_POP_MPLS
 432  *
 433  * Used for NXAST_POP_MPLS, OFPAT11_POP_MPLS.. */
 434 struct ofpact_pop_mpls {
 435     struct ofpact ofpact;
 436     ovs_be16 ethertype;
 437 };
 438
 439 /* OFPACT_SET_TUNNEL.
 440  *
 441  * Used for NXAST_SET_TUNNEL, NXAST_SET_TUNNEL64. */
 442 struct ofpact_tunnel {
 443     struct ofpact ofpact;
 444     uint64_t tun_id;
 445 };
 446
 447 /* OFPACT_SET_QUEUE.
 448  *
 449  * Used for NXAST_SET_QUEUE. */
 450 struct ofpact_queue {
 451     struct ofpact ofpact;
 452     uint32_t queue_id;
 453 };
 454
 455 /* OFPACT_FIN_TIMEOUT.
 456  *
 457  * Used for NXAST_FIN_TIMEOUT. */
 458 struct ofpact_fin_timeout {
 459     struct ofpact ofpact;
 460     uint16_t fin_idle_timeout;
 461     uint16_t fin_hard_timeout;
 462 };
 463
 464 /* OFPACT_WRITE_METADATA.
 465  *
 466  * Used for NXAST_WRITE_METADATA. */
 467 struct ofpact_metadata {
 468     struct ofpact ofpact;
 469     ovs_be64 metadata;
 470     ovs_be64 mask;
 471 };
 472
 473 /* OFPACT_METER.
 474  *
 475  * Used for OFPIT13_METER. */
 476 struct ofpact_meter {
 477     struct ofpact ofpact;
 478     uint32_t meter_id;
 479 };
 480
 481 /* OFPACT_WRITE_ACTIONS.
 482  *
 483  * Used for OFPIT11_WRITE_ACTIONS. */
 484 struct ofpact_nest {
 485     struct ofpact ofpact;
 486     uint8_t pad[PAD_SIZE(sizeof(struct ofpact), OFPACT_ALIGNTO)];
 487     struct ofpact actions[];
 488 };
 489 BUILD_ASSERT_DECL(offsetof(struct ofpact_nest, actions) % OFPACT_ALIGNTO == 0);
 490 BUILD_ASSERT_DECL(offsetof(struct ofpact_nest, actions)
 491                   == sizeof(struct ofpact_nest));
 492
 493 /* Bits for 'flags' in struct nx_action_conntrack.
 494  *
 495  * If NX_CT_F_COMMIT is set, then the connection entry is moved from the
 496  * unconfirmed to confirmed list in the tracker. */
 497 enum nx_conntrack_flags {
 498     NX_CT_F_COMMIT = 1 << 0,
 499 };
 500
 501 /* Magic value for struct nx_action_conntrack 'recirc_table' field, to specify
 502  * that the packet should not be recirculated. */
 503 #define NX_CT_RECIRC_NONE OFPTT_ALL
 504
 505 /* We want to determine the size of these elements at compile time to ensure
 506  * actions alignment, but we also want to allow ofpact_conntrack to have
 507  * basic _put(), _get(), etc accessors defined below which access these
 508  * members directly from ofpact_conntrack. An anonymous struct will serve
 509  * both of these purposes. */
 510 #define CT_MEMBERS                      \
 511 struct {                                \
 512     struct ofpact ofpact;               \
 513     uint16_t flags;                     \
 514     uint16_t zone_imm;                  \
 515     struct mf_subfield zone_src;        \
 516     uint16_t alg;                       \
 517     uint8_t recirc_table;               \
 518 }
 519
 520 #if !defined(IPPORT_FTP)
 521 #define IPPORT_FTP  21
 522 #endif
 523
 524 /* OFPACT_CT.
 525  *
 526  * Used for NXAST_CT. */
 527 struct ofpact_conntrack {
 528     union {
 529         CT_MEMBERS;
 530         uint8_t pad[OFPACT_ALIGN(sizeof(CT_MEMBERS))];
 531     };
 532     struct ofpact actions[0];
 533 };
 534 BUILD_ASSERT_DECL(offsetof(struct ofpact_conntrack, actions)
 535                   % OFPACT_ALIGNTO == 0);
 536 BUILD_ASSERT_DECL(offsetof(struct ofpact_conntrack, actions)
 537                   == sizeof(struct ofpact_conntrack));
 538
 539 static inline size_t
 540 ofpact_ct_get_action_len(const struct ofpact_conntrack *oc)
 541 {
 542     return oc->ofpact.len - offsetof(struct ofpact_conntrack, actions);
 543 }
 544
 545 static inline size_t
 546 ofpact_nest_get_action_len(const struct ofpact_nest *on)
 547 {
 548     return on->ofpact.len - offsetof(struct ofpact_nest, actions);
 549 }
 550
 551 void ofpacts_execute_action_set(struct ofpbuf *action_list,
 552                                 const struct ofpbuf *action_set);
 553
 554 /* Bits for 'flags' in struct nx_action_nat.
 555  */
 556 enum nx_nat_flags {
 557     NX_NAT_F_SRC          = 1 << 0,
 558     NX_NAT_F_DST          = 1 << 1,
 559     NX_NAT_F_PERSISTENT   = 1 << 2,
 560     NX_NAT_F_PROTO_HASH   = 1 << 3,
 561     NX_NAT_F_PROTO_RANDOM = 1 << 4,
 562 };
 563
 564 /* OFPACT_NAT.
 565  *
 566  * Used for NXAST_NAT. */
 567 struct ofpact_nat {
 568     struct ofpact ofpact;
 569     uint8_t range_af; /* AF_UNSPEC, AF_INET, or AF_INET6 */
 570     uint16_t flags;  /* NX_NAT_F_* */
 571     struct {
 572         struct {
 573             uint16_t min;
 574             uint16_t max;
 575         } proto;
 576         union {
 577             struct {
 578                 ovs_be32 min;
 579                 ovs_be32 max;
 580             } ipv4;
 581             struct {
 582                 struct in6_addr min;
 583                 struct in6_addr max;
 584             } ipv6;
 585         } addr;
 586     } range;
 587 };
 588
 589
 590 /* OFPACT_RESUBMIT.
 591  *
 592  * Used for NXAST_RESUBMIT, NXAST_RESUBMIT_TABLE. */
 593 struct ofpact_resubmit {
 594     struct ofpact ofpact;
 595     ofp_port_t in_port;
 596     uint8_t table_id;
 597 };
 598
 599 /* Part of struct ofpact_learn, below. */
 600 struct ofpact_learn_spec {
 601     int n_bits;                 /* Number of bits in source and dest. */
 602
 603     int src_type;               /* One of NX_LEARN_SRC_*. */
 604     struct mf_subfield src;     /* NX_LEARN_SRC_FIELD only. */
 605     union mf_subvalue src_imm;  /* NX_LEARN_SRC_IMMEDIATE only. */
 606
 607     int dst_type;             /* One of NX_LEARN_DST_*. */
 608     struct mf_subfield dst;   /* NX_LEARN_DST_MATCH, NX_LEARN_DST_LOAD only. */
 609 };
 610
 611
 612 /* Bits for 'flags' in struct nx_action_learn.
 613  *
 614  * If NX_LEARN_F_SEND_FLOW_REM is set, then the learned flows will have their
 615  * OFPFF_SEND_FLOW_REM flag set.
 616  *
 617  * If NX_LEARN_F_DELETE_LEARNED is set, then removing this action will delete
 618  * all the flows from the learn action's 'table_id' that have the learn
 619  * action's 'cookie'.  Important points:
 620  *
 621  *     - The deleted flows include those created by this action, those created
 622  *       by other learn actions with the same 'table_id' and 'cookie', those
 623  *       created by flow_mod requests by a controller in the specified table
 624  *       with the specified cookie, and those created through any other
 625  *       means.
 626  *
 627  *     - If multiple flows specify "learn" actions with
 628  *       NX_LEARN_F_DELETE_LEARNED with the same 'table_id' and 'cookie', then
 629  *       no deletion occurs until all of those "learn" actions are deleted.
 630  *
 631  *     - Deleting a flow that contains a learn action is the most obvious way
 632  *       to delete a learn action.  Modifying a flow's actions, or replacing it
 633  *       by a new flow, can also delete a learn action.  Finally, replacing a
 634  *       learn action with NX_LEARN_F_DELETE_LEARNED with a learn action
 635  *       without that flag also effectively deletes the learn action and can
 636  *       trigger flow deletion.
 637  *
 638  * NX_LEARN_F_DELETE_LEARNED was added in Open vSwitch 2.4. */
 639 enum nx_learn_flags {
 640     NX_LEARN_F_SEND_FLOW_REM = 1 << 0,
 641     NX_LEARN_F_DELETE_LEARNED = 1 << 1,
 642 };
 643
 644 #define NX_LEARN_N_BITS_MASK    0x3ff
 645
 646 #define NX_LEARN_SRC_FIELD     (0 << 13) /* Copy from field. */
 647 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
 648 #define NX_LEARN_SRC_MASK      (1 << 13)
 649
 650 #define NX_LEARN_DST_MATCH     (0 << 11) /* Add match criterion. */
 651 #define NX_LEARN_DST_LOAD      (1 << 11) /* Add NXAST_REG_LOAD action. */
 652 #define NX_LEARN_DST_OUTPUT    (2 << 11) /* Add OFPAT_OUTPUT action. */
 653 #define NX_LEARN_DST_RESERVED  (3 << 11) /* Not yet defined. */
 654 #define NX_LEARN_DST_MASK      (3 << 11)
 655
 656 /* OFPACT_LEARN.
 657  *
 658  * Used for NXAST_LEARN. */
 659 struct ofpact_learn {
 660     struct ofpact ofpact;
 661
 662     uint16_t idle_timeout;      /* Idle time before discarding (seconds). */
 663     uint16_t hard_timeout;      /* Max time before discarding (seconds). */
 664     uint16_t priority;          /* Priority level of flow entry. */
 665     uint8_t table_id;           /* Table to insert flow entry. */
 666     ovs_be64 cookie;            /* Cookie for new flow. */
 667     enum nx_learn_flags flags;  /* NX_LEARN_F_*. */
 668     uint16_t fin_idle_timeout;  /* Idle timeout after FIN, if nonzero. */
 669     uint16_t fin_hard_timeout;  /* Hard timeout after FIN, if nonzero. */
 670
 671     unsigned int n_specs;
 672     struct ofpact_learn_spec specs[];
 673 };
 674
 675 /* Multipath link choice algorithm to apply.
 676  *
 677  * In the descriptions below, 'n_links' is max_link + 1. */
 678 enum nx_mp_algorithm {
 679     /* link = hash(flow) % n_links.
 680      *
 681      * Redistributes all traffic when n_links changes.  O(1) performance.  See
 682      * RFC 2992.
 683      *
 684      * Use UINT16_MAX for max_link to get a raw hash value. */
 685     NX_MP_ALG_MODULO_N = 0,
 686
 687     /* link = hash(flow) / (MAX_HASH / n_links).
 688      *
 689      * Redistributes between one-quarter and one-half of traffic when n_links
 690      * changes.  O(1) performance.  See RFC 2992.
 691      */
 692     NX_MP_ALG_HASH_THRESHOLD = 1,
 693
 694     /* Highest Random Weight.
 695      *
 696      * for i in [0,n_links):
 697      *   weights[i] = hash(flow, i)
 698      * link = { i such that weights[i] >= weights[j] for all j != i }
 699      *
 700      * Redistributes 1/n_links of traffic when n_links changes.  O(n_links)
 701      * performance.  If n_links is greater than a threshold (currently 64, but
 702      * subject to change), Open vSwitch will substitute another algorithm
 703      * automatically.  See RFC 2992. */
 704     NX_MP_ALG_HRW = 2,
 705
 706     /* Iterative Hash.
 707      *
 708      * i = 0
 709      * repeat:
 710      *     i = i + 1
 711      *     link = hash(flow, i) % arg
 712      * while link > max_link
 713      *
 714      * Redistributes 1/n_links of traffic when n_links changes.  O(1)
 715      * performance when arg/max_link is bounded by a constant.
 716      *
 717      * Redistributes all traffic when arg changes.
 718      *
 719      * arg must be greater than max_link and for best performance should be no
 720      * more than approximately max_link * 2.  If arg is outside the acceptable
 721      * range, Open vSwitch will automatically substitute the least power of 2
 722      * greater than max_link.
 723      *
 724      * This algorithm is specific to Open vSwitch.
 725      */
 726     NX_MP_ALG_ITER_HASH = 3,
 727 };
 728
 729 /* OFPACT_CONJUNCTION.
 730  *
 731  * Used for NXAST_CONJUNCTION. */
 732 struct ofpact_conjunction {
 733     struct ofpact ofpact;
 734     uint8_t clause;
 735     uint8_t n_clauses;
 736     uint32_t id;
 737 };
 738
 739 /* OFPACT_MULTIPATH.
 740  *
 741  * Used for NXAST_MULTIPATH. */
 742 struct ofpact_multipath {
 743     struct ofpact ofpact;
 744
 745     /* What fields to hash and how. */
 746     enum nx_hash_fields fields;
 747     uint16_t basis;             /* Universal hash parameter. */
 748
 749     /* Multipath link choice algorithm to apply to hash value. */
 750     enum nx_mp_algorithm algorithm;
 751     uint16_t max_link;          /* Number of output links, minus 1. */
 752     uint32_t arg;               /* Algorithm-specific argument. */
 753
 754     /* Where to store the result. */
 755     struct mf_subfield dst;
 756 };
 757
 758 /* OFPACT_NOTE.
 759  *
 760  * Used for NXAST_NOTE. */
 761 struct ofpact_note {
 762     struct ofpact ofpact;
 763     size_t length;
 764     uint8_t data[];
 765 };
 766
 767 /* OFPACT_SAMPLE.
 768  *
 769  * Used for NXAST_SAMPLE. */
 770 struct ofpact_sample {
 771     struct ofpact ofpact;
 772     uint16_t probability;  // Always >0.
 773     uint32_t collector_set_id;
 774     uint32_t obs_domain_id;
 775     uint32_t obs_point_id;
 776 };
 777
 778 /* OFPACT_DEC_TTL.
 779  *
 780  * Used for OFPAT11_DEC_NW_TTL, NXAST_DEC_TTL and NXAST_DEC_TTL_CNT_IDS. */
 781 struct ofpact_cnt_ids {
 782     struct ofpact ofpact;
 783
 784     /* Controller ids. */
 785     unsigned int n_controllers;
 786     uint16_t cnt_ids[];
 787 };
 788
 789 /* OFPACT_SET_MPLS_LABEL.
 790  *
 791  * Used for OFPAT11_SET_MPLS_LABEL and NXAST_SET_MPLS_LABEL */
 792 struct ofpact_mpls_label {
 793     struct ofpact ofpact;
 794
 795     ovs_be32 label;
 796 };
 797
 798 /* OFPACT_SET_MPLS_TC.
 799  *
 800  * Used for OFPAT11_SET_MPLS_TC and NXAST_SET_MPLS_TC */
 801 struct ofpact_mpls_tc {
 802     struct ofpact ofpact;
 803
 804     uint8_t tc;
 805 };
 806
 807 /* OFPACT_SET_MPLS_TTL.
 808  *
 809  * Used for OFPAT11_SET_MPLS_TTL and NXAST_SET_MPLS_TTL */
 810 struct ofpact_mpls_ttl {
 811     struct ofpact ofpact;
 812
 813     uint8_t ttl;
 814 };
 815
 816 /* OFPACT_GOTO_TABLE
 817  *
 818  * Used for OFPIT11_GOTO_TABLE */
 819 struct ofpact_goto_table {
 820     struct ofpact ofpact;
 821     uint8_t table_id;
 822 };
 823
 824 /* OFPACT_GROUP.
 825  *
 826  * Used for OFPAT11_GROUP. */
 827 struct ofpact_group {
 828     struct ofpact ofpact;
 829     uint32_t group_id;
 830 };
 831
 832 /* OFPACT_UNROLL_XLATE.
 833  *
 834  * Used only internally. */
 835 struct ofpact_unroll_xlate {
 836     struct ofpact ofpact;
 837
 838     /* Metadata in xlate context, visible to controller via PACKET_INs. */
 839     uint8_t  rule_table_id;       /* 0xFF if none. */
 840     ovs_be64 rule_cookie;         /* OVS_BE64_MAX if none. */
 841 };
 842
 843 /* Converting OpenFlow to ofpacts. */
 844 enum ofperr ofpacts_pull_openflow_actions(struct ofpbuf *openflow,
 845                                           unsigned int actions_len,
 846                                           enum ofp_version version,
 847                                           struct ofpbuf *ofpacts);
 848 enum ofperr ofpacts_pull_openflow_instructions(struct ofpbuf *openflow,
 849                                                unsigned int instructions_len,
 850                                                enum ofp_version version,
 851                                                struct ofpbuf *ofpacts);
 852 enum ofperr ofpacts_check(struct ofpact[], size_t ofpacts_len,
 853                           struct flow *, ofp_port_t max_ports,
 854                           uint8_t table_id, uint8_t n_tables,
 855                           enum ofputil_protocol *usable_protocols);
 856 enum ofperr ofpacts_check_consistency(struct ofpact[], size_t ofpacts_len,
 857                                       struct flow *, ofp_port_t max_ports,
 858                                       uint8_t table_id, uint8_t n_tables,
 859                                       enum ofputil_protocol usable_protocols);
 860 enum ofperr ofpact_check_output_port(ofp_port_t port, ofp_port_t max_ports);
 861
 862 /* Converting ofpacts to OpenFlow. */
 863 size_t ofpacts_put_openflow_actions(const struct ofpact[], size_t ofpacts_len,
 864                                     struct ofpbuf *openflow, enum ofp_version);
 865 void ofpacts_put_openflow_instructions(const struct ofpact[],
 866                                        size_t ofpacts_len,
 867                                        struct ofpbuf *openflow,
 868                                        enum ofp_version ofp_version);
 869
 870 /* Sets of supported actions. */
 871 ovs_be32 ofpact_bitmap_to_openflow(uint64_t ofpacts_bitmap, enum ofp_version);
 872 uint64_t ofpact_bitmap_from_openflow(ovs_be32 ofpat_bitmap, enum ofp_version);
 873 void ofpact_bitmap_format(uint64_t ofpacts_bitmap, struct ds *);
 874
 875 /* Working with ofpacts. */
 876 bool ofpacts_output_to_port(const struct ofpact[], size_t ofpacts_len,
 877                             ofp_port_t port);
 878 bool ofpacts_output_to_group(const struct ofpact[], size_t ofpacts_len,
 879                              uint32_t group_id);
 880 bool ofpacts_equal(const struct ofpact a[], size_t a_len,
 881                    const struct ofpact b[], size_t b_len);
 882 const struct mf_field *ofpact_get_mf_dst(const struct ofpact *ofpact);
 883 uint32_t ofpacts_get_meter(const struct ofpact[], size_t ofpacts_len);
 884
 885 /* Formatting and parsing ofpacts. */
 886 void ofpacts_format(const struct ofpact[], size_t ofpacts_len, struct ds *);
 887 char *ofpacts_parse_actions(const char *, struct ofpbuf *ofpacts,
 888                             enum ofputil_protocol *usable_protocols)
 889     OVS_WARN_UNUSED_RESULT;
 890 char *ofpacts_parse_instructions(const char *, struct ofpbuf *ofpacts,
 891                                  enum ofputil_protocol *usable_protocols)
 892     OVS_WARN_UNUSED_RESULT;
 893 const char *ofpact_name(enum ofpact_type);
 894
 895 /* Internal use by the helpers below. */
 896 void ofpact_init(struct ofpact *, enum ofpact_type, size_t len);
 897 void *ofpact_put(struct ofpbuf *, enum ofpact_type, size_t len);
 898
 899 /* For each OFPACT_<ENUM> with a corresponding struct <STRUCT>, this defines
 900  * the following commonly useful functions:
 901  *
 902  *   struct <STRUCT> *ofpact_put_<ENUM>(struct ofpbuf *ofpacts);
 903  *
 904  *     Appends a new 'ofpact', of length OFPACT_<ENUM>_SIZE, to 'ofpacts',
 905  *     initializes it with ofpact_init_<ENUM>(), and returns it.  Also sets
 906  *     'ofpacts->header' to the returned action.
 907  *
 908  *     After using this function to add a variable-length action, add the
 909  *     elements of the flexible array (e.g. with ofpbuf_put()), then use
 910  *     ofpact_finish() to pad the action to a multiple of OFPACT_ALIGNTO bytes
 911  *     and update its embedded length field.  (Keep in mind the need to refresh
 912  *     the structure from 'ofpacts->header' after adding data to 'ofpacts'.)
 913  *
 914  *   struct <STRUCT> *ofpact_get_<ENUM>(const struct ofpact *ofpact);
 915  *
 916  *     Returns 'ofpact' cast to "struct <STRUCT> *".  'ofpact->type' must be
 917  *     OFPACT_<ENUM>.
 918  *
 919  * as well as the following more rarely useful definitions:
 920  *
 921  *   void ofpact_init_<ENUM>(struct <STRUCT> *ofpact);
 922  *
 923  *     Initializes the parts of 'ofpact' that identify it as having type
 924  *     OFPACT_<ENUM> and length OFPACT_<ENUM>_SIZE and zeros the rest.
 925  *
 926  *   <ENUM>_SIZE
 927  *
 928  *     The size of the action structure.  For a fixed-length action, this is
 929  *     sizeof(struct <STRUCT>) rounded up to a multiple of OFPACT_ALIGNTO.  For
 930  *     a variable-length action, this is the offset to the variable-length
 931  *     part.
 932  */
 933 #define OFPACT(ENUM, STRUCT, MEMBER, NAME)                              \
 934     BUILD_ASSERT_DECL(offsetof(struct STRUCT, ofpact) == 0);            \
 935                                                                         \
 936     enum { OFPACT_##ENUM##_SIZE                                         \
 937            = (offsetof(struct STRUCT, MEMBER)                           \
 938               ? offsetof(struct STRUCT, MEMBER)                         \
 939               : OFPACT_ALIGN(sizeof(struct STRUCT))) };                 \
 940                                                                         \
 941     static inline struct STRUCT *                                       \
 942     ofpact_get_##ENUM(const struct ofpact *ofpact)                      \
 943     {                                                                   \
 944         ovs_assert(ofpact->type == OFPACT_##ENUM);                      \
 945         return ALIGNED_CAST(struct STRUCT *, ofpact);                   \
 946     }                                                                   \
 947                                                                         \
 948     static inline struct STRUCT *                                       \
 949     ofpact_put_##ENUM(struct ofpbuf *ofpacts)                           \
 950     {                                                                   \
 951         return ofpact_put(ofpacts, OFPACT_##ENUM,                       \
 952                           OFPACT_##ENUM##_SIZE);                        \
 953     }                                                                   \
 954                                                                         \
 955     static inline void                                                  \
 956     ofpact_init_##ENUM(struct STRUCT *ofpact)                           \
 957     {                                                                   \
 958         ofpact_init(&ofpact->ofpact, OFPACT_##ENUM,                     \
 959                     OFPACT_##ENUM##_SIZE);                              \
 960     }
 961 OFPACTS
 962 #undef OFPACT
 963
 964 /* Call after adding the variable-length part to a variable-length action. */
 965 void ofpact_finish(struct ofpbuf *, struct ofpact *);
 966
 967 /* Additional functions for composing ofpacts. */
 968 struct ofpact_set_field *ofpact_put_reg_load(struct ofpbuf *ofpacts);
 969
 970 /* OpenFlow 1.1 instructions.
 971  * The order is sorted in execution order. Not in the value of OFPIT11_xxx.
 972  * It is enforced on parser from text string.
 973  */
 974 #define OVS_INSTRUCTIONS                                    \
 975     DEFINE_INST(OFPIT13_METER,                              \
 976                 ofp13_instruction_meter,          false,    \
 977                 "meter")                                    \
 978                                                             \
 979     DEFINE_INST(OFPIT11_APPLY_ACTIONS,                      \
 980                 ofp11_instruction_actions,        true,     \
 981                 "apply_actions")                            \
 982                                                             \
 983     DEFINE_INST(OFPIT11_CLEAR_ACTIONS,                      \
 984                 ofp11_instruction,                false,    \
 985                 "clear_actions")                            \
 986                                                             \
 987     DEFINE_INST(OFPIT11_WRITE_ACTIONS,                      \
 988                 ofp11_instruction_actions,        true,     \
 989                 "write_actions")                            \
 990                                                             \
 991     DEFINE_INST(OFPIT11_WRITE_METADATA,                     \
 992                 ofp11_instruction_write_metadata, false,    \
 993                 "write_metadata")                           \
 994                                                             \
 995     DEFINE_INST(OFPIT11_GOTO_TABLE,                         \
 996                 ofp11_instruction_goto_table,     false,    \
 997                 "goto_table")
 998
 999 enum ovs_instruction_type {
1000 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) OVSINST_##ENUM,
1001     OVS_INSTRUCTIONS
1002 #undef DEFINE_INST
1003 };
1004
1005 enum {
1006 #define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
1007     N_OVS_INSTRUCTIONS = OVS_INSTRUCTIONS
1008 #undef DEFINE_INST
1009 };
1010
1011 const char *ovs_instruction_name_from_type(enum ovs_instruction_type type);
1012 int ovs_instruction_type_from_name(const char *name);
1013 enum ovs_instruction_type ovs_instruction_type_from_ofpact_type(
1014     enum ofpact_type);
1015 enum ofperr ovs_instruction_type_from_inst_type(
1016     enum ovs_instruction_type *instruction_type, const uint16_t inst_type);
1017
1018 ovs_be32 ovsinst_bitmap_to_openflow(uint32_t ovsinst_bitmap, enum ofp_version);
1019 uint32_t ovsinst_bitmap_from_openflow(ovs_be32 ofpit_bitmap,
1020                                       enum ofp_version);
1021
1022 #endif /* ofp-actions.h */