xref: /aoo41x/main/sal/osl/unx/semaphor.c (revision cdf0e10c)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir 
29*cdf0e10cSrcweir #include "system.h"
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include <osl/semaphor.h>
32*cdf0e10cSrcweir #include <osl/diagnose.h>
33*cdf0e10cSrcweir 
34*cdf0e10cSrcweir #ifndef OSL_USE_SYS_V_SEMAPHORE
35*cdf0e10cSrcweir 
36*cdf0e10cSrcweir /* This is the (default) POSIX thread-local semaphore variant */
37*cdf0e10cSrcweir 
38*cdf0e10cSrcweir /*
39*cdf0e10cSrcweir 	Implemetation notes:
40*cdf0e10cSrcweir 	The void* represented by oslSemaphore is used
41*cdf0e10cSrcweir 	as a pointer to an sem_t struct
42*cdf0e10cSrcweir */
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir /*****************************************************************************/
45*cdf0e10cSrcweir /* osl_createSemaphore  */
46*cdf0e10cSrcweir /*****************************************************************************/
47*cdf0e10cSrcweir 
48*cdf0e10cSrcweir oslSemaphore SAL_CALL osl_createSemaphore(sal_uInt32 initialCount)
49*cdf0e10cSrcweir {
50*cdf0e10cSrcweir 	int ret = 0;
51*cdf0e10cSrcweir 	oslSemaphore Semaphore;
52*cdf0e10cSrcweir 
53*cdf0e10cSrcweir 	Semaphore= malloc(sizeof(sem_t));
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir 	OSL_ASSERT(Semaphore);		/* ptr valid? */
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir 	if ( Semaphore == 0 )
58*cdf0e10cSrcweir 	{
59*cdf0e10cSrcweir 		return 0;
60*cdf0e10cSrcweir 	}
61*cdf0e10cSrcweir 
62*cdf0e10cSrcweir 	/* unnamed semaphore, not shared between processes */
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir    	ret= sem_init((sem_t*)Semaphore, 0, initialCount);
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir 	/* create failed? */
67*cdf0e10cSrcweir 	if (ret != 0)
68*cdf0e10cSrcweir 	{
69*cdf0e10cSrcweir 	    OSL_TRACE("osl_createSemaphore failed. Errno: %d; %s\n",
70*cdf0e10cSrcweir 				  errno,
71*cdf0e10cSrcweir 				  strerror(errno));
72*cdf0e10cSrcweir 
73*cdf0e10cSrcweir 	    free(Semaphore);
74*cdf0e10cSrcweir 	    Semaphore = NULL;
75*cdf0e10cSrcweir 	}
76*cdf0e10cSrcweir 
77*cdf0e10cSrcweir 	return Semaphore;
78*cdf0e10cSrcweir }
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir /*****************************************************************************/
81*cdf0e10cSrcweir /* osl_destroySemaphore  */
82*cdf0e10cSrcweir /*****************************************************************************/
83*cdf0e10cSrcweir void SAL_CALL osl_destroySemaphore(oslSemaphore Semaphore)
84*cdf0e10cSrcweir {
85*cdf0e10cSrcweir 	if(Semaphore)			/* ptr valid? */
86*cdf0e10cSrcweir 	{
87*cdf0e10cSrcweir 		sem_destroy((sem_t*)Semaphore);
88*cdf0e10cSrcweir 	    free(Semaphore);
89*cdf0e10cSrcweir 	}
90*cdf0e10cSrcweir }
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir /*****************************************************************************/
93*cdf0e10cSrcweir /* osl_acquireSemaphore  */
94*cdf0e10cSrcweir /*****************************************************************************/
95*cdf0e10cSrcweir sal_Bool SAL_CALL osl_acquireSemaphore(oslSemaphore Semaphore) {
96*cdf0e10cSrcweir 
97*cdf0e10cSrcweir 	OSL_ASSERT(Semaphore != 0);	/* abort in debug mode */
98*cdf0e10cSrcweir 
99*cdf0e10cSrcweir 	if (Semaphore != 0)		/* be tolerant in release mode */
100*cdf0e10cSrcweir 	{
101*cdf0e10cSrcweir 	    return (sem_wait((sem_t*)Semaphore) == 0);
102*cdf0e10cSrcweir 	}
103*cdf0e10cSrcweir 
104*cdf0e10cSrcweir 	return sal_False;
105*cdf0e10cSrcweir }
106*cdf0e10cSrcweir 
107*cdf0e10cSrcweir /*****************************************************************************/
108*cdf0e10cSrcweir /* osl_tryToAcquireSemaphore  */
109*cdf0e10cSrcweir /*****************************************************************************/
110*cdf0e10cSrcweir sal_Bool SAL_CALL osl_tryToAcquireSemaphore(oslSemaphore Semaphore) {
111*cdf0e10cSrcweir 
112*cdf0e10cSrcweir 	OSL_ASSERT(Semaphore != 0);	/* abort in debug mode */
113*cdf0e10cSrcweir 	if (Semaphore != 0)		/* be tolerant in release mode */
114*cdf0e10cSrcweir 	{
115*cdf0e10cSrcweir 	    return (sem_trywait((sem_t*)Semaphore) == 0);
116*cdf0e10cSrcweir 	}
117*cdf0e10cSrcweir 
118*cdf0e10cSrcweir 	return sal_False;
119*cdf0e10cSrcweir }
120*cdf0e10cSrcweir 
121*cdf0e10cSrcweir /*****************************************************************************/
122*cdf0e10cSrcweir /* osl_releaseSemaphore  */
123*cdf0e10cSrcweir /*****************************************************************************/
124*cdf0e10cSrcweir sal_Bool SAL_CALL osl_releaseSemaphore(oslSemaphore Semaphore) {
125*cdf0e10cSrcweir 
126*cdf0e10cSrcweir 	OSL_ASSERT(Semaphore != 0);		/* abort in debug mode */
127*cdf0e10cSrcweir 
128*cdf0e10cSrcweir 	if (Semaphore != 0)			/* be tolerant in release mode */
129*cdf0e10cSrcweir 	{
130*cdf0e10cSrcweir 	    return (sem_post((sem_t*)Semaphore) == 0);
131*cdf0e10cSrcweir 	}
132*cdf0e10cSrcweir 
133*cdf0e10cSrcweir 	return sal_False;
134*cdf0e10cSrcweir }
135*cdf0e10cSrcweir 
136*cdf0e10cSrcweir #else /* OSL_USE_SYS_V_SEMAPHORE */
137*cdf0e10cSrcweir 
138*cdf0e10cSrcweir /*******************************************************************************/
139*cdf0e10cSrcweir 
140*cdf0e10cSrcweir /* This is the SYS V private semaphore variant */
141*cdf0e10cSrcweir 
142*cdf0e10cSrcweir /*
143*cdf0e10cSrcweir 	Implemetation notes:
144*cdf0e10cSrcweir 	The void* represented by oslSemaphore is used
145*cdf0e10cSrcweir 	as a pointer to an osl_TSemImpl struct
146*cdf0e10cSrcweir */
147*cdf0e10cSrcweir 
148*cdf0e10cSrcweir 
149*cdf0e10cSrcweir #if defined(NETBSD)
150*cdf0e10cSrcweir union semun {
151*cdf0e10cSrcweir         int     val;            /* value for SETVAL */
152*cdf0e10cSrcweir         struct  semid_ds *buf;  /* buffer for IPC_STAT & IPC_SET */
153*cdf0e10cSrcweir         u_short *array;         /* array for GETALL & SETALL */
154*cdf0e10cSrcweir };
155*cdf0e10cSrcweir #endif
156*cdf0e10cSrcweir 
157*cdf0e10cSrcweir typedef struct _osl_TSemImpl
158*cdf0e10cSrcweir {
159*cdf0e10cSrcweir   int m_Id;
160*cdf0e10cSrcweir 
161*cdf0e10cSrcweir } osl_TSemImpl;
162*cdf0e10cSrcweir 
163*cdf0e10cSrcweir /*****************************************************************************/
164*cdf0e10cSrcweir /* osl_createSemaphore  */
165*cdf0e10cSrcweir /*****************************************************************************/
166*cdf0e10cSrcweir oslSemaphore SAL_CALL osl_createSemaphore(sal_uInt32 initialCount)
167*cdf0e10cSrcweir {
168*cdf0e10cSrcweir 	union semun arg;
169*cdf0e10cSrcweir 
170*cdf0e10cSrcweir 	oslSemaphore Semaphore;
171*cdf0e10cSrcweir 	osl_TSemImpl* pSem;
172*cdf0e10cSrcweir 
173*cdf0e10cSrcweir 	Semaphore= malloc(sizeof(osl_TSemImpl));
174*cdf0e10cSrcweir 	OSL_POSTCOND(Semaphore, "malloc failed\n");		/* ptr valid? */
175*cdf0e10cSrcweir 
176*cdf0e10cSrcweir 	pSem= (osl_TSemImpl*)Semaphore;
177*cdf0e10cSrcweir 
178*cdf0e10cSrcweir 
179*cdf0e10cSrcweir 	/* unnamed (private) semaphore */
180*cdf0e10cSrcweir 
181*cdf0e10cSrcweir    	pSem->m_Id= semget(IPC_PRIVATE, 1, 0666 | IPC_CREAT);
182*cdf0e10cSrcweir 
183*cdf0e10cSrcweir 
184*cdf0e10cSrcweir 	/* create failed? */
185*cdf0e10cSrcweir 	if (pSem->m_Id < 0)
186*cdf0e10cSrcweir 	{
187*cdf0e10cSrcweir 	    OSL_TRACE("osl_createSemaphore failed (semget). Errno: %d; %s\n",
188*cdf0e10cSrcweir 			   errno,
189*cdf0e10cSrcweir 			   strerror(errno));
190*cdf0e10cSrcweir 
191*cdf0e10cSrcweir 	    free(Semaphore);
192*cdf0e10cSrcweir 	    return 0;
193*cdf0e10cSrcweir 	}
194*cdf0e10cSrcweir 
195*cdf0e10cSrcweir     /* set initial count */
196*cdf0e10cSrcweir 
197*cdf0e10cSrcweir     arg.val= initialCount;
198*cdf0e10cSrcweir 
199*cdf0e10cSrcweir 	if(semctl(pSem->m_Id, 0, SETVAL, arg) < 0)
200*cdf0e10cSrcweir 	{
201*cdf0e10cSrcweir 	    OSL_TRACE("osl_createSemaphore failed (semctl(SETVAL)). Errno: %d; %s\n",
202*cdf0e10cSrcweir 			   errno,
203*cdf0e10cSrcweir 			   strerror(errno));
204*cdf0e10cSrcweir 
205*cdf0e10cSrcweir 		if(semctl(pSem->m_Id, 0, IPC_RMID, arg) < 0)
206*cdf0e10cSrcweir 		{
207*cdf0e10cSrcweir 		    OSL_TRACE("semctl(IPC_RMID) failed. Errno: %d; %s\n", errno, strerror(errno));
208*cdf0e10cSrcweir 	    }
209*cdf0e10cSrcweir 
210*cdf0e10cSrcweir 		free(Semaphore);
211*cdf0e10cSrcweir 		return 0;
212*cdf0e10cSrcweir 	}
213*cdf0e10cSrcweir 
214*cdf0e10cSrcweir 
215*cdf0e10cSrcweir 	return Semaphore;
216*cdf0e10cSrcweir }
217*cdf0e10cSrcweir 
218*cdf0e10cSrcweir /*****************************************************************************/
219*cdf0e10cSrcweir /* osl_destroySemaphore  */
220*cdf0e10cSrcweir /*****************************************************************************/
221*cdf0e10cSrcweir void SAL_CALL osl_destroySemaphore(oslSemaphore Semaphore) {
222*cdf0e10cSrcweir 
223*cdf0e10cSrcweir 	if(Semaphore)			/* ptr valid? */
224*cdf0e10cSrcweir 	{
225*cdf0e10cSrcweir 		union semun arg;
226*cdf0e10cSrcweir 
227*cdf0e10cSrcweir 	    osl_TSemImpl* pSem= (osl_TSemImpl*)Semaphore;
228*cdf0e10cSrcweir 
229*cdf0e10cSrcweir 		if(semctl(pSem->m_Id, 0, IPC_RMID, arg) < 0)
230*cdf0e10cSrcweir 
231*cdf0e10cSrcweir 		{
232*cdf0e10cSrcweir 		    OSL_TRACE("osl_destroySemaphore failed. (semctl(IPC_RMID)). Errno: %d; %s\n",
233*cdf0e10cSrcweir 				   errno,
234*cdf0e10cSrcweir 				   strerror(errno));
235*cdf0e10cSrcweir 	    }
236*cdf0e10cSrcweir 
237*cdf0e10cSrcweir 	    free(Semaphore);
238*cdf0e10cSrcweir 	}
239*cdf0e10cSrcweir }
240*cdf0e10cSrcweir 
241*cdf0e10cSrcweir /*****************************************************************************/
242*cdf0e10cSrcweir /* osl_acquireSemaphore  */
243*cdf0e10cSrcweir /*****************************************************************************/
244*cdf0e10cSrcweir sal_Bool SAL_CALL osl_acquireSemaphore(oslSemaphore Semaphore) {
245*cdf0e10cSrcweir 
246*cdf0e10cSrcweir 	/* abort in debug mode */
247*cdf0e10cSrcweir 	OSL_PRECOND(Semaphore != 0, "Semaphore not created\n");
248*cdf0e10cSrcweir 
249*cdf0e10cSrcweir 
250*cdf0e10cSrcweir 	if (Semaphore != 0)		/* be tolerant in release mode */
251*cdf0e10cSrcweir 	{
252*cdf0e10cSrcweir 	    struct sembuf op;
253*cdf0e10cSrcweir 		osl_TSemImpl* pSem= (osl_TSemImpl*)Semaphore;
254*cdf0e10cSrcweir 
255*cdf0e10cSrcweir 		op.sem_num= 0;
256*cdf0e10cSrcweir 		op.sem_op= -1;
257*cdf0e10cSrcweir 		op.sem_flg= SEM_UNDO;
258*cdf0e10cSrcweir 
259*cdf0e10cSrcweir 		return semop(pSem->m_Id, &op, 1) >= 0;
260*cdf0e10cSrcweir 
261*cdf0e10cSrcweir 	}
262*cdf0e10cSrcweir 
263*cdf0e10cSrcweir 	return sal_False;
264*cdf0e10cSrcweir }
265*cdf0e10cSrcweir 
266*cdf0e10cSrcweir /*****************************************************************************/
267*cdf0e10cSrcweir /* osl_tryToAcquireSemaphore  */
268*cdf0e10cSrcweir /*****************************************************************************/
269*cdf0e10cSrcweir sal_Bool SAL_CALL osl_tryToAcquireSemaphore(oslSemaphore Semaphore) {
270*cdf0e10cSrcweir 
271*cdf0e10cSrcweir 	/* abort in debug mode */
272*cdf0e10cSrcweir 	OSL_PRECOND(Semaphore != 0, "Semaphore not created\n");
273*cdf0e10cSrcweir 
274*cdf0e10cSrcweir 	if (Semaphore != 0)		/* be tolerant in release mode */
275*cdf0e10cSrcweir 	{
276*cdf0e10cSrcweir 	    struct sembuf op;
277*cdf0e10cSrcweir 		osl_TSemImpl* pSem= (osl_TSemImpl*)Semaphore;
278*cdf0e10cSrcweir 
279*cdf0e10cSrcweir 		op.sem_num= 0;
280*cdf0e10cSrcweir 		op.sem_op= -1;
281*cdf0e10cSrcweir 		op.sem_flg= SEM_UNDO | IPC_NOWAIT;
282*cdf0e10cSrcweir 
283*cdf0e10cSrcweir 		return semop(pSem->m_Id, &op, 1) >= 0;
284*cdf0e10cSrcweir 	}
285*cdf0e10cSrcweir 
286*cdf0e10cSrcweir 	return sal_False;
287*cdf0e10cSrcweir }
288*cdf0e10cSrcweir 
289*cdf0e10cSrcweir /*****************************************************************************/
290*cdf0e10cSrcweir /* osl_releaseSemaphore  */
291*cdf0e10cSrcweir /*****************************************************************************/
292*cdf0e10cSrcweir sal_Bool SAL_CALL osl_releaseSemaphore(oslSemaphore Semaphore)
293*cdf0e10cSrcweir {
294*cdf0e10cSrcweir 
295*cdf0e10cSrcweir 	/* abort in debug mode */
296*cdf0e10cSrcweir 	OSL_PRECOND(Semaphore != 0, "Semaphore not created\n");
297*cdf0e10cSrcweir 
298*cdf0e10cSrcweir 	if (Semaphore != 0)			/* be tolerant in release mode */
299*cdf0e10cSrcweir 	{
300*cdf0e10cSrcweir 	    struct sembuf op;
301*cdf0e10cSrcweir 		osl_TSemImpl* pSem= (osl_TSemImpl*)Semaphore;
302*cdf0e10cSrcweir 
303*cdf0e10cSrcweir 		op.sem_num= 0;
304*cdf0e10cSrcweir 		op.sem_op= 1;
305*cdf0e10cSrcweir 		op.sem_flg= SEM_UNDO;
306*cdf0e10cSrcweir 
307*cdf0e10cSrcweir 		return semop(pSem->m_Id, &op, 1) >= 0;
308*cdf0e10cSrcweir 	}
309*cdf0e10cSrcweir 
310*cdf0e10cSrcweir 	return sal_False;
311*cdf0e10cSrcweir }
312*cdf0e10cSrcweir 
313*cdf0e10cSrcweir #endif /* OSL_USE_SYS_V_SEMAPHORE */
314*cdf0e10cSrcweir 
315