]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/net/pktap.h
xnu-7195.101.1.tar.gz
[apple/xnu.git] / bsd / net / pktap.h
index ef5ec8c7cc76aa4004e2cb459369b0f418a8d23e..5e07f99d6a465c8d282653f9904145c959b09a7b 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012-2014 Apple Inc. All rights reserved.
+ * Copyright (c) 2012-2017 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  *
@@ -33,6 +33,7 @@
 #include <stdint.h>
 #include <net/if.h>
 #include <uuid/uuid.h>
+#include <string.h>
 
 #ifdef PRIVATE
 
 /*
  * Commands via SIOCGDRVSPEC/SIOCSDRVSPEC
  */
-#define PKTP_CMD_FILTER_GET    1       /* array of PKTAP_MAX_FILTERS * struct pktap_filter */
-#define PKTP_CMD_FILTER_SET    3       /* array of PKTAP_MAX_FILTERS * struct pktap_filter */
-#define PKTP_CMD_TAP_COUNT     4       /* uint32_t number of active bpf tap on the interface */
+#define PKTP_CMD_FILTER_GET     1       /* array of PKTAP_MAX_FILTERS * struct pktap_filter */
+#define PKTP_CMD_FILTER_SET     3       /* array of PKTAP_MAX_FILTERS * struct pktap_filter */
+#define PKTP_CMD_TAP_COUNT      4       /* uint32_t number of active bpf tap on the interface */
 
 /*
  * Filtering is currently based on network interface properties --
- * the interface type and the interface name -- and has two types of 
+ * the interface type and the interface name -- and has two types of
  * operations -- pass and skip.
  * By default only interfaces of type IFT_ETHER and IFT_CELLULAR pass
  * the filter.
  * It's possible to include other interfaces by type or by name
  * The interface type is evaluated before the interface name
- * The first matching rule stops the evaluation. 
+ * The first matching rule stops the evaluation.
  * A rule with interface type 0 (zero) matches any interfaces
  */
-#define PKTAP_FILTER_OP_NONE   0       /* For inactive entries at the end of the list */
-#define PKTAP_FILTER_OP_PASS   1
-#define PKTAP_FILTER_OP_SKIP   2
+#define PKTAP_FILTER_OP_NONE    0       /* For inactive entries at the end of the list */
+#define PKTAP_FILTER_OP_PASS    1
+#define PKTAP_FILTER_OP_SKIP    2
 
