]> git.proxmox.com Git - ovs.git/blame - lib/ofp-actions.c
Move lib/ofp-actions.h to include/openvswitch directory
[ovs.git] / lib / ofp-actions.c
CommitLineData
f25d0cf3 1/*
77ab5fd2 2 * Copyright (c) 2008-2016 Nicira, Inc.
f25d0cf3
BP
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#include <config.h>
d787ad39
JS
18#include <netinet/in.h>
19
f25d0cf3
BP
20#include "bundle.h"
21#include "byte-order.h"
b1c5bf1f 22#include "colors.h"
f25d0cf3 23#include "compiler.h"
d4abaff5 24#include "dummy.h"
c2d936a4 25#include "hmap.h"
f25d0cf3 26#include "learn.h"
f25d0cf3
BP
27#include "multipath.h"
28#include "nx-match.h"
9ac0aada 29#include "odp-netlink.h"
bdcad671 30#include "ofp-prop.h"
b598f214
BW
31#include "openvswitch/dynamic-string.h"
32#include "openvswitch/meta-flow.h"
33#include "openvswitch/ofp-actions.h"
f4248336 34#include "openvswitch/ofp-util.h"
b598f214 35#include "openvswitch/ofp-parse.h"
64c96779 36#include "openvswitch/ofpbuf.h"
b598f214 37#include "openvswitch/vlog.h"
c2d936a4 38#include "unaligned.h"
cb22974d 39#include "util.h"
f25d0cf3
BP
40
41VLOG_DEFINE_THIS_MODULE(ofp_actions);
42
43static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
f25d0cf3 44
c2d936a4
BP
45struct ofp_action_header;
46
47/* Raw identifiers for OpenFlow actions.
48 *
49 * Decoding and encoding OpenFlow actions across multiple versions is difficult
50 * to do in a clean, consistent way. This enumeration lays out all of the
51 * forms of actions that Open vSwitch supports.
52 *
53 * The comments here must follow a stylized form because the
54 * "extract-ofp-actions" program parses them at build time to generate data
55 * tables.
56 *
57 * - The first part of each comment specifies the vendor, OpenFlow versions,
58 * and type for each protocol that supports the action:
59 *
60 * # The vendor is OF for standard OpenFlow actions, NX for Nicira
61 * extension actions. (Support for other vendors can be added, but
62 * it can't be done just based on a vendor ID definition alone
63 * because OpenFlow doesn't define a standard way to specify a
64 * subtype for vendor actions, so other vendors might do it different
65 * from Nicira.)
66 *
67 * # The version can specify a specific OpenFlow version, a version
68 * range delimited by "-", or an open-ended range with "+".
69 *
70 * # The type, in parentheses, is the action type number (for standard
71 * OpenFlow actions) or subtype (for vendor extension actions).
72 *
73 * # Optionally one may add "is deprecated" followed by a
74 * human-readable reason in parentheses (which will be used in log
75 * messages), if a particular action should no longer be used.
76 *
77 * Multiple such specifications may be separated by commas.
78 *
79 * - The second part describes the action's wire format. It may be:
80 *
81 * # "struct <name>": The struct fully specifies the wire format. The
82 * action is exactly the size of the struct. (Thus, the struct must
83 * be an exact multiple of 8 bytes in size.)
84 *
85 * # "struct <name>, ...": The struct specifies the beginning of the
86 * wire format. An instance of the action is either the struct's
87 * exact size, or a multiple of 8 bytes longer.
88 *
89 * # "uint<N>_t" or "ovs_be<N>": The action consists of a (standard or
90 * vendor extension) header, followed by 0 or more pad bytes to align
91 * to a multiple of <N> bits, followed by an argument of the given
92 * type, followed by 0 or more pad bytes to bring the total action up
93 * to a multiple of 8 bytes.
94 *
95 * # "void": The action is just a (standard or vendor extension)
96 * header.
97 *
98 * - Optional additional text enclosed in square brackets is commentary for
99 * the human reader.
100 */
101enum ofp_raw_action_type {
102/* ## ----------------- ## */
103/* ## Standard actions. ## */
104/* ## ----------------- ## */
105
106 /* OF1.0(0): struct ofp10_action_output. */
107 OFPAT_RAW10_OUTPUT,
108 /* OF1.1+(0): struct ofp11_action_output. */
109 OFPAT_RAW11_OUTPUT,
110
111 /* OF1.0(1): uint16_t. */
112 OFPAT_RAW10_SET_VLAN_VID,
113 /* OF1.0(2): uint8_t. */
114 OFPAT_RAW10_SET_VLAN_PCP,
115
116 /* OF1.1(1), OF1.2+(1) is deprecated (use Set-Field): uint16_t.
117 *
118 * [Semantics differ slightly between the 1.0 and 1.1 versions of the VLAN
119 * modification actions: the 1.0 versions push a VLAN header if none is
120 * present, but the 1.1 versions do not. That is the only reason that we
121 * distinguish their raw action types.] */
122 OFPAT_RAW11_SET_VLAN_VID,
123 /* OF1.1(2), OF1.2+(2) is deprecated (use Set-Field): uint8_t. */
124 OFPAT_RAW11_SET_VLAN_PCP,
125
126 /* OF1.1+(17): ovs_be16.
127 *
128 * [The argument is the Ethertype, e.g. ETH_TYPE_VLAN_8021Q, not the VID or
129 * TCI.] */
130 OFPAT_RAW11_PUSH_VLAN,
131
132 /* OF1.0(3): void. */
133 OFPAT_RAW10_STRIP_VLAN,
134 /* OF1.1+(18): void. */
135 OFPAT_RAW11_POP_VLAN,
136
137 /* OF1.0(4), OF1.1(3), OF1.2+(3) is deprecated (use Set-Field): struct
138 * ofp_action_dl_addr. */
139 OFPAT_RAW_SET_DL_SRC,
140
141 /* OF1.0(5), OF1.1(4), OF1.2+(4) is deprecated (use Set-Field): struct
142 * ofp_action_dl_addr. */
143 OFPAT_RAW_SET_DL_DST,
144
145 /* OF1.0(6), OF1.1(5), OF1.2+(5) is deprecated (use Set-Field):
146 * ovs_be32. */
147 OFPAT_RAW_SET_NW_SRC,
148
149 /* OF1.0(7), OF1.1(6), OF1.2+(6) is deprecated (use Set-Field):
150 * ovs_be32. */
151 OFPAT_RAW_SET_NW_DST,
152
153 /* OF1.0(8), OF1.1(7), OF1.2+(7) is deprecated (use Set-Field): uint8_t. */
154 OFPAT_RAW_SET_NW_TOS,
155
156 /* OF1.1(8), OF1.2+(8) is deprecated (use Set-Field): uint8_t. */
157 OFPAT_RAW11_SET_NW_ECN,
158
159 /* OF1.0(9), OF1.1(9), OF1.2+(9) is deprecated (use Set-Field):
160 * ovs_be16. */
161 OFPAT_RAW_SET_TP_SRC,
162
163 /* OF1.0(10), OF1.1(10), OF1.2+(10) is deprecated (use Set-Field):
164 * ovs_be16. */
165 OFPAT_RAW_SET_TP_DST,
166
167 /* OF1.0(11): struct ofp10_action_enqueue. */
168 OFPAT_RAW10_ENQUEUE,
169
170 /* NX1.0(30), OF1.1(13), OF1.2+(13) is deprecated (use Set-Field):
171 * ovs_be32. */
172 OFPAT_RAW_SET_MPLS_LABEL,
173
174 /* NX1.0(31), OF1.1(14), OF1.2+(14) is deprecated (use Set-Field):
175 * uint8_t. */
176 OFPAT_RAW_SET_MPLS_TC,
177
178 /* NX1.0(25), OF1.1(15), OF1.2+(15) is deprecated (use Set-Field):
179 * uint8_t. */
180 OFPAT_RAW_SET_MPLS_TTL,
181
182 /* NX1.0(26), OF1.1+(16): void. */
183 OFPAT_RAW_DEC_MPLS_TTL,
184
185 /* NX1.0(23), OF1.1+(19): ovs_be16.
186 *
187 * [The argument is the Ethertype, e.g. ETH_TYPE_MPLS, not the label.] */
188 OFPAT_RAW_PUSH_MPLS,
189
190 /* NX1.0(24), OF1.1+(20): ovs_be16.
191 *
192 * [The argument is the Ethertype, e.g. ETH_TYPE_IPV4 if at BoS or
193 * ETH_TYPE_MPLS otherwise, not the label.] */
194 OFPAT_RAW_POP_MPLS,
195
196 /* NX1.0(4), OF1.1+(21): uint32_t. */
197 OFPAT_RAW_SET_QUEUE,
198
199 /* OF1.1+(22): uint32_t. */
200 OFPAT_RAW11_GROUP,
201
202 /* OF1.1+(23): uint8_t. */
203 OFPAT_RAW11_SET_NW_TTL,
204
205 /* NX1.0(18), OF1.1+(24): void. */
206 OFPAT_RAW_DEC_NW_TTL,
207 /* NX1.0+(21): struct nx_action_cnt_ids, ... */
208 NXAST_RAW_DEC_TTL_CNT_IDS,
209
7eb4b1f1 210 /* OF1.2-1.4(25): struct ofp12_action_set_field, ... */
c2d936a4 211 OFPAT_RAW12_SET_FIELD,
7eb4b1f1
BP
212 /* OF1.5+(25): struct ofp12_action_set_field, ... */
213 OFPAT_RAW15_SET_FIELD,
214 /* NX1.0-1.4(7): struct nx_action_reg_load.
215 *
216 * [In OpenFlow 1.5, set_field is a superset of reg_load functionality, so
217 * we drop reg_load.] */
c2d936a4 218 NXAST_RAW_REG_LOAD,
bad8a439
BP
219 /* NX1.0-1.4(33): struct nx_action_reg_load2, ...
220 *
221 * [In OpenFlow 1.5, set_field is a superset of reg_load2 functionality, so
222 * we drop reg_load2.] */
223 NXAST_RAW_REG_LOAD2,
c2d936a4 224
f13cdd73 225 /* OF1.5+(28): struct ofp15_action_copy_field, ... */
73178f20 226 OFPAT_RAW15_COPY_FIELD,
914624f8
BP
227 /* ONF1.3-1.4(3200): struct onf_action_copy_field, ... */
228 ONFACT_RAW13_COPY_FIELD,
bad8a439 229 /* NX1.0-1.4(6): struct nx_action_reg_move, ... */
73178f20
BP
230 NXAST_RAW_REG_MOVE,
231
c2d936a4
BP
232/* ## ------------------------- ## */
233/* ## Nicira extension actions. ## */
234/* ## ------------------------- ## */
235
236/* Actions similar to standard actions are listed with the standard actions. */
237
238 /* NX1.0+(1): uint16_t. */
239 NXAST_RAW_RESUBMIT,
240 /* NX1.0+(14): struct nx_action_resubmit. */
241 NXAST_RAW_RESUBMIT_TABLE,
242
243 /* NX1.0+(2): uint32_t. */
244 NXAST_RAW_SET_TUNNEL,
245 /* NX1.0+(9): uint64_t. */
246 NXAST_RAW_SET_TUNNEL64,
247
248 /* NX1.0+(5): void. */
249 NXAST_RAW_POP_QUEUE,
250
c2d936a4
BP
251 /* NX1.0+(8): struct nx_action_note, ... */
252 NXAST_RAW_NOTE,
253
254 /* NX1.0+(10): struct nx_action_multipath. */
255 NXAST_RAW_MULTIPATH,
256
257 /* NX1.0+(12): struct nx_action_bundle, ... */
258 NXAST_RAW_BUNDLE,
259 /* NX1.0+(13): struct nx_action_bundle, ... */
260 NXAST_RAW_BUNDLE_LOAD,
261
262 /* NX1.0+(15): struct nx_action_output_reg. */
263 NXAST_RAW_OUTPUT_REG,
bad8a439
BP
264 /* NX1.0+(32): struct nx_action_output_reg2. */
265 NXAST_RAW_OUTPUT_REG2,
c2d936a4
BP
266
267 /* NX1.0+(16): struct nx_action_learn, ... */
268 NXAST_RAW_LEARN,
269
270 /* NX1.0+(17): void. */
271 NXAST_RAW_EXIT,
272
273 /* NX1.0+(19): struct nx_action_fin_timeout. */
274 NXAST_RAW_FIN_TIMEOUT,
275
276 /* NX1.0+(20): struct nx_action_controller. */
277 NXAST_RAW_CONTROLLER,
bdcad671
BP
278 /* NX1.0+(37): struct nx_action_controller2, ... */
279 NXAST_RAW_CONTROLLER2,
c2d936a4
BP
280
281 /* NX1.0+(22): struct nx_action_write_metadata. */
282 NXAST_RAW_WRITE_METADATA,
283
284 /* NX1.0+(27): struct nx_action_stack. */
285 NXAST_RAW_STACK_PUSH,
286
287 /* NX1.0+(28): struct nx_action_stack. */
288 NXAST_RAW_STACK_POP,
289
290 /* NX1.0+(29): struct nx_action_sample. */
291 NXAST_RAW_SAMPLE,
18080541
BP
292
293 /* NX1.0+(34): struct nx_action_conjunction. */
294 NXAST_RAW_CONJUNCTION,
d4abaff5 295
07659514
JS
296 /* NX1.0+(35): struct nx_action_conntrack, ... */
297 NXAST_RAW_CT,
298
9ac0aada
JR
299 /* NX1.0+(36): struct nx_action_nat, ... */
300 NXAST_RAW_NAT,
301
d4abaff5
BP
302/* ## ------------------ ## */
303/* ## Debugging actions. ## */
304/* ## ------------------ ## */
305
306/* These are intentionally undocumented, subject to change, and ovs-vswitchd */
307/* accepts them only if started with --enable-dummy. */
308
309 /* NX1.0+(255): void. */
310 NXAST_RAW_DEBUG_RECIRC,
c2d936a4
BP
311};
312
313/* OpenFlow actions are always a multiple of 8 bytes in length. */
314#define OFP_ACTION_ALIGN 8
315
316/* Define a few functions for working with instructions. */
317#define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
318 static inline const struct STRUCT * OVS_UNUSED \
319 instruction_get_##ENUM(const struct ofp11_instruction *inst)\
320 { \
321 ovs_assert(inst->type == htons(ENUM)); \
322 return ALIGNED_CAST(struct STRUCT *, inst); \
323 } \
324 \
325 static inline void OVS_UNUSED \
326 instruction_init_##ENUM(struct STRUCT *s) \
327 { \
328 memset(s, 0, sizeof *s); \
329 s->type = htons(ENUM); \
330 s->len = htons(sizeof *s); \
331 } \
332 \
333 static inline struct STRUCT * OVS_UNUSED \
334 instruction_put_##ENUM(struct ofpbuf *buf) \
335 { \
336 struct STRUCT *s = ofpbuf_put_uninit(buf, sizeof *s); \
337 instruction_init_##ENUM(s); \
338 return s; \
339 }
340OVS_INSTRUCTIONS
341#undef DEFINE_INST
342
343static void ofpacts_update_instruction_actions(struct ofpbuf *openflow,
344 size_t ofs);
178742f9 345static void pad_ofpat(struct ofpbuf *openflow, size_t start_ofs);
c2d936a4
BP
346
347static enum ofperr ofpacts_verify(const struct ofpact[], size_t ofpacts_len,
d824b5b7
JS
348 uint32_t allowed_ovsinsts,
349 enum ofpact_type outer_action);
c2d936a4
BP
350
351static void ofpact_put_set_field(struct ofpbuf *openflow, enum ofp_version,
352 enum mf_field_id, uint64_t value);
353
354static enum ofperr ofpact_pull_raw(struct ofpbuf *, enum ofp_version,
355 enum ofp_raw_action_type *, uint64_t *arg);
356static void *ofpact_put_raw(struct ofpbuf *, enum ofp_version,
357 enum ofp_raw_action_type, uint64_t arg);
358
cab50449 359static char *OVS_WARN_UNUSED_RESULT ofpacts_parse(
c2d936a4 360 char *str, struct ofpbuf *ofpacts, enum ofputil_protocol *usable_protocols,
d824b5b7 361 bool allow_instructions, enum ofpact_type outer_action);
07659514
JS
362static enum ofperr ofpacts_pull_openflow_actions__(
363 struct ofpbuf *openflow, unsigned int actions_len,
364 enum ofp_version version, uint32_t allowed_ovsinsts,
365 struct ofpbuf *ofpacts, enum ofpact_type outer_action);
8e53fe8c
JS
366static char * OVS_WARN_UNUSED_RESULT ofpacts_parse_copy(
367 const char *s_, struct ofpbuf *ofpacts,
368 enum ofputil_protocol *usable_protocols,
369 bool allow_instructions, enum ofpact_type outer_action);
d824b5b7 370
4f20179d
BP
371/* Returns the ofpact following 'ofpact', except that if 'ofpact' contains
372 * nested ofpacts it returns the first one. */
373struct ofpact *
374ofpact_next_flattened(const struct ofpact *ofpact)
375{
376 switch (ofpact->type) {
377 case OFPACT_OUTPUT:
378 case OFPACT_GROUP:
379 case OFPACT_CONTROLLER:
380 case OFPACT_ENQUEUE:
381 case OFPACT_OUTPUT_REG:
382 case OFPACT_BUNDLE:
383 case OFPACT_SET_FIELD:
384 case OFPACT_SET_VLAN_VID:
385 case OFPACT_SET_VLAN_PCP:
386 case OFPACT_STRIP_VLAN:
387 case OFPACT_PUSH_VLAN:
388 case OFPACT_SET_ETH_SRC:
389 case OFPACT_SET_ETH_DST:
390 case OFPACT_SET_IPV4_SRC:
391 case OFPACT_SET_IPV4_DST:
392 case OFPACT_SET_IP_DSCP:
393 case OFPACT_SET_IP_ECN:
394 case OFPACT_SET_IP_TTL:
395 case OFPACT_SET_L4_SRC_PORT:
396 case OFPACT_SET_L4_DST_PORT:
397 case OFPACT_REG_MOVE:
398 case OFPACT_STACK_PUSH:
399 case OFPACT_STACK_POP:
400 case OFPACT_DEC_TTL:
401 case OFPACT_SET_MPLS_LABEL:
402 case OFPACT_SET_MPLS_TC:
403 case OFPACT_SET_MPLS_TTL:
404 case OFPACT_DEC_MPLS_TTL:
405 case OFPACT_PUSH_MPLS:
406 case OFPACT_POP_MPLS:
407 case OFPACT_SET_TUNNEL:
408 case OFPACT_SET_QUEUE:
409 case OFPACT_POP_QUEUE:
410 case OFPACT_FIN_TIMEOUT:
411 case OFPACT_RESUBMIT:
412 case OFPACT_LEARN:
413 case OFPACT_CONJUNCTION:
414 case OFPACT_MULTIPATH:
415 case OFPACT_NOTE:
416 case OFPACT_EXIT:
417 case OFPACT_SAMPLE:
418 case OFPACT_UNROLL_XLATE:
419 case OFPACT_DEBUG_RECIRC:
420 case OFPACT_METER:
421 case OFPACT_CLEAR_ACTIONS:
422 case OFPACT_WRITE_METADATA:
423 case OFPACT_GOTO_TABLE:
424 case OFPACT_NAT:
425 return ofpact_next(ofpact);
426
427 case OFPACT_CT:
428 return ofpact_get_CT(ofpact)->actions;
429
430 case OFPACT_WRITE_ACTIONS:
431 return ofpact_get_WRITE_ACTIONS(ofpact)->actions;
432 }
433
434 OVS_NOT_REACHED();
435}
436
d824b5b7
JS
437/* Pull off existing actions or instructions. Used by nesting actions to keep
438 * ofpacts_parse() oblivious of actions nesting.
439 *
440 * Push the actions back on after nested parsing, e.g.:
441 *
442 * size_t ofs = ofpacts_pull(ofpacts);
443 * ...nested parsing...
444 * ofpbuf_push_uninit(ofpacts, ofs);
445 */
446static size_t
447ofpacts_pull(struct ofpbuf *ofpacts)
448{
449 size_t ofs;
450
d824b5b7
JS
451 ofs = ofpacts->size;
452 ofpbuf_pull(ofpacts, ofs);
453
454 return ofs;
455}
c2d936a4
BP
456
457#include "ofp-actions.inc1"
458\f
459/* Output actions. */
460
461/* Action structure for OFPAT10_OUTPUT, which sends packets out 'port'.
462 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
463 * number of bytes to send. A 'max_len' of zero means no bytes of the
464 * packet should be sent. */
465struct ofp10_action_output {
466 ovs_be16 type; /* OFPAT10_OUTPUT. */
467 ovs_be16 len; /* Length is 8. */
468 ovs_be16 port; /* Output port. */
469 ovs_be16 max_len; /* Max length to send to controller. */
e45e72f1 470};
c2d936a4
BP
471OFP_ASSERT(sizeof(struct ofp10_action_output) == 8);
472
473/* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
474 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
475 * number of bytes to send. A 'max_len' of zero means no bytes of the
476 * packet should be sent.*/
477struct ofp11_action_output {
478 ovs_be16 type; /* OFPAT11_OUTPUT. */
479 ovs_be16 len; /* Length is 16. */
480 ovs_be32 port; /* Output port. */
481 ovs_be16 max_len; /* Max length to send to controller. */
482 uint8_t pad[6]; /* Pad to 64 bits. */
483};
484OFP_ASSERT(sizeof(struct ofp11_action_output) == 16);
e45e72f1 485
f25d0cf3 486static enum ofperr
c2d936a4 487decode_OFPAT_RAW10_OUTPUT(const struct ofp10_action_output *oao,
f3cd3ac7 488 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4 489 struct ofpbuf *out)
f25d0cf3
BP
490{
491 struct ofpact_output *output;
492
493 output = ofpact_put_OUTPUT(out);
4e022ec0 494 output->port = u16_to_ofp(ntohs(oao->port));
f25d0cf3
BP
495 output->max_len = ntohs(oao->max_len);
496
57ad4e9e 497 return ofpact_check_output_port(output->port, OFPP_MAX);
f25d0cf3
BP
498}
499
500static enum ofperr
c2d936a4 501decode_OFPAT_RAW11_OUTPUT(const struct ofp11_action_output *oao,
f3cd3ac7
JS
502 enum ofp_version ofp_version OVS_UNUSED,
503 struct ofpbuf *out)
f25d0cf3 504{
c2d936a4
BP
505 struct ofpact_output *output;
506 enum ofperr error;
f25d0cf3 507
c2d936a4
BP
508 output = ofpact_put_OUTPUT(out);
509 output->max_len = ntohs(oao->max_len);
510
511 error = ofputil_port_from_ofp11(oao->port, &output->port);
512 if (error) {
513 return error;
f25d0cf3 514 }
c2d936a4
BP
515
516 return ofpact_check_output_port(output->port, OFPP_MAX);
f25d0cf3
BP
517}
518
519static void
c2d936a4
BP
520encode_OUTPUT(const struct ofpact_output *output,
521 enum ofp_version ofp_version, struct ofpbuf *out)
f25d0cf3 522{
c2d936a4
BP
523 if (ofp_version == OFP10_VERSION) {
524 struct ofp10_action_output *oao;
f25d0cf3 525
c2d936a4
BP
526 oao = put_OFPAT10_OUTPUT(out);
527 oao->port = htons(ofp_to_u16(output->port));
528 oao->max_len = htons(output->max_len);
529 } else {
530 struct ofp11_action_output *oao;
531
532 oao = put_OFPAT11_OUTPUT(out);
533 oao->port = ofputil_port_to_ofp11(output->port);
534 oao->max_len = htons(output->max_len);
535 }
f25d0cf3
BP
536}
537
cab50449 538static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
539parse_OUTPUT(const char *arg, struct ofpbuf *ofpacts,
540 enum ofputil_protocol *usable_protocols OVS_UNUSED)
f25d0cf3 541{
c2d936a4
BP
542 if (strchr(arg, '[')) {
543 struct ofpact_output_reg *output_reg;
f25d0cf3 544
c2d936a4
BP
545 output_reg = ofpact_put_OUTPUT_REG(ofpacts);
546 output_reg->max_len = UINT16_MAX;
547 return mf_parse_subfield(&output_reg->src, arg);
548 } else {
549 struct ofpact_output *output;
550
551 output = ofpact_put_OUTPUT(ofpacts);
552 if (!ofputil_port_from_string(arg, &output->port)) {
553 return xasprintf("%s: output to unknown port", arg);
554 }
555 output->max_len = output->port == OFPP_CONTROLLER ? UINT16_MAX : 0;
556 return NULL;
f25d0cf3 557 }
c2d936a4 558}
f25d0cf3 559
c2d936a4
BP
560static void
561format_OUTPUT(const struct ofpact_output *a, struct ds *s)
562{
563 if (ofp_to_u16(a->port) < ofp_to_u16(OFPP_MAX)) {
b1c5bf1f
QM
564 ds_put_format(s, "%soutput:%s%"PRIu16,
565 colors.special, colors.end, a->port);
c2d936a4
BP
566 } else {
567 ofputil_format_port(a->port, s);
568 if (a->port == OFPP_CONTROLLER) {
569 ds_put_format(s, ":%"PRIu16, a->max_len);
570 }
571 }
f25d0cf3 572}
c2d936a4
BP
573\f
574/* Group actions. */
f25d0cf3
BP
575
576static enum ofperr
f3cd3ac7
JS
577decode_OFPAT_RAW11_GROUP(uint32_t group_id,
578 enum ofp_version ofp_version OVS_UNUSED,
579 struct ofpbuf *out)
f25d0cf3 580{
c2d936a4
BP
581 ofpact_put_GROUP(out)->group_id = group_id;
582 return 0;
583}
f25d0cf3 584
c2d936a4
BP
585static void
586encode_GROUP(const struct ofpact_group *group,
587 enum ofp_version ofp_version, struct ofpbuf *out)
588{
589 if (ofp_version == OFP10_VERSION) {
590 /* XXX */
591 } else {
592 put_OFPAT11_GROUP(out, group->group_id);
f25d0cf3 593 }
c2d936a4 594}
f25d0cf3 595
cab50449 596static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
597parse_GROUP(char *arg, struct ofpbuf *ofpacts,
598 enum ofputil_protocol *usable_protocols OVS_UNUSED)
599{
600 return str_to_u32(arg, &ofpact_put_GROUP(ofpacts)->group_id);
f25d0cf3
BP
601}
602
603static void
c2d936a4 604format_GROUP(const struct ofpact_group *a, struct ds *s)
f25d0cf3 605{
b1c5bf1f
QM
606 ds_put_format(s, "%sgroup:%s%"PRIu32,
607 colors.special, colors.end, a->group_id);
f25d0cf3 608}
c2d936a4
BP
609\f
610/* Action structure for NXAST_CONTROLLER.
611 *
612 * This generalizes using OFPAT_OUTPUT to send a packet to OFPP_CONTROLLER. In
613 * addition to the 'max_len' that OFPAT_OUTPUT supports, it also allows
614 * specifying:
615 *
616 * - 'reason': The reason code to use in the ofp_packet_in or nx_packet_in.
617 *
618 * - 'controller_id': The ID of the controller connection to which the
619 * ofp_packet_in should be sent. The ofp_packet_in or nx_packet_in is
620 * sent only to controllers that have the specified controller connection
621 * ID. See "struct nx_controller_id" for more information. */
622struct nx_action_controller {
623 ovs_be16 type; /* OFPAT_VENDOR. */
624 ovs_be16 len; /* Length is 16. */
625 ovs_be32 vendor; /* NX_VENDOR_ID. */
626 ovs_be16 subtype; /* NXAST_CONTROLLER. */
627 ovs_be16 max_len; /* Maximum length to send to controller. */
628 ovs_be16 controller_id; /* Controller ID to send packet-in. */
629 uint8_t reason; /* enum ofp_packet_in_reason (OFPR_*). */
630 uint8_t zero; /* Must be zero. */
631};
632OFP_ASSERT(sizeof(struct nx_action_controller) == 16);
f25d0cf3 633
77ab5fd2
BP
634/* Properties for NXAST_CONTROLLER2.
635 *
636 * For more information on the effect of NXAC2PT_PAUSE, see the large comment
637 * on NXT_PACKET_IN2 in nicira-ext.h */
bdcad671
BP
638enum nx_action_controller2_prop_type {
639 NXAC2PT_MAX_LEN, /* ovs_be16 max bytes to send (default all). */
640 NXAC2PT_CONTROLLER_ID, /* ovs_be16 dest controller ID (default 0). */
641 NXAC2PT_REASON, /* uint8_t reason (OFPR_*), default 0. */
642 NXAC2PT_USERDATA, /* Data to copy into NXPINT_USERDATA. */
77ab5fd2 643 NXAC2PT_PAUSE, /* Flag to pause pipeline to resume later. */
bdcad671
BP
644};
645
646/* Action structure for NXAST_CONTROLLER2.
647 *
648 * This replacement for NXAST_CONTROLLER makes it extensible via properties. */
649struct nx_action_controller2 {
650 ovs_be16 type; /* OFPAT_VENDOR. */
651 ovs_be16 len; /* Length is 16 or more. */
652 ovs_be32 vendor; /* NX_VENDOR_ID. */
653 ovs_be16 subtype; /* NXAST_CONTROLLER2. */
654 uint8_t zeros[6]; /* Must be zero. */
655 /* Followed by NXAC2PT_* properties. */
656};
657OFP_ASSERT(sizeof(struct nx_action_controller2) == 16);
658
c2d936a4
BP
659static enum ofperr
660decode_NXAST_RAW_CONTROLLER(const struct nx_action_controller *nac,
f3cd3ac7 661 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4 662 struct ofpbuf *out)
f25d0cf3
BP
663{
664 struct ofpact_controller *oc;
665
666 oc = ofpact_put_CONTROLLER(out);
bdcad671 667 oc->ofpact.raw = NXAST_RAW_CONTROLLER;
f25d0cf3
BP
668 oc->max_len = ntohs(nac->max_len);
669 oc->controller_id = ntohs(nac->controller_id);
670 oc->reason = nac->reason;
ce058104 671 ofpact_finish_CONTROLLER(out, &oc);
bdcad671
BP
672
673 return 0;
674}
675
676static enum ofperr
677decode_NXAST_RAW_CONTROLLER2(const struct nx_action_controller2 *nac2,
678 enum ofp_version ofp_version OVS_UNUSED,
679 struct ofpbuf *out)
680{
681 if (!is_all_zeros(nac2->zeros, sizeof nac2->zeros)) {
682 return OFPERR_NXBRC_MUST_BE_ZERO;
683 }
684
685 size_t start_ofs = out->size;
686 struct ofpact_controller *oc = ofpact_put_CONTROLLER(out);
687 oc->ofpact.raw = NXAST_RAW_CONTROLLER2;
688 oc->max_len = UINT16_MAX;
689 oc->reason = OFPR_ACTION;
690
691 struct ofpbuf properties;
692 ofpbuf_use_const(&properties, nac2, ntohs(nac2->len));
693 ofpbuf_pull(&properties, sizeof *nac2);
694
695 while (properties.size > 0) {
696 struct ofpbuf payload;
697 uint64_t type;
698
699 enum ofperr error = ofpprop_pull(&properties, &payload, &type);
700 if (error) {
701 return error;
702 }
703
704 switch (type) {
705 case NXAC2PT_MAX_LEN:
706 error = ofpprop_parse_u16(&payload, &oc->max_len);
707 break;
708
709 case NXAC2PT_CONTROLLER_ID:
710 error = ofpprop_parse_u16(&payload, &oc->controller_id);
711 break;
712
713 case NXAC2PT_REASON: {
714 uint8_t u8;
715 error = ofpprop_parse_u8(&payload, &u8);
716 oc->reason = u8;
717 break;
718 }
719
720 case NXAC2PT_USERDATA:
721 out->size = start_ofs + OFPACT_CONTROLLER_SIZE;
722 ofpbuf_put(out, payload.msg, ofpbuf_msgsize(&payload));
723 oc = ofpbuf_at_assert(out, start_ofs, sizeof *oc);
724 oc->userdata_len = ofpbuf_msgsize(&payload);
725 break;
726
77ab5fd2
BP
727 case NXAC2PT_PAUSE:
728 oc->pause = true;
729 break;
730
bdcad671
BP
731 default:
732 error = OFPPROP_UNKNOWN(false, "NXAST_RAW_CONTROLLER2", type);
733 break;
734 }
735 if (error) {
736 return error;
737 }
738 }
739
ce058104 740 ofpact_finish_CONTROLLER(out, &oc);
bdcad671 741
c2d936a4 742 return 0;
f25d0cf3
BP
743}
744
c2d936a4
BP
745static void
746encode_CONTROLLER(const struct ofpact_controller *controller,
747 enum ofp_version ofp_version OVS_UNUSED,
748 struct ofpbuf *out)
4cceacb9 749{
bdcad671 750 if (controller->userdata_len
77ab5fd2 751 || controller->pause
bdcad671
BP
752 || controller->ofpact.raw == NXAST_RAW_CONTROLLER2) {
753 size_t start_ofs = out->size;
754 put_NXAST_CONTROLLER2(out);
755 if (controller->max_len != UINT16_MAX) {
756 ofpprop_put_u16(out, NXAC2PT_MAX_LEN, controller->max_len);
757 }
758 if (controller->controller_id != 0) {
759 ofpprop_put_u16(out, NXAC2PT_CONTROLLER_ID,
760 controller->controller_id);
761 }
762 if (controller->reason != OFPR_ACTION) {
763 ofpprop_put_u8(out, NXAC2PT_REASON, controller->reason);
764 }
765 if (controller->userdata_len != 0) {
766 ofpprop_put(out, NXAC2PT_USERDATA, controller->userdata,
767 controller->userdata_len);
768 }
77ab5fd2
BP
769 if (controller->pause) {
770 ofpprop_put_flag(out, NXAC2PT_PAUSE);
771 }
bdcad671
BP
772 pad_ofpat(out, start_ofs);
773 } else {
774 struct nx_action_controller *nac;
4cceacb9 775
bdcad671
BP
776 nac = put_NXAST_CONTROLLER(out);
777 nac->max_len = htons(controller->max_len);
778 nac->controller_id = htons(controller->controller_id);
779 nac->reason = controller->reason;
780 }
c2d936a4
BP
781}
782
cab50449 783static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
784parse_CONTROLLER(char *arg, struct ofpbuf *ofpacts,
785 enum ofputil_protocol *usable_protocols OVS_UNUSED)
786{
787 enum ofp_packet_in_reason reason = OFPR_ACTION;
788 uint16_t controller_id = 0;
789 uint16_t max_len = UINT16_MAX;
bdcad671 790 const char *userdata = NULL;
77ab5fd2 791 bool pause = false;
c2d936a4
BP
792
793 if (!arg[0]) {
794 /* Use defaults. */
795 } else if (strspn(arg, "0123456789") == strlen(arg)) {
796 char *error = str_to_u16(arg, "max_len", &max_len);
797 if (error) {
798 return error;
799 }
800 } else {
801 char *name, *value;
802
803 while (ofputil_parse_key_value(&arg, &name, &value)) {
804 if (!strcmp(name, "reason")) {
805 if (!ofputil_packet_in_reason_from_string(value, &reason)) {
806 return xasprintf("unknown reason \"%s\"", value);
807 }
808 } else if (!strcmp(name, "max_len")) {
809 char *error = str_to_u16(value, "max_len", &max_len);
810 if (error) {
811 return error;
812 }
813 } else if (!strcmp(name, "id")) {
814 char *error = str_to_u16(value, "id", &controller_id);
815 if (error) {
816 return error;
817 }
bdcad671
BP
818 } else if (!strcmp(name, "userdata")) {
819 userdata = value;
77ab5fd2
BP
820 } else if (!strcmp(name, "pause")) {
821 pause = true;
c2d936a4
BP
822 } else {
823 return xasprintf("unknown key \"%s\" parsing controller "
824 "action", name);
825 }
826 }
4cceacb9
JS
827 }
828
77ab5fd2 829 if (reason == OFPR_ACTION && controller_id == 0 && !userdata && !pause) {
c2d936a4 830 struct ofpact_output *output;
4cceacb9 831
c2d936a4
BP
832 output = ofpact_put_OUTPUT(ofpacts);
833 output->port = OFPP_CONTROLLER;
834 output->max_len = max_len;
835 } else {
836 struct ofpact_controller *controller;
837
838 controller = ofpact_put_CONTROLLER(ofpacts);
839 controller->max_len = max_len;
840 controller->reason = reason;
841 controller->controller_id = controller_id;
77ab5fd2 842 controller->pause = pause;
bdcad671
BP
843
844 if (userdata) {
845 size_t start_ofs = ofpacts->size;
846 const char *end = ofpbuf_put_hex(ofpacts, userdata, NULL);
847 if (*end) {
848 return xstrdup("bad hex digit in `controller' "
849 "action `userdata'");
850 }
851 size_t userdata_len = ofpacts->size - start_ofs;
852 controller = ofpacts->header;
853 controller->userdata_len = userdata_len;
854 }
ce058104 855 ofpact_finish_CONTROLLER(ofpacts, &controller);
c2d936a4
BP
856 }
857
858 return NULL;
4cceacb9
JS
859}
860
bdcad671
BP
861static void
862format_hex_arg(struct ds *s, const uint8_t *data, size_t len)
863{
864 for (size_t i = 0; i < len; i++) {
865 if (i) {
866 ds_put_char(s, '.');
867 }
868 ds_put_format(s, "%02"PRIx8, data[i]);
869 }
870}
871
f25d0cf3 872static void
c2d936a4 873format_CONTROLLER(const struct ofpact_controller *a, struct ds *s)
f25d0cf3 874{
77ab5fd2
BP
875 if (a->reason == OFPR_ACTION && !a->controller_id && !a->userdata_len
876 && !a->pause) {
b1c5bf1f
QM
877 ds_put_format(s, "%sCONTROLLER:%s%"PRIu16,
878 colors.special, colors.end, a->max_len);
c2d936a4
BP
879 } else {
880 enum ofp_packet_in_reason reason = a->reason;
f25d0cf3 881
b1c5bf1f 882 ds_put_format(s, "%scontroller(%s", colors.paren, colors.end);
c2d936a4
BP
883 if (reason != OFPR_ACTION) {
884 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
885
b1c5bf1f 886 ds_put_format(s, "%sreason=%s%s,", colors.param, colors.end,
c2d936a4
BP
887 ofputil_packet_in_reason_to_string(
888 reason, reasonbuf, sizeof reasonbuf));
889 }
890 if (a->max_len != UINT16_MAX) {
b1c5bf1f
QM
891 ds_put_format(s, "%smax_len=%s%"PRIu16",",
892 colors.param, colors.end, a->max_len);
c2d936a4
BP
893 }
894 if (a->controller_id != 0) {
b1c5bf1f
QM
895 ds_put_format(s, "%sid=%s%"PRIu16",",
896 colors.param, colors.end, a->controller_id);
c2d936a4 897 }
bdcad671 898 if (a->userdata_len) {
b1c5bf1f 899 ds_put_format(s, "%suserdata=%s", colors.param, colors.end);
bdcad671
BP
900 format_hex_arg(s, a->userdata, a->userdata_len);
901 ds_put_char(s, ',');
902 }
77ab5fd2 903 if (a->pause) {
b1c5bf1f 904 ds_put_format(s, "%spause%s,", colors.value, colors.end);
77ab5fd2 905 }
c2d936a4 906 ds_chomp(s, ',');
b1c5bf1f 907 ds_put_format(s, "%s)%s", colors.paren, colors.end);
c2d936a4 908 }
f25d0cf3 909}
c2d936a4
BP
910\f
911/* Enqueue action. */
912struct ofp10_action_enqueue {
913 ovs_be16 type; /* OFPAT10_ENQUEUE. */
914 ovs_be16 len; /* Len is 16. */
915 ovs_be16 port; /* Port that queue belongs. Should
916 refer to a valid physical port
917 (i.e. < OFPP_MAX) or OFPP_IN_PORT. */
918 uint8_t pad[6]; /* Pad for 64-bit alignment. */
919 ovs_be32 queue_id; /* Where to enqueue the packets. */
920};
921OFP_ASSERT(sizeof(struct ofp10_action_enqueue) == 16);
f25d0cf3 922
c2d967a5 923static enum ofperr
c2d936a4 924decode_OFPAT_RAW10_ENQUEUE(const struct ofp10_action_enqueue *oae,
f3cd3ac7 925 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4 926 struct ofpbuf *out)
c2d967a5 927{
c2d936a4 928 struct ofpact_enqueue *enqueue;
c2d967a5 929
c2d936a4
BP
930 enqueue = ofpact_put_ENQUEUE(out);
931 enqueue->port = u16_to_ofp(ntohs(oae->port));
932 enqueue->queue = ntohl(oae->queue_id);
933 if (ofp_to_u16(enqueue->port) >= ofp_to_u16(OFPP_MAX)
934 && enqueue->port != OFPP_IN_PORT
935 && enqueue->port != OFPP_LOCAL) {
936 return OFPERR_OFPBAC_BAD_OUT_PORT;
937 }
938 return 0;
c2d967a5
MM
939}
940
c2d936a4
BP
941static void
942encode_ENQUEUE(const struct ofpact_enqueue *enqueue,
943 enum ofp_version ofp_version, struct ofpbuf *out)
c2d967a5 944{
c2d936a4
BP
945 if (ofp_version == OFP10_VERSION) {
946 struct ofp10_action_enqueue *oae;
c2d967a5 947
c2d936a4
BP
948 oae = put_OFPAT10_ENQUEUE(out);
949 oae->port = htons(ofp_to_u16(enqueue->port));
950 oae->queue_id = htonl(enqueue->queue);
951 } else {
952 /* XXX */
c2d967a5 953 }
c2d936a4 954}
c2d967a5 955
cab50449 956static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
957parse_ENQUEUE(char *arg, struct ofpbuf *ofpacts,
958 enum ofputil_protocol *usable_protocols OVS_UNUSED)
959{
960 char *sp = NULL;
961 char *port = strtok_r(arg, ":q,", &sp);
962 char *queue = strtok_r(NULL, "", &sp);
963 struct ofpact_enqueue *enqueue;
c2d967a5 964
c2d936a4
BP
965 if (port == NULL || queue == NULL) {
966 return xstrdup("\"enqueue\" syntax is \"enqueue:PORT:QUEUE\" or "
967 "\"enqueue(PORT,QUEUE)\"");
c2d967a5
MM
968 }
969
c2d936a4
BP
970 enqueue = ofpact_put_ENQUEUE(ofpacts);
971 if (!ofputil_port_from_string(port, &enqueue->port)) {
972 return xasprintf("%s: enqueue to unknown port", port);
973 }
974 return str_to_u32(queue, &enqueue->queue);
c2d967a5
MM
975}
976
c2d936a4
BP
977static void
978format_ENQUEUE(const struct ofpact_enqueue *a, struct ds *s)
29089a54 979{
b1c5bf1f 980 ds_put_format(s, "%senqueue:%s", colors.param, colors.end);
c2d936a4
BP
981 ofputil_format_port(a->port, s);
982 ds_put_format(s, ":%"PRIu32, a->queue);
983}
984\f
985/* Action structure for NXAST_OUTPUT_REG.
986 *
987 * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
988 *
989 * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
990 * the NXAST_REG_LOAD action.
991 *
992 * The acceptable nxm_header values for 'src' are the same as the acceptable
993 * nxm_header values for the 'src' field of NXAST_REG_MOVE.
994 *
995 * The 'max_len' field indicates the number of bytes to send when the chosen
996 * port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
997 * field of OFPAT_OUTPUT.
998 *
999 * The 'zero' field is required to be zeroed for forward compatibility. */
1000struct nx_action_output_reg {
1001 ovs_be16 type; /* OFPAT_VENDOR. */
1002 ovs_be16 len; /* 24. */
1003 ovs_be32 vendor; /* NX_VENDOR_ID. */
1004 ovs_be16 subtype; /* NXAST_OUTPUT_REG. */
29089a54 1005
c2d936a4
BP
1006 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1007 ovs_be32 src; /* Source. */
29089a54 1008
c2d936a4 1009 ovs_be16 max_len; /* Max length to send to controller. */
29089a54 1010
c2d936a4
BP
1011 uint8_t zero[6]; /* Reserved, must be zero. */
1012};
1013OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
29089a54 1014
bad8a439
BP
1015/* Action structure for NXAST_OUTPUT_REG2.
1016 *
1017 * Like the NXAST_OUTPUT_REG but organized so that there is room for a 64-bit
1018 * experimenter OXM as 'src'.
1019 */
1020struct nx_action_output_reg2 {
1021 ovs_be16 type; /* OFPAT_VENDOR. */
1022 ovs_be16 len; /* 24. */
1023 ovs_be32 vendor; /* NX_VENDOR_ID. */
1024 ovs_be16 subtype; /* NXAST_OUTPUT_REG2. */
1025
1026 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1027 ovs_be16 max_len; /* Max length to send to controller. */
1028
1029 /* Followed by:
1030 * - 'src', as an OXM/NXM header (either 4 or 8 bytes).
1031 * - Enough 0-bytes to pad the action out to 24 bytes. */
1032 uint8_t pad[10];
1033};
1034OFP_ASSERT(sizeof(struct nx_action_output_reg2) == 24);
1035
a7a2d006 1036static enum ofperr
c2d936a4 1037decode_NXAST_RAW_OUTPUT_REG(const struct nx_action_output_reg *naor,
f3cd3ac7 1038 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4 1039 struct ofpbuf *out)
a7a2d006 1040{
c2d936a4 1041 struct ofpact_output_reg *output_reg;
a7a2d006 1042
c2d936a4 1043 if (!is_all_zeros(naor->zero, sizeof naor->zero)) {
a7a2d006
JS
1044 return OFPERR_OFPBAC_BAD_ARGUMENT;
1045 }
a7a2d006 1046
c2d936a4 1047 output_reg = ofpact_put_OUTPUT_REG(out);
bad8a439 1048 output_reg->ofpact.raw = NXAST_RAW_OUTPUT_REG;
c2d936a4
BP
1049 output_reg->src.field = mf_from_nxm_header(ntohl(naor->src));
1050 output_reg->src.ofs = nxm_decode_ofs(naor->ofs_nbits);
1051 output_reg->src.n_bits = nxm_decode_n_bits(naor->ofs_nbits);
1052 output_reg->max_len = ntohs(naor->max_len);
1053
1054 return mf_check_src(&output_reg->src, NULL);
a7a2d006
JS
1055}
1056
bad8a439
BP
1057static enum ofperr
1058decode_NXAST_RAW_OUTPUT_REG2(const struct nx_action_output_reg2 *naor,
f3cd3ac7
JS
1059 enum ofp_version ofp_version OVS_UNUSED,
1060 struct ofpbuf *out)
bad8a439
BP
1061{
1062 struct ofpact_output_reg *output_reg;
bad8a439
BP
1063 output_reg = ofpact_put_OUTPUT_REG(out);
1064 output_reg->ofpact.raw = NXAST_RAW_OUTPUT_REG2;
1065 output_reg->src.ofs = nxm_decode_ofs(naor->ofs_nbits);
1066 output_reg->src.n_bits = nxm_decode_n_bits(naor->ofs_nbits);
1067 output_reg->max_len = ntohs(naor->max_len);
1068
0a2869d5 1069 struct ofpbuf b = ofpbuf_const_initializer(naor, ntohs(naor->len));
bad8a439 1070 ofpbuf_pull(&b, OBJECT_OFFSETOF(naor, pad));
0a2869d5
BP
1071
1072 enum ofperr error = nx_pull_header(&b, &output_reg->src.field, NULL);
bad8a439
BP
1073 if (error) {
1074 return error;
1075 }
6fd6ed71 1076 if (!is_all_zeros(b.data, b.size)) {
bad8a439
BP
1077 return OFPERR_NXBRC_MUST_BE_ZERO;
1078 }
1079
1080 return mf_check_src(&output_reg->src, NULL);
1081}
1082
c2d936a4
BP
1083static void
1084encode_OUTPUT_REG(const struct ofpact_output_reg *output_reg,
1085 enum ofp_version ofp_version OVS_UNUSED,
1086 struct ofpbuf *out)
f25d0cf3 1087{
bad8a439
BP
1088 /* If 'output_reg' came in as an NXAST_RAW_OUTPUT_REG2 action, or if it
1089 * cannot be encoded in the older form, encode it as
1090 * NXAST_RAW_OUTPUT_REG2. */
1091 if (output_reg->ofpact.raw == NXAST_RAW_OUTPUT_REG2
1092 || !mf_nxm_header(output_reg->src.field->id)) {
1093 struct nx_action_output_reg2 *naor = put_NXAST_OUTPUT_REG2(out);
6fd6ed71 1094 size_t size = out->size;
bad8a439
BP
1095
1096 naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
1097 output_reg->src.n_bits);
1098 naor->max_len = htons(output_reg->max_len);
1099
6fd6ed71 1100 out->size = size - sizeof naor->pad;
bad8a439 1101 nx_put_header(out, output_reg->src.field->id, 0, false);
6fd6ed71 1102 out->size = size;
bad8a439
BP
1103 } else {
1104 struct nx_action_output_reg *naor = put_NXAST_OUTPUT_REG(out);
f25d0cf3 1105
bad8a439
BP
1106 naor->ofs_nbits = nxm_encode_ofs_nbits(output_reg->src.ofs,
1107 output_reg->src.n_bits);
1108 naor->src = htonl(mf_nxm_header(output_reg->src.field->id));
1109 naor->max_len = htons(output_reg->max_len);
1110 }
f25d0cf3
BP
1111}
1112
cab50449 1113static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1114parse_OUTPUT_REG(const char *arg, struct ofpbuf *ofpacts,
1115 enum ofputil_protocol *usable_protocols OVS_UNUSED)
f25d0cf3 1116{
c2d936a4 1117 return parse_OUTPUT(arg, ofpacts, usable_protocols);
f25d0cf3
BP
1118}
1119
c2d936a4
BP
1120static void
1121format_OUTPUT_REG(const struct ofpact_output_reg *a, struct ds *s)
f25d0cf3 1122{
b1c5bf1f 1123 ds_put_format(s, "%soutput:%s", colors.special, colors.end);
c2d936a4
BP
1124 mf_format_subfield(&a->src, s);
1125}
1126\f
1127/* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
1128 *
1129 * The bundle actions choose a slave from a supplied list of options.
1130 * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
1131 * selection to a register.
1132 *
1133 * The list of possible slaves follows the nx_action_bundle structure. The size
1134 * of each slave is governed by its type as indicated by the 'slave_type'
1135 * parameter. The list of slaves should be padded at its end with zeros to make
1136 * the total length of the action a multiple of 8.
1137 *
1138 * Switches infer from the 'slave_type' parameter the size of each slave. All
1139 * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
1140 * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
1141 * 2 byte width. Switches should reject actions which indicate unknown or
1142 * unsupported slave types.
1143 *
1144 * Switches use a strategy dictated by the 'algorithm' parameter to choose a
1145 * slave. If the switch does not support the specified 'algorithm' parameter,
1146 * it should reject the action.
1147 *
1148 * Several algorithms take into account liveness when selecting slaves. The
1149 * liveness of a slave is implementation defined (with one exception), but will
1150 * generally take into account things like its carrier status and the results
1151 * of any link monitoring protocols which happen to be running on it. In order
1152 * to give controllers a place-holder value, the OFPP_NONE port is always
1153 * considered live.
1154 *
1155 * Some slave selection strategies require the use of a hash function, in which
1156 * case the 'fields' and 'basis' parameters should be populated. The 'fields'
1157 * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
1158 * hash. Refer to the definition of "enum nx_hash_fields" for details. The
1159 * 'basis' parameter is used as a universal hash parameter. Different values
1160 * of 'basis' yield different hash results.
1161 *
1162 * The 'zero' parameter at the end of the action structure is reserved for
1163 * future use. Switches are required to reject actions which have nonzero
1164 * bytes in the 'zero' field.
1165 *
1166 * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
1167 * should reject actions which have nonzero bytes in either of these fields.
1168 *
1169 * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
1170 * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
1171 * similar to those for the NXAST_REG_LOAD action. */
1172struct nx_action_bundle {
1173 ovs_be16 type; /* OFPAT_VENDOR. */
1174 ovs_be16 len; /* Length including slaves. */
1175 ovs_be32 vendor; /* NX_VENDOR_ID. */
1176 ovs_be16 subtype; /* NXAST_BUNDLE or NXAST_BUNDLE_LOAD. */
f25d0cf3 1177
c2d936a4
BP
1178 /* Slave choice algorithm to apply to hash value. */
1179 ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
4cceacb9 1180
c2d936a4
BP
1181 /* What fields to hash and how. */
1182 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
1183 ovs_be16 basis; /* Universal hash parameter. */
f25d0cf3 1184
c2d936a4
BP
1185 ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
1186 ovs_be16 n_slaves; /* Number of slaves. */
f25d0cf3 1187
c2d936a4
BP
1188 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1189 ovs_be32 dst; /* Destination. */
f25d0cf3 1190
c2d936a4
BP
1191 uint8_t zero[4]; /* Reserved. Must be zero. */
1192};
1193OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
f25d0cf3 1194
c2d936a4
BP
1195static enum ofperr
1196decode_bundle(bool load, const struct nx_action_bundle *nab,
1197 struct ofpbuf *ofpacts)
1198{
1199 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1200 struct ofpact_bundle *bundle;
1201 uint32_t slave_type;
1202 size_t slaves_size, i;
1203 enum ofperr error;
bd85dac1 1204
c2d936a4
BP
1205 bundle = ofpact_put_BUNDLE(ofpacts);
1206
1207 bundle->n_slaves = ntohs(nab->n_slaves);
1208 bundle->basis = ntohs(nab->basis);
1209 bundle->fields = ntohs(nab->fields);
1210 bundle->algorithm = ntohs(nab->algorithm);
1211 slave_type = ntohl(nab->slave_type);
1212 slaves_size = ntohs(nab->len) - sizeof *nab;
1213
1214 error = OFPERR_OFPBAC_BAD_ARGUMENT;
1215 if (!flow_hash_fields_valid(bundle->fields)) {
1216 VLOG_WARN_RL(&rl, "unsupported fields %d", (int) bundle->fields);
1217 } else if (bundle->n_slaves > BUNDLE_MAX_SLAVES) {
1218 VLOG_WARN_RL(&rl, "too many slaves");
1219 } else if (bundle->algorithm != NX_BD_ALG_HRW
1220 && bundle->algorithm != NX_BD_ALG_ACTIVE_BACKUP) {
1221 VLOG_WARN_RL(&rl, "unsupported algorithm %d", (int) bundle->algorithm);
508a9338 1222 } else if (slave_type != mf_nxm_header(MFF_IN_PORT)) {
c2d936a4
BP
1223 VLOG_WARN_RL(&rl, "unsupported slave type %"PRIu16, slave_type);
1224 } else {
1225 error = 0;
1226 }
bd85dac1 1227
c2d936a4
BP
1228 if (!is_all_zeros(nab->zero, sizeof nab->zero)) {
1229 VLOG_WARN_RL(&rl, "reserved field is nonzero");
1230 error = OFPERR_OFPBAC_BAD_ARGUMENT;
1231 }
f25d0cf3 1232
c2d936a4
BP
1233 if (load) {
1234 bundle->dst.field = mf_from_nxm_header(ntohl(nab->dst));
1235 bundle->dst.ofs = nxm_decode_ofs(nab->ofs_nbits);
1236 bundle->dst.n_bits = nxm_decode_n_bits(nab->ofs_nbits);
f25d0cf3 1237
c2d936a4
BP
1238 if (bundle->dst.n_bits < 16) {
1239 VLOG_WARN_RL(&rl, "bundle_load action requires at least 16 bit "
1240 "destination.");
1241 error = OFPERR_OFPBAC_BAD_ARGUMENT;
1242 }
1243 } else {
1244 if (nab->ofs_nbits || nab->dst) {
1245 VLOG_WARN_RL(&rl, "bundle action has nonzero reserved fields");
1246 error = OFPERR_OFPBAC_BAD_ARGUMENT;
1247 }
1248 }
f25d0cf3 1249
c2d936a4
BP
1250 if (slaves_size < bundle->n_slaves * sizeof(ovs_be16)) {
1251 VLOG_WARN_RL(&rl, "Nicira action %s only has %"PRIuSIZE" bytes "
1252 "allocated for slaves. %"PRIuSIZE" bytes are required "
1253 "for %"PRIu16" slaves.",
1254 load ? "bundle_load" : "bundle", slaves_size,
1255 bundle->n_slaves * sizeof(ovs_be16), bundle->n_slaves);
1256 error = OFPERR_OFPBAC_BAD_LEN;
1257 }
f25d0cf3 1258
c2d936a4
BP
1259 for (i = 0; i < bundle->n_slaves; i++) {
1260 uint16_t ofp_port = ntohs(((ovs_be16 *)(nab + 1))[i]);
1261 ofpbuf_put(ofpacts, &ofp_port, sizeof ofp_port);
19b58f3c 1262 bundle = ofpacts->header;
c2d936a4 1263 }
f25d0cf3 1264
ce058104 1265 ofpact_finish_BUNDLE(ofpacts, &bundle);
c2d936a4
BP
1266 if (!error) {
1267 error = bundle_check(bundle, OFPP_MAX, NULL);
1268 }
1269 return error;
1270}
f25d0cf3 1271
c2d936a4 1272static enum ofperr
f3cd3ac7
JS
1273decode_NXAST_RAW_BUNDLE(const struct nx_action_bundle *nab,
1274 enum ofp_version ofp_version OVS_UNUSED,
1275 struct ofpbuf *out)
c2d936a4
BP
1276{
1277 return decode_bundle(false, nab, out);
1278}
f25d0cf3 1279
c2d936a4
BP
1280static enum ofperr
1281decode_NXAST_RAW_BUNDLE_LOAD(const struct nx_action_bundle *nab,
f3cd3ac7 1282 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4
BP
1283 struct ofpbuf *out)
1284{
1285 return decode_bundle(true, nab, out);
1286}
c2d967a5 1287
c2d936a4
BP
1288static void
1289encode_BUNDLE(const struct ofpact_bundle *bundle,
1290 enum ofp_version ofp_version OVS_UNUSED,
1291 struct ofpbuf *out)
1292{
1293 int slaves_len = ROUND_UP(2 * bundle->n_slaves, OFP_ACTION_ALIGN);
1294 struct nx_action_bundle *nab;
1295 ovs_be16 *slaves;
1296 size_t i;
f25d0cf3 1297
c2d936a4
BP
1298 nab = (bundle->dst.field
1299 ? put_NXAST_BUNDLE_LOAD(out)
1300 : put_NXAST_BUNDLE(out));
1301 nab->len = htons(ntohs(nab->len) + slaves_len);
1302 nab->algorithm = htons(bundle->algorithm);
1303 nab->fields = htons(bundle->fields);
1304 nab->basis = htons(bundle->basis);
508a9338 1305 nab->slave_type = htonl(mf_nxm_header(MFF_IN_PORT));
c2d936a4
BP
1306 nab->n_slaves = htons(bundle->n_slaves);
1307 if (bundle->dst.field) {
1308 nab->ofs_nbits = nxm_encode_ofs_nbits(bundle->dst.ofs,
1309 bundle->dst.n_bits);
508a9338 1310 nab->dst = htonl(mf_nxm_header(bundle->dst.field->id));
c2d936a4 1311 }
f25d0cf3 1312
c2d936a4
BP
1313 slaves = ofpbuf_put_zeros(out, slaves_len);
1314 for (i = 0; i < bundle->n_slaves; i++) {
1315 slaves[i] = htons(ofp_to_u16(bundle->slaves[i]));
1316 }
1317}
b02475c5 1318
cab50449 1319static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1320parse_BUNDLE(const char *arg, struct ofpbuf *ofpacts,
1321 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1322{
1323 return bundle_parse(arg, ofpacts);
1324}
b02475c5 1325
cab50449 1326static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1327parse_bundle_load(const char *arg, struct ofpbuf *ofpacts)
1328{
1329 return bundle_parse_load(arg, ofpacts);
1330}
097d4939 1331
c2d936a4
BP
1332static void
1333format_BUNDLE(const struct ofpact_bundle *a, struct ds *s)
1334{
1335 bundle_format(a, s);
1336}
1337\f
1338/* Set VLAN actions. */
097d4939 1339
c2d936a4
BP
1340static enum ofperr
1341decode_set_vlan_vid(uint16_t vid, bool push_vlan_if_needed, struct ofpbuf *out)
1342{
1343 if (vid & ~0xfff) {
1344 return OFPERR_OFPBAC_BAD_ARGUMENT;
1345 } else {
1346 struct ofpact_vlan_vid *vlan_vid = ofpact_put_SET_VLAN_VID(out);
1347 vlan_vid->vlan_vid = vid;
1348 vlan_vid->push_vlan_if_needed = push_vlan_if_needed;
1349 return 0;
1350 }
1351}
0f3f3c3d 1352
c2d936a4 1353static enum ofperr
f3cd3ac7
JS
1354decode_OFPAT_RAW10_SET_VLAN_VID(uint16_t vid,
1355 enum ofp_version ofp_version OVS_UNUSED,
1356 struct ofpbuf *out)
c2d936a4
BP
1357{
1358 return decode_set_vlan_vid(vid, true, out);
1359}
b676167a 1360
c2d936a4 1361static enum ofperr
f3cd3ac7
JS
1362decode_OFPAT_RAW11_SET_VLAN_VID(uint16_t vid,
1363 enum ofp_version ofp_version OVS_UNUSED,
1364 struct ofpbuf *out)
c2d936a4
BP
1365{
1366 return decode_set_vlan_vid(vid, false, out);
1367}
29089a54 1368
c2d936a4
BP
1369static void
1370encode_SET_VLAN_VID(const struct ofpact_vlan_vid *vlan_vid,
1371 enum ofp_version ofp_version, struct ofpbuf *out)
1372{
1373 uint16_t vid = vlan_vid->vlan_vid;
1374
1375 /* Push a VLAN tag, if none is present and this form of the action calls
1376 * for such a feature. */
1377 if (ofp_version > OFP10_VERSION
1378 && vlan_vid->push_vlan_if_needed
1379 && !vlan_vid->flow_has_vlan) {
1380 put_OFPAT11_PUSH_VLAN(out, htons(ETH_TYPE_VLAN_8021Q));
f25d0cf3
BP
1381 }
1382
c2d936a4
BP
1383 if (ofp_version == OFP10_VERSION) {
1384 put_OFPAT10_SET_VLAN_VID(out, vid);
1385 } else if (ofp_version == OFP11_VERSION) {
1386 put_OFPAT11_SET_VLAN_VID(out, vid);
1387 } else {
1388 ofpact_put_set_field(out, ofp_version,
1389 MFF_VLAN_VID, vid | OFPVID12_PRESENT);
1390 }
f25d0cf3
BP
1391}
1392
cab50449 1393static char * OVS_WARN_UNUSED_RESULT
c2d936a4 1394parse_set_vlan_vid(char *arg, struct ofpbuf *ofpacts, bool push_vlan_if_needed)
d01c980f 1395{
ca287d20 1396 struct ofpact_vlan_vid *vlan_vid;
c2d936a4
BP
1397 uint16_t vid;
1398 char *error;
d01c980f 1399
c2d936a4 1400 error = str_to_u16(arg, "VLAN VID", &vid);
d01c980f
BP
1401 if (error) {
1402 return error;
1403 }
1404
c2d936a4
BP
1405 if (vid & ~VLAN_VID_MASK) {
1406 return xasprintf("%s: not a valid VLAN VID", arg);
d01c980f 1407 }
c2d936a4
BP
1408 vlan_vid = ofpact_put_SET_VLAN_VID(ofpacts);
1409 vlan_vid->vlan_vid = vid;
1410 vlan_vid->push_vlan_if_needed = push_vlan_if_needed;
1411 return NULL;
1412}
d01c980f 1413
cab50449 1414static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1415parse_SET_VLAN_VID(char *arg, struct ofpbuf *ofpacts,
1416 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1417{
1418 return parse_set_vlan_vid(arg, ofpacts, false);
d01c980f
BP
1419}
1420
c2d936a4
BP
1421static void
1422format_SET_VLAN_VID(const struct ofpact_vlan_vid *a, struct ds *s)
1423{
b1c5bf1f 1424 ds_put_format(s, "%s%s:%s%"PRIu16, colors.param,
c2d936a4 1425 a->push_vlan_if_needed ? "mod_vlan_vid" : "set_vlan_vid",
b1c5bf1f 1426 colors.end, a->vlan_vid);
c2d936a4
BP
1427}
1428\f
1429/* Set PCP actions. */
e3f8f887 1430
c2d936a4
BP
1431static enum ofperr
1432decode_set_vlan_pcp(uint8_t pcp, bool push_vlan_if_needed, struct ofpbuf *out)
f25d0cf3 1433{
c2d936a4
BP
1434 if (pcp & ~7) {
1435 return OFPERR_OFPBAC_BAD_ARGUMENT;
1436 } else {
1437 struct ofpact_vlan_pcp *vlan_pcp = ofpact_put_SET_VLAN_PCP(out);
1438 vlan_pcp->vlan_pcp = pcp;
1439 vlan_pcp->push_vlan_if_needed = push_vlan_if_needed;
1440 return 0;
1441 }
f25d0cf3
BP
1442}
1443
c2d936a4 1444static enum ofperr
f3cd3ac7
JS
1445decode_OFPAT_RAW10_SET_VLAN_PCP(uint8_t pcp,
1446 enum ofp_version ofp_version OVS_UNUSED,
1447 struct ofpbuf *out)
f25d0cf3 1448{
c2d936a4 1449 return decode_set_vlan_pcp(pcp, true, out);
f25d0cf3
BP
1450}
1451
c2d936a4 1452static enum ofperr
f3cd3ac7
JS
1453decode_OFPAT_RAW11_SET_VLAN_PCP(uint8_t pcp,
1454 enum ofp_version ofp_version OVS_UNUSED,
1455 struct ofpbuf *out)
c2d936a4
BP
1456{
1457 return decode_set_vlan_pcp(pcp, false, out);
1458}
f25d0cf3 1459
699dddf1 1460static void
c2d936a4
BP
1461encode_SET_VLAN_PCP(const struct ofpact_vlan_pcp *vlan_pcp,
1462 enum ofp_version ofp_version, struct ofpbuf *out)
699dddf1 1463{
c2d936a4
BP
1464 uint8_t pcp = vlan_pcp->vlan_pcp;
1465
1466 /* Push a VLAN tag, if none is present and this form of the action calls
1467 * for such a feature. */
1468 if (ofp_version > OFP10_VERSION
1469 && vlan_pcp->push_vlan_if_needed
1470 && !vlan_pcp->flow_has_vlan) {
1471 put_OFPAT11_PUSH_VLAN(out, htons(ETH_TYPE_VLAN_8021Q));
1472 }
699dddf1 1473
c2d936a4
BP
1474 if (ofp_version == OFP10_VERSION) {
1475 put_OFPAT10_SET_VLAN_PCP(out, pcp);
1476 } else if (ofp_version == OFP11_VERSION) {
1477 put_OFPAT11_SET_VLAN_PCP(out, pcp);
1478 } else {
1479 ofpact_put_set_field(out, ofp_version, MFF_VLAN_PCP, pcp);
699dddf1
BP
1480 }
1481}
1482
cab50449 1483static char * OVS_WARN_UNUSED_RESULT
c2d936a4 1484parse_set_vlan_pcp(char *arg, struct ofpbuf *ofpacts, bool push_vlan_if_needed)
f25d0cf3 1485{
c2d936a4
BP
1486 struct ofpact_vlan_pcp *vlan_pcp;
1487 uint8_t pcp;
1488 char *error;
e3f8f887 1489
c2d936a4
BP
1490 error = str_to_u8(arg, "VLAN PCP", &pcp);
1491 if (error) {
699dddf1 1492 return error;
f25d0cf3
BP
1493 }
1494
c2d936a4
BP
1495 if (pcp & ~7) {
1496 return xasprintf("%s: not a valid VLAN PCP", arg);
1497 }
1498 vlan_pcp = ofpact_put_SET_VLAN_PCP(ofpacts);
1499 vlan_pcp->vlan_pcp = pcp;
1500 vlan_pcp->push_vlan_if_needed = push_vlan_if_needed;
1501 return NULL;
1502}
1503
cab50449 1504static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1505parse_SET_VLAN_PCP(char *arg, struct ofpbuf *ofpacts,
1506 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1507{
1508 return parse_set_vlan_pcp(arg, ofpacts, false);
1509}
1510
1511static void
1512format_SET_VLAN_PCP(const struct ofpact_vlan_pcp *a, struct ds *s)
1513{
b1c5bf1f 1514 ds_put_format(s, "%s%s:%s%"PRIu8, colors.param,
c2d936a4 1515 a->push_vlan_if_needed ? "mod_vlan_pcp" : "set_vlan_pcp",
b1c5bf1f 1516 colors.end, a->vlan_pcp);
c2d936a4
BP
1517}
1518\f
1519/* Strip VLAN actions. */
1520
1521static enum ofperr
1522decode_OFPAT_RAW10_STRIP_VLAN(struct ofpbuf *out)
1523{
1524 ofpact_put_STRIP_VLAN(out)->ofpact.raw = OFPAT_RAW10_STRIP_VLAN;
f25d0cf3
BP
1525 return 0;
1526}
1527
8f2cded4 1528static enum ofperr
c2d936a4 1529decode_OFPAT_RAW11_POP_VLAN(struct ofpbuf *out)
8f2cded4 1530{
c2d936a4
BP
1531 ofpact_put_STRIP_VLAN(out)->ofpact.raw = OFPAT_RAW11_POP_VLAN;
1532 return 0;
1533}
f25d0cf3 1534
c2d936a4
BP
1535static void
1536encode_STRIP_VLAN(const struct ofpact_null *null OVS_UNUSED,
1537 enum ofp_version ofp_version, struct ofpbuf *out)
1538{
1539 if (ofp_version == OFP10_VERSION) {
1540 put_OFPAT10_STRIP_VLAN(out);
1541 } else {
1542 put_OFPAT11_POP_VLAN(out);
1543 }
1544}
f25d0cf3 1545
cab50449 1546static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1547parse_STRIP_VLAN(char *arg OVS_UNUSED, struct ofpbuf *ofpacts,
1548 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1549{
1550 ofpact_put_STRIP_VLAN(ofpacts)->ofpact.raw = OFPAT_RAW10_STRIP_VLAN;
1551 return NULL;
1552}
1553
cab50449 1554static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1555parse_pop_vlan(struct ofpbuf *ofpacts)
1556{
1557 ofpact_put_STRIP_VLAN(ofpacts)->ofpact.raw = OFPAT_RAW11_POP_VLAN;
1558 return NULL;
1559}
1560
1561static void
1562format_STRIP_VLAN(const struct ofpact_null *a, struct ds *s)
1563{
b1c5bf1f
QM
1564 ds_put_format(s, (a->ofpact.raw == OFPAT_RAW11_POP_VLAN
1565 ? "%spop_vlan%s"
1566 : "%sstrip_vlan%s"),
1567 colors.value, colors.end);
c2d936a4
BP
1568}
1569\f
1570/* Push VLAN action. */
1571
1572static enum ofperr
f3cd3ac7
JS
1573decode_OFPAT_RAW11_PUSH_VLAN(ovs_be16 eth_type,
1574 enum ofp_version ofp_version OVS_UNUSED,
1575 struct ofpbuf *out)
c2d936a4
BP
1576{
1577 if (eth_type != htons(ETH_TYPE_VLAN_8021Q)) {
1578 /* XXX 802.1AD(QinQ) isn't supported at the moment */
1579 return OFPERR_OFPBAC_BAD_ARGUMENT;
f25d0cf3 1580 }
c2d936a4
BP
1581 ofpact_put_PUSH_VLAN(out);
1582 return 0;
1583}
f25d0cf3 1584
c2d936a4
BP
1585static void
1586encode_PUSH_VLAN(const struct ofpact_null *null OVS_UNUSED,
1587 enum ofp_version ofp_version, struct ofpbuf *out)
1588{
1589 if (ofp_version == OFP10_VERSION) {
1590 /* PUSH is a side effect of a SET_VLAN_VID/PCP, which should
1591 * follow this action. */
1592 } else {
1593 /* XXX ETH_TYPE_VLAN_8021AD case */
1594 put_OFPAT11_PUSH_VLAN(out, htons(ETH_TYPE_VLAN_8021Q));
f25d0cf3 1595 }
c2d936a4 1596}
f25d0cf3 1597
cab50449 1598static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1599parse_PUSH_VLAN(char *arg, struct ofpbuf *ofpacts,
1600 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1601{
1602 uint16_t ethertype;
1603 char *error;
1604
1605 *usable_protocols &= OFPUTIL_P_OF11_UP;
1606 error = str_to_u16(arg, "ethertype", &ethertype);
4cceacb9 1607 if (error) {
4cceacb9
JS
1608 return error;
1609 }
1610
c2d936a4
BP
1611 if (ethertype != ETH_TYPE_VLAN_8021Q) {
1612 /* XXX ETH_TYPE_VLAN_8021AD case isn't supported */
1613 return xasprintf("%s: not a valid VLAN ethertype", arg);
f25d0cf3 1614 }
c2d936a4
BP
1615
1616 ofpact_put_PUSH_VLAN(ofpacts);
1617 return NULL;
d01c980f
BP
1618}
1619
c2d936a4
BP
1620static void
1621format_PUSH_VLAN(const struct ofpact_null *a OVS_UNUSED, struct ds *s)
8f2cded4 1622{
c2d936a4 1623 /* XXX 802.1AD case*/
b1c5bf1f
QM
1624 ds_put_format(s, "%spush_vlan:%s%#"PRIx16,
1625 colors.param, colors.end, ETH_TYPE_VLAN_8021Q);
8f2cded4 1626}
d01c980f 1627\f
c2d936a4
BP
1628/* Action structure for OFPAT10_SET_DL_SRC/DST and OFPAT11_SET_DL_SRC/DST. */
1629struct ofp_action_dl_addr {
1630 ovs_be16 type; /* Type. */
1631 ovs_be16 len; /* Length is 16. */
74ff3298 1632 struct eth_addr dl_addr; /* Ethernet address. */
c2d936a4
BP
1633 uint8_t pad[6];
1634};
1635OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
d01c980f 1636
d01c980f 1637static enum ofperr
c2d936a4 1638decode_OFPAT_RAW_SET_DL_SRC(const struct ofp_action_dl_addr *a,
f3cd3ac7 1639 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4 1640 struct ofpbuf *out)
d01c980f 1641{
74ff3298 1642 ofpact_put_SET_ETH_SRC(out)->mac = a->dl_addr;
c2d936a4
BP
1643 return 0;
1644}
3ddcaf2d 1645
c2d936a4
BP
1646static enum ofperr
1647decode_OFPAT_RAW_SET_DL_DST(const struct ofp_action_dl_addr *a,
f3cd3ac7 1648 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4
BP
1649 struct ofpbuf *out)
1650{
74ff3298 1651 ofpact_put_SET_ETH_DST(out)->mac = a->dl_addr;
c2d936a4
BP
1652 return 0;
1653}
d01c980f 1654
c2d936a4
BP
1655static void
1656encode_SET_ETH_addr(const struct ofpact_mac *mac, enum ofp_version ofp_version,
1657 enum ofp_raw_action_type raw, enum mf_field_id field,
1658 struct ofpbuf *out)
1659{
c2d936a4
BP
1660 if (ofp_version < OFP12_VERSION) {
1661 struct ofp_action_dl_addr *oada;
1662
1663 oada = ofpact_put_raw(out, ofp_version, raw, 0);
74ff3298 1664 oada->dl_addr = mac->mac;
c2d936a4
BP
1665 } else {
1666 ofpact_put_set_field(out, ofp_version, field,
74ff3298 1667 eth_addr_to_uint64(mac->mac));
d01c980f
BP
1668 }
1669}
1670
c2d936a4
BP
1671static void
1672encode_SET_ETH_SRC(const struct ofpact_mac *mac, enum ofp_version ofp_version,
1673 struct ofpbuf *out)
b2dd70be 1674{
c2d936a4
BP
1675 encode_SET_ETH_addr(mac, ofp_version, OFPAT_RAW_SET_DL_SRC, MFF_ETH_SRC,
1676 out);
b2dd70be 1677
c2d936a4 1678}
b2dd70be 1679
c2d936a4
BP
1680static void
1681encode_SET_ETH_DST(const struct ofpact_mac *mac,
1682 enum ofp_version ofp_version,
1683 struct ofpbuf *out)
1684{
1685 encode_SET_ETH_addr(mac, ofp_version, OFPAT_RAW_SET_DL_DST, MFF_ETH_DST,
1686 out);
b2dd70be 1687
c2d936a4 1688}
b2dd70be 1689
cab50449 1690static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1691parse_SET_ETH_SRC(char *arg, struct ofpbuf *ofpacts,
1692 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1693{
74ff3298 1694 return str_to_mac(arg, &ofpact_put_SET_ETH_SRC(ofpacts)->mac);
c2d936a4
BP
1695}
1696
cab50449 1697static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1698parse_SET_ETH_DST(char *arg, struct ofpbuf *ofpacts,
1699 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1700{
74ff3298 1701 return str_to_mac(arg, &ofpact_put_SET_ETH_DST(ofpacts)->mac);
b2dd70be
JR
1702}
1703
1704static void
c2d936a4 1705format_SET_ETH_SRC(const struct ofpact_mac *a, struct ds *s)
b2dd70be 1706{
b1c5bf1f
QM
1707 ds_put_format(s, "%smod_dl_src:%s"ETH_ADDR_FMT,
1708 colors.param, colors.end, ETH_ADDR_ARGS(a->mac));
c2d936a4 1709}
b2dd70be 1710
c2d936a4
BP
1711static void
1712format_SET_ETH_DST(const struct ofpact_mac *a, struct ds *s)
1713{
b1c5bf1f
QM
1714 ds_put_format(s, "%smod_dl_dst:%s"ETH_ADDR_FMT,
1715 colors.param, colors.end, ETH_ADDR_ARGS(a->mac));
c2d936a4
BP
1716}
1717\f
1718/* Set IPv4 address actions. */
b2dd70be 1719
c2d936a4 1720static enum ofperr
f3cd3ac7
JS
1721decode_OFPAT_RAW_SET_NW_SRC(ovs_be32 ipv4,
1722 enum ofp_version ofp_version OVS_UNUSED,
1723 struct ofpbuf *out)
c2d936a4
BP
1724{
1725 ofpact_put_SET_IPV4_SRC(out)->ipv4 = ipv4;
1726 return 0;
b2dd70be
JR
1727}
1728
c2d936a4 1729static enum ofperr
f3cd3ac7
JS
1730decode_OFPAT_RAW_SET_NW_DST(ovs_be32 ipv4,
1731 enum ofp_version ofp_version OVS_UNUSED,
1732 struct ofpbuf *out)
b2dd70be 1733{
c2d936a4
BP
1734 ofpact_put_SET_IPV4_DST(out)->ipv4 = ipv4;
1735 return 0;
1736}
b2dd70be 1737
c2d936a4
BP
1738static void
1739encode_SET_IPV4_addr(const struct ofpact_ipv4 *ipv4,
1740 enum ofp_version ofp_version,
1741 enum ofp_raw_action_type raw, enum mf_field_id field,
1742 struct ofpbuf *out)
1743{
1744 ovs_be32 addr = ipv4->ipv4;
1745 if (ofp_version < OFP12_VERSION) {
1746 ofpact_put_raw(out, ofp_version, raw, ntohl(addr));
b2dd70be 1747 } else {
c2d936a4 1748 ofpact_put_set_field(out, ofp_version, field, ntohl(addr));
b2dd70be
JR
1749 }
1750}
1751
a6fd70bb 1752static void
c2d936a4
BP
1753encode_SET_IPV4_SRC(const struct ofpact_ipv4 *ipv4,
1754 enum ofp_version ofp_version, struct ofpbuf *out)
a6fd70bb 1755{
c2d936a4
BP
1756 encode_SET_IPV4_addr(ipv4, ofp_version, OFPAT_RAW_SET_NW_SRC, MFF_IPV4_SRC,
1757 out);
1758}
a6fd70bb 1759
c2d936a4
BP
1760static void
1761encode_SET_IPV4_DST(const struct ofpact_ipv4 *ipv4,
1762 enum ofp_version ofp_version, struct ofpbuf *out)
1763{
1764 encode_SET_IPV4_addr(ipv4, ofp_version, OFPAT_RAW_SET_NW_DST, MFF_IPV4_DST,
1765 out);
1766}
a6fd70bb 1767
cab50449 1768static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1769parse_SET_IPV4_SRC(char *arg, struct ofpbuf *ofpacts,
1770 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1771{
1772 return str_to_ip(arg, &ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4);
1773}
a6fd70bb 1774
cab50449 1775static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1776parse_SET_IPV4_DST(char *arg, struct ofpbuf *ofpacts,
1777 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1778{
1779 return str_to_ip(arg, &ofpact_put_SET_IPV4_DST(ofpacts)->ipv4);
1780}
a6fd70bb 1781
c2d936a4
BP
1782static void
1783format_SET_IPV4_SRC(const struct ofpact_ipv4 *a, struct ds *s)
1784{
b1c5bf1f
QM
1785 ds_put_format(s, "%smod_nw_src:%s"IP_FMT,
1786 colors.param, colors.end, IP_ARGS(a->ipv4));
c2d936a4 1787}
097d4939 1788
c2d936a4
BP
1789static void
1790format_SET_IPV4_DST(const struct ofpact_ipv4 *a, struct ds *s)
1791{
b1c5bf1f
QM
1792 ds_put_format(s, "%smod_nw_dst:%s"IP_FMT,
1793 colors.param, colors.end, IP_ARGS(a->ipv4));
c2d936a4
BP
1794}
1795\f
1796/* Set IPv4/v6 TOS actions. */
097d4939 1797
c2d936a4 1798static enum ofperr
f3cd3ac7
JS
1799decode_OFPAT_RAW_SET_NW_TOS(uint8_t dscp,
1800 enum ofp_version ofp_version OVS_UNUSED,
1801 struct ofpbuf *out)
c2d936a4
BP
1802{
1803 if (dscp & ~IP_DSCP_MASK) {
1804 return OFPERR_OFPBAC_BAD_ARGUMENT;
1805 } else {
1806 ofpact_put_SET_IP_DSCP(out)->dscp = dscp;
1807 return 0;
a6fd70bb
JR
1808 }
1809}
1810
a6fd70bb 1811static void
c2d936a4
BP
1812encode_SET_IP_DSCP(const struct ofpact_dscp *dscp,
1813 enum ofp_version ofp_version, struct ofpbuf *out)
a6fd70bb 1814{
c2d936a4
BP
1815 if (ofp_version < OFP12_VERSION) {
1816 put_OFPAT_SET_NW_TOS(out, ofp_version, dscp->dscp);
1817 } else {
1818 ofpact_put_set_field(out, ofp_version,
1819 MFF_IP_DSCP_SHIFTED, dscp->dscp >> 2);
1820 }
1821}
a6fd70bb 1822
cab50449 1823static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1824parse_SET_IP_DSCP(char *arg, struct ofpbuf *ofpacts,
1825 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1826{
1827 uint8_t tos;
1828 char *error;
a6fd70bb 1829
c2d936a4
BP
1830 error = str_to_u8(arg, "TOS", &tos);
1831 if (error) {
1832 return error;
1833 }
a6fd70bb 1834
c2d936a4
BP
1835 if (tos & ~IP_DSCP_MASK) {
1836 return xasprintf("%s: not a valid TOS", arg);
a6fd70bb 1837 }
c2d936a4
BP
1838 ofpact_put_SET_IP_DSCP(ofpacts)->dscp = tos;
1839 return NULL;
a6fd70bb
JR
1840}
1841
b2dd70be 1842static void
c2d936a4 1843format_SET_IP_DSCP(const struct ofpact_dscp *a, struct ds *s)
b2dd70be 1844{
b1c5bf1f 1845 ds_put_format(s, "%smod_nw_tos:%s%d", colors.param, colors.end, a->dscp);
c2d936a4
BP
1846}
1847\f
1848/* Set IPv4/v6 ECN actions. */
b2dd70be 1849
c2d936a4 1850static enum ofperr
f3cd3ac7
JS
1851decode_OFPAT_RAW11_SET_NW_ECN(uint8_t ecn,
1852 enum ofp_version ofp_version OVS_UNUSED,
1853 struct ofpbuf *out)
c2d936a4
BP
1854{
1855 if (ecn & ~IP_ECN_MASK) {
1856 return OFPERR_OFPBAC_BAD_ARGUMENT;
b2dd70be 1857 } else {
c2d936a4
BP
1858 ofpact_put_SET_IP_ECN(out)->ecn = ecn;
1859 return 0;
b2dd70be
JR
1860 }
1861}
1862
c2d936a4
BP
1863static void
1864encode_SET_IP_ECN(const struct ofpact_ecn *ip_ecn,
1865 enum ofp_version ofp_version, struct ofpbuf *out)
d01c980f 1866{
c2d936a4
BP
1867 uint8_t ecn = ip_ecn->ecn;
1868 if (ofp_version == OFP10_VERSION) {
1869 /* XXX */
1870 } else if (ofp_version == OFP11_VERSION) {
1871 put_OFPAT11_SET_NW_ECN(out, ecn);
1872 } else {
1873 ofpact_put_set_field(out, ofp_version, MFF_IP_ECN, ecn);
1874 }
1875}
d01c980f 1876
cab50449 1877static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1878parse_SET_IP_ECN(char *arg, struct ofpbuf *ofpacts,
1879 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1880{
1881 uint8_t ecn;
1882 char *error;
d01c980f 1883
c2d936a4 1884 error = str_to_u8(arg, "ECN", &ecn);
d01c980f
BP
1885 if (error) {
1886 return error;
1887 }
1888
c2d936a4
BP
1889 if (ecn & ~IP_ECN_MASK) {
1890 return xasprintf("%s: not a valid ECN", arg);
1891 }
1892 ofpact_put_SET_IP_ECN(ofpacts)->ecn = ecn;
1893 return NULL;
d01c980f
BP
1894}
1895
c2d936a4
BP
1896static void
1897format_SET_IP_ECN(const struct ofpact_ecn *a, struct ds *s)
1898{
b1c5bf1f
QM
1899 ds_put_format(s, "%smod_nw_ecn:%s%d",
1900 colors.param, colors.end, a->ecn);
c2d936a4
BP
1901}
1902\f
1903/* Set IPv4/v6 TTL actions. */
1904
d01c980f 1905static enum ofperr
f3cd3ac7
JS
1906decode_OFPAT_RAW11_SET_NW_TTL(uint8_t ttl,
1907 enum ofp_version ofp_version OVS_UNUSED,
1908 struct ofpbuf *out)
d01c980f 1909{
c2d936a4
BP
1910 ofpact_put_SET_IP_TTL(out)->ttl = ttl;
1911 return 0;
1912}
1913
1914static void
1915encode_SET_IP_TTL(const struct ofpact_ip_ttl *ttl,
1916 enum ofp_version ofp_version, struct ofpbuf *out)
1917{
1918 if (ofp_version >= OFP11_VERSION) {
1919 put_OFPAT11_SET_NW_TTL(out, ttl->ttl);
1920 } else {
1921 /* XXX */
1922 }
1923}
1924
cab50449 1925static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
1926parse_SET_IP_TTL(char *arg, struct ofpbuf *ofpacts,
1927 enum ofputil_protocol *usable_protocols OVS_UNUSED)
1928{
1929 uint8_t ttl;
1930 char *error;
d01c980f 1931
c2d936a4 1932 error = str_to_u8(arg, "TTL", &ttl);
d01c980f
BP
1933 if (error) {
1934 return error;
1935 }
1936
c2d936a4
BP
1937 ofpact_put_SET_IP_TTL(ofpacts)->ttl = ttl;
1938 return NULL;
1939}
d01c980f 1940
c2d936a4
BP
1941static void
1942format_SET_IP_TTL(const struct ofpact_ip_ttl *a, struct ds *s)
1943{
b1c5bf1f 1944 ds_put_format(s, "%smod_nw_ttl:%s%d", colors.param, colors.end, a->ttl);
c2d936a4
BP
1945}
1946\f
1947/* Set TCP/UDP/SCTP port actions. */
d01c980f 1948
c2d936a4 1949static enum ofperr
f3cd3ac7
JS
1950decode_OFPAT_RAW_SET_TP_SRC(ovs_be16 port,
1951 enum ofp_version ofp_version OVS_UNUSED,
1952 struct ofpbuf *out)
c2d936a4
BP
1953{
1954 ofpact_put_SET_L4_SRC_PORT(out)->port = ntohs(port);
1955 return 0;
1956}
d01c980f 1957
c2d936a4 1958static enum ofperr
f3cd3ac7
JS
1959decode_OFPAT_RAW_SET_TP_DST(ovs_be16 port,
1960 enum ofp_version ofp_version OVS_UNUSED,
1961 struct ofpbuf *out)
c2d936a4
BP
1962{
1963 ofpact_put_SET_L4_DST_PORT(out)->port = ntohs(port);
1964 return 0;
1965}
d01c980f 1966
c2d936a4
BP
1967static void
1968encode_SET_L4_port(const struct ofpact_l4_port *l4_port,
1969 enum ofp_version ofp_version, enum ofp_raw_action_type raw,
1970 enum mf_field_id field, struct ofpbuf *out)
1971{
1972 uint16_t port = l4_port->port;
3e34fbdd 1973
c2d936a4
BP
1974 if (ofp_version >= OFP12_VERSION && field != MFF_N_IDS) {
1975 ofpact_put_set_field(out, ofp_version, field, port);
1976 } else {
1977 ofpact_put_raw(out, ofp_version, raw, port);
1978 }
1979}
8e61c110 1980
c2d936a4
BP
1981static void
1982encode_SET_L4_SRC_PORT(const struct ofpact_l4_port *l4_port,
1983 enum ofp_version ofp_version, struct ofpbuf *out)
1984{
1985 uint8_t proto = l4_port->flow_ip_proto;
1986 enum mf_field_id field = (proto == IPPROTO_TCP ? MFF_TCP_SRC
1987 : proto == IPPROTO_UDP ? MFF_UDP_SRC
1988 : proto == IPPROTO_SCTP ? MFF_SCTP_SRC
1989 : MFF_N_IDS);
276c4e7a 1990
c2d936a4
BP
1991 encode_SET_L4_port(l4_port, ofp_version, OFPAT_RAW_SET_TP_SRC, field, out);
1992}
d01c980f 1993
c2d936a4
BP
1994static void
1995encode_SET_L4_DST_PORT(const struct ofpact_l4_port *l4_port,
1996 enum ofp_version ofp_version,
1997 struct ofpbuf *out)
1998{
1999 uint8_t proto = l4_port->flow_ip_proto;
2000 enum mf_field_id field = (proto == IPPROTO_TCP ? MFF_TCP_DST
2001 : proto == IPPROTO_UDP ? MFF_UDP_DST
2002 : proto == IPPROTO_SCTP ? MFF_SCTP_DST
2003 : MFF_N_IDS);
d01c980f 2004
c2d936a4
BP
2005 encode_SET_L4_port(l4_port, ofp_version, OFPAT_RAW_SET_TP_DST, field, out);
2006}
7bcb1506 2007
cab50449 2008static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
2009parse_SET_L4_SRC_PORT(char *arg, struct ofpbuf *ofpacts,
2010 enum ofputil_protocol *usable_protocols OVS_UNUSED)
2011{
2012 return str_to_u16(arg, "source port",
2013 &ofpact_put_SET_L4_SRC_PORT(ofpacts)->port);
2014}
d01c980f 2015
cab50449 2016static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
2017parse_SET_L4_DST_PORT(char *arg, struct ofpbuf *ofpacts,
2018 enum ofputil_protocol *usable_protocols OVS_UNUSED)
2019{
2020 return str_to_u16(arg, "destination port",
2021 &ofpact_put_SET_L4_DST_PORT(ofpacts)->port);
2022}
d01c980f 2023
c2d936a4
BP
2024static void
2025format_SET_L4_SRC_PORT(const struct ofpact_l4_port *a, struct ds *s)
2026{
b1c5bf1f 2027 ds_put_format(s, "%smod_tp_src:%s%d", colors.param, colors.end, a->port);
c2d936a4 2028}
d01c980f 2029
c2d936a4
BP
2030static void
2031format_SET_L4_DST_PORT(const struct ofpact_l4_port *a, struct ds *s)
2032{
b1c5bf1f 2033 ds_put_format(s, "%smod_tp_dst:%s%d", colors.param, colors.end, a->port);
c2d936a4
BP
2034}
2035\f
73178f20
BP
2036/* Action structure for OFPAT_COPY_FIELD. */
2037struct ofp15_action_copy_field {
2038 ovs_be16 type; /* OFPAT_COPY_FIELD. */
2039 ovs_be16 len; /* Length is padded to 64 bits. */
2040 ovs_be16 n_bits; /* Number of bits to copy. */
2041 ovs_be16 src_offset; /* Starting bit offset in source. */
2042 ovs_be16 dst_offset; /* Starting bit offset in destination. */
650763d8 2043 uint8_t pad[2];
f13cdd73
BP
2044 /* Followed by:
2045 * - OXM header for source field.
2046 * - OXM header for destination field.
2047 * - Padding with 0-bytes to a multiple of 8 bytes.
650763d8
BP
2048 * The "pad2" member is the beginning of the above. */
2049 uint8_t pad2[4];
73178f20 2050};
f13cdd73 2051OFP_ASSERT(sizeof(struct ofp15_action_copy_field) == 16);
73178f20 2052
914624f8
BP
2053/* Action structure for OpenFlow 1.3 extension copy-field action.. */
2054struct onf_action_copy_field {
2055 ovs_be16 type; /* OFPAT_EXPERIMENTER. */
2056 ovs_be16 len; /* Length is padded to 64 bits. */
2057 ovs_be32 experimenter; /* ONF_VENDOR_ID. */
2058 ovs_be16 exp_type; /* 3200. */
2059 uint8_t pad[2]; /* Not used. */
2060 ovs_be16 n_bits; /* Number of bits to copy. */
2061 ovs_be16 src_offset; /* Starting bit offset in source. */
2062 ovs_be16 dst_offset; /* Starting bit offset in destination. */
2063 uint8_t pad2[2]; /* Not used. */
2064 /* Followed by:
2065 * - OXM header for source field.
2066 * - OXM header for destination field.
2067 * - Padding with 0-bytes (either 0 or 4 of them) to a multiple of 8 bytes.
2068 * The "pad3" member is the beginning of the above. */
2069 uint8_t pad3[4]; /* Not used. */
2070};
2071OFP_ASSERT(sizeof(struct onf_action_copy_field) == 24);
2072
c2d936a4
BP
2073/* Action structure for NXAST_REG_MOVE.
2074 *
2075 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
2076 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
2077 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
2078 * the next most significant bit, and so on.
2079 *
2080 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
2081 * sense to use nxm_hasmask=1 because the action does not do any kind of
2082 * matching; it uses the actual value of a field.)
2083 *
2084 * The following nxm_header values are potentially acceptable as 'src':
2085 *
2086 * - NXM_OF_IN_PORT
2087 * - NXM_OF_ETH_DST
2088 * - NXM_OF_ETH_SRC
2089 * - NXM_OF_ETH_TYPE
2090 * - NXM_OF_VLAN_TCI
2091 * - NXM_OF_IP_TOS
2092 * - NXM_OF_IP_PROTO
2093 * - NXM_OF_IP_SRC
2094 * - NXM_OF_IP_DST
2095 * - NXM_OF_TCP_SRC
2096 * - NXM_OF_TCP_DST
2097 * - NXM_OF_UDP_SRC
2098 * - NXM_OF_UDP_DST
2099 * - NXM_OF_ICMP_TYPE
2100 * - NXM_OF_ICMP_CODE
2101 * - NXM_OF_ARP_OP
2102 * - NXM_OF_ARP_SPA
2103 * - NXM_OF_ARP_TPA
2104 * - NXM_NX_TUN_ID
2105 * - NXM_NX_ARP_SHA
2106 * - NXM_NX_ARP_THA
2107 * - NXM_NX_ICMPV6_TYPE
2108 * - NXM_NX_ICMPV6_CODE
2109 * - NXM_NX_ND_SLL
2110 * - NXM_NX_ND_TLL
2111 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
2112 * - NXM_NX_PKT_MARK
2113 * - NXM_NX_TUN_IPV4_SRC
2114 * - NXM_NX_TUN_IPV4_DST
2115 *
2116 * The following nxm_header values are potentially acceptable as 'dst':
2117 *
2118 * - NXM_OF_ETH_DST
2119 * - NXM_OF_ETH_SRC
2120 * - NXM_OF_IP_TOS
2121 * - NXM_OF_IP_SRC
2122 * - NXM_OF_IP_DST
2123 * - NXM_OF_TCP_SRC
2124 * - NXM_OF_TCP_DST
2125 * - NXM_OF_UDP_SRC
2126 * - NXM_OF_UDP_DST
f6ecf944
JP
2127 * - NXM_OF_ICMP_TYPE
2128 * - NXM_OF_ICMP_CODE
2129 * - NXM_NX_ICMPV6_TYPE
2130 * - NXM_NX_ICMPV6_CODE
c2d936a4
BP
2131 * - NXM_NX_ARP_SHA
2132 * - NXM_NX_ARP_THA
2133 * - NXM_OF_ARP_OP
2134 * - NXM_OF_ARP_SPA
2135 * - NXM_OF_ARP_TPA
2136 * Modifying any of the above fields changes the corresponding packet
2137 * header.
2138 *
2139 * - NXM_OF_IN_PORT
2140 *
2141 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
2142 *
2143 * - NXM_NX_PKT_MARK
2144 *
2145 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
2146 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
2147 * header (if any), ignoring the other bits. Setting a value with CFI=1
2148 * adds or modifies the 802.1Q header appropriately, setting the TCI field
2149 * to the field's new value (with the CFI bit masked out).
2150 *
2151 * - NXM_NX_TUN_ID, NXM_NX_TUN_IPV4_SRC, NXM_NX_TUN_IPV4_DST. Modifying
2152 * any of these values modifies the corresponding tunnel header field used
2153 * for the packet's next tunnel encapsulation, if allowed by the
2154 * configuration of the output tunnel port.
2155 *
2156 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
2157 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
2158 * used only if the flow's nx_match includes an nxm_entry that specifies
2159 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
2160 *
2161 * The switch will reject actions for which src_ofs+n_bits is greater than the
2162 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
2163 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
2164 *
2165 * This action behaves properly when 'src' overlaps with 'dst', that is, it
2166 * behaves as if 'src' were copied out to a temporary buffer, then the
2167 * temporary buffer copied to 'dst'.
2168 */
2169struct nx_action_reg_move {
2170 ovs_be16 type; /* OFPAT_VENDOR. */
2171 ovs_be16 len; /* Length is 24. */
2172 ovs_be32 vendor; /* NX_VENDOR_ID. */
2173 ovs_be16 subtype; /* NXAST_REG_MOVE. */
2174 ovs_be16 n_bits; /* Number of bits. */
2175 ovs_be16 src_ofs; /* Starting bit offset in source. */
2176 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
bad8a439
BP
2177 /* Followed by:
2178 * - OXM/NXM header for source field (4 or 8 bytes).
2179 * - OXM/NXM header for destination field (4 or 8 bytes).
2180 * - Padding with 0-bytes to a multiple of 8 bytes, if necessary. */
c2d936a4 2181};
bad8a439 2182OFP_ASSERT(sizeof(struct nx_action_reg_move) == 16);
ff14eb7a 2183
73178f20 2184static enum ofperr
914624f8
BP
2185decode_copy_field__(ovs_be16 src_offset, ovs_be16 dst_offset, ovs_be16 n_bits,
2186 const void *action, ovs_be16 action_len, size_t oxm_offset,
2187 struct ofpbuf *ofpacts)
73178f20 2188{
0a2869d5 2189 struct ofpact_reg_move *move = ofpact_put_REG_MOVE(ofpacts);
914624f8
BP
2190 move->ofpact.raw = ONFACT_RAW13_COPY_FIELD;
2191 move->src.ofs = ntohs(src_offset);
2192 move->src.n_bits = ntohs(n_bits);
2193 move->dst.ofs = ntohs(dst_offset);
2194 move->dst.n_bits = ntohs(n_bits);
2195
0a2869d5 2196 struct ofpbuf b = ofpbuf_const_initializer(action, ntohs(action_len));
914624f8 2197 ofpbuf_pull(&b, oxm_offset);
0a2869d5
BP
2198
2199 enum ofperr error = nx_pull_header(&b, &move->src.field, NULL);
f13cdd73
BP
2200 if (error) {
2201 return error;
2202 }
2203 error = nx_pull_header(&b, &move->dst.field, NULL);
2204 if (error) {
2205 return error;
2206 }
f13cdd73 2207
6fd6ed71 2208 if (!is_all_zeros(b.data, b.size)) {
f13cdd73
BP
2209 return OFPERR_NXBRC_MUST_BE_ZERO;
2210 }
2211
73178f20
BP
2212 return nxm_reg_move_check(move, NULL);
2213}
2214
914624f8
BP
2215static enum ofperr
2216decode_OFPAT_RAW15_COPY_FIELD(const struct ofp15_action_copy_field *oacf,
f3cd3ac7 2217 enum ofp_version ofp_version OVS_UNUSED,
914624f8
BP
2218 struct ofpbuf *ofpacts)
2219{
2220 return decode_copy_field__(oacf->src_offset, oacf->dst_offset,
2221 oacf->n_bits, oacf, oacf->len,
2222 OBJECT_OFFSETOF(oacf, pad2), ofpacts);
2223}
2224
2225static enum ofperr
2226decode_ONFACT_RAW13_COPY_FIELD(const struct onf_action_copy_field *oacf,
f3cd3ac7 2227 enum ofp_version ofp_version OVS_UNUSED,
914624f8
BP
2228 struct ofpbuf *ofpacts)
2229{
2230 return decode_copy_field__(oacf->src_offset, oacf->dst_offset,
2231 oacf->n_bits, oacf, oacf->len,
2232 OBJECT_OFFSETOF(oacf, pad3), ofpacts);
2233}
2234
c2d936a4
BP
2235static enum ofperr
2236decode_NXAST_RAW_REG_MOVE(const struct nx_action_reg_move *narm,
f3cd3ac7 2237 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4
BP
2238 struct ofpbuf *ofpacts)
2239{
0a2869d5 2240 struct ofpact_reg_move *move = ofpact_put_REG_MOVE(ofpacts);
914624f8 2241 move->ofpact.raw = NXAST_RAW_REG_MOVE;
c2d936a4
BP
2242 move->src.ofs = ntohs(narm->src_ofs);
2243 move->src.n_bits = ntohs(narm->n_bits);
c2d936a4
BP
2244 move->dst.ofs = ntohs(narm->dst_ofs);
2245 move->dst.n_bits = ntohs(narm->n_bits);
d01c980f 2246
0a2869d5 2247 struct ofpbuf b = ofpbuf_const_initializer(narm, ntohs(narm->len));
bad8a439 2248 ofpbuf_pull(&b, sizeof *narm);
0a2869d5
BP
2249
2250 enum ofperr error = nx_pull_header(&b, &move->src.field, NULL);
bad8a439
BP
2251 if (error) {
2252 return error;
2253 }
2254 error = nx_pull_header(&b, &move->dst.field, NULL);
2255 if (error) {
2256 return error;
2257 }
6fd6ed71 2258 if (!is_all_zeros(b.data, b.size)) {
bad8a439
BP
2259 return OFPERR_NXBRC_MUST_BE_ZERO;
2260 }
2261
c2d936a4
BP
2262 return nxm_reg_move_check(move, NULL);
2263}
d01c980f 2264
c2d936a4
BP
2265static void
2266encode_REG_MOVE(const struct ofpact_reg_move *move,
73178f20
BP
2267 enum ofp_version ofp_version, struct ofpbuf *out)
2268{
914624f8
BP
2269 /* For OpenFlow 1.3, the choice of ONFACT_RAW13_COPY_FIELD versus
2270 * NXAST_RAW_REG_MOVE is somewhat difficult. Neither one is guaranteed to
2271 * be supported by every OpenFlow 1.3 implementation. It would be ideal to
2272 * probe for support. Until we have that ability, we currently prefer
2273 * NXAST_RAW_REG_MOVE for backward compatibility with older Open vSwitch
2274 * versions. */
6fd6ed71 2275 size_t start_ofs = out->size;
73178f20 2276 if (ofp_version >= OFP15_VERSION) {
bad8a439 2277 struct ofp15_action_copy_field *copy = put_OFPAT15_COPY_FIELD(out);
73178f20
BP
2278 copy->n_bits = htons(move->dst.n_bits);
2279 copy->src_offset = htons(move->src.ofs);
2280 copy->dst_offset = htons(move->dst.ofs);
6fd6ed71 2281 out->size = out->size - sizeof copy->pad2;
f13cdd73
BP
2282 nx_put_header(out, move->src.field->id, ofp_version, false);
2283 nx_put_header(out, move->dst.field->id, ofp_version, false);
914624f8
BP
2284 } else if (ofp_version == OFP13_VERSION
2285 && move->ofpact.raw == ONFACT_RAW13_COPY_FIELD) {
2286 struct onf_action_copy_field *copy = put_ONFACT13_COPY_FIELD(out);
2287 copy->n_bits = htons(move->dst.n_bits);
2288 copy->src_offset = htons(move->src.ofs);
2289 copy->dst_offset = htons(move->dst.ofs);
6fd6ed71 2290 out->size = out->size - sizeof copy->pad3;
914624f8
BP
2291 nx_put_header(out, move->src.field->id, ofp_version, false);
2292 nx_put_header(out, move->dst.field->id, ofp_version, false);
73178f20 2293 } else {
bad8a439 2294 struct nx_action_reg_move *narm = put_NXAST_REG_MOVE(out);
73178f20
BP
2295 narm->n_bits = htons(move->dst.n_bits);
2296 narm->src_ofs = htons(move->src.ofs);
2297 narm->dst_ofs = htons(move->dst.ofs);
bad8a439
BP
2298 nx_put_header(out, move->src.field->id, 0, false);
2299 nx_put_header(out, move->dst.field->id, 0, false);
73178f20 2300 }
bad8a439 2301 pad_ofpat(out, start_ofs);
c2d936a4 2302}
e9536ecb 2303
cab50449 2304static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
2305parse_REG_MOVE(const char *arg, struct ofpbuf *ofpacts,
2306 enum ofputil_protocol *usable_protocols OVS_UNUSED)
2307{
2308 struct ofpact_reg_move *move = ofpact_put_REG_MOVE(ofpacts);
2309 const char *full_arg = arg;
2310 char *error;
097d4939 2311
c2d936a4
BP
2312 error = mf_parse_subfield__(&move->src, &arg);
2313 if (error) {
2314 return error;
2315 }
2316 if (strncmp(arg, "->", 2)) {
2317 return xasprintf("%s: missing `->' following source", full_arg);
2318 }
2319 arg += 2;
2320 error = mf_parse_subfield(&move->dst, arg);
2321 if (error) {
2322 return error;
2323 }
097d4939 2324
c2d936a4
BP
2325 if (move->src.n_bits != move->dst.n_bits) {
2326 return xasprintf("%s: source field is %d bits wide but destination is "
2327 "%d bits wide", full_arg,
2328 move->src.n_bits, move->dst.n_bits);
2329 }
2330 return NULL;
2331}
0f3f3c3d 2332
c2d936a4
BP
2333static void
2334format_REG_MOVE(const struct ofpact_reg_move *a, struct ds *s)
2335{
2336 nxm_format_reg_move(a, s);
2337}
2338\f
7eb4b1f1
BP
2339/* Action structure for OFPAT12_SET_FIELD. */
2340struct ofp12_action_set_field {
2341 ovs_be16 type; /* OFPAT12_SET_FIELD. */
2342 ovs_be16 len; /* Length is padded to 64 bits. */
2343
2344 /* Followed by:
2345 * - An OXM header, value, and (in OpenFlow 1.5+) optionally a mask.
2346 * - Enough 0-bytes to pad out to a multiple of 64 bits.
2347 *
2348 * The "pad" member is the beginning of the above. */
2349 uint8_t pad[4];
2350};
2351OFP_ASSERT(sizeof(struct ofp12_action_set_field) == 8);
2352
c2d936a4
BP
2353/* Action structure for NXAST_REG_LOAD.
2354 *
2355 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
2356 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
2357 * starts at 0 for the least-significant bit, 1 for the next most significant
2358 * bit, and so on.
2359 *
2360 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
2361 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
2362 * loading them.
2363 *
2364 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
2365 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
2366 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
2367 * also stored as one less than its true value:
2368 *
2369 * 15 6 5 0
2370 * +------------------------------+------------------+
2371 * | ofs | n_bits - 1 |
2372 * +------------------------------+------------------+
2373 *
2374 * The switch will reject actions for which ofs+n_bits is greater than the
2375 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
2376 * greater are set to 1, with error type OFPET_BAD_ACTION, code
2377 * OFPBAC_BAD_ARGUMENT.
2378 */
2379struct nx_action_reg_load {
2380 ovs_be16 type; /* OFPAT_VENDOR. */
2381 ovs_be16 len; /* Length is 24. */
2382 ovs_be32 vendor; /* NX_VENDOR_ID. */
2383 ovs_be16 subtype; /* NXAST_REG_LOAD. */
2384 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
2385 ovs_be32 dst; /* Destination register. */
2386 ovs_be64 value; /* Immediate value. */
2387};
2388OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
b676167a 2389
bad8a439
BP
2390/* Action structure for NXAST_REG_LOAD2.
2391 *
2392 * Compared to OFPAT_SET_FIELD, we can use this to set whole or partial fields
2393 * in any OpenFlow version. Compared to NXAST_REG_LOAD, we can use this to set
2394 * OXM experimenter fields. */
2395struct nx_action_reg_load2 {
2396 ovs_be16 type; /* OFPAT_VENDOR. */
2397 ovs_be16 len; /* At least 16. */
2398 ovs_be32 vendor; /* NX_VENDOR_ID. */
2399 ovs_be16 subtype; /* NXAST_SET_FIELD. */
2400
2401 /* Followed by:
2402 * - An NXM/OXM header, value, and optionally a mask.
2403 * - Enough 0-bytes to pad out to a multiple of 64 bits.
2404 *
2405 * The "pad" member is the beginning of the above. */
2406 uint8_t pad[6];
2407};
2408OFP_ASSERT(sizeof(struct nx_action_reg_load2) == 16);
2409
c2d936a4 2410static enum ofperr
7eb4b1f1
BP
2411decode_ofpat_set_field(const struct ofp12_action_set_field *oasf,
2412 bool may_mask, struct ofpbuf *ofpacts)
7fdb60a7 2413{
0a2869d5 2414 struct ofpbuf b = ofpbuf_const_initializer(oasf, ntohs(oasf->len));
7eb4b1f1 2415 ofpbuf_pull(&b, OBJECT_OFFSETOF(oasf, pad));
0a2869d5
BP
2416
2417 struct ofpact_set_field *sf = ofpact_put_SET_FIELD(ofpacts);
2418 enum ofperr error = nx_pull_entry(&b, &sf->field, &sf->value,
2419 may_mask ? &sf->mask : NULL);
178742f9 2420 if (error) {
178742f9
BP
2421 return (error == OFPERR_OFPBMC_BAD_MASK
2422 ? OFPERR_OFPBAC_BAD_SET_MASK
2423 : error);
c2d936a4 2424 }
7eb4b1f1
BP
2425 if (!may_mask) {
2426 memset(&sf->mask, 0xff, sf->field->n_bytes);
2427 }
178742f9 2428
6fd6ed71 2429 if (!is_all_zeros(b.data, b.size)) {
c2d936a4
BP
2430 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2431 }
7fdb60a7 2432
178742f9
BP
2433 /* OpenFlow says specifically that one may not set OXM_OF_IN_PORT via
2434 * Set-Field. */
2435 if (sf->field->id == MFF_IN_PORT_OXM) {
2436 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
c2d936a4 2437 }
178742f9 2438
c2d936a4 2439 /* oxm_length is now validated to be compatible with mf_value. */
178742f9
BP
2440 if (!sf->field->writable) {
2441 VLOG_WARN_RL(&rl, "destination field %s is not writable",
2442 sf->field->name);
c2d936a4
BP
2443 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2444 }
c2d936a4 2445
d3cb080e 2446 /* The value must be valid for match. OpenFlow 1.5 also says,
7eb4b1f1
BP
2447 * "In an OXM_OF_VLAN_VID set-field action, the OFPVID_PRESENT bit must be
2448 * a 1-bit in oxm_value and in oxm_mask." */
178742f9
BP
2449 if (!mf_is_value_valid(sf->field, &sf->value)
2450 || (sf->field->id == MFF_VLAN_VID
31c9ed6c
BP
2451 && (!(sf->mask.be16 & htons(OFPVID12_PRESENT))
2452 || !(sf->value.be16 & htons(OFPVID12_PRESENT))))) {
c2d936a4 2453 struct ds ds = DS_EMPTY_INITIALIZER;
178742f9 2454 mf_format(sf->field, &sf->value, NULL, &ds);
c2d936a4 2455 VLOG_WARN_RL(&rl, "Invalid value for set field %s: %s",
178742f9 2456 sf->field->name, ds_cstr(&ds));
c2d936a4
BP
2457 ds_destroy(&ds);
2458
2459 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
7fdb60a7 2460 }
c2d936a4 2461 return 0;
7fdb60a7
SH
2462}
2463
7eb4b1f1
BP
2464static enum ofperr
2465decode_OFPAT_RAW12_SET_FIELD(const struct ofp12_action_set_field *oasf,
f3cd3ac7 2466 enum ofp_version ofp_version OVS_UNUSED,
7eb4b1f1
BP
2467 struct ofpbuf *ofpacts)
2468{
2469 return decode_ofpat_set_field(oasf, false, ofpacts);
2470}
2471
2472static enum ofperr
2473decode_OFPAT_RAW15_SET_FIELD(const struct ofp12_action_set_field *oasf,
f3cd3ac7 2474 enum ofp_version ofp_version OVS_UNUSED,
7eb4b1f1
BP
2475 struct ofpbuf *ofpacts)
2476{
2477 return decode_ofpat_set_field(oasf, true, ofpacts);
2478}
2479
2480static enum ofperr
2481decode_NXAST_RAW_REG_LOAD(const struct nx_action_reg_load *narl,
f3cd3ac7 2482 enum ofp_version ofp_version OVS_UNUSED,
7eb4b1f1
BP
2483 struct ofpbuf *out)
2484{
2485 struct ofpact_set_field *sf = ofpact_put_reg_load(out);
2486 struct mf_subfield dst;
2487 enum ofperr error;
2488
2489 sf->ofpact.raw = NXAST_RAW_REG_LOAD;
2490
2491 dst.field = mf_from_nxm_header(ntohl(narl->dst));
2492 dst.ofs = nxm_decode_ofs(narl->ofs_nbits);
2493 dst.n_bits = nxm_decode_n_bits(narl->ofs_nbits);
2494 error = mf_check_dst(&dst, NULL);
2495 if (error) {
2496 return error;
2497 }
2498
2499 /* Reject 'narl' if a bit numbered 'n_bits' or higher is set to 1 in
2500 * narl->value. */
2501 if (dst.n_bits < 64 && ntohll(narl->value) >> dst.n_bits) {
2502 return OFPERR_OFPBAC_BAD_ARGUMENT;
2503 }
2504
2505 sf->field = dst.field;
2506 bitwise_put(ntohll(narl->value),
2507 &sf->value, dst.field->n_bytes, dst.ofs,
2508 dst.n_bits);
2509 bitwise_put(UINT64_MAX,
2510 &sf->mask, dst.field->n_bytes, dst.ofs,
2511 dst.n_bits);
2512
2513 return 0;
2514}
2515
bad8a439
BP
2516static enum ofperr
2517decode_NXAST_RAW_REG_LOAD2(const struct nx_action_reg_load2 *narl,
f3cd3ac7 2518 enum ofp_version ofp_version OVS_UNUSED,
bad8a439
BP
2519 struct ofpbuf *out)
2520{
0a2869d5 2521 struct ofpact_set_field *sf = ofpact_put_SET_FIELD(out);
bad8a439
BP
2522 sf->ofpact.raw = NXAST_RAW_REG_LOAD2;
2523
0a2869d5 2524 struct ofpbuf b = ofpbuf_const_initializer(narl, ntohs(narl->len));
bad8a439 2525 ofpbuf_pull(&b, OBJECT_OFFSETOF(narl, pad));
0a2869d5
BP
2526
2527 enum ofperr error = nx_pull_entry(&b, &sf->field, &sf->value, &sf->mask);
bad8a439
BP
2528 if (error) {
2529 return error;
2530 }
6fd6ed71 2531 if (!is_all_zeros(b.data, b.size)) {
bad8a439
BP
2532 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2533 }
2534
2535 if (!sf->field->writable) {
2536 VLOG_WARN_RL(&rl, "destination field %s is not writable",
2537 sf->field->name);
2538 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
2539 }
2540 return 0;
2541}
2542
7fdb60a7 2543static void
c2d936a4 2544ofpact_put_set_field(struct ofpbuf *openflow, enum ofp_version ofp_version,
178742f9 2545 enum mf_field_id field, uint64_t value_)
7fdb60a7 2546{
7eb4b1f1 2547 struct ofp12_action_set_field *oasf OVS_UNUSED;
178742f9 2548 int n_bytes = mf_from_id(field)->n_bytes;
6fd6ed71 2549 size_t start_ofs = openflow->size;
178742f9 2550 union mf_value value;
7fdb60a7 2551
178742f9 2552 value.be64 = htonll(value_ << (8 * (8 - n_bytes)));
7fdb60a7 2553
7eb4b1f1 2554 oasf = put_OFPAT12_SET_FIELD(openflow);
6fd6ed71 2555 openflow->size = openflow->size - sizeof oasf->pad;
178742f9
BP
2556 nx_put_entry(openflow, field, ofp_version, &value, NULL);
2557 pad_ofpat(openflow, start_ofs);
7fdb60a7
SH
2558}
2559
7eb4b1f1
BP
2560static bool
2561next_load_segment(const struct ofpact_set_field *sf,
2562 struct mf_subfield *dst, uint64_t *value)
2563{
fa078489
BP
2564 int n_bits = sf->field->n_bits;
2565 int n_bytes = sf->field->n_bytes;
7eb4b1f1
BP
2566 int start = dst->ofs + dst->n_bits;
2567
fa078489 2568 if (start < n_bits) {
7eb4b1f1 2569 dst->field = sf->field;
fa078489
BP
2570 dst->ofs = bitwise_scan(&sf->mask, n_bytes, 1, start, n_bits);
2571 if (dst->ofs < n_bits) {
2572 dst->n_bits = bitwise_scan(&sf->mask, n_bytes, 0, dst->ofs + 1,
2573 MIN(dst->ofs + 64, n_bits)) - dst->ofs;
2574 *value = bitwise_get(&sf->value, n_bytes, dst->ofs, dst->n_bits);
7eb4b1f1
BP
2575 return true;
2576 }
2577 }
2578 return false;
2579}
178742f9 2580
7eb4b1f1 2581/* Convert 'sf' to a series of REG_LOADs. */
7fdb60a7 2582static void
c2d936a4 2583set_field_to_nxast(const struct ofpact_set_field *sf, struct ofpbuf *openflow)
7fdb60a7 2584{
bad8a439 2585 /* If 'sf' cannot be encoded as NXAST_REG_LOAD because it requires an
4fe04a7e
JG
2586 * experimenter OXM or is variable length (or if it came in as
2587 * NXAST_REG_LOAD2), encode as NXAST_REG_LOAD2. Otherwise use
2588 * NXAST_REG_LOAD, which is backward compatible. */
bad8a439 2589 if (sf->ofpact.raw == NXAST_RAW_REG_LOAD2
4fe04a7e 2590 || !mf_nxm_header(sf->field->id) || sf->field->variable_len) {
bad8a439 2591 struct nx_action_reg_load2 *narl OVS_UNUSED;
6fd6ed71 2592 size_t start_ofs = openflow->size;
bad8a439
BP
2593
2594 narl = put_NXAST_REG_LOAD2(openflow);
6fd6ed71 2595 openflow->size = openflow->size - sizeof narl->pad;
bad8a439
BP
2596 nx_put_entry(openflow, sf->field->id, 0, &sf->value, &sf->mask);
2597 pad_ofpat(openflow, start_ofs);
2598 } else {
2599 struct mf_subfield dst;
2600 uint64_t value;
7eb4b1f1 2601
bad8a439
BP
2602 dst.ofs = dst.n_bits = 0;
2603 while (next_load_segment(sf, &dst, &value)) {
2604 struct nx_action_reg_load *narl = put_NXAST_REG_LOAD(openflow);
2605 narl->ofs_nbits = nxm_encode_ofs_nbits(dst.ofs, dst.n_bits);
2606 narl->dst = htonl(mf_nxm_header(dst.field->id));
2607 narl->value = htonll(value);
2608 }
7fdb60a7
SH
2609 }
2610}
2611
7eb4b1f1
BP
2612/* Convert 'sf', which must set an entire field, to standard OpenFlow 1.0/1.1
2613 * actions, if we can, falling back to Nicira extensions if we must.
7fdb60a7 2614 *
c2d936a4
BP
2615 * We check only meta-flow types that can appear within set field actions and
2616 * that have a mapping to compatible action types. These struct mf_field
2617 * definitions have a defined OXM or NXM header value and specify the field as
2618 * writable. */
2619static void
2620set_field_to_legacy_openflow(const struct ofpact_set_field *sf,
2621 enum ofp_version ofp_version,
2622 struct ofpbuf *out)
7fdb60a7 2623{
c2d936a4
BP
2624 switch ((int) sf->field->id) {
2625 case MFF_VLAN_TCI: {
2626 ovs_be16 tci = sf->value.be16;
2627 bool cfi = (tci & htons(VLAN_CFI)) != 0;
2628 uint16_t vid = vlan_tci_to_vid(tci);
2629 uint8_t pcp = vlan_tci_to_pcp(tci);
2630
2631 if (ofp_version < OFP11_VERSION) {
2632 /* NXM_OF_VLAN_TCI to OpenFlow 1.0 mapping:
2633 *
2634 * If CFI=1, Add or modify VLAN VID & PCP.
2635 * If CFI=0, strip VLAN header, if any.
2636 */
2637 if (cfi) {
2638 put_OFPAT10_SET_VLAN_VID(out, vid);
2639 put_OFPAT10_SET_VLAN_PCP(out, pcp);
2640 } else {
2641 put_OFPAT10_STRIP_VLAN(out);
2642 }
2643 } else {
2644 /* NXM_OF_VLAN_TCI to OpenFlow 1.1 mapping:
2645 *
2646 * If CFI=1, Add or modify VLAN VID & PCP.
2647 * OpenFlow 1.1 set actions only apply if the packet
2648 * already has VLAN tags. To be sure that is the case
2649 * we have to push a VLAN header. As we do not support
2650 * multiple layers of VLANs, this is a no-op, if a VLAN
2651 * header already exists. This may backfire, however,
2652 * when we start supporting multiple layers of VLANs.
2653 * If CFI=0, strip VLAN header, if any.
2654 */
2655 if (cfi) {
2656 /* Push a VLAN tag, if one was not seen at action validation
2657 * time. */
2658 if (!sf->flow_has_vlan) {
2659 put_OFPAT11_PUSH_VLAN(out, htons(ETH_TYPE_VLAN_8021Q));
2660 }
2661 put_OFPAT11_SET_VLAN_VID(out, vid);
2662 put_OFPAT11_SET_VLAN_PCP(out, pcp);
2663 } else {
2664 /* If the flow did not match on vlan, we have no way of
2665 * knowing if the vlan tag exists, so we must POP just to be
2666 * sure. */
2667 put_OFPAT11_POP_VLAN(out);
2668 }
2669 }
2670 break;
2671 }
7fdb60a7 2672
c2d936a4
BP
2673 case MFF_VLAN_VID: {
2674 uint16_t vid = ntohs(sf->value.be16) & VLAN_VID_MASK;
2675 if (ofp_version == OFP10_VERSION) {
2676 put_OFPAT10_SET_VLAN_VID(out, vid);
2677 } else {
2678 put_OFPAT11_SET_VLAN_VID(out, vid);
2679 }
2680 break;
2681 }
2682
2683 case MFF_VLAN_PCP:
2684 if (ofp_version == OFP10_VERSION) {
2685 put_OFPAT10_SET_VLAN_PCP(out, sf->value.u8);
2686 } else {
2687 put_OFPAT11_SET_VLAN_PCP(out, sf->value.u8);
2688 }
2689 break;
2690
2691 case MFF_ETH_SRC:
74ff3298 2692 put_OFPAT_SET_DL_SRC(out, ofp_version)->dl_addr = sf->value.mac;
c2d936a4
BP
2693 break;
2694
2695 case MFF_ETH_DST:
74ff3298 2696 put_OFPAT_SET_DL_DST(out, ofp_version)->dl_addr = sf->value.mac;
c2d936a4
BP
2697 break;
2698
2699 case MFF_IPV4_SRC:
2700 put_OFPAT_SET_NW_SRC(out, ofp_version, sf->value.be32);
2701 break;
2702
2703 case MFF_IPV4_DST:
2704 put_OFPAT_SET_NW_DST(out, ofp_version, sf->value.be32);
2705 break;
2706
2707 case MFF_IP_DSCP:
2708 put_OFPAT_SET_NW_TOS(out, ofp_version, sf->value.u8);
2709 break;
2710
2711 case MFF_IP_DSCP_SHIFTED:
2712 put_OFPAT_SET_NW_TOS(out, ofp_version, sf->value.u8 << 2);
2713 break;
2714
2715 case MFF_TCP_SRC:
2716 case MFF_UDP_SRC:
2717 put_OFPAT_SET_TP_SRC(out, sf->value.be16);
2718 break;
2719
2720 case MFF_TCP_DST:
2721 case MFF_UDP_DST:
2722 put_OFPAT_SET_TP_DST(out, sf->value.be16);
2723 break;
2724
2725 default:
2726 set_field_to_nxast(sf, out);
2727 break;
7fdb60a7
SH
2728 }
2729}
2730
7eb4b1f1
BP
2731static void
2732set_field_to_set_field(const struct ofpact_set_field *sf,
2733 enum ofp_version ofp_version, struct ofpbuf *out)
2734{
2735 struct ofp12_action_set_field *oasf OVS_UNUSED;
6fd6ed71 2736 size_t start_ofs = out->size;
7eb4b1f1
BP
2737
2738 oasf = put_OFPAT12_SET_FIELD(out);
6fd6ed71 2739 out->size = out->size - sizeof oasf->pad;
7eb4b1f1
BP
2740 nx_put_entry(out, sf->field->id, ofp_version, &sf->value, &sf->mask);
2741 pad_ofpat(out, start_ofs);
2742}
2743
c2d936a4
BP
2744static void
2745encode_SET_FIELD(const struct ofpact_set_field *sf,
2746 enum ofp_version ofp_version, struct ofpbuf *out)
2747{
7eb4b1f1 2748 if (ofp_version >= OFP15_VERSION) {
bad8a439
BP
2749 /* OF1.5+ only has Set-Field (reg_load is redundant so we drop it
2750 * entirely). */
7eb4b1f1 2751 set_field_to_set_field(sf, ofp_version, out);
bad8a439
BP
2752 } else if (sf->ofpact.raw == NXAST_RAW_REG_LOAD ||
2753 sf->ofpact.raw == NXAST_RAW_REG_LOAD2) {
2754 /* It came in as reg_load, send it out the same way. */
7eb4b1f1
BP
2755 set_field_to_nxast(sf, out);
2756 } else if (ofp_version < OFP12_VERSION) {
2757 /* OpenFlow 1.0 and 1.1 don't have Set-Field. */
c2d936a4 2758 set_field_to_legacy_openflow(sf, ofp_version, out);
7eb4b1f1
BP
2759 } else if (is_all_ones((const uint8_t *) &sf->mask, sf->field->n_bytes)) {
2760 /* We're encoding to OpenFlow 1.2, 1.3, or 1.4. The action sets an
2761 * entire field, so encode it as OFPAT_SET_FIELD. */
2762 set_field_to_set_field(sf, ofp_version, out);
c2d936a4 2763 } else {
7eb4b1f1
BP
2764 /* We're encoding to OpenFlow 1.2, 1.3, or 1.4. The action cannot be
2765 * encoded as OFPAT_SET_FIELD because it does not set an entire field,
2766 * so encode it as reg_load. */
2767 set_field_to_nxast(sf, out);
c2d936a4
BP
2768 }
2769}
2770
36b43aa6
JS
2771/* Parses the input argument 'arg' into the key, value, and delimiter
2772 * components that are common across the reg_load and set_field action format.
2773 *
2774 * With an argument like "1->metadata", sets the following pointers to
2775 * point within 'arg':
2776 * key: "metadata"
2777 * value: "1"
2778 * delim: "->"
2779 *
2780 * Returns NULL if successful, otherwise a malloc()'d string describing the
2781 * error. The caller is responsible for freeing the returned string. */
2782static char * OVS_WARN_UNUSED_RESULT
2783set_field_split_str(char *arg, char **key, char **value, char **delim)
2784{
2785 char *value_end;
2786
2787 *value = arg;
2788 value_end = strstr(arg, "->");
2789 *key = value_end + strlen("->");
2790 if (delim) {
2791 *delim = value_end;
2792 }
2793
2794 if (!value_end) {
2795 return xasprintf("%s: missing `->'", arg);
2796 }
2797 if (strlen(value_end) <= strlen("->")) {
2798 return xasprintf("%s: missing field name following `->'", arg);
2799 }
2800
2801 return NULL;
2802}
2803
c2d936a4
BP
2804/* Parses a "set_field" action with argument 'arg', appending the parsed
2805 * action to 'ofpacts'.
2806 *
2807 * Returns NULL if successful, otherwise a malloc()'d string describing the
2808 * error. The caller is responsible for freeing the returned string. */
cab50449 2809static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
2810set_field_parse__(char *arg, struct ofpbuf *ofpacts,
2811 enum ofputil_protocol *usable_protocols)
7fdb60a7 2812{
c2d936a4
BP
2813 struct ofpact_set_field *sf = ofpact_put_SET_FIELD(ofpacts);
2814 char *value;
2815 char *delim;
2816 char *key;
2817 const struct mf_field *mf;
2818 char *error;
7fdb60a7 2819
36b43aa6
JS
2820 error = set_field_split_str(arg, &key, &value, &delim);
2821 if (error) {
2822 return error;
c2d936a4 2823 }
e3f8f887 2824
c2d936a4
BP
2825 mf = mf_from_name(key);
2826 if (!mf) {
2827 return xasprintf("%s is not a valid OXM field name", key);
2828 }
2829 if (!mf->writable) {
2830 return xasprintf("%s is read-only", key);
2831 }
2832 sf->field = mf;
2833 delim[0] = '\0';
7eb4b1f1 2834 error = mf_parse(mf, value, &sf->value, &sf->mask);
7fdb60a7
SH
2835 if (error) {
2836 return error;
2837 }
2838
c2d936a4
BP
2839 if (!mf_is_value_valid(mf, &sf->value)) {
2840 return xasprintf("%s is not a valid value for field %s", value, key);
7fdb60a7
SH
2841 }
2842
a4ce8b25 2843 *usable_protocols &= mf->usable_protocols_exact;
c2d936a4 2844 return NULL;
7fdb60a7
SH
2845}
2846
c2d936a4
BP
2847/* Parses 'arg' as the argument to a "set_field" action, and appends such an
2848 * action to 'ofpacts'.
2849 *
2850 * Returns NULL if successful, otherwise a malloc()'d string describing the
2851 * error. The caller is responsible for freeing the returned string. */
cab50449 2852static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
2853parse_SET_FIELD(const char *arg, struct ofpbuf *ofpacts,
2854 enum ofputil_protocol *usable_protocols)
2855{
2856 char *copy = xstrdup(arg);
2857 char *error = set_field_parse__(copy, ofpacts, usable_protocols);
2858 free(copy);
2859 return error;
2860}
a359d5ad 2861
cab50449 2862static char * OVS_WARN_UNUSED_RESULT
7eb4b1f1
BP
2863parse_reg_load(char *arg, struct ofpbuf *ofpacts)
2864{
2865 struct ofpact_set_field *sf = ofpact_put_reg_load(ofpacts);
7eb4b1f1 2866 struct mf_subfield dst;
36b43aa6 2867 char *key, *value_str;
81270993 2868 union mf_value value;
7eb4b1f1
BP
2869 char *error;
2870
36b43aa6
JS
2871 error = set_field_split_str(arg, &key, &value_str, NULL);
2872 if (error) {
2873 return error;
7eb4b1f1 2874 }
36b43aa6
JS
2875
2876 error = mf_parse_subfield(&dst, key);
7eb4b1f1
BP
2877 if (error) {
2878 return error;
2879 }
2880
81270993
JS
2881 if (parse_int_string(value_str, (uint8_t *)&value, dst.field->n_bytes,
2882 &key)) {
2883 return xasprintf("%s: cannot parse integer value", arg);
2884 }
2885
2886 if (!bitwise_is_all_zeros(&value, dst.field->n_bytes, dst.n_bits,
2887 dst.field->n_bytes * 8 - dst.n_bits)) {
2888 struct ds ds;
2889
2890 ds_init(&ds);
2891 mf_format(dst.field, &value, NULL, &ds);
2892 error = xasprintf("%s: value %s does not fit into %d bits",
2893 arg, ds_cstr(&ds), dst.n_bits);
2894 ds_destroy(&ds);
2895 return error;
7eb4b1f1
BP
2896 }
2897
2898 sf->field = dst.field;
2899 memset(&sf->value, 0, sizeof sf->value);
81270993
JS
2900 bitwise_copy(&value, dst.field->n_bytes, 0, &sf->value,
2901 dst.field->n_bytes, dst.ofs, dst.n_bits);
2902 bitwise_one(&sf->mask, dst.field->n_bytes, dst.ofs, dst.n_bits);
2903
7eb4b1f1
BP
2904 return NULL;
2905}
2906
c2d936a4
BP
2907static void
2908format_SET_FIELD(const struct ofpact_set_field *a, struct ds *s)
2909{
7eb4b1f1
BP
2910 if (a->ofpact.raw == NXAST_RAW_REG_LOAD) {
2911 struct mf_subfield dst;
2912 uint64_t value;
2913
2914 dst.ofs = dst.n_bits = 0;
2915 while (next_load_segment(a, &dst, &value)) {
b1c5bf1f
QM
2916 ds_put_format(s, "%sload:%s%#"PRIx64"%s->%s",
2917 colors.special, colors.end, value,
2918 colors.special, colors.end);
7eb4b1f1
BP
2919 mf_format_subfield(&dst, s);
2920 ds_put_char(s, ',');
2921 }
2922 ds_chomp(s, ',');
2923 } else {
b1c5bf1f 2924 ds_put_format(s, "%sset_field:%s", colors.special, colors.end);
7eb4b1f1 2925 mf_format(a->field, &a->value, &a->mask, s);
b1c5bf1f
QM
2926 ds_put_format(s, "%s->%s%s",
2927 colors.special, colors.end, a->field->name);
7eb4b1f1
BP
2928 }
2929}
2930
2931/* Appends an OFPACT_SET_FIELD ofpact to 'ofpacts' and returns it. The ofpact
2932 * is marked such that, if possible, it will be translated to OpenFlow as
2933 * NXAST_REG_LOAD extension actions rather than OFPAT_SET_FIELD, either because
2934 * that was the way that the action was expressed when it came into OVS or for
2935 * backward compatibility. */
2936struct ofpact_set_field *
2937ofpact_put_reg_load(struct ofpbuf *ofpacts)
2938{
2939 struct ofpact_set_field *sf = ofpact_put_SET_FIELD(ofpacts);
2940 sf->ofpact.raw = NXAST_RAW_REG_LOAD;
2941 return sf;
c2d936a4
BP
2942}
2943\f
2944/* Action structure for NXAST_STACK_PUSH and NXAST_STACK_POP.
2945 *
2946 * Pushes (or pops) field[offset: offset + n_bits] to (or from)
2947 * top of the stack.
2948 */
2949struct nx_action_stack {
2950 ovs_be16 type; /* OFPAT_VENDOR. */
2951 ovs_be16 len; /* Length is 16. */
2952 ovs_be32 vendor; /* NX_VENDOR_ID. */
2953 ovs_be16 subtype; /* NXAST_STACK_PUSH or NXAST_STACK_POP. */
2954 ovs_be16 offset; /* Bit offset into the field. */
bad8a439
BP
2955 /* Followed by:
2956 * - OXM/NXM header for field to push or pop (4 or 8 bytes).
2957 * - ovs_be16 'n_bits', the number of bits to extract from the field.
2958 * - Enough 0-bytes to pad out the action to 24 bytes. */
2959 uint8_t pad[12]; /* See above. */
a359d5ad 2960};
c2d936a4 2961OFP_ASSERT(sizeof(struct nx_action_stack) == 24);
a359d5ad 2962
bad8a439 2963static enum ofperr
c2d936a4
BP
2964decode_stack_action(const struct nx_action_stack *nasp,
2965 struct ofpact_stack *stack_action)
a359d5ad 2966{
c2d936a4 2967 stack_action->subfield.ofs = ntohs(nasp->offset);
bad8a439 2968
0a2869d5 2969 struct ofpbuf b = ofpbuf_const_initializer(nasp, sizeof *nasp);
bad8a439 2970 ofpbuf_pull(&b, OBJECT_OFFSETOF(nasp, pad));
0a2869d5
BP
2971 enum ofperr error = nx_pull_header(&b, &stack_action->subfield.field,
2972 NULL);
bad8a439
BP
2973 if (error) {
2974 return error;
2975 }
6fd6ed71 2976 stack_action->subfield.n_bits = ntohs(*(const ovs_be16 *) b.data);
bad8a439 2977 ofpbuf_pull(&b, 2);
6fd6ed71 2978 if (!is_all_zeros(b.data, b.size)) {
bad8a439
BP
2979 return OFPERR_NXBRC_MUST_BE_ZERO;
2980 }
2981
2982 return 0;
a359d5ad
IY
2983}
2984
c2d936a4
BP
2985static enum ofperr
2986decode_NXAST_RAW_STACK_PUSH(const struct nx_action_stack *nasp,
f3cd3ac7
JS
2987 enum ofp_version ofp_version OVS_UNUSED,
2988 struct ofpbuf *ofpacts)
a359d5ad 2989{
c2d936a4 2990 struct ofpact_stack *push = ofpact_put_STACK_PUSH(ofpacts);
bad8a439
BP
2991 enum ofperr error = decode_stack_action(nasp, push);
2992 return error ? error : nxm_stack_push_check(push, NULL);
a359d5ad
IY
2993}
2994
c2d936a4
BP
2995static enum ofperr
2996decode_NXAST_RAW_STACK_POP(const struct nx_action_stack *nasp,
f3cd3ac7 2997 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4 2998 struct ofpbuf *ofpacts)
084c53de 2999{
c2d936a4 3000 struct ofpact_stack *pop = ofpact_put_STACK_POP(ofpacts);
bad8a439
BP
3001 enum ofperr error = decode_stack_action(nasp, pop);
3002 return error ? error : nxm_stack_pop_check(pop, NULL);
084c53de
BP
3003}
3004
c2d936a4
BP
3005static void
3006encode_STACK_op(const struct ofpact_stack *stack_action,
3007 struct nx_action_stack *nasp)
c0621c39 3008{
bad8a439
BP
3009 struct ofpbuf b;
3010 ovs_be16 n_bits;
3011
c2d936a4 3012 nasp->offset = htons(stack_action->subfield.ofs);
bad8a439
BP
3013
3014 ofpbuf_use_stack(&b, nasp, ntohs(nasp->len));
3015 ofpbuf_put_uninit(&b, OBJECT_OFFSETOF(nasp, pad));
3016 nx_put_header(&b, stack_action->subfield.field->id, 0, false);
3017 n_bits = htons(stack_action->subfield.n_bits);
3018 ofpbuf_put(&b, &n_bits, sizeof n_bits);
c0621c39
AW
3019}
3020
c2d936a4
BP
3021static void
3022encode_STACK_PUSH(const struct ofpact_stack *stack,
3023 enum ofp_version ofp_version OVS_UNUSED, struct ofpbuf *out)
3024{
3025 encode_STACK_op(stack, put_NXAST_STACK_PUSH(out));
3026}
8e97815e 3027
c2d936a4
BP
3028static void
3029encode_STACK_POP(const struct ofpact_stack *stack,
3030 enum ofp_version ofp_version OVS_UNUSED, struct ofpbuf *out)
8e97815e 3031{
c2d936a4
BP
3032 encode_STACK_op(stack, put_NXAST_STACK_POP(out));
3033}
8e97815e 3034
cab50449 3035static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3036parse_STACK_PUSH(char *arg, struct ofpbuf *ofpacts,
3037 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3038{
3039 return nxm_parse_stack_action(ofpact_put_STACK_PUSH(ofpacts), arg);
3040}
8e97815e 3041
cab50449 3042static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3043parse_STACK_POP(char *arg, struct ofpbuf *ofpacts,
3044 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3045{
3046 return nxm_parse_stack_action(ofpact_put_STACK_POP(ofpacts), arg);
8e97815e
BP
3047}
3048
c2d936a4
BP
3049static void
3050format_STACK_PUSH(const struct ofpact_stack *a, struct ds *s)
8e97815e 3051{
c2d936a4
BP
3052 nxm_format_stack_push(a, s);
3053}
8e97815e 3054
c2d936a4
BP
3055static void
3056format_STACK_POP(const struct ofpact_stack *a, struct ds *s)
3057{
3058 nxm_format_stack_pop(a, s);
3059}
3060\f
3061/* Action structure for NXAST_DEC_TTL_CNT_IDS.
3062 *
3063 * If the packet is not IPv4 or IPv6, does nothing. For IPv4 or IPv6, if the
3064 * TTL or hop limit is at least 2, decrements it by 1. Otherwise, if TTL or
3065 * hop limit is 0 or 1, sends a packet-in to the controllers with each of the
3066 * 'n_controllers' controller IDs specified in 'cnt_ids'.
3067 *
3068 * (This differs from NXAST_DEC_TTL in that for NXAST_DEC_TTL the packet-in is
3069 * sent only to controllers with id 0.)
3070 */
3071struct nx_action_cnt_ids {
3072 ovs_be16 type; /* OFPAT_VENDOR. */
3073 ovs_be16 len; /* Length including slaves. */
3074 ovs_be32 vendor; /* NX_VENDOR_ID. */
3075 ovs_be16 subtype; /* NXAST_DEC_TTL_CNT_IDS. */
3076
3077 ovs_be16 n_controllers; /* Number of controllers. */
3078 uint8_t zeros[4]; /* Must be zero. */
3079
3080 /* Followed by 1 or more controller ids.
3081 *
3082 * uint16_t cnt_ids[]; // Controller ids.
3083 * uint8_t pad[]; // Must be 0 to 8-byte align cnt_ids[].
3084 */
3085};
3086OFP_ASSERT(sizeof(struct nx_action_cnt_ids) == 16);
3087
3088static enum ofperr
3089decode_OFPAT_RAW_DEC_NW_TTL(struct ofpbuf *out)
3090{
3091 uint16_t id = 0;
3092 struct ofpact_cnt_ids *ids;
3093 enum ofperr error = 0;
3094
3095 ids = ofpact_put_DEC_TTL(out);
3096 ids->n_controllers = 1;
3097 ofpbuf_put(out, &id, sizeof id);
6fd6ed71 3098 ids = out->header;
ce058104 3099 ofpact_finish_DEC_TTL(out, &ids);
c2d936a4
BP
3100 return error;
3101}
3102
3103static enum ofperr
3104decode_NXAST_RAW_DEC_TTL_CNT_IDS(const struct nx_action_cnt_ids *nac_ids,
f3cd3ac7 3105 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4
BP
3106 struct ofpbuf *out)
3107{
3108 struct ofpact_cnt_ids *ids;
3109 size_t ids_size;
3110 int i;
3111
3112 ids = ofpact_put_DEC_TTL(out);
3113 ids->ofpact.raw = NXAST_RAW_DEC_TTL_CNT_IDS;
3114 ids->n_controllers = ntohs(nac_ids->n_controllers);
3115 ids_size = ntohs(nac_ids->len) - sizeof *nac_ids;
3116
3117 if (!is_all_zeros(nac_ids->zeros, sizeof nac_ids->zeros)) {
3118 return OFPERR_NXBRC_MUST_BE_ZERO;
8e97815e 3119 }
c2d936a4
BP
3120
3121 if (ids_size < ids->n_controllers * sizeof(ovs_be16)) {
3122 VLOG_WARN_RL(&rl, "Nicira action dec_ttl_cnt_ids only has %"PRIuSIZE" "
3123 "bytes allocated for controller ids. %"PRIuSIZE" bytes "
3124 "are required for %"PRIu16" controllers.",
3125 ids_size, ids->n_controllers * sizeof(ovs_be16),
3126 ids->n_controllers);
3127 return OFPERR_OFPBAC_BAD_LEN;
3128 }
3129
3130 for (i = 0; i < ids->n_controllers; i++) {
3131 uint16_t id = ntohs(((ovs_be16 *)(nac_ids + 1))[i]);
3132 ofpbuf_put(out, &id, sizeof id);
6fd6ed71 3133 ids = out->header;
c2d936a4
BP
3134 }
3135
ce058104 3136 ofpact_finish_DEC_TTL(out, &ids);
c2d936a4
BP
3137
3138 return 0;
8e97815e
BP
3139}
3140
c2d936a4
BP
3141static void
3142encode_DEC_TTL(const struct ofpact_cnt_ids *dec_ttl,
3143 enum ofp_version ofp_version, struct ofpbuf *out)
8e97815e 3144{
c2d936a4
BP
3145 if (dec_ttl->ofpact.raw == NXAST_RAW_DEC_TTL_CNT_IDS
3146 || dec_ttl->n_controllers != 1
3147 || dec_ttl->cnt_ids[0] != 0) {
3148 struct nx_action_cnt_ids *nac_ids = put_NXAST_DEC_TTL_CNT_IDS(out);
3149 int ids_len = ROUND_UP(2 * dec_ttl->n_controllers, OFP_ACTION_ALIGN);
3150 ovs_be16 *ids;
3151 size_t i;
8e97815e 3152
c2d936a4
BP
3153 nac_ids->len = htons(ntohs(nac_ids->len) + ids_len);
3154 nac_ids->n_controllers = htons(dec_ttl->n_controllers);
3155
3156 ids = ofpbuf_put_zeros(out, ids_len);
3157 for (i = 0; i < dec_ttl->n_controllers; i++) {
3158 ids[i] = htons(dec_ttl->cnt_ids[i]);
8e97815e 3159 }
c2d936a4
BP
3160 } else {
3161 put_OFPAT_DEC_NW_TTL(out, ofp_version);
8e97815e 3162 }
8e97815e
BP
3163}
3164
c2d936a4
BP
3165static void
3166parse_noargs_dec_ttl(struct ofpbuf *ofpacts)
d01c980f 3167{
c2d936a4
BP
3168 struct ofpact_cnt_ids *ids;
3169 uint16_t id = 0;
3170
3171 ofpact_put_DEC_TTL(ofpacts);
3172 ofpbuf_put(ofpacts, &id, sizeof id);
6fd6ed71 3173 ids = ofpacts->header;
c2d936a4 3174 ids->n_controllers++;
ce058104 3175 ofpact_finish_DEC_TTL(ofpacts, &ids);
d01c980f
BP
3176}
3177
cab50449 3178static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3179parse_DEC_TTL(char *arg, struct ofpbuf *ofpacts,
3180 enum ofputil_protocol *usable_protocols OVS_UNUSED)
d01c980f 3181{
c2d936a4
BP
3182 if (*arg == '\0') {
3183 parse_noargs_dec_ttl(ofpacts);
3184 } else {
3185 struct ofpact_cnt_ids *ids;
3186 char *cntr;
3187
3188 ids = ofpact_put_DEC_TTL(ofpacts);
3189 ids->ofpact.raw = NXAST_RAW_DEC_TTL_CNT_IDS;
3190 for (cntr = strtok_r(arg, ", ", &arg); cntr != NULL;
3191 cntr = strtok_r(NULL, ", ", &arg)) {
3192 uint16_t id = atoi(cntr);
3193
3194 ofpbuf_put(ofpacts, &id, sizeof id);
6fd6ed71 3195 ids = ofpacts->header;
c2d936a4
BP
3196 ids->n_controllers++;
3197 }
3198 if (!ids->n_controllers) {
3199 return xstrdup("dec_ttl_cnt_ids: expected at least one controller "
3200 "id.");
3201 }
ce058104 3202 ofpact_finish_DEC_TTL(ofpacts, &ids);
c2d936a4
BP
3203 }
3204 return NULL;
d01c980f
BP
3205}
3206
c2d936a4
BP
3207static void
3208format_DEC_TTL(const struct ofpact_cnt_ids *a, struct ds *s)
d01c980f 3209{
c2d936a4 3210 size_t i;
d01c980f 3211
b1c5bf1f 3212 ds_put_format(s, "%sdec_ttl%s", colors.paren, colors.end);
c2d936a4 3213 if (a->ofpact.raw == NXAST_RAW_DEC_TTL_CNT_IDS) {
b1c5bf1f 3214 ds_put_format(s, "%s(%s", colors.paren, colors.end);
c2d936a4
BP
3215 for (i = 0; i < a->n_controllers; i++) {
3216 if (i) {
3217 ds_put_cstr(s, ",");
d01c980f 3218 }
c2d936a4
BP
3219 ds_put_format(s, "%"PRIu16, a->cnt_ids[i]);
3220 }
b1c5bf1f 3221 ds_put_format(s, "%s)%s", colors.paren, colors.end);
d01c980f
BP
3222 }
3223}
c2d936a4
BP
3224\f
3225/* Set MPLS label actions. */
d01c980f
BP
3226
3227static enum ofperr
f3cd3ac7
JS
3228decode_OFPAT_RAW_SET_MPLS_LABEL(ovs_be32 label,
3229 enum ofp_version ofp_version OVS_UNUSED,
3230 struct ofpbuf *out)
d01c980f 3231{
c2d936a4
BP
3232 ofpact_put_SET_MPLS_LABEL(out)->label = label;
3233 return 0;
3234}
d01c980f 3235
c2d936a4
BP
3236static void
3237encode_SET_MPLS_LABEL(const struct ofpact_mpls_label *label,
3238 enum ofp_version ofp_version,
3239 struct ofpbuf *out)
3240{
3241 if (ofp_version < OFP12_VERSION) {
3242 put_OFPAT_SET_MPLS_LABEL(out, ofp_version, label->label);
3243 } else {
3244 ofpact_put_set_field(out, ofp_version, MFF_MPLS_LABEL,
3245 ntohl(label->label));
d01c980f 3246 }
c2d936a4 3247}
d01c980f 3248
cab50449 3249static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3250parse_SET_MPLS_LABEL(char *arg, struct ofpbuf *ofpacts,
3251 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3252{
3253 struct ofpact_mpls_label *mpls_label = ofpact_put_SET_MPLS_LABEL(ofpacts);
3254 if (*arg == '\0') {
3255 return xstrdup("set_mpls_label: expected label.");
d01c980f 3256 }
c2d936a4
BP
3257
3258 mpls_label->label = htonl(atoi(arg));
3259 return NULL;
d01c980f
BP
3260}
3261
3262static void
c2d936a4 3263format_SET_MPLS_LABEL(const struct ofpact_mpls_label *a, struct ds *s)
d01c980f 3264{
b1c5bf1f
QM
3265 ds_put_format(s, "%sset_mpls_label(%s%"PRIu32"%s)%s",
3266 colors.paren, colors.end, ntohl(a->label),
3267 colors.paren, colors.end);
d01c980f 3268}
c2d936a4
BP
3269\f
3270/* Set MPLS TC actions. */
d01c980f 3271
c2d936a4 3272static enum ofperr
f3cd3ac7
JS
3273decode_OFPAT_RAW_SET_MPLS_TC(uint8_t tc,
3274 enum ofp_version ofp_version OVS_UNUSED,
3275 struct ofpbuf *out)
d01c980f 3276{
c2d936a4
BP
3277 ofpact_put_SET_MPLS_TC(out)->tc = tc;
3278 return 0;
3279}
d01c980f 3280
c2d936a4
BP
3281static void
3282encode_SET_MPLS_TC(const struct ofpact_mpls_tc *tc,
3283 enum ofp_version ofp_version, struct ofpbuf *out)
3284{
3285 if (ofp_version < OFP12_VERSION) {
3286 put_OFPAT_SET_MPLS_TC(out, ofp_version, tc->tc);
3287 } else {
3288 ofpact_put_set_field(out, ofp_version, MFF_MPLS_TC, tc->tc);
8f2cded4 3289 }
c2d936a4 3290}
8f2cded4 3291
cab50449 3292static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3293parse_SET_MPLS_TC(char *arg, struct ofpbuf *ofpacts,
3294 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3295{
3296 struct ofpact_mpls_tc *mpls_tc = ofpact_put_SET_MPLS_TC(ofpacts);
d01c980f 3297
c2d936a4
BP
3298 if (*arg == '\0') {
3299 return xstrdup("set_mpls_tc: expected tc.");
d01c980f
BP
3300 }
3301
c2d936a4
BP
3302 mpls_tc->tc = atoi(arg);
3303 return NULL;
3304}
d01c980f 3305
c2d936a4
BP
3306static void
3307format_SET_MPLS_TC(const struct ofpact_mpls_tc *a, struct ds *s)
3308{
b1c5bf1f
QM
3309 ds_put_format(s, "%sset_mpls_ttl(%s%"PRIu8"%s)%s",
3310 colors.paren, colors.end, a->tc,
3311 colors.paren, colors.end);
c2d936a4
BP
3312}
3313\f
3314/* Set MPLS TTL actions. */
d01c980f 3315
c2d936a4 3316static enum ofperr
f3cd3ac7
JS
3317decode_OFPAT_RAW_SET_MPLS_TTL(uint8_t ttl,
3318 enum ofp_version ofp_version OVS_UNUSED,
3319 struct ofpbuf *out)
c2d936a4
BP
3320{
3321 ofpact_put_SET_MPLS_TTL(out)->ttl = ttl;
3322 return 0;
3323}
638a19b0 3324
c2d936a4
BP
3325static void
3326encode_SET_MPLS_TTL(const struct ofpact_mpls_ttl *ttl,
3327 enum ofp_version ofp_version, struct ofpbuf *out)
3328{
3329 put_OFPAT_SET_MPLS_TTL(out, ofp_version, ttl->ttl);
3330}
638a19b0 3331
c2d936a4
BP
3332/* Parses 'arg' as the argument to a "set_mpls_ttl" action, and appends such an
3333 * action to 'ofpacts'.
3334 *
3335 * Returns NULL if successful, otherwise a malloc()'d string describing the
3336 * error. The caller is responsible for freeing the returned string. */
cab50449 3337static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3338parse_SET_MPLS_TTL(char *arg, struct ofpbuf *ofpacts,
3339 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3340{
3341 struct ofpact_mpls_ttl *mpls_ttl = ofpact_put_SET_MPLS_TTL(ofpacts);
d01c980f 3342
c2d936a4
BP
3343 if (*arg == '\0') {
3344 return xstrdup("set_mpls_ttl: expected ttl.");
b19e8793 3345 }
7fdb60a7 3346
c2d936a4
BP
3347 mpls_ttl->ttl = atoi(arg);
3348 return NULL;
3349}
4cceacb9 3350
c2d936a4
BP
3351static void
3352format_SET_MPLS_TTL(const struct ofpact_mpls_ttl *a, struct ds *s)
3353{
b1c5bf1f
QM
3354 ds_put_format(s, "%sset_mpls_ttl(%s%"PRIu8"%s)%s",
3355 colors.paren, colors.end, a->ttl,
3356 colors.paren, colors.end);
c2d936a4
BP
3357}
3358\f
3359/* Decrement MPLS TTL actions. */
4cceacb9 3360
c2d936a4
BP
3361static enum ofperr
3362decode_OFPAT_RAW_DEC_MPLS_TTL(struct ofpbuf *out)
3363{
3364 ofpact_put_DEC_MPLS_TTL(out);
3365 return 0;
3366}
8dd54666 3367
c2d936a4
BP
3368static void
3369encode_DEC_MPLS_TTL(const struct ofpact_null *null OVS_UNUSED,
3370 enum ofp_version ofp_version, struct ofpbuf *out)
3371{
3372 put_OFPAT_DEC_MPLS_TTL(out, ofp_version);
3373}
3374
cab50449 3375static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3376parse_DEC_MPLS_TTL(char *arg OVS_UNUSED, struct ofpbuf *ofpacts,
3377 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3378{
3379 ofpact_put_DEC_MPLS_TTL(ofpacts);
3380 return NULL;
3381}
3382
3383static void
3384format_DEC_MPLS_TTL(const struct ofpact_null *a OVS_UNUSED, struct ds *s)
3385{
b1c5bf1f 3386 ds_put_format(s, "%sdec_mpls_ttl%s", colors.value, colors.end);
c2d936a4
BP
3387}
3388\f
3389/* Push MPLS label action. */
3390
3391static enum ofperr
f3cd3ac7
JS
3392decode_OFPAT_RAW_PUSH_MPLS(ovs_be16 ethertype,
3393 enum ofp_version ofp_version OVS_UNUSED,
3394 struct ofpbuf *out)
c2d936a4
BP
3395{
3396 struct ofpact_push_mpls *oam;
3397
3398 if (!eth_type_mpls(ethertype)) {
3399 return OFPERR_OFPBAC_BAD_ARGUMENT;
8dd54666 3400 }
c2d936a4
BP
3401 oam = ofpact_put_PUSH_MPLS(out);
3402 oam->ethertype = ethertype;
d01c980f 3403
c2d936a4
BP
3404 return 0;
3405}
3406
3407static void
3408encode_PUSH_MPLS(const struct ofpact_push_mpls *push_mpls,
3409 enum ofp_version ofp_version, struct ofpbuf *out)
3410{
3411 put_OFPAT_PUSH_MPLS(out, ofp_version, push_mpls->ethertype);
3412}
3413
cab50449 3414static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3415parse_PUSH_MPLS(char *arg, struct ofpbuf *ofpacts,
3416 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3417{
3418 uint16_t ethertype;
3419 char *error;
3420
3421 error = str_to_u16(arg, "push_mpls", &ethertype);
3422 if (!error) {
3423 ofpact_put_PUSH_MPLS(ofpacts)->ethertype = htons(ethertype);
d01c980f
BP
3424 }
3425 return error;
3426}
c2d936a4
BP
3427
3428static void
3429format_PUSH_MPLS(const struct ofpact_push_mpls *a, struct ds *s)
3430{
b1c5bf1f
QM
3431 ds_put_format(s, "%spush_mpls:%s0x%04"PRIx16,
3432 colors.param, colors.end, ntohs(a->ethertype));
c2d936a4 3433}
d01c980f 3434\f
c2d936a4
BP
3435/* Pop MPLS label action. */
3436
3437static enum ofperr
f3cd3ac7
JS
3438decode_OFPAT_RAW_POP_MPLS(ovs_be16 ethertype,
3439 enum ofp_version ofp_version OVS_UNUSED,
3440 struct ofpbuf *out)
57ad4e9e 3441{
c2d936a4
BP
3442 ofpact_put_POP_MPLS(out)->ethertype = ethertype;
3443 return 0;
3444}
57ad4e9e 3445
c2d936a4
BP
3446static void
3447encode_POP_MPLS(const struct ofpact_pop_mpls *pop_mpls,
3448 enum ofp_version ofp_version, struct ofpbuf *out)
3449{
3450 put_OFPAT_POP_MPLS(out, ofp_version, pop_mpls->ethertype);
3451}
3452
cab50449 3453static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3454parse_POP_MPLS(char *arg, struct ofpbuf *ofpacts,
3455 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3456{
3457 uint16_t ethertype;
3458 char *error;
3459
3460 error = str_to_u16(arg, "pop_mpls", &ethertype);
3461 if (!error) {
3462 ofpact_put_POP_MPLS(ofpacts)->ethertype = htons(ethertype);
57ad4e9e 3463 }
c2d936a4 3464 return error;
57ad4e9e
BP
3465}
3466
ba2fe8e9 3467static void
c2d936a4 3468format_POP_MPLS(const struct ofpact_pop_mpls *a, struct ds *s)
ba2fe8e9 3469{
b1c5bf1f
QM
3470 ds_put_format(s, "%spop_mpls:%s0x%04"PRIx16,
3471 colors.param, colors.end, ntohs(a->ethertype));
ba2fe8e9 3472}
c2d936a4
BP
3473\f
3474/* Set tunnel ID actions. */
ba2fe8e9 3475
f25d0cf3 3476static enum ofperr
f3cd3ac7
JS
3477decode_NXAST_RAW_SET_TUNNEL(uint32_t tun_id,
3478 enum ofp_version ofp_version OVS_UNUSED,
3479 struct ofpbuf *out)
f25d0cf3 3480{
c2d936a4
BP
3481 struct ofpact_tunnel *tunnel = ofpact_put_SET_TUNNEL(out);
3482 tunnel->ofpact.raw = NXAST_RAW_SET_TUNNEL;
3483 tunnel->tun_id = tun_id;
3484 return 0;
3485}
f25d0cf3 3486
c2d936a4 3487static enum ofperr
f3cd3ac7
JS
3488decode_NXAST_RAW_SET_TUNNEL64(uint64_t tun_id,
3489 enum ofp_version ofp_version OVS_UNUSED,
3490 struct ofpbuf *out)
c2d936a4
BP
3491{
3492 struct ofpact_tunnel *tunnel = ofpact_put_SET_TUNNEL(out);
3493 tunnel->ofpact.raw = NXAST_RAW_SET_TUNNEL64;
3494 tunnel->tun_id = tun_id;
3495 return 0;
3496}
f25d0cf3 3497
c2d936a4
BP
3498static void
3499encode_SET_TUNNEL(const struct ofpact_tunnel *tunnel,
3500 enum ofp_version ofp_version, struct ofpbuf *out)
3501{
3502 uint64_t tun_id = tunnel->tun_id;
f25d0cf3 3503
c2d936a4
BP
3504 if (ofp_version < OFP12_VERSION) {
3505 if (tun_id <= UINT32_MAX
3506 && tunnel->ofpact.raw != NXAST_RAW_SET_TUNNEL64) {
3507 put_NXAST_SET_TUNNEL(out, tun_id);
3508 } else {
3509 put_NXAST_SET_TUNNEL64(out, tun_id);
f25d0cf3 3510 }
c2d936a4
BP
3511 } else {
3512 ofpact_put_set_field(out, ofp_version, MFF_TUN_ID, tun_id);
3513 }
3514}
f25d0cf3 3515
cab50449 3516static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3517parse_set_tunnel(char *arg, struct ofpbuf *ofpacts,
3518 enum ofp_raw_action_type raw)
3519{
3520 struct ofpact_tunnel *tunnel;
ca287d20 3521
c2d936a4
BP
3522 tunnel = ofpact_put_SET_TUNNEL(ofpacts);
3523 tunnel->ofpact.raw = raw;
3524 return str_to_u64(arg, &tunnel->tun_id);
3525}
8621547c 3526
cab50449 3527static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3528parse_SET_TUNNEL(char *arg, struct ofpbuf *ofpacts,
3529 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3530{
3531 return parse_set_tunnel(arg, ofpacts, NXAST_RAW_SET_TUNNEL);
3532}
8621547c 3533
c2d936a4
BP
3534static void
3535format_SET_TUNNEL(const struct ofpact_tunnel *a, struct ds *s)
3536{
b1c5bf1f 3537 ds_put_format(s, "%sset_tunnel%s:%s%#"PRIx64, colors.param,
c2d936a4
BP
3538 (a->tun_id > UINT32_MAX
3539 || a->ofpact.raw == NXAST_RAW_SET_TUNNEL64 ? "64" : ""),
b1c5bf1f 3540 colors.end, a->tun_id);
c2d936a4
BP
3541}
3542\f
3543/* Set queue action. */
8621547c 3544
c2d936a4 3545static enum ofperr
f3cd3ac7
JS
3546decode_OFPAT_RAW_SET_QUEUE(uint32_t queue_id,
3547 enum ofp_version ofp_version OVS_UNUSED,
3548 struct ofpbuf *out)
c2d936a4
BP
3549{
3550 ofpact_put_SET_QUEUE(out)->queue_id = queue_id;
3551 return 0;
3552}
8621547c 3553
c2d936a4
BP
3554static void
3555encode_SET_QUEUE(const struct ofpact_queue *queue,
3556 enum ofp_version ofp_version, struct ofpbuf *out)
3557{
3558 put_OFPAT_SET_QUEUE(out, ofp_version, queue->queue_id);
3559}
8621547c 3560
cab50449 3561static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3562parse_SET_QUEUE(char *arg, struct ofpbuf *ofpacts,
3563 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3564{
3565 return str_to_u32(arg, &ofpact_put_SET_QUEUE(ofpacts)->queue_id);
3566}
8621547c 3567
c2d936a4
BP
3568static void
3569format_SET_QUEUE(const struct ofpact_queue *a, struct ds *s)
3570{
b1c5bf1f
QM
3571 ds_put_format(s, "%sset_queue:%s%"PRIu32,
3572 colors.param, colors.end, a->queue_id);
c2d936a4
BP
3573}
3574\f
3575/* Pop queue action. */
1e7db674 3576
c2d936a4
BP
3577static enum ofperr
3578decode_NXAST_RAW_POP_QUEUE(struct ofpbuf *out)
3579{
3580 ofpact_put_POP_QUEUE(out);
3581 return 0;
3582}
f25d0cf3 3583
c2d936a4
BP
3584static void
3585encode_POP_QUEUE(const struct ofpact_null *null OVS_UNUSED,
3586 enum ofp_version ofp_version OVS_UNUSED, struct ofpbuf *out)
3587{
3588 put_NXAST_POP_QUEUE(out);
3589}
f25d0cf3 3590
cab50449 3591static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3592parse_POP_QUEUE(const char *arg OVS_UNUSED, struct ofpbuf *ofpacts,
3593 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3594{
3595 ofpact_put_POP_QUEUE(ofpacts);
3596 return NULL;
3597}
f25d0cf3 3598
c2d936a4
BP
3599static void
3600format_POP_QUEUE(const struct ofpact_null *a OVS_UNUSED, struct ds *s)
3601{
b1c5bf1f 3602 ds_put_format(s, "%spop_queue%s", colors.value, colors.end);
c2d936a4
BP
3603}
3604\f
3605/* Action structure for NXAST_FIN_TIMEOUT.
3606 *
3607 * This action changes the idle timeout or hard timeout, or both, of this
3608 * OpenFlow rule when the rule matches a TCP packet with the FIN or RST flag.
3609 * When such a packet is observed, the action reduces the rule's idle timeout
3610 * to 'fin_idle_timeout' and its hard timeout to 'fin_hard_timeout'. This
3611 * action has no effect on an existing timeout that is already shorter than the
3612 * one that the action specifies. A 'fin_idle_timeout' or 'fin_hard_timeout'
3613 * of zero has no effect on the respective timeout.
3614 *
3615 * 'fin_idle_timeout' and 'fin_hard_timeout' are measured in seconds.
3616 * 'fin_hard_timeout' specifies time since the flow's creation, not since the
3617 * receipt of the FIN or RST.
3618 *
3619 * This is useful for quickly discarding learned TCP flows that otherwise will
3620 * take a long time to expire.
3621 *
3622 * This action is intended for use with an OpenFlow rule that matches only a
3623 * single TCP flow. If the rule matches multiple TCP flows (e.g. it wildcards
3624 * all TCP traffic, or all TCP traffic to a particular port), then any FIN or
3625 * RST in any of those flows will cause the entire OpenFlow rule to expire
3626 * early, which is not normally desirable.
3627 */
3628struct nx_action_fin_timeout {
3629 ovs_be16 type; /* OFPAT_VENDOR. */
3630 ovs_be16 len; /* 16. */
3631 ovs_be32 vendor; /* NX_VENDOR_ID. */
3632 ovs_be16 subtype; /* NXAST_FIN_TIMEOUT. */
3633 ovs_be16 fin_idle_timeout; /* New idle timeout, if nonzero. */
3634 ovs_be16 fin_hard_timeout; /* New hard timeout, if nonzero. */
3635 ovs_be16 pad; /* Must be zero. */
3636};
3637OFP_ASSERT(sizeof(struct nx_action_fin_timeout) == 16);
f25d0cf3 3638
c2d936a4
BP
3639static enum ofperr
3640decode_NXAST_RAW_FIN_TIMEOUT(const struct nx_action_fin_timeout *naft,
f3cd3ac7 3641 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4
BP
3642 struct ofpbuf *out)
3643{
3644 struct ofpact_fin_timeout *oft;
8621547c 3645
c2d936a4
BP
3646 oft = ofpact_put_FIN_TIMEOUT(out);
3647 oft->fin_idle_timeout = ntohs(naft->fin_idle_timeout);
3648 oft->fin_hard_timeout = ntohs(naft->fin_hard_timeout);
3649 return 0;
3650}
f25d0cf3 3651
c2d936a4
BP
3652static void
3653encode_FIN_TIMEOUT(const struct ofpact_fin_timeout *fin_timeout,
3654 enum ofp_version ofp_version OVS_UNUSED,
3655 struct ofpbuf *out)
3656{
3657 struct nx_action_fin_timeout *naft = put_NXAST_FIN_TIMEOUT(out);
3658 naft->fin_idle_timeout = htons(fin_timeout->fin_idle_timeout);
3659 naft->fin_hard_timeout = htons(fin_timeout->fin_hard_timeout);
3660}
f25d0cf3 3661
cab50449 3662static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3663parse_FIN_TIMEOUT(char *arg, struct ofpbuf *ofpacts,
3664 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3665{
3666 struct ofpact_fin_timeout *oft = ofpact_put_FIN_TIMEOUT(ofpacts);
3667 char *key, *value;
f25d0cf3 3668
c2d936a4
BP
3669 while (ofputil_parse_key_value(&arg, &key, &value)) {
3670 char *error;
b02475c5 3671
c2d936a4
BP
3672 if (!strcmp(key, "idle_timeout")) {
3673 error = str_to_u16(value, key, &oft->fin_idle_timeout);
3674 } else if (!strcmp(key, "hard_timeout")) {
3675 error = str_to_u16(value, key, &oft->fin_hard_timeout);
3676 } else {
3677 error = xasprintf("invalid key '%s' in 'fin_timeout' argument",
3678 key);
8621547c 3679 }
8dd54666 3680
c2d936a4
BP
3681 if (error) {
3682 return error;
9cae45dc 3683 }
9cae45dc 3684 }
c2d936a4
BP
3685 return NULL;
3686}
e3b56933 3687
c2d936a4
BP
3688static void
3689format_FIN_TIMEOUT(const struct ofpact_fin_timeout *a, struct ds *s)
3690{
b1c5bf1f 3691 ds_put_format(s, "%sfin_timeout(%s", colors.paren, colors.end);
c2d936a4 3692 if (a->fin_idle_timeout) {
b1c5bf1f
QM
3693 ds_put_format(s, "%sidle_timeout=%s%"PRIu16",",
3694 colors.param, colors.end, a->fin_idle_timeout);
7e9f8266 3695 }
c2d936a4 3696 if (a->fin_hard_timeout) {
b1c5bf1f
QM
3697 ds_put_format(s, "%shard_timeout=%s%"PRIu16",",
3698 colors.param, colors.end, a->fin_hard_timeout);
f25d0cf3 3699 }
c2d936a4 3700 ds_chomp(s, ',');
b1c5bf1f 3701 ds_put_format(s, "%s)%s", colors.paren, colors.end);
f25d0cf3 3702}
c2d936a4
BP
3703\f
3704/* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
eca39bce 3705 *
c2d936a4 3706 * These actions search one of the switch's flow tables:
ba2fe8e9 3707 *
c2d936a4
BP
3708 * - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
3709 * it specifies the table to search.
ca287d20 3710 *
c2d936a4
BP
3711 * - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
3712 * NXAST_RESUBMIT regardless of 'table'), it searches the current flow
3713 * table, that is, the OpenFlow flow table that contains the flow from
3714 * which this action was obtained. If this action did not come from a
3715 * flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
3716 * is the current table.
3717 *
3718 * The flow table lookup uses a flow that may be slightly modified from the
3719 * original lookup:
3720 *
3721 * - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
3722 * is used as the flow's in_port.
3723 *
3724 * - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
3725 * then its value is used as the flow's in_port. Otherwise, the original
3726 * in_port is used.
3727 *
3728 * - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
3729 * resubmit action, then the flow is updated with the new values.
3730 *
3731 * Following the lookup, the original in_port is restored.
3732 *
3733 * If the modified flow matched in the flow table, then the corresponding
3734 * actions are executed. Afterward, actions following the resubmit in the
3735 * original set of actions, if any, are executed; any changes made to the
3736 * packet (e.g. changes to VLAN) by secondary actions persist when those
3737 * actions are executed, although the original in_port is restored.
3738 *
3739 * Resubmit actions may be used any number of times within a set of actions.
3740 *
3741 * Resubmit actions may nest to an implementation-defined depth. Beyond this
3742 * implementation-defined depth, further resubmit actions are simply ignored.
3743 *
3744 * NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
3745 * 'pad' to be all-bits-zero.
3746 *
3747 * Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
3748 * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
3749 */
3750struct nx_action_resubmit {
3751 ovs_be16 type; /* OFPAT_VENDOR. */
3752 ovs_be16 len; /* Length is 16. */
3753 ovs_be32 vendor; /* NX_VENDOR_ID. */
3754 ovs_be16 subtype; /* NXAST_RESUBMIT. */
3755 ovs_be16 in_port; /* New in_port for checking flow table. */
3756 uint8_t table; /* NXAST_RESUBMIT_TABLE: table to use. */
3757 uint8_t pad[3];
3758};
3759OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
3760
3761static enum ofperr
f3cd3ac7
JS
3762decode_NXAST_RAW_RESUBMIT(uint16_t port,
3763 enum ofp_version ofp_version OVS_UNUSED,
3764 struct ofpbuf *out)
f25d0cf3 3765{
c2d936a4 3766 struct ofpact_resubmit *resubmit;
f25d0cf3 3767
c2d936a4
BP
3768 resubmit = ofpact_put_RESUBMIT(out);
3769 resubmit->ofpact.raw = NXAST_RAW_RESUBMIT;
3770 resubmit->in_port = u16_to_ofp(port);
3771 resubmit->table_id = 0xff;
3772 return 0;
f25d0cf3 3773}
4cceacb9 3774
c2d936a4
BP
3775static enum ofperr
3776decode_NXAST_RAW_RESUBMIT_TABLE(const struct nx_action_resubmit *nar,
f3cd3ac7 3777 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4 3778 struct ofpbuf *out)
ba2fe8e9 3779{
c2d936a4 3780 struct ofpact_resubmit *resubmit;
ba2fe8e9 3781
c2d936a4
BP
3782 if (nar->pad[0] || nar->pad[1] || nar->pad[2]) {
3783 return OFPERR_OFPBAC_BAD_ARGUMENT;
3784 }
3785
3786 resubmit = ofpact_put_RESUBMIT(out);
3787 resubmit->ofpact.raw = NXAST_RAW_RESUBMIT_TABLE;
3788 resubmit->in_port = u16_to_ofp(ntohs(nar->in_port));
3789 resubmit->table_id = nar->table;
3790 return 0;
ba2fe8e9
BP
3791}
3792
c2d936a4
BP
3793static void
3794encode_RESUBMIT(const struct ofpact_resubmit *resubmit,
3795 enum ofp_version ofp_version OVS_UNUSED, struct ofpbuf *out)
4cceacb9 3796{
c2d936a4 3797 uint16_t in_port = ofp_to_u16(resubmit->in_port);
4cceacb9 3798
c2d936a4
BP
3799 if (resubmit->table_id == 0xff
3800 && resubmit->ofpact.raw != NXAST_RAW_RESUBMIT_TABLE) {
3801 put_NXAST_RESUBMIT(out, in_port);
3802 } else {
3803 struct nx_action_resubmit *nar = put_NXAST_RESUBMIT_TABLE(out);
3804 nar->table = resubmit->table_id;
3805 nar->in_port = htons(in_port);
3806 }
3807}
6813ee7c 3808
cab50449 3809static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
3810parse_RESUBMIT(char *arg, struct ofpbuf *ofpacts,
3811 enum ofputil_protocol *usable_protocols OVS_UNUSED)
3812{
3813 struct ofpact_resubmit *resubmit;
3814 char *in_port_s, *table_s;
6813ee7c 3815
c2d936a4 3816 resubmit = ofpact_put_RESUBMIT(ofpacts);
8f2cded4 3817
c2d936a4
BP
3818 in_port_s = strsep(&arg, ",");
3819 if (in_port_s && in_port_s[0]) {
3820 if (!ofputil_port_from_string(in_port_s, &resubmit->in_port)) {
3821 return xasprintf("%s: resubmit to unknown port", in_port_s);
8f2cded4 3822 }
c2d936a4
BP
3823 } else {
3824 resubmit->in_port = OFPP_IN_PORT;
3825 }
4cceacb9 3826
c2d936a4
BP
3827 table_s = strsep(&arg, ",");
3828 if (table_s && table_s[0]) {
3829 uint32_t table_id = 0;
3830 char *error;
3831
3832 error = str_to_u32(table_s, &table_id);
3833 if (error) {
3834 return error;
3835 }
3836 resubmit->table_id = table_id;
3837 } else {
3838 resubmit->table_id = 255;
4cceacb9
JS
3839 }
3840
c2d936a4
BP
3841 if (resubmit->in_port == OFPP_IN_PORT && resubmit->table_id == 255) {
3842 return xstrdup("at least one \"in_port\" or \"table\" must be "
3843 "specified on resubmit");
3844 }
3845 return NULL;
3846}
3847
3848static void
3849format_RESUBMIT(const struct ofpact_resubmit *a, struct ds *s)
3850{
3851 if (a->in_port != OFPP_IN_PORT && a->table_id == 255) {
b1c5bf1f 3852 ds_put_format(s, "%sresubmit:%s", colors.special, colors.end);
c2d936a4
BP
3853 ofputil_format_port(a->in_port, s);
3854 } else {
b1c5bf1f 3855 ds_put_format(s, "%sresubmit(%s", colors.paren, colors.end);
c2d936a4
BP
3856 if (a->in_port != OFPP_IN_PORT) {
3857 ofputil_format_port(a->in_port, s);
3858 }
3859 ds_put_char(s, ',');
3860 if (a->table_id != 255) {
3861 ds_put_format(s, "%"PRIu8, a->table_id);
3862 }
b1c5bf1f 3863 ds_put_format(s, "%s)%s", colors.paren, colors.end);
c2d936a4
BP
3864 }
3865}
3866\f
3867/* Action structure for NXAST_LEARN.
3868 *
3869 * This action adds or modifies a flow in an OpenFlow table, similar to
3870 * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'. The new flow has the
3871 * specified idle timeout, hard timeout, priority, cookie, and flags. The new
3872 * flow's match criteria and actions are built by applying each of the series
3873 * of flow_mod_spec elements included as part of the action.
3874 *
3875 * A flow_mod_spec starts with a 16-bit header. A header that is all-bits-0 is
3876 * a no-op used for padding the action as a whole to a multiple of 8 bytes in
3877 * length. Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
3878 * bits from a source to a destination. In this case, the header contains
3879 * multiple fields:
3880 *
3881 * 15 14 13 12 11 10 0
3882 * +------+---+------+---------------------------------+
3883 * | 0 |src| dst | n_bits |
3884 * +------+---+------+---------------------------------+
3885 *
3886 * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'. The
3887 * following table summarizes the meaning of each possible combination.
3888 * Details follow the table:
3889 *
3890 * src dst meaning
3891 * --- --- ----------------------------------------------------------
3892 * 0 0 Add match criteria based on value in a field.
3893 * 1 0 Add match criteria based on an immediate value.
3894 * 0 1 Add NXAST_REG_LOAD action to copy field into a different field.
3895 * 1 1 Add NXAST_REG_LOAD action to load immediate value into a field.
3896 * 0 2 Add OFPAT_OUTPUT action to output to port from specified field.
3897 * All other combinations are undefined and not allowed.
3898 *
3899 * The flow_mod_spec header is followed by a source specification and a
3900 * destination specification. The format and meaning of the source
3901 * specification depends on 'src':
3902 *
3903 * - If 'src' is 0, the source bits are taken from a field in the flow to
3904 * which this action is attached. (This should be a wildcarded field. If
3905 * its value is fully specified then the source bits being copied have
3906 * constant values.)
3907 *
3908 * The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
3909 * 'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
3910 * offset within that field. The source bits are field[ofs:ofs+n_bits-1].
3911 * 'field' and 'ofs' are subject to the same restrictions as the source
3912 * field in NXAST_REG_MOVE.
3913 *
3914 * - If 'src' is 1, the source bits are a constant value. The source
3915 * specification is (n_bits+15)/16*2 bytes long. Taking those bytes as a
3916 * number in network order, the source bits are the 'n_bits'
3917 * least-significant bits. The switch will report an error if other bits
3918 * in the constant are nonzero.
3919 *
3920 * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
3921 * ovs_be32 'field' and an ovs_be16 'ofs'. 'field' is an nxm_header with
3922 * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field. The
3923 * meaning of the flow_mod_spec depends on 'dst':
3924 *
3925 * - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
3926 * flow. The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
3927 * packet equal the source bits. 'field' may be any nxm_header with
3928 * nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
3929 *
3930 * Order is significant. Earlier flow_mod_specs must satisfy any
3931 * prerequisites for matching fields specified later, by copying constant
3932 * values into prerequisite fields.
3933 *
3934 * The switch will reject flow_mod_specs that do not satisfy NXM masking
3935 * restrictions.
3936 *
3937 * - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
3938 * the new flow. The new flow copies the source bits into
3939 * field[ofs:ofs+n_bits-1]. Actions are executed in the same order as the
3940 * flow_mod_specs.
3941 *
3942 * A single NXAST_REG_LOAD action writes no more than 64 bits, so n_bits
3943 * greater than 64 yields multiple NXAST_REG_LOAD actions.
3944 *
3945 * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
3946 * empty. It has the following meaning:
3947 *
3948 * - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
3949 * The new flow outputs to the OpenFlow port specified by the source field.
3950 * Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
3951 * OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported. Other special ports
3952 * may not be used.
3953 *
3954 * Resource Management
3955 * -------------------
3956 *
3957 * A switch has a finite amount of flow table space available for learning.
3958 * When this space is exhausted, no new learning table entries will be learned
3959 * until some existing flow table entries expire. The controller should be
3960 * prepared to handle this by flooding (which can be implemented as a
3961 * low-priority flow).
3962 *
3963 * If a learned flow matches a single TCP stream with a relatively long
3964 * timeout, one may make the best of resource constraints by setting
3965 * 'fin_idle_timeout' or 'fin_hard_timeout' (both measured in seconds), or
3966 * both, to shorter timeouts. When either of these is specified as a nonzero
3967 * value, OVS adds a NXAST_FIN_TIMEOUT action, with the specified timeouts, to
3968 * the learned flow.
3969 *
3970 * Examples
3971 * --------
3972 *
3973 * The following examples give a prose description of the flow_mod_specs along
3974 * with informal notation for how those would be represented and a hex dump of
3975 * the bytes that would be required.
3976 *
3977 * These examples could work with various nx_action_learn parameters. Typical
3978 * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
3979 * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
3980 *
3981 * 1. Learn input port based on the source MAC, with lookup into
3982 * NXM_NX_REG1[16:31] by resubmit to in_port=99:
3983 *
3984 * Match on in_port=99:
3985 * ovs_be16(src=1, dst=0, n_bits=16), 20 10
3986 * ovs_be16(99), 00 63
3987 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
3988 *
3989 * Match Ethernet destination on Ethernet source from packet:
3990 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
3991 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
3992 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
3993 *
3994 * Set NXM_NX_REG1[16:31] to the packet's input port:
3995 * ovs_be16(src=0, dst=1, n_bits=16), 08 10
3996 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
3997 * ovs_be32(NXM_NX_REG1), ovs_be16(16) 00 01 02 04 00 10
3998 *
3999 * Given a packet that arrived on port A with Ethernet source address B,
4000 * this would set up the flow "in_port=99, dl_dst=B,
4001 * actions=load:A->NXM_NX_REG1[16..31]".
4002 *
4003 * In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
4004 * NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
4005 * load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
4006 *
4007 * 2. Output to input port based on the source MAC and VLAN VID, with lookup
4008 * into NXM_NX_REG1[16:31]:
4009 *
4010 * Match on same VLAN ID as packet:
4011 * ovs_be16(src=0, dst=0, n_bits=12), 00 0c
4012 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
4013 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
4014 *
4015 * Match Ethernet destination on Ethernet source from packet:
4016 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
4017 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
4018 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
4019 *
4020 * Output to the packet's input port:
4021 * ovs_be16(src=0, dst=2, n_bits=16), 10 10
4022 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
4023 *
4024 * Given a packet that arrived on port A with Ethernet source address B in
4025 * VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
4026 * actions=output:A".
4027 *
4028 * In syntax accepted by ovs-ofctl, this action is:
4029 * learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
4030 * output:NXM_OF_IN_PORT[])
4031 *
4032 * 3. Here's a recipe for a very simple-minded MAC learning switch. It uses a
4033 * 10-second MAC expiration time to make it easier to see what's going on
4034 *
4035 * ovs-vsctl del-controller br0
4036 * ovs-ofctl del-flows br0
4037 * ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
4038 hard_timeout=10, NXM_OF_VLAN_TCI[0..11], \
4039 NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[], \
4040 output:NXM_OF_IN_PORT[]), resubmit(,1)"
4041 * ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
4042 *
4043 * You can then dump the MAC learning table with:
4044 *
4045 * ovs-ofctl dump-flows br0 table=1
4046 *
4047 * Usage Advice
4048 * ------------
4049 *
4050 * For best performance, segregate learned flows into a table that is not used
4051 * for any other flows except possibly for a lowest-priority "catch-all" flow
4052 * (a flow with no match criteria). If different learning actions specify
4053 * different match criteria, use different tables for the learned flows.
4054 *
4055 * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
4056 * These timeouts apply to the flow that is added, which means that a flow with
4057 * an idle timeout will expire when no traffic has been sent *to* the learned
4058 * address. This is not usually the intent in MAC learning; instead, we want
4059 * the MAC learn entry to expire when no traffic has been sent *from* the
4060 * learned address. Use a hard timeout for that.
39c94593
JR
4061 *
4062 *
4063 * Visibility of Changes
4064 * ---------------------
4065 *
4066 * Prior to Open vSwitch 2.4, any changes made by a "learn" action in a given
4067 * flow translation are visible to flow table lookups made later in the flow
4068 * translation. This means that, in the example above, a MAC learned by the
4069 * learn action in table 0 would be found in table 1 (if the packet being
4070 * processed had the same source and destination MAC address).
4071 *
4072 * In Open vSwitch 2.4 and later, changes to a flow table (whether to add or
4073 * modify a flow) by a "learn" action are visible only for later flow
4074 * translations, not for later lookups within the same flow translation. In
4075 * the MAC learning example, a MAC learned by the learn action in table 0 would
4076 * not be found in table 1 if the flow translation would resubmit to table 1
4077 * after the processing of the learn action, meaning that if this MAC had not
4078 * been learned before then the packet would be flooded. */
c2d936a4
BP
4079struct nx_action_learn {
4080 ovs_be16 type; /* OFPAT_VENDOR. */
4081 ovs_be16 len; /* At least 24. */
4082 ovs_be32 vendor; /* NX_VENDOR_ID. */
4083 ovs_be16 subtype; /* NXAST_LEARN. */
4084 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
4085 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
4086 ovs_be16 priority; /* Priority level of flow entry. */
4087 ovs_be64 cookie; /* Cookie for new flow. */
4088 ovs_be16 flags; /* NX_LEARN_F_*. */
4089 uint8_t table_id; /* Table to insert flow entry. */
4090 uint8_t pad; /* Must be zero. */
4091 ovs_be16 fin_idle_timeout; /* Idle timeout after FIN, if nonzero. */
4092 ovs_be16 fin_hard_timeout; /* Hard timeout after FIN, if nonzero. */
4093 /* Followed by a sequence of flow_mod_spec elements, as described above,
4094 * until the end of the action is reached. */
4095};
4096OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
4097
4098static ovs_be16
4099get_be16(const void **pp)
4100{
4101 const ovs_be16 *p = *pp;
4102 ovs_be16 value = *p;
4103 *pp = p + 1;
4104 return value;
4105}
4106
4107static ovs_be32
4108get_be32(const void **pp)
4109{
4110 const ovs_be32 *p = *pp;
4111 ovs_be32 value = get_unaligned_be32(p);
4112 *pp = p + 1;
4113 return value;
4114}
4115
4116static void
4117get_subfield(int n_bits, const void **p, struct mf_subfield *sf)
4118{
4119 sf->field = mf_from_nxm_header(ntohl(get_be32(p)));
4120 sf->ofs = ntohs(get_be16(p));
4121 sf->n_bits = n_bits;
4122}
4123
4124static unsigned int
4125learn_min_len(uint16_t header)
4126{
4127 int n_bits = header & NX_LEARN_N_BITS_MASK;
4128 int src_type = header & NX_LEARN_SRC_MASK;
4129 int dst_type = header & NX_LEARN_DST_MASK;
4130 unsigned int min_len;
4131
4132 min_len = 0;
4133 if (src_type == NX_LEARN_SRC_FIELD) {
4134 min_len += sizeof(ovs_be32); /* src_field */
4135 min_len += sizeof(ovs_be16); /* src_ofs */
4136 } else {
4137 min_len += DIV_ROUND_UP(n_bits, 16);
4138 }
4139 if (dst_type == NX_LEARN_DST_MATCH ||
4140 dst_type == NX_LEARN_DST_LOAD) {
4141 min_len += sizeof(ovs_be32); /* dst_field */
4142 min_len += sizeof(ovs_be16); /* dst_ofs */
4143 }
4144 return min_len;
4145}
4146
4147/* Converts 'nal' into a "struct ofpact_learn" and appends that struct to
4148 * 'ofpacts'. Returns 0 if successful, otherwise an OFPERR_*. */
4149static enum ofperr
4150decode_NXAST_RAW_LEARN(const struct nx_action_learn *nal,
f3cd3ac7 4151 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4
BP
4152 struct ofpbuf *ofpacts)
4153{
4154 struct ofpact_learn *learn;
4155 const void *p, *end;
4156
4157 if (nal->pad) {
4158 return OFPERR_OFPBAC_BAD_ARGUMENT;
4159 }
4160
4161 learn = ofpact_put_LEARN(ofpacts);
4162
4163 learn->idle_timeout = ntohs(nal->idle_timeout);
4164 learn->hard_timeout = ntohs(nal->hard_timeout);
4165 learn->priority = ntohs(nal->priority);
4166 learn->cookie = nal->cookie;
4167 learn->table_id = nal->table_id;
4168 learn->fin_idle_timeout = ntohs(nal->fin_idle_timeout);
4169 learn->fin_hard_timeout = ntohs(nal->fin_hard_timeout);
4170
4171 learn->flags = ntohs(nal->flags);
4172 if (learn->flags & ~(NX_LEARN_F_SEND_FLOW_REM |
4173 NX_LEARN_F_DELETE_LEARNED)) {
4174 return OFPERR_OFPBAC_BAD_ARGUMENT;
4175 }
4176
4177 if (learn->table_id == 0xff) {
4178 return OFPERR_OFPBAC_BAD_ARGUMENT;
4179 }
4180
4181 end = (char *) nal + ntohs(nal->len);
4182 for (p = nal + 1; p != end; ) {
4183 struct ofpact_learn_spec *spec;
4184 uint16_t header = ntohs(get_be16(&p));
4185
4186 if (!header) {
4187 break;
4188 }
4189
4190 spec = ofpbuf_put_zeros(ofpacts, sizeof *spec);
6fd6ed71 4191 learn = ofpacts->header;
c2d936a4
BP
4192 learn->n_specs++;
4193
4194 spec->src_type = header & NX_LEARN_SRC_MASK;
4195 spec->dst_type = header & NX_LEARN_DST_MASK;
4196 spec->n_bits = header & NX_LEARN_N_BITS_MASK;
4197
4198 /* Check for valid src and dst type combination. */
4199 if (spec->dst_type == NX_LEARN_DST_MATCH ||
4200 spec->dst_type == NX_LEARN_DST_LOAD ||
4201 (spec->dst_type == NX_LEARN_DST_OUTPUT &&
4202 spec->src_type == NX_LEARN_SRC_FIELD)) {
4203 /* OK. */
4204 } else {
4205 return OFPERR_OFPBAC_BAD_ARGUMENT;
4206 }
4207
4208 /* Check that the arguments don't overrun the end of the action. */
4209 if ((char *) end - (char *) p < learn_min_len(header)) {
4210 return OFPERR_OFPBAC_BAD_LEN;
4211 }
4212
4213 /* Get the source. */
4214 if (spec->src_type == NX_LEARN_SRC_FIELD) {
4215 get_subfield(spec->n_bits, &p, &spec->src);
4216 } else {
4217 int p_bytes = 2 * DIV_ROUND_UP(spec->n_bits, 16);
4218
4219 bitwise_copy(p, p_bytes, 0,
4220 &spec->src_imm, sizeof spec->src_imm, 0,
4221 spec->n_bits);
4222 p = (const uint8_t *) p + p_bytes;
4223 }
4224
4225 /* Get the destination. */
4226 if (spec->dst_type == NX_LEARN_DST_MATCH ||
4227 spec->dst_type == NX_LEARN_DST_LOAD) {
4228 get_subfield(spec->n_bits, &p, &spec->dst);
4229 }
4230 }
ce058104 4231 ofpact_finish_LEARN(ofpacts, &learn);
c2d936a4
BP
4232
4233 if (!is_all_zeros(p, (char *) end - (char *) p)) {
4234 return OFPERR_OFPBAC_BAD_ARGUMENT;
4235 }
4236
4237 return 0;
4238}
4239
4240static void
4241put_be16(struct ofpbuf *b, ovs_be16 x)
4242{
4243 ofpbuf_put(b, &x, sizeof x);
4244}
4245
4246static void
4247put_be32(struct ofpbuf *b, ovs_be32 x)
4248{
4249 ofpbuf_put(b, &x, sizeof x);
4250}
4251
4252static void
4253put_u16(struct ofpbuf *b, uint16_t x)
4254{
4255 put_be16(b, htons(x));
4256}
4257
4258static void
4259put_u32(struct ofpbuf *b, uint32_t x)
4260{
4261 put_be32(b, htonl(x));
4262}
4263
4264static void
4265encode_LEARN(const struct ofpact_learn *learn,
4266 enum ofp_version ofp_version OVS_UNUSED, struct ofpbuf *out)
4267{
4268 const struct ofpact_learn_spec *spec;
4269 struct nx_action_learn *nal;
4270 size_t start_ofs;
4271
6fd6ed71 4272 start_ofs = out->size;
c2d936a4
BP
4273 nal = put_NXAST_LEARN(out);
4274 nal->idle_timeout = htons(learn->idle_timeout);
4275 nal->hard_timeout = htons(learn->hard_timeout);
4276 nal->fin_idle_timeout = htons(learn->fin_idle_timeout);
4277 nal->fin_hard_timeout = htons(learn->fin_hard_timeout);
4278 nal->priority = htons(learn->priority);
4279 nal->cookie = learn->cookie;
4280 nal->flags = htons(learn->flags);
4281 nal->table_id = learn->table_id;
4282
4283 for (spec = learn->specs; spec < &learn->specs[learn->n_specs]; spec++) {
4284 put_u16(out, spec->n_bits | spec->dst_type | spec->src_type);
4285
4286 if (spec->src_type == NX_LEARN_SRC_FIELD) {
508a9338 4287 put_u32(out, mf_nxm_header(spec->src.field->id));
c2d936a4
BP
4288 put_u16(out, spec->src.ofs);
4289 } else {
4290 size_t n_dst_bytes = 2 * DIV_ROUND_UP(spec->n_bits, 16);
4291 uint8_t *bits = ofpbuf_put_zeros(out, n_dst_bytes);
4292 bitwise_copy(&spec->src_imm, sizeof spec->src_imm, 0,
4293 bits, n_dst_bytes, 0,
4294 spec->n_bits);
4295 }
4296
4297 if (spec->dst_type == NX_LEARN_DST_MATCH ||
4298 spec->dst_type == NX_LEARN_DST_LOAD) {
508a9338 4299 put_u32(out, mf_nxm_header(spec->dst.field->id));
c2d936a4
BP
4300 put_u16(out, spec->dst.ofs);
4301 }
4302 }
4303
178742f9 4304 pad_ofpat(out, start_ofs);
c2d936a4
BP
4305}
4306
cab50449 4307static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
4308parse_LEARN(char *arg, struct ofpbuf *ofpacts,
4309 enum ofputil_protocol *usable_protocols OVS_UNUSED)
4310{
4311 return learn_parse(arg, ofpacts);
4312}
4313
4314static void
4315format_LEARN(const struct ofpact_learn *a, struct ds *s)
4316{
4317 learn_format(a, s);
4318}
4319\f
18080541
BP
4320/* Action structure for NXAST_CONJUNCTION. */
4321struct nx_action_conjunction {
4322 ovs_be16 type; /* OFPAT_VENDOR. */
4323 ovs_be16 len; /* At least 16. */
4324 ovs_be32 vendor; /* NX_VENDOR_ID. */
4325 ovs_be16 subtype; /* See enum ofp_raw_action_type. */
4326 uint8_t clause;
4327 uint8_t n_clauses;
4328 ovs_be32 id;
4329};
4330OFP_ASSERT(sizeof(struct nx_action_conjunction) == 16);
4331
4332static void
4333add_conjunction(struct ofpbuf *out,
4334 uint32_t id, uint8_t clause, uint8_t n_clauses)
4335{
4336 struct ofpact_conjunction *oc;
4337
4338 oc = ofpact_put_CONJUNCTION(out);
4339 oc->id = id;
4340 oc->clause = clause;
4341 oc->n_clauses = n_clauses;
4342}
4343
4344static enum ofperr
4345decode_NXAST_RAW_CONJUNCTION(const struct nx_action_conjunction *nac,
f3cd3ac7 4346 enum ofp_version ofp_version OVS_UNUSED,
18080541
BP
4347 struct ofpbuf *out)
4348{
4349 if (nac->n_clauses < 2 || nac->n_clauses > 64
4350 || nac->clause >= nac->n_clauses) {
4351 return OFPERR_NXBAC_BAD_CONJUNCTION;
4352 } else {
4353 add_conjunction(out, ntohl(nac->id), nac->clause, nac->n_clauses);
4354 return 0;
4355 }
4356}
4357
4358static void
4359encode_CONJUNCTION(const struct ofpact_conjunction *oc,
4360 enum ofp_version ofp_version OVS_UNUSED, struct ofpbuf *out)
4361{
4362 struct nx_action_conjunction *nac = put_NXAST_CONJUNCTION(out);
4363 nac->clause = oc->clause;
4364 nac->n_clauses = oc->n_clauses;
4365 nac->id = htonl(oc->id);
4366}
4367
4368static void
4369format_CONJUNCTION(const struct ofpact_conjunction *oc, struct ds *s)
4370{
b1c5bf1f
QM
4371 ds_put_format(s, "%sconjunction(%s%"PRIu32",%"PRIu8"/%"PRIu8"%s)%s",
4372 colors.paren, colors.end,
4373 oc->id, oc->clause + 1, oc->n_clauses,
4374 colors.paren, colors.end);
18080541
BP
4375}
4376
4377static char * OVS_WARN_UNUSED_RESULT
4378parse_CONJUNCTION(const char *arg, struct ofpbuf *ofpacts,
4379 enum ofputil_protocol *usable_protocols OVS_UNUSED)
4380{
4381 uint8_t n_clauses;
4382 uint8_t clause;
4383 uint32_t id;
4384 int n;
4385
4386 if (!ovs_scan(arg, "%"SCNi32" , %"SCNu8" / %"SCNu8" %n",
4387 &id, &clause, &n_clauses, &n) || n != strlen(arg)) {
4388 return xstrdup("\"conjunction\" syntax is \"conjunction(id,i/n)\"");
4389 }
4390
4391 if (n_clauses < 2) {
4392 return xstrdup("conjunction must have at least 2 clauses");
4393 } else if (n_clauses > 64) {
4394 return xstrdup("conjunction must have at most 64 clauses");
4395 } else if (clause < 1) {
4396 return xstrdup("clause index must be positive");
4397 } else if (clause > n_clauses) {
4398 return xstrdup("clause index must be less than or equal to "
4399 "number of clauses");
4400 }
4401
4402 add_conjunction(ofpacts, id, clause - 1, n_clauses);
4403 return NULL;
4404}
4405\f
c2d936a4
BP
4406/* Action structure for NXAST_MULTIPATH.
4407 *
4408 * This action performs the following steps in sequence:
4409 *
4410 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
4411 * Refer to the definition of "enum nx_mp_fields" for details.
4412 *
4413 * The 'basis' value is used as a universal hash parameter, that is,
4414 * different values of 'basis' yield different hash functions. The
4415 * particular universal hash function used is implementation-defined.
4416 *
4417 * The hashed fields' values are drawn from the current state of the
4418 * flow, including all modifications that have been made by actions up to
4419 * this point.
4420 *
4421 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
4422 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
4423 * for details.
4424 *
4425 * The output of the algorithm is 'link', an unsigned integer less than
4426 * or equal to 'max_link'.
4427 *
4428 * Some algorithms use 'arg' as an additional argument.
4429 *
4430 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
4431 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
4432 * action.
4433 *
4434 * The switch will reject actions that have an unknown 'fields', or an unknown
4435 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
4436 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
4437 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
4438 */
4439struct nx_action_multipath {
4440 ovs_be16 type; /* OFPAT_VENDOR. */
4441 ovs_be16 len; /* Length is 32. */
4442 ovs_be32 vendor; /* NX_VENDOR_ID. */
4443 ovs_be16 subtype; /* NXAST_MULTIPATH. */
4444
4445 /* What fields to hash and how. */
4446 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
4447 ovs_be16 basis; /* Universal hash parameter. */
4448 ovs_be16 pad0;
4449
4450 /* Multipath link choice algorithm to apply to hash value. */
4451 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
4452 ovs_be16 max_link; /* Number of output links, minus 1. */
4453 ovs_be32 arg; /* Algorithm-specific argument. */
4454 ovs_be16 pad1;
4455
4456 /* Where to store the result. */
4457 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
4458 ovs_be32 dst; /* Destination. */
4459};
4460OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
4461
4462static enum ofperr
4463decode_NXAST_RAW_MULTIPATH(const struct nx_action_multipath *nam,
f3cd3ac7 4464 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4
BP
4465 struct ofpbuf *out)
4466{
4467 uint32_t n_links = ntohs(nam->max_link) + 1;
4468 size_t min_n_bits = log_2_ceil(n_links);
4469 struct ofpact_multipath *mp;
4470
4471 mp = ofpact_put_MULTIPATH(out);
4472 mp->fields = ntohs(nam->fields);
4473 mp->basis = ntohs(nam->basis);
4474 mp->algorithm = ntohs(nam->algorithm);
4475 mp->max_link = ntohs(nam->max_link);
4476 mp->arg = ntohl(nam->arg);
4477 mp->dst.field = mf_from_nxm_header(ntohl(nam->dst));
4478 mp->dst.ofs = nxm_decode_ofs(nam->ofs_nbits);
4479 mp->dst.n_bits = nxm_decode_n_bits(nam->ofs_nbits);
4480
4481 if (!flow_hash_fields_valid(mp->fields)) {
4482 VLOG_WARN_RL(&rl, "unsupported fields %d", (int) mp->fields);
4483 return OFPERR_OFPBAC_BAD_ARGUMENT;
4484 } else if (mp->algorithm != NX_MP_ALG_MODULO_N
4485 && mp->algorithm != NX_MP_ALG_HASH_THRESHOLD
4486 && mp->algorithm != NX_MP_ALG_HRW
4487 && mp->algorithm != NX_MP_ALG_ITER_HASH) {
4488 VLOG_WARN_RL(&rl, "unsupported algorithm %d", (int) mp->algorithm);
4489 return OFPERR_OFPBAC_BAD_ARGUMENT;
4490 } else if (mp->dst.n_bits < min_n_bits) {
4491 VLOG_WARN_RL(&rl, "multipath action requires at least %"PRIuSIZE" bits for "
4492 "%"PRIu32" links", min_n_bits, n_links);
4493 return OFPERR_OFPBAC_BAD_ARGUMENT;
4494 }
4495
4496 return multipath_check(mp, NULL);
4497}
4498
4499static void
4500encode_MULTIPATH(const struct ofpact_multipath *mp,
4501 enum ofp_version ofp_version OVS_UNUSED, struct ofpbuf *out)
4502{
4503 struct nx_action_multipath *nam = put_NXAST_MULTIPATH(out);
4504
4505 nam->fields = htons(mp->fields);
4506 nam->basis = htons(mp->basis);
4507 nam->algorithm = htons(mp->algorithm);
4508 nam->max_link = htons(mp->max_link);
4509 nam->arg = htonl(mp->arg);
4510 nam->ofs_nbits = nxm_encode_ofs_nbits(mp->dst.ofs, mp->dst.n_bits);
508a9338 4511 nam->dst = htonl(mf_nxm_header(mp->dst.field->id));
c2d936a4
BP
4512}
4513
cab50449 4514static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
4515parse_MULTIPATH(const char *arg, struct ofpbuf *ofpacts,
4516 enum ofputil_protocol *usable_protocols OVS_UNUSED)
4517{
4518 return multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
4519}
4520
4521static void
4522format_MULTIPATH(const struct ofpact_multipath *a, struct ds *s)
4523{
4524 multipath_format(a, s);
4525}
4526\f
4527/* Action structure for NXAST_NOTE.
4528 *
4529 * This action has no effect. It is variable length. The switch does not
4530 * attempt to interpret the user-defined 'note' data in any way. A controller
4531 * can use this action to attach arbitrary metadata to a flow.
4532 *
4533 * This action might go away in the future.
4534 */
4535struct nx_action_note {
4536 ovs_be16 type; /* OFPAT_VENDOR. */
4537 ovs_be16 len; /* A multiple of 8, but at least 16. */
4538 ovs_be32 vendor; /* NX_VENDOR_ID. */
4539 ovs_be16 subtype; /* NXAST_NOTE. */
4540 uint8_t note[6]; /* Start of user-defined data. */
4541 /* Possibly followed by additional user-defined data. */
4542};
4543OFP_ASSERT(sizeof(struct nx_action_note) == 16);
4544
4545static enum ofperr
f3cd3ac7
JS
4546decode_NXAST_RAW_NOTE(const struct nx_action_note *nan,
4547 enum ofp_version ofp_version OVS_UNUSED,
4548 struct ofpbuf *out)
c2d936a4
BP
4549{
4550 struct ofpact_note *note;
4551 unsigned int length;
4552
4553 length = ntohs(nan->len) - offsetof(struct nx_action_note, note);
2bd318de 4554 note = ofpact_put_NOTE(out);
c2d936a4 4555 note->length = length;
2bd318de 4556 ofpbuf_put(out, nan->note, length);
ce058104 4557 ofpact_finish_NOTE(out, &note);
c2d936a4
BP
4558
4559 return 0;
4560}
4561
4562static void
4563encode_NOTE(const struct ofpact_note *note,
4564 enum ofp_version ofp_version OVS_UNUSED, struct ofpbuf *out)
4565{
6fd6ed71 4566 size_t start_ofs = out->size;
c2d936a4 4567 struct nx_action_note *nan;
c2d936a4
BP
4568
4569 put_NXAST_NOTE(out);
6fd6ed71 4570 out->size = out->size - sizeof nan->note;
c2d936a4
BP
4571
4572 ofpbuf_put(out, note->data, note->length);
9ac0aada 4573 pad_ofpat(out, start_ofs);
c2d936a4
BP
4574}
4575
cab50449 4576static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
4577parse_NOTE(const char *arg, struct ofpbuf *ofpacts,
4578 enum ofputil_protocol *usable_protocols OVS_UNUSED)
4579{
27aa8793
BP
4580 size_t start_ofs = ofpacts->size;
4581 ofpact_put_NOTE(ofpacts);
4582 arg = ofpbuf_put_hex(ofpacts, arg, NULL);
4583 if (arg[0]) {
4584 return xstrdup("bad hex digit in `note' argument");
4585 }
4586 struct ofpact_note *note = ofpbuf_at_assert(ofpacts, start_ofs,
4587 sizeof *note);
4588 note->length = ofpacts->size - (start_ofs + sizeof *note);
ce058104 4589 ofpact_finish_NOTE(ofpacts, &note);
c2d936a4
BP
4590 return NULL;
4591}
4592
4593static void
4594format_NOTE(const struct ofpact_note *a, struct ds *s)
4595{
b1c5bf1f 4596 ds_put_format(s, "%snote:%s", colors.param, colors.end);
bdcad671 4597 format_hex_arg(s, a->data, a->length);
c2d936a4
BP
4598}
4599\f
4600/* Exit action. */
4601
4602static enum ofperr
4603decode_NXAST_RAW_EXIT(struct ofpbuf *out)
4604{
4605 ofpact_put_EXIT(out);
4606 return 0;
4607}
4608
4609static void
4610encode_EXIT(const struct ofpact_null *null OVS_UNUSED,
4611 enum ofp_version ofp_version OVS_UNUSED, struct ofpbuf *out)
4612{
4613 put_NXAST_EXIT(out);
4614}
4615
cab50449 4616static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
4617parse_EXIT(char *arg OVS_UNUSED, struct ofpbuf *ofpacts,
4618 enum ofputil_protocol *usable_protocols OVS_UNUSED)
4619{
4620 ofpact_put_EXIT(ofpacts);
4621 return NULL;
4622}
4623
4624static void
4625format_EXIT(const struct ofpact_null *a OVS_UNUSED, struct ds *s)
4626{
b1c5bf1f 4627 ds_put_format(s, "%sexit%s", colors.special, colors.end);
c2d936a4
BP
4628}
4629\f
e672ff9b
JR
4630/* Unroll xlate action. */
4631
4632static void
4633encode_UNROLL_XLATE(const struct ofpact_unroll_xlate *unroll OVS_UNUSED,
4634 enum ofp_version ofp_version OVS_UNUSED,
4635 struct ofpbuf *out OVS_UNUSED)
4636{
4637 OVS_NOT_REACHED();
4638}
4639
4640static char * OVS_WARN_UNUSED_RESULT
4641parse_UNROLL_XLATE(char *arg OVS_UNUSED, struct ofpbuf *ofpacts OVS_UNUSED,
4642 enum ofputil_protocol *usable_protocols OVS_UNUSED)
4643{
4644 OVS_NOT_REACHED();
4645 return NULL;
4646}
4647
4648static void
28632a8a 4649format_UNROLL_XLATE(const struct ofpact_unroll_xlate *a, struct ds *s)
e672ff9b 4650{
b1c5bf1f
QM
4651 ds_put_format(s, "%sunroll_xlate(%s%stable=%s%"PRIu8
4652 ", %scookie=%s%"PRIu64"%s)%s",
4653 colors.paren, colors.end,
4654 colors.special, colors.end, a->rule_table_id,
4655 colors.param, colors.end, ntohll(a->rule_cookie),
4656 colors.paren, colors.end);
e672ff9b
JR
4657}
4658\f
c2d936a4
BP
4659/* Action structure for NXAST_SAMPLE.
4660 *
4661 * Samples matching packets with the given probability and sends them
4662 * each to the set of collectors identified with the given ID. The
4663 * probability is expressed as a number of packets to be sampled out
4664 * of USHRT_MAX packets, and must be >0.
4665 *
4666 * When sending packet samples to IPFIX collectors, the IPFIX flow
4667 * record sent for each sampled packet is associated with the given
4668 * observation domain ID and observation point ID. Each IPFIX flow
4669 * record contain the sampled packet's headers when executing this
4670 * rule. If a sampled packet's headers are modified by previous
4671 * actions in the flow, those modified headers are sent. */
4672struct nx_action_sample {
4673 ovs_be16 type; /* OFPAT_VENDOR. */
4674 ovs_be16 len; /* Length is 24. */
4675 ovs_be32 vendor; /* NX_VENDOR_ID. */
4676 ovs_be16 subtype; /* NXAST_SAMPLE. */
4677 ovs_be16 probability; /* Fraction of packets to sample. */
4678 ovs_be32 collector_set_id; /* ID of collector set in OVSDB. */
4679 ovs_be32 obs_domain_id; /* ID of sampling observation domain. */
4680 ovs_be32 obs_point_id; /* ID of sampling observation point. */
4681};
4682OFP_ASSERT(sizeof(struct nx_action_sample) == 24);
4683
4684static enum ofperr
f3cd3ac7
JS
4685decode_NXAST_RAW_SAMPLE(const struct nx_action_sample *nas,
4686 enum ofp_version ofp_version OVS_UNUSED,
4687 struct ofpbuf *out)
c2d936a4
BP
4688{
4689 struct ofpact_sample *sample;
4690
4691 sample = ofpact_put_SAMPLE(out);
4692 sample->probability = ntohs(nas->probability);
4693 sample->collector_set_id = ntohl(nas->collector_set_id);
4694 sample->obs_domain_id = ntohl(nas->obs_domain_id);
4695 sample->obs_point_id = ntohl(nas->obs_point_id);
4696
4697 if (sample->probability == 0) {
4698 return OFPERR_OFPBAC_BAD_ARGUMENT;
4699 }
4700
4701 return 0;
4702}
4703
4704static void
4705encode_SAMPLE(const struct ofpact_sample *sample,
4706 enum ofp_version ofp_version OVS_UNUSED, struct ofpbuf *out)
4707{
4708 struct nx_action_sample *nas;
4709
4710 nas = put_NXAST_SAMPLE(out);
4711 nas->probability = htons(sample->probability);
4712 nas->collector_set_id = htonl(sample->collector_set_id);
4713 nas->obs_domain_id = htonl(sample->obs_domain_id);
4714 nas->obs_point_id = htonl(sample->obs_point_id);
4715}
4716
4717/* Parses 'arg' as the argument to a "sample" action, and appends such an
4718 * action to 'ofpacts'.
4719 *
4720 * Returns NULL if successful, otherwise a malloc()'d string describing the
4721 * error. The caller is responsible for freeing the returned string. */
cab50449 4722static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
4723parse_SAMPLE(char *arg, struct ofpbuf *ofpacts,
4724 enum ofputil_protocol *usable_protocols OVS_UNUSED)
4725{
4726 struct ofpact_sample *os = ofpact_put_SAMPLE(ofpacts);
4727 char *key, *value;
4728
4729 while (ofputil_parse_key_value(&arg, &key, &value)) {
4730 char *error = NULL;
4731
4732 if (!strcmp(key, "probability")) {
4733 error = str_to_u16(value, "probability", &os->probability);
4734 if (!error && os->probability == 0) {
4735 error = xasprintf("invalid probability value \"%s\"", value);
4736 }
4737 } else if (!strcmp(key, "collector_set_id")) {
4738 error = str_to_u32(value, &os->collector_set_id);
4739 } else if (!strcmp(key, "obs_domain_id")) {
4740 error = str_to_u32(value, &os->obs_domain_id);
4741 } else if (!strcmp(key, "obs_point_id")) {
4742 error = str_to_u32(value, &os->obs_point_id);
4743 } else {
4744 error = xasprintf("invalid key \"%s\" in \"sample\" argument",
4745 key);
4746 }
4747 if (error) {
4748 return error;
4749 }
4750 }
4751 if (os->probability == 0) {
4752 return xstrdup("non-zero \"probability\" must be specified on sample");
4753 }
4754 return NULL;
4755}
4756
4757static void
4758format_SAMPLE(const struct ofpact_sample *a, struct ds *s)
4759{
b1c5bf1f
QM
4760 ds_put_format(s, "%ssample(%s%sprobability=%s%"PRIu16
4761 ",%scollector_set_id=%s%"PRIu32
4762 ",%sobs_domain_id=%s%"PRIu32
4763 ",%sobs_point_id=%s%"PRIu32"%s)%s",
4764 colors.paren, colors.end,
4765 colors.param, colors.end, a->probability,
4766 colors.param, colors.end, a->collector_set_id,
4767 colors.param, colors.end, a->obs_domain_id,
4768 colors.param, colors.end, a->obs_point_id,
4769 colors.paren, colors.end);
c2d936a4
BP
4770}
4771\f
d4abaff5
BP
4772/* debug_recirc instruction. */
4773
4774static bool enable_debug;
4775
4776void
4777ofpact_dummy_enable(void)
4778{
4779 enable_debug = true;
4780}
4781
4782static enum ofperr
4783decode_NXAST_RAW_DEBUG_RECIRC(struct ofpbuf *out)
4784{
4785 if (!enable_debug) {
4786 return OFPERR_OFPBAC_BAD_VENDOR_TYPE;
4787 }
4788
4789 ofpact_put_DEBUG_RECIRC(out);
4790 return 0;
4791}
4792
4793static void
4794encode_DEBUG_RECIRC(const struct ofpact_null *n OVS_UNUSED,
4795 enum ofp_version ofp_version OVS_UNUSED,
4796 struct ofpbuf *out)
4797{
4798 put_NXAST_DEBUG_RECIRC(out);
4799}
4800
4801static char * OVS_WARN_UNUSED_RESULT
4802parse_DEBUG_RECIRC(char *arg OVS_UNUSED, struct ofpbuf *ofpacts,
4803 enum ofputil_protocol *usable_protocols OVS_UNUSED)
4804{
4805 ofpact_put_DEBUG_RECIRC(ofpacts);
4806 return NULL;
4807}
4808
4809static void
4810format_DEBUG_RECIRC(const struct ofpact_null *a OVS_UNUSED, struct ds *s)
4811{
b1c5bf1f 4812 ds_put_format(s, "%sdebug_recirc%s", colors.value, colors.end);
d4abaff5 4813}
07659514
JS
4814
4815/* Action structure for NXAST_CT.
4816 *
4817 * Pass traffic to the connection tracker.
4818 *
4819 * There are two important concepts to understanding the connection tracking
4820 * interface: Packet state and Connection state. Packets may be "Untracked" or
4821 * "Tracked". Connections may be "Uncommitted" or "Committed".
4822 *
4823 * - Packet State:
4824 *
4825 * Untracked packets have not yet passed through the connection tracker,
4826 * and the connection state for such packets is unknown. In most cases,
4827 * packets entering the OpenFlow pipeline will initially be in the
4828 * untracked state. Untracked packets may become tracked by executing
4829 * NXAST_CT with a "recirc_table" specified. This makes various aspects
4830 * about the connection available, in particular the connection state.
4831 *
4832 * Tracked packets have previously passed through the connection tracker.
4833 * These packets will remain tracked through until the end of the OpenFlow
4834 * pipeline. Tracked packets which have NXAST_CT executed with a
4835 * "recirc_table" specified will return to the tracked state.
4836 *
4837 * The packet state is only significant for the duration of packet
4838 * processing within the OpenFlow pipeline.
4839 *
4840 * - Connection State:
4841 *
4842 * Multiple packets may be associated with a single connection. Initially,
4843 * all connections are uncommitted. The connection state corresponding to
4844 * a packet is available in the NXM_NX_CT_STATE field for tracked packets.
4845 *
4846 * Uncommitted connections have no state stored about them. Uncommitted
4847 * connections may transition into the committed state by executing
4848 * NXAST_CT with the NX_CT_F_COMMIT flag.
4849 *
4850 * Once a connection becomes committed, information may be gathered about
4851 * the connection by passing subsequent packets through the connection
4852 * tracker, and the state of the connection will be stored beyond the
4853 * lifetime of packet processing.
4854 *
4855 * Connections may transition back into the uncommitted state due to
4856 * external timers, or due to the contents of packets that are sent to the
4857 * connection tracker. This behaviour is outside of the scope of the
4858 * OpenFlow interface.
4859 *
4860 * The "zone" specifies a context within which the tracking is done:
4861 *
4862 * The connection tracking zone is a 16-bit number. Each zone is an
4863 * independent connection tracking context. The connection state for each
4864 * connection is completely separate for each zone, so if a connection
4865 * is committed to zone A, then it will remain uncommitted in zone B.
4866 * If NXAST_CT is executed with the same zone multiple times, later
4867 * executions have no effect.
4868 *
4869 * If 'zone_src' is nonzero, this specifies that the zone should be
4870 * sourced from a field zone_src[ofs:ofs+nbits]. The format and semantics
4871 * of 'zone_src' and 'zone_ofs_nbits' are similar to those for the
4872 * NXAST_REG_LOAD action. The acceptable nxm_header values for 'zone_src'
4873 * are the same as the acceptable nxm_header values for the 'src' field of
4874 * NXAST_REG_MOVE.
4875 *
4876 * If 'zone_src' is zero, then the value of 'zone_imm' will be used as the
4877 * connection tracking zone.
4878 *
4879 * The "recirc_table" allows NXM_NX_CT_* fields to become available:
4880 *
4881 * If "recirc_table" has a value other than NX_CT_RECIRC_NONE, then the
4882 * packet will be logically cloned prior to executing this action. One
4883 * copy will be sent to the connection tracker, then will be re-injected
4884 * into the OpenFlow pipeline beginning at the OpenFlow table specified in
4885 * this field. When the packet re-enters the pipeline, the NXM_NX_CT_*
4886 * fields will be populated. The original instance of the packet will
4887 * continue the current actions list. This can be thought of as similar to
4888 * the effect of the "output" action: One copy is sent out (in this case,
4889 * to the connection tracker), but the current copy continues processing.
4890 *
4891 * It is strongly recommended that this table is later than the current
4892 * table, to prevent loops.
8e53fe8c 4893 *
d787ad39
JS
4894 * The "alg" attaches protocol-specific behaviour to this action:
4895 *
4896 * The ALG is a 16-bit number which specifies that additional
4897 * processing should be applied to this traffic.
4898 *
4899 * Protocol | Value | Meaning
4900 * --------------------------------------------------------------------
4901 * None | 0 | No protocol-specific behaviour.
4902 * FTP | 21 | Parse FTP control connections and observe the
4903 * | | negotiation of related data connections.
4904 * Other | Other | Unsupported protocols.
4905 *
4906 * By way of example, if FTP control connections have this action applied
4907 * with the ALG set to FTP (21), then the connection tracker will observe
4908 * the negotiation of data connections. This allows the connection
4909 * tracker to identify subsequent data connections as "related" to this
4910 * existing connection. The "related" flag will be populated in the
4911 * NXM_NX_CT_STATE field for such connections if the 'recirc_table' is
4912 * specified.
4913 *
8e53fe8c
JS
4914 * Zero or more actions may immediately follow this action. These actions will
4915 * be executed within the context of the connection tracker, and they require
4916 * the NX_CT_F_COMMIT flag to be set.
07659514
JS
4917 */
4918struct nx_action_conntrack {
4919 ovs_be16 type; /* OFPAT_VENDOR. */
4920 ovs_be16 len; /* At least 24. */
4921 ovs_be32 vendor; /* NX_VENDOR_ID. */
4922 ovs_be16 subtype; /* NXAST_CT. */
4923 ovs_be16 flags; /* Zero or more NX_CT_F_* flags.
4924 * Unspecified flag bits must be zero. */
4925 ovs_be32 zone_src; /* Connection tracking context. */
4926 union {
4927 ovs_be16 zone_ofs_nbits;/* Range to use from source field. */
4928 ovs_be16 zone_imm; /* Immediate value for zone. */
4929 };
4930 uint8_t recirc_table; /* Recirculate to a specific table, or
4931 NX_CT_RECIRC_NONE for no recirculation. */
d787ad39
JS
4932 uint8_t pad[3]; /* Zeroes */
4933 ovs_be16 alg; /* Well-known port number for the protocol.
4934 * 0 indicates no ALG is required. */
07659514
JS
4935 /* Followed by a sequence of zero or more OpenFlow actions. The length of
4936 * these is included in 'len'. */
4937};
4938OFP_ASSERT(sizeof(struct nx_action_conntrack) == 24);
4939
4940static enum ofperr
4941decode_ct_zone(const struct nx_action_conntrack *nac,
4942 struct ofpact_conntrack *out)
4943{
4944 if (nac->zone_src) {
4945 enum ofperr error;
4946
4947 out->zone_src.field = mf_from_nxm_header(ntohl(nac->zone_src));
4948 out->zone_src.ofs = nxm_decode_ofs(nac->zone_ofs_nbits);
4949 out->zone_src.n_bits = nxm_decode_n_bits(nac->zone_ofs_nbits);
4950 error = mf_check_src(&out->zone_src, NULL);
4951 if (error) {
4952 return error;
4953 }
4954
4955 if (out->zone_src.n_bits != 16) {
4956 VLOG_WARN_RL(&rl, "zone n_bits %d not within valid range [16..16]",
4957 out->zone_src.n_bits);
4958 return OFPERR_OFPBAC_BAD_SET_LEN;
4959 }
4960 } else {
4961 out->zone_src.field = NULL;
4962 out->zone_imm = ntohs(nac->zone_imm);
4963 }
4964
4965 return 0;
4966}
4967
4968static enum ofperr
4969decode_NXAST_RAW_CT(const struct nx_action_conntrack *nac,
8e53fe8c 4970 enum ofp_version ofp_version, struct ofpbuf *out)
07659514 4971{
8e53fe8c 4972 const size_t ct_offset = ofpacts_pull(out);
0a2869d5 4973 struct ofpact_conntrack *conntrack = ofpact_put_CT(out);
07659514 4974 conntrack->flags = ntohs(nac->flags);
0a2869d5
BP
4975
4976 int error = decode_ct_zone(nac, conntrack);
07659514
JS
4977 if (error) {
4978 goto out;
4979 }
4980 conntrack->recirc_table = nac->recirc_table;
d787ad39 4981 conntrack->alg = ntohs(nac->alg);
07659514 4982
8e53fe8c
JS
4983 ofpbuf_pull(out, sizeof(*conntrack));
4984
0a2869d5
BP
4985 struct ofpbuf openflow = ofpbuf_const_initializer(
4986 nac + 1, ntohs(nac->len) - sizeof(*nac));
8e53fe8c
JS
4987 error = ofpacts_pull_openflow_actions__(&openflow, openflow.size,
4988 ofp_version,
4989 1u << OVSINST_OFPIT11_APPLY_ACTIONS,
4990 out, OFPACT_CT);
4991 if (error) {
4992 goto out;
4993 }
4994
4995 conntrack = ofpbuf_push_uninit(out, sizeof(*conntrack));
4996 out->header = &conntrack->ofpact;
ce058104 4997 ofpact_finish_CT(out, &conntrack);
8e53fe8c
JS
4998
4999 if (conntrack->ofpact.len > sizeof(*conntrack)
5000 && !(conntrack->flags & NX_CT_F_COMMIT)) {
9ac0aada
JR
5001 const struct ofpact *a;
5002 size_t ofpacts_len = conntrack->ofpact.len - sizeof(*conntrack);
5003
5004 OFPACT_FOR_EACH (a, conntrack->actions, ofpacts_len) {
5005 if (a->type != OFPACT_NAT || ofpact_get_NAT(a)->flags
5006 || ofpact_get_NAT(a)->range_af != AF_UNSPEC) {
5007 VLOG_WARN_RL(&rl, "CT action requires commit flag if actions "
5008 "other than NAT without arguments are specified.");
5009 error = OFPERR_OFPBAC_BAD_ARGUMENT;
5010 goto out;
5011 }
5012 }
8e53fe8c
JS
5013 }
5014
07659514 5015out:
8e53fe8c 5016 ofpbuf_push_uninit(out, ct_offset);
07659514
JS
5017 return error;
5018}
5019
5020static void
5021encode_CT(const struct ofpact_conntrack *conntrack,
8e53fe8c 5022 enum ofp_version ofp_version, struct ofpbuf *out)
07659514
JS
5023{
5024 struct nx_action_conntrack *nac;
8e53fe8c
JS
5025 const size_t ofs = out->size;
5026 size_t len;
07659514
JS
5027
5028 nac = put_NXAST_CT(out);
5029 nac->flags = htons(conntrack->flags);
5030 if (conntrack->zone_src.field) {
5031 nac->zone_src = htonl(mf_nxm_header(conntrack->zone_src.field->id));
5032 nac->zone_ofs_nbits = nxm_encode_ofs_nbits(conntrack->zone_src.ofs,
5033 conntrack->zone_src.n_bits);
5034 } else {
5035 nac->zone_src = htonl(0);
5036 nac->zone_imm = htons(conntrack->zone_imm);
5037 }
5038 nac->recirc_table = conntrack->recirc_table;
d787ad39 5039 nac->alg = htons(conntrack->alg);
8e53fe8c
JS
5040
5041 len = ofpacts_put_openflow_actions(conntrack->actions,
5042 ofpact_ct_get_action_len(conntrack),
5043 out, ofp_version);
5044 len += sizeof(*nac);
5045 nac = ofpbuf_at(out, ofs, sizeof(*nac));
5046 nac->len = htons(len);
07659514
JS
5047}
5048
9ac0aada
JR
5049static char * OVS_WARN_UNUSED_RESULT parse_NAT(char *arg, struct ofpbuf *,
5050 enum ofputil_protocol * OVS_UNUSED);
5051
07659514
JS
5052/* Parses 'arg' as the argument to a "ct" action, and appends such an
5053 * action to 'ofpacts'.
5054 *
5055 * Returns NULL if successful, otherwise a malloc()'d string describing the
5056 * error. The caller is responsible for freeing the returned string. */
5057static char * OVS_WARN_UNUSED_RESULT
5058parse_CT(char *arg, struct ofpbuf *ofpacts,
8e53fe8c 5059 enum ofputil_protocol *usable_protocols)
07659514 5060{
8e53fe8c 5061 const size_t ct_offset = ofpacts_pull(ofpacts);
07659514
JS
5062 struct ofpact_conntrack *oc;
5063 char *error = NULL;
5064 char *key, *value;
5065
5066 oc = ofpact_put_CT(ofpacts);
5067 oc->flags = 0;
5068 oc->recirc_table = NX_CT_RECIRC_NONE;
5069 while (ofputil_parse_key_value(&arg, &key, &value)) {
5070 if (!strcmp(key, "commit")) {
5071 oc->flags |= NX_CT_F_COMMIT;
5072 } else if (!strcmp(key, "table")) {
5073 error = str_to_u8(value, "recirc_table", &oc->recirc_table);
5074 if (!error && oc->recirc_table == NX_CT_RECIRC_NONE) {
5075 error = xasprintf("invalid table %#"PRIx16, oc->recirc_table);
5076 }
5077 } else if (!strcmp(key, "zone")) {
5078 error = str_to_u16(value, "zone", &oc->zone_imm);
5079
5080 if (error) {
5081 free(error);
5082 error = mf_parse_subfield(&oc->zone_src, value);
5083 if (error) {
5084 return error;
5085 }
5086 }
d787ad39
JS
5087 } else if (!strcmp(key, "alg")) {
5088 error = str_to_connhelper(value, &oc->alg);
9ac0aada
JR
5089 } else if (!strcmp(key, "nat")) {
5090 const size_t nat_offset = ofpacts_pull(ofpacts);
5091
5092 error = parse_NAT(value, ofpacts, usable_protocols);
9ac0aada
JR
5093 /* Update CT action pointer and length. */
5094 ofpacts->header = ofpbuf_push_uninit(ofpacts, nat_offset);
5095 oc = ofpacts->header;
8e53fe8c
JS
5096 } else if (!strcmp(key, "exec")) {
5097 /* Hide existing actions from ofpacts_parse_copy(), so the
5098 * nesting can be handled transparently. */
76e3e669 5099 enum ofputil_protocol usable_protocols2;
9ac0aada 5100 const size_t exec_offset = ofpacts_pull(ofpacts);
76e3e669 5101
76e3e669
JR
5102 /* Initializes 'usable_protocol2', fold it back to
5103 * '*usable_protocols' afterwards, so that we do not lose
5104 * restrictions already in there. */
5105 error = ofpacts_parse_copy(value, ofpacts, &usable_protocols2,
5106 false, OFPACT_CT);
5107 *usable_protocols &= usable_protocols2;
9ac0aada 5108 ofpacts->header = ofpbuf_push_uninit(ofpacts, exec_offset);
8e53fe8c 5109 oc = ofpacts->header;
07659514
JS
5110 } else {
5111 error = xasprintf("invalid argument to \"ct\" action: `%s'", key);
5112 }
5113 if (error) {
5114 break;
5115 }
5116 }
5117
ce058104 5118 ofpact_finish_CT(ofpacts, &oc);
8e53fe8c 5119 ofpbuf_push_uninit(ofpacts, ct_offset);
07659514
JS
5120 return error;
5121}
5122
d787ad39
JS
5123static void
5124format_alg(int port, struct ds *s)
5125{
5126 if (port == IPPORT_FTP) {
b1c5bf1f 5127 ds_put_format(s, "%salg=%sftp,", colors.param, colors.end);
d787ad39 5128 } else if (port) {
b1c5bf1f 5129 ds_put_format(s, "%salg=%s%d,", colors.param, colors.end, port);
d787ad39
JS
5130 }
5131}
5132
9ac0aada
JR
5133static void format_NAT(const struct ofpact_nat *a, struct ds *ds);
5134
07659514
JS
5135static void
5136format_CT(const struct ofpact_conntrack *a, struct ds *s)
5137{
b1c5bf1f 5138 ds_put_format(s, "%sct(%s", colors.paren, colors.end);
07659514 5139 if (a->flags & NX_CT_F_COMMIT) {
b1c5bf1f 5140 ds_put_format(s, "%scommit%s,", colors.value, colors.end);
07659514
JS
5141 }
5142 if (a->recirc_table != NX_CT_RECIRC_NONE) {
b1c5bf1f
QM
5143 ds_put_format(s, "%stable=%s%"PRIu8",",
5144 colors.special, colors.end, a->recirc_table);
07659514
JS
5145 }
5146 if (a->zone_src.field) {
b1c5bf1f 5147 ds_put_format(s, "%szone=%s", colors.param, colors.end);
07659514
JS
5148 mf_format_subfield(&a->zone_src, s);
5149 ds_put_char(s, ',');
5150 } else if (a->zone_imm) {
b1c5bf1f
QM
5151 ds_put_format(s, "%szone=%s%"PRIu16",",
5152 colors.param, colors.end, a->zone_imm);
07659514 5153 }
9ac0aada
JR
5154 /* If the first action is a NAT action, format it outside of the 'exec'
5155 * envelope. */
5156 const struct ofpact *action = a->actions;
5157 size_t actions_len = ofpact_ct_get_action_len(a);
5158 if (actions_len && action->type == OFPACT_NAT) {
5159 format_NAT(ofpact_get_NAT(action), s);
5160 ds_put_char(s, ',');
5161 actions_len -= OFPACT_ALIGN(action->len);
5162 action = ofpact_next(action);
5163 }
5164 if (actions_len) {
b1c5bf1f 5165 ds_put_format(s, "%sexec(%s", colors.paren, colors.end);
9ac0aada 5166 ofpacts_format(action, actions_len, s);
b1c5bf1f 5167 ds_put_format(s, "%s),%s", colors.paren, colors.end);
8e53fe8c 5168 }
d787ad39 5169 format_alg(a->alg, s);
07659514 5170 ds_chomp(s, ',');
b1c5bf1f 5171 ds_put_format(s, "%s)%s", colors.paren, colors.end);
07659514 5172}
9ac0aada
JR
5173\f
5174/* NAT action. */
5175
5176/* Which optional fields are present? */
5177enum nx_nat_range {
5178 NX_NAT_RANGE_IPV4_MIN = 1 << 0, /* ovs_be32 */
5179 NX_NAT_RANGE_IPV4_MAX = 1 << 1, /* ovs_be32 */
5180 NX_NAT_RANGE_IPV6_MIN = 1 << 2, /* struct in6_addr */
5181 NX_NAT_RANGE_IPV6_MAX = 1 << 3, /* struct in6_addr */
5182 NX_NAT_RANGE_PROTO_MIN = 1 << 4, /* ovs_be16 */
5183 NX_NAT_RANGE_PROTO_MAX = 1 << 5, /* ovs_be16 */
5184};
5185
5186/* Action structure for NXAST_NAT. */
5187struct nx_action_nat {
5188 ovs_be16 type; /* OFPAT_VENDOR. */
5189 ovs_be16 len; /* At least 16. */
5190 ovs_be32 vendor; /* NX_VENDOR_ID. */
5191 ovs_be16 subtype; /* NXAST_NAT. */
5192 uint8_t pad[2]; /* Must be zero. */
5193 ovs_be16 flags; /* Zero or more NX_NAT_F_* flags.
5194 * Unspecified flag bits must be zero. */
5195 ovs_be16 range_present; /* NX_NAT_RANGE_* */
5196 /* Followed by optional parameters as specified by 'range_present' */
5197};
5198OFP_ASSERT(sizeof(struct nx_action_nat) == 16);
5199
5200static void
5201encode_NAT(const struct ofpact_nat *nat,
5202 enum ofp_version ofp_version OVS_UNUSED,
5203 struct ofpbuf *out)
5204{
5205 struct nx_action_nat *nan;
5206 const size_t ofs = out->size;
5207 uint16_t range_present = 0;
5208
5209 nan = put_NXAST_NAT(out);
5210 nan->flags = htons(nat->flags);
5211 if (nat->range_af == AF_INET) {
5212 if (nat->range.addr.ipv4.min) {
5213 ovs_be32 *min = ofpbuf_put_uninit(out, sizeof *min);
5214 *min = nat->range.addr.ipv4.min;
5215 range_present |= NX_NAT_RANGE_IPV4_MIN;
5216 }
5217 if (nat->range.addr.ipv4.max) {
5218 ovs_be32 *max = ofpbuf_put_uninit(out, sizeof *max);
5219 *max = nat->range.addr.ipv4.max;
5220 range_present |= NX_NAT_RANGE_IPV4_MAX;
5221 }
5222 } else if (nat->range_af == AF_INET6) {
5223 if (!ipv6_mask_is_any(&nat->range.addr.ipv6.min)) {
5224 struct in6_addr *min = ofpbuf_put_uninit(out, sizeof *min);
5225 *min = nat->range.addr.ipv6.min;
5226 range_present |= NX_NAT_RANGE_IPV6_MIN;
5227 }
5228 if (!ipv6_mask_is_any(&nat->range.addr.ipv6.max)) {
5229 struct in6_addr *max = ofpbuf_put_uninit(out, sizeof *max);
5230 *max = nat->range.addr.ipv6.max;
5231 range_present |= NX_NAT_RANGE_IPV6_MAX;
5232 }
5233 }
5234 if (nat->range_af != AF_UNSPEC) {
5235 if (nat->range.proto.min) {
5236 ovs_be16 *min = ofpbuf_put_uninit(out, sizeof *min);
5237 *min = htons(nat->range.proto.min);
5238 range_present |= NX_NAT_RANGE_PROTO_MIN;
5239 }
5240 if (nat->range.proto.max) {
5241 ovs_be16 *max = ofpbuf_put_uninit(out, sizeof *max);
5242 *max = htons(nat->range.proto.max);
5243 range_present |= NX_NAT_RANGE_PROTO_MAX;
5244 }
5245 }
5246 pad_ofpat(out, ofs);
5247 nan = ofpbuf_at(out, ofs, sizeof *nan);
5248 nan->range_present = htons(range_present);
5249}
5250
5251static enum ofperr
5252decode_NXAST_RAW_NAT(const struct nx_action_nat *nan,
5253 enum ofp_version ofp_version OVS_UNUSED,
5254 struct ofpbuf *out)
5255{
5256 struct ofpact_nat *nat;
5257 uint16_t range_present = ntohs(nan->range_present);
5258 const char *opts = (char *)(nan + 1);
5259 uint16_t len = ntohs(nan->len) - sizeof *nan;
5260
5261 nat = ofpact_put_NAT(out);
5262 nat->flags = ntohs(nan->flags);
5263
5264#define NX_NAT_GET_OPT(DST, SRC, LEN, TYPE) \
5265 (LEN >= sizeof(TYPE) \
5266 ? (memcpy(DST, SRC, sizeof(TYPE)), LEN -= sizeof(TYPE), \
5267 SRC += sizeof(TYPE)) \
5268 : NULL)
5269
5270 nat->range_af = AF_UNSPEC;
5271 if (range_present & NX_NAT_RANGE_IPV4_MIN) {
5272 if (range_present & (NX_NAT_RANGE_IPV6_MIN | NX_NAT_RANGE_IPV6_MAX)) {
5273 return OFPERR_OFPBAC_BAD_ARGUMENT;
5274 }
5275
5276 if (!NX_NAT_GET_OPT(&nat->range.addr.ipv4.min, opts, len, ovs_be32)
5277 || !nat->range.addr.ipv4.min) {
5278 return OFPERR_OFPBAC_BAD_ARGUMENT;
5279 }
5280
5281 nat->range_af = AF_INET;
5282
5283 if (range_present & NX_NAT_RANGE_IPV4_MAX) {
5284 if (!NX_NAT_GET_OPT(&nat->range.addr.ipv4.max, opts, len,
5285 ovs_be32)) {
5286 return OFPERR_OFPBAC_BAD_ARGUMENT;
5287 }
5288 if (ntohl(nat->range.addr.ipv4.max)
5289 < ntohl(nat->range.addr.ipv4.min)) {
5290 return OFPERR_OFPBAC_BAD_ARGUMENT;
5291 }
5292 }
5293 } else if (range_present & NX_NAT_RANGE_IPV4_MAX) {
5294 return OFPERR_OFPBAC_BAD_ARGUMENT;
5295 } else if (range_present & NX_NAT_RANGE_IPV6_MIN) {
5296 if (!NX_NAT_GET_OPT(&nat->range.addr.ipv6.min, opts, len,
5297 struct in6_addr)
5298 || ipv6_mask_is_any(&nat->range.addr.ipv6.min)) {
5299 return OFPERR_OFPBAC_BAD_ARGUMENT;
5300 }
5301
5302 nat->range_af = AF_INET6;
5303
5304 if (range_present & NX_NAT_RANGE_IPV6_MAX) {
5305 if (!NX_NAT_GET_OPT(&nat->range.addr.ipv6.max, opts, len,
5306 struct in6_addr)) {
5307 return OFPERR_OFPBAC_BAD_ARGUMENT;
5308 }
5309 if (memcmp(&nat->range.addr.ipv6.max, &nat->range.addr.ipv6.min,
5310 sizeof(struct in6_addr)) < 0) {
5311 return OFPERR_OFPBAC_BAD_ARGUMENT;
5312 }
5313 }
5314 } else if (range_present & NX_NAT_RANGE_IPV6_MAX) {
5315 return OFPERR_OFPBAC_BAD_ARGUMENT;
5316 }
5317
5318 if (range_present & NX_NAT_RANGE_PROTO_MIN) {
5319 ovs_be16 proto;
5320
5321 if (nat->range_af == AF_UNSPEC) {
5322 return OFPERR_OFPBAC_BAD_ARGUMENT;
5323 }
5324 if (!NX_NAT_GET_OPT(&proto, opts, len, ovs_be16) || proto == 0) {
5325 return OFPERR_OFPBAC_BAD_ARGUMENT;
5326 }
5327 nat->range.proto.min = ntohs(proto);
5328 if (range_present & NX_NAT_RANGE_PROTO_MAX) {
5329 if (!NX_NAT_GET_OPT(&proto, opts, len, ovs_be16)) {
5330 return OFPERR_OFPBAC_BAD_ARGUMENT;
5331 }
5332 nat->range.proto.max = ntohs(proto);
5333 if (nat->range.proto.max < nat->range.proto.min) {
5334 return OFPERR_OFPBAC_BAD_ARGUMENT;
5335 }
5336 }
5337 } else if (range_present & NX_NAT_RANGE_PROTO_MAX) {
5338 return OFPERR_OFPBAC_BAD_ARGUMENT;
5339 }
5340
5341 return 0;
5342}
5343
5344static void
5345format_NAT(const struct ofpact_nat *a, struct ds *ds)
5346{
b1c5bf1f 5347 ds_put_format(ds, "%snat%s", colors.paren, colors.end);
9ac0aada
JR
5348
5349 if (a->flags & (NX_NAT_F_SRC | NX_NAT_F_DST)) {
b1c5bf1f
QM
5350 ds_put_format(ds, "%s(%s", colors.paren, colors.end);
5351 ds_put_format(ds, a->flags & NX_NAT_F_SRC ? "%ssrc%s" : "%sdst%s",
5352 colors.param, colors.end);
9ac0aada
JR
5353
5354 if (a->range_af != AF_UNSPEC) {
b1c5bf1f 5355 ds_put_format(ds, "%s=%s", colors.param, colors.end);
9ac0aada
JR
5356
5357 if (a->range_af == AF_INET) {
5358 ds_put_format(ds, IP_FMT, IP_ARGS(a->range.addr.ipv4.min));
5359
5360 if (a->range.addr.ipv4.max
5361 && a->range.addr.ipv4.max != a->range.addr.ipv4.min) {
5362 ds_put_format(ds, "-"IP_FMT,
5363 IP_ARGS(a->range.addr.ipv4.max));
5364 }
5365 } else if (a->range_af == AF_INET6) {
5366 ipv6_format_addr_bracket(&a->range.addr.ipv6.min, ds,
5367 a->range.proto.min);
5368
5369 if (!ipv6_mask_is_any(&a->range.addr.ipv6.max)
5370 && memcmp(&a->range.addr.ipv6.max, &a->range.addr.ipv6.min,
5371 sizeof(struct in6_addr)) != 0) {
5372 ds_put_char(ds, '-');
5373 ipv6_format_addr_bracket(&a->range.addr.ipv6.max, ds,
5374 a->range.proto.min);
5375 }
5376 }
5377 if (a->range.proto.min) {
5378 ds_put_char(ds, ':');
5379 ds_put_format(ds, "%"PRIu16, a->range.proto.min);
5380
5381 if (a->range.proto.max
5382 && a->range.proto.max != a->range.proto.min) {
5383 ds_put_format(ds, "-%"PRIu16, a->range.proto.max);
5384 }
5385 }
5386 ds_put_char(ds, ',');
5387
5388 if (a->flags & NX_NAT_F_PERSISTENT) {
b1c5bf1f
QM
5389 ds_put_format(ds, "%spersistent%s,",
5390 colors.value, colors.end);
9ac0aada
JR
5391 }
5392 if (a->flags & NX_NAT_F_PROTO_HASH) {
b1c5bf1f 5393 ds_put_format(ds, "%shash%s,", colors.value, colors.end);
9ac0aada
JR
5394 }
5395 if (a->flags & NX_NAT_F_PROTO_RANDOM) {
b1c5bf1f 5396 ds_put_format(ds, "%srandom%s,", colors.value, colors.end);
9ac0aada
JR
5397 }
5398 }
5399 ds_chomp(ds, ',');
b1c5bf1f 5400 ds_put_format(ds, "%s)%s", colors.paren, colors.end);
9ac0aada
JR
5401 }
5402}
5403
5404static char * OVS_WARN_UNUSED_RESULT
5405str_to_nat_range(const char *s, struct ofpact_nat *on)
5406{
5407 char ipv6_s[IPV6_SCAN_LEN + 1];
5408 int n = 0;
5409
5410 on->range_af = AF_UNSPEC;
5411 if (ovs_scan_len(s, &n, IP_SCAN_FMT,
5412 IP_SCAN_ARGS(&on->range.addr.ipv4.min))) {
5413 on->range_af = AF_INET;
5414
5415 if (s[n] == '-') {
5416 n++;
5417 if (!ovs_scan_len(s, &n, IP_SCAN_FMT,
5418 IP_SCAN_ARGS(&on->range.addr.ipv4.max))
5419 || (ntohl(on->range.addr.ipv4.max)
5420 < ntohl(on->range.addr.ipv4.min))) {
5421 goto error;
5422 }
5423 }
5424 } else if ((ovs_scan_len(s, &n, IPV6_SCAN_FMT, ipv6_s)
5425 || ovs_scan_len(s, &n, "["IPV6_SCAN_FMT"]", ipv6_s))
5426 && inet_pton(AF_INET6, ipv6_s, &on->range.addr.ipv6.min) == 1) {
5427 on->range_af = AF_INET6;
5428
5429 if (s[n] == '-') {
5430 n++;
5431 if (!(ovs_scan_len(s, &n, IPV6_SCAN_FMT, ipv6_s)
5432 || ovs_scan_len(s, &n, "["IPV6_SCAN_FMT"]", ipv6_s))
5433 || inet_pton(AF_INET6, ipv6_s, &on->range.addr.ipv6.max) != 1
5434 || memcmp(&on->range.addr.ipv6.max, &on->range.addr.ipv6.min,
5435 sizeof on->range.addr.ipv6.max) < 0) {
5436 goto error;
5437 }
5438 }
5439 }
5440 if (on->range_af != AF_UNSPEC && s[n] == ':') {
5441 n++;
5442 if (!ovs_scan_len(s, &n, "%"SCNu16, &on->range.proto.min)) {
5443 goto error;
5444 }
5445 if (s[n] == '-') {
5446 n++;
5447 if (!ovs_scan_len(s, &n, "%"SCNu16, &on->range.proto.max)
5448 || on->range.proto.max < on->range.proto.min) {
5449 goto error;
5450 }
5451 }
5452 }
5453 if (strlen(s) != n) {
5454 return xasprintf("garbage (%s) after nat range \"%s\" (pos: %d)",
5455 &s[n], s, n);
5456 }
5457 return NULL;
5458error:
5459 return xasprintf("invalid nat range \"%s\"", s);
5460}
5461
5462
5463/* Parses 'arg' as the argument to a "nat" action, and appends such an
5464 * action to 'ofpacts'.
5465 *
5466 * Returns NULL if successful, otherwise a malloc()'d string describing the
5467 * error. The caller is responsible for freeing the returned string. */
5468static char * OVS_WARN_UNUSED_RESULT
5469parse_NAT(char *arg, struct ofpbuf *ofpacts,
5470 enum ofputil_protocol *usable_protocols OVS_UNUSED)
5471{
5472 struct ofpact_nat *on = ofpact_put_NAT(ofpacts);
5473 char *key, *value;
5474
5475 on->flags = 0;
5476 on->range_af = AF_UNSPEC;
5477
5478 while (ofputil_parse_key_value(&arg, &key, &value)) {
5479 char *error = NULL;
5480
5481 if (!strcmp(key, "src")) {
5482 on->flags |= NX_NAT_F_SRC;
5483 error = str_to_nat_range(value, on);
5484 } else if (!strcmp(key, "dst")) {
5485 on->flags |= NX_NAT_F_DST;
5486 error = str_to_nat_range(value, on);
5487 } else if (!strcmp(key, "persistent")) {
5488 on->flags |= NX_NAT_F_PERSISTENT;
5489 } else if (!strcmp(key, "hash")) {
5490 on->flags |= NX_NAT_F_PROTO_HASH;
5491 } else if (!strcmp(key, "random")) {
5492 on->flags |= NX_NAT_F_PROTO_RANDOM;
5493 } else {
5494 error = xasprintf("invalid key \"%s\" in \"nat\" argument",
5495 key);
5496 }
5497 if (error) {
5498 return error;
5499 }
5500 }
5501 if (on->flags & NX_NAT_F_SRC && on->flags & NX_NAT_F_DST) {
5502 return xasprintf("May only specify one of \"snat\" or \"dnat\".");
5503 }
5504 if (!(on->flags & NX_NAT_F_SRC || on->flags & NX_NAT_F_DST)) {
5505 if (on->flags) {
5506 return xasprintf("Flags allowed only with \"snat\" or \"dnat\".");
5507 }
5508 if (on->range_af != AF_UNSPEC) {
5509 return xasprintf("Range allowed only with \"snat\" or \"dnat\".");
5510 }
5511 }
5512 return NULL;
5513}
5514
d4abaff5 5515\f
c2d936a4
BP
5516/* Meter instruction. */
5517
5518static void
5519encode_METER(const struct ofpact_meter *meter,
5520 enum ofp_version ofp_version, struct ofpbuf *out)
5521{
5522 if (ofp_version >= OFP13_VERSION) {
5523 instruction_put_OFPIT13_METER(out)->meter_id = htonl(meter->meter_id);
5524 }
5525}
5526
cab50449 5527static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
5528parse_METER(char *arg, struct ofpbuf *ofpacts,
5529 enum ofputil_protocol *usable_protocols)
5530{
5531 *usable_protocols &= OFPUTIL_P_OF13_UP;
5532 return str_to_u32(arg, &ofpact_put_METER(ofpacts)->meter_id);
5533}
5534
5535static void
5536format_METER(const struct ofpact_meter *a, struct ds *s)
5537{
b1c5bf1f
QM
5538 ds_put_format(s, "%smeter:%s%"PRIu32,
5539 colors.param, colors.end, a->meter_id);
c2d936a4
BP
5540}
5541\f
5542/* Clear-Actions instruction. */
5543
5544static void
5545encode_CLEAR_ACTIONS(const struct ofpact_null *null OVS_UNUSED,
5546 enum ofp_version ofp_version OVS_UNUSED,
5547 struct ofpbuf *out OVS_UNUSED)
5548{
5549 if (ofp_version > OFP10_VERSION) {
5550 instruction_put_OFPIT11_CLEAR_ACTIONS(out);
5551 }
5552}
5553
cab50449 5554static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
5555parse_CLEAR_ACTIONS(char *arg OVS_UNUSED, struct ofpbuf *ofpacts,
5556 enum ofputil_protocol *usable_protocols OVS_UNUSED)
5557{
5558 ofpact_put_CLEAR_ACTIONS(ofpacts);
5559 return NULL;
5560}
5561
5562static void
5563format_CLEAR_ACTIONS(const struct ofpact_null *a OVS_UNUSED, struct ds *s)
5564{
b1c5bf1f 5565 ds_put_format(s, "%sclear_actions%s", colors.value, colors.end);
c2d936a4
BP
5566}
5567\f
5568/* Write-Actions instruction. */
5569
5570static void
5571encode_WRITE_ACTIONS(const struct ofpact_nest *actions,
5572 enum ofp_version ofp_version, struct ofpbuf *out)
5573{
5574 if (ofp_version > OFP10_VERSION) {
6fd6ed71 5575 const size_t ofs = out->size;
c2d936a4
BP
5576
5577 instruction_put_OFPIT11_WRITE_ACTIONS(out);
5578 ofpacts_put_openflow_actions(actions->actions,
5579 ofpact_nest_get_action_len(actions),
5580 out, ofp_version);
5581 ofpacts_update_instruction_actions(out, ofs);
5582 }
5583}
5584
cab50449 5585static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
5586parse_WRITE_ACTIONS(char *arg, struct ofpbuf *ofpacts,
5587 enum ofputil_protocol *usable_protocols)
5588{
d824b5b7 5589 size_t ofs = ofpacts_pull(ofpacts);
c2d936a4
BP
5590 struct ofpact_nest *on;
5591 char *error;
c2d936a4
BP
5592
5593 /* Add a Write-Actions instruction and then pull it off. */
5594 ofpact_put(ofpacts, OFPACT_WRITE_ACTIONS, sizeof *on);
5595 ofpbuf_pull(ofpacts, sizeof *on);
5596
5597 /* Parse nested actions.
5598 *
5599 * We pulled off "write-actions" and the previous actions because the
5600 * OFPACT_WRITE_ACTIONS is only partially constructed: its length is such
5601 * that it doesn't actually include the nested actions. That means that
5602 * ofpacts_parse() would reject them as being part of an Apply-Actions that
5603 * follows a Write-Actions, which is an invalid order. */
d824b5b7
JS
5604 error = ofpacts_parse(arg, ofpacts, usable_protocols, false,
5605 OFPACT_WRITE_ACTIONS);
c2d936a4
BP
5606
5607 /* Put the Write-Actions back on and update its length. */
5608 on = ofpbuf_push_uninit(ofpacts, sizeof *on);
6fd6ed71 5609 on->ofpact.len = ofpacts->size;
c2d936a4
BP
5610
5611 /* Put any previous actions or instructions back on. */
5612 ofpbuf_push_uninit(ofpacts, ofs);
5613
5614 return error;
5615}
5616
5617static void
5618format_WRITE_ACTIONS(const struct ofpact_nest *a, struct ds *s)
5619{
b1c5bf1f 5620 ds_put_format(s, "%swrite_actions(%s", colors.paren, colors.end);
c2d936a4 5621 ofpacts_format(a->actions, ofpact_nest_get_action_len(a), s);
b1c5bf1f 5622 ds_put_format(s, "%s)%s", colors.paren, colors.end);
c2d936a4
BP
5623}
5624\f
5625/* Action structure for NXAST_WRITE_METADATA.
5626 *
5627 * Modifies the 'mask' bits of the metadata value. */
5628struct nx_action_write_metadata {
5629 ovs_be16 type; /* OFPAT_VENDOR. */
5630 ovs_be16 len; /* Length is 32. */
5631 ovs_be32 vendor; /* NX_VENDOR_ID. */
5632 ovs_be16 subtype; /* NXAST_WRITE_METADATA. */
5633 uint8_t zeros[6]; /* Must be zero. */
5634 ovs_be64 metadata; /* Metadata register. */
5635 ovs_be64 mask; /* Metadata mask. */
5636};
5637OFP_ASSERT(sizeof(struct nx_action_write_metadata) == 32);
5638
5639static enum ofperr
5640decode_NXAST_RAW_WRITE_METADATA(const struct nx_action_write_metadata *nawm,
f3cd3ac7 5641 enum ofp_version ofp_version OVS_UNUSED,
c2d936a4
BP
5642 struct ofpbuf *out)
5643{
5644 struct ofpact_metadata *om;
5645
5646 if (!is_all_zeros(nawm->zeros, sizeof nawm->zeros)) {
5647 return OFPERR_NXBRC_MUST_BE_ZERO;
5648 }
5649
5650 om = ofpact_put_WRITE_METADATA(out);
5651 om->metadata = nawm->metadata;
5652 om->mask = nawm->mask;
5653
5654 return 0;
5655}
5656
5657static void
5658encode_WRITE_METADATA(const struct ofpact_metadata *metadata,
5659 enum ofp_version ofp_version, struct ofpbuf *out)
5660{
5661 if (ofp_version == OFP10_VERSION) {
5662 struct nx_action_write_metadata *nawm;
5663
5664 nawm = put_NXAST_WRITE_METADATA(out);
5665 nawm->metadata = metadata->metadata;
5666 nawm->mask = metadata->mask;
5667 } else {
5668 struct ofp11_instruction_write_metadata *oiwm;
5669
5670 oiwm = instruction_put_OFPIT11_WRITE_METADATA(out);
5671 oiwm->metadata = metadata->metadata;
5672 oiwm->metadata_mask = metadata->mask;
5673 }
5674}
5675
cab50449 5676static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
5677parse_WRITE_METADATA(char *arg, struct ofpbuf *ofpacts,
5678 enum ofputil_protocol *usable_protocols)
5679{
5680 struct ofpact_metadata *om;
5681 char *mask = strchr(arg, '/');
5682
5683 *usable_protocols &= OFPUTIL_P_NXM_OF11_UP;
5684
5685 om = ofpact_put_WRITE_METADATA(ofpacts);
5686 if (mask) {
5687 char *error;
5688
5689 *mask = '\0';
5690 error = str_to_be64(mask + 1, &om->mask);
5691 if (error) {
5692 return error;
5693 }
5694 } else {
5695 om->mask = OVS_BE64_MAX;
5696 }
5697
5698 return str_to_be64(arg, &om->metadata);
5699}
5700
5701static void
5702format_WRITE_METADATA(const struct ofpact_metadata *a, struct ds *s)
5703{
b1c5bf1f
QM
5704 ds_put_format(s, "%swrite_metadata:%s%#"PRIx64,
5705 colors.param, colors.end, ntohll(a->metadata));
c2d936a4
BP
5706 if (a->mask != OVS_BE64_MAX) {
5707 ds_put_format(s, "/%#"PRIx64, ntohll(a->mask));
5708 }
4cceacb9 5709}
f25d0cf3 5710\f
c2d936a4 5711/* Goto-Table instruction. */
f25d0cf3
BP
5712
5713static void
c2d936a4
BP
5714encode_GOTO_TABLE(const struct ofpact_goto_table *goto_table,
5715 enum ofp_version ofp_version, struct ofpbuf *out)
f25d0cf3 5716{
c2d936a4
BP
5717 if (ofp_version == OFP10_VERSION) {
5718 struct nx_action_resubmit *nar;
f25d0cf3 5719
c2d936a4
BP
5720 nar = put_NXAST_RESUBMIT_TABLE(out);
5721 nar->table = goto_table->table_id;
5722 nar->in_port = htons(ofp_to_u16(OFPP_IN_PORT));
5723 } else {
5724 struct ofp11_instruction_goto_table *oigt;
5725
5726 oigt = instruction_put_OFPIT11_GOTO_TABLE(out);
5727 oigt->table_id = goto_table->table_id;
5728 memset(oigt->pad, 0, sizeof oigt->pad);
5729 }
5730}
5731
cab50449 5732static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
5733parse_GOTO_TABLE(char *arg, struct ofpbuf *ofpacts,
5734 enum ofputil_protocol *usable_protocols OVS_UNUSED)
5735{
5736 struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
5737 char *table_s = strsep(&arg, ",");
5738 if (!table_s || !table_s[0]) {
5739 return xstrdup("instruction goto-table needs table id");
5740 }
5741 return str_to_u8(table_s, "table", &ogt->table_id);
5742}
5743
5744static void
5745format_GOTO_TABLE(const struct ofpact_goto_table *a, struct ds *s)
5746{
b1c5bf1f
QM
5747 ds_put_format(s, "%sgoto_table:%s%"PRIu8,
5748 colors.param, colors.end, a->table_id);
c2d936a4
BP
5749}
5750\f
5751static void
5ad4b3f8 5752log_bad_action(const struct ofp_action_header *actions, size_t actions_len,
c2d936a4
BP
5753 const struct ofp_action_header *bad_action, enum ofperr error)
5754{
5755 if (!VLOG_DROP_WARN(&rl)) {
5756 struct ds s;
5757
5758 ds_init(&s);
5ad4b3f8 5759 ds_put_hex_dump(&s, actions, actions_len, 0, false);
c2d936a4
BP
5760 VLOG_WARN("bad action at offset %#"PRIxPTR" (%s):\n%s",
5761 (char *)bad_action - (char *)actions,
5762 ofperr_get_name(error), ds_cstr(&s));
5763 ds_destroy(&s);
5764 }
5765}
5766
5767static enum ofperr
5768ofpacts_decode(const void *actions, size_t actions_len,
5769 enum ofp_version ofp_version, struct ofpbuf *ofpacts)
5770{
0a2869d5 5771 struct ofpbuf openflow = ofpbuf_const_initializer(actions, actions_len);
6fd6ed71
PS
5772 while (openflow.size) {
5773 const struct ofp_action_header *action = openflow.data;
c2d936a4
BP
5774 enum ofp_raw_action_type raw;
5775 enum ofperr error;
5776 uint64_t arg;
5777
5778 error = ofpact_pull_raw(&openflow, ofp_version, &raw, &arg);
5779 if (!error) {
f3cd3ac7 5780 error = ofpact_decode(action, raw, ofp_version, arg, ofpacts);
c2d936a4
BP
5781 }
5782
5783 if (error) {
5ad4b3f8 5784 log_bad_action(actions, actions_len, action, error);
c2d936a4
BP
5785 return error;
5786 }
5787 }
c2d936a4
BP
5788 return 0;
5789}
5790
5791static enum ofperr
5792ofpacts_pull_openflow_actions__(struct ofpbuf *openflow,
5793 unsigned int actions_len,
5794 enum ofp_version version,
5795 uint32_t allowed_ovsinsts,
d824b5b7
JS
5796 struct ofpbuf *ofpacts,
5797 enum ofpact_type outer_action)
c2d936a4
BP
5798{
5799 const struct ofp_action_header *actions;
9abca1e5 5800 size_t orig_size = ofpacts->size;
c2d936a4
BP
5801 enum ofperr error;
5802
c2d936a4
BP
5803 if (actions_len % OFP_ACTION_ALIGN != 0) {
5804 VLOG_WARN_RL(&rl, "OpenFlow message actions length %u is not a "
5805 "multiple of %d", actions_len, OFP_ACTION_ALIGN);
5806 return OFPERR_OFPBRC_BAD_LEN;
5807 }
5808
5809 actions = ofpbuf_try_pull(openflow, actions_len);
5810 if (actions == NULL) {
5811 VLOG_WARN_RL(&rl, "OpenFlow message actions length %u exceeds "
5812 "remaining message length (%"PRIu32")",
6fd6ed71 5813 actions_len, openflow->size);
c2d936a4
BP
5814 return OFPERR_OFPBRC_BAD_LEN;
5815 }
5816
5817 error = ofpacts_decode(actions, actions_len, version, ofpacts);
5818 if (error) {
9abca1e5 5819 ofpacts->size = orig_size;
c2d936a4
BP
5820 return error;
5821 }
5822
d824b5b7
JS
5823 error = ofpacts_verify(ofpacts->data, ofpacts->size, allowed_ovsinsts,
5824 outer_action);
c2d936a4 5825 if (error) {
9abca1e5 5826 ofpacts->size = orig_size;
c2d936a4
BP
5827 }
5828 return error;
5829}
5830
9abca1e5
BP
5831/* Attempts to convert 'actions_len' bytes of OpenFlow actions from the front
5832 * of 'openflow' into ofpacts. On success, appends the converted actions to
5833 * 'ofpacts'; on failure, 'ofpacts' is unchanged (but might be reallocated) .
c2d936a4
BP
5834 * Returns 0 if successful, otherwise an OpenFlow error.
5835 *
5836 * Actions are processed according to their OpenFlow version which
5837 * is provided in the 'version' parameter.
5838 *
5839 * In most places in OpenFlow, actions appear encapsulated in instructions, so
5840 * you should call ofpacts_pull_openflow_instructions() instead of this
5841 * function.
5842 *
5843 * The parsed actions are valid generically, but they may not be valid in a
5844 * specific context. For example, port numbers up to OFPP_MAX are valid
5845 * generically, but specific datapaths may only support port numbers in a
5846 * smaller range. Use ofpacts_check() to additional check whether actions are
5847 * valid in a specific context. */
5848enum ofperr
5849ofpacts_pull_openflow_actions(struct ofpbuf *openflow,
5850 unsigned int actions_len,
5851 enum ofp_version version,
5852 struct ofpbuf *ofpacts)
5853{
5854 return ofpacts_pull_openflow_actions__(openflow, actions_len, version,
5855 1u << OVSINST_OFPIT11_APPLY_ACTIONS,
d824b5b7 5856 ofpacts, 0);
c2d936a4
BP
5857}
5858\f
5859/* OpenFlow 1.1 actions. */
5860
5861
5862/* True if an action sets the value of a field
5863 * in a way that is compatibile with the action set.
1b0ee636 5864 * The field can be set via either a set or a move action.
c2d936a4
BP
5865 * False otherwise. */
5866static bool
1b0ee636 5867ofpact_is_set_or_move_action(const struct ofpact *a)
c2d936a4
BP
5868{
5869 switch (a->type) {
5870 case OFPACT_SET_FIELD:
1b0ee636 5871 case OFPACT_REG_MOVE:
c2d936a4
BP
5872 case OFPACT_SET_ETH_DST:
5873 case OFPACT_SET_ETH_SRC:
5874 case OFPACT_SET_IP_DSCP:
5875 case OFPACT_SET_IP_ECN:
5876 case OFPACT_SET_IP_TTL:
5877 case OFPACT_SET_IPV4_DST:
5878 case OFPACT_SET_IPV4_SRC:
5879 case OFPACT_SET_L4_DST_PORT:
5880 case OFPACT_SET_L4_SRC_PORT:
5881 case OFPACT_SET_MPLS_LABEL:
5882 case OFPACT_SET_MPLS_TC:
5883 case OFPACT_SET_MPLS_TTL:
5884 case OFPACT_SET_QUEUE:
5885 case OFPACT_SET_TUNNEL:
5886 case OFPACT_SET_VLAN_PCP:
5887 case OFPACT_SET_VLAN_VID:
5888 return true;
5889 case OFPACT_BUNDLE:
5890 case OFPACT_CLEAR_ACTIONS:
07659514 5891 case OFPACT_CT:
9ac0aada 5892 case OFPACT_NAT:
c2d936a4
BP
5893 case OFPACT_CONTROLLER:
5894 case OFPACT_DEC_MPLS_TTL:
5895 case OFPACT_DEC_TTL:
5896 case OFPACT_ENQUEUE:
5897 case OFPACT_EXIT:
e672ff9b 5898 case OFPACT_UNROLL_XLATE:
c2d936a4
BP
5899 case OFPACT_FIN_TIMEOUT:
5900 case OFPACT_GOTO_TABLE:
5901 case OFPACT_GROUP:
5902 case OFPACT_LEARN:
18080541 5903 case OFPACT_CONJUNCTION:
c2d936a4
BP
5904 case OFPACT_METER:
5905 case OFPACT_MULTIPATH:
5906 case OFPACT_NOTE:
5907 case OFPACT_OUTPUT:
5908 case OFPACT_OUTPUT_REG:
5909 case OFPACT_POP_MPLS:
5910 case OFPACT_POP_QUEUE:
5911 case OFPACT_PUSH_MPLS:
5912 case OFPACT_PUSH_VLAN:
c2d936a4
BP
5913 case OFPACT_RESUBMIT:
5914 case OFPACT_SAMPLE:
5915 case OFPACT_STACK_POP:
5916 case OFPACT_STACK_PUSH:
5917 case OFPACT_STRIP_VLAN:
5918 case OFPACT_WRITE_ACTIONS:
5919 case OFPACT_WRITE_METADATA:
d4abaff5 5920 case OFPACT_DEBUG_RECIRC:
c2d936a4
BP
5921 return false;
5922 default:
5923 OVS_NOT_REACHED();
5924 }
5925}
5926
5927/* True if an action is allowed in the action set.
5928 * False otherwise. */
5929static bool
5930ofpact_is_allowed_in_actions_set(const struct ofpact *a)
5931{
5932 switch (a->type) {
5933 case OFPACT_DEC_MPLS_TTL:
5934 case OFPACT_DEC_TTL:
5935 case OFPACT_GROUP:
5936 case OFPACT_OUTPUT:
5937 case OFPACT_POP_MPLS:
5938 case OFPACT_PUSH_MPLS:
5939 case OFPACT_PUSH_VLAN:
1b0ee636 5940 case OFPACT_REG_MOVE:
c2d936a4
BP
5941 case OFPACT_SET_FIELD:
5942 case OFPACT_SET_ETH_DST:
5943 case OFPACT_SET_ETH_SRC:
5944 case OFPACT_SET_IP_DSCP:
5945 case OFPACT_SET_IP_ECN:
5946 case OFPACT_SET_IP_TTL:
5947 case OFPACT_SET_IPV4_DST:
5948 case OFPACT_SET_IPV4_SRC:
5949 case OFPACT_SET_L4_DST_PORT:
5950 case OFPACT_SET_L4_SRC_PORT:
5951 case OFPACT_SET_MPLS_LABEL:
5952 case OFPACT_SET_MPLS_TC:
5953 case OFPACT_SET_MPLS_TTL:
5954 case OFPACT_SET_QUEUE:
5955 case OFPACT_SET_TUNNEL:
5956 case OFPACT_SET_VLAN_PCP:
5957 case OFPACT_SET_VLAN_VID:
5958 case OFPACT_STRIP_VLAN:
5959 return true;
5960
5961 /* In general these actions are excluded because they are not part of
5962 * the OpenFlow specification nor map to actions that are defined in
5963 * the specification. Thus the order in which they should be applied
5964 * in the action set is undefined. */
5965 case OFPACT_BUNDLE:
5966 case OFPACT_CONTROLLER:
07659514 5967 case OFPACT_CT:
9ac0aada 5968 case OFPACT_NAT:
c2d936a4
BP
5969 case OFPACT_ENQUEUE:
5970 case OFPACT_EXIT:
e672ff9b 5971 case OFPACT_UNROLL_XLATE:
c2d936a4
BP
5972 case OFPACT_FIN_TIMEOUT:
5973 case OFPACT_LEARN:
18080541 5974 case OFPACT_CONJUNCTION:
c2d936a4
BP
5975 case OFPACT_MULTIPATH:
5976 case OFPACT_NOTE:
5977 case OFPACT_OUTPUT_REG:
5978 case OFPACT_POP_QUEUE:
c2d936a4
BP
5979 case OFPACT_RESUBMIT:
5980 case OFPACT_SAMPLE:
5981 case OFPACT_STACK_POP:
5982 case OFPACT_STACK_PUSH:
d4abaff5 5983 case OFPACT_DEBUG_RECIRC:
c2d936a4
BP
5984
5985 /* The action set may only include actions and thus
5986 * may not include any instructions */
5987 case OFPACT_CLEAR_ACTIONS:
5988 case OFPACT_GOTO_TABLE:
5989 case OFPACT_METER:
5990 case OFPACT_WRITE_ACTIONS:
5991 case OFPACT_WRITE_METADATA:
5992 return false;
5993 default:
5994 OVS_NOT_REACHED();
5995 }
f25d0cf3
BP
5996}
5997
c2d936a4 5998/* Append ofpact 'a' onto the tail of 'out' */
f25d0cf3 5999static void
c2d936a4 6000ofpact_copy(struct ofpbuf *out, const struct ofpact *a)
f25d0cf3 6001{
c2d936a4 6002 ofpbuf_put(out, a, OFPACT_ALIGN(a->len));
f25d0cf3
BP
6003}
6004
c2d936a4
BP
6005/* Copies the last ofpact whose type is 'filter' from 'in' to 'out'. */
6006static bool
6007ofpacts_copy_last(struct ofpbuf *out, const struct ofpbuf *in,
6008 enum ofpact_type filter)
f25d0cf3 6009{
c2d936a4
BP
6010 const struct ofpact *target;
6011 const struct ofpact *a;
f25d0cf3 6012
c2d936a4 6013 target = NULL;
6fd6ed71 6014 OFPACT_FOR_EACH (a, in->data, in->size) {
c2d936a4
BP
6015 if (a->type == filter) {
6016 target = a;
6017 }
6018 }
6019 if (target) {
6020 ofpact_copy(out, target);
f25d0cf3 6021 }
c2d936a4 6022 return target != NULL;
f25d0cf3
BP
6023}
6024
c2d936a4
BP
6025/* Append all ofpacts, for which 'filter' returns true, from 'in' to 'out'.
6026 * The order of appended ofpacts is preserved between 'in' and 'out' */
4cceacb9 6027static void
c2d936a4
BP
6028ofpacts_copy_all(struct ofpbuf *out, const struct ofpbuf *in,
6029 bool (*filter)(const struct ofpact *))
4cceacb9 6030{
c2d936a4 6031 const struct ofpact *a;
4cceacb9 6032
6fd6ed71 6033 OFPACT_FOR_EACH (a, in->data, in->size) {
c2d936a4
BP
6034 if (filter(a)) {
6035 ofpact_copy(out, a);
6036 }
6037 }
4cceacb9
JS
6038}
6039
c2d936a4
BP
6040/* Reads 'action_set', which contains ofpacts accumulated by
6041 * OFPACT_WRITE_ACTIONS instructions, and writes equivalent actions to be
6042 * executed directly into 'action_list'. (These names correspond to the
6043 * "Action Set" and "Action List" terms used in OpenFlow 1.1+.)
6044 *
6045 * In general this involves appending the last instance of each action that is
e672ff9b 6046 * admissible in the action set in the order described in the OpenFlow
c2d936a4
BP
6047 * specification.
6048 *
6049 * Exceptions:
6050 * + output action is only appended if no group action was present in 'in'.
6051 * + As a simplification all set actions are copied in the order the are
6052 * provided in 'in' as many set actions applied to a field has the same
6053 * affect as only applying the last action that sets a field and
6054 * duplicates are removed by do_xlate_actions().
6055 * This has an unwanted side-effect of compsoting multiple
6056 * LOAD_REG actions that touch different regions of the same field. */
6057void
6058ofpacts_execute_action_set(struct ofpbuf *action_list,
6059 const struct ofpbuf *action_set)
f25d0cf3 6060{
c2d936a4
BP
6061 /* The OpenFlow spec "Action Set" section specifies this order. */
6062 ofpacts_copy_last(action_list, action_set, OFPACT_STRIP_VLAN);
6063 ofpacts_copy_last(action_list, action_set, OFPACT_POP_MPLS);
6064 ofpacts_copy_last(action_list, action_set, OFPACT_PUSH_MPLS);
6065 ofpacts_copy_last(action_list, action_set, OFPACT_PUSH_VLAN);
6066 ofpacts_copy_last(action_list, action_set, OFPACT_DEC_TTL);
6067 ofpacts_copy_last(action_list, action_set, OFPACT_DEC_MPLS_TTL);
1b0ee636 6068 ofpacts_copy_all(action_list, action_set, ofpact_is_set_or_move_action);
c2d936a4 6069 ofpacts_copy_last(action_list, action_set, OFPACT_SET_QUEUE);
f25d0cf3 6070
c2d936a4
BP
6071 /* If both OFPACT_GROUP and OFPACT_OUTPUT are present, OpenFlow says that
6072 * we should execute only OFPACT_GROUP.
6073 *
6074 * If neither OFPACT_GROUP nor OFPACT_OUTPUT is present, then we can drop
6075 * all the actions because there's no point in modifying a packet that will
6076 * not be sent anywhere. */
6077 if (!ofpacts_copy_last(action_list, action_set, OFPACT_GROUP) &&
2e34a6a3
SS
6078 !ofpacts_copy_last(action_list, action_set, OFPACT_OUTPUT) &&
6079 !ofpacts_copy_last(action_list, action_set, OFPACT_RESUBMIT)) {
c2d936a4 6080 ofpbuf_clear(action_list);
f25d0cf3 6081 }
f25d0cf3
BP
6082}
6083
f25d0cf3 6084
c2d936a4
BP
6085static enum ofperr
6086ofpacts_decode_for_action_set(const struct ofp_action_header *in,
6087 size_t n_in, enum ofp_version version,
6088 struct ofpbuf *out)
c2d967a5 6089{
c2d936a4
BP
6090 enum ofperr error;
6091 struct ofpact *a;
6fd6ed71 6092 size_t start = out->size;
c2d967a5 6093
c2d936a4 6094 error = ofpacts_decode(in, n_in, version, out);
c2d967a5 6095
c2d936a4
BP
6096 if (error) {
6097 return error;
6098 }
6099
6fd6ed71 6100 OFPACT_FOR_EACH (a, ofpact_end(out->data, start), out->size - start) {
c2d936a4
BP
6101 if (!ofpact_is_allowed_in_actions_set(a)) {
6102 VLOG_WARN_RL(&rl, "disallowed action in action set");
6103 return OFPERR_OFPBAC_BAD_TYPE;
c2d967a5
MM
6104 }
6105 }
c2d936a4
BP
6106
6107 return 0;
c2d967a5 6108}
c2d936a4
BP
6109\f
6110/* OpenFlow 1.1 instructions. */
c2d967a5 6111
c2d936a4
BP
6112struct instruction_type_info {
6113 enum ovs_instruction_type type;
6114 const char *name;
6115};
6116
6117static const struct instruction_type_info inst_info[] = {
6118#define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) {OVSINST_##ENUM, NAME},
6119OVS_INSTRUCTIONS
6120#undef DEFINE_INST
6121};
6122
6123const char *
6124ovs_instruction_name_from_type(enum ovs_instruction_type type)
f25d0cf3 6125{
c2d936a4 6126 return inst_info[type].name;
f25d0cf3
BP
6127}
6128
c2d936a4
BP
6129int
6130ovs_instruction_type_from_name(const char *name)
29089a54 6131{
c2d936a4
BP
6132 const struct instruction_type_info *p;
6133 for (p = inst_info; p < &inst_info[ARRAY_SIZE(inst_info)]; p++) {
6134 if (!strcasecmp(name, p->name)) {
6135 return p->type;
6136 }
6137 }
6138 return -1;
29089a54
RL
6139}
6140
c2d936a4
BP
6141enum ovs_instruction_type
6142ovs_instruction_type_from_ofpact_type(enum ofpact_type type)
f25d0cf3 6143{
c2d936a4
BP
6144 switch (type) {
6145 case OFPACT_METER:
6146 return OVSINST_OFPIT13_METER;
6147 case OFPACT_CLEAR_ACTIONS:
6148 return OVSINST_OFPIT11_CLEAR_ACTIONS;
6149 case OFPACT_WRITE_ACTIONS:
6150 return OVSINST_OFPIT11_WRITE_ACTIONS;
6151 case OFPACT_WRITE_METADATA:
6152 return OVSINST_OFPIT11_WRITE_METADATA;
6153 case OFPACT_GOTO_TABLE:
6154 return OVSINST_OFPIT11_GOTO_TABLE;
6155 case OFPACT_OUTPUT:
6156 case OFPACT_GROUP:
f25d0cf3 6157 case OFPACT_CONTROLLER:
c2d936a4 6158 case OFPACT_ENQUEUE:
f25d0cf3 6159 case OFPACT_OUTPUT_REG:
f25d0cf3 6160 case OFPACT_BUNDLE:
c2d936a4
BP
6161 case OFPACT_SET_VLAN_VID:
6162 case OFPACT_SET_VLAN_PCP:
6163 case OFPACT_STRIP_VLAN:
6164 case OFPACT_PUSH_VLAN:
6165 case OFPACT_SET_ETH_SRC:
6166 case OFPACT_SET_ETH_DST:
6167 case OFPACT_SET_IPV4_SRC:
6168 case OFPACT_SET_IPV4_DST:
6169 case OFPACT_SET_IP_DSCP:
6170 case OFPACT_SET_IP_ECN:
6171 case OFPACT_SET_IP_TTL:
6172 case OFPACT_SET_L4_SRC_PORT:
6173 case OFPACT_SET_L4_DST_PORT:
f25d0cf3 6174 case OFPACT_REG_MOVE:
c2d936a4 6175 case OFPACT_SET_FIELD:
bd85dac1 6176 case OFPACT_STACK_PUSH:
bd85dac1 6177 case OFPACT_STACK_POP:
f25d0cf3 6178 case OFPACT_DEC_TTL:
097d4939 6179 case OFPACT_SET_MPLS_LABEL:
097d4939 6180 case OFPACT_SET_MPLS_TC:
0f3f3c3d 6181 case OFPACT_SET_MPLS_TTL:
b676167a 6182 case OFPACT_DEC_MPLS_TTL:
c2d936a4
BP
6183 case OFPACT_PUSH_MPLS:
6184 case OFPACT_POP_MPLS:
f25d0cf3 6185 case OFPACT_SET_TUNNEL:
c2d936a4
BP
6186 case OFPACT_SET_QUEUE:
6187 case OFPACT_POP_QUEUE:
6188 case OFPACT_FIN_TIMEOUT:
6189 case OFPACT_RESUBMIT:
6190 case OFPACT_LEARN:
18080541 6191 case OFPACT_CONJUNCTION:
c2d936a4
BP
6192 case OFPACT_MULTIPATH:
6193 case OFPACT_NOTE:
6194 case OFPACT_EXIT:
e672ff9b 6195 case OFPACT_UNROLL_XLATE:
c2d936a4 6196 case OFPACT_SAMPLE:
d4abaff5 6197 case OFPACT_DEBUG_RECIRC:
07659514 6198 case OFPACT_CT:
9ac0aada 6199 case OFPACT_NAT:
c2d936a4
BP
6200 default:
6201 return OVSINST_OFPIT11_APPLY_ACTIONS;
6202 }
6203}
6204
6205enum ofperr
6206ovs_instruction_type_from_inst_type(enum ovs_instruction_type *instruction_type,
6207 const uint16_t inst_type)
6208{
6209 switch (inst_type) {
6210
6211#define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
6212 case ENUM: \
6213 *instruction_type = OVSINST_##ENUM; \
6214 return 0;
6215OVS_INSTRUCTIONS
6216#undef DEFINE_INST
6217
6218 default:
6219 return OFPERR_OFPBIC_UNKNOWN_INST;
6220 }
6221}
6222
6223/* Two-way translation between OVS's internal "OVSINST_*" representation of
6224 * instructions and the "OFPIT_*" representation used in OpenFlow. */
6225struct ovsinst_map {
6226 enum ovs_instruction_type ovsinst; /* Internal name for instruction. */
6227 int ofpit; /* OFPIT_* number from OpenFlow spec. */
6228};
6229
6230static const struct ovsinst_map *
6231get_ovsinst_map(enum ofp_version version)
6232{
6233 /* OpenFlow 1.1 and 1.2 instructions. */
6234 static const struct ovsinst_map of11[] = {
6235 { OVSINST_OFPIT11_GOTO_TABLE, 1 },
6236 { OVSINST_OFPIT11_WRITE_METADATA, 2 },
6237 { OVSINST_OFPIT11_WRITE_ACTIONS, 3 },
6238 { OVSINST_OFPIT11_APPLY_ACTIONS, 4 },
6239 { OVSINST_OFPIT11_CLEAR_ACTIONS, 5 },
6240 { 0, -1 },
6241 };
f25d0cf3 6242
c2d936a4
BP
6243 /* OpenFlow 1.3+ instructions. */
6244 static const struct ovsinst_map of13[] = {
6245 { OVSINST_OFPIT11_GOTO_TABLE, 1 },
6246 { OVSINST_OFPIT11_WRITE_METADATA, 2 },
6247 { OVSINST_OFPIT11_WRITE_ACTIONS, 3 },
6248 { OVSINST_OFPIT11_APPLY_ACTIONS, 4 },
6249 { OVSINST_OFPIT11_CLEAR_ACTIONS, 5 },
6250 { OVSINST_OFPIT13_METER, 6 },
6251 { 0, -1 },
6252 };
4cceacb9 6253
c2d936a4
BP
6254 return version < OFP13_VERSION ? of11 : of13;
6255}
f25d0cf3 6256
c2d936a4
BP
6257/* Converts 'ovsinst_bitmap', a bitmap whose bits correspond to OVSINST_*
6258 * values, into a bitmap of instructions suitable for OpenFlow 'version'
6259 * (OFP11_VERSION or later), and returns the result. */
6260ovs_be32
6261ovsinst_bitmap_to_openflow(uint32_t ovsinst_bitmap, enum ofp_version version)
6262{
6263 uint32_t ofpit_bitmap = 0;
6264 const struct ovsinst_map *x;
f25d0cf3 6265
c2d936a4
BP
6266 for (x = get_ovsinst_map(version); x->ofpit >= 0; x++) {
6267 if (ovsinst_bitmap & (1u << x->ovsinst)) {
6268 ofpit_bitmap |= 1u << x->ofpit;
6269 }
6270 }
6271 return htonl(ofpit_bitmap);
6272}
f25d0cf3 6273
c2d936a4
BP
6274/* Converts 'ofpit_bitmap', a bitmap of instructions from an OpenFlow message
6275 * with the given 'version' (OFP11_VERSION or later) into a bitmap whose bits
6276 * correspond to OVSINST_* values, and returns the result. */
6277uint32_t
6278ovsinst_bitmap_from_openflow(ovs_be32 ofpit_bitmap, enum ofp_version version)
6279{
6280 uint32_t ovsinst_bitmap = 0;
6281 const struct ovsinst_map *x;
f25d0cf3 6282
c2d936a4
BP
6283 for (x = get_ovsinst_map(version); x->ofpit >= 0; x++) {
6284 if (ofpit_bitmap & htonl(1u << x->ofpit)) {
6285 ovsinst_bitmap |= 1u << x->ovsinst;
6286 }
6287 }
6288 return ovsinst_bitmap;
6289}
f25d0cf3 6290
c2d936a4
BP
6291static inline struct ofp11_instruction *
6292instruction_next(const struct ofp11_instruction *inst)
6293{
6294 return ((struct ofp11_instruction *) (void *)
6295 ((uint8_t *) inst + ntohs(inst->len)));
6296}
f25d0cf3 6297
c2d936a4
BP
6298static inline bool
6299instruction_is_valid(const struct ofp11_instruction *inst,
6300 size_t n_instructions)
6301{
6302 uint16_t len = ntohs(inst->len);
6303 return (!(len % OFP11_INSTRUCTION_ALIGN)
6304 && len >= sizeof *inst
6305 && len / sizeof *inst <= n_instructions);
6306}
f25d0cf3 6307
c2d936a4
BP
6308/* This macro is careful to check for instructions with bad lengths. */
6309#define INSTRUCTION_FOR_EACH(ITER, LEFT, INSTRUCTIONS, N_INSTRUCTIONS) \
6310 for ((ITER) = (INSTRUCTIONS), (LEFT) = (N_INSTRUCTIONS); \
6311 (LEFT) > 0 && instruction_is_valid(ITER, LEFT); \
6312 ((LEFT) -= (ntohs((ITER)->len) \
6313 / sizeof(struct ofp11_instruction)), \
6314 (ITER) = instruction_next(ITER)))
f25d0cf3 6315
c2d936a4
BP
6316static enum ofperr
6317decode_openflow11_instruction(const struct ofp11_instruction *inst,
6318 enum ovs_instruction_type *type)
6319{
6320 uint16_t len = ntohs(inst->len);
b02475c5 6321
c2d936a4
BP
6322 switch (inst->type) {
6323 case CONSTANT_HTONS(OFPIT11_EXPERIMENTER):
6324 return OFPERR_OFPBIC_BAD_EXPERIMENTER;
b02475c5 6325
c2d936a4
BP
6326#define DEFINE_INST(ENUM, STRUCT, EXTENSIBLE, NAME) \
6327 case CONSTANT_HTONS(ENUM): \
6328 if (EXTENSIBLE \
6329 ? len >= sizeof(struct STRUCT) \
6330 : len == sizeof(struct STRUCT)) { \
6331 *type = OVSINST_##ENUM; \
6332 return 0; \
6333 } else { \
6334 return OFPERR_OFPBIC_BAD_LEN; \
6335 }
6336OVS_INSTRUCTIONS
6337#undef DEFINE_INST
29089a54 6338
c2d936a4
BP
6339 default:
6340 return OFPERR_OFPBIC_UNKNOWN_INST;
f25d0cf3
BP
6341 }
6342}
f25d0cf3 6343
c2d936a4
BP
6344static enum ofperr
6345decode_openflow11_instructions(const struct ofp11_instruction insts[],
6346 size_t n_insts,
6347 const struct ofp11_instruction *out[])
f25d0cf3 6348{
c2d936a4
BP
6349 const struct ofp11_instruction *inst;
6350 size_t left;
f25d0cf3 6351
c2d936a4
BP
6352 memset(out, 0, N_OVS_INSTRUCTIONS * sizeof *out);
6353 INSTRUCTION_FOR_EACH (inst, left, insts, n_insts) {
6354 enum ovs_instruction_type type;
6355 enum ofperr error;
f25d0cf3 6356
c2d936a4
BP
6357 error = decode_openflow11_instruction(inst, &type);
6358 if (error) {
6359 return error;
6360 }
f25d0cf3 6361
c2d936a4
BP
6362 if (out[type]) {
6363 return OFPERR_OFPBIC_DUP_INST;
6364 }
6365 out[type] = inst;
6366 }
6367
6368 if (left) {
6369 VLOG_WARN_RL(&rl, "bad instruction format at offset %"PRIuSIZE,
6370 (n_insts - left) * sizeof *inst);
6371 return OFPERR_OFPBIC_BAD_LEN;
6372 }
6373 return 0;
f25d0cf3
BP
6374}
6375
6376static void
c2d936a4
BP
6377get_actions_from_instruction(const struct ofp11_instruction *inst,
6378 const struct ofp_action_header **actions,
6379 size_t *actions_len)
f25d0cf3 6380{
c2d936a4
BP
6381 *actions = ALIGNED_CAST(const struct ofp_action_header *, inst + 1);
6382 *actions_len = ntohs(inst->len) - sizeof *inst;
6383}
f25d0cf3 6384
c2d936a4
BP
6385enum ofperr
6386ofpacts_pull_openflow_instructions(struct ofpbuf *openflow,
6387 unsigned int instructions_len,
6388 enum ofp_version version,
6389 struct ofpbuf *ofpacts)
6390{
6391 const struct ofp11_instruction *instructions;
6392 const struct ofp11_instruction *insts[N_OVS_INSTRUCTIONS];
6393 enum ofperr error;
f25d0cf3 6394
9abca1e5 6395 ofpbuf_clear(ofpacts);
c2d936a4
BP
6396 if (version == OFP10_VERSION) {
6397 return ofpacts_pull_openflow_actions__(openflow, instructions_len,
6398 version,
6399 (1u << N_OVS_INSTRUCTIONS) - 1,
d824b5b7 6400 ofpacts, 0);
c2d936a4 6401 }
f25d0cf3 6402
c2d936a4
BP
6403 if (instructions_len % OFP11_INSTRUCTION_ALIGN != 0) {
6404 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u is not a "
6405 "multiple of %d",
6406 instructions_len, OFP11_INSTRUCTION_ALIGN);
6407 error = OFPERR_OFPBIC_BAD_LEN;
6408 goto exit;
6409 }
f25d0cf3 6410
c2d936a4
BP
6411 instructions = ofpbuf_try_pull(openflow, instructions_len);
6412 if (instructions == NULL) {
6413 VLOG_WARN_RL(&rl, "OpenFlow message instructions length %u exceeds "
6414 "remaining message length (%"PRIu32")",
6fd6ed71 6415 instructions_len, openflow->size);
c2d936a4
BP
6416 error = OFPERR_OFPBIC_BAD_LEN;
6417 goto exit;
6418 }
f25d0cf3 6419
c2d936a4
BP
6420 error = decode_openflow11_instructions(
6421 instructions, instructions_len / OFP11_INSTRUCTION_ALIGN,
6422 insts);
6423 if (error) {
6424 goto exit;
6425 }
f25d0cf3 6426
c2d936a4
BP
6427 if (insts[OVSINST_OFPIT13_METER]) {
6428 const struct ofp13_instruction_meter *oim;
6429 struct ofpact_meter *om;
f25d0cf3 6430
c2d936a4
BP
6431 oim = ALIGNED_CAST(const struct ofp13_instruction_meter *,
6432 insts[OVSINST_OFPIT13_METER]);
f25d0cf3 6433
c2d936a4
BP
6434 om = ofpact_put_METER(ofpacts);
6435 om->meter_id = ntohl(oim->meter_id);
6436 }
6437 if (insts[OVSINST_OFPIT11_APPLY_ACTIONS]) {
6438 const struct ofp_action_header *actions;
6439 size_t actions_len;
f25d0cf3 6440
c2d936a4
BP
6441 get_actions_from_instruction(insts[OVSINST_OFPIT11_APPLY_ACTIONS],
6442 &actions, &actions_len);
6443 error = ofpacts_decode(actions, actions_len, version, ofpacts);
6444 if (error) {
6445 goto exit;
6446 }
6447 }
6448 if (insts[OVSINST_OFPIT11_CLEAR_ACTIONS]) {
6449 instruction_get_OFPIT11_CLEAR_ACTIONS(
6450 insts[OVSINST_OFPIT11_CLEAR_ACTIONS]);
6451 ofpact_put_CLEAR_ACTIONS(ofpacts);
6452 }
6453 if (insts[OVSINST_OFPIT11_WRITE_ACTIONS]) {
6454 struct ofpact_nest *on;
6455 const struct ofp_action_header *actions;
6456 size_t actions_len;
2bd318de 6457 size_t start = ofpacts->size;
255a54ea
BP
6458 ofpact_put(ofpacts, OFPACT_WRITE_ACTIONS,
6459 offsetof(struct ofpact_nest, actions));
c2d936a4
BP
6460 get_actions_from_instruction(insts[OVSINST_OFPIT11_WRITE_ACTIONS],
6461 &actions, &actions_len);
6462 error = ofpacts_decode_for_action_set(actions, actions_len,
6463 version, ofpacts);
6464 if (error) {
6465 goto exit;
6466 }
6467 on = ofpbuf_at_assert(ofpacts, start, sizeof *on);
6fd6ed71 6468 on->ofpact.len = ofpacts->size - start;
c2d936a4
BP
6469 }
6470 if (insts[OVSINST_OFPIT11_WRITE_METADATA]) {
6471 const struct ofp11_instruction_write_metadata *oiwm;
6472 struct ofpact_metadata *om;
ca287d20 6473
c2d936a4
BP
6474 oiwm = ALIGNED_CAST(const struct ofp11_instruction_write_metadata *,
6475 insts[OVSINST_OFPIT11_WRITE_METADATA]);
8dd54666 6476
c2d936a4
BP
6477 om = ofpact_put_WRITE_METADATA(ofpacts);
6478 om->metadata = oiwm->metadata;
6479 om->mask = oiwm->metadata_mask;
6480 }
6481 if (insts[OVSINST_OFPIT11_GOTO_TABLE]) {
6482 const struct ofp11_instruction_goto_table *oigt;
6483 struct ofpact_goto_table *ogt;
7395c052 6484
c2d936a4
BP
6485 oigt = instruction_get_OFPIT11_GOTO_TABLE(
6486 insts[OVSINST_OFPIT11_GOTO_TABLE]);
6487 ogt = ofpact_put_GOTO_TABLE(ofpacts);
6488 ogt->table_id = oigt->table_id;
6489 }
e3f8f887 6490
6fd6ed71 6491 error = ofpacts_verify(ofpacts->data, ofpacts->size,
d824b5b7 6492 (1u << N_OVS_INSTRUCTIONS) - 1, 0);
c2d936a4
BP
6493exit:
6494 if (error) {
6495 ofpbuf_clear(ofpacts);
f25d0cf3 6496 }
c2d936a4 6497 return error;
f25d0cf3 6498}
d01c980f 6499
c2d936a4
BP
6500/* Update the length of the instruction that begins at offset 'ofs' within
6501 * 'openflow' and contains nested actions that extend to the end of 'openflow'.
6502 * If the instruction contains no nested actions, deletes it entirely. */
d01c980f 6503static void
c2d936a4 6504ofpacts_update_instruction_actions(struct ofpbuf *openflow, size_t ofs)
d01c980f 6505{
c2d936a4 6506 struct ofp11_instruction_actions *oia;
d01c980f 6507
c2d936a4 6508 oia = ofpbuf_at_assert(openflow, ofs, sizeof *oia);
6fd6ed71
PS
6509 if (openflow->size > ofs + sizeof *oia) {
6510 oia->len = htons(openflow->size - ofs);
c2d936a4 6511 } else {
6fd6ed71 6512 openflow->size = ofs;
c2d936a4 6513 }
d01c980f 6514}
c2d936a4
BP
6515\f
6516/* Checks that 'port' is a valid output port for OFPACT_OUTPUT, given that the
6517 * switch will never have more than 'max_ports' ports. Returns 0 if 'port' is
6518 * valid, otherwise an OpenFlow error code. */
6519enum ofperr
6520ofpact_check_output_port(ofp_port_t port, ofp_port_t max_ports)
99086062 6521{
c2d936a4
BP
6522 switch (port) {
6523 case OFPP_IN_PORT:
6524 case OFPP_TABLE:
6525 case OFPP_NORMAL:
6526 case OFPP_FLOOD:
6527 case OFPP_ALL:
6528 case OFPP_CONTROLLER:
c2d936a4
BP
6529 case OFPP_LOCAL:
6530 return 0;
6531
13d2c689
BP
6532 case OFPP_NONE:
6533 return OFPERR_OFPBAC_BAD_OUT_PORT;
6534
c2d936a4
BP
6535 default:
6536 if (ofp_to_u16(port) < ofp_to_u16(max_ports)) {
6537 return 0;
6538 }
6539 return OFPERR_OFPBAC_BAD_OUT_PORT;
99086062
BP
6540 }
6541}
6542
c2d936a4
BP
6543/* Removes the protocols that require consistency between match and actions
6544 * (that's everything but OpenFlow 1.0) from '*usable_protocols'.
6545 *
6546 * (An example of an inconsistency between match and actions is a flow that
6547 * does not match on an MPLS Ethertype but has an action that pops an MPLS
6548 * label.) */
d01c980f 6549static void
c2d936a4
BP
6550inconsistent_match(enum ofputil_protocol *usable_protocols)
6551{
6552 *usable_protocols &= OFPUTIL_P_OF10_ANY;
6553}
6554
6555/* May modify flow->dl_type, flow->nw_proto and flow->vlan_tci,
6556 * caller must restore them.
6557 *
6558 * Modifies some actions, filling in fields that could not be properly set
6559 * without context. */
6560static enum ofperr
6561ofpact_check__(enum ofputil_protocol *usable_protocols, struct ofpact *a,
6562 struct flow *flow, ofp_port_t max_ports,
6563 uint8_t table_id, uint8_t n_tables)
d01c980f 6564{
c2d936a4
BP
6565 const struct ofpact_enqueue *enqueue;
6566 const struct mf_field *mf;
6567
d01c980f
BP
6568 switch (a->type) {
6569 case OFPACT_OUTPUT:
c2d936a4
BP
6570 return ofpact_check_output_port(ofpact_get_OUTPUT(a)->port,
6571 max_ports);
6572
6573 case OFPACT_CONTROLLER:
6574 return 0;
d01c980f
BP
6575
6576 case OFPACT_ENQUEUE:
c2d936a4
BP
6577 enqueue = ofpact_get_ENQUEUE(a);
6578 if (ofp_to_u16(enqueue->port) >= ofp_to_u16(max_ports)
6579 && enqueue->port != OFPP_IN_PORT
6580 && enqueue->port != OFPP_LOCAL) {
6581 return OFPERR_OFPBAC_BAD_OUT_PORT;
6582 }
6583 return 0;
6584
6585 case OFPACT_OUTPUT_REG:
6586 return mf_check_src(&ofpact_get_OUTPUT_REG(a)->src, flow);
6587
6588 case OFPACT_BUNDLE:
6589 return bundle_check(ofpact_get_BUNDLE(a), max_ports, flow);
d01c980f
BP
6590
6591 case OFPACT_SET_VLAN_VID:
c2d936a4
BP
6592 /* Remember if we saw a vlan tag in the flow to aid translating to
6593 * OpenFlow 1.1+ if need be. */
6594 ofpact_get_SET_VLAN_VID(a)->flow_has_vlan =
6595 (flow->vlan_tci & htons(VLAN_CFI)) == htons(VLAN_CFI);
6596 if (!(flow->vlan_tci & htons(VLAN_CFI)) &&
6597 !ofpact_get_SET_VLAN_VID(a)->push_vlan_if_needed) {
6598 inconsistent_match(usable_protocols);
6599 }
6600 /* Temporary mark that we have a vlan tag. */
6601 flow->vlan_tci |= htons(VLAN_CFI);
6602 return 0;
d01c980f
BP
6603
6604 case OFPACT_SET_VLAN_PCP:
c2d936a4
BP
6605 /* Remember if we saw a vlan tag in the flow to aid translating to
6606 * OpenFlow 1.1+ if need be. */
6607 ofpact_get_SET_VLAN_PCP(a)->flow_has_vlan =
6608 (flow->vlan_tci & htons(VLAN_CFI)) == htons(VLAN_CFI);
6609 if (!(flow->vlan_tci & htons(VLAN_CFI)) &&
6610 !ofpact_get_SET_VLAN_PCP(a)->push_vlan_if_needed) {
6611 inconsistent_match(usable_protocols);
6612 }
6613 /* Temporary mark that we have a vlan tag. */
6614 flow->vlan_tci |= htons(VLAN_CFI);
6615 return 0;
d01c980f
BP
6616
6617 case OFPACT_STRIP_VLAN:
c2d936a4
BP
6618 if (!(flow->vlan_tci & htons(VLAN_CFI))) {
6619 inconsistent_match(usable_protocols);
6620 }
6621 /* Temporary mark that we have no vlan tag. */
6622 flow->vlan_tci = htons(0);
6623 return 0;
d01c980f 6624
3e34fbdd 6625 case OFPACT_PUSH_VLAN:
c2d936a4
BP
6626 if (flow->vlan_tci & htons(VLAN_CFI)) {
6627 /* Multiple VLAN headers not supported. */
6628 return OFPERR_OFPBAC_BAD_TAG;
6629 }
6630 /* Temporary mark that we have a vlan tag. */
6631 flow->vlan_tci |= htons(VLAN_CFI);
6632 return 0;
276c4e7a 6633
d01c980f 6634 case OFPACT_SET_ETH_SRC:
d01c980f 6635 case OFPACT_SET_ETH_DST:
c2d936a4 6636 return 0;
d01c980f
BP
6637
6638 case OFPACT_SET_IPV4_SRC:
d01c980f 6639 case OFPACT_SET_IPV4_DST:
c2d936a4
BP
6640 if (flow->dl_type != htons(ETH_TYPE_IP)) {
6641 inconsistent_match(usable_protocols);
6642 }
6643 return 0;
d01c980f 6644
04f01c24 6645 case OFPACT_SET_IP_DSCP:
ff14eb7a 6646 case OFPACT_SET_IP_ECN:
0c20dbe4 6647 case OFPACT_SET_IP_TTL:
7bcb1506 6648 case OFPACT_DEC_TTL:
c2d936a4
BP
6649 if (!is_ip_any(flow)) {
6650 inconsistent_match(usable_protocols);
6651 }
6652 return 0;
b02475c5 6653
c2d936a4 6654 case OFPACT_SET_L4_SRC_PORT:
c2d936a4 6655 case OFPACT_SET_L4_DST_PORT:
b8778a0d 6656 if (!is_ip_any(flow) || (flow->nw_frag & FLOW_NW_FRAG_LATER) ||
c2d936a4
BP
6657 (flow->nw_proto != IPPROTO_TCP && flow->nw_proto != IPPROTO_UDP
6658 && flow->nw_proto != IPPROTO_SCTP)) {
6659 inconsistent_match(usable_protocols);
6660 }
6661 /* Note on which transport protocol the port numbers are set.
6662 * This allows this set action to be converted to an OF1.2 set field
6663 * action. */
b8778a0d
JR
6664 if (a->type == OFPACT_SET_L4_SRC_PORT) {
6665 ofpact_get_SET_L4_SRC_PORT(a)->flow_ip_proto = flow->nw_proto;
6666 } else {
6667 ofpact_get_SET_L4_DST_PORT(a)->flow_ip_proto = flow->nw_proto;
6668 }
c2d936a4 6669 return 0;
b02475c5 6670
c2d936a4
BP
6671 case OFPACT_REG_MOVE:
6672 return nxm_reg_move_check(ofpact_get_REG_MOVE(a), flow);
8dd54666 6673
e3f8f887 6674 case OFPACT_SET_FIELD:
c2d936a4
BP
6675 mf = ofpact_get_SET_FIELD(a)->field;
6676 /* Require OXM_OF_VLAN_VID to have an existing VLAN header. */
6677 if (!mf_are_prereqs_ok(mf, flow) ||
6678 (mf->id == MFF_VLAN_VID && !(flow->vlan_tci & htons(VLAN_CFI)))) {
6679 VLOG_WARN_RL(&rl, "set_field %s lacks correct prerequisities",
6680 mf->name);
6681 return OFPERR_OFPBAC_MATCH_INCONSISTENT;
6682 }
6683 /* Remember if we saw a vlan tag in the flow to aid translating to
6684 * OpenFlow 1.1 if need be. */
6685 ofpact_get_SET_FIELD(a)->flow_has_vlan =
6686 (flow->vlan_tci & htons(VLAN_CFI)) == htons(VLAN_CFI);
6687 if (mf->id == MFF_VLAN_TCI) {
6688 /* The set field may add or remove the vlan tag,
6689 * Mark the status temporarily. */
6690 flow->vlan_tci = ofpact_get_SET_FIELD(a)->value.be16;
6691 }
6692 return 0;
e3f8f887 6693
bd85dac1 6694 case OFPACT_STACK_PUSH:
c2d936a4
BP
6695 return nxm_stack_push_check(ofpact_get_STACK_PUSH(a), flow);
6696
bd85dac1 6697 case OFPACT_STACK_POP:
c2d936a4
BP
6698 return nxm_stack_pop_check(ofpact_get_STACK_POP(a), flow);
6699
6700 case OFPACT_SET_MPLS_LABEL:
6701 case OFPACT_SET_MPLS_TC:
6702 case OFPACT_SET_MPLS_TTL:
6703 case OFPACT_DEC_MPLS_TTL:
6704 if (!eth_type_mpls(flow->dl_type)) {
6705 inconsistent_match(usable_protocols);
6706 }
6707 return 0;
6708
d01c980f 6709 case OFPACT_SET_TUNNEL:
c2d936a4 6710 case OFPACT_SET_QUEUE:
d01c980f 6711 case OFPACT_POP_QUEUE:
d01c980f 6712 case OFPACT_RESUBMIT:
c2d936a4
BP
6713 return 0;
6714
6715 case OFPACT_FIN_TIMEOUT:
6716 if (flow->nw_proto != IPPROTO_TCP) {
6717 inconsistent_match(usable_protocols);
6718 }
6719 return 0;
6720
d01c980f 6721 case OFPACT_LEARN:
c2d936a4
BP
6722 return learn_check(ofpact_get_LEARN(a), flow);
6723
18080541
BP
6724 case OFPACT_CONJUNCTION:
6725 return 0;
6726
d01c980f 6727 case OFPACT_MULTIPATH:
c2d936a4
BP
6728 return multipath_check(ofpact_get_MULTIPATH(a), flow);
6729
d01c980f
BP
6730 case OFPACT_NOTE:
6731 case OFPACT_EXIT:
c2d936a4 6732 return 0;
d01c980f 6733
c2d936a4
BP
6734 case OFPACT_PUSH_MPLS:
6735 flow->dl_type = ofpact_get_PUSH_MPLS(a)->ethertype;
6736 /* The packet is now MPLS and the MPLS payload is opaque.
6737 * Thus nothing can be assumed about the network protocol.
6738 * Temporarily mark that we have no nw_proto. */
6739 flow->nw_proto = 0;
6740 return 0;
1e7db674 6741
c2d936a4
BP
6742 case OFPACT_POP_MPLS:
6743 if (!eth_type_mpls(flow->dl_type)) {
6744 inconsistent_match(usable_protocols);
6745 }
6746 flow->dl_type = ofpact_get_POP_MPLS(a)->ethertype;
6747 return 0;
1e7db674 6748
c2d936a4
BP
6749 case OFPACT_SAMPLE:
6750 return 0;
1e7db674 6751
07659514
JS
6752 case OFPACT_CT: {
6753 struct ofpact_conntrack *oc = ofpact_get_CT(a);
76e3e669 6754 enum ofperr err;
07659514
JS
6755
6756 if (!dl_type_is_ip_any(flow->dl_type)
6757 || (flow->ct_state & CS_INVALID && oc->flags & NX_CT_F_COMMIT)) {
6758 inconsistent_match(usable_protocols);
6759 }
6760
6761 if (oc->zone_src.field) {
6762 return mf_check_src(&oc->zone_src, flow);
6763 }
8e53fe8c 6764
76e3e669
JR
6765 err = ofpacts_check(oc->actions, ofpact_ct_get_action_len(oc),
6766 flow, max_ports, table_id, n_tables,
6767 usable_protocols);
6768 return err;
07659514
JS
6769 }
6770
9ac0aada
JR
6771 case OFPACT_NAT: {
6772 struct ofpact_nat *on = ofpact_get_NAT(a);
6773
6774 if (!dl_type_is_ip_any(flow->dl_type) ||
6775 (on->range_af == AF_INET && flow->dl_type != htons(ETH_TYPE_IP)) ||
6776 (on->range_af == AF_INET6
6777 && flow->dl_type != htons(ETH_TYPE_IPV6))) {
6778 inconsistent_match(usable_protocols);
6779 }
6780 return 0;
6781 }
6782
c2d936a4
BP
6783 case OFPACT_CLEAR_ACTIONS:
6784 return 0;
1e7db674 6785
c2d936a4
BP
6786 case OFPACT_WRITE_ACTIONS: {
6787 /* Use a temporary copy of 'usable_protocols' because we can't check
6788 * consistency of an action set. */
6789 struct ofpact_nest *on = ofpact_get_WRITE_ACTIONS(a);
6790 enum ofputil_protocol p = *usable_protocols;
6791 return ofpacts_check(on->actions, ofpact_nest_get_action_len(on),
6792 flow, max_ports, table_id, n_tables, &p);
6793 }
1e7db674 6794
c2d936a4
BP
6795 case OFPACT_WRITE_METADATA:
6796 return 0;
1e7db674 6797
c2d936a4
BP
6798 case OFPACT_METER: {
6799 uint32_t mid = ofpact_get_METER(a)->meter_id;
6800 if (mid == 0 || mid > OFPM13_MAX) {
6801 return OFPERR_OFPMMFC_INVALID_METER;
6802 }
6803 return 0;
6804 }
1e7db674 6805
c2d936a4
BP
6806 case OFPACT_GOTO_TABLE: {
6807 uint8_t goto_table = ofpact_get_GOTO_TABLE(a)->table_id;
6808 if ((table_id != 255 && goto_table <= table_id)
6809 || (n_tables != 255 && goto_table >= n_tables)) {
8c87971e 6810 return OFPERR_OFPBIC_BAD_TABLE_ID;
c2d936a4
BP
6811 }
6812 return 0;
6813 }
1e7db674 6814
c2d936a4
BP
6815 case OFPACT_GROUP:
6816 return 0;
1e7db674 6817
e672ff9b
JR
6818 case OFPACT_UNROLL_XLATE:
6819 /* UNROLL is an internal action that should never be seen via
6820 * OpenFlow. */
6821 return OFPERR_OFPBAC_BAD_TYPE;
6822
d4abaff5
BP
6823 case OFPACT_DEBUG_RECIRC:
6824 return 0;
6825
c2d936a4
BP
6826 default:
6827 OVS_NOT_REACHED();
6828 }
6829}
1e7db674 6830
c2d936a4
BP
6831/* Checks that the 'ofpacts_len' bytes of actions in 'ofpacts' are
6832 * appropriate for a packet with the prerequisites satisfied by 'flow' in a
6833 * switch with no more than 'max_ports' ports.
6834 *
6835 * If 'ofpacts' and 'flow' are inconsistent with one another, un-sets in
6836 * '*usable_protocols' the protocols that forbid the inconsistency. (An
6837 * example of an inconsistency between match and actions is a flow that does
6838 * not match on an MPLS Ethertype but has an action that pops an MPLS label.)
6839 *
6840 * May annotate ofpacts with information gathered from the 'flow'.
6841 *
6842 * May temporarily modify 'flow', but restores the changes before returning. */
6843enum ofperr
6844ofpacts_check(struct ofpact ofpacts[], size_t ofpacts_len,
6845 struct flow *flow, ofp_port_t max_ports,
6846 uint8_t table_id, uint8_t n_tables,
6847 enum ofputil_protocol *usable_protocols)
6848{
6849 struct ofpact *a;
6850 ovs_be16 dl_type = flow->dl_type;
6851 ovs_be16 vlan_tci = flow->vlan_tci;
6852 uint8_t nw_proto = flow->nw_proto;
6853 enum ofperr error = 0;
1e7db674 6854
c2d936a4
BP
6855 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
6856 error = ofpact_check__(usable_protocols, a, flow,
6857 max_ports, table_id, n_tables);
6858 if (error) {
1e7db674 6859 break;
c2d936a4
BP
6860 }
6861 }
6862 /* Restore fields that may have been modified. */
6863 flow->dl_type = dl_type;
6864 flow->vlan_tci = vlan_tci;
6865 flow->nw_proto = nw_proto;
6866 return error;
6867}
1e7db674 6868
c2d936a4
BP
6869/* Like ofpacts_check(), but reports inconsistencies as
6870 * OFPERR_OFPBAC_MATCH_INCONSISTENT rather than clearing bits. */
6871enum ofperr
6872ofpacts_check_consistency(struct ofpact ofpacts[], size_t ofpacts_len,
6873 struct flow *flow, ofp_port_t max_ports,
6874 uint8_t table_id, uint8_t n_tables,
6875 enum ofputil_protocol usable_protocols)
6876{
6877 enum ofputil_protocol p = usable_protocols;
6878 enum ofperr error;
1e7db674 6879
c2d936a4
BP
6880 error = ofpacts_check(ofpacts, ofpacts_len, flow, max_ports,
6881 table_id, n_tables, &p);
6882 return (error ? error
6883 : p != usable_protocols ? OFPERR_OFPBAC_MATCH_INCONSISTENT
6884 : 0);
6885}
097d4939 6886
28f5311f
JS
6887/* Returns the destination field that 'ofpact' would write to, or NULL
6888 * if the action would not write to an mf_field. */
6889const struct mf_field *
6890ofpact_get_mf_dst(const struct ofpact *ofpact)
8e53fe8c 6891{
28f5311f
JS
6892 if (ofpact->type == OFPACT_SET_FIELD) {
6893 const struct ofpact_set_field *orl;
8e53fe8c 6894
28f5311f 6895 orl = CONTAINER_OF(ofpact, struct ofpact_set_field, ofpact);
8e53fe8c 6896 return orl->field;
28f5311f
JS
6897 } else if (ofpact->type == OFPACT_REG_MOVE) {
6898 const struct ofpact_reg_move *orm;
8e53fe8c 6899
28f5311f 6900 orm = CONTAINER_OF(ofpact, struct ofpact_reg_move, ofpact);
8e53fe8c
JS
6901 return orm->dst.field;
6902 }
6903
6904 return NULL;
6905}
6906
6907static enum ofperr
6908unsupported_nesting(enum ofpact_type action, enum ofpact_type outer_action)
6909{
6910 VLOG_WARN("%s action doesn't support nested action %s",
6911 ofpact_name(outer_action), ofpact_name(action));
6912 return OFPERR_OFPBAC_BAD_ARGUMENT;
6913}
6914
6915static bool
6916field_requires_ct(enum mf_field_id field)
6917{
9daf2348 6918 return field == MFF_CT_MARK || field == MFF_CT_LABEL;
8e53fe8c
JS
6919}
6920
6921/* Apply nesting constraints for actions */
d824b5b7
JS
6922static enum ofperr
6923ofpacts_verify_nested(const struct ofpact *a, enum ofpact_type outer_action)
6924{
28f5311f 6925 const struct mf_field *field = ofpact_get_mf_dst(a);
8e53fe8c
JS
6926
6927 if (field && field_requires_ct(field->id) && outer_action != OFPACT_CT) {
6928 VLOG_WARN("cannot set CT fields outside of ct action");
6929 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
6930 }
9ac0aada
JR
6931 if (a->type == OFPACT_NAT) {
6932 if (outer_action != OFPACT_CT) {
6933 VLOG_WARN("Cannot have NAT action outside of \"ct\" action");
6934 return OFPERR_OFPBAC_BAD_SET_ARGUMENT;
6935 }
6936 return 0;
6937 }
8e53fe8c
JS
6938
6939 if (outer_action) {
6940 ovs_assert(outer_action == OFPACT_WRITE_ACTIONS
6941 || outer_action == OFPACT_CT);
6942
6943 if (outer_action == OFPACT_CT) {
6944 if (!field) {
6945 return unsupported_nesting(a->type, outer_action);
6946 } else if (!field_requires_ct(field->id)) {
6947 VLOG_WARN("%s action doesn't support nested modification "
6948 "of %s", ofpact_name(outer_action), field->name);
6949 return OFPERR_OFPBAC_BAD_ARGUMENT;
6950 }
6951 }
d824b5b7
JS
6952 }
6953
6954 return 0;
6955}
6956
18080541
BP
6957/* Verifies that the 'ofpacts_len' bytes of actions in 'ofpacts' are in the
6958 * appropriate order as defined by the OpenFlow spec and as required by Open
6959 * vSwitch.
6960 *
6961 * 'allowed_ovsinsts' is a bitmap of OVSINST_* values, in which 1-bits indicate
d824b5b7
JS
6962 * instructions that are allowed within 'ofpacts[]'.
6963 *
6964 * If 'outer_action' is not zero, it specifies that the actions are nested
6965 * within another action of type 'outer_action'. */
c2d936a4
BP
6966static enum ofperr
6967ofpacts_verify(const struct ofpact ofpacts[], size_t ofpacts_len,
d824b5b7 6968 uint32_t allowed_ovsinsts, enum ofpact_type outer_action)
c2d936a4
BP
6969{
6970 const struct ofpact *a;
6971 enum ovs_instruction_type inst;
097d4939 6972
c2d936a4
BP
6973 inst = OVSINST_OFPIT13_METER;
6974 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
6975 enum ovs_instruction_type next;
8e53fe8c 6976 enum ofperr error;
1e7db674 6977
18080541
BP
6978 if (a->type == OFPACT_CONJUNCTION) {
6979 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
f08e39dd
BP
6980 if (a->type != OFPACT_CONJUNCTION && a->type != OFPACT_NOTE) {
6981 VLOG_WARN("\"conjunction\" actions may be used along with "
6982 "\"note\" but not any other kind of action "
6983 "(such as the \"%s\" action used here)",
96775a1c 6984 ofpact_name(a->type));
18080541
BP
6985 return OFPERR_NXBAC_BAD_CONJUNCTION;
6986 }
6987 }
6988 return 0;
6989 }
6990
8e53fe8c
JS
6991 error = ofpacts_verify_nested(a, outer_action);
6992 if (error) {
6993 return error;
d824b5b7
JS
6994 }
6995
c2d936a4
BP
6996 next = ovs_instruction_type_from_ofpact_type(a->type);
6997 if (a > ofpacts
6998 && (inst == OVSINST_OFPIT11_APPLY_ACTIONS
6999 ? next < inst
7000 : next <= inst)) {
7001 const char *name = ovs_instruction_name_from_type(inst);
7002 const char *next_name = ovs_instruction_name_from_type(next);
1e7db674 7003
c2d936a4
BP
7004 if (next == inst) {
7005 VLOG_WARN("duplicate %s instruction not allowed, for OpenFlow "
7006 "1.1+ compatibility", name);
7007 } else {
7008 VLOG_WARN("invalid instruction ordering: %s must appear "
7009 "before %s, for OpenFlow 1.1+ compatibility",
7010 next_name, name);
7011 }
7012 return OFPERR_OFPBAC_UNSUPPORTED_ORDER;
7013 }
7014 if (!((1u << next) & allowed_ovsinsts)) {
7015 const char *name = ovs_instruction_name_from_type(next);
1e7db674 7016
c2d936a4
BP
7017 VLOG_WARN("%s instruction not allowed here", name);
7018 return OFPERR_OFPBIC_UNSUP_INST;
1e7db674 7019 }
c2d936a4
BP
7020
7021 inst = next;
7022 }
7023
7024 return 0;
7025}
7026\f
7027/* Converting ofpacts to OpenFlow. */
7028
7029static void
7030encode_ofpact(const struct ofpact *a, enum ofp_version ofp_version,
7031 struct ofpbuf *out)
7032{
7033 switch (a->type) {
7034#define OFPACT(ENUM, STRUCT, MEMBER, NAME) \
7035 case OFPACT_##ENUM: \
355ead69
GS
7036 encode_##ENUM(ofpact_get_##ENUM(a), ofp_version, out); \
7037 return;
c2d936a4
BP
7038 OFPACTS
7039#undef OFPACT
7040 default:
7041 OVS_NOT_REACHED();
1e7db674 7042 }
e3f8f887
JR
7043}
7044
7045/* Converts the 'ofpacts_len' bytes of ofpacts in 'ofpacts' into OpenFlow
7046 * actions in 'openflow', appending the actions to any existing data in
d01c980f 7047 * 'openflow'. */
a07c15bc 7048size_t
e3f8f887
JR
7049ofpacts_put_openflow_actions(const struct ofpact ofpacts[], size_t ofpacts_len,
7050 struct ofpbuf *openflow,
7051 enum ofp_version ofp_version)
d01c980f
BP
7052{
7053 const struct ofpact *a;
6fd6ed71 7054 size_t start_size = openflow->size;
d01c980f
BP
7055
7056 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
c2d936a4 7057 encode_ofpact(a, ofp_version, openflow);
d01c980f 7058 }
6fd6ed71 7059 return openflow->size - start_size;
d01c980f
BP
7060}
7061
c2d936a4
BP
7062static enum ovs_instruction_type
7063ofpact_is_apply_actions(const struct ofpact *a)
d01c980f 7064{
c2d936a4
BP
7065 return (ovs_instruction_type_from_ofpact_type(a->type)
7066 == OVSINST_OFPIT11_APPLY_ACTIONS);
d01c980f 7067}
8dd54666
IY
7068
7069void
e3f8f887
JR
7070ofpacts_put_openflow_instructions(const struct ofpact ofpacts[],
7071 size_t ofpacts_len,
7072 struct ofpbuf *openflow,
7073 enum ofp_version ofp_version)
8dd54666 7074{
c2d936a4 7075 const struct ofpact *end = ofpact_end(ofpacts, ofpacts_len);
8dd54666
IY
7076 const struct ofpact *a;
7077
8f2cded4
BP
7078 if (ofp_version == OFP10_VERSION) {
7079 ofpacts_put_openflow_actions(ofpacts, ofpacts_len, openflow,
7080 ofp_version);
7081 return;
7082 }
e3f8f887 7083
c2d936a4
BP
7084 a = ofpacts;
7085 while (a < end) {
7086 if (ofpact_is_apply_actions(a)) {
6fd6ed71 7087 size_t ofs = openflow->size;
8dd54666
IY
7088
7089 instruction_put_OFPIT11_APPLY_ACTIONS(openflow);
c2d936a4
BP
7090 do {
7091 encode_ofpact(a, ofp_version, openflow);
7092 a = ofpact_next(a);
7093 } while (a < end && ofpact_is_apply_actions(a));
7fdb60a7 7094 ofpacts_update_instruction_actions(openflow, ofs);
c2d936a4
BP
7095 } else {
7096 encode_ofpact(a, ofp_version, openflow);
7097 a = ofpact_next(a);
8dd54666
IY
7098 }
7099 }
7100}
d01c980f 7101\f
08d1e234
BP
7102/* Sets of supported actions. */
7103
7104/* Two-way translation between OVS's internal "OFPACT_*" representation of
7105 * actions and the "OFPAT_*" representation used in some OpenFlow version.
7106 * (OFPAT_* numbering varies from one OpenFlow version to another, so a given
7107 * instance is specific to one OpenFlow version.) */
7108struct ofpact_map {
7109 enum ofpact_type ofpact; /* Internal name for action type. */
7110 int ofpat; /* OFPAT_* number from OpenFlow spec. */
7111};
7112
7113static const struct ofpact_map *
7114get_ofpact_map(enum ofp_version version)
7115{
7116 /* OpenFlow 1.0 actions. */
7117 static const struct ofpact_map of10[] = {
7118 { OFPACT_OUTPUT, 0 },
7119 { OFPACT_SET_VLAN_VID, 1 },
7120 { OFPACT_SET_VLAN_PCP, 2 },
7121 { OFPACT_STRIP_VLAN, 3 },
7122 { OFPACT_SET_ETH_SRC, 4 },
7123 { OFPACT_SET_ETH_DST, 5 },
7124 { OFPACT_SET_IPV4_SRC, 6 },
7125 { OFPACT_SET_IPV4_DST, 7 },
7126 { OFPACT_SET_IP_DSCP, 8 },
7127 { OFPACT_SET_L4_SRC_PORT, 9 },
7128 { OFPACT_SET_L4_DST_PORT, 10 },
7129 { OFPACT_ENQUEUE, 11 },
7130 { 0, -1 },
7131 };
7132
7133 /* OpenFlow 1.1 actions. */
7134 static const struct ofpact_map of11[] = {
7135 { OFPACT_OUTPUT, 0 },
7136 { OFPACT_SET_VLAN_VID, 1 },
7137 { OFPACT_SET_VLAN_PCP, 2 },
7138 { OFPACT_SET_ETH_SRC, 3 },
7139 { OFPACT_SET_ETH_DST, 4 },
7140 { OFPACT_SET_IPV4_SRC, 5 },
7141 { OFPACT_SET_IPV4_DST, 6 },
7142 { OFPACT_SET_IP_DSCP, 7 },
7143 { OFPACT_SET_IP_ECN, 8 },
7144 { OFPACT_SET_L4_SRC_PORT, 9 },
7145 { OFPACT_SET_L4_DST_PORT, 10 },
7146 /* OFPAT_COPY_TTL_OUT (11) not supported. */
7147 /* OFPAT_COPY_TTL_IN (12) not supported. */
7148 { OFPACT_SET_MPLS_LABEL, 13 },
7149 { OFPACT_SET_MPLS_TC, 14 },
7150 { OFPACT_SET_MPLS_TTL, 15 },
7151 { OFPACT_DEC_MPLS_TTL, 16 },
7152 { OFPACT_PUSH_VLAN, 17 },
7153 { OFPACT_STRIP_VLAN, 18 },
7154 { OFPACT_PUSH_MPLS, 19 },
7155 { OFPACT_POP_MPLS, 20 },
7156 { OFPACT_SET_QUEUE, 21 },
7157 { OFPACT_GROUP, 22 },
7158 { OFPACT_SET_IP_TTL, 23 },
7159 { OFPACT_DEC_TTL, 24 },
7160 { 0, -1 },
7161 };
7162
7163 /* OpenFlow 1.2, 1.3, and 1.4 actions. */
7164 static const struct ofpact_map of12[] = {
7165 { OFPACT_OUTPUT, 0 },
7166 /* OFPAT_COPY_TTL_OUT (11) not supported. */
7167 /* OFPAT_COPY_TTL_IN (12) not supported. */
7168 { OFPACT_SET_MPLS_TTL, 15 },
7169 { OFPACT_DEC_MPLS_TTL, 16 },
7170 { OFPACT_PUSH_VLAN, 17 },
7171 { OFPACT_STRIP_VLAN, 18 },
7172 { OFPACT_PUSH_MPLS, 19 },
7173 { OFPACT_POP_MPLS, 20 },
7174 { OFPACT_SET_QUEUE, 21 },
7175 { OFPACT_GROUP, 22 },
7176 { OFPACT_SET_IP_TTL, 23 },
7177 { OFPACT_DEC_TTL, 24 },
7178 { OFPACT_SET_FIELD, 25 },
7179 /* OF1.3+ OFPAT_PUSH_PBB (26) not supported. */
7180 /* OF1.3+ OFPAT_POP_PBB (27) not supported. */
7181 { 0, -1 },
7182 };
7183
7184 switch (version) {
7185 case OFP10_VERSION:
7186 return of10;
7187
7188 case OFP11_VERSION:
7189 return of11;
7190
7191 case OFP12_VERSION:
7192 case OFP13_VERSION:
7193 case OFP14_VERSION:
7194 case OFP15_VERSION:
7195 default:
7196 return of12;
7197 }
7198}
7199
7200/* Converts 'ofpacts_bitmap', a bitmap whose bits correspond to OFPACT_*
7201 * values, into a bitmap of actions suitable for OpenFlow 'version', and
7202 * returns the result. */
7203ovs_be32
7204ofpact_bitmap_to_openflow(uint64_t ofpacts_bitmap, enum ofp_version version)
7205{
7206 uint32_t openflow_bitmap = 0;
7207 const struct ofpact_map *x;
7208
7209 for (x = get_ofpact_map(version); x->ofpat >= 0; x++) {
7210 if (ofpacts_bitmap & (UINT64_C(1) << x->ofpact)) {
7211 openflow_bitmap |= 1u << x->ofpat;
7212 }
7213 }
7214 return htonl(openflow_bitmap);
7215}
7216
7217/* Converts 'ofpat_bitmap', a bitmap of actions from an OpenFlow message with
7218 * the given 'version' into a bitmap whose bits correspond to OFPACT_* values,
7219 * and returns the result. */
7220uint64_t
7221ofpact_bitmap_from_openflow(ovs_be32 ofpat_bitmap, enum ofp_version version)
7222{
7223 uint64_t ofpact_bitmap = 0;
7224 const struct ofpact_map *x;
7225
7226 for (x = get_ofpact_map(version); x->ofpat >= 0; x++) {
7227 if (ofpat_bitmap & htonl(1u << x->ofpat)) {
7228 ofpact_bitmap |= UINT64_C(1) << x->ofpact;
7229 }
7230 }
7231 return ofpact_bitmap;
7232}
7233
7234/* Appends to 's' a string representation of the set of OFPACT_* represented
7235 * by 'ofpacts_bitmap'. */
7236void
7237ofpact_bitmap_format(uint64_t ofpacts_bitmap, struct ds *s)
7238{
7239 if (!ofpacts_bitmap) {
7240 ds_put_cstr(s, "<none>");
7241 } else {
7242 while (ofpacts_bitmap) {
7243 ds_put_format(s, "%s ",
7244 ofpact_name(rightmost_1bit_idx(ofpacts_bitmap)));
7245 ofpacts_bitmap = zero_rightmost_1bit(ofpacts_bitmap);
7246 }
7247 ds_chomp(s, ' ');
7248 }
7249}
7250\f
f25d0cf3
BP
7251/* Returns true if 'action' outputs to 'port', false otherwise. */
7252static bool
4e022ec0 7253ofpact_outputs_to_port(const struct ofpact *ofpact, ofp_port_t port)
f25d0cf3
BP
7254{
7255 switch (ofpact->type) {
7256 case OFPACT_OUTPUT:
7257 return ofpact_get_OUTPUT(ofpact)->port == port;
7258 case OFPACT_ENQUEUE:
7259 return ofpact_get_ENQUEUE(ofpact)->port == port;
7260 case OFPACT_CONTROLLER:
7261 return port == OFPP_CONTROLLER;
7262
7263 case OFPACT_OUTPUT_REG:
7264 case OFPACT_BUNDLE:
7265 case OFPACT_SET_VLAN_VID:
7266 case OFPACT_SET_VLAN_PCP:
7267 case OFPACT_STRIP_VLAN:
3e34fbdd 7268 case OFPACT_PUSH_VLAN:
f25d0cf3
BP
7269 case OFPACT_SET_ETH_SRC:
7270 case OFPACT_SET_ETH_DST:
7271 case OFPACT_SET_IPV4_SRC:
7272 case OFPACT_SET_IPV4_DST:
04f01c24 7273 case OFPACT_SET_IP_DSCP:
ff14eb7a 7274 case OFPACT_SET_IP_ECN:
0c20dbe4 7275 case OFPACT_SET_IP_TTL:
f25d0cf3
BP
7276 case OFPACT_SET_L4_SRC_PORT:
7277 case OFPACT_SET_L4_DST_PORT:
7278 case OFPACT_REG_MOVE:
b2dd70be 7279 case OFPACT_SET_FIELD:
bd85dac1
AZ
7280 case OFPACT_STACK_PUSH:
7281 case OFPACT_STACK_POP:
f25d0cf3 7282 case OFPACT_DEC_TTL:
097d4939
JR
7283 case OFPACT_SET_MPLS_LABEL:
7284 case OFPACT_SET_MPLS_TC:
0f3f3c3d 7285 case OFPACT_SET_MPLS_TTL:
b676167a 7286 case OFPACT_DEC_MPLS_TTL:
f25d0cf3 7287 case OFPACT_SET_TUNNEL:
4cceacb9 7288 case OFPACT_WRITE_METADATA:
f25d0cf3
BP
7289 case OFPACT_SET_QUEUE:
7290 case OFPACT_POP_QUEUE:
7291 case OFPACT_FIN_TIMEOUT:
7292 case OFPACT_RESUBMIT:
7293 case OFPACT_LEARN:
18080541 7294 case OFPACT_CONJUNCTION:
f25d0cf3 7295 case OFPACT_MULTIPATH:
f25d0cf3
BP
7296 case OFPACT_NOTE:
7297 case OFPACT_EXIT:
e672ff9b 7298 case OFPACT_UNROLL_XLATE:
b02475c5
SH
7299 case OFPACT_PUSH_MPLS:
7300 case OFPACT_POP_MPLS:
29089a54 7301 case OFPACT_SAMPLE:
b19e8793 7302 case OFPACT_CLEAR_ACTIONS:
7fdb60a7 7303 case OFPACT_WRITE_ACTIONS:
8dd54666 7304 case OFPACT_GOTO_TABLE:
638a19b0 7305 case OFPACT_METER:
7395c052 7306 case OFPACT_GROUP:
d4abaff5 7307 case OFPACT_DEBUG_RECIRC:
07659514 7308 case OFPACT_CT:
9ac0aada 7309 case OFPACT_NAT:
f25d0cf3
BP
7310 default:
7311 return false;
7312 }
7313}
7314
7315/* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
7316 * to 'port', false otherwise. */
7317bool
7318ofpacts_output_to_port(const struct ofpact *ofpacts, size_t ofpacts_len,
4e022ec0 7319 ofp_port_t port)
c2d936a4
BP
7320{
7321 const struct ofpact *a;
f25d0cf3 7322
4f20179d 7323 OFPACT_FOR_EACH_FLATTENED (a, ofpacts, ofpacts_len) {
c2d936a4
BP
7324 if (ofpact_outputs_to_port(a, port)) {
7325 return true;
7326 }
7327 }
f25d0cf3 7328
c2d936a4
BP
7329 return false;
7330}
f25d0cf3 7331
c2d936a4
BP
7332/* Returns true if any action in the 'ofpacts_len' bytes of 'ofpacts' outputs
7333 * to 'group', false otherwise. */
7334bool
7335ofpacts_output_to_group(const struct ofpact *ofpacts, size_t ofpacts_len,
7336 uint32_t group_id)
7337{
7338 const struct ofpact *a;
b02475c5 7339
4f20179d 7340 OFPACT_FOR_EACH_FLATTENED (a, ofpacts, ofpacts_len) {
c2d936a4
BP
7341 if (a->type == OFPACT_GROUP
7342 && ofpact_get_GROUP(a)->group_id == group_id) {
7343 return true;
7344 }
7345 }
b02475c5 7346
c2d936a4
BP
7347 return false;
7348}
8dd54666 7349
c2d936a4
BP
7350bool
7351ofpacts_equal(const struct ofpact *a, size_t a_len,
7352 const struct ofpact *b, size_t b_len)
7353{
7354 return a_len == b_len && !memcmp(a, b, a_len);
7355}
29089a54 7356
c2d936a4
BP
7357/* Finds the OFPACT_METER action, if any, in the 'ofpacts_len' bytes of
7358 * 'ofpacts'. If found, returns its meter ID; if not, returns 0.
7359 *
7360 * This function relies on the order of 'ofpacts' being correct (as checked by
7361 * ofpacts_verify()). */
7362uint32_t
7363ofpacts_get_meter(const struct ofpact ofpacts[], size_t ofpacts_len)
7364{
7365 const struct ofpact *a;
7fdb60a7 7366
c2d936a4
BP
7367 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
7368 enum ovs_instruction_type inst;
b19e8793 7369
c2d936a4
BP
7370 inst = ovs_instruction_type_from_ofpact_type(a->type);
7371 if (a->type == OFPACT_METER) {
7372 return ofpact_get_METER(a)->meter_id;
7373 } else if (inst > OVSINST_OFPIT13_METER) {
7374 break;
4cceacb9 7375 }
c2d936a4 7376 }
638a19b0 7377
c2d936a4
BP
7378 return 0;
7379}
7380\f
7381/* Formatting ofpacts. */
7395c052 7382
c2d936a4
BP
7383static void
7384ofpact_format(const struct ofpact *a, struct ds *s)
7385{
7386 switch (a->type) {
7387#define OFPACT(ENUM, STRUCT, MEMBER, NAME) \
7388 case OFPACT_##ENUM: \
7389 format_##ENUM(ALIGNED_CAST(const struct STRUCT *, a), s); \
7390 break;
7391 OFPACTS
7392#undef OFPACT
7393 default:
7394 OVS_NOT_REACHED();
f25d0cf3
BP
7395 }
7396}
7397
7398/* Appends a string representing the 'ofpacts_len' bytes of ofpacts in
7399 * 'ofpacts' to 'string'. */
7400void
7401ofpacts_format(const struct ofpact *ofpacts, size_t ofpacts_len,
7402 struct ds *string)
7403{
f25d0cf3 7404 if (!ofpacts_len) {
b1c5bf1f 7405 ds_put_format(string, "%sdrop%s", colors.drop, colors.end);
f25d0cf3
BP
7406 } else {
7407 const struct ofpact *a;
7408
7409 OFPACT_FOR_EACH (a, ofpacts, ofpacts_len) {
7410 if (a != ofpacts) {
b1c5bf1f 7411 ds_put_char(string, ',');
f25d0cf3 7412 }
8dd54666 7413
5dca28b5 7414 /* XXX write-actions */
f25d0cf3
BP
7415 ofpact_format(a, string);
7416 }
7417 }
7418}
7419\f
7420/* Internal use by helpers. */
7421
ce058104 7422/* Implementation of ofpact_put_<ENUM>(). */
f25d0cf3
BP
7423void *
7424ofpact_put(struct ofpbuf *ofpacts, enum ofpact_type type, size_t len)
7425{
7426 struct ofpact *ofpact;
7427
6fd6ed71
PS
7428 ofpacts->header = ofpbuf_put_uninit(ofpacts, len);
7429 ofpact = ofpacts->header;
f25d0cf3
BP
7430 ofpact_init(ofpact, type, len);
7431 return ofpact;
7432}
7433
ce058104 7434/* Implementation of ofpact_init_<ENUM>(). */
f25d0cf3
BP
7435void
7436ofpact_init(struct ofpact *ofpact, enum ofpact_type type, size_t len)
7437{
7438 memset(ofpact, 0, len);
7439 ofpact->type = type;
c2d936a4 7440 ofpact->raw = -1;
f25d0cf3
BP
7441 ofpact->len = len;
7442}
ce058104
BP
7443
7444/* Implementation of ofpact_finish_<ENUM>().
7445 *
7446 * Finishes composing a variable-length action (begun using
2bd318de
BP
7447 * ofpact_put_<NAME>()), by padding the action to a multiple of OFPACT_ALIGNTO
7448 * bytes and updating its embedded length field. See the large comment near
ebe12cd3
JS
7449 * the end of ofp-actions.h for more information.
7450 *
7451 * May reallocate 'ofpacts'. Callers should consider updating their 'ofpact'
7452 * pointer to the return value of this function. */
7453void *
34abaa3d 7454ofpact_finish(struct ofpbuf *ofpacts, struct ofpact *ofpact)
f25d0cf3 7455{
5308056f
JS
7456 ptrdiff_t len;
7457
6fd6ed71 7458 ovs_assert(ofpact == ofpacts->header);
5308056f 7459 len = (char *) ofpbuf_tail(ofpacts) - (char *) ofpact;
847b5649 7460 ovs_assert(len > 0 && len <= UINT16_MAX);
5308056f 7461 ofpact->len = len;
2bd318de 7462 ofpbuf_padto(ofpacts, OFPACT_ALIGN(ofpacts->size));
ebe12cd3
JS
7463
7464 return ofpacts->header;
f25d0cf3 7465}
c2d936a4 7466\f
cab50449 7467static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
7468ofpact_parse(enum ofpact_type type, char *value, struct ofpbuf *ofpacts,
7469 enum ofputil_protocol *usable_protocols)
7470{
7471 switch (type) {
7472#define OFPACT(ENUM, STRUCT, MEMBER, NAME) \
7473 case OFPACT_##ENUM: \
7474 return parse_##ENUM(value, ofpacts, usable_protocols);
7475 OFPACTS
7476#undef OFPACT
7477 default:
7478 OVS_NOT_REACHED();
7479 }
7480}
7481
7482static bool
7483ofpact_type_from_name(const char *name, enum ofpact_type *type)
7484{
7485#define OFPACT(ENUM, STRUCT, MEMBER, NAME) \
7486 if (!strcasecmp(name, NAME)) { \
7487 *type = OFPACT_##ENUM; \
7488 return true; \
7489 }
7490 OFPACTS
7491#undef OFPACT
7492
7493 return false;
7494}
7495
7496/* Parses 'str' as a series of instructions, and appends them to 'ofpacts'.
7497 *
7498 * Returns NULL if successful, otherwise a malloc()'d string describing the
d824b5b7
JS
7499 * error. The caller is responsible for freeing the returned string.
7500 *
7501 * If 'outer_action' is specified, indicates that the actions being parsed
7502 * are nested within another action of the type specified in 'outer_action'. */
cab50449 7503static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
7504ofpacts_parse__(char *str, struct ofpbuf *ofpacts,
7505 enum ofputil_protocol *usable_protocols,
d824b5b7 7506 bool allow_instructions, enum ofpact_type outer_action)
c2d936a4
BP
7507{
7508 int prev_inst = -1;
7509 enum ofperr retval;
7510 char *key, *value;
7511 bool drop = false;
7512 char *pos;
7513
7514 pos = str;
7515 while (ofputil_parse_key_value(&pos, &key, &value)) {
7516 enum ovs_instruction_type inst = OVSINST_OFPIT11_APPLY_ACTIONS;
7517 enum ofpact_type type;
7518 char *error = NULL;
7519 ofp_port_t port;
7520
7521 if (ofpact_type_from_name(key, &type)) {
7522 error = ofpact_parse(type, value, ofpacts, usable_protocols);
7523 inst = ovs_instruction_type_from_ofpact_type(type);
7524 } else if (!strcasecmp(key, "mod_vlan_vid")) {
7525 error = parse_set_vlan_vid(value, ofpacts, true);
7526 } else if (!strcasecmp(key, "mod_vlan_pcp")) {
7527 error = parse_set_vlan_pcp(value, ofpacts, true);
7528 } else if (!strcasecmp(key, "set_nw_ttl")) {
7529 error = parse_SET_IP_TTL(value, ofpacts, usable_protocols);
7530 } else if (!strcasecmp(key, "pop_vlan")) {
7531 error = parse_pop_vlan(ofpacts);
7532 } else if (!strcasecmp(key, "set_tunnel64")) {
7533 error = parse_set_tunnel(value, ofpacts,
7534 NXAST_RAW_SET_TUNNEL64);
7eb4b1f1
BP
7535 } else if (!strcasecmp(key, "load")) {
7536 error = parse_reg_load(value, ofpacts);
c2d936a4
BP
7537 } else if (!strcasecmp(key, "bundle_load")) {
7538 error = parse_bundle_load(value, ofpacts);
7539 } else if (!strcasecmp(key, "drop")) {
7540 drop = true;
7541 } else if (!strcasecmp(key, "apply_actions")) {
7542 return xstrdup("apply_actions is the default instruction");
7543 } else if (ofputil_port_from_string(key, &port)) {
7544 ofpact_put_OUTPUT(ofpacts)->port = port;
7545 } else {
7546 return xasprintf("unknown action %s", key);
7547 }
7548 if (error) {
7549 return error;
7550 }
7551
7552 if (inst != OVSINST_OFPIT11_APPLY_ACTIONS) {
7553 if (!allow_instructions) {
7554 return xasprintf("only actions are allowed here (not "
7555 "instruction %s)",
7556 ovs_instruction_name_from_type(inst));
7557 }
7558 if (inst == prev_inst) {
7559 return xasprintf("instruction %s may be specified only once",
7560 ovs_instruction_name_from_type(inst));
7561 }
7562 }
7563 if (prev_inst != -1 && inst < prev_inst) {
7564 return xasprintf("instruction %s must be specified before %s",
7565 ovs_instruction_name_from_type(inst),
7566 ovs_instruction_name_from_type(prev_inst));
7567 }
7568 prev_inst = inst;
7569 }
c2d936a4 7570
6fd6ed71 7571 if (drop && ofpacts->size) {
c2d936a4
BP
7572 return xstrdup("\"drop\" must not be accompanied by any other action "
7573 "or instruction");
7574 }
7575
6fd6ed71 7576 retval = ofpacts_verify(ofpacts->data, ofpacts->size,
c2d936a4
BP
7577 (allow_instructions
7578 ? (1u << N_OVS_INSTRUCTIONS) - 1
d824b5b7
JS
7579 : 1u << OVSINST_OFPIT11_APPLY_ACTIONS),
7580 outer_action);
c2d936a4
BP
7581 if (retval) {
7582 return xstrdup("Incorrect instruction ordering");
7583 }
7584
7585 return NULL;
7586}
7587
cab50449 7588static char * OVS_WARN_UNUSED_RESULT
c2d936a4 7589ofpacts_parse(char *str, struct ofpbuf *ofpacts,
d824b5b7
JS
7590 enum ofputil_protocol *usable_protocols, bool allow_instructions,
7591 enum ofpact_type outer_action)
c2d936a4 7592{
6fd6ed71 7593 uint32_t orig_size = ofpacts->size;
c2d936a4 7594 char *error = ofpacts_parse__(str, ofpacts, usable_protocols,
d824b5b7 7595 allow_instructions, outer_action);
c2d936a4 7596 if (error) {
6fd6ed71 7597 ofpacts->size = orig_size;
c2d936a4
BP
7598 }
7599 return error;
7600}
7601
cab50449 7602static char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
7603ofpacts_parse_copy(const char *s_, struct ofpbuf *ofpacts,
7604 enum ofputil_protocol *usable_protocols,
d824b5b7 7605 bool allow_instructions, enum ofpact_type outer_action)
c2d936a4
BP
7606{
7607 char *error, *s;
7608
7609 *usable_protocols = OFPUTIL_P_ANY;
7610
7611 s = xstrdup(s_);
d824b5b7
JS
7612 error = ofpacts_parse(s, ofpacts, usable_protocols, allow_instructions,
7613 outer_action);
c2d936a4
BP
7614 free(s);
7615
7616 return error;
7617}
7618
7619/* Parses 's' as a set of OpenFlow actions and appends the actions to
d824b5b7
JS
7620 * 'ofpacts'. 'outer_action', if nonzero, specifies that 's' contains actions
7621 * that are nested within the action of type 'outer_action'.
c2d936a4
BP
7622 *
7623 * Returns NULL if successful, otherwise a malloc()'d string describing the
7624 * error. The caller is responsible for freeing the returned string. */
cab50449 7625char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
7626ofpacts_parse_actions(const char *s, struct ofpbuf *ofpacts,
7627 enum ofputil_protocol *usable_protocols)
7628{
d824b5b7 7629 return ofpacts_parse_copy(s, ofpacts, usable_protocols, false, 0);
c2d936a4
BP
7630}
7631
7632/* Parses 's' as a set of OpenFlow instructions and appends the instructions to
7633 * 'ofpacts'.
7634 *
7635 * Returns NULL if successful, otherwise a malloc()'d string describing the
7636 * error. The caller is responsible for freeing the returned string. */
cab50449 7637char * OVS_WARN_UNUSED_RESULT
c2d936a4
BP
7638ofpacts_parse_instructions(const char *s, struct ofpbuf *ofpacts,
7639 enum ofputil_protocol *usable_protocols)
7640{
d824b5b7 7641 return ofpacts_parse_copy(s, ofpacts, usable_protocols, true, 0);
c2d936a4 7642}
08d1e234
BP
7643
7644const char *
7645ofpact_name(enum ofpact_type type)
7646{
7647 switch (type) {
7648#define OFPACT(ENUM, STRUCT, MEMBER, NAME) case OFPACT_##ENUM: return NAME;
7649 OFPACTS
7650#undef OFPACT
7651 }
7652 return "<unknown>";
7653}
c2d936a4
BP
7654\f
7655/* Low-level action decoding and encoding functions. */
7656
7657/* Everything needed to identify a particular OpenFlow action. */
7658struct ofpact_hdrs {
7659 uint32_t vendor; /* 0 if standard, otherwise a vendor code. */
7660 uint16_t type; /* Type if standard, otherwise subtype. */
7661 uint8_t ofp_version; /* From ofp_header. */
7662};
7663
7664/* Information about a particular OpenFlow action. */
7665struct ofpact_raw_instance {
7666 /* The action's identity. */
7667 struct ofpact_hdrs hdrs;
7668 enum ofp_raw_action_type raw;
7669
7670 /* Looking up the action. */
7671 struct hmap_node decode_node; /* Based on 'hdrs'. */
7672 struct hmap_node encode_node; /* Based on 'raw' + 'hdrs.ofp_version'. */
7673
7674 /* The action's encoded size.
7675 *
7676 * If this action is fixed-length, 'min_length' == 'max_length'.
7677 * If it is variable length, then 'max_length' is ROUND_DOWN(UINT16_MAX,
7678 * OFP_ACTION_ALIGN) == 65528. */
7679 unsigned short int min_length;
7680 unsigned short int max_length;
7681
7682 /* For actions with a simple integer numeric argument, 'arg_ofs' is the
7683 * offset of that argument from the beginning of the action and 'arg_len'
7684 * its length, both in bytes.
7685 *
7686 * For actions that take other forms, these are both zero. */
7687 unsigned short int arg_ofs;
7688 unsigned short int arg_len;
7689
7690 /* The name of the action, e.g. "OFPAT_OUTPUT" or "NXAST_RESUBMIT". */
7691 const char *name;
7692
7693 /* If this action is deprecated, a human-readable string with a brief
7694 * explanation. */
7695 const char *deprecation;
7696};
7697
7698/* Action header. */
7699struct ofp_action_header {
7700 /* The meaning of other values of 'type' generally depends on the OpenFlow
7701 * version (see enum ofp_raw_action_type).
7702 *
7703 * Across all OpenFlow versions, OFPAT_VENDOR indicates that 'vendor'
7704 * designates an OpenFlow vendor ID and that the remainder of the action
7705 * structure has a vendor-defined meaning.
7706 */
7707#define OFPAT_VENDOR 0xffff
7708 ovs_be16 type;
7709
7710 /* Always a multiple of 8. */
7711 ovs_be16 len;
7712
7713 /* For type == OFPAT_VENDOR only, this is a vendor ID, e.g. NX_VENDOR_ID or
7714 * ONF_VENDOR_ID. Other 'type's use this space for some other purpose. */
7715 ovs_be32 vendor;
7716};
7717OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
7718
232c1e12
BP
7719/* Header for Nicira-defined actions and for ONF vendor extensions.
7720 *
7721 * This cannot be used as an entirely generic vendor extension action header,
7722 * because OpenFlow does not specify the location or size of the action
7723 * subtype; it just happens that ONF extensions and Nicira extensions share
7724 * this format. */
7725struct ext_action_header {
c2d936a4
BP
7726 ovs_be16 type; /* OFPAT_VENDOR. */
7727 ovs_be16 len; /* At least 16. */
232c1e12 7728 ovs_be32 vendor; /* NX_VENDOR_ID or ONF_VENDOR_ID. */
c2d936a4
BP
7729 ovs_be16 subtype; /* See enum ofp_raw_action_type. */
7730 uint8_t pad[6];
7731};
232c1e12 7732OFP_ASSERT(sizeof(struct ext_action_header) == 16);
c2d936a4
BP
7733
7734static bool
7735ofpact_hdrs_equal(const struct ofpact_hdrs *a,
7736 const struct ofpact_hdrs *b)
7737{
7738 return (a->vendor == b->vendor
7739 && a->type == b->type
7740 && a->ofp_version == b->ofp_version);
7741}
7742
7743static uint32_t
7744ofpact_hdrs_hash(const struct ofpact_hdrs *hdrs)
7745{
7746 return hash_2words(hdrs->vendor, (hdrs->type << 16) | hdrs->ofp_version);
7747}
7748
7749#include "ofp-actions.inc2"
7750
7751static struct hmap *
7752ofpact_decode_hmap(void)
7753{
7754 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
7755 static struct hmap hmap;
7756
7757 if (ovsthread_once_start(&once)) {
7758 struct ofpact_raw_instance *inst;
7759
7760 hmap_init(&hmap);
7761 for (inst = all_raw_instances;
7762 inst < &all_raw_instances[ARRAY_SIZE(all_raw_instances)];
7763 inst++) {
7764 hmap_insert(&hmap, &inst->decode_node,
7765 ofpact_hdrs_hash(&inst->hdrs));
7766 }
7767 ovsthread_once_done(&once);
7768 }
7769 return &hmap;
7770}
7771
7772static struct hmap *
7773ofpact_encode_hmap(void)
7774{
7775 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
7776 static struct hmap hmap;
7777
7778 if (ovsthread_once_start(&once)) {
7779 struct ofpact_raw_instance *inst;
7780
7781 hmap_init(&hmap);
7782 for (inst = all_raw_instances;
7783 inst < &all_raw_instances[ARRAY_SIZE(all_raw_instances)];
7784 inst++) {
7785 hmap_insert(&hmap, &inst->encode_node,
7786 hash_2words(inst->raw, inst->hdrs.ofp_version));
7787 }
7788 ovsthread_once_done(&once);
7789 }
7790 return &hmap;
7791}
7792
7793static enum ofperr
7794ofpact_decode_raw(enum ofp_version ofp_version,
7795 const struct ofp_action_header *oah, size_t length,
7796 const struct ofpact_raw_instance **instp)
7797{
7798 const struct ofpact_raw_instance *inst;
7799 struct ofpact_hdrs hdrs;
7800
7801 *instp = NULL;
7802 if (length < sizeof *oah) {
7803 return OFPERR_OFPBAC_BAD_LEN;
7804 }
7805
7806 /* Get base action type. */
7807 if (oah->type == htons(OFPAT_VENDOR)) {
7808 /* Get vendor. */
7809 hdrs.vendor = ntohl(oah->vendor);
232c1e12
BP
7810 if (hdrs.vendor == NX_VENDOR_ID || hdrs.vendor == ONF_VENDOR_ID) {
7811 /* Get extension subtype. */
7812 const struct ext_action_header *nah;
c2d936a4 7813
232c1e12 7814 nah = ALIGNED_CAST(const struct ext_action_header *, oah);
c2d936a4
BP
7815 if (length < sizeof *nah) {
7816 return OFPERR_OFPBAC_BAD_LEN;
7817 }
7818 hdrs.type = ntohs(nah->subtype);
7819 } else {
7820 VLOG_WARN_RL(&rl, "OpenFlow action has unknown vendor %#"PRIx32,
7821 hdrs.vendor);
7822 return OFPERR_OFPBAC_BAD_VENDOR;
7823 }
7824 } else {
7825 hdrs.vendor = 0;
7826 hdrs.type = ntohs(oah->type);
7827 }
7828
7829 hdrs.ofp_version = ofp_version;
7830 HMAP_FOR_EACH_WITH_HASH (inst, decode_node, ofpact_hdrs_hash(&hdrs),
7831 ofpact_decode_hmap()) {
7832 if (ofpact_hdrs_equal(&hdrs, &inst->hdrs)) {
7833 *instp = inst;
7834 return 0;
7835 }
7836 }
7837
7838 return (hdrs.vendor
7839 ? OFPERR_OFPBAC_BAD_VENDOR_TYPE
7840 : OFPERR_OFPBAC_BAD_TYPE);
7841}
7842
7843static enum ofperr
7844ofpact_pull_raw(struct ofpbuf *buf, enum ofp_version ofp_version,
7845 enum ofp_raw_action_type *raw, uint64_t *arg)
7846{
6fd6ed71 7847 const struct ofp_action_header *oah = buf->data;
c2d936a4
BP
7848 const struct ofpact_raw_instance *action;
7849 unsigned int length;
7850 enum ofperr error;
7851
7852 *raw = *arg = 0;
6fd6ed71 7853 error = ofpact_decode_raw(ofp_version, oah, buf->size, &action);
c2d936a4
BP
7854 if (error) {
7855 return error;
7856 }
7857
7858 if (action->deprecation) {
7859 VLOG_INFO_RL(&rl, "%s is deprecated in %s (%s)",
7860 action->name, ofputil_version_to_string(ofp_version),
7861 action->deprecation);
7862 }
7863
7864 length = ntohs(oah->len);
6fd6ed71 7865 if (length > buf->size) {
b153b990 7866 VLOG_WARN_RL(&rl, "OpenFlow action %s length %u exceeds action buffer "
6fd6ed71 7867 "length %"PRIu32, action->name, length, buf->size);
b153b990
BP
7868 return OFPERR_OFPBAC_BAD_LEN;
7869 }
c2d936a4
BP
7870 if (length < action->min_length || length > action->max_length) {
7871 VLOG_WARN_RL(&rl, "OpenFlow action %s length %u not in valid range "
7872 "[%hu,%hu]", action->name, length,
7873 action->min_length, action->max_length);
7874 return OFPERR_OFPBAC_BAD_LEN;
7875 }
7876 if (length % 8) {
7877 VLOG_WARN_RL(&rl, "OpenFlow action %s length %u is not a multiple "
7878 "of 8", action->name, length);
7879 return OFPERR_OFPBAC_BAD_LEN;
7880 }
7881
7882 *raw = action->raw;
7883 *arg = 0;
7884 if (action->arg_len) {
7885 const uint8_t *p;
7886 int i;
7887
7888 p = ofpbuf_at_assert(buf, action->arg_ofs, action->arg_len);
7889 for (i = 0; i < action->arg_len; i++) {
7890 *arg = (*arg << 8) | p[i];
7891 }
7892 }
7893
7894 ofpbuf_pull(buf, length);
7895
7896 return 0;
7897}
7898
7899static const struct ofpact_raw_instance *
7900ofpact_raw_lookup(enum ofp_version ofp_version, enum ofp_raw_action_type raw)
7901{
7902 const struct ofpact_raw_instance *inst;
7903
7904 HMAP_FOR_EACH_WITH_HASH (inst, encode_node, hash_2words(raw, ofp_version),
7905 ofpact_encode_hmap()) {
7906 if (inst->raw == raw && inst->hdrs.ofp_version == ofp_version) {
7907 return inst;
7908 }
7909 }
7910 OVS_NOT_REACHED();
7911}
7912
7913static void *
7914ofpact_put_raw(struct ofpbuf *buf, enum ofp_version ofp_version,
7915 enum ofp_raw_action_type raw, uint64_t arg)
7916{
7917 const struct ofpact_raw_instance *inst;
7918 struct ofp_action_header *oah;
7919 const struct ofpact_hdrs *hdrs;
7920
7921 inst = ofpact_raw_lookup(ofp_version, raw);
7922 hdrs = &inst->hdrs;
7923
7924 oah = ofpbuf_put_zeros(buf, inst->min_length);
7925 oah->type = htons(hdrs->vendor ? OFPAT_VENDOR : hdrs->type);
7926 oah->len = htons(inst->min_length);
7927 oah->vendor = htonl(hdrs->vendor);
7928
7929 switch (hdrs->vendor) {
7930 case 0:
7931 break;
7932
232c1e12
BP
7933 case NX_VENDOR_ID:
7934 case ONF_VENDOR_ID: {
7935 struct ext_action_header *nah = (struct ext_action_header *) oah;
c2d936a4
BP
7936 nah->subtype = htons(hdrs->type);
7937 break;
7938 }
7939
7940 default:
7941 OVS_NOT_REACHED();
7942 }
7943
7944 if (inst->arg_len) {
7945 uint8_t *p = (uint8_t *) oah + inst->arg_ofs + inst->arg_len;
7946 int i;
7947
7948 for (i = 0; i < inst->arg_len; i++) {
7949 *--p = arg;
7950 arg >>= 8;
7951 }
7952 } else {
7953 ovs_assert(!arg);
7954 }
7955
7956 return oah;
7957}
178742f9
BP
7958
7959static void
7960pad_ofpat(struct ofpbuf *openflow, size_t start_ofs)
7961{
7962 struct ofp_action_header *oah;
7963
9ac0aada
JR
7964 ofpbuf_put_zeros(openflow, PAD_SIZE(openflow->size - start_ofs,
7965 OFP_ACTION_ALIGN));
178742f9
BP
7966
7967 oah = ofpbuf_at_assert(openflow, start_ofs, sizeof *oah);
6fd6ed71 7968 oah->len = htons(openflow->size - start_ofs);
178742f9
BP
7969}
7970