vlc_threads.h 26.5 KB
Newer Older
1
/*****************************************************************************
2 3
 * vlc_threads.h : threads implementation for the VideoLAN client
 * This header provides portable declarations for mutexes & conditions
4
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
5
 * Copyright (C) 1999, 2002 VLC authors and VideoLAN
6
 * Copyright © 2007-2008 Rémi Denis-Courmont
7
 *
8 9
 * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
 *          Samuel Hocevar <sam@via.ecp.fr>
Gildas Bazin's avatar
 
Gildas Bazin committed
10
 *          Gildas Bazin <gbazin@netcourrier.com>
11
 *          Christophe Massiot <massiot@via.ecp.fr>
12
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
13 14 15
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
16
 * (at your option) any later version.
17
 *
18 19
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
20 21
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
22
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
23 24 25
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26
 *****************************************************************************/
27

28 29
#ifndef VLC_THREADS_H_
#define VLC_THREADS_H_
30

31
/**
32 33 34
 * \ingroup os
 * \defgroup thread Threads and synchronization primitives
 * @{
35
 * \file
36
 * Thread primitive declarations
37 38
 */

39 40 41 42 43 44 45 46
/**
 * Issues an explicit deferred cancellation point.
 *
 * This has no effects if thread cancellation is disabled.
 * This can be called when there is a rather slow non-sleeping operation.
 * This is also used to force a cancellation point in a function that would
 * otherwise <em>not always</em> be a one (block_FifoGet() is an example).
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
47 48
VLC_API void vlc_testcancel(void);

49
#if defined (_WIN32)
50 51 52 53
# include <process.h>
# ifndef ETIMEDOUT
#  define ETIMEDOUT 10060 /* This is the value in winsock.h. */
# endif
54

55
typedef struct vlc_thread *vlc_thread_t;
56
#define VLC_THREAD_CANCELED NULL
57 58
typedef struct
{
59 60 61
    bool dynamic;
    union
    {
62 63 64 65 66
        struct
        {
            bool locked;
            unsigned long contention;
        };
67 68
        CRITICAL_SECTION mutex;
    };
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
69
} vlc_mutex_t;
70
#define VLC_STATIC_MUTEX { false, { { false, 0 } } }
71 72
typedef struct
{
73 74
    HANDLE   semaphore;
    LONG     waiters;
75 76
    unsigned clock;
} vlc_cond_t;
77
#define VLC_STATIC_COND { NULL, 0, 0 }
78 79
typedef HANDLE vlc_sem_t;
#define LIBVLC_NEED_RWLOCK
80
typedef struct vlc_threadvar *vlc_threadvar_t;
81
typedef struct vlc_timer *vlc_timer_t;
82

83 84 85 86 87 88 89
# define VLC_THREAD_PRIORITY_LOW      0
# define VLC_THREAD_PRIORITY_INPUT    THREAD_PRIORITY_ABOVE_NORMAL
# define VLC_THREAD_PRIORITY_AUDIO    THREAD_PRIORITY_HIGHEST
# define VLC_THREAD_PRIORITY_VIDEO    0
# define VLC_THREAD_PRIORITY_OUTPUT   THREAD_PRIORITY_ABOVE_NORMAL
# define VLC_THREAD_PRIORITY_HIGHEST  THREAD_PRIORITY_TIME_CRITICAL

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
90 91 92 93
static inline int vlc_poll(struct pollfd *fds, unsigned nfds, int timeout)
{
    int val;

94 95 96 97
    vlc_testcancel();
    val = poll(fds, nfds, timeout);
    if (val < 0)
        vlc_testcancel();
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
98 99 100 101
    return val;
}
# define poll(u,n,t) vlc_poll(u, n, t)

102 103
#elif defined (__OS2__)
# include <errno.h>
104

