All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCHv4] docs/zh_CN: Add zh_CN/accounting/psi.rst
@ 2021-07-26 13:58 cgel.zte
  2021-07-29 13:17 ` Alex Shi
  2021-07-30 19:19 ` Jonathan Corbet
  0 siblings, 2 replies; 3+ messages in thread
From: cgel.zte @ 2021-07-26 13:58 UTC (permalink / raw)
  To: siyanteng, sterlingteng
  Cc: alexs, corbet, yang.yang29, linux-doc, linux-kernel

From: Yang Yang <yang.yang29@zte.com.cn>

Add translation zh_CN/accounting/psi.rst and zh_CN/accounting/index.rst.

Signed-off-by: Yang Yang <yang.yang29@zte.com.cn>
Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
---
v4: delete wrong Reviewed-by
v3: add reviewers
v2: correct wrong format and add translations for code annotations
---
 .../translations/zh_CN/accounting/index.rst   |  25 +++
 .../translations/zh_CN/accounting/psi.rst     | 155 ++++++++++++++++++
 2 files changed, 180 insertions(+)
 create mode 100644 Documentation/translations/zh_CN/accounting/index.rst
 create mode 100644 Documentation/translations/zh_CN/accounting/psi.rst

diff --git a/Documentation/translations/zh_CN/accounting/index.rst b/Documentation/translations/zh_CN/accounting/index.rst
new file mode 100644
index 000000000000..362e907b41f9
--- /dev/null
+++ b/Documentation/translations/zh_CN/accounting/index.rst
@@ -0,0 +1,25 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+.. include:: ../disclaimer-zh_CN.rst
+
+:Original: Documentation/accounting/index.rst
+:Translator: Yang Yang <yang.yang29@zte.com.cn>
+
+.. _cn_accounting_index.rst:
+
+
+====
+计数
+====
+
+.. toctree::
+   :maxdepth: 1
+
+   psi
+
+Todolist:
+
+   cgroupstats
+   delay-accounting
+   taskstats
+   taskstats-struct
diff --git a/Documentation/translations/zh_CN/accounting/psi.rst b/Documentation/translations/zh_CN/accounting/psi.rst
new file mode 100644
index 000000000000..a0ddb7bd257c
--- /dev/null
+++ b/Documentation/translations/zh_CN/accounting/psi.rst
@@ -0,0 +1,155 @@
+.. include:: ../disclaimer-zh_CN.rst
+
+:Original: Documentation/accounting/psi.rst
+:Translator: Yang Yang <yang.yang29@zte.com.cn>
+
+.. _cn_psi.rst:
+
+
+=================
+PSI——压力阻塞信息
+=================
+
+:日期: April, 2018
+:作者: Johannes Weiner <hannes@cmpxchg.org>
+
+当CPU、memory或IO设备处于竞争状态,业务负载会遭受时延毛刺、吞吐量降低,
+及面临OOM的风险。
+
+如果没有一种准确的方法度量系统竞争程度,则有两种后果:一种是用户过于节制,
+未充分利用系统资源;另一种是过度使用,经常性面临业务中断的风险。
+
+psi特性能够识别和量化资源竞争导致的业务中断,及其对复杂负载乃至整个系统在
+时间上的影响。
+
+准确度量因资源不足造成的生产力损失,有助于用户基于硬件调整业务负载,或基
+于业务负载配置硬件。
+
+psi能够实时的提供相关信息,因此系统可基于psi实现动态的负载管理。如实施
+卸载、迁移、策略性的停止或杀死低优先级或可重启的批处理任务。
+
+psi帮助用户实现硬件资源利用率的最大化。同时无需牺牲业务负载健康度,也无需
+面临OOM等造成业务中断的风险。
+
+压力接口
+========
+
+压力信息可通过/proc/pressure/ --cpu、memory、io文件分别获取。
+
+CPU相关信息格式如下:
+
+        some avg10=0.00 avg60=0.00 avg300=0.00 total=0
+
+内存和IO相关信息如下:
+
+        some avg10=0.00 avg60=0.00 avg300=0.00 total=0
+        full avg10=0.00 avg60=0.00 avg300=0.00 total=0
+
+some行代表至少有一个任务阻塞于特定资源的时间占比。
+
+full行代表所有非idle任务同时阻塞于特定资源的时间占比。在这种状态下CPU资源
+完全被浪费,相对于正常运行,业务负载由于耗费更多时间等待而受到严重影响。
+
+由于此情况严重影响系统性能,因此清楚的识别本情况并与some行所代表的情况区分开,
+将有助于分析及提升系统性能。这就是full独立于some行的原因。
+
+avg代表阻塞时间占比(百分比),为最近10秒、60秒、300秒内的均值。这样我们
+既可观察到短期事件的影响,也可看到中等及长时间内的趋势。total代表总阻塞
+时间(单位微秒),可用于观察时延毛刺,这种毛刺可能在均值中无法体现。
+
+监控压力门限
+============
+
+用户可注册触发器,通过poll()监控资源压力是否超过门限。
+
+触发器定义:指定时间窗口期内累积阻塞时间的最大值。比如可定义500ms内积累
+100ms阻塞,即触发一次唤醒事件。
+
+触发器注册方法:用户打开代表特定资源的psi接口文件,写入门限、时间窗口的值。
+所打开的文件描述符用于等待事件,可使用select()、poll()、epoll()。
+写入信息的格式如下:
+
+        <some|full> <stall amount in us> <time window in us>
+
+示例:向/proc/pressure/memory写入"some 150000 1000000"将新增触发器,将在
+1秒内至少一个任务阻塞于内存的总时间超过150ms时触发。向/proc/pressure/io写入
+"full 50000 1000000"将新增触发器,将在1秒内所有任务都阻塞于io的总时间超过50ms时触发。
+
+触发器可针对多个psi度量值设置,同一个psi度量值可设置多个触发器。每个触发器需要
+单独的文件描述符用于轮询,以区分于其他触发器。所以即使对于同一个psi接口文件,
+每个触发器也需要单独的调用open()。
+
+监控器在被监控资源进入阻塞状态时启动,在系统退出阻塞状态后停用。系统进入阻塞
+状态后,监控psi增长的频率为每监控窗口刷新10次。
+
+内核接受的窗口为500ms~10s,所以监控间隔为50ms~1s。设置窗口下限目的是为了
+防止过于频繁的轮询。设置窗口上限的目的是因为窗口过长则无意义,此时查看
+psi接口提供的均值即可。
+
+监控器在激活后,至少在跟踪窗口期间将保持活动状态。以避免随着系统进入和退出
+阻塞状态,监控器过于频繁的进入和退出活动状态。
+
+用户态通知在监控窗口内会受到速率限制。当对应的文件描述符关闭,触发器会自动注销。
+
+用户态监控器使用示例
+====================
+
+::
+
+  #include <errno.h>
+  #include <fcntl.h>
+  #include <stdio.h>
+  #include <poll.h>
+  #include <string.h>
+  #include <unistd.h>
+
+  /* 监控内存部分阻塞,监控时间窗口为1秒、阻塞门限为150毫秒。*/
+  int main() {
+        const char trig[] = "some 150000 1000000";
+        struct pollfd fds;
+        int n;
+
+        fds.fd = open("/proc/pressure/memory", O_RDWR | O_NONBLOCK);
+        if (fds.fd < 0) {
+                printf("/proc/pressure/memory open error: %s\n",
+                        strerror(errno));
+                return 1;
+        }
+        fds.events = POLLPRI;
+
+        if (write(fds.fd, trig, strlen(trig) + 1) < 0) {
+                printf("/proc/pressure/memory write error: %s\n",
+                        strerror(errno));
+                return 1;
+        }
+
+        printf("waiting for events...\n");
+        while (1) {
+                n = poll(&fds, 1, -1);
+                if (n < 0) {
+                        printf("poll error: %s\n", strerror(errno));
+                        return 1;
+                }
+                if (fds.revents & POLLERR) {
+                        printf("got POLLERR, event source is gone\n");
+                        return 0;
+                }
+                if (fds.revents & POLLPRI) {
+                        printf("event triggered!\n");
+                } else {
+                        printf("unknown event received: 0x%x\n", fds.revents);
+                        return 1;
+                }
+        }
+
+        return 0;
+  }
+
+Cgroup2接口
+===========
+
+对于CONFIG_CGROUP=y及挂载了cgroup2文件系统的系统,能够获取cgroups内任务的psi。
+此场景下cgroupfs挂载点的子目录包含cpu.pressure、memory.pressure、io.pressure文件,
+内容格式与/proc/pressure/下的文件相同。
+
+可设置基于cgroup的psi监控器,方法与系统级psi监控器相同。
-- 
2.25.1


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCHv4] docs/zh_CN: Add zh_CN/accounting/psi.rst
  2021-07-26 13:58 [PATCHv4] docs/zh_CN: Add zh_CN/accounting/psi.rst cgel.zte
@ 2021-07-29 13:17 ` Alex Shi
  2021-07-30 19:19 ` Jonathan Corbet
  1 sibling, 0 replies; 3+ messages in thread
From: Alex Shi @ 2021-07-29 13:17 UTC (permalink / raw)
  To: cgel.zte
  Cc: Yanteng Si, YanTeng Si, Alex Shi, Jonathan Corbet, yang.yang29,
	linux-doc, linux-kernel

On Mon, Jul 26, 2021 at 9:58 PM <cgel.zte@gmail.com> wrote:
>
> From: Yang Yang <yang.yang29@zte.com.cn>
>
> Add translation zh_CN/accounting/psi.rst and zh_CN/accounting/index.rst.
>
> Signed-off-by: Yang Yang <yang.yang29@zte.com.cn>
> Reviewed-by: Yanteng Si <siyanteng@loongson.cn>

Nice job for both of you!

Reviewed-by: Alex Shi <alexs@kernel.org>

BTW, we don't have to resend a new version for only 'Reviewed-by:'
picking. Maintainer will do it often.

Thanks
Alex

> ---
> v4: delete wrong Reviewed-by
> v3: add reviewers
> v2: correct wrong format and add translations for code annotations
> ---
>  .../translations/zh_CN/accounting/index.rst   |  25 +++
>  .../translations/zh_CN/accounting/psi.rst     | 155 ++++++++++++++++++
>  2 files changed, 180 insertions(+)
>  create mode 100644 Documentation/translations/zh_CN/accounting/index.rst
>  create mode 100644 Documentation/translations/zh_CN/accounting/psi.rst
>
> diff --git a/Documentation/translations/zh_CN/accounting/index.rst b/Documentation/translations/zh_CN/accounting/index.rst
> new file mode 100644
> index 000000000000..362e907b41f9
> --- /dev/null
> +++ b/Documentation/translations/zh_CN/accounting/index.rst
> @@ -0,0 +1,25 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +.. include:: ../disclaimer-zh_CN.rst
> +
> +:Original: Documentation/accounting/index.rst
> +:Translator: Yang Yang <yang.yang29@zte.com.cn>
> +
> +.. _cn_accounting_index.rst:
> +
> +
> +====
> +计数
> +====
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +   psi
> +
> +Todolist:
> +
> +   cgroupstats
> +   delay-accounting
> +   taskstats
> +   taskstats-struct
> diff --git a/Documentation/translations/zh_CN/accounting/psi.rst b/Documentation/translations/zh_CN/accounting/psi.rst
> new file mode 100644
> index 000000000000..a0ddb7bd257c
> --- /dev/null
> +++ b/Documentation/translations/zh_CN/accounting/psi.rst
> @@ -0,0 +1,155 @@
> +.. include:: ../disclaimer-zh_CN.rst
> +
> +:Original: Documentation/accounting/psi.rst
> +:Translator: Yang Yang <yang.yang29@zte.com.cn>
> +
> +.. _cn_psi.rst:
> +
> +
> +=================
> +PSI——压力阻塞信息
> +=================
> +
> +:日期: April, 2018
> +:作者: Johannes Weiner <hannes@cmpxchg.org>
> +
> +当CPU、memory或IO设备处于竞争状态,业务负载会遭受时延毛刺、吞吐量降低,
> +及面临OOM的风险。
> +
> +如果没有一种准确的方法度量系统竞争程度,则有两种后果:一种是用户过于节制,
> +未充分利用系统资源;另一种是过度使用,经常性面临业务中断的风险。
> +
> +psi特性能够识别和量化资源竞争导致的业务中断,及其对复杂负载乃至整个系统在
> +时间上的影响。
> +
> +准确度量因资源不足造成的生产力损失,有助于用户基于硬件调整业务负载,或基
> +于业务负载配置硬件。
> +
> +psi能够实时的提供相关信息,因此系统可基于psi实现动态的负载管理。如实施
> +卸载、迁移、策略性的停止或杀死低优先级或可重启的批处理任务。
> +
> +psi帮助用户实现硬件资源利用率的最大化。同时无需牺牲业务负载健康度,也无需
> +面临OOM等造成业务中断的风险。
> +
> +压力接口
> +========
> +
> +压力信息可通过/proc/pressure/ --cpu、memory、io文件分别获取。
> +
> +CPU相关信息格式如下:
> +
> +        some avg10=0.00 avg60=0.00 avg300=0.00 total=0
> +
> +内存和IO相关信息如下:
> +
> +        some avg10=0.00 avg60=0.00 avg300=0.00 total=0
> +        full avg10=0.00 avg60=0.00 avg300=0.00 total=0
> +
> +some行代表至少有一个任务阻塞于特定资源的时间占比。
> +
> +full行代表所有非idle任务同时阻塞于特定资源的时间占比。在这种状态下CPU资源
> +完全被浪费,相对于正常运行,业务负载由于耗费更多时间等待而受到严重影响。
> +
> +由于此情况严重影响系统性能,因此清楚的识别本情况并与some行所代表的情况区分开,
> +将有助于分析及提升系统性能。这就是full独立于some行的原因。
> +
> +avg代表阻塞时间占比(百分比),为最近10秒、60秒、300秒内的均值。这样我们
> +既可观察到短期事件的影响,也可看到中等及长时间内的趋势。total代表总阻塞
> +时间(单位微秒),可用于观察时延毛刺,这种毛刺可能在均值中无法体现。
> +
> +监控压力门限
> +============
> +
> +用户可注册触发器,通过poll()监控资源压力是否超过门限。
> +
> +触发器定义:指定时间窗口期内累积阻塞时间的最大值。比如可定义500ms内积累
> +100ms阻塞,即触发一次唤醒事件。
> +
> +触发器注册方法:用户打开代表特定资源的psi接口文件,写入门限、时间窗口的值。
> +所打开的文件描述符用于等待事件,可使用select()、poll()、epoll()。
> +写入信息的格式如下:
> +
> +        <some|full> <stall amount in us> <time window in us>
> +
> +示例:向/proc/pressure/memory写入"some 150000 1000000"将新增触发器,将在
> +1秒内至少一个任务阻塞于内存的总时间超过150ms时触发。向/proc/pressure/io写入
> +"full 50000 1000000"将新增触发器,将在1秒内所有任务都阻塞于io的总时间超过50ms时触发。
> +
> +触发器可针对多个psi度量值设置,同一个psi度量值可设置多个触发器。每个触发器需要
> +单独的文件描述符用于轮询,以区分于其他触发器。所以即使对于同一个psi接口文件,
> +每个触发器也需要单独的调用open()。
> +
> +监控器在被监控资源进入阻塞状态时启动,在系统退出阻塞状态后停用。系统进入阻塞
> +状态后,监控psi增长的频率为每监控窗口刷新10次。
> +
> +内核接受的窗口为500ms~10s,所以监控间隔为50ms~1s。设置窗口下限目的是为了
> +防止过于频繁的轮询。设置窗口上限的目的是因为窗口过长则无意义,此时查看
> +psi接口提供的均值即可。
> +
> +监控器在激活后,至少在跟踪窗口期间将保持活动状态。以避免随着系统进入和退出
> +阻塞状态,监控器过于频繁的进入和退出活动状态。
> +
> +用户态通知在监控窗口内会受到速率限制。当对应的文件描述符关闭,触发器会自动注销。
> +
> +用户态监控器使用示例
> +====================
> +
> +::
> +
> +  #include <errno.h>
> +  #include <fcntl.h>
> +  #include <stdio.h>
> +  #include <poll.h>
> +  #include <string.h>
> +  #include <unistd.h>
> +
> +  /* 监控内存部分阻塞,监控时间窗口为1秒、阻塞门限为150毫秒。*/
> +  int main() {
> +        const char trig[] = "some 150000 1000000";
> +        struct pollfd fds;
> +        int n;
> +
> +        fds.fd = open("/proc/pressure/memory", O_RDWR | O_NONBLOCK);
> +        if (fds.fd < 0) {
> +                printf("/proc/pressure/memory open error: %s\n",
> +                        strerror(errno));
> +                return 1;
> +        }
> +        fds.events = POLLPRI;
> +
> +        if (write(fds.fd, trig, strlen(trig) + 1) < 0) {
> +                printf("/proc/pressure/memory write error: %s\n",
> +                        strerror(errno));
> +                return 1;
> +        }
> +
> +        printf("waiting for events...\n");
> +        while (1) {
> +                n = poll(&fds, 1, -1);
> +                if (n < 0) {
> +                        printf("poll error: %s\n", strerror(errno));
> +                        return 1;
> +                }
> +                if (fds.revents & POLLERR) {
> +                        printf("got POLLERR, event source is gone\n");
> +                        return 0;
> +                }
> +                if (fds.revents & POLLPRI) {
> +                        printf("event triggered!\n");
> +                } else {
> +                        printf("unknown event received: 0x%x\n", fds.revents);
> +                        return 1;
> +                }
> +        }
> +
> +        return 0;
> +  }
> +
> +Cgroup2接口
> +===========
> +
> +对于CONFIG_CGROUP=y及挂载了cgroup2文件系统的系统,能够获取cgroups内任务的psi。
> +此场景下cgroupfs挂载点的子目录包含cpu.pressure、memory.pressure、io.pressure文件,
> +内容格式与/proc/pressure/下的文件相同。
> +
> +可设置基于cgroup的psi监控器,方法与系统级psi监控器相同。
> --
> 2.25.1
>

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCHv4] docs/zh_CN: Add zh_CN/accounting/psi.rst
  2021-07-26 13:58 [PATCHv4] docs/zh_CN: Add zh_CN/accounting/psi.rst cgel.zte
  2021-07-29 13:17 ` Alex Shi
@ 2021-07-30 19:19 ` Jonathan Corbet
  1 sibling, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2021-07-30 19:19 UTC (permalink / raw)
  To: cgel.zte, siyanteng, sterlingteng
  Cc: alexs, yang.yang29, linux-doc, linux-kernel

cgel.zte@gmail.com writes:

> From: Yang Yang <yang.yang29@zte.com.cn>
>
> Add translation zh_CN/accounting/psi.rst and zh_CN/accounting/index.rst.
>
> Signed-off-by: Yang Yang <yang.yang29@zte.com.cn>
> Reviewed-by: Yanteng Si <siyanteng@loongson.cn>
> ---
> v4: delete wrong Reviewed-by
> v3: add reviewers
> v2: correct wrong format and add translations for code annotations
> ---
>  .../translations/zh_CN/accounting/index.rst   |  25 +++
>  .../translations/zh_CN/accounting/psi.rst     | 155 ++++++++++++++++++
>  2 files changed, 180 insertions(+)
>  create mode 100644 Documentation/translations/zh_CN/accounting/index.rst
>  create mode 100644 Documentation/translations/zh_CN/accounting/psi.rst

Almost there ... but you need to link .../accounting/index.rst into the
top-level Chinese index.rst for these new files to be part of the docs
build.  Please be sure you can actually build the docs and view the
result.

Thanks,

jon

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-07-30 19:19 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-07-26 13:58 [PATCHv4] docs/zh_CN: Add zh_CN/accounting/psi.rst cgel.zte
2021-07-29 13:17 ` Alex Shi
2021-07-30 19:19 ` Jonathan Corbet

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.