]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/net/pf_pbuf.h
xnu-4570.1.46.tar.gz
[apple/xnu.git] / bsd / net / pf_pbuf.h
diff --git a/bsd/net/pf_pbuf.h b/bsd/net/pf_pbuf.h
new file mode 100644 (file)
index 0000000..55c7f0a
--- /dev/null
@@ -0,0 +1,106 @@
+/*
+ * Copyright (c) 2016 Apple Inc. All rights reserved.
+ *
+ * @APPLE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this
+ * file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_LICENSE_HEADER_END@
+ */
+
+#ifndef __PBUF_H__
+#define        __PBUF_H__
+
+#include <sys/mbuf.h>
+
+enum pbuf_type {
+       PBUF_TYPE_ZOMBIE = 0,
+       PBUF_TYPE_MBUF,
+       PBUF_TYPE_MEMORY
+};
+
+enum pbuf_action {
+       PBUF_ACTION_DESTROY
+};
+
+#define        PBUF_ACTION_RV_SUCCESS  0
+#define        PBUF_ACTION_RV_FAILURE  (-1)
+
+struct pbuf_memory {
+       uint8_t *pm_buffer;     // Pointer to start of buffer
+       u_int pm_buffer_len;    // Total length of buffer
+       u_int pm_offset;        // Offset to start of payload
+       u_int pm_len;           // Length of payload
+       uint32_t pm_csum_flags;
+       uint32_t pm_csum_data;
+       uint8_t pm_proto;
+       uint8_t pm_flowsrc;
+       uint32_t pm_flowid;
+       uint32_t pm_flags;
+       struct pf_mtag pm_pftag;
+       int (*pm_action)(struct pbuf_memory *, enum pbuf_action);
+       void *pm_action_cookie;
+};
+
+typedef struct pbuf {
+       enum pbuf_type  pb_type;
+       union {
+               struct mbuf *pbu_mbuf;
+               struct pbuf_memory pbu_memory;
+       } pb_u;
+#define        pb_mbuf         pb_u.pbu_mbuf
+#define        pb_memory       pb_u.pbu_memory
+
+       void            *pb_data;
+       uint32_t        pb_packet_len;
+       uint32_t        pb_contig_len;
+       uint32_t        *pb_csum_flags;
+       uint32_t        *pb_csum_data;
+       uint8_t         *pb_proto;
+       uint8_t         *pb_flowsrc;
+       uint32_t        *pb_flowid;
+       uint32_t        *pb_flags;
+       struct pf_mtag  *pb_pftag;
+       struct ifnet    *pb_ifp;
+       struct pbuf     *pb_next;
+} pbuf_t;
+
+#define pbuf_is_valid(pb) (!((pb) == NULL || (pb)->pb_type == PBUF_TYPE_ZOMBIE))
+
+void           pbuf_init_mbuf(pbuf_t *, struct mbuf *, struct ifnet *);
+void           pbuf_init_memory(pbuf_t *, const struct pbuf_memory *,
+                               struct ifnet *);
+void           pbuf_destroy(pbuf_t *);
+void           pbuf_sync(pbuf_t *);
+
+struct mbuf    *pbuf_to_mbuf(pbuf_t *, boolean_t);
+struct mbuf    *pbuf_clone_to_mbuf(pbuf_t *);
+
+void *         pbuf_ensure_contig(pbuf_t *, size_t);
+void *         pbuf_ensure_writable(pbuf_t *, size_t);
+
+void *         pbuf_resize_segment(pbuf_t *, int off, int olen, int nlen);
+void *         pbuf_contig_segment(pbuf_t *, int off, int len);
+
+void           pbuf_copy_data(pbuf_t *, int, int, void *);
+void           pbuf_copy_back(pbuf_t *, int, int, void *);
+
+uint16_t       pbuf_inet_cksum(const pbuf_t *, uint32_t, uint32_t, uint32_t);
+uint16_t       pbuf_inet6_cksum(const pbuf_t *, uint32_t, uint32_t, uint32_t);
+
+mbuf_svc_class_t pbuf_get_service_class(const pbuf_t *);
+
+#endif /* __PBUF_H__ */