मैन्युअल तरीके से बेसलाइन प्रोफ़ाइल बनाएं और उन्हें मेज़र करें

हमारा सुझाव है कि प्रोफ़ाइल के नियमों को जनरेट करने की प्रोसेस को ऑटोमेट करने के लिए, Jetpack Macrobenchmark library का इस्तेमाल करें. इससे, मैन्युअल तरीके से काम करने की ज़रूरत कम हो जाएगी और सामान्य स्केलेबिलिटी बढ़ जाएगी. हालांकि, आपके पास अपने ऐप्लिकेशन में, प्रोफ़ाइल के नियमों को मैन्युअल तरीके से बनाने और उनका मेज़रमेंट करने का विकल्प होता है.

प्रोफ़ाइल के नियम मैन्युअल तरीके से तय करना

किसी ऐप्लिकेशन या लाइब्रेरी मॉड्यूल में, प्रोफ़ाइल के नियम मैन्युअल तरीके से तय किए जा सकते हैं. इसके लिए, src/main डायरेक्ट्री में मौजूद baseline-prof.txt नाम की फ़ाइल बनाएं. यह वही फ़ोल्डर है जिसमें AndroidManifest.xml फ़ाइल मौजूद होती है.

इस फ़ाइल में, हर लाइन पर एक नियम तय किया जाता है. हर नियम, ऐप्लिकेशन या लाइब्रेरी में मौजूद उन तरीकों या क्लास के लिए एक पैटर्न दिखाता है जिन्हें ऑप्टिमाइज़ करने की ज़रूरत होती है.

adb shell profman --dump-classes-and-methods का इस्तेमाल करने पर, इन नियमों का सिंटैक्स, आसानी से पढ़े जा सकने वाले एआरटी प्रोफ़ाइल फ़ॉर्मैट (एचआरएफ़) का सुपरसेट होता है. यह सिंटैक्स, डिस्क्रिप्टर और सिग्नेचरके सिंटैक्स जैसा होता है. हालांकि, इसमें वाइल्डकार्ड का इस्तेमाल करके, नियम लिखने की प्रोसेस को आसान बनाया जा सकता है.

यहां Jetpack Compose लाइब्रेरी में शामिल, बेसलाइन प्रोफ़ाइल के कुछ नियमों का उदाहरण दिया गया है:

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;

इस सैंपल Compiler Explorer प्रोजेक्ट में, प्रोफ़ाइल के नियमों में बदलाव किया जा सकता है. ध्यान दें कि Compiler Explorer सिर्फ़ आसानी से पढ़े जा सकने वाले एआरटी प्रोफ़ाइल फ़ॉर्मैट (एचआरएफ़) के साथ काम करता है. इसलिए, इसमें वाइल्डकार्ड इस्तेमाल नहीं किए जा सकते.

नियमों का सिंटैक्स

ये नियम, तरीकों या क्लास को टारगेट करने के लिए, दो फ़ॉर्मैट में से किसी एक का इस्तेमाल करते हैं:

[FLAGS][CLASS_DESCRIPTOR]->[METHOD_SIGNATURE]

क्लास के नियम के लिए, इस पैटर्न का इस्तेमाल किया जाता है:

[CLASS_DESCRIPTOR]

ज़्यादा जानकारी के लिए, यह टेबल देखें:

सिंटैक्स ब्यौरा
FLAGS यह H, S, और P वर्णों में से एक या उससे ज़्यादा वर्णों को दिखाता है. इससे यह पता चलता है कि स्टार्टअप टाइप के हिसाब से, इस तरीके को Hot, Startup, या Post Startup के तौर पर फ़्लैग किया जाना चाहिए या नहीं.

फ़्लैग वाला तरीका, "हॉट" तरीका होता है. इसका मतलब है कि ऐप्लिकेशन के लाइफ़टाइम में इसे कई बार कॉल किया जाता है.

फ़्लैग वाला तरीका, स्टार्टअप के दौरान कॉल किया जाने वाला तरीका होता है.HS

P फ़्लैग वाला तरीका, स्टार्टअप के बाद कॉल किया जाने वाला तरीका होता है.

