Project

General

Profile

TasksFunding » History » Version 255

Denis 'GNUtoo' Carikli, 05/02/2019 03:21 PM
Remove "Finish to port the Galaxy S III (I9300) and the Galaxy Note 2 (N7100) to Mainline Linux" as it was part of the Port Replicant to Android 9 task

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