graphene/Pal/src/host/Linux/db_semaphore.c

/* -*- mode:c; c-file-style:"k&r"; c-basic-offset: 4; tab-width:4; indent-tabs-mode:nil; mode:auto-fill; fill-column:78; -*- */
/* vim: set ts=4 sw=4 et tw=78 fo=cqt wm=0: */

/* Copyright (C) 2014 OSCAR lab, Stony Brook University
   This file is part of Graphene Library OS.

   Graphene Library OS is free software: you can redistribute it and/or
   modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation, either version 3 of the
   License, or (at your option) any later version.

   Graphene Library OS is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

/*
 * db_semaphore.c
 *
 * This file contains APIs that provides operations of semaphores.
 */

#include "pal_defs.h"
#include "pal_linux_defs.h"
#include "pal.h"
#include "pal_internal.h"
#include "pal_linux.h"
#include "pal_error.h"
#include "api.h"

#include <cmpxchg.h>
#include <atomic.h>
#include <linux/futex.h>
#include <limits.h>
#include <errno.h>
#include <linux/time.h>

static inline int atomic_dec_if_positive (struct atomic_int *v)
{
    int c, old, dec;
    c = atomic_read(v);
    for (;;) {
        dec = c - 1;
        if (unlikely(dec < 0))
            break;
        old = atomic_cmpxchg((v), c, dec);
        if (likely(old == c))
            break;
        c = old;
    }
    return dec;
}

int
_DkSemaphoreCreate (PAL_HANDLE handle, int initialCount, int maxCount)
{
    /*
     * 1. Allocate memory for db_sem (this includes a futex variable).
     * 2. Pack it into a PAL_HANDLE
     * 3. Set the semaphore object with the argument values (count, maxCount)
     */

    SET_HANDLE_TYPE(handle, semaphore);
    atomic_set(&handle->semaphore.nwaiters, 0);
    handle->semaphore.max_value = maxCount;

    /* optimization: if maxCount == 1, we make it into mutex */
    if (handle->semaphore.max_value == 1) {
        handle->semaphore.value.mut.u = initialCount;
    } else {
        atomic_set(&handle->semaphore.value.i, maxCount - initialCount);
    }

    return 0;
}

void _DkSemaphoreDestroy (PAL_HANDLE semaphoreHandle)
{
    free(semaphoreHandle);
}

int _DkMutexLockTimeout (struct mutex_handle * mut, uint64_t timeout);

int _DkSemaphoreAcquire (PAL_HANDLE sem, int count)
{
    /* optimization: use it as a mutex */
    if (sem->semaphore.max_value == 1) {
        struct mutex_handle * mut = &sem->semaphore.value.mut;
        _DkMutexLock(mut);
        return 0;
    }

    if (count > sem->semaphore.max_value)
        return -PAL_ERROR_INVAL;

    struct atomic_int * value = &sem->semaphore.value.i;
    int c = 0;

    if (!value)
        return -PAL_ERROR_BADHANDLE;

    if (count == 1)
        c = atomic_dec_and_test_nonnegative (value);
    else
        c = atomic_sub_and_test_nonnegative (count, value);

    if (c)
        return 0;

    /* We didn't get the lock.  Bump the count back up. */
    if (count == 1)
        atomic_inc (value);
    else
        atomic_add (count, value);

    int ret = 0;
    atomic_inc (&sem->semaphore.nwaiters);

    while (1) {
        ret = INLINE_SYSCALL(futex, 6, value, FUTEX_WAIT, 0,
                             NULL, NULL, 0);

        if (IS_ERR(ret)) {
            if (ERRNO(ret) == EWOULDBLOCK) {
                ret = 0;
            } else {
                ret = unix_to_pal_error(ERRNO(ret));
                break;
            }
        }

        if (count == 1)
            c = atomic_dec_and_test_nonnegative (value);
        else
            c = atomic_sub_and_test_nonnegative (count, value);

        if (c)
            break;

        /* We didn't get the lock.  Bump the count back up. */
        if (count == 1)
            atomic_inc (value);
        else
            atomic_add (count, value);
    }

    atomic_dec (&sem->semaphore.nwaiters);
    return ret;
}

int _DkSemaphoreAcquireTimeout (PAL_HANDLE sem, int count, uint64_t timeout)
{
    /* Pass it up to the no-timeout version if no timeout requested */
    if (timeout == NO_TIMEOUT)
        return _DkSemaphoreAcquire(sem, count);

    /* optimization: use it as a mutex */
    if (sem->semaphore.max_value == 1) {
        struct mutex_handle * mut = & sem->semaphore.value.mut;
        return _DkMutexLockTimeout(mut, timeout);
    }

    if (count > sem->semaphore.max_value)
        return -PAL_ERROR_INVAL;

    struct atomic_int * value = &sem->semaphore.value.i;
    int c = 0;

    if (!value)
        return -PAL_ERROR_BADHANDLE;

    if (count == 1)
        c = atomic_dec_and_test_nonnegative (value);
    else
        c = atomic_sub_and_test_nonnegative (count, value);

    if (c)
        return 0;

    /* We didn't get the lock.  Bump the count back up. */
    if (count == 1)
        atomic_inc (value);
    else
        atomic_add (count, value);

    if (!timeout)
        return -PAL_ERROR_TRYAGAIN;

    struct timespec waittime;
    long sec = timeout / 1000000;
    long microsec = timeout - (sec * 1000000);
    waittime.tv_sec = sec;
    waittime.tv_nsec = microsec * 1000;
    int ret = 0;
    atomic_inc (&sem->semaphore.nwaiters);

    while (1) {
        ret = INLINE_SYSCALL(futex, 6, value, FUTEX_WAIT, 0,
                             &waittime, NULL, 0);

        if (ERRNO(ret) == EWOULDBLOCK) {
            ret = 0;
        } else {
            ret = unix_to_pal_error(ERRNO(ret));
            break;
        }

        if (count == 1)
            c = atomic_dec_and_test_nonnegative (value);
        else
            c = atomic_sub_and_test_nonnegative (count, value);

        if (c)
            break;
    }

    /* We didn't get the lock.  Bump the count back up. */
    if (count == 1)
        atomic_inc (value);
    else
        atomic_add (count, value);

    atomic_dec (&sem->semaphore.nwaiters);
    return ret;
}

void _DkSemaphoreRelease (PAL_HANDLE sem, int count)
{
    /* optimization: use it as a mutex */
    if (sem->semaphore.max_value == 1) {
        struct mutex_handle * mut =
            &sem->semaphore.value.mut;

        _DkMutexUnlock(mut);
        return;
    }

    struct atomic_int * value = &sem->semaphore.value.i;

    if (count == 1)
        atomic_inc (value);
    else
        atomic_add (count, value);

    int nwaiters = atomic_read (&sem->semaphore.nwaiters);

    if (nwaiters > 0)
        INLINE_SYSCALL(futex, 6, value, FUTEX_WAKE, nwaiters, NULL, NULL, 0);
}

int _DkSemaphoreGetCurrentCount (PAL_HANDLE sem)
{
    if (sem->semaphore.max_value == 1) {
        struct mutex_handle * m = &sem->semaphore.value.mut;
        return m->b.locked;
    }

    int c = atomic_read(&sem->semaphore.value.i);
    return sem->semaphore.max_value - c;
}