/*
- * Copyright (c) 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
+ * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include "openflow/nicira-ext.h"
#include "packets.h"
#include "shash.h"
+#include "tun-metadata.h"
#include "unaligned.h"
#include "util.h"
#include "openvswitch/vlog.h"
static int nxm_field(uint64_t header) { return (header >> 41) & 0x7f; }
static bool nxm_hasmask(uint64_t header) { return (header >> 40) & 1; }
static int nxm_length(uint64_t header) { return (header >> 32) & 0xff; }
+static uint64_t nxm_no_len(uint64_t header) { return header & 0xffffff80ffffffffULL; }
static bool
is_experimenter_oxm(uint64_t header)
enum ofp_version);
static void nx_put_header__(struct ofpbuf *, uint64_t header, bool masked);
+static void nx_put_header_len(struct ofpbuf *, enum mf_field_id field,
+ enum ofp_version version, bool masked,
+ size_t n_bytes);
/* Rate limit for nx_match parse errors. These always indicate a bug in the
* peer and so there's not much point in showing a lot of them. */
nx_pull_header__(struct ofpbuf *b, bool allow_cookie, uint64_t *header,
const struct mf_field **field)
{
- if (ofpbuf_size(b) < 4) {
+ if (b->size < 4) {
goto bad_len;
}
- *header = ((uint64_t) ntohl(get_unaligned_be32(ofpbuf_data(b)))) << 32;
+ *header = ((uint64_t) ntohl(get_unaligned_be32(b->data))) << 32;
if (is_experimenter_oxm(*header)) {
- if (ofpbuf_size(b) < 8) {
+ if (b->size < 8) {
goto bad_len;
}
- *header = ntohll(get_unaligned_be64(ofpbuf_data(b)));
+ *header = ntohll(get_unaligned_be64(b->data));
}
- if (nxm_length(*header) <= nxm_experimenter_len(*header)) {
+ if (nxm_length(*header) < nxm_experimenter_len(*header)) {
VLOG_WARN_RL(&rl, "OXM header "NXM_HEADER_FMT" has invalid length %d "
"(minimum is %d)",
NXM_HEADER_ARGS(*header), nxm_length(*header),
- nxm_header_len(*header) + 1);
+ nxm_header_len(*header));
goto error;
}
ofpbuf_pull(b, nxm_header_len(*header));
bad_len:
VLOG_DBG_RL(&rl, "encountered partial (%"PRIu32"-byte) OXM entry",
- ofpbuf_size(b));
+ b->size);
error:
*header = 0;
- *field = NULL;
+ if (field) {
+ *field = NULL;
+ }
return OFPERR_OFPBMC_BAD_LEN;
}
+static void
+copy_entry_value(const struct mf_field *field, union mf_value *value,
+ const uint8_t *payload, int width)
+{
+ int copy_len;
+ void *copy_dst;
+
+ copy_dst = value;
+ copy_len = MIN(width, field ? field->n_bytes : sizeof *value);
+
+ if (field && field->variable_len) {
+ memset(value, 0, field->n_bytes);
+ copy_dst = &value->u8 + field->n_bytes - copy_len;
+ }
+
+ memcpy(copy_dst, payload, copy_len);
+}
+
static enum ofperr
nx_pull_entry__(struct ofpbuf *b, bool allow_cookie, uint64_t *header,
- const struct mf_field **field,
+ const struct mf_field **field_,
union mf_value *value, union mf_value *mask)
{
+ const struct mf_field *field;
enum ofperr header_error;
unsigned int payload_len;
const uint8_t *payload;
int width;
- header_error = nx_pull_header__(b, allow_cookie, header, field);
+ header_error = nx_pull_header__(b, allow_cookie, header, &field);
if (header_error && header_error != OFPERR_OFPBMC_BAD_FIELD) {
return header_error;
}
if (!payload) {
VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" calls for %u-byte "
"payload but only %"PRIu32" bytes follow OXM header",
- NXM_HEADER_ARGS(*header), payload_len, ofpbuf_size(b));
+ NXM_HEADER_ARGS(*header), payload_len, b->size);
return OFPERR_OFPBMC_BAD_LEN;
}
return OFPERR_OFPBMC_BAD_WILDCARDS;
}
- memcpy(value, payload, MIN(width, sizeof *value));
+ copy_entry_value(field, value, payload, width);
+
if (mask) {
if (nxm_hasmask(*header)) {
- memcpy(mask, payload + width, MIN(width, sizeof *mask));
+ copy_entry_value(field, mask, payload + width, width);
} else {
- memset(mask, 0xff, MIN(width, sizeof *mask));
+ memset(mask, 0xff, sizeof *mask);
}
} else if (nxm_hasmask(*header)) {
VLOG_DBG_RL(&rl, "OXM header "NXM_HEADER_FMT" includes mask but "
return OFPERR_OFPBMC_BAD_MASK;
}
- return header_error;
+ if (field_) {
+ *field_ = field;
+ return header_error;
+ }
+
+ return 0;
}
/* Attempts to pull an NXM or OXM header, value, and mask (if present) from the
}
ofpbuf_use_const(&b, p, match_len);
- while (ofpbuf_size(&b)) {
- const uint8_t *pos = ofpbuf_data(&b);
+ while (b.size) {
+ const uint8_t *pos = b.data;
const struct mf_field *field;
union mf_value value;
union mf_value mask;
} else if (!mf_is_all_wild(field, &match->wc)) {
error = OFPERR_OFPBMC_DUP_FIELD;
} else {
- mf_set(field, &value, &mask, match);
+ char *err_str;
+
+ mf_set(field, &value, &mask, match, &err_str);
+ if (err_str) {
+ VLOG_DBG_RL(&rl, "error parsing OXM at offset %"PRIdPTR" "
+ "within match (%s)", pos - p, err_str);
+ free(err_str);
+ return OFPERR_OFPBMC_BAD_VALUE;
+ }
}
if (error) {
if (!p) {
VLOG_DBG_RL(&rl, "nx_match length %u, rounded up to a "
"multiple of 8, is longer than space in message (max "
- "length %"PRIu32")", match_len, ofpbuf_size(b));
+ "length %"PRIu32")", match_len, b->size);
return OFPERR_OFPBMC_BAD_LEN;
}
}
static enum ofperr
oxm_pull_match__(struct ofpbuf *b, bool strict, struct match *match)
{
- struct ofp11_match_header *omh = ofpbuf_data(b);
+ struct ofp11_match_header *omh = b->data;
uint8_t *p;
uint16_t match_len;
- if (ofpbuf_size(b) < sizeof *omh) {
+ if (b->size < sizeof *omh) {
return OFPERR_OFPBMC_BAD_LEN;
}
if (!p) {
VLOG_DBG_RL(&rl, "oxm length %u, rounded up to a "
"multiple of 8, is longer than space in message (max "
- "length %"PRIu32")", match_len, ofpbuf_size(b));
+ "length %"PRIu32")", match_len, b->size);
return OFPERR_OFPBMC_BAD_LEN;
}
{
return oxm_pull_match__(b, false, match);
}
+
+/* Verify an array of OXM TLVs treating value of each TLV as a mask,
+ * disallowing masks in each TLV and ignoring pre-requisites. */
+enum ofperr
+oxm_pull_field_array(const void *fields_data, size_t fields_len,
+ struct field_array *fa)
+{
+ struct ofpbuf b;
+
+ ofpbuf_use_const(&b, fields_data, fields_len);
+ while (b.size) {
+ const uint8_t *pos = b.data;
+ const struct mf_field *field;
+ union mf_value value;
+ enum ofperr error;
+ uint64_t header;
+
+ error = nx_pull_entry__(&b, false, &header, &field, &value, NULL);
+ if (error) {
+ VLOG_DBG_RL(&rl, "error pulling field array field");
+ return error;
+ } else if (!field) {
+ VLOG_DBG_RL(&rl, "unknown field array field");
+ error = OFPERR_OFPBMC_BAD_FIELD;
+ } else if (bitmap_is_set(fa->used.bm, field->id)) {
+ VLOG_DBG_RL(&rl, "duplicate field array field '%s'", field->name);
+ error = OFPERR_OFPBMC_DUP_FIELD;
+ } else if (!mf_is_mask_valid(field, &value)) {
+ VLOG_DBG_RL(&rl, "bad mask in field array field '%s'", field->name);
+ return OFPERR_OFPBMC_BAD_MASK;
+ } else {
+ field_array_set(field->id, &value, fa);
+ }
+
+ if (error) {
+ const uint8_t *start = fields_data;
+
+ VLOG_DBG_RL(&rl, "error parsing OXM at offset %"PRIdPTR" "
+ "within field array (%s)", pos - start,
+ ofperr_to_string(error));
+ return error;
+ }
+ }
+
+ return 0;
+}
\f
/* nx_put_match() and helpers.
*
* 'put' functions whose names end in 'm' add a field that might be wildcarded.
* Other 'put' functions add exact-match fields.
*/
-
-static void
-nxm_put_unmasked(struct ofpbuf *b, enum mf_field_id field,
- enum ofp_version version, const void *value, size_t n_bytes)
+void
+nxm_put__(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
+ const void *value, const void *mask, size_t n_bytes)
{
- nx_put_header(b, field, version, false);
+ nx_put_header_len(b, field, version, !!mask, n_bytes);
ofpbuf_put(b, value, n_bytes);
+ if (mask) {
+ ofpbuf_put(b, mask, n_bytes);
+ }
+
}
static void
{
if (!is_all_zeros(mask, n_bytes)) {
bool masked = !is_all_ones(mask, n_bytes);
- nx_put_header(b, field, version, masked);
- ofpbuf_put(b, value, n_bytes);
- if (masked) {
- ofpbuf_put(b, mask, n_bytes);
- }
+ nxm_put__(b, field, version, value, masked ? mask : NULL, n_bytes);
}
}
nxm_put_8(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
uint8_t value)
{
- nxm_put_unmasked(b, field, version, &value, sizeof value);
+ nxm_put__(b, field, version, &value, NULL, sizeof value);
}
static void
nxm_put_16(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
ovs_be16 value)
{
- nxm_put_unmasked(b, field, version, &value, sizeof value);
+ nxm_put__(b, field, version, &value, NULL, sizeof value);
}
static void
nxm_put_32(struct ofpbuf *b, enum mf_field_id field, enum ofp_version version,
ovs_be32 value)
{
- nxm_put_unmasked(b, field, version, &value, sizeof value);
+ nxm_put__(b, field, version, &value, NULL, sizeof value);
}
static void
static void
nxm_put_eth_masked(struct ofpbuf *b,
enum mf_field_id field, enum ofp_version version,
- const uint8_t value[ETH_ADDR_LEN],
- const uint8_t mask[ETH_ADDR_LEN])
+ const struct eth_addr value, const struct eth_addr mask)
{
- nxm_put(b, field, version, value, mask, ETH_ADDR_LEN);
+ nxm_put(b, field, version, value.ea, mask.ea, ETH_ADDR_LEN);
}
static void
ovs_be64 cookie, ovs_be64 cookie_mask)
{
const struct flow *flow = &match->flow;
- const size_t start_len = ofpbuf_size(b);
+ const size_t start_len = b->size;
int match_len;
int i;
- BUILD_ASSERT_DECL(FLOW_WC_SEQ == 28);
+ BUILD_ASSERT_DECL(FLOW_WC_SEQ == 33);
/* Metadata. */
if (match->wc.masks.dp_hash) {
nxm_put_32(b, MFF_RECIRC_ID, oxm, htonl(flow->recirc_id));
}
+ if (match->wc.masks.conj_id) {
+ nxm_put_32(b, MFF_CONJ_ID, oxm, htonl(flow->conj_id));
+ }
+
if (match->wc.masks.in_port.ofp_port) {
ofp_port_t in_port = flow->in_port.ofp_port;
if (oxm) {
flow->tunnel.tun_id, match->wc.masks.tunnel.tun_id);
/* Other tunnel metadata. */
+ nxm_put_16m(b, MFF_TUN_FLAGS, oxm,
+ htons(flow->tunnel.flags), htons(match->wc.masks.tunnel.flags));
nxm_put_32m(b, MFF_TUN_SRC, oxm,
flow->tunnel.ip_src, match->wc.masks.tunnel.ip_src);
nxm_put_32m(b, MFF_TUN_DST, oxm,
flow->tunnel.ip_dst, match->wc.masks.tunnel.ip_dst);
+ nxm_put_16m(b, MFF_TUN_GBP_ID, oxm,
+ flow->tunnel.gbp_id, match->wc.masks.tunnel.gbp_id);
+ nxm_put_8m(b, MFF_TUN_GBP_FLAGS, oxm,
+ flow->tunnel.gbp_flags, match->wc.masks.tunnel.gbp_flags);
+ tun_metadata_to_nx_match(b, oxm, match);
/* Registers. */
if (oxm < OFP15_VERSION) {
}
}
- match_len = ofpbuf_size(b) - start_len;
+ match_len = b->size - start_len;
return match_len;
}
{
int match_len;
struct ofp11_match_header *omh;
- size_t start_len = ofpbuf_size(b);
+ size_t start_len = b->size;
ovs_be64 cookie = htonll(0), cookie_mask = htonll(0);
ofpbuf_put_uninit(b, sizeof *omh);
return match_len;
}
+/* Appends to 'b' the nx_match format that expresses the tlv corresponding
+ * to 'id'. If mask is not all-ones then it is also formated as the value
+ * of the tlv. */
+static void
+nx_format_mask_tlv(struct ds *ds, enum mf_field_id id,
+ const union mf_value *mask)
+{
+ const struct mf_field *mf = mf_from_id(id);
+
+ ds_put_format(ds, "%s", mf->name);
+
+ if (!is_all_ones(mask, mf->n_bytes)) {
+ ds_put_char(ds, '=');
+ mf_format(mf, mask, NULL, ds);
+ }
+
+ ds_put_char(ds, ',');
+}
+
+/* Appends a string representation of 'fa_' to 'ds'.
+ * The TLVS value of 'fa_' is treated as a mask and
+ * only the name of fields is formated if it is all ones. */
+void
+oxm_format_field_array(struct ds *ds, const struct field_array *fa)
+{
+ size_t start_len = ds->length;
+ int i;
+
+ for (i = 0; i < MFF_N_IDS; i++) {
+ if (bitmap_is_set(fa->used.bm, i)) {
+ nx_format_mask_tlv(ds, i, &fa->value[i]);
+ }
+ }
+
+ if (ds->length > start_len) {
+ ds_chomp(ds, ',');
+ }
+}
+
+/* Appends to 'b' a series of OXM TLVs corresponding to the series
+ * of enum mf_field_id and value tuples in 'fa_'.
+ *
+ * OXM differs slightly among versions of OpenFlow. Specify the OpenFlow
+ * version in use as 'version'.
+ *
+ * This function can cause 'b''s data to be reallocated.
+ *
+ * Returns the number of bytes appended to 'b'. May return zero. */
+int
+oxm_put_field_array(struct ofpbuf *b, const struct field_array *fa,
+ enum ofp_version version)
+{
+ size_t start_len = b->size;
+ int i;
+
+ /* Field arrays are only used with the group selection method
+ * property and group properties are only available in OpenFlow 1.5+.
+ * So the following assertion should never fail.
+ *
+ * If support for older OpenFlow versions is desired then some care
+ * will need to be taken of different TLVs that handle the same
+ * flow fields. In particular:
+ * - VLAN_TCI, VLAN_VID and MFF_VLAN_PCP
+ * - IP_DSCP_MASK and DSCP_SHIFTED
+ * - REGS and XREGS
+ */
+ ovs_assert(version >= OFP15_VERSION);
+
+ for (i = 0; i < MFF_N_IDS; i++) {
+ if (bitmap_is_set(fa->used.bm, i)) {
+ int len = mf_field_len(mf_from_id(i), &fa->value[i], NULL, NULL);
+ nxm_put__(b, i, version,
+ &fa->value[i].u8 + mf_from_id(i)->n_bytes - len, NULL,
+ len);
+ }
+ }
+
+ return b->size - start_len;
+}
+
static void
nx_put_header__(struct ofpbuf *b, uint64_t header, bool masked)
{
nx_put_header__(b, mf_oxm_header(field, version), masked);
}
+static void
+nx_put_header_len(struct ofpbuf *b, enum mf_field_id field,
+ enum ofp_version version, bool masked, size_t n_bytes)
+{
+ uint64_t header = mf_oxm_header(field, version);
+
+ header = NXM_HEADER(nxm_vendor(header), nxm_class(header),
+ nxm_field(header), false,
+ nxm_experimenter_len(header) + n_bytes);
+
+ nx_put_header__(b, header, masked);
+}
+
void
nx_put_entry(struct ofpbuf *b,
enum mf_field_id field, enum ofp_version version,
const union mf_value *value, const union mf_value *mask)
{
- int n_bytes = mf_from_id(field)->n_bytes;
- bool masked = mask && !is_all_ones(mask, n_bytes);
+ const struct mf_field *mf = mf_from_id(field);
+ bool masked;
+ int len, offset;
- nx_put_header(b, field, version, masked);
- ofpbuf_put(b, value, n_bytes);
+ len = mf_field_len(mf, value, mask, &masked);
+ offset = mf->n_bytes - len;
+
+ nx_put_header_len(b, field, version, masked, len);
+ ofpbuf_put(b, &value->u8 + offset, len);
if (masked) {
- ofpbuf_put(b, mask, n_bytes);
+ ofpbuf_put(b, &mask->u8 + offset, len);
}
}
\f
ofpbuf_use_const(&b, p, match_len);
ds_init(&s);
- while (ofpbuf_size(&b)) {
+ while (b.size) {
union mf_value value;
union mf_value mask;
enum ofperr error;
ds_put_char(&s, ')');
}
- if (ofpbuf_size(&b)) {
+ if (b.size) {
if (s.length) {
ds_put_cstr(&s, ", ");
}
- ds_put_format(&s, "<%u invalid bytes>", ofpbuf_size(&b));
+ ds_put_format(&s, "<%u invalid bytes>", b.size);
}
return ds_steal_cstr(&s);
char *
oxm_match_to_string(const struct ofpbuf *p, unsigned int match_len)
{
- const struct ofp11_match_header *omh = ofpbuf_data(p);
+ const struct ofp11_match_header *omh = p->data;
uint16_t match_len_;
struct ds s;
nx_match_from_string_raw(const char *s, struct ofpbuf *b)
{
const char *full_s = s;
- const size_t start_len = ofpbuf_size(b);
+ const size_t start_len = b->size;
if (!strcmp(s, "<any>")) {
- /* Ensure that 'ofpbuf_data(b)' isn't actually null. */
+ /* Ensure that 'b->data' isn't actually null. */
ofpbuf_prealloc_tailroom(b, 1);
return 0;
}
for (s += strspn(s, ", "); *s; s += strspn(s, ", ")) {
const char *name;
uint64_t header;
+ ovs_be64 nw_header;
+ ovs_be64 *header_ptr;
int name_len;
size_t n;
s += name_len + 1;
- nx_put_header__(b, header, false);
+ header_ptr = ofpbuf_put_uninit(b, nxm_header_len(header));
s = ofpbuf_put_hex(b, s, &n);
if (n != nxm_field_bytes(header)) {
- ovs_fatal(0, "%.2s: hex digits expected", s);
+ const struct mf_field *field = mf_from_oxm_header(header);
+
+ if (field && field->variable_len) {
+ if (n <= field->n_bytes) {
+ int len = (nxm_hasmask(header) ? n * 2 : n) +
+ nxm_experimenter_len(header);
+
+ header = NXM_HEADER(nxm_vendor(header), nxm_class(header),
+ nxm_field(header),
+ nxm_hasmask(header) ? 1 : 0, len);
+ } else {
+ ovs_fatal(0, "expected to read at most %d bytes but got "
+ "%"PRIuSIZE, field->n_bytes, n);
+ }
+ } else {
+ ovs_fatal(0, "expected to read %d bytes but got %"PRIuSIZE,
+ nxm_field_bytes(header), n);
+ }
}
+ nw_header = htonll(header);
+ memcpy(header_ptr, &nw_header, nxm_header_len(header));
+
if (nxm_hasmask(header)) {
s += strspn(s, " ");
if (*s != '/') {
s++;
}
- return ofpbuf_size(b) - start_len;
+ return b->size - start_len;
}
int
{
int match_len;
struct ofp11_match_header *omh;
- size_t start_len = ofpbuf_size(b);
+ size_t start_len = b->size;
ofpbuf_put_uninit(b, sizeof *omh);
match_len = nx_match_from_string_raw(s, b) + sizeof *omh;
union mf_value src_value;
union mf_value dst_value;
- mf_mask_field_and_prereqs(move->dst.field, &wc->masks);
- mf_mask_field_and_prereqs(move->src.field, &wc->masks);
+ mf_mask_field_and_prereqs(move->dst.field, wc);
+ mf_mask_field_and_prereqs(move->src.field, wc);
/* A flow may wildcard nw_frag. Do nothing if setting a transport
* header field on a packet that does not have them. */
{
union mf_subvalue *v = NULL;
- if (ofpbuf_size(stack)) {
+ if (stack->size) {
- ofpbuf_set_size(stack, ofpbuf_size(stack) - sizeof *v);
+ stack->size -= sizeof *v;
v = (union mf_subvalue *) ofpbuf_tail(stack);
}
} else {
if (!VLOG_DROP_WARN(&rl)) {
char *flow_str = flow_to_string(flow);
- VLOG_WARN_RL(&rl, "Failed to pop from an empty stack. On flow \n"
+ VLOG_WARN_RL(&rl, "Failed to pop from an empty stack. On flow\n"
" %s", flow_str);
free(flow_str);
}
for (struct nxm_field_index *nfi = all_nxm_fields;
nfi < &all_nxm_fields[ARRAY_SIZE(all_nxm_fields)]; nfi++) {
hmap_insert(&nxm_header_map, &nfi->header_node,
- hash_int(nfi->nf.header, 0));
+ hash_uint64(nxm_no_len(nfi->nf.header)));
hmap_insert(&nxm_name_map, &nfi->name_node,
hash_string(nfi->nf.name, 0));
list_push_back(&nxm_mf_map[nfi->nf.id], &nfi->mf_node);
nxm_field_by_header(uint64_t header)
{
const struct nxm_field_index *nfi;
+ uint64_t header_no_len;
nxm_init();
if (nxm_hasmask(header)) {
header = nxm_make_exact_header(header);
}
- HMAP_FOR_EACH_IN_BUCKET (nfi, header_node, hash_int(header, 0),
+ header_no_len = nxm_no_len(header);
+
+ HMAP_FOR_EACH_IN_BUCKET (nfi, header_node, hash_uint64(header_no_len),
&nxm_header_map) {
- if (header == nfi->nf.header) {
- return &nfi->nf;
+ if (header_no_len == nxm_no_len(nfi->nf.header)) {
+ if (nxm_length(header) == nxm_length(nfi->nf.header) ||
+ mf_from_id(nfi->nf.id)->variable_len) {
+ return &nfi->nf;
+ } else {
+ return NULL;
+ }
}
}
return NULL;