bsd/net/kext_net.h

   1 /*
   2  * Copyright (c) 1999-2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 /*
  30  * Support for socket filter kernel extensions
  31  */
  32
  33 #ifndef NET_KEXT_NET_H
  34 #define NET_KEXT_NET_H
  35
  36 #include <sys/appleapiopts.h>
  37
  38 #include <sys/queue.h>
  39 #include <sys/cdefs.h>
  40
  41 #ifdef BSD_KERNEL_PRIVATE
  42
  43 #include <sys/kpi_socketfilter.h>
  44
  45 /*
  46  * Internal implementation bits
  47  */
  48
  49 struct socket_filter;
  50
  51 #define SFEF_DETACHUSEZERO      0x1     // Detach when use reaches zero
  52 #define SFEF_UNREGISTERING      0x2     // Remove due to unregister
  53
  54 struct socket_filter_entry {
  55         struct socket_filter_entry      *sfe_next_onsocket;
  56         struct socket_filter_entry      *sfe_next_onfilter;
  57
  58         struct socket_filter            *sfe_filter;
  59         struct socket                           *sfe_socket;
  60         void                                            *sfe_cookie;
  61
  62         u_int32_t                                       sfe_flags;
  63 };
  64
  65 #define SFF_DETACHING           0x1
  66
  67 struct socket_filter {
  68         TAILQ_ENTRY(socket_filter)      sf_protosw_next;
  69         TAILQ_ENTRY(socket_filter)      sf_global_next;
  70         struct socket_filter_entry      *sf_entry_head;
  71
  72         struct protosw                          *sf_proto;
  73         struct sflt_filter                      sf_filter;
  74         u_int32_t                                       sf_flags;
  75         u_int32_t                                       sf_usecount;
  76 };
  77
  78 TAILQ_HEAD(socket_filter_list, socket_filter);
  79
  80 /* Private, internal implementation functions */
  81 void    sflt_init(void) __attribute__((section("__TEXT, initcode")));
  82 void    sflt_initsock(struct socket *so);
  83 void    sflt_termsock(struct socket *so);
  84 void    sflt_use(struct socket *so);
  85 void    sflt_unuse(struct socket *so);
  86 void    sflt_notify(struct socket *so, sflt_event_t event, void *param);
  87 int             sflt_data_in(struct socket *so, const struct sockaddr *from, mbuf_t *data,
  88                                          mbuf_t *control, sflt_data_flag_t flags, int *filtered);
  89 int             sflt_attach_private(struct socket *so, struct socket_filter *filter, sflt_handle handle, int locked);
  90
  91 #endif /* BSD_KERNEL_PRIVATE */
  92
  93 #define NFF_BEFORE              0x01
  94 #define NFF_AFTER               0x02
  95
  96 #define NKE_OK 0
  97 #define NKE_REMOVE -1
  98
  99 /*
 100  * Interface structure for inserting an installed socket NKE into an
 101  *  existing socket.
 102  * 'handle' is the NKE to be inserted, 'where' is an insertion point,
 103  *  and flags dictate the position of the to-be-inserted NKE relative to
 104  *  the 'where' NKE.  If the latter is NULL, the flags indicate "first"
 105  *  or "last"
 106  */
 107 #pragma pack(4)
 108
 109 struct so_nke
 110 {       unsigned int nke_handle;
 111         unsigned int nke_where;
 112         int nke_flags; /* NFF_BEFORE, NFF_AFTER: net/kext_net.h */
 113         u_int32_t reserved[4];  /* for future use */
 114 };
 115
 116 #pragma pack()
 117
 118 #endif /* NET_KEXT_NET_H */
 119