इस फ़ाइल में मौजूद क्लास से पता चलता है कि इसका इस्तेमाल स्टार्टअप के दौरान किया जाता है. साथ ही, क्लास लोडिंग की लागत से बचने के लिए, इसे हीप में पहले से ही एलोकेट किया जाना चाहिए. एआरटी कंपाइलर, ऑप्टिमाइज़ेशन की अलग-अलग रणनीतियों का इस्तेमाल करता है. जैसे, इन तरीकों का एओटी कंपाइलेशन और जनरेट की गई एओटी फ़ाइल में लेआउट ऑप्टिमाइज़ेशन करना.
CLASS_DESCRIPTOR टारगेट किए गए तरीके की क्लास के लिए डिस्क्रिप्टर. उदाहरण के लिए, androidx.compose.runtime.SlotTable का डिस्क्रिप्टर Landroidx/compose/runtime/SlotTable; है. यहां Dalvik Executable (DEX) फ़ॉर्मैट के हिसाब से, L को पहले जोड़ा गया है.
METHOD_SIGNATURE तरीके का सिग्नेचर, जिसमें तरीके का नाम, पैरामीटर टाइप, और रिटर्न टाइप शामिल होते हैं. उदाहरण के लिए:

// LayoutNode.kt

fun isPlaced():Boolean {
// ...
}

LayoutNode पर isPlaced()Z का सिग्नेचर है.

इन पैटर्न में वाइल्डकार्ड हो सकते हैं, ताकि एक ही नियम में कई तरीकों या क्लास शामिल की जा सकें. Android Studio में, नियमों के सिंटैक्स का इस्तेमाल करके लिखने के बारे में मदद पाने के लिए, Android Baseline Profiles प्लगिन देखें.

वाइल्डकार्ड वाले नियम का एक उदाहरण यहां दिया गया है:

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

बेसलाइन प्रोफ़ाइल के नियमों में इस्तेमाल किए जा सकने वाले टाइप

बेसलाइन प्रोफ़ाइल के नियमों में, ये टाइप इस्तेमाल किए जा सकते हैं. इन टाइप के बारे में ज़्यादा जानने के लिए, देखें Dalvik Executable (DEX) फ़ॉर्मैट.

वर्ण टाइप ब्यौरा
B बाइट साइन किया गया बाइट
C कैरेक्टर UTF-16 में एनकोड किया गया यूनिकोड कैरेक्टर कोड पॉइंट
D डबल डबल-प्रेसिशन फ़्लोटिंग पॉइंट वैल्यू
F फ़्लोट सिंगल-प्रेसिशन फ़्लोटिंग पॉइंट वैल्यू
I आईएनटी पूर्णांक
J लंबा लंबा पूर्णांक
S लघु साइन किया गया शॉर्ट
V void Void
Z बूलियन सही या गलत
L (क्लास का नाम) रेफ़रंस क्लास के नाम का इंस्टेंस

इसके अलावा, लाइब्रेरी में ऐसे नियम तय किए जा सकते हैं जिन्हें एएआर आर्टफ़ैक्ट में पैकेज किया जाता है. इन आर्टफ़ैक्ट को शामिल करने के लिए, APK बनाने पर, नियमों को मर्ज किया जाता है. यह प्रोसेस, मेनिफ़ेस्ट मर्ज करने की प्रोसेस जैसी होती है. इसके बाद, इन्हें कंपाइल करके, कॉम्पैक्ट बाइनरी एआरटी प्रोफ़ाइल बनाई जाती है. यह प्रोफ़ाइल, APK के हिसाब से होती है.

एआरटी, डिवाइसों पर APK का इस्तेमाल करने पर, इस प्रोफ़ाइल का इस्तेमाल करता है. इससे, Android 9 (एपीआई लेवल 28) पर इंस्टॉल करते समय, ऐप्लिकेशन के किसी खास सबसेट को एओटी कंपाइल किया जा सकता है. वहीं, Android 7 (एपीआई लेवल 24) पर भी यह सुविधा मिलती है, जब ProfileInstaller का इस्तेमाल किया जाता है.

बेसलाइन प्रोफ़ाइलें मैन्युअल तरीके से इकट्ठा करना

Macrobenchmark लाइब्रेरी को सेट अप किए बिना, बेसलाइन प्रोफ़ाइल को मैन्युअल तरीके से जनरेट किया जा सकता है. साथ ही, उपयोगकर्ता के अहम सफ़र के लिए, यूज़र इंटरफ़ेस (यूआई) के ऑटोमेशन बनाए जा सकते हैं. हमारा सुझाव है कि Macrobenchmarks का इस्तेमाल करें. हालांकि, ऐसा करना हमेशा मुमकिन नहीं होता. उदाहरण के लिए, अगर Gradle के अलावा किसी अन्य बिल्ड सिस्टम का इस्तेमाल किया जा रहा है, तो बेसलाइन प्रोफ़ाइल Gradle प्लगिन का इस्तेमाल नहीं किया जा सकता. ऐसे मामलों में, बेसलाइन प्रोफ़ाइल के नियमों को मैन्युअल तरीके से इकट्ठा किया जा सकता है. अगर एपीआई लेवल 34 और इसके बाद के वर्शन पर चलने वाले डिवाइस या एम्युलेटर का इस्तेमाल किया जाता है, तो यह काम ज़्यादा आसानी से किया जा सकता है. हालांकि, एपीआई लेवल कम होने पर भी यह काम किया जा सकता है. इसके लिए, रूट ऐक्सेस की ज़रूरत होती है. साथ ही, एओएसपी इमेज पर चलने वाले एम्युलेटर का इस्तेमाल करना होता है. नियमों को सीधे तौर पर इकट्ठा करने के लिए, यह तरीका अपनाएं:

  1. टेस्ट डिवाइस पर, अपने ऐप्लिकेशन का रिलीज़ वर्शन इंस्टॉल करें. ऐप्लिकेशन का बिल्ड टाइप, R8 से ऑप्टिमाइज़ नहीं किया गया होना चाहिए. साथ ही, इसे डीबग नहीं किया जा सकता. इससे, बिल्ड सिस्टम के लिए इस्तेमाल की जा सकने वाली प्रोफ़ाइल कैप्चर की जा सकती है.
  2. प्रोफ़ाइल इंस्टॉल करने की सुविधा बंद करें और ऐप्लिकेशन को बंद करें.

    अगर आपके APK में, Jetpack Profile Installer लाइब्रेरी की डिपेंडेंसी है, तो लाइब्रेरी आपके APK के पहली बार लॉन्च होने पर, प्रोफ़ाइल को बूटस्ट्रैप करती है. इससे, प्रोफ़ाइल जनरेट करने की प्रोसेस में रुकावट आ सकती है. इसलिए, इसे बंद करने के लिए यह कमांड इस्तेमाल करें:

    adb shell am broadcast -a androidx.profileinstaller.action.SKIP_FILE WRITE_SKIP_FILE $PACKAGE_NAME/androidx.profileinstaller.ProfileInstallReceiver
  3. ऐप्लिकेशन के कंपाइलेशन को रीसेट करें और सभी प्रोफ़ाइलें मिटाएं.

    एपीआई लेवल 34 और इसके बाद के वर्शन

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

    एपीआई लेवल 33 और इससे पहले के वर्शन

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

  4. ऐप्लिकेशन चलाएं और उपयोगकर्ता के उन अहम सफ़र पर मैन्युअल तरीके से नेविगेट करें जिनके लिए आपको प्रोफ़ाइल इकट्ठा करनी है.

  5. प्रोफ़ाइलों को स्थिर होने देने के लिए, कम से कम पांच सेकंड इंतज़ार करें.

  6. सेव करने की कार्रवाई करें और सेव होने तक इंतज़ार करें. अगर आपके APK में, Jetpack Profile Installer लाइब्रेरी की डिपेंडेंसी है, तो प्रोफ़ाइलें डंप करने के लिए, इसका इस्तेमाल करें:

    adb shell am broadcast -a androidx.profileinstaller.action.SAVE_PROFILE $PACKAGE_NAME/androidx.profileinstaller.ProfileInstallReceiver
    sleep 1 # wait 1 second
    adb shell am force-stop $PACKAGE_NAME
    अगर Profile Installer का इस्तेमाल नहीं किया जा रहा है, तो एम्युलेटर पर, प्रोफ़ाइलें मैन्युअल तरीके से डंप करने के लिए यह कमांड इस्तेमाल करें:

    adb root
    adb shell killall -s SIGUSR1 $PACKAGE_NAME
    sleep 1 # wait 1 second
    adb shell am force-stop $PACKAGE_NAME

  7. जनरेट की गई बाइनरी प्रोफ़ाइलों को टेक्स्ट में बदलें:

    एपीआई लेवल 34 और इसके बाद के वर्शन

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

    एपीआई लेवल 33 और इससे पहले के वर्शन

    यह तय करें कि रेफ़रंस प्रोफ़ाइल या मौजूदा प्रोफ़ाइल बनाई गई है या नहीं. रेफ़रंस प्रोफ़ाइल, इस जगह पर मौजूद होती है:

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

    मौजूदा प्रोफ़ाइल, इस जगह पर मौजूद होती है:

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

    APK की जगह तय करें:

    adb root
    adb shell pm path $PACKAGE_NAME

    कन्वर्ज़न की प्रोसेस पूरी करें:

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

  8. डिवाइस से डंप की गई प्रोफ़ाइल को वापस पाने के लिए, adb का इस्तेमाल करें:

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

