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

Commit e006983d authored by yawanng's avatar yawanng
Browse files

Add support to report ART metrics to statsd. 

It will report dex2oat related metrics (total time, dex bytes and result
code) after each run of dex2oat.

This is a cherry pick from AOSP aog/1619941 with conflict fixing.
Internal and AOSP have different APIs.

Bug: 177694884
Test: atest ArtStatsLogUtilsTest
Change-Id: Ic167e250a74e29dee0c8dc628d1cc731d778fa26
parent 3276ba27

services/core/Android.bp

+9 −0
Original line number Diff line number Diff line
@@ -81,10 +81,19 @@ genrule { 
    out: ["services.core.protolog.json"],

}



genrule {

    name: "statslog-art-java-gen",

    tools: ["stats-log-api-gen"],

    cmd: "$(location stats-log-api-gen) --java $(out) --module art" +

         " --javaPackage com.android.internal.art --javaClass ArtStatsLog --worksource",

    out: ["com/android/internal/art/ArtStatsLog.java"],

}



java_library_static {

    name: "services.core.unboosted",

    defaults: ["platform_service_defaults"],

    srcs: [

        ":statslog-art-java-gen",

        ":services.core-sources",

        ":services.core.protologsrc",

        ":dumpstate_aidl",

services/core/java/com/android/server/pm/PackageDexOptimizer.java

+27 −0
Original line number Diff line number Diff line
@@ -51,6 +51,7 @@ import android.os.FileUtils; 
import android.os.PowerManager;

import android.os.SystemClock;

import android.os.SystemProperties;

import android.os.Trace;

import android.os.UserHandle;

import android.os.WorkSource;

import android.os.storage.StorageManager;
@@ -62,6 +63,8 @@ import com.android.internal.annotations.GuardedBy; 
import com.android.internal.util.IndentingPrintWriter;

import com.android.server.pm.Installer.InstallerException;

import com.android.server.pm.dex.ArtManagerService;

import com.android.server.pm.dex.ArtStatsLogUtils;

import com.android.server.pm.dex.ArtStatsLogUtils.ArtStatsLogger;

import com.android.server.pm.dex.DexManager;

import com.android.server.pm.dex.DexoptOptions;

import com.android.server.pm.dex.DexoptUtils;
@@ -99,6 +102,8 @@ public class PackageDexOptimizer { 
    private final PowerManager.WakeLock mDexoptWakeLock;

    private volatile boolean mSystemReady;



    private final ArtStatsLogger mArtStatsLogger = new ArtStatsLogger();



    PackageDexOptimizer(Installer installer, Object installLock, Context context,

            String wakeLockTag) {

        this.mInstaller = installer;
@@ -252,6 +257,28 @@ public class PackageDexOptimizer { 
                        profileUpdated, classLoaderContexts[i], dexoptFlags, sharedGid,

                        packageStats, options.isDowngrade(), profileName, dexMetadataPath,

                        options.getCompilationReason());



                // Only report metrics for base apk for now.

                // TODO: add ISA and APK type to metrics.

                if (pkg.getBaseApkPath().equals(path)) {

                    Trace.traceBegin(Trace.TRACE_TAG_PACKAGE_MANAGER, "dex2oat-metrics");

                    try {

                        long sessionId = Math.randomLongInternal();

                        ArtStatsLogUtils.writeStatsLog(

                                mArtStatsLogger,

                                sessionId,

                                path,

                                compilerFilter,

                                sharedGid,

                                packageStats.getCompileTime(path),

                                dexMetadataPath,

                                options.getCompilationReason(),

                                newResult);

                    } finally {

                        Trace.traceEnd(Trace.TRACE_TAG_PACKAGE_MANAGER);

                    }

                }



                // The end result is:

                //  - FAILED if any path failed,

                //  - PERFORMED if at least one path needed compilation,

services/core/java/com/android/server/pm/dex/ArtStatsLogUtils.java

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

 * Copyright (C) 2021 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 com.android.server.pm.dex;



import static com.android.internal.art.ArtStatsLog.ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_INSTALL_BULK_DOWNGRADED;

import static com.android.internal.art.ArtStatsLog.ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_INSTALL_BULK_SECONDARY;

import static com.android.internal.art.ArtStatsLog.ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_INSTALL_BULK_SECONDARY_DOWNGRADED;

import static com.android.internal.art.ArtStatsLog.ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_FAKE_RUN_FROM_APK_FALLBACK;

import static com.android.internal.art.ArtStatsLog.ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_FAKE_RUN_FROM_VDEX_FALLBACK;



import android.util.jar.StrictJarFile;

import android.util.Slog;



import com.android.internal.art.ArtStatsLog;

import com.android.server.pm.PackageManagerService;



import java.io.IOException;

import java.util.HashMap;

import java.util.Iterator;

import java.util.Map;

import java.util.zip.ZipEntry;



/** Utils class to report ART metrics to statsd. */

public class ArtStatsLogUtils {

    private static final String TAG = ArtStatsLogUtils.class.getSimpleName();

    private static final String PROFILE_DEX_METADATA = "primary.prof";

    private static final String VDEX_DEX_METADATA = "primary.vdex";





    private static final int ART_COMPILATION_REASON_INSTALL_BULK_SECONDARY =

            ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_INSTALL_BULK_SECONDARY;

    private static final int ART_COMPILATION_REASON_INSTALL_BULK_DOWNGRADED =

            ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_INSTALL_BULK_DOWNGRADED;

    private static final int ART_COMPILATION_REASON_INSTALL_BULK_SECONDARY_DOWNGRADED =

            ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_INSTALL_BULK_SECONDARY_DOWNGRADED;



    private static final int ART_COMPILATION_FILTER_FAKE_RUN_FROM_APK_FALLBACK =

            ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_FAKE_RUN_FROM_APK_FALLBACK;

    private static final int ART_COMPILATION_FILTER_FAKE_RUN_FROM_VDEX_FALLBACK =

            ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_FAKE_RUN_FROM_VDEX_FALLBACK;



    private static final Map<Integer, Integer> COMPILATION_REASON_MAP = new HashMap();



    static {

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_UNKNOWN, ArtStatsLog.

                ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_UNKNOWN);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_FIRST_BOOT, ArtStatsLog.

                ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_FIRST_BOOT);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_BOOT_AFTER_OTA, ArtStatsLog.

                ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_BOOT);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_POST_BOOT, ArtStatsLog.

                ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_POST_BOOT);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_INSTALL, ArtStatsLog.

                ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_INSTALL);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_INSTALL_FAST, ArtStatsLog.

                ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_INSTALL_FAST);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_INSTALL_BULK, ArtStatsLog.

                ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_INSTALL_BULK);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_INSTALL_BULK_SECONDARY,

                ART_COMPILATION_REASON_INSTALL_BULK_SECONDARY);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_INSTALL_BULK_DOWNGRADED,

                ART_COMPILATION_REASON_INSTALL_BULK_DOWNGRADED);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_INSTALL_BULK_SECONDARY_DOWNGRADED,

                ART_COMPILATION_REASON_INSTALL_BULK_SECONDARY_DOWNGRADED);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_BACKGROUND_DEXOPT, ArtStatsLog.

                ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_BG_DEXOPT);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_AB_OTA, ArtStatsLog.

                ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_AB_OTA);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_INACTIVE_PACKAGE_DOWNGRADE,

                ArtStatsLog.

                        ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_INACTIVE);

        COMPILATION_REASON_MAP.put(PackageManagerService.REASON_SHARED,

                ArtStatsLog.ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_SHARED);

    }



    private static final Map<String, Integer> COMPILE_FILTER_MAP = new HashMap();



    static {

        COMPILE_FILTER_MAP.put("error", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_ERROR);

        COMPILE_FILTER_MAP.put("unknown", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_UNKNOWN);

        COMPILE_FILTER_MAP.put("assume-verified", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_ASSUMED_VERIFIED);

        COMPILE_FILTER_MAP.put("extract", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_EXTRACT);

        COMPILE_FILTER_MAP.put("verify", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_VERIFY);

        COMPILE_FILTER_MAP.put("quicken", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_QUICKEN);

        COMPILE_FILTER_MAP.put("space-profile", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_SPACE_PROFILE);

        COMPILE_FILTER_MAP.put("space", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_SPACE);

        COMPILE_FILTER_MAP.put("speed-profile", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_SPEED_PROFILE);

        COMPILE_FILTER_MAP.put("speed", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_SPEED);

        COMPILE_FILTER_MAP.put("everything-profile", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_EVERYTHING_PROFILE);

        COMPILE_FILTER_MAP.put("everything", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_EVERYTHING);

        COMPILE_FILTER_MAP.put("run-from-apk", ArtStatsLog.

                ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_FAKE_RUN_FROM_APK);

        COMPILE_FILTER_MAP.put("run-from-apk-fallback",

                ART_COMPILATION_FILTER_FAKE_RUN_FROM_APK_FALLBACK);

        COMPILE_FILTER_MAP.put("run-from-vdex-fallback",

                ART_COMPILATION_FILTER_FAKE_RUN_FROM_VDEX_FALLBACK);

    }



    public static void writeStatsLog(

            ArtStatsLogger logger,

            long sessionId,

            String path,

            String compilerFilter,

            int uid,

            long compileTime,

            String dexMetadataPath,

            int compilationReason,

            int result) {

        int dexMetadataType = getDexMetadataType(dexMetadataPath);

        logger.write(

                sessionId,

                uid,

                compilationReason,

                compilerFilter,

                ArtStatsLog.ART_DATUM_REPORTED__KIND__ART_DATUM_DEX2OAT_RESULT_CODE,

                result,

                dexMetadataType);

        logger.write(

                sessionId,

                uid,

                compilationReason,

                compilerFilter,

                ArtStatsLog.ART_DATUM_REPORTED__KIND__ART_DATUM_DEX2OAT_DEX_CODE_BYTES,

                getDexBytes(path),

                dexMetadataType);

        logger.write(

                sessionId,

                uid,

                compilationReason,

                compilerFilter,

                ArtStatsLog.ART_DATUM_REPORTED__KIND__ART_DATUM_DEX2OAT_TOTAL_TIME,

                compileTime,

                dexMetadataType);

    }



    private static long getDexBytes(String apkPath) {

        StrictJarFile jarFile = null;

        long dexBytes = 0;

        try {

            jarFile = new StrictJarFile(apkPath,

                    /*verify=*/ false,

                    /*signatureSchemeRollbackProtectionsEnforced=*/ false);

            Iterator<ZipEntry> it = jarFile.iterator();

            while (it.hasNext()) {

                ZipEntry entry = it.next();

                if (entry.getName().matches("classes(\\d)*[.]dex")) {

                    dexBytes += entry.getSize();

                }

            }

            return dexBytes;

        } catch (IOException ignore) {

            Slog.e(TAG, "Error when parsing APK " + apkPath);

            return -1L;

        } finally {

            try {

                if (jarFile != null) {

                    jarFile.close();

                }

            } catch (IOException ignore) {

            }

        }

    }



    private static int getDexMetadataType(String dexMetadataPath) {

        if (dexMetadataPath == null) {

            return ArtStatsLog.ART_DATUM_REPORTED__DEX_METADATA_TYPE__NONE_DEX_METADATA;

        }

        StrictJarFile jarFile = null;

        try {

            jarFile = new StrictJarFile(dexMetadataPath,

                    /*verify=*/ false,

                    /*signatureSchemeRollbackProtectionsEnforced=*/false);

            boolean hasProfile = findFileName(jarFile, PROFILE_DEX_METADATA);

            boolean hasVdex = findFileName(jarFile, VDEX_DEX_METADATA);

            if (hasProfile && hasVdex) {

                return ArtStatsLog.ART_DATUM_REPORTED__DEX_METADATA_TYPE__PROFILE_AND_VDEX;

            } else if (hasProfile) {

                return ArtStatsLog.ART_DATUM_REPORTED__DEX_METADATA_TYPE__PROFILE;

            } else if (hasVdex) {

                return ArtStatsLog.ART_DATUM_REPORTED__DEX_METADATA_TYPE__VDEX;

            } else {

                return ArtStatsLog.ART_DATUM_REPORTED__DEX_METADATA_TYPE__UNKNOWN_DEX_METADATA;

            }

        } catch (IOException ignore) {

            Slog.e(TAG, "Error when parsing dex metadata " + dexMetadataPath);

            return ArtStatsLog.ART_DATUM_REPORTED__DEX_METADATA_TYPE__ERROR_DEX_METADATA;

        } finally {

            try {

                if (jarFile != null) {

                    jarFile.close();

                }

            } catch (IOException ignore) {

            }

        }

    }



    private static boolean findFileName(StrictJarFile jarFile, String filename) throws IOException {

        Iterator<ZipEntry> it = jarFile.iterator();

        while (it.hasNext()) {

            ZipEntry entry = it.next();

            if (entry.getName().equals(filename)) {

                return true;

            }

        }

        return false;

    }



    public static class ArtStatsLogger {

        public void write(

                long sessionId,

                int uid,

                int compilationReason,

                String compilerFilter,

                int kind,

                long value,

                int dexMetadataType) {

            ArtStatsLog.write(

                    ArtStatsLog.ART_DATUM_REPORTED,

                    sessionId,

                    uid,

                    COMPILE_FILTER_MAP.getOrDefault(compilerFilter, ArtStatsLog.

                            ART_DATUM_REPORTED__COMPILE_FILTER__ART_COMPILATION_FILTER_UNKNOWN),

                    COMPILATION_REASON_MAP.getOrDefault(compilationReason, ArtStatsLog.

                            ART_DATUM_REPORTED__COMPILATION_REASON__ART_COMPILATION_REASON_UNKNOWN),

                    /*timestamp_millis=*/ 0L,

                    ArtStatsLog.ART_DATUM_REPORTED__THREAD_TYPE__ART_THREAD_MAIN,

                    kind,

                    value,

                    dexMetadataType);

        }

    }

}

services/tests/servicestests/src/com/android/server/pm/dex/ArtStatsLogUtilsTest.java

0 → 100644
+295 −0

File added.

Preview size limit exceeded, changes collapsed.