Project

General

Profile

TasksFunding » History » Version 256

Denis 'GNUtoo' Carikli, 05/02/2019 03:29 PM
Remove template. The template probably doesn't apply to the graphics fund which needs to be updated to match the one sent

1 1 Denis 'GNUtoo' Carikli
{{>toc}}
2
3 181 Denis 'GNUtoo' Carikli
h1. Funding
4 1 Denis 'GNUtoo' Carikli
5 181 Denis 'GNUtoo' Carikli
h2. Funding procedure
6
7 247 Denis 'GNUtoo' Carikli
h3. Tasks accepted for funding
8 186 Denis 'GNUtoo' Carikli
9 247 Denis 'GNUtoo' Carikli
* [[Tasks_funding#"Finish porting Replicant to a newer Android version" nlnet Grant application|Finish porting Replicant to a newer Android version]]
10 248 Denis 'GNUtoo' Carikli
* [[TasksFunding#Graphics-acceleration|Graphics acceleration]]
11 84 Denis 'GNUtoo' Carikli
12
h3. Applicant criteria
13
14 249 Denis 'GNUtoo' Carikli
* -The applicants will need to already have Patches in Replicant to apply. So if you want to apply and don't have any patches in Replicant, the easiest way is just to send some useful patches.-
15
* -The applicants will need to be able to demonstrate that they have the required skills by showing contributions in free and open source project in similar areas.-
16
* -The applicants will need to be able to do contract work-
17
18
The application criteria wrere handled by the NLnet foundation.
19 93 Denis 'GNUtoo' Carikli
20 84 Denis 'GNUtoo' Carikli
h3. Discussions
21
22
There is "a thread about funding on the mailing list":https://lists.osuosl.org/pipermail/replicant/2019-January/001774.html about that
23 76 Denis 'GNUtoo' Carikli
24 250 Denis 'GNUtoo' Carikli
h2. Port Replicant to a newer Android version
25 113 Denis 'GNUtoo' Carikli
26
Replicant is currently based on LineageOS 13 which is based on Android 6.0.
27
It is becoming very urgent to upgrade Replicant to a newer release of Android, as Android 6.0 is not supported anymore. It would probably also make it way easier to fix the following issues:
28
* Replicant is currently lagging behind with security fixes
29
* Replicant cannot be built from a GNU/Linux distribution that follows the Free Software Distribution Guidelines
30
31
*Hardware requirements* :
32
* A computer that is able to build Replicant.
33
* A smartphone or tablet that can easily supported by the new version of Replicant and that meet Android 9 [[HardwareRequirements]].
34
35
*Expected outcomes*:
36
* Remove all proprietary components of LineageOS and make sure that Replicant follows the "Free Software Distributions Guidelines (FSDG)":https://www.gnu.org/distros/"
37
* Port all the changes needed to successfully boot without any proprietary software in Replicant
38
* Make sure that most of the security issues are fixed, and lower the attack surface if possible.
39
* Make sure that Replicant can be built on a GNU/Linux distribution that follows the "Free Software Distributions Guidelines (FSDG)":https://www.gnu.org/distros/
40
* Rebrand LineageOS as Replicant
41
42 254 Denis 'GNUtoo' Carikli
*Funding*: We applied to https://nlnet.nl/PET
43 251 Denis 'GNUtoo' Carikli
44 254 Denis 'GNUtoo' Carikli
h3. NLnet foundation Grant application for "Finish porting Replicant to a newer Android version"
45 253 Denis 'GNUtoo' Carikli
46
h4. Contact information:
47
48
|_. Your name | Denis Carikli |
49
|_. Email address | [[PrivateContact#Email]] + our contact at the FSF |
50
|_. Phone numbers | GNUtoo's phone number |
51
|_. Organisation | Replicant and the FSF |
52
|_. Country | France(Denis Carikli), USA (FSF) |
53
54
h4. General project information
55
56 125 Denis 'GNUtoo' Carikli
|_. Project name | Finish porting Replicant to a newer Android version |
57 128 Denis 'GNUtoo' Carikli
|_. Website / wiki | https://redmine.replicant.us/projects/replicant/wiki/Porting_Replicant_to_Android_9 |
58 253 Denis 'GNUtoo' Carikli
|_. Abstract: Can you explain the whole project and its expected outcome(s).in 1200 characters | <pre>
59 196 Denis 'GNUtoo' Carikli
Replicant is a fully free software Android distribution which
60 1 Denis 'GNUtoo' Carikli
is approved by the FSF (http://gnu.org/distros).
61 196 Denis 'GNUtoo' Carikli
62
The combination of Android Open Source Project source code with
63
the Linux source code provided by the device vendor is not
64 216 Denis 'GNUtoo' Carikli
sufficient to produce a fully free Android distribution that
65 196 Denis 'GNUtoo' Carikli
works: a lot of the code that makes critical hardware components
66 216 Denis 'GNUtoo' Carikli
work (the modem, graphics, audio, GPS, etc) is in userspace.
67 196 Denis 'GNUtoo' Carikli
Because of that, most device manufacturers don't release them as
68 195 Denis 'GNUtoo' Carikli
free software.
69 196 Denis 'GNUtoo' Carikli
70
To make such hardware work, the Replicant project manages to
71 216 Denis 'GNUtoo' Carikli
replace or avoid such nonfree software.
72 196 Denis 'GNUtoo' Carikli
73
Replicant is currently based on LineageOS 13.0 which in turn is based
74 216 Denis 'GNUtoo' Carikli
on Android 6.0.1 which are both not supported anymore. Replicant is
75 196 Denis 'GNUtoo' Carikli
based on LineageOS because it supports way more smartphones and
76
tablets than the Android Open Source Project.
77 1 Denis 'GNUtoo' Carikli
78
The project consists in porting Replicant changes on top of the
79
Android 9 release of the Android Open Source project,
80
and when LineageOS 16 will be ready, to backport our changes on
81
top of LineageOS 16.
82 253 Denis 'GNUtoo' Carikli
</pre> |
83 1 Denis 'GNUtoo' Carikli
|_. Have you been involved with projects or organizations relevant to this project before?
84 253 Denis 'GNUtoo' Carikli
And if so, can you tell us a bit about your contributions? | Yes: I've been involved in Replicant since the beginning both as a developer and for managing the project:
85
As a developer:
86
* I did most/all the initial system work and made it work for the the HTC Dream, and the Google Nexus One.
87
* I also worked on porting the Goldelico GTA04, Galaxy nexus, Galaxy Tab 2 7.1 along with other Replicant developers and did various bug fixes and improvements.
88
* I am also doing code reviews for patches.
89
And as for managing the project I'm involved in:
90
* public relations (blog posts, etc)
91
* fund usage decisions
92
* infrastructure (system administration with other developers, etc)
93
* documentation
94
* project direction and strategic decisions |
95 1 Denis 'GNUtoo' Carikli
96 253 Denis 'GNUtoo' Carikli
h4. Requested support
97
98 140 Denis 'GNUtoo' Carikli
|_. Requested Amount (Between 5000 and 50000 Euros) | 50000 Euros |
99 253 Denis 'GNUtoo' Carikli
|_. Does the project have other funding sources, both past and present? | 
100
The Replicant project has about 200000 dollars at disposition:
101
* The Replicant project has a donation page https://crm.fsf.org/civicrm/contribute/transact?reset=1&id=19. Part of the donations were used for buying devices and reimburse conference attendances. We have about 20000 dollars remaining from the donation.
102
* The Replicant project recently received 200000 dollars from Handshake: https://www.fsf.org/news/free-software-foundation-receives-1-million-from-handshake As the FSF takes 10% that leaves us 180000 dollars |
103 190 Denis 'GNUtoo' Carikli
104
Explain what the requested budget will be used for? 
105
<pre>
106 189 Denis 'GNUtoo' Carikli
The budget will only be used to fund this task through contract work.
107 217 Denis 'GNUtoo' Carikli
108 133 Denis 'GNUtoo' Carikli
We think it will take something between 3 and 6 months of work
109
for one full time developer.
110
111 217 Denis 'GNUtoo' Carikli
However it is always difficult to evaluate precisely the amount of time
112
that this kind of project would take as sometimes it can be slowed down
113 155 Denis 'GNUtoo' Carikli
a lot due to bugs needing to be fixed.
114
115
For instance, when adding support for the Nexus One to Replicant,
116
a lot of time was spent dealing with display issues that didn't affect
117 1 Denis 'GNUtoo' Carikli
the upstream projects, because they relied on the GPU which required
118
nonfree software to work.
119
120
If we take the cost of a Freelance developer in the USA (75$ to 150$
121
per hour) as a basis, to enable people living in Europe and the USA
122
to apply, we can fund a developer to work on it for a period that
123
is mostly equivalent to something between 2 to 4 months full
124
time.
125 169 Denis 'GNUtoo' Carikli
126
So far we have at least one person interested in working on it
127
as a contractor (me), and one volunteer who wants to work on it at the
128
same time, but who cannot do it full time. We will make sure
129 155 Denis 'GNUtoo' Carikli
that everybody has a chance to apply for doing contract work.
130
131
If the work is not done when the 50000E run out, and if we cannot
132 217 Denis 'GNUtoo' Carikli
make sure that it will be completed by volunteers in a reasonable
133
timeframe, the Replicant project will most probably use its existing
134
funds to pay for contract work to make sure that this task is completed.
135
136 155 Denis 'GNUtoo' Carikli
The Replicant project will also take care of ensuring that the
137 217 Denis 'GNUtoo' Carikli
people that will work on this task have the necessary hardware to
138
do it, for instance by shipping or reimbursing the purchase of a
139
compatible smartphone with the Replicant project money.
140 191 Denis 'GNUtoo' Carikli
141
Once we have the Samsung Galaxy SIII fully working with
142 217 Denis 'GNUtoo' Carikli
Replicant 9, we will add support for most smartphones
143 191 Denis 'GNUtoo' Carikli
and tablets we currently support in Replicant, and add support
144
for more recent smartphones (the most recent one we currently
145 171 Denis 'GNUtoo' Carikli
support has been released in 2013).
146 1 Denis 'GNUtoo' Carikli
147 217 Denis 'GNUtoo' Carikli
We also have a very basic documentation on the Android 9 port here:
148
https://redmine.replicant.us/projects/replicant/wiki/Porting_Replicant_to_Android_9
149
</pre>
150 1 Denis 'GNUtoo' Carikli
151 217 Denis 'GNUtoo' Carikli
Compare your own project with existing or historical efforts.
152 168 Denis 'GNUtoo' Carikli
<pre>
153
Upgrading Replicant to a new Android version usually took about 2 or 3
154
months of full-time equivalent work for one person.
155 170 Denis 'GNUtoo' Carikli
Here, we already have a device (The Galaxy SIII 4G) booting under Android 9
156
master before the release, with a kernel that is closely based on upstream
157
Linux, but a lot still needs to be done (modem, audio, sensors, etc) and
158 132 Denis 'GNUtoo' Carikli
validated. The Android architecture also changed a lot more between Android
159
6.0.1 and Android 9 than it did when we ported Replicant to newer Android
160 217 Denis 'GNUtoo' Carikli
versions.
161
</pre>
162
163
What are significant technical challenges you expect to solve during the project, if any?
164
<pre>
165 76 Denis 'GNUtoo' Carikli
We will also need to make sure that Replicant 9 can be built with a
166
GNU/Linux distribution that is approved by the FSF. This could be
167
challenging if they lack some of the packages required to build Android.
168 1 Denis 'GNUtoo' Carikli
</pre>
169
170
Describe the ecosystem of the project, and how you will engage with relevant actors and promote the outcomes?
171
<pre>
172
This project will re-use code from several projects such as Android,
173
drm-hwcomposer, Mesa and Lima driver. Whenever possible we will foster
174
collaboration with these projects and submit our changes upstream.
175
176
The Replicant project contributors and the FSF will supervise
177 253 Denis 'GNUtoo' Carikli
contractors to do the work.
178
179
A blog post will announce that the Replicant project
180
has got some funding for this specific task, and that it is
181
looking for a contractor to work on it. This is to make sure
182
that everyone has equal chances in the application process.
183
184
Then the most suited contractor will be selected. Only contractors
185
that already have worked on similar tasks as part of free and open
186
source software projects will be chosen. This way we can look at
187
their existing contributions and make sure that they are able to
188
do the task before engaging with them.
189
190
The Replicant project will also make sure that the contractor has
191
or gets the hardware required to work on the task, before starting
192
to work on it.</pre>
193
194
|_. Attachments | None |
195 256 Denis 'GNUtoo' Carikli
196
h4. How may we handle your information
197
198
|_. What should we do in the other case,
199
 e.g. when your project is not immediately selected? | I allow NLnet Foundation to keep the information I submit on record, should future funding opportunities arise |
200
|_. Send me a copy of this application. | check-box checked |
201
|_. PGP pubkey | None (if we use Replicant contact address, we can't encrypt to it) |
202 250 Denis 'GNUtoo' Carikli
203 165 dl lud
h2. Graphics acceleration
204 1 Denis 'GNUtoo' Carikli
205 173 dl lud
Currently, all supported devices on Replicant lack a free software driver for their GPU. This means that OpenGL ES (GLES) rendering must be done on the CPU (software rendering). The current approach to software rendering on Replicant 6 is based on "libAGL":https://android.googlesource.com/platform/frameworks/native/+/master/opengl, an optimized GLES 1.x implementation that uses "libpixelflinger":https://android.googlesource.com/platform/system/core/+log/master/libpixelflinger software renderer. Development on both these libraries ceased in 2013 and no work was done to support newer GLES versions.
206 226 dl lud
The major consequences of this are that:
207 173 dl lud
* Critical applications like web browsers crash due to lack of GLES 2.0 (#705). Replicant currently uses an out-dated browser that has many security flaws.
208 1 Denis 'GNUtoo' Carikli
* Replicant relies on patches to the Android framework to make things like the camera application work.
209 166 dl lud
* The rendering speed has degraded over the newer Android versions, like Android 6. Even applications that do not crash become difficult to use due to the huge rendering delays.
210 235 dl lud
211 1 Denis 'GNUtoo' Carikli
This task aims to fix all these severe issues by putting together a new graphics stack for the Android 9 port. This new graphics stack must be compatible with Android 9 Hardware Abstraction Layers (HAL) and provide at least GLES 2.0 rendering. It should be flexible enough to do software rendering with "Mesa":https://www.mesa3d.org/intro.html or "SwiftShader":https://swiftshader.googlesource.com/SwiftShader (Google's current software renderer), and also GPU rendering on devices where a free GPU driver is available.
212 235 dl lud
213 1 Denis 'GNUtoo' Carikli
"Joonas Kylmälä":https://redmine.replicant.us/users/8585 has done some introductory work on the Android 9 port for the i9305, and found a way to have it rendering to the screen. He put together a graphics stack composed of: gbm_gralloc ("Gralloc HAL":https://source.android.com/devices/graphics/implement#gralloc_hal) + drm_hwcomposer ("Hardware Composer HAL":https://source.android.com/devices/graphics/implement#hardware_composer_hal) + Mesa with kms_swrast driver with softpipe backend (CPU software renderer for GLES). This will be the starting point for this task.
214 235 dl lud
215 1 Denis 'GNUtoo' Carikli
Joonas' prototype shows that Replicant can use "gbm_gralloc":https://osdn.net/projects/android-x86/scm/git/external-gbm_gralloc/summary, an existing graphics memory allocator (gralloc) HAL maintained(ish) by Android-x86, in conjunction with "drm-hwcomposer":https://gitlab.freedesktop.org/drm-hwcomposer/drm-hwcomposer, a libre implementation of Android's Hardware Composer HAL based on Linux's DRM, to achieve software rendering with Mesa. This solution avoids the need to write a custom gralloc for Replicant, and takes advantage of the hardware acceleration for composition provided by drm-hwcomposer on devices with a free software DRM driver (e.g. exynos-based smartphones and tablets).
216 236 dl lud
217 237 dl lud
Much more testing is needed to confirm that gbm_gralloc can be the definitive gralloc HAL on Replicant 9. It still wasn't tried with SwiftShader, or even Mesa's llvmpipe backend, which is a must since the softpipe backend is too slow to be usable.
218 235 dl lud
Joonas' tests showed that some other components will need our attention, mostly the drm/exynos driver. In order to make drm/exynos work with gbm_gralloc and drm-hwcomposer Joonas had to disable "DRM-Auth":https://en.wikipedia.org/wiki/Direct_Rendering_Manager#DRM-Master_and_DRM-Auth and hack some missing pixel formats into it by using the default pixel format for everything. Besides drm/exynos, we will also have to make the graphics stack work with the "virtual GEM (vGEM) driver":https://www.phoronix.com/scan.php?page=news_item&px=DRM-vGEM-Mesa-Software, in order to support devices that lack a real drm driver.
219
220
The major and first goal of this task is thus to build upon Joonas's prototype and put together a stable and fully free graphics stack, compatible with GLES 2.0, that does software rendering through Mesa's llvmpipe with a decent performance.
221 1 Denis 'GNUtoo' Carikli
222 165 dl lud
*Hardware requirements*: A computer that is able to build Replicant. A Samsung Galaxy S3 or S3 4G to run the [[Porting_Replicant_to_Android_9|current Replicant 9 port]].
223 1 Denis 'GNUtoo' Carikli
224
*Difficulty*: Medium / Hard
225
226
*Requirements/Prerequisites*: Knowledge of C++, kernel interfaces knowledge or the ability to learn them
227
228 235 dl lud
*Expected outcomes*:
229 226 dl lud
* Graphics stack with decent performance on software rendering
230 1 Denis 'GNUtoo' Carikli
* Working GLES 2.0 implementation
231
* Fast enough graphics
232 209 dl lud
* F-Droid applications not crashing anymore because of GLES.
233 1 Denis 'GNUtoo' Carikli
234 210 dl lud
*Time +estimation+*:
235 1 Denis 'GNUtoo' Carikli
236 237 dl lud
|_. Step |_. man-hours |
237
| Set up the development environment, including the current Replicant 9 port on the test device. |>. 24 |
238
| Read AOSP documentation and understand all details of the graphics stack. |>. 16 |
239
| Adapt the build files to use Mesa's llvmpipe backend instead of softpipe. Fix potential LLVM version incompatibilities between Mesa and Android. |>. 40 |
240
| Properly implement the missing pixel formats in drm/exynos and try to have it merged into upstream. |>. 72 |
241
| Find a proper way to use DRM-Master and DRM-Auth with gbm_gralloc and drm-hwcomposer. |>. 40 |
242 238 dl lud
| Create test scenarios and check if the graphics stack works as expected. Consider "alternative grallocs":https://redmine.replicant.us/projects/replicant/wiki/GraphicsResearch#Gralloc if necessary. |>. 40 |
243 234 dl lud
| Make the graphics stack work with vGEM driver besides drm/exynos. |>. 40 |
244 1 Denis 'GNUtoo' Carikli
| Document the design decisions. |>. 16 |
245
|_. TOTAL |_>. 288 |
246 252 Denis 'GNUtoo' Carikli
247 1 Denis 'GNUtoo' Carikli
h3. Subtasks
248
249 235 dl lud
The following sub-tasks could also be worked on after finishing writing the gralloc:
250 1 Denis 'GNUtoo' Carikli
* [[Tasks_funding#SwiftShader|SwiftShader]]
251
* [[Tasks_funding#llvmpipe optimizations|llvmpipe optimizations]]
252
* [[Tasks_funding#Lima driver|Lima driver]]
253 252 Denis 'GNUtoo' Carikli
254 235 dl lud
h3. SwiftShader
255 238 dl lud
256 1 Denis 'GNUtoo' Carikli
"SwiftShader":https://swiftshader.googlesource.com/SwiftShader is Google's current software renderer that is capable of GLES 2.0 and is now "under work to support Vulkan":https://swiftshader.googlesource.com/SwiftShader/+log/master.
257 238 dl lud
258 232 dl lud
Mesa is the preferred renderer on Replicant for several reasons such as its support for both software and hardware (GPU) rendering, and its big community, with hundreds of active contributors. However, Mesa lacks a Vulkan software renderer. With Vulkan soon becoming a "requirement for new Android versions":https://android-developers.googleblog.com/2019/03/introducing-android-q-beta.html, we must make sure that Replicant's graphics stack can use SwiftShader in order to become futureproof. Furthermore, SwiftShader was built with performance in mind, specially for ARM CPUs, and may bring speed improvements on some devices.
259 238 dl lud
260 233 dl lud
The goal of this sub-task is thus to create a compile-time or run-time option that allows using Replicant 9 with SwiftShader as it's software renderer instead of Mesa.
261 232 dl lud
262 1 Denis 'GNUtoo' Carikli
*Hardware requirements*: A computer that is able to build Replicant. A smartphone or tablet that is supported by Replicant to be able to test the result.
263
264
*Difficulty*: Medium
265
266
*Requirements/Prerequisites*: Knowledge of C++, Makefiles and git. Android's graphics stack knowledge or the ability to learn them.
267
268 238 dl lud
*Expected outcomes*:
269
* SwiftShader running on Replicant.
270 1 Denis 'GNUtoo' Carikli
* Working Vulkan implementation.
271 211 dl lud
272
*Time +estimation+*: 40 man-hours.
273 252 Denis 'GNUtoo' Carikli
274 1 Denis 'GNUtoo' Carikli
h3. llvmpipe optimizations
275
276
Mesa is a highly versatile library that can be extended with device drivers to allow it to be used in different environments ranging from software emulation to complete hardware acceleration. One such driver is the "Gallium llvmpipe driver":https://www.mesa3d.org/llvmpipe.html, which is a software rasterizer that uses LLVM to do runtime code generation. It only needs a CPU to run graphics computations and thus brings full GLES support to all Replicant devices.
277
278
"llvmpipe has been integrated in Replicant 6":https://git.replicant.us/replicant/external_mesa3d/log/ but it's not activated by default yet as it is very slow. It is also not fully complete.
279
280
To fix that, llvmpipe and/or the integration of it in Replicant should be optimized. We should first start by configuring llvmpipe and/or Mesa "to not implement very expensive OpenGL operations":https://www.mesa3d.org/perf.html. If that's not sufficient, or if that breaks application compatibility, various software or hardware features ("ARM NEON":https://www.arm.com/products/processors/technologies/neon.php, hardware 2D acceleration, etc) could be used to improve the speed.
281 231 dl lud
282
Considerable speed improvements may be achieved with a fine-tuned emulation for division instructions. The ARM cores on many Replicant devices do not have hardware "support for the SDIV/UDIV instructions":https://community.arm.com/processors/b/blog/posts/divide-and-conquer. We should profile some apps and check whether GLES functions requiring divisions are to blame for the poor performance.
283 1 Denis 'GNUtoo' Carikli
284
*Hardware requirements* : A computer that is able to build Replicant. A smartphone or tablet that is supported by Replicant to be able to test the result.
285
286
*Difficulty*: Medium / Hard (depending on the amount of optimizations required)
287
288
*Requirements/Prerequisites*: See with Mesa project
289
290 211 dl lud
*Expected outcomes*: faster llvmpipe on ARM devices, able to run apps such as Fennec F-Droid (Firefox).
291
292
*Time +estimation+*:
293
294 234 dl lud
|_. Step |_. man-hours |
295
| Setup a "testing and benchmarking environment":https://source.android.com/devices/graphics/testing |>. 40 |
296
| Disable expensive OpenGL operations. Check speedup and stability. |>. 24 |
297
| Recap matrix operations (Linear Algebra) and study ARM NEON. |>. 48 |
298 242 dl lud
| Do a profiling of several apps to find the most used GLES operations. |>. 32 |
299 234 dl lud
| Use "Ne10 library":https://github.com/projectNe10/Ne10 or "Neon Intrinsics":https://developer.arm.com/architectures/instruction-sets/simd-isas/neon/intrinsics for the most used GLES operations. |>. 80 |
300
| Fix bugs, re-write the code where needed, get it stable. |>. 80 |
301 1 Denis 'GNUtoo' Carikli
|_. TOTAL |_>. 304 |
302 252 Denis 'GNUtoo' Carikli
303 1 Denis 'GNUtoo' Carikli
h3. Lima driver
304
305
"Lima":https://gitlab.freedesktop.org/lima is a free software Mesa driver for ARM Mali-4xx (Utgard) GPUs. These GPUs are present in several Replicant supported devices such as Galaxy S2, S3, S3 4G, Note and Note 2. 
306
307
Lima aims to full GLES support but it is still in development. However the "current implementation status":https://gitlab.freedesktop.org/lima/mesa/issues/39#note_79193 already allows the hardware acceleration of several tasks. GPU-based hardware acceleration is faster and less power hungry than software rendering, both by several orders of magnitude. It would allow Replicant devices to run applications with a performance close to that of non-free devices.
308 167 dl lud
309
*Hardware requirements* : A computer that is able to build Replicant. A Replicant device with a Mali-4xx GPU that can run mainline Linux (e.g. Galaxy S3 or Note 2).
310
311
*Difficulty*: Medium
312
313
*Requirements/Prerequisites*: "See with Lima project":https://gitlab.freedesktop.org/lima/web/wikis/home#build-and-install
314 1 Denis 'GNUtoo' Carikli
315 212 dl lud
*Expected outcomes*: Lima driver being used for GLES rendering on a supported device.
316
317 234 dl lud
|_. Step |_. man-hours |
318
| Rebase "Lima's Linux kernel DRM driver":https://gitlab.freedesktop.org/lima/linux on top of "forkbomb's Midas on Mainline kernel":https://blog.forkwhiletrue.me/pages/midas-mainline/. |>. 80 |
319
| Replace mainline Mesa for "Lima's Mesa":https://gitlab.freedesktop.org/lima/mesa (with their driver).  |>. 16 |
320
| Build and test thoroughly with "synthetic":https://source.android.com/devices/graphics/testing and real applications. |>. 40 |
321
| Create a fallback mechanism that uses the software renderer for GLES functions not yet implemented in Lima. |>. 100 |
322 222 dl lud
|_. TOTAL |_>. 236 |
323 252 Denis 'GNUtoo' Carikli
324 243 dl lud
h3. Software Bill of Materials
325
326
* "Replicant 9":https://redmine.replicant.us/projects/replicant/wiki/Porting_Replicant_to_Android_9
327
* "Mesa":https://www.mesa3d.org/intro.html (in particular: "Gallium llvmpipe driver":https://www.mesa3d.org/llvmpipe.html)
328
* "gbm_gralloc":https://osdn.net/projects/android-x86/scm/git/external-gbm_gralloc/summary
329
* "drm-hwcomposer":https://gitlab.freedesktop.org/drm-hwcomposer/drm-hwcomposer
330
* "Linux kernel":https://www.kernel.org/ (in particular: drm/exynos driver and "vGEM driver":https://www.phoronix.com/scan.php?page=news_item&px=DRM-vGEM-Mesa-Software)
331
* "SwiftShader":https://swiftshader.googlesource.com/SwiftShader
332
* "Ne10 library":https://github.com/projectNe10/Ne10
333
* "Neon Intrinsics":https://developer.arm.com/architectures/instruction-sets/simd-isas/neon/intrinsics
334
* "Lima":https://gitlab.freedesktop.org/lima
335 252 Denis 'GNUtoo' Carikli
336 222 dl lud
h3. "Graphics acceleration on Replicant" nlnet Grant application
337
338
|_. Project name | Graphics acceleration on Replicant |
339
|_. Website / wiki | https://redmine.replicant.us/projects/replicant/wiki/Tasks_funding#Graphics-acceleration |
340
341
Abstract: Can you explain the whole project and its expected outcome(s) in 1200 characters
342
<pre>
343
Replicant is a fully free software Android distribution which is approved by the
344
FSF. All supported devices on Replicant currently lack a free software driver
345
for their GPU. As such, OpenGL ES (GLES) rendering must be done on the CPU
346
through software rendering (SR).
347 223 dl lud
348 222 dl lud
Replicant's current renderer is both incomplete and slow. It causes essential
349
apps like web browsers to crash due to lack of GLES 2.0, and many other
350
apps run too slow to be usable.
351
352
This project aims to fix this by complementing Android's 9 graphics stack.
353
Adding a few missing components will created of a fully-free, fast and compliant
354
graphics stack.
355
356
First we will write a gralloc (graphics memory allocator) tailored for SR that
357
is compatible with drm-hwcomposer (a libre implementation of Android's Hardware
358
Composer HAL). This gralloc enables drm-hwcomposer to work with SurfaceFlinger
359
and SwiftShader, creating a stack capable of GLES 2.0 on the CPU of all Replicant
360
devices.
361
362
Afterwards we will integrate and optimize Mesa's llvmpipe SR, which offers better
363
community support than SwiftShader. As last step we will add support for the
364
Lima driver, which will bring an even faster GPU-backed GLES to at least 5
365
devices.
366
</pre> 
367
368
|_. Have you been involved with projects or organizations relevant to this project before?
369
And if so, can you tell us a bit about your contributions? | SEE TEMPLATE |
370
371
|_. Requested Amount (Between 5000 and 50000 Euros) | 50000 Euros |
372
|_. Does the project have other funding sources, both past and present? | SEE TEMPLATE |
373
374 1 Denis 'GNUtoo' Carikli
Explain what the requested budget will be used for? 
375 223 dl lud
<pre>
376 1 Denis 'GNUtoo' Carikli
The budget will only be used to fund this project through contract work.
377 223 dl lud
378
We estimate that this project should take 868 man-hours to reach full completion,
379
with 632 man-hours being enough to reach all software rendering goals, leaving only
380
the GPU rendering to be done. A detailed run-down of this estimate is available at
381
https://redmine.replicant.us/projects/replicant/wiki/Tasks_funding#Graphics-acceleration
382
383
So far we have a team of two people interested on working on this project (the
384
two authors and submitters of this application). Both can commit to the project
385
on a part-time regime (17.5 hours per week), which means that the project should
386
be fully completed in about 6 months.
387
388
We will make sure that everybody has a chance to apply for doing contract work.
389
If we take the cost of a freelance developer in the USA (75 to 150 USD
390
per hour) as a basis, to enable people living in Europe and the USA
391
to apply, we can fund between 380 and 760 man-hours with the 50000 EUR budget.
392
This should be enough to cover all work on software rendering plus the initial
393
work on GPU rendering.
394
395
As happens on all software projects, getting a precise time/effort evaluation is
396
a difficult endeavour, specially when dealing with a project that is heavy on
397
research such as this one.
398
399
If the software rendering goals are not reached when the 50000 EUR budget runs
400
out, or if the Replicant project deems it necessary to have GPU rendering, it
401
will use its existing funds to pay for contract work if no volunteers are found
402
to finish the project.
403
404
The Replicant project will also make sure that the people working on this project
405
have the necessary hardware to do it, for instance by shipping or reimbursing the
406 222 dl lud
purchase of a compatible smartphone with the Replicant project funds.
407
</pre>
408
409
Compare your own project with existing or historical efforts.
410 224 dl lud
<pre>
411
Past Replicant versions have relied on patches to the Android framework to make
412
software rendering work. These patches were quite specific for Replicant and
413
had no use elsewhere. This made them unfit for upstreaming or sharing with any
414 222 dl lud
other project.
415 224 dl lud
416
Android's Project Treble new graphics stack allows us to follow a different
417
approach this time. Instead of patching the Android framework, we will
418
implement one of the well defined Android HALs (Hardware Abstraction Layer):
419
the gralloc HAL. The end result will be a software library that can prove to be
420
useful on several projects besides Replicant (e.g. Android-x86 project) and
421
thus fit for upstreaming.
422
423
424
Furthermore, past Replicant versions relied on Google's software renderers
425
(ligAGL and libpixelflinger) for OpenGL ES support. As quite a few other
426
Google's open-source projects, these two had no community behind them and got
427
stalled as soon as Google deprecated them.
428
429
This time will we take a different approach. Although our first graphics stack
430
will rely on Google's SwiftShader renderer, we will then move our efforts into
431
Mesa. Mesa is a big community project, with hundreds of active contributors and
432
great community support. It includes the llvmpipe software renderer along with
433
new drivers in development for GPUs present on current and future Replicant
434 222 dl lud
devices. Mesa should provide a stable and maintained platform for years to come.
435
</pre>
436
437
What are significant technical challenges you expect to solve during the project, if any?
438 225 dl lud
<pre>
439
We expect to solve significant technical challenges during this project:
440
1. Implementation of the first Android gralloc library compatible with software
441
rendering.
442
2. Development of free-software benchmarks for OpenGL ES on Android, used to test
443
our optimizations to llvmpipe.
444
3. Optimization of llvmpipe by at least one order of magnitude.
445
4. Running an exynos based smartphone with fully free-software GPU graphics
446 222 dl lud
acceleration.
447
</pre>
448 229 dl lud
449
Describe the ecosystem of the project, and how you will engage with relevant actors and promote the outcomes?
450
<pre>
451
This project will re-use code from several projects such as Android,
452
drm-hwcomposer, Mesa and Lima driver. Whenever possible we will foster
453
collaboration with these projects and submit our changes upstream.
454
455
The Replicant project contributors and the FSF will supervise
456
contractors to do the work.
457
458
A blog post will announce that the Replicant project
459
has got some funding for this specific task, and that it is
460
looking for a contractor to work on it. This is to make sure
461
that everyone has equal chances in the application process.
462
463
Then the most suited contractor will be selected. Only contractors
464
that already have worked on similar tasks as part of free and open
465
source software projects will be chosen. This way we can look at
466
their existing contributions and make sure that they are able to
467
do the task before engaging with them.
468
469
The Replicant project will also make sure that the contractor has
470
or gets the hardware required to work on the task, before starting
471 1 Denis 'GNUtoo' Carikli
to work on it.
472 229 dl lud
</pre>
473 222 dl lud
474 167 dl lud
|_. Attachments | SEE TEMPLATE |