bsd/net/kext_net.h

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