mirror of https://github.com/mkerrisk/man-pages
s390_sthyi.2: New page for s390-specific s390_sthyi(2)
Signed-off-by: QingFeng Hao <haoqf@linux.vnet.ibm.com> Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
parent
46010ab917
commit
c336d6e0fb
|
@ -0,0 +1,118 @@
|
|||
.\" Copyright IBM Corp. 2017
|
||||
.\" Author: QingFeng Hao <haoqf@linux.vnet.ibm.com>
|
||||
.\"
|
||||
.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
|
||||
.\" This is free documentation; you can redistribute it and/or
|
||||
.\" modify it under the terms of the GNU General Public License as
|
||||
.\" published by the Free Software Foundation; either version 2 of
|
||||
.\" the License, or (at your option) any later version.
|
||||
.\"
|
||||
.\" The GNU General Public License's references to "object code"
|
||||
.\" and "executables" are to be interpreted as the output of any
|
||||
.\" document formatting or typesetting system, including
|
||||
.\" intermediate and printed output.
|
||||
.\"
|
||||
.\" This manual is distributed in the hope that it will be useful,
|
||||
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
.\" GNU General Public License for more details.
|
||||
.\"
|
||||
.\" You should have received a copy of the GNU General Public
|
||||
.\" License along with this manual; if not, see
|
||||
.\" <http://www.gnu.org/licenses/>.
|
||||
.\" %%%LICENSE_END
|
||||
.\"
|
||||
.TH S390_STHYI 2 2017-09-21 "Linux Programmer's Manual"
|
||||
.SH NAME
|
||||
s390_sthyi \- emulate STHYI instruction
|
||||
.SH SYNOPSIS
|
||||
.nf
|
||||
.B #include <asm/unistd.h>
|
||||
.PP
|
||||
.BI "int s390_sthyi(unsigned long " function_code ", void *" buffer ",
|
||||
.BI " uint64_t *" return_code ", unsigned long " flags ");
|
||||
.fi
|
||||
.SH DESCRIPTION
|
||||
The
|
||||
.BR s390_sthyi ()
|
||||
system call emulates the STHYI (Store Hypervisor Information) instruction.
|
||||
It provides hardware resource information for the machine and its virtualization
|
||||
levels. This includes CPU type and capacity, as well as the machine model and
|
||||
other metrics.
|
||||
.PP
|
||||
The
|
||||
.I function_code
|
||||
argument indicates which function to perform.
|
||||
The following code(s) are supported:
|
||||
.RB ( 0 )
|
||||
Return CP (Central Processor) and IFL (Integrated Facility for Linux)
|
||||
capacity information.
|
||||
.PP
|
||||
The
|
||||
.I buffer
|
||||
argument specifies the address of response buffer. If the system
|
||||
call returns 0, the response buffer will be filled with CPU capacity
|
||||
information. Otherwise, the response buffer's content is unchanged.
|
||||
.PP
|
||||
The
|
||||
.I return_code
|
||||
argument stores the return code of the STHYI instruction, success
|
||||
.RB ( 0 )
|
||||
or unsupported function code
|
||||
.RB ( 4 ).
|
||||
For details about return code, function_code, and buffer argument,
|
||||
please see section
|
||||
.IR "CONFORMING TO"
|
||||
below.
|
||||
.PP
|
||||
The
|
||||
.I flags
|
||||
argument is provided to allow for future extensions and currently
|
||||
must be set to "0".
|
||||
.SH RETURN VALUE
|
||||
On success, the return value of
|
||||
.BR s390_sthyi ()
|
||||
matches the condition code of the STHYI instructions, which is a value
|
||||
between 0-3 (that is: emulation succeeded).
|
||||
Return value of 0 indicates that CPU capacity information is stored to
|
||||
.I buffer.
|
||||
Return value of 3 indicates "unsupported function code" and buffer's
|
||||
content is unchanged.
|
||||
Return value of 1 and 2 are reserved.
|
||||
.PP
|
||||
On error, -1 is returned, and
|
||||
.IR errno
|
||||
is set appropriately.
|
||||
.SH ERRORS
|
||||
.TP
|
||||
.B EINVAL
|
||||
The value specified in
|
||||
.I flags
|
||||
is non-zero.
|
||||
.TP
|
||||
.B EOPNOTSUPP
|
||||
The value specified in
|
||||
.I function_code
|
||||
is not a valid value.
|
||||
.TP
|
||||
.B EFAULT
|
||||
The value specified in
|
||||
.I buffer
|
||||
or
|
||||
.I return_code
|
||||
is not a valid address.
|
||||
.TP
|
||||
.B ENOMEM
|
||||
Allocating memory for handling the CPU capacity information failed.
|
||||
.SH VERSIONS
|
||||
This system call is available since Linux 4.15.
|
||||
.SH CONFORMING TO
|
||||
This Linux-specific system call is available only on the s390 architecture.
|
||||
For details about the STHYI instruction, see
|
||||
https://www.ibm.com/support/knowledgecenter/SSB27U_6.3.0/com.ibm.zvm.v630.hcpb4/hcpb4sth.htm
|
||||
.SH NOTES
|
||||
Glibc does not provide a wrapper for this system call, use
|
||||
.BR syscall (2)
|
||||
to call it.
|
||||
.SH SEE ALSO
|
||||
.BR syscall (2)
|
Loading…
Reference in New Issue