Index: stable/12/lib/libc/sys/clock_gettime.2 =================================================================== --- stable/12/lib/libc/sys/clock_gettime.2 (revision 357877) +++ stable/12/lib/libc/sys/clock_gettime.2 (revision 357878) @@ -1,176 +1,184 @@ .\" $OpenBSD: clock_gettime.2,v 1.4 1997/05/08 20:21:16 kstailey Exp $ .\" .\" Copyright (c) 1980, 1991, 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. .\" 3. 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. .\" .\" $FreeBSD$ .\" -.Dd March 20, 2017 +.Dd December 7, 2019 .Dt CLOCK_GETTIME 2 .Os .Sh NAME .Nm clock_gettime , .Nm clock_settime , .Nm clock_getres .Nd get/set/calibrate date and time .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In time.h .Ft int .Fn clock_gettime "clockid_t clock_id" "struct timespec *tp" .Ft int .Fn clock_settime "clockid_t clock_id" "const struct timespec *tp" .Ft int .Fn clock_getres "clockid_t clock_id" "struct timespec *tp" .Sh DESCRIPTION The .Fn clock_gettime and .Fn clock_settime system calls allow the calling process to retrieve or set the value used by a clock which is specified by .Fa clock_id . .Pp The .Fa clock_id argument can be a value obtained from .Xr clock_getcpuclockid 3 or .Xr pthread_getcpuclockid 3 as well as the following values: .Pp .Bl -tag -width indent -compact .It Dv CLOCK_REALTIME .It Dv CLOCK_REALTIME_PRECISE .It Dv CLOCK_REALTIME_FAST Increments as a wall clock should. .It Dv CLOCK_MONOTONIC .It Dv CLOCK_MONOTONIC_PRECISE .It Dv CLOCK_MONOTONIC_FAST Increments in SI seconds. .It Dv CLOCK_UPTIME .It Dv CLOCK_UPTIME_PRECISE .It Dv CLOCK_UPTIME_FAST Starts at zero when the kernel boots and increments monotonically in SI seconds while the machine is running. .It Dv CLOCK_VIRTUAL Increments only when the CPU is running in user mode on behalf of the calling process. .It Dv CLOCK_PROF Increments when the CPU is running in user or kernel mode. .It Dv CLOCK_SECOND Returns the current second without performing a full time counter query, using an in-kernel cached value of the current second. .It Dv CLOCK_PROCESS_CPUTIME_ID Returns the execution time of the calling process. .It Dv CLOCK_THREAD_CPUTIME_ID Returns the execution time of the calling thread. .El .Pp The clock IDs .Fa CLOCK_REALTIME_FAST , .Fa CLOCK_MONOTONIC_FAST , .Fa CLOCK_UPTIME_FAST are analogs of corresponding IDs without _FAST suffix but do not perform a full time counter query, so their accuracy is one timer tick. Similarly, .Fa CLOCK_REALTIME_PRECISE , .Fa CLOCK_MONOTONIC_PRECISE , .Fa CLOCK_UPTIME_PRECISE are used to get the most exact value as possible, at the expense of execution time. .Pp The structure pointed to by .Fa tp is defined in .In sys/timespec.h as: .Bd -literal struct timespec { time_t tv_sec; /* seconds */ long tv_nsec; /* and nanoseconds */ }; .Ed .Pp Only the super-user may set the time of day, using only .Fa CLOCK_REALTIME . If the system securelevel is greater than 1 (see .Xr init 8 ) , the time may only be advanced. This limitation is imposed to prevent a malicious super-user from setting arbitrary time stamps on files. The system time can still be adjusted backwards using the .Xr adjtime 2 system call even when the system is secure. .Pp The resolution (granularity) of a clock is returned by the .Fn clock_getres system call. This value is placed in a (non-NULL) .Fa *tp . .Sh RETURN VALUES .Rv -std .Sh ERRORS The following error codes may be set in .Va errno : .Bl -tag -width Er .It Bq Er EINVAL The .Fa clock_id or .Fa timespec argument was not a valid value. .It Bq Er EPERM A user other than the super-user attempted to set the time. .El .Sh SEE ALSO .Xr date 1 , .Xr adjtime 2 , .Xr clock_getcpuclockid 3 , .Xr ctime 3 , .Xr pthread_getcpuclockid 3 , .Xr timed 8 .Sh STANDARDS The .Fn clock_gettime , .Fn clock_settime , and .Fn clock_getres system calls conform to .St -p1003.1b-93 . The clock IDs .Fa CLOCK_REALTIME_FAST , .Fa CLOCK_REALTIME_PRECISE , .Fa CLOCK_MONOTONIC_FAST , .Fa CLOCK_MONOTONIC_PRECISE , .Fa CLOCK_UPTIME , .Fa CLOCK_UPTIME_FAST , .Fa CLOCK_UPTIME_PRECISE , .Fa CLOCK_SECOND are FreeBSD extensions to the POSIX interface. +.Sh HISTORY +The +.Fn clock_gettime , +.Fn clock_settime , +and +.Fn clock_getres +system calls first appeared in +.Fx 3.0 . Index: stable/12/lib/libc/sys/lio_listio.2 =================================================================== --- stable/12/lib/libc/sys/lio_listio.2 (revision 357877) +++ stable/12/lib/libc/sys/lio_listio.2 (revision 357878) @@ -1,218 +1,223 @@ .\" Copyright (c) 2003 Tim J. Robbins .\" 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. .\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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. .\" .\" $FreeBSD$ .\" -.Dd Oct 23, 2017 +.Dd Dec 7, 2019 .Dt LIO_LISTIO 2 .Os .Sh NAME .Nm lio_listio .Nd "list directed I/O (REALTIME)" .Sh LIBRARY .Lb libc .Sh SYNOPSIS .In aio.h .Ft int .Fo lio_listio .Fa "int mode" .Fa "struct aiocb * const list[]" .Fa "int nent" .Fa "struct sigevent *sig" .Fc .Sh DESCRIPTION The .Fn lio_listio function initiates a list of I/O requests with a single function call. The .Fa list argument is an array of pointers to .Vt aiocb structures describing each operation to perform, with .Fa nent elements. .Dv NULL elements are ignored. .Pp The .Va aio_lio_opcode field of each .Vt aiocb specifies the operation to be performed. The following operations are supported: .Bl -tag -width ".Dv LIO_WRITE" .It Dv LIO_READ Read data as if by a call to .Xr aio_read 2 . .It Dv LIO_NOP No operation. .It Dv LIO_WRITE Write data as if by a call to .Xr aio_write 2 . .El .Pp If the .Fa mode argument is .Dv LIO_WAIT , .Fn lio_listio does not return until all the requested operations have been completed. If .Fa mode is .Dv LIO_NOWAIT , .Fa sig can be used to request asynchronous notification when all operations have completed. If .Fa sig is .Dv NULL , no notification is sent. .Pp For .Dv SIGEV_KEVENT notifications, the posted kevent will contain: .Bl -column ".Va filter" .It Sy Member Ta Sy Value .It Va ident Ta Fa list .It Va filter Ta Dv EVFILT_LIO .It Va udata Ta value stored in .Fa sig->sigev_value .El .Pp For .Dv SIGEV_SIGNO and .Dv SIGEV_THREAD_ID notifications, the information for the queued signal will include .Dv SI_ASYNCIO in the .Va si_code field and the value stored in .Fa sig->sigev_value in the .Va si_value field. .Pp For .Dv SIGEV_THREAD notifications, the value stored in .Fa sig->sigev_value is passed to the .Fa sig->sigev_notify_function as described in .Xr sigevent 3 . .Pp The order in which the requests are carried out is not specified; in particular, there is no guarantee that they will be executed in the order 0, 1, ..., .Fa nent Ns \-1 . .Sh RETURN VALUES If .Fa mode is .Dv LIO_WAIT , the .Fn lio_listio function returns 0 if the operations completed successfully, otherwise \-1. .Pp If .Fa mode is .Dv LIO_NOWAIT , the .Fn lio_listio function returns 0 if the operations are successfully queued, otherwise \-1. .Sh ERRORS The .Fn lio_listio function will fail if: .Bl -tag -width Er .It Bq Er EAGAIN There are not enough resources to enqueue the requests. .It Bq Er EAGAIN The request would cause the system-wide limit .Dv {AIO_MAX} to be exceeded. .It Bq Er EINVAL The .Fa mode argument is neither .Dv LIO_WAIT nor .Dv LIO_NOWAIT , or .Fa nent is greater than .Dv {AIO_LISTIO_MAX} . .It Bq Er EINVAL The asynchronous notification method in .Fa sig->sigev_notify is invalid or not supported. .It Bq Er EINTR A signal interrupted the system call before it could be completed. .It Bq Er EIO One or more requests failed. .El .Pp In addition, the .Fn lio_listio function may fail for any of the reasons listed for .Xr aio_read 2 and .Xr aio_write 2 . .Pp If .Fn lio_listio succeeds, or fails with an error code of .Er EAGAIN , EINTR , or .Er EIO , some of the requests may have been initiated. The caller should check the error status of each .Vt aiocb structure individually by calling .Xr aio_error 2 . .Sh SEE ALSO .Xr aio_error 2 , .Xr aio_read 2 , .Xr aio_write 2 , .Xr read 2 , .Xr write 2 , .Xr sigevent 3 , .Xr siginfo 3 , .Xr aio 4 .Sh STANDARDS The .Fn lio_listio function is expected to conform to .St -p1003.1-2001 . +.Sh HISTORY +The +.Fn lio_listio +system call first appeared in +.Fx 3.0 . Index: stable/12 =================================================================== --- stable/12 (revision 357877) +++ stable/12 (revision 357878) Property changes on: stable/12 ___________________________________________________________________ Modified: svn:mergeinfo ## -0,0 +0,1 ## Merged /head:r355488-355489