semmutex-r0drv-freebsd.c revision 5ea40b04201696e445c4eeb0d1a238543aeb9167
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/* $Id$ */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/** @file
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync * IPRT - Mutex Semaphores, Ring-0 Driver, FreeBSD.
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync */
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/*
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync * Copyright (C) 2010 Sun Microsystems, Inc.
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync *
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * available from http://www.virtualbox.org. This file is free software;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * you can redistribute it and/or modify it under the terms of the GNU
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * General Public License (GPL) as published by the Free Software
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync *
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * The contents of this file may alternatively be used under the terms
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * of the Common Development and Distribution License Version 1.0
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * VirtualBox OSE distribution, in which case the provisions of the
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * CDDL are applicable instead of those of the GPL.
d4a9d525e6f2111d462d2d96462dced6b9ec00efvboxsync *
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * You may elect to license modified versions of this file under the
7b9f0c34e9ea328981c99e97054bdf8684d9d620vboxsync * terms and conditions of either the GPL or the CDDL or both.
9e7e0b61d29309a0ed7af9472c8d6d865f9e8a2dvboxsync *
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync * additional information or have any questions.
0fd108a555ae02f2fb557d5f2c40281999b60d15vboxsync */
c55bf74b54ecdfb5ebc4e5d90b620d0fee31737evboxsync
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync/*******************************************************************************
b1cc3e87518139898395f96974ecff9e6bf228fbvboxsync* Header Files *
b1cc3e87518139898395f96974ecff9e6bf228fbvboxsync*******************************************************************************/
c55bf74b54ecdfb5ebc4e5d90b620d0fee31737evboxsync#include "the-freebsd-kernel.h"
7862f4bd000f1eb6c86289f5ac2849e9cf943ca9vboxsync#include "internal/iprt.h"
388b6b190a5407548753b7fde12fa58134ec3563vboxsync#include <iprt/semaphore.h>
7862f4bd000f1eb6c86289f5ac2849e9cf943ca9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <iprt/asm.h>
c55bf74b54ecdfb5ebc4e5d90b620d0fee31737evboxsync#include <iprt/assert.h>
f9ce005e61f0fbb51a2cabc53d58c3485151faa9vboxsync#include <iprt/err.h>
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync#include <iprt/mem.h>
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync#include <iprt/thread.h>
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync#include <iprt/time.h>
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync#include "internal/magics.h"
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync/*******************************************************************************
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync* Structures and Typedefs *
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync*******************************************************************************/
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync/**
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync * Wrapper for the FreeBSD (sleep) mutex.
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync */
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsynctypedef struct RTSEMMUTEXINTERNAL
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync{
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync /** Magic value (RTSEMMUTEX_MAGIC). */
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync uint32_t u32Magic;
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync /** The FreeBSD shared/exclusive lock mutex. */
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync struct sx SxLock;
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync} RTSEMMUTEXINTERNAL, *PRTSEMMUTEXINTERNAL;
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsyncRTDECL(int) RTSemMutexCreate(PRTSEMMUTEX phMutexSem)
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync{
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync AssertCompile(sizeof(RTSEMMUTEXINTERNAL) > sizeof(void *));
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync AssertPtrReturn(phMutexSem, VERR_INVALID_POINTER);
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync PRTSEMMUTEXINTERNAL pThis = (PRTSEMMUTEXINTERNAL)RTMemAllocZ(sizeof(*pThis));
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync if (pThis)
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync {
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync pThis->u32Magic = RTSEMMUTEX_MAGIC;
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync sx_init_flags(&pThis->SxLock, "IPRT Mutex Semaphore", SX_LOCK_RECURSED);
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync *phMutexSem = pThis;
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync return VINF_SUCCESS;
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync }
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync return VERR_NO_MEMORY;
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync}
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsyncRTDECL(int) RTSemMutexDestroy(RTSEMMUTEX hMutexSem)
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync{
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync PRTSEMMUTEXINTERNAL pThis = hMutexSem;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync if (pThis == NIL_RTSEMMUTEX)
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync return VINF_SUCCESS;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMMUTEX_MAGIC, ("%p: u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync AssertReturn(ASMAtomicCmpXchgU32(&pThis->u32Magic, RTSEMMUTEX_MAGIC_DEAD, RTSEMMUTEX_MAGIC), VERR_INVALID_HANDLE);
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync sx_destroy(&pThis->SxLock);
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync RTMemFree(pThis);
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync return VINF_SUCCESS;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync}
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync
e38a1f5933935fe8db152ea06dac5aa1be27d870vboxsyncRTDECL(int) RTSemMutexRequest(RTSEMMUTEX hMutexSem, RTMSINTERVAL cMillies)
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync{
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync PRTSEMMUTEXINTERNAL pThis = hMutexSem;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync int rc;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMMUTEX_MAGIC, ("%p: u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync
e38a1f5933935fe8db152ea06dac5aa1be27d870vboxsync if (cMillies == RT_INDEFINITE_WAIT)
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync {
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync sx_xlock(&pThis->SxLock);
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync rc = VINF_SUCCESS;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync }
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync else if (!cMillies)
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync {
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync if (sx_try_xlock(&pThis->SxLock))
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync rc = VINF_SUCCESS;
e38a1f5933935fe8db152ea06dac5aa1be27d870vboxsync else
4171ffb38eb8720b2ae9a8d13e95103ab26cfd12vboxsync rc = VERR_TIMEOUT;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync }
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync /*
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync * GROSS HACK: poll implementation of timeout.
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync */
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync /** @todo Implement timeouts in RTSemMutexRequest. */
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync else if (sx_try_xlock(&pThis->SxLock))
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync rc = VINF_SUCCESS;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync else
e86baafe99d1f1eb37adcca5fdecfd06e7f13bc5vboxsync {
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync uint64_t StartTS = RTTimeSystemMilliTS();
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync rc = VERR_TIMEOUT;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync do
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync {
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync RTThreadSleep(1);
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync if (sx_try_xlock(&pThis->SxLock))
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync {
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync rc = VINF_SUCCESS;
e38a1f5933935fe8db152ea06dac5aa1be27d870vboxsync break;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync }
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync } while (RTTimeSystemMilliTS() - StartTS < cMillies);
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync }
581f0625e43a928987623d7cf59e1b1ab61ca6c8vboxsync
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync return VINF_SUCCESS;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync}
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsyncRTDECL(int) RTSemMutexRequestNoResume(RTSEMMUTEX hMutexSem, RTMSINTERVAL cMillies)
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync{
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync PRTSEMMUTEXINTERNAL pThis = hMutexSem;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync int rc;
3f5dd727ecbcf3e99217c70f04bc2340beb9072cvboxsync AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMMUTEX_MAGIC, ("%p: u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync if (cMillies == RT_INDEFINITE_WAIT)
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync {
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync if (!sx_xlock_sig(&pThis->SxLock))
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync rc = VINF_SUCCESS;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync else
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync rc = VERR_INTERRUPTED;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync }
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync else if (!cMillies)
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync {
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync if (sx_try_xlock(&pThis->SxLock))
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync rc = VINF_SUCCESS;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync else
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync rc = VERR_TIMEOUT;
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync }
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync /*
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync * GROSS HACK: poll implementation of timeout.
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync */
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync /** @todo Implement timeouts and interrupt checks in
462e60a19d02a99b2b1a5c08dff74bb0808d707cvboxsync * RTSemMutexRequestNoResume. */
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync else if (sx_try_xlock(&pThis->SxLock))
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync rc = VINF_SUCCESS;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync else
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync {
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync uint64_t StartTS = RTTimeSystemMilliTS();
702a8ee2dc1de96f2f77e97135015d3e243186fdvboxsync rc = VERR_TIMEOUT;
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync do
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync {
d4a9d525e6f2111d462d2d96462dced6b9ec00efvboxsync RTThreadSleep(1);
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync if (sx_try_xlock(&pThis->SxLock))
fb41ad77bcfbdb3aaa1fc9503a37ee6a70dc6461vboxsync {
fb41ad77bcfbdb3aaa1fc9503a37ee6a70dc6461vboxsync rc = VINF_SUCCESS;
fb41ad77bcfbdb3aaa1fc9503a37ee6a70dc6461vboxsync break;
fb41ad77bcfbdb3aaa1fc9503a37ee6a70dc6461vboxsync }
fb41ad77bcfbdb3aaa1fc9503a37ee6a70dc6461vboxsync } while (RTTimeSystemMilliTS() - StartTS < cMillies);
fb41ad77bcfbdb3aaa1fc9503a37ee6a70dc6461vboxsync }
c55bf74b54ecdfb5ebc4e5d90b620d0fee31737evboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync return VINF_SUCCESS;
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync}
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsyncRTDECL(int) RTSemMutexRelease(RTSEMMUTEX hMutexSem)
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync{
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync PRTSEMMUTEXINTERNAL pThis = hMutexSem;
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMMUTEX_MAGIC, ("%p: u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_HANDLE);
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync sx_xunlock(&pThis->SxLock);
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync return VINF_SUCCESS;
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync}
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
fb41ad77bcfbdb3aaa1fc9503a37ee6a70dc6461vboxsync
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync
c10a6f0c7041e4d1ee50ad38425aab9d43c55522vboxsyncRTDECL(bool) RTSemMutexIsOwned(RTSEMMUTEX hMutexSem)
2f3883b126a405f92b19e829472f614c7352b4f9vboxsync{
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync PRTSEMMUTEXINTERNAL pThis = hMutexSem;
ecf100db90e8e3af96312908282d3c20e754fbe8vboxsync AssertPtrReturn(pThis, false);
3fb3de312d1ff675e0f7cc62a7d46cbb1d5d9353vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMMUTEX_MAGIC, ("%p: u32Magic=%RX32\n", pThis, pThis->u32Magic), false);
c55bf74b54ecdfb5ebc4e5d90b620d0fee31737evboxsync
c55bf74b54ecdfb5ebc4e5d90b620d0fee31737evboxsync return sx_xlocked(&pThis->SxLock);
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync}
c55bf74b54ecdfb5ebc4e5d90b620d0fee31737evboxsync
cd5df721f068659172f3bf95de8fedeb465f057dvboxsync