| // Copyright 2018 The Fuchsia Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #include "fidl/flat_ast.h" |
| |
| #include <assert.h> |
| #include <stdio.h> |
| |
| #include <algorithm> |
| #include <sstream> |
| |
| #include "fidl/attributes.h" |
| #include "fidl/lexer.h" |
| #include "fidl/names.h" |
| #include "fidl/parser.h" |
| #include "fidl/raw_ast.h" |
| |
| namespace fidl { |
| namespace flat { |
| |
| namespace { |
| |
| template <typename T> |
| class Scope { |
| public: |
| bool Insert(const T& t) { |
| auto iter = scope_.insert(t); |
| return iter.second; |
| } |
| |
| private: |
| std::set<T> scope_; |
| }; |
| |
| constexpr TypeShape kHandleTypeShape = TypeShape(4u, 4u); |
| constexpr TypeShape kInt8TypeShape = TypeShape(1u, 1u); |
| constexpr TypeShape kInt16TypeShape = TypeShape(2u, 2u); |
| constexpr TypeShape kInt32TypeShape = TypeShape(4u, 4u); |
| constexpr TypeShape kInt64TypeShape = TypeShape(8u, 8u); |
| constexpr TypeShape kUint8TypeShape = TypeShape(1u, 1u); |
| constexpr TypeShape kUint16TypeShape = TypeShape(2u, 2u); |
| constexpr TypeShape kUint32TypeShape = TypeShape(4u, 4u); |
| constexpr TypeShape kUint64TypeShape = TypeShape(8u, 8u); |
| constexpr TypeShape kBoolTypeShape = TypeShape(1u, 1u); |
| constexpr TypeShape kStatusTypeShape = TypeShape(4u, 4u); |
| constexpr TypeShape kFloat32TypeShape = TypeShape(4u, 4u); |
| constexpr TypeShape kFloat64TypeShape = TypeShape(8u, 8u); |
| |
| uint32_t AlignTo(uint32_t size, uint32_t alignment) { |
| auto mask = alignment - 1; |
| size += mask; |
| size &= ~mask; |
| return size; |
| } |
| |
| TypeShape CStructTypeShape(std::vector<FieldShape*>* fields) { |
| uint32_t size = 0u; |
| uint32_t alignment = 1u; |
| uint32_t depth = 0u; |
| |
| for (FieldShape* field : *fields) { |
| TypeShape typeshape = field->Typeshape(); |
| alignment = std::max(alignment, typeshape.Alignment()); |
| size = AlignTo(size, typeshape.Alignment()); |
| field->SetOffset(size); |
| size += typeshape.Size(); |
| depth = std::max(depth, typeshape.Depth()); |
| } |
| |
| size = AlignTo(size, alignment); |
| return TypeShape(size, alignment, depth); |
| } |
| |
| TypeShape CUnionTypeShape(const std::vector<flat::Union::Member>& members) { |
| uint32_t size = 0u; |
| uint32_t alignment = 1u; |
| uint32_t depth = 0u; |
| |
| for (const auto& member : members) { |
| const auto& fieldshape = member.fieldshape; |
| size = std::max(size, fieldshape.Size()); |
| alignment = std::max(alignment, fieldshape.Alignment()); |
| depth = std::max(depth, fieldshape.Depth()); |
| } |
| |
| size = AlignTo(size, alignment); |
| return TypeShape(size, alignment, depth); |
| } |
| |
| TypeShape FidlStructTypeShape(std::vector<FieldShape*>* fields) { |
| return CStructTypeShape(fields); |
| } |
| |
| TypeShape PointerTypeShape(TypeShape element) { |
| // Because FIDL supports recursive data structures, we might not have |
| // computed the TypeShape for the element we're pointing to. In that case, |
| // the size will be zero and we'll use |numeric_limits<uint32_t>::max()| as |
| // the depth. We'll never see a zero size for a real TypeShape because empty |
| // structs are banned. |
| // |
| // We're careful to check for saturation before incrementing the depth |
| // because recursive data structures have a depth pegged at the numeric |
| // limit. |
| uint32_t depth = std::numeric_limits<uint32_t>::max(); |
| if (element.Size() > 0 && element.Depth() < std::numeric_limits<uint32_t>::max()) |
| depth = element.Depth() + 1; |
| return TypeShape(8u, 8u, depth); |
| } |
| |
| TypeShape ArrayTypeShape(TypeShape element, uint32_t count) { |
| return TypeShape(element.Size() * count, element.Alignment(), element.Depth()); |
| } |
| |
| TypeShape VectorTypeShape(TypeShape element) { |
| auto size = FieldShape(kUint64TypeShape); |
| auto data = FieldShape(PointerTypeShape(element)); |
| std::vector<FieldShape*> header{&size, &data}; |
| return CStructTypeShape(&header); |
| } |
| |
| TypeShape StringTypeShape() { |
| auto size = FieldShape(kUint64TypeShape); |
| auto data = FieldShape(PointerTypeShape(kUint8TypeShape)); |
| std::vector<FieldShape*> header{&size, &data}; |
| return CStructTypeShape(&header); |
| } |
| |
| TypeShape PrimitiveTypeShape(types::PrimitiveSubtype type) { |
| switch (type) { |
| case types::PrimitiveSubtype::kInt8: |
| return kInt8TypeShape; |
| case types::PrimitiveSubtype::kInt16: |
| return kInt16TypeShape; |
| case types::PrimitiveSubtype::kInt32: |
| return kInt32TypeShape; |
| case types::PrimitiveSubtype::kInt64: |
| return kInt64TypeShape; |
| case types::PrimitiveSubtype::kUint8: |
| return kUint8TypeShape; |
| case types::PrimitiveSubtype::kUint16: |
| return kUint16TypeShape; |
| case types::PrimitiveSubtype::kUint32: |
| return kUint32TypeShape; |
| case types::PrimitiveSubtype::kUint64: |
| return kUint64TypeShape; |
| case types::PrimitiveSubtype::kBool: |
| return kBoolTypeShape; |
| case types::PrimitiveSubtype::kStatus: |
| return kStatusTypeShape; |
| case types::PrimitiveSubtype::kFloat32: |
| return kFloat32TypeShape; |
| case types::PrimitiveSubtype::kFloat64: |
| return kFloat64TypeShape; |
| } |
| } |
| |
| } // namespace |
| |
| bool Decl::HasAttribute(fidl::StringView name) const { |
| if (!attributes) |
| return false; |
| for (const auto& attribute : attributes->attribute_list) { |
| if (attribute->name->location.data() == name) |
| return true; |
| } |
| return false; |
| } |
| |
| fidl::StringView Decl::GetAttribute(fidl::StringView name) const { |
| if (!attributes) |
| return fidl::StringView(); |
| for (const auto& attribute : attributes->attribute_list) { |
| if (attribute->name->location.data() == name) { |
| if (attribute->value) { |
| auto value = attribute->value->location.data(); |
| if (value.size() >= 2 && value[0] == '"' && value[value.size() - 1] == '"') |
| return fidl::StringView(value.data() + 1, value.size() - 2); |
| } |
| // Don't search for another attribute with the same name. |
| break; |
| } |
| } |
| return fidl::StringView(); |
| } |
| |
| bool Interface::Method::Parameter::IsSimple() const { |
| if (type->kind == Type::Kind::kString) { |
| auto string_type = static_cast<StringType*>(type.get()); |
| return string_type->max_size.Value() < Size::Max().Value(); |
| } else if (type->kind == Type::Kind::kVector) { |
| auto vector_type = static_cast<VectorType*>(type.get()); |
| if (vector_type->element_count.Value() == Size::Max().Value()) |
| return false; |
| switch (vector_type->element_type->kind) { |
| case Type::Kind::kHandle: |
| case Type::Kind::kRequestHandle: |
| case Type::Kind::kPrimitive: |
| return true; |
| case Type::Kind::kArray: |
| case Type::Kind::kVector: |
| case Type::Kind::kString: |
| case Type::Kind::kIdentifier: |
| return false; |
| } |
| } |
| return fieldshape.Depth() == 0u; |
| } |
| |
| // Consuming the AST is primarily concerned with walking the tree and |
| // flattening the representation. The AST's declaration nodes are |
| // converted into the Library's foo_declaration structures. This means pulling |
| // a struct declaration inside an interface out to the top level and |
| // so on. |
| |
| std::string LibraryName(const Library* library, StringView separator) { |
| if (library != nullptr) { |
| return StringJoin(library->name(), separator); |
| } |
| return std::string(); |
| } |
| |
| bool Library::Fail(StringView message) { |
| auto formatted_message = std::string(message) + "\n"; |
| error_reporter_->ReportError(std::move(formatted_message)); |
| return false; |
| } |
| |
| bool Library::Fail(const SourceLocation& location, StringView message) { |
| auto formatted_message = location.position() + ": " + std::string(message) + "\n"; |
| error_reporter_->ReportError(std::move(formatted_message)); |
| return false; |
| } |
| |
| Library::Library(const std::map<std::vector<StringView>, std::unique_ptr<Library>>* dependencies, |
| ErrorReporter* error_reporter) |
| : dependencies_(dependencies), error_reporter_(error_reporter) { |
| for (const auto& dep : *dependencies_) { |
| const std::unique_ptr<Library>& library = dep.second; |
| const auto& declarations = library->declarations_; |
| declarations_.insert(declarations.begin(), declarations.end()); |
| } |
| } |
| |
| bool Library::CompileCompoundIdentifier(const raw::CompoundIdentifier* compound_identifier, |
| SourceLocation location, Name* name_out) { |
| const auto& components = compound_identifier->components; |
| assert(components.size() >= 1); |
| |
| SourceLocation decl_name = components.back()->location; |
| |
| if (components.size() == 1) { |
| *name_out = Name(this, decl_name); |
| return true; |
| } |
| |
| std::vector<StringView> library_name; |
| for (auto iter = components.begin(); |
| iter != components.end() - 1; |
| ++iter) { |
| library_name.push_back((*iter)->location.data()); |
| } |
| |
| auto iter = dependencies_->find(library_name); |
| if (iter == dependencies_->end()) { |
| std::string message("Could not find library named "); |
| message += NameLibrary(library_name); |
| const auto& location = components[0]->location; |
| return Fail(location, message); |
| } |
| |
| const std::unique_ptr<Library>& library = iter->second; |
| *name_out = Name(library.get(), decl_name); |
| return true; |
| } |
| |
| bool Library::ParseSize(std::unique_ptr<Constant> constant, Size* out_size) { |
| uint32_t value; |
| if (!ParseIntegerConstant(constant.get(), &value)) { |
| *out_size = Size(); |
| return false; |
| } |
| *out_size = Size(std::move(constant), value); |
| return true; |
| } |
| |
| void Library::RegisterConst(Const* decl) { |
| const Name* name = &decl->name; |
| constants_.emplace(name, decl); |
| switch (decl->type->kind) { |
| case Type::Kind::kString: |
| string_constants_.emplace(name, decl); |
| break; |
| case Type::Kind::kPrimitive: |
| primitive_constants_.emplace(name, decl); |
| break; |
| default: |
| break; |
| } |
| } |
| |
| bool Library::RegisterDecl(Decl* decl) { |
| const Name* name = &decl->name; |
| auto iter = declarations_.emplace(name, decl); |
| if (!iter.second) { |
| std::string message = "Name collision: "; |
| message.append(name->name().data()); |
| return Fail(*name, message); |
| } |
| return true; |
| } |
| |
| bool Library::ConsumeConstant(std::unique_ptr<raw::Constant> raw_constant, SourceLocation location, |
| std::unique_ptr<Constant>* out_constant) { |
| switch (raw_constant->kind) { |
| case raw::Constant::Kind::kIdentifier: { |
| auto identifier = static_cast<raw::IdentifierConstant*>(raw_constant.get()); |
| Name name; |
| if (!CompileCompoundIdentifier(identifier->identifier.get(), location, &name)) { |
| return false; |
| } |
| *out_constant = std::make_unique<IdentifierConstant>(std::move(name)); |
| break; |
| } |
| case raw::Constant::Kind::kLiteral: { |
| auto literal = static_cast<raw::LiteralConstant*>(raw_constant.get()); |
| *out_constant = std::make_unique<LiteralConstant>(std::move(literal->literal)); |
| break; |
| } |
| } |
| return true; |
| } |
| |
| bool Library::ConsumeType(std::unique_ptr<raw::Type> raw_type, SourceLocation location, |
| std::unique_ptr<Type>* out_type) { |
| switch (raw_type->kind) { |
| case raw::Type::Kind::kArray: { |
| auto array_type = static_cast<raw::ArrayType*>(raw_type.get()); |
| std::unique_ptr<Type> element_type; |
| if (!ConsumeType(std::move(array_type->element_type), location, &element_type)) |
| return false; |
| std::unique_ptr<Constant> constant; |
| if (!ConsumeConstant(std::move(array_type->element_count), location, &constant)) |
| return false; |
| Size element_count; |
| if (!ParseSize(std::move(constant), &element_count)) |
| return Fail(location, "Unable to parse array element count"); |
| uint32_t size; |
| if (__builtin_mul_overflow(element_count.Value(), element_type->size, &size)) { |
| return Fail(location, "The array's size overflows a uint32_t"); |
| } |
| *out_type = |
| std::make_unique<ArrayType>(size, std::move(element_type), std::move(element_count)); |
| break; |
| } |
| case raw::Type::Kind::kVector: { |
| auto vector_type = static_cast<raw::VectorType*>(raw_type.get()); |
| std::unique_ptr<Type> element_type; |
| if (!ConsumeType(std::move(vector_type->element_type), location, &element_type)) |
| return false; |
| Size element_count = Size::Max(); |
| if (vector_type->maybe_element_count) { |
| std::unique_ptr<Constant> constant; |
| if (!ConsumeConstant(std::move(vector_type->maybe_element_count), location, &constant)) |
| return false; |
| if (!ParseSize(std::move(constant), &element_count)) |
| return Fail(location, "Unable to parse vector size bound"); |
| } |
| *out_type = std::make_unique<VectorType>(std::move(element_type), std::move(element_count), |
| vector_type->nullability); |
| break; |
| } |
| case raw::Type::Kind::kString: { |
| auto string_type = static_cast<raw::StringType*>(raw_type.get()); |
| Size element_count = Size::Max(); |
| if (string_type->maybe_element_count) { |
| std::unique_ptr<Constant> constant; |
| if (!ConsumeConstant(std::move(string_type->maybe_element_count), location, &constant)) |
| return false; |
| if (!ParseSize(std::move(constant), &element_count)) |
| return Fail(location, "Unable to parse string size bound"); |
| } |
| *out_type = |
| std::make_unique<StringType>(std::move(element_count), string_type->nullability); |
| break; |
| } |
| case raw::Type::Kind::kHandle: { |
| auto handle_type = static_cast<raw::HandleType*>(raw_type.get()); |
| *out_type = std::make_unique<HandleType>(handle_type->subtype, handle_type->nullability); |
| break; |
| } |
| case raw::Type::Kind::kRequestHandle: { |
| auto request_type = static_cast<raw::RequestHandleType*>(raw_type.get()); |
| Name name; |
| if (!CompileCompoundIdentifier(request_type->identifier.get(), location, &name)) { |
| return false; |
| } |
| *out_type = std::make_unique<RequestHandleType>(std::move(name), request_type->nullability); |
| break; |
| } |
| case raw::Type::Kind::kPrimitive: { |
| auto primitive_type = static_cast<raw::PrimitiveType*>(raw_type.get()); |
| *out_type = std::make_unique<PrimitiveType>(primitive_type->subtype); |
| break; |
| } |
| case raw::Type::Kind::kIdentifier: { |
| auto identifier_type = static_cast<raw::IdentifierType*>(raw_type.get()); |
| Name name; |
| if (!CompileCompoundIdentifier(identifier_type->identifier.get(), location, &name)) { |
| return false; |
| } |
| *out_type = std::make_unique<IdentifierType>(std::move(name), identifier_type->nullability); |
| break; |
| } |
| } |
| return true; |
| } |
| |
| bool Library::ConsumeConstDeclaration(std::unique_ptr<raw::ConstDeclaration> const_declaration) { |
| auto attributes = std::move(const_declaration->attributes); |
| auto location = const_declaration->identifier->location; |
| auto name = Name(this, location); |
| std::unique_ptr<Type> type; |
| if (!ConsumeType(std::move(const_declaration->type), location, &type)) |
| return false; |
| |
| std::unique_ptr<Constant> constant; |
| if (!ConsumeConstant(std::move(const_declaration->constant), location, &constant)) |
| return false; |
| |
| const_declarations_.push_back(std::make_unique<Const>(std::move(attributes), std::move(name), |
| std::move(type), std::move(constant))); |
| auto decl = const_declarations_.back().get(); |
| RegisterConst(decl); |
| return RegisterDecl(decl); |
| } |
| |
| bool Library::ConsumeEnumDeclaration(std::unique_ptr<raw::EnumDeclaration> enum_declaration) { |
| std::vector<Enum::Member> members; |
| for (auto& member : enum_declaration->members) { |
| auto location = member->identifier->location; |
| std::unique_ptr<Constant> value; |
| if (!ConsumeConstant(std::move(member->value), location, &value)) |
| return false; |
| members.emplace_back(location, std::move(value)); |
| } |
| auto type = types::PrimitiveSubtype::kUint32; |
| if (enum_declaration->maybe_subtype) |
| type = enum_declaration->maybe_subtype->subtype; |
| |
| auto attributes = std::move(enum_declaration->attributes); |
| auto name = Name(this, enum_declaration->identifier->location); |
| |
| enum_declarations_.push_back( |
| std::make_unique<Enum>(std::move(attributes), std::move(name), type, std::move(members))); |
| return RegisterDecl(enum_declarations_.back().get()); |
| } |
| |
| bool Library::ConsumeInterfaceDeclaration( |
| std::unique_ptr<raw::InterfaceDeclaration> interface_declaration) { |
| auto attributes = std::move(interface_declaration->attributes); |
| auto name = Name(this, interface_declaration->identifier->location); |
| |
| std::vector<Interface::Method> methods; |
| for (auto& method : interface_declaration->methods) { |
| auto ordinal_literal = std::move(method->ordinal); |
| uint32_t value; |
| if (!ParseIntegerLiteral<decltype(value)>(ordinal_literal.get(), &value)) |
| return Fail(ordinal_literal->location, "Unable to parse ordinal"); |
| if (value == 0u) |
| return Fail(ordinal_literal->location, "Fidl ordinals cannot be 0"); |
| Ordinal ordinal(std::move(ordinal_literal), value); |
| |
| SourceLocation method_name = method->identifier->location; |
| |
| std::unique_ptr<Interface::Method::Message> maybe_request; |
| if (method->maybe_request != nullptr) { |
| maybe_request.reset(new Interface::Method::Message()); |
| for (auto& parameter : method->maybe_request->parameter_list) { |
| SourceLocation parameter_name = parameter->identifier->location; |
| std::unique_ptr<Type> type; |
| if (!ConsumeType(std::move(parameter->type), parameter_name, &type)) |
| return false; |
| maybe_request->parameters.emplace_back(std::move(type), std::move(parameter_name)); |
| } |
| } |
| |
| std::unique_ptr<Interface::Method::Message> maybe_response; |
| if (method->maybe_response != nullptr) { |
| maybe_response.reset(new Interface::Method::Message()); |
| for (auto& parameter : method->maybe_response->parameter_list) { |
| SourceLocation parameter_name = parameter->identifier->location; |
| std::unique_ptr<Type> type; |
| if (!ConsumeType(std::move(parameter->type), parameter_name, &type)) |
| return false; |
| maybe_response->parameters.emplace_back(std::move(type), parameter_name); |
| } |
| } |
| |
| assert(maybe_request != nullptr || maybe_response != nullptr); |
| |
| methods.emplace_back(std::move(ordinal), std::move(method_name), std::move(maybe_request), |
| std::move(maybe_response)); |
| } |
| |
| interface_declarations_.push_back( |
| std::make_unique<Interface>(std::move(attributes), std::move(name), std::move(methods))); |
| return RegisterDecl(interface_declarations_.back().get()); |
| } |
| |
| bool Library::ConsumeStructDeclaration(std::unique_ptr<raw::StructDeclaration> struct_declaration) { |
| auto attributes = std::move(struct_declaration->attributes); |
| auto name = Name(this, struct_declaration->identifier->location); |
| |
| std::vector<Struct::Member> members; |
| for (auto& member : struct_declaration->members) { |
| std::unique_ptr<Type> type; |
| auto location = member->identifier->location; |
| if (!ConsumeType(std::move(member->type), location, &type)) |
| return false; |
| std::unique_ptr<Constant> maybe_default_value; |
| if (member->maybe_default_value != nullptr) { |
| if (!ConsumeConstant(std::move(member->maybe_default_value), location, |
| &maybe_default_value)) |
| return false; |
| } |
| members.emplace_back(std::move(type), member->identifier->location, |
| std::move(maybe_default_value)); |
| } |
| |
| struct_declarations_.push_back( |
| std::make_unique<Struct>(std::move(attributes), std::move(name), std::move(members))); |
| return RegisterDecl(struct_declarations_.back().get()); |
| } |
| |
| bool Library::ConsumeUnionDeclaration(std::unique_ptr<raw::UnionDeclaration> union_declaration) { |
| std::vector<Union::Member> members; |
| for (auto& member : union_declaration->members) { |
| auto location = member->identifier->location; |
| std::unique_ptr<Type> type; |
| if (!ConsumeType(std::move(member->type), location, &type)) |
| return false; |
| members.emplace_back(std::move(type), location); |
| } |
| |
| auto attributes = std::move(union_declaration->attributes); |
| auto name = Name(this, union_declaration->identifier->location); |
| |
| union_declarations_.push_back( |
| std::make_unique<Union>(std::move(attributes), std::move(name), std::move(members))); |
| return RegisterDecl(union_declarations_.back().get()); |
| } |
| |
| bool Library::ConsumeFile(std::unique_ptr<raw::File> file) { |
| // All fidl files in a library should agree on the library name. |
| std::vector<StringView> new_name; |
| for (const auto& part : file->library_name->components) { |
| new_name.push_back(part->location.data()); |
| } |
| if (!library_name_.empty()) { |
| if (new_name != library_name_) { |
| return Fail(file->library_name->components[0]->location, |
| "Two files in the library disagree about the name of the library"); |
| } |
| } else { |
| library_name_ = new_name; |
| } |
| |
| auto using_list = std::move(file->using_list); |
| |
| auto const_declaration_list = std::move(file->const_declaration_list); |
| for (auto& const_declaration : const_declaration_list) { |
| if (!ConsumeConstDeclaration(std::move(const_declaration))) { |
| return false; |
| } |
| } |
| |
| auto enum_declaration_list = std::move(file->enum_declaration_list); |
| for (auto& enum_declaration : enum_declaration_list) { |
| if (!ConsumeEnumDeclaration(std::move(enum_declaration))) { |
| return false; |
| } |
| } |
| |
| auto interface_declaration_list = std::move(file->interface_declaration_list); |
| for (auto& interface_declaration : interface_declaration_list) { |
| if (!ConsumeInterfaceDeclaration(std::move(interface_declaration))) { |
| return false; |
| } |
| } |
| |
| auto struct_declaration_list = std::move(file->struct_declaration_list); |
| for (auto& struct_declaration : struct_declaration_list) { |
| if (!ConsumeStructDeclaration(std::move(struct_declaration))) { |
| return false; |
| } |
| } |
| |
| auto union_declaration_list = std::move(file->union_declaration_list); |
| for (auto& union_declaration : union_declaration_list) { |
| if (!ConsumeUnionDeclaration(std::move(union_declaration))) { |
| return false; |
| } |
| } |
| |
| return true; |
| } |
| |
| // Library resolution is concerned with resolving identifiers to their |
| // declarations, and with computing type sizes and alignments. |
| |
| bool Library::TypecheckString(const IdentifierConstant* identifier) { |
| auto iter = string_constants_.find(&identifier->name); |
| if (iter == string_constants_.end()) |
| return Fail(identifier->name.name(), "Unable to find string constant"); |
| // TODO(kulakowski) Check string bounds. |
| return true; |
| } |
| |
| bool Library::TypecheckPrimitive(const IdentifierConstant* identifier) { |
| auto iter = primitive_constants_.find(&identifier->name); |
| if (iter == primitive_constants_.end()) |
| return Fail(identifier->name.name(), "Unable to find primitive constant"); |
| // TODO(kulakowski) Check numeric values. |
| return true; |
| } |
| |
| bool Library::TypecheckConst(const Const* const_declaration) { |
| auto type = const_declaration->type.get(); |
| auto constant = const_declaration->value.get(); |
| switch (type->kind) { |
| case Type::Kind::kArray: |
| return Fail("Tried to generate an array constant"); |
| case Type::Kind::kVector: |
| return Fail("Tried to generate an vector constant"); |
| case Type::Kind::kHandle: |
| return Fail("Tried to generate a handle constant"); |
| case Type::Kind::kRequestHandle: |
| return Fail("Tried to generate a request handle constant"); |
| case Type::Kind::kString: { |
| switch (constant->kind) { |
| case Constant::Kind::kIdentifier: { |
| auto identifier_constant = static_cast<const IdentifierConstant*>(constant); |
| return TypecheckString(identifier_constant); |
| } |
| case Constant::Kind::kLiteral: { |
| auto literal_constant = static_cast<const LiteralConstant*>(constant); |
| switch (literal_constant->literal->kind) { |
| case raw::Literal::Kind::kString: |
| return true; |
| case raw::Literal::Kind::kNumeric: |
| return Fail("Tried to assign a numeric literal into a string"); |
| case raw::Literal::Kind::kTrue: |
| case raw::Literal::Kind::kFalse: |
| return Fail("Tried to assign a bool literal into a string"); |
| } |
| } |
| } |
| } |
| case Type::Kind::kPrimitive: { |
| auto primitive_type = static_cast<const PrimitiveType*>(type); |
| switch (constant->kind) { |
| case Constant::Kind::kIdentifier: { |
| auto identifier_constant = static_cast<const IdentifierConstant*>(constant); |
| return TypecheckPrimitive(identifier_constant); |
| } |
| case Constant::Kind::kLiteral: { |
| auto literal_constant = static_cast<const LiteralConstant*>(constant); |
| switch (literal_constant->literal->kind) { |
| case raw::Literal::Kind::kString: |
| return Fail("Tried to assign a string literal to a numeric constant"); |
| case raw::Literal::Kind::kNumeric: |
| // TODO(kulakowski) Check the constants of numbers. |
| switch (primitive_type->subtype) { |
| case types::PrimitiveSubtype::kUint8: |
| case types::PrimitiveSubtype::kUint16: |
| case types::PrimitiveSubtype::kUint32: |
| case types::PrimitiveSubtype::kUint64: |
| case types::PrimitiveSubtype::kInt8: |
| case types::PrimitiveSubtype::kInt16: |
| case types::PrimitiveSubtype::kInt32: |
| case types::PrimitiveSubtype::kInt64: |
| case types::PrimitiveSubtype::kFloat32: |
| case types::PrimitiveSubtype::kFloat64: |
| return true; |
| case types::PrimitiveSubtype::kBool: |
| return Fail("Tried to assign a numeric literal into a bool"); |
| case types::PrimitiveSubtype::kStatus: |
| return Fail("Tried to assign a numeric literal into a status"); |
| } |
| case raw::Literal::Kind::kTrue: |
| case raw::Literal::Kind::kFalse: |
| switch (primitive_type->subtype) { |
| case types::PrimitiveSubtype::kBool: |
| return true; |
| case types::PrimitiveSubtype::kUint8: |
| case types::PrimitiveSubtype::kUint16: |
| case types::PrimitiveSubtype::kUint32: |
| case types::PrimitiveSubtype::kUint64: |
| case types::PrimitiveSubtype::kInt8: |
| case types::PrimitiveSubtype::kInt16: |
| case types::PrimitiveSubtype::kInt32: |
| case types::PrimitiveSubtype::kInt64: |
| case types::PrimitiveSubtype::kFloat32: |
| case types::PrimitiveSubtype::kFloat64: |
| return Fail("Tried to assign a bool into a numeric type"); |
| case types::PrimitiveSubtype::kStatus: |
| return Fail("Tried to assign a bool into a status"); |
| } |
| } |
| } |
| } |
| } |
| case Type::Kind::kIdentifier: { |
| auto identifier_type = static_cast<const IdentifierType*>(type); |
| auto decl = LookupType(identifier_type); |
| switch (decl->kind) { |
| case Decl::Kind::kConst: |
| assert(false && "const declarations don't make types!"); |
| return false; |
| case Decl::Kind::kEnum: |
| return true; |
| case Decl::Kind::kInterface: |
| return Fail("Tried to create a const declaration of interface type"); |
| case Decl::Kind::kStruct: |
| return Fail("Tried to create a const declaration of struct type"); |
| case Decl::Kind::kUnion: |
| return Fail("Tried to create a const declaration of union type"); |
| } |
| } |
| } |
| } |
| |
| Decl* Library::LookupConstant(const Type* type, const Name& name) { |
| auto decl = LookupType(type); |
| if (decl == nullptr) { |
| // This wasn't a named type. Thus we are looking up a |
| // top-level constant, of string or primitive type. |
| assert(type->kind == Type::Kind::kString || type->kind == Type::Kind::kPrimitive); |
| auto iter = constants_.find(&name); |
| if (iter == constants_.end()) { |
| return nullptr; |
| } |
| return iter->second; |
| } |
| // We must otherwise be looking for an enum member. |
| if (decl->kind != Decl::Kind::kEnum) { |
| return nullptr; |
| } |
| auto enum_decl = static_cast<Enum*>(decl); |
| for (auto& member : enum_decl->members) { |
| if (member.name.data() == name.name().data()) { |
| return enum_decl; |
| } |
| } |
| // The enum didn't have a member of that name! |
| return nullptr; |
| } |
| |
| Decl* Library::LookupType(const Type* type) const { |
| for (;;) { |
| switch (type->kind) { |
| case flat::Type::Kind::kString: |
| case flat::Type::Kind::kHandle: |
| case flat::Type::Kind::kRequestHandle: |
| case flat::Type::Kind::kPrimitive: |
| return nullptr; |
| case flat::Type::Kind::kVector: { |
| type = static_cast<const flat::VectorType*>(type)->element_type.get(); |
| continue; |
| } |
| case flat::Type::Kind::kArray: { |
| type = static_cast<const flat::ArrayType*>(type)->element_type.get(); |
| continue; |
| } |
| case flat::Type::Kind::kIdentifier: { |
| auto identifier_type = static_cast<const flat::IdentifierType*>(type); |
| if (identifier_type->nullability == types::Nullability::kNullable) { |
| return nullptr; |
| } |
| return LookupType(identifier_type->name); |
| } |
| } |
| } |
| } |
| |
| Decl* Library::LookupType(const Name& name) const { |
| auto iter = declarations_.find(&name); |
| if (iter == declarations_.end()) { |
| return nullptr; |
| } |
| return iter->second; |
| } |
| |
| // An edge from D1 to D2 means that a C needs to see the declaration |
| // of D1 before the declaration of D2. For instance, given the fidl |
| // struct D2 { D1 d; }; |
| // struct D1 { int32 x; }; |
| // D1 has an edge pointing to D2. Note that struct and union pointers, |
| // unlike inline structs or unions, do not have dependency edges. |
| bool Library::DeclDependencies(Decl* decl, std::set<Decl*>* out_edges) { |
| std::set<Decl*> edges; |
| auto maybe_add_decl = [this, &edges](const Type* type) { |
| auto type_decl = LookupType(type); |
| if (type_decl != nullptr) { |
| edges.insert(type_decl); |
| } |
| }; |
| auto maybe_add_constant = [this, &edges](const Type* type, const Constant* constant) -> bool { |
| switch (constant->kind) { |
| case Constant::Kind::kIdentifier: { |
| auto identifier = static_cast<const flat::IdentifierConstant*>(constant); |
| auto decl = LookupConstant(type, identifier->name); |
| if (decl == nullptr) { |
| std::string message("Unable to find the constant named: "); |
| message += identifier->name.name().data(); |
| return Fail(identifier->name, message.data()); |
| } |
| edges.insert(decl); |
| break; |
| } |
| case Constant::Kind::kLiteral: { |
| // Literals have no dependencies on other declarations. |
| break; |
| } |
| } |
| return true; |
| }; |
| switch (decl->kind) { |
| case Decl::Kind::kConst: { |
| auto const_decl = static_cast<const Const*>(decl); |
| if (!maybe_add_constant(const_decl->type.get(), const_decl->value.get())) |
| return false; |
| break; |
| } |
| case Decl::Kind::kEnum: { |
| break; |
| } |
| case Decl::Kind::kInterface: { |
| auto interface_decl = static_cast<const Interface*>(decl); |
| for (const auto& method : interface_decl->methods) { |
| if (method.maybe_request != nullptr) { |
| for (const auto& parameter : method.maybe_request->parameters) { |
| maybe_add_decl(parameter.type.get()); |
| } |
| } |
| if (method.maybe_response != nullptr) { |
| for (const auto& parameter : method.maybe_response->parameters) { |
| maybe_add_decl(parameter.type.get()); |
| } |
| } |
| } |
| break; |
| } |
| case Decl::Kind::kStruct: { |
| auto struct_decl = static_cast<const Struct*>(decl); |
| for (const auto& member : struct_decl->members) { |
| maybe_add_decl(member.type.get()); |
| if (member.maybe_default_value) { |
| if (!maybe_add_constant(member.type.get(), member.maybe_default_value.get())) |
| return false; |
| } |
| } |
| break; |
| } |
| case Decl::Kind::kUnion: { |
| auto union_decl = static_cast<const Union*>(decl); |
| for (const auto& member : union_decl->members) { |
| maybe_add_decl(member.type.get()); |
| } |
| break; |
| } |
| } |
| *out_edges = std::move(edges); |
| return true; |
| } |
| |
| bool Library::SortDeclarations() { |
| // |degree| is the number of undeclared dependencies for each decl. |
| std::map<Decl*, uint32_t> degrees; |
| // |inverse_dependencies| records the decls that depend on each decl. |
| std::map<Decl*, std::vector<Decl*>> inverse_dependencies; |
| for (auto& name_and_decl : declarations_) { |
| Decl* decl = name_and_decl.second; |
| degrees[decl] = 0u; |
| } |
| for (auto& name_and_decl : declarations_) { |
| Decl* decl = name_and_decl.second; |
| std::set<Decl*> deps; |
| if (!DeclDependencies(decl, &deps)) |
| return false; |
| degrees[decl] += deps.size(); |
| for (Decl* dep : deps) { |
| inverse_dependencies[dep].push_back(decl); |
| } |
| } |
| |
| // Start with all decls that have no incoming edges. |
| std::vector<Decl*> decls_without_deps; |
| for (const auto& decl_and_degree : degrees) { |
| if (decl_and_degree.second == 0u) { |
| decls_without_deps.push_back(decl_and_degree.first); |
| } |
| } |
| |
| while (!decls_without_deps.empty()) { |
| // Pull one out of the queue. |
| auto decl = decls_without_deps.back(); |
| decls_without_deps.pop_back(); |
| assert(degrees[decl] == 0u); |
| declaration_order_.push_back(decl); |
| |
| // Decrement the incoming degree of all the other decls it |
| // points to. |
| auto& inverse_deps = inverse_dependencies[decl]; |
| for (Decl* inverse_dep : inverse_deps) { |
| uint32_t& degree = degrees[inverse_dep]; |
| assert(degree != 0u); |
| degree -= 1; |
| if (degree == 0u) |
| decls_without_deps.push_back(inverse_dep); |
| } |
| } |
| |
| if (declaration_order_.size() != degrees.size()) { |
| // We didn't visit all the edges! There was a cycle. |
| return Fail("There is an includes-cycle in declarations"); |
| } |
| |
| return true; |
| } |
| |
| bool Library::CompileConst(Const* const_declaration) { |
| TypeShape typeshape; |
| if (!CompileType(const_declaration->type.get(), &typeshape)) { |
| return false; |
| } |
| if (!TypecheckConst(const_declaration)) { |
| return false; |
| } |
| return true; |
| } |
| |
| bool Library::CompileEnum(Enum* enum_declaration) { |
| switch (enum_declaration->type) { |
| case types::PrimitiveSubtype::kInt8: |
| case types::PrimitiveSubtype::kInt16: |
| case types::PrimitiveSubtype::kInt32: |
| case types::PrimitiveSubtype::kInt64: |
| case types::PrimitiveSubtype::kUint8: |
| case types::PrimitiveSubtype::kUint16: |
| case types::PrimitiveSubtype::kUint32: |
| case types::PrimitiveSubtype::kUint64: |
| // These are allowed as enum subtypes. Compile the size and alignment. |
| enum_declaration->typeshape = PrimitiveTypeShape(enum_declaration->type); |
| break; |
| |
| case types::PrimitiveSubtype::kBool: |
| case types::PrimitiveSubtype::kStatus: |
| case types::PrimitiveSubtype::kFloat32: |
| case types::PrimitiveSubtype::kFloat64: |
| // These are not allowed as enum subtypes. |
| return Fail(*enum_declaration, "Enums cannot be bools, statuses, or floats"); |
| } |
| |
| // TODO(TO-702) Validate values. |
| return true; |
| } |
| |
| bool Library::CompileInterface(Interface* interface_declaration) { |
| // TODO(TO-703) Add subinterfaces here. |
| Scope<StringView> name_scope; |
| Scope<uint32_t> ordinal_scope; |
| bool is_simple = HasSimpleLayout(interface_declaration); |
| for (auto& method : interface_declaration->methods) { |
| if (!name_scope.Insert(method.name.data())) |
| return Fail(method.name, "Multiple methods with the same name in an interface"); |
| if (!ordinal_scope.Insert(method.ordinal.Value())) |
| return Fail(method.name, "Mulitple methods with the same ordinal in an interface"); |
| auto CreateMessage = [&](Interface::Method::Message* message) -> bool { |
| Scope<StringView> scope; |
| auto header_field_shape = FieldShape(TypeShape(16u, 4u)); |
| std::vector<FieldShape*> message_struct; |
| message_struct.push_back(&header_field_shape); |
| for (auto& param : message->parameters) { |
| if (!scope.Insert(param.name.data())) |
| return Fail(param.name, "Multiple parameters with the same name in a method"); |
| if (!CompileType(param.type.get(), ¶m.fieldshape.Typeshape())) |
| return false; |
| message_struct.push_back(¶m.fieldshape); |
| if (is_simple && !param.IsSimple()) |
| return Fail(param.name, "Non-simple parameter in interface with [Layout=\"Simple\"]"); |
| } |
| message->typeshape = FidlStructTypeShape(&message_struct); |
| return true; |
| }; |
| if (method.maybe_request) { |
| if (!CreateMessage(method.maybe_request.get())) |
| return false; |
| } |
| if (method.maybe_response) { |
| if (!CreateMessage(method.maybe_response.get())) |
| return false; |
| } |
| } |
| return true; |
| } |
| |
| bool Library::CompileStruct(Struct* struct_declaration) { |
| Scope<StringView> scope; |
| std::vector<FieldShape*> fidl_struct; |
| for (auto& member : struct_declaration->members) { |
| if (!scope.Insert(member.name.data())) |
| return Fail(member.name, "Multiple struct fields with the same name"); |
| if (!CompileType(member.type.get(), &member.fieldshape.Typeshape())) |
| return false; |
| fidl_struct.push_back(&member.fieldshape); |
| } |
| |
| struct_declaration->typeshape = FidlStructTypeShape(&fidl_struct); |
| |
| return true; |
| } |
| |
| bool Library::CompileUnion(Union* union_declaration) { |
| Scope<StringView> scope; |
| for (auto& member : union_declaration->members) { |
| if (!scope.Insert(member.name.data())) |
| return Fail(member.name, "Multiple union members with the same name"); |
| if (!CompileType(member.type.get(), &member.fieldshape.Typeshape())) |
| return false; |
| } |
| |
| auto tag = FieldShape(kUint32TypeShape); |
| union_declaration->membershape = FieldShape(CUnionTypeShape(union_declaration->members)); |
| std::vector<FieldShape*> fidl_union = {&tag, &union_declaration->membershape}; |
| union_declaration->typeshape = CStructTypeShape(&fidl_union); |
| |
| // This is either 4 or 8, depending on whether any union members |
| // have alignment 8. |
| auto offset = union_declaration->membershape.Offset(); |
| for (auto& member : union_declaration->members) { |
| member.fieldshape.SetOffset(offset); |
| } |
| |
| return true; |
| } |
| |
| bool Library::Compile() { |
| for (const auto& name_and_library : *dependencies_) { |
| const Library* library = name_and_library.second.get(); |
| constants_.insert(library->constants_.begin(), library->constants_.end()); |
| } |
| |
| if (!SortDeclarations()) { |
| return false; |
| } |
| |
| // We process declarations in topologically sorted order. For |
| // example, we process a struct member's type before the entire |
| // struct. |
| for (Decl* decl : declaration_order_) { |
| switch (decl->kind) { |
| case Decl::Kind::kConst: { |
| auto const_decl = static_cast<Const*>(decl); |
| if (!CompileConst(const_decl)) { |
| return false; |
| } |
| break; |
| } |
| case Decl::Kind::kEnum: { |
| auto enum_decl = static_cast<Enum*>(decl); |
| if (!CompileEnum(enum_decl)) { |
| return false; |
| } |
| break; |
| } |
| case Decl::Kind::kInterface: { |
| auto interface_decl = static_cast<Interface*>(decl); |
| if (!CompileInterface(interface_decl)) { |
| return false; |
| } |
| break; |
| } |
| case Decl::Kind::kStruct: { |
| auto struct_decl = static_cast<Struct*>(decl); |
| if (!CompileStruct(struct_decl)) { |
| return false; |
| } |
| break; |
| } |
| case Decl::Kind::kUnion: { |
| auto union_decl = static_cast<Union*>(decl); |
| if (!CompileUnion(union_decl)) { |
| return false; |
| } |
| break; |
| } |
| default: |
| abort(); |
| } |
| } |
| |
| return true; |
| } |
| |
| bool Library::CompileArrayType(flat::ArrayType* array_type, TypeShape* out_typeshape) { |
| TypeShape element_typeshape; |
| if (!CompileType(array_type->element_type.get(), &element_typeshape)) |
| return false; |
| *out_typeshape = ArrayTypeShape(element_typeshape, array_type->element_count.Value()); |
| return true; |
| } |
| |
| bool Library::CompileVectorType(flat::VectorType* vector_type, TypeShape* out_typeshape) { |
| // We do not need the typeshape, but we do need to compile the |
| // element type. Compiling the type is the time we check for |
| // certain invalid states, like optional enums (prior to this we |
| // do not know if |Foo?| is referring to a struct or union, or an |
| // enum). |
| TypeShape element_typeshape; |
| if (!CompileType(vector_type->element_type.get(), &element_typeshape)) |
| return false; |
| *out_typeshape = VectorTypeShape(element_typeshape); |
| return true; |
| } |
| |
| bool Library::CompileStringType(flat::StringType* string_type, TypeShape* out_typeshape) { |
| *out_typeshape = StringTypeShape(); |
| return true; |
| } |
| |
| bool Library::CompileHandleType(flat::HandleType* handle_type, TypeShape* out_typeshape) { |
| // Nothing to check. |
| *out_typeshape = kHandleTypeShape; |
| return true; |
| } |
| |
| bool Library::CompileRequestHandleType(flat::RequestHandleType* request_type, |
| TypeShape* out_typeshape) { |
| auto named_decl = LookupType(request_type->name); |
| if (!named_decl || named_decl->kind != Decl::Kind::kInterface) |
| return Fail(request_type->name, "Undefined reference in request handle name"); |
| |
| *out_typeshape = kHandleTypeShape; |
| return true; |
| } |
| |
| bool Library::CompilePrimitiveType(flat::PrimitiveType* primitive_type, TypeShape* out_typeshape) { |
| *out_typeshape = PrimitiveTypeShape(primitive_type->subtype); |
| return true; |
| } |
| |
| bool Library::CompileIdentifierType(flat::IdentifierType* identifier_type, |
| TypeShape* out_typeshape) { |
| TypeShape typeshape; |
| |
| auto named_decl = LookupType(identifier_type->name); |
| if (!named_decl) |
| return Fail(identifier_type->name, "Undefined reference in identifier type name"); |
| |
| switch (named_decl->kind) { |
| case Decl::Kind::kConst: { |
| // A constant isn't a type! |
| return Fail(identifier_type->name, |
| "The name of a constant was used where a type was expected"); |
| } |
| case Decl::Kind::kEnum: { |
| if (identifier_type->nullability == types::Nullability::kNullable) { |
| // Enums aren't nullable! |
| return Fail(identifier_type->name, "An enum was referred to as 'nullable'"); |
| } else { |
| typeshape = static_cast<const Enum*>(named_decl)->typeshape; |
| } |
| break; |
| } |
| case Decl::Kind::kInterface: { |
| typeshape = kHandleTypeShape; |
| break; |
| } |
| case Decl::Kind::kStruct: { |
| typeshape = static_cast<const Struct*>(named_decl)->typeshape; |
| if (identifier_type->nullability == types::Nullability::kNullable) |
| typeshape = PointerTypeShape(typeshape); |
| break; |
| } |
| case Decl::Kind::kUnion: { |
| typeshape = static_cast<const Union*>(named_decl)->typeshape; |
| if (identifier_type->nullability == types::Nullability::kNullable) |
| typeshape = PointerTypeShape(typeshape); |
| break; |
| } |
| default: { abort(); } |
| } |
| |
| identifier_type->size = typeshape.Size(); |
| *out_typeshape = typeshape; |
| return true; |
| } |
| |
| bool Library::CompileType(Type* type, TypeShape* out_typeshape) { |
| switch (type->kind) { |
| case Type::Kind::kArray: { |
| auto array_type = static_cast<ArrayType*>(type); |
| return CompileArrayType(array_type, out_typeshape); |
| } |
| |
| case Type::Kind::kVector: { |
| auto vector_type = static_cast<VectorType*>(type); |
| return CompileVectorType(vector_type, out_typeshape); |
| } |
| |
| case Type::Kind::kString: { |
| auto string_type = static_cast<StringType*>(type); |
| return CompileStringType(string_type, out_typeshape); |
| } |
| |
| case Type::Kind::kHandle: { |
| auto handle_type = static_cast<HandleType*>(type); |
| return CompileHandleType(handle_type, out_typeshape); |
| } |
| |
| case Type::Kind::kRequestHandle: { |
| auto request_type = static_cast<RequestHandleType*>(type); |
| return CompileRequestHandleType(request_type, out_typeshape); |
| } |
| |
| case Type::Kind::kPrimitive: { |
| auto primitive_type = static_cast<PrimitiveType*>(type); |
| return CompilePrimitiveType(primitive_type, out_typeshape); |
| } |
| |
| case Type::Kind::kIdentifier: { |
| auto identifier_type = static_cast<IdentifierType*>(type); |
| return CompileIdentifierType(identifier_type, out_typeshape); |
| } |
| } |
| } |
| |
| } // namespace flat |
| } // namespace fidl |
