xref: /src/sys/external/bsd/drm2/linux/linux_kthread.c

/*	$NetBSD: linux_kthread.c,v 1.9 2021/12/19 12:43:05 riastradh Exp $	*/

/*-
 * Copyright (c) 2021 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Taylor R. Campbell.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: linux_kthread.c,v 1.9 2021/12/19 12:43:05 riastradh Exp $");

#include <sys/types.h>

#include <sys/condvar.h>
#include <sys/kmem.h>
#include <sys/kthread.h>
#include <sys/lwp.h>
#include <sys/mutex.h>
#include <sys/specificdata.h>

#include <linux/err.h>
#include <linux/kthread.h>
#include <linux/spinlock.h>

#include <drm/drm_wait_netbsd.h>

struct task_struct {
	kmutex_t	kt_lock;
	kcondvar_t	kt_cv;
	bool		kt_shouldstop:1;
	bool		kt_shouldpark:1;
	bool		kt_parked:1;
	bool		kt_exited:1;
	int		kt_ret;

	int		(*kt_func)(void *);
	void		*kt_cookie;
	spinlock_t	*kt_interlock;
	drm_waitqueue_t	*kt_wq;
	struct lwp	*kt_lwp;
};

static specificdata_key_t linux_kthread_key __read_mostly = -1;

int
linux_kthread_init(void)
{
	int error;

	error = lwp_specific_key_create(&linux_kthread_key, NULL);
	if (error)
		goto out;

	/* Success!  */
	error = 0;

out:	if (error)
		linux_kthread_fini();
	return error;
}

void
linux_kthread_fini(void)
{

	if (linux_kthread_key != -1) {
		lwp_specific_key_delete(linux_kthread_key);
		linux_kthread_key = -1;
	}
}

#define	linux_kthread()	_linux_kthread(__func__)
static struct task_struct *
_linux_kthread(const char *caller)
{
	struct task_struct *T;

	T = lwp_getspecific(linux_kthread_key);
	KASSERTMSG(T != NULL, "%s must be called from Linux kthread", caller);

	return T;
}

static void
linux_kthread_start(void *cookie)
{
	struct task_struct *T = cookie;
	int ret;

	lwp_setspecific(linux_kthread_key, T);

	ret = (*T->kt_func)(T->kt_cookie);

	/*
	 * Mark the thread exited, set the return value, and wake any
	 * waiting kthread_stop.
	 */
	mutex_enter(&T->kt_lock);
	T->kt_exited = true;
	T->kt_ret = ret;
	cv_broadcast(&T->kt_cv);
	mutex_exit(&T->kt_lock);

	/* Exit the (NetBSD) kthread.  */
	kthread_exit(0);
}

static struct task_struct *
kthread_alloc(int (*func)(void *), void *cookie, spinlock_t *interlock,
    drm_waitqueue_t *wq)
{
	struct task_struct *T;

	T = kmem_zalloc(sizeof(*T), KM_SLEEP);

	mutex_init(&T->kt_lock, MUTEX_DEFAULT, IPL_VM);
	cv_init(&T->kt_cv, "lnxkthrd");

	T->kt_shouldstop = false;
	T->kt_shouldpark = false;
	T->kt_parked = false;
	T->kt_exited = false;
	T->kt_ret = 0;

	T->kt_func = func;
	T->kt_cookie = cookie;
	T->kt_interlock = interlock;
	T->kt_wq = wq;

	return T;
}

static void
kthread_free(struct task_struct *T)
{

	KASSERT(T->kt_exited);

	cv_destroy(&T->kt_cv);
	mutex_destroy(&T->kt_lock);
	kmem_free(T, sizeof(*T));
}