105
typedef struct vlc_thread *vlc_thread_t;
106
#define VLC_THREAD_CANCELED NULL
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
typedef struct
{
    bool dynamic;
    union
    {
        struct
        {
            bool locked;
            unsigned long contention;
        };
        HMTX hmtx;
    };
} vlc_mutex_t;
#define VLC_STATIC_MUTEX { false, { { false, 0 } } }
typedef struct
{
    HEV      hev;
124 125 126
    unsigned waiters;
    HEV      hevAck;
    unsigned signaled;
127 128
    unsigned clock;
} vlc_cond_t;
129
#define VLC_STATIC_COND { NULLHANDLE, 0, NULLHANDLE, 0, 0 }
130 131
#define LIBVLC_NEED_SEMAPHORE
#define LIBVLC_NEED_RWLOCK
132 133 134
typedef struct vlc_threadvar *vlc_threadvar_t;
typedef struct vlc_timer *vlc_timer_t;

135 136 137 138 139 140 141 142 143 144 145
# define VLC_THREAD_PRIORITY_LOW      0
# define VLC_THREAD_PRIORITY_INPUT \
                                    MAKESHORT(PRTYD_MAXIMUM / 2, PRTYC_REGULAR)
# define VLC_THREAD_PRIORITY_AUDIO    MAKESHORT(PRTYD_MAXIMUM, PRTYC_REGULAR)
# define VLC_THREAD_PRIORITY_VIDEO    0
# define VLC_THREAD_PRIORITY_OUTPUT \
                                    MAKESHORT(PRTYD_MAXIMUM / 2, PRTYC_REGULAR)
# define VLC_THREAD_PRIORITY_HIGHEST  MAKESHORT(0, PRTYC_TIMECRITICAL)

# define pthread_sigmask  sigprocmask

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
static inline int vlc_poll (struct pollfd *fds, unsigned nfds, int timeout)
{
    static int (*vlc_poll_os2)(struct pollfd *, unsigned, int) = NULL;

    if (!vlc_poll_os2)
    {
        HMODULE hmod;
        CHAR szFailed[CCHMAXPATH];

        if (DosLoadModule(szFailed, sizeof(szFailed), "vlccore", &hmod))
            return -1;

        if (DosQueryProcAddr(hmod, 0, "_vlc_poll_os2", (PFN *)&vlc_poll_os2))
            return -1;
    }

    return (*vlc_poll_os2)(fds, nfds, timeout);
}
# define poll(u,n,t) vlc_poll(u, n, t)

166 167 168 169 170 171 172 173 174
#elif defined (__ANDROID__)      /* pthreads subset without pthread_cancel() */
# include <unistd.h>
# include <pthread.h>
# include <poll.h>
# define LIBVLC_USE_PTHREAD_CLEANUP   1
# define LIBVLC_NEED_SEMAPHORE
# define LIBVLC_NEED_RWLOCK

typedef struct vlc_thread *vlc_thread_t;
175
#define VLC_THREAD_CANCELED NULL
176
typedef pthread_mutex_t vlc_mutex_t;
177

178
#define VLC_STATIC_MUTEX PTHREAD_MUTEX_INITIALIZER
179 180 181 182 183 184
typedef struct
{
    pthread_cond_t cond;
    unsigned clock;
} vlc_cond_t;
#define VLC_STATIC_COND  { PTHREAD_COND_INITIALIZER, CLOCK_REALTIME }
185 186 187 188 189 190 191 192 193 194 195

typedef pthread_key_t   vlc_threadvar_t;
typedef struct vlc_timer *vlc_timer_t;

# define VLC_THREAD_PRIORITY_LOW      0
# define VLC_THREAD_PRIORITY_INPUT    0
# define VLC_THREAD_PRIORITY_AUDIO    0
# define VLC_THREAD_PRIORITY_VIDEO    0
# define VLC_THREAD_PRIORITY_OUTPUT   0
# define VLC_THREAD_PRIORITY_HIGHEST  0

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
static inline int vlc_poll (struct pollfd *fds, unsigned nfds, int timeout)
{
    int val;

    do
    {
        int ugly_timeout = ((unsigned)timeout >= 50) ? 50 : timeout;
        if (timeout >= 0)
            timeout -= ugly_timeout;

        vlc_testcancel ();
        val = poll (fds, nfds, ugly_timeout);
    }
    while (val == 0 && timeout != 0);

    return val;
}

# define poll(u,n,t) vlc_poll(u, n, t)

