add file

API.md

@@ -0,0 +1,83 @@
+# API
+
+`int cpu_usage_init(void)`
+
+初始化 CPU 使用率统计功能。必须初始化之后才能获取正确的使用率
+
+| 参数 | 描述 |
+| ---- | ----|
+| 无 | |
+| **返回** | **描述** | 
+| 0 | 总是返回 0 |
+
+`void cpu_usage_deinit(void)`
+
+反初始化 CPU 使用率统计功能。当统计功能不需要时，调用此函数释放系统资源
+
+| 参数 | 描述 |
+| ---- | ----|
+| 无 | |
+| **返回** | **描述** | 
+| 无 | 无 |
+
+`cpu_usage_t *cpu_usage_obj(void)`
+
+获取统计对象，可以从统计对象中获得更详细的数据
+
+| 参数 | 描述 |
+| ---- | ----|
+| 无 | |
+| **返回** | **描述** | 
+| cpu_usage_t | CPU 统计对象 |
+
+统计对象成员介绍
+
+| 成员 | 描述 |
+| ---- | ----|
+| time | 与系统心跳同频定时器 |
+| state | 运行状态 |
+| cpus | CPU 数量 |
+| suspend_tick | 上次挂起时的 tick 值 |
+| period | 统计周期 |
+| idle_stat.idle_tick | idle 运行总时长（tick） |
+| idle_stat.last_tick | 上个周期开始时间戳（tick）|
+| idle_stat.load      | 上个周期其他线程执行时长（tick）|
+| idle_stat.tid       | idle 线程对象 |
+
+统计状态介绍
+
+| 状态 | 描述 |
+| ---- | ----|
+| CPU_USAGE_STATE_DEACTIVATED | 未初始化，停止状态 |
+| CPU_USAGE_STATE_ACTIVATED | 正在运行 |
+| CPU_USAGE_STATE_SUSPEND | 被挂起，等待恢复 |
+
+`void cpu_usage_suspend(void)`
+
+挂起 CPU 使用率统计功能。系统低功耗期间使用。
+
+| 参数 | 描述 |
+| ---- | ----|
+| 无 | |
+| **返回** | **描述** | 
+| 无 | 无 |
+
+`void cpu_usage_resume(void)`
+
+恢复 CPU 使用率统计功能。低功耗恢复时使用。
+
+| 参数 | 描述 |
+| ---- | ----|
+| 无 | |
+| **返回** | **描述** | 
+| 无 | 无 |
+
+`float cpu_load_average(void)`
+
+获取 CPU 平均使用率
+
+| 参数 | 描述 |
+| ---- | ----|
+| 无 | |
+| **返回** | **描述** | 
+| float | CPU 平均使用率 |

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,53 @@
+# CPU 使用率统计
+
+统计单核 CPU 使用率。目前不支持多核
+
+## 基本原理
+
+每个时间片侦测一次当前线程，如果当前正在运行 idle 线程，空闲计数器自增。一个周期后，计算 IDEL 线程运行时间的占比。
+
+例如：
+
+![线程运行时间片](./figures/thread.png)
+
+上图展示一个周期内，某个 CPU 上线程时间片信息。假设一个方格代表一个时间片。
+
+- 一个周期总时间片数 `30 tick`
+- idle 总共运行 `13 tick`
+
+CPU 使用率 = 13 / 30 * 100
+
+## 使用方法
+
+### 代码调用
+
+```c
+float load;
+cpu_usage_init();
+load = cpu_load_average();
+printf("cpu load average: %f\n", load);
+```
+
+### 命令行
+
+msh 命令行输入 `usage` 打印出 CPU 使用率
+
+```sh
+msh />usage
+cpu: 31
+```
+
+msh 命令行输入 `usage -l 50`，调整 CPU 使用率，使其不低于 50%
+
+```sh
+msh />usage -l 50
+CPU usage adjusted to 50%
+msh />usage
+cpu: 51
+```
+
+> 若系统没有使用自动初始化功能，在输出命令之前，主动调用 `cpu_usage_init` 进行初始化。
+
+## API 介绍
+
+[API 介绍](./API.md)

