summaryrefslogtreecommitdiff
path: root/usr/src/man/man7d/vnd.7d
diff options
context:
space:
mode:
authorRobert Mustacchi <rm@joyent.com>2014-03-19 23:42:17 +0000
committerRobert Mustacchi <rm@joyent.com>2014-03-20 00:18:37 +0000
commitad740f5f23aca9052a27984d4912ec9379c611bf (patch)
tree6d400a11a3ebd39f0461e968c22a7b7ddf136827 /usr/src/man/man7d/vnd.7d
parentfcf3046eb3c7c79a2695dc54a8bb82f42de4d25e (diff)
downloadillumos-joyent-ad740f5f23aca9052a27984d4912ec9379c611bf.tar.gz
OS-2800 Project Bardiche
OS-2784 want sdev plugin interface OS-2783 want generalized squeues OS-2785 ipf should be able to hook kvm nics OS-2782 want /dev/net/zone/%zonename/%datalink OS-610 snoop and libdlpi should be able to consume /dev/net/zone/%zonename OS-2786 .gitignore should include debug object directories OS-2781 dlpi promisc modes should be able to be RX-only OS-2780 Want dlpi primitive DL_EXCLUSIVE_REQ OS-2779 Makefile.man should take care of directory creation OS-2778 dls_promisc doesn't properly handle all transitions Reviewed by: Jerry Jelinek <jerry.jelinek@joyent.com>
Diffstat (limited to 'usr/src/man/man7d/vnd.7d')
-rw-r--r--usr/src/man/man7d/vnd.7d119
1 files changed, 119 insertions, 0 deletions
diff --git a/usr/src/man/man7d/vnd.7d b/usr/src/man/man7d/vnd.7d
new file mode 100644
index 0000000000..4cc0d8f9bf
--- /dev/null
+++ b/usr/src/man/man7d/vnd.7d
@@ -0,0 +1,119 @@
+'\" te
+.\"
+.\" This file and its contents are supplied under the terms of the
+.\" Common Development and Distribution License ("CDDL"), version 1.0.
+.\" You may only use this file in accordance with the terms of version
+.\" 1.0 of the CDDL.
+.\"
+.\" A full copy of the text of the CDDL should have accompanied this
+.\" source. A copy of the CDDL is also available via the Internet at
+.\" http://www.illumos.org/license/CDDL.
+.\"
+.\"
+.\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
+.\"
+.TH VND 7D "Feb 11, 2014"
+.SH NAME
+vnd \- virtual layer two network driver
+
+.SH SYNOPSIS
+.nf
+.LP
+/dev/vnd/ctl
+.nf
+.LP
+/dev/vnd/*
+
+.SH DESCRIPTION
+.sp
+.LP
+The vnd driver provides support for a layer two datapath in an
+analogous way that IP(7P) provides a support for an IP-based layer
+three datapath. Both devices operate exclusively on datalinks. A
+datalink that has been plumbed up with IP via ifconfig(1M) or
+ipadm(1M) cannot be used with vnd or vice-versa.
+.sp
+.LP
+The vnd driver supports and takes advantage of the the following
+illumos features:
+.RS
+.sp
+.LP
+Supports dld/dls feature negotation of GLDv3 features, such
+as direct calls, flow control, checksum offloading, and more.
+.sp
+.LP
+All IP and IPv6 based traffic is sent through ipfilter(5),
+allowing packet filtering.
+.sp
+.LP
+Better control over vectored reads and writes in a frame-centric manner
+through framed I/O. See libvnd(3LIB) for more information on these
+interfaces.
+.RE
+.sp
+.LP
+The vnd driver exposes two different kinds of device nodes. The first is
+a self-cloning control node which can be used to create vnd devices on
+top of datalinks. Those devices can optionally be bound into the file
+system namespace under /dev/vnd. Control operations on the control node
+or named devices are private to the implementation. Instead,
+libvnd(3LIB) provides a stable interfaces for using, creating, and
+manipulating vnd devices.
+.sp
+.LP
+.SH FILES
+.sp
+.n3 2
+.na
+/dev/vnd/ctl
+.ad
+.RS 16n
+vnd self-cloning control node
+.RE
+
+.sp
+.n3 2
+.na
+/dev/vnd/%link
+.ad
+.RS 16n
+Character device that corresponds to the vnd device of the given
+name (%link). A given device will appear for each actively linked device
+in the current zone.
+.RE
+
+.sp
+.n3 2
+.na
+/dev/vnd/zone/%zone/%link
+.ad
+.RS 16n
+These are character devices that correspond to the vnd device of
+the given name (%link). They are organized based on the zone that they
+appear in. Thus if a zone named foo has a vnd device named
+bar, then the global zone will have the file
+/dev/vnd/zone/foo/bar. Note, these only occur in the global zone.
+.RE
+
+.SH ATTRIBUTES
+.sp
+.LP
+See attributes(5) for descriptions of the following attributes:
+.sp
+
+.sp
+.TS
+box;
+c | c
+l | l .
+ATTRIBUTE TYPE ATTRIBUTE VALUE
+_
+Interface Stability Evolving
+.TE
+
+.SH SEE ALSO
+.sp
+.LP
+dladm(1M), ipflter(5), libvnd(3LIB), vndadm(1M),
+vndstat(1)