Electrolysis: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(closing this out.)
 
(30 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== Thanks ==
(5/1/2018) The Electrolysis Project is officially complete. Mozilla continues to work on scaling the Gecko process model through newer projects and work, including our process-per-origin initiative [https://wiki.mozilla.org/Project_Fission Project Fission]. Props and thanks to our entire community for helping us ship this body work. We could not have successfully shipped this without your help!
== Overview ==
== Overview ==


Line 6: Line 10:


* Legacy NPAPI plugin hosting
* Legacy NPAPI plugin hosting
* Media playback
* Media playback ('Gecko Media Plugin', a.k.a. 'GMP')
* Web content ('content processes')
* Web content ('content processes')
* [Fx53] GPU Process (Windows Only) {{bug|1264543}}
* [Fx54] file://URL access process {{bug|1147911}}
* [Fx55] Web Extensions {{bug|1190679}}
* [Fx55, Fx56] ServiceWorker and in the future SharedWorker threads {{bug|1231208}}


In the future Electrolysis child processes may be used to handle other browser tasks including graphical composition, and addon hosting for addons that leverage the new [[WebExtensions]] apis.
In the future Electrolysis child processes may be used to handle other browser tasks including audio, networking ({{bug|1322426}}), PDFium and Pepper Flash ({{bug|558184}}).


In Mozilla documentation "Electrolysis" is often shorted as "e10s".
In Mozilla documentation "Electrolysis" is often shorted as "e10s".
Line 17: Line 25:
=== Nightly/Aurora ===
=== Nightly/Aurora ===


If you're on Nightly or Aurora, e10s is already enabled by default! A user-facing checkbox is available for controlling Electrolysis functionality. Open Preferences and check the "Enable multi-process" checkbox and then restart your browser:
If you're on Nightly e10s-multi is enabled by default with 4 content processes. Soon, Firefox 54 Aurora, will also have e10s-multi (4 processes) enabled by default. A user-facing checkbox is available for controlling Electrolysis functionality. Open Preferences and check the "Enable multi-process" checkbox and then restart your browser:


[[File:E10s-toggle-in-preferences.png|324x150px|frameless|Nightly > Preferences > General > Enable multi-process]]
[[File:E10s-toggle-in-preferences.png|324x150px|frameless|Nightly > Preferences > General > Enable multi-process]]
Line 34: Line 42:


== Schedule and Status ==
== Schedule and Status ==
View the [https://wiki.mozilla.org/Electrolysis/Multiple_content_processes Multiple Content Process] wiki page for more information about release milestones, release criteria, and a gradual roll-out schedule of e10s-multi.


A single content process model is currently being tested on Nightly, Aurora and Beta channels. See the schedule below for planned rollout to release. A multiple content process model (e10s-multi) will roll out in a follow up release. View the [https://wiki.mozilla.org/Electrolysis/Multiple_content_processes Multiple Content Process] wiki page for more information.
=== Schedule ===


=== Schedule ===
The following schedule covers rollout of the single content process feature to release builds up to Firefox 54. Multi process is covered starting in Nightly 54.


The following schedule covers rollout of the single content process feature to release builds.
[https://sql.telemetry.mozilla.org/queries/972#1659 What percent of the population actually has e10s enabled? ]
   
   
{| class="wikitable"
{| class="wikitable"
|-
|-
! Date !! Trunk !! Aurora !! Beta !! Release !! Target % !! Actual %
! Date !! Trunk !! Aurora !! Beta !! Release  
|-
|-
| 2015-04-30 || 40 default (working on m5) || 39 off || 38 off || 37 off || - || -
| 2015-04-30 || 40 default (working on m5) || 39 off || 38 off || 37 off  
|-
|-
| 2015-05-11 || 41 default (working on m6) || 40 prompt || 39 off || 38 off || - ||-
| 2015-05-11 || 41 default (working on m6) || 40 prompt || 39 off || 38 off  
|-
|-
| 2015-06-29 || 42 default (working on m7/m8) || 41 prompt|| 40 off || 39 off || - || -
| 2015-06-29 || 42 default (working on m7/m8) || 41 prompt|| 40 off || 39 off  
|-
|-
| 2015-08-10 || 43 default (working on m8) || 42 default || 41 off || 40 off || - || -
| 2015-08-10 || 43 default (working on m8) || 42 default || 41 off || 40 off  
|-
|-
| 2015-09-21 || 44 default || 43 default || 42 off || 41 off || - || -
| 2015-09-21 || 44 default || 43 default || 42 off || 41 off  
|-
|-
| 2015-11-02 || 45 default || 44 default || 43 off || 42 off || - || -
| 2015-11-02 || 45 default || 44 default || 43 off || 42 off  
|-
|-
| 2015-12-14 || 46 default || 45 default || 44 A/B [1] || 43 off || - || -
| 2015-12-14 || 46 default || 45 default || 44 A/B [1] || 43 off  
|-
|-
| 2016-01-25 || 47 default || 46 default || 45 A/B [1] || 44 off|| - || -
| 2016-01-25 || 47 default || 46 default || 45 A/B [1] || 44 off
|-
|-
| 2016-03-07 || 48 default || 47 default || 46 A/B [1] || 45 off|| - || -
| 2016-03-07 || 48 default || 47 default || 46 A/B [1] || 45 off
|-
|-
| 2016-04-25 || 49 default || 48 default || 47 50% [1][2] || 46 off|| - || -
| 2016-04-25 || 49 default || 48 default || 47 50% [1][2] || 46 off
|-
|-
| 2016-06-06 || 50 default || 49 default || 48 [1][2] || 47 off|| -||-
| 2016-06-06 || 50 default || 49 default || 48 [1][2] || 47 off
|-
|-
| 2016-08-01 || 51 default[6] || 50 default || 49 [2][4]|| 48 ON [3] || 41% || 30-33%
| 2016-08-01 || 51 default[6] || 50 default || 49 [2][4]|| 48 ON [3]  
|-
|-
| 2016-09-19 || 52 default [7][8] || 51 default[6] || 50 default [4] || 49 ON [5] || + 3-4% || 35%
| 2016-09-19 || 52 default [7][8] || 51 default[6] || 50 default [4] || 49 ON [5]  
|-
|-
|2016-11-07 || 53 default [8] || 52 default [7]|| 51 default [6] || 50 ON [5]|| + 6-12%||
|2016-11-07 || 53 default [8] || 52 default [7]|| 51 default [6] || 50 ON [5]
|-  
|-  
|2017-01-24 || 54 default || 53 default [8] || 52 default [7] || 51 ON [*]|| * ||
|2017-01-24 || 54 default || 53 default || 52 default [7] || 51 ON  
|-
|-
|2017-03-07 || 55 default || 54 default || 53 default || 52 ON [*]|| *||
|2017-03-07 || 55 default[9] || 54 default[8] || 53 default || 52 ON  
|-
|-
|2017-04-18 || 56 default || 55 default || 54 default || 53 ON [*] || * ||  
|2017-04-18 || 55 default || n/a || 54 default || 53 ON  
|-
|2017-06-13 || 56 default || n/a || 55 default || 54 ON [10]
|}
|}


Line 86: Line 97:
[5] White listed Add-Ons + Add-Ons created as a WebExtension shipping on Release<br/>
[5] White listed Add-Ons + Add-Ons created as a WebExtension shipping on Release<br/>
[6] A11y+ Windows 8 touch screen support enabled, not riding trains<br/>
[6] A11y+ Windows 8 touch screen support enabled, not riding trains<br/>
[7] A11y + Windows 8 riding trains<br/>
[7] Windows 8 riding trains<br/>
[8] E10s Multi Enabled, Not riding trains<br/>
[8] E10s Multi Enabled, Not riding trains<br/>
[9] A11y Enabled for Windows <br/>
[10] E10s multi enabled, riding trains<br/>
[*] indicates the goal for the release has yet to be planned
[*] indicates the goal for the release has yet to be planned


Line 108: Line 121:
| 52 || all Extensions marked "multiprocessCompatible" and all WebExtensions [1]
| 52 || all Extensions marked "multiprocessCompatible" and all WebExtensions [1]
|-
|-
| 53 || all Extensions marked "multiprocessCompatible" and all WebExtensions [1]. Beta testing on add-ons that don't use  compatibility shims (~400 based on telemetry)
| 53 || all Extensions marked "multiprocessCompatible" and all WebExtensions [1].  
|-
|-
| 54 || all Extensions marked "multiprocessCompatible" and all WebExtensions [1].  Possibly add-ons that don't use compatibility shims.
| 54 || all Extensions marked "multiprocessCompatible" and all WebExtensions [1].   
|-
|-
| 55 || all Extensions marked "multiprocessCompatible" and all WebExtensions [1].  Possibly add-ons that don't use compatibility shims.
| 55 || all Extensions marked "multiprocessCompatible" and all WebExtensions [1].   
|-
|-
| 56 || all Extensions marked "multiprocessCompatible" and all WebExtensions [1].  Possibly add-ons that don't use compatibility shims.
| 56 || all Extensions marked "multiprocessCompatible" and all WebExtensions [1].  
|-
|-
| 57 || ONLY webextensions supported [4]
| 57 || ONLY WebExtensions supported [4]
|}
|}


Line 136: Line 149:


=== Weekly Status Reports ===
=== Weekly Status Reports ===
==2015==
 
* [https://wiki.mozilla.org/E10s/Status/Nov13 Nov 13]<br>
==2017==
* [https://wiki.mozilla.org/E10s/Status/Nov20 Nov 20]<br>
*[https://wiki.mozilla.org/E10s/Status/Feb17 Feb 17]<br>
* [https://wiki.mozilla.org/E10s/Status/Nov27 Nov 27]<br>
*[https://wiki.mozilla.org/E10s/Status/March20 March 20]<br>
* [https://wiki.mozilla.org/E10s/Status/Dec4 Dec 4]<br>
*[https://wiki.mozilla.org/E10s/Status/April3 April 3]<br>
* [https://wiki.mozilla.org/E10s/Status/Dec22 Dec 22]<br>
*[https://wiki.mozilla.org/E10s/Status/April10 April 10]<br>
*[https://wiki.mozilla.org/E10s/Status/May5 May 5]<br>
*[https://wiki.mozilla.org/E10s/Status/May9 May 9]<br>
*[https://wiki.mozilla.org/E10s/Status/May16 May 16]<br>
*[https://wiki.mozilla.org/E10s/Status/May26 May 26]<br>
*[https://wiki.mozilla.org/E10s/Status/June2 June 2]<br>
*[https://wiki.mozilla.org/E10s/Status/June16 June 16]<br>
*[https://wiki.mozilla.org/E10s/Status/July21 July 21]<br>
 
==2016==
==2016==
* [https://wiki.mozilla.org/E10s/Status/Jan15 Jan 15]<br>
* [https://wiki.mozilla.org/E10s/Status/Jan15 Jan 15]<br>
Line 168: Line 189:
* [https://wiki.mozilla.org/E10s/Status/Dec23 Dec 23]<br>
* [https://wiki.mozilla.org/E10s/Status/Dec23 Dec 23]<br>


==2017==
==2015==
* [https://wiki.mozilla.org/E10s/Status/Feb17 Feb 17]<br>
* [https://wiki.mozilla.org/E10s/Status/Nov13 Nov 13]<br>
* [https://wiki.mozilla.org/E10s/Status/Nov20 Nov 20]<br>
* [https://wiki.mozilla.org/E10s/Status/Nov27 Nov 27]<br>
* [https://wiki.mozilla.org/E10s/Status/Dec4 Dec 4]<br>
* [https://wiki.mozilla.org/E10s/Status/Dec22 Dec 22]<br>
 
 


== Experiments ==
== Experiments ==
Line 189: Line 216:
== Add-ons Compatibility ==
== Add-ons Compatibility ==


Add-on authors should refer to the MDN [https://developer.mozilla.org/en-US/Add-ons/Working_with_multiprocess_Firefox Firefox Add-on Migration Guide] for porting existing add-ons to e10s. For general design information see the [https://developer.mozilla.org/en-US/Firefox/Multiprocess_Firefox Multiprocess Firefox] MDN documentation. Add-on testing compatibility is currently available at http://arewee10syet.com.
Add-on authors should refer to the MDN [https://developer.mozilla.org/en-US/Add-ons/Working_with_multiprocess_Firefox Firefox Add-on Migration Guide] for porting existing add-ons to e10s. For general design information see the [https://developer.mozilla.org/en-US/Firefox/Multiprocess_Firefox Multiprocess Firefox] MDN documentation. Add-on testing compatibility is currently available at https://arewewebextensionsyet.com/.


For more information about Add-on issue mitigation and rollout of e10s to add-on users, see the [https://wiki.mozilla.org/Add-ons Add-on Project Wiki] page.
For more information about Add-on issue mitigation and rollout of e10s to add-on users, see the [https://wiki.mozilla.org/Add-ons Add-on Project Wiki] page.

Latest revision as of 14:14, 15 May 2018

Thanks

(5/1/2018) The Electrolysis Project is officially complete. Mozilla continues to work on scaling the Gecko process model through newer projects and work, including our process-per-origin initiative Project Fission. Props and thanks to our entire community for helping us ship this body work. We could not have successfully shipped this without your help!

Overview

Electrolysis functionality hosts, renders, or executes web related content in background child processes which communicate with the "parent" Firefox browser via various ipdl protocols. The two major advantages of this model are security and performance. Security improvements are accomplished through security sandboxing, performance improvements are born out of the fact that multiple processes better leverage available client computing power.

Electrolysis child processes are currently in use for the following tasks within Firefox:

  • Legacy NPAPI plugin hosting
  • Media playback ('Gecko Media Plugin', a.k.a. 'GMP')
  • Web content ('content processes')
  • [Fx53] GPU Process (Windows Only) bug 1264543
  • [Fx54] file://URL access process bug 1147911
  • [Fx55] Web Extensions bug 1190679
  • [Fx55, Fx56] ServiceWorker and in the future SharedWorker threads bug 1231208

In the future Electrolysis child processes may be used to handle other browser tasks including audio, networking (bug 1322426), PDFium and Pepper Flash (bug 558184).

In Mozilla documentation "Electrolysis" is often shorted as "e10s".

Testing

Nightly/Aurora

If you're on Nightly e10s-multi is enabled by default with 4 content processes. Soon, Firefox 54 Aurora, will also have e10s-multi (4 processes) enabled by default. A user-facing checkbox is available for controlling Electrolysis functionality. Open Preferences and check the "Enable multi-process" checkbox and then restart your browser:

Nightly > Preferences > General > Enable multi-process

Firefox Beta

If you're currently using Firefox Beta you might be testing e10s already, check about:support and look for a number higher than 0 in the "Multiprocess Windows" entry. If you would like to opt-in to help us test open about:config and toggle browser.tabs.remote.autostart to true. On your next restart, e10s should be active.

Firefox Release

If you're using Firefox 48 or later, you might be using e10s already. Check about:support and look for a number higher than 0 in the "Multiprocess Windows" entry. If you would like to opt-in, open about:config and toggle browser.tabs.remote.autostart to true. On your next restart, e10s should be active.

Force Enable

If you've tried enabling e10s following the instruction above, but your about:support indicates that e10s is disabled (e.g., accessibility, add-ons can trigger this), you can force e10s on for testing purposes. Within about:config create a new boolean pref named browser.tabs.remote.force-enable and set it to true. This is not encouraged, use it at your own risk!

Schedule and Status

View the Multiple Content Process wiki page for more information about release milestones, release criteria, and a gradual roll-out schedule of e10s-multi.

Schedule

The following schedule covers rollout of the single content process feature to release builds up to Firefox 54. Multi process is covered starting in Nightly 54.

What percent of the population actually has e10s enabled?

Date Trunk Aurora Beta Release
2015-04-30 40 default (working on m5) 39 off 38 off 37 off
2015-05-11 41 default (working on m6) 40 prompt 39 off 38 off
2015-06-29 42 default (working on m7/m8) 41 prompt 40 off 39 off
2015-08-10 43 default (working on m8) 42 default 41 off 40 off
2015-09-21 44 default 43 default 42 off 41 off
2015-11-02 45 default 44 default 43 off 42 off
2015-12-14 46 default 45 default 44 A/B [1] 43 off
2016-01-25 47 default 46 default 45 A/B [1] 44 off
2016-03-07 48 default 47 default 46 A/B [1] 45 off
2016-04-25 49 default 48 default 47 50% [1][2] 46 off
2016-06-06 50 default 49 default 48 [1][2] 47 off
2016-08-01 51 default[6] 50 default 49 [2][4] 48 ON [3]
2016-09-19 52 default [7][8] 51 default[6] 50 default [4] 49 ON [5]
2016-11-07 53 default [8] 52 default [7] 51 default [6] 50 ON [5]
2017-01-24 54 default 53 default 52 default [7] 51 ON
2017-03-07 55 default[9] 54 default[8] 53 default 52 ON
2017-04-18 55 default n/a 54 default 53 ON
2017-06-13 56 default n/a 55 default 54 ON [10]

[1] qualifying users: users that do not use addons and have not activated accessibility support over 30 days.
[2] full run across the entire beta period
[3] 1% of qualifying users with ramp up to 100% during the release cycle
[4] White listed Add-Ons + Add-Ons created as a WebExtension testing on beta, full cycle
[5] White listed Add-Ons + Add-Ons created as a WebExtension shipping on Release
[6] A11y+ Windows 8 touch screen support enabled, not riding trains
[7] Windows 8 riding trains
[8] E10s Multi Enabled, Not riding trains
[9] A11y Enabled for Windows
[10] E10s multi enabled, riding trains
[*] indicates the goal for the release has yet to be planned

Add-ons Schedule

The following schedule rollout of Electrolysis as it releases specifically to add-ons. Each release of Firefox will add more and more add-ons to the cohort of users who get multi process Firefox.

Users with add-ons not in yet the cohort to get multi-process, will continue to run Firefox (as before) without e10s enabled. The Road to 57 blog post has details and there is a visual of the schedule here.

Version Cohort
49 limited experimental set of Extensions and all WebExtensions
50 all Extensions marked "multiprocessCompatible" and all WebExtensions [1]
51 Moving back to Fx 50 release criteria. All Extensions and all WebExtensions [1], [2], [3], plus 770 add-ons testing in Beta that were not marked either way (initial expansion) had been included.
52 all Extensions marked "multiprocessCompatible" and all WebExtensions [1]
53 all Extensions marked "multiprocessCompatible" and all WebExtensions [1].
54 all Extensions marked "multiprocessCompatible" and all WebExtensions [1].
55 all Extensions marked "multiprocessCompatible" and all WebExtensions [1].
56 all Extensions marked "multiprocessCompatible" and all WebExtensions [1].
57 ONLY WebExtensions supported [4]

[1] Before each stage moves from beta to release, there are release criteria (crashes, jank etc) that need to be met. We will delay moving to Release if issues are identified in Beta.

[2] Initially Shims will be available that will help certain add-ons with compatibility. These are a temporary measure due to potential limitations that could impact user experience.

[3] With the exception of Extensions marked explicitly as NOT multiprocessCompatible.

[4] More details in blog post or broader add-on timing schedule see for details on what will be allowed

For information on add-on support rollout see the Add-on/e10s Project Wiki.

Staged Roll-Out Plan

To read a summary of the Roll-Out plan, see Asa's blog.

Windows XP

Due to stability issues Windows XP is currently not leveraging e10s on release channel. XP and Vista will move out to Extended Support Release (ESR) 45 when 45 merges to release (bug 1303827). As such there are no plans to support e10s for XP/Vista in the future.

Weekly Status Reports

2017

2016

2015


Experiments

There's a dedicated page for the experiments: E10s Experiments

Contributing

The simplest way to help out is to test a release that has e10s enabled, and file bug when you find them. Please try to find duplicates prior to filing.

For developers interested in helping out, MDN has a good introduction to e10s, useful for both Firefox and add-on developers.

Security Sandboxing

See the Security Sandbox wiki page for more information and status.

Accessibility Support

See the e10s Accessibility wiki page for support implementation detail.

Add-ons Compatibility

Add-on authors should refer to the MDN Firefox Add-on Migration Guide for porting existing add-ons to e10s. For general design information see the Multiprocess Firefox MDN documentation. Add-on testing compatibility is currently available at https://arewewebextensionsyet.com/.

For more information about Add-on issue mitigation and rollout of e10s to add-on users, see the Add-on Project Wiki page.

Past Milestones

  • 2014-09-11 - bug 1064885 - Enable opt-in option for Nightly
  • 2014-11-13 - bug 1093691 - Enabled for Nightly builds
  • 2015-05-08 - bug 1161260 - Enable opt-in option for Aurora
  • 2015-07-28 - bug 1182097 - Disabled on Aurora for about 1 week due to a bug in a11y prompting
  • 2015-07-31 - bug 1188605 - Enabled for Aurora builds
  • 2015-12-15 - bug 1229104 - Beta testing
  • 2016-08-01 - Enabled for non-add-on users in Release 48 / Beta testing of add-on users in 49

Communication

Weekly Cross Functional
Covering current e10s status, multi-e10s, add-ons rollout, and sandboxing.
Fridays @ 10am Pacific
Weekly Team Meeting
(No longer active)
Weekly Team Meeting Thursday at 9:00am PT
  • Vidyo: "e10s"
  • Invitation: Contact blassey, jimm, or larissa to get added to the meeting invite list.
  • Meeting Notes
Weekly Addons Design Meeting
(No longer active)
IRC
  • Server: irc.mozilla.org
  • Channel: #e10s
Newsgroup/Mailing List

People

Engineering Management
  • Brad Lassey
Product Management
  • Jeff Griffiths
Project Management
  • Erin Lancaster - e10s Go to Market
  • Shell Escalante - Add-Ons
QA
  • Tracy Walker (e10s Quality Assurance Lead)
Development Team
  • Mike Conley
  • Felipe Gomes
  • Blake Kaplan
  • Gabor Krizsanits
  • William McCloskey
  • Jim Mathies
  • Tom Schuster
  • Dave Townsend
  • George Wright

Meeting Notes

Link

Reference

Bug Lists

Nightly enable blockers

Aurora uplift blockers (plus dev. tools)

Beta blockers

GA Blockers

Summary Lists

Devtools Lists

Performance bugs (e10s-perf)

Future

Triage Lists

Misc. Trackers

Uplift candidates: (M9 and P1 tracking+ bugs fixed in FF 48 but not 47)