Project

General

Profile

TasksFunding » History » Version 268

Denis 'GNUtoo' Carikli, 01/14/2020 12:54 PM

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 258 Denis 'GNUtoo' Carikli
h3. Background and rationale for funding work through the NLnet foundation
8
9
The NLnet foundation managed to get some European Union grants to fund work on privacy and trust technologies.
10
11
It's then up to individuals to apply to it, and to define tasks that can improve privacy and trust on the Internet, which then the NLnet foundation can choose to fund.
12
13 260 Denis 'GNUtoo' Carikli
This could for instance be used to fund the advancement of software (Tor, Replicant, etc) and hardware freedom (RISC-V, etc).
14 258 Denis 'GNUtoo' Carikli
15 263 Denis 'GNUtoo' Carikli
The only requirement (beside improving privacy and trust) seem to be that the project needs to have an European Union component (like the people applying for the grant living in the European union, etc).
16 258 Denis 'GNUtoo' Carikli
17 1 Denis 'GNUtoo' Carikli
They are then paid once tasks defined and/or the deliverables mentioned in the task have been completed.
18 260 Denis 'GNUtoo' Carikli
19
The NLnet foundation also have some resources to help pushing changes upstream and try to push the applicants into making their work as useful as possible by engaging with upstream communities.
20 258 Denis 'GNUtoo' Carikli
21
References:
22
* "Fosdem Lightning talks on the topic":https://fosdem.org/2019/schedule/event/nextgen_internet/
23
24 259 Denis 'GNUtoo' Carikli
h3. Tasks accepted for funding by the NLnet foundation
25 186 Denis 'GNUtoo' Carikli
26 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]]
27 248 Denis 'GNUtoo' Carikli
* [[TasksFunding#Graphics-acceleration|Graphics acceleration]]
28 84 Denis 'GNUtoo' Carikli
29 249 Denis 'GNUtoo' Carikli
The application criteria wrere handled by the NLnet foundation.
30 93 Denis 'GNUtoo' Carikli
31 84 Denis 'GNUtoo' Carikli
h3. Discussions
32
33
There is "a thread about funding on the mailing list":https://lists.osuosl.org/pipermail/replicant/2019-January/001774.html about that
34 76 Denis 'GNUtoo' Carikli
35 257 Denis 'GNUtoo' Carikli
h3. Mistakes
36
37 262 Denis 'GNUtoo' Carikli
* When submitting a task to the NLnet Foundation make sure to select a call in "Please select a call", like "NGI Privacy & Trust Enhancing Technologies". I for instance forgot to select the right call.
38
* The amount requested was too high as the grant is not taxed. The amount was changed after the submission and acceptation.
39 257 Denis 'GNUtoo' Carikli
40 250 Denis 'GNUtoo' Carikli
h2. Port Replicant to a newer Android version
41 113 Denis 'GNUtoo' Carikli
42 266 Denis 'GNUtoo' Carikli
h3. Documents
43 264 Denis 'GNUtoo' Carikli
44
MOU:
45 267 Denis 'GNUtoo' Carikli
* "TaTeX source in git":https://git.replicant.us/contrib/GNUtoo/documents/tree/NLnet/porting_replicant_to_android9
46 268 Denis 'GNUtoo' Carikli
* "Signed MOU from GNUtoo":https://redmine.replicant.us/attachments/download/1656/porting_replicant_to_android9_signed_dc.pdf
47 266 Denis 'GNUtoo' Carikli
* "Signed MOU from both parties":https://redmine.replicant.us/attachments/download/1655/2019-02-105_signed.pdf
48 264 Denis 'GNUtoo' Carikli
49
h3. Initial application (modified since)
50
51 113 Denis 'GNUtoo' Carikli
Replicant is currently based on LineageOS 13 which is based on Android 6.0.
52
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:
53
* Replicant is currently lagging behind with security fixes
54
* Replicant cannot be built from a GNU/Linux distribution that follows the Free Software Distribution Guidelines
55
56
*Hardware requirements* :
57
* A computer that is able to build Replicant.
58
* A smartphone or tablet that can easily supported by the new version of Replicant and that meet Android 9 [[HardwareRequirements]].
59
60
*Expected outcomes*:
61
* Remove all proprietary components of LineageOS and make sure that Replicant follows the "Free Software Distributions Guidelines (FSDG)":https://www.gnu.org/distros/"
62
* Port all the changes needed to successfully boot without any proprietary software in Replicant
63
* Make sure that most of the security issues are fixed, and lower the attack surface if possible.
64
* 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/
65
* Rebrand LineageOS as Replicant
66
67 254 Denis 'GNUtoo' Carikli
*Funding*: We applied to https://nlnet.nl/PET
68 251 Denis 'GNUtoo' Carikli
69 254 Denis 'GNUtoo' Carikli
h3. NLnet foundation Grant application for "Finish porting Replicant to a newer Android version"
70 253 Denis 'GNUtoo' Carikli
71
h4. Contact information:
72
73
|_. Your name | Denis Carikli |
74
|_. Email address | [[PrivateContact#Email]] + our contact at the FSF |
75
|_. Phone numbers | GNUtoo's phone number |
76
|_. Organisation | Replicant and the FSF |
77
|_. Country | France(Denis Carikli), USA (FSF) |
78
79
h4. General project information
80
81 125 Denis 'GNUtoo' Carikli
|_. Project name | Finish porting Replicant to a newer Android version |
82 128 Denis 'GNUtoo' Carikli
|_. Website / wiki | https://redmine.replicant.us/projects/replicant/wiki/Porting_Replicant_to_Android_9 |
83 253 Denis 'GNUtoo' Carikli
|_. Abstract: Can you explain the whole project and its expected outcome(s).in 1200 characters | <pre>
84 196 Denis 'GNUtoo' Carikli
Replicant is a fully free software Android distribution which
85 1 Denis 'GNUtoo' Carikli
is approved by the FSF (http://gnu.org/distros).
86 196 Denis 'GNUtoo' Carikli
87
The combination of Android Open Source Project source code with
88
the Linux source code provided by the device vendor is not
89 216 Denis 'GNUtoo' Carikli
sufficient to produce a fully free Android distribution that
90 196 Denis 'GNUtoo' Carikli
works: a lot of the code that makes critical hardware components
91 216 Denis 'GNUtoo' Carikli
work (the modem, graphics, audio, GPS, etc) is in userspace.
92 196 Denis 'GNUtoo' Carikli
Because of that, most device manufacturers don't release them as
93 195 Denis 'GNUtoo' Carikli
free software.
94 196 Denis 'GNUtoo' Carikli
95
To make such hardware work, the Replicant project manages to
96 216 Denis 'GNUtoo' Carikli
replace or avoid such nonfree software.
97 196 Denis 'GNUtoo' Carikli
98
Replicant is currently based on LineageOS 13.0 which in turn is based
99 216 Denis 'GNUtoo' Carikli
on Android 6.0.1 which are both not supported anymore. Replicant is
100 196 Denis 'GNUtoo' Carikli
based on LineageOS because it supports way more smartphones and
101
tablets than the Android Open Source Project.
102 1 Denis 'GNUtoo' Carikli
103
The project consists in porting Replicant changes on top of the
104
Android 9 release of the Android Open Source project,
105
and when LineageOS 16 will be ready, to backport our changes on
106
top of LineageOS 16.
107 253 Denis 'GNUtoo' Carikli
</pre> |
108 1 Denis 'GNUtoo' Carikli
|_. Have you been involved with projects or organizations relevant to this project before?
109 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:
110
As a developer:
111
* I did most/all the initial system work and made it work for the the HTC Dream, and the Google Nexus One.
112
* 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.
113
* I am also doing code reviews for patches.
114
And as for managing the project I'm involved in:
115
* public relations (blog posts, etc)
116
* fund usage decisions
117
* infrastructure (system administration with other developers, etc)
118
* documentation
119
* project direction and strategic decisions |
120 1 Denis 'GNUtoo' Carikli
121 253 Denis 'GNUtoo' Carikli
h4. Requested support
122
123 140 Denis 'GNUtoo' Carikli
|_. Requested Amount (Between 5000 and 50000 Euros) | 50000 Euros |
124 253 Denis 'GNUtoo' Carikli
|_. Does the project have other funding sources, both past and present? | 
125
The Replicant project has about 200000 dollars at disposition:
126
* 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.
127
* 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 |
128 190 Denis 'GNUtoo' Carikli
129
Explain what the requested budget will be used for? 
130
<pre>
131 189 Denis 'GNUtoo' Carikli
The budget will only be used to fund this task through contract work.
132 217 Denis 'GNUtoo' Carikli
133 133 Denis 'GNUtoo' Carikli
We think it will take something between 3 and 6 months of work
134
for one full time developer.
135
136 217 Denis 'GNUtoo' Carikli
However it is always difficult to evaluate precisely the amount of time
137
that this kind of project would take as sometimes it can be slowed down
138 155 Denis 'GNUtoo' Carikli
a lot due to bugs needing to be fixed.
139
140
For instance, when adding support for the Nexus One to Replicant,
141
a lot of time was spent dealing with display issues that didn't affect
142 1 Denis 'GNUtoo' Carikli
the upstream projects, because they relied on the GPU which required
143
nonfree software to work.
144
145
If we take the cost of a Freelance developer in the USA (75$ to 150$
146
per hour) as a basis, to enable people living in Europe and the USA
147
to apply, we can fund a developer to work on it for a period that
148
is mostly equivalent to something between 2 to 4 months full
149
time.
150 169 Denis 'GNUtoo' Carikli
151
So far we have at least one person interested in working on it
152
as a contractor (me), and one volunteer who wants to work on it at the
153
same time, but who cannot do it full time. We will make sure
154 155 Denis 'GNUtoo' Carikli
that everybody has a chance to apply for doing contract work.
155
156
If the work is not done when the 50000E run out, and if we cannot
157 217 Denis 'GNUtoo' Carikli
make sure that it will be completed by volunteers in a reasonable
158
timeframe, the Replicant project will most probably use its existing
159
funds to pay for contract work to make sure that this task is completed.
160
161 155 Denis 'GNUtoo' Carikli
The Replicant project will also take care of ensuring that the
162 217 Denis 'GNUtoo' Carikli
people that will work on this task have the necessary hardware to
163
do it, for instance by shipping or reimbursing the purchase of a
164
compatible smartphone with the Replicant project money.
165 191 Denis 'GNUtoo' Carikli
166
Once we have the Samsung Galaxy SIII fully working with
167 217 Denis 'GNUtoo' Carikli
Replicant 9, we will add support for most smartphones
168 191 Denis 'GNUtoo' Carikli
and tablets we currently support in Replicant, and add support
169
for more recent smartphones (the most recent one we currently
170 171 Denis 'GNUtoo' Carikli
support has been released in 2013).
171 1 Denis 'GNUtoo' Carikli
172 217 Denis 'GNUtoo' Carikli
We also have a very basic documentation on the Android 9 port here:
173
https://redmine.replicant.us/projects/replicant/wiki/Porting_Replicant_to_Android_9
174
</pre>
175 1 Denis 'GNUtoo' Carikli
176 217 Denis 'GNUtoo' Carikli
Compare your own project with existing or historical efforts.
177 168 Denis 'GNUtoo' Carikli
<pre>
178
Upgrading Replicant to a new Android version usually took about 2 or 3
179
months of full-time equivalent work for one person.
180 170 Denis 'GNUtoo' Carikli
Here, we already have a device (The Galaxy SIII 4G) booting under Android 9
181
master before the release, with a kernel that is closely based on upstream
182
Linux, but a lot still needs to be done (modem, audio, sensors, etc) and
183 132 Denis 'GNUtoo' Carikli
validated. The Android architecture also changed a lot more between Android
184
6.0.1 and Android 9 than it did when we ported Replicant to newer Android
185 217 Denis 'GNUtoo' Carikli
versions.
186
</pre>
187
188
What are significant technical challenges you expect to solve during the project, if any?
189
<pre>
190 76 Denis 'GNUtoo' Carikli
We will also need to make sure that Replicant 9 can be built with a
191
GNU/Linux distribution that is approved by the FSF. This could be
192
challenging if they lack some of the packages required to build Android.
193 1 Denis 'GNUtoo' Carikli
</pre>
194
195
Describe the ecosystem of the project, and how you will engage with relevant actors and promote the outcomes?
196
<pre>
197
This project will re-use code from several projects such as Android,
198
drm-hwcomposer, Mesa and Lima driver. Whenever possible we will foster
199
collaboration with these projects and submit our changes upstream.
200
201
The Replicant project contributors and the FSF will supervise
202 253 Denis 'GNUtoo' Carikli
contractors to do the work.
203
204
A blog post will announce that the Replicant project
205
has got some funding for this specific task, and that it is
206
looking for a contractor to work on it. This is to make sure
207
that everyone has equal chances in the application process.
208
209
Then the most suited contractor will be selected. Only contractors
210
that already have worked on similar tasks as part of free and open
211
source software projects will be chosen. This way we can look at
212
their existing contributions and make sure that they are able to
213
do the task before engaging with them.
214
215
The Replicant project will also make sure that the contractor has
216
or gets the hardware required to work on the task, before starting
217
to work on it.</pre>
218
219
|_. Attachments | None |
220 256 Denis 'GNUtoo' Carikli
221
h4. How may we handle your information
222
223
|_. What should we do in the other case,
224
 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 |
225
|_. Send me a copy of this application. | check-box checked |
226
|_. PGP pubkey | None (if we use Replicant contact address, we can't encrypt to it) |
227 250 Denis 'GNUtoo' Carikli
228 165 dl lud
h2. Graphics acceleration
229 1 Denis 'GNUtoo' Carikli
230 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.
231 226 dl lud
The major consequences of this are that:
232 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.
233 1 Denis 'GNUtoo' Carikli
* Replicant relies on patches to the Android framework to make things like the camera application work.
234 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.
235 235 dl lud
236 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.
237 235 dl lud
238 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.
239 235 dl lud
240 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).
241 236 dl lud
242 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.
243 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.
244
245
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.
246 1 Denis 'GNUtoo' Carikli
247 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]].
248 1 Denis 'GNUtoo' Carikli
249
*Difficulty*: Medium / Hard
250
251
*Requirements/Prerequisites*: Knowledge of C++, kernel interfaces knowledge or the ability to learn them
252
253 235 dl lud
*Expected outcomes*:
254 226 dl lud
* Graphics stack with decent performance on software rendering
255 1 Denis 'GNUtoo' Carikli
* Working GLES 2.0 implementation
256
* Fast enough graphics
257 209 dl lud
* F-Droid applications not crashing anymore because of GLES.
258 1 Denis 'GNUtoo' Carikli
259 210 dl lud
*Time +estimation+*:
260 1 Denis 'GNUtoo' Carikli
261 237 dl lud
|_. Step |_. man-hours |
262
| Set up the development environment, including the current Replicant 9 port on the test device. |>. 24 |
263
| Read AOSP documentation and understand all details of the graphics stack. |>. 16 |
264
| Adapt the build files to use Mesa's llvmpipe backend instead of softpipe. Fix potential LLVM version incompatibilities between Mesa and Android. |>. 40 |
265
| Properly implement the missing pixel formats in drm/exynos and try to have it merged into upstream. |>. 72 |
266
| Find a proper way to use DRM-Master and DRM-Auth with gbm_gralloc and drm-hwcomposer. |>. 40 |
267 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 |
268 234 dl lud
| Make the graphics stack work with vGEM driver besides drm/exynos. |>. 40 |
269 1 Denis 'GNUtoo' Carikli
| Document the design decisions. |>. 16 |
270
|_. TOTAL |_>. 288 |
271 252 Denis 'GNUtoo' Carikli
272 1 Denis 'GNUtoo' Carikli
h3. Subtasks
273
274 235 dl lud
The following sub-tasks could also be worked on after finishing writing the gralloc:
275 1 Denis 'GNUtoo' Carikli
* [[Tasks_funding#SwiftShader|SwiftShader]]
276
* [[Tasks_funding#llvmpipe optimizations|llvmpipe optimizations]]
277
* [[Tasks_funding#Lima driver|Lima driver]]
278 252 Denis 'GNUtoo' Carikli
279 235 dl lud
h3. SwiftShader
280 238 dl lud
281 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.
282 238 dl lud
283 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.
284 238 dl lud
285 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.
286 232 dl lud
287 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.
288
289
*Difficulty*: Medium
290
291
*Requirements/Prerequisites*: Knowledge of C++, Makefiles and git. Android's graphics stack knowledge or the ability to learn them.
292
293 238 dl lud
*Expected outcomes*:
294
* SwiftShader running on Replicant.
295 1 Denis 'GNUtoo' Carikli
* Working Vulkan implementation.
296 211 dl lud
297
*Time +estimation+*: 40 man-hours.
298 252 Denis 'GNUtoo' Carikli
299 1 Denis 'GNUtoo' Carikli
h3. llvmpipe optimizations
300
301
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.
302
303
"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.
304
305
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.
306 231 dl lud
307
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.
308 1 Denis 'GNUtoo' Carikli
309
*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.
310
311
*Difficulty*: Medium / Hard (depending on the amount of optimizations required)
312
313
*Requirements/Prerequisites*: See with Mesa project
314
315 211 dl lud
*Expected outcomes*: faster llvmpipe on ARM devices, able to run apps such as Fennec F-Droid (Firefox).
316
317
*Time +estimation+*:
318
319 234 dl lud
|_. Step |_. man-hours |
320
| Setup a "testing and benchmarking environment":https://source.android.com/devices/graphics/testing |>. 40 |
321
| Disable expensive OpenGL operations. Check speedup and stability. |>. 24 |
322
| Recap matrix operations (Linear Algebra) and study ARM NEON. |>. 48 |
323 242 dl lud
| Do a profiling of several apps to find the most used GLES operations. |>. 32 |
324 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 |
325
| Fix bugs, re-write the code where needed, get it stable. |>. 80 |
326 1 Denis 'GNUtoo' Carikli
|_. TOTAL |_>. 304 |
327 252 Denis 'GNUtoo' Carikli
328 1 Denis 'GNUtoo' Carikli
h3. Lima driver
329
330
"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. 
331
332
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.
333 167 dl lud
334
*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).
335
336
*Difficulty*: Medium
337
338
*Requirements/Prerequisites*: "See with Lima project":https://gitlab.freedesktop.org/lima/web/wikis/home#build-and-install
339 1 Denis 'GNUtoo' Carikli
340 212 dl lud
*Expected outcomes*: Lima driver being used for GLES rendering on a supported device.
341
342 234 dl lud
|_. Step |_. man-hours |
343
| 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 |
344
| Replace mainline Mesa for "Lima's Mesa":https://gitlab.freedesktop.org/lima/mesa (with their driver).  |>. 16 |
345
| Build and test thoroughly with "synthetic":https://source.android.com/devices/graphics/testing and real applications. |>. 40 |
346
| Create a fallback mechanism that uses the software renderer for GLES functions not yet implemented in Lima. |>. 100 |
347 222 dl lud
|_. TOTAL |_>. 236 |
348 252 Denis 'GNUtoo' Carikli
349 243 dl lud
h3. Software Bill of Materials
350
351
* "Replicant 9":https://redmine.replicant.us/projects/replicant/wiki/Porting_Replicant_to_Android_9
352
* "Mesa":https://www.mesa3d.org/intro.html (in particular: "Gallium llvmpipe driver":https://www.mesa3d.org/llvmpipe.html)
353
* "gbm_gralloc":https://osdn.net/projects/android-x86/scm/git/external-gbm_gralloc/summary
354
* "drm-hwcomposer":https://gitlab.freedesktop.org/drm-hwcomposer/drm-hwcomposer
355
* "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)
356
* "SwiftShader":https://swiftshader.googlesource.com/SwiftShader
357
* "Ne10 library":https://github.com/projectNe10/Ne10
358
* "Neon Intrinsics":https://developer.arm.com/architectures/instruction-sets/simd-isas/neon/intrinsics
359
* "Lima":https://gitlab.freedesktop.org/lima
360 252 Denis 'GNUtoo' Carikli
361 222 dl lud
h3. "Graphics acceleration on Replicant" nlnet Grant application
362
363
|_. Project name | Graphics acceleration on Replicant |
364
|_. Website / wiki | https://redmine.replicant.us/projects/replicant/wiki/Tasks_funding#Graphics-acceleration |
365
366
Abstract: Can you explain the whole project and its expected outcome(s) in 1200 characters
367
<pre>
368
Replicant is a fully free software Android distribution which is approved by the
369
FSF. All supported devices on Replicant currently lack a free software driver
370
for their GPU. As such, OpenGL ES (GLES) rendering must be done on the CPU
371
through software rendering (SR).
372 223 dl lud
373 222 dl lud
Replicant's current renderer is both incomplete and slow. It causes essential
374
apps like web browsers to crash due to lack of GLES 2.0, and many other
375
apps run too slow to be usable.
376
377
This project aims to fix this by complementing Android's 9 graphics stack.
378
Adding a few missing components will created of a fully-free, fast and compliant
379
graphics stack.
380
381
First we will write a gralloc (graphics memory allocator) tailored for SR that
382
is compatible with drm-hwcomposer (a libre implementation of Android's Hardware
383
Composer HAL). This gralloc enables drm-hwcomposer to work with SurfaceFlinger
384
and SwiftShader, creating a stack capable of GLES 2.0 on the CPU of all Replicant
385
devices.
386
387
Afterwards we will integrate and optimize Mesa's llvmpipe SR, which offers better
388
community support than SwiftShader. As last step we will add support for the
389
Lima driver, which will bring an even faster GPU-backed GLES to at least 5
390
devices.
391
</pre> 
392
393
|_. Have you been involved with projects or organizations relevant to this project before?
394
And if so, can you tell us a bit about your contributions? | SEE TEMPLATE |
395
396
|_. Requested Amount (Between 5000 and 50000 Euros) | 50000 Euros |
397
|_. Does the project have other funding sources, both past and present? | SEE TEMPLATE |
398
399 1 Denis 'GNUtoo' Carikli
Explain what the requested budget will be used for? 
400 223 dl lud
<pre>
401 1 Denis 'GNUtoo' Carikli
The budget will only be used to fund this project through contract work.
402 223 dl lud
403
We estimate that this project should take 868 man-hours to reach full completion,
404
with 632 man-hours being enough to reach all software rendering goals, leaving only
405
the GPU rendering to be done. A detailed run-down of this estimate is available at
406
https://redmine.replicant.us/projects/replicant/wiki/Tasks_funding#Graphics-acceleration
407
408
So far we have a team of two people interested on working on this project (the
409
two authors and submitters of this application). Both can commit to the project
410
on a part-time regime (17.5 hours per week), which means that the project should
411
be fully completed in about 6 months.
412
413
We will make sure that everybody has a chance to apply for doing contract work.
414
If we take the cost of a freelance developer in the USA (75 to 150 USD
415
per hour) as a basis, to enable people living in Europe and the USA
416
to apply, we can fund between 380 and 760 man-hours with the 50000 EUR budget.
417
This should be enough to cover all work on software rendering plus the initial
418
work on GPU rendering.
419
420
As happens on all software projects, getting a precise time/effort evaluation is
421
a difficult endeavour, specially when dealing with a project that is heavy on
422
research such as this one.
423
424
If the software rendering goals are not reached when the 50000 EUR budget runs
425
out, or if the Replicant project deems it necessary to have GPU rendering, it
426
will use its existing funds to pay for contract work if no volunteers are found
427
to finish the project.
428
429
The Replicant project will also make sure that the people working on this project
430
have the necessary hardware to do it, for instance by shipping or reimbursing the
431 222 dl lud
purchase of a compatible smartphone with the Replicant project funds.
432
</pre>
433
434
Compare your own project with existing or historical efforts.
435 224 dl lud
<pre>
436
Past Replicant versions have relied on patches to the Android framework to make
437
software rendering work. These patches were quite specific for Replicant and
438
had no use elsewhere. This made them unfit for upstreaming or sharing with any
439 222 dl lud
other project.
440 224 dl lud
441
Android's Project Treble new graphics stack allows us to follow a different
442
approach this time. Instead of patching the Android framework, we will
443
implement one of the well defined Android HALs (Hardware Abstraction Layer):
444
the gralloc HAL. The end result will be a software library that can prove to be
445
useful on several projects besides Replicant (e.g. Android-x86 project) and
446
thus fit for upstreaming.
447
448
449
Furthermore, past Replicant versions relied on Google's software renderers
450
(ligAGL and libpixelflinger) for OpenGL ES support. As quite a few other
451
Google's open-source projects, these two had no community behind them and got
452
stalled as soon as Google deprecated them.
453
454
This time will we take a different approach. Although our first graphics stack
455
will rely on Google's SwiftShader renderer, we will then move our efforts into
456
Mesa. Mesa is a big community project, with hundreds of active contributors and
457
great community support. It includes the llvmpipe software renderer along with
458
new drivers in development for GPUs present on current and future Replicant
459 222 dl lud
devices. Mesa should provide a stable and maintained platform for years to come.
460
</pre>
461
462
What are significant technical challenges you expect to solve during the project, if any?
463 225 dl lud
<pre>
464
We expect to solve significant technical challenges during this project:
465
1. Implementation of the first Android gralloc library compatible with software
466
rendering.
467
2. Development of free-software benchmarks for OpenGL ES on Android, used to test
468
our optimizations to llvmpipe.
469
3. Optimization of llvmpipe by at least one order of magnitude.
470
4. Running an exynos based smartphone with fully free-software GPU graphics
471 222 dl lud
acceleration.
472
</pre>
473 229 dl lud
474
Describe the ecosystem of the project, and how you will engage with relevant actors and promote the outcomes?
475
<pre>
476
This project will re-use code from several projects such as Android,
477
drm-hwcomposer, Mesa and Lima driver. Whenever possible we will foster
478
collaboration with these projects and submit our changes upstream.
479
480
The Replicant project contributors and the FSF will supervise
481
contractors to do the work.
482
483
A blog post will announce that the Replicant project
484
has got some funding for this specific task, and that it is
485
looking for a contractor to work on it. This is to make sure
486
that everyone has equal chances in the application process.
487
488
Then the most suited contractor will be selected. Only contractors
489
that already have worked on similar tasks as part of free and open
490
source software projects will be chosen. This way we can look at
491
their existing contributions and make sure that they are able to
492
do the task before engaging with them.
493
494
The Replicant project will also make sure that the contractor has
495
or gets the hardware required to work on the task, before starting
496 1 Denis 'GNUtoo' Carikli
to work on it.
497 229 dl lud
</pre>
498 222 dl lud
499 167 dl lud
|_. Attachments | SEE TEMPLATE |