diff options
Diffstat (limited to 'usr/src/man/man7d')
| -rw-r--r-- | usr/src/man/man7d/Makefile | 6 | ||||
| -rw-r--r-- | usr/src/man/man7d/cpuid.7d | 5 | ||||
| -rw-r--r-- | usr/src/man/man7d/imc.7d | 103 | ||||
| -rw-r--r-- | usr/src/man/man7d/imcstub.7d | 46 | ||||
| -rw-r--r-- | usr/src/man/man7d/vnd.7d | 118 | ||||
| -rw-r--r-- | usr/src/man/man7d/zfd.7d | 81 |
6 files changed, 358 insertions, 1 deletions
diff --git a/usr/src/man/man7d/Makefile b/usr/src/man/man7d/Makefile index 612461a7e8..c652a3134f 100644 --- a/usr/src/man/man7d/Makefile +++ b/usr/src/man/man7d/Makefile @@ -142,11 +142,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 \ @@ -205,6 +207,8 @@ i386_MANFILES= ahci.7d \ ecpp.7d \ elxl.7d \ i40e.7d \ + imc.7d \ + imcstub.7d \ ipmi.7d \ iprb.7d \ ipw.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/imc.7d b/usr/src/man/man7d/imc.7d new file mode 100644 index 0000000000..9389afd0f1 --- /dev/null +++ b/usr/src/man/man7d/imc.7d @@ -0,0 +1,103 @@ +.\" +.\" 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 2019 Joyent, Inc. +.\" +.Dd June 25, 2019 +.Dt IMC 7D +.Os +.Sh NAME +.Nm imc +.Nd Intel memory controller driver +.Sh SYNOPSIS +.Pa /dev/mc/mc* +.Sh DESCRIPTION +The +.Nm +driver interfaces with the memory controller found on certain +generations of Intel CPUs and provides a means for decoding physical +addresses to the corresponding memory device. +The +.Nm +driver plugs into the operating systems fault management framework +providing additional details to the system about the memory topology and +the ability to decode physical addresses into the corresponding portion +of the memory hierarchy. +.Pp +The +.Nm +driver is supported on the following Intel processors: +.Bl -bullet -offset indent -width Sy +.It +Sandy Bridge E5 and E7 Xeon Processors +.It +Ivy Bridge E5 and E7 Xeon Processors +.It +Haswell E5 and E7 Xeon Processors +.It +Broadwell E5 and E7 Xeon Processors +.It +Skylake Xeon Scalable Processors +.It +Cascade Lake Xeon Scalable Processors +.It +Broadwell and Skylake Xeon-D processors +.El +.Pp +Other lines involving the above microarchitectures, such as Xeon E3 +branded processors, are not supported as they do not provide the +necessary hardware support. +.Pp +The +.Nm +driver is a pseudo-device driver that amalgamates all of the different +.Xr imcstub 7D +instances into a coherent view. +The +.Xr imcstub 7D +driver attaches to all of the different PCI devices that the processor +exposes. +.Pp +One challenge with the +.Nm +driver is the Intel Enhanced Machine Check Architecture v2 +.Pq EMCAv2 . +Many vendors use EMCAv2 to hide memory errors from the operating system. +Such systems limit the effectiveness of the +.Nm +driver and the fault management architecture by hiding correctable and +uncorrectable DIMM errors from the operating system. +.Pp +The +.Nm +driver has a few limitations. +Currently it does not always properly handle lockstep and mirroring +mode, particularly in variants that are common on Skylake and newer +systems. +It also does not properly handle cases where Intel Optane NVDIMMs are in +use on the memory bus. +.Sh ARCHITECTURE +The +.Nm +driver is only supported on specific Intel +.Sy x86 +systems. +.Sh FILES +.Bl -tag -width Pa +.It Pa /platform/i86pc/kernel/drv/amd64/imc +64-bit device driver (x86). +.It Pa /platform/i86pc/kernel/drv/imc.conf +Driver configuration file. +.El +.Sh SEE ALSO +.Xr fmadm 1M , +.Xr fmdump 1M , +.Xr imcstub 7D diff --git a/usr/src/man/man7d/imcstub.7d b/usr/src/man/man7d/imcstub.7d new file mode 100644 index 0000000000..d4f69c3b7a --- /dev/null +++ b/usr/src/man/man7d/imcstub.7d @@ -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 2019 Joyent, Inc. +.\" +.Dd June 25, 2019 +.Dt IMCSTUB 7D +.Os +.Sh NAME +.Nm imcstub +.Nd Intel memory controller stub driver +.Sh DESCRIPTION +The +.Nm +driver is a counterpart to the +.Xr imc 7D +driver. +The +.Nm +driver is responsible for attaching to all of the logical PCI devices +that are exposed by Intel CPUs and providing them for use by the +.Xr imc 7D +driver. +For more information on how this is used by the system, please see +.Xr imc 7D . +.Sh ARCHITECTURE +The +.Nm +driver is only supported on certain Intel +.Sy x86 +systems. +.Sh FILES +.Bl -tag -width Pa +.It Pa /platform/i86pc/kernel/drv/amd64/imcstub +64-bit device driver (x86). +.El +.Sh SEE ALSO +.Xr imc 7D 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..cbdc869819 --- /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. +.Sh SEE ALSO +.Xr zlogin 1 , +.Xr zoneadmd 1M , +.Xr zonecfg 1M , +.Xr zcons 7D |