Bug 1887068: Add perfetto SDK and build with it when gecko profiling is enabled on Android. r=glandium,smaug,dveditz

Differential Revision: https://phabricator.services.mozilla.com/D205662

config/system-headers.mozbuild

@@ -1366,3 +1366,8 @@ if CONFIG["OS_TARGET"] == "FreeBSD":
 
 if CONFIG["MOZ_APP_SYSTEM_HEADERS"]:
     include("../" + CONFIG["MOZ_BUILD_APP"] + "/app-system-headers.mozbuild")
+
+if CONFIG["MOZ_PERFETTO"]:
+    system_headers += [
+        "sys/timerfd.h",
+    ]

third_party/moz.build

@@ -91,3 +91,5 @@ with Files('wasm2c/**'):
 with Files('libsrtp/**'):
     BUG_COMPONENT = ('Core', 'WebRTC: Networking')
 
+with Files("perfetto/**"):
+    BUG_COMPONENT = ("Core", "Performance")

third_party/perfetto/LICENSE

@@ -0,0 +1,189 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) 2017, The Android Open Source Project
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+

third_party/perfetto/moz.build

@@ -0,0 +1,19 @@
+# -*- Mode: python; indent-tabs-mode: nil; tab-width: 40 -*-
+# vim: set filetype=python:
+# 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/.
+
+EXPORTS.perfetto += [
+    'sdk/perfetto.h'
+]
+
+SOURCES += [
+    'sdk/perfetto.cc'
+]
+
+LOCAL_INCLUDES += [
+  '/third_party/perfetto/sdk',
+]
+
+FINAL_LIBRARY = 'xul'

third_party/perfetto/moz.yaml

@@ -0,0 +1,44 @@
+# Version of this schema
+schema: 1
+
+bugzilla:
+  # Bugzilla product and component for this directory and subdirectories
+  product: "Core"
+  component: "Performance"
+
+origin:
+  name: "perfetto"
+  description: "C++ SDK for userspace performance tracing on Linux and Android."
+
+  url: "https://perfetto.dev"
+  license: Apache-2.0
+
+  release: v44.0 (2024-04-10T09:26:48+00:00).
+  revision: v44.0
+
+updatebot:
+  maintainer-phab: denispal
+  maintainer-bz: dpalmeiro@mozilla.com
+  tasks:
+    - type: vendoring
+      enabled: true
+      frequency: release
+
+vendoring:
+  url: https://github.com/google/perfetto
+  source-hosting: github
+  tracking: tag
+  keep:
+    - moz.build
+    - moz_attributes.patch
+  skip-vendoring-steps:
+    - update-moz-build
+  exclude:
+    - '**'
+  include:
+    - sdk/
+    - LICENSE
+  # Add an implicit attribute to EventFinalizer() and use the
+  # asan declarations from "mozilla/MemoryChecking.h".
+  patches:
+    - moz_attributes.patch

third_party/perfetto/moz_attributes.patch

@@ -0,0 +1,31 @@
+diff --git a/sdk/perfetto.h b/sdk/perfetto.h
+index 411806567..b64f864a9 100644
+--- a/sdk/perfetto.h
++++ b/sdk/perfetto.h
+@@ -365,8 +365,7 @@
+ 
+ #if defined(__clang__)
+ #if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__)
+-extern "C" void __asan_poison_memory_region(void const volatile*, size_t);
+-extern "C" void __asan_unpoison_memory_region(void const volatile*, size_t);
++#include "mozilla/MemoryChecking.h"
+ #define PERFETTO_ASAN_POISON(a, s) __asan_poison_memory_region((a), (s))
+ #define PERFETTO_ASAN_UNPOISON(a, s) __asan_unpoison_memory_region((a), (s))
+ #else
+@@ -19479,6 +19478,7 @@ class TrackEventDataSource
+ #define PERFETTO_INTERNAL_EVENT_FINALIZER_KEYWORD default
+ #endif
+ 
++#include <mozilla/Attributes.h>
+ #define PERFETTO_INTERNAL_SCOPED_EVENT_FINALIZER(category)                    \
+   struct PERFETTO_UID(ScopedEvent) {                                          \
+     struct EventFinalizer {                                                   \
+@@ -19489,7 +19489,7 @@ class TrackEventDataSource
+       /* TrackEventArgumentFunction in |__VA_ARGS__|. This is required so  */ \
+       /* that the scoped event is exactly ONE line and can't escape the    */ \
+       /* scope if used in a single line if statement.                      */ \
+-      EventFinalizer(...) {}                                                  \
++      MOZ_IMPLICIT EventFinalizer(...) {}                                     \
+       ~EventFinalizer() { TRACE_EVENT_END(category); }                        \
+                                                                               \
+       EventFinalizer(const EventFinalizer&) = delete;                         \

toolkit/moz.configure

@@ -114,6 +114,16 @@ set_config("MOZ_GECKO_PROFILER", gecko_profiler_define)
 set_define("MOZ_GECKO_PROFILER", gecko_profiler_define)
 
 
+# Enable perfetto on Android if gecko profiling is enabled and only for
+# nightly builds. Linux support requires at least linux-headers-3.18 for <linux/vm_sockets.h>
+set_config(
+    "MOZ_PERFETTO", gecko_profiler_define, when=target_is_android & milestone.is_nightly
+)
+set_define(
+    "MOZ_PERFETTO", gecko_profiler_define, when=target_is_android & milestone.is_nightly
+)
+
+
 # Whether code to parse ELF binaries should be compiled for the Gecko profiler
 # (for symbol table dumping).
 @depends(gecko_profiler, target)

tools/performance/moz.build

@@ -14,4 +14,7 @@ EXPORTS.mozilla += [
 
 include("/ipc/chromium/chromium-config.mozbuild")
 
+if CONFIG["MOZ_PERFETTO"]:
+    DIRS += ["/third_party/perfetto/"]
+
 FINAL_LIBRARY = "xul"