1 // SPDX-License-Identifier: GPL-2.0
3 * cacheinfo support - processor cache information via sysfs
5 * Based on arch/x86/kernel/cpu/intel_cacheinfo.c
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/acpi.h>
11 #include <linux/bitops.h>
12 #include <linux/cacheinfo.h>
13 #include <linux/compiler.h>
14 #include <linux/cpu.h>
15 #include <linux/device.h>
16 #include <linux/init.h>
18 #include <linux/sched.h>
19 #include <linux/slab.h>
20 #include <linux/smp.h>
21 #include <linux/sysfs.h>
23 /* pointer to per cpu cacheinfo */
24 static DEFINE_PER_CPU(struct cpu_cacheinfo, ci_cpu_cacheinfo);
25 #define ci_cacheinfo(cpu) (&per_cpu(ci_cpu_cacheinfo, cpu))
26 #define cache_leaves(cpu) (ci_cacheinfo(cpu)->num_leaves)
27 #define per_cpu_cacheinfo(cpu) (ci_cacheinfo(cpu)->info_list)
29 struct cpu_cacheinfo *get_cpu_cacheinfo(unsigned int cpu)
31 return ci_cacheinfo(cpu);
35 static inline bool cache_leaves_are_shared(struct cacheinfo *this_leaf,
36 struct cacheinfo *sib_leaf)
38 return sib_leaf->fw_token == this_leaf->fw_token;
41 /* OF properties to query for a given cache type */
42 struct cache_type_info {
43 const char *size_prop;
44 const char *line_size_props[2];
45 const char *nr_sets_prop;
48 static const struct cache_type_info cache_type_info[] = {
50 .size_prop = "cache-size",
51 .line_size_props = { "cache-line-size",
52 "cache-block-size", },
53 .nr_sets_prop = "cache-sets",
55 .size_prop = "i-cache-size",
56 .line_size_props = { "i-cache-line-size",
57 "i-cache-block-size", },
58 .nr_sets_prop = "i-cache-sets",
60 .size_prop = "d-cache-size",
61 .line_size_props = { "d-cache-line-size",
62 "d-cache-block-size", },
63 .nr_sets_prop = "d-cache-sets",
67 static inline int get_cacheinfo_idx(enum cache_type type)
69 if (type == CACHE_TYPE_UNIFIED)
74 static void cache_size(struct cacheinfo *this_leaf, struct device_node *np)
77 const __be32 *cache_size;
80 ct_idx = get_cacheinfo_idx(this_leaf->type);
81 propname = cache_type_info[ct_idx].size_prop;
83 cache_size = of_get_property(np, propname, NULL);
85 this_leaf->size = of_read_number(cache_size, 1);
88 /* not cache_line_size() because that's a macro in include/linux/cache.h */
89 static void cache_get_line_size(struct cacheinfo *this_leaf,
90 struct device_node *np)
92 const __be32 *line_size;
95 ct_idx = get_cacheinfo_idx(this_leaf->type);
96 lim = ARRAY_SIZE(cache_type_info[ct_idx].line_size_props);
98 for (i = 0; i < lim; i++) {
101 propname = cache_type_info[ct_idx].line_size_props[i];
102 line_size = of_get_property(np, propname, NULL);
108 this_leaf->coherency_line_size = of_read_number(line_size, 1);
111 static void cache_nr_sets(struct cacheinfo *this_leaf, struct device_node *np)
113 const char *propname;
114 const __be32 *nr_sets;
117 ct_idx = get_cacheinfo_idx(this_leaf->type);
118 propname = cache_type_info[ct_idx].nr_sets_prop;
120 nr_sets = of_get_property(np, propname, NULL);
122 this_leaf->number_of_sets = of_read_number(nr_sets, 1);
125 static void cache_associativity(struct cacheinfo *this_leaf)
127 unsigned int line_size = this_leaf->coherency_line_size;
128 unsigned int nr_sets = this_leaf->number_of_sets;
129 unsigned int size = this_leaf->size;
132 * If the cache is fully associative, there is no need to
133 * check the other properties.
135 if (!(nr_sets == 1) && (nr_sets > 0 && size > 0 && line_size > 0))
136 this_leaf->ways_of_associativity = (size / nr_sets) / line_size;
139 static bool cache_node_is_unified(struct cacheinfo *this_leaf,
140 struct device_node *np)
142 return of_property_read_bool(np, "cache-unified");
145 static void cache_of_set_props(struct cacheinfo *this_leaf,
146 struct device_node *np)
149 * init_cache_level must setup the cache level correctly
150 * overriding the architecturally specified levels, so
151 * if type is NONE at this stage, it should be unified
153 if (this_leaf->type == CACHE_TYPE_NOCACHE &&
154 cache_node_is_unified(this_leaf, np))
155 this_leaf->type = CACHE_TYPE_UNIFIED;
156 cache_size(this_leaf, np);
157 cache_get_line_size(this_leaf, np);
158 cache_nr_sets(this_leaf, np);
159 cache_associativity(this_leaf);
162 static int cache_setup_of_node(unsigned int cpu)
164 struct device_node *np;
165 struct cacheinfo *this_leaf;
166 struct device *cpu_dev = get_cpu_device(cpu);
167 struct cpu_cacheinfo *this_cpu_ci = get_cpu_cacheinfo(cpu);
168 unsigned int index = 0;
170 /* skip if fw_token is already populated */
171 if (this_cpu_ci->info_list->fw_token) {
176 pr_err("No cpu device for CPU %d\n", cpu);
179 np = cpu_dev->of_node;
181 pr_err("Failed to find cpu%d device node\n", cpu);
185 while (index < cache_leaves(cpu)) {
186 this_leaf = this_cpu_ci->info_list + index;
187 if (this_leaf->level != 1)
188 np = of_find_next_cache_node(np);
190 np = of_node_get(np);/* cpu node itself */
193 cache_of_set_props(this_leaf, np);
194 this_leaf->fw_token = np;
198 if (index != cache_leaves(cpu)) /* not all OF nodes populated */
204 static inline int cache_setup_of_node(unsigned int cpu) { return 0; }
205 static inline bool cache_leaves_are_shared(struct cacheinfo *this_leaf,
206 struct cacheinfo *sib_leaf)
209 * For non-DT/ACPI systems, assume unique level 1 caches, system-wide
210 * shared caches for all other levels. This will be used only if
211 * arch specific code has not populated shared_cpu_map
213 return !(this_leaf->level == 1);
217 int __weak cache_setup_acpi(unsigned int cpu)
222 static int cache_shared_cpu_map_setup(unsigned int cpu)
224 struct cpu_cacheinfo *this_cpu_ci = get_cpu_cacheinfo(cpu);
225 struct cacheinfo *this_leaf, *sib_leaf;
229 if (this_cpu_ci->cpu_map_populated)
232 if (of_have_populated_dt())
233 ret = cache_setup_of_node(cpu);
234 else if (!acpi_disabled)
235 ret = cache_setup_acpi(cpu);
240 for (index = 0; index < cache_leaves(cpu); index++) {
243 this_leaf = this_cpu_ci->info_list + index;
244 /* skip if shared_cpu_map is already populated */
245 if (!cpumask_empty(&this_leaf->shared_cpu_map))
248 cpumask_set_cpu(cpu, &this_leaf->shared_cpu_map);
249 for_each_online_cpu(i) {
250 struct cpu_cacheinfo *sib_cpu_ci = get_cpu_cacheinfo(i);
252 if (i == cpu || !sib_cpu_ci->info_list)
253 continue;/* skip if itself or no cacheinfo */
254 sib_leaf = sib_cpu_ci->info_list + index;
255 if (cache_leaves_are_shared(this_leaf, sib_leaf)) {
256 cpumask_set_cpu(cpu, &sib_leaf->shared_cpu_map);
257 cpumask_set_cpu(i, &this_leaf->shared_cpu_map);
265 static void cache_shared_cpu_map_remove(unsigned int cpu)
267 struct cpu_cacheinfo *this_cpu_ci = get_cpu_cacheinfo(cpu);
268 struct cacheinfo *this_leaf, *sib_leaf;
269 unsigned int sibling, index;
271 for (index = 0; index < cache_leaves(cpu); index++) {
272 this_leaf = this_cpu_ci->info_list + index;
273 for_each_cpu(sibling, &this_leaf->shared_cpu_map) {
274 struct cpu_cacheinfo *sib_cpu_ci;
276 if (sibling == cpu) /* skip itself */
279 sib_cpu_ci = get_cpu_cacheinfo(sibling);
280 if (!sib_cpu_ci->info_list)
283 sib_leaf = sib_cpu_ci->info_list + index;
284 cpumask_clear_cpu(cpu, &sib_leaf->shared_cpu_map);
285 cpumask_clear_cpu(sibling, &this_leaf->shared_cpu_map);
287 if (of_have_populated_dt())
288 of_node_put(this_leaf->fw_token);
292 static void free_cache_attributes(unsigned int cpu)
294 if (!per_cpu_cacheinfo(cpu))
297 cache_shared_cpu_map_remove(cpu);
299 kfree(per_cpu_cacheinfo(cpu));
300 per_cpu_cacheinfo(cpu) = NULL;
303 int __weak init_cache_level(unsigned int cpu)
308 int __weak populate_cache_leaves(unsigned int cpu)
313 static int detect_cache_attributes(unsigned int cpu)
317 if (init_cache_level(cpu) || !cache_leaves(cpu))
320 per_cpu_cacheinfo(cpu) = kcalloc(cache_leaves(cpu),
321 sizeof(struct cacheinfo), GFP_KERNEL);
322 if (per_cpu_cacheinfo(cpu) == NULL)
326 * populate_cache_leaves() may completely setup the cache leaves and
327 * shared_cpu_map or it may leave it partially setup.
329 ret = populate_cache_leaves(cpu);
333 * For systems using DT for cache hierarchy, fw_token
334 * and shared_cpu_map will be set up here only if they are
335 * not populated already
337 ret = cache_shared_cpu_map_setup(cpu);
339 pr_warn("Unable to detect cache hierarchy for CPU %d\n", cpu);
346 free_cache_attributes(cpu);
350 /* pointer to cpuX/cache device */
351 static DEFINE_PER_CPU(struct device *, ci_cache_dev);
352 #define per_cpu_cache_dev(cpu) (per_cpu(ci_cache_dev, cpu))
354 static cpumask_t cache_dev_map;
356 /* pointer to array of devices for cpuX/cache/indexY */
357 static DEFINE_PER_CPU(struct device **, ci_index_dev);
358 #define per_cpu_index_dev(cpu) (per_cpu(ci_index_dev, cpu))
359 #define per_cache_index_dev(cpu, idx) ((per_cpu_index_dev(cpu))[idx])
361 #define show_one(file_name, object) \
362 static ssize_t file_name##_show(struct device *dev, \
363 struct device_attribute *attr, char *buf) \
365 struct cacheinfo *this_leaf = dev_get_drvdata(dev); \
366 return sprintf(buf, "%u\n", this_leaf->object); \
370 show_one(level, level);
371 show_one(coherency_line_size, coherency_line_size);
372 show_one(number_of_sets, number_of_sets);
373 show_one(physical_line_partition, physical_line_partition);
374 show_one(ways_of_associativity, ways_of_associativity);
376 static ssize_t size_show(struct device *dev,
377 struct device_attribute *attr, char *buf)
379 struct cacheinfo *this_leaf = dev_get_drvdata(dev);
381 return sprintf(buf, "%uK\n", this_leaf->size >> 10);
384 static ssize_t shared_cpumap_show_func(struct device *dev, bool list, char *buf)
386 struct cacheinfo *this_leaf = dev_get_drvdata(dev);
387 const struct cpumask *mask = &this_leaf->shared_cpu_map;
389 return cpumap_print_to_pagebuf(list, buf, mask);
392 static ssize_t shared_cpu_map_show(struct device *dev,
393 struct device_attribute *attr, char *buf)
395 return shared_cpumap_show_func(dev, false, buf);
398 static ssize_t shared_cpu_list_show(struct device *dev,
399 struct device_attribute *attr, char *buf)
401 return shared_cpumap_show_func(dev, true, buf);
404 static ssize_t type_show(struct device *dev,
405 struct device_attribute *attr, char *buf)
407 struct cacheinfo *this_leaf = dev_get_drvdata(dev);
409 switch (this_leaf->type) {
410 case CACHE_TYPE_DATA:
411 return sprintf(buf, "Data\n");
412 case CACHE_TYPE_INST:
413 return sprintf(buf, "Instruction\n");
414 case CACHE_TYPE_UNIFIED:
415 return sprintf(buf, "Unified\n");
421 static ssize_t allocation_policy_show(struct device *dev,
422 struct device_attribute *attr, char *buf)
424 struct cacheinfo *this_leaf = dev_get_drvdata(dev);
425 unsigned int ci_attr = this_leaf->attributes;
428 if ((ci_attr & CACHE_READ_ALLOCATE) && (ci_attr & CACHE_WRITE_ALLOCATE))
429 n = sprintf(buf, "ReadWriteAllocate\n");
430 else if (ci_attr & CACHE_READ_ALLOCATE)
431 n = sprintf(buf, "ReadAllocate\n");
432 else if (ci_attr & CACHE_WRITE_ALLOCATE)
433 n = sprintf(buf, "WriteAllocate\n");
437 static ssize_t write_policy_show(struct device *dev,
438 struct device_attribute *attr, char *buf)
440 struct cacheinfo *this_leaf = dev_get_drvdata(dev);
441 unsigned int ci_attr = this_leaf->attributes;
444 if (ci_attr & CACHE_WRITE_THROUGH)
445 n = sprintf(buf, "WriteThrough\n");
446 else if (ci_attr & CACHE_WRITE_BACK)
447 n = sprintf(buf, "WriteBack\n");
451 static DEVICE_ATTR_RO(id);
452 static DEVICE_ATTR_RO(level);
453 static DEVICE_ATTR_RO(type);
454 static DEVICE_ATTR_RO(coherency_line_size);
455 static DEVICE_ATTR_RO(ways_of_associativity);
456 static DEVICE_ATTR_RO(number_of_sets);
457 static DEVICE_ATTR_RO(size);
458 static DEVICE_ATTR_RO(allocation_policy);
459 static DEVICE_ATTR_RO(write_policy);
460 static DEVICE_ATTR_RO(shared_cpu_map);
461 static DEVICE_ATTR_RO(shared_cpu_list);
462 static DEVICE_ATTR_RO(physical_line_partition);
464 static struct attribute *cache_default_attrs[] = {
467 &dev_attr_level.attr,
468 &dev_attr_shared_cpu_map.attr,
469 &dev_attr_shared_cpu_list.attr,
470 &dev_attr_coherency_line_size.attr,
471 &dev_attr_ways_of_associativity.attr,
472 &dev_attr_number_of_sets.attr,
474 &dev_attr_allocation_policy.attr,
475 &dev_attr_write_policy.attr,
476 &dev_attr_physical_line_partition.attr,
481 cache_default_attrs_is_visible(struct kobject *kobj,
482 struct attribute *attr, int unused)
484 struct device *dev = kobj_to_dev(kobj);
485 struct cacheinfo *this_leaf = dev_get_drvdata(dev);
486 const struct cpumask *mask = &this_leaf->shared_cpu_map;
487 umode_t mode = attr->mode;
489 if ((attr == &dev_attr_id.attr) && (this_leaf->attributes & CACHE_ID))
491 if ((attr == &dev_attr_type.attr) && this_leaf->type)
493 if ((attr == &dev_attr_level.attr) && this_leaf->level)
495 if ((attr == &dev_attr_shared_cpu_map.attr) && !cpumask_empty(mask))
497 if ((attr == &dev_attr_shared_cpu_list.attr) && !cpumask_empty(mask))
499 if ((attr == &dev_attr_coherency_line_size.attr) &&
500 this_leaf->coherency_line_size)
502 if ((attr == &dev_attr_ways_of_associativity.attr) &&
503 this_leaf->size) /* allow 0 = full associativity */
505 if ((attr == &dev_attr_number_of_sets.attr) &&
506 this_leaf->number_of_sets)
508 if ((attr == &dev_attr_size.attr) && this_leaf->size)
510 if ((attr == &dev_attr_write_policy.attr) &&
511 (this_leaf->attributes & CACHE_WRITE_POLICY_MASK))
513 if ((attr == &dev_attr_allocation_policy.attr) &&
514 (this_leaf->attributes & CACHE_ALLOCATE_POLICY_MASK))
516 if ((attr == &dev_attr_physical_line_partition.attr) &&
517 this_leaf->physical_line_partition)
523 static const struct attribute_group cache_default_group = {
524 .attrs = cache_default_attrs,
525 .is_visible = cache_default_attrs_is_visible,
528 static const struct attribute_group *cache_default_groups[] = {
529 &cache_default_group,
533 static const struct attribute_group *cache_private_groups[] = {
534 &cache_default_group,
535 NULL, /* Place holder for private group */
539 const struct attribute_group *
540 __weak cache_get_priv_group(struct cacheinfo *this_leaf)
545 static const struct attribute_group **
546 cache_get_attribute_groups(struct cacheinfo *this_leaf)
548 const struct attribute_group *priv_group =
549 cache_get_priv_group(this_leaf);
552 return cache_default_groups;
554 if (!cache_private_groups[1])
555 cache_private_groups[1] = priv_group;
557 return cache_private_groups;
560 /* Add/Remove cache interface for CPU device */
561 static void cpu_cache_sysfs_exit(unsigned int cpu)
564 struct device *ci_dev;
566 if (per_cpu_index_dev(cpu)) {
567 for (i = 0; i < cache_leaves(cpu); i++) {
568 ci_dev = per_cache_index_dev(cpu, i);
571 device_unregister(ci_dev);
573 kfree(per_cpu_index_dev(cpu));
574 per_cpu_index_dev(cpu) = NULL;
576 device_unregister(per_cpu_cache_dev(cpu));
577 per_cpu_cache_dev(cpu) = NULL;
580 static int cpu_cache_sysfs_init(unsigned int cpu)
582 struct device *dev = get_cpu_device(cpu);
584 if (per_cpu_cacheinfo(cpu) == NULL)
587 per_cpu_cache_dev(cpu) = cpu_device_create(dev, NULL, NULL, "cache");
588 if (IS_ERR(per_cpu_cache_dev(cpu)))
589 return PTR_ERR(per_cpu_cache_dev(cpu));
591 /* Allocate all required memory */
592 per_cpu_index_dev(cpu) = kcalloc(cache_leaves(cpu),
593 sizeof(struct device *), GFP_KERNEL);
594 if (unlikely(per_cpu_index_dev(cpu) == NULL))
600 cpu_cache_sysfs_exit(cpu);
604 static int cache_add_dev(unsigned int cpu)
608 struct device *ci_dev, *parent;
609 struct cacheinfo *this_leaf;
610 struct cpu_cacheinfo *this_cpu_ci = get_cpu_cacheinfo(cpu);
611 const struct attribute_group **cache_groups;
613 rc = cpu_cache_sysfs_init(cpu);
614 if (unlikely(rc < 0))
617 parent = per_cpu_cache_dev(cpu);
618 for (i = 0; i < cache_leaves(cpu); i++) {
619 this_leaf = this_cpu_ci->info_list + i;
620 if (this_leaf->disable_sysfs)
622 cache_groups = cache_get_attribute_groups(this_leaf);
623 ci_dev = cpu_device_create(parent, this_leaf, cache_groups,
625 if (IS_ERR(ci_dev)) {
626 rc = PTR_ERR(ci_dev);
629 per_cache_index_dev(cpu, i) = ci_dev;
631 cpumask_set_cpu(cpu, &cache_dev_map);
635 cpu_cache_sysfs_exit(cpu);
639 static int cacheinfo_cpu_online(unsigned int cpu)
641 int rc = detect_cache_attributes(cpu);
645 rc = cache_add_dev(cpu);
647 free_cache_attributes(cpu);
651 static int cacheinfo_cpu_pre_down(unsigned int cpu)
653 if (cpumask_test_and_clear_cpu(cpu, &cache_dev_map))
654 cpu_cache_sysfs_exit(cpu);
656 free_cache_attributes(cpu);
660 static int __init cacheinfo_sysfs_init(void)
662 return cpuhp_setup_state(CPUHP_AP_ONLINE_DYN, "base/cacheinfo:online",
663 cacheinfo_cpu_online, cacheinfo_cpu_pre_down);
665 device_initcall(cacheinfo_sysfs_init);