-#define PKTAP_FILTER_PARAM_NONE                0
-#define PKTAP_FILTER_PARAM_IF_TYPE     1
-#define PKTAP_FILTER_PARAM_IF_NAME     2
+#define PKTAP_FILTER_PARAM_NONE         0
+#define PKTAP_FILTER_PARAM_IF_TYPE      1
+#define PKTAP_FILTER_PARAM_IF_NAME      2
 
 #ifdef BSD_KERNEL_PRIVATE
 struct pktap_filter {
-       uint32_t        filter_op;
-       uint32_t        filter_param;
+       uint32_t        filter_op;
+       uint32_t        filter_param;
        union {
-               uint32_t        _filter_if_type;
-               char            _filter_if_name[PKTAP_IFXNAMESIZE];
+               uint32_t        _filter_if_type;
+               char            _filter_if_name[PKTAP_IFXNAMESIZE];
        } param_;
-       size_t          filter_ifname_prefix_len;
+       size_t          filter_ifname_prefix_len;
 };
 
 struct x_pktap_filter {
 #else
 struct pktap_filter {
 #endif /* BSD_KERNEL_PRIVATE */
-       uint32_t        filter_op;
-       uint32_t        filter_param;
+       uint32_t        filter_op;
+       uint32_t        filter_param;
        union {
-               uint32_t        _filter_if_type;
-               char            _filter_if_name[PKTAP_IFXNAMESIZE];
+               uint32_t        _filter_if_type;
+               char            _filter_if_name[PKTAP_IFXNAMESIZE];
        } param_;
 };
 #define filter_param_if_type param_._filter_if_type
@@ -100,54 +101,147 @@ struct pktap_filter {
  * In theory, there could be several types of blocks in a chain before the actual packet
  */
 struct pktap_header {
-       uint32_t                pth_length;                     /* length of this header */
-       uint32_t                pth_type_next;                  /* type of data following */
-       uint32_t                pth_dlt;                        /* DLT of packet */
-       char                    pth_ifname[PKTAP_IFXNAMESIZE];  /* interface name */
-       uint32_t                pth_flags;                      /* flags */
-       uint32_t                pth_protocol_family;
-       uint32_t                pth_frame_pre_length;
-       uint32_t                pth_frame_post_length;
-       pid_t                   pth_pid;                        /* process ID */
-       char                    pth_comm[MAXCOMLEN+1];          /* process name */
-       uint32_t                pth_svc;                        /* service class */
-       uint16_t                pth_iftype;
-       uint16_t                pth_ifunit;
-       pid_t                   pth_epid;               /* effective process ID */
-       char                    pth_ecomm[MAXCOMLEN+1]; /* effective command name */
-       uint32_t                pth_flowid;
-       uint32_t                pth_ipproto;
-       struct timeval32        pth_tstamp;
-       uuid_t                  pth_uuid;
-       uuid_t                  pth_euuid;      
+       uint32_t                pth_length;                     /* length of this header */
+       uint32_t                pth_type_next;                  /* type of data following */
+       uint32_t                pth_dlt;                        /* DLT of packet */
+       char                    pth_ifname[PKTAP_IFXNAMESIZE];  /* interface name */
+       uint32_t                pth_flags;                      /* flags */
+       uint32_t                pth_protocol_family;
+       uint32_t                pth_frame_pre_length;
+       uint32_t                pth_frame_post_length;
+       pid_t                   pth_pid;                        /* process ID */
+       char                    pth_comm[MAXCOMLEN + 1];          /* process name */
+       uint32_t                pth_svc;                        /* service class */
+       uint16_t                pth_iftype;
+       uint16_t                pth_ifunit;
+       pid_t                   pth_epid;               /* effective process ID */
+       char                    pth_ecomm[MAXCOMLEN + 1]; /* effective command name */
+       uint32_t                pth_flowid;
+       uint32_t                pth_ipproto;
+       struct timeval32        pth_tstamp;
+       uuid_t                  pth_uuid;
+       uuid_t                  pth_euuid;
 };
 
 /*
+ * The original version 1 of the pktap_header structure always had the field
+ * pth_type_next set to PTH_TYPE_PACKET
+ */
+#define PTH_TYPE_NONE   0               /* No more data following */
+#define PTH_TYPE_PACKET 1               /* Actual captured packet data */
+
+/*
+ * Size of buffer that can contain any pktap header
+ * followed by the optional 4 bytes protocol field
+ * or 16 bytes link layer header
+ */
+union pktap_header_extra {
+       uint8_t         llhdr[16];
+       uint32_t        proto;
+};
+
+/*
+ * Version 2 version of the header
  *
+ * The field pth_flags is at the same offset as the orignal pktap_header and
+ * the flag PTH_FLAG_V2_HDR allows to differentiate the header version.
  */
-#define PTH_TYPE_NONE  0               /* No more data following */
-#define PTH_TYPE_PACKET        1               /* Actual captured packet data */
 
-#define PTH_FLAG_DIR_IN                        0x0001  /* Outgoing packet */
-#define PTH_FLAG_DIR_OUT               0x0002  /* Incoming packet */
-#define PTH_FLAG_PROC_DELEGATED                0x0004  /* Process delegated */
-#define PTH_FLAG_IF_DELEGATED          0x0008  /* Interface delegated */
+#define PKTAP_MAX_COMM_SIZE (MAXCOMLEN + 1)
+
+struct pktap_v2_hdr {
+       uint8_t                 pth_length;                     /* length of this header */
+       uint8_t                 pth_uuid_offset;                /* max size: sizeof(uuid_t) */
+       uint8_t                 pth_e_uuid_offset;              /* max size: sizeof(uuid_t) */
+       uint8_t                 pth_ifname_offset;              /* max size: PKTAP_IFXNAMESIZE*/
+       uint8_t                 pth_comm_offset;                /* max size: PKTAP_MAX_COMM_SIZE */
+       uint8_t                 pth_e_comm_offset;              /* max size: PKTAP_MAX_COMM_SIZE */
+       uint16_t                pth_dlt;                        /* DLT of packet */
+       uint16_t                pth_frame_pre_length;
+       uint16_t                pth_frame_post_length;
+       uint16_t                pth_iftype;
+       uint16_t                pth_ipproto;
+       uint32_t                pth_protocol_family;
+       uint32_t                pth_svc;                        /* service class */
+       uint32_t                pth_flowid;
+       pid_t                   pth_pid;                        /* process ID */
+       pid_t                   pth_e_pid;                      /* effective process ID */
+       uint32_t                pth_flags;                      /* flags */
+};
+
+struct pktap_v2_hdr_space {
+       struct pktap_v2_hdr pth_hdr;
+       uint8_t pth_uuid[sizeof(uuid_t)];
+       uint8_t pth_e_uuid[sizeof(uuid_t)];
+       uint8_t pth_ifname[PKTAP_IFXNAMESIZE];
+       uint8_t pth_comm[PKTAP_MAX_COMM_SIZE];
+       uint8_t pth_e_comm[PKTAP_MAX_COMM_SIZE];
+};
+
+struct pktap_buffer_v2_hdr_extra {
+       struct pktap_v2_hdr_space hdr_space;
+       union pktap_header_extra extra;
+};
+
+#define COPY_PKTAP_COMMON_FIELDS_TO_V2(pktap_v2_hdr_dst, pktap_header_src) { \
+       (pktap_v2_hdr_dst)->pth_length = sizeof(struct pktap_v2_hdr); \
+       (pktap_v2_hdr_dst)->pth_uuid_offset = 0; \
+       (pktap_v2_hdr_dst)->pth_e_uuid_offset = 0; \
+       (pktap_v2_hdr_dst)->pth_ifname_offset = 0; \
+       (pktap_v2_hdr_dst)->pth_comm_offset = 0; \
+       (pktap_v2_hdr_dst)->pth_e_comm_offset = 0; \
+       (pktap_v2_hdr_dst)->pth_dlt = (uint16_t)(pktap_header_src)->pth_dlt; \
+       (pktap_v2_hdr_dst)->pth_frame_pre_length = (uint16_t)(pktap_header_src)->pth_frame_pre_length; \
+       (pktap_v2_hdr_dst)->pth_frame_post_length = (uint16_t)(pktap_header_src)->pth_frame_post_length; \
+       (pktap_v2_hdr_dst)->pth_iftype = (pktap_header_src)->pth_iftype; \
+       (pktap_v2_hdr_dst)->pth_ipproto = (uint16_t)(pktap_header_src)->pth_ipproto; \
+       (pktap_v2_hdr_dst)->pth_protocol_family = (pktap_header_src)->pth_protocol_family; \
+       (pktap_v2_hdr_dst)->pth_svc = (pktap_header_src)->pth_svc; \
+       (pktap_v2_hdr_dst)->pth_flowid = (pktap_header_src)->pth_flowid; \
+       (pktap_v2_hdr_dst)->pth_pid = (pktap_header_src)->pth_pid; \
+       (pktap_v2_hdr_dst)->pth_e_pid = (pktap_header_src)->pth_epid; \
+       (pktap_v2_hdr_dst)->pth_flags = (pktap_header_src)->pth_flags; \
+       (pktap_v2_hdr_dst)->pth_flags |= PTH_FLAG_V2_HDR; \
+}
+
+/*
+ * Values for field pth_flags
+ */
+#define PTH_FLAG_DIR_IN         0x00000001 /* Outgoing packet */
+#define PTH_FLAG_DIR_OUT        0x00000002 /* Incoming packet */
+#define PTH_FLAG_PROC_DELEGATED 0x00000004 /* Process delegated */
+#define PTH_FLAG_IF_DELEGATED   0x00000008 /* Interface delegated */
 #ifdef BSD_KERNEL_PRIVATE
-#define PTH_FLAG_DELAY_PKTAP           0x1000  /* Finalize pktap header on read */
+#define PTH_FLAG_DELAY_PKTAP    0x00001000 /* Finalize pktap header on read */
 #endif /* BSD_KERNEL_PRIVATE */
-#define PTH_FLAG_TSTAMP                        0x2000  /* Has time stamp */
-#define        PTH_FLAG_NEW_FLOW               0x4000  /* Packet from a new flow */
-
+#define PTH_FLAG_TSTAMP         0x00002000 /* Has time stamp */
+#define PTH_FLAG_NEW_FLOW       0x00004000 /* Packet from a new flow */
+#define PTH_FLAG_REXMIT         0x00008000 /* Packet is a retransmission */
+#define PTH_FLAG_KEEP_ALIVE     0x00010000 /* Is keep alive packet */
+#define PTH_FLAG_SOCKET         0x00020000 /* Packet on a Socket */
+#define PTH_FLAG_NEXUS_CHAN     0x00040000 /* Packet on a nexus channel */
+#define PTH_FLAG_V2_HDR         0x00080000 /* Version 2 of pktap */
 
 #ifdef BSD_KERNEL_PRIVATE
+
+#include <net/bpf.h>
+
+struct pktap_header_buffer {
+       struct pktap_header             pkth;
+       union pktap_header_extra        extra;
+};
+
+extern uint32_t pktap_total_tap_count;
+
 extern void pktap_init(void);
 extern void pktap_input(struct ifnet *, protocol_family_t, struct mbuf *, char *);
-extern void pktap_output(struct ifnet *, protocol_family_t, struct mbuf *, 
-       u_int32_t, u_int32_t);
-extern void pktap_fill_proc_info(struct pktap_header *, protocol_family_t , 
-       struct mbuf *, u_int32_t , int , struct ifnet *);
+extern void pktap_output(struct ifnet *, protocol_family_t, struct mbuf *,
+    u_int32_t, u_int32_t);
+extern void pktap_fill_proc_info(struct pktap_header *, protocol_family_t,
+    struct mbuf *, u_int32_t, int, struct ifnet *);
 extern void pktap_finalize_proc_info(struct pktap_header *);
-
+extern void pktap_v2_finalize_proc_info(struct pktap_v2_hdr *);
+extern void convert_to_pktap_header_to_v2(struct bpf_packet *bpf_pkt, bool truncate);
 #endif /* BSD_KERNEL_PRIVATE */
 #endif /* PRIVATE */