Platform/Uptime
Project Uptime ran from April 2016 to June 2017. Preventing and fixing crashes remains an important task, and there is ongoing work there. But this work is no longer being coordinated under Project Uptime. This page is being kept in place as a historical record.
Project Uptime's goal is to reduce the crash rate of Firefox (desktop and mobile) and keep it down. This project is a Platform Engineering initiative that aims to extend and complement existing work relating to stability within Mozilla.
David Bryant's internal email announcement said: "The overall responsibility to hit our stability target is something that falls on the entire platform organization, and in terms of priority, stability is second only to shipping e10s."
Contents
- 1 Goals
- 2 All about crashes
- 3 OKRs
- 3.1 In progress
- 3.1.1 Establish crash rate metrics and targets
- 3.1.2 Improve pre-release coverage
- 3.1.3 Improve analysis of crash reports
- 3.1.4 [DONE] Improve understanding of OOM causes
- 3.1.5 Catch more crashes with static and dynamic analysis
- 3.1.6 [DONE] Improve crash report comprehensibility
- 3.1.7 Prevent common C++ defects with better types and annotations
- 3.2 H2 2016 Backlog
- 3.3 Future Backlog
- 3.1 In progress
- 4 Data Sources and Useful Links
- 5 Participants
- 6 Meetings
- 7 Communication channels
- 8 Nightly crash triage
Goals
The basics
We can break Uptime's goals down into four sub-goals.
- Reduce the Release crash rate, and keep it down. This gives a better experience for ~100M/7M users, and makes them less likely to switch to a different browser.
- Reduce the Beta crash rate, and keep it down. This gives a better experience for ~2M/150k users, and makes them less likely to switch to a different browser or a later channel. This goal partially subsumes goal #1.
- Reduce the Aurora crash rate, and keep it down. This gives a better experience for ~100k/2k users, and makes them less likely to switch to a different browser or a later channel. This goal partially subsumes goals #1 and #2.
- Reduce the Nightly crash rate, and keep it down. This gives a better experience for ~30k/1k users, and makes them less likely to switch to a different browser or a later channel. This goal partially subsumes goals #1, #2 and #3.
(Channel ADI numbers are approximate, taken from http://arewestableyet.com on Apr 26.)
These sub-goals are listed in order of priority. But note that the relative priorities do not match the relative user counts. E.g. even though Release has ~3000x as many users as Nightly, goal #1 is not 3000x more important than goal #4. The higher-numbered goals, as well as being (decreasingly) virtuous in their own right, partially subsume the lower-numbered goals, because a crash fixed or avoided in an earlier channel is one that doesn't show up in a later channel. (The later goals don't fully subsume the earlier goals because some crashes don't show up in significant numbers until we get to the larger populations of the later channels.)
There are multiple strategies (tools, processes, systems) to achieve these goals -- see below -- but those strategies should not be confused with the goals themselves.
Definition of "crash rate"
For a long time the crash rate metric was "crashes per 100 ADIs". This has various shortcomings and is in the process of being replaced with "crashes per 1000 hours of usage".
Not all crashes are equal. For example: persistent start-up crashes are terrible; with e10s enabled, content process crashes are not as bad as chrome process crashes; plugin crashes may be less important. It would be possible to adjust the per-1000-hours-of-usage measurements by weighting different types of crashes differently. However, any such formula would be arbitrary and not clearly better than the plain metric. Therefore, we will use the plain metric for defining "crash rate", and that is the value we want to get down.
Having said that, when considering a problem as complex as browser crashes, any single metric will have shortcomings and should not be the only thing paid attention to. In particular, we should build systems and processes (such as automated alerts) that help us give attention to the worst kinds of crashes.
Target crash rate
There are eight crash rates to track: {Release, Beta, Aurora, Nightly} x {desktop, mobile}.
The actual target values are TBD, and cannot be decided until the new per-1000-hours-of-usage metric has fully replaced the old per-100-ADIs metric and we know what our current values are.
All about crashes
We use "crashes" to refer to several kinds of events.
- Uncontrolled crashes: most commonly due to bad memory accesses, which are caused by bad pointers. Also sometimes illegal instructions, division-by-zero, etc.
- Controlled aborts: MOZ_CRASH, MOZ_RELEASE_ASSERT, Rust panics, etc.
- OOMs: running out of virtual or physical memory, or page file. Can be caused by Firefox using too much memory, or other processes on the system using too much memory. These usually present as controlled aborts.
- Hangs: sometimes when a plugin or content process stops responding for too long, we will collect a dump from that process and then kill it. Most common at shutdown.
Crashes are grouped by process type:
- When the "main" (chrome) process crashes, Firefox terminates.
- When a content process crashes, Firefox itself stays open but some or all tabs must be reloaded.
- When an NPAPI plugin or Gecko media plugin crashes, the web page will stay alive but some functionality may be broken and require the user to reload pages which used that plugin.
There are multiple different causes of crashes, and multiple ways they can be identified and addressed.
A word about coverage
For all of the following paths to a bug report (except static analysis and code inspection) coverage affects how effective the path is. There are several kinds of coverage.
- Code coverage: e.g. which lines of code are we not testing?
- Web feature coverage: e.g. which web features are we not testing?
- Site coverage: e.g. which important websites are we not testing?
- Hardware configuration coverage: e.g. which important gfx card/drivers combinations are we not testing?
- Firefox configuration coverage: e.g. which add-ons or non-default options are we not testing?
Paths to a bug report
Almost without exception, for a crash to be fixed we must have a bug report for it. There are multiple paths from a crash to a bug report.
User crash report (automated)
Steps
- A "normal" user hits a crash.
- The crash reporter catches the crash.
- The user consents to crash report submission.
- The crash report is created.
- The crash report is submitted, received and processed.
- The crash report is clustered into a signature and ranked.
- A Mozillian triages the signature and files a bug report.
Pros and cons
- [+] This is the only path that gives us a clear idea of how frequent the crash is among our user population.
- [+] Crash reports on Nightly provide fast feedback and small regression windows.
- [-] This is a long, complex path with numerous points of potential failure.
- [-] Submission rates vary, and are low for content, NPAPI and GMPlugin crashes.
- [-] Clustering and ranking is imperfect. Sometimes crash reports with distinct causes get conflated into one signature. Sometimes crash reports with a single cause get separate signatures (people sometimes spot this and link multiple signatures to a single bug report). The ranking does not consider crash severity.
- [-] Some crashes only manifest frequently in later release channels, where they affect more people, and are harder to address due to late feedback and large regression windows. Crashes that only manifest significantly on Release may require chemspills.
- [-] Crash reports frequently lack enough info to diagnose/address. (E.g. no steps to reproduce, and it's obvious that a pointer was bad, but unclear how it got that way.) Or the info is present but easy to overlook.
- [-] Crash report data can be unreliable. (E.g. incorrect crash addresses and stack traces.)
User crash report (manual)
Steps
- A developer, QA person or advanced user hits a crash.
- That person files a bug report.
Pros and cons
- [+/-] We may or may not get clear steps to reproduce.
- [+] We usually get a crash report as well.
Crash on automation
Steps
- An automated non-TreeHerder job crashes, e.g. fuzzers, BugHunter.
- A monitoring person (e.g. fuzzer, QA person) files a bug report.
Note: many tests are performed regularly on TreeHerder and are cause for immediate patch backout if they crash. Such crashes do not match this path because no bug report is filed.
Pros and cons
- [+] We have a test case...
- [-] ...but reproduction may be difficult or unreliable.
Analysis
Steps
- A non-TreeHerder dynamic analysis job (e.g. Valgrind, ASan, TSan, UBSan) or static analysis job (e.g. Coverity) detects a possible crash defect. Or, a developer identifies a possible crash defect via code inspection.
- A monitoring person files a bug report.
Note: some dynamic and static analysis jobs are performed regularly on TreeHerder and are cause for immediate patch backout if they fail. Crash defects found this way do not match this path because no bug report is filed.
Pros and cons
- [+] The defect is usually well-identified and actionable.
- [-] Not always clear how often the defect will cause crashes, though this depends on the analysis kind. (E.g. ASan is clearer than TSan.)
Paths from bug report to a diagnosis
As mentioned above, different kinds of bug report data have different likelihoods of leading to a diagnosis.
- High: Reliable test case or steps to reproduce.
- High: Well-identified defect, e.g. from analysis.
- Lower: Unreliable test case or steps to reproduce.
- Lower: Crash report.
Also, the following things increase the likelihood that a crash bug report will lead to a diagnosis.
- A needinfo request of an appropriate developer.
- Evidence that the crash has high severity or frequency.
- Nagging.
Addressing a diagnosed crash
Once the cause of a crash in a bug report has been diagnosed, it can be addressed. The possible ways to address a crash -- and to prevent similar crashes in the future -- depends on what kind of defect it is.
A defect in our code
Many crashes are due to defects in our code. Ways to address include: fix the defect; backout the defect; disable the defect; recover and continue (e.g. e10s content process restarting).
It's also possible to prevent entire classes of defects by using better code patterns and/or languages, or tools (e.g. dynamic analysis with sufficient coverage).
A defect in something we rely on
Some crashes are caused by defects in things we depend on: OS, gfx drivers, CPUs (e.g. the infamous AMD bug; overclocking can cause problems), RAM, disks. E.g. bug 1270232 and bug 1194856 are bugs where a bad installation might be the cause.
In general, we cannot fix or prevent these defects. Ways to address include: avoid the defect; detect and tolerate the defect; detect the defect and inform the user.
A defective interaction
Some crashes are caused by defective interactions with other software such as malware and/or anti-virus products. Sometimes these can be blocked, and sometimes we must rely on evangelism.
OOMs
OOMs are different to other crashes in terms of cause, though not any different in terms of the effect on users. In general, anything that significantly reduces memory usage helps, as does making large allocations fallible, especially those whose size is controlled by user input or web content. Using 64-bit builds also prevents address space exhaustion.
OKRs
OKRs are "objectives and key results". Within the following sections, each sub-section represents an objective, and the bullet points within that sub-section represent key results. Some objective sub-sections have additional supporting information (marked with Extra:) such as a table of relevant bug reports.
These OKRs are for H2 2016.
In progress
These are OKRs that have people actively working on them now.
Establish crash rate metrics and targets
- Verify that the crashes-per-1000-hour metric is reliable [digitarald]
- Define and choose target crash rate(s) [digitarald, njn]
- Implement dashboard(s) for easy monitoring [digitarald, ddurst]
Improve pre-release coverage
- Get the number of Nightly users growing again [pascal, marcia]
-
Provide test exercises for QA people and keen Nightly users to run regularly [marcia](One and Done has been decommissioned.) - ? Improve earlier channel populations to be more representative of the Release population [lonnen?]
Extra: bug 1280394 [tracking] Nightly adoption bugs
Improve analysis of crash reports
- Clouseau: Automatically identify changesets that cause regressions [calixte]
- [DONE] crash-correlations: Identify correlations for crash signatures [mcastelluccio]
- ? Provide ability to run custom analysis jobs on crash reports (similar to telemetry analysis jobs) [ekyle?]
Extra: Bugs blocking bug 1289676: [Uptime] Crash report handling
14 Total; 14 Open (100%); 0 Resolved (0%); 0 Verified (0%);
Extra: A cross-variate analysis of FHR data, by Brendan Colloran, which may have useful techniques.
[DONE] Improve understanding of OOM causes
- [DONE] Do a large-scale analysis of memory reports from OOM crashes [njn]
- [DONE] Show important data from memory reports in crash-stats [njn]
- ? Discuss common OOM cases with partners [digitarald?]
Extra: Bugs blocking bug 1291174: [Uptime] OOMs
| ID | Priority | Summary | Keywords | Assigned to |
|---|---|---|---|---|
| 1291068 | -- | Large-scale analysis of OOM crash reports with ContainsMemoryReport=1 | ||
| 1291173 | -- | Show important info from memory reports in crash-stats | Nicholas Nethercote [inactive] | |
| 1299747 | -- | Create a tool to track 64k unaligned virtual memory allocation | Ting-Yu Chou [:ting] (away) |
3 Total; 3 Open (100%); 0 Resolved (0%); 0 Verified (0%);
Catch more crashes with static and dynamic analysis
- Add additional, regular ASan, TSan, and Valgrind jobs to TreeHerder [jseward, sfink, tcole]
- Experiment with TSan, UBSan and Application Verifier [jseward, tcole, cervantes]
- Reduce the number of outstanding Coverity issues to zero and keep it there [bogdan]
- ? Add more checks to the clang static analysis job [sledru?]
Extra: Bugs blocking bug 1289660: [Uptime] Static analysis
| ID | Priority | Summary | Keywords | Assigned to |
|---|---|---|---|---|
| 1230156 | P3 | [meta] Coverity Static Analysis fixes | coverity, meta | |
| 1272513 | -- | Enable -Wshadow warnings | Chris Peterson [:cpeterson] |
2 Total; 2 Open (100%); 0 Resolved (0%); 0 Verified (0%);
Extra: Bugs blocking bug 1289646: [Uptime] Dynamic analysis
| ID | Priority | Summary | Keywords | Assigned to |
|---|---|---|---|---|
| 929478 | -- | [meta] Make TSan (ThreadSanitizer) usable with Firefox | meta, sec-want | |
| 1030826 | -- | Support AddressSanitizer builds on Windows with clang-cl | sec-want | |
| 1280637 | -- | Add a TSan-enabled TaskCluster JS shell job | Steve Fink [:sfink] [:s:] | |
| 1284975 | P2 | [meta] Make SpiderMonkey clean on UBSan | meta | |
| 1288596 | -- | Make SM-tc(msan) a first class test job | Steve Fink [:sfink] [:s:] | |
| 1288993 | -- | Run valgrind-mochitest twice a day as a Tier 2 job | Joel Maher ( :jmaher ) (UTC -8) | |
| 1289994 | P3 | [meta] Use Application Verifier | meta | |
| 1291954 | P3 | Make SM(tsan) a tier 1 build | Steve Fink [:sfink] [:s:] |
8 Total; 8 Open (100%); 0 Resolved (0%); 0 Verified (0%);
[DONE] Improve crash report comprehensibility
- [DONE] Improve presentation of crash reports on crash-stats [njn, adngdb]
- [DONE] Improve crash report documentation [njn]
Extra: Bugs blocking bug 1289675: [Uptime] Crash report comprehensibility
| ID | Priority | Summary | Keywords | Assigned to |
|---|---|---|---|---|
| 1275799 | -- | Add descriptions to crash report fields | [DEACTIVATED] Adrian Gaudebert | |
| 1288309 | -- | Improve documentation about individual crash reports | Nicholas Nethercote [inactive] | |
| 1288310 | -- | Improve documentation about analyzing clusters of crash reports | Nicholas Nethercote [inactive] |
3 Total; 3 Open (100%); 0 Resolved (0%); 0 Verified (0%);
Prevent common C++ defects with better types and annotations
- Finish mozilla::Result<T,E> and use in SpiderMonkey [jandem]
- Use MOZ_MUST_USE outside SpiderMonkey [njn, wcpan]
Extra: Bugs blocking bug 1289662: [Uptime] Low-level defect prevention and detection
| ID | Priority | Summary | Keywords | Assigned to |
|---|---|---|---|---|
| 1268766 | -- | Use [[nodiscard]] everywhere | ||
| 1272203 | -- | Add mozilla::NotNull to MFBT | Nicholas Nethercote [inactive] | |
| 1276097 | P5 | Add a bytecode sanity check | ||
| 1277368 | P3 | [meta] Use mozilla::Result<T, E> for fallible return values in the JS engine | meta, triage-deferred | Jan de Mooij [:jandem] |
4 Total; 4 Open (100%); 0 Resolved (0%); 0 Verified (0%);
H2 2016 Backlog
These are unassigned OKRs that would be helpful and are higher priority.
Refine how crash clusters are ranked
- Take into account crash severity and/or user distribution as well as frequency
- Use Crystal Ball (or other means) to identify how pre-Release crashes will manifest on Release
Extra: Bugs blocking bug 1291174: [Uptime] Crash cluster ranking
| ID | Priority | Summary | Keywords | Assigned to |
|---|---|---|---|---|
| 1303730 | -- | Consider changing the default precision for cardinality queries | ||
| 1305016 | -- | In the Top Crashers list, add the number of installations that are generating crash reports for a given signature | [DEACTIVATED] Adrian Gaudebert |
2 Total; 2 Open (100%); 0 Resolved (0%); 0 Verified (0%);
Extra: Relevant research papers.
- http://ieeexplore.ieee.org/document/5711013/
- http://swat.polymtl.ca/~foutsekh/docs/Khomh-WCRE-entropy.pdf
Reduce shutdown hang rate
- ?
Extra: Gecko:Shutdown_issues
Detect if Firefox is misinstalled
- Implement an installation check mechanism
- Provide guidance to the user when the check fails
Prevent crashes caused by malware and anti-virus on Windows
- Utilize Windows 10 blocking protection for content processes
- Reduce export space of xpcom symbols [bsmedberg]
- ? Provide an API for A/V so they don't need to use dangerous tricks
Extra: bug 1299187 Tracking: stop exporting symbols such that 3rd-party software cannot use XPCOM effectively
Catch more crashes with fuzzing
- Better isolate components so they can be fuzzed more easily (like the JS shell)
- Increase fuzzing coverage of non-default options
- Improve gtests, which are a good starting point for fuzzing
- [DONE] Run BugHunter with common antivirus software [tomcat]
Extra: bug 1289194 Add LibFuzzer support for testing xul code
Future Backlog
These are unassigned OKRs that would be helpful and are lower priority.
Detect when crashes are caused by faulty RAM
- Run some kind of live RAM test in the browser
- Annotate crash reports when faulty RAM is detected
Extra: Bugs blocking bug 1289666: [Uptime] Defective hardware
| ID | Priority | Summary | Keywords | Assigned to |
|---|---|---|---|---|
| 995652 | P3 | Run memtest from the crash reporter | ||
| 1270554 | -- | Run memtest continuously on the live browser | ||
| 1274428 | -- | Mark crashes that happen at invalid instruction pointers? | ||
| 1274628 | P3 | Annotate crashes when the code in memory around the crashing instruction differs from the code in the shipped binary | ||
| 1281759 | P3 | Work around mysterious AMD JIT crashes | crash | Jan de Mooij [:jandem] |
| 1293188 | P3 | Crash in EnterBaseline (can be defective hardware [Mem or VGA]) | crash, triage-deferred | |
| 1293996 | P1 | Crash in adapt_probs | crash, regression | Jean-Yves Avenard [:jya] |
| 1317253 | P5 | Best-effort detection of faulty memory at page-request time |
8 Total; 8 Open (100%); 0 Resolved (0%); 0 Verified (0%);
Improve crash report generation on the client
- Record additional interesting pages of memory
- Include more JS execution info (stacks; recently called JS file/functions; unresolved promises)
- Include more URL data (URLS of all open tabs; recent URLs of the crashing tab; non-anonymized memory reports); might require policy/legal approval
- Don't omit frame pointers?
- Better identify threads of all platforms, including threadpools
Extra: Bugs blocking bug 1289663: [Uptime] Crash report creation
12 Total; 12 Open (100%); 0 Resolved (0%); 0 Verified (0%);
Increase crash report submission rate
- Submit more crash reports from content process crashes
- Always submit non-sensitive data, and make only the sensitive data part (e.g. minidumps) optional
Extra: Bugs blocking bug 1289671: [Uptime] Crash report submission
| ID | Priority | Summary | Keywords | Assigned to |
|---|---|---|---|---|
| 1269998 | P1 | Prompt users with pending crash reports to submit them | Brad Lassey [:blassey] (use needinfo?) | |
| 1270553 | -- | Allow users to opt-in to auto submitting crash data | ||
| 1280469 | P2 | [meta] Client-side stack walking | meta | Gabriele Svelto [:gsvelto] |
| 1287178 | -- | Refactor unsubmitted crash report handling and allow users to always send backlogged crash reports | dev-doc-needed | Mike Conley (:mconley) (:⚙️) |
| 1333125 | P4 | Improve HTTP proxy support in the crashreporter client and pingsender |
5 Total; 5 Open (100%); 0 Resolved (0%); 0 Verified (0%);
Data Sources and Useful Links
- Crash Stats: entry point to crash reports.
- Platform/Uptime/Logs has some more specific links useful when analyzing crash reports.
- Data mining
- ActiveData: a giant queryable database of unit test results, Buildbot steps, and MozHarness steps with success/failure outcomes
- Bugzilla REST API
- Bugzilla ElasticSearch Cluster: easy-to-query historical data
- Test code coverage
- Fuzzing Explained - A Guide for Software Developers
- Crash rate dashboards
- Crash rate history: old ADI-based view
- Stability dashboard: new view, intended to replace arewestableyet.com [chutten]
- ADI & Telemetry Crash Rate (Release) [harald]
- Telemetry Crash Rate (Beta) [harald]
- Crashes per 1000 usage hours (Beta, DevEd, Nightly) [bsmedberg]
- bug 1324528 - Bug about removing old dashboards.
- bug 1324526 - Bug about the new dashboards we want.
- Firefox ADI dashboard (requires Tableau/dataviz privileges to view)
Participants
The grouping below is by time zone.
Taiwan
- Kan-Ru Chen, platform engineering
- Ting-Yu Chou, platform engineering
- Cervantes Yu, platform engineering
- Wei-Cheng Pan, platform engineering
Australia (Eastern)
- Nicholas Nethercote, platform engineering
North America (Pacific)
- Andrew McCreight, platform engineering
- Lonnen, Socorro
- David Baron, platform engineering
North America (Eastern)
- Jim Chen, platform engineering
- Kyle Lahnakoski, data visualization/analysis
- Marcia Knous, Release Management
- Milan Sreckovic, platform engineering
- Benjamin Smedberg, Firefox engineering
- David Durst, Firefox engineering
Europe (Western)
- Marco Castelluccio, crash report analysis and automation
Europe (Central)
- Calixte Denizet, crash report analysis and automation
- Julian Seward, dynamic analysis
- Sylvestre Ledru, static analysis, release management & stability
- Gabriele Svelto, Firefox engineering
Europe (Eastern)
- Andi Bogdan Postelnicu, static analysis
Meetings
We held meetings for several months, then switched to email updates because we deemed that to be more effective use of everybody's time.
Here are the minutes of the meetings we have had.
- 2017-04-10 minutes
- 2017-03-27 minutes
- 2017-03-13 minutes
- 2017-02-27 minutes
- 2017-02-13 minutes
- 2016-12-19 minutes
- Hawaii minutes: general
- Hawaii minutes: Windows third-party crashes
- Hawaii minutes: client-side crash report generation
- Hawaii minutes: crash report analysis
- Hawaii minutes: crash metrics
- 2016-11-21 minutes
- 2016-11-07 minutes
- 2016-10-24 minutes
- 2016-10-10 minutes
- 2016-09-26 minutes
- 2016-09-12 minutes
- 2016-08-29 minutes
Here is the meeting minutes template.
Communication channels
- IRC: #uptime
- Vidyo: Uptime
- Email: There are two email lists, both of which are low-volume.
- Public: The stability list. This list should be used for the vast majority of discussion. Anybody can join this list.
- Private:
projectuptime-team@mozilla.com. This is only for private discussion, e.g. discussions relating to commercially-sensitive information. Please email nnethercote if you want to join this list.
Nightly crash triage
This documentation has been moved to NightlyCrashTriage.
