startup_appspawn/standard/appspawn_appmgr.c

/*
 * Copyright (c) 2024 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 <fcntl.h>
#include <limits.h>
#include <sched.h>
#include <stdlib.h>
#include <unistd.h>

#include <sys/ipc.h>
#include <sys/mman.h>
#include <sys/mount.h>
#include <sys/signalfd.h>
#include <sys/socket.h>
#include <sys/stat.h>
#include <sys/wait.h>

#include "appspawn_adapter.h"
#include "appspawn_hook.h"
#include "appspawn_msg.h"
#include "appspawn_manager.h"
#include "securec.h"

#define SLEEP_DURATION 3000 // us
#define EXIT_APP_TIMEOUT 1000000 // us

static AppSpawnMgr *g_appSpawnMgr = NULL;

AppSpawnMgr *CreateAppSpawnMgr(int mode)
{
    APPSPAWN_CHECK_ONLY_EXPER(mode < MODE_INVALID, return NULL);
    if (g_appSpawnMgr != NULL) {
        return g_appSpawnMgr;
    }
    AppSpawnMgr *appMgr = (AppSpawnMgr *)calloc(1, sizeof(AppSpawnMgr));
    APPSPAWN_CHECK(appMgr != NULL, return NULL, "Failed to alloc memory for appspawn");
    appMgr->content.longProcName = NULL;
    appMgr->content.longProcNameLen = 0;
    appMgr->content.mode = mode;
    appMgr->content.sandboxNsFlags = 0;
    appMgr->content.wdgOpened = 0;
    appMgr->content.isLinux = false;
    appMgr->servicePid = getpid();
    appMgr->server = NULL;
    appMgr->sigHandler = NULL;
    OH_ListInit(&appMgr->appQueue);
    OH_ListInit(&appMgr->diedQueue);
    OH_ListInit(&appMgr->appSpawnQueue);
    appMgr->diedAppCount = 0;
    OH_ListInit(&appMgr->extData);
    g_appSpawnMgr = appMgr;
    g_appSpawnMgr->spawnTime.minAppspawnTime = APPSPAWN_MAX_TIME;
    g_appSpawnMgr->spawnTime.maxAppspawnTime = 0;
    return appMgr;
}

AppSpawnMgr *GetAppSpawnMgr(void)
{
    return g_appSpawnMgr;
}

AppSpawnContent *GetAppSpawnContent(void)
{
    return g_appSpawnMgr == NULL ? NULL : &g_appSpawnMgr->content;
}

static void SpawningQueueDestroy(ListNode *node)
{
    AppSpawningCtx *property = ListEntry(node, AppSpawningCtx, node);
    DeleteAppSpawningCtx(property);
}

static void ExtDataDestroy(ListNode *node)
{
    AppSpawnExtData *extData = ListEntry(node, AppSpawnExtData, node);
    AppSpawnExtDataFree freeNode = extData->freeNode;
    if (freeNode) {
        freeNode(extData);
    }
}

void DeleteAppSpawnMgr(AppSpawnMgr *mgr)
{
    APPSPAWN_CHECK_ONLY_EXPER(mgr != NULL, return);
    OH_ListRemoveAll(&mgr->appQueue, NULL);
    OH_ListRemoveAll(&mgr->diedQueue, NULL);
    OH_ListRemoveAll(&mgr->appSpawnQueue, SpawningQueueDestroy);
    OH_ListRemoveAll(&mgr->extData, ExtDataDestroy);

    APPSPAWN_LOGV("DeleteAppSpawnMgr %{public}d %{public}d", mgr->servicePid, getpid());
    free(mgr);
    if (g_appSpawnMgr == mgr) {
        g_appSpawnMgr = NULL;
    }
}

void TraversalSpawnedProcess(AppTraversal traversal, void *data)
{
    APPSPAWN_CHECK_ONLY_EXPER(g_appSpawnMgr != NULL && traversal != NULL, return);
    ListNode *node = g_appSpawnMgr->appQueue.next;
    while (node != &g_appSpawnMgr->appQueue) {
        ListNode *next = node->next;
        AppSpawnedProcess *appInfo = ListEntry(node, AppSpawnedProcess, node);
        traversal(g_appSpawnMgr, appInfo, data);
        node = next;
    }
}

static int AppInfoPidComparePro(ListNode *node, void *data)
{
    AppSpawnedProcess *node1 = ListEntry(node, AppSpawnedProcess, node);
    pid_t pid = *(pid_t *)data;
    return node1->pid - pid;
}

static int AppInfoNameComparePro(ListNode *node, void *data)
{
    AppSpawnedProcess *node1 = ListEntry(node, AppSpawnedProcess, node);
    return strcmp(node1->name, (char *)data);
}

static int AppInfoCompareProc(ListNode *node, ListNode *newNode)
{
    AppSpawnedProcess *node1 = ListEntry(node, AppSpawnedProcess, node);
    AppSpawnedProcess *node2 = ListEntry(newNode, AppSpawnedProcess, node);
    return node1->pid - node2->pid;
}

AppSpawnedProcess *AddSpawnedProcess(pid_t pid, const char *processName, bool isDebuggable)
{
    APPSPAWN_CHECK(g_appSpawnMgr != NULL && processName != NULL, return NULL, "Invalid mgr or process name");
    APPSPAWN_CHECK(pid > 0, return NULL, "Invalid pid for %{public}s", processName);
    size_t len = strlen(processName) + 1;
    APPSPAWN_CHECK(len > 1, return NULL, "Invalid processName for %{public}s", processName);
    AppSpawnedProcess *node = (AppSpawnedProcess *)calloc(1, sizeof(AppSpawnedProcess) + len + 1);
    APPSPAWN_CHECK(node != NULL, return NULL, "Failed to malloc for appinfo");

    node->pid = pid;
    node->max = 0;
    node->uid = 0;
    node->exitStatus = 0;
    node->isDebuggable = isDebuggable;
    int ret = strcpy_s(node->name, len, processName);
    APPSPAWN_CHECK(ret == 0, free(node);
        return NULL, "Failed to strcpy process name");

    OH_ListInit(&node->node);
    APPSPAWN_LOGI("Add %{public}s, pid=%{public}d success", processName, pid);
    OH_ListAddWithOrder(&g_appSpawnMgr->appQueue, &node->node, AppInfoCompareProc);
    return node;
}

void TerminateSpawnedProcess(AppSpawnedProcess *node)
{
    APPSPAWN_CHECK_ONLY_EXPER(g_appSpawnMgr != NULL && node != NULL, return);
    // delete node
    OH_ListRemove(&node->node);
    OH_ListInit(&node->node);
    if (!IsNWebSpawnMode(g_appSpawnMgr)) {
        free(node);
        return;
    }
    if (g_appSpawnMgr->diedAppCount >= MAX_DIED_PROCESS_COUNT) {
        AppSpawnedProcess *oldApp = ListEntry(g_appSpawnMgr->diedQueue.next, AppSpawnedProcess, node);
        OH_ListRemove(&oldApp->node);
        OH_ListInit(&oldApp->node);
        free(oldApp);
        g_appSpawnMgr->diedAppCount--;
    }
    APPSPAWN_LOGI("ProcessAppDied %{public}s, pid=%{public}d", node->name, node->pid);
    OH_ListAddTail(&g_appSpawnMgr->diedQueue, &node->node);
    g_appSpawnMgr->diedAppCount++;
}

AppSpawnedProcess *GetSpawnedProcess(pid_t pid)
{
    APPSPAWN_CHECK_ONLY_EXPER(g_appSpawnMgr != NULL, return NULL);
    ListNode *node = OH_ListFind(&g_appSpawnMgr->appQueue, &pid, AppInfoPidComparePro);
    APPSPAWN_CHECK_ONLY_EXPER(node != NULL, return NULL);
    return ListEntry(node, AppSpawnedProcess, node);
}

AppSpawnedProcess *GetSpawnedProcessByName(const char *name)
{
    APPSPAWN_CHECK_ONLY_EXPER(g_appSpawnMgr != NULL, return NULL);
    APPSPAWN_CHECK_ONLY_EXPER(name != NULL, return NULL);

    ListNode *node = OH_ListFind(&g_appSpawnMgr->appQueue, (void *)name, AppInfoNameComparePro);
    APPSPAWN_CHECK_ONLY_EXPER(node != NULL, return NULL);
    return ListEntry(node, AppSpawnedProcess, node);
}

static void DumpProcessSpawnStack(pid_t pid)
{
#if (!defined(CJAPP_SPAWN) && !defined(NATIVE_SPAWN))
    DumpSpawnStack(pid);
    DumpSpawnStack(getpid());
#endif
#ifndef APPSPAWN_TEST
    kill(pid, SIGKILL);
#endif
    APPSPAWN_LOGI("Dump stack finished");
}

int KillAndWaitStatus(pid_t pid, int sig, int *exitStatus)
{
    APPSPAWN_CHECK_ONLY_EXPER(exitStatus != NULL, return 0);
    *exitStatus = -1;
    if (pid <= 0) {
        return 0;
    }

    if (kill(pid, sig) != 0) {
        APPSPAWN_LOGE("unable to kill process, pid: %{public}d ret %{public}d", pid, errno);
        return -1;
    }

    int retry = 0;
    pid_t exitPid = 0;

    while (retry * SLEEP_DURATION < EXIT_APP_TIMEOUT) {
        exitPid = waitpid(pid, exitStatus, WNOHANG);
        if (exitPid == pid) {
            return 0;
        }
        usleep(SLEEP_DURATION);
        retry++;
    }

    DumpProcessSpawnStack(pid);
    APPSPAWN_LOGE("waitpid failed, pid: %{public}d %{public}d, status: %{public}d", exitPid, pid, *exitStatus);

    return -1;
}

static int GetProcessTerminationStatus(pid_t pid)
{
    APPSPAWN_CHECK_ONLY_EXPER(g_appSpawnMgr != NULL, return -1);
    APPSPAWN_LOGV("GetProcessTerminationStatus pid: %{public}d ", pid);
    if (pid <= 0) {
        return 0;
    }
    int exitStatus = 0;
    ListNode *node = OH_ListFind(&g_appSpawnMgr->diedQueue, &pid, AppInfoPidComparePro);
    if (node != NULL) {
        AppSpawnedProcess *info = ListEntry(node, AppSpawnedProcess, node);
        exitStatus = info->exitStatus;
        OH_ListRemove(node);
        OH_ListInit(node);
        free(info);
        if (g_appSpawnMgr->diedAppCount > 0) {
            g_appSpawnMgr->diedAppCount--;
        }
        return exitStatus;
    }
    AppSpawnedProcess *app = GetSpawnedProcess(pid);
    if (app == NULL) {
        APPSPAWN_LOGE("unable to get process, pid: %{public}d ", pid);
        return -1;
    }

    if (KillAndWaitStatus(pid, SIGKILL, &exitStatus) == 0) { // kill success, delete app
        OH_ListRemove(&app->node);
        OH_ListInit(&app->node);
        free(app);
    }
    return exitStatus;
}

AppSpawningCtx *CreateAppSpawningCtx(void)
{
    static uint32_t requestId = 0;
    AppSpawningCtx *property = (AppSpawningCtx *)malloc(sizeof(AppSpawningCtx));
    APPSPAWN_CHECK(property != NULL, return NULL, "Failed to create AppSpawningCtx ");
    property->client.id = ++requestId;
    property->client.flags = 0;
    property->forkCtx.watcherHandle = NULL;
    property->forkCtx.pidFdWatcherHandle = NULL;
    property->forkCtx.coldRunPath = NULL;
    property->forkCtx.timer = NULL;
    property->forkCtx.fd[0] = -1;
    property->forkCtx.fd[1] = -1;
    property->isPrefork = false;
    property->forkCtx.childMsg = NULL;
    property->message = NULL;
    property->pid = 0;
    property->state = APP_STATE_IDLE;
    OH_ListInit(&property->node);
    if (g_appSpawnMgr) {
        OH_ListAddTail(&g_appSpawnMgr->appSpawnQueue, &property->node);
    }
    return property;
}

void DeleteAppSpawningCtx(AppSpawningCtx *property)
{
    APPSPAWN_CHECK_ONLY_EXPER(property != NULL, return);
    APPSPAWN_LOGV("DeleteAppSpawningCtx");

    DeleteAppSpawnMsg(property->message);

    OH_ListRemove(&property->node);
    if (property->forkCtx.timer) {
        LE_StopTimer(LE_GetDefaultLoop(), property->forkCtx.timer);
        property->forkCtx.timer = NULL;
    }
    if (property->forkCtx.watcherHandle) {
        LE_RemoveWatcher(LE_GetDefaultLoop(), property->forkCtx.watcherHandle);
        property->forkCtx.watcherHandle = NULL;
    }
    if (property->forkCtx.coldRunPath) {
        free(property->forkCtx.coldRunPath);
        property->forkCtx.coldRunPath = NULL;
    }
    if (property->forkCtx.fd[0] >= 0) {
        close(property->forkCtx.fd[0]);
    }
    if (property->forkCtx.fd[1] >= 0) {
        close(property->forkCtx.fd[1]);
    }

    free(property);
}

static int AppPropertyComparePid(ListNode *node, void *data)
{
    AppSpawningCtx *property = ListEntry(node, AppSpawningCtx, node);
    if (property->pid == *(pid_t *)data) {
        return 0;
    }
    return 1;
}

AppSpawningCtx *GetAppSpawningCtxByPid(pid_t pid)
{
    APPSPAWN_CHECK_ONLY_EXPER(g_appSpawnMgr != NULL, return NULL);
    ListNode *node = OH_ListFind(&g_appSpawnMgr->appSpawnQueue, (void *)&pid, AppPropertyComparePid);
    APPSPAWN_CHECK_ONLY_EXPER(node != NULL, return NULL);
    return ListEntry(node, AppSpawningCtx, node);
}

void AppSpawningCtxTraversal(ProcessTraversal traversal, void *data)
{
    APPSPAWN_CHECK_ONLY_EXPER(g_appSpawnMgr != NULL && traversal != NULL, return);
    ListNode *node = g_appSpawnMgr->appSpawnQueue.next;
    while (node != &g_appSpawnMgr->appSpawnQueue) {
        ListNode *next = node->next;
        AppSpawningCtx *ctx = ListEntry(node, AppSpawningCtx, node);
        traversal(g_appSpawnMgr, ctx, data);
        node = next;
    }
}

static int DumpAppSpawnQueue(ListNode *node, void *data)
{
    AppSpawningCtx *property = ListEntry(node, AppSpawningCtx, node);
    APPSPAPWN_DUMP("app property id: %{public}u flags: %{public}x",
        property->client.id, property->client.flags);
    APPSPAPWN_DUMP("app property state: %{public}d", property->state);

    DumpAppSpawnMsg(property->message);
    return 0;
}

static int DumpAppQueue(ListNode *node, void *data)
{
    AppSpawnedProcess *appInfo = ListEntry(node, AppSpawnedProcess, node);
    uint64_t diff = DiffTime(&appInfo->spawnStart, &appInfo->spawnEnd);
    APPSPAPWN_DUMP("App info uid: %{public}u pid: %{public}x", appInfo->uid, appInfo->pid);
    APPSPAPWN_DUMP("App info name: %{public}s exitStatus: 0x%{public}x spawn time: %{public}" PRIu64 " us ",
        appInfo->name, appInfo->exitStatus, diff);
    return 0;
}

static int DumpExtData(ListNode *node, void *data)
{
    AppSpawnExtData *extData = ListEntry(node, AppSpawnExtData, node);
    if (extData->dumpNode) {
        extData->dumpNode(extData);
    }
    return 0;
}

void ProcessAppSpawnDumpMsg(const AppSpawnMsgNode *message)
{
    APPSPAWN_CHECK_ONLY_EXPER(g_appSpawnMgr != NULL && message != NULL, return);
    FILE *stream = NULL;
    uint32_t len = 0;
    char *ptyName = GetAppSpawnMsgExtInfo(message, "pty-name", &len);
    if (ptyName != NULL) {
        APPSPAWN_LOGI("Dump info to file '%{public}s'", ptyName);
        char canonicalPtyPath[PATH_MAX] = { 0 };
        if (realpath(ptyName, canonicalPtyPath) == NULL) {
            return;
        }

        stream = fopen(canonicalPtyPath, "w");
        SetDumpToStream(stream);
    } else {
        SetDumpToStream(stdout);
    }
    APPSPAPWN_DUMP("Dump appspawn info start ... ");
    APPSPAPWN_DUMP("APP spawning queue: ");
    OH_ListTraversal((ListNode *)&g_appSpawnMgr->appSpawnQueue, NULL, DumpAppSpawnQueue, 0);
    APPSPAPWN_DUMP("APP queue: ");
    OH_ListTraversal((ListNode *)&g_appSpawnMgr->appQueue, "App queue", DumpAppQueue, 0);
    APPSPAPWN_DUMP("APP died queue: ");
    OH_ListTraversal((ListNode *)&g_appSpawnMgr->diedQueue, "App died queue", DumpAppQueue, 0);
    APPSPAPWN_DUMP("Ext data: ");
    OH_ListTraversal((ListNode *)&g_appSpawnMgr->extData, "Ext data", DumpExtData, 0);
    APPSPAPWN_DUMP("Dump appspawn info finish ");
    if (stream != NULL) {
        (void)fflush(stream);
        fclose(stream);
#ifdef APPSPAWN_TEST
        SetDumpToStream(stdout);
#else
        SetDumpToStream(NULL);
#endif
    }
}

int ProcessTerminationStatusMsg(const AppSpawnMsgNode *message, AppSpawnResult *result)
{
    APPSPAWN_CHECK_ONLY_EXPER(g_appSpawnMgr != NULL && message != NULL, return -1);
    APPSPAWN_CHECK_ONLY_EXPER(result != NULL, return -1);
    if (!IsNWebSpawnMode(g_appSpawnMgr)) {
        return APPSPAWN_MSG_INVALID;
    }
    result->result = -1;
    result->pid = 0;
    pid_t *pid = (pid_t *)GetAppSpawnMsgInfo(message, TLV_RENDER_TERMINATION_INFO);
    if (pid == NULL) {
        return -1;
    }
    // get render process termination status, only nwebspawn need this logic.
    result->pid = *pid;
    result->result = GetProcessTerminationStatus(*pid);
    return 0;
}