forked from openkylin/docs
update 开始贡献/openKylin+SDK开发指南V2.0.md.
Signed-off-by: chipo <gugudu@sina.com>
This commit is contained in:
chipo
Gitee
parent
799fedc0a2
commit
956a609721
|
|
@ -431,126 +431,42 @@ $ sudo apt-get install libkysdk-hardware libkysdk-hardware-dev |
|
|||
获取系统中所有磁盘的列表
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 磁 | C | extern char\*\* | 获取系统中 | |
|
||||
| | | kdk_get_disklist() | | |
|
||||
| > 盘信息 | | | 所有磁盘的 | |
|
||||
| | | | | |
|
||||
| | | | > 列表 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | char\*\*， | |
|
||||
| | | | 每个字符串表示 | |
|
||||
| | | | | |
|
||||
| | | | 一 | |
|
||||
| | | | 个磁盘的绝对路径， | |
|
||||
| | | | | |
|
||||
| | | | 结尾以 NULL | |
|
||||
| | | | 字符表示结 | |
|
||||
| | | | | |
|
||||
| | | | > 束 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|----------------------------------|-----------------------------------------|
|
||||
| 获取磁盘信息 | C | extern char** kdk_get_disklist() | 获取系统中所有磁盘的列表 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | char**， 每个字符串表示一个磁盘的绝对路径， 结尾以NULL字符表示结束 |
|
||||
|
||||
```
|
||||
|
||||
释放由 kdk_get_disklist 返回的磁盘列表
|
||||
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|------------------------------------------------|----------------------------|
|
||||
| 获取磁盘信息 | C | extern void kdk_free_disklist(char** disklist) | 释放由kdk_get_disklist返回的磁盘列表 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | disklist ：由kdk_get_disk_list返回的字符串指针 | 无 |
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+---------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+===============+===+
|
||||
| 获 取 磁 | C | extern void | > 释 放 由 | |
|
||||
| | | kdk_free | | |
|
||||
| > 盘信息 | | _disklist(char\*\* | kdk_get_disk | |
|
||||
| | | disklist) | | |
|
||||
| | | | list 返 回 的 | |
|
||||
| | | | | |
|
||||
| | | | > 磁盘列表 | |
|
||||
+----------+------------+--------------------+---------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+---------------+---+
|
||||
| | | > disklist ： 由 | > 无 | |
|
||||
| | | > | | |
|
||||
| | | > | | |
|
||||
| | | kdk_get_disk_list | | |
|
||||
| | | | | |
|
||||
| | | 返回的字符串指 | | |
|
||||
| | | | | |
|
||||
| | | > 针 | | |
|
||||
+----------+------------+--------------------+---------------+---+
|
||||
```
|
||||
|
||||
|
||||
获取系统中指定磁盘的磁盘信息
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 磁 | C | extern | 获取指定磁 | |
|
||||
| | | kdk_diskinfo | | |
|
||||
| > 盘信息 | | \*kdk_ | 盘的磁盘信 | |
|
||||
| | | get_diskinfo(const | | |
|
||||
| | | | > 息 | |
|
||||
| | | char \*diskname) | | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | diskname ： 指 定 | kdk_diskinfo\* | |
|
||||
| | | | 该磁盘的详 | |
|
||||
| | | 磁盘名称，应当 | | |
|
||||
| | | | > 细 | |
|
||||
| | | 是 例 如 /dev/sda | 信息，具体信息自取 | |
|
||||
| | | | | |
|
||||
| | | 这种绝对路径， | | |
|
||||
| | | | | |
|
||||
| | | 或者是 disklist 中 | | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|-------------------------------------------------------------|-------------------------------|
|
||||
| 获取磁盘信息 | C | extern kdk_diskinfo *kdk_get_diskinfo(const char *diskname) | 获取指定磁盘的磁盘信息 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | diskname：指定磁盘名称，应当是例如/dev/sda这种绝对路径，或者是disklist中的某个元素 | kdk_diskinfo* 该磁盘的详细信息，具体信息自取 |
|
||||
|
||||
|
||||
|
||||
```
|
||||
+---+---+--------------+---+---+
|
||||
| | | > 的某个元素 | | |
|
||||
+---+---+--------------+---+---+
|
||||
```
|
||||
|
||||
|
||||
释放由 kdk_get_diskinfo 返回的磁盘信息结构体
|
||||
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|----------------------------------------------------|-------------------------------|
|
||||
| 获取磁盘信息 | C | extern void kdk_free_diskinfo(kdk_diskinfo *disk); | 释放由kdk_get_diskinfo返回的磁盘信息结构体 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | disk：由kdk_get_diskinfo返回的结构体指针 | 无 |
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+---------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+===============+===+
|
||||
| 获 取 磁 | C | extern void | > 释 放 由 | |
|
||||
| | | kdk_free_dis | | |
|
||||
| > 盘信息 | | kinfo(kdk_diskinfo | kdk_get_disk | |
|
||||
| | | | | |
|
||||
| | | \*disk); | info 返 回 的 | |
|
||||
| | | | | |
|
||||
| | | | 磁盘信息结 | |
|
||||
| | | | | |
|
||||
| | | | > 构体 | |
|
||||
+----------+------------+--------------------+---------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+---------------+---+
|
||||
| | | > disk ： 由 | > 无 | |
|
||||
| | | > | | |
|
||||
| | | > kdk_get_diskinfo | | |
|
||||
| | | | | |
|
||||
| | | 返回的结构体指 | | |
|
||||
| | | | | |
|
||||
| | | > 针 | | |
|
||||
+----------+------------+--------------------+---------------+---+
|
||||
```
|
||||
|
||||
|
||||
#### 3.1.2.4 获取 bios 信息
|
||||
|
|
@ -578,67 +494,33 @@ $ sudo apt-get install libkysdk-hardware libkysdk-hardware-dev |
|
|||
获取 bios 厂商信息
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 磁 | C | extern const char | 获取 bios 厂 | |
|
||||
| | | \*kdk_ | | |
|
||||
| > 盘信息 | | bios_get_vendor(); | > 商信息 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | 成功返回 bios | |
|
||||
| | | | 厂商，失败 | |
|
||||
| | | | | |
|
||||
| | | | > 返回 null | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|-------------------------------------------|---------------------|
|
||||
| 获取磁盘信息 | C | extern const char *kdk_bios_get_vendor(); | 获取bios厂商信息 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | 成功返回bios厂商，失败返回null |
|
||||
|
||||
|
||||
|
||||
获取 bios 版本信息
|
||||
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|--------------------------------------------|---------------------|
|
||||
| 获取磁盘信息 | C | extern const char *kdk_bios_get_version(); | 获取bios版本信息 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | 成功返回bios版本，失败返回null |
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 磁 | C | extern const char | 获取 bios 版 | |
|
||||
| | | \*kdk_b | | |
|
||||
| > 盘信息 | | ios_get_version(); | > 本信息 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | 成功返回 bios | |
|
||||
| | | | 版本，失败 | |
|
||||
| | | | | |
|
||||
| | | | > 返回 null | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
|
||||
|
||||
释放内存
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+------+--------+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 |
|
||||
+----------+------------+------+--------+
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|----------------------------------------|---------------|
|
||||
| 获取磁盘信息 | C | extern void kdk_bios_free(char* info); | 释放获取信息接口申请的内存 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 获取信息接口返回的指针 | 无 |
|
||||
|
||||
+----------+---+-----------------------------------------+--------------+---+
|
||||
| 获 取 磁 | C | extern void kdk_bios_free(char\* info); | 释放获取信 | |
|
||||
| | | | | |
|
||||
| > 盘信息 | | | 息接口申请 | |
|
||||
| | | | | |
|
||||
| | | | > 的内存 | |
|
||||
+==========+===+=========================================+==============+===+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+---+-----------------------------------------+--------------+---+
|
||||
| | | 获取信息接口返 | > 无 | |
|
||||
| | | | | |
|
||||
| | | > 回的指针 | | |
|
||||
+----------+---+-----------------------------------------+--------------+---+
|
||||
```
|
||||
|
||||
|
||||
#### 3.1.2.5 获取主板信息
|
||||
|
|
@ -665,113 +547,53 @@ $ sudo apt-get install libkysdk-hardware libkysdk-hardware-dev |
|
|||
|
||||
获取主板产品名称信息
|
||||
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|------------------------------------------|---------------------|
|
||||
| 获取磁盘信息 | C | extern const char *kdk_board_get_name(); | 获取主板产品名称 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | 成功返回主板产品名称，失败返回null |
|
||||
|
||||
```
|
||||
+----------+------------+-------------------------------------------+------------+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 |
|
||||
+==========+============+===========================================+============+
|
||||
| 获 取 磁 | C | extern const char \*kdk_board_get_name(); | 获取主板产 |
|
||||
| | | | |
|
||||
| > 盘信息 | | | > 品名称 |
|
||||
+----------+------------+-------------------------------------------+------------+
|
||||
```
|
||||
|
||||
|
||||
|
||||
```
|
||||
+---+---+------------+------------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+===+===+============+========================+===+
|
||||
| | | > 无 | 成功返回主板产品名称， | |
|
||||
| | | | | |
|
||||
| | | | > 失败返回 null | |
|
||||
+---+---+------------+------------------------+---+
|
||||
```
|
||||
|
||||
|
||||
获取主板生产日期
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 磁 | C | extern const char | 获取主板生 | |
|
||||
| | | \*kdk | | |
|
||||
| > 盘信息 | | _board_get_date(); | > 产日期 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | 成功 | |
|
||||
| | | | 返回主板生产日期， | |
|
||||
| | | | | |
|
||||
| | | | > 失败返回 null | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|------------------------------------------|---------------------|
|
||||
| 获取磁盘信息 | C | extern const char *kdk_board_get_date(); | 获取主板生产日期 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | 成功返回主板生产日期，失败返回null |
|
||||
|
||||
|
||||
获取主板序列号
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 磁 | C | extern const char | 获取主板序 | |
|
||||
| | | \*kdk_b | | |
|
||||
| > 盘信息 | | oard_get_serial(); | > 列号 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | 成功 | |
|
||||
| | | | 返回主板序列号，失 | |
|
||||
| | | | | |
|
||||
| | | | > 败返回 null | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|--------------------------------------------|--------------------|
|
||||
| 获取磁盘信息 | C | extern const char *kdk_board_get_serial(); | 获取主板序列号 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | 成功返回主板序列号，失败返回null |
|
||||
|
||||
|
||||
获取主板厂商信息
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 磁 | C | extern const char | 获取主板厂 | |
|
||||
| | | \*kdk_b | | |
|
||||
| > 盘信息 | | oard_get_vendor(); | > 商信息 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | 成功 | |
|
||||
| | | | 返回主板厂商信息， | |
|
||||
| | | | | |
|
||||
| | | | > 失败返回 null | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|--------------------------------------------|---------------------|
|
||||
| 获取磁盘信息 | C | extern const char *kdk_board_get_vendor(); | 获取主板厂商信息 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | 成功返回主板厂商信息，失败返回null |
|
||||
|
||||
|
||||
|
||||
释放内存
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+------------------------------------------+--------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+==========================================+==============+===+
|
||||
| 获 取 磁 | C | extern void kdk_board_free(char\* info); | 释放获取信 | |
|
||||
| | | | | |
|
||||
| > 盘信息 | | | 息接口申请 | |
|
||||
| | | | | |
|
||||
| | | | > 的内存 | |
|
||||
+----------+------------+------------------------------------------+--------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+------------------------------------------+--------------+---+
|
||||
| | | 获取信息接口返 | > 无 | |
|
||||
| | | | | |
|
||||
| | | > 回的指针 | | |
|
||||
+----------+------------+------------------------------------------+--------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|-----------------------------------------|---------------|
|
||||
| 获取磁盘信息 | C | extern void kdk_board_free(char* info); | 释放获取信息接口申请的内存 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 获取信息接口返回的指针 | 无 |
|
||||
|
||||
|
||||
|
||||
#### 3.1.2.6 获取 usb 设备信息
|
||||
|
|
@ -799,56 +621,23 @@ $ sudo apt-get install libkysdk-hardware libkysdk-hardware-dev |
|
|||
获取所有 usb 设备信息
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 磁 | C | extern | 获 取 usb 设 | |
|
||||
| | | pDriverInfoList | | |
|
||||
| > 盘信息 | | k | > 备信息 | |
|
||||
| | | dk_usb_get_list(); | | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | pDriverInfoList : | |
|
||||
| | | | usb 设 备 | |
|
||||
| | | | | |
|
||||
| | | | 信息 | |
|
||||
| | | | 的结构体指针，具体 | |
|
||||
| | | | | |
|
||||
| | | | > 信息自取 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|--------------------------------------------|----------------------------------------|
|
||||
| 获取磁盘信息 | C | extern pDriverInfoList kdk_usb_get_list(); | 获取usb设备信息 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | pDriverInfoList : usb设备信息的结构体指针，具体信息自取 |
|
||||
|
||||
释放内存
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+==============+===+
|
||||
| 获 取 磁 | C | extern void | 释放获取信 | |
|
||||
| | | kdk_usb_fr | | |
|
||||
| > 盘信息 | | ee(pDriverInfoList | 息时申请的 | |
|
||||
| | | list); | | |
|
||||
| | | | > 内存 | |
|
||||
+----------+------------+--------------------+--------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|-------------------------------------------------|--------------|
|
||||
| 获取磁盘信息 | C | extern void kdk_usb_free(pDriverInfoList list); | 释放获取信息时申请的内存 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | list:kdk_usb_get_list()返回的指针 | 无 |
|
||||
|
||||
|
||||
|
||||
```
|
||||
+---+---+--------------------+------+---+
|
||||
| | | list:kdk_usb_get_l | > 无 | |
|
||||
| | | | | |
|
||||
| | | > ist()返回的指针 | | |
|
||||
+---+---+--------------------+------+---+
|
||||
```
|
||||
|
||||
|
||||
### **3.1.3** 获取包列表信息
|
||||
|
||||
封装 C 接口获取系统中所有的包信息。
|
||||
|
|
@ -877,106 +666,36 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev
|
|||
获取系统中所有包列表
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 包 | C | extern | 获取系统中所有 | |
|
||||
| | | kdk_package_list\* | | |
|
||||
| 列 表 信 | | | > 包列表 | |
|
||||
| | | kdk_package | | |
|
||||
| > 息 | | _get_packagelist() | | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | kdk_package_list\* | |
|
||||
| | | | 包描述 | |
|
||||
| | | | | |
|
||||
| | | | 结构 | |
|
||||
| | | | 体列表；返回的结构 | |
|
||||
| | | | | |
|
||||
| | | | > 体 需 要 由 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|---------|------|--------------------------------------------------------|----------------------------------------------------------------------|
|
||||
| 获取包列表信息 | C | extern kdk_package_list* kdk_package_get_packagelist() | 获取系统中所有包列表 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | kdk_package_list* 包描述结构体列表；返回的结构体需要由kdk_package_free_packagelist()回收 |
|
||||
|
||||
|
||||
|
||||
```
|
||||
+---+---+---+--------------------------+---+
|
||||
| | | | kdk_package_free_package | |
|
||||
| | | | | |
|
||||
| | | | > list()回收 | |
|
||||
+---+---+---+--------------------------+---+
|
||||
```
|
||||
|
||||
|
||||
获取系统中指定包的版本号
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 包 | C | extern char\* | 获取系统中指 | |
|
||||
| | | kdk_package | | |
|
||||
| 列 表 信 | | _get_version(const | 定包的版本号 | |
|
||||
| | | | | |
|
||||
| > 息 | | char \*name) | | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > name：软件包名 | char\* 版本号，由 | |
|
||||
| | | | alloc 生 | |
|
||||
| | | | | |
|
||||
| | | | 成，需要被 | |
|
||||
| | | | free；若给定 | |
|
||||
| | | | | |
|
||||
| | | | 的 包 不 存 在 ， | |
|
||||
| | | | 则 返 回 | |
|
||||
| | | | | |
|
||||
| | | | > NULL | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|---------|------|--------------------------------------------------------|---------------------------------------------|
|
||||
| 获取包列表信息 | C | extern char* kdk_package_get_version(const char *name) | 获取系统中指定包的版本号 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | name：软件包名 | char* 版本号，由alloc生成，需要被free；若给定的包不存在，则返回NULL |
|
||||
|
||||
|
||||
|
||||
检测指定包名的软件包是否正确安装
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+==============+===+
|
||||
| 获 取 包 | C | extern int | 检测指定包名 | |
|
||||
| | | kdk_package_ | | |
|
||||
| 列 表 信 | | is_installed(const | 的软件包是否 | |
|
||||
| | | char | | |
|
||||
| > 息 | | | > 正确安装 | |
|
||||
| | | \*name, const char | | |
|
||||
| | | \*version) | | |
|
||||
+----------+------------+--------------------+--------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|------------------------------------|-------------------|----------------------------------------------------------------------------|------------------|
|
||||
| 获取包列表信息 | C | extern int kdk_package_is_installed(const char *name, const char *version) | 检测指定包名的软件包是否正确安装 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | name：软件包名 |
|
||||
| version：版本号，大部分情况下为NULL，预留为snap做准备 | int 成功返回0，失败返回错误码 |
|
||||
|
||||
|
||||
|
||||
```
|
||||
+---+---+------------------+------------------------+---+
|
||||
| | | name ： 软 件 | int 成功返回 0，失败返 | |
|
||||
| | | | | |
|
||||
| | | > 包名 | > 回错误码 | |
|
||||
| | | | | |
|
||||
| | | version：版本 | | |
|
||||
| | | | | |
|
||||
| | | 号，大部分情况下 | | |
|
||||
| | | | | |
|
||||
| | | 为 NULL，预留为 | | |
|
||||
| | | | | |
|
||||
| | | > snap 做准备 | | |
|
||||
+---+---+------------------+------------------------+---+
|
||||
|
||||
```
|
||||
|
||||
### **3.1.4** 获取资源信息
|
||||
|
||||
封装 C 接口获取到内存、swap 分区、cpu 的使用率。
|
||||
|
|
@ -1007,301 +726,124 @@ $ sudo apt-get install libkysdk-package libkysdk-package-dev
|
|||
|
||||
获取系统中物理内存总大小
|
||||
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|------------------------------------------------------|-----------------------------|
|
||||
| 获取资源信息 | C | extern unsigned long kdk_rti_get_mem_res_total_KiB() | 获取系统中物理内存总大小 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | unsigned long 物理内存大小，KiB为单位 |
|
||||
|
||||
```
|
||||
+----------+------------+---------------------------------+--------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+=================================+==============+===+
|
||||
| 获 取 资 | C | extern unsigned long | 获取系统中物 | |
|
||||
| | | | | |
|
||||
| > 源信息 | | kdk_rti_get_mem_res_total_KiB() | 理内存总大小 | |
|
||||
+----------+------------+---------------------------------+--------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+---------------------------------+--------------+---+
|
||||
```
|
||||
|
||||
|
||||
|
||||
```
|
||||
+---+---+------+---------------------------+---+
|
||||
| | | > 无 | unsigned long 物 理 内 存 | |
|
||||
| | | | | |
|
||||
| | | | > 大小，KiB 为单位 | |
|
||||
+---+---+------+---------------------------+---+
|
||||
```
|
||||
|
||||
|
||||
获取物理内存使用率
|
||||
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|--------------------------------------------------|---------------|
|
||||
| 获取资源信息 | C | extern float kdk_rti_get_mem_res_usage_percent() | 获取物理内存使用率 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | float 物理内存使用率 |
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 资 | C | extern float | 获取物理内 | |
|
||||
| | | | | |
|
||||
| > 源信息 | | kdk_rti_get_mem_r | > 存使用率 | |
|
||||
| | | es_usage_percent() | | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | > float | |
|
||||
| | | | > 物理内存使用率 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
|
||||
|
||||
获取物理内存使用大小
|
||||
|
||||
|
||||
```
|
||||
+----------+----------+---------------------------------+--------------------------+---+
|
||||
| > 子模块 | 编程语言 | 声明 | > 描述 | |
|
||||
+==========+==========+=================================+==========================+===+
|
||||
| 获 取 资 | C | extern unsigned long | 获 取 物 理 内 存 | |
|
||||
| | | | | |
|
||||
| > 源信息 | | kdk_rti_get_mem_res_usage_KiB() | 使 用 大 小 ， 注 | |
|
||||
| | | | | |
|
||||
| | | | 意 Buffer/Cache | |
|
||||
| | | | | |
|
||||
| | | | 被 计 算 为 已 使 | |
|
||||
| | | | | |
|
||||
| | | | > 用内存 | |
|
||||
+----------+----------+---------------------------------+--------------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+----------+---------------------------------+--------------------------+---+
|
||||
| | | > 无 | unsigned long 物理内存使 | |
|
||||
| | | | | |
|
||||
| | | | > 用大小，KiB 为单位 | |
|
||||
+----------+----------+---------------------------------+--------------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|------------------------------------------------------|------------------------------------|
|
||||
| 获取资源信息 | C | extern unsigned long kdk_rti_get_mem_res_usage_KiB() | 获取物理内存使用大小，注意Buffer/Cache被计算为已使用内存 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | unsigned long 物理内存使用大小，KiB为单位 |
|
||||
|
||||
|
||||
|
||||
获取实际可用的物理内存大小
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+------+--------+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 |
|
||||
+----------+------------+------+--------+
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|----------------------------------------------------------|-------------------------------------------|
|
||||
| 获取资源信息 | C | extern unsigned long kdk_rti_get_mem_res_available_KiB() | 获取实际可用的物理内存大小，该数值约等于Free + Buffer + Cache |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | unsigned long 可用物理内存大小，KiB为单位 |
|
||||
|
||||
+----------+---+-------------------------------------+----------------------------+---+
|
||||
| 获 取 资 | C | extern unsigned long | 获取实际可用 | |
|
||||
| | | | | |
|
||||
| > 源信息 | | kdk_rti_get_mem_res_available_KiB() | 的物理内存大 | |
|
||||
| | | | | |
|
||||
| | | | 小，该数值约 | |
|
||||
| | | | | |
|
||||
| | | | 等 于 Free + | |
|
||||
| | | | | |
|
||||
| | | | Buffer + Cache | |
|
||||
+==========+===+=====================================+============================+===+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+---+-------------------------------------+----------------------------+---+
|
||||
| | | > 无 | unsigned long 可用物理内存 | |
|
||||
| | | | | |
|
||||
| | | | > 大小，KiB 为单位 | |
|
||||
+----------+---+-------------------------------------+----------------------------+---+
|
||||
```
|
||||
|
||||
|
||||
获取实际空闲的物理内存大小
|
||||
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|-----------------------------------------------------|---------------------------------------|
|
||||
| 获取资源信息 | C | extern unsigned long kdk_rti_get_mem_res_free_KiB() | 获取实际空闲的物理内存大小，注意Buffer/Cache被计算为已使用内存 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | unsigned long 空闲的物理内存大小，KiB为单位 |
|
||||
|
||||
```
|
||||
+----------+----------+---------------------+---------------------+---+
|
||||
| > 子模块 | 编程语言 | 声明 | > 描述 | |
|
||||
+==========+==========+=====================+=====================+===+
|
||||
| 获 取 资 | C | extern unsigned | > 获取实际空闲 | |
|
||||
| | | long | 的物理内存大小，注 | |
|
||||
| > 源信息 | | | > 意Buffer/Cache | |
|
||||
| | | kdk_rti_get | > | |
|
||||
| | | _mem_res_free_KiB() | 被计算为已使用内存 | |
|
||||
+----------+----------+---------------------+---------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+----------+---------------------+---------------------+---+
|
||||
| | | > 无 | unsigned long | |
|
||||
| | | | 空闲的物理 | |
|
||||
| | | | | |
|
||||
| | | | > 内存大小，KiB | |
|
||||
| | | | > 为单位 | |
|
||||
+----------+----------+---------------------+---------------------+---+
|
||||
|
||||
```
|
||||
|
||||
获取所有应用申请的虚拟内存总量
|
||||
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|-------------------------------------------------------|-------------------------------|
|
||||
| 获取资源信息 | C | extern unsigned long kdk_rti_get_mem_virt_alloc_KiB() | 获取所有应用申请的虚拟内存总量 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | unsigned long 虚拟内存总申请量，KiB为单位 |
|
||||
|
||||
```
|
||||
+----------+------------+----------------------------------+----------------+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 |
|
||||
+==========+============+==================================+================+
|
||||
| 获 取 资 | C | extern unsigned long | 获取所有应用申 |
|
||||
| | | | |
|
||||
| > 源信息 | | kdk_rti_get_mem_virt_alloc_KiB() | 请的虚拟内存总 |
|
||||
+----------+------------+----------------------------------+----------------+
|
||||
|
||||
+---+---+------------+--------------------------+---+
|
||||
| | | | > 量 | |
|
||||
+===+===+============+==========================+===+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+---+---+------------+--------------------------+---+
|
||||
| | | > 无 | unsigned long 虚拟内存总 | |
|
||||
| | | | | |
|
||||
| | | | > 申请量，KiB 为单位 | |
|
||||
+---+---+------------+--------------------------+---+
|
||||
|
||||
```
|
||||
|
||||
获取系统中 Swap 分区总大小
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 资 | C | extern unsigned | 获 取 系 统 中 | |
|
||||
| | | long | | |
|
||||
| > 源信息 | | | Swap 分 区总 大 | |
|
||||
| | | kdk_rti_get_me | | |
|
||||
| | | m_swap_total_KiB() | > 小 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | unsigned long Swap | |
|
||||
| | | | 分 区 | |
|
||||
| | | | | |
|
||||
| | | | > 大小，KiB 为单位 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|-------------------------------------------------------|-------------------------------|
|
||||
| 获取资源信息 | C | extern unsigned long kdk_rti_get_mem_swap_total_KiB() | 获取系统中Swap分区总大小 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | unsigned long Swap分区大小，KiB为单位 |
|
||||
|
||||
|
||||
|
||||
获取 Swap 分区使用率
|
||||
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|---------------------------------------------------|-----------------|
|
||||
| 获取资源信息 | C | extern float kdk_rti_get_mem_swap_usage_percent() | 获取Swap分区使用率 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | float Swap分区使用率 |
|
||||
|
||||
```
|
||||
+----------+----------+---------------------+---------------------+---+
|
||||
| > 子模块 | 编程语言 | 声明 | > 描述 | |
|
||||
+==========+==========+=====================+=====================+===+
|
||||
| 获 取 资 | C | extern float | 获 取 Swap | |
|
||||
| | | | | |
|
||||
| > 源信息 | | kdk_rti_get_mem_s | 分区使用率 | |
|
||||
| | | wap_usage_percent() | | |
|
||||
+----------+----------+---------------------+---------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+----------+---------------------+---------------------+---+
|
||||
| | | > 无 | > float Swap | |
|
||||
| | | | > 分区使用率 | |
|
||||
+----------+----------+---------------------+---------------------+---+
|
||||
```
|
||||
|
||||
|
||||
获取 Swap 分区使用量
|
||||
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|-------------------------------------------------------|--------------------------------|
|
||||
| 获取资源信息 | C | extern unsigned long kdk_rti_get_mem_swap_usage_KiB() | 获取Swap分区使用量 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | unsigned long Swap分区使用量，KiB为单位 |
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 资 | C | extern unsigned | 获取 Swap 分区 | |
|
||||
| | | long | | |
|
||||
| > 源信息 | | | > 使用量 | |
|
||||
| | | kdk_rti_get_me | | |
|
||||
| | | m_swap_usage_KiB() | | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | unsigned long Swap | |
|
||||
| | | | 分 区 | |
|
||||
| | | | | |
|
||||
| | | | > 使用量，KiB | |
|
||||
| | | | > 为单位 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
|
||||
|
||||
获取 Swap 分区空闲大小
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 资 | C | extern unsigned | 获取 Swap 分区 | |
|
||||
| | | long | | |
|
||||
| > 源信息 | | | > 空闲大小 | |
|
||||
| | | kdk_rti_get_m | | |
|
||||
| | | em_swap_free_KiB() | | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | unsigned long Swap | |
|
||||
| | | | 分 区 | |
|
||||
| | | | | |
|
||||
| | | | > 空闲大小，KiB | |
|
||||
| | | | > 为单位 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|------------------------------------------------------|---------------------------------|
|
||||
| 获取资源信息 | C | extern unsigned long kdk_rti_get_mem_swap_free_KiB() | 获取Swap分区空闲大小 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | unsigned long Swap分区空闲大小，KiB为单位 |
|
||||
|
||||
|
||||
|
||||
获取 CPU 瞬时使用率
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 资 | C | extern float | 获 取 CPU 瞬 时 | |
|
||||
| | | kdk_rti_get_c | | |
|
||||
| > 源信息 | | pu_current_usage() | > 使用率 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 无 | float CPU | |
|
||||
| | | | 瞬时使用率， | |
|
||||
| | | | | |
|
||||
| | | | > 该值 \< 1.00 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------|------|----------------------------------------------|--------------------------|
|
||||
| 获取资源信息 | C | extern float kdk_rti_get_cpu_current_usage() | 获取CPU瞬时使用率 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | 无 | float CPU瞬时使用率，该值 < 1.00 |
|
||||
|
||||
```
|
||||
|
||||
获取操作系统开机时长
|
||||
|
||||
|
||||
```
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| > 子模块 | > 编程语言 | 声明 | > 描述 | |
|
||||
+==========+============+====================+====================+===+
|
||||
| 获 取 资 | C | extern int | 获 取 操 作 系 统 | |
|
||||
| | | kdk_rti_g | | |
|
||||
| > 源信息 | | et_uptime(unsigned | > 开机时长 | |
|
||||
| | | int | | |
|
||||
| | | | | |
|
||||
| | | \*day, unsigned | | |
|
||||
| | | int \*hour, | | |
|
||||
| | | unsigned int | | |
|
||||
| | | \*min, | | |
|
||||
| | | | | |
|
||||
| | | unsigned int | | |
|
||||
| | | \*sec) | | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > 参数说明 | > 返回值说明 | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
| | | > day：开机天数 | int 返 回 0 表 示 | |
|
||||
| | | > | 成 | |
|
||||
| | | > hour 小时数，该 | | |
|
||||
| | | > | 功，返回非零表示 | |
|
||||
| | | > 数值一定 \< 24 | | |
|
||||
| | | > | > 失败 | |
|
||||
| | | > min：分钟数，该 | | |
|
||||
| | | > | | |
|
||||
| | | > 数值一定 \< 60 | | |
|
||||
| | | > | | |
|
||||
| | | > sec ：秒数，该数 | | |
|
||||
| | | > | | |
|
||||
| | | > 值一定 \< 60 | | |
|
||||
+----------+------------+--------------------+--------------------+---+
|
||||
```
|
||||
| 子模块 | 编程语言 | 声明 | 描述 |
|
||||
|--------------------|----------------|------------------------------------------------------------------------------------------------------------|------------|
|
||||
| 获取资源信息 | C | extern int kdk_rti_get_uptime(unsigned int *day, unsigned int *hour, unsigned int *min, unsigned int *sec) | 获取操作系统开机时长 |
|
||||
| | | 参数说明 | 返回值说明 | |
|
||||
| | | day：开机天数<br> hour小时数，该数值一定 < 24<br> min：分钟数，该数值一定 < 60<br> sec：秒数，该数值一定 < 60<br> int 返回0表示成功，返回非零表示失败 |
|
||||
|
||||
|
||||
获取指定进程的 CPU 使用率
|
||||
|
|
|
|||
Loading…
Reference in New Issue