SConscript

@@ -0,0 +1,13 @@
+Import('RTT_ROOT')
+Import('rtconfig')
+from building import *
+
+objs = []
+cwd     = GetCurrentDir()
+list = os.listdir(cwd)
+src     = Glob('*.c') + Glob('*.cpp')
+CPPPATH = [cwd, str(Dir('#'))]
+
+group = DefineGroup('cpu_usage', src, depend = ['PKG_USING_CPU_USAGE'], CPPPATH = CPPPATH)
+
+Return('group')

cpu_usage.c

@@ -0,0 +1,135 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2020-12-04     tyx          first implementation
+ */
+
+#include "cpu_usage.h"
+
+#ifndef CPU_USAGE_PERIOD_TICK
+#define CPU_USAGE_PERIOD_TICK RT_TICK_PER_SECOND
+#endif
+
+cpu_usage_t *cpu_usage_obj(void)
+{
+    static struct cpu_usage _usage;
+    return &_usage;
+}
+
+static void timeout(void *param)
+{
+    cpu_usage_t *obj = param;
+
+    if (obj->state == CPU_USAGE_STATE_ACTIVATED)
+    {
+        if (++obj->period == CPU_USAGE_PERIOD_TICK)
+        {
+            obj->period = 0;
+            obj->idle_stat[0].load = CPU_USAGE_PERIOD_TICK - 
+                (obj->idle_stat[0].idle_tick - obj->idle_stat[0].last_tick);
+            obj->idle_stat[0].last_tick = obj->idle_stat[0].idle_tick;
+        }
+
+        if (rt_thread_self() == obj->idle_stat[0].tid)
+        {
+            obj->idle_stat[0].idle_tick++;
+        }
+    }
+}
+
+int cpu_usage_init(void)
+{
+    cpu_usage_t *obj = cpu_usage_obj();
+    rt_timer_t t = &obj->time;
+    char idle_name[RT_NAME_MAX];
+    int i;
+
+    if (rt_object_get_type(&t->parent) != RT_Object_Class_Timer)
+    {
+        /* init time */
+        rt_timer_init(t, "usage", timeout, obj, 1,
+            RT_TIMER_FLAG_PERIODIC | RT_TIMER_FLAG_HARD_TIMER);
+        /* set cpus */
+        obj->cpus = sizeof(obj->idle_stat) / sizeof(obj->idle_stat[0]);
+        /* get idle thread handle */
+        for (i = 0; i < obj->cpus; i++)
+        {
+            rt_snprintf(idle_name, sizeof(idle_name), "tidle%d", i);
+            obj->idle_stat[i].tid = rt_thread_find(idle_name);
+        }
+        /* set flags */
+        obj->state = CPU_USAGE_STATE_ACTIVATED;
+        /* start */
+        rt_timer_start(t);
+    }
+    return 0;
+}
+
+void cpu_usage_deinit(void)
+{
+    cpu_usage_t *obj = cpu_usage_obj();
+    rt_timer_t t = &obj->time;
+
+    if (rt_object_get_type(&t->parent) == RT_Object_Class_Timer)
+    {
+        rt_timer_stop(t);
+        rt_timer_detach(t);
+        rt_memset(obj, 0, sizeof(*obj));
+    }
+}
+
+void cpu_usage_suspend(void)
+{
+    cpu_usage_t *obj = cpu_usage_obj();
+    rt_timer_t t = &obj->time;
+
+    if (obj->state == CPU_USAGE_STATE_ACTIVATED)
+    {
+        rt_timer_stop(t);
+        obj->state = CPU_USAGE_STATE_SUSPEND;
+        obj->suspend_tick = rt_tick_get();
+    }
+}
+
+void cpu_usage_resume(void)
+{
+    cpu_usage_t *obj = cpu_usage_obj();
+    rt_timer_t t = &obj->time;
+    rt_tick_t tick;
+    int i;
+
+    if (obj->state == CPU_USAGE_STATE_SUSPEND)
+    {
+        tick = rt_tick_get() - obj->suspend_tick;
+        for (i = 0; i < obj->cpus; i++)
+        {
+            obj->idle_stat[i].idle_tick += tick;
+        }
+        obj->state = CPU_USAGE_STATE_ACTIVATED;
+        rt_timer_start(t);
+    }
+}
+
+float cpu_load_average(void)
+{
+    cpu_usage_t *obj = cpu_usage_obj();
+    rt_tick_t usage = 0;
+    float load = 0.0;
+    int i;
+
+    if (obj->state == CPU_USAGE_STATE_ACTIVATED)
+    {
+        for (i = 0; i < obj->cpus; i++)
+        {
+            usage += obj->idle_stat[i].load;
+        }
+        load = 100.0 * usage / (CPU_USAGE_PERIOD_TICK * obj->cpus);
+    }
+    return load;
+}
+
+#ifdef RT_USING_COMPONENTS_INIT
+INIT_APP_EXPORT(cpu_usage_init);
+#endif

cpu_usage.h

@@ -0,0 +1,52 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2020-12-04     tyx          first implementation
+ */
+
+#ifndef __CPU_USAGE_H__
+#define __CPU_USAGE_H__
+
+#include "rtthread.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define CPU_USAGE_STATE_DEACTIVATED  (0x0)
+#define CPU_USAGE_STATE_ACTIVATED    (0x1)
+#define CPU_USAGE_STATE_SUSPEND      (0x2)
+
+struct cpu_usage
+{
+    struct rt_timer time;           /* Period timer */
+    rt_uint8_t state;               /* Running state */
+    rt_uint8_t cpus;                /* Number of CPUs */
+    rt_uint16_t reserved;
+    rt_tick_t suspend_tick;         /* CPU suspend timestamp */
+    rt_tick_t period;               /* Stat Period */
+    struct _idle_stat
+    {
+        rt_tick_t idle_tick;
+        rt_tick_t last_tick;
+        rt_tick_t load;
+        rt_thread_t tid;
+    }
+    idle_stat[1];
+};
+typedef struct cpu_usage cpu_usage_t;
+
+int cpu_usage_init(void);
+void cpu_usage_deinit(void);
+cpu_usage_t *cpu_usage_obj(void);
+void cpu_usage_suspend(void);
+void cpu_usage_resume(void);
+float cpu_load_average(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

cpu_usage_cmd.c

@@ -0,0 +1,53 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Change Logs:
+ * Date           Author       Notes
+ * 2020-12-04     tyx          first implementation
+ */
+#include <stdlib.h>
+#include "cpu_usage.h"
+
+static volatile rt_thread_t tid;
+
+static void load_thread(void *param)
+{
+    while (tid != RT_NULL && (int)tid->user_data)
+    {
+        while ((int)tid->user_data >= rt_tick_get() % 100);
+        rt_thread_delay(1);
+    }
+    tid = RT_NULL;
+}
+
+void cpu_usage_msh(int argc, char *argv[])
+{
+    if (argc == 3 && rt_strcmp(argv[1], "-l") == 0)
+    {
+        if (tid)
+        {
+            tid->user_data = strtoul(argv[2], RT_NULL, 10);
+        }
+        else
+        {
+            tid = rt_thread_create("usage", load_thread, RT_NULL, 256,
+                RT_THREAD_PRIORITY_MAX - 2, 20);
+            if (tid == RT_NULL)
+            {
+                rt_kprintf("create thread failed.");
+            }
+            tid->user_data = strtoul(argv[2], RT_NULL, 10);
+            rt_thread_startup(tid);
+        }
+        rt_kprintf("CPU usage adjusted to %d%c\n", tid->user_data, '%');
+    }
+    else if (argc == 1)
+    {
+        rt_kprintf("cpu: %d\n", (int)cpu_load_average());
+    }
+    else
+    {
+        rt_kprintf("%s\n", argv[0]);
+    }
+}
+FINSH_FUNCTION_EXPORT_ALIAS(cpu_usage_msh, __cmd_usage, cpu usage);