/* * 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 "utils.h" namespace android { namespace stats_log_api_gen { /** * Inlining this method because "android-base/strings.h" is not available on * google3. */ static vector Split(const string& s, const string& delimiters) { GOOGLE_CHECK_NE(delimiters.size(), 0U); vector result; size_t base = 0; size_t found; while (true) { found = s.find_first_of(delimiters, base); result.push_back(s.substr(base, found - base)); if (found == s.npos) break; base = found + 1; } return result; } void build_non_chained_decl_map(const Atoms& atoms, std::map* decl_map) { for (AtomDeclSet::const_iterator atomIt = atoms.non_chained_decls.begin(); atomIt != atoms.non_chained_decls.end(); atomIt++) { decl_map->insert(std::make_pair((*atomIt)->code, atomIt)); } } const map& get_annotation_id_constants() { static const map* ANNOTATION_ID_CONSTANTS = new map{ {ANNOTATION_ID_IS_UID, "ANNOTATION_ID_IS_UID"}, {ANNOTATION_ID_TRUNCATE_TIMESTAMP, "ANNOTATION_ID_TRUNCATE_TIMESTAMP"}, {ANNOTATION_ID_PRIMARY_FIELD, "ANNOTATION_ID_PRIMARY_FIELD"}, {ANNOTATION_ID_PRIMARY_FIELD_FIRST_UID, "ANNOTATION_ID_PRIMARY_FIELD_FIRST_UID"}, {ANNOTATION_ID_EXCLUSIVE_STATE, "ANNOTATION_ID_EXCLUSIVE_STATE"}, {ANNOTATION_ID_TRIGGER_STATE_RESET, "ANNOTATION_ID_TRIGGER_STATE_RESET"}, {ANNOTATION_ID_STATE_NESTED, "ANNOTATION_ID_STATE_NESTED"}}; return *ANNOTATION_ID_CONSTANTS; } /** * Turn lower and camel case into upper case with underscores. */ string make_constant_name(const string& str) { string result; const int N = str.size(); bool underscore_next = false; for (int i = 0; i < N; i++) { char c = str[i]; if (c >= 'A' && c <= 'Z') { if (underscore_next) { result += '_'; underscore_next = false; } } else if (c >= 'a' && c <= 'z') { c = 'A' + c - 'a'; underscore_next = true; } else if (c == '_') { underscore_next = false; } result += c; } return result; } const char* cpp_type_name(java_type_t type) { switch (type) { case JAVA_TYPE_BOOLEAN: return "bool"; case JAVA_TYPE_INT: // Fallthrough. case JAVA_TYPE_ENUM: return "int32_t"; case JAVA_TYPE_LONG: return "int64_t"; case JAVA_TYPE_FLOAT: return "float"; case JAVA_TYPE_DOUBLE: return "double"; case JAVA_TYPE_STRING: return "char const*"; case JAVA_TYPE_BYTE_ARRAY: return "const BytesField&"; case JAVA_TYPE_BOOLEAN_ARRAY: return "const bool*"; case JAVA_TYPE_INT_ARRAY: // Fallthrough. case JAVA_TYPE_ENUM_ARRAY: return "const std::vector&"; case JAVA_TYPE_LONG_ARRAY: return "const std::vector&"; case JAVA_TYPE_FLOAT_ARRAY: return "const std::vector&"; case JAVA_TYPE_STRING_ARRAY: return "const std::vector&"; case JAVA_TYPE_DOUBLE_ARRAY: return "const std::vector&"; default: return "UNKNOWN"; } } const char* java_type_name(java_type_t type) { switch (type) { case JAVA_TYPE_BOOLEAN: return "boolean"; case JAVA_TYPE_INT: // Fallthrough. case JAVA_TYPE_ENUM: return "int"; case JAVA_TYPE_LONG: return "long"; case JAVA_TYPE_FLOAT: return "float"; case JAVA_TYPE_DOUBLE: return "double"; case JAVA_TYPE_STRING: return "java.lang.String"; case JAVA_TYPE_BYTE_ARRAY: return "byte[]"; case JAVA_TYPE_BOOLEAN_ARRAY: return "boolean[]"; case JAVA_TYPE_INT_ARRAY: // Fallthrough. case JAVA_TYPE_ENUM_ARRAY: return "int[]"; case JAVA_TYPE_LONG_ARRAY: return "long[]"; case JAVA_TYPE_FLOAT_ARRAY: return "float[]"; case JAVA_TYPE_STRING_ARRAY: return "java.lang.String[]"; case JAVA_TYPE_DOUBLE_ARRAY: return "double[]"; default: return "UNKNOWN"; } } // Does not include AttributionChain type. bool is_repeated_field(java_type_t type) { switch (type) { case JAVA_TYPE_BOOLEAN_ARRAY: case JAVA_TYPE_INT_ARRAY: case JAVA_TYPE_FLOAT_ARRAY: case JAVA_TYPE_LONG_ARRAY: case JAVA_TYPE_STRING_ARRAY: case JAVA_TYPE_ENUM_ARRAY: return true; default: return false; } } // Native // Writes namespaces for the cpp and header files, returning the number of // namespaces written. void write_namespace(FILE* out, const string& cppNamespaces) { vector cppNamespaceVec = Split(cppNamespaces, ","); for (const string& cppNamespace : cppNamespaceVec) { fprintf(out, "namespace %s {\n", cppNamespace.c_str()); } } // Writes namespace closing brackets for cpp and header files. void write_closing_namespace(FILE* out, const string& cppNamespaces) { vector cppNamespaceVec = Split(cppNamespaces, ","); for (auto it = cppNamespaceVec.rbegin(); it != cppNamespaceVec.rend(); ++it) { fprintf(out, "} // namespace %s\n", it->c_str()); } } static void write_cpp_usage(FILE* out, const string& method_name, const string& atom_code_name, const shared_ptr atom, const AtomDecl& attributionDecl) { fprintf(out, " * Usage: %s(StatsLog.%s", method_name.c_str(), atom_code_name.c_str()); for (vector::const_iterator field = atom->fields.begin(); field != atom->fields.end(); field++) { if (field->javaType == JAVA_TYPE_ATTRIBUTION_CHAIN) { for (const auto& chainField : attributionDecl.fields) { if (chainField.javaType == JAVA_TYPE_STRING) { fprintf(out, ", const std::vector<%s>& %s", cpp_type_name(chainField.javaType), chainField.name.c_str()); } else { fprintf(out, ", const %s* %s, size_t %s_length", cpp_type_name(chainField.javaType), chainField.name.c_str(), chainField.name.c_str()); } } } else { fprintf(out, ", %s %s", cpp_type_name(field->javaType), field->name.c_str()); } } fprintf(out, ");\n"); } void write_native_atom_constants(FILE* out, const Atoms& atoms, const AtomDecl& attributionDecl) { fprintf(out, "/**\n"); fprintf(out, " * Constants for atom codes.\n"); fprintf(out, " */\n"); fprintf(out, "enum {\n"); std::map atom_code_to_non_chained_decl_map; build_non_chained_decl_map(atoms, &atom_code_to_non_chained_decl_map); size_t i = 0; // Print atom constants for (AtomDeclSet::const_iterator atomIt = atoms.decls.begin(); atomIt != atoms.decls.end(); atomIt++) { string constant = make_constant_name((*atomIt)->name); fprintf(out, "\n"); fprintf(out, " /**\n"); fprintf(out, " * %s %s\n", (*atomIt)->message.c_str(), (*atomIt)->name.c_str()); write_cpp_usage(out, "stats_write", constant, *atomIt, attributionDecl); auto non_chained_decl = atom_code_to_non_chained_decl_map.find((*atomIt)->code); if (non_chained_decl != atom_code_to_non_chained_decl_map.end()) { write_cpp_usage(out, "stats_write_non_chained", constant, *non_chained_decl->second, attributionDecl); } fprintf(out, " */\n"); char const* const comma = (i == atoms.decls.size() - 1) ? "" : ","; fprintf(out, " %s = %d%s\n", constant.c_str(), (*atomIt)->code, comma); i++; } fprintf(out, "\n"); fprintf(out, "};\n"); fprintf(out, "\n"); } // Java void write_java_atom_codes(FILE* out, const Atoms& atoms) { fprintf(out, " // Constants for atom codes.\n"); std::map atom_code_to_non_chained_decl_map; build_non_chained_decl_map(atoms, &atom_code_to_non_chained_decl_map); // Print constants for the atom codes. for (AtomDeclSet::const_iterator atomIt = atoms.decls.begin(); atomIt != atoms.decls.end(); atomIt++) { string constant = make_constant_name((*atomIt)->name); fprintf(out, "\n"); fprintf(out, " /**\n"); fprintf(out, " * %s %s
\n", (*atomIt)->message.c_str(), (*atomIt)->name.c_str()); write_java_usage(out, "write", constant, **atomIt); auto non_chained_decl = atom_code_to_non_chained_decl_map.find((*atomIt)->code); if (non_chained_decl != atom_code_to_non_chained_decl_map.end()) { write_java_usage(out, "write_non_chained", constant, **(non_chained_decl->second)); } fprintf(out, " */\n"); fprintf(out, " public static final int %s = %d;\n", constant.c_str(), (*atomIt)->code); } fprintf(out, "\n"); } void write_java_enum_values(FILE* out, const Atoms& atoms) { fprintf(out, " // Constants for enum values.\n\n"); for (AtomDeclSet::const_iterator atomIt = atoms.decls.begin(); atomIt != atoms.decls.end(); atomIt++) { for (vector::const_iterator field = (*atomIt)->fields.begin(); field != (*atomIt)->fields.end(); field++) { if (field->javaType == JAVA_TYPE_ENUM) { fprintf(out, " // Values for %s.%s\n", (*atomIt)->message.c_str(), field->name.c_str()); for (map::const_iterator value = field->enumValues.begin(); value != field->enumValues.end(); value++) { fprintf(out, " public static final int %s__%s__%s = %d;\n", make_constant_name((*atomIt)->message).c_str(), make_constant_name(field->name).c_str(), make_constant_name(value->second).c_str(), value->first); } fprintf(out, "\n"); } } } } void write_java_usage(FILE* out, const string& method_name, const string& atom_code_name, const AtomDecl& atom) { fprintf(out, " * Usage: StatsLog.%s(StatsLog.%s", method_name.c_str(), atom_code_name.c_str()); for (vector::const_iterator field = atom.fields.begin(); field != atom.fields.end(); field++) { if (field->javaType == JAVA_TYPE_ATTRIBUTION_CHAIN) { fprintf(out, ", android.os.WorkSource workSource"); } else if (field->javaType == JAVA_TYPE_BYTE_ARRAY) { fprintf(out, ", byte[] %s", field->name.c_str()); } else { fprintf(out, ", %s %s", java_type_name(field->javaType), field->name.c_str()); } } fprintf(out, ");
\n"); } int write_java_non_chained_methods(FILE* out, const SignatureInfoMap& signatureInfoMap) { for (auto signatureInfoMapIt = signatureInfoMap.begin(); signatureInfoMapIt != signatureInfoMap.end(); signatureInfoMapIt++) { // Print method signature. fprintf(out, " public static void write_non_chained(int code"); vector signature = signatureInfoMapIt->first; int argIndex = 1; for (vector::const_iterator arg = signature.begin(); arg != signature.end(); arg++) { if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) { fprintf(stderr, "Non chained signatures should not have attribution chains.\n"); return 1; } else { fprintf(out, ", %s arg%d", java_type_name(*arg), argIndex); } argIndex++; } fprintf(out, ") {\n"); fprintf(out, " write(code"); argIndex = 1; for (vector::const_iterator arg = signature.begin(); arg != signature.end(); arg++) { // First two args are uid and tag of attribution chain. if (argIndex == 1) { fprintf(out, ", new int[] {arg%d}", argIndex); } else if (argIndex == 2) { fprintf(out, ", new java.lang.String[] {arg%d}", argIndex); } else { fprintf(out, ", arg%d", argIndex); } argIndex++; } fprintf(out, ");\n"); fprintf(out, " }\n"); fprintf(out, "\n"); } return 0; } int write_java_work_source_methods(FILE* out, const SignatureInfoMap& signatureInfoMap) { fprintf(out, " // WorkSource methods.\n"); for (auto signatureInfoMapIt = signatureInfoMap.begin(); signatureInfoMapIt != signatureInfoMap.end(); signatureInfoMapIt++) { vector signature = signatureInfoMapIt->first; // Determine if there is Attribution in this signature. int attributionArg = -1; int argIndexMax = 0; for (vector::const_iterator arg = signature.begin(); arg != signature.end(); arg++) { argIndexMax++; if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) { if (attributionArg > -1) { fprintf(stderr, "An atom contains multiple AttributionNode fields.\n"); fprintf(stderr, "This is not supported. Aborting WorkSource method writing.\n"); fprintf(out, "\n// Invalid for WorkSource: more than one attribution " "chain.\n"); return 1; } attributionArg = argIndexMax; } } if (attributionArg < 0) { continue; } fprintf(out, "\n"); // Method header (signature) fprintf(out, " public static void write(int code"); int argIndex = 1; for (vector::const_iterator arg = signature.begin(); arg != signature.end(); arg++) { if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) { fprintf(out, ", android.os.WorkSource ws"); } else { fprintf(out, ", %s arg%d", java_type_name(*arg), argIndex); } argIndex++; } fprintf(out, ") {\n"); // write_non_chained() component. TODO: Remove when flat uids are no longer // needed. fprintf(out, " for (int i = 0; i < ws.size(); ++i) {\n"); fprintf(out, " write_non_chained(code"); for (int argIndex = 1; argIndex <= argIndexMax; argIndex++) { if (argIndex == attributionArg) { fprintf(out, ", ws.getUid(i), ws.getPackageName(i)"); } else { fprintf(out, ", arg%d", argIndex); } } fprintf(out, ");\n"); fprintf(out, " }\n"); // close for-loop // write() component. fprintf(out, " java.util.List workChains = " "ws.getWorkChains();\n"); fprintf(out, " if (workChains != null) {\n"); fprintf(out, " for (android.os.WorkSource.WorkChain wc : workChains) " "{\n"); fprintf(out, " write(code"); for (int argIndex = 1; argIndex <= argIndexMax; argIndex++) { if (argIndex == attributionArg) { fprintf(out, ", wc.getUids(), wc.getTags()"); } else { fprintf(out, ", arg%d", argIndex); } } fprintf(out, ");\n"); fprintf(out, " }\n"); // close for-loop fprintf(out, " }\n"); // close if fprintf(out, " }\n"); // close method } return 0; } } // namespace stats_log_api_gen } // namespace android