semeventmulti-r0drv-linux.c revision 30c84c361575629a712f338b514d9db7a8c681f4
671242f350d172e106580348e24bab66b0d7e6a5vboxsync/* $Id$ */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync/** @file
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * IPRT - Multiple Release Event Semaphores, Ring-0 Driver, Linux.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync/*
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync *
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * available from http://www.virtualbox.org. This file is free software;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * you can redistribute it and/or modify it under the terms of the GNU
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * General Public License (GPL) as published by the Free Software
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync *
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * The contents of this file may alternatively be used under the terms
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * of the Common Development and Distribution License Version 1.0
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * VirtualBox OSE distribution, in which case the provisions of the
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * CDDL are applicable instead of those of the GPL.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync *
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * You may elect to license modified versions of this file under the
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * terms and conditions of either the GPL or the CDDL or both.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync *
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * additional information or have any questions.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync/*******************************************************************************
671242f350d172e106580348e24bab66b0d7e6a5vboxsync* Header Files *
671242f350d172e106580348e24bab66b0d7e6a5vboxsync*******************************************************************************/
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#include "the-linux-kernel.h"
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#include "internal/iprt.h"
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#include <iprt/semaphore.h>
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#include <iprt/alloc.h>
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#include <iprt/assert.h>
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#include <iprt/asm.h>
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#include <iprt/err.h>
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#include "internal/magics.h"
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync/*******************************************************************************
671242f350d172e106580348e24bab66b0d7e6a5vboxsync* Structures and Typedefs *
671242f350d172e106580348e24bab66b0d7e6a5vboxsync*******************************************************************************/
671242f350d172e106580348e24bab66b0d7e6a5vboxsync/**
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Linux event semaphore.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsynctypedef struct RTSEMEVENTMULTIINTERNAL
671242f350d172e106580348e24bab66b0d7e6a5vboxsync{
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /** Magic value (RTSEMEVENTMULTI_MAGIC). */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync uint32_t volatile u32Magic;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /** The object status - !0 when signaled and 0 when reset. */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync uint32_t volatile fState;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /** The wait queue. */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync wait_queue_head_t Head;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync} RTSEMEVENTMULTIINTERNAL, *PRTSEMEVENTMULTIINTERNAL;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRTDECL(int) RTSemEventMultiCreate(PRTSEMEVENTMULTI pEventMultiSem)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync{
671242f350d172e106580348e24bab66b0d7e6a5vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)RTMemAlloc(sizeof(*pThis));
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (pThis)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync {
671242f350d172e106580348e24bab66b0d7e6a5vboxsync pThis->u32Magic = RTSEMEVENTMULTI_MAGIC;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync pThis->fState = 0;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync init_waitqueue_head(&pThis->Head);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync *pEventMultiSem = pThis;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return VINF_SUCCESS;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync }
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return VERR_NO_MEMORY;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync}
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRT_EXPORT_SYMBOL(RTSemEventMultiCreate);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRTDECL(int) RTSemEventMultiDestroy(RTSEMEVENTMULTI EventMultiSem)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync{
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /*
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Validate input.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)EventMultiSem;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (!pThis)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return VERR_INVALID_PARAMETER;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /*
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Invalidate it and signal the object just in case.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync ASMAtomicIncU32(&pThis->u32Magic);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync ASMAtomicXchgU32(&pThis->fState, 0);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync Assert(!waitqueue_active(&pThis->Head));
671242f350d172e106580348e24bab66b0d7e6a5vboxsync wake_up_all(&pThis->Head);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync RTMemFree(pThis);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return VINF_SUCCESS;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync}
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRT_EXPORT_SYMBOL(RTSemEventMultiDestroy);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRTDECL(int) RTSemEventMultiSignal(RTSEMEVENTMULTI EventMultiSem)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync{
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /*
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Validate input.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)EventMultiSem;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (!pThis)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return VERR_INVALID_PARAMETER;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /*
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Signal the event object.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync ASMAtomicXchgU32(&pThis->fState, 1);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync wake_up_all(&pThis->Head);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return VINF_SUCCESS;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync}
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRT_EXPORT_SYMBOL(RTSemEventMultiSignal);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRTDECL(int) RTSemEventMultiReset(RTSEMEVENTMULTI EventMultiSem)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync{
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /*
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Validate input.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)EventMultiSem;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (!pThis)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return VERR_INVALID_PARAMETER;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /*
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Reset it.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync ASMAtomicXchgU32(&pThis->fState, 0);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return VINF_SUCCESS;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync}
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRT_EXPORT_SYMBOL(RTSemEventMultiReset);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync/**
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Worker for RTSemEventMulti and RTSemEventMultiNoResume.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync *
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * @returns VBox status code.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * @param pThis The event semaphore.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * @param cMillies The number of milliseconds to wait.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * @param fInterruptible Whether it's an interruptible wait or not.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncstatic int rtSemEventMultiWait(PRTSEMEVENTMULTIINTERNAL pThis, unsigned cMillies, bool fInterruptible)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync{
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /*
671242f350d172e106580348e24bab66b0d7e6a5vboxsync * Ok wait for it.
671242f350d172e106580348e24bab66b0d7e6a5vboxsync */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync DEFINE_WAIT(Wait);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync int rc = VINF_SUCCESS;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync long lTimeout = cMillies == RT_INDEFINITE_WAIT ? MAX_SCHEDULE_TIMEOUT : msecs_to_jiffies(cMillies);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#ifdef IPRT_DEBUG_SEMS
671242f350d172e106580348e24bab66b0d7e6a5vboxsync snprintf(current->comm, TASK_COMM_LEN, "E%lx", IPRT_DEBUG_SEMS_ADDRESS(pThis));
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#endif
671242f350d172e106580348e24bab66b0d7e6a5vboxsync for (;;)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync {
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /* make everything thru schedule() atomic scheduling wise. */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync prepare_to_wait(&pThis->Head, &Wait, fInterruptible ? TASK_INTERRUPTIBLE : TASK_UNINTERRUPTIBLE);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /* check the condition. */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (pThis->fState)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync break;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /* check for pending signals. */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (fInterruptible && signal_pending(current))
671242f350d172e106580348e24bab66b0d7e6a5vboxsync {
671242f350d172e106580348e24bab66b0d7e6a5vboxsync rc = VERR_INTERRUPTED;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync break;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync }
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /* wait */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync lTimeout = schedule_timeout(lTimeout);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync after_wait(&Wait);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /* Check if someone destroyed the semaphore while we were waiting. */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (pThis->u32Magic != RTSEMEVENTMULTI_MAGIC)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync {
671242f350d172e106580348e24bab66b0d7e6a5vboxsync rc = VERR_SEM_DESTROYED;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync break;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync }
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync /* check for timeout. */
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (!lTimeout)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync {
671242f350d172e106580348e24bab66b0d7e6a5vboxsync rc = VERR_TIMEOUT;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync break;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync }
671242f350d172e106580348e24bab66b0d7e6a5vboxsync }
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync finish_wait(&pThis->Head, &Wait);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#ifdef IPRT_DEBUG_SEMS
671242f350d172e106580348e24bab66b0d7e6a5vboxsync snprintf(current->comm, TASK_COMM_LEN, "E%lx:%d", IPRT_DEBUG_SEMS_ADDRESS(pThis), rc);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync#endif
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return rc;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync}
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRTDECL(int) RTSemEventMultiWait(RTSEMEVENTMULTI EventMultiSem, unsigned cMillies)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync{
671242f350d172e106580348e24bab66b0d7e6a5vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)EventMultiSem;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (!pThis)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return VERR_INVALID_PARAMETER;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (pThis->fState)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return VINF_SUCCESS;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync return rtSemEventMultiWait(pThis, cMillies, false /* fInterruptible */);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync}
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRT_EXPORT_SYMBOL(RTSemEventMultiWait);
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsync
671242f350d172e106580348e24bab66b0d7e6a5vboxsyncRTDECL(int) RTSemEventMultiWaitNoResume(RTSEMEVENTMULTI EventMultiSem, unsigned cMillies)
671242f350d172e106580348e24bab66b0d7e6a5vboxsync{
671242f350d172e106580348e24bab66b0d7e6a5vboxsync PRTSEMEVENTMULTIINTERNAL pThis = (PRTSEMEVENTMULTIINTERNAL)EventMultiSem;
671242f350d172e106580348e24bab66b0d7e6a5vboxsync if (!pThis)
return VERR_INVALID_PARAMETER;
AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
AssertMsgReturn(pThis->u32Magic == RTSEMEVENTMULTI_MAGIC, ("%p u32Magic=%RX32\n", pThis, pThis->u32Magic), VERR_INVALID_PARAMETER);
if (pThis->fState)
return VINF_SUCCESS;
return rtSemEventMultiWait(pThis, cMillies, true /* fInterruptible */);
}
RT_EXPORT_SYMBOL(RTSemEventMultiWaitNoResume);