Job Management

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

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. - init: main phase of the initialization process. In this phase, a large number of commands are executed, and services in the boot group (first group) are started concurrently by the init group. Some important services related to system functions are also started in this phase. - post-init: post-initialization phase. In this phase, the trigger command is used to invoke the execution of other phases, which can be regarded as independent phases, or the post-init phase as a whole. In this phase, a large number of commands are executed, and the normal group (the second group) is started by the init group. Most services configured in the .cfg files are started in this phase.

• Custom job (for standard system or higher)

A job triggered based on specific rules. You can add commands to the job as required and run the trigger command to invoke the execution of commands in the job.

• Conditional job (for standard system or higher)

A job triggered based on specific conditions. You can add conditions to a job so that the job is executed when the conditions are met.

A condition is a combination of system parameter values. It supports operations such as && and || as well as matching of any parameter values by using the wildcard character (*).

Generally, you can configure a condition in the format shown below:

  "condition": "sys.usb.config = none && sys.usb.configfs = 0"

If you need to enable parameter checking in the boot phase, configure the condition as follows:

  "condition": "boot && const.debuggable=1"

When defining commands for a job, you can add attributes in the format of param:xxx to form different commands.

Constraints

With the system parameter module, the standard system is able to support basic, conditional, and custom jobs. The small system supports only basic jobs.

How to Develop

Use Cases

A job is a command set, where you can manage the commands to be executed. A maximum of 4096 commands can be added to a command set. During the init startup process, the execution of jobs helps ensure normal running of services.

Parameter Description

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

{
    "jobs" : [{     // Basic job
            "name" : "stage1",
            "cmds" : [
                "start service1",
                "mkdir dir1"
            ]
        }, {        // Conditional job
            "name" : "param:test.name1=0",
            "condition" : "test.name1=0",
            "cmds" : [
                "chmod 0755 dir1",
                "chown root root dir1"
            ]
        }, {        // Custom job
            "name" : "param:test.name2=*",
            "condition" : "test.name2=*",
            "cmds" : [
                "chmod 0644 dir1",
                "chown system system dir1"
            ]
        }
    ]
}