216 217 218 219 220 221 222 223 224 225 226
#elif defined (__APPLE__)
# define _APPLE_C_SOURCE    1 /* Proper pthread semantics on OSX */
# include <unistd.h>
# include <pthread.h>
/* Unnamed POSIX semaphores not supported on Mac OS X */
# include <mach/semaphore.h>
# include <mach/task.h>
# define LIBVLC_USE_PTHREAD           1
# define LIBVLC_USE_PTHREAD_CLEANUP   1

typedef pthread_t       vlc_thread_t;
227
#define VLC_THREAD_CANCELED PTHREAD_CANCELED
228 229
typedef pthread_mutex_t vlc_mutex_t;
#define VLC_STATIC_MUTEX PTHREAD_MUTEX_INITIALIZER
230 231 232 233 234 235
typedef struct
{
    pthread_cond_t cond;
    unsigned clock;
} vlc_cond_t;
#define VLC_STATIC_COND  { PTHREAD_COND_INITIALIZER, 0 }
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
typedef semaphore_t     vlc_sem_t;
typedef pthread_rwlock_t vlc_rwlock_t;
#define VLC_STATIC_RWLOCK PTHREAD_RWLOCK_INITIALIZER
typedef pthread_key_t   vlc_threadvar_t;
typedef struct vlc_timer *vlc_timer_t;

# define VLC_THREAD_PRIORITY_LOW      0
# define VLC_THREAD_PRIORITY_INPUT   22
# define VLC_THREAD_PRIORITY_AUDIO   22
# define VLC_THREAD_PRIORITY_VIDEO    0
# define VLC_THREAD_PRIORITY_OUTPUT  22
# define VLC_THREAD_PRIORITY_HIGHEST 22

#else /* POSIX threads */
# include <unistd.h> /* _POSIX_SPIN_LOCKS */
# include <pthread.h>
# include <semaphore.h>
253 254 255 256

/**
 * Whether LibVLC threads are based on POSIX threads.
 */
257
# define LIBVLC_USE_PTHREAD           1
258 259 260 261

/**
 * Whether LibVLC thread cancellation is based on POSIX threads.
 */
262 263
# define LIBVLC_USE_PTHREAD_CLEANUP   1

264 265 266
/**
 * Thread handle.
 */
267
typedef pthread_t       vlc_thread_t;
268

269 270 271 272 273
/**
 * Return value of a canceled thread.
 */
#define VLC_THREAD_CANCELED PTHREAD_CANCELED

274 275 276 277 278
/**
 * Mutex.
 *
 * Storage space for a mutual exclusion lock.
 */
279
typedef pthread_mutex_t vlc_mutex_t;
280 281 282 283

/**
 * Static initializer for (static) mutex.
 */
284
#define VLC_STATIC_MUTEX PTHREAD_MUTEX_INITIALIZER
285 286 287 288 289 290

/**
 * Condition variable.
 *
 * Storage space for a thread condition variable.
 */
291
typedef pthread_cond_t  vlc_cond_t;
292 293 294 295

/**
 * Static initializer for (static) condition variable.
 */
296
#define VLC_STATIC_COND  PTHREAD_COND_INITIALIZER
297 298 299 300 301 302

/**
 * Semaphore.
 *
 * Storage space for a thread-safe semaphore.
 */
303
typedef sem_t           vlc_sem_t;
304 305 306 307 308 309

/**
 * Read/write lock.
 *
 * Storage space for a slim reader/writer lock.
 */
310
typedef pthread_rwlock_t vlc_rwlock_t;
311 312 313 314

/**
 * Static initializer for (static) read/write lock.
 */
315
#define VLC_STATIC_RWLOCK PTHREAD_RWLOCK_INITIALIZER
316 317 318 319

/**
 * Thread-local key handle.
 */
320
typedef pthread_key_t   vlc_threadvar_t;
321 322 323 324

/**
 * Threaded timer handle.
 */
325 326 327 328 329 330 331 332 333
typedef struct vlc_timer *vlc_timer_t;

# define VLC_THREAD_PRIORITY_LOW      0
# define VLC_THREAD_PRIORITY_INPUT   10
# define VLC_THREAD_PRIORITY_AUDIO    5
# define VLC_THREAD_PRIORITY_VIDEO    0
# define VLC_THREAD_PRIORITY_OUTPUT  15
# define VLC_THREAD_PRIORITY_HIGHEST 20

