| /* |
| * Copyright (C) 2018 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. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * 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. |
| */ |
| |
| #include "src/perfetto_cmd/perfetto_cmd.h" |
| |
| #include <fcntl.h> |
| #include <stdio.h> |
| #include <sys/stat.h> |
| #include <sys/types.h> |
| #include <time.h> |
| |
| #include <algorithm> |
| #include <array> |
| #include <atomic> |
| #include <chrono> |
| #include <cinttypes> |
| #include <cstdint> |
| #include <cstdlib> |
| #include <cstring> |
| #include <functional> |
| #include <iostream> |
| #include <iterator> |
| #include <memory> |
| #include <mutex> |
| #include <optional> |
| #include <random> |
| #include <string> |
| #include <thread> |
| #include <utility> |
| #include <vector> |
| |
| #include "perfetto/base/build_config.h" |
| #include "perfetto/base/compiler.h" |
| #include "perfetto/base/logging.h" |
| #include "perfetto/base/proc_utils.h" // IWYU pragma: keep |
| #include "perfetto/ext/base/android_utils.h" // IWYU pragma: keep |
| #include "perfetto/ext/base/ctrl_c_handler.h" |
| #include "perfetto/ext/base/file_utils.h" |
| #include "perfetto/ext/base/getopt.h" // IWYU pragma: keep |
| #include "perfetto/ext/base/no_destructor.h" |
| #include "perfetto/ext/base/pipe.h" |
| #include "perfetto/ext/base/scoped_file.h" |
| #include "perfetto/ext/base/string_splitter.h" |
| #include "perfetto/ext/base/string_utils.h" |
| #include "perfetto/ext/base/string_view.h" |
| #include "perfetto/ext/base/thread_task_runner.h" |
| #include "perfetto/ext/base/thread_utils.h" |
| #include "perfetto/ext/base/utils.h" |
| #include "perfetto/ext/base/uuid.h" |
| #include "perfetto/ext/base/version.h" |
| #include "perfetto/ext/base/waitable_event.h" |
| #include "perfetto/ext/traced/traced.h" |
| #include "perfetto/ext/tracing/core/basic_types.h" |
| #include "perfetto/ext/tracing/core/trace_packet.h" |
| #include "perfetto/ext/tracing/core/tracing_service.h" |
| #include "perfetto/ext/tracing/ipc/consumer_ipc_client.h" |
| #include "perfetto/tracing/core/flush_flags.h" |
| #include "perfetto/tracing/core/forward_decls.h" |
| #include "perfetto/tracing/core/trace_config.h" |
| #include "perfetto/tracing/default_socket.h" |
| #include "protos/perfetto/common/data_source_descriptor.gen.h" |
| #include "src/android_stats/perfetto_atoms.h" |
| #include "src/android_stats/statsd_logging_helper.h" |
| #include "src/perfetto_cmd/bugreport_path.h" |
| #include "src/perfetto_cmd/config.h" |
| #include "src/perfetto_cmd/packet_writer.h" |
| #include "src/perfetto_cmd/pbtxt_to_pb.h" |
| #include "src/perfetto_cmd/rate_limiter.h" |
| #include "src/perfetto_cmd/trigger_producer.h" |
| |
| #include "protos/perfetto/common/ftrace_descriptor.gen.h" |
| #include "protos/perfetto/common/tracing_service_state.gen.h" |
| #include "protos/perfetto/common/track_event_descriptor.gen.h" |
| |
| // For dup() (and _setmode() on windows). |
| #if PERFETTO_BUILDFLAG(PERFETTO_OS_WIN) |
| #include <fcntl.h> |
| #include <io.h> |
| #else |
| #include <unistd.h> |
| #endif |
| |
| namespace perfetto { |
| namespace { |
| |
| std::atomic<perfetto::PerfettoCmd*> g_perfetto_cmd; |
| |
| const uint32_t kOnTraceDataTimeoutMs = 3000; |
| const uint32_t kCloneTimeoutMs = 30000; |
| |
| class LoggingErrorReporter : public ErrorReporter { |
| public: |
| LoggingErrorReporter(std::string file_name, const char* config) |
| : file_name_(std::move(file_name)), config_(config) {} |
| |
| void AddError(size_t row, |
| size_t column, |
| size_t length, |
| const std::string& message) override { |
| parsed_successfully_ = false; |
| std::string line = ExtractLine(row - 1).ToStdString(); |
| if (!line.empty() && line[line.length() - 1] == '\n') { |
| line.erase(line.length() - 1); |
| } |
| |
| std::string guide(column + length, ' '); |
| for (size_t i = column; i < column + length; i++) { |
| guide[i - 1] = i == column ? '^' : '~'; |
| } |
| fprintf(stderr, "%s:%zu:%zu error: %s\n", file_name_.c_str(), row, column, |
| message.c_str()); |
| fprintf(stderr, "%s\n", line.c_str()); |
| fprintf(stderr, "%s\n", guide.c_str()); |
| } |
| |
| bool Success() const { return parsed_successfully_; } |
| |
| private: |
| base::StringView ExtractLine(size_t line) { |
| const char* start = config_; |
| const char* end = config_; |
| |
| for (size_t i = 0; i < line + 1; i++) { |
| start = end; |
| char c; |
| while ((c = *end++) && c != '\n') |
| ; |
| } |
| return base::StringView(start, static_cast<size_t>(end - start)); |
| } |
| |
| bool parsed_successfully_ = true; |
| std::string file_name_; |
| const char* config_; |
| }; |
| |
| bool ParseTraceConfigPbtxt(const std::string& file_name, |
| const std::string& pbtxt, |
| TraceConfig* config) { |
| LoggingErrorReporter reporter(file_name, pbtxt.c_str()); |
| std::vector<uint8_t> buf = PbtxtToPb(pbtxt, &reporter); |
| if (!reporter.Success()) |
| return false; |
| if (!config->ParseFromArray(buf.data(), buf.size())) |
| return false; |
| return true; |
| } |
| |
| bool IsUserBuild() { |
| #if PERFETTO_BUILDFLAG(PERFETTO_ANDROID_BUILD) |
| std::string build_type = base::GetAndroidProp("ro.build.type"); |
| if (build_type.empty()) { |
| PERFETTO_ELOG("Unable to read ro.build.type: assuming user build"); |
| return true; |
| } |
| return build_type == "user"; |
| #else |
| return false; |
| #endif // PERFETTO_BUILDFLAG(PERFETTO_ANDROID_BUILD) |
| } |
| |
| std::optional<PerfettoStatsdAtom> ConvertRateLimiterResponseToAtom( |
| RateLimiter::ShouldTraceResponse resp) { |
| switch (resp) { |
| case RateLimiter::kNotAllowedOnUserBuild: |
| return PerfettoStatsdAtom::kCmdUserBuildTracingNotAllowed; |
| case RateLimiter::kOkToTrace: |
| return std::nullopt; |
| } |
| PERFETTO_FATAL("For GCC"); |
| } |
| |
| void ArgsAppend(std::string* str, const std::string& arg) { |
| str->append(arg); |
| str->append("\0", 1); |
| } |
| } // namespace |
| |
| const char* kStateDir = "/data/misc/perfetto-traces"; |
| |
| PerfettoCmd::PerfettoCmd() { |
| // Only the main thread instance on the main thread will receive ctrl-c. |
| PerfettoCmd* set_if_null = nullptr; |
| g_perfetto_cmd.compare_exchange_strong(set_if_null, this); |
| } |
| |
| PerfettoCmd::~PerfettoCmd() { |
| PerfettoCmd* self = this; |
| if (g_perfetto_cmd.compare_exchange_strong(self, nullptr)) { |
| if (ctrl_c_handler_installed_) { |
| task_runner_.RemoveFileDescriptorWatch(ctrl_c_evt_.fd()); |
| } |
| } |
| } |
| |
| void PerfettoCmd::PrintUsage(const char* argv0) { |
| fprintf(stderr, R"( |
| Usage: %s |
| --background -d : Exits immediately and continues in the background. |
| Prints the PID of the bg process. The printed PID |
| can used to gracefully terminate the tracing |
| session by issuing a `kill -TERM $PRINTED_PID`. |
| --background-wait -D : Like --background, but waits (up to 30s) for all |
| data sources to be started before exiting. Exit |
| code is zero if a successful acknowledgement is |
| received, non-zero otherwise (error or timeout). |
| --clone TSID : Creates a read-only clone of an existing tracing |
| session, identified by its ID (see --query). |
| --clone-for-bugreport : Can only be used with --clone. It disables the |
| trace_filter on the cloned session. |
| --config -c : /path/to/trace/config/file or - for stdin |
| --out -o : /path/to/out/trace/file or - for stdout |
| If using CLONE_SNAPSHOT triggers, each snapshot |
| will be saved in a new file with a counter suffix |
| (e.g., file.0, file.1, file.2). |
| --txt : Parse config as pbtxt. Not for production use. |
| Not a stable API. |
| --query [--long] : Queries the service state and prints it as |
| human-readable text. --long allows the output to |
| extend past 80 chars. |
| --query-raw : Like --query, but prints raw proto-encoded bytes |
| of tracing_service_state.proto. |
| --help -h |
| |
| Light configuration flags: (only when NOT using -c/--config) |
| --time -t : Trace duration N[s,m,h] (default: 10s) |
| --buffer -b : Ring buffer size N[mb,gb] (default: 32mb) |
| --size -s : Max file size N[mb,gb] |
| (default: in-memory ring-buffer only) |
| --app -a : Android (atrace) app name |
| FTRACE_GROUP/FTRACE_NAME : Record ftrace event (e.g. sched/sched_switch) |
| ATRACE_CAT : Record ATRACE_CAT (e.g. wm) (Android only) |
| |
| Statsd-specific and other Android-only flags: |
| --alert-id : ID of the alert that triggered this trace. |
| --config-id : ID of the triggering config. |
| --config-uid : UID of app which registered the config. |
| --subscription-id : ID of the subscription that triggered this trace. |
| --upload : Upload trace. |
| --dropbox TAG : DEPRECATED: Use --upload instead |
| TAG should always be set to 'perfetto'. |
| --save-for-bugreport : If a trace with bugreport_score > 0 is running, it |
| saves it into a file. Outputs the path when done. |
| --no-guardrails : Ignore guardrails triggered when using --upload |
| (testing only). |
| --reset-guardrails : Resets the state of the guardails and exits |
| (testing only). |
| |
| Detach mode. DISCOURAGED, read https://perfetto.dev/docs/concepts/detached-mode |
| --detach=key : Detach from the tracing session with the given key. |
| --attach=key [--stop] : Re-attach to the session (optionally stop tracing |
| once reattached). |
| --is_detached=key : Check if the session can be re-attached. |
| Exit code: 0:Yes, 2:No, 1:Error. |
| )", /* this comment fixes syntax highlighting in some editors */ |
| argv0); |
| } |
| |
| std::optional<int> PerfettoCmd::ParseCmdlineAndMaybeDaemonize(int argc, |
| char** argv) { |
| #if !PERFETTO_BUILDFLAG(PERFETTO_OS_WIN) |
| umask(0000); // make sure that file creation is not affected by umask. |
| #endif |
| enum LongOption { |
| OPT_ALERT_ID = 1000, |
| OPT_BUGREPORT, |
| OPT_BUGREPORT_ALL, |
| OPT_CLONE, |
| OPT_CLONE_SKIP_FILTER, |
| OPT_CONFIG_ID, |
| OPT_CONFIG_UID, |
| OPT_SUBSCRIPTION_ID, |
| OPT_RESET_GUARDRAILS, |
| OPT_PBTXT_CONFIG, |
| OPT_DROPBOX, |
| OPT_UPLOAD, |
| OPT_IGNORE_GUARDRAILS, |
| OPT_DETACH, |
| OPT_ATTACH, |
| OPT_IS_DETACHED, |
| OPT_STOP, |
| OPT_QUERY, |
| OPT_LONG, |
| OPT_QUERY_RAW, |
| OPT_VERSION, |
| }; |
| static const option long_options[] = { |
| {"help", no_argument, nullptr, 'h'}, |
| {"config", required_argument, nullptr, 'c'}, |
| {"out", required_argument, nullptr, 'o'}, |
| {"background", no_argument, nullptr, 'd'}, |
| {"background-wait", no_argument, nullptr, 'D'}, |
| {"time", required_argument, nullptr, 't'}, |
| {"buffer", required_argument, nullptr, 'b'}, |
| {"size", required_argument, nullptr, 's'}, |
| {"app", required_argument, nullptr, 'a'}, |
| {"no-guardrails", no_argument, nullptr, OPT_IGNORE_GUARDRAILS}, |
| {"txt", no_argument, nullptr, OPT_PBTXT_CONFIG}, |
| {"upload", no_argument, nullptr, OPT_UPLOAD}, |
| {"dropbox", required_argument, nullptr, OPT_DROPBOX}, |
| {"alert-id", required_argument, nullptr, OPT_ALERT_ID}, |
| {"config-id", required_argument, nullptr, OPT_CONFIG_ID}, |
| {"config-uid", required_argument, nullptr, OPT_CONFIG_UID}, |
| {"subscription-id", required_argument, nullptr, OPT_SUBSCRIPTION_ID}, |
| {"reset-guardrails", no_argument, nullptr, OPT_RESET_GUARDRAILS}, |
| {"detach", required_argument, nullptr, OPT_DETACH}, |
| {"attach", required_argument, nullptr, OPT_ATTACH}, |
| {"clone", required_argument, nullptr, OPT_CLONE}, |
| {"clone-for-bugreport", no_argument, nullptr, OPT_CLONE_SKIP_FILTER}, |
| {"is_detached", required_argument, nullptr, OPT_IS_DETACHED}, |
| {"stop", no_argument, nullptr, OPT_STOP}, |
| {"query", no_argument, nullptr, OPT_QUERY}, |
| {"long", no_argument, nullptr, OPT_LONG}, |
| {"query-raw", no_argument, nullptr, OPT_QUERY_RAW}, |
| {"version", no_argument, nullptr, OPT_VERSION}, |
| {"save-for-bugreport", no_argument, nullptr, OPT_BUGREPORT}, |
| {"save-all-for-bugreport", no_argument, nullptr, OPT_BUGREPORT_ALL}, |
| {nullptr, 0, nullptr, 0}}; |
| |
| std::string config_file_name; |
| std::string trace_config_raw; |
| bool parse_as_pbtxt = false; |
| TraceConfig::StatsdMetadata statsd_metadata; |
| limiter_.reset(new RateLimiter()); |
| |
| ConfigOptions config_options; |
| bool has_config_options = false; |
| |
| if (argc <= 1) { |
| PrintUsage(argv[0]); |
| return 1; |
| } |
| |
| // getopt is not thread safe and cmdline parsing requires a mutex for the case |
| // of concurrent cmdline parsing for bugreport snapshots. |
| static base::NoDestructor<std::mutex> getopt_mutex; |
| std::unique_lock<std::mutex> getopt_lock(getopt_mutex.ref()); |
| |
| optind = 1; // Reset getopt state. It's reused by the snapshot thread. |
| for (;;) { |
| int option = |
| getopt_long(argc, argv, "hc:o:dDt:b:s:a:", long_options, nullptr); |
| |
| if (option == -1) |
| break; // EOF. |
| |
| if (option == 'c') { |
| config_file_name = std::string(optarg); |
| if (strcmp(optarg, "-") == 0) { |
| #if PERFETTO_BUILDFLAG(PERFETTO_OS_WIN) |
| // We don't want the runtime to replace "\n" with "\r\n" on `std::cin`. |
| _setmode(_fileno(stdin), _O_BINARY); |
| #endif |
| std::istreambuf_iterator<char> begin(std::cin), end; |
| trace_config_raw.assign(begin, end); |
| } else if (strcmp(optarg, ":test") == 0) { |
| TraceConfig test_config; |
| ConfigOptions opts; |
| opts.time = "2s"; |
| opts.categories.emplace_back("sched/sched_switch"); |
| opts.categories.emplace_back("power/cpu_idle"); |
| opts.categories.emplace_back("power/cpu_frequency"); |
| opts.categories.emplace_back("power/gpu_frequency"); |
| PERFETTO_CHECK(CreateConfigFromOptions(opts, &test_config)); |
| trace_config_raw = test_config.SerializeAsString(); |
| } else if (strcmp(optarg, ":mem") == 0) { |
| // This is used by OnCloneSnapshotTriggerReceived(), which passes the |
| // original trace config as a member field. This is needed because, in |
| // the new PerfettoCmd instance, we need to know upfront trace config |
| // fields that affect the behaviour of perfetto_cmd, e.g., the guardrail |
| // overrides, the unique_session_name, the reporter API package etc. |
| PERFETTO_CHECK(!snapshot_config_.empty()); |
| trace_config_raw = snapshot_config_; |
| } else { |
| if (!base::ReadFile(optarg, &trace_config_raw)) { |
| #if PERFETTO_BUILDFLAG(PERFETTO_ANDROID_BUILD) |
| PERFETTO_PLOG( |
| "Could not open %s. If this is a permission denied error, try " |
| "placing the config in /data/misc/perfetto-configs: Perfetto " |
| "should always be able to access this directory.", |
| optarg); |
| #else |
| PERFETTO_PLOG("Could not open %s", optarg); |
| #endif |
| return 1; |
| } |
| } |
| continue; |
| } |
| |
| if (option == 'o') { |
| trace_out_path_ = optarg; |
| continue; |
| } |
| |
| if (option == 'd') { |
| background_ = true; |
| continue; |
| } |
| |
| if (option == 'D') { |
| background_ = true; |
| background_wait_ = true; |
| continue; |
| } |
| |
| if (option == OPT_CLONE) { |
| clone_tsid_ = static_cast<TracingSessionID>(atoll(optarg)); |
| continue; |
| } |
| |
| if (option == OPT_CLONE_SKIP_FILTER) { |
| clone_for_bugreport_ = true; |
| continue; |
| } |
| |
| if (option == 't') { |
| has_config_options = true; |
| config_options.time = std::string(optarg); |
| continue; |
| } |
| |
| if (option == 'b') { |
| has_config_options = true; |
| config_options.buffer_size = std::string(optarg); |
| continue; |
| } |
| |
| if (option == 's') { |
| has_config_options = true; |
| config_options.max_file_size = std::string(optarg); |
| continue; |
| } |
| |
| if (option == 'a') { |
| config_options.atrace_apps.push_back(std::string(optarg)); |
| has_config_options = true; |
| continue; |
| } |
| |
| if (option == OPT_UPLOAD) { |
| #if PERFETTO_BUILDFLAG(PERFETTO_OS_ANDROID) |
| upload_flag_ = true; |
| continue; |
| #else |
| PERFETTO_ELOG("--upload is only supported on Android"); |
| return 1; |
| #endif |
| } |
| |
| if (option == OPT_DROPBOX) { |
| #if PERFETTO_BUILDFLAG(PERFETTO_OS_ANDROID) |
| PERFETTO_CHECK(optarg); |
| upload_flag_ = true; |
| continue; |
| #else |
| PERFETTO_ELOG("--dropbox is only supported on Android"); |
| return 1; |
| #endif |
| } |
| |
| if (option == OPT_PBTXT_CONFIG) { |
| parse_as_pbtxt = true; |
| continue; |
| } |
| |
| if (option == OPT_IGNORE_GUARDRAILS) { |
| ignore_guardrails_ = true; |
| continue; |
| } |
| |
| if (option == OPT_RESET_GUARDRAILS) { |
| PERFETTO_ILOG( |
| "Guardrails no longer exist in perfetto_cmd; this option only exists " |
| "for backwards compatability."); |
| return 0; |
| } |
| |
| if (option == OPT_ALERT_ID) { |
| statsd_metadata.set_triggering_alert_id(atoll(optarg)); |
| continue; |
| } |
| |
| if (option == OPT_CONFIG_ID) { |
| statsd_metadata.set_triggering_config_id(atoll(optarg)); |
| continue; |
| } |
| |
| if (option == OPT_CONFIG_UID) { |
| statsd_metadata.set_triggering_config_uid(atoi(optarg)); |
| continue; |
| } |
| |
| if (option == OPT_SUBSCRIPTION_ID) { |
| statsd_metadata.set_triggering_subscription_id(atoll(optarg)); |
| continue; |
| } |
| |
| if (option == OPT_DETACH) { |
| detach_key_ = std::string(optarg); |
| PERFETTO_CHECK(!detach_key_.empty()); |
| continue; |
| } |
| |
| if (option == OPT_ATTACH) { |
| attach_key_ = std::string(optarg); |
| PERFETTO_CHECK(!attach_key_.empty()); |
| continue; |
| } |
| |
| if (option == OPT_IS_DETACHED) { |
| attach_key_ = std::string(optarg); |
| redetach_once_attached_ = true; |
| PERFETTO_CHECK(!attach_key_.empty()); |
| continue; |
| } |
| |
| if (option == OPT_STOP) { |
| stop_trace_once_attached_ = true; |
| continue; |
| } |
| |
| if (option == OPT_QUERY) { |
| query_service_ = true; |
| continue; |
| } |
| |
| if (option == OPT_LONG) { |
| query_service_long_ = true; |
| continue; |
| } |
| |
| if (option == OPT_QUERY_RAW) { |
| query_service_ = true; |
| query_service_output_raw_ = true; |
| continue; |
| } |
| |
| if (option == OPT_VERSION) { |
| printf("%s\n", base::GetVersionString()); |
| return 0; |
| } |
| |
| if (option == OPT_BUGREPORT) { |
| bugreport_ = true; |
| continue; |
| } |
| |
| if (option == OPT_BUGREPORT_ALL) { |
| clone_all_bugreport_traces_ = true; |
| continue; |
| } |
| |
| PrintUsage(argv[0]); |
| return 1; |
| } |
| |
| for (ssize_t i = optind; i < argc; i++) { |
| has_config_options = true; |
| config_options.categories.push_back(argv[i]); |
| } |
| getopt_lock.unlock(); |
| |
| if (query_service_ && (is_detach() || is_attach() || background_)) { |
| PERFETTO_ELOG("--query cannot be combined with any other argument"); |
| return 1; |
| } |
| |
| if (query_service_long_ && !query_service_) { |
| PERFETTO_ELOG("--long can only be used with --query"); |
| return 1; |
| } |
| |
| if (is_detach() && is_attach()) { |
| PERFETTO_ELOG("--attach and --detach are mutually exclusive"); |
| return 1; |
| } |
| |
| if (is_detach() && background_) { |
| PERFETTO_ELOG("--detach and --background are mutually exclusive"); |
| return 1; |
| } |
| |
| if (stop_trace_once_attached_ && !is_attach()) { |
| PERFETTO_ELOG("--stop is supported only in combination with --attach"); |
| return 1; |
| } |
| |
| if ((bugreport_ || clone_all_bugreport_traces_) && |
| (is_attach() || is_detach() || query_service_ || has_config_options || |
| background_wait_)) { |
| PERFETTO_ELOG("--save-for-bugreport cannot take any other argument"); |
| return 1; |
| } |
| |
| if (clone_for_bugreport_ && !clone_tsid_) { |
| PERFETTO_ELOG("--clone-for-bugreport requires --clone"); |
| return 1; |
| } |
| |
| // --save-for-bugreport is the equivalent of: |
| // --clone kBugreportSessionId -o /data/misc/perfetto-traces/bugreport/... |
| if (bugreport_ && trace_out_path_.empty()) { |
| PERFETTO_LOG("Invoked perfetto with --save-for-bugreport"); |
| clone_tsid_ = kBugreportSessionId; |
| clone_for_bugreport_ = true; |
| trace_out_path_ = GetBugreportTracePath(); |
| } |
| |
| // Parse the trace config. It can be either: |
| // 1) A proto-encoded file/stdin (-c ...). |
| // 2) A proto-text file/stdin (-c ... --txt). |
| // 3) A set of option arguments (-t 10s -s 10m). |
| // The only cases in which a trace config is not expected is --attach. |
| // For this we are just acting on already existing sessions. |
| trace_config_.reset(new TraceConfig()); |
| |
| bool parsed = false; |
| bool cfg_could_be_txt = false; |
| const bool will_trace_or_trigger = |
| !is_attach() && !query_service_ && !clone_all_bugreport_traces_; |
| if (!will_trace_or_trigger) { |
| if ((!trace_config_raw.empty() || has_config_options)) { |
| PERFETTO_ELOG("Cannot specify a trace config with this option"); |
| return 1; |
| } |
| } else if (has_config_options) { |
| if (!trace_config_raw.empty()) { |
| PERFETTO_ELOG( |
| "Cannot specify both -c/--config and any of --time, --size, " |
| "--buffer, --app, ATRACE_CAT, FTRACE_EVENT"); |
| return 1; |
| } |
| parsed = CreateConfigFromOptions(config_options, trace_config_.get()); |
| } else { |
| if (trace_config_raw.empty() && !clone_tsid_) { |
| PERFETTO_ELOG("The TraceConfig is empty"); |
| return 1; |
| } |
| PERFETTO_DLOG("Parsing TraceConfig, %zu bytes", trace_config_raw.size()); |
| if (parse_as_pbtxt) { |
| parsed = ParseTraceConfigPbtxt(config_file_name, trace_config_raw, |
| trace_config_.get()); |
| } else { |
| parsed = trace_config_->ParseFromString(trace_config_raw); |
| cfg_could_be_txt = |
| !parsed && std::all_of(trace_config_raw.begin(), |
| trace_config_raw.end(), [](char c) { |
| // This is equiv to: isprint(c) || isspace(x) |
| // but doesn't depend on and load the locale. |
| return (c >= 32 && c <= 126) || |
| (c >= 9 && c <= 13); |
| }); |
| } |
| } |
| |
| if (parsed) { |
| *trace_config_->mutable_statsd_metadata() = std::move(statsd_metadata); |
| trace_config_raw.clear(); |
| } else if (will_trace_or_trigger && !clone_tsid_) { |
| PERFETTO_ELOG("The trace config is invalid, bailing out."); |
| if (cfg_could_be_txt) { |
| PERFETTO_ELOG( |
| "Looks like you are passing a textual config but I'm expecting a " |
| "proto-encoded binary config."); |
| PERFETTO_ELOG("Try adding --txt to the cmdline."); |
| } |
| return 1; |
| } |
| |
| if (trace_config_->trace_uuid_lsb() == 0 && |
| trace_config_->trace_uuid_msb() == 0) { |
| base::Uuid uuid = base::Uuidv4(); |
| if (trace_config_->statsd_metadata().triggering_subscription_id()) { |
| uuid.set_lsb( |
| trace_config_->statsd_metadata().triggering_subscription_id()); |
| } |
| uuid_ = uuid.ToString(); |
| trace_config_->set_trace_uuid_msb(uuid.msb()); |
| trace_config_->set_trace_uuid_lsb(uuid.lsb()); |
| } else { |
| base::Uuid uuid(trace_config_->trace_uuid_lsb(), |
| trace_config_->trace_uuid_msb()); |
| uuid_ = uuid.ToString(); |
| } |
| |
| const auto& delay = trace_config_->cmd_trace_start_delay(); |
| if (delay.has_max_delay_ms() != delay.has_min_delay_ms()) { |
| PERFETTO_ELOG("cmd_trace_start_delay field is only partially specified."); |
| return 1; |
| } |
| |
| bool has_incidentd_package = |
| !trace_config_->incident_report_config().destination_package().empty(); |
| if (has_incidentd_package && !upload_flag_) { |
| PERFETTO_ELOG( |
| "Unexpected IncidentReportConfig without --dropbox / --upload."); |
| return 1; |
| } |
| |
| bool has_android_reporter_package = !trace_config_->android_report_config() |
| .reporter_service_package() |
| .empty(); |
| if (has_android_reporter_package && !upload_flag_) { |
| PERFETTO_ELOG( |
| "Unexpected AndroidReportConfig without --dropbox / --upload."); |
| return 1; |
| } |
| |
| if (has_incidentd_package && has_android_reporter_package) { |
| PERFETTO_ELOG( |
| "Only one of IncidentReportConfig and AndroidReportConfig " |
| "allowed in the same config."); |
| return 1; |
| } |
| |
| // If the upload flag is set, we can only be doing one of three things: |
| // 1. Reporting to either incidentd or Android framework. |
| // 2. Skipping incidentd/Android report because it was explicitly |
| // specified in the config. |
| // 3. Activating triggers. |
| bool incidentd_valid = |
| has_incidentd_package || |
| trace_config_->incident_report_config().skip_incidentd(); |
| bool android_report_valid = |
| has_android_reporter_package || |
| trace_config_->android_report_config().skip_report(); |
| bool has_triggers = !trace_config_->activate_triggers().empty(); |
| if (upload_flag_ && !incidentd_valid && !android_report_valid && |
| !has_triggers) { |
| PERFETTO_ELOG( |
| "One of IncidentReportConfig, AndroidReportConfig or activate_triggers " |
| "must be specified with --dropbox / --upload."); |
| return 1; |
| } |
| |
| // Only save to incidentd if: |
| // 1) |destination_package| is set |
| // 2) |skip_incidentd| is absent or false. |
| // 3) we are not simply activating triggers. |
| save_to_incidentd_ = |
| has_incidentd_package && |
| !trace_config_->incident_report_config().skip_incidentd() && |
| !has_triggers; |
| |
| // Only report to the Andorid framework if: |
| // 1) |reporter_service_package| is set |
| // 2) |skip_report| is absent or false. |
| // 3) we are not simply activating triggers. |
| report_to_android_framework_ = |
| has_android_reporter_package && |
| !trace_config_->android_report_config().skip_report() && !has_triggers; |
| |
| // Respect the wishes of the config with respect to statsd logging or fall |
| // back on the presence of the --upload flag if not set. |
| switch (trace_config_->statsd_logging()) { |
| case TraceConfig::STATSD_LOGGING_ENABLED: |
| statsd_logging_ = true; |
| break; |
| case TraceConfig::STATSD_LOGGING_DISABLED: |
| statsd_logging_ = false; |
| break; |
| case TraceConfig::STATSD_LOGGING_UNSPECIFIED: |
| statsd_logging_ = upload_flag_; |
| break; |
| } |
| trace_config_->set_statsd_logging(statsd_logging_ |
| ? TraceConfig::STATSD_LOGGING_ENABLED |
| : TraceConfig::STATSD_LOGGING_DISABLED); |
| |
| // Set up the output file. Either --out or --upload are expected, with the |
| // only exception of --attach. In this case the output file is passed when |
| // detaching. |
| if (!trace_out_path_.empty() && upload_flag_) { |
| PERFETTO_ELOG( |
| "Can't log to a file (--out) and incidentd (--upload) at the same " |
| "time"); |
| return 1; |
| } |
| |
| if (!trace_config_->output_path().empty()) { |
| if (!trace_out_path_.empty() || upload_flag_) { |
| PERFETTO_ELOG( |
| "Can't pass --out or --upload if output_path is set in the " |
| "trace config"); |
| return 1; |
| } |
| if (base::FileExists(trace_config_->output_path())) { |
| PERFETTO_ELOG( |
| "The output_path must not exist, the service cannot overwrite " |
| "existing files for security reasons. Remove %s or use a different " |
| "path.", |
| trace_config_->output_path().c_str()); |
| return 1; |
| } |
| } |
| |
| // |activate_triggers| in the trace config is shorthand for trigger_perfetto. |
| // In this case we don't intend to send any trace config to the service, |
| // rather use that as a signal to the cmdline client to connect as a producer |
| // and activate triggers. |
| if (has_triggers) { |
| for (const auto& trigger : trace_config_->activate_triggers()) { |
| triggers_to_activate_.push_back(trigger); |
| } |
| trace_config_.reset(new TraceConfig()); |
| } |
| |
| bool open_out_file = true; |
| if (!will_trace_or_trigger) { |
| open_out_file = false; |
| if (!trace_out_path_.empty() || upload_flag_) { |
| PERFETTO_ELOG("Can't pass an --out file (or --upload) with this option"); |
| return 1; |
| } |
| } else if (!triggers_to_activate_.empty() || |
| (trace_config_->write_into_file() && |
| !trace_config_->output_path().empty())) { |
| open_out_file = false; |
| } else if (trace_out_path_.empty() && !upload_flag_) { |
| PERFETTO_ELOG("Either --out or --upload is required"); |
| return 1; |
| } else if (is_detach() && !trace_config_->write_into_file()) { |
| // In detached mode we must pass the file descriptor to the service and |
| // let that one write the trace. We cannot use the IPC readback code path |
| // because the client process is about to exit soon after detaching. |
| // We could support detach && !write_into_file, but that would make the |
| // cmdline logic more complex. The feasible configurations are: |
| // 1. Using write_into_file and passing the file path on the --detach call. |
| // 2. Using pure ring-buffer mode, setting write_into_file = false and |
| // passing the output file path to the --attach call. |
| // This is too complicated and harder to reason about, so we support only 1. |
| // Traceur gets around this by always setting write_into_file and specifying |
| // file_write_period_ms = 1week (which effectively means: write into the |
| // file only at the end of the trace) to achieve ring buffer traces. |
| PERFETTO_ELOG( |
| "TraceConfig's write_into_file must be true when using --detach"); |
| return 1; |
| } |
| if (open_out_file) { |
| if (!OpenOutputFile()) |
| return 1; |
| if (!trace_config_->write_into_file()) |
| packet_writer_.emplace(trace_out_stream_.get()); |
| } |
| |
| bool will_trace_indefinitely = |
| trace_config_->duration_ms() == 0 && |
| trace_config_->trigger_config().trigger_timeout_ms() == 0; |
| if (will_trace_indefinitely && save_to_incidentd_ && !ignore_guardrails_) { |
| PERFETTO_ELOG("Can't trace indefinitely when tracing to Incidentd."); |
| return 1; |
| } |
| |
| if (will_trace_indefinitely && report_to_android_framework_ && |
| !ignore_guardrails_) { |
| PERFETTO_ELOG( |
| "Can't trace indefinitely when reporting to Android framework."); |
| return 1; |
| } |
| |
| if (background_) { |
| if (background_wait_) { |
| #if !PERFETTO_BUILDFLAG(PERFETTO_OS_WIN) |
| background_wait_pipe_ = base::Pipe::Create(base::Pipe::kRdNonBlock); |
| #endif |
| } |
| |
| PERFETTO_CHECK(snapshot_threads_.empty()); // No threads before Daemonize. |
| base::Daemonize([this]() -> int { |
| background_wait_pipe_.wr.reset(); |
| |
| if (background_wait_) { |
| return WaitOnBgProcessPipe(); |
| } |
| |
| return 0; |
| }); |
| background_wait_pipe_.rd.reset(); |
| } |
| |
| return std::nullopt; // Continues in ConnectToServiceRunAndMaybeNotify() |
| // below. |
| } |
| |
| void PerfettoCmd::NotifyBgProcessPipe(BgProcessStatus status) { |
| #if !PERFETTO_BUILDFLAG(PERFETTO_OS_WIN) |
| if (!background_wait_pipe_.wr) { |
| return; |
| } |
| static_assert(sizeof status == 1, "Enum bigger than one byte"); |
| PERFETTO_EINTR(write(background_wait_pipe_.wr.get(), &status, 1)); |
| background_wait_pipe_.wr.reset(); |
| #else // PERFETTO_BUILDFLAG(PERFETTO_OS_WIN) |
| base::ignore_result(status); |
| #endif //! PERFETTO_BUILDFLAG(PERFETTO_OS_WIN) |
| } |
| |
| PerfettoCmd::BgProcessStatus PerfettoCmd::WaitOnBgProcessPipe() { |
| #if !PERFETTO_BUILDFLAG(PERFETTO_OS_WIN) |
| base::ScopedPlatformHandle fd = std::move(background_wait_pipe_.rd); |
| PERFETTO_CHECK(fd); |
| |
| BgProcessStatus msg; |
| static_assert(sizeof msg == 1, "Enum bigger than one byte"); |
| std::array<pollfd, 1> pollfds = {pollfd{fd.get(), POLLIN, 0}}; |
| |
| int ret = PERFETTO_EINTR(poll(&pollfds[0], pollfds.size(), 30000 /*ms*/)); |
| PERFETTO_CHECK(ret >= 0); |
| if (ret == 0) { |
| fprintf(stderr, "Timeout waiting for all data sources to start\n"); |
| return kBackgroundTimeout; |
| } |
| ssize_t read_ret = PERFETTO_EINTR(read(fd.get(), &msg, 1)); |
| PERFETTO_CHECK(read_ret >= 0); |
| if (read_ret == 0) { |
| fprintf(stderr, "Background process didn't report anything\n"); |
| return kBackgroundOtherError; |
| } |
| |
| if (msg != kBackgroundOk) { |
| fprintf(stderr, "Background process failed, BgProcessStatus=%d\n", |
| static_cast<int>(msg)); |
| return msg; |
| } |
| #endif //! PERFETTO_BUILDFLAG(PERFETTO_OS_WIN) |
| |
| return kBackgroundOk; |
| } |
| |
| int PerfettoCmd::ConnectToServiceRunAndMaybeNotify() { |
| int exit_code = ConnectToServiceAndRun(); |
| |
| NotifyBgProcessPipe(exit_code == 0 ? kBackgroundOk : kBackgroundOtherError); |
| |
| return exit_code; |
| } |
| |
| int PerfettoCmd::ConnectToServiceAndRun() { |
| // If we are just activating triggers then we don't need to rate limit, |
| // connect as a consumer or run the trace. So bail out after processing all |
| // the options. |
| if (!triggers_to_activate_.empty()) { |
| LogTriggerEvents(PerfettoTriggerAtom::kCmdTrigger, triggers_to_activate_); |
| |
| bool finished_with_success = false; |
| auto weak_this = weak_factory_.GetWeakPtr(); |
| TriggerProducer producer( |
| &task_runner_, |
| [weak_this, &finished_with_success](bool success) { |
| if (!weak_this) |
| return; |
| finished_with_success = success; |
| weak_this->task_runner_.Quit(); |
| }, |
| &triggers_to_activate_); |
| task_runner_.Run(); |
| if (!finished_with_success) { |
| LogTriggerEvents(PerfettoTriggerAtom::kCmdTriggerFail, |
| triggers_to_activate_); |
| } |
| return finished_with_success ? 0 : 1; |
| } // if (triggers_to_activate_) |
| |
| if (query_service_) { |
| consumer_endpoint_ = |
| ConsumerIPCClient::Connect(GetConsumerSocket(), this, &task_runner_); |
| task_runner_.Run(); |
| return 1; // We can legitimately get here if the service disconnects. |
| } |
| |
| RateLimiter::Args args{}; |
| args.is_user_build = IsUserBuild(); |
| args.is_uploading = save_to_incidentd_ || report_to_android_framework_; |
| args.allow_user_build_tracing = trace_config_->allow_user_build_tracing(); |
| |
| if (!trace_config_->unique_session_name().empty()) |
| base::MaybeSetThreadName("p-" + trace_config_->unique_session_name()); |
| |
| expected_duration_ms_ = trace_config_->duration_ms(); |
| if (!expected_duration_ms_) { |
| uint32_t timeout_ms = trace_config_->trigger_config().trigger_timeout_ms(); |
| uint32_t max_stop_delay_ms = 0; |
| for (const auto& trigger : trace_config_->trigger_config().triggers()) { |
| max_stop_delay_ms = std::max(max_stop_delay_ms, trigger.stop_delay_ms()); |
| } |
| expected_duration_ms_ = timeout_ms + max_stop_delay_ms; |
| } |
| |
| const auto& delay = trace_config_->cmd_trace_start_delay(); |
| if (delay.has_min_delay_ms()) { |
| PERFETTO_DCHECK(delay.has_max_delay_ms()); |
| std::random_device r; |
| std::minstd_rand minstd(r()); |
| std::uniform_int_distribution<uint32_t> dist(delay.min_delay_ms(), |
| delay.max_delay_ms()); |
| std::this_thread::sleep_for(std::chrono::milliseconds(dist(minstd))); |
| } |
| |
| if (clone_tsid_) { |
| if (snapshot_trigger_name_.empty()) { |
| LogUploadEvent(PerfettoStatsdAtom::kCloneTraceBegin); |
| } else { |
| LogUploadEvent(PerfettoStatsdAtom::kCloneTriggerTraceBegin, |
| snapshot_trigger_name_); |
| } |
| } else if (trace_config_->trigger_config().trigger_timeout_ms() == 0) { |
| LogUploadEvent(PerfettoStatsdAtom::kTraceBegin); |
| } else { |
| LogUploadEvent(PerfettoStatsdAtom::kBackgroundTraceBegin); |
| } |
| |
| auto err_atom = ConvertRateLimiterResponseToAtom(limiter_->ShouldTrace(args)); |
| if (err_atom) { |
| LogUploadEvent(err_atom.value()); |
| return 1; |
| } |
| |
| #if PERFETTO_BUILDFLAG(PERFETTO_OS_ANDROID) |
| if (!background_ && !is_detach() && !upload_flag_ && |
| triggers_to_activate_.empty() && !isatty(STDIN_FILENO) && |
| !isatty(STDERR_FILENO) && getenv("TERM")) { |
| fprintf(stderr, |
| "Warning: No PTY. CTRL+C won't gracefully stop the trace. If you " |
| "are running perfetto via adb shell, use the -tt arg (adb shell " |
| "-t perfetto ...) or consider using the helper script " |
| "tools/record_android_trace from the Perfetto repository.\n\n"); |
| } |
| #endif |
| |
| consumer_endpoint_ = |
| ConsumerIPCClient::Connect(GetConsumerSocket(), this, &task_runner_); |
| SetupCtrlCSignalHandler(); |
| task_runner_.Run(); |
| |
| return tracing_succeeded_ ? 0 : 1; |
| } |
| |
| void PerfettoCmd::OnConnect() { |
| connected_ = true; |
| LogUploadEvent(PerfettoStatsdAtom::kOnConnect); |
| |
| uint32_t events_mask = 0; |
| if (GetTriggerMode(*trace_config_) == |
| TraceConfig::TriggerConfig::CLONE_SNAPSHOT) { |
| events_mask |= ObservableEvents::TYPE_CLONE_TRIGGER_HIT; |
| } |
| if (background_wait_) { |
| events_mask |= ObservableEvents::TYPE_ALL_DATA_SOURCES_STARTED; |
| } |
| if (events_mask) { |
| consumer_endpoint_->ObserveEvents(events_mask); |
| } |
| |
| if (query_service_) { |
| consumer_endpoint_->QueryServiceState( |
| {}, [this](bool success, const TracingServiceState& svc_state) { |
| PrintServiceState(success, svc_state); |
| fflush(stdout); |
| exit(success ? 0 : 1); |
| }); |
| return; |
| } |
| |
| if (clone_all_bugreport_traces_) { |
| ConsumerEndpoint::QueryServiceStateArgs args; |
| // Reduces the size of the IPC reply skipping data sources and producers. |
| args.sessions_only = true; |
| auto weak_this = weak_factory_.GetWeakPtr(); |
| consumer_endpoint_->QueryServiceState( |
| args, [weak_this](bool success, const TracingServiceState& svc_state) { |
| if (weak_this) |
| weak_this->CloneAllBugreportTraces(success, svc_state); |
| }); |
| return; |
| } |
| |
| if (is_attach()) { |
| consumer_endpoint_->Attach(attach_key_); |
| return; |
| } |
| |
| if (clone_tsid_.has_value()) { |
| task_runner_.PostDelayedTask(std::bind(&PerfettoCmd::OnTimeout, this), |
| kCloneTimeoutMs); |
| ConsumerEndpoint::CloneSessionArgs args; |
| args.skip_trace_filter = clone_for_bugreport_; |
| args.for_bugreport = clone_for_bugreport_; |
| consumer_endpoint_->CloneSession(*clone_tsid_, std::move(args)); |
| return; |
| } |
| |
| if (expected_duration_ms_) { |
| PERFETTO_LOG("Connected to the Perfetto traced service, TTL: %ds", |
| (expected_duration_ms_ + 999) / 1000); |
| } else { |
| PERFETTO_LOG("Connected to the Perfetto traced service, starting tracing"); |
| } |
| |
| PERFETTO_DCHECK(trace_config_); |
| trace_config_->set_enable_extra_guardrails( |
| (save_to_incidentd_ || report_to_android_framework_) && |
| !ignore_guardrails_); |
| |
| // Set the statsd logging flag if we're uploading |
| |
| base::ScopedFile optional_fd; |
| if (trace_config_->write_into_file() && trace_config_->output_path().empty()) |
| optional_fd.reset(dup(fileno(*trace_out_stream_))); |
| |
| consumer_endpoint_->EnableTracing(*trace_config_, std::move(optional_fd)); |
| |
| if (is_detach()) { |
| consumer_endpoint_->Detach(detach_key_); // Will invoke OnDetach() soon. |
| return; |
| } |
| |
| // Failsafe mechanism to avoid waiting indefinitely if the service hangs. |
| // Note: when using prefer_suspend_clock_for_duration the actual duration |
| // might be < expected_duration_ms_ measured in in wall time. But this is fine |
| // because the resulting timeout will be conservative (it will be accurate |
| // if the device never suspends, and will be more lax if it does). |
| if (expected_duration_ms_) { |
| uint32_t trace_timeout = expected_duration_ms_ + 60000 + |
| trace_config_->flush_timeout_ms() + |
| trace_config_->data_source_stop_timeout_ms(); |
| task_runner_.PostDelayedTask(std::bind(&PerfettoCmd::OnTimeout, this), |
| trace_timeout); |
| } |
| } |
| |
| void PerfettoCmd::OnDisconnect() { |
| if (connected_) { |
| PERFETTO_LOG("Disconnected from the traced service"); |
| } else { |
| #if PERFETTO_BUILDFLAG(PERFETTO_OS_ANDROID) |
| static const char kDocUrl[] = |
| "https://perfetto.dev/docs/quickstart/android-tracing"; |
| #else |
| static const char kDocUrl[] = |
| "https://perfetto.dev/docs/quickstart/linux-tracing"; |
| #endif |
| PERFETTO_LOG( |
| "Could not connect to the traced socket %s. Ensure traced is " |
| "running or use tracebox. See %s.", |
| GetConsumerSocket(), kDocUrl); |
| } |
| |
| connected_ = false; |
| task_runner_.Quit(); |
| } |
| |
| void PerfettoCmd::OnTimeout() { |
| PERFETTO_ELOG("Timed out while waiting for trace from the service, aborting"); |
| LogUploadEvent(PerfettoStatsdAtom::kOnTimeout); |
| task_runner_.Quit(); |
| } |
| |
| void PerfettoCmd::CheckTraceDataTimeout() { |
| if (trace_data_timeout_armed_) { |
| PERFETTO_ELOG("Timed out while waiting for OnTraceData, aborting"); |
| FinalizeTraceAndExit(); |
| } |
| trace_data_timeout_armed_ = true; |
| task_runner_.PostDelayedTask( |
| std::bind(&PerfettoCmd::CheckTraceDataTimeout, this), |
| kOnTraceDataTimeoutMs); |
| } |
| |
| void PerfettoCmd::OnTraceData(std::vector<TracePacket> packets, bool has_more) { |
| trace_data_timeout_armed_ = false; |
| |
| PERFETTO_CHECK(packet_writer_.has_value()); |
| if (!packet_writer_->WritePackets(packets)) { |
| PERFETTO_ELOG("Failed to write packets"); |
| FinalizeTraceAndExit(); |
| } |
| |
| if (!has_more) |
| FinalizeTraceAndExit(); // Reached end of trace. |
| } |
| |
| void PerfettoCmd::OnTracingDisabled(const std::string& error) { |
| ReadbackTraceDataAndQuit(error); |
| } |
| |
| void PerfettoCmd::ReadbackTraceDataAndQuit(const std::string& error) { |
| if (!error.empty()) { |
| // Some of these errors (e.g. unique session name already exists) are soft |
| // errors and likely to happen in nominal condition. As such they shouldn't |
| // be marked as "E" in the event log. Hence why LOG and not ELOG here. |
| PERFETTO_LOG("Service error: %s", error.c_str()); |
| |
| // In case of errors don't leave a partial file around. This happens |
| // frequently in the case of --save-for-bugreport if there is no eligible |
| // trace. See also b/279753347 . |
| if (bytes_written_ == 0 && !trace_out_path_.empty() && |
| trace_out_path_ != "-") { |
| remove(trace_out_path_.c_str()); |
| } |
| |
| // Even though there was a failure, we mark this as success for legacy |
| // reasons: when guardrails used to exist in perfetto_cmd, this codepath |
| // would still cause guardrails to be written and the exit code to be 0. |
| // |
| // We want to preserve that semantic and the easiest way to do that would |
| // be to set |tracing_succeeded_| to true. |
| tracing_succeeded_ = true; |
| task_runner_.Quit(); |
| return; |
| } |
| |
| // Make sure to only log this atom if |error| is empty; traced |
| // would have logged a terminal error atom corresponding to |error| |
| // and we don't want to log anything after that. |
| LogUploadEvent(PerfettoStatsdAtom::kOnTracingDisabled); |
| |
| if (trace_config_->write_into_file()) { |
| // If write_into_file == true, at this point the passed file contains |
| // already all the packets. |
| return FinalizeTraceAndExit(); |
| } |
| |
| trace_data_timeout_armed_ = false; |
| CheckTraceDataTimeout(); |
| |
| // This will cause a bunch of OnTraceData callbacks. The last one will |
| // save the file and exit. |
| consumer_endpoint_->ReadBuffers(); |
| } |
| |
| void PerfettoCmd::FinalizeTraceAndExit() { |
| LogUploadEvent(PerfettoStatsdAtom::kFinalizeTraceAndExit); |
| packet_writer_.reset(); |
| |
| if (trace_out_stream_) { |
| fseek(*trace_out_stream_, 0, SEEK_END); |
| off_t sz = ftell(*trace_out_stream_); |
| if (sz > 0) |
| bytes_written_ = static_cast<size_t>(sz); |
| } |
| |
| if (save_to_incidentd_) { |
| #if PERFETTO_BUILDFLAG(PERFETTO_OS_ANDROID) |
| SaveTraceIntoIncidentOrCrash(); |
| #endif |
| } else if (report_to_android_framework_) { |
| #if PERFETTO_BUILDFLAG(PERFETTO_OS_ANDROID) |
| ReportTraceToAndroidFrameworkOrCrash(); |
| #endif |
| } else { |
| trace_out_stream_.reset(); |
| if (trace_config_->write_into_file()) { |
| // trace_out_path_ might be empty in the case of --attach. |
| PERFETTO_LOG("Trace written into the output file"); |
| } else { |
| PERFETTO_LOG("Wrote %" PRIu64 " bytes into %s", bytes_written_, |
| trace_out_path_ == "-" ? "stdout" : trace_out_path_.c_str()); |
| } |
| } |
| |
| tracing_succeeded_ = true; |
| task_runner_.Quit(); |
| } |
| |
| bool PerfettoCmd::OpenOutputFile() { |
| base::ScopedFile fd; |
| if (trace_out_path_.empty()) { |
| #if PERFETTO_BUILDFLAG(PERFETTO_OS_ANDROID) |
| fd = CreateUnlinkedTmpFile(); |
| #endif |
| } else if (trace_out_path_ == "-") { |
| fd.reset(dup(fileno(stdout))); |
| } else { |
| fd = base::OpenFile(trace_out_path_, O_RDWR | O_CREAT | O_TRUNC, 0600); |
| } |
| if (!fd) { |
| PERFETTO_PLOG( |
| "Failed to open %s. If you get permission denied in " |
| "/data/misc/perfetto-traces, the file might have been " |
| "created by another user, try deleting it first.", |
| trace_out_path_.c_str()); |
| return false; |
| } |
| trace_out_stream_.reset(fdopen(fd.release(), "wb")); |
| PERFETTO_CHECK(trace_out_stream_); |
| return true; |
| } |
| |
| void PerfettoCmd::SetupCtrlCSignalHandler() { |
| // Only the main thread instance should handle CTRL+C. |
| if (g_perfetto_cmd != this) |
| return; |
| ctrl_c_handler_installed_ = true; |
| base::InstallCtrlCHandler([] { |
| if (PerfettoCmd* main_thread = g_perfetto_cmd.load()) |
| main_thread->SignalCtrlC(); |
| }); |
| auto weak_this = weak_factory_.GetWeakPtr(); |
| task_runner_.AddFileDescriptorWatch(ctrl_c_evt_.fd(), [weak_this] { |
| if (!weak_this) |
| return; |
| PERFETTO_LOG("SIGINT/SIGTERM received: disabling tracing."); |
| weak_this->ctrl_c_evt_.Clear(); |
| weak_this->consumer_endpoint_->Flush( |
| 0, |
| [weak_this](bool flush_success) { |
| if (!weak_this) |
| return; |
| if (!flush_success) |
| PERFETTO_ELOG("Final flush unsuccessful."); |
| weak_this->consumer_endpoint_->DisableTracing(); |
| }, |
| FlushFlags(FlushFlags::Initiator::kPerfettoCmd, |
| FlushFlags::Reason::kTraceStop)); |
| }); |
| } |
| |
| void PerfettoCmd::OnDetach(bool success) { |
| if (!success) { |
| PERFETTO_ELOG("Session detach failed"); |
| exit(1); |
| } |
| exit(0); |
| } |
| |
| void PerfettoCmd::OnAttach(bool success, const TraceConfig& trace_config) { |
| if (!success) { |
| if (!redetach_once_attached_) { |
| // Print an error message if attach fails, with the exception of the |
| // --is_detached case, where we want to silently return. |
| PERFETTO_ELOG("Session re-attach failed. Check service logs for details"); |
| } |
| // Keep this exit code distinguishable from the general error code so |
| // --is_detached can tell the difference between a general error and the |
| // not-detached case. |
| exit(2); |
| } |
| |
| if (redetach_once_attached_) { |
| consumer_endpoint_->Detach(attach_key_); // Will invoke OnDetach() soon. |
| return; |
| } |
| |
| trace_config_.reset(new TraceConfig(trace_config)); |
| PERFETTO_DCHECK(trace_config_->write_into_file()); |
| |
| if (stop_trace_once_attached_) { |
| auto weak_this = weak_factory_.GetWeakPtr(); |
| consumer_endpoint_->Flush( |
| 0, |
| [weak_this](bool flush_success) { |
| if (!weak_this) |
| return; |
| if (!flush_success) |
| PERFETTO_ELOG("Final flush unsuccessful."); |
| weak_this->consumer_endpoint_->DisableTracing(); |
| }, |
| FlushFlags(FlushFlags::Initiator::kPerfettoCmd, |
| FlushFlags::Reason::kTraceStop)); |
| } |
| } |
| |
| void PerfettoCmd::OnTraceStats(bool /*success*/, |
| const TraceStats& /*trace_config*/) { |
| // TODO(eseckler): Support GetTraceStats(). |
| } |
| |
| void PerfettoCmd::OnSessionCloned(const OnSessionClonedArgs& args) { |
| PERFETTO_DLOG("Cloned tracing session %" PRIu64 ", success=%d", |
| clone_tsid_.value_or(0), args.success); |
| std::string full_error; |
| if (!args.success) { |
| full_error = "Failed to clone tracing session " + |
| std::to_string(clone_tsid_.value_or(0)) + ": " + args.error; |
| } |
| |
| // This is used with --save-all-for-bugreport, to pause all cloning threads |
| // so that they first issue the clone and then proceed only after the service |
| // has seen all the clone requests. |
| if (on_session_cloned_) { |
| std::function<void()> on_session_cloned(nullptr); |
| std::swap(on_session_cloned, on_session_cloned_); |
| on_session_cloned(); |
| } |
| |
| // Kick off the readback and file finalization (as if we started tracing and |
| // reached the duration_ms timeout). |
| uuid_ = args.uuid.ToString(); |
| ReadbackTraceDataAndQuit(full_error); |
| } |
| |
| void PerfettoCmd::PrintServiceState(bool success, |
| const TracingServiceState& svc_state) { |
| if (!success) { |
| PERFETTO_ELOG("Failed to query the service state"); |
| return; |
| } |
| |
| if (query_service_output_raw_) { |
| std::string str = svc_state.SerializeAsString(); |
| fwrite(str.data(), 1, str.size(), stdout); |
| return; |
| } |
| |
| printf( |
| "\x1b[31mNot meant for machine consumption. Use --query-raw for " |
| "scripts.\x1b[0m\n\n"); |
| printf( |
| "Service: %s\n" |
| "Tracing sessions: %d (started: %d)\n", |
| svc_state.tracing_service_version().c_str(), svc_state.num_sessions(), |
| svc_state.num_sessions_started()); |
| |
| printf(R"( |
| |
| PRODUCER PROCESSES CONNECTED: |
| |
| ID PID UID NAME SDK |
| == === === ==== === |
| )"); |
| for (const auto& producer : svc_state.producers()) { |
| printf("%-10d %-10d %-10d %-32s %s\n", producer.id(), producer.pid(), |
| producer.uid(), producer.name().c_str(), |
| producer.sdk_version().c_str()); |
| } |
| |
| printf(R"( |
| |
| DATA SOURCES REGISTERED: |
| |
| NAME PRODUCER DETAILS |
| === ======== ======== |
| )"); |
| for (const auto& ds : svc_state.data_sources()) { |
| char producer_id_and_name[128]{}; |
| const int ds_producer_id = ds.producer_id(); |
| for (const auto& producer : svc_state.producers()) { |
| if (producer.id() == ds_producer_id) { |
| base::SprintfTrunc(producer_id_and_name, sizeof(producer_id_and_name), |
| "%s (%d)", producer.name().c_str(), ds_producer_id); |
| break; |
| } |
| } |
| |
| printf("%-40s %-28s ", ds.ds_descriptor().name().c_str(), |
| producer_id_and_name); |
| // Print the category names for clients using the track event SDK. |
| std::string cats; |
| if (!ds.ds_descriptor().track_event_descriptor_raw().empty()) { |
| const std::string& raw = ds.ds_descriptor().track_event_descriptor_raw(); |
| protos::gen::TrackEventDescriptor desc; |
| if (desc.ParseFromArray(raw.data(), raw.size())) { |
| for (const auto& cat : desc.available_categories()) { |
| cats.append(cats.empty() ? "" : ","); |
| cats.append(cat.name()); |
| } |
| } |
| } else if (!ds.ds_descriptor().ftrace_descriptor_raw().empty()) { |
| const std::string& raw = ds.ds_descriptor().ftrace_descriptor_raw(); |
| protos::gen::FtraceDescriptor desc; |
| if (desc.ParseFromArray(raw.data(), raw.size())) { |
| for (const auto& cat : desc.atrace_categories()) { |
| cats.append(cats.empty() ? "" : ","); |
| cats.append(cat.name()); |
| } |
| } |
| } |
| const size_t kCatsShortLen = 40; |
| if (!query_service_long_ && cats.length() > kCatsShortLen) { |
| cats = cats.substr(0, kCatsShortLen); |
| cats.append("... (use --long to expand)"); |
| } |
| printf("%s\n", cats.c_str()); |
| } // for data_sources() |
| |
| if (svc_state.supports_tracing_sessions()) { |
| printf(R"( |
| |
| TRACING SESSIONS: |
| |
| ID UID STATE BUF (#) KB DUR (s) #DS STARTED NAME |
| === === ===== ========== ======= === ======= ==== |
| )"); |
| for (const auto& sess : svc_state.tracing_sessions()) { |
| uint32_t buf_tot_kb = 0; |
| for (uint32_t kb : sess.buffer_size_kb()) |
| buf_tot_kb += kb; |
| int sec = |
| static_cast<int>((sess.start_realtime_ns() / 1000000000) % 86400); |
| int h = sec / 3600; |
| int m = (sec - (h * 3600)) / 60; |
| int s = (sec - h * 3600 - m * 60); |
| printf("%-7" PRIu64 " %-7d %-10s (%d) %-8u %-9u %-4u %02d:%02d:%02d %s\n", |
| sess.id(), sess.consumer_uid(), sess.state().c_str(), |
| sess.buffer_size_kb_size(), buf_tot_kb, sess.duration_ms() / 1000, |
| sess.num_data_sources(), h, m, s, |
| sess.unique_session_name().c_str()); |
| } // for tracing_sessions() |
| |
| int sessions_listed = static_cast<int>(svc_state.tracing_sessions().size()); |
| if (sessions_listed != svc_state.num_sessions() && |
| base::GetCurrentUserId() != 0) { |
| printf( |
| "\n" |
| "NOTE: Some tracing sessions are not reported in the list above.\n" |
| "This is likely because they are owned by a different UID.\n" |
| "If you want to list all session, run again this command as root.\n"); |
| } |
| } // if (supports_tracing_sessions) |
| } |
| |
| void PerfettoCmd::OnObservableEvents( |
| const ObservableEvents& observable_events) { |
| if (observable_events.all_data_sources_started()) { |
| NotifyBgProcessPipe(kBackgroundOk); |
| } |
| if (observable_events.has_clone_trigger_hit()) { |
| int64_t tsid = observable_events.clone_trigger_hit().tracing_session_id(); |
| std::string trigger_name = |
| observable_events.clone_trigger_hit().trigger_name(); |
| OnCloneSnapshotTriggerReceived(static_cast<TracingSessionID>(tsid), |
| std::move(trigger_name)); |
| } |
| } |
| |
| void PerfettoCmd::OnCloneSnapshotTriggerReceived(TracingSessionID tsid, |
| std::string trigger_name) { |
| std::string cmdline; |
| cmdline.reserve(128); |
| ArgsAppend(&cmdline, "perfetto"); |
| ArgsAppend(&cmdline, "--config"); |
| ArgsAppend(&cmdline, |
| ":mem"); // Use the copied config from `snapshot_config_`. |
| ArgsAppend(&cmdline, "--clone"); |
| ArgsAppend(&cmdline, std::to_string(tsid)); |
| if (upload_flag_) { |
| ArgsAppend(&cmdline, "--upload"); |
| } else if (!trace_out_path_.empty()) { |
| ArgsAppend(&cmdline, "--out"); |
| ArgsAppend(&cmdline, |
| trace_out_path_ + "." + std::to_string(snapshot_count_++)); |
| } else { |
| PERFETTO_FATAL("Cannot use CLONE_SNAPSHOT with the current cmdline args"); |
| } |
| CloneSessionOnThread(tsid, cmdline, kSingleExtraThread, |
| std::move(trigger_name), nullptr); |
| } |
| |
| void PerfettoCmd::CloneSessionOnThread( |
| TracingSessionID tsid, |
| const std::string& cmdline, |
| CloneThreadMode thread_mode, |
| std::string trigger_name, |
| std::function<void()> on_clone_callback) { |
| PERFETTO_DLOG("Creating snapshot for tracing session %" PRIu64, tsid); |
| |
| // Only the main thread instance should be handling snapshots. |
| // We should never end up in a state where each secondary PerfettoCmd |
| // instance handles other snapshots and creates other threads. |
| PERFETTO_CHECK(g_perfetto_cmd == this); |
| |
| if (snapshot_threads_.empty() || thread_mode == kNewThreadPerRequest) { |
| // The destructor of the main-thread's PerfettoCmdMain will destroy and |
| // join the threads that we are crating here. |
| snapshot_threads_.emplace_back( |
| base::ThreadTaskRunner::CreateAndStart("snapshot")); |
| } |
| |
| // We need to pass a copy of the trace config to the new PerfettoCmd instance |
| // because the trace config defines a bunch of properties that are used by the |
| // cmdline client (reporter API package, guardrails, etc). |
| std::string trace_config_copy = trace_config_->SerializeAsString(); |
| |
| snapshot_threads_.back().PostTask( |
| [tsid, cmdline, trace_config_copy, trigger_name, on_clone_callback] { |
| int argc = 0; |
| char* argv[32]; |
| // `splitter` needs to live on the stack for the whole scope as it owns |
| // the underlying string storage that gets std::moved to PerfettoCmd. |
| base::StringSplitter splitter(std::move(cmdline), '\0'); |
| while (splitter.Next()) { |
| argv[argc++] = splitter.cur_token(); |
| PERFETTO_CHECK(static_cast<size_t>(argc) < base::ArraySize(argv)); |
| } |
| perfetto::PerfettoCmd cmd; |
| cmd.snapshot_config_ = std::move(trace_config_copy); |
| cmd.snapshot_trigger_name_ = std::move(trigger_name); |
| cmd.on_session_cloned_ = on_clone_callback; |
| auto cmdline_res = cmd.ParseCmdlineAndMaybeDaemonize(argc, argv); |
| PERFETTO_CHECK(!cmdline_res.has_value()); // No daemonization expected. |
| int res = cmd.ConnectToServiceRunAndMaybeNotify(); |
| if (res) |
| PERFETTO_ELOG("Cloning session %" PRIu64 " failed (%d)", tsid, res); |
| }); |
| } |
| |
| void PerfettoCmd::CloneAllBugreportTraces( |
| bool success, |
| const TracingServiceState& service_state) { |
| if (!success) |
| PERFETTO_FATAL("Failed to list active tracing sessions"); |
| |
| struct SessionToClone { |
| int32_t bugreport_score; |
| TracingSessionID tsid; |
| std::string fname; // Before deduping logic. |
| bool operator<(const SessionToClone& other) const { |
| return bugreport_score > other.bugreport_score; // High score first. |
| } |
| }; |
| std::vector<SessionToClone> sessions; |
| for (const auto& session : service_state.tracing_sessions()) { |
| if (session.bugreport_score() <= 0 || !session.is_started()) |
| continue; |
| std::string fname; |
| if (!session.bugreport_filename().empty()) { |
| fname = session.bugreport_filename(); |
| } else { |
| fname = "systrace.pftrace"; |
| } |
| sessions.emplace_back( |
| SessionToClone{session.bugreport_score(), session.id(), fname}); |
| } // for(session) |
| |
| if (sessions.empty()) { |
| PERFETTO_LOG("No tracing sessions eligible for bugreport were found."); |
| exit(0); |
| } |
| |
| // First clone all sessions, synchronize, then read them back into files. |
| // The `sync_fn` below will be executed on each thread inside OnSessionCloned |
| // before proceeding with the readback. The logic below delays the readback |
| // of all threads, until the service has acked all the clone requests. |
| // The tracing service is single-threaded and data readbacks can take several |
| // seconds. This is to minimize the global clone time and avoid that that |
| // several sessions stomp on each other. |
| const size_t num_sessions = sessions.size(); |
| |
| // sync_point needs to be a shared_ptr to deal with the case where the main |
| // thread runs in the middle of the Notify() and the Wait() and destroys the |
| // WaitableEvent before some thread gets to the Wait(). |
| auto sync_point = std::make_shared<base::WaitableEvent>(); |
| |
| std::function<void()> sync_fn = [sync_point, num_sessions] { |
| sync_point->Notify(); |
| sync_point->Wait(num_sessions); |
| }; |
| |
| // Clone the sessions in order, starting with the highest score first. |
| std::sort(sessions.begin(), sessions.end()); |
| for (auto it = sessions.begin(); it != sessions.end(); ++it) { |
| std::string actual_fname = it->fname; |
| size_t dupes = static_cast<size_t>(std::count_if( |
| sessions.begin(), it, |
| [&](const SessionToClone& o) { return o.fname == it->fname; })); |
| if (dupes > 0) { |
| std::string suffix = "_" + std::to_string(dupes); |
| const size_t last_dot = actual_fname.find_last_of('.'); |
| if (last_dot != std::string::npos) { |
| actual_fname.replace(last_dot, 1, suffix + "."); |
| } else { |
| actual_fname.append(suffix); |
| } |
| } // if (dupes > 0) |
| |
| // Clone the tracing session into the bugreport file. |
| std::string out_path = GetBugreportTraceDir() + "/" + actual_fname; |
| remove(out_path.c_str()); |
| PERFETTO_LOG("Cloning tracing session %" PRIu64 " with score %d into %s", |
| it->tsid, it->bugreport_score, out_path.c_str()); |
| std::string cmdline; |
| cmdline.reserve(128); |
| ArgsAppend(&cmdline, "perfetto"); |
| ArgsAppend(&cmdline, "--clone"); |
| ArgsAppend(&cmdline, std::to_string(it->tsid)); |
| ArgsAppend(&cmdline, "--clone-for-bugreport"); |
| ArgsAppend(&cmdline, "--out"); |
| ArgsAppend(&cmdline, out_path); |
| CloneSessionOnThread(it->tsid, cmdline, kNewThreadPerRequest, "", sync_fn); |
| } // for(sessions) |
| |
| PERFETTO_DLOG("Issuing %zu CloneSession requests", num_sessions); |
| sync_point->Wait(num_sessions); |
| PERFETTO_DLOG("All %zu sessions have acked the clone request", num_sessions); |
| |
| // After all sessions are done, quit. |
| // Note that there is no risk that thd.PostTask() will interleave with the |
| // sequence of tasks that PerfettoCmd involves, there is no race here. |
| // There are two TaskRunners here, nested into each other: |
| // 1) The "outer" ThreadTaskRunner, created by `thd`. This will see only one |
| // task ever, which is "run perfetto_cmd until completion". |
| // 2) Internally PerfettoCmd creates its own UnixTaskRunner, which creates |
| // a nested TaskRunner that takes control of the execution. This returns |
| // only once TaskRunner::Quit() is called, in its epilogue. |
| auto done_count = std::make_shared<std::atomic<size_t>>(num_sessions); |
| for (auto& thd : snapshot_threads_) { |
| thd.PostTask([done_count] { |
| if (done_count->fetch_sub(1) == 1) { |
| PERFETTO_DLOG("All sessions cloned. quitting"); |
| exit(0); |
| } |
| }); |
| } |
| } |
| |
| void PerfettoCmd::LogUploadEvent(PerfettoStatsdAtom atom) { |
| if (!statsd_logging_) |
| return; |
| base::Uuid uuid(uuid_); |
| android_stats::MaybeLogUploadEvent(atom, uuid.lsb(), uuid.msb()); |
| } |
| |
| void PerfettoCmd::LogUploadEvent(PerfettoStatsdAtom atom, |
| const std::string& trigger_name) { |
| if (!statsd_logging_) |
| return; |
| base::Uuid uuid(uuid_); |
| android_stats::MaybeLogUploadEvent(atom, uuid.lsb(), uuid.msb(), |
| trigger_name); |
| } |
| |
| void PerfettoCmd::LogTriggerEvents( |
| PerfettoTriggerAtom atom, |
| const std::vector<std::string>& trigger_names) { |
| if (!statsd_logging_) |
| return; |
| android_stats::MaybeLogTriggerEvents(atom, trigger_names); |
| } |
| |
| int PERFETTO_EXPORT_ENTRYPOINT PerfettoCmdMain(int argc, char** argv) { |
| perfetto::PerfettoCmd cmd; |
| auto opt_res = cmd.ParseCmdlineAndMaybeDaemonize(argc, argv); |
| if (opt_res.has_value()) |
| return *opt_res; |
| return cmd.ConnectToServiceRunAndMaybeNotify(); |
| } |
| |
| } // namespace perfetto |