/*
- * Copyright (c) 2004-2007 Apple Inc. All rights reserved.
+ * Copyright (c) 2008-2010 Apple Inc. All rights reserved.
*
* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
*
@header kpi_mbuf.h
This header defines an API for interacting with mbufs. mbufs are the
primary method of storing packets in the networking stack.
-
+
mbufs are used to store various items in the networking stack. The
most common usage of an mbuf is to store a packet or data on a
socket waiting to be sent or received. The mbuf is a contiguous
structure with some header followed by some data. To store more data
than would fit in an mbuf, external data is used. Most mbufs with
external data use clusters to store the external data.
-
+
mbufs can be chained, contiguous data in a packet can be found by
following the m_next chain. Packets may be bundled together using
m_nextpacket. Many parts of the stack do not properly handle chains
being passed to any interface filters.
*/
enum {
- MBUF_EXT = 0x0001, /* has associated external storage */
- MBUF_PKTHDR = 0x0002, /* start of record */
- MBUF_EOR = 0x0004, /* end of record */
-
- MBUF_BCAST = 0x0100, /* send/received as link-level broadcast */
- MBUF_MCAST = 0x0200, /* send/received as link-level multicast */
- MBUF_FRAG = 0x0400, /* packet is a fragment of a larger packet */
+ MBUF_EXT = 0x0001, /* has associated external storage */
+ MBUF_PKTHDR = 0x0002, /* start of record */
+ MBUF_EOR = 0x0004, /* end of record */
+
+ MBUF_BCAST = 0x0100, /* send/received as link-level broadcast */
+ MBUF_MCAST = 0x0200, /* send/received as link-level multicast */
+ MBUF_FRAG = 0x0400, /* packet is a fragment of a larger packet */
MBUF_FIRSTFRAG = 0x0800, /* packet is first fragment */
MBUF_LASTFRAG = 0x1000, /* packet is last fragment */
MBUF_PROMISC = 0x2000 /* packet is promiscuous */
MBUF_TYPE_PCB = 4, /* protocol control block */
MBUF_TYPE_RTABLE = 5, /* routing tables */
MBUF_TYPE_HTABLE = 6, /* IMP host tables */
- MBUF_TYPE_ATABLE = 7, /* address resolution tables */
+ MBUF_TYPE_ATABLE = 7, /* address resolution tables */
MBUF_TYPE_SONAME = 8, /* socket name */
MBUF_TYPE_SOOPTS = 10, /* socket options */
MBUF_TYPE_FTABLE = 11, /* fragment reassembly header */
@constant MBUF_CSUM_REQ_UDP Indicates the UDP checksum has not been
calculated yet.
*/
+enum {
+ MBUF_TSO_IPV4 = 0x100000,
+ MBUF_TSO_IPV6 = 0x200000
+};
+typedef u_int32_t mbuf_tso_request_flags_t;
+
enum {
#ifdef KERNEL_PRIVATE
MBUF_CSUM_REQ_SUM16 = 0x1000, /* Weird apple hardware checksum */
-#endif KERNEL_PRIVATE
+#endif /* KERNEL_PRIVATE */
MBUF_CSUM_REQ_IP = 0x0001,
MBUF_CSUM_REQ_TCP = 0x0002,
MBUF_CSUM_REQ_UDP = 0x0004
*/
enum {
#ifdef KERNEL_PRIVATE
- MBUF_CSUM_TCP_SUM16 = MBUF_CSUM_REQ_SUM16, /* Weird apple hardware checksum */
-#endif
- MBUF_CSUM_DID_IP = 0x0100,
- MBUF_CSUM_IP_GOOD = 0x0200,
- MBUF_CSUM_DID_DATA = 0x0400,
+ MBUF_CSUM_TCP_SUM16 = MBUF_CSUM_REQ_SUM16, /* Weird apple hardware checksum */
+#endif /* KERNEL_PRIVATE */
+ MBUF_CSUM_DID_IP = 0x0100,
+ MBUF_CSUM_IP_GOOD = 0x0200,
+ MBUF_CSUM_DID_DATA = 0x0400,
MBUF_CSUM_PSEUDO_HDR = 0x0800
};
typedef u_int32_t mbuf_csum_performed_flags_t;
block, if blocking is necessary fail and return immediately.
*/
enum {
- MBUF_WAITOK = 0, /* Ok to block to get memory */
- MBUF_DONTWAIT = 1 /* Don't block, fail if blocking would be required */
+ MBUF_WAITOK = 0, /* Ok to block to get memory */
+ MBUF_DONTWAIT = 1 /* Don't block, fail if blocking would be required */
};
typedef u_int32_t mbuf_how_t;
@field bigmclbytes Length of a big mbuf cluster.
*/
struct mbuf_stat {
- u_long mbufs; /* mbufs obtained from page pool */
- u_long clusters; /* clusters obtained from page pool */
- u_long clfree; /* free clusters */
- u_long drops; /* times failed to find space */
- u_long wait; /* times waited for space */
- u_long drain; /* times drained protocols for space */
- u_short mtypes[256]; /* type specific mbuf allocations */
- u_long mcfail; /* times m_copym failed */
- u_long mpfail; /* times m_pullup failed */
- u_long msize; /* length of an mbuf */
- u_long mclbytes; /* length of an mbuf cluster */
- u_long minclsize; /* min length of data to allocate a cluster */
- u_long mlen; /* length of data in an mbuf */
- u_long mhlen; /* length of data in a header mbuf */
- u_long bigclusters; /* number of big clusters */
- u_long bigclfree; /* number of big clustser free */
- u_long bigmclbytes; /* length of data in a big cluster */
+ u_int32_t mbufs; /* mbufs obtained from page pool */
+ u_int32_t clusters; /* clusters obtained from page pool */
+ u_int32_t clfree; /* free clusters */
+ u_int32_t drops; /* times failed to find space */
+ u_int32_t wait; /* times waited for space */
+ u_int32_t drain; /* times drained protocols for space */
+ u_short mtypes[256]; /* type specific mbuf allocations */
+ u_int32_t mcfail; /* times m_copym failed */
+ u_int32_t mpfail; /* times m_pullup failed */
+ u_int32_t msize; /* length of an mbuf */
+ u_int32_t mclbytes; /* length of an mbuf cluster */
+ u_int32_t minclsize; /* min length of data to allocate a cluster */
+ u_int32_t mlen; /* length of data in an mbuf */
+ u_int32_t mhlen; /* length of data in a header mbuf */
+ u_int32_t bigclusters; /* number of big clusters */
+ u_int32_t bigclfree; /* number of big clustser free */
+ u_int32_t bigmclbytes; /* length of data in a big cluster */
};
/* Parameter for m_copym to copy all bytes */
@param mbuf The mbuf.
@result A pointer to the data in the mbuf.
*/
-void* mbuf_data(mbuf_t mbuf);
+extern void *mbuf_data(mbuf_t mbuf);
/*!
@function mbuf_datastart
data in an mbuf. An mbuf's data may come from a cluster or be
embedded in the mbuf structure itself. The data pointer
retrieved by mbuf_data may not be at the start of the data
- (mbuf_leadingspace will be non-zero). This function will return to
- you a pointer that matches mbuf_data() - mbuf_leadingspace().
+ (mbuf_leadingspace will be non-zero). This function will return
+ a pointer that matches mbuf_data() - mbuf_leadingspace().
@param mbuf The mbuf.
@result A pointer to smallest possible value for data.
*/
-void* mbuf_datastart(mbuf_t mbuf);
+extern void *mbuf_datastart(mbuf_t mbuf);
/*!
@function mbuf_setdata
@param len The new length of data in the mbuf.
@result 0 on success, errno error on failure.
*/
-errno_t mbuf_setdata(mbuf_t mbuf, void *data, size_t len);
+extern errno_t mbuf_setdata(mbuf_t mbuf, void *data, size_t len);
/*!
@function mbuf_align_32
data location.
@result 0 on success, errno error on failure.
*/
-errno_t mbuf_align_32(mbuf_t mbuf, size_t len);
+extern errno_t mbuf_align_32(mbuf_t mbuf, size_t len);
/*!
@function mbuf_data_to_physical
@result The 64 bit physical address of the mbuf data or NULL if ptr
does not point to data stored in an mbuf.
*/
-addr64_t mbuf_data_to_physical(void* ptr);
+extern addr64_t mbuf_data_to_physical(void *ptr);
/* Allocation */
@param mbuf The mbuf.
@result 0 on success, errno error on failure.
*/
-errno_t mbuf_get(mbuf_how_t how, mbuf_type_t type, mbuf_t* mbuf);
+extern errno_t mbuf_get(mbuf_how_t how, mbuf_type_t type, mbuf_t *mbuf);
/*!
@function mbuf_gethdr
@param mbuf The mbuf.
@result 0 on success, errno error on failure.
*/
-errno_t mbuf_gethdr(mbuf_how_t how, mbuf_type_t type, mbuf_t* mbuf);
+extern errno_t mbuf_gethdr(mbuf_how_t how, mbuf_type_t type, mbuf_t *mbuf);
/*!
@function mbuf_attachcluster
EINVAL - Invalid parameter
ENOMEM - Not enough memory available
*/
-errno_t
-mbuf_attachcluster(mbuf_how_t how, mbuf_type_t type, mbuf_t *mbuf,
- caddr_t extbuf, void (*extfree)(caddr_t , u_int, caddr_t),
+extern errno_t mbuf_attachcluster(mbuf_how_t how, mbuf_type_t type,
+ mbuf_t *mbuf, caddr_t extbuf, void (*extfree)(caddr_t , u_int, caddr_t),
size_t extsize, caddr_t extarg);
/*!
In this case, the caller is advised to use 4096 bytes or
smaller during subseqent requests.
*/
-errno_t mbuf_alloccluster(mbuf_how_t how, size_t *size, caddr_t *addr);
+extern errno_t mbuf_alloccluster(mbuf_how_t how, size_t *size, caddr_t *addr);
/*!
@function mbuf_freecluster
@param addr The address of the cluster.
@param size The actual size of the cluster.
*/
-void mbuf_freecluster(caddr_t addr, size_t size);
+extern void mbuf_freecluster(caddr_t addr, size_t size);
/*!
@function mbuf_getcluster
In this case, the caller is advised to use 4096 bytes or
smaller during subsequent requests.
*/
-errno_t mbuf_getcluster(mbuf_how_t how, mbuf_type_t type, size_t size, mbuf_t* mbuf);
+extern errno_t mbuf_getcluster(mbuf_how_t how, mbuf_type_t type, size_t size,
+ mbuf_t *mbuf);
/*!
@function mbuf_mclget
will be freed. If you specify an mbuf value in *mbuf,
mbuf_mclget will not free it.
*/
-errno_t mbuf_mclget(mbuf_how_t how, mbuf_type_t type, mbuf_t* mbuf);
+extern errno_t mbuf_mclget(mbuf_how_t how, mbuf_type_t type, mbuf_t *mbuf);
/*!
@function mbuf_allocpacket
ENOBUFS - Buffers not big enough for the maximum number of
chunks requested
*/
-errno_t mbuf_allocpacket(mbuf_how_t how, size_t packetlen, unsigned int * maxchunks, mbuf_t *mbuf);
+extern errno_t mbuf_allocpacket(mbuf_how_t how, size_t packetlen,
+ unsigned int * maxchunks, mbuf_t *mbuf);
/*!
@function mbuf_allocpacket_list
ENOBUFS - Buffers not big enough for the maximum number of
chunks requested
*/
-errno_t mbuf_allocpacket_list(unsigned int numpkts, mbuf_how_t how, size_t packetlen, unsigned int * maxchunks, mbuf_t *mbuf);
+extern errno_t mbuf_allocpacket_list(unsigned int numpkts, mbuf_how_t how,
+ size_t packetlen, unsigned int * maxchunks, mbuf_t *mbuf);
/*!
@param mbuf Upon success, *mbuf will be a reference to the new mbuf.
@result 0 on success, errno error on failure.
*/
-errno_t mbuf_getpacket(mbuf_how_t how, mbuf_t* mbuf);
+extern errno_t mbuf_getpacket(mbuf_how_t how, mbuf_t *mbuf);
/*!
@function mbuf_free
@param mbuf The mbuf to free.
@result The next mbuf in the chain.
*/
-mbuf_t mbuf_free(mbuf_t mbuf);
+extern mbuf_t mbuf_free(mbuf_t mbuf);
/*!
@function mbuf_freem
@discussion Frees a chain of mbufs link through mnext.
@param mbuf The first mbuf in the chain to free.
*/
-void mbuf_freem(mbuf_t mbuf);
+extern void mbuf_freem(mbuf_t mbuf);
/*!
@function mbuf_freem_list
@param mbuf The first mbuf in the linked list to free.
@result The number of mbufs freed.
*/
-int mbuf_freem_list(mbuf_t mbuf);
+extern int mbuf_freem_list(mbuf_t mbuf);
/*!
@function mbuf_leadingspace
@param mbuf The mbuf.
@result The number of unused bytes at the start of the mbuf.
*/
-size_t mbuf_leadingspace(const mbuf_t mbuf);
+extern size_t mbuf_leadingspace(const mbuf_t mbuf);
/*!
@function mbuf_trailingspace
@param mbuf The mbuf.
@result The number of unused bytes following the current data.
*/
-size_t mbuf_trailingspace(const mbuf_t mbuf);
+extern size_t mbuf_trailingspace(const mbuf_t mbuf);
/* Manipulation */
@param new_mbuf Upon success, the newly allocated mbuf.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_copym(const mbuf_t src, size_t offset, size_t len,
- mbuf_how_t how, mbuf_t* new_mbuf);
+extern errno_t mbuf_copym(const mbuf_t src, size_t offset, size_t len,
+ mbuf_how_t how, mbuf_t *new_mbuf);
/*!
@function mbuf_dup
@param new_mbuf Upon success, the newly allocated mbuf.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_dup(const mbuf_t src, mbuf_how_t how, mbuf_t* new_mbuf);
+extern errno_t mbuf_dup(const mbuf_t src, mbuf_how_t how, mbuf_t *new_mbuf);
/*!
@function mbuf_prepend
@param how Blocking or non-blocking.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_prepend(mbuf_t* mbuf, size_t len, mbuf_how_t how);
+extern errno_t mbuf_prepend(mbuf_t *mbuf, size_t len, mbuf_how_t how);
/*!
@function mbuf_split
failure, the original mbuf chain passed in to src will be
preserved.
*/
-errno_t mbuf_split(mbuf_t src, size_t offset,
- mbuf_how_t how, mbuf_t* new_mbuf);
+extern errno_t mbuf_split(mbuf_t src, size_t offset, mbuf_how_t how,
+ mbuf_t *new_mbuf);
/*!
@function mbuf_pullup
@result 0 upon success otherwise the errno error. In the case of an
error, the mbuf chain has been freed.
*/
-errno_t mbuf_pullup(mbuf_t* mbuf, size_t len);
+extern errno_t mbuf_pullup(mbuf_t *mbuf, size_t len);
/*!
@function mbuf_pulldown
in.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_pulldown(mbuf_t src, size_t *offset, size_t length, mbuf_t *location);
+extern errno_t mbuf_pulldown(mbuf_t src, size_t *offset, size_t length,
+ mbuf_t *location);
/*!
@function mbuf_adj
@param mbuf The mbuf chain to trim.
@param len The number of bytes to trim from the mbuf chain.
*/
-void mbuf_adj(mbuf_t mbuf, int len);
+extern void mbuf_adj(mbuf_t mbuf, int len);
/*!
@function mbuf_adjustlen
@param amount The number of bytes increment the length by.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_adjustlen(mbuf_t mbuf, int amount);
+extern errno_t mbuf_adjustlen(mbuf_t mbuf, int amount);
+
+/*!
+ @function mbuf_concatenate
+ @discussion Concatenate mbuf chain src to dst using m_next and return
+ a chain which represents the concatenated chain. The routine
+ does not prevent two chains of different mbuf types to be
+ concatenated, nor does it modify any packet header in the
+ destination chain. Therefore, it's the responsibility of the
+ caller to ensure that the resulted concatenated mbuf chain is
+ correct for further usages.
+ @param dst The destination mbuf chain.
+ @param src The source mbuf chain.
+ @result A pointer to the head of the concatenated mbuf chain. This
+ should be treated as the updated destination mbuf chain; the
+ caller must no longer refer to the original src or dst mbuf
+ chain. Otherwise it returns NULL if the original dst mbuf
+ chain is NULL.
+ */
+extern mbuf_t mbuf_concatenate(mbuf_t dst, mbuf_t src);
/*!
@function mbuf_copydata
copied.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_copydata(const mbuf_t mbuf, size_t offset, size_t length, void* out_data);
+extern errno_t mbuf_copydata(const mbuf_t mbuf, size_t offset, size_t length,
+ void *out_data);
/*!
@function mbuf_copyback
@discussion Copies data from a buffer to an mbuf chain.
mbuf_copyback will grow the chain to fit the specified buffer.
-
+
If mbuf_copydata is unable to allocate enough mbufs to grow the
chain, ENOBUFS will be returned. The mbuf chain will be shorter
than expected but all of the data up to the end of the mbuf
chain will be valid.
-
+
If an offset is specified, mbuf_copyback will skip that many
bytes in the mbuf chain before starting to write the buffer in
to the chain. If the mbuf chain does not contain this many
@param how Blocking or non-blocking.
@result 0 upon success, EINVAL or ENOBUFS upon failure.
*/
-errno_t mbuf_copyback(mbuf_t mbuf, size_t offset, size_t length,
- const void *data, mbuf_how_t how);
+extern errno_t mbuf_copyback(mbuf_t mbuf, size_t offset, size_t length,
+ const void *data, mbuf_how_t how);
/*!
@function mbuf_mclhasreference
@param mbuf The mbuf with the cluster to test.
@result 0 if there is no reference by another mbuf, 1 otherwise.
*/
-int mbuf_mclhasreference(mbuf_t mbuf);
+extern int mbuf_mclhasreference(mbuf_t mbuf);
/* mbuf header */
@param mbuf The mbuf.
@result The next mbuf in the chain.
*/
-mbuf_t mbuf_next(const mbuf_t mbuf);
+extern mbuf_t mbuf_next(const mbuf_t mbuf);
/*!
@function mbuf_setnext
@param next The new next mbuf.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_setnext(mbuf_t mbuf, mbuf_t next);
+extern errno_t mbuf_setnext(mbuf_t mbuf, mbuf_t next);
/*!
@function mbuf_nextpkt
@param mbuf The mbuf.
@result The nextpkt.
*/
-mbuf_t mbuf_nextpkt(const mbuf_t mbuf);
+extern mbuf_t mbuf_nextpkt(const mbuf_t mbuf);
/*!
@function mbuf_setnextpkt
@param mbuf The mbuf.
@param nextpkt The new next packet.
*/
-void mbuf_setnextpkt(mbuf_t mbuf, mbuf_t nextpkt);
+extern void mbuf_setnextpkt(mbuf_t mbuf, mbuf_t nextpkt);
/*!
@function mbuf_len
@param mbuf The mbuf.
@result The length.
*/
-size_t mbuf_len(const mbuf_t mbuf);
+extern size_t mbuf_len(const mbuf_t mbuf);
/*!
@function mbuf_setlen
@param len The new length.
@result 0 upon success otherwise the errno error.
*/
-void mbuf_setlen(mbuf_t mbuf, size_t len);
+extern void mbuf_setlen(mbuf_t mbuf, size_t len);
/*!
@function mbuf_maxlen
@param mbuf The mbuf.
@result The maximum lenght of data for this mbuf.
*/
-size_t mbuf_maxlen(const mbuf_t mbuf);
+extern size_t mbuf_maxlen(const mbuf_t mbuf);
/*!
@function mbuf_type
@param mbuf The mbuf.
@result The type.
*/
-mbuf_type_t mbuf_type(const mbuf_t mbuf);
+extern mbuf_type_t mbuf_type(const mbuf_t mbuf);
/*!
@function mbuf_settype
@param new_type The new type.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_settype(mbuf_t mbuf, mbuf_type_t new_type);
+extern errno_t mbuf_settype(mbuf_t mbuf, mbuf_type_t new_type);
/*!
@function mbuf_flags
@param mbuf The mbuf.
@result The flags.
*/
-mbuf_flags_t mbuf_flags(const mbuf_t mbuf);
+extern mbuf_flags_t mbuf_flags(const mbuf_t mbuf);
/*!
@function mbuf_setflags
@param flags The flags that should be set, all other flags will be cleared.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_setflags(mbuf_t mbuf, mbuf_flags_t flags);
+extern errno_t mbuf_setflags(mbuf_t mbuf, mbuf_flags_t flags);
/*!
@function mbuf_setflags_mask
@param mask The mask controlling which flags will be modified.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_setflags_mask(mbuf_t mbuf, mbuf_flags_t flags,
- mbuf_flags_t mask);
+extern errno_t mbuf_setflags_mask(mbuf_t mbuf, mbuf_flags_t flags,
+ mbuf_flags_t mask);
/*!
@function mbuf_copy_pkthdr
@param mbuf The mbuf to which the packet header will be copied.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_copy_pkthdr(mbuf_t dest, const mbuf_t src);
+extern errno_t mbuf_copy_pkthdr(mbuf_t dest, const mbuf_t src);
/*!
@function mbuf_pkthdr_len
be changed.
@result The length, in bytes, of the packet.
*/
-size_t mbuf_pkthdr_len(const mbuf_t mbuf);
+extern size_t mbuf_pkthdr_len(const mbuf_t mbuf);
/*!
@function mbuf_pkthdr_setlen
@param mbuf The mbuf containing the packet header.
@param len The new length of the packet.
*/
-void mbuf_pkthdr_setlen(mbuf_t mbuf, size_t len);
+extern void mbuf_pkthdr_setlen(mbuf_t mbuf, size_t len);
/*!
@function mbuf_pkthdr_adjustlen
@param amount The number of bytes to adjust the packet header length
field by.
*/
-void mbuf_pkthdr_adjustlen(mbuf_t mbuf, int amount);
+extern void mbuf_pkthdr_adjustlen(mbuf_t mbuf, int amount);
/*!
@function mbuf_pkthdr_rcvif
@param mbuf The mbuf containing the packet header.
@result A reference to the interface.
*/
-ifnet_t mbuf_pkthdr_rcvif(const mbuf_t mbuf);
+extern ifnet_t mbuf_pkthdr_rcvif(const mbuf_t mbuf);
/*!
@function mbuf_pkthdr_setrcvif
@param ifnet A reference to an interface.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_pkthdr_setrcvif(mbuf_t mbuf, ifnet_t ifp);
+extern errno_t mbuf_pkthdr_setrcvif(mbuf_t mbuf, ifnet_t ifp);
/*!
@function mbuf_pkthdr_header
@param mbuf The mbuf containing the packet header.
@result A pointer to the packet header.
*/
-void* mbuf_pkthdr_header(const mbuf_t mbuf);
+extern void *mbuf_pkthdr_header(const mbuf_t mbuf);
/*!
@function mbuf_pkthdr_setheader
@param ifnet A pointer to the header.
@result 0 upon success otherwise the errno error.
*/
-void mbuf_pkthdr_setheader(mbuf_t mbuf, void* header);
+extern void mbuf_pkthdr_setheader(mbuf_t mbuf, void *header);
/* Checksums */
original checksum was valid.
@param mbuf The mbuf that has been modified.
*/
-void mbuf_inbound_modified(mbuf_t mbuf);
+extern void mbuf_inbound_modified(mbuf_t mbuf);
/*!
@function mbuf_outbound_finalize
@discussion This function will "finalize" the packet allowing your
code to inspect the final packet.
-
+
There are a number of operations that are performed in hardware,
such as calculating checksums. This function will perform in
software the various opterations that were scheduled to be done
hardware, you must call this function to get an aproximate final
packet. If you plan to modify the packet in any way, you should
call this function.
-
+
This function should be called before modifying any outbound
packets.
-
+
This function may be called at various levels, in some cases
additional headers may have already been prepended, such as the
case of a packet seen by an interface filter. To handle this,
protocol header. For an IP packet with an ethernet header, this
would be the length of an ethernet header.
*/
-void mbuf_outbound_finalize(mbuf_t mbuf, u_long protocol_family,
- size_t protocol_offset);
+extern void mbuf_outbound_finalize(mbuf_t mbuf, u_int32_t protocol_family,
+ size_t protocol_offset);
/*!
@function mbuf_set_vlan_tag
@param vlan The protocol family of the aux data to add.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_set_vlan_tag(mbuf_t mbuf, u_int16_t vlan);
+extern errno_t mbuf_set_vlan_tag(mbuf_t mbuf, u_int16_t vlan);
/*!
@function mbuf_get_vlan_tag
@result 0 upon success otherwise the errno error. ENXIO indicates
that the vlan tag is not set.
*/
-errno_t mbuf_get_vlan_tag(mbuf_t mbuf, u_int16_t *vlan);
+extern errno_t mbuf_get_vlan_tag(mbuf_t mbuf, u_int16_t *vlan);
/*!
@function mbuf_clear_vlan_tag
@param mbuf The mbuf containing the packet.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_clear_vlan_tag(mbuf_t mbuf);
+extern errno_t mbuf_clear_vlan_tag(mbuf_t mbuf);
#ifdef KERNEL_PRIVATE
/*
@param value This parameter is currently unsupported.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_set_csum_requested(mbuf_t mbuf,
- mbuf_csum_request_flags_t request, u_int32_t value);
-#endif
+extern errno_t mbuf_set_csum_requested(mbuf_t mbuf,
+ mbuf_csum_request_flags_t request, u_int32_t value);
+#endif /* KERNEL_PRIVATE */
/*!
@function mbuf_get_csum_requested
@param value This parameter is currently unsupported.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_get_csum_requested(mbuf_t mbuf,
- mbuf_csum_request_flags_t *request, u_int32_t *value);
+extern errno_t mbuf_get_csum_requested(mbuf_t mbuf,
+ mbuf_csum_request_flags_t *request, u_int32_t *value);
+
+/*!
+ @function mbuf_get_tso_requested
+ @discussion This function is used by the driver to determine which
+ checksum operations should be performed in hardware.
+ @param mbuf The mbuf containing the packet.
+ @param request Flags indicating which values are being requested
+ for this packet.
+ @param value The requested value.
+ @result 0 upon success otherwise the errno error.
+ */
+extern errno_t mbuf_get_tso_requested(mbuf_t mbuf,
+ mbuf_tso_request_flags_t *request, u_int32_t *value);
/*!
@function mbuf_clear_csum_requested
@param mbuf The mbuf containing the packet.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_clear_csum_requested(mbuf_t mbuf);
+extern errno_t mbuf_clear_csum_requested(mbuf_t mbuf);
/*!
@function mbuf_set_csum_performed
hardware.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_set_csum_performed(mbuf_t mbuf,
- mbuf_csum_performed_flags_t flags, u_int32_t value);
+extern errno_t mbuf_set_csum_performed(mbuf_t mbuf,
+ mbuf_csum_performed_flags_t flags, u_int32_t value);
#ifdef KERNEL_PRIVATE
/*
hardware.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_get_csum_performed(mbuf_t mbuf,
- mbuf_csum_performed_flags_t *flags, u_int32_t *value);
-#endif
+extern errno_t mbuf_get_csum_performed(mbuf_t mbuf,
+ mbuf_csum_performed_flags_t *flags, u_int32_t *value);
+#endif /* KERNEL_PRIVATE */
+
+/*!
+ @function mbuf_get_mlen
+ @discussion This routine returns the number of data bytes in a normal
+ mbuf, i.e. an mbuf that is not a packet header, nor one with
+ an external cluster attached to it. This is equivalent to the
+ legacy MLEN macro.
+ @result The number of bytes of available data.
+ */
+extern u_int32_t mbuf_get_mlen(void);
+
+/*!
+ @function mbuf_get_mhlen
+ @discussion This routine returns the number of data bytes in a packet
+ header mbuf. This is equivalent to the legacy MHLEN macro.
+ @result The number of bytes of available data.
+ */
+extern u_int32_t mbuf_get_mhlen(void);
/*!
@function mbuf_clear_csum_performed
@param mbuf The mbuf containing the packet.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_clear_csum_performed(mbuf_t mbuf);
+extern errno_t mbuf_clear_csum_performed(mbuf_t mbuf);
/*!
@function mbuf_inet_cksum
this variable. The caller must set it to a non-NULL value.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_inet_cksum(mbuf_t mbuf, int protocol, u_int32_t offset,
- u_int32_t length, u_int16_t *csum);
+extern errno_t mbuf_inet_cksum(mbuf_t mbuf, int protocol, u_int32_t offset,
+ u_int32_t length, u_int16_t *csum);
/*!
@function mbuf_inet6_cksum
this variable. The caller must set it to a non-NULL value.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_inet6_cksum(mbuf_t mbuf, int protocol, u_int32_t offset,
- u_int32_t length, u_int16_t *csum);
+extern errno_t mbuf_inet6_cksum(mbuf_t mbuf, int protocol, u_int32_t offset,
+ u_int32_t length, u_int16_t *csum);
/* mbuf tags */
@discussion Lookup the module id for a string. If there is no module
id assigned to this string, a new module id will be assigned.
The string should be the bundle id of the kext. In the case of a
- tag that will be shared across multiple kexts, a common bundle id
- style string should be used.
-
+ tag that will be shared across multiple kexts, a common bundle
+ id style string should be used.
+
The lookup operation is not optimized. A module should call this
- function once during startup and chache the module id. The module id
- will not be resassigned until the machine reboots.
+ function once during startup and chache the module id. The
+ module id will not be resassigned until the machine reboots.
@param module_string A unique string identifying your module.
Example: com.apple.nke.SharedIP.
@param module_id Upon return, a unique identifier for use with
is rebooted.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_tag_id_find(const char *module_string,
- mbuf_tag_id_t *module_id);
+extern errno_t mbuf_tag_id_find(const char *module_string,
+ mbuf_tag_id_t *module_id);
/*!
@function mbuf_tag_allocate
@discussion Allocate an mbuf tag. Mbuf tags allow various portions
of the stack to tag mbufs with data that will travel with the
mbuf through the stack.
-
- Tags may only be added to mbufs with packet headers
+
+ Tags may only be added to mbufs with packet headers
(MBUF_PKTHDR flag is set). Mbuf tags are freed when the mbuf is
freed or when mbuf_tag_free is called.
@param mbuf The mbuf to attach this tag to.
buffer allocated for the mtag.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_tag_allocate(mbuf_t mbuf, mbuf_tag_id_t module_id,
- mbuf_tag_type_t type, size_t length,
- mbuf_how_t how, void** data_p);
+extern errno_t mbuf_tag_allocate(mbuf_t mbuf, mbuf_tag_id_t module_id,
+ mbuf_tag_type_t type, size_t length, mbuf_how_t how, void **data_p);
/*!
@function mbuf_tag_find
buffer allocated for the mtag.
@result 0 upon success otherwise the errno error.
*/
-errno_t mbuf_tag_find(mbuf_t mbuf, mbuf_tag_id_t module_id,
- mbuf_tag_type_t type, size_t *length, void** data_p);
+extern errno_t mbuf_tag_find(mbuf_t mbuf, mbuf_tag_id_t module_id,
+ mbuf_tag_type_t type, size_t *length, void **data_p);
/*!
@function mbuf_tag_free
@param module_id The ID of the tag to free.
@param type The type of the tag to free.
*/
-void mbuf_tag_free(mbuf_t mbuf, mbuf_tag_id_t module_id,
- mbuf_tag_type_t type);
+extern void mbuf_tag_free(mbuf_t mbuf, mbuf_tag_id_t module_id,
+ mbuf_tag_type_t type);
/* mbuf stats */
@discussion Get the mbuf statistics.
@param stats Storage to copy the stats in to.
*/
-void mbuf_stats(struct mbuf_stat* stats);
+extern void mbuf_stats(struct mbuf_stat *stats);
+#ifdef KERNEL_PRIVATE
+/*
+ @enum mbuf_priority_t
+ @abstract Priority of a packet.
+ @discussion Some mbufs represent packets containing application data.
+ The priority of the application data is represented by the
+ mbuf priority, as determined by the system.
+ @constant MBUF_PRIORITY_NORMAL Indicates the packet contains
+ normal priority data.
+ @constant MBUF_PRIORITY_BACKGROUND Indicates the packet contains
+ background priority data.
+ */
+typedef enum {
+ MBUF_PRIORITY_NORMAL = 0,
+ MBUF_PRIORITY_BACKGROUND = 1
+} mbuf_priority_t;
+/*
+ @function mbuf_get_priority
+ @discussion Get the priority value of the packet.
+ @param mbuf The mbuf to obtain the priority value from.
+ @result The priority value of the packet.
+ */
+extern mbuf_priority_t mbuf_get_priority(mbuf_t mbuf);
+
+/*
+ @enum mbuf_traffic_class_t
+ @abstract Traffic class of a packet
+ @discussion Property that represent the category of traffic of a packet.
+ This information may be used by the driver and at the link level.
+ @constant MBUF_TC_BE Best effort, normal class.
+ @constant MBUF_TC_BK Background, low priority or bulk traffic.
+ @constant MBUF_TC_VI Interactive video, constant bit rate, low latency.
+ @constant MBUF_TC_VO Interactive voice, constant bit rate, lowest latency.
+*/
+typedef enum {
+#ifdef XNU_KERNEL_PRIVATE
+ MBUF_TC_NONE = -1,
+#endif
+ MBUF_TC_BE = 0,
+ MBUF_TC_BK = 1,
+ MBUF_TC_VI = 2,
+ MBUF_TC_VO = 3
+} mbuf_traffic_class_t;
+
+/*
+ @function mbuf_get_traffic_class
+ @discussion Get the traffic class of an mbuf packet
+ @param mbuf The mbuf to get the traffic class of.
+ @result The traffic class
+*/
+extern mbuf_traffic_class_t mbuf_get_traffic_class(mbuf_t mbuf);
+
+/*
+ @function mbuf_set_traffic_class
+ @discussion Set the traffic class of an mbuf packet.
+ @param mbuf The mbuf to set the traffic class on.
+ @ac The traffic class
+ @result 0 on success, EINVAL if bad paramater is passed
+*/
+extern errno_t mbuf_set_traffic_class(mbuf_t mbuf, mbuf_traffic_class_t tc);
+#endif /* KERNEL_PRIVATE */
/* IF_QUEUE interaction */
-#define IF_ENQUEUE_MBUF(ifq, m) { \
- mbuf_setnextpkt((m), 0); \
- if ((ifq)->ifq_tail == 0) \
- (ifq)->ifq_head = (m); \
- else \
- mbuf_setnextpkt((mbuf_t)(ifq)->ifq_tail, (m)); \
- (ifq)->ifq_tail = (m); \
- (ifq)->ifq_len++; \
+#define IF_ENQUEUE_MBUF(ifq, m) { \
+ mbuf_setnextpkt((m), 0); \
+ if ((ifq)->ifq_tail == 0) \
+ (ifq)->ifq_head = (m); \
+ else \
+ mbuf_setnextpkt((mbuf_t)(ifq)->ifq_tail, (m)); \
+ (ifq)->ifq_tail = (m); \
+ (ifq)->ifq_len++; \
}
-#define IF_PREPEND_MBUF(ifq, m) { \
- mbuf_setnextpkt((m), (ifq)->ifq_head); \
- if ((ifq)->ifq_tail == 0) \
- (ifq)->ifq_tail = (m); \
- (ifq)->ifq_head = (m); \
- (ifq)->ifq_len++; \
+
+#define IF_PREPEND_MBUF(ifq, m) { \
+ mbuf_setnextpkt((m), (ifq)->ifq_head); \
+ if ((ifq)->ifq_tail == 0) \
+ (ifq)->ifq_tail = (m); \
+ (ifq)->ifq_head = (m); \
+ (ifq)->ifq_len++; \
}
-#define IF_DEQUEUE_MBUF(ifq, m) { \
- (m) = (ifq)->ifq_head; \
- if (m) { \
- if (((ifq)->ifq_head = mbuf_nextpkt((m))) == 0) \
- (ifq)->ifq_tail = 0; \
- mbuf_setnextpkt((m), 0); \
- (ifq)->ifq_len--; \
- } \
+
+#define IF_DEQUEUE_MBUF(ifq, m) { \
+ (m) = (ifq)->ifq_head; \
+ if (m) { \
+ if (((ifq)->ifq_head = mbuf_nextpkt((m))) == 0) \
+ (ifq)->ifq_tail = 0; \
+ mbuf_setnextpkt((m), 0); \
+ (ifq)->ifq_len--; \
+ } \
}
__END_DECLS
-#endif
+#endif /* __KPI_MBUF__ */
projects / apple / xnu.git / blobdiff