Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 1 | |
Fred Drake | 3cf4d2b | 2000-07-09 00:55:06 +0000 | [diff] [blame] | 2 | #ifndef Py_PYTHREAD_H |
| 3 | #define Py_PYTHREAD_H |
| 4 | |
Guido van Rossum | 65d5b57 | 1998-12-21 19:32:43 +0000 | [diff] [blame] | 5 | typedef void *PyThread_type_lock; |
| 6 | typedef void *PyThread_type_sema; |
Sjoerd Mullender | d10d829 | 1992-09-11 15:19:27 +0000 | [diff] [blame] | 7 | |
| 8 | #ifdef __cplusplus |
| 9 | extern "C" { |
| 10 | #endif |
| 11 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 12 | PyAPI_FUNC(void) PyThread_init_thread(void); |
| 13 | PyAPI_FUNC(long) PyThread_start_new_thread(void (*)(void *), void *); |
| 14 | PyAPI_FUNC(void) PyThread_exit_thread(void); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 15 | PyAPI_FUNC(long) PyThread_get_thread_ident(void); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 16 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 17 | PyAPI_FUNC(PyThread_type_lock) PyThread_allocate_lock(void); |
| 18 | PyAPI_FUNC(void) PyThread_free_lock(PyThread_type_lock); |
| 19 | PyAPI_FUNC(int) PyThread_acquire_lock(PyThread_type_lock, int); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 20 | #define WAIT_LOCK 1 |
| 21 | #define NOWAIT_LOCK 0 |
Antoine Pitrou | 7c3e577 | 2010-04-14 15:44:10 +0000 | [diff] [blame] | 22 | |
| 23 | /* PY_TIMEOUT_T is the integral type used to specify timeouts when waiting |
| 24 | on a lock (see PyThread_acquire_lock_timed() below). |
| 25 | PY_TIMEOUT_MAX is the highest usable value (in microseconds) of that |
| 26 | type, and depends on the system threading API. |
| 27 | |
| 28 | NOTE: this isn't the same value as `_thread.TIMEOUT_MAX`. The _thread |
| 29 | module exposes a higher-level API, with timeouts expressed in seconds |
| 30 | and floating-point numbers allowed. |
| 31 | */ |
| 32 | #if defined(HAVE_LONG_LONG) |
| 33 | #define PY_TIMEOUT_T PY_LONG_LONG |
| 34 | #define PY_TIMEOUT_MAX PY_LLONG_MAX |
| 35 | #else |
| 36 | #define PY_TIMEOUT_T long |
| 37 | #define PY_TIMEOUT_MAX LONG_MAX |
| 38 | #endif |
| 39 | |
| 40 | /* In the NT API, the timeout is a DWORD and is expressed in milliseconds */ |
| 41 | #if defined (NT_THREADS) |
| 42 | #if (0xFFFFFFFFLL * 1000 < PY_TIMEOUT_MAX) |
| 43 | #undef PY_TIMEOUT_MAX |
| 44 | #define PY_TIMEOUT_MAX (0xFFFFFFFFLL * 1000) |
| 45 | #endif |
| 46 | #endif |
| 47 | |
| 48 | /* If microseconds == 0, the call is non-blocking: it returns immediately |
| 49 | even when the lock can't be acquired. |
| 50 | If microseconds > 0, the call waits up to the specified duration. |
| 51 | If microseconds < 0, the call waits until success (or abnormal failure) |
| 52 | |
| 53 | microseconds must be less than PY_TIMEOUT_MAX. Behaviour otherwise is |
| 54 | undefined. */ |
| 55 | PyAPI_FUNC(int) PyThread_acquire_lock_timed(PyThread_type_lock, |
| 56 | PY_TIMEOUT_T microseconds); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 57 | PyAPI_FUNC(void) PyThread_release_lock(PyThread_type_lock); |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 58 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 59 | PyAPI_FUNC(size_t) PyThread_get_stacksize(void); |
| 60 | PyAPI_FUNC(int) PyThread_set_stacksize(size_t); |
| 61 | |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 62 | /* Thread Local Storage (TLS) API */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 63 | PyAPI_FUNC(int) PyThread_create_key(void); |
| 64 | PyAPI_FUNC(void) PyThread_delete_key(int); |
| 65 | PyAPI_FUNC(int) PyThread_set_key_value(int, void *); |
| 66 | PyAPI_FUNC(void *) PyThread_get_key_value(int); |
Mark Hammond | 8d98d2c | 2003-04-19 15:41:53 +0000 | [diff] [blame] | 67 | PyAPI_FUNC(void) PyThread_delete_key_value(int key); |
Guido van Rossum | a027efa | 1997-05-05 20:56:21 +0000 | [diff] [blame] | 68 | |
Benjamin Peterson | e68df0f | 2008-06-13 00:26:50 +0000 | [diff] [blame] | 69 | /* Cleanup after a fork */ |
| 70 | PyAPI_FUNC(void) PyThread_ReInitTLS(void); |
| 71 | |
Sjoerd Mullender | d10d829 | 1992-09-11 15:19:27 +0000 | [diff] [blame] | 72 | #ifdef __cplusplus |
| 73 | } |
| 74 | #endif |
| 75 | |
Guido van Rossum | d023a78 | 1999-03-24 19:02:09 +0000 | [diff] [blame] | 76 | #endif /* !Py_PYTHREAD_H */ |