Skip to content

Commit 5a6c7bc

Browse files
omkar3141rghaddab
omkar3141
authored and
rghaddab
committed
[nrf fromtree] tests: settings: Performance test for settings
This adds a on target performance test for Settings SS. Using this test performance of the Setting SS + NVS/ZMS backend can be benchmarked. The test repeatedly write 128 settings entries. Each setting entry has a size of 4 bytes, and path length of 16 bytes (excluding the null-terminator). The test has two variants, with and without Bluetooth scan running. This is useful to benchmark performance along with some component of BT subsystem activated. The test could be enhanced in future to include or create combinations of different functionalities running, when agreesive store operations are happening. Signed-off-by: Omkar Kulkarni <[email protected]> (cherry picked from commit c795596604ea06f3d463bf36c4c1106b83165e72)
1 parent 36a0d48 commit 5a6c7bc

File tree

4 files changed

+219
-0
lines changed

4 files changed

+219
-0
lines changed

‎tests/subsys/settings/performance/CMakeLists.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# SPDX-License-Identifier: Apache-2.0
2+
3+
cmake_minimum_required(VERSION 3.20.0)
4+
find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
5+
project(test_settings_perf)
6+
7+
zephyr_include_directories(
8+
${ZEPHYR_BASE}/subsys/settings/include
9+
${ZEPHYR_BASE}/subsys/settings/src
10+
)
11+
12+
target_sources(app PRIVATE
13+
settings_test_perf.c)

‎tests/subsys/settings/performance/prj.conf‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
CONFIG_ZTEST=y
2+
CONFIG_FLASH=y
3+
CONFIG_FLASH_MAP=y
4+
CONFIG_ZMS=y
5+
6+
CONFIG_SETTINGS=y
7+
CONFIG_SETTINGS_RUNTIME=y

‎tests/subsys/settings/performance/settings_test_perf.c‎

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
/*
2+
* Copyright (c) 2024 Nordic Semiconductor ASA
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
#include <stdlib.h>
7+
8+
#include "settings_priv.h"
9+
#include <zephyr/ztest.h>
10+
#include <zephyr/settings/settings.h>
11+
#include <zephyr/bluetooth/bluetooth.h>
12+
13+
/* This is a test suite for performance testing of settings subsystem by writing
14+
* many small setting values repeatedly. Ideally, this should consume as small
15+
* amount of time as possible for best possible UX.
16+
*/
17+
18+
static struct k_work_q settings_work_q;
19+
static K_THREAD_STACK_DEFINE(settings_work_stack, 2024);
20+
static struct k_work_delayable pending_store;
21+
22+
#define TEST_SETTINGS_COUNT (128)
23+
#define TEST_STORE_ITR (5)
24+
#define TEST_TIMEOUT_SEC (60)
25+
#define TEST_SETTINGS_WORKQ_PRIO (1)
26+
27+
static void bt_scan_cb(const bt_addr_le_t *addr, int8_t rssi, uint8_t adv_type,
28+
struct net_buf_simple *buf)
29+
{
30+
printk("len %u\n", buf->len);
31+
}
32+
33+
struct test_setting {
34+
uint32_t val;
35+
} test_settings[TEST_SETTINGS_COUNT];
36+
37+
K_SEM_DEFINE(waitfor_work, 0, 1);
38+
39+
static void store_pending(struct k_work *work)
40+
{
41+
int err;
42+
char path[20];
43+
struct test_stats {
44+
uint32_t total_calculated;
45+
uint32_t total_measured;
46+
uint32_t single_entry_max;
47+
uint32_t single_entry_min;
48+
} stats = {0, 0, 0, UINT32_MAX};
49+
50+
int64_t ts1 = k_uptime_get();
51+
52+
/* benchmark storage performance */
53+
for (int j = 0; j < TEST_STORE_ITR; j++) {
54+
for (int i = 0; i < TEST_SETTINGS_COUNT; i++) {
55+
test_settings[i].val = TEST_SETTINGS_COUNT*j + i;
56+
57+
int64_t ts2 = k_uptime_get();
58+
59+
snprintk(path, sizeof(path), "ab/cdef/ghi/%04x", i);
60+
err = settings_save_one(path, &test_settings[i],
61+
sizeof(struct test_setting));
62+
zassert_equal(err, 0, "settings_save_one failed %d", err);
63+
64+
int64_t delta2 = k_uptime_delta(&ts2);
65+
66+
if (stats.single_entry_max < delta2) {
67+
stats.single_entry_max = delta2;
68+
}
69+
if (stats.single_entry_min > delta2) {
70+
stats.single_entry_min = delta2;
71+
}
72+
stats.total_calculated += delta2;
73+
}
74+
}
75+
76+
int64_t delta1 = k_uptime_delta(&ts1);
77+
78+
stats.total_measured = delta1;
79+
80+
printk("*** storing of %u entries completed ***\n", ARRAY_SIZE(test_settings));
81+
printk("total calculated: %u, total measured: %u\n", stats.total_calculated,
82+
stats.total_measured);
83+
printk("entry max: %u, entry min: %u\n", stats.single_entry_max,
84+
stats.single_entry_min);
85+
86+
k_sem_give(&waitfor_work);
87+
}
88+
89+
ZTEST_SUITE(settings_perf, NULL, NULL, NULL, NULL, NULL);
90+
91+
ZTEST(settings_perf, test_performance)
92+
{
93+
int err;
94+
95+
if (IS_ENABLED(CONFIG_NVS)) {
96+
printk("Testing with NVS\n");
97+
} else if (IS_ENABLED(CONFIG_ZMS)) {
98+
printk("Testing with ZMS\n");
99+
}
100+
101+
k_work_queue_start(&settings_work_q, settings_work_stack,
102+
K_THREAD_STACK_SIZEOF(settings_work_stack),
103+
K_PRIO_COOP(TEST_SETTINGS_WORKQ_PRIO), NULL);
104+
k_thread_name_set(&settings_work_q.thread, "Settings workq");
105+
k_work_init_delayable(&pending_store, store_pending);
106+
107+
if (IS_ENABLED(CONFIG_BT)) {
108+
/* enable one of the major subsystems, and start scanning. */
109+
err = bt_enable(NULL);
110+
zassert_equal(err, 0, "Bluetooth init failed (err %d)\n", err);
111+
112+
err = bt_le_scan_start(BT_LE_SCAN_ACTIVE, bt_scan_cb);
113+
zassert_equal(err, 0, "Scanning failed to start (err %d)\n", err);
114+
}
115+
116+
err = settings_subsys_init();
117+
zassert_equal(err, 0, "settings_backend_init failed %d", err);
118+
119+
/* fill with values */
120+
for (int i = 0; i < TEST_SETTINGS_COUNT; i++) {
121+
test_settings[i].val = i;
122+
}
123+
124+
k_work_reschedule_for_queue(&settings_work_q, &pending_store, K_NO_WAIT);
125+
126+
err = k_sem_take(&waitfor_work, K_SECONDS(TEST_TIMEOUT_SEC));
127+
zassert_equal(err, 0, "k_sem_take failed %d", err);
128+
129+
if (IS_ENABLED(CONFIG_BT)) {
130+
err = bt_le_scan_stop();
131+
zassert_equal(err, 0, "Scanning failed to stop (err %d)\n", err);
132+
}
133+
}

