share/man/man4/ng_socket.4

   1 .\" Copyright (c) 1996-1999 Whistle Communications, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Subject to the following obligations and disclaimer of warranty, use and
   5 .\" redistribution of this software, in source or object code forms, with or
   6 .\" without modifications are expressly permitted by Whistle Communications;
   7 .\" provided, however, that:
   8 .\" 1. Any and all reproductions of the source or object code must include the
   9 .\"    copyright notice above and the following disclaimer of warranties; and
  10 .\" 2. No rights are granted, in any manner or form, to use Whistle
  11 .\"    Communications, Inc. trademarks, including the mark "WHISTLE
  12 .\"    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
  13 .\"    such appears in the above copyright notice or in the software.
  14 .\"
  15 .\" THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
  16 .\" TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
  17 .\" REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
  18 .\" INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
  20 .\" WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
  21 .\" REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
  22 .\" SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
  23 .\" IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
  24 .\" RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
  25 .\" WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  26 .\" PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
  27 .\" SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
  28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  30 .\" THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
  31 .\" OF SUCH DAMAGE.
  32 .\"
  33 .\" Author: Archie Cobbs <archie@FreeBSD.org>
  34 .\"
  35 .\" $FreeBSD$
  36 .\" $Whistle: ng_socket.8,v 1.5 1999/01/25 23:46:27 archie Exp $
  37 .\"
  38 .Dd January 19, 1999
  39 .Dt NG_SOCKET 4
  40 .Os
  41 .Sh NAME
  42 .Nm ng_socket
  43 .Nd netgraph socket node type
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In netgraph/ng_socket.h
  47 .Sh DESCRIPTION
  48 A
  49 .Nm socket
  50 node is both a
  51 .Bx
  52 socket and a netgraph node.
  53 The
  54 .Nm
  55 node type allows user-mode processes to participate in the kernel
  56 .Xr netgraph 4
  57 networking subsystem using the
  58 .Bx
  59 socket interface.
  60 The process must have
  61 root privileges to be able to create netgraph sockets however once created,
  62 any process that has one may use it.
  63 .Pp
  64 A new
  65 .Nm
  66 node is created by creating a new socket of type
  67 .Dv NG_CONTROL
  68 in the protocol family
  69 .Dv PF_NETGRAPH ,
  70 using the
  71 .Xr socket 2
  72 system call.
  73 Any control messages received by the node
  74 and not having a cookie value of
  75 .Dv NGM_SOCKET_COOKIE
  76 are received by the process, using
  77 .Xr recvfrom 2 ;
  78 the socket address argument is a
  79 .Dv "struct sockaddr_ng"
  80 containing the sender's netgraph address.
  81 Conversely, control messages can be sent to any node by calling
  82 .Xr sendto 2 ,
  83 supplying the recipient's address in a
  84 .Dv "struct sockaddr_ng" .
  85 The
  86 .Xr bind 2
  87 system call may be used to assign a global netgraph name to the node.
  88 .Pp
  89 To transmit and receive netgraph data packets, a
  90 .Dv NG_DATA
  91 socket must also be created using
  92 .Xr socket 2
  93 and associated with a
  94 .Nm
  95 node.
  96 .Dv NG_DATA
  97 sockets do not automatically
  98 have nodes associated with them; they are bound to a specific node via the
  99 .Xr connect 2
 100 system call.
 101 The address argument is the netgraph address of the
 102 .Nm
 103 node already created.
 104 Once a data socket is associated with a node,
 105 any data packets received by the node are read using
 106 .Xr recvfrom 2
 107 and any packets to be sent out from the node are written using
 108 .Xr sendto 2 .
 109 In the case of data sockets, the
 110 .Dv "struct sockaddr_ng"
 111 contains the name of the
 112 .Em hook
 113 on which the data was received or should be sent.
 114 .Pp
 115 As a special case, to allow netgraph data sockets to be used as stdin or stdout
 116 on naive programs, a
 117 .Xr sendto 2
 118 with a NULL sockaddr pointer, a
 119 .Xr send 2
 120 or a
 121 .Xr write 2
 122 will succeed in the case where there is exactly ONE hook attached to
 123 the socket node, (and thus the path is unambiguous).
 124 .Pp
 125 There is a user library that simplifies using netgraph sockets; see
 126 .Xr netgraph 3 .
 127 .Sh HOOKS
 128 This node type supports hooks with arbitrary names (as long as
 129 they are unique) and always accepts hook connection requests.
 130 .Sh CONTROL MESSAGES
 131 This node type supports the generic control messages, plus the following:
 132 .Bl -tag -width foo
 133 .It Dv NGM_SOCK_CMD_NOLINGER
 134 When the last hook is removed from this node, it will shut down as
 135 if it had received a
 136 .Dv NGM_SHUTDOWN
 137 message.
 138 Attempts to access the sockets associated will return
 139 .Er ENOTCONN .
 140 .It Dv NGM_SOCK_CMD_LINGER
 141 This is the default mode.
 142 When the last hook is removed, the node will
 143 continue to exist, ready to accept new hooks until it
 144 is explicitly shut down.
 145 .El
 146 .Pp
 147 All other messages
 148 with neither the
 149 .Dv NGM_SOCKET_COOKIE
 150 or
 151 .Dv NGM_GENERIC_COOKIE
 152 will be passed unaltered up the
 153 .Dv NG_CONTROL
 154 socket.
 155 .Sh SHUTDOWN
 156 This node type shuts down and disappears when both the associated
 157 .Dv NG_CONTROL
 158 and
 159 .Dv NG_DATA
 160 sockets have been closed, or a
 161 .Dv NGM_SHUTDOWN
 162 control message is received.
 163 In the latter case, attempts to write
 164 to the still-open sockets will return
 165 .Er ENOTCONN .
 166 If the
 167 .Dv NGM_SOCK_CMD_NOLINGER
 168 message has been received, closure of the last hook will also initiate
 169 a shutdown of the node.
 170 .Sh SEE ALSO
 171 .Xr socket 2 ,
 172 .Xr netgraph 3 ,
 173 .Xr netgraph 4 ,
 174 .Xr ng_ksocket 4 ,
 175 .Xr ngctl 8
 176 .Sh HISTORY
 177 The
 178 .Nm
 179 node type was implemented in
 180 .Fx 4.0 .
 181 .Sh AUTHORS
 182 .An Julian Elischer Aq julian@FreeBSD.org
 183 .Sh BUGS
 184 It is not possible to reject the connection of a hook, though any
 185 data received on that hook can certainly be ignored.
 186 .Pp
 187 The controlling process is not notified of all events that an in-kernel node
 188 would be notified of, e.g.\& a new hook, or hook removal.
 189 Some node-initiated messages should be defined for this purpose (to be
 190 sent up the control socket).