1 .\" Copyright (c) 1996-1999 Whistle Communications, Inc.
2 .\" All rights reserved.
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.
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
33 .\" Authors: Julian Elischer <julian@FreeBSD.org>
34 .\" Archie Cobbs <archie@FreeBSD.org>
36 .\" $FreeBSD: src/share/man/man4/netgraph.4,v 1.39.2.1 2001/12/21 09:00:50 ru Exp $
37 .\" $Whistle: netgraph.4,v 1.7 1999/01/28 23:54:52 julian Exp $
44 .Nd graph based kernel networking subsystem
48 system provides a uniform and modular system for the implementation
49 of kernel objects which perform various networking functions. The objects,
52 can be arranged into arbitrarily complicated graphs. Nodes have
54 which are used to connect two nodes together, forming the edges in the graph.
55 Nodes communicate along the edges to process data, implement protocols, etc.
59 is to supplement rather than replace the existing kernel networking
60 infrastructure. It provides:
62 .Bl -bullet -compact -offset 2n
64 A flexible way of combining protocol and link level drivers
66 A modular way to implement new protocols
68 A common framework for kernel entities to inter-communicate
70 A reasonably fast, kernel-based implementation
73 The most fundamental concept in
77 All nodes implement a number of predefined methods which allow them
78 to interact with other nodes in a well defined manner.
82 which is a static property of the node determined at node creation time.
83 A node's type is described by a unique
86 The type implies what the node does and how it may be connected
89 In object-oriented language, types are classes and nodes are instances
90 of their respective class. All node types are subclasses of the generic node
91 type, and hence inherit certain common functionality and capabilities
92 (e.g., the ability to have an
96 Nodes may be assigned a globally unique
99 used to refer to the node.
100 The name must not contain the characters
106 characters (including NUL byte).
108 Each node instance has a unique
110 which is expressed as a 32-bit hex value. This value may be used to
111 refer to a node when there is no
115 Nodes are connected to other nodes by connecting a pair of
117 one from each node. Data flows bidirectionally between nodes along
118 connected pairs of hooks. A node may have as many hooks as it
119 needs, and may assign whatever meaning it wants to a hook.
121 Hooks have these properties:
123 .Bl -bullet -compact -offset 2n
127 name which is unique among all hooks
128 on that node (other hooks on other nodes may have the same name).
129 The name must not contain a
136 characters (including NUL byte).
138 A hook is always connected to another hook. That is, hooks are
139 created at the time they are connected, and breaking an edge by
140 removing either hook destroys both hooks.
143 A node may decide to assign special meaning to some hooks.
144 For example, connecting to the hook named
147 the node to start sending debugging information to that hook.
149 Two types of information flow between nodes: data messages and
150 control messages. Data messages are passed in mbuf chains along the edges
151 in the graph, one edge at a time. The first mbuf in a chain must have the
153 flag set. Each node decides how to handle data coming in on its hooks.
155 Control messages are type-specific C structures sent from one node
156 directly to some arbitrary other node. Control messages have a common
157 header format, followed by type-specific data, and are binary structures
158 for efficiency. However, node types also may support conversion of the
159 type specific data between binary and
161 for debugging and human interface purposes (see the
165 generic control messages below). Nodes are not required to support
168 There are two ways to address a control message. If
169 there is a sequence of edges connecting the two nodes, the message
172 by specifying the corresponding sequence
173 of hooks as the destination address for the message (relative
174 addressing). Otherwise, the recipient node global
177 (or equivalent ID based name) is used as the destination address
178 for the message (absolute addressing). The two types of addressing
179 may be combined, by specifying an absolute start node and a sequence
182 Messages often represent commands that are followed by a reply message
183 in the reverse direction. To facilitate this, the recipient of a
184 control message is supplied with a
186 that is suitable for addressing a reply.
188 Each control message contains a 32 bit value called a
190 indicating the type of the message, i.e., how to interpret it.
191 Typically each type defines a unique typecookie for the messages
192 that it understands. However, a node may choose to recognize and
193 implement more than one type of message.
194 .Sh Netgraph is Functional
195 In order to minimize latency, most
197 operations are functional.
198 That is, data and control messages are delivered by making function
199 calls rather than by using queues and mailboxes. For example, if node
200 A wishes to send a data mbuf to neighboring node B, it calls the
203 data delivery function. This function in turn locates
206 method. While this mode of operation
207 results in good performance, it has a few implications for node
210 .Bl -bullet -compact -offset 2n
212 Whenever a node delivers a data or control message, the node
213 may need to allow for the possibility of receiving a returning
214 message before the original delivery function call returns.
216 Netgraph nodes and support routines generally run at
218 However, some nodes may want to send data and control messages
219 from a different priority level. Netgraph supplies queueing routines which
220 utilize the NETISR system to move message delivery to
222 Note that messages are always received at
225 It's possible for an infinite loop to occur if the graph contains cycles.
228 So far, these issues have not proven problematical in practice.
229 .Sh Interaction With Other Parts of the Kernel
230 A node may have a hidden interaction with other components of the
231 kernel outside of the
233 subsystem, such as device hardware,
234 kernel protocol stacks, etc. In fact, one of the benefits of
236 is the ability to join disparate kernel networking entities together in a
237 consistent communication framework.
239 An example is the node type
241 which is both a netgraph node and a
244 socket in the protocol family
246 Socket nodes allow user processes to participate in
248 Other nodes communicate with socket nodes using the usual methods, and the
249 node hides the fact that it is also passing information to and from a
250 cooperating user process.
252 Another example is a device driver that presents
253 a node interface to the hardware.
255 Nodes are notified of the following actions via function calls
256 to the following node methods (all at
258 and may accept or reject that action (by returning the appropriate
261 .It Creation of a new node
262 The constructor for the type is called. If creation of a new node is
263 allowed, the constructor must call the generic node creation
264 function (in object-oriented terms, the superclass constructor)
265 and then allocate any special resources it needs. For nodes that
266 correspond to hardware, this is typically done during the device
267 attach routine. Often a global
269 name corresponding to the
270 device name is assigned here as well.
271 .It Creation of a new hook
272 The hook is created and tentatively
273 linked to the node, and the node is told about the name that will be
274 used to describe this hook. The node sets up any special data structures
275 it needs, or may reject the connection, based on the name of the hook.
276 .It Successful connection of two hooks
277 After both ends have accepted their
278 hooks, and the links have been made, the nodes get a chance to
279 find out who their peer is across the link and can then decide to reject
280 the connection. Tear-down is automatic.
281 .It Destruction of a hook
282 The node is notified of a broken connection. The node may consider some hooks
283 to be critical to operation and others to be expendable: the disconnection
284 of one hook may be an acceptable event while for another it
285 may affect a total shutdown for the node.
286 .It Shutdown of a node
287 This method allows a node to clean up
288 and to ensure that any actions that need to be performed
289 at this time are taken. The method must call the generic (i.e., superclass)
290 node destructor to get rid of the generic components of the node.
291 Some nodes (usually associated with a piece of hardware) may be
293 in that a shutdown breaks all edges and resets the node,
294 but doesn't remove it, in which case the generic destructor is not called.
296 .Sh Sending and Receiving Data
297 Three other methods are also supported by all nodes:
299 .It Receive data message
300 An mbuf chain is passed to the node.
301 The node is notified on which hook the data arrived,
302 and can use this information in its processing decision.
303 The node must must always
305 the mbuf chain on completion or error, or pass it on to another node
306 (or kernel module) which will then be responsible for freeing it.
308 In addition to the mbuf chain itself there is also a pointer to a
309 structure describing meta-data about the message
310 (e.g. priority information). This pointer may be
312 if there is no additional information. The format for this information is
314 .Pa sys/netgraph/netgraph.h .
315 The memory for meta-data must allocated via
319 As with the data itself, it is the receiver's responsibility to
321 the meta-data. If the mbuf chain is freed the meta-data must
322 be freed at the same time. If the meta-data is freed but the
323 real data on is passed on, then a
325 pointer must be substituted.
327 The receiving node may decide to defer the data by queueing it in the
329 NETISR system (see below).
331 The structure and use of meta-data is still experimental, but is
332 presently used in frame-relay to indicate that management packets
333 should be queued for transmission
334 at a higher priority than data packets. This is required for
335 conformance with Frame Relay standards.
337 .It Receive queued data message
338 Usually this will be the same function as
339 .Em Receive data message.
340 This is the entry point called when a data message is being handed to
341 the node after having been queued in the NETISR system.
342 This allows a node to decide in the
343 .Em Receive data message
344 method that a message should be deferred and queued,
345 and be sure that when it is processed from the queue,
346 it will not be queued again.
347 .It Receive control message
348 This method is called when a control message is addressed to the node.
349 A return address is always supplied, giving the address of the node
350 that originated the message so a reply message can be sent anytime later.
352 It is possible for a synchronous reply to be made, and in fact this
353 is more common in practice.
354 This is done by setting a pointer (supplied as an extra function parameter)
355 to point to the reply.
356 Then when the control message delivery function returns,
357 the caller can check if this pointer has been made non-NULL,
358 and if so then it points to the reply message allocated via
360 and containing the synchronous response. In both directions,
361 (request and response) it is up to the
362 receiver of that message to
364 the control message buffer. All control messages and replies are
371 Much use has been made of reference counts, so that nodes being
372 free'd of all references are automatically freed, and this behaviour
373 has been tested and debugged to present a consistent and trustworthy
380 framework provides an unambiguous and simple to use method of specifically
381 addressing any single node in the graph. The naming of a node is
382 independent of its type, in that another node, or external component
383 need not know anything about the node's type in order to address it so as
384 to send it a generic message type. Node and hook names should be
385 chosen so as to make addresses meaningful.
387 Addresses are either absolute or relative. An absolute address begins
388 with a node name, (or ID), followed by a colon, followed by a sequence of hook
389 names separated by periods. This addresses the node reached by starting
390 at the named node and following the specified sequence of hooks.
391 A relative address includes only the sequence of hook names, implicitly
392 starting hook traversal at the local node.
394 There are a couple of special possibilities for the node name.
399 always refers to the local node.
400 Also, nodes that have no global name may be addressed by their ID numbers,
401 by enclosing the hex representation of the ID number within square brackets.
402 Here are some examples of valid netgraph addresses:
403 .Bd -literal -offset 4n -compact
412 Consider the following set of nodes might be created for a site with
413 a single physical frame relay line having two active logical DLCI channels,
414 with RFC-1490 frames on DLCI 16 and PPP frames over DLCI 20:
417 [type SYNC ] [type FRAME] [type RFC1490]
418 [ "Frame1" ](uplink)<-->(data)[<un-named>](dlci16)<-->(mux)[<un-named> ]
419 [ A ] [ B ](dlci20)<---+ [ C ]
426 One could always send a control message to node C from anywhere
428 .Em "Frame1:uplink.dlci16" .
430 .Em "Frame1:uplink.dlci20"
431 could reliably be used to reach node D, and node A could refer
436 Conversely, B can refer to A as
440 could be used by both nodes C and D to address a message to node A.
442 Note that this is only for
443 .Em control messages .
444 Data messages are routed one hop at a time, by specifying the departing
445 hook, with each node making the next routing decision. So when B
446 receives a frame on hook
448 it decodes the frame relay header to determine the DLCI,
449 and then forwards the unwrapped frame to either C or D.
451 A similar graph might be used to represent multi-link PPP running
455 [ type BRI ](B1)<--->(link1)[ type MPP ]
456 [ "ISDN1" ](B2)<--->(link2)[ (no name) ]
461 +->(switch)[ type Q.921 ](term1)<---->(datalink)[ type Q.931 ]
462 [ (no name) ] [ (no name) ]
464 .Sh Netgraph Structures
465 Interesting members of the node and hook structures are shown below:
468 char *name; /* Optional globally unique name */
469 void *private; /* Node implementation private info */
470 struct ng_type *type; /* The type of this node */
471 int refs; /* Number of references to this struct */
472 int numhooks; /* Number of connected hooks */
473 hook_p hooks; /* Linked list of (connected) hooks */
475 typedef struct ng_node *node_p;
478 char *name; /* This node's name for this hook */
479 void *private; /* Node implementation private info */
480 int refs; /* Number of references to this struct */
481 struct ng_node *node; /* The node this hook is attached to */
482 struct ng_hook *peer; /* The other hook in this connected pair */
483 struct ng_hook *next; /* Next in list of hooks for this node */
485 typedef struct ng_hook *hook_p;
488 The maintenance of the name pointers, reference counts, and linked list
489 of hooks for each node is handled automatically by the
492 Typically a node's private info contains a back-pointer to the node or hook
493 structure, which counts as a new reference that must be registered by
497 From a hook you can obtain the corresponding node, and from
498 a node the list of all active hooks.
500 Node types are described by these structures:
502 /** How to convert a control message from binary <-> ASCII */
504 u_int32_t cookie; /* typecookie */
505 int cmd; /* command number */
506 const char *name; /* command name */
507 const struct ng_parse_type *mesgType; /* args if !NGF_RESP */
508 const struct ng_parse_type *respType; /* args if NGF_RESP */
512 u_int32_t version; /* Must equal NG_VERSION */
513 const char *name; /* Unique type name */
515 /* Module event handler */
516 modeventhand_t mod_event; /* Handle load/unload (optional) */
519 int (*constructor)(node_p *node); /* Create a new node */
521 /** Methods using the node **/
522 int (*rcvmsg)(node_p node, /* Receive control message */
523 struct ng_mesg *msg, /* The message */
524 const char *retaddr, /* Return address */
525 struct ng_mesg **resp); /* Synchronous response */
526 int (*shutdown)(node_p node); /* Shutdown this node */
527 int (*newhook)(node_p node, /* create a new hook */
528 hook_p hook, /* Pre-allocated struct */
529 const char *name); /* Name for new hook */
531 /** Methods using the hook **/
532 int (*connect)(hook_p hook); /* Confirm new hook attachment */
533 int (*rcvdata)(hook_p hook, /* Receive data on a hook */
534 struct mbuf *m, /* The data in an mbuf */
535 meta_p meta); /* Meta-data, if any */
536 int (*disconnect)(hook_p hook); /* Notify disconnection of hook */
538 /** How to convert control messages binary <-> ASCII */
539 const struct ng_cmdlist *cmdlist; /* Optional; may be NULL */
543 Control messages have the following structure:
545 #define NG_CMDSTRLEN 15 /* Max command string (16 with null) */
549 u_char version; /* Must equal NG_VERSION */
550 u_char spare; /* Pad to 2 bytes */
551 u_short arglen; /* Length of cmd/resp data */
552 u_long flags; /* Message status flags */
553 u_long token; /* Reply should have the same token */
554 u_long typecookie; /* Node type understanding this message */
555 u_long cmd; /* Command identifier */
556 u_char cmdstr[NG_CMDSTRLEN+1]; /* Cmd string (for debug) */
558 char data[0]; /* Start of cmd/resp data */
561 #define NG_VERSION 1 /* Netgraph version */
562 #define NGF_ORIG 0x0000 /* Command */
563 #define NGF_RESP 0x0001 /* Response */
566 Control messages have the fixed header shown above, followed by a
567 variable length data section which depends on the type cookie
568 and the command. Each field is explained below:
571 Indicates the version of netgraph itself. The current version is
574 This is the length of any extra arguments, which begin at
577 Indicates whether this is a command or a response control message.
581 is a means by which a sender can match a reply message to the
582 corresponding command message; the reply always has the same token.
585 The corresponding node type's unique 32-bit value.
586 If a node doesn't recognize the type cookie it must reject the message
590 Each type should have an include file that defines the commands,
591 argument format, and cookie for its own messages.
593 insures that the same header file was included by both sender and
594 receiver; when an incompatible change in the header file is made,
598 The de facto method for generating unique type cookies is to take the
599 seconds from the epoch at the time the header file is written
601 .Dv "date -u +'%s'" ) .
603 There is a predefined typecookie
604 .Dv NGM_GENERIC_COOKIE
608 a corresponding set of generic messages which all nodes understand.
609 The handling of these messages is automatic.
611 The identifier for the message command. This is type specific,
612 and is defined in the same header file as the typecookie.
614 Room for a short human readable version of
616 (for debugging purposes only).
619 Some modules may choose to implement messages from more than one
620 of the header files and thus recognize more than one type cookie.
621 .Sh Control Message ASCII Form
622 Control messages are in binary format for efficiency. However, for
623 debugging and human interface purposes, and if the node type supports
624 it, control messages may be converted to and from an equivalent
628 form is similar to the binary form, with two exceptions:
630 .Bl -tag -compact -width xxx
634 header field must contain the
636 name of the command, corresponding to the
642 field contains a NUL-terminated
644 string version of the message arguments.
647 In general, the arguments field of a control messgage can be any
648 arbitrary C data type. Netgraph includes parsing routines to support
649 some pre-defined datatypes in
651 with this simple syntax:
653 .Bl -tag -compact -width xxx
655 Integer types are represented by base 8, 10, or 16 numbers.
657 Strings are enclosed in double quotes and respect the normal
658 C language backslash escapes.
660 IP addresses have the obvious form.
662 Arrays are enclosed in square brackets, with the elements listed
663 consecutively starting at index zero. An element may have an optional
664 index and equals sign preceding it. Whenever an element
665 does not have an explicit index, the index is implicitly the previous
666 element's index plus one.
668 Structures are enclosed in curly braces, and each field is specified
670 .Dq fieldname=value .
672 Any array element or structure field whose value is equal to its
674 may be omitted. For integer types, the default value
675 is usually zero; for string types, the empty string.
677 Array elements and structure fields may be specified in any order.
680 Each node type may define its own arbitrary types by providing
681 the necessary routines to parse and unparse.
684 for a specific node type are documented in the documentation for
686 .Sh Generic Control Messages
687 There are a number of standard predefined messages that will work
688 for any node, as they are supported directly by the framework itself.
691 along with the basic layout of messages and other similar information.
694 Connect to another node, using the supplied hook names on either end.
696 Construct a node of the given type and then connect to it using the
699 The target node should disconnect from all its neighbours and shut down.
700 Persistent nodes such as those representing physical hardware
701 might not disappear from the node namespace, but only reset themselves.
702 The node must disconnect all of its hooks.
703 This may result in neighbors shutting themselves down, and possibly a
704 cascading shutdown of the entire connected graph.
706 Assign a name to a node. Nodes can exist without having a name, and this
707 is the default for nodes created using the
709 method. Such nodes can only be addressed relatively or by their ID number.
711 Ask the node to break a hook connection to one of its neighbours.
712 Both nodes will have their
715 Either node may elect to totally shut down as a result.
717 Asks the target node to describe itself. The four returned fields
718 are the node name (if named), the node type, the node ID and the
719 number of hooks attached. The ID is an internal number unique to that node.
721 This returns the information given by
724 includes an array of fields describing each link, and the description for
725 the node at the far end of that link.
727 This returns an array of node descriptions (as for
729 where each entry of the array describes a named node.
730 All named nodes will be described.
734 except that all nodes are listed regardless of whether they have a name or not.
736 This returns a list of all currently installed netgraph types.
737 .It Dv NGM_TEXT_STATUS
738 The node may return a text formatted status message.
739 The status information is determined entirely by the node type.
740 It is the only "generic" message
741 that requires any support within the node itself and as such the node may
742 elect to not support this message. The text response must be less than
744 bytes in length (presently 1024). This can be used to return general
745 status information in human readable form.
746 .It Dv NGM_BINARY2ASCII
747 This message converts a binary control message to its
750 The entire control message to be converted is contained within the
751 arguments field of the
753 message itself. If successful, the reply will contain the same control
757 A node will typically only know how to translate messages that it
758 itself understands, so the target node of the
760 is often the same node that would actually receive that message.
761 .It Dv NGM_ASCII2BINARY
763 .Dv NGM_BINARY2ASCII .
764 The entire control message to be converted, in
767 in the arguments section of the
769 and need only have the
774 header fields filled in, plus the NUL-terminated string version of
775 the arguments in the arguments field. If successful, the reply
776 contains the binary version of the control message.
779 Data moving through the
781 system can be accompanied by meta-data that describes some
782 aspect of that data. The form of the meta-data is a fixed header,
783 which contains enough information for most uses, and can optionally
784 be supplemented by trailing
786 structures, which contain a
788 (see the section on control messages), an identifier, a length and optional
789 data. If a node does not recognize the cookie associated with an option,
790 it should ignore that option.
792 Meta data might include such things as priority, discard eligibility,
793 or special processing requirements. It might also mark a packet for
794 debug status, etc. The use of meta-data is still experimental.
798 code may either be statically compiled
799 into the kernel or else loaded dynamically as a KLD via
801 In the former case, include
805 in your kernel configuration file. You may also include selected
806 node types in the kernel compilation, for example:
807 .Bd -literal -offset indent
809 options NETGRAPH_SOCKET
810 options NETGRAPH_ECHO
815 subsystem is loaded, individual node types may be loaded at any time
820 knows how to automatically do this; when a request to create a new
825 will attempt to load the KLD module
828 Types can also be installed at boot time, as certain device drivers
829 may want to export each instance of the device as a netgraph node.
831 In general, new types can be installed at any time from within the
834 supplying a pointer to the type's
840 macro automates this process by using a linker set.
841 .Sh EXISTING NODE TYPES
842 Several node types currently exist. Each is fully documented
846 The socket type implements two new sockets in the new protocol domain
848 The new sockets protocols are
854 Typically one of each is associated with a socket node.
855 When both sockets have closed, the node will shut down. The
857 socket is used for sending and receiving data, while the
859 socket is used for sending and receiving control messages.
860 Data and control messages are passed using the
865 .Dv struct sockaddr_ng
869 Responds only to generic messages and is a
871 for data, Useful for testing. Always accepts new hooks.
874 Responds only to generic messages and always echoes data back through the
875 hook from which it arrived. Returns any non generic messages as their
876 own response. Useful for testing. Always accepts new hooks.
879 This node is useful for
887 Data entering from the right is passed to the left and duplicated on
889 and data entering from the left is passed to the right and
894 is sent to the right and data from
899 Encapsulates/de-encapsulates frames encoded according to RFC 1490.
900 Has a hook for the encapsulated packets
903 for each protocol (i.e., IP, PPP, etc.).
906 Encapsulates/de-encapsulates Frame Relay frames.
907 Has a hook for the encapsulated packets
913 Automatically handles frame relay
915 (link management interface) operations and packets.
916 Automatically probes and detects which of several LMI standards
917 is in use at the exchange.
920 This node is also a line discipline. It simply converts between mbuf
921 frames and sequential serial data, allowing a tty to appear as a netgraph
922 node. It has a programmable
927 This node encapsulates and de-encapsulates asynchronous frames
928 according to RFC 1662. This is used in conjunction with the TTY node
929 type for supporting PPP links over asynchronous serial lines.
932 This node is also a system networking interface. It has hooks representing
933 each protocol family (IP, AppleTalk, IPX, etc.) and appears in the output of
935 The interfaces are named
941 Whether a named node exists can be checked by trying to send a control message
944 If it does not exist,
948 All data messages are mbuf chains with the M_PKTHDR flag set.
950 Nodes are responsible for freeing what they allocate.
951 There are three exceptions:
954 Mbufs sent across a data link are never to be freed by the sender.
956 Any meta-data information traveling with the data has the same restriction.
957 It might be freed by any node the data passes through, and a
959 passed onwards, but the caller will never free it.
961 .Fn NG_FREE_META "meta"
963 .Fn NG_FREE_DATA "m" "meta"
964 should be used if possible to free data and meta data (see
969 are freed by the callee. As in the case above, the addresses
970 associated with the message are freed by whatever allocated them so the
971 recipient should copy them if it wants to keep that information.
974 .Bl -tag -width xxxxx -compact
975 .It Pa /sys/netgraph/netgraph.h
976 Definitions for use solely within the kernel by
979 .It Pa /sys/netgraph/ng_message.h
980 Definitions needed by any file that needs to deal with
983 .It Pa /sys/netgraph/ng_socket.h
984 Definitions needed to use
987 .It Pa /sys/netgraph/ng_{type}.h
988 Definitions needed to use
991 nodes, including the type cookie definition.
992 .It Pa /modules/netgraph.ko
993 Netgraph subsystem loadable KLD module.
994 .It Pa /modules/ng_{type}.ko
995 Loadable KLD module for node type {type}.
997 .Sh USER MODE SUPPORT
998 There is a library for supporting user-mode programs that wish
999 to interact with the netgraph system. See
1003 Two user-mode support programs,
1007 are available to assist manual configuration and debugging.
1009 There are a few useful techniques for debugging new node types.
1010 First, implementing new node types in user-mode first
1011 makes debugging easier.
1014 node type is also useful for debugging, especially in conjunction with
1026 .Xr ng_frame_relay 4 ,
1045 system was designed and first implemented at Whistle Communications, Inc.\&
1048 customized for the Whistle InterJet.
1049 It first made its debut in the main tree in
1053 .An Julian Elischer Aq julian@FreeBSD.org ,
1054 with contributions by
1055 .An Archie Cobbs Aq archie@FreeBSD.org .