xnu-1228.15.4.tar.gz

[apple/xnu.git] / bsd / net / dlil.h

diff --git a/bsd/net/dlil.h b/bsd/net/dlil.h
index 63479e676d3a7c71888b21f6315dda06c386d08d..6e3872b799f5700eff4745d30a87418d8f3020a1 100644 (file)
--- a/bsd/net/dlil.h
+++ b/bsd/net/dlil.h
@@ -1,23 +1,29 @@
 /*
  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
  *
 /*
  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * 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. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 /*
  *     Copyright (c) 1999 Apple Computer, Inc. 
  */
 /*
  *     Copyright (c) 1999 Apple Computer, Inc. 


@@ -25,33 +31,12 @@
  *     Data Link Inteface Layer
  *     Author: Ted Walker
  */
  *     Data Link Inteface Layer
  *     Author: Ted Walker
  */

-
-

 #ifndef DLIL_H
 #define DLIL_H
 #ifndef DLIL_H
 #define DLIL_H

+#ifdef KERNEL

 
 

-#if __STDC__
-
-struct ifnet;
-struct mbuf;
-struct ether_header;
-
-#endif
-
-
-
-#define DLIL_LAST_FILTER   -1
-#define DLIL_NULL_FILTER   -2
-
-#define DLIL_WAIT_FOR_FREE -2
-
-#define DLIL_BLUEBOX 1
-
-
-
-#include <net/if.h>
-#include <net/if_var.h>
-#include <sys/kern_event.h>
+#include <sys/kernel_types.h>
+#include <net/kpi_interface.h>

 
 enum {
        BPF_TAP_DISABLE,
 
 enum {
        BPF_TAP_DISABLE,


@@ -60,266 +45,145 @@ enum {
        BPF_TAP_INPUT_OUTPUT
 };
 
        BPF_TAP_INPUT_OUTPUT
 };
 

+/* Ethernet specific types */
+#define DLIL_DESC_ETYPE2       4
+#define DLIL_DESC_SAP          5
+#define DLIL_DESC_SNAP         6
+/*
+ * DLIL_DESC_ETYPE2 - native_type must point to 2 byte ethernet raw protocol,
+ *                    variants.native_type_length must be set to 2
+ * DLIL_DESC_SAP - native_type must point to 3 byte SAP protocol
+ *                 variants.native_type_length must be set to 3
+ * DLIL_DESC_SNAP - native_type must point to 5 byte SNAP protocol
+ *                  variants.native_type_length must be set to 5
+ *
+ * All protocols must be in Network byte order.
+ *
+ * Future interface families may define more protocol types they know about.
+ * The type implies the offset and context of the protocol data at native_type.
+ * The length of the protocol data specified at native_type must be set in
+ * variants.native_type_length.
+ */

 
 

-struct dl_tag_attr_str {
-    u_long     dl_tag;
-    short      if_flags;
-    short      if_unit;
-    u_long     if_family;
-    u_long     protocol_family;
-};
-
-
-struct dlil_pr_flt_str {
-    caddr_t     cookie;
-
-    int        (*filter_dl_input)(caddr_t      cookie, 
-                          struct mbuf  **m, 
-                          char         **frame_header, 
-                          struct ifnet **ifp);
-
-
-    int (*filter_dl_output)(caddr_t        cookie, 
-                           struct mbuf     **m, 
-                           struct ifnet    **ifp, 
-                           struct sockaddr **dest,
-                           char            *dest_linkaddr, 
-                           char            *frame_type);
-
-    int (*filter_dl_event)(caddr_t           cookie, 
-                          struct kern_event_msg   *event_msg);
-
-    int (*filter_dl_ioctl)(caddr_t     cookie, 
-                          struct ifnet *ifp,
-                          u_long       ioctl_cmd,
-                          caddr_t      ioctl_arg);
-
-    int        (*filter_detach)(caddr_t  cookie);
-};
-
-struct dlil_if_flt_str {
-    caddr_t                               cookie;
-    int        (*filter_if_input)(caddr_t         cookie,
-                          struct ifnet    **ifnet_ptr,
-                          struct mbuf     **mbuf_ptr,
-                          char            **frame_ptr);
-
-    int        (*filter_if_event)(caddr_t          cookie,
-                          struct ifnet     **ifnet_ptr,
-                          struct kern_event_msg **event_msg_ptr);
-
-    int        (*filter_if_output)(caddr_t      cookie,
-                           struct ifnet **ifnet_ptr,
-                           struct mbuf  **mbuf_ptr);
-
-
-    int        (*filter_if_ioctl)(caddr_t       cookie,
-                          struct ifnet  *ifnet_ptr,
-                          u_long        ioctl_code_ptr,
-                          caddr_t       ioctl_arg_ptr);
-
-    int        (*filter_if_free)(caddr_t      cookie,
-                         struct ifnet *ifnet_ptr);
-
-    int        (*filter_detach)(caddr_t  cookie);
-};
-
-
-#define DLIL_PR_FILTER  1
-#define DLIL_IF_FILTER  2
-
-
-
-typedef int (*dl_input_func)(struct mbuf *m, char *frame_header,
-                            struct ifnet *ifp, u_long  dl_tag, int sync_ok);
-typedef int (*dl_pre_output_func)(struct ifnet         *ifp,
-                                 struct mbuf           **m,
-                                 struct sockaddr       *dest,
-                                 caddr_t               route_entry,
-                                 char                  *frame_type,
-                                 char                  *dst_addr,
-                                 u_long                dl_tag);
-
-typedef int (*dl_event_func)(struct kern_event_msg  *event,
-                            u_long            dl_tag);
-
-typedef int (*dl_offer_func)(struct mbuf *m, char *frame_header);
-typedef int (*dl_ioctl_func)(u_long    dl_tag,
-                            struct ifnet *ifp,
-                            u_long     ioctl_cmd,
-                            caddr_t    ioctl_arg);
-
-
-
-struct dlil_filterq_entry {
-    TAILQ_ENTRY(dlil_filterq_entry) que;
-    u_long      filter_id;
-    int                 type;
-    union {
-       struct dlil_if_flt_str if_filter;
-       struct dlil_pr_flt_str pr_filter;
-    } variants;
-};
-
-
-TAILQ_HEAD(dlil_filterq_head, dlil_filterq_entry);
-
-
-struct if_proto {
-    TAILQ_ENTRY(if_proto)                      next;
-    u_long                                     dl_tag;
-    struct dlil_filterq_head                    pr_flt_head;
-    struct ifnet               *ifp;
-    dl_input_func              dl_input;
-    dl_pre_output_func         dl_pre_output;
-    dl_event_func              dl_event;
-    dl_offer_func              dl_offer;
-    dl_ioctl_func              dl_ioctl;
-    u_long                     protocol_family;
-
-};
-
-TAILQ_HEAD(dlil_proto_head, if_proto);
-
-struct dlil_tag_list_entry {
-    TAILQ_ENTRY(dlil_tag_list_entry) next;
-    struct ifnet                  *ifp;
-    u_long                        dl_tag;
-};
-
-
-#define DLIL_DESC_RAW          1
-#define DLIL_DESC_802_2                2
-#define DLIL_DESC_802_2_SNAP   3
-
-struct dlil_demux_desc {
-    TAILQ_ENTRY(dlil_demux_desc) next;
-    int                                 type;
-
-    u_char  *native_type;
-    union {
-       struct {
-           u_long   proto_id_length; /* IN LONGWORDS!!! */
-           u_char   *proto_id;
-           u_char   *proto_id_mask;
-
-       } bitmask;
-
-       struct {
-           u_char   dsap;
-           u_char   ssap;
-           u_char   control_code;
-           u_char   pad;
-       } desc_802_2;
-
-       struct {
-           u_char   dsap;
-           u_char   ssap;
-           u_char   control_code;
-           u_char   org[3];
-           u_short  protocol_type;
-       } desc_802_2_SNAP;
-    } variants;
-};
-
-TAILQ_HEAD(ddesc_head_str, dlil_demux_desc);
-
-
-struct dlil_proto_reg_str {
-    struct ddesc_head_str      demux_desc_head;
-    u_long                     interface_family;
-    u_long                     protocol_family;
-    short                      unit_number;
-    int                                default_proto; /* 0 or 1 */
-    dl_input_func              input;
-    dl_pre_output_func         pre_output;
-    dl_event_func              event;
-    dl_offer_func              offer;
-    dl_ioctl_func              ioctl;
-};
-
-
-int dlil_attach_interface_filter(struct ifnet             *ifnet_ptr,
-                                struct dlil_if_flt_str    *interface_filter,
-                                u_long                    *filter_id,
-                                int                       insertion_point);
-
-int
-dlil_input(struct ifnet  *ifp, struct mbuf *m_head, struct mbuf *m_tail);
-
-int
-dlil_output(u_long             dl_tag,
-           struct mbuf         *m,
-           caddr_t             route,
-           struct sockaddr     *dest,
-           int                 raw);
-
+#ifdef KERNEL_PRIVATE

 
 

-int
-dlil_ioctl(u_long      proto_family,
-          struct ifnet *ifp,
-          u_long       ioctl_code,
-          caddr_t      ioctl_arg);
-
-int
-dlil_attach_protocol(struct dlil_proto_reg_str   *proto,
-                    u_long                      *dl_tag);
+#include <net/if.h>
+#include <net/if_var.h>
+#include <sys/kern_event.h>
+#include <kern/thread.h>
+#include <kern/locks.h>

 
 

-int
-dlil_detach_protocol(u_long    dl_tag);
+#if __STDC__

 
 

-int
-dlil_if_attach(struct ifnet    *ifp);
+struct ifnet;
+struct mbuf;
+struct ether_header;
+struct sockaddr_dl;

 
 

-int
-dlil_attach_protocol_filter(u_long                 dl_tag,
-                           struct dlil_pr_flt_str  *proto_filter,
-                           u_long                  *filter_id,
-                           int                     insertion_point);
-int
-dlil_detach_filter(u_long      filter_id);
+#endif

 
 

-struct dlil_ifmod_reg_str {
-    int (*add_if)(struct ifnet *ifp);
-    int (*del_if)(struct ifnet *ifp);
-    int (*add_proto)(struct ddesc_head_str   *demux_desc_head,
-                    struct if_proto  *proto, u_long dl_tag);
-    int (*del_proto)(struct if_proto  *proto, u_long dl_tag);
-    int (*ifmod_ioctl)(struct ifnet *ifp, u_long ioctl_cmd, caddr_t data);
-    int        (*shutdown)();
+#ifdef BSD_KERNEL_PRIVATE
+struct ifnet_stat_increment_param;
+struct iff_filter;
+
+struct dlil_threading_info {
+       mbuf_t          mbuf_head;      /* start of mbuf list from if */
+       mbuf_t          mbuf_tail;
+       u_int32_t       mbuf_count;
+       boolean_t       net_affinity;   /* affinity set is available */
+       u_int32_t       input_waiting;  /* DLIL condition of thread */
+       struct thread   *input_thread;  /* thread data for this input */
+       struct thread   *workloop_thread; /* current workloop thread */
+       u_int32_t       tag;            /* current affinity tag */
+       lck_mtx_t       *input_lck;     
+       lck_grp_t       *lck_grp;       /* lock group (for lock stats) */
+       char            input_name[32];          
+#if IFNET_INPUT_SANITY_CHK
+       u_int32_t       input_wake_cnt; /* number of times the thread was awaken with packets to process */
+       u_long          input_mbuf_cnt; /* total number of mbuf packets processed by this thread */
+#endif

 };
 
 };
 

+/*
+       The following are shared with kpi_protocol.c so that it may wakeup
+       the input thread to run through packets queued for protocol input.
+*/
+#define        DLIL_INPUT_RUNNING      0x80000000
+#define        DLIL_INPUT_WAITING      0x40000000
+#define        DLIL_PROTO_REGISTER     0x20000000
+#define        DLIL_PROTO_WAITING      0x10000000
+#define        DLIL_INPUT_TERMINATE    0x08000000

 
 

-int dlil_reg_if_modules(u_long  interface_family,
-                       struct dlil_ifmod_reg_str  *ifmod_reg);
-
-int 
-dlil_inject_if_input(struct mbuf *m, char *frame_header, u_long from_id);
+void dlil_init(void);

 
 

-int
-dlil_inject_pr_input(struct mbuf *m, char *frame_header, u_long from_id);
+errno_t dlil_set_bpf_tap(ifnet_t ifp, bpf_tap_mode mode,
+                                                bpf_packet_func callback);

 
 

-int
-dlil_inject_pr_output(struct mbuf              *m,
-                     struct sockaddr           *dest,
-                     int                       raw, 
-                     char                      *frame_type,
-                     char                      *dst_linkaddr,
-                     u_long                    from_id);
+/*
+ * Send arp internal bypasses the check for
+ * IPv4LL.
+ */
+errno_t
+dlil_send_arp_internal(
+       ifnet_t ifp,
+       u_int16_t arpop,
+       const struct sockaddr_dl* sender_hw,
+       const struct sockaddr* sender_proto,
+       const struct sockaddr_dl* target_hw,
+       const struct sockaddr* target_proto);

 
 int
 
 int

-dlil_inject_if_output(struct mbuf *m, u_long from_id);
-
-int  
-dlil_find_dltag(u_long if_family, short unit, u_long proto_family, u_long *dl_tag);
-
+dlil_output(
+       ifnet_t                                 ifp,
+       protocol_family_t               proto_family,
+       mbuf_t                                  packetlist,
+       void                                    *route,
+       const struct sockaddr   *dest,
+       int                                             raw);
+
+errno_t
+dlil_resolve_multi(
+       struct ifnet *ifp,
+       const struct sockaddr *proto_addr,
+       struct sockaddr *ll_addr,
+       size_t ll_len);
+
+errno_t
+dlil_send_arp(
+       ifnet_t ifp,
+       u_int16_t arpop,
+       const struct sockaddr_dl* sender_hw,
+       const struct sockaddr* sender_proto,
+       const struct sockaddr_dl* target_hw,
+       const struct sockaddr* target_proto);
+
+int dlil_attach_filter(ifnet_t ifp, const struct iff_filter *if_filter,
+                                          interface_filter_t *filter_ref);
+void dlil_detach_filter(interface_filter_t filter);
+int dlil_detach_protocol(ifnet_t ifp, u_long protocol);
+extern void dlil_proto_unplumb_all(ifnet_t);
+
+#endif /* BSD_KERNEL_PRIVATE */
+
+void
+dlil_post_msg(struct ifnet *ifp,u_long event_subclass, u_long event_code, 
+                  struct net_event_data *event_data, u_long event_data_len);
+
+/* 
+ * dlil_if_acquire is obsolete. Use ifnet_allocate.
+ */

 
 

-int
-dlil_event(struct ifnet *ifp, struct kern_event_msg *event);
+int dlil_if_acquire(u_long family, const void *uniqueid, size_t uniqueid_len, 
+                       struct ifnet **ifp);
+                       

 
 

-int dlil_dereg_if_modules(u_long interface_family);
+/* 
+ * dlil_if_release is obsolete. The equivalent is called automatically when
+ * an interface is detached.
+ */

 
 

-int
-dlil_if_detach(struct ifnet *ifp);
+void dlil_if_release(struct ifnet *ifp);

 
 

+#endif /* KERNEL_PRIVATE */
+#endif /* KERNEL */

 #endif /* DLIL_H */
 #endif /* DLIL_H */