xref: /aosp_15_r20/external/perfetto/bazel/standalone/perfetto_cfg.bzl (revision 6dbdd20afdafa5e3ca9b8809fa73465d530080dc)
1# Copyright (C) 2019 The Android Open Source Project
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#      http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15# Noop function used to override rules we don't want to support in standalone.
16def _noop_override(**kwargs):
17    pass
18
19PERFETTO_CONFIG = struct(
20    # This is used to refer to deps within perfetto's BUILD files.
21    # In standalone and bazel-based embedders use '//', because perfetto has its
22    # own repository, and //xxx would be relative to @perfetto//xxx.
23    # In Google internal builds, instead, this is set to //third_party/perfetto,
24    # because perfetto doesn't have its own repository there.
25    root = "//",
26
27    # These variables map dependencies to perfetto third-party projects. This is
28    # to allow perfetto embedders (e.g. gapid) and google internal builds to
29    # override paths and target names to their own third_party.
30    deps = struct(
31        # Target exposing the build config header. It should be a valid
32        # cc_library dependency as it will become a dependency of every
33        # perfetto_cc_library target. It needs to expose a
34        # "perfetto_build_flags.h" file that can be included via:
35        # #include "perfetto_build_flags.h".
36        build_config = ["//:build_config_hdr"],
37
38        # Target exposing the PERFETTO_VERSION_STRING() and
39        # PERFETTO_VERSION_SCM_REVISION() macros. This is overridden in google
40        # internal builds.
41        version_header = ["//:cc_perfetto_version_header"],
42
43        # Target exposing platform-specific functionality for base. This is
44        # overriden in Google internal builds.
45        base_platform = ["//:perfetto_base_default_platform"],
46
47        zlib = ["@perfetto_dep_zlib//:zlib"],
48        expat = ["@perfetto_dep_expat//:expat"],
49        jsoncpp = ["@perfetto_dep_jsoncpp//:jsoncpp"],
50        linenoise = ["@perfetto_dep_linenoise//:linenoise"],
51        sqlite = ["@perfetto_dep_sqlite//:sqlite"],
52        sqlite_ext_percentile = ["@perfetto_dep_sqlite_src//:percentile_ext"],
53        protoc = ["@com_google_protobuf//:protoc"],
54        protoc_lib = ["@com_google_protobuf//:protoc_lib"],
55        protobuf_lite = ["@com_google_protobuf//:protobuf_lite"],
56        protobuf_full = ["@com_google_protobuf//:protobuf"],
57        protobuf_descriptor_proto = ["@com_google_protobuf//:descriptor_proto"],
58        open_csd = ["@perfetto_dep_open_csd//:open_csd"],
59
60        # The Python targets are empty on the standalone build because we assume
61        # any relevant deps are installed on the system or are not applicable.
62        protobuf_py = [],
63        pandas_py = [],
64        tp_vendor_py = [],
65        tp_resolvers_py = [],
66
67        # There are multiple configurations for the function name demangling
68        # logic in trace processor:
69        # (1) The following defaults include a subset of demangling sources
70        #     from llvm-project. This is the most complete implementation.
71        # (2) You can avoid the llvm dependency by setting "llvm_demangle = []"
72        #     here and PERFETTO_LLVM_DEMANGLE to false in your
73        #     perfetto_build_flags.h. Then the implementation will use a
74        #     demangler from the c++ runtime, which will most likely handle
75        #     only itanium mangling, and is unavailable on some platforms (e.g.
76        #     Windows, where it becomes a nop).
77        # (3) You can override the whole demangle_wrapper below, and provide
78        #     your own demangling implementation.
79        demangle_wrapper = [ "//:src_trace_processor_demangle" ],
80        llvm_demangle = ["@perfetto_dep_llvm_demangle//:llvm_demangle"],
81    ),
82
83    # This struct allows embedders to customize the cc_opts for Perfetto
84    # 3rd party dependencies. They only have an effect if the dependencies are
85    # initialized with the Perfetto build files (i.e. via perfetto_deps()).
86    deps_copts = struct(
87        zlib = [],
88        expat = [],
89        jsoncpp = [],
90        linenoise = [],
91        sqlite = [],
92        llvm_demangle = [],
93        open_csd = [],
94    ),
95
96    # Allow Bazel embedders to change the visibility of "public" targets.
97    # This variable has been introduced to limit the change to Bazel and avoid
98    # making the targets fully public in the google internal tree.
99    public_visibility = [
100        "//visibility:public",
101    ],
102
103    # Allow Bazel embedders to change the visibility of the proto targets.
104    # This variable has been introduced to limit the change to Bazel and avoid
105    # making the targets public in the google internal tree.
106    proto_library_visibility = "//visibility:private",
107
108    # Allow Bazel embedders to change the visibility of the Go protos.
109    # Go protos have all sorts of strange behaviour in Google3 so need special
110    # handling as the rules for other languages do not work for Go.
111    go_proto_library_visibility = "//visibility:private",
112
113    # This struct allows the embedder to customize copts and other args passed
114    # to rules like cc_binary. Prefixed rules (e.g. perfetto_cc_binary) will
115    # look into this struct before falling back on native.cc_binary().
116    # This field is completely optional, the embedder can omit the whole
117    # |rule_overrides| or invidivual keys. They are assigned to None or noop
118    # actions here just for documentation purposes.
119    rule_overrides = struct(
120        proto_library = None,
121
122        cc_binary = None,
123        cc_library = None,
124        cc_proto_library = None,
125
126        # Supporting java rules pulls in the JDK and generally is not something
127        # we need for most embedders.
128        java_proto_library = _noop_override,
129        java_lite_proto_library = _noop_override,
130
131        py_binary = None,
132        py_library = None,
133        py_proto_library = None,
134
135        go_proto_library = None,
136
137        jspb_proto_library = None,
138    ),
139
140    # The default copts which we use to compile C++ code.
141    default_copts = [
142        "-std=c++17",
143    ]
144)
145