share/man/man9/accept_filter.9

   1 .\"
   2 .\" Copyright (c) 2000 Alfred Perlstein
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/share/man/man9/accept_filter.9,v 1.13 2004/06/16 08:33:57 ru Exp $
  27 .\" $DragonFly: src/share/man/man9/accept_filter.9,v 1.5 2007/09/26 18:56:26 swildner Exp $
  28 .\"
  29 .Dd June 25, 2000
  30 .Os
  31 .Dt ACCEPT_FILTER 9
  32 .Sh NAME
  33 .Nm accept_filter ,
  34 .Nm accept_filt_add ,
  35 .Nm accept_filt_del ,
  36 .Nm accept_filt_generic_mod_event ,
  37 .Nm accept_filt_get
  38 .Nd filter incoming connections
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/socket.h
  42 .Fd #define ACCEPT_FILTER_MOD
  43 .In sys/socketvar.h
  44 .Ft int
  45 .Fn accept_filt_add "struct accept_filter *filt"
  46 .Ft int
  47 .Fn accept_filt_del "char *name"
  48 .Ft int
  49 .Fn accept_filt_generic_mod_event "module_t mod" "int event" "void *data"
  50 .Ft struct accept_filter *
  51 .Fn accept_filt_get "char *name"
  52 .Sh DESCRIPTION
  53 Accept filters allow an application to request
  54 that the kernel pre-process incoming connections.
  55 An accept filter is requested via the
  56 .Xr setsockopt 2
  57 system call, passing in an
  58 .Fa optname
  59 of
  60 .Dv SO_ACCEPTFILTER .
  61 .Sh IMPLEMENTATION NOTES
  62 A module that wants to be an accept filter
  63 must provide a
  64 .Vt "struct accept_filter"
  65 to the system:
  66 .Bd -literal
  67 struct accept_filter {
  68         char    accf_name[16];
  69         void    (*accf_callback)(struct socket *so, void *arg, int waitflag);
  70         void *  (*accf_create)(struct socket *so, char *arg);
  71         void    (*accf_destroy)(struct socket *so);
  72         SLIST_ENTRY(accept_filter) accf_next;   /* next on the list */
  73 };
  74 .Ed
  75 .Pp
  76 The module should register it with the function
  77 .Fn accept_filt_add ,
  78 passing a pointer to a
  79 .Vt "struct accept_filter" ,
  80 allocated with
  81 .Xr kmalloc 9
  82 .Pp
  83 The fields of
  84 .Vt "struct accept_filter"
  85 are as follows:
  86 .Bl -tag -width ".Va accf_callback"
  87 .It Fa accf_name
  88 Name of the filter;
  89 this is how it will be accessed from userland.
  90 .It Fa accf_callback
  91 The callback that the kernel will do
  92 once the connection is established.
  93 It is the same as a socket upcall
  94 and will be called when the connection is established
  95 and whenever new data arrives on the socket,
  96 unless the callback modifies the socket's flags.
  97 .It Fa accf_create
  98 Called whenever a
  99 .Xr setsockopt 2
 100 installs the filter onto
 101 a listening socket.
 102 .It Fa accf_destroy
 103 Called whenever the user removes the accept filter on the socket.
 104 .El
 105 .Pp
 106 The
 107 .Fn accept_filt_del
 108 function passed the same string used in
 109 .Fa accept_filter.accf_name
 110 during registration with
 111 .Fn accept_filt_add ,
 112 the kernel will then disallow and further userland use of the filter.
 113 .Pp
 114 The
 115 .Fn accept_filt_get
 116 function is used internally to locate which accept filter to use via the
 117 .Xr setsockopt 2
 118 system call.
 119 .Pp
 120 The
 121 .Fn accept_filt_generic_mod_event
 122 function provides a simple way to avoid duplication of code
 123 for accept filters which do not use the argument field to load
 124 and unload themselves.
 125 This function can be used in the
 126 .Vt moduledata_t
 127 struct for the
 128 .Xr DECLARE_MODULE 9
 129 macro.
 130 .Sh SEE ALSO
 131 .Xr setsockopt 2 ,
 132 .Xr accf_data 9 ,
 133 .Xr accf_http 9 ,
 134 .Xr kmalloc 9
 135 .Sh HISTORY
 136 The accept filter mechanism was introduced in
 137 .Fx 4.0 .
 138 .Sh AUTHORS
 139 .An -nosplit
 140 This manual page was written by
 141 .An Alfred Perlstein ,
 142 .An Sheldon Hearn
 143 and
 144 .An Jeroen Ruigrok van der Werven .
 145 .Pp
 146 The accept filter concept was pioneered by
 147 .An David Filo
 148 at Yahoo!\&
 149 and refined to be a loadable module system by
 150 .An Alfred Perlstein .