linux-core/drm_sman.c

   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 SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  17  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  18  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  19  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  20  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * The above copyright notice and this permission notice (including the
  23  * next paragraph) shall be included in all copies or substantial portions
  24  * of the Software.
  25  *
  26  *
  27  **************************************************************************/
  28 /*
  29  * Simple memory manager interface that keeps track on allocate regions on a
  30  * per "owner" basis. All regions associated with an "owner" can be released
  31  * with a simple call. Typically if the "owner" exists. The owner is any
  32  * "unsigned long" identifier. Can typically be a pointer to a file private
  33  * struct or a context identifier.
  34  *
  35  * Authors:
  36  * Thomas Hellström <thomas-at-tungstengraphics-dot-com>
  37  */
  38
  39 #include "drm_sman.h"
  40
  41 typedef struct drm_owner_item {
  42         drm_hash_item_t owner_hash;
  43         struct list_head sman_list;
  44         struct list_head mem_blocks;
  45 } drm_owner_item_t;
  46
  47 void drm_sman_takedown(drm_sman_t * sman)
  48 {
  49         drm_ht_remove(&sman->user_hash_tab);
  50         drm_ht_remove(&sman->owner_hash_tab);
  51         if (sman->mm)
  52                 drm_free(sman->mm, sman->num_managers * sizeof(*sman->mm),
  53                          DRM_MEM_MM);
  54 }
  55
  56 EXPORT_SYMBOL(drm_sman_takedown);
  57
  58 int
  59 drm_sman_init(drm_sman_t * sman, unsigned int num_managers,
  60               unsigned int user_order, unsigned int owner_order)
  61 {
  62         int ret = 0;
  63
  64         sman->mm = (drm_sman_mm_t *) drm_calloc(num_managers, sizeof(*sman->mm),
  65                                                 DRM_MEM_MM);
  66         if (!sman->mm) {
  67                 ret = -ENOMEM;
  68                 goto out;
  69         }
  70         sman->num_managers = num_managers;
  71         INIT_LIST_HEAD(&sman->owner_items);
  72         ret = drm_ht_create(&sman->owner_hash_tab, owner_order);
  73         if (ret)
  74                 goto out1;
  75         ret = drm_ht_create(&sman->user_hash_tab, user_order);
  76         if (!ret)
  77                 goto out;
  78
  79         drm_ht_remove(&sman->owner_hash_tab);
  80 out1:
  81         drm_free(sman->mm, num_managers * sizeof(*sman->mm), DRM_MEM_MM);
  82 out:
  83         return ret;
  84 }
  85
  86 EXPORT_SYMBOL(drm_sman_init);
  87
  88 static void *drm_sman_mm_allocate(void *private, unsigned long size,
  89                                   unsigned alignment)
  90 {
  91         drm_mm_t *mm = (drm_mm_t *) private;
  92         drm_mm_node_t *tmp;
  93
  94         tmp = drm_mm_search_free(mm, size, alignment, 1);
  95         if (!tmp) {
  96                 return NULL;
  97         }
  98         tmp = drm_mm_get_block(tmp, size, alignment);
  99         return tmp;
 100 }
 101
 102 static void drm_sman_mm_free(void *private, void *ref)
 103 {
 104         drm_mm_node_t *node = (drm_mm_node_t *) ref;
 105
 106         drm_mm_put_block(node);
 107 }
 108
 109 static void drm_sman_mm_destroy(void *private)
 110 {
 111         drm_mm_t *mm = (drm_mm_t *) private;
 112         drm_mm_takedown(mm);
 113         drm_free(mm, sizeof(*mm), DRM_MEM_MM);
 114 }
 115
 116 static unsigned long drm_sman_mm_offset(void *private, void *ref)
 117 {
 118         drm_mm_node_t *node = (drm_mm_node_t *) ref;
 119         return node->start;
 120 }
 121
 122 int
 123 drm_sman_set_range(drm_sman_t * sman, unsigned int manager,
 124                    unsigned long start, unsigned long size)
 125 {
 126         drm_sman_mm_t *sman_mm;
 127         drm_mm_t *mm;
 128         int ret;
 129
 130         BUG_ON(manager >= sman->num_managers);
 131
 132         sman_mm = &sman->mm[manager];
 133         mm = drm_calloc(1, sizeof(*mm), DRM_MEM_MM);
 134         if (!mm) {
 135                 return -ENOMEM;
 136         }
 137         sman_mm->private = mm;
 138         ret = drm_mm_init(mm, start, size);
 139
 140         if (ret) {
 141                 drm_free(mm, sizeof(*mm), DRM_MEM_MM);
 142                 return ret;
 143         }
 144
 145         sman_mm->allocate = drm_sman_mm_allocate;
 146         sman_mm->free = drm_sman_mm_free;
 147         sman_mm->destroy = drm_sman_mm_destroy;
 148         sman_mm->offset = drm_sman_mm_offset;
 149
 150         return 0;
 151 }
 152
 153 EXPORT_SYMBOL(drm_sman_set_range);
 154
 155 int
 156 drm_sman_set_manager(drm_sman_t * sman, unsigned int manager,
 157                      drm_sman_mm_t * allocator)
 158 {
 159         BUG_ON(manager >= sman->num_managers);
 160         sman->mm[manager] = *allocator;
 161
 162         return 0;
 163 }
 164
 165 static drm_owner_item_t *drm_sman_get_owner_item(drm_sman_t * sman,
 166                                                  unsigned long owner)
 167 {
 168         int ret;
 169         drm_hash_item_t *owner_hash_item;
 170         drm_owner_item_t *owner_item;
 171
 172         ret = drm_ht_find_item(&sman->owner_hash_tab, owner, &owner_hash_item);
 173         if (!ret) {
 174                 return drm_hash_entry(owner_hash_item, drm_owner_item_t,
 175                                       owner_hash);
 176         }
 177
 178         owner_item = drm_calloc(1, sizeof(*owner_item), DRM_MEM_MM);
 179         if (!owner_item)
 180                 goto out;
 181
 182         INIT_LIST_HEAD(&owner_item->mem_blocks);
 183         owner_item->owner_hash.key = owner;
 184         if (drm_ht_insert_item(&sman->owner_hash_tab, &owner_item->owner_hash))
 185                 goto out1;
 186
 187         list_add_tail(&owner_item->sman_list, &sman->owner_items);
 188         return owner_item;
 189
 190 out1:
 191         drm_free(owner_item, sizeof(*owner_item), DRM_MEM_MM);
 192 out:
 193         return NULL;
 194 }
 195
 196 drm_memblock_item_t *drm_sman_alloc(drm_sman_t *sman, unsigned int manager,
 197                                     unsigned long size, unsigned alignment,
 198                                     unsigned long owner)
 199 {
 200         void *tmp;
 201         drm_sman_mm_t *sman_mm;
 202         drm_owner_item_t *owner_item;
 203         drm_memblock_item_t *memblock;
 204
 205         BUG_ON(manager >= sman->num_managers);
 206
 207         sman_mm = &sman->mm[manager];
 208         tmp = sman_mm->allocate(sman_mm->private, size, alignment);
 209
 210         if (!tmp) {
 211                 return NULL;
 212         }
 213
 214         memblock = drm_calloc(1, sizeof(*memblock), DRM_MEM_MM);
 215
 216         if (!memblock)
 217                 goto out;
 218
 219         memblock->mm_info = tmp;
 220         memblock->mm = sman_mm;
 221         memblock->sman = sman;
 222
 223         if (drm_ht_just_insert_please
 224             (&sman->user_hash_tab, &memblock->user_hash,
 225              (unsigned long)memblock, 32, 0, 0))
 226                 goto out1;
 227
 228         owner_item = drm_sman_get_owner_item(sman, owner);
 229         if (!owner_item)
 230                 goto out2;
 231
 232         list_add_tail(&memblock->owner_list, &owner_item->mem_blocks);
 233
 234         return memblock;
 235
 236 out2:
 237         drm_ht_remove_item(&sman->user_hash_tab, &memblock->user_hash);
 238 out1:
 239         drm_free(memblock, sizeof(*memblock), DRM_MEM_MM);
 240 out:
 241         sman_mm->free(sman_mm->private, tmp);
 242
 243         return NULL;
 244 }
 245
 246 EXPORT_SYMBOL(drm_sman_alloc);
 247
 248 static void drm_sman_free(drm_memblock_item_t *item)
 249 {
 250         drm_sman_t *sman = item->sman;
 251
 252         list_del(&item->owner_list);
 253         drm_ht_remove_item(&sman->user_hash_tab, &item->user_hash);
 254         item->mm->free(item->mm->private, item->mm_info);
 255         drm_free(item, sizeof(*item), DRM_MEM_MM);
 256 }
 257
 258 int drm_sman_free_key(drm_sman_t *sman, unsigned int key)
 259 {
 260         drm_hash_item_t *hash_item;
 261         drm_memblock_item_t *memblock_item;
 262
 263         if (drm_ht_find_item(&sman->user_hash_tab, key, &hash_item))
 264                 return -EINVAL;
 265
 266         memblock_item = drm_hash_entry(hash_item, drm_memblock_item_t, user_hash);
 267         drm_sman_free(memblock_item);
 268         return 0;
 269 }
 270
 271 EXPORT_SYMBOL(drm_sman_free_key);
 272
 273 static void drm_sman_remove_owner(drm_sman_t *sman,
 274                                   drm_owner_item_t *owner_item)
 275 {
 276         list_del(&owner_item->sman_list);
 277         drm_ht_remove_item(&sman->owner_hash_tab, &owner_item->owner_hash);
 278         drm_free(owner_item, sizeof(*owner_item), DRM_MEM_MM);
 279 }
 280
 281 int drm_sman_owner_clean(drm_sman_t *sman, unsigned long owner)
 282 {
 283
 284         drm_hash_item_t *hash_item;
 285         drm_owner_item_t *owner_item;
 286
 287         if (drm_ht_find_item(&sman->owner_hash_tab, owner, &hash_item)) {
 288                 return -1;
 289         }
 290
 291         owner_item = drm_hash_entry(hash_item, drm_owner_item_t, owner_hash);
 292         if (owner_item->mem_blocks.next == &owner_item->mem_blocks) {
 293                 drm_sman_remove_owner(sman, owner_item);
 294                 return -1;
 295         }
 296
 297         return 0;
 298 }
 299
 300 EXPORT_SYMBOL(drm_sman_owner_clean);
 301
 302 static void drm_sman_do_owner_cleanup(drm_sman_t *sman,
 303                                       drm_owner_item_t *owner_item)
 304 {
 305         drm_memblock_item_t *entry, *next;
 306
 307         list_for_each_entry_safe(entry, next, &owner_item->mem_blocks,
 308                                  owner_list) {
 309                 drm_sman_free(entry);
 310         }
 311         drm_sman_remove_owner(sman, owner_item);
 312 }
 313
 314 void drm_sman_owner_cleanup(drm_sman_t *sman, unsigned long owner)
 315 {
 316
 317         drm_hash_item_t *hash_item;
 318         drm_owner_item_t *owner_item;
 319
 320         if (drm_ht_find_item(&sman->owner_hash_tab, owner, &hash_item)) {
 321
 322                 return;
 323         }
 324
 325         owner_item = drm_hash_entry(hash_item, drm_owner_item_t, owner_hash);
 326         drm_sman_do_owner_cleanup(sman, owner_item);
 327 }
 328
 329 EXPORT_SYMBOL(drm_sman_owner_cleanup);
 330
 331 void drm_sman_cleanup(drm_sman_t *sman)
 332 {
 333         drm_owner_item_t *entry, *next;
 334         unsigned int i;
 335         drm_sman_mm_t *sman_mm;
 336
 337         list_for_each_entry_safe(entry, next, &sman->owner_items, sman_list) {
 338                 drm_sman_do_owner_cleanup(sman, entry);
 339         }
 340         if (sman->mm) {
 341                 for (i = 0; i < sman->num_managers; ++i) {
 342                         sman_mm = &sman->mm[i];
 343                         if (sman_mm->private) {
 344                                 sman_mm->destroy(sman_mm->private);
 345                                 sman_mm->private = NULL;
 346                         }
 347                 }
 348         }
 349 }
 350
 351 EXPORT_SYMBOL(drm_sman_cleanup);