Promote Slog to @SystemApi(client = Client.MODULE_LIBS) (130228bf) · Commits · e / os / android_frameworks_base

core/api/module-lib-current.txt

+19 −0

Original line number	Diff line number	Diff line
		@@ -466,6 +466,25 @@ package android.util {
		method public static int logToRadioBuffer(int, @Nullable String, @Nullable String);
		}

		public final class Slog {
		method public static int d(@Nullable String, @NonNull String);
		method public static int d(@Nullable String, @NonNull String, @Nullable Throwable);
		method public static int e(@Nullable String, @NonNull String);
		method public static int e(@Nullable String, @NonNull String, @Nullable Throwable);
		method public static int i(@Nullable String, @NonNull String);
		method public static int i(@Nullable String, @NonNull String, @Nullable Throwable);
		method public static int v(@Nullable String, @NonNull String);
		method public static int v(@Nullable String, @NonNull String, @Nullable Throwable);
		method public static int w(@Nullable String, @NonNull String);
		method public static int w(@Nullable String, @NonNull String, @Nullable Throwable);
		method public static int w(@Nullable String, @Nullable Throwable);
		method public static int wtf(@Nullable String, @NonNull String);
		method public static int wtf(@Nullable String, @Nullable Throwable);
		method public static int wtf(@Nullable String, @NonNull String, @Nullable Throwable);
		method public static void wtfQuiet(@Nullable String, @NonNull String);
		method public static int wtfStack(@Nullable String, @NonNull String);
		}

		public class SystemConfigFileCommitEventLogger {
		ctor public SystemConfigFileCommitEventLogger(@NonNull String);
		method public void setStartTime(long);

core/java/android/util/Slog.java

+180 −30

Original line number	Diff line number	Diff line
		@@ -16,6 +16,9 @@

		package android.util;

		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.annotation.SystemApi;
		import android.compat.annotation.UnsupportedAppUsage;
		import android.os.Build;

		@@ -24,118 +27,265 @@ import android.os.Build;
		*
		* <p>Should be used by system components. Use {@code adb logcat --buffer=system} to fetch the logs.
		*
		* @see Log
		* @hide
		*/
		@SystemApi(client = SystemApi.Client.MODULE_LIBRARIES)
		public final class Slog {

		private Slog() {
		}

		/**
		* Logs {@code msg} at {@link Log#VERBOSE} level.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		*
		* @see Log#v(String, String)
		*/
		@UnsupportedAppUsage
		public static int v(String tag, String msg) {
		public static int v(@Nullable String tag, @NonNull String msg) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.VERBOSE, tag, msg);
		}

		public static int v(String tag, String msg, Throwable tr) {
		/**
		* Logs {@code msg} at {@link Log#VERBOSE} level, attaching stack trace of the {@code tr} to
		* the end of the log statement.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		* @param tr an exception to log.
		*
		* @see Log#v(String, String, Throwable)
		*/
		public static int v(@Nullable String tag, @NonNull String msg, @Nullable Throwable tr) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.VERBOSE, tag,
		msg + '\n' + Log.getStackTraceString(tr));
		}

		/**
		* Logs {@code msg} at {@link Log#DEBUG} level.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		*
		* @see Log#d(String, String)
		*/
		@UnsupportedAppUsage
		public static int d(String tag, String msg) {
		public static int d(@Nullable String tag, @NonNull String msg) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.DEBUG, tag, msg);
		}

		/**
		* Logs {@code msg} at {@link Log#DEBUG} level, attaching stack trace of the {@code tr} to
		* the end of the log statement.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		* @param tr an exception to log.
		*
		* @see Log#d(String, String, Throwable)
		*/
		@UnsupportedAppUsage
		public static int d(String tag, String msg, Throwable tr) {
		public static int d(@Nullable String tag, @NonNull String msg, @Nullable Throwable tr) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.DEBUG, tag,
		msg + '\n' + Log.getStackTraceString(tr));
		}

		/**
		* Logs {@code msg} at {@link Log#INFO} level.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		*
		* @see Log#i(String, String)
		*/
		@UnsupportedAppUsage
		public static int i(String tag, String msg) {
		public static int i(@Nullable String tag, @NonNull String msg) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.INFO, tag, msg);
		}

		public static int i(String tag, String msg, Throwable tr) {
		/**
		* Logs {@code msg} at {@link Log#INFO} level, attaching stack trace of the {@code tr} to
		* the end of the log statement.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		* @param tr an exception to log.
		*
		* @see Log#i(String, String, Throwable)
		*/
		public static int i(@Nullable String tag, @NonNull String msg, @Nullable Throwable tr) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.INFO, tag,
		msg + '\n' + Log.getStackTraceString(tr));
		}

		/**
		* Logs {@code msg} at {@link Log#WARN} level.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		*
		* @see Log#w(String, String)
		*/
		@UnsupportedAppUsage
		public static int w(String tag, String msg) {
		public static int w(@Nullable String tag, @NonNull String msg) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.WARN, tag, msg);
		}

		/**
		* Logs {@code msg} at {@link Log#WARN} level, attaching stack trace of the {@code tr} to
		* the end of the log statement.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		* @param tr an exception to log.
		*
		* @see Log#w(String, String, Throwable)
		*/
		@UnsupportedAppUsage
		public static int w(String tag, String msg, Throwable tr) {
		public static int w(@Nullable String tag, @NonNull String msg, @Nullable Throwable tr) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.WARN, tag,
		msg + '\n' + Log.getStackTraceString(tr));
		}

		public static int w(String tag, Throwable tr) {
		/**
		* Logs stack trace of {@code tr} at {@link Log#WARN} level.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param tr an exception to log.
		*
		* @see Log#w(String, Throwable)
		*/
		public static int w(@Nullable String tag, @Nullable Throwable tr) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.WARN, tag, Log.getStackTraceString(tr));
		}

		/**
		* Logs {@code msg} at {@link Log#ERROR} level.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		*
		* @see Log#e(String, String)
		*/
		@UnsupportedAppUsage
		public static int e(String tag, String msg) {
		public static int e(@Nullable String tag, @NonNull String msg) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.ERROR, tag, msg);
		}

		/**
		* Logs {@code msg} at {@link Log#ERROR} level, attaching stack trace of the {@code tr} to
		* the end of the log statement.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		* @param tr an exception to log.
		*
		* @see Log#e(String, String, Throwable)
		*/
		@UnsupportedAppUsage
		public static int e(String tag, String msg, Throwable tr) {
		public static int e(@Nullable String tag, @NonNull String msg, @Nullable Throwable tr) {
		return Log.println_native(Log.LOG_ID_SYSTEM, Log.ERROR, tag,
		msg + '\n' + Log.getStackTraceString(tr));
		}

		/**
		* Like {@link Log#wtf(String, String)}, but will never cause the caller to crash, and
		* will always be handled asynchronously. Primarily for use by coding running within
		* the system process.
		* Logs a condition that should never happen.
		*
		* <p>
		* Similar to {@link Log#wtf(String, String)}, but will never cause the caller to crash, and
		* will always be handled asynchronously. Primarily to be used by the system server.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		*
		* @see Log#wtf(String, String)
		*/
		@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
		public static int wtf(String tag, String msg) {
		public static int wtf(@Nullable String tag, @NonNull String msg) {
		return Log.wtf(Log.LOG_ID_SYSTEM, tag, msg, null, false, true);
		}

		/**
		* Like {@link #wtf(String, String)}, but does not output anything to the log.
		* Similar to {@link #wtf(String, String)}, but does not output anything to the log.
		*/
		public static void wtfQuiet(String tag, String msg) {
		public static void wtfQuiet(@Nullable String tag, @NonNull String msg) {
		Log.wtfQuiet(Log.LOG_ID_SYSTEM, tag, msg, true);
		}

		/**
		* Like {@link Log#wtfStack(String, String)}, but will never cause the caller to crash, and
		* will always be handled asynchronously. Primarily for use by coding running within
		* the system process.
		* Logs a condition that should never happen, attaching the full call stack to the log.
		*
		* <p>
		* Similar to {@link Log#wtfStack(String, String)}, but will never cause the caller to crash,
		* and will always be handled asynchronously. Primarily to be used by the system server.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		*
		* @see Log#wtfStack(String, String)
		*/
		@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023)
		public static int wtfStack(String tag, String msg) {
		public static int wtfStack(@Nullable String tag, @NonNull String msg) {
		return Log.wtf(Log.LOG_ID_SYSTEM, tag, msg, null, true, true);
		}

		/**
		* Like {@link Log#wtf(String, Throwable)}, but will never cause the caller to crash,
		* and will always be handled asynchronously. Primarily for use by coding running within
		* the system process.
		* Logs a condition that should never happen, attaching stack trace of the {@code tr} to the
		* end of the log statement.
		*
		* <p>
		* Similar to {@link Log#wtf(String, Throwable)}, but will never cause the caller to crash,
		* and will always be handled asynchronously. Primarily to be used by the system server.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param tr an exception to log.
		*
		* @see Log#wtf(String, Throwable)
		*/
		public static int wtf(String tag, Throwable tr) {
		public static int wtf(@Nullable String tag, @Nullable Throwable tr) {
		return Log.wtf(Log.LOG_ID_SYSTEM, tag, tr.getMessage(), tr, false, true);
		}

		/**
		* Like {@link Log#wtf(String, String, Throwable)}, but will never cause the caller to crash,
		* and will always be handled asynchronously. Primarily for use by coding running within
		* the system process.
		* Logs a condition that should never happen, attaching stack trace of the {@code tr} to the
		* end of the log statement.
		*
		* <p>
		* Similar to {@link Log#wtf(String, String, Throwable)}, but will never cause the caller to
		* crash, and will always be handled asynchronously. Primarily to be used by the system server.
		*
		* @param tag identifies the source of a log message. It usually represents system service,
		* e.g. {@code PackageManager}.
		* @param msg the message to log.
		* @param tr an exception to log.
		*
		* @see Log#wtf(String, String, Throwable)
		*/
		@UnsupportedAppUsage
		public static int wtf(String tag, String msg, Throwable tr) {
		public static int wtf(@Nullable String tag, @NonNull String msg, @Nullable Throwable tr) {
		return Log.wtf(Log.LOG_ID_SYSTEM, tag, msg, tr, false, true);
		}

		/** @hide */
		@UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.R, trackingBug = 170729553)
		public static int println(int priority, String tag, String msg) {
		public static int println(@Log.Level int priority, @Nullable String tag, @NonNull String msg) {
		return Log.println_native(Log.LOG_ID_SYSTEM, priority, tag, msg);
		}
		}