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$
  27 .\" "
  28 .Dd June 25, 2000
  29 .Os
  30 .Dt ACCEPT_FILTER 9
  31 .Sh NAME
  32 .Nm accept_filter ,
  33 .Nm accept_filt_add ,
  34 .Nm accept_filt_del ,
  35 .Nm accept_filt_generic_mod_event ,
  36 .Nm accept_filt_get
  37 .Nd filter incoming connections
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/module.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 struct accept_filter to the system:
  64 .Bd -literal
  65 struct accept_filter {
  66         char    accf_name[16];
  67         void    (*accf_callback)(struct socket *so, void *arg, int waitflag);
  68         void *  (*accf_create)(struct socket *so, char *arg);
  69         void    (*accf_destroy)(struct socket *so);
  70         SLIST_ENTRY(accept_filter) accf_next;   /* next on the list */
  71 };
  72 .Ed
  73 .Pp
  74 The module should register it with the function
  75 .Fn accept_filt_add ,
  76 passing a pointer to a struct accept_filter, allocated with
  77 .Xr MALLOC 9
  78 .Pp
  79 The fields of
  80 .Fa struct accept_filter
  81 are as follows:
  82 .Bl -tag -width accf_callbackXXX
  83 .It accf_name
  84 Name of the filter;
  85 this is how it will be accessed from userland.
  86 .It accf_callback
  87 The callback that the kernel will do
  88 once the connection is established.
  89 It is the same as a socket upcall
  90 and will be called when the connection is established
  91 and whenever new data arrives on the socket,
  92 unless the callback modifies the socket's flags.
  93 .It accf_create
  94 Called whenever a
  95 .Xr setsockopt 2
  96 installs the filter onto
  97 a listening socket.
  98 .It accf_destroy
  99 Called whenever the user removes the accept filter on the socket.
 100 .El
 101 .Pp
 102 .Fn accept_filt_del
 103 passed the same string used in accept_filter.accf_name during registration
 104 with
 105 .Fn accept_filt_add ,
 106 the kernel will then disallow and further userland use of the filter.
 107 .Pp
 108 .Fn accept_filt_get
 109 is used internally to locate which accept filter to use via the
 110 .Fn setsocketopt
 111 syscall.
 112 .Pp
 113 .Fn accept_filt_generic_mod_event
 114 provides a simple way to avoid duplicate
 115 code for accept filters which don't use
 116 argument field to load and unload
 117 themselves.  It is a function that can be
 118 put in the load/unload struct
 119 for the
 120 .Fn DECLARE_MODULE
 121 macro.
 122 .Sh SEE ALSO
 123 .Xr setsockopt 2 ,
 124 .Xr accf_data 9 ,
 125 .Xr accf_http 9 ,
 126 .Xr malloc 9
 127 .Sh HISTORY
 128 The accept filter mechanism was introduced in
 129 .Fx 4.0 .
 130 .Sh AUTHORS
 131 This manual page was written by
 132 .An Alfred Perlstein ,
 133 Sheldon Hearn and Jeroen Ruigrok van der Werven.
 134 The accept filter concept was pioneered by David Filo at Yahoo!
 135 and refined to be a loadable module system by Alfred Perlstein.