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