git.sesse.net Git - vlc/blob - src/misc/mtime.c

   1 /*****************************************************************************
   2  * mtime.c: high resolution time management functions
   3  * Functions are prototyped in vlc_mtime.h.
   4  *****************************************************************************
   5  * Copyright (C) 1998-2007 the VideoLAN team
   6  * Copyright © 2006-2007 Rémi Denis-Courmont
   7  * $Id$
   8  *
   9  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10  *          Rémi Denis-Courmont <rem$videolan,org>
  11  *          Gisle Vanem
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  26  *****************************************************************************/
  27
  28 /*****************************************************************************
  29  * Preamble
  30  *****************************************************************************/
  31
  32 #include <vlc/vlc.h>
  33
  34 #include <time.h>                      /* clock_gettime(), clock_nanosleep() */
  35 #include <assert.h>
  36 #include <errno.h>
  37
  38
  39 #if defined( PTH_INIT_IN_PTH_H )                                  /* GNU Pth */
  40 #   include <pth.h>
  41 #endif
  42
  43 #ifdef HAVE_UNISTD_H
  44 #   include <unistd.h>                                           /* select() */
  45 #endif
  46
  47 #ifdef HAVE_KERNEL_OS_H
  48 #   include <kernel/OS.h>
  49 #endif
  50
  51 #if defined( WIN32 ) || defined( UNDER_CE )
  52 #   include <windows.h>
  53 #endif
  54 #if defined(HAVE_SYS_TIME_H)
  55 #   include <sys/time.h>
  56 #endif
  57
  58 #if !defined(HAVE_STRUCT_TIMESPEC)
  59 struct timespec
  60 {
  61     time_t  tv_sec;
  62     int32_t tv_nsec;
  63 };
  64 #endif
  65
  66 #if defined(HAVE_NANOSLEEP) && !defined(HAVE_DECL_NANOSLEEP)
  67 int nanosleep(struct timespec *, struct timespec *);
  68 #endif
  69
  70 #ifdef HAVE_CLOCK_NANOSLEEP
  71 #  if !defined _POSIX_CLOCK_SELECTION || (_POSIX_CLOCK_SELECTION - 0 <= 0)
  72 /*
  73  * We cannot use the monotonic clock is clock selection is not available,
  74  * as it would screw vlc_cond_timedwait() completely. Instead, we have to
  75  * stick to the realtime clock. Nevermind it screws everything when ntpdate
  76  * warps the wall clock.
  77  */
  78 #    undef CLOCK_MONOTONIC
  79 #    define CLOCK_MONOTONIC CLOCK_REALTIME
  80 #  endif
  81 #endif
  82
  83 /**
  84  * Return a date in a readable format
  85  *
  86  * This function converts a mtime date into a string.
  87  * psz_buffer should be a buffer long enough to store the formatted
  88  * date.
  89  * \param date to be converted
  90  * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
  91  * \return psz_buffer is returned so this can be used as printf parameter.
  92  */
  93 char *mstrtime( char *psz_buffer, mtime_t date )
  94 {
  95     static mtime_t ll1000 = 1000, ll60 = 60, ll24 = 24;
  96
  97     snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%02d:%02d:%02d-%03d.%03d",
  98              (int) (date / (ll1000 * ll1000 * ll60 * ll60) % ll24),
  99              (int) (date / (ll1000 * ll1000 * ll60) % ll60),
 100              (int) (date / (ll1000 * ll1000) % ll60),
 101              (int) (date / ll1000 % ll1000),
 102              (int) (date % ll1000) );
 103     return( psz_buffer );
 104 }
 105
 106 /**
 107  * Convert seconds to a time in the format h:mm:ss.
 108  *
 109  * This function is provided for any interface function which need to print a
 110  * time string in the format h:mm:ss
 111  * date.
 112  * \param secs  the date to be converted
 113  * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
 114  * \return psz_buffer is returned so this can be used as printf parameter.
 115  */
 116 char *secstotimestr( char *psz_buffer, int i_seconds )
 117 {
 118     int i_hours, i_mins;
 119     i_mins = i_seconds / 60;
 120     i_hours = i_mins / 60 ;
 121     if( i_hours )
 122     {
 123         snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%d:%2.2d:%2.2d",
 124                  (int) i_hours,
 125                  (int) (i_mins % 60),
 126                  (int) (i_seconds % 60) );
 127     }
 128     else
 129     {
 130          snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%2.2d:%2.2d",
 131                    (int) i_mins ,
 132                    (int) (i_seconds % 60) );
 133     }
 134     return( psz_buffer );
 135 }
 136
 137 /**
 138  * Return a value that is no bigger than the clock precision
 139  * (possibly zero).
 140  */
 141 static inline unsigned mprec( void )
 142 {
 143 #if defined (HAVE_CLOCK_NANOSLEEP)
 144     struct timespec ts;
 145     if( clock_getres( CLOCK_MONOTONIC, &ts ))
 146         clock_getres( CLOCK_REALTIME, &ts );
 147
 148     return ts.tv_nsec / 1000;
 149 #endif
 150     return 0;
 151 }
 152
 153 static unsigned prec = 0;
 154 static volatile mtime_t cached_time = 0;
 155
 156 /**
 157  * Return high precision date
 158  *
 159  * Uses the gettimeofday() function when possible (1 MHz resolution) or the
 160  * ftime() function (1 kHz resolution).
 161  */
 162 mtime_t mdate( void )
 163 {
 164     mtime_t res;
 165
 166 #if defined (HAVE_CLOCK_NANOSLEEP)
 167     struct timespec ts;
 168
 169     /* Try to use POSIX monotonic clock if available */
 170     if( clock_gettime( CLOCK_MONOTONIC, &ts ) == EINVAL )
 171         /* Run-time fallback to real-time clock (always available) */
 172         (void)clock_gettime( CLOCK_REALTIME, &ts );
 173
 174     res = ((mtime_t)ts.tv_sec * (mtime_t)1000000)
 175            + (mtime_t)(ts.tv_nsec / 1000);
 176
 177 #elif defined( HAVE_KERNEL_OS_H )
 178     res = real_time_clock_usecs();
 179
 180 #elif defined( WIN32 ) || defined( UNDER_CE )
 181     /* We don't need the real date, just the value of a high precision timer */
 182     static mtime_t freq = I64C(-1);
 183
 184     if( freq == I64C(-1) )
 185     {
 186         /* Extract from the Tcl source code:
 187          * (http://www.cs.man.ac.uk/fellowsd-bin/TIP/7.html)
 188          *
 189          * Some hardware abstraction layers use the CPU clock
 190          * in place of the real-time clock as a performance counter
 191          * reference.  This results in:
 192          *    - inconsistent results among the processors on
 193          *      multi-processor systems.
 194          *    - unpredictable changes in performance counter frequency
 195          *      on "gearshift" processors such as Transmeta and
 196          *      SpeedStep.
 197          * There seems to be no way to test whether the performance
 198          * counter is reliable, but a useful heuristic is that
 199          * if its frequency is 1.193182 MHz or 3.579545 MHz, it's
 200          * derived from a colorburst crystal and is therefore
 201          * the RTC rather than the TSC.  If it's anything else, we
 202          * presume that the performance counter is unreliable.
 203          */
 204         LARGE_INTEGER buf;
 205
 206         freq = ( QueryPerformanceFrequency( &buf ) &&
 207                  (buf.QuadPart == I64C(1193182) || buf.QuadPart == I64C(3579545) ) )
 208                ? buf.QuadPart : 0;
 209     }
 210
 211     if( freq != 0 )
 212     {
 213         LARGE_INTEGER counter;
 214         QueryPerformanceCounter (&counter);
 215
 216         /* Convert to from (1/freq) to microsecond resolution */
 217         /* We need to split the division to avoid 63-bits overflow */
 218         lldiv_t d = lldiv (counter.QuadPart, freq);
 219
 220         res = (d.quot * 1000000) + ((d.rem * 1000000) / freq);
 221     }
 222     else
 223     {
 224         /* Fallback on GetTickCount() which has a milisecond resolution
 225          * (actually, best case is about 10 ms resolution)
 226          * GetTickCount() only returns a DWORD thus will wrap after
 227          * about 49.7 days so we try to detect the wrapping. */
 228
 229         static CRITICAL_SECTION date_lock;
 230         static mtime_t i_previous_time = I64C(-1);
 231         static int i_wrap_counts = -1;
 232
 233         if( i_wrap_counts == -1 )
 234         {
 235             /* Initialization */
 236             i_previous_time = I64C(1000) * GetTickCount();
 237             InitializeCriticalSection( &date_lock );
 238             i_wrap_counts = 0;
 239         }
 240
 241         EnterCriticalSection( &date_lock );
 242         res = I64C(1000) *
 243             (i_wrap_counts * I64C(0x100000000) + GetTickCount());
 244         if( i_previous_time > res )
 245         {
 246             /* Counter wrapped */
 247             i_wrap_counts++;
 248             res += I64C(0x100000000) * 1000;
 249         }
 250         i_previous_time = res;
 251         LeaveCriticalSection( &date_lock );
 252     }
 253 #else
 254     struct timeval tv_date;
 255
 256     /* gettimeofday() cannot fail given &tv_date is a valid address */
 257     (void)gettimeofday( &tv_date, NULL );
 258     res = (mtime_t) tv_date.tv_sec * 1000000 + (mtime_t) tv_date.tv_usec;
 259 #endif
 260
 261     return cached_time = res;
 262 }
 263
 264 /**
 265  * Wait for a date
 266  *
 267  * This function uses select() and an system date function to wake up at a
 268  * precise date. It should be used for process synchronization. If current date
 269  * is posterior to wished date, the function returns immediately.
 270  * \param date The date to wake up at
 271  */
 272 void mwait( mtime_t date )
 273 {
 274     if( prec == 0 )
 275         prec = mprec();
 276
 277     /* If the deadline is already elapsed, or within the clock precision,
 278      * do not even bother the clock. */
 279     if( ( date - cached_time ) < (mtime_t)prec ) // OK: mtime_t is signed
 280         return;
 281
 282 #if 0 && defined (HAVE_CLOCK_NANOSLEEP)
 283     lldiv_t d = lldiv( date, 1000000 );
 284     struct timespec ts = { d.quot, d.rem * 1000 };
 285
 286     int val;
 287     while( ( val = clock_nanosleep( CLOCK_MONOTONIC, TIMER_ABSTIME, &ts,
 288                                     NULL ) ) == EINTR );
 289     if( val == EINVAL )
 290     {
 291         ts.tv_sec = d.quot; ts.tv_nsec = d.rem * 1000;
 292         while( clock_nanosleep( CLOCK_REALTIME, 0, &ts, NULL ) == EINTR );
 293     }
 294 #else
 295
 296     mtime_t delay = date - mdate();
 297     if( delay > 0 )
 298         msleep( delay );
 299
 300 #endif
 301 }
 302
 303 /**
 304  * More precise sleep()
 305  *
 306  * Portable usleep() function.
 307  * \param delay the amount of time to sleep
 308  */
 309 void msleep( mtime_t delay )
 310 {
 311     mtime_t earlier = cached_time;
 312
 313 #if defined( HAVE_CLOCK_NANOSLEEP )
 314     lldiv_t d = lldiv( delay, 1000000 );
 315     struct timespec ts = { d.quot, d.rem * 1000 };
 316
 317     int val;
 318     while( ( val = clock_nanosleep( CLOCK_MONOTONIC, 0, &ts, &ts ) ) == EINTR );
 319     if( val == EINVAL )
 320     {
 321         ts.tv_sec = d.quot; ts.tv_nsec = d.rem * 1000;
 322         while( clock_nanosleep( CLOCK_REALTIME, 0, &ts, &ts ) == EINTR );
 323     }
 324
 325 #elif defined( HAVE_KERNEL_OS_H )
 326     snooze( delay );
 327
 328 #elif defined( PTH_INIT_IN_PTH_H )
 329     pth_usleep( delay );
 330
 331 #elif defined( ST_INIT_IN_ST_H )
 332     st_usleep( delay );
 333
 334 #elif defined( WIN32 ) || defined( UNDER_CE )
 335     Sleep( (int) (delay / 1000) );
 336
 337 #elif defined( HAVE_NANOSLEEP )
 338     struct timespec ts_delay;
 339
 340     ts_delay.tv_sec = delay / 1000000;
 341     ts_delay.tv_nsec = (delay % 1000000) * 1000;
 342
 343     while( nanosleep( &ts_delay, &ts_delay ) && ( errno == EINTR ) );
 344
 345 #else
 346     struct timeval tv_delay;
 347
 348     tv_delay.tv_sec = delay / 1000000;
 349     tv_delay.tv_usec = delay % 1000000;
 350
 351     /* If a signal is caught, you are screwed. Update your OS to nanosleep()
 352      * or clock_nanosleep() if this is an issue. */
 353     select( 0, NULL, NULL, NULL, &tv_delay );
 354 #endif
 355
 356     earlier += delay;
 357     if( cached_time < earlier )
 358         cached_time = earlier;
 359 }
 360
 361 /*
 362  * Date management (internal and external)
 363  */
 364
 365 /**
 366  * Initialize a date_t.
 367  *
 368  * \param date to initialize
 369  * \param divider (sample rate) numerator
 370  * \param divider (sample rate) denominator
 371  */
 372
 373 void date_Init( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
 374 {
 375     p_date->date = 0;
 376     p_date->i_divider_num = i_divider_n;
 377     p_date->i_divider_den = i_divider_d;
 378     p_date->i_remainder = 0;
 379 }
 380
 381 /**
 382  * Change a date_t.
 383  *
 384  * \param date to change
 385  * \param divider (sample rate) numerator
 386  * \param divider (sample rate) denominator
 387  */
 388
 389 void date_Change( date_t *p_date, uint32_t i_divider_n, uint32_t i_divider_d )
 390 {
 391     p_date->i_divider_num = i_divider_n;
 392     p_date->i_divider_den = i_divider_d;
 393 }
 394
 395 /**
 396  * Set the date value of a date_t.
 397  *
 398  * \param date to set
 399  * \param date value
 400  */
 401 void date_Set( date_t *p_date, mtime_t i_new_date )
 402 {
 403     p_date->date = i_new_date;
 404     p_date->i_remainder = 0;
 405 }
 406
 407 /**
 408  * Get the date of a date_t
 409  *
 410  * \param date to get
 411  * \return date value
 412  */
 413 mtime_t date_Get( const date_t *p_date )
 414 {
 415     return p_date->date;
 416 }
 417
 418 /**
 419  * Move forwards or backwards the date of a date_t.
 420  *
 421  * \param date to move
 422  * \param difference value
 423  */
 424 void date_Move( date_t *p_date, mtime_t i_difference )
 425 {
 426     p_date->date += i_difference;
 427 }
 428
 429 /**
 430  * Increment the date and return the result, taking into account
 431  * rounding errors.
 432  *
 433  * \param date to increment
 434  * \param incrementation in number of samples
 435  * \return date value
 436  */
 437 mtime_t date_Increment( date_t *p_date, uint32_t i_nb_samples )
 438 {
 439     mtime_t i_dividend = (mtime_t)i_nb_samples * 1000000;
 440     p_date->date += i_dividend / p_date->i_divider_num * p_date->i_divider_den;
 441     p_date->i_remainder += (int)(i_dividend % p_date->i_divider_num);
 442
 443     if( p_date->i_remainder >= p_date->i_divider_num )
 444     {
 445         /* This is Bresenham algorithm. */
 446         p_date->date += p_date->i_divider_den;
 447         p_date->i_remainder -= p_date->i_divider_num;
 448     }
 449
 450     return p_date->date;
 451 }
 452
 453 #ifndef HAVE_GETTIMEOFDAY
 454
 455 #ifdef WIN32
 456
 457 /*
 458  * Number of micro-seconds between the beginning of the Windows epoch
 459  * (Jan. 1, 1601) and the Unix epoch (Jan. 1, 1970).
 460  *
 461  * This assumes all Win32 compilers have 64-bit support.
 462  */
 463 #if defined(_MSC_VER) || defined(_MSC_EXTENSIONS) || defined(__WATCOMC__)
 464 #   define DELTA_EPOCH_IN_USEC  11644473600000000Ui64
 465 #else
 466 #   define DELTA_EPOCH_IN_USEC  11644473600000000ULL
 467 #endif
 468
 469 static uint64_t filetime_to_unix_epoch (const FILETIME *ft)
 470 {
 471     uint64_t res = (uint64_t) ft->dwHighDateTime << 32;
 472
 473     res |= ft->dwLowDateTime;
 474     res /= 10;                   /* from 100 nano-sec periods to usec */
 475     res -= DELTA_EPOCH_IN_USEC;  /* from Win epoch to Unix epoch */
 476     return (res);
 477 }
 478
 479 static int gettimeofday (struct timeval *tv, void *tz )
 480 {
 481     FILETIME  ft;
 482     uint64_t tim;
 483
 484     if (!tv) {
 485         return VLC_EGENERIC;
 486     }
 487     GetSystemTimeAsFileTime (&ft);
 488     tim = filetime_to_unix_epoch (&ft);
 489     tv->tv_sec  = (long) (tim / 1000000L);
 490     tv->tv_usec = (long) (tim % 1000000L);
 491     return (0);
 492 }
 493
 494 #endif
 495
 496 #endif
 497
 498 /**
 499  * @return NTP 64-bits timestamp in host byte order.
 500  */
 501 uint64_t NTPtime64 (void)
 502 {
 503     struct timespec ts;
 504 #if defined (CLOCK_REALTIME)
 505     clock_gettime (CLOCK_REALTIME, &ts);
 506 #else
 507     {
 508         struct timeval tv;
 509         gettimeofday (&tv, NULL);
 510         ts.tv_sec = tv.tv_sec;
 511         ts.tv_nsec = tv.tv_usec * 1000;
 512     }
 513 #endif
 514
 515     /* Convert nanoseconds to 32-bits fraction (232 picosecond units) */
 516     uint64_t t = (uint64_t)(ts.tv_nsec) << 32;
 517     t /= 1000000000;
 518
 519
 520     /* There is 70 years (incl. 17 leap ones) offset to the Unix Epoch.
 521      * No leap seconds during that period since they were not invented yet.
 522      */
 523     assert (t < 0x100000000);
 524     t |= ((70LL * 365 + 17) * 24 * 60 * 60 + ts.tv_sec) << 32;
 525     return t;
 526 }
 527