blob: 96833edaa2c6b33b1ef714f2ffbcd20bcee06511 [file] [log] [blame]
/*
* 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.
*/
#include "src/trace_processor/util/descriptors.h"
#include <cstdint>
#include <optional>
#include <vector>
#include "perfetto/base/status.h"
#include "perfetto/ext/base/string_utils.h"
#include "perfetto/ext/base/string_view.h"
#include "perfetto/protozero/field.h"
#include "perfetto/protozero/message.h"
#include "perfetto/protozero/proto_decoder.h"
#include "perfetto/protozero/scattered_heap_buffer.h"
#include "protos/perfetto/common/descriptor.pbzero.h"
#include "protos/perfetto/trace_processor/trace_processor.pbzero.h"
#include "src/trace_processor/util/status_macros.h"
namespace perfetto {
namespace trace_processor {
namespace {
FieldDescriptor CreateFieldFromDecoder(
const protos::pbzero::FieldDescriptorProto::Decoder& f_decoder,
bool is_extension) {
using FieldDescriptorProto = protos::pbzero::FieldDescriptorProto;
std::string type_name =
f_decoder.has_type_name()
? base::StringView(f_decoder.type_name()).ToStdString()
: "";
// TODO(lalitm): add support for enums here.
uint32_t type =
f_decoder.has_type()
? static_cast<uint32_t>(f_decoder.type())
: static_cast<uint32_t>(FieldDescriptorProto::TYPE_MESSAGE);
protos::pbzero::FieldOptions::Decoder opt(f_decoder.options());
return FieldDescriptor(
base::StringView(f_decoder.name()).ToStdString(),
static_cast<uint32_t>(f_decoder.number()), type, std::move(type_name),
std::vector<uint8_t>(f_decoder.options().data,
f_decoder.options().data + f_decoder.options().size),
f_decoder.label() == FieldDescriptorProto::LABEL_REPEATED, opt.packed(),
is_extension);
}
base::Status CheckExtensionField(const ProtoDescriptor& proto_descriptor,
const FieldDescriptor& field) {
using FieldDescriptorProto = protos::pbzero::FieldDescriptorProto;
auto existing_field = proto_descriptor.FindFieldByTag(field.number());
if (existing_field) {
if (field.type() != existing_field->type()) {
return base::ErrStatus("Field %s is re-introduced with different type",
field.name().c_str());
}
if ((field.type() == FieldDescriptorProto::TYPE_MESSAGE ||
field.type() == FieldDescriptorProto::TYPE_ENUM) &&
field.raw_type_name() != existing_field->raw_type_name()) {
return base::ErrStatus(
"Field %s is re-introduced with different type %s (was %s)",
field.name().c_str(), field.raw_type_name().c_str(),
existing_field->raw_type_name().c_str());
}
}
return base::OkStatus();
}
} // namespace
std::optional<uint32_t> DescriptorPool::ResolveShortType(
const std::string& parent_path,
const std::string& short_type) {
PERFETTO_DCHECK(!short_type.empty());
std::string search_path = short_type[0] == '.'
? parent_path + short_type
: parent_path + '.' + short_type;
auto opt_idx = FindDescriptorIdx(search_path);
if (opt_idx)
return opt_idx;
if (parent_path.empty())
return std::nullopt;
auto parent_dot_idx = parent_path.rfind('.');
auto parent_substr = parent_dot_idx == std::string::npos
? ""
: parent_path.substr(0, parent_dot_idx);
return ResolveShortType(parent_substr, short_type);
}
base::Status DescriptorPool::AddExtensionField(
const std::string& package_name,
protozero::ConstBytes field_desc_proto) {
using FieldDescriptorProto = protos::pbzero::FieldDescriptorProto;
FieldDescriptorProto::Decoder f_decoder(field_desc_proto);
auto field = CreateFieldFromDecoder(f_decoder, true);
std::string extendee_name = f_decoder.extendee().ToStdString();
if (extendee_name.empty()) {
return base::ErrStatus("Extendee name is empty");
}
if (extendee_name[0] != '.') {
// Only prepend if the extendee is not fully qualified
extendee_name = package_name + "." + extendee_name;
}
std::optional<uint32_t> extendee = FindDescriptorIdx(extendee_name);
if (!extendee.has_value()) {
return base::ErrStatus("Extendee does not exist %s", extendee_name.c_str());
}
ProtoDescriptor& extendee_desc = descriptors_[extendee.value()];
RETURN_IF_ERROR(CheckExtensionField(extendee_desc, field));
extendee_desc.AddField(field);
return base::OkStatus();
}
base::Status DescriptorPool::AddNestedProtoDescriptors(
const std::string& file_name,
const std::string& package_name,
std::optional<uint32_t> parent_idx,
protozero::ConstBytes descriptor_proto,
std::vector<ExtensionInfo>* extensions,
bool merge_existing_messages) {
protos::pbzero::DescriptorProto::Decoder decoder(descriptor_proto);
auto parent_name =
parent_idx ? descriptors_[*parent_idx].full_name() : package_name;
auto full_name =
parent_name + "." + base::StringView(decoder.name()).ToStdString();
auto idx = FindDescriptorIdx(full_name);
if (idx.has_value() && !merge_existing_messages) {
const auto& existing_descriptor = descriptors_[*idx];
return base::ErrStatus("%s: %s was already defined in file %s",
file_name.c_str(), full_name.c_str(),
existing_descriptor.file_name().c_str());
}
if (!idx.has_value()) {
ProtoDescriptor proto_descriptor(file_name, package_name, full_name,
ProtoDescriptor::Type::kMessage,
parent_idx);
idx = AddProtoDescriptor(std::move(proto_descriptor));
}
ProtoDescriptor& proto_descriptor = descriptors_[*idx];
if (proto_descriptor.type() != ProtoDescriptor::Type::kMessage) {
return base::ErrStatus("%s was enum, redefined as message",
full_name.c_str());
}
using FieldDescriptorProto = protos::pbzero::FieldDescriptorProto;
for (auto it = decoder.field(); it; ++it) {
FieldDescriptorProto::Decoder f_decoder(*it);
auto field = CreateFieldFromDecoder(f_decoder, /*is_extension=*/false);
RETURN_IF_ERROR(CheckExtensionField(proto_descriptor, field));
proto_descriptor.AddField(std::move(field));
}
for (auto it = decoder.enum_type(); it; ++it) {
RETURN_IF_ERROR(AddEnumProtoDescriptors(file_name, package_name, idx, *it,
merge_existing_messages));
}
for (auto it = decoder.nested_type(); it; ++it) {
RETURN_IF_ERROR(AddNestedProtoDescriptors(file_name, package_name, idx, *it,
extensions,
merge_existing_messages));
}
for (auto ext_it = decoder.extension(); ext_it; ++ext_it) {
extensions->emplace_back(package_name, *ext_it);
}
return base::OkStatus();
}
base::Status DescriptorPool::AddEnumProtoDescriptors(
const std::string& file_name,
const std::string& package_name,
std::optional<uint32_t> parent_idx,
protozero::ConstBytes descriptor_proto,
bool merge_existing_messages) {
protos::pbzero::EnumDescriptorProto::Decoder decoder(descriptor_proto);
auto parent_name =
parent_idx ? descriptors_[*parent_idx].full_name() : package_name;
auto full_name =
parent_name + "." + base::StringView(decoder.name()).ToStdString();
auto prev_idx = FindDescriptorIdx(full_name);
if (prev_idx.has_value() && !merge_existing_messages) {
const auto& existing_descriptor = descriptors_[*prev_idx];
return base::ErrStatus("%s: %s was already defined in file %s",
file_name.c_str(), full_name.c_str(),
existing_descriptor.file_name().c_str());
}
if (!prev_idx.has_value()) {
ProtoDescriptor proto_descriptor(file_name, package_name, full_name,
ProtoDescriptor::Type::kEnum,
std::nullopt);
prev_idx = AddProtoDescriptor(std::move(proto_descriptor));
}
ProtoDescriptor& proto_descriptor = descriptors_[*prev_idx];
if (proto_descriptor.type() != ProtoDescriptor::Type::kEnum) {
return base::ErrStatus("%s was message, redefined as enum",
full_name.c_str());
}
for (auto it = decoder.value(); it; ++it) {
protos::pbzero::EnumValueDescriptorProto::Decoder enum_value(it->data(),
it->size());
proto_descriptor.AddEnumValue(enum_value.number(),
enum_value.name().ToStdString());
}
return base::OkStatus();
}
base::Status DescriptorPool::AddFromFileDescriptorSet(
const uint8_t* file_descriptor_set_proto,
size_t size,
const std::vector<std::string>& skip_prefixes,
bool merge_existing_messages) {
protos::pbzero::FileDescriptorSet::Decoder proto(file_descriptor_set_proto,
size);
std::vector<ExtensionInfo> extensions;
for (auto it = proto.file(); it; ++it) {
protos::pbzero::FileDescriptorProto::Decoder file(*it);
const std::string file_name = file.name().ToStdString();
if (base::StartsWithAny(file_name, skip_prefixes))
continue;
if (!merge_existing_messages &&
processed_files_.find(file_name) != processed_files_.end()) {
// This file has been loaded once already. Skip.
continue;
}
processed_files_.insert(file_name);
std::string package = "." + base::StringView(file.package()).ToStdString();
for (auto message_it = file.message_type(); message_it; ++message_it) {
RETURN_IF_ERROR(AddNestedProtoDescriptors(
file_name, package, std::nullopt, *message_it, &extensions,
merge_existing_messages));
}
for (auto enum_it = file.enum_type(); enum_it; ++enum_it) {
RETURN_IF_ERROR(AddEnumProtoDescriptors(
file_name, package, std::nullopt, *enum_it, merge_existing_messages));
}
for (auto ext_it = file.extension(); ext_it; ++ext_it) {
extensions.emplace_back(package, *ext_it);
}
}
// Second pass: Add extension fields to the real protos.
for (const auto& extension : extensions) {
RETURN_IF_ERROR(AddExtensionField(extension.first, extension.second));
}
// Third pass: resolve the types of all the fields.
using FieldDescriptorProto = protos::pbzero::FieldDescriptorProto;
for (ProtoDescriptor& descriptor : descriptors_) {
for (auto& entry : *descriptor.mutable_fields()) {
FieldDescriptor& field = entry.second;
bool needs_resolution =
field.resolved_type_name().empty() &&
(field.type() == FieldDescriptorProto::TYPE_MESSAGE ||
field.type() == FieldDescriptorProto::TYPE_ENUM);
if (needs_resolution) {
auto opt_desc =
ResolveShortType(descriptor.full_name(), field.raw_type_name());
if (!opt_desc.has_value()) {
return base::ErrStatus(
"Unable to find short type %s in field inside message %s",
field.raw_type_name().c_str(), descriptor.full_name().c_str());
}
field.set_resolved_type_name(
descriptors_[opt_desc.value()].full_name());
}
}
}
// Fourth pass: resolve all "uninterpreted" options to real options.
for (ProtoDescriptor& descriptor : descriptors_) {
for (auto& entry : *descriptor.mutable_fields()) {
FieldDescriptor& field = entry.second;
if (field.options().empty()) {
continue;
}
ResolveUninterpretedOption(descriptor, field, *field.mutable_options());
}
}
return base::OkStatus();
}
base::Status DescriptorPool::ResolveUninterpretedOption(
const ProtoDescriptor& proto_desc,
const FieldDescriptor& field_desc,
std::vector<uint8_t>& options) {
auto opt_idx = FindDescriptorIdx(".google.protobuf.FieldOptions");
if (!opt_idx) {
return base::ErrStatus("Unable to find field options for field %s in %s",
field_desc.name().c_str(),
proto_desc.full_name().c_str());
}
ProtoDescriptor& field_options_desc = descriptors_[*opt_idx];
protozero::ProtoDecoder decoder(field_desc.options().data(),
field_desc.options().size());
protozero::HeapBuffered<protozero::Message> field_options;
for (;;) {
const uint8_t* start = decoder.begin() + decoder.read_offset();
auto field = decoder.ReadField();
if (!field.valid()) {
break;
}
const uint8_t* end = decoder.begin() + decoder.read_offset();
if (field.id() !=
protos::pbzero::FieldOptions::kUninterpretedOptionFieldNumber) {
field_options->AppendRawProtoBytes(start,
static_cast<size_t>(end - start));
continue;
}
protos::pbzero::UninterpretedOption::Decoder unint(field.as_bytes());
auto it = unint.name();
if (!it) {
return base::ErrStatus(
"Option for field %s in message %s does not have a name",
field_desc.name().c_str(), proto_desc.full_name().c_str());
}
protos::pbzero::UninterpretedOption::NamePart::Decoder name_part(*it);
auto option_field_desc =
field_options_desc.FindFieldByName(name_part.name_part().ToStdString());
// It's not immediately clear how options with multiple names should
// be parsed. This likely requires digging into protobuf compiler
// source; given we don't have any examples of this in the codebase
// today, defer handling of this to when we may need it.
if (++it) {
return base::ErrStatus(
"Option for field %s in message %s has multiple name segments",
field_desc.name().c_str(), proto_desc.full_name().c_str());
}
if (unint.has_identifier_value()) {
field_options->AppendString(option_field_desc->number(),
unint.identifier_value().ToStdString());
} else if (unint.has_positive_int_value()) {
field_options->AppendVarInt(option_field_desc->number(),
unint.positive_int_value());
} else if (unint.has_negative_int_value()) {
field_options->AppendVarInt(option_field_desc->number(),
unint.negative_int_value());
} else if (unint.has_double_value()) {
field_options->AppendFixed(option_field_desc->number(),
unint.double_value());
} else if (unint.has_string_value()) {
field_options->AppendString(option_field_desc->number(),
unint.string_value().ToStdString());
} else if (unint.has_aggregate_value()) {
field_options->AppendString(option_field_desc->number(),
unint.aggregate_value().ToStdString());
} else {
return base::ErrStatus(
"Unknown field set in UninterpretedOption %s for field %s in message "
"%s",
option_field_desc->name().c_str(), field_desc.name().c_str(),
proto_desc.full_name().c_str());
}
}
if (decoder.bytes_left() > 0) {
return base::ErrStatus("Unexpected extra bytes when parsing option %zu",
decoder.bytes_left());
}
options = field_options.SerializeAsArray();
return base::OkStatus();
}
std::optional<uint32_t> DescriptorPool::FindDescriptorIdx(
const std::string& full_name) const {
auto it = full_name_to_descriptor_index_.find(full_name);
if (it == full_name_to_descriptor_index_.end()) {
return std::nullopt;
}
return it->second;
}
std::vector<uint8_t> DescriptorPool::SerializeAsDescriptorSet() {
protozero::HeapBuffered<protos::pbzero::DescriptorSet> descs;
for (auto& desc : descriptors()) {
protos::pbzero::DescriptorProto* proto_descriptor =
descs->add_descriptors();
proto_descriptor->set_name(desc.full_name());
for (auto& entry : desc.fields()) {
auto& field = entry.second;
protos::pbzero::FieldDescriptorProto* field_descriptor =
proto_descriptor->add_field();
field_descriptor->set_name(field.name());
field_descriptor->set_number(static_cast<int32_t>(field.number()));
// We do not support required fields. They will show up as
// optional after serialization.
field_descriptor->set_label(
field.is_repeated()
? protos::pbzero::FieldDescriptorProto::LABEL_REPEATED
: protos::pbzero::FieldDescriptorProto::LABEL_OPTIONAL);
field_descriptor->set_type_name(field.resolved_type_name());
field_descriptor->set_type(
static_cast<protos::pbzero::FieldDescriptorProto_Type>(field.type()));
}
}
return descs.SerializeAsArray();
}
uint32_t DescriptorPool::AddProtoDescriptor(ProtoDescriptor descriptor) {
uint32_t idx = static_cast<uint32_t>(descriptors_.size());
full_name_to_descriptor_index_[descriptor.full_name()] = idx;
descriptors_.emplace_back(std::move(descriptor));
return idx;
}
ProtoDescriptor::ProtoDescriptor(std::string file_name,
std::string package_name,
std::string full_name,
Type type,
std::optional<uint32_t> parent_id)
: file_name_(std::move(file_name)),
package_name_(std::move(package_name)),
full_name_(std::move(full_name)),
type_(type),
parent_id_(parent_id) {}
FieldDescriptor::FieldDescriptor(std::string name,
uint32_t number,
uint32_t type,
std::string raw_type_name,
std::vector<uint8_t> options,
bool is_repeated,
bool is_packed,
bool is_extension)
: name_(std::move(name)),
number_(number),
type_(type),
raw_type_name_(std::move(raw_type_name)),
options_(std::move(options)),
is_repeated_(is_repeated),
is_packed_(is_packed),
is_extension_(is_extension) {}
} // namespace trace_processor
} // namespace perfetto