इससे, जनरेट किए गए प्रोफ़ाइल के नियम वापस आ जाते हैं और आपके ऐप्लिकेशन मॉड्यूल में इंस्टॉल हो जाते हैं. अगली बार ऐप्लिकेशन बनाने पर, बेसलाइन प्रोफ़ाइल शामिल की जाती है. इंस्टॉल करने से जुड़ी समस्याएं में दिए गए तरीके अपनाकर, इसकी पुष्टि करें.

ऐप्लिकेशन में हुए सुधारों का मेज़रमेंट मैन्युअल तरीके से करना

हमारा सुझाव है कि बेंचमार्किंग की मदद से, ऐप्लिकेशन में हुए सुधारों का मेज़रमेंट करें. हालांकि, अगर आपको सुधारों का मेज़रमेंट मैन्युअल तरीके से करना है, तो रेफ़रंस के लिए, ऑप्टिमाइज़ न किए गए ऐप्लिकेशन के स्टार्टअप का मेज़रमेंट करके शुरू करें.

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"

इसके बाद, बेसलाइन प्रोफ़ाइल को साइडलोड करें.

# 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

यह पुष्टि करने के लिए कि पैकेज को इंस्टॉल करते समय ऑप्टिमाइज़ किया गया था, यह कमांड चलाएं:

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

आउटपुट में यह जानकारी होनी चाहिए कि पैकेज कंपाइल किया गया है:

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

अब, ऐप्लिकेशन के स्टार्टअप की परफ़ॉर्मेंस का मेज़रमेंट पहले की तरह किया जा सकता है. हालांकि, कंपाइल की गई स्थिति को रीसेट करने की ज़रूरत नहीं है. पक्का करें कि पैकेज के लिए, कंपाइल की गई स्थिति को रीसेट न किया जाए.

# 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"

बेसलाइन प्रोफ़ाइलें और profgen

इस सेक्शन में बताया गया है कि profgen टूल, बेसलाइन प्रोफ़ाइल का कॉम्पैक्ट बाइनरी वर्शन बनाते समय क्या करता है.

Profgen-cli, प्रोफ़ाइल कंपाइल करने, इंट्रॉस्पेक्शन, और एआरटी प्रोफ़ाइलों को ट्रांसपाइल करने में मदद करता है. इसलिए, इन्हें टारगेट एसडीके वर्शन के बावजूद, Android पर चलने वाले डिवाइसों पर इंस्टॉल किया जा सकता है.

Profgen-cli एक सीएलआई है, जो बेसलाइन प्रोफ़ाइल के एचआरएफ़ को कंपाइल किए गए फ़ॉर्मैट में कंपाइल करता है. सीएलआई, Android SDK के हिस्से के तौर पर, cmdline-tools रिपॉज़िटरी में भी शिप होता है.

studio-main ब्रांच में ये सुविधाएं उपलब्ध हैं:

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

Profgen-cli की मदद से, कॉम्पैक्ट बाइनरी प्रोफ़ाइलें बनाना

Profgen-cli के साथ, bin, validate, और dumpProfile कमांड इस्तेमाल किए जा सकते हैं. उपलब्ध कमांड देखने के लिए, profgen --help का इस्तेमाल करें:

  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

कॉम्पैक्ट बाइनरी प्रोफ़ाइल जनरेट करने के लिए, bin कमांड का इस्तेमाल करें. यहां इनवोकेशन का एक उदाहरण दिया गया है:

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

उपलब्ध विकल्प देखने के लिए, profgen bin options_list का इस्तेमाल करें:

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

पहले आर्ग्युमेंट में, baseline-prof.txt एचआरएफ़ का पाथ दिखता है.

Profgen-cli को, APK के रिलीज़ बिल्ड का पाथ और एक अस्पष्ट बनाने वाला मैप भी चाहिए. इसका इस्तेमाल, R8 या Proguard का इस्तेमाल करते समय, APK को अस्पष्ट बनाने के लिए किया जाता है. इस तरह, कंपाइल की गई प्रोफ़ाइल बनाते समय, profgen, एचआरएफ़ में मौजूद सोर्स सिंबल को उनके अस्पष्ट बनाए गए नामों में बदल सकता है.

