xref: /linux/tools/testing/selftests/damon/sysfs.sh (revision 4eca0ef49af9b2b0c52ef2b58e045ab34629796b)
1#!/bin/bash
2# SPDX-License-Identifier: GPL-2.0
3
4# Kselftest frmework requirement - SKIP code is 4.
5ksft_skip=4
6
7ensure_write_succ()
8{
9	file=$1
10	content=$2
11	reason=$3
12
13	if ! echo "$content" > "$file"
14	then
15		echo "writing $content to $file failed"
16		echo "expected success because $reason"
17		exit 1
18	fi
19}
20
21ensure_write_fail()
22{
23	file=$1
24	content=$2
25	reason=$3
26
27	if (echo "$content" > "$file") 2> /dev/null
28	then
29		echo "writing $content to $file succeed ($fail_reason)"
30		echo "expected failure because $reason"
31		exit 1
32	fi
33}
34
35ensure_dir()
36{
37	dir=$1
38	to_ensure=$2
39	if [ "$to_ensure" = "exist" ] && [ ! -d "$dir" ]
40	then
41		echo "$dir dir is expected but not found"
42		exit 1
43	elif [ "$to_ensure" = "not_exist" ] && [ -d "$dir" ]
44	then
45		echo "$dir dir is not expected but found"
46		exit 1
47	fi
48}
49
50ensure_file()
51{
52	file=$1
53	to_ensure=$2
54	permission=$3
55	if [ "$to_ensure" = "exist" ]
56	then
57		if [ ! -f "$file" ]
58		then
59			echo "$file is expected but not found"
60			exit 1
61		fi
62		perm=$(stat -c "%a" "$file")
63		if [ ! "$perm" = "$permission" ]
64		then
65			echo "$file permission: expected $permission but $perm"
66			exit 1
67		fi
68	elif [ "$to_ensure" = "not_exist" ] && [ -f "$dir" ]
69	then
70		echo "$file is not expected but found"
71		exit 1
72	fi
73}
74
75test_range()
76{
77	range_dir=$1
78	ensure_dir "$range_dir" "exist"
79	ensure_file "$range_dir/min" "exist" 600
80	ensure_file "$range_dir/max" "exist" 600
81}
82
83test_tried_regions()
84{
85	tried_regions_dir=$1
86	ensure_dir "$tried_regions_dir" "exist"
87	ensure_file "$tried_regions_dir/total_bytes" "exist" "400"
88}
89
90test_stats()
91{
92	stats_dir=$1
93	ensure_dir "$stats_dir" "exist"
94	for f in nr_tried sz_tried nr_applied sz_applied qt_exceeds
95	do
96		ensure_file "$stats_dir/$f" "exist" "400"
97	done
98}
99
100test_filter()
101{
102	filter_dir=$1
103	ensure_file "$filter_dir/type" "exist" "600"
104	ensure_write_succ "$filter_dir/type" "anon" "valid input"
105	ensure_write_succ "$filter_dir/type" "memcg" "valid input"
106	ensure_write_succ "$filter_dir/type" "addr" "valid input"
107	ensure_write_succ "$filter_dir/type" "target" "valid input"
108	ensure_write_fail "$filter_dir/type" "foo" "invalid input"
109	ensure_file "$filter_dir/matching" "exist" "600"
110	ensure_file "$filter_dir/memcg_path" "exist" "600"
111	ensure_file "$filter_dir/addr_start" "exist" "600"
112	ensure_file "$filter_dir/addr_end" "exist" "600"
113	ensure_file "$filter_dir/damon_target_idx" "exist" "600"
114}
115
116test_filters()
117{
118	filters_dir=$1
119	ensure_dir "$filters_dir" "exist"
120	ensure_file "$filters_dir/nr_filters" "exist" "600"
121	ensure_write_succ  "$filters_dir/nr_filters" "1" "valid input"
122	test_filter "$filters_dir/0"
123
124	ensure_write_succ  "$filters_dir/nr_filters" "2" "valid input"
125	test_filter "$filters_dir/0"
126	test_filter "$filters_dir/1"
127
128	ensure_write_succ "$filters_dir/nr_filters" "0" "valid input"
129	ensure_dir "$filters_dir/0" "not_exist"
130	ensure_dir "$filters_dir/1" "not_exist"
131}
132
133test_watermarks()
134{
135	watermarks_dir=$1
136	ensure_dir "$watermarks_dir" "exist"
137	ensure_file "$watermarks_dir/metric" "exist" "600"
138	ensure_file "$watermarks_dir/interval_us" "exist" "600"
139	ensure_file "$watermarks_dir/high" "exist" "600"
140	ensure_file "$watermarks_dir/mid" "exist" "600"
141	ensure_file "$watermarks_dir/low" "exist" "600"
142}
143
144test_weights()
145{
146	weights_dir=$1
147	ensure_dir "$weights_dir" "exist"
148	ensure_file "$weights_dir/sz_permil" "exist" "600"
149	ensure_file "$weights_dir/nr_accesses_permil" "exist" "600"
150	ensure_file "$weights_dir/age_permil" "exist" "600"
151}
152
153test_quotas()
154{
155	quotas_dir=$1
156	ensure_dir "$quotas_dir" "exist"
157	ensure_file "$quotas_dir/ms" "exist" 600
158	ensure_file "$quotas_dir/bytes" "exist" 600
159	ensure_file "$quotas_dir/reset_interval_ms" "exist" 600
160	test_weights "$quotas_dir/weights"
161}
162
163test_access_pattern()
164{
165	access_pattern_dir=$1
166	ensure_dir "$access_pattern_dir" "exist"
167	test_range "$access_pattern_dir/age"
168	test_range "$access_pattern_dir/nr_accesses"
169	test_range "$access_pattern_dir/sz"
170}
171
172test_scheme()
173{
174	scheme_dir=$1
175	ensure_dir "$scheme_dir" "exist"
176	ensure_file "$scheme_dir/action" "exist" "600"
177	test_access_pattern "$scheme_dir/access_pattern"
178	ensure_file "$scheme_dir/apply_interval_us" "exist" "600"
179	test_quotas "$scheme_dir/quotas"
180	test_watermarks "$scheme_dir/watermarks"
181	test_filters "$scheme_dir/filters"
182	test_stats "$scheme_dir/stats"
183	test_tried_regions "$scheme_dir/tried_regions"
184}
185
186test_schemes()
187{
188	schemes_dir=$1
189	ensure_dir "$schemes_dir" "exist"
190	ensure_file "$schemes_dir/nr_schemes" "exist" 600
191
192	ensure_write_succ  "$schemes_dir/nr_schemes" "1" "valid input"
193	test_scheme "$schemes_dir/0"
194
195	ensure_write_succ  "$schemes_dir/nr_schemes" "2" "valid input"
196	test_scheme "$schemes_dir/0"
197	test_scheme "$schemes_dir/1"
198
199	ensure_write_succ "$schemes_dir/nr_schemes" "0" "valid input"
200	ensure_dir "$schemes_dir/0" "not_exist"
201	ensure_dir "$schemes_dir/1" "not_exist"
202}
203
204test_region()
205{
206	region_dir=$1
207	ensure_dir "$region_dir" "exist"
208	ensure_file "$region_dir/start" "exist" 600
209	ensure_file "$region_dir/end" "exist" 600
210}
211
212test_regions()
213{
214	regions_dir=$1
215	ensure_dir "$regions_dir" "exist"
216	ensure_file "$regions_dir/nr_regions" "exist" 600
217
218	ensure_write_succ  "$regions_dir/nr_regions" "1" "valid input"
219	test_region "$regions_dir/0"
220
221	ensure_write_succ  "$regions_dir/nr_regions" "2" "valid input"
222	test_region "$regions_dir/0"
223	test_region "$regions_dir/1"
224
225	ensure_write_succ "$regions_dir/nr_regions" "0" "valid input"
226	ensure_dir "$regions_dir/0" "not_exist"
227	ensure_dir "$regions_dir/1" "not_exist"
228}
229
230test_target()
231{
232	target_dir=$1
233	ensure_dir "$target_dir" "exist"
234	ensure_file "$target_dir/pid_target" "exist" "600"
235	test_regions "$target_dir/regions"
236}
237
238test_targets()
239{
240	targets_dir=$1
241	ensure_dir "$targets_dir" "exist"
242	ensure_file "$targets_dir/nr_targets" "exist" 600
243
244	ensure_write_succ  "$targets_dir/nr_targets" "1" "valid input"
245	test_target "$targets_dir/0"
246
247	ensure_write_succ  "$targets_dir/nr_targets" "2" "valid input"
248	test_target "$targets_dir/0"
249	test_target "$targets_dir/1"
250
251	ensure_write_succ "$targets_dir/nr_targets" "0" "valid input"
252	ensure_dir "$targets_dir/0" "not_exist"
253	ensure_dir "$targets_dir/1" "not_exist"
254}
255
256test_intervals()
257{
258	intervals_dir=$1
259	ensure_dir "$intervals_dir" "exist"
260	ensure_file "$intervals_dir/aggr_us" "exist" "600"
261	ensure_file "$intervals_dir/sample_us" "exist" "600"
262	ensure_file "$intervals_dir/update_us" "exist" "600"
263}
264
265test_monitoring_attrs()
266{
267	monitoring_attrs_dir=$1
268	ensure_dir "$monitoring_attrs_dir" "exist"
269	test_intervals "$monitoring_attrs_dir/intervals"
270	test_range "$monitoring_attrs_dir/nr_regions"
271}
272
273test_context()
274{
275	context_dir=$1
276	ensure_dir "$context_dir" "exist"
277	ensure_file "$context_dir/avail_operations" "exit" 400
278	ensure_file "$context_dir/operations" "exist" 600
279	test_monitoring_attrs "$context_dir/monitoring_attrs"
280	test_targets "$context_dir/targets"
281	test_schemes "$context_dir/schemes"
282}
283
284test_contexts()
285{
286	contexts_dir=$1
287	ensure_dir "$contexts_dir" "exist"
288	ensure_file "$contexts_dir/nr_contexts" "exist" 600
289
290	ensure_write_succ  "$contexts_dir/nr_contexts" "1" "valid input"
291	test_context "$contexts_dir/0"
292
293	ensure_write_fail "$contexts_dir/nr_contexts" "2" "only 0/1 are supported"
294	test_context "$contexts_dir/0"
295
296	ensure_write_succ "$contexts_dir/nr_contexts" "0" "valid input"
297	ensure_dir "$contexts_dir/0" "not_exist"
298}
299
300test_kdamond()
301{
302	kdamond_dir=$1
303	ensure_dir "$kdamond_dir" "exist"
304	ensure_file "$kdamond_dir/state" "exist" "600"
305	ensure_file "$kdamond_dir/pid" "exist" 400
306	test_contexts "$kdamond_dir/contexts"
307}
308
309test_kdamonds()
310{
311	kdamonds_dir=$1
312	ensure_dir "$kdamonds_dir" "exist"
313
314	ensure_file "$kdamonds_dir/nr_kdamonds" "exist" "600"
315
316	ensure_write_succ  "$kdamonds_dir/nr_kdamonds" "1" "valid input"
317	test_kdamond "$kdamonds_dir/0"
318
319	ensure_write_succ  "$kdamonds_dir/nr_kdamonds" "2" "valid input"
320	test_kdamond "$kdamonds_dir/0"
321	test_kdamond "$kdamonds_dir/1"
322
323	ensure_write_succ "$kdamonds_dir/nr_kdamonds" "0" "valid input"
324	ensure_dir "$kdamonds_dir/0" "not_exist"
325	ensure_dir "$kdamonds_dir/1" "not_exist"
326}
327
328test_damon_sysfs()
329{
330	damon_sysfs=$1
331	if [ ! -d "$damon_sysfs" ]
332	then
333		echo "$damon_sysfs not found"
334		exit $ksft_skip
335	fi
336
337	test_kdamonds "$damon_sysfs/kdamonds"
338}
339
340check_dependencies()
341{
342	if [ $EUID -ne 0 ]
343	then
344		echo "Run as root"
345		exit $ksft_skip
346	fi
347}
348
349check_dependencies
350test_damon_sysfs "/sys/kernel/mm/damon/admin"
351