diff options
Diffstat (limited to 'testing/talos/talos/pageloader/chrome/Profiler.js')
| -rw-r--r-- | testing/talos/talos/pageloader/chrome/Profiler.js | 221 |
1 files changed, 221 insertions, 0 deletions
diff --git a/testing/talos/talos/pageloader/chrome/Profiler.js b/testing/talos/talos/pageloader/chrome/Profiler.js new file mode 100644 index 0000000000..15524e347d --- /dev/null +++ b/testing/talos/talos/pageloader/chrome/Profiler.js @@ -0,0 +1,221 @@ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +/* eslint-env mozilla/frame-script */ + +// - NOTE: This file is duplicated verbatim at: +// - talos/pageloader/chrome/Profiler.js +// - talos/tests/tart/addon/content/Profiler.js +// - talos/startup_test/tresize/addon/content/Profiler.js +// +// - Please keep these copies in sync. +// - Please make sure your changes apply cleanly to all use cases. + +// Finer grained profiler control +// +// Use this object to pause and resume the profiler so that it only profiles the +// relevant parts of our tests. +var Profiler; + +(function () { + var _profiler; + + // If this script is loaded in a framescript context, there won't be a + // document object, so just use a fallback value in that case. + var test_name = this.document ? this.document.location.pathname : "unknown"; + + // Whether Profiler has been initialized. Until that happens, most calls + // will be ignored. + var enabled = false; + + // The subtest name that beginTest() was called with. + var currentTest = ""; + + // Start time of the current subtest. It will be used to create a duration + // marker at the end of the subtest. + var profilerSubtestStartTime; + + // Profiling settings. + var profiler_interval, + profiler_entries, + profiler_threadsArray, + profiler_featuresArray, + profiler_dir; + + try { + // eslint-disable-next-line mozilla/use-services + _profiler = Cc["@mozilla.org/tools/profiler;1"].getService(Ci.nsIProfiler); + } catch (ex) { + (typeof dumpLog == "undefined" ? dump : dumpLog)(ex + "\n"); + } + + // Parses an url query string into a JS object. + function searchToObject(locationSearch) { + var pairs = locationSearch.substring(1).split("&"); + var result = {}; + + for (var i in pairs) { + if (pairs[i] !== "") { + var pair = pairs[i].split("="); + result[decodeURIComponent(pair[0])] = decodeURIComponent(pair[1] || ""); + } + } + + return result; + } + + Profiler = { + /** + * Initialize the profiler using profiler settings supplied in a JS object. + * The following properties on the object are respected: + * - gecko_profile_interval + * - gecko_profile_entries + * - gecko_profile_features + * - gecko_profile_threads + * - gecko_profile_dir + */ + initFromObject: function Profiler__initFromObject(obj) { + if ( + obj && + "gecko_profile_dir" in obj && + typeof obj.gecko_profile_dir == "string" && + "gecko_profile_interval" in obj && + Number.isFinite(obj.gecko_profile_interval * 1) && + "gecko_profile_entries" in obj && + Number.isFinite(obj.gecko_profile_entries * 1) && + "gecko_profile_features" in obj && + typeof obj.gecko_profile_features == "string" && + "gecko_profile_threads" in obj && + typeof obj.gecko_profile_threads == "string" + ) { + profiler_interval = obj.gecko_profile_interval; + profiler_entries = obj.gecko_profile_entries; + profiler_featuresArray = obj.gecko_profile_features.split(","); + profiler_threadsArray = obj.gecko_profile_threads.split(","); + profiler_dir = obj.gecko_profile_dir; + enabled = true; + } + }, + initFromURLQueryParams: function Profiler__initFromURLQueryParams( + locationSearch + ) { + this.initFromObject(searchToObject(locationSearch)); + }, + beginTest: function Profiler__beginTest(testName) { + currentTest = testName; + if (_profiler && enabled) { + _profiler.StartProfiler( + profiler_entries, + profiler_interval, + profiler_featuresArray, + profiler_threadsArray + ); + } + }, + finishTest: function Profiler__finishTest() { + if (_profiler && enabled) { + _profiler.Pause(); + _profiler.dumpProfileToFile( + profiler_dir + "/" + currentTest + ".profile" + ); + _profiler.StopProfiler(); + } + }, + finishTestAsync: function Profiler__finishTest() { + if (!(_profiler && enabled)) { + return undefined; + } + return new Promise((resolve, reject) => { + Services.profiler.getProfileDataAsync().then( + profile => { + let profileFile = profiler_dir + "/" + currentTest + ".profile"; + + const { NetUtil } = ChromeUtils.importESModule( + "resource://gre/modules/NetUtil.sys.mjs" + ); + const { FileUtils } = ChromeUtils.importESModule( + "resource://gre/modules/FileUtils.sys.mjs" + ); + + var file = Cc["@mozilla.org/file/local;1"].createInstance( + Ci.nsIFile + ); + file.initWithPath(profileFile); + + var ostream = FileUtils.openSafeFileOutputStream(file); + + let istream = Cc[ + "@mozilla.org/io/string-input-stream;1" + ].createInstance(Ci.nsIStringInputStream); + istream.setUTF8Data(JSON.stringify(profile)); + + // The last argument (the callback) is optional. + NetUtil.asyncCopy(istream, ostream, function (status) { + if (!Components.isSuccessCode(status)) { + reject(); + return; + } + + resolve(); + }); + }, + error => { + console.error("Failed to gather profile:", error); + reject(); + } + ); + }); + }, + finishStartupProfiling: function Profiler__finishStartupProfiling() { + if (_profiler && enabled) { + _profiler.Pause(); + _profiler.dumpProfileToFile(profiler_dir + "/startup.profile"); + _profiler.StopProfiler(); + } + }, + + /** + * Set a marker indicating the start of the subtest. + * + * It will also set the `profilerSubtestStartTime` to be used later by + * `subtestEnd`. + */ + subtestStart: function Profiler__subtestStart(name, explicit) { + profilerSubtestStartTime = Cu.now(); + if (_profiler) { + ChromeUtils.addProfilerMarker( + "Talos", + { category: "Test" }, + explicit ? name : 'Start of test "' + (name || test_name) + '"' + ); + } + }, + + /** + * Set a marker indicating the duration of the subtest. + * + * This will take the `profilerSubtestStartTime` that was set by + * `subtestStart` and will create a duration marker by setting the `endTime` + * to the current time. + */ + subtestEnd: function Profiler__subtestEnd(name, explicit) { + if (_profiler) { + ChromeUtils.addProfilerMarker( + "Talos", + { startTime: profilerSubtestStartTime, category: "Test" }, + explicit ? name : 'Test "' + (name || test_name) + '"' + ); + } + }, + mark: function Profiler__mark(marker, explicit) { + if (_profiler) { + ChromeUtils.addProfilerMarker( + "Talos", + { category: "Test" }, + explicit ? marker : 'Profiler: "' + (marker || test_name) + '"' + ); + } + }, + }; +})(); |