Home | History | Annotate | Line # | Download | only in bsd-core 
      1 /**************************************************************************
      2  *
      3  * Copyright 2006 Tungsten Graphics, Inc., Bismarck, ND., USA.
      4  * All Rights Reserved.
      5  *
      6  * Permission is hereby granted, free of charge, to any person obtaining a
      7  * copy of this software and associated documentation files (the
      8  * "Software"), to deal in the Software without restriction, including
      9  * without limitation the rights to use, copy, modify, merge, publish,
     10  * distribute, sub license, and/or sell copies of the Software, and to
     11  * permit persons to whom the Software is furnished to do so, subject to
     12  * the following conditions:
     13  *
     14  * The above copyright notice and this permission notice (including the
     15  * next paragraph) shall be included in all copies or substantial portions
     16  * of the Software.
     17  *
     18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
     21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
     22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
     23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
     24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
     25  *
     26  *
     27  **************************************************************************/
     28 
     29 /*
     30  * Simple memory MANager interface that keeps track on allocate regions on a
     31  * per "owner" basis. All regions associated with an "owner" can be released
     32  * with a simple call. Typically if the "owner" exists. The owner is any
     33  * "unsigned long" identifier. Can typically be a pointer to a file private
     34  * struct or a context identifier.
     35  *
     36  * Authors:
     37  * Thomas Hellstrm <thomas-at-tungstengraphics-dot-com>
     38  */
     39 
     40 #ifndef DRM_SMAN_H
     41 #define DRM_SMAN_H
     42 
     43 #include "drm_hashtab.h"
     44 #include "drm_linux_list.h"
     45 #include "drm_mm.h"
     46 
     47 /*
     48  * A class that is an abstration of a simple memory allocator.
     49  * The sman implementation provides a default such allocator
     50  * using the drm_mm.c implementation. But the user can replace it.
     51  * See the SiS implementation, which may use the SiS FB kernel module
     52  * for memory management.
     53  */
     54 
     55 struct drm_sman_mm {
     56 	/* private info. If allocated, needs to be destroyed by the destroy
     57 	   function */
     58 	void *private;
     59 
     60 	/* Allocate a memory block with given size and alignment.
     61 	   Return an opaque reference to the memory block */
     62 
     63 	void *(*allocate) (void *private, unsigned long size,
     64 			   unsigned alignment);
     65 
     66 	/* Free a memory block. "ref" is the opaque reference that we got from
     67 	   the "alloc" function */
     68 
     69 	void (*freem) (void *private, void *ref);
     70 
     71 	/* Free all resources associated with this allocator */
     72 
     73 	void (*destroy) (void *private);
     74 
     75 	/* Return a memory offset from the opaque reference returned from the
     76 	   "alloc" function */
     77 
     78 	unsigned long (*offset) (void *private, void *ref);
     79 };
     80 
     81 struct drm_memblock_item {
     82 	struct list_head owner_list;
     83 	struct drm_hash_item user_hash;
     84 	void *mm_info;
     85 	struct drm_sman_mm *mm;
     86 	struct drm_sman *sman;
     87 };
     88 
     89 struct drm_sman {
     90 	struct drm_sman_mm *mm;
     91 	int num_managers;
     92 	struct drm_open_hash owner_hash_tab;
     93 	struct drm_open_hash user_hash_tab;
     94 	struct list_head owner_items;
     95 };
     96 
     97 /*
     98  * Take down a memory manager. This function should only be called after a
     99  * successful init and after a call to drm_sman_cleanup.
    100  */
    101 
    102 extern void drm_sman_takedown(struct drm_sman * sman);
    103 
    104 /*
    105  * Allocate structures for a manager.
    106  * num_managers are the number of memory pools to manage. (VRAM, AGP, ....)
    107  * user_order is the log2 of the number of buckets in the user hash table.
    108  *	    set this to approximately log2 of the max number of memory regions
    109  *	    that will be allocated for _all_ pools together.
    110  * owner_order is the log2 of the number of buckets in the owner hash table.
    111  *	    set this to approximately log2 of
    112  *	    the number of client file connections that will
    113  *	    be using the manager.
    114  *
    115  */
    116 
    117 extern int drm_sman_init(struct drm_sman * sman, unsigned int num_managers,
    118 			 unsigned int user_order, unsigned int owner_order);
    119 
    120 /*
    121  * Initialize a drm_mm.c allocator. Should be called only once for each
    122  * manager unless a customized allogator is used.
    123  */
    124 
    125 extern int drm_sman_set_range(struct drm_sman * sman, unsigned int manager,
    126 			      unsigned long start, unsigned long size);
    127 
    128 /*
    129  * Initialize a customized allocator for one of the managers.
    130  * (See the SiS module). The object pointed to by "allocator" is copied,
    131  * so it can be destroyed after this call.
    132  */
    133 
    134 extern int drm_sman_set_manager(struct drm_sman * sman, unsigned int mananger,
    135 				struct drm_sman_mm * allocator);
    136 
    137 /*
    138  * Allocate a memory block. Aligment is not implemented yet.
    139  */
    140 
    141 extern struct drm_memblock_item *drm_sman_alloc(struct drm_sman * sman,
    142 						unsigned int manager,
    143 						unsigned long size,
    144 						unsigned alignment,
    145 						unsigned long owner);
    146 /*
    147  * Free a memory block identified by its user hash key.
    148  */
    149 
    150 extern int drm_sman_free_key(struct drm_sman * sman, unsigned int key);
    151 
    152 /*
    153  * returns 1 iff there are no stale memory blocks associated with this owner.
    154  * Typically called to determine if we need to idle the hardware and call
    155  * drm_sman_owner_cleanup. If there are no stale memory blocks, it removes all
    156  * resources associated with owner.
    157  */
    158 
    159 extern int drm_sman_owner_clean(struct drm_sman * sman, unsigned long owner);
    160 
    161 /*
    162  * Frees all stale memory blocks associated with this owner. Note that this
    163  * requires that the hardware is finished with all blocks, so the graphics engine
    164  * should be idled before this call is made. This function also frees
    165  * any resources associated with "owner" and should be called when owner
    166  * is not going to be referenced anymore.
    167  */
    168 
    169 extern void drm_sman_owner_cleanup(struct drm_sman * sman, unsigned long owner);
    170 
    171 /*
    172  * Frees all stale memory blocks associated with the memory manager.
    173  * See idling above.
    174  */
    175 
    176 extern void drm_sman_cleanup(struct drm_sman * sman);
    177 
    178 #endif
    179