share/man/man9/accf_http.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/accf_http.9,v 1.1.2.6 2002/07/02 01:03:59 brian Exp $
  27 .\"
  28 .Dd November 15, 2000
  29 .Dt ACCF_HTTP 9
  30 .Os
  31 .Sh NAME
  32 .Nm accf_http
  33 .Nd "buffer incoming connections until a certain complete HTTP requests arrive"
  34 .Sh SYNOPSIS
  35 .Cd options INET
  36 .Cd options ACCEPT_FILTER_HTTP
  37 .Li kldload accf_http
  38 .Sh DESCRIPTION
  39 This is a filter to be placed on a socket that will be using
  40 .Fn accept
  41 to receive incoming HTTP connections.
  42 .Pp
  43 It prevents the application from receiving the connected descriptor via
  44 .Fn accept
  45 until either a full HTTP/1.0 or HTTP/1.1 HEAD or GET request has
  46 been buffered by the kernel.
  47 .Pp
  48 If something other than a HTTP/1.0 or
  49 HTTP/1.1 HEAD or GET request is received the kernel will
  50 allow the application to receive the connection descriptor
  51 via
  52 .Fn accept .
  53 .Pp
  54 The utility of
  55 .Nm
  56 is such that a server will not have to context switch several times
  57 before performing the initial parsing of the request.
  58 This effectively reduces the amount of required CPU utilization
  59 to handle incoming requests by keeping active
  60 processes in preforking servers such as Apache low
  61 and reducing the size of the filedescriptor set that needs
  62 to be managed by interfaces such as
  63 .Fn select ,
  64 .Fn poll
  65 or
  66 .Fn kevent
  67 based servers.
  68 .Pp
  69 The
  70 .Nm
  71 kernel option is also a module that can be enabled at runtime via
  72 .Xr kldload 8
  73 if the INET option has been compiled into the kernel.
  74 .Sh EXAMPLES
  75 Assuming ACCEPT_FILTER_HTTP has been included in the kernel config
  76 file or the
  77 .Nm
  78 module has been loaded, this will enable the http accept filter
  79 on the socket
  80 .Fa sok .
  81 .Bd -literal -offset 0i
  82         struct accept_filter_arg afa;
  83
  84         bzero(&afa, sizeof(afa));
  85         strcpy(afa.af_name, "httpready");
  86         setsockopt(sok, SOL_SOCKET, SO_ACCEPTFILTER, &afa, sizeof(afa));
  87 .Ed
  88 .Sh SEE ALSO
  89 .Xr setsockopt 2 ,
  90 .Xr accept_filter 9
  91 .Sh HISTORY
  92 The accept filter mechanism and the
  93 .Nm
  94 filter were introduced in
  95 .Fx 4.0 .
  96 .Sh AUTHORS
  97 This manual page and the filter were written by
  98 .An Alfred Perlstein .