334 335
#endif

336 337 338 339 340 341 342 343 344 345 346
#ifdef LIBVLC_NEED_SEMAPHORE
typedef struct vlc_sem
{
    vlc_mutex_t lock;
    vlc_cond_t  wait;
    unsigned    value;
} vlc_sem_t;
#endif

#ifdef LIBVLC_NEED_RWLOCK
typedef struct vlc_rwlock
347 348 349 350
{
    vlc_mutex_t   mutex;
    vlc_cond_t    wait;
    long          state;
351
} vlc_rwlock_t;
352 353 354
# define VLC_STATIC_RWLOCK { VLC_STATIC_MUTEX, VLC_STATIC_COND, 0 }
#endif

355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
/**
 * Initializes a fast mutex.
 *
 * Recursive locking of a fast mutex is undefined behaviour. (In debug builds,
 * recursive locking will cause an assertion failure.)
 */
VLC_API void vlc_mutex_init(vlc_mutex_t *);

/**
 * Initializes a recursive mutex.
 * \warning This is strongly discouraged. Please use normal mutexes.
 */
VLC_API void vlc_mutex_init_recursive(vlc_mutex_t *);

/**
 * Deinitializes a mutex.
 *
 * The mutex must not be locked, otherwise behaviour is undefined.
 */
VLC_API void vlc_mutex_destroy(vlc_mutex_t *);

/**
 * Acquires a mutex.
 *
 * If needed, this waits for any other thread to release it.
 *
 * \warning Beware of deadlocks when locking multiple mutexes at the same time,
 * or when using mutexes from callbacks.
 *
 * \note This function is not a cancellation-point.
 */
VLC_API void vlc_mutex_lock(vlc_mutex_t *);

/**
 * Tries to acquire a mutex.
 *
 * This function acquires the mutex if and only if it is not currently held by
 * another thread. This function never sleeps and can be used in delay-critical
 * code paths.
 *
 * \note This function is not a cancellation-point.
 *
 * \warning If this function fails, then the mutex is held... by another
 * thread. The calling thread must deal with the error appropriately. That
 * typically implies postponing the operations that would have required the
 * mutex. If the thread cannot defer those operations, then it must use
 * vlc_mutex_lock(). If in doubt, use vlc_mutex_lock() instead.
 *
 * @return 0 if the mutex could be acquired, an error code otherwise.
 */
405
VLC_API int vlc_mutex_trylock( vlc_mutex_t * ) VLC_USED;
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440

/**
 * Releases a mutex.
 *
 * If the mutex is not held by the calling thread, the behaviour is undefined.
 */
VLC_API void vlc_mutex_unlock(vlc_mutex_t *);

/**
 * Initializes a condition variable.
 */
VLC_API void vlc_cond_init(vlc_cond_t *);

/**
 * Initializes a condition variable (wall clock).
 *
 * Contrary to vlc_cond_init(), the wall clock will be used as a reference for
 * the vlc_cond_timedwait() time-out parameter.
 */
VLC_API void vlc_cond_init_daytime(vlc_cond_t *);

/**
 * Deinitializes a condition variable.
 *
 * No threads shall be waiting or signaling the condition, otherwise the
 * behavior is undefined.
 */
VLC_API void vlc_cond_destroy(vlc_cond_t *);

/**
 * Wakes up one thread waiting on a condition variable.
 *
 * If any thread is currently waiting on the condition variable, at least one
 * of those threads will be woken up. Otherwise, this function has no effects.
 */
441
VLC_API void vlc_cond_signal(vlc_cond_t *);
442 443 444 445

/**
 * Wakes up all threads waiting on a condition variable.
 */
446
VLC_API void vlc_cond_broadcast(vlc_cond_t *);
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470

