2003-09-28 Moritz Schulte <mo@g10code.com>
[libgcrypt.git] / src / ath.h
1 /* ath.h - Thread-safeness library.
2    Copyright (C) 2002, 2003 g10 Code GmbH
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 #include <sys/types.h>
25 #include <sys/socket.h>
26
27 \f
28 /* Define _ATH_EXT_SYM_PREFIX if you want to give all external symbols
29    a prefix.  */
30 #define _ATH_EXT_SYM_PREFIX _gcry_
31
32 #ifdef _ATH_EXT_SYM_PREFIX
33 #define _ATH_PREFIX1(x,y) x ## y
34 #define _ATH_PREFIX2(x,y) _ATH_PREFIX1(x,y)
35 #define _ATH_PREFIX(x) _ATH_PREFIX2(_ATH_EXT_SYM_PREFIX,x)
36 #define ath_mutex_init _ATH_PREFIX(ath_mutex_init)
37 #define ath_mutex_destroy _ATH_PREFIX(ath_mutex_destroy)
38 #define ath_mutex_lock _ATH_PREFIX(ath_mutex_lock)
39 #define ath_mutex_unlock _ATH_PREFIX(ath_mutex_unlock)
40 #define ath_read _ATH_PREFIX(ath_read)
41 #define ath_write _ATH_PREFIX(ath_write)
42 #define ath_select _ATH_PREFIX(ath_select)
43 #define ath_waitpid _ATH_PREFIX(ath_waitpid)
44 #define ath_connect _ATH_PREFIX(ath_connect)
45 #define ath_accept _ATH_PREFIX(ath_accept)
46 #define ath_sendmsg _ATH_PREFIX(ath_sendmsg)
47 #define ath_recvmsg _ATH_PREFIX(ath_recvmsg)
48 #endif
49
50 \f
51 typedef void *ath_mutex_t;
52 #define ATH_MUTEX_INITIALIZER 0;
53
54 /* Functions for mutual exclusion.  */
55 int ath_mutex_init (ath_mutex_t *mutex);
56 int ath_mutex_destroy (ath_mutex_t *mutex);
57 int ath_mutex_lock (ath_mutex_t *mutex);
58 int ath_mutex_unlock (ath_mutex_t *mutex);
59
60 /* Replacement for the POSIX functions, which can be used to allow
61    other (user-level) threads to run.  */
62 ssize_t ath_read (int fd, void *buf, size_t nbytes);
63 ssize_t ath_write (int fd, const void *buf, size_t nbytes);
64 ssize_t ath_select (int nfd, fd_set *rset, fd_set *wset, fd_set *eset,
65                     struct timeval *timeout);
66 ssize_t ath_waitpid (pid_t pid, int *status, int options);
67 int ath_accept (int s, struct sockaddr *addr, socklen_t *length_ptr);
68 int ath_connect (int s, struct sockaddr *addr, socklen_t length);
69 int ath_sendmsg (int s, const struct msghdr *msg, int flags);
70 int ath_recvmsg (int s, struct msghdr *msg, int flags);
71
72 #define _ATH_COMPAT
73 #ifdef _ATH_COMPAT
74 struct ath_ops
75 {
76   int (*mutex_init) (void **priv, int just_check);
77   int (*mutex_destroy) (void *priv);
78   int (*mutex_lock) (void *priv);
79   int (*mutex_unlock) (void *priv);
80   ssize_t (*read) (int fd, void *buf, size_t nbytes);
81   ssize_t (*write) (int fd, const void *buf, size_t nbytes);
82   ssize_t (*select) (int nfd, fd_set *rset, fd_set *wset, fd_set *eset,
83                      struct timeval *timeout);
84   ssize_t (*waitpid) (pid_t pid, int *status, int options);
85   int (*accept) (int s, struct sockaddr *addr, socklen_t *length_ptr);
86   int (*connect) (int s, struct sockaddr *addr, socklen_t length);
87   int (*sendmsg) (int s, const struct msghdr *msg, int flags);
88   int (*recvmsg) (int s, struct msghdr *msg, int flags);
89 };
90
91 /* Initialize the any-thread package.  */
92 #define ath_init _ATH_PREFIX(ath_init)
93 void ath_init (void);
94
95 /* Used by ath_pkg_init.  */
96 #define ath_pthread_available _ATH_PREFIX(ath_pthread_available)
97 struct ath_ops *ath_pthread_available (void);
98 #define ath_pth_available _ATH_PREFIX(ath_pth_available)
99 struct ath_ops *ath_pth_available (void);
100 #endif
101
102 #endif  /* ATH_H */