A whole bunch of changes to eventually support
[libgcrypt.git] / src / ath.h
1 /* ath.h - Thread-safeness library.
2    Copyright (C) 2002, 2003, 2004 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, but
12    WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    General Public License for more details.
15  
16    You should have received a copy of the GNU Lesser General Public
17    License along with Libgcrypt; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
19    02111-1307, USA.  */
20
21 #ifndef ATH_H
22 #define ATH_H
23
24 #ifdef _WIN32
25 #include <windows.h>
26 #else
27 #include <sys/types.h>
28 #include <sys/socket.h>
29 #endif
30 #include <gpg-error.h>
31
32 #include <config.h>
33
34 \f
35 /* Define _ATH_EXT_SYM_PREFIX if you want to give all external symbols
36    a prefix.  */
37 #define _ATH_EXT_SYM_PREFIX _gcry_
38
39 #ifdef _ATH_EXT_SYM_PREFIX
40 #define _ATH_PREFIX1(x,y) x ## y
41 #define _ATH_PREFIX2(x,y) _ATH_PREFIX1(x,y)
42 #define _ATH_PREFIX(x) _ATH_PREFIX2(_ATH_EXT_SYM_PREFIX,x)
43 #define ath_install _ATH_PREFIX(ath_install)
44 #define ath_init _ATH_PREFIX(ath_init)
45 #define ath_mutex_init _ATH_PREFIX(ath_mutex_init)
46 #define ath_mutex_destroy _ATH_PREFIX(ath_mutex_destroy)
47 #define ath_mutex_lock _ATH_PREFIX(ath_mutex_lock)
48 #define ath_mutex_unlock _ATH_PREFIX(ath_mutex_unlock)
49 #define ath_read _ATH_PREFIX(ath_read)
50 #define ath_write _ATH_PREFIX(ath_write)
51 #define ath_select _ATH_PREFIX(ath_select)
52 #define ath_waitpid _ATH_PREFIX(ath_waitpid)
53 #define ath_connect _ATH_PREFIX(ath_connect)
54 #define ath_accept _ATH_PREFIX(ath_accept)
55 #define ath_sendmsg _ATH_PREFIX(ath_sendmsg)
56 #define ath_recvmsg _ATH_PREFIX(ath_recvmsg)
57 #endif
58
59 \f
60 enum ath_thread_option
61   {
62     ATH_THREAD_OPTION_DEFAULT = 0,
63     ATH_THREAD_OPTION_USER = 1,
64     ATH_THREAD_OPTION_PTH = 2,
65     ATH_THREAD_OPTION_PTHREAD = 3
66   };
67
68 struct ath_ops
69 {
70   /* The OPTION field encodes the thread model and the version number
71      of this structure.   
72        Bits  7 - 0  are used for the thread model
73        Bits 15 - 8  are used for the version number.
74   */
75   unsigned int option;
76
77   int (*init) (void);
78   int (*mutex_init) (void **priv);
79   int (*mutex_destroy) (void *priv);
80   int (*mutex_lock) (void *priv);
81   int (*mutex_unlock) (void *priv);
82   ssize_t (*read) (int fd, void *buf, size_t nbytes);
83   ssize_t (*write) (int fd, const void *buf, size_t nbytes);
84 #ifdef _WIN32
85   ssize_t (*select) (int nfd, void *rset, void *wset, void *eset,
86                      struct timeval *timeout);
87   ssize_t (*waitpid) (pid_t pid, int *status, int options);
88   int (*accept) (int s, void  *addr, int *length_ptr);
89   int (*connect) (int s, void *addr, int length);
90   int (*sendmsg) (int s, const void *msg, int flags);
91   int (*recvmsg) (int s, void *msg, int flags);
92 #else
93   ssize_t (*select) (int nfd, fd_set *rset, fd_set *wset, fd_set *eset,
94                      struct timeval *timeout);
95   ssize_t (*waitpid) (pid_t pid, int *status, int options);
96   int (*accept) (int s, struct sockaddr *addr, socklen_t *length_ptr);
97   int (*connect) (int s, struct sockaddr *addr, socklen_t length);
98   int (*sendmsg) (int s, const struct msghdr *msg, int flags);
99   int (*recvmsg) (int s, struct msghdr *msg, int flags);
100 #endif
101 };
102
103 gpg_err_code_t ath_install (struct ath_ops *ath_ops, int check_only);
104 int ath_init (void);
105
106
107 /* Functions for mutual exclusion.  */
108 typedef void *ath_mutex_t;
109 #define ATH_MUTEX_INITIALIZER 0
110
111 int ath_mutex_init (ath_mutex_t *mutex);
112 int ath_mutex_destroy (ath_mutex_t *mutex);
113 int ath_mutex_lock (ath_mutex_t *mutex);
114 int ath_mutex_unlock (ath_mutex_t *mutex);
115
116 /* Replacement for the POSIX functions, which can be used to allow
117    other (user-level) threads to run.  */
118 ssize_t ath_read (int fd, void *buf, size_t nbytes);
119 ssize_t ath_write (int fd, const void *buf, size_t nbytes);
120 #ifdef _WIN32
121 ssize_t ath_select (int nfd, void *rset, void *wset, void *eset,
122                     struct timeval *timeout);
123 ssize_t ath_waitpid (pid_t pid, int *status, int options);
124 int ath_accept (int s, void *addr, int *length_ptr);
125 int ath_connect (int s, void *addr, int length);
126 int ath_sendmsg (int s, const void *msg, int flags);
127 int ath_recvmsg (int s, void *msg, int flags);
128 #else
129 ssize_t ath_select (int nfd, fd_set *rset, fd_set *wset, fd_set *eset,
130                     struct timeval *timeout);
131 ssize_t ath_waitpid (pid_t pid, int *status, int options);
132 int ath_accept (int s, struct sockaddr *addr, socklen_t *length_ptr);
133 int ath_connect (int s, struct sockaddr *addr, socklen_t length);
134 int ath_sendmsg (int s, const struct msghdr *msg, int flags);
135 int ath_recvmsg (int s, struct msghdr *msg, int flags);
136 #endif 
137
138 #endif  /* ATH_H */