summaryrefslogtreecommitdiff
path: root/include/arch/unix/locks.h
blob: 02a96b97f812e95b95ad8382e07c40d8c88f4d27 (plain)
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
/* ====================================================================
 * 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 LOCKS_H
#define LOCKS_H

#include "apr.h"
#include "apr_private.h"
#include "apr_general.h"
#include "apr_lib.h"
#include "apr_lock.h"
#include "apr_sms.h"
#include "apr_portable.h"

/* System headers required by Locks library */
#if APR_HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#if APR_HAVE_STDIO_H
#include <stdio.h>
#endif
#if APR_HAVE_FCNTL_H
#include <fcntl.h>
#endif

#ifdef HAVE_SYS_SEM_H
#include <sys/sem.h>
#endif
#ifdef HAVE_SYS_FILE_H
#include <sys/file.h>
#endif
#if APR_HAVE_STDLIB_H
#include <stdlib.h>
#endif
#if APR_HAVE_UNISTD_H
#include <unistd.h>
#endif
#if APR_HAVE_STRING_H
#include <string.h>
#endif
#ifdef HAVE_SYS_MMAN_H
#include <sys/mman.h>
#endif

#if APR_HAS_THREADS
#if APR_HAVE_PTHREAD_H
#include <pthread.h>
#endif
#endif
/* End System Headers */

struct apr_unix_lock_methods_t {
    apr_status_t (*create)(apr_lock_t *, const char *);
    apr_status_t (*acquire)(apr_lock_t *);
    apr_status_t (*release)(apr_lock_t *);
    apr_status_t (*destroy)(apr_lock_t *);
    apr_status_t (*child_init)(apr_lock_t **, apr_pool_t *, const char *);
};
typedef struct apr_unix_lock_methods_t apr_unix_lock_methods_t;

#if defined(HAVE_SEMCTL) && defined(HAVE_SEMGET)
#define APR_HAS_SYSVSEM_SERIALIZE      1
extern const apr_unix_lock_methods_t apr_unix_sysv_methods;
#else
#define APR_HAS_SYSVSEM_SERIALIZE      0
#endif

#if defined(HAVE_FCNTL_H) && defined(HAVE_F_SETLK)
#define APR_HAS_FCNTL_SERIALIZE        1
extern const apr_unix_lock_methods_t apr_unix_fcntl_methods;
#else
#define APR_HAS_FCNTL_SERIALIZE        0
#endif

#if defined(HAVE_FLOCK) && defined(HAVE_LOCK_EX)
#define APR_HAS_FLOCK_SERIALIZE        1
extern const apr_unix_lock_methods_t apr_unix_flock_methods;
#else
#define APR_HAS_FLOCK_SERIALIZE        0
#endif

#if defined(HAVE_PTHREAD_H) && defined(HAVE_PTHREAD_PROCESS_SHARED) && defined(HAVE_PTHREAD_MUTEXATTR_SETPSHARED)
#define APR_HAS_PROC_PTHREAD_SERIALIZE 1
extern const apr_unix_lock_methods_t apr_unix_proc_pthread_methods;
#else
#define APR_HAS_PROC_PTHREAD_SERIALIZE 0
#endif

#if defined(HAVE_PTHREAD_RWLOCK_INIT)
#define APR_HAS_RWLOCK_SERIALIZE       1
extern const apr_unix_lock_methods_t apr_unix_rwlock_methods;
#else
#define APR_HAS_RWLOCK_SERIALIZE       0
#endif

#if !APR_HAVE_UNION_SEMUN && defined(APR_HAS_SYSVSEM_SERIALIZE)
/* it makes no sense, but this isn't defined on solaris */
union semun {
    long val;
    struct semid_ds *buf;
    ushort *array;
};
#endif

struct apr_lock_t {
    apr_pool_t *pool;
    const apr_unix_lock_methods_t *meth;
    const apr_unix_lock_methods_t *inter_meth, *intra_meth; /* for APR_LOCK_ALL */
    apr_locktype_e type;
    apr_lockscope_e scope;
    int curr_locked;
    char *fname;
#if APR_HAS_SYSVSEM_SERIALIZE || APR_HAS_FCNTL_SERIALIZE || APR_HAS_FLOCK_SERIALIZE
    int interproc;
#endif
#if APR_HAS_PROC_PTHREAD_SERIALIZE
    pthread_mutex_t *pthread_interproc;
#endif
#if APR_HAS_THREADS
    /* APR doesn't have threads, no sense in having an thread lock mechanism.
     */

    apr_os_thread_t owner;
    int owner_ref;

#if APR_USE_PTHREAD_SERIALIZE
    pthread_mutex_t *intraproc;
#endif
#ifdef HAVE_PTHREAD_RWLOCK_INIT
    pthread_rwlock_t rwlock;
#endif
#endif
    /* At some point, we should do a scope for both inter and intra process
     * locking here.  Something like pthread_mutex with PTHREAD_PROCESS_SHARED
     */    
};

#if APR_HAS_THREADS
extern const apr_unix_lock_methods_t apr_unix_intra_methods;
#endif

void apr_unix_setup_lock(void);

#endif  /* LOCKS_H */