tools/trace_to_text/trace_symbol_table.h

/*
 * Copyright (C) 2019 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 TOOLS_TRACE_TO_TEXT_TRACE_SYMBOL_TABLE_H_
#define TOOLS_TRACE_TO_TEXT_TRACE_SYMBOL_TABLE_H_

#include <iostream>

#include "perfetto/profiling/symbolizer.h"
#include "tools/trace_to_text/profile_visitor.h"

namespace perfetto {
namespace trace_to_text {

class TraceSymbolTable : public ProfileVisitor {
 public:
  TraceSymbolTable(Symbolizer* symbolizer) : symbolizer_(symbolizer) {}
  bool AddCallstack(const protos::Callstack&) override { return true; }
  bool AddInternedString(const protos::InternedString& string) override;
  bool AddFrame(const protos::Frame& frame) override;
  bool AddMapping(const protos::Mapping& mapping) override;
  bool AddProfiledFrameSymbols(
      const protos::ProfiledFrameSymbols& symbol) override;

  const std::vector<SymbolizedFrame>* Get(uint64_t frame_iid) const;
  // Call Finalize before using Get or WriteResult.
  bool Finalize();

 private:
  // This is so we can return a const std::string& in ResolveString.
  const std::string kEmptyString = "";
  struct ResolvedMapping {
    std::string mapping_name;
    std::string build_id;
  };

  const std::string& ResolveString(uint64_t iid);
  ResolvedMapping ResolveMapping(const protos::Mapping& mapping);

  // Can be nullptr to disable symbolization. Then TraceSymbolTable only reads
  // the symbol table from the trace.
  Symbolizer* symbolizer_;

  std::map<uint64_t, std::string> interned_strings_;
  std::map<uint64_t, ResolvedMapping> mappings_;

  std::map<std::string, uint64_t> intern_table_;
  uint64_t max_string_intern_id_ = 0;

  std::map<uint64_t /* frame id */, uint64_t /* rel_pc */> rel_pc_for_frame_;

  std::map<uint64_t /* mapping_id */, std::vector<uint64_t> /* frame id */>
      to_symbolize_;

  std::map<uint64_t /* frame_id */, std::vector<SymbolizedFrame>>
      symbols_for_frame_;
};
int SymbolizeProfile(std::istream* input, std::ostream* output);

}  // namespace trace_to_text
}  // namespace perfetto

#endif  // TOOLS_TRACE_TO_TEXT_TRACE_SYMBOL_TABLE_H_