1 /*
2  * Sync File validation framework and debug infomation
3  *
4  * Copyright (C) 2012 Google, Inc.
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9  * GNU General Public License for more details.
10  *
11  */
12 
13 #ifndef LINUX_SYNC_H
14 #define LINUX_SYNC_H
15 
16 #include <linux/list.h>
17 #include <linux/rbtree.h>
18 #include <linux/spinlock.h>
19 #include <linux/dma-fence.h>
20 
21 #include <linux/sync_file.h>
22 #include <uapi/linux/sync_file.h>
23 
24 /**
25  * struct sync_timeline - sync object
26  * @kref:        reference count on fence.
27  * @name:        name of the sync_timeline. Useful for debugging
28  * @lock:        lock protecting @pt_list and @value
29  * @pt_tree:        rbtree of active (unsignaled/errored) sync_pts
30  * @pt_list:        list of active (unsignaled/errored) sync_pts
31  * @sync_timeline_list:    membership in global sync_timeline_list
32  */
33 struct sync_timeline {
34     struct kref kref;
35     char name[32];
36 
37     /* protected by lock */
38     u64 context;
39     int value;
40 
41     struct rb_root pt_tree;
42     struct list_head pt_list;
43     spinlock_t lock;
44 
45     struct list_head sync_timeline_list;
46 };
47 
dma_fence_parent(struct dma_fence *fence)48 static inline struct sync_timeline *dma_fence_parent(struct dma_fence *fence)
49 {
50     return container_of(fence->lock, struct sync_timeline, lock);
51 }
52 
53 /**
54  * struct sync_pt - sync_pt object
55  * @base: base fence object
56  * @link: link on the sync timeline's list
57  * @node: node in the sync timeline's tree
58  */
59 struct sync_pt {
60     struct dma_fence base;
61     struct list_head link;
62     struct rb_node node;
63 };
64 
65 #ifdef CONFIG_DEBUG_FS
66 extern const struct file_operations sw_sync_debugfs_fops;
67 
68 void sync_timeline_debug_add(struct sync_timeline *obj);
69 void sync_timeline_debug_remove(struct sync_timeline *obj);
70 void sync_file_debug_add(struct sync_file *fence);
71 void sync_file_debug_remove(struct sync_file *fence);
72 #else
sync_timeline_debug_add(struct sync_timeline *obj)73 static inline void sync_timeline_debug_add(struct sync_timeline *obj)
74 {
75 }
sync_timeline_debug_remove(struct sync_timeline *obj)76 static inline void sync_timeline_debug_remove(struct sync_timeline *obj)
77 {
78 }
sync_file_debug_add(struct sync_file *fence)79 static inline void sync_file_debug_add(struct sync_file *fence)
80 {
81 }
sync_file_debug_remove(struct sync_file *fence)82 static inline void sync_file_debug_remove(struct sync_file *fence)
83 {
84 }
85 #endif
86 
87 #endif /* _LINUX_SYNC_H */
88