‎tests/subsys/settings/performance/testcase.yaml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
tests:
2+
settings.performance.zms:
3+
extra_configs:
4+
- CONFIG_SETTINGS_ZMS=y
5+
- CONFIG_ZMS_LOOKUP_CACHE=y
6+
- CONFIG_ZMS_LOOKUP_CACHE_SIZE=512
7+
platform_allow:
8+
- nrf52840dk/nrf52840
9+
- nrf54l15dk/nrf54l15/cpuapp
10+
min_ram: 32
11+
tags:
12+
- settings
13+
- zms
14+
15+
settings.performance.nvs:
16+
extra_configs:
17+
- CONFIG_ZMS=n
18+
- CONFIG_NVS=y
19+
- CONFIG_NVS_LOOKUP_CACHE=y
20+
- CONFIG_NVS_LOOKUP_CACHE_SIZE=512
21+
- CONFIG_SETTINGS_NVS_NAME_CACHE=y
22+
- CONFIG_SETTINGS_NVS_NAME_CACHE_SIZE=512
23+
platform_allow:
24+
- nrf52840dk/nrf52840
25+
- nrf54l15dk/nrf54l15/cpuapp
26+
min_ram: 32
27+
tags:
28+
- settings
29+
- nvs
30+
31+
settings.performance.zms_bt:
32+
extra_configs:
33+
- CONFIG_BT=y
34+
- CONFIG_BT_OBSERVER=y
35+
- CONFIG_BT_PERIPHERAL=y
36+
- CONFIG_SETTINGS_ZMS=y
37+
- CONFIG_ZMS_LOOKUP_CACHE=y
38+
- CONFIG_ZMS_LOOKUP_CACHE_SIZE=512
39+
platform_allow: nrf52840dk/nrf52840
40+
platform_exclude:
41+
- native_sim
42+
- qemu_x86
43+
min_ram: 32
44+
tags:
45+
- settings
46+
- zms
47+
48+
settings.performance.nvs_bt:
49+
extra_configs:
50+
- CONFIG_BT=y
51+
- CONFIG_BT_OBSERVER=y
52+
- CONFIG_BT_PERIPHERAL=y
53+
- CONFIG_ZMS=n
54+
- CONFIG_NVS=y
55+
- CONFIG_NVS_LOOKUP_CACHE=y
56+
- CONFIG_NVS_LOOKUP_CACHE_SIZE=512
57+
- CONFIG_SETTINGS_NVS_NAME_CACHE=y
58+
- CONFIG_SETTINGS_NVS_NAME_CACHE_SIZE=512
59+
platform_allow: nrf52840dk/nrf52840
60+
platform_exclude:
61+
- native_sim
62+
- qemu_x86
63+
min_ram: 32
64+
tags:
65+
- settings
66+
- nvs

0 commit comments

Comments
 (0)