[No QA] Combine PGO tooling and emulator CI verification

.github/workflows/pgoEvaluation.yml

@@ -0,0 +1,123 @@
+name: Verify native PGO on emulators
+
+on:
+  push:
+    branches: ['@chrispader/perf/pgo-ci-verification']
+  workflow_dispatch:
+    inputs:
+      platform:
+        description: Platforms to verify
+        type: choice
+        default: both
+        options: [both, android, ios]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pgo-emulator-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  STANDALONE_NEW_DOT: 'false'
+  IS_HYBRID_APP: 'true'
+  BUNDLER: metro
+  SENTRY_DISABLE_AUTO_UPLOAD: 'true'
+  CMAKE_BUILD_PARALLEL_LEVEL: '2'
+
+jobs:
+  verify:
+    # Only the copied, reviewed branch in App receives private dependency access.
+    if: github.repository == 'Expensify/App' && github.ref == 'refs/heads/@chrispader/perf/pgo-ci-verification'
+    runs-on: ${{ matrix.platform == 'android' && 'ubuntu-24.04' || 'blacksmith-12vcpu-macos-latest' }}
+    timeout-minutes: 360
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: ${{ fromJSON(inputs.platform == 'android' && '["android"]' || inputs.platform == 'ios' && '["ios"]' || '["android","ios"]') }}
+    steps:
+      - name: Check existing repository secrets
+        env:
+          CHECKOUT_TOKEN: ${{ secrets.OS_BOTIFY_TOKEN }}
+          MAPBOX_TOKEN: ${{ secrets.MAPBOX_SDK_DOWNLOAD_TOKEN }}
+        run: |
+          test -n "$CHECKOUT_TOKEN" || { echo '::error::Add the existing OS_BOTIFY_TOKEN repository secret with access to Mobile-Expensify.'; exit 1; }
+          test -n "$MAPBOX_TOKEN" || { echo '::error::Add the existing MAPBOX_SDK_DOWNLOAD_TOKEN repository secret.'; exit 1; }
+      - name: Checkout the candidate and its pinned native sources
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+        with:
+          submodules: recursive
+          token: ${{ secrets.OS_BOTIFY_TOKEN }}
+          persist-credentials: false
+      - name: Verify native checkout
+        run: |
+          test "$(git -C Mobile-Expensify rev-parse HEAD)" = "$(git ls-tree HEAD Mobile-Expensify | awk '{print $3}')"
+          test "$(./scripts/is-hybrid-app.sh)" = true
+      - name: Free space for Android source builds
+        if: matrix.platform == 'android'
+        run: sudo rm -rf /usr/share/dotnet /usr/local/.ghcup /opt/ghc /usr/local/share/powershell
+      - name: Setup HybridApp dependencies
+        uses: ./.github/actions/composite/setupNode
+        with:
+          IS_HYBRID_BUILD: 'true'
+      - name: Setup private SDK downloads
+        env:
+          MAPBOX_TOKEN: ${{ secrets.MAPBOX_SDK_DOWNLOAD_TOKEN }}
+        run: ./scripts/setup-mapbox-sdk.sh "$MAPBOX_TOKEN"
+
+      - name: Read repository Java version
+        if: matrix.platform == 'android'
+        id: java
+        uses: ./.github/actions/composite/getJavaVersion
+      - name: Setup Java
+        if: matrix.platform == 'android'
+        uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654
+        with:
+          distribution: temurin
+          java-version: ${{ steps.java.outputs.version }}
+      - name: Setup Android build tools and emulator access
+        if: matrix.platform == 'android'
+        run: |
+          "$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager" 'platforms;android-37.0' 'build-tools;36.0.0' 'ndk;27.1.12297006' 'cmake;3.22.1'
+          echo "ANDROID_NDK_HOME=$ANDROID_HOME/ndk/27.1.12297006" >> "$GITHUB_ENV"
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
+      - name: Verify Android PGO on a disposable emulator
+        if: matrix.platform == 'android'
+        uses: ReactiveCircus/android-emulator-runner@a421e43855164a8197daf9d8d40fe71c6996bb0d # v2.38.0
+        with:
+          api-level: 36
+          arch: x86_64
+          target: google_apis
+          profile: pixel_7
+          disable-animations: true
+          script: npm run pgo:verify-ci -- android
+
+      - name: Select repository Xcode
+        if: matrix.platform == 'ios'
+        uses: ./.github/actions/composite/getXcodeVersion
+      - name: Setup Ruby and CocoaPods
+        if: matrix.platform == 'ios'
+        id: ruby
+        uses: ruby/setup-ruby@afeafc3d1ab54a631816aba4c914a0081c12ff2f
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+      - name: Verify iOS PGO on a disposable simulator
+        if: matrix.platform == 'ios'
+        env:
+          BUNDLE_GEMFILE: ${{ github.workspace }}/Gemfile
+        run: |
+          export PATH="${{ steps.ruby.outputs.ruby-prefix }}/bin:$PATH"
+          npm run pgo:verify-ci -- ios
+
+      - name: Upload verification profiles and report
+        if: always()
+        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f
+        with:
+          name: pgo-emulator-${{ matrix.platform }}
+          path: .pgo/ci/${{ matrix.platform }}
+          include-hidden-files: true
+          if-no-files-found: warn
+          retention-days: 7

.gitignore

@@ -136,6 +136,9 @@ config/certificatePinning/roots/
 # Rspack build profiling output (RSPACK_PROFILE=OVERVIEW|ALL)
 .rspack-profile-*/
 
+# Local native PGO profiles
+.pgo/
+
 # Expo
 .expo
 dist/

android/app/build.gradle

@@ -84,6 +84,16 @@ project.ext.envConfigFiles = [
  * Set this to true to Run Proguard on Release builds to minify the Java bytecode.
  */
 def enableProguardInReleaseBuilds = true
+def pgoMode = providers.gradleProperty('pgoMode').getOrElse('off')
+def pgoProfile = providers.gradleProperty('pgoProfile').orNull
+
+if (!(pgoMode in ['off', 'generate', 'use'])) {
+    throw new GradleException("Unsupported pgoMode '${pgoMode}'. Use off, generate, or use.")
+}
+
+if (pgoMode == 'use' && !pgoProfile) {
+    throw new GradleException('pgoProfile is required when pgoMode=use.')
+}
 
 /**
  * The preferred build flavor of JavaScriptCore (JSC)
@@ -119,6 +129,7 @@ android {
         // Supported language variants must be declared here to avoid from being removed during the compilation.
         // This also helps us to not include unnecessary language variants in the APK.
         resConfigs "en", "es"
+        buildConfigField 'boolean', 'PGO_PROFILE_GENERATION', (pgoMode == 'generate').toString()
     }
 
     flavorDimensions "default"

android/app/src/main/AndroidManifest.xml

@@ -28,6 +28,14 @@
         android:theme="@style/AppTheme"
         tools:replace="android:supportsRtl">
 
+        <receiver
+            android:name=".PgoProfileReceiver"
+            android:exported="true">
+            <intent-filter>
+                <action android:name="com.expensify.chat.action.WRITE_PGO_PROFILES" />
+            </intent-filter>
+        </receiver>
+
         <service
             android:name="com.expensify.reactnativebackgroundtask.BackgroundJobService"
             android:permission="android.permission.BIND_JOB_SERVICE"

android/app/src/main/java/com/expensify/chat/PgoProfileReceiver.java

@@ -0,0 +1,27 @@
+package com.expensify.chat;
+
+import android.content.BroadcastReceiver;
+import android.content.Context;
+import android.content.Intent;
+import android.util.Log;
+
+/**
+ * Receives an explicit adb broadcast at the end of a local PGO collection run.
+ *
+ * The receiver is inert in ordinary builds. It deliberately lives outside the JS surface so a
+ * manual profiling journey can finish before its native counters are persisted.
+ */
+public final class PgoProfileReceiver extends BroadcastReceiver {
+    private static final String TAG = "PgoProfileReceiver";
+
+    @Override
+    public void onReceive(Context context, Intent intent) {
+        if (!BuildConfig.PGO_PROFILE_GENERATION) {
+            Log.w(TAG, "Ignoring PGO profile request in a non-instrumented build.");
+            return;
+        }
+
+        final int writtenProfiles = PgoProfileWriter.writeProfiles(context);
+        Log.i(TAG, "Wrote " + writtenProfiles + " LLVM PGO profile(s).");
+    }
+}

android/app/src/main/java/com/expensify/chat/PgoProfileWriter.java

@@ -0,0 +1,19 @@
+package com.expensify.chat;
+
+import android.content.Context;
+
+/** Development-only bridge for persisting LLVM PGO counters before Android kills the process. */
+public final class PgoProfileWriter {
+    private PgoProfileWriter() {}
+
+    private static native int writeProfiles(String directory);
+
+    public static int writeProfiles(Context context) {
+        if (!BuildConfig.PGO_PROFILE_GENERATION) {
+            return 0;
+        }
+
+        System.loadLibrary("ExpensifyNitroUtils");
+        return writeProfiles(context.getCacheDir().getAbsolutePath());
+    }
+}

ios/NewExpensify/RCTBootSplash.h

@@ -4,6 +4,7 @@
 
 + (void)initWithStoryboard:(NSString * _Nonnull)storyboardName
                   rootView:(UIView * _Nullable)rootView;
++ (void)initializePGOProfileCollection;
 + (void)hide:(BOOL)fade;
 + (void)bringSubviewToFrontIfInitialized;
 

ios/NewExpensify/RCTBootSplash.mm

@@ -13,13 +13,62 @@
 #import <React/RCTSurfaceHostingView.h>
 #import <React/RCTRootView.h>
 
+#ifndef EXPENSIFY_PGO_GENERATE
+#define EXPENSIFY_PGO_GENERATE 0
+#endif
+
+#if EXPENSIFY_PGO_GENERATE
+#include <dlfcn.h>
+
+extern "C" void __llvm_profile_set_filename(const char *FilenamePat);
+extern "C" int __llvm_profile_write_file(void);
+extern "C" void __llvm_profile_reset_counters(void);
+
+using PGOSetFilename = void (*)(const char *);
+using PGOWriteFile = int (*)();
+using PGOResetCounters = void (*)();
+
+template <typename Function>
+static Function HermesPGOFunction(const char *symbol) {
+  return reinterpret_cast<Function>(dlsym(RTLD_DEFAULT, symbol));
+}
+#endif
+
+static NSString *const PGO_DIRECTORY_NAME = @"ExpensifyPGO";
+static NSString *const PGO_STATUS_MARKER = @"profile-status.txt";
+static CFStringRef const PGO_WRITE_NOTIFICATION = CFSTR("com.expensify.pgo.write-profiles");
+static CFStringRef const PGO_CLEAR_NOTIFICATION = CFSTR("com.expensify.pgo.clear-profiles");
+
 static RCTSurfaceHostingProxyRootView *_rootView = nil;
 
 static UIView *_loadingView = nil;
 static NSMutableArray<RCTPromiseResolveBlock> *_resolveQueue = [[NSMutableArray alloc] init];
 static bool _fade = false;
 static bool _nativeHidden = false;
 
+static long long CurrentTimeMilliseconds(void) {
+  return (long long)([[NSDate date] timeIntervalSince1970] * 1000);
+}
+
+@interface RCTBootSplash ()
++ (NSURL *)pgoDirectoryURL;
++ (void)writePGOStatus:(NSString *)status result:(int)result;
++ (void)writePGOProfiles;
++ (void)clearPGOProfiles;
+@end
+
+static void HandlePGONotification(__unused CFNotificationCenterRef center,
+                                  __unused void *observer,
+                                  CFStringRef name,
+                                  __unused const void *object,
+                                  __unused CFDictionaryRef userInfo) {
+  if (CFEqual(name, PGO_WRITE_NOTIFICATION)) {
+    [RCTBootSplash writePGOProfiles];
+  } else if (CFEqual(name, PGO_CLEAR_NOTIFICATION)) {
+    [RCTBootSplash clearPGOProfiles];
+  }
+}
+
 @implementation RCTBootSplash
 
 RCT_EXPORT_MODULE();
@@ -32,6 +81,81 @@ + (BOOL)requiresMainQueueSetup {
   return NO;
 }
 
++ (NSURL *)pgoDirectoryURL {
+  NSURL *cachesURL = [[[NSFileManager defaultManager] URLsForDirectory:NSCachesDirectory
+                                                            inDomains:NSUserDomainMask] firstObject];
+  NSURL *directoryURL = [cachesURL URLByAppendingPathComponent:PGO_DIRECTORY_NAME isDirectory:YES];
+  [[NSFileManager defaultManager] createDirectoryAtURL:directoryURL
+                           withIntermediateDirectories:YES
+                                            attributes:nil
+                                                 error:nil];
+  return directoryURL;
+}
+
++ (void)writePGOStatus:(NSString *)status result:(int)result {
+  NSString *contents = [NSString stringWithFormat:@"%lld,%@,%d", CurrentTimeMilliseconds(), status, result];
+  NSURL *statusURL = [[self pgoDirectoryURL] URLByAppendingPathComponent:PGO_STATUS_MARKER];
+  [contents writeToURL:statusURL atomically:YES encoding:NSUTF8StringEncoding error:nil];
+}
+
++ (void)initializePGOProfileCollection {
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    CFNotificationCenterRef notificationCenter = CFNotificationCenterGetDarwinNotifyCenter();
+    CFNotificationCenterAddObserver(notificationCenter, NULL, HandlePGONotification, PGO_WRITE_NOTIFICATION, NULL, CFNotificationSuspensionBehaviorDeliverImmediately);
+    CFNotificationCenterAddObserver(notificationCenter, NULL, HandlePGONotification, PGO_CLEAR_NOTIFICATION, NULL, CFNotificationSuspensionBehaviorDeliverImmediately);
+
+#if EXPENSIFY_PGO_GENERATE
+    NSString *profilePattern = [[[self pgoDirectoryURL] URLByAppendingPathComponent:@"newdot-%m.profraw"] path];
+    __llvm_profile_set_filename(profilePattern.fileSystemRepresentation);
+    PGOSetFilename setHermesFilename = HermesPGOFunction<PGOSetFilename>("expensify_llvm_profile_set_filename");
+    if (setHermesFilename != nullptr) {
+      setHermesFilename(profilePattern.fileSystemRepresentation);
+    }
+#endif
+  });
+}
+
++ (void)writePGOProfiles {
+#if EXPENSIFY_PGO_GENERATE
+  int appResult = __llvm_profile_write_file();
+  PGOWriteFile writeHermesFile = HermesPGOFunction<PGOWriteFile>("expensify_llvm_profile_write_file");
+  int hermesResult = writeHermesFile != nullptr ? writeHermesFile() : 1;
+  int result = appResult == 0 && hermesResult == 0 ? 0 : 1;
+  [self writePGOStatus:@"written" result:result];
+  NSLog(@"ExpensifyPGO: wrote LLVM profile with result=%d appResult=%d hermesResult=%d", result, appResult, hermesResult);
+#else
+  [self writePGOStatus:@"not-instrumented" result:1];
+  NSLog(@"ExpensifyPGO: ignored profile write in a non-instrumented build");
+#endif
+}
+
++ (void)clearPGOProfiles {
+  NSFileManager *fileManager = [NSFileManager defaultManager];
+  NSURL *directoryURL = [self pgoDirectoryURL];
+  NSArray<NSURL *> *files = [fileManager contentsOfDirectoryAtURL:directoryURL
+                                      includingPropertiesForKeys:nil
+                                                         options:0
+                                                           error:nil];
+  for (NSURL *fileURL in files) {
+    if ([fileURL.lastPathComponent hasSuffix:@".profraw"] || [fileURL.lastPathComponent isEqualToString:PGO_STATUS_MARKER]) {
+      [fileManager removeItemAtURL:fileURL error:nil];
+    }
+  }
+
+#if EXPENSIFY_PGO_GENERATE
+  __llvm_profile_reset_counters();
+  PGOResetCounters resetHermesCounters = HermesPGOFunction<PGOResetCounters>("expensify_llvm_profile_reset_counters");
+  int result = resetHermesCounters != nullptr ? 0 : 1;
+  if (resetHermesCounters != nullptr) {
+    resetHermesCounters();
+  }
+  [self writePGOStatus:@"cleared" result:result];
+#else
+  [self writePGOStatus:@"not-instrumented" result:1];
+#endif
+}
+
 + (bool)isLoadingViewVisible {
   return _loadingView != nil && ![_loadingView isHidden];
 }

knip.json

@@ -91,5 +91,5 @@
         "diff-so-fancy",
         "@babel/plugin-proposal-class-properties"
     ],
-    "ignoreBinaries": ["metro-symbolicate", "mkcert", "openssl"]
+    "ignoreBinaries": ["metro-symbolicate", "mkcert", "openssl", "agent-device"]
 }