QoreThreadLock.h

/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
    QoreThreadLock.h
 
    Qore Programming Language
 
    Copyright (C) 2003 - 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 
    Note that the Qore library is released under a choice of three open-source
    licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
    information.
*/
 
#ifndef _QORE_QORETHREADLOCK_H
 
#define _QORE_QORETHREADLOCK_H
 
#include <cassert>
#include <csignal>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <pthread.h>
 
 
class QoreThreadLock {
    friend class QoreCondition;
 
public:
    DLLLOCAL QoreThreadLock() : QoreThreadLock(nullptr) {
    }
 
    DLLLOCAL QoreThreadLock(const pthread_mutexattr_t* ma) {
#ifndef NDEBUG
        int rc =
#endif
        pthread_mutex_init(&ptm_lock, ma);
        assert(!rc);
    }
 
    DLLLOCAL QoreThreadLock(const QoreThreadLock&) : QoreThreadLock(nullptr) {
    }
 
    DLLLOCAL ~QoreThreadLock() {
        pthread_mutex_destroy(&ptm_lock);
    }
 
 
    DLLLOCAL void lock() {
#ifndef NDEBUG
        int rc =
#endif
        pthread_mutex_lock(&ptm_lock);
        assert(!rc);
    }
 
 
    DLLLOCAL void unlock() {
#ifndef NDEBUG
        int rc =
#endif
        pthread_mutex_unlock(&ptm_lock);
        assert(!rc);
    }
 
 
    DLLLOCAL int trylock() {
        return pthread_mutex_trylock(&ptm_lock);
    }
 
private:
    pthread_mutex_t ptm_lock;
 
    DLLLOCAL QoreThreadLock& operator=(const QoreThreadLock&) = delete;
};
 
 
class QoreRecursiveThreadLock : public QoreThreadLock {
public:
    DLLEXPORT QoreRecursiveThreadLock();
 
    DLLLOCAL QoreRecursiveThreadLock(const QoreRecursiveThreadLock&) : QoreRecursiveThreadLock() {
    }
};
 
 
class AutoLocker {
public:
    DLLLOCAL AutoLocker(QoreThreadLock* l) : lck(l) {
        lck->lock();
    }
 
    DLLLOCAL AutoLocker(QoreThreadLock& l) : lck(&l) {
        lck->lock();
    }
 
 
    DLLLOCAL AutoLocker(QoreThreadLock* l, bool already_locked) : lck(l) {
        if (!already_locked) {
            lck->lock();
        }
    }
 
 
    DLLLOCAL AutoLocker(QoreThreadLock& l, bool already_locked) : lck(&l) {
        if (!already_locked) {
            lck->lock();
        }
    }
 
    DLLLOCAL ~AutoLocker() {
        lck->unlock();
    }
 
private:
    DLLLOCAL AutoLocker(const AutoLocker&) = delete;
    DLLLOCAL AutoLocker& operator=(const AutoLocker&) = delete;
    DLLLOCAL void *operator new(size_t) = delete;
 
protected:
    QoreThreadLock* lck;
};
 
 
class AutoUnlocker {
public:
    DLLLOCAL AutoUnlocker(QoreThreadLock* l) : lck(l) {
        if (lck)
            lck->unlock();
    }
 
    DLLLOCAL AutoUnlocker(QoreThreadLock& l) : lck(&l) {
        lck->unlock();
    }
 
    DLLLOCAL ~AutoUnlocker() {
        if (lck)
            lck->lock();
    }
 
private:
    DLLLOCAL AutoUnlocker(const AutoUnlocker&) = delete;
    DLLLOCAL AutoUnlocker& operator=(const AutoUnlocker&) = delete;
    DLLLOCAL void *operator new(size_t) = delete;
 
protected:
    QoreThreadLock* lck;
};
 
 
class SafeLocker {
public:
    DLLLOCAL SafeLocker(QoreThreadLock* l) : lck(l) {
        lck->lock();
        locked = true;
    }
 
    DLLLOCAL SafeLocker(QoreThreadLock& l) : lck(&l) {
        lck->lock();
        locked = true;
    }
 
    DLLLOCAL ~SafeLocker() {
        if (locked)
            lck->unlock();
    }
 
    DLLLOCAL void lock() {
        assert(!locked);
        lck->lock();
        locked = true;
    }
 
    DLLLOCAL void unlock() {
        assert(locked);
        locked = false;
        lck->unlock();
    }
 
    DLLLOCAL void stay_locked() {
        assert(locked);
        locked = false;
    }
 
    DLLLOCAL void relock() {
        assert(!locked);
        lck->lock();
        locked = true;
    }
 
private:
    DLLLOCAL SafeLocker(const SafeLocker&) = delete;
    DLLLOCAL SafeLocker& operator=(const SafeLocker&) = delete;
    DLLLOCAL void *operator new(size_t) = delete;
 
protected:
    QoreThreadLock* lck;
 
    bool locked;
};
 
 
class OptLocker {
public:
    DLLLOCAL OptLocker(QoreThreadLock* l) : lck(l) {
        if (lck)
            lck->lock();
    }
 
    DLLLOCAL ~OptLocker() {
        if (lck)
            lck->unlock();
    }
 
private:
    DLLLOCAL OptLocker(const OptLocker&) = delete;
    DLLLOCAL OptLocker& operator=(const OptLocker&) = delete;
    DLLLOCAL void *operator new(size_t) = delete;
 
protected:
    QoreThreadLock* lck;
};
 
#endif // _QORE_QORETHREADLOCK_H