summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Hall2017-02-12 00:50:02 -0600
committerJesse Hall2017-02-23 20:44:50 -0600
commit081806e5f2e9f8b573827b0f3d4b35d8ddb64cb9 (patch)
tree435c00fbdaa48dac5440db4f91b9a433d5f1abb5 /libsync
parent077ffd5055538e79d20fb5de964083cfbe10dc3f (diff)
downloadplatform-system-core-081806e5f2e9f8b573827b0f3d4b35d8ddb64cb9.tar.gz
platform-system-core-081806e5f2e9f8b573827b0f3d4b35d8ddb64cb9.tar.xz
platform-system-core-081806e5f2e9f8b573827b0f3d4b35d8ddb64cb9.zip
sync: Add NDK sync.h and libsync
The new header provides an updated interface to libsync appropriate for the NDK. Clients use existing syscalls where possible (e.g. poll() instead of sync_wait()), and the remaining functions return structures used in mainline Linux kernels rather than the Android staging sync framework. Over time, framework clients will be migrated to using the NDK interface, which will eventually replace the current internal interface. The only difference is the header will be named <android/sync.h> in the NDK and <sync/sync.h> internally. Bug: 35138793 Test: sync-unit-tests on bullhead Change-Id: Ieb3649b80565393e26b604416158438d32c2a256
Diffstat (limited to 'libsync')
-rw-r--r--libsync/Android.bp14
-rw-r--r--libsync/NOTICE190
-rw-r--r--libsync/include/ndk/sync.h89
-rw-r--r--libsync/include/sync/sync.h74
-rw-r--r--libsync/libsync.map.txt32
5 files changed, 338 insertions, 61 deletions
diff --git a/libsync/Android.bp b/libsync/Android.bp
index a4e55992c..b293da4ad 100644
--- a/libsync/Android.bp
+++ b/libsync/Android.bp
@@ -1,3 +1,17 @@
1ndk_headers {
2 name: "libsync_headers",
3 from: "include/ndk",
4 to: "android",
5 srcs: ["include/ndk/sync.h"],
6 license: "NOTICE",
7}
8
9ndk_library {
10 name: "libsync.ndk",
11 symbol_file: "libsync.map.txt",
12 first_version: "26",
13}
14
1cc_defaults { 15cc_defaults {
2 name: "libsync_defaults", 16 name: "libsync_defaults",
3 srcs: ["sync.c"], 17 srcs: ["sync.c"],
diff --git a/libsync/NOTICE b/libsync/NOTICE
new file mode 100644
index 000000000..2c8db73b0
--- /dev/null
+++ b/libsync/NOTICE
@@ -0,0 +1,190 @@
1
2 Copyright (c) 2012-2017, The Android Open Source Project
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6
7 Unless required by applicable law or agreed to in writing, software
8 distributed under the License is distributed on an "AS IS" BASIS,
9 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 See the License for the specific language governing permissions and
11 limitations under the License.
12
13
14 Apache License
15 Version 2.0, January 2004
16 http://www.apache.org/licenses/
17
18 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
19
20 1. Definitions.
21
22 "License" shall mean the terms and conditions for use, reproduction,
23 and distribution as defined by Sections 1 through 9 of this document.
24
25 "Licensor" shall mean the copyright owner or entity authorized by
26 the copyright owner that is granting the License.
27
28 "Legal Entity" shall mean the union of the acting entity and all
29 other entities that control, are controlled by, or are under common
30 control with that entity. For the purposes of this definition,
31 "control" means (i) the power, direct or indirect, to cause the
32 direction or management of such entity, whether by contract or
33 otherwise, or (ii) ownership of fifty percent (50%) or more of the
34 outstanding shares, or (iii) beneficial ownership of such entity.
35
36 "You" (or "Your") shall mean an individual or Legal Entity
37 exercising permissions granted by this License.
38
39 "Source" form shall mean the preferred form for making modifications,
40 including but not limited to software source code, documentation
41 source, and configuration files.
42
43 "Object" form shall mean any form resulting from mechanical
44 transformation or translation of a Source form, including but
45 not limited to compiled object code, generated documentation,
46 and conversions to other media types.
47
48 "Work" shall mean the work of authorship, whether in Source or
49 Object form, made available under the License, as indicated by a
50 copyright notice that is included in or attached to the work
51 (an example is provided in the Appendix below).
52
53 "Derivative Works" shall mean any work, whether in Source or Object
54 form, that is based on (or derived from) the Work and for which the
55 editorial revisions, annotations, elaborations, or other modifications
56 represent, as a whole, an original work of authorship. For the purposes
57 of this License, Derivative Works shall not include works that remain
58 separable from, or merely link (or bind by name) to the interfaces of,
59 the Work and Derivative Works thereof.
60
61 "Contribution" shall mean any work of authorship, including
62 the original version of the Work and any modifications or additions
63 to that Work or Derivative Works thereof, that is intentionally
64 submitted to Licensor for inclusion in the Work by the copyright owner
65 or by an individual or Legal Entity authorized to submit on behalf of
66 the copyright owner. For the purposes of this definition, "submitted"
67 means any form of electronic, verbal, or written communication sent
68 to the Licensor or its representatives, including but not limited to
69 communication on electronic mailing lists, source code control systems,
70 and issue tracking systems that are managed by, or on behalf of, the
71 Licensor for the purpose of discussing and improving the Work, but
72 excluding communication that is conspicuously marked or otherwise
73 designated in writing by the copyright owner as "Not a Contribution."
74
75 "Contributor" shall mean Licensor and any individual or Legal Entity
76 on behalf of whom a Contribution has been received by Licensor and
77 subsequently incorporated within the Work.
78
79 2. Grant of Copyright License. Subject to the terms and conditions of
80 this License, each Contributor hereby grants to You a perpetual,
81 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
82 copyright license to reproduce, prepare Derivative Works of,
83 publicly display, publicly perform, sublicense, and distribute the
84 Work and such Derivative Works in Source or Object form.
85
86 3. Grant of Patent License. Subject to the terms and conditions of
87 this License, each Contributor hereby grants to You a perpetual,
88 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
89 (except as stated in this section) patent license to make, have made,
90 use, offer to sell, sell, import, and otherwise transfer the Work,
91 where such license applies only to those patent claims licensable
92 by such Contributor that are necessarily infringed by their
93 Contribution(s) alone or by combination of their Contribution(s)
94 with the Work to which such Contribution(s) was submitted. If You
95 institute patent litigation against any entity (including a
96 cross-claim or counterclaim in a lawsuit) alleging that the Work
97 or a Contribution incorporated within the Work constitutes direct
98 or contributory patent infringement, then any patent licenses
99 granted to You under this License for that Work shall terminate
100 as of the date such litigation is filed.
101
102 4. Redistribution. You may reproduce and distribute copies of the
103 Work or Derivative Works thereof in any medium, with or without
104 modifications, and in Source or Object form, provided that You
105 meet the following conditions:
106
107 (a) You must give any other recipients of the Work or
108 Derivative Works a copy of this License; and
109
110 (b) You must cause any modified files to carry prominent notices
111 stating that You changed the files; and
112
113 (c) You must retain, in the Source form of any Derivative Works
114 that You distribute, all copyright, patent, trademark, and
115 attribution notices from the Source form of the Work,
116 excluding those notices that do not pertain to any part of
117 the Derivative Works; and
118
119 (d) If the Work includes a "NOTICE" text file as part of its
120 distribution, then any Derivative Works that You distribute must
121 include a readable copy of the attribution notices contained
122 within such NOTICE file, excluding those notices that do not
123 pertain to any part of the Derivative Works, in at least one
124 of the following places: within a NOTICE text file distributed
125 as part of the Derivative Works; within the Source form or
126 documentation, if provided along with the Derivative Works; or,
127 within a display generated by the Derivative Works, if and
128 wherever such third-party notices normally appear. The contents
129 of the NOTICE file are for informational purposes only and
130 do not modify the License. You may add Your own attribution
131 notices within Derivative Works that You distribute, alongside
132 or as an addendum to the NOTICE text from the Work, provided
133 that such additional attribution notices cannot be construed
134 as modifying the License.
135
136 You may add Your own copyright statement to Your modifications and
137 may provide additional or different license terms and conditions
138 for use, reproduction, or distribution of Your modifications, or
139 for any such Derivative Works as a whole, provided Your use,
140 reproduction, and distribution of the Work otherwise complies with
141 the conditions stated in this License.
142
143 5. Submission of Contributions. Unless You explicitly state otherwise,
144 any Contribution intentionally submitted for inclusion in the Work
145 by You to the Licensor shall be under the terms and conditions of
146 this License, without any additional terms or conditions.
147 Notwithstanding the above, nothing herein shall supersede or modify
148 the terms of any separate license agreement you may have executed
149 with Licensor regarding such Contributions.
150
151 6. Trademarks. This License does not grant permission to use the trade
152 names, trademarks, service marks, or product names of the Licensor,
153 except as required for reasonable and customary use in describing the
154 origin of the Work and reproducing the content of the NOTICE file.
155
156 7. Disclaimer of Warranty. Unless required by applicable law or
157 agreed to in writing, Licensor provides the Work (and each
158 Contributor provides its Contributions) on an "AS IS" BASIS,
159 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
160 implied, including, without limitation, any warranties or conditions
161 of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
162 PARTICULAR PURPOSE. You are solely responsible for determining the
163 appropriateness of using or redistributing the Work and assume any
164 risks associated with Your exercise of permissions under this License.
165
166 8. Limitation of Liability. In no event and under no legal theory,
167 whether in tort (including negligence), contract, or otherwise,
168 unless required by applicable law (such as deliberate and grossly
169 negligent acts) or agreed to in writing, shall any Contributor be
170 liable to You for damages, including any direct, indirect, special,
171 incidental, or consequential damages of any character arising as a
172 result of this License or out of the use or inability to use the
173 Work (including but not limited to damages for loss of goodwill,
174 work stoppage, computer failure or malfunction, or any and all
175 other commercial damages or losses), even if such Contributor
176 has been advised of the possibility of such damages.
177
178 9. Accepting Warranty or Additional Liability. While redistributing
179 the Work or Derivative Works thereof, You may choose to offer,
180 and charge a fee for, acceptance of support, warranty, indemnity,
181 or other liability obligations and/or rights consistent with this
182 License. However, in accepting such obligations, You may act only
183 on Your own behalf and on Your sole responsibility, not on behalf
184 of any other Contributor, and only if You agree to indemnify,
185 defend, and hold each Contributor harmless for any liability
186 incurred by, or claims asserted against, such Contributor by reason
187 of your accepting any such warranty or additional liability.
188
189 END OF TERMS AND CONDITIONS
190
diff --git a/libsync/include/ndk/sync.h b/libsync/include/ndk/sync.h
new file mode 100644
index 000000000..758a10623
--- /dev/null
+++ b/libsync/include/ndk/sync.h
@@ -0,0 +1,89 @@
1/*
2 * Copyright 2017 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_SYNC_H
18#define ANDROID_SYNC_H
19
20#include <stdint.h>
21
22#include <linux/sync_file.h>
23
24__BEGIN_DECLS
25
26#if __ANDROID_API__ >= __ANDROID_API_O__
27
28/* Fences indicate the status of an asynchronous task. They are initially
29 * in unsignaled state (0), and make a one-time transition to either signaled
30 * (1) or error (< 0) state. A sync file is a collection of one or more fences;
31 * the sync file's status is error if any of its fences are in error state,
32 * signaled if all of the child fences are signaled, or unsignaled otherwise.
33 *
34 * Sync files are created by various device APIs in response to submitting
35 * tasks to the device. Standard file descriptor lifetime syscalls like dup()
36 * and close() are used to manage sync file lifetime.
37 *
38 * The poll(), ppoll(), or select() syscalls can be used to wait for the sync
39 * file to change status, or (with a timeout of zero) to check its status.
40 *
41 * The functions below provide a few additional sync-specific operations.
42 */
43
44/**
45 * Merge two sync files.
46 *
47 * This produces a new sync file with the given name which has the union of the
48 * two original sync file's fences; redundant fences may be removed.
49 *
50 * If one of the input sync files is signaled or invalid, then this function
51 * may behave like dup(): the new file descriptor refers to the valid/unsignaled
52 * sync file with its original name, rather than a new sync file.
53 *
54 * The original fences remain valid, and the caller is responsible for closing
55 * them.
56 */
57int32_t sync_merge(const char *name, int32_t fd1, int32_t fd2);
58
59/**
60 * Retrieve detailed information about a sync file and its fences.
61 *
62 * The returned sync_file_info must be freed by calling sync_file_info_free().
63 */
64struct sync_file_info *sync_file_info(int32_t fd);
65
66/**
67 * Get the array of fence infos from the sync file's info.
68 *
69 * The returned array is owned by the parent sync file info, and has
70 * info->num_fences entries.
71 */
72inline struct sync_fence_info *sync_get_fence_info(
73 const struct sync_file_info *info) {
74// This header should compile in C, but some C++ projects enable
75// warnings-as-error for C-style casts.
76#pragma GCC diagnostic push
77#pragma GCC diagnostic ignored "-Wold-style-cast"
78 return (struct sync_fence_info *)(uintptr_t)(info->sync_fence_info);
79#pragma GCC diagnostic pop
80}
81
82/** Free a struct sync_file_info structure */
83void sync_file_info_free(struct sync_file_info *info);
84
85#endif // __ANDROID_API__ >= __ANDROID_API_O__
86
87__END_DECLS
88
89#endif /* ANDROID_SYNC_H */
diff --git a/libsync/include/sync/sync.h b/libsync/include/sync/sync.h
index 50ed0ac57..8755d2b5d 100644
--- a/libsync/include/sync/sync.h
+++ b/libsync/include/sync/sync.h
@@ -19,6 +19,19 @@
19#ifndef __SYS_CORE_SYNC_H 19#ifndef __SYS_CORE_SYNC_H
20#define __SYS_CORE_SYNC_H 20#define __SYS_CORE_SYNC_H
21 21
22/* This file contains the legacy sync interface used by Android platform and
23 * device code. The direct contents will be removed over time as code
24 * transitions to using the updated interface in ndk/sync.h. When this file is
25 * empty other than the ndk/sync.h include, that file will be renamed to
26 * replace this one.
27 *
28 * New code should continue to include this file (#include <sync/sync.h>)
29 * instead of ndk/sync.h so the eventual rename is seamless, but should only
30 * use the things declared in ndk/sync.h.
31 */
32
33#include "../ndk/sync.h"
34
22#include <sys/cdefs.h> 35#include <sys/cdefs.h>
23#include <stdint.h> 36#include <stdint.h>
24 37
@@ -90,69 +103,8 @@ struct sync_pt_info {
90#define SYNC_IOC_LEGACY_FENCE_INFO _IOWR(SYNC_IOC_MAGIC, 2,\ 103#define SYNC_IOC_LEGACY_FENCE_INFO _IOWR(SYNC_IOC_MAGIC, 2,\
91 struct sync_fence_info_data) 104 struct sync_fence_info_data)
92 105
93struct sync_merge_data {
94 char name[32];
95 int32_t fd2;
96 int32_t fence;
97 uint32_t flags;
98 uint32_t pad;
99};
100
101struct sync_file_info {
102 char name[32];
103 int32_t status;
104 uint32_t flags;
105 uint32_t num_fences;
106 uint32_t pad;
107
108 uint64_t sync_fence_info;
109};
110
111struct sync_fence_info {
112 char obj_name[32];
113 char driver_name[32];
114 int32_t status;
115 uint32_t flags;
116 uint64_t timestamp_ns;
117};
118
119/**
120 * Mainline API:
121 *
122 * Opcodes 0, 1 and 2 were burned during a API change to avoid users of the
123 * old API to get weird errors when trying to handling sync_files. The API
124 * change happened during the de-stage of the Sync Framework when there was
125 * no upstream users available.
126 */
127
128/**
129 * DOC: SYNC_IOC_MERGE - merge two fences
130 *
131 * Takes a struct sync_merge_data. Creates a new fence containing copies of
132 * the sync_pts in both the calling fd and sync_merge_data.fd2. Returns the
133 * new fence's fd in sync_merge_data.fence
134 *
135 * This is the new version of the Sync API after the de-stage that happened
136 * on Linux kernel 4.7.
137 */
138#define SYNC_IOC_MERGE _IOWR(SYNC_IOC_MAGIC, 3, struct sync_merge_data)
139
140/**
141 * DOC: SYNC_IOC_FILE_INFO - get detailed information on a sync_file
142 *
143 * Takes a struct sync_file_info. If num_fences is 0, the field is updated
144 * with the actual number of fences. If num_fences is > 0, the system will
145 * use the pointer provided on sync_fence_info to return up to num_fences of
146 * struct sync_fence_info, with detailed fence information.
147 *
148 * This is the new version of the Sync API after the de-stage that happened
149 * on Linux kernel 4.7.
150 */
151#define SYNC_IOC_FILE_INFO _IOWR(SYNC_IOC_MAGIC, 4, struct sync_file_info)
152
153/* timeout in msecs */ 106/* timeout in msecs */
154int sync_wait(int fd, int timeout); 107int sync_wait(int fd, int timeout);
155int sync_merge(const char *name, int fd1, int fd2);
156struct sync_fence_info_data *sync_fence_info(int fd); 108struct sync_fence_info_data *sync_fence_info(int fd);
157struct sync_pt_info *sync_pt_info(struct sync_fence_info_data *info, 109struct sync_pt_info *sync_pt_info(struct sync_fence_info_data *info,
158 struct sync_pt_info *itr); 110 struct sync_pt_info *itr);
diff --git a/libsync/libsync.map.txt b/libsync/libsync.map.txt
new file mode 100644
index 000000000..daa28ae92
--- /dev/null
+++ b/libsync/libsync.map.txt
@@ -0,0 +1,32 @@
1#
2# Copyright 2017 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16
17LIBSYNC {
18 global:
19 sync_merge; # introduced=26
20 sync_get_fence_info; # introduced=26
21 sync_free_fence_info; # introduced=26
22 local:
23 *;
24};
25
26LIBSYNC_PLATFORM {
27 global:
28 sync_wait;
29 sync_fence_info;
30 sync_pt_info;
31 sync_fence_info_free;
32} LIBSYNC_PLATFORM;