git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	1	.\" Copyright (c) 1990, 1991, 1993
	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\" 4. Neither the name of the University nor the names of its contributors
	13	.\" may be used to endorse or promote products derived from this software
	14	.\" without specific prior written permission.
	15	.\"
	16	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	17	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	18	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	19	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	20	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	21	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	22	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	23	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	24	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	25	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	26	.\" SUCH DAMAGE.
	27	.\"
	28	.\" @(#)times.3 8.1 (Berkeley) 6/4/93
	29	.\" $FreeBSD$
	30	.\"
	31	.Dd December 1, 2008
	32	.Dt TIMES 3
	33	.Os
	34	.Sh NAME
	35	.Nm times
	36	.Nd process times
	37	.Sh LIBRARY
	38	.Lb libc
	39	.Sh SYNOPSIS
	40	.In sys/times.h
	41	.Ft clock_t
	42	.Fn times "struct tms *tp"
	43	.Sh DESCRIPTION
	44	.Bf -symbolic
	45	This interface is obsoleted by
	46	.Xr getrusage 2
	47	and
	48	.Xr gettimeofday 2 .
	49	.Ef
	50	.Pp
	51	The
	52	.Fn times
	53	function returns the value of time in
	54	.Dv CLK_TCK Ns 's
	55	of a second since
	56	0 hours, 0 minutes, 0 seconds, January 1, 1970, Coordinated Universal
	57	Time.
	58	.Pp
	59	It also fills in the structure pointed to by
	60	.Fa tp
	61	with time-accounting information.
	62	.Pp
	63	The
	64	.Vt tms
	65	structure is defined as follows:
	66	.Bd -literal -offset indent
	67	struct tms {
	68	clock_t tms_utime;
	69	clock_t tms_stime;
	70	clock_t tms_cutime;
	71	clock_t tms_cstime;
	72	};
	73	.Ed
	74	.Pp
	75	The elements of this structure are defined as follows:
	76	.Bl -tag -width ".Va tms_cutime"
	77	.It Va tms_utime
	78	The
	79	.Tn CPU
	80	time charged for the execution of user instructions.
	81	.It Va tms_stime
	82	The
	83	.Tn CPU
	84	time charged for execution by the system on behalf of
	85	the process.
	86	.It Va tms_cutime
	87	The sum of the
	88	.Va tms_utime Ns s
	89	and
	90	.Va tms_cutime Ns s
	91	of the child processes.
	92	.It Va tms_cstime
	93	The sum of the
	94	.Fa tms_stime Ns s
	95	and
	96	.Fa tms_cstime Ns s
	97	of the child processes.
	98	.El
	99	.Pp
	100	All times are in
	101	.Dv CLK_TCK Ns 's
	102	of a second.
	103	.Pp
	104	The times of a terminated child process are included in the
	105	.Va tms_cutime
	106	and
	107	.Va tms_cstime
	108	elements of the parent when one of the
	109	.Xr wait 2
	110	functions returns the process ID of the terminated child to the parent.
	111	If an error occurs,
	112	.Fn times
	113	returns the value
	114	.Pq Po Vt clock_t Pc Ns \-1 ,
	115	and sets
	116	.Va errno
	117	to indicate the error.
	118	.Sh ERRORS
	119	The
	120	.Fn times
	121	function
	122	may fail and set the global variable
	123	.Va errno
	124	for any of the errors specified for the library
	125	routines
	126	.Xr getrusage 2
	127	and
	128	.Xr gettimeofday 2 .
	129	.Sh SEE ALSO
	130	.Xr time 1 ,
	131	.Xr getrusage 2 ,
	132	.Xr gettimeofday 2 ,
	133	.Xr wait 2
	134	.Sh STANDARDS
	135	The
	136	.Fn times
	137	function
	138	conforms to
	139	.St -p1003.1-88 .