xref: /base/startup/appspawn/common/appspawn_server.h

/*
 * 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.
 */

#ifndef APPSPAWN_SERVER_H
#define APPSPAWN_SERVER_H
#include <stdint.h>
#include <stdio.h>
#include <unistd.h>

#include "appspawn_utils.h"
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    MODE_FOR_APP_SPAWN,
    MODE_FOR_NWEB_SPAWN,
    MODE_FOR_APP_COLD_RUN,
    MODE_FOR_NWEB_COLD_RUN,
    MODE_FOR_NATIVE_SPAWN,
    MODE_FOR_CJAPP_SPAWN,
    MODE_INVALID
} RunMode;

typedef enum {
    PROCESS_FOR_APP_SPAWN,
    PROCESS_FOR_NWEB_SPAWN,
    PROCESS_FOR_APP_COLD_RUN,
    PROCESS_FOR_NWEB_COLD_RUN,
    PROCESS_FOR_NATIVE_SPAWN,
    PROCESS_FOR_NWEB_RESTART,
    PROCESS_INVALID
} RunProcess;

typedef enum {
    CJPROCESS_FOR_APP_SPAWN,
    CJPROCESS_FOR_APP_COLD_RUN,
    CJPROCESS_INVALID
} CJRunProcess;

typedef struct AppSpawnClient {
    uint32_t id;
    uint32_t flags;  // Save negotiated flags
} AppSpawnClient;

typedef struct AppSpawnContent {
    char *longProcName;
    uint32_t longProcNameLen;
    uint32_t sandboxNsFlags;
    int wdgOpened;
#ifdef USE_ENCAPS
    int fdEncaps;
#endif
    RunMode mode;
#ifndef OHOS_LITE
    int32_t preforkFd[2];
    int32_t parentToChildFd[2];
    char *propertyBuffer;
    pid_t reservedPid;
    int enablePerfork;
#endif
    // system
    void (*runAppSpawn)(struct AppSpawnContent *content, int argc, char *const argv[]);
    void (*notifyResToParent)(struct AppSpawnContent *content, AppSpawnClient *client, int result);
    int (*runChildProcessor)(struct AppSpawnContent *content, AppSpawnClient *client);
    // for cold start
    int (*coldStartApp)(struct AppSpawnContent *content, AppSpawnClient *client);
} AppSpawnContent;

typedef struct TagAppSpawnForkArg {
    struct AppSpawnContent *content;
    AppSpawnClient *client;
} AppSpawnForkArg;

AppSpawnContent *AppSpawnCreateContent(const char *socketName, char *longProcName, uint32_t longProcNameLen, int cold);
int AppSpawnExecuteClearEnvHook(AppSpawnContent *content, AppSpawnClient *client);
int AppSpawnExecuteSpawningHook(AppSpawnContent *content, AppSpawnClient *client);
int AppSpawnExecutePreReplyHook(AppSpawnContent *content, AppSpawnClient *client);
int AppSpawnExecutePostReplyHook(AppSpawnContent *content, AppSpawnClient *client);
void AppSpawnEnvClear(AppSpawnContent *content, AppSpawnClient *client);
int AppSpawnProcessMsg(AppSpawnContent *content, AppSpawnClient *client, pid_t *childPid);
void ProcessExit(int code);
int AppSpawnChild(AppSpawnContent *content, AppSpawnClient *client);
#ifdef __cplusplus
}
#endif
#endif  // APPSPAWN_SERVER_H