From 482001980756c92a9f09896aafe2c02cf5d449c0 Mon Sep 17 00:00:00 2001 From: shawn_he Date: Mon, 29 Aug 2022 16:04:58 +0800 Subject: [PATCH] update doc Signed-off-by: shawn_he --- .../subsystems/subsys-boot-init-jobs.md | 929 ++++++++++++++++-- 1 file changed, 865 insertions(+), 64 deletions(-) diff --git a/en/device-dev/subsystems/subsys-boot-init-jobs.md b/en/device-dev/subsystems/subsys-boot-init-jobs.md index e725ce382f..31e52aa9bb 100644 --- a/en/device-dev/subsystems/subsys-boot-init-jobs.md +++ b/en/device-dev/subsystems/subsys-boot-init-jobs.md @@ -1,11 +1,11 @@ # Job Management ## Overview -### Overview +### Function A job is a set of commands in the **.cfg** file of the init module. A maximum of 4096 jobs can be added. Jobs can be configured in the [.cfg file](subsys-boot-init-cfg.md). Generally, jobs are executed during initialization to serve the normal startup of services or the initialization of specific basic functions. ### Basic Concepts A job can be configured in the **init.cfg** file or the custom **.cfg** file of the module. The parser of the init process aggregates commands of the jobs with the same name into one job. For jobs with the same name, the init process only ensures that the commands in the **init.cfg** file are executed in preference. It does not guarantee the execution sequence of commands in other **.cfg** files. -- Basic job +- Common job A job executed in a fixed phase during init process startup, for example, pre-init, init, or post-init. - pre-init: pre-initialization phase. Key services on which other services depend, such as ueventd, watchdog, and hilogd, are started in this phase. The mounting of data partitions is also done in this phase. @@ -32,75 +32,876 @@ A job is a command set, where you can manage the commands to be executed. A maxi ### Parameters **Table 1** Command set description - | Command| Format and Example| Description| - | -------- | -------- | -------- | - | mkdir | mkdir target folder [mode] [owner] [group]
Example:
mkdir /storage/myDirectory
mkdir /storage/myDirectory 0755 root root| Creates a folder. mkdir and the target folder must be separated by only one space.
System type: small system and standard system| - | chmod | chmod permission target
Example:
chmod 0600 /storage/myFile.txt
chmod 0750 /storage/myDir | Modifies the permission, which must be in the 0xxx format. chmod, permission, and target must be separated by only one space.
System type: small system and standard system| - | chown | chown uid gid target
Example:
chown 900 800 /storage/myDir
chown 100 100 /storage/myFile.txt | Modifies the owner group. chown, uid, gid, and target must be separated by only one space.
System type: small system and standard system| - | mount | mount fileSystemType src dst flags data
Example:
mount vfat /dev/mmcblk0 /sdc rw,umask=000
mount jffs2 /dev/mtdblock3 /storage nosuid| Mounts devices. Every two parameters must be separated by only one space. For details about flags, see the mountFlagMap[] function in base/startup/init_lite/services/init/init_common_cmds.c. The data field is optional.
System type: small system and standard system| - | start | start serviceName
Example: start foundation| Starts services. serviceName must be contained in the services array.
System type: small system and standard system| - | export | export key value
Example:
export TEST /data/test| Sets environment variables. key and value respectively indicate the environment variable and its value.
System type: small system and standard system| - | rm | rm filename
Example:
rm /data/testfile| Deletes a file. filename indicates the absolute file path.
System type: small system and standard system| - | rmdir | rmdir dirname
Example:
rmdir /data/testdir| Deletes a directory. dirname indicates the absolute path of the directory.
System type: small system and standard system| - | write | write filename value
Example:
write /data/testfile 0| Writes a file. filename and value respectively indicate the absolute file path and the string to write.
System type: small system and standard system| - | stop | stop serviceName
Example:
stop console| Stops a service. servicenamei> indicates the name of the service to stop.
System type: small system and standard system| - | copy | copy oldfile newfile
Example:
copy /data/old /data/new| Copies a file. oldfile and newfile respectively indicate the old and new absolute file paths.
System type: small system and standard system| - | reset | reset serviceName
Example:
reset console| Resets a service. servicename indicates the name of the service to reset. If the service has not been started, this command will start the service. If the service is running, the command will stop the service and then restart it.
System type: small system and standard system| - | reboot | reboot [subsystem]
Example:
reboot updater| Restarts the system. subsystem is optional. If it is not specified, the device enters the current system upon restarting. If it is specified, the device enters the corresponding subsystem upon restarting. For example, if you run reboot updater, the device enters the updater subsystem upon restarting.
System type: small system and standard system| - | sleep | sleep time
Example:
sleep 5| Enters the sleep mode. time indicates the sleep time, which must not exceed 5 seconds.
To avoid impact on services, exercise caution when running this command.
System type: small system and standard system| - | domainname | domainname name
Example:
domainname localdomain| Sets the domain name.
System type: small system and standard system| - | hostname | hostname name
Example:
hostname localhost| Sets the host name.
System type: small system and standard system| - | wait | wait filepath [time]
Example:
wait /data/testfile or wait /data/testfile 5| Waits for commands. time indicates the waiting time, which must not exceed 5 seconds.
System type: small system and standard system| - | setrlimit | setrlimit resource curValue maxValue
Example:
setrlimit RLIMIT_CPU 10 100| Sets resource usage restrictions.
System type: small system and standard system| - | write | write path content
Example:
write /proc/sys/kernel/sysrq 0| Writes a file.
System type: small system and standard system| - | exec | exec Path of the executable file Parameters passed by the executable file
Example:
exec /system/bin/mkdir /data/test.txt| Runs an executable file. This command is called by the system.
System type: small system and standard system| - | syncexec | syncexec Path of the executable file Parameters passed by the executable file
Example:
syncexec /system/bin/udevadm trigger| Runs an executable file synchronously. The **wait** function will be called to wait for the child process to end. The command must not contain more than 10 parameters.
System type: standard system - | mknode |mknod name { b \| c } Major Minor
Example:
mknod path b 0644 1 9| Creates an index node corresponding to a directory entry and a special file.
System type: standard system| - | makedev | makedev major minor
Example:
makedev -v update| Creates a static device node, which is usually in the /dev directory.
System type: standard system| - | symlink | symlink target link_name
Example:
symlink /proc/self/fd/0 /dev/stdin| Creates a symbolic link.
System type: standard system| - | trigger | trigger jobName
Example:
trigger early-fs| Triggers a job.
System type: standard system| - | insmod | insmod [-f] [options]
Example:
insmod xxx.ko| Loads a kernel module file.
System type: standard system| - | setparam | setparam paramName paramValue
Example:
setparam sys.usb.config hdc| Sets system parameters.
System type: standard system| - | load_persist_params | load persist params
Example:
load_persist_params | Loads persist parameters. There must be one and only one space after the load_persist_params command.
System type: standard system| - | load_param | load params
Example:
load_param /data/test.normal.para| Loads the parameters from a file to the memory.
System type: standard system| - | load_access_token_id | load_access_token_id | Writes the access token to the data/service/el0/access_token/nativetoken.json file. There is one and only one space after load_access_token_id.
System type: standard system| - | ifup | ifup NIC
Example:
ifup eth0| Activates the specified NIC.
System type: standard system| - | mount_fstab | mount_fstab fstab.test
Example:
mount_fstab /vendor/etc/fstab.test| Mounts partitions based on the fstab file.
System type: standard system| - | umount_fstab | umount_fstab fstab.test
Example:
umount_fstab /vendor/etc/fstab.test| Unmounts partitions based on the fstab file.
System type: standard system| - | restorecon | restorecon file or dir
Example:
restorecon /file| Reloads the SELinux context.
System type: standard system| - | stopAllServices | stopAllServices [bool]
Example:
stopAllServices false or stopAllServices| Stops all services. The maximum response time is 10 ms by default.
System type: standard system| - | umount |umount path
Example:
umount /vendor| Unmounts a mounted device.
System type: standard system| - | sync | sync | Writes data to the disk synchronously. There is only one and only one space after sync.
System type: standard system| - | timer_start | timer_start serviceName
Example:
timer_start console| Starts the service timer.
System type: standard system| - | timer_stop | timer_stop serviceName
Example:
timer_stop console| Stops a service timer.
System type: standard system| - | init_global_key | init_global_key path
Example:
init_global_key /data| Initializes the encryption key of the data partition file.
System type: standard system| - | init_main_user | init_main_user| Encrypts the main user directory.
System type: standard system| - | mkswap | mkswap file
Example:
mkswap /swapfile1| Creates a swap partition on a file or device.
System type: standard system| - | swapon | swapon file
Example:
swapon /swapfile1| Activates the swap space.
System type: standard system| - | mksandbox | mksandbox fileName
Example:
mksandbox system| Creates a sandbox.
System type: standard system| - | loadcfg | loadcfg filePath
Example:
loadcfg /patch/fstab.cfg| Loads other .cfg files. The maximum size of the target file (only /patch/fstab.cfg supported currently) is 50 KB. Each line in the /patch/fstab.cfg file is a command. The command types and formats must comply with their respective requirements mentioned in this table. A maximum of 20 commands are allowed.
System type: small system| + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Command + + + Format and Example + + + Description + + + Supported System Type + +
+ mkdir + + mkdir target folder [mode] [owner] [group]
Example:
mkdir /storage/myDirectory
mkdir /storage/myDirectory 0755 root root + 		+ Creates a folder. mkdir and the target folder must be separated by only one space. Folders cannot be created recursively. + + Small and standard systems +
+ chmod + + chmod permission target
Example:
chmod 0600 /storage/myFile.txt
chmod 0750 /storage/myDir + 		+ Modifies the permission, which must be in the 0xxx format. chmod, permission, and target must be separated by only one space. + + Small and standard systems +
+ chown + + chown uid gid target
Example:
chown 900 800 /storage/myDir
chown 100 100 /storage/myFile.txt + 		+ Modifies the owner group. chown, uid, gid, and target must be separated by only one space. + + Small and standard systems +
+ mount + + mount fileSystemType src dst flags data
Example:
mount vfat /dev/mmcblk0 /sdc rw,umask=000
mount jffs2 /dev/mtdblock3 /storage nosuid + 		+ Mounts devices. Every two parameters must be separated by only one space.
For details about flags, see the mountFlagMap[] array of the mountFlagMap function in base/startup/init_lite/services/init/init_common_cmds.c. The data field is optional. + 		+ Small and standard systems +
+ start + + start serviceName
Example:
start foundationstart + 		+ Starts services. serviceName must be contained in the services array. + + Small and standard systems +
+ export + + export key value
Example:
export TEST /data/test + 		+ Sets environment variables. key and value respectively indicate the environment variable and its value. + + Small and standard systems +
+ rm + + rm filename
Example:
rm /data/testfile + 		+ Deletes a file. filename indicates the absolute file path. + + Small and standard systems +
+ rmdir + + rmdir dirname
Example:
rmdir /data/testdir + 		+ Deletes a directory. dirname indicates the absolute path of the directory. + + Small and standard systems +
+ write + + write filename value
Example:
write /data/testfile 0 + 		+ Writes a file. filename and value respectively indicate the absolute file path and the string to write. + + Standard system +
+ stop + + stop servicename
Example:
stop console + 		+ Stops a service. servicename indicates the name of the service to stop. + + Small and standard systems +
+ copy + + copy oldfile newfile
Example:
copy /data/old /data/new + 		+ Copies a file. oldfile and newfile respectively indicate the old and new absolute file paths. + + Small and standard systems +
+ reset + + reset servicename
Example:
reset console + 		+ Resets a service. servicename indicates the name of the service to reset. If the service has not been started, this command will start the service. If the service is running, the command will stop the service and then restart it. + + Small and standard systems +
+ reboot + + reboot subsystem
Example:
reboot updater + 		+ Restarts the system. subsystem is optional. If it is not specified, the device enters the current system upon restarting. If it is specified, the device enters the corresponding subsystem upon restarting. For example, if you run reboot updater, the device enters the updater subsystem upon restarting. + + Small and standard systems +
+ sleep + + sleep time
Example:
sleep 5 + 		+ Enters the sleep mode. time indicates the sleep time.
To avoid impact on services, exercise caution when running this command. + 		+ Small and standard systems +
+ domainname + + domainname name
Example:
domainname localdomain + 		+ Sets the domain name. + + Small and standard systems +
+ hostname + + hostname name
Example:
hostname localhost + 		+ Sets the host name. + + Small and standard systems +
+ wait + + wait filepath
Example:
wait /data/testfile or wait /data/testfile 5 + 		+ Waits for commands. The waiting time must not exceed 5 seconds. + + Small and standard systems +
+ setrlimit + + setrlimit resource curValue maxValue
Example:
setrlimit RLIMIT_CPU 10 100 + 		+ Sets resource usage restrictions.
For details, see the resource[] array of the DoSetrlimit function in base/startup/init_lite/services/init/init_common_cmds.c. + 		+ Small and standard systems +
+ exec + + exec Path of the executable file Parameters passed by the executable file
Example:
exec /system/bin/udevadm trigger + 		+ Runs an executable file. The command must not contain more than 10 parameters. + + Small and standard systems +
+ syncexec + + syncexec Path of the executable file Parameters passed by the executable file
Example:
syncexec /system/bin/udevadm trigger + 		+ Runs an executable file synchronously. The **wait** function will be called to wait for the child process to end. The command must not contain more than 10 parameters. + + Standard system +
+ mknode + + mknod name { b | c } Major Minor
Example:
mknod path b 0644 1 9 + 		+ Creates an index node corresponding to a directory entry and a special file. + + Standard system +
+ makedev + + makedev major minor
Example:
makedev -v update + 		+ Creates a static device node, which is usually in the /dev directory. + + Standard system +
+ symlink + + symlink target link_name
Example
symlink /proc/self/fd/0 /dev/stdin + 		+ Creates a symbolic link. + + Standard system +
+ trigger + + trigger jobName
Example
trigger early-fs + 		+ Triggers a job. + + Standard system +
+ insmod + + insmod [-f] [options]
Example
insmod xxx.ko + 		+ Loads a kernel module file. + + Standard system +
+ setparam + + setparam paramname paramvalue
Example:
setparam sys.usb.config hdc + 		+ Sets system parameters. + + Standard system +
+ load_persist_params + + load persist params
Example:
load_persist_params  + 		+ Loads persist parameters. There must be one and only one space after the load_persist_params command. + + Standard system +
+ load_param + + load params
Example:
load_param /data/test.normal.para + 		+ Loads the parameters from a file to the memory. + + Standard system +
+ load_access_token_id + + load_access_token_id  + + Writes the access token to the data/service/el0/access_token/nativetoken.json file. There is one and only one space after load_access_token_id. + + Standard system +
+ ifup + + ifup NIC
Example:
ifup eth0 + 		+ Activates the specified NIC. + + Standard system +
+ mount_fstab + + mount_fstab fstab.test
Example:
mount_fstab /vendor/etc/fstab.test + 		+ Mounts partitions based on the fstab file. + + Standard system +
+ umount_fstab + + umount_fstab fstab.test
Example:
umount_fstab /vendor/etc/fstab.test + 		+ Unmounts partitions based on the fstab file. + + Standard system +
+ restorecon + + restorecon file or dir
Example:
restorecon /file + 		+ Reloads the SELinux context. + + Standard system +
+ stopAllServices + + stopAllServices [bool]
Example:
stopAllServices false
stopAllServices + 		+ Stops all services. + + Standard system +
+ umount + + umount path
Example:
umount /vendor + 		+ Unmounts a mounted device. + + Standard system +
+ sync + + sync  + + Writes data to the disk synchronously. There is only one and only one space after sync. + + Standard system +
+ timer_start + + timer_start serviceName
Example:
timer_start console + 		+ Starts the service timer. + + Standard system +
+ timer_stop + + timer_stop serviceName
Example:
timer_stop console + 		+ Stops the service timer. + + Standard system +
+ init_global_key + + init_global_key path
Example:
init_global_key /data + 		+ Initializes the encryption key of the data partition file. + + Standard system +
+ init_main_user + + init_main_user + + Encrypts the main user directory. + + Standard system +
+ mkswap + + mkswap file
Example:
mkswap /swapfile1 + 		+ Creates a swap partition on a file or device. + + Standard system +
+ swapon + + swapon file
Example:
swapon /swapfile1 + 		+ Activates the swap space. + + Standard system +
+ mksandbox + + mksandbox fileName
Example:
mksandbox system + 		+ Creates a sandbox. + + Standard system +
+ loadcfg + + loadcfg filePath
Example:
loadcfg /patch/fstab.cfg + 		+ Loads other .cfg files. The maximum size of the target file (only /patch/fstab.cfg supported currently) is 50 KB. Each line in the /patch/fstab.cfg file is a command. The command types and formats must comply with their respective requirements mentioned in this table. A maximum of 20 commands are allowed. + + Small system +
### Available APIs Job management is a part of the init startup process. It is a process-based function that completely serves the init startup process. It does not provide any functional APIs for other modules. It works in a way similar to command group management and does not provide help for other types of management. The following describes the job management APIs. **Table 2** Description of job parsing APIs -| API| Description| Supported System Type| -|:--------|:-----|:------| -|void ParseAllJobs(const cJSON *fileRoot)|Provides the general entry for parsing jobs.| Small and standard systems| -|static void ParseJob(const cJSON *jobItem, Job *resJob)|Checks whether a job exists and parses cmds in it.| Small system| -|int GetCmdLinesFromJson(const cJSON *root, CmdLines **cmdLines)| Parses cmds in the job. This API is used for the small system.
It does not apply to the standard system because the trigger command and condition attribute are involved.| Small and standard systems| -|int ParseTriggerConfig(const cJSON *fileRoot,
int (*checkJobValid)(const char *jobName))|Parses the trigger command in the job.| Standard System| -|static int ParseTrigger_(const TriggerWorkSpace *workSpace,
const cJSON *triggerItem,
int (*checkJobValid)(const char *jobName))|Obtains the job name, condition attribute, and cmds command group.
Jobs are stored in a hash table, and commands are stored in a queue structure.| Standard system| + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ API + + Input Parameter + + Return Value + + Description + + Supported System Type +
+ void ParseAllJobs(const cJSON *fileRoot) + + const cJSON *fileRoot + + void + + Provides the general entry for parsing jobs. + + Small and standard systems +
+ static void ParseJob(const cJSON  *jobItem, Job *resJob) + + const cJSON *jobItem, Job *resJob + + void + + Checks whether a job exists and parses cmds in it. + + Small system +
+ int GetCmdLinesFromJson(const cJSON *root, CmdLines **cmdLines) + + const cJSON *root, CmdLines **cmdLines + + int + + Parses cmds in the job. This API is used for the small system. It does not apply to the standard system because the trigger command and condition attribute are involved. + + Small and standard systems +
+ int ParseTriggerConfig(const cJSON *fileRoot, int (*checkJobValid)(const char *jobName)) + + const cJSON *fileRoot, int (*checkJobValid)(const char *jobName) + + int + + Parses the trigger command in the job. + + Standard system +
+ static int ParseTrigger_(const TriggerWorkSpace *workSpace, const cJSON *triggerItem, int (*checkJobValid)(const char *jobName)) + + const TriggerWorkSpace *workSpace, const cJSON *triggerItem, int (*checkJobValid)(const char *jobName) + + int + + Obtains the job name, condition attribute, and cmds command group. Jobs are stored in a hash table, and commands are stored in a queue structure. + + Standard system +
**Table 3** Description of the job triggering APIs -| API| Description| Supported System Type| -|:--------|:-----|:------| -|void PostTrigger(EventType type, const char *content, uint32_t contentLen)|Verifies the validity of the job name and sends a job triggering event.| Standard system| -|static void SendTriggerEvent(int type, const char *content, uint32_t contentLen)|Performs functions such as system control and starting or stopping of services based on system parameters.| Standard system| -|static void DoTriggerCmd(const struct CmdArgs *ctx)|Executes the trigger command.| Standard system| -|void DoTriggerExec(const char *triggerName)| Finds a command group based on the job name and pushes the commands in the command group to the execution queue.| Standard system| -|void DoJob(const char *jobName)|Matches a job based on the job name and invokes DoCmdByIndex to execute the commands in the job.| Small system| -|void DoCmdByIndex(int index, const char *cmdContent)|Combines parameters and commands.| Small and standard systems| + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ API + + Input Parameter + + Return Value + + Description + + Supported System Type +
+ void PostTrigger(EventType type, const char *content, uint32_t contentLen) + + EventType type, const char *content, uint32_t contentLen + + void + + Verifies the validity of the job name and sends a job triggering event. + + Standard system +
+ static void SendTriggerEvent(int type, const char *content, uint32_t contentLen) + + int type, const char *content, uint32_t contentLen + + void + + Performs functions such as system control and starting or stopping of services based on system parameters. + + Standard system +
+ static void DoTriggerCmd(const struct CmdArgs *ctx) + + const struct CmdArgs *ctx + + void + + Executes the trigger command. + + Standard system +
+ void DoTriggerExec(const char *triggerName) + + const char *triggerName + + void + + Finds a command group based on the job name and pushes the commands in the command group to the execution queue. This API is available only for the standard system. + + Standard system +
+ void DoJob(const char *jobName) + + const char *jobName + + void + + Matches a job based on the job name and invokes DoCmdByIndex to execute the commands in the job. + + Small system +
+ void DoCmdByIndex(int index, const char *cmdContent) + + int index, const char *cmdContent + + void + + Combines parameters and commands. + + Small and standard systems +
### Development Example The following is the template for configuring jobs in the .cfg file. You can use it to verify the job management function. -- GitLab