mm/secretmem: add __init annotation to secretmem_init()
[linux-block.git] / mm / damon / dbgfs.c
CommitLineData
4bc05954
SP
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * DAMON Debugfs Interface
4 *
5 * Author: SeongJae Park <sjpark@amazon.de>
6 */
7
8#define pr_fmt(fmt) "damon-dbgfs: " fmt
9
10#include <linux/damon.h>
11#include <linux/debugfs.h>
12#include <linux/file.h>
13#include <linux/mm.h>
14#include <linux/module.h>
15#include <linux/page_idle.h>
16#include <linux/slab.h>
17
18static struct damon_ctx **dbgfs_ctxs;
19static int dbgfs_nr_ctxs;
20static struct dentry **dbgfs_dirs;
75c1c2b5 21static DEFINE_MUTEX(damon_dbgfs_lock);
4bc05954
SP
22
23/*
24 * Returns non-empty string on success, negative error code otherwise.
25 */
26static char *user_input_str(const char __user *buf, size_t count, loff_t *ppos)
27{
28 char *kbuf;
29 ssize_t ret;
30
31 /* We do not accept continuous write */
32 if (*ppos)
33 return ERR_PTR(-EINVAL);
34
db7a347b 35 kbuf = kmalloc(count + 1, GFP_KERNEL | __GFP_NOWARN);
4bc05954
SP
36 if (!kbuf)
37 return ERR_PTR(-ENOMEM);
38
39 ret = simple_write_to_buffer(kbuf, count + 1, ppos, buf, count);
40 if (ret != count) {
41 kfree(kbuf);
42 return ERR_PTR(-EIO);
43 }
44 kbuf[ret] = '\0';
45
46 return kbuf;
47}
48
49static ssize_t dbgfs_attrs_read(struct file *file,
50 char __user *buf, size_t count, loff_t *ppos)
51{
52 struct damon_ctx *ctx = file->private_data;
53 char kbuf[128];
54 int ret;
55
56 mutex_lock(&ctx->kdamond_lock);
57 ret = scnprintf(kbuf, ARRAY_SIZE(kbuf), "%lu %lu %lu %lu %lu\n",
cbeaa77b
SP
58 ctx->attrs.sample_interval, ctx->attrs.aggr_interval,
59 ctx->attrs.ops_update_interval,
60 ctx->attrs.min_nr_regions, ctx->attrs.max_nr_regions);
4bc05954
SP
61 mutex_unlock(&ctx->kdamond_lock);
62
63 return simple_read_from_buffer(buf, count, ppos, kbuf, ret);
64}
65
66static ssize_t dbgfs_attrs_write(struct file *file,
67 const char __user *buf, size_t count, loff_t *ppos)
68{
69 struct damon_ctx *ctx = file->private_data;
bead3b00 70 struct damon_attrs attrs;
4bc05954 71 char *kbuf;
9210622a 72 ssize_t ret;
4bc05954
SP
73
74 kbuf = user_input_str(buf, count, ppos);
75 if (IS_ERR(kbuf))
76 return PTR_ERR(kbuf);
77
78 if (sscanf(kbuf, "%lu %lu %lu %lu %lu",
bead3b00
SP
79 &attrs.sample_interval, &attrs.aggr_interval,
80 &attrs.ops_update_interval,
81 &attrs.min_nr_regions,
82 &attrs.max_nr_regions) != 5) {
4bc05954
SP
83 ret = -EINVAL;
84 goto out;
85 }
86
87 mutex_lock(&ctx->kdamond_lock);
88 if (ctx->kdamond) {
89 ret = -EBUSY;
90 goto unlock_out;
91 }
92
bead3b00 93 ret = damon_set_attrs(ctx, &attrs);
9210622a
RW
94 if (!ret)
95 ret = count;
4bc05954
SP
96unlock_out:
97 mutex_unlock(&ctx->kdamond_lock);
98out:
99 kfree(kbuf);
100 return ret;
101}
102
c364f9af
SP
103/*
104 * Return corresponding dbgfs' scheme action value (int) for the given
105 * damos_action if the given damos_action value is valid and supported by
106 * dbgfs, negative error code otherwise.
107 */
108static int damos_action_to_dbgfs_scheme_action(enum damos_action action)
109{
110 switch (action) {
111 case DAMOS_WILLNEED:
112 return 0;
113 case DAMOS_COLD:
114 return 1;
115 case DAMOS_PAGEOUT:
116 return 2;
117 case DAMOS_HUGEPAGE:
118 return 3;
119 case DAMOS_NOHUGEPAGE:
120 return 4;
121 case DAMOS_STAT:
122 return 5;
123 default:
124 return -EINVAL;
125 }
126}
127
af122dd8
SP
128static ssize_t sprint_schemes(struct damon_ctx *c, char *buf, ssize_t len)
129{
130 struct damos *s;
131 int written = 0;
132 int rc;
133
134 damon_for_each_scheme(s, c) {
135 rc = scnprintf(&buf[written], len - written,
3a619fdb 136 "%lu %lu %u %u %u %u %d %lu %lu %lu %u %u %u %d %lu %lu %lu %lu %lu %lu %lu %lu %lu\n",
f5a79d7c
YD
137 s->pattern.min_sz_region,
138 s->pattern.max_sz_region,
139 s->pattern.min_nr_accesses,
140 s->pattern.max_nr_accesses,
141 s->pattern.min_age_region,
142 s->pattern.max_age_region,
c364f9af 143 damos_action_to_dbgfs_scheme_action(s->action),
d7d0ec85
SP
144 s->quota.ms, s->quota.sz,
145 s->quota.reset_interval,
f4a68b4a
SP
146 s->quota.weight_sz,
147 s->quota.weight_nr_accesses,
148 s->quota.weight_age,
ae666a6d
SP
149 s->wmarks.metric, s->wmarks.interval,
150 s->wmarks.high, s->wmarks.mid, s->wmarks.low,
3a619fdb
SP
151 s->stat.nr_tried, s->stat.sz_tried,
152 s->stat.nr_applied, s->stat.sz_applied,
153 s->stat.qt_exceeds);
af122dd8
SP
154 if (!rc)
155 return -ENOMEM;
156
157 written += rc;
158 }
159 return written;
160}
161
162static ssize_t dbgfs_schemes_read(struct file *file, char __user *buf,
163 size_t count, loff_t *ppos)
164{
165 struct damon_ctx *ctx = file->private_data;
166 char *kbuf;
167 ssize_t len;
168
db7a347b 169 kbuf = kmalloc(count, GFP_KERNEL | __GFP_NOWARN);
af122dd8
SP
170 if (!kbuf)
171 return -ENOMEM;
172
173 mutex_lock(&ctx->kdamond_lock);
174 len = sprint_schemes(ctx, kbuf, count);
175 mutex_unlock(&ctx->kdamond_lock);
176 if (len < 0)
177 goto out;
178 len = simple_read_from_buffer(buf, count, ppos, kbuf, len);
179
180out:
181 kfree(kbuf);
182 return len;
183}
184
185static void free_schemes_arr(struct damos **schemes, ssize_t nr_schemes)
186{
187 ssize_t i;
188
189 for (i = 0; i < nr_schemes; i++)
190 kfree(schemes[i]);
191 kfree(schemes);
192}
193
c364f9af
SP
194/*
195 * Return corresponding damos_action for the given dbgfs input for a scheme
196 * action if the input is valid, negative error code otherwise.
197 */
198static enum damos_action dbgfs_scheme_action_to_damos_action(int dbgfs_action)
af122dd8 199{
c364f9af
SP
200 switch (dbgfs_action) {
201 case 0:
202 return DAMOS_WILLNEED;
203 case 1:
204 return DAMOS_COLD;
205 case 2:
206 return DAMOS_PAGEOUT;
207 case 3:
208 return DAMOS_HUGEPAGE;
209 case 4:
210 return DAMOS_NOHUGEPAGE;
211 case 5:
212 return DAMOS_STAT;
af122dd8 213 default:
c364f9af 214 return -EINVAL;
af122dd8
SP
215 }
216}
217
218/*
219 * Converts a string into an array of struct damos pointers
220 *
221 * Returns an array of struct damos pointers that converted if the conversion
222 * success, or NULL otherwise.
223 */
224static struct damos **str_to_schemes(const char *str, ssize_t len,
225 ssize_t *nr_schemes)
226{
227 struct damos *scheme, **schemes;
228 const int max_nr_schemes = 256;
229 int pos = 0, parsed, ret;
c364f9af
SP
230 unsigned int action_input;
231 enum damos_action action;
af122dd8
SP
232
233 schemes = kmalloc_array(max_nr_schemes, sizeof(scheme),
234 GFP_KERNEL);
235 if (!schemes)
236 return NULL;
237
238 *nr_schemes = 0;
239 while (pos < len && *nr_schemes < max_nr_schemes) {
f5a79d7c 240 struct damos_access_pattern pattern = {};
2b8a248d 241 struct damos_quota quota = {};
ae666a6d 242 struct damos_watermarks wmarks;
2b8a248d 243
f4a68b4a 244 ret = sscanf(&str[pos],
ae666a6d 245 "%lu %lu %u %u %u %u %u %lu %lu %lu %u %u %u %u %lu %lu %lu %lu%n",
f5a79d7c
YD
246 &pattern.min_sz_region, &pattern.max_sz_region,
247 &pattern.min_nr_accesses,
248 &pattern.max_nr_accesses,
249 &pattern.min_age_region,
250 &pattern.max_age_region,
251 &action_input, &quota.ms,
f4a68b4a
SP
252 &quota.sz, &quota.reset_interval,
253 &quota.weight_sz, &quota.weight_nr_accesses,
ae666a6d
SP
254 &quota.weight_age, &wmarks.metric,
255 &wmarks.interval, &wmarks.high, &wmarks.mid,
256 &wmarks.low, &parsed);
257 if (ret != 18)
af122dd8 258 break;
c364f9af
SP
259 action = dbgfs_scheme_action_to_damos_action(action_input);
260 if ((int)action < 0)
af122dd8 261 goto fail;
af122dd8 262
f5a79d7c
YD
263 if (pattern.min_sz_region > pattern.max_sz_region ||
264 pattern.min_nr_accesses > pattern.max_nr_accesses ||
265 pattern.min_age_region > pattern.max_age_region)
c89ae63e
XH
266 goto fail;
267
268 if (wmarks.high < wmarks.mid || wmarks.high < wmarks.low ||
269 wmarks.mid < wmarks.low)
270 goto fail;
271
af122dd8 272 pos += parsed;
f5a79d7c 273 scheme = damon_new_scheme(&pattern, action, &quota, &wmarks);
af122dd8
SP
274 if (!scheme)
275 goto fail;
276
277 schemes[*nr_schemes] = scheme;
278 *nr_schemes += 1;
279 }
280 return schemes;
281fail:
282 free_schemes_arr(schemes, *nr_schemes);
283 return NULL;
284}
285
286static ssize_t dbgfs_schemes_write(struct file *file, const char __user *buf,
287 size_t count, loff_t *ppos)
288{
289 struct damon_ctx *ctx = file->private_data;
290 char *kbuf;
291 struct damos **schemes;
9210622a 292 ssize_t nr_schemes = 0, ret;
af122dd8
SP
293
294 kbuf = user_input_str(buf, count, ppos);
295 if (IS_ERR(kbuf))
296 return PTR_ERR(kbuf);
297
9210622a 298 schemes = str_to_schemes(kbuf, count, &nr_schemes);
af122dd8
SP
299 if (!schemes) {
300 ret = -EINVAL;
301 goto out;
302 }
303
304 mutex_lock(&ctx->kdamond_lock);
305 if (ctx->kdamond) {
306 ret = -EBUSY;
307 goto unlock_out;
308 }
309
9210622a
RW
310 ret = damon_set_schemes(ctx, schemes, nr_schemes);
311 if (!ret) {
312 ret = count;
af122dd8 313 nr_schemes = 0;
9210622a
RW
314 }
315
af122dd8
SP
316unlock_out:
317 mutex_unlock(&ctx->kdamond_lock);
318 free_schemes_arr(schemes, nr_schemes);
319out:
320 kfree(kbuf);
321 return ret;
322}
323
4bc05954
SP
324static ssize_t sprint_target_ids(struct damon_ctx *ctx, char *buf, ssize_t len)
325{
326 struct damon_target *t;
1971bd63 327 int id;
4bc05954
SP
328 int written = 0;
329 int rc;
330
331 damon_for_each_target(t, ctx) {
c9e124e0 332 if (damon_target_has_pid(ctx))
4bc05954 333 /* Show pid numbers to debugfs users */
1971bd63
SP
334 id = pid_vnr(t->pid);
335 else
336 /* Show 42 for physical address space, just for fun */
337 id = 42;
4bc05954 338
1971bd63 339 rc = scnprintf(&buf[written], len - written, "%d ", id);
4bc05954
SP
340 if (!rc)
341 return -ENOMEM;
342 written += rc;
343 }
344 if (written)
345 written -= 1;
346 written += scnprintf(&buf[written], len - written, "\n");
347 return written;
348}
349
350static ssize_t dbgfs_target_ids_read(struct file *file,
351 char __user *buf, size_t count, loff_t *ppos)
352{
353 struct damon_ctx *ctx = file->private_data;
354 ssize_t len;
355 char ids_buf[320];
356
357 mutex_lock(&ctx->kdamond_lock);
358 len = sprint_target_ids(ctx, ids_buf, 320);
359 mutex_unlock(&ctx->kdamond_lock);
360 if (len < 0)
361 return len;
362
363 return simple_read_from_buffer(buf, count, ppos, ids_buf, len);
364}
365
366/*
1971bd63 367 * Converts a string into an integers array
4bc05954 368 *
1971bd63
SP
369 * Returns an array of integers array if the conversion success, or NULL
370 * otherwise.
4bc05954 371 */
1971bd63 372static int *str_to_ints(const char *str, ssize_t len, ssize_t *nr_ints)
4bc05954 373{
1971bd63
SP
374 int *array;
375 const int max_nr_ints = 32;
376 int nr;
4bc05954
SP
377 int pos = 0, parsed, ret;
378
1971bd63
SP
379 *nr_ints = 0;
380 array = kmalloc_array(max_nr_ints, sizeof(*array), GFP_KERNEL);
381 if (!array)
4bc05954 382 return NULL;
1971bd63
SP
383 while (*nr_ints < max_nr_ints && pos < len) {
384 ret = sscanf(&str[pos], "%d%n", &nr, &parsed);
4bc05954
SP
385 pos += parsed;
386 if (ret != 1)
387 break;
1971bd63
SP
388 array[*nr_ints] = nr;
389 *nr_ints += 1;
4bc05954
SP
390 }
391
1971bd63 392 return array;
4bc05954
SP
393}
394
1971bd63 395static void dbgfs_put_pids(struct pid **pids, int nr_pids)
4bc05954
SP
396{
397 int i;
398
1971bd63
SP
399 for (i = 0; i < nr_pids; i++)
400 put_pid(pids[i]);
401}
402
403/*
404 * Converts a string into an struct pid pointers array
405 *
406 * Returns an array of struct pid pointers if the conversion success, or NULL
407 * otherwise.
408 */
409static struct pid **str_to_pids(const char *str, ssize_t len, ssize_t *nr_pids)
410{
411 int *ints;
412 ssize_t nr_ints;
413 struct pid **pids;
414
415 *nr_pids = 0;
416
417 ints = str_to_ints(str, len, &nr_ints);
418 if (!ints)
419 return NULL;
420
421 pids = kmalloc_array(nr_ints, sizeof(*pids), GFP_KERNEL);
422 if (!pids)
423 goto out;
424
425 for (; *nr_pids < nr_ints; (*nr_pids)++) {
426 pids[*nr_pids] = find_get_pid(ints[*nr_pids]);
427 if (!pids[*nr_pids]) {
428 dbgfs_put_pids(pids, *nr_pids);
429 kfree(ints);
430 kfree(pids);
431 return NULL;
432 }
433 }
434
435out:
436 kfree(ints);
437 return pids;
4bc05954
SP
438}
439
43642825
SP
440/*
441 * dbgfs_set_targets() - Set monitoring targets.
442 * @ctx: monitoring context
1971bd63
SP
443 * @nr_targets: number of targets
444 * @pids: array of target pids (size is same to @nr_targets)
43642825 445 *
1971bd63
SP
446 * This function should not be called while the kdamond is running. @pids is
447 * ignored if the context is not configured to have pid in each target. On
448 * failure, reference counts of all pids in @pids are decremented.
43642825
SP
449 *
450 * Return: 0 on success, negative error code otherwise.
451 */
1971bd63
SP
452static int dbgfs_set_targets(struct damon_ctx *ctx, ssize_t nr_targets,
453 struct pid **pids)
43642825
SP
454{
455 ssize_t i;
456 struct damon_target *t, *next;
457
458 damon_for_each_target_safe(t, next, ctx) {
c9e124e0 459 if (damon_target_has_pid(ctx))
1971bd63 460 put_pid(t->pid);
43642825
SP
461 damon_destroy_target(t);
462 }
463
1971bd63
SP
464 for (i = 0; i < nr_targets; i++) {
465 t = damon_new_target();
43642825 466 if (!t) {
43642825
SP
467 damon_for_each_target_safe(t, next, ctx)
468 damon_destroy_target(t);
c9e124e0 469 if (damon_target_has_pid(ctx))
1971bd63 470 dbgfs_put_pids(pids, nr_targets);
43642825
SP
471 return -ENOMEM;
472 }
c9e124e0 473 if (damon_target_has_pid(ctx))
1971bd63 474 t->pid = pids[i];
43642825
SP
475 damon_add_target(ctx, t);
476 }
477
478 return 0;
479}
480
4bc05954
SP
481static ssize_t dbgfs_target_ids_write(struct file *file,
482 const char __user *buf, size_t count, loff_t *ppos)
483{
484 struct damon_ctx *ctx = file->private_data;
c026291a 485 bool id_is_pid = true;
70b84808 486 char *kbuf;
1971bd63 487 struct pid **target_pids = NULL;
4bc05954 488 ssize_t nr_targets;
9210622a 489 ssize_t ret;
4bc05954
SP
490
491 kbuf = user_input_str(buf, count, ppos);
492 if (IS_ERR(kbuf))
493 return PTR_ERR(kbuf);
494
c026291a
SP
495 if (!strncmp(kbuf, "paddr\n", count)) {
496 id_is_pid = false;
1971bd63 497 nr_targets = 1;
4bc05954
SP
498 }
499
c026291a 500 if (id_is_pid) {
1971bd63
SP
501 target_pids = str_to_pids(kbuf, count, &nr_targets);
502 if (!target_pids) {
503 ret = -ENOMEM;
504 goto out;
4bc05954
SP
505 }
506 }
507
508 mutex_lock(&ctx->kdamond_lock);
509 if (ctx->kdamond) {
c026291a 510 if (id_is_pid)
1971bd63 511 dbgfs_put_pids(target_pids, nr_targets);
4bc05954
SP
512 ret = -EBUSY;
513 goto unlock_out;
514 }
515
ebb3f994 516 /* remove previously set targets */
1971bd63 517 dbgfs_set_targets(ctx, 0, NULL);
da7aaca0
SP
518 if (!nr_targets) {
519 ret = count;
520 goto unlock_out;
521 }
c026291a
SP
522
523 /* Configure the context for the address space type */
524 if (id_is_pid)
da7aaca0 525 ret = damon_select_ops(ctx, DAMON_OPS_VADDR);
c026291a 526 else
da7aaca0
SP
527 ret = damon_select_ops(ctx, DAMON_OPS_PADDR);
528 if (ret)
529 goto unlock_out;
c026291a 530
1971bd63 531 ret = dbgfs_set_targets(ctx, nr_targets, target_pids);
43642825 532 if (!ret)
9210622a 533 ret = count;
4bc05954
SP
534
535unlock_out:
536 mutex_unlock(&ctx->kdamond_lock);
1971bd63 537 kfree(target_pids);
4bc05954
SP
538out:
539 kfree(kbuf);
540 return ret;
541}
542
90bebce9
SP
543static ssize_t sprint_init_regions(struct damon_ctx *c, char *buf, ssize_t len)
544{
545 struct damon_target *t;
546 struct damon_region *r;
144760f8 547 int target_idx = 0;
90bebce9
SP
548 int written = 0;
549 int rc;
550
551 damon_for_each_target(t, c) {
552 damon_for_each_region(r, t) {
553 rc = scnprintf(&buf[written], len - written,
144760f8
SP
554 "%d %lu %lu\n",
555 target_idx, r->ar.start, r->ar.end);
90bebce9
SP
556 if (!rc)
557 return -ENOMEM;
558 written += rc;
559 }
144760f8 560 target_idx++;
90bebce9
SP
561 }
562 return written;
563}
564
565static ssize_t dbgfs_init_regions_read(struct file *file, char __user *buf,
566 size_t count, loff_t *ppos)
567{
568 struct damon_ctx *ctx = file->private_data;
569 char *kbuf;
570 ssize_t len;
571
db7a347b 572 kbuf = kmalloc(count, GFP_KERNEL | __GFP_NOWARN);
90bebce9
SP
573 if (!kbuf)
574 return -ENOMEM;
575
576 mutex_lock(&ctx->kdamond_lock);
577 if (ctx->kdamond) {
578 mutex_unlock(&ctx->kdamond_lock);
579 len = -EBUSY;
580 goto out;
581 }
582
583 len = sprint_init_regions(ctx, kbuf, count);
584 mutex_unlock(&ctx->kdamond_lock);
585 if (len < 0)
586 goto out;
587 len = simple_read_from_buffer(buf, count, ppos, kbuf, len);
588
589out:
590 kfree(kbuf);
591 return len;
592}
593
144760f8
SP
594static int add_init_region(struct damon_ctx *c, int target_idx,
595 struct damon_addr_range *ar)
90bebce9
SP
596{
597 struct damon_target *t;
598 struct damon_region *r, *prev;
144760f8 599 unsigned long idx = 0;
90bebce9
SP
600 int rc = -EINVAL;
601
602 if (ar->start >= ar->end)
603 return -EINVAL;
604
605 damon_for_each_target(t, c) {
144760f8 606 if (idx++ == target_idx) {
90bebce9
SP
607 r = damon_new_region(ar->start, ar->end);
608 if (!r)
609 return -ENOMEM;
610 damon_add_region(r, t);
611 if (damon_nr_regions(t) > 1) {
612 prev = damon_prev_region(r);
613 if (prev->ar.end > r->ar.start) {
614 damon_destroy_region(r, t);
615 return -EINVAL;
616 }
617 }
618 rc = 0;
619 }
620 }
621 return rc;
622}
623
624static int set_init_regions(struct damon_ctx *c, const char *str, ssize_t len)
625{
626 struct damon_target *t;
627 struct damon_region *r, *next;
628 int pos = 0, parsed, ret;
144760f8 629 int target_idx;
90bebce9
SP
630 struct damon_addr_range ar;
631 int err;
632
633 damon_for_each_target(t, c) {
634 damon_for_each_region_safe(r, next, t)
635 damon_destroy_region(r, t);
636 }
637
638 while (pos < len) {
144760f8
SP
639 ret = sscanf(&str[pos], "%d %lu %lu%n",
640 &target_idx, &ar.start, &ar.end, &parsed);
90bebce9
SP
641 if (ret != 3)
642 break;
144760f8 643 err = add_init_region(c, target_idx, &ar);
90bebce9
SP
644 if (err)
645 goto fail;
646 pos += parsed;
647 }
648
649 return 0;
650
651fail:
652 damon_for_each_target(t, c) {
653 damon_for_each_region_safe(r, next, t)
654 damon_destroy_region(r, t);
655 }
656 return err;
657}
658
659static ssize_t dbgfs_init_regions_write(struct file *file,
660 const char __user *buf, size_t count,
661 loff_t *ppos)
662{
663 struct damon_ctx *ctx = file->private_data;
664 char *kbuf;
665 ssize_t ret = count;
666 int err;
667
668 kbuf = user_input_str(buf, count, ppos);
669 if (IS_ERR(kbuf))
670 return PTR_ERR(kbuf);
671
672 mutex_lock(&ctx->kdamond_lock);
673 if (ctx->kdamond) {
674 ret = -EBUSY;
675 goto unlock_out;
676 }
677
678 err = set_init_regions(ctx, kbuf, ret);
679 if (err)
680 ret = err;
681
682unlock_out:
683 mutex_unlock(&ctx->kdamond_lock);
684 kfree(kbuf);
685 return ret;
686}
687
429538e8
SP
688static ssize_t dbgfs_kdamond_pid_read(struct file *file,
689 char __user *buf, size_t count, loff_t *ppos)
690{
691 struct damon_ctx *ctx = file->private_data;
692 char *kbuf;
693 ssize_t len;
694
db7a347b 695 kbuf = kmalloc(count, GFP_KERNEL | __GFP_NOWARN);
429538e8
SP
696 if (!kbuf)
697 return -ENOMEM;
698
699 mutex_lock(&ctx->kdamond_lock);
700 if (ctx->kdamond)
701 len = scnprintf(kbuf, count, "%d\n", ctx->kdamond->pid);
702 else
703 len = scnprintf(kbuf, count, "none\n");
704 mutex_unlock(&ctx->kdamond_lock);
705 if (!len)
706 goto out;
707 len = simple_read_from_buffer(buf, count, ppos, kbuf, len);
708
709out:
710 kfree(kbuf);
711 return len;
712}
713
4bc05954
SP
714static int damon_dbgfs_open(struct inode *inode, struct file *file)
715{
716 file->private_data = inode->i_private;
717
718 return nonseekable_open(inode, file);
719}
720
721static const struct file_operations attrs_fops = {
722 .open = damon_dbgfs_open,
723 .read = dbgfs_attrs_read,
724 .write = dbgfs_attrs_write,
725};
726
af122dd8
SP
727static const struct file_operations schemes_fops = {
728 .open = damon_dbgfs_open,
729 .read = dbgfs_schemes_read,
730 .write = dbgfs_schemes_write,
731};
732
4bc05954
SP
733static const struct file_operations target_ids_fops = {
734 .open = damon_dbgfs_open,
735 .read = dbgfs_target_ids_read,
736 .write = dbgfs_target_ids_write,
737};
738
90bebce9
SP
739static const struct file_operations init_regions_fops = {
740 .open = damon_dbgfs_open,
741 .read = dbgfs_init_regions_read,
742 .write = dbgfs_init_regions_write,
743};
744
429538e8
SP
745static const struct file_operations kdamond_pid_fops = {
746 .open = damon_dbgfs_open,
747 .read = dbgfs_kdamond_pid_read,
748};
749
4bc05954
SP
750static void dbgfs_fill_ctx_dir(struct dentry *dir, struct damon_ctx *ctx)
751{
af122dd8 752 const char * const file_names[] = {"attrs", "schemes", "target_ids",
90bebce9 753 "init_regions", "kdamond_pid"};
af122dd8 754 const struct file_operations *fops[] = {&attrs_fops, &schemes_fops,
90bebce9 755 &target_ids_fops, &init_regions_fops, &kdamond_pid_fops};
4bc05954
SP
756 int i;
757
758 for (i = 0; i < ARRAY_SIZE(file_names); i++)
759 debugfs_create_file(file_names[i], 0600, dir, ctx, fops[i]);
760}
761
658f9ae7 762static void dbgfs_before_terminate(struct damon_ctx *ctx)
4bc05954
SP
763{
764 struct damon_target *t, *next;
765
c9e124e0 766 if (!damon_target_has_pid(ctx))
658f9ae7 767 return;
4bc05954 768
34796417 769 mutex_lock(&ctx->kdamond_lock);
4bc05954 770 damon_for_each_target_safe(t, next, ctx) {
1971bd63 771 put_pid(t->pid);
4bc05954
SP
772 damon_destroy_target(t);
773 }
34796417 774 mutex_unlock(&ctx->kdamond_lock);
4bc05954
SP
775}
776
777static struct damon_ctx *dbgfs_new_ctx(void)
778{
779 struct damon_ctx *ctx;
780
781 ctx = damon_new_ctx();
782 if (!ctx)
783 return NULL;
784
4a20865b
SP
785 if (damon_select_ops(ctx, DAMON_OPS_VADDR) &&
786 damon_select_ops(ctx, DAMON_OPS_PADDR)) {
da7aaca0
SP
787 damon_destroy_ctx(ctx);
788 return NULL;
789 }
4bc05954
SP
790 ctx->callback.before_terminate = dbgfs_before_terminate;
791 return ctx;
792}
793
75c1c2b5
SP
794static void dbgfs_destroy_ctx(struct damon_ctx *ctx)
795{
796 damon_destroy_ctx(ctx);
797}
798
799/*
800 * Make a context of @name and create a debugfs directory for it.
801 *
802 * This function should be called while holding damon_dbgfs_lock.
803 *
804 * Returns 0 on success, negative error code otherwise.
805 */
806static int dbgfs_mk_context(char *name)
807{
808 struct dentry *root, **new_dirs, *new_dir;
809 struct damon_ctx **new_ctxs, *new_ctx;
810
811 if (damon_nr_running_ctxs())
812 return -EBUSY;
813
814 new_ctxs = krealloc(dbgfs_ctxs, sizeof(*dbgfs_ctxs) *
815 (dbgfs_nr_ctxs + 1), GFP_KERNEL);
816 if (!new_ctxs)
817 return -ENOMEM;
818 dbgfs_ctxs = new_ctxs;
819
820 new_dirs = krealloc(dbgfs_dirs, sizeof(*dbgfs_dirs) *
821 (dbgfs_nr_ctxs + 1), GFP_KERNEL);
822 if (!new_dirs)
823 return -ENOMEM;
824 dbgfs_dirs = new_dirs;
825
826 root = dbgfs_dirs[0];
827 if (!root)
828 return -ENOENT;
829
830 new_dir = debugfs_create_dir(name, root);
d26f6070
BP
831 /* Below check is required for a potential duplicated name case */
832 if (IS_ERR(new_dir))
833 return PTR_ERR(new_dir);
75c1c2b5
SP
834 dbgfs_dirs[dbgfs_nr_ctxs] = new_dir;
835
836 new_ctx = dbgfs_new_ctx();
837 if (!new_ctx) {
838 debugfs_remove(new_dir);
839 dbgfs_dirs[dbgfs_nr_ctxs] = NULL;
840 return -ENOMEM;
841 }
842
843 dbgfs_ctxs[dbgfs_nr_ctxs] = new_ctx;
844 dbgfs_fill_ctx_dir(dbgfs_dirs[dbgfs_nr_ctxs],
845 dbgfs_ctxs[dbgfs_nr_ctxs]);
846 dbgfs_nr_ctxs++;
847
848 return 0;
849}
850
851static ssize_t dbgfs_mk_context_write(struct file *file,
852 const char __user *buf, size_t count, loff_t *ppos)
853{
854 char *kbuf;
855 char *ctx_name;
9210622a 856 ssize_t ret;
75c1c2b5
SP
857
858 kbuf = user_input_str(buf, count, ppos);
859 if (IS_ERR(kbuf))
860 return PTR_ERR(kbuf);
861 ctx_name = kmalloc(count + 1, GFP_KERNEL);
862 if (!ctx_name) {
863 kfree(kbuf);
864 return -ENOMEM;
865 }
866
867 /* Trim white space */
868 if (sscanf(kbuf, "%s", ctx_name) != 1) {
869 ret = -EINVAL;
870 goto out;
871 }
872
873 mutex_lock(&damon_dbgfs_lock);
9210622a
RW
874 ret = dbgfs_mk_context(ctx_name);
875 if (!ret)
876 ret = count;
75c1c2b5
SP
877 mutex_unlock(&damon_dbgfs_lock);
878
879out:
880 kfree(kbuf);
881 kfree(ctx_name);
882 return ret;
883}
884
885/*
886 * Remove a context of @name and its debugfs directory.
887 *
888 * This function should be called while holding damon_dbgfs_lock.
889 *
890 * Return 0 on success, negative error code otherwise.
891 */
892static int dbgfs_rm_context(char *name)
893{
894 struct dentry *root, *dir, **new_dirs;
895 struct damon_ctx **new_ctxs;
896 int i, j;
1552fd3e 897 int ret = 0;
75c1c2b5
SP
898
899 if (damon_nr_running_ctxs())
900 return -EBUSY;
901
902 root = dbgfs_dirs[0];
903 if (!root)
904 return -ENOENT;
905
906 dir = debugfs_lookup(name, root);
907 if (!dir)
908 return -ENOENT;
909
910 new_dirs = kmalloc_array(dbgfs_nr_ctxs - 1, sizeof(*dbgfs_dirs),
911 GFP_KERNEL);
1552fd3e
GKH
912 if (!new_dirs) {
913 ret = -ENOMEM;
914 goto out_dput;
915 }
75c1c2b5
SP
916
917 new_ctxs = kmalloc_array(dbgfs_nr_ctxs - 1, sizeof(*dbgfs_ctxs),
918 GFP_KERNEL);
919 if (!new_ctxs) {
1552fd3e
GKH
920 ret = -ENOMEM;
921 goto out_new_dirs;
75c1c2b5
SP
922 }
923
924 for (i = 0, j = 0; i < dbgfs_nr_ctxs; i++) {
925 if (dbgfs_dirs[i] == dir) {
926 debugfs_remove(dbgfs_dirs[i]);
927 dbgfs_destroy_ctx(dbgfs_ctxs[i]);
928 continue;
929 }
930 new_dirs[j] = dbgfs_dirs[i];
931 new_ctxs[j++] = dbgfs_ctxs[i];
932 }
933
934 kfree(dbgfs_dirs);
935 kfree(dbgfs_ctxs);
936
937 dbgfs_dirs = new_dirs;
938 dbgfs_ctxs = new_ctxs;
939 dbgfs_nr_ctxs--;
940
1552fd3e
GKH
941 goto out_dput;
942
943out_new_dirs:
944 kfree(new_dirs);
945out_dput:
946 dput(dir);
947 return ret;
75c1c2b5
SP
948}
949
950static ssize_t dbgfs_rm_context_write(struct file *file,
951 const char __user *buf, size_t count, loff_t *ppos)
952{
953 char *kbuf;
9210622a 954 ssize_t ret;
75c1c2b5
SP
955 char *ctx_name;
956
957 kbuf = user_input_str(buf, count, ppos);
958 if (IS_ERR(kbuf))
959 return PTR_ERR(kbuf);
960 ctx_name = kmalloc(count + 1, GFP_KERNEL);
961 if (!ctx_name) {
962 kfree(kbuf);
963 return -ENOMEM;
964 }
965
966 /* Trim white space */
967 if (sscanf(kbuf, "%s", ctx_name) != 1) {
968 ret = -EINVAL;
969 goto out;
970 }
971
972 mutex_lock(&damon_dbgfs_lock);
9210622a
RW
973 ret = dbgfs_rm_context(ctx_name);
974 if (!ret)
975 ret = count;
75c1c2b5
SP
976 mutex_unlock(&damon_dbgfs_lock);
977
978out:
979 kfree(kbuf);
980 kfree(ctx_name);
981 return ret;
982}
983
4bc05954
SP
984static ssize_t dbgfs_monitor_on_read(struct file *file,
985 char __user *buf, size_t count, loff_t *ppos)
986{
987 char monitor_on_buf[5];
988 bool monitor_on = damon_nr_running_ctxs() != 0;
989 int len;
990
991 len = scnprintf(monitor_on_buf, 5, monitor_on ? "on\n" : "off\n");
992
993 return simple_read_from_buffer(buf, count, ppos, monitor_on_buf, len);
994}
995
996static ssize_t dbgfs_monitor_on_write(struct file *file,
997 const char __user *buf, size_t count, loff_t *ppos)
998{
9210622a 999 ssize_t ret;
4bc05954 1000 char *kbuf;
4bc05954
SP
1001
1002 kbuf = user_input_str(buf, count, ppos);
1003 if (IS_ERR(kbuf))
1004 return PTR_ERR(kbuf);
1005
1006 /* Remove white space */
1007 if (sscanf(kbuf, "%s", kbuf) != 1) {
1008 kfree(kbuf);
1009 return -EINVAL;
1010 }
1011
d78f3853 1012 mutex_lock(&damon_dbgfs_lock);
b5ca3e83
XH
1013 if (!strncmp(kbuf, "on", count)) {
1014 int i;
1015
1016 for (i = 0; i < dbgfs_nr_ctxs; i++) {
1017 if (damon_targets_empty(dbgfs_ctxs[i])) {
1018 kfree(kbuf);
d78f3853 1019 mutex_unlock(&damon_dbgfs_lock);
b5ca3e83
XH
1020 return -EINVAL;
1021 }
1022 }
8b9b0d33 1023 ret = damon_start(dbgfs_ctxs, dbgfs_nr_ctxs, true);
b5ca3e83 1024 } else if (!strncmp(kbuf, "off", count)) {
9210622a 1025 ret = damon_stop(dbgfs_ctxs, dbgfs_nr_ctxs);
b5ca3e83 1026 } else {
9210622a 1027 ret = -EINVAL;
b5ca3e83 1028 }
d78f3853 1029 mutex_unlock(&damon_dbgfs_lock);
4bc05954 1030
9210622a
RW
1031 if (!ret)
1032 ret = count;
4bc05954
SP
1033 kfree(kbuf);
1034 return ret;
1035}
1036
75c1c2b5
SP
1037static const struct file_operations mk_contexts_fops = {
1038 .write = dbgfs_mk_context_write,
1039};
1040
1041static const struct file_operations rm_contexts_fops = {
1042 .write = dbgfs_rm_context_write,
1043};
1044
4bc05954
SP
1045static const struct file_operations monitor_on_fops = {
1046 .read = dbgfs_monitor_on_read,
1047 .write = dbgfs_monitor_on_write,
1048};
1049
1050static int __init __damon_dbgfs_init(void)
1051{
1052 struct dentry *dbgfs_root;
75c1c2b5
SP
1053 const char * const file_names[] = {"mk_contexts", "rm_contexts",
1054 "monitor_on"};
1055 const struct file_operations *fops[] = {&mk_contexts_fops,
1056 &rm_contexts_fops, &monitor_on_fops};
4bc05954
SP
1057 int i;
1058
1059 dbgfs_root = debugfs_create_dir("damon", NULL);
1060
1061 for (i = 0; i < ARRAY_SIZE(file_names); i++)
1062 debugfs_create_file(file_names[i], 0600, dbgfs_root, NULL,
1063 fops[i]);
1064 dbgfs_fill_ctx_dir(dbgfs_root, dbgfs_ctxs[0]);
1065
b2d4c646 1066 dbgfs_dirs = kmalloc(sizeof(dbgfs_root), GFP_KERNEL);
4bc05954
SP
1067 if (!dbgfs_dirs) {
1068 debugfs_remove(dbgfs_root);
1069 return -ENOMEM;
1070 }
1071 dbgfs_dirs[0] = dbgfs_root;
1072
1073 return 0;
1074}
1075
1076/*
1077 * Functions for the initialization
1078 */
1079
1080static int __init damon_dbgfs_init(void)
1081{
d78f3853 1082 int rc = -ENOMEM;
4bc05954 1083
d78f3853 1084 mutex_lock(&damon_dbgfs_lock);
4bc05954
SP
1085 dbgfs_ctxs = kmalloc(sizeof(*dbgfs_ctxs), GFP_KERNEL);
1086 if (!dbgfs_ctxs)
d78f3853 1087 goto out;
4bc05954
SP
1088 dbgfs_ctxs[0] = dbgfs_new_ctx();
1089 if (!dbgfs_ctxs[0]) {
1090 kfree(dbgfs_ctxs);
d78f3853 1091 goto out;
4bc05954
SP
1092 }
1093 dbgfs_nr_ctxs = 1;
1094
1095 rc = __damon_dbgfs_init();
1096 if (rc) {
1097 kfree(dbgfs_ctxs[0]);
1098 kfree(dbgfs_ctxs);
1099 pr_err("%s: dbgfs init failed\n", __func__);
1100 }
1101
d78f3853
SP
1102out:
1103 mutex_unlock(&damon_dbgfs_lock);
4bc05954
SP
1104 return rc;
1105}
1106
1107module_init(damon_dbgfs_init);
17ccae8b
SP
1108
1109#include "dbgfs-test.h"