Tentative hack for OSX msleep/mwait cancellation
[vlc.git] / 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(HAVE_STRUCT_TIMESPEC)
60 struct timespec
61 {
62     time_t  tv_sec;
63     int32_t tv_nsec;
64 };
65 #endif
66
67 #if defined(HAVE_NANOSLEEP) && !defined(HAVE_DECL_NANOSLEEP)
68 int nanosleep(struct timespec *, struct timespec *);
69 #endif
70
71 #if !defined (_POSIX_CLOCK_SELECTION)
72 #  define _POSIX_CLOCK_SELECTION (-1)
73 #endif
74
75 # if (_POSIX_CLOCK_SELECTION < 0)
76 /*
77  * We cannot use the monotonic clock is clock selection is not available,
78  * as it would screw vlc_cond_timedwait() completely. Instead, we have to
79  * stick to the realtime clock. Nevermind it screws everything when ntpdate
80  * warps the wall clock.
81  */
82 #  undef CLOCK_MONOTONIC
83 #  define CLOCK_MONOTONIC CLOCK_REALTIME
84 #elif !defined (HAVE_CLOCK_NANOSLEEP)
85 /* Clock selection without clock in the first place, I don't think so. */
86 #  error We have quite a situation here! Fix me if it ever happens.
87 #endif
88
89 /**
90  * Return a date in a readable format
91  *
92  * This function converts a mtime date into a string.
93  * psz_buffer should be a buffer long enough to store the formatted
94  * date.
95  * \param date to be converted
96  * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
97  * \return psz_buffer is returned so this can be used as printf parameter.
98  */
99 char *mstrtime( char *psz_buffer, mtime_t date )
100 {
101     static const mtime_t ll1000 = 1000, ll60 = 60, ll24 = 24;
102
103     snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%02d:%02d:%02d-%03d.%03d",
104              (int) (date / (ll1000 * ll1000 * ll60 * ll60) % ll24),
105              (int) (date / (ll1000 * ll1000 * ll60) % ll60),
106              (int) (date / (ll1000 * ll1000) % ll60),
107              (int) (date / ll1000 % ll1000),
108              (int) (date % ll1000) );
109     return( psz_buffer );
110 }
111
112 /**
113  * Convert seconds to a time in the format h:mm:ss.
114  *
115  * This function is provided for any interface function which need to print a
116  * time string in the format h:mm:ss
117  * date.
118  * \param secs  the date to be converted
119  * \param psz_buffer should be a buffer at least MSTRTIME_MAX_SIZE characters
120  * \return psz_buffer is returned so this can be used as printf parameter.
121  */
122 char *secstotimestr( char *psz_buffer, int i_seconds )
123 {
124     int i_hours, i_mins;
125     i_mins = i_seconds / 60;
126     i_hours = i_mins / 60 ;
127     if( i_hours )
128     {
129         snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%d:%2.2d:%2.2d",
130                  (int) i_hours,
131                  (int) (i_mins % 60),
132                  (int) (i_seconds % 60) );
133     }
134     else
135     {
136          snprintf( psz_buffer, MSTRTIME_MAX_SIZE, "%2.2d:%2.2d",
137                    (int) i_mins ,
138                    (int) (i_seconds % 60) );
139     }
140     return( psz_buffer );
141 }
142
143 #if defined (HAVE_CLOCK_NANOSLEEP)
144 static unsigned prec = 0;
145
146 static void mprec_once( void )
147 {
148     struct timespec ts;
149     if( clock_getres( CLOCK_MONOTONIC, &ts ))
150         clock_getres( CLOCK_REALTIME, &ts );
151
152     prec = ts.tv_nsec / 1000;
153 }
154 #endif
155
156 /**
157  * Return a value that is no bigger than the clock precision
158  * (possibly zero).
159  */
160 static inline unsigned mprec( void )
161 {
162 #if defined (HAVE_CLOCK_NANOSLEEP)
163     static pthread_once_t once = PTHREAD_ONCE_INIT;
164     pthread_once( &once, mprec_once );
165     return prec;
166 #else
167     return 0;
168 #endif
169 }
170
171 /**
172  * Return high precision date
173  *
174  * Use a 1 MHz clock when possible, or 1 kHz
175  *
176  * Beware ! It doesn't reflect the actual date (since epoch), but can be the machine's uptime or anything (when monotonic clock is used)
177  */
178 mtime_t mdate( void )
179 {
180     mtime_t res;
181
182 #if defined (HAVE_CLOCK_NANOSLEEP)
183     struct timespec ts;
184
185     /* Try to use POSIX monotonic clock if available */
186     if( clock_gettime( CLOCK_MONOTONIC, &ts ) == EINVAL )
187         /* Run-time fallback to real-time clock (always available) */
188         (void)clock_gettime( CLOCK_REALTIME, &ts );
189
190     res = ((mtime_t)ts.tv_sec * (mtime_t)1000000)
191            + (mtime_t)(ts.tv_nsec / 1000);
192
193 #elif defined( HAVE_KERNEL_OS_H )
194     res = real_time_clock_usecs();
195
196 #elif defined( WIN32 ) || defined( UNDER_CE )
197     /* We don't need the real date, just the value of a high precision timer */
198     static mtime_t freq = INT64_C(-1);
199
200     if( freq == INT64_C(-1) )
201     {
202         /* Extract from the Tcl source code:
203          * (http://www.cs.man.ac.uk/fellowsd-bin/TIP/7.html)
204          *
205          * Some hardware abstraction layers use the CPU clock
206          * in place of the real-time clock as a performance counter
207          * reference.  This results in:
208          *    - inconsistent results among the processors on
209          *      multi-processor systems.
210          *    - unpredictable changes in performance counter frequency
211          *      on "gearshift" processors such as Transmeta and
212          *      SpeedStep.
213          * There seems to be no way to test whether the performance
214          * counter is reliable, but a useful heuristic is that
215          * if its frequency is 1.193182 MHz or 3.579545 MHz, it's
216          * derived from a colorburst crystal and is therefore
217          * the RTC rather than the TSC.  If it's anything else, we
218          * presume that the performance counter is unreliable.
219          */
220         LARGE_INTEGER buf;
221
222         freq = ( QueryPerformanceFrequency( &buf ) &&
223                  (buf.QuadPart == INT64_C(1193182) || buf.QuadPart == INT64_C(3579545) ) )
224                ? buf.QuadPart : 0;
225
226 #if defined( WIN32 )
227         /* on windows 2000, XP and Vista detect if there are two
228            cores there - that makes QueryPerformanceFrequency in
229            any case not trustable?
230            (may also be true, for single cores with adaptive
231             CPU frequency and active power management?)
232         */
233         HINSTANCE h_Kernel32 = LoadLibrary(_T("kernel32.dll"));
234         if(h_Kernel32)
235         {
236             void WINAPI (*pf_GetSystemInfo)(LPSYSTEM_INFO);
237             pf_GetSystemInfo = (void WINAPI (*)(LPSYSTEM_INFO))
238                                 GetProcAddress(h_Kernel32, _T("GetSystemInfo"));
239             if(pf_GetSystemInfo)
240             {
241                SYSTEM_INFO system_info;
242                pf_GetSystemInfo(&system_info);
243                if(system_info.dwNumberOfProcessors > 1)
244                   freq = 0;
245             }
246             FreeLibrary(h_Kernel32);
247         }
248 #endif
249     }
250
251     if( freq != 0 )
252     {
253         LARGE_INTEGER counter;
254         QueryPerformanceCounter (&counter);
255
256         /* Convert to from (1/freq) to microsecond resolution */
257         /* We need to split the division to avoid 63-bits overflow */
258         lldiv_t d = lldiv (counter.QuadPart, freq);
259
260         res = (d.quot * 1000000) + ((d.rem * 1000000) / freq);
261     }
262     else
263     {
264         /* Fallback on timeGetTime() which has a millisecond resolution
265          * (actually, best case is about 5 ms resolution)
266          * timeGetTime() only returns a DWORD thus will wrap after
267          * about 49.7 days so we try to detect the wrapping. */
268
269         static CRITICAL_SECTION date_lock;
270         static mtime_t i_previous_time = INT64_C(-1);
271         static int i_wrap_counts = -1;
272
273         if( i_wrap_counts == -1 )
274         {
275             /* Initialization */
276 #if defined( WIN32 )
277             i_previous_time = INT64_C(1000) * timeGetTime();
278 #else
279             i_previous_time = INT64_C(1000) * GetTickCount();
280 #endif
281             InitializeCriticalSection( &date_lock );
282             i_wrap_counts = 0;
283         }
284
285         EnterCriticalSection( &date_lock );
286 #if defined( WIN32 )
287         res = INT64_C(1000) *
288             (i_wrap_counts * INT64_C(0x100000000) + timeGetTime());
289 #else
290         res = INT64_C(1000) *
291             (i_wrap_counts * INT64_C(0x100000000) + GetTickCount());
292 #endif
293         if( i_previous_time > res )
294         {
295             /* Counter wrapped */
296             i_wrap_counts++;
297             res += INT64_C(0x100000000) * 1000;
298         }
299         i_previous_time = res;
300         LeaveCriticalSection( &date_lock );
301     }
302 #else
303     struct timeval tv_date;
304
305     /* gettimeofday() cannot fail given &tv_date is a valid address */
306     (void)gettimeofday( &tv_date, NULL );
307     res = (mtime_t) tv_date.tv_sec * 1000000 + (mtime_t) tv_date.tv_usec;
308 #endif
309
310     return res;
311 }
312
313 #undef mwait
314 /**
315  * Wait for a date
316  *
317  * This function uses select() and an system date function to wake up at a
318  * precise date. It should be used for process synchronization. If current date
319  * is posterior to wished date, the function returns immediately.
320  * \param date The date to wake up at
321  */
322 void mwait( mtime_t date )
323 {
324     /* If the deadline is already elapsed, or within the clock precision,
325      * do not even bother the system timer. */
326     date -= mprec();
327
328 #if defined (HAVE_CLOCK_NANOSLEEP)
329     lldiv_t d = lldiv( date, 1000000 );
330     struct timespec ts = { d.quot, d.rem * 1000 };
331
332     int val;
333     while( ( val = clock_nanosleep( CLOCK_MONOTONIC, TIMER_ABSTIME, &ts,
334                                     NULL ) ) == EINTR );
335     if( val == EINVAL )
336     {
337         ts.tv_sec = d.quot; ts.tv_nsec = d.rem * 1000;
338         while( clock_nanosleep( CLOCK_REALTIME, 0, &ts, NULL ) == EINTR );
339     }
340
341 #elif defined (WIN32)
342     mtime_t i_total;
343
344     while( (i_total = (date - mdate())) > 0 )
345     {
346         const mtime_t i_sleep = i_total / 1000;
347         DWORD i_delay = (i_sleep > 0x7fffffff) ? 0x7fffffff : i_sleep;
348         vlc_testcancel();
349         SleepEx( i_delay, TRUE );
350     }
351     vlc_testcancel();
352
353 #elif defined( __APPLE__ )
354     /* Explicit hack: OSX does not cancel at nanosleep() */
355     struct vlc_mutex_t lock;
356     struct vlc_cond_t  wait;
357
358     vlc_mutex_init (&lock);
359     vlc_cond_init (&wait);
360     vlc_mutex_lock (&lock);
361
362     vlc_cleanup_push (vlc_mutex_destroy, &lock);
363     vlc_cleanup_push (vlc_cond_destroy, &wait);
364     vlc_cleanup_push (vlc_mutex_unlock, &lock);
365
366     vlc_cond_timedwait (&wait, &lock, date);
367
368     vlc_cleanup_run ();
369     vlc_cleanup_run ();
370     vlc_cleanup_run ();
371
372 #else
373     mtime_t delay = date - mdate();
374     if( delay > 0 )
375         msleep( delay );
376
377 #endif
378 }
379
380
381 #include "libvlc.h" /* vlc_backtrace() */
382 #undef msleep
383
384 #if defined(__APPLE__) && defined( HAVE_NANOSLEEP )
385 /* Mac OS X 10.5's nanosleep is not a cancellation point */
386 static inline int
387 semi_testcancelable_nanosleep(const struct timespec *rqtp, struct timespec *rmtp)
388 {
389     int ret;
390     pthread_testcancel();
391     ret = nanosleep(rqtp, rmtp);
392     pthread_testcancel();
393     return ret;
394 }
395 #define nanosleep semi_testcancelable_nanosleep
396 #endif
397
398 /**
399  * Portable usleep(). Cancellation point.
400  *
401  * \param delay the amount of time to sleep
402  */
403 void msleep( mtime_t delay )
404 {
405 #if defined( HAVE_CLOCK_NANOSLEEP )
406     lldiv_t d = lldiv( delay, 1000000 );
407     struct timespec ts = { d.quot, d.rem * 1000 };
408
409     int val;
410     while( ( val = clock_nanosleep( CLOCK_MONOTONIC, 0, &ts, &ts ) ) == EINTR );
411     if( val == EINVAL )
412     {
413         ts.tv_sec = d.quot; ts.tv_nsec = d.rem * 1000;
414         while( clock_nanosleep( CLOCK_REALTIME, 0, &ts, &ts ) == EINTR );
415     }
416
417 #elif defined( HAVE_KERNEL_OS_H )
418     snooze( delay );
419
420 #elif defined( WIN32 ) || defined( UNDER_CE ) || defined( __APPLE__ )
421     mwait (mdate () + delay);
422
423 #elif defined( HAVE_NANOSLEEP )
424     struct timespec ts_delay;
425
426     ts_delay.tv_sec = delay / 1000000;
427     ts_delay.tv_nsec = (delay % 1000000) * 1000;
428
429     while( nanosleep( &ts_delay, &ts_delay ) && ( errno == EINTR ) );
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 #ifndef HAVE_GETTIMEOFDAY
539
540 #ifdef WIN32
541
542 /*
543  * Number of micro-seconds between the beginning of the Windows epoch
544  * (Jan. 1, 1601) and the Unix epoch (Jan. 1, 1970).
545  *
546  * This assumes all Win32 compilers have 64-bit support.
547  */
548 #if defined(_MSC_VER) || defined(_MSC_EXTENSIONS) || defined(__WATCOMC__)
549 #   define DELTA_EPOCH_IN_USEC  11644473600000000Ui64
550 #else
551 #   define DELTA_EPOCH_IN_USEC  11644473600000000ULL
552 #endif
553
554 static uint64_t filetime_to_unix_epoch (const FILETIME *ft)
555 {
556     uint64_t res = (uint64_t) ft->dwHighDateTime << 32;
557
558     res |= ft->dwLowDateTime;
559     res /= 10;                   /* from 100 nano-sec periods to usec */
560     res -= DELTA_EPOCH_IN_USEC;  /* from Win epoch to Unix epoch */
561     return (res);
562 }
563
564 static int gettimeofday (struct timeval *tv, void *tz )
565 {
566     FILETIME  ft;
567     uint64_t tim;
568
569     if (!tv) {
570         return VLC_EGENERIC;
571     }
572     GetSystemTimeAsFileTime (&ft);
573     tim = filetime_to_unix_epoch (&ft);
574     tv->tv_sec  = (long) (tim / 1000000L);
575     tv->tv_usec = (long) (tim % 1000000L);
576     return (0);
577 }
578
579 #endif
580
581 #endif
582
583 /**
584  * @return NTP 64-bits timestamp in host byte order.
585  */
586 uint64_t NTPtime64 (void)
587 {
588     struct timespec ts;
589 #if defined (CLOCK_REALTIME)
590     clock_gettime (CLOCK_REALTIME, &ts);
591 #else
592     {
593         struct timeval tv;
594         gettimeofday (&tv, NULL);
595         ts.tv_sec = tv.tv_sec;
596         ts.tv_nsec = tv.tv_usec * 1000;
597     }
598 #endif
599
600     /* Convert nanoseconds to 32-bits fraction (232 picosecond units) */
601     uint64_t t = (uint64_t)(ts.tv_nsec) << 32;
602     t /= 1000000000;
603
604
605     /* There is 70 years (incl. 17 leap ones) offset to the Unix Epoch.
606      * No leap seconds during that period since they were not invented yet.
607      */
608     assert (t < 0x100000000);
609     t |= ((70LL * 365 + 17) * 24 * 60 * 60 + ts.tv_sec) << 32;
610     return t;
611 }
612