Merge cherrypicks of ['googleplex-android-review.googlesource.com/28207892',... (34fbd349) · Commits · e / os / android_frameworks_base

core/java/com/android/internal/protolog/LegacyProtoLogImpl.java

+12 −23

Original line number	Diff line number	Diff line
		@@ -48,7 +48,6 @@ import java.io.File;
		import java.io.IOException;
		import java.io.PrintWriter;
		import java.util.ArrayList;
		import java.util.Map;
		import java.util.TreeMap;
		import java.util.stream.Collectors;

		@@ -66,7 +65,7 @@ public class LegacyProtoLogImpl implements IProtoLog {
		private final String mLegacyViewerConfigFilename;
		private final TraceBuffer mBuffer;
		private final LegacyProtoLogViewerConfigReader mViewerConfig;
		private final Map<String, IProtoLogGroup> mLogGroups = new TreeMap<>();
		private final TreeMap<String, IProtoLogGroup> mLogGroups;
		private final Runnable mCacheUpdater;
		private final int mPerChunkSize;

		@@ -75,19 +74,20 @@ public class LegacyProtoLogImpl implements IProtoLog {
		private final Object mProtoLogEnabledLock = new Object();

		public LegacyProtoLogImpl(String outputFile, String viewerConfigFilename,
		Runnable cacheUpdater) {
		TreeMap<String, IProtoLogGroup> logGroups, Runnable cacheUpdater) {
		this(new File(outputFile), viewerConfigFilename, BUFFER_CAPACITY,
		new LegacyProtoLogViewerConfigReader(), PER_CHUNK_SIZE, cacheUpdater);
		new LegacyProtoLogViewerConfigReader(), PER_CHUNK_SIZE, logGroups, cacheUpdater);
		}

		public LegacyProtoLogImpl(File file, String viewerConfigFilename, int bufferCapacity,
		LegacyProtoLogViewerConfigReader viewerConfig, int perChunkSize,
		Runnable cacheUpdater) {
		TreeMap<String, IProtoLogGroup> logGroups, Runnable cacheUpdater) {
		mLogFile = file;
		mBuffer = new TraceBuffer(bufferCapacity);
		mLegacyViewerConfigFilename = viewerConfigFilename;
		mViewerConfig = viewerConfig;
		mPerChunkSize = perChunkSize;
		mLogGroups = logGroups;
		mCacheUpdater = cacheUpdater;
		}

		@@ -97,25 +97,21 @@ public class LegacyProtoLogImpl implements IProtoLog {
		@VisibleForTesting
		@Override
		public void log(LogLevel level, IProtoLogGroup group, long messageHash, int paramsMask,
		Object[] args) {
		@Nullable String messageString, Object[] args) {
		if (group.isLogToProto()) {
		logToProto(messageHash, paramsMask, args);
		}
		if (group.isLogToLogcat()) {
		logToLogcat(group.getTag(), level, messageHash, args);
		logToLogcat(group.getTag(), level, messageHash, messageString, args);
		}
		}

		@Override
		public void log(LogLevel logLevel, IProtoLogGroup group, String messageString, Object... args) {
		// This will be removed very soon so no point implementing it here.
		throw new IllegalStateException(
		"Not implemented. Only implemented for PerfettoProtoLogImpl.");
		}

		private void logToLogcat(String tag, LogLevel level, long messageHash, Object[] args) {
		private void logToLogcat(String tag, LogLevel level, long messageHash,
		@Nullable String messageString, Object[] args) {
		String message = null;
		final String messageString = mViewerConfig.getViewerString(messageHash);
		if (messageString == null) {
		messageString = mViewerConfig.getViewerString(messageHash);
		}
		if (messageString != null) {
		if (args != null) {
		try {
		@@ -414,12 +410,5 @@ public class LegacyProtoLogImpl implements IProtoLog {
		// so we ignore the level argument to this function.
		return group.isLogToLogcat() \|\| (group.isLogToProto() && isProtoEnabled());
		}

		@Override
		public void registerGroups(IProtoLogGroup... protoLogGroups) {
		for (IProtoLogGroup group : protoLogGroups) {
		mLogGroups.put(group.name(), group);
		}
		}
		}

core/java/com/android/internal/protolog/LogcatOnlyProtoLogImpl.java

deleted100644 → 0

+0 −80

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2024 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.
		*/

		package com.android.internal.protolog;

		import android.text.TextUtils;
		import android.util.Log;

		import com.android.internal.protolog.common.ILogger;
		import com.android.internal.protolog.common.IProtoLog;
		import com.android.internal.protolog.common.IProtoLogGroup;
		import com.android.internal.protolog.common.LogLevel;

		/**
		* Class only create and used to server temporarily for when there is source code pre-processing by
		* the ProtoLog tool, when the tracing to Perfetto flag is off, and the static REQUIRE_PROTOLOGTOOL
		* boolean is false. In which case we simply want to log protolog message to logcat. Note, that this
		* means that in such cases there is no real advantage of using protolog over logcat.
		*
		* @deprecated Should not be used. This is just a temporary class to support a legacy behavior.
		*/
		@Deprecated
		public class LogcatOnlyProtoLogImpl implements IProtoLog {
		@Override
		public void log(LogLevel logLevel, IProtoLogGroup group, long messageHash, int paramsMask,
		Object[] args) {
		throw new RuntimeException("Not supported when using LogcatOnlyProtoLogImpl");
		}

		@Override
		public void log(LogLevel logLevel, IProtoLogGroup group, String messageString, Object[] args) {
		String formattedString = TextUtils.formatSimple(messageString, args);
		switch (logLevel) {
		case VERBOSE -> Log.v(group.getTag(), formattedString);
		case INFO -> Log.i(group.getTag(), formattedString);
		case DEBUG -> Log.d(group.getTag(), formattedString);
		case WARN -> Log.w(group.getTag(), formattedString);
		case ERROR -> Log.e(group.getTag(), formattedString);
		case WTF -> Log.wtf(group.getTag(), formattedString);
		}
		}

		@Override
		public boolean isProtoEnabled() {
		return false;
		}

		@Override
		public int startLoggingToLogcat(String[] groups, ILogger logger) {
		return 0;
		}

		@Override
		public int stopLoggingToLogcat(String[] groups, ILogger logger) {
		return 0;
		}

		@Override
		public boolean isEnabled(IProtoLogGroup group, LogLevel level) {
		return true;
		}

		@Override
		public void registerGroups(IProtoLogGroup... protoLogGroups) {
		// Does nothing
		}
		}

core/java/com/android/internal/protolog/PerfettoProtoLogImpl.java

+105 −304

File changed.

Preview size limit exceeded, changes collapsed.

core/java/com/android/internal/protolog/ProtoLog.java

+39 −60

Original line number	Diff line number	Diff line
		@@ -44,23 +44,21 @@ public class ProtoLog {
		// LINT.ThenChange(frameworks/base/tools/protologtool/src/com/android/protolog/tool/ProtoLogTool.kt)

		// Needs to be set directly otherwise the protologtool tries to transform the method call
		@Deprecated
		public static boolean REQUIRE_PROTOLOGTOOL = true;

		private static IProtoLog sProtoLogInstance;

		/**
		* DEBUG level log.
		*
		* @param group {@code IProtoLogGroup} controlling this log call.
		* @param messageString constant format string for the logged message.
		* @param args parameters to be used with the format string.
		*
		* NOTE: If source code is pre-processed by ProtoLogTool this is not the function call that is
		* executed. Check generated code for actual call.
		*/
		public static void d(IProtoLogGroup group, String messageString, Object... args) {
		logStringMessage(LogLevel.DEBUG, group, messageString, args);
		// Stub, replaced by the ProtoLogTool.
		if (REQUIRE_PROTOLOGTOOL) {
		throw new UnsupportedOperationException(
		"ProtoLog calls MUST be processed with ProtoLogTool");
		}
		}

		/**
		@@ -69,12 +67,13 @@ public class ProtoLog {
		* @param group {@code IProtoLogGroup} controlling this log call.
		* @param messageString constant format string for the logged message.
		* @param args parameters to be used with the format string.
		*
		* NOTE: If source code is pre-processed by ProtoLogTool this is not the function call that is
		* executed. Check generated code for actual call.
		*/
		public static void v(IProtoLogGroup group, String messageString, Object... args) {
		logStringMessage(LogLevel.VERBOSE, group, messageString, args);
		// Stub, replaced by the ProtoLogTool.
		if (REQUIRE_PROTOLOGTOOL) {
		throw new UnsupportedOperationException(
		"ProtoLog calls MUST be processed with ProtoLogTool");
		}
		}

		/**
		@@ -83,12 +82,13 @@ public class ProtoLog {
		* @param group {@code IProtoLogGroup} controlling this log call.
		* @param messageString constant format string for the logged message.
		* @param args parameters to be used with the format string.
		*
		* NOTE: If source code is pre-processed by ProtoLogTool this is not the function call that is
		* executed. Check generated code for actual call.
		*/
		public static void i(IProtoLogGroup group, String messageString, Object... args) {
		logStringMessage(LogLevel.INFO, group, messageString, args);
		// Stub, replaced by the ProtoLogTool.
		if (REQUIRE_PROTOLOGTOOL) {
		throw new UnsupportedOperationException(
		"ProtoLog calls MUST be processed with ProtoLogTool");
		}
		}

		/**
		@@ -97,12 +97,13 @@ public class ProtoLog {
		* @param group {@code IProtoLogGroup} controlling this log call.
		* @param messageString constant format string for the logged message.
		* @param args parameters to be used with the format string.
		*
		* NOTE: If source code is pre-processed by ProtoLogTool this is not the function call that is
		* executed. Check generated code for actual call.
		*/
		public static void w(IProtoLogGroup group, String messageString, Object... args) {
		logStringMessage(LogLevel.WARN, group, messageString, args);
		// Stub, replaced by the ProtoLogTool.
		if (REQUIRE_PROTOLOGTOOL) {
		throw new UnsupportedOperationException(
		"ProtoLog calls MUST be processed with ProtoLogTool");
		}
		}

		/**
		@@ -111,12 +112,13 @@ public class ProtoLog {
		* @param group {@code IProtoLogGroup} controlling this log call.
		* @param messageString constant format string for the logged message.
		* @param args parameters to be used with the format string.
		*
		* NOTE: If source code is pre-processed by ProtoLogTool this is not the function call that is
		* executed. Check generated code for actual call.
		*/
		public static void e(IProtoLogGroup group, String messageString, Object... args) {
		logStringMessage(LogLevel.ERROR, group, messageString, args);
		// Stub, replaced by the ProtoLogTool.
		if (REQUIRE_PROTOLOGTOOL) {
		throw new UnsupportedOperationException(
		"ProtoLog calls MUST be processed with ProtoLogTool");
		}
		}

		/**
		@@ -125,12 +127,13 @@ public class ProtoLog {
		* @param group {@code IProtoLogGroup} controlling this log call.
		* @param messageString constant format string for the logged message.
		* @param args parameters to be used with the format string.
		*
		* NOTE: If source code is pre-processed by ProtoLogTool this is not the function call that is
		* executed. Check generated code for actual call.
		*/
		public static void wtf(IProtoLogGroup group, String messageString, Object... args) {
		logStringMessage(LogLevel.WTF, group, messageString, args);
		// Stub, replaced by the ProtoLogTool.
		if (REQUIRE_PROTOLOGTOOL) {
		throw new UnsupportedOperationException(
		"ProtoLog calls MUST be processed with ProtoLogTool");
		}
		}

		/**
		@@ -139,7 +142,11 @@ public class ProtoLog {
		* @return true iff this is being logged.
		*/
		public static boolean isEnabled(IProtoLogGroup group, LogLevel level) {
		return sProtoLogInstance.isEnabled(group, level);
		if (REQUIRE_PROTOLOGTOOL) {
		throw new UnsupportedOperationException(
		"ProtoLog calls MUST be processed with ProtoLogTool");
		}
		return false;
		}

		/**
		@@ -147,38 +154,10 @@ public class ProtoLog {
		* @return A singleton instance of ProtoLog.
		*/
		public static IProtoLog getSingleInstance() {
		return sProtoLogInstance;
		}

		/**
		* Registers available protolog groups. A group must be registered before it can be used.
		* @param protoLogGroups The groups to register for use in protolog.
		*/
		public static void registerGroups(IProtoLogGroup... protoLogGroups) {
		sProtoLogInstance.registerGroups(protoLogGroups);
		}

		private static void logStringMessage(LogLevel logLevel, IProtoLogGroup group,
		String stringMessage, Object... args) {
		if (sProtoLogInstance == null) {
		throw new IllegalStateException(
		"Trying to use ProtoLog before it is initialized in this process.");
		}

		if (sProtoLogInstance.isEnabled(group, logLevel)) {
		sProtoLogInstance.log(logLevel, group, stringMessage, args);
		}
		}

		static {
		if (android.tracing.Flags.perfettoProtologTracing()) {
		sProtoLogInstance = new PerfettoProtoLogImpl();
		} else {
		if (REQUIRE_PROTOLOGTOOL) {
		throw new RuntimeException("REQUIRE_PROTOLOGTOOL not set to false.");
		} else {
		sProtoLogInstance = new LogcatOnlyProtoLogImpl();
		}
		throw new UnsupportedOperationException(
		"ProtoLog calls MUST be processed with ProtoLogTool");
		}
		return null;
		}
		}

core/java/com/android/internal/protolog/ProtoLogDataSource.java

+0 −3

Original line number	Diff line number	Diff line
		@@ -40,7 +40,6 @@ import com.android.internal.protolog.common.LogLevel;

		import java.io.IOException;
		import java.util.HashMap;
		import java.util.HashSet;
		import java.util.Map;
		import java.util.Set;
		import java.util.function.Consumer;
		@@ -139,8 +138,6 @@ public class ProtoLogDataSource extends DataSource<ProtoLogDataSource.Instance,
		}

		public static class IncrementalState {
		public final Set<Integer> protologGroupInterningSet = new HashSet<>();
		public final Set<Long> protologMessageInterningSet = new HashSet<>();
		public final Map<String, Integer> argumentInterningMap = new HashMap<>();
		public final Map<String, Integer> stacktraceInterningMap = new HashMap<>();
		public boolean clearReported = false;