drm: updated DRM map patch for 32/64 bit systems
[linux-2.6.git] / drivers / char / drm / drm_context.c
1 /**
2  * \file drm_context.h 
3  * IOCTLs for generic contexts
4  * 
5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
6  * \author Gareth Hughes <gareth@valinux.com>
7  */
8
9 /*
10  * Created: Fri Nov 24 18:31:37 2000 by gareth@valinux.com
11  *
12  * Copyright 1999, 2000 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 /*
37  * ChangeLog:
38  *  2001-11-16  Torsten Duwe <duwe@caldera.de>
39  *              added context constructor/destructor hooks,
40  *              needed by SiS driver's memory management.
41  */
42
43 #include "drmP.h"
44
45 /******************************************************************/
46 /** \name Context bitmap support */
47 /*@{*/
48
49 /**
50  * Free a handle from the context bitmap.
51  *
52  * \param dev DRM device.
53  * \param ctx_handle context handle.
54  *
55  * Clears the bit specified by \p ctx_handle in drm_device::ctx_bitmap and the entry
56  * in drm_device::context_sareas, while holding the drm_device::struct_sem
57  * lock.
58  */
59 void drm_ctxbitmap_free( drm_device_t *dev, int ctx_handle )
60 {
61         if ( ctx_handle < 0 ) goto failed;
62         if ( !dev->ctx_bitmap ) goto failed;
63
64         if ( ctx_handle < DRM_MAX_CTXBITMAP ) {
65                 down(&dev->struct_sem);
66                 clear_bit( ctx_handle, dev->ctx_bitmap );
67                 dev->context_sareas[ctx_handle] = NULL;
68                 up(&dev->struct_sem);
69                 return;
70         }
71 failed:
72         DRM_ERROR( "Attempt to free invalid context handle: %d\n",
73                    ctx_handle );
74         return;
75 }
76
77 /** 
78  * Context bitmap allocation.
79  *
80  * \param dev DRM device.
81  * \return (non-negative) context handle on success or a negative number on failure.
82  *
83  * Find the first zero bit in drm_device::ctx_bitmap and (re)allocates
84  * drm_device::context_sareas to accommodate the new entry while holding the
85  * drm_device::struct_sem lock.
86  */
87 static int drm_ctxbitmap_next( drm_device_t *dev )
88 {
89         int bit;
90
91         if(!dev->ctx_bitmap) return -1;
92
93         down(&dev->struct_sem);
94         bit = find_first_zero_bit( dev->ctx_bitmap, DRM_MAX_CTXBITMAP );
95         if ( bit < DRM_MAX_CTXBITMAP ) {
96                 set_bit( bit, dev->ctx_bitmap );
97                 DRM_DEBUG( "drm_ctxbitmap_next bit : %d\n", bit );
98                 if((bit+1) > dev->max_context) {
99                         dev->max_context = (bit+1);
100                         if(dev->context_sareas) {
101                                 drm_map_t **ctx_sareas;
102
103                                 ctx_sareas = drm_realloc(dev->context_sareas,
104                                                 (dev->max_context - 1) * 
105                                                 sizeof(*dev->context_sareas),
106                                                 dev->max_context * 
107                                                 sizeof(*dev->context_sareas),
108                                                 DRM_MEM_MAPS);
109                                 if(!ctx_sareas) {
110                                         clear_bit(bit, dev->ctx_bitmap);
111                                         up(&dev->struct_sem);
112                                         return -1;
113                                 }
114                                 dev->context_sareas = ctx_sareas;
115                                 dev->context_sareas[bit] = NULL;
116                         } else {
117                                 /* max_context == 1 at this point */
118                                 dev->context_sareas = drm_alloc(
119                                                 dev->max_context * 
120                                                 sizeof(*dev->context_sareas),
121                                                 DRM_MEM_MAPS);
122                                 if(!dev->context_sareas) {
123                                         clear_bit(bit, dev->ctx_bitmap);
124                                         up(&dev->struct_sem);
125                                         return -1;
126                                 }
127                                 dev->context_sareas[bit] = NULL;
128                         }
129                 }
130                 up(&dev->struct_sem);
131                 return bit;
132         }
133         up(&dev->struct_sem);
134         return -1;
135 }
136
137 /**
138  * Context bitmap initialization.
139  *
140  * \param dev DRM device.
141  *
142  * Allocates and initialize drm_device::ctx_bitmap and drm_device::context_sareas, while holding
143  * the drm_device::struct_sem lock.
144  */
145 int drm_ctxbitmap_init( drm_device_t *dev )
146 {
147         int i;
148         int temp;
149
150         down(&dev->struct_sem);
151         dev->ctx_bitmap = (unsigned long *) drm_alloc( PAGE_SIZE,
152                                                         DRM_MEM_CTXBITMAP );
153         if ( dev->ctx_bitmap == NULL ) {
154                 up(&dev->struct_sem);
155                 return -ENOMEM;
156         }
157         memset( (void *)dev->ctx_bitmap, 0, PAGE_SIZE );
158         dev->context_sareas = NULL;
159         dev->max_context = -1;
160         up(&dev->struct_sem);
161
162         for ( i = 0 ; i < DRM_RESERVED_CONTEXTS ; i++ ) {
163                 temp = drm_ctxbitmap_next( dev );
164                 DRM_DEBUG( "drm_ctxbitmap_init : %d\n", temp );
165         }
166
167         return 0;
168 }
169
170 /**
171  * Context bitmap cleanup.
172  *
173  * \param dev DRM device.
174  *
175  * Frees drm_device::ctx_bitmap and drm_device::context_sareas, while holding
176  * the drm_device::struct_sem lock.
177  */
178 void drm_ctxbitmap_cleanup( drm_device_t *dev )
179 {
180         down(&dev->struct_sem);
181         if( dev->context_sareas ) drm_free( dev->context_sareas,
182                                              sizeof(*dev->context_sareas) * 
183                                              dev->max_context,
184                                              DRM_MEM_MAPS );
185         drm_free( (void *)dev->ctx_bitmap, PAGE_SIZE, DRM_MEM_CTXBITMAP );
186         up(&dev->struct_sem);
187 }
188
189 /*@}*/
190
191 /******************************************************************/
192 /** \name Per Context SAREA Support */
193 /*@{*/
194
195 /**
196  * Get per-context SAREA.
197  * 
198  * \param inode device inode.
199  * \param filp file pointer.
200  * \param cmd command.
201  * \param arg user argument pointing to a drm_ctx_priv_map structure.
202  * \return zero on success or a negative number on failure.
203  *
204  * Gets the map from drm_device::context_sareas with the handle specified and
205  * returns its handle.
206  */
207 int drm_getsareactx(struct inode *inode, struct file *filp,
208                      unsigned int cmd, unsigned long arg)
209 {
210         drm_file_t      *priv   = filp->private_data;
211         drm_device_t    *dev    = priv->head->dev;
212         drm_ctx_priv_map_t __user *argp = (void __user *)arg;
213         drm_ctx_priv_map_t request;
214         drm_map_t *map;
215         drm_map_list_t *_entry;
216
217         if (copy_from_user(&request, argp, sizeof(request)))
218                 return -EFAULT;
219
220         down(&dev->struct_sem);
221         if (dev->max_context < 0 || request.ctx_id >= (unsigned) dev->max_context) {
222                 up(&dev->struct_sem);
223                 return -EINVAL;
224         }
225
226         map = dev->context_sareas[request.ctx_id];
227         up(&dev->struct_sem);
228
229         request.handle = 0;
230         list_for_each_entry(_entry, &dev->maplist->head,head) {
231                 if (_entry->map == map) {
232                         request.handle = (void *)(unsigned long)_entry->user_token;
233                         break;
234                 }
235         }
236         if (request.handle == 0)
237                 return -EINVAL;
238
239
240         if (copy_to_user(argp, &request, sizeof(request)))
241                 return -EFAULT;
242         return 0;
243 }
244
245 /**
246  * Set per-context SAREA.
247  * 
248  * \param inode device inode.
249  * \param filp file pointer.
250  * \param cmd command.
251  * \param arg user argument pointing to a drm_ctx_priv_map structure.
252  * \return zero on success or a negative number on failure.
253  *
254  * Searches the mapping specified in \p arg and update the entry in
255  * drm_device::context_sareas with it.
256  */
257 int drm_setsareactx(struct inode *inode, struct file *filp,
258                      unsigned int cmd, unsigned long arg)
259 {
260         drm_file_t      *priv   = filp->private_data;
261         drm_device_t    *dev    = priv->head->dev;
262         drm_ctx_priv_map_t request;
263         drm_map_t *map = NULL;
264         drm_map_list_t *r_list = NULL;
265         struct list_head *list;
266
267         if (copy_from_user(&request,
268                            (drm_ctx_priv_map_t __user *)arg,
269                            sizeof(request)))
270                 return -EFAULT;
271
272         down(&dev->struct_sem);
273         list_for_each(list, &dev->maplist->head) {
274                 r_list = list_entry(list, drm_map_list_t, head);
275                 if (r_list->map
276                     && r_list->user_token == (unsigned long) request.handle)
277                         goto found;
278         }
279 bad:
280         up(&dev->struct_sem);
281         return -EINVAL;
282
283 found:
284         map = r_list->map;
285         if (!map) goto bad;
286         if (dev->max_context < 0)
287                 goto bad;
288         if (request.ctx_id >= (unsigned) dev->max_context)
289                 goto bad;
290         dev->context_sareas[request.ctx_id] = map;
291         up(&dev->struct_sem);
292         return 0;
293 }
294
295 /*@}*/
296
297 /******************************************************************/
298 /** \name The actual DRM context handling routines */
299 /*@{*/
300
301 /**
302  * Switch context.
303  *
304  * \param dev DRM device.
305  * \param old old context handle.
306  * \param new new context handle.
307  * \return zero on success or a negative number on failure.
308  *
309  * Attempt to set drm_device::context_flag.
310  */
311 int drm_context_switch( drm_device_t *dev, int old, int new )
312 {
313         if ( test_and_set_bit( 0, &dev->context_flag ) ) {
314                 DRM_ERROR( "Reentering -- FIXME\n" );
315                 return -EBUSY;
316         }
317
318
319         DRM_DEBUG( "Context switch from %d to %d\n", old, new );
320
321         if ( new == dev->last_context ) {
322                 clear_bit( 0, &dev->context_flag );
323                 return 0;
324         }
325
326         return 0;
327 }
328
329 /**
330  * Complete context switch.
331  *
332  * \param dev DRM device.
333  * \param new new context handle.
334  * \return zero on success or a negative number on failure.
335  *
336  * Updates drm_device::last_context and drm_device::last_switch. Verifies the
337  * hardware lock is held, clears the drm_device::context_flag and wakes up
338  * drm_device::context_wait.
339  */
340 static int drm_context_switch_complete( drm_device_t *dev, int new )
341 {
342         dev->last_context = new;  /* PRE/POST: This is the _only_ writer. */
343         dev->last_switch  = jiffies;
344
345         if ( !_DRM_LOCK_IS_HELD(dev->lock.hw_lock->lock) ) {
346                 DRM_ERROR( "Lock isn't held after context switch\n" );
347         }
348
349                                 /* If a context switch is ever initiated
350                                    when the kernel holds the lock, release
351                                    that lock here. */
352         clear_bit( 0, &dev->context_flag );
353         wake_up( &dev->context_wait );
354
355         return 0;
356 }
357
358 /**
359  * Reserve contexts.
360  *
361  * \param inode device inode.
362  * \param filp file pointer.
363  * \param cmd command.
364  * \param arg user argument pointing to a drm_ctx_res structure.
365  * \return zero on success or a negative number on failure.
366  */
367 int drm_resctx( struct inode *inode, struct file *filp,
368                  unsigned int cmd, unsigned long arg )
369 {
370         drm_ctx_res_t res;
371         drm_ctx_t __user *argp = (void __user *)arg;
372         drm_ctx_t ctx;
373         int i;
374
375         if ( copy_from_user( &res, argp, sizeof(res) ) )
376                 return -EFAULT;
377
378         if ( res.count >= DRM_RESERVED_CONTEXTS ) {
379                 memset( &ctx, 0, sizeof(ctx) );
380                 for ( i = 0 ; i < DRM_RESERVED_CONTEXTS ; i++ ) {
381                         ctx.handle = i;
382                         if ( copy_to_user( &res.contexts[i],
383                                            &ctx, sizeof(ctx) ) )
384                                 return -EFAULT;
385                 }
386         }
387         res.count = DRM_RESERVED_CONTEXTS;
388
389         if ( copy_to_user( argp, &res, sizeof(res) ) )
390                 return -EFAULT;
391         return 0;
392 }
393
394 /**
395  * Add context.
396  *
397  * \param inode device inode.
398  * \param filp file pointer.
399  * \param cmd command.
400  * \param arg user argument pointing to a drm_ctx structure.
401  * \return zero on success or a negative number on failure.
402  *
403  * Get a new handle for the context and copy to userspace.
404  */
405 int drm_addctx( struct inode *inode, struct file *filp,
406                  unsigned int cmd, unsigned long arg )
407 {
408         drm_file_t *priv = filp->private_data;
409         drm_device_t *dev = priv->head->dev;
410         drm_ctx_list_t * ctx_entry;
411         drm_ctx_t __user *argp = (void __user *)arg;
412         drm_ctx_t ctx;
413
414         if ( copy_from_user( &ctx, argp, sizeof(ctx) ) )
415                 return -EFAULT;
416
417         ctx.handle = drm_ctxbitmap_next( dev );
418         if ( ctx.handle == DRM_KERNEL_CONTEXT ) {
419                                 /* Skip kernel's context and get a new one. */
420                 ctx.handle = drm_ctxbitmap_next( dev );
421         }
422         DRM_DEBUG( "%d\n", ctx.handle );
423         if ( ctx.handle == -1 ) {
424                 DRM_DEBUG( "Not enough free contexts.\n" );
425                                 /* Should this return -EBUSY instead? */
426                 return -ENOMEM;
427         }
428
429         if ( ctx.handle != DRM_KERNEL_CONTEXT )
430         {
431                 if (dev->driver->context_ctor)
432                         dev->driver->context_ctor(dev, ctx.handle);
433         }
434
435         ctx_entry = drm_alloc( sizeof(*ctx_entry), DRM_MEM_CTXLIST );
436         if ( !ctx_entry ) {
437                 DRM_DEBUG("out of memory\n");
438                 return -ENOMEM;
439         }
440
441         INIT_LIST_HEAD( &ctx_entry->head );
442         ctx_entry->handle = ctx.handle;
443         ctx_entry->tag = priv;
444
445         down( &dev->ctxlist_sem );
446         list_add( &ctx_entry->head, &dev->ctxlist->head );
447         ++dev->ctx_count;
448         up( &dev->ctxlist_sem );
449
450         if ( copy_to_user( argp, &ctx, sizeof(ctx) ) )
451                 return -EFAULT;
452         return 0;
453 }
454
455 int drm_modctx( struct inode *inode, struct file *filp,
456                  unsigned int cmd, unsigned long arg )
457 {
458         /* This does nothing */
459         return 0;
460 }
461
462 /**
463  * Get context.
464  *
465  * \param inode device inode.
466  * \param filp file pointer.
467  * \param cmd command.
468  * \param arg user argument pointing to a drm_ctx structure.
469  * \return zero on success or a negative number on failure.
470  */
471 int drm_getctx( struct inode *inode, struct file *filp,
472                  unsigned int cmd, unsigned long arg )
473 {
474         drm_ctx_t __user *argp = (void __user *)arg;
475         drm_ctx_t ctx;
476
477         if ( copy_from_user( &ctx, argp, sizeof(ctx) ) )
478                 return -EFAULT;
479
480         /* This is 0, because we don't handle any context flags */
481         ctx.flags = 0;
482
483         if ( copy_to_user( argp, &ctx, sizeof(ctx) ) )
484                 return -EFAULT;
485         return 0;
486 }
487
488 /**
489  * Switch context.
490  *
491  * \param inode device inode.
492  * \param filp file pointer.
493  * \param cmd command.
494  * \param arg user argument pointing to a drm_ctx structure.
495  * \return zero on success or a negative number on failure.
496  *
497  * Calls context_switch().
498  */
499 int drm_switchctx( struct inode *inode, struct file *filp,
500                     unsigned int cmd, unsigned long arg )
501 {
502         drm_file_t *priv = filp->private_data;
503         drm_device_t *dev = priv->head->dev;
504         drm_ctx_t ctx;
505
506         if ( copy_from_user( &ctx, (drm_ctx_t __user *)arg, sizeof(ctx) ) )
507                 return -EFAULT;
508
509         DRM_DEBUG( "%d\n", ctx.handle );
510         return drm_context_switch( dev, dev->last_context, ctx.handle );
511 }
512
513 /**
514  * New context.
515  *
516  * \param inode device inode.
517  * \param filp file pointer.
518  * \param cmd command.
519  * \param arg user argument pointing to a drm_ctx structure.
520  * \return zero on success or a negative number on failure.
521  *
522  * Calls context_switch_complete().
523  */
524 int drm_newctx( struct inode *inode, struct file *filp,
525                  unsigned int cmd, unsigned long arg )
526 {
527         drm_file_t *priv = filp->private_data;
528         drm_device_t *dev = priv->head->dev;
529         drm_ctx_t ctx;
530
531         if ( copy_from_user( &ctx, (drm_ctx_t __user *)arg, sizeof(ctx) ) )
532                 return -EFAULT;
533
534         DRM_DEBUG( "%d\n", ctx.handle );
535         drm_context_switch_complete( dev, ctx.handle );
536
537         return 0;
538 }
539
540 /**
541  * Remove context.
542  *
543  * \param inode device inode.
544  * \param filp file pointer.
545  * \param cmd command.
546  * \param arg user argument pointing to a drm_ctx structure.
547  * \return zero on success or a negative number on failure.
548  *
549  * If not the special kernel context, calls ctxbitmap_free() to free the specified context.
550  */
551 int drm_rmctx( struct inode *inode, struct file *filp,
552                 unsigned int cmd, unsigned long arg )
553 {
554         drm_file_t *priv = filp->private_data;
555         drm_device_t *dev = priv->head->dev;
556         drm_ctx_t ctx;
557
558         if ( copy_from_user( &ctx, (drm_ctx_t __user *)arg, sizeof(ctx) ) )
559                 return -EFAULT;
560
561         DRM_DEBUG( "%d\n", ctx.handle );
562         if ( ctx.handle == DRM_KERNEL_CONTEXT + 1 ) {
563                 priv->remove_auth_on_close = 1;
564         }
565         if ( ctx.handle != DRM_KERNEL_CONTEXT ) {
566                 if (dev->driver->context_dtor)
567                         dev->driver->context_dtor(dev, ctx.handle);
568                 drm_ctxbitmap_free( dev, ctx.handle );
569         }
570
571         down( &dev->ctxlist_sem );
572         if ( !list_empty( &dev->ctxlist->head ) ) {
573                 drm_ctx_list_t *pos, *n;
574
575                 list_for_each_entry_safe( pos, n, &dev->ctxlist->head, head ) {
576                         if ( pos->handle == ctx.handle ) {
577                                 list_del( &pos->head );
578                                 drm_free( pos, sizeof(*pos), DRM_MEM_CTXLIST );
579                                 --dev->ctx_count;
580                         }
581                 }
582         }
583         up( &dev->ctxlist_sem );
584
585         return 0;
586 }
587
588 /*@}*/
589