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