/**
 * Waits on a condition variable.
 *
 * The calling thread will be suspended until another thread calls
 * vlc_cond_signal() or vlc_cond_broadcast() on the same condition variable,
 * the thread is cancelled with vlc_cancel(), or the system causes a
 * <em>spurious</em> unsolicited wake-up.
 *
 * A mutex is needed to wait on a condition variable. It must <b>not</b> be
 * a recursive mutex. Although it is possible to use the same mutex for
 * multiple condition, it is not valid to use different mutexes for the same
 * condition variable at the same time from different threads.
 *
 * The canonical way to use a condition variable to wait for event foobar is:
 @code
   vlc_mutex_lock(&lock);
   mutex_cleanup_push(&lock); // release the mutex in case of cancellation

   while (!foobar)
       vlc_cond_wait(&wait, &lock);

   // -- foobar is now true, do something about it here --

471 472
   vlc_cleanup_pop();
   vlc_mutex_unlock(&lock);
473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
  @endcode
 *
 * \note This function is a cancellation point. In case of thread cancellation,
 * the mutex is always locked before cancellation proceeds.
 *
 * \param cond condition variable to wait on
 * \param mutex mutex which is unlocked while waiting,
 *              then locked again when waking up.
 */
VLC_API void vlc_cond_wait(vlc_cond_t *cond, vlc_mutex_t *mutex);

/**
 * Waits on a condition variable up to a certain date.
 *
 * This works like vlc_cond_wait() but with an additional time-out.
 *
 * If the variable was initialized with vlc_cond_init(), the timeout has the
 * same arbitrary origin as mdate(). If the variable was initialized with
 * vlc_cond_init_daytime(), or was statically initialized with
 * \ref VLC_STATIC_COND, the timeout is expressed from the Unix epoch (i.e.
 * the wall clock).
 *
 * \param p_condvar condition variable to wait on
 * \param p_mutex mutex which is unlocked while waiting,
 *                then locked again when waking up.
 * \param deadline <b>absolute</b> timeout
 *
 * \return 0 if the condition was signaled, an error code in case of timeout.
 */
VLC_API int vlc_cond_timedwait(vlc_cond_t *cond, vlc_mutex_t *mutex,
                               mtime_t deadline);

/**
 * Initializes a semaphore.
 *
 * @param count initial semaphore value (typically 0)
 */
VLC_API void vlc_sem_init(vlc_sem_t *, unsigned count);

/**
 * Deinitializes a semaphore.
 */
515
VLC_API void vlc_sem_destroy(vlc_sem_t *);
516 517 518 519 520

/**
 * Increments the value of a semaphore.
 * @return 0 on success, EOVERFLOW in case of integer overflow.
 */
521
VLC_API int vlc_sem_post(vlc_sem_t *);
522 523 524 525 526 527 528 529 530 531

/**
 * Waits on a semaphore.
 *
 * This function atomically waits for the semaphore to become non-zero then
 * decrements it, and returns. If the semaphore is non-zero on entry, it is
 * immediately decremented.
 *
 * \note This function may be a point of cancellation.
 */
532 533
VLC_API void vlc_sem_wait(vlc_sem_t *);

534 535 536
/**
 * Initializes a read/write lock.
 */
537
VLC_API void vlc_rwlock_init(vlc_rwlock_t *);
538 539 540 541

/**
 * Destroys an initialized unused read/write lock.
 */
542
VLC_API void vlc_rwlock_destroy(vlc_rwlock_t *);
543 544 545 546 547 548 549

/**
 * Acquires a read/write lock for reading.
 *
 * \note Recursion is allowed.
 * \note This function may be a point of cancellation.
 */
550
VLC_API void vlc_rwlock_rdlock(vlc_rwlock_t *);
551 552 553 554 555

/**
 * Acquires a read/write lock for writing. Recursion is not allowed.
 * \note This function may be a point of cancellation.
 */
556
VLC_API void vlc_rwlock_wrlock(vlc_rwlock_t *);
557 558 559 560 561 562

/**
 * Releases a read/write lock.
 *
 * The calling thread must hold the lock. Otherwise behaviour is undefined.
 */
563
VLC_API void vlc_rwlock_unlock(vlc_rwlock_t *);
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580

/**
 * Allocates a thread-specific variable.
 *
 * @param key where to store the thread-specific variable handle
 * @param destr a destruction callback. It is called whenever a thread exits
 * and the thread-specific variable has a non-NULL value.
 *
 * @return 0 on success, a system error code otherwise.
 * This function can actually fail: on most systems, there is a fixed limit to
 * the number of thread-specific variables in a given process.
 */
VLC_API int vlc_threadvar_create(vlc_threadvar_t *key, void (*destr) (void *));

