source: mainline/uspace/lib/posix/time.h@ 1b55da67

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 1b55da67 was 4cf8ca6, checked in by Petr Koupy <petr.koupy@…>, 14 years ago

Various minor commenting (no change in functionality).
  • Property mode set to 100644
File size: 6.1 KB
Line 
1/*
2 * Copyright (c) 2011 Petr Koupy
3 * Copyright (c) 2011 Jiri Zarevucky
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/** @addtogroup libposix
31 * @{
32 */
33/** @file Time measurement support.
34 */
35
36#ifndef POSIX_TIME_H_
37#define POSIX_TIME_H_
38
39#include "libc/time.h"
40#include "sys/types.h"
41
42#ifndef NULL
43 #define NULL ((void *) 0)
44#endif
45
46#ifndef CLOCKS_PER_SEC
47 #define CLOCKS_PER_SEC (1000000L)
48#endif
49
50#ifndef __locale_t_defined
51 #define __locale_t_defined
52 typedef struct __posix_locale *posix_locale_t;
53 #ifndef LIBPOSIX_INTERNAL
54 #define locale_t posix_locale_t
55 #endif
56#endif
57
58#ifndef POSIX_SIGNAL_H_
59 struct posix_sigevent;
60 #ifndef LIBPOSIX_INTERNAL
61 #define sigevent posix_sigevent
62 #endif
63#endif
64
65#undef ASCTIME_BUF_LEN
66#define ASCTIME_BUF_LEN 26
67
68#undef CLOCK_REALTIME
69#define CLOCK_REALTIME ((posix_clockid_t) 0)
70
71struct posix_tm {
72 int tm_sec; /* Seconds [0,60]. */
73 int tm_min; /* Minutes [0,59]. */
74 int tm_hour; /* Hour [0,23]. */
75 int tm_mday; /* Day of month [1,31]. */
76 int tm_mon; /* Month of year [0,11]. */
77 int tm_year; /* Years since 1900. */
78 int tm_wday; /* Day of week [0,6] (Sunday = 0). */
79 int tm_yday; /* Day of year [0,365]. */
80 int tm_isdst; /* Daylight Savings flag. */
81};
82
83struct posix_timespec {
84 time_t tv_sec; /* Seconds. */
85 long tv_nsec; /* Nanoseconds. */
86};
87
88struct posix_itimerspec {
89 struct posix_timespec it_interval; /* Timer period. */
90 struct posix_timespec it_value; /* Timer expiration. */
91};
92
93typedef struct __posix_timer *posix_timer_t;
94
95/* Timezones */
96extern int posix_daylight;
97extern long posix_timezone;
98extern char *posix_tzname[2];
99extern void posix_tzset(void);
100
101/* Elapsed Time */
102extern double posix_difftime(time_t time1, time_t time0);
103
104/* Broken-down Time */
105extern time_t posix_mktime(struct posix_tm *tm);
106extern struct posix_tm *posix_gmtime(const time_t *timer);
107extern struct posix_tm *posix_gmtime_r(const time_t *restrict timer,
108 struct posix_tm *restrict result);
109extern struct posix_tm *posix_localtime(const time_t *timer);
110extern struct posix_tm *posix_localtime_r(const time_t *restrict timer,
111 struct posix_tm *restrict result);
112
113/* Formatting Calendar Time */
114extern char *posix_asctime(const struct posix_tm *timeptr);
115extern char *posix_asctime_r(const struct posix_tm *restrict timeptr,
116 char *restrict buf);
117extern char *posix_ctime(const time_t *timer);
118extern char *posix_ctime_r(const time_t *timer, char *buf);
119extern size_t posix_strftime(char *restrict s, size_t maxsize,
120 const char *restrict format, const struct posix_tm *restrict tm);
121extern size_t posix_strftime_l(char *restrict s, size_t maxsize,
122 const char *restrict format, const struct posix_tm *restrict tm,
123 posix_locale_t loc);
124
125/* Clocks */
126extern int posix_clock_getres(posix_clockid_t clock_id,
127 struct posix_timespec *res);
128extern int posix_clock_gettime(posix_clockid_t clock_id,
129 struct posix_timespec *tp);
130extern int posix_clock_settime(posix_clockid_t clock_id,
131 const struct posix_timespec *tp);
132extern int posix_clock_nanosleep(posix_clockid_t clock_id, int flags,
133 const struct posix_timespec *rqtp, struct posix_timespec *rmtp);
134
135#if 0
136
137/* Timers */
138extern int posix_timer_create(posix_clockid_t clockid,
139 struct posix_sigevent *restrict evp,
140 posix_timer_t *restrict timerid);
141extern int posix_timer_delete(posix_timer_t timerid);
142extern int posix_timer_getoverrun(posix_timer_t timerid);
143extern int posix_timer_gettime(posix_timer_t timerid,
144 struct posix_itimerspec *value);
145extern int posix_timer_settime(posix_timer_t timerid, int flags,
146 const struct posix_itimerspec *restrict value,
147 struct posix_itimerspec *restrict ovalue);
148
149#endif
150
151/* CPU Time */
152extern posix_clock_t posix_clock(void);
153
154#ifndef LIBPOSIX_INTERNAL
155 #define tm posix_tm
156 #define timespec posix_timespec
157 #define itimerspec posix_itimerspec
158 #define timer_t posix_timer_t
159
160 #define daylight posix_daylight
161 #define timezone posix_timezone
162 #define tzname posix_tzname
163 #define tzset posix_tzset
164
165 #define difftime posix_difftime
166
167 #define mktime posix_mktime
168 #define gmtime posix_gmtime
169 #define gmtime_r posix_gmtime_r
170 #define localtime posix_localtime
171 #define localtime_r posix_localtime_r
172
173 #define asctime posix_asctime
174 #define asctime_r posix_asctime_r
175 #define ctime posix_ctime
176 #define ctime_r posix_ctime_r
177 #define strftime posix_strftime
178 #define strftime_l posix_strftime_l
179
180 #define clock_getres posix_clock_getres
181 #define clock_gettime posix_clock_gettime
182 #define clock_settime posix_clock_settime
183 #define clock_nanosleep posix_clock_nanosleep
184
185 #define timer_create posix_timer_create
186 #define timer_delete posix_timer_delete
187 #define timer_getoverrun posix_timer_getoverrun
188 #define timer_gettime posix_timer_gettime
189 #define timer_settime posix_timer_settime
190
191 #define clock posix_clock
192#endif
193
194#endif // POSIX_TIME_H_
195
196/** @}
197 */
Note: See TracBrowser for help on using the repository browser.