semeventmulti-r0drv-linux.c revision d25cdc250684c6ef5a0884806d778f96126501b3
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/* $Id$ */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/** @file
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * innotek Portable Runtime - Multiple Release Event Semaphores, Ring-0 Driver, Linux.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/*
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Copyright (C) 2006-2007 innotek GmbH
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync *
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * available from http://www.virtualbox.org. This file is free software;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * you can redistribute it and/or modify it under the terms of the GNU
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * General Public License as published by the Free Software Foundation,
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * distribution. VirtualBox OSE is distributed in the hope that it will
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * be useful, but WITHOUT ANY WARRANTY of any kind.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/*******************************************************************************
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync* Header Files *
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync*******************************************************************************/
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync#include "the-linux-kernel.h"
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync#include <iprt/semaphore.h>
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync#include <iprt/alloc.h>
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync#include <iprt/assert.h>
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync#include <iprt/asm.h>
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync#include <iprt/err.h>
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync#include "internal/magics.h"
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/*******************************************************************************
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync* Structures and Typedefs *
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync*******************************************************************************/
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/**
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Linux event semaphore.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsynctypedef struct RTSEMEVENTMULTIINTERNAL
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync{
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /** Magic value (RTSEMEVENT_MAGIC). */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync uint32_t volatile u32Magic;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /** The object status - !0 when signaled and 0 when reset. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync uint32_t volatile fState;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /** The wait queue. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync wait_queue_head_t Head;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync} RTSEMEVENTMULTIINTERNAL, *PRTSEMEVENTMULTIINTERNAL;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncRTDECL(int) RTSemEventMultiCreate(PRTSEMEVENTMULTI pEventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync{
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)RTMemAlloc(sizeof(*pThis));
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (pThis)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync {
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync pThis->u32Magic = RTSEMEVENT_MAGIC;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync init_waitqueue_head(&pThis->Head);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync *pEventMultiSem = pThis;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VINF_SUCCESS;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync }
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VERR_NO_MEMORY;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync}
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncRTDECL(int) RTSemEventMultiDestroy(RTSEMEVENTMULTI EventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync{
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /*
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Validate input.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)EventMultiSem;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (!pThis)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VERR_INVALID_PARAMETER;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /*
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Invalidate it and signal the object just in case.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync ASMAtomicIncU32(&pThis->u32Magic);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync ASMAtomicXchgU32(&pThis->fState, 0);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync Assert(!waitqueue_active(&pThis->Head));
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync wake_up_all(&pThis->Head);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync RTMemFree(pThis);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VINF_SUCCESS;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync}
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncRTDECL(int) RTSemEventMultiSignal(RTSEMEVENTMULTI EventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync{
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /*
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Validate input.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)EventMultiSem;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (!pThis)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VERR_INVALID_PARAMETER;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /*
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Signal the event object.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync ASMAtomicXchgU32(&pThis->fState, 1);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync wake_up_all(&pThis->Head);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VINF_SUCCESS;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync}
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncRTDECL(int) RTSemEventMultiReset(RTSEMEVENTMULTI EventMultiSem)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync{
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /*
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Validate input.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)EventMultiSem;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (!pThis)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VERR_INVALID_PARAMETER;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /*
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Reset it.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync ASMAtomicXchgU32(&pThis->fState, 0);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VINF_SUCCESS;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync}
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync/**
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Worker for RTSemEventMulti and RTSemEventMultiNoResume.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync *
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * @returns VBox status code.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * @param pThis The event semaphore.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * @param cMillies The number of milliseconds to wait.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * @param fInterruptible Whether it's an interruptible wait or not.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncstatic int rtSemEventWait(PRTSEMEVENTMULTIINTERNAL pThis, unsigned cMillies, bool fInterruptible)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync{
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /*
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync * Ok wait for it.
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync DEFINE_WAIT(Wait);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync int rc = VINF_SUCCESS;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync long lTimeout = cMillies == RT_INDEFINITE_WAIT ? MAX_SCHEDULE_TIMEOUT : msecs_to_jiffies(cMillies);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync for (;;)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync {
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /* make everything thru schedule() atomic scheduling wise. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync prepare_to_wait(&pThis->Head, &Wait, fInterruptible ? TASK_INTERRUPTIBLE : TASK_UNINTERRUPTIBLE);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /* check the condition. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (pThis->fState)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync break;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /* check for pending signals. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (fInterruptible && signal_pending(current))
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync {
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync rc = VERR_INTERRUPTED;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync break;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync }
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /* wait */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync lTimeout = schedule_timeout(lTimeout);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /* Check if someone destroyed the semaphore while we were waiting. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (pThis->u32Magic != RTSEMEVENT_MAGIC)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync {
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync rc = VERR_SEM_DESTROYED;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync break;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync }
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync /* check for timeout. */
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (!lTimeout)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync {
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync rc = VERR_TIMEOUT;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync break;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync }
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync }
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync finish_wait(&pThis->Head, &Wait);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return rc;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync}
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncRTDECL(int) RTSemEventMultiWait(RTSEMEVENTMULTI EventMultiSem, unsigned cMillies)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync{
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)EventMultiSem;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (!pThis)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VERR_INVALID_PARAMETER;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (pThis->fState)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VINF_SUCCESS;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return rtSemEventWait(pThis, cMillies, false /* fInterruptible */);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync}
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsyncRTDECL(int) RTSemEventMultiWaitNoResume(RTSEMEVENTMULTI EventMultiSem, unsigned cMillies)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync{
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)EventMultiSem;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (!pThis)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VERR_INVALID_PARAMETER;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENT_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync if (pThis->fState)
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return VINF_SUCCESS;
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync return rtSemEventWait(pThis, cMillies, true /* fInterruptible */);
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync}
d25cdc250684c6ef5a0884806d778f96126501b3vboxsync