list: Rename struct list to struct ovs_list
[cascardo/ovs.git] / lib / ofpbuf.h
index dad7f64..4c0f7ea 100644 (file)
@@ -37,26 +37,46 @@ enum OVS_PACKED_ENUM ofpbuf_source {
 };
 
 /* Buffer for holding arbitrary data.  An ofpbuf is automatically reallocated
- * as necessary if it grows too large for the available memory. */
+ * as necessary if it grows too large for the available memory.
+ *
+ * 'frame' and offset conventions:
+ *
+ * Network frames (aka "packets"): 'frame' MUST be set to the start of the
+ *    packet, layer offsets MAY be set as appropriate for the packet.
+ *    Additionally, we assume in many places that the 'frame' and 'data' are
+ *    the same for packets.
+ *
+ * OpenFlow messages: 'frame' points to the start of the OpenFlow
+ *    header, while 'l3_ofs' is the length of the OpenFlow header.
+ *    When parsing, the 'data' will move past these, as data is being
+ *    pulled from the OpenFlow message.
+ *
+ * Actions: When encoding OVS action lists, the 'frame' is used
+ *    as a pointer to the beginning of the current action (see ofpact_put()).
+ *
+ * rconn: Reuses 'frame' as a private pointer while queuing.
+ */
 struct ofpbuf {
 #ifdef DPDK_NETDEV
     struct rte_mbuf mbuf;       /* DPDK mbuf */
 #else
-    void *base;                 /* First byte of allocated space. */
-    void *data;                 /* First byte actually in use. */
-    uint32_t size;              /* Number of bytes in use. */
+    void *base_;                 /* First byte of allocated space. */
+    void *data_;                 /* First byte actually in use. */
+    uint32_t size_;              /* Number of bytes in use. */
 #endif
     uint32_t allocated;         /* Number of bytes allocated. */
 
-    void *l2;                   /* Link-level header. */
-    uint16_t l2_5_ofs;          /* MPLS label stack offset from l2, or
-                                 * UINT16_MAX */
-    uint16_t l3_ofs;            /* Network-level header offset from l2, or
-                                 * UINT16_MAX. */
-    uint16_t l4_ofs;            /* Transport-level header offset from l2, or
-                                   UINT16_MAX. */
+    void *frame;                /* Packet frame start, or NULL. */
     enum ofpbuf_source source;  /* Source of memory allocated as 'base'. */
-    struct list list_node;      /* Private list element for use by owner. */
+    uint8_t l2_pad_size;        /* Detected l2 padding size.
+                                 * Padding is non-pullable. */
+    uint16_t l2_5_ofs;          /* MPLS label stack offset from 'frame', or
+                                 * UINT16_MAX */
+    uint16_t l3_ofs;            /* Network-level header offset from 'frame',
+                                   or UINT16_MAX. */
+    uint16_t l4_ofs;            /* Transport-level header offset from 'frame',
+                                   or UINT16_MAX. */
+    struct ovs_list list_node;  /* Private list element for use by owner. */
 };
 
 static inline void * ofpbuf_data(const struct ofpbuf *);
@@ -69,13 +89,17 @@ static inline void ofpbuf_set_size(struct ofpbuf *, uint32_t);
 
 void * ofpbuf_resize_l2(struct ofpbuf *, int increment);
 void * ofpbuf_resize_l2_5(struct ofpbuf *, int increment);
-static inline void * ofpbuf_get_l2_5(const struct ofpbuf *);
+static inline void * ofpbuf_l2(const struct ofpbuf *);
+static inline void ofpbuf_set_frame(struct ofpbuf *, void *);
+static inline uint8_t ofpbuf_l2_pad_size(const struct ofpbuf *);
+static inline void ofpbuf_set_l2_pad_size(struct ofpbuf *, uint8_t);
+static inline void * ofpbuf_l2_5(const struct ofpbuf *);
 static inline void ofpbuf_set_l2_5(struct ofpbuf *, void *);
