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