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

Commit b383c6cf authored by Kirill Timofeev's avatar Kirill Timofeev
Browse files

Perfetto SDK: extract MessageQueue tracing test to a separate class. 

This is the only test that validates the integration with Framework, all
other tests in 'PerfettoTraceTest' validate the Perfetto SDK itself.

In the follow-up CL 'PerfettoTraceMessageQueueTest' will be converted to
the parametrized test to make sure both current and new
'dev.perfetto.sdk' tracing works fine. The 'PerfettoTraceTest' will be
deleted after migration to the 'dev.perfetto.sdk' version.

Test:
atest FrameworksCoreTests:PerfettoTraceTest
atest FrameworksCoreTests:PerfettoTraceMessageQueueTest
Bug: 303199244
Flag: TEST_ONLY
Change-Id: I77c2775bee860cd7f85b2a76462e2e55a565b839
parent 5d0a24f8

core/tests/coretests/src/android/os/OWNERS

+2 −2
Original line number Diff line number Diff line
@@ -22,5 +22,5 @@ per-file RemoteCallbackListTest.java = shayba@google.com 
# MessageQueue

per-file MessageQueueTest.java = file:/MESSAGE_QUEUE_OWNERS



# PerfettoTraceTest

per-file PerfettoTraceTest.java = zezeozue@google.com, ktimofeev@google.com
 
# Perfetto SDK

per-file PerfettoTrace*Test.java = zezeozue@google.com, ktimofeev@google.com

core/tests/coretests/src/android/os/PerfettoTraceMessageQueueTest.java

0 → 100644
+250 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2025 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 android.os;



import static com.google.common.truth.Truth.assertThat;



import android.platform.test.annotations.DisabledOnRavenwood;

import android.platform.test.annotations.RequiresFlagsEnabled;

import android.platform.test.flag.junit.CheckFlagsRule;

import android.platform.test.flag.junit.DeviceFlagsValueProvider;

import android.util.ArraySet;



import androidx.test.ext.junit.runners.AndroidJUnit4;



import com.google.protobuf.ExtensionRegistryLite;



import org.junit.Before;

import org.junit.BeforeClass;

import org.junit.Rule;

import org.junit.Test;

import org.junit.runner.RunWith;



import perfetto.protos.AndroidTrackEventOuterClass;

import perfetto.protos.AndroidTrackEventOuterClass.AndroidMessageQueue;

import perfetto.protos.AndroidTrackEventOuterClass.AndroidTrackEvent;

import perfetto.protos.DataSourceConfigOuterClass;

import perfetto.protos.InternedDataOuterClass;

import perfetto.protos.TraceConfigOuterClass;

import perfetto.protos.TraceOuterClass;

import perfetto.protos.TracePacketOuterClass;

import perfetto.protos.TrackDescriptorOuterClass;

import perfetto.protos.TrackEventConfigOuterClass;

import perfetto.protos.TrackEventOuterClass;



import java.util.ArrayList;

import java.util.Set;

import java.util.concurrent.CountDownLatch;

import java.util.concurrent.TimeUnit;



/** Tests the Perfetto SDK tracing for the MessageQueue and Looper classes. */

@RunWith(AndroidJUnit4.class)

@DisabledOnRavenwood(blockedBy = PerfettoTrace.class)

public class PerfettoTraceMessageQueueTest {

    @Rule

    public final CheckFlagsRule mCheckFlagsRule = DeviceFlagsValueProvider.createCheckFlagsRule();



    private static final int MESSAGE = 1234567;

    private static final int MESSAGE_DELAYED = 7654321;



    private final Set<String> mCategoryNames = new ArraySet<>();

    private final Set<String> mEventNames = new ArraySet<>();



    @BeforeClass

    public static void setUpClass() {

        PerfettoTrace.register(true);

        PerfettoTrace.registerCategories();

    }



    @Before

    public void setUp() {

        mCategoryNames.clear();

        mEventNames.clear();

    }



    @Test

    @RequiresFlagsEnabled(android.os.Flags.FLAG_PERFETTO_SDK_TRACING_V2)

    public void testMessageQueue() throws Exception {

        final String mqReceiverThreadName = "mq_test_thread";

        final String mqSenderThreadName = Thread.currentThread().getName();

        final HandlerThread thread = new HandlerThread(mqReceiverThreadName);

        thread.start();

        final Handler handler = thread.getThreadHandler();

        final CountDownLatch latch = new CountDownLatch(1);



        PerfettoTrace.Session session =

                new PerfettoTrace.Session(true, getTraceConfig("mq").toByteArray());



        final int eventsCount = 4;



        handler.sendEmptyMessage(MESSAGE);

        handler.sendEmptyMessageDelayed(MESSAGE_DELAYED, 10);

        handler.sendEmptyMessage(MESSAGE);

        handler.postDelayed(

                () -> {

                    latch.countDown();

                },

                20);

        assertThat(latch.await(100, TimeUnit.MILLISECONDS)).isTrue();



        ExtensionRegistryLite registry = ExtensionRegistryLite.newInstance();

        AndroidTrackEventOuterClass.registerAllExtensions(registry);



        TraceOuterClass.Trace trace = TraceOuterClass.Trace.parseFrom(session.close(), registry);



        int counterCount = 0;

        int sliceEndEventCount = 0;



        Long counterTrackUuid = null;

        ArrayList<AndroidMessageQueue> messageQueueSendEvents = new ArrayList<>();

        ArrayList<Long> messageQueueSendFlowIds = new ArrayList<>();

        ArrayList<AndroidMessageQueue> messageQueueReceiveEvents = new ArrayList<>();

        ArrayList<Long> messageQueueReceiveTerminateFlowIds = new ArrayList<>();



        for (TracePacketOuterClass.TracePacket packet : trace.getPacketList()) {

            if (packet.hasTrackDescriptor()) {

                TrackDescriptorOuterClass.TrackDescriptor trackDescriptor =

                        packet.getTrackDescriptor();

                if (trackDescriptor.getName().equals(mqReceiverThreadName)

                        && trackDescriptor.hasCounter()) {

                    counterTrackUuid = trackDescriptor.getUuid();

                }

            } else if (packet.hasTrackEvent()) {

                TrackEventOuterClass.TrackEvent event = packet.getTrackEvent();

                if (event.getType() == TrackEventOuterClass.TrackEvent.Type.TYPE_INSTANT) {

                    if (event.hasExtension(AndroidTrackEvent.messageQueue)) {

                        AndroidMessageQueue mqEvent =

                                event.getExtension(AndroidTrackEvent.messageQueue);

                        messageQueueSendEvents.add(mqEvent);

                        assertThat(event.getFlowIdsCount()).isEqualTo(1);

                        messageQueueSendFlowIds.add(event.getFlowIds(0));

                    }

                } else if (event.getType()

                        == TrackEventOuterClass.TrackEvent.Type.TYPE_SLICE_BEGIN) {

                    if (event.hasExtension(AndroidTrackEvent.messageQueue)) {

                        AndroidMessageQueue mqEvent =

                                event.getExtension(AndroidTrackEvent.messageQueue);

                        messageQueueReceiveEvents.add(mqEvent);

                        assertThat(event.getTerminatingFlowIdsCount()).isEqualTo(1);

                        messageQueueReceiveTerminateFlowIds.add(event.getTerminatingFlowIds(0));

                    }

                } else if (event.getType() == TrackEventOuterClass.TrackEvent.Type.TYPE_SLICE_END) {

                    sliceEndEventCount++;

                } else if (event.getType() == TrackEventOuterClass.TrackEvent.Type.TYPE_COUNTER) {

                    if (counterTrackUuid != null && event.getTrackUuid() == counterTrackUuid) {

                        counterCount++;

                    }

                }

            }

            collectInternedData(packet);

        }



        assertThat(mCategoryNames).containsExactly("mq");

        assertThat(mEventNames).containsExactly("message_queue_send", "message_queue_receive");

        assertThat(counterTrackUuid).isNotNull();

        assertThat(counterCount).isAtLeast(eventsCount);

        assertThat(sliceEndEventCount).isEqualTo(eventsCount);



        assertThat(messageQueueSendEvents).hasSize(eventsCount);

        assertThat(messageQueueSendFlowIds).hasSize(eventsCount);



        assertThat(messageQueueReceiveEvents).hasSize(eventsCount);

        assertThat(messageQueueReceiveTerminateFlowIds).hasSize(eventsCount);



        assertThat(messageQueueSendEvents.get(0).getMessageCode()).isEqualTo(MESSAGE);

        assertThat(messageQueueSendEvents.get(0).getMessageDelayMs()).isEqualTo(0);

        assertThat(messageQueueSendEvents.get(0).getReceivingThreadName())

                .isEqualTo(mqReceiverThreadName);



        assertThat(messageQueueSendEvents.get(1).getMessageCode()).isEqualTo(MESSAGE_DELAYED);

        assertThat(messageQueueSendEvents.get(1).getMessageDelayMs()).isEqualTo(10);

        assertThat(messageQueueSendEvents.get(1).getReceivingThreadName())

                .isEqualTo(mqReceiverThreadName);



        assertThat(messageQueueSendEvents.get(2).getMessageCode()).isEqualTo(MESSAGE);

        assertThat(messageQueueSendEvents.get(2).getMessageDelayMs()).isEqualTo(0);

        assertThat(messageQueueSendEvents.get(2).getReceivingThreadName())

                .isEqualTo(mqReceiverThreadName);



        assertThat(messageQueueSendEvents.get(3).getMessageCode()).isEqualTo(0);

        assertThat(messageQueueSendEvents.get(3).getMessageDelayMs()).isEqualTo(20);

        assertThat(messageQueueSendEvents.get(3).getReceivingThreadName())

                .isEqualTo(mqReceiverThreadName);



        assertThat(messageQueueReceiveEvents.get(0).getSendingThreadName())

                .isEqualTo(mqSenderThreadName);

        assertThat(messageQueueReceiveEvents.get(1).getSendingThreadName())

                .isEqualTo(mqSenderThreadName);

        assertThat(messageQueueReceiveEvents.get(2).getSendingThreadName())

                .isEqualTo(mqSenderThreadName);

        assertThat(messageQueueReceiveEvents.get(3).getSendingThreadName())

                .isEqualTo(mqSenderThreadName);



        // The second message was send with a delay, and was received after the third one,

        // so we assert that the terminating flow Id of the third message is equal to the flow Id

        // of the second and the terminating flow id of the second is equal to the flow Id of the

        // third.

        assertThat(messageQueueSendFlowIds.get(0))

                .isEqualTo(messageQueueReceiveTerminateFlowIds.get(0));

        assertThat(messageQueueSendFlowIds.get(1))

                .isEqualTo(messageQueueReceiveTerminateFlowIds.get(2));

        assertThat(messageQueueSendFlowIds.get(2))

                .isEqualTo(messageQueueReceiveTerminateFlowIds.get(1));

        assertThat(messageQueueSendFlowIds.get(3))

                .isEqualTo(messageQueueReceiveTerminateFlowIds.get(3));

    }



