dma-resv.c 21.9 KB
Newer Older
1
// SPDX-License-Identifier: MIT
2
/*
3
 * Copyright (C) 2012-2014 Canonical Ltd (Maarten Lankhorst)
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
 *
 * 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.
 *
 **************************************************************************/
/*
 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
 */

36
#include <linux/dma-resv.h>
37
#include <linux/dma-fence-array.h>
38
#include <linux/export.h>
39
#include <linux/mm.h>
40
#include <linux/sched/mm.h>
41
#include <linux/mmu_notifier.h>
42
#include <linux/seq_file.h>
43

R
Rob Clark 已提交
44 45 46 47 48 49 50 51 52
/**
 * DOC: Reservation Object Overview
 *
 * The reservation object provides a mechanism to manage shared and
 * exclusive fences associated with a buffer.  A reservation object
 * can have attached one exclusive fence (normally associated with
 * write operations) or N shared fences (read operations).  The RCU
 * mechanism is used to protect read access to fences from locked
 * write-side updates.
53 54
 *
 * See struct dma_resv for more details.
R
Rob Clark 已提交
55 56
 */

57
DEFINE_WD_CLASS(reservation_ww_class);
58
EXPORT_SYMBOL(reservation_ww_class);
59

60 61 62 63 64 65
struct dma_resv_list {
	struct rcu_head rcu;
	u32 shared_count, shared_max;
	struct dma_fence __rcu *shared[];
};

66
/**
67
 * dma_resv_list_alloc - allocate fence list
68 69
 * @shared_max: number of fences we need space for
 *
70
 * Allocate a new dma_resv_list and make sure to correctly initialize
71 72
 * shared_max.
 */
73
static struct dma_resv_list *dma_resv_list_alloc(unsigned int shared_max)
74
{
75
	struct dma_resv_list *list;
76

C
Christian König 已提交
77
	list = kmalloc(struct_size(list, shared, shared_max), GFP_KERNEL);
78 79 80 81 82 83 84 85 86 87
	if (!list)
		return NULL;

	list->shared_max = (ksize(list) - offsetof(typeof(*list), shared)) /
		sizeof(*list->shared);

	return list;
}

/**
88
 * dma_resv_list_free - free fence list
89 90
 * @list: list to free
 *
91
 * Free a dma_resv_list and make sure to drop all references.
92
 */
93
static void dma_resv_list_free(struct dma_resv_list *list)
94 95 96 97 98 99 100 101 102 103 104 105
{
	unsigned int i;

	if (!list)
		return;

	for (i = 0; i < list->shared_count; ++i)
		dma_fence_put(rcu_dereference_protected(list->shared[i], true));

	kfree_rcu(list, rcu);
}

106
/**
107
 * dma_resv_init - initialize a reservation object
108 109
 * @obj: the reservation object
 */
110
void dma_resv_init(struct dma_resv *obj)
111 112
{
	ww_mutex_init(&obj->lock, &reservation_ww_class);
113
	seqcount_ww_mutex_init(&obj->seq, &obj->lock);
114

115 116 117
	RCU_INIT_POINTER(obj->fence, NULL);
	RCU_INIT_POINTER(obj->fence_excl, NULL);
}
118
EXPORT_SYMBOL(dma_resv_init);
119 120

/**
121
 * dma_resv_fini - destroys a reservation object
122 123
 * @obj: the reservation object
 */
124
void dma_resv_fini(struct dma_resv *obj)
125
{
126
	struct dma_resv_list *fobj;
127 128 129 130 131 132 133 134 135 136 137
	struct dma_fence *excl;

	/*
	 * This object should be dead and all references must have
	 * been released to it, so no need to be protected with rcu.
	 */
	excl = rcu_dereference_protected(obj->fence_excl, 1);
	if (excl)
		dma_fence_put(excl);

	fobj = rcu_dereference_protected(obj->fence, 1);
138
	dma_resv_list_free(fobj);
139 140
	ww_mutex_destroy(&obj->lock);
}
141
EXPORT_SYMBOL(dma_resv_fini);
142

143 144 145 146 147 148
static inline struct dma_fence *
dma_resv_excl_fence(struct dma_resv *obj)
{
       return rcu_dereference_check(obj->fence_excl, dma_resv_held(obj));
}

149 150 151 152 153
static inline struct dma_resv_list *dma_resv_shared_list(struct dma_resv *obj)
{
	return rcu_dereference_check(obj->fence, dma_resv_held(obj));
}

R
Rob Clark 已提交
154
/**
155 156
 * dma_resv_reserve_shared - Reserve space to add shared fences to
 * a dma_resv.
R
Rob Clark 已提交
157
 * @obj: reservation object
158
 * @num_fences: number of fences we want to add
R
Rob Clark 已提交
159
 *
160
 * Should be called before dma_resv_add_shared_fence().  Must
161 162 163 164 165
 * be called with @obj locked through dma_resv_lock().
 *
 * Note that the preallocated slots need to be re-reserved if @obj is unlocked
 * at any time before calling dma_resv_add_shared_fence(). This is validated
 * when CONFIG_DEBUG_MUTEXES is enabled.
R
Rob Clark 已提交
166 167 168
 *
 * RETURNS
 * Zero for success, or -errno
169
 */
170
int dma_resv_reserve_shared(struct dma_resv *obj, unsigned int num_fences)
171
{
172
	struct dma_resv_list *old, *new;
173
	unsigned int i, j, k, max;
174

175
	dma_resv_assert_held(obj);
176

177
	old = dma_resv_shared_list(obj);
178
	if (old && old->shared_max) {
179
		if ((old->shared_count + num_fences) <= old->shared_max)
180
			return 0;
181
		max = max(old->shared_count + num_fences, old->shared_max * 2);
182
	} else {
183
		max = max(4ul, roundup_pow_of_two(num_fences));
184
	}
185

186
	new = dma_resv_list_alloc(max);
187 188
	if (!new)
		return -ENOMEM;
189 190 191 192 193 194 195

	/*
	 * no need to bump fence refcounts, rcu_read access
	 * requires the use of kref_get_unless_zero, and the
	 * references from the old struct are carried over to
	 * the new.
	 */
196 197
	for (i = 0, j = 0, k = max; i < (old ? old->shared_count : 0); ++i) {
		struct dma_fence *fence;
198

199
		fence = rcu_dereference_protected(old->shared[i],
200
						  dma_resv_held(obj));
201 202
		if (dma_fence_is_signaled(fence))
			RCU_INIT_POINTER(new->shared[--k], fence);
203
		else
204
			RCU_INIT_POINTER(new->shared[j++], fence);
205
	}
206
	new->shared_count = j;
207

208
	/*
209 210 211 212 213 214
	 * We are not changing the effective set of fences here so can
	 * merely update the pointer to the new array; both existing
	 * readers and new readers will see exactly the same set of
	 * active (unsignaled) shared fences. Individual fences and the
	 * old array are protected by RCU and so will not vanish under
	 * the gaze of the rcu_read_lock() readers.
215
	 */
216
	rcu_assign_pointer(obj->fence, new);
217

218
	if (!old)
219
		return 0;
220

221
	/* Drop the references to the signaled fences */
222
	for (i = k; i < max; ++i) {
223
		struct dma_fence *fence;
224

225
		fence = rcu_dereference_protected(new->shared[i],
226
						  dma_resv_held(obj));
227
		dma_fence_put(fence);
228 229
	}
	kfree_rcu(old, rcu);
230 231

	return 0;
232
}
233
EXPORT_SYMBOL(dma_resv_reserve_shared);
234

235 236 237 238 239 240 241 242 243 244 245
#ifdef CONFIG_DEBUG_MUTEXES
/**
 * dma_resv_reset_shared_max - reset shared fences for debugging
 * @obj: the dma_resv object to reset
 *
 * Reset the number of pre-reserved shared slots to test that drivers do
 * correct slot allocation using dma_resv_reserve_shared(). See also
 * &dma_resv_list.shared_max.
 */
void dma_resv_reset_shared_max(struct dma_resv *obj)
{
246
	struct dma_resv_list *fences = dma_resv_shared_list(obj);
247

248 249 250 251 252
	dma_resv_assert_held(obj);

	/* Test shared fence slot reservation */
	if (fences)
		fences->shared_max = fences->shared_count;
253
}
254
EXPORT_SYMBOL(dma_resv_reset_shared_max);
255 256
#endif

R
Rob Clark 已提交
257
/**
258
 * dma_resv_add_shared_fence - Add a fence to a shared slot
R
Rob Clark 已提交
259 260 261
 * @obj: the reservation object
 * @fence: the shared fence to add
 *
262
 * Add a fence to a shared slot, @obj must be locked with dma_resv_lock(), and
263
 * dma_resv_reserve_shared() has been called.
264 265
 *
 * See also &dma_resv.fence for a discussion of the semantics.
266
 */
267
void dma_resv_add_shared_fence(struct dma_resv *obj, struct dma_fence *fence)
268
{
269
	struct dma_resv_list *fobj;
270
	struct dma_fence *old;
271
	unsigned int i, count;
272

273 274
	dma_fence_get(fence);

275
	dma_resv_assert_held(obj);
276

277 278 279 280 281
	/* Drivers should not add containers here, instead add each fence
	 * individually.
	 */
	WARN_ON(dma_fence_is_container(fence));

282
	fobj = dma_resv_shared_list(obj);
283
	count = fobj->shared_count;
284

285 286
	write_seqcount_begin(&obj->seq);

287
	for (i = 0; i < count; ++i) {
288

289
		old = rcu_dereference_protected(fobj->shared[i],
290
						dma_resv_held(obj));
291 292
		if (old->context == fence->context ||
		    dma_fence_is_signaled(old))
293 294 295 296
			goto replace;
	}

	BUG_ON(fobj->shared_count >= fobj->shared_max);
297
	old = NULL;
298
	count++;
299 300 301

replace:
	RCU_INIT_POINTER(fobj->shared[i], fence);
302 303
	/* pointer update must be visible before we extend the shared_count */
	smp_store_mb(fobj->shared_count, count);
304 305

	write_seqcount_end(&obj->seq);
306
	dma_fence_put(old);
307
}
308
EXPORT_SYMBOL(dma_resv_add_shared_fence);
309

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
/**
 * dma_resv_replace_fences - replace fences in the dma_resv obj
 * @obj: the reservation object
 * @context: the context of the fences to replace
 * @replacement: the new fence to use instead
 *
 * Replace fences with a specified context with a new fence. Only valid if the
 * operation represented by the original fence has no longer access to the
 * resources represented by the dma_resv object when the new fence completes.
 *
 * And example for using this is replacing a preemption fence with a page table
 * update fence which makes the resource inaccessible.
 */
void dma_resv_replace_fences(struct dma_resv *obj, uint64_t context,
			     struct dma_fence *replacement)
{
	struct dma_resv_list *list;
	struct dma_fence *old;
	unsigned int i;

	dma_resv_assert_held(obj);

	write_seqcount_begin(&obj->seq);

	old = dma_resv_excl_fence(obj);
	if (old->context == context) {
		RCU_INIT_POINTER(obj->fence_excl, dma_fence_get(replacement));
		dma_fence_put(old);
	}

	list = dma_resv_shared_list(obj);
	for (i = 0; list && i < list->shared_count; ++i) {
		old = rcu_dereference_protected(list->shared[i],
						dma_resv_held(obj));
		if (old->context != context)
			continue;

		rcu_assign_pointer(list->shared[i], dma_fence_get(replacement));
		dma_fence_put(old);
	}

	write_seqcount_end(&obj->seq);
}
EXPORT_SYMBOL(dma_resv_replace_fences);

R
Rob Clark 已提交
355
/**
356
 * dma_resv_add_excl_fence - Add an exclusive fence.
R
Rob Clark 已提交
357
 * @obj: the reservation object
358
 * @fence: the exclusive fence to add
R
Rob Clark 已提交
359
 *
360
 * Add a fence to the exclusive slot. @obj must be locked with dma_resv_lock().
361
 * See also &dma_resv.fence_excl for a discussion of the semantics.
R
Rob Clark 已提交
362
 */
363
void dma_resv_add_excl_fence(struct dma_resv *obj, struct dma_fence *fence)
364
{
365
	struct dma_fence *old_fence = dma_resv_excl_fence(obj);
366

367
	dma_resv_assert_held(obj);
368

369
	dma_fence_get(fence);
370

371 372 373 374
	write_seqcount_begin(&obj->seq);
	/* write_seqcount_begin provides the necessary memory barrier */
	RCU_INIT_POINTER(obj->fence_excl, fence);
	write_seqcount_end(&obj->seq);
375

376
	dma_fence_put(old_fence);
377
}
378
EXPORT_SYMBOL(dma_resv_add_excl_fence);
379

380 381
/* Restart the iterator by initializing all the necessary fields, but not the
 * relation to the dma_resv object. */
382 383 384 385
static void dma_resv_iter_restart_unlocked(struct dma_resv_iter *cursor)
{
	cursor->seq = read_seqcount_begin(&cursor->obj->seq);
	cursor->index = -1;
386 387
	cursor->shared_count = 0;
	if (cursor->all_fences) {
388
		cursor->fences = dma_resv_shared_list(cursor->obj);
389 390 391
		if (cursor->fences)
			cursor->shared_count = cursor->fences->shared_count;
	} else {
392
		cursor->fences = NULL;
393
	}
394 395 396
	cursor->is_restarted = true;
}

397
/* Walk to the next not signaled fence and grab a reference to it */
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
static void dma_resv_iter_walk_unlocked(struct dma_resv_iter *cursor)
{
	struct dma_resv *obj = cursor->obj;

	do {
		/* Drop the reference from the previous round */
		dma_fence_put(cursor->fence);

		if (cursor->index == -1) {
			cursor->fence = dma_resv_excl_fence(obj);
			cursor->index++;
			if (!cursor->fence)
				continue;

		} else if (!cursor->fences ||
413
			   cursor->index >= cursor->shared_count) {
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
			cursor->fence = NULL;
			break;

		} else {
			struct dma_resv_list *fences = cursor->fences;
			unsigned int idx = cursor->index++;

			cursor->fence = rcu_dereference(fences->shared[idx]);
		}
		cursor->fence = dma_fence_get_rcu(cursor->fence);
		if (!cursor->fence || !dma_fence_is_signaled(cursor->fence))
			break;
	} while (true);
}

/**
 * dma_resv_iter_first_unlocked - first fence in an unlocked dma_resv obj.
 * @cursor: the cursor with the current position
 *
433 434 435 436 437 438
 * Subsequent fences are iterated with dma_resv_iter_next_unlocked().
 *
 * Beware that the iterator can be restarted.  Code which accumulates statistics
 * or similar needs to check for this with dma_resv_iter_is_restarted(). For
 * this reason prefer the locked dma_resv_iter_first() whenver possible.
 *
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
 * Returns the first fence from an unlocked dma_resv obj.
 */
struct dma_fence *dma_resv_iter_first_unlocked(struct dma_resv_iter *cursor)
{
	rcu_read_lock();
	do {
		dma_resv_iter_restart_unlocked(cursor);
		dma_resv_iter_walk_unlocked(cursor);
	} while (read_seqcount_retry(&cursor->obj->seq, cursor->seq));
	rcu_read_unlock();

	return cursor->fence;
}
EXPORT_SYMBOL(dma_resv_iter_first_unlocked);

/**
 * dma_resv_iter_next_unlocked - next fence in an unlocked dma_resv obj.
 * @cursor: the cursor with the current position
 *
458 459 460 461
 * Beware that the iterator can be restarted.  Code which accumulates statistics
 * or similar needs to check for this with dma_resv_iter_is_restarted(). For
 * this reason prefer the locked dma_resv_iter_next() whenver possible.
 *
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
 * Returns the next fence from an unlocked dma_resv obj.
 */
struct dma_fence *dma_resv_iter_next_unlocked(struct dma_resv_iter *cursor)
{
	bool restart;

	rcu_read_lock();
	cursor->is_restarted = false;
	restart = read_seqcount_retry(&cursor->obj->seq, cursor->seq);
	do {
		if (restart)
			dma_resv_iter_restart_unlocked(cursor);
		dma_resv_iter_walk_unlocked(cursor);
		restart = true;
	} while (read_seqcount_retry(&cursor->obj->seq, cursor->seq));
	rcu_read_unlock();

	return cursor->fence;
}
EXPORT_SYMBOL(dma_resv_iter_next_unlocked);

483 484 485 486
/**
 * dma_resv_iter_first - first fence from a locked dma_resv object
 * @cursor: cursor to record the current position
 *
487 488
 * Subsequent fences are iterated with dma_resv_iter_next_unlocked().
 *
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
 * Return the first fence in the dma_resv object while holding the
 * &dma_resv.lock.
 */
struct dma_fence *dma_resv_iter_first(struct dma_resv_iter *cursor)
{
	struct dma_fence *fence;

	dma_resv_assert_held(cursor->obj);

	cursor->index = 0;
	if (cursor->all_fences)
		cursor->fences = dma_resv_shared_list(cursor->obj);
	else
		cursor->fences = NULL;

	fence = dma_resv_excl_fence(cursor->obj);
	if (!fence)
		fence = dma_resv_iter_next(cursor);

	cursor->is_restarted = true;
	return fence;
}
EXPORT_SYMBOL_GPL(dma_resv_iter_first);

/**
 * dma_resv_iter_next - next fence from a locked dma_resv object
 * @cursor: cursor to record the current position
 *
 * Return the next fences from the dma_resv object while holding the
 * &dma_resv.lock.
 */
struct dma_fence *dma_resv_iter_next(struct dma_resv_iter *cursor)
{
	unsigned int idx;

	dma_resv_assert_held(cursor->obj);

	cursor->is_restarted = false;
	if (!cursor->fences || cursor->index >= cursor->fences->shared_count)
		return NULL;

	idx = cursor->index++;
	return rcu_dereference_protected(cursor->fences->shared[idx],
					 dma_resv_held(cursor->obj));
}
EXPORT_SYMBOL_GPL(dma_resv_iter_next);

536
/**
537 538 539 540 541 542
 * dma_resv_copy_fences - Copy all fences from src to dst.
 * @dst: the destination reservation object
 * @src: the source reservation object
 *
 * Copy all fences from src to dst. dst-lock must be held.
 */
543
int dma_resv_copy_fences(struct dma_resv *dst, struct dma_resv *src)
544
{
545 546 547
	struct dma_resv_iter cursor;
	struct dma_resv_list *list;
	struct dma_fence *f, *excl;
548

549
	dma_resv_assert_held(dst);
550

551 552
	list = NULL;
	excl = NULL;
553

554 555
	dma_resv_iter_begin(&cursor, src, true);
	dma_resv_for_each_fence_unlocked(&cursor, f) {
556

557 558 559
		if (dma_resv_iter_is_restarted(&cursor)) {
			dma_resv_list_free(list);
			dma_fence_put(excl);
560

561 562
			if (cursor.shared_count) {
				list = dma_resv_list_alloc(cursor.shared_count);
563 564 565 566
				if (!list) {
					dma_resv_iter_end(&cursor);
					return -ENOMEM;
				}
567

568
				list->shared_count = 0;
569

570 571
			} else {
				list = NULL;
572
			}
573
			excl = NULL;
574 575
		}

576 577 578 579 580 581 582
		dma_fence_get(f);
		if (dma_resv_iter_is_exclusive(&cursor))
			excl = f;
		else
			RCU_INIT_POINTER(list->shared[list->shared_count++], f);
	}
	dma_resv_iter_end(&cursor);
583

584
	write_seqcount_begin(&dst->seq);
585 586
	excl = rcu_replace_pointer(dst->fence_excl, excl, dma_resv_held(dst));
	list = rcu_replace_pointer(dst->fence, list, dma_resv_held(dst));
587
	write_seqcount_end(&dst->seq);
588

589 590
	dma_resv_list_free(list);
	dma_fence_put(excl);
591 592 593

	return 0;
}
594
EXPORT_SYMBOL(dma_resv_copy_fences);
595

R
Rob Clark 已提交
596
/**
597
 * dma_resv_get_fences - Get an object's shared and exclusive
R
Rob Clark 已提交
598 599
 * fences without update side lock held
 * @obj: the reservation object
600 601 602 603
 * @write: true if we should return all fences
 * @num_fences: the number of fences returned
 * @fences: the array of fence ptrs returned (array is krealloc'd to the
 * required size, and must be freed by caller)
R
Rob Clark 已提交
604
 *
605 606
 * Retrieve all fences from the reservation object.
 * Returns either zero or -ENOMEM.
R
Rob Clark 已提交
607
 */
608 609
int dma_resv_get_fences(struct dma_resv *obj, bool write,
			unsigned int *num_fences, struct dma_fence ***fences)
610
{
611 612
	struct dma_resv_iter cursor;
	struct dma_fence *fence;
613

614 615
	*num_fences = 0;
	*fences = NULL;
616

617
	dma_resv_iter_begin(&cursor, obj, write);
618
	dma_resv_for_each_fence_unlocked(&cursor, fence) {
619

620 621
		if (dma_resv_iter_is_restarted(&cursor)) {
			unsigned int count;
622

623 624
			while (*num_fences)
				dma_fence_put((*fences)[--(*num_fences)]);
625

626
			count = cursor.shared_count + 1;
627

628
			/* Eventually re-allocate the array */
629
			*fences = krealloc_array(*fences, count,
630 631
						 sizeof(void *),
						 GFP_KERNEL);
632
			if (count && !*fences) {
633 634
				dma_resv_iter_end(&cursor);
				return -ENOMEM;
635
			}
636
		}
637

638
		(*fences)[(*num_fences)++] = dma_fence_get(fence);
639
	}
640
	dma_resv_iter_end(&cursor);
641

642
	return 0;
643
}
644
EXPORT_SYMBOL_GPL(dma_resv_get_fences);
645

646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
/**
 * dma_resv_get_singleton - Get a single fence for all the fences
 * @obj: the reservation object
 * @write: true if we should return all fences
 * @fence: the resulting fence
 *
 * Get a single fence representing all the fences inside the resv object.
 * Returns either 0 for success or -ENOMEM.
 *
 * Warning: This can't be used like this when adding the fence back to the resv
 * object since that can lead to stack corruption when finalizing the
 * dma_fence_array.
 *
 * Returns 0 on success and negative error values on failure.
 */
int dma_resv_get_singleton(struct dma_resv *obj, bool write,
			   struct dma_fence **fence)
{
	struct dma_fence_array *array;
	struct dma_fence **fences;
	unsigned count;
	int r;

	r = dma_resv_get_fences(obj, write, &count, &fences);
        if (r)
		return r;

	if (count == 0) {
		*fence = NULL;
		return 0;
	}

	if (count == 1) {
		*fence = fences[0];
		kfree(fences);
		return 0;
	}

	array = dma_fence_array_create(count, fences,
				       dma_fence_context_alloc(1),
				       1, false);
	if (!array) {
		while (count--)
			dma_fence_put(fences[count]);
		kfree(fences);
		return -ENOMEM;
	}

	*fence = &array->base;
	return 0;
}
EXPORT_SYMBOL_GPL(dma_resv_get_singleton);

R
Rob Clark 已提交
699
/**
700
 * dma_resv_wait_timeout - Wait on reservation's objects
R
Rob Clark 已提交
701 702 703 704 705 706
 * shared and/or exclusive fences.
 * @obj: the reservation object
 * @wait_all: if true, wait on all fences, else wait on just exclusive fence
 * @intr: if true, do interruptible wait
 * @timeout: timeout value in jiffies or zero to return immediately
 *
707 708
 * Callers are not required to hold specific locks, but maybe hold
 * dma_resv_lock() already
R
Rob Clark 已提交
709 710 711 712
 * RETURNS
 * Returns -ERESTARTSYS if interrupted, 0 if the wait timed out, or
 * greater than zer on success.
 */
713 714
long dma_resv_wait_timeout(struct dma_resv *obj, bool wait_all, bool intr,
			   unsigned long timeout)