/**
 * Deallocates a thread-specific variable.
 */
581
VLC_API void vlc_threadvar_delete(vlc_threadvar_t *);
582

583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
/**
 * Sets a thread-specific variable.

 * \param key thread-local variable key (created with vlc_threadvar_create())
 * \param value new value for the variable for the calling thread
 * \return 0 on success, a system error code otherwise.
 */
VLC_API int vlc_threadvar_set(vlc_threadvar_t key, void *value);

/**
 * Gets the value of a thread-local variable for the calling thread.
 * This function cannot fail.
 *
 * \return the value associated with the given variable for the calling
 * or NULL if no value was set.
 */
VLC_API void *vlc_threadvar_get(vlc_threadvar_t);

/**
 * Creates and starts a new thread.
 *
 * The thread must be <i>joined</i> with vlc_join() to reclaim resources
 * when it is not needed anymore.
 *
 * @param th [OUT] pointer to write the handle of the created thread to
 *                 (mandatory, must be non-NULL)
 * @param entry entry point for the thread
 * @param data data parameter given to the entry point
 * @param priority thread priority value
 * @return 0 on success, a standard error code on error.
 */
VLC_API int vlc_clone(vlc_thread_t *th, void *(*entry)(void *), void *data,
                      int priority) VLC_USED;

/**
 * Marks a thread as cancelled.
 *
 * Next time the target thread reaches a cancellation point (while not having
 * disabled cancellation), it will run its cancellation cleanup handler, the
 * thread variable destructors, and terminate.
 *
 * vlc_join() must be used regardless of a thread being cancelled or not, to
 * avoid leaking resources.
 */
627 628
VLC_API void vlc_cancel(vlc_thread_t);

629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
/**
 * Waits for a thread to complete (if needed), then destroys it.
 *
 * \note This is a cancellation point. In case of cancellation, the thread is
 * <b>not</b> joined.

 * \warning A thread cannot join itself (normally VLC will abort if this is
 * attempted). Also a detached thread <b>cannot</b> be joined.
 *
 * @param th thread handle
 * @param result [OUT] pointer to write the thread return value or NULL
 */
VLC_API void vlc_join(vlc_thread_t th, void **result);

/**
 * Disables thread cancellation.
 *
 * This functions saves the current cancellation state (enabled or disabled),
 * then disables cancellation for the calling thread. It must be called before
 * entering a piece of code that is not cancellation-safe, unless it can be
 * proven that the calling thread will not be cancelled.
 *
 * \note This function is not a cancellation point.
 *
 * \return Previous cancellation state (opaque value for vlc_restorecancel()).
 */
VLC_API int vlc_savecancel(void);

/**
 * Restores the cancellation state.
 *
 * This function restores the cancellation state of the calling thread to
 * a state previously saved by vlc_savecancel().
 *
 * \note This function is not a cancellation point.
 *
 * \param state previous state as returned by vlc_savecancel().
 */
VLC_API void vlc_restorecancel(int state);

/**
 * Internal handler for thread cancellation.
 *
 * Do not call this function directly. Use wrapper macros instead:
673
 * vlc_cleanup_push(), vlc_cleanup_pop().
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
 */
VLC_API void vlc_control_cancel(int cmd, ...);

/**
 * Precision monotonic clock.
 *
 * In principles, the clock has a precision of 1 MHz. But the actual resolution
 * may be much lower, especially when it comes to sleeping with mwait() or
 * msleep(). Most general-purpose operating systems provide a resolution of
 * only 100 to 1000 Hz.
 *
 * \warning The origin date (time value "zero") is not specified. It is
 * typically the time the kernel started, but this is platform-dependent.
 * If you need wall clock time, use gettimeofday() instead.
 *
 * \return a timestamp in microseconds.
 */
691
VLC_API mtime_t mdate(void);
692 693 694 695 696 697 698 699

/**
 * Waits until a deadline.
 *
 * \param deadline timestamp to wait for (\ref mdate())
 *
 * \note The deadline may be exceeded due to OS scheduling.
 */
700
VLC_API void mwait(mtime_t deadline);
701 702 703 704 705 706

/**
 * Waits for an interval of time.
 *
 * @param delay how long to wait (in microseconds)
 */