    private TraceConfigOuterClass.TraceConfig getTraceConfig(String cat) {

        TraceConfigOuterClass.TraceConfig.BufferConfig bufferConfig =

                TraceConfigOuterClass.TraceConfig.BufferConfig.newBuilder().setSizeKb(1024).build();

        TrackEventConfigOuterClass.TrackEventConfig trackEventConfig =

                TrackEventConfigOuterClass.TrackEventConfig.newBuilder()

                        .addEnabledCategories(cat)

                        .build();

        DataSourceConfigOuterClass.DataSourceConfig dsConfig =

                DataSourceConfigOuterClass.DataSourceConfig.newBuilder()

                        .setName("track_event")

                        .setTargetBuffer(0)

                        .setTrackEventConfig(trackEventConfig)

                        .build();

        TraceConfigOuterClass.TraceConfig.DataSource ds =

                TraceConfigOuterClass.TraceConfig.DataSource.newBuilder()

                        .setConfig(dsConfig)

                        .build();

        TraceConfigOuterClass.TraceConfig traceConfig =

                TraceConfigOuterClass.TraceConfig.newBuilder()

                        .addBuffers(bufferConfig)

                        .addDataSources(ds)

                        .build();

        return traceConfig;

    }



    private void collectInternedData(TracePacketOuterClass.TracePacket packet) {

        if (!packet.hasInternedData()) {

            return;

        }



        InternedDataOuterClass.InternedData data = packet.getInternedData();



        for (TrackEventOuterClass.EventCategory cat : data.getEventCategoriesList()) {

            mCategoryNames.add(cat.getName());

        }

        for (TrackEventOuterClass.EventName ev : data.getEventNamesList()) {

            mEventNames.add(ev.getName());

        }

    }

}

core/tests/coretests/src/android/os/PerfettoTraceTest.java

+0 −137
Original line number Diff line number Diff line
@@ -32,16 +32,11 @@ import android.util.ArraySet; 
import androidx.test.InstrumentationRegistry;

