dlls/ntdll/time.c

   1 /*
   2  * Nt time functions.
   3  *
   4  * RtlTimeToTimeFields, RtlTimeFieldsToTime and defines are taken from ReactOS and
   5  * adapted to wine with special permissions of the author. This code is
   6  * Copyright 2002 Rex Jolliff (rex@lvcablemodem.com)
   7  *
   8  * Copyright 1999 Juergen Schmied
   9  * Copyright 2007 Dmitry Timoshkov
  10  *
  11  * This library is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public
  13  * License as published by the Free Software Foundation; either
  14  * version 2.1 of the License, or (at your option) any later version.
  15  *
  16  * This library is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with this library; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  24  */
  25
  26 #include <stdarg.h>
  27 #include <stdlib.h>
  28 #include <errno.h>
  29 #include <string.h>
  30 #include <limits.h>
  31 #include <time.h>
  32
  33 #include "ntstatus.h"
  34 #define WIN32_NO_STATUS
  35 #define NONAMELESSUNION
  36 #include "windef.h"
  37 #include "winternl.h"
  38 #include "ddk/wdm.h"
  39 #include "wine/exception.h"
  40 #include "wine/debug.h"
  41 #include "ntdll_misc.h"
  42
  43 WINE_DEFAULT_DEBUG_CHANNEL(ntdll);
  44
  45 #define TICKSPERSEC        10000000
  46 #define TICKSPERMSEC       10000
  47 #define SECSPERDAY         86400
  48 #define SECSPERHOUR        3600
  49 #define SECSPERMIN         60
  50 #define MINSPERHOUR        60
  51 #define HOURSPERDAY        24
  52 #define EPOCHWEEKDAY       1  /* Jan 1, 1601 was Monday */
  53 #define DAYSPERWEEK        7
  54 #define MONSPERYEAR        12
  55 #define DAYSPERQUADRICENTENNIUM (365 * 400 + 97)
  56 #define DAYSPERNORMALQUADRENNIUM (365 * 4 + 1)
  57
  58 /* 1601 to 1970 is 369 years plus 89 leap days */
  59 #define SECS_1601_TO_1970  ((369 * 365 + 89) * (ULONGLONG)SECSPERDAY)
  60 #define TICKS_1601_TO_1970 (SECS_1601_TO_1970 * TICKSPERSEC)
  61 /* 1601 to 1980 is 379 years plus 91 leap days */
  62 #define SECS_1601_TO_1980  ((379 * 365 + 91) * (ULONGLONG)SECSPERDAY)
  63 #define TICKS_1601_TO_1980 (SECS_1601_TO_1980 * TICKSPERSEC)
  64
  65
  66 static const int MonthLengths[2][MONSPERYEAR] =
  67 {
  68         { 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 },
  69         { 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }
  70 };
  71
  72 static inline BOOL IsLeapYear(int Year)
  73 {
  74     return Year % 4 == 0 && (Year % 100 != 0 || Year % 400 == 0);
  75 }
  76
  77
  78 /******************************************************************************
  79  *       RtlTimeToTimeFields [NTDLL.@]
  80  *
  81  * Convert a time into a TIME_FIELDS structure.
  82  *
  83  * PARAMS
  84  *   liTime     [I] Time to convert.
  85  *   TimeFields [O] Destination for the converted time.
  86  *
  87  * RETURNS
  88  *   Nothing.
  89  */
  90 VOID WINAPI RtlTimeToTimeFields(
  91         const LARGE_INTEGER *liTime,
  92         PTIME_FIELDS TimeFields)
  93 {
  94         int SecondsInDay;
  95         long int cleaps, years, yearday, months;
  96         long int Days;
  97         LONGLONG Time;
  98
  99         /* Extract millisecond from time and convert time into seconds */
 100         TimeFields->Milliseconds =
 101             (CSHORT) (( liTime->QuadPart % TICKSPERSEC) / TICKSPERMSEC);
 102         Time = liTime->QuadPart / TICKSPERSEC;
 103
 104         /* The native version of RtlTimeToTimeFields does not take leap seconds
 105          * into account */
 106
 107         /* Split the time into days and seconds within the day */
 108         Days = Time / SECSPERDAY;
 109         SecondsInDay = Time % SECSPERDAY;
 110
 111         /* compute time of day */
 112         TimeFields->Hour = (CSHORT) (SecondsInDay / SECSPERHOUR);
 113         SecondsInDay = SecondsInDay % SECSPERHOUR;
 114         TimeFields->Minute = (CSHORT) (SecondsInDay / SECSPERMIN);
 115         TimeFields->Second = (CSHORT) (SecondsInDay % SECSPERMIN);
 116
 117         /* compute day of week */
 118         TimeFields->Weekday = (CSHORT) ((EPOCHWEEKDAY + Days) % DAYSPERWEEK);
 119
 120         /* compute year, month and day of month. */
 121         cleaps=( 3 * ((4 * Days + 1227) / DAYSPERQUADRICENTENNIUM) + 3 ) / 4;
 122         Days += 28188 + cleaps;
 123         years = (20 * Days - 2442) / (5 * DAYSPERNORMALQUADRENNIUM);
 124         yearday = Days - (years * DAYSPERNORMALQUADRENNIUM)/4;
 125         months = (64 * yearday) / 1959;
 126         /* the result is based on a year starting on March.
 127          * To convert take 12 from Januari and Februari and
 128          * increase the year by one. */
 129         if( months < 14 ) {
 130             TimeFields->Month = months - 1;
 131             TimeFields->Year = years + 1524;
 132         } else {
 133             TimeFields->Month = months - 13;
 134             TimeFields->Year = years + 1525;
 135         }
 136         /* calculation of day of month is based on the wonderful
 137          * sequence of INT( n * 30.6): it reproduces the
 138          * 31-30-31-30-31-31 month lengths exactly for small n's */
 139         TimeFields->Day = yearday - (1959 * months) / 64 ;
 140         return;
 141 }
 142
 143 /******************************************************************************
 144  *       RtlTimeFieldsToTime [NTDLL.@]
 145  *
 146  * Convert a TIME_FIELDS structure into a time.
 147  *
 148  * PARAMS
 149  *   ftTimeFields [I] TIME_FIELDS structure to convert.
 150  *   Time         [O] Destination for the converted time.
 151  *
 152  * RETURNS
 153  *   Success: TRUE.
 154  *   Failure: FALSE.
 155  */
 156 BOOLEAN WINAPI RtlTimeFieldsToTime(
 157         PTIME_FIELDS tfTimeFields,
 158         PLARGE_INTEGER Time)
 159 {
 160         int month, year, cleaps, day;
 161
 162         /* FIXME: normalize the TIME_FIELDS structure here */
 163         /* No, native just returns 0 (error) if the fields are not */
 164         if( tfTimeFields->Milliseconds< 0 || tfTimeFields->Milliseconds > 999 ||
 165                 tfTimeFields->Second < 0 || tfTimeFields->Second > 59 ||
 166                 tfTimeFields->Minute < 0 || tfTimeFields->Minute > 59 ||
 167                 tfTimeFields->Hour < 0 || tfTimeFields->Hour > 23 ||
 168                 tfTimeFields->Month < 1 || tfTimeFields->Month > 12 ||
 169                 tfTimeFields->Day < 1 ||
 170                 tfTimeFields->Day > MonthLengths
 171                     [ tfTimeFields->Month ==2 || IsLeapYear(tfTimeFields->Year)]
 172                     [ tfTimeFields->Month - 1] ||
 173                 tfTimeFields->Year < 1601 )
 174             return FALSE;
 175
 176         /* now calculate a day count from the date
 177          * First start counting years from March. This way the leap days
 178          * are added at the end of the year, not somewhere in the middle.
 179          * Formula's become so much less complicate that way.
 180          * To convert: add 12 to the month numbers of Jan and Feb, and
 181          * take 1 from the year */
 182         if(tfTimeFields->Month < 3) {
 183             month = tfTimeFields->Month + 13;
 184             year = tfTimeFields->Year - 1;
 185         } else {
 186             month = tfTimeFields->Month + 1;
 187             year = tfTimeFields->Year;
 188         }
 189         cleaps = (3 * (year / 100) + 3) / 4;   /* nr of "century leap years"*/
 190         day =  (36525 * year) / 100 - cleaps + /* year * dayperyr, corrected */
 191                  (1959 * month) / 64 +         /* months * daypermonth */
 192                  tfTimeFields->Day -          /* day of the month */
 193                  584817 ;                      /* zero that on 1601-01-01 */
 194         /* done */
 195
 196         Time->QuadPart = (((((LONGLONG) day * HOURSPERDAY +
 197             tfTimeFields->Hour) * MINSPERHOUR +
 198             tfTimeFields->Minute) * SECSPERMIN +
 199             tfTimeFields->Second ) * 1000 +
 200             tfTimeFields->Milliseconds ) * TICKSPERMSEC;
 201
 202         return TRUE;
 203 }
 204
 205
 206 /******************************************************************************
 207  *        RtlLocalTimeToSystemTime [NTDLL.@]
 208  *
 209  * Convert a local time into system time.
 210  *
 211  * PARAMS
 212  *   LocalTime  [I] Local time to convert.
 213  *   SystemTime [O] Destination for the converted time.
 214  *
 215  * RETURNS
 216  *   Success: STATUS_SUCCESS.
 217  *   Failure: An NTSTATUS error code indicating the problem.
 218  */
 219 NTSTATUS WINAPI RtlLocalTimeToSystemTime( const LARGE_INTEGER *LocalTime,
 220                                           PLARGE_INTEGER SystemTime)
 221 {
 222     SYSTEM_TIMEOFDAY_INFORMATION info;
 223
 224     TRACE("(%p, %p)\n", LocalTime, SystemTime);
 225
 226     NtQuerySystemInformation( SystemTimeOfDayInformation, &info, sizeof(info), NULL );
 227     SystemTime->QuadPart = LocalTime->QuadPart + info.TimeZoneBias.QuadPart;
 228     return STATUS_SUCCESS;
 229 }
 230
 231 /******************************************************************************
 232  *       RtlSystemTimeToLocalTime [NTDLL.@]
 233  *
 234  * Convert a system time into a local time.
 235  *
 236  * PARAMS
 237  *   SystemTime [I] System time to convert.
 238  *   LocalTime  [O] Destination for the converted time.
 239  *
 240  * RETURNS
 241  *   Success: STATUS_SUCCESS.
 242  *   Failure: An NTSTATUS error code indicating the problem.
 243  */
 244 NTSTATUS WINAPI RtlSystemTimeToLocalTime( const LARGE_INTEGER *SystemTime,
 245                                           PLARGE_INTEGER LocalTime )
 246 {
 247     SYSTEM_TIMEOFDAY_INFORMATION info;
 248
 249     TRACE("(%p, %p)\n", SystemTime, LocalTime);
 250
 251     NtQuerySystemInformation( SystemTimeOfDayInformation, &info, sizeof(info), NULL );
 252     LocalTime->QuadPart = SystemTime->QuadPart - info.TimeZoneBias.QuadPart;
 253     return STATUS_SUCCESS;
 254 }
 255
 256 /******************************************************************************
 257  *       RtlTimeToSecondsSince1970 [NTDLL.@]
 258  *
 259  * Convert a time into a count of seconds since 1970.
 260  *
 261  * PARAMS
 262  *   Time    [I] Time to convert.
 263  *   Seconds [O] Destination for the converted time.
 264  *
 265  * RETURNS
 266  *   Success: TRUE.
 267  *   Failure: FALSE, if the resulting value will not fit in a DWORD.
 268  */
 269 BOOLEAN WINAPI RtlTimeToSecondsSince1970( const LARGE_INTEGER *Time, LPDWORD Seconds )
 270 {
 271     ULONGLONG tmp = Time->QuadPart / TICKSPERSEC - SECS_1601_TO_1970;
 272     if (tmp > 0xffffffff) return FALSE;
 273     *Seconds = tmp;
 274     return TRUE;
 275 }
 276
 277 /******************************************************************************
 278  *       RtlTimeToSecondsSince1980 [NTDLL.@]
 279  *
 280  * Convert a time into a count of seconds since 1980.
 281  *
 282  * PARAMS
 283  *   Time    [I] Time to convert.
 284  *   Seconds [O] Destination for the converted time.
 285  *
 286  * RETURNS
 287  *   Success: TRUE.
 288  *   Failure: FALSE, if the resulting value will not fit in a DWORD.
 289  */
 290 BOOLEAN WINAPI RtlTimeToSecondsSince1980( const LARGE_INTEGER *Time, LPDWORD Seconds )
 291 {
 292     ULONGLONG tmp = Time->QuadPart / TICKSPERSEC - SECS_1601_TO_1980;
 293     if (tmp > 0xffffffff) return FALSE;
 294     *Seconds = tmp;
 295     return TRUE;
 296 }
 297
 298 /******************************************************************************
 299  *       RtlSecondsSince1970ToTime [NTDLL.@]
 300  *
 301  * Convert a count of seconds since 1970 to a time.
 302  *
 303  * PARAMS
 304  *   Seconds [I] Time to convert.
 305  *   Time    [O] Destination for the converted time.
 306  *
 307  * RETURNS
 308  *   Nothing.
 309  */
 310 void WINAPI RtlSecondsSince1970ToTime( DWORD Seconds, LARGE_INTEGER *Time )
 311 {
 312     Time->QuadPart = Seconds * (ULONGLONG)TICKSPERSEC + TICKS_1601_TO_1970;
 313 }
 314
 315 /******************************************************************************
 316  *       RtlSecondsSince1980ToTime [NTDLL.@]
 317  *
 318  * Convert a count of seconds since 1980 to a time.
 319  *
 320  * PARAMS
 321  *   Seconds [I] Time to convert.
 322  *   Time    [O] Destination for the converted time.
 323  *
 324  * RETURNS
 325  *   Nothing.
 326  */
 327 void WINAPI RtlSecondsSince1980ToTime( DWORD Seconds, LARGE_INTEGER *Time )
 328 {
 329     Time->QuadPart = Seconds * (ULONGLONG)TICKSPERSEC + TICKS_1601_TO_1980;
 330 }
 331
 332 /******************************************************************************
 333  *       RtlTimeToElapsedTimeFields [NTDLL.@]
 334  *
 335  * Convert a time to a count of elapsed seconds.
 336  *
 337  * PARAMS
 338  *   Time       [I] Time to convert.
 339  *   TimeFields [O] Destination for the converted time.
 340  *
 341  * RETURNS
 342  *   Nothing.
 343  */
 344 void WINAPI RtlTimeToElapsedTimeFields( const LARGE_INTEGER *Time, PTIME_FIELDS TimeFields )
 345 {
 346     LONGLONG time;
 347     INT rem;
 348
 349     time = Time->QuadPart / TICKSPERSEC;
 350     TimeFields->Milliseconds = (Time->QuadPart % TICKSPERSEC) / TICKSPERMSEC;
 351
 352     /* time is now in seconds */
 353     TimeFields->Year  = 0;
 354     TimeFields->Month = 0;
 355     TimeFields->Day   = time / SECSPERDAY;
 356
 357     /* rem is now the remaining seconds in the last day */
 358     rem = time % SECSPERDAY;
 359     TimeFields->Second = rem % 60;
 360     rem /= 60;
 361     TimeFields->Minute = rem % 60;
 362     TimeFields->Hour = rem / 60;
 363 }
 364
 365 /***********************************************************************
 366  *       RtlGetSystemTimePrecise [NTDLL.@]
 367  *
 368  * Get a more accurate current system time.
 369  *
 370  * RETURNS
 371  *   The current system time.
 372  */
 373 LONGLONG WINAPI RtlGetSystemTimePrecise( void )
 374 {
 375     return unix_funcs->RtlGetSystemTimePrecise();
 376 }
 377
 378 /******************************************************************************
 379  *  RtlQueryPerformanceCounter   [NTDLL.@]
 380  */
 381 BOOL WINAPI DECLSPEC_HOTPATCH RtlQueryPerformanceCounter( LARGE_INTEGER *counter )
 382 {
 383     NtQueryPerformanceCounter( counter, NULL );
 384     return TRUE;
 385 }
 386
 387 /******************************************************************************
 388  *  RtlQueryPerformanceFrequency   [NTDLL.@]
 389  */
 390 BOOL WINAPI DECLSPEC_HOTPATCH RtlQueryPerformanceFrequency( LARGE_INTEGER *frequency )
 391 {
 392     frequency->QuadPart = TICKSPERSEC;
 393     return TRUE;
 394 }
 395
 396 /******************************************************************************
 397  * NtGetTickCount   (NTDLL.@)
 398  * ZwGetTickCount   (NTDLL.@)
 399  */
 400 ULONG WINAPI DECLSPEC_HOTPATCH NtGetTickCount(void)
 401 {
 402     /* note: we ignore TickCountMultiplier */
 403     return user_shared_data->u.TickCount.LowPart;
 404 }
 405
 406 /***********************************************************************
 407  *      RtlQueryTimeZoneInformation [NTDLL.@]
 408  *
 409  * Get information about the current timezone.
 410  *
 411  * PARAMS
 412  *   tzinfo [O] Destination for the retrieved timezone info.
 413  *
 414  * RETURNS
 415  *   Success: STATUS_SUCCESS.
 416  *   Failure: An NTSTATUS error code indicating the problem.
 417  */
 418 NTSTATUS WINAPI RtlQueryTimeZoneInformation(RTL_TIME_ZONE_INFORMATION *ret)
 419 {
 420     return NtQuerySystemInformation( SystemCurrentTimeZoneInformation, ret, sizeof(*ret), NULL );
 421 }
 422
 423 /***********************************************************************
 424  *      RtlQueryDynamicTimeZoneInformation [NTDLL.@]
 425  *
 426  * Get information about the current timezone.
 427  *
 428  * PARAMS
 429  *   tzinfo [O] Destination for the retrieved timezone info.
 430  *
 431  * RETURNS
 432  *   Success: STATUS_SUCCESS.
 433  *   Failure: An NTSTATUS error code indicating the problem.
 434  */
 435 NTSTATUS WINAPI RtlQueryDynamicTimeZoneInformation(RTL_DYNAMIC_TIME_ZONE_INFORMATION *ret)
 436 {
 437     return NtQuerySystemInformation( SystemDynamicTimeZoneInformation, ret, sizeof(*ret), NULL );
 438 }
 439
 440 /***********************************************************************
 441  *       RtlSetTimeZoneInformation [NTDLL.@]
 442  *
 443  * Set the current time zone information.
 444  *
 445  * PARAMS
 446  *   tzinfo [I] Timezone information to set.
 447  *
 448  * RETURNS
 449  *   Success: STATUS_SUCCESS.
 450  *   Failure: An NTSTATUS error code indicating the problem.
 451  *
 452  */
 453 NTSTATUS WINAPI RtlSetTimeZoneInformation( const RTL_TIME_ZONE_INFORMATION *tzinfo )
 454 {
 455     return STATUS_PRIVILEGE_NOT_HELD;
 456 }
 457
 458 /***********************************************************************
 459  *        RtlQueryUnbiasedInterruptTime [NTDLL.@]
 460  */
 461 BOOL WINAPI RtlQueryUnbiasedInterruptTime(ULONGLONG *time)
 462 {
 463     ULONG high, low;
 464
 465     if (!time)
 466     {
 467         RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_PARAMETER );
 468         return FALSE;
 469     }
 470
 471     do
 472     {
 473         high = user_shared_data->InterruptTime.High1Time;
 474         low = user_shared_data->InterruptTime.LowPart;
 475     }
 476     while (high != user_shared_data->InterruptTime.High2Time);
 477     /* FIXME: should probably subtract InterruptTimeBias */
 478     *time = (ULONGLONG)high << 32 | low;
 479     return TRUE;
 480 }