707 708 709 710 711
VLC_API void msleep(mtime_t delay);

#define VLC_HARD_MIN_SLEEP   10000 /* 10 milliseconds = 1 tick at 100Hz */
#define VLC_SOFT_MIN_SLEEP 9000000 /* 9 seconds */

712
#if VLC_GCC_VERSION(4,3)
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
/* Linux has 100, 250, 300 or 1000Hz
 *
 * HZ=100 by default on FreeBSD, but some architectures use a 1000Hz timer
 */

static
__attribute__((unused))
__attribute__((noinline))
__attribute__((error("sorry, cannot sleep for such short a time")))
mtime_t impossible_delay( mtime_t delay )
{
    (void) delay;
    return VLC_HARD_MIN_SLEEP;
}

static
__attribute__((unused))
__attribute__((noinline))
__attribute__((warning("use proper event handling instead of short delay")))
mtime_t harmful_delay( mtime_t delay )
{
    return delay;
}

# define check_delay( d ) \
    ((__builtin_constant_p(d < VLC_HARD_MIN_SLEEP) \
   && (d < VLC_HARD_MIN_SLEEP)) \
       ? impossible_delay(d) \
       : ((__builtin_constant_p(d < VLC_SOFT_MIN_SLEEP) \
       && (d < VLC_SOFT_MIN_SLEEP)) \
           ? harmful_delay(d) \
           : d))

static
__attribute__((unused))
__attribute__((noinline))
__attribute__((error("deadlines can not be constant")))
mtime_t impossible_deadline( mtime_t deadline )
{
    return deadline;
}

# define check_deadline( d ) \
    (__builtin_constant_p(d) ? impossible_deadline(d) : d)
#else
# define check_delay(d) (d)
# define check_deadline(d) (d)
#endif

#define msleep(d) msleep(check_delay(d))
#define mwait(d) mwait(check_deadline(d))

765 766 767 768 769 770 771 772 773
/**
 * Initializes an asynchronous timer.
 *
 * \param id pointer to timer to be initialized
 * \param func function that the timer will call
 * \param data parameter for the timer function
 * \return 0 on success, a system error code otherwise.
 *
 * \warning Asynchronous timers are processed from an unspecified thread.
774
 * \note Multiple occurrences of a single interval timer are serialized:
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
 * they cannot run concurrently.
 */
VLC_API int vlc_timer_create(vlc_timer_t *id, void (*func)(void *), void *data)
VLC_USED;

/**
 * Destroys an initialized timer.
 *
 * If needed, the timer is first disarmed. Behaviour is undefined if the
 * specified timer is not initialized.
 *
 * \warning This function <b>must</b> be called before the timer data can be
 * freed and before the timer callback function can be unmapped/unloaded.
 *
 * \param timer timer to destroy
 */
VLC_API void vlc_timer_destroy(vlc_timer_t timer);

/**
 * Arms or disarms an initialized timer.
 *
 * This functions overrides any previous call to itself.
 *
 * \note A timer can fire later than requested due to system scheduling
 * limitations. An interval timer can fail to trigger sometimes, either because
 * the system is busy or suspended, or because a previous iteration of the
 * timer is still running. See also vlc_timer_getoverrun().
 *
 * \param timer initialized timer
 * \param absolute the timer value origin is the same as mdate() if true,
 *                 the timer value is relative to now if false.
 * \param value zero to disarm the timer, otherwise the initial time to wait
 *              before firing the timer.
 * \param interval zero to fire the timer just once, otherwise the timer
 *                 repetition interval.
 */
VLC_API void vlc_timer_schedule(vlc_timer_t timer, bool absolute,
                                mtime_t value, mtime_t interval);

/**
 * Fetches and resets the overrun counter for a timer.
 *
 * This functions returns the number of times that the interval timer should
 * have fired, but the callback was not invoked due to scheduling problems.
 * The call resets the counter to zero.
 *
 * \param timer initialized timer
 * \return the timer overrun counter (typically zero)
 */
824
VLC_API unsigned vlc_timer_getoverrun(vlc_timer_t) VLC_USED;
825

826 827 828 829 830
/**
 * Count CPUs.
 *
 * \return number of available (logical) CPUs.
 */
