2012-05-29 22:14:26 +04:00
|
|
|
/**
|
|
|
|
* WinPR: Windows Portable Runtime
|
|
|
|
* Synchronization Functions
|
|
|
|
*
|
|
|
|
* Copyright 2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
|
|
|
|
*
|
|
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
* you may not use this file except in compliance with the License.
|
|
|
|
* You may obtain a copy of the License at
|
|
|
|
*
|
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
*
|
|
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
* See the License for the specific language governing permissions and
|
|
|
|
* limitations under the License.
|
|
|
|
*/
|
|
|
|
|
2022-02-16 12:08:00 +03:00
|
|
|
#include <winpr/config.h>
|
2012-08-15 01:20:53 +04:00
|
|
|
|
2012-05-29 22:14:26 +04:00
|
|
|
#include <winpr/synch.h>
|
2015-04-28 09:55:26 +03:00
|
|
|
#include <winpr/debug.h>
|
|
|
|
#include <winpr/wlog.h>
|
2019-02-07 18:43:55 +03:00
|
|
|
#include <winpr/string.h>
|
2012-05-29 22:14:26 +04:00
|
|
|
|
2012-09-19 01:33:52 +04:00
|
|
|
#include "synch.h"
|
|
|
|
|
|
|
|
#ifndef _WIN32
|
|
|
|
|
2015-04-28 18:29:07 +03:00
|
|
|
#include <errno.h>
|
|
|
|
|
2013-05-17 01:32:58 +04:00
|
|
|
#include "../handle/handle.h"
|
2015-04-28 09:55:26 +03:00
|
|
|
|
|
|
|
#include "../log.h"
|
|
|
|
#define TAG WINPR_TAG("sync.mutex")
|
|
|
|
|
2015-03-11 17:11:14 +03:00
|
|
|
static BOOL MutexCloseHandle(HANDLE handle);
|
|
|
|
|
|
|
|
static BOOL MutexIsHandled(HANDLE handle)
|
|
|
|
{
|
2022-04-27 16:56:39 +03:00
|
|
|
return WINPR_HANDLE_IS_HANDLED(handle, HANDLE_TYPE_MUTEX, FALSE);
|
2015-03-11 17:11:14 +03:00
|
|
|
}
|
|
|
|
|
2015-03-11 19:57:01 +03:00
|
|
|
static int MutexGetFd(HANDLE handle)
|
2015-03-11 17:11:14 +03:00
|
|
|
{
|
2018-10-24 14:17:14 +03:00
|
|
|
WINPR_MUTEX* mux = (WINPR_MUTEX*)handle;
|
|
|
|
|
2015-03-11 19:57:01 +03:00
|
|
|
if (!MutexIsHandled(handle))
|
|
|
|
return -1;
|
|
|
|
|
|
|
|
/* TODO: Mutex does not support file handles... */
|
|
|
|
(void)mux;
|
|
|
|
return -1;
|
2015-03-11 17:11:14 +03:00
|
|
|
}
|
|
|
|
|
2015-03-17 23:54:45 +03:00
|
|
|
BOOL MutexCloseHandle(HANDLE handle)
|
|
|
|
{
|
2019-11-06 17:24:51 +03:00
|
|
|
WINPR_MUTEX* mutex = (WINPR_MUTEX*)handle;
|
2024-01-23 18:49:54 +03:00
|
|
|
int rc = 0;
|
2015-03-11 17:11:14 +03:00
|
|
|
|
|
|
|
if (!MutexIsHandled(handle))
|
|
|
|
return FALSE;
|
|
|
|
|
2016-05-24 14:35:11 +03:00
|
|
|
if ((rc = pthread_mutex_destroy(&mutex->mutex)))
|
2015-04-28 09:55:26 +03:00
|
|
|
{
|
2024-02-05 15:01:08 +03:00
|
|
|
char ebuffer[256] = { 0 };
|
|
|
|
WLog_ERR(TAG, "pthread_mutex_destroy failed with %s [%d]",
|
|
|
|
winpr_strerror(rc, ebuffer, sizeof(ebuffer)), rc);
|
2015-04-28 10:42:46 +03:00
|
|
|
#if defined(WITH_DEBUG_MUTEX)
|
2015-04-28 09:55:26 +03:00
|
|
|
{
|
2024-01-23 18:49:54 +03:00
|
|
|
size_t used = 0;
|
2015-04-28 18:29:07 +03:00
|
|
|
void* stack = winpr_backtrace(20);
|
2018-10-24 14:17:14 +03:00
|
|
|
char** msg = NULL;
|
2015-04-28 18:29:07 +03:00
|
|
|
|
|
|
|
if (stack)
|
|
|
|
msg = winpr_backtrace_symbols(stack, &used);
|
|
|
|
|
|
|
|
if (msg)
|
|
|
|
{
|
2024-01-30 12:25:38 +03:00
|
|
|
for (size_t i = 0; i < used; i++)
|
2019-11-06 17:24:51 +03:00
|
|
|
WLog_ERR(TAG, "%2" PRIdz ": %s", i, msg[i]);
|
2015-04-28 18:29:07 +03:00
|
|
|
}
|
2018-10-24 14:17:14 +03:00
|
|
|
|
|
|
|
free(msg);
|
2015-04-28 18:29:07 +03:00
|
|
|
winpr_backtrace_free(stack);
|
2015-04-28 09:55:26 +03:00
|
|
|
}
|
|
|
|
#endif
|
2016-05-24 14:35:11 +03:00
|
|
|
/**
|
|
|
|
* Note: unfortunately we may not return FALSE here since CloseHandle(hmutex) on
|
|
|
|
* Windows always seems to succeed independently of the mutex object locking state
|
|
|
|
*/
|
2015-04-28 18:29:07 +03:00
|
|
|
}
|
2015-03-11 17:11:14 +03:00
|
|
|
|
2019-02-07 18:43:55 +03:00
|
|
|
free(mutex->name);
|
2015-03-11 17:11:14 +03:00
|
|
|
free(handle);
|
|
|
|
return TRUE;
|
|
|
|
}
|
2013-05-17 01:32:58 +04:00
|
|
|
|
2022-04-13 10:34:05 +03:00
|
|
|
static HANDLE_OPS ops = { MutexIsHandled,
|
|
|
|
MutexCloseHandle,
|
|
|
|
MutexGetFd,
|
|
|
|
NULL, /* CleanupHandle */
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL,
|
|
|
|
NULL };
|
2015-03-16 02:29:37 +03:00
|
|
|
|
2012-09-19 01:33:52 +04:00
|
|
|
HANDLE CreateMutexW(LPSECURITY_ATTRIBUTES lpMutexAttributes, BOOL bInitialOwner, LPCWSTR lpName)
|
2019-02-07 18:43:55 +03:00
|
|
|
{
|
2024-01-23 18:49:54 +03:00
|
|
|
HANDLE handle = NULL;
|
2019-02-07 18:43:55 +03:00
|
|
|
char* name = NULL;
|
|
|
|
|
|
|
|
if (lpName)
|
|
|
|
{
|
2022-10-28 09:09:27 +03:00
|
|
|
name = ConvertWCharToUtf8Alloc(lpName, NULL);
|
|
|
|
if (!name)
|
2019-02-07 18:43:55 +03:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
handle = CreateMutexA(lpMutexAttributes, bInitialOwner, name);
|
|
|
|
free(name);
|
|
|
|
return handle;
|
|
|
|
}
|
|
|
|
|
|
|
|
HANDLE CreateMutexA(LPSECURITY_ATTRIBUTES lpMutexAttributes, BOOL bInitialOwner, LPCSTR lpName)
|
2012-09-18 20:57:19 +04:00
|
|
|
{
|
2013-04-03 21:35:45 +04:00
|
|
|
HANDLE handle = NULL;
|
2024-01-23 18:49:54 +03:00
|
|
|
WINPR_MUTEX* mutex = NULL;
|
2019-11-06 17:24:51 +03:00
|
|
|
mutex = (WINPR_MUTEX*)calloc(1, sizeof(WINPR_MUTEX));
|
2012-09-19 01:33:52 +04:00
|
|
|
|
2019-02-07 18:43:55 +03:00
|
|
|
if (lpMutexAttributes)
|
2023-01-23 14:03:18 +03:00
|
|
|
WLog_WARN(TAG, "[%s] does not support lpMutexAttributes", lpName);
|
2019-02-07 18:43:55 +03:00
|
|
|
|
2013-05-17 01:32:58 +04:00
|
|
|
if (mutex)
|
2013-04-03 21:35:45 +04:00
|
|
|
{
|
2016-05-24 14:35:11 +03:00
|
|
|
pthread_mutexattr_t attr;
|
|
|
|
pthread_mutexattr_init(&attr);
|
|
|
|
pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE);
|
|
|
|
pthread_mutex_init(&mutex->mutex, &attr);
|
2015-07-14 12:39:41 +03:00
|
|
|
WINPR_HANDLE_SET_TYPE_AND_MODE(mutex, HANDLE_TYPE_MUTEX, WINPR_FD_READ);
|
2022-04-27 16:56:39 +03:00
|
|
|
mutex->common.ops = &ops;
|
2019-11-06 17:24:51 +03:00
|
|
|
handle = (HANDLE)mutex;
|
2013-05-17 01:32:58 +04:00
|
|
|
|
2013-04-03 21:35:45 +04:00
|
|
|
if (bInitialOwner)
|
2013-05-17 01:32:58 +04:00
|
|
|
pthread_mutex_lock(&mutex->mutex);
|
2019-02-07 18:43:55 +03:00
|
|
|
|
2019-02-08 11:05:36 +03:00
|
|
|
if (lpName)
|
|
|
|
mutex->name = strdup(lpName); /* Non runtime relevant information, skip NULL check */
|
2013-04-03 21:35:45 +04:00
|
|
|
}
|
2012-09-19 01:33:52 +04:00
|
|
|
|
|
|
|
return handle;
|
2012-09-18 20:57:19 +04:00
|
|
|
}
|
|
|
|
|
2019-02-07 18:43:55 +03:00
|
|
|
HANDLE CreateMutexExA(LPSECURITY_ATTRIBUTES lpMutexAttributes, LPCSTR lpName, DWORD dwFlags,
|
2018-10-24 14:17:14 +03:00
|
|
|
DWORD dwDesiredAccess)
|
2012-09-18 20:57:19 +04:00
|
|
|
{
|
2019-02-07 18:43:55 +03:00
|
|
|
BOOL initial = FALSE;
|
|
|
|
/* TODO: support access modes */
|
|
|
|
|
|
|
|
if (dwDesiredAccess != 0)
|
2023-01-23 14:03:18 +03:00
|
|
|
WLog_WARN(TAG, "[%s] does not support dwDesiredAccess 0x%08" PRIx32, lpName,
|
|
|
|
dwDesiredAccess);
|
2019-02-07 18:43:55 +03:00
|
|
|
|
|
|
|
if (dwFlags & CREATE_MUTEX_INITIAL_OWNER)
|
|
|
|
initial = TRUE;
|
|
|
|
|
|
|
|
return CreateMutexA(lpMutexAttributes, initial, lpName);
|
2012-09-18 20:57:19 +04:00
|
|
|
}
|
|
|
|
|
2018-10-24 14:17:14 +03:00
|
|
|
HANDLE CreateMutexExW(LPSECURITY_ATTRIBUTES lpMutexAttributes, LPCWSTR lpName, DWORD dwFlags,
|
|
|
|
DWORD dwDesiredAccess)
|
2012-09-18 20:57:19 +04:00
|
|
|
{
|
2019-02-07 18:43:55 +03:00
|
|
|
BOOL initial = FALSE;
|
|
|
|
|
|
|
|
/* TODO: support access modes */
|
|
|
|
if (dwDesiredAccess != 0)
|
2023-01-23 14:03:18 +03:00
|
|
|
WLog_WARN(TAG, "[%s] does not support dwDesiredAccess 0x%08" PRIx32, lpName,
|
|
|
|
dwDesiredAccess);
|
2019-02-07 18:43:55 +03:00
|
|
|
|
|
|
|
if (dwFlags & CREATE_MUTEX_INITIAL_OWNER)
|
|
|
|
initial = TRUE;
|
|
|
|
|
|
|
|
return CreateMutexW(lpMutexAttributes, initial, lpName);
|
2012-09-18 20:57:19 +04:00
|
|
|
}
|
|
|
|
|
2018-10-24 14:17:14 +03:00
|
|
|
HANDLE OpenMutexA(DWORD dwDesiredAccess, BOOL bInheritHandle, LPCSTR lpName)
|
2012-09-18 20:57:19 +04:00
|
|
|
{
|
2019-02-07 18:43:55 +03:00
|
|
|
/* TODO: Implement */
|
|
|
|
WINPR_UNUSED(dwDesiredAccess);
|
|
|
|
WINPR_UNUSED(bInheritHandle);
|
|
|
|
WINPR_UNUSED(lpName);
|
2023-01-23 14:03:18 +03:00
|
|
|
WLog_ERR(TAG, "TODO: Implement");
|
2012-09-18 20:57:19 +04:00
|
|
|
return NULL;
|
|
|
|
}
|
2012-05-29 22:14:26 +04:00
|
|
|
|
2018-10-24 14:17:14 +03:00
|
|
|
HANDLE OpenMutexW(DWORD dwDesiredAccess, BOOL bInheritHandle, LPCWSTR lpName)
|
2012-09-18 20:57:19 +04:00
|
|
|
{
|
2019-02-07 18:43:55 +03:00
|
|
|
/* TODO: Implement */
|
|
|
|
WINPR_UNUSED(dwDesiredAccess);
|
|
|
|
WINPR_UNUSED(bInheritHandle);
|
|
|
|
WINPR_UNUSED(lpName);
|
2023-01-23 14:03:18 +03:00
|
|
|
WLog_ERR(TAG, "TODO: Implement");
|
2012-09-18 20:57:19 +04:00
|
|
|
return NULL;
|
|
|
|
}
|
2012-05-29 22:14:26 +04:00
|
|
|
|
2012-09-18 20:57:19 +04:00
|
|
|
BOOL ReleaseMutex(HANDLE hMutex)
|
|
|
|
{
|
2024-01-23 18:49:54 +03:00
|
|
|
ULONG Type = 0;
|
|
|
|
WINPR_HANDLE* Object = NULL;
|
2012-09-19 01:33:52 +04:00
|
|
|
|
|
|
|
if (!winpr_Handle_GetInfo(hMutex, &Type, &Object))
|
|
|
|
return FALSE;
|
|
|
|
|
|
|
|
if (Type == HANDLE_TYPE_MUTEX)
|
|
|
|
{
|
2019-11-06 17:24:51 +03:00
|
|
|
WINPR_MUTEX* mutex = (WINPR_MUTEX*)Object;
|
2016-05-24 14:35:11 +03:00
|
|
|
int rc = pthread_mutex_unlock(&mutex->mutex);
|
2018-10-24 14:17:14 +03:00
|
|
|
|
2016-05-24 14:35:11 +03:00
|
|
|
if (rc)
|
|
|
|
{
|
2024-02-05 15:01:08 +03:00
|
|
|
char ebuffer[256] = { 0 };
|
|
|
|
WLog_ERR(TAG, "pthread_mutex_unlock failed with %s [%d]",
|
|
|
|
winpr_strerror(rc, ebuffer, sizeof(ebuffer)), rc);
|
2016-05-24 14:35:11 +03:00
|
|
|
return FALSE;
|
|
|
|
}
|
2018-10-24 14:17:14 +03:00
|
|
|
|
2012-09-19 01:33:52 +04:00
|
|
|
return TRUE;
|
|
|
|
}
|
|
|
|
|
|
|
|
return FALSE;
|
2012-09-18 20:57:19 +04:00
|
|
|
}
|
2012-09-19 01:33:52 +04:00
|
|
|
|
|
|
|
#endif
|