VirtualBox

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

Last change on this file since 34497 was 33540, checked in by vboxsync, 14 years ago

*: spelling fixes, thanks Timeless!

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 30.6 KB
Line 
1/* $Id: time.cpp 33540 2010-10-28 09:27:05Z 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) * (23*3600 + 47*60 + 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) * (00*3600 + 12*60 + 43) + 145224192 )
57
58
59/*******************************************************************************
60* Global Variables *
61*******************************************************************************/
62/**
63 * Days per month in a common year.
64 */
65static 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 */
74static 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 */
83static 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 */
103static 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 */
128static 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>
194bool isLeapYear(int iYear)
195{
196 return iYear % 4 == 0 && (iYear % 100 != 0 || iYear % 400 == 0);
197}
198void printYear(int iYear, int iLeap)
199{
200 if (!(iYear % 10))
201 printf("\n/" "*%d:*" "/", iYear + 1970);
202 printf(" 365*%4d+%-3d,", iYear, iLeap);
203}
204int 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 */
228DECLINLINE(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 */
243RTDECL(bool) RTTimeIsLeapYear(int32_t i32Year)
244{
245 return rtTimeIsLeapYear(i32Year);
246}
247RT_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 */
257RTDECL(PRTTIME) RTTimeExplode(PRTTIME pTime, PCRTTIMESPEC pTimeSpec)
258{
259 int64_t i64Div;
260 int32_t i32Div;
261 int32_t i32Rem;
262 unsigned iYear;
263 const uint16_t *paiDayOfYear;
264 int iMonth;
265
266 AssertMsg(VALID_PTR(pTime), ("%p\n", pTime));
267 AssertMsg(VALID_PTR(pTimeSpec), ("%p\n", pTime));
268
269 /*
270 * The simple stuff first.
271 */
272 pTime->fFlags = RTTIME_FLAGS_TYPE_UTC;
273 i64Div = pTimeSpec->i64NanosecondsRelativeToUnixEpoch;
274 i32Rem = (int32_t)(i64Div % 1000000000);
275 i64Div /= 1000000000;
276 if (i32Rem < 0)
277 {
278 i32Rem += 1000000000;
279 i64Div--;
280 }
281 pTime->u32Nanosecond = i32Rem;
282
283 /* second */
284 i32Rem = (int32_t)(i64Div % 60);
285 i64Div /= 60;
286 if (i32Rem < 0)
287 {
288 i32Rem += 60;
289 i64Div--;
290 }
291 pTime->u8Second = i32Rem;
292
293 /* minute */
294 i32Div = (int32_t)i64Div; /* 60,000,000,000 > 33bit, so 31bit suffices. */
295 i32Rem = i32Div % 60;
296 i32Div /= 60;
297 if (i32Rem < 0)
298 {
299 i32Rem += 60;
300 i32Div--;
301 }
302 pTime->u8Minute = i32Rem;
303
304 /* hour */
305 i32Rem = i32Div % 24;
306 i32Div /= 24; /* days relative to 1970-01-01 */
307 if (i32Rem < 0)
308 {
309 i32Rem += 24;
310 i32Div--;
311 }
312 pTime->u8Hour = i32Rem;
313
314 /* weekday - 1970-01-01 was a Thursday (3) */
315 pTime->u8WeekDay = ((int)(i32Div % 7) + 3 + 7) % 7;
316
317 /*
318 * We've now got a number of days relative to 1970-01-01.
319 * To get the correct year number we have to mess with leap years. Fortunately,
320 * the representation we've got only supports a few hundred years, so we can
321 * generate a table and perform a simple two way search from the modulus 365 derived.
322 */
323 iYear = OFF_YEAR_IDX_EPOCH + i32Div / 365;
324 while (g_aoffYear[iYear + 1] <= i32Div)
325 iYear++;
326 while (g_aoffYear[iYear] > i32Div)
327 iYear--;
328 pTime->i32Year = iYear + OFF_YEAR_IDX_0_YEAR;
329 i32Div -= g_aoffYear[iYear];
330 pTime->u16YearDay = i32Div + 1;
331
332 /*
333 * Figuring out the month is done in a manner similar to the year, only here we
334 * ensure that the index is matching or too small.
335 */
336 if (rtTimeIsLeapYear(pTime->i32Year))
337 {
338 pTime->fFlags |= RTTIME_FLAGS_LEAP_YEAR;
339 paiDayOfYear = &g_aiDayOfYearLeap[0];
340 }
341 else
342 {
343 pTime->fFlags |= RTTIME_FLAGS_COMMON_YEAR;
344 paiDayOfYear = &g_aiDayOfYear[0];
345 }
346 iMonth = i32Div / 32;
347 i32Div++;
348 while (paiDayOfYear[iMonth + 1] <= i32Div)
349 iMonth++;
350 pTime->u8Month = iMonth + 1;
351 i32Div -= paiDayOfYear[iMonth];
352 pTime->u8MonthDay = i32Div + 1;
353
354 /* This is for UTC timespecs, so, no offset. */
355 pTime->offUTC = 0;
356
357 return pTime;
358}
359RT_EXPORT_SYMBOL(RTTimeExplode);
360
361
362/**
363 * Implodes exploded time to a time spec (UTC).
364 *
365 * @returns pTime on success.
366 * @returns NULL if the pTime data is invalid.
367 * @param pTimeSpec Where to store the imploded UTC time.
368 * If pTime specifies a time which outside the range, maximum or
369 * minimum values will be returned.
370 * @param pTime Pointer to the exploded time to implode.
371 * The fields u8Month, u8WeekDay and u8MonthDay are not used,
372 * and all the other fields are expected to be within their
373 * bounds. Use RTTimeNormalize() to calculate u16YearDay and
374 * normalize the ranges of the fields.
375 */
376RTDECL(PRTTIMESPEC) RTTimeImplode(PRTTIMESPEC pTimeSpec, PCRTTIME pTime)
377{
378 int32_t i32Days;
379 uint32_t u32Secs;
380 int64_t i64Nanos;
381
382 /*
383 * Validate input.
384 */
385 AssertReturn(VALID_PTR(pTimeSpec), NULL);
386 AssertReturn(VALID_PTR(pTime), NULL);
387 AssertReturn(pTime->u32Nanosecond < 1000000000, NULL);
388 AssertReturn(pTime->u8Second < 60, NULL);
389 AssertReturn(pTime->u8Minute < 60, NULL);
390 AssertReturn(pTime->u8Hour < 24, NULL);
391 AssertReturn(pTime->u16YearDay >= 1, NULL);
392 AssertReturn(pTime->u16YearDay <= (rtTimeIsLeapYear(pTime->i32Year) ? 366 : 365), NULL);
393 AssertMsgReturn(pTime->i32Year <= RTTIME_MAX_YEAR && pTime->i32Year >= RTTIME_MIN_YEAR, ("%RI32\n", pTime->i32Year), NULL);
394
395 /*
396 * Do the conversion to nanoseconds.
397 */
398 i32Days = g_aoffYear[pTime->i32Year - OFF_YEAR_IDX_0_YEAR]
399 + pTime->u16YearDay - 1;
400 AssertMsgReturn(i32Days <= RTTIME_MAX_DAY && i32Days >= RTTIME_MIN_DAY, ("%RI32\n", i32Days), NULL);
401
402 u32Secs = pTime->u8Second
403 + pTime->u8Minute * 60
404 + pTime->u8Hour * 3600;
405 i64Nanos = (uint64_t)pTime->u32Nanosecond
406 + u32Secs * UINT64_C(1000000000);
407 AssertMsgReturn(i32Days != RTTIME_MAX_DAY || i64Nanos <= RTTIME_MAX_DAY_NANO, ("%RI64\n", i64Nanos), NULL);
408 AssertMsgReturn(i32Days != RTTIME_MIN_DAY || i64Nanos >= RTTIME_MIN_DAY_NANO, ("%RI64\n", i64Nanos), NULL);
409
410 i64Nanos += i32Days * UINT64_C(86400000000000);
411
412 pTimeSpec->i64NanosecondsRelativeToUnixEpoch = i64Nanos;
413 return pTimeSpec;
414}
415RT_EXPORT_SYMBOL(RTTimeImplode);
416
417
418/**
419 * Internal worker for RTTimeNormalize and RTTimeLocalNormalize.
420 * It doesn't adjust the UCT offset but leaves that for RTTimeLocalNormalize.
421 */
422PRTTIME rtTimeNormalizeInternal(PRTTIME pTime)
423{
424 unsigned uSecond;
425 unsigned uMinute;
426 unsigned uHour;
427 bool fLeapYear;
428
429 /*
430 * Fix the YearDay and Month/MonthDay.
431 */
432 fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
433 if (!pTime->u16YearDay)
434 {
435 /*
436 * The Month+MonthDay must present, overflow adjust them and calc the year day.
437 */
438 AssertMsgReturn( pTime->u8Month
439 && pTime->u8MonthDay,
440 ("date=%d-%d-%d\n", pTime->i32Year, pTime->u8Month, pTime->u8MonthDay),
441 NULL);
442 while (pTime->u8Month > 12)
443 {
444 pTime->u8Month -= 12;
445 pTime->i32Year++;
446 fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
447 pTime->fFlags &= ~(RTTIME_FLAGS_COMMON_YEAR | RTTIME_FLAGS_LEAP_YEAR);
448 }
449
450 for (;;)
451 {
452 unsigned cDaysInMonth = fLeapYear
453 ? g_acDaysInMonthsLeap[pTime->u8Month - 1]
454 : g_acDaysInMonthsLeap[pTime->u8Month - 1];
455 if (pTime->u8MonthDay <= cDaysInMonth)
456 break;
457 pTime->u8MonthDay -= cDaysInMonth;
458 if (pTime->u8Month != 12)
459 pTime->u8Month++;
460 else
461 {
462 pTime->u8Month = 1;
463 pTime->i32Year++;
464 fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
465 pTime->fFlags &= ~(RTTIME_FLAGS_COMMON_YEAR | RTTIME_FLAGS_LEAP_YEAR);
466 }
467 }
468
469 pTime->u16YearDay = pTime->u8MonthDay - 1
470 + (fLeapYear
471 ? g_aiDayOfYearLeap[pTime->u8Month - 1]
472 : g_aiDayOfYear[pTime->u8Month - 1]);
473 }
474 else
475 {
476 /*
477 * Are both YearDay and Month/MonthDay valid?
478 * Check that they don't overflow and match, if not use YearDay (simpler).
479 */
480 bool fRecalc = true;
481 if ( pTime->u8Month
482 && pTime->u8MonthDay)
483 {
484 do
485 {
486 uint16_t u16YearDay;
487
488 /* If you change one, zero the other to make clear what you mean. */
489 AssertBreak(pTime->u8Month <= 12);
490 AssertBreak(pTime->u8MonthDay <= (fLeapYear
491 ? g_acDaysInMonthsLeap[pTime->u8Month - 1]
492 : g_acDaysInMonths[pTime->u8Month - 1]));
493 u16YearDay = pTime->u8MonthDay - 1
494 + (fLeapYear
495 ? g_aiDayOfYearLeap[pTime->u8Month - 1]
496 : g_aiDayOfYear[pTime->u8Month - 1]);
497 AssertBreak(u16YearDay == pTime->u16YearDay);
498 fRecalc = false;
499 } while (0);
500 }
501 if (fRecalc)
502 {
503 const uint16_t *paiDayOfYear;
504
505 /* overflow adjust YearDay */
506 while (pTime->u16YearDay > (fLeapYear ? 366 : 365))
507 {
508 pTime->u16YearDay -= fLeapYear ? 366 : 365;
509 pTime->i32Year++;
510 fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
511 pTime->fFlags &= ~(RTTIME_FLAGS_COMMON_YEAR | RTTIME_FLAGS_LEAP_YEAR);
512 }
513
514 /* calc Month and MonthDay */
515 paiDayOfYear = fLeapYear
516 ? &g_aiDayOfYearLeap[0]
517 : &g_aiDayOfYear[0];
518 pTime->u8Month = 1;
519 while (pTime->u16YearDay > paiDayOfYear[pTime->u8Month])
520 pTime->u8Month++;
521 Assert(pTime->u8Month >= 1 && pTime->u8Month <= 12);
522 pTime->u8MonthDay = pTime->u16YearDay - paiDayOfYear[pTime->u8Month - 1] + 1;
523 }
524 }
525
526 /*
527 * Fixup time overflows.
528 * Use unsigned int values internally to avoid overflows.
529 */
530 uSecond = pTime->u8Second;
531 uMinute = pTime->u8Minute;
532 uHour = pTime->u8Hour;
533
534 while (pTime->u32Nanosecond >= 1000000000)
535 {
536 pTime->u32Nanosecond -= 1000000000;
537 uSecond++;
538 }
539
540 while (uSecond >= 60)
541 {
542 uSecond -= 60;
543 uMinute++;
544 }
545
546 while (uMinute >= 60)
547 {
548 uMinute -= 60;
549 uHour++;
550 }
551
552 while (uHour >= 24)
553 {
554 uHour -= 24;
555
556 /* This is really a RTTimeIncDay kind of thing... */
557 if (pTime->u16YearDay + 1 != (fLeapYear ? g_aiDayOfYearLeap[pTime->u8Month] : g_aiDayOfYear[pTime->u8Month]))
558 {
559 pTime->u16YearDay++;
560 pTime->u8MonthDay++;
561 }
562 else if (pTime->u8Month != 12)
563 {
564 pTime->u16YearDay++;
565 pTime->u8Month++;
566 pTime->u8MonthDay = 1;
567 }
568 else
569 {
570 pTime->i32Year++;
571 fLeapYear = rtTimeIsLeapYear(pTime->i32Year);
572 pTime->fFlags &= ~(RTTIME_FLAGS_COMMON_YEAR | RTTIME_FLAGS_LEAP_YEAR);
573 pTime->u16YearDay = 1;
574 pTime->u8Month = 1;
575 pTime->u8MonthDay = 1;
576 }
577 }
578
579 pTime->u8Second = uSecond;
580 pTime->u8Minute = uMinute;
581 pTime->u8Hour = uHour;
582
583 /*
584 * Correct the leap year flag.
585 * Assert if it's wrong, but ignore if unset.
586 */
587 if (fLeapYear)
588 {
589 Assert(!(pTime->fFlags & RTTIME_FLAGS_COMMON_YEAR));
590 pTime->fFlags &= ~RTTIME_FLAGS_COMMON_YEAR;
591 pTime->fFlags |= RTTIME_FLAGS_LEAP_YEAR;
592 }
593 else
594 {
595 Assert(!(pTime->fFlags & RTTIME_FLAGS_LEAP_YEAR));
596 pTime->fFlags &= ~RTTIME_FLAGS_LEAP_YEAR;
597 pTime->fFlags |= RTTIME_FLAGS_COMMON_YEAR;
598 }
599
600
601 /*
602 * Calc week day.
603 *
604 * 1970-01-01 was a Thursday (3), so find the number of days relative to
605 * that point. We use the table when possible and a slow+stupid+brute-force
606 * algorithm for points outside it. Feel free to optimize the latter by
607 * using some clever formula.
608 */
609 if ( pTime->i32Year >= OFF_YEAR_IDX_0_YEAR
610 && pTime->i32Year < OFF_YEAR_IDX_0_YEAR + (int32_t)RT_ELEMENTS(g_aoffYear))
611 {
612 int32_t offDays = g_aoffYear[pTime->i32Year - OFF_YEAR_IDX_0_YEAR]
613 + pTime->u16YearDay -1;
614 pTime->u8WeekDay = ((offDays % 7) + 3 + 7) % 7;
615 }
616 else
617 {
618 int32_t i32Year = pTime->i32Year;
619 if (i32Year >= 1970)
620 {
621 uint64_t offDays = pTime->u16YearDay - 1;
622 while (--i32Year >= 1970)
623 offDays += rtTimeIsLeapYear(i32Year) ? 366 : 365;
624 pTime->u8WeekDay = (uint8_t)((offDays + 3) % 7);
625 }
626 else
627 {
628 int64_t offDays = (fLeapYear ? -366 - 1 : -365 - 1) + pTime->u16YearDay;
629 while (++i32Year < 1970)
630 offDays -= rtTimeIsLeapYear(i32Year) ? 366 : 365;
631 pTime->u8WeekDay = ((int)(offDays % 7) + 3 + 7) % 7;
632 }
633 }
634 return pTime;
635}
636
637
638/**
639 * Normalizes the fields of a time structure.
640 *
641 * It is possible to calculate year-day from month/day and vice
642 * versa. If you adjust any of these, make sure to zero the
643 * other so you make it clear which of the fields to use. If
644 * it's ambiguous, the year-day field is used (and you get
645 * assertions in debug builds).
646 *
647 * All the time fields and the year-day or month/day fields will
648 * be adjusted for overflows. (Since all fields are unsigned, there
649 * is no underflows.) It is possible to exploit this for simple
650 * date math, though the recommended way of doing that to implode
651 * the time into a timespec and do the math on that.
652 *
653 * @returns pTime on success.
654 * @returns NULL if the data is invalid.
655 *
656 * @param pTime The time structure to normalize.
657 *
658 * @remarks This function doesn't work with local time, only with UTC time.
659 */
660RTDECL(PRTTIME) RTTimeNormalize(PRTTIME pTime)
661{
662 /*
663 * Validate that we've got the minimum of stuff handy.
664 */
665 AssertReturn(VALID_PTR(pTime), NULL);
666 AssertMsgReturn(!(pTime->fFlags & ~RTTIME_FLAGS_MASK), ("%#x\n", pTime->fFlags), NULL);
667 AssertMsgReturn((pTime->fFlags & RTTIME_FLAGS_TYPE_MASK) != RTTIME_FLAGS_TYPE_LOCAL, ("Use RTTimeLocalNormalize!\n"), NULL);
668 AssertMsgReturn(pTime->offUTC == 0, ("%d; Use RTTimeLocalNormalize!\n", pTime->offUTC), NULL);
669
670 pTime = rtTimeNormalizeInternal(pTime);
671 if (pTime)
672 pTime->fFlags |= RTTIME_FLAGS_TYPE_UTC;
673 return pTime;
674}
675RT_EXPORT_SYMBOL(RTTimeNormalize);
676
677
678/**
679 * Converts a time spec to a ISO date string.
680 *
681 * @returns psz on success.
682 * @returns NULL on buffer underflow.
683 * @param pTime The time. Caller should've normalized this.
684 * @param psz Where to store the string.
685 * @param cb The size of the buffer.
686 */
687RTDECL(char *) RTTimeToString(PCRTTIME pTime, char *psz, size_t cb)
688{
689 size_t cch;
690
691 /* (Default to UTC if not specified) */
692 if ( (pTime->fFlags & RTTIME_FLAGS_TYPE_MASK) == RTTIME_FLAGS_TYPE_LOCAL
693 && pTime->offUTC)
694 {
695 int32_t offUTCHour = pTime->offUTC / 60;
696 int32_t offUTCMinute = pTime->offUTC % 60;
697 char chSign;
698 Assert(pTime->offUTC <= 840 && pTime->offUTC >= -840);
699 if (pTime->offUTC >= 0)
700 chSign = '+';
701 else
702 {
703 chSign = '-';
704 offUTCMinute = -offUTCMinute;
705 offUTCHour = -offUTCHour;
706 }
707 cch = RTStrPrintf(psz, cb,
708 "%RI32-%02u-%02uT%02u:%02u:%02u.%09RU32%c%02%02",
709 pTime->i32Year, pTime->u8Month, pTime->u8MonthDay,
710 pTime->u8Hour, pTime->u8Minute, pTime->u8Second, pTime->u32Nanosecond,
711 chSign, offUTCHour, offUTCMinute);
712 if ( cch <= 15
713 || psz[cch - 5] != chSign)
714 return NULL;
715 }
716 else
717 {
718 cch = RTStrPrintf(psz, cb, "%RI32-%02u-%02uT%02u:%02u:%02u.%09RU32Z",
719 pTime->i32Year, pTime->u8Month, pTime->u8MonthDay,
720 pTime->u8Hour, pTime->u8Minute, pTime->u8Second, pTime->u32Nanosecond);
721 if ( cch <= 15
722 || psz[cch - 1] != 'Z')
723 return NULL;
724 }
725 return psz;
726}
727RT_EXPORT_SYMBOL(RTTimeToString);
728
729
730/**
731 * Converts a time spec to a ISO date string.
732 *
733 * @returns psz on success.
734 * @returns NULL on buffer underflow.
735 * @param pTime The time spec.
736 * @param psz Where to store the string.
737 * @param cb The size of the buffer.
738 */
739RTDECL(char *) RTTimeSpecToString(PCRTTIMESPEC pTime, char *psz, size_t cb)
740{
741 RTTIME Time;
742 return RTTimeToString(RTTimeExplode(&Time, pTime), psz, cb);
743}
744RT_EXPORT_SYMBOL(RTTimeSpecToString);
745
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette