Referans Profilleri manuel olarak oluşturma ve ölçme

Manuel çabayı azaltmak ve genel ölçeklenebilirliği artırmak için Jetpack Macrobenchmark kitaplığını kullanarak profil kurallarının oluşturulmasını otomatikleştirmenizi önemle tavsiye ederiz. Ancak, uygulamanızda manuel olarak profil kuralları oluşturup ölçebilirsiniz.

Profil kurallarını manuel olarak tanımlama

src/main dizininde baseline-prof.txt adlı bir dosya oluşturarak bir uygulamada veya kitaplık modülünde profil kurallarını manuel olarak tanımlayabilirsiniz. Bu, AndroidManifest.xml dosyasını içeren klasörle aynıdır.

Dosyada her satırda bir kural belirtilir. Her kural, uygulama veya kitaplıktaki optimize edilmesi gereken eşleşen yöntemler ya da sınıflar için bir kalıbı temsil eder.

Bu kuralların söz dizimi, adb shell profman --dump-classes-and-methods kullanıldığında kullanıcı tarafından okunabilen ART profil biçiminin (HRF) bir üst kümesidir. Söz dizimi, tanımlayıcılar ve imzalar için söz dizimine benzer ancak kural yazma sürecini basitleştirmek için joker karakterlerin kullanılmasına olanak tanır.

Aşağıdaki örnekte, Jetpack Compose kitaplığına dahil edilen birkaç Temel Profil kuralı gösterilmektedir:

HSPLandroidx/compose/runtime/ComposerImpl;->updateValue(Ljava/lang/Object;)V
HSPLandroidx/compose/runtime/ComposerImpl;->updatedNodeCount(I)I
HLandroidx/compose/runtime/ComposerImpl;->validateNodeExpected()V
PLandroidx/compose/runtime/CompositionImpl;->applyChanges()V
HLandroidx/compose/runtime/ComposerKt;->findLocation(Ljava/util/List;I)I
Landroidx/compose/runtime/ComposerImpl;

Bu örnek Derleyici Gezgini projesinde profil kurallarını değiştirmeyi deneyebilirsiniz. Derleyici Gezgini'nin yalnızca okunabilir ART profil biçimini (HRF) desteklediğini, bu nedenle joker karakterlerin desteklenmediğini unutmayın.

Kural söz dizimi

Bu kurallar, yöntemleri veya sınıfları hedeflemek için iki biçimden birini alır:

[FLAGS][CLASS_DESCRIPTOR]->[METHOD_SIGNATURE]

Sınıf kuralları aşağıdaki kalıbı kullanır:

[CLASS_DESCRIPTOR]

Ayrıntılı açıklama için aşağıdaki tabloya bakın:

Tek bir kuralın birden fazla yöntem veya sınıfı kapsaması için bu kalıplarda joker karakterler bulunabilir. Android Studio'da kural söz dizimiyle yazma konusunda yardım almak için Android Baseline Profilleri eklentisine bakın.

Joker karakter kuralı örneği şu şekilde olabilir:

HSPLandroidx/compose/ui/layout/**->**(**)**

Temel profil kurallarında desteklenen türler

Referans profil kuralları aşağıdaki türleri destekler. Bu türlerle ilgili ayrıntılar için Dalvik yürütülebilir (DEX) biçimi bölümüne bakın.

Ayrıca kitaplıklar, AAR yapılarına paketlenmiş kurallar tanımlayabilir. Bu yapıları içerecek bir APK oluşturduğunuzda kurallar, manifest birleştirme işlemine benzer şekilde birleştirilir ve APK'ya özel, kompakt bir ikili ART profiline derlenir.

ART, Android 9'da (API düzeyi 28) veya Android 7'de (API düzeyi 24) yükleme sırasında uygulamanın belirli bir alt kümesini AOT derlemek için cihazlarda ProfileInstaller kullanıldığında bu profilden yararlanır.

Temel profilleri manuel olarak toplama

Macrobenchmark kitaplığını oluşturmadan temel profili manuel olarak oluşturabilir ve kritik kullanıcı yolculuklarınız için kullanıcı arayüzü otomasyonları oluşturabilirsiniz. Makrobenchmark'ları kullanmanızı önersek de bu her zaman mümkün olmayabilir. Örneğin, Gradle dışında bir derleme sistemi kullanıyorsanız Temel Profil Gradle eklentisini kullanamazsınız. Bu gibi durumlarda, Temel Profil kurallarını manuel olarak toplayabilirsiniz. API 34 ve sonraki sürümleri çalıştıran bir cihaz veya emülatör kullanıyorsanız bu işlem çok daha kolaydır. Daha düşük API düzeylerinde de mümkündür ancak root erişimi gerektirir ve AOSP resmi çalıştıran bir emülatör kullanmanız gerekir. Aşağıdakileri yaparak kuralları doğrudan toplayabilirsiniz:

1. Uygulamanızın sürüm sürümünü bir test cihazına yükleyin. Doğru bir profil için uygulama derleme türü R8 için optimize edilmiş ve hata ayıklama yapılamayan bir tür olmalıdır.
2. Profillerin derlenmediğinden emin olun.

   API 34 ve sonraki sürümler

   adb shell cmd package compile -f -m verify $PACKAGE_NAME
   adb shell pm art clear-app-profiles $PACKAGE_NAME

   API 33 ve önceki sürümler

   adb root
   adb shell cmd package compile --reset $PACKAGE_NAME

   APK'nız Jetpack Profil Yükleyici kitaplığına bağımlıysa kitaplık, APK'nızın ilk başlatılmasında bir profil oluşturur. Bu, profil oluşturma sürecini etkileyebilir. Bu nedenle, aşağıdaki komutla devre dışı bırakın:

   adb shell am broadcast -a androidx.profileinstaller.action.SKIP_FILE $PACKAGE_NAME/androidx.profileinstaller.ProfileInstallReceiver

3. Uygulamayı çalıştırın ve profil toplamak istediğiniz kritik kullanıcı yolculuklarında manuel olarak gezinin.
4. ART'den profilleri dökmesini isteyin. APK'nız Jetpack Profile Installer kitaplığına bağımlıysa profilleri dökmek için bu kitaplığı kullanın:

   adb shell am broadcast -a androidx.profileinstaller.action.SAVE_FILE $PACKAGE_NAME/androidx.profileinstaller.ProfileInstallReceiver
   adb shell am force-stop $PACKAGE_NAME

   Profil Yükleyici'yi kullanmıyorsanız aşağıdaki komutu kullanarak profilleri bir emülatöre manuel olarak aktarın:

   adb root
   adb shell killall -s SIGUSR1 $PACKAGE_NAME
   adb shell am force-stop $PACKAGE_NAME

5. Profil oluşturma işleminin tamamlanması için en az beş saniye bekleyin.
6. Oluşturulan ikili profilleri metne dönüştürün:

   API 34 ve sonraki sürümler

   adb shell pm dump-profiles --dump-classes-and-methods $PACKAGE_NAME

   API 33 ve önceki sürümler

   Referans profili mi yoksa mevcut profil mi oluşturulduğunu belirleyin. Referans profili, şu konumda yer alır:

   /data/misc/profiles/ref/$$PACKAGE_NAME/primary.prof

   Mevcut profil şu konumda bulunur:

   /data/misc/profiles/cur/0/$PACKAGE_NAME/primary.prof

   APK'nın konumunu belirleyin:

   adb root
   adb shell pm path $PACKAGE_NAME

   Dönüşüm işlemini gerçekleştirin:

   adb root
   adb shell profman --dump-classes-and-methods --profile-file=$PROFILE_PATH --apk=$APK_PATH > /data/misc/profman/$PACKAGE_NAME-primary.prof.txt

7. Depolanan profili cihazdan almak için adb'ü kullanın:

   adb pull /data/misc/profman/$PACKAGE_NAME-primary.prof.txt PATH_TO_APP_MODULE/src/main/

Bu işlem, oluşturulan profil kurallarını alır ve uygulama modülünüze yükler. Uygulamayı bir sonraki derlemenizde Temel Profil dahil edilir. Yükleme sorunları başlıklı makaledeki adımları uygulayarak bunu doğrulayın.

Uygulama iyileştirmelerini manuel olarak ölçme

Uygulama iyileştirmelerini karşılaştırma yoluyla ölçmenizi önemle tavsiye ederiz. Ancak iyileştirmeleri manuel olarak ölçmek istiyorsanız referans olarak optimize edilmemiş uygulama başlatma süresini ölçerek başlayabilirsiniz.

PACKAGE_NAME=com.example.app
# Force Stop App
adb shell am force-stop $PACKAGE_NAME
# Reset compiled state
adb shell cmd package compile --reset $PACKAGE_NAME
# Measure App startup
# This corresponds to `Time to initial display` metric.
adb shell am start-activity -W -n $PACKAGE_NAME/.ExampleActivity \
 | grep "TotalTime"

Ardından, temel profili harici olarak yükleyin.

# Unzip the Release APK first.
unzip release.apk
# Create a ZIP archive.
# The name should match the name of the APK.
# Copy `baseline.prof{m}` and rename it `primary.prof{m}`.
cp assets/dexopt/baseline.prof primary.prof
cp assets/dexopt/baseline.profm primary.profm
# Create an archive.
zip -r release.dm primary.prof primary.profm
# Confirm that release.dm only contains the two profile files:
unzip -l release.dm
# Archive:  release.dm
#   Length      Date    Time    Name
# ---------  ---------- -----   ----
#      3885  1980-12-31 17:01   primary.prof
#      1024  1980-12-31 17:01   primary.profm
# ---------                     -------
#                               2 files
# Install APK + Profile together.
adb install-multiple release.apk release.dm

Paketin yükleme sırasında optimize edildiğini doğrulamak için aşağıdaki komutu çalıştırın:

# Check dexopt state.
adb shell dumpsys package dexopt | grep -A 1 $PACKAGE_NAME

Çıkış, paketin derlendiğini belirtmelidir:

[com.example.app]
  path: /data/app/~~YvNxUxuP2e5xA6EGtM5i9A==/com.example.app-zQ0tkJN8tDrEZXTlrDUSBg==/base.apk
  arm64: [status=speed-profile] [reason=install-dm]

Artık uygulama başlatma performansını, derlenmiş durumu sıfırlamadan önceki gibi ölçebilirsiniz. Paketin derlenmiş durumunu sıfırlamadığınızdan emin olun.

# Force stop app
adb shell am force-stop $PACKAGE_NAME
# Measure app startup
adb shell am start-activity -W -n $PACKAGE_NAME/.ExampleActivity \
 | grep "TotalTime"

Referans Profiller ve profgen

Bu bölümde, profgen aracının bir Referans Profili'nin kompakt ikili sürümünü oluştururken ne yaptığı açıklanmaktadır.

Profgen-cli, profil derleme, iç gözlem ve ART profillerinin dönüştürülmesinde yardımcı olur. Böylece, bu profiller, hedef SDK sürümünden bağımsız olarak Android destekli cihazlara yüklenebilir.

Profgen-cli, bir taban profilin HRF'sini derlenmiş biçimine derleyen bir KSA'dır. CLI ayrıca Android SDK'nın bir parçası olarak cmdline-tools deposunda da gönderilir.

Aşağıdaki özellikler studio-main dalında kullanılabilir:

➜ ../cmdline-tools/latest/bin
apkanalyzer
avdmanager
lint
profgen
retrace
screenshot2
sdkmanager

Profgen-cli ile kompakt ikili profiller oluşturma

Profgen-cli ile kullanılabilen komutlar bin, validate ve dumpProfile'dir. Kullanılabilir komutları görmek için profgen --help simgesini kullanın:

➜  profgen --help
Usage: profgen options_list
Subcommands:
    bin - Generate Binary Profile
    validate - Validate Profile
    dumpProfile - Dump a binary profile to a HRF

Options:
    --help, -h -> Usage info

Kompakt ikili profili oluşturmak için bin komutunu kullanın. Aşağıda örnek bir çağrı verilmiştir:

profgen bin ./baseline-prof.txt \
  --apk ./release.apk \
  --map ./obfuscation-map.txt \
  --profile-format v0_1_0_p \
  --output ./baseline.prof \

Kullanılabilir seçenekleri görmek için profgen bin options_list simgesini kullanın:

Usage: profgen bin options_list
Arguments:
    profile -> File path to Human Readable profile { String }
Options:
    --apk, -a -> File path to apk (always required) { String }
    --output, -o -> File path to generated binary profile (always required)
    --map, -m -> File path to name obfuscation map { String }
    --output-meta, -om -> File path to generated metadata output { String }
    --profile-format, -pf [V0_1_0_P] -> The ART profile format version
      { Value should be one of [
         v0_1_5_s, v0_1_0_p, v0_0_9_omr1, v0_0_5_o, v0_0_1_n
        ]
      }
    --help, -h -> Usage info

İlk bağımsız değişken, baseline-prof.txt HRF'nin yolunu temsil eder.

Profgen-cli, APK'nın sürüm derlemesine ve R8 veya ProGuard kullanılırken APK'nın kodunu karartmak için kullanılan bir karartma haritasına da ihtiyaç duyar. Bu sayede profgen, derlenmiş profili oluştururken HRF'deki kaynak sembolleri, karartılmış karşılıklarına çevirebilir.

ART profil biçimleri ileri veya geriye dönük uyumlu olmadığından, profgen'ün gerektiğinde bir ART profil biçimini diğerine kod dönüştürmek için kullanabileceğiniz profil meta verilerini (profm) paketlemesi amacıyla bir profil biçimi sağlayın.

Profil biçimleri ve platform sürümleri

Profil biçimi seçerken aşağıdaki seçenekler kullanılabilir:

baseline.prof ve baseline.profm çıkış dosyalarını APK'daki assets veya dexopt klasörüne kopyalayın.

Kod karartma haritaları

Yalnızca HRF kaynak simgeleri kullanıyorsa karartma haritasını sağlamanız gerekir. HRF, zaten kodu karartılmış bir sürümden oluşturulduysa ve eşleme gerekmiyorsa bu seçeneği yoksayabilir ve çıkışları assets veya dexopt klasörüne kopyalayabilirsiniz.

Temel profillerin geleneksel kurulumu

Taban profiller geleneksel olarak bir cihaza iki yoldan biriyle yayınlanır.

install-multiple öğesini DexMetadata ile kullanma

API 28 ve sonraki sürümleri çalıştıran cihazlarda Play istemcisi, yüklenen APK sürümünün APK'sını ve DexMetadata (DM) yükünü indirir. DM, cihazdaki Paket Yöneticisi'ne aktarılan profil bilgilerini içerir.

APK ve DM, aşağıdaki gibi bir yöntem kullanılarak tek bir yükleme oturumunun parçası olarak yüklenir:

adb install-multiple base.apk base.dm

Jetpack Profil Yükleyici

API düzeyi 29 ve sonraki sürümleri çalıştıran cihazlarda Jetpack ProfileInstaller kitaplığı, APK cihaza yüklendikten sonra assets veya dexopt içine paketlenmiş bir profili yüklemek için alternatif bir mekanizma sağlar. ProfileInstaller, ProfileInstallReceiver veya doğrudan uygulama tarafından çağrılır.

ProfileInstaller kitaplığı, hedef cihazın SDK sürümüne göre profili yeniden kodlar ve cihazdaki cur dizinine (cihazdaki ART profilleri için pakete özel bir hazırlık dizini) kopyalar.

Cihaz boştayken profil, cihazda bg-dexopt adlı bir işlem tarafından alınır.

Temel profili harici olarak yükleme

Bu bölümde, bir APK verildiğinde ana profilin nasıl yükleneceği açıklanmaktadır.

androidx.profileinstaller ile anons yapma

API 24 ve sonraki sürümleri çalıştıran cihazlarda profili yükleme komutu yayınlayabilirsiniz:

# Broadcast the install profile command - moves binary profile from assets
#     to a location where ART uses it for the next compile.
#     When successful, the following command prints "1":
adb shell am broadcast \
    -a androidx.profileinstaller.action.INSTALL_PROFILE \
    <pkg>/androidx.profileinstaller.ProfileInstallReceiver

# Kill the process
am force-stop <pkg>

# Compile the package based on profile
adb shell cmd package compile -f -m speed-profile <pkg>

ProfileInstaller, Play'deki 450.000 uygulamanın yaklaşık 77.000'inde bulunan temel profillere sahip çoğu APK'da bulunmaz. Ancak Compose kullanan hemen her APK'da bulunur. Bunun nedeni, kitaplıkların ProfileInstaller'a bağımlı olduğunu belirtmeden profil sağlayabilmesidir. Profili olan her kitaplığa bağımlılık eklemek Jetpack ile başlayarak uygulanır.

install-multiple öğesini profgen veya DexMetaData ile kullanın

API 28 ve sonraki sürümleri çalıştıran cihazlarda, uygulamada ProfileInstaller kitaplığının bulunmasına gerek kalmadan bir temel profil yükleyebilirsiniz.

Bunu yapmak için Profgen-cli'yi kullanın:

profgen extractProfile \
        --apk app-release.apk \
        --output-dex-metadata app-release.dm \
        --profile-format V0_1_5_S # Select based on device and the preceding table.

# Install APK and the profile together
adb install-multiple appname-release.apk appname-release.dm

APK bölmelerini desteklemek için önceki profil ayıklama adımlarını APK başına bir kez çalıştırın. Yükleme sırasında her APK'yı ve ilişkili .dm dosyasını ileterek APK ve .dm adlarının eşleştiğinden emin olun:

adb install-multiple appname-base.apk appname-base.dm \
appname-split1.apk appname-split1.dm

Doğrulama

Profilin düzgün şekilde yüklendiğini doğrulamak için Uygulama iyileştirmelerini manuel olarak ölçme adımlarını kullanabilirsiniz.

İkili profilin içeriğini dökme

Temel profilin kompakt ikili sürümünün içeriğini incelemek için Profgen-cli dumpProfile seçeneğini kullanın:

Usage: profgen dumpProfile options_list
Options:
    --profile, -p -> File path to the binary profile (always required)
    --apk, -a -> File path to apk (always required) { String }
    --map, -m -> File path to name obfuscation map { String }
    --strict, -s [true] -> Strict mode
    --output, -o -> File path for the HRF (always required) { String }
    --help, -h -> Usage info

Kompakt ikili gösterimi yalnızca DEX ofsetlerini depoladığından, APK'ya dumpProfile için ihtiyaç duyar. Bu nedenle, sınıf ve yöntem adlarını yeniden oluşturmaları gerekir.

Sıkı mod varsayılan olarak etkindir ve bu modda, profilin APK'daki DEX dosyalarıyla uyumluluğu kontrol edilir. Başka bir araç tarafından oluşturulan profillerde hata ayıklama işlemi yapmaya çalışıyorsanız uyumluluk hataları alabilirsiniz. Bu hatalar, inceleme için döküm almanızı engelleyebilir. Bu gibi durumlarda --strict false ile yüksek güvenlik modunu devre dışı bırakabilirsiniz. Ancak çoğu durumda yüksek güvenlik modunu etkin tutmanız gerekir.

Gizleme haritası isteğe bağlıdır. Sağlandığında, kullanım kolaylığı için gizlenen sembollerin insan tarafından okunabilen sürümleriyle yeniden eşlenmesine yardımcı olur.