OpenHarmony-v6.0-Release/s

/*
 * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
 * 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.
 */

#include <ipc_skeleton.h>
#include <iservice_registry.h>
#include <regex>
#include <string_ex.h>
#include <unistd.h>
#include <vector>

#include "hdf_dump.h"
#include "hdf_core_log.h"
#include "hdf_object_manager.h"
#include "hdf_sbuf_ipc.h"
#include "hdf_remote_adapter.h"
#include "hdf_xcollie.h"

#define HDF_LOG_TAG hdf_remote_adapter

static constexpr int32_t THREAD_POOL_BASE_THREAD_COUNT = 5;
static int32_t g_remoteThreadMax = THREAD_POOL_BASE_THREAD_COUNT;

HdfRemoteServiceStub::HdfRemoteServiceStub(struct HdfRemoteService *service)
    : IPCObjectStub(std::u16string(u"")), service_(service)
{
}

// LCOV_EXCL_START
int HdfRemoteServiceStub::OnRemoteRequest(uint32_t code,
    OHOS::MessageParcel &data, OHOS::MessageParcel &reply, OHOS::MessageOption &option)
{
    HDF_LOGD("OnRemoteRequest enter");
    (void)option;

    int ret = HDF_FAILURE;
    struct HdfSBuf *dataSbuf = ParcelToSbuf(&data);
    struct HdfSBuf *replySbuf = ParcelToSbuf(&reply);

    std::shared_lock lock(mutex_);
    if (service_ == nullptr) {
        HDF_LOGE("service_ is nullptr");
        HdfSbufRecycle(dataSbuf);
        HdfSbufRecycle(replySbuf);
        return HDF_ERR_INVALID_OBJECT;
    }
    struct HdfRemoteDispatcher *dispatcher = service_->dispatcher;
    if (dispatcher != nullptr && dispatcher->Dispatch != nullptr) {
        ret = dispatcher->Dispatch(reinterpret_cast<HdfRemoteService *>(service_->target), code, dataSbuf, replySbuf);
    } else {
        HDF_LOGE("dispatcher or dispatcher->Dispatch is null, flags is: %{public}d", option.GetFlags());
    }

    HdfSbufRecycle(dataSbuf);
    HdfSbufRecycle(replySbuf);
    return ret;
}
// LCOV_EXCL_STOP

void HdfRemoteServiceStub::HdfRemoteStubClearHolder()
{
    std::unique_lock lock(mutex_);
    service_ = nullptr;
}

HdfRemoteServiceStub::~HdfRemoteServiceStub()
{
    HDF_LOGD("~HdfRemoteServiceStub");
}

HdfRemoteServiceHolder::~HdfRemoteServiceHolder()
{
    HDF_LOGD("~HdfRemoteServiceHolder");
}
// LCOV_EXCL_START
int32_t HdfRemoteServiceStub::Dump(int32_t fd, const std::vector<std::u16string> &args)
{
    return HdfDump(fd, args);
}

HdfDeathNotifier::HdfDeathNotifier(struct HdfRemoteService *service, struct HdfDeathRecipient *recipient)
    : recipient_(recipient), service_(service)
{
}

HdfDeathNotifier::~HdfDeathNotifier()
{
}

void HdfDeathNotifier::OnRemoteDied(const OHOS::wptr<OHOS::IRemoteObject> &object) /* who = 0 */
{
    if (recipient_ != nullptr) {
        recipient_->OnRemoteDied(recipient_, service_);
    }
}
// LCOV_EXCL_STop
static int HdfRemoteAdapterOptionalDispatch(struct HdfRemoteService *service, int code,
    HdfSBuf *data, HdfSBuf *reply, bool sync)
{
    if (service == nullptr) {
        return HDF_ERR_INVALID_PARAM;
    }

    OHOS::MessageParcel *dataParcel = nullptr;
    OHOS::MessageParcel *replyParcel = nullptr;

    if (reply == nullptr) {
        static OHOS::MessageParcel dummyReply;
        dummyReply.FlushBuffer();
        replyParcel = &dummyReply;
    } else if (SbufToParcel(reply, &replyParcel)) {
// LCOV_EXCL_START
        HDF_LOGE("%{public}s:invalid reply sbuf object to dispatch", __func__);
        return HDF_ERR_INVALID_PARAM;
    }
// LCOV_EXCL_STOP
    if (SbufToParcel(data, &dataParcel)) {
// LCOV_EXCL_START
        HDF_LOGE("%{public}s:invalid data sbuf object to dispatch", __func__);
        return HDF_ERR_INVALID_PARAM;
    }
// LCOV_EXCL_STOP
    int flag = sync ? OHOS::MessageOption::TF_SYNC : OHOS::MessageOption::TF_ASYNC;
    OHOS::MessageOption option(flag);
    struct HdfRemoteServiceHolder *holder = reinterpret_cast<struct HdfRemoteServiceHolder *>(service);
    if (dataParcel != nullptr) {
        OHOS::sptr<OHOS::IRemoteObject> remote = holder->remote_;
        if (remote != nullptr) {
            return remote->SendRequest(code, *dataParcel, *replyParcel, option);
        }
    }
    return HDF_FAILURE;
}

