/*
- * Copyright (c) 2010, 2011 Nicira Networks.
+ * Copyright (c) 2010, 2011, 2012, 2013, 2014, 2016 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 <stdint.h>
#include <sys/types.h>
#include <netinet/in.h>
+#include "compiler.h"
+#include "flow.h"
+#include "meta-flow.h"
+#include "ofp-errors.h"
#include "openvswitch/types.h"
-struct cls_rule;
struct ds;
-struct flow;
+struct match;
+struct ofpact_reg_move;
+struct ofpact_reg_load;
+struct ofpact_stack;
struct ofpbuf;
struct nx_action_reg_load;
struct nx_action_reg_move;
+
/* Nicira Extended Match (NXM) flexible flow match helper functions.
*
* See include/openflow/nicira-ext.h for NXM specification.
*/
-int nx_pull_match(struct ofpbuf *, unsigned int match_len, uint16_t priority,
- struct cls_rule *);
-int nx_put_match(struct ofpbuf *, const struct cls_rule *);
+void mf_format_subfield(const struct mf_subfield *, struct ds *);
+char *mf_parse_subfield__(struct mf_subfield *sf, const char **s)
+ OVS_WARN_UNUSED_RESULT;
+char *mf_parse_subfield(struct mf_subfield *, const char *s)
+ OVS_WARN_UNUSED_RESULT;
+
+/* Decoding matches. */
+enum ofperr nx_pull_match(struct ofpbuf *, unsigned int match_len,
+ struct match *,
+ ovs_be64 *cookie, ovs_be64 *cookie_mask);
+enum ofperr nx_pull_match_loose(struct ofpbuf *, unsigned int match_len,
+ struct match *, ovs_be64 *cookie,
+ ovs_be64 *cookie_mask);
+enum ofperr oxm_pull_match(struct ofpbuf *, struct match *);
+enum ofperr oxm_pull_match_loose(struct ofpbuf *, struct match *);
+enum ofperr oxm_decode_match(const void *, size_t, struct match *);
+enum ofperr oxm_pull_field_array(const void *, size_t fields_len,
+ struct field_array *);
+
+/* Encoding matches. */
+int nx_put_match(struct ofpbuf *, const struct match *,
+ ovs_be64 cookie, ovs_be64 cookie_mask);
+int oxm_put_match(struct ofpbuf *, const struct match *, enum ofp_version);
+void oxm_put_raw(struct ofpbuf *, const struct match *, enum ofp_version);
+void oxm_format_field_array(struct ds *, const struct field_array *);
+int oxm_put_field_array(struct ofpbuf *, const struct field_array *,
+ enum ofp_version version);
+
+/* Decoding and encoding OXM/NXM headers (just a field ID) or entries (a field
+ * ID followed by a value and possibly a mask). */
+enum ofperr nx_pull_entry(struct ofpbuf *, const struct mf_field **,
+ union mf_value *value, union mf_value *mask);
+enum ofperr nx_pull_header(struct ofpbuf *, const struct mf_field **,
+ bool *masked);
+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);
+void nx_put_entry(struct ofpbuf *, enum mf_field_id, enum ofp_version,
+ const union mf_value *value, const union mf_value *mask);
+void nx_put_header(struct ofpbuf *, enum mf_field_id, enum ofp_version,
+ bool masked);
+
+/* NXM and OXM protocol headers values.
+ *
+ * These are often alternatives to nx_pull_entry/header() and
+ * nx_put_entry/header() for decoding and encoding OXM/NXM. In those cases,
+ * the nx_*() functions should be preferred because they can support the 64-bit
+ * "experimenter" OXM format (even though it is not yet implemented). */
+uint32_t mf_nxm_header(enum mf_field_id);
+const struct mf_field *mf_from_nxm_header(uint32_t nxm_header);
char *nx_match_to_string(const uint8_t *, unsigned int match_len);
+char *oxm_match_to_string(const struct ofpbuf *, unsigned int match_len);
int nx_match_from_string(const char *, struct ofpbuf *);
+int oxm_match_from_string(const char *, struct ofpbuf *);
+
+void nx_format_field_name(enum mf_field_id, enum ofp_version, struct ds *);
+
+char *nxm_parse_reg_move(struct ofpact_reg_move *, const char *)
+ OVS_WARN_UNUSED_RESULT;
+
+void nxm_format_reg_move(const struct ofpact_reg_move *, struct ds *);
-uint64_t nxm_read_field_bits(ovs_be32 header, ovs_be16 ofs_nbits,
- const struct flow *);
+enum ofperr nxm_reg_move_check(const struct ofpact_reg_move *,
+ const struct flow *);
-void nxm_parse_reg_move(struct nx_action_reg_move *, const char *);
-void nxm_parse_reg_load(struct nx_action_reg_load *, const char *);
+void nxm_execute_reg_move(const struct ofpact_reg_move *, struct flow *,
+ struct flow_wildcards *);
+void nxm_reg_load(const struct mf_subfield *, uint64_t src_data,
+ struct flow *, struct flow_wildcards *);
-void nxm_format_reg_move(const struct nx_action_reg_move *, struct ds *);
-void nxm_format_reg_load(const struct nx_action_reg_load *, struct ds *);
+char *nxm_parse_stack_action(struct ofpact_stack *, const char *)
+ OVS_WARN_UNUSED_RESULT;
-int nxm_check_reg_move(const struct nx_action_reg_move *, const struct flow *);
-int nxm_check_reg_load(const struct nx_action_reg_load *, const struct flow *);
-int nxm_src_check(ovs_be32 src, unsigned int ofs, unsigned int n_bits,
- const struct flow *);
-int nxm_dst_check(ovs_be32 dst, unsigned int ofs, unsigned int n_bits,
- const struct flow *);
+void nxm_format_stack_push(const struct ofpact_stack *, struct ds *);
+void nxm_format_stack_pop(const struct ofpact_stack *, struct ds *);
-void nxm_execute_reg_move(const struct nx_action_reg_move *, struct flow *);
-void nxm_execute_reg_load(const struct nx_action_reg_load *, struct flow *);
-void nxm_reg_load(ovs_be32 dst, ovs_be16 ofs_nbits, uint64_t src_data,
- struct flow *);
+enum ofperr nxm_stack_push_check(const struct ofpact_stack *,
+ const struct flow *);
+enum ofperr nxm_stack_pop_check(const struct ofpact_stack *,
+ const struct flow *);
-int nxm_field_bytes(uint32_t header);
-int nxm_field_bits(uint32_t header);
-const struct mf_field *nxm_field_to_mf_field(uint32_t header);
+void nxm_execute_stack_push(const struct ofpact_stack *,
+ const struct flow *, struct flow_wildcards *,
+ struct ofpbuf *);
+void nxm_execute_stack_pop(const struct ofpact_stack *,
+ struct flow *, struct flow_wildcards *,
+ struct ofpbuf *);
-const char *nxm_parse_field_bits(const char *s,
- uint32_t *headerp, int *ofsp, int *n_bitsp);
-void nxm_format_field_bits(struct ds *, uint32_t header, int ofs, int n_bits);
+ovs_be64 oxm_bitmap_from_mf_bitmap(const struct mf_bitmap *, enum ofp_version);
+struct mf_bitmap oxm_bitmap_to_mf_bitmap(ovs_be64 oxm_bitmap,
+ enum ofp_version);
+struct mf_bitmap oxm_writable_fields(void);
+struct mf_bitmap oxm_matchable_fields(void);
+struct mf_bitmap oxm_maskable_fields(void);
-/* Dealing with the 'ofs_nbits' members of struct nx_action_reg_load and struct
- * nx_action_multipath. */
+/* Dealing with the 'ofs_nbits' members in several Nicira extensions. */
static inline ovs_be16
nxm_encode_ofs_nbits(int ofs, int n_bits)
return (ntohs(ofs_nbits) & 0x3f) + 1;
}
\f
-/* Upper bound on the length of an nx_match. The longest nx_match (an
- * IPV6 neighbor discovery message using 5 registers) would be:
- *
- * header value mask total
- * ------ ----- ---- -----
- * NXM_OF_IN_PORT 4 2 -- 6
- * NXM_OF_ETH_DST_W 4 6 6 16
- * NXM_OF_ETH_SRC 4 6 -- 10
- * NXM_OF_ETH_TYPE 4 2 -- 6
- * NXM_OF_VLAN_TCI 4 2 2 8
- * NXM_OF_IP_TOS 4 1 -- 5
- * NXM_NX_IP_ECN 4 1 -- 5
- * NXM_OF_IP_TTL 4 1 -- 5
- * NXM_NX_IP_FRAG 4 1 1 8
- * NXM_OF_IP_PROTO 4 2 -- 6
- * NXM_OF_IPV6_SRC_W 4 16 16 36
- * NXM_OF_IPV6_DST_W 4 16 16 36
- * NXM_OF_IPV6_LABEL 4 4 -- 8
- * NXM_OF_ICMP_TYPE 4 1 -- 5
- * NXM_OF_ICMP_CODE 4 1 -- 5
- * NXM_NX_ND_TARGET 4 16 -- 20
- * NXM_NX_ND_SLL 4 6 -- 10
- * NXM_NX_REG_W(0) 4 4 4 12
- * NXM_NX_REG_W(1) 4 4 4 12
- * NXM_NX_REG_W(2) 4 4 4 12
- * NXM_NX_REG_W(3) 4 4 4 12
- * NXM_NX_REG_W(4) 4 4 4 12
- * NXM_NX_TUN_ID_W 4 8 8 20
- * -------------------------------------------
- * total 275
- *
- * So this value is conservative.
- */
-#define NXM_MAX_LEN 384
-
/* This is my guess at the length of a "typical" nx_match, for use in
* predicting space requirements. */
#define NXM_TYPICAL_LEN 64
projects / cascardo / ovs.git / blobdiff