man-pages/man2/s390_runtime_instr.2

92 lines
2.7 KiB
Groff
Raw Normal View History

.\" Copyright IBM Corp. 2012
.\" Author: Jan Glauber <jang@linux.vnet.ibm.com>
.\" Copyright (c) 2012, IBM Corp.
.\"
.\" 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/>.
.TH S390_RUNTIME_INSTR 2 2012-12-17 "Linux Programmer's Manual"
.SH NAME
s390_runtime_instr \- enable/disable s390 CPU runtime instrumentation
.SH SYNOPSIS
.nf
.B #include <asm/runtime_instr.h>
.BI "int s390_runtime_instr(int " command ", int " signum ");
.fi
.SH DESCRIPTION
The
.BR s390_runtime_instr ()
system call starts or stops CPU runtime instrumentation for the current thread.
The
.IR command
argument controls whether runtime instrumentation is started
( 1 ) or stopped ( 2 ) for the current thread.
The
.IR signum
argument specifies the number of a real-time signal.
The real-time signal is sent to the thread if the runtime instrumentation
buffer is full or if the runtime-instrumentation-halted interrupt
occurred.
.SH RETURN VALUE
On success
.BR s390_runtime_instr ()
returns 0 and enables the thread for
runtime instrumentation by assigning the thread a default runtime
instrumentation control block.
The caller can then read and modify the control block and start the runtime
instrumentation.
On error, -1 is returned and
.IR errno
is set to one of the error codes listed below.
.SH ERRORS
.TP
.B EOPNOTSUPP
The runtime instrumentation facility is not available.
.TP
.B EINVAL
The value specified in
.IR command
is not a valid command or the value specified in
.IR signum
is not a real-time signal number.
.TP
.B ENOMEM
Allocating memory for the runtime instrumentation control block failed.
.SH VERSIONS
This system call is available since Linux 3.7.
.SH CONFORMING TO
This Linux-specific system call is only available on the s390 architecture.
The runtime instrumentation facility is available beginning with System z EC12.
.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),
.BR signal (7)