1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
#ifndef APR_LOCKS_H
#define APR_LOCKS_H
#include "apr.h"
#include "apr_pools.h"
#include "apr_errno.h"
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/**
* @package APR lock library
*/
typedef enum {APR_CROSS_PROCESS, APR_INTRAPROCESS, APR_LOCKALL} apr_lockscope_e;
typedef enum {APR_MUTEX, APR_READWRITE} apr_locktype_e;
typedef enum {APR_READER, APR_WRITER} apr_readerwriter_e;
typedef struct apr_lock_t apr_lock_t;
/* Function definitions */
/**
* Create a new instance of a lock structure.
* @param lock The newly created lock structure.
* @param type The type of lock to create, one of:
* <PRE>
* APR_MUTEX
* APR_READWRITE
* </PRE>
* @param scope The scope of the lock to create, one of:
* <PRE>
* APR_CROSS_PROCESS lock processes from the protected area.
* APR_INTRAPROCESS lock threads from the protected area.
* APR_LOCKALL lock processes and threads from the
* protected area.
* </PRE>
* @param fname A file name to use if the lock mechanism requires one. This
* argument should always be provided. The lock code itself will
* determine if it should be used.
* @param pool The pool to operate on.
* @tip APR_CROSS_PROCESS may lock both processes and threads, but it is
* only guaranteed to lock processes.
* @deffunc apr_status_t apr_lock_create(apr_lock_t **lock, apr_locktype_e type, apr_lockscope_e scope, const char *fname, apr_pool_t *pool)
*/
APR_DECLARE(apr_status_t) apr_lock_create(apr_lock_t **lock,
apr_locktype_e type,
apr_lockscope_e scope,
const char *fname,
apr_pool_t *pool);
/**
* Lock a protected region.
* @param lock The lock to set.
* @deffunc apr_status_t apr_lock_acquire(apr_lock_t *lock)
*/
APR_DECLARE(apr_status_t) apr_lock_acquire(apr_lock_t *lock);
/**
* Tries to lock a protected region.
* If it fails, returns APR_EBUSY. Otherwise, it returns APR_SUCCESS.
* @param lock The lock to set.
* @deffunc apr_status_t apr_lock_tryacquire(apr_lock_t *lock)
*/
APR_DECLARE(apr_status_t) apr_lock_tryacquire(apr_lock_t *lock);
/**
* Lock a region with either a reader or writer lock.
* @param lock The lock to set.
* @param type The type of lock to acquire.
* @deffunc apr_status_t apr_lock_acquire_rw(apr_lock_t *lock, apr_readerwriter_e type)
*/
APR_DECLARE(apr_status_t) apr_lock_acquire_rw(apr_lock_t *lock,
apr_readerwriter_e type);
/**
* Unlock a protected region.
* @param lock The lock to reset.
* @deffunc apr_status_t apr_lock_release(apr_lock_t *lock)
*/
APR_DECLARE(apr_status_t) apr_lock_release(apr_lock_t *lock);
/**
* Free the memory associated with a lock.
* @param lock The lock to free.
* @deffunc apr_status_t apr_lock_destroy(apr_lock_t *lock)
* @tip If the lock is currently active when it is destroyed, it
* will be unlocked first.
*/
APR_DECLARE(apr_status_t) apr_lock_destroy(apr_lock_t *lock);
/**
* Re-open a lock in a child process.
* @param lock The newly re-opened lock structure.
* @param fname A file name to use if the lock mechanism requires one. This
* argument should always be provided. The lock code itself will
* determine if it should be used. This filename should be the
* same one that was passed to apr_lock_create
* @param pool The pool to operate on.
* @tip This function doesn't always do something, it depends on the
* locking mechanism chosen for the platform, but it is a good
* idea to call it regardless, because it makes the code more
* portable.
* @deffunc apr_status_t apr_lock_child_init(apr_lock_t **lock, const char *fname, apr_pool_t *pool)
*/
APR_DECLARE(apr_status_t) apr_lock_child_init(apr_lock_t **lock,
const char *fname,
apr_pool_t *pool);
/**
* Return the pool associated with the current lock.
* @param lock The currently open lock.
* @param key The key to use when retreiving data associated with this lock
* @param data The user data associated with the lock.
* @deffunc apr_status_t apr_lock_data_get(apr_lock_t *lock, const char *key, void *data)
*/
APR_DECLARE(apr_status_t) apr_lock_data_get(apr_lock_t *lock, const char *key,
void *data);
/**
* Return the pool associated with the current lock.
* @param lock The currently open lock.
* @param data The user data to associate with the lock.
* @param key The key to use when associating data with this lock
* @param cleanup The cleanup to use when the lock is destroyed.
* @deffunc apr_status_t apr_lock_data_set(apr_lock_t *lock, void *data, const char *key, apr_status_t (*cleanup)(void *))
*/
APR_DECLARE(apr_status_t) apr_lock_data_set(apr_lock_t *lock, void *data,
const char *key,
apr_status_t (*cleanup)(void *));
#if APR_HAS_LOCK_CREATE_NP
typedef enum {APR_LOCK_FCNTL, APR_LOCK_FLOCK, APR_LOCK_SYSVSEM, APR_LOCK_PROC_PTHREAD,
APR_LOCK_DEFAULT} apr_lockmech_e_np;
/**
* non-portable interface to apr_lock_create()
*
* Create a new instance of a lock structure. This is like apr_lock_create()
* but has some non-portable parameters. This should be used sparingly.
*
* @param lock The newly created lock structure.
* @param type The type of lock to create, one of:
* <PRE>
* APR_MUTEX
* APR_READWRITE
* </PRE>
* @param scope The scope of the lock to create, one of:
* <PRE>
* APR_CROSS_PROCESS lock processes from the protected area.
* APR_INTRAPROCESS lock threads from the protected area.
* APR_LOCKALL lock processes and threads from the
* protected area.
* </PRE>
* @param mech The mechanism to use for the interprocess lock, if any; one of
* <PRE>
* APR_LOCK_FCNTL
* APR_LOCK_FLOCK
* APR_LOCK_SYSVSEM
* APR_LOCK_PROC_PTHREAD
* APR_LOCK_DEFAULT pick the default mechanism for the platform
* </PRE>
* @param fname A file name to use if the lock mechanism requires one. This
* argument should always be provided. The lock code itself will
* determine if it should be used.
* @param pool The pool to operate on.
* @tip APR_CROSS_PROCESS may lock both processes and threads, but it is
* only guaranteed to lock processes.
* @deffunc apr_status_t apr_lock_create(apr_lock_t **lock, apr_locktype_e type, apr_lockscope_e scope, const char *fname, apr_pool_t *pool)
*/
APR_DECLARE(apr_status_t) apr_lock_create_np(apr_lock_t **lock,
apr_locktype_e type,
apr_lockscope_e scope,
apr_lockmech_e_np mech,
const char *fname,
apr_pool_t *pool);
#endif /* APR_HAS_LOCK_CREATE_NP */
#ifdef __cplusplus
}
#endif
#endif /* ! APR_LOCKS_H */
|
