Completed switch to a simpler thread model.
[libgcrypt.git] / src / ath.h
1 /* ath.h - Thread-safeness library.
2  * Copyright (C) 2002, 2003, 2004, 2011 Free Software Foundation, Inc.
3  *
4  * This file is part of Libgcrypt.
5  *
6  * Libgcrypt is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser general Public License as
8  * published by the Free Software Foundation; either version 2.1 of
9  * the License, or (at your option) any later version.
10  *
11  * Libgcrypt is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef ATH_H
21 #define ATH_H
22
23 #include <config.h>
24
25 #ifdef _WIN32
26 # include <windows.h>
27 #else /* !_WIN32 */
28 # ifdef HAVE_SYS_SELECT_H
29 #  include <sys/select.h>
30 # else
31 #  include <sys/time.h>
32 # endif
33 # include <sys/types.h>
34 # ifdef HAVE_SYS_MSG_H
35 #  include <sys/msg.h>  /* (e.g. for zOS) */
36 # endif
37 # include <sys/socket.h>
38 #endif /* !_WIN32 */
39 #include <gpg-error.h>
40
41
42 \f
43 /* Define _ATH_EXT_SYM_PREFIX if you want to give all external symbols
44    a prefix.  */
45 #define _ATH_EXT_SYM_PREFIX _gcry_
46
47 #ifdef _ATH_EXT_SYM_PREFIX
48 #define _ATH_PREFIX1(x,y) x ## y
49 #define _ATH_PREFIX2(x,y) _ATH_PREFIX1(x,y)
50 #define _ATH_PREFIX(x) _ATH_PREFIX2(_ATH_EXT_SYM_PREFIX,x)
51 #define ath_install _ATH_PREFIX(ath_install)
52 #define ath_init _ATH_PREFIX(ath_init)
53 #define ath_get_model _ATH_PREFIX(ath_get_model)
54 #define ath_mutex_init _ATH_PREFIX(ath_mutex_init)
55 #define ath_mutex_destroy _ATH_PREFIX(ath_mutex_destroy)
56 #define ath_mutex_lock _ATH_PREFIX(ath_mutex_lock)
57 #define ath_mutex_unlock _ATH_PREFIX(ath_mutex_unlock)
58 #endif
59
60 \f
61 enum ath_thread_option
62   {
63     ATH_THREAD_OPTION_DEFAULT = 0,
64     ATH_THREAD_OPTION_USER = 1,
65     ATH_THREAD_OPTION_PTH = 2,
66     ATH_THREAD_OPTION_PTHREAD = 3
67   };
68
69 struct ath_ops
70 {
71   /* The OPTION field encodes the thread model and the version number
72      of this structure.
73        Bits  7 - 0  are used for the thread model
74        Bits 15 - 8  are used for the version number.
75   */
76   unsigned int option;
77
78 };
79
80 gpg_err_code_t ath_install (struct ath_ops *ath_ops);
81 int ath_init (void);
82 const char *ath_get_model (int *r_model);
83
84 /* Functions for mutual exclusion.  */
85 typedef void *ath_mutex_t;
86
87 int ath_mutex_init (ath_mutex_t *mutex);
88 int ath_mutex_destroy (ath_mutex_t *mutex);
89 int ath_mutex_lock (ath_mutex_t *mutex);
90 int ath_mutex_unlock (ath_mutex_t *mutex);
91
92 #endif  /* ATH_H */