| /* |
| * Copyright 2020 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.tv.tunerresourcemanager; |
| |
| import android.annotation.NonNull; |
| import android.annotation.Nullable; |
| import android.content.Context; |
| import android.media.tv.TvInputManager; |
| import android.media.tv.tunerresourcemanager.CasSessionRequest; |
| import android.media.tv.tunerresourcemanager.IResourcesReclaimListener; |
| import android.media.tv.tunerresourcemanager.ITunerResourceManager; |
| import android.media.tv.tunerresourcemanager.ResourceClientProfile; |
| import android.media.tv.tunerresourcemanager.TunerFrontendInfo; |
| import android.media.tv.tunerresourcemanager.TunerFrontendRequest; |
| import android.media.tv.tunerresourcemanager.TunerLnbRequest; |
| import android.media.tv.tunerresourcemanager.TunerResourceManager; |
| import android.os.Binder; |
| import android.os.RemoteException; |
| import android.util.Log; |
| import android.util.Slog; |
| import android.util.SparseArray; |
| |
| import com.android.internal.annotations.VisibleForTesting; |
| import com.android.server.SystemService; |
| |
| import java.util.ArrayList; |
| import java.util.List; |
| |
| /** |
| * This class provides a system service that manages the TV tuner resources. |
| * |
| * @hide |
| */ |
| public class TunerResourceManagerService extends SystemService { |
| private static final String TAG = "TunerResourceManagerService"; |
| private static final boolean DEBUG = Log.isLoggable(TAG, Log.DEBUG); |
| |
| public static final int INVALID_CLIENT_ID = -1; |
| private static final int MAX_CLIENT_PRIORITY = 1000; |
| |
| // Array of the registered client profiles |
| @VisibleForTesting private SparseArray<ClientProfile> mClientProfiles = new SparseArray<>(); |
| private int mNextUnusedClientId = 0; |
| private List<Integer> mRegisteredClientIds = new ArrayList<Integer>(); |
| |
| // Array of the current available frontend resources |
| @VisibleForTesting |
| private SparseArray<FrontendResource> mFrontendResources = new SparseArray<>(); |
| // Array of the current available frontend ids |
| private List<Integer> mAvailableFrontendIds = new ArrayList<Integer>(); |
| |
| private SparseArray<IResourcesReclaimListener> mListeners = new SparseArray<>(); |
| |
| private TvInputManager mManager; |
| private UseCasePriorityHints mPriorityCongfig = new UseCasePriorityHints(); |
| |
| // Used to synchronize the access to the service. |
| private final Object mLock = new Object(); |
| |
| public TunerResourceManagerService(@Nullable Context context) { |
| super(context); |
| } |
| |
| @Override |
| public void onStart() { |
| onStart(false /*isForTesting*/); |
| } |
| |
| @VisibleForTesting |
| protected void onStart(boolean isForTesting) { |
| if (!isForTesting) { |
| publishBinderService(Context.TV_TUNER_RESOURCE_MGR_SERVICE, new BinderService()); |
| } |
| mManager = (TvInputManager) getContext().getSystemService(Context.TV_INPUT_SERVICE); |
| mPriorityCongfig.parse(); |
| } |
| |
| private final class BinderService extends ITunerResourceManager.Stub { |
| @Override |
| public void registerClientProfile(@NonNull ResourceClientProfile profile, |
| @NonNull IResourcesReclaimListener listener, @NonNull int[] clientId) |
| throws RemoteException { |
| enforceAccessPermission(); |
| if (profile == null) { |
| throw new RemoteException("ResourceClientProfile can't be null"); |
| } |
| |
| if (clientId == null) { |
| throw new RemoteException("clientId can't be null!"); |
| } |
| |
| if (!mPriorityCongfig.isDefinedUseCase(profile.getUseCase())) { |
| throw new RemoteException("Use undefined client use case:" + profile.getUseCase()); |
| } |
| |
| synchronized (mLock) { |
| registerClientProfileInternal(profile, listener, clientId); |
| } |
| } |
| |
| @Override |
| public void unregisterClientProfile(int clientId) throws RemoteException { |
| enforceAccessPermission(); |
| synchronized (mLock) { |
| if (!checkClientExists(clientId)) { |
| Slog.e(TAG, "Unregistering non exists client:" + clientId); |
| return; |
| } |
| unregisterClientProfileInternal(clientId); |
| } |
| } |
| |
| @Override |
| public boolean updateClientPriority(int clientId, int priority, int niceValue) { |
| enforceAccessPermission(); |
| synchronized (mLock) { |
| return updateClientPriorityInternal(clientId, priority, niceValue); |
| } |
| } |
| |
| @Override |
| public void setFrontendInfoList(@NonNull TunerFrontendInfo[] infos) throws RemoteException { |
| enforceAccessPermission(); |
| if (infos == null) { |
| throw new RemoteException("TunerFrontendInfo can't be null"); |
| } |
| synchronized (mLock) { |
| setFrontendInfoListInternal(infos); |
| } |
| } |
| |
| @Override |
| public void updateCasInfo(int casSystemId, int maxSessionNum) { |
| if (DEBUG) { |
| Slog.d(TAG, |
| "updateCasInfo(casSystemId=" + casSystemId |
| + ", maxSessionNum=" + maxSessionNum + ")"); |
| } |
| } |
| |
| @Override |
| public void setLnbInfoList(int[] lnbIds) { |
| if (DEBUG) { |
| for (int i = 0; i < lnbIds.length; i++) { |
| Slog.d(TAG, "updateLnbInfo(lnbId=" + lnbIds[i] + ")"); |
| } |
| } |
| } |
| |
| @Override |
| public boolean requestFrontend(@NonNull TunerFrontendRequest request, |
| @NonNull int[] frontendId) throws RemoteException { |
| enforceAccessPermission(); |
| if (frontendId == null) { |
| throw new RemoteException("frontendId can't be null"); |
| } |
| synchronized (mLock) { |
| try { |
| return requestFrontendInternal(request, frontendId); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| @Override |
| public void shareFrontend(int selfClientId, int targetClientId) { |
| if (DEBUG) { |
| Slog.d(TAG, "shareFrontend from " + selfClientId + " with " + targetClientId); |
| } |
| } |
| |
| @Override |
| public boolean requestCasSession( |
| @NonNull CasSessionRequest request, @NonNull int[] sessionResourceId) { |
| if (DEBUG) { |
| Slog.d(TAG, "requestCasSession(request=" + request + ")"); |
| } |
| |
| return true; |
| } |
| |
| @Override |
| public boolean requestLnb(@NonNull TunerLnbRequest request, @NonNull int[] lnbId) { |
| if (DEBUG) { |
| Slog.d(TAG, "requestLnb(request=" + request + ")"); |
| } |
| return true; |
| } |
| |
| @Override |
| public void releaseFrontend(int frontendId) { |
| if (DEBUG) { |
| Slog.d(TAG, "releaseFrontend(id=" + frontendId + ")"); |
| } |
| } |
| |
| @Override |
| public void releaseCasSession(int sessionResourceId) { |
| if (DEBUG) { |
| Slog.d(TAG, "releaseCasSession(sessionResourceId=" + sessionResourceId + ")"); |
| } |
| } |
| |
| @Override |
| public void releaseLnb(int lnbId) { |
| if (DEBUG) { |
| Slog.d(TAG, "releaseLnb(lnbId=" + lnbId + ")"); |
| } |
| } |
| |
| @Override |
| public boolean isHigherPriority( |
| ResourceClientProfile challengerProfile, ResourceClientProfile holderProfile) { |
| if (DEBUG) { |
| Slog.d(TAG, |
| "isHigherPriority(challengerProfile=" + challengerProfile |
| + ", holderProfile=" + challengerProfile + ")"); |
| } |
| return true; |
| } |
| } |
| |
| @VisibleForTesting |
| protected void registerClientProfileInternal(ResourceClientProfile profile, |
| IResourcesReclaimListener listener, int[] clientId) { |
| if (DEBUG) { |
| Slog.d(TAG, "registerClientProfile(clientProfile=" + profile + ")"); |
| } |
| |
| clientId[0] = INVALID_CLIENT_ID; |
| if (mManager == null) { |
| Slog.e(TAG, "TvInputManager is null. Can't register client profile."); |
| return; |
| } |
| // TODO tell if the client already exists |
| clientId[0] = mNextUnusedClientId++; |
| |
| int pid = profile.getTvInputSessionId() == null |
| ? Binder.getCallingPid() /*callingPid*/ |
| : mManager.getClientPid(profile.getTvInputSessionId()); /*tvAppId*/ |
| |
| ClientProfile clientProfile = new ClientProfile.Builder(clientId[0]) |
| .tvInputSessionId(profile.getTvInputSessionId()) |
| .useCase(profile.getUseCase()) |
| .processId(pid) |
| .build(); |
| clientProfile.setPriority(getClientPriority(profile.getUseCase(), pid)); |
| |
| mClientProfiles.append(clientId[0], clientProfile); |
| mListeners.append(clientId[0], listener); |
| mRegisteredClientIds.add(clientId[0]); |
| } |
| |
| @VisibleForTesting |
| protected void unregisterClientProfileInternal(int clientId) { |
| if (DEBUG) { |
| Slog.d(TAG, "unregisterClientProfile(clientId=" + clientId + ")"); |
| } |
| for (int id : getClientProfile(clientId).getInUseFrontendIds()) { |
| getFrontendResource(id).removeOwner(); |
| for (int groupMemberId : getFrontendResource(id).getExclusiveGroupMemberFeIds()) { |
| getFrontendResource(groupMemberId).removeOwner(); |
| } |
| } |
| mClientProfiles.remove(clientId); |
| mListeners.remove(clientId); |
| mRegisteredClientIds.remove(clientId); |
| } |
| |
| @VisibleForTesting |
| protected boolean updateClientPriorityInternal(int clientId, int priority, int niceValue) { |
| if (DEBUG) { |
| Slog.d(TAG, |
| "updateClientPriority(clientId=" + clientId + ", priority=" + priority |
| + ", niceValue=" + niceValue + ")"); |
| } |
| |
| ClientProfile profile = getClientProfile(clientId); |
| if (profile == null) { |
| Slog.e(TAG, |
| "Can not find client profile with id " + clientId |
| + " when trying to update the client priority."); |
| return false; |
| } |
| |
| profile.setPriority(priority); |
| profile.setNiceValue(niceValue); |
| |
| return true; |
| } |
| |
| @VisibleForTesting |
| protected void setFrontendInfoListInternal(TunerFrontendInfo[] infos) { |
| if (DEBUG) { |
| Slog.d(TAG, "updateFrontendInfo:"); |
| for (int i = 0; i < infos.length; i++) { |
| Slog.d(TAG, infos[i].toString()); |
| } |
| } |
| |
| // An arrayList to record the frontends pending on updating. Ids will be removed |
| // from this list once its updating finished. Any frontend left in this list when all |
| // the updates are done will be removed from mAvailableFrontendIds and |
| // mFrontendResources. |
| List<Integer> updatingFrontendIds = new ArrayList<>(mAvailableFrontendIds); |
| |
| // Update frontendResources sparse array and other mappings accordingly |
| for (int i = 0; i < infos.length; i++) { |
| if (getFrontendResource(infos[i].getId()) != null) { |
| if (DEBUG) { |
| Slog.d(TAG, "Frontend id=" + infos[i].getId() + "exists."); |
| } |
| updatingFrontendIds.remove(new Integer(infos[i].getId())); |
| } else { |
| // Add a new fe resource |
| FrontendResource newFe = new FrontendResource.Builder(infos[i].getId()) |
| .type(infos[i].getFrontendType()) |
| .exclusiveGroupId(infos[i].getExclusiveGroupId()) |
| .build(); |
| // Update the exclusive group member list in all the existing Frontend resource |
| for (Integer feId : mAvailableFrontendIds) { |
| FrontendResource fe = getFrontendResource(feId.intValue()); |
| if (fe.getExclusiveGroupId() == newFe.getExclusiveGroupId()) { |
| newFe.addExclusiveGroupMemberFeId(fe.getId()); |
| newFe.addExclusiveGroupMemberFeId(fe.getExclusiveGroupMemberFeIds()); |
| for (Integer excGroupmemberFeId : fe.getExclusiveGroupMemberFeIds()) { |
| getFrontendResource(excGroupmemberFeId.intValue()) |
| .addExclusiveGroupMemberFeId(newFe.getId()); |
| } |
| fe.addExclusiveGroupMemberFeId(newFe.getId()); |
| break; |
| } |
| } |
| // Update resource list and available id list |
| mFrontendResources.append(newFe.getId(), newFe); |
| mAvailableFrontendIds.add(newFe.getId()); |
| } |
| } |
| |
| // TODO check if the removing resource is in use or not. Handle the conflict. |
| for (Integer removingId : updatingFrontendIds) { |
| // update the exclusive group id memver list |
| FrontendResource fe = getFrontendResource(removingId.intValue()); |
| fe.removeExclusiveGroupMemberFeId(new Integer(fe.getId())); |
| for (Integer excGroupmemberFeId : fe.getExclusiveGroupMemberFeIds()) { |
| getFrontendResource(excGroupmemberFeId.intValue()) |
| .removeExclusiveGroupMemberFeId(new Integer(fe.getId())); |
| } |
| mFrontendResources.remove(removingId.intValue()); |
| mAvailableFrontendIds.remove(removingId); |
| } |
| } |
| |
| @VisibleForTesting |
| protected boolean requestFrontendInternal(TunerFrontendRequest request, int[] frontendId) |
| throws RemoteException { |
| if (DEBUG) { |
| Slog.d(TAG, "requestFrontend(request=" + request + ")"); |
| } |
| |
| frontendId[0] = TunerResourceManager.INVALID_FRONTEND_ID; |
| if (!checkClientExists(request.getClientId())) { |
| Slog.e(TAG, "Request frontend from unregistered client:" + request.getClientId()); |
| return false; |
| } |
| ClientProfile requestClient = getClientProfile(request.getClientId()); |
| int grantingFrontendId = -1; |
| int inUseLowestPriorityFrId = -1; |
| // Priority max value is 1000 |
| int currentLowestPriority = MAX_CLIENT_PRIORITY + 1; |
| for (int id : mAvailableFrontendIds) { |
| FrontendResource fr = getFrontendResource(id); |
| if (fr.getType() == request.getFrontendType()) { |
| if (!fr.isInUse()) { |
| // Grant unused frontend with no exclusive group members first. |
| if (fr.getExclusiveGroupMemberFeIds().size() == 0) { |
| grantingFrontendId = id; |
| break; |
| } else if (grantingFrontendId < 0) { |
| // Grant the unused frontend with lower id first if all the unused |
| // frontends have exclusive group members. |
| grantingFrontendId = id; |
| } |
| } else if (grantingFrontendId < 0) { |
| // Record the frontend id with the lowest client priority among all the |
| // in use frontends when no available frontend has been found. |
| int priority = getOwnerClientPriority(id); |
| if (currentLowestPriority > priority) { |
| inUseLowestPriorityFrId = id; |
| currentLowestPriority = priority; |
| } |
| } |
| } |
| } |
| |
| // Grant frontend when there is unused resource. |
| if (grantingFrontendId > -1) { |
| frontendId[0] = grantingFrontendId; |
| updateFrontendClientMappingOnNewGrant(frontendId[0], request.getClientId()); |
| return true; |
| } |
| |
| // When all the resources are occupied, grant the lowest priority resource if the |
| // request client has higher priority. |
| if (inUseLowestPriorityFrId > -1 && (requestClient.getPriority() > currentLowestPriority)) { |
| frontendId[0] = inUseLowestPriorityFrId; |
| reclaimFrontendResource(getFrontendResource(frontendId[0]).getOwnerClientId()); |
| updateFrontendClientMappingOnNewGrant(frontendId[0], request.getClientId()); |
| return true; |
| } |
| |
| return false; |
| } |
| |
| @VisibleForTesting |
| protected int getClientPriority(int useCase, int pid) { |
| if (DEBUG) { |
| Slog.d(TAG, "getClientPriority useCase=" + useCase |
| + ", pid=" + pid + ")"); |
| } |
| |
| if (isForeground(pid)) { |
| return mPriorityCongfig.getForegroundPriority(useCase); |
| } |
| return mPriorityCongfig.getBackgroundPriority(useCase); |
| } |
| |
| @VisibleForTesting |
| protected boolean isForeground(int pid) { |
| // TODO: how to get fg/bg information from pid |
| return true; |
| } |
| |
| @VisibleForTesting |
| protected void reclaimFrontendResource(int reclaimingId) throws RemoteException { |
| if (mListeners.get(reclaimingId) != null) { |
| try { |
| mListeners.get(reclaimingId).onReclaimResources(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| private void updateFrontendClientMappingOnNewGrant(int grantingId, int ownerClientId) { |
| FrontendResource grantingFrontend = getFrontendResource(grantingId); |
| ClientProfile ownerProfile = getClientProfile(ownerClientId); |
| grantingFrontend.setOwner(ownerClientId); |
| ownerProfile.useFrontend(grantingId); |
| for (int exclusiveGroupMember : grantingFrontend.getExclusiveGroupMemberFeIds()) { |
| getFrontendResource(exclusiveGroupMember).setOwner(ownerClientId); |
| ownerProfile.useFrontend(exclusiveGroupMember); |
| } |
| } |
| |
| /** |
| * Get the owner client's priority from the frontend id. |
| * |
| * @param frontendId an in use frontend id. |
| * @return the priority of the owner client of the frontend. |
| */ |
| private int getOwnerClientPriority(int frontendId) { |
| return getClientProfile(getFrontendResource(frontendId).getOwnerClientId()).getPriority(); |
| } |
| |
| private ClientProfile getClientProfile(int clientId) { |
| return mClientProfiles.get(clientId); |
| } |
| |
| protected FrontendResource getFrontendResource(int frontendId) { |
| return mFrontendResources.get(frontendId); |
| } |
| |
| @VisibleForTesting |
| protected SparseArray<ClientProfile> getClientProfiles() { |
| return mClientProfiles; |
| } |
| |
| @VisibleForTesting |
| protected SparseArray<FrontendResource> getFrontendResources() { |
| return mFrontendResources; |
| } |
| |
| private boolean checkClientExists(int clientId) { |
| return mRegisteredClientIds.contains(clientId); |
| } |
| |
| private void enforceAccessPermission() { |
| getContext().enforceCallingOrSelfPermission( |
| "android.permission.TUNER_RESOURCE_ACCESS", TAG); |
| } |
| } |