19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.util; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport com.android.internal.os.RuntimeInit; 208c84109b9fbbf473b225707a38261ff5f99d95fbDianne Hackbornimport com.android.internal.util.FastPrintWriter; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.PrintWriter; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.StringWriter; 24dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onoratoimport java.net.UnknownHostException; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * API for sending log output. 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Generally, use the Log.v() Log.d() Log.i() Log.w() and Log.e() 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * methods. 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>The order in terms of verbosity, from least to most is 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ERROR, WARN, INFO, DEBUG, VERBOSE. Verbose should never be compiled 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * into an application except during development. Debug logs are compiled 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in but stripped at runtime. Error, warning and info logs are always kept. 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Tip:</b> A good convention is to declare a <code>TAG</code> constant 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * in your class: 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre>private static final String TAG = "MyActivity";</pre> 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and use that in subsequent calls to the log methods. 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </p> 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p><b>Tip:</b> Don't forget that when you make a call like 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <pre>Log.v(TAG, "index=" + i);</pre> 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that when you're building the string to pass into Log.d, the compiler uses a 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * StringBuilder and at least three allocations occur: the StringBuilder 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * itself, the buffer, and the String object. Realistically, there is also 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * another buffer allocation and copy, and even more pressure on the gc. 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * That means that if your log message is filtered out, you might be doing 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * significant work and incurring significant overhead. 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic final class Log { 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Priority constant for the println method; use Log.v. 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int VERBOSE = 2; 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Priority constant for the println method; use Log.d. 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int DEBUG = 3; 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Priority constant for the println method; use Log.i. 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int INFO = 4; 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Priority constant for the println method; use Log.w. 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int WARN = 5; 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Priority constant for the println method; use Log.e. 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int ERROR = 6; 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Priority constant for the println method. 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final int ASSERT = 7; 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 8660d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor /** 87164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn * Exception class used to capture a stack trace in {@link #wtf}. 8860d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor */ 8960d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor private static class TerribleFailure extends Exception { 9060d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor TerribleFailure(String msg, Throwable cause) { super(msg, cause); } 9160d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor } 9260d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor 9344dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick /** 94164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn * Interface to handle terrible failures from {@link #wtf}. 9544dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick * 9644dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick * @hide 9744dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick */ 9844dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick public interface TerribleFailureHandler { 995232271a41323594ae406be7476b6ca2f08af3d8Dianne Hackborn void onTerribleFailure(String tag, TerribleFailure what, boolean system); 10044dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick } 10144dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick 10244dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick private static TerribleFailureHandler sWtfHandler = new TerribleFailureHandler() { 1035232271a41323594ae406be7476b6ca2f08af3d8Dianne Hackborn public void onTerribleFailure(String tag, TerribleFailure what, boolean system) { 1045232271a41323594ae406be7476b6ca2f08af3d8Dianne Hackborn RuntimeInit.wtf(tag, what, system); 10544dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick } 10644dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick }; 10744dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Log() { 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send a {@link #VERBOSE} log message. 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int v(String tag, String msg) { 11800bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, VERBOSE, tag, msg); 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send a {@link #VERBOSE} log message and log the exception. 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tr An exception to log 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int v(String tag, String msg, Throwable tr) { 12900bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, VERBOSE, tag, msg + '\n' + getStackTraceString(tr)); 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send a {@link #DEBUG} log message. 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int d(String tag, String msg) { 13900bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, DEBUG, tag, msg); 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send a {@link #DEBUG} log message and log the exception. 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tr An exception to log 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int d(String tag, String msg, Throwable tr) { 15000bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, DEBUG, tag, msg + '\n' + getStackTraceString(tr)); 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send an {@link #INFO} log message. 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int i(String tag, String msg) { 16000bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, INFO, tag, msg); 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send a {@link #INFO} log message and log the exception. 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tr An exception to log 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int i(String tag, String msg, Throwable tr) { 17100bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, INFO, tag, msg + '\n' + getStackTraceString(tr)); 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send a {@link #WARN} log message. 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int w(String tag, String msg) { 18100bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, WARN, tag, msg); 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send a {@link #WARN} log message and log the exception. 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tr An exception to log 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int w(String tag, String msg, Throwable tr) { 19200bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, WARN, tag, msg + '\n' + getStackTraceString(tr)); 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Checks to see whether or not a log for the specified tag is loggable at the specified level. 19760d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The default level of any tag is set to INFO. This means that any level above and including 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * INFO will be logged. Before you make any calls to a logging method you should check to see 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if your tag should be logged. You can change the default level by setting a system property: 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 'setprop log.tag.<YOUR_LOG_TAG> <LEVEL>' 20260d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * Where level is either VERBOSE, DEBUG, INFO, WARN, ERROR, ASSERT, or SUPPRESS. SUPPRESS will 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * turn off all logging for your tag. You can also create a local.prop file that with the 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * following in it: 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 'log.tag.<YOUR_LOG_TAG>=<LEVEL>' 2069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * and place that in /data/local.prop. 20760d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * 2089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag The tag to check. 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param level The level to check. 2109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Whether or not that this is allowed to be logged. 2119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws IllegalArgumentException is thrown if the tag.length() > 23. 2129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static native boolean isLoggable(String tag, int level); 21460d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor 2159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* 2169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send a {@link #WARN} log message and log the exception. 2179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 2189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 2199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tr An exception to log 2209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int w(String tag, Throwable tr) { 22200bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, WARN, tag, getStackTraceString(tr)); 2239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send an {@link #ERROR} log message. 2279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 2289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 2299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 2309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int e(String tag, String msg) { 23200bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, ERROR, tag, msg); 2339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Send a {@link #ERROR} log message and log the exception. 2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 2399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tr An exception to log 2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static int e(String tag, String msg, Throwable tr) { 24300bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, ERROR, tag, msg + '\n' + getStackTraceString(tr)); 2449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 24760d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * What a Terrible Failure: Report a condition that should never happen. 24860d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * The error will always be logged at level ASSERT with the call stack. 24960d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * Depending on system configuration, a report may be added to the 25060d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * {@link android.os.DropBoxManager} and/or the process may be terminated 25160d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * immediately with an error dialog. 25260d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * @param tag Used to identify the source of a log message. 25360d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * @param msg The message you would like logged. 25460d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor */ 25560d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor public static int wtf(String tag, String msg) { 2565232271a41323594ae406be7476b6ca2f08af3d8Dianne Hackborn return wtf(LOG_ID_MAIN, tag, msg, null, false, false); 25760d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor } 25860d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor 25960d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor /** 260164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn * Like {@link #wtf(String, String)}, but also writes to the log the full 261164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn * call stack. 262164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn * @hide 263164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn */ 264164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn public static int wtfStack(String tag, String msg) { 2655232271a41323594ae406be7476b6ca2f08af3d8Dianne Hackborn return wtf(LOG_ID_MAIN, tag, msg, null, true, false); 266164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn } 267164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn 268164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn /** 26960d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * What a Terrible Failure: Report an exception that should never happen. 27060d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * Similar to {@link #wtf(String, String)}, with an exception to log. 27160d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * @param tag Used to identify the source of a log message. 27260d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * @param tr An exception to log. 27360d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor */ 27460d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor public static int wtf(String tag, Throwable tr) { 2755232271a41323594ae406be7476b6ca2f08af3d8Dianne Hackborn return wtf(LOG_ID_MAIN, tag, tr.getMessage(), tr, false, false); 27660d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor } 27760d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor 27860d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor /** 27960d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * What a Terrible Failure: Report an exception that should never happen. 28060d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * Similar to {@link #wtf(String, Throwable)}, with a message as well. 28160d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * @param tag Used to identify the source of a log message. 28260d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * @param msg The message you would like logged. 28360d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor * @param tr An exception to log. May be null. 28460d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor */ 28560d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor public static int wtf(String tag, String msg, Throwable tr) { 2865232271a41323594ae406be7476b6ca2f08af3d8Dianne Hackborn return wtf(LOG_ID_MAIN, tag, msg, tr, false, false); 287164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn } 288164371fb759bad6854570af0fca60d9a01e17235Dianne Hackborn 2895232271a41323594ae406be7476b6ca2f08af3d8Dianne Hackborn static int wtf(int logId, String tag, String msg, Throwable tr, boolean localStack, 2905232271a41323594ae406be7476b6ca2f08af3d8Dianne Hackborn boolean system) { 29144dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick TerribleFailure what = new TerribleFailure(msg, tr); 2922d073ba83c570466a7f77d1cd9193ab4a60eaee4Christopher Ferris // Only mark this as ERROR, do not use ASSERT since that should be 2932d073ba83c570466a7f77d1cd9193ab4a60eaee4Christopher Ferris // reserved for cases where the system is guaranteed to abort. 2942d073ba83c570466a7f77d1cd9193ab4a60eaee4Christopher Ferris // The onTerribleFailure call does not always cause a crash. 2952d073ba83c570466a7f77d1cd9193ab4a60eaee4Christopher Ferris int bytes = println_native(logId, ERROR, tag, msg + '\n' 296878deb3c7b33a0c508137143c776e07bab0296cfDianne Hackborn + getStackTraceString(localStack ? what : tr)); 2975232271a41323594ae406be7476b6ca2f08af3d8Dianne Hackborn sWtfHandler.onTerribleFailure(tag, what, system); 29860d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor return bytes; 29960d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor } 30060d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor 3011e01d16982e6b22ec4c0e2d6dc1e261eb6f92c8eDianne Hackborn static void wtfQuiet(int logId, String tag, String msg, boolean system) { 3021e01d16982e6b22ec4c0e2d6dc1e261eb6f92c8eDianne Hackborn TerribleFailure what = new TerribleFailure(msg, null); 3031e01d16982e6b22ec4c0e2d6dc1e261eb6f92c8eDianne Hackborn sWtfHandler.onTerribleFailure(tag, what, system); 3041e01d16982e6b22ec4c0e2d6dc1e261eb6f92c8eDianne Hackborn } 3051e01d16982e6b22ec4c0e2d6dc1e261eb6f92c8eDianne Hackborn 30660d8762413e8daba5f73559786312a9ec5e3b827Dan Egnor /** 30744dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick * Sets the terrible failure handler, for testing. 30844dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick * 30944dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick * @return the old handler 31044dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick * 31144dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick * @hide 31244dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick */ 31344dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick public static TerribleFailureHandler setWtfHandler(TerribleFailureHandler handler) { 31444dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick if (handler == null) { 31544dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick throw new NullPointerException("handler == null"); 31644dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick } 31744dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick TerribleFailureHandler oldHandler = sWtfHandler; 31844dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick sWtfHandler = handler; 31944dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick return oldHandler; 32044dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick } 32144dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick 32244dc76a8a702d6a919fcea1c2d19ba3792687c85Brad Fitzpatrick /** 3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Handy function to get a loggable stack trace from a Throwable 3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tr An exception to log 3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static String getStackTraceString(Throwable tr) { 3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (tr == null) { 3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return ""; 3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 330dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato 331dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato // This is to reduce the amount of log spew that apps do in the non-error 332dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato // condition of the network being unavailable. 333dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato Throwable t = tr; 334dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato while (t != null) { 335dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato if (t instanceof UnknownHostException) { 336dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato return ""; 337dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato } 338dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato t = t.getCause(); 339dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato } 340dba50c7ed24e05ff349a94b8c4a6d9bb9050973bJoe Onorato 3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project StringWriter sw = new StringWriter(); 3428c84109b9fbbf473b225707a38261ff5f99d95fbDianne Hackborn PrintWriter pw = new FastPrintWriter(sw, false, 256); 3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project tr.printStackTrace(pw); 3448c84109b9fbbf473b225707a38261ff5f99d95fbDianne Hackborn pw.flush(); 3459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return sw.toString(); 3469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Low-level logging call. 3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param priority The priority/type of this log message 3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param tag Used to identify the source of a log message. It usually identifies 3529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the class or activity where the log call occurs. 3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param msg The message you would like logged. 3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The number of bytes written. 3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 35600bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato public static int println(int priority, String tag, String msg) { 35700bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato return println_native(LOG_ID_MAIN, priority, tag, msg); 35800bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato } 35900bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato 3608a9b22056b13477f59df934928c00c58b5871c95Joe Onorato /** @hide */ public static final int LOG_ID_MAIN = 0; 3618a9b22056b13477f59df934928c00c58b5871c95Joe Onorato /** @hide */ public static final int LOG_ID_RADIO = 1; 3628a9b22056b13477f59df934928c00c58b5871c95Joe Onorato /** @hide */ public static final int LOG_ID_EVENTS = 2; 3638a9b22056b13477f59df934928c00c58b5871c95Joe Onorato /** @hide */ public static final int LOG_ID_SYSTEM = 3; 36469eb6f57e34fb78050adcedcda8479cf2ad0c418Mark Salyzyn /** @hide */ public static final int LOG_ID_CRASH = 4; 36500bb93823d082c31d757bd7b75a8615afbd2c1a5Joe Onorato 3668a9b22056b13477f59df934928c00c58b5871c95Joe Onorato /** @hide */ public static native int println_native(int bufID, 3678a9b22056b13477f59df934928c00c58b5871c95Joe Onorato int priority, String tag, String msg); 3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 369