X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/fbf3527063143094ed40d1a4a3bc595c29b81145..3297da9f47ce18371941b2b48a2f4018b4793ced:/include/xbt/xbt_os_thread.h diff --git a/include/xbt/xbt_os_thread.h b/include/xbt/xbt_os_thread.h index 3d9542941d..d555995c1a 100644 --- a/include/xbt/xbt_os_thread.h +++ b/include/xbt/xbt_os_thread.h @@ -1,109 +1,61 @@ /* xbt/xbt_os_thread.h -- Thread portability layer */ -/* Copyright (c) 2007-2015. The SimGrid Team. - * All rights reserved. */ +/* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -#ifndef _XBT_OS_THREAD_H -#define _XBT_OS_THREAD_H +#ifndef XBT_OS_THREAD_H +#define XBT_OS_THREAD_H -#include "simgrid_config.h" /* Windows or Posix */ -#include "xbt/function_types.h" +#include +#include + +#include SG_BEGIN_DECL() /** @addtogroup XBT_thread * @brief Thread portability layer - * + * * This section describes the thread portability layer. It defines types and functions very close to the pthread API, * but it's portable to windows too. - * - * @{ - */ - /** \brief Thread data type (opaque structure) */ -typedef struct xbt_os_thread_ *xbt_os_thread_t; - -#ifdef _XBT_WIN32 /* defined if this is a windows system, 32bits or 64bits) */ -#include -#endif - -#include -typedef pthread_key_t xbt_os_thread_key_t; -/** Calls pthread_atfork() if present, and raise an exception otherwise. * - * The only known user of this wrapper is mmalloc_preinit(), but it is absolutely mandatory there: - * when used with tesh, mmalloc *must* be mutex protected and resistant to forks. - * This functionality is the only way to get it working (by ensuring that the mutex is consistently released on forks) - */ -XBT_PUBLIC(int) xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void)); - -XBT_PUBLIC(int) xbt_os_get_numcores(void); - -XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_create(const char *name, pvoid_f_pvoid_t start_routine, void *param, void *data); - -/** Bind the thread to the given core, if possible. - * - * If pthread_setaffinity_np is not usable on that (non-gnu) platform, this function does nothing. + * @{ */ -XBT_PUBLIC(int) xbt_os_thread_bind(xbt_os_thread_t thread, int core); -XBT_PUBLIC(void) xbt_os_thread_exit(int *retcode); -XBT_PUBLIC(void) xbt_os_thread_detach(xbt_os_thread_t thread); -XBT_PUBLIC(xbt_os_thread_t) xbt_os_thread_self(void); -XBT_PUBLIC(const char *) xbt_os_thread_self_name(void); -XBT_PUBLIC(const char *) xbt_os_thread_name(xbt_os_thread_t); -XBT_PUBLIC(void) xbt_os_thread_set_extra_data(void *data); -XBT_PUBLIC(void *) xbt_os_thread_get_extra_data(void); -XBT_PUBLIC(void) xbt_os_thread_key_create(xbt_os_thread_key_t* key); -XBT_PUBLIC(void) xbt_os_thread_set_specific(xbt_os_thread_key_t key, void* value); -XBT_PUBLIC(void*) xbt_os_thread_get_specific(xbt_os_thread_key_t key); - /* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */ -XBT_PUBLIC(void) xbt_os_thread_join(xbt_os_thread_t thread, void **thread_return); -XBT_PUBLIC(void) xbt_os_thread_yield(void); -XBT_PUBLIC(void) xbt_os_thread_cancel(xbt_os_thread_t thread); -XBT_PUBLIC(void) xbt_os_thread_setstacksize(int stack_size); -XBT_PUBLIC(void) xbt_os_thread_setguardsize(int guard_size); - - /** \brief Thread mutex data type (opaque structure) */ +/** @brief Thread data type (opaque structure) */ +typedef struct xbt_os_thread_ *xbt_os_thread_t; +XBT_PUBLIC xbt_os_thread_t xbt_os_thread_create(const char* name, pvoid_f_pvoid_t start_routine, void* param, + void* data); +XBT_PUBLIC void xbt_os_thread_exit(int* retcode); + +XBT_PUBLIC xbt_os_thread_t xbt_os_thread_self(void); +XBT_PUBLIC const char* xbt_os_thread_self_name(void); +XBT_PUBLIC void xbt_os_thread_set_extra_data(void* data); +XBT_PUBLIC void* xbt_os_thread_get_extra_data(void); +/* xbt_os_thread_join frees the joined thread (ie the XBT wrapper around it, the OS frees the rest) */ +XBT_PUBLIC void xbt_os_thread_join(xbt_os_thread_t thread, void** thread_return); +XBT_PUBLIC void xbt_os_thread_setstacksize(int stack_size); +XBT_PUBLIC void xbt_os_thread_setguardsize(int guard_size); +XBT_PUBLIC int xbt_os_thread_bind(xbt_os_thread_t thread, int core); +XBT_PUBLIC int xbt_os_thread_atfork(void (*prepare)(void), void (*parent)(void), void (*child)(void)); + +/** @brief Thread mutex data type (opaque structure) */ typedef struct xbt_os_mutex_ *xbt_os_mutex_t; +XBT_PUBLIC xbt_os_mutex_t xbt_os_mutex_init(void); +XBT_PUBLIC void xbt_os_mutex_acquire(xbt_os_mutex_t mutex); +XBT_PUBLIC void xbt_os_mutex_release(xbt_os_mutex_t mutex); +XBT_PUBLIC void xbt_os_mutex_destroy(xbt_os_mutex_t mutex); -XBT_PUBLIC(xbt_os_mutex_t) xbt_os_mutex_init(void); -XBT_PUBLIC(void) xbt_os_mutex_acquire(xbt_os_mutex_t mutex); -XBT_PUBLIC(void) xbt_os_mutex_timedacquire(xbt_os_mutex_t mutex, double delay); -XBT_PUBLIC(void) xbt_os_mutex_release(xbt_os_mutex_t mutex); -XBT_PUBLIC(void) xbt_os_mutex_destroy(xbt_os_mutex_t mutex); - -/** \brief Thread reentrant mutex data type (opaque structure) */ -typedef struct xbt_os_rmutex_ *xbt_os_rmutex_t; - -XBT_PUBLIC(xbt_os_rmutex_t) xbt_os_rmutex_init(void); -XBT_PUBLIC(void) xbt_os_rmutex_acquire(xbt_os_rmutex_t rmutex); -XBT_PUBLIC(void) xbt_os_rmutex_release(xbt_os_rmutex_t rmutex); -XBT_PUBLIC(void) xbt_os_rmutex_destroy(xbt_os_rmutex_t rmutex); - -/** \brief Thread condition data type (opaque structure) */ -typedef struct xbt_os_cond_ *xbt_os_cond_t; - -XBT_PUBLIC(xbt_os_cond_t) xbt_os_cond_init(void); -XBT_PUBLIC(void) xbt_os_cond_wait(xbt_os_cond_t cond, xbt_os_mutex_t mutex); -XBT_PUBLIC(void) xbt_os_cond_timedwait(xbt_os_cond_t cond, xbt_os_mutex_t mutex, double delay); -XBT_PUBLIC(void) xbt_os_cond_signal(xbt_os_cond_t cond); -XBT_PUBLIC(void) xbt_os_cond_broadcast(xbt_os_cond_t cond); -XBT_PUBLIC(void) xbt_os_cond_destroy(xbt_os_cond_t cond); - -/** \brief Semaphore data type (opaque structure) */ +/** @brief Semaphore data type (opaque structure) */ typedef struct xbt_os_sem_ *xbt_os_sem_t; - -XBT_PUBLIC(xbt_os_sem_t) xbt_os_sem_init(unsigned int value); -XBT_PUBLIC(void) xbt_os_sem_acquire(xbt_os_sem_t sem); -XBT_PUBLIC(void) xbt_os_sem_timedacquire(xbt_os_sem_t sem, double timeout); -XBT_PUBLIC(void) xbt_os_sem_release(xbt_os_sem_t sem); -XBT_PUBLIC(void) xbt_os_sem_destroy(xbt_os_sem_t sem); -XBT_PUBLIC(void) xbt_os_sem_get_value(xbt_os_sem_t sem, int *svalue); +XBT_PUBLIC xbt_os_sem_t xbt_os_sem_init(unsigned int value); +XBT_PUBLIC void xbt_os_sem_acquire(xbt_os_sem_t sem); +XBT_PUBLIC void xbt_os_sem_release(xbt_os_sem_t sem); +XBT_PUBLIC void xbt_os_sem_destroy(xbt_os_sem_t sem); /** @} */ SG_END_DECL() -#endif /* _XBT_OS_THREAD_H */ +#endif /* XBT_OS_THREAD_H */