src/trace_processor/proto_trace_parser.h - platform/external/perfetto - Git at Google

 /*
  * 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.
  */

 #ifndef SRC_TRACE_PROCESSOR_PROTO_TRACE_PARSER_H_
 #define SRC_TRACE_PROCESSOR_PROTO_TRACE_PARSER_H_

 #include <stdint.h>

 #include <array>
 #include <memory>

 #include "perfetto/ext/base/optional.h"
 #include "perfetto/ext/base/string_view.h"
 #include "perfetto/protozero/field.h"
 #include "src/trace_processor/ftrace_descriptors.h"
 #include "src/trace_processor/graphics_event_parser.h"
 #include "src/trace_processor/proto_incremental_state.h"
 #include "src/trace_processor/slice_tracker.h"
 #include "src/trace_processor/trace_blob_view.h"
 #include "src/trace_processor/trace_parser.h"
 #include "src/trace_processor/trace_storage.h"

 #include "protos/perfetto/trace/track_event/track_event.pbzero.h"

 namespace perfetto {
 namespace trace_processor {

 class ArgsTracker;
 class TraceProcessorContext;

 class ProtoTraceParser : public TraceParser {
  public:
   using ConstBytes = protozero::ConstBytes;
   explicit ProtoTraceParser(TraceProcessorContext*);
   ~ProtoTraceParser() override;

   // TraceParser implementation.
   void ParseTracePacket(int64_t timestamp,
                         TraceSorter::TimestampedTracePiece) override;
   void ParseFtracePacket(uint32_t cpu,
                          int64_t timestamp,
                          TraceSorter::TimestampedTracePiece) override;

   void ParseProcessTree(ConstBytes);
   void ParseProcessStats(int64_t timestamp, ConstBytes);
   void ParseSchedSwitch(uint32_t cpu, int64_t timestamp, ConstBytes);
   void ParseSchedWakeup(int64_t timestamp, ConstBytes);
   void ParseSchedWaking(int64_t timestamp, ConstBytes);
   void ParseSchedProcessFree(int64_t timestamp, ConstBytes);
   void ParseTaskNewTask(int64_t timestamp, uint32_t source_tid, ConstBytes);
   void ParseTaskRename(ConstBytes);
   void ParseCpuFreq(int64_t timestamp, ConstBytes);
   void ParseCpuIdle(int64_t timestamp, ConstBytes);
   void ParseGpuFreq(int64_t timestamp, ConstBytes);
   void ParsePrint(uint32_t cpu, int64_t timestamp, uint32_t pid, ConstBytes);
   void ParseZero(uint32_t cpu, int64_t timestamp, uint32_t pid, ConstBytes);
   void ParseSysStats(int64_t ts, ConstBytes);
   void ParseRssStat(int64_t ts, uint32_t pid, ConstBytes);
   void ParseIonHeapGrowOrShrink(int64_t ts,
                                 uint32_t pid,
                                 ConstBytes,
                                 bool grow);
   void ParseSignalDeliver(int64_t ts, uint32_t pid, ConstBytes);
   void ParseSignalGenerate(int64_t ts, ConstBytes);
   void ParseLowmemoryKill(int64_t ts, ConstBytes);
   void ParseBatteryCounters(int64_t ts, ConstBytes);
   void ParsePowerRails(ConstBytes);
   void ParseOOMScoreAdjUpdate(int64_t ts, ConstBytes);
   void ParseMmEventRecord(int64_t ts, uint32_t pid, ConstBytes);
   void ParseSysEvent(int64_t ts, uint32_t pid, bool is_enter, ConstBytes);
   void ParseAndroidLogPacket(ConstBytes);
   void ParseAndroidLogEvent(ConstBytes);
   void ParseAndroidLogStats(ConstBytes);
   void ParseGenericFtrace(int64_t timestamp,
                           uint32_t cpu,
                           uint32_t pid,
                           ConstBytes view);
   void ParseTypedFtraceToRaw(uint32_t ftrace_id,
                              int64_t timestamp,
                              uint32_t cpu,
                              uint32_t pid,
                              ConstBytes view);
   void ParseTraceStats(ConstBytes);
   void ParseFtraceStats(ConstBytes);
   void ParseProfilePacket(int64_t ts,
                           ProtoIncrementalState::PacketSequenceState*,
                           size_t sequence_state_generation,
                           ConstBytes);
   void ParseStreamingProfilePacket(ProtoIncrementalState::PacketSequenceState*,
                                    size_t sequence_state_generation,
                                    ConstBytes);
   void ParseSystemInfo(ConstBytes);
   void ParseTrackEvent(int64_t ts,
                        int64_t tts,
                        int64_t ticount,
                        ProtoIncrementalState::PacketSequenceState*,
                        size_t sequence_state_generation,
                        ConstBytes);
   void ParseLegacyEventAsRawEvent(
       int64_t ts,
       int64_t tts,
       int64_t ticount,
       base::Optional<UniqueTid> utid,
       StringId category_id,
       StringId name_id,
       const protos::pbzero::TrackEvent::LegacyEvent::Decoder& legacy_event,
       SliceTracker::SetArgsCallback args_callback);
   void ParseDebugAnnotationArgs(ConstBytes debug_annotation,
                                 ProtoIncrementalState::PacketSequenceState*,
                                 size_t sequence_state_generation,
                                 ArgsTracker* args_tracker,
                                 RowId row);
   void ParseNestedValueArgs(ConstBytes nested_value,
                             base::StringView flat_key,
                             base::StringView key,
                             ArgsTracker* args_tracker,
                             RowId row);
   void ParseTaskExecutionArgs(ConstBytes task_execution,
                               ProtoIncrementalState::PacketSequenceState*,
                               size_t sequence_state_generation,
                               ArgsTracker* args_tracker,
                               RowId row);
   void ParseChromeBenchmarkMetadata(ConstBytes);
   void ParseChromeEvents(int64_t ts, ConstBytes);
   void ParseMetatraceEvent(int64_t ts, ConstBytes);
   void ParseTraceConfig(ConstBytes);
   void ParseStatsdMetadata(ConstBytes);
   void ParseAndroidPackagesList(ConstBytes);
   void ParseLogMessage(ConstBytes,
                        ProtoIncrementalState::PacketSequenceState*,
                        size_t sequence_state_generation,
                        int64_t,
                        base::Optional<UniqueTid>,
                        ArgsTracker*,
                        RowId);
   void ParseModuleSymbols(ConstBytes);
   void ParseHeapGraph(int64_t ts, ConstBytes);

  private:
   TraceProcessorContext* context_;
   std::unique_ptr<GraphicsEventParser> graphics_event_parser_;

   const StringId utid_name_id_;
   const StringId sched_wakeup_name_id_;
   const StringId sched_waking_name_id_;
   const StringId cpu_freq_name_id_;
   const StringId cpu_idle_name_id_;
   const StringId gpu_freq_name_id_;
   const StringId comm_name_id_;
   const StringId num_forks_name_id_;
   const StringId num_irq_total_name_id_;
   const StringId num_softirq_total_name_id_;
   const StringId num_irq_name_id_;
   const StringId num_softirq_name_id_;
   const StringId cpu_times_user_ns_id_;
   const StringId cpu_times_user_nice_ns_id_;
   const StringId cpu_times_system_mode_ns_id_;
   const StringId cpu_times_idle_ns_id_;
   const StringId cpu_times_io_wait_ns_id_;
   const StringId cpu_times_irq_ns_id_;
   const StringId cpu_times_softirq_ns_id_;
   const StringId signal_deliver_id_;
   const StringId signal_generate_id_;
   const StringId batt_charge_id_;
   const StringId batt_capacity_id_;
   const StringId batt_current_id_;
   const StringId batt_current_avg_id_;
   const StringId lmk_id_;
   const StringId oom_score_adj_id_;
   const StringId ion_total_unknown_id_;
   const StringId ion_change_unknown_id_;
   const StringId metatrace_id_;
   const StringId task_file_name_args_key_id_;
   const StringId task_function_name_args_key_id_;
   const StringId task_line_number_args_key_id_;
   const StringId log_message_body_key_id_;
   const StringId data_name_id_;
   const StringId raw_chrome_metadata_event_id_;
   const StringId raw_chrome_legacy_system_trace_event_id_;
   const StringId raw_chrome_legacy_user_trace_event_id_;
   const StringId raw_legacy_event_id_;
   const StringId legacy_event_category_key_id_;
   const StringId legacy_event_name_key_id_;
   const StringId legacy_event_phase_key_id_;
   const StringId legacy_event_duration_ns_key_id_;
   const StringId legacy_event_thread_timestamp_ns_key_id_;
   const StringId legacy_event_thread_duration_ns_key_id_;
   const StringId legacy_event_thread_instruction_count_key_id_;
   const StringId legacy_event_thread_instruction_delta_key_id_;
   const StringId legacy_event_use_async_tts_key_id_;
   const StringId legacy_event_global_id_key_id_;
   const StringId legacy_event_local_id_key_id_;
   const StringId legacy_event_id_scope_key_id_;
   const StringId legacy_event_bind_id_key_id_;
   const StringId legacy_event_bind_to_enclosing_key_id_;
   const StringId legacy_event_flow_direction_key_id_;
   const StringId flow_direction_value_in_id_;
   const StringId flow_direction_value_out_id_;
   const StringId flow_direction_value_inout_id_;
   std::vector<StringId> meminfo_strs_id_;
   std::vector<StringId> vmstat_strs_id_;
   std::vector<StringId> rss_members_;
   std::vector<StringId> power_rails_strs_id_;

   struct FtraceMessageStrings {
     // The string id of name of the event field (e.g. sched_switch's id).
     StringId message_name_id = 0;
     std::array<StringId, kMaxFtraceEventFields> field_name_ids;
   };
   std::vector<FtraceMessageStrings> ftrace_message_strings_;

   // Maps a proto field number for memcounters in ProcessStats::Process to
   // their StringId. Keep kProcStatsProcessSize equal to 1 + max proto field
   // id of ProcessStats::Process.
   static constexpr size_t kProcStatsProcessSize = 11;
   std::array<StringId, kProcStatsProcessSize> proc_stats_process_names_{};

   struct MmEventCounterNames {
     MmEventCounterNames() = default;
     MmEventCounterNames(StringId _count, StringId _max_lat, StringId _avg_lat)
         : count(_count), max_lat(_max_lat), avg_lat(_avg_lat) {}

     StringId count = 0;
     StringId max_lat = 0;
     StringId avg_lat = 0;
   };

   // Keep kMmEventCounterSize equal to mm_event_type::MM_TYPE_NUM in the kernel.
   static constexpr size_t kMmEventCounterSize = 7;
   std::array<MmEventCounterNames, kMmEventCounterSize> mm_event_counter_names_;
 };

 }  // namespace trace_processor
 }  // namespace perfetto

 #endif  // SRC_TRACE_PROCESSOR_PROTO_TRACE_PARSER_H_
	/*
	* 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.
	*/

	#ifndef SRC_TRACE_PROCESSOR_PROTO_TRACE_PARSER_H_
	#define SRC_TRACE_PROCESSOR_PROTO_TRACE_PARSER_H_

	#include <stdint.h>

	#include <array>
	#include <memory>

	#include "perfetto/ext/base/optional.h"
	#include "perfetto/ext/base/string_view.h"
	#include "perfetto/protozero/field.h"
	#include "src/trace_processor/ftrace_descriptors.h"
	#include "src/trace_processor/graphics_event_parser.h"
	#include "src/trace_processor/proto_incremental_state.h"
	#include "src/trace_processor/slice_tracker.h"
	#include "src/trace_processor/trace_blob_view.h"
	#include "src/trace_processor/trace_parser.h"
	#include "src/trace_processor/trace_storage.h"

	#include "protos/perfetto/trace/track_event/track_event.pbzero.h"

	namespace perfetto {
	namespace trace_processor {

	class ArgsTracker;
	class TraceProcessorContext;

	class ProtoTraceParser : public TraceParser {
	public:
	using ConstBytes = protozero::ConstBytes;
	explicit ProtoTraceParser(TraceProcessorContext*);
	~ProtoTraceParser() override;

	// TraceParser implementation.
	void ParseTracePacket(int64_t timestamp,
	TraceSorter::TimestampedTracePiece) override;
	void ParseFtracePacket(uint32_t cpu,
	int64_t timestamp,
	TraceSorter::TimestampedTracePiece) override;

	void ParseProcessTree(ConstBytes);
	void ParseProcessStats(int64_t timestamp, ConstBytes);
	void ParseSchedSwitch(uint32_t cpu, int64_t timestamp, ConstBytes);
	void ParseSchedWakeup(int64_t timestamp, ConstBytes);
	void ParseSchedWaking(int64_t timestamp, ConstBytes);
	void ParseSchedProcessFree(int64_t timestamp, ConstBytes);
	void ParseTaskNewTask(int64_t timestamp, uint32_t source_tid, ConstBytes);
	void ParseTaskRename(ConstBytes);
	void ParseCpuFreq(int64_t timestamp, ConstBytes);
	void ParseCpuIdle(int64_t timestamp, ConstBytes);
	void ParseGpuFreq(int64_t timestamp, ConstBytes);
	void ParsePrint(uint32_t cpu, int64_t timestamp, uint32_t pid, ConstBytes);
	void ParseZero(uint32_t cpu, int64_t timestamp, uint32_t pid, ConstBytes);
	void ParseSysStats(int64_t ts, ConstBytes);
	void ParseRssStat(int64_t ts, uint32_t pid, ConstBytes);
	void ParseIonHeapGrowOrShrink(int64_t ts,
	uint32_t pid,
	ConstBytes,
	bool grow);
	void ParseSignalDeliver(int64_t ts, uint32_t pid, ConstBytes);
	void ParseSignalGenerate(int64_t ts, ConstBytes);
	void ParseLowmemoryKill(int64_t ts, ConstBytes);
	void ParseBatteryCounters(int64_t ts, ConstBytes);
	void ParsePowerRails(ConstBytes);
	void ParseOOMScoreAdjUpdate(int64_t ts, ConstBytes);
	void ParseMmEventRecord(int64_t ts, uint32_t pid, ConstBytes);
	void ParseSysEvent(int64_t ts, uint32_t pid, bool is_enter, ConstBytes);
	void ParseAndroidLogPacket(ConstBytes);
	void ParseAndroidLogEvent(ConstBytes);
	void ParseAndroidLogStats(ConstBytes);
	void ParseGenericFtrace(int64_t timestamp,
	uint32_t cpu,
	uint32_t pid,
	ConstBytes view);
	void ParseTypedFtraceToRaw(uint32_t ftrace_id,
	int64_t timestamp,
	uint32_t cpu,
	uint32_t pid,
	ConstBytes view);
	void ParseTraceStats(ConstBytes);
	void ParseFtraceStats(ConstBytes);
	void ParseProfilePacket(int64_t ts,
	ProtoIncrementalState::PacketSequenceState*,
	size_t sequence_state_generation,
	ConstBytes);
	void ParseStreamingProfilePacket(ProtoIncrementalState::PacketSequenceState*,
	size_t sequence_state_generation,
	ConstBytes);
	void ParseSystemInfo(ConstBytes);
	void ParseTrackEvent(int64_t ts,
	int64_t tts,
	int64_t ticount,
	ProtoIncrementalState::PacketSequenceState*,
	size_t sequence_state_generation,
	ConstBytes);
	void ParseLegacyEventAsRawEvent(
	int64_t ts,
	int64_t tts,
	int64_t ticount,
	base::Optional<UniqueTid> utid,
	StringId category_id,
	StringId name_id,
	const protos::pbzero::TrackEvent::LegacyEvent::Decoder& legacy_event,
	SliceTracker::SetArgsCallback args_callback);
	void ParseDebugAnnotationArgs(ConstBytes debug_annotation,
	ProtoIncrementalState::PacketSequenceState*,
	size_t sequence_state_generation,
	ArgsTracker* args_tracker,
	RowId row);
	void ParseNestedValueArgs(ConstBytes nested_value,
	base::StringView flat_key,
	base::StringView key,
	ArgsTracker* args_tracker,
	RowId row);
	void ParseTaskExecutionArgs(ConstBytes task_execution,
	ProtoIncrementalState::PacketSequenceState*,
	size_t sequence_state_generation,
	ArgsTracker* args_tracker,
	RowId row);
	void ParseChromeBenchmarkMetadata(ConstBytes);
	void ParseChromeEvents(int64_t ts, ConstBytes);
	void ParseMetatraceEvent(int64_t ts, ConstBytes);
	void ParseTraceConfig(ConstBytes);
	void ParseStatsdMetadata(ConstBytes);
	void ParseAndroidPackagesList(ConstBytes);
	void ParseLogMessage(ConstBytes,
	ProtoIncrementalState::PacketSequenceState*,
	size_t sequence_state_generation,
	int64_t,
	base::Optional<UniqueTid>,
	ArgsTracker*,
	RowId);
	void ParseModuleSymbols(ConstBytes);
	void ParseHeapGraph(int64_t ts, ConstBytes);

	private:
	TraceProcessorContext* context_;
	std::unique_ptr<GraphicsEventParser> graphics_event_parser_;

	const StringId utid_name_id_;
	const StringId sched_wakeup_name_id_;
	const StringId sched_waking_name_id_;
	const StringId cpu_freq_name_id_;
	const StringId cpu_idle_name_id_;
	const StringId gpu_freq_name_id_;
	const StringId comm_name_id_;
	const StringId num_forks_name_id_;
	const StringId num_irq_total_name_id_;
	const StringId num_softirq_total_name_id_;
	const StringId num_irq_name_id_;
	const StringId num_softirq_name_id_;
	const StringId cpu_times_user_ns_id_;
	const StringId cpu_times_user_nice_ns_id_;
	const StringId cpu_times_system_mode_ns_id_;
	const StringId cpu_times_idle_ns_id_;
	const StringId cpu_times_io_wait_ns_id_;
	const StringId cpu_times_irq_ns_id_;
	const StringId cpu_times_softirq_ns_id_;
	const StringId signal_deliver_id_;
	const StringId signal_generate_id_;
	const StringId batt_charge_id_;
	const StringId batt_capacity_id_;
	const StringId batt_current_id_;
	const StringId batt_current_avg_id_;
	const StringId lmk_id_;
	const StringId oom_score_adj_id_;
	const StringId ion_total_unknown_id_;
	const StringId ion_change_unknown_id_;
	const StringId metatrace_id_;
	const StringId task_file_name_args_key_id_;
	const StringId task_function_name_args_key_id_;
	const StringId task_line_number_args_key_id_;
	const StringId log_message_body_key_id_;
	const StringId data_name_id_;
	const StringId raw_chrome_metadata_event_id_;
	const StringId raw_chrome_legacy_system_trace_event_id_;
	const StringId raw_chrome_legacy_user_trace_event_id_;
	const StringId raw_legacy_event_id_;
	const StringId legacy_event_category_key_id_;
	const StringId legacy_event_name_key_id_;
	const StringId legacy_event_phase_key_id_;
	const StringId legacy_event_duration_ns_key_id_;
	const StringId legacy_event_thread_timestamp_ns_key_id_;
	const StringId legacy_event_thread_duration_ns_key_id_;
	const StringId legacy_event_thread_instruction_count_key_id_;
	const StringId legacy_event_thread_instruction_delta_key_id_;
	const StringId legacy_event_use_async_tts_key_id_;
	const StringId legacy_event_global_id_key_id_;
	const StringId legacy_event_local_id_key_id_;
	const StringId legacy_event_id_scope_key_id_;
	const StringId legacy_event_bind_id_key_id_;
	const StringId legacy_event_bind_to_enclosing_key_id_;
	const StringId legacy_event_flow_direction_key_id_;
	const StringId flow_direction_value_in_id_;
	const StringId flow_direction_value_out_id_;
	const StringId flow_direction_value_inout_id_;
	std::vector<StringId> meminfo_strs_id_;
	std::vector<StringId> vmstat_strs_id_;
	std::vector<StringId> rss_members_;
	std::vector<StringId> power_rails_strs_id_;

	struct FtraceMessageStrings {
	// The string id of name of the event field (e.g. sched_switch's id).
	StringId message_name_id = 0;
	std::array<StringId, kMaxFtraceEventFields> field_name_ids;
	};
	std::vector<FtraceMessageStrings> ftrace_message_strings_;

	// Maps a proto field number for memcounters in ProcessStats::Process to
	// their StringId. Keep kProcStatsProcessSize equal to 1 + max proto field
	// id of ProcessStats::Process.
	static constexpr size_t kProcStatsProcessSize = 11;
	std::array<StringId, kProcStatsProcessSize> proc_stats_process_names_{};

	struct MmEventCounterNames {
	MmEventCounterNames() = default;
	MmEventCounterNames(StringId _count, StringId _max_lat, StringId _avg_lat)
	: count(_count), max_lat(_max_lat), avg_lat(_avg_lat) {}

	StringId count = 0;
	StringId max_lat = 0;
	StringId avg_lat = 0;
	};

	// Keep kMmEventCounterSize equal to mm_event_type::MM_TYPE_NUM in the kernel.
	static constexpr size_t kMmEventCounterSize = 7;
	std::array<MmEventCounterNames, kMmEventCounterSize> mm_event_counter_names_;
	};

	} // namespace trace_processor
	} // namespace perfetto

	#endif // SRC_TRACE_PROCESSOR_PROTO_TRACE_PARSER_H_