Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Use StatsEvent in Java autogenerated code"

Browse Source
This commit is contained in:
Treehugger Robot
2020-01-10 22:42:45 +00:00
committed by Gerrit Code Review
parent c7483ff8bf ef19b08b05
commit 94e980f83b
8 changed files with 1320 additions and 738 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
tools/stats_log_api_gen/Android.bp
View File

@@ -21,9 +21,13 @@ cc_binary_host {
name: "stats-log-api-gen",
srcs: [
"Collation.cpp",
"java_writer.cpp",
"java_writer_q.cpp",
"main.cpp",
"utils.cpp",
],
cflags: [
"-DSTATS_SCHEMA_LEGACY",
"-Wall",
"-Werror",
],

286
tools/stats_log_api_gen/java_writer.cpp Normal file
View File

@@ -0,0 +1,286 @@
/*
* 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 "java_writer.h"
#include "java_writer_q.h"
#include "utils.h"
namespace android {
namespace stats_log_api_gen {
static int write_java_q_logger_class(
FILE* out,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const AtomDecl &attributionDecl,
const string& moduleName
) {
fprintf(out, "\n");
fprintf(out, " // Write logging helper methods for statsd in Q and earlier.\n");
fprintf(out, " private static class QLogger {\n");
write_java_q_logging_constants(out, " ");
// Print Q write methods.
fprintf(out, "\n");
fprintf(out, " // Write methods.\n");
write_java_methods_q_schema(
out, signatures_to_modules, attributionDecl, moduleName, " ");
fprintf(out, " }\n");
return 0;
}
static int write_java_methods(
FILE* out,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const AtomDecl &attributionDecl,
const string& moduleName
) {
for (auto signature_to_modules_it = signatures_to_modules.begin();
signature_to_modules_it != signatures_to_modules.end(); signature_to_modules_it++) {
// Skip if this signature is not needed for the module.
if (!signature_needed_for_module(signature_to_modules_it->second, moduleName)) {
continue;
}
// Print method signature.
if (DEFAULT_MODULE_NAME == moduleName) {
fprintf(out, " /** @hide */\n");
}
fprintf(out, " public static void write(int code");
vector<java_type_t> signature = signature_to_modules_it->first;
int argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) {
for (auto chainField : attributionDecl.fields) {
fprintf(out, ", %s[] %s",
java_type_name(chainField.javaType), chainField.name.c_str());
}
} else if (*arg == JAVA_TYPE_KEY_VALUE_PAIR) {
fprintf(out, ", SparseArray<Object> valueMap");
} else {
fprintf(out, ", %s arg%d", java_type_name(*arg), argIndex);
}
argIndex++;
}
fprintf(out, ") {\n");
// Print method body.
string indent("");
if (DEFAULT_MODULE_NAME != moduleName) {
fprintf(out, " if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) {\n");
indent = " ";
}
// Start StatsEvent.Builder.
fprintf(out, "%s final StatsEvent.Builder builder = StatsEvent.newBuilder();\n",
indent.c_str());
// Write atom code.
fprintf(out, "%s builder.setAtomId(code);\n", indent.c_str());
// Write the args.
argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
switch (*arg) {
case JAVA_TYPE_BOOLEAN:
fprintf(out, "%s builder.writeBoolean(arg%d);\n", indent.c_str(), argIndex);
break;
case JAVA_TYPE_INT:
case JAVA_TYPE_ENUM:
fprintf(out, "%s builder.writeInt(arg%d);\n", indent.c_str(), argIndex);
break;
case JAVA_TYPE_FLOAT:
fprintf(out, "%s builder.writeFloat(arg%d);\n", indent.c_str(), argIndex);
break;
case JAVA_TYPE_LONG:
fprintf(out, "%s builder.writeLong(arg%d);\n", indent.c_str(), argIndex);
break;
case JAVA_TYPE_STRING:
fprintf(out, "%s builder.writeString(arg%d);\n", indent.c_str(), argIndex);
break;
case JAVA_TYPE_BYTE_ARRAY:
fprintf(out, "%s builder.writeByteArray(arg%d);\n",
indent.c_str(), argIndex);
break;
case JAVA_TYPE_ATTRIBUTION_CHAIN:
{
const char* uidName = attributionDecl.fields.front().name.c_str();
const char* tagName = attributionDecl.fields.back().name.c_str();
fprintf(out, "%s builder.writeAttributionChain(%s, %s);\n",
indent.c_str(), uidName, tagName);
break;
}
case JAVA_TYPE_KEY_VALUE_PAIR:
fprintf(out, "\n");
fprintf(out,
"%s // Write KeyValuePairs.\n", indent.c_str());
fprintf(out,
"%s final int count = valueMap.size();\n", indent.c_str());
fprintf(out,
"%s final SparseIntArray intMap = new SparseIntArray();\n",
indent.c_str());
fprintf(out,
"%s final SparseLongArray longMap = new SparseLongArray();\n",
indent.c_str());
fprintf(out,
"%s final SparseArray<String> stringMap = new SparseArray<>();\n",
indent.c_str());
fprintf(out,
"%s final SparseArray<Float> floatMap = new SparseArray<>();\n",
indent.c_str());
fprintf(out,
"%s for (int i = 0; i < count; i++) {\n", indent.c_str());
fprintf(out,
"%s final int key = valueMap.keyAt(i);\n", indent.c_str());
fprintf(out,
"%s final Object value = valueMap.valueAt(i);\n",
indent.c_str());
fprintf(out,
"%s if (value instanceof Integer) {\n", indent.c_str());
fprintf(out,
"%s intMap.put(key, (Integer) value);\n", indent.c_str());
fprintf(out,
"%s } else if (value instanceof Long) {\n", indent.c_str());
fprintf(out,
"%s longMap.put(key, (Long) value);\n", indent.c_str());
fprintf(out,
"%s } else if (value instanceof String) {\n", indent.c_str());
fprintf(out,
"%s stringMap.put(key, (String) value);\n", indent.c_str());
fprintf(out,
"%s } else if (value instanceof Float) {\n", indent.c_str());
fprintf(out,
"%s floatMap.put(key, (Float) value);\n", indent.c_str());
fprintf(out,
"%s }\n", indent.c_str());
fprintf(out,
"%s }\n", indent.c_str());
fprintf(out,
"%s builder.writeKeyValuePairs("
"intMap, longMap, stringMap, floatMap);\n", indent.c_str());
break;
default:
// Unsupported types: OBJECT, DOUBLE.
fprintf(stderr, "Encountered unsupported type.");
return 1;
}
argIndex++;
}
fprintf(out, "\n");
fprintf(out, "%s StatsLog.write(builder.build());\n", indent.c_str());
// Add support for writing using Q schema if this is not the default module.
if (DEFAULT_MODULE_NAME != moduleName) {
fprintf(out, " } else {\n");
fprintf(out, " QLogger.write(code");
argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) {
const char* uidName = attributionDecl.fields.front().name.c_str();
const char* tagName = attributionDecl.fields.back().name.c_str();
fprintf(out, ", %s, %s", uidName, tagName);
} else if (*arg == JAVA_TYPE_KEY_VALUE_PAIR) {
// Module logging does not yet support key value pair.
fprintf(stderr, "Module logging does not yet support key value pair.\n");
return 1;
} else {
fprintf(out, ", arg%d", argIndex);
}
argIndex++;
}
fprintf(out, ");\n");
fprintf(out, " }\n"); // if
}
fprintf(out, " }\n"); // method
fprintf(out, "\n");
}
return 0;
}
int write_stats_log_java(FILE* out, const Atoms& atoms, const AtomDecl &attributionDecl,
const string& moduleName, const string& javaClass,
const string& javaPackage) {
// Print prelude
fprintf(out, "// This file is autogenerated\n");
fprintf(out, "\n");
fprintf(out, "package %s;\n", javaPackage.c_str());
fprintf(out, "\n");
fprintf(out, "\n");
fprintf(out, "import android.os.Build;\n");
fprintf(out, "import android.os.SystemClock;\n");
if (DEFAULT_MODULE_NAME == moduleName) {
// Mainline modules don't use WorkSource logging.
fprintf(out, "import android.os.WorkSource;\n");
// SparseArray is used for writing KeyValuePairs; not supported for Mainline modules.
fprintf(out, "import android.util.SparseArray;\n");
fprintf(out, "import android.util.SparseIntArray;\n");
fprintf(out, "import android.util.SparseLongArray;\n");
}
fprintf(out, "import android.util.StatsEvent;\n");
fprintf(out, "import android.util.StatsLog;\n");
if (DEFAULT_MODULE_NAME == moduleName) {
// List is used for WorkSource writing. Only needed for default module.
fprintf(out, "\n");
fprintf(out, "import java.util.ArrayList;\n");
}
fprintf(out, "\n");
fprintf(out, "\n");
fprintf(out, "/**\n");
fprintf(out, " * Utility class for logging statistics events.\n");
if (DEFAULT_MODULE_NAME == moduleName) {
fprintf(out, " * @hide\n");
}
fprintf(out, " */\n");
fprintf(out, "public class %s {\n", javaClass.c_str());
write_java_atom_codes(out, atoms, moduleName);
write_java_enum_values(out, atoms, moduleName);
int errors = 0;
// Print write methods.
fprintf(out, " // Write methods\n");
errors += write_java_methods(out, atoms.signatures_to_modules, attributionDecl, moduleName);
errors += write_java_non_chained_methods(
out, atoms.non_chained_signatures_to_modules, moduleName);
if (DEFAULT_MODULE_NAME == moduleName) {
errors += write_java_work_source_methods(out, atoms.signatures_to_modules, moduleName);
} else {
errors += write_java_q_logger_class(
out, atoms.signatures_to_modules, attributionDecl, moduleName);
}
fprintf(out, "}\n");
return errors;
}
} // namespace stats_log_api_gen
} // namespace android

