include/xbt/xbt_os_thread.h

   1 /* xbt/xbt_os_thread.h -- Thread portability layer                          */
   2
   3 /* Copyright (c) 2007-2015. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #ifndef _XBT_OS_THREAD_H
  10 #define _XBT_OS_THREAD_H
  11
  12 #include "xbt/base.h"
  13
  14 SG_BEGIN_DECL()
  15
  16 #include <pthread.h>
  17 typedef pthread_key_t xbt_os_thread_key_t;
  18
  19 /** @addtogroup XBT_thread
  20  *  @brief Thread portability layer
  21  *
  22  *  This section describes the thread portability layer. It defines types and functions very close to the pthread API,
  23  *  but it's portable to windows too.
  24  *
  25  *  @{
  26  */
  27
  28 XBT_PUBLIC(int) xbt_os_get_numcores(void);
  29
  30   /** \brief Thread data type (opaque structure) */
  31 typedef struct xbt_os_thread_ *xbt_os_thread_t;
  32 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(const char *name, pvoid_f_pvoid_t start_routine, void *param, void *data);
  33 XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode);
  34 XBT_PUBLIC(void) xbt_os_thread_detach(xbt_os_thread_t thread);
  35
  36 XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void);
  37 XBT_PUBLIC(const char *) xbt_os_thread_self_name(void);
  38 XBT_PUBLIC(void) xbt_os_thread_set_extra_data(void *data);
  39 XBT_PUBLIC(void *) xbt_os_thread_get_extra_data(void);
  40 XBT_PUBLIC(void) xbt_os_thread_key_create(xbt_os_thread_key_t* key);
  41 XBT_PUBLIC(void) xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value);
  42 XBT_PUBLIC(void*) xbt_os_thread_get_specific(xbt_os_thread_key_t key);
  43   /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */
  44 XBT_PUBLIC(void) xbt_os_thread_join(xbt_os_thread_t thread, void **thread_return);
  45 XBT_PUBLIC(void) xbt_os_thread_yield(void);
  46 XBT_PUBLIC(void) xbt_os_thread_cancel(xbt_os_thread_t thread);
  47 XBT_PUBLIC(void) xbt_os_thread_setstacksize(int stack_size);
  48 XBT_PUBLIC(void) xbt_os_thread_setguardsize(int guard_size);
  49 XBT_PUBLIC(int) xbt_os_thread_bind(xbt_os_thread_t thread, int core);
  50 XBT_PUBLIC(int) xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void));
  51
  52   /** \brief Thread mutex data type (opaque structure) */
  53 typedef struct xbt_os_mutex_ *xbt_os_mutex_t;
  54 XBT_PUBLIC(xbt_os_mutex_t) xbt_os_mutex_init(void);
  55 XBT_PUBLIC(void) xbt_os_mutex_acquire(xbt_os_mutex_t mutex);
  56 XBT_PUBLIC(void) xbt_os_mutex_release(xbt_os_mutex_t mutex);
  57 XBT_PUBLIC(void) xbt_os_mutex_destroy(xbt_os_mutex_t mutex);
  58
  59 /** \brief Thread condition data type (opaque structure) */
  60 typedef struct xbt_os_cond_ *xbt_os_cond_t;
  61 XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void);
  62 XBT_PUBLIC(void) xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex);
  63 XBT_PUBLIC(void) xbt_os_cond_signal(xbt_os_cond_t cond);
  64 XBT_PUBLIC(void) xbt_os_cond_broadcast(xbt_os_cond_t cond);
  65 XBT_PUBLIC(void) xbt_os_cond_destroy(xbt_os_cond_t cond);
  66
  67 /** \brief Semaphore data type (opaque structure) */
  68 typedef struct xbt_os_sem_ *xbt_os_sem_t;
  69 XBT_PUBLIC(xbt_os_sem_t) xbt_os_sem_init(unsigned int value);
  70 XBT_PUBLIC(void) xbt_os_sem_acquire(xbt_os_sem_t sem);
  71 XBT_PUBLIC(void) xbt_os_sem_release(xbt_os_sem_t sem);
  72 XBT_PUBLIC(void) xbt_os_sem_destroy(xbt_os_sem_t sem);
  73
  74 /** @} */
  75
  76 SG_END_DECL()
  77 #endif                          /* _XBT_OS_THREAD_H */