[deliverable/linux.git] / include / drm / ttm / ttm_memory.h

/**************************************************************************
 *
 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 * USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 **************************************************************************/

#ifndef TTM_MEMORY_H
#define TTM_MEMORY_H

#include <linux/workqueue.h>
#include <linux/spinlock.h>
#include <linux/bug.h>
#include <linux/wait.h>
#include <linux/errno.h>
#include <linux/kobject.h>
#include <linux/mm.h>

/**
 * struct ttm_mem_shrink - callback to shrink TTM memory usage.
 *
 * @do_shrink: The callback function.
 *
 * Arguments to the do_shrink functions are intended to be passed using
 * inheritance. That is, the argument class derives from struct ttm_mem_shrink,
 * and can be accessed using container_of().
 */

struct ttm_mem_shrink {
	int (*do_shrink) (struct ttm_mem_shrink *);
};

/**
 * struct ttm_mem_global - Global memory accounting structure.
 *
 * @shrink: A single callback to shrink TTM memory usage. Extend this
 * to a linked list to be able to handle multiple callbacks when needed.
 * @swap_queue: A workqueue to handle shrinking in low memory situations. We
 * need a separate workqueue since it will spend a lot of time waiting
 * for the GPU, and this will otherwise block other workqueue tasks(?)
 * At this point we use only a single-threaded workqueue.
 * @work: The workqueue callback for the shrink queue.
 * @queue: Wait queue for processes suspended waiting for memory.
 * @lock: Lock to protect the @shrink - and the memory accounting members,
 * that is, essentially the whole structure with some exceptions.
 * @zones: Array of pointers to accounting zones.
 * @num_zones: Number of populated entries in the @zones array.
 * @zone_kernel: Pointer to the kernel zone.
 * @zone_highmem: Pointer to the highmem zone if there is one.
 * @zone_dma32: Pointer to the dma32 zone if there is one.
 *
 * Note that this structure is not per device. It should be global for all
 * graphics devices.
 */

#define TTM_MEM_MAX_ZONES 2
struct ttm_mem_zone;
struct ttm_mem_global {
	struct kobject kobj;
	struct ttm_mem_shrink *shrink;
	struct workqueue_struct *swap_queue;
	struct work_struct work;
	wait_queue_head_t queue;
	spinlock_t lock;
	struct ttm_mem_zone *zones[TTM_MEM_MAX_ZONES];
	unsigned int num_zones;
	struct ttm_mem_zone *zone_kernel;
#ifdef CONFIG_HIGHMEM
	struct ttm_mem_zone *zone_highmem;
#else
	struct ttm_mem_zone *zone_dma32;
#endif
};

/**
 * ttm_mem_init_shrink - initialize a struct ttm_mem_shrink object
 *
 * @shrink: The object to initialize.
 * @func: The callback function.
 */

static inline void ttm_mem_init_shrink(struct ttm_mem_shrink *shrink,
				       int (*func) (struct ttm_mem_shrink *))
{
	shrink->do_shrink = func;
}

/**
 * ttm_mem_register_shrink - register a struct ttm_mem_shrink object.
 *
 * @glob: The struct ttm_mem_global object to register with.
 * @shrink: An initialized struct ttm_mem_shrink object to register.
 *
 * Returns:
 * -EBUSY: There's already a callback registered. (May change).
 */

static inline int ttm_mem_register_shrink(struct ttm_mem_global *glob,
					  struct ttm_mem_shrink *shrink)
{
	spin_lock(&glob->lock);
	if (glob->shrink != NULL) {
		spin_unlock(&glob->lock);
		return -EBUSY;
	}
	glob->shrink = shrink;
	spin_unlock(&glob->lock);
	return 0;
}

/**
 * ttm_mem_unregister_shrink - unregister a struct ttm_mem_shrink object.
 *
 * @glob: The struct ttm_mem_global object to unregister from.
 * @shrink: A previously registert struct ttm_mem_shrink object.
 *
 */

static inline void ttm_mem_unregister_shrink(struct ttm_mem_global *glob,
					     struct ttm_mem_shrink *shrink)
{
	spin_lock(&glob->lock);
	BUG_ON(glob->shrink != shrink);
	glob->shrink = NULL;
	spin_unlock(&glob->lock);
}

extern int ttm_mem_global_init(struct ttm_mem_global *glob);
extern void ttm_mem_global_release(struct ttm_mem_global *glob);
extern int ttm_mem_global_alloc(struct ttm_mem_global *glob, uint64_t memory,
				bool no_wait, bool interruptible);
extern void ttm_mem_global_free(struct ttm_mem_global *glob,
				uint64_t amount);
extern int ttm_mem_global_alloc_page(struct ttm_mem_global *glob,
				     struct page *page,
				     bool no_wait, bool interruptible);
extern void ttm_mem_global_free_page(struct ttm_mem_global *glob,
				     struct page *page);