715
{
716
	long ret = timeout ? timeout : 1;
717
	struct dma_resv_iter cursor;
718
	struct dma_fence *fence;
719

720 721
	dma_resv_iter_begin(&cursor, obj, wait_all);
	dma_resv_for_each_fence_unlocked(&cursor, fence) {
722

723 724 725 726
		ret = dma_fence_wait_timeout(fence, intr, ret);
		if (ret <= 0) {
			dma_resv_iter_end(&cursor);
			return ret;
727 728
		}
	}
729
	dma_resv_iter_end(&cursor);
730 731 732

	return ret;
}
733
EXPORT_SYMBOL_GPL(dma_resv_wait_timeout);
734 735


R
Rob Clark 已提交
736
/**
737 738
 * dma_resv_test_signaled - Test if a reservation object's fences have been
 * signaled.
R
Rob Clark 已提交
739 740 741 742
 * @obj: the reservation object
 * @test_all: if true, test all fences, otherwise only test the exclusive
 * fence
 *
743
 * Callers are not required to hold specific locks, but maybe hold
744 745
 * dma_resv_lock() already.
 *
R
Rob Clark 已提交
746
 * RETURNS
747 748
 *
 * True if all fences signaled, else false.
R
Rob Clark 已提交
749
 */
750
bool dma_resv_test_signaled(struct dma_resv *obj, bool test_all)
751
{
752
	struct dma_resv_iter cursor;
753
	struct dma_fence *fence;
754

755 756 757 758
	dma_resv_iter_begin(&cursor, obj, test_all);
	dma_resv_for_each_fence_unlocked(&cursor, fence) {
		dma_resv_iter_end(&cursor);
		return false;
759
	}
760 761
	dma_resv_iter_end(&cursor);
	return true;
762
}
763
EXPORT_SYMBOL_GPL(dma_resv_test_signaled);
764

765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
/**
 * dma_resv_describe - Dump description of the resv object into seq_file
 * @obj: the reservation object
 * @seq: the seq_file to dump the description into
 *
 * Dump a textual description of the fences inside an dma_resv object into the
 * seq_file.
 */
void dma_resv_describe(struct dma_resv *obj, struct seq_file *seq)
{
	struct dma_resv_iter cursor;
	struct dma_fence *fence;

	dma_resv_for_each_fence(&cursor, obj, true, fence) {
		seq_printf(seq, "\t%s fence:",
			   dma_resv_iter_is_exclusive(&cursor) ?
				"Exclusive" : "Shared");
		dma_fence_describe(fence, seq);
	}
}
EXPORT_SYMBOL_GPL(dma_resv_describe);

787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
#if IS_ENABLED(CONFIG_LOCKDEP)
static int __init dma_resv_lockdep(void)
{
	struct mm_struct *mm = mm_alloc();
	struct ww_acquire_ctx ctx;
	struct dma_resv obj;
	struct address_space mapping;
	int ret;

	if (!mm)
		return -ENOMEM;

	dma_resv_init(&obj);
	address_space_init_once(&mapping);

	mmap_read_lock(mm);
	ww_acquire_init(&ctx, &reservation_ww_class);
	ret = dma_resv_lock(&obj, &ctx);
	if (ret == -EDEADLK)
		dma_resv_lock_slow(&obj, &ctx);
	fs_reclaim_acquire(GFP_KERNEL);
	/* for unmap_mapping_range on trylocked buffer objects in shrinkers */
	i_mmap_lock_write(&mapping);
	i_mmap_unlock_write(&mapping);
#ifdef CONFIG_MMU_NOTIFIER
	lock_map_acquire(&__mmu_notifier_invalidate_range_start_map);
	__dma_fence_might_wait();
	lock_map_release(&__mmu_notifier_invalidate_range_start_map);
#else
	__dma_fence_might_wait();
#endif
	fs_reclaim_release(GFP_KERNEL);
	ww_mutex_unlock(&obj.lock);
	ww_acquire_fini(&ctx);
	mmap_read_unlock(mm);

	mmput(mm);

	return 0;
}
subsys_initcall(dma_resv_lockdep);
#endif