import androidx.test.ext.junit.runners.AndroidJUnit4;



import com.google.protobuf.ExtensionRegistryLite;



import org.junit.Before;

import org.junit.Rule;

import org.junit.Test;

import org.junit.runner.RunWith;



import perfetto.protos.AndroidTrackEventOuterClass;

import perfetto.protos.AndroidTrackEventOuterClass.AndroidMessageQueue;

import perfetto.protos.AndroidTrackEventOuterClass.AndroidTrackEvent;

import perfetto.protos.ChromeLatencyInfoOuterClass.ChromeLatencyInfo;

import perfetto.protos.ChromeLatencyInfoOuterClass.ChromeLatencyInfo.ComponentInfo;

import perfetto.protos.DataSourceConfigOuterClass.DataSourceConfig;
@@ -62,11 +57,8 @@ import perfetto.protos.TrackEventOuterClass.EventCategory; 
import perfetto.protos.TrackEventOuterClass.EventName;

import perfetto.protos.TrackEventOuterClass.TrackEvent;



import java.util.ArrayList;

import java.util.List;

import java.util.Set;

import java.util.concurrent.CountDownLatch;

import java.util.concurrent.TimeUnit;



/**

 * This class is used to test the native tracing support. Run this test
@@ -615,135 +607,6 @@ public class PerfettoTraceTest { 
        assertThat(mDebugAnnotationNames).doesNotContain("before");

    }



    @Test

    @RequiresFlagsEnabled(android.os.Flags.FLAG_PERFETTO_SDK_TRACING_V2)

    public void testMessageQueue() throws Exception {

        PerfettoTrace.MQ_CATEGORY.register();

        final String mqReceiverThreadName = "mq_test_thread";

        final String mqSenderThreadName = Thread.currentThread().getName();

        final HandlerThread thread = new HandlerThread(mqReceiverThreadName);

        thread.start();

        final Handler handler = thread.getThreadHandler();

        final CountDownLatch latch = new CountDownLatch(1);



        PerfettoTrace.Session session = new PerfettoTrace.Session(true,

                getTraceConfig("mq").toByteArray());



        final int eventsCount = 4;



        handler.sendEmptyMessage(MESSAGE);

        handler.sendEmptyMessageDelayed(MESSAGE_DELAYED, 10);

        handler.sendEmptyMessage(MESSAGE);

        handler.postDelayed(() -> {

            latch.countDown();

        }, 20);

        assertThat(latch.await(100, TimeUnit.MILLISECONDS)).isTrue();



        ExtensionRegistryLite registry = ExtensionRegistryLite.newInstance();

        AndroidTrackEventOuterClass.registerAllExtensions(registry);



        Trace trace = Trace.parseFrom(session.close(), registry);



        int counterCount = 0;

        int sliceEndEventCount = 0;



        Long counterTrackUuid = null;

        ArrayList<AndroidMessageQueue> messageQueueSendEvents = new ArrayList<>();

        ArrayList<Long> messageQueueSendFlowIds = new ArrayList<>();

        ArrayList<AndroidMessageQueue> messageQueueReceiveEvents = new ArrayList<>();

        ArrayList<Long> messageQueueReceiveTerminateFlowIds = new ArrayList<>();



        for (TracePacket packet : trace.getPacketList()) {

            if (packet.hasTrackDescriptor()) {

                TrackDescriptor trackDescriptor = packet.getTrackDescriptor();

                if (trackDescriptor.getName().equals(mqReceiverThreadName)

                        && trackDescriptor.hasCounter()) {

                    counterTrackUuid = trackDescriptor.getUuid();

                }

            } else if (packet.hasTrackEvent()) {

                TrackEvent event = packet.getTrackEvent();

                if (event.getType() == TrackEvent.Type.TYPE_INSTANT) {

                    if (event.hasExtension(AndroidTrackEvent.messageQueue)) {

                        AndroidMessageQueue mqEvent =

                                event.getExtension(AndroidTrackEvent.messageQueue);

                        messageQueueSendEvents.add(mqEvent);

                        assertThat(event.getFlowIdsCount()).isEqualTo(1);

                        messageQueueSendFlowIds.add(event.getFlowIds(0));

                    }

                } else if (event.getType() == TrackEvent.Type.TYPE_SLICE_BEGIN) {

                    if (event.hasExtension(AndroidTrackEvent.messageQueue)) {

                        AndroidMessageQueue mqEvent =

                                event.getExtension(AndroidTrackEvent.messageQueue);

                        messageQueueReceiveEvents.add(mqEvent);

                        assertThat(event.getTerminatingFlowIdsCount()).isEqualTo(1);

                        messageQueueReceiveTerminateFlowIds.add(event.getTerminatingFlowIds(0));

                    }

                } else if (event.getType() == TrackEvent.Type.TYPE_SLICE_END) {

                    sliceEndEventCount++;

                } else if (event.getType() == TrackEvent.Type.TYPE_COUNTER) {

                    if (counterTrackUuid != null && event.getTrackUuid() == counterTrackUuid) {

                        counterCount++;

                    }

                }

            }

            collectInternedData(packet);

        }



        assertThat(mCategoryNames).containsExactly("mq");

        assertThat(mEventNames).containsExactly("message_queue_send", "message_queue_receive");

        assertThat(counterTrackUuid).isNotNull();

        assertThat(counterCount).isAtLeast(eventsCount);

        assertThat(sliceEndEventCount).isEqualTo(eventsCount);



        assertThat(messageQueueSendEvents).hasSize(eventsCount);

        assertThat(messageQueueSendFlowIds).hasSize(eventsCount);



        assertThat(messageQueueReceiveEvents).hasSize(eventsCount);

        assertThat(messageQueueReceiveTerminateFlowIds).hasSize(eventsCount);



        assertThat(messageQueueSendEvents.get(0).getMessageCode()).isEqualTo(MESSAGE);

        assertThat(messageQueueSendEvents.get(0).getMessageDelayMs()).isEqualTo(0);

        assertThat(messageQueueSendEvents.get(0).getReceivingThreadName()).isEqualTo(

                mqReceiverThreadName);



        assertThat(messageQueueSendEvents.get(1).getMessageCode()).isEqualTo(MESSAGE_DELAYED);

        assertThat(messageQueueSendEvents.get(1).getMessageDelayMs()).isEqualTo(10);

        assertThat(messageQueueSendEvents.get(1).getReceivingThreadName()).isEqualTo(

                mqReceiverThreadName);



        assertThat(messageQueueSendEvents.get(2).getMessageCode()).isEqualTo(MESSAGE);

        assertThat(messageQueueSendEvents.get(2).getMessageDelayMs()).isEqualTo(0);

        assertThat(messageQueueSendEvents.get(2).getReceivingThreadName()).isEqualTo(

                mqReceiverThreadName);



        assertThat(messageQueueSendEvents.get(3).getMessageCode()).isEqualTo(0);

        assertThat(messageQueueSendEvents.get(3).getMessageDelayMs()).isEqualTo(20);

        assertThat(messageQueueSendEvents.get(3).getReceivingThreadName()).isEqualTo(

                mqReceiverThreadName);



        assertThat(messageQueueReceiveEvents.get(0).getSendingThreadName()).isEqualTo(

                mqSenderThreadName);

        assertThat(messageQueueReceiveEvents.get(1).getSendingThreadName()).isEqualTo(

                mqSenderThreadName);

        assertThat(messageQueueReceiveEvents.get(2).getSendingThreadName()).isEqualTo(

                mqSenderThreadName);

        assertThat(messageQueueReceiveEvents.get(3).getSendingThreadName()).isEqualTo(

                mqSenderThreadName);



        // The second message was send with a delay, and was received after the third one,

        // so we assert that the terminating flow Id of the third message is equal to the flow Id

        // of the second and the terminating flow id of the second is equal to the flow Id of the

        // third.

        assertThat(messageQueueSendFlowIds.get(0)).isEqualTo(

                messageQueueReceiveTerminateFlowIds.get(0));

        assertThat(messageQueueSendFlowIds.get(1)).isEqualTo(

                messageQueueReceiveTerminateFlowIds.get(2));

        assertThat(messageQueueSendFlowIds.get(2)).isEqualTo(

                messageQueueReceiveTerminateFlowIds.get(1));

        assertThat(messageQueueSendFlowIds.get(3)).isEqualTo(

                messageQueueReceiveTerminateFlowIds.get(3));

    }



    private TraceConfig getTraceConfig(String cat) {

        BufferConfig bufferConfig = BufferConfig.newBuilder().setSizeKb(1024).build();

        TrackEventConfig trackEventConfig = TrackEventConfig