mirror of
https://github.com/openharmony/ability_ability_runtime.git
synced 2026-08-24 22:21:36 -04:00
renjh5496
306 lines
9.6 KiB
C++
306 lines
9.6 KiB
C++
/*
|
|
* Copyright (c) 2021-2025 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 OHOS_ABILITY_RUNTIME_APP_SPAWN_CLIENT_H
|
|
#define OHOS_ABILITY_RUNTIME_APP_SPAWN_CLIENT_H
|
|
|
|
#include <array>
|
|
#include <map>
|
|
#include <memory>
|
|
#include <set>
|
|
#include <string>
|
|
#include <unistd.h>
|
|
#include <vector>
|
|
|
|
#include "appspawn.h"
|
|
#include "bundle_info.h"
|
|
#ifdef SUPPORT_CHILD_PROCESS
|
|
#include "child_process_info.h"
|
|
#endif // SUPPORT_CHILD_PROCESS
|
|
#include "data_group_info.h"
|
|
#include "nocopyable.h"
|
|
#include "shared/base_shared_bundle_info.h"
|
|
|
|
namespace OHOS {
|
|
namespace AppExecFwk {
|
|
enum class SpawnConnectionState { STATE_NOT_CONNECT, STATE_CONNECTED, STATE_CONNECT_FAILED };
|
|
using HspList = std::vector<BaseSharedBundleInfo>;
|
|
using DataGroupInfoList = std::vector<DataGroupInfo>;
|
|
using JITPermissionsMap = std::map<std::string, std::string>;
|
|
const int32_t MAX_FLAG_INDEX = 32;
|
|
const int32_t MAX_PROC_NAME_LEN = 256;
|
|
const int64_t START_FLAG_BASE = 1;
|
|
const int32_t MAX_COST_TIME = 500;
|
|
struct AppSpawnStartMsg {
|
|
uint64_t accessTokenIdEx;
|
|
uint64_t flags = 0;
|
|
uint32_t accessTokenId;
|
|
uint32_t hapFlags = 0; // whether is pre installed hap
|
|
std::vector<int32_t> gids;
|
|
std::string procName;
|
|
std::string soPath;
|
|
std::string apl;
|
|
std::string bundleName;
|
|
std::string renderParam; // only nweb spawn need this param.
|
|
std::string overlayInfo; // overlay hap resource path list
|
|
std::string ownerId;
|
|
std::string provisionType;
|
|
std::string appDistributionType;
|
|
std::string atomicAccount = "";
|
|
std::string extensionSandboxPath;
|
|
std::string processType = "";
|
|
std::string extensionTypeName;
|
|
std::string appSignType;
|
|
std::string imageName;
|
|
HspList hspList; // list of harmony shared package
|
|
std::set<std::string> permissions;
|
|
std::map<std::string, std::string> appEnv; // environment variable to be set to the process
|
|
std::map<std::string, int32_t> fds;
|
|
DataGroupInfoList dataGroupInfoList; // list of harmony shared package
|
|
JITPermissionsMap jitPermissionsMap; // map of JIT permissions
|
|
uint32_t mountPermissionFlags;
|
|
uint32_t apiTargetVersion = 0;
|
|
int32_t uid;
|
|
int32_t gid;
|
|
int32_t pid;
|
|
int32_t code = 0; // 0: default, MSG_APP_SPAWN; 1: MSG_SPAWN_NATIVE_PROCESS; 2: MSG_GET_RENDER_TERMINATION_STATUS
|
|
int32_t bundleIndex; // when dlp launch another app used, default is 0
|
|
int32_t maxChildProcess = 0;
|
|
#ifdef SUPPORT_CHILD_PROCESS
|
|
int32_t childProcessType = CHILD_PROCESS_TYPE_NOT_CHILD;
|
|
#endif // SUPPORT_CHILD_PROCESS
|
|
int32_t hostProcessUid = 0; // host process uid, only use for nwebspawn.
|
|
int32_t templatePid = -1;
|
|
int32_t imagePid = -1;
|
|
uint64_t checkpointId = 0;
|
|
uint8_t setAllowInternet;
|
|
uint8_t allowInternet; // hap socket allowed
|
|
uint8_t reserved1;
|
|
uint8_t reserved2;
|
|
bool atomicServiceFlag = false;
|
|
bool isolatedExtension = false; // whether is isolatedExtension
|
|
bool strictMode = false; // whether is strict mode
|
|
bool isolationMode = false;
|
|
bool isolatedNetworkFlag = false;
|
|
bool isolatedSELinuxFlag = false;
|
|
bool isolatedSandboxFlagLegacy = false; // APP_FLAGS_EXTENSION_SANDBOX legacy
|
|
bool isScreenLockDataProtect = false;
|
|
bool isCustomSandboxFlag = false;
|
|
};
|
|
|
|
constexpr auto LEN_PID = sizeof(pid_t);
|
|
struct StartFlags {
|
|
static const int COLD_START = 0;
|
|
static const int BACKUP_EXTENSION = 1;
|
|
static const int DLP_MANAGER = 2;
|
|
static const int DEBUGGABLE = 3;
|
|
static const int ASANENABLED = 4;
|
|
static const int ACCESS_BUNDLE_DIR = 5;
|
|
static const int NATIVEDEBUG = 6;
|
|
static const int NO_SANDBOX = 7;
|
|
static const int OVERLAY = 8;
|
|
static const int BUNDLE_RESOURCES = 9;
|
|
static const int GWP_ENABLED_FORCE = 10;
|
|
static const int GWP_ENABLED_NORMAL = 11;
|
|
static const int TSANENABLED = 12;
|
|
static const int EXTENSION_CONTROLLED = 13;
|
|
static const int HWASANENABLED = 21;
|
|
static const int UBSANENABLED = 22;
|
|
static const int TEMP_JIT_ALLOW = 28;
|
|
static const int DLP_MANAGER_FULL_CONTROL = 37;
|
|
static const int DLP_MANAGER_READ_ONLY = 38;
|
|
static const int CLOUD_FILE_SYNC_ENABLED = 39;
|
|
static const int APP_FLAGS_DEBUGSERVER = 44;
|
|
};
|
|
|
|
struct CreateStartMsgParam {
|
|
std::shared_ptr<AAFwk::Want> want = nullptr;
|
|
BundleInfo bundleInfo;
|
|
std::string moduleName;
|
|
std::string abilityName;
|
|
std::string processName;
|
|
uint64_t startFlags = 0;
|
|
int32_t uid = -1;
|
|
int32_t bundleIndex = 0;
|
|
ExtensionAbilityType extensionAbilityType = ExtensionAbilityType::UNSPECIFIED;
|
|
BundleType bundleType = BundleType::APP;
|
|
bool strictMode = false;
|
|
bool networkEnableFlags = true;
|
|
bool saEnableFlags = true;
|
|
};
|
|
|
|
union AppSpawnPidMsg {
|
|
pid_t pid = 0;
|
|
char pidBuf[LEN_PID];
|
|
};
|
|
|
|
class AppSpawnClient {
|
|
public:
|
|
/**
|
|
* Constructor.
|
|
*/
|
|
explicit AppSpawnClient(bool isNWebSpawn = false);
|
|
|
|
/**
|
|
* Constructor by service name
|
|
*/
|
|
explicit AppSpawnClient(const char* serviceName);
|
|
|
|
/**
|
|
* Destructor
|
|
*/
|
|
virtual ~AppSpawnClient();
|
|
|
|
/**
|
|
* Disable copy.
|
|
*/
|
|
DISALLOW_COPY_AND_MOVE(AppSpawnClient);
|
|
|
|
/**
|
|
* Try connect to appSpawn.
|
|
*/
|
|
ErrCode OpenConnection();
|
|
|
|
/**
|
|
* Close the connect of appspawn.
|
|
*/
|
|
void CloseConnection();
|
|
|
|
/**
|
|
* Return the connect state.
|
|
*/
|
|
SpawnConnectionState QueryConnectionState() const;
|
|
|
|
/**
|
|
* Return the clent handle.
|
|
*/
|
|
AppSpawnClientHandle GetAppSpawnClientHandle() const;
|
|
|
|
/**
|
|
* Set dac info.
|
|
*
|
|
* @param startMsg, request message.
|
|
* @param reqHandle, handle for request message
|
|
*/
|
|
int32_t SetDacInfo(const AppSpawnStartMsg &startMsg, AppSpawnReqMsgHandle reqHandle);
|
|
|
|
/**
|
|
* Set mount permission.
|
|
*
|
|
* @param startMsg, request message.
|
|
* @param reqHandle, handle for request message
|
|
*/
|
|
int32_t SetMountPermission(const AppSpawnStartMsg &startMsg, AppSpawnReqMsgHandle reqHandle);
|
|
|
|
/**
|
|
* Set start flags.
|
|
*
|
|
* @param startMsg, request message.
|
|
* @param reqHandle, handle for request message
|
|
*/
|
|
int32_t SetStartFlags(const AppSpawnStartMsg &startMsg, AppSpawnReqMsgHandle reqHandle);
|
|
|
|
/**
|
|
* Set extra info: render-cmd, HspList, Overlay, DataGroup, AppEnv.
|
|
*
|
|
* @param startMsg, request message.
|
|
* @param reqHandle, handle for request message
|
|
*/
|
|
int32_t AppspawnSetExtMsg(const AppSpawnStartMsg &startMsg, AppSpawnReqMsgHandle reqHandle);
|
|
|
|
/**
|
|
* Set extra info: provision_type, max_child_process.
|
|
*
|
|
* @param startMsg, request message.
|
|
* @param reqHandle, handle for request message
|
|
*/
|
|
int32_t AppspawnSetExtMsgMore(const AppSpawnStartMsg &startMsg, AppSpawnReqMsgHandle reqHandle);
|
|
|
|
/**
|
|
* Set extra info: parent uid.
|
|
*
|
|
* @param startMsg, request message,
|
|
* @param reqHandle, handle for request message
|
|
*
|
|
* Return the Message Set result.
|
|
*/
|
|
int32_t AppspawnSetExtMsgSec(const AppSpawnStartMsg &startMsg, AppSpawnReqMsgHandle reqHandle);
|
|
|
|
/**
|
|
* Create default appspawn msg.
|
|
*
|
|
* @param startMsg, request message.
|
|
* @param reqHandle, handle for request message
|
|
*/
|
|
int32_t AppspawnCreateDefaultMsg(const AppSpawnStartMsg &startMsg, AppSpawnReqMsgHandle reqHandle);
|
|
|
|
/**
|
|
* Verify startMsg.
|
|
*
|
|
* @param startMsg, request message.
|
|
*/
|
|
bool VerifyMsg(const AppSpawnStartMsg &startMsg);
|
|
|
|
/**
|
|
* Send appSpawn uninstall debug hap message.
|
|
*
|
|
* @param userId, the user id.
|
|
*/
|
|
int32_t SendAppSpawnUninstallDebugHapMsg(int32_t userId);
|
|
|
|
/**
|
|
* Start request to nwebspawn process.
|
|
*/
|
|
virtual int32_t PreStartNWebSpawnProcess();
|
|
|
|
/**
|
|
* AppSpawnClient core function, Start request to appSpawn.
|
|
*
|
|
* @param startMsg, request message.
|
|
* @param pid, pid of app process, get from appSpawn.
|
|
*/
|
|
virtual int32_t StartProcess(const AppSpawnStartMsg &startMsg, pid_t &pid);
|
|
|
|
virtual int32_t StartImageProcess(const AppSpawnStartMsg &startMsg, pid_t &pid, uint64_t &checkpointId);
|
|
|
|
/**
|
|
* Get render process termination status.
|
|
*
|
|
* @param startMsg, request message.
|
|
* @param status, termination status of render process, get from appSpawn.
|
|
*/
|
|
virtual int32_t GetRenderProcessTerminationStatus(const AppSpawnStartMsg &startMsg, int &status);
|
|
|
|
private:
|
|
std::string serviceName_ = APPSPAWN_SERVER_NAME;
|
|
AppSpawnClientHandle handle_ = nullptr;
|
|
SpawnConnectionState state_ = SpawnConnectionState::STATE_NOT_CONNECT;
|
|
|
|
#ifdef SUPPORT_CHILD_PROCESS
|
|
int32_t SetChildProcessTypeStartFlag(const AppSpawnReqMsgHandle &reqHandle, int32_t childProcessType);
|
|
#endif // SUPPORT_CHILD_PROCESS
|
|
|
|
int32_t SetExtMsgFds(const AppSpawnReqMsgHandle &reqHandle, const std::map<std::string, int32_t> &fds);
|
|
|
|
int32_t SetIsolationModeFlag(const AppSpawnStartMsg &startMsg, const AppSpawnReqMsgHandle &reqHandle);
|
|
|
|
int32_t SetStrictMode(const AppSpawnStartMsg &startMsg, const AppSpawnReqMsgHandle &reqHandle);
|
|
|
|
int32_t SetUserIdInfo(const AppSpawnStartMsg &startMsg, AppSpawnReqMsgHandle &reqHandle);
|
|
};
|
|
} // namespace AppExecFwk
|
|
} // namespace OHOS
|
|
#endif // OHOS_ABILITY_RUNTIME_APP_SPAWN_CLIENT_H
|