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 | ||
36 | #include "drmP.h" | |
37 | ||
c94f7029 DA |
38 | static int drm_notifier(void *priv); |
39 | ||
b5e89ed5 | 40 | /** |
1da177e4 LT |
41 | * Lock ioctl. |
42 | * | |
43 | * \param inode device inode. | |
6c340eac | 44 | * \param file_priv DRM file private. |
1da177e4 LT |
45 | * \param cmd command. |
46 | * \param arg user argument, pointing to a drm_lock structure. | |
47 | * \return zero on success or negative number on failure. | |
48 | * | |
49 | * Add the current task to the lock wait queue, and attempt to take to lock. | |
50 | */ | |
c153f45f | 51 | int drm_lock(struct drm_device *dev, void *data, struct drm_file *file_priv) |
1da177e4 | 52 | { |
b5e89ed5 | 53 | DECLARE_WAITQUEUE(entry, current); |
c153f45f | 54 | struct drm_lock *lock = data; |
7c1c2871 | 55 | struct drm_master *master = file_priv->master; |
b5e89ed5 | 56 | int ret = 0; |
1da177e4 | 57 | |
6c340eac | 58 | ++file_priv->lock_count; |
1da177e4 | 59 | |
c153f45f | 60 | if (lock->context == DRM_KERNEL_CONTEXT) { |
b5e89ed5 | 61 | DRM_ERROR("Process %d using kernel context %d\n", |
ba25f9dc | 62 | task_pid_nr(current), lock->context); |
b5e89ed5 DA |
63 | return -EINVAL; |
64 | } | |
1da177e4 | 65 | |
b5e89ed5 | 66 | DRM_DEBUG("%d (pid %d) requests lock (0x%08x), flags = 0x%08x\n", |
ba25f9dc | 67 | lock->context, task_pid_nr(current), |
7c1c2871 | 68 | master->lock.hw_lock->lock, lock->flags); |
1da177e4 LT |
69 | |
70 | if (drm_core_check_feature(dev, DRIVER_DMA_QUEUE)) | |
c153f45f | 71 | if (lock->context < 0) |
1da177e4 LT |
72 | return -EINVAL; |
73 | ||
7c1c2871 DA |
74 | add_wait_queue(&master->lock.lock_queue, &entry); |
75 | spin_lock_bh(&master->lock.spinlock); | |
76 | master->lock.user_waiters++; | |
77 | spin_unlock_bh(&master->lock.spinlock); | |
78 | ||
1da177e4 LT |
79 | for (;;) { |
80 | __set_current_state(TASK_INTERRUPTIBLE); | |
7c1c2871 | 81 | if (!master->lock.hw_lock) { |
1da177e4 LT |
82 | /* Device has been unregistered */ |
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 DA |
89 | atomic_inc(&dev->counts[_DRM_STAT_LOCKS]); |
90 | break; /* Got lock */ | |
1da177e4 | 91 | } |
b5e89ed5 | 92 | |
1da177e4 LT |
93 | /* Contention */ |
94 | schedule(); | |
b5e89ed5 | 95 | if (signal_pending(current)) { |
1da177e4 LT |
96 | ret = -ERESTARTSYS; |
97 | break; | |
98 | } | |
99 | } | |
7c1c2871 DA |
100 | spin_lock_bh(&master->lock.spinlock); |
101 | master->lock.user_waiters--; | |
102 | spin_unlock_bh(&master->lock.spinlock); | |
1da177e4 | 103 | __set_current_state(TASK_RUNNING); |
7c1c2871 | 104 | remove_wait_queue(&master->lock.lock_queue, &entry); |
1da177e4 | 105 | |
c153f45f EA |
106 | DRM_DEBUG("%d %s\n", lock->context, |
107 | ret ? "interrupted" : "has lock"); | |
040ac320 | 108 | if (ret) return ret; |
d985c108 | 109 | |
3e5fc80a DA |
110 | /* don't set the block all signals on the master process for now |
111 | * really probably not the correct answer but lets us debug xkb | |
112 | * xserver for now */ | |
7c1c2871 | 113 | if (!file_priv->is_master) { |
3e5fc80a DA |
114 | sigemptyset(&dev->sigmask); |
115 | sigaddset(&dev->sigmask, SIGSTOP); | |
116 | sigaddset(&dev->sigmask, SIGTSTP); | |
117 | sigaddset(&dev->sigmask, SIGTTIN); | |
118 | sigaddset(&dev->sigmask, SIGTTOU); | |
119 | dev->sigdata.context = lock->context; | |
7c1c2871 | 120 | dev->sigdata.lock = master->lock.hw_lock; |
3e5fc80a DA |
121 | block_all_signals(drm_notifier, &dev->sigdata, &dev->sigmask); |
122 | } | |
b5e89ed5 | 123 | |
c153f45f | 124 | if (dev->driver->dma_ready && (lock->flags & _DRM_LOCK_READY)) |
1da177e4 | 125 | dev->driver->dma_ready(dev); |
b5e89ed5 | 126 | |
c153f45f EA |
127 | if (dev->driver->dma_quiescent && (lock->flags & _DRM_LOCK_QUIESCENT)) |
128 | { | |
d985c108 | 129 | if (dev->driver->dma_quiescent(dev)) { |
c153f45f EA |
130 | DRM_DEBUG("%d waiting for DMA quiescent\n", |
131 | lock->context); | |
20caafa6 | 132 | return -EBUSY; |
d985c108 DA |
133 | } |
134 | } | |
b5e89ed5 DA |
135 | |
136 | if (dev->driver->kernel_context_switch && | |
c153f45f | 137 | dev->last_context != lock->context) { |
b5e89ed5 | 138 | dev->driver->kernel_context_switch(dev, dev->last_context, |
c153f45f | 139 | lock->context); |
1da177e4 | 140 | } |
040ac320 | 141 | |
d985c108 | 142 | return 0; |
1da177e4 LT |
143 | } |
144 | ||
b5e89ed5 | 145 | /** |
1da177e4 LT |
146 | * Unlock ioctl. |
147 | * | |
148 | * \param inode device inode. | |
6c340eac | 149 | * \param file_priv DRM file private. |
1da177e4 LT |
150 | * \param cmd command. |
151 | * \param arg user argument, pointing to a drm_lock structure. | |
152 | * \return zero on success or negative number on failure. | |
153 | * | |
154 | * Transfer and free the lock. | |
155 | */ | |
c153f45f | 156 | int drm_unlock(struct drm_device *dev, void *data, struct drm_file *file_priv) |
1da177e4 | 157 | { |
c153f45f | 158 | struct drm_lock *lock = data; |
7c1c2871 | 159 | struct drm_master *master = file_priv->master; |
1da177e4 | 160 | |
c153f45f | 161 | if (lock->context == DRM_KERNEL_CONTEXT) { |
b5e89ed5 | 162 | DRM_ERROR("Process %d using kernel context %d\n", |
ba25f9dc | 163 | task_pid_nr(current), lock->context); |
1da177e4 LT |
164 | return -EINVAL; |
165 | } | |
166 | ||
b5e89ed5 | 167 | atomic_inc(&dev->counts[_DRM_STAT_UNLOCKS]); |
1da177e4 LT |
168 | |
169 | /* kernel_context_switch isn't used by any of the x86 drm | |
170 | * modules but is required by the Sparc driver. | |
171 | */ | |
172 | if (dev->driver->kernel_context_switch_unlock) | |
0c4dd906 | 173 | dev->driver->kernel_context_switch_unlock(dev); |
1da177e4 | 174 | else { |
7c1c2871 | 175 | if (drm_lock_free(&master->lock, lock->context)) { |
040ac320 | 176 | /* FIXME: Should really bail out here. */ |
1da177e4 LT |
177 | } |
178 | } | |
179 | ||
180 | unblock_all_signals(); | |
181 | return 0; | |
182 | } | |
183 | ||
184 | /** | |
185 | * Take the heavyweight lock. | |
186 | * | |
187 | * \param lock lock pointer. | |
188 | * \param context locking context. | |
189 | * \return one if the lock is held, or zero otherwise. | |
190 | * | |
191 | * Attempt to mark the lock as held by the given context, via the \p cmpxchg instruction. | |
192 | */ | |
55910517 | 193 | int drm_lock_take(struct drm_lock_data *lock_data, |
040ac320 | 194 | unsigned int context) |
1da177e4 LT |
195 | { |
196 | unsigned int old, new, prev; | |
040ac320 | 197 | volatile unsigned int *lock = &lock_data->hw_lock->lock; |
1da177e4 | 198 | |
f116cc56 | 199 | spin_lock_bh(&lock_data->spinlock); |
1da177e4 LT |
200 | do { |
201 | old = *lock; | |
b5e89ed5 DA |
202 | if (old & _DRM_LOCK_HELD) |
203 | new = old | _DRM_LOCK_CONT; | |
040ac320 TH |
204 | else { |
205 | new = context | _DRM_LOCK_HELD | | |
206 | ((lock_data->user_waiters + lock_data->kernel_waiters > 1) ? | |
207 | _DRM_LOCK_CONT : 0); | |
208 | } | |
1da177e4 LT |
209 | prev = cmpxchg(lock, old, new); |
210 | } while (prev != old); | |
f116cc56 | 211 | spin_unlock_bh(&lock_data->spinlock); |
040ac320 | 212 | |
1da177e4 LT |
213 | if (_DRM_LOCKING_CONTEXT(old) == context) { |
214 | if (old & _DRM_LOCK_HELD) { | |
215 | if (context != DRM_KERNEL_CONTEXT) { | |
216 | DRM_ERROR("%d holds heavyweight lock\n", | |
217 | context); | |
218 | } | |
219 | return 0; | |
220 | } | |
221 | } | |
040ac320 TH |
222 | |
223 | if ((_DRM_LOCKING_CONTEXT(new)) == context && (new & _DRM_LOCK_HELD)) { | |
b5e89ed5 | 224 | /* Have lock */ |
1da177e4 LT |
225 | return 1; |
226 | } | |
227 | return 0; | |
228 | } | |
9e44af79 | 229 | EXPORT_SYMBOL(drm_lock_take); |
1da177e4 LT |
230 | |
231 | /** | |
232 | * This takes a lock forcibly and hands it to context. Should ONLY be used | |
b5e89ed5 DA |
233 | * inside *_unlock to give lock to kernel before calling *_dma_schedule. |
234 | * | |
1da177e4 LT |
235 | * \param dev DRM device. |
236 | * \param lock lock pointer. | |
237 | * \param context locking context. | |
238 | * \return always one. | |
239 | * | |
240 | * Resets the lock file pointer. | |
241 | * Marks the lock as held by the given context, via the \p cmpxchg instruction. | |
242 | */ | |
55910517 | 243 | static int drm_lock_transfer(struct drm_lock_data *lock_data, |
c94f7029 | 244 | unsigned int context) |
1da177e4 LT |
245 | { |
246 | unsigned int old, new, prev; | |
040ac320 | 247 | volatile unsigned int *lock = &lock_data->hw_lock->lock; |
1da177e4 | 248 | |
6c340eac | 249 | lock_data->file_priv = NULL; |
1da177e4 | 250 | do { |
b5e89ed5 DA |
251 | old = *lock; |
252 | new = context | _DRM_LOCK_HELD; | |
1da177e4 LT |
253 | prev = cmpxchg(lock, old, new); |
254 | } while (prev != old); | |
255 | return 1; | |
256 | } | |
257 | ||
258 | /** | |
259 | * Free lock. | |
b5e89ed5 | 260 | * |
1da177e4 LT |
261 | * \param dev DRM device. |
262 | * \param lock lock. | |
263 | * \param context context. | |
b5e89ed5 | 264 | * |
1da177e4 LT |
265 | * Resets the lock file pointer. |
266 | * Marks the lock as not held, via the \p cmpxchg instruction. Wakes any task | |
267 | * waiting on the lock queue. | |
268 | */ | |
55910517 | 269 | int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context) |
1da177e4 LT |
270 | { |
271 | unsigned int old, new, prev; | |
040ac320 TH |
272 | volatile unsigned int *lock = &lock_data->hw_lock->lock; |
273 | ||
f116cc56 | 274 | spin_lock_bh(&lock_data->spinlock); |
040ac320 TH |
275 | if (lock_data->kernel_waiters != 0) { |
276 | drm_lock_transfer(lock_data, 0); | |
277 | lock_data->idle_has_lock = 1; | |
f116cc56 | 278 | spin_unlock_bh(&lock_data->spinlock); |
040ac320 TH |
279 | return 1; |
280 | } | |
f116cc56 | 281 | spin_unlock_bh(&lock_data->spinlock); |
1da177e4 | 282 | |
1da177e4 | 283 | do { |
b5e89ed5 | 284 | old = *lock; |
040ac320 | 285 | new = _DRM_LOCKING_CONTEXT(old); |
1da177e4 LT |
286 | prev = cmpxchg(lock, old, new); |
287 | } while (prev != old); | |
040ac320 | 288 | |
1da177e4 LT |
289 | if (_DRM_LOCK_IS_HELD(old) && _DRM_LOCKING_CONTEXT(old) != context) { |
290 | DRM_ERROR("%d freed heavyweight lock held by %d\n", | |
b5e89ed5 | 291 | context, _DRM_LOCKING_CONTEXT(old)); |
1da177e4 LT |
292 | return 1; |
293 | } | |
040ac320 | 294 | wake_up_interruptible(&lock_data->lock_queue); |
1da177e4 LT |
295 | return 0; |
296 | } | |
9e44af79 | 297 | EXPORT_SYMBOL(drm_lock_free); |
1da177e4 LT |
298 | |
299 | /** | |
300 | * If we get here, it means that the process has called DRM_IOCTL_LOCK | |
301 | * without calling DRM_IOCTL_UNLOCK. | |
302 | * | |
303 | * If the lock is not held, then let the signal proceed as usual. If the lock | |
304 | * is held, then set the contended flag and keep the signal blocked. | |
305 | * | |
306 | * \param priv pointer to a drm_sigdata structure. | |
307 | * \return one if the signal should be delivered normally, or zero if the | |
308 | * signal should be blocked. | |
309 | */ | |
c94f7029 | 310 | static int drm_notifier(void *priv) |
1da177e4 | 311 | { |
55910517 | 312 | struct drm_sigdata *s = (struct drm_sigdata *) priv; |
b5e89ed5 | 313 | unsigned int old, new, prev; |
1da177e4 | 314 | |
b5e89ed5 | 315 | /* Allow signal delivery if lock isn't held */ |
1da177e4 | 316 | if (!s->lock || !_DRM_LOCK_IS_HELD(s->lock->lock) |
b5e89ed5 DA |
317 | || _DRM_LOCKING_CONTEXT(s->lock->lock) != s->context) |
318 | return 1; | |
1da177e4 | 319 | |
b5e89ed5 DA |
320 | /* Otherwise, set flag to force call to |
321 | drmUnlock */ | |
1da177e4 | 322 | do { |
b5e89ed5 DA |
323 | old = s->lock->lock; |
324 | new = old | _DRM_LOCK_CONT; | |
1da177e4 LT |
325 | prev = cmpxchg(&s->lock->lock, old, new); |
326 | } while (prev != old); | |
327 | return 0; | |
328 | } | |
040ac320 TH |
329 | |
330 | /** | |
331 | * This function returns immediately and takes the hw lock | |
332 | * with the kernel context if it is free, otherwise it gets the highest priority when and if | |
333 | * it is eventually released. | |
334 | * | |
335 | * This guarantees that the kernel will _eventually_ have the lock _unless_ it is held | |
336 | * by a blocked process. (In the latter case an explicit wait for the hardware lock would cause | |
337 | * a deadlock, which is why the "idlelock" was invented). | |
338 | * | |
339 | * This should be sufficient to wait for GPU idle without | |
340 | * having to worry about starvation. | |
341 | */ | |
342 | ||
55910517 | 343 | void drm_idlelock_take(struct drm_lock_data *lock_data) |
040ac320 TH |
344 | { |
345 | int ret = 0; | |
346 | ||
f116cc56 | 347 | spin_lock_bh(&lock_data->spinlock); |
040ac320 TH |
348 | lock_data->kernel_waiters++; |
349 | if (!lock_data->idle_has_lock) { | |
350 | ||
f116cc56 | 351 | spin_unlock_bh(&lock_data->spinlock); |
040ac320 | 352 | ret = drm_lock_take(lock_data, DRM_KERNEL_CONTEXT); |
f116cc56 | 353 | spin_lock_bh(&lock_data->spinlock); |
040ac320 TH |
354 | |
355 | if (ret == 1) | |
356 | lock_data->idle_has_lock = 1; | |
357 | } | |
f116cc56 | 358 | spin_unlock_bh(&lock_data->spinlock); |
040ac320 TH |
359 | } |
360 | EXPORT_SYMBOL(drm_idlelock_take); | |
361 | ||
55910517 | 362 | void drm_idlelock_release(struct drm_lock_data *lock_data) |
040ac320 TH |
363 | { |
364 | unsigned int old, prev; | |
365 | volatile unsigned int *lock = &lock_data->hw_lock->lock; | |
366 | ||
f116cc56 | 367 | spin_lock_bh(&lock_data->spinlock); |
040ac320 TH |
368 | if (--lock_data->kernel_waiters == 0) { |
369 | if (lock_data->idle_has_lock) { | |
370 | do { | |
371 | old = *lock; | |
372 | prev = cmpxchg(lock, old, DRM_KERNEL_CONTEXT); | |
373 | } while (prev != old); | |
374 | wake_up_interruptible(&lock_data->lock_queue); | |
375 | lock_data->idle_has_lock = 0; | |
376 | } | |
377 | } | |
f116cc56 | 378 | spin_unlock_bh(&lock_data->spinlock); |
040ac320 TH |
379 | } |
380 | EXPORT_SYMBOL(drm_idlelock_release); | |
381 | ||
382 | ||
c153f45f | 383 | int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv) |
040ac320 | 384 | { |
7c1c2871 DA |
385 | struct drm_master *master = file_priv->master; |
386 | return (file_priv->lock_count && master->lock.hw_lock && | |
387 | _DRM_LOCK_IS_HELD(master->lock.hw_lock->lock) && | |
388 | master->lock.file_priv == file_priv); | |
040ac320 TH |
389 | } |
390 | ||
391 | EXPORT_SYMBOL(drm_i_have_hw_lock); |