util: Introduce ASSIGN_CONTAINER to make iteration macros easier to read.

[openvswitch] / lib / ofp-util.h

diff --git a/lib/ofp-util.h b/lib/ofp-util.h
index c5a18975590e054cf54b16fb67507a8225b23f4e..02096b0ba16f3636139aabd7b649c9045cdd1966 100644 (file)
--- a/lib/ofp-util.h
+++ b/lib/ofp-util.h
@@ -22,24 +22,47 @@
 #include <stddef.h>
 #include <stdint.h>
 #include "flow.h"
+#include "openflow/nicira-ext.h"
+#include "openvswitch/types.h"
 
+struct cls_rule;
 struct ofpbuf;
 struct ofp_action_header;
 
+/* Alignment of ofp_actions. */
+#define OFP_ACTION_ALIGN 8
+
+/* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
+ * and from IP bitmasks. */
+ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
+int ofputil_netmask_to_wcbits(ovs_be32 netmask);
+
+/* Work with OpenFlow 1.0 ofp_match. */
+void ofputil_cls_rule_from_match(const struct ofp_match *,
+                                 unsigned int priority, enum nx_flow_format,
+                                 uint64_t cookie, struct cls_rule *);
+void ofputil_cls_rule_to_match(const struct cls_rule *, enum nx_flow_format,
+                               struct ofp_match *);
+void normalize_match(struct ofp_match *);
+char *ofp_match_to_literal_string(const struct ofp_match *match);
+
 /* OpenFlow protocol utility functions. */
 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
+void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
 void *make_openflow_xid(size_t openflow_len, uint8_t type,
-                        uint32_t xid, struct ofpbuf **);
+                        ovs_be32 xid, struct ofpbuf **);
+void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
+                     struct ofpbuf **);
 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
-void *put_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
+void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
                        struct ofpbuf *);
 void update_openflow_length(struct ofpbuf *);
-struct ofpbuf *make_flow_mod(uint16_t command, const struct flow *,
+struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
                              size_t actions_len);
-struct ofpbuf *make_add_flow(const struct flow *, uint32_t buffer_id,
+struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
                              uint16_t max_idle, size_t actions_len);
-struct ofpbuf *make_del_flow(const struct flow *);
-struct ofpbuf *make_add_simple_flow(const struct flow *,
+struct ofpbuf *make_del_flow(const struct cls_rule *);
+struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
                                     uint32_t buffer_id, uint16_t out_port,
                                     uint16_t max_idle);
 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
@@ -59,8 +82,6 @@ int check_ofp_message(const struct ofp_header *, uint8_t type, size_t size);
 int check_ofp_message_array(const struct ofp_header *, uint8_t type,
                             size_t size, size_t array_elt_size,
                             size_t *n_array_elts);
-int check_ofp_packet_out(const struct ofp_header *, struct ofpbuf *data,
-                         int *n_actions, int max_ports);
 
 struct flow_stats_iterator {
     const uint8_t *pos, *end;
@@ -77,11 +98,11 @@ const union ofp_action *actions_first(struct actions_iterator *,
                                       size_t n_actions);
 const union ofp_action *actions_next(struct actions_iterator *);
 int validate_actions(const union ofp_action *, size_t n_actions,
-                     int max_ports);
+                     const struct flow *, int max_ports);
 bool action_outputs_to_port(const union ofp_action *, uint16_t port);
 
-void normalize_match(struct ofp_match *);
-char *ofp_match_to_literal_string(const struct ofp_match *match);
+int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
+                         union ofp_action **, size_t *);
 \f
 /* OpenFlow vendors.
  *
@@ -145,12 +166,21 @@ enum ofputil_vendor_codes {
  * the vendor codes can fit. */
 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
 
+/* These are macro versions of the functions defined below.  The macro versions
+ * are intended for use in contexts where function calls are not allowed,
+ * e.g. static initializers and case labels. */
+#define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
+#define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
+        ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
+#define OFP_MKERR_NICIRA(TYPE, CODE) \
+        OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
+
 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
  * an integer. */
 static inline int
 ofp_mkerr(uint16_t type, uint16_t code)
 {
-    return (1 << 30) | (type << 16) | code;
+    return OFP_MKERR(type, code);
 }
 
 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
@@ -159,7 +189,7 @@ static inline int
 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
 {
     assert(vendor < OFPUTIL_N_VENDORS);
-    return (1 << 30) | (vendor << 26) | (type << 16) | code;
+    return OFP_MKERR_VENDOR(vendor, type, code);
 }
 
 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
@@ -167,7 +197,7 @@ ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
 static inline int
 ofp_mkerr_nicira(uint16_t type, uint16_t code)
 {
-    return ofp_mkerr_vendor(OFPUTIL_VENDOR_NICIRA, type, code);
+    return OFP_MKERR_NICIRA(type, code);
 }
 
 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension