xref: /linux/tools/testing/selftests/damon/sysfs.py (revision ddac713da3bcd117a4ee4d184a34f02582495e7d)
1#!/usr/bin/env python3
2# SPDX-License-Identifier: GPL-2.0
3
4import json
5import os
6import subprocess
7
8import _damon_sysfs
9
10def dump_damon_status_dict(pid):
11    try:
12        subprocess.check_output(['which', 'drgn'], stderr=subprocess.DEVNULL)
13    except:
14        return None, 'drgn not found'
15    file_dir = os.path.dirname(os.path.abspath(__file__))
16    dump_script = os.path.join(file_dir, 'drgn_dump_damon_status.py')
17    rc = subprocess.call(['drgn', dump_script, pid, 'damon_dump_output'],
18                         stderr=subprocess.DEVNULL)
19    if rc != 0:
20        return None, 'drgn fail'
21    try:
22        with open('damon_dump_output', 'r') as f:
23            return json.load(f), None
24    except Exception as e:
25        return None, 'json.load fail (%s)' % e
26
27def fail(expectation, status):
28    print('unexpected %s' % expectation)
29    print(json.dumps(status, indent=4))
30    exit(1)
31
32def assert_true(condition, expectation, status):
33    if condition is not True:
34        fail(expectation, status)
35
36def assert_watermarks_committed(watermarks, dump):
37    wmark_metric_val = {
38            'none': 0,
39            'free_mem_rate': 1,
40            }
41    assert_true(dump['metric'] == wmark_metric_val[watermarks.metric],
42                'metric', dump)
43    assert_true(dump['interval'] == watermarks.interval, 'interval', dump)
44    assert_true(dump['high'] == watermarks.high, 'high', dump)
45    assert_true(dump['mid'] == watermarks.mid, 'mid', dump)
46    assert_true(dump['low'] == watermarks.low, 'low', dump)
47
48def assert_quota_goal_committed(qgoal, dump):
49    metric_val = {
50            'user_input': 0,
51            'some_mem_psi_us': 1,
52            'node_mem_used_bp': 2,
53            'node_mem_free_bp': 3,
54            }
55    assert_true(dump['metric'] == metric_val[qgoal.metric], 'metric', dump)
56    assert_true(dump['target_value'] == qgoal.target_value, 'target_value',
57                dump)
58    if qgoal.metric == 'user_input':
59        assert_true(dump['current_value'] == qgoal.current_value,
60                    'current_value', dump)
61    assert_true(dump['nid'] == qgoal.nid, 'nid', dump)
62
63def assert_quota_committed(quota, dump):
64    assert_true(dump['reset_interval'] == quota.reset_interval_ms,
65                'reset_interval', dump)
66    assert_true(dump['ms'] == quota.ms, 'ms', dump)
67    assert_true(dump['sz'] == quota.sz, 'sz', dump)
68    for idx, qgoal in enumerate(quota.goals):
69        assert_quota_goal_committed(qgoal, dump['goals'][idx])
70    tuner_val = {
71            'consist': 0,
72            'temporal': 1,
73            }
74    assert_true(dump['goal_tuner'] == tuner_val[quota.goal_tuner],
75                'goal_tuner', dump)
76    assert_true(dump['weight_sz'] == quota.weight_sz_permil, 'weight_sz', dump)
77    assert_true(dump['weight_nr_accesses'] == quota.weight_nr_accesses_permil,
78                'weight_nr_accesses', dump)
79    assert_true(
80            dump['weight_age'] == quota.weight_age_permil, 'weight_age', dump)
81
82
83def assert_migrate_dests_committed(dests, dump):
84    assert_true(dump['nr_dests'] == len(dests.dests), 'nr_dests', dump)
85    for idx, dest in enumerate(dests.dests):
86        assert_true(dump['node_id_arr'][idx] == dest.id, 'node_id', dump)
87        assert_true(dump['weight_arr'][idx] == dest.weight, 'weight', dump)
88
89def assert_filter_committed(filter_, dump):
90    assert_true(filter_.type_ == dump['type'], 'type', dump)
91    assert_true(filter_.matching == dump['matching'], 'matching', dump)
92    assert_true(filter_.allow == dump['allow'], 'allow', dump)
93    # TODO: check memcg_path and memcg_id if type is memcg
94    if filter_.type_ == 'addr':
95        assert_true([filter_.addr_start, filter_.addr_end] ==
96                    dump['addr_range'], 'addr_range', dump)
97    elif filter_.type_ == 'target':
98        assert_true(filter_.target_idx == dump['target_idx'], 'target_idx',
99                    dump)
100    elif filter_.type_ == 'hugepage_size':
101        assert_true([filter_.min_, filter_.max_] == dump['sz_range'],
102                    'sz_range', dump)
103
104def assert_access_pattern_committed(pattern, dump):
105    assert_true(dump['min_sz_region'] == pattern.size[0], 'min_sz_region',
106                dump)
107    assert_true(dump['max_sz_region'] == pattern.size[1], 'max_sz_region',
108                dump)
109    assert_true(dump['min_nr_accesses'] == pattern.nr_accesses[0],
110                'min_nr_accesses', dump)
111    assert_true(dump['max_nr_accesses'] == pattern.nr_accesses[1],
112                'max_nr_accesses', dump)
113    assert_true(dump['min_age_region'] == pattern.age[0], 'min_age_region',
114                dump)
115    assert_true(dump['max_age_region'] == pattern.age[1], 'miaxage_region',
116                dump)
117
118def assert_scheme_committed(scheme, dump):
119    assert_access_pattern_committed(scheme.access_pattern, dump['pattern'])
120    action_val = {
121            'willneed': 0,
122            'cold': 1,
123            'pageout': 2,
124            'hugepage': 3,
125            'nohugeapge': 4,
126            'lru_prio': 5,
127            'lru_deprio': 6,
128            'migrate_hot': 7,
129            'migrate_cold': 8,
130            'stat': 9,
131            }
132    assert_true(dump['action'] == action_val[scheme.action], 'action', dump)
133    assert_true(dump['apply_interval_us'] == scheme. apply_interval_us,
134                'apply_interval_us', dump)
135    assert_true(dump['target_nid'] == scheme.target_nid, 'target_nid', dump)
136    assert_migrate_dests_committed(scheme.dests, dump['migrate_dests'])
137    assert_quota_committed(scheme.quota, dump['quota'])
138    assert_watermarks_committed(scheme.watermarks, dump['wmarks'])
139    # TODO: test filters directory
140    for idx, f in enumerate(scheme.core_filters.filters):
141        assert_filter_committed(f, dump['core_filters'][idx])
142    for idx, f in enumerate(scheme.ops_filters.filters):
143        assert_filter_committed(f, dump['ops_filters'][idx])
144
145def assert_schemes_committed(schemes, dump):
146    assert_true(len(schemes) == len(dump), 'len_schemes', dump)
147    for idx, scheme in enumerate(schemes):
148        assert_scheme_committed(scheme, dump[idx])
149
150def assert_monitoring_attrs_committed(attrs, dump):
151    assert_true(dump['sample_interval'] == attrs.sample_us, 'sample_interval',
152                dump)
153    assert_true(dump['aggr_interval'] == attrs.aggr_us, 'aggr_interval', dump)
154    assert_true(dump['intervals_goal']['access_bp'] ==
155                attrs.intervals_goal.access_bp, 'access_bp',
156                dump['intervals_goal'])
157    assert_true(dump['intervals_goal']['aggrs'] == attrs.intervals_goal.aggrs,
158                'aggrs', dump['intervals_goal'])
159    assert_true(dump['intervals_goal']['min_sample_us'] ==
160                attrs.intervals_goal.min_sample_us, 'min_sample_us',
161                dump['intervals_goal'])
162    assert_true(dump['intervals_goal']['max_sample_us'] ==
163                attrs.intervals_goal.max_sample_us, 'max_sample_us',
164                dump['intervals_goal'])
165
166    assert_true(dump['ops_update_interval'] == attrs.update_us,
167                'ops_update_interval', dump)
168    assert_true(dump['min_nr_regions'] == attrs.min_nr_regions,
169                'min_nr_regions', dump)
170    assert_true(dump['max_nr_regions'] == attrs.max_nr_regions,
171                'max_nr_regions', dump)
172
173def assert_monitoring_target_committed(target, dump):
174    # target.pid is the pid "number", while dump['pid'] is 'struct pid'
175    # pointer, and hence cannot be compared.
176    assert_true(dump['obsolete'] == target.obsolete, 'target obsolete', dump)
177
178def assert_monitoring_targets_committed(targets, dump):
179    assert_true(len(targets) == len(dump), 'len_targets', dump)
180    for idx, target in enumerate(targets):
181        assert_monitoring_target_committed(target, dump[idx])
182
183def assert_ctx_committed(ctx, dump):
184    ops_val = {
185            'vaddr': 0,
186            'fvaddr': 1,
187            'paddr': 2,
188            }
189    assert_true(dump['ops']['id'] == ops_val[ctx.ops], 'ops_id', dump)
190    assert_monitoring_attrs_committed(ctx.monitoring_attrs, dump['attrs'])
191    assert_monitoring_targets_committed(ctx.targets, dump['adaptive_targets'])
192    assert_schemes_committed(ctx.schemes, dump['schemes'])
193
194def assert_ctxs_committed(kdamonds):
195    status, err = dump_damon_status_dict(kdamonds.kdamonds[0].pid)
196    if err is not None:
197        print(err)
198        kdamonds.stop()
199        exit(1)
200
201    ctxs = kdamonds.kdamonds[0].contexts
202    dump = status['contexts']
203    assert_true(len(ctxs) == len(dump), 'ctxs length', dump)
204    for idx, ctx in enumerate(ctxs):
205        assert_ctx_committed(ctx, dump[idx])
206
207def main():
208    kdamonds = _damon_sysfs.Kdamonds(
209            [_damon_sysfs.Kdamond(
210                contexts=[_damon_sysfs.DamonCtx(
211                    targets=[_damon_sysfs.DamonTarget(pid=-1)],
212                    schemes=[_damon_sysfs.Damos()],
213                    )])])
214    err = kdamonds.start()
215    if err is not None:
216        print('kdamond start failed: %s' % err)
217        exit(1)
218
219    assert_ctxs_committed(kdamonds)
220
221    context = _damon_sysfs.DamonCtx(
222            monitoring_attrs=_damon_sysfs.DamonAttrs(
223                sample_us=100000, aggr_us=2000000,
224                intervals_goal=_damon_sysfs.IntervalsGoal(
225                    access_bp=400, aggrs=3, min_sample_us=5000,
226                    max_sample_us=10000000),
227                update_us=2000000),
228            schemes=[_damon_sysfs.Damos(
229                action='pageout',
230                access_pattern=_damon_sysfs.DamosAccessPattern(
231                    size=[4096, 2**10],
232                    nr_accesses=[3, 317],
233                    age=[5,71]),
234                quota=_damon_sysfs.DamosQuota(
235                    sz=100*1024*1024, ms=100,
236                    goals=[_damon_sysfs.DamosQuotaGoal(
237                        metric='node_mem_used_bp',
238                        target_value=9950,
239                        nid=1)],
240                    goal_tuner='temporal',
241                    reset_interval_ms=1500,
242                    weight_sz_permil=20,
243                    weight_nr_accesses_permil=200,
244                    weight_age_permil=1000),
245                watermarks=_damon_sysfs.DamosWatermarks(
246                    metric = 'free_mem_rate', interval = 500000, # 500 ms
247                    high = 500, mid = 400, low = 50),
248                target_nid=1,
249                apply_interval_us=1000000,
250                dests=_damon_sysfs.DamosDests(
251                    dests=[_damon_sysfs.DamosDest(id=1, weight=30),
252                           _damon_sysfs.DamosDest(id=0, weight=70)]),
253                core_filters=[
254                    _damon_sysfs.DamosFilter(type_='addr', matching=True,
255                                             allow=False, addr_start=42,
256                                             addr_end=4242),
257                    ],
258                ops_filters=[
259                    _damon_sysfs.DamosFilter(type_='anon', matching=True,
260                                             allow=True),
261                    ],
262                )])
263    context.idx = 0
264    context.kdamond = kdamonds.kdamonds[0]
265    kdamonds.kdamonds[0].contexts = [context]
266    kdamonds.kdamonds[0].commit()
267
268    assert_ctxs_committed(kdamonds)
269
270    # test online commitment of minimum context.
271    context = _damon_sysfs.DamonCtx()
272    context.idx = 0
273    context.kdamond = kdamonds.kdamonds[0]
274    kdamonds.kdamonds[0].contexts = [context]
275    kdamonds.kdamonds[0].commit()
276
277    assert_ctxs_committed(kdamonds)
278
279    kdamonds.stop()
280
281    # test obsolete_target.
282    proc1 = subprocess.Popen(['sh'], stdout=subprocess.PIPE,
283                             stderr=subprocess.PIPE)
284    proc2 = subprocess.Popen(['sh'], stdout=subprocess.PIPE,
285                             stderr=subprocess.PIPE)
286    proc3 = subprocess.Popen(['sh'], stdout=subprocess.PIPE,
287                             stderr=subprocess.PIPE)
288    kdamonds = _damon_sysfs.Kdamonds(
289            [_damon_sysfs.Kdamond(
290                contexts=[_damon_sysfs.DamonCtx(
291                    ops='vaddr',
292                    targets=[
293                        _damon_sysfs.DamonTarget(pid=proc1.pid),
294                        _damon_sysfs.DamonTarget(pid=proc2.pid),
295                        _damon_sysfs.DamonTarget(pid=proc3.pid),
296                        ],
297                    schemes=[_damon_sysfs.Damos()],
298                    )])])
299    err = kdamonds.start()
300    if err is not None:
301        print('kdamond start failed: %s' % err)
302        exit(1)
303    kdamonds.kdamonds[0].contexts[0].targets[1].obsolete = True
304    kdamonds.kdamonds[0].commit()
305    del kdamonds.kdamonds[0].contexts[0].targets[1]
306    assert_ctxs_committed(kdamonds)
307    kdamonds.stop()
308
309if __name__ == '__main__':
310    main()
311