static int HdfRemoteAdapterDispatch(struct HdfRemoteService *service,
    int code, HdfSBuf *data, HdfSBuf *reply)
{
    return HdfRemoteAdapterOptionalDispatch(service, code, data, reply, true);
}
// LCOV_EXCL_START
static int HdfRemoteAdapterDispatchAsync(struct HdfRemoteService *service,
    int code, HdfSBuf *data, HdfSBuf *reply)
{
    return HdfRemoteAdapterOptionalDispatch(service, code, data, reply, false);
}
// LCOV_EXCL_STOP
HdfRemoteServiceHolder::HdfRemoteServiceHolder() : remote_(nullptr), deathRecipient_(nullptr)
{
    service_.object.objectId = HDF_OBJECT_ID_REMOTE_SERVICE;
    service_.dispatcher = nullptr;
    service_.target = nullptr;
    service_.index = 0;
}

bool HdfRemoteServiceHolder::SetInterfaceDescriptor(const char *desc)
{
    if (desc == nullptr) {
        return false;
    }
    std::u16string newDesc = OHOS::Str8ToStr16(std::string(desc));
// LCOV_EXCL_START
    if (newDesc.empty()) {
        HDF_LOGE("failed to set interface des, error on cover str8 to str16, %{public}s", desc);
        return false;
    }
// LCOV_EXCL_STOP
    descriptor_.assign(newDesc);
    return true;
}

void HdfRemoteAdapterAddDeathRecipient(
    struct HdfRemoteService *service, struct HdfDeathRecipient *recipient)
{
    struct HdfRemoteServiceHolder *holder = reinterpret_cast<struct HdfRemoteServiceHolder *>(service);
    if (holder == nullptr) {
        return;
    }
// LCOV_EXCL_START
    OHOS::sptr<OHOS::IRemoteObject> remote = holder->remote_;
    if (remote == nullptr) {
        return;
    }
    if (holder->deathRecipient_ != nullptr) {
        remote->RemoveDeathRecipient(holder->deathRecipient_);
    }
    holder->deathRecipient_ = new HdfDeathNotifier(service, recipient);
    remote->AddDeathRecipient(holder->deathRecipient_);
// LCOV_EXCL_STOP
}

// LCOV_EXCL_START
void HdfRemoteAdapterRemoveDeathRecipient(
    struct HdfRemoteService *service, const struct HdfDeathRecipient *recipient)
{
    struct HdfRemoteServiceHolder *holder = reinterpret_cast<struct HdfRemoteServiceHolder *>(service);
    (void)recipient;
    if (holder == nullptr) {
        return;
    }
    OHOS::sptr<OHOS::IRemoteObject> remote = holder->remote_;
    if (remote == nullptr) {
        return;
    }
    if (holder->deathRecipient_ != nullptr) {
        remote->RemoveDeathRecipient(holder->deathRecipient_);
        holder->deathRecipient_ = nullptr;
    }
}
// LCOV_EXCL_STOP

struct HdfRemoteService *HdfRemoteAdapterBind(OHOS::sptr<OHOS::IRemoteObject> binder)
{
    struct HdfRemoteService *remoteService = nullptr;
    static HdfRemoteDispatcher dispatcher = {
        .Dispatch = HdfRemoteAdapterDispatch,
        .DispatchAsync = HdfRemoteAdapterDispatchAsync,
    };

    struct HdfRemoteServiceHolder *holder = new HdfRemoteServiceHolder();
    if (holder != nullptr) {
        holder->remote_ = binder;
        remoteService = &holder->service_;
        remoteService->dispatcher = &dispatcher;
        remoteService->index = (uint64_t)binder.GetRefPtr();
        return remoteService;
    }
    return nullptr;
}

struct HdfRemoteService *HdfRemoteAdapterObtain(void)
{
    struct HdfRemoteServiceHolder *holder = new HdfRemoteServiceHolder();
    holder->remote_ = new HdfRemoteServiceStub(&holder->service_);
    return &holder->service_;
}

void HdfRemoteAdapterRecycle(struct HdfRemoteService *object)
{
    struct HdfRemoteServiceHolder *holder = reinterpret_cast<struct HdfRemoteServiceHolder *>(object);
    if (holder != nullptr) {
        auto remote = holder->remote_;
        if (remote != nullptr && !remote->IsProxyObject()) {
            HdfRemoteServiceStub *stub = reinterpret_cast<HdfRemoteServiceStub *>(remote.GetRefPtr());
            if (stub != nullptr) {
                stub->HdfRemoteStubClearHolder();
            }
        }
        holder->service_.target = nullptr;
        holder->service_.dispatcher = nullptr;
        holder->descriptor_.clear();
        holder->remote_ = nullptr;
        delete holder;
    }
}
// LCOV_EXCL_START
int HdfRemoteAdapterAddService(const char *name, struct HdfRemoteService *service)
{
    if (name == nullptr || service == nullptr) {
        return HDF_ERR_INVALID_PARAM;
    }

    OHOS::sptr<OHOS::IServiceRegistry> sr = OHOS::ServiceRegistry::GetInstance();
    if (sr == nullptr) {
        HDF_LOGE("failed to get service registry");
        return HDF_FAILURE;
    }
    struct HdfRemoteServiceHolder *holder = reinterpret_cast<struct HdfRemoteServiceHolder *>(service);
    int ret = sr->AddService(OHOS::Str8ToStr16(name), holder->remote_);
    if (ret == 0) {
        (void)OHOS::IPCSkeleton::GetInstance().SetMaxWorkThreadNum(g_remoteThreadMax++);
    }
    return ret;
}

struct HdfRemoteService *HdfRemoteAdapterGetService(const char *name)
{
    if (name == nullptr) {
        return nullptr;
    }

    OHOS::sptr<OHOS::IServiceRegistry> sr = OHOS::ServiceRegistry::GetInstance();
    if (sr == nullptr) {
        HDF_LOGE("failed to get service registry");
        return nullptr;
    }
    OHOS::sptr<OHOS::IRemoteObject> remote = sr->GetService(OHOS::Str8ToStr16(name));
    if (remote != nullptr) {
        return HdfRemoteAdapterBind(remote);
    }
    return nullptr;
}
// LCOV_EXCL_STOP
int HdfRemoteAdapterAddSa(int32_t saId, struct HdfRemoteService *service)
{
    if (service == nullptr) {
        return HDF_ERR_INVALID_PARAM;
    }

    const int32_t waitTimes = 50;
    const int32_t sleepInterval = 20000;
    OHOS::sptr<OHOS::ISystemAbilityManager> saManager;
    {
        OHOS::HdfXCollie hdfXCollie("HdfRemoteAdapterAddSa_" + OHOS::ToString(saId) + "_get_samgr",
            OHOS::DEFAULT_TIMEOUT_SECONDS, nullptr, nullptr, OHOS::HDF_XCOLLIE_FLAG_RECOVERY);

        for (uint32_t cnt = 0; cnt < waitTimes; ++cnt) {
            HDF_LOGI("waiting for samgr... %{public}d", cnt);
            saManager = OHOS::SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager();
            if (saManager != nullptr) {
                HDF_LOGI("GetSystemAbilityManager success");
                break;
            }
// LCOV_EXCL_START
            HDF_LOGI("GetSystemAbilityManager failed, retry");
            usleep(sleepInterval);
        }
// LCOV_EXCL_STOP
        if (saManager == nullptr) {
            HDF_LOGE("failed to get sa manager, waiting timeout");
            return HDF_FAILURE;
        }
    }
    {
        OHOS::HdfXCollie hdfXCollie("HdfRemoteAdapterAddSa_" + OHOS::ToString(saId) + "_add_sa",
            OHOS::DEFAULT_TIMEOUT_SECONDS, nullptr, nullptr, OHOS::HDF_XCOLLIE_FLAG_RECOVERY);
        struct HdfRemoteServiceHolder *holder = reinterpret_cast<struct HdfRemoteServiceHolder *>(service);
#ifdef WITH_SELINUX
        OHOS::sptr<OHOS::IRemoteObject> remote = holder->remote_;
        OHOS::IPCObjectStub *stub = reinterpret_cast<OHOS::IPCObjectStub *>(remote.GetRefPtr());
        stub->SetRequestSidFlag(true);
#endif
        int ret = HDF_FAILURE;
        for (uint32_t cnt = 0; cnt < waitTimes; ++cnt) {
            HDF_LOGI("waiting for addSa... %{public}d", cnt);
            ret = saManager->AddSystemAbility(saId, holder->remote_);
            if (ret == HDF_SUCCESS) {
                HDF_LOGI("addsa %{public}d, success", saId);
                break;
            }
            HDF_LOGI("AddSystemAbility failed, retry");
            usleep(sleepInterval);
        }
        if (ret != HDF_SUCCESS) {
            HDF_LOGE("failed to addSa, waiting timeout");
            return ret;
        }

        (void)OHOS::IPCSkeleton::GetInstance().SetMaxWorkThreadNum(g_remoteThreadMax++);
    }
    return HDF_SUCCESS;
}

struct HdfRemoteService *HdfRemoteAdapterGetSa(int32_t saId)
{
    auto saManager = OHOS::SystemAbilityManagerClient::GetInstance().GetSystemAbilityManager();
    if (saManager == nullptr) {
        HDF_LOGE("failed to get sa manager");
        return nullptr;
    }
    OHOS::sptr<OHOS::IRemoteObject> remote = saManager->GetSystemAbility(saId);
    constexpr int32_t waitTimes = 50;
    constexpr int32_t sleepInterval = 20000;
    int32_t timeout = waitTimes;
    while (remote == nullptr && (timeout > 0)) {
// LCOV_EXCL_START
        HDF_LOGD("waiting for saId %{public}d", saId);
        usleep(sleepInterval);
        remote = saManager->GetSystemAbility(saId);
        timeout--;
// LCOV_EXCL_STOP
    }
    if (remote != nullptr) {
        return HdfRemoteAdapterBind(remote);
    } else {
// LCOV_EXCL_START
        HDF_LOGE("failed to get sa %{public}d", saId);
    }
    return nullptr;
// LCOV_EXCL_STOP
}

bool HdfRemoteAdapterSetInterfaceDesc(struct HdfRemoteService *service, const char *desc)
{
    if (service == nullptr || desc == nullptr) {
        return false;
    }
    struct HdfRemoteServiceHolder *holder = reinterpret_cast<struct HdfRemoteServiceHolder *>(service);
    return holder->SetInterfaceDescriptor(desc);
}

bool HdfRemoteAdapterWriteInterfaceToken(struct HdfRemoteService *service, struct HdfSBuf *data)
{
    if (service == nullptr || data == nullptr) {
        return false;
    }
    struct HdfRemoteServiceHolder *holder = reinterpret_cast<struct HdfRemoteServiceHolder *>(service);
    OHOS::MessageParcel *parcel = nullptr;

    if (SbufToParcel(data, &parcel) != HDF_SUCCESS) {
        HDF_LOGE("failed to write interface token, SbufToParcel error");
        return false;
    }

    if (holder->remote_ == nullptr) {
        HDF_LOGE("failed to write interface token, holder->remote is nullptr");
        return false;
    }
    if (holder->descriptor_.empty()) {
        HDF_LOGE("failed to write interface token, empty token");
        return false;
    }
    return parcel->WriteInterfaceToken(holder->descriptor_);
}

static bool CheckInterfaceTokenIngoreVersion(const std::string &client, const std::string &stub)
{
    std::vector<std::string> clientVec;
    OHOS::SplitStr(client, ".", clientVec);
    std::vector<std::string> stubVec;
    OHOS::SplitStr(stub, ".", stubVec);
    if (clientVec.size() != stubVec.size()) {
        HDF_LOGE("%{public}s: client desc and stub desc have different size", __func__);
        return false;
    }
    std::regex rVer("[V|v][0-9]+_[0-9]+");
    for (size_t i = 0; i < stubVec.size(); i++) {
        if (std::regex_match(stubVec[i], rVer)) {
            continue;
        }
        if (clientVec[i] != stubVec[i]) {
            HDF_LOGE("%{public}s: mismatch between client desc and stub desc", __func__);
            return false;
        }
    }
    return true;
}

bool HdfRemoteAdapterCheckInterfaceToken(struct HdfRemoteService *service, struct HdfSBuf *data)
{
    if (service == nullptr || data == nullptr) {
        return false;
    }
    struct HdfRemoteServiceHolder *holder = reinterpret_cast<struct HdfRemoteServiceHolder *>(service);
    if (holder->remote_ == nullptr) {
        return false;
    }
    OHOS::MessageParcel *parcel = nullptr;

    if (SbufToParcel(data, &parcel) != HDF_SUCCESS) {
        return false;
    }
    auto desc = parcel->ReadInterfaceToken();
    if (desc.empty()) {
        HDF_LOGE("failed to check interface, empty token");
        return false;
    }
    std::string client = OHOS::Str16ToStr8(desc);
    std::string stub = OHOS::Str16ToStr8(holder->descriptor_);
    if (!CheckInterfaceTokenIngoreVersion(client, stub)) {
        HDF_LOGE("calling unknown interface: %{public}s", client.c_str());
        return false;
    }
    return true;
}

pid_t HdfRemoteGetCallingPid(void)
{
    return OHOS::IPCSkeleton::GetCallingPid();
}

pid_t HdfRemoteGetCallingUid(void)
{
    return OHOS::IPCSkeleton::GetCallingUid();
}

char *HdfRemoteGetCallingSid(void)
{
    return strdup(OHOS::IPCSkeleton::GetCallingSid().c_str());
}

int HdfRemoteAdapterDefaultDispatch(struct HdfRemoteService *service,
    int code, struct HdfSBuf *data, struct HdfSBuf *reply)
{
    struct HdfRemoteServiceHolder *holder = reinterpret_cast<struct HdfRemoteServiceHolder *>(service);
    if (holder == nullptr) {
        HDF_LOGE("%{public}s: failed to converts remote to holder", __func__);
        return HDF_ERR_INVALID_PARAM;
    }

    if (holder->remote_ == nullptr) {
        HDF_LOGE("%{public}s: invaild holder, holder->remote is nullptr", __func__);
        return HDF_ERR_INVALID_PARAM;
    }

    OHOS::IPCObjectStub *stub = reinterpret_cast<OHOS::IPCObjectStub *>(holder->remote_.GetRefPtr());
    if (stub == nullptr) {
// LCOV_EXCL_START
        HDF_LOGE("%{public}s: failed to converts holder->remote to IPCObjectStub object", __func__);
        return HDF_ERR_INVALID_PARAM;
// LCOV_EXCL_STOP
    }

    OHOS::MessageParcel *dataParcel = nullptr;
    OHOS::MessageParcel *replyParcel = nullptr;
    OHOS::MessageOption option;

    if (SbufToParcel(data, &dataParcel) != HDF_SUCCESS) {
// LCOV_EXCL_START
        HDF_LOGE("%{public}s:invalid data sbuf object to dispatch", __func__);
        return HDF_ERR_INVALID_PARAM;
// LCOV_EXCL_STOP
    }

    if (SbufToParcel(data, &replyParcel) != HDF_SUCCESS) {
// LCOV_EXCL_START
        HDF_LOGE("%{public}s:invalid reply sbuf object to dispatch", __func__);
        return HDF_ERR_INVALID_PARAM;
// LCOV_EXCL_STOP
    }

    return stub->IPCObjectStub::OnRemoteRequest(code, *dataParcel, *replyParcel, option);
}