mm/damon/sysfs.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * DAMON sysfs Interface
   4  *
   5  * Copyright (c) 2022 SeongJae Park <sj@kernel.org>
   6  */
   7
   8 #include <linux/pid.h>
   9 #include <linux/sched.h>
  10 #include <linux/slab.h>
  11
  12 #include "sysfs-common.h"
  13
  14 /*
  15  * init region directory
  16  */
  17
  18 struct damon_sysfs_region {
  19         struct kobject kobj;
  20         struct damon_addr_range ar;
  21 };
  22
  23 static struct damon_sysfs_region *damon_sysfs_region_alloc(void)
  24 {
  25         return kzalloc(sizeof(struct damon_sysfs_region), GFP_KERNEL);
  26 }
  27
  28 static ssize_t start_show(struct kobject *kobj, struct kobj_attribute *attr,
  29                 char *buf)
  30 {
  31         struct damon_sysfs_region *region = container_of(kobj,
  32                         struct damon_sysfs_region, kobj);
  33
  34         return sysfs_emit(buf, "%lu\n", region->ar.start);
  35 }
  36
  37 static ssize_t start_store(struct kobject *kobj, struct kobj_attribute *attr,
  38                 const char *buf, size_t count)
  39 {
  40         struct damon_sysfs_region *region = container_of(kobj,
  41                         struct damon_sysfs_region, kobj);
  42         int err = kstrtoul(buf, 0, &region->ar.start);
  43
  44         return err ? err : count;
  45 }
  46
  47 static ssize_t end_show(struct kobject *kobj, struct kobj_attribute *attr,
  48                 char *buf)
  49 {
  50         struct damon_sysfs_region *region = container_of(kobj,
  51                         struct damon_sysfs_region, kobj);
  52
  53         return sysfs_emit(buf, "%lu\n", region->ar.end);
  54 }
  55
  56 static ssize_t end_store(struct kobject *kobj, struct kobj_attribute *attr,
  57                 const char *buf, size_t count)
  58 {
  59         struct damon_sysfs_region *region = container_of(kobj,
  60                         struct damon_sysfs_region, kobj);
  61         int err = kstrtoul(buf, 0, &region->ar.end);
  62
  63         return err ? err : count;
  64 }
  65
  66 static void damon_sysfs_region_release(struct kobject *kobj)
  67 {
  68         kfree(container_of(kobj, struct damon_sysfs_region, kobj));
  69 }
  70
  71 static struct kobj_attribute damon_sysfs_region_start_attr =
  72                 __ATTR_RW_MODE(start, 0600);
  73
  74 static struct kobj_attribute damon_sysfs_region_end_attr =
  75                 __ATTR_RW_MODE(end, 0600);
  76
  77 static struct attribute *damon_sysfs_region_attrs[] = {
  78         &damon_sysfs_region_start_attr.attr,
  79         &damon_sysfs_region_end_attr.attr,
  80         NULL,
  81 };
  82 ATTRIBUTE_GROUPS(damon_sysfs_region);
  83
  84 static const struct kobj_type damon_sysfs_region_ktype = {
  85         .release = damon_sysfs_region_release,
  86         .sysfs_ops = &kobj_sysfs_ops,
  87         .default_groups = damon_sysfs_region_groups,
  88 };
  89
  90 /*
  91  * init_regions directory
  92  */
  93
  94 struct damon_sysfs_regions {
  95         struct kobject kobj;
  96         struct damon_sysfs_region **regions_arr;
  97         int nr;
  98 };
  99
 100 static struct damon_sysfs_regions *damon_sysfs_regions_alloc(void)
 101 {
 102         return kzalloc(sizeof(struct damon_sysfs_regions), GFP_KERNEL);
 103 }
 104
 105 static void damon_sysfs_regions_rm_dirs(struct damon_sysfs_regions *regions)
 106 {
 107         struct damon_sysfs_region **regions_arr = regions->regions_arr;
 108         int i;
 109
 110         for (i = 0; i < regions->nr; i++)
 111                 kobject_put(&regions_arr[i]->kobj);
 112         regions->nr = 0;
 113         kfree(regions_arr);
 114         regions->regions_arr = NULL;
 115 }
 116
 117 static int damon_sysfs_regions_add_dirs(struct damon_sysfs_regions *regions,
 118                 int nr_regions)
 119 {
 120         struct damon_sysfs_region **regions_arr, *region;
 121         int err, i;
 122
 123         damon_sysfs_regions_rm_dirs(regions);
 124         if (!nr_regions)
 125                 return 0;
 126
 127         regions_arr = kmalloc_array(nr_regions, sizeof(*regions_arr),
 128                         GFP_KERNEL | __GFP_NOWARN);
 129         if (!regions_arr)
 130                 return -ENOMEM;
 131         regions->regions_arr = regions_arr;
 132
 133         for (i = 0; i < nr_regions; i++) {
 134                 region = damon_sysfs_region_alloc();
 135                 if (!region) {
 136                         damon_sysfs_regions_rm_dirs(regions);
 137                         return -ENOMEM;
 138                 }
 139
 140                 err = kobject_init_and_add(&region->kobj,
 141                                 &damon_sysfs_region_ktype, &regions->kobj,
 142                                 "%d", i);
 143                 if (err) {
 144                         kobject_put(&region->kobj);
 145                         damon_sysfs_regions_rm_dirs(regions);
 146                         return err;
 147                 }
 148
 149                 regions_arr[i] = region;
 150                 regions->nr++;
 151         }
 152         return 0;
 153 }
 154
 155 static ssize_t nr_regions_show(struct kobject *kobj,
 156                 struct kobj_attribute *attr, char *buf)
 157 {
 158         struct damon_sysfs_regions *regions = container_of(kobj,
 159                         struct damon_sysfs_regions, kobj);
 160
 161         return sysfs_emit(buf, "%d\n", regions->nr);
 162 }
 163
 164 static ssize_t nr_regions_store(struct kobject *kobj,
 165                 struct kobj_attribute *attr, const char *buf, size_t count)
 166 {
 167         struct damon_sysfs_regions *regions;
 168         int nr, err = kstrtoint(buf, 0, &nr);
 169
 170         if (err)
 171                 return err;
 172         if (nr < 0)
 173                 return -EINVAL;
 174
 175         regions = container_of(kobj, struct damon_sysfs_regions, kobj);
 176
 177         if (!mutex_trylock(&damon_sysfs_lock))
 178                 return -EBUSY;
 179         err = damon_sysfs_regions_add_dirs(regions, nr);
 180         mutex_unlock(&damon_sysfs_lock);
 181         if (err)
 182                 return err;
 183
 184         return count;
 185 }
 186
 187 static void damon_sysfs_regions_release(struct kobject *kobj)
 188 {
 189         kfree(container_of(kobj, struct damon_sysfs_regions, kobj));
 190 }
 191
 192 static struct kobj_attribute damon_sysfs_regions_nr_attr =
 193                 __ATTR_RW_MODE(nr_regions, 0600);
 194
 195 static struct attribute *damon_sysfs_regions_attrs[] = {
 196         &damon_sysfs_regions_nr_attr.attr,
 197         NULL,
 198 };
 199 ATTRIBUTE_GROUPS(damon_sysfs_regions);
 200
 201 static const struct kobj_type damon_sysfs_regions_ktype = {
 202         .release = damon_sysfs_regions_release,
 203         .sysfs_ops = &kobj_sysfs_ops,
 204         .default_groups = damon_sysfs_regions_groups,
 205 };
 206
 207 /*
 208  * target directory
 209  */
 210
 211 struct damon_sysfs_target {
 212         struct kobject kobj;
 213         struct damon_sysfs_regions *regions;
 214         int pid;
 215 };
 216
 217 static struct damon_sysfs_target *damon_sysfs_target_alloc(void)
 218 {
 219         return kzalloc(sizeof(struct damon_sysfs_target), GFP_KERNEL);
 220 }
 221
 222 static int damon_sysfs_target_add_dirs(struct damon_sysfs_target *target)
 223 {
 224         struct damon_sysfs_regions *regions = damon_sysfs_regions_alloc();
 225         int err;
 226
 227         if (!regions)
 228                 return -ENOMEM;
 229
 230         err = kobject_init_and_add(&regions->kobj, &damon_sysfs_regions_ktype,
 231                         &target->kobj, "regions");
 232         if (err)
 233                 kobject_put(&regions->kobj);
 234         else
 235                 target->regions = regions;
 236         return err;
 237 }
 238
 239 static void damon_sysfs_target_rm_dirs(struct damon_sysfs_target *target)
 240 {
 241         damon_sysfs_regions_rm_dirs(target->regions);
 242         kobject_put(&target->regions->kobj);
 243 }
 244
 245 static ssize_t pid_target_show(struct kobject *kobj,
 246                 struct kobj_attribute *attr, char *buf)
 247 {
 248         struct damon_sysfs_target *target = container_of(kobj,
 249                         struct damon_sysfs_target, kobj);
 250
 251         return sysfs_emit(buf, "%d\n", target->pid);
 252 }
 253
 254 static ssize_t pid_target_store(struct kobject *kobj,
 255                 struct kobj_attribute *attr, const char *buf, size_t count)
 256 {
 257         struct damon_sysfs_target *target = container_of(kobj,
 258                         struct damon_sysfs_target, kobj);
 259         int err = kstrtoint(buf, 0, &target->pid);
 260
 261         if (err)
 262                 return -EINVAL;
 263         return count;
 264 }
 265
 266 static void damon_sysfs_target_release(struct kobject *kobj)
 267 {
 268         kfree(container_of(kobj, struct damon_sysfs_target, kobj));
 269 }
 270
 271 static struct kobj_attribute damon_sysfs_target_pid_attr =
 272                 __ATTR_RW_MODE(pid_target, 0600);
 273
 274 static struct attribute *damon_sysfs_target_attrs[] = {
 275         &damon_sysfs_target_pid_attr.attr,
 276         NULL,
 277 };
 278 ATTRIBUTE_GROUPS(damon_sysfs_target);
 279
 280 static const struct kobj_type damon_sysfs_target_ktype = {
 281         .release = damon_sysfs_target_release,
 282         .sysfs_ops = &kobj_sysfs_ops,
 283         .default_groups = damon_sysfs_target_groups,
 284 };
 285
 286 /*
 287  * targets directory
 288  */
 289
 290 struct damon_sysfs_targets {
 291         struct kobject kobj;
 292         struct damon_sysfs_target **targets_arr;
 293         int nr;
 294 };
 295
 296 static struct damon_sysfs_targets *damon_sysfs_targets_alloc(void)
 297 {
 298         return kzalloc(sizeof(struct damon_sysfs_targets), GFP_KERNEL);
 299 }
 300
 301 static void damon_sysfs_targets_rm_dirs(struct damon_sysfs_targets *targets)
 302 {
 303         struct damon_sysfs_target **targets_arr = targets->targets_arr;
 304         int i;
 305
 306         for (i = 0; i < targets->nr; i++) {
 307                 damon_sysfs_target_rm_dirs(targets_arr[i]);
 308                 kobject_put(&targets_arr[i]->kobj);
 309         }
 310         targets->nr = 0;
 311         kfree(targets_arr);
 312         targets->targets_arr = NULL;
 313 }
 314
 315 static int damon_sysfs_targets_add_dirs(struct damon_sysfs_targets *targets,
 316                 int nr_targets)
 317 {
 318         struct damon_sysfs_target **targets_arr, *target;
 319         int err, i;
 320
 321         damon_sysfs_targets_rm_dirs(targets);
 322         if (!nr_targets)
 323                 return 0;
 324
 325         targets_arr = kmalloc_array(nr_targets, sizeof(*targets_arr),
 326                         GFP_KERNEL | __GFP_NOWARN);
 327         if (!targets_arr)
 328                 return -ENOMEM;
 329         targets->targets_arr = targets_arr;
 330
 331         for (i = 0; i < nr_targets; i++) {
 332                 target = damon_sysfs_target_alloc();
 333                 if (!target) {
 334                         damon_sysfs_targets_rm_dirs(targets);
 335                         return -ENOMEM;
 336                 }
 337
 338                 err = kobject_init_and_add(&target->kobj,
 339                                 &damon_sysfs_target_ktype, &targets->kobj,
 340                                 "%d", i);
 341                 if (err)
 342                         goto out;
 343
 344                 err = damon_sysfs_target_add_dirs(target);
 345                 if (err)
 346                         goto out;
 347
 348                 targets_arr[i] = target;
 349                 targets->nr++;
 350         }
 351         return 0;
 352
 353 out:
 354         damon_sysfs_targets_rm_dirs(targets);
 355         kobject_put(&target->kobj);
 356         return err;
 357 }
 358
 359 static ssize_t nr_targets_show(struct kobject *kobj,
 360                 struct kobj_attribute *attr, char *buf)
 361 {
 362         struct damon_sysfs_targets *targets = container_of(kobj,
 363                         struct damon_sysfs_targets, kobj);
 364
 365         return sysfs_emit(buf, "%d\n", targets->nr);
 366 }
 367
 368 static ssize_t nr_targets_store(struct kobject *kobj,
 369                 struct kobj_attribute *attr, const char *buf, size_t count)
 370 {
 371         struct damon_sysfs_targets *targets;
 372         int nr, err = kstrtoint(buf, 0, &nr);
 373
 374         if (err)
 375                 return err;
 376         if (nr < 0)
 377                 return -EINVAL;
 378
 379         targets = container_of(kobj, struct damon_sysfs_targets, kobj);
 380
 381         if (!mutex_trylock(&damon_sysfs_lock))
 382                 return -EBUSY;
 383         err = damon_sysfs_targets_add_dirs(targets, nr);
 384         mutex_unlock(&damon_sysfs_lock);
 385         if (err)
 386                 return err;
 387
 388         return count;
 389 }
 390
 391 static void damon_sysfs_targets_release(struct kobject *kobj)
 392 {
 393         kfree(container_of(kobj, struct damon_sysfs_targets, kobj));
 394 }
 395
 396 static struct kobj_attribute damon_sysfs_targets_nr_attr =
 397                 __ATTR_RW_MODE(nr_targets, 0600);
 398
 399 static struct attribute *damon_sysfs_targets_attrs[] = {
 400         &damon_sysfs_targets_nr_attr.attr,
 401         NULL,
 402 };
 403 ATTRIBUTE_GROUPS(damon_sysfs_targets);
 404
 405 static const struct kobj_type damon_sysfs_targets_ktype = {
 406         .release = damon_sysfs_targets_release,
 407         .sysfs_ops = &kobj_sysfs_ops,
 408         .default_groups = damon_sysfs_targets_groups,
 409 };
 410
 411 /*
 412  * intervals directory
 413  */
 414
 415 struct damon_sysfs_intervals {
 416         struct kobject kobj;
 417         unsigned long sample_us;
 418         unsigned long aggr_us;
 419         unsigned long update_us;
 420 };
 421
 422 static struct damon_sysfs_intervals *damon_sysfs_intervals_alloc(
 423                 unsigned long sample_us, unsigned long aggr_us,
 424                 unsigned long update_us)
 425 {
 426         struct damon_sysfs_intervals *intervals = kmalloc(sizeof(*intervals),
 427                         GFP_KERNEL);
 428
 429         if (!intervals)
 430                 return NULL;
 431
 432         intervals->kobj = (struct kobject){};
 433         intervals->sample_us = sample_us;
 434         intervals->aggr_us = aggr_us;
 435         intervals->update_us = update_us;
 436         return intervals;
 437 }
 438
 439 static ssize_t sample_us_show(struct kobject *kobj,
 440                 struct kobj_attribute *attr, char *buf)
 441 {
 442         struct damon_sysfs_intervals *intervals = container_of(kobj,
 443                         struct damon_sysfs_intervals, kobj);
 444
 445         return sysfs_emit(buf, "%lu\n", intervals->sample_us);
 446 }
 447
 448 static ssize_t sample_us_store(struct kobject *kobj,
 449                 struct kobj_attribute *attr, const char *buf, size_t count)
 450 {
 451         struct damon_sysfs_intervals *intervals = container_of(kobj,
 452                         struct damon_sysfs_intervals, kobj);
 453         unsigned long us;
 454         int err = kstrtoul(buf, 0, &us);
 455
 456         if (err)
 457                 return err;
 458
 459         intervals->sample_us = us;
 460         return count;
 461 }
 462
 463 static ssize_t aggr_us_show(struct kobject *kobj, struct kobj_attribute *attr,
 464                 char *buf)
 465 {
 466         struct damon_sysfs_intervals *intervals = container_of(kobj,
 467                         struct damon_sysfs_intervals, kobj);
 468
 469         return sysfs_emit(buf, "%lu\n", intervals->aggr_us);
 470 }
 471
 472 static ssize_t aggr_us_store(struct kobject *kobj, struct kobj_attribute *attr,
 473                 const char *buf, size_t count)
 474 {
 475         struct damon_sysfs_intervals *intervals = container_of(kobj,
 476                         struct damon_sysfs_intervals, kobj);
 477         unsigned long us;
 478         int err = kstrtoul(buf, 0, &us);
 479
 480         if (err)
 481                 return err;
 482
 483         intervals->aggr_us = us;
 484         return count;
 485 }
 486
 487 static ssize_t update_us_show(struct kobject *kobj,
 488                 struct kobj_attribute *attr, char *buf)
 489 {
 490         struct damon_sysfs_intervals *intervals = container_of(kobj,
 491                         struct damon_sysfs_intervals, kobj);
 492
 493         return sysfs_emit(buf, "%lu\n", intervals->update_us);
 494 }
 495
 496 static ssize_t update_us_store(struct kobject *kobj,
 497                 struct kobj_attribute *attr, const char *buf, size_t count)
 498 {
 499         struct damon_sysfs_intervals *intervals = container_of(kobj,
 500                         struct damon_sysfs_intervals, kobj);
 501         unsigned long us;
 502         int err = kstrtoul(buf, 0, &us);
 503
 504         if (err)
 505                 return err;
 506
 507         intervals->update_us = us;
 508         return count;
 509 }
 510
 511 static void damon_sysfs_intervals_release(struct kobject *kobj)
 512 {
 513         kfree(container_of(kobj, struct damon_sysfs_intervals, kobj));
 514 }
 515
 516 static struct kobj_attribute damon_sysfs_intervals_sample_us_attr =
 517                 __ATTR_RW_MODE(sample_us, 0600);
 518
 519 static struct kobj_attribute damon_sysfs_intervals_aggr_us_attr =
 520                 __ATTR_RW_MODE(aggr_us, 0600);
 521
 522 static struct kobj_attribute damon_sysfs_intervals_update_us_attr =
 523                 __ATTR_RW_MODE(update_us, 0600);
 524
 525 static struct attribute *damon_sysfs_intervals_attrs[] = {
 526         &damon_sysfs_intervals_sample_us_attr.attr,
 527         &damon_sysfs_intervals_aggr_us_attr.attr,
 528         &damon_sysfs_intervals_update_us_attr.attr,
 529         NULL,
 530 };
 531 ATTRIBUTE_GROUPS(damon_sysfs_intervals);
 532
 533 static const struct kobj_type damon_sysfs_intervals_ktype = {
 534         .release = damon_sysfs_intervals_release,
 535         .sysfs_ops = &kobj_sysfs_ops,
 536         .default_groups = damon_sysfs_intervals_groups,
 537 };
 538
 539 /*
 540  * monitoring_attrs directory
 541  */
 542
 543 struct damon_sysfs_attrs {
 544         struct kobject kobj;
 545         struct damon_sysfs_intervals *intervals;
 546         struct damon_sysfs_ul_range *nr_regions_range;
 547 };
 548
 549 static struct damon_sysfs_attrs *damon_sysfs_attrs_alloc(void)
 550 {
 551         struct damon_sysfs_attrs *attrs = kmalloc(sizeof(*attrs), GFP_KERNEL);
 552
 553         if (!attrs)
 554                 return NULL;
 555         attrs->kobj = (struct kobject){};
 556         return attrs;
 557 }
 558
 559 static int damon_sysfs_attrs_add_dirs(struct damon_sysfs_attrs *attrs)
 560 {
 561         struct damon_sysfs_intervals *intervals;
 562         struct damon_sysfs_ul_range *nr_regions_range;
 563         int err;
 564
 565         intervals = damon_sysfs_intervals_alloc(5000, 100000, 60000000);
 566         if (!intervals)
 567                 return -ENOMEM;
 568
 569         err = kobject_init_and_add(&intervals->kobj,
 570                         &damon_sysfs_intervals_ktype, &attrs->kobj,
 571                         "intervals");
 572         if (err)
 573                 goto put_intervals_out;
 574         attrs->intervals = intervals;
 575
 576         nr_regions_range = damon_sysfs_ul_range_alloc(10, 1000);
 577         if (!nr_regions_range) {
 578                 err = -ENOMEM;
 579                 goto put_intervals_out;
 580         }
 581
 582         err = kobject_init_and_add(&nr_regions_range->kobj,
 583                         &damon_sysfs_ul_range_ktype, &attrs->kobj,
 584                         "nr_regions");
 585         if (err)
 586                 goto put_nr_regions_intervals_out;
 587         attrs->nr_regions_range = nr_regions_range;
 588         return 0;
 589
 590 put_nr_regions_intervals_out:
 591         kobject_put(&nr_regions_range->kobj);
 592         attrs->nr_regions_range = NULL;
 593 put_intervals_out:
 594         kobject_put(&intervals->kobj);
 595         attrs->intervals = NULL;
 596         return err;
 597 }
 598
 599 static void damon_sysfs_attrs_rm_dirs(struct damon_sysfs_attrs *attrs)
 600 {
 601         kobject_put(&attrs->nr_regions_range->kobj);
 602         kobject_put(&attrs->intervals->kobj);
 603 }
 604
 605 static void damon_sysfs_attrs_release(struct kobject *kobj)
 606 {
 607         kfree(container_of(kobj, struct damon_sysfs_attrs, kobj));
 608 }
 609
 610 static struct attribute *damon_sysfs_attrs_attrs[] = {
 611         NULL,
 612 };
 613 ATTRIBUTE_GROUPS(damon_sysfs_attrs);
 614
 615 static const struct kobj_type damon_sysfs_attrs_ktype = {
 616         .release = damon_sysfs_attrs_release,
 617         .sysfs_ops = &kobj_sysfs_ops,
 618         .default_groups = damon_sysfs_attrs_groups,
 619 };
 620
 621 /*
 622  * context directory
 623  */
 624
 625 /* This should match with enum damon_ops_id */
 626 static const char * const damon_sysfs_ops_strs[] = {
 627         "vaddr",
 628         "fvaddr",
 629         "paddr",
 630 };
 631
 632 struct damon_sysfs_context {
 633         struct kobject kobj;
 634         enum damon_ops_id ops_id;
 635         struct damon_sysfs_attrs *attrs;
 636         struct damon_sysfs_targets *targets;
 637         struct damon_sysfs_schemes *schemes;
 638 };
 639
 640 static struct damon_sysfs_context *damon_sysfs_context_alloc(
 641                 enum damon_ops_id ops_id)
 642 {
 643         struct damon_sysfs_context *context = kmalloc(sizeof(*context),
 644                                 GFP_KERNEL);
 645
 646         if (!context)
 647                 return NULL;
 648         context->kobj = (struct kobject){};
 649         context->ops_id = ops_id;
 650         return context;
 651 }
 652
 653 static int damon_sysfs_context_set_attrs(struct damon_sysfs_context *context)
 654 {
 655         struct damon_sysfs_attrs *attrs = damon_sysfs_attrs_alloc();
 656         int err;
 657
 658         if (!attrs)
 659                 return -ENOMEM;
 660         err = kobject_init_and_add(&attrs->kobj, &damon_sysfs_attrs_ktype,
 661                         &context->kobj, "monitoring_attrs");
 662         if (err)
 663                 goto out;
 664         err = damon_sysfs_attrs_add_dirs(attrs);
 665         if (err)
 666                 goto out;
 667         context->attrs = attrs;
 668         return 0;
 669
 670 out:
 671         kobject_put(&attrs->kobj);
 672         return err;
 673 }
 674
 675 static int damon_sysfs_context_set_targets(struct damon_sysfs_context *context)
 676 {
 677         struct damon_sysfs_targets *targets = damon_sysfs_targets_alloc();
 678         int err;
 679
 680         if (!targets)
 681                 return -ENOMEM;
 682         err = kobject_init_and_add(&targets->kobj, &damon_sysfs_targets_ktype,
 683                         &context->kobj, "targets");
 684         if (err) {
 685                 kobject_put(&targets->kobj);
 686                 return err;
 687         }
 688         context->targets = targets;
 689         return 0;
 690 }
 691
 692 static int damon_sysfs_context_set_schemes(struct damon_sysfs_context *context)
 693 {
 694         struct damon_sysfs_schemes *schemes = damon_sysfs_schemes_alloc();
 695         int err;
 696
 697         if (!schemes)
 698                 return -ENOMEM;
 699         err = kobject_init_and_add(&schemes->kobj, &damon_sysfs_schemes_ktype,
 700                         &context->kobj, "schemes");
 701         if (err) {
 702                 kobject_put(&schemes->kobj);
 703                 return err;
 704         }
 705         context->schemes = schemes;
 706         return 0;
 707 }
 708
 709 static int damon_sysfs_context_add_dirs(struct damon_sysfs_context *context)
 710 {
 711         int err;
 712
 713         err = damon_sysfs_context_set_attrs(context);
 714         if (err)
 715                 return err;
 716
 717         err = damon_sysfs_context_set_targets(context);
 718         if (err)
 719                 goto put_attrs_out;
 720
 721         err = damon_sysfs_context_set_schemes(context);
 722         if (err)
 723                 goto put_targets_attrs_out;
 724         return 0;
 725
 726 put_targets_attrs_out:
 727         kobject_put(&context->targets->kobj);
 728         context->targets = NULL;
 729 put_attrs_out:
 730         kobject_put(&context->attrs->kobj);
 731         context->attrs = NULL;
 732         return err;
 733 }
 734
 735 static void damon_sysfs_context_rm_dirs(struct damon_sysfs_context *context)
 736 {
 737         damon_sysfs_attrs_rm_dirs(context->attrs);
 738         kobject_put(&context->attrs->kobj);
 739         damon_sysfs_targets_rm_dirs(context->targets);
 740         kobject_put(&context->targets->kobj);
 741         damon_sysfs_schemes_rm_dirs(context->schemes);
 742         kobject_put(&context->schemes->kobj);
 743 }
 744
 745 static ssize_t avail_operations_show(struct kobject *kobj,
 746                 struct kobj_attribute *attr, char *buf)
 747 {
 748         enum damon_ops_id id;
 749         int len = 0;
 750
 751         for (id = 0; id < NR_DAMON_OPS; id++) {
 752                 if (!damon_is_registered_ops(id))
 753                         continue;
 754                 len += sysfs_emit_at(buf, len, "%s\n",
 755                                 damon_sysfs_ops_strs[id]);
 756         }
 757         return len;
 758 }
 759
 760 static ssize_t operations_show(struct kobject *kobj,
 761                 struct kobj_attribute *attr, char *buf)
 762 {
 763         struct damon_sysfs_context *context = container_of(kobj,
 764                         struct damon_sysfs_context, kobj);
 765
 766         return sysfs_emit(buf, "%s\n", damon_sysfs_ops_strs[context->ops_id]);
 767 }
 768
 769 static ssize_t operations_store(struct kobject *kobj,
 770                 struct kobj_attribute *attr, const char *buf, size_t count)
 771 {
 772         struct damon_sysfs_context *context = container_of(kobj,
 773                         struct damon_sysfs_context, kobj);
 774         enum damon_ops_id id;
 775
 776         for (id = 0; id < NR_DAMON_OPS; id++) {
 777                 if (sysfs_streq(buf, damon_sysfs_ops_strs[id])) {
 778                         context->ops_id = id;
 779                         return count;
 780                 }
 781         }
 782         return -EINVAL;
 783 }
 784
 785 static void damon_sysfs_context_release(struct kobject *kobj)
 786 {
 787         kfree(container_of(kobj, struct damon_sysfs_context, kobj));
 788 }
 789
 790 static struct kobj_attribute damon_sysfs_context_avail_operations_attr =
 791                 __ATTR_RO_MODE(avail_operations, 0400);
 792
 793 static struct kobj_attribute damon_sysfs_context_operations_attr =
 794                 __ATTR_RW_MODE(operations, 0600);
 795
 796 static struct attribute *damon_sysfs_context_attrs[] = {
 797         &damon_sysfs_context_avail_operations_attr.attr,
 798         &damon_sysfs_context_operations_attr.attr,
 799         NULL,
 800 };
 801 ATTRIBUTE_GROUPS(damon_sysfs_context);
 802
 803 static const struct kobj_type damon_sysfs_context_ktype = {
 804         .release = damon_sysfs_context_release,
 805         .sysfs_ops = &kobj_sysfs_ops,
 806         .default_groups = damon_sysfs_context_groups,
 807 };
 808
 809 /*
 810  * contexts directory
 811  */
 812
 813 struct damon_sysfs_contexts {
 814         struct kobject kobj;
 815         struct damon_sysfs_context **contexts_arr;
 816         int nr;
 817 };
 818
 819 static struct damon_sysfs_contexts *damon_sysfs_contexts_alloc(void)
 820 {
 821         return kzalloc(sizeof(struct damon_sysfs_contexts), GFP_KERNEL);
 822 }
 823
 824 static void damon_sysfs_contexts_rm_dirs(struct damon_sysfs_contexts *contexts)
 825 {
 826         struct damon_sysfs_context **contexts_arr = contexts->contexts_arr;
 827         int i;
 828
 829         for (i = 0; i < contexts->nr; i++) {
 830                 damon_sysfs_context_rm_dirs(contexts_arr[i]);
 831                 kobject_put(&contexts_arr[i]->kobj);
 832         }
 833         contexts->nr = 0;
 834         kfree(contexts_arr);
 835         contexts->contexts_arr = NULL;
 836 }
 837
 838 static int damon_sysfs_contexts_add_dirs(struct damon_sysfs_contexts *contexts,
 839                 int nr_contexts)
 840 {
 841         struct damon_sysfs_context **contexts_arr, *context;
 842         int err, i;
 843
 844         damon_sysfs_contexts_rm_dirs(contexts);
 845         if (!nr_contexts)
 846                 return 0;
 847
 848         contexts_arr = kmalloc_array(nr_contexts, sizeof(*contexts_arr),
 849                         GFP_KERNEL | __GFP_NOWARN);
 850         if (!contexts_arr)
 851                 return -ENOMEM;
 852         contexts->contexts_arr = contexts_arr;
 853
 854         for (i = 0; i < nr_contexts; i++) {
 855                 context = damon_sysfs_context_alloc(DAMON_OPS_VADDR);
 856                 if (!context) {
 857                         damon_sysfs_contexts_rm_dirs(contexts);
 858                         return -ENOMEM;
 859                 }
 860
 861                 err = kobject_init_and_add(&context->kobj,
 862                                 &damon_sysfs_context_ktype, &contexts->kobj,
 863                                 "%d", i);
 864                 if (err)
 865                         goto out;
 866
 867                 err = damon_sysfs_context_add_dirs(context);
 868                 if (err)
 869                         goto out;
 870
 871                 contexts_arr[i] = context;
 872                 contexts->nr++;
 873         }
 874         return 0;
 875
 876 out:
 877         damon_sysfs_contexts_rm_dirs(contexts);
 878         kobject_put(&context->kobj);
 879         return err;
 880 }
 881
 882 static ssize_t nr_contexts_show(struct kobject *kobj,
 883                 struct kobj_attribute *attr, char *buf)
 884 {
 885         struct damon_sysfs_contexts *contexts = container_of(kobj,
 886                         struct damon_sysfs_contexts, kobj);
 887
 888         return sysfs_emit(buf, "%d\n", contexts->nr);
 889 }
 890
 891 static ssize_t nr_contexts_store(struct kobject *kobj,
 892                 struct kobj_attribute *attr, const char *buf, size_t count)
 893 {
 894         struct damon_sysfs_contexts *contexts;
 895         int nr, err;
 896
 897         err = kstrtoint(buf, 0, &nr);
 898         if (err)
 899                 return err;
 900         /* TODO: support multiple contexts per kdamond */
 901         if (nr < 0 || 1 < nr)
 902                 return -EINVAL;
 903
 904         contexts = container_of(kobj, struct damon_sysfs_contexts, kobj);
 905         if (!mutex_trylock(&damon_sysfs_lock))
 906                 return -EBUSY;
 907         err = damon_sysfs_contexts_add_dirs(contexts, nr);
 908         mutex_unlock(&damon_sysfs_lock);
 909         if (err)
 910                 return err;
 911
 912         return count;
 913 }
 914
 915 static void damon_sysfs_contexts_release(struct kobject *kobj)
 916 {
 917         kfree(container_of(kobj, struct damon_sysfs_contexts, kobj));
 918 }
 919
 920 static struct kobj_attribute damon_sysfs_contexts_nr_attr
 921                 = __ATTR_RW_MODE(nr_contexts, 0600);
 922
 923 static struct attribute *damon_sysfs_contexts_attrs[] = {
 924         &damon_sysfs_contexts_nr_attr.attr,
 925         NULL,
 926 };
 927 ATTRIBUTE_GROUPS(damon_sysfs_contexts);
 928
 929 static const struct kobj_type damon_sysfs_contexts_ktype = {
 930         .release = damon_sysfs_contexts_release,
 931         .sysfs_ops = &kobj_sysfs_ops,
 932         .default_groups = damon_sysfs_contexts_groups,
 933 };
 934
 935 /*
 936  * kdamond directory
 937  */
 938
 939 struct damon_sysfs_kdamond {
 940         struct kobject kobj;
 941         struct damon_sysfs_contexts *contexts;
 942         struct damon_ctx *damon_ctx;
 943 };
 944
 945 static struct damon_sysfs_kdamond *damon_sysfs_kdamond_alloc(void)
 946 {
 947         return kzalloc(sizeof(struct damon_sysfs_kdamond), GFP_KERNEL);
 948 }
 949
 950 static int damon_sysfs_kdamond_add_dirs(struct damon_sysfs_kdamond *kdamond)
 951 {
 952         struct damon_sysfs_contexts *contexts;
 953         int err;
 954
 955         contexts = damon_sysfs_contexts_alloc();
 956         if (!contexts)
 957                 return -ENOMEM;
 958
 959         err = kobject_init_and_add(&contexts->kobj,
 960                         &damon_sysfs_contexts_ktype, &kdamond->kobj,
 961                         "contexts");
 962         if (err) {
 963                 kobject_put(&contexts->kobj);
 964                 return err;
 965         }
 966         kdamond->contexts = contexts;
 967
 968         return err;
 969 }
 970
 971 static void damon_sysfs_kdamond_rm_dirs(struct damon_sysfs_kdamond *kdamond)
 972 {
 973         damon_sysfs_contexts_rm_dirs(kdamond->contexts);
 974         kobject_put(&kdamond->contexts->kobj);
 975 }
 976
 977 static bool damon_sysfs_ctx_running(struct damon_ctx *ctx)
 978 {
 979         bool running;
 980
 981         mutex_lock(&ctx->kdamond_lock);
 982         running = ctx->kdamond != NULL;
 983         mutex_unlock(&ctx->kdamond_lock);
 984         return running;
 985 }
 986
 987 /*
 988  * enum damon_sysfs_cmd - Commands for a specific kdamond.
 989  */
 990 enum damon_sysfs_cmd {
 991         /* @DAMON_SYSFS_CMD_ON: Turn the kdamond on. */
 992         DAMON_SYSFS_CMD_ON,
 993         /* @DAMON_SYSFS_CMD_OFF: Turn the kdamond off. */
 994         DAMON_SYSFS_CMD_OFF,
 995         /* @DAMON_SYSFS_CMD_COMMIT: Update kdamond inputs. */
 996         DAMON_SYSFS_CMD_COMMIT,
 997         /*
 998          * @DAMON_SYSFS_CMD_COMMIT_SCHEMES_QUOTA_GOALS: Commit the quota goals
 999          * to DAMON.
1000          */
1001         DAMON_SYSFS_CMD_COMMIT_SCHEMES_QUOTA_GOALS,
1002         /*
1003          * @DAMON_SYSFS_CMD_UPDATE_SCHEMES_STATS: Update scheme stats sysfs
1004          * files.
1005          */
1006         DAMON_SYSFS_CMD_UPDATE_SCHEMES_STATS,
1007         /*
1008          * @DAMON_SYSFS_CMD_UPDATE_SCHEMES_TRIED_BYTES: Update
1009          * tried_regions/total_bytes sysfs files for each scheme.
1010          */
1011         DAMON_SYSFS_CMD_UPDATE_SCHEMES_TRIED_BYTES,
1012         /*
1013          * @DAMON_SYSFS_CMD_UPDATE_SCHEMES_TRIED_REGIONS: Update schemes tried
1014          * regions
1015          */
1016         DAMON_SYSFS_CMD_UPDATE_SCHEMES_TRIED_REGIONS,
1017         /*
1018          * @DAMON_SYSFS_CMD_CLEAR_SCHEMES_TRIED_REGIONS: Clear schemes tried
1019          * regions
1020          */
1021         DAMON_SYSFS_CMD_CLEAR_SCHEMES_TRIED_REGIONS,
1022         /*
1023          * @DAMON_SYSFS_CMD_UPDATE_SCHEMES_EFFECTIVE_QUOTAS: Update the
1024          * effective size quota of the scheme in bytes.
1025          */
1026         DAMON_SYSFS_CMD_UPDATE_SCHEMES_EFFECTIVE_QUOTAS,
1027         /*
1028          * @NR_DAMON_SYSFS_CMDS: Total number of DAMON sysfs commands.
1029          */
1030         NR_DAMON_SYSFS_CMDS,
1031 };
1032
1033 /* Should match with enum damon_sysfs_cmd */
1034 static const char * const damon_sysfs_cmd_strs[] = {
1035         "on",
1036         "off",
1037         "commit",
1038         "commit_schemes_quota_goals",
1039         "update_schemes_stats",
1040         "update_schemes_tried_bytes",
1041         "update_schemes_tried_regions",
1042         "clear_schemes_tried_regions",
1043         "update_schemes_effective_quotas",
1044 };
1045
1046 /*
1047  * struct damon_sysfs_cmd_request - A request to the DAMON callback.
1048  * @cmd:        The command that needs to be handled by the callback.
1049  * @kdamond:    The kobject wrapper that associated to the kdamond thread.
1050  *
1051  * This structure represents a sysfs command request that need to access some
1052  * DAMON context-internal data.  Because DAMON context-internal data can be
1053  * safely accessed from DAMON callbacks without additional synchronization, the
1054  * request will be handled by the DAMON callback.  None-``NULL`` @kdamond means
1055  * the request is valid.
1056  */
1057 struct damon_sysfs_cmd_request {
1058         enum damon_sysfs_cmd cmd;
1059         struct damon_sysfs_kdamond *kdamond;
1060 };
1061
1062 /* Current DAMON callback request.  Protected by damon_sysfs_lock. */
1063 static struct damon_sysfs_cmd_request damon_sysfs_cmd_request;
1064
1065 static ssize_t state_show(struct kobject *kobj, struct kobj_attribute *attr,
1066                 char *buf)
1067 {
1068         struct damon_sysfs_kdamond *kdamond = container_of(kobj,
1069                         struct damon_sysfs_kdamond, kobj);
1070         struct damon_ctx *ctx = kdamond->damon_ctx;
1071         bool running;
1072
1073         if (!ctx)
1074                 running = false;
1075         else
1076                 running = damon_sysfs_ctx_running(ctx);
1077
1078         return sysfs_emit(buf, "%s\n", running ?
1079                         damon_sysfs_cmd_strs[DAMON_SYSFS_CMD_ON] :
1080                         damon_sysfs_cmd_strs[DAMON_SYSFS_CMD_OFF]);
1081 }
1082
1083 static int damon_sysfs_set_attrs(struct damon_ctx *ctx,
1084                 struct damon_sysfs_attrs *sys_attrs)
1085 {
1086         struct damon_sysfs_intervals *sys_intervals = sys_attrs->intervals;
1087         struct damon_sysfs_ul_range *sys_nr_regions =
1088                 sys_attrs->nr_regions_range;
1089         struct damon_attrs attrs = {
1090                 .sample_interval = sys_intervals->sample_us,
1091                 .aggr_interval = sys_intervals->aggr_us,
1092                 .ops_update_interval = sys_intervals->update_us,
1093                 .min_nr_regions = sys_nr_regions->min,
1094                 .max_nr_regions = sys_nr_regions->max,
1095         };
1096         return damon_set_attrs(ctx, &attrs);
1097 }
1098
1099 static void damon_sysfs_destroy_targets(struct damon_ctx *ctx)
1100 {
1101         struct damon_target *t, *next;
1102         bool has_pid = damon_target_has_pid(ctx);
1103
1104         damon_for_each_target_safe(t, next, ctx) {
1105                 if (has_pid)
1106                         put_pid(t->pid);
1107                 damon_destroy_target(t);
1108         }
1109 }
1110
1111 static int damon_sysfs_set_regions(struct damon_target *t,
1112                 struct damon_sysfs_regions *sysfs_regions)
1113 {
1114         struct damon_addr_range *ranges = kmalloc_array(sysfs_regions->nr,
1115                         sizeof(*ranges), GFP_KERNEL | __GFP_NOWARN);
1116         int i, err = -EINVAL;
1117
1118         if (!ranges)
1119                 return -ENOMEM;
1120         for (i = 0; i < sysfs_regions->nr; i++) {
1121                 struct damon_sysfs_region *sys_region =
1122                         sysfs_regions->regions_arr[i];
1123
1124                 if (sys_region->ar.start > sys_region->ar.end)
1125                         goto out;
1126
1127                 ranges[i].start = sys_region->ar.start;
1128                 ranges[i].end = sys_region->ar.end;
1129                 if (i == 0)
1130                         continue;
1131                 if (ranges[i - 1].end > ranges[i].start)
1132                         goto out;
1133         }
1134         err = damon_set_regions(t, ranges, sysfs_regions->nr);
1135 out:
1136         kfree(ranges);
1137         return err;
1138
1139 }
1140
1141 static int damon_sysfs_add_target(struct damon_sysfs_target *sys_target,
1142                 struct damon_ctx *ctx)
1143 {
1144         struct damon_target *t = damon_new_target();
1145         int err = -EINVAL;
1146
1147         if (!t)
1148                 return -ENOMEM;
1149         damon_add_target(ctx, t);
1150         if (damon_target_has_pid(ctx)) {
1151                 t->pid = find_get_pid(sys_target->pid);
1152                 if (!t->pid)
1153                         goto destroy_targets_out;
1154         }
1155         err = damon_sysfs_set_regions(t, sys_target->regions);
1156         if (err)
1157                 goto destroy_targets_out;
1158         return 0;
1159
1160 destroy_targets_out:
1161         damon_sysfs_destroy_targets(ctx);
1162         return err;
1163 }
1164
1165 static int damon_sysfs_add_targets(struct damon_ctx *ctx,
1166                 struct damon_sysfs_targets *sysfs_targets)
1167 {
1168         int i, err;
1169
1170         /* Multiple physical address space monitoring targets makes no sense */
1171         if (ctx->ops.id == DAMON_OPS_PADDR && sysfs_targets->nr > 1)
1172                 return -EINVAL;
1173
1174         for (i = 0; i < sysfs_targets->nr; i++) {
1175                 struct damon_sysfs_target *st = sysfs_targets->targets_arr[i];
1176
1177                 err = damon_sysfs_add_target(st, ctx);
1178                 if (err)
1179                         return err;
1180         }
1181         return 0;
1182 }
1183
1184 static void damon_sysfs_before_terminate(struct damon_ctx *ctx)
1185 {
1186         struct damon_target *t, *next;
1187
1188         if (!damon_target_has_pid(ctx))
1189                 return;
1190
1191         mutex_lock(&ctx->kdamond_lock);
1192         damon_for_each_target_safe(t, next, ctx) {
1193                 put_pid(t->pid);
1194                 damon_destroy_target(t);
1195         }
1196         mutex_unlock(&ctx->kdamond_lock);
1197 }
1198
1199 /*
1200  * damon_sysfs_upd_schemes_stats() - Update schemes stats sysfs files.
1201  * @data:       The kobject wrapper that associated to the kdamond thread.
1202  *
1203  * This function reads the schemes stats of specific kdamond and update the
1204  * related values for sysfs files.  This function should be called from DAMON
1205  * worker thread,to safely access the DAMON contexts-internal data.  Caller
1206  * should also ensure holding ``damon_syfs_lock``, and ->damon_ctx of @data is
1207  * not NULL but a valid pointer, to safely access DAMON sysfs variables.
1208  */
1209 static int damon_sysfs_upd_schemes_stats(void *data)
1210 {
1211         struct damon_sysfs_kdamond *kdamond = data;
1212         struct damon_ctx *ctx = kdamond->damon_ctx;
1213
1214         damon_sysfs_schemes_update_stats(
1215                         kdamond->contexts->contexts_arr[0]->schemes, ctx);
1216         return 0;
1217 }
1218
1219 static inline bool damon_sysfs_kdamond_running(
1220                 struct damon_sysfs_kdamond *kdamond)
1221 {
1222         return kdamond->damon_ctx &&
1223                 damon_sysfs_ctx_running(kdamond->damon_ctx);
1224 }
1225
1226 static int damon_sysfs_apply_inputs(struct damon_ctx *ctx,
1227                 struct damon_sysfs_context *sys_ctx)
1228 {
1229         int err;
1230
1231         err = damon_select_ops(ctx, sys_ctx->ops_id);
1232         if (err)
1233                 return err;
1234         err = damon_sysfs_set_attrs(ctx, sys_ctx->attrs);
1235         if (err)
1236                 return err;
1237         err = damon_sysfs_add_targets(ctx, sys_ctx->targets);
1238         if (err)
1239                 return err;
1240         return damon_sysfs_add_schemes(ctx, sys_ctx->schemes);
1241 }
1242
1243 static struct damon_ctx *damon_sysfs_build_ctx(
1244                 struct damon_sysfs_context *sys_ctx);
1245
1246 /*
1247  * damon_sysfs_commit_input() - Commit user inputs to a running kdamond.
1248  * @kdamond:    The kobject wrapper for the associated kdamond.
1249  *
1250  * If the sysfs input is wrong, the kdamond will be terminated.
1251  */
1252 static int damon_sysfs_commit_input(struct damon_sysfs_kdamond *kdamond)
1253 {
1254         struct damon_ctx *param_ctx;
1255         int err;
1256
1257         if (!damon_sysfs_kdamond_running(kdamond))
1258                 return -EINVAL;
1259         /* TODO: Support multiple contexts per kdamond */
1260         if (kdamond->contexts->nr != 1)
1261                 return -EINVAL;
1262
1263         param_ctx = damon_sysfs_build_ctx(kdamond->contexts->contexts_arr[0]);
1264         if (IS_ERR(param_ctx))
1265                 return PTR_ERR(param_ctx);
1266         err = damon_commit_ctx(kdamond->damon_ctx, param_ctx);
1267         damon_sysfs_destroy_targets(param_ctx);
1268         damon_destroy_ctx(param_ctx);
1269         return err;
1270 }
1271
1272 static int damon_sysfs_commit_schemes_quota_goals(void *data)
1273 {
1274         struct damon_sysfs_kdamond *sysfs_kdamond = data;
1275         struct damon_ctx *ctx;
1276         struct damon_sysfs_context *sysfs_ctx;
1277
1278         if (!damon_sysfs_kdamond_running(sysfs_kdamond))
1279                 return -EINVAL;
1280         /* TODO: Support multiple contexts per kdamond */
1281         if (sysfs_kdamond->contexts->nr != 1)
1282                 return -EINVAL;
1283
1284         ctx = sysfs_kdamond->damon_ctx;
1285         sysfs_ctx = sysfs_kdamond->contexts->contexts_arr[0];
1286         return damos_sysfs_set_quota_scores(sysfs_ctx->schemes, ctx);
1287 }
1288
1289 /*
1290  * damon_sysfs_upd_schemes_effective_quotas() - Update schemes effective quotas
1291  * sysfs files.
1292  * @data:       The kobject wrapper that associated to the kdamond thread.
1293  *
1294  * This function reads the schemes' effective quotas of specific kdamond and
1295  * update the related values for sysfs files.  This function should be called
1296  * from DAMON callbacks while holding ``damon_syfs_lock``, to safely access the
1297  * DAMON contexts-internal data and DAMON sysfs variables.
1298  */
1299 static int damon_sysfs_upd_schemes_effective_quotas(void *data)
1300 {
1301         struct damon_sysfs_kdamond *kdamond = data;
1302         struct damon_ctx *ctx = kdamond->damon_ctx;
1303
1304         damos_sysfs_update_effective_quotas(
1305                         kdamond->contexts->contexts_arr[0]->schemes, ctx);
1306         return 0;
1307 }
1308
1309
1310 /*
1311  * damon_sysfs_cmd_request_callback() - DAMON callback for handling requests.
1312  * @c:          The DAMON context of the callback.
1313  * @active:     Whether @c is not deactivated due to watermarks.
1314  * @after_aggr: Whether this is called from after_aggregation() callback.
1315  *
1316  * This function is periodically called back from the kdamond thread for @c.
1317  * Then, it checks if there is a waiting DAMON sysfs request and handles it.
1318  */
1319 static int damon_sysfs_cmd_request_callback(struct damon_ctx *c, bool active,
1320                 bool after_aggregation)
1321 {
1322         struct damon_sysfs_kdamond *kdamond;
1323         int err = 0;
1324
1325         /* avoid deadlock due to concurrent state_store('off') */
1326         if (!mutex_trylock(&damon_sysfs_lock))
1327                 return 0;
1328         kdamond = damon_sysfs_cmd_request.kdamond;
1329         if (!kdamond || kdamond->damon_ctx != c)
1330                 goto out;
1331         switch (damon_sysfs_cmd_request.cmd) {
1332         case DAMON_SYSFS_CMD_COMMIT:
1333                 if (!after_aggregation)
1334                         goto out;
1335                 err = damon_sysfs_commit_input(kdamond);
1336                 break;
1337         default:
1338                 break;
1339         }
1340         /* Mark the request as invalid now. */
1341         damon_sysfs_cmd_request.kdamond = NULL;
1342 out:
1343         mutex_unlock(&damon_sysfs_lock);
1344         return err;
1345 }
1346
1347 static int damon_sysfs_after_wmarks_check(struct damon_ctx *c)
1348 {
1349         /*
1350          * after_wmarks_check() is called back while the context is deactivated
1351          * by watermarks.
1352          */
1353         return damon_sysfs_cmd_request_callback(c, false, false);
1354 }
1355
1356 static int damon_sysfs_after_sampling(struct damon_ctx *c)
1357 {
1358         /*
1359          * after_sampling() is called back only while the context is not
1360          * deactivated by watermarks.
1361          */
1362         return damon_sysfs_cmd_request_callback(c, true, false);
1363 }
1364
1365 static int damon_sysfs_after_aggregation(struct damon_ctx *c)
1366 {
1367         /*
1368          * after_aggregation() is called back only while the context is not
1369          * deactivated by watermarks.
1370          */
1371         return damon_sysfs_cmd_request_callback(c, true, true);
1372 }
1373
1374 static struct damon_ctx *damon_sysfs_build_ctx(
1375                 struct damon_sysfs_context *sys_ctx)
1376 {
1377         struct damon_ctx *ctx = damon_new_ctx();
1378         int err;
1379
1380         if (!ctx)
1381                 return ERR_PTR(-ENOMEM);
1382
1383         err = damon_sysfs_apply_inputs(ctx, sys_ctx);
1384         if (err) {
1385                 damon_destroy_ctx(ctx);
1386                 return ERR_PTR(err);
1387         }
1388
1389         ctx->callback.after_wmarks_check = damon_sysfs_after_wmarks_check;
1390         ctx->callback.after_sampling = damon_sysfs_after_sampling;
1391         ctx->callback.after_aggregation = damon_sysfs_after_aggregation;
1392         ctx->callback.before_terminate = damon_sysfs_before_terminate;
1393         return ctx;
1394 }
1395
1396 static int damon_sysfs_turn_damon_on(struct damon_sysfs_kdamond *kdamond)
1397 {
1398         struct damon_ctx *ctx;
1399         int err;
1400
1401         if (damon_sysfs_kdamond_running(kdamond))
1402                 return -EBUSY;
1403         if (damon_sysfs_cmd_request.kdamond == kdamond)
1404                 return -EBUSY;
1405         /* TODO: support multiple contexts per kdamond */
1406         if (kdamond->contexts->nr != 1)
1407                 return -EINVAL;
1408
1409         if (kdamond->damon_ctx)
1410                 damon_destroy_ctx(kdamond->damon_ctx);
1411         kdamond->damon_ctx = NULL;
1412
1413         ctx = damon_sysfs_build_ctx(kdamond->contexts->contexts_arr[0]);
1414         if (IS_ERR(ctx))
1415                 return PTR_ERR(ctx);
1416         err = damon_start(&ctx, 1, false);
1417         if (err) {
1418                 damon_destroy_ctx(ctx);
1419                 return err;
1420         }
1421         kdamond->damon_ctx = ctx;
1422         return err;
1423 }
1424
1425 static int damon_sysfs_turn_damon_off(struct damon_sysfs_kdamond *kdamond)
1426 {
1427         if (!kdamond->damon_ctx)
1428                 return -EINVAL;
1429         return damon_stop(&kdamond->damon_ctx, 1);
1430         /*
1431          * To allow users show final monitoring results of already turned-off
1432          * DAMON, we free kdamond->damon_ctx in next
1433          * damon_sysfs_turn_damon_on(), or kdamonds_nr_store()
1434          */
1435 }
1436
1437 static int damon_sysfs_damon_call(int (*fn)(void *data),
1438                 struct damon_sysfs_kdamond *kdamond)
1439 {
1440         struct damon_call_control call_control = {};
1441
1442         if (!kdamond->damon_ctx)
1443                 return -EINVAL;
1444         call_control.fn = fn;
1445         call_control.data = kdamond;
1446         return damon_call(kdamond->damon_ctx, &call_control);
1447 }
1448
1449 struct damon_sysfs_schemes_walk_data {
1450         struct damon_sysfs_kdamond *sysfs_kdamond;
1451         bool total_bytes_only;
1452 };
1453
1454 /* populate the region directory */
1455 static void damon_sysfs_schemes_tried_regions_upd_one(void *data, struct damon_ctx *ctx,
1456                 struct damon_target *t, struct damon_region *r,
1457                 struct damos *s, unsigned long sz_filter_passed)
1458 {
1459         struct damon_sysfs_schemes_walk_data *walk_data = data;
1460         struct damon_sysfs_kdamond *sysfs_kdamond = walk_data->sysfs_kdamond;
1461
1462         damos_sysfs_populate_region_dir(
1463                         sysfs_kdamond->contexts->contexts_arr[0]->schemes,
1464                         ctx, t, r, s, walk_data->total_bytes_only,
1465                         sz_filter_passed);
1466 }
1467
1468 static int damon_sysfs_update_schemes_tried_regions(
1469                 struct damon_sysfs_kdamond *sysfs_kdamond, bool total_bytes_only)
1470 {
1471         struct damon_sysfs_schemes_walk_data walk_data = {
1472                 .sysfs_kdamond = sysfs_kdamond,
1473                 .total_bytes_only = total_bytes_only,
1474         };
1475         struct damos_walk_control control = {
1476                 .walk_fn = damon_sysfs_schemes_tried_regions_upd_one,
1477                 .data = &walk_data,
1478         };
1479         struct damon_ctx *ctx = sysfs_kdamond->damon_ctx;
1480
1481         if (!ctx)
1482                 return -EINVAL;
1483
1484         damon_sysfs_schemes_clear_regions(
1485                         sysfs_kdamond->contexts->contexts_arr[0]->schemes);
1486         return damos_walk(ctx, &control);
1487 }
1488
1489 /*
1490  * damon_sysfs_handle_cmd() - Handle a command for a specific kdamond.
1491  * @cmd:        The command to handle.
1492  * @kdamond:    The kobject wrapper for the associated kdamond.
1493  *
1494  * This function handles a DAMON sysfs command for a kdamond.  For commands
1495  * that need to access running DAMON context-internal data, it requests
1496  * handling of the command to the DAMON callback
1497  * (@damon_sysfs_cmd_request_callback()) and wait until it is properly handled,
1498  * or the context is completed.
1499  *
1500  * Return: 0 on success, negative error code otherwise.
1501  */
1502 static int damon_sysfs_handle_cmd(enum damon_sysfs_cmd cmd,
1503                 struct damon_sysfs_kdamond *kdamond)
1504 {
1505         bool need_wait = true;
1506
1507         switch (cmd) {
1508         case DAMON_SYSFS_CMD_ON:
1509                 return damon_sysfs_turn_damon_on(kdamond);
1510         case DAMON_SYSFS_CMD_OFF:
1511                 return damon_sysfs_turn_damon_off(kdamond);
1512         case DAMON_SYSFS_CMD_COMMIT_SCHEMES_QUOTA_GOALS:
1513                 return damon_sysfs_damon_call(
1514                                 damon_sysfs_commit_schemes_quota_goals,
1515                                 kdamond);
1516         case DAMON_SYSFS_CMD_UPDATE_SCHEMES_STATS:
1517                 return damon_sysfs_damon_call(
1518                                 damon_sysfs_upd_schemes_stats, kdamond);
1519         case DAMON_SYSFS_CMD_UPDATE_SCHEMES_TRIED_BYTES:
1520                 return damon_sysfs_update_schemes_tried_regions(kdamond, true);
1521         case DAMON_SYSFS_CMD_UPDATE_SCHEMES_TRIED_REGIONS:
1522                 return damon_sysfs_update_schemes_tried_regions(kdamond, false);
1523         case DAMON_SYSFS_CMD_CLEAR_SCHEMES_TRIED_REGIONS:
1524                 return damon_sysfs_schemes_clear_regions(
1525                         kdamond->contexts->contexts_arr[0]->schemes);
1526         case DAMON_SYSFS_CMD_UPDATE_SCHEMES_EFFECTIVE_QUOTAS:
1527                 return damon_sysfs_damon_call(
1528                                 damon_sysfs_upd_schemes_effective_quotas,
1529                                 kdamond);
1530         default:
1531                 break;
1532         }
1533
1534         /* Pass the command to DAMON callback for safe DAMON context access */
1535         if (damon_sysfs_cmd_request.kdamond)
1536                 return -EBUSY;
1537         if (!damon_sysfs_kdamond_running(kdamond))
1538                 return -EINVAL;
1539         damon_sysfs_cmd_request.cmd = cmd;
1540         damon_sysfs_cmd_request.kdamond = kdamond;
1541
1542         /*
1543          * wait until damon_sysfs_cmd_request_callback() handles the request
1544          * from kdamond context
1545          */
1546         mutex_unlock(&damon_sysfs_lock);
1547         while (need_wait) {
1548                 schedule_timeout_idle(msecs_to_jiffies(100));
1549                 if (!mutex_trylock(&damon_sysfs_lock))
1550                         continue;
1551                 if (!damon_sysfs_cmd_request.kdamond) {
1552                         /* damon_sysfs_cmd_request_callback() handled */
1553                         need_wait = false;
1554                 } else if (!damon_sysfs_kdamond_running(kdamond)) {
1555                         /* kdamond has already finished */
1556                         need_wait = false;
1557                         damon_sysfs_cmd_request.kdamond = NULL;
1558                 }
1559                 mutex_unlock(&damon_sysfs_lock);
1560         }
1561         mutex_lock(&damon_sysfs_lock);
1562         return 0;
1563 }
1564
1565 static ssize_t state_store(struct kobject *kobj, struct kobj_attribute *attr,
1566                 const char *buf, size_t count)
1567 {
1568         struct damon_sysfs_kdamond *kdamond = container_of(kobj,
1569                         struct damon_sysfs_kdamond, kobj);
1570         enum damon_sysfs_cmd cmd;
1571         ssize_t ret = -EINVAL;
1572
1573         if (!mutex_trylock(&damon_sysfs_lock))
1574                 return -EBUSY;
1575         for (cmd = 0; cmd < NR_DAMON_SYSFS_CMDS; cmd++) {
1576                 if (sysfs_streq(buf, damon_sysfs_cmd_strs[cmd])) {
1577                         ret = damon_sysfs_handle_cmd(cmd, kdamond);
1578                         break;
1579                 }
1580         }
1581         mutex_unlock(&damon_sysfs_lock);
1582         if (!ret)
1583                 ret = count;
1584         return ret;
1585 }
1586
1587 static ssize_t pid_show(struct kobject *kobj,
1588                 struct kobj_attribute *attr, char *buf)
1589 {
1590         struct damon_sysfs_kdamond *kdamond = container_of(kobj,
1591                         struct damon_sysfs_kdamond, kobj);
1592         struct damon_ctx *ctx;
1593         int pid = -1;
1594
1595         if (!mutex_trylock(&damon_sysfs_lock))
1596                 return -EBUSY;
1597         ctx = kdamond->damon_ctx;
1598         if (!ctx)
1599                 goto out;
1600
1601         mutex_lock(&ctx->kdamond_lock);
1602         if (ctx->kdamond)
1603                 pid = ctx->kdamond->pid;
1604         mutex_unlock(&ctx->kdamond_lock);
1605 out:
1606         mutex_unlock(&damon_sysfs_lock);
1607         return sysfs_emit(buf, "%d\n", pid);
1608 }
1609
1610 static void damon_sysfs_kdamond_release(struct kobject *kobj)
1611 {
1612         struct damon_sysfs_kdamond *kdamond = container_of(kobj,
1613                         struct damon_sysfs_kdamond, kobj);
1614
1615         if (kdamond->damon_ctx)
1616                 damon_destroy_ctx(kdamond->damon_ctx);
1617         kfree(kdamond);
1618 }
1619
1620 static struct kobj_attribute damon_sysfs_kdamond_state_attr =
1621                 __ATTR_RW_MODE(state, 0600);
1622
1623 static struct kobj_attribute damon_sysfs_kdamond_pid_attr =
1624                 __ATTR_RO_MODE(pid, 0400);
1625
1626 static struct attribute *damon_sysfs_kdamond_attrs[] = {
1627         &damon_sysfs_kdamond_state_attr.attr,
1628         &damon_sysfs_kdamond_pid_attr.attr,
1629         NULL,
1630 };
1631 ATTRIBUTE_GROUPS(damon_sysfs_kdamond);
1632
1633 static const struct kobj_type damon_sysfs_kdamond_ktype = {
1634         .release = damon_sysfs_kdamond_release,
1635         .sysfs_ops = &kobj_sysfs_ops,
1636         .default_groups = damon_sysfs_kdamond_groups,
1637 };
1638
1639 /*
1640  * kdamonds directory
1641  */
1642
1643 struct damon_sysfs_kdamonds {
1644         struct kobject kobj;
1645         struct damon_sysfs_kdamond **kdamonds_arr;
1646         int nr;
1647 };
1648
1649 static struct damon_sysfs_kdamonds *damon_sysfs_kdamonds_alloc(void)
1650 {
1651         return kzalloc(sizeof(struct damon_sysfs_kdamonds), GFP_KERNEL);
1652 }
1653
1654 static void damon_sysfs_kdamonds_rm_dirs(struct damon_sysfs_kdamonds *kdamonds)
1655 {
1656         struct damon_sysfs_kdamond **kdamonds_arr = kdamonds->kdamonds_arr;
1657         int i;
1658
1659         for (i = 0; i < kdamonds->nr; i++) {
1660                 damon_sysfs_kdamond_rm_dirs(kdamonds_arr[i]);
1661                 kobject_put(&kdamonds_arr[i]->kobj);
1662         }
1663         kdamonds->nr = 0;
1664         kfree(kdamonds_arr);
1665         kdamonds->kdamonds_arr = NULL;
1666 }
1667
1668 static bool damon_sysfs_kdamonds_busy(struct damon_sysfs_kdamond **kdamonds,
1669                 int nr_kdamonds)
1670 {
1671         int i;
1672
1673         for (i = 0; i < nr_kdamonds; i++) {
1674                 if (damon_sysfs_kdamond_running(kdamonds[i]) ||
1675                     damon_sysfs_cmd_request.kdamond == kdamonds[i])
1676                         return true;
1677         }
1678
1679         return false;
1680 }
1681
1682 static int damon_sysfs_kdamonds_add_dirs(struct damon_sysfs_kdamonds *kdamonds,
1683                 int nr_kdamonds)
1684 {
1685         struct damon_sysfs_kdamond **kdamonds_arr, *kdamond;
1686         int err, i;
1687
1688         if (damon_sysfs_kdamonds_busy(kdamonds->kdamonds_arr, kdamonds->nr))
1689                 return -EBUSY;
1690
1691         damon_sysfs_kdamonds_rm_dirs(kdamonds);
1692         if (!nr_kdamonds)
1693                 return 0;
1694
1695         kdamonds_arr = kmalloc_array(nr_kdamonds, sizeof(*kdamonds_arr),
1696                         GFP_KERNEL | __GFP_NOWARN);
1697         if (!kdamonds_arr)
1698                 return -ENOMEM;
1699         kdamonds->kdamonds_arr = kdamonds_arr;
1700
1701         for (i = 0; i < nr_kdamonds; i++) {
1702                 kdamond = damon_sysfs_kdamond_alloc();
1703                 if (!kdamond) {
1704                         damon_sysfs_kdamonds_rm_dirs(kdamonds);
1705                         return -ENOMEM;
1706                 }
1707
1708                 err = kobject_init_and_add(&kdamond->kobj,
1709                                 &damon_sysfs_kdamond_ktype, &kdamonds->kobj,
1710                                 "%d", i);
1711                 if (err)
1712                         goto out;
1713
1714                 err = damon_sysfs_kdamond_add_dirs(kdamond);
1715                 if (err)
1716                         goto out;
1717
1718                 kdamonds_arr[i] = kdamond;
1719                 kdamonds->nr++;
1720         }
1721         return 0;
1722
1723 out:
1724         damon_sysfs_kdamonds_rm_dirs(kdamonds);
1725         kobject_put(&kdamond->kobj);
1726         return err;
1727 }
1728
1729 static ssize_t nr_kdamonds_show(struct kobject *kobj,
1730                 struct kobj_attribute *attr, char *buf)
1731 {
1732         struct damon_sysfs_kdamonds *kdamonds = container_of(kobj,
1733                         struct damon_sysfs_kdamonds, kobj);
1734
1735         return sysfs_emit(buf, "%d\n", kdamonds->nr);
1736 }
1737
1738 static ssize_t nr_kdamonds_store(struct kobject *kobj,
1739                 struct kobj_attribute *attr, const char *buf, size_t count)
1740 {
1741         struct damon_sysfs_kdamonds *kdamonds;
1742         int nr, err;
1743
1744         err = kstrtoint(buf, 0, &nr);
1745         if (err)
1746                 return err;
1747         if (nr < 0)
1748                 return -EINVAL;
1749
1750         kdamonds = container_of(kobj, struct damon_sysfs_kdamonds, kobj);
1751
1752         if (!mutex_trylock(&damon_sysfs_lock))
1753                 return -EBUSY;
1754         err = damon_sysfs_kdamonds_add_dirs(kdamonds, nr);
1755         mutex_unlock(&damon_sysfs_lock);
1756         if (err)
1757                 return err;
1758
1759         return count;
1760 }
1761
1762 static void damon_sysfs_kdamonds_release(struct kobject *kobj)
1763 {
1764         kfree(container_of(kobj, struct damon_sysfs_kdamonds, kobj));
1765 }
1766
1767 static struct kobj_attribute damon_sysfs_kdamonds_nr_attr =
1768                 __ATTR_RW_MODE(nr_kdamonds, 0600);
1769
1770 static struct attribute *damon_sysfs_kdamonds_attrs[] = {
1771         &damon_sysfs_kdamonds_nr_attr.attr,
1772         NULL,
1773 };
1774 ATTRIBUTE_GROUPS(damon_sysfs_kdamonds);
1775
1776 static const struct kobj_type damon_sysfs_kdamonds_ktype = {
1777         .release = damon_sysfs_kdamonds_release,
1778         .sysfs_ops = &kobj_sysfs_ops,
1779         .default_groups = damon_sysfs_kdamonds_groups,
1780 };
1781
1782 /*
1783  * damon user interface directory
1784  */
1785
1786 struct damon_sysfs_ui_dir {
1787         struct kobject kobj;
1788         struct damon_sysfs_kdamonds *kdamonds;
1789 };
1790
1791 static struct damon_sysfs_ui_dir *damon_sysfs_ui_dir_alloc(void)
1792 {
1793         return kzalloc(sizeof(struct damon_sysfs_ui_dir), GFP_KERNEL);
1794 }
1795
1796 static int damon_sysfs_ui_dir_add_dirs(struct damon_sysfs_ui_dir *ui_dir)
1797 {
1798         struct damon_sysfs_kdamonds *kdamonds;
1799         int err;
1800
1801         kdamonds = damon_sysfs_kdamonds_alloc();
1802         if (!kdamonds)
1803                 return -ENOMEM;
1804
1805         err = kobject_init_and_add(&kdamonds->kobj,
1806                         &damon_sysfs_kdamonds_ktype, &ui_dir->kobj,
1807                         "kdamonds");
1808         if (err) {
1809                 kobject_put(&kdamonds->kobj);
1810                 return err;
1811         }
1812         ui_dir->kdamonds = kdamonds;
1813         return err;
1814 }
1815
1816 static void damon_sysfs_ui_dir_release(struct kobject *kobj)
1817 {
1818         kfree(container_of(kobj, struct damon_sysfs_ui_dir, kobj));
1819 }
1820
1821 static struct attribute *damon_sysfs_ui_dir_attrs[] = {
1822         NULL,
1823 };
1824 ATTRIBUTE_GROUPS(damon_sysfs_ui_dir);
1825
1826 static const struct kobj_type damon_sysfs_ui_dir_ktype = {
1827         .release = damon_sysfs_ui_dir_release,
1828         .sysfs_ops = &kobj_sysfs_ops,
1829         .default_groups = damon_sysfs_ui_dir_groups,
1830 };
1831
1832 static int __init damon_sysfs_init(void)
1833 {
1834         struct kobject *damon_sysfs_root;
1835         struct damon_sysfs_ui_dir *admin;
1836         int err;
1837
1838         damon_sysfs_root = kobject_create_and_add("damon", mm_kobj);
1839         if (!damon_sysfs_root)
1840                 return -ENOMEM;
1841
1842         admin = damon_sysfs_ui_dir_alloc();
1843         if (!admin) {
1844                 kobject_put(damon_sysfs_root);
1845                 return -ENOMEM;
1846         }
1847         err = kobject_init_and_add(&admin->kobj, &damon_sysfs_ui_dir_ktype,
1848                         damon_sysfs_root, "admin");
1849         if (err)
1850                 goto out;
1851         err = damon_sysfs_ui_dir_add_dirs(admin);
1852         if (err)
1853                 goto out;
1854         return 0;
1855
1856 out:
1857         kobject_put(&admin->kobj);
1858         kobject_put(damon_sysfs_root);
1859         return err;
1860 }
1861 subsys_initcall(damon_sysfs_init);
1862
1863 #include "tests/sysfs-kunit.h"