X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/1c79356b52d46aa6b508fb032f5ae709b1f2897b..0a7de7458d150b5d4dffc935ba399be265ef0a1a:/bsd/net/ndrv.h?ds=sidebyside diff --git a/bsd/net/ndrv.h b/bsd/net/ndrv.h index 38b75b558..dde3a2a9b 100644 --- a/bsd/net/ndrv.h +++ b/bsd/net/ndrv.h @@ -1,79 +1,176 @@ /* - * Copyright (c) 2000 Apple Computer, Inc. All rights reserved. + * Copyright (c) 2008 Apple Computer, Inc. All rights reserved. * - * @APPLE_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 Original Code and all software distributed under the License are - * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER + * @APPLE_OSREFERENCE_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. 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. + * + * 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. - * - * @APPLE_LICENSE_HEADER_END@ + * 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_OSREFERENCE_LICENSE_HEADER_END@ */ /* Copyright (c) 1997, 1998 Apple Computer, Inc. All Rights Reserved */ /* * @(#)ndrv.h 1.1 (MacOSX) 6/10/43 * Justin Walker - 970604 */ +#include #ifndef _NET_NDRV_H #define _NET_NDRV_H +#include -struct sockaddr_ndrv -{ unsigned char snd_len; + +struct sockaddr_ndrv { + unsigned char snd_len; unsigned char snd_family; unsigned char snd_name[IFNAMSIZ]; /* from if.h */ }; /* - * The cb is plugged into the socket (so_pcb), and the ifnet structure - * of BIND is plugged in here. - * For now, it looks like a raw_cb up front... + * Support for user-mode protocol handlers */ -struct ndrv_cb -{ struct ndrv_cb *nd_next; /* Doubly-linked list */ - struct ndrv_cb *nd_prev; - struct socket *nd_socket; /* Back to the socket */ - unsigned int nd_signature; /* Just double-checking */ - struct sockaddr_ndrv *nd_faddr; - struct sockaddr_ndrv *nd_laddr; - struct sockproto nd_proto; /* proto family, protocol */ - int nd_descrcnt; /* # elements in nd_dlist */ - TAILQ_HEAD(dlist, dlil_demux_desc) nd_dlist; /* Descr. list */ - struct ifnet *nd_if; -}; -#define sotondrvcb(so) ((struct ndrv_cb *)(so)->so_pcb) -#define NDRV_SIGNATURE 0x4e445256 /* "NDRV" */ +#define NDRV_DEMUXTYPE_ETHERTYPE 4 +#define NDRV_DEMUXTYPE_SAP 5 +#define NDRV_DEMUXTYPE_SNAP 6 -/* Nominal allocated space for NDRV sockets */ -#define NDRVSNDQ 8192 -#define NDRVRCVQ 8192 +#define NDRVPROTO_NDRV 0 /* - * Support for user-mode protocol handlers + * Struct: ndrv_demux_desc + * Purpose: + * To uniquely identify a packet based on its low-level framing information. + * + * Fields: + * type : type of protocol in data field, must be understood by + * the interface family of the interface the socket is bound to + * length : length of protocol data in "data" field + * data : union of framing-specific data, in network byte order + * ether_type : ethernet type in network byte order, assuming + * ethernet type II framing + * sap : first 3 bytes of sap header, network byte order + * snap : first 5 bytes of snap header, network byte order + * other : up to 28 bytes of protocol data for different protocol type + * + * Examples: + * 1) 802.1x uses ether_type 0x888e, so the descriptor would be set as: + * struct ndrv_demux_desc desc; + * desc.type = NDRV_DEMUXTYPE_ETHERTYPE + * desc.length = sizeof(unsigned short); + * desc.ether_type = htons(0x888e); + * 2) AppleTalk uses SNAP 0x080007809B + * struct ndrv_demux_desc desc; + * desc.type = NDRV_DEMUXTYPE_SNAP; + * desc.length = 5; + * desc.data.snap[0] = 08; + * desc.data.snap[1] = 00; + * desc.data.snap[2] = 07; + * desc.data.snap[3] = 80; + * desc.data.snap[4] = 9B; + */ +struct ndrv_demux_desc { + u_int16_t type; + u_int16_t length; + union{ + u_int16_t ether_type; + u_int8_t sap[3]; + u_int8_t snap[5]; + u_int8_t other[28]; + } data; +}; + +#define NDRV_PROTOCOL_DESC_VERS 1 + +/* + * Struct: ndrv_protocol_desc + * Purpose: + * Used to "bind" an NDRV socket so that packets that match + * given protocol demux descriptions can be received: + * Field: + * version : must be NDRV_PROTOCOL_DESC_VERS + * protocol_family : unique identifier for this protocol + * demux_count : number of demux_list descriptors in demux_list; maximum of 10 + * demux_list : pointer to array of demux descriptors */ +struct ndrv_protocol_desc { + u_int32_t version; + u_int32_t protocol_family; + u_int32_t demux_count; + struct ndrv_demux_desc *demux_list; +}; -/* Arg to socket options */ -struct ndrv_descr -{ unsigned int nd_len; /* Length of descriptor buffer, in bytes */ - unsigned char *nd_buf; /* Descriptor buffer */ +#ifdef KERNEL_PRIVATE +/* LP64 version of ndrv_protocol_desc. all pointers + * grow when we're dealing with a 64-bit process. + * WARNING - keep in sync with ndrv_protocol_desc + */ +struct ndrv_protocol_desc64 { + u_int32_t version; + u_int32_t protocol_family; + u_int32_t demux_count; + user64_addr_t demux_list __attribute__((aligned(8))); }; -#define NDRV_DMXSPEC 0x01 /* Get/Set (Add) a list of protocol specs */ -#define NDRV_DELDMXSPEC 0x02 /* Delete a list of protocol specs */ -#define NDRV_DMXSPECCNT 0x03 /* Return number of active protocol specs */ +struct ndrv_protocol_desc32 { + u_int32_t version; + u_int32_t protocol_family; + u_int32_t demux_count; + user32_addr_t demux_list; +}; +#endif /* KERNEL_PRIVATE */ + +#define SOL_NDRVPROTO NDRVPROTO_NDRV /* Use this socket level */ +#define NDRV_DELDMXSPEC 0x02 /* Delete the registered protocol */ +#define NDRV_SETDMXSPEC 0x04 /* Set the protocol spec */ +#define NDRV_ADDMULTICAST 0x05 /* Add a physical multicast address */ +#define NDRV_DELMULTICAST 0x06 /* Delete a phyiscal multicast */ + +/* + * SOL_NDRVPROTO - use this for the socket level when calling setsocketopt + * NDRV_DELDMXSPEC - removes the registered protocol and all related demuxes + * NDRV_SETDMXSPEC - set the protocol to receive, use struct ndrv_protocol_desc + * as the parameter. + * NDRV_ADDMULTICAST - Enable reception of a phyiscal multicast address, use + * a sockaddr of the appropriate type for the media in use. + * NDRV_DELMULTICAST - Disable reception of a phyiscal multicast address, use + * a sockaddr of the appropriate type for the media in use. + * + * When adding multicasts, the multicasts are ref counted. If the multicast is + * already registered in the kernel, the count will be bumped. When deleting + * the multicast, the count is decremented. If the count reaches zero the + * multicast is removed. If your process is killed, PF_NDRV will unregister + * the mulitcasts you've added. You can only delete multicasts you've added + * on the same socket. + * + * If the interface goes away while your socket is open, your protocol is + * immediately detached and sending/receiving is disabled on the socket. + * If you need a chance to do something, please file a bug and we can give + * you a second or two. + */ + +/* Max number of descriptions allowed by default */ +#define NDRV_DMUX_MAX_DESCR 1024 + +/* + * sysctl MIB tags at the kern.ipc.nrdv level + */ +#define NRDV_MULTICAST_ADDRS_PER_SOCK 1 /* to toggle NDRV_DMUX_MAX_DESCR value */ -#if KERNEL -extern struct ndrv_cb ndrvl; /* Head of controlblock list */ -#endif -#endif /* _NET_NDRV_H */ +#endif /* _NET_NDRV_H */