172961230a5890071bcca436eb5630172ce84ec41Andreas Huber/*
272961230a5890071bcca436eb5630172ce84ec41Andreas Huber * Copyright (C) 2010 The Android Open Source Project
372961230a5890071bcca436eb5630172ce84ec41Andreas Huber *
472961230a5890071bcca436eb5630172ce84ec41Andreas Huber * Licensed under the Apache License, Version 2.0 (the "License");
572961230a5890071bcca436eb5630172ce84ec41Andreas Huber * you may not use this file except in compliance with the License.
672961230a5890071bcca436eb5630172ce84ec41Andreas Huber * You may obtain a copy of the License at
772961230a5890071bcca436eb5630172ce84ec41Andreas Huber *
872961230a5890071bcca436eb5630172ce84ec41Andreas Huber *      http://www.apache.org/licenses/LICENSE-2.0
972961230a5890071bcca436eb5630172ce84ec41Andreas Huber *
1072961230a5890071bcca436eb5630172ce84ec41Andreas Huber * Unless required by applicable law or agreed to in writing, software
1172961230a5890071bcca436eb5630172ce84ec41Andreas Huber * distributed under the License is distributed on an "AS IS" BASIS,
1272961230a5890071bcca436eb5630172ce84ec41Andreas Huber * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1372961230a5890071bcca436eb5630172ce84ec41Andreas Huber * See the License for the specific language governing permissions and
1472961230a5890071bcca436eb5630172ce84ec41Andreas Huber * limitations under the License.
1572961230a5890071bcca436eb5630172ce84ec41Andreas Huber */
1672961230a5890071bcca436eb5630172ce84ec41Andreas Huber
1772961230a5890071bcca436eb5630172ce84ec41Andreas Huber//#define LOG_NDEBUG 0
1872961230a5890071bcca436eb5630172ce84ec41Andreas Huber#define LOG_TAG "ALooperRoster"
1972961230a5890071bcca436eb5630172ce84ec41Andreas Huber#include <utils/Log.h>
2072961230a5890071bcca436eb5630172ce84ec41Andreas Huber
2172961230a5890071bcca436eb5630172ce84ec41Andreas Huber#include "ALooperRoster.h"
2272961230a5890071bcca436eb5630172ce84ec41Andreas Huber
2372961230a5890071bcca436eb5630172ce84ec41Andreas Huber#include "ADebug.h"
2472961230a5890071bcca436eb5630172ce84ec41Andreas Huber#include "AHandler.h"
2572961230a5890071bcca436eb5630172ce84ec41Andreas Huber#include "AMessage.h"
2672961230a5890071bcca436eb5630172ce84ec41Andreas Huber
2772961230a5890071bcca436eb5630172ce84ec41Andreas Hubernamespace android {
2872961230a5890071bcca436eb5630172ce84ec41Andreas Huber
2972961230a5890071bcca436eb5630172ce84ec41Andreas HuberALooperRoster::ALooperRoster()
305df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    : mNextHandlerID(1),
315df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber      mNextReplyID(1) {
3272961230a5890071bcca436eb5630172ce84ec41Andreas Huber}
3372961230a5890071bcca436eb5630172ce84ec41Andreas Huber
3472961230a5890071bcca436eb5630172ce84ec41Andreas HuberALooper::handler_id ALooperRoster::registerHandler(
3572961230a5890071bcca436eb5630172ce84ec41Andreas Huber        const sp<ALooper> looper, const sp<AHandler> &handler) {
3672961230a5890071bcca436eb5630172ce84ec41Andreas Huber    Mutex::Autolock autoLock(mLock);
3772961230a5890071bcca436eb5630172ce84ec41Andreas Huber
3872961230a5890071bcca436eb5630172ce84ec41Andreas Huber    if (handler->id() != 0) {
3972961230a5890071bcca436eb5630172ce84ec41Andreas Huber        CHECK(!"A handler must only be registered once.");
4072961230a5890071bcca436eb5630172ce84ec41Andreas Huber        return INVALID_OPERATION;
4172961230a5890071bcca436eb5630172ce84ec41Andreas Huber    }
4272961230a5890071bcca436eb5630172ce84ec41Andreas Huber
4372961230a5890071bcca436eb5630172ce84ec41Andreas Huber    HandlerInfo info;
4472961230a5890071bcca436eb5630172ce84ec41Andreas Huber    info.mLooper = looper;
4572961230a5890071bcca436eb5630172ce84ec41Andreas Huber    info.mHandler = handler;
4672961230a5890071bcca436eb5630172ce84ec41Andreas Huber    ALooper::handler_id handlerID = mNextHandlerID++;
4772961230a5890071bcca436eb5630172ce84ec41Andreas Huber    mHandlers.add(handlerID, info);
4872961230a5890071bcca436eb5630172ce84ec41Andreas Huber
4972961230a5890071bcca436eb5630172ce84ec41Andreas Huber    handler->setID(handlerID);
5072961230a5890071bcca436eb5630172ce84ec41Andreas Huber
5172961230a5890071bcca436eb5630172ce84ec41Andreas Huber    return handlerID;
5272961230a5890071bcca436eb5630172ce84ec41Andreas Huber}
5372961230a5890071bcca436eb5630172ce84ec41Andreas Huber
5472961230a5890071bcca436eb5630172ce84ec41Andreas Hubervoid ALooperRoster::unregisterHandler(ALooper::handler_id handlerID) {
5572961230a5890071bcca436eb5630172ce84ec41Andreas Huber    Mutex::Autolock autoLock(mLock);
5672961230a5890071bcca436eb5630172ce84ec41Andreas Huber
5772961230a5890071bcca436eb5630172ce84ec41Andreas Huber    ssize_t index = mHandlers.indexOfKey(handlerID);
58f200777290d2e3e8b580c512cc0808eae9790705Andreas Huber
59f200777290d2e3e8b580c512cc0808eae9790705Andreas Huber    if (index < 0) {
60f200777290d2e3e8b580c512cc0808eae9790705Andreas Huber        return;
61f200777290d2e3e8b580c512cc0808eae9790705Andreas Huber    }
6272961230a5890071bcca436eb5630172ce84ec41Andreas Huber
6372961230a5890071bcca436eb5630172ce84ec41Andreas Huber    const HandlerInfo &info = mHandlers.valueAt(index);
6411cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber
6511cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber    sp<AHandler> handler = info.mHandler.promote();
6611cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber
6711cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber    if (handler != NULL) {
6811cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber        handler->setID(0);
6911cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber    }
7072961230a5890071bcca436eb5630172ce84ec41Andreas Huber
7172961230a5890071bcca436eb5630172ce84ec41Andreas Huber    mHandlers.removeItemsAt(index);
7272961230a5890071bcca436eb5630172ce84ec41Andreas Huber}
7372961230a5890071bcca436eb5630172ce84ec41Andreas Huber
7430873bfd08255e2c4e98ff5732ffff2838772617Andreas Hubervoid ALooperRoster::unregisterStaleHandlers() {
7530873bfd08255e2c4e98ff5732ffff2838772617Andreas Huber
7675c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen    Vector<sp<ALooper> > activeLoopers;
7775c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen    {
7875c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen        Mutex::Autolock autoLock(mLock);
7975c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen
8075c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen        for (size_t i = mHandlers.size(); i-- > 0;) {
8175c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen            const HandlerInfo &info = mHandlers.valueAt(i);
8275c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen
8375c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen            sp<ALooper> looper = info.mLooper.promote();
8475c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen            if (looper == NULL) {
8575c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen                ALOGV("Unregistering stale handler %d", mHandlers.keyAt(i));
8675c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen                mHandlers.removeItemsAt(i);
8775c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen            } else {
8875c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen                // At this point 'looper' might be the only sp<> keeping
8975c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen                // the object alive. To prevent it from going out of scope
9075c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen                // and having ~ALooper call this method again recursively
9175c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen                // and then deadlocking because of the Autolock above, add
9275c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen                // it to a Vector which will go out of scope after the lock
9375c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen                // has been released.
9475c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen                activeLoopers.add(looper);
9575c672fc376ef9b3ceff61a96513242b0e5ebd60Marco Nelissen            }
9630873bfd08255e2c4e98ff5732ffff2838772617Andreas Huber        }
9730873bfd08255e2c4e98ff5732ffff2838772617Andreas Huber    }
9830873bfd08255e2c4e98ff5732ffff2838772617Andreas Huber}
9930873bfd08255e2c4e98ff5732ffff2838772617Andreas Huber
1005df775d2f509c76e76a46615fca83dba95299f6eAndreas Huberstatus_t ALooperRoster::postMessage(
10172961230a5890071bcca436eb5630172ce84ec41Andreas Huber        const sp<AMessage> &msg, int64_t delayUs) {
10272961230a5890071bcca436eb5630172ce84ec41Andreas Huber
103047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen    sp<ALooper> looper = findLooper(msg->target());
10411cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber
10511cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber    if (looper == NULL) {
1065df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber        return -ENOENT;
10711cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber    }
10811cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber    looper->post(msg, delayUs);
1095df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    return OK;
11072961230a5890071bcca436eb5630172ce84ec41Andreas Huber}
11172961230a5890071bcca436eb5630172ce84ec41Andreas Huber
11272961230a5890071bcca436eb5630172ce84ec41Andreas Hubervoid ALooperRoster::deliverMessage(const sp<AMessage> &msg) {
11372961230a5890071bcca436eb5630172ce84ec41Andreas Huber    sp<AHandler> handler;
11472961230a5890071bcca436eb5630172ce84ec41Andreas Huber
11572961230a5890071bcca436eb5630172ce84ec41Andreas Huber    {
11672961230a5890071bcca436eb5630172ce84ec41Andreas Huber        Mutex::Autolock autoLock(mLock);
11772961230a5890071bcca436eb5630172ce84ec41Andreas Huber
11872961230a5890071bcca436eb5630172ce84ec41Andreas Huber        ssize_t index = mHandlers.indexOfKey(msg->target());
11972961230a5890071bcca436eb5630172ce84ec41Andreas Huber
12072961230a5890071bcca436eb5630172ce84ec41Andreas Huber        if (index < 0) {
1215ff1dd576bb93c45b44088a51544a18fc43ebf58Steve Block            ALOGW("failed to deliver message. Target handler not registered.");
12272961230a5890071bcca436eb5630172ce84ec41Andreas Huber            return;
12372961230a5890071bcca436eb5630172ce84ec41Andreas Huber        }
12472961230a5890071bcca436eb5630172ce84ec41Andreas Huber
12572961230a5890071bcca436eb5630172ce84ec41Andreas Huber        const HandlerInfo &info = mHandlers.valueAt(index);
12611cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber        handler = info.mHandler.promote();
12711cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber
12811cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber        if (handler == NULL) {
1295ff1dd576bb93c45b44088a51544a18fc43ebf58Steve Block            ALOGW("failed to deliver message. "
130f200777290d2e3e8b580c512cc0808eae9790705Andreas Huber                 "Target handler %d registered, but object gone.",
131f200777290d2e3e8b580c512cc0808eae9790705Andreas Huber                 msg->target());
13211cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber
13311cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber            mHandlers.removeItemsAt(index);
13411cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber            return;
13511cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber        }
13672961230a5890071bcca436eb5630172ce84ec41Andreas Huber    }
13772961230a5890071bcca436eb5630172ce84ec41Andreas Huber
13872961230a5890071bcca436eb5630172ce84ec41Andreas Huber    handler->onMessageReceived(msg);
13972961230a5890071bcca436eb5630172ce84ec41Andreas Huber}
14072961230a5890071bcca436eb5630172ce84ec41Andreas Huber
141e2b20987c2652a984d10520ef3542d50d91119c5Andreas Hubersp<ALooper> ALooperRoster::findLooper(ALooper::handler_id handlerID) {
142e2b20987c2652a984d10520ef3542d50d91119c5Andreas Huber    Mutex::Autolock autoLock(mLock);
143e2b20987c2652a984d10520ef3542d50d91119c5Andreas Huber
144e2b20987c2652a984d10520ef3542d50d91119c5Andreas Huber    ssize_t index = mHandlers.indexOfKey(handlerID);
145e2b20987c2652a984d10520ef3542d50d91119c5Andreas Huber
146e2b20987c2652a984d10520ef3542d50d91119c5Andreas Huber    if (index < 0) {
147e2b20987c2652a984d10520ef3542d50d91119c5Andreas Huber        return NULL;
148e2b20987c2652a984d10520ef3542d50d91119c5Andreas Huber    }
149e2b20987c2652a984d10520ef3542d50d91119c5Andreas Huber
15011cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber    sp<ALooper> looper = mHandlers.valueAt(index).mLooper.promote();
15111cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber
15211cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber    if (looper == NULL) {
15311cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber        mHandlers.removeItemsAt(index);
15411cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber        return NULL;
15511cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber    }
15611cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber
15711cc270ac5fd522c9e6491a7933516a96da4f62eAndreas Huber    return looper;
158e2b20987c2652a984d10520ef3542d50d91119c5Andreas Huber}
159e2b20987c2652a984d10520ef3542d50d91119c5Andreas Huber
1605df775d2f509c76e76a46615fca83dba95299f6eAndreas Huberstatus_t ALooperRoster::postAndAwaitResponse(
1615df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber        const sp<AMessage> &msg, sp<AMessage> *response) {
162047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen    sp<ALooper> looper = findLooper(msg->target());
163047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen
164047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen    if (looper == NULL) {
165047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen        ALOGW("failed to post message. "
166047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen                "Target handler %d still registered, but object gone.",
167047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen                msg->target());
168047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen        response->clear();
169047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen        return -ENOENT;
170047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen    }
171047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen
1725df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    Mutex::Autolock autoLock(mLock);
1735df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber
1745df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    uint32_t replyID = mNextReplyID++;
1755df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber
1765df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    msg->setInt32("replyID", replyID);
1775df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber
178047dd13ca42ff7cea10821ef64eb09229fa3e751Marco Nelissen    looper->post(msg, 0 /* delayUs */);
1795df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber
1805df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    ssize_t index;
1815df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    while ((index = mReplies.indexOfKey(replyID)) < 0) {
1825df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber        mRepliesCondition.wait(mLock);
1835df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    }
1845df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber
1855df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    *response = mReplies.valueAt(index);
1865df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    mReplies.removeItemsAt(index);
1875df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber
1885df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    return OK;
1895df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber}
1905df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber
1915df775d2f509c76e76a46615fca83dba95299f6eAndreas Hubervoid ALooperRoster::postReply(uint32_t replyID, const sp<AMessage> &reply) {
1925df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    Mutex::Autolock autoLock(mLock);
1935df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber
1945df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    CHECK(mReplies.indexOfKey(replyID) < 0);
1955df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    mReplies.add(replyID, reply);
1965df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber    mRepliesCondition.broadcast();
1975df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber}
1985df775d2f509c76e76a46615fca83dba95299f6eAndreas Huber
19972961230a5890071bcca436eb5630172ce84ec41Andreas Huber}  // namespace android
200