mm: cma: support sysfs
Subsystems (3)
PATCH v5 1/1 mm: cma: support sysfs
Since CMA is getting used more widely, it's more important to keep monitoring CMA statistics for system health since it's directly related to user experience.
This patch introduces sysfs statistics for CMA, in order to provide some basic monitoring of the CMA allocator.
* the number of CMA page successful allocations
* the number of CMA page allocation failures
These two values allow the user to calcuate the allocation failure rate for each CMA area.
e.g.)
/sys/kernel/mm/cma/WIFI/alloc_pages_[success|fail] /sys/kernel/mm/cma/SENSOR/alloc_pages_[success|fail] /sys/kernel/mm/cma/BLUETOOTH/alloc_pages_[success|fail]
The cma_stat was intentionally allocated by dynamic allocation to harmonize with kobject lifetime management.
https://lore.kernel.org/linux-mm/[email protected]/
---
From v4 - https://lore.kernel.org/linux-mm/[email protected]/
* fix corruption - digetx@
From v3 - https://lore.kernel.org/linux-mm/[email protected]/
* fix ZERO_OR_NULL_PTR - kernel test robot
* remove prefix cma - david@
* resolve conflict with vmstat cma in mmotm - akpm@
* rename stat name with success|fail
From v2 - https://lore.kernel.org/linux-mm/[email protected]/
* sysfs doc and description modification - jhubbard
From v1 - https://lore.kernel.org/linux-mm/[email protected]/
* fix sysfs build and refactoring - willy
* rename and drop some attributes - jhubbard
Documentation/ABI/testing/sysfs-kernel-mm-cma | 25 ++++ mm/Kconfig | 7 ++ mm/Makefile | 1 + mm/cma.c | 7 +- mm/cma.h | 21 ++++ mm/cma_sysfs.c | 107 ++++++++++++++++++ 6 files changed, 166 insertions(+), 2 deletions(-) create mode 100644 Documentation/ABI/testing/sysfs-kernel-mm-cma create mode 100644 mm/cma_sysfs.c
Documentation/ABI/testing/sysfs-kernel-mm-cma new file +25 -0
@@ -0,0 +1,25 @@ +What: /sys/kernel/mm/cma/ +Date: Feb 2021 +Contact: Minchan Kim <[email protected]> +Description: + /sys/kernel/mm/cma/ contains a subdirectory for each CMA + heap name (also sometimes called CMA areas). + + Each CMA heap subdirectory (that is, each + /sys/kernel/mm/cma/<cma-heap-name> directory) contains the + following items: + + alloc_pages_success + alloc_pages_fail + +What: /sys/kernel/mm/cma/<cma-heap-name>/alloc_pages_success +Date: Feb 2021 +Contact: Minchan Kim <[email protected]> +Description: + the number of pages CMA API succeeded to allocate + +What: /sys/kernel/mm/cma/<cma-heap-name>/alloc_pages_fail +Date: Feb 2021 +Contact: Minchan Kim <[email protected]> +Description: + the number of pages CMA API failed to allocate
mm/Kconfig +7 -0
@@ -513,6 +513,13 @@ config CMA_DEBUGFS help Turns on the DebugFS interface for CMA. +config CMA_SYSFS + bool "CMA information through sysfs interface" + depends on CMA && SYSFS + help + This option exposes some sysfs attributes to get information + from CMA. + config CMA_AREAS int "Maximum count of the CMA areas" depends on CMA
mm/Makefile +1 -0
@@ -109,6 +109,7 @@ obj-$(CONFIG_CMA) += cma.o obj-$(CONFIG_MEMORY_BALLOON) += balloon_compaction.o obj-$(CONFIG_PAGE_EXTENSION) += page_ext.o obj-$(CONFIG_CMA_DEBUGFS) += cma_debug.o +obj-$(CONFIG_CMA_SYSFS) += cma_sysfs.o obj-$(CONFIG_USERFAULTFD) += userfaultfd.o obj-$(CONFIG_IDLE_PAGE_TRACKING) += page_idle.o obj-$(CONFIG_DEBUG_PAGE_REF) += debug_page_ref.o
mm/cma.c +5 -2
@@ -507,10 +507,13 @@ struct page *cma_alloc(struct cma *cma, size_t count, unsigned int align,pr_debug ("%s(): returned %p\n" , __func__, page); out: -if (page) +if (page) {count_vm_event (CMA_ALLOC_SUCCESS ); -else +cma_sysfs_alloc_pages_count (cma, count); + }else {count_vm_event (CMA_ALLOC_FAIL ); +cma_sysfs_fail_pages_count (cma, count); + }return page; }
mm/cma.h +21 -0
@@ -3,6 +3,12 @@#define __MM_CMA_H__#include <linux/debugfs.h> +#include <linux/kobject.h> + +struct cma_kobject { +struct cma *cma; +struct kobject kobj; +};struct cma {unsigned long base_pfn;
@@ -16,6 +22,14 @@ struct cma {struct debugfs_u32_array dfs_bitmap;#endif char name[CMA_MAX_NAME ]; +#ifdef CONFIG_CMA_SYSFS +/* the number of CMA page successful allocations */ +atomic64_t nr_pages_succeeded; +/* the number of CMA page allocation failures */ +atomic64_t nr_pages_failed; +/* kobject requires dynamic objecjt */ +struct cma_kobject *kobj; +#endif };extern struct cma cma_areas[MAX_CMA_AREAS ];
@@ -26,4 +40,11 @@ static inline unsigned long cma_bitmap_maxno(struct cma *cma) return cma->count >> cma->order_per_bit; } +#ifdef CONFIG_CMA_SYSFS +void cma_sysfs_alloc_pages_count (struct cma *cma,size_t count); +void cma_sysfs_fail_pages_count (struct cma *cma,size_t count); +#else +static inline void cma_sysfs_alloc_pages_count (struct cma *cma,size_t count) {}; +static inline void cma_sysfs_fail_pages_count (struct cma *cma,size_t count) {}; +#endif #endif
mm/cma_sysfs.c new file +107 -0
107 lines not on this page · raw message
Signature · 1 line
2.31.0.291.g576ba9dcdaf-goog
23.03.2021 22:50, Minchan Kim пишет:
Quoted 11 lines
Since CMA is getting used more widely, it's more important to keep monitoring CMA statistics for system health since it's directly related to user experience.
This patch introduces sysfs statistics for CMA, in order to provide some basic monitoring of the CMA allocator.
* the number of CMA page successful allocations
* the number of CMA page allocation failuresThese two values allow the user to calcuate the allocation
typo: calculate
mm/cma.h struct cma { · line 30
Quoted 12 lines
struct cma {
mm/cma.h +6
-0unsigned long base_pfn;@@ -16,6 +22,14 @@ struct cma {struct debugfs_u32_array dfs_bitmap;#endif char name[CMA_MAX_NAME ]; +#ifdef CONFIG_CMA_SYSFS +/* the number of CMA page successful allocations */ +atomic64_t nr_pages_succeeded; +/* the number of CMA page allocation failures */ +atomic64_t nr_pages_failed; +/* kobject requires dynamic objecjt */
typo: object
...
mm/cma_sysfs.c line 53
Quoted 4 lines
mm/cma_sysfs.c new file +4
-0+static void cma_kobj_release (struct kobject *kobj) +{ +struct cma_kobject *cma_kobj = + container_of(kobj, struct cma_kobject, kobj);
I'd add a to_cma_kobject() helper to improve readability.
Quoted 14 lines
mm/cma_sysfs.c new file +14
-0+struct cma *cma = cma_kobj->cma; + +kfree (cma_kobj); + cma->kobj =NULL ; +} + +static struct attribute *cma_attrs[] = { + &alloc_pages_success_attr.attr, + &alloc_pages_fail_attr.attr, +NULL , +}; +ATTRIBUTE_GROUPS (cma); + +static struct kobject *cma_kobj_root;
mm/cma_sysfs.c line 77
Quoted 10 lines
mm/cma_sysfs.c new file +10
-0+ +static struct kobj_type cma_ktype = { + .release = cma_kobj_release, + .sysfs_ops = &kobj_sysfs_ops, + .default_groups = cma_groups +}; + +static int __init cma_sysfs_init (void ) +{ +int i =0 ;
unsigned int, for consistency
There is no need to initialize this variable.
mm/cma_sysfs.c line 88
Quoted 11 lines
mm/cma_sysfs.c new file +11
-0+struct cma *cma; + + cma_kobj_root =kobject_create_and_add ("cma" , mm_kobj); +if (!cma_kobj_root) +return -ENOMEM ; + +for (i =0 ; i < cma_area_count; i++) { +struct cma_kobject *kobj; + + cma = &cma_areas[i]; + kobj =kzalloc (sizeof (struct cma_kobject ),GFP_KERNEL );
Checkpatch should warn that kzalloc(*kobj, ..) is a better variant.
I'd also rename kobj to cma_kobj everywhere, for clarity.
Quoted 7 lines
mm/cma_sysfs.c new file +7
-0+if (!kobj) + goto out; + + kobj->cma = cma; + cma->kobj = kobj; +if (kobject_init_and_add (&cma->kobj->kobj, &cma_ktype, + cma_kobj_root,"%s" , cma->name)) {
mm/cma_sysfs.c line 105
Quoted 10 lines
mm/cma_sysfs.c new file +10
-0+kobject_put (&cma->kobj->kobj); + goto out; + } + } + +return 0 ; +out: +kobject_put (cma_kobj_root); + +return -ENOMEM ;
kobject_init_and_add returns a error code, it could be different from ENOMEM. Won't hurt to propagate the proper error code.
24.03.2021 00:19, Dmitry Osipenko пишет:
Quoted 11 lines
Quoted 11 lines
mm/cma_sysfs.c new file +11
-0+if (!kobj) + goto out; + + kobj->cma = cma; + cma->kobj = kobj; +if (kobject_init_and_add (&cma->kobj->kobj, &cma_ktype, + cma_kobj_root,"%s" , cma->name)) { +kobject_put (&cma->kobj->kobj); + goto out; + } + }
Quoted 9 lines
mm/cma_sysfs.c line 105
Quoted 6 lines
mm/cma_sysfs.c new file +6
-0+ +return 0 ; +out: +kobject_put (cma_kobj_root); + +return -ENOMEM ;
kobject_init_and_addreturns a error code, it could be different from ENOMEM. Won't hurt to propagate the proper error code.
I think it will be cleaner to write it like this:
cma_kobj = kzalloc(sizeof(*cma_kobj), GFP_KERNEL);
if (!cma_kobj) {
kobject_put(cma_kobj_root);
return -ENOMEM;
}
cma_kobj->cma = cma;
err = kobject_init_and_add(&cma_kobj->kobj, &cma_ktype,
cma_kobj_root, "%s", cma->name);
if (err) {
kobject_put(&cma_kobj->kobj);
kobject_put(cma_kobj_root);
return err;
}
}
return 0;
}23.03.2021 22:50, Minchan Kim пишет:
mm/cma.h static inline unsigned long cma_bitmap_maxno(struct cma *cma) · line 45
Quoted 3 lines
mm/cma.h +3
-0+#ifdef CONFIG_CMA_SYSFS +void cma_sysfs_alloc_pages_count (struct cma *cma,size_t count); +void cma_sysfs_fail_pages_count (struct cma *cma,size_t count);
I'd also rename cma_sysfs_alloc_pages_count to cma_sysfs_account_success_pages and cma_sysfs_fail_pages_count to cma_sysfs_account_fail_pages.
Quoted 8 lines · Dmitry Osipenko
23.03.2021 22:50, Minchan Kim пишет:
mm/cma.h static inline unsigned long cma_bitmap_maxno(struct cma *cma) · line 45
Quoted 3 lines
mm/cma.h +3
-0+#ifdef CONFIG_CMA_SYSFS +void cma_sysfs_alloc_pages_count (struct cma *cma,size_t count); +void cma_sysfs_fail_pages_count (struct cma *cma,size_t count);I'd also rename
cma_sysfs_alloc_pages_counttocma_sysfs_account_success_pagesandcma_sysfs_fail_pages_counttocma_sysfs_account_fail_pages.
Every comment makes sense. Will revise and resend.
Thanks for the review.
mm/cma_sysfs.c line 17
Quoted 7 lines · Minchan Kim
mm/cma_sysfs.c new file +6
-0+/* the number of CMA page successful allocations */ +atomic64_t nr_pages_succeeded; +void cma_sysfs_alloc_pages_count (struct cma *cma,size_t count) +{ +atomic64_add (count, &cma->nr_pages_succeeded); +}
I don't understand. A size_t is a byte count. But the variable is called 'nr_pages'. So which is it, a byte count or a page count?
mm/cma_sysfs.c line 35
Quoted 9 lines
mm/cma_sysfs.c new file +9
-0+static ssize_t alloc_pages_success_show (struct kobject *kobj, +struct kobj_attribute *attr,char *buf) +{ +struct cma_kobject *cma_kobj =container_of (kobj, + struct cma_kobject, kobj); +struct cma *cma = cma_kobj->cma; + +return sysfs_emit (buf,"%llu\n" , +atomic64_read (&cma->nr_pages_succeeded));
... if it's in bytes, it should probably be reported in kilobytes and be suffixed with a 'K' like many other stats.
Quoted 11 lines · Matthew Wilcox
mm/cma_sysfs.c line 17
Quoted 7 lines · Minchan Kim
mm/cma_sysfs.c new file +6
-0+/* the number of CMA page successful allocations */ +atomic64_t nr_pages_succeeded; +void cma_sysfs_alloc_pages_count (struct cma *cma,size_t count) +{ +atomic64_add (count, &cma->nr_pages_succeeded); +}I don't understand. A
size_tis a byte count. But the variable is called 'nr_pages'. So which is it, a byte count or a page count?
It's page count. I followed the cma_alloc interface since it has size_t count variable for nr_pages.
Let's go with unsigned long nr_pages:
void cma_sysfs_alloc_pages_count(struct cma *cma, unsigned long nr_pages)
Quoted 14 lines
mm/cma_sysfs.c line 35
Quoted 10 lines
mm/cma_sysfs.c new file +9
-0+static ssize_t alloc_pages_success_show (struct kobject *kobj, +struct kobj_attribute *attr,char *buf) +{ +struct cma_kobject *cma_kobj =container_of (kobj, + struct cma_kobject, kobj); +struct cma *cma = cma_kobj->cma; + +return sysfs_emit (buf,"%llu\n" , +atomic64_read (&cma->nr_pages_succeeded));... if it's in bytes, it should probably be reported in kilobytes and be suffixed with a 'K' like many other stats.
Quoted 13 lines · Minchan Kim
Quoted 11 lines · Matthew Wilcox
mm/cma_sysfs.c line 17
Quoted 7 lines · Minchan Kim
mm/cma_sysfs.c new file +6
-0+/* the number of CMA page successful allocations */ +atomic64_t nr_pages_succeeded; +void cma_sysfs_alloc_pages_count (struct cma *cma,size_t count) +{ +atomic64_add (count, &cma->nr_pages_succeeded); +}I don't understand. A
size_tis a byte count. But the variable is called 'nr_pages'. So which is it, a byte count or a page count?
Quoted 2 lines
It's page count. I followed the
cma_allocinterface since it hassize_tcount variable fornr_pages.
That's very confusing. cma_alloc is wrong; if it needs to be an unsigned long, that's fine. But it shouldn't be size_t.
7.17 of n1256 defines:
size_t
which is the unsigned integer type of the result of the sizeof operator
Do you want to submit a patch to fix cma_alloc as well?
Quoted 3 lines
Let's go with unsigned long
nr_pages:
voidcma_sysfs_alloc_pages_count(struct cma *cma, unsigned long nr_pages)
Works for me!
Quoted 20 lines · Matthew Wilcox
Quoted 13 lines · Minchan Kim
Quoted 11 lines · Matthew Wilcox
mm/cma_sysfs.c line 17
Quoted 7 lines · Minchan Kim
mm/cma_sysfs.c new file +6
-0+/* the number of CMA page successful allocations */ +atomic64_t nr_pages_succeeded; +void cma_sysfs_alloc_pages_count (struct cma *cma,size_t count) +{ +atomic64_add (count, &cma->nr_pages_succeeded); +}I don't understand. A
size_tis a byte count. But the variable is called 'nr_pages'. So which is it, a byte count or a page count?Quoted 2 lines
It's page count. I followed the
cma_allocinterface since it hassize_tcount variable fornr_pages.That's very confusing.
cma_allocis wrong; if it needs to be an unsigned long, that's fine. But it shouldn't besize_t.
Quoted 6 lines
7.17 of n1256 defines:
size_t
which is the unsigned integer type of the result of the sizeof operatorDo you want to submit a patch to fix
cma_allocas well?
Sure, but it will be separate patch.
Quoted 6 lines
Quoted 4 lines
Let's go with unsigned long
nr_pages:
voidcma_sysfs_alloc_pages_count(struct cma *cma, unsigned long nr_pages)Works for me!
Thanks for review!