2003-10-06 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / ath.h
1 /* ath.h - Interfaces for thread-safeness library.
2    Copyright (C) 2002, 2003 g10 Code GmbH
3
4    This file is part of GPGME.
5  
6    GPGME is free software; you can redistribute it and/or modify it
7    under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10  
11    GPGME 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 General Public License
17    along with GPGME; if not, write to the Free Software Foundation,
18    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
19
20 #ifndef ATH_H
21 #define ATH_H
22
23 #ifdef HAVE_SYS_SELECT_H
24 # include <sys/select.h>
25 #else
26 # include <sys/time.h>
27 #endif
28 #include <sys/types.h>
29 #include <sys/socket.h>
30
31 \f
32 /* Define _ATH_EXT_SYM_PREFIX if you want to give all external symbols
33    a prefix.  */
34 #define _ATH_EXT_SYM_PREFIX _gpgme_
35
36 #ifdef _ATH_EXT_SYM_PREFIX
37 #define _ATH_PREFIX1(x,y) x ## y
38 #define _ATH_PREFIX2(x,y) _ATH_PREFIX1(x,y)
39 #define _ATH_PREFIX(x) _ATH_PREFIX2(_ATH_EXT_SYM_PREFIX,x)
40 #define ath_mutex_init _ATH_PREFIX(ath_mutex_init)
41 #define ath_mutex_destroy _ATH_PREFIX(ath_mutex_destroy)
42 #define ath_mutex_lock _ATH_PREFIX(ath_mutex_lock)
43 #define ath_mutex_unlock _ATH_PREFIX(ath_mutex_unlock)
44 #define ath_read _ATH_PREFIX(ath_read)
45 #define ath_write _ATH_PREFIX(ath_write)
46 #define ath_select _ATH_PREFIX(ath_select)
47 #define ath_waitpid _ATH_PREFIX(ath_waitpid)
48 #define ath_connect _ATH_PREFIX(ath_connect)
49 #define ath_accept _ATH_PREFIX(ath_accept)
50 #define ath_sendmsg _ATH_PREFIX(ath_sendmsg)
51 #define ath_recvmsg _ATH_PREFIX(ath_recvmsg)
52 #endif
53
54 \f
55 typedef void *ath_mutex_t;
56 #define ATH_MUTEX_INITIALIZER 0;
57
58 /* Functions for mutual exclusion.  */
59 int ath_mutex_init (ath_mutex_t *mutex);
60 int ath_mutex_destroy (ath_mutex_t *mutex);
61 int ath_mutex_lock (ath_mutex_t *mutex);
62 int ath_mutex_unlock (ath_mutex_t *mutex);
63
64 /* Replacement for the POSIX functions, which can be used to allow
65    other (user-level) threads to run.  */
66 ssize_t ath_read (int fd, void *buf, size_t nbytes);
67 ssize_t ath_write (int fd, const void *buf, size_t nbytes);
68 ssize_t ath_select (int nfd, fd_set *rset, fd_set *wset, fd_set *eset,
69                     struct timeval *timeout);
70 ssize_t ath_waitpid (pid_t pid, int *status, int options);
71 int ath_accept (int s, struct sockaddr *addr, socklen_t *length_ptr);
72 int ath_connect (int s, struct sockaddr *addr, socklen_t length);
73 int ath_sendmsg (int s, const struct msghdr *msg, int flags);
74 int ath_recvmsg (int s, struct msghdr *msg, int flags);
75
76 #define _ATH_COMPAT
77 #ifdef _ATH_COMPAT
78 struct ath_ops
79 {
80   int (*mutex_init) (void **priv, int just_check);
81   int (*mutex_destroy) (void *priv);
82   int (*mutex_lock) (void *priv);
83   int (*mutex_unlock) (void *priv);
84   ssize_t (*read) (int fd, void *buf, size_t nbytes);
85   ssize_t (*write) (int fd, const void *buf, size_t nbytes);
86   ssize_t (*select) (int nfd, fd_set *rset, fd_set *wset, fd_set *eset,
87                      struct timeval *timeout);
88   ssize_t (*waitpid) (pid_t pid, int *status, int options);
89   int (*accept) (int s, struct sockaddr *addr, socklen_t *length_ptr);
90   int (*connect) (int s, struct sockaddr *addr, socklen_t length);
91   int (*sendmsg) (int s, const struct msghdr *msg, int flags);
92   int (*recvmsg) (int s, struct msghdr *msg, int flags);
93 };
94
95 /* Initialize the any-thread package.  */
96 #define ath_init _ATH_PREFIX(ath_init)
97 void ath_init (void);
98
99 /* Used by ath_pkg_init.  */
100 #define ath_pthread_available _ATH_PREFIX(ath_pthread_available)
101 struct ath_ops *ath_pthread_available (void);
102 #define ath_pth_available _ATH_PREFIX(ath_pth_available)
103 struct ath_ops *ath_pth_available (void);
104 #endif
105
106 #endif  /* ATH_H */