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 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com> 29 */ 30 31#ifndef _TTM_EXECBUF_UTIL_H_ 32#define _TTM_EXECBUF_UTIL_H_ 33 34#include "ttm/ttm_bo_api.h" 35#include <linux/list.h> 36 37/** 38 * struct ttm_validate_buffer 39 * 40 * @head: list head for thread-private list. 41 * @bo: refcounted buffer object pointer. 42 * @new_sync_obj_arg: New sync_obj_arg for @bo, to be used once 43 * adding a new sync object. 44 * @reservied: Indicates whether @bo has been reserved for validation. 45 */ 46 47struct ttm_validate_buffer { 48 struct list_head head; 49 struct ttm_buffer_object *bo; 50 void *new_sync_obj_arg; 51 bool reserved; 52}; 53 54/** 55 * function ttm_eu_backoff_reservation 56 * 57 * @list: thread private list of ttm_validate_buffer structs. 58 * 59 * Undoes all buffer validation reservations for bos pointed to by 60 * the list entries. 61 */ 62 63extern void ttm_eu_backoff_reservation(struct list_head *list); 64 65/** 66 * function ttm_eu_reserve_buffers 67 * 68 * @list: thread private list of ttm_validate_buffer structs. 69 * @val_seq: A unique sequence number. 70 * 71 * Tries to reserve bos pointed to by the list entries for validation. 72 * If the function returns 0, all buffers are marked as "unfenced", 73 * taken off the lru lists and are not synced for write CPU usage. 74 * 75 * If the function detects a deadlock due to multiple threads trying to 76 * reserve the same buffers in reverse order, all threads except one will 77 * back off and retry. This function may sleep while waiting for 78 * CPU write reservations to be cleared, and for other threads to 79 * unreserve their buffers. 80 * 81 * This function may return -ERESTART or -EAGAIN if the calling process 82 * receives a signal while waiting. In that case, no buffers on the list 83 * will be reserved upon return. 84 * 85 * Buffers reserved by this function should be unreserved by 86 * a call to either ttm_eu_backoff_reservation() or 87 * ttm_eu_fence_buffer_objects() when command submission is complete or 88 * has failed. 89 */ 90 91extern int ttm_eu_reserve_buffers(struct list_head *list, uint32_t val_seq); 92 93/** 94 * function ttm_eu_fence_buffer_objects. 95 * 96 * @list: thread private list of ttm_validate_buffer structs. 97 * @sync_obj: The new sync object for the buffers. 98 * 99 * This function should be called when command submission is complete, and 100 * it will add a new sync object to bos pointed to by entries on @list. 101 * It also unreserves all buffers, putting them on lru lists. 102 * 103 */ 104 105extern void ttm_eu_fence_buffer_objects(struct list_head *list, void *sync_obj); 106 107#endif 108