Skip to content

Commit 2a9821a

Browse files
committed
fix: Resolve ImageReader ANRs by running OnImageAvailableListener on a background HandlerThread (flutter#168716)
Moves the `ImageReader.OnImageAvailableListener` to run on a dedicated background `HandlerThread` owned by `ImageReaderSurfaceProducer` to avoid blocking the Android UI thread with graphics buffer allocation (`acquireLatestImage`) which led to severe Input Dispatching Timed Out ANRs and graphics driver crashes on low-end devices. Key changes: - Created and managed a dedicated `HandlerThread` inside `ImageReaderSurfaceProducer` to handle `OnImageAvailable` callbacks. - Refactored `onImage` to receive `PerImageReader` directly, eliminating map lookups and preventing memory leaks of native images when callbacks race with producer release/cleanup. - Marshalled `scheduleEngineFrame()` (which performs JNI frame scheduling) back to the main thread via the outer class's main-thread `handler` to respect the `@UiThread` check of `FlutterJNI`. - Marshalled the entire `release()` sequence in `finalize()` back to the main thread to prevent thread data races on non-thread-safe lists and set collections inside `FlutterRenderer` on the GC finalizer thread. - Made state and thread fields `volatile` to guarantee proper visibility across the main thread, background thread, and GC threads. - Added a dedicated Robolectric test `ImageReaderSurfaceProducerOnImageAvailableListenerRunsOnBackgroundThread` to verify that the listener runs on a non-main-thread Handler looper, and updated existing Robolectric tests to idle the background looper during frame rendering.
1 parent 8bc1f30 commit 2a9821a

2 files changed

Lines changed: 78 additions & 11 deletions

File tree

‎engine/src/flutter/shell/platform/android/io/flutter/embedding/engine/renderer/FlutterRenderer.java‎

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import android.media.ImageReader;
1818
import android.os.Build;
1919
import android.os.Handler;
20+
import android.os.HandlerThread;
2021
import android.os.Looper;
2122
import android.view.Surface;
2223
import androidx.annotation.Keep;
@@ -470,7 +471,9 @@ final class ImageReaderSurfaceProducer
470471

471472
private final long id;
472473

473-
private boolean released;
474+
private volatile boolean released;
475+
@VisibleForTesting volatile HandlerThread handlerThread;
476+
@VisibleForTesting volatile Handler backgroundHandler;
474477
// Will be true in tests and on Android API < 33.
475478
private boolean ignoringFence = false;
476479

@@ -522,7 +525,7 @@ public PerImage(Image image, long queuedTime) {
522525
private class PerImageReader {
523526
public final ImageReader reader;
524527
private final ArrayDeque<PerImage> imageQueue = new ArrayDeque<>();
525-
private boolean closed = false;
528+
private volatile boolean closed = false;
526529

527530
public PerImageReader(ImageReader reader) {
528531
this.reader = reader;
@@ -541,10 +544,10 @@ public PerImageReader(ImageReader reader) {
541544
image.close();
542545
return;
543546
}
544-
onImage(r, image);
547+
onImage(PerImageReader.this, image);
545548
};
546549
reader.setOnImageAvailableListener(
547-
onImageAvailableListener, new Handler(Looper.getMainLooper()));
550+
onImageAvailableListener, backgroundHandler);
548551
}
549552

550553
PerImage queueImage(Image image) {
@@ -631,10 +634,13 @@ void pruneImageReaderQueue() {
631634
}
632635
}
633636

634-
void onImage(ImageReader reader, Image image) {
637+
void onImage(PerImageReader perReader, Image image) {
635638
PerImage queuedImage;
636639
synchronized (lock) {
637-
PerImageReader perReader = getOrCreatePerImageReader(reader);
640+
if (released || perReader.closed) {
641+
image.close();
642+
return;
643+
}
638644
queuedImage = perReader.queueImage(image);
639645
}
640646
if (queuedImage == null) {
@@ -647,7 +653,7 @@ void onImage(ImageReader reader, Image image) {
647653
long queueDelta = now - lastQueueTime;
648654
Log.i(
649655
TAG,
650-
reader.hashCode()
656+
perReader.reader.hashCode()
651657
+ " enqueued image="
652658
+ queuedImage.image.hashCode()
653659
+ " queueDelta="
@@ -657,7 +663,12 @@ void onImage(ImageReader reader, Image image) {
657663
lastQueueTime = System.nanoTime();
658664
}
659665
}
660-
scheduleEngineFrame();
666+
handler.post(
667+
() -> {
668+
if (!released) {
669+
scheduleEngineFrame();
670+
}
671+
});
661672
}
662673

663674
PerImage dequeueImage() {
@@ -755,10 +766,15 @@ public void onTrimMemory(int level) {
755766
}
756767

757768
private void releaseInternal() {
758-
cleanup();
759769
released = true;
770+
cleanup();
760771
removeOnTrimMemoryListener(this);
761772
imageReaderProducers.remove(this);
773+
if (handlerThread != null) {
774+
handlerThread.quitSafely();
775+
handlerThread = null;
776+
backgroundHandler = null;
777+
}
762778
}
763779

764780
private void cleanup() {
@@ -813,6 +829,9 @@ private void maybeWaitOnFence(Image image) {
813829

814830
ImageReaderSurfaceProducer(long id) {
815831
this.id = id;
832+
handlerThread = new HandlerThread("ImageReaderSurfaceProducerThread");
833+
handlerThread.start();
834+
backgroundHandler = new Handler(handlerThread.getLooper());
816835
}
817836

818837
@Override
@@ -931,8 +950,7 @@ protected void finalize() throws Throwable {
931950
if (released) {
932951
return;
933952
}
934-
releaseInternal();
935-
handler.post(new TextureFinalizerRunnable(id, flutterJNI));
953+
handler.post(this::release);
936954
} finally {
937955
super.finalize();
938956
}

‎engine/src/flutter/shell/platform/android/test/io/flutter/embedding/engine/renderer/FlutterRendererTest.java‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -500,6 +500,7 @@ public void ImageReaderSurfaceProducerProducesImageOfCorrectSize() {
500500

501501
// Let callbacks run.
502502
shadowOf(Looper.getMainLooper()).idle();
503+
shadowOf(texture.handlerThread.getLooper()).idle();
503504

504505
// Extract the image and check its size.
505506
Image image = texture.acquireLatestImage();
@@ -520,6 +521,7 @@ public void ImageReaderSurfaceProducerProducesImageOfCorrectSize() {
520521

521522
// Let callbacks run.
522523
shadowOf(Looper.getMainLooper()).idle();
524+
shadowOf(texture.handlerThread.getLooper()).idle();
523525

524526
// Extract the image and check its size.
525527
image = texture.acquireLatestImage();
@@ -559,6 +561,7 @@ public void ImageReaderSurfaceProducerDoesNotDropFramesWhenResizeInFlight() {
559561

560562
// Let callbacks run. The rendered frame will manifest here.
561563
shadowOf(Looper.getMainLooper()).idle();
564+
shadowOf(texture.handlerThread.getLooper()).idle();
562565

563566
// We acquired the frame produced above.
564567
assertNotNull(texture.acquireLatestImage());
@@ -587,6 +590,7 @@ public void ImageReaderSurfaceProducerImageReadersAndImagesCount() {
587590

588591
// Let callbacks run, this will produce a single frame.
589592
shadowOf(Looper.getMainLooper()).idle();
593+
shadowOf(texture.handlerThread.getLooper()).idle();
590594

591595
assertEquals(1, texture.numImageReaders());
592596
assertEquals(1, texture.numImages());
@@ -602,6 +606,7 @@ public void ImageReaderSurfaceProducerImageReadersAndImagesCount() {
602606

603607
// Let callbacks run.
604608
shadowOf(Looper.getMainLooper()).idle();
609+
shadowOf(texture.handlerThread.getLooper()).idle();
605610

606611
assertEquals(1, texture.numImageReaders());
607612
assertEquals(2, texture.numImages());
@@ -616,6 +621,7 @@ public void ImageReaderSurfaceProducerImageReadersAndImagesCount() {
616621

617622
// Let callbacks run.
618623
shadowOf(Looper.getMainLooper()).idle();
624+
shadowOf(texture.handlerThread.getLooper()).idle();
619625

620626
assertEquals(2, texture.numImageReaders());
621627
assertEquals(3, texture.numImages());
@@ -673,6 +679,7 @@ public void ImageReaderSurfaceProducerDequeueManyImages() {
673679
canvas.drawARGB(255, 255, 0, 0);
674680
surface.unlockCanvasAndPost(canvas);
675681
shadowOf(Looper.getMainLooper()).idle();
682+
shadowOf(texture.handlerThread.getLooper()).idle();
676683

677684
// Acquire first frame.
678685
Image produced = texture.acquireLatestImage();
@@ -683,6 +690,7 @@ public void ImageReaderSurfaceProducerDequeueManyImages() {
683690
canvas.drawARGB(255, 255, 0, 0);
684691
surface.unlockCanvasAndPost(canvas);
685692
shadowOf(Looper.getMainLooper()).idle();
693+
shadowOf(texture.handlerThread.getLooper()).idle();
686694

687695
// 2
688696
produced = texture.acquireLatestImage();
@@ -692,6 +700,7 @@ public void ImageReaderSurfaceProducerDequeueManyImages() {
692700
canvas.drawARGB(255, 255, 0, 0);
693701
surface.unlockCanvasAndPost(canvas);
694702
shadowOf(Looper.getMainLooper()).idle();
703+
shadowOf(texture.handlerThread.getLooper()).idle();
695704

696705
// 3
697706
produced = texture.acquireLatestImage();
@@ -701,6 +710,7 @@ public void ImageReaderSurfaceProducerDequeueManyImages() {
701710
canvas.drawARGB(255, 255, 0, 0);
702711
surface.unlockCanvasAndPost(canvas);
703712
shadowOf(Looper.getMainLooper()).idle();
713+
shadowOf(texture.handlerThread.getLooper()).idle();
704714

705715
// 4
706716
produced = texture.acquireLatestImage();
@@ -731,6 +741,7 @@ public void ImageReaderSurfaceProducerTrimMemoryCallback() {
731741

732742
// Let callbacks run, this will produce a single frame.
733743
shadowOf(Looper.getMainLooper()).idle();
744+
shadowOf(texture.handlerThread.getLooper()).idle();
734745

735746
assertEquals(1, texture.numImageReaders());
736747
assertEquals(1, texture.numImages());
@@ -739,6 +750,7 @@ public void ImageReaderSurfaceProducerTrimMemoryCallback() {
739750
// This should do nothing.
740751
texture.onTrimMemory(0);
741752
shadowOf(Looper.getMainLooper()).idle();
753+
shadowOf(texture.handlerThread.getLooper()).idle();
742754

743755
assertEquals(1, texture.numImageReaders());
744756
assertEquals(1, texture.numImages());
@@ -748,6 +760,7 @@ public void ImageReaderSurfaceProducerTrimMemoryCallback() {
748760
// This should result in a trim.
749761
texture.onTrimMemory(TRIM_MEMORY_BACKGROUND);
750762
shadowOf(Looper.getMainLooper()).idle();
763+
shadowOf(texture.handlerThread.getLooper()).idle();
751764

752765
assertEquals(0, texture.numImageReaders());
753766
assertEquals(0, texture.numImages());
@@ -766,6 +779,7 @@ public void ImageReaderSurfaceProducerTrimMemoryCallback() {
766779

767780
// Let callbacks run, this will produce a single frame.
768781
shadowOf(Looper.getMainLooper()).idle();
782+
shadowOf(texture.handlerThread.getLooper()).idle();
769783

770784
assertEquals(1, texture.numImageReaders());
771785
assertEquals(1, texture.numImages());
@@ -965,6 +979,7 @@ public void ImageReaderSurfaceProducerSchedulesFrameIfQueueNotEmpty() throws Exc
965979
canvas.drawARGB(255, 255, 0, 0);
966980
surface.unlockCanvasAndPost(canvas);
967981
shadowOf(Looper.getMainLooper()).idle();
982+
shadowOf(texture.handlerThread.getLooper()).idle();
968983
}
969984

970985
// Each enqueue of an image should result in a call to scheduleEngineFrame.
@@ -973,6 +988,7 @@ public void ImageReaderSurfaceProducerSchedulesFrameIfQueueNotEmpty() throws Exc
973988
// Consume the first image.
974989
Image image = texture.acquireLatestImage();
975990
shadowOf(Looper.getMainLooper()).idle();
991+
shadowOf(texture.handlerThread.getLooper()).idle();
976992

977993
// The dequeue should call scheduleEngineFrame because another image
978994
// remains in the queue.
@@ -981,6 +997,7 @@ public void ImageReaderSurfaceProducerSchedulesFrameIfQueueNotEmpty() throws Exc
981997
// Consume the second image.
982998
image = texture.acquireLatestImage();
983999
shadowOf(Looper.getMainLooper()).idle();
1000+
shadowOf(texture.handlerThread.getLooper()).idle();
9841001

9851002
// The dequeue should not call scheduleEngineFrame because the queue
9861003
// is now empty.
@@ -1074,4 +1091,36 @@ public void restoreSurfaceProducers_restoresImageReaderSurfaceProducersAsIfAppli
10741091
assertFalse(imageReaderProducer1.notifiedDestroy);
10751092
assertFalse(imageReaderProducer2.notifiedDestroy);
10761093
}
1094+
1095+
@Test
1096+
public void ImageReaderSurfaceProducerOnImageAvailableListenerRunsOnBackgroundThread() {
1097+
FlutterRenderer flutterRenderer = spy(engineRule.getFlutterEngine().getRenderer());
1098+
TextureRegistry.SurfaceProducer producer = flutterRenderer.createSurfaceProducer();
1099+
try {
1100+
FlutterRenderer.ImageReaderSurfaceProducer spyImageReaderSurfaceProducer =
1101+
spy((FlutterRenderer.ImageReaderSurfaceProducer) producer);
1102+
ImageReader mockImageReader = mock(ImageReader.class);
1103+
Surface mockSurface = mock(Surface.class);
1104+
1105+
when(mockSurface.isValid()).thenReturn(true);
1106+
when(mockImageReader.getSurface()).thenReturn(mockSurface);
1107+
when(spyImageReaderSurfaceProducer.createImageReader()).thenReturn(mockImageReader);
1108+
1109+
// This will trigger the creation of the PerImageReader, which registers the listener.
1110+
spyImageReaderSurfaceProducer.getSurface();
1111+
1112+
// Verify that setOnImageAvailableListener was called, and capture the Handler.
1113+
ArgumentCaptor<android.os.Handler> handlerCaptor = ArgumentCaptor.forClass(android.os.Handler.class);
1114+
verify(mockImageReader).setOnImageAvailableListener(any(), handlerCaptor.capture());
1115+
1116+
android.os.Handler handler = handlerCaptor.getValue();
1117+
assertNotNull(handler);
1118+
// This assertion should fail on the current code because it uses the main looper.
1119+
assertNotEquals("The ImageReader listener must not run on the main thread to avoid ANRs",
1120+
Looper.getMainLooper(), handler.getLooper());
1121+
} finally {
1122+
producer.release();
1123+
}
1124+
}
10771125
}
1126+

0 commit comments

Comments
 (0)