Update.
[kopensolaris-gnu/glibc.git] / manual / time.texi
1 @node Date and Time, Non-Local Exits, Arithmetic, Top
2 @chapter Date and Time
3
4 This chapter describes functions for manipulating dates and times,
5 including functions for determining what the current time is and
6 conversion between different time representations.
7
8 The time functions fall into three main categories:
9
10 @itemize @bullet
11 @item
12 Functions for measuring elapsed CPU time are discussed in @ref{Processor
13 Time}.
14
15 @item
16 Functions for measuring absolute clock or calendar time are discussed in
17 @ref{Calendar Time}.
18
19 @item
20 Functions for setting alarms and timers are discussed in @ref{Setting
21 an Alarm}.
22 @end itemize
23
24 @menu
25 * Processor Time::              Measures processor time used by a program.
26 * Calendar Time::               Manipulation of ``real'' dates and times.
27 * Setting an Alarm::            Sending a signal after a specified time.
28 * Sleeping::                    Waiting for a period of time.
29 * Resource Usage::              Measuring various resources used.
30 * Limits on Resources::         Specifying limits on resource usage.
31 * Priority::                    Reading or setting process run priority.
32 @end menu
33
34 @node Processor Time
35 @section Processor Time
36
37 If you're trying to optimize your program or measure its efficiency, it's
38 very useful to be able to know how much @dfn{processor time} or @dfn{CPU
39 time} it has used at any given point.  Processor time is different from
40 actual wall clock time because it doesn't include any time spent waiting
41 for I/O or when some other process is running.  Processor time is
42 represented by the data type @code{clock_t}, and is given as a number of
43 @dfn{clock ticks} relative to an arbitrary base time marking the beginning
44 of a single program invocation.
45 @cindex CPU time
46 @cindex processor time
47 @cindex clock ticks
48 @cindex ticks, clock
49 @cindex time, elapsed CPU
50
51 @menu
52 * Basic CPU Time::              The @code{clock} function.
53 * Detailed CPU Time::           The @code{times} function.
54 @end menu
55
56 @node Basic CPU Time
57 @subsection Basic CPU Time Inquiry
58
59 To get the elapsed CPU time used by a process, you can use the
60 @code{clock} function.  This facility is declared in the header file
61 @file{time.h}.
62 @pindex time.h
63
64 In typical usage, you call the @code{clock} function at the beginning and
65 end of the interval you want to time, subtract the values, and then divide
66 by @code{CLOCKS_PER_SEC} (the number of clock ticks per second), like this:
67
68 @smallexample
69 @group
70 #include <time.h>
71
72 clock_t start, end;
73 double elapsed;
74
75 start = clock();
76 @dots{} /* @r{Do the work.} */
77 end = clock();
78 elapsed = ((double) (end - start)) / CLOCKS_PER_SEC;
79 @end group
80 @end smallexample
81
82 Different computers and operating systems vary wildly in how they keep
83 track of processor time.  It's common for the internal processor clock
84 to have a resolution somewhere between hundredths and millionths of a
85 second.
86
87 In the GNU system, @code{clock_t} is equivalent to @code{long int} and
88 @code{CLOCKS_PER_SEC} is an integer value.  But in other systems, both
89 @code{clock_t} and the type of the macro @code{CLOCKS_PER_SEC} can be
90 either integer or floating-point types.  Casting processor time values
91 to @code{double}, as in the example above, makes sure that operations
92 such as arithmetic and printing work properly and consistently no matter
93 what the underlying representation is.
94
95 @comment time.h
96 @comment ISO
97 @deftypevr Macro int CLOCKS_PER_SEC
98 The value of this macro is the number of clock ticks per second measured
99 by the @code{clock} function.
100 @end deftypevr
101
102 @comment time.h
103 @comment POSIX.1
104 @deftypevr Macro int CLK_TCK
105 This is an obsolete name for @code{CLOCKS_PER_SEC}.
106 @end deftypevr
107
108 @comment time.h
109 @comment ISO
110 @deftp {Data Type} clock_t
111 This is the type of the value returned by the @code{clock} function.
112 Values of type @code{clock_t} are in units of clock ticks.
113 @end deftp
114
115 @comment time.h
116 @comment ISO
117 @deftypefun clock_t clock (void)
118 This function returns the elapsed processor time.  The base time is
119 arbitrary but doesn't change within a single process.  If the processor
120 time is not available or cannot be represented, @code{clock} returns the
121 value @code{(clock_t)(-1)}.
122 @end deftypefun
123
124
125 @node Detailed CPU Time
126 @subsection Detailed Elapsed CPU Time Inquiry
127
128 The @code{times} function returns more detailed information about
129 elapsed processor time in a @w{@code{struct tms}} object.  You should
130 include the header file @file{sys/times.h} to use this facility.
131 @pindex sys/times.h
132
133 @comment sys/times.h
134 @comment POSIX.1
135 @deftp {Data Type} {struct tms}
136 The @code{tms} structure is used to return information about process
137 times.  It contains at least the following members:
138
139 @table @code
140 @item clock_t tms_utime
141 This is the CPU time used in executing the instructions of the calling
142 process.
143
144 @item clock_t tms_stime
145 This is the CPU time used by the system on behalf of the calling process.
146
147 @item clock_t tms_cutime
148 This is the sum of the @code{tms_utime} values and the @code{tms_cutime}
149 values of all terminated child processes of the calling process, whose
150 status has been reported to the parent process by @code{wait} or
151 @code{waitpid}; see @ref{Process Completion}.  In other words, it
152 represents the total CPU time used in executing the instructions of all
153 the terminated child processes of the calling process, excluding child
154 processes which have not yet been reported by @code{wait} or
155 @code{waitpid}.
156
157 @item clock_t tms_cstime
158 This is similar to @code{tms_cutime}, but represents the total CPU time
159 used by the system on behalf of all the terminated child processes of the
160 calling process.
161 @end table
162
163 All of the times are given in clock ticks.  These are absolute values; in a
164 newly created process, they are all zero.  @xref{Creating a Process}.
165 @end deftp
166
167 @comment sys/times.h
168 @comment POSIX.1
169 @deftypefun clock_t times (struct tms *@var{buffer})
170 The @code{times} function stores the processor time information for
171 the calling process in @var{buffer}.
172
173 The return value is the same as the value of @code{clock()}: the elapsed
174 real time relative to an arbitrary base.  The base is a constant within a
175 particular process, and typically represents the time since system
176 start-up.  A value of @code{(clock_t)(-1)} is returned to indicate failure.
177 @end deftypefun
178
179 @strong{Portability Note:} The @code{clock} function described in
180 @ref{Basic CPU Time}, is specified by the @w{ISO C} standard.  The
181 @code{times} function is a feature of POSIX.1.  In the GNU system, the
182 value returned by the @code{clock} function is equivalent to the sum of
183 the @code{tms_utime} and @code{tms_stime} fields returned by
184 @code{times}.
185
186 @node Calendar Time
187 @section Calendar Time
188
189 This section describes facilities for keeping track of dates and times
190 according to the Gregorian calendar.
191 @cindex Gregorian calendar
192 @cindex time, calendar
193 @cindex date and time
194
195 There are three representations for date and time information:
196
197 @itemize @bullet
198 @item
199 @dfn{Calendar time} (the @code{time_t} data type) is a compact
200 representation, typically giving the number of seconds elapsed since
201 some implementation-specific base time.
202 @cindex calendar time
203
204 @item
205 There is also a @dfn{high-resolution time} representation (the @code{struct
206 timeval} data type) that includes fractions of a second.  Use this time
207 representation instead of ordinary calendar time when you need greater
208 precision.
209 @cindex high-resolution time
210
211 @item
212 @dfn{Local time} or @dfn{broken-down time} (the @code{struct
213 tm} data type) represents the date and time as a set of components
214 specifying the year, month, and so on, for a specific time zone.
215 This time representation is usually used in conjunction with formatting
216 date and time values.
217 @cindex local time
218 @cindex broken-down time
219 @end itemize
220
221 @menu
222 * Simple Calendar Time::        Facilities for manipulating calendar time.
223 * High-Resolution Calendar::    A time representation with greater precision.
224 * Broken-down Time::            Facilities for manipulating local time.
225 * Formatting Date and Time::    Converting times to strings.
226 * TZ Variable::                 How users specify the time zone.
227 * Time Zone Functions::         Functions to examine or specify the time zone.
228 * Time Functions Example::      An example program showing use of some of
229                                  the time functions.
230 @end menu
231
232 @node Simple Calendar Time
233 @subsection Simple Calendar Time
234
235 This section describes the @code{time_t} data type for representing
236 calendar time, and the functions which operate on calendar time objects.
237 These facilities are declared in the header file @file{time.h}.
238 @pindex time.h
239
240 @cindex epoch
241 @comment time.h
242 @comment ISO
243 @deftp {Data Type} time_t
244 This is the data type used to represent calendar time.
245 When interpreted as an absolute time
246 value, it represents the number of seconds elapsed since 00:00:00 on
247 January 1, 1970, Coordinated Universal Time.  (This date is sometimes
248 referred to as the @dfn{epoch}.)  POSIX requires that this count
249 ignore leap seconds, but on some hosts this count includes leap seconds
250 if you set @code{TZ} to certain values (@pxref{TZ Variable}).
251
252 In the GNU C library, @code{time_t} is equivalent to @code{long int}.
253 In other systems, @code{time_t} might be either an integer or
254 floating-point type.
255 @end deftp
256
257 @comment time.h
258 @comment ISO
259 @deftypefun double difftime (time_t @var{time1}, time_t @var{time0})
260 The @code{difftime} function returns the number of seconds elapsed
261 between time @var{time1} and time @var{time0}, as a value of type
262 @code{double}.  The difference ignores leap seconds unless leap
263 second support is enabled.
264
265 In the GNU system, you can simply subtract @code{time_t} values.  But on
266 other systems, the @code{time_t} data type might use some other encoding
267 where subtraction doesn't work directly.
268 @end deftypefun
269
270 @comment time.h
271 @comment ISO
272 @deftypefun time_t time (time_t *@var{result})
273 The @code{time} function returns the current time as a value of type
274 @code{time_t}.  If the argument @var{result} is not a null pointer, the
275 time value is also stored in @code{*@var{result}}.  If the calendar
276 time is not available, the value @w{@code{(time_t)(-1)}} is returned.
277 @end deftypefun
278
279
280 @node High-Resolution Calendar
281 @subsection High-Resolution Calendar
282
283 The @code{time_t} data type used to represent calendar times has a
284 resolution of only one second.  Some applications need more precision.
285
286 So, the GNU C library also contains functions which are capable of
287 representing calendar times to a higher resolution than one second.  The
288 functions and the associated data types described in this section are
289 declared in @file{sys/time.h}.
290 @pindex sys/time.h
291
292 @comment sys/time.h
293 @comment BSD
294 @deftp {Data Type} {struct timeval}
295 The @code{struct timeval} structure represents a calendar time.  It
296 has the following members:
297
298 @table @code
299 @item long int tv_sec
300 This represents the number of seconds since the epoch.  It is equivalent
301 to a normal @code{time_t} value.
302
303 @item long int tv_usec
304 This is the fractional second value, represented as the number of
305 microseconds.
306
307 Some times struct timeval values are used for time intervals.  Then the
308 @code{tv_sec} member is the number of seconds in the interval, and
309 @code{tv_usec} is the number of additional microseconds.
310 @end table
311 @end deftp
312
313 @comment sys/time.h
314 @comment BSD
315 @deftp {Data Type} {struct timezone}
316 The @code{struct timezone} structure is used to hold minimal information
317 about the local time zone.  It has the following members:
318
319 @table @code
320 @item int tz_minuteswest
321 This is the number of minutes west of UTC.
322
323 @item int tz_dsttime
324 If nonzero, daylight saving time applies during some part of the year.
325 @end table
326
327 The @code{struct timezone} type is obsolete and should never be used.
328 Instead, use the facilities described in @ref{Time Zone Functions}.
329 @end deftp
330
331 It is often necessary to subtract two values of type @w{@code{struct
332 timeval}}.  Here is the best way to do this.  It works even on some
333 peculiar operating systems where the @code{tv_sec} member has an
334 unsigned type.
335
336 @smallexample
337 /* @r{Subtract the `struct timeval' values X and Y,}
338    @r{storing the result in RESULT.}
339    @r{Return 1 if the difference is negative, otherwise 0.}  */
340
341 int
342 timeval_subtract (result, x, y)
343      struct timeval *result, *x, *y;
344 @{
345   /* @r{Perform the carry for the later subtraction by updating @var{y}.} */
346   if (x->tv_usec < y->tv_usec) @{
347     int nsec = (y->tv_usec - x->tv_usec) / 1000000 + 1;
348     y->tv_usec -= 1000000 * nsec;
349     y->tv_sec += nsec;
350   @}
351   if (x->tv_usec - y->tv_usec > 1000000) @{
352     int nsec = (y->tv_usec - x->tv_usec) / 1000000;
353     y->tv_usec += 1000000 * nsec;
354     y->tv_sec -= nsec;
355   @}
356
357   /* @r{Compute the time remaining to wait.}
358      @r{@code{tv_usec} is certainly positive.} */
359   result->tv_sec = x->tv_sec - y->tv_sec;
360   result->tv_usec = x->tv_usec - y->tv_usec;
361
362   /* @r{Return 1 if result is negative.} */
363   return x->tv_sec < y->tv_sec;
364 @}
365 @end smallexample
366
367 @comment sys/time.h
368 @comment BSD
369 @deftypefun int gettimeofday (struct timeval *@var{tp}, struct timezone *@var{tzp})
370 The @code{gettimeofday} function returns the current date and time in the
371 @code{struct timeval} structure indicated by @var{tp}.  Information about the
372 time zone is returned in the structure pointed at @var{tzp}.  If the @var{tzp}
373 argument is a null pointer, time zone information is ignored.
374
375 The return value is @code{0} on success and @code{-1} on failure.  The
376 following @code{errno} error condition is defined for this function:
377
378 @table @code
379 @item ENOSYS
380 The operating system does not support getting time zone information, and
381 @var{tzp} is not a null pointer.  The GNU operating system does not
382 support using @w{@code{struct timezone}} to represent time zone
383 information; that is an obsolete feature of 4.3 BSD.
384 Instead, use the facilities described in @ref{Time Zone Functions}.
385 @end table
386 @end deftypefun
387
388 @comment sys/time.h
389 @comment BSD
390 @deftypefun int settimeofday (const struct timeval *@var{tp}, const struct timezone *@var{tzp})
391 The @code{settimeofday} function sets the current date and time
392 according to the arguments.  As for @code{gettimeofday}, time zone
393 information is ignored if @var{tzp} is a null pointer.
394
395 You must be a privileged user in order to use @code{settimeofday}.
396
397 The return value is @code{0} on success and @code{-1} on failure.  The
398 following @code{errno} error conditions are defined for this function:
399
400 @table @code
401 @item EPERM
402 This process cannot set the time because it is not privileged.
403
404 @item ENOSYS
405 The operating system does not support setting time zone information, and
406 @var{tzp} is not a null pointer.
407 @end table
408 @end deftypefun
409
410 @comment sys/time.h
411 @comment BSD
412 @deftypefun int adjtime (const struct timeval *@var{delta}, struct timeval *@var{olddelta})
413 This function speeds up or slows down the system clock in order to make
414 gradual adjustments in the current time.  This ensures that the time
415 reported by the system clock is always monotonically increasing, which
416 might not happen if you simply set the current time.
417
418 The @var{delta} argument specifies a relative adjustment to be made to
419 the current time.  If negative, the system clock is slowed down for a
420 while until it has lost this much time.  If positive, the system clock
421 is speeded up for a while.
422
423 If the @var{olddelta} argument is not a null pointer, the @code{adjtime}
424 function returns information about any previous time adjustment that
425 has not yet completed.
426
427 This function is typically used to synchronize the clocks of computers
428 in a local network.  You must be a privileged user to use it.
429 The return value is @code{0} on success and @code{-1} on failure.  The
430 following @code{errno} error condition is defined for this function:
431
432 @table @code
433 @item EPERM
434 You do not have privilege to set the time.
435 @end table
436 @end deftypefun
437
438 @strong{Portability Note:}  The @code{gettimeofday}, @code{settimeofday},
439 and @code{adjtime} functions are derived from BSD.
440
441
442 @node Broken-down Time
443 @subsection Broken-down Time
444 @cindex broken-down time
445 @cindex calendar time and broken-down time
446
447 Calendar time is represented as a number of seconds.  This is convenient
448 for calculation, but has no resemblance to the way people normally
449 represent dates and times.  By contrast, @dfn{broken-down time} is a binary
450 representation separated into year, month, day, and so on.  Broken down
451 time values are not useful for calculations, but they are useful for
452 printing human readable time.
453
454 A broken-down time value is always relative to a choice of local time
455 zone, and it also indicates which time zone was used.
456
457 The symbols in this section are declared in the header file @file{time.h}.
458
459 @comment time.h
460 @comment ISO
461 @deftp {Data Type} {struct tm}
462 This is the data type used to represent a broken-down time.  The structure
463 contains at least the following members, which can appear in any order:
464
465 @table @code
466 @item int tm_sec
467 This is the number of seconds after the minute, normally in the range
468 @code{0} through @code{59}.  (The actual upper limit is @code{60}, to allow
469 for leap seconds if leap second support is available.)
470 @cindex leap second
471
472 @item int tm_min
473 This is the number of minutes after the hour, in the range @code{0} through
474 @code{59}.
475
476 @item int tm_hour
477 This is the number of hours past midnight, in the range @code{0} through
478 @code{23}.
479
480 @item int tm_mday
481 This is the day of the month, in the range @code{1} through @code{31}.
482
483 @item int tm_mon
484 This is the number of months since January, in the range @code{0} through
485 @code{11}.
486
487 @item int tm_year
488 This is the number of years since @code{1900}.
489
490 @item int tm_wday
491 This is the number of days since Sunday, in the range @code{0} through
492 @code{6}.
493
494 @item int tm_yday
495 This is the number of days since January 1, in the range @code{0} through
496 @code{365}.
497
498 @item int tm_isdst
499 @cindex Daylight Saving Time
500 @cindex summer time
501 This is a flag that indicates whether Daylight Saving Time is (or was, or
502 will be) in effect at the time described.  The value is positive if
503 Daylight Saving Time is in effect, zero if it is not, and negative if the
504 information is not available.
505
506 @item long int tm_gmtoff
507 This field describes the time zone that was used to compute this
508 broken-down time value, including any adjustment for daylight saving; it
509 is the number of seconds that you must add to UTC to get local time.
510 You can also think of this as the number of seconds east of UTC.  For
511 example, for U.S. Eastern Standard Time, the value is @code{-5*60*60}.
512 The @code{tm_gmtoff} field is derived from BSD and is a GNU library
513 extension; it is not visible in a strict @w{ISO C} environment.
514
515 @item const char *tm_zone
516 This field is the name for the time zone that was used to compute this
517 broken-down time value.  Like @code{tm_gmtoff}, this field is a BSD and
518 GNU extension, and is not visible in a strict @w{ISO C} environment.
519 @end table
520 @end deftp
521
522 @comment time.h
523 @comment ISO
524 @deftypefun {struct tm *} localtime (const time_t *@var{time})
525 The @code{localtime} function converts the calendar time pointed to by
526 @var{time} to broken-down time representation, expressed relative to the
527 user's specified time zone.
528
529 The return value is a pointer to a static broken-down time structure, which
530 might be overwritten by subsequent calls to @code{ctime}, @code{gmtime},
531 or @code{localtime}.  (But no other library function overwrites the contents
532 of this object.)
533
534 Calling @code{localtime} has one other effect: it sets the variable
535 @code{tzname} with information about the current time zone.  @xref{Time
536 Zone Functions}.
537 @end deftypefun
538
539 @comment time.h
540 @comment ISO
541 @deftypefun {struct tm *} gmtime (const time_t *@var{time})
542 This function is similar to @code{localtime}, except that the broken-down
543 time is expressed as Coordinated Universal Time (UTC)---that is, as
544 Greenwich Mean Time (GMT)---rather than relative to the local time zone.
545
546 Recall that calendar times are @emph{always} expressed in coordinated
547 universal time.
548 @end deftypefun
549
550 @comment time.h
551 @comment ISO
552 @deftypefun time_t mktime (struct tm *@var{brokentime})
553 The @code{mktime} function is used to convert a broken-down time structure
554 to a calendar time representation.  It also ``normalizes'' the contents of
555 the broken-down time structure, by filling in the day of week and day of
556 year based on the other date and time components.
557
558 The @code{mktime} function ignores the specified contents of the
559 @code{tm_wday} and @code{tm_yday} members of the broken-down time
560 structure.  It uses the values of the other components to compute the
561 calendar time; it's permissible for these components to have
562 unnormalized values outside of their normal ranges.  The last thing that
563 @code{mktime} does is adjust the components of the @var{brokentime}
564 structure (including the @code{tm_wday} and @code{tm_yday}).
565
566 If the specified broken-down time cannot be represented as a calendar time,
567 @code{mktime} returns a value of @code{(time_t)(-1)} and does not modify
568 the contents of @var{brokentime}.
569
570 Calling @code{mktime} also sets the variable @code{tzname} with
571 information about the current time zone.  @xref{Time Zone Functions}.
572 @end deftypefun
573
574 @node Formatting Date and Time
575 @subsection Formatting Date and Time
576
577 The functions described in this section format time values as strings.
578 These functions are declared in the header file @file{time.h}.
579 @pindex time.h
580
581 @comment time.h
582 @comment ISO
583 @deftypefun {char *} asctime (const struct tm *@var{brokentime})
584 The @code{asctime} function converts the broken-down time value that
585 @var{brokentime} points to into a string in a standard format:
586
587 @smallexample
588 "Tue May 21 13:46:22 1991\n"
589 @end smallexample
590
591 The abbreviations for the days of week are: @samp{Sun}, @samp{Mon},
592 @samp{Tue}, @samp{Wed}, @samp{Thu}, @samp{Fri}, and @samp{Sat}.
593
594 The abbreviations for the months are: @samp{Jan}, @samp{Feb},
595 @samp{Mar}, @samp{Apr}, @samp{May}, @samp{Jun}, @samp{Jul}, @samp{Aug},
596 @samp{Sep}, @samp{Oct}, @samp{Nov}, and @samp{Dec}.
597
598 The return value points to a statically allocated string, which might be
599 overwritten by subsequent calls to @code{asctime} or @code{ctime}.
600 (But no other library function overwrites the contents of this
601 string.)
602 @end deftypefun
603
604 @comment time.h
605 @comment ISO
606 @deftypefun {char *} ctime (const time_t *@var{time})
607 The @code{ctime} function is similar to @code{asctime}, except that the
608 time value is specified as a @code{time_t} calendar time value rather
609 than in broken-down local time format.  It is equivalent to
610
611 @smallexample
612 asctime (localtime (@var{time}))
613 @end smallexample
614
615 @code{ctime} sets the variable @code{tzname}, because @code{localtime}
616 does so.  @xref{Time Zone Functions}.
617 @end deftypefun
618
619 @comment time.h
620 @comment ISO
621 @comment POSIX.2
622 @deftypefun size_t strftime (char *@var{s}, size_t @var{size}, const char *@var{template}, const struct tm *@var{brokentime})
623 This function is similar to the @code{sprintf} function (@pxref{Formatted
624 Input}), but the conversion specifications that can appear in the format
625 template @var{template} are specialized for printing components of the date
626 and time @var{brokentime} according to the locale currently specified for
627 time conversion (@pxref{Locales}).
628
629 Ordinary characters appearing in the @var{template} are copied to the
630 output string @var{s}; this can include multibyte character sequences.
631 Conversion specifiers are introduced by a @samp{%} character, followed
632 by an optional flag which can be one of the following.  These flags,
633 which are GNU extensions, affect only the output of numbers:
634
635 @table @code
636 @item _
637 The number is padded with spaces.
638
639 @item -
640 The number is not padded at all.
641
642 @item 0
643 The number is padded with zeros even if the format specifies padding
644 with spaces.
645
646 @item ^
647 The output uses uppercase characters, but only if this is possible
648 (@pxref{Case Conversion}).
649 @end table
650
651 The default action is to pad the number with zeros to keep it a constant
652 width.  Numbers that do not have a range indicated below are never
653 padded, since there is no natural width for them.
654
655 Following the flag an optional specification of the width is possible.
656 This is specified in decimal notation.  If the natural size of the
657 output is of the field has less than the specified number of characters,
658 the result is written right adjusted and space padded to the given
659 size.
660
661 An optional modifier can follow the optional flag and width
662 specification.  The modifiers, which are POSIX.2 extensions, are:
663
664 @table @code
665 @item E
666 Use the locale's alternate representation for date and time.  This
667 modifier applies to the @code{%c}, @code{%C}, @code{%x}, @code{%X},
668 @code{%y} and @code{%Y} format specifiers.  In a Japanese locale, for
669 example, @code{%Ex} might yield a date format based on the Japanese
670 Emperors' reigns.
671
672 @item O
673 Use the locale's alternate numeric symbols for numbers.  This modifier
674 applies only to numeric format specifiers.
675 @end table
676
677 If the format supports the modifier but no alternate representation
678 is available, it is ignored.
679
680 The conversion specifier ends with a format specifier taken from the
681 following list.  The whole @samp{%} sequence is replaced in the output
682 string as follows:
683
684 @table @code
685 @item %a
686 The abbreviated weekday name according to the current locale.
687
688 @item %A
689 The full weekday name according to the current locale.
690
691 @item %b
692 The abbreviated month name according to the current locale.
693
694 @item %B
695 The full month name according to the current locale.
696
697 @item %c
698 The preferred date and time representation for the current locale.
699
700 @item %C
701 The century of the year.  This is equivalent to the greatest integer not
702 greater than the year divided by 100.
703
704 This format is a POSIX.2 extension.
705
706 @item %d
707 The day of the month as a decimal number (range @code{01} through @code{31}).
708
709 @item %D
710 The date using the format @code{%m/%d/%y}.
711
712 This format is a POSIX.2 extension.
713
714 @item %e
715 The day of the month like with @code{%d}, but padded with blank (range
716 @code{ 1} through @code{31}).
717
718 This format is a POSIX.2 extension.
719
720 @item %g
721 The year corresponding to the ISO week number, but without the century
722 (range @code{00} through @code{99}).  This has the same format and value
723 as @code{%y}, except that if the ISO week number (see @code{%V}) belongs
724 to the previous or next year, that year is used instead.
725
726 This format is a GNU extension.
727
728 @item %G
729 The year corresponding to the ISO week number.  This has the same format
730 and value as @code{%Y}, except that if the ISO week number (see
731 @code{%V}) belongs to the previous or next year, that year is used
732 instead.
733
734 This format is a GNU extension.
735
736 @item %h
737 The abbreviated month name according to the current locale.  The action
738 is the same as for @code{%b}.
739
740 This format is a POSIX.2 extension.
741
742 @item %H
743 The hour as a decimal number, using a 24-hour clock (range @code{00} through
744 @code{23}).
745
746 @item %I
747 The hour as a decimal number, using a 12-hour clock (range @code{01} through
748 @code{12}).
749
750 @item %j
751 The day of the year as a decimal number (range @code{001} through @code{366}).
752
753 @item %k
754 The hour as a decimal number, using a 24-hour clock like @code{%H}, but
755 padded with blank (range @code{ 0} through @code{23}).
756
757 This format is a GNU extension.
758
759 @item %l
760 The hour as a decimal number, using a 12-hour clock like @code{%I}, but
761 padded with blank (range @code{ 1} through @code{12}).
762
763 This format is a GNU extension.
764
765 @item %m
766 The month as a decimal number (range @code{01} through @code{12}).
767
768 @item %M
769 The minute as a decimal number (range @code{00} through @code{59}).
770
771 @item %n
772 A single @samp{\n} (newline) character.
773
774 This format is a POSIX.2 extension.
775
776 @item %p
777 Either @samp{AM} or @samp{PM}, according to the given time value; or the
778 corresponding strings for the current locale.  Noon is treated as
779 @samp{PM} and midnight as @samp{AM}.
780
781 @ignore
782 We currently have a problem with makeinfo.  Write @samp{AM} and @samp{am}
783 both results in `am'.  I.e., the difference in case is not visible anymore.
784 @end ignore
785 @item %P
786 Either @samp{am} or @samp{pm}, according to the given time value; or the
787 corresponding strings for the current locale, printed in lowercase
788 characters.  Noon is treated as @samp{pm} and midnight as @samp{am}.
789
790 This format is a GNU extension.
791
792 @item %r
793 The complete time using the AM/PM format of the current locale.
794
795 This format is a POSIX.2 extension.
796
797 @item %R
798 The hour and minute in decimal numbers using the format @code{%H:%M}.
799
800 This format is a GNU extension.
801
802 @item %s
803 The number of seconds since the epoch, i.e., since 1970-01-01 00:00:00 UTC.
804 Leap seconds are not counted unless leap second support is available.
805
806 This format is a GNU extension.
807
808 @item %S
809 The second as a decimal number (range @code{00} through @code{60}).
810
811 @item %t
812 A single @samp{\t} (tabulator) character.
813
814 This format is a POSIX.2 extension.
815
816 @item %T
817 The time using decimal numbers using the format @code{%H:%M:%S}.
818
819 This format is a POSIX.2 extension.
820
821 @item %u
822 The day of the week as a decimal number (range @code{1} through
823 @code{7}), Monday being @code{1}.
824
825 This format is a POSIX.2 extension.
826
827 @item %U
828 The week number of the current year as a decimal number (range @code{00}
829 through @code{53}), starting with the first Sunday as the first day of
830 the first week.  Days preceding the first Sunday in the year are
831 considered to be in week @code{00}.
832
833 @item %V
834 The @w{ISO 8601:1988} week number as a decimal number (range @code{01}
835 through @code{53}).  ISO weeks start with Monday and end with Sunday.
836 Week @code{01} of a year is the first week which has the majority of its
837 days in that year; this is equivalent to the week containing the year's
838 first Thursday, and it is also equivalent to the week containing January
839 4.  Week @code{01} of a year can contain days from the previous year.
840 The week before week @code{01} of a year is the last week (@code{52} or
841 @code{53}) of the previous year even if it contains days from the new
842 year.
843
844 This format is a POSIX.2 extension.
845
846 @item %w
847 The day of the week as a decimal number (range @code{0} through
848 @code{6}), Sunday being @code{0}.
849
850 @item %W
851 The week number of the current year as a decimal number (range @code{00}
852 through @code{53}), starting with the first Monday as the first day of
853 the first week.  All days preceding the first Monday in the year are
854 considered to be in week @code{00}.
855
856 @item %x
857 The preferred date representation for the current locale, but without the
858 time.
859
860 @item %X
861 The preferred time representation for the current locale, but with no date.
862
863 @item %y
864 The year without a century as a decimal number (range @code{00} through
865 @code{99}).  This is equivalent to the year modulo 100.
866
867 @item %Y
868 The year as a decimal number, using the Gregorian calendar.  Years
869 before the year @code{1} are numbered @code{0}, @code{-1}, and so on.
870
871 @item %z
872 @w{RFC 822}/@w{ISO 8601:1988} style numeric time zone (e.g.,
873 @code{-0600} or @code{+0100}), or nothing if no time zone is
874 determinable.
875
876 This format is a GNU extension.
877
878 @item %Z
879 The time zone abbreviation (empty if the time zone can't be determined).
880
881 @item %%
882 A literal @samp{%} character.
883 @end table
884
885 The @var{size} parameter can be used to specify the maximum number of
886 characters to be stored in the array @var{s}, including the terminating
887 null character.  If the formatted time requires more than @var{size}
888 characters, the excess characters are discarded.  The return value from
889 @code{strftime} is the number of characters placed in the array @var{s},
890 not including the terminating null character.  If the value equals
891 @var{size}, it means that the array @var{s} was too small; you should
892 repeat the call, providing a bigger array.
893
894 If @var{s} is a null pointer, @code{strftime} does not actually write
895 anything, but instead returns the number of characters it would have written.
896
897 According to POSIX.1 every call to @code{strftime} implies a call to
898 @code{tzset}.  So the contents of the environment variable @code{TZ}
899 is examined before any output is produced.
900
901 For an example of @code{strftime}, see @ref{Time Functions Example}.
902 @end deftypefun
903
904 @node TZ Variable
905 @subsection Specifying the Time Zone with @code{TZ}
906
907 In POSIX systems, a user can specify the time zone by means of the
908 @code{TZ} environment variable.  For information about how to set
909 environment variables, see @ref{Environment Variables}.  The functions
910 for accessing the time zone are declared in @file{time.h}.
911 @pindex time.h
912 @cindex time zone
913
914 You should not normally need to set @code{TZ}.  If the system is
915 configured properly, the default time zone will be correct.  You might
916 set @code{TZ} if you are using a computer over the network from a
917 different time zone, and would like times reported to you in the time zone
918 that local for you, rather than what is local for the computer.
919
920 In POSIX.1 systems the value of the @code{TZ} variable can be of one of
921 three formats.  With the GNU C library, the most common format is the
922 last one, which can specify a selection from a large database of time
923 zone information for many regions of the world.  The first two formats
924 are used to describe the time zone information directly, which is both
925 more cumbersome and less precise.  But the POSIX.1 standard only
926 specifies the details of the first two formats, so it is good to be
927 familiar with them in case you come across a POSIX.1 system that doesn't
928 support a time zone information database.
929
930 The first format is used when there is no Daylight Saving Time (or
931 summer time) in the local time zone:
932
933 @smallexample
934 @r{@var{std} @var{offset}}
935 @end smallexample
936
937 The @var{std} string specifies the name of the time zone.  It must be
938 three or more characters long and must not contain a leading colon or
939 embedded digits, commas, or plus or minus signs.  There is no space
940 character separating the time zone name from the @var{offset}, so these
941 restrictions are necessary to parse the specification correctly.
942
943 The @var{offset} specifies the time value one must add to the local time
944 to get a Coordinated Universal Time value.  It has syntax like
945 [@code{+}|@code{-}]@var{hh}[@code{:}@var{mm}[@code{:}@var{ss}]].  This
946 is positive if the local time zone is west of the Prime Meridian and
947 negative if it is east.  The hour must be between @code{0} and
948 @code{23}, and the minute and seconds between @code{0} and @code{59}.
949
950 For example, here is how we would specify Eastern Standard Time, but
951 without any daylight saving time alternative:
952
953 @smallexample
954 EST+5
955 @end smallexample
956
957 The second format is used when there is Daylight Saving Time:
958
959 @smallexample
960 @r{@var{std} @var{offset} @var{dst} [@var{offset}]@code{,}@var{start}[@code{/}@var{time}]@code{,}@var{end}[@code{/}@var{time}]}
961 @end smallexample
962
963 The initial @var{std} and @var{offset} specify the standard time zone, as
964 described above.  The @var{dst} string and @var{offset} specify the name
965 and offset for the corresponding daylight saving time time zone; if the
966 @var{offset} is omitted, it defaults to one hour ahead of standard time.
967
968 The remainder of the specification describes when daylight saving time is
969 in effect.  The @var{start} field is when daylight saving time goes into
970 effect and the @var{end} field is when the change is made back to standard
971 time.  The following formats are recognized for these fields:
972
973 @table @code
974 @item J@var{n}
975 This specifies the Julian day, with @var{n} between @code{1} and @code{365}.
976 February 29 is never counted, even in leap years.
977
978 @item @var{n}
979 This specifies the Julian day, with @var{n} between @code{0} and @code{365}.
980 February 29 is counted in leap years.
981
982 @item M@var{m}.@var{w}.@var{d}
983 This specifies day @var{d} of week @var{w} of month @var{m}.  The day
984 @var{d} must be between @code{0} (Sunday) and @code{6}.  The week
985 @var{w} must be between @code{1} and @code{5}; week @code{1} is the
986 first week in which day @var{d} occurs, and week @code{5} specifies the
987 @emph{last} @var{d} day in the month.  The month @var{m} should be
988 between @code{1} and @code{12}.
989 @end table
990
991 The @var{time} fields specify when, in the local time currently in
992 effect, the change to the other time occurs.  If omitted, the default is
993 @code{02:00:00}.
994
995 For example, here is how one would specify the Eastern time zone in the
996 United States, including the appropriate daylight saving time and its dates
997 of applicability.  The normal offset from UTC is 5 hours; since this is
998 west of the prime meridian, the sign is positive.  Summer time begins on
999 the first Sunday in April at 2:00am, and ends on the last Sunday in October
1000 at 2:00am.
1001
1002 @smallexample
1003 EST+5EDT,M4.1.0/2,M10.5.0/2
1004 @end smallexample
1005
1006 The schedule of daylight saving time in any particular jurisdiction has
1007 changed over the years.  To be strictly correct, the conversion of dates
1008 and times in the past should be based on the schedule that was in effect
1009 then.  However, this format has no facilities to let you specify how the
1010 schedule has changed from year to year.  The most you can do is specify
1011 one particular schedule---usually the present day schedule---and this is
1012 used to convert any date, no matter when.  For precise time zone
1013 specifications, it is best to use the time zone information database
1014 (see below).
1015
1016 The third format looks like this:
1017
1018 @smallexample
1019 :@var{characters}
1020 @end smallexample
1021
1022 Each operating system interprets this format differently; in the GNU C
1023 library, @var{characters} is the name of a file which describes the time
1024 zone.
1025
1026 @pindex /etc/localtime
1027 @pindex localtime
1028 If the @code{TZ} environment variable does not have a value, the
1029 operation chooses a time zone by default.  In the GNU C library, the
1030 default time zone is like the specification @samp{TZ=:/etc/localtime}
1031 (or @samp{TZ=:/usr/local/etc/localtime}, depending on how GNU C library
1032 was configured; @pxref{Installation}).  Other C libraries use their own
1033 rule for choosing the default time zone, so there is little we can say
1034 about them.
1035
1036 @cindex time zone database
1037 @pindex /share/lib/zoneinfo
1038 @pindex zoneinfo
1039 If @var{characters} begins with a slash, it is an absolute file name;
1040 otherwise the library looks for the file
1041 @w{@file{/share/lib/zoneinfo/@var{characters}}}.  The @file{zoneinfo}
1042 directory contains data files describing local time zones in many
1043 different parts of the world.  The names represent major cities, with
1044 subdirectories for geographical areas; for example,
1045 @file{America/New_York}, @file{Europe/London}, @file{Asia/Hong_Kong}.
1046 These data files are installed by the system administrator, who also
1047 sets @file{/etc/localtime} to point to the data file for the local time
1048 zone.  The GNU C library comes with a large database of time zone
1049 information for most regions of the world, which is maintained by a
1050 community of volunteers and put in the public domain.
1051
1052 @node Time Zone Functions
1053 @subsection Functions and Variables for Time Zones
1054
1055 @comment time.h
1056 @comment POSIX.1
1057 @deftypevar {char *} tzname [2]
1058 The array @code{tzname} contains two strings, which are the standard
1059 names of the pair of time zones (standard and daylight
1060 saving) that the user has selected.  @code{tzname[0]} is the name of
1061 the standard time zone (for example, @code{"EST"}), and @code{tzname[1]}
1062 is the name for the time zone when daylight saving time is in use (for
1063 example, @code{"EDT"}).  These correspond to the @var{std} and @var{dst}
1064 strings (respectively) from the @code{TZ} environment variable.  If
1065 daylight saving time is never used, @code{tzname[1]} is the empty string.
1066
1067 The @code{tzname} array is initialized from the @code{TZ} environment
1068 variable whenever @code{tzset}, @code{ctime}, @code{strftime},
1069 @code{mktime}, or @code{localtime} is called.  If multiple abbreviations
1070 have been used (e.g. @code{"EWT"} and @code{"EDT"} for U.S. Eastern War
1071 Time and Eastern Daylight Time), the array contains the most recent
1072 abbreviation.
1073
1074 The @code{tzname} array is required for POSIX.1 compatibility, but in
1075 GNU programs it is better to use the @code{tm_zone} member of the
1076 broken-down time structure, since @code{tm_zone} reports the correct
1077 abbreviation even when it is not the latest one.
1078
1079 @end deftypevar
1080
1081 @comment time.h
1082 @comment POSIX.1
1083 @deftypefun void tzset (void)
1084 The @code{tzset} function initializes the @code{tzname} variable from
1085 the value of the @code{TZ} environment variable.  It is not usually
1086 necessary for your program to call this function, because it is called
1087 automatically when you use the other time conversion functions that
1088 depend on the time zone.
1089 @end deftypefun
1090
1091 The following variables are defined for compatibility with System V
1092 Unix.  Like @code{tzname}, these variables are set by calling
1093 @code{tzset} or the other time conversion functions.
1094
1095 @comment time.h
1096 @comment SVID
1097 @deftypevar {long int} timezone
1098 This contains the difference between UTC and the latest local standard
1099 time, in seconds west of UTC.  For example, in the U.S. Eastern time
1100 zone, the value is @code{5*60*60}.  Unlike the @code{tm_gmtoff} member
1101 of the broken-down time structure, this value is not adjusted for
1102 daylight saving, and its sign is reversed.  In GNU programs it is better
1103 to use @code{tm_gmtoff}, since it contains the correct offset even when
1104 it is not the latest one.
1105 @end deftypevar
1106
1107 @comment time.h
1108 @comment SVID
1109 @deftypevar int daylight
1110 This variable has a nonzero value if daylight savings time rules apply.
1111 A nonzero value does not necessarily mean that daylight savings time is
1112 now in effect; it means only that daylight savings time is sometimes in
1113 effect.
1114 @end deftypevar
1115
1116 @node Time Functions Example
1117 @subsection Time Functions Example
1118
1119 Here is an example program showing the use of some of the local time and
1120 calendar time functions.
1121
1122 @smallexample
1123 @include strftim.c.texi
1124 @end smallexample
1125
1126 It produces output like this:
1127
1128 @smallexample
1129 Wed Jul 31 13:02:36 1991
1130 Today is Wednesday, July 31.
1131 The time is 01:02 PM.
1132 @end smallexample
1133
1134
1135 @node Setting an Alarm
1136 @section Setting an Alarm
1137
1138 The @code{alarm} and @code{setitimer} functions provide a mechanism for a
1139 process to interrupt itself at some future time.  They do this by setting a
1140 timer; when the timer expires, the process receives a signal.
1141
1142 @cindex setting an alarm
1143 @cindex interval timer, setting
1144 @cindex alarms, setting
1145 @cindex timers, setting
1146 Each process has three independent interval timers available:
1147
1148 @itemize @bullet
1149 @item
1150 A real-time timer that counts clock time.  This timer sends a
1151 @code{SIGALRM} signal to the process when it expires.
1152 @cindex real-time timer
1153 @cindex timer, real-time
1154
1155 @item
1156 A virtual timer that counts CPU time used by the process.  This timer
1157 sends a @code{SIGVTALRM} signal to the process when it expires.
1158 @cindex virtual timer
1159 @cindex timer, virtual
1160
1161 @item
1162 A profiling timer that counts both CPU time used by the process, and CPU
1163 time spent in system calls on behalf of the process.  This timer sends a
1164 @code{SIGPROF} signal to the process when it expires.
1165 @cindex profiling timer
1166 @cindex timer, profiling
1167
1168 This timer is useful for profiling in interpreters.  The interval timer
1169 mechanism does not have the fine granularity necessary for profiling
1170 native code.
1171 @c @xref{profil} !!!
1172 @end itemize
1173
1174 You can only have one timer of each kind set at any given time.  If you
1175 set a timer that has not yet expired, that timer is simply reset to the
1176 new value.
1177
1178 You should establish a handler for the appropriate alarm signal using
1179 @code{signal} or @code{sigaction} before issuing a call to @code{setitimer}
1180 or @code{alarm}.  Otherwise, an unusual chain of events could cause the
1181 timer to expire before your program establishes the handler, and in that
1182 case it would be terminated, since that is the default action for the alarm
1183 signals.  @xref{Signal Handling}.
1184
1185 The @code{setitimer} function is the primary means for setting an alarm.
1186 This facility is declared in the header file @file{sys/time.h}.  The
1187 @code{alarm} function, declared in @file{unistd.h}, provides a somewhat
1188 simpler interface for setting the real-time timer.
1189 @pindex unistd.h
1190 @pindex sys/time.h
1191
1192 @comment sys/time.h
1193 @comment BSD
1194 @deftp {Data Type} {struct itimerval}
1195 This structure is used to specify when a timer should expire.  It contains
1196 the following members:
1197 @table @code
1198 @item struct timeval it_interval
1199 This is the interval between successive timer interrupts.  If zero, the
1200 alarm will only be sent once.
1201
1202 @item struct timeval it_value
1203 This is the interval to the first timer interrupt.  If zero, the alarm is
1204 disabled.
1205 @end table
1206
1207 The @code{struct timeval} data type is described in @ref{High-Resolution
1208 Calendar}.
1209 @end deftp
1210
1211 @comment sys/time.h
1212 @comment BSD
1213 @deftypefun int setitimer (int @var{which}, struct itimerval *@var{new}, struct itimerval *@var{old})
1214 The @code{setitimer} function sets the timer specified by @var{which}
1215 according to @var{new}.  The @var{which} argument can have a value of
1216 @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL}, or @code{ITIMER_PROF}.
1217
1218 If @var{old} is not a null pointer, @code{setitimer} returns information
1219 about any previous unexpired timer of the same kind in the structure it
1220 points to.
1221
1222 The return value is @code{0} on success and @code{-1} on failure.  The
1223 following @code{errno} error conditions are defined for this function:
1224
1225 @table @code
1226 @item EINVAL
1227 The timer interval was too large.
1228 @end table
1229 @end deftypefun
1230
1231 @comment sys/time.h
1232 @comment BSD
1233 @deftypefun int getitimer (int @var{which}, struct itimerval *@var{old})
1234 The @code{getitimer} function stores information about the timer specified
1235 by @var{which} in the structure pointed at by @var{old}.
1236
1237 The return value and error conditions are the same as for @code{setitimer}.
1238 @end deftypefun
1239
1240 @comment sys/time.h
1241 @comment BSD
1242 @table @code
1243 @item ITIMER_REAL
1244 @findex ITIMER_REAL
1245 This constant can be used as the @var{which} argument to the
1246 @code{setitimer} and @code{getitimer} functions to specify the real-time
1247 timer.
1248
1249 @comment sys/time.h
1250 @comment BSD
1251 @item ITIMER_VIRTUAL
1252 @findex ITIMER_VIRTUAL
1253 This constant can be used as the @var{which} argument to the
1254 @code{setitimer} and @code{getitimer} functions to specify the virtual
1255 timer.
1256
1257 @comment sys/time.h
1258 @comment BSD
1259 @item ITIMER_PROF
1260 @findex ITIMER_PROF
1261 This constant can be used as the @var{which} argument to the
1262 @code{setitimer} and @code{getitimer} functions to specify the profiling
1263 timer.
1264 @end table
1265
1266 @comment unistd.h
1267 @comment POSIX.1
1268 @deftypefun {unsigned int} alarm (unsigned int @var{seconds})
1269 The @code{alarm} function sets the real-time timer to expire in
1270 @var{seconds} seconds.  If you want to cancel any existing alarm, you
1271 can do this by calling @code{alarm} with a @var{seconds} argument of
1272 zero.
1273
1274 The return value indicates how many seconds remain before the previous
1275 alarm would have been sent.  If there is no previous alarm, @code{alarm}
1276 returns zero.
1277 @end deftypefun
1278
1279 The @code{alarm} function could be defined in terms of @code{setitimer}
1280 like this:
1281
1282 @smallexample
1283 unsigned int
1284 alarm (unsigned int seconds)
1285 @{
1286   struct itimerval old, new;
1287   new.it_interval.tv_usec = 0;
1288   new.it_interval.tv_sec = 0;
1289   new.it_value.tv_usec = 0;
1290   new.it_value.tv_sec = (long int) seconds;
1291   if (setitimer (ITIMER_REAL, &new, &old) < 0)
1292     return 0;
1293   else
1294     return old.it_value.tv_sec;
1295 @}
1296 @end smallexample
1297
1298 There is an example showing the use of the @code{alarm} function in
1299 @ref{Handler Returns}.
1300
1301 If you simply want your process to wait for a given number of seconds,
1302 you should use the @code{sleep} function.  @xref{Sleeping}.
1303
1304 You shouldn't count on the signal arriving precisely when the timer
1305 expires.  In a multiprocessing environment there is typically some
1306 amount of delay involved.
1307
1308 @strong{Portability Note:} The @code{setitimer} and @code{getitimer}
1309 functions are derived from BSD Unix, while the @code{alarm} function is
1310 specified by the POSIX.1 standard.  @code{setitimer} is more powerful than
1311 @code{alarm}, but @code{alarm} is more widely used.
1312
1313 @node Sleeping
1314 @section Sleeping
1315
1316 The function @code{sleep} gives a simple way to make the program wait
1317 for short periods of time.  If your program doesn't use signals (except
1318 to terminate), then you can expect @code{sleep} to wait reliably for
1319 the specified amount of time.  Otherwise, @code{sleep} can return sooner
1320 if a signal arrives; if you want to wait for a given period regardless
1321 of signals, use @code{select} (@pxref{Waiting for I/O}) and don't
1322 specify any descriptors to wait for.
1323 @c !!! select can get EINTR; using SA_RESTART makes sleep win too.
1324
1325 @comment unistd.h
1326 @comment POSIX.1
1327 @deftypefun {unsigned int} sleep (unsigned int @var{seconds})
1328 The @code{sleep} function waits for @var{seconds} or until a signal
1329 is delivered, whichever happens first.
1330
1331 If @code{sleep} function returns because the requested time has
1332 elapsed, it returns a value of zero.  If it returns because of delivery
1333 of a signal, its return value is the remaining time in the sleep period.
1334
1335 The @code{sleep} function is declared in @file{unistd.h}.
1336 @end deftypefun
1337
1338 Resist the temptation to implement a sleep for a fixed amount of time by
1339 using the return value of @code{sleep}, when nonzero, to call
1340 @code{sleep} again.  This will work with a certain amount of accuracy as
1341 long as signals arrive infrequently.  But each signal can cause the
1342 eventual wakeup time to be off by an additional second or so.  Suppose a
1343 few signals happen to arrive in rapid succession by bad luck---there is
1344 no limit on how much this could shorten or lengthen the wait.
1345
1346 Instead, compute the time at which the program should stop waiting, and
1347 keep trying to wait until that time.  This won't be off by more than a
1348 second.  With just a little more work, you can use @code{select} and
1349 make the waiting period quite accurate.  (Of course, heavy system load
1350 can cause unavoidable additional delays---unless the machine is
1351 dedicated to one application, there is no way you can avoid this.)
1352
1353 On some systems, @code{sleep} can do strange things if your program uses
1354 @code{SIGALRM} explicitly.  Even if @code{SIGALRM} signals are being
1355 ignored or blocked when @code{sleep} is called, @code{sleep} might
1356 return prematurely on delivery of a @code{SIGALRM} signal.  If you have
1357 established a handler for @code{SIGALRM} signals and a @code{SIGALRM}
1358 signal is delivered while the process is sleeping, the action taken
1359 might be just to cause @code{sleep} to return instead of invoking your
1360 handler.  And, if @code{sleep} is interrupted by delivery of a signal
1361 whose handler requests an alarm or alters the handling of @code{SIGALRM},
1362 this handler and @code{sleep} will interfere.
1363
1364 On the GNU system, it is safe to use @code{sleep} and @code{SIGALRM} in
1365 the same program, because @code{sleep} does not work by means of
1366 @code{SIGALRM}.
1367
1368 @node Resource Usage
1369 @section Resource Usage
1370
1371 @pindex sys/resource.h
1372 The function @code{getrusage} and the data type @code{struct rusage}
1373 are used for examining the usage figures of a process.  They are declared
1374 in @file{sys/resource.h}.
1375
1376 @comment sys/resource.h
1377 @comment BSD
1378 @deftypefun int getrusage (int @var{processes}, struct rusage *@var{rusage})
1379 This function reports the usage totals for processes specified by
1380 @var{processes}, storing the information in @code{*@var{rusage}}.
1381
1382 In most systems, @var{processes} has only two valid values:
1383
1384 @table @code
1385 @comment sys/resource.h
1386 @comment BSD
1387 @item RUSAGE_SELF
1388 Just the current process.
1389
1390 @comment sys/resource.h
1391 @comment BSD
1392 @item RUSAGE_CHILDREN
1393 All child processes (direct and indirect) that have terminated already.
1394 @end table
1395
1396 In the GNU system, you can also inquire about a particular child process
1397 by specifying its process ID.
1398
1399 The return value of @code{getrusage} is zero for success, and @code{-1}
1400 for failure.
1401
1402 @table @code
1403 @item EINVAL
1404 The argument @var{processes} is not valid.
1405 @end table
1406 @end deftypefun
1407
1408 One way of getting usage figures for a particular child process is with
1409 the function @code{wait4}, which returns totals for a child when it
1410 terminates.  @xref{BSD Wait Functions}.
1411
1412 @comment sys/resource.h
1413 @comment BSD
1414 @deftp {Data Type} {struct rusage}
1415 This data type records a collection usage amounts for various sorts of
1416 resources.  It has the following members, and possibly others:
1417
1418 @table @code
1419 @item struct timeval ru_utime
1420 Time spent executing user instructions.
1421
1422 @item struct timeval ru_stime
1423 Time spent in operating system code on behalf of @var{processes}.
1424
1425 @item long int ru_maxrss
1426 The maximum resident set size used, in kilobytes.  That is, the maximum
1427 number of kilobytes that @var{processes} used in real memory simultaneously.
1428
1429 @item long int ru_ixrss
1430 An integral value expressed in kilobytes times ticks of execution, which
1431 indicates the amount of memory used by text that was shared with other
1432 processes.
1433
1434 @item long int ru_idrss
1435 An integral value expressed the same way, which is the amount of
1436 unshared memory used in data.
1437
1438 @item long int ru_isrss
1439 An integral value expressed the same way, which is the amount of
1440 unshared memory used in stack space.
1441
1442 @item long int ru_minflt
1443 The number of page faults which were serviced without requiring any I/O.
1444
1445 @item long int ru_majflt
1446 The number of page faults which were serviced by doing I/O.
1447
1448 @item long int ru_nswap
1449 The number of times @var{processes} was swapped entirely out of main memory.
1450
1451 @item long int ru_inblock
1452 The number of times the file system had to read from the disk on behalf
1453 of @var{processes}.
1454
1455 @item long int ru_oublock
1456 The number of times the file system had to write to the disk on behalf
1457 of @var{processes}.
1458
1459 @item long int ru_msgsnd
1460 Number of IPC messages sent.
1461
1462 @item long ru_msgrcv
1463 Number of IPC messages received.
1464
1465 @item long int ru_nsignals
1466 Number of signals received.
1467
1468 @item long int ru_nvcsw
1469 The number of times @var{processes} voluntarily invoked a context switch
1470 (usually to wait for some service).
1471
1472 @item long int ru_nivcsw
1473 The number of times an involuntary context switch took place (because
1474 the time slice expired, or another process of higher priority became
1475 runnable).
1476 @end table
1477 @end deftp
1478
1479 An additional historical function for examining usage figures,
1480 @code{vtimes}, is supported but not documented here.  It is declared in
1481 @file{sys/vtimes.h}.
1482
1483 @node Limits on Resources
1484 @section Limiting Resource Usage
1485 @cindex resource limits
1486 @cindex limits on resource usage
1487 @cindex usage limits
1488
1489 You can specify limits for the resource usage of a process.  When the
1490 process tries to exceed a limit, it may get a signal, or the system call
1491 by which it tried to do so may fail, depending on the limit.  Each
1492 process initially inherits its limit values from its parent, but it can
1493 subsequently change them.
1494
1495 @pindex sys/resource.h
1496 The symbols in this section are defined in @file{sys/resource.h}.
1497
1498 @comment sys/resource.h
1499 @comment BSD
1500 @deftypefun int getrlimit (int @var{resource}, struct rlimit *@var{rlp})
1501 Read the current value and the maximum value of resource @var{resource}
1502 and store them in @code{*@var{rlp}}.
1503
1504 The return value is @code{0} on success and @code{-1} on failure.  The
1505 only possible @code{errno} error condition is @code{EFAULT}.
1506 @end deftypefun
1507
1508 @comment sys/resource.h
1509 @comment BSD
1510 @deftypefun int setrlimit (int @var{resource}, struct rlimit *@var{rlp})
1511 Store the current value and the maximum value of resource @var{resource}
1512 in @code{*@var{rlp}}.
1513
1514 The return value is @code{0} on success and @code{-1} on failure.  The
1515 following @code{errno} error condition is possible:
1516
1517 @table @code
1518 @item EPERM
1519 You tried to change the maximum permissible limit value,
1520 but you don't have privileges to do so.
1521 @end table
1522 @end deftypefun
1523
1524 @comment sys/resource.h
1525 @comment BSD
1526 @deftp {Data Type} {struct rlimit}
1527 This structure is used with @code{getrlimit} to receive limit values,
1528 and with @code{setrlimit} to specify limit values.  It has two fields:
1529
1530 @table @code
1531 @item rlim_cur
1532 The current value of the limit in question.
1533 This is also called the ``soft limit''.
1534 @cindex soft limit
1535
1536 @item rlim_max
1537 The maximum permissible value of the limit in question.  You cannot set
1538 the current value of the limit to a larger number than this maximum.
1539 Only the super user can change the maximum permissible value.
1540 This is also called the ``hard limit''.
1541 @cindex hard limit
1542 @end table
1543
1544 In @code{getrlimit}, the structure is an output; it receives the current
1545 values.  In @code{setrlimit}, it specifies the new values.
1546 @end deftp
1547
1548 Here is a list of resources that you can specify a limit for.
1549 Those that are sizes are measured in bytes.
1550
1551 @table @code
1552 @comment sys/resource.h
1553 @comment BSD
1554 @item RLIMIT_CPU
1555 @vindex RLIMIT_CPU
1556 The maximum amount of cpu time the process can use.  If it runs for
1557 longer than this, it gets a signal: @code{SIGXCPU}.  The value is
1558 measured in seconds.  @xref{Operation Error Signals}.
1559
1560 @comment sys/resource.h
1561 @comment BSD
1562 @item RLIMIT_FSIZE
1563 @vindex RLIMIT_FSIZE
1564 The maximum size of file the process can create.  Trying to write a
1565 larger file causes a signal: @code{SIGXFSZ}.  @xref{Operation Error
1566 Signals}.
1567
1568 @comment sys/resource.h
1569 @comment BSD
1570 @item RLIMIT_DATA
1571 @vindex RLIMIT_DATA
1572 The maximum size of data memory for the process.  If the process tries
1573 to allocate data memory beyond this amount, the allocation function
1574 fails.
1575
1576 @comment sys/resource.h
1577 @comment BSD
1578 @item RLIMIT_STACK
1579 @vindex RLIMIT_STACK
1580 The maximum stack size for the process.  If the process tries to extend
1581 its stack past this size, it gets a @code{SIGSEGV} signal.
1582 @xref{Program Error Signals}.
1583
1584 @comment sys/resource.h
1585 @comment BSD
1586 @item RLIMIT_CORE
1587 @vindex RLIMIT_CORE
1588 The maximum size core file that this process can create.  If the process
1589 terminates and would dump a core file larger than this maximum size,
1590 then no core file is created.  So setting this limit to zero prevents
1591 core files from ever being created.
1592
1593 @comment sys/resource.h
1594 @comment BSD
1595 @item RLIMIT_RSS
1596 @vindex RLIMIT_RSS
1597 The maximum amount of physical memory that this process should get.
1598 This parameter is a guide for the system's scheduler and memory
1599 allocator; the system may give the process more memory when there is a
1600 surplus.
1601
1602 @comment sys/resource.h
1603 @comment BSD
1604 @item RLIMIT_MEMLOCK
1605 The maximum amount of memory that can be locked into physical memory (so
1606 it will never be paged out).
1607
1608 @comment sys/resource.h
1609 @comment BSD
1610 @item RLIMIT_NPROC
1611 The maximum number of processes that can be created with the same user ID.
1612 If you have reached the limit for your user ID, @code{fork} will fail
1613 with @code{EAGAIN}.  @xref{Creating a Process}.
1614
1615 @comment sys/resource.h
1616 @comment BSD
1617 @item RLIMIT_NOFILE
1618 @vindex RLIMIT_NOFILE
1619 @itemx RLIMIT_OFILE
1620 @vindex RLIMIT_OFILE
1621 The maximum number of files that the process can open.  If it tries to
1622 open more files than this, it gets error code @code{EMFILE}.
1623 @xref{Error Codes}.  Not all systems support this limit; GNU does, and
1624 4.4 BSD does.
1625
1626 @comment sys/resource.h
1627 @comment BSD
1628 @item RLIM_NLIMITS
1629 @vindex RLIM_NLIMITS
1630 The number of different resource limits.  Any valid @var{resource}
1631 operand must be less than @code{RLIM_NLIMITS}.
1632 @end table
1633
1634 @comment sys/resource.h
1635 @comment BSD
1636 @defvr Constant int RLIM_INFINITY
1637 This constant stands for a value of ``infinity'' when supplied as
1638 the limit value in @code{setrlimit}.
1639 @end defvr
1640
1641 @c ??? Someone want to finish these?
1642 Two historical functions for setting resource limits, @code{ulimit} and
1643 @code{vlimit}, are not documented here.  The latter is declared in
1644 @file{sys/vlimit.h} and comes from BSD.
1645
1646 @node Priority
1647 @section Process Priority
1648 @cindex process priority
1649 @cindex priority of a process
1650
1651 @pindex sys/resource.h
1652 When several processes try to run, their respective priorities determine
1653 what share of the CPU each process gets.  This section describes how you
1654 can read and set the priority of a process.  All these functions and
1655 macros are declared in @file{sys/resource.h}.
1656
1657 The range of valid priority values depends on the operating system, but
1658 typically it runs from @code{-20} to @code{20}.  A lower priority value
1659 means the process runs more often.  These constants describe the range of
1660 priority values:
1661
1662 @table @code
1663 @comment sys/resource.h
1664 @comment BSD
1665 @item PRIO_MIN
1666 @vindex PRIO_MIN
1667 The smallest valid priority value.
1668
1669 @comment sys/resource.h
1670 @comment BSD
1671 @item PRIO_MAX
1672 @vindex PRIO_MAX
1673 The smallest valid priority value.
1674 @end table
1675
1676 @comment sys/resource.h
1677 @comment BSD
1678 @deftypefun int getpriority (int @var{class}, int @var{id})
1679 Read the priority of a class of processes; @var{class} and @var{id}
1680 specify which ones (see below).  If the processes specified do not all
1681 have the same priority, this returns the smallest value that any of them
1682 has.
1683
1684 The return value is the priority value on success, and @code{-1} on
1685 failure.  The following @code{errno} error condition are possible for
1686 this function:
1687
1688 @table @code
1689 @item ESRCH
1690 The combination of @var{class} and @var{id} does not match any existing
1691 process.
1692
1693 @item EINVAL
1694 The value of @var{class} is not valid.
1695 @end table
1696
1697 When the return value is @code{-1}, it could indicate failure, or it
1698 could be the priority value.  The only way to make certain is to set
1699 @code{errno = 0} before calling @code{getpriority}, then use @code{errno
1700 != 0} afterward as the criterion for failure.
1701 @end deftypefun
1702
1703 @comment sys/resource.h
1704 @comment BSD
1705 @deftypefun int setpriority (int @var{class}, int @var{id}, int @var{priority})
1706 Set the priority of a class of processes to @var{priority}; @var{class}
1707 and @var{id} specify which ones (see below).
1708
1709 The return value is @code{0} on success and @code{-1} on failure.  The
1710 following @code{errno} error condition are defined for this function:
1711
1712 @table @code
1713 @item ESRCH
1714 The combination of @var{class} and @var{id} does not match any existing
1715 process.
1716
1717 @item EINVAL
1718 The value of @var{class} is not valid.
1719
1720 @item EPERM
1721 You tried to set the priority of some other user's process, and you
1722 don't have privileges for that.
1723
1724 @item EACCES
1725 You tried to lower the priority of a process, and you don't have
1726 privileges for that.
1727 @end table
1728 @end deftypefun
1729
1730 The arguments @var{class} and @var{id} together specify a set of
1731 processes you are interested in.  These are the possible values for
1732 @var{class}:
1733
1734 @table @code
1735 @comment sys/resource.h
1736 @comment BSD
1737 @item PRIO_PROCESS
1738 @vindex PRIO_PROCESS
1739 Read or set the priority of one process.  The argument @var{id} is a
1740 process ID.
1741
1742 @comment sys/resource.h
1743 @comment BSD
1744 @item PRIO_PGRP
1745 @vindex PRIO_PGRP
1746 Read or set the priority of one process group.  The argument @var{id} is
1747 a process group ID.
1748
1749 @comment sys/resource.h
1750 @comment BSD
1751 @item PRIO_USER
1752 @vindex PRIO_USER
1753 Read or set the priority of one user's processes.  The argument @var{id}
1754 is a user ID.
1755 @end table
1756
1757 If the argument @var{id} is 0, it stands for the current process,
1758 current process group, or the current user, according to @var{class}.
1759
1760 @c ??? I don't know where we should say this comes from.
1761 @comment Unix
1762 @comment dunno.h
1763 @deftypefun int nice (int @var{increment})
1764 Increment the priority of the current process by @var{increment}.
1765 The return value is the same as for @code{setpriority}.
1766
1767 Here is an equivalent definition for @code{nice}:
1768
1769 @smallexample
1770 int
1771 nice (int increment)
1772 @{
1773   int old = getpriority (PRIO_PROCESS, 0);
1774   return setpriority (PRIO_PROCESS, 0, old + increment);
1775 @}
1776 @end smallexample
1777 @end deftypefun