diff options
Diffstat (limited to 'usr/src/man/man7')
| -rw-r--r-- | usr/src/man/man7/FSS.7 | 219 | ||||
| -rw-r--r-- | usr/src/man/man7/Intro.7 | 183 | ||||
| -rw-r--r-- | usr/src/man/man7/Makefile | 34 | ||||
| -rw-r--r-- | usr/src/man/man7/cpr.7 | 108 | ||||
| -rw-r--r-- | usr/src/man/man7/ibmf.7 | 78 |
5 files changed, 622 insertions, 0 deletions
diff --git a/usr/src/man/man7/FSS.7 b/usr/src/man/man7/FSS.7 new file mode 100644 index 0000000000..c350bd8a03 --- /dev/null +++ b/usr/src/man/man7/FSS.7 @@ -0,0 +1,219 @@ +'\" te +.\" Copyright (c) 2001, 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 FSS 7 "1 Oct 2004" "SunOS 5.11" "Device and Network Interfaces" +.SH NAME +FSS \- Fair share scheduler +.SH DESCRIPTION +.sp +.LP +The fair share scheduler (FSS) guarantees application performance by explicitly +allocating shares of CPU resources to projects. A share indicates a project's +entitlement to available CPU resources. Because shares are meaningful only in +comparison with other project's shares, the absolute quantity of shares is not +important. Any number that is in proportion with the desired CPU entitlement +can be used. +.sp +.LP +The goals of the FSS scheduler differ from the traditional time-sharing +scheduling class (TS). In addition to scheduling individual LWPs, the FSS +scheduler schedules projects against each other, making it impossible for any +project to acquire more CPU cycles simply by running more processes +concurrently. +.sp +.LP +A project's entitlement is individually calculated by FSS independently for +each processor set if the project contains processes bound to them. If a +project is running on more than one processor set, it can have different +entitlements on every set. A project's entitlement is defined as a ratio +between the number of shares given to a project and the sum of shares of all +active projects running on the same processor set. An active project is one +that has at least one running or runnable process. Entitlements are recomputed +whenever any project becomes active or inactive, or whenever the number of +shares is changed. +.sp +.LP +Processor sets represent virtual machines in the FSS scheduling class and +processes are scheduled independently in each processor set. That is, processes +compete with each other only if they are running on the same processor set. +When a processor set is destroyed, all processes that were bound to it are +moved to the default processor set, which always exists. Empty processor sets +(that is, sets without processors in them) have no impact on the FSS scheduler +behavior. +.sp +.LP +If a processor set contains a mix of TS/IA and FSS processes, the fairness of +the FSS scheduling class can be compromised because these classes use the same +range of priorities. Fairness is most significantly affected if processes +running in the TS scheduling class are CPU-intensive and are bound to +processors within the processor set. As a result, you should avoid having +processes from TS/IA and FSS classes share the same processor set. RT and FSS +processes use disjoint priority ranges and therefore can share processor sets. +.sp +.LP +As projects execute, their CPU usage is accumulated over time. The FSS +scheduler periodically decays CPU usages of every project by multiplying it +with a decay factor, ensuring that more recent CPU usage has greater weight +when taken into account for scheduling. The FSS scheduler continually adjusts +priorities of all processes to make each project's relative CPU usage converge +with its entitlement. +.sp +.LP +While FSS is designed to fairly allocate cycles over a long-term time period, +it is possible that projects will not receive their allocated shares worth of +CPU cycles due to uneven demand. This makes one-shot, instantaneous analysis of +FSS performance data unreliable. +.sp +.LP +Note that share is not the same as utilization. A project may be allocated 50% +of the system, although on the average, it uses just 20%. Shares serve to cap a +project's CPU usage only when there is competition from other projects running +on the same processor set. When there is no competition, utilization may be +larger than entitlement based on shares. Allocating a small share to a busy +project slows it down but does not prevent it from completing its work if the +system is not saturated. +.sp +.LP +The configuration of CPU shares is managed by the name server as a property of +the \fBproject\fR(4) database. In the following example, an entry in the +\fB/etc/project\fR file sets the number of shares for project \fBx-files\fR to +10: +.sp +.in +2 +.nf +x-files:100::::project.cpu-shares=(privileged,10,none) +.fi +.in -2 + +.sp +.LP +Projects with undefined number of shares are given one share each. This means +that such projects are treated with equal importance. Projects with 0 shares +only run when there are no projects with non-zero shares competing for the same +processor set. The maximum number of shares that can be assigned to one project +is 65535. +.sp +.LP +You can use the \fBprctl\fR(1) command to determine the current share +assignment for a given project: +.sp +.in +2 +.nf +$ prctl -n project.cpu-shares -i project x-files +.fi +.in -2 + +.sp +.LP +or to change the amount of shares if you have root privileges: +.sp +.in +2 +.nf +# prctl -r -n project.cpu-shares -v 5 -i project x-files +.fi +.in -2 + +.sp +.LP +See the \fBprctl\fR(1) man page for additional information on how to modify and +examine resource controls associated with active processes, tasks, or projects +on the system. See \fBresource_controls\fR(5) for a description of the resource +controls supported in the current release of the Solaris operating system. +.sp +.LP +By default, project \fBsystem\fR (project ID 0) includes all system daemons +started by initialization scripts and has an "unlimited" amount of shares. That +is, it is always scheduled first no matter how many shares are given to other +projects. +.sp +.LP +The following command sets FSS as the default scheduler for the system: +.sp +.in +2 +.nf +# dispadmin -d FSS +.fi +.in -2 + +.sp +.LP +This change will take effect on the next reboot. Alternatively, you can move +processes from the time-share scheduling class (as well as the special case of +init) into the FSS class without changing your default scheduling class and +rebooting by becoming \fBroot\fR, and then using the \fBpriocntl\fR(1) command, +as shown in the following example: +.sp +.in +2 +.nf +# priocntl -s -c FSS -i class TS +# priocntl -s -c FSS -i pid 1 +.fi +.in -2 + +.SH CONFIGURING SCHEDULER WITH DISPADMIN +.sp +.LP +You can use the \fBdispadmin\fR(1M) command to examine and tune the FSS +scheduler's time quantum value. Time quantum is the amount of time that a +thread is allowed to run before it must relinquish the processor. The following +example dumps the current time quantum for the fair share scheduler: +.sp +.in +2 +.nf +$ dispadmin -g -c FSS + # + # Fair Share Scheduler Configuration + # + RES=1000 + # + # Time Quantum + # + QUANTUM=110 +.fi +.in -2 + +.sp +.LP +The value of the QUANTUM represents some fraction of a second with the +fractional value determied by the reciprocal value of RES. With the default +value of RES = 1000, the reciprocal of 1000 is .001, or milliseconds. Thus, by +default, the QUANTUM value represents the time quantum in milliseconds. +.sp +.LP +If you change the RES value using \fBdispadmin\fR with the \fB-r\fR option, you +also change the QUANTUM value. For example, instead of quantum of 110 with RES +of 1000, a quantum of 11 with a RES of 100 results. The fractional unit is +different while the amount of time is the same. +.sp +.LP +You can use the \fB-s\fR option to change the time quantum value. Note that +such changes are not preserved across reboot. Please refer to the +\fBdispadmin\fR(1M) man page for additional information. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +lw(2.75i) lw(2.75i) +lw(2.75i) lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +ArchitectureSUNWcsu +.TE + +.SH SEE ALSO +.sp +.LP +\fBprctl\fR(1), \fBpriocntl\fR(1), \fBdispadmin\fR(1M), \fBpsrset\fR(1M), +\fBpriocntl\fR(2), \fBproject\fR(4), \fBattributes\fR(5), +\fBresource_controls\fR(5) +.sp +.LP +\fISystem Administration Guide: Virtualization Using the Solaris Operating +System\fR diff --git a/usr/src/man/man7/Intro.7 b/usr/src/man/man7/Intro.7 new file mode 100644 index 0000000000..631e86ca1d --- /dev/null +++ b/usr/src/man/man7/Intro.7 @@ -0,0 +1,183 @@ +'\" te +.\" Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved. +.\" Copyright 1989 AT&T +.\" 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 Intro 7 "29 Sep 1994" "SunOS 5.11" "Device and Network Interfaces" +.SH NAME +Intro, intro \- introduction to special files +.SH DESCRIPTION +.sp +.LP +This section describes various device and network interfaces available on the +system. The types of interfaces described include character and block +devices, STREAMS modules, network protocols, file systems, and ioctl requests +for driver subsystems and classes. +.sp +.LP +This section contains the following major collections: +.sp +.ne 2 +.mk +.na +\fB(7D)\fR +.ad +.RS 9n +.rt +The system provides drivers for a variety of hardware devices, such as disk, +magnetic tapes, serial communication lines, mice, and frame buffers, as well +as virtual devices such as pseudo-terminals and windows. +.sp +This section describes special files that refer to specific hardware +peripherals and device drivers. STREAMS device drivers are also described. +Characteristics of both the hardware device and the corresponding device driver +are discussed where applicable. +.sp +An application accesses a device through that device's special file. This +section specifies the device special file to be used to access the device as +well as application programming interface (API) information relevant to the use +of the device driver. +.sp +All device special files are located under the \fB/devices\fR directory. The +\fB/devices\fR directory hierarchy attempts to mirror the hierarchy of system +busses, controllers, and devices configured on the system. Logical device +names for special files in \fB/devices\fR are located under the \fB/dev\fR +directory. Although not every special file under \fB/devices\fR will have a +corresponding logical entry under \fB/dev\fR, whenever possible, an +application should reference a device using the logical name for the device. +Logical device names are listed in the \fBFILES\fR section of the page for the +device in question. +.sp +This section also describes driver configuration where applicable. Many device +drivers have a driver configuration file of the form +\fIdriver_name\fR\fB\&.conf\fR associated with them (see +\fBdriver.conf\fR(4)). The configuration information stored in the driver +configuration file is used to configure the driver and the device. Driver +configuration files are located in \fB/kernel/drv\fR and +\fB/usr/kernel/drv\fR. Driver configuration files for platform dependent +drivers are located in \fB/platform/`uname\fR \fB-i`/kernel/drv\fR where +\fB`uname\fR \fB-i`\fR is the output of the \fBuname\fR(1) command with the +\fB-i\fR option. +.sp +Some driver configuration files may contain user configurable properties. +Changes in a driver's configuration file will not take effect until the system +is rebooted or the driver has been removed and re-added (see \fBrem_drv\fR(1M) +and \fBadd_drv\fR(1M)). +.RE + +.sp +.ne 2 +.mk +.na +\fB(7FS)\fR +.ad +.RS 9n +.rt +This section describes the programmatic interface for several file systems +supported by SunOS. +.RE + +.sp +.ne 2 +.mk +.na +\fB(7I)\fR +.ad +.RS 9n +.rt +This section describes ioctl requests which apply to a class of drivers or +subsystems. For example, ioctl requests which apply to most tape devices are +discussed in \fBmtio\fR(7I). Ioctl requests relevant to only a specific +device are described on the man page for that device. The page for the device +in question should still be examined for exceptions to the ioctls listed in +section 7I. +.RE + +.sp +.ne 2 +.mk +.na +\fB(7M)\fR +.ad +.RS 9n +.rt +This section describes \fBSTREAMS\fR modules. Note that \fBSTREAMS\fR +drivers are discussed in section 7D. \fBstreamio\fR(7I) contains a list of +ioctl requests used to manipulate \fBSTREAMS\fR modules and interface with the +\fBSTREAMS\fR framework. Ioctl requests specific to a \fBSTREAMS\fR module +will be discussed on the man page for that module. +.RE + +.sp +.ne 2 +.mk +.na +\fB(7P)\fR +.ad +.RS 9n +.rt +This section describes various network protocols available in SunOS. +.sp +SunOS supports both socket-based and \fBSTREAMS-based\fR network +communications. The Internet protocol family, described in \fBinet\fR(7P), is +the primary protocol family supported by SunOS, although the system can support +a number of others. The raw interface provides low-level services, such as +packet fragmentation and reassembly, routing, addressing, and basic transport +for socket-based implementations. Facilities for communicating using an +Internet-family protocol are generally accessed by specifying the \fBAF_INET\fR +address family when binding a socket; see \fBsocket\fR(3SOCKET) for details. +.sp +Major protocols in the Internet family include: +.RS +4 +.TP +.ie t \(bu +.el o +The Internet Protocol (IP) itself, which supports the universal datagram +format, as described in \fBip\fR(7P). This is the default protocol for +\fBSOCK_RAW\fR type sockets within the \fBAF_INET\fR domain. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +The Transmission Control Protocol (TCP); see \fBtcp\fR(7P). This is the default +protocol for \fBSOCK_STREAM\fR type sockets. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +The User Datagram Protocol (UDP); see \fBudp\fR(7P). This is the default +protocol for \fBSOCK_DGRAM\fR type sockets. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +The Address Resolution Protocol (ARP); see \fBarp\fR(7P). +.RE +.RS +4 +.TP +.ie t \(bu +.el o +The Internet Control Message Protocol (ICMP); see \fBicmp\fR(7P). +.RE +.RE + +.SH SEE ALSO +.sp +.LP +\fBadd_drv\fR(1M), \fBrem_drv\fR(1M), \fBIntro\fR(3), \fBioctl\fR(2), +\fBsocket\fR(3SOCKET), \fBdriver.conf\fR(4), \fBarp\fR(7P), \fBicmp\fR(7P), +\fBinet\fR(7P), \fBip\fR(7P), \fBmtio\fR(7I), \fBst\fR(7D), \fBstreamio\fR(7I), +\fBtcp\fR(7P), \fBudp\fR(7P) +.sp +.LP +\fISystem Administration Guide: IP Services\fR +.sp +.LP +\fISTREAMS Programming Guide\fR +.sp +.LP +\fIWriting Device Drivers\fR diff --git a/usr/src/man/man7/Makefile b/usr/src/man/man7/Makefile new file mode 100644 index 0000000000..8714a9c95e --- /dev/null +++ b/usr/src/man/man7/Makefile @@ -0,0 +1,34 @@ +# +# 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 2011, Richard Lowe + +include ../../Makefile.master + +MANSECT = 7 + +MANSOFILES = intro.7 + +MANFILES = FSS.7 \ + Intro.7 \ + cpr.7 \ + ibmf.7 \ + $(MANSOFILES) + +intro.7 := SOSRC = man7/Intro.7 + +.KEEP_STATE: + +include ../Makefile.man + +install: $(ROOTMANFILES) + + diff --git a/usr/src/man/man7/cpr.7 b/usr/src/man/man7/cpr.7 new file mode 100644 index 0000000000..ad1285fa03 --- /dev/null +++ b/usr/src/man/man7/cpr.7 @@ -0,0 +1,108 @@ +'\" te +.\" Copyright (c) 2001, 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 cpr 7 "7 May 2001" "SunOS 5.11" "Device and Network Interfaces" +.SH NAME +cpr \- Suspend and resume module +.SH SYNOPSIS +.LP +.nf +\fB/platform/'uname -m'/kernel/misc/cpr\fR +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBcpr\fR module is a loadable module used to suspend and resume the entire +system. You may wish to suspend a system to save power or to power off +temporarily for transport. The \fBcpr\fR module should not be used in place of +a normal shutdown when performing any hardware reconfiguration or replacement. +In order for the resume operation to succeed, it is important that the hardware +configuration remain the same. When the system is suspended, the entire system +state is preserved in non-volatile storage until a resume operation is +conducted. +.sp +.LP +\fBdtpower\fR(1M) or \fBpower.conf\fR(4) are used to configure the +suspend-resume feature. +.sp +.LP +The speed of suspend and resume operations can range from 15 seconds to +several minutes, depending on the system speed, memory size, and load. +.sp +.LP +During resume operation, the \fBSIGTHAW\fR signal is sent to all processes to +allow them to do any special processing in response to suspend-resume +operation. Normally applications are not required to do any special processing +because of suspend-resume, but some specialized processes can use +\fBSIGTHAW\fR to restore the state prior to suspend. For example, \fBX\fR can +refresh the screen in response to \fBSIGTHAW\fR. +.sp +.LP +In some cases the \fBcpr\fR module may be unable to perform the suspend +operation. If a system contains additional devices outside the standard shipped +configuration, it is possible that device drivers for these additional devices +might not support suspend-resume operations. In this case, the suspend fails +and an error message is displayed. These devices must be removed or their +device drivers unloaded for the suspend operation to succeed. Contact the +device manufacturer to obtain a new version of device driver that supports +suspend-resume. +.sp +.LP +A suspend may also fail when devices or processes are performing critical or +time-sensitive operations (such as realtime operations). The system will remain +in its current running state. Messages reporting the failure will be displayed +on the console and status returned to the caller. Once the system is +successfully suspended the resume operation will succeed, barring external +influences such as a hardware reconfiguration. +.sp +.LP +Some network-based applications may fail across a suspend and resume cycle. +This largely depends on the underlying network protocol and the applications +involved. In general, applications that retry and automatically reestablish +connections will continue to operate transparently on a resume operation; +those applications that do not will likely fail. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface stability Unstable +.TE + +.SH SEE ALSO +.sp +.LP +\fBdtpower\fR(1M) (OpenWindows Reference Manual), \fBpmconfig\fR(1M), +\fBuadmin\fR(1M), \fBuadmin\fR(2), \fBpower.conf\fR(4), \fBattributes\fR(5) +.sp +.LP +\fIUsing Power Management\fR +.sp +.LP +\fIWriting Device Drivers\fR +.SH NOTES +.sp +.LP +Certain device operations such as tape and floppy disk activities are not +resumable due to the nature of removable media. These activities are detected +at suspend time, and must be stopped before the suspend operation will +complete successfully. +.sp +.LP +Suspend-resume is currently supported only on a limited set of hardware +platforms. Please see the book \fIUsing Power Management\fR for a complete +list of platforms that support system Power Management. See \fBuname\fR(2) to +programatically determine if the machine supports suspend-resume. diff --git a/usr/src/man/man7/ibmf.7 b/usr/src/man/man7/ibmf.7 new file mode 100644 index 0000000000..8f85fb425e --- /dev/null +++ b/usr/src/man/man7/ibmf.7 @@ -0,0 +1,78 @@ +'\" 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 ibmf 7 "9 Sep 2004" "SunOS 5.11" "Device and Network Interfaces" +.SH NAME +ibmf \- InfiniBand Management Transport Framework +.SH DESCRIPTION +.sp +.LP +The InfiniBand (IB) Management Transport Framework provides the mechanisms for +IB management modules to communicate with other InfiniBand management modules +such as the Subnet Administration process. It also provides helper functions +such as Subnet Administration Access (SAA) for commonly performed operations. +.SH FILES +.sp +.ne 2 +.mk +.na +\fB/kernel/misc/ibmf\fR +.ad +.RS 29n +.rt +32-bit ELF kernel misc module (x86 platform only). +.RE + +.sp +.ne 2 +.mk +.na +\fB/kernel/misc/amd64/ibmf\fR +.ad +.RS 29n +.rt +64-bit ELF kernel misc module (x86 platform only). +.RE + +.sp +.ne 2 +.mk +.na +\fB/kernel/misc/sparcv9/ibmf\fR +.ad +.RS 29n +.rt +64-bit ELF kernel misc module (SPARC platform only). +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +ArchitecturePCI-based systems +_ +Interface stabilityConsolidation Private +.TE + +.SH SEE ALSO +.sp +.LP +\fBibtl\fR(7D) +.sp +.LP +\fIInfiniBand Architecture Specification, Version 1.1\fR +.sp +.LP +\fIwww.infinibandta.org\fR |