एआरटी प्रोफ़ाइल के फ़ॉर्मैट, फ़ॉरवर्ड या बैकवर्ड कंपैटिबल नहीं होते. इसलिए, प्रोफ़ाइल का फ़ॉर्मैट उपलब्ध कराएं, ताकि profgen, प्रोफ़ाइल मेटाडेटा (profm) को पैकेज कर सके. इसका इस्तेमाल, ज़रूरत पड़ने पर, एक एआरटी प्रोफ़ाइल फ़ॉर्मैट को दूसरे में ट्रांसकोड करने के लिए किया जा सकता है.

प्रोफ़ाइल के फ़ॉर्मैट और प्लैटफ़ॉर्म के वर्शन

प्रोफ़ाइल का फ़ॉर्मैट चुनते समय, ये विकल्प उपलब्ध होते हैं:

प्रोफ़ाइल का फ़ॉर्मैट प्लैटफ़ॉर्म वर्शन एपीआई लेवल
v0_1_5_s Android S और इसके बाद के वर्शन 31 से ज़्यादा
v0_1_0_p Android P, Q, और R 28-30
v0_0_9_omr1 Android O MR1 27
v0_0_5_o Android O 26
v0_0_1_n Android N 24-25

आउटपुट फ़ाइलें baseline.prof और baseline.profm को APK में मौजूद assets या dexopt फ़ोल्डर में कॉपी करें.

अस्पष्ट बनाने वाले मैप

अस्पष्ट बनाने वाला मैप सिर्फ़ तब उपलब्ध कराएं, जब एचआरएफ़ में सोर्स सिंबल का इस्तेमाल किया गया हो. अगर एचआरएफ़, रिलीज़ बिल्ड से जनरेट किया गया है, जिसे पहले से ही अस्पष्ट बनाया गया है और मैपिंग की ज़रूरत नहीं है, तो उस विकल्प को अनदेखा किया जा सकता है. साथ ही, आउटपुट को assets या dexopt फ़ोल्डर में कॉपी किया जा सकता है.

बेसलाइन प्रोफ़ाइलें इंस्टॉल करने का पारंपरिक तरीका

बेसलाइन प्रोफ़ाइलें, पारंपरिक तौर पर किसी डिवाइस पर दो तरीकों से डिलीवर की जाती हैं.

DexMetadata के साथ install-multiple का इस्तेमाल करना

एपीआई लेवल 28 और इसके बाद के वर्शन पर चलने वाले डिवाइसों पर, Play क्लाइंट, इंस्टॉल किए जा रहे APK वर्शन के लिए, APK और DexMetadata (DM) पेलोड डाउनलोड करता है. डीएम में, प्रोफ़ाइल की जानकारी होती है. यह जानकारी, डिवाइस पर मौजूद Package Manager को पास की जाती है.

APK और डीएम, इंस्टॉल करने के एक ही सेशन के दौरान इंस्टॉल किए जाते हैं. इसके लिए, इस तरह के कमांड का इस्तेमाल किया जाता है:

adb install-multiple base.apk base.dm

Jetpack ProfileInstaller

एपीआई लेवल 29 और इसके बाद के वर्शन पर चलने वाले डिवाइसों पर, Jetpack ProfileInstaller लाइब्रेरी, assets या dexopt में पैकेज की गई प्रोफ़ाइल को इंस्टॉल करने के लिए एक वैकल्पिक तरीका उपलब्ध कराती है. यह तरीका, डिवाइस पर APK इंस्टॉल होने के बाद काम करता है. ProfileInstaller, ProfileInstallReceiver या सीधे ऐप्लिकेशन से शुरू होता है.

ProfileInstaller लाइब्रेरी, टारगेट डिवाइस के एसडीके वर्शन के हिसाब से प्रोफ़ाइल को ट्रांसकोड करती है. साथ ही, प्रोफ़ाइल को डिवाइस पर मौजूद cur डायरेक्ट्री में कॉपी करती है. यह डायरेक्ट्री, डिवाइस पर एआरटी प्रोफ़ाइलों के लिए, पैकेज के हिसाब से बनाई गई स्टेजिंग डायरेक्ट्री होती है.

