| /* |
| * Copyright (C) 2015, 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 "generate_cpp.h" |
| #include "parse_helpers.h" |
| |
| #include <cctype> |
| #include <cstring> |
| #include <memory> |
| #include <random> |
| #include <string> |
| |
| #include <base/stringprintf.h> |
| #include <base/strings.h> |
| |
| #include "aidl_language.h" |
| #include "ast_cpp.h" |
| #include "code_writer.h" |
| #include "logging.h" |
| |
| using android::base::StringPrintf; |
| using android::base::Join; |
| using std::string; |
| using std::unique_ptr; |
| using std::vector; |
| |
| namespace android { |
| namespace aidl { |
| namespace cpp { |
| namespace internals { |
| namespace { |
| const char kStatusOkOrBreakCheck[] = "if (status != android::OK) { break; }"; |
| const char kReturnVarName[] = "_aidl_return"; |
| const char kAndroidStatusLiteral[] = "android::status_t"; |
| const char kIBinderHeader[] = "binder/IBinder.h"; |
| const char kIInterfaceHeader[] = "binder/IInterface.h"; |
| const char kParcelHeader[] = "binder/Parcel.h"; |
| |
| string UpperCase(const std::string& s) { |
| string result = s; |
| for (char& c : result) |
| c = toupper(c); |
| return result; |
| } |
| |
| string BuildVarName(const AidlArgument& a) { |
| string prefix = "out_"; |
| if (a.GetDirection() & AidlArgument::IN_DIR) { |
| prefix = "in_"; |
| } |
| return prefix + a.GetName(); |
| } |
| |
| vector<string> BuildArgList(const TypeNamespace& types, |
| const AidlMethod& method, |
| bool for_declaration) { |
| // Build up the argument list for the server method call. |
| vector<string> method_arguments; |
| for (const unique_ptr<AidlArgument>& a : method.GetArguments()) { |
| string literal; |
| if (for_declaration) { |
| // Method declarations need types, pointers to out params, and variable |
| // names that match the .aidl specification. |
| const Type* type = types.Find(a->GetType().GetName()); |
| literal = StringPrintf( |
| "%s%s %s", type->CppType().c_str(), |
| (a->IsOut()) ? "*" : "", |
| a->GetName().c_str()); |
| } else { |
| if (a->IsOut()) { literal = "&"; } |
| literal += BuildVarName(*a); |
| } |
| method_arguments.push_back(literal); |
| } |
| |
| const Type* return_type = types.Find(method.GetType().GetName()); |
| if (return_type != types.VoidType()) { |
| if (for_declaration) { |
| method_arguments.push_back( |
| StringPrintf("%s* %s", return_type->CppType().c_str(), |
| kReturnVarName)); |
| } else { |
| method_arguments.push_back(string{"&"} + kReturnVarName); |
| } |
| } |
| |
| return method_arguments; |
| } |
| |
| unique_ptr<Declaration> BuildMethodDecl(const AidlMethod& method, |
| const TypeNamespace& types, |
| bool for_interface) { |
| uint32_t modifiers = 0; |
| if (for_interface) { |
| modifiers |= MethodDecl::IS_VIRTUAL; |
| modifiers |= MethodDecl::IS_PURE_VIRTUAL; |
| } else { |
| modifiers |= MethodDecl::IS_OVERRIDE; |
| } |
| |
| return unique_ptr<Declaration>{ |
| new MethodDecl{kAndroidStatusLiteral, |
| method.GetName(), |
| BuildArgList(types, method, true /* for method decl */), |
| modifiers}}; |
| } |
| |
| unique_ptr<CppNamespace> NestInNamespaces(unique_ptr<Declaration> decl) { |
| using N = CppNamespace; |
| using NPtr = unique_ptr<N>; |
| return NPtr{new N{"android", NPtr{new N{"generated", std::move(decl)}}}}; |
| } |
| |
| bool DeclareLocalVariable(const TypeNamespace& types, const AidlArgument& a, |
| StatementBlock* b) { |
| const Type* cpp_type = types.Find(a.GetType().GetName()); |
| if (!cpp_type) { return false; } |
| |
| b->AddLiteral(cpp_type->CppType() + " " + BuildVarName(a)); |
| return true; |
| } |
| |
| } // namespace |
| |
| enum class ClassNames { BASE, CLIENT, SERVER, INTERFACE }; |
| |
| string ClassName(const AidlInterface& interface, ClassNames type) { |
| string c_name = interface.GetName(); |
| |
| if (c_name.length() >= 2 && c_name[0] == 'I' && isupper(c_name[1])) |
| c_name = c_name.substr(1); |
| |
| switch (type) { |
| case ClassNames::CLIENT: |
| c_name = "Bp" + c_name; |
| break; |
| case ClassNames::SERVER: |
| c_name = "Bn" + c_name; |
| break; |
| case ClassNames::INTERFACE: |
| c_name = "I" + c_name; |
| break; |
| case ClassNames::BASE: |
| break; |
| } |
| return c_name; |
| } |
| |
| unique_ptr<Document> BuildClientSource(const TypeNamespace& types, |
| const AidlInterface& parsed_doc) { |
| unique_ptr<CppNamespace> ns{new CppNamespace{"android"}}; |
| return unique_ptr<Document>{new CppSource{ {}, std::move(ns)}}; |
| } |
| |
| namespace { |
| |
| bool HandleServerTransaction(const TypeNamespace& types, |
| const AidlMethod& method, |
| StatementBlock* b) { |
| // Declare all the parameters now. In the common case, we expect no errors |
| // in serialization. |
| for (const unique_ptr<AidlArgument>& a : method.GetArguments()) { |
| if (!DeclareLocalVariable(types, *a, b)) { return false; } |
| } |
| |
| // Declare a variable to hold the return value. |
| const Type* return_type = types.Find(method.GetType().GetName()); |
| if (return_type != types.VoidType()) { |
| b->AddLiteral(StringPrintf( |
| "%s %s", return_type->CppType().c_str(), kReturnVarName)); |
| } |
| |
| // Declare the status variable |
| b->AddLiteral(StringPrintf("%s status", kAndroidStatusLiteral)); |
| |
| // Deserialize each "in" parameter to the transaction. |
| for (const AidlArgument* a : method.GetInArguments()) { |
| // Deserialization looks roughly like: |
| // status = data.ReadInt32(&in_param_name); |
| // if (status != android::OK) { break; } |
| const Type* type = types.Find(a->GetType().GetName()); |
| b->AddStatement(new Assignment{ |
| "status", |
| new MethodCall{"data." + type->ReadFromParcelMethod(), |
| "&" + BuildVarName(*a)}}); |
| b->AddLiteral(kStatusOkOrBreakCheck, false /* no semicolon */); |
| } |
| |
| // Call the actual method. This is implemented by the subclass. |
| b->AddStatement(new Assignment{ |
| "status", new MethodCall{ |
| method.GetName(), |
| new ArgList{BuildArgList(types, method, |
| false /* not for method decl */)}}}); |
| b->AddLiteral(kStatusOkOrBreakCheck, false /* no semicolon */); |
| |
| // Write each out parameter to the reply parcel. |
| for (const AidlArgument* a : method.GetOutArguments()) { |
| // Serialization looks roughly like: |
| // status = data.WriteInt32(out_param_name); |
| // if (status != android::OK) { break; } |
| const Type* type = types.Find(a->GetType().GetName()); |
| b->AddStatement(new Assignment{ |
| "status", |
| new MethodCall{"reply->" + type->WriteToParcelMethod(), |
| BuildVarName(*a)}}); |
| b->AddLiteral(kStatusOkOrBreakCheck, false /* no semicolon */); |
| } |
| |
| return true; |
| } |
| |
| } // namespace |
| |
| unique_ptr<Document> BuildServerSource(const TypeNamespace& types, |
| const AidlInterface& parsed_doc) { |
| const string bn_name = ClassName(parsed_doc, ClassNames::SERVER); |
| vector<string> include_list{bn_name + ".h", kParcelHeader}; |
| unique_ptr<MethodImpl> on_transact{new MethodImpl{ |
| kAndroidStatusLiteral, bn_name, "onTransact", |
| {"uint32_t code", |
| "const android::Parcel& data", |
| "android::Parcel* reply", |
| "uint32_t flags"} |
| }}; |
| |
| // Add the all important switch statement, but retain a pointer to it. |
| SwitchStatement* s = new SwitchStatement{"code"}; |
| on_transact->AddStatement(unique_ptr<AstNode>{s}); |
| |
| // The switch statement has a case statement for each transaction code. |
| for (const auto& method : parsed_doc.GetMethods()) { |
| StatementBlock* b = s->AddCase("Call::" + UpperCase(method->GetName())); |
| if (!b) { return nullptr; } |
| |
| if (!HandleServerTransaction(types, *method, b)) { return nullptr; } |
| } |
| |
| // The switch statement has a default case which defers to the super class. |
| // The superclass handles a few pre-defined transactions. |
| StatementBlock* b = s->AddCase(""); |
| b->AddLiteral( |
| "status = android::BBinder::onTransact(code, data, reply, flags)"); |
| |
| // Finally, the server's onTransact method just returns a status code. |
| on_transact->AddStatement(unique_ptr<AstNode>{ |
| new LiteralStatement{"return status"}}); |
| |
| return unique_ptr<Document>{new CppSource{ |
| include_list, |
| NestInNamespaces(std::move(on_transact))}}; |
| } |
| |
| unique_ptr<Document> BuildInterfaceSource(const TypeNamespace& types, |
| const AidlInterface& parsed_doc) { |
| const string i_name = ClassName(parsed_doc, ClassNames::INTERFACE); |
| const string bp_name = ClassName(parsed_doc, ClassNames::CLIENT); |
| vector<string> include_list{i_name + ".h", bp_name + ".h"}; |
| |
| string fq_name = i_name; |
| if (!parsed_doc.GetPackage().empty()) { |
| fq_name = StringPrintf("%s.%s", parsed_doc.GetPackage().c_str(), i_name.c_str()); |
| } |
| |
| unique_ptr<ConstructorDecl> meta_if{new ConstructorDecl{ |
| "IMPLEMENT_META_INTERFACE", |
| {ClassName(parsed_doc, ClassNames::BASE), '"' + fq_name + '"'} |
| }}; |
| |
| return unique_ptr<Document>{new CppSource{ |
| include_list, |
| NestInNamespaces(std::move(meta_if))}}; |
| } |
| |
| unique_ptr<Document> BuildClientHeader(const TypeNamespace& types, |
| const AidlInterface& parsed_doc) { |
| const string i_name = ClassName(parsed_doc, ClassNames::INTERFACE); |
| const string bp_name = ClassName(parsed_doc, ClassNames::CLIENT); |
| |
| unique_ptr<ConstructorDecl> constructor{new ConstructorDecl(bp_name, {})}; |
| unique_ptr<ConstructorDecl> destructor{ |
| new ConstructorDecl("~" + bp_name, {})}; |
| |
| vector<unique_ptr<Declaration>> publics; |
| publics.push_back(std::move(constructor)); |
| publics.push_back(std::move(destructor)); |
| |
| for (const auto& item : parsed_doc.GetMethods()) { |
| publics.push_back(BuildMethodDecl(*item, types, false)); |
| } |
| |
| unique_ptr<ClassDecl> bp_class{ |
| new ClassDecl{bp_name, |
| "public android::BpInterface<" + i_name + ">", |
| std::move(publics), |
| {} |
| }}; |
| |
| return unique_ptr<Document>{new CppHeader{ |
| bp_name + "_H", |
| {kIBinderHeader, |
| kIInterfaceHeader, |
| "utils/Errors.h", |
| i_name + ".h"}, |
| NestInNamespaces(std::move(bp_class))}}; |
| } |
| |
| unique_ptr<Document> BuildServerHeader(const TypeNamespace& types, |
| const AidlInterface& parsed_doc) { |
| const string i_name = ClassName(parsed_doc, ClassNames::INTERFACE); |
| const string bn_name = ClassName(parsed_doc, ClassNames::SERVER); |
| |
| unique_ptr<Declaration> on_transact{ |
| new MethodDecl(kAndroidStatusLiteral, "onTransact", |
| { "uint32_t code", |
| "const android::Parcel& data", |
| "android::Parcel* reply", |
| "uint32_t flags = 0" |
| })}; |
| |
| std::vector<unique_ptr<Declaration>> publics; |
| publics.push_back(std::move(on_transact)); |
| |
| unique_ptr<ClassDecl> bn_class{ |
| new ClassDecl{bn_name, |
| "public android::BnInterface<" + i_name + ">", |
| std::move(publics), |
| {} |
| }}; |
| |
| return unique_ptr<Document>{new CppHeader{ |
| bn_name + "_H", |
| {"binder/IInterface.h", |
| i_name + ".h"}, |
| NestInNamespaces(std::move(bn_class))}}; |
| } |
| |
| unique_ptr<Document> BuildInterfaceHeader(const TypeNamespace& types, |
| const AidlInterface& parsed_doc) { |
| unique_ptr<ClassDecl> if_class{ |
| new ClassDecl{ClassName(parsed_doc, ClassNames::INTERFACE), |
| "public android::IInterface"}}; |
| if_class->AddPublic(unique_ptr<Declaration>{ |
| new ConstructorDecl{ |
| "DECLARE_META_INTERFACE", |
| {ClassName(parsed_doc, ClassNames::BASE)}}}); |
| |
| unique_ptr<Enum> call_enum{new Enum{"Call"}}; |
| for (const auto& method : parsed_doc.GetMethods()) { |
| if_class->AddPublic(BuildMethodDecl(*method, types, true)); |
| call_enum->AddValue( |
| UpperCase(method->GetName()), |
| StringPrintf("android::IBinder::FIRST_CALL_TRANSACTION + %d", |
| method->GetId())); |
| } |
| if_class->AddPublic(std::move(call_enum)); |
| |
| return unique_ptr<Document>{new CppSource{ |
| {kIBinderHeader, |
| kIInterfaceHeader}, |
| NestInNamespaces(std::move(if_class))}}; |
| } |
| |
| bool GenerateCppForFile(const std::string& name, unique_ptr<Document> doc) { |
| if (!doc) { |
| return false; |
| } |
| unique_ptr<CodeWriter> writer = GetFileWriter(name); |
| doc->Write(writer.get()); |
| return true; |
| } |
| |
| } // namespace internals |
| |
| using namespace internals; |
| |
| bool GenerateCpp(const CppOptions& options, |
| const TypeNamespace& types, |
| const AidlInterface& parsed_doc) { |
| bool success = true; |
| |
| success &= GenerateCppForFile(options.ClientCppFileName(), |
| BuildClientSource(types, parsed_doc)); |
| success &= GenerateCppForFile(options.ClientHeaderFileName(), |
| BuildClientHeader(types, parsed_doc)); |
| success &= GenerateCppForFile(options.ServerCppFileName(), |
| BuildServerSource(types, parsed_doc)); |
| success &= GenerateCppForFile(options.ServerHeaderFileName(), |
| BuildServerHeader(types, parsed_doc)); |
| success &= GenerateCppForFile(options.InterfaceCppFileName(), |
| BuildInterfaceSource(types, parsed_doc)); |
| success &= GenerateCppForFile(options.InterfaceHeaderFileName(), |
| BuildInterfaceHeader(types, parsed_doc)); |
| |
| return success; |
| } |
| |
| } // namespace cpp |
| } // namespace aidl |
| } // namespace android |