include/xbt/xbt_os_thread.h

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