डिवाइस के आइडल होने के बाद, प्रोफ़ाइल को डिवाइस पर bg-dexopt नाम की प्रोसेस पिक अप करती है.

बेसलाइन प्रोफ़ाइल को साइडलोड करना

इस सेक्शन में, किसी APK के लिए बेसलाइन प्रोफ़ाइल इंस्टॉल करने का तरीका बताया गया है.

androidx.profileinstaller के साथ ब्रॉडकास्ट करना

एपीआई लेवल 24 और इसके बाद के वर्शन पर चलने वाले डिवाइसों पर, प्रोफ़ाइल इंस्टॉल करने के लिए, ब्रॉडकास्ट कमांड का इस्तेमाल किया जा सकता है:

# 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>

ज़्यादातर APK में, बेसलाइन प्रोफ़ाइल के साथ ProfileInstaller मौजूद नहीं होता. Play पर मौजूद 4.5 लाख ऐप्लिकेशन में से करीब 77 हज़ार ऐप्लिकेशन में यह मौजूद नहीं है. हालांकि, Compose का इस्तेमाल करने वाले हर APK में यह मौजूद होता है. ऐसा इसलिए है, क्योंकि लाइब्रेरी, ProfileInstaller पर डिपेंडेंसी का एलान किए बिना, प्रोफ़ाइलें उपलब्ध करा सकती हैं. प्रोफ़ाइल वाली हर लाइब्रेरी में डिपेंडेंसी जोड़ने की सुविधा, Jetpack से शुरू होती है.

Profgen या DexMetaData के साथ install-multiple का इस्तेमाल करना

एपीआई लेवल 28 और इसके बाद के वर्शन पर चलने वाले डिवाइसों पर, ऐप्लिकेशन में ProfileInstaller लाइब्रेरी के बिना भी, बेसलाइन प्रोफ़ाइल को साइडलोड किया जा सकता है.

ऐसा करने के लिए, Profgen-cli का इस्तेमाल करें:

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 स्प्लिट की सुविधा के लिए, प्रोफ़ाइल एक्सट्रैक्ट करने के लिए ऊपर दिए गए चरणों को हर APK के लिए एक बार करें. इंस्टॉल करते समय, हर APK और उससे जुड़ी .dm फ़ाइल पास करें. साथ ही, पक्का करें कि APK और .dm के नाम एक जैसे हों:

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

पुष्टि

यह पुष्टि करने के लिए कि प्रोफ़ाइल सही तरीके से इंस्टॉल की गई है, ऐप्लिकेशन में हुए सुधारों का मेज़रमेंट मैन्युअल तरीके से करना में दिए गए चरणों का इस्तेमाल किया जा सकता है.

बाइनरी प्रोफ़ाइल का कॉन्टेंट डंप करना

बेसलाइन प्रोफ़ाइल के कॉम्पैक्ट बाइनरी वर्शन का कॉन्टेंट देखने के लिए, Profgen-cli के dumpProfile विकल्प का इस्तेमाल करें:

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

dumpProfile को APK की ज़रूरत होती है, क्योंकि कॉम्पैक्ट बाइनरी रिप्रेजेंटेशन में सिर्फ़ DEX ऑफ़सेट सेव होते हैं. इसलिए, क्लास और तरीके के नाम फिर से बनाने के लिए, इसकी ज़रूरत होती है.

स्ट्रिक्ट मोड डिफ़ॉल्ट रूप से चालू होता है. इससे, APK में मौजूद DEX फ़ाइलों के साथ प्रोफ़ाइल की कंपैटिबिलिटी की जांच की जाती है. अगर किसी अन्य टूल से जनरेट की गई प्रोफ़ाइलों को डीबग करने की कोशिश की जा रही है, तो कंपैटिबिलिटी से जुड़ी गड़बड़ियां आ सकती हैं. इससे, जांच के लिए प्रोफ़ाइल डंप नहीं की जा सकती. ऐसे मामलों में, --strict false का इस्तेमाल करके, स्ट्रिक्ट मोड को बंद किया जा सकता है. हालांकि, ज़्यादातर मामलों में, स्ट्रिक्ट मोड को चालू रखना चाहिए.

एक अस्पष्ट बनाने वाला मैप ज़रूरी नहीं है. इसे उपलब्ध कराने पर, यह अस्पष्ट बनाए गए सिंबल को आसानी से इस्तेमाल करने के लिए, आसानी से पढ़े जा सकने वाले वर्शन में रीमैप करने में मदद मिलती है.