Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /** |
b5e89ed5 | 2 | * \file drm_lock.c |
1da177e4 | 3 | * IOCTLs for locking |
b5e89ed5 | 4 | * |
1da177e4 LT |
5 | * \author Rickard E. (Rik) Faith <faith@valinux.com> |
6 | * \author Gareth Hughes <gareth@valinux.com> | |
7 | */ | |
8 | ||
9 | /* | |
10 | * Created: Tue Feb 2 08:37:54 1999 by faith@valinux.com | |
11 | * | |
12 | * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas. | |
13 | * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California. | |
14 | * All Rights Reserved. | |
15 | * | |
16 | * Permission is hereby granted, free of charge, to any person obtaining a | |
17 | * copy of this software and associated documentation files (the "Software"), | |
18 | * to deal in the Software without restriction, including without limitation | |
19 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, | |
20 | * and/or sell copies of the Software, and to permit persons to whom the | |
21 | * Software is furnished to do so, subject to the following conditions: | |
22 | * | |
23 | * The above copyright notice and this permission notice (including the next | |
24 | * paragraph) shall be included in all copies or substantial portions of the | |
25 | * Software. | |
26 | * | |
27 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
28 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
29 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
30 | * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR | |
31 | * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, | |
32 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | |
33 | * OTHER DEALINGS IN THE SOFTWARE. | |
34 | */ | |
35 | ||
5c2a5ce6 | 36 | #include <linux/export.h> |
760285e7 | 37 | #include <drm/drmP.h> |
1da177e4 | 38 | |
c94f7029 DA |
39 | static int drm_notifier(void *priv); |
40 | ||
4ac5ec40 DV |
41 | static int drm_lock_take(struct drm_lock_data *lock_data, unsigned int context); |
42 | ||
b5e89ed5 | 43 | /** |
1da177e4 LT |
44 | * Lock ioctl. |
45 | * | |
46 | * \param inode device inode. | |
6c340eac | 47 | * \param file_priv DRM file private. |
1da177e4 LT |
48 | * \param cmd command. |
49 | * \param arg user argument, pointing to a drm_lock structure. | |
50 | * \return zero on success or negative number on failure. | |
51 | * | |
52 | * Add the current task to the lock wait queue, and attempt to take to lock. | |
53 | */ | |
c153f45f | 54 | int drm_lock(struct drm_device *dev, void *data, struct drm_file *file_priv) |
1da177e4 | 55 | { |
b5e89ed5 | 56 | DECLARE_WAITQUEUE(entry, current); |
c153f45f | 57 | struct drm_lock *lock = data; |
7c1c2871 | 58 | struct drm_master *master = file_priv->master; |
b5e89ed5 | 59 | int ret = 0; |
1da177e4 | 60 | |
6c340eac | 61 | ++file_priv->lock_count; |
1da177e4 | 62 | |
c153f45f | 63 | if (lock->context == DRM_KERNEL_CONTEXT) { |
b5e89ed5 | 64 | DRM_ERROR("Process %d using kernel context %d\n", |
ba25f9dc | 65 | task_pid_nr(current), lock->context); |
b5e89ed5 DA |
66 | return -EINVAL; |
67 | } | |
1da177e4 | 68 | |
b5e89ed5 | 69 | DRM_DEBUG("%d (pid %d) requests lock (0x%08x), flags = 0x%08x\n", |
ba25f9dc | 70 | lock->context, task_pid_nr(current), |
7c1c2871 | 71 | master->lock.hw_lock->lock, lock->flags); |
1da177e4 | 72 | |
7c1c2871 DA |
73 | add_wait_queue(&master->lock.lock_queue, &entry); |
74 | spin_lock_bh(&master->lock.spinlock); | |
75 | master->lock.user_waiters++; | |
76 | spin_unlock_bh(&master->lock.spinlock); | |
77 | ||
1da177e4 LT |
78 | for (;;) { |
79 | __set_current_state(TASK_INTERRUPTIBLE); | |
7c1c2871 | 80 | if (!master->lock.hw_lock) { |
1da177e4 | 81 | /* Device has been unregistered */ |
fda714c2 | 82 | send_sig(SIGTERM, current, 0); |
1da177e4 LT |
83 | ret = -EINTR; |
84 | break; | |
85 | } | |
7c1c2871 DA |
86 | if (drm_lock_take(&master->lock, lock->context)) { |
87 | master->lock.file_priv = file_priv; | |
88 | master->lock.lock_time = jiffies; | |
b5e89ed5 | 89 | break; /* Got lock */ |
1da177e4 | 90 | } |
b5e89ed5 | 91 | |
1da177e4 | 92 | /* Contention */ |
08f2e669 | 93 | mutex_unlock(&drm_global_mutex); |
1da177e4 | 94 | schedule(); |
08f2e669 | 95 | mutex_lock(&drm_global_mutex); |
b5e89ed5 | 96 | if (signal_pending(current)) { |
4d77c88e | 97 | ret = -EINTR; |
1da177e4 LT |
98 | break; |
99 | } | |
100 | } | |
7c1c2871 DA |
101 | spin_lock_bh(&master->lock.spinlock); |
102 | master->lock.user_waiters--; | |
103 | spin_unlock_bh(&master->lock.spinlock); | |
1da177e4 | 104 | __set_current_state(TASK_RUNNING); |
7c1c2871 | 105 | remove_wait_queue(&master->lock.lock_queue, &entry); |
1da177e4 | 106 | |
c153f45f EA |
107 | DRM_DEBUG("%d %s\n", lock->context, |
108 | ret ? "interrupted" : "has lock"); | |
040ac320 | 109 | if (ret) return ret; |
d985c108 | 110 | |
3e5fc80a DA |
111 | /* don't set the block all signals on the master process for now |
112 | * really probably not the correct answer but lets us debug xkb | |
113 | * xserver for now */ | |
7c1c2871 | 114 | if (!file_priv->is_master) { |
3e5fc80a DA |
115 | sigemptyset(&dev->sigmask); |
116 | sigaddset(&dev->sigmask, SIGSTOP); | |
117 | sigaddset(&dev->sigmask, SIGTSTP); | |
118 | sigaddset(&dev->sigmask, SIGTTIN); | |
119 | sigaddset(&dev->sigmask, SIGTTOU); | |
120 | dev->sigdata.context = lock->context; | |
7c1c2871 | 121 | dev->sigdata.lock = master->lock.hw_lock; |
3e5fc80a DA |
122 | block_all_signals(drm_notifier, &dev->sigdata, &dev->sigmask); |
123 | } | |
b5e89ed5 | 124 | |
c153f45f EA |
125 | if (dev->driver->dma_quiescent && (lock->flags & _DRM_LOCK_QUIESCENT)) |
126 | { | |
d985c108 | 127 | if (dev->driver->dma_quiescent(dev)) { |
c153f45f EA |
128 | DRM_DEBUG("%d waiting for DMA quiescent\n", |
129 | lock->context); | |
20caafa6 | 130 | return -EBUSY; |
d985c108 DA |
131 | } |
132 | } | |
b5e89ed5 | 133 | |
d985c108 | 134 | return 0; |
1da177e4 LT |
135 | } |
136 | ||
b5e89ed5 | 137 | /** |
1da177e4 LT |
138 | * Unlock ioctl. |
139 | * | |
140 | * \param inode device inode. | |
6c340eac | 141 | * \param file_priv DRM file private. |
1da177e4 LT |
142 | * \param cmd command. |
143 | * \param arg user argument, pointing to a drm_lock structure. | |
144 | * \return zero on success or negative number on failure. | |
145 | * | |
146 | * Transfer and free the lock. | |
147 | */ | |
c153f45f | 148 | int drm_unlock(struct drm_device *dev, void *data, struct drm_file *file_priv) |
1da177e4 | 149 | { |
c153f45f | 150 | struct drm_lock *lock = data; |
45ff46c5 | 151 | struct drm_master *master = file_priv->master; |
1da177e4 | 152 | |
c153f45f | 153 | if (lock->context == DRM_KERNEL_CONTEXT) { |
b5e89ed5 | 154 | DRM_ERROR("Process %d using kernel context %d\n", |
ba25f9dc | 155 | task_pid_nr(current), lock->context); |
1da177e4 LT |
156 | return -EINVAL; |
157 | } | |
158 | ||
45ff46c5 DV |
159 | if (drm_lock_free(&master->lock, lock->context)) { |
160 | /* FIXME: Should really bail out here. */ | |
161 | } | |
162 | ||
1da177e4 LT |
163 | unblock_all_signals(); |
164 | return 0; | |
165 | } | |
166 | ||
167 | /** | |
168 | * Take the heavyweight lock. | |
169 | * | |
170 | * \param lock lock pointer. | |
171 | * \param context locking context. | |
172 | * \return one if the lock is held, or zero otherwise. | |
173 | * | |
174 | * Attempt to mark the lock as held by the given context, via the \p cmpxchg instruction. | |
175 | */ | |
4ac5ec40 | 176 | static |
55910517 | 177 | int drm_lock_take(struct drm_lock_data *lock_data, |
040ac320 | 178 | unsigned int context) |
1da177e4 LT |
179 | { |
180 | unsigned int old, new, prev; | |
040ac320 | 181 | volatile unsigned int *lock = &lock_data->hw_lock->lock; |
1da177e4 | 182 | |
f116cc56 | 183 | spin_lock_bh(&lock_data->spinlock); |
1da177e4 LT |
184 | do { |
185 | old = *lock; | |
b5e89ed5 DA |
186 | if (old & _DRM_LOCK_HELD) |
187 | new = old | _DRM_LOCK_CONT; | |
040ac320 TH |
188 | else { |
189 | new = context | _DRM_LOCK_HELD | | |
190 | ((lock_data->user_waiters + lock_data->kernel_waiters > 1) ? | |
191 | _DRM_LOCK_CONT : 0); | |
192 | } | |
1da177e4 LT |
193 | prev = cmpxchg(lock, old, new); |
194 | } while (prev != old); | |
f116cc56 | 195 | spin_unlock_bh(&lock_data->spinlock); |
040ac320 | 196 | |
1da177e4 LT |
197 | if (_DRM_LOCKING_CONTEXT(old) == context) { |
198 | if (old & _DRM_LOCK_HELD) { | |
199 | if (context != DRM_KERNEL_CONTEXT) { | |
200 | DRM_ERROR("%d holds heavyweight lock\n", | |
201 | context); | |
202 | } | |
203 | return 0; | |
204 | } | |
205 | } | |
040ac320 TH |
206 | |
207 | if ((_DRM_LOCKING_CONTEXT(new)) == context && (new & _DRM_LOCK_HELD)) { | |
b5e89ed5 | 208 | /* Have lock */ |
1da177e4 LT |
209 | return 1; |
210 | } | |
211 | return 0; | |
212 | } | |
213 | ||
214 | /** | |
215 | * This takes a lock forcibly and hands it to context. Should ONLY be used | |
b5e89ed5 DA |
216 | * inside *_unlock to give lock to kernel before calling *_dma_schedule. |
217 | * | |
1da177e4 LT |
218 | * \param dev DRM device. |
219 | * \param lock lock pointer. | |
220 | * \param context locking context. | |
221 | * \return always one. | |
222 | * | |
223 | * Resets the lock file pointer. | |
224 | * Marks the lock as held by the given context, via the \p cmpxchg instruction. | |
225 | */ | |
55910517 | 226 | static int drm_lock_transfer(struct drm_lock_data *lock_data, |
c94f7029 | 227 | unsigned int context) |
1da177e4 LT |
228 | { |
229 | unsigned int old, new, prev; | |
040ac320 | 230 | volatile unsigned int *lock = &lock_data->hw_lock->lock; |
1da177e4 | 231 | |
6c340eac | 232 | lock_data->file_priv = NULL; |
1da177e4 | 233 | do { |
b5e89ed5 DA |
234 | old = *lock; |
235 | new = context | _DRM_LOCK_HELD; | |
1da177e4 LT |
236 | prev = cmpxchg(lock, old, new); |
237 | } while (prev != old); | |
238 | return 1; | |
239 | } | |
240 | ||
241 | /** | |
242 | * Free lock. | |
b5e89ed5 | 243 | * |
1da177e4 LT |
244 | * \param dev DRM device. |
245 | * \param lock lock. | |
246 | * \param context context. | |
b5e89ed5 | 247 | * |
1da177e4 LT |
248 | * Resets the lock file pointer. |
249 | * Marks the lock as not held, via the \p cmpxchg instruction. Wakes any task | |
250 | * waiting on the lock queue. | |
251 | */ | |
55910517 | 252 | int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context) |
1da177e4 LT |
253 | { |
254 | unsigned int old, new, prev; | |
040ac320 TH |
255 | volatile unsigned int *lock = &lock_data->hw_lock->lock; |
256 | ||
f116cc56 | 257 | spin_lock_bh(&lock_data->spinlock); |
040ac320 TH |
258 | if (lock_data->kernel_waiters != 0) { |
259 | drm_lock_transfer(lock_data, 0); | |
260 | lock_data->idle_has_lock = 1; | |
f116cc56 | 261 | spin_unlock_bh(&lock_data->spinlock); |
040ac320 TH |
262 | return 1; |
263 | } | |
f116cc56 | 264 | spin_unlock_bh(&lock_data->spinlock); |
1da177e4 | 265 | |
1da177e4 | 266 | do { |
b5e89ed5 | 267 | old = *lock; |
040ac320 | 268 | new = _DRM_LOCKING_CONTEXT(old); |
1da177e4 LT |
269 | prev = cmpxchg(lock, old, new); |
270 | } while (prev != old); | |
040ac320 | 271 | |
1da177e4 LT |
272 | if (_DRM_LOCK_IS_HELD(old) && _DRM_LOCKING_CONTEXT(old) != context) { |
273 | DRM_ERROR("%d freed heavyweight lock held by %d\n", | |
b5e89ed5 | 274 | context, _DRM_LOCKING_CONTEXT(old)); |
1da177e4 LT |
275 | return 1; |
276 | } | |
040ac320 | 277 | wake_up_interruptible(&lock_data->lock_queue); |
1da177e4 LT |
278 | return 0; |
279 | } | |
280 | ||
281 | /** | |
282 | * If we get here, it means that the process has called DRM_IOCTL_LOCK | |
283 | * without calling DRM_IOCTL_UNLOCK. | |
284 | * | |
285 | * If the lock is not held, then let the signal proceed as usual. If the lock | |
286 | * is held, then set the contended flag and keep the signal blocked. | |
287 | * | |
288 | * \param priv pointer to a drm_sigdata structure. | |
289 | * \return one if the signal should be delivered normally, or zero if the | |
290 | * signal should be blocked. | |
291 | */ | |
c94f7029 | 292 | static int drm_notifier(void *priv) |
1da177e4 | 293 | { |
55910517 | 294 | struct drm_sigdata *s = (struct drm_sigdata *) priv; |
b5e89ed5 | 295 | unsigned int old, new, prev; |
1da177e4 | 296 | |
b5e89ed5 | 297 | /* Allow signal delivery if lock isn't held */ |
1da177e4 | 298 | if (!s->lock || !_DRM_LOCK_IS_HELD(s->lock->lock) |
b5e89ed5 DA |
299 | || _DRM_LOCKING_CONTEXT(s->lock->lock) != s->context) |
300 | return 1; | |
1da177e4 | 301 | |
b5e89ed5 DA |
302 | /* Otherwise, set flag to force call to |
303 | drmUnlock */ | |
1da177e4 | 304 | do { |
b5e89ed5 DA |
305 | old = s->lock->lock; |
306 | new = old | _DRM_LOCK_CONT; | |
1da177e4 LT |
307 | prev = cmpxchg(&s->lock->lock, old, new); |
308 | } while (prev != old); | |
309 | return 0; | |
310 | } | |
040ac320 TH |
311 | |
312 | /** | |
313 | * This function returns immediately and takes the hw lock | |
314 | * with the kernel context if it is free, otherwise it gets the highest priority when and if | |
315 | * it is eventually released. | |
316 | * | |
317 | * This guarantees that the kernel will _eventually_ have the lock _unless_ it is held | |
318 | * by a blocked process. (In the latter case an explicit wait for the hardware lock would cause | |
319 | * a deadlock, which is why the "idlelock" was invented). | |
320 | * | |
321 | * This should be sufficient to wait for GPU idle without | |
322 | * having to worry about starvation. | |
323 | */ | |
324 | ||
55910517 | 325 | void drm_idlelock_take(struct drm_lock_data *lock_data) |
040ac320 | 326 | { |
4a1b0714 | 327 | int ret; |
040ac320 | 328 | |
f116cc56 | 329 | spin_lock_bh(&lock_data->spinlock); |
040ac320 TH |
330 | lock_data->kernel_waiters++; |
331 | if (!lock_data->idle_has_lock) { | |
332 | ||
f116cc56 | 333 | spin_unlock_bh(&lock_data->spinlock); |
040ac320 | 334 | ret = drm_lock_take(lock_data, DRM_KERNEL_CONTEXT); |
f116cc56 | 335 | spin_lock_bh(&lock_data->spinlock); |
040ac320 TH |
336 | |
337 | if (ret == 1) | |
338 | lock_data->idle_has_lock = 1; | |
339 | } | |
f116cc56 | 340 | spin_unlock_bh(&lock_data->spinlock); |
040ac320 | 341 | } |
5c2a5ce6 | 342 | EXPORT_SYMBOL(drm_idlelock_take); |
040ac320 | 343 | |
55910517 | 344 | void drm_idlelock_release(struct drm_lock_data *lock_data) |
040ac320 TH |
345 | { |
346 | unsigned int old, prev; | |
347 | volatile unsigned int *lock = &lock_data->hw_lock->lock; | |
348 | ||
f116cc56 | 349 | spin_lock_bh(&lock_data->spinlock); |
040ac320 TH |
350 | if (--lock_data->kernel_waiters == 0) { |
351 | if (lock_data->idle_has_lock) { | |
352 | do { | |
353 | old = *lock; | |
354 | prev = cmpxchg(lock, old, DRM_KERNEL_CONTEXT); | |
355 | } while (prev != old); | |
356 | wake_up_interruptible(&lock_data->lock_queue); | |
357 | lock_data->idle_has_lock = 0; | |
358 | } | |
359 | } | |
f116cc56 | 360 | spin_unlock_bh(&lock_data->spinlock); |
040ac320 | 361 | } |
5c2a5ce6 | 362 | EXPORT_SYMBOL(drm_idlelock_release); |
040ac320 | 363 | |
c153f45f | 364 | int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv) |
040ac320 | 365 | { |
7c1c2871 DA |
366 | struct drm_master *master = file_priv->master; |
367 | return (file_priv->lock_count && master->lock.hw_lock && | |
368 | _DRM_LOCK_IS_HELD(master->lock.hw_lock->lock) && | |
369 | master->lock.file_priv == file_priv); | |
040ac320 | 370 | } |