aboutsummaryrefslogtreecommitdiffstats
path: root/kernel/sched/swork.c
blob: 1950f40ca725811a344a88dca9bdddc2616b8c16 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/*
 * Copyright (C) 2014 BMW Car IT GmbH, Daniel Wagner daniel.wagner@bmw-carit.de
 *
 * Provides a framework for enqueuing callbacks from irq context
 * PREEMPT_RT_FULL safe. The callbacks are executed in kthread context.
 */

#include <linux/swait.h>
#include <linux/swork.h>
#include <linux/kthread.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/export.h>

#define SWORK_EVENT_PENDING     (1 << 0)

static DEFINE_MUTEX(worker_mutex);
static struct sworker *glob_worker;

struct sworker {
	struct list_head events;
	struct swait_queue_head wq;

	raw_spinlock_t lock;

	struct task_struct *task;
	int refs;
};

static bool swork_readable(struct sworker *worker)
{
	bool r;

	if (kthread_should_stop())
		return true;

	raw_spin_lock_irq(&worker->lock);
	r = !list_empty(&worker->events);
	raw_spin_unlock_irq(&worker->lock);

	return r;
}

static int swork_kthread(void *arg)
{
	struct sworker *worker = arg;

	for (;;) {
		swait_event_interruptible(worker->wq,
					swork_readable(worker));
		if (kthread_should_stop())
			break;

		raw_spin_lock_irq(&worker->lock);
		while (!list_empty(&worker->events)) {
			struct swork_event *sev;

			sev = list_first_entry(&worker->events,
					struct swork_event, item);
			list_del(&sev->item);
			raw_spin_unlock_irq(&worker->lock);

			WARN_ON_ONCE(!test_and_clear_bit(SWORK_EVENT_PENDING,
							 &sev->flags));
			sev->func(sev);
			raw_spin_lock_irq(&worker->lock);
		}
		raw_spin_unlock_irq(&worker->lock);
	}
	return 0;
}

static struct sworker *swork_create(void)
{
	struct sworker *worker;

	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
	if (!worker)
		return ERR_PTR(-ENOMEM);

	INIT_LIST_HEAD(&worker->events);
	raw_spin_lock_init(&worker->lock);
	init_swait_queue_head(&worker->wq);

	worker->task = kthread_run(swork_kthread, worker, "kswork");
	if (IS_ERR(worker->task)) {
		kfree(worker);
		return ERR_PTR(-ENOMEM);
	}

	return worker;
}

static void swork_destroy(struct sworker *worker)
{
	kthread_stop(worker->task);

	WARN_ON(!list_empty(&worker->events));
	kfree(worker);
}

/**
 * swork_queue - queue swork
 *
 * Returns %false if @work was already on a queue, %true otherwise.
 *
 * The work is queued and processed on a random CPU
 */
bool swork_queue(struct swork_event *sev)
{
	unsigned long flags;

	if (test_and_set_bit(SWORK_EVENT_PENDING, &sev->flags))
		return false;

	raw_spin_lock_irqsave(&glob_worker->lock, flags);
	list_add_tail(&sev->item, &glob_worker->events);
	raw_spin_unlock_irqrestore(&glob_worker->lock, flags);

	swake_up(&glob_worker->wq);
	return true;
}
EXPORT_SYMBOL_GPL(swork_queue);

/**
 * swork_get - get an instance of the sworker
 *
 * Returns an negative error code if the initialization if the worker did not
 * work, %0 otherwise.
 *
 */
int swork_get(void)
{
	struct sworker *worker;

	mutex_lock(&worker_mutex);
	if (!glob_worker) {
		worker = swork_create();
		if (IS_ERR(worker)) {
			mutex_unlock(&worker_mutex);
			return -ENOMEM;
		}

		glob_worker = worker;
	}

	glob_worker->refs++;
	mutex_unlock(&worker_mutex);

	return 0;
}
EXPORT_SYMBOL_GPL(swork_get);

/**
 * swork_put - puts an instance of the sworker
 *
 * Will destroy the sworker thread. This function must not be called until all
 * queued events have been completed.
 */
void swork_put(void)
{
	mutex_lock(&worker_mutex);

	glob_worker->refs--;
	if (glob_worker->refs > 0)
		goto out;

	swork_destroy(glob_worker);
	glob_worker = NULL;
out:
	mutex_unlock(&worker_mutex);
}
EXPORT_SYMBOL_GPL(swork_put);