struct task_struct *
kthread_run(int (*func)(void *), void *cookie, const char *name,
    spinlock_t *interlock, drm_waitqueue_t *wq)
{
	struct task_struct *T;
	int error;

	T = kthread_alloc(func, cookie, interlock, wq);
	error = kthread_create(PRI_NONE, KTHREAD_MPSAFE, NULL,
	    linux_kthread_start, T, &T->kt_lwp, "%s", name);
	if (error) {
		kthread_free(T);
		return ERR_PTR(-error); /* XXX errno NetBSD->Linux */
	}

	return T;
}

int
kthread_stop(struct task_struct *T)
{
	int ret;

	/* Lock order: interlock, then kthread lock.  */
	spin_lock(T->kt_interlock);
	mutex_enter(&T->kt_lock);

	/*
	 * Notify the thread that it's stopping, and wake it if it's
	 * parked or sleeping on its own waitqueue.
	 */
	T->kt_shouldpark = false;
	T->kt_shouldstop = true;
	cv_broadcast(&T->kt_cv);
	DRM_SPIN_WAKEUP_ALL(T->kt_wq, T->kt_interlock);

	/* Release the interlock while we wait for thread to finish.  */
	spin_unlock(T->kt_interlock);

	/* Wait for the thread to finish.  */
	while (!T->kt_exited)
		cv_wait(&T->kt_cv, &T->kt_lock);

	/* Grab the return code and release the lock -- we're done.  */
	ret = T->kt_ret;
	mutex_exit(&T->kt_lock);

	/* Free the (Linux) kthread.  */
	kthread_free(T);

	/* Return what the thread returned.  */
	return ret;
}

int
kthread_should_stop(void)
{
	struct task_struct *T = linux_kthread();
	bool shouldstop;

	mutex_enter(&T->kt_lock);
	shouldstop = T->kt_shouldstop;
	mutex_exit(&T->kt_lock);

	return shouldstop;
}

void
kthread_park(struct task_struct *T)
{

	/* Lock order: interlock, then kthread lock.  */
	spin_lock(T->kt_interlock);
	mutex_enter(&T->kt_lock);

	/* Caller must not ask to park if they've already asked to stop.  */
	KASSERT(!T->kt_shouldstop);

	/* Ask the thread to park.  */
	T->kt_shouldpark = true;

	/*
	 * Ensure the thread is not sleeping on its condvar.  After
	 * this point, we are done with the interlock, which we must
	 * not hold while we wait on the kthread condvar.
	 */
	DRM_SPIN_WAKEUP_ALL(T->kt_wq, T->kt_interlock);
	spin_unlock(T->kt_interlock);

	/*
	 * Wait until the thread has issued kthread_parkme, unless we
	 * are already the thread, which Linux allows and interprets to
	 * mean don't wait.
	 */
	if (T->kt_lwp != curlwp) {
		while (!T->kt_parked)
			cv_wait(&T->kt_cv, &T->kt_lock);
	}

	/* Release the kthread lock too.  */
	mutex_exit(&T->kt_lock);
}

void
kthread_unpark(struct task_struct *T)
{

	mutex_enter(&T->kt_lock);
	T->kt_shouldpark = false;
	cv_broadcast(&T->kt_cv);
	mutex_exit(&T->kt_lock);
}

int
__kthread_should_park(struct task_struct *T)
{
	bool shouldpark;

	mutex_enter(&T->kt_lock);
	shouldpark = T->kt_shouldpark;
	mutex_exit(&T->kt_lock);

	return shouldpark;
}

int
kthread_should_park(void)
{
	struct task_struct *T = linux_kthread();

	return __kthread_should_park(T);
}

void
kthread_parkme(void)
{
	struct task_struct *T = linux_kthread();

	assert_spin_locked(T->kt_interlock);

	spin_unlock(T->kt_interlock);
	mutex_enter(&T->kt_lock);
	while (T->kt_shouldpark) {
		T->kt_parked = true;
		cv_broadcast(&T->kt_cv);
		cv_wait(&T->kt_cv, &T->kt_lock);
		T->kt_parked = false;
	}
	mutex_exit(&T->kt_lock);
	spin_lock(T->kt_interlock);
}