diff options
Diffstat (limited to 'usr/src/man')
112 files changed, 8691 insertions, 961 deletions
diff --git a/usr/src/man/Makefile b/usr/src/man/Makefile index 74d27fb221..f4fc11d776 100644 --- a/usr/src/man/Makefile +++ b/usr/src/man/Makefile @@ -84,6 +84,7 @@ SUBDIRS= man1 \ man3tsol \ man3uuid \ man3volmgt \ + man3vnd \ man3xcurses \ man3xnet \ man4 \ diff --git a/usr/src/man/man1/Makefile b/usr/src/man/man1/Makefile index ee62253939..25c5453c42 100644 --- a/usr/src/man/man1/Makefile +++ b/usr/src/man/man1/Makefile @@ -73,6 +73,7 @@ MANFILES= acctcom.1 \ clear.1 \ cmp.1 \ col.1 \ + column.1 \ comm.1 \ command.1 \ compress.1 \ @@ -85,6 +86,8 @@ MANFILES= acctcom.1 \ csh.1 \ csplit.1 \ ctags.1 \ + ctfdiff.1 \ + ctfdump.1 \ ctrun.1 \ ctstat.1 \ ctwatch.1 \ @@ -218,6 +221,7 @@ MANFILES= acctcom.1 \ m4.1 \ mac.1 \ mach.1 \ + machid.1 \ madv.so.1.1 \ mail.1 \ mailcompat.1 \ @@ -467,6 +471,9 @@ MANLINKS= batch.1 \ helpuid.1 \ helpyorn.1 \ hist.1 \ + i286.1 \ + i386.1 \ + i486.1 \ if.1 \ intro.1 \ jsh.1 \ @@ -477,8 +484,10 @@ MANLINKS= batch.1 \ notify.1 \ onintr.1 \ page.1 \ + pauxv.1 \ pcat.1 \ pcred.1 \ + penv.1 \ pfcsh.1 \ pfiles.1 \ pfksh.1 \ @@ -512,9 +521,11 @@ MANLINKS= batch.1 \ sh.1 \ snca.1 \ source.1 \ + sparc.1 \ spellin.1 \ stop.1 \ strconf.1 \ + sun.1 \ switch.1 \ ulimit.1 \ unalias.1 \ @@ -646,6 +657,12 @@ unlimit.1 := LINKSRC = limit.1 dumpkeys.1 := LINKSRC = loadkeys.1 +i286.1 := LINKSRC = machid.1 +i386.1 := LINKSRC = machid.1 +i486.1 := LINKSRC = machid.1 +sparc.1 := LINKSRC = machid.1 +sun.1 := LINKSRC = machid.1 + rmail.1 := LINKSRC = mail.1 page.1 := LINKSRC = more.1 @@ -655,6 +672,9 @@ snca.1 := LINKSRC = nca.1 pcat.1 := LINKSRC = pack.1 unpack.1 := LINKSRC = pack.1 +pauxv.1 := LINKSRC = pargs.1 +penv.1 := LINKSRC = pargs.1 + pfcsh.1 := LINKSRC = pfexec.1 pfksh.1 := LINKSRC = pfexec.1 pfsh.1 := LINKSRC = pfexec.1 @@ -700,7 +720,6 @@ hashcheck.1 := LINKSRC = spell.1 hashmake.1 := LINKSRC = spell.1 spellin.1 := LINKSRC = spell.1 - strconf.1 := LINKSRC = strchg.1 settime.1 := LINKSRC = touch.1 diff --git a/usr/src/man/man1/column.1 b/usr/src/man/man1/column.1 new file mode 100644 index 0000000000..a8c23310ba --- /dev/null +++ b/usr/src/man/man1/column.1 @@ -0,0 +1,129 @@ +.\" Copyright (c) 1989, 1990, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)column.1 8.1 (Berkeley) 6/6/93 +.\" $FreeBSD$ +.\" +.\" Portions Copyright (c) 2013 Joyent, Inc. All rights reserved. +.\" +.TH COLUMN 1 "Jan 10, 2013" +.SH NAME +column \- columnate lists +.SH SYNOPSIS +.LP +.nf +\fBcolumn\fR [\fB-tx\fR] [\fB-c\fR \fIcolumns\fR] [\fB-s\fR \fIsep\fR] [\fIfile\fR ... ] +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBcolumn\fR +utility formats its input into multiple columns. +Rows are filled before columns. +Input is taken from +\fIfile\fR +operands, or, by default, from the standard input. +Empty lines are ignored. +.SH OPTIONS +.sp +.LP +The options are as follows: +.sp +.ne 2 +.na +\fB\fB-c\fR \fIcolumns\fR\fR +.ad +.RS 17n +Output is formatted for a display \fIcolumns\fR +wide. +.RE + +.sp +.ne 2 +.na +\fB\fB-s\fR \fIsep\fR\fR +.ad +.RS 17n +Specify a set of characters to be used to delimit columns for the +\fB-t\fR option. +.RE + +.sp +.ne 2 +.na +\fB\fB-t\fR\fR +.ad +.RS 17n +Determine the number of columns the input contains and create a table. +Columns are delimited with whitespace, by default, or with the characters +supplied using the \fBs\fR +option. +Useful for pretty-printing displays. +.RE + +.sp +.ne 2 +.na +\fB-x\fR +.ad +.RS 17n +Fill columns before filling rows. +.RE + +.SH ENVIRONMENT +The COLUMNS , LANG , LC_ALL +and +LC_CTYPE +environment variables affect the execution of +\fBcolumn\fR +as described in +\fBenviron\fR(5). + +.SH EXIT STATUS +The \fBcolumn\fR utility exits 0 on success and >0 if an error occurs. + +.SH EXAMPLES +.sp +.in +2 +.nf +(printf \&"PERM LINKS OWNER GROUP SIZE MONTH DAY \&"\ \&;\ \&\e +printf \&"HH:MM/YEAR NAME\en\&"\ \&;\ \&\e +ls -l \&| sed 1d) \&| column -t +.fi +.in -2 +.sp + + +.SH SEE ALSO +\fBls\fR(1), \fBpaste\fR(1), \fBsort\fR(1) + +.SH HISTORY +The \fBcolumn\fR command appeared in 4.3BSD-Reno. + +.SH BUGS +Input lines are limited to LINE_MAX bytes in length. diff --git a/usr/src/man/man1/crontab.1 b/usr/src/man/man1/crontab.1 index c93255f406..1008b63a21 100644 --- a/usr/src/man/man1/crontab.1 +++ b/usr/src/man/man1/crontab.1 @@ -1,6 +1,7 @@ '\" te .\" Copyright 1989 AT&T .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2011, Joyent, Inc. All Rights Reserved .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at http://www.opengroup.org/bookstore/. .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text @@ -10,7 +11,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH CRONTAB 1 "Apr 6, 2009" +.TH CRONTAB 1 "Sep 23, 2013" .SH NAME crontab \- user crontab file .SH SYNOPSIS @@ -26,7 +27,7 @@ crontab \- user crontab file .LP .nf -\fB/usr/bin/crontab\fR \fB-l\fR [\fIusername\fR] +\fB/usr/bin/crontab\fR \fB-l\fR [\fB-g\fR] [\fIusername\fR] .fi .LP @@ -46,7 +47,7 @@ crontab \- user crontab file .LP .nf -\fB/usr/xpg4/bin/crontab\fR \fB-l\fR [\fIusername\fR] +\fB/usr/xpg4/bin/crontab\fR \fB-l\fR [\fB-g\fR] [\fIusername\fR] .fi .LP @@ -66,7 +67,7 @@ crontab \- user crontab file .LP .nf -\fB/usr/xpg6/bin/crontab\fR \fB-l\fR [\fIusername\fR] +\fB/usr/xpg6/bin/crontab\fR \fB-l\fR [\fB-g\fR] [\fIusername\fR] .fi .LP @@ -86,6 +87,17 @@ users' crontabs. .LP If \fBcrontab\fR is invoked with \fIfilename\fR, this overwrites an existing \fBcrontab\fR entry for the user that invokes it. +.sp +.LP +Cron supports a merged crontab with entries coming from either the user's +\fB/var/spool/cron/crontabs\fR file or from the user's +\fB/etc/cron.d/crontabs\fR file. The entries in the user's +\fB/var/spool/cron/crontabs\fR file are editable whereas those in +\fB/etc/cron.d/crontabs\fR are system-defined entries which may not +be customized by the user. The dual set of crontab entries is only +of interest to system-defined users such as \fBroot\fR. Except where +otherwise explicitly indicated, all variants of the \fBcrontab\fR command +act only on the editable crontab files found in \fB/var/spool/cron/crontabs\fR. .SS "\fBcrontab\fR Access Control" .sp .LP @@ -343,6 +355,9 @@ file using the \fB-r\fR option. If \fIusername\fR is specified, the specified user's \fBcrontab\fR file is edited, rather than the current user's \fBcrontab\fR file. This can only be done by root or by a user with the \fBsolaris.jobs.admin\fR authorization. +.sp +Only the entries in the user's \fB/var/spool/cron/crontabs\fR file are +editable. .RE .sp @@ -354,6 +369,22 @@ done by root or by a user with the \fBsolaris.jobs.admin\fR authorization. Lists the \fBcrontab\fR file for the invoking user. Only root or a user with the \fBsolaris.jobs.admin\fR authorization can specify a username following the \fB-l\fR option to list the \fBcrontab\fR file of the specified user. +.sp +Entries from the user's \fB/var/spool/cron/crontabs\fR file are listed, unless +the \fB-g\fR option is given, in which case only entries from the user's +\fB/etc/cron.d/crontabs\fR file are listed. +.RE + +.sp +.ne 2 +.na +\fB\fB-g\fR\fR +.ad +.RS 6n +In conjunction with the \fB-l\fR option, lists the global \fBcrontab\fR file +for the invoking or specified user (if authorized) instead of the editable +\fBcrontab\fR file. This option is not valid unless the \fB-l\fR option is +also given. .RE .sp @@ -583,6 +614,15 @@ list of denied users .sp .ne 2 .na +\fB\fB/etc/cron.d/crontabs\fR\fR +.ad +.RS 28n +system spool area for \fBcrontab\fR +.RE + +.sp +.ne 2 +.na \fB\fB/var/cron/log\fR\fR .ad .RS 28n diff --git a/usr/src/man/man1/ctfdiff.1 b/usr/src/man/man1/ctfdiff.1 new file mode 100644 index 0000000000..1934c64c52 --- /dev/null +++ b/usr/src/man/man1/ctfdiff.1 @@ -0,0 +1,337 @@ +.\" +.\" 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) 2015, Joyent, Inc. +.\" +.Dd Oct 4, 2014 +.Dt CTFDIFF 1 +.Os +.Sh NAME +.Nm ctfdiff +.Nd compare two CTF containers +.Sh SYNOPSIS +.Nm ctfdiff +.Op Fl afIloqt +.Op Fl F Ar function +.Op Fl O Ar object +.Op Fl p Ar parent1 +.Op Fl p Ar parent2 +.Op Fl T Ar type +.Ar file1 file2 +.Sh DESCRIPTION +The +.Nm +utility identifies differences between the contents of the +.Sy CTF +containers found in +.Em file1 +and +.Em file2 . +.Lp +.Nm +can find differences between two +.Sy CTF +container's +.Sy labels , +.Sy functions , +.Sy objects , +and +.Sy types . +When no options are specified, +.Nm +will only consider +.Sy functions , +.Sy objects, +and +.Sy types . +.Lp +Two +.Sy labels +are considered the same, if they have the same name. Two +.Sy objects +are considered the same if they have the same name and the type of the +object is the same. Two +.Sy functions +are considered the same if they have the same, the same return type, the +same number of arguments, and the types of their arguments are the same. +.Lp +Two +.Sy types +are considered the same if they have the same, they represent the same +kind of thing, and the contents of the type are the same. This varies +for each specific kind, for example, two structs are the same if they +have the same members whose types, offsets, and names are all the same. +For more information on the specifics for what we look at for each kind +of type, and the kinds themselves, see the information we use to encode +them in +.Xr ctf 4 . If the option +.Fl I +is specified, then the names of basic integer types are ignored. For an +example of where this makes sense, see +.Sy Example 4 . +.Lp +If the +.Sy CTF +container found inside of either +.Em file1 +or +.Em file2 +has been uniquified (see +.Xr ctf 4 +for more on uniquification), then the parent +.Sy CTF +container is also required for the diff to complete. +.Sh OPTIONS +The following options are supported: +.Bl -hang -width Ds +.It Fl a +.Bd -filled -compact +Diff +.Sy labels , +.Sy types , +.Sy objects , +and +.Sy functions . +.Ed +.It Fl f +.Bd -filled -compact +Diff +.Sy function +type argument information. +.Ed +.It Fl F Ar function +.Bd -filled -compact +When diffing +.Sy functions , +only consider the function +.Em function . +This option requires that the option +.Fl -f +be specified and can be repeated multiple times. +.Ed +.It Fl I +.Bd -filled -compact +Ignore the names of integral types. This option is useful when comparing +types between two +.Sy CTF +containers that have different programming models. In this case, when +comparing integers, the name of the type is not considered. This means +that the ILP32 type long which is a 32-bit wide signed integer is the +same as the LP64 type int which is a 32-bit wide signed integer, even +though they have different names. +.Ed +.It Fl l +.Bd -filled -compact +Diff the +.Sy labels +contained inside the +.Sy CTF +containers. +.Ed +.It Fl o +.Bd -filled -compact +Diff type information for +.Sy objects . +.Ed +.It Fl O Ar object +.Bd -filled -compact +When diffing type information for +.Sy objects , +only compare if the object is name +.Em object . This option requires +.Fl o +to be specified and can be repeated multiple times. +.Ed +.It Fl p Ar parent1 +.Bd -filled -compact +Specifies the path of file that is the parent of the +.Sy CTF +container inside of +.Em file1 +is +.Em parent1 . +This option is required if +.Em file1 +has been uniquified. For more information on uniquification, see +.Xr ctf 4 . +.Ed +.It Fl P Ar parent2 +.Bd -filled -compact +Specifies the path of file that is the parent of the +.Sy CTF +container inside of +.Em file2 is +.Em parent2 . +This option is required if +.Em file1 +has been uniquified. For more information on uniquification, see +.Xr ctf 4 . +.Ed +.It Fl q +.Bd -filled -compact +Enables quiet mode. Standard output from the diff will not be emitted. +However, diagnostics messages will still be emitted to standard error. +.Ed +.It Fl t +.Bd -filled -compact +Diff the +.Sy type +information sections in the +.Sy CTF +containers. +.Ed +.It Fl T Ar type +.Bd -filled -compact +When diffing the +.Sy types +section, only consider it if the type is name +.Em type . +Types specified here do not impact the diffing of +.Sy objects +or +.Sy functions . +Even with +.Fl -T +specified, other types will be diffed as necessary for the evaluation of +the named types; however, the results of those intermediate differences +will not impact the results of +.Nm , +only named types are considered when evaluating the exit status of +.Nm . +.Ed +.El +.Sh EXIT STATUS +.Bl -inset +.It Sy 0 +.Bd -filled -offset indent -compact +Execution completed successfully, no differences were detected +between +.Em file1 +and +.Em file2 . +.Ed +.It Sy 1 +.Bd -filled -offset indent -compact +Execution completed successfully, but differences were detected +between +.Em file1 +and +.Em file2 . +.Ed +.It Sy 2 +.D1 Invalid command line options were specified. +.It Sy 3 +.D1 A fatal error occured. +.El +.Sh EXAMPLES +.Sy Example 1 +Diffing Two +.Sy CTF +Containers +.Lp +The following example compares two +.Sy CTF +containers using the default set +of comparisons: +.Sy objects , +.Sy functions , +and +.Sy types . +.Bd -literal -offset 6n +$ ctfdiff /usr/lib/libc.so.1 /usr/lib/libdtrace.so.1 +ctf container /usr/lib/libc.so.1 type 37 is different +ctf container /usr/lib/libc.so.1 type 38 is different +ctf container /usr/lib/libc.so.1 type 39 is different +ctf container /usr/lib/libc.so.1 type 40 is different +ctf container /usr/lib/libc.so.1 type 41 is different +ctf container /usr/lib/libc.so.1 type 42 is different +ctf container /usr/lib/libc.so.1 type 43 is different +ctf container /usr/lib/libc.so.1 type 47 is different +ctf container /usr/lib/libc.so.1 type 48 is different +ctf container /usr/lib/libc.so.1 type 49 is different +\&... +.Ed +.Sy Example 2 +Diffing Types Between Two +.Sy CTF +Containers with Parents +.Lp +The following example compares two +.Sy CTF +containers +.Sy /ws/rm/zlan/proto/kernel/drv/amd64/vnd +and +.Sy /ws/rm/zlan/proto/kernel/drv/amd64/overlay +that have been uniquified against the same container +.Sy /ws/rm/zlan/proto/kernel/amd64/genunix . +.Bd -literal -offset 6n +$ ctfdiff -t -p /ws/rm/zlan/proto/kernel/amd64/genunix \\ + -P /ws/rm/zlan/proto/kernel/amd64/genunix \\ + /ws/rm/zlan/proto/kernel/drv/amd64/vnd \\ + /ws/rm/zlan/proto/kernel/drv/amd64/overlay +ctf container /ws/rm/zlan/proto/kernel/drv/amd64/vnd type 32769 is different +ctf container /ws/rm/zlan/proto/kernel/drv/amd64/vnd type 32770 is different +ctf container /ws/rm/zlan/proto/kernel/drv/amd64/vnd type 32771 is different +ctf container /ws/rm/zlan/proto/kernel/drv/amd64/vnd type 32772 is different +ctf container /ws/rm/zlan/proto/kernel/drv/amd64/vnd type 32774 is different +ctf container /ws/rm/zlan/proto/kernel/drv/amd64/vnd type 32775 is different +ctf container /ws/rm/zlan/proto/kernel/drv/amd64/vnd type 32776 is different +ctf container /ws/rm/zlan/proto/kernel/drv/amd64/vnd type 32777 is different +ctf container /ws/rm/zlan/proto/kernel/drv/amd64/vnd type 32778 is different +ctf container /ws/rm/zlan/proto/kernel/drv/amd64/vnd type 32779 is different +\&... +.Ed +.Lp +.Sy Example 3 +Diffing a Specific Function in Two +.Sy CTF +Containers +.Lp +This example shows us looking for differences in the function +.Sy libzfs_core_init +in two different version of the library +.Sy libzfs_core.so.1 . +.Bd -literal -offset 6n +$ ctfdiff -f -F libzfs_core_init /usr/lib/libzfs_core.so.1 \\ + /ws/rm/ctf/proto/usr/lib/libzfs_core.so.1 +$ echo $? +.Ed +.Lp +.Sy Example 4 +Diffing Types to Find Differences Between Different Data Models. +.Lp +This example looks for differences between structures used in an ioctl +that the kernel wants to be bitness neutral by comparing a 32-bit and +64-bit library that consumes it. In this example, we'll use the library +.Sy libvnd.so.1 +and the types +.Sy vnd_ioc_attach_t , +.Sy vnd_ioc_link_t , +.Sy vnd_ioc_unlink_t , +.Sy vnd_ioc_buf_t , +and +.Sy vnd_ioc_info_t . +.Bd -literal -offset 6n +$ ctfdiff -t -I -T vnd_ioc_attach_t -T vnd_ioc_link_t \\ + -T vnd_ioc_unlink_t -T vnd_ioc_buf_t -T vnd_ioc_info_t \\ + i386/libvnd.so.1 amd64/libvnd.so.1 +$ echo $? +0 +.Ed +.Sh INTERFACE STABILITY +The command syntax is +.Sy Committed . +The output format is +.Sy Uncommitted . +.Sh SEE ALSO +.Xr ctfdump 1 , +.Xr diff 1 , +.Xr ctf 4 diff --git a/usr/src/man/man1/ctfdump.1 b/usr/src/man/man1/ctfdump.1 new file mode 100644 index 0000000000..a8c2d978ae --- /dev/null +++ b/usr/src/man/man1/ctfdump.1 @@ -0,0 +1,393 @@ +.\" +.\" 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) 2015, Joyent, Inc. +.\" +.Dd Oct 4, 2014 +.Dt CTFDUMP 1 +.Os +.Sh NAME +.Nm ctfdump +.Nd dump parts of ctf data from files +.Sh SYNOPSIS +.Nm ctfdump +.Op Fl dfhlsSt +.Op Fl p Ar parent +.Op Fl u Ar outfile +.Ar file +.Sh DESCRIPTION +The +.Nm +utility dumps and decodes the +.Sy CTF +data contained inside of +.Sy ELF +objects and raw +.Sy CTF +files. +.Lp +.Nm +can dump information about the +.Sy CTF header , +the +.Sy labels +encoded in the +.Sy CTF +container, +the types of +.Sy data objects , +the internal +.Sy string +table, +the types of the return function and the arguments for +.Sy functions , +and of course, it displays information about the +.Sy types +defined in the +.Sy CTF +container. +.Lp +.Nm +can also be used to dump out the raw +.Sy CTF +data and send it to another file. When writing out data, it always +ensures that the +.Sy CTF +data is decompressed. In this form, the +.Sy CTF +data can be inspected using +.Nm +and other tools such as +.Xr mdb 1 . +.Lp +When no options are specified, +.Nm +displays all information. However, when the +.Fl u +option is used, then no information is displayed by default, unless +requested through the the appropriate option. +.Sh OPTIONS +The following options are supported: +.Bl -hang -width Ds +.It Fl d +.Bd -filled -compact +Dump the types of symbols that correspond to objects. +.Ed +.It Fl f +.Bd -filled -compact +Dump the types of the return values and arguments of the functions. +.Ed +.It Fl h +.Bd -filled -compact +Dump the +.Sy CTF +header +.Ed +.It Fl l +.Bd -filled -compact +Dump all +.Sy CTF +labels associated with the file. +.Ed +.It Fl p Ar parent +.Bd -filled -compact +Use the type information in +.Em parent +to supplement output. This is useful when a +.Nm CTF +container has been +.Sy uniquified +against +.Em parent . +This allows +.Nm +to use the names of types when used with +.Fl t . +.Ed +.It Fl s +.Bd -filled -compact +Dump the internal +.Sy CTF +string table +.Ed +.It Fl S +.Bd -filled -compact +Displays statistics about the +.Sy CTF +container. +.Ed +.It Fl t +.Bd -filled -compact +Dump the type information contained in the +.Sy CTF +conatiner. +.Ed +.It Fl u Ar outfile +.Bd -filled -compact +Copies the uncompressed +.Sy CTF +data to the file specified by +.Em outfile . +This can be used to make it easier to inspect the raw +.Sy CTF +data. +.Ed +.El +.Sh OUTPUT +When the +.Nm +utility is executed with its default options, it prints out a textual +representation of the +.Sy CTF +information. Note, the output format of +.Nm +is subject to change at any time and should not be relied upon as a +stable format to be used for parsing. +.Ss CTF Header +This section describes the values in the +.Sy CTF +header. Each line in the section describes the value of one of the +members of the header. For more information on the meaning and +interpretation of these members, see +.Xr ctf 4 . +.Ss Label Table +This section describes information about the labels present in the +.Sy CTF +information. Each entry in this section, if present, starts with a +number and is followed by a string. An example entry in the label +section might look like: +.Bd -literal +\&... + 2270 joyent_20151001T070028Z +\&... +.Ed +.Pp +The number, +.Em 2270 , +represents the last type that the label applies to. The string, +.Em joyent_20151001T070028Z , +is the name of the label. In this case, if there were no other labels, +it would indicate that the label applied to all types up to, and +including, the type number 2270. For more information +on how labels are used with +.Sy CTF +information, see the section +.Em The Label Section +in +.Xr ctf 4 . +.Ss Data Objects +This section describes the type information relating to data objects +from the symbol table. An entry for a data object consists of four +columns. The first column is just a monotonic ID. The second number is +the type id of the object. The third column is the name of the symbol +and the fourth column is the corresponding index from the symbol table. +.Pp +Take for example, the following couple of entries: +.Bd -literal +\&... + [0] 13 hz (48) + [1] 78 _nd (49) + [2] 1656 __pfmt_label (56) + [3] 926 _aio_hash (68) + [4] 13 _lio_free (70) + [5] 1321 u8_number_of_bytes (73) +\&... +.Ed +.Pp +Let's take the first entry in the list above. The symbol is named +.Sy hz . +It is the first data object, as indicated by the number zero in +brackets. It has a type id of 13 and in this case, it has a symbol table +index of 48. +.Ss Functions +This section describes the type information for functions. For each +function present in the symbol table with type information, the +function's entry into the function section, the function's name, the +function's symbol table index, the function's return type, and the types +of the function's arguments are printed. If a function is a variadic +function, then the variadic argument is printed as the string +.Sy '...' . +.Pp +Take for example, the following couple of entries: +.Bd -literal +\&... + [687] pfprint_stack (3110) returns: 11 args: (385, 115, 29, 1704, 223, 116, 2) + [688] pfprint_stddev (3111) returns: 11 args: (385, 115, 29, 1704, 223, 116, 2) + [689] pfprint_quantize (3112) returns: 11 args: (385, 115, 29, 1704, 223, 116, 2) + [690] pfprint_lquantize (3113) returns: 11 args: (385, 115, 29, 1704, 223, 116, 2) + [691] pfprint_llquantize (3114) returns: 11 args: (385, 115, 29, 1704, 223, 116, 2) +\&... +.Ed +.Pp +The first column is the function's entry number in the function type +information section. It is enclosed in brackets. The next column is the +function's name and it is followed in parenthesis by the its index in the +symbol table. The following portions of this entry describe the return +type and then all of the arguments, in positional order. +.Ss Types +The types section gives information about each type in the +.Sy CTF +container. Each entry begins with its type identifier. The type +identifier may either be in square brackets or in angle brackets. If the +type identifier is enclosed in angle brackets, then that represents that +it is a root type or top-level type. If it is square brackets, then it +is not. For more information on root types, see +.Xr ctf 4 . +.Pp +Next, the type will have its name and kind. If it is an array, it will +be followed with a subscript that describes the number of entries in the +array. If it is a pointer, it will followed by the +.Sy * +symbol to indicate that it is a pointer. If the type has the +.Sy const , +.Sy volatile , +.Sy typedef , +or +.Sy restrict +keyword applied to it, that will precede the name. All of these +reference types, including pointer, will then be followed with an +example of the type that they refer to. +.Pp +Types which are an integral or floating point value will be followed by +information about their encoding and the number of bits represented in +the type. +.Pp +Arrays will be followed by two different entries, the contents and +index. The contents member contains the type id of the array's contents +and the index member describes a type which can represent the array's +index. +.Pp +Structures and unions will be preceded with the corresponding C keyword, +.Sy struct +or +.Sy union . +After that, the size in bytes of the structure will be indicated. ON +each subsequent line, a single member will be listed. That line will +contain the member's name, it's type identifier, and the offset into the +structure that it can be found in, in bits. +.Pp +The following show examples of type information for all of these +different types: +.Bd -literal +\&... + [5] char [12] contents: 1, index: 2 + [6] short encoding=SIGNED offset=0 bits=16 + <7> struct exit_status (4 bytes) + e_termination type=6 off=0 + e_exit type=6 off=16 + + <8> typedef time_t refers to 2 + <9> struct utmp (36 bytes) + ut_user type=3 off=0 + ut_id type=4 off=64 + ut_line type=5 off=96 + ut_pid type=6 off=192 + ut_type type=6 off=208 + ut_exit type=7 off=224 + ut_time type=8 off=256 + + <10> struct utmp * refers to 9 + [11] const struct utmp refers to 9 + [12] const struct utmp * refers to 11 + <13> int encoding=SIGNED offset=0 bits=32 + <14> typedef int32_t refers to 13 +\&... +.Ed +.Ss String Table +This section describes all of the strings that are present in the +.Sy CTF +container. Each line represents an entry in the string table. First the +byte offset into the string table is shown in brackets and then the +string's value is displayed. Note the following examples: +.Bd -literal + [0] \0 + [1] joyent_20151001T070028Z + [25] char + [30] long + [35] short +.Ed +.Ss Statistics +This section contains miscellaneous statistics about the +.Sy CTF +data present. Each line contains a single statistic. A brief explanation +of the statistic is placed first, followed by an equals sign, and then +finally the value. +.Sh EXIT STATUS +.Bl -inset +.It Sy 0 +.Dl Execution completed successfully. +.It Sy 1 +.Dl A fatal error occured. +.It Sy 2 +.Dl Invalid command line options were specified. +.El +.Sh EXAMPLES +.Sy Example 1 +Displaying the Type Section of a Single File +.Lp +The following example dumps the type section of the file +.Sy /usr/lib/libc.so.1 . +.Bd -literal -offset 6n +$ ctfdump -t /usr/lib/libc.so.1 +- Types ---------------------------------------------------- + + <1> int encoding=SIGNED offset=0 bits=32 + <2> long encoding=SIGNED offset=0 bits=32 + <3> typedef pid_t refers to 2 + <4> unsigned int encoding=0x0 offset=0 bits=32 + <5> typedef uid_t refers to 4 + <6> typedef gid_t refers to 5 + <7> typedef uintptr_t refers to 4 +\&... +.Ed +.Lp +.Sy Example 2 +Dumping the CTF data to Another File +.Lp +The following example dumps the entire CTF data from the file +.Sy /usr/lib/libc.so.1 +and places it into the file +.Sy ctf.out . +This then shows how you can use the +.Xr mdb 1 +to inspect its contents. +.Bd -literal -offset 6n +$ ctfdump -u ctf.out /usr/lib/libc.so.1 +$ mdb ./ctf.out +> ::typedef -r /usr/lib/libctf.so.1 +> 0::print ctf_header_t +{ + cth_preamble = { + ctp_magic = 0xcff1 + ctp_version = 0x2 + ctp_flags = 0 + } + cth_parlabel = 0 + cth_parname = 0 + cth_lbloff = 0 + cth_objtoff = 0x8 + cth_funcoff = 0x5e0 + cth_typeoff = 0x7178 + cth_stroff = 0x12964 + cth_strlen = 0x7c9c +} +.Ed +.Sh INTERFACE STABILITY +The command syntax is +.Sy Committed . +The output format is +.Sy Uncommitted . +.Sh SEE ALSO +.Xr ctfdiff 1 , +.Xr dump 1 , +.Xr elfdump 1 , +.Xr mdb 1 , +.Xr ctf 4 diff --git a/usr/src/man/man1/hostname.1 b/usr/src/man/man1/hostname.1 index 5b63dab64a..75a24a0437 100644 --- a/usr/src/man/man1/hostname.1 +++ b/usr/src/man/man1/hostname.1 @@ -1,8 +1,9 @@ .\" Copyright (c) 1992, Sun Microsystems, Inc. +.\" Copyright 2016 Joyent, Inc. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.Dd May 12, 2016 +.Dd Aug 26, 2016 .Dt HOSTNAME 1 .Os .Sh NAME @@ -19,6 +20,17 @@ command prints the name of the current host, as given before the .Xr login 1 prompt. The super-user can set the hostname by giving .Ar name-of-host . +.Pp +While setting the hostname changes the hostname for the running system, +it does not persist the change. The proper way to update the hostname +will vary depending on how the system is configured. For most systems, +the persistent hostname is stored in the file +.Pa /etc/nodename . +See +.Xr nodename 4 +for more information on how to update it. Note, the +.Pa /etc/nodename +file may be ignored in cases where the system is configured to use DHCP. .Sh OPTIONS .Bl -tag -width Ds .It Fl s @@ -26,4 +38,5 @@ Prints only the part of the hostname preceding the first dot. .El .Sh SEE ALSO .Xr uname 1 , +.Xr nodename 4 , .Xr attributes 5 diff --git a/usr/src/man/man1/ld.1 b/usr/src/man/man1/ld.1 index 7fc0277160..1b0b0a5566 100644 --- a/usr/src/man/man1/ld.1 +++ b/usr/src/man/man1/ld.1 @@ -24,7 +24,7 @@ ld \- link-editor for object files [\fB-z\fR combreloc | nocombreloc ] [\fB-z\fR defs | nodefs] [\fB-z\fR direct | nodirect] [\fB-z\fR endfiltee] [\fB-z\fR fatal-warnings | nofatal-warnings ] [\fB-z\fR finiarray=\fIfunction\fR] -[\fB-z\fR globalaudit] [\fB-z\fR groupperm | nogroupperm] +[\fB-z\fR globalaudit] [\fB-z\fR groupperm | nogroupperm] [\fB-z\fR guidance[=\fIid1\fR,\fIid2\fR...] [\fB-z\fR help ] [\fB-z\fR ignore | record] [\fB-z\fR initarray=\fIfunction\fR] [\fB-z\fR initfirst] [\fB-z\fR interpose] [\fB-z\fR lazyload | nolazyload] diff --git a/usr/src/man/man1/ld.so.1.1 b/usr/src/man/man1/ld.so.1.1 index 4b14ca4f1a..19afbbf3d6 100644 --- a/usr/src/man/man1/ld.so.1.1 +++ b/usr/src/man/man1/ld.so.1.1 @@ -1,9 +1,10 @@ '\" .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2014, Joyent, Inc. All Rights Reserved .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH LD.SO.1 1 "Oct 5, 2012" +.TH LD.SO.1 1 "May 8, 2014" .SH NAME ld.so.1 \- runtime linker for dynamic objects .SH SYNOPSIS @@ -574,6 +575,24 @@ aid debugging. See also the \fBRTLD_DI_SETSIGNAL\fR request to .RE .sp +.ne 2 +.na +.BR LD_TOXIC_PATH, +.BR LD_TOXIC_PATH_32, +.BR LD_TOXIC_PATH_64, +.ad +.sp .6 +.RS 4n +The toxic path refers to a set of paths where by, if +.B ld.so.1 +were to load a dependency on that path, rather than loading it, it +should kill the process. This is useful when having built libraries that +while matching the native architecture of the system, are not suitable +to be used, for example, libraries that that correspond to an alternate +release of an operating system. +.RE + +.sp .LP Notice that environment variable names beginning with the characters '\fBLD_\fR' are reserved for possible future enhancements to \fBld\fR(1) and diff --git a/usr/src/man/man1/machid.1 b/usr/src/man/man1/machid.1 new file mode 100644 index 0000000000..cb95fa36b6 --- /dev/null +++ b/usr/src/man/man1/machid.1 @@ -0,0 +1,25 @@ +'\" te +.\" Copyright 1989 AT&T +.\" Copyright (c) 1999, Sun Microsystems, Inc. +.\" All Rights Reserved +.\" Copyright 2015, Joyent, Inc. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH MACHID 1 "Feb 27, 2015" +.SH NAME +machid, sun, i286, i386, i486, sparc \- get processor type truth value + +.SH DESCRIPTION +.sp +.LP +These commands are obsolete and may be removed in a future version of the +software. +.sp +.ne 2 +.na +.SH NOTES +.sp +.LP +The \fBmachid\fR family of commands is obsolete. Use \fBuname\fR \fB-p\fR and +\fBuname\fR \fB-m\fR instead. diff --git a/usr/src/man/man1/nawk.1 b/usr/src/man/man1/nawk.1 index 425db5d299..2c27e1baa0 100644 --- a/usr/src/man/man1/nawk.1 +++ b/usr/src/man/man1/nawk.1 @@ -15,6 +15,12 @@ nawk \- pattern scanning and processing language .SH SYNOPSIS .LP .nf +\fB/usr/bin/awk\fR [\fB-F\fR \fIERE\fR] [\fB-v\fR \fIassignment\fR] \fI\&'program'\fR | \fB-f\fR \fIprogfile\fR... + [\fIargument\fR]... +.fi + +.LP +.nf \fB/usr/bin/nawk\fR [\fB-F\fR \fIERE\fR] [\fB-v\fR \fIassignment\fR] \fI\&'program'\fR | \fB-f\fR \fIprogfile\fR... [\fIargument\fR]... .fi @@ -28,7 +34,8 @@ nawk \- pattern scanning and processing language .SH DESCRIPTION .sp .LP -The \fB/usr/bin/nawk\fR and \fB/usr/xpg4/bin/awk\fR utilities execute +The \fB/usr/bin/awk\fR, \fB/usr/bin/nawk\fR and \fB/usr/xpg4/bin/awk\fR +utilities execute \fIprogram\fRs written in the \fBnawk\fR programming language, which is specialized for textual data manipulation. A \fBnawk\fR \fIprogram\fR is a sequence of patterns and corresponding actions. The string specifying diff --git a/usr/src/man/man1/pargs.1 b/usr/src/man/man1/pargs.1 index 3f8e2bae8c..58b7bfc7f9 100644 --- a/usr/src/man/man1/pargs.1 +++ b/usr/src/man/man1/pargs.1 @@ -1,20 +1,22 @@ '\" te .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 2015 Joyent, Inc. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH PARGS 1 "Jun 19, 2006" +.TH PARGS 1 "Oct 5, 2015" .SH NAME -pargs \- print process arguments, environment variables, or auxiliary +pargs, penv, pauxv \- print process arguments, environment variables, or auxiliary vector .SH SYNOPSIS .LP .nf \fBpargs\fR [\fB-aceFlx\fR] [\fIpid\fR | \fIcore\fR]... +\fBpauxv\fR [\fB-cF\fR] [\fIpid\fR | \fIcore\fR]... +\fBpenv\fR [\fB-cF\fR] [\fIpid\fR | \fIcore\fR]... .fi .SH DESCRIPTION -.sp .LP The \fBpargs\fR utility examines a target process or process core file and prints arguments, environment variables and values, or the process auxiliary @@ -32,10 +34,18 @@ the target process and the \fBpargs\fR process do not share a common character encoding, \fBpargs\fR attempts to employ the \fBiconv\fR(3C) facility to generate a printable version of the extracted strings. In the event that such a conversion is impossible, strings are displayed as 7-bit \fBASCII\fR. -.SH OPTIONS .sp .LP -The following options are supported: +The \fBpauxv\fR command is equivalent to running \fBpargs\fR with the +\fB-x\fR option. +.sp +.LP +The \fBpenv\fR command is equivalent to running \fBpargs\fR with the +\fB-e\fR option. +.SH OPTIONS +.LP +The following options are supported by \fBpargs\fR. Only the \fB-c\fR +and \fB-F\fR options are supported by \fBpauxv\fR and \fBpenv\fR: .sp .ne 2 .na @@ -98,7 +108,6 @@ Prints process auxiliary vector. .RE .SH OPERANDS -.sp .LP The following operands are supported: .sp @@ -120,7 +129,6 @@ Process core file. .RE .SH USAGE -.sp .LP Caution should be exercised when using the \fB-F\fR flag. Imposing two controlling processes on one victim process can lead to chaos. Safety is @@ -128,7 +136,6 @@ assured only if the primary controlling process, typically a debugger, has stopped the victim process and the primary controlling process is doing nothing at the moment of application of the \fBproc\fR tool in question. .SH EXIT STATUS -.sp .LP The following exit values are returned: .sp @@ -151,7 +158,6 @@ option). .RE .SH FILES -.sp .ne 2 .na \fB\fB/proc/pid/*\fR\fR @@ -161,7 +167,6 @@ Process information and control files. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -177,7 +182,6 @@ Interface Stability Evolving .TE .SH SEE ALSO -.sp .LP \fBproc\fR(1), \fBiconv\fR(3C), \fBproc\fR(4), \fBascii\fR(5), \fBattributes\fR(5), \fBenviron\fR(5), \fBformats\fR(5) diff --git a/usr/src/man/man1/pfexec.1 b/usr/src/man/man1/pfexec.1 index 66e5e08420..5d5c9048ed 100644 --- a/usr/src/man/man1/pfexec.1 +++ b/usr/src/man/man1/pfexec.1 @@ -58,6 +58,12 @@ For \fBpfexec\fR to function correctly, the \fBpfexecd\fR daemon must be running in the current zone. This is normally managed by the "\fBsvc:/system/pfexec:default\fR" SMF service (see \fBsmf\fR(5)). .SH USAGE +.sp +.LP +For \fBpfexec\fR to function correctly, the \fBpfexecd\fR daemon must be running +in the current zone. This is normally managed by the +"\fBsvc:/system/pfexec:default\fR" SMF service (see \fBsmf\fR(5)). +.SH USAGE .LP \fBpfexec\fR is used to execute commands with predefined process attributes, such as specific user or group \fBID\fRs. diff --git a/usr/src/man/man1/proc.1 b/usr/src/man/man1/proc.1 index 4a428e55fd..e61ae1d714 100644 --- a/usr/src/man/man1/proc.1 +++ b/usr/src/man/man1/proc.1 @@ -539,12 +539,12 @@ Interface Stability See below. The human readable output is Uncommitted. The options are Committed. .SH SEE ALSO .LP -\fBgcore\fR(1), \fBldd\fR(1), \fBpargs\fR(1), \fBpgrep\fR(1), \fBpkill\fR(1), -\fBplimit\fR(1), \fBpmap\fR(1), \fBpreap\fR(1), \fBps\fR(1), \fBptree\fR(1), -\fBppgsz\fR(1), \fBpwd\fR(1), \fBrlogin\fR(1), \fBtime\fR(1), \fBtruss\fR(1), -\fBwait\fR(1), \fBfcntl\fR(2), \fBfstat\fR(2), \fBsetuid\fR(2), -\fBdlopen\fR(3C), \fBsignal.h\fR(3HEAD), \fBcore\fR(4), \fBproc\fR(4), -\fBprocess\fR(4), \fBattributes\fR(5), \fBzones\fR(5) +\fBgcore\fR(1), \fBldd\fR(1), \fBpargs\fR(1), \fBpauxv\fR(1), \fBpenv\fR(1), +\fBpgrep\fR(1), \fBpkill\fR(1), \fBplimit\fR(1), \fBpmap\fR(1), \fBpreap\fR(1), +\fBps\fR(1), \fBptree\fR(1), \fBppgsz\fR(1), \fBpwd\fR(1), \fBrlogin\fR(1), +\fBtime\fR(1), \fBtruss\fR(1), \fBwait\fR(1), \fBfcntl\fR(2), \fBfstat\fR(2), +\fBsetuid\fR(2), \fBdlopen\fR(3C), \fBsignal.h\fR(3HEAD), \fBcore\fR(4), +\fBproc\fR(4), \fBprocess\fR(4), \fBattributes\fR(5), \fBzones\fR(5) .SH WARNINGS .LP The following \fBproc\fR tools stop their target processes while inspecting diff --git a/usr/src/man/man1/ps.1 b/usr/src/man/man1/ps.1 index 7ff574f12b..2b0d435c44 100644 --- a/usr/src/man/man1/ps.1 +++ b/usr/src/man/man1/ps.1 @@ -38,6 +38,9 @@ displayed is controlled by the options. Some options accept lists as arguments. Items in a list can be either separated by commas or else enclosed in quotes and separated by commas or spaces. Values for \fIproclist\fR and \fIgrplist\fR must be numeric. +.sp +.LP +The \fBps\fR command also accepts BSD-style options. See \fBps\fR(1b). .SH OPTIONS .sp .LP @@ -1311,7 +1314,8 @@ Standard See \fBstandards\fR(5). .sp .LP \fBkill\fR(1), \fBlgrpinfo\fR(1), \fBnice\fR(1), \fBpagesize\fR(1), -\fBpmap\fR(1), \fBpriocntl\fR(1), \fBwho\fR(1), \fBgetty\fR(1M), \fBproc\fR(4), +\fBpmap\fR(1), \fBpriocntl\fR(1), \fBps\fR(1b), \fBwho\fR(1), \fBgetty\fR(1M), +\fBproc\fR(4), \fBttysrch\fR(4), \fBattributes\fR(5), \fBenviron\fR(5), \fBresource_controls\fR(5), \fBstandards\fR(5), \fBzones\fR(5) .SH NOTES diff --git a/usr/src/man/man1/sed.1 b/usr/src/man/man1/sed.1 index 126402343c..cd805bd841 100644 --- a/usr/src/man/man1/sed.1 +++ b/usr/src/man/man1/sed.1 @@ -1,8 +1,6 @@ .\" Copyright (c) 1992, 1993 .\" The Regents of the University of California. All rights reserved. .\" -.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved. -.\" .\" This code is derived from software contributed to Berkeley by .\" the Institute of Electrical and Electronics Engineers, Inc. .\" @@ -44,7 +42,8 @@ [\fB\-Ealnr\fP] [\fB\-e\fP \fIcommand\fP] [\fB\-f\fP \fIcommand_file\fP] -[\fB\-I\fP[\fIextension\fP] | \fB\-i\fP[\fIextension\fP]] +[\fB\-I\fP \fIextension\fP] +[\fB\-i\fP \fIextension\fP] [\fIfile ...\fP] .SH DESCRIPTION The @@ -97,11 +96,16 @@ Append the editing commands found in the file to the list of commands. The editing commands should each be listed on a separate line. .TP -\fB\-I\fP[\fIextension\fP] -Edit files in-place, saving backups if \fIextension\fP was specified. -It is not recommended to omit saving backups when in-place editing files, -as you risk corruption or partial content in situations where disk -space is exhausted, etc. +\fB\-I\fP \fIextension\fP +Edit files in-place, saving backups with the specified +\fIextension\fP. +If a zero-length +\fIextension\fP +is given, no backup will be saved. +It is not recommended to give a zero-length +\fIextension\fP +when in-place editing files, as you risk corruption or partial content +in situations where disk space is exhausted, etc. Note that in-place editing with \fB\-I\fP @@ -119,7 +123,7 @@ where using \fB\-i\fP is desired. .TP -\fB\-i\fP[\fIextension\fP] +\fB\-i\fP \fIextension\fP Edit files in-place similarly to \fB\-I\fP, but treat each file independently from other files. diff --git a/usr/src/man/man1/zlogin.1 b/usr/src/man/man1/zlogin.1 index 7c99eb6cb1..476faab86f 100644 --- a/usr/src/man/man1/zlogin.1 +++ b/usr/src/man/man1/zlogin.1 @@ -13,43 +13,43 @@ .\" Portions Copyright [yyyy] [name of copyright owner] .\" Copyright 2013 DEY Storage Systems, Inc. .\" Copyright (c) 2014 Gary Mills +.\" Copyright (c) 2015, Joyent, Inc. All Rights Reserved .\" Copyright 2015 Nexenta Systems, Inc. All rights reserved. -.TH ZLOGIN 1 "Mar 17, 2015" +.TH ZLOGIN 1 "Mar 30, 2015" .SH NAME zlogin \- enter a zone .SH SYNOPSIS .LP .nf -\fBzlogin\fR [\fB-dCEQ\fR] [\fB-e\fR \fIc\fR] [\fB-l\fR \fIusername\fR] \fIzonename\fR +\fBzlogin\fR [\fB-dCEINQ\fR] [\fB-e\fR \fIc\fR] [\fB-l\fR \fIusername\fR] \fIzonename\fR .fi .LP .nf -\fBzlogin\fR [\fB-nEQS\fR] [\fB-e\fR \fIc\fR] [\fB-l\fR \fIusername\fR] \fIzonename\fR \fIutility\fR +\fBzlogin\fR [\fB-inEQS\fR] [\fB-e\fR \fIc\fR] [\fB-l\fR \fIusername\fR] \fIzonename\fR \fIutility\fR [\fIargument\fR]... .fi .SH DESCRIPTION -.sp .LP The \fBzlogin\fR utility is used by the administrator to enter an operating system zone. Only a superuser operating in the global system zone can use this utility. .sp .LP -\fBzlogin\fR operates in one of three modes: +\fBzlogin\fR operates in one of four modes: .sp .ne 2 .na \fBInteractive Mode\fR .ad .RS 24n -If no utility argument is given and the stdin file descriptor for the -\fBzlogin\fR process is a tty device, \fBzlogin\fR operates in \fBinteractive -mode\fR. In this mode, \fBzlogin\fR creates a new pseudo terminal for use -within the login session. Programs requiring a tty device, for example, -\fBvi\fR(1), work properly in this mode. In this mode, \fBzlogin\fR invokes -\fBlogin\fR(1) to provide a suitable login session. +If no utility argument is given or if the \fB-i\fR option is specified, and the +stdin file descriptor for the \fBzlogin\fR process is a tty device, \fBzlogin\fR +operates in \fBinteractive mode\fR. In this mode, \fBzlogin\fR creates a new +pseudo terminal for use within the login session. Programs requiring a tty +device, for example, \fBvi\fR(1), work properly in this mode. In this mode, +\fBzlogin\fR invokes \fBlogin\fR(1) to provide a suitable login session. .RE .sp @@ -58,11 +58,12 @@ within the login session. Programs requiring a tty device, for example, \fBNon-Interactive Mode\fR .ad .RS 24n -If a utility is specified, \fBzlogin\fR operates in \fBnon-interactive mode\fR. -This mode can be useful for script authors since stdin, stdout, and stderr are -preserved and the exit status of \fIutility\fR is returned upon termination. In -this mode, \fBzlogin\fR invokes \fBsu\fR(1M) in order to set up the user's -environment and to provide a login environment. +If a utility is specified and the \fB-i\fR option is not specified, \fBzlogin\fR +operates in \fBnon-interactive mode\fR. This mode can be useful for script +authors since stdin, stdout, and stderr are preserved and the exit status of +\fIutility\fR is returned upon termination. In this mode, \fBzlogin\fR invokes +\fBsu\fR(1M) in order to set up the user's environment and to provide a login +environment. .sp The specified command is passed as a string and interpreted by a shell running in the non-global zone. See \fBrsh\fR(1). @@ -80,8 +81,17 @@ available once the zone is in the installed state. Connections to the console are persistent across reboot of the zone. .RE -.SH OPTIONS .sp +.ne 2 +.na +\fBStandalone-processs Interactive Mode\fR +.ad +.RS 24n +If the \fB-I\fR option is specified the user is connected to the zone's stdin, +stdout and stderr \fBzfd(7D)\fR devices. +.RE + +.SH OPTIONS .LP The following options are supported: .sp @@ -127,6 +137,25 @@ login by using the escape sequence character. .sp .ne 2 .na +\fB\fB-i\fR\fR +.ad +.RS 15n +Forces interactive mode when a utility argument is specified. +.RE + +.sp +.ne 2 +.na +\fB\fB-I\fR\fR +.ad +.RS 15n +Connects to the zone's \fBzfd(7D)\fR devices. +.RE + +.sp +.sp +.ne 2 +.na \fB\fB-l\fR \fIusername\fR\fR .ad .RS 15n @@ -149,6 +178,17 @@ and the shell which invokes \fBzlogin\fR both read from standard input. .sp .ne 2 .na +\fB-N\fR +.ad +.RS 15n +Nohup. This may only be used with the -I option to avoid sending EOF to the zfd +device when zlogin's stdin receives EOF. It can also be toggled by sending +\fBSIGUSR1\fR to an attached zlogin process. +.RE + +.sp +.ne 2 +.na \fB-Q\fR .ad .RS 15n @@ -172,7 +212,6 @@ other forms of login have become impossible. .RE .SS "Escape Sequences" -.sp .LP Lines that you type that start with the tilde character (\fB~\fR) are "escape sequences". The escape character can be changed using the \fB-e\fR option. @@ -187,12 +226,10 @@ host breaks the connection with no warning to the zone's end. .RE .SH SECURITY -.sp .LP Once a process has been placed in a zone other than the global zone, the process cannot change zone again, nor can any of its children. .SH OPERANDS -.sp .LP The following operands are supported: .sp @@ -223,7 +260,6 @@ Arguments passed to the utility. .RE .SH EXIT STATUS -.sp .LP In interactive and non-interactive modes, the \fBzlogin\fR utility exits when the command or shell in the non-global zone exits. In non-interactive mode, the @@ -268,7 +304,6 @@ mode. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -284,12 +319,10 @@ Interface Stability Evolving .TE .SH SEE ALSO -.sp .LP \fBlogin\fR(1), \fBrsh\fR(1), \fBvi\fR(1), \fBsu\fR(1M), \fBzoneadm\fR(1M), \fBzonecfg\fR(1M), \fBattributes\fR(5), \fBzones\fR(5) .SH NOTES -.sp .LP \fBzlogin\fR fails if its open files or any portion of its address space corresponds to an NFS file. This includes the executable itself or the shared diff --git a/usr/src/man/man1m/Makefile b/usr/src/man/man1m/Makefile index c3b726bc59..1cb7503b39 100644 --- a/usr/src/man/man1m/Makefile +++ b/usr/src/man/man1m/Makefile @@ -16,7 +16,7 @@ # Copyright 2016 Toomas Soome <tsoome@me.com> # -include $(SRC)//Makefile.master +include $(SRC)//Makefile.master MANSECT= 1m @@ -544,7 +544,10 @@ _MANFILES= 6to4relay.1m \ uucleanup.1m \ uusched.1m \ uuxqt.1m \ + vfsstat.1m \ vmstat.1m \ + vndadm.1m \ + vndstat.1m \ volcopy.1m \ volcopy_ufs.1m \ vscanadm.1m \ @@ -720,7 +723,6 @@ hal-set-property.1m := LINKSRC = hal-get-property.1m poweroff.1m := LINKSRC = halt.1m - comsat.1m := LINKSRC = in.comsat.1m fingerd.1m := LINKSRC = in.fingerd.1m rarpd.1m := LINKSRC = in.rarpd.1m diff --git a/usr/src/man/man1m/cfgadm_usb.1m b/usr/src/man/man1m/cfgadm_usb.1m index 23a565cd75..5fa2432cb8 100644 --- a/usr/src/man/man1m/cfgadm_usb.1m +++ b/usr/src/man/man1m/cfgadm_usb.1m @@ -30,7 +30,6 @@ cfgadm_usb \- USB hardware-specific commands for cfgadm .fi .SH DESCRIPTION -.sp .LP The Universal Serial Bus (\fBUSB\fR) hardware-specific library \fB/usr/lib/cfgadm/usb.so.1\fR provides the functionality for administering @@ -124,14 +123,14 @@ usb0/1.4 USB-device connected configured ok .sp .LP -\fBUSB2.0\fR chips have one \fBEHCI\fR host \fBUSB2.0\fR host controller and a +\fBUSB 2.0\fR chips have one \fBEHCI\fR host \fBUSB 2.0\fR host controller and a number of companion \fBUSB 1.\fR\fIx\fR host controllers (either \fBOHCI\fR or \fBUHCI\fR host controllers). .sp .LP -When a \fBUSB2.0\fR device has been plugged in, it shows up on the \fBEHCI\fR +When a \fBUSB 2.0\fR device has been plugged in, it shows up on the \fBEHCI\fR logical ports which might not have a \fB1\fR to \fB1\fR mapping to external -physical port numbers on the system. When a \fBUSB1.\fR\fIx\fR device is +physical port numbers on the system. When a \fBUSB 1.\fR\fIx\fR device is plugged in, the \fBEHCI\fR host controller reroutes the device to a companion host controller and the device shows up on the companion's logical port number. @@ -170,11 +169,11 @@ usb3/5 unknown empty unconfigured ok .sp .LP In this example \fBusb0\fR is the onboard USB 1.\fIx\fR host controller. -\fBusb1\fR and \fBusb2\fR are companion \fBOHCI USB1.\fR\fIx\fR host -controllers and \fBusb3\fR is an \fBEHCI USB2.0\fR host controller. +\fBusb1\fR and \fBusb2\fR are companion \fBOHCI USB 1.\fR\fIx\fR host +controllers and \fBusb3\fR is an \fBEHCI USB 2.0\fR host controller. .sp .LP -The following table shows the somewhat confusing routing for this USB2.0 chip: +The following table shows the somewhat confusing routing for this USB 2.0 chip: .sp .in +2 .nf @@ -333,7 +332,6 @@ before removing its device from the \fBUSB\fR. However, it is not recommended to hot-remove devices currently in use (such as removable disks currently opened by a volume manager or some other application). .SH OPTIONS -.sp .LP \fBcfgadm\fR defines several types of operations. These operations include invoking configuration state changes (\fB-c\fR), invoking hardware-specific @@ -957,7 +955,6 @@ are on the same bus. This information is available in the '\fBInformation\fR' field. .SH FILES -.sp .ne 2 .na \fB\fB/usr/lib/cfgadm/usb.so.1\fR\fR @@ -968,7 +965,6 @@ Hardware specific library for generic USB device administration .RE .SH SEE ALSO -.sp .LP \fBcfgadm\fR(1M), \fBconfig_admin\fR(3CFGADM), \fBattributes\fR(5), \fBscsa2usb\fR(7D), \fBusba\fR(7D) @@ -979,7 +975,6 @@ Universal Serial Bus 1.1 Specification (\fBwww.usb.org\fR) .LP \fI\fR .SH NOTES -.sp .LP \fBcfgadm\fR(1M) can not unconfigure, disconnect, reset, or change the configuration of any \fBUSB\fR device currently opened by any application. diff --git a/usr/src/man/man1m/dladm.1m b/usr/src/man/man1m/dladm.1m index 376d366a43..d10f529ecb 100644 --- a/usr/src/man/man1m/dladm.1m +++ b/usr/src/man/man1m/dladm.1m @@ -16,7 +16,7 @@ dladm \- administer data links .LP .nf \fBdladm show-link\fR [\fB-P\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIlink\fR] -\fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] \fIlink\fR \fInew-link\fR +\fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fIlink\fR \fInew-link\fR .fi .LP @@ -99,9 +99,11 @@ dladm \- administer data links .LP .nf -\fBdladm set-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIlink\fR -\fBdladm reset-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-p\fR \fIprop\fR[,...]] \fIlink\fR -\fBdladm show-linkprop\fR [\fB-P\fR] [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] [\fB-p\fR \fIprop\fR[,...]] [\fIlink\fR] +\fBdladm set-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] + \fIlink\fR +\fBdladm reset-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] [\fB-p\fR \fIprop\fR[,...]] \fIlink\fR +\fBdladm show-linkprop\fR [\fB-P\fR] [\fB-z\fR \fIzonename\fR] [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]] + [\fB-p\fR \fIprop\fR[,...]] [\fIlink\fR] .fi .LP @@ -116,9 +118,9 @@ dladm \- administer data links \fBdladm create-vnic\fR [\fB-t\fR] \fB-l\fR \fIlink\fR [\fB-R\fR \fIroot-dir\fR] [\fB-m\fR \fIvalue\fR | auto | {factory \fB-n\fR \fIslot-identifier\fR]} | {random [\fB-r\fR \fIprefix\fR]}] [\fB-v\fR \fIvlan-id\fR] [\fB-p\fR \fIprop\fR=\fIvalue\fR[,...]] \fIvnic-link\fR -\fBdladm delete-vnic\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fIvnic-link\fR +\fBdladm delete-vnic\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fIvnic-link\fR \fBdladm show-vnic\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [\fB-o\fR \fIfield\fR[,...]] - [\fB-l\fR \fIlink\fR] [\fIvnic-link\fR] + [\fB-l\fR \fIlink\fR] [\fB-z\fR \fIzonename\fR] [\fIvnic-link\fR] .fi .LP @@ -140,6 +142,14 @@ dladm \- administer data links .LP .nf +\fBdladm create-overlay\fR [\fB-t\fR] \fB-e\fR \fIencap\fR \fB-s\fR \fIsearch\fR \fB-v\fR \fIvnetid\fR [\fB-p\fR \fIprop\fR=\fIvalue\fR[,...]] \fIoverlay\fR +\fBdladm delete-overlay\fR \fIoverlay\fR +\fBdladm modify-overlay\fR \fB-d\fR \fImac\fR | \fB-f\fR | \fB-s\fR \fImac=ip:port\fR \fIoverlay\fR +\fBdladm show-overlay\fR [ \fB-f\fR | \fB-t\fR ] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIoverlay\fR] +.fi + +.LP +.nf \fBdladm show-usage\fR [\fB-a\fR] \fB-f\fR \fIfilename\fR [\fB-p\fR \fIplotfile\fR \fB-F\fR \fIformat\fR] [\fB-s\fR \fItime\fR] [\fB-e\fR \fItime\fR] [\fIlink\fR] .fi @@ -227,9 +237,9 @@ A WiFi datalink. .ad .sp .6 .RS 4n -A virtual network interface created on a link or an \fBetherstub\fR. It is a -pseudo device that can be treated as if it were an network interface card on a -machine. +A virtual network interface created on a link, an \fBetherstub\fR, or \fBan +overlay\fR. It is a pseudo device that can be treated as if it were an network +interface card on a machine. .RE .sp @@ -297,6 +307,20 @@ use any alphanumeric characters, as well as underscore (\fB_\fR), period characters. .RE +.sp +.ne 2 +.na +.B overlay +.ad +.sp .6 +.RS 4n +An overlay instance, identified by an administratively-chosen name. An overlay +can be used to create or join an existing software defined network. +VNICs created on an overlay will appear to be connected by a local virtual +switch and will also be connected to interfaces on matching overlays provided by +other hosts. For more information on overlay devices, see \fBoverlay\fR(5). +.RE + .SS "Options" .LP Each \fBdladm\fR subcommand has its own set of options. However, many of the @@ -569,8 +593,7 @@ will be displayed only once. .sp .ne 2 .na -\fB\fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] \fIlink\fR -\fInew-link\fR\fR +\fB\fBdladm rename-link\fR [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fIlink\fR \fInew-link\fR\fR .ad .sp .6 .RS 4n @@ -588,6 +611,16 @@ examples of how this subcommand is used. See "Options," above. .RE +.sp +.ne 2 +.na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +A link assigned to a zone can only be renamed while the zone is in the ready state. +.RE + .RE .sp @@ -3193,8 +3226,7 @@ Extended output is displayed for \fBPTYPE\fR values of \fBcurrent\fR, .sp .ne 2 .na -\fB\fBdladm set-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-p\fR -\fIprop\fR=\fIvalue\fR[,...] \fIlink\fR\fR +\fB\fBdladm set-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIlink\fR\fR .ad .sp .6 .RS 4n @@ -3226,6 +3258,16 @@ See "Options," above. .sp .ne 2 .na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + +.sp +.ne 2 +.na \fB\fB-p\fR \fIprop\fR=\fIvalue\fR[,...], \fB--prop\fR \fIprop\fR=\fIvalue\fR[,...]\fR .ad @@ -3245,8 +3287,7 @@ same value. .sp .ne 2 .na -\fB\fBdladm reset-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-p\fR -\fIprop\fR,...] \fIlink\fR\fR +\fB\fBdladm reset-linkprop\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] [\fB-p\fR \fIprop\fR,...] \fIlink\fR\fR .ad .sp .6 .RS 4n @@ -3278,6 +3319,16 @@ See "Options," above. .sp .ne 2 .na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + +.sp +.ne 2 +.na \fB\fB-p\fR \fIprop, ...\fR, \fB--prop\fR=\fIprop, ...\fR\fR .ad .sp .6 @@ -3292,8 +3343,7 @@ the same value. .sp .ne 2 .na -\fB\fBdladm show-linkprop\fR [\fB-P\fR] [[\fB-c\fR] \fB-o\fR -\fIfield\fR[,...]][\fB-p\fR \fIprop\fR[,...]] [\fIlink\fR]\fR +\fB\fBdladm show-linkprop\fR [\fB-P\fR] [\fB-z\fR \fIzonename\fR] [[\fB-c\fR] \fB-o\fR \fIfield\fR[,...]][\fB-p\fR \fIprop\fR[,...]] [\fIlink\fR]\fR .ad .sp .6 .RS 4n @@ -3411,6 +3461,16 @@ Display persistent link property information .sp .ne 2 .na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + +.sp +.ne 2 +.na \fB\fB-p\fR \fIprop, ...\fR, \fB--prop\fR=\fIprop, ...\fR\fR .ad .sp .6 @@ -3728,8 +3788,7 @@ A comma-separated list of properties to set to the specified values. .sp .ne 2 .na -\fB\fBdladm delete-vnic\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] -\fIvnic-link\fR\fR +\fB\fBdladm delete-vnic\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fIvnic-link\fR\fR .ad .sp .6 .RS 4n @@ -3755,13 +3814,22 @@ next reboot. See "Options," above. .RE +.sp +.ne 2 +.na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + .RE .sp .ne 2 .na -\fB\fBdladm show-vnic\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] -[\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fIvnic-link\fR]\fR +\fB\fBdladm show-vnic\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fB-z\fR \fIzonename\fR] [\fIvnic-link\fR]\fR .ad .sp .6 .RS 4n @@ -3904,6 +3972,16 @@ will be displayed only once. Display information for all VNICs on the named link. .RE +.sp +.ne 2 +.na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + .RE .sp @@ -4321,6 +4399,349 @@ The tunnel destination address. .sp .ne 2 .na +\fBdladm create-overlay\fR \fB-e\fR \fIencap\fR \fB-s\fR \fIsearch\fR +\fB-v\fR \fIvnetid\fR [\fB-p\fR \fIprop\fR=\fIvalue\fR[,...]] \fIoverlay\fR +.ad +.sp .6 +.RS 4n +Create an overlay device named \fIoverlay\fR. +.sp +Overlay devices are similar to etherstubs. VNICs can be created on top +of them. However, unlike an etherstub which is local to the system, an +overlay device can be configured to communicate to remote hosts, +providing a means for network virtualization. The way in which it does +this is described by the encapsulation module and the search plugin. For +more information on these, see \fBoverlay\fR(5). +.sp +An overlay device has a series of required and optional properties. These +properties vary based upon the search and encapsulation modules and are fully +specified in \fBoverlay\fR(5). Not every property needs to be specified - some +have default values which will be used if nothing specific is specified. For +example, the default port for VXLAN comes from its IANA standard. If a +required property is missing, the command will fail and inform you of the +missing properties. +.sp +.ne 2 +.na +\fB\fB-t\fR, \fB--temporary\fR\fR +.ad +.sp .6 +.RS 4n +Specifies that the overlay is temporary. Temporary overlays last until +the next reboot. +.RE + +.sp +.ne 2 +.na +\fB-e\fR \fIencap\fR, \fB--encap\fR=\fIencap\fR +.ad +.sp .6 +.RS 4n +Use \fIencap\fR as the encapsulation plugin for the overlay device +\fIoverlay\fR. The encapsulation plugin determines how packets are transformed +before being put on the wire. +.RE + +.sp +.ne 2 +.na +\fB-s\fR \fIsearch\fR, \fB--search\fR=\fIsearch\fR +.ad +.sp .6 +.RS 4n +Use \fIsearch\fR as the search plugin for \fIoverlay\fR. The search plugin +determines how non-local targets are found and where packets are directed to. +.RE + +.sp +.ne 2 +.na +\fB\fB-p\fR \fIprop\fR=\fIvalue\fR,..., \fB--prop\fR +\fIprop\fR=\fIvalue\fR,...\fR +.ad +.sp .6 +.RS 4n +A comma-separated list of properties to set to the specified values. +.RE + +.sp +.ne 2 +.na +\fB-v\fR \fIvnetid\fR, \fB--vnetid\fR=\fIvnetid\fR +.ad +.sp .6 +.RS 4n +Sets the virtual networking identifier to \fIvnetid\fR. A virtual network +identifier determines is similar to a VLAN identifier, in that it identifies a +unique virtual network. All overlay devices on the system share the same space +for the virtual network identifier. However, the valid range of identifiers is +determined by the encapsulation plugin specified by \fB-e\fR. +.RE + +.RE + +.sp +.ne 2 +.na +\fBdladm delete-overlay\fR \fIoverlay\fR +.ad +.sp .6 +.RS 4n +Delete the specified overlay. This will fail if there are VNICs on top of the +device. +.RE + +.sp +.ne 2 +.na +\fBdladm modify-overlay\fR \fB-d\fR \fImac\fR | \fB-f\fR | \fB-s\fR \fImac=ip:port\fR \fIoverlay\fR +.ad +.sp .6 +.RS 4n +Modifies the target tables for the specified overlay. +.sp +The different options allow for different ways of modifying the target table. +One of \fB-d\fR, \fB-f\fR, and \fB-s\fR is required. This is not applicable for +all kinds of overlay devices. For more information, see \fBoverlay\fR(5). +.sp +.ne 2 +.na +\fB-d\fR \fImac\fR, \fB--delete-entry\fR=\fImac\fR +.ad +.sp .6 +.RS 4n +Deletes the entry for \fImac\fR from the target table for \fIoverlay\fR. Note, +if a lookup is pending or outstanding, this does not cancel it or stop it from +updating the value. +.RE + +.sp +.ne 2 +.na +\fB-f\fR, \fB--flush-table\fR +.ad +.sp .6 +.RS 4n +Flushes all values in the target table for \fIoverlay\fR. +.RE + +.sp +.ne 2 +.na +\fB-s\fR \fImac\fR=\fIvalue\fR, \fB--set-entry\fR=\fImac\fR=\fIvalue\fR +.ad +.sp .6 +.RS 4n +Sets the value of \fIoverlay\fR's target table entry for \fImac\fR to +the specified value. The specified value varies upon the encapsulation +plugin. The value may be a combination of a MAC address, IP address, +and port. Generally, this looks like +[\fImac\fR,][\fIIP\fR:][\fIport\fR]. If a component is the last one, +then there is no need for a separator. eg. if just the MAC address or +IP is needed, it would look like \fImac\fR and \fIIP\fR respectively. +.RE + +.RE + +.sp +.ne 2 +.na +\fBdladm show-overlay\fR [ \fB-f\fR | \fB-t\fR ] [[\fB-p\fR] \fB-o\fR \fIfield\fR[,...]] [\fIoverlay\fR] +.ad +.sp .6 +.RS 4n +Shows overlay configuration (the default), internal target tables (\fB-t\fR), or +the FMA state (\fB-f\fR), either for all overlays or the specified overlay. +.sp +By default (with neither \fB-f\fR or \fB-t\fR specified), the following fields +will be displayed: +.sp +.ne 2 +.na +\fB\fBLINK\fR\fR +.ad +.sp .6 +.RS 4n +The name of the overlay. +.RE + +.sp +.ne 2 +.na +\fB\fBPROPERTY\fR\fR +.ad +.sp .6 +.RS 4n +The name of the property. +.RE + +.sp +.ne 2 +.na +\fB\fBPERM\fR\fR +.ad +.sp .6 +.RS 4n +The read/write permissions of the property. The value shown is one of \fBr-\fR +or \fBrw\fR. +.RE + +.sp +.ne 2 +.na +\fB\fBVALUE\fR\fR +.ad +.sp .6 +.RS 4n +The current property value. If the value is not set, it is shown as \fB--\fR. +If it is unknown, the value is shown as \fB?\fR. +.RE + +.sp +.ne 2 +.na +\fB\fBDEFAULT\fR\fR +.ad +.sp .6 +.RS 4n +The default value of the property. If the property has no default value, +\fB--\fR is shown. +.RE + +.sp +.ne 2 +.na +\fB\fBPOSSIBLE\fR\fR +.ad +.sp .6 +.RS 4n +A comma-separated list of the values the property can have. If the values span +a numeric range, \fImin\fR - \fImax\fR might be shown as shorthand. If the +possible values are unknown or unbounded, \fB--\fR is shown. +.RE + +.sp +When the \fB-f\fR option is displayed, the following fields will be displayed: +.sp +.ne 2 +.na +\fB\fBLINK\fR\fR +.ad +.sp .6 +.RS 4n +The name of the overlay. +.RE + +.sp +.ne 2 +.na +\fB\fBSTATUS\fR\fR +.ad +.sp .6 +.RS 4n +Either \fBONLINE\fR or \fBDEGRADED\fR. +.RE + +.sp +.ne 2 +.na +\fB\fBDETAILS\fR\fR +.ad +.sp .6 +.RS 4n +When the \fBoverlay\fR's status is \fBONLINE\fR, then this has the value +\fB--\fR. Otherwise, when it is \fBDEGRADED\fR, this field provides a more +detailed explanation as to why it's degraded. +.RE + +.sp +When the \fB-t\fR option is displayed, the following fields will be displayed: +.sp +.ne 2 +.na +\fB\fBLINK\fR\fR +.ad +.sp .6 +.RS 4n +The name of the overlay. +.RE + +.sp +.ne 2 +.na +\fB\fBTARGET\fR\fR +.ad +.sp .6 +.RS 4n +The target MAC address of a table entry. +.RE + +.sp +.ne 2 +.na +\fB\fBDESTINATION\fR\fR +.ad +.sp .6 +.RS 4n +The address that an encapsulated packet will be sent to when a packet has the +address specified by \fBTARGET\fR. +.RE + +The \fBshow-overlay\fR command supports the following options: + +.sp +.ne 2 +.na +\fB-f\fR, \fB--fma\fR +.ad +.sp .6 +.RS 4n +Displays information about an overlay device's FMA state. For more +information on the target table, see \fBoverlay\fR(5). +.RE + +.sp +.ne 2 +.na +\fB\fB-o\fR \fIfield\fR[,...], \fB--output\fR=\fIfield\fR\fR +.ad +.sp .6 +.RS 4n +A case-insensitive, comma-separated list of output fields to display. The field +name must be one of the fields listed above, or the special value \fBall\fR, to +display all fields. The fields applicable to the \fB-o\fR option are limited to +those listed under each output mode. For example, if using \fB-L\fR, only the +fields listed under \fB-L\fR, above, can be used with \fB-o\fR. +.RE + +.sp +.ne 2 +.na +\fB\fB-p\fR, \fB--parsable\fR\fR +.ad +.sp .6 +.RS 4n +Display using a stable machine-parsable format. The \fB-o\fR option is +required with \fB-p\fR. See "Parsable Output Format", below. +.RE + +.sp +.ne 2 +.na +\fB-t\fR, \fB--target\fR +.ad +.sp .6 +.RS 4n +Displays information about an overlay device's target table. For more +information on the target table, see \fBoverlay\fR(5). +.RE + +.RE + +.sp +.ne 2 +.na \fB\fBdladm show-usage\fR [\fB-a\fR] \fB-f\fR \fIfilename\fR [\fB-p\fR \fIplotfile\fR \fB-F\fR \fIformat\fR] [\fB-s\fR \fItime\fR] [\fB-e\fR \fItime\fR] [\fIlink\fR]\fR @@ -5496,7 +5917,7 @@ Interface Stability Committed .LP \fBacctadm\fR(1M), \fBautopush\fR(1M), \fBifconfig\fR(1M), \fBipsecconf\fR(1M), \fBndd\fR(1M), \fBpsrset\fR(1M), \fBwpad\fR(1M), \fBzonecfg\fR(1M), -\fBattributes\fR(5), \fBieee802.3\fR(5), \fBdlpi\fR(7P) +\fBattributes\fR(5), \fBieee802.3\fR(5), \fBoverlay\fR(5), \fBdlpi\fR(7P) .SH NOTES .LP The preferred method of referring to an aggregation in the aggregation diff --git a/usr/src/man/man1m/flowadm.1m b/usr/src/man/man1m/flowadm.1m index 5eca181426..860d5f1faa 100644 --- a/usr/src/man/man1m/flowadm.1m +++ b/usr/src/man/man1m/flowadm.1m @@ -1,5 +1,6 @@ '\" te .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2011, Joyent, Inc. All Rights Reserved .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -11,14 +12,14 @@ services, containers, and virtual machines .LP .nf \fBflowadm show-flow\fR [\fB-pP\fR] [\fB-S\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [\fB-l\fR \fIlink\fR] - [\fB-o\fR \fIfield\fR[,...]] [\fIflow\fR] + [\fB-o\fR \fIfield\fR[,...]] [\fB-z\fR \fIzonename\fR] [\fIflow\fR] .fi .LP .nf -\fBflowadm add-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR \fIlink\fR \fB-a\fR \fIattr\fR=\fIvalue\fR[,...] - \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIflow\fR -\fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] {\fB-l\fR \fIlink\fR | \fIflow\fR} +\fBflowadm add-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fB-l\fR \fIlink\fR + \fB-a\fR \fIattr\fR=\fIvalue\fR[,...] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIflow\fR +\fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] {\fB-l\fR \fIlink\fR | \fIflow\fR} .fi .LP @@ -75,8 +76,7 @@ The following subcommands are supported: .sp .ne 2 .na -\fB\fBflowadm show-flow\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] -[\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fIflow\fR]\fR +\fB\fBflowadm show-flow\fR [\fB-pP\fR] [\fB-s\fR [\fB-i\fR \fIinterval\fR]] [\fB-o\fR \fIfield\fR[,...]] [\fB-l\fR \fIlink\fR] [\fB-z\fR \fIzonename\fR] [\fIflow\fR]\fR .ad .sp .6 .RS 4n @@ -221,14 +221,22 @@ Display information for all flows on the named link or information for the named flow. .RE +.sp +.ne 2 +.na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + .RE .sp .ne 2 .na -\fB\fBflowadm add-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR -\fIlink\fR \fB-a\fR \fIattr\fR=\fIvalue\fR[,...] \fB-p\fR -\fIprop\fR=\fIvalue\fR[,...] \fIflow\fR\fR +\fB\fBflowadm add-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fB-l\fR \fIlink\fR \fB-a\fR \fIattr\fR=\fIvalue\fR[,...] \fB-p\fR \fIprop\fR=\fIvalue\fR[,...] \fIflow\fR\fR .ad .sp .6 .RS 4n @@ -266,6 +274,16 @@ persistent creation. .sp .ne 2 .na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + +.sp +.ne 2 +.na \fB\fB-l\fR \fIlink\fR, \fB--link\fR=\fIlink\fR\fR .ad .sp .6 @@ -298,8 +316,7 @@ A comma-separated list of properties to be set to the specified values. .sp .ne 2 .na -\fB\fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] \fB-l\fR -{\fIlink\fR | \fIflow\fR}\fR +\fB\fBflowadm remove-flow\fR [\fB-t\fR] [\fB-R\fR \fIroot-dir\fR] [\fB-z\fR \fIzonename\fR] \fB-l\fR {\fIlink\fR | \fIflow\fR}\fR .ad .sp .6 .RS 4n @@ -329,6 +346,16 @@ persistent removal. .sp .ne 2 .na +\fB\fB-z\fR \fIzonename\fR +.ad +.sp .6 +.RS 4n +Operate on a link that has been delegated to the specified zone. +.RE + +.sp +.ne 2 +.na \fB\fB-l\fR \fIlink\fR | \fIflow\fR, \fB--link\fR=\fIlink\fR | \fIflow\fR\fR .ad .sp .6 diff --git a/usr/src/man/man1m/mount_tmpfs.1m b/usr/src/man/man1m/mount_tmpfs.1m index ef7a2a6a35..7ea64130bd 100644 --- a/usr/src/man/man1m/mount_tmpfs.1m +++ b/usr/src/man/man1m/mount_tmpfs.1m @@ -1,10 +1,10 @@ '\" te .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved -.\" Copyright (c) 2011, Joyent, Inc. All Rights Reserved +.\" Copyright 2015 Joyent, Inc. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH MOUNT_TMPFS 1M "Dec 2, 2011" +.TH MOUNT_TMPFS 1M "Mar 18, 2015" .SH NAME mount_tmpfs \- mount tmpfs file systems .SH SYNOPSIS @@ -26,7 +26,8 @@ remain hidden until the file system is once again unmounted. The attributes (mode, owner, and group) of the root of the \fBtmpfs\fR filesystem are inherited from the underlying \fImount_point\fR, provided that those attributes are determinable. If not, the root's attributes are set to their default -values. +values. The mode may also be overriden by the \fBmode\fR mount option, which +takes precedence if set. .sp .LP The \fIspecial\fR argument is usually specified as \fBswap\fR but is in fact @@ -55,13 +56,29 @@ set with \fBremount\fR reverts to no limit. .sp .ne 2 .na +\fBmode=\fIoctalmode\fR\fR +.ad +.RS 19n +The \fImode\fR argument controls the permissions of the \fBtmpfs\fR mount +point. The argument must be an octal number, of the form passed to +\fBchmod\fR(1). Only the access mode, setuid, setgid, and sticky bits (a mask +of \fB07777\fR) may be set. If this option is not provided then the default +mode behaviour, as described above, applies. +.RE + +.sp +.sp +.ne 2 +.na \fBsize=\fIsz\fR\fR .ad .RS 19n The \fIsz\fR argument controls the size of this particular \fBtmpfs\fR file system. If the argument is has a `k' suffix, the number will be interpreted as a number of kilobytes. An `m' suffix will be interpreted as a number of -megabytes. No suffix is interpreted as bytes. In all cases, the actual size of +megabytes. A `g' suffix will be interpreted as a number of gigabytes. A `%' +suffix will be interpreted as a percentage of the swap space available to the +zone. No suffix is interpreted as bytes. In all cases, the actual size of the file system is the number of bytes specified, rounded up to the physical pagesize of the system. .RE diff --git a/usr/src/man/man1m/prstat.1m b/usr/src/man/man1m/prstat.1m index a5f02621cf..08e2ce9907 100644 --- a/usr/src/man/man1m/prstat.1m +++ b/usr/src/man/man1m/prstat.1m @@ -1,6 +1,7 @@ '\" te .\" Copyright (c) 2013 Gary Mills .\" Copyright (c) 2006, 2009 Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2013, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -10,10 +11,10 @@ prstat \- report active process statistics .SH SYNOPSIS .LP .nf -\fBprstat\fR [\fB-acHJLmRrtTvWZ\fR] [\fB-d\fR u | d] [\fB-C\fR \fIpsrsetlist\fR] [\fB-h\fR \fIlgrplist\fR] +\fBprstat\fR [\fB-acHJLmRrtTvVWZ\fR] [\fB-d\fR u | d] [\fB-C\fR \fIpsrsetlist\fR] [\fB-h\fR \fIlgrplist\fR] [\fB-j\fR \fIprojlist\fR] [\fB-k\fR \fItasklist\fR] [\fB-n\fR \fIntop\fR[,\fInbottom\fR]] [\fB-p\fR \fIpidlist\fR] [\fB-P\fR \fIcpulist\fR] [\fB-s\fR \fIkey\fR | \fB-S\fR \fIkey\fR ] - [\fB-u\fR \fIeuidlist\fR] [\fB-U\fR \fIuidlist\fR] [\fB-z\fR \fIzoneidlist\fR] + [\fB-u\fR \fIeuidlist\fR] [\fB-U\fR \fIuidlist\fR] [\fB-z\fR \fIzoneidlist\fR] [\fB-Z\fR] [\fIinterval\fR [\fIcount\fR]] .fi @@ -366,6 +367,18 @@ with the \fB-\fR sign. .sp .ne 2 .na +\fB\fB-V\fR\fR +.ad +.sp .6 +.RS 4n +Report accurate aggregated SWAP and RSS values when used with the \fB-J\fR, +\fB-t\fR, \fB-T\fR or \fB-Z\fR options. This uses an accurate, but more expensive, +calculation to determine the aggregated values for the specified grouping. +.RE + +.sp +.ne 2 +.na \fB\fB-W\fR\fR .ad .sp .6 @@ -447,9 +460,11 @@ devices, in kilobytes (\fBK\fR), megabytes (\fBM\fR), or gigabytes (\fBG\fR). .RS 4n The resident set size of the process (\fBRSS\fR), in kilobytes (\fBK\fR), megabytes (\fBM\fR), or gigabytes (\fBG\fR). The RSS value is an estimate -provided by \fBproc\fR(4) that might underestimate the actual resident set -size. Users who want to get more accurate usage information for capacity -planning should use the \fB-x\fR option to \fBpmap\fR(1) instead. +provided by \fBproc\fR(4) that might underestimate the actual +per-process resident set size and usually overestimates the aggregated +resident set size. Users who want to get more accurate usage information for +capacity planning should use either the \fB-V\fR option or, for per-process +results, the \fB-x\fR option to \fBpmap\fR(1) instead. .RE .sp diff --git a/usr/src/man/man1m/reboot.1m b/usr/src/man/man1m/reboot.1m index 87f4bd892b..a4bdebd496 100644 --- a/usr/src/man/man1m/reboot.1m +++ b/usr/src/man/man1m/reboot.1m @@ -142,8 +142,7 @@ This option is currently available only on x86 systems. The \fB-p\fR and .ad .sp .6 .RS 4n -Quick. Reboot quickly and ungracefully, without shutting down running processes -first. +Quick. Reboot quickly without halting running zones first. .RE .SH OPERANDS diff --git a/usr/src/man/man1m/snoop.1m b/usr/src/man/man1m/snoop.1m index ca969e22b4..4184c66e10 100644 --- a/usr/src/man/man1m/snoop.1m +++ b/usr/src/man/man1m/snoop.1m @@ -1,9 +1,10 @@ '\" te .\" Copyright (C) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2014, Joyent, Inc. All rights reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SNOOP 1M "Feb 18, 2009" +.TH SNOOP 1M "Feb 24, 2014" .SH NAME snoop \- capture and inspect network packets .SH SYNOPSIS @@ -12,7 +13,7 @@ snoop \- capture and inspect network packets \fBsnoop\fR [\fB-aqrCDINPSvV\fR] [\fB-t\fR [r | a | d]] [\fB-c\fR \fImaxcount\fR] [\fB-d\fR \fIdevice\fR] [\fB-i\fR \fIfilename\fR] [\fB-n\fR \fIfilename\fR] [\fB-o\fR \fIfilename\fR] [\fB-p\fR \fIfirst\fR [, \fIlast\fR]] [\fB-s\fR \fIsnaplen\fR] [\fB-x\fR \fIoffset\fR [, \fIlength\fR]] - [\fIexpression\fR] + [\fB-z\fR \fIzonename\fR] [\fIexpression\fR] .fi .SH DESCRIPTION @@ -298,6 +299,22 @@ the whole packet, use an \fIoffset\fR of 0. If a \fIlength\fR value is not provided, the rest of the packet is displayed. .RE +.sp +.ne 2 +.na +.BI -z zonename +.ad +.sp .6 +.RS 4n +Open an earlier datalink specified via +.B -d +or +.B -I +in the specified zone \fIzonename\fR. +This option is only meaningful in the global zone and +allows the global zone to inspect datalinks of non-global zones. +.RE + .SH OPERANDS .sp .ne 2 diff --git a/usr/src/man/man1m/svc.startd.1m b/usr/src/man/man1m/svc.startd.1m index 7c80c35e23..103c6b5fec 100644 --- a/usr/src/man/man1m/svc.startd.1m +++ b/usr/src/man/man1m/svc.startd.1m @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH SVC.STARTD 1M "Mar 18, 2011" +.TH SVC.STARTD 1M "Aug 23, 2012" .SH NAME svc.startd \- Service Management Facility master restarter .SH SYNOPSIS @@ -372,10 +372,13 @@ properties listed below in the \fBstartd\fR property group. .RS 4n The \fBcritical_failure_count\fR and \fBcritical_failure_period\fR properties together specify the maximum number of service failures allowed in a given -time interval before \fBsvc.startd\fR transitions the service to maintenance. +number of seconds before \fBsvc.startd\fR transitions the service to +maintenance. If the number of failures exceeds \fBcritical_failure_count\fR in any period of \fBcritical_failure_period\fR seconds, \fBsvc.startd\fR will transition the -service to maintenance. +service to maintenance. The \fBcritical_failure_count\fR value is limited +to the range 1-10 and defaults to 10. The \fBcritical_failure_period\fR +defaults to 600 seconds. .RE .sp diff --git a/usr/src/man/man1m/tunefs.1m b/usr/src/man/man1m/tunefs.1m index 7f522f43fa..0b849f2dd7 100644 --- a/usr/src/man/man1m/tunefs.1m +++ b/usr/src/man/man1m/tunefs.1m @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH TUNEFS 1M "Dec 5, 2003" +.TH TUNEFS 1M "Sep 19, 2013" .SH NAME tunefs \- tune an existing UFS file system .SH SYNOPSIS @@ -120,3 +120,9 @@ encountering files greater than or equal to 2 Gbyte ( 2^31 bytes). .sp .LP \fBmkfs_ufs\fR(1M), \fBnewfs\fR(1M), \fBattributes\fR(5), \fBlargefile\fR(5) + +.\" Take this out and a Unix Demon will dog your steps from now until +.\" the time_t's wrap around. +.SH BUGS +.sp +You can tune a file system, but you can't tune a fish. diff --git a/usr/src/man/man1m/vfsstat.1m b/usr/src/man/man1m/vfsstat.1m new file mode 100644 index 0000000000..aef8431a09 --- /dev/null +++ b/usr/src/man/man1m/vfsstat.1m @@ -0,0 +1,213 @@ +'\" 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 2014 Joyent, Inc. All rights reserved. +.\" +.TH "VFSSTAT" "1m" "May 1, 2014" "" "" +. +.SH "NAME" +\fBvfsstat\fR \-\- Report VFS read and write activity +. +.SH "SYNOPSIS" +. +.nf +vfsstat [\-hIMrzZ] [interval [count]] +. +.fi +. +.SH "DESCRIPTION" +The vfsstat utility reports a summary of VFS read and write +activity per zone\. It first prints all activity since boot, then +reports activity over a specified interval\. +. +.P +When run from a non\-global zone (NGZ), only activity from that NGZ +can be observed\. When run from a the global zone (GZ), activity +from the GZ and all other NGZs can be observed\. +. +.P +This tool is convenient for examining I/O performance as +experienced by a particular zone or application\. Other tools +which examine solely disk I/O do not report reads and writes which +may use the filesystem\'s cache\. Since all read and write system +calls pass through the VFS layer, even those which are satisfied +by the filesystem cache, this tool is a useful starting point when +looking at a potential I/O performance problem\. The vfsstat +command reports the most accurate reading of I/O performance as +experienced by an application or zone\. +. +.P +One additional feature is that ZFS zvol performance is also reported +by this tool, even though zvol I/O does not go through the VFS +layer\. This is done so that this single tool can be used to monitor +I/O performance and because its not unreasonable to think of zvols +as being included along with other ZFS filesystems\. +. +.P +The calculations and output fields emulate those from iostat(1m) +as closely as possible\. When only one zone is actively performing +disk I/O, the results from iostat(1m) in the global zone and +vfsstat in the local zone should be almost identical\. Note that +many VFS read operations may be handled by the filesystem cache, +so vfsstat and iostat(1m) will be similar only when most +operations require a disk access\. +. +.P +As with iostat(1m), a result of 100% for VFS read and write +utilization does not mean that the VFS layer is fully saturated\. +Instead, that measurement just shows that at least one operation +was pending over the last interval of time examined\. Since the +VFS layer can process more than one operation concurrently, this +measurement will frequently be 100% but the VFS layer can still +accept additional requests\. +. +.SH "OUTPUT" +The vfsstat utility reports the following information: +. +.IP "" 4 +. +.nf +r/s +.RS +reads per second +.RE + +w/s +.RS +writes per second +.RE + +kr/s +.RS +kilobytes read per second +.RE + +kw/s +.RS +kilobytes written per second +.RE + +ractv +.RS +average number of read operations actively being serviced by the VFS layer +.RE + +wactv +.RS +average number of write operations actively being serviced by the VFS layer +.RE + +read_t +.RS +average VFS read latency, in microseconds +.RE + +writ_t +.RS +average VFS write latency, in microseconds +.RE + +%r +.RS +percent of time there is a VFS read operation pending +.RE + +%w +.RS +percent of time there is a VFS write operation pending +.RE + +d/s +.RS +VFS operations per second delayed by the ZFS I/O throttle +.RE + +del_t +.RS +average ZFS I/O throttle delay, in microseconds +.RE +. +.fi +. +.IP "" 0 +. +.SH "OPTIONS" +The following options are supported: +. +.P +\-h +.RS +Show help message and exit +.RE +. +.P +\-I +.RS +Print results per interval, rather than per second (where applicable) +.RE +. +.P +\-M +.RS +Print results in MB/s instead of KB/s +.RE +. +.P +\-r +.RS +Show results in a comma\-separated format +.RE +. +.P +\-z +.RS +Hide zones with no VFS activity +.RE +. +.P +\-Z +.RS +Print results for all zones, not just the current zone +.RE +. +.SH "OPERANDS" +interval +. +.P +Specifies the length in seconds to pause between each interval +report\. If not specified, vfsstat will print a summary since boot +and exit\. +. +.P +count +. +.P +Specifies the number of intervals to report\. Defaults to +unlimited if not specified\. +. +.SH "SEE ALSO" +. +.nf +iostat(1m), ziostat(1m), mpstat(1m) +. +.fi +. +.SH "NOTES" +This command does not examine readdir or any other VFS operations, +only read and write operations\. +. +.P +This command does not look at network I/O, only I/O operations to +or from a file\. +. +.P +The output format from vfsstat may change over time; use the +comma\-separated output for a stable output format\. diff --git a/usr/src/man/man1m/vndadm.1m b/usr/src/man/man1m/vndadm.1m new file mode 100644 index 0000000000..253518a88a --- /dev/null +++ b/usr/src/man/man1m/vndadm.1m @@ -0,0 +1,651 @@ +'\" 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 VNDADM 1M "Mar 06, 2014" +.SH NAME +vndadm \- administer vnd devices + +.SH SYNOPSIS + +.nf +vndadm create [-z zonename] [-l datalink] device +vndadm destroy [-z zonename] device... +vndadm list [-p] [-d delim] [-o field,...] [-z zonename] [device]... +vndadm get [-p] [-d delim] [-z zonename] device [prop]... +vndadm set [-z zonename] device prop=val... +.fi + +.SH DESCRIPTION +.sp +.LP +The vndadm command is used to administer vnd devices. A vnd device is +similar to an IP network interface, except that the vnd device operates +at layer two. A vnd device is created over a data link (see dladm(1M)) +and its address is that of the underlying data link. For ethernet based +devices, that address would be the MAC address of the data link. vnd +devices are character devices which may be used to send and receive +layer two packets. When reading or writing to a vnd device, the full +frame must be present. This is useful for working with virtual machines, +or other environments where you need to manipulate the entire layer two +frame. + +.sp +.LP +Every command takes a device as an argument. To specify a vnd device, +you just use the name of the device. Devices are scoped to zones. If no +zone is specified, the current zone is assumed. A device name can be any +series of alphanumeric ascii characters which typically match the name +of the underlying data link. A given vnd device name must be unique in a +given zone, but the same name can be used across zones. +.sp +.SH OPTIONS +.sp +.LP +All vndadm subcommands have the following common option: +.sp +.ne 2 +.na +-z zonename +.ad +.sp .6 +.RS 4n +Operate in the context of the specified zone. When creating a vnd +device, the named device is created in the specified zone. All other +operations scope the device lookup to the specified zone. If the user is +not in the global zone, the use of -z will not work. + +.sp +.LP +When -z is used and multiple devices are specified, then +the use of -z applies to all of the devices. +.RE + +.SH SUBCOMMANDS +.sp +.ne 2 +.na +vndadm create [-z zonename] [-l datalink] device +.ad +.sp +.RS 4n +Creates a vnd device with the specified name device. If -l datalink is +not specified, it is assumed that the data link and the device share the +same name. The created device will exist for as long as the zone exists +or until a call to vndadm destroy. vnd devices do not persist across +system reboots. Note, if an IP interface or another libdlpi(3LIB) +consumer is already using the data link, then vnd will fail. + +.sp +The maximum length of the name of device is 31 characters. The allowed +set of characters is alphanumberic characters, ':', \'-', and \'_'. The +names 'zone' and 'ctl' are reserved and may not be used. + +.sp +.ne 2 +.na +-l datalink +.ad +.sp .6 +.RS 4n +Specifies the name of the data link to create the device over. This +allows the vnd device name to be different from the data link's name. +.RE +.sp +.ne 2 +.na +-z zonename +.ad +.sp .6 +.RS 4n +See OPTIONS above. +.RE + +.RE + +.sp +.ne 2 +.na +vndadm destroy [-z zonename] device... +.ad +.sp +.RS 4n +Destroys the specified device. The destruction is analogous to +unlink(2). If the device is still open and used by applications, the +device will continue to exist, but it will no longer be accessible by +the name device. +.sp +.ne 2 +.na +-z zonename +.ad +.sp .6 +.RS 4n +See OPTIONS above. +.RE +.RE + +.sp +.ne 2 +.na +vndadm list [-p] [-d delim] [-o field,...] [-z zonename] [device]... +.ad +.sp +.RS 4n +Lists active vnd devices. By default, vnadm list lists all devices in +every zone that the caller is allowed to see; the current zone if in the +non-global zone, and all zones in the global zone. If device is +specified one or more times, then output will be limited to the +specified devices. +.sp +.ne 2 +.na +-o field[,...] +.ad +.sp .6 +.RS 4n +A case-insensitive, comma-separated list of output fields. When -o is +not used, all of the fields listed below are shown. The field name must +be one of the following fields: + +.sp +.ne 2 +.na +NAME +.ad +.sp .6 +.RS 4n +The name of the vnd device. +.RE + +.sp +.ne 2 +.na +DATALINK +.ad +.sp .6 +.RS 4n +The name of the data link the vnd device was created over. +.RE + +.sp +.ne 2 +.na +ZONENAME +.ad +.sp .6 +.RS 4n +The name of the zone that the vnd device exists in. +.RE +.RE + +.sp +.ne 2 +.na +-p +.ad +.sp .6 +.RS 4n +Display the output in a stable machine parseable format. The -o option +is required with the -p option. See "Parseable Output Format" below. +.RE + +.sp +.ne 2 +.na +-d delim +.ad +.sp .6 +.RS 4n +Change the delimiter used in conjunction with generating parseable +output. This option may only be specified when -p is also specified. +.RE + +.sp +.ne 2 +.na +-z zonename +.ad +.sp .6 +.RS 4n +See OPTIONS above. +.RE + +.RE + + +.sp +.ne 2 +.na +vndadm get [-p] [-d delim] [-z zonename] device [prop]... +.ad +.sp +.RS 4n +Displays the properties for the specified device. By default, all +properties of a given device are displayed. If prop is specified one or +more times, then only the specified properties will be displayed for +device. For a list of properties, see the section "Properties" below. +The property output consists of the following four columns: +.sp +.ne 2 +.na +LINK +.ad +.sp .6 +.RS 4n +The name of the device +.RE + +.sp +.ne 2 +.na +PROPERTY +.ad +.sp .6 +.RS 4n +The name of the property. Note that some properties that are private to +the implementation may be displayed. Those properties begin with a +leading underscore. +.RE + +.sp +.ne 2 +.na +PERM +.ad +.sp .6 +.RS 4n +Describes whether the property is read-only or +if it is read-write. This field does not +indicate if the current user has permission, but +lists permissions for a privileged user. +.RE + +.sp +.ne 2 +.na +VALUE +.ad +.sp .6 +.RS 4n +The value of the property. +.RE + +.sp +.ne 2 +.na +-p +.ad +.sp .6 +.RS 4n +Display the output in a stable machine parseable format. See "Parseable +Output Format" below. +.RE + +.sp +.ne 2 +.na +-d delim +.ad +.sp .6 +.RS 4n +Change the delimiter used in conjunction with generating parseable +output. This option may only be specified when -p is also specified. +.RE + +.sp +.ne 2 +.na +-z zonename +.ad +.sp .6 +.RS 4n +See OPTIONS above. +.RE +.RE + +.sp +.ne 2 +.na +vndadm set [-z zonename] device prop=val... +.ad +.sp +.RS 4n +Sets properties on the named device. Setting a property takes effect for +all operations on the device, after the program returns. Multiple +properties can be set at once; however, properties are applied one at a +time to the device. Property names and values must be separated with an +equals sign. Additional property and value pairs should be separated by +white space. For a list of properties, see the section "Properties" +below. + +.sp +.ne 2 +.na +-z zonename +.ad +.sp .6 +.RS 4n +See OPTIONS above. +.RE +.RE + +.SS Parseable Output Format +.sp +.LP +The default output for parseable data is to be separated with a single +ascii space character. The delimiter may be changed with the -d +option. When parseable output is requested, no numbers that represent +sizes will be displayed in human readable form, they will be fully +expanded. eg. the number 42K will instead be 43008. + +.SS Properties +.sp +.LP +The following are supported and stable properties. Note that any +properties that starts with a leading underscore are not a stable +property and may be removed at any time. + +.sp +.ne 2 +.na +rxbuf +.ad +.sp .6 +.RS 4n +A read/write property that controls the size of the receive buffer for +the device. All received data enters the receive buffer until a consumer +consumes it. If adding a received frame would exceed the size of the +receive buffer, then that frame will be dropped. The maximum size of the +buffer is limited by the 'maxsize' property. The minimum size of the +buffer is the value of the 'maxtu' property. The property's value may be +anything between that maximum and minimum. When setting this property, +standard size suffixes such as 'K' and 'M' may be used. +.RE + +.sp +.ne 2 +.na +txbuf +.ad +.sp .6 +.RS 4n +A read/write property that controls the size of the transmit buffer. All +in-flight transmitted data must be able to fit into the transmit buffer +to account for potential flow control events. If there is not enough +space in the transmit buffer, transmit related I/O operations will +either block or fail based on whether the file has been put into +non-blocking mode by setting O_NONBLOCK or O_NDELAY with fcntl(2). The +maximum size of the buffer is limited by the 'maxsize' property. The +minimum size of the buffer is the value of the 'maxtu' property. The +property's value may be anything between that maximum and minimum. When +setting this property, standard size suffixes such as 'K' and 'M' may be +used. + +.RE + +.sp +.ne 2 +.na +maxsize +.ad +.sp .6 +.RS 4n +A read-only property that describes the maximum size of buffers in the +system. Properties such as rxbuf and txbuf cannot be set beyond this. +.RE + +.sp +.ne 2 +.na +mintu +.ad +.sp .6 +.RS 4n +A read-only property that describes the minimum size of a frame +transmitted to the underlying data link. Note that the minimum listed +here may be less than the size of a valid layer two frame and therefore +may be dropped. A frame smaller than this value will be rejected by vnd. +.RE + +.sp +.ne 2 +.na +maxtu +.ad +.sp .6 +.RS 4n +A read-only property that describes the maximum size of a frame +transmitted to the underlying data link. A frame larger than this value +will be rejected by vnd. +.RE + +.SH EXAMPLES +.LP +Example 1 Creating a vnd device +.sp +.LP +To create a vnd device over the VNIC named net0, enter the following +command: + +.sp +.in +2 +.nf +# vndadm create net0 +.fi +.in -2 +.sp + +.LP +Example 2 Creating a vnd device in another zone +.sp +.LP + +To create a vnd device over the VNIC named net1 in the zone +1b7155a4-aef9-e7f0-d33c-9705e4b8b525, enter the following command: + +.sp +.in +2 +.nf +# vndadm create -z 1b7155a4-aef9-e7f0-d33c-9705e4b8b525 net1 +.fi +.in -2 +.sp + +.LP +Example 3 Destroying a vnd device +.sp +.LP + +To destroy the vnd device named net0, enter the following command: + +.sp +.in +2 +.nf +# vndadm destroy net0 +.fi +.in -2 +.sp + +.LP +Example 4 Destroying a vnd device in another zone +.sp +.LP + +To destroy the vnd device named net1 in the zone +1b7155a4-aef9-e7f0-d33c-9705e4b8b525, enter the following command: + +.sp +.in +2 +.nf +# vndadm destroy -z 1b7155a4-aef9-e7f0-d33c-9705e4b8b525 net1 +.fi +.in -2 +.sp + +.LP +Example 5 List all vnd devices +.sp +.LP + +To list all devices, run the following command: + +.sp +.in +2 +.nf +# vndadm list +NAME DATALINK ZONENAME +net0 net0 global +net0 net0 1b7155a4-aef9-e7f0-d33c-9705e4b8b525 +.fi +.in -2 +.sp + +.LP +Example 6 Listing devices in a specific zone +.sp +.LP + +To list devices in a specific zone, run the following command: + +.sp +.in +2 +.nf +# vndadm list -z 1b7155a4-aef9-e7f0-d33c-9705e4b8b525 + +NAME DATALINK ZONENAME +net0 net0 1b7155a4-aef9-e7f0-d33c-9705e4b8b525 +.fi +.in -2 +.sp + +.LP +Example 7 List all devices in a parseable format +.sp +.LP + +To list all devices in a parseable format with the delimiter of ':', run +the following command: + +.sp +.in +2 +.nf +# vndadm list -p -d: -o name,datalink,zone +net0:net0:global +net0:net0:1b7155a4-aef9-e7f0-d33c-9705e4b8b525 +.fi +.in -2 +.sp + +.LP +Example 8 Retrieving all properties for a device +.sp +.LP + +To retrieve all of the properties for the vnd device foo0, run the +following command: + +.sp +.in +2 +.nf +# vndadm get foo0 +LINK PROPERTY PERM VALUE +foo0 rxbuf rw 65536 +foo0 txbuf rw 65536 +foo0 maxsize r- 4194304 +foo0 mintu r- 0 +foo0 maxtu r- 1518 +foo0 _nflush rw 10 +foo0 _burstsz rw 10 +.fi +.in -2 +.sp + +.LP +Example 9 Retrieving specific properties for a device +.sp +.LP + +To retrieve just the rxbuf and txbuf properties for the vnd device foo0, +run the following command: + +.sp +.in +2 +.nf +# vndadm get foo0 rxbuf txbuf +LINK PROPERTY PERM VALUE +foo0 rxbuf rw 65536 +foo0 txbuf rw 65536 +.fi +.in -2 +.sp + +.LP +Example 10 Retrieving properties for a device in a parseable format +.sp +.LP + +To retrieve all properties for the vnd device foo0 in a parseable +format, run the following command: + +.sp +.in +2 +.nf +# vndadm get -p foo0 +foo0 rxbuf rw 65536 +foo0 txbuf rw 65536 +foo0 maxsize r- 4194304 +foo0 mintu r- 0 +foo0 maxtu r- 1518 +foo0 _nflush rw 10 +foo0 _burstsz rw 10 +.fi +.in -2 +.sp + +.LP +Example 11 Setting a property on a device +.sp +.LP + +To set the receive buffer size to one megabyte on the device foo0, run +the following command: + +.sp +.in +2 +.nf +# vndadm set foo0 rxbuf=1M +.fi +.in -2 +.sp + +.LP +Example 12 Setting multiple properties on a device +.sp +.LP + +To set the transmit buffer to 300 Kb and the receive buffer to 1 Mb, run +the following command: + +.sp +.in +2 +.nf +# vndadm set foo0 rxbuf=300K txbuf=1M +.fi +.in -2 +.sp + +.SH SEE ALSO + +dladm(1M), ipadm(1M), fcntl(2), fcntl.h(3HEAD), libvnd(3LIB), +vndstat(1M), vnd(7D) diff --git a/usr/src/man/man1m/vndstat.1m b/usr/src/man/man1m/vndstat.1m new file mode 100644 index 0000000000..a7f843e228 --- /dev/null +++ b/usr/src/man/man1m/vndstat.1m @@ -0,0 +1,163 @@ +'\" 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 VNDSTAT 1M "Mar 06, 2014" +.SH NAME +vndstat \- report vnd activity + +.SH SYNOPSIS + +vndstat [interval [count]] + +.SH DESCRIPTION +.sp +.LP +The vndstat command reports a summary of per-device vnd +activity. Once per interval it prints a table of statistics per +device. In the global zone, vndstat reports on all devices in the +system. From the non-global zone, it only reports on devices that are +present in that zone. vndstat reports on all vnd devices +that exist, including anonymous devices which are not linked into the +file system. +.sp +.LP +The vndstat command's output includes the following information: +.sp +.ne 2 +.na +.B name +.ad +.RS 14n +The name of the device, if bound. If a given vnd device is not +bound into the file system, hence considered anonymous, then there will +be no name for the device. +.RE + +.sp +.ne 2 +.na +.B rx B/s +.ad +.RS 14n +The number of bytes received by the device during interval. +.RE + +.sp +.ne 2 +.na +.B tx B/s +.ad +.RS 14n +The number of bytes transmitted by the device during interval. +.RE + +.sp +.ne 2 +.na +.B drops +.ad +.RS 14n +The number of packets and messages which have been dropped. This +includes all drops due to insufficient buffer space, IP hooks, and +unknown or malformed DLPI messages. +.RE + +.sp +.ne 2 +.na +.B txfc +.ad +.RS 14n +The number of flow control events that have occurred. A flow control +event occurs when the layers below vnd request that all transmits +be paused until a future call resumes the flow. This statistic is +incremented when the flow is resumed. It is not incremented when it is +first paused. +.RE + +.sp +.ne 2 +.na +.B zone +.ad +.RS 14n +The name of the zone the device is located in. +.RE + +.SH OPTIONS + +.sp +.ne 2 +.na +interval +.ad +.RS 13n +Report once each interval seconds. interval may not be +fractional. +.RE + +.sp +.ne 2 +.na +count +.ad +.RS 13n +Only print count reports, then exit. +.RE +.sp +.LP +When no arguments are given to vndstat, it will always print at an +interval of one second. Reports will continue until vndstat +is terminated. + +.SH EXAMPLES +.LP +Example 1 Print five seconds of data + +.sp +.in +2 +.nf +example% vndstat 1 5 + name | rx B/s | tx B/s | drops txfc | zone + net0 | 1.45MB/s | 14.1KB/s | 0 0 | 1b7155a4-aef9-e7f0-d33c-9705e4b8b525 + net0 | 3.50MB/s | 19.5KB/s | 0 0 | 1b7155a4-aef9-e7f0-d33c-9705e4b8b525 + net0 | 2.83MB/s | 30.8KB/s | 0 0 | 1b7155a4-aef9-e7f0-d33c-9705e4b8b525 + net0 | 3.08MB/s | 30.6KB/s | 0 0 | 1b7155a4-aef9-e7f0-d33c-9705e4b8b525 + net0 | 3.21MB/s | 30.6KB/s | 0 0 | 1b7155a4-aef9-e7f0-d33c-9705e4b8b525 +.fi +.in -2 +.sp + +.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 See below. +.TE + +.sp +.LP +Invocation is evolving. Human readable output is unstable. +.SH SEE ALSO + +dlstat(1M), nicstat(1M), vndadm(1M), vnd(7M) diff --git a/usr/src/man/man1m/zfs.1m b/usr/src/man/man1m/zfs.1m index 33f2b54b34..c0edc2e780 100644 --- a/usr/src/man/man1m/zfs.1m +++ b/usr/src/man/man1m/zfs.1m @@ -23,7 +23,7 @@ .\" Copyright 2011 Joshua M. Clulow <josh@sysmgr.org> .\" Copyright (c) 2011, 2016 by Delphix. All rights reserved. .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved. -.\" Copyright (c) 2014, Joyent, Inc. All rights reserved. +.\" Copyright (c) 2015, Joyent, Inc. All rights reserved. .\" Copyright (c) 2014 by Adam Stevko. All rights reserved. .\" Copyright (c) 2014 Integros [integros.com] .\" Copyright 2016 Nexenta Systems, Inc. diff --git a/usr/src/man/man1m/zoneadm.1m b/usr/src/man/man1m/zoneadm.1m index 1ddfc1356a..1056bb92d2 100644 --- a/usr/src/man/man1m/zoneadm.1m +++ b/usr/src/man/man1m/zoneadm.1m @@ -1,6 +1,7 @@ '\" te .\" Copyright 2015 Nexenta Systems, Inc. All rights reserved. .\" Copyright (c) 2009 Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2011 Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -128,12 +129,14 @@ Use the following command to attach a zone: .sp .ne 2 .na -\fB\fBboot\fR [\fB--\fR \fIboot_options\fR]\fR +\fB\fBboot\fR [\fB-X\fR] [\fB--\fR \fIboot_options\fR]\fR .ad .sp .6 .RS 4n Boot (or activate) the specified zones. .sp +The \fI-X\fR option enables debug for the zone's brand while booting. +.sp The following \fIboot_options\fR are supported: .sp .ne 2 @@ -248,12 +251,25 @@ The source zone must be halted before this subcommand can be used. .sp .ne 2 .na -\fB\fBhalt\fR\fR +\fB\fBhalt [\fB-X\fR]\fR\fR .ad .sp .6 .RS 4n Halt the specified zones. \fBhalt\fR bypasses running the shutdown scripts inside the zone. It also removes run time resources of the zone. +.sp +The \fI-X\fR option enables debug for the zone's brand while halting. +.sp +Use: +.sp +.in +2 +.nf +zlogin \fIzone\fR shutdown +.fi +.in -2 +.sp + +to cleanly shutdown the zone by running the shutdown scripts. .RE .sp @@ -403,24 +419,28 @@ and normal restrictions for \fIzonepath\fR apply. .sp .ne 2 .na -\fB\fBready\fR\fR +\fB\fBready [\fB-X\fR]\fR\fR .ad .sp .6 .RS 4n Prepares a zone for running applications but does not start any user processes in the zone. +.sp +The \fI-X\fR option enables debug for the zone's brand while readying. .RE .sp .ne 2 .na -\fB\fBreboot\fR\ [\fB--\fR \fIboot_options\fR]]\fR +\fB\fBreboot\fR\ [\fB-X\fR] [\fB--\fR \fIboot_options\fR]]\fR .ad .sp .6 .RS 4n Restart the zones. This is equivalent to a \fBhalt\fR \fBboot\fR sequence. This subcommand fails if the specified zones are not active. See \fIboot\fR subcommand for the boot options. +.sp +The \fI-X\fR option enables debug for the zone's brand while rebooting. .RE .sp diff --git a/usr/src/man/man1m/zonecfg.1m b/usr/src/man/man1m/zonecfg.1m index 5371592ade..55a768cf41 100644 --- a/usr/src/man/man1m/zonecfg.1m +++ b/usr/src/man/man1m/zonecfg.1m @@ -1,6 +1,6 @@ '\" te .\" Copyright (c) 2004, 2009 Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2013 Joyent, Inc. All Rights Reserved. +.\" Copyright 2015 Joyent, Inc. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -10,17 +10,17 @@ zonecfg \- set up zone configuration .SH SYNOPSIS .LP .nf -\fBzonecfg\fR \fB-z\fR \fIzonename\fR +\fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} .fi .LP .nf -\fBzonecfg\fR \fB-z\fR \fIzonename\fR \fIsubcommand\fR +\fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} \fIsubcommand\fR .fi .LP .nf -\fBzonecfg\fR \fB-z\fR \fIzonename\fR \fB-f\fR \fIcommand_file\fR +\fBzonecfg\fR {\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} \fB-f\fR \fIcommand_file\fR .fi .LP @@ -42,7 +42,8 @@ The following synopsis of the \fBzonecfg\fR command is for interactive usage: .sp .in +2 .nf -zonecfg \fB-z\fR \fIzonename subcommand\fR +{\fB-z\fR \fIzonename\fR | \fB-u\fR \fIuuid\fR} +zonecfg {\fB-z\fR \fIzonename | \fB-u\fR \fIuuid} subcommand\fR .fi .in -2 .sp @@ -344,6 +345,16 @@ The following properties are supported: .sp .ne 2 .na +\fB(global)\fR +.ad +.sp .6 +.RS 4n +\fBzfs-io-priority\fR +.RE + +.sp +.ne 2 +.na \fB\fBfs\fR\fR .ad .sp .6 @@ -358,7 +369,7 @@ The following properties are supported: .ad .sp .6 .RS 4n -\fBaddress\fR, \fBphysical\fR, \fBdefrouter\fR +\fBaddress\fR, \fBallowed-address\fR, \fBdefrouter\fR, \fBglobal-nic\fR, \fBmac-addr\fR, \fBphysical\fR, \fBproperty\fR, \fBvlan-id\fR .RE .sp @@ -631,7 +642,17 @@ Values needed to determine how, where, and so forth to mount file systems. See .sp .ne 2 .na -\fB\fBnet\fR: address, physical, defrouter\fR +\fB\fBinherit-pkg-dir\fR: dir\fR +.ad +.sp .6 +.RS 4n +The directory path. +.RE + +.sp +.ne 2 +.na +\fB\fBnet\fR: address, allowed-address, defrouter, global-nic, mac-addr, physical, property, vlan-id\fR .ad .sp .6 .RS 4n @@ -670,6 +691,10 @@ zone. However, if the interface is not used by the global zone, it should be configured \fBdown\fR in the global zone, and the default router for the interface should be specified here. .sp +The global-nic is used for exclusive stack zones which will use a VNIC on-demand. When the zone boots, a VNIC named using the physical property will be created on the global NIC. If provided, the mac-addr and vlan-id will be set on this VNIC. +.sp +The \fBproperty\fR setting is a resource which can be used to set arbitrary name/value pairs on the network. These name/value pairs are made available to the zone's brand, which can use them as needed to set up the network interface. +.sp For an exclusive-IP zone, the physical property must be set and the address and default router properties cannot be set. .RE @@ -801,7 +826,7 @@ property is not specified, the scheduling class is established as follows: .ie t \(bu .el o If the \fBcpu-shares\fR property or equivalent rctl is set, the scheduling -class FSS is used. +class \fBFSS\fR is used. .RE .RS +4 .TP @@ -817,10 +842,15 @@ used. .el o Under any other conditions, the system default scheduling class is used. .RE +.sp +If the \fBFX\fR scheduling class is specified, then the optional +\fBfixed-hi-pri\fR attribute can be set to \fBtrue\fR. This causes all of the +processes in the zone to run at the highest \fBFX\fR priority. By default +processes under \fBFX\fR run at the lowest priority. See \fBpriocntl\fR(2) +for details on each scheduling class. .RE - .sp .ne 2 .na @@ -913,6 +943,16 @@ is not supported. .RE .sp +.ne 2 +.na +\fBglobal: \fBzfs-io-priority\fR\fR +.ad +.sp .6 +.RS 4n +Specifies a priority for this zone's ZFS I/O. The priority is used by the ZFS I/O scheduler as in input to determine how to schedule I/O across zones. By default all zones have a priority of 1. The value can be increased for zones whose I/O is more critical. This property is the preferred way to set the \fBzone.zfs-io-priority\fR rctl. +.RE + +.sp .LP The following table summarizes resources, property-names, and types: .sp @@ -935,13 +975,22 @@ resource property-name type (global) max-shm-ids simple (global) max-shm-memory simple (global) scheduling-class simple +(global) zfs-io-priority simple fs dir simple special simple raw simple type simple options list of simple net address simple + allowed-address simple + defrouter simple + global-nic simple + mac-addr simple physical simple + property list of complex + name simple + value simple + vlan-id simple device match simple rctl name simple value list of complex @@ -1155,6 +1204,16 @@ name \fBglobal\fR and all names beginning with \fBSUNW\fR are reserved and cannot be used. .RE +.sp +.ne 2 +.na +\fB\fB-u\fR \fIuuid\fR\fR +.ad +.sp .6 +.RS 4n +Specify the uuid of a zone instead of the Zone name. +.RE + .SH SUBCOMMANDS .LP You can use the \fBadd\fR and \fBselect\fR subcommands to select a specific @@ -1244,8 +1303,7 @@ correct to be committed, this operation automatically does a verify. .sp .ne 2 .na -\fB\fBcreate [\fR\fB-F\fR\fB] [\fR \fB-a\fR \fIpath\fR |\fB-b\fR \fB|\fR -\fB-t\fR \fItemplate\fR\fB]\fR\fR +\fB\fBcreate [\fR\fB-F\fR\fB] [\fR \fB-a\fR \fIpath\fR |\fB-b\fR \fB|\fR \fB-t\fR \fItemplate\fR\fB] [\fR\fB-X\fR\fB]\fR\fR .ad .sp .6 .RS 4n @@ -1267,6 +1325,8 @@ configured, it should be installed using the "\fBzoneadm attach\fR" command .sp Use the \fB-b\fR option to create a blank configuration. Without arguments, \fBcreate\fR applies the Sun default settings. +.sp +Use the \fB-X\fR option to facilitate creating a zone whose XML definition already exists on the host. The zone will be atomically added to the zone index file. .RE .sp @@ -1343,18 +1403,21 @@ which is currently being added or modified. .sp .ne 2 .na -\fB\fBremove\fR \fIresource-type\fR\fB{\fR\fIproperty-name\fR\fB=\fR\fIproperty --value\fR\fB}\fR(global scope)\fR +\fB\fBremove\fR [\fR\fB-F\fR\fB] \fIresource-type\fR\fB [\fR\fIproperty-name\fR\fB=\fR\fIproperty-value\fR\fB]* \fR(global scope)\fR +.br +\fB\fBremove\fR \fR\fIproperty-name\fR\fB \fR\fIproperty-value\fR\fB \fR(resource scope)\fR .ad .sp .6 .RS 4n In the global scope, removes the specified resource. The \fB[]\fR syntax means -0 or more of whatever is inside the square braces. If you want only to remove a +0 or more property name-value pairs. If you want to only remove a single instance of the resource, you must specify enough property name-value pairs for the resource to be uniquely identified. If no property name-value pairs are specified, all instances will be removed. If there is more than one -pair is specified, a confirmation is required, unless you use the \fB-F\fR -option. +pair specified, a confirmation is required, unless you use the \fB-F\fR +option. Likewise, the \fB-F\fR option can be used to remove a resource that +does not exist (that is, no error will occur). In the resource scope, remove +the specified name-value pair. .RE .sp @@ -1884,7 +1947,7 @@ Interface Stability Volatile \fBppriv\fR(1), \fBprctl\fR(1), \fBzlogin\fR(1), \fBkstat\fR(1M), \fBmount\fR(1M), \fBpooladm\fR(1M), \fBpoolcfg\fR(1M), \fBpoold\fR(1M), \fBrcapd\fR(1M), \fBrctladm\fR(1M), \fBsvcadm\fR(1M), \fBsysidtool\fR(1M), -\fBzfs\fR(1M), \fBzoneadm\fR(1M), \fBpriv_str_to_set\fR(3C), +\fBzfs\fR(1M), \fBzoneadm\fR(1M), \fBpriocntl\fR(2), \fBpriv_str_to_set\fR(3C), \fBkstat\fR(3KSTAT), \fBvfstab\fR(4), \fBattributes\fR(5), \fBbrands\fR(5), \fBfnmatch\fR(5), \fBlx\fR(5), \fBprivileges\fR(5), \fBresource_controls\fR(5), \fBsecurity-flags\fR(5), \fBzones\fR(5) diff --git a/usr/src/man/man1m/zpool.1m b/usr/src/man/man1m/zpool.1m index eadb5482be..db714ef595 100644 --- a/usr/src/man/man1m/zpool.1m +++ b/usr/src/man/man1m/zpool.1m @@ -20,6 +20,7 @@ .\" .\" .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2013, Joyent, Inc. All Rights Reserved. .\" Copyright (c) 2013 by Delphix. All rights reserved. .\" Copyright 2016 Nexenta Systems, Inc. .\" diff --git a/usr/src/man/man3c/Makefile b/usr/src/man/man3c/Makefile index 61591de7e7..4b8e8336a0 100644 --- a/usr/src/man/man3c/Makefile +++ b/usr/src/man/man3c/Makefile @@ -210,6 +210,9 @@ MANFILES= __fbufsize.3c \ imaxdiv.3c \ index.3c \ initgroups.3c \ + inotify_init.3c \ + inotify_add_watch.3c \ + inotify_rm_watch.3c \ insque.3c \ is_system_labeled.3c \ isaexec.3c \ diff --git a/usr/src/man/man3c/inotify_add_watch.3c b/usr/src/man/man3c/inotify_add_watch.3c new file mode 100644 index 0000000000..4f79e03c82 --- /dev/null +++ b/usr/src/man/man3c/inotify_add_watch.3c @@ -0,0 +1,120 @@ +'\" te +.\" Copyright (c) 2014, Joyent, Inc. All Rights Reserved. +.\" 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. +.TH INOTIFY_ADD_WATCH 3C "Sep 17, 2014" +.SH NAME +inotify_add_watch \- add a watch to an inotify instance +.SH SYNOPSIS + +.LP +.nf +#include <sys/inotify.h> + +\fBint\fR \fBinotify_add_watch\fR(\fBint\fR \fIfd\fR, \fBconst char *\fR\fIpathname\fR, \fBuint32_t\fR \fImask\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBinotify_add_watch()\fR function adds a watch for the file or +directory specified by \fIpathname\fR to the inotify instance +specified by \fIfd\fR for the events specified by \fImask\fR. See +\fBinotify\fR(5) for details on the meaning of \fImask\fR, how +it affects the interpretation of \fIpathname\fR, and how +events for the watched file or directory are subsequently +retrieved via \fBread\fR(2). + +.SH RETURN VALUES +.sp +.LP +Upon succesful completion, \fBinotify_add_watch()\fR returns the +watch descriptor associated with the new watch. +If an error occurs, -1 is returned and errno is set to indicate +the error. + +.SH ERRORS +.sp +.LP +\fBinotify_add_watch()\fR will fail if: +.sp +.ne 2 +.na +\fB\fBEACCES\fR\fR +.ad +.RS 10n +\fIpathname\fR could not be opened for reading. +.RE + +.sp +.ne 2 +.na +\fB\fBEBADF\fR\fR +.ad +.RS 10n +The \fIfd\fR argument is not a valid open file descriptor. +.RE + +.sp +.ne 2 +.na +\fB\fBEFAULT\fR\fR +.ad +.RS 10n +The memory associated with \fIpathname\fR was not mapped. +.RE + +.sp +.ne 2 +.na +\fB\fBEINVAL\fR\fR +.ad +.RS 10n +The \fIfd\fR argument does not correspond to an +\fBinotify\fR(5) instance as initialized with +\fBinotify_init\fR(3C) or \fBinotify_init1\fR(3C). +.RE + +.sp +.ne 2 +.na +\fB\fBENOSPC\fR\fR +.ad +.RS 10n +The number of watches on the specified instance would exceed the +maximum number of watches per \fBinotify\fR(5) instance. +.RE + +.sp +.ne 2 +.na +\fB\fBENOTDIR\fR\fR +.ad +.RS 10n +\fIpathname\fR does not correspond to a directory and +\fBIN_ONLYDIR\fR was specified in \fImask\fR. +.RE + +.sp +.SH NOTES +.sp +.LP + +While the \fBinotify\fR(5) facility is implemented for purposes of +offering compatibility for Linux-borne applications, native +applications may opt to use it instead of (or in addition to) the +\fBPORT_SOURCE_FILE\fR capability of event ports. See +\fBinotify\fR(5) for details and restrictions. + +.SH SEE ALSO +.sp +.LP +\fBinotify_init\fR(3C), \fBinotify_init1\fR(3C), +\fBport_create\fR(3C), \fBport_associate\fR(3C), \fBport_get\fR(3C), +\fBinotify\fR(5) diff --git a/usr/src/man/man3c/inotify_init.3c b/usr/src/man/man3c/inotify_init.3c new file mode 100644 index 0000000000..551a2ca798 --- /dev/null +++ b/usr/src/man/man3c/inotify_init.3c @@ -0,0 +1,107 @@ +'\" te +.\" Copyright (c) 2014, Joyent, Inc. All Rights Reserved. +.\" 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. +.TH INOTIFY_INIT 3C "Sep 17, 2014" +.SH NAME +inotify_init, inotify_init1 \- initialize an inotify instance +.SH SYNOPSIS + +.LP +.nf +#include <sys/inotify.h> + +\fBint\fR \fBinotify_init\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBinotify_init1\fR(\fBint\fR \fIflags\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBinotify_init()\fR and \fBinotify_init1()\fR functions both create an +\fBinotify\fR(5) instance that can be operated upon via +\fBinotify_add_watch\fR(3C), \fBinotify_rm_watch\fR(3C) and \fBread\fR(2). +\fBinotify\fR instances are +represented as file descriptors, and should be closed via \fBclose\fR(2). + +The only difference between the two functions is their signature; +\fBinotify_init()\fR takes no arguments, +while \fBinotify_init1()\fR takes a \fIflags\fR argument that can have +any of the following values: + +.sp +.ne 2 +.na +\fBIN_CLOEXEC\fR +.ad +.RS 12n +Instance should be closed upon an +\fBexec\fR(2); see \fBopen\fR(2)'s description of \fBO_CLOEXEC\fR. +.RE + +.sp +.ne 2 +.na +\fBIN_NONBLOCK\fR +.ad +.RS 12n +Instance will be set to be non-blocking. A \fBread\fR(2) on an +\fBinotify\fR instance that has been initialized with +\fBIN_NONBLOCK\fR will return \fBEAGAIN\fR if there are +no events enqueued in lieu of blocking. +.RE + +.SH RETURN VALUES +.sp +.LP +Upon succesful completion, 0 is returned. Otherwise, -1 is returned and errno +is set to indicate the error. +.SH ERRORS +.sp +.LP +The \fBinotify_init()\fR and \fBinotify_init1()\fR functions will fail if: +.sp +.ne 2 +.na +\fB\fBEINVAL\fR\fR +.ad +.RS 10n +The \fIflags\fR are invalid (\fBinotify_init1()\fR). +.RE + +.sp +.ne 2 +.na +\fB\fBEMFILE\fR\fR +.ad +.RS 10n +There are currently {\fBOPEN_MAX\fR} file descriptors open in the calling +process, or the maximum number of \fBinotify\fR instances for the user +would be exceeded. +.RE + +.sp +.SH NOTES +.sp +.LP + +While the \fBinotify\fR(5) facility is implemented for purposes of +offering compatibility for Linux-borne applications, native +applications may opt to use it instead of (or in addition to) the +\fBPORT_SOURCE_FILE\fR capability of event ports. See +\fBinotify\fR(5) for details and restrictions. + +.SH SEE ALSO +.sp +.LP +\fBinotiy_add_watch\fR(3C), \fBinotify_rm_watch\fR(3C), \fBinotify\fR(5) diff --git a/usr/src/man/man3c/inotify_rm_watch.3c b/usr/src/man/man3c/inotify_rm_watch.3c new file mode 100644 index 0000000000..de568f8e24 --- /dev/null +++ b/usr/src/man/man3c/inotify_rm_watch.3c @@ -0,0 +1,81 @@ +'\" te +.\" Copyright (c) 2014, Joyent, Inc. All Rights Reserved. +.\" 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. +.TH INOTIFY_RM_WATCH 3C "Sep 17, 2014" +.SH NAME +inotify_rm_watch \- remove a watch from an inotify instance +.SH SYNOPSIS + +.LP +.nf +#include <sys/inotify.h> + +\fBint\fR \fBinotify_rm_watch\fR(\fBint\fR \fIfd\fR, \fBint\fR \fIwd\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBinotify_rm_watch()\fR function removes the watch specified +by \fIwd\fR from the inotify instance associated with \fIfd\fR. +Removing a watch will induce an \fBIN_IGNORED\fR event; see +\fBinotify\fR(5) for details. + +.SH RETURN VALUES +.sp +.LP +Upon succesful completion, \fBinotify_add_watch()\fR returns the +watch descriptor associated with the new watch. +If an error occurs, -1 is returned and errno is set to indicate +the error. + +.SH ERRORS +.sp +.LP +\fBinotify_rm_watch()\fR will fail if: +.sp +.ne 2 +.na +\fB\fBEBADF\fR\fR +.ad +.RS 10n +The \fIfd\fR argument is not a valid open file descriptor. +.RE + +.sp +.ne 2 +.na +\fB\fBEINVAL\fR\fR +.ad +.RS 10n +The \fIfd\fR argument does not correspond to an +\fBinotify\fR(5) instance as initialized with +\fBinotify_init\fR(3C) or \fBinotify_init1\fR(3C), or +\fIwd\fR is not a valid watch for the specified inotify +instance. +.RE + +.sp +.SH NOTES +.sp +.LP + +While the \fBinotify\fR(5) facility is implemented for purposes of +offering compatibility for Linux-borne applications, native +applications may opt to use it instead of (or in addition to) the +\fBPORT_SOURCE_FILE\fR capability of event ports. See +\fBinotify\fR(5) for details and restrictions. + +.SH SEE ALSO +.sp +.LP +\fBinotify_init\fR(3C), \fBinotify_init1\fR(3C), +\fBport_create\fR(3C), \fBport_associate\fR(3C), \fBport_get\fR(3C), +\fBinotify\fR(5) diff --git a/usr/src/man/man3c/psignal.3c b/usr/src/man/man3c/psignal.3c index 655dedb022..a977fb6df4 100644 --- a/usr/src/man/man3c/psignal.3c +++ b/usr/src/man/man3c/psignal.3c @@ -1,16 +1,17 @@ '\" te .\" Copyright 1989 AT&T. Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2014, Joyent, Inc. All rights reserved. .\" Copyright 2015 Circonus, Inc. All rights reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH PSIGNAL 3C "Mar 31, 2005" +.TH PSIGNAL 3C "Aug 14, 2014" .SH NAME psignal, psiginfo \- system signal messages .SH SYNOPSIS .LP .nf -#include <siginfo.h> +#include <signal.h> \fBvoid\fR \fBpsignal\fR(\fBint\fR \fIsig\fR, \fBconst char *\fR\fIs\fR); .fi @@ -28,7 +29,9 @@ that may have been passed as the first argument to a signal handler. The \fIpinfo\fR argument is a pointer to a \fBsiginfo\fR structure that may have been passed as the second argument to an enhanced signal handler. See \fBsigaction\fR(2). The argument string \fIs\fR is printed first, followed by a -colon and a blank, followed by the message and a \fBNEWLINE\fR character. +colon and a blank, followed by the message and a \fBNEWLINE\fR character. If +\fBs\fR is the value \fBNULL\fR or an empty string, then nothing is printed for +the user's string and the colon and blank are omitted. .SH USAGE .LP Messages printed from these functions are in the native language specified by diff --git a/usr/src/man/man3c/timer_create.3c b/usr/src/man/man3c/timer_create.3c index 2f93e954e3..f57bf1d25f 100644 --- a/usr/src/man/man3c/timer_create.3c +++ b/usr/src/man/man3c/timer_create.3c @@ -9,7 +9,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH TIMER_CREATE 3C "Sep 15, 2015" +.TH TIMER_CREATE 3C "Mar 24, 2016" .SH NAME timer_create \- create a timer .SH SYNOPSIS @@ -125,17 +125,6 @@ system. The specified clock \fBID\fR, \fIclock_id\fR, is not defined. .RE -.sp -.ne 2 -.na -\fB\fBEPERM\fR\fR -.ad -.RS 10n -The specified clock \fBID\fR, \fIclock_id\fR, is \fBCLOCK_HIGHRES\fR and the -{\fBPRIV_PROC_CLOCK_HIGHRES\fR} is not asserted in the effective set of the -calling process. -.RE - .SH ATTRIBUTES .LP See \fBattributes\fR(5) for descriptions of the following attributes: @@ -159,5 +148,4 @@ Standard See \fBstandards\fR(5). .LP \fBexec\fR(2), \fBfork\fR(2), \fBtime\fR(2), \fBclock_settime\fR(3C), \fBsignal\fR(3C), \fBsignal.h\fR(3HEAD), \fBtimer_delete\fR(3C), -\fBtimer_settime\fR(3C), \fBattributes\fR(5), \fBprivileges\fR(5), -\fBstandards\fR(5) +\fBtimer_settime\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3c/timer_settime.3c b/usr/src/man/man3c/timer_settime.3c index 543f042aba..8ae32ccc91 100644 --- a/usr/src/man/man3c/timer_settime.3c +++ b/usr/src/man/man3c/timer_settime.3c @@ -1,5 +1,6 @@ '\" te .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 2016, Joyent, Inc. .\" Copyright 1989 AT&T .\" Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved. .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at @@ -9,7 +10,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH TIMER_SETTIME 3C "Feb 5, 2008" +.TH TIMER_SETTIME 3C "Mar 24, 2016" .SH NAME timer_settime, timer_gettime, timer_getoverrun \- per-process timers .SH SYNOPSIS @@ -103,6 +104,12 @@ set to \fBDELAYTIMER_MAX\fR. The value returned by \fBtimer_getoverrun()\fR applies to the most recent expiration signal delivery or acceptance for the timer. If no expiration signal has been delivered for the timer, the meaning of the overrun count returned is undefined. +.sp +.LP +If the specified timer is of type \fBCLOCK_HIGHRES\fR and the time value is +smaller than a system defined threshold, then {\fBPRIV_PROC_CLOCK_HIGHRES\fR} +must be asserted in the effective set of the calling process or the time values +will be adjusted up to the threshold value. .SH RETURN VALUES .sp .LP @@ -171,4 +178,5 @@ Standard See \fBstandards\fR(5). .sp .LP \fBtime.h\fR(3HEAD), \fBclock_settime\fR(3C), \fBtimer_create\fR(3C), -\fBtimer_delete\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) +\fBtimer_delete\fR(3C), \fBattributes\fR(5), \fBprivileges\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3dlpi/Makefile b/usr/src/man/man3dlpi/Makefile index cdd24216bd..4c5448f0be 100644 --- a/usr/src/man/man3dlpi/Makefile +++ b/usr/src/man/man3dlpi/Makefile @@ -41,10 +41,12 @@ MANFILES= dlpi_arptype.3dlpi \ dlpi_walk.3dlpi MANLINKS= dlpi_disabmulti.3dlpi \ + dlpi_open_zone.3dlpi \ dlpi_promiscoff.3dlpi dlpi_disabmulti.3dlpi := LINKSRC = dlpi_enabmulti.3dlpi +dlpi_open_zone.3dlpi := LINKSRC = man3dlpi/dlpi_open.3dlpi dlpi_promiscoff.3dlpi := LINKSRC = dlpi_promiscon.3dlpi .KEEP_STATE: diff --git a/usr/src/man/man3dlpi/dlpi_open.3dlpi b/usr/src/man/man3dlpi/dlpi_open.3dlpi index 8129a75404..489f66066a 100644 --- a/usr/src/man/man3dlpi/dlpi_open.3dlpi +++ b/usr/src/man/man3dlpi/dlpi_open.3dlpi @@ -1,9 +1,10 @@ '\" te .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2014, Joyent, Inc. All rights reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH DLPI_OPEN 3DLPI "Nov 17, 2008" +.TH DLPI_OPEN 3DLPI "Feb 24, 2014" .SH NAME dlpi_open \- open DLPI link .SH SYNOPSIS @@ -14,6 +15,9 @@ dlpi_open \- open DLPI link \fBint\fR \fBdlpi_open\fR(\fBconst char *\fR\fIlinkname\fR, \fBdlpi_handle_t *\fR\fIdhp\fR, \fBuint_t\fR \fIflags\fR); + +\fBint\fR \fBdlpi_open_zone\fR(\fBconst char *\fR\fIlinkname\fR, \fBconst char *\fR + \fIzonename\fR, \fBdlpi_handle_t *\fR\fIdhp\fR, \fBuint_t\fR \fIflags\fR); .fi .SH DESCRIPTION @@ -114,6 +118,18 @@ value ensures that \fBDLPI_ETIMEDOUT\fR is returned from a \fBlibdlpi\fR operation only in the event that the \fBDLPI\fR link becomes unresponsive. The timeout value can be changed with \fBdlpi_set_timeout\fR(3DLPI), although this should seldom be necessary. + +.sp +.LP +The \fBdlpi_open_zone()\fR function behaves as \fBdlpi_open()\fR, except that it +looks for the link specified by \fBlinkname\fR in the specified zone +\fBzonename\fR as opposed to the current zone. This function is only meaningful +from the global zone. Instead of scanning \fB/dev/net\fR, \fBdlpi_open_zone()\fR +scans \fB/dev/net/zone/<\fIzonename\fR> for the data link and +\fB/dev/ipnet/zone/<\fIzonename\fR> when DLPI_DEVIPNET is present in +\fBflags\fR. If a NULL or empty string is passed into \fBdlpi_open_zone()\fR, it +will behave as though \fBdlpi_open\fR has been called. + .SH RETURN VALUES .sp .LP @@ -124,7 +140,7 @@ section is returned. .SH ERRORS .sp .LP -The \fBdlpi_open()\fR function will fail if: +The \fBdlpi_open()\fR and \fBdlpi_open_zone()\fR function will fail if: .sp .ne 2 .na @@ -195,6 +211,17 @@ DLPI operation failed See \fBattributes\fR(5) for description of the following attributes: .sp +.LP +The \fBdlpi_open_zone()\fR function will fail if: +.sp +.ne 2 +.na +\fB\fBDLPI_EZONENAMEINVAL\fR\fR +.ad +.RS 25n +Invalid \fIzonename\fR argument +.RE + .sp .TS box; diff --git a/usr/src/man/man3lib/Makefile b/usr/src/man/man3lib/Makefile index 220ed2ae3e..a470f408fa 100644 --- a/usr/src/man/man3lib/Makefile +++ b/usr/src/man/man3lib/Makefile @@ -105,6 +105,7 @@ MANFILES= libMPAPI.3lib \ libumem.3lib \ libuuid.3lib \ libvolmgt.3lib \ + libvnd.3lib \ libw.3lib \ libxnet.3lib \ liby.3lib diff --git a/usr/src/man/man3lib/libvnd.3lib b/usr/src/man/man3lib/libvnd.3lib new file mode 100644 index 0000000000..ead69ff82e --- /dev/null +++ b/usr/src/man/man3lib/libvnd.3lib @@ -0,0 +1,690 @@ +'\" 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 LIBVND 3LIB "Mar 06, 2014" +.SH NAME +libvnd \- vnd library + +.SH SYNOPSIS +.LP +.nf +cc [ flag... ] file... -lvnd [ library... ] +#include <libvnd.h> +.fi + +.SH DESCRIPTION +.LP +The libvnd library provides a stable and programmatic interface to +vnd(7D) devices. vnd devices provide the means for creating a layer two +interface over a data link, similar to the use of libdlpi(3LIB) and +IP(7P). In dlpi parlance, a vnd device obtains data from all service +attachment points (SAP). For ethernet devices, this means that a vnd +device sends and receives traffic for all ethertypes. It is intended to +be used for services such as virtual machines which emulate layer two +devices. + +.LP +Handles to vnd(7D) devices are obtained through the use of vnd_create +and vnd_open. With a handle, I/O can be performed and properties on the +device can be set and retrieved. I/O on devices should be performed +through the vnd_frameio_read and vnd_frameio_write functions. A file +descriptor suitable for use with event ports and polling may be obtained +through vnd_pollfd. Handles are relinquished through calls to vnd_close; +however, devices will persist until vnd_unlink has been called. + +.LP +The rest of this manual documents the interfaces, properties, errors, +and threading model for libvnd. The in-depth description of individual +interfaces, their arguments, and examples, are in manual pages for each +provided interface. + + +.SH INTERFACES +.sp +.LP + +The shared object libvnd.so.1 provides the public interfaces defined +below. See Intro(3) for additional information on shared object +interfaces. Individual functions are documented in their own manual +pages. + +.sp +.TS +l l +l l . +vnd_create vnd_errno +vnd_open vnd_syserrno +vnd_unlink vnd_strerror +vnd_close vnd_strsyserror +vnd_pollfd vnd_walk +vnd_prop_get vnd_prop_set +vnd_prop_iter vnd_prop_writeable +vnd_frameio_read vnd_frameio_write +.TE + +.SH PROPERTIES + +.LP +The following table summarizes properties of a vnd device. The +properties can be retrieved and set with the functions +vnd_prop_get(3VND) and vnd_prop_set(3VND). Following the table, the +structures and properties are described in greater detail. + +.nf + +-------------------+---------------------+-------+ + | PROPERTY | STRUCTURE | PERM | + +-------------------+---------------------+-------+ + | VND_PROP_RXBUF | vnd_prop_buf_t | R/W | + +-------------------+---------------------+-------+ + | VND_PROP_TXBUF | vnd_prop_buf_t | R/W | + +-------------------+---------------------+-------+ + | VND_PROP_MAXBUF | vnd_prop_buf_t | R/- | + +-------------------+---------------------+-------+ + | VND_PROP_MINTU | vnd_prop_buf_t | R/- | + +-------------------+---------------------+-------+ + | VND_PROP_MAXTU | vnd_prop_buf_t | R/- | + +-------------------+---------------------+-------+ +.fi + +.SS Structures + +.LP +The vnd_prop_buf_t structure has the following members: + +.in +2 +.nf +uint64_t vpb_size; +.fi +.in -2 + +.LP +The vpb_size member refers to a size in bytes. When getting a property, +it represents the size of that property, when setting a property, it is +the size to set the property to. + + +.SS Property Descriptions +.sp +.ne 2 +.na +rxbuf +.ad +.sp .6 +.RS 4n +A read/write property that controls the size of the receive buffer for +the device. All received data enters the receive buffer until a consumer +consumes it. If adding a received frame would exceed the size of the +receive buffer, then that frame will be dropped. The maximum size of the +buffer is limited by the 'maxsize' property. +.RE + +.sp +.ne 2 +.na +txbuf +.ad +.sp .6 +.RS 4n +A read/write property that controls the size of the transmit buffer. All +in-flight transmitted data must be able to fix into the transmit buffer +to deal with potential flow control events. If there is not enough space +in the transmit buffer, transmit related I/O operations will either +block or fail based on whether or not O_NONBLOCK or O_NDELAY were set +with fcntl(2). +.RE + +.sp +.ne 2 +.na +maxsize +.ad +.sp .6 +.RS 4n +A read only property that describes the maximum size of buffers in the +system. Properties such as rxbuf and txbuf cannot be set beyond this. +.RE + +.sp +.ne 2 +.na +mintu +.ad +.sp .6 +.RS 4n +A read only property that describes the minimum size of a frame +transmitted to the underlying data link. Note that the minimum listed +here may be less than the size of a valid layer two frame and therefore +may be dropped. A frame smaller than this value will be rejected by vnd. +.RE + +.sp +.ne 2 +.na +maxtu +.ad +.sp .6 +.RS 4n +A read only property that describes the maximum size of +a frame transmitted to the underlying data link. A frame +larger than this value will be rejected by vnd. +.RE + + +.SH ERRORS +.sp +.LP +Most interfaces provided by libvnd provide a means to retrieve a +vnd_errno_t that describes an error that has occurred. The manuals for +individual interfaces describe whether or not this additional error +information is available and how to retrieve it. The following is a +complete list of the error numbers and their names as defined in +<sys/vnd_errno.h>. Any entries not listed here are private to the +implementation and may change at any time. + +.sp +.ne 2 +.na +0 VND_E_SUCCESS +.ad +.RS 23n +no error +.sp +This indicates that the operation completed successfully. +.RE + +.sp +.ne 2 +.na +1 VND_E_NOMEM +.ad +.RS 23n +not enough memory available +.sp +Insufficient memory was available. This is the equivalent of the +standard system errno ENOMEM. +.RE + +.sp +.ne 2 +.na +2 VND_E_NODATALINK +.ad +.RS 23n +no such datalink +.sp +The data link requested to be used as part of vnd_create does not exist +in the requested zone. +.RE + +.sp +.ne 2 +.na +3 VND_E_NOTETHER +.ad +.RS 23n +datalink not of type DL_ETHER +.sp +The data link used as part of a call to vnd_create is not an Ethernet +device. vnd_create only works with Ethernet devices at this time. +.RE + +.sp +.ne 2 +.na +4 VND_E_DLPIINVAL +.ad +.RS 23n +unknown dlpi failure +.sp +An unexpected DLPI message was received during vnd device +initialization. +.RE + +.sp +.ne 2 +.na +5 VND_E_ATTACHFAIL +.ad +.RS 23n +DL_ATTACH_REQ failed +.sp +During vnd device initialization, the dlpi call to attach to the +requested data link failed. +.RE + +.sp +.ne 2 +.na +6 VND_E_BINDFAIL +.ad +.RS 23n +DL_BIND_REQ failed +.sp + +During vnd device initialization, the dlpi call to bind to a service +attachment point on the data link failed. +.RE + +.sp +.ne 2 +.na +7 VND_E_PROMISCFAIL +.ad +.RS 23n +DL_PROMISCON_REQ failed +.sp + +During vnd device initialization, the dlpi call to enable promiscuous +mode on the underlying device failed. +.RE + +.sp +.ne 2 +.na +8 VND_E_DIRECTFAIL +.ad +.RS 23n +DLD_CAPAB_DIRECT enable failed +.sp +During vnd device initialization, the dlpi call to enable the DLD fast +path failed. +.RE + +.sp +.ne 2 +.na +9 VND_E_CAPACKINVAL +.ad +.RS 23n +bad datalink capability +.sp +During vnd device initialization, the kernel responded with an invalid +capability acknowledgement. +.RE + +.sp +.ne 2 +.na +10 VND_E_SUBCAPINVAL +.ad +.RS 23n +bad datalink subcapability +.sp +During vnd device initialization, the kernel responded with an invalid +sub-capability. +.RE + +.sp +.ne 2 +.na +11 VND_E_DLDBADVERS +.ad +.RS 23n +bad dld version +.sp +The vnd(7D) module does not support the version of the dld capability +that the kernel sent. As such, the data path could not be brought up and +the device could not be fully initialized. +.RE + +.sp +.ne 2 +.na +12 VND_E_KSTATCREATE +.ad +.RS 23n +failed to create kstats +.sp +During vnd device initialization, the necessary kstats could not be +created. +.RE + +.sp +.ne 2 +.na +13 VND_E_NODEV +.ad +.RS 23n +no such vnd link +.sp +During device initialization, the requested character device did not +exist. +.RE + +.sp +.ne 2 +.na +14 VND_E_NONETSTACK +.ad +.RS 23n +netstack doesn't exist +.sp +During device initialization, the networking stack for the device did +not exist. +.RE + +.sp +.ne 2 +.na +15 VND_E_ASSOCIATED +.ad +.RS 23n +device already associated +.sp +During vnd device initialization, the vnd STREAMS device was already +associated with another vnd device. +.RE + +.sp +.ne 2 +.na +16 VND_E_ATTACHED +.ad +.RS 23n +device already attached +.sp +The given vnd device has already been created over a data link and +cannot be created over another one. +.RE + +.sp +.ne 2 +.na +17 VND_E_LINKED +.ad +.RS 23n +device already linked +.sp +The given vnd device has already been given a name and bound into the +file system name space. +.RE + +.sp +.ne 2 +.na +18 VND_E_BADNAME +.ad +.RS 23n +invalid name +.sp +The requested name is not a valid name. Valid names are alphanumeric +ascii names, along with the following ascii characters: ':', '\-', and +\'_'. Names must be less than LIBVND_NAMELEN bytes including the null +terminator. +.RE + +.sp +.ne 2 +.na +19 VND_E_PERM +.ad +.RS 23n +permission denied +.sp +A request was made from a non-global zone to manipulate a vnd device +that belongs to a different zone. +.RE + +.sp +.ne 2 +.na +20 VND_E_NOZONE +.ad +.RS 23n +no such zone +.sp +A request was made which targeted a zone that did not exist. +.RE + +.sp +.ne 2 +.na +21 VND_E_STRINIT +.ad +.RS 23n +failed to initialize vnd stream module +.sp +During vnd device initialization, the vnd STREAMS module could not be +pushed onto the data link's stream head. +.RE + +.sp +.ne 2 +.na +22 VND_E_NOTATTACHED +.ad +.RS 23n +device not attached +.sp +A request was made that requires a vnd device be attached to a data +link, such as a call to change a property. The device was not attached +to a data link. +.RE + +.sp +.ne 2 +.na +23 VND_E_NOTLINKED +.ad +.RS 23n +device not linked +.sp +A request was made to a vnd device that requires the vnd device to be +named and present in /dev. The given device was not linked into /dev at +the time of the call. +.RE + +.sp +.ne 2 +.na +24 VND_E_LINKEXISTS +.ad +.RS 23n +another device has the same link name +.sp +When trying to link a given vnd device into a zones /dev name space, +another device already exists with the same name. +.RE + +.sp +.ne 2 +.na +25 VND_E_MINORNODE +.ad +.RS 23n +failed to create minor node +.sp +While trying to link a vnd device into the /devices and /dev name space, +the call to ddi_create_minor_node() failed. +.RE + +.sp +.ne 2 +.na +26 VND_E_BUFTOOBIG +.ad +.RS 23n +requested buffer size is too large +.sp +The requested buffer size exceeds the maximum valid value for the given +property. +.RE + +.sp +.ne 2 +.na +27 VND_E_BUFTOOSMALL +.ad +.RS 23n +requested buffer size is too small +.sp +The requested buffer size is less than the minimum buffer size. This +generally occurs when making the buffer size less than the maximum +transmission unit. +.RE + +.sp +.ne 2 +.na +28 VND_E_DLEXCL +.ad +.RS 23n +unable to obtain exclusive access to dlpi link, link busy +.sp +When a vnd device is created, it expects exclusive active access to the +device. If any other active dlpi consumers, such as IP, are already +using the device, then the vnd device will not be created. Passive +consumers, such as snoop, can still use a device that has been +exclusively opened. +.RE + +.sp +.ne 2 +.na +28 VND_E_DIRECTNOTSUP +.ad +.RS 23n +DLD direct capability not supported over data link +.sp +The data link that the vnd device was created over does not supported +the DLD Direct capability. As such, the data path could not be +initialized. +.RE + +.sp +.ne 2 +.na +30 VND_E_BADPROPSIZE +.ad +.RS 23n +invalid property size +.sp +The size of the data passed into vnd_prop_get or vnd_prop_set is +incorrect and does not match the expected data size. +.RE + +.sp +.ne 2 +.na +31 VND_E_BADPROP +.ad +.RS 23n +invalid property +.sp +An unknown property identifier was specified. For a list of valid +properties, see the section above entitled "PROPERTIES". +.RE + +.sp +.ne 2 +.na +32 VND_E_PROPRDONLY +.ad +.RS 23n +property is read only +.sp +An operation tried to update the value of a read only property. For a +list of which properties are read only and which are readable and +writeable, see the section above entitled "PROPERTIES". +.RE + +.sp +.ne 2 +.na +33 VND_E_SYS +.ad +.RS 23n +unexpected system error +.sp +This indicates that there is no vnd specific error available and that +the system errno is valid. The system errno can be obtained and printed +through vnd_syserrno and vnd_strsyserror. The possible values and their +meanings are documented in Intro(2). +.RE + +.sp +.ne 2 +.na +34 VND_E_CAPABPASS +.ad +.RS 23n +capabilities invalid, pass-through module detected +.sp +While negotiating capabilities, a pass-through module was detected and +the capability had to be discarded. Because of this, the data path could +not be initialized. +.RE + + +.SH THREADING + +.LP +The libvnd library is not truly MT-safe. MT-safety is provided on +the granularity of a given vnd_handle_t. Operations on a single +vnd_handle_t are unsafe; however, operations on different handles are +MT-safe. If a single vnd_handle_t is used by multiple threads, it +is the caller's responsibility to provide locking to ensure that +multiple threads aren't simultaneously calling into libvnd on a +single handle. + + +.SH FILES +.sp +.ne 2 +.na +/usr/lib/libvnd.so.1 +.ad +.RS 27n +shared object +.RE + +.sp +.ne 2 +.na +/usr/lib/64/libvnd.so.1 +.ad +.RS 27n +64-bit shared object +.RE + +.SH ATTRIBUTES + +.sp +.LP +See attributes(5) for descriptions of the following attributes: + +.sp +.TS +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Stability Committed +_ +MT-Level See "THREADING" +.TE + +.SH SEE ALSO + +.sp +.LP +attributes(5), Intro(2), fcntl(2), Intro(3), fcntl.h(3HEAD), libdlpi(3LIB), port_create(3C), vnd(7D) +.sp +.LP +vnd_close(3VND), vnd_create(3VND), vnd_errno(3VND), +vnd_frameio_read(3VND), vnd_frameio_write(3VND), vnd_open(3VND) +vnd_pollfd(3VND), vnd_prop_get(3VND), vnd_prop_iter(3VND), +vnd_prop_set(3VND), +vnd_prop_writeable(3VND), vnd_walk(3VND) diff --git a/usr/src/man/man3vnd/Makefile b/usr/src/man/man3vnd/Makefile new file mode 100644 index 0000000000..64abf9dcd6 --- /dev/null +++ b/usr/src/man/man3vnd/Makefile @@ -0,0 +1,70 @@ +# +# 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. +# + +include $(SRC)/Makefile.master + +MANSECT= 3vnd + +MANFILES= vnd_create.3vnd \ + vnd_errno.3vnd \ + vnd_frameio_read.3vnd \ + vnd_pollfd.3vnd \ + vnd_prop_get.3vnd \ + vnd_prop_iter.3vnd \ + vnd_prop_writeable.3vnd \ + vnd_walk.3vnd + +MANLINKS= frameio_t.3vnd \ + framevec_t.3vnd \ + vnd_close.3vnd \ + vnd_frameio_write.3vnd \ + vnd_open.3vnd \ + vnd_prop_set.3vnd \ + vnd_prop_iter_f.3vnd \ + vnd_strerror.3vnd \ + vnd_strsyserror.3vnd \ + vnd_syserrno.3vnd \ + vnd_unlink.3vnd \ + vnd_walk_cb_f.3vnd + +# vnd_create.3vnd +vnd_open.3vnd := LINKSRC = vnd_create.3vnd +vnd_unlink.3vnd := LINKSRC = vnd_create.3vnd +vnd_close.3vnd := LINKSRC = vnd_create.3vnd + +# vnd_errno.3vnd +vnd_strerror.3vnd := LINKSRC = vnd_errno.3vnd +vnd_syserrno.3vnd := LINKSRC = vnd_errno.3vnd +vnd_strsyserror.3vnd := LINKSRC = vnd_errno.3vnd + +# vnd_frameio_read.3vnd +vnd_frameio_write.3vnd := LINKSRC = vnd_frameio_read.3vnd +framevec_t.3vnd := LINKSRC = vnd_frameio_read.3vnd +frameio_t.3vnd := LINKSRC = vnd_frameio_read.3vnd + +# vnd_prop_get.3vnd +vnd_prop_set.3vnd := LINKSRC = vnd_prop_get.3vnd + +# vnd_prop_iter.3vnd +vnd_prop_iter_f.3vnd := LINKSRC = vnd_prop_iter.3vnd + +# vnd_walk.3vnd +vnd_walk_cb_f.3vnd := LINKSRC = vnd_walk.3vnd + +.KEEP_STATE: + +include $(SRC)/man/Makefile.man + +install: $(ROOTMANFILES) $(ROOTMANLINKS) diff --git a/usr/src/man/man3vnd/vnd_create.3vnd b/usr/src/man/man3vnd/vnd_create.3vnd new file mode 100644 index 0000000000..d29237a60c --- /dev/null +++ b/usr/src/man/man3vnd/vnd_create.3vnd @@ -0,0 +1,280 @@ +'\" 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_CREATE 3VND "Feb 21, 2014" + +.SH NAME + +vnd_create, vnd_open, vnd_unlink, vnd_close \- create, open, and destroy +vnd devices + +.SH SYNOPSIS + +.LP +.nf +cc [ flag... ] file... -lvnd [ library... ] +#include <libvnd.h> + +vnd_handle_t *vnd_create(const char *zonename, const char *datalink, + const char *linkname, vnd_errno_t *vnderr, int *syserr); + +vnd_handle_t *vnd_open(const char *zonename, const char *linkname, + vnd_errno_t *vnderr, int *syserr); + +int vnd_unlink(vnd_handle_t *vhp); + +void vnd_close(vnd_handle_t *vhp); +.fi + + +.SH DESCRIPTION +.LP +These functions create vnd devices, obtain handles to extant vnd +devices, and close handles to vnd devices, for use with the rest of +libvnd(3LIB). + +.LP +The vnd_create function creates a new vnd device in the zone specified +by zonename. The zone name argument may be null, in which case the +caller's current zone is used instead. The vnd device and data link it +is created over must both be in the same zone. The datalink argument +indicates the name of the DLPI data link to create the vnd device over. +The linkname argument indicates the name of the new vnd device. The +linkname argument must be less than VND_NAMELEN characters long, +excluding the null terminator. It should be an alphanumeric string. The +only non-alphanumeric characters allowed are ':', '-', and \'_'. +Neither the datalink argument nor linkname argument may be NULL. A +handle to the created device is returned to the caller. Once the +vnd_create function returns, the device can be subsequently opened with +a call to vnd_open. The named device persists until a call to vnd_unlink +or the containing zone is halted. Creating a vnd device requires +PRIV_SYS_NET_CONFIG as well as PRIV_RAWACCESS. The arguments vnderr and +syserr are used to obtain errors in the cases where the call to +vnd_create fails. Both arguments may be NULL pointers, in which case the +more detailed error information is discarded. + +.LP +The vnd_open function opens an existing vnd device and returns a +unique handle to that device. The vnd device to open is specified by +both zonename and linkname. The zonename argument specifies what zone +to look for the vnd device in. The linkname specifies the name of the +link. The zonename argument may be NULL. If it is, the current zone is +used. Similar to vnd_create, the integer values pointed to by the +arguments vnderr and syserr will be filled in with additional error +information in the cases where a call to vnd_open fails. Both +arguments may be NULL to indicate that the error information is not +requested, though this is not recommended. + +.LP +The vnd_unlink function unlinks the vnd device specified by the vnd +handle vhp. This unlink is similar to the use of unlink in a file +system. After a call to unlink, the vnd device will no longer be +accessible by callers to vnd_open and the name will be available for +use in vnd_create. However, the device will continue to exist until +all handles to the device have been closed. + +.LP +The vnd_close function relinquishes the vnd device referenced by the +handle vhp. After a call to vnd_close, the handle is invalidated and +must not be used by the consumer again. The act of calling vnd_close +on a handle does not remove the device. The device is persisted as +long as vnd_unlink has not been called on the device or the containing +zone has not been destroyed. + +.SH RETURN VALUES + +.LP +Upon successful completion, the functions vnd_create and vnd_open +return a pointer to a vnd_handle_t. This handle is used for all +subsequent library operations. If either function fails, then a NULL +pointer is returned and more detailed error information is filled into +the integers pointed to by vnderr and syserr. The vnderr and syserr +correspond to the values that would normally be returned by a call to +vnd_errno(3VND) and vnd_syserrno(3VND). For the full list of possible +errors see libvnd(3LIB). + +.LP +The vnd_unlink function returns zero on success and -1 on failure. On +failure, the vnd and system errnos are updated and available through +the vnd_errno(3VND) and vnd_syserrno(3VND) functions. + +.LP +The vnd_close function does not return any values nor does it set +vnderr or syserr. The handle passed to vnd_close can no longer be +used. + +.SH EXAMPLES +.LP +Example 1 Creating a device +.sp +.LP + +The following sample C program shows how to create a vnd device over +an existing datalink named "net0" that other applications can open +and use as "vnd0". + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr; + + /* Errors are considered fatal */ + vhp = vnd_create(NULL, "net0", "vnd0", &vnderr, &syserr); + + if (vhp == NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to create device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to create device: %s", + vnd_strerror(vnderr)); + return (1); + } + + (void) printf("successfully created vnd0\n"); + vnd_close(vhp); + return (0); +} +.fi +.in -2 + +.LP +Example 2 Opening an existing device in another zone +.sp +.LP + +The following sample C program opens the device named "vnd1" in the zone +named "turin" for further use. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr, ret; + + vhp = vnd_open("turin", "vnd1", &vnderr, &syserr); + if (vhp != NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + return (1); + } + + /* + * Use the device vnd1 with the handle vhp with any of + * the other interfaces documented in libvnd(3LIB) here. + * + * After an arbitrary amount of code, the program will + * set the variable ret with the exit code for the + * program and should execute the following code before + * returning. + */ + vnd_close(vhp); + return (ret); +} +.fi +.in -2 + + +.LP +Example 3 Removing a device +.sp +.LP + +The following sample C program removes a vnd device named vnd0. This +program makes it so no additional programs can access the device. +However, if anyone is actively using it, it will still exist, +similar to calling unlink(2). + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr, ret; + + vhp = vnd_open(NULL, "vnd0", &vnderr, &syserr); + if (vhp != NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + return (1); + } + + if (vnd_unlink(vhp) != 0) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to unlink device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to unlink device: %s", + vnd_strerror(vnderr)); + ret = 1; + } else { + (void) printf("successfully unlinked vnd0!\n"); + ret = 0; + } + + vnd_close(vhp); + return (ret); +} +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See attributes(5) for descriptions of the following attributes: + +.sp +.TS +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Stability Committed +_ +MT-Level See "THREADING" in libvnd(3LIB) +.TE + +.SH SEE ALSO + +libvnd(3LIB), vnd_errno(3VND), vnd_syserrno(3VND), attributes(5), privileges(5) diff --git a/usr/src/man/man3vnd/vnd_errno.3vnd b/usr/src/man/man3vnd/vnd_errno.3vnd new file mode 100644 index 0000000000..ddd6126dd1 --- /dev/null +++ b/usr/src/man/man3vnd/vnd_errno.3vnd @@ -0,0 +1,170 @@ +'\" 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_ERRNO 3VND "Feb 21, 2014" + +.SH NAME + +vnd_errno, vnd_syserrno, vnd_strerror, vnd_strsyserror \- obtain and +translate vnd errors + + +.SH SYNOPSIS + +.LP +.nf +cc [ flag... ] file... -lvnd [ library... ] +#include <libvnd.h> + +uint32_t vnd_errno(vnd_handle_t *vhp); + +const char *vnd_strerror(vnd_errno_t err); + +int vnd_syserrno(vnd_handle_t *vhp); + +const char *vnd_strsyserror(int syserr); +.fi + +.SH DESCRIPTION + +.LP +The libvnd(3LIB) library supports a complementary array of errors that +give more specific error information than the traditional set of +system errors available via errno(3C). When an error occurs, consumers +should call the vnd_errno function first and check its value. If the +value of the vnd_errno_t is VND_E_SYS, then the system errno should be +checked. If the vnd_errno_t is not VND_E_SYS, then the contents of the +system errno returned from vnd_syserrno are undefined. Both the vnd +and system errors are only valid for a given handle after a libvnd +library function returned an error and before another libvnd library +function is called on the same handle. The act of making an additional +function call with the same vnd_handle_t invalidates any prior vnd or +system error numbers. For the full list of valid vnd errors see +libvnd(3LIB). For the full list of valid system errors, see Intro(2). + +.LP +The vnd_errno and vnd_syserrno functions retrieve the most recent vnd +and syserr error number respectively from a vnd handle vhp. + +.LP +The vnd_strerror function translates a vnd_errno_t err to a +corresponding string and returns a pointer to that constant string. + +.LP +The vnd_syserrno function is analogous to the vnd_strerror function, +except that it translates a system error back to a string. + + +.SH RETURN VALUES + +.LP +The vnd_errno function returns a vnd_errno_t which contains the vnd +error information. + +.LP +The vnd_syserror function returns an integer which contains the system +error information. These values are the same as those returned by +errno(3C). + +.LP +The vnd_strerror function returns a pointer to a constant string. If +the error passed in is unknown, the string "unknown error" is +returned. + +.LP +The vnd_strsyserror function returns a pointer to the translated +constant string. If an unknown error number is passed, it returns the +string "Unknown error". If an error occurs, it returns a NULL pointer. + +.SH EXAMPLES + +.LP +Example 1 Obtaining errors from a vnd_handle_t + +.sp +.LP +The following sample C function, which can be incorporated into a larger +program, shows how to obtain the vnd and system errors from a +vnd_handle_t after a vnd interface on a handle failed. + +.sp +.in +2 +.nf +#include <libvnd.h> + +static void +print_errnos(vnd_handle_t *vhp) +{ + vnd_errno_t vnderr; + int syserr; + + vnderr = vnd_errno(vhp); + syserr = vnd_syserrno(vhp); + + (void) printf("vnd err: %d, sys err: %d\n", + vnderr, syserr); +} +.fi +.in -2 + +.LP +Example 2 A perror-like function + +.sp +.LP +The following sample C function which can be incorporated into a +larger program shows how to write a perror-like function to print +out error messages for a vnd device. + +.sp +.in +2 +.nf +#include <libvnd.h> + +static void +sample_perror(const char *msg, vnd_error_t vnderr, int syserr) +{ + (void) fprintf(stderr, "%s: %s", msg, + vnderr != VND_E_SYS ? vnd_strerror(vnderr) : + vnd_strsyserror(syserr)); +} +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See attributes(5) for descriptions of the following attributes: + +.sp +.TS +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Stability Committed +_ +MT-Level See below +.TE + +.LP +The MT-Level of the functions vnd_strerror and vnd_strsyserror is +MT-Safe. See "THREADING" in libvnd(3LIB) for a discussion of the +MT-Level of vnd_errno and vnd_syserrno. + + +.SH SEE ALSO + +Intro(2), errno(3C), libvnd(3LIB), attributes(5) diff --git a/usr/src/man/man3vnd/vnd_frameio_read.3vnd b/usr/src/man/man3vnd/vnd_frameio_read.3vnd new file mode 100644 index 0000000000..5fc65c96a3 --- /dev/null +++ b/usr/src/man/man3vnd/vnd_frameio_read.3vnd @@ -0,0 +1,705 @@ +'\" 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_FRAMEIO_READ 3VND "Mar 06, 2014" + +.SH NAME + +vnd_frameio_read, vnd_frameio_write \- perform framed I/O to a vnd device + +.SH SYNOPSIS + +.LP +.nf +cc [ flag... ] file... -lvnd [ library... ] +#include <libvnd.h> + +int vnd_frameio_read(vnd_handle_t *vhp, frameio_t *fiop); + +int vnd_frameio_write(vnd_handle_t *vhp, frameio_t *fiop); +.fi + +.SH DESCRIPTION +.LP +Framed I/O is a general means to manipulate data that is inherently +framed, meaning that there is a maximum frame size, but the data may +often be less than that size. As an example, an Ethernet device's MTU +describes the maximum frame size, but the size of an individual frame +is often much less. You can read a single frame at a time, or you can +read multiple frames in a single call. + +In addition, framed I/O allows the consumer to break individual frames +into a series of vectors. This is analogous to the use of an iovec(9S) +with readv(2) and writev(2). + +vnd_frameio_read performs a framed I/O read of the device represented by +the handle vhp, with the framed I/O data described by fiop. +vnd_frameio_write works in the same manner, except performing a write +instead of a read. + +.LP +The basic vector component of the frameio_t is the framevec_t. Each +framevec_t represents a single vector entry. An array of these is +present in the frameio_t. The framevec_t structure has the following +members: + +.in +2 +.nf +void *fv_buf /* data buffer */ +size_t fv_buflen; /* total size of buffer */ +size_t fv_actlen; /* amount of buffer consumed */ +.fi +.in -2 + +.LP +The fv_buf member points to a buffer which contains the data for this +individual vector. When reading, data is consumed from fv_buf. When +writing, data is written into fv_buf. + +The fv_buflen should indicate the total amount of data that is in the +buffer. When reading, it indicates the size of the buffer. It must be +set prior to calling vnd_frameio_read(). When writing, it indicates the +amount of data that is valid in the buffer. + +The fv_actlen is a read-only member. It is set on successful return of +the functions vnd_frameio_read and vnd_frameio_write. When reading, it +is updated with the amount of data that was read into fv_buf. When +writing, it is instead updated with the amount of data from fv_buf that +was actually consumed. Generally when writing data, a framevec_t will +either be entirely consumed or it will not be consumed at all. + + +.LP +A series of framevec_t's is encapsulated in a frameio_t. The frameio_t +structure has the following members: + +.in +2 +.nf +uint_t fio_version; /* current version */ +uint_t fio_nvpf; /* number of vectors in one frame */ +uint_t fio_nvecs; /* The total number of vectors */ +framevec_t fio_vecs[]; /* vectors */ +.fi +.in -2 + +.LP +The fio_version member represents the current version of the frameio_t. +The fio_version should be set to the macro FRAMEIO_CURRENT_VERSION, +which is currently 1. + +The members fio_nvpf and fio_nvecs describe the number of frames that +exist. fio_nvecs describes the total number of vectors that are present +in fio_vecs. The upper bound on this is described by FRAMEIO_NVECS_MAX +which is currently 32. fio_nvpf describe the number of vectors that +should be used to make up each frame. By setting fio_vecs to be an even +multiple of fio_nvpf, multiple frames can be read or written in a single +call. + +After a call to vnd_frameio_read or vnd_frameio_write fio_nvecs is +updated with total number of vectors read or written to. This value can +be divided by fio_nvpf to determine the total number of frames that were +written or read. + +.LP +Each frame can be broken down into a series of multiple vectors. As an +example, someone might want to break Ethernet frames into mac headers +and payloads. The value of fio_nvpf would be set to two, to indicate +that a single frame consists of two different vector components. The +member fio_nvecs describes the total number of frames. As such, the +value of fio_vecs divided by fio_nvpf describes the total number of +frames that can be consumed in one call. As a result of this, fio_nvpf +must evenly divide fio_vecs. If fio_nvpf is set to two and +fio_nvecs is set to ten, then a total of five frames can be processed +at once, each frame being broken down into two different vector +components. + +A given frame will never overflow the number of vectors described by +fio_nvpf. Consider the case where each vector component has a buffer +sized to 1518 bytes, fio_nvpf is set to one, and fio_nvecs is set to +three. If a call to vnd_frameio_read is made and four 500 byte Ethernet +frames come in, then each frame will be mapped to a single vector. The +500 bytes will be copied into fio_nvecs[i]->fio_buf and +fio_nvecs[i]->fio_actlen will be set to 500. To contrast this, if +readv(2) had been called, the first three frames would all be in the +first iov and the fourth frame's first eight bytes would be in the first +iov and the remaining in the second. + +.LP +The user must properly initialize fio_nvecs framevec_t's worth of the +fio_vecs array. When multiple vectors comprise a frame, fv_buflen data +is consumed before moving onto the next vector. Consider the case +where the user wants to break a vector into three different +components, an 18 byte vector for an Ethernet VLAN header, a 20 byte +vector for an IPv4 header, and a third 1500 byte vector for the +remaining payload. If a frame was received that only had 30 bytes, +then the first 18 bytes would fill up the first vector, the remaining +12 bytes would fill up the IPv4 header. If instead a 524 byte frame +came in, then the first 18 bytes would be placed in the first vector, +the next 24 bytes would be placed in the next vector, and the remaining +500 bytes in the third. + +.LP +The functions vnd_frameio_read and vnd_frameio_write operate in both +blocking and non-blocking mode. If either O_NONBLOCK or O_NDELAY have +been set on the file descriptor, then the I/O will behave in +non-blocking mode. When in non-blocking mode, if no data is available +when vnd_frameio_read is called, EAGAIN is returned. When +vnd_frameio_write is called in non-blocking mode, if sufficient buffer +space to hold all of the output frames is not available, then +vnd_frameio_write will return EAGAIN. To know when the given vnd device +has sufficient space, the device fires POLLIN/POLLRDNORM when data is +available for read and POLLOUT/POLLRDOUT when space in the buffer has +opened up for write. These events can be watched for through +port_associate(3C) and similar routines with a file descriptor returned +from vnd_polfd(3VND). + +.LP +When non-blocking mode is disabled, calls to vnd_frameio_read will +block until some amount of data is available. Calls to +vnd_frameio_write will block until sufficient buffer space is +available. + +.LP +Similar to read(2) and write(2), vnd_frameio_read and +vnd_frameio_write make no guarantees about the ordering of data when +multiple threads simultaneously call the interface. While the data +itself will be atomic, the ordering of multiple simultaneous calls is +not defined. + +.SH RETURN VALUES + +.LP +The vnd_frameio_read function returns zero on success. The member +fio_nvecs of fiop is updated with the total number of vectors that had +data read into them. Each updated framevec_t will have the buffer +pointed to by fv_buf filled in with data, and fv_actlen will be +updated with the amount of valid data in fv_buf. + +.LP +The vnd_frameio_write function returns zero on success. The member +fio_nvecs of fiop is updated with the total number of vectors that +were written out to the underlying datalink. The fv_actlen of each +vector is updated to indicate the amount of data that was written from +that buffer. + +.LP +On failure, both vnd_frameio_read and vnd_frameio_write return -1. The +vnd and system error numbers are updated and available via +vnd_errno(3VND) and vnd_syserrno(3VND). See ERRORS below for a list of +errors and their meaning. + + +.SH ERRORS +.LP +The functions vnd_frameio_read and vnd_frameio_write always set the +vnd error to VND_E_SYS. The following system errors will be +encountered: + +.sp +.ne 2 +.na +EAGAIN +.ad +.RS 10n +Insufficient system memory was available for the operation. +.sp +Non-blocking mode was enabled and during the call to vnd_frameio_read, +no data was available. Non-blocking mode was enabled and during the call +to vnd_frameio_write, insufficient buffer space was available. +.RE + +.sp +.ne 2 +.na +ENXIO +.ad +.RS 10n +The vnd device referred to by vhp is not currently attached to an +underlying data link and cannot send data. +.RE + +.sp +.ne 2 +.na +EFAULT +.ad +.RS 10n +The fiop argument points to an illegal address or the fv_buf members of +the framevec_t's associated with the fiop member fio_vecs point to +illegal addresses. +.RE + +.sp +.ne 2 +.na +EINVAL +.ad +.RS 10n +The fio_version member of fiop was unknown, the number of vectors +specified by fio_nvecs is zero or greater than FRAMEIO_NVECS_MAX, +fio_nvpf equals zero, fio_nvecs is not evenly divisible by fio_nvpf, or +a buffer in fio_vecs[] has set fv_buf or fv_buflen to zero. +.RE + + +.sp +.ne 2 +.na +EINTR +.ad +.RS 10n +A signal was caught during vnd_frameio_read or vnd_frameio_write, and no +data was transferred. +.RE + + +.sp +.ne 2 +.na +EOVERFLOW +.ad +.RS 10n +During vnd_frameio_read, the size of a frame specified by fiop->fio_nvpf +and fiop->fio_vecs[].fv_buflen cannot contain a frame. +.sp +In a ILP32 environment, more data than UINT_MAX would be set in +fv_actlen. +.RE + + +.sp +.ne 2 +.na +ERANGE +.ad +.RS 10n +During vnd_frameio_write, the size of a frame is less than the device's +minimum transmission unit or it is larger than the size of the maximum +transmission unit. +.RE + + +.SH EXAMPLES + +.LP +Example 1 Read a single frame with a single vector + +.sp +.LP +The following sample C program opens an existing vnd device named +"vnd0" in the current zone and performs a blocking read of a single +frame from it. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr, i; + frameio_t *fiop; + + fiop = malloc(sizeof (frameio_t) + sizeof (framevec_t)); + if (fiop == NULL) { + perror("malloc frameio_t"); + return (1); + } + fiop->fio_version = FRAMEIO_CURRENT_VERSION; + fiop->fio_nvpf = 1; + fiop->fio_nvecs = 1; + fiop->fio_vecs[0].fv_buf = malloc(1518); + fiop->fio_vecs[0].fv_buflen = 1518; + if (fiop->fio_vecs[0].fv_buf == NULL) { + perror("malloc framevec_t.fv_buf"); + free(fiop); + return (1); + } + + vhp = vnd_open(NULL, "vnd1", &vnderr, &syserr); + if (vhp != NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + free(fiop->fio_vecs[0].fv_buf); + free(fiop); + return (1); + } + + if (frameio_read(vhp, fiop) != 0) { + vnd_errno_t vnderr = vnd_errno(vhp); + int syserr = vnd_syserrno(vhp); + + /* Most consumers should retry on EINTR */ + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to read: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to read: %s", + vnd_strerror(vnderr)); + vnd_close(vhp); + free(fiop->fio_vecs[0].fv_buf); + free(fiop); + return (1); + } + + + /* Consume the data however it's desired */ + (void) printf("received %d bytes\n", fiop->fio_vecs[0].fv_actlen); + for (i = 0; i < fiop->fio_vecs[0].fv_actlen) + (void) printf("%x ", fiop->fio_vecs[0].fv_buf[i]); + + vnd_close(vhp); + free(fiop->fio_vecs[0].fv_buf); + free(viop); + return (0); +} +.fi +.in -2 + +.LP +Example 2 Write a single frame with a single vector +.sp +.LP +The following sample C program opens an existing vnd device named +"vnd0" in the current zone and performs a blocking write of a single +frame to it. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> +#include <string.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr; + frameio_t *fiop; + + fiop = malloc(sizeof (frameio_t) + sizeof (framevec_t)); + if (fiop == NULL) { + perror("malloc frameio_t"); + return (1); + } + fiop->fio_version = FRAMEIO_CURRENT_VERSION; + fiop->fio_nvpf = 1; + fiop->fio_nvecs = 1; + fiop->fio_vecs[0].fv_buf = malloc(1518); + if (fiop->fio_vecs[0].fv_buf == NULL) { + perror("malloc framevec_t.fv_buf"); + free(fiop); + return (1); + } + + /* + * Fill in your data however you desire. This is an entirely + * invalid frame and while the frameio write may succeed, the + * networking stack will almost certainly drop it. + */ + (void) memset(fiop->fio_vecs[0].fv_buf, 'r', 1518); + fiop->fio_vecs[0].fv_buflen = 1518; + + vhp = vnd_open(NULL, "vnd0", &vnderr, &syserr); + if (vhp != NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + free(fiop->fio_vecs[0].fv_buf); + free(fiop); + return (1); + } + + if (frameio_write(vhp, fiop) != 0) { + /* Most consumers should retry on EINTR */ + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to write: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to write: %s", + vnd_strerror(vnderr)); + vnd_close(vhp); + free(fiop->fio_vecs[0].fv_buf); + free(fiop); + return (1); + } + + + (void) printf("wrote %d bytes\n", fiop->fio_vecs[0].fv_actlen); + + vnd_close(vhp); + free(fiop->fio_vecs[0].fv_buf); + free(viop); + return (0); +} +.fi +.in -2 + +.LP +Example 3 Read frames comprised of multiple vectors +.sp +.LP +The following sample C program is similar to example 1, except instead +of reading a single frame consisting of a single vector it reads +multiple frames consisting of two vectors. The first vector has room for +an 18 byte VLAN enabled Ethernet header and the second vector has room +for a 1500 byte payload. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr, i, nframes; + frameio_t *fiop; + + /* Allocate enough framevec_t's for 5 frames */ + fiop = malloc(sizeof (frameio_t) + sizeof (framevec_t) * 10); + if (fiop == NULL) { + perror("malloc frameio_t"); + return (1); + } + fiop->fio_version = FRAMEIO_CURRENT_VERSION; + fiop->fio_nvpf = 2; + fiop->fio_nvecs = 10; + for (i = 0; i < 10; i += 2) { + fiop->fio_vecs[i].fv_buf = malloc(18); + fiop->fio_vecs[i].fv_buflen = 18; + if (fiop->fio_vecs[i].fv_buf == NULL) { + perror("malloc framevec_t.fv_buf"); + /* Perform appropriate memory cleanup */ + return (1); + } + fiop->fio_vecs[i+1].fv_buf = malloc(1500); + fiop->fio_vecs[i+1].fv_buflen = 1500; + if (fiop->fio_vecs[i+1].fv_buf == NULL) { + perror("malloc framevec_t.fv_buf"); + /* Perform appropriate memory cleanup */ + return (1); + } + } + + vhp = vnd_open(NULL, "vnd1", &vnderr, &syserr); + if (vhp != NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + /* Perform appropriate memory cleanup */ + return (1); + } + + if (frameio_read(vhp, fiop) != 0) { + /* Most consumers should retry on EINTR */ + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to read: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to read: %s", + vnd_strerror(vnderr)); + vnd_close(vhp); + /* Perform appropriate memory cleanup */ + return (1); + } + + /* Consume the data however it's desired */ + nframes = fiop->fio_nvecs / fiop->fio_nvpf; + (void) printf("consumed %d frames!\n", nframes); + for (i = 0; i < nframes; i++) { + (void) printf("received %d bytes of Ethernet Header\n", + fiop->fio_vecs[i].fv_actlen); + (void) printf("received %d bytes of payload\n", + fiop->fio_vecs[i+1].fv_actlen); + } + + vnd_close(vhp); + /* Do proper memory cleanup */ + return (0); +} +.fi +.in -2 + +.LP +Example 4 Perform non-blocking reads of multiple frames with a +single vector +.sp +.LP +In this sample C program, opens an existing vnd device named "vnd0" in +the current zone, ensures that it is in non-blocking mode, and uses +event ports to do device reads. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> +#include <port.h> +#include <unistd.h> +#include <errno.h> +#include <sys/tpyes.h> +#include <fcntl.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr, i, nframes, port, vfd; + frameio_t *fiop; + + port = port_create(); + if (port < 0) { + perror("port_create"); + return (1); + } + /* Allocate enough framevec_t's for 10 frames */ + fiop = malloc(sizeof (frameio_t) + sizeof (framevec_t) * 10); + if (fiop == NULL) { + perror("malloc frameio_t"); + (void) close(port); + return (1); + } + fiop->fio_version = FRAMEIO_CURRENT_VERSION; + fiop->fio_nvpf = 1; + fiop->fio_nvecs = 10; + for (i = 0; i < 10; i++) { + fiop->fio_vecs[i].fv_buf = malloc(1518); + fiop->fio_vecs[i].fv_buflen = 1518; + if (fiop->fio_vecs[i].fv_buf == NULL) { + perror("malloc framevec_t.fv_buf"); + /* Perform appropriate memory cleanup */ + (void) close(port); + return (1); + } + } + + vhp = vnd_open(NULL, "vnd1", &vnderr, &syserr); + if (vhp != NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + /* Perform appropriate memory cleanup */ + (void) close(port); + return (1); + } + vfd = vnd_pollfd(vhp); + if (fcntl(fd, F_SETFL, O_NONBLOCK) != 0) { + (void) fprintf(stderr, "failed to enable non-blocking mode: %s", + strerrror(errno)); + } + + for (;;) { + port_event_t pe; + + if (port_associate(port, PORT_SOURCE_FD, vfd, POLLIN, + vhp) != 0) { + perror("port_associate"); + vnd_close(vhp); + /* Perform appropriate memory cleanup */ + (void) close(port); + return (1); + } + + if (port_get(port, &pe, NULL) != 0) { + if (errno == EINTR) + continue; + perror("port_associate"); + vnd_close(vhp); + /* Perform appropriate memory cleanup */ + (void) close(port); + return (1); + } + + /* + * Most real applications will need to compare the file + * descriptor and switch on it. In this case, assume + * that the fd in question that is readable is 'vfd'. + */ + if (frameio_read(pe.portev_user, fiop) != 0) { + vnd_errno_t vnderr = vnd_errno(vhp); + int syserr = vnd_syserrno(vhp); + + if (vnderr == VND_E_SYS && (syserr == EINTR || + syserr == EAGAIN)) + continue; + (void) fprintf(stderr, "failed to get read: %s", + vnd_strsyserror(vnderr)); + vnd_close(vhp); + /* Perform appropriate memory cleanup */ + (void) close(port); + return (1); + } + + /* Consume the data however it's desired */ + nframes = fiop->fio_nvecs / fiop->fio_nvpf; + for (i = 0; i < nframes; i++) { + (void) printf("frame %d is %d bytes large\n", i, + fiop->fio_vecs[i].fv_actlen); + } + + } + + vnd_close(vhp); + /* Do proper memory cleanup */ + return (0); +} +.fi +.in -2 + +.SH ATTRIBUTES +.LP +See attributes(5) for descriptions of the following attributes: + +.sp +.TS +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Stability Committed +_ +MT-Level See "THREADING" in libvnd(3LIB) +.TE + + +.SH SEE ALSO + +Intro(2), getmsg(2), read(2), readv(2), write(2), writev(2), +libvnd(3VND), vnd_errno(3VND), vnd_pollfd(3VND), vnd_syserrno(3VND), +iovec(9S) diff --git a/usr/src/man/man3vnd/vnd_pollfd.3vnd b/usr/src/man/man3vnd/vnd_pollfd.3vnd new file mode 100644 index 0000000000..500d3bac99 --- /dev/null +++ b/usr/src/man/man3vnd/vnd_pollfd.3vnd @@ -0,0 +1,155 @@ +'\" 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_POLLFD 3VND "Feb 21, 2014" + +.SH NAME + +vnd_pollfd \- get file descriptor for polling + +.SH SYNOPSIS + +.LP +.nf +cc [ flag... ] file... -lvnd [ library... ] +#include <libvnd.h> + +int vnd_pollfd(vnd_handle_t *vhp); +.fi + +.SH DESCRIPTION +.LP +The vnd_pollfd() function returns an integer id which corresponds to +the file descriptor that represents the underlying device that is +associated with the vnd handle vhp. This file descriptor is suitable +for use with port_associate(3C) and similar polling techniques such as +poll(2). Use of the file descriptor outside of these uses may cause +undocumented behavior from the rest of the library. + +.LP +The file descriptor in question is still managed by libvnd. The caller +must not call close(2) on it. Once vnd_close(3VND) has been called, +any further use of the file descriptor is undefined behavior. + + +.SH RETURN VALUES +.LP +The function returns the integer id of the file descriptor that +corresponds to the underlying vnd device. + +.SH EXAMPLES + +.LP +Example 1 Use event ports for vnd notifications +.sp +.LP +The following sample C program shows how to use the vnd_pollfd +function with event ports to be notified whenever there is data +available to be read. This program assumes that a vnd device named +"vnd0" exists in the current zone. For an example of creating the +device, see Example 1 in vnd_create(3VND). + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <port.h> +#include <sys/types.h> +#include <unistd.h> +#include <fcntl.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int port, syserr, vfd, ret; + + port = port_create(); + if (port < 0) { + perror("port_create"); + return (1); + } + + vhp = vnd_open(NULL, "vnd0", &vnderr, &syserr); + if (vhp == NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + (void) close(port); + return (1); + } + + vfd = vnd_pollfd(vhp); + if (fcntl(vfd, F_SETFL, O_NONBLOCK) != 0) { + perror("fcntl"); + vnd_close(vhp); + (void) close(port); + return (1); + } + + if (port_associate(port, PORT_SOURCE_FD, vfd, POLLIN, NULL) != 0) { + perror("port_associate"); + vnd_close(vhp); + (void) close(port); + return (1); + } + + for (;;) { + port_event_t pe; + + + if (port_get(port, &pe, NULL) != 0) { + if (errno == EINTR) + continue; + perror("port_get"); + vnd_close(vhp); + (void) close(port); + return (1); + } + + /* + * Read the data with vnd_frameio_read(3VND) and + * optionally break out of the loop or continue to the + * next iteration and reassociate vfd with the event + * port. + */ + } +} +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See attributes(5) for descriptions of the following attributes: + +.sp +.TS +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Stability Committed +_ +MT-Level See "THREADING" in libvnd(3LIB) +.TE + +.SH SEE ALSO + +close(2), poll(2), port_create(3C), libvnd(3LIB), vnd_close(3VND) diff --git a/usr/src/man/man3vnd/vnd_prop_get.3vnd b/usr/src/man/man3vnd/vnd_prop_get.3vnd new file mode 100644 index 0000000000..e47698c85e --- /dev/null +++ b/usr/src/man/man3vnd/vnd_prop_get.3vnd @@ -0,0 +1,242 @@ +'\" 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_PROP_GET 3VND "Feb 21, 2014" + +.SH NAME + +vnd_prop_get, vnd_prop_set \- get and set vnd properties + +.SH SYNOPSIS + +.LP +.nf +cc [ flag... ] file... -lvnd [ library... ] +#include <libvnd.h> + +int vnd_prop_get(vnd_handle_t *vhp, vnd_prop_t prop, void *buf, size_t len); + +int vnd_prop_set(vnd_handle_t *vhp, vnd_prop_t prop, void *buf, size_t len); +.fi + +.SH DESCRIPTION +.LP +The vnd_prop_get and vnd_prop_set functions are used to retrieve +and set property values on the vnd_handle_t referred to by vhp. The +property to get or set is specified by the argument prop. The +argument buf and the size of buf, in len, should be a pointer to the +appropriate structure for the property as defined in libvnd(3LIB). + +.LP +All of the supported properties are listed and described in the +libvnd(3LIB) manual page. + + +.SH RETURN VALUES +.LP +On success, the vnd_prop_get and vnd_prop_set functions return zero. +On failure, they return -1 and additional error information is +available through vnd_errno(3VND) and vnd_syserrno(3VND). + +.LP +When vnd_prop_get returns successfully, the contents of buf are +filled in with the value of the corresponding property. The contents +of buf should not change across a call to vnd_prop_set. + +.SH EXAMPLES + +.LP +Example 1 Getting the value of the rxbuf property +.LP +The following sample C program retrieves the value of the +rxbuf property and prints it to standard out. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr; + vnd_prop_buf_t vpb; + + vhp = vnd_open(NULL, "vnd1", &vnderr, &syserr); + if (vhp != NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + return (1); + } + + if (vnd_prop_get(vhp, VND_PROP_RXBUF, &vpn, sizeof (vpn)) != 0) { + vnderr = vnd_errno(vhp); + syserr = vnd_syserrno(vhp); + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to get VND_PROP_RXBUF: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to get VND_PROP_RXBUF: %s", + vnd_strerror(vnderr)); + return (1); + } + + (void) printf("recieve buffer size is %d bytes\n", vpb.vpb_size); + + vnd_close(vnd); + return (0); +} +.fi +.in -2 + +.LP +EXAMPLE 2 Setting a property +.LP +This sample C program sets the property VND_PROP_RXBUF to the value of +4200 bytes. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr; + vnd_prop_buf_t vpb; + + vhp = vnd_open(NULL, "vnd1", &vnderr, &syserr); + if (vhp != NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + return (1); + } + + vpb.vpb_size = 4200; + if (vnd_prop_set(vhp, VND_PROP_RXBUF, &vpb, sizeof (vpb)) != 0) { + vnderr = vnd_errno(vhp); + syserr = vnd_syserrno(vhp); + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to set VND_PROP_RXBUF: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to set VND_PROP_RXBUF: %s", + vnd_strerror(vnderr)); + return (1); + } + + (void) printf("successfully set VND_PROP_RXBUF to 4200\n"); + + vnd_close(vnd); + return (0); +} +.fi +.in -2 + +.LP +Example 3 Setting a property to the value of another. +.LP +In this sample C program, we set the VND_PROP_TXBUF to the maximum +allowable size as determined by the read-only property VND_PROP_MAXBUF. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr; + vnd_prop_buf_t vpb; + + vhp = vnd_open(NULL, "vnd1", &vnderr, &syserr); + if (vhp != NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + return (1); + } + + if (vnd_prop_get(vhp, VND_PROP_MAXBUF, &vpb, sizeof (vpb)) != 0) { + vnderr = vnd_errno(vhp); + syserr = vnd_syserrno(vhp); + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to get VND_PROP_MAXBUF: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to get VND_PROP_MAXBUF: %s", + vnd_strerror(vnderr)); + return (1); + } + + if (vnd_prop_set(vhp, VND_PROP_TXBUF, &vpb, sizeof (vpb)) != 0) { + vnderr = vnd_errno(vhp); + syserr = vnd_syserrno(vhp); + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to set VND_PROP_TXBUF: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to set VND_PROP_TXBUF: %s", + vnd_strerror(vnderr)); + return (1); + } + + (void) printf("successfully set VND_PROP_TXBUF to %d\n", vpb.vpb_size); + + vnd_close(vnd); + return (0); +} +.fi + +.SH ATTRIBUTES +.sp +.LP +See attributes(5) for descriptions of the following attributes: + +.sp +.TS +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Stability Committed +_ +MT-Level See "THREADING" in libvnd(3LIB) +.TE + +.SH SEE ALSO +libvnd(3VND), vnd_errno(3VND, vnd_syserrno(3VND) diff --git a/usr/src/man/man3vnd/vnd_prop_iter.3vnd b/usr/src/man/man3vnd/vnd_prop_iter.3vnd new file mode 100644 index 0000000000..29221734c5 --- /dev/null +++ b/usr/src/man/man3vnd/vnd_prop_iter.3vnd @@ -0,0 +1,148 @@ +'\" 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_PROP_ITER 3VND "Feb 21, 2014" + +.SH NAME + +vnd_prop_iter \- iterate vnd properties + +.SH SYNOPSIS + +.LP +.nf +cc [ flag... ] file... -lvnd [ library... ] +#include <libvnd.h> + +typedef int (vnd_prop_iter_f)(vnd_handle_t *vhp, vnd_prop_t prop, + void *cbarg); + +int vnd_prop_iter(vnd_handle_t *vhp, vnd_prop_iter_f cb, + void *arg); +.fi + +.SH DESCRIPTION +.LP +The vnd_prop_iter function iterates over all the available properties +for the vnd handle vhp and calls the user supplied callback function +cb. The argument arg is passed directly to the callback function. + +.LP +The function specified by cb receives three arguments. The first, vhp, +is the same vnd library handle that was passed to vnd_prop_iter. During +the callback, the consumer should not call vnd_close(3VND). Doing so +will lead to undefined and undocumented behavior. The second argument, +prop, is the current property. While vnd_prop_iter guarantees that all +properties will be recieved, it does not guarantee the order of them. +The final argument, cbarg, is the same argument that the caller passed +in during arg. + +.LP +The return value of the callback function cb indicates whether or not +property iteration should continue. To continue iteration, the +function cb should return zero. Otherwise, to stop property iteration +it should return non-zero. + +.SH RETURN VALUES + +.LP +On success, the function vnd_prop_iter returns zero. If the callback +function returned non-zero to terminate iteration, vnd_prop_iter will +instead return one. In the case of library failure, vnd_prop_iter will +return -1. In such cases, the vnd and system errors will be updated +and available via vnd_errno(3VND) and vnd_syserrno(3VND). + +.SH EXAMPLES + +.LP +Example 1 Print writeable properties + +.LP +The following sample C program walks over every vnd property and +prints out whether the property is read-only or read-write for the +vnd device "vnd1" in the current zone. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdlib.h> +#include <stdio.h> + +static int +print_prop(vnd_handle_t *vhp, vnd_prop_t prop, void *unused) +{ + boolean_t canwrite; + + if (vnd_prop_writeable(vhp, &canwrite) != 0) + abort(); + + (void) printf("prop %d is %s", prop, canwrite == B_TRUE ? "rw" : "r-"); + return (0); +} + +int +main(void) +{ + vnd_handle_t *vhp; + vnd_errno_t vnderr; + int syserr; + + vhp = vnd_open(NULL, "vnd1", &vnderr, &syserr); + if (vhp != NULL) { + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + return (1); + } + + if (vnd_prop_iter(vhp, print_prop, NULL) != 0) { + vnderr = vnd_errno(vhp); + syserr = vnd_syserrno(vhp); + if (vnderr == VND_E_SYS) + (void) fprintf(stderr, "failed to open device: %s", + vnd_strsyserror(syserr)); + else + (void) fprintf(stderr, "failed to open device: %s", + vnd_strerror(vnderr)); + return (1); + } + + vnd_close(vnd); + return (0); +} +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See attributes(5) for descriptions of the following attributes: + +.sp +.TS +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Stability Committed +_ +MT-Level See "THREADING" in libvnd(3LIB) +.TE + +libvnd(3LIB), vnd_close(3VND), vnd_errno(3VND), vnd_syserrno(3VND) diff --git a/usr/src/man/man3vnd/vnd_prop_writeable.3vnd b/usr/src/man/man3vnd/vnd_prop_writeable.3vnd new file mode 100644 index 0000000000..c23414718b --- /dev/null +++ b/usr/src/man/man3vnd/vnd_prop_writeable.3vnd @@ -0,0 +1,101 @@ +'\" 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_PROP_WRITEABLE 3VND "Feb 21, 2014" + +.SH NAME + +vnd_prop_writeable \- determine if a vnd property can be updated + +.SH SYNOPSIS + +.LP +.nf +cc [ flag... ] file... -lvnd [ library... ] +#include <libvnd.h> + +int vnd_prop_writeable(vnd_prop_t prop, boolean_t *wp); +.fi + + +.SH DESCRIPTION +.LP +The vnd_prop_writeable function is used as a programmatic means to +determine whether a given vnd property is writeable or not. The +property to check is specified in prop and should be from the list +described in libvnd(3VND). The argument wp is a pointer to a boolean_t +which will be updated upon the successful completion of the function. +The argument wp must be a valid pointer. If a property is writeable +than the value pointed to by wp is set to B_TRUE. If the property is +read-only, then the value is set to B_FALSE. + + +.SH RETURN VALUES +.LP +On success, vnd_prop_writeable returns zero and the value pointed to +by wp is updated with whether the property is writeable. If the +property prop does not exist, then vnd_prop_writeable will return -1. + +.SH EXAMPLES +.LP +Example 1 Check whether the property VND_PROP_TXBUF is writable +.LP +The following sample C program checks whether the vnd property +VND_PROP_TXBUF is writeable or not. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> +#include <stdlib.h> + +int +main(void) +{ + boolean_t canwrite; + + if (vnd_prop_writeable(VND_PROP_TXBUF, &prop) != 0) + abort(); + + if (canwrite == B_TRUE) + (void) printf("VND_PROP_TXBUF is writeable\n"); + else + (void) printf("VND_PROP_TXBUF is read only\n"); + + return (0); +} +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See attributes(5) for descriptions of the following attributes: + +.sp +.TS +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Stability Committed +_ +MT-Level MT-Safe +.TE + +.SH SEE ALSO + +vndadm(1M), libvnd(3VND) diff --git a/usr/src/man/man3vnd/vnd_walk.3vnd b/usr/src/man/man3vnd/vnd_walk.3vnd new file mode 100644 index 0000000000..bed53130d3 --- /dev/null +++ b/usr/src/man/man3vnd/vnd_walk.3vnd @@ -0,0 +1,155 @@ +'\" 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_CREATE 3VND "Feb 21, 2014" + +.SH NAME + +vnd_walk \- walk all vnd devices + + +.SH SYNOPSIS + +.LP +.nf +cc [ flag... ] file... -lvnd [ library... ] +#include <libvnd.h> + +typedef int (*vnd_walk_cb_f)(vnd_info_t *viip, void *cbarg); + +int vnd_walk(vnd_walk_cb_t cb, void *arg, vnd_errno_t *vnderr, int *syserr); +.fi + + +.SH DESCRIPTION +.LP +The vnd_walk() function fires the callback function cb once for every +vnd device that is visible in the current zone. If the caller is in +the global zone, then all vnd devices in all zones will be walked. If +the caller is in a non-global zone, then only the devices in that zone +will be visible. + +.LP +The function cb will be called with two arguments. The first argument, +viip, is a pointer to a structure that contains information about the +link. The second argument to the function cb, cbarg, is the same +argument that is passed to the function vnd_walk as arg. To continue +the function cb should return zero. If the function cb returns +non-zero the walk will terminate. + +.LP +As the vnd_walk function does not have a handle, errors are returned +in vnderr and syserr. Both vnderr and syserr are allowed to be NULL +pointers. If either one is a NULL pointer, then error information for +that class of error will not be returned. It is not recommended that +consumers supply NULL pointers. + +.LP +The vnd_info_t structure contains the following members: + +.in +2 +.nf +uint32_t vi_version +zoneid_t vi_zone +char vi_name[LIBVND_NAMELEN]; +char vi_datalink[LIBVND_NAMELEN]; +.fi +.in -2 + +.LP +The member vi_version is guaranteed to be the first member of the +structure. This number indicates the current revision of the structure +and is set to the integer value 1. More properties may be added in +future releases. Those properties will be tied to a greater version +number so software knows whether or not it is legal to access them. + +.LP +The vi_zone field indicates the zone id that the vnd device exists in. +The vi_name field is the name of the vnd device. If the vnd_device is +not linked, the name field is set to "<unknown>". The vi_datalink +field is filled in with the name of the data link the vnd device is on +top of. + + +.SH RETURN VALUES + +.LP +The vnd_walk function will return zero on success. If the consumer +supplied callback function returned non-zero, then the vnd_walk +function will return 1. If an error occurred, -1 is returned, and if +vnderr and syserr are non-null, they are filled in with their +respective error values. See vnd_errno(3VND) for more information on +these errors. + +.SH EXAMPLES + +.LP +Example 1 Walk all devices and print information about them + +.LP +The following sample C program walks every vnd device and prints out +information about them. + +.sp +.in +2 +.nf +#include <libvnd.h> +#include <stdio.h> + +static int +print_entry(vnd_info_t *viip, void *unused) +{ + (void) printf("device %s over data link %s in zone %d\n", + viip->vi_name, viip->vi_datalink, viip->vi_zone); + return (0); +} + +int +main(void) +{ + vnd_errno_t vnderr; + int syserr; + + if (vnd_walk(print_entry, NULL, &vnderr, &syserr) != 0) { + (void) fprintf(stderr, "failed to walk vnd devices: %s\n", + vnderr != VND_E_SYS ? vnd_strerror(vnderr) : + vnd_strsyserror(syserr)); + return (1); + } + + return (0); +} +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See attributes(5) for descriptions of the following attributes: + +.sp +.TS +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE +_ +Stability Committed +_ +MT-Level MT-Safe +.TE + +.SH SEE ALSO + +libvnd(3VND), vnd_errno(3VND), attributes(5), zones(5) diff --git a/usr/src/man/man3xnet/Makefile b/usr/src/man/man3xnet/Makefile index 81cd96cba3..cc231f60c4 100644 --- a/usr/src/man/man3xnet/Makefile +++ b/usr/src/man/man3xnet/Makefile @@ -62,6 +62,7 @@ MANLINKS= getaddrinfo.3xnet \ getservbyname.3xnet \ getservbyport.3xnet \ getservent.3xnet \ + htonll.3xnet \ htons.3xnet \ if_freenameindex.3xnet \ if_indextoname.3xnet \ @@ -73,6 +74,7 @@ MANLINKS= getaddrinfo.3xnet \ inet_ntoa.3xnet \ inet_pton.3xnet \ ntohl.3xnet \ + ntohll.3xnet \ ntohs.3xnet \ sethostent.3xnet \ setnetent.3xnet \ @@ -97,6 +99,7 @@ getservbyname.3xnet := LINKSRC = endservent.3xnet getservbyport.3xnet := LINKSRC = endservent.3xnet getservent.3xnet := LINKSRC = endservent.3xnet +htonll.3xnet := LINKSRC = htonl.3xnet htons.3xnet := LINKSRC = htonl.3xnet if_freenameindex.3xnet := LINKSRC = if_nametoindex.3xnet @@ -112,6 +115,7 @@ inet_ntoa.3xnet := LINKSRC = inet_addr.3xnet inet_pton.3xnet := LINKSRC = inet_ntop.3xnet ntohl.3xnet := LINKSRC = htonl.3xnet +ntohll.3xnet := LINKSRC = htonl.3xnet ntohs.3xnet := LINKSRC = htonl.3xnet sethostent.3xnet := LINKSRC = endhostent.3xnet diff --git a/usr/src/man/man3xnet/htonl.3xnet b/usr/src/man/man3xnet/htonl.3xnet index aa8470a28e..dda4586eb7 100644 --- a/usr/src/man/man3xnet/htonl.3xnet +++ b/usr/src/man/man3xnet/htonl.3xnet @@ -7,7 +7,8 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH HTONL 3XNET "Jun 10, 2002" +.\" Portions Copyright (c) 2012 Joyent, Inc. All rights reserved. +.TH HTONL 3XNET "Jan 03, 2013" .SH NAME htonl, htons, ntohl, ntohs \- convert values between host and network byte order @@ -22,6 +23,11 @@ order .LP .nf +\fBuint64_t\fR \fBhtonll\fR(\fBuint64_t\fR \fIhostlonglong\fR); +.fi + +.LP +.nf \fBuint16_t\fR \fBhtons\fR(\fBuint16_t\fR \fIhostshort\fR); .fi @@ -32,18 +38,23 @@ order .LP .nf +\fBuint64_t\fR \fBntohll\fR(\fBuint64_t\fR \fInetlonglong\fR); +.fi + +.LP +.nf \fBuint16_t\fR \fBntohs\fR(\fBuint16_t\fR \fI netshort\fR); .fi .SH DESCRIPTION .sp .LP -These functions convert 16-bit and 32-bit quantities between network byte order -and host byte order. +These functions convert 16-bit, 32-bit, and 64-bit quantities between network +byte order and host byte order. .sp .LP -The \fBuint32_t\fR and \fBuint16_t\fR types are made available by inclusion -of \fB<inttypes.h>\fR\&. +The \fBuint32_t\fR, \fBuint16_t\fR, and \fBuint64_t\fR types are made available +by inclusion of \fB<inttypes.h>\fR\&. .SH USAGE .sp .LP @@ -56,12 +67,12 @@ value of their argument. .SH RETURN VALUES .sp .LP -The \fBhtonl()\fR and \fBhtons()\fR functions return the argument value -converted from host to network byte order. +The \fBhtonl()\fR, \fBhtonll()\fR, and \fBhtons()\fR functions return the +argument value converted from host to network byte order. .sp .LP -The \fBntohl()\fR and \fBntohs()\fR functions return the argument value -converted from network to host byte order. +The \fBntohl()\fR, \fBntohll()\fR, and \fBntohs()\fR functions return the +argument value converted from network to host byte order. .SH ERRORS .sp .LP diff --git a/usr/src/man/man4/Makefile b/usr/src/man/man4/Makefile index 26e46b0532..806d634969 100644 --- a/usr/src/man/man4/Makefile +++ b/usr/src/man/man4/Makefile @@ -138,6 +138,7 @@ _MANFILES= Intro.4 \ nsmbrc.4 \ nss.4 \ nsswitch.conf.4 \ + overlay_files.4 \ packingrules.4 \ pam.conf.4 \ passwd.4 \ @@ -292,7 +293,6 @@ pcie.4 := LINKSRC = pci.4 sendmail.cf.4 := LINKSRC = sendmail.4 submit.cf.4 := LINKSRC = sendmail.4 - isa.4 := LINKSRC = sysbus.4 dumpdates.4 := LINKSRC = ufsdump.4 diff --git a/usr/src/man/man4/overlay_files.4 b/usr/src/man/man4/overlay_files.4 new file mode 100644 index 0000000000..a0f66c65fd --- /dev/null +++ b/usr/src/man/man4/overlay_files.4 @@ -0,0 +1,169 @@ +.\" +.\" 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 2015, Joyent, Inc. +.\" +.Dd Apr 13, 2015 +.Dt OVERLAY_FILES 4 +.Os +.Sh NAME +.Nm overlay_files +.Nd Overlay files plugin file format +.Sh DESCRIPTION +The +.Sy files +plugin provides a means for a dynamic overlay where the destinations are +determined based on a static description contained in a +.Sy JSON +file. This manual describes the format of the file used by the +.Sy files/config +property. To create and manage overlays +with the +.Sy files +plugin, use +.Xr dladm 1M . +For more information on overlays, see +.Xr overlay 5 . +.Pp +Using the +.Sy files +module, a static and simple overlay network can be created. This network +does not support the use of +.Em broadcast +or +.Em multicast +traffic. Both ARP and NDP traffic are proxied by the plugin itself. In +addition, the plugin allows for DHCP. Instead of providing a traditional +DHCP proxy, when an initial DHCP broadcast goes out to a broadcast +address, it will get rewritten to target a specific MAC address. The +.Sy files +plugin is useful as proof of concept and for simple static networks +where addresses do not need to be reconfigured. If more advanced +topologies or more streamlined updates are required, consider a different +plugin. +.Pp +The file format is encoded as a series of +.Sy JSON +objects. Each object has a key, which is a MAC address on the +.Sy overlay +network. It has multiple values, some required, some optional, which +describe various properties. The valid properties are: +.Bl -hang -width Ds +.It Sy ip +.Bd -filled -compact +The +.Sy ip +key indicates the IP address on the +.Sy underlay +network that houses the MAC address in question. Packets directed for +the MAC address will be encapsulated and set to this address. This field +is required. +.Pp +The value is a +.Em JSON String . +Both IPv4 and IPv6 addresses are supported and should be written out in their +traditional forms. Follow the guidelines for writing addresses in +.Xr inet_aton 3SOCKET . +.Ed +.It Sy port +.Bd -filled -compact +The +.Sy port +key indicates the port on the +.Sy underlay +network that houses the MAC address in question. This property is required if +the encapsulation module requires a port for its destination. The value is +a +.Em JSON Number . +.Ed +.It Sy arp +.Bd -filled -compact +The +.Sy arp +key stores the IPv4 address that corresponds to this MAC address on the +.Sy overlay +network. This will be used to respond to ARP queries that would traditionally +have been received by the OS kernel. If this address is not present, no IPv4 +packets directed to this IP address will be received by the network interface +that has this MAC address, regardless of what is configured on top of it. +.Pp +The value is a +.Em JSON String +and should be written out following the guidelines for IPv4 addresses in +.Xr inet_aton 3SOCKET . +.Ed +.It Sy ndp +.Bd -filled -compact +The +.Sy ndp +key stores the IPv6 address that corresponds to this MAC address on the +.Sy overlay +network. This will be used to respond to NDP queries that would traditionally +have been received by the OS kernel. If this address is not present, no IPv6 +packets directed to this IP address will be received by the network interface +that has this MAC address, regardless of what is configured on top of it. +.Pp +The value is a +.Em JSON String +and should be written out following the guidelines for IPv6 addresses in +.Xr inet_aton 3SOCKET . +.Ed +.It Sy dhcp-proxy +.Bd -filled -compact +The +.Sy dhcp-proxy +key stores a MAC address that DHCP messages directed to a broadcast address get +rewritten to be sent to. This can be viewed as a form of proxy DHCP, but is +different in mechanism from a traditional proxy. The value is a +.Em JSON String +and should be written as a traditional MAC address string as described by +.Xr ether_aton 3SOCKET . +.Ed +.El +.Sh EXAMPLES +.Sy Example 1 +Sample configuration file +.Pp +This configuration file provides information for three different MAC +addresses. Each MAC address has an entry which describes what its IPv4 +and IPv6 address is, as well as the IP address and port of the host on +the underlay network. Finally, one host has a DHCP proxy entry to +demonstrate how one might configure DHCP. +.Bd -literal -offset indent +{ + "de:ad:be:ef:00:00": { + "arp": "10.55.55.2", + "ip": "10.88.88.69", + "ndp": "fe80::3", + "port": 4789 + }, + "de:ad:be:ef:00:01": { + "arp": "10.55.55.3", + "dhcp-proxy": "de:ad:be:ef:00:00", + "ip": "10.88.88.70", + "ndp": "fe80::4", + "port": 4789 + }, + "de:ad:be:ef:00:02": { + "arp": "10.55.55.4", + "ip": "10.88.88.71", + "ndp": "fe80::5", + "port": 4789 + } +} +.Ed +.Sh STABILITY +This file format is +.Sy committed ; +however, keys that are not listed here are reserved for future use. +.Sh SEE ALSO +.Xr dladm 1M , +.Xr overlay 5 diff --git a/usr/src/man/man4/proc.4 b/usr/src/man/man4/proc.4 index 59fd43f9a0..4f123bfd93 100644 --- a/usr/src/man/man4/proc.4 +++ b/usr/src/man/man4/proc.4 @@ -1,7 +1,7 @@ '\" te .\" Copyright 1989 AT&T .\" Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright (c) 2013, Joyent, Inc. All rights reserved. +.\" Copyright 2015, Joyent, Inc. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -665,6 +665,18 @@ the process. \fBpr_what\fR is unused in this case. .RE .sp +.ne 2 +.na +\fB\fBPR_BRAND\fR\fR +.ad +.RS 17n +indicates that the lwp stopped for a brand-specific reason. Interpretation +of the value of \fBpr_what\fR depends on which zone brand is in use. It is +not generally expected that an lwp stopped in this state will be restarted +by native \fBproc\fR(4) consumers. +.RE + +.sp .LP \fBpr_cursig\fR names the current signal, that is, the next signal to be delivered to the lwp, if any. \fBpr_info\fR, when the lwp is in a @@ -922,6 +934,15 @@ migrate to checking \fBPR_ISSYS\fR in the \fBpstatus\fR structure's 0x8000). \fBpr_pctcpu\fR is the summation over all lwps in the process. .sp .LP +The \fBpr_fname\fR and \fBpr_psargs\fR are writable by the owner of the +process. To write to them, the \fBpsinfo\fR file should be open for writing +and the desired value for the field should be written at the file offset +that corresponds to the member of structure. No other entry may be written +to; if a write is attempted to an offset that does not represent one of +these two memers, or if the size of the write is not exactly the size of +the member being written, no bytes will be written and zero will be returned. +.sp +.LP \fBpr_lwp\fR contains the \fBps\fR(1) information for the representative lwp. If the process is a \fIzombie\fR, \fBpr_nlwp\fR, \fBpr_nzomb\fR, and \fBpr_lwp.pr_lwpid\fR are zero and the other fields of \fBpr_lwp\fR are @@ -1066,6 +1087,12 @@ Contains the initial values of the process's aux vector in an array of \fBauxv_t\fR structures (see \fB<sys/auxv.h>\fR). The values are those that were passed by the operating system as startup information to the dynamic linker. +.SS "argv" +.LP +Contains the concatenation of each of the argument strings, including their +\fBNUL\fR terminators, in the argument vector (\fBargv\fR) for the process. If +the process has modified either its argument vector, or the contents of any of +the strings referenced by that vector, those changes will be visible here. .SS "ldt" .LP This file exists only on x86-based machines. It is non-empty only if the @@ -2538,6 +2565,16 @@ process aux vector .sp .ne 2 .na +\fB\fB/proc/\fIpid\fR/argv\fR\fR +.ad +.sp .6 +.RS 4n +process argument vector +.RE + +.sp +.ne 2 +.na \fB\fB/proc/\fIpid\fR/ldt\fR\fR .ad .sp .6 diff --git a/usr/src/man/man4/process.4 b/usr/src/man/man4/process.4 index 50f80efca2..d709decfce 100644 --- a/usr/src/man/man4/process.4 +++ b/usr/src/man/man4/process.4 @@ -1,9 +1,10 @@ '\" te .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 2016, Joyent, Inc. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH PROCESS 4 "Mar 25, 2008" +.TH PROCESS 4 "Sept 6, 2016" .SH NAME process \- process contract type .SH SYNOPSIS @@ -205,6 +206,21 @@ exits. .sp .ne 2 .na +\fB\fBCT_PR_KEEP_EXEC\fR\fR +.ad +.sp .6 +.RS 4n +If set, the process contract template remains active across \fBexec\fR(2). +This can be used to setup a contract for children of an application which +is not contract-aware. If this is not set then the system clears the active +template when the process execs. Because this option is intended for an +application which is not contract-aware, new child process contracts will be +automatically abandoned by the parent. +.RE + +.sp +.ne 2 +.na \fB\fBCT_PR_NOORPHAN\fR\fR .ad .sp .6 diff --git a/usr/src/man/man5/Makefile b/usr/src/man/man5/Makefile index 0a00068722..3faa1135cd 100644 --- a/usr/src/man/man5/Makefile +++ b/usr/src/man/man5/Makefile @@ -14,7 +14,7 @@ # Copyright (c) 2012 by Delphix. All rights reserved. # Copyright 2014 Nexenta Systems, Inc. # Copyright 2014 Garrett D'Amore <garrett@damore.org> -# Copyright (c) 2015, Joyent, Inc. All rights reserved. +# Copyright 2016, Joyent, Inc. # include $(SRC)/Makefile.master @@ -59,6 +59,7 @@ MANFILES= Intro.5 \ iconv_unicode.5 \ ieee802.3.5 \ ieee802.11.5 \ + inotify.5 \ ipfilter.5 \ isalist.5 \ kerberos.5 \ @@ -69,6 +70,7 @@ MANFILES= Intro.5 \ lfcompile.5 \ lfcompile64.5 \ locale.5 \ + lx.5 \ man.5 \ mandoc_char.5 \ mandoc_roff.5 \ @@ -79,6 +81,7 @@ MANFILES= Intro.5 \ ms.5 \ mutex.5 \ nfssec.5 \ + overlay.5 \ pam_allow.5 \ pam_authtok_check.5 \ pam_authtok_get.5 \ diff --git a/usr/src/man/man5/brands.5 b/usr/src/man/man5/brands.5 index 9d7ce16d42..cc79ac173a 100644 --- a/usr/src/man/man5/brands.5 +++ b/usr/src/man/man5/brands.5 @@ -83,5 +83,4 @@ Interface Stability Evolving \fBin.rlogind\fR(1M), \fBsshd\fR(1M), \fBzoneadm\fR(1M), \fBzonecfg\fR(1M), \fBkill\fR(2), \fBpriocntl\fR(2), \fBgetzoneid\fR(3C), \fBucred_get\fR(3C), \fBgetzoneid\fR(3C), \fBproc\fR(4), \fBattributes\fR(5), \fBlx\fR(5), -\fBnative\fR(5), \fBprivileges\fR(5), \fBzones\fR(5), \fBlx_systrace\fR(7D), -\fBcrgetzoneid\fR(9F) +\fBprivileges\fR(5), \fBzones\fR(5), \fBcrgetzoneid\fR(9F) diff --git a/usr/src/man/man5/ieee802.3.5 b/usr/src/man/man5/ieee802.3.5 index 4f6cb9a953..b77c378db2 100644 --- a/usr/src/man/man5/ieee802.3.5 +++ b/usr/src/man/man5/ieee802.3.5 @@ -21,7 +21,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE .\" -.Dd "Jan 29, 2016" +.Dd "Nov 23, 2016" .Dt IEEE802.3 5 .Os .Sh NAME @@ -88,8 +88,12 @@ Advertises 10 Gbps support. Advertises 10 Mbps half-duplex support. .It Sy adv_cap_2500fdx Advertises 2.5 Gbps support. +.It Sy adv_cap_50gfdx +Advertises 50 Gbps support. .It Sy adv_cap_40gfdx Advertises 40 Gbps support. +.It Sy adv_cap_25gfdx +Advertises 25 Gbps support. .It Sy adv_cap_5000fdx Advertises 5 Gbps support. .It Sy adv_cap_autoneg @@ -126,8 +130,12 @@ Device supports 10 Gpbs. Device supports 10 Mbps half-duplex. .It Sy cap_2500fdx Device supports 2.5 Gbps. +.It Sy cap_50gfdx +Device supports 50 Gpbs. .It Sy cap_40gfdx Device supports 40 Gpbs. +.It Sy cap_25gfdx +Device supports 25 Gpbs. .It Sy cap_5000fdx Device supports 5 Gbps. .It Sy cap_asmpause @@ -208,8 +216,12 @@ Peer supports 10 Mbps half-duplex. Peer supports 2.5 Gbps. .It Sy lp_cap_5000fdx Peer supports 5 Gbps. +.It Sy lp_cap_50gfdx +Peer supports 50 Gbps. .It Sy lp_cap_40gfdx Peer supports 40 Gbps. +.It Sy lp_cap_25gfdx +Peer supports 25 Gbps. .It Sy lp_cap_asmpause Peer supports asymmetric flow control. .It Sy lp_cap_autoneg diff --git a/usr/src/man/man5/inotify.5 b/usr/src/man/man5/inotify.5 new file mode 100644 index 0000000000..9b0016101d --- /dev/null +++ b/usr/src/man/man5/inotify.5 @@ -0,0 +1,305 @@ +'\" te +.\" Copyright (c) 2014, Joyent, Inc. All Rights Reserved. +.\" 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. +.TH INOTIFY 5 "Sep 17, 2014" +.SH NAME +inotify \- Linux-compatible file event notification facility +.SH SYNOPSIS + +.LP +.nf +#include <sys/inotify.h> +.fi + +.SH DESCRIPTION +.sp +.LP + +\fBinotify\fR is a facility for receiving file system events on specified +files or directories. When monitoring a directory, \fBinotify\fR can be +used to retrieve events not only on the directory, but also on any files +that the directory contains. \fBinotify\fR originated with Linux, and +this facility is designed to be binary-compatible with the Linux facility, +including the following interfaces: + +.RS +4 +.TP +.ie t \(bu +.el o +\fBinotify_init\fR(3C) creates an \fBinotify\fR instance, returning a file +descriptor associated with the in-kernel event queue. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +\fBinotify_init1\fR(3C) also creates an \fBinotify\fR instance, but allows +for a flags argument that controls some attributes of the returned file +descriptor. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +\fBinotify_add_watch\fR(3C) allows a watch of a particular file or directory +to be added to a watch list associated with the specified \fBinotify\fR +instance. \fBinotify_add_watch\fR(3C) returns a watch descriptor that will +be reflected in the \fIwd\fR member of the \fIinotify_event\fR structure +returned via a \fBread\fR(2) of the instance. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +\fBinotify_rm_watch\fR(3C) removes the watch that corresponds to the specified +watch descriptor. +.RE + +When all file descriptors referring to a particular \fBinotify\fR instance +are closed, the instance and all watches associated with that instance are +freed. + +To consume events on an \fBinotify\fR instance, an application should +issue a \fBread\fR(2) to the instance. If no events are available +(and the \fBinotify\fR instance has not been explicitly made non-blocking +via \fBinotify_init1\fR(3C)) the \fBread\fR(2) will block until a +watched event occurs. If and when events are available, \fBread\fR(2) will +return an array of the following structures: + +.sp +.in +2 +.nf +struct inotify_event { + int wd; /* watch descriptor */ + uint32_t mask; /* mask of event */ + uint32_t cookie; /* cookie for associating renames */ + uint32_t len; /* size of name field */ + char name[]; /* optional name */ +}; +.fi +.in -2 + +\fIwd\fR contains the watch descriptor that corresponds to the event, +as returned by \fBinotify_add_watch\fR(3C). + +\fImask\fR is a bitwise \fBOR\fR of event masks (see below) that +describes the event. + +\fIcookie\fR is an opaque value that can be used to associate different +events into a single logical event. In particular, it allows consumers to +associate \fBIN_MOVED_FROM\fR events with subsequent \fBIN_MOVED_TO\fR +events. + +\fIlen\fR denotes the length of the \fIname\fR field, including any padding +required for trailing null bytes and alignment. The size of the entire +event is therefore the size of the \fIinotify_event\fR structure plus the +value of \fIlen\fR. + +\fIname\fR contains the name of the file associated with the event, if any. +This field is only present when the watched entity is a directory and +the event corresponds to a file that was contained by the watched directory +(though see \fBNOTES\fR and \fBWARNINGS\fR for details and limitations). +When present, \fIname\fR is null terminated, and may contain additional +zero bytes +to pad for alignment. (The length of this field -- including any bytes +for alignment -- is denoted by the \fIlen\fR field.) + +.SS "Events" + +The events that can be generated on a watched entity are as follows: + +.sp +.in +2 +.TS +c c +l l . +\fIEvent\fR \fIDescription\fR +\fBIN_ACCESS\fR File/directory was accessed +\fBIN_ATTRIB\fR File/directory attributes were changed +\fBIN_CLOSE_WRITE\fR File/directory opened for writing was closed +\fBIN_CLOSE_NOWRITE\fR File/directory not opened for writing was closed +\fBIN_CREATE\fR File/directory created in watched directory +\fBIN_DELETE\fR File/directory deleted from watched directory +\fBIN_DELETE_SELF\fR Watched file/directory was deleted +\fBIN_MODIFY\fR File/directory was modified +\fBIN_MODIFY_SELF\fR Watched file/directory was modified +\fBIN_MOVED_FROM\fR File was renamed from entity in watched directory +\fBIN_MOVED_TO\fR File was renamed to entity in watched directory +\fBIN_OPEN\fR File/directory was opened +.TE +.in -2 + +Of these, all events except \fBIN_MOVE_SELF\fR and \fBIN_DELETE_SELF\fR +can refer to either the watched entity or (if the watched entity +is a directory) a file or directory contained by the watched directory. +(See \fBNOTES\fR and \fBWARNINGS\fR, below for details on this +mechanism and its limitations.) +If the event corresponds to a contained entity, +\fIname\fR will be set to the name of the affected +entity. + +In addition to speciyfing events of interest, watched events may +be modified by potentially setting any of the following when adding a +watch via \fBinotify_add_watch\fR(3C): + +.sp +.ne 2 +.na +\fBIN_DONT_FOLLOW\fR +.ad +.RS 12n +Don't follow the specified pathname if it is a symbolic link. +.RE + +.sp +.ne 2 +.na +\fBIN_EXCL_UNLINK\fR +.ad +.RS 12n +If watching a directory and a contained entity becomes unlinked, cease +generating events for that entity. (By default, contained entities will +continue to generate events on their former parent directory.) +.RE + +.sp +.ne 2 +.na +\fBIN_MASK_ADD\fR +.ad +.RS 12n +If the specified pathname is already being watched, the specified events +will be added to the watched events instead of the default behavior of +replacing them. (If one +may forgive the editorializing, this particular interface gewgaw +seems entirely superfluous, and a canonical example of +feasibility trumping wisdom.) +.RE + +.sp +.ne 2 +.na +\fBIN_ONESHOT\fR +.ad +.RS 12n +Once an event has been generated for the watched entity, remove the +watch from the watch list as if \fBinotify_rm_watch\fR(3C) had been called +on it (thereby inducing an \fBIN_IGNORED\fR event). +.RE + +.sp +.ne 2 +.na +\fBIN_ONLYDIR\fR +.ad +.RS 12n +Only watch the specified pathname if it is a directory. +.RE + +In addition to the specified events, the following bits may be specified +in the \fImask\fR field as returned from \fBread\fR(2): + +.sp +.ne 2 +.na +\fBIN_IGNORED\fR +.ad +.RS 12n +A watch was removed explicitly (i.e, via \fBinotify_rm_watch\fR(3C)) or +implicitly (e.g., because \fBIN_ONESHOT\fR was set or because the watched +entity was deleted). +.RE + +.sp +.ne 2 +.na +\fBIN_ISDIR\fR +.ad +.RS 12n +The entity inducing the event is a directory. +.RE + +.sp +.ne 2 +.na +\fBIN_Q_OVERFLOW\fR +.ad +.RS 12n +The event queue exceeded the maximum event queue length per instance. +(By default, this is 16384, but it can be tuned by setting +\fBinotify_maxevents\fR via \fB/etc/system\fR.) +.RE + +.sp +.ne 2 +.na +\fBIN_UNMOUNT\fR +.ad +.RS 12n +The filesystem containing the watched entity was unmounted. +.RE + +.sp +.SH NOTES +.sp +.LP + +\fBinotify\fR instances can be monitored via \fBpoll\fR(2), +\fBport_get\fR(3C), \fBepoll\fR(5), etc. + +The event queue associated with an \fBinotify\fR instance is serialized +and ordered: events will be placed on the tail of the queue in the order +that they occur. + +If at the time an event occurs the tail of the event queue is identical +to the newly received event, the newly received event will be dropped, +effectively coalescing the two events. + +When watching a directory and receieving events on contained elements +(i.e., a contained file or subdirectory), note that the information +received in the \fIname\fR field may be stale: the file may have been +renamed between the event and its processing. If a file has been unlinked +(and if \fBIN_EXCL_UNLINK\fR has not been set), +the \fIname\fR will reflect the last name that resolved to the file. +If a new file is created in the same directory with the old name, events +on the new file and the old (unlinked) file will become undistinguishable. + +The number of bytes that are available to be read on an \fBinotify\fR +instance can be determined via a \fBFIONREAD\fR \fBioctl\fR(2). + +.sp +.SH WARNINGS +.sp +.LP + +While a best effort has been made to mimic the Linux semantics, there +remains a fundamental difference with respect to hard links: on Linux, +if a file has multiple hard links to it, a notification on a watched +directory or file will be received if and only if that event was received +via the watched path. For events that are induced by open files +(such as \fBIN_MODIFY\fR), these semantics seem peculiar: the watched +file is in fact changing, but because it is not changing via the watched +path, no notification is received. By contrast, the implementation here +will always yield an event in this case -- even if the event was induced +by an \fBopen\fR(2) via an unwatched path. If an event occurs within a +watched directory on a file for which there exist multiple hard links within +the same (watched) directory, the event's \fIname\fR will correspond to one +of the links to the file. If multiple hard links exist to the +same file in the same watched directory and one of the links is removed, +notifications may not necessarily continue to be received for the file, +despite the (remaining) link in the watched directory; users of +\fBinotify\fR should exercise extreme caution when watching directories +that contain files with multiple hard links in the same directory. + +.SH SEE ALSO +.sp +.LP +\fBinotify_init\fR(3C), \fBinotify_init1\fR(3C), \fBinotify_add_watch\fR(3C), +\fBinotify_rm_watch\fR(3C), \fBport_get\fR(3C), \fBepoll\fR(5) diff --git a/usr/src/man/man5/lx.5 b/usr/src/man/man5/lx.5 new file mode 100644 index 0000000000..0060f9ecfa --- /dev/null +++ b/usr/src/man/man5/lx.5 @@ -0,0 +1,108 @@ +.\" +.\" 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 2016, Joyent, Inc. +.\" +.Dd February 5, 2106 +.Dt LX 5 +.Os +.Sh NAME +.Nm lx +.Nd zone brand for running a GNU/Linux user-level environment +.Sh DESCRIPTION +The +.Em lx +brand +uses the +.Xr brands 5 +framework to provide an environment for running binary applications built +for GNU/Linux. User-level code, including an entire Linux distribution, can +run inside the zone. Both 32-bit and 64-bit applications are supported. The +majority of Linux system calls are provided, along with emulation for a +variety of Linux file systems, such as +.Em proc , +.Em cgroup +and +.Em sysfs . +.Pp +The +.Em /proc +file system within the zone is a subset of a full Linux +.Em /proc . +Most kernel-level tuning applied to +.Em /proc +is unavailable or ignored. Some tuning can be performed, but only to reduce +the overall limits that have been specified on the zone's configuration. +That is, within the zone there is no way to increase the resource limits set +on the zone itself. +.Pp +The zone must be installed using a clone of a +.Xr zfs 1m +dataset which contains an image of the software to be run in the zone. +.Pp +Example: +.Dl zoneadm -z myzone install -x nodataset -t debian7 +.Pp +Applications provided by the base SunOS operating system are also available +within the zone under the +.Em /native +mount point. This allows the use of various native tools such as +.Xr dtrace 1m , +.Xr mdb 1 , +or the +.Xr proc 1 +tools on GNU/Linux applications. However, not every native tool will work +properly within an +.Em lx +zone. +.Sh CONFIGURATION +The +.Em kernel-version +attribute can be included in the zone's +.Xr zonecfg 1m +settings as a way to specify the Linux version that the zone is emulating. For +example, the value could be +.Em 3.13.0 . +.Sh LIMITATIONS +The brand only supports the exclusive IP stack zone configuration. +.Pp +Most modern GNU/Linux application software runs on +.Em lx , +but because there are some system calls or file systems which are not currently +implemented, it's possible that an application won't run. This does not +preclude the application running in the future as the +.Em lx +brand adds new capabilities. +.Pp +Because there is only the single SunOS kernel running on the system, there +is no support for any Linux kernel-level modules. That is, there is no support +for add-on drivers or any other modules that are part of the Linux kernel +itself. If that is required, a full virtual machine should be used instead of +an +.Em lx +branded zone. +.Pp +Any core files produced within the zone are in the native SunOS format. +.Pp +As with any zone, the normal security mechanisms and privileges apply. Thus, +certain operations (for example, changing the system time), will not be allowed +unless the zone has been configured with the appropriate additional privileges. +.Sh SEE ALSO +.Xr mdb 1 , +.Xr proc 1 , +.Xr dtrace 1m , +.Xr zfs 1m , +.Xr zoneadm 1m , +.Xr zonecfg 1m , +.Xr brands 5 , +.Xr privileges 5 , +.Xr resource_controls 5 , +.Xr zones 5 diff --git a/usr/src/man/man5/overlay.5 b/usr/src/man/man5/overlay.5 new file mode 100644 index 0000000000..c415cad4b6 --- /dev/null +++ b/usr/src/man/man5/overlay.5 @@ -0,0 +1,499 @@ +.\" +.\" 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 2015 Joyent, Inc. +.\" +.Dd Apr 09, 2015 +.Dt OVERLAY 5 +.Os +.Sh NAME +.Nm overlay +.Nd Overlay Devices +.Sh DESCRIPTION +Overlay devices are a GLDv3 device that allows users to create overlay +networks that can be used to form the basis of network virtualization +and software defined networking. Overlay networks allow a single +physical network, often called an +.Sy underlay +network, to provide the means for creating multiple logical, isolated, +and discrete layer two and layer three networks on top of it. +.Pp +Overlay devices are administered through +.Xr dladm 1M . +Overlay devices themselves cannot be plumbed up with +.Sy IP , +.Sy vnd , +or any other protocol. Instead, like an +.Sy etherstub , +they allow for VNICs to be created on top of them. Like an +.Sy etherstub , +an overlay device acts as a local switch; however, when it encounters a +non-local destination address, it instead looks up where it should send +the packet, encapsulates it, and sends it out another interface in the +system. +.Pp +A single overlay device encapsulates the logic to answer two different, +but related, questions: +.Pp +.Bl -enum -offset indent -compact +.It +How should a packet be transformed and put on the wire? +.It +Where should a transformed packet be sent? +.El +.Pp +Each of these questions is answered by a plugin. The first question is +answered by what's called an +.Em encapsulation plugin . +The second question is answered by what's called a +.Em search plugin . +Packets are encapsulated and decapsulated using the encapsulation plugin +by the kernel. The search plugins are all user land plugins that are +consumed by the varpd service whose FMRI is +.Em svc:/network/varpd:default . +This separation allows for the kernel to be responsible for the data +path, while having the search plugins in userland allows the system to +provide a much more expressive interface. +.Ss Overlay Types +Overlay devices come in +two different flavors, one where all packets are always sent to a single +address, the other, where the destination of a packet varies based on +the target MAC address of the packet. This information is maintained in +a +.Em target table , +which is independent and unique to each overlay device. We call the +plugins that send traffic to a single location, for example a single +unicast or multicast IP address, a +.Sy point to point +overlay and the overlay devices that can send traffic to different +locations based on the MAC address of that packet a +.Sy dynamic +overlay. The plugin type is determined based on the type of the +.Sy search plugin . +These are all fully listed in the section +.Sx Plugins and their Properties . +.Ss Overlay Destination +Both encapsulation and search plugins define the kinds of destinations +that they know how to support. An encapsulation plugin always has a +single destination type that's determined based on how the encapsulation +is defined. A search plugin, on the other hand, can support multiple +combinations of destinations. A search plugin must support the +destination type of the encapsulation device. The destination may +require any of the following three pieces of information, depending on +the encapsulation plugin: +.Bl -hang -width Ds +.It Sy MAC Address +.Bd -filled -compact +An Ethernet MAC address is required to determine the destination. +.Ed +.It Sy IP Address +.Bd -filled -compact +An IP address is required. Both IPv4 and IPv6 addresses are supported. +.Ed +.It Sy Port +.Bd -filled -compact +An IP protocol level (TCP, UDP, SCTP, etc.) port is required. +.Ed +.El +.Pp +The list of destination types that are supported by both the search and +encapsulation plugins is listed in the section +.Sx Plugins and their Properties . +.Ss varpd +The varpd service, mentioned above, is responsible for providing the +virtual ARP daemon. Its responsibility is conceptually similar to ARP. +It runs all instances of search plugins in the system and is responsible +for answering the kernel's ARP-like questions for where packets should +be sent. +.Pp +The varpd service, svc:/network/varpd:default, must be enabled for +overlay devices to function. If it is disabled while there are active +devices, then most overlay devices will not function correctly and +likely will end up dropping traffic. +.Sh PLUGINS AND PROPERTIES +Properties fall into three categories in the system: +.Bl -enum -offset indent -compact +.It +Generic properties all overlay devices have +.It +Properties specific to the encapsulation plugin +.It +Properties specific to the search plugin +.El +.Pp +Each property in the system has the following attributes, which mirror +the traditional +.Xr dladm 1M +link properties: +.Bl -hang -width Ds +.It Sy Name +.Bd -filled -compact +The name of a property is namespaced by its module and always structured +and referred to as as module/property. This allows for both an +encapsulation and search plugin to have a property with the same name. +Properties that are valid for all overlay devices and not specific to a +module do not generally use a module prefix. +.Pp +For example, the property +.Sy vxlan/listen_ip +is associated with the +.Sy vxlan +encapsulation module. +.Ed +.It Sy Type +.Bd -filled -compact +Each property in the system has a type. +.Xr dladm 1M +takes care of converting between the internal representation and a +value, but the type influences the acceptable input range. The types +are: +.Bl -hang -width Ds +.It Sy INT +A signed integer that is up to eight bytes long +.Pq Sy int64_t . +.It Sy UINT +An unsigned integer that is up to eight bytes long +.Pq Sy uint64_t . +.It Sy IP +Either an IPv4 or IPv6 address in traditional string form. For example, +192.168.128.23 or 2001:470:8af4::1:1. IPv4 addresses may also be encoded +as IPv4-mapped IPv6 addresses. +.It Sy STRING +A string of ASCII or UTF-8 encoded characters terminated with a +.Sy NUL +byte. The maximum string length, including the terminator, is currently +256 bytes. +.El +.Ed +.It Sy Permissions +.Bd -filled -compact +Each property has permissions associated with it, which indicate whether +the system considers them read-only properties or read-write properties. +A read-only property can never be updated once the device is created. +This generally includes things like the overlay's encapsulation module. +.Ed +.It Sy Required +.Bd -filled -compact +This property indicates whether the property is required for the given +plugin. If it is not specified during a call to +.Sy dladm create-overlay , +then the overlay cannot be successfully created. Properties which have a +.Sy default +will use that value if one is not specified rather than cause the +overlay creation to fail. +.Ed +.It Sy Current Value +.Bd -filled -compact +The current value of a property, if the property has a value set. +Required properties always have a value set. +.Ed +.It Sy Default Value +.Bd -filled -compact +The default value is an optional part of a given property. If a property +does define a default value, then it will be used when an overlay is +created and no other value is given. +.Ed +.It Sy Value ranges +.Bd -filled -compact +Value ranges are an optional part of a given property. They indicate a +range or set of values that are valid and may be set for a property. A +property may not declare such a range as it may be impractical or +unknown. For example, most properties based on IP addresses will not +declare a range. +.Ed +.El +.Pp +The following sections describe both the modules and the properties that +exist for each module, noting their name, type, permissions, whether or +not they are required, and if there is a default value. In addition, the +effects of each property will be described. +.Ss Encapsulation Plugins +.Bl -hang -width Ds +.It Sy vxlan +The +.Sy vxlan +module is a UDP based encapsulation method. It takes a frame that would +be put on the wire, wraps it up in a VXLAN header and places it in a UDP +packet that gets sent out on the underlying network. For more details +about the specific format of the VXLAN header, see +.Xr vxlan 7P . +.Pp +The +.Sy vxlan +module requires both an +.Sy IP address +and +.Sy port +to address it. It has a 24-bit virtual network ID space, allowing for +virtual network identifiers that range from +.Sy 0 +- +.Sy 16777215 . +.Pp +The +.Sy vxlan +module has the following properties: +.Bl -hang -width Ds +.It Sy vxlan/listen_ip +.Bd -filled -compact +Type: +.Sy IP | +Permissions: +.Sy Read/Write | +.Sy Required +.Ed +.Bd -filled +The +.Sy vxlan/listen_ip +property determines the IP address that the system will accept VXLAN +encapsulated packets on for this overlay. +.Ed +.It Sy vxlan/listen_port +.Bd -filled -compact +Type: +.Sy UINT | +Permissions: +.Sy Read/Write | +.Sy Required +.Ed +.Bd -filled -compact +Default Value: +.Sy 4789 | +Range: +.Sy 0 - 65535 +.Ed +.Bd -filled +The +.Sy vxlan/listen_port +property determines the UDP port that the system will listen on for +VXLAN traffic for this overlay. The default value is +.Sy 4789 , +the IANA assigned port for VXLAN. +.Ed +.El +.Pp +The +.Sy vxlan/listen_ip +and +.Sy vxlan/listen_port +properties determine how the system will accept VXLAN encapsulated +packets for this interface. It does not determine the interface that +packets will be sent out over. Multiple overlays that all use VXLAN can +share the same IP and port combination, as the virtual network +identifier can be used to tell the different overlays apart. +.El +.Ss Search Plugins +Because search plugins may support multiple destinations, they may have +more properties listed than necessarily show up for a given overlay. +For example, the +.Sy direct +plugin supports destinations that are identified by both an IP address +and a port, or just an IP address. In cases where the device is created +over an overlay that only uses an IP address for its destination, then +it will not have the +.Sy direct/dest_port +property. +.Bl -hang -width Ds +.It Sy direct +The +.Sy direct +plugin is a point to point module that can be used to create an overlay +that forwards all non-local traffic to a single destination. It supports +destinations that are a combination of an +.Sy IP Address +and a +.Sy port . +.Pp +The +.Sy direct +plugin has the following properties: +.Bl -hang -width Ds +.It Sy direct/dest_ip +.Bd -filled -compact +Type: +.Sy IP | +Permissions: +.Sy Read/Write | +.Sy Required +.Ed +.Bd -filled +The +.Sy direct/dest_ip +property indicates the IP address that all traffic will be sent out. +Traffic will be sent out the corresponding interface based on +traditional IP routing rules and the configuration of the networking +stack of the global zone. +.Ed +.It Sy direct/dest_port +.Bd -filled -compact +Type: +.Sy UINT | +Permissions: +.Sy Read/Write | +.Sy Required +.Ed +.Bd -filled -compact +Default Value: +.Sy - | +Range: +.Sy 0 - 65535 +.Ed +.Bd -filled +The +.Sy direct/dest_port +property indicates the TCP or UDP port that all traffic will be directed +to. +.Ed +.El +.It Sy files +The +.Sy files +plugin implements a +.Sy dynamic +plugin that specifies where traffic should be sent based on a file. It +is a glorified version of /etc/ethers. The +.Sy dynamic +plugin does not support broadcast or multicast traffic, but it has +support for proxy ARP, NDP, and DHCPv4. For the full details of the file +format, see +.Xr overlay_files 4 . +.Pp +The +.Sy files +plugin has the following property: +.Bl -hang -width Ds +.It Sy files/config +.Bd -filled -compact +Type: +.Sy String | +Permissions: +.Sy Read/Write | +.Sy Required +.Ed +.Bd -filled +The +.Sy files/config +property specifies an absolute path to a file to read. The file is a +JSON file that is formatted according to +.Xr overlay_files 4 . +.Ed +.El +.El +.Ss General Properties +Each overaly has the following properties which are used to give +additional information about the system. None of these properties may be +specified as part of a +.Sy dladm create-overlay , +instead they come from other arguments or from internal parts of the +system. +.Bl -hang -width Ds +.It Sy encap +.Bd -filled -compact +.Sy String | +Permissions: +.Sy Read Only +.Ed +.Bd -filled +The +.Sy encap +property contains the name of the encapsulation module that's in use. +.Ed +.It Sy mtu +.Bd -filled -compact +.Sy UINT | +Permissions: +.Sy Read/Write +.Ed +.Bd -filled -compact +Default Value: +.Sy 1400 | +Range: +.Sy 576 - 9000 +.Ed +.Bd -filled +The +.Sy mtu +property describes the maximum transmission unit of the overlay. The +default value is +.Sy 1400 +bytes, which ensures that in a traditional deployment with an MTU of +1500 bytes, the overhead that is added from encapsulation is all +accounted for. It is the administrator's responsibility to ensure that +the device's MTU and the encapsulation overhead does not exceed that of +the interfaces that the encapsulated traffic will be sent out of. +.Pp +To modify the +.Sy mtu +property, use +.Sy dladm set-linkprop . +.Ed +.It Sy search +.Bd -filled -compact +.Sy String | +Permissions: +.Sy Read Only +.Ed +.Bd -filled +The +.Sy search +property contains the name of the search plugin that's in use. +.Ed +.It Sy varpd/id +.Bd -filled -compact +.Sy String | +Permissions: +.Sy Read Only +.Ed +.Bd -filled +The +.Sy varpd/id +property indicates the identifier which the +.Sy varpd +service uses for this overlay. +.Ed +.It Sy vnetid +.Bd -filled -compact +.Sy UINT | +Permissions: +.Sy Read/Write +.Ed +.Bd -filled +The +.Sy vnetid +property has the virtual network identifier that belongs to this overlay. +The valid range for the virtual network identifier depends on the +encapsulation engine. +.Ed +.El +.Sh FMA INTEGRATION +Overlay devices are wired into FMA, the illumos fault management +architecture, and generates error reports depending on the +.Sy search +plugin in use. Due to limitations in FMA today, when a single overlay +enters a degraded state, meaning that it cannot properly perform look +ups or another error occurred, then it degrades the overall +.Sy overlay +psuedo-device driver. +.Pp +For more fine-grained information about which overlay is actually in a +.Em degraded +state, one should run +.Sy dladm show-overlay -f . +In addition, for each overlay in a degraded state a more useful +diagnostic message is provided which describes the reason that caused +this overlay to enter into a degraded state. +.Pp +The overlay driver is self-healing. If the problem corrects itself on +its own, it will clear the fault on the corresponding device. +.Sh SEE ALSO +.Xr dladm 1M , +.Xr overlay_files 4 , +.Xr vxlan 7P diff --git a/usr/src/man/man5/privileges.5 b/usr/src/man/man5/privileges.5 index 53b86177e2..ac613ccad5 100644 --- a/usr/src/man/man5/privileges.5 +++ b/usr/src/man/man5/privileges.5 @@ -1,6 +1,6 @@ '\" te .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. -.\" Copyright 2015, Joyent, Inc. All Rights Reserved. +.\" Copyright 2016, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -307,6 +307,16 @@ Allow a process to perform privileged mappings through a graphics device. .sp .ne 2 .na +\fB\fBPRIV_HYPRLOFS_CONTROL\fR\fR +.ad +.sp .6 +.RS 4n +Allow a process to perform hyprlofs name space management. +.RE + +.sp +.ne 2 +.na \fB\fBPRIV_IPC_DAC_READ\fR\fR .ad .sp .6 @@ -475,7 +485,7 @@ Allow a process to change its root directory. .ad .sp .6 .RS 4n -Allow a process to use high resolution timers. +Allow a process to use high resolution timers with very small time values. .RE .sp @@ -697,6 +707,16 @@ Allow a process to configure a system's datalink interfaces. .sp .ne 2 .na +\fB\fBPRIV_SYS_FS_IMPORT\fR\fR +.ad +.sp .6 +.RS 4n +Allow a process to import a potentially untrusted file system (e.g. ZFS recv). +.RE + +.sp +.ne 2 +.na \fB\fBPRIV_SYS_IP_CONFIG\fR\fR .ad .sp .6 diff --git a/usr/src/man/man5/resource_controls.5 b/usr/src/man/man5/resource_controls.5 index fe22484bcc..47e1521f41 100644 --- a/usr/src/man/man5/resource_controls.5 +++ b/usr/src/man/man5/resource_controls.5 @@ -1,15 +1,17 @@ '\" te .\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright (c) 2012, Joyent, Inc. All Rights Reserved. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] .TH RESOURCE_CONTROLS 5 "April 9, 2016" .SH NAME -resource_controls \- resource controls available through project database +resource_controls \- resource controls available through projects and zones .SH DESCRIPTION .LP -The resource controls facility is configured through the project database. See -\fBproject\fR(4). You can set and modify resource controls through the +For projects the resource controls facility is configured through the project +database. See \fBproject\fR(4). For zones, resource controls are configured +through \fBzonecfg\fR(1M). You can set and modify resource controls through the following utilities: .RS +4 .TP @@ -35,6 +37,12 @@ following utilities: .el o \fBrctladm\fR(1M) .RE +.RS +4 +.TP +.ie t \(bu +.el o +\fBzonecfg\fR(1M) +.RE .sp .LP In a program, you use \fBsetrctl\fR(2) to set resource control values. @@ -282,6 +290,19 @@ Maximum allowable number of event ports, expressed as an integer. .sp .ne 2 .na +\fB\fBproject.max-processes\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of processes that can be active in a project. This rctl is +similar to \fBproject.max-lwps\fR, except that zombie processes are included. +This rctl prevents process-slot exhaustion which can occur due to an excessive +number of zombies. Expressed as an integer. +.RE + +.sp +.ne 2 +.na \fB\fBproject.max-sem-ids\fR\fR .ad .sp .6 @@ -370,6 +391,33 @@ The following zone-wide resource controls are available: .sp .ne 2 .na +\fB\fBzone.cpu-baseline\fR\fR +.ad +.sp .6 +.RS 4n +Sets a baseline amount of CPU time that a zone can use before it is considered +to be bursting. The unit used is the percentage of a single CPU that is being +used by all user threads in a zone. The value should be less than the +\fBzone.cpu-cap\fR rctl value and is expressed as an integer. +This resource control does not support the \fBsyslog\fR action. +.RE + +.sp +.ne 2 +.na +\fB\fBzone.cpu-burst-time\fR\fR +.ad +.sp .6 +.RS 4n +Sets the number of seconds that a zone can exceed the \fBzone.cpu-baseline\fR +rctl value before being cpu-capped down to the \fBzone.cpu-baseline\fR. +A value of 0 means that \fBzone.cpu-baseline\fR can be exceeded indefinitely. +This resource control does not support the \fBsyslog\fR action. +.RE + +.sp +.ne 2 +.na \fB\fBzone.cpu-cap\fR\fR .ad .sp .6 @@ -388,7 +436,7 @@ not support the \fBsyslog\fR action. .ad .sp .6 .RS 4n -Sets a limit on the number of fair share scheduler (FSS) CPU shares for a zone. +Sets a value on the number of fair share scheduler (FSS) CPU shares for a zone. CPU shares are first allocated to the zone, and then further subdivided among projects within the zone as specified in the \fBproject.cpu-shares\fR entries. Expressed as an integer. This resource control does not support the @@ -408,14 +456,25 @@ Total amount of physical locked memory available to a zone. .sp .ne 2 .na +\fB\fBzone.max-lofi\fR\fR +.ad +.sp .6 +.RS 4n +Sets a limit on the number of \fBLOFI\fR(7D) devices that can be created in a +zone. Expressed as an integer. This resource control does not support the +\fBsyslog\fR action. +.RE + +.sp +.ne 2 +.na \fB\fBzone.max-lwps\fR\fR .ad .sp .6 .RS 4n -Enhances resource isolation by preventing too many LWPs in one zone from -affecting other zones. A zone's total LWPs can be further subdivided among -projects within the zone within the zone by using \fBproject.max-lwps\fR -entries. Expressed as an integer. +Sets a limit on how many LWPs can be active in a zone. A zone's total LWPs +can be further subdivided among projects within the zone within the zone by +using \fBproject.max-lwps\fR entries. Expressed as an integer. .RE .sp @@ -432,6 +491,33 @@ integer. .sp .ne 2 .na +\fB\fBzone.max-physical-memory\fR\fR +.ad +.sp .6 +.RS 4n +Sets a limit on the amount of physical memory (RSS) that can be used by a zone +before resident pages start being forcibly paged out. The unit used is bytes. +Expressed as an integer. This resource control does not support the +\fBsyslog\fR action. +.RE + +.sp +.ne 2 +.na +\fB\fBzone.max-processes\fR\fR +.ad +.sp .6 +.RS 4n +Maximum number of processes that can be active in a zone. This rctl is +similar to \fBzone.max-lwps\fR, except that zombie processes are included. +This rctl prevents process-slot exhaustion which can occur due to an excessive +number of zombies. This rctl can be further subdivided among projects within +the zone using \fBproject.max-processes\fR. Expressed as an integer. +.RE + +.sp +.ne 2 +.na \fB\fBzone.max-sem-ids\fR\fR .ad .sp .6 @@ -473,6 +559,18 @@ mappings and \fBtmpfs\fR mounts for this zone. .RE .sp +.ne 2 +.na +\fB\fBzone.zfs-io-priority\fR\fR +.ad +.sp .6 +.RS 4n +Sets a value for the \fBzfs\fR(1M) I/O priority for a zone. This is used as +one of the inputs to determine if a zone's I/O should be throttled. Expressed +as an integer. This resource control does not support the \fBsyslog\fR action. +.RE + +.sp .LP See \fBzones\fR(5). .SS "Units Used in Resource Controls" diff --git a/usr/src/man/man7d/Makefile b/usr/src/man/man7d/Makefile index b8a0301748..b7ded478a7 100644 --- a/usr/src/man/man7d/Makefile +++ b/usr/src/man/man7d/Makefile @@ -12,6 +12,7 @@ # # Copyright 2011, Richard Lowe # Copyright 2015 Nexenta Systems, Inc. All rights reserved. +# Copyright 2016 Joyent, Inc. # Copyright 2016 Garrett D'Amore <garrett@damore.org> # Copyright 2016 Joyent, Inc. # Copyright 2016 Hans Rosenfeld <rosenfeld@grumpf.hope-2000.org> @@ -144,11 +145,13 @@ _MANFILES= aac.7d \ virtualkm.7d \ vni.7d \ vr.7d \ + vnd.7d \ wscons.7d \ xge.7d \ yge.7d \ zcons.7d \ - zero.7d + zero.7d \ + zfd.7d sparc_MANFILES= audiocs.7d \ bbc_beep.7d \ diff --git a/usr/src/man/man7d/cpuid.7d b/usr/src/man/man7d/cpuid.7d index cc522b1969..f24f73ed40 100644 --- a/usr/src/man/man7d/cpuid.7d +++ b/usr/src/man/man7d/cpuid.7d @@ -1,5 +1,6 @@ '\" te .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 2015, Joyent, Inc. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] @@ -43,6 +44,10 @@ the years). See the processor manufacturers documentation for further information about the syntax and semantics of the wide variety of information available from this instruction. +.LP +Some systems can be configured to limit the cpuid opcodes which are accessible. +While illumos handles this condition, other software may malfunction when such +limits are enabled. Those settings are typically manipulated in the BIOS. .SH EXAMPLE .LP This example allows you to determine if the current x86 processor supports diff --git a/usr/src/man/man7d/hubd.7d b/usr/src/man/man7d/hubd.7d index d130e4b7ab..c65a663607 100644 --- a/usr/src/man/man7d/hubd.7d +++ b/usr/src/man/man7d/hubd.7d @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH HUBD 7D "Jul 6, 2006" +.TH HUBD 7D "Oct 4, 2016" .SH NAME hubd \- USB hub driver .SH SYNOPSIS @@ -13,11 +13,10 @@ hubd \- USB hub driver .fi .SH DESCRIPTION -.sp .LP -The \fBhubd\fR is a USBA (Solaris USB Architecture) compliant client driver +The \fBhubd\fR is a USBA (illumos USB Architecture) compliant client driver that supports USB hubs conforming to the \fIUniversal Serial Bus Specification -2.0\fR. The \fBhubd\fR driver supports bus-powered and self-powered hubs. The +3.0\fR. The \fBhubd\fR driver supports bus-powered and self-powered hubs. The driver supports hubs with individual port power, ganged power and no power switching. .sp @@ -30,7 +29,6 @@ attaches a driver to the device if one is available for the default or selected configuration. When the device is disconnected from the hub port, the \fBhubd\fR driver offlines any driver instance attached to the device. .SH FILES -.sp .ne 2 .na \fB\fB/kernel/drv/hubd\fR\fR @@ -58,7 +56,6 @@ configuration. When the device is disconnected from the hub port, the .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for a description of the following attributes: .sp @@ -74,7 +71,6 @@ Architecture SPARC, x86, PCI-based systems .TE .SH SEE ALSO -.sp .LP \fBcfgadm_usb\fR(1M), \fBattributes\fR(5), \fBusba\fR(7D) .sp @@ -90,7 +86,6 @@ Architecture SPARC, x86, PCI-based systems .LP http://\fIwww.sun.com/io\fR .SH DIAGNOSTICS -.sp .LP In addition to being logged, the following messages may also appear on the system console. Messages are formatted in the following manner: @@ -292,7 +287,7 @@ The device requires more power than is available on this port. .sp .ne 2 .na -\fBPort <\fIn\fR> in over current condition, please check the attached device +\fBPort <\fIn\fR\fB> in over current condition, please check the attached device to clear the condition. The system will try to recover the port, but if not successful, you need to re-connect the hub or reboot the system to bring the port back to work.\fR @@ -306,3 +301,17 @@ problem. If the port doesn't work after the overcurrent condition is cleared, please re-connect the hub or reboot the system to enable the port again. .RE +.sp +.ne 2 +.na +\fBunable to attach USB 3.x hub <vendor> <device>. A maximum of 5 hubs +may be cascaded.\fR +.ad +.sp .6 +.RS 4n +USB 3.0 has an upper bound on the number of hubs that may be chained +together. If this limit is exceeded, a hub may not be detected or +attached. The hub will be functional if plugged into a different part of +the USB topology. To determine the depth of the hub, count the number of +devices between it and the host controller. +.RE diff --git a/usr/src/man/man7d/i40e.7d b/usr/src/man/man7d/i40e.7d index 57d2de5adf..2c43164796 100644 --- a/usr/src/man/man7d/i40e.7d +++ b/usr/src/man/man7d/i40e.7d @@ -11,12 +11,12 @@ .\" .\" Copyright 2016 Joyent, Inc. .\" -.Dd March 25, 2016 +.Dd December 16, 2016 .Dt I40E 7D .Os .Sh NAME .Nm i40e -.Nd Intel XL710 10/40 Gigabit Ethernet Device Driver +.Nd Intel XL710 Ethernet Device Driver .Sh SYNOPSIS .Pa /dev/i40e* .Sh DESCRIPTION @@ -28,7 +28,8 @@ supports the Data Link Provider Interface, The .Nm driver supports the Intel XL710 Ethernet Controller family of networking -interface cards which come in both 10 GbE and 40 GbE variants. +interface cards which come in 1 GbE, 10 GbE, 25 GbE, and 40 GbE +variants. .Pp In addition to basic device initialization and the sending and receiving of frames, it supports the following features: @@ -73,8 +74,8 @@ It exists in the file system at The .Nm i40e driver always performs auto-negotiation and depending on the model may -negotiate to 40 Gbps, 10 Gbps, or 1 Gbps. At this time, there are no -models that support 1000BASE-T and thus auto-negotiation is required. +negotiate to 40 Gbps, 25 Gbps, 10 Gbps, or 1 Gbps. At this time, the +driver requires the use of auto-negotiation. .Pp The .Nm diff --git a/usr/src/man/man7d/ugen.7d b/usr/src/man/man7d/ugen.7d index d870b946bc..bab5b5a847 100644 --- a/usr/src/man/man7d/ugen.7d +++ b/usr/src/man/man7d/ugen.7d @@ -30,8 +30,7 @@ and full device status. .LP \fBugen\fR supports control, bulk, isochronous and interrupt (in and out) transfers. \fBlibusb\fR(3LIB) uses \fBugen\fR to access devices that do not -contain drivers (such as digital cameras and PDAs). Refer to -\fB/usr/sfw/share/doc/libusb/libusb.txt\fR for details. +contain drivers (such as digital cameras and PDAs). .SH BINDING .LP In general, no explicit binding of the \fBugen\fR driver is necessary because @@ -66,6 +65,7 @@ USB 2.0 device (usb<vid>,<pid>)... .LP where vid is the USB vendor identifier in hex and pid is the product identifier in hex supplied by the device descriptor \fBusb_dev_descr\fR(9S). +Note, the USB device version may vary depending on the device. .sp .LP When using ugen for the first time, you must add the driver utilizing diff --git a/usr/src/man/man7d/usba.7d b/usr/src/man/man7d/usba.7d index c917bed146..87c61d6758 100644 --- a/usr/src/man/man7d/usba.7d +++ b/usr/src/man/man7d/usba.7d @@ -1,190 +1,183 @@ -'\" te -.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved +.\" Copyright 2016 Joyent, Inc. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USBA 7D "April 9, 2016" -.SH NAME -usba, usb \- Solaris USB Architecture (USBA) -.SH DESCRIPTION -.LP +.Dd October 4, 2016 +.Dt USBA 7D +.Os +.Sh NAME +.Nm usba , +.Nm usb +.Nd illumos USB Architecture (USBA) +.Sh DESCRIPTION USB provides a low-cost means for attaching peripheral devices, including mass-storage devices, keyboards, mice, and printers, to a system. For complete information on the USB architecture, visit the USB website at http://www.usb.org. -.sp -.LP +.Pp USBA supports 126 hot-pluggable USB devices per USB bus. The maximum data -transfer rate is 1.5 Mbits (low speed USB 1.x) or 12 Mbits (full speed USB 1.x) -or 480 MBits (high speed USB 2.0) Mbits per second (Mbps). -.sp -.LP -USBA adheres to the \fIUniversal Serial Bus 2.0\fR specification and provides a -transport layer abstraction to USB client drivers. -.sp -.LP -For information on how to write USB client drivers, see \fIWriting Device -Drivers\fR. For the latest information on writing USB drivers, visit -\fIhttp://developers.sun.com/solaris/developer/support/driver/usb.html\fR. For -a complete list of USBA interfaces, see \fBIntro\fR(9F) and \fBIntro\fR(9S). -.sp -.LP -Devices without a driver may have a \fBlibusb\fR(3LIB) application. For more -information, see \fB/usr/sfw/share/doc/libusb/libusb.txt\fR. -.SH FILES -.LP +transfer rate is 5 Gbits (SuperSpeed USB 3.0), 480 Mbits (high speed USB +2.0), 12 Mbits (full speed USB 1.x), or 1.5 Mbits (low speed USB 1.x). +.Pp +USBA adheres to the +.Em Universal Serial Bus 3.0 +specification and provides a transport layer abstraction to USB client +drivers. +.Pp +For information on how to write USB client drivers, see +.Em Writing Device Drivers . +For the latest information on writing USB drivers, visit +.Em http://illumos.org/books/wdd . +For a complete list of USBA interfaces, see +.Xr Intro 9F +or +.Xr Intro 9S . +.Pp +Devices without a driver may be able to leverage +.Xr libusb 3LIB . +.Sh FILES Listed below are drivers and modules which either utilize or are utilized by -USBA. Drivers in \fB/kernel/drv\fR are 32 bit drivers (x86 only). Drivers in -\fB/kernel/drv/sparcv9\fR or \fB/kernel/drv/amd64\fR are 64 bit drivers. -.sp -.in +2 -.nf -\fIClient Driver Function/Device\fR - -kernel/drv/[sparcv9|amd64/]hid HID class -kernel/drv/[sparcv9|amd64/]hubd hub class -kernel/drv/[sparcv9|amd64/]hwahc HWA Host Controller class -kernel/drv/[sparcv9|amd64/]hwarc HWA Radio Controller class -kernel/drv/[sparcv9|amd64/]scsa2usb mass storage class -kernel/drv/[sparcv9|amd64/]usbprn printer class -kernel/drv/[sparcv9|amd64/]usb_as audio streaming class -kernel/drv/[sparcv9|amd64/]usb_ac audio control class -kernel/drv/[sparcv9|amd64/]usbvc video class -kernel/drv/[sparcv9|amd64/]usb_mid multi-interface device -kernel/drv/[sparcv9|amd64/]usb_ia interface-association driver -kernel/drv/[sparcv9|amd64/]usbser_edge Edgeport USB to serial port -kernel/drv/[sparcv9|amd64/]usbsksp Keyspan USB to serial port -kernel/drv/[sparcv9|amd64/]usbsprl pl2303 USB to serial port -kernel/drv/[sparcv9|amd64/]usbsacm CDC ACM class to serial port -kernel/drv/[sparcv9|amd64/]ugen generic USB driver -kernel/drv/[sparcv9|amd64/]wusb_ca WUSB Cable Association class -kernel/drv/[sparcv9|amd64/]ohci open host controller driver -kernel/drv/[sparcv9|amd64/]uhci universal host controller driver -kernel/drv/[sparcv9|amd64/]ehci enhanced host controller driver -.fi -.in -2 -.sp - -.sp -.in +2 -.nf -\fIClient Streams Modules Function/Device\fR -/kernel/strmod/[sparcv9|amd64]usbkbm Keyboad -/kernel/strmod/[sparcv9|amd64]usbms Mouse -/kernel/strmod/[sparcv9|amd64]usb_ah Audio HID -.fi -.in -2 -.sp - -.sp -.in +2 -.nf -\fIHost Controller Interface Drivers Device\fR - -/kernel/drv/[sparcv9|amd64]ehci Enhanced HCI -/kernel/drv/[sparcv9|amd64]ohci Open HCI -/kernel/drv/[sparcv|amd64/]uhci Univeral HCI -.fi -.in -2 -.sp - -.SH ATTRIBUTES -.LP -See \fBattributes\fR(5) for a description of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture PCI-based systems -.TE - -.SH SEE ALSO -.LP -\fBcfgadm_usb\fR(1M), \fBlibusb\fR(3LIB), \fBattributes\fR(5), \fBehci\fR(7D), -\fBhid\fR(7D), \fBhubd\fR(7D), \fBohci\fR(7D), \fBscsa2usb\fR(7D), -\fBuhci\fR(7D), \fBusb_ac\fR(7D), \fBusb_as\fR(7D), \fBusb_ia\fR(7D), -\fBusb_mid\fR(7D), \fBusbprn\fR(7D), \fBusbsacm\fR(7D), \fBusbser_edge\fR(7D), -\fBusbsksp\fR(7D), \fBusbsprl\fR(7D), \fBusbvc\fR(7D), \fBugen\fR(7D), -\fBvirtualkm\fR(7D). \fBIntro\fR(9F), \fBIntro\fR(9S) -.sp -.LP -\fIWriting Device Drivers\fR -.sp -.LP -\fIUniversal Serial Bus Specification 2.0\fR. -.sp -.LP -\fIInterface Association Descriptor Engineering Change Notice (ECN)\fR -.sp -.LP -\fISystem Administration Guide: Basic Administration\fR -.sp -.LP -http://www.sun.com -.SH NOTES -.LP -Booting from USB mass-storage devices is not supported on SPARC, but is -supported on X86. -.SH DIAGNOSTICS -.LP +USBA. Drivers in +.Pa /kernel/drv\ +are 32 bit drivers (x86 only). Drivers in +.Pa /kernel/drv/sparcv9 +or +.Pa kernel/drv/amd64 +are 64 bit drivers. +.Bl -column -offset indent ".Pa kernel/drv/[sparcv9|amd64/]usbser_edge" "Edgeport USB to serial port" +.It Em Client Driver +.Ta Em Function/Device +.It +.Ta +.It Pa kernel/drv/[sparcv9|amd64/]hid +.Ta HID class +.It Pa kernel/drv/[sparcv9|amd64/]hubd +.Ta hub class +.It Pa kernel/drv/[sparcv9|amd64/]scsa2usb +.Ta mass storage class +.It Pa kernel/drv/[sparcv9|amd64/]usbprn +.Ta printer class +.It Pa kernel/drv/[sparcv9|amd64/]usb_as +.Ta audio streaming class +.It Pa kernel/drv/[sparcv9|amd64/]usb_ac +.Ta audio control class +.It Pa kernel/drv/[sparcv9|amd64/]usbvc +.Ta video class +.It Pa kernel/drv/[sparcv9|amd64/]usb_mid +.Ta multi-interface device +.It Pa kernel/drv/[sparcv9|amd64/]usb_ia +.Ta interface-association driver +.It Pa kernel/drv/[sparcv9|amd64/]usbser_edge +.Ta Edgeport USB to serial port +.It Pa kernel/drv/[sparcv9|amd64/]usbsksp +.Ta Keyspan USB to serial port +.It Pa kernel/drv/[sparcv9|amd64/]usbsprl +.Ta pl2303 USB to serial port +.It Pa kernel/drv/[sparcv9|amd64/]usbsacm +.Ta CDC ACM class to serial port +.It Pa kernel/drv/[sparcv9|amd64/]ugen +.Ta generic USB driver +.It Pa kernel/drv/[sparcv9|amd64/]ohci +.Ta open host controller driver +.It Pa kernel/drv/[sparcv9|amd64/]uhci +.Ta universal host controller driver +.It Pa kernel/drv/[sparcv9|amd64/]ehci +.Ta enhanced host controller driver +.It Pa kernel/drv/[sparcv9|amd64/]xhci +.Ta extensible host controller driver +.El +.Bl -column -offset indent ".Pa /kernel/strmod/[sparcv9|amd64/]usb_ah" "Function/Device" +.It +.Ta +.It Em Client Streams Modules +.Ta Em Function/Device +.It +.Ta +.It Pa /kernel/strmod/[sparcv9|amd64/]usbkbm +.Ta Keyboad +.It Pa /kernel/strmod/[sparcv9|amd64/]usbms +.Ta Mouse +.It Pa /kernel/strmod/[sparcv9|amd64/]usb_ah +.Ta Audio HID +.El +.Bl -column -offset indent ".Em Host Controller Interface Drivers" "Extensible HCI" +.It Em Host Controller Interface Drivers +.Ta Em Device +.It +.Ta +.It Pa /kernel/drv/[amd64/]xhci +.Ta Extensible HCI +.It Pa /kernel/drv/[sparcv9|amd64/]ehci +.Ta Enhanced HCI +.It Pa /kernel/drv/[sparcv9|amd64/]ohci +.Ta Open HCI +.It Pa /kernel/drv/[sparcv|amd64/]uhci +.Ta Universal HCI +.El +.Sh DIAGNOSTICS The messages described below may appear on the system console as well as being logged. All messages are formatted in the following manner: -.sp -.in +2 -.nf -WARNING: Error message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBNo driver found for device <device_name> (interface <number> node -name=<node_name>)\fR -.ad -.sp .6 -.RS 4n -The installed Solaris software does not contain a supported driver for this -hardware. <number> is the interface number. <name> is either the device path -name or the device name. -.RE - -.sp -.ne 2 -.na -\fBDraining callbacks timed out!\fR -.ad -.sp .6 -.RS 4n +.Bl -tag -width Sy -offset 2n +.It WARNING: Error message... +.El +.Bl -tag -width Sy -offset 2n +.It Sy no driver found for device <device_name> (interface <number> node +name=<node_name>) +The installed software does not contain a supported driver for this +hardware. <number> is the interface number. <name> is either the device path name or the device name. +.It Sy Draining callbacks timed out! An internal error occurred. Please reboot your system. If this problem persists, contact your system vendor. -.RE - -.sp -.LP +.El +.Pp The following messages may be logged into the system log. They are formatted in the following manner: -.sp -.in +2 -.nf +.Bd -literal -offset 2n <device path><usba<instance number>): message... -.fi -.in -2 -.sp - -.sp -.ne 2 -.na -\fBIncorrect USB driver version for <n.m>.\fR -.ad -.sp .6 -.RS 4n +.Ed +.Bl -tag -width Sy -offset 2n +.It Sy Incorrect USB driver version for <n.m>. Driver is incompatible with USBA framework. -.RE - +.El +.Sh SEE ALSO +.Xr cfgadm_usb 1M , +.Xr libusb 3LIB , +.Xr attributes 5 , +.Xr ehci 7D , +.Xr hid 7D , +.Xr hubd 7D , +.Xr ohci 7D , +.Xr scsa2usb 7D , +.Xr ugen 7D , +.Xr uhci 7D , +.Xr usb_ac 7D , +.Xr usb_as 7D , +.Xr usb_ia 7D , +.Xr usb_mid 7D , +.Xr usbprn 7D , +.Xr usbsacm 7D , +.Xr usbser_edge 7D , +.Xr usbsksp 7D , +.Xr usbsprl 7D , +.Xr usbvc 7D , +.Xr virtualkm 7D , +.Xr xhci 7D , +.Xr Intro 9F , +.Xr Intro 9S) +.Pp +.Rs +.%T Writing Device Drivers +.Re +.Rs +.%T Universal Serial Bus Specification 3.0 +.Re +.Rs +.%T Interface Association Descriptor Engineering Change Notice (ECN) +.Re +.Rs +.%T System Administration Guide: Basic Administration +.Re +.Sh NOTES +Booting from USB mass-storage devices is not supported on SPARC, but is +supported on X86. diff --git a/usr/src/man/man7d/vnd.7d b/usr/src/man/man7d/vnd.7d new file mode 100644 index 0000000000..d311c4dc08 --- /dev/null +++ b/usr/src/man/man7d/vnd.7d @@ -0,0 +1,118 @@ +'\" 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 +.LP +/dev/vnd/* +.fi + +.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 +.SH FILES +.sp +.ne 2 +.na +/dev/vnd/ctl +.ad +.RS 16n +vnd self-cloning control node +.RE + +.sp +.ne 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 +.ne 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) diff --git a/usr/src/man/man7d/zfd.7d b/usr/src/man/man7d/zfd.7d new file mode 100644 index 0000000000..71b3084fdc --- /dev/null +++ b/usr/src/man/man7d/zfd.7d @@ -0,0 +1,81 @@ +.\" +.\" 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 2015, Joyent, Inc. All rights reserved. +.\" +.Dd "Oct 16, 2015" +.Dt ZFD 7D +.Os +.Sh NAME +.Nm zfd +.Nd Zone file descriptor driver +.Sh DESCRIPTION +The +.Nm zfd +character driver exports devices into the zone which can be used by a +a standalone process within the zone as +.Vt stdin , +.Vt stdout , +and +.Vt stderr . +The +.Nm zfd +driver behaves in a similar manner as the +.Nm zcons(7D) +device. +Inside a zone, the slave side devices appear as +.Nm /dev/zfd/[0-4] . +.sp +The zone's zfd device configuration is driven by +.Nm zoneadmd +and a zone attribute +.Nm zlog-mode +which is somewhat of a misnomer since its purpose has evolved. The attribute +can have a variety of values, but the lowest two positions in the value string +are used to control how many zfd devices are created inside the zone and if the +primary stream is a tty. +.sp +.Dl -- +.Dl -n +.Dl t- +.Dl tn +.sp +With the +.Nm t +flag set, +.Vt stdin , +.Vt stdout , +and +.Vt stderr , +are multiplexed onto a single full-duplex stream which is configured as a tty. +That is, +.Nm ptem , +.Nm ldterm +and +.Nm ttycompat +are autopushed onto the stream when the slave side is opened. There is only a +single zfd device (0) needed for the primary stream. +.sp +When the +.Nm n +flag is set, it is assumed that output logging will be done within the zone +itself. In this configuration 1 or 2 additional zfd devices, depending on tty +mode +.Nm ( t +flag), are created within the zone. An application can then configure the +zfd streams driver into a multiplexer. Output from the stdout/stderr zfd(s) +will be teed into the correspond logging zfd(s) within the zone. +.sp +.Sh SEE ALSO +.Xr zlogin 1 , +.Xr zoneadmd 1M , +.Xr zonecfg 1M , +.Xr zcons 7D diff --git a/usr/src/man/man7fs/Makefile b/usr/src/man/man7fs/Makefile index 187bacff78..57aa608a65 100644 --- a/usr/src/man/man7fs/Makefile +++ b/usr/src/man/man7fs/Makefile @@ -26,7 +26,9 @@ MANFILES= bootfs.7fs \ devfs.7fs \ fd.7fs \ hsfs.7fs \ + hyprlofs.7fs \ lofs.7fs \ + lxproc.7fs \ objfs.7fs \ pcfs.7fs \ sharefs.7fs \ diff --git a/usr/src/man/man7fs/hyprlofs.7fs b/usr/src/man/man7fs/hyprlofs.7fs new file mode 100644 index 0000000000..8655791193 --- /dev/null +++ b/usr/src/man/man7fs/hyprlofs.7fs @@ -0,0 +1,62 @@ +'\" te +.\" Copyright (c) 2012, Joyent, Inc. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH HYPRLOFS 7FS "March 7, 2012" +.SH NAME +hyprlofs \- fast name space virtual file system +.SH SYNOPSIS +.LP +.nf +#include <sys/fs/hyprlofs.h> + +\fB\fR\fBmount\fR (\fB\fR\fIspecial\fR, \fB\fR\fIdirectory\fR, \fB\fR\fIMS_DATA\fR, \fB\fR\fI"hyprlofs"\fR, \fB\fR\fINULL\fR, \fB\fR\fI0\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +\fBhyprlofs\fR is a hybrid file system combining features from +\fBtmpfs(7FS)\fR and \fBlofs(7FS)\fR. +As with \fBlofs\fR, the \fBhyprlofs\fR file system allows new, virtual file +systems to be created which provide access to existing files using alternate +pathnames. In addition, the files themselves may have alternate names and +paths within the mount. +Unlike \fBlofs\fR, files cannot be created and backing files cannot be removed. +The name space is completely managed through ioctls on the mount. +Entries in the name space are not mounts and thus, they will not appear in the +mnttab. The file system is designed to provide a very fast name space to the +backing files. The name space can be modified very quickly through the ioctl +interface. +.sp +.LP +\fBhyprlofs\fR file systems can be mounted with the command: +.sp +.in +2 +.nf +\fBmount \fR\fB-F\fR\fB hyprlofs swap \fR\fIdirectory\fR +.fi +.in -2 + +.sp +.LP +The name space used by \fBhyprlofs\fR exists only in-memory so it will consume +a small amount of the system's virtual memory. The files themselves are backed +by the original file as with \fBlofs\fR. + +.SH SEE ALSO +.sp +.LP +\fBdf\fR(1M), \fBmount\fR(1M), \fBswap\fR(1M), +\fBmount\fR(2), \fBumount\fR(2) +.sp +.LP +\fISystem Administration Guide: Basic Administration\fR +.SH DIAGNOSTICS +.sp +.LP +\fBdf\fR(1M) output is of limited accuracy since +the space available to \fBhyprlofs\fR is dependent on the swap +space demands of the entire system and the files in the name space are not +included. diff --git a/usr/src/man/man7fs/lxproc.7fs b/usr/src/man/man7fs/lxproc.7fs new file mode 100644 index 0000000000..7ef10ce343 --- /dev/null +++ b/usr/src/man/man7fs/lxproc.7fs @@ -0,0 +1,115 @@ +'\" te +.\" Copyright (c) 2012, Joyent, Inc. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH LXPROC 7FS "April 25, 2012" +.SH NAME +lxproc \- a loosely Linux-compatible /proc +.SH SYNOPSIS +.LP +.nf +\fB\fR\fBmount\fR (\fB\fR\fI"lxproc"\fR, \fB\fR\fIdirectory\fR, \fB\fR\fIMS_DATA\fR, \fB\fR\fI"lxproc"\fR, \fB\fR\fINULL\fR, \fB\fR\fI0\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +\fBlxproc\fR is an implementation of the \fB/proc\fR filesystem that +loosely matches the Linux semantics of providing human-readable text files +that correspond to elements of the system. +As with both \fBproc\fR(4) and Linux \fB/proc\fR, \fBlxproc\fR makes available +a directory for every process, with each directory containing a number +of files; like Linux \fB/proc\fR but unlike \fBproc\fR(4), \fBlxproc\fR also +makes available a number of files related to system-wide information. +To ascertain the meaning and structure of the files provided via +\fBlxproc\fR, users should consult the Linux documentation. +.sp +.LP +The \fBlxproc\fR compatibility layer is +provided only as a best-effort for simple Linux \fB/proc\fR readers; it +is not intended to exactly mimic Linux semantics and nor does it attempt to +somehow fool a consumer into believing that it is operating within a Linux +environment. As such, \fBlxproc\fR should only be used by Linux-specific +programs that are willing to trade precision in understanding the +system in return for Linux compatibility. To programmatically understand +the system precisely and in terms of its native constructs, +one should not use \fBlxproc\fR, but rather \fBproc\fR(4) or +\fBkstat\fR(3KSTAT). +To understand +a process or group of processes from either a shell script or the command line, +one should not use \fBlxproc\fR, but rather \fBproc\fR(4)-based tools like +\fBprstat\fR(1M), +\fBpfiles\fR(1), +\fBpargs\fR(1), +\fBpmap\fR(1), +\fBptree\fR(1), +\fBplimit\fR(1), +\fBpflags\fR(1), +\fBpcred\fR(1), +\fBpstack\fR(1), +\fBpldd\fR(1), +\fBpsig\fR(1), +or +\fBpwdx\fR(1). +To understand system-wide constructs from either a shell script or the +command line, one should not use \fBlxproc\fR, but rather +\fBkstat\fR(3KSTAT)-based tools like +\fBkstat\fR(1M), +\fBmpstat\fR(1M), +\fBiostat\fR(1M), +\fBnetstat\fR(1M) or +\fBpsrinfo\fR(1M). +.sp +.LP +Like \fB/proc\fR, \fBlxproc\fR can be mounted on any mount point, but the +preferred mount point is \fB/system/lxproc\fR; if a zone brand elects to +mount it by default, this will (or should) generally be the mount point. +.sp +.LP +\fBlxproc\fR can be mounted with the command: +.sp +.in +2 +.nf +\fBmount \fR\fB-F\fR\fB lxproc lxproc \fR\fIdirectory\fR +.fi +.in -2 + +.SH SEE ALSO +.sp +.LP +\fBdf\fR(1M), +\fBiostat\fR(1M), +\fBkstat\fR(1M), +\fBmpstat\fR(1M), +\fBmount\fR(1M), +\fBnetstat\fR(1M), +\fBpargs\fR(1), +\fBpcred\fR(1), +\fBpfiles\fR(1), +\fBpflags\fR(1), +\fBpldd\fR(1), +\fBplimit\fR(1), +\fBpmap\fR(1), +\fBprstat\fR(1M), +\fBpsig\fR(1), +\fBpsrinfo\fR(1M), +\fBpstack\fR(1), +\fBptree\fR(1), +\fBpwdx\fR(1), +\fBmount\fR(2), \fBumount\fR(2), \fBkstat\fR(3KSTAT), \fBproc\fR(4), +\fBkstat\fR(9S) + +.SH NOTES +.sp +.LP +When choosing between offering +Linux compatibility and telling the truth, \fBlxproc\fR emphatically picks +the truth. A particular glaring example of this is the Linux notion of +"tasks" (that is, threads), which -- due to historical misadventures on +Linux -- allocate their identifiers from the process identifier space. +(That is, each thread has in effect a pid.) Some Linux \fB/proc\fR readers +have come to depend on this attribute, and become confused when threads +appear with proper identifiers, so \fBlxproc\fR simply opts for the pre-2.6 +behavior, and does not present the tasks directory at all. + diff --git a/usr/src/man/man7i/uscsi.7i b/usr/src/man/man7i/uscsi.7i index 3247f53cc1..f246590ca4 100644 --- a/usr/src/man/man7i/uscsi.7i +++ b/usr/src/man/man7i/uscsi.7i @@ -1,9 +1,10 @@ '\" te .\" Copyright (c) 2007 by Sun Microsystems, Inc. All rights reserved. +.\" Copyright 2016 Joyent, Inc. .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USCSI 7I "May 29, 2007" +.TH USCSI 7I "Sep 23, 2016" .SH NAME uscsi \- user SCSI command interface .SH SYNOPSIS @@ -15,7 +16,6 @@ uscsi \- user SCSI command interface .fi .SH DESCRIPTION -.sp .LP The \fBuscsi\fR command is very powerful and somewhat dangerous; therefore it has some permission restrictions. See \fBWARNINGS\fR for more details. @@ -349,8 +349,13 @@ See the \fBscsi_pkt\fR(9S) flag \fBFLAG_RENEGOTIATE_WIDE_SYNC\fR for more information. .RE +The \fBuscsi_xfer_t\fR is a type definition that corresponds to a 64-bit +unsigned integer. It should be used for the \fBUSCSIMAXXFER\fR ioctls. This is +used for determining the maximum transfer size that can be performed in a single +\fBUSCSICMD\fR ioctl. If the SCSI request is larger than the specified size, +then it may not work, depending on the hardware platform. + .SH IOCTLS -.sp .LP The \fBioctl\fR supported by drivers providing the \fBuscsi\fR interface is: .sp @@ -371,10 +376,24 @@ status, and Request Sense is enabled, the sense data itself is returned in Sense data transfer. .RE -.SH ERRORS .sp .ne 2 .na +.B USCSIMAXXFER +.ad +.RS 12n +The argument is a pointer to a \fBuscsi_xfer_t\fR value. The maximum transfer +size that can be used with the \fBUSCSICMD\fR ioctl for the current device will +be returned in the \fBuscsi_xfer_t\fR. +.sp +.LP +Not all devices which support the \fBUSCSICMD\fR ioctl also support the +\fBUSCSIMAXXFER\fR ioctl. +.RE + +.SH ERRORS +.ne 2 +.na \fB\fBEINVAL\fR\fR .ad .RS 10n @@ -396,7 +415,8 @@ An error occurred during the execution of the command. \fB\fBEPERM\fR\fR .ad .RS 10n -A process without root credentials tried to execute the \fBUSCSICMD\fR ioctl. +A process without root credentials tried to execute the \fBUSCSICMD\fR or +\fRUSCSIMAXXFER\fR ioctl. .RE .sp @@ -405,12 +425,11 @@ A process without root credentials tried to execute the \fBUSCSICMD\fR ioctl. \fB\fBEFAULT\fR\fR .ad .RS 10n -The \fBuscsi_cmd\fR itself, the \fBuscsi_cdb\fR, the \fBuscsi_buf\fR, or the -\fBuscsi_rqbuf\fR point to an invalid address. +The \fBuscsi_cmd\fR itself, the \fBuscsi_cdb\fR, the \fBuscsi_buf\fR, the +\fBuscsi_rqbuf\fR, or the \fBuscsi_xfer_t\fR point to an invalid address. .RE .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -426,14 +445,12 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp .LP \fBioctl\fR(2), \fBattributes\fR(5), \fBsd\fR(7D), \fBst\fR(7D) .sp .LP \fIANSI Small Computer System Interface-2 (SCSI-2)\fR .SH WARNINGS -.sp .LP The \fBuscsi\fR command is very powerful, but somewhat dangerous, and so its use is restricted to processes running as root, regardless of the file @@ -450,7 +467,8 @@ number is used to send the command. The \fBuscsi\fR interface is not recommended for very large data transfers (typically more than 16MB). If the requested transfer size exceeds the maximum transfer size of the DMA engine, it will not be broken up into multiple -transfers and DMA errors may result. +transfers and DMA errors may result. The \fBUSCSIMAXXFER\fR ioctl can be used +to determine the maximum transfer size. .sp .LP The \fBUSCSICMD\fR ioctl associates a \fBstruct uscsi_cmd\fR with a device by diff --git a/usr/src/man/man7m/Makefile b/usr/src/man/man7m/Makefile index bb44184ba7..36eb293fc3 100644 --- a/usr/src/man/man7m/Makefile +++ b/usr/src/man/man7m/Makefile @@ -12,6 +12,7 @@ # # Copyright 2011, Richard Lowe # Copyright 2013 Nexenta Systems, Inc. All rights reserved. +# Copyright 2015 Joyent, Inc. # include $(SRC)/Makefile.master @@ -20,6 +21,7 @@ MANSECT= 7m _MANFILES = bufmod.7m \ connld.7m \ + datafilt.7m \ ldterm.7m \ pckt.7m \ pfmod.7m \ diff --git a/usr/src/man/man7m/datafilt.7m b/usr/src/man/man7m/datafilt.7m new file mode 100644 index 0000000000..f74ac0b103 --- /dev/null +++ b/usr/src/man/man7m/datafilt.7m @@ -0,0 +1,46 @@ +.\" +.\" 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 2014 Ryan Zezeski +.\" Copyright 2015 Joyent, Inc. +.\" +.Dd Apr 21, 2015 +.Dt DATAFILT 7M +.Os +.Sh NAME +.Nm datafilt +.Nd socket filter module for deferred TCP connections +.Sh DESCRIPTION +The +.Nm datafilt +socket filter provides deferment of +.Xr accept 3SOCKET +for TCP connections. The accept call will not return until at least +one byte has been buffered by the kernel. Deferment assures the +application that the first call to +.Xr read 2 or +.Xr recv 3SOCKET +will not block. It reduces unnecessary switching between user and +kernel. +.Sh EXAMPLES +.Ss Example 1 +Enable deferment on the listening socket. +.Bd -literal + setsockopt(lsock, SOL_FILTER, FIL_ATTACH, "datafilt", 8); +.Ed +.Ss Example 2 +Disable deferment on the listening socket. +.Bd -literal + char filt[] = "datafilt"; + setsockopt(lsock, SOL_FILTER, FIL_DETACH, filt, strlen(filt) + 1); +.Ed +.Sh SEE ALSO +.Xr setsockopt 3SOCKET diff --git a/usr/src/man/man7p/Makefile b/usr/src/man/man7p/Makefile index 13cb58770d..f73a157f47 100644 --- a/usr/src/man/man7p/Makefile +++ b/usr/src/man/man7p/Makefile @@ -39,7 +39,8 @@ MANFILES= arp.7p \ sip.7p \ slp.7p \ tcp.7p \ - udp.7p + udp.7p \ + vxlan.7p MANLINKS= AH.7p \ ARP.7p \ @@ -51,6 +52,7 @@ MANLINKS= AH.7p \ SCTP.7p \ TCP.7p \ UDP.7p \ + VXLAN.7p \ if.7p ARP.7p := LINKSRC = arp.7p @@ -75,6 +77,8 @@ TCP.7p := LINKSRC = tcp.7p UDP.7p := LINKSRC = udp.7p +VXLAN.7p := LINKSRC = vxlan.7p + .KEEP_STATE: include $(SRC)/man/Makefile.man diff --git a/usr/src/man/man7p/vxlan.7p b/usr/src/man/man7p/vxlan.7p new file mode 100644 index 0000000000..a32637b484 --- /dev/null +++ b/usr/src/man/man7p/vxlan.7p @@ -0,0 +1,124 @@ +.\" +.\" 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 2015 Joyent, Inc. +.\" +.Dd Apr 10, 2015 +.Dt VXLAN 7P +.Os +.Sh NAME +.Nm VXLAN , +.Nm vxlan +.Nd Virtual eXtensible Local Area Network +.Sh SYNOPSIS +.In sys/vxlan.h +.Sh DESCRIPTION +.Nm +(RFC 7348) is a network encapsulation protocol that is used by +.Xr overlay 5 +devices. A payload, commonly an Ethernet frame, is placed inside of a +UDP packet and prepended with an 8-byte +.Nm +header. +.Pp +The +.Nm +header contains two 32-bit words. The first word is an 8-bit flags field +followed by 24 reserved bits. The second word is a 24-bit virtual network +identifier followed by 8 reserved bits. The virtual network identifier +identifies a unique +.Nm +and +is similar in concept to an IEEE 802.1Q VLAN identifier. +.Pp +The system provides access to +.Nm +through dladm overlays. See +.Xr dladm 1M +and +.Xr overlay 5 +for more information. +.Pp +The +.In sys/vxlan.h +header provides information for working with the +.Nm +protocol. The contents of this header are +.Sy uncommitted . +The header defines a structure that may be used to encode and decode a VXLAN +header. It defines a packed structure type +.Sy vxlan_hdr_t +which represents the +.Nm +frame header and has the following members: +.Bd -literal + uint32_t vxlan_flags; /* flags in upper 8 bits */ + uint32_t vxlan_id; /* VXLAN ID in upper 24 bits */ +.Ed +.Sh EXAMPLES +.Sy Example 1 +Decoding a +.Nm +header +.Pp +The following example shows how to validate a +.Nm header. For more information on this process, see RFC 7348. +.Bd -literal -offset indent +#include <sys/types.h> +#include <netinet/in.h> +#include <inttypes.h> +#include <sys/vxlan.h> + +\&... + +/* + * Validate the following bytes as a VXLAN header. If valid, return + * 0 and store the VXLAN identifier in *vidp. Otherwise, return an + * error. + */ +int +validate_vxlan(void *buf, int len, uint32_t *vidp) +{ + vxlan_hdr_t *hdr; + + if (len < sizeof (vxlan_hdr_t)) + return (EINAVL); + + hdr = buf; + if ((ntohl(hdr->vxlan_flags) & VXLAN_MAGIC) == 0) + return (EINAVL); + + *vidp = ntohl(vxlan->vxlan_id) >> VXLAN_ID_SHIFT; + + return (0); +} +.Ed +.Sh STABILITY +The contents of +.In sys/vxlan.h +are +.Sy Uncommitted . +.Sh SEE ALSO +.Xr dladm 1M , +.Xr overlay 5 +.Rs +.%A Mahalingam, M. +.%A Dutt, D. +.%A Duda, K. +.%A Agarwal, P. +.%A Kreeger L. +.%A Sridhar, T. +.%A Bursell, M. +.%A C. Wright +.%T RFC 7348, Virtual eXtensible Local Area Network (VXLAN): A Framework +.%T for Overlaying Virtualized Layer 2 Networks over Layer 3 Networks +.%D August 2014 +.Re diff --git a/usr/src/man/man9f/Makefile b/usr/src/man/man9f/Makefile index 9eef8d5e52..ea8a999df9 100644 --- a/usr/src/man/man9f/Makefile +++ b/usr/src/man/man9f/Makefile @@ -499,6 +499,7 @@ MANFILES= ASSERT.9f \ usb_client_attach.9f \ usb_clr_feature.9f \ usb_create_pm_components.9f \ + usb_ep_xdescr_fill.9f \ usb_get_addr.9f \ usb_get_alt_if.9f \ usb_get_cfg.9f \ @@ -518,7 +519,7 @@ MANFILES= ASSERT.9f \ usb_pipe_get_state.9f \ usb_pipe_intr_xfer.9f \ usb_pipe_isoc_xfer.9f \ - usb_pipe_open.9f \ + usb_pipe_xopen.9f \ usb_pipe_reset.9f \ usb_pipe_set_private.9f \ usb_register_hotplug_cbs.9f \ @@ -1212,6 +1213,7 @@ MANLINKS= AVL_NEXT.9f \ usb_owns_device.9f \ usb_pipe_ctrl_xfer_wait.9f \ usb_pipe_get_private.9f \ + usb_pipe_open.9f \ usb_pipe_stop_intr_polling.9f \ usb_pipe_stop_isoc_polling.9f \ usb_print_descr_tree.9f \ @@ -2087,6 +2089,8 @@ usb_pipe_stop_isoc_polling.9f := LINKSRC = usb_pipe_isoc_xfer.9f usb_pipe_get_private.9f := LINKSRC = usb_pipe_set_private.9f +usb_pipe_open.9f := LINKSRC = usb_pipe_xopen.9f + usb_unregister_hotplug_cbs.9f := LINKSRC = usb_register_hotplug_cbs.9f va_copy.9f := LINKSRC = va_arg.9f diff --git a/usr/src/man/man9f/kmem_alloc.9f b/usr/src/man/man9f/kmem_alloc.9f index 9c4f8ccb0c..201544b57c 100644 --- a/usr/src/man/man9f/kmem_alloc.9f +++ b/usr/src/man/man9f/kmem_alloc.9f @@ -129,5 +129,8 @@ uninitialized kernel memory should be handled carefully. For example, never .SH NOTES .sp .LP -\fBkmem_alloc(0\fR, \fIflag\fR\fB)\fR always returns \fINULL\fR. -\fBkmem_free(NULL, 0)\fR is legal. +\fBkmem_alloc(0\fR, \fIflag\fR\fB)\fR always returns \fINULL\fR, but +if \fBKM_SLEEP\fR is set, this behavior is considered to be deprecated; +the system may be configured to explicitly panic in this case in lieu +of returning \fINULL\fR. +\fBkmem_free(NULL, 0)\fR is legal, however. diff --git a/usr/src/man/man9f/usb_client_attach.9f b/usr/src/man/man9f/usb_client_attach.9f index d7c79ab32d..6aa757d190 100644 --- a/usr/src/man/man9f/usb_client_attach.9f +++ b/usr/src/man/man9f/usb_client_attach.9f @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_CLIENT_ATTACH 9F "Jan 5, 2004" +.TH USB_CLIENT_ATTACH 9F "Oct 30, 2016" .SH NAME usb_client_attach, usb_client_detach \- USBA framework registration of client USB drivers @@ -28,11 +28,9 @@ USB drivers .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .LP For \fBusb_client_attach()\fR: .sp @@ -84,7 +82,6 @@ Pointer to a usb_client_dev_data_t to free. Can be NULL. .RE .SH DESCRIPTION -.sp .LP The \fBusb_client_attach()\fR function registers a driver with the USBA framework and must be called before any other USBA function. Usually, @@ -98,7 +95,6 @@ dev_data argument is non-NULL. The \fBusb_client_detach()\fR function is the last USBA function a client calls before completing \fBdetach\fR(9E). It is not necessary to call \fBusb_client_detach()\fR during a suspend operation. .SS "VERSIONING" -.sp .LP USBDRV_VERSION is a macro which creates a version number based on the USBDRV_MAJOR_VER and USBDRV_MINOR_VER definitions. It must be passed as the @@ -112,15 +108,13 @@ USBA_MINOR_VER value also in <sys/usb/usbai.h>. .sp .LP Version 0.8 drivers from previous releases are binary compatible and run on -Solaris 10, but are not compilable. Version 0.8 binary compatibility will not -be supported in subsequent Solaris OS releases. +illumos, but are not compilable. .sp .LP Definitions of USBDRV_MAJOR_VERSION and USBDRV_MINOR_VERSION must appear in the client driver above the reference to <\fBsys/usb/usba.h\fR>. Note that different releases have different USBA_[MAJOR|MINOR]_VER numbers. .SH RETURN VALUES -.sp .LP For \fBusb_client_attach()\fR: .sp @@ -190,7 +184,6 @@ Not called from an attach routine context. .RE .SH CONTEXT -.sp .LP The \fBusb_client_attach()\fR function may only be called from \fBattach\fR(9E). @@ -199,7 +192,6 @@ The \fBusb_client_attach()\fR function may only be called from The \fBusb_client_detach()\fR function may be called only from \fBattach\fR(9E) or \fBdetach\fR(9E). .SH EXAMPLES -.sp .in +2 .nf if (usb_client_attach(dip, USBDRV_VERSION, 0) != USB_SUCCESS) { @@ -221,7 +213,6 @@ or \fBdetach\fR(9E). .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -239,7 +230,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBattach\fR(9E), \fBdetach\fR(9E), \fBusb_get_dev_data\fR(9F) diff --git a/usr/src/man/man9f/usb_ep_xdescr_fill.9f b/usr/src/man/man9f/usb_ep_xdescr_fill.9f new file mode 100644 index 0000000000..0a11dcac93 --- /dev/null +++ b/usr/src/man/man9f/usb_ep_xdescr_fill.9f @@ -0,0 +1,106 @@ +.\" +.\" 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 2016 Joyent, Inc. +.\" +.Dd Aug 7, 2016 +.Dt USB_EP_XDESCR_FILL 9F +.Os +.Sh NAME +.Nm usb_ep_xdescr_fill +.Nd fill extended endpoint description from endpoint data +.Sh SYNOPSIS +.In sys/usb/usba.h +.Ft int +.Fo usb_ep_xdescr_fill +.Fa "uint_t version" +.Fa "dev_info_t *dip" +.Fa "usb_ep_data_t *ep_data" +.Fa "usb_ep_xdescr_t *ep_xdescr" +.Fc +.Sh INTERFACE STABILITY +illumos DDI specific +.Sh PARAMETESR +.Bl -tag -width Fa +.It Fa version +Indicates the current version of the +.Ft usb_ep_xdescr_t +structure the driver is using. Callers should always specify +.Sy USB_EP_XDESCR_CURRENT_VERSION . +.It Fa dip +Pointer to the device's +.Sy dev_info +structure. +.It Fa ep_data +Pointer to endpoint data retrieved by calling +.Xr usb_lookup_ep_data 9F . +.It Fa ep_xdescr +Pointer to the extended endpoint descriptor that will be filled out. +.El +.Sh DESCRIPTION +The +.Fn usb_ep_xdescr_fill +function is used to fill in the members of the extended endpoint +descriptor +.Fa ep_xdescr +based on the endpoint descriptor data in +.Fa ep_data . +Once filled in, +.Fa ep_xdescr +can be used to open a pipe by calling +.Xr usb_pipe_xopen 9F . +.Pp +Prior to USB 3.0, only one descriptor, the +.Xr usb_ep_descr 9S , +was needed to describe an endpoint. However, with USB 3.0, additional +companion descriptors have been added and are required to successfully +open an endpoint. After calling this, all descriptors needed +to successfully open a pipe will be placed into +.Fa ep_xdescr +and the endpoint data, +.Fa ep_data , +is no longer required. +.Sh CONTEXT +The +.Fn usb_ep_xdescr_fill +is generally only called from a drivers +.Xr attach 9E +entry point; however, it may be called from either +.Sy user +or +.Sy kernel +context. +.Sh RETURN VALUES +Upon successful completion, the +.Fn usb_ep_xdescr_fill +function returns +.Sy USB_SUCCESS . +Otherwise an error number is returned. +.Sh ERRORS +.Bl -tag -width Er +.It Er USB_INVALID_ARGS +The value of +.Fa version +is unknown, or one of +.Fa dip , +.Fa ep_data , +and +.Fa ep_xdescr +was an invalid pointer. +.It Er USB_FAILURE +An unknown error occurred. +.El +.Sh SEE ALSO +.Xr usb_lookup_ep_data 9F , +.Xr usb_pipe_xopen 9F , +.Xr usb_ep_descr 9S , +.Xr usb_ep_ss_comp_descr 9S , +.Xr usb_ep_xdescr 9S diff --git a/usr/src/man/man9f/usb_get_addr.9f b/usr/src/man/man9f/usb_get_addr.9f index 94fccab7f4..746530b264 100644 --- a/usr/src/man/man9f/usb_get_addr.9f +++ b/usr/src/man/man9f/usb_get_addr.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_GET_ADDR 9F "Feb 9, 2004" +.TH USB_GET_ADDR 9F "Sep 16, 2016" .SH NAME usb_get_addr \- Retrieve device USB address .SH SYNOPSIS @@ -15,11 +15,9 @@ usb_get_addr \- Retrieve device USB address .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -29,25 +27,21 @@ Pointer to the device's dev_info structure. .RE .SH DESCRIPTION -.sp .LP The \fBusb_get_addr()\fR function returns the current USB bus address for debugging purposes. The returned address is unique for a specific USB bus, and may be replicated if multiple host controller instances are present on the system. .SH RETURN VALUES -.sp .LP On success: USB device address. .sp .LP On failure: returns 0. Fails if dip is NULL. .SH CONTEXT -.sp .LP May be called from user, kernel or interrupt context. .SH EXAMPLES -.sp .in +2 .nf int usb_addr; @@ -57,7 +51,6 @@ usb_addr = usb_get_addr(dip); .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -75,6 +68,5 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP -\fBattributes\fR(5), \fBusb_pipe_open\fR(9F) +\fBattributes\fR(5), \fBusb_pipe_xopen\fR(9F) diff --git a/usr/src/man/man9f/usb_get_cfg.9f b/usr/src/man/man9f/usb_get_cfg.9f index 2686a0e2b6..12d387470b 100644 --- a/usr/src/man/man9f/usb_get_cfg.9f +++ b/usr/src/man/man9f/usb_get_cfg.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_GET_CFG 9F "Jan 5, 2004" +.TH USB_GET_CFG 9F "Sep 16, 2016" .SH NAME usb_get_cfg, usb_set_cfg \- Get and set current USB device configuration .SH SYNOPSIS @@ -25,11 +25,9 @@ usb_get_cfg, usb_set_cfg \- Get and set current USB device configuration .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .LP For \fBusb_get_cfg()\fR: .sp @@ -110,7 +108,6 @@ Second argument passed to callback handler. .RE .SH DESCRIPTION -.sp .LP The \fBusb_get_cfg()\fR function retrieves the current configuration. It ignores the flags argument and always blocks while contacting the device. @@ -134,7 +131,6 @@ function is the only supported programmatic way to change device configuration. This call blocks if USB_FLAGS_SLEEP is set in flags. It returns immediately and calls the callback on completion if USB_FLAGS_SLEEP is not set. .SH RETURN VALUES -.sp .LP For \fBusb_get_cfg()\fR: .sp @@ -235,7 +231,6 @@ One or more pipes other than the default control pipe are open on the device. .RE .SH CONTEXT -.sp .LP The \fBusb_get_cfg()\fR function may be called from user or kernel context. .sp @@ -250,7 +245,6 @@ supplied, can block because it is executing in kernel context. Otherwise the callback cannot block. Please see \fBusb_callback_flags\fR(9S) for more information on callbacks. .SH EXAMPLES -.sp .in +2 .nf Setting the configuration to the one at index 1 (in the @@ -287,7 +281,6 @@ information on callbacks. .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -305,9 +298,8 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_dev_data\fR(9F), -\fBusb_get_string_descr\fR(9F), \fBusb_pipe_open\fR(9F), +\fBusb_get_string_descr\fR(9F), \fBusb_pipe_xopen\fR(9F), \fBusb_callback_flags\fR(9S), \fBusb_cfg_descr\fR(9S), \fBusb_ep_descr\fR(9S), \fBusb_if_descr\fR(9S) diff --git a/usr/src/man/man9f/usb_get_dev_data.9f b/usr/src/man/man9f/usb_get_dev_data.9f index 636ab9c73d..01269dfa15 100644 --- a/usr/src/man/man9f/usb_get_dev_data.9f +++ b/usr/src/man/man9f/usb_get_dev_data.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_GET_DEV_DATA 9F "Jan 5, 2004" +.TH USB_GET_DEV_DATA 9F "Sep 16, 2016" .SH NAME usb_get_dev_data, usb_free_dev_data, usb_free_descr_tree, usb_print_descr_tree \- Retrieve device configuration information @@ -34,11 +34,9 @@ usb_get_dev_data, usb_free_dev_data, usb_free_descr_tree, usb_print_descr_tree .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .LP For \fBusb_get_dev_data()\fR: .sp @@ -143,7 +141,6 @@ on-screen. .RE .SH DESCRIPTION -.sp .LP The \fBusb_get_dev_data()\fR function interrogates a device and returns its configuration information in a usb_client_dev_data_t structure. Most USBA @@ -222,7 +219,6 @@ which dumps the descriptor tree to the screen when the system is verbose booted (\fBboot\fR \fB-v\fR). Output is spaced with blank lines for readability and provides you with an on-screen look at what a device has to offer. .SH RETURN VALUES -.sp .LP For \fBusb_get_dev_data()\fR: .sp @@ -317,7 +313,6 @@ Other error. .RE .SH CONTEXT -.sp .LP The \fBusb_get_dev_data()\fR and \fBusb_print_descr_tree()\fR functions may be called from user or kernel context. @@ -326,7 +321,6 @@ called from user or kernel context. The \fBusb_free_dev_data()\fR and \fBusb_free_descr_tree()\fR functions may be called from user, kernel or interrupt context. .SH EXAMPLES -.sp .in +2 .nf In this example, assume a device has the configuration shown @@ -391,7 +385,6 @@ current OS device node. .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -409,11 +402,10 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_client_attach\fR(9F), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_lookup_ep_data\fR(9F), \fBusb_parse_data\fR(9F), -\fBusb_pipe_open\fR(9F), \fBusb_cfg_descr\fR(9S), +\fBusb_pipe_xopen\fR(9F), \fBusb_cfg_descr\fR(9S), \fBusb_client_dev_data(9S)\fR, \fBusb_ep_descr\fR(9S), \fBusb_if_descr\fR(9S), \fBusb_string_descr\fR(9S) diff --git a/usr/src/man/man9f/usb_lookup_ep_data.9f b/usr/src/man/man9f/usb_lookup_ep_data.9f index 4962dcb4b7..18f2317b98 100644 --- a/usr/src/man/man9f/usb_lookup_ep_data.9f +++ b/usr/src/man/man9f/usb_lookup_ep_data.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_LOOKUP_EP_DATA 9F "Jan 5, 2004" +.TH USB_LOOKUP_EP_DATA 9F "Sep 16, 2016" .SH NAME usb_lookup_ep_data \- Lookup endpoint information .SH SYNOPSIS @@ -19,11 +19,9 @@ usb_lookup_ep_data \- Lookup endpoint information .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -76,7 +74,7 @@ finding one to retrieve. .ad .RS 13n Type of endpoint. This is one of: USB_EP_ATTR_CONTROL, USB_EP_ATTR_ISOCH, -USB_EP_ATTR_BULK, or USB_EP_ATTR_INTR. Please see \fBusb_pipe_open\fR(9F) for +USB_EP_ATTR_BULK, or USB_EP_ATTR_INTR. Please see \fBusb_pipe_xopen\fR(9F) for more information. .RE @@ -91,7 +89,6 @@ ignored for bi-directional control endpoints. .RE .SH DESCRIPTION -.sp .LP The \fBusb_lookup_ep_data()\fR function returns endpoint information from the tree embedded in client data returned from \fBusb_get_dev_data\fR. It operates @@ -101,7 +98,6 @@ endpoints it finds which match the specifications of the other arguments, and then retrieves information on the next matching endpoint it finds. Note that it does not make a copy of the data, but points to the tree itself. .SH RETURN VALUES -.sp .LP On success: the tree node corresponding to the desired endpoint. .sp @@ -110,11 +106,9 @@ On failure: returns NULL. Fails if \fIdip\fR or \fIdev_datap\fR are NULL, if the desired endpoint does not exist in the tree, or no tree is present in dev_datap. .SH CONTEXT -.sp .LP May be called from user, kernel or interrupt context. .SH EXAMPLES -.sp .LP Retrieve the polling interval for the second interrupt endpoint at interface 0, alt 3: @@ -147,7 +141,6 @@ Retrieve the maximum packet size for the first control pipe at interface 0, alt .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -165,7 +158,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_get_dev_data\fR(9F), \fBusb_pipe_open\fR(9F), \fBusb_cfg_descr\fR(9S), \fBusb_if_descr\fR(9S), \fBusb_ep_descr\fR(9S) diff --git a/usr/src/man/man9f/usb_parse_data.9f b/usr/src/man/man9f/usb_parse_data.9f index cf7f043bf6..61e5bfc513 100644 --- a/usr/src/man/man9f/usb_parse_data.9f +++ b/usr/src/man/man9f/usb_parse_data.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_PARSE_DATA 9F "Jan 5, 2004" +.TH USB_PARSE_DATA 9F "Oct 30, 2016" .SH NAME usb_parse_data \- Tokenize and align the bytes of raw variable-format data .SH SYNOPSIS @@ -18,11 +18,9 @@ usb_parse_data \- Tokenize and align the bytes of raw variable-format data .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIformat\fR\fR @@ -73,7 +71,6 @@ exceed this value. .RE .SH DESCRIPTION -.sp .LP The \fBusb_parse_data\fR function parses data such as a variable-format class- or vendor-specific descriptor. The function also tokenizes and aligns the bytes @@ -81,7 +78,7 @@ of raw descriptor data into fields of a variable-format descriptor. .sp .LP While the USBA framework can parse the endpoint, interface, configuration, and -string descriptors defined by the \fIUSB 2.0\fR specification, the format of +string descriptors defined by the \fIUSB 3.0\fR specification, the format of class- or vendor-specific descriptors cannot be explicitly defined by the specification and will be unique for each. The \fIformat\fR argument defines how to parse such a descriptor. @@ -94,18 +91,15 @@ While the USB specification defines bit ordering as little-endian, this routine The \fIstructlen\fR parameter defines the size of the destination data buffer. Data is truncated to this size if the destination data buffer is too small. .SH RETURN VALUES -.sp .LP On success: Returns the size (in bytes) of the parsed data result. .sp .LP On failure: Returns 0. (Same as USB_PARSE_ERROR). .SH CONTEXT -.sp .LP May be called from user, kernel or interrupt context. .SH EXAMPLES -.sp .in +2 .nf /* @@ -136,7 +130,6 @@ May be called from user, kernel or interrupt context. .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -154,7 +147,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_get_cfg\fR(9F) diff --git a/usr/src/man/man9f/usb_pipe_bulk_xfer.9f b/usr/src/man/man9f/usb_pipe_bulk_xfer.9f index 5789d2ce13..04f0e61570 100644 --- a/usr/src/man/man9f/usb_pipe_bulk_xfer.9f +++ b/usr/src/man/man9f/usb_pipe_bulk_xfer.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_PIPE_BULK_XFER 9F "Aug 3, 2006" +.TH USB_PIPE_BULK_XFER 9F "Sep 16, 2016" .SH NAME usb_pipe_bulk_xfer \- USB bulk transfer function .SH SYNOPSIS @@ -18,11 +18,9 @@ usb_pipe_bulk_xfer \- USB bulk transfer function .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIpipe_handle\fR\fR @@ -50,7 +48,6 @@ USB_FLAGS_SLEEP is the only flag recognized. Wait for request to complete. .RE .SH DESCRIPTION -.sp .LP The \fBusb_pipe_bulk_xfer()\fR function requests the USBA framework to perform a transfer through a USB bulk pipe. The request is passed to the host @@ -66,7 +63,6 @@ Requests for bulk transfers must have mblks attached to store data. Allocate an mblk for data when a request is allocated via \fBusb_alloc_bulk_req\fR(9F) by passing a non-negative value for the \fIlen\fR argument. .SH RETURN VALUES -.sp .ne 2 .na \fBUSB_SUCCESS\fR @@ -179,12 +175,10 @@ and bulk_cb_flags fields of the request. Please see \fBusb_completion_reason\fR(9S) and \fBusb_callback_flags\fR(9S) for more information. .SH CONTEXT -.sp .LP May be called from kernel or user context without regard to arguments. May be called from interrupt context only when the USB_FLAGS_SLEEP flag is clear. .SH EXAMPLES -.sp .in +2 .nf /* Allocate, initialize and issue a synchronous bulk request. */ @@ -209,7 +203,6 @@ called from interrupt context only when the USB_FLAGS_SLEEP flag is clear. .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -227,12 +220,11 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_alloc_request\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_status\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_get_state\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), -\fBusb_pipe_isoc_xfer\fR(9F), \fBusb_pipe_open\fR(9F), +\fBusb_pipe_isoc_xfer\fR(9F), \fBusb_pipe_xopen\fR(9F), \fBusb_pipe_reset\fR(9F), \fBusb_bulk_request\fR(9S), \fBusb_callback_flags\fR(9S), \fBusb_completion_reason\fR(9S), \fBusb_ctrl_request\fR(9S), \fBusb_intr_request\fR(9S), diff --git a/usr/src/man/man9f/usb_pipe_close.9f b/usr/src/man/man9f/usb_pipe_close.9f index 93376ed530..571ca577ca 100644 --- a/usr/src/man/man9f/usb_pipe_close.9f +++ b/usr/src/man/man9f/usb_pipe_close.9f @@ -4,7 +4,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_PIPE_CLOSE 9F "Jan 5, 2004" +.TH USB_PIPE_CLOSE 9F "Sep 16, 2016" .SH NAME usb_pipe_close \- Close and cleanup a USB device pipe .SH SYNOPSIS @@ -22,11 +22,9 @@ usb_pipe_close \- Close and cleanup a USB device pipe .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -74,7 +72,6 @@ Second argument to callback function. .RE .SH DESCRIPTION -.sp .LP The \fBusb_pipe_close()\fR function closes the pipe pointed to by \fIpipe_handle\fR, releases all related resources and then frees the pipe @@ -158,7 +155,6 @@ Error starting asynchronous request. .RE .SH RETURN VALUES -.sp .LP Status is returned to the caller via the callback handler's rval argument. Possible callback hander rval argument values are: @@ -219,7 +215,6 @@ Note that messages mirroring the above errors are logged to the console logfile on error. (This provides status for calls which otherwise could provide status). .SH CONTEXT -.sp .LP May be called from user or kernel context regardless of arguments. May not be called from a callback executing in interrupt context. Please see @@ -231,7 +226,6 @@ supplied, can block because it is executing in kernel context. Otherwise the callback cannot block. Please see \fBusb_callback_flags\fR(9S) for more information on callbacks. .SH EXAMPLES -.sp .in +2 .nf /* Synchronous close of pipe. */ @@ -249,7 +243,6 @@ usb_pipe_close(dip, pipe, 0, close_callback, callback_arg); .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -267,8 +260,7 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_get_status\fR(9F), \fBusb_pipe_drain_reqs\fR(9F), -\fBusb_pipe_get_state\fR(9F), \fBusb_pipe_open\fR(9F), +\fBusb_pipe_get_state\fR(9F), \fBusb_pipe_xopen\fR(9F), \fBusb_pipe_reset\fR(9F), \fBusb_callback_flags\fR(9S) diff --git a/usr/src/man/man9f/usb_pipe_ctrl_xfer.9f b/usr/src/man/man9f/usb_pipe_ctrl_xfer.9f index 44fed1b424..ca9e7a9300 100644 --- a/usr/src/man/man9f/usb_pipe_ctrl_xfer.9f +++ b/usr/src/man/man9f/usb_pipe_ctrl_xfer.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. .\" See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_PIPE_CTRL_XFER 9F "Sep 15, 2009" +.TH USB_PIPE_CTRL_XFER 9F "Sep 16, 2016" .SH NAME usb_pipe_ctrl_xfer, usb_pipe_ctrl_xfer_wait \- USB control pipe transfer functions @@ -26,11 +26,9 @@ functions .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .LP For \fBusb_pipe_ctrl_xfer()\fR: .sp @@ -122,7 +120,6 @@ No flags are recognized. Reserved for future expansion. .RE .SH DESCRIPTION -.sp .LP The \fBusb_pipe_ctrl_xfer()\fR function requests the USBA framework to perform a transfer through a USB control pipe. The request is passed to the host @@ -186,7 +183,6 @@ Mblks for data are allocated optionally when a request is allocated via argument. Control requests passing or receiving no supplemental data need not allocate an mblk. .SH RETURN VALUES -.sp .LP For \fBusb_pipe_ctrl_xfer()\fR: .sp @@ -318,7 +314,6 @@ and ctrl_cb_flags fields of the request. Please see \fBusb_callback_flags\fR(9S) and \fBusb_completion_reason\fR(9S) for more information. .SH CONTEXT -.sp .LP The \fBusb_pipe_ctrl_xfer()\fR function may be called from kernel or user context without regard to arguments and from the interrupt context only when @@ -328,7 +323,6 @@ the USB_FLAGS_SLEEP flag is clear. The \fBusb_pipe_ctrl_xfer_wait()\fR function may be called from kernel or user context. .SH EXAMPLES -.sp .in +2 .nf /* Allocate, initialize and issue a synchronous control request. */ @@ -436,7 +430,6 @@ context. .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -454,12 +447,11 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_alloc_request\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_status\fR(9F). \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), \fBusb_pipe_isoc_xfer\fR(9F), -\fBusb_pipe_open\fR(9F), \fBusb_pipe_reset\fR(9F), +\fBusb_pipe_xopen\fR(9F), \fBusb_pipe_reset\fR(9F), \fBusb_pipe_get_state\fR(9F), \fBusb_bulk_request\fR(9S), \fBusb_callback_flags\fR(9S), \fBusb_ctrl_request\fR(9S), \fBusb_completion_reason\fR(9S), \fBusb_intr_request\fR(9S), diff --git a/usr/src/man/man9f/usb_pipe_get_state.9f b/usr/src/man/man9f/usb_pipe_get_state.9f index 16724f3047..2f704f166d 100644 --- a/usr/src/man/man9f/usb_pipe_get_state.9f +++ b/usr/src/man/man9f/usb_pipe_get_state.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_PIPE_GET_STATE 9F "Jan 5, 2004" +.TH USB_PIPE_GET_STATE 9F "Sep 16, 2016" .SH NAME usb_pipe_get_state \- Return USB pipe state .SH SYNOPSIS @@ -18,11 +18,9 @@ usb_pipe_get_state \- Return USB pipe state .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIpipe_handle\fR\fR @@ -50,7 +48,6 @@ No flags are recognized. Reserved for future expansion. .RE .SH DESCRIPTION -.sp .LP The \fBusb_pipe_get_state()\fR function retrieves the state of the pipe referred to by \fIpipe_handle\fR into the location pointed to by @@ -108,7 +105,6 @@ cleanup is in progress. .RE .SH RETURN VALUES -.sp .ne 2 .na \fBUSB_SUCCESS\fR @@ -136,11 +132,9 @@ Pipe_handle argument is \fBNULL\fR. .RE .SH CONTEXT -.sp .LP May be called from user, kernel or interrupt context. .SH EXAMPLES -.sp .in +2 .nf usb_pipe_handle_t pipe; @@ -158,7 +152,6 @@ May be called from user, kernel or interrupt context. .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -176,8 +169,7 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_clr_feature\fR(9F), \fBusb_get_cfg\fR(9F). \fBusb_get_status\fR(9F), \fBusb_pipe_close\fR(9F), -\fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_open\fR(9F). \fBusb_pipe_reset\fR(9F) +\fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_xopen\fR(9F). \fBusb_pipe_reset\fR(9F) diff --git a/usr/src/man/man9f/usb_pipe_intr_xfer.9f b/usr/src/man/man9f/usb_pipe_intr_xfer.9f index dda96724b5..b08ea5d323 100644 --- a/usr/src/man/man9f/usb_pipe_intr_xfer.9f +++ b/usr/src/man/man9f/usb_pipe_intr_xfer.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_PIPE_INTR_XFER 9F "Aug 3, 2006" +.TH USB_PIPE_INTR_XFER 9F "Sep 16, 2016" .SH NAME usb_pipe_intr_xfer, usb_pipe_stop_intr_polling \- USB interrupt transfer and polling functions @@ -24,11 +24,9 @@ polling functions .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .LP For \fBusb_pipe_intr_xfer()\fR: .sp @@ -82,7 +80,6 @@ USB_FLAGS_SLEEP is the only flag recognized. Wait for polling to stop. .RE .SH DESCRIPTION -.sp .LP The \fBusb_pipe_intr_xfer()\fR function requests the USBA framework to perform a transfer through a USB interrupt pipe. The request is passed to the host @@ -94,7 +91,6 @@ There are three categories of interrupt transfers: periodic or polled interrupt-IN, single-transfer interrupt-IN, and (single-transfer) interrupt-OUT. .SS "Periodic Interrupt-IN Transfers" -.sp .LP Periodic or polled interrupt-IN transfers execute on input requests which do not have the USB_ATTRS_ONE_XFER attribute set. One request enables repetitive @@ -126,7 +122,6 @@ set, the current (non-original) request is returned on error. Call this case. The USB_CR_STOPPED_POLLING flag is always set for callbacks where the original request is returned. .SS "Single-transfer Interrupt-IN Transfers" -.sp .LP Interrupt-IN requests which have the USB_ATTRS_ONE_XFER attribute perform a single transfer. Such requests are synchronous when the USB_FLAGS_SLEEP flag is @@ -135,7 +130,6 @@ is complete, and their callbacks are optional. The request is returned to the client through the normal or the exception completion callback to signal either normal completion or an error condition. .SS "Interrupt-OUT Transfers" -.sp .LP Interrupt-OUT requests always set up for a single transfer. However, multiple requests can be queued and execute in periodic fashion until depleted. @@ -196,7 +190,6 @@ Mblks for data for interrupt-OUT requests are allocated when a request is allocated via \fBusb_alloc_intr_req\fR(9F) by passing a non-negative value for the \fIlen\fR argument. .SH RETURN VALUES -.sp .LP For \fBusb_pipe_intr_xfer()\fR .sp @@ -320,13 +313,11 @@ logfile. Exception handlers' queued requests which are flushed by these commands before execution are returned with completion reason of USB_CR_FLUSHED. .SH CONTEXT -.sp .LP Both of these functions can be called from kernel or user context without regard to arguments, and may be called from interrupt context only when the USB_FLAGS_SLEEP flag is clear. .SH EXAMPLES -.sp .in +2 .nf /* Start polling on interrupt-IN pipe. */ @@ -389,7 +380,6 @@ USB_FLAGS_SLEEP flag is clear. .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -407,12 +397,11 @@ Interface stability Evolving .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_alloc_request\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_status\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_get_state\fR(9F), -\fBusb_pipe_isoc_xfer\fR(9F), \fBusb_pipe_open\fR(9F), +\fBusb_pipe_isoc_xfer\fR(9F), \fBusb_pipe_xopen\fR(9F), \fBusb_pipe_reset\fR(9F), \fBusb_bulk_request\fR(9S), \fBusb_callback_flags\fR(9S), \fBusb_completion_reason\fR(9S), \fBusb_ctrl_request\fR(9S), \fBusb_ep_descr\fR(9S), \fBusb_intr_request\fR(9S), diff --git a/usr/src/man/man9f/usb_pipe_isoc_xfer.9f b/usr/src/man/man9f/usb_pipe_isoc_xfer.9f index 8404111c62..f708880e98 100644 --- a/usr/src/man/man9f/usb_pipe_isoc_xfer.9f +++ b/usr/src/man/man9f/usb_pipe_isoc_xfer.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_PIPE_ISOC_XFER 9F "Jan 5, 2004" +.TH USB_PIPE_ISOC_XFER 9F "Sep 16, 2016" .SH NAME usb_pipe_isoc_xfer, usb_pipe_stop_isoc_polling \- USB isochronous transfer and polling functions @@ -26,11 +26,9 @@ polling functions .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .LP For \fBusb_pipe_isoc_xfer()\fR: .sp @@ -83,7 +81,6 @@ USB_FLAGS_SLEEP is the only flag recognized. Wait for polling to stop. .RE .SH DESCRIPTION -.sp .LP The \fBusb_pipe_isoc_xfer()\fR function requests the USBA framework to perform a transfer through a USB isochronous pipe. The request is passed to the @@ -115,7 +112,6 @@ exception callbacks. Such errors will instead be logged in the packet descriptor's isoc_pkt_status field. These errors can be examined when the completed request is returned through a normal callback. .SS "Isochronous-OUT TRANSFERS" -.sp .LP Allocate room for data when allocating isochronous-OUT requests via usb_alloc_isoc_req(9F), by passing a positive value for the \fIlen\fR @@ -131,7 +127,6 @@ new request has its USB_ATTRS_ISOC_XFER_ASAP attribute set, the host controller driver will queue the request to start on a frame which immediately follows the last frame of the last queued request. .SS "Isochronous-IN TRANSFERS" -.sp .LP All isochronous-IN transfers start background polling, and require only a single (original) request. The USBA framework will allocate a new request each @@ -145,7 +140,6 @@ The original request passed to \fBusb_pipe_isoc_xfer()\fR will be used to return status when polling termination is requested, or for error condition notification. There can be only one isochronous-IN request submitted at a time. .SS "CALLBACKS" -.sp .LP Isochronous transfer normal-completion callbacks cannot block for any reason since they are called from interrupt context. They will have @@ -226,7 +220,6 @@ exception callback with a completion reason of USB_CR_STOPPED_POLLING. .RE .SH RETURN VALUES -.sp .LP For \fBusb_pipe_isoc_xfer()\fR: .sp @@ -374,13 +367,11 @@ context; the pipe handle is invalid, NULL or pertains to a closing or closed pipe; or the pipe is in an error state. Messages regarding these errors will be logged to the console logfile. .SH CONTEXT -.sp .LP Both of these functions may be called from kernel or user context without regard to arguments. May be called from interrupt context only when the USB_FLAGS_SLEEP flag is clear. .SH EXAMPLES -.sp .in +2 .nf /* Start polling on an isochronous-IN pipe. */ @@ -430,7 +421,6 @@ USB_FLAGS_SLEEP flag is clear. .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -448,14 +438,13 @@ Interface stability Evolving .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_alloc_request\fR(9F), \fBusb_get_current_frame_number\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_max_pkts_per_isoc_request\fR(9F), \fBusb_get_status\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_get_state\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), -\fBusb_pipe_open\fR(9F), \fBusb_pipe_reset\fR(9F), \fBusb_bulk_request\fR(9S), +\fBusb_pipe_xopen\fR(9F), \fBusb_pipe_reset\fR(9F), \fBusb_bulk_request\fR(9S), \fBusb_callback_flags\fR(9S), \fBusb_completion_reason\fR(9S), \fBusb_ctrl_request\fR(9S), \fBusb_ep_descr\fR(9S), \fBusb_intr_request\fR(9S), \fBusb_isoc_request\fR(9S) diff --git a/usr/src/man/man9f/usb_pipe_open.9f b/usr/src/man/man9f/usb_pipe_open.9f deleted file mode 100644 index 1fdb517ace..0000000000 --- a/usr/src/man/man9f/usb_pipe_open.9f +++ /dev/null @@ -1,373 +0,0 @@ -'\" te -.\" Copyright (c) 2004, Sun Microsystems, Inc., All Rights Reserved -.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. -.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. -.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_PIPE_OPEN 9F "Jan 5, 2004" -.SH NAME -usb_pipe_open \- Open a USB pipe to a device -.SH SYNOPSIS -.LP -.nf -#include <sys/usb/usba.h> - - - -\fBint\fR \fBusb_pipe_open\fR(\fBdev_info_t *\fR\fIdip\fR, \fBusb_ep_descr_t *\fR\fIendpoint\fR, - \fBusb_pipe_policy_t *\fR\fIpipe_policy\fR, -\fBusb_flags_t\fR \fIflags\fR, \fBusb_pipe_handle_t *\fR\fIpipe_handle\fR); -.fi - -.SH INTERFACE LEVEL -.sp -.LP -Solaris DDI specific (Solaris DDI) -.SH PARAMETERS -.sp -.ne 2 -.na -\fB\fIdip\fR\fR -.ad -.RS 15n -Pointer to the device's \fBdev_info\fR structure. -.RE - -.sp -.ne 2 -.na -\fB\fIendpoint\fR\fR -.ad -.RS 15n -Pointer to endpoint descriptor. -.RE - -.sp -.ne 2 -.na -\fB\fIpipe_policy\fR\fR -.ad -.RS 15n -Pointer to \fIpipe_policy\fR. \fIpipe_policy\fR provides hints on pipe usage. -.RE - -.sp -.ne 2 -.na -\fB\fIflags\fR\fR -.ad -.RS 15n -USB_FLAGS_SLEEP is only flag that is recognized. Wait for memory resources if -not immediately available. -.RE - -.sp -.ne 2 -.na -\fB\fIpipe_handle\fR\fR -.ad -.RS 15n -Address to where new pipe handle is returned. (The handle is opaque.) -.RE - -.SH DESCRIPTION -.sp -.LP -A pipe is a logical connection to an endpoint on a USB device. The -\fBusb_pipe_open()\fR function creates such a logical connection and returns an -initialized handle which refers to that connection. -.sp -.LP -The \fIUSB 2.0\fR specification defines four endpoint types, each with a -corresponding type of pipe. Each of the four types of pipes uses its physical -connection resource differently. They are: -.sp -.ne 2 -.na -\fBControl pipe\fR -.ad -.RS 20n -Used for bursty, non-periodic, reliable, host-initiated request/response -communication, such as for command/status operations. These are guaranteed to -get approximately 10% of frame time and will get more if needed and if -available, but there is no guarantee on transfer promptness. Bidirectional. -.RE - -.sp -.ne 2 -.na -\fBBulk pipe\fR -.ad -.RS 20n -Used for large, reliable, non-time-critical data transfers. These get the bus -on a bandwidth-available basis. Unidirectional. Sample uses include printer -data. -.RE - -.sp -.ne 2 -.na -\fBInterrupt pipe\fR -.ad -.RS 20n -Used for sending or receiving small amounts of reliable data infrequently but -with bounded service periods, as for interrupt handling. Unidirectional. -.RE - -.sp -.ne 2 -.na -\fBIsochronous pipe\fR -.ad -.RS 20n -Used for large, unreliable, time-critical data transfers. Boasts a guaranteed -constant data rate as long as there is data, but there are no retries of failed -transfers. Interrupt and isochronous data are together guaranteed 90% of frame -time as needed. Unidirectional. Sample uses include audio. -.RE - -.sp -.LP -The type of endpoint to which a pipe connects (and therefore the pipe type) is -defined by the \fBbmAttributes\fR field of that pipe's endpoint descriptor. -(See \fBusb_ep_descr\fR(9S)). Opens to interrupt and isochronous pipes can fail -if the required bandwidth cannot be guaranteed. -.sp -.LP -The polling interval for periodic (interrupt or isochronous) pipes, carried by -the endpoint argument's bInterval field, must be within range. Valid ranges -are: -.sp -.LP -Full speed: range of 1-255 maps to 1-255 ms. -.sp -.LP -Low speed: range of 10-255 maps to 10-255 ms. -.sp -.LP -High speed: range of 1-16 maps to (2**(bInterval-1)) * 125us. -.sp -.LP -Adequate bandwidth during transfers is guaranteed for all periodic pipes which -are opened successfully. Interrupt and isochronous pipes have guaranteed -latency times, so bandwidth for them is allocated when they are opened. (Please -refer to Sections \fI5.7\fR and \fI5.8\fR of the \fIUSB 2.0\fR specification -which address isochronous and interrupt transfers.) Opens of interrupt and -isochronous pipes fail if inadequate bandwidth is available to support their -guaranteed latency time. Because periodic pipe bandwidth is allocated on pipe -open, open periodic pipes only when needed. -.sp -.LP -The bandwidth required by a device varies based on polling interval, the -maximum packet size (\fBwMaxPacketSize\fR) and the device speed. Unallocated -bandwidth remaining for new devices depends on the bandwidth already allocated -for previously opened periodic pipes. -.sp -.LP -The \fIpipe_policy\fR parameter provides a hint as to pipe usage and must be -specified. It is a \fBusb_pipe_policy_t\fR which contains the following fields: -.sp -.in +2 -.nf -uchar_t pp_max_async_reqs: - A hint indicating how many - asynchronous operations requiring - their own kernel thread will be - concurrently in progress, the highest - number of threads ever needed at one - time. Allow at least one for - synchronous callback handling and as - many as are needed to accommodate the - anticipated parallelism of asynchronous* - calls to the following functions: - usb_pipe_close(9F) - usb_set_cfg(9F) - usb_set_alt_if(9F) - usb_clr_feature(9F) - usb_pipe_reset(9F) - usb_pipe_drain_reqs(9F) - usb_pipe_stop_intr_polling(9F) - usb_pipe_stop_isoc_polling(9F) - Setting to too small a value can - deadlock the pipe. - - * Asynchronous calls are calls made - without the USB_FLAGS_SLEEP flag being - passed. Note that a large number of - callbacks becomes an issue mainly when - blocking functions are called from - callback handlers. -.fi -.in -2 - -.sp -.LP -The control pipe to the default endpoints (endpoints for both directions with -addr 0, sometimes called the default control pipe or default pipe) comes -pre-opened by the hub. A client driver receives the default control pipe handle -through \fBusb_get_dev_data\fR(9F). A client driver cannot open the default -control pipe manually. Note that the same control pipe may be shared among -several drivers when a device has multiple interfaces and each interface is -operated by its own driver. -.sp -.LP -All explicit pipe opens are exclusive; attempts to open an opened pipe fail. -.sp -.LP -On success, the pipe_handle argument points to an opaque handle of the opened -pipe. On failure, it is set to NULL. -.SH RETURN VALUES -.sp -.ne 2 -.na -\fBUSB_SUCCESS\fR -.ad -.RS 25n -Open succeeded. -.RE - -.sp -.ne 2 -.na -\fBUSB_NO_RESOURCES\fR -.ad -.RS 25n -Insufficient resources were available. -.RE - -.sp -.ne 2 -.na -\fBUSB_NO_BANDWIDTH\fR -.ad -.RS 25n -Insufficient bandwidth available. (isochronous and interrupt pipes). -.RE - -.sp -.ne 2 -.na -\fBUSB_INVALID_CONTEXT\fR -.ad -.RS 25n -Called from interrupt handler with USB_FLAGS_SLEEP set. -.RE - -.sp -.ne 2 -.na -\fBUSB_INVALID_ARGS\fR -.ad -.RS 25n -dip and/or pipe_handle is NULL. Pipe_policy is NULL. -.RE - -.sp -.ne 2 -.na -\fBUSB_INVALID_PERM\fR -.ad -.RS 25n -Endpoint is NULL, signifying the default control pipe. A client driver cannot -open the default control pipe. -.RE - -.sp -.ne 2 -.na -\fBUSB_NOT_SUPPORTED\fR -.ad -.RS 25n -Isochronous or interrupt endpoint with maximum packet size of zero is not -supported. -.RE - -.sp -.ne 2 -.na -\fBUSB_HC_HARDWARE_ERROR\fR -.ad -.RS 25n -Host controller is in an error state. -.RE - -.sp -.ne 2 -.na -\fBUSB_FAILURE\fR -.ad -.RS 25n -Pipe is already open. Host controller not in an operational state. Polling -interval (\fBep_descr bInterval\fR field) is out of range (intr or isoc pipes). -.RE - -.SH CONTEXT -.sp -.LP -May be called from user or kernel context regardless of arguments. May also be -called from interrupt context if the \fIUSB_FLAGS_SLEEP\fR option is not set. -.SH EXAMPLES -.sp -.in +2 -.nf - usb_ep_data_t *ep_data; - usb_pipe_policy_t policy; - usb_pipe_handle_t pipe; - usb_client_dev_data_t *reg_data; - uint8_t interface = 1; - uint8_t alternate = 1; - uint8_t first_ep_number = 0; - - /* Initialize pipe policy. */ - bzero(policy, sizeof(usb_pipe_policy_t)); - policy.pp_max_async_requests = 2; - - /* Get tree of descriptors for device. */ - if (usb_get_dev_data( - dip, USBDRV_VERSION, ®_data, USB_FLAGS_ALL_DESCR, 0) != - USB_SUCCESS) { - ... - } - - /* Get first interrupt-IN endpoint. */ - ep_data = usb_lookup_ep_data(dip, reg_data, interface, alternate, - first_ep_number, USB_EP_ATTR_INTR, USB_EP_DIR_IN); - if (ep_data == NULL) { - ... - } - - /* Open the pipe. Get handle to pipe back in 5th argument. */ - if (usb_pipe_open(dip, &ep_data.ep_descr - &policy, USB_FLAGS_SLEEP, &pipe) != USB_SUCCESS) { - ... - } -.fi -.in -2 - -.SH ATTRIBUTES -.sp -.LP -See \fBattributes\fR(5) for descriptions of the following attributes: -.sp - -.sp -.TS -box; -c | c -l | l . -ATTRIBUTE TYPE ATTRIBUTE VALUE -_ -Architecture PCI-based systems -_ -Interface stability Committed -.TE - -.SH SEE ALSO -.sp -.LP -\fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), -\fBusb_get_status\fR(9F), \fBusb_get_dev_data\fR(9F), -\fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), -\fBusb_pipe_close\fR(9F), \fBusb_pipe_get_state\fR(9F), -\fBusb_pipe_intr_xfer\fR(9F), \fBusb_pipe_isoc_xfer\fR(9F), -\fBusb_pipe_reset\fR(9F), \fBusb_pipe_set_private\fR(9F), -\fBusb_ep_descr\fR(9S), \fBusb_callback_flags\fR(9S) diff --git a/usr/src/man/man9f/usb_pipe_reset.9f b/usr/src/man/man9f/usb_pipe_reset.9f index 7b465c72cb..5f7a516613 100644 --- a/usr/src/man/man9f/usb_pipe_reset.9f +++ b/usr/src/man/man9f/usb_pipe_reset.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_PIPE_RESET 9F "Jan 5, 2004" +.TH USB_PIPE_RESET 9F "Sep 16, 2016" .SH NAME usb_pipe_reset \- Abort queued requests from a USB pipe and reset the pipe .SH SYNOPSIS @@ -19,11 +19,9 @@ usb_pipe_reset \- Abort queued requests from a USB pipe and reset the pipe .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -70,7 +68,6 @@ Second argument to callback function. .RE .SH DESCRIPTION -.sp .LP Call \fBusb_pipe_reset()\fR to reset a pipe which is in an error state, or to abort a current request and clear the pipe. The \fBusb_pipe_reset()\fR function @@ -161,7 +158,6 @@ USB_CB_ASYNC_REQ_FAILED \(em Error starting asynchronous request. .RE .SH RETURN VALUES -.sp .LP Status is returned to the caller via the callback handler's rval argument. Possible callback hander rval argument values are: @@ -239,7 +235,6 @@ Note that messages mirroring the above errors are logged to the console logfile on error. This provides status for calls which could not otherwise provide status. .SH CONTEXT -.sp .LP May be called from user or kernel context regardless of arguments. May be called from any callback with the USB_FLAGS_SLEEP clear. May not be called from @@ -251,7 +246,6 @@ supplied, can block because it is executing in kernel context. Otherwise the callback cannot block. Please see \fBusb_callback_flags\fR(9S) for more information on callbacks. .SH EXAMPLES -.sp .in +2 .nf void post_reset_handler( @@ -270,7 +264,6 @@ usb_pipe_reset(dip, bulk_pipe, USB_FLAGS_SLEEP, NULL, NULL); .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -288,12 +281,11 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_get_cfg\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_close\fR(9F), \fBusb_get_status\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_drain_reqs\fR(9F), \fBusb_pipe_get_state\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), -\fBusb_pipe_isoc_xfer\fR(9F), \fBusb_pipe_open\fR(9F), +\fBusb_pipe_isoc_xfer\fR(9F), \fBusb_pipe_xopen\fR(9F), \fBusb_pipe_stop_intr_polling\fR(9F), \fBusb_pipe_stop_isoc_polling\fR(9F), \fBusb_callback_flags\fR(9S) diff --git a/usr/src/man/man9f/usb_pipe_set_private.9f b/usr/src/man/man9f/usb_pipe_set_private.9f index 71f1b21bad..20735dcc1d 100644 --- a/usr/src/man/man9f/usb_pipe_set_private.9f +++ b/usr/src/man/man9f/usb_pipe_set_private.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_PIPE_SET_PRIVATE 9F "Jan 5, 2004" +.TH USB_PIPE_SET_PRIVATE 9F "Sep 16, 2016" .SH NAME usb_pipe_set_private, usb_pipe_get_private \- USB user-defined pipe data-field facility @@ -21,11 +21,9 @@ facility .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .LP For \fBusb_pipe_set_private()\fR: .sp @@ -59,7 +57,6 @@ Pipe handle from which user-defined data is retrieved. .RE .SH DESCRIPTION -.sp .LP The \fBusb_set_driver_private()\fR function initializes the user-private data field of the pipe referred to by \fIpipe_handle\fR, using \fIdata\fR. The @@ -72,7 +69,6 @@ The \fBusb_get_driver_private()\fR function retrieves the user-private data stored via \fBusb_set_driver_private()\fR, from the pipe referred to by \fIpipe_handle\fR. .SH RETURN VALUES -.sp .LP For \fBusb_pipe_set_private()\fR: .sp @@ -115,11 +111,9 @@ On success: usb_opaque_t pointer to data being retrieved. On failure: \fBNULL\fR. Fails if pipe handle is \fBNULL\fR or invalid. Fails if pipe handle is to a pipe which is closing or closed. .SH CONTEXT -.sp .LP May be called from user, kernel or interrupt context. .SH EXAMPLES -.sp .in +2 .nf usb_pipe_handle_t pipe; @@ -137,7 +131,6 @@ May be called from user, kernel or interrupt context. .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -155,6 +148,5 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP -\fBattributes\fR(5), \fBusb_pipe_open\fR(9F), \fBusb_alloc_request\fR(9F) +\fBattributes\fR(5), \fBusb_pipe_xopen\fR(9F), \fBusb_alloc_request\fR(9F) diff --git a/usr/src/man/man9f/usb_pipe_xopen.9f b/usr/src/man/man9f/usb_pipe_xopen.9f new file mode 100644 index 0000000000..b9a2406252 --- /dev/null +++ b/usr/src/man/man9f/usb_pipe_xopen.9f @@ -0,0 +1,299 @@ +.\" Copyright (c) 2004, Sun Microsystems, Inc., All Rights Reserved +.\" Copyright 2016 Joyent, Inc. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.Dd Sep 16, 2016 +.Dt USB_PIPE_XOPEN 9F +.Os +.Sh NAME +.Nm usb_pipe_open , +.Nm usb_pipe_xopen +.Nd Open a USB pipe to a device +.Sh SYNOPSIS +.In sys/usb/usba.h +.Ft int +.Fo usb_pipe_open +.Fa "dev_info_t *dip" +.Fa "usb_ep_descr_t *endpoint" +.Fa "usb_pipe_policy_t *pipe_policy" +.Fa "usb_flags_t flags" +.Fa "usb_pipe_handle_t *pipe_handle" +.Fc +.Ft int +.Fo usb_pipe_xopen +.Fa "dev_info_t *dip" +.Fa "usb_ep_xdescr_t *extended_endpoint" +.Fa "usb_pipe_policy_t *pipe_policy" +.Fa "usb_flags_t flags" +.Fa "usb_pipe_handle_t *pipe_handle" +.Fc +.Sh INTERFACE LEVEL +Solaris DDI specific (Solaris DDI) +.Sh PARAMETERS +.Bl -tag -width Fa +.It Fa dip +Pointer to the device's +.Sy dev_info +structure. +.It Fa endpoint +Pointer to endpoint descriptor. +.It Fa extended_endpoint +Pointer to an extended endpoint descriptor retrieved from calling +.Xr usb_ep_xdescr_fill 9F . +.It Fa pipe_policy +Pointer to +.Em pipe_policy. +.Em pipe_policy +provides hints on pipe usage. +.It Fa flags +.Sy USB_FLAGS_SLEEP +is only flag that is recognized. Wait for memory resources if +not immediately available. +.It Fa pipe_handle +Address to where new pipe handle is returned. (The handle is opaque.) +.El +.Sh DESCRIPTION +A pipe is a logical connection to an endpoint on a USB device. The +.Fn usb_pipe_xopen +function creates such a logical connection and returns an +initialized handle which refers to that connection. +.Pp +The +.Em USB 3.0 +specification defines four endpoint types, each with a +corresponding type of pipe. Each of the four types of pipes uses its physical +connection resource differently. They are: +.Bl -tag -width Sy +.It Sy Control Pipe +Used for bursty, non-periodic, reliable, host-initiated request/response +communication, such as for command/status operations. These are guaranteed to +get approximately 10% of frame time and will get more if needed and if +available, but there is no guarantee on transfer promptness. Bidirectional. +.It Sy Bulk Pipe +Used for large, reliable, non-time-critical data transfers. These get the bus +on a bandwidth-available basis. Unidirectional. Sample uses include printer +data. +.It Sy Interrupt Pipe +Used for sending or receiving small amounts of reliable data infrequently but +with bounded service periods, as for interrupt handling. Unidirectional. +.It Sy Isochronous Pipe +Used for large, unreliable, time-critical data transfers. Boasts a guaranteed +constant data rate as long as there is data, but there are no retries of failed +transfers. Interrupt and isochronous data are together guaranteed 90% of frame +time as needed. Unidirectional. Sample uses include audio. +.El +.Pp +The type of endpoint to which a pipe connects (and therefore the pipe type) is +defined by the +.Sy bmAttributes +field of that pipe's endpoint descriptor. +.Po +See +.Xr usb_ep_descr 9S +.Pc . +.Pp +Prior to the +.Em USB 3.0 +specification, only the +.Xr usb_ep_descr 9S +was required to identify all of the attributes of a given pipe. Starting +with +.Em USB 3.0 +there are additional endpoint companion descriptors required to open a +pipe. To support SuperSpeed devices, the new +.Fn usb_pipe_xopen +function must be used rather than the older +.Fn usb_pipe_open +function. The +.Xr usb_ep_xdescr 9S +structure can be automatically filled out and obtained by calling the +.Xr usb_ep_xdescr_fill 9F +function. +.Pp +Opens to interrupt and isochronous pipes can fail +if the required bandwidth cannot be guaranteed. +.Pp +The polling interval for periodic (interrupt or isochronous) pipes, carried by +the endpoint argument's bInterval field, must be within range. Valid ranges +are: +.Pp +Full speed: range of 1-255 maps to 1-255 ms. +.Pp +Low speed: range of 10-255 maps to 10-255 ms. +.Pp +High speed: range of 1-16 maps to (2**(bInterval-1)) * 125us. +.Pp +Super speed: range of 1-16 maps to (2**(bInterval-1)) * 125us. +.Pp +Adequate bandwidth during transfers is guaranteed for all periodic pipes which +are opened successfully. Interrupt and isochronous pipes have guaranteed +latency times, so bandwidth for them is allocated when they are opened. +.Po +Please +refer to Sections +.Em 4.4.7 +and +.Em 4.4.8 +of the +.Em USB 3.1 +specification +which address isochronous and interrupt transfers. +.Pc +Opens of interrupt and isochronous pipes fail if inadequate bandwidth is +available to support their guaranteed latency time. Because periodic +pipe bandwidth is allocated on pipe open, open periodic pipes only when +needed. +.Pp +The bandwidth required by a device varies based on polling interval, the +maximum packet size +.Pq Sy wMaxPacketSize +and the device speed. Unallocated +bandwidth remaining for new devices depends on the bandwidth already allocated +for previously opened periodic pipes. +.Pp +The +.Em pipe_policy +parameter provides a hint as to pipe usage and must be +specified. It is a +.Em usb_pipe_policy_t +which contains the following fields: +.Bd -literal -offset indent +uchar_t pp_max_async_reqs: +.Ed +.Pp +The +.Sy pp_max_async_reqs +member is a hint indicating how many asynchronous operations requiring +their own kernel thread will be concurrently in progress, the highest +number of threads ever needed at one time. Allow at least one for +synchronous callback handling and as many as are needed to accommodate +the anticipated parallelism of asynchronous* calls to the following +functions: +.Xr usb_pipe_close 9F , +.Xr usb_set_cfg 9F , +.Xr usb_set_alt_if 9F , +.Xr usb_clr_feature 9F , +.Xr usb_pipe_reset 9F , +.Xr usb_pipe_drain_reqs 9F , +.Xr usb_pipe_stop_intr_polling 9F , +and +.Xr usb_pipe_stop_isoc_polling 9F . +.Pp +Setting to too small a value can deadlock the pipe. Asynchronous calls +are calls made without the +.Sy USB_FLAGS_SLEEP +flag being passed. Note that +a large number of callbacks becomes an issue mainly when blocking +functions are called from callback handlers. +.Pp +The control pipe to the default endpoints (endpoints for both directions with +addr 0, sometimes called the default control pipe or default pipe) comes +pre-opened by the hub. A client driver receives the default control pipe handle +through +.Xr usb_get_dev_data 9F . +A client driver cannot open the default +control pipe manually. Note that the same control pipe may be shared among +several drivers when a device has multiple interfaces and each interface is +operated by its own driver. +.Pp +All explicit pipe opens are exclusive; attempts to open an opened pipe fail. +.Pp +On success, the pipe_handle argument points to an opaque handle of the opened +pipe. On failure, it is set to NULL. +.Sh CONTEXT +May be called from user or kernel context regardless of arguments. May also be +called from interrupt context if the +.Sy USB_FLAGS_SLEEP +option is not set. +.Sh RETURN VALUES +.Bl -tag -width Sy +.It Sy USB_SUCCESS +Open succeeded. +.It Sy USB_NO_RESOURCES +Insufficient resources were available. +.It Sy USB_NO_BANDWIDTH +Insufficient bandwidth available. (isochronous and interrupt pipes). +.It Sy USB_INVALID_CONTEXT +Called from interrupt handler with USB_FLAGS_SLEEP set. +.It Sy USB_INVALID_ARGS +dip and/or pipe_handle is NULL. Pipe_policy is NULL. +.It Sy USB_INVALID_PERM +Endpoint is NULL, signifying the default control pipe. A client driver cannot +open the default control pipe. +.It Sy USB_NOT_SUPPORTED +Isochronous or interrupt endpoint with maximum packet size of zero is not +supported. +.It Sy USB_HC_HARDWARE_ERROR +Host controller is in an error state. +.It Sy USB_FAILURE +Pipe is already open. Host controller not in an operational state. Polling +interval +.Pq Sy Bep_descr bInterval No field +is out of range (intr or isoc pipes). +.Pp +The device referred to by +.Fa dip +is at least a SuperSpeed device and the older +.Fn usb_pipe_open +function was used. +.El +.Sh EXAMPLES +.Bd -literal -offset indent +usb_ep_data_t *ep_data; +usb_ep_xdescr_t ep_xdescr; +usb_pipe_policy_t policy; +usb_pipe_handle_t pipe; +usb_client_dev_data_t *reg_data; +uint8_t interface = 1; +uint8_t alternate = 1; +uint8_t first_ep_number = 0; + +/* Initialize pipe policy. */ +bzero(policy, sizeof(usb_pipe_policy_t)); +policy.pp_max_async_requests = 2; + +/* Get tree of descriptors for device. */ +if (usb_get_dev_data(dip, USBDRV_VERSION, ®_data, + USB_FLAGS_ALL_DESCR, 0) != USB_SUCCESS) { + ... +} + +/* Get first interrupt-IN endpoint. */ +ep_data = usb_lookup_ep_data(dip, reg_data, interface, alternate, + first_ep_number, USB_EP_ATTR_INTR, USB_EP_DIR_IN); +if (ep_data == NULL) { + ... +} + +/* Translate the ep_data into the filled in usb_ep_xdescr_t */ +if (usb_ep_xdescr_fill(USB_EP_XDESCR_CURRENT_VERSION, dip, + ep_data, &ep_xdescr) != USB_SUCCESS) { + ... +} + +/* Open the pipe. Get handle to pipe back in 5th argument. */ +if (usb_pipe_open(dip, &ep_data.ep_descr + &policy, USB_FLAGS_SLEEP, &pipe) != USB_SUCCESS) { + ... +} +.Ed +.Sh SEE ALSO +.Xr usb_get_alt_if 9F , +.Xr usb_get_cfg 9F , +.Xr usb_get_dev_data 9F , +.Xr usb_get_status 9F , +.Xr usb_pipe_bulk_xfer 9F , +.Xr usb_pipe_close 9F , +.Xr usb_pipe_ctrl_xfer 9F , +.Xr usb_pipe_get_state 9F , +.Xr usb_pipe_intr_xfer 9F , +.Xr usb_pipe_isoc_xfer 9F , +.Xr usb_pipe_reset 9F , +.Xr usb_pipe_set_private 9F , +.Xr usb_callback_flags 9S , +.Xr usb_ep_descr 9S +.Rs +.%T Universal Serial Bus 3.1 Specification +.%U http://www.usb.org +.Re diff --git a/usr/src/man/man9f/usb_reset_device.9f b/usr/src/man/man9f/usb_reset_device.9f index ff34e8f135..acf2a0244f 100644 --- a/usr/src/man/man9f/usb_reset_device.9f +++ b/usr/src/man/man9f/usb_reset_device.9f @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_RESET_DEVICE 9F "Aug 21, 2007" +.TH USB_RESET_DEVICE 9F "Sep 16, 2016" .SH NAME usb_reset_device \- reset a USB device according to the reset_level. .SH SYNOPSIS @@ -18,11 +18,9 @@ usb_reset_device \- reset a USB device according to the reset_level. .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH PARAMETERS -.sp .ne 2 .na \fB\fIdip\fR\fR @@ -44,7 +42,6 @@ The level to which the device is reset. See below for a list of valid .RE .SH DESCRIPTION -.sp .LP The \fBusb_reset_device()\fR function provides a client driver to request a hardware reset for a \fBUSB\fR device, which may be required in some situations @@ -104,7 +101,6 @@ depending on where the failure occurred. .RE .SH RETURN VALUES -.sp .LP The return values for the \fBusb_reset_device()\fR function are: .sp @@ -237,12 +233,10 @@ static int xxx_attach(dev_info_t *dip, ddi_attach_cmd_t cmd) .in -2 .SH CONTEXT -.sp .LP The \fBusb_reset_device()\fR function may be called from user or kernel context. .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -260,12 +254,10 @@ Interface Stability Committed .TE .SH SEE ALSO -.sp .LP \fBattributes\fR(5), \fBusb_clr_feature\fR(9F), \fBusb_get_cfg\fR(9F), -\fBusb_pipe_close\fR(9F), \fBusb_pipe_open\fR(9F), \fBusb_pipe_reset\fR(9F), +\fBusb_pipe_close\fR(9F), \fBusb_pipe_xopen\fR(9F), \fBusb_pipe_reset\fR(9F), .SH DIAGNOSTICS -.sp .LP The messages described below may appear on the system console as well as being logged. All messages are formatted in the following manner: @@ -318,6 +310,5 @@ function. .RE .SH NOTES -.sp .LP Always close all applications before resetting a device. diff --git a/usr/src/man/man9s/Makefile b/usr/src/man/man9s/Makefile index f281dc3230..36ff13a29b 100644 --- a/usr/src/man/man9s/Makefile +++ b/usr/src/man/man9s/Makefile @@ -75,27 +75,38 @@ MANFILES= Intro.9s \ stroptions.9s \ tuple.9s \ uio.9s \ - usb_bulk_request.9s \ + usb_bulk_req.9s \ usb_callback_flags.9s \ usb_cfg_descr.9s \ usb_client_dev_data.9s \ usb_completion_reason.9s \ - usb_ctrl_request.9s \ + usb_ctrl_req.9s \ usb_dev_descr.9s \ usb_dev_qlf_descr.9s \ usb_ep_descr.9s \ + usb_ep_ss_comp_descr.9s \ + usb_ep_xdescr.9s \ usb_if_descr.9s \ - usb_intr_request.9s \ - usb_isoc_request.9s \ + usb_intr_req.9s \ + usb_isoc_req.9s \ usb_other_speed_cfg_descr.9s \ usb_request_attributes.9s \ usb_string_descr.9s -MANLINKS= dblk.9s \ - intro.9s \ - mac_callbacks_t.9s \ - mac_register_t.9s \ - mblk.9s +MANLINKS= dblk.9s \ + intro.9s \ + mac_callbacks_t.9s \ + mac_register_t.9s \ + mblk.9s \ + usb_ep_ss_comp_descr_t.9s \ + usb_bulk_req_t.9s \ + usb_bulk_request.9s \ + usb_ctrl_req_t.9s \ + usb_ctrl_request.9s \ + usb_intr_req_t.9s \ + usb_intr_request.9s \ + usb_isoc_req_t.9s \ + usb_isoc_request.9s intro.9s := LINKSRC = Intro.9s @@ -106,6 +117,24 @@ mac_register_t.9s := LINKSRC = mac_register.9s mblk.9s := LINKSRC = msgb.9s +# +# The usb_*_req(9S) pages used to be called usb_*_request(9S). We've +# kept the old name around as a link to help folks out, but changed the +# name so that they actually matched the structures. +# +usb_bulk_req_t.9s := LINKSRC = usb_bulk_req.9s +usb_bulk_request.9s := LINKSRC = usb_bulk_req.9s +usb_ctrl_req_t.9s := LINKSRC = usb_ctrl_req.9s +usb_ctrl_request.9s := LINKSRC = usb_ctrl_req.9s +usb_intr_req_t.9s := LINKSRC = usb_intr_req.9s +usb_intr_request.9s := LINKSRC = usb_intr_req.9s +usb_isoc_req_t.9s := LINKSRC = usb_isoc_req.9s +usb_isoc_request.9s := LINKSRC = usb_isoc_req.9s + +usb_ep_ss_comp_descr_t.9s := LINKSRC = usb_ep_ss_comp_descr.9s +usb_ep_xdescr_t.9s := LINKSRC = usb_ep_xdescr.9s +usba_hcdi_register_args_t.9s := LINKSRC = usba_hcdi_register_args.9s + .KEEP_STATE: include $(SRC)/man/Makefile.man diff --git a/usr/src/man/man9s/usb_bulk_request.9s b/usr/src/man/man9s/usb_bulk_req.9s index ff76d494fa..80aea5ad14 100644 --- a/usr/src/man/man9s/usb_bulk_request.9s +++ b/usr/src/man/man9s/usb_bulk_req.9s @@ -5,7 +5,7 @@ .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] .TH USB_BULK_REQUEST 9S "Jan 5, 2004" .SH NAME -usb_bulk_request \- USB bulk request structure +usb_bulk_req, usb_bulk_req_t, usb_bulk_request \- USB bulk request structure .SH SYNOPSIS .LP .nf @@ -13,11 +13,9 @@ usb_bulk_request \- USB bulk request structure .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH DESCRIPTION -.sp .LP A bulk request (that is, a request sent through a bulk pipe) is used to transfer large amounts of data in reliable but non-time-critical fashion. @@ -27,7 +25,7 @@ information on bulk transfers. (The \fIUSB 2.0\fR specification is available at .sp .LP The fields in the usb_bulk_req_t are used to format a bulk request. Please see -below for acceptable combinations of flags and attributes. +below for acceptable combinations of flags and attributes. .sp .LP The usb_bulk_req_t fields are: @@ -242,7 +240,6 @@ summarize recovery actions taken and errors encountered during recovery. See All usb request types share the same callback handling. See \fBusb_callback_flags\fR(9S) for details. .SH ATTRIBUTES -.sp .LP See attributes(5) for descriptions of the following attributes: .sp @@ -260,7 +257,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBusb_alloc_request\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_get_max_bulk_transfer_size\fR(9F), diff --git a/usr/src/man/man9s/usb_client_dev_data.9s b/usr/src/man/man9s/usb_client_dev_data.9s index 0cccba2df3..d1a0cfe12d 100644 --- a/usr/src/man/man9s/usb_client_dev_data.9s +++ b/usr/src/man/man9s/usb_client_dev_data.9s @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH USB_CLIENT_DEV_DATA 9S "Jan 5, 2004" +.TH USB_CLIENT_DEV_DATA 9S "Oct 30, 2016" .SH NAME usb_client_dev_data \- Device configuration information .SH SYNOPSIS @@ -13,11 +13,9 @@ usb_client_dev_data \- Device configuration information .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH DESCRIPTION -.sp .LP The usb_client_dev_data_t structure carries all device configuration information. It is provided to a USB client driver through a call to @@ -142,7 +140,7 @@ devices. .LP The descriptor tree, returned by dev_cfg, makes a device's parsed standard USB descriptors available to the driver. The tree is designed to be easily -traversed to get any or all standard \fIUSB 2.0\fR descriptors. (See the "Tree +traversed to get any or all standard \fIUSB 3.0\fR descriptors. (See the "Tree Structure" section of this manpage below.) dev_n_cfg returns the number of configurations in the tree. Note that this value may differ from the number of configurations returned in the device descriptor. @@ -161,10 +159,9 @@ USB_PARSE_LVL_NONE is returned when no tree is returned. Note that the value of this field can differ from the parse_level requested as an argument to \fBusb_get_dev_data()\fR. .SS "TREE STRUCTURE" -.sp .LP The root of the tree is dev_cfg, an array of usb_cfg_data_t configuration -nodes, each representing one device configuration. The array index does +nodes, each representing one device configuration. The array index does not correspond to a configuration's value; use the bConfigurationValue field of the configuration descriptor within to find out the proper number for a given configuration. @@ -227,7 +224,6 @@ Configuration and interface alternate nodes return string descriptions. Note that all string descriptions returned have a maximum length of USB_MAXSTRINGLEN bytes and are in English ASCII. .SH EXAMPLES -.sp .LP In the following example, a device's configuration data, including the following descriptor tree, is retrieved by \fBusb_get_dev_data\fR(9F) into @@ -278,7 +274,6 @@ usb_client_dev_data_t *reg_data: .in -2 .SH ATTRIBUTES -.sp .LP See \fBattributes\fR(5) for descriptions of the following attributes: .sp @@ -296,7 +291,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F), \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F), \fBusb_lookup_ep_data\fR(9F), diff --git a/usr/src/man/man9s/usb_ctrl_request.9s b/usr/src/man/man9s/usb_ctrl_req.9s index bc59381f13..e3e9b828dd 100644 --- a/usr/src/man/man9s/usb_ctrl_request.9s +++ b/usr/src/man/man9s/usb_ctrl_req.9s @@ -5,7 +5,7 @@ .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] .TH USB_CTRL_REQUEST 9S "Jan 5, 2004" .SH NAME -usb_ctrl_request \- USB control pipe request structure +usb_ctrl_req, usb_ctrl_req_t, usb_ctrl_request \- USB control pipe request structure .SH SYNOPSIS .LP .nf @@ -13,11 +13,9 @@ usb_ctrl_request \- USB control pipe request structure .fi .SH INTERFACE LEVEL -.sp .LP Solaris DDI specific (Solaris DDI) .SH DESCRIPTION -.sp .LP A control request is used to send device commands (or requests) and to read status. Please refer to Section\fI 5.5\fR of the \fIUSB 2.0\fR specification @@ -25,7 +23,6 @@ for information on control pipes. For information on formatting requests, see Section \fI9.3\fR of the \fIUSB 2.0\fR specification. The USB 2.0 specification is available at \fIwww.usb.org\fR. .SH STRUCTURE MEMBERS -.sp .LP The fields in the usb_ctrl_req_t are used to format a control request: .sp @@ -158,7 +155,6 @@ Unicode language ID, used as wIndex for USB_REQ_SET/GET_DESCRIPTOR .in -2 .SH ATTRIBUTES -.sp .LP See attributes(5) for descriptions of the following attributes: .sp @@ -176,7 +172,6 @@ Interface stability Committed .TE .SH SEE ALSO -.sp .LP \fBusb_alloc_request\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F), \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_intr_xfer\fR(9F), diff --git a/usr/src/man/man9s/usb_ep_ss_comp_descr.9s b/usr/src/man/man9s/usb_ep_ss_comp_descr.9s new file mode 100644 index 0000000000..b94b7f576b --- /dev/null +++ b/usr/src/man/man9s/usb_ep_ss_comp_descr.9s @@ -0,0 +1,122 @@ +.\" +.\" 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 2016 Joyent, Inc. +.\" +.Dd Aug 10, 2016 +.Dt USB_EP_SS_COMP_DESCR 9S +.Os +.Sh NAME +.Nm usb_ep_ss_comp_descr , +.Nm usb_ep_ss_comp_descr_t +.Nd USB endpoint SuperSpeed Companion Descriptor +.Sh SYNOPSIS +.In sys/usb/usba.h +.Sh INTERFACE LEVEL +illumos DDI Specific +.Sh DESCRIPTION +The +.Sy usb_ep_ss_comp_descr_t +structure defines additional endpoint attributes for USB 3.0 and newer +devices. This structure is considered a +.Em companion descriptor . +On its own, it does not uniquely define an endpoint. A standard USB +descriptor is still required. See +.Xr usb_ep_descr 9S +for the definition of the standard descriptor. +.Pp +If available, the SuperSpeed companion descriptor can be accessed by +getting the endpoint data through a call to +.Xr usb_lookup_ep_data 9F . +These descriptors are required to open pipes for USB 3.0 and newer +devices. They can be assembled into the proper format for +.Xr usb_pipe_xopen 9F +by calling +.Xr usb_ep_xdescr_fill 9F . +.Pp +This structure is formally defined in section 9.6.7 of the USB 3.1 +specification. +.Sh STRUCTURE MEMBERS +.Bd -literal -offset indent +uint8_t bLength; +uint8_t bDescriptorType; +uint8_t bMaxBurst; +uint8_t bmAttributes; +uint16_t wBytesPerInterval; +.Ed +.Pp +The +.Sy bLength +member is always set to the size of this descriptor, which is usually +six. +.Pp +The +.Sy bDescriptorType +member should be set to the macro +.Sy USB_DESCR_TYPE_SS_EP_COMP +whose value is 0x30. +.Pp +The +.Sy bMaxBurst +member indicates the maximum number of packets that the endpoint can +send in one 'burst'. Valid values range from 0 to 15 and the values are +one less than the number of packets. A value of 0 indicates that 1 +packet can be sent in a burst. A value of 15 indicates that 16 packets +can be sent in a burst. +.Pp +The +.Sy bmAttributes +member indicates different attributes of the endpoint. This member is +reserved and should be zero for +.Sy control +and +.Sy interrupt +endpoints. +.Pp +For a +.Sy bulk +endpoint, the +.Sy bmAttributes +member is used to indicate the maximum number of streams that the device +supports. The first five bits (4:0) are used, the remaining 3 bits are +reserved and should be zero. Values range from 0 to 16. A value of zero +indicates that streams are not supported. Otherwise, it indicates that +the device supports 2 raised to the value number of streams. A value of +3, indicates 2^3 streams are supported. +.Pp +For an +.Sy isochronous +endpoint, the +.Sy bmAttributes +member is used to indicate the value of the +.Sy Mult +property, a value used to calculate the maximum number of packets the +device and receive in a service interval. The first two bits (1:0) are +used to determine the mult. The remaining 6 bits (7:2) are reserved and +should be set to zero. +.Pp +The +.Sy wBytesPerInterval +member is used to indicate the total number of bytes that can be +transferred in one service interval. Note, this is only valid for +.Sy Isochronous +and +.Sy Interrupt IN +(periodic) endpoints. +.Sh SEE ALSO +.Xr usb_ep_xdescr_fill 9F , +.Xr usb_pipe_xopen 9F , +.Xr usb_ep_descr 9S , +.Xr usb_ep_xdescr 9S +.Rs +.%T Universal Serial Bus 3.1 Specification +.%U www.usb.org +.Re diff --git a/usr/src/man/man9s/usb_ep_xdescr.9s b/usr/src/man/man9s/usb_ep_xdescr.9s new file mode 100644 index 0000000000..bb7a86120e --- /dev/null +++ b/usr/src/man/man9s/usb_ep_xdescr.9s @@ -0,0 +1,117 @@ +.\" +.\" 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 2016 Joyent, Inc. +.\" +.Dd Sep 16, 2016 +.Dt USB_EP_XDESCR 9S +.Os +.Sh NAME +.Nm usb_ep_xdescr , +.Nm usb_ep_xdescr_t +.Nd extended endpoint descriptor +.Sh SYNOPSIS +.In sys/usb/usba.h +.Sh INTERFACE LEVEL +illumos DDI Specific +.Sh DESCRIPTION +The +.Sy usb_ep_xdescr_t +structure is used to describe an endpoint descriptor as well account for +the continuing evolutions in the USB specification. +.Pp +Starting with the +.Em USB 3.0 +specification, +.Em USB 3.0 +endpoints have an endpoint SuperSpeed companion descriptor. See +.Xr usb_ep_ss_comp_descr 9S +for a description of the descriptor. In the +.Em USB 3.1 +specification, certain endpoints will have additional companion +descriptors. +.Pp +The +.Sy usb_ep_xdescr_t +structure, combined with the +.Xr usb_ep_xdescr_fill 9F +and +.Xr usb_pipe_xopen 9F +are designed to abstract away the need for USB client device drivers to +need to be updated in the face of these newer endpoints, whose +information is required for host controller devices to properly program +the device. +.Pp +After looking up endpoint data, through the +.Xr usb_lookup_ep_data 9F , +device drivers should call the +.Xr usb_ep_xdescr_fill 9F +function. After that, the +.Sy usb_ep_xdescr_t +structure will be filled in. +.Sh STRUCTURE MEMBERS +The +.Sy usb_ep_xdescr_t +structure has the following members: +.Bd -literal -offset indent +uint_t uex_version; +usb_ep_xdescr_flags_t uex_flags; +usb_ep_descr_t uex_ep; +usb_ep_ss_comp_descr_t uex_ep_ss; +.Ed +.Pp +The +.Sy uex_version +member is used to describe the current version of this structure. This +member will be set to the value passed in by the device driver to +.Xr usb_ep_xdescr_fil 9F . +Device drivers should ignore this field and should not modify the value +placed there or modify it. +.Pp +The +.Sy uex_flags +member is an enumeration that defines a number of flags. Each flag +indicates whether or not a given member is present or valid. Before +accessing any member other than +.Sy uex_ep , +the device driver should check the flag here, otherwise its contents may +be undefined. Currently the following flags are defined: +.Bl -tag -width Sy -offset indent +.It Sy USB_EP_XFLAGS_SS_COMP +Indicates that a SuperSpeed endpoint companion descriptor is present and +has been filled in. The member +.Sy uex_ep_ss +is valid. +.El +.Pp +The +.Sy uex_ep +member contains a traditional USB endpoint descriptor. Its contents are +defined in +.Xr usb_ep_descr 9S . +There is no flag for this member in +.Sy uex_flags , +it is always valid. +.Pp +The +.Sy uex_ep_ss +member contains a USB 3.0 SuperSpeed endpoint companion descriptor as +defined in +.Xr usb_ep_ss_comp_descr 9S . +This member is only valid if the +.Sy USB_EP_XFLAGS_SS_COMP +flag is specified in +.Sy uex_flags . +.Sh SEE ALSO +.Xr usb_ep_xdescr_fill 9F , +.Xr usb_pipe_xopen 9F , +.Xr usb_ep_descr 9S , +.Xr usb_ep_ss_comp_descr 9S diff --git a/usr/src/man/man9s/usb_intr_request.9s b/usr/src/man/man9s/usb_intr_req.9s index beb9f271d8..b6e8ab5473 100644 --- a/usr/src/man/man9s/usb_intr_request.9s +++ b/usr/src/man/man9s/usb_intr_req.9s @@ -5,7 +5,7 @@ .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] .TH USB_INTR_REQUEST 9S "April 9, 2016" .SH NAME -usb_intr_request \- USB interrupt request structure +usb_intr_req, usb_intr_req_t, usb_intr_request \- USB interrupt request structure .SH SYNOPSIS .LP .nf diff --git a/usr/src/man/man9s/usb_isoc_request.9s b/usr/src/man/man9s/usb_isoc_req.9s index 3e957be111..83d4b7e17c 100644 --- a/usr/src/man/man9s/usb_isoc_request.9s +++ b/usr/src/man/man9s/usb_isoc_req.9s @@ -5,7 +5,7 @@ .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] .TH USB_ISOC_REQUEST 9S "April 9, 2016" .SH NAME -usb_isoc_request \- USB isochronous request structure +usb_isoc_req, usb_isoc_req_t, usb_isoc_request \- USB isochronous request structure .SH SYNOPSIS .LP .nf |