[mirror_ubuntu-artful-kernel.git] / include / linux / reservation.h

/*
 * Header file for reservations for dma-buf and ttm
 *
 * Copyright(C) 2011 Linaro Limited. All rights reserved.
 * Copyright (C) 2012-2013 Canonical Ltd
 * Copyright (C) 2012 Texas Instruments
 *
 * Authors:
 * Rob Clark <robdclark@gmail.com>
 * Maarten Lankhorst <maarten.lankhorst@canonical.com>
 * Thomas Hellstrom <thellstrom-at-vmware-dot-com>
 *
 * Based on bo.c which bears the following copyright notice,
 * but is dual licensed:
 *
 * 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 _LINUX_RESERVATION_H
#define _LINUX_RESERVATION_H

#include <linux/ww_mutex.h>
#include <linux/fence.h>
#include <linux/slab.h>

extern struct ww_class reservation_ww_class;

struct reservation_object_list {
	u32 shared_count, shared_max;
	struct fence *shared[];
};

struct reservation_object {
	struct ww_mutex lock;

	struct fence *fence_excl;
	struct reservation_object_list *fence;
	struct reservation_object_list *staged;
};

#define reservation_object_assert_held(obj) \
	lockdep_assert_held(&(obj)->lock.base)

static inline void
reservation_object_init(struct reservation_object *obj)
{
	ww_mutex_init(&obj->lock, &reservation_ww_class);

	obj->fence_excl = NULL;
	obj->fence = NULL;
	obj->staged = NULL;
}

static inline void
reservation_object_fini(struct reservation_object *obj)
{
	int i;
	struct reservation_object_list *fobj;

	/*
	 * This object should be dead and all references must have
	 * been released to it.
	 */
	if (obj->fence_excl)
		fence_put(obj->fence_excl);

	fobj = obj->fence;
	if (fobj) {
		for (i = 0; i < fobj->shared_count; ++i)
			fence_put(fobj->shared[i]);

		kfree(fobj);
	}
	kfree(obj->staged);

	ww_mutex_destroy(&obj->lock);
}

static inline struct reservation_object_list *
reservation_object_get_list(struct reservation_object *obj)
{
	reservation_object_assert_held(obj);

	return obj->fence;
}

static inline struct fence *
reservation_object_get_excl(struct reservation_object *obj)
{
	reservation_object_assert_held(obj);

	return obj->fence_excl;
}

int reservation_object_reserve_shared(struct reservation_object *obj);
void reservation_object_add_shared_fence(struct reservation_object *obj,
					 struct fence *fence);

void reservation_object_add_excl_fence(struct reservation_object *obj,
				       struct fence *fence);

#endif /* _LINUX_RESERVATION_H */
Commit	Line	Data
786d7257 ML	1	/*
	2	* Header file for reservations for dma-buf and ttm
	3	*
	4	* Copyright(C) 2011 Linaro Limited. All rights reserved.
	5	* Copyright (C) 2012-2013 Canonical Ltd
	6	* Copyright (C) 2012 Texas Instruments
	7	*
	8	* Authors:
0ba6b8fb	9	* Rob Clark <robdclark@gmail.com>
786d7257 ML	10	* Maarten Lankhorst <maarten.lankhorst@canonical.com>
	11	* Thomas Hellstrom <thellstrom-at-vmware-dot-com>
	12	*
	13	* Based on bo.c which bears the following copyright notice,
	14	* but is dual licensed:
	15	*
	16	* Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
	17	* All Rights Reserved.
	18	*
	19	* Permission is hereby granted, free of charge, to any person obtaining a
	20	* copy of this software and associated documentation files (the
	21	* "Software"), to deal in the Software without restriction, including
	22	* without limitation the rights to use, copy, modify, merge, publish,
	23	* distribute, sub license, and/or sell copies of the Software, and to
	24	* permit persons to whom the Software is furnished to do so, subject to
	25	* the following conditions:
	26	*
	27	* The above copyright notice and this permission notice (including the
	28	* next paragraph) shall be included in all copies or substantial portions
	29	* of the Software.
	30	*
	31	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	32	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	33	* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
	34	* THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
	35	* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
	36	* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
	37	* USE OR OTHER DEALINGS IN THE SOFTWARE.
	38	*/
	39	#ifndef _LINUX_RESERVATION_H
	40	#define _LINUX_RESERVATION_H
	41
1b375dc3	42	#include <linux/ww_mutex.h>
0ba6b8fb ML	43	#include <linux/fence.h>
0ba6b8fb ML	44	#include <linux/slab.h>
786d7257 ML	45
	46	extern struct ww_class reservation_ww_class;
	47
04a5faa8 ML	48	struct reservation_object_list {
	49	u32 shared_count, shared_max;
	50	struct fence *shared[];
	51	};
	52
786d7257 ML	53	struct reservation_object {
786d7257 ML	54	struct ww_mutex lock;
0ba6b8fb ML	55
0ba6b8fb ML	56	struct fence *fence_excl;
04a5faa8 ML	57	struct reservation_object_list *fence;
04a5faa8 ML	58	struct reservation_object_list *staged;
786d7257 ML	59	};
786d7257 ML	60
04a5faa8 ML	61	#define reservation_object_assert_held(obj) \
	62	lockdep_assert_held(&(obj)->lock.base)
	63
786d7257 ML	64	static inline void
	65	reservation_object_init(struct reservation_object *obj)
	66	{
	67	ww_mutex_init(&obj->lock, &reservation_ww_class);
0ba6b8fb	68
0ba6b8fb	69	obj->fence_excl = NULL;
04a5faa8 ML	70	obj->fence = NULL;
04a5faa8 ML	71	obj->staged = NULL;
786d7257 ML	72	}
	73
	74	static inline void
	75	reservation_object_fini(struct reservation_object *obj)
	76	{
0ba6b8fb	77	int i;
04a5faa8	78	struct reservation_object_list *fobj;
0ba6b8fb	79
04a5faa8 ML	80	/*
	81	* This object should be dead and all references must have
	82	* been released to it.
	83	*/
0ba6b8fb ML	84	if (obj->fence_excl)
0ba6b8fb ML	85	fence_put(obj->fence_excl);
04a5faa8 ML	86
	87	fobj = obj->fence;
	88	if (fobj) {
	89	for (i = 0; i < fobj->shared_count; ++i)
	90	fence_put(fobj->shared[i]);
	91
	92	kfree(fobj);
	93	}
	94	kfree(obj->staged);
0ba6b8fb	95
786d7257 ML	96	ww_mutex_destroy(&obj->lock);
	97	}
	98
04a5faa8 ML	99	static inline struct reservation_object_list *
	100	reservation_object_get_list(struct reservation_object *obj)
	101	{
	102	reservation_object_assert_held(obj);
	103
	104	return obj->fence;
	105	}
	106
	107	static inline struct fence *
	108	reservation_object_get_excl(struct reservation_object *obj)
	109	{
	110	reservation_object_assert_held(obj);
	111
	112	return obj->fence_excl;
	113	}
	114
	115	int reservation_object_reserve_shared(struct reservation_object *obj);
	116	void reservation_object_add_shared_fence(struct reservation_object *obj,
	117	struct fence *fence);
	118
	119	void reservation_object_add_excl_fence(struct reservation_object *obj,
	120	struct fence *fence);
	121
786d7257	122	#endif /* _LINUX_RESERVATION_H */