831 832
VLC_API unsigned vlc_GetCPUCount(void);

833
#if defined (LIBVLC_USE_PTHREAD_CLEANUP)
834
/**
835 836 837 838 839 840
 * Registers a thread cancellation handler.
 *
 * This pushes a function to run if the thread is cancelled (or otherwise
 * exits prematurely).
 *
 * If multiple procedures are registered,
841 842
 * they are handled in last-in first-out order.
 *
843
 * \note Any call to vlc_cleanup_push() <b>must</b> paired with a call to
844
 * vlc_cleanup_pop().
845 846 847 848 849
 * \warning Branching into or out of the block between these two function calls
 * is not allowed (read: it will likely crash the whole process).
 *
 * \param routine procedure to call if the thread ends
 * \param arg argument for the procedure
850 851 852 853
 */
# define vlc_cleanup_push( routine, arg ) pthread_cleanup_push (routine, arg)

/**
854 855 856 857
 * Unregisters the last cancellation handler.
 *
 * This pops the cancellation handler that was last pushed with
 * vlc_cleanup_push() in the calling thread.
858 859 860 861
 */
# define vlc_cleanup_pop( ) pthread_cleanup_pop (0)

#else
862 863 864 865 866
enum
{
    VLC_CLEANUP_PUSH,
    VLC_CLEANUP_POP,
};
867 868 869 870 871 872 873 874 875 876
typedef struct vlc_cleanup_t vlc_cleanup_t;

struct vlc_cleanup_t
{
    vlc_cleanup_t *next;
    void         (*proc) (void *);
    void          *data;
};

/* This macros opens a code block on purpose. This is needed for multiple
877
 * calls within a single function. This also prevent Win32 developers from
878 879 880 881 882 883 884 885 886 887
 * writing code that would break on POSIX (POSIX opens a block as well). */
# define vlc_cleanup_push( routine, arg ) \
    do { \
        vlc_cleanup_t vlc_cleanup_data = { NULL, routine, arg, }; \
        vlc_control_cancel (VLC_CLEANUP_PUSH, &vlc_cleanup_data)

# define vlc_cleanup_pop( ) \
        vlc_control_cancel (VLC_CLEANUP_POP); \
    } while (0)

Rémi Denis-Courmont's avatar
typo  
Rémi Denis-Courmont committed
888
#endif /* !LIBVLC_USE_PTHREAD_CLEANUP */
889

890 891 892 893 894 895
static inline void vlc_cleanup_lock (void *lock)
{
    vlc_mutex_unlock ((vlc_mutex_t *)lock);
}
#define mutex_cleanup_push( lock ) vlc_cleanup_push (vlc_cleanup_lock, lock)

896 897 898
#ifdef __cplusplus
/**
 * Helper C++ class to lock a mutex.
899
 *
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
 * The mutex is locked when the object is created, and unlocked when the object
 * is destroyed.
 */
class vlc_mutex_locker
{
    private:
        vlc_mutex_t *lock;
    public:
        vlc_mutex_locker (vlc_mutex_t *m) : lock (m)
        {
            vlc_mutex_lock (lock);
        }

        ~vlc_mutex_locker (void)
        {
            vlc_mutex_unlock (lock);
        }
};
#endif

920 921
enum
{
922 923
   VLC_AVCODEC_MUTEX = 0,
   VLC_GCRYPT_MUTEX,
924
   VLC_XLIB_MUTEX,
925
   VLC_MOSAIC_MUTEX,
926
   VLC_HIGHLIGHT_MUTEX,
927
   /* Insert new entry HERE */
928 929 930
   VLC_MAX_MUTEX
};

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
/**
 * Internal handler for global mutexes.
 *
 * Do not use this function directly. Use helper macros instead:
 * vlc_global_lock(), vlc_global_unlock().
 */
VLC_API void vlc_global_mutex(unsigned, bool);

/**
 * Acquires a global mutex.
 */
#define vlc_global_lock( n ) vlc_global_mutex(n, true)

/**
 * Releases a global mutex.
 */
#define vlc_global_unlock( n ) vlc_global_mutex(n, false)
948

949 950
/** @} */

951
#endif /* !_VLC_THREADS_H */