extern size_t ttm_round_pot(size_t size);
#endif
Commit	Line	Data
ba4e7d97 TH	1	/**************************************************************************
	2	*
	3	* Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., 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	#ifndef TTM_MEMORY_H
	29	#define TTM_MEMORY_H
	30
	31	#include <linux/workqueue.h>
	32	#include <linux/spinlock.h>
187f1882	33	#include <linux/bug.h>
ba4e7d97 TH	34	#include <linux/wait.h>
ba4e7d97 TH	35	#include <linux/errno.h>
5fd9cbad	36	#include <linux/kobject.h>
c3a73ba1	37	#include <linux/mm.h>
ba4e7d97 TH	38
	39	/**
	40	* struct ttm_mem_shrink - callback to shrink TTM memory usage.
	41	*
	42	* @do_shrink: The callback function.
	43	*
	44	* Arguments to the do_shrink functions are intended to be passed using
0d74f86f	45	* inheritance. That is, the argument class derives from struct ttm_mem_shrink,
ba4e7d97 TH	46	* and can be accessed using container_of().
	47	*/
	48
	49	struct ttm_mem_shrink {
	50	int (do_shrink) (struct ttm_mem_shrink );
	51	};
	52
	53	/**
	54	* struct ttm_mem_global - Global memory accounting structure.
	55	*
	56	* @shrink: A single callback to shrink TTM memory usage. Extend this
	57	* to a linked list to be able to handle multiple callbacks when needed.
	58	* @swap_queue: A workqueue to handle shrinking in low memory situations. We
	59	* need a separate workqueue since it will spend a lot of time waiting
	60	* for the GPU, and this will otherwise block other workqueue tasks(?)
	61	* At this point we use only a single-threaded workqueue.
	62	* @work: The workqueue callback for the shrink queue.
	63	* @queue: Wait queue for processes suspended waiting for memory.
	64	* @lock: Lock to protect the @shrink - and the memory accounting members,
	65	* that is, essentially the whole structure with some exceptions.
5fd9cbad TH	66	* @zones: Array of pointers to accounting zones.
	67	* @num_zones: Number of populated entries in the @zones array.
	68	* @zone_kernel: Pointer to the kernel zone.
	69	* @zone_highmem: Pointer to the highmem zone if there is one.
	70	* @zone_dma32: Pointer to the dma32 zone if there is one.
ba4e7d97 TH	71	*
	72	* Note that this structure is not per device. It should be global for all
	73	* graphics devices.
	74	*/
	75
5fd9cbad TH	76	#define TTM_MEM_MAX_ZONES 2
5fd9cbad TH	77	struct ttm_mem_zone;
ba4e7d97	78	struct ttm_mem_global {
5fd9cbad	79	struct kobject kobj;
ba4e7d97 TH	80	struct ttm_mem_shrink *shrink;
	81	struct workqueue_struct *swap_queue;
	82	struct work_struct work;
	83	wait_queue_head_t queue;
	84	spinlock_t lock;
5fd9cbad TH	85	struct ttm_mem_zone *zones[TTM_MEM_MAX_ZONES];
	86	unsigned int num_zones;
	87	struct ttm_mem_zone *zone_kernel;
	88	#ifdef CONFIG_HIGHMEM
	89	struct ttm_mem_zone *zone_highmem;
	90	#else
	91	struct ttm_mem_zone *zone_dma32;
	92	#endif
ba4e7d97 TH	93	};
	94
	95	/**
	96	* ttm_mem_init_shrink - initialize a struct ttm_mem_shrink object
	97	*
	98	* @shrink: The object to initialize.
	99	* @func: The callback function.
	100	*/
	101
	102	static inline void ttm_mem_init_shrink(struct ttm_mem_shrink *shrink,
	103	int (func) (struct ttm_mem_shrink ))
	104	{
	105	shrink->do_shrink = func;
	106	}
	107
	108	/**
	109	* ttm_mem_register_shrink - register a struct ttm_mem_shrink object.
	110	*
	111	* @glob: The struct ttm_mem_global object to register with.
	112	* @shrink: An initialized struct ttm_mem_shrink object to register.
	113	*
	114	* Returns:
	115	* -EBUSY: There's already a callback registered. (May change).
	116	*/
	117
	118	static inline int ttm_mem_register_shrink(struct ttm_mem_global *glob,
	119	struct ttm_mem_shrink *shrink)
	120	{
	121	spin_lock(&glob->lock);
	122	if (glob->shrink != NULL) {
	123	spin_unlock(&glob->lock);
	124	return -EBUSY;
	125	}
	126	glob->shrink = shrink;
	127	spin_unlock(&glob->lock);
	128	return 0;
	129	}
	130
	131	/**
	132	* ttm_mem_unregister_shrink - unregister a struct ttm_mem_shrink object.
	133	*
	134	* @glob: The struct ttm_mem_global object to unregister from.
	135	* @shrink: A previously registert struct ttm_mem_shrink object.
	136	*
	137	*/
	138
	139	static inline void ttm_mem_unregister_shrink(struct ttm_mem_global *glob,
	140	struct ttm_mem_shrink *shrink)
	141	{
	142	spin_lock(&glob->lock);
	143	BUG_ON(glob->shrink != shrink);
	144	glob->shrink = NULL;
	145	spin_unlock(&glob->lock);
	146	}
	147
	148	extern int ttm_mem_global_init(struct ttm_mem_global *glob);
	149	extern void ttm_mem_global_release(struct ttm_mem_global *glob);
	150	extern int ttm_mem_global_alloc(struct ttm_mem_global *glob, uint64_t memory,
5fd9cbad	151	bool no_wait, bool interruptible);
ba4e7d97	152	extern void ttm_mem_global_free(struct ttm_mem_global *glob,
5fd9cbad TH	153	uint64_t amount);
	154	extern int ttm_mem_global_alloc_page(struct ttm_mem_global *glob,
	155	struct page *page,
	156	bool no_wait, bool interruptible);
	157	extern void ttm_mem_global_free_page(struct ttm_mem_global *glob,
	158	struct page *page);
ba4e7d97 TH	159	extern size_t ttm_round_pot(size_t size);
ba4e7d97 TH	160	#endif