-static inline void * ofpbuf_get_l3(const struct ofpbuf *);
+static inline void * ofpbuf_l3(const struct ofpbuf *);
 static inline void ofpbuf_set_l3(struct ofpbuf *, void *);
-static inline void * ofpbuf_get_l4(const struct ofpbuf *);
+static inline void * ofpbuf_l4(const struct ofpbuf *);
 static inline void ofpbuf_set_l4(struct ofpbuf *, void *);
-static inline size_t ofpbuf_get_l4_size(const struct ofpbuf *);
+static inline size_t ofpbuf_l4_size(const struct ofpbuf *);
 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *);
 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *);
 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *);
@@ -136,8 +160,8 @@ static inline void *ofpbuf_try_pull(struct ofpbuf *, size_t);
 void *ofpbuf_steal_data(struct ofpbuf *);
 
 char *ofpbuf_to_string(const struct ofpbuf *, size_t maxbytes);
-static inline struct ofpbuf *ofpbuf_from_list(const struct list *);
-void ofpbuf_list_delete(struct list *);
+static inline struct ofpbuf *ofpbuf_from_list(const struct ovs_list *);
+void ofpbuf_list_delete(struct ovs_list *);
 static inline bool ofpbuf_equal(const struct ofpbuf *, const struct ofpbuf *);
 
 \f
@@ -155,7 +179,9 @@ static inline void ofpbuf_delete(struct ofpbuf *b)
 {
     if (b) {
         if (b->source == OFPBUF_DPDK) {
-            free_dpdk_buf(b);
+            /* If this ofpbuf was allocated by DPDK it must have been
+             * created as a dpif_packet */
+            free_dpdk_buf((struct dpif_packet*) b);
             return;
         }
 
@@ -181,14 +207,14 @@ static inline void *ofpbuf_at_assert(const struct ofpbuf *b, size_t offset,
     return ((char *) ofpbuf_data(b)) + offset;
 }
 
-/* Returns the byte following the last byte of data in use in 'b'. */
+/* Returns a pointer to byte following the last byte of data in use in 'b'. */
 static inline void *ofpbuf_tail(const struct ofpbuf *b)
 {
     return (char *) ofpbuf_data(b) + ofpbuf_size(b);
 }
 
-/* Returns the byte following the last byte allocated for use (but not
- * necessarily in use) by 'b'. */
+/* Returns a pointer to byte following the last byte allocated for use (but
+ * not necessarily in use) in 'b'. */
 static inline void *ofpbuf_end(const struct ofpbuf *b)
 {
     return (char *) ofpbuf_base(b) + b->allocated;
@@ -222,7 +248,7 @@ static inline void ofpbuf_clear(struct ofpbuf *b)
 static inline void *ofpbuf_pull(struct ofpbuf *b, size_t size)
 {
     void *data = ofpbuf_data(b);
-    ovs_assert(ofpbuf_size(b) >= size);
+    ovs_assert(ofpbuf_size(b) - ofpbuf_l2_pad_size(b) >= size);
     ofpbuf_set_data(b, (char*)ofpbuf_data(b) + size);
     ofpbuf_set_size(b, ofpbuf_size(b) - size);
     return data;
@@ -233,10 +259,11 @@ static inline void *ofpbuf_pull(struct ofpbuf *b, size_t size)
  * null pointer without modifying 'b'. */
 static inline void *ofpbuf_try_pull(struct ofpbuf *b, size_t size)
 {
-    return ofpbuf_size(b) >= size ? ofpbuf_pull(b, size) : NULL;
+    return ofpbuf_size(b) - ofpbuf_l2_pad_size(b) >= size
+        ? ofpbuf_pull(b, size) : NULL;
 }
 
-static inline struct ofpbuf *ofpbuf_from_list(const struct list *list)
+static inline struct ofpbuf *ofpbuf_from_list(const struct ovs_list *list)
 {
     return CONTAINER_OF(list, struct ofpbuf, list_node);
 }
@@ -247,48 +274,79 @@ static inline bool ofpbuf_equal(const struct ofpbuf *a, const struct ofpbuf *b)
            memcmp(ofpbuf_data(a), ofpbuf_data(b), ofpbuf_size(a)) == 0;
 }
 
-static inline void * ofpbuf_get_l2_5(const struct ofpbuf *b)
+/* Get the start if the Ethernet frame.  'l3_ofs' marks the end of the l2
+ * headers, so return NULL if it is not set. */
+static inline void * ofpbuf_l2(const struct ofpbuf *b)
+{
+    return (b->l3_ofs != UINT16_MAX) ? b->frame : NULL;
+}
+
+/* Sets the packet frame start pointer and resets all layer offsets.
+ * l3 offset must be set before 'l2' can be retrieved. */
+static inline void ofpbuf_set_frame(struct ofpbuf *b, void *packet)
+{
+    b->frame = packet;
+    b->l2_pad_size = 0;
+    b->l2_5_ofs = UINT16_MAX;
+    b->l3_ofs = UINT16_MAX;
+    b->l4_ofs = UINT16_MAX;
+}
+
+static inline uint8_t ofpbuf_l2_pad_size(const struct ofpbuf *b)
+{
+    return b->l2_pad_size;
+}
+
+static inline void ofpbuf_set_l2_pad_size(struct ofpbuf *b, uint8_t pad_size)
+{
+    ovs_assert(pad_size <= ofpbuf_size(b));
+    b->l2_pad_size = pad_size;
+}
+
+static inline void * ofpbuf_l2_5(const struct ofpbuf *b)
 {
-    return b->l2_5_ofs != UINT16_MAX ? (char *)b->l2 + b->l2_5_ofs : NULL;
+    return b->l2_5_ofs != UINT16_MAX ? (char *)b->frame + b->l2_5_ofs : NULL;
 }
 
 static inline void ofpbuf_set_l2_5(struct ofpbuf *b, void *l2_5)
 {
-    b->l2_5_ofs = l2_5 ? (char *)l2_5 - (char *)b->l2 : UINT16_MAX;
+    b->l2_5_ofs = l2_5 ? (char *)l2_5 - (char *)b->frame : UINT16_MAX;
 }
 
-static inline void * ofpbuf_get_l3(const struct ofpbuf *b)
+static inline void * ofpbuf_l3(const struct ofpbuf *b)
 {
-    return b->l3_ofs != UINT16_MAX ? (char *)b->l2 + b->l3_ofs : NULL;
+    return b->l3_ofs != UINT16_MAX ? (char *)b->frame + b->l3_ofs : NULL;
 }
 
 static inline void ofpbuf_set_l3(struct ofpbuf *b, void *l3)
 {
-    b->l3_ofs = l3 ? (char *)l3 - (char *)b->l2 : UINT16_MAX;
+    b->l3_ofs = l3 ? (char *)l3 - (char *)b->frame : UINT16_MAX;
 }
 
-static inline void * ofpbuf_get_l4(const struct ofpbuf *b)
+static inline void * ofpbuf_l4(const struct ofpbuf *b)
 {
-    return b->l4_ofs != UINT16_MAX ? (char *)b->l2 + b->l4_ofs : NULL;
+    return b->l4_ofs != UINT16_MAX ? (char *)b->frame + b->l4_ofs : NULL;
 }
 
 static inline void ofpbuf_set_l4(struct ofpbuf *b, void *l4)
 {
-    b->l4_ofs = l4 ? (char *)l4 - (char *)b->l2 : UINT16_MAX;
+    b->l4_ofs = l4 ? (char *)l4 - (char *)b->frame : UINT16_MAX;
 }
 
-static inline size_t ofpbuf_get_l4_size(const struct ofpbuf *b)
+static inline size_t ofpbuf_l4_size(const struct ofpbuf *b)
 {
     return b->l4_ofs != UINT16_MAX
-        ? (const char *)ofpbuf_tail(b) - (const char *)ofpbuf_get_l4(b) : 0;
+        ? (const char *)ofpbuf_tail(b) - (const char *)ofpbuf_l4(b)
+        - ofpbuf_l2_pad_size(b)
+        : 0;
 }
 
 static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *b)
 {
-    size_t l4_size = ofpbuf_get_l4_size(b);
+    size_t l4_size = ofpbuf_l4_size(b);
 
     if (OVS_LIKELY(l4_size >= TCP_HEADER_LEN)) {
-        struct tcp_header *tcp = ofpbuf_get_l4(b);
+        struct tcp_header *tcp = ofpbuf_l4(b);
         int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
 
         if (OVS_LIKELY(tcp_len >= TCP_HEADER_LEN && tcp_len <= l4_size)) {
@@ -300,23 +358,25 @@ static inline const void *ofpbuf_get_tcp_payload(const struct ofpbuf *b)
 
 static inline const void *ofpbuf_get_udp_payload(const struct ofpbuf *b)
 {
-    return OVS_LIKELY(ofpbuf_get_l4_size(b) >= UDP_HEADER_LEN)
-        ? (const char *)ofpbuf_get_l4(b) + UDP_HEADER_LEN : NULL;
+    return OVS_LIKELY(ofpbuf_l4_size(b) >= UDP_HEADER_LEN)
+        ? (const char *)ofpbuf_l4(b) + UDP_HEADER_LEN : NULL;
 }
 
 static inline const void *ofpbuf_get_sctp_payload(const struct ofpbuf *b)
 {
-    return OVS_LIKELY(ofpbuf_get_l4_size(b) >= SCTP_HEADER_LEN)
-        ? (const char *)ofpbuf_get_l4(b) + SCTP_HEADER_LEN : NULL;
+    return OVS_LIKELY(ofpbuf_l4_size(b) >= SCTP_HEADER_LEN)
+        ? (const char *)ofpbuf_l4(b) + SCTP_HEADER_LEN : NULL;
 }
 
 static inline const void *ofpbuf_get_icmp_payload(const struct ofpbuf *b)
 {
-    return OVS_LIKELY(ofpbuf_get_l4_size(b) >= ICMP_HEADER_LEN)
-        ? (const char *)ofpbuf_get_l4(b) + ICMP_HEADER_LEN : NULL;
+    return OVS_LIKELY(ofpbuf_l4_size(b) >= ICMP_HEADER_LEN)
+        ? (const char *)ofpbuf_l4(b) + ICMP_HEADER_LEN : NULL;
 }
 
 #ifdef DPDK_NETDEV
+BUILD_ASSERT_DECL(offsetof(struct ofpbuf, mbuf) == 0);
+
 static inline void * ofpbuf_data(const struct ofpbuf *b)
 {
     return b->mbuf.pkt.data;
@@ -352,35 +412,43 @@ static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
 #else
 static inline void * ofpbuf_data(const struct ofpbuf *b)
 {
-    return b->data;
+    return b->data_;
 }
 
 static inline void ofpbuf_set_data(struct ofpbuf *b, void *d)
 {
-    b->data = d;
+    b->data_ = d;
 }
 
 static inline void * ofpbuf_base(const struct ofpbuf *b)
 {
-    return b->base;
+    return b->base_;
 }
 
 static inline void ofpbuf_set_base(struct ofpbuf *b, void *d)
 {
-    b->base = d;
+    b->base_ = d;
 }
 
 static inline uint32_t ofpbuf_size(const struct ofpbuf *b)
 {
-    return b->size;
+    return b->size_;
 }
 
 static inline void ofpbuf_set_size(struct ofpbuf *b, uint32_t v)
 {
-    b->size = v;
+    b->size_ = v;
 }
 #endif
 
+static inline void ofpbuf_reset_packet(struct ofpbuf *b, int off)
+{
+    ofpbuf_set_size(b, ofpbuf_size(b) - off);
+    ofpbuf_set_data(b, (void *) ((unsigned char *) b->frame + off));
+    b->frame = NULL;
+    b->l2_5_ofs = b->l3_ofs = b->l4_ofs = UINT16_MAX;
+}
+
 #ifdef  __cplusplus
 }
 #endif