Re: [PATCH v2] docs/zh_CN: Add zh_CN/accounting/delay-accounting.rst

From: Alex Shi
Date: Wed Sep 22 2021 - 23:48:36 EST


On Fri, Sep 17, 2021 at 3:21 PM <cgel.zte@xxxxxxxxx> wrote:
>
> From: Yang Yang <yang.yang29@xxxxxxxxxx>
>
> Add translation zh_CN/accounting/delay-accounting.rst and links it
> to zh_CN/accounting/index.rst while clean its todo entry.
>
> Signed-off-by: Yang Yang <yang.yang29@xxxxxxxxxx>
> ---
> v2: delete useless blackline
> ---
> .../zh_CN/accounting/delay-accounting.rst | 113 ++++++++++++++++++
> .../translations/zh_CN/accounting/index.rst | 2 +-
> 2 files changed, 114 insertions(+), 1 deletion(-)
> create mode 100644 Documentation/translations/zh_CN/accounting/delay-accounting.rst
>
> diff --git a/Documentation/translations/zh_CN/accounting/delay-accounting.rst b/Documentation/translations/zh_CN/accounting/delay-accounting.rst
> new file mode 100644
> index 000000000000..760f96876ea2
> --- /dev/null
> +++ b/Documentation/translations/zh_CN/accounting/delay-accounting.rst
> @@ -0,0 +1,113 @@
> +.. include:: ../disclaimer-zh_CN.rst
> +
> +:Original: Documentation/accounting/delay-accounting.rst
> +:Translator: Yang Yang <yang.yang29@xxxxxxxxxx>
> +
> +.. _cn_delay-accounting.rst:
> +
> +========
> +延迟计数
> +========
> +
> +任务在等待某些内核资源可用时,会造成延迟。例如一个可运行的任务可能会等待
> +一个空闲CPU来运行。
> +
> +基于每任务的延迟计数功能度量由以下情况造成的任务延迟:
> +
> +a) 等待一个CPU(任务为可运行)
> +b) 完成由该任务发起的块I/O同步请求
> +c) 页面交换
> +d) 内存回收
> +
> +并将这些统计信息通过taskstats接口提供给用户空间。
> +
> +这些延迟信息为适当的调整任务CPU优先级、io优先级、rss限制提供反馈。重要任务
> +长期延迟,表示可能需要提高其相关优先级。
> +
> +通过使用taskstats接口,本功能还可提供一个线程组(对应传统Unix进程)所有任务
> +(或线程)的总延迟统计信息。此类汇总往往是需要的,由内核来完成更加高效。
> +
> +用户空间的实体,特别是资源管理程序,可将延迟统计信息汇总到任意组中。为实现
> +这一点,任务的延迟统计信息在其生命周期内和退出时皆可获取,从而确保可进行
> +连续、完整的监控

missed a period here.

Nice work for all other parts!

Reviewed-by: Alex Shi <alexs@xxxxxxxxxx>

> +
> +
> +接口
> +----
> +
> +延迟计数使用taskstats接口,该接口由本目录另一个单独的文档详细描述。Taskstats
> +向用户态返回一个通用数据结构,对应每pid或每tgid的统计信息。延迟计数功能填写
> +该数据结构的特定字段。见
> +
> + include/linux/taskstats.h
> +
> +其描述了延迟计数相关字段。系统通常以计数器形式返回 CPU、同步块 I/O、交换、内存
> +回收等的累积延迟。
> +
> +取任务某计数器两个连续读数的差值,将得到任务在该时间间隔内等待对应资源的总延迟。
> +
> +当任务退出时,内核会将包含每任务的统计信息发送给用户空间,而无需额外的命令。
> +若其为线程组最后一个退出的任务,内核还会发送每tgid的统计信息。更多详细信息见
> +taskstats接口的描述。
> +
> +tools/accounting目录中的用户空间程序getdelays.c提供了一些简单的命令,用以显示
> +延迟统计信息。其也是使用taskstats接口的示例。
> +
> +用法
> +----
> +
> +使用以下配置编译内核::
> +
> + CONFIG_TASK_DELAY_ACCT=y
> + CONFIG_TASKSTATS=y
> +
> +延迟计数在启动时默认关闭。
> +若需开启,在启动参数中增加::
> +
> + delayacct
> +
> +本文后续的说明基于延迟计数已开启。也可在系统运行时,使用sysctl的kernel.task_delayacct
> +进行开关。注意,只有在启用延迟计数后启动的任务才会有相关信息。
> +
> +系统启动后,使用类似getdelays.c的工具获取任务或线程组(tgid)的延迟信息。
> +
> +getdelays命令的一般格式::
> +
> + getdelays [-t tgid] [-p pid] [-c cmd...]
> +
> +获取pid为10的任务从系统启动后的延迟信息::
> +
> + # ./getdelays -p 10
> + (输出信息和下例相似)
> +
> +获取所有tgid为5的任务从系统启动后的总延迟信息::
> +
> + # ./getdelays -t 5
> +
> +
> + CPU count real total virtual total delay total
> + 7876 92005750 100000000 24001500
> + IO count delay total
> + 0 0
> + SWAP count delay total
> + 0 0
> + RECLAIM count delay total
> + 0 0
> +
> +获取指定简单命令运行时的延迟信息::
> +
> + # ./getdelays -c ls /
> +
> + bin data1 data3 data5 dev home media opt root srv sys usr
> + boot data2 data4 data6 etc lib mnt proc sbin subdomain tmp var
> +
> +
> + CPU count real total virtual total delay total
> + 6 4000250 4000000 0
> + IO count delay total
> + 0 0
> + SWAP count delay total
> + 0 0
> + RECLAIM count delay total
> + 0 0
> +
> diff --git a/Documentation/translations/zh_CN/accounting/index.rst b/Documentation/translations/zh_CN/accounting/index.rst
> index 362e907b41f9..090f93776faa 100644
> --- a/Documentation/translations/zh_CN/accounting/index.rst
> +++ b/Documentation/translations/zh_CN/accounting/index.rst
> @@ -16,10 +16,10 @@
> :maxdepth: 1
>
> psi
> + delay-accounting
>
> Todolist:
>
> cgroupstats
> - delay-accounting
> taskstats
> taskstats-struct
> --
> 2.25.1
>