40
tools/stats_log_api_gen/java_writer.h Normal file
View File

@@ -0,0 +1,40 @@
/*
* 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.
*/
#pragma once
#include "Collation.h"
#include <map>
#include <set>
#include <vector>
#include <stdio.h>
#include <string.h>
namespace android {
namespace stats_log_api_gen {
using namespace std;
int write_stats_log_java(FILE* out, const Atoms& atoms, const AtomDecl &attributionDecl,
const string& moduleName, const string& javaClass,
const string& javaPackage
);
} // namespace stats_log_api_gen
} // namespace android

470
tools/stats_log_api_gen/java_writer_q.cpp Normal file
View File

@@ -0,0 +1,470 @@
/*
* 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 "java_writer_q.h"
#include "utils.h"
namespace android {
namespace stats_log_api_gen {
void write_java_q_logging_constants(FILE* out, const string& indent) {
fprintf(out, "%s// Payload limits.\n", indent.c_str());
fprintf(out, "%sprivate static final int LOGGER_ENTRY_MAX_PAYLOAD = 4068;\n", indent.c_str());
fprintf(out,
"%sprivate static final int MAX_EVENT_PAYLOAD = LOGGER_ENTRY_MAX_PAYLOAD - 4;\n",
indent.c_str());
// Value types. Must match with EventLog.java and log.h.
fprintf(out, "\n");
fprintf(out, "%s// Value types.\n", indent.c_str());
fprintf(out, "%sprivate static final byte INT_TYPE = 0;\n", indent.c_str());
fprintf(out, "%sprivate static final byte LONG_TYPE = 1;\n", indent.c_str());
fprintf(out, "%sprivate static final byte STRING_TYPE = 2;\n", indent.c_str());
fprintf(out, "%sprivate static final byte LIST_TYPE = 3;\n", indent.c_str());
fprintf(out, "%sprivate static final byte FLOAT_TYPE = 4;\n", indent.c_str());
// Size of each value type.
// Booleans, ints, floats, and enums take 5 bytes, 1 for the type and 4 for the value.
fprintf(out, "\n");
fprintf(out, "%s// Size of each value type.\n", indent.c_str());
fprintf(out, "%sprivate static final int INT_TYPE_SIZE = 5;\n", indent.c_str());
fprintf(out, "%sprivate static final int FLOAT_TYPE_SIZE = 5;\n", indent.c_str());
// Longs take 9 bytes, 1 for the type and 8 for the value.
fprintf(out, "%sprivate static final int LONG_TYPE_SIZE = 9;\n", indent.c_str());
// Strings take 5 metadata bytes: 1 byte is for the type, 4 are for the length.
fprintf(out, "%sprivate static final int STRING_TYPE_OVERHEAD = 5;\n", indent.c_str());
fprintf(out, "%sprivate static final int LIST_TYPE_OVERHEAD = 2;\n", indent.c_str());
}
int write_java_methods_q_schema(
FILE* out,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const AtomDecl &attributionDecl,
const string& moduleName,
const string& indent) {
int requiredHelpers = 0;
for (auto signature_to_modules_it = signatures_to_modules.begin();
signature_to_modules_it != signatures_to_modules.end(); signature_to_modules_it++) {
// Skip if this signature is not needed for the module.
if (!signature_needed_for_module(signature_to_modules_it->second, moduleName)) {
continue;
}
// Print method signature.
vector<java_type_t> signature = signature_to_modules_it->first;
fprintf(out, "%spublic static void write(int code", indent.c_str());
int argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) {
for (auto chainField : attributionDecl.fields) {
fprintf(out, ", %s[] %s",
java_type_name(chainField.javaType), chainField.name.c_str());
}
} else if (*arg == JAVA_TYPE_KEY_VALUE_PAIR) {
// Module logging does not yet support key value pair.
fprintf(stderr, "Module logging does not yet support key value pair.\n");
continue;
} else {
fprintf(out, ", %s arg%d", java_type_name(*arg), argIndex);
}
argIndex++;
}
fprintf(out, ") {\n");
// Calculate the size of the buffer.
fprintf(out, "%s // Initial overhead of the list, timestamp, and atom tag.\n",
indent.c_str());
fprintf(out,
"%s int needed = LIST_TYPE_OVERHEAD + LONG_TYPE_SIZE + INT_TYPE_SIZE;\n",
indent.c_str());
argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
switch (*arg) {
case JAVA_TYPE_BOOLEAN:
case JAVA_TYPE_INT:
case JAVA_TYPE_FLOAT:
case JAVA_TYPE_ENUM:
fprintf(out, "%s needed += INT_TYPE_SIZE;\n", indent.c_str());
break;
case JAVA_TYPE_LONG:
// Longs take 9 bytes, 1 for the type and 8 for the value.
fprintf(out, "%s needed += LONG_TYPE_SIZE;\n", indent.c_str());
break;
case JAVA_TYPE_STRING:
// Strings take 5 metadata bytes + length of byte encoded string.
fprintf(out, "%s if (arg%d == null) {\n", indent.c_str(), argIndex);
fprintf(out, "%s arg%d = \"\";\n", indent.c_str(), argIndex);
fprintf(out, "%s }\n", indent.c_str());
fprintf(out,
"%s byte[] arg%dBytes = "
"arg%d.getBytes(java.nio.charset.StandardCharsets.UTF_8);\n",
indent.c_str(), argIndex, argIndex);
fprintf(out, "%s needed += STRING_TYPE_OVERHEAD + arg%dBytes.length;\n",
indent.c_str(), argIndex);
break;
case JAVA_TYPE_BYTE_ARRAY:
// Byte arrays take 5 metadata bytes + length of byte array.
fprintf(out, "%s if (arg%d == null) {\n", indent.c_str(), argIndex);
fprintf(out, "%s arg%d = new byte[0];\n", indent.c_str(), argIndex);
fprintf(out, "%s }\n", indent.c_str());
fprintf(out, "%s needed += STRING_TYPE_OVERHEAD + arg%d.length;\n",
indent.c_str(), argIndex);
break;
case JAVA_TYPE_ATTRIBUTION_CHAIN:
{
const char* uidName = attributionDecl.fields.front().name.c_str();
const char* tagName = attributionDecl.fields.back().name.c_str();
// Null checks on the params.
fprintf(out, "%s if (%s == null) {\n", indent.c_str(), uidName);
fprintf(out, "%s %s = new %s[0];\n", indent.c_str(), uidName,
java_type_name(attributionDecl.fields.front().javaType));
fprintf(out, "%s }\n", indent.c_str());
fprintf(out, "%s if (%s == null) {\n", indent.c_str(), tagName);
fprintf(out, "%s %s = new %s[0];\n", indent.c_str(), tagName,
java_type_name(attributionDecl.fields.back().javaType));
fprintf(out, "%s }\n", indent.c_str());
// First check that the lengths of the uid and tag arrays are the same.
fprintf(out, "%s if (%s.length != %s.length) {\n",
indent.c_str(), uidName, tagName);
fprintf(out, "%s return;\n", indent.c_str());
fprintf(out, "%s }\n", indent.c_str());
fprintf(out, "%s int attrSize = LIST_TYPE_OVERHEAD;\n", indent.c_str());
fprintf(out, "%s for (int i = 0; i < %s.length; i++) {\n",
indent.c_str(), tagName);
fprintf(out, "%s String str%d = (%s[i] == null) ? \"\" : %s[i];\n",
indent.c_str(), argIndex, tagName, tagName);
fprintf(out,
"%s int str%dlen = "
"str%d.getBytes(java.nio.charset.StandardCharsets.UTF_8).length;\n",
indent.c_str(), argIndex, argIndex);
fprintf(out,
"%s attrSize += "
"LIST_TYPE_OVERHEAD + INT_TYPE_SIZE + STRING_TYPE_OVERHEAD + str%dlen;\n",
indent.c_str(), argIndex);
fprintf(out, "%s }\n", indent.c_str());
fprintf(out, "%s needed += attrSize;\n", indent.c_str());
break;
}
default:
// Unsupported types: OBJECT, DOUBLE, KEY_VALUE_PAIR.
fprintf(stderr, "Module logging does not yet support key value pair.\n");
return 1;
}
argIndex++;
}
// Now we have the size that is needed. Check for overflow and return if needed.
fprintf(out, "%s if (needed > MAX_EVENT_PAYLOAD) {\n", indent.c_str());
fprintf(out, "%s return;\n", indent.c_str());
fprintf(out, "%s }\n", indent.c_str());
// Create new buffer, and associated data types.
fprintf(out, "%s byte[] buff = new byte[needed];\n", indent.c_str());
fprintf(out, "%s int pos = 0;\n", indent.c_str());
// Initialize the buffer with list data type.
fprintf(out, "%s buff[pos] = LIST_TYPE;\n", indent.c_str());
fprintf(out, "%s buff[pos + 1] = %zu;\n", indent.c_str(), signature.size() + 2);
fprintf(out, "%s pos += LIST_TYPE_OVERHEAD;\n", indent.c_str());
// Write timestamp.
fprintf(out, "%s long elapsedRealtime = SystemClock.elapsedRealtimeNanos();\n", indent.c_str());
fprintf(out, "%s buff[pos] = LONG_TYPE;\n", indent.c_str());
fprintf(out, "%s copyLong(buff, pos + 1, elapsedRealtime);\n", indent.c_str());
fprintf(out, "%s pos += LONG_TYPE_SIZE;\n", indent.c_str());
// Write atom code.
fprintf(out, "%s buff[pos] = INT_TYPE;\n", indent.c_str());
fprintf(out, "%s copyInt(buff, pos + 1, code);\n", indent.c_str());
fprintf(out, "%s pos += INT_TYPE_SIZE;\n", indent.c_str());
// Write the args.
argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
switch (*arg) {
case JAVA_TYPE_BOOLEAN:
fprintf(out, "%s buff[pos] = INT_TYPE;\n", indent.c_str());
fprintf(out, "%s copyInt(buff, pos + 1, arg%d? 1 : 0);\n",
indent.c_str(), argIndex);
fprintf(out, "%s pos += INT_TYPE_SIZE;\n", indent.c_str());
break;
case JAVA_TYPE_INT:
case JAVA_TYPE_ENUM:
fprintf(out, "%s buff[pos] = INT_TYPE;\n", indent.c_str());
fprintf(out, "%s copyInt(buff, pos + 1, arg%d);\n", indent.c_str(), argIndex);
fprintf(out, "%s pos += INT_TYPE_SIZE;\n", indent.c_str());
break;
case JAVA_TYPE_FLOAT:
requiredHelpers |= JAVA_MODULE_REQUIRES_FLOAT;
fprintf(out, "%s buff[pos] = FLOAT_TYPE;\n", indent.c_str());
fprintf(out, "%s copyFloat(buff, pos + 1, arg%d);\n", indent.c_str(), argIndex);
fprintf(out, "%s pos += FLOAT_TYPE_SIZE;\n", indent.c_str());
break;
case JAVA_TYPE_LONG:
fprintf(out, "%s buff[pos] = LONG_TYPE;\n", indent.c_str());
fprintf(out, "%s copyLong(buff, pos + 1, arg%d);\n", indent.c_str(), argIndex);
fprintf(out, "%s pos += LONG_TYPE_SIZE;\n", indent.c_str());
break;
case JAVA_TYPE_STRING:
fprintf(out, "%s buff[pos] = STRING_TYPE;\n", indent.c_str());
fprintf(out, "%s copyInt(buff, pos + 1, arg%dBytes.length);\n",
indent.c_str(), argIndex);
fprintf(out, "%s System.arraycopy("
"arg%dBytes, 0, buff, pos + STRING_TYPE_OVERHEAD, arg%dBytes.length);\n",
indent.c_str(), argIndex, argIndex);
fprintf(out, "%s pos += STRING_TYPE_OVERHEAD + arg%dBytes.length;\n",
indent.c_str(), argIndex);
break;
case JAVA_TYPE_BYTE_ARRAY:
fprintf(out, "%s buff[pos] = STRING_TYPE;\n", indent.c_str());
fprintf(out, "%s copyInt(buff, pos + 1, arg%d.length);\n",
indent.c_str(), argIndex);
fprintf(out, "%s System.arraycopy("
"arg%d, 0, buff, pos + STRING_TYPE_OVERHEAD, arg%d.length);\n",
indent.c_str(), argIndex, argIndex);
fprintf(out, "%s pos += STRING_TYPE_OVERHEAD + arg%d.length;\n",
indent.c_str(), argIndex);
break;
case JAVA_TYPE_ATTRIBUTION_CHAIN:
{
requiredHelpers |= JAVA_MODULE_REQUIRES_ATTRIBUTION;
const char* uidName = attributionDecl.fields.front().name.c_str();
const char* tagName = attributionDecl.fields.back().name.c_str();
fprintf(out, "%s writeAttributionChain(buff, pos, %s, %s);\n", indent.c_str(),
uidName, tagName);
fprintf(out, "%s pos += attrSize;\n", indent.c_str());
break;
}
default:
// Unsupported types: OBJECT, DOUBLE, KEY_VALUE_PAIR.
fprintf(stderr,
"Object, Double, and KeyValuePairs are not supported in module logging");
return 1;
}
argIndex++;
}
fprintf(out, "%s StatsLog.writeRaw(buff, pos);\n", indent.c_str());
fprintf(out, "%s}\n", indent.c_str());
fprintf(out, "\n");
}
write_java_helpers_for_q_schema_methods(out, attributionDecl, requiredHelpers, indent);
return 0;
}
void write_java_helpers_for_q_schema_methods(
FILE* out,
const AtomDecl &attributionDecl,
const int requiredHelpers,
const string& indent) {
fprintf(out, "\n");
fprintf(out, "%s// Helper methods for copying primitives\n", indent.c_str());
fprintf(out, "%sprivate static void copyInt(byte[] buff, int pos, int val) {\n",
indent.c_str());
fprintf(out, "%s buff[pos] = (byte) (val);\n", indent.c_str());
fprintf(out, "%s buff[pos + 1] = (byte) (val >> 8);\n", indent.c_str());
fprintf(out, "%s buff[pos + 2] = (byte) (val >> 16);\n", indent.c_str());
fprintf(out, "%s buff[pos + 3] = (byte) (val >> 24);\n", indent.c_str());
fprintf(out, "%s return;\n", indent.c_str());
fprintf(out, "%s}\n", indent.c_str());
fprintf(out, "\n");
fprintf(out, "%sprivate static void copyLong(byte[] buff, int pos, long val) {\n",
indent.c_str());
fprintf(out, "%s buff[pos] = (byte) (val);\n", indent.c_str());
fprintf(out, "%s buff[pos + 1] = (byte) (val >> 8);\n", indent.c_str());
fprintf(out, "%s buff[pos + 2] = (byte) (val >> 16);\n", indent.c_str());
fprintf(out, "%s buff[pos + 3] = (byte) (val >> 24);\n", indent.c_str());
fprintf(out, "%s buff[pos + 4] = (byte) (val >> 32);\n", indent.c_str());
fprintf(out, "%s buff[pos + 5] = (byte) (val >> 40);\n", indent.c_str());
fprintf(out, "%s buff[pos + 6] = (byte) (val >> 48);\n", indent.c_str());
fprintf(out, "%s buff[pos + 7] = (byte) (val >> 56);\n", indent.c_str());
fprintf(out, "%s return;\n", indent.c_str());
fprintf(out, "%s}\n", indent.c_str());
fprintf(out, "\n");
if (requiredHelpers & JAVA_MODULE_REQUIRES_FLOAT) {
fprintf(out, "%sprivate static void copyFloat(byte[] buff, int pos, float val) {\n",
indent.c_str());
fprintf(out, "%s copyInt(buff, pos, Float.floatToIntBits(val));\n", indent.c_str());
fprintf(out, "%s return;\n", indent.c_str());
fprintf(out, "%s}\n", indent.c_str());
fprintf(out, "\n");
}
if (requiredHelpers & JAVA_MODULE_REQUIRES_ATTRIBUTION) {
fprintf(out, "%sprivate static void writeAttributionChain(byte[] buff, int pos",
indent.c_str());
for (auto chainField : attributionDecl.fields) {
fprintf(out, ", %s[] %s",
java_type_name(chainField.javaType), chainField.name.c_str());
}
fprintf(out, ") {\n");
const char* uidName = attributionDecl.fields.front().name.c_str();
const char* tagName = attributionDecl.fields.back().name.c_str();
// Write the first list begin.
fprintf(out, "%s buff[pos] = LIST_TYPE;\n", indent.c_str());
fprintf(out, "%s buff[pos + 1] = (byte) (%s.length);\n", indent.c_str(), tagName);
fprintf(out, "%s pos += LIST_TYPE_OVERHEAD;\n", indent.c_str());
// Iterate through the attribution chain and write the nodes.
fprintf(out, "%s for (int i = 0; i < %s.length; i++) {\n", indent.c_str(), tagName);
// Write the list begin.
fprintf(out, "%s buff[pos] = LIST_TYPE;\n", indent.c_str());
fprintf(out, "%s buff[pos + 1] = %lu;\n",
indent.c_str(), attributionDecl.fields.size());
fprintf(out, "%s pos += LIST_TYPE_OVERHEAD;\n", indent.c_str());
// Write the uid.
fprintf(out, "%s buff[pos] = INT_TYPE;\n", indent.c_str());
fprintf(out, "%s copyInt(buff, pos + 1, %s[i]);\n", indent.c_str(), uidName);
fprintf(out, "%s pos += INT_TYPE_SIZE;\n", indent.c_str());
// Write the tag.
fprintf(out, "%s String %sStr = (%s[i] == null) ? \"\" : %s[i];\n",
indent.c_str(), tagName, tagName, tagName);
fprintf(out, "%s byte[] %sByte = "
"%sStr.getBytes(java.nio.charset.StandardCharsets.UTF_8);\n",
indent.c_str(), tagName, tagName);
fprintf(out, "%s buff[pos] = STRING_TYPE;\n", indent.c_str());
fprintf(out, "%s copyInt(buff, pos + 1, %sByte.length);\n", indent.c_str(), tagName);
fprintf(out, "%s System.arraycopy("
"%sByte, 0, buff, pos + STRING_TYPE_OVERHEAD, %sByte.length);\n",
indent.c_str(), tagName, tagName);
fprintf(out, "%s pos += STRING_TYPE_OVERHEAD + %sByte.length;\n",
indent.c_str(), tagName);
fprintf(out, "%s }\n", indent.c_str());
fprintf(out, "%s}\n", indent.c_str());
fprintf(out, "\n");
}
}
#if defined(STATS_SCHEMA_LEGACY)
static void write_java_method(
FILE* out,
const string& method_name,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const AtomDecl &attributionDecl) {
for (auto signature_to_modules_it = signatures_to_modules.begin();
signature_to_modules_it != signatures_to_modules.end(); signature_to_modules_it++) {
vector<java_type_t> signature = signature_to_modules_it->first;
fprintf(out, " /** @hide */\n");
fprintf(out, " public static native int %s(int code", method_name.c_str());
int argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) {
for (auto chainField : attributionDecl.fields) {
fprintf(out, ", %s[] %s",
java_type_name(chainField.javaType), chainField.name.c_str());
}
} else if (*arg == JAVA_TYPE_KEY_VALUE_PAIR) {
fprintf(out, ", SparseArray<Object> value_map");
} else {
fprintf(out, ", %s arg%d", java_type_name(*arg), argIndex);
}
argIndex++;
}
fprintf(out, ");\n");
fprintf(out, "\n");
}
}
int write_stats_log_java_q(FILE* out, const Atoms& atoms, const AtomDecl &attributionDecl) {
// Print prelude
fprintf(out, "// This file is autogenerated\n");
fprintf(out, "\n");
fprintf(out, "package android.util;\n");
fprintf(out, "\n");
fprintf(out, "import android.os.WorkSource;\n");
fprintf(out, "import android.util.SparseArray;\n");
fprintf(out, "import java.util.ArrayList;\n");
fprintf(out, "\n");
fprintf(out, "\n");
fprintf(out, "/**\n");
fprintf(out, " * API For logging statistics events.\n");
fprintf(out, " * @hide\n");
fprintf(out, " */\n");
fprintf(out, "public class StatsLogInternal {\n");
write_java_atom_codes(out, atoms, DEFAULT_MODULE_NAME);
write_java_enum_values(out, atoms, DEFAULT_MODULE_NAME);
// Print write methods
fprintf(out, " // Write methods\n");
write_java_method(out, "write", atoms.signatures_to_modules, attributionDecl);
write_java_method(out, "write_non_chained", atoms.non_chained_signatures_to_modules,
attributionDecl);
write_java_work_source_methods(out, atoms.signatures_to_modules, DEFAULT_MODULE_NAME);
fprintf(out, "}\n");
return 0;
}
int write_stats_log_java_q_for_module(FILE* out, const Atoms& atoms, const AtomDecl &attributionDecl,
const string& moduleName, const string& javaClass,
const string& javaPackage) {
// Print prelude
fprintf(out, "// This file is autogenerated\n");
fprintf(out, "\n");
fprintf(out, "package %s;\n", javaPackage.c_str());
fprintf(out, "\n");
fprintf(out, "import static java.nio.charset.StandardCharsets.UTF_8;\n");
fprintf(out, "\n");
fprintf(out, "import android.util.StatsLog;\n");
fprintf(out, "import android.os.SystemClock;\n");
fprintf(out, "\n");
fprintf(out, "import java.util.ArrayList;\n");
fprintf(out, "\n");
fprintf(out, "\n");
fprintf(out, "/**\n");
fprintf(out, " * Utility class for logging statistics events.\n");
fprintf(out, " */\n");
fprintf(out, "public class %s {\n", javaClass.c_str());
write_java_q_logging_constants(out, " ");
write_java_atom_codes(out, atoms, moduleName);
write_java_enum_values(out, atoms, moduleName);
int errors = 0;
// Print write methods
fprintf(out, " // Write methods\n");
errors += write_java_methods_q_schema(out, atoms.signatures_to_modules, attributionDecl,
moduleName, " ");
errors += write_java_non_chained_methods(out, atoms.non_chained_signatures_to_modules,
moduleName);
fprintf(out, "}\n");
return errors;
}
#endif
} // namespace stats_log_api_gen
} // namespace android

