Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 5513817c authored by Lee Shombert's avatar Lee Shombert
Browse files

Avoid ANRs in dumpCacheInfo 

Bug: 233566891

PropertyInvalidatedCache.dumpCacheInfo() sometimes triggers an ANR in
system_server, with a thread blocked writing to dumpsys TransferPipe
while holding a cache lock.  Other threads are blocked on the cache
lock.  There does not seem be a true deadlock, but if IO is slow then
all the threads slow down enough to trigger the ANR.

This change stages the output of dumpCacheInfo() in a byte array. The
byte array is written while holding the appropriate cache locks.  When
the byte array has been completely generated and all locks have been
released, the output is sent back to the caller over the dumpsys
TransferPipe.

The two PrintWriter objects are properly closed now.  The previous
code worked as a side effect of the many calls to flush(), which are
unnecessary now.

As a consequence of this change, it will be possible add a unit-test
for the output of 'dumpsys cacheinfo' by calling the method that
creates the byte array.  Such a unit test is not part of this commit.cache.

Tested manually by running 'dumpsys cacheinfo' and verifying that the
output is correct.

Test:
 * FrameworksCoreTests:IpcDataCacheTest

Change-Id: Icbd0197ca883cf0560ba2eb637951abee033eced
parent 1ae18287

core/java/android/app/PropertyInvalidatedCache.java

+44 −25
Original line number Diff line number Diff line
@@ -33,6 +33,7 @@ import com.android.internal.util.FastPrintWriter; 


import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.io.ByteArrayOutputStream;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.PrintWriter;
@@ -1444,7 +1445,6 @@ public class PropertyInvalidatedCache<Query, Result> { 
                    mCache.size(), mMaxEntries, mHighWaterMark, mMissOverflow));

            pw.println(TextUtils.formatSimple("    Enabled: %s", mDisabled ? "false" : "true"));

            pw.println("");

            pw.flush();



            // No specific cache was requested.  This is the default, and no details

            // should be dumped.
@@ -1463,7 +1463,6 @@ public class PropertyInvalidatedCache<Query, Result> { 


                pw.println(TextUtils.formatSimple("      Key: %s\n      Value: %s\n", key, value));

            }

            pw.flush();

        }

    }
@@ -1488,13 +1487,8 @@ public class PropertyInvalidatedCache<Query, Result> { 
     * provided ParcelFileDescriptor.  Optional switches allow the caller to choose

     * specific caches (selection is by cache name or property name); if these switches

     * are used then the output includes both cache statistics and cache entries.

     * @hide

     */

    public static void dumpCacheInfo(@NonNull ParcelFileDescriptor pfd, @NonNull String[] args) {

        try  (

            FileOutputStream fout = new FileOutputStream(pfd.getFileDescriptor());

            PrintWriter pw = new FastPrintWriter(fout);

        ) {

    private static void dumpCacheInfo(@NonNull PrintWriter pw, @NonNull String[] args) {

        if (!sEnabled) {

            pw.println("  Caching is disabled in this process.");

            return;
@@ -1516,6 +1510,31 @@ public class PropertyInvalidatedCache<Query, Result> { 
            PropertyInvalidatedCache currentCache = activeCaches.get(i);

            currentCache.dumpContents(pw, detail, args);

        }

    }



    /**

     * Without arguments, this dumps statistics from every cache in the process to the

     * provided ParcelFileDescriptor.  Optional switches allow the caller to choose

     * specific caches (selection is by cache name or property name); if these switches

     * are used then the output includes both cache statistics and cache entries.

     * @hide

     */

    public static void dumpCacheInfo(@NonNull ParcelFileDescriptor pfd, @NonNull String[] args) {

        // Create a PrintWriter that uses a byte array.  The code can safely write to

        // this array without fear of blocking.  The completed byte array will be sent

        // to the caller after all the data has been collected and all locks have been

        // released.

        ByteArrayOutputStream barray = new ByteArrayOutputStream();

        PrintWriter bout = new PrintWriter(barray);

        dumpCacheInfo(bout, args);

        bout.close();



        try {

            // Send the final byte array to the output.  This happens outside of all locks.

            var out = new FileOutputStream(pfd.getFileDescriptor());

            barray.writeTo(out);

            out.close();

            barray.close();

        } catch (IOException e) {

            Log.e(TAG, "Failed to dump PropertyInvalidatedCache instances");

        }