time.cpp@ 30859

Last change on this file since 30859 was 28800, checked in by vboxsync, 15 years ago
Automated rebranding to Oracle copyright/license strings via filemuncher
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 30.5 KB

Line
1	/* $Id: time.cpp 28800 2010-04-27 08:22:32Z vboxsync $ */
2	/** @file
3	* IPRT - Time.
4	*/
5
6	/*
7	* Copyright (C) 2006-2007 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*/
26
27
28	/*******************************************************************************
29	* Header Files *
30	*******************************************************************************/
31	#define LOG_GROUP RTLOGGROUP_TIME
32	#include <iprt/time.h>
33	#include "internal/iprt.h"
34
35	#include <iprt/string.h>
36	#include <iprt/assert.h>
37	#include "internal/time.h"
38
39
40	/*******************************************************************************
41	* Defined Constants And Macros *
42	*******************************************************************************/
43	/** The max year we possibly could implode. */
44	#define RTTIME_MAX_YEAR (292 + 1970)
45	/** The min year we possibly could implode. */
46	#define RTTIME_MIN_YEAR (-293 + 1970)
47
48	/** The max day supported by our time representation. (2262-04-11T23-47-16.854775807) */
49	#define RTTIME_MAX_DAY (365*292+71 + 101-1)
50	/** The min day supported by our time representation. (1677-09-21T00-12-43.145224192) */
51	#define RTTIME_MIN_DAY (365*-293-70 + 264-1)
52
53	/** The max nano second into the max day. (2262-04-11T23-47-16.854775807) */
54	#define RTTIME_MAX_DAY_NANO ( INT64_C(1000000000) * (233600 + 4760 + 16) + 854775807 )
55	/** The min nano second into the min day. (1677-09-21T00-12-43.145224192) */
56	#define RTTIME_MIN_DAY_NANO ( INT64_C(1000000000) * (003600 + 1260 + 43) + 145224192 )
57
58
59	/*******************************************************************************
60	* Global Variables *
61	*******************************************************************************/
62	/**
63	* Days per month in a common year.
64	*/
65	static const uint8_t g_acDaysInMonths[12] =
66	{
67	/Jan Feb Mar Arp May Jun Jul Aug Sep Oct Nov Dec /
68	31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
69	};
70
71	/**
72	* Days per month in a leap year.
73	*/
74	static const uint8_t g_acDaysInMonthsLeap[12] =
75	{
76	/Jan Feb Mar Arp May Jun Jul Aug Sep Oct Nov Dec /
77	31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
78	};
79
80	/**
81	* The day of year for each month in a common year.
82	*/
83	static const uint16_t g_aiDayOfYear[12 + 1] =
84	{
85	1, /* Jan */
86	1+31, /* Feb */
87	1+31+28, /* Mar */
88	1+31+28+31, /* Apr */
89	1+31+28+31+30, /* May */
90	1+31+28+31+30+31, /* Jun */
91	1+31+28+31+30+31+30, /* Jul */
92	1+31+28+31+30+31+30+31, /* Aug */
93	1+31+28+31+30+31+30+31+31, /* Sep */
94	1+31+28+31+30+31+30+31+31+30, /* Oct */
95	1+31+28+31+30+31+30+31+31+30+31, /* Nov */
96	1+31+28+31+30+31+30+31+31+30+31+30, /* Dec */
97	1+31+28+31+30+31+30+31+31+30+31+30+31
98	};
99
100	/**
101	* The day of year for each month in a leap year.
102	*/
103	static const uint16_t g_aiDayOfYearLeap[12 + 1] =
104	{
105	1, /* Jan */
106	1+31, /* Feb */
107	1+31+29, /* Mar */
108	1+31+29+31, /* Apr */
109	1+31+29+31+30, /* May */
110	1+31+29+31+30+31, /* Jun */
111	1+31+29+31+30+31+30, /* Jul */
112	1+31+29+31+30+31+30+31, /* Aug */
113	1+31+29+31+30+31+30+31+31, /* Sep */
114	1+31+29+31+30+31+30+31+31+30, /* Oct */
115	1+31+29+31+30+31+30+31+31+30+31, /* Nov */
116	1+31+29+31+30+31+30+31+31+30+31+30, /* Dec */
117	1+31+29+31+30+31+30+31+31+30+31+30+31
118	};
119
120	/** The index of 1970 in g_aoffYear */
121	#define OFF_YEAR_IDX_EPOCH 300
122	/** The year of the first index. */
123	#define OFF_YEAR_IDX_0_YEAR 1670
124
125	/**
126	* The number of days the 1st of january a year is offseted from 1970-01-01.
127	*/
128	static const int32_t g_aoffYear[] =
129	{
130	/1670:/ 365-300+-72, 365-299+-72, 365-298+-72, 365-297+-71, 365-296+-71, 365-295+-71, 365-294+-71, 365-293+-70, 365-292+-70, 365-291+-70,
131	/1680:/ 365-290+-70, 365-289+-69, 365-288+-69, 365-287+-69, 365-286+-69, 365-285+-68, 365-284+-68, 365-283+-68, 365-282+-68, 365-281+-67,
132	/1690:/ 365-280+-67, 365-279+-67, 365-278+-67, 365-277+-66, 365-276+-66, 365-275+-66, 365-274+-66, 365-273+-65, 365-272+-65, 365-271+-65,
133	/1700:/ 365-270+-65, 365-269+-65, 365-268+-65, 365-267+-65, 365-266+-65, 365-265+-64, 365-264+-64, 365-263+-64, 365-262+-64, 365-261+-63,
134	/1710:/ 365-260+-63, 365-259+-63, 365-258+-63, 365-257+-62, 365-256+-62, 365-255+-62, 365-254+-62, 365-253+-61, 365-252+-61, 365-251+-61,
135	/1720:/ 365-250+-61, 365-249+-60, 365-248+-60, 365-247+-60, 365-246+-60, 365-245+-59, 365-244+-59, 365-243+-59, 365-242+-59, 365-241+-58,
136	/1730:/ 365-240+-58, 365-239+-58, 365-238+-58, 365-237+-57, 365-236+-57, 365-235+-57, 365-234+-57, 365-233+-56, 365-232+-56, 365-231+-56,
137	/1740:/ 365-230+-56, 365-229+-55, 365-228+-55, 365-227+-55, 365-226+-55, 365-225+-54, 365-224+-54, 365-223+-54, 365-222+-54, 365-221+-53,
138	/1750:/ 365-220+-53, 365-219+-53, 365-218+-53, 365-217+-52, 365-216+-52, 365-215+-52, 365-214+-52, 365-213+-51, 365-212+-51, 365-211+-51,
139	/1760:/ 365-210+-51, 365-209+-50, 365-208+-50, 365-207+-50, 365-206+-50, 365-205+-49, 365-204+-49, 365-203+-49, 365-202+-49, 365-201+-48,
140	/1770:/ 365-200+-48, 365-199+-48, 365-198+-48, 365-197+-47, 365-196+-47, 365-195+-47, 365-194+-47, 365-193+-46, 365-192+-46, 365-191+-46,
141	/1780:/ 365-190+-46, 365-189+-45, 365-188+-45, 365-187+-45, 365-186+-45, 365-185+-44, 365-184+-44, 365-183+-44, 365-182+-44, 365-181+-43,
142	/1790:/ 365-180+-43, 365-179+-43, 365-178+-43, 365-177+-42, 365-176+-42, 365-175+-42, 365-174+-42, 365-173+-41, 365-172+-41, 365-171+-41,
143	/1800:/ 365-170+-41, 365-169+-41, 365-168+-41, 365-167+-41, 365-166+-41, 365-165+-40, 365-164+-40, 365-163+-40, 365-162+-40, 365-161+-39,
144	/1810:/ 365-160+-39, 365-159+-39, 365-158+-39, 365-157+-38, 365-156+-38, 365-155+-38, 365-154+-38, 365-153+-37, 365-152+-37, 365-151+-37,
145	/1820:/ 365-150+-37, 365-149+-36, 365-148+-36, 365-147+-36, 365-146+-36, 365-145+-35, 365-144+-35, 365-143+-35, 365-142+-35, 365-141+-34,
146	/1830:/ 365-140+-34, 365-139+-34, 365-138+-34, 365-137+-33, 365-136+-33, 365-135+-33, 365-134+-33, 365-133+-32, 365-132+-32, 365-131+-32,
147	/1840:/ 365-130+-32, 365-129+-31, 365-128+-31, 365-127+-31, 365-126+-31, 365-125+-30, 365-124+-30, 365-123+-30, 365-122+-30, 365-121+-29,
148	/1850:/ 365-120+-29, 365-119+-29, 365-118+-29, 365-117+-28, 365-116+-28, 365-115+-28, 365-114+-28, 365-113+-27, 365-112+-27, 365-111+-27,
149	/1860:/ 365-110+-27, 365-109+-26, 365-108+-26, 365-107+-26, 365-106+-26, 365-105+-25, 365-104+-25, 365-103+-25, 365-102+-25, 365-101+-24,
150	/1870:/ 365-100+-24, 365 -99+-24, 365* -98+-24, 365* -97+-23, 365* -96+-23, 365* -95+-23, 365* -94+-23, 365* -93+-22, 365* -92+-22, 365* -91+-22,
151	/1880:/ 365* -90+-22, 365* -89+-21, 365* -88+-21, 365* -87+-21, 365* -86+-21, 365* -85+-20, 365* -84+-20, 365* -83+-20, 365* -82+-20, 365* -81+-19,
152	/1890:/ 365* -80+-19, 365* -79+-19, 365* -78+-19, 365* -77+-18, 365* -76+-18, 365* -75+-18, 365* -74+-18, 365* -73+-17, 365* -72+-17, 365* -71+-17,
153	/1900:/ 365* -70+-17, 365* -69+-17, 365* -68+-17, 365* -67+-17, 365* -66+-17, 365* -65+-16, 365* -64+-16, 365* -63+-16, 365* -62+-16, 365* -61+-15,
154	/1910:/ 365* -60+-15, 365* -59+-15, 365* -58+-15, 365* -57+-14, 365* -56+-14, 365* -55+-14, 365* -54+-14, 365* -53+-13, 365* -52+-13, 365* -51+-13,
155	/1920:/ 365* -50+-13, 365* -49+-12, 365* -48+-12, 365* -47+-12, 365* -46+-12, 365* -45+-11, 365* -44+-11, 365* -43+-11, 365* -42+-11, 365* -41+-10,
156	/1930:/ 365* -40+-10, 365* -39+-10, 365* -38+-10, 365* -37+-9 , 365* -36+-9 , 365* -35+-9 , 365* -34+-9 , 365* -33+-8 , 365* -32+-8 , 365* -31+-8 ,
157	/1940:/ 365* -30+-8 , 365* -29+-7 , 365* -28+-7 , 365* -27+-7 , 365* -26+-7 , 365* -25+-6 , 365* -24+-6 , 365* -23+-6 , 365* -22+-6 , 365* -21+-5 ,
158	/1950:/ 365* -20+-5 , 365* -19+-5 , 365* -18+-5 , 365* -17+-4 , 365* -16+-4 , 365* -15+-4 , 365* -14+-4 , 365* -13+-3 , 365* -12+-3 , 365* -11+-3 ,
159	/1960:/ 365* -10+-3 , 365* -9+-2 , 365* -8+-2 , 365* -7+-2 , 365* -6+-2 , 365* -5+-1 , 365* -4+-1 , 365* -3+-1 , 365* -2+-1 , 365* -1+0 ,
160	/1970:/ 365* 0+0 , 365* 1+0 , 365* 2+0 , 365* 3+1 , 365* 4+1 , 365* 5+1 , 365* 6+1 , 365* 7+2 , 365* 8+2 , 365* 9+2 ,
161	/1980:/ 365* 10+2 , 365* 11+3 , 365* 12+3 , 365* 13+3 , 365* 14+3 , 365* 15+4 , 365* 16+4 , 365* 17+4 , 365* 18+4 , 365* 19+5 ,
162	/1990:/ 365* 20+5 , 365* 21+5 , 365* 22+5 , 365* 23+6 , 365* 24+6 , 365* 25+6 , 365* 26+6 , 365* 27+7 , 365* 28+7 , 365* 29+7 ,
163	/2000:/ 365* 30+7 , 365* 31+8 , 365* 32+8 , 365* 33+8 , 365* 34+8 , 365* 35+9 , 365* 36+9 , 365* 37+9 , 365* 38+9 , 365* 39+10 ,
164	/2010:/ 365* 40+10 , 365* 41+10 , 365* 42+10 , 365* 43+11 , 365* 44+11 , 365* 45+11 , 365* 46+11 , 365* 47+12 , 365* 48+12 , 365* 49+12 ,
165	/2020:/ 365* 50+12 , 365* 51+13 , 365* 52+13 , 365* 53+13 , 365* 54+13 , 365* 55+14 , 365* 56+14 , 365* 57+14 , 365* 58+14 , 365* 59+15 ,
166	/2030:/ 365* 60+15 , 365* 61+15 , 365* 62+15 , 365* 63+16 , 365* 64+16 , 365* 65+16 , 365* 66+16 , 365* 67+17 , 365* 68+17 , 365* 69+17 ,
167	/2040:/ 365* 70+17 , 365* 71+18 , 365* 72+18 , 365* 73+18 , 365* 74+18 , 365* 75+19 , 365* 76+19 , 365* 77+19 , 365* 78+19 , 365* 79+20 ,
168	/2050:/ 365* 80+20 , 365* 81+20 , 365* 82+20 , 365* 83+21 , 365* 84+21 , 365* 85+21 , 365* 86+21 , 365* 87+22 , 365* 88+22 , 365* 89+22 ,
169	/2060:/ 365* 90+22 , 365* 91+23 , 365* 92+23 , 365* 93+23 , 365* 94+23 , 365* 95+24 , 365* 96+24 , 365* 97+24 , 365* 98+24 , 365* 99+25 ,
170	/2070:/ 365* 100+25 , 365* 101+25 , 365* 102+25 , 365* 103+26 , 365* 104+26 , 365* 105+26 , 365* 106+26 , 365* 107+27 , 365* 108+27 , 365* 109+27 ,
171	/2080:/ 365* 110+27 , 365* 111+28 , 365* 112+28 , 365* 113+28 , 365* 114+28 , 365* 115+29 , 365* 116+29 , 365* 117+29 , 365* 118+29 , 365* 119+30 ,
172	/2090:/ 365* 120+30 , 365* 121+30 , 365* 122+30 , 365* 123+31 , 365* 124+31 , 365* 125+31 , 365* 126+31 , 365* 127+32 , 365* 128+32 , 365* 129+32 ,
173	/2100:/ 365* 130+32 , 365* 131+32 , 365* 132+32 , 365* 133+32 , 365* 134+32 , 365* 135+33 , 365* 136+33 , 365* 137+33 , 365* 138+33 , 365* 139+34 ,
174	/2110:/ 365* 140+34 , 365* 141+34 , 365* 142+34 , 365* 143+35 , 365* 144+35 , 365* 145+35 , 365* 146+35 , 365* 147+36 , 365* 148+36 , 365* 149+36 ,
175	/2120:/ 365* 150+36 , 365* 151+37 , 365* 152+37 , 365* 153+37 , 365* 154+37 , 365* 155+38 , 365* 156+38 , 365* 157+38 , 365* 158+38 , 365* 159+39 ,
176	/2130:/ 365* 160+39 , 365* 161+39 , 365* 162+39 , 365* 163+40 , 365* 164+40 , 365* 165+40 , 365* 166+40 , 365* 167+41 , 365* 168+41 , 365* 169+41 ,
177	/2140:/ 365* 170+41 , 365* 171+42 , 365* 172+42 , 365* 173+42 , 365* 174+42 , 365* 175+43 , 365* 176+43 , 365* 177+43 , 365* 178+43 , 365* 179+44 ,
178	/2150:/ 365* 180+44 , 365* 181+44 , 365* 182+44 , 365* 183+45 , 365* 184+45 , 365* 185+45 , 365* 186+45 , 365* 187+46 , 365* 188+46 , 365* 189+46 ,
179	/2160:/ 365* 190+46 , 365* 191+47 , 365* 192+47 , 365* 193+47 , 365* 194+47 , 365* 195+48 , 365* 196+48 , 365* 197+48 , 365* 198+48 , 365* 199+49 ,
180	/2170:/ 365* 200+49 , 365* 201+49 , 365* 202+49 , 365* 203+50 , 365* 204+50 , 365* 205+50 , 365* 206+50 , 365* 207+51 , 365* 208+51 , 365* 209+51 ,
181	/2180:/ 365* 210+51 , 365* 211+52 , 365* 212+52 , 365* 213+52 , 365* 214+52 , 365* 215+53 , 365* 216+53 , 365* 217+53 , 365* 218+53 , 365* 219+54 ,
182	/2190:/ 365* 220+54 , 365* 221+54 , 365* 222+54 , 365* 223+55 , 365* 224+55 , 365* 225+55 , 365* 226+55 , 365* 227+56 , 365* 228+56 , 365* 229+56 ,
183	/2200:/ 365* 230+56 , 365* 231+56 , 365* 232+56 , 365* 233+56 , 365* 234+56 , 365* 235+57 , 365* 236+57 , 365* 237+57 , 365* 238+57 , 365* 239+58 ,
184	/2210:/ 365* 240+58 , 365* 241+58 , 365* 242+58 , 365* 243+59 , 365* 244+59 , 365* 245+59 , 365* 246+59 , 365* 247+60 , 365* 248+60 , 365* 249+60 ,
185	/2220:/ 365* 250+60 , 365* 251+61 , 365* 252+61 , 365* 253+61 , 365* 254+61 , 365* 255+62 , 365* 256+62 , 365* 257+62 , 365* 258+62 , 365* 259+63 ,
186	/2230:/ 365* 260+63 , 365* 261+63 , 365* 262+63 , 365* 263+64 , 365* 264+64 , 365* 265+64 , 365* 266+64 , 365* 267+65 , 365* 268+65 , 365* 269+65 ,
187	/2240:/ 365* 270+65 , 365* 271+66 , 365* 272+66 , 365* 273+66 , 365* 274+66 , 365* 275+67 , 365* 276+67 , 365* 277+67 , 365* 278+67 , 365* 279+68 ,
188	/2250:/ 365* 280+68 , 365* 281+68 , 365* 282+68 , 365* 283+69 , 365* 284+69 , 365* 285+69 , 365* 286+69 , 365* 287+70 , 365* 288+70 , 365* 289+70 ,
189	/2260:/ 365* 290+70 , 365* 291+71 , 365* 292+71 , 365* 293+71 , 365* 294+71 , 365* 295+72 , 365* 296+72 , 365* 297+72 , 365* 298+72 , 365* 299+73
190	};
191
192	/* generator code:
193	#include <stdio.h>
194	bool isLeapYear(int iYear)
195	{
196	return iYear % 4 == 0 && (iYear % 100 != 0 \|\| iYear % 400 == 0);
197	}
198	void printYear(int iYear, int iLeap)
199	{
200	if (!(iYear % 10))
201	printf("\n/" "%d:" "/", iYear + 1970);
202	printf(" 365*%4d+%-3d,", iYear, iLeap);
203	}
204	int main()
205	{
206	int iYear = 0;
207	int iLeap = 0;
208	while (iYear > -300)
209	iLeap -= isLeapYear(1970 + --iYear);
210	while (iYear < 300)
211	{
212	printYear(iYear, iLeap);
213	iLeap += isLeapYear(1970 + iYear++);
214	}
215	printf("\n");
216	return 0;
217	}
218	*/
219
220
221	/**
222	* Checks if a year is a leap year or not.
223	*
224	* @returns true if it's a leap year.
225	* @returns false if it's a common year.
226	* @param i32Year The year in question.
227	*/
228	DECLINLINE(bool) rtTimeIsLeapYear(int32_t i32Year)
229	{
230	return i32Year % 4 == 0
231	&& ( i32Year % 100 != 0
232	\|\| i32Year % 400 == 0);
233	}
234
235
236	/**
237	* Checks if a year is a leap year or not.
238	*
239	* @returns true if it's a leap year.
240	* @returns false if it's a common year.
241	* @param i32Year The year in question.
242	*/
243	RTDECL(bool) RTTimeIsLeapYear(int32_t i32Year)
244	{
245	return rtTimeIsLeapYear(i32Year);
246	}
247	RT_EXPORT_SYMBOL(RTTimeIsLeapYear);
248
249
250	/**
251	* Explodes a time spec (UTC).
252	*
253	* @returns pTime.
254	* @param pTime Where to store the exploded time.
255	* @param pTimeSpec The time spec to exploded.
256	*/
257	RTDECL(PRTTIME) RTTimeExplode(PRTTIME pTime, PCRTTIMESPEC pTimeSpec)
258	{
259	AssertMsg(VALID_PTR(pTime), ("%p\n", pTime));
260	AssertMsg(VALID_PTR(pTimeSpec), ("%p\n", pTime));
261
262	/*
263	* The simple stuff first.
264	*/
265	pTime->fFlags = RTTIME_FLAGS_TYPE_UTC;
266	int64_t i64Div = pTimeSpec->i64NanosecondsRelativeToUnixEpoch;
267	int32_t i32Rem = (int32_t)(i64Div % 1000000000);
268	i64Div /= 1000000000;
269	if (i32Rem < 0)
270	{
271	i32Rem += 1000000000;
272	i64Div--;
273	}
274	pTime->u32Nanosecond = i32Rem;
275
276	/* second */
277	i32Rem = (int32_t)(i64Div % 60);
278	i64Div /= 60;
279	if (i32Rem < 0)
280	{
281	i32Rem += 60;
282	i64Div--;
283	}
284	pTime->u8Second = i32Rem;
285
286	/* minute */
287	int32_t i32Div = (int32_t)i64Div; /* 60,000,000,000 > 33bit, so 31bit suffices. */
288	i32Rem = i32Div % 60;
289	i32Div /= 60;
290	if (i32Rem < 0)
291	{
292	i32Rem += 60;
293	i32Div--;
294	}
295	pTime->u8Minute = i32Rem;
296
297	/* hour */
298	i32Rem = i32Div % 24;
299	i32Div /= 24; /* days relative to 1970-01-01 */
300	if (i32Rem < 0)
301	{
302	i32Rem += 24;
303	i32Div--;
304	}
305	pTime->u8Hour = i32Rem;
306
307	/* weekday - 1970-01-01 was a Thursday (3) */
308	pTime->u8WeekDay = ((int)(i32Div % 7) + 3 + 7) % 7;
309
310	/*
311	* We've now got a number of days relative to 1970-01-01.
312	* To get the correct year number we have to mess with leap years. Fortunatly,
313	* the represenation we've got only supports a few hundred years, so we can
314	* generate a table and perform a simple two way search from the modulus 365 derived.
315	*/
316	unsigned iYear = OFF_YEAR_IDX_EPOCH + i32Div / 365;
317	while (g_aoffYear[iYear + 1] <= i32Div)
318	iYear++;
319	while (g_aoffYear[iYear] > i32Div)
320	iYear--;
321	pTime->i32Year = iYear + OFF_YEAR_IDX_0_YEAR;
322	i32Div -= g_aoffYear[iYear];
323	pTime->u16YearDay = i32Div + 1;
324
325	/*
326	* Figuring out the month is done in a manner similar to the year, only here we
327	* ensure that the index is matching or too small.
328	*/
329	const uint16_t *paiDayOfYear;
330	if (rtTimeIsLeapYear(pTime->i32Year))
331	{
332	pTime->fFlags \|= RTTIME_FLAGS_LEAP_YEAR;
333	paiDayOfYear = &g_aiDayOfYearLeap[0];
334	}
335	else
336	{
337	pTime->fFlags \|= RTTIME_FLAGS_COMMON_YEAR;
338	paiDayOfYear = &g_aiDayOfYear[0];
339	}
340	int iMonth = i32Div / 32;
341	i32Div++;
342	while (paiDayOfYear[iMonth + 1] <= i32Div)
343	iMonth++;
344	pTime->u8Month = iMonth + 1;
345	i32Div -= paiDayOfYear[iMonth];
346	pTime->u8MonthDay = i32Div + 1;
347
348	/* This is for UTC timespecs, so, no offset. */
349	pTime->offUTC = 0;
350
351	return pTime;
352	}
353	RT_EXPORT_SYMBOL(RTTimeExplode);
354
355
356	/**
357	* Implodes exploded time to a time spec (UTC).
358	*
359	* @returns pTime on success.
360	* @returns NULL if the pTime data is invalid.
361	* @param pTimeSpec Where to store the imploded UTC time.
362	* If pTime specifies a time which outside the range, maximum or
363	* minimum values will be returned.
364	* @param pTime Pointer to the exploded time to implode.
365	* The fields u8Month, u8WeekDay and u8MonthDay are not used,
366	* and all the other fields are expected to be within their
367	* bounds. Use RTTimeNormalize() to calculate u16YearDay and
368	* normalize the ranges of the fields.
369	*/
370	RTDECL(PRTTIMESPEC) RTTimeImplode(PRTTIMESPEC pTimeSpec, PCRTTIME pTime)
371	{
372	/*
373	* Validate input.
374	*/
375	AssertReturn(VALID_PTR(pTimeSpec), NULL);
376	AssertReturn(VALID_PTR(pTime), NULL);
377	AssertReturn(pTime->u32Nanosecond < 1000000000, NULL);
378	AssertReturn(pTime->u8Second < 60, NULL);
379	AssertReturn(pTime->u8Minute < 60, NULL);
380	AssertReturn(pTime->u8Hour < 24, NULL);
381	AssertReturn(pTime->u16YearDay >= 1, NULL);
382	AssertReturn(pTime->u16YearDay <= (rtTimeIsLeapYear(pTime->i32Year) ? 366 : 365), NULL);
383	AssertMsgReturn(pTime->i32Year <= RTTIME_MAX_YEAR && pTime->i32Year >= RTTIME_MIN_YEAR, ("%RI32\n", pTime->i32Year), NULL);
384
385	/*
386	* Do the conversion to nanoseconds.
387	*/
388	int32_t i32Days = g_aoffYear[pTime->i32Year - OFF_YEAR_IDX_0_YEAR]
389	+ pTime->u16YearDay - 1;
390	AssertMsgReturn(i32Days <= RTTIME_MAX_DAY && i32Days >= RTTIME_MIN_DAY, ("%RI32\n", i32Days), NULL);
391
392	uint32_t u32Secs = pTime->u8Second
393	+ pTime->u8Minute * 60
394	+ pTime->u8Hour * 3600;
395	int64_t i64Nanos = (uint64_t)pTime->u32Nanosecond
396	+ u32Secs * UINT64_C(1000000000);
397	AssertMsgReturn(i32Days != RTTIME_MAX_DAY \|\| i64Nanos <= RTTIME_MAX_DAY_NANO, ("%RI64\n", i64Nanos), NULL);
398	AssertMsgReturn(i32Days != RTTIME_MIN_DAY \|\| i64Nanos >= RTTIME_MIN_DAY_NANO, ("%RI64\n", i64Nanos), NULL);
399
400	i64Nanos += i32Days * UINT64_C(86400000000000);
401
402	pTimeSpec->i64NanosecondsRelativeToUnixEpoch = i64Nanos;
403	return pTimeSpec;
404	}
405	RT_EXPORT_SYMBOL(RTTimeImplode);
406
407
408	/**
409	* Internal worker for RTTimeNormalize and RTTimeLocalNormalize.
410	* It doesn't adjust the UCT offset but leaves that for RTTimeLocalNormalize.
411	*/
412	PRTTIME rtTimeNormalizeInternal(PRTTIME pTime)
413	{
414	/*
415	* Fix the YearDay and Month/MonthDay.
416	*/
417	bool fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
418	if (!pTime->u16YearDay)
419	{
420	/*
421	* The Month+MonthDay must present, overflow adjust them and calc the year day.
422	*/
423	AssertMsgReturn( pTime->u8Month
424	&& pTime->u8MonthDay,
425	("date=%d-%d-%d\n", pTime->i32Year, pTime->u8Month, pTime->u8MonthDay),
426	NULL);
427	while (pTime->u8Month > 12)
428	{
429	pTime->u8Month -= 12;
430	pTime->i32Year++;
431	fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
432	pTime->fFlags &= ~(RTTIME_FLAGS_COMMON_YEAR \| RTTIME_FLAGS_LEAP_YEAR);
433	}
434
435	for (;;)
436	{
437	unsigned cDaysInMonth = fLeapYear
438	? g_acDaysInMonthsLeap[pTime->u8Month - 1]
439	: g_acDaysInMonthsLeap[pTime->u8Month - 1];
440	if (pTime->u8MonthDay <= cDaysInMonth)
441	break;
442	pTime->u8MonthDay -= cDaysInMonth;
443	if (pTime->u8Month != 12)
444	pTime->u8Month++;
445	else
446	{
447	pTime->u8Month = 1;
448	pTime->i32Year++;
449	fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
450	pTime->fFlags &= ~(RTTIME_FLAGS_COMMON_YEAR \| RTTIME_FLAGS_LEAP_YEAR);
451	}
452	}
453
454	pTime->u16YearDay = pTime->u8MonthDay - 1
455	+ (fLeapYear
456	? g_aiDayOfYearLeap[pTime->u8Month - 1]
457	: g_aiDayOfYear[pTime->u8Month - 1]);
458	}
459	else
460	{
461	/*
462	* Are both YearDay and Month/MonthDay valid?
463	* Check that they don't overflow and match, if not use YearDay (simpler).
464	*/
465	bool fRecalc = true;
466	if ( pTime->u8Month
467	&& pTime->u8MonthDay)
468	{
469	do
470	{
471	/* If you change one, zero the other to make clear what you mean. */
472	AssertBreak(pTime->u8Month <= 12);
473	AssertBreak(pTime->u8MonthDay <= (fLeapYear
474	? g_acDaysInMonthsLeap[pTime->u8Month - 1]
475	: g_acDaysInMonths[pTime->u8Month - 1]));
476	uint16_t u16YearDay = pTime->u8MonthDay - 1
477	+ (fLeapYear
478	? g_aiDayOfYearLeap[pTime->u8Month - 1]
479	: g_aiDayOfYear[pTime->u8Month - 1]);
480	AssertBreak(u16YearDay == pTime->u16YearDay);
481	fRecalc = false;
482	} while (0);
483	}
484	if (fRecalc)
485	{
486	/* overflow adjust YearDay */
487	while (pTime->u16YearDay > (fLeapYear ? 366 : 365))
488	{
489	pTime->u16YearDay -= fLeapYear ? 366 : 365;
490	pTime->i32Year++;
491	fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
492	pTime->fFlags &= ~(RTTIME_FLAGS_COMMON_YEAR \| RTTIME_FLAGS_LEAP_YEAR);
493	}
494
495	/* calc Month and MonthDay */
496	const uint16_t *paiDayOfYear = fLeapYear
497	? &g_aiDayOfYearLeap[0]
498	: &g_aiDayOfYear[0];
499	pTime->u8Month = 1;
500	while (pTime->u16YearDay > paiDayOfYear[pTime->u8Month])
501	pTime->u8Month++;
502	Assert(pTime->u8Month >= 1 && pTime->u8Month <= 12);
503	pTime->u8MonthDay = pTime->u16YearDay - paiDayOfYear[pTime->u8Month - 1] + 1;
504	}
505	}
506
507	/*
508	* Fixup time overflows.
509	* Use unsigned int values internally to avoid overflows.
510	*/
511	unsigned uSecond = pTime->u8Second;
512	unsigned uMinute = pTime->u8Minute;
513	unsigned uHour = pTime->u8Hour;
514
515	while (pTime->u32Nanosecond >= 1000000000)
516	{
517	pTime->u32Nanosecond -= 1000000000;
518	uSecond++;
519	}
520
521	while (uSecond >= 60)
522	{
523	uSecond -= 60;
524	uMinute++;
525	}
526
527	while (uMinute >= 60)
528	{
529	uMinute -= 60;
530	uHour++;
531	}
532
533	while (uHour >= 24)
534	{
535	uHour -= 24;
536
537	/* This is really a RTTimeIncDay kind of thing... */
538	if (pTime->u16YearDay + 1 != (fLeapYear ? g_aiDayOfYearLeap[pTime->u8Month] : g_aiDayOfYear[pTime->u8Month]))
539	{
540	pTime->u16YearDay++;
541	pTime->u8MonthDay++;
542	}
543	else if (pTime->u8Month != 12)
544	{
545	pTime->u16YearDay++;
546	pTime->u8Month++;
547	pTime->u8MonthDay = 1;
548	}
549	else
550	{
551	pTime->i32Year++;
552	fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
553	pTime->fFlags &= ~(RTTIME_FLAGS_COMMON_YEAR \| RTTIME_FLAGS_LEAP_YEAR);
554	pTime->u16YearDay = 1;
555	pTime->u8Month = 1;
556	pTime->u8MonthDay = 1;
557	}
558	}
559
560	pTime->u8Second = uSecond;
561	pTime->u8Minute = uMinute;
562	pTime->u8Hour = uHour;
563
564	/*
565	* Correct the leap year flag.
566	* Assert if it's wrong, but ignore if unset.
567	*/
568	if (fLeapYear)
569	{
570	Assert(!(pTime->fFlags & RTTIME_FLAGS_COMMON_YEAR));
571	pTime->fFlags &= ~RTTIME_FLAGS_COMMON_YEAR;
572	pTime->fFlags \|= RTTIME_FLAGS_LEAP_YEAR;
573	}
574	else
575	{
576	Assert(!(pTime->fFlags & RTTIME_FLAGS_LEAP_YEAR));
577	pTime->fFlags &= ~RTTIME_FLAGS_LEAP_YEAR;
578	pTime->fFlags \|= RTTIME_FLAGS_COMMON_YEAR;
579	}
580
581
582	/*
583	* Calc week day.
584	*
585	* 1970-01-01 was a Thursday (3), so find the number of days relative to
586	* that point. We use the table when possible and a slow+stupid+brute-force
587	* algorithm for points outside it. Feel free to optimize the latter by
588	* using some clever formula.
589	*/
590	if ( pTime->i32Year >= OFF_YEAR_IDX_0_YEAR
591	&& pTime->i32Year < OFF_YEAR_IDX_0_YEAR + (int32_t)RT_ELEMENTS(g_aoffYear))
592	{
593	int32_t offDays = g_aoffYear[pTime->i32Year - OFF_YEAR_IDX_0_YEAR]
594	+ pTime->u16YearDay -1;
595	pTime->u8WeekDay = ((offDays % 7) + 3 + 7) % 7;
596	}
597	else
598	{
599	int32_t i32Year = pTime->i32Year;
600	if (i32Year >= 1970)
601	{
602	uint64_t offDays = pTime->u16YearDay - 1;
603	while (--i32Year >= 1970)
604	offDays += rtTimeIsLeapYear(i32Year) ? 366 : 365;
605	pTime->u8WeekDay = (uint8_t)((offDays + 3) % 7);
606	}
607	else
608	{
609	int64_t offDays = (fLeapYear ? -366 - 1 : -365 - 1) + pTime->u16YearDay;
610	while (++i32Year < 1970)
611	offDays -= rtTimeIsLeapYear(i32Year) ? 366 : 365;
612	pTime->u8WeekDay = ((int)(offDays % 7) + 3 + 7) % 7;
613	}
614	}
615	return pTime;
616	}
617
618
619	/**
620	* Normalizes the fields of a time structure.
621	*
622	* It is possible to calculate year-day from month/day and vice
623	* versa. If you adjust any of these, make sure to zero the
624	* other so you make it clear which of the fields to use. If
625	* it's ambiguous, the year-day field is used (and you get
626	* assertions in debug builds).
627	*
628	* All the time fields and the year-day or month/day fields will
629	* be adjusted for overflows. (Since all fields are unsigned, there
630	* is no underflows.) It is possible to exploit this for simple
631	* date math, though the recommended way of doing that to implode
632	* the time into a timespec and do the math on that.
633	*
634	* @returns pTime on success.
635	* @returns NULL if the data is invalid.
636	*
637	* @param pTime The time structure to normalize.
638	*
639	* @remarks This function doesn't work with local time, only with UTC time.
640	*/
641	RTDECL(PRTTIME) RTTimeNormalize(PRTTIME pTime)
642	{
643	/*
644	* Validate that we've got the minium of stuff handy.
645	*/
646	AssertReturn(VALID_PTR(pTime), NULL);
647	AssertMsgReturn(!(pTime->fFlags & ~RTTIME_FLAGS_MASK), ("%#x\n", pTime->fFlags), NULL);
648	AssertMsgReturn((pTime->fFlags & RTTIME_FLAGS_TYPE_MASK) != RTTIME_FLAGS_TYPE_LOCAL, ("Use RTTimeLocalNormalize!\n"), NULL);
649	AssertMsgReturn(pTime->offUTC == 0, ("%d; Use RTTimeLocalNormalize!\n", pTime->offUTC), NULL);
650
651	pTime = rtTimeNormalizeInternal(pTime);
652	if (pTime)
653	pTime->fFlags \|= RTTIME_FLAGS_TYPE_UTC;
654	return pTime;
655	}
656	RT_EXPORT_SYMBOL(RTTimeNormalize);
657
658
659	/**
660	* Converts a time spec to a ISO date string.
661	*
662	* @returns psz on success.
663	* @returns NULL on buffer underflow.
664	* @param pTime The time. Caller should've normalized this.
665	* @param psz Where to store the string.
666	* @param cb The size of the buffer.
667	*/
668	RTDECL(char ) RTTimeToString(PCRTTIME pTime, char psz, size_t cb)
669	{
670	/* (Default to UTC if not specified) */
671	if ( (pTime->fFlags & RTTIME_FLAGS_TYPE_MASK) == RTTIME_FLAGS_TYPE_LOCAL
672	&& pTime->offUTC)
673	{
674	Assert(pTime->offUTC <= 840 && pTime->offUTC >= -840);
675	int32_t offUTCHour = pTime->offUTC / 60;
676	int32_t offUTCMinute = pTime->offUTC % 60;
677	char chSign;
678	if (pTime->offUTC >= 0)
679	chSign = '+';
680	else
681	{
682	chSign = '-';
683	offUTCMinute = -offUTCMinute;
684	offUTCHour = -offUTCHour;
685	}
686	size_t cch = RTStrPrintf(psz, cb,
687	"%RI32-%02u-%02uT%02u:%02u:%02u.%09RU32%c%02%02",
688	pTime->i32Year, pTime->u8Month, pTime->u8MonthDay,
689	pTime->u8Hour, pTime->u8Minute, pTime->u8Second, pTime->u32Nanosecond,
690	chSign, offUTCHour, offUTCMinute);
691	if ( cch <= 15
692	\|\| psz[cch - 5] != chSign)
693	return NULL;
694	}
695	else
696	{
697	size_t cch = RTStrPrintf(psz, cb, "%RI32-%02u-%02uT%02u:%02u:%02u.%09RU32Z",
698	pTime->i32Year, pTime->u8Month, pTime->u8MonthDay,
699	pTime->u8Hour, pTime->u8Minute, pTime->u8Second, pTime->u32Nanosecond);
700	if ( cch <= 15
701	\|\| psz[cch - 1] != 'Z')
702	return NULL;
703	}
704	return psz;
705	}
706	RT_EXPORT_SYMBOL(RTTimeToString);
707
708
709	/**
710	* Converts a time spec to a ISO date string.
711	*
712	* @returns psz on success.
713	* @returns NULL on buffer underflow.
714	* @param pTime The time spec.
715	* @param psz Where to store the string.
716	* @param cb The size of the buffer.
717	*/
718	RTDECL(char ) RTTimeSpecToString(PCRTTIMESPEC pTime, char psz, size_t cb)
719	{
720	RTTIME Time;
721	return RTTimeToString(RTTimeExplode(&Time, pTime), psz, cb);
722	}
723	RT_EXPORT_SYMBOL(RTTimeSpecToString);
724

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Runtime/common/time/time.cpp@ 30859

Download in other formats: