summaryrefslogtreecommitdiffstats
path: root/lib/libc/stdio/_flock_stub.c
blob: a77fad98224274be8473a3d31df88b59b695edc8 (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
197
/*
 * Copyright (c) 1998 John Birrell <jb@cimlogic.com.au>.
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by John Birrell.
 * 4. Neither the name of the author nor the names of any co-contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS 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 REGENTS OR 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.
 *
 * $FreeBSD$
 *
 */

/*
 * POSIX stdio FILE locking functions. These assume that the locking
 * is only required at FILE structure level, not at file descriptor
 * level too.
 *
 */

#include "namespace.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <pthread.h>
#include "un-namespace.h"

/*
 * Weak symbols for externally visible functions in this file:
 */
#pragma weak	flockfile=_flockfile
#pragma weak	_flockfile_debug=_flockfile_debug_stub
#pragma weak	ftrylockfile=_ftrylockfile
#pragma weak	funlockfile=_funlockfile

static int	init_lock(FILE *);

/*
 * The FILE lock structure. The FILE *fp is locked when the mutex
 * is locked.
 */
struct	__file_lock {
	pthread_mutex_t	fl_mutex;
	pthread_t	fl_owner;	/* current owner */
	int		fl_count;	/* recursive lock count */
};

/*
 * We need to retain binary compatibility for a while.  So pretend
 * that _lock is part of FILE * even though it is dereferenced off
 * _extra now.  When we stop encoding the size of FILE into binaries
 * this can be changed in stdio.h.  This will reduce the amount of
 * code that has to change in the future (just remove this comment
 * and #define).
 */
#define _lock _extra->_mtlock

/*
 * Allocate and initialize a file lock.
 */
static int
init_lock(FILE *fp)
{
	struct __file_lock *p;
	int	ret;

	if ((p = malloc(sizeof(struct __file_lock))) == NULL)
		ret = -1;
	else {
		p->fl_mutex = PTHREAD_MUTEX_INITIALIZER;
		p->fl_owner = NULL;
		p->fl_count = 0;
		fp->_lock = p;
		ret = 0;
	}
	return (ret);
}

void
_flockfile(FILE *fp)
{
	pthread_t curthread = _pthread_self();

	/*
	 * Check if this is a real file with a valid lock, creating
	 * the lock if needed:
	 */
	if ((fp->_file >= 0) &&
	    ((fp->_lock != NULL) || (init_lock(fp) == 0))) {
		if (fp->_lock->fl_owner == curthread)
			fp->_lock->fl_count++;
		else {
			/*
			 * Make sure this mutex is treated as a private
			 * internal mutex:
			 */
			_pthread_mutex_lock(&fp->_lock->fl_mutex);
			fp->_lock->fl_owner = curthread;
			fp->_lock->fl_count = 1;
		}
	}
}

/*
 * This can be overriden by the threads library if it is linked in.
 */
void
_flockfile_debug_stub(FILE *fp, char *fname, int lineno)
{
	_flockfile(fp);
}

int
_ftrylockfile(FILE *fp)
{
	pthread_t curthread = _pthread_self();
	int	ret = 0;

	/*
	 * Check if this is a real file with a valid lock, creating
	 * the lock if needed:
	 */
	if ((fp->_file >= 0) &&
	    ((fp->_lock != NULL) || (init_lock(fp) == 0))) {
		if (fp->_lock->fl_owner == curthread)
			fp->_lock->fl_count++;
		/*
		 * Make sure this mutex is treated as a private
		 * internal mutex:
		 */
		else if (_pthread_mutex_trylock(&fp->_lock->fl_mutex) == 0) {
			fp->_lock->fl_owner = curthread;
			fp->_lock->fl_count = 1;
		}
		else
			ret = -1;
	}
	else
		ret = -1;
	return (ret);
}

void 
_funlockfile(FILE *fp)
{
	pthread_t	curthread = _pthread_self();

	/*
	 * Check if this is a real file with a valid lock owned
	 * by the current thread:
	 */
	if ((fp->_file >= 0) && (fp->_lock != NULL) &&
	    (fp->_lock->fl_owner == curthread)) {
		/*
		 * Check if this thread has locked the FILE
		 * more than once:
		 */
		if (fp->_lock->fl_count > 1)
			/*
			 * Decrement the count of the number of
			 * times the running thread has locked this
			 * file:
			 */
			fp->_lock->fl_count--;
		else {
			/*
			 * The running thread will release the
			 * lock now:
			 */
			fp->_lock->fl_count = 0;
			fp->_lock->fl_owner = NULL;
			_pthread_mutex_unlock(&fp->_lock->fl_mutex);
		}
	}
}
OpenPOWER on IntegriCloud