X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/91447636331957f3d9b5ca5b508f07c526b0074d..e2fac8b15b12a7979f72090454d850e612fc5b13:/bsd/net/dlil.h diff --git a/bsd/net/dlil.h b/bsd/net/dlil.h index 6824572cb..6e3872b79 100644 --- a/bsd/net/dlil.h +++ b/bsd/net/dlil.h @@ -1,23 +1,29 @@ /* * 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, - * 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. @@ -28,35 +34,10 @@ #ifndef DLIL_H #define DLIL_H #ifdef KERNEL + #include #include -#if __STDC__ - -struct ifnet; -struct mbuf; -struct ether_header; -struct sockaddr_dl; - -#endif - - -#ifdef KERNEL_PRIVATE -#define DLIL_LAST_FILTER -1 -#define DLIL_NULL_FILTER -2 - -#define DLIL_WAIT_FOR_FREE -2 - -#define DLIL_BLUEBOX 1 - - - -#include -#include -#include - -#endif KERNEL_PRIVATE - enum { BPF_TAP_DISABLE, BPF_TAP_INPUT, @@ -64,76 +45,6 @@ enum { BPF_TAP_INPUT_OUTPUT }; -#ifdef KERNEL_PRIVATE -struct kev_msg; -struct iff_filter; - -struct dlil_if_flt_str { - caddr_t cookie; - int (*filter_if_input)(caddr_t cookie, - struct ifnet **ifp, - struct mbuf **mbuf_ptr, - char **frame_ptr); - - int (*filter_if_event)(caddr_t cookie, - struct ifnet *ifp, - struct kev_msg *event_msg_ptr); - - int (*filter_if_output)(caddr_t cookie, - struct ifnet **ifp, - struct mbuf **mbuf_ptr); - - - int (*filter_if_ioctl)(caddr_t cookie, - struct ifnet *ifp, - u_long ioctl_code_ptr, - caddr_t ioctl_arg_ptr); - - int (*filter_if_free)(caddr_t cookie, - struct ifnet *ifp); - - int (*filter_detach)(caddr_t cookie); - u_long reserved[2]; -}; - -#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 protocol_family, int sync_ok); -typedef int (*dl_pre_output_func)(struct ifnet *ifp, - u_long protocol_family, - struct mbuf **m, - const struct sockaddr *dest, - caddr_t route_entry, - char *frame_type, - char *dst_addr); - -typedef void (*dl_event_func)(struct ifnet *ifp, struct kev_msg *event); - -typedef int (*dl_offer_func)(struct mbuf *m, char *frame_header); -typedef int (*dl_ioctl_func)(u_long protocol_family, - struct ifnet *ifp, - u_long ioctl_cmd, - caddr_t ioctl_arg); -typedef int (*dl_detached_func)(u_long protocol_family, struct ifnet *ifp); - -/* Obsolete types */ -#define DLIL_DESC_RAW 1 -#define DLIL_DESC_802_2 2 -#define DLIL_DESC_802_2_SNAP 3 -/* - * DLIL_DESC_RAW - obsolete type, data in variants.bitmask or native_type - * if variants.bitmask.proto_id_length, native_type in host - * byte order. - * DLIL_DESC_802_2 - obsolete, data in variants.desc_802_2 - * DLIL_DESC_802_2_SNAP - obsolete, data in variants.desc_802_2_SNAP - * protocol field in host byte order - */ -#endif KERNEL_PRIVATE - /* Ethernet specific types */ #define DLIL_DESC_ETYPE2 4 #define DLIL_DESC_SAP 5 @@ -155,102 +66,58 @@ typedef int (*dl_detached_func)(u_long protocol_family, struct ifnet *ifp); */ #ifdef KERNEL_PRIVATE -struct dlil_demux_desc { - TAILQ_ENTRY(dlil_demux_desc) next; - - int type; - u_char *native_type; - - union { - /* Structs in this union are obsolete. They exist for binary compatability only */ - /* Only the native_type_length is used */ - struct { - u_long proto_id_length; /* IN LONGWORDS!!! */ - u_char *proto_id; /* No longer supported by Ethernet family */ - 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; /* Ignored, assumed to be 0xAA */ - u_char ssap; /* Ignored, assumed to be 0xAA */ - u_char control_code; /* Ignored, assumed to be 0x03 */ - u_char org[3]; - u_short protocol_type; /* In host byte order */ - } desc_802_2_SNAP; - - /* Length of data pointed to by native_type, must be set correctly */ - u_int32_t native_type_length; - } variants; -}; -TAILQ_HEAD(ddesc_head_str, dlil_demux_desc); +#include +#include +#include +#include +#include -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; - dl_detached_func detached; - u_long reserved[3]; -}; +#if __STDC__ +struct ifnet; +struct mbuf; +struct ether_header; +struct sockaddr_dl; -int dlil_attach_filter(struct ifnet *ifp, const struct iff_filter *if_filter, - interface_filter_t *filter_ref); +#endif +#ifdef BSD_KERNEL_PRIVATE struct ifnet_stat_increment_param; +struct iff_filter; -int -dlil_input_with_stats(struct ifnet *ifp, struct mbuf *m_head, struct mbuf *m_tail, - const struct ifnet_stat_increment_param *stats); - -int -dlil_input(struct ifnet *ifp, struct mbuf *m_head, struct mbuf *m_tail); - -int -dlil_output_list( - struct ifnet *ifp, - u_long protocol_family, - struct mbuf *packetlist, - caddr_t route, - const struct sockaddr *dest, - int raw); - -int -dlil_output( - struct ifnet *ifp, - u_long protocol_family, - struct mbuf *m, - caddr_t route, - const struct sockaddr *dest, - int raw); +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_ioctl(u_long proto_family, - struct ifnet *ifp, - u_long ioctl_code, - caddr_t ioctl_arg); +void dlil_init(void); -errno_t -dlil_resolve_multi( - struct ifnet *ifp, - const struct sockaddr *proto_addr, - struct sockaddr *ll_addr, - size_t ll_len); +errno_t dlil_set_bpf_tap(ifnet_t ifp, bpf_tap_mode mode, + bpf_packet_func callback); /* * Send arp internal bypasses the check for @@ -265,6 +132,22 @@ dlil_send_arp_internal( const struct sockaddr_dl* target_hw, const struct sockaddr* target_proto); +int +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, @@ -274,334 +157,30 @@ dlil_send_arp( const struct sockaddr_dl* target_hw, const struct sockaddr* target_proto); -int -dlil_ioctl_locked(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); - -int -dlil_detach_protocol(struct ifnet *ifp, u_long protocol_family); - -int -dlil_if_attach(struct ifnet *ifp); - -#ifdef BSD_KERNEL_PRIVATE - -int -dlil_if_attach_with_address( - struct ifnet *ifp, - const struct sockaddr_dl *ll_addr); - -int -dlil_attach_protocol_kpi(ifnet_t ifp, protocol_family_t protocol, - const struct ifnet_attach_proto_param *proto_details); - -errno_t dlil_set_bpf_tap(ifnet_t ifp, bpf_tap_mode mode, - bpf_packet_func callback); - -#endif - -void -dlil_detach_filter(interface_filter_t filter); - -struct dlil_ifmod_reg_str { - int (*add_if)(struct ifnet *ifp); - int (*del_if)(struct ifnet *ifp); - int (*add_proto)(struct ifnet *ifp, u_long protocol_family, - struct ddesc_head_str *demux_desc_head); -#ifdef __KPI_INTERFACE__ - ifnet_del_proto_func del_proto; - ifnet_ioctl_func ifmod_ioctl; -#else - void* del_proto; - void* ifmod_ioctl; -#endif - int (*shutdown)(void); - int (*init_if)(struct ifnet *ifp); - u_long reserved[3]; -}; - - -int dlil_reg_if_modules(u_long interface_family, - struct dlil_ifmod_reg_str *ifmod_reg); - -/* - -Function : dlil_reg_proto_module - - A DLIL protocol module is a piece of code that know how to handle a certain type - of protocol (PF_INET, PF_INET6, ...) for a certain family of interface (APPLE_IF_FAM_ETHERNET, - APPLE_IF_FAM_PPP, ...). - - dlil_reg_proto_module() allows the registration of such a protocol/interface handler before any - interface is attached. - Typically, the attach and detach function of the protocol handler will call - dlil_{attach/detach}_protocol with the parameter specific to the protocol. - - The goal of this modules is to insulate the actual protocol (IP, IPv6) from the DLIL details. - -Parameters : - 'protocol_family' is PF_INET, PF_INET6, ... - 'interface_family' is APPLE_IF_FAM_ETHERNET, APPLE_IF_FAM_PPP, ... - 'protomod_reg' is the protocol registration structure. - 'attach_proto' funtion is mandatory. - 'detach_proto' funtion is optional (DLIL will manage it). - -Return code : - -0 : - - No error. - -ENOMEM: - - No memory can be allocated for internal data structure. - -EEXIST: - - The protocol family has already been registered for this interface family. - -EINVAL: - - The dlil_protomod_reg_str structure contains incorrect values. - -*/ - -int dlil_reg_proto_module(u_long protocol_family, u_long interface_family, - int (*attach)(struct ifnet *ifp, u_long protocol_family), - int (*detach)(struct ifnet *ifp, u_long protocol_family)); - -/* - -Function : dlil_dereg_proto_module - - dlil_dereg_proto_module() will unregister the protocol module previously - registered with dlil_dereg_proto_module(). - - There is no restriction when to call it. - Interfaces or protoco can be attached, it will not prevent the deregistration of the module. - -Parameters : - 'protocol_family' is PF_INET, PF_INET6, ... - 'interface_family' is APPLE_IF_FAM_ETHERNET, APPLE_IF_FAM_PPP, ... - -Return code : - -0 : - - No error. - -ENOENT: - - No module was registered.. - -*/ - -int dlil_dereg_proto_module(u_long protocol_family, u_long interface_family); - -/* - -Function : dlil_plumb_protocol - - dlil_plumb_protocol() will plumb a protocol to an actual interface. - This will find a registered protocol module and call its attach function. - The module will typically call dlil_attach_protocol with the appropriate parameters. - -Parameters : - 'protocol_family' is PF_INET, PF_INET6, ... - 'ifp' is the interface to plumb the protocol to. - -Return code : - -0 : - - No error. - -ENOENT: - - No module was registered. - -other: - - Error returned by the attach_proto function - -*/ -int dlil_plumb_protocol(u_long protocol_family, struct ifnet *ifp); - -/* - -Function : dlil_unplumb_protocol - - dlil_unplumb_protocol() will unplumb a protocol from an interface. - This will find a registered protocol module and call its detach function. - The module will typically call dlil_detach_protocol with the appropriate parameters. - If no module is found, this function will call dlil_detach_protocol directly. - -Parameters : - 'protocol_family' is PF_INET, PF_INET6, ... - 'ifp' is APPLE_IF_FAM_ETHERNET, APPLE_IF_FAM_PPP, ... - -Return code : - -0 : - - No error. - -ENOENT: - - No module was registered. - -other: - - Error returned by the attach_proto function - -*/ -int dlil_unplumb_protocol(u_long protocol_family, struct ifnet *ifp); - -int -dlil_inject_if_input(struct mbuf *m, char *frame_header, u_long from_id); - -int -dlil_inject_pr_input(struct mbuf *m, char *frame_header, u_long from_id); - -int -dlil_inject_pr_output(struct mbuf *m, - struct sockaddr *dest, - int raw, - char *frame_type, - char *dst_linkaddr, - u_long from_id); +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); -int -dlil_inject_if_output(struct mbuf *m, u_long from_id); +#endif /* BSD_KERNEL_PRIVATE */ -#ifdef 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); -#endif - -int -dlil_event(struct ifnet *ifp, struct kern_event_msg *event); - -int dlil_dereg_if_modules(u_long interface_family); - -int -dlil_if_detach(struct ifnet *ifp); - -void -ifp_reference(struct ifnet *ifp); - -void -ifp_release(struct ifnet *ifp); - /* - -Function : dlil_if_acquire - - DLIL manages the list of ifnet interfaces allocated using the dlil_if_acquire - function. This list if not the same as the list of attached interfaces, - visible with ifconfig. - This list contains attached as well as detached interfaces. - Detached interfaces are kept in the list to prevent the kernel from crashing - by using an old ifp. - - if it succeeds, dlil_if_acquire returns an ifnet data structure. - This ifnet can either be a new allocated block of memory, or an ifnet - that already existed and that DLIL has found in its list of unused - interface and that matches the family/uniqueid tuple. - - dlil_if_acquire can fail if the requested interface is already in use, - or if no memory is available to create a new interface. - - The typical sequence of call for a driver will be : - dlil_if_acquire(... &ifp) - ... Fill in the ifnet ... - dlil_if_attach(ifp) - ... Driver work ... - dlil_if_detach(ifp) - dlil_if_release(ifp) - - Important : ifnet allocated by DLIL are managed by DLIL. DLIL takes care - of them, and keeps them until a driver wants to reuse them, but DLIL may - also decide to free them when not in use by a driver. - - Note : the structure returned will actually be large enough to contain - an arpcom structure (ifnet + ethernet) structure. - Drivers cannot extend the structure and must to store their private - information in if_sofc and if_private. - -Parameters : - 'family' uniquely identifies DLIL interface family. - 'uniqueid' is a unique identifier for that interface, managed by the - driver (for example MAC address for ethernet). - 'uniqueid_len' is the length of the unique id. - 'ifp' contains on output the allocated ifnet. - -Return code : - -0 : - - If an ifnet matching the uniqueid is found, the matching ifnet is returned - in ifp and the flags IFEF_REUSE and IF_INUSE are set in the if_eflags. - The fields in the ifnet are NOT zeroed and may contain old values that - the driver can reuse. [They are not necessarily the values that were - there when the driver released the ifnet, as protocol might have - continued to update them]. - - If no matching ifnet is found, a new structure is allocated and returned - in ifp with all fields initialized to 0. - The flag IF_INUSE is set in the if_eflags. IFEF_REUSE is NOT set. - dlil_if_acquire will copy the uniqueid and keep it for matching purpose. - - If 'uniqueid' is NULL, then dlil_if_acquire will return the first - ifnet that contains a null uniqueid for that family, with the flags - IFEF_REUSE and IF_INUSE set. - If no ifnet is available, a new one will be created. - -ENOMEM: - - If no matching interface is found, and no memory can be allocated, - dlil_if_acquire will return ENOMEM. - - -EBUSY: - - If the unique id matches the id of an interface currently in use, - dlil_if_acquire will return EBUSY. - An interface 'in use' is an allocated interface, not necessarily attached. - -*/ + * dlil_if_acquire is obsolete. Use ifnet_allocate. + */ int dlil_if_acquire(u_long family, const void *uniqueid, size_t uniqueid_len, struct ifnet **ifp); /* - -Function : dlil_if_release - - dlil_if_release will transfer control of the ifnet to DLIL. - DLIL will keep the interface in its list, marking it unused. - The fields will be left in their current state, so the driver can reuse - the ifnet later, by calling dlil_if_acquire. - The if_eflags IF_INUSE will be cleared. - The fields if_output, if_ioctl, if_free and if_set_bpf_tap will be changed - to point to DLIL private functions. - After calling dlil_if_release, the driver can safely terminate and - unload if necessary. - Note: your driver should only call dlil_if_release once your if_free - function has been called. - -Parameters : - ifp is the pointer to the ifnet to release. - -*/ + * dlil_if_release is obsolete. The equivalent is called automatically when + * an interface is detached. + */ void dlil_if_release(struct ifnet *ifp);