]>
Commit | Line | Data |
---|---|---|
d4cab38e GP |
1 | /* |
2 | * drivers/dma-buf/sync_file.c | |
3 | * | |
4 | * Copyright (C) 2012 Google, Inc. | |
5 | * | |
6 | * This software is licensed under the terms of the GNU General Public | |
7 | * License version 2, as published by the Free Software Foundation, and | |
8 | * may be copied, distributed, and modified under those terms. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | * GNU General Public License for more details. | |
14 | * | |
15 | */ | |
16 | ||
17 | #include <linux/export.h> | |
18 | #include <linux/file.h> | |
19 | #include <linux/fs.h> | |
20 | #include <linux/kernel.h> | |
21 | #include <linux/poll.h> | |
22 | #include <linux/sched.h> | |
23 | #include <linux/slab.h> | |
24 | #include <linux/uaccess.h> | |
25 | #include <linux/anon_inodes.h> | |
460bfc41 GP |
26 | #include <linux/sync_file.h> |
27 | #include <uapi/linux/sync_file.h> | |
d4cab38e GP |
28 | |
29 | static const struct file_operations sync_file_fops; | |
30 | ||
a02b9dc9 | 31 | static struct sync_file *sync_file_alloc(void) |
d4cab38e GP |
32 | { |
33 | struct sync_file *sync_file; | |
34 | ||
a02b9dc9 | 35 | sync_file = kzalloc(sizeof(*sync_file), GFP_KERNEL); |
d4cab38e GP |
36 | if (!sync_file) |
37 | return NULL; | |
38 | ||
39 | sync_file->file = anon_inode_getfile("sync_file", &sync_file_fops, | |
40 | sync_file, 0); | |
41 | if (IS_ERR(sync_file->file)) | |
42 | goto err; | |
43 | ||
44 | kref_init(&sync_file->kref); | |
45 | ||
46 | init_waitqueue_head(&sync_file->wq); | |
47 | ||
a02b9dc9 GP |
48 | INIT_LIST_HEAD(&sync_file->cb.node); |
49 | ||
d4cab38e GP |
50 | return sync_file; |
51 | ||
52 | err: | |
53 | kfree(sync_file); | |
54 | return NULL; | |
55 | } | |
56 | ||
f54d1867 | 57 | static void fence_check_cb_func(struct dma_fence *f, struct dma_fence_cb *cb) |
d4cab38e | 58 | { |
d4cab38e GP |
59 | struct sync_file *sync_file; |
60 | ||
a02b9dc9 | 61 | sync_file = container_of(cb, struct sync_file, cb); |
d4cab38e | 62 | |
a02b9dc9 | 63 | wake_up_all(&sync_file->wq); |
d4cab38e GP |
64 | } |
65 | ||
66 | /** | |
c240a714 | 67 | * sync_file_create() - creates a sync file |
d4cab38e GP |
68 | * @fence: fence to add to the sync_fence |
69 | * | |
24a36734 DV |
70 | * Creates a sync_file containg @fence. This function acquires and additional |
71 | * reference of @fence for the newly-created &sync_file, if it succeeds. The | |
72 | * sync_file can be released with fput(sync_file->file). Returns the | |
73 | * sync_file or NULL in case of error. | |
d4cab38e | 74 | */ |
f54d1867 | 75 | struct sync_file *sync_file_create(struct dma_fence *fence) |
d4cab38e GP |
76 | { |
77 | struct sync_file *sync_file; | |
78 | ||
a02b9dc9 | 79 | sync_file = sync_file_alloc(); |
d4cab38e GP |
80 | if (!sync_file) |
81 | return NULL; | |
82 | ||
f54d1867 | 83 | sync_file->fence = dma_fence_get(fence); |
a02b9dc9 | 84 | |
041916a7 | 85 | snprintf(sync_file->name, sizeof(sync_file->name), "%s-%s%llu-%d", |
d4cab38e GP |
86 | fence->ops->get_driver_name(fence), |
87 | fence->ops->get_timeline_name(fence), fence->context, | |
88 | fence->seqno); | |
89 | ||
d4cab38e GP |
90 | return sync_file; |
91 | } | |
92 | EXPORT_SYMBOL(sync_file_create); | |
93 | ||
d4cab38e GP |
94 | static struct sync_file *sync_file_fdget(int fd) |
95 | { | |
96 | struct file *file = fget(fd); | |
97 | ||
98 | if (!file) | |
99 | return NULL; | |
100 | ||
101 | if (file->f_op != &sync_file_fops) | |
102 | goto err; | |
103 | ||
104 | return file->private_data; | |
105 | ||
106 | err: | |
107 | fput(file); | |
108 | return NULL; | |
109 | } | |
110 | ||
972526a4 GP |
111 | /** |
112 | * sync_file_get_fence - get the fence related to the sync_file fd | |
113 | * @fd: sync_file fd to get the fence from | |
114 | * | |
115 | * Ensures @fd references a valid sync_file and returns a fence that | |
116 | * represents all fence in the sync_file. On error NULL is returned. | |
117 | */ | |
f54d1867 | 118 | struct dma_fence *sync_file_get_fence(int fd) |
972526a4 GP |
119 | { |
120 | struct sync_file *sync_file; | |
f54d1867 | 121 | struct dma_fence *fence; |
972526a4 GP |
122 | |
123 | sync_file = sync_file_fdget(fd); | |
124 | if (!sync_file) | |
125 | return NULL; | |
126 | ||
f54d1867 | 127 | fence = dma_fence_get(sync_file->fence); |
972526a4 GP |
128 | fput(sync_file->file); |
129 | ||
130 | return fence; | |
131 | } | |
132 | EXPORT_SYMBOL(sync_file_get_fence); | |
133 | ||
a02b9dc9 | 134 | static int sync_file_set_fence(struct sync_file *sync_file, |
f54d1867 | 135 | struct dma_fence **fences, int num_fences) |
d4cab38e | 136 | { |
f54d1867 | 137 | struct dma_fence_array *array; |
a02b9dc9 GP |
138 | |
139 | /* | |
140 | * The reference for the fences in the new sync_file and held | |
141 | * in add_fence() during the merge procedure, so for num_fences == 1 | |
142 | * we already own a new reference to the fence. For num_fence > 1 | |
f54d1867 | 143 | * we own the reference of the dma_fence_array creation. |
a02b9dc9 GP |
144 | */ |
145 | if (num_fences == 1) { | |
146 | sync_file->fence = fences[0]; | |
c654dd07 | 147 | kfree(fences); |
a02b9dc9 | 148 | } else { |
f54d1867 CW |
149 | array = dma_fence_array_create(num_fences, fences, |
150 | dma_fence_context_alloc(1), | |
151 | 1, false); | |
a02b9dc9 GP |
152 | if (!array) |
153 | return -ENOMEM; | |
154 | ||
155 | sync_file->fence = &array->base; | |
156 | } | |
d4cab38e | 157 | |
a02b9dc9 GP |
158 | return 0; |
159 | } | |
160 | ||
f54d1867 CW |
161 | static struct dma_fence **get_fences(struct sync_file *sync_file, |
162 | int *num_fences) | |
a02b9dc9 | 163 | { |
f54d1867 CW |
164 | if (dma_fence_is_array(sync_file->fence)) { |
165 | struct dma_fence_array *array = to_dma_fence_array(sync_file->fence); | |
a02b9dc9 GP |
166 | |
167 | *num_fences = array->num_fences; | |
168 | return array->fences; | |
169 | } | |
170 | ||
171 | *num_fences = 1; | |
172 | return &sync_file->fence; | |
173 | } | |
174 | ||
f54d1867 CW |
175 | static void add_fence(struct dma_fence **fences, |
176 | int *i, struct dma_fence *fence) | |
a02b9dc9 GP |
177 | { |
178 | fences[*i] = fence; | |
179 | ||
f54d1867 CW |
180 | if (!dma_fence_is_signaled(fence)) { |
181 | dma_fence_get(fence); | |
d4cab38e GP |
182 | (*i)++; |
183 | } | |
184 | } | |
185 | ||
186 | /** | |
187 | * sync_file_merge() - merge two sync_files | |
188 | * @name: name of new fence | |
189 | * @a: sync_file a | |
190 | * @b: sync_file b | |
191 | * | |
192 | * Creates a new sync_file which contains copies of all the fences in both | |
193 | * @a and @b. @a and @b remain valid, independent sync_file. Returns the | |
194 | * new merged sync_file or NULL in case of error. | |
195 | */ | |
196 | static struct sync_file *sync_file_merge(const char *name, struct sync_file *a, | |
197 | struct sync_file *b) | |
198 | { | |
d4cab38e | 199 | struct sync_file *sync_file; |
f54d1867 | 200 | struct dma_fence **fences, **nfences, **a_fences, **b_fences; |
a02b9dc9 | 201 | int i, i_a, i_b, num_fences, a_num_fences, b_num_fences; |
d4cab38e | 202 | |
a02b9dc9 | 203 | sync_file = sync_file_alloc(); |
d4cab38e GP |
204 | if (!sync_file) |
205 | return NULL; | |
206 | ||
a02b9dc9 GP |
207 | a_fences = get_fences(a, &a_num_fences); |
208 | b_fences = get_fences(b, &b_num_fences); | |
209 | if (a_num_fences > INT_MAX - b_num_fences) | |
210 | return NULL; | |
211 | ||
212 | num_fences = a_num_fences + b_num_fences; | |
213 | ||
214 | fences = kcalloc(num_fences, sizeof(*fences), GFP_KERNEL); | |
215 | if (!fences) | |
216 | goto err; | |
d4cab38e GP |
217 | |
218 | /* | |
219 | * Assume sync_file a and b are both ordered and have no | |
220 | * duplicates with the same context. | |
221 | * | |
222 | * If a sync_file can only be created with sync_file_merge | |
223 | * and sync_file_create, this is a reasonable assumption. | |
224 | */ | |
a02b9dc9 | 225 | for (i = i_a = i_b = 0; i_a < a_num_fences && i_b < b_num_fences; ) { |
f54d1867 CW |
226 | struct dma_fence *pt_a = a_fences[i_a]; |
227 | struct dma_fence *pt_b = b_fences[i_b]; | |
d4cab38e GP |
228 | |
229 | if (pt_a->context < pt_b->context) { | |
a02b9dc9 | 230 | add_fence(fences, &i, pt_a); |
d4cab38e GP |
231 | |
232 | i_a++; | |
233 | } else if (pt_a->context > pt_b->context) { | |
a02b9dc9 | 234 | add_fence(fences, &i, pt_b); |
d4cab38e GP |
235 | |
236 | i_b++; | |
237 | } else { | |
238 | if (pt_a->seqno - pt_b->seqno <= INT_MAX) | |
a02b9dc9 | 239 | add_fence(fences, &i, pt_a); |
d4cab38e | 240 | else |
a02b9dc9 | 241 | add_fence(fences, &i, pt_b); |
d4cab38e GP |
242 | |
243 | i_a++; | |
244 | i_b++; | |
245 | } | |
246 | } | |
247 | ||
a02b9dc9 GP |
248 | for (; i_a < a_num_fences; i_a++) |
249 | add_fence(fences, &i, a_fences[i_a]); | |
250 | ||
251 | for (; i_b < b_num_fences; i_b++) | |
252 | add_fence(fences, &i, b_fences[i_b]); | |
253 | ||
7cec540a | 254 | if (i == 0) |
f54d1867 | 255 | fences[i++] = dma_fence_get(a_fences[0]); |
d4cab38e | 256 | |
a02b9dc9 GP |
257 | if (num_fences > i) { |
258 | nfences = krealloc(fences, i * sizeof(*fences), | |
259 | GFP_KERNEL); | |
260 | if (!nfences) | |
261 | goto err; | |
262 | ||
263 | fences = nfences; | |
264 | } | |
265 | ||
266 | if (sync_file_set_fence(sync_file, fences, i) < 0) { | |
267 | kfree(fences); | |
268 | goto err; | |
269 | } | |
d4cab38e | 270 | |
d4cab38e GP |
271 | strlcpy(sync_file->name, name, sizeof(sync_file->name)); |
272 | return sync_file; | |
a02b9dc9 GP |
273 | |
274 | err: | |
275 | fput(sync_file->file); | |
276 | return NULL; | |
277 | ||
d4cab38e GP |
278 | } |
279 | ||
280 | static void sync_file_free(struct kref *kref) | |
281 | { | |
282 | struct sync_file *sync_file = container_of(kref, struct sync_file, | |
283 | kref); | |
d4cab38e | 284 | |
e2416553 | 285 | if (test_bit(POLL_ENABLED, &sync_file->fence->flags)) |
f54d1867 CW |
286 | dma_fence_remove_callback(sync_file->fence, &sync_file->cb); |
287 | dma_fence_put(sync_file->fence); | |
d4cab38e GP |
288 | kfree(sync_file); |
289 | } | |
290 | ||
291 | static int sync_file_release(struct inode *inode, struct file *file) | |
292 | { | |
293 | struct sync_file *sync_file = file->private_data; | |
294 | ||
295 | kref_put(&sync_file->kref, sync_file_free); | |
296 | return 0; | |
297 | } | |
298 | ||
299 | static unsigned int sync_file_poll(struct file *file, poll_table *wait) | |
300 | { | |
301 | struct sync_file *sync_file = file->private_data; | |
d4cab38e GP |
302 | |
303 | poll_wait(file, &sync_file->wq, wait); | |
304 | ||
069cad6d | 305 | if (!test_and_set_bit(POLL_ENABLED, &sync_file->fence->flags)) { |
f54d1867 CW |
306 | if (dma_fence_add_callback(sync_file->fence, &sync_file->cb, |
307 | fence_check_cb_func) < 0) | |
e2416553 GP |
308 | wake_up_all(&sync_file->wq); |
309 | } | |
d4cab38e | 310 | |
f54d1867 | 311 | return dma_fence_is_signaled(sync_file->fence) ? POLLIN : 0; |
d4cab38e GP |
312 | } |
313 | ||
314 | static long sync_file_ioctl_merge(struct sync_file *sync_file, | |
92e06213 | 315 | unsigned long arg) |
d4cab38e GP |
316 | { |
317 | int fd = get_unused_fd_flags(O_CLOEXEC); | |
318 | int err; | |
319 | struct sync_file *fence2, *fence3; | |
320 | struct sync_merge_data data; | |
321 | ||
322 | if (fd < 0) | |
323 | return fd; | |
324 | ||
325 | if (copy_from_user(&data, (void __user *)arg, sizeof(data))) { | |
326 | err = -EFAULT; | |
327 | goto err_put_fd; | |
328 | } | |
329 | ||
330 | if (data.flags || data.pad) { | |
331 | err = -EINVAL; | |
332 | goto err_put_fd; | |
333 | } | |
334 | ||
335 | fence2 = sync_file_fdget(data.fd2); | |
336 | if (!fence2) { | |
337 | err = -ENOENT; | |
338 | goto err_put_fd; | |
339 | } | |
340 | ||
341 | data.name[sizeof(data.name) - 1] = '\0'; | |
342 | fence3 = sync_file_merge(data.name, sync_file, fence2); | |
343 | if (!fence3) { | |
344 | err = -ENOMEM; | |
345 | goto err_put_fence2; | |
346 | } | |
347 | ||
348 | data.fence = fd; | |
349 | if (copy_to_user((void __user *)arg, &data, sizeof(data))) { | |
350 | err = -EFAULT; | |
351 | goto err_put_fence3; | |
352 | } | |
353 | ||
354 | fd_install(fd, fence3->file); | |
355 | fput(fence2->file); | |
356 | return 0; | |
357 | ||
358 | err_put_fence3: | |
359 | fput(fence3->file); | |
360 | ||
361 | err_put_fence2: | |
362 | fput(fence2->file); | |
363 | ||
364 | err_put_fd: | |
365 | put_unused_fd(fd); | |
366 | return err; | |
367 | } | |
368 | ||
f54d1867 | 369 | static void sync_fill_fence_info(struct dma_fence *fence, |
92e06213 | 370 | struct sync_fence_info *info) |
d4cab38e GP |
371 | { |
372 | strlcpy(info->obj_name, fence->ops->get_timeline_name(fence), | |
373 | sizeof(info->obj_name)); | |
374 | strlcpy(info->driver_name, fence->ops->get_driver_name(fence), | |
375 | sizeof(info->driver_name)); | |
f54d1867 | 376 | if (dma_fence_is_signaled(fence)) |
d4cab38e GP |
377 | info->status = fence->status >= 0 ? 1 : fence->status; |
378 | else | |
379 | info->status = 0; | |
380 | info->timestamp_ns = ktime_to_ns(fence->timestamp); | |
381 | } | |
382 | ||
383 | static long sync_file_ioctl_fence_info(struct sync_file *sync_file, | |
92e06213 | 384 | unsigned long arg) |
d4cab38e GP |
385 | { |
386 | struct sync_file_info info; | |
387 | struct sync_fence_info *fence_info = NULL; | |
f54d1867 | 388 | struct dma_fence **fences; |
d4cab38e | 389 | __u32 size; |
a02b9dc9 | 390 | int num_fences, ret, i; |
d4cab38e GP |
391 | |
392 | if (copy_from_user(&info, (void __user *)arg, sizeof(info))) | |
393 | return -EFAULT; | |
394 | ||
395 | if (info.flags || info.pad) | |
396 | return -EINVAL; | |
397 | ||
a02b9dc9 GP |
398 | fences = get_fences(sync_file, &num_fences); |
399 | ||
d4cab38e GP |
400 | /* |
401 | * Passing num_fences = 0 means that userspace doesn't want to | |
402 | * retrieve any sync_fence_info. If num_fences = 0 we skip filling | |
403 | * sync_fence_info and return the actual number of fences on | |
404 | * info->num_fences. | |
405 | */ | |
406 | if (!info.num_fences) | |
407 | goto no_fences; | |
408 | ||
a02b9dc9 | 409 | if (info.num_fences < num_fences) |
d4cab38e GP |
410 | return -EINVAL; |
411 | ||
a02b9dc9 | 412 | size = num_fences * sizeof(*fence_info); |
d4cab38e GP |
413 | fence_info = kzalloc(size, GFP_KERNEL); |
414 | if (!fence_info) | |
415 | return -ENOMEM; | |
416 | ||
a02b9dc9 GP |
417 | for (i = 0; i < num_fences; i++) |
418 | sync_fill_fence_info(fences[i], &fence_info[i]); | |
d4cab38e GP |
419 | |
420 | if (copy_to_user(u64_to_user_ptr(info.sync_fence_info), fence_info, | |
421 | size)) { | |
422 | ret = -EFAULT; | |
423 | goto out; | |
424 | } | |
425 | ||
426 | no_fences: | |
427 | strlcpy(info.name, sync_file->name, sizeof(info.name)); | |
f54d1867 | 428 | info.status = dma_fence_is_signaled(sync_file->fence); |
a02b9dc9 | 429 | info.num_fences = num_fences; |
d4cab38e GP |
430 | |
431 | if (copy_to_user((void __user *)arg, &info, sizeof(info))) | |
432 | ret = -EFAULT; | |
433 | else | |
434 | ret = 0; | |
435 | ||
436 | out: | |
437 | kfree(fence_info); | |
438 | ||
439 | return ret; | |
440 | } | |
441 | ||
442 | static long sync_file_ioctl(struct file *file, unsigned int cmd, | |
92e06213 | 443 | unsigned long arg) |
d4cab38e GP |
444 | { |
445 | struct sync_file *sync_file = file->private_data; | |
446 | ||
447 | switch (cmd) { | |
448 | case SYNC_IOC_MERGE: | |
449 | return sync_file_ioctl_merge(sync_file, arg); | |
450 | ||
451 | case SYNC_IOC_FILE_INFO: | |
452 | return sync_file_ioctl_fence_info(sync_file, arg); | |
453 | ||
454 | default: | |
455 | return -ENOTTY; | |
456 | } | |
457 | } | |
458 | ||
459 | static const struct file_operations sync_file_fops = { | |
460 | .release = sync_file_release, | |
461 | .poll = sync_file_poll, | |
462 | .unlocked_ioctl = sync_file_ioctl, | |
463 | .compat_ioctl = sync_file_ioctl, | |
464 | }; |