58
tools/stats_log_api_gen/java_writer_q.h Normal file
View File

@@ -0,0 +1,58 @@
/*
* 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.
*/
#pragma once
#include "Collation.h"
#include <map>
#include <set>
#include <vector>
#include <stdio.h>
#include <string.h>
namespace android {
namespace stats_log_api_gen {
using namespace std;
void write_java_q_logging_constants(FILE* out, const string& indent);
int write_java_methods_q_schema(
FILE* out,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const AtomDecl &attributionDecl,
const string& moduleName,
const string& indent
);
void write_java_helpers_for_q_schema_methods(
FILE * out,
const AtomDecl &attributionDecl,
const int requiredHelpers,
const string& indent
);
#if defined(STATS_SCHEMA_LEGACY)
int write_stats_log_java_q(FILE* out, const Atoms& atoms, const AtomDecl &attributionDecl);
int write_stats_log_java_q_for_module(FILE* out, const Atoms& atoms, const AtomDecl &attributionDecl,
const string& moduleName, const string& javaClass,
const string& javaPackage);
#endif
} // namespace stats_log_api_gen
} // namespace android

791
tools/stats_log_api_gen/main.cpp
View File

@@ -1,9 +1,15 @@
#include "Collation.h"
#if !defined(STATS_SCHEMA_LEGACY)
#include "java_writer.h"
#endif
#include "java_writer_q.h"
#include "utils.h"
#include "frameworks/base/cmds/statsd/src/atoms.pb.h"
#include <map>
#include <set>
#include <vector>
@@ -20,108 +26,8 @@ using namespace std;
namespace android {
namespace stats_log_api_gen {
int maxPushedAtomId = 2;
const string DEFAULT_MODULE_NAME = "DEFAULT";
const string DEFAULT_CPP_NAMESPACE = "android,util";
const string DEFAULT_CPP_HEADER_IMPORT = "statslog.h";
const string DEFAULT_JAVA_PACKAGE = "android.util";
const string DEFAULT_JAVA_CLASS = "StatsLogInternal";
const int JAVA_MODULE_REQUIRES_FLOAT = 0x01;
const int JAVA_MODULE_REQUIRES_ATTRIBUTION = 0x02;
using android::os::statsd::Atom;
/**
* Turn lower and camel case into upper case with underscores.
*/
static 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;
}
static const char*
cpp_type_name(java_type_t type)
{
switch (type) {
case JAVA_TYPE_BOOLEAN:
return "bool";
case JAVA_TYPE_INT:
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&";
default:
return "UNKNOWN";
}
}
static const char*
java_type_name(java_type_t type)
{
switch (type) {
case JAVA_TYPE_BOOLEAN:
return "boolean";
case JAVA_TYPE_INT:
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[]";
default:
return "UNKNOWN";
}
}
static bool atom_needed_for_module(const AtomDecl& atomDecl, const string& moduleName) {
if (moduleName == DEFAULT_MODULE_NAME) {
return true;
}
return atomDecl.hasModule && (moduleName == atomDecl.moduleName);
}
static bool signature_needed_for_module(const set<string>& modules, const string& moduleName) {
if (moduleName == DEFAULT_MODULE_NAME) {
return true;
}
return modules.find(moduleName) != modules.end();
}
static void write_atoms_info_cpp(FILE *out, const Atoms &atoms) {
std::set<string> kTruncatingAtomNames = {"mobile_radio_power_state_changed",
"audio_state_changed",
@@ -637,14 +543,6 @@ static int write_stats_log_cpp(FILE *out, const Atoms &atoms, const AtomDecl &at
return 0;
}
void build_non_chained_decl_map(const Atoms& atoms,
std::map<int, set<AtomDecl>::const_iterator>* decl_map){
for (set<AtomDecl>::const_iterator atom = atoms.non_chained_decls.begin();
atom != atoms.non_chained_decls.end(); atom++) {
decl_map->insert(std::make_pair(atom->code, atom));
}
}
static void write_cpp_usage(
FILE* out, const string& method_name, const string& atom_code_name,
const AtomDecl& atom, const AtomDecl &attributionDecl) {
@@ -756,6 +654,7 @@ write_stats_log_header(FILE* out, const Atoms& atoms, const AtomDecl &attributio
build_non_chained_decl_map(atoms, &atom_code_to_non_chained_decl_map);
size_t i = 0;
int maxPushedAtomId = 2;
// Print atom constants
for (set<AtomDecl>::const_iterator atom = atoms.decls.begin();
atom != atoms.decls.end(); atom++) {
@@ -873,629 +772,11 @@ write_stats_log_header(FILE* out, const Atoms& atoms, const AtomDecl &attributio
return 0;
}
static 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<AtomField>::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_KEY_VALUE_PAIR) {
fprintf(out, ", SparseArray<Object> value_map");
} 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, ");<br>\n");
}
static void write_java_method(
FILE* out,
const string& method_name,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const AtomDecl &attributionDecl) {
for (auto signature_to_modules_it = signatures_to_modules.begin();
signature_to_modules_it != signatures_to_modules.end(); signature_to_modules_it++) {
vector<java_type_t> signature = signature_to_modules_it->first;
fprintf(out, " /** @hide */\n");
fprintf(out, " public static native int %s(int code", method_name.c_str());
int argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) {
for (auto chainField : attributionDecl.fields) {
fprintf(out, ", %s[] %s",
java_type_name(chainField.javaType), chainField.name.c_str());
}
} else if (*arg == JAVA_TYPE_KEY_VALUE_PAIR) {
fprintf(out, ", SparseArray<Object> value_map");
} else {
fprintf(out, ", %s arg%d", java_type_name(*arg), argIndex);
}
argIndex++;
}
fprintf(out, ");\n");
}
}
static void write_java_helpers_for_module(
FILE * out,
const AtomDecl &attributionDecl,
const int requiredHelpers) {
fprintf(out, " private static void copyInt(byte[] buff, int pos, int val) {\n");
fprintf(out, " buff[pos] = (byte) (val);\n");
fprintf(out, " buff[pos + 1] = (byte) (val >> 8);\n");
fprintf(out, " buff[pos + 2] = (byte) (val >> 16);\n");
fprintf(out, " buff[pos + 3] = (byte) (val >> 24);\n");
fprintf(out, " return;\n");
fprintf(out, " }\n");
fprintf(out, "\n");
fprintf(out, " private static void copyLong(byte[] buff, int pos, long val) {\n");
fprintf(out, " buff[pos] = (byte) (val);\n");
fprintf(out, " buff[pos + 1] = (byte) (val >> 8);\n");
fprintf(out, " buff[pos + 2] = (byte) (val >> 16);\n");
fprintf(out, " buff[pos + 3] = (byte) (val >> 24);\n");
fprintf(out, " buff[pos + 4] = (byte) (val >> 32);\n");
fprintf(out, " buff[pos + 5] = (byte) (val >> 40);\n");
fprintf(out, " buff[pos + 6] = (byte) (val >> 48);\n");
fprintf(out, " buff[pos + 7] = (byte) (val >> 56);\n");
fprintf(out, " return;\n");
fprintf(out, " }\n");
fprintf(out, "\n");
if (requiredHelpers & JAVA_MODULE_REQUIRES_FLOAT) {
fprintf(out, " private static void copyFloat(byte[] buff, int pos, float val) {\n");
fprintf(out, " copyInt(buff, pos, Float.floatToIntBits(val));\n");
fprintf(out, " return;\n");
fprintf(out, " }\n");
fprintf(out, "\n");
}
if (requiredHelpers & JAVA_MODULE_REQUIRES_ATTRIBUTION) {
fprintf(out, " private static void writeAttributionChain(byte[] buff, int pos");
for (auto chainField : attributionDecl.fields) {
fprintf(out, ", %s[] %s",
java_type_name(chainField.javaType), chainField.name.c_str());
}
fprintf(out, ") {\n");
const char* uidName = attributionDecl.fields.front().name.c_str();
const char* tagName = attributionDecl.fields.back().name.c_str();
// Write the first list begin.
fprintf(out, " buff[pos] = LIST_TYPE;\n");
fprintf(out, " buff[pos + 1] = (byte) (%s.length);\n", tagName);
fprintf(out, " pos += LIST_TYPE_OVERHEAD;\n");
// Iterate through the attribution chain and write the nodes.
fprintf(out, " for (int i = 0; i < %s.length; i++) {\n", tagName);
// Write the list begin.
fprintf(out, " buff[pos] = LIST_TYPE;\n");
fprintf(out, " buff[pos + 1] = %lu;\n", attributionDecl.fields.size());
fprintf(out, " pos += LIST_TYPE_OVERHEAD;\n");
// Write the uid.
fprintf(out, " buff[pos] = INT_TYPE;\n");
fprintf(out, " copyInt(buff, pos + 1, %s[i]);\n", uidName);
fprintf(out, " pos += INT_TYPE_SIZE;\n");
// Write the tag.
fprintf(out, " String %sStr = (%s[i] == null) ? \"\" : %s[i];\n",
tagName, tagName, tagName);
fprintf(out, " byte[] %sByte = %sStr.getBytes(UTF_8);\n", tagName, tagName);
fprintf(out, " buff[pos] = STRING_TYPE;\n");
fprintf(out, " copyInt(buff, pos + 1, %sByte.length);\n", tagName);
fprintf(out, " System.arraycopy("
"%sByte, 0, buff, pos + STRING_TYPE_OVERHEAD, %sByte.length);\n",
tagName, tagName);
fprintf(out, " pos += STRING_TYPE_OVERHEAD + %sByte.length;\n", tagName);
fprintf(out, " }\n");
fprintf(out, " }\n");
fprintf(out, "\n");
}
}
static int write_java_non_chained_method_for_module(
FILE* out,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const string& moduleName
) {
for (auto signature_to_modules_it = signatures_to_modules.begin();
signature_to_modules_it != signatures_to_modules.end(); signature_to_modules_it++) {
// Skip if this signature is not needed for the module.
if (!signature_needed_for_module(signature_to_modules_it->second, moduleName)) {
continue;
}
// Print method signature.
vector<java_type_t> signature = signature_to_modules_it->first;
fprintf(out, " public static void write_non_chained(int code");
int argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) {
// Non chained signatures should not have attribution chains.
return 1;
} else if (*arg == JAVA_TYPE_KEY_VALUE_PAIR) {
// Module logging does not yet support key value pair.
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<java_type_t>::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;
}
static int write_java_method_for_module(
FILE* out,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const AtomDecl &attributionDecl,
const string& moduleName,
int* requiredHelpers
) {
for (auto signature_to_modules_it = signatures_to_modules.begin();
signature_to_modules_it != signatures_to_modules.end(); signature_to_modules_it++) {
// Skip if this signature is not needed for the module.
if (!signature_needed_for_module(signature_to_modules_it->second, moduleName)) {
continue;
}
// Print method signature.
vector<java_type_t> signature = signature_to_modules_it->first;
fprintf(out, " public static void write(int code");
int argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) {
for (auto chainField : attributionDecl.fields) {
fprintf(out, ", %s[] %s",
java_type_name(chainField.javaType), chainField.name.c_str());
}
} else if (*arg == JAVA_TYPE_KEY_VALUE_PAIR) {
// Module logging does not yet support key value pair.
return 1;
} else {
fprintf(out, ", %s arg%d", java_type_name(*arg), argIndex);
}
argIndex++;
}
fprintf(out, ") {\n");
// Calculate the size of the buffer.
fprintf(out, " // Initial overhead of the list, timestamp, and atom tag.\n");
fprintf(out, " int needed = LIST_TYPE_OVERHEAD + LONG_TYPE_SIZE + INT_TYPE_SIZE;\n");
argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
switch (*arg) {
case JAVA_TYPE_BOOLEAN:
case JAVA_TYPE_INT:
case JAVA_TYPE_FLOAT:
case JAVA_TYPE_ENUM:
fprintf(out, " needed += INT_TYPE_SIZE;\n");
break;
case JAVA_TYPE_LONG:
// Longs take 9 bytes, 1 for the type and 8 for the value.
fprintf(out, " needed += LONG_TYPE_SIZE;\n");
break;
case JAVA_TYPE_STRING:
// Strings take 5 metadata bytes + length of byte encoded string.
fprintf(out, " if (arg%d == null) {\n", argIndex);
fprintf(out, " arg%d = \"\";\n", argIndex);
fprintf(out, " }\n");
fprintf(out, " byte[] arg%dBytes= arg%d.getBytes(UTF_8);\n",
argIndex, argIndex);
fprintf(out, " needed += STRING_TYPE_OVERHEAD + arg%dBytes.length;\n",
argIndex);
break;
case JAVA_TYPE_BYTE_ARRAY:
// Byte arrays take 5 metadata bytes + length of byte array.
fprintf(out, " if (arg%d == null) {\n", argIndex);
fprintf(out, " arg%d = new byte[0];\n", argIndex);
fprintf(out, " }\n");
fprintf(out, " needed += STRING_TYPE_OVERHEAD + arg%d.length;\n", argIndex);
break;
case JAVA_TYPE_ATTRIBUTION_CHAIN:
{
const char* uidName = attributionDecl.fields.front().name.c_str();
const char* tagName = attributionDecl.fields.back().name.c_str();
// Null checks on the params.
fprintf(out, " if (%s == null) {\n", uidName);
fprintf(out, " %s = new %s[0];\n", uidName,
java_type_name(attributionDecl.fields.front().javaType));
fprintf(out, " }\n");
fprintf(out, " if (%s == null) {\n", tagName);
fprintf(out, " %s = new %s[0];\n", tagName,
java_type_name(attributionDecl.fields.back().javaType));
fprintf(out, " }\n");
// First check that the lengths of the uid and tag arrays are the same.
fprintf(out, " if (%s.length != %s.length) {\n", uidName, tagName);
fprintf(out, " return;\n");
fprintf(out, " }\n");
fprintf(out, " int attrSize = LIST_TYPE_OVERHEAD;\n");
fprintf(out, " for (int i = 0; i < %s.length; i++) {\n", tagName);
fprintf(out, " String str%d = (%s[i] == null) ? \"\" : %s[i];\n",
argIndex, tagName, tagName);
fprintf(out, " int str%dlen = str%d.getBytes(UTF_8).length;\n",
argIndex, argIndex);
fprintf(out,
" attrSize += "
"LIST_TYPE_OVERHEAD + INT_TYPE_SIZE + STRING_TYPE_OVERHEAD + str%dlen;\n",
argIndex);
fprintf(out, " }\n");
fprintf(out, " needed += attrSize;\n");
break;
}
default:
// Unsupported types: OBJECT, DOUBLE, KEY_VALUE_PAIR.
return 1;
}
argIndex++;
}
// Now we have the size that is needed. Check for overflow and return if needed.
fprintf(out, " if (needed > MAX_EVENT_PAYLOAD) {\n");
fprintf(out, " return;\n");
fprintf(out, " }\n");
// Create new buffer, and associated data types.
fprintf(out, " byte[] buff = new byte[needed];\n");
fprintf(out, " int pos = 0;\n");
// Initialize the buffer with list data type.
fprintf(out, " buff[pos] = LIST_TYPE;\n");
fprintf(out, " buff[pos + 1] = %zu;\n", signature.size() + 2);
fprintf(out, " pos += LIST_TYPE_OVERHEAD;\n");
// Write timestamp.
fprintf(out, " long elapsedRealtime = SystemClock.elapsedRealtimeNanos();\n");
fprintf(out, " buff[pos] = LONG_TYPE;\n");
fprintf(out, " copyLong(buff, pos + 1, elapsedRealtime);\n");
fprintf(out, " pos += LONG_TYPE_SIZE;\n");
// Write atom code.
fprintf(out, " buff[pos] = INT_TYPE;\n");
fprintf(out, " copyInt(buff, pos + 1, code);\n");
fprintf(out, " pos += INT_TYPE_SIZE;\n");
// Write the args.
argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
switch (*arg) {
case JAVA_TYPE_BOOLEAN:
fprintf(out, " buff[pos] = INT_TYPE;\n");
fprintf(out, " copyInt(buff, pos + 1, arg%d? 1 : 0);\n", argIndex);
fprintf(out, " pos += INT_TYPE_SIZE;\n");
break;
case JAVA_TYPE_INT:
case JAVA_TYPE_ENUM:
fprintf(out, " buff[pos] = INT_TYPE;\n");
fprintf(out, " copyInt(buff, pos + 1, arg%d);\n", argIndex);
fprintf(out, " pos += INT_TYPE_SIZE;\n");
break;
case JAVA_TYPE_FLOAT:
*requiredHelpers |= JAVA_MODULE_REQUIRES_FLOAT;
fprintf(out, " buff[pos] = FLOAT_TYPE;\n");
fprintf(out, " copyFloat(buff, pos + 1, arg%d);\n", argIndex);
fprintf(out, " pos += FLOAT_TYPE_SIZE;\n");
break;
case JAVA_TYPE_LONG:
fprintf(out, " buff[pos] = LONG_TYPE;\n");
fprintf(out, " copyLong(buff, pos + 1, arg%d);\n", argIndex);
fprintf(out, " pos += LONG_TYPE_SIZE;\n");
break;
case JAVA_TYPE_STRING:
fprintf(out, " buff[pos] = STRING_TYPE;\n");
fprintf(out, " copyInt(buff, pos + 1, arg%dBytes.length);\n", argIndex);
fprintf(out, " System.arraycopy("
"arg%dBytes, 0, buff, pos + STRING_TYPE_OVERHEAD, arg%dBytes.length);\n",
argIndex, argIndex);
fprintf(out, " pos += STRING_TYPE_OVERHEAD + arg%dBytes.length;\n",
argIndex);
break;
case JAVA_TYPE_BYTE_ARRAY:
fprintf(out, " buff[pos] = STRING_TYPE;\n");
fprintf(out, " copyInt(buff, pos + 1, arg%d.length);\n", argIndex);
fprintf(out, " System.arraycopy("
"arg%d, 0, buff, pos + STRING_TYPE_OVERHEAD, arg%d.length);\n",
argIndex, argIndex);
fprintf(out, " pos += STRING_TYPE_OVERHEAD + arg%d.length;\n", argIndex);
break;
case JAVA_TYPE_ATTRIBUTION_CHAIN:
{
*requiredHelpers |= JAVA_MODULE_REQUIRES_ATTRIBUTION;
const char* uidName = attributionDecl.fields.front().name.c_str();
const char* tagName = attributionDecl.fields.back().name.c_str();
fprintf(out, " writeAttributionChain(buff, pos, %s, %s);\n",
uidName, tagName);
fprintf(out, " pos += attrSize;\n");
break;
}
default:
// Unsupported types: OBJECT, DOUBLE, KEY_VALUE_PAIR.
return 1;
}
argIndex++;
}
fprintf(out, " StatsLog.writeRaw(buff, pos);\n");
fprintf(out, " }\n");
fprintf(out, "\n");
}
return 0;
}
static void write_java_work_source_method(FILE* out,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const string& moduleName) {
fprintf(out, "\n // WorkSource methods.\n");
for (auto signature_to_modules_it = signatures_to_modules.begin();
signature_to_modules_it != signatures_to_modules.end(); signature_to_modules_it++) {
// Skip if this signature is not needed for the module.
if (!signature_needed_for_module(signature_to_modules_it->second, moduleName)) {
continue;
}
vector<java_type_t> signature = signature_to_modules_it->first;
// Determine if there is Attribution in this signature.
int attributionArg = -1;
int argIndexMax = 0;
for (vector<java_type_t>::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;
}
attributionArg = argIndexMax;
}
}
if (attributionArg < 0) {
continue;
}
// Method header (signature)
if (moduleName == DEFAULT_MODULE_NAME) {
fprintf(out, " /** @hide */\n");
}
fprintf(out, " public static void write(int code");
int argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) {
fprintf(out, ", 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.get(i), ws.getName(i)");
} else {
fprintf(out, ", arg%d", argIndex);
}
}
fprintf(out, ");\n");
fprintf(out, " }\n"); // close for-loop
// write() component.
fprintf(out, " ArrayList<WorkSource.WorkChain> workChains = ws.getWorkChains();\n");
fprintf(out, " if (workChains != null) {\n");
fprintf(out, " for (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
}
}
static void write_java_atom_codes(FILE* out, const Atoms& atoms, const string& moduleName) {
fprintf(out, " // Constants for atom codes.\n");
std::map<int, set<AtomDecl>::const_iterator> 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 (set<AtomDecl>::const_iterator atom = atoms.decls.begin();
atom != atoms.decls.end(); atom++) {
// Skip if the atom is not needed for the module.
if (!atom_needed_for_module(*atom, moduleName)) {
continue;
}
string constant = make_constant_name(atom->name);
fprintf(out, "\n");
fprintf(out, " /**\n");
fprintf(out, " * %s %s<br>\n", atom->message.c_str(), atom->name.c_str());
write_java_usage(out, "write", constant, *atom);
auto non_chained_decl = atom_code_to_non_chained_decl_map.find(atom->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);
}
if (moduleName == DEFAULT_MODULE_NAME) {
fprintf(out, " * @hide\n");
}
fprintf(out, " */\n");
fprintf(out, " public static final int %s = %d;\n", constant.c_str(), atom->code);
}
fprintf(out, "\n");
}
static void write_java_enum_values(FILE* out, const Atoms& atoms, const string& moduleName) {
fprintf(out, " // Constants for enum values.\n\n");
for (set<AtomDecl>::const_iterator atom = atoms.decls.begin();
atom != atoms.decls.end(); atom++) {
// Skip if the atom is not needed for the module.
if (!atom_needed_for_module(*atom, moduleName)) {
continue;
}
for (vector<AtomField>::const_iterator field = atom->fields.begin();
field != atom->fields.end(); field++) {
if (field->javaType == JAVA_TYPE_ENUM) {
fprintf(out, " // Values for %s.%s\n", atom->message.c_str(),
field->name.c_str());
for (map<int, string>::const_iterator value = field->enumValues.begin();
value != field->enumValues.end(); value++) {
if (moduleName == DEFAULT_MODULE_NAME) {
fprintf(out, " /** @hide */\n");
}
fprintf(out, " public static final int %s__%s__%s = %d;\n",
make_constant_name(atom->message).c_str(),
make_constant_name(field->name).c_str(),
make_constant_name(value->second).c_str(),
value->first);
}
fprintf(out, "\n");
}
}
}
}
static int
write_stats_log_java(FILE* out, const Atoms& atoms, const AtomDecl &attributionDecl)
{
// Print prelude
fprintf(out, "// This file is autogenerated\n");
fprintf(out, "\n");
fprintf(out, "package android.util;\n");
fprintf(out, "\n");
fprintf(out, "import android.os.WorkSource;\n");
fprintf(out, "import android.util.SparseArray;\n");
fprintf(out, "import java.util.ArrayList;\n");
fprintf(out, "\n");
fprintf(out, "\n");
fprintf(out, "/**\n");
fprintf(out, " * API For logging statistics events.\n");
fprintf(out, " * @hide\n");
fprintf(out, " */\n");
fprintf(out, "public class StatsLogInternal {\n");
write_java_atom_codes(out, atoms, DEFAULT_MODULE_NAME);
write_java_enum_values(out, atoms, DEFAULT_MODULE_NAME);
// Print write methods
fprintf(out, " // Write methods\n");
write_java_method(out, "write", atoms.signatures_to_modules, attributionDecl);
write_java_method(out, "write_non_chained", atoms.non_chained_signatures_to_modules,
attributionDecl);
write_java_work_source_method(out, atoms.signatures_to_modules, DEFAULT_MODULE_NAME);
fprintf(out, "}\n");
return 0;
}
// TODO: Merge this with write_stats_log_java so that we can get rid of StatsLogInternal JNI.
static int
write_stats_log_java_for_module(FILE* out, const Atoms& atoms, const AtomDecl &attributionDecl,
const string& moduleName, const string& javaClass, const string& javaPackage)
{
// Print prelude
fprintf(out, "// This file is autogenerated\n");
fprintf(out, "\n");
fprintf(out, "package %s;\n", javaPackage.c_str());
fprintf(out, "\n");
fprintf(out, "import static java.nio.charset.StandardCharsets.UTF_8;\n");
fprintf(out, "\n");
fprintf(out, "import android.util.StatsLog;\n");
fprintf(out, "import android.os.SystemClock;\n");
fprintf(out, "\n");
fprintf(out, "import java.util.ArrayList;\n");
fprintf(out, "\n");
fprintf(out, "\n");
fprintf(out, "/**\n");
fprintf(out, " * Utility class for logging statistics events.\n");
fprintf(out, " */\n");
fprintf(out, "public class %s {\n", javaClass.c_str());
// TODO: ideally these match with the native values (and automatically change if they change).
fprintf(out, " private static final int LOGGER_ENTRY_MAX_PAYLOAD = 4068;\n");
fprintf(out,
" private static final int MAX_EVENT_PAYLOAD = LOGGER_ENTRY_MAX_PAYLOAD - 4;\n");
// Value types. Must match with EventLog.java and log.h.
fprintf(out, " private static final byte INT_TYPE = 0;\n");
fprintf(out, " private static final byte LONG_TYPE = 1;\n");
fprintf(out, " private static final byte STRING_TYPE = 2;\n");
fprintf(out, " private static final byte LIST_TYPE = 3;\n");
fprintf(out, " private static final byte FLOAT_TYPE = 4;\n");
// Size of each value type.
// Booleans, ints, floats, and enums take 5 bytes, 1 for the type and 4 for the value.
fprintf(out, " private static final int INT_TYPE_SIZE = 5;\n");
fprintf(out, " private static final int FLOAT_TYPE_SIZE = 5;\n");
// Longs take 9 bytes, 1 for the type and 8 for the value.
fprintf(out, " private static final int LONG_TYPE_SIZE = 9;\n");
// Strings take 5 metadata bytes: 1 byte is for the type, 4 are for the length.
fprintf(out, " private static final int STRING_TYPE_OVERHEAD = 5;\n");
fprintf(out, " private static final int LIST_TYPE_OVERHEAD = 2;\n");
write_java_atom_codes(out, atoms, moduleName);
write_java_enum_values(out, atoms, moduleName);
int errors = 0;
int requiredHelpers = 0;
// Print write methods
fprintf(out, " // Write methods\n");
errors += write_java_method_for_module(out, atoms.signatures_to_modules, attributionDecl,
moduleName, &requiredHelpers);
errors += write_java_non_chained_method_for_module(out, atoms.non_chained_signatures_to_modules,
moduleName);
fprintf(out, " // Helper methods for copying primitives\n");
write_java_helpers_for_module(out, attributionDecl, requiredHelpers);
fprintf(out, "}\n");
return errors;
}
// Hide the JNI write helpers that are not used in the new schema.
// TODO(b/145100015): Remove this and other JNI related functionality once StatsEvent migration is
// complete.
#if defined(STATS_SCHEMA_LEGACY)
// JNI helpers.
static const char*
jni_type_name(java_type_t type)
{
@@ -1666,7 +947,7 @@ static void write_key_value_map_jni(FILE* out) {
}
static int
write_stats_log_jni(FILE* out, const string& java_method_name, const string& cpp_method_name,
write_stats_log_jni_method(FILE* out, const string& java_method_name, const string& cpp_method_name,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const AtomDecl &attributionDecl) {
// Print write methods
@@ -1882,40 +1163,56 @@ void write_jni_registration(FILE* out, const string& java_method_name,
jni_function_name(java_method_name, signature).c_str());
}
}
#endif // JNI helpers.
static int
#if defined(STATS_SCHEMA_LEGACY)
write_stats_log_jni(FILE* out, const Atoms& atoms, const AtomDecl &attributionDecl)
#else
// Write empty JNI file that doesn't contain any JNI methods.
// TODO(b/145100015): remove this function and all JNI autogen code once StatsEvent migration is
// complete.
write_stats_log_jni(FILE* out)
#endif
{
// Print prelude
fprintf(out, "// This file is autogenerated\n");
fprintf(out, "\n");
#if defined(STATS_SCHEMA_LEGACY)
fprintf(out, "#include <statslog.h>\n");
fprintf(out, "\n");
fprintf(out, "#include <nativehelper/JNIHelp.h>\n");
fprintf(out, "#include <nativehelper/ScopedUtfChars.h>\n");
fprintf(out, "#include <utils/Vector.h>\n");
#endif
fprintf(out, "#include \"core_jni_helpers.h\"\n");
fprintf(out, "#include \"jni.h\"\n");
fprintf(out, "\n");
#if defined(STATS_SCHEMA_LEGACY)
fprintf(out, "#define UNUSED __attribute__((__unused__))\n");
fprintf(out, "\n");
#endif
fprintf(out, "namespace android {\n");
fprintf(out, "\n");
write_stats_log_jni(out, "write", "stats_write", atoms.signatures_to_modules, attributionDecl);
write_stats_log_jni(out, "write_non_chained", "stats_write_non_chained",
#if defined(STATS_SCHEMA_LEGACY)
write_stats_log_jni_method(out, "write", "stats_write", atoms.signatures_to_modules, attributionDecl);
write_stats_log_jni_method(out, "write_non_chained", "stats_write_non_chained",
atoms.non_chained_signatures_to_modules, attributionDecl);
#endif
// Print registration function table
fprintf(out, "/*\n");
fprintf(out, " * JNI registration.\n");
fprintf(out, " */\n");
fprintf(out, "static const JNINativeMethod gRegisterMethods[] = {\n");
#if defined(STATS_SCHEMA_LEGACY)
write_jni_registration(out, "write", atoms.signatures_to_modules, attributionDecl);
write_jni_registration(out, "write_non_chained", atoms.non_chained_signatures_to_modules,
attributionDecl);
#endif
fprintf(out, "};\n");
fprintf(out, "\n");
@@ -2112,13 +1409,25 @@ run(int argc, char const*const* argv)
fprintf(stderr, "Must supply --javaPackage if supplying a specific module\n");
return 1;
}
#if defined(STATS_SCHEMA_LEGACY)
if (moduleName == DEFAULT_MODULE_NAME) {
errorCount = android::stats_log_api_gen::write_stats_log_java(
errorCount = android::stats_log_api_gen::write_stats_log_java_q(
out, atoms, attributionDecl);
} else {
errorCount = android::stats_log_api_gen::write_stats_log_java_for_module(
errorCount = android::stats_log_api_gen::write_stats_log_java_q_for_module(
out, atoms, attributionDecl, moduleName, javaClass, javaPackage);
}
#else
if (moduleName == DEFAULT_MODULE_NAME) {
javaClass = "StatsLogInternal";
javaPackage = "android.util";
}
errorCount = android::stats_log_api_gen::write_stats_log_java(
out, atoms, attributionDecl, moduleName, javaClass, javaPackage);
#endif
fclose(out);
}
@@ -2129,16 +1438,22 @@ run(int argc, char const*const* argv)
fprintf(stderr, "Unable to open file for write: %s\n", jniFilename.c_str());
return 1;
}
#if defined(STATS_SCHEMA_LEGACY)
errorCount = android::stats_log_api_gen::write_stats_log_jni(
out, atoms, attributionDecl);
#else
errorCount = android::stats_log_api_gen::write_stats_log_jni(out);
#endif
fclose(out);
}
return errorCount;
}
}
}
} // namespace stats_log_api_gen
} // namespace android
/**
* Main.

334
tools/stats_log_api_gen/utils.cpp Normal file
View File

@@ -0,0 +1,334 @@
/*
* 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 {
/**
* 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:
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&";
default:
return "UNKNOWN";
}
}
const char* java_type_name(java_type_t type) {
switch (type) {
case JAVA_TYPE_BOOLEAN:
return "boolean";
case JAVA_TYPE_INT:
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[]";
default:
return "UNKNOWN";
}
}
bool atom_needed_for_module(const AtomDecl& atomDecl, const string& moduleName) {
if (moduleName == DEFAULT_MODULE_NAME) {
return true;
}
return atomDecl.hasModule && (moduleName == atomDecl.moduleName);
}
bool signature_needed_for_module(const set<string>& modules, const string& moduleName) {
if (moduleName == DEFAULT_MODULE_NAME) {
return true;
}
return modules.find(moduleName) != modules.end();
}
void build_non_chained_decl_map(const Atoms& atoms,
std::map<int, set<AtomDecl>::const_iterator>* decl_map) {
for (set<AtomDecl>::const_iterator atom = atoms.non_chained_decls.begin();
atom != atoms.non_chained_decls.end(); atom++) {
decl_map->insert(std::make_pair(atom->code, atom));
}
}
// Java
void write_java_atom_codes(FILE* out, const Atoms& atoms, const string& moduleName) {
fprintf(out, " // Constants for atom codes.\n");
std::map<int, set<AtomDecl>::const_iterator> 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 (set<AtomDecl>::const_iterator atom = atoms.decls.begin();
atom != atoms.decls.end(); atom++) {
// Skip if the atom is not needed for the module.
if (!atom_needed_for_module(*atom, moduleName)) {
continue;
}
string constant = make_constant_name(atom->name);
fprintf(out, "\n");
fprintf(out, " /**\n");
fprintf(out, " * %s %s<br>\n", atom->message.c_str(), atom->name.c_str());
write_java_usage(out, "write", constant, *atom);
auto non_chained_decl = atom_code_to_non_chained_decl_map.find(atom->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);
}
if (moduleName == DEFAULT_MODULE_NAME) {
fprintf(out, " * @hide\n");
}
fprintf(out, " */\n");
fprintf(out, " public static final int %s = %d;\n", constant.c_str(), atom->code);
}
fprintf(out, "\n");
}
void write_java_enum_values(FILE* out, const Atoms& atoms, const string& moduleName) {
fprintf(out, " // Constants for enum values.\n\n");
for (set<AtomDecl>::const_iterator atom = atoms.decls.begin();
atom != atoms.decls.end(); atom++) {
// Skip if the atom is not needed for the module.
if (!atom_needed_for_module(*atom, moduleName)) {
continue;
}
for (vector<AtomField>::const_iterator field = atom->fields.begin();
field != atom->fields.end(); field++) {
if (field->javaType == JAVA_TYPE_ENUM) {
fprintf(out, " // Values for %s.%s\n", atom->message.c_str(),
field->name.c_str());
for (map<int, string>::const_iterator value = field->enumValues.begin();
value != field->enumValues.end(); value++) {
if (moduleName == DEFAULT_MODULE_NAME) {
fprintf(out, " /** @hide */\n");
}
fprintf(out, " public static final int %s__%s__%s = %d;\n",
make_constant_name(atom->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<AtomField>::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_KEY_VALUE_PAIR) {
fprintf(out, ", SparseArray<Object> value_map");
} 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, ");<br>\n");
}
int write_java_non_chained_methods(
FILE* out,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const string& moduleName
) {
for (auto signature_to_modules_it = signatures_to_modules.begin();
signature_to_modules_it != signatures_to_modules.end(); signature_to_modules_it++) {
// Skip if this signature is not needed for the module.
if (!signature_needed_for_module(signature_to_modules_it->second, moduleName)) {
continue;
}
// Print method signature.
if (DEFAULT_MODULE_NAME == moduleName) {
fprintf(out, " /** @hide */\n");
}
fprintf(out, " public static void write_non_chained(int code");
vector<java_type_t> signature = signature_to_modules_it->first;
int argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) {
// Non chained signatures should not have attribution chains.
return 1;
} else if (*arg == JAVA_TYPE_KEY_VALUE_PAIR) {
// Module logging does not yet support key value pair.
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<java_type_t>::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 map<vector<java_type_t>, set<string>>& signatures_to_modules,
const string& moduleName
) {
fprintf(out, " // WorkSource methods.\n");
for (auto signature_to_modules_it = signatures_to_modules.begin();
signature_to_modules_it != signatures_to_modules.end(); signature_to_modules_it++) {
// Skip if this signature is not needed for the module.
if (!signature_needed_for_module(signature_to_modules_it->second, moduleName)) {
continue;
}
vector<java_type_t> signature = signature_to_modules_it->first;
// Determine if there is Attribution in this signature.
int attributionArg = -1;
int argIndexMax = 0;
for (vector<java_type_t>::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)
if (DEFAULT_MODULE_NAME == moduleName) {
fprintf(out, " /** @hide */\n");
}
fprintf(out, " public static void write(int code");
int argIndex = 1;
for (vector<java_type_t>::const_iterator arg = signature.begin();
arg != signature.end(); arg++) {
if (*arg == JAVA_TYPE_ATTRIBUTION_CHAIN) {
fprintf(out, ", 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.get(i), ws.getName(i)");
} else {
fprintf(out, ", arg%d", argIndex);
}
}
fprintf(out, ");\n");
fprintf(out, " }\n"); // close for-loop
// write() component.
fprintf(out, " ArrayList<WorkSource.WorkChain> workChains = ws.getWorkChains();\n");
fprintf(out, " if (workChains != null) {\n");
fprintf(out, " for (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

75
tools/stats_log_api_gen/utils.h Normal file
View File

@@ -0,0 +1,75 @@
/*
* 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.
*/
#pragma once
#include "Collation.h"
#include <map>
#include <set>
#include <vector>
#include <stdio.h>
#include <string.h>
namespace android {
namespace stats_log_api_gen {
using namespace std;
const string DEFAULT_MODULE_NAME = "DEFAULT";
const string DEFAULT_CPP_NAMESPACE = "android,util";
const string DEFAULT_CPP_HEADER_IMPORT = "statslog.h";
const string DEFAULT_JAVA_PACKAGE = "android.util";
const string DEFAULT_JAVA_CLASS = "StatsLogInternal";
const int JAVA_MODULE_REQUIRES_FLOAT = 0x01;
const int JAVA_MODULE_REQUIRES_ATTRIBUTION = 0x02;
string make_constant_name(const string& str);
const char* cpp_type_name(java_type_t type);
const char* java_type_name(java_type_t type);
bool atom_needed_for_module(const AtomDecl& atomDecl, const string& moduleName);
bool signature_needed_for_module(const set<string>& modules, const string& moduleName);
void build_non_chained_decl_map(const Atoms& atoms,
std::map<int, set<AtomDecl>::const_iterator>* decl_map);
// Common Java helpers.
void write_java_atom_codes(FILE* out, const Atoms& atoms, const string& moduleName);
void write_java_enum_values(FILE* out, const Atoms& atoms, const string& moduleName);
void write_java_usage(FILE* out, const string& method_name, const string& atom_code_name,
const AtomDecl& atom);
int write_java_non_chained_methods(FILE* out, const map<vector<java_type_t>,
set<string>>& signatures_to_modules,
const string& moduleName
);
int write_java_work_source_methods(
FILE* out,
const map<vector<java_type_t>, set<string>>& signatures_to_modules,
const string& moduleName
);
} // namespace stats_log_api_gen
} // namespace android