lib/libnetgraph/netgraph.3

   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@whistle.com>
  34 .\"
  35 .\" $FreeBSD: src/lib/libnetgraph/netgraph.3,v 1.4.2.10 2002/12/29 16:35:36 schweikh Exp $
  36 .\" $DragonFly: src/lib/libnetgraph/netgraph.3,v 1.2 2003/06/17 04:26:50 dillon Exp $
  37 .\" $Whistle: netgraph.3,v 1.7 1999/01/25 07:14:06 archie Exp $
  38 .\"
  39 .Dd January 19, 1999
  40 .Dt NETGRAPH 3
  41 .Os
  42 .Sh NAME
  43 .Nm NgMkSockNode ,
  44 .Nm NgNameNode ,
  45 .Nm NgSendMsg ,
  46 .Nm NgRecvMsg ,
  47 .Nm NgSendData ,
  48 .Nm NgRecvData ,
  49 .Nm NgSetDebug ,
  50 .Nm NgSetErrLog
  51 .Nd netgraph user library
  52 .Sh LIBRARY
  53 .Lb libnetgraph
  54 .Sh SYNOPSIS
  55 .In netgraph.h
  56 .Ft int
  57 .Fn NgMkSockNode "const char *name" "int *csp" "int *dsp"
  58 .Ft int
  59 .Fn NgNameNode "int cs" "const char *path" "const char *fmt" "..."
  60 .Ft int
  61 .Fn NgSendMsg "int cs" "const char *path" "int cookie" "int cmd" "const void *arg" "size_t arglen"
  62 .Ft int
  63 .Fn NgSendAsciiMsg "int cs" "const char *path" "const char *fmt" "..."
  64 .Ft int
  65 .Fn NgSendMsgReply "int cs" "const char *path" "struct ng_mesg *msg" "const void *arg" "size_t arglen"
  66 .Ft int
  67 .Fn NgRecvMsg "int cs" "struct ng_mesg *rep" "size_t replen" "char *path"
  68 .Ft int
  69 .Fn NgRecvAsciiMsg "int cs" "struct ng_mesg *rep" "size_t replen" "char *path"
  70 .Ft int
  71 .Fn NgSendData "int ds" "const char *hook" "const u_char *buf" "size_t len"
  72 .Ft int
  73 .Fn NgRecvData "int ds" "u_char *buf" "size_t len" "char *hook"
  74 .Ft int
  75 .Fn NgSetDebug "int level"
  76 .Ft void
  77 .Fn NgSetErrLog "void (*log)(const char *fmt, ...)" "void (*logx)(const char *fmt, ...)"
  78 .Sh DESCRIPTION
  79 These functions facilitate user-mode program participation in the kernel
  80 .Xr netgraph 4
  81 graph-based networking system, by utilizing the netgraph
  82 .Em socket
  83 node type (see
  84 .Xr ng_socket 4 ) .
  85 .Pp
  86 .Fn NgMkSockNode
  87 should be called first, to create a new
  88 .Em socket
  89 type netgraph node with associated control and data sockets.  If
  90 .Fa name
  91 is non-NULL, the node will have that global name assigned to it.
  92 .Fa "*csp"
  93 and
  94 .Fa "*dsp"
  95 will be set to the newly opened control and data sockets
  96 associated with the node; either
  97 .Fa "csp"
  98 or
  99 .Fa "dsp"
 100 may be NULL if only one socket is desired.
 101 .Fn NgMkSockNode
 102 loads the socket node type KLD if it's not already loaded.
 103 .Pp
 104 .Fn NgNameNode
 105 assigns a global name to the node addressed by
 106 .Fa path .
 107 .Pp
 108 .Fn NgSendMsg
 109 sends a binary control message from the socket node associated
 110 with control socket
 111 .Fa cs
 112 to the node addressed by
 113 .Fa path .
 114 The
 115 .Fa cookie
 116 indicates how to interpret
 117 .Fa cmd ,
 118 which indicates a specific command.
 119 Extra argument data (if any) is specified by
 120 .Fa arg
 121 and
 122 .Fa arglen .
 123 The
 124 .Fa cookie ,
 125 .Fa cmd ,
 126 and argument data are defined by the header file corresponding
 127 to the type of the node being addressed.
 128 The unique, non-negative token value chosen for use in the message
 129 header is returned.  This value is typically used to associate replies.
 130 .Pp
 131 Use
 132 .Fn NgSendMsgReply
 133 to send reply to a previously received control message.
 134 The original message header should be pointed to by
 135 .Fa msg .
 136 .Pp
 137 .Fn NgSendAsciiMsg
 138 performs the same function as
 139 .Fn NgSendMsg ,
 140 but adds support for
 141 .Tn ASCII
 142 encoding of control messages.
 143 .Fn NgSendAsciiMsg
 144 formats its input a la
 145 .Xr printf 3
 146 and then sends the resulting
 147 .Tn ASCII
 148 string to the node in a
 149 .Dv NGM_ASCII2BINARY
 150 control message.  The node returns a binary version of the
 151 message, which is then sent back to the node just as with
 152 .Fn NgSendMsg .
 153 As with
 154 .Fn NgSendMsg ,
 155 the message token value is returned.
 156 Note that
 157 .Tn ASCII
 158 conversion may not be supported by all node types.
 159 .Pp
 160 .Fn NgRecvMsg
 161 reads the next control message received by the node associated with
 162 control socket
 163 .Fa cs .
 164 The message and any extra argument data must fit in
 165 .Fa replen
 166 bytes.
 167 If
 168 .Fa "path"
 169 is non-NULL, it must point to a buffer of at least
 170 .Dv "NG_PATHLEN + 1"
 171 bytes, which will be filled in (and NUL terminated) with the path to
 172 the node from which the message was received.
 173 .Pp
 174 The length of the control message is returned.
 175 A return value of zero indicates that the socket was closed.
 176 .Pp
 177 .Fn NgRecvAsciiMsg
 178 works exactly like
 179 .Fn NgRecvMsg ,
 180 except that after the message is received, any binary arguments
 181 are converted to
 182 .Tn ASCII
 183 by sending a
 184 .Dv NGM_BINARY2ASCII
 185 request back to the originating node.  The result is the same as
 186 .Fn NgRecvAsciiMsg ,
 187 with the exception that the reply arguments field will contain
 188 a NUL-terminated
 189 .Tn ASCII
 190 version of the arguments (and the reply
 191 header argument length field will be adjusted).
 192 .Pp
 193 .Fn NgSendData
 194 writes a data packet out on the specified hook of the node corresponding
 195 to data socket
 196 .Fa ds .
 197 The node must already be connected to some other node via that hook.
 198 .Pp
 199 .Fn NgRecvData
 200 reads the next data packet (of up to
 201 .Fa len
 202 bytes) received by the node corresponding to data socket
 203 .Fa ds
 204 and stores it in
 205 .Fa buf ,
 206 which must be large enough to hold the entire packet.  If
 207 .Fa "hook"
 208 is non-NULL, it must point to a buffer of at least
 209 .Dv "NG_HOOKLEN + 1"
 210 bytes, which will be filled in (and NUL terminated) with the name of
 211 the hook on which the data was received.
 212 .Pp
 213 The length of the packet is returned.
 214 A return value of zero indicates that the socket was closed.
 215 .Pp
 216 .Fn NgSetDebug
 217 and
 218 .Fn NgSetErrLog
 219 are used for debugging.
 220 .Fn NgSetDebug
 221 sets the debug level (if non-negative), and returns the old setting.
 222 Higher debug levels result in more verbosity.  The default is zero.
 223 All debug and error messages are logged via the functions
 224 specified in the most recent call to
 225 .Fn NgSetErrLog .
 226 The default logging functions are
 227 .Xr vwarn 3
 228 and
 229 .Xr vwarnx 3 .
 230 .Pp
 231 At debug level 3, the library attempts to display control message arguments
 232 in
 233 .Tn ASCII
 234 format; however, this results in additional messages being
 235 sent which may interfere with debugging.  At even higher levels,
 236 even these additional messages will be displayed, etc.
 237 .Pp
 238 Note that
 239 .Xr select 2
 240 can be used on the data and the control sockets to detect the presence of
 241 incoming data and control messages, respectively.
 242 Data and control packets are always written and read atomically, i.e.,
 243 in one whole piece.
 244 .Pp
 245 User mode programs must be linked with the
 246 .Dv -lnetgraph
 247 flag to link in this library.
 248 .Sh INITIALIZATION
 249 To enable Netgraph in your kernel, either your kernel must be
 250 compiled with
 251 .Dq options NETGRAPH
 252 in the kernel configuration
 253 file, or else the
 254 .Xr netgraph 4
 255 and
 256 .Xr ng_socket 4
 257 KLD modules must have been loaded via
 258 .Xr kldload 8 .
 259 .Sh RETURN VALUES
 260 .Fn NgSetDebug
 261 returns the previous debug setting.
 262 .Fn NgSetErrLog
 263 has no return value.
 264 All other functions return \-1 if there was an error and set
 265 .Va errno
 266 accordingly.
 267 A return value of zero from
 268 .Fn NgRecvMsg
 269 or
 270 .Fn NgRecvData
 271 indicates that the netgraph socket has been closed.
 272 .Pp
 273 For
 274 .Fn NgSendAsciiMsg
 275 and
 276 .Fn NgRecvAsciiMsg ,
 277 the following additional errors are possible:
 278 .Bl -tag -width Er
 279 .It Bq Er ENOSYS
 280 The node type does not know how to encode or decode the control message.
 281 .It Bq Er ERANGE
 282 The encoded or decoded arguments were too long for the supplied buffer.
 283 .It Bq Er ENOENT
 284 An unknown structure field was seen in an
 285 .Tn ASCII
 286 control message.
 287 .It Bq Er EALREADY
 288 The same structure field was specified twice in an
 289 .Tn ASCII
 290 control message.
 291 .It Bq Er EINVAL
 292 .Tn ASCII
 293 control message parse error or illegal value.
 294 .It Bq Er E2BIG
 295 ASCII control message array or fixed width string buffer overflow.
 296 .El
 297 .Sh SEE ALSO
 298 .Xr select 2 ,
 299 .Xr socket 2 ,
 300 .Xr warnx 3 ,
 301 .Xr kld 4 ,
 302 .Xr netgraph 4 ,
 303 .Xr ng_socket 4
 304 .Sh HISTORY
 305 The
 306 .Nm netgraph
 307 system was designed and first implemented at Whistle Communications, Inc. in
 308 a version of
 309 .Fx 2.2
 310 customized for the Whistle InterJet.
 311 .Sh AUTHORS
 312 .An Archie Cobbs Aq archie@whistle.com