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