1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef _OSL_MUTEX_H_ 25*b1cdbd2cSJim Jagielski #define _OSL_MUTEX_H_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <sal/types.h> 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski #ifdef __cplusplus 30*b1cdbd2cSJim Jagielski extern "C" { 31*b1cdbd2cSJim Jagielski #endif 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski struct _oslMutexImpl; 34*b1cdbd2cSJim Jagielski typedef struct _oslMutexImpl * oslMutex; 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski /** Create a thread-local mutex. 37*b1cdbd2cSJim Jagielski @return 0 if the mutex could not be created, otherwise a handle to the mutex. 38*b1cdbd2cSJim Jagielski */ 39*b1cdbd2cSJim Jagielski oslMutex SAL_CALL osl_createMutex(void); 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski /** Release the OS-structures and free mutex data-structure. 42*b1cdbd2cSJim Jagielski @param Mutex the mutex-handle 43*b1cdbd2cSJim Jagielski */ 44*b1cdbd2cSJim Jagielski void SAL_CALL osl_destroyMutex(oslMutex Mutex); 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielski /** Acquire the mutex, block if already acquired by another thread. 47*b1cdbd2cSJim Jagielski @param Mutex handle to a created mutex. 48*b1cdbd2cSJim Jagielski @return False if system-call fails. 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL osl_acquireMutex(oslMutex Mutex); 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski /** Try to acquire the mutex without blocking. 53*b1cdbd2cSJim Jagielski @param Mutex handle to a created mutex. 54*b1cdbd2cSJim Jagielski @return False if it could not be acquired. 55*b1cdbd2cSJim Jagielski */ 56*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL osl_tryToAcquireMutex(oslMutex Mutex); 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski /** Release the mutex. 59*b1cdbd2cSJim Jagielski @param Mutex handle to a created mutex. 60*b1cdbd2cSJim Jagielski @return False if system-call fails. 61*b1cdbd2cSJim Jagielski */ 62*b1cdbd2cSJim Jagielski sal_Bool SAL_CALL osl_releaseMutex(oslMutex Mutex); 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski /** Returns a unique and global mutex. 65*b1cdbd2cSJim Jagielski @return the global mutex. 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielski oslMutex * SAL_CALL osl_getGlobalMutex(void); 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski #ifdef __cplusplus 70*b1cdbd2cSJim Jagielski } 71*b1cdbd2cSJim Jagielski #endif 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski #endif /* _OSL_MUTEX_H_ */ 74