/*
- * Copyright (c) 2014 Nicira, Inc.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* limitations under the License.
*/
-#ifndef PACKET_DPIF_H
-#define PACKET_DPIF_H 1
+#ifndef DPBUF_H
+#define DPBUF_H 1
-#include "ofpbuf.h"
+#include <stddef.h>
+#include <stdint.h>
+#include "list.h"
+#include "packets.h"
+#include "util.h"
+#include "netdev-dpdk.h"
#ifdef __cplusplus
extern "C" {
#endif
-/* A packet received from a netdev and passed to a dpif. */
+enum OVS_PACKED_ENUM dp_packet_source {
+ DPBUF_MALLOC, /* Obtained via malloc(). */
+ DPBUF_STACK, /* Un-movable stack space or static buffer. */
+ DPBUF_STUB, /* Starts on stack, may expand into heap. */
+ DPBUF_DPDK, /* buffer data is from DPDK allocated memory.
+ ref to build_dp_packet() in netdev-dpdk. */
+};
+/* Buffer for holding arbitrary data. An dp_packet is automatically reallocated
+ * 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 dp_packet {
- struct ofpbuf ofpbuf; /* Packet data. */
-#ifndef DPDK_NETDEV
+#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. */
uint32_t dp_hash; /* Packet hash. */
#endif
+ uint32_t allocated; /* Number of bytes allocated. */
+
+ void *frame; /* Packet frame start, or NULL. */
+ enum dp_packet_source source; /* Source of memory allocated as 'base'. */
+ 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 pkt_metadata md;
+ struct ovs_list list_node; /* Private list element for use by owner. */
};
-struct dp_packet *dp_packet_new_with_headroom(size_t size,
- size_t headroom);
+static inline void * dp_packet_data(const struct dp_packet *);
+static inline void dp_packet_set_data(struct dp_packet *, void *);
+static inline void * dp_packet_base(const struct dp_packet *);
+static inline void dp_packet_set_base(struct dp_packet *, void *);
+
+static inline uint32_t dp_packet_size(const struct dp_packet *);
+static inline void dp_packet_set_size(struct dp_packet *, uint32_t);
+
+void * dp_packet_resize_l2(struct dp_packet *, int increment);
+void * dp_packet_resize_l2_5(struct dp_packet *, int increment);
+static inline void * dp_packet_l2(const struct dp_packet *);
+static inline void dp_packet_set_frame(struct dp_packet *, void *);
+static inline uint8_t dp_packet_l2_pad_size(const struct dp_packet *);
+static inline void dp_packet_set_l2_pad_size(struct dp_packet *, uint8_t);
+static inline void * dp_packet_l2_5(const struct dp_packet *);
+static inline void dp_packet_set_l2_5(struct dp_packet *, void *);
+static inline void * dp_packet_l3(const struct dp_packet *);
+static inline void dp_packet_set_l3(struct dp_packet *, void *);
+static inline void * dp_packet_l4(const struct dp_packet *);
+static inline void dp_packet_set_l4(struct dp_packet *, void *);
+static inline size_t dp_packet_l4_size(const struct dp_packet *);
+static inline const void *dp_packet_get_tcp_payload(const struct dp_packet *);
+static inline const void *dp_packet_get_udp_payload(const struct dp_packet *);
+static inline const void *dp_packet_get_sctp_payload(const struct dp_packet *);
+static inline const void *dp_packet_get_icmp_payload(const struct dp_packet *);
+static inline const void *dp_packet_get_nd_payload(const struct dp_packet *);
+
+void dp_packet_use(struct dp_packet *, void *, size_t);
+void dp_packet_use_stub(struct dp_packet *, void *, size_t);
+void dp_packet_use_const(struct dp_packet *, const void *, size_t);
+
+void dp_packet_init_dpdk(struct dp_packet *b, size_t allocated);
+
+void dp_packet_init(struct dp_packet *, size_t);
+void dp_packet_uninit(struct dp_packet *);
+static inline void *dp_packet_get_uninit_pointer(struct dp_packet *);
+
+struct dp_packet *dp_packet_new(size_t);
+struct dp_packet *dp_packet_new_with_headroom(size_t, size_t headroom);
+struct dp_packet *dp_packet_clone(const struct dp_packet *);
+struct dp_packet *dp_packet_clone_with_headroom(const struct dp_packet *,
+ size_t headroom);
+struct dp_packet *dp_packet_clone_data(const void *, size_t);
+struct dp_packet *dp_packet_clone_data_with_headroom(const void *, size_t,
+ size_t headroom);
+static inline void dp_packet_delete(struct dp_packet *);
+
+static inline void *dp_packet_at(const struct dp_packet *, size_t offset,
+ size_t size);
+static inline void *dp_packet_at_assert(const struct dp_packet *, size_t offset,
+ size_t size);
+static inline void *dp_packet_tail(const struct dp_packet *);
+static inline void *dp_packet_end(const struct dp_packet *);
+
+void *dp_packet_put_uninit(struct dp_packet *, size_t);
+void *dp_packet_put_zeros(struct dp_packet *, size_t);
+void *dp_packet_put(struct dp_packet *, const void *, size_t);
+char *dp_packet_put_hex(struct dp_packet *, const char *s, size_t *n);
+void dp_packet_reserve(struct dp_packet *, size_t);
+void dp_packet_reserve_with_tailroom(struct dp_packet *b, size_t headroom,
+ size_t tailroom);
+void *dp_packet_push_uninit(struct dp_packet *b, size_t);
+void *dp_packet_push_zeros(struct dp_packet *, size_t);
+void *dp_packet_push(struct dp_packet *b, const void *, size_t);
+
+static inline size_t dp_packet_headroom(const struct dp_packet *);
+static inline size_t dp_packet_tailroom(const struct dp_packet *);
+void dp_packet_prealloc_headroom(struct dp_packet *, size_t);
+void dp_packet_prealloc_tailroom(struct dp_packet *, size_t);
+void dp_packet_shift(struct dp_packet *, int);
-struct dp_packet *dp_packet_clone_from_ofpbuf(const struct ofpbuf *b);
+static inline void dp_packet_clear(struct dp_packet *);
+static inline void *dp_packet_pull(struct dp_packet *, size_t);
+static inline void *dp_packet_try_pull(struct dp_packet *, size_t);
-struct dp_packet *dp_packet_clone(struct dp_packet *p);
+void *dp_packet_steal_data(struct dp_packet *);
-static inline void dp_packet_delete(struct dp_packet *p)
+char *dp_packet_to_string(const struct dp_packet *, size_t maxbytes);
+static inline struct dp_packet *dp_packet_from_list(const struct ovs_list *);
+void dp_packet_list_delete(struct ovs_list *);
+static inline bool dp_packet_equal(const struct dp_packet *, const struct dp_packet *);
+
+\f
+/* Returns a pointer that may be passed to free() to accomplish the same thing
+ * as dp_packet_uninit(b). The return value is a null pointer if dp_packet_uninit()
+ * would not free any memory. */
+static inline void *dp_packet_get_uninit_pointer(struct dp_packet *b)
+{
+ /* XXX: If 'source' is DPBUF_DPDK memory gets leaked! */
+ return b && b->source == DPBUF_MALLOC ? dp_packet_base(b) : NULL;
+}
+
+/* Frees memory that 'b' points to, as well as 'b' itself. */
+static inline void dp_packet_delete(struct dp_packet *b)
+{
+ if (b) {
+ if (b->source == DPBUF_DPDK) {
+ /* If this dp_packet was allocated by DPDK it must have been
+ * created as a dp_packet */
+ free_dpdk_buf((struct dp_packet*) b);
+ return;
+ }
+
+ dp_packet_uninit(b);
+ free(b);
+ }
+}
+
+/* If 'b' contains at least 'offset + size' bytes of data, returns a pointer to
+ * byte 'offset'. Otherwise, returns a null pointer. */
+static inline void *dp_packet_at(const struct dp_packet *b, size_t offset,
+ size_t size)
{
- struct ofpbuf *buf = &p->ofpbuf;
+ return offset + size <= dp_packet_size(b) ? (char *) dp_packet_data(b) + offset : NULL;
+}
- ofpbuf_delete(buf);
+/* Returns a pointer to byte 'offset' in 'b', which must contain at least
+ * 'offset + size' bytes of data. */
+static inline void *dp_packet_at_assert(const struct dp_packet *b, size_t offset,
+ size_t size)
+{
+ ovs_assert(offset + size <= dp_packet_size(b));
+ return ((char *) dp_packet_data(b)) + offset;
+}
+
+/* Returns a pointer to byte following the last byte of data in use in 'b'. */
+static inline void *dp_packet_tail(const struct dp_packet *b)
+{
+ return (char *) dp_packet_data(b) + dp_packet_size(b);
+}
+
+/* Returns a pointer to byte following the last byte allocated for use (but
+ * not necessarily in use) in 'b'. */
+static inline void *dp_packet_end(const struct dp_packet *b)
+{
+ return (char *) dp_packet_base(b) + b->allocated;
+}
+
+/* Returns the number of bytes of headroom in 'b', that is, the number of bytes
+ * of unused space in dp_packet 'b' before the data that is in use. (Most
+ * commonly, the data in a dp_packet is at its beginning, and thus the dp_packet's
+ * headroom is 0.) */
+static inline size_t dp_packet_headroom(const struct dp_packet *b)
+{
+ return (char*)dp_packet_data(b) - (char*)dp_packet_base(b);
+}
+
+/* Returns the number of bytes that may be appended to the tail end of dp_packet
+ * 'b' before the dp_packet must be reallocated. */
+static inline size_t dp_packet_tailroom(const struct dp_packet *b)
+{
+ return (char*)dp_packet_end(b) - (char*)dp_packet_tail(b);
+}
+
+/* Clears any data from 'b'. */
+static inline void dp_packet_clear(struct dp_packet *b)
+{
+ dp_packet_set_data(b, dp_packet_base(b));
+ dp_packet_set_size(b, 0);
+}
+
+/* Removes 'size' bytes from the head end of 'b', which must contain at least
+ * 'size' bytes of data. Returns the first byte of data removed. */
+static inline void *dp_packet_pull(struct dp_packet *b, size_t size)
+{
+ void *data = dp_packet_data(b);
+ ovs_assert(dp_packet_size(b) - dp_packet_l2_pad_size(b) >= size);
+ dp_packet_set_data(b, (char*)dp_packet_data(b) + size);
+ dp_packet_set_size(b, dp_packet_size(b) - size);
+ return data;
+}
+
+/* If 'b' has at least 'size' bytes of data, removes that many bytes from the
+ * head end of 'b' and returns the first byte removed. Otherwise, returns a
+ * null pointer without modifying 'b'. */
+static inline void *dp_packet_try_pull(struct dp_packet *b, size_t size)
+{
+ return dp_packet_size(b) - dp_packet_l2_pad_size(b) >= size
+ ? dp_packet_pull(b, size) : NULL;
+}
+
+static inline struct dp_packet *dp_packet_from_list(const struct ovs_list *list)
+{
+ return CONTAINER_OF(list, struct dp_packet, list_node);
+}
+
+static inline bool dp_packet_equal(const struct dp_packet *a, const struct dp_packet *b)
+{
+ return dp_packet_size(a) == dp_packet_size(b) &&
+ memcmp(dp_packet_data(a), dp_packet_data(b), dp_packet_size(a)) == 0;
+}
+
+/* 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 * dp_packet_l2(const struct dp_packet *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 dp_packet_set_frame(struct dp_packet *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 dp_packet_l2_pad_size(const struct dp_packet *b)
+{
+ return b->l2_pad_size;
+}
+
+static inline void dp_packet_set_l2_pad_size(struct dp_packet *b, uint8_t pad_size)
+{
+ ovs_assert(pad_size <= dp_packet_size(b));
+ b->l2_pad_size = pad_size;
+}
+
+static inline void * dp_packet_l2_5(const struct dp_packet *b)
+{
+ return b->l2_5_ofs != UINT16_MAX ? (char *)b->frame + b->l2_5_ofs : NULL;
+}
+
+static inline void dp_packet_set_l2_5(struct dp_packet *b, void *l2_5)
+{
+ b->l2_5_ofs = l2_5 ? (char *)l2_5 - (char *)b->frame : UINT16_MAX;
+}
+
+static inline void * dp_packet_l3(const struct dp_packet *b)
+{
+ return b->l3_ofs != UINT16_MAX ? (char *)b->frame + b->l3_ofs : NULL;
+}
+
+static inline void dp_packet_set_l3(struct dp_packet *b, void *l3)
+{
+ b->l3_ofs = l3 ? (char *)l3 - (char *)b->frame : UINT16_MAX;
+}
+
+static inline void * dp_packet_l4(const struct dp_packet *b)
+{
+ return b->l4_ofs != UINT16_MAX ? (char *)b->frame + b->l4_ofs : NULL;
+}
+
+static inline void dp_packet_set_l4(struct dp_packet *b, void *l4)
+{
+ b->l4_ofs = l4 ? (char *)l4 - (char *)b->frame : UINT16_MAX;
+}
+
+static inline size_t dp_packet_l4_size(const struct dp_packet *b)
+{
+ return b->l4_ofs != UINT16_MAX
+ ? (const char *)dp_packet_tail(b) - (const char *)dp_packet_l4(b)
+ - dp_packet_l2_pad_size(b)
+ : 0;
+}
+
+static inline const void *dp_packet_get_tcp_payload(const struct dp_packet *b)
+{
+ size_t l4_size = dp_packet_l4_size(b);
+
+ if (OVS_LIKELY(l4_size >= TCP_HEADER_LEN)) {
+ struct tcp_header *tcp = dp_packet_l4(b);
+ int tcp_len = TCP_OFFSET(tcp->tcp_ctl) * 4;
+
+ if (OVS_LIKELY(tcp_len >= TCP_HEADER_LEN && tcp_len <= l4_size)) {
+ return (const char *)tcp + tcp_len;
+ }
+ }
+ return NULL;
+}
+
+static inline const void *dp_packet_get_udp_payload(const struct dp_packet *b)
+{
+ return OVS_LIKELY(dp_packet_l4_size(b) >= UDP_HEADER_LEN)
+ ? (const char *)dp_packet_l4(b) + UDP_HEADER_LEN : NULL;
+}
+
+static inline const void *dp_packet_get_sctp_payload(const struct dp_packet *b)
+{
+ return OVS_LIKELY(dp_packet_l4_size(b) >= SCTP_HEADER_LEN)
+ ? (const char *)dp_packet_l4(b) + SCTP_HEADER_LEN : NULL;
+}
+
+static inline const void *dp_packet_get_icmp_payload(const struct dp_packet *b)
+{
+ return OVS_LIKELY(dp_packet_l4_size(b) >= ICMP_HEADER_LEN)
+ ? (const char *)dp_packet_l4(b) + ICMP_HEADER_LEN : NULL;
+}
+
+static inline const void *dp_packet_get_nd_payload(const struct dp_packet *b)
+{
+ return OVS_LIKELY(dp_packet_l4_size(b) >= ND_MSG_LEN)
+ ? (const char *)dp_packet_l4(b) + ND_MSG_LEN : NULL;
+}
+
+#ifdef DPDK_NETDEV
+BUILD_ASSERT_DECL(offsetof(struct dp_packet, mbuf) == 0);
+
+static inline void * dp_packet_data(const struct dp_packet *b)
+{
+ return b->mbuf.pkt.data;
+}
+
+static inline void dp_packet_set_data(struct dp_packet *b, void *d)
+{
+ b->mbuf.pkt.data = d;
+}
+
+static inline void * dp_packet_base(const struct dp_packet *b)
+{
+ return b->mbuf.buf_addr;
+}
+
+static inline void dp_packet_set_base(struct dp_packet *b, void *d)
+{
+ b->mbuf.buf_addr = d;
+}
+
+static inline uint32_t dp_packet_size(const struct dp_packet *b)
+{
+ return b->mbuf.pkt.pkt_len;
+}
+
+static inline void dp_packet_set_size(struct dp_packet *b, uint32_t v)
+{
+ b->mbuf.pkt.data_len = v; /* Current seg length. */
+ b->mbuf.pkt.pkt_len = v; /* Total length of all segments linked to
+ * this segment. */
+}
+
+#else
+static inline void * dp_packet_data(const struct dp_packet *b)
+{
+ return b->data_;
+}
+
+static inline void dp_packet_set_data(struct dp_packet *b, void *d)
+{
+ b->data_ = d;
+}
+
+static inline void * dp_packet_base(const struct dp_packet *b)
+{
+ return b->base_;
+}
+
+static inline void dp_packet_set_base(struct dp_packet *b, void *d)
+{
+ b->base_ = d;
+}
+
+static inline uint32_t dp_packet_size(const struct dp_packet *b)
+{
+ return b->size_;
+}
+
+static inline void dp_packet_set_size(struct dp_packet *b, uint32_t v)
+{
+ b->size_ = v;
+}
+#endif
+
+static inline void dp_packet_reset_packet(struct dp_packet *b, int off)
+{
+ dp_packet_set_size(b, dp_packet_size(b) - off);
+ dp_packet_set_data(b, (void *) ((unsigned char *) b->frame + off));
+ b->frame = NULL;
+ b->l2_5_ofs = b->l3_ofs = b->l4_ofs = UINT16_MAX;
}
static inline uint32_t dp_packet_get_dp_hash(struct dp_packet *p)
{
#ifdef DPDK_NETDEV
- return p->ofpbuf.mbuf.pkt.hash.rss;
+ return p->mbuf.pkt.hash.rss;
#else
return p->dp_hash;
#endif
uint32_t hash)
{
#ifdef DPDK_NETDEV
- p->ofpbuf.mbuf.pkt.hash.rss = hash;
+ p->mbuf.pkt.hash.rss = hash;
#else
p->dp_hash = hash;
#endif
}
#endif
-#endif /* dp-packet.h */
+#endif /* dp_packet.h */
projects / cascardo / ovs.git / blobdiff