43
43
VLOG_DEFINE_THIS_MODULE(ofp_parse);
45
static void ofp_fatal(const char *flow, bool verbose, const char *format, ...)
49
str_to_table_id(const char *str)
45
/* Parses 'str' as an 8-bit unsigned integer into '*valuep'.
47
* 'name' describes the value parsed in an error message, if any.
49
* Returns NULL if successful, otherwise a malloc()'d string describing the
50
* error. The caller is responsible for freeing the returned string. */
51
static char * WARN_UNUSED_RESULT
52
str_to_u8(const char *str, const char *name, uint8_t *valuep)
53
if (!str_to_int(str, 10, &table_id) || table_id < 0 || table_id > 255) {
54
ovs_fatal(0, "invalid table \"%s\"", str);
56
if (!str_to_int(str, 0, &value) || value < 0 || value > 255) {
57
return xasprintf("invalid %s \"%s\"", name, str);
60
str_to_u16(const char *str, const char *name)
63
/* Parses 'str' as a 16-bit unsigned integer into '*valuep'.
65
* 'name' describes the value parsed in an error message, if any.
67
* Returns NULL if successful, otherwise a malloc()'d string describing the
68
* error. The caller is responsible for freeing the returned string. */
69
static char * WARN_UNUSED_RESULT
70
str_to_u16(const char *str, const char *name, uint16_t *valuep)
64
74
if (!str_to_int(str, 0, &value) || value < 0 || value > 65535) {
65
ovs_fatal(0, "invalid %s \"%s\"", name, str);
75
return xasprintf("invalid %s \"%s\"", name, str);
71
str_to_u32(const char *str)
81
/* Parses 'str' as a 32-bit unsigned integer into '*valuep'.
83
* Returns NULL if successful, otherwise a malloc()'d string describing the
84
* error. The caller is responsible for freeing the returned string. */
85
static char * WARN_UNUSED_RESULT
86
str_to_u32(const char *str, uint32_t *valuep)
77
ovs_fatal(0, "missing required numeric argument");
92
return xstrdup("missing required numeric argument");
81
96
value = strtoul(str, &tail, 0);
82
97
if (errno == EINVAL || errno == ERANGE || *tail) {
83
ovs_fatal(0, "invalid numeric format %s", str);
98
return xasprintf("invalid numeric format %s", str);
89
str_to_u64(const char *str)
104
/* Parses 'str' as an 64-bit unsigned integer into '*valuep'.
106
* Returns NULL if successful, otherwise a malloc()'d string describing the
107
* error. The caller is responsible for freeing the returned string. */
108
static char * WARN_UNUSED_RESULT
109
str_to_u64(const char *str, uint64_t *valuep)
95
ovs_fatal(0, "missing required numeric argument");
115
return xstrdup("missing required numeric argument");
99
119
value = strtoull(str, &tail, 0);
100
120
if (errno == EINVAL || errno == ERANGE || *tail) {
101
ovs_fatal(0, "invalid numeric format %s", str);
121
return xasprintf("invalid numeric format %s", str);
127
/* Parses 'str' as an 64-bit unsigned integer in network byte order into
130
* Returns NULL if successful, otherwise a malloc()'d string describing the
131
* error. The caller is responsible for freeing the returned string. */
132
static char * WARN_UNUSED_RESULT
133
str_to_be64(const char *str, ovs_be64 *valuep)
138
error = str_to_u64(str, &value);
140
*valuep = htonll(value);
145
/* Parses 'str' as an Ethernet address into 'mac'.
147
* Returns NULL if successful, otherwise a malloc()'d string describing the
148
* error. The caller is responsible for freeing the returned string. */
149
static char * WARN_UNUSED_RESULT
107
150
str_to_mac(const char *str, uint8_t mac[6])
109
152
if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
110
153
!= ETH_ADDR_SCAN_COUNT) {
111
ovs_fatal(0, "invalid mac address %s", str);
154
return xasprintf("invalid mac address %s", str);
159
/* Parses 'str' as an IP address into '*ip'.
161
* Returns NULL if successful, otherwise a malloc()'d string describing the
162
* error. The caller is responsible for freeing the returned string. */
163
static char * WARN_UNUSED_RESULT
116
164
str_to_ip(const char *str, ovs_be32 *ip)
118
166
struct in_addr in_addr;
120
168
if (lookup_ip(str, &in_addr)) {
121
ovs_fatal(0, "%s: could not convert to IP address", str);
169
return xasprintf("%s: could not convert to IP address", str);
123
171
*ip = in_addr.s_addr;
175
/* Parses 'arg' as the argument to an "enqueue" action, and appends such an
176
* action to 'ofpacts'.
178
* Returns NULL if successful, otherwise a malloc()'d string describing the
179
* error. The caller is responsible for freeing the returned string. */
180
static char * WARN_UNUSED_RESULT
127
181
parse_enqueue(char *arg, struct ofpbuf *ofpacts)
132
186
struct ofpact_enqueue *enqueue;
134
188
if (port == NULL || queue == NULL) {
135
ovs_fatal(0, "\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
189
return xstrdup("\"enqueue\" syntax is \"enqueue:PORT:QUEUE\"");
138
192
enqueue = ofpact_put_ENQUEUE(ofpacts);
139
enqueue->port = str_to_u32(port);
140
enqueue->queue = str_to_u32(queue);
193
if (!ofputil_port_from_string(port, &enqueue->port)) {
194
return xasprintf("%s: enqueue to unknown port", port);
196
return str_to_u32(queue, &enqueue->queue);
144
parse_output(char *arg, struct ofpbuf *ofpacts)
199
/* Parses 'arg' as the argument to an "output" action, and appends such an
200
* action to 'ofpacts'.
202
* Returns NULL if successful, otherwise a malloc()'d string describing the
203
* error. The caller is responsible for freeing the returned string. */
204
static char * WARN_UNUSED_RESULT
205
parse_output(const char *arg, struct ofpbuf *ofpacts)
146
207
if (strchr(arg, '[')) {
147
208
struct ofpact_output_reg *output_reg;
149
210
output_reg = ofpact_put_OUTPUT_REG(ofpacts);
150
mf_parse_subfield(&output_reg->src, arg);
151
211
output_reg->max_len = UINT16_MAX;
212
return mf_parse_subfield(&output_reg->src, arg);
153
214
struct ofpact_output *output;
155
216
output = ofpact_put_OUTPUT(ofpacts);
156
output->port = str_to_u32(arg);
157
217
output->max_len = output->port == OFPP_CONTROLLER ? UINT16_MAX : 0;
218
if (!ofputil_port_from_string(arg, &output->port)) {
219
return xasprintf("%s: output to unknown port", arg);
225
/* Parses 'arg' as the argument to an "resubmit" action, and appends such an
226
* action to 'ofpacts'.
228
* Returns NULL if successful, otherwise a malloc()'d string describing the
229
* error. The caller is responsible for freeing the returned string. */
230
static char * WARN_UNUSED_RESULT
162
231
parse_resubmit(char *arg, struct ofpbuf *ofpacts)
164
233
struct ofpact_resubmit *resubmit;
169
238
in_port_s = strsep(&arg, ",");
170
239
if (in_port_s && in_port_s[0]) {
171
240
if (!ofputil_port_from_string(in_port_s, &resubmit->in_port)) {
172
ovs_fatal(0, "%s: resubmit to unknown port", in_port_s);
241
return xasprintf("%s: resubmit to unknown port", in_port_s);
175
244
resubmit->in_port = OFPP_IN_PORT;
178
247
table_s = strsep(&arg, ",");
179
resubmit->table_id = table_s && table_s[0] ? str_to_u32(table_s) : 255;
248
if (table_s && table_s[0]) {
252
error = str_to_u32(table_s, &table_id);
256
resubmit->table_id = table_id;
258
resubmit->table_id = 255;
181
261
if (resubmit->in_port == OFPP_IN_PORT && resubmit->table_id == 255) {
182
ovs_fatal(0, "at least one \"in_port\" or \"table\" must be specified "
262
return xstrdup("at least one \"in_port\" or \"table\" must be "
263
"specified on resubmit");
268
/* Parses 'arg' as the argument to a "note" action, and appends such an action
271
* Returns NULL if successful, otherwise a malloc()'d string describing the
272
* error. The caller is responsible for freeing the returned string. */
273
static char * WARN_UNUSED_RESULT
188
274
parse_note(const char *arg, struct ofpbuf *ofpacts)
190
276
struct ofpact_note *note;
215
301
ofpact_update_len(ofpacts, ¬e->ofpact);
305
/* Parses 'arg' as the argument to a "fin_timeout" action, and appends such an
306
* action to 'ofpacts'.
308
* Returns NULL if successful, otherwise a malloc()'d string describing the
309
* error. The caller is responsible for freeing the returned string. */
310
static char * WARN_UNUSED_RESULT
219
311
parse_fin_timeout(struct ofpbuf *b, char *arg)
221
313
struct ofpact_fin_timeout *oft = ofpact_put_FIN_TIMEOUT(b);
222
314
char *key, *value;
224
316
while (ofputil_parse_key_value(&arg, &key, &value)) {
225
319
if (!strcmp(key, "idle_timeout")) {
226
oft->fin_idle_timeout = str_to_u16(value, key);
320
error = str_to_u16(value, key, &oft->fin_idle_timeout);
227
321
} else if (!strcmp(key, "hard_timeout")) {
228
oft->fin_hard_timeout = str_to_u16(value, key);
322
error = str_to_u16(value, key, &oft->fin_hard_timeout);
230
ovs_fatal(0, "invalid key '%s' in 'fin_timeout' argument", key);
324
error = xasprintf("invalid key '%s' in 'fin_timeout' argument",
335
/* Parses 'arg' as the argument to a "controller" action, and appends such an
336
* action to 'ofpacts'.
338
* Returns NULL if successful, otherwise a malloc()'d string describing the
339
* error. The caller is responsible for freeing the returned string. */
340
static char * WARN_UNUSED_RESULT
236
341
parse_controller(struct ofpbuf *b, char *arg)
238
343
enum ofp_packet_in_reason reason = OFPR_ACTION;
243
348
/* Use defaults. */
244
349
} else if (strspn(arg, "0123456789") == strlen(arg)) {
245
max_len = str_to_u16(arg, "max_len");
350
char *error = str_to_u16(arg, "max_len", &max_len);
247
355
char *name, *value;
249
357
while (ofputil_parse_key_value(&arg, &name, &value)) {
250
358
if (!strcmp(name, "reason")) {
251
359
if (!ofputil_packet_in_reason_from_string(value, &reason)) {
252
ovs_fatal(0, "unknown reason \"%s\"", value);
360
return xasprintf("unknown reason \"%s\"", value);
254
362
} else if (!strcmp(name, "max_len")) {
255
max_len = str_to_u16(value, "max_len");
363
char *error = str_to_u16(value, "max_len", &max_len);
256
367
} else if (!strcmp(name, "id")) {
257
controller_id = str_to_u16(value, "id");
368
char *error = str_to_u16(value, "id", &controller_id);
259
ovs_fatal(0, "unknown key \"%s\" parsing controller action",
373
return xasprintf("unknown key \"%s\" parsing controller "
311
432
ids->n_controllers++;
313
434
if (!ids->n_controllers) {
314
ovs_fatal(0, "dec_ttl_cnt_ids: expected at least one controller "
435
return xstrdup("dec_ttl_cnt_ids: expected at least one controller "
317
438
ofpact_update_len(b, &ids->ofpact);
322
set_field_parse(const char *arg, struct ofpbuf *ofpacts)
324
char *orig = xstrdup(arg);
443
/* Parses 'arg' as the argument to a "set_mpls_ttl" action, and appends such an
444
* action to 'ofpacts'.
446
* Returns NULL if successful, otherwise a malloc()'d string describing the
447
* error. The caller is responsible for freeing the returned string. */
448
static char * WARN_UNUSED_RESULT
449
parse_set_mpls_ttl(struct ofpbuf *b, const char *arg)
451
struct ofpact_mpls_ttl *mpls_ttl = ofpact_put_SET_MPLS_TTL(b);
454
return xstrdup("parse_set_mpls_ttl: expected ttl.");
457
mpls_ttl->ttl = atoi(arg);
461
/* Parses a "set_field" action with argument 'arg', appending the parsed
462
* action to 'ofpacts'.
464
* Returns NULL if successful, otherwise a malloc()'d string describing the
465
* error. The caller is responsible for freeing the returned string. */
466
static char * WARN_UNUSED_RESULT
467
set_field_parse__(char *arg, struct ofpbuf *ofpacts)
325
469
struct ofpact_reg_load *load = ofpact_put_REG_LOAD(ofpacts);
329
473
const struct mf_field *mf;
331
475
union mf_value mf_value;
334
delim = strstr(orig, "->");
478
delim = strstr(arg, "->");
336
ovs_fatal(0, "%s: missing `->'", orig);
480
return xasprintf("%s: missing `->'", arg);
338
482
if (strlen(delim) <= strlen("->")) {
339
ovs_fatal(0, "%s: missing field name following `->'", orig);
483
return xasprintf("%s: missing field name following `->'", arg);
342
486
key = delim + strlen("->");
343
487
mf = mf_from_name(key);
345
ovs_fatal(0, "%s is not valid oxm field name", key);
489
return xasprintf("%s is not a valid OXM field name", key);
347
491
if (!mf->writable) {
348
ovs_fatal(0, "%s is not allowed to set", key);
492
return xasprintf("%s is read-only", key);
352
496
error = mf_parse_value(mf, value, &mf_value);
354
ovs_fatal(0, "%s", error);
356
500
if (!mf_is_value_valid(mf, &mf_value)) {
357
ovs_fatal(0, "%s is not valid valid for field %s", value, key);
501
return xasprintf("%s is not a valid value for field %s", value, key);
359
503
ofpact_set_field_init(load, mf, &mf_value);
508
/* Parses 'arg' as the argument to a "set_field" action, and appends such an
509
* action to 'ofpacts'.
511
* Returns NULL if successful, otherwise a malloc()'d string describing the
512
* error. The caller is responsible for freeing the returned string. */
513
static char * WARN_UNUSED_RESULT
514
set_field_parse(const char *arg, struct ofpbuf *ofpacts)
516
char *copy = xstrdup(arg);
517
char *error = set_field_parse__(copy, ofpacts);
522
/* Parses 'arg' as the argument to a "write_metadata" instruction, and appends
523
* such an action to 'ofpacts'.
525
* Returns NULL if successful, otherwise a malloc()'d string describing the
526
* error. The caller is responsible for freeing the returned string. */
527
static char * WARN_UNUSED_RESULT
364
528
parse_metadata(struct ofpbuf *b, char *arg)
366
530
struct ofpact_metadata *om;
369
533
om = ofpact_put_WRITE_METADATA(b);
373
om->mask = htonll(str_to_u64(mask + 1));
539
error = str_to_be64(mask + 1, &om->mask);
375
544
om->mask = htonll(UINT64_MAX);
378
om->metadata = htonll(str_to_u64(arg));
382
parse_named_action(enum ofputil_action_code code, const struct flow *flow,
547
return str_to_be64(arg, &om->metadata);
550
/* Parses 'arg' as the argument to a "sample" action, and appends such an
551
* action to 'ofpacts'.
553
* Returns NULL if successful, otherwise a malloc()'d string describing the
554
* error. The caller is responsible for freeing the returned string. */
555
static char * WARN_UNUSED_RESULT
556
parse_sample(struct ofpbuf *b, char *arg)
558
struct ofpact_sample *os = ofpact_put_SAMPLE(b);
561
while (ofputil_parse_key_value(&arg, &key, &value)) {
564
if (!strcmp(key, "probability")) {
565
error = str_to_u16(value, "probability", &os->probability);
566
if (!error && os->probability == 0) {
567
error = xasprintf("invalid probability value \"%s\"", value);
569
} else if (!strcmp(key, "collector_set_id")) {
570
error = str_to_u32(value, &os->collector_set_id);
571
} else if (!strcmp(key, "obs_domain_id")) {
572
error = str_to_u32(value, &os->obs_domain_id);
573
} else if (!strcmp(key, "obs_point_id")) {
574
error = str_to_u32(value, &os->obs_point_id);
576
error = xasprintf("invalid key \"%s\" in \"sample\" argument",
583
if (os->probability == 0) {
584
return xstrdup("non-zero \"probability\" must be specified on sample");
589
/* Parses 'arg' as the argument to action 'code', and appends such an action to
592
* Returns NULL if successful, otherwise a malloc()'d string describing the
593
* error. The caller is responsible for freeing the returned string. */
594
static char * WARN_UNUSED_RESULT
595
parse_named_action(enum ofputil_action_code code,
383
596
char *arg, struct ofpbuf *ofpacts)
598
size_t orig_size = ofpacts->size;
385
599
struct ofpact_tunnel *tunnel;
396
610
case OFPUTIL_OFPAT10_OUTPUT:
397
611
case OFPUTIL_OFPAT11_OUTPUT:
398
parse_output(arg, ofpacts);
612
error = parse_output(arg, ofpacts);
401
615
case OFPUTIL_OFPAT10_SET_VLAN_VID:
402
616
case OFPUTIL_OFPAT11_SET_VLAN_VID:
403
vid = str_to_u32(arg);
617
error = str_to_u16(arg, "VLAN VID", &vid);
404
622
if (vid & ~VLAN_VID_MASK) {
405
ovs_fatal(0, "%s: not a valid VLAN VID", arg);
623
return xasprintf("%s: not a valid VLAN VID", arg);
407
625
ofpact_put_SET_VLAN_VID(ofpacts)->vlan_vid = vid;
410
628
case OFPUTIL_OFPAT10_SET_VLAN_PCP:
411
629
case OFPUTIL_OFPAT11_SET_VLAN_PCP:
412
pcp = str_to_u32(arg);
630
error = str_to_u8(arg, "VLAN PCP", &pcp);
414
ovs_fatal(0, "%s: not a valid VLAN PCP", arg);
636
return xasprintf("%s: not a valid VLAN PCP", arg);
416
638
ofpact_put_SET_VLAN_PCP(ofpacts)->vlan_pcp = pcp;
419
641
case OFPUTIL_OFPAT12_SET_FIELD:
420
set_field_parse(arg, ofpacts);
642
return set_field_parse(arg, ofpacts);
423
644
case OFPUTIL_OFPAT10_STRIP_VLAN:
424
645
case OFPUTIL_OFPAT11_POP_VLAN:
428
649
case OFPUTIL_OFPAT11_PUSH_VLAN:
429
ethertype = str_to_u16(arg, "ethertype");
650
error = str_to_u16(arg, "ethertype", ðertype);
430
655
if (ethertype != ETH_TYPE_VLAN_8021Q) {
431
656
/* XXX ETH_TYPE_VLAN_8021AD case isn't supported */
432
ovs_fatal(0, "%s: not a valid VLAN ethertype", arg);
657
return xasprintf("%s: not a valid VLAN ethertype", arg);
434
660
ofpact_put_PUSH_VLAN(ofpacts);
437
663
case OFPUTIL_OFPAT11_SET_QUEUE:
438
ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
664
error = str_to_u32(arg, &ofpact_put_SET_QUEUE(ofpacts)->queue_id);
442
667
case OFPUTIL_OFPAT10_SET_DL_SRC:
443
668
case OFPUTIL_OFPAT11_SET_DL_SRC:
444
str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
669
error = str_to_mac(arg, ofpact_put_SET_ETH_SRC(ofpacts)->mac);
447
672
case OFPUTIL_OFPAT10_SET_DL_DST:
448
673
case OFPUTIL_OFPAT11_SET_DL_DST:
449
str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
674
error = str_to_mac(arg, ofpact_put_SET_ETH_DST(ofpacts)->mac);
452
677
case OFPUTIL_OFPAT10_SET_NW_SRC:
453
678
case OFPUTIL_OFPAT11_SET_NW_SRC:
455
ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4 = ip;
679
error = str_to_ip(arg, &ofpact_put_SET_IPV4_SRC(ofpacts)->ipv4);
458
682
case OFPUTIL_OFPAT10_SET_NW_DST:
459
683
case OFPUTIL_OFPAT11_SET_NW_DST:
461
ofpact_put_SET_IPV4_DST(ofpacts)->ipv4 = ip;
684
error = str_to_ip(arg, &ofpact_put_SET_IPV4_DST(ofpacts)->ipv4);
464
687
case OFPUTIL_OFPAT10_SET_NW_TOS:
465
688
case OFPUTIL_OFPAT11_SET_NW_TOS:
466
tos = str_to_u32(arg);
689
error = str_to_u8(arg, "TOS", &tos);
467
694
if (tos & ~IP_DSCP_MASK) {
468
ovs_fatal(0, "%s: not a valid TOS", arg);
695
return xasprintf("%s: not a valid TOS", arg);
470
697
ofpact_put_SET_IPV4_DSCP(ofpacts)->dscp = tos;
476
703
case OFPUTIL_OFPAT10_SET_TP_SRC:
477
704
case OFPUTIL_OFPAT11_SET_TP_SRC:
478
ofpact_put_SET_L4_SRC_PORT(ofpacts)->port = str_to_u32(arg);
705
error = str_to_u16(arg, "source port",
706
&ofpact_put_SET_L4_SRC_PORT(ofpacts)->port);
481
709
case OFPUTIL_OFPAT10_SET_TP_DST:
482
710
case OFPUTIL_OFPAT11_SET_TP_DST:
483
ofpact_put_SET_L4_DST_PORT(ofpacts)->port = str_to_u32(arg);
711
error = str_to_u16(arg, "destination port",
712
&ofpact_put_SET_L4_DST_PORT(ofpacts)->port);
486
715
case OFPUTIL_OFPAT10_ENQUEUE:
487
parse_enqueue(arg, ofpacts);
716
error = parse_enqueue(arg, ofpacts);
490
719
case OFPUTIL_NXAST_RESUBMIT:
491
parse_resubmit(arg, ofpacts);
720
error = parse_resubmit(arg, ofpacts);
494
723
case OFPUTIL_NXAST_SET_TUNNEL:
495
724
case OFPUTIL_NXAST_SET_TUNNEL64:
496
725
tunnel = ofpact_put_SET_TUNNEL(ofpacts);
497
726
tunnel->ofpact.compat = code;
498
tunnel->tun_id = str_to_u64(arg);
727
error = str_to_u64(arg, &tunnel->tun_id);
501
730
case OFPUTIL_NXAST_WRITE_METADATA:
502
parse_metadata(ofpacts, arg);
731
error = parse_metadata(ofpacts, arg);
505
734
case OFPUTIL_NXAST_SET_QUEUE:
506
ofpact_put_SET_QUEUE(ofpacts)->queue_id = str_to_u32(arg);
735
error = str_to_u32(arg, &ofpact_put_SET_QUEUE(ofpacts)->queue_id);
509
738
case OFPUTIL_NXAST_POP_QUEUE:
513
742
case OFPUTIL_NXAST_REG_MOVE:
514
nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
743
error = nxm_parse_reg_move(ofpact_put_REG_MOVE(ofpacts), arg);
517
746
case OFPUTIL_NXAST_REG_LOAD:
518
nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
747
error = nxm_parse_reg_load(ofpact_put_REG_LOAD(ofpacts), arg);
521
750
case OFPUTIL_NXAST_NOTE:
522
parse_note(arg, ofpacts);
751
error = parse_note(arg, ofpacts);
525
754
case OFPUTIL_NXAST_MULTIPATH:
526
multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
529
case OFPUTIL_NXAST_AUTOPATH__DEPRECATED:
530
autopath_parse(ofpact_put_AUTOPATH(ofpacts), arg);
755
error = multipath_parse(ofpact_put_MULTIPATH(ofpacts), arg);
533
758
case OFPUTIL_NXAST_BUNDLE:
534
bundle_parse(arg, ofpacts);
759
error = bundle_parse(arg, ofpacts);
537
762
case OFPUTIL_NXAST_BUNDLE_LOAD:
538
bundle_parse_load(arg, ofpacts);
763
error = bundle_parse_load(arg, ofpacts);
541
766
case OFPUTIL_NXAST_RESUBMIT_TABLE:
554
779
case OFPUTIL_NXAST_DEC_TTL:
555
parse_dec_ttl(ofpacts, arg);
780
error = parse_dec_ttl(ofpacts, arg);
783
case OFPUTIL_NXAST_SET_MPLS_TTL:
784
case OFPUTIL_OFPAT11_SET_MPLS_TTL:
785
error = parse_set_mpls_ttl(ofpacts, arg);
788
case OFPUTIL_OFPAT11_DEC_MPLS_TTL:
789
case OFPUTIL_NXAST_DEC_MPLS_TTL:
790
ofpact_put_DEC_MPLS_TTL(ofpacts);
558
793
case OFPUTIL_NXAST_FIN_TIMEOUT:
559
parse_fin_timeout(ofpacts, arg);
794
error = parse_fin_timeout(ofpacts, arg);
562
797
case OFPUTIL_NXAST_CONTROLLER:
563
parse_controller(ofpacts, arg);
798
error = parse_controller(ofpacts, arg);
801
case OFPUTIL_OFPAT11_PUSH_MPLS:
802
case OFPUTIL_NXAST_PUSH_MPLS:
803
error = str_to_u16(arg, "push_mpls", ðertype);
805
ofpact_put_PUSH_MPLS(ofpacts)->ethertype = htons(ethertype);
809
case OFPUTIL_OFPAT11_POP_MPLS:
810
case OFPUTIL_NXAST_POP_MPLS:
811
error = str_to_u16(arg, "pop_mpls", ðertype);
813
ofpact_put_POP_MPLS(ofpacts)->ethertype = htons(ethertype);
817
case OFPUTIL_NXAST_STACK_PUSH:
818
error = nxm_parse_stack_action(ofpact_put_STACK_PUSH(ofpacts), arg);
820
case OFPUTIL_NXAST_STACK_POP:
821
error = nxm_parse_stack_action(ofpact_put_STACK_POP(ofpacts), arg);
824
case OFPUTIL_NXAST_SAMPLE:
825
error = parse_sample(ofpacts, arg);
830
ofpacts->size = orig_size;
569
str_to_ofpact__(const struct flow *flow, char *pos, char *act, char *arg,
835
/* Parses action 'act', with argument 'arg', and appends a parsed version to
838
* 'n_actions' specifies the number of actions already parsed (for proper
839
* handling of "drop" actions).
841
* Returns NULL if successful, otherwise a malloc()'d string describing the
842
* error. The caller is responsible for freeing the returned string. */
843
static char * WARN_UNUSED_RESULT
844
str_to_ofpact__(char *pos, char *act, char *arg,
570
845
struct ofpbuf *ofpacts, int n_actions)
572
847
int code = ofputil_action_code_from_name(act);
574
parse_named_action(code, flow, arg, ofpacts);
849
return parse_named_action(code, arg, ofpacts);
575
850
} else if (!strcasecmp(act, "drop")) {
577
ovs_fatal(0, "Drop actions must not be preceded by other "
852
return xstrdup("Drop actions must not be preceded by other "
579
854
} else if (ofputil_parse_key_value(&pos, &act, &arg)) {
580
ovs_fatal(0, "Drop actions must not be followed by other "
855
return xstrdup("Drop actions must not be followed by other "
586
860
if (ofputil_port_from_string(act, &port)) {
587
861
ofpact_put_OUTPUT(ofpacts)->port = port;
589
ovs_fatal(0, "Unknown action: %s", act);
863
return xasprintf("Unknown action: %s", act);
597
str_to_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
870
/* Parses 'str' as a series of actions, and appends them to 'ofpacts'.
872
* Returns NULL if successful, otherwise a malloc()'d string describing the
873
* error. The caller is responsible for freeing the returned string. */
874
static char * WARN_UNUSED_RESULT
875
str_to_ofpacts(char *str, struct ofpbuf *ofpacts)
877
size_t orig_size = ofpacts->size;
599
878
char *pos, *act, *arg;
600
879
enum ofperr error;
631
920
case OVSINST_OFPIT11_WRITE_ACTIONS:
633
ovs_fatal(0, "instruction write-actions is not supported yet");
922
error_s = xstrdup("instruction write-actions is not supported yet");
636
925
case OVSINST_OFPIT11_CLEAR_ACTIONS:
637
926
ofpact_put_CLEAR_ACTIONS(ofpacts);
929
case OVSINST_OFPIT13_METER:
930
error_s = str_to_u32(arg, &ofpact_put_METER(ofpacts)->meter_id);
640
933
case OVSINST_OFPIT11_WRITE_METADATA:
641
parse_metadata(ofpacts, arg);
934
error_s = parse_metadata(ofpacts, arg);
644
937
case OVSINST_OFPIT11_GOTO_TABLE: {
645
938
struct ofpact_goto_table *ogt = ofpact_put_GOTO_TABLE(ofpacts);
646
939
char *table_s = strsep(&arg, ",");
647
940
if (!table_s || !table_s[0]) {
648
ovs_fatal(0, "instruction goto-table needs table id");
941
return xstrdup("instruction goto-table needs table id");
650
ogt->table_id = str_to_table_id(table_s);
943
error_s = str_to_u8(table_s, "table", &ogt->table_id);
655
952
/* If write_metadata is specified as an action AND an instruction, ofpacts
656
953
could be invalid. */
657
954
error = ofpacts_verify(ofpacts->data, ofpacts->size);
659
ovs_fatal(0, "Incorrect instruction ordering");
956
return xstrdup("Incorrect instruction ordering");
664
str_to_inst_ofpacts(const struct flow *flow, char *str, struct ofpbuf *ofpacts)
961
/* Parses 'str' as a series of instructions, and appends them to 'ofpacts'.
963
* Returns NULL if successful, otherwise a malloc()'d string describing the
964
* error. The caller is responsible for freeing the returned string. */
965
static char * WARN_UNUSED_RESULT
966
str_to_inst_ofpacts(char *str, struct ofpbuf *ofpacts)
968
size_t orig_size = ofpacts->size;
666
969
char *pos, *inst, *arg;
668
971
const char *prev_inst = NULL;
743
ofp_fatal(const char *flow, bool verbose, const char *format, ...)
748
fprintf(stderr, "%s:\n", flow);
751
va_start(args, format);
752
ovs_fatal_valist(0, format, args);
1058
/* Parses 's' as the (possibly masked) value of field 'mf', and updates
1059
* 'match' appropriately.
1061
* Returns NULL if successful, otherwise a malloc()'d string describing the
1062
* error. The caller is responsible for freeing the returned string. */
1063
static char * WARN_UNUSED_RESULT
756
1064
parse_field(const struct mf_field *mf, const char *s, struct match *match)
758
1066
union mf_value value, mask;
761
1069
error = mf_parse(mf, s, &value, &mask);
763
ovs_fatal(0, "%s", error);
1071
mf_set(mf, &value, &mask, match);
766
mf_set(mf, &value, &mask, match);
769
/* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
770
* page) into 'fm' for sending the specified flow_mod 'command' to a switch.
771
* If 'actions' is specified, an action must be in 'string' and may be expanded
774
* To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
775
* constant for 'command'. To parse syntax for an OFPST_FLOW or
776
* OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'. */
778
parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_,
1076
static char * WARN_UNUSED_RESULT
1077
parse_ofp_str__(struct ofputil_flow_mod *fm, int command, char *string)
782
1080
F_OUT_PORT = 1 << 0,
875
1174
value = strtok_r(NULL, ", \t\r\n", &save_ptr);
877
ofp_fatal(str_, verbose, "field %s missing value", name);
1176
return xasprintf("field %s missing value", name);
880
1179
if (!strcmp(name, "table")) {
881
fm->table_id = str_to_table_id(value);
1180
error = str_to_u8(value, "table", &fm->table_id);
882
1181
} else if (!strcmp(name, "out_port")) {
883
if (!ofputil_port_from_string(name, &fm->out_port)) {
884
ofp_fatal(str_, verbose, "%s is not a valid OpenFlow port",
1182
if (!ofputil_port_from_string(value, &fm->out_port)) {
1183
error = xasprintf("%s is not a valid OpenFlow port",
887
1186
} else if (fields & F_PRIORITY && !strcmp(name, "priority")) {
888
fm->priority = str_to_u16(value, name);
1189
error = str_to_u16(value, name, &priority);
1190
fm->priority = priority;
889
1191
} else if (fields & F_TIMEOUT && !strcmp(name, "idle_timeout")) {
890
fm->idle_timeout = str_to_u16(value, name);
1192
error = str_to_u16(value, name, &fm->idle_timeout);
891
1193
} else if (fields & F_TIMEOUT && !strcmp(name, "hard_timeout")) {
892
fm->hard_timeout = str_to_u16(value, name);
1194
error = str_to_u16(value, name, &fm->hard_timeout);
893
1195
} else if (!strcmp(name, "cookie")) {
894
1196
char *mask = strchr(value, '/');
897
1199
/* A mask means we're searching for a cookie. */
898
1200
if (command == OFPFC_ADD) {
899
ofp_fatal(str_, verbose, "flow additions cannot use "
1201
return xstrdup("flow additions cannot use "
903
fm->cookie = htonll(str_to_u64(value));
904
fm->cookie_mask = htonll(str_to_u64(mask+1));
1205
error = str_to_be64(value, &fm->cookie);
1209
error = str_to_be64(mask + 1, &fm->cookie_mask);
906
1211
/* No mask means that the cookie is being set. */
907
1212
if (command != OFPFC_ADD && command != OFPFC_MODIFY
908
&& command != OFPFC_MODIFY_STRICT) {
909
ofp_fatal(str_, verbose, "cannot set cookie");
1213
&& command != OFPFC_MODIFY_STRICT) {
1214
return xstrdup("cannot set cookie");
911
fm->new_cookie = htonll(str_to_u64(value));
1216
error = str_to_be64(value, &fm->new_cookie);
1217
fm->modify_cookie = true;
913
1219
} else if (mf_from_name(name)) {
914
parse_field(mf_from_name(name), value, &fm->match);
1220
error = parse_field(mf_from_name(name), value, &fm->match);
915
1221
} else if (!strcmp(name, "duration")
916
1222
|| !strcmp(name, "n_packets")
917
1223
|| !strcmp(name, "n_bytes")
944
1270
fm->ofpacts = NULL;
950
/* Convert 'str_' (as described in the documentation for the "monitor" command
951
* in the ovs-ofctl man page) into 'fmr'. */
953
parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
1276
/* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1277
* page) into 'fm' for sending the specified flow_mod 'command' to a switch.
1279
* To parse syntax for an OFPT_FLOW_MOD (or NXT_FLOW_MOD), use an OFPFC_*
1280
* constant for 'command'. To parse syntax for an OFPST_FLOW or
1281
* OFPST_AGGREGATE (or NXST_FLOW or NXST_AGGREGATE), use -1 for 'command'.
1283
* Returns NULL if successful, otherwise a malloc()'d string describing the
1284
* error. The caller is responsible for freeing the returned string. */
1285
char * WARN_UNUSED_RESULT
1286
parse_ofp_str(struct ofputil_flow_mod *fm, int command, const char *str_)
958
1288
char *string = xstrdup(str_);
959
char *save_ptr = NULL;
1291
error = parse_ofp_str__(fm, command, string);
1294
fm->ofpacts_len = 0;
1301
static char * WARN_UNUSED_RESULT
1302
parse_ofp_meter_mod_str__(struct ofputil_meter_mod *mm, char *string,
1303
struct ofpbuf *bands, int command)
1310
char *save_ptr = NULL;
1311
char *band_str = NULL;
1320
fields = F_METER | F_FLAGS | F_BANDS;
1323
case OFPMC13_DELETE:
1327
case OFPMC13_MODIFY:
1328
fields = F_METER | F_FLAGS | F_BANDS;
1335
mm->command = command;
1336
mm->meter.meter_id = 0;
1337
mm->meter.flags = 0;
1338
if (fields & F_BANDS) {
1339
band_str = strstr(string, "band");
1341
return xstrdup("must specify bands");
1345
band_str = strchr(band_str + 1, '=');
1347
return xstrdup("must specify bands");
1352
for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
1353
name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1355
if (fields & F_FLAGS && !strcmp(name, "kbps")) {
1356
mm->meter.flags |= OFPMF13_KBPS;
1357
} else if (fields & F_FLAGS && !strcmp(name, "pktps")) {
1358
mm->meter.flags |= OFPMF13_PKTPS;
1359
} else if (fields & F_FLAGS && !strcmp(name, "burst")) {
1360
mm->meter.flags |= OFPMF13_BURST;
1361
} else if (fields & F_FLAGS && !strcmp(name, "stats")) {
1362
mm->meter.flags |= OFPMF13_STATS;
1366
value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1368
return xasprintf("field %s missing value", name);
1371
if (!strcmp(name, "meter")) {
1372
if (!strcmp(value, "all")) {
1373
mm->meter.meter_id = OFPM13_ALL;
1374
} else if (!strcmp(value, "controller")) {
1375
mm->meter.meter_id = OFPM13_CONTROLLER;
1376
} else if (!strcmp(value, "slowpath")) {
1377
mm->meter.meter_id = OFPM13_SLOWPATH;
1379
char *error = str_to_u32(value, &mm->meter.meter_id);
1383
if (mm->meter.meter_id > OFPM13_MAX) {
1384
return xasprintf("invalid value for %s", name);
1388
return xasprintf("unknown keyword %s", name);
1392
if (fields & F_METER && !mm->meter.meter_id) {
1393
return xstrdup("must specify 'meter'");
1395
if (fields & F_FLAGS && !mm->meter.flags) {
1396
return xstrdup("meter must specify either 'kbps' or 'pktps'");
1399
if (fields & F_BANDS) {
1400
uint16_t n_bands = 0;
1401
struct ofputil_meter_band *band = NULL;
1404
for (name = strtok_r(band_str, "=, \t\r\n", &save_ptr); name;
1405
name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
1409
value = strtok_r(NULL, ", \t\r\n", &save_ptr);
1411
return xasprintf("field %s missing value", name);
1414
if (!strcmp(name, "type")) {
1415
/* Start a new band */
1416
band = ofpbuf_put_zeros(bands, sizeof *band);
1419
if (!strcmp(value, "drop")) {
1420
band->type = OFPMBT13_DROP;
1421
} else if (!strcmp(value, "dscp_remark")) {
1422
band->type = OFPMBT13_DSCP_REMARK;
1424
return xasprintf("field %s unknown value %s", name, value);
1426
} else if (!band || !band->type) {
1427
return xstrdup("band must start with the 'type' keyword");
1428
} else if (!strcmp(name, "rate")) {
1429
char *error = str_to_u32(value, &band->rate);
1433
} else if (!strcmp(name, "burst_size")) {
1434
char *error = str_to_u32(value, &band->burst_size);
1438
} else if (!strcmp(name, "prec_level")) {
1439
char *error = str_to_u8(value, name, &band->prec_level);
1444
return xasprintf("unknown keyword %s", name);
1447
/* validate bands */
1449
return xstrdup("meter must have bands");
1452
mm->meter.n_bands = n_bands;
1453
mm->meter.bands = ofpbuf_steal_data(bands);
1455
for (i = 0; i < n_bands; ++i) {
1456
band = &mm->meter.bands[i];
1459
return xstrdup("band must have 'type'");
1461
if (band->type == OFPMBT13_DSCP_REMARK) {
1462
if (!band->prec_level) {
1463
return xstrdup("'dscp_remark' band must have"
1467
if (band->prec_level) {
1468
return xstrdup("Only 'dscp_remark' band may have"
1473
return xstrdup("band must have 'rate'");
1475
if (mm->meter.flags & OFPMF13_BURST) {
1476
if (!band->burst_size) {
1477
return xstrdup("band must have 'burst_size' "
1478
"when 'burst' flag is set");
1481
if (band->burst_size) {
1482
return xstrdup("band may have 'burst_size' only "
1483
"when 'burst' flag is set");
1488
mm->meter.n_bands = 0;
1489
mm->meter.bands = NULL;
1495
/* Convert 'str_' (as described in the Flow Syntax section of the ovs-ofctl man
1496
* page) into 'mm' for sending the specified meter_mod 'command' to a switch.
1498
* Returns NULL if successful, otherwise a malloc()'d string describing the
1499
* error. The caller is responsible for freeing the returned string. */
1500
char * WARN_UNUSED_RESULT
1501
parse_ofp_meter_mod_str(struct ofputil_meter_mod *mm, const char *str_,
1504
struct ofpbuf bands;
1508
ofpbuf_init(&bands, 64);
1509
string = xstrdup(str_);
1511
error = parse_ofp_meter_mod_str__(mm, string, &bands, command);
1514
ofpbuf_uninit(&bands);
1519
static char * WARN_UNUSED_RESULT
1520
parse_flow_monitor_request__(struct ofputil_flow_monitor_request *fmr,
1521
const char *str_, char *string)
1523
static atomic_uint32_t id = ATOMIC_VAR_INIT(0);
1524
char *save_ptr = NULL;
1527
atomic_add(&id, 1, &fmr->id);
963
1529
fmr->flags = (NXFMF_INITIAL | NXFMF_ADD | NXFMF_DELETE | NXFMF_MODIFY
964
1530
| NXFMF_OWN | NXFMF_ACTIONS);
965
1531
fmr->out_port = OFPP_NONE;
993
1559
value = strtok_r(NULL, ", \t\r\n", &save_ptr);
995
ovs_fatal(0, "%s: field %s missing value", str_, name);
1561
return xasprintf("%s: field %s missing value", str_, name);
998
1564
if (!strcmp(name, "table")) {
999
fmr->table_id = str_to_table_id(value);
1565
char *error = str_to_u8(value, "table", &fmr->table_id);
1000
1569
} else if (!strcmp(name, "out_port")) {
1001
fmr->out_port = atoi(value);
1570
fmr->out_port = u16_to_ofp(atoi(value));
1002
1571
} else if (mf_from_name(name)) {
1003
parse_field(mf_from_name(name), value, &fmr->match);
1574
error = parse_field(mf_from_name(name), value, &fmr->match);
1005
ovs_fatal(0, "%s: unknown keyword %s", str_, name);
1579
return xasprintf("%s: unknown keyword %s", str_, name);
1586
/* Convert 'str_' (as described in the documentation for the "monitor" command
1587
* in the ovs-ofctl man page) into 'fmr'.
1589
* Returns NULL if successful, otherwise a malloc()'d string describing the
1590
* error. The caller is responsible for freeing the returned string. */
1591
char * WARN_UNUSED_RESULT
1592
parse_flow_monitor_request(struct ofputil_flow_monitor_request *fmr,
1595
char *string = xstrdup(str_);
1596
char *error = parse_flow_monitor_request__(fmr, str_, string);
1012
1601
/* Parses 's' as a set of OpenFlow actions and appends the actions to
1015
* Prints an error on stderr and aborts the program if 's' syntax is
1604
* Returns NULL if successful, otherwise a malloc()'d string describing the
1605
* error. The caller is responsible for freeing the returned string. */
1606
char * WARN_UNUSED_RESULT
1018
1607
parse_ofpacts(const char *s_, struct ofpbuf *ofpacts)
1020
1609
char *s = xstrdup(s_);
1021
str_to_ofpacts(NULL, s, ofpacts);
1610
char *error = str_to_ofpacts(s, ofpacts);
1025
1616
/* Parses 'string' as an OFPT_FLOW_MOD or NXT_FLOW_MOD with command 'command'
1026
* (one of OFPFC_*) into 'fm'. */
1617
* (one of OFPFC_*) into 'fm'.
1619
* Returns NULL if successful, otherwise a malloc()'d string describing the
1620
* error. The caller is responsible for freeing the returned string. */
1621
char * WARN_UNUSED_RESULT
1028
1622
parse_ofp_flow_mod_str(struct ofputil_flow_mod *fm, const char *string,
1029
uint16_t command, bool verbose)
1031
struct match match_copy;
1033
parse_ofp_str(fm, command, string, verbose);
1035
/* Normalize a copy of the match. This ensures that non-normalized flows
1036
* get logged but doesn't affect what gets sent to the switch, so that the
1037
* switch can do whatever it likes with the flow. */
1038
match_copy = fm->match;
1039
ofputil_normalize_match(&match_copy);
1625
char *error = parse_ofp_str(fm, command, string);
1627
/* Normalize a copy of the match. This ensures that non-normalized
1628
* flows get logged but doesn't affect what gets sent to the switch, so
1629
* that the switch can do whatever it likes with the flow. */
1630
struct match match_copy = fm->match;
1631
ofputil_normalize_match(&match_copy);
1637
/* Opens file 'file_name' and reads each line as a flow_mod of the specified
1638
* type (one of OFPFC_*). Stores each flow_mod in '*fm', an array allocated
1639
* on the caller's behalf, and the number of flow_mods in '*n_fms'.
1641
* Returns NULL if successful, otherwise a malloc()'d string describing the
1642
* error. The caller is responsible for freeing the returned string. */
1643
char * WARN_UNUSED_RESULT
1043
1644
parse_ofp_flow_mod_file(const char *file_name, uint16_t command,
1044
1645
struct ofputil_flow_mod **fms, size_t *n_fms)
1046
1647
size_t allocated_fms;
1050
1655
stream = !strcmp(file_name, "-") ? stdin : fopen(file_name, "r");
1051
1656
if (stream == NULL) {
1052
ovs_fatal(errno, "%s: open", file_name);
1657
return xasprintf("%s: open failed (%s)",
1658
file_name, ovs_strerror(errno));
1055
1661
allocated_fms = *n_fms;
1057
while (!ds_get_preprocessed_line(&s, stream)) {
1664
while (!ds_get_preprocessed_line(&s, stream, &line_number)) {
1058
1667
if (*n_fms >= allocated_fms) {
1059
1668
*fms = x2nrealloc(*fms, &allocated_fms, sizeof **fms);
1061
parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command, false);
1670
error = parse_ofp_flow_mod_str(&(*fms)[*n_fms], ds_cstr(&s), command);
1674
for (i = 0; i < *n_fms; i++) {
1675
free((*fms)[i].ofpacts);
1682
if (stream != stdin) {
1686
return xasprintf("%s:%d: %s", file_name, line_number, error);
1064
1691
ds_destroy(&s);
1066
1692
if (stream != stdin) {
1067
1693
fclose(stream);
1698
char * WARN_UNUSED_RESULT
1072
1699
parse_ofp_flow_stats_request_str(struct ofputil_flow_stats_request *fsr,
1073
1700
bool aggregate, const char *string)
1075
1702
struct ofputil_flow_mod fm;
1077
parse_ofp_str(&fm, -1, string, false);
1705
error = parse_ofp_str(&fm, -1, string);
1078
1710
fsr->aggregate = aggregate;
1079
1711
fsr->cookie = fm.cookie;
1080
1712
fsr->cookie_mask = fm.cookie_mask;
1081
1713
fsr->match = fm.match;
1082
1714
fsr->out_port = fm.out_port;
1083
1715
fsr->table_id = fm.table_id;
1086
1719
/* Parses a specification of a flow from 's' into 'flow'. 's' must take the