Add UserHandle and BinderChannelCredentials to BinderChannelBuilder to support cross-user ondevice server.

Author: wwtbuaa01

binder/src/main/java/io/grpc/binder/BinderChannelBuilder.java

@@ -74,7 +74,8 @@ public static BinderChannelBuilder forAddress(
     return new BinderChannelBuilder(
         checkNotNull(directAddress, "directAddress"),
         null,
-        BinderChannelCredentials.forDefault(sourceContext));
+        sourceContext,
+        BinderChannelCredentials.forDefault());
   }
 
   /**
@@ -90,16 +91,17 @@ public static BinderChannelBuilder forAddress(
    * resulting builder. They will not be shut down automatically.
    *
    * @param directAddress the {@link AndroidComponentAddress} referencing the service to bind to.
+   * @param sourceContext the context to bind from (e.g. The current Activity or Application).
    * @param channelCredentials the arbitrary binder specific channel credentials to be used to
-   *     establish a binder connection including the context to bind from (e.g. The current
-   *     Activity or Application).
+   *     establish a binder connection.
    * @return a new builder
    */
   public static BinderChannelBuilder forAddress(
       AndroidComponentAddress directAddress,
+      Context sourceContext,
       BinderChannelCredentials channelCredentials) {
     return new BinderChannelBuilder(
-        checkNotNull(directAddress, "directAddress"), null, channelCredentials);
+        checkNotNull(directAddress, "directAddress"), null, sourceContext, channelCredentials);
   }
 
   /**
@@ -123,7 +125,8 @@ public static BinderChannelBuilder forTarget(String target, Context sourceContex
     return new BinderChannelBuilder(
         null,
         checkNotNull(target, "target"),
-        BinderChannelCredentials.forDefault(sourceContext));
+        sourceContext,
+        BinderChannelCredentials.forDefault());
   }
 
   /**
@@ -140,15 +143,15 @@ public static BinderChannelBuilder forTarget(String target, Context sourceContex
    *
    * @param target A target uri which should resolve into an {@link AndroidComponentAddress}
    *     referencing the service to bind to.
+   * @param sourceContext the context to bind from (e.g. The current Activity or Application).
    * @param channelCredentials the arbitrary binder specific channel credentials to be used to
-   *     establish a binder connection including the context to bind from (e.g. The current
-   *     Activity or Application).
+   *     establish a binder connection.
    * @return a new builder
    */
   public static BinderChannelBuilder forTarget(
-      String target, BinderChannelCredentials channelCredentials) {
+      String target, Context sourceContext, BinderChannelCredentials channelCredentials) {
     return new BinderChannelBuilder(
-        null, checkNotNull(target, "target"), channelCredentials);
+        null, checkNotNull(target, "target"), sourceContext, channelCredentials);
   }
 
   /**
@@ -183,10 +186,10 @@ public static BinderChannelBuilder forTarget(String target) {
   private BinderChannelBuilder(
       @Nullable AndroidComponentAddress directAddress,
       @Nullable String target,
+      Context sourceContext,
       BinderChannelCredentials channelCredentials) {
     mainThreadExecutor =
-        ContextCompat.getMainExecutor(
-            checkNotNull(channelCredentials.getSourceContext(), "sourceContext"));
+        ContextCompat.getMainExecutor(checkNotNull(sourceContext, "sourceContext"));
     securityPolicy = SecurityPolicies.internalOnly();
     inboundParcelablePolicy = InboundParcelablePolicy.DEFAULT;
     bindServiceFlags = BindServiceFlags.DEFAULTS;
@@ -196,13 +199,14 @@ final class BinderChannelTransportFactoryBuilder
       @Override
       public ClientTransportFactory buildClientTransportFactory() {
         return new TransportFactory(
-            channelCredentials,
+            sourceContext,
             mainThreadExecutor,
             schedulerPool,
             managedChannelImplBuilder.getOffloadExecutorPool(),
             securityPolicy,
             bindServiceFlags,
             inboundParcelablePolicy,
+            channelCredentials,
             targetUserHandle);
       }
     }
@@ -319,35 +323,38 @@ public BinderChannelBuilder idleTimeout(long value, TimeUnit unit) {
 
   /** Creates new binder transports. */
   private static final class TransportFactory implements ClientTransportFactory {
-    private final BinderChannelCredentials channelCredentials;
+    private final Context sourceContext;
     private final Executor mainThreadExecutor;
     private final ObjectPool<ScheduledExecutorService> scheduledExecutorPool;
     private final ObjectPool<? extends Executor> offloadExecutorPool;
     private final SecurityPolicy securityPolicy;
     private final InboundParcelablePolicy inboundParcelablePolicy;
     private final BindServiceFlags bindServiceFlags;
+    private final BinderChannelCredentials channelCredentials;
     @Nullable private final UserHandle targetUserHandle;
 
     private ScheduledExecutorService executorService;
     private Executor offloadExecutor;
     private boolean closed;
 
     TransportFactory(
-        BinderChannelCredentials channelCredentials,
+        Context sourceContext,
         Executor mainThreadExecutor,
         ObjectPool<ScheduledExecutorService> scheduledExecutorPool,
         ObjectPool<? extends Executor> offloadExecutorPool,
         SecurityPolicy securityPolicy,
         BindServiceFlags bindServiceFlags,
         InboundParcelablePolicy inboundParcelablePolicy,
+        BinderChannelCredentials channelCredentials,
         @Nullable UserHandle targetUserHandle) {
-      this.channelCredentials = channelCredentials;
+      this.sourceContext = sourceContext;
       this.mainThreadExecutor = mainThreadExecutor;
       this.scheduledExecutorPool = scheduledExecutorPool;
       this.offloadExecutorPool = offloadExecutorPool;
       this.securityPolicy = securityPolicy;
       this.bindServiceFlags = bindServiceFlags;
       this.inboundParcelablePolicy = inboundParcelablePolicy;
+      this.channelCredentials = channelCredentials;
       this.targetUserHandle = targetUserHandle;
 
       executorService = scheduledExecutorPool.getObject();
@@ -361,9 +368,10 @@ public ConnectionClientTransport newClientTransport(
         throw new IllegalStateException("The transport factory is closed.");
       }
       return new BinderTransport.BinderClientTransport(
-          channelCredentials,
+          sourceContext,
           (AndroidComponentAddress) addr,
           bindServiceFlags,
+          channelCredentials,
           targetUserHandle,
           mainThreadExecutor,
           scheduledExecutorPool,

binder/src/main/java/io/grpc/binder/BinderChannelCredentials.java

@@ -19,8 +19,6 @@
 import static com.google.common.base.Preconditions.checkNotNull;
 
 import android.content.ComponentName;
-import android.content.Context;
-import androidx.annotation.MainThread;
 import io.grpc.ChannelCredentials;
 import io.grpc.ExperimentalApi;
 import javax.annotation.Nullable;
@@ -32,35 +30,38 @@ public final class BinderChannelCredentials extends ChannelCredentials {
   /**
    * Creates the default BinderChannelCredentials.
    *
-   * @param sourceContext the context to bind from (e.g. The current Activity or Application).
    * @return a BinderChannelCredentials
    */
+<<<<<<< HEAD
   public static BinderChannelCredentials forDefault(Context sourceContext) {
     return new BinderChannelCredentials(checkNotNull(sourceContext, "sourceContext"), null);
+=======
+  public static BinderChannelCredentials forDefault() {
+    return new BinderChannelCredentials(null);
+>>>>>>> 2b7f83473 (Add UserHandle and BinderChannelCredentials to BinderChannelBuilder to support cross-user ondevice server.)
   }
 
   /**
    * Creates a BinderChannelCredentials to be used with DevicePolicyManager API.
    *
-   * @param sourceContext the context to bind from (e.g. The current Activity or Application).
    * @param devicePolicyAdminComponentName the admin component to be specified with
    *     DevicePolicyManager.bindDeviceAdminServiceAsUser API.
    * @return a BinderChannelCredentials
    */
   public static BinderChannelCredentials forDevicePolicyAdmin(
+<<<<<<< HEAD
       Context sourceContext, ComponentName devicePolicyAdminComponentName) {
     return new BinderChannelCredentials(
       checkNotNull(sourceContext, "sourceContext"), devicePolicyAdminComponentName);
+=======
+      ComponentName devicePolicyAdminComponentName) {
+    return new BinderChannelCredentials(devicePolicyAdminComponentName);
+>>>>>>> 2b7f83473 (Add UserHandle and BinderChannelCredentials to BinderChannelBuilder to support cross-user ondevice server.)
   }
 
-  // The sourceContext field is intentionally not guarded, since (aside from the constructor),
-  // it is only modified in the main thread.
-  @Nullable private Context sourceContext;  // Only null in the unbound state.
   @Nullable private final ComponentName devicePolicyAdminComponentName;
 
-  private BinderChannelCredentials(
-      Context sourceContext, @Nullable ComponentName devicePolicyAdminComponentName) {
-    this.sourceContext = sourceContext;
+  private BinderChannelCredentials(@Nullable ComponentName devicePolicyAdminComponentName) {
     this.devicePolicyAdminComponentName = devicePolicyAdminComponentName;
   }
 
@@ -69,18 +70,8 @@ public ChannelCredentials withoutBearerTokens() {
     return this;
   }
 
-  @Nullable
-  public Context getSourceContext() {
-    return sourceContext;
-  }
-
   @Nullable
   public ComponentName getDevicePolicyAdminComponentName() {
     return devicePolicyAdminComponentName;
   }
-
-  @MainThread
-  public void clearReferences() {
-    sourceContext = null;
-  }
 }

binder/src/main/java/io/grpc/binder/internal/BinderTransport.java

@@ -569,9 +569,10 @@ public static final class BinderClientTransport extends BinderTransport
     private int latestCallId = FIRST_CALL_ID;
 
     public BinderClientTransport(
-        BinderChannelCredentials channelCredentials,
+        Context sourceContext,
         AndroidComponentAddress targetAddress,
         BindServiceFlags bindServiceFlags,
+        BinderChannelCredentials channelCredentials,
         @Nullable UserHandle targetUserHandle,
         Executor mainThreadExecutor,
         ObjectPool<ScheduledExecutorService> executorServicePool,
@@ -581,9 +582,8 @@ public BinderClientTransport(
         Attributes eagAttrs) {
       super(
           executorServicePool,
-          buildClientAttributes(
-              eagAttrs, channelCredentials.getSourceContext(), targetAddress, inboundParcelablePolicy),
-          buildLogId(channelCredentials.getSourceContext(), targetAddress));
+          buildClientAttributes(eagAttrs, sourceContext, targetAddress, inboundParcelablePolicy),
+          buildLogId(sourceContext, targetAddress));
       this.offloadExecutorPool = offloadExecutorPool;
       this.securityPolicy = securityPolicy;
       this.offloadExecutor = offloadExecutorPool.getObject();
@@ -593,9 +593,10 @@ public BinderClientTransport(
       serviceBinding =
           new ServiceBinding(
               mainThreadExecutor,
-              channelCredentials,
+              sourceContext,
               targetAddress.asBindIntent(),
               bindServiceFlags.toInteger(),
+              channelCredentials,
               targetUserHandle,
               this);
     }

binder/src/main/java/io/grpc/binder/internal/ServiceBinding.java

@@ -80,6 +80,7 @@ public String methodName() {
 
   private final Intent bindIntent;
   private final int bindFlags;
+  private final BinderChannelCredentials channelCredentials;
   private final Observer observer;
   private final Executor mainThreadExecutor;
   @Nullable private final UserHandle targetUserHandle;
@@ -91,16 +92,17 @@ public String methodName() {
   // they're only modified in the main thread. The constructor contains a synchronized block
   // to ensure there's a write barrier when these fields are first written.
 
-  @Nullable private BinderChannelCredentials channelCredentials;  // Only null in the unbound state.
+  @Nullable private Context sourceContext; // Only null in the unbound state.
 
   private State reportedState; // Only used on the main thread.
 
   @AnyThread
   ServiceBinding(
       Executor mainThreadExecutor,
-      BinderChannelCredentials channelCredentials,
+      Context sourceContext,
       Intent bindIntent,
       int bindFlags,
+      BinderChannelCredentials channelCredentials,
       @Nullable UserHandle targetUserHandle,
       Observer observer) {
     // We need to synchronize here ensure other threads see all
@@ -109,8 +111,9 @@ public String methodName() {
       this.bindIntent = bindIntent;
       this.bindFlags = bindFlags;
       this.observer = observer;
-      this.channelCredentials = channelCredentials;
+      this.sourceContext = sourceContext;
       this.mainThreadExecutor = mainThreadExecutor;
+      this.channelCredentials = channelCredentials;
       this.targetUserHandle = targetUserHandle;
       state = State.NOT_BINDING;
       reportedState = State.NOT_BINDING;
@@ -143,22 +146,28 @@ public synchronized void bind() {
     if (state == State.NOT_BINDING) {
       state = State.BINDING;
       Status bindResult =
-          bindInternal(channelCredentials, bindIntent, this, bindFlags, targetUserHandle);
+          bindInternal(
+            sourceContext,
+            bindIntent,
+            this,
+            bindFlags,
+            channelCredentials,
+            targetUserHandle);
       if (!bindResult.isOk()) {
-        handleBindServiceFailure(channelCredentials.getSourceContext(), this);
+        handleBindServiceFailure(sourceContext, this);
         state = State.UNBOUND;
         mainThreadExecutor.execute(() -> notifyUnbound(bindResult));
       }
     }
   }
 
   private static Status bindInternal(
-      BinderChannelCredentials channelCredentials,
+      Context context,
       Intent bindIntent,
       ServiceConnection conn,
       int flags,
+      BinderChannelCredentials channelCredentials,
       @Nullable UserHandle targetUserHandle) {
-    Context context = channelCredentials.getSourceContext();
     BindMethodType bindMethodType = BindMethodType.BIND_SERVICE;
     try {
       if (targetUserHandle == null) {
@@ -231,7 +240,7 @@ void unbindInternal(Status reason) {
     Context unbindFrom = null;
     synchronized (this) {
       if (state == State.BINDING || state == State.BOUND) {
-        unbindFrom = channelCredentials.getSourceContext();
+        unbindFrom = sourceContext;
       }
       state = State.UNBOUND;
     }
@@ -243,7 +252,7 @@ void unbindInternal(Status reason) {
 
   @MainThread
   private void clearReferences() {
-    channelCredentials = null;
+    sourceContext = null;
   }
 
   @Override
@@ -283,6 +292,6 @@ public void onBindingDied(ComponentName name) {
 
   @VisibleForTesting
   synchronized boolean isSourceContextCleared() {
-    return channelCredentials == null;
+    return sourceContext == null;
   }
 }

binder/src/test/java/io/grpc/binder/BinderChannelCredentialsTest.java

@@ -15,7 +15,7 @@ public class BinderChannelCredentialsTest {
 
   @Test
   public void defaultBinderChannelCredentials() {
-    BinderChannelCredentials channelCredentials = BinderChannelCredentials.forDefault(appContext);
+    BinderChannelCredentials channelCredentials = BinderChannelCredentials.forDefault();
     assertThat(channelCredentials.getDevicePolicyAdminComponentName()).isNull();
   }
 
@@ -24,7 +24,7 @@ public void binderChannelCredentialsForDevicePolicyAdmin() {
     String deviceAdminClassName = "DevicePolicyAdmin";
     BinderChannelCredentials channelCredentials =
         BinderChannelCredentials.forDevicePolicyAdmin(
-            appContext, new ComponentName(appContext, deviceAdminClassName));
+            new ComponentName(appContext, deviceAdminClassName));
     assertThat(channelCredentials.getDevicePolicyAdminComponentName()).isNotNull();
     assertThat(channelCredentials.getDevicePolicyAdminComponentName().getClassName())
         .isEqualTo(deviceAdminClassName);