drivers/base: fix userspace break from using bin_attributes for cpumap and cpulist
Subsystems (2)
PATCH v4 1/1 drivers/base: fix userspace break from using bin_attributes for cpumap and cpulist
Using bin_attributes with a 0 size causes fstat and friends to return that 0 size. This breaks userspace code that retrieves the size before reading the file. Rather than reverting 75bd50fa841 ("drivers/base/node.c: use bin_attribute to break the size limitation of cpumap ABI") let's put in a size value at compile time. Use direct comparison and a worst-case maximum to ensure compile time constants. For cpulist the max is on the order of NR_CPUS * (ceil(log10(NR_CPUS)) + 1) which for 8192 is 40960 (8192 * 5). In order to get near that you'd need a system with every other CPU on one node or something similar. e.g. (0,2,4,8, ... ). To simplify the math and support larger NR_CPUS in the future we are using NR_CPUS * 7. We also set it to a min of PAGE_SIZE to retain the older behavior for smaller NR_CPUS. The cpumap file wants to be something like NR_CPUS/4 + NR_CPUS/32, for the ","s so for simplicity we are using NR_CPUS/2.
Add a set of macros for these values to cpumask.h so they can be used in multiple places. Apply these to the handful of such files in drivers/base/topology.c as well as node.c.
On an 80 cpu 4-node sytem (NR_CPUS == 8192)
before:
-r--r--r--. 1 root root 0 Jul 12 14:08 /sys/devices/system/node/node0/cpulist -r--r--r--. 1 root root 0 Jul 11 17:25 /sys/devices/system/node/node0/cpumap
after:
-r--r--r--. 1 root root 57344 Jul 13 11:32 /sys/devices/system/node/node0/cpulist -r--r--r--. 1 root root 4096 Jul 13 11:31 /sys/devices/system/node/node0/cpumap
CONFIG_NR_CPUS = 16384
-r--r--r--. 1 root root 114688 Jul 13 14:03 /sys/devices/system/node/node0/cpulist
-r--r--r--. 1 root root 8192 Jul 13 14:02 /sys/devices/system/node/node0/cpumap
--- drivers/base/node.c | 4 ++-- drivers/base/topology.c | 32 ++++++++++++++++---------------- include/linux/cpumask.h | 16 ++++++++++++++++ 3 files changed, 34 insertions(+), 18 deletions(-)
drivers/base/node.c +2 -2
@@ -45,7 +45,7 @@ static inline ssize_t cpumap_read(struct file *file, struct kobject *kobj,return n; } -static BIN_ATTR_RO(cpumap, 0); +static BIN_ATTR_RO(cpumap, CPUMAP_FILE_MAX_BYTES); static inline ssize_t cpulist_read(struct file *file, struct kobject *kobj, struct bin_attribute *attr, char *buf,
@@ -66,7 +66,7 @@ static inline ssize_t cpulist_read(struct file *file, struct kobject *kobj,return n; } -static BIN_ATTR_RO(cpulist, 0); +static BIN_ATTR_RO(cpulist, CPULIST_FILE_MAX_BYTES);/** * struct node_access_nodes - Access class device to hold user visible
drivers/base/topology.c +16 -16
@@ -62,47 +62,47 @@ define_id_show_func(ppin, "0x%llx");static DEVICE_ATTR_ADMIN_RO (ppin);define_siblings_read_func (thread_siblings, sibling_cpumask); -static BIN_ATTR_RO(thread_siblings, 0); -static BIN_ATTR_RO(thread_siblings_list, 0); +static BIN_ATTR_RO(thread_siblings, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(thread_siblings_list, CPULIST_FILE_MAX_BYTES);define_siblings_read_func (core_cpus, sibling_cpumask); -static BIN_ATTR_RO(core_cpus, 0); -static BIN_ATTR_RO(core_cpus_list, 0); +static BIN_ATTR_RO(core_cpus, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(core_cpus_list, CPULIST_FILE_MAX_BYTES);define_siblings_read_func (core_siblings, core_cpumask); -static BIN_ATTR_RO(core_siblings, 0); -static BIN_ATTR_RO(core_siblings_list, 0); +static BIN_ATTR_RO(core_siblings, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(core_siblings_list, CPULIST_FILE_MAX_BYTES);#ifdef TOPOLOGY_CLUSTER_SYSFS define_siblings_read_func (cluster_cpus, cluster_cpumask); -static BIN_ATTR_RO(cluster_cpus, 0); -static BIN_ATTR_RO(cluster_cpus_list, 0); +static BIN_ATTR_RO(cluster_cpus, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(cluster_cpus_list, CPULIST_FILE_MAX_BYTES);#endif #ifdef TOPOLOGY_DIE_SYSFS define_siblings_read_func (die_cpus, die_cpumask); -static BIN_ATTR_RO(die_cpus, 0); -static BIN_ATTR_RO(die_cpus_list, 0); +static BIN_ATTR_RO(die_cpus, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(die_cpus_list, CPULIST_FILE_MAX_BYTES);#endif define_siblings_read_func (package_cpus, core_cpumask); -static BIN_ATTR_RO(package_cpus, 0); -static BIN_ATTR_RO(package_cpus_list, 0); +static BIN_ATTR_RO(package_cpus, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(package_cpus_list, CPULIST_FILE_MAX_BYTES);#ifdef TOPOLOGY_BOOK_SYSFS define_id_show_func (book_id,"%d" );static DEVICE_ATTR_RO (book_id);define_siblings_read_func (book_siblings, book_cpumask); -static BIN_ATTR_RO(book_siblings, 0); -static BIN_ATTR_RO(book_siblings_list, 0); +static BIN_ATTR_RO(book_siblings, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(book_siblings_list, CPULIST_FILE_MAX_BYTES);#endif #ifdef TOPOLOGY_DRAWER_SYSFS define_id_show_func (drawer_id,"%d" );static DEVICE_ATTR_RO (drawer_id);define_siblings_read_func (drawer_siblings, drawer_cpumask); -static BIN_ATTR_RO(drawer_siblings, 0); -static BIN_ATTR_RO(drawer_siblings_list, 0); +static BIN_ATTR_RO(drawer_siblings, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(drawer_siblings_list, CPULIST_FILE_MAX_BYTES);#endif static struct bin_attribute *bin_attrs[] = {
include/linux/cpumask.h +16 -0
@@ -1071,4 +1071,20 @@ cpumap_print_list_to_buf(char *buf, const struct cpumask *mask, [0] = 1UL \ } } +/* +* Provide a valid theoretical max size for cpumap ands cpulist sysfs files to +* avoid breaking userspace which may allocate a buffer based on the size +* reported by e.g. fstat. +* +* For cpumap NR_CPUS/2 is a simplification of NR_CPUS/4 + NR_CPUS/32. +* +* For cpulist 7 is (ceil(log10(NR_CPUS)) + 1) allowing for NR_CPUS to be up to +* 2 orders of magnitude larger than 8192. This covers a worst-case of every +* other cpu being on one of two nodes for a very large NR_CPUS. +* +* Use PAGE_SIZE as a minimum for smaller configurations. +*/ +#define CPUMAP_FILE_MAX_BYTES (((NR_CPUS >> 1) > PAGE_SIZE) ? NR_CPUS >> 1 : PAGE_SIZE) +#define CPULIST_FILE_MAX_BYTES (((NR_CPUS * 7) > PAGE_SIZE) ? NR_CPUS * 7 : PAGE_SIZE) +#endif /* __LINUX_CPUMASK_H */
Signature · 1 line
2.31.1
Greg Kroah-Hartman
maintainerQuoted 161 lines · Phil Auld
Using
bin_attributeswith a 0 size causes fstat and friends to return that 0 size. This breaks userspace code that retrieves the size before reading the file. Rather than reverting75bd50fa841("drivers/base/node.c: usebin_attributeto break the size limitation of cpumap ABI") let's put in a size value at compile time. Use direct comparison and a worst-case maximum to ensure compile time constants. For cpulist the max is on the order ofNR_CPUS* (ceil(log10(NR_CPUS)) + 1) which for 8192 is 40960 (8192 * 5). In order to get near that you'd need a system with every other CPU on one node or something similar. e.g. (0,2,4,8, ... ). To simplify the math and support largerNR_CPUSin the future we are usingNR_CPUS* 7. We also set it to a min ofPAGE_SIZEto retain the older behavior for smallerNR_CPUS. The cpumap file wants to be something like NR_CPUS/4 + NR_CPUS/32, for the ","s so for simplicity we are using NR_CPUS/2.Add a set of macros for these values to
cpumask.hso they can be used in multiple places. Apply these to the handful of such files indrivers/base/topology.cas well asnode.c.On an 80 cpu 4-node sytem (
NR_CPUS== 8192)before:
(quoted diff) +0
-2-r--r--r--. 1 root root 0 Jul 12 14:08 /sys/devices/system/node/node0/cpulist -r--r--r--. 1 root root 0 Jul 11 17:25 /sys/devices/system/node/node0/cpumapafter:
(quoted diff) +0
-2-r--r--r--. 1 root root 57344 Jul 13 11:32 /sys/devices/system/node/node0/cpulist -r--r--r--. 1 root root 4096 Jul 13 11:31 /sys/devices/system/node/node0/cpumap
CONFIG_NR_CPUS= 16384(quoted diff) +0
-2-r--r--r--. 1 root root 114688 Jul 13 14:03 /sys/devices/system/node/node0/cpulist -r--r--r--. 1 root root 8192 Jul 13 14:02 /sys/devices/system/node/node0/cpumapFixes 75bd50fa841 ("drivers/base/node.c: use bin_attribute to break the size limitation of cpumap ABI")Fixes bb9ec13d156 ("topology: use bin_attribute to break the size limitation of cpumap ABI")Cc Greg Kroah-Hartman <[email protected]>Cc "Rafael J. Wysocki" <[email protected]>Signed-off-by Phil Auld <[email protected]>--- drivers/base/node.c | 4 ++-- drivers/base/topology.c | 32 ++++++++++++++++---------------- include/linux/cpumask.h | 16 ++++++++++++++++ 3 files changed, 34 insertions(+), 18 deletions(-)drivers/base/node.c +2
-2@@ -45,7 +45,7 @@ static inline ssize_t cpumap_read(struct file *file, struct kobject *kobj,return n; } -static BIN_ATTR_RO(cpumap, 0); +static BIN_ATTR_RO(cpumap, CPUMAP_FILE_MAX_BYTES); static inline ssize_t cpulist_read(struct file *file, struct kobject *kobj, struct bin_attribute *attr, char *buf,@@ -66,7 +66,7 @@ static inline ssize_t cpulist_read(struct file *file, struct kobject *kobj,return n; } -static BIN_ATTR_RO(cpulist, 0); +static BIN_ATTR_RO(cpulist, CPULIST_FILE_MAX_BYTES);/** * struct node_access_nodes - Access class device to hold user visible drivers/base/topology.c +16
-16@@ -62,47 +62,47 @@ define_id_show_func(ppin, "0x%llx");static DEVICE_ATTR_ADMIN_RO (ppin);define_siblings_read_func (thread_siblings, sibling_cpumask); -static BIN_ATTR_RO(thread_siblings, 0); -static BIN_ATTR_RO(thread_siblings_list, 0); +static BIN_ATTR_RO(thread_siblings, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(thread_siblings_list, CPULIST_FILE_MAX_BYTES);define_siblings_read_func (core_cpus, sibling_cpumask); -static BIN_ATTR_RO(core_cpus, 0); -static BIN_ATTR_RO(core_cpus_list, 0); +static BIN_ATTR_RO(core_cpus, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(core_cpus_list, CPULIST_FILE_MAX_BYTES);define_siblings_read_func (core_siblings, core_cpumask); -static BIN_ATTR_RO(core_siblings, 0); -static BIN_ATTR_RO(core_siblings_list, 0); +static BIN_ATTR_RO(core_siblings, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(core_siblings_list, CPULIST_FILE_MAX_BYTES);#ifdef TOPOLOGY_CLUSTER_SYSFS define_siblings_read_func (cluster_cpus, cluster_cpumask); -static BIN_ATTR_RO(cluster_cpus, 0); -static BIN_ATTR_RO(cluster_cpus_list, 0); +static BIN_ATTR_RO(cluster_cpus, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(cluster_cpus_list, CPULIST_FILE_MAX_BYTES);#endif #ifdef TOPOLOGY_DIE_SYSFS define_siblings_read_func (die_cpus, die_cpumask); -static BIN_ATTR_RO(die_cpus, 0); -static BIN_ATTR_RO(die_cpus_list, 0); +static BIN_ATTR_RO(die_cpus, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(die_cpus_list, CPULIST_FILE_MAX_BYTES);#endif define_siblings_read_func (package_cpus, core_cpumask); -static BIN_ATTR_RO(package_cpus, 0); -static BIN_ATTR_RO(package_cpus_list, 0); +static BIN_ATTR_RO(package_cpus, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(package_cpus_list, CPULIST_FILE_MAX_BYTES);#ifdef TOPOLOGY_BOOK_SYSFS define_id_show_func (book_id,"%d" );static DEVICE_ATTR_RO (book_id);define_siblings_read_func (book_siblings, book_cpumask); -static BIN_ATTR_RO(book_siblings, 0); -static BIN_ATTR_RO(book_siblings_list, 0); +static BIN_ATTR_RO(book_siblings, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(book_siblings_list, CPULIST_FILE_MAX_BYTES);#endif #ifdef TOPOLOGY_DRAWER_SYSFS define_id_show_func (drawer_id,"%d" );static DEVICE_ATTR_RO (drawer_id);define_siblings_read_func (drawer_siblings, drawer_cpumask); -static BIN_ATTR_RO(drawer_siblings, 0); -static BIN_ATTR_RO(drawer_siblings_list, 0); +static BIN_ATTR_RO(drawer_siblings, CPUMAP_FILE_MAX_BYTES); +static BIN_ATTR_RO(drawer_siblings_list, CPULIST_FILE_MAX_BYTES);#endif static struct bin_attribute *bin_attrs[] = {include/linux/cpumask.h +16
-0@@ -1071,4 +1071,20 @@ cpumap_print_list_to_buf(char *buf, const struct cpumask *mask, [0] = 1UL \ } } +/* +* Provide a valid theoretical max size for cpumap ands cpulist sysfs files to +* avoid breaking userspace which may allocate a buffer based on the size +* reported by e.g. fstat. +* +* For cpumap NR_CPUS/2 is a simplification of NR_CPUS/4 + NR_CPUS/32. +* +* For cpulist 7 is (ceil(log10(NR_CPUS)) + 1) allowing for NR_CPUS to be up to +* 2 orders of magnitude larger than 8192. This covers a worst-case of every +* other cpu being on one of two nodes for a very large NR_CPUS. +* +* Use PAGE_SIZE as a minimum for smaller configurations. +*/ +#define CPUMAP_FILE_MAX_BYTES (((NR_CPUS >> 1) > PAGE_SIZE) ? NR_CPUS >> 1 : PAGE_SIZE) +#define CPULIST_FILE_MAX_BYTES (((NR_CPUS * 7) > PAGE_SIZE) ? NR_CPUS * 7 : PAGE_SIZE) +#endif /* __LINUX_CPUMASK_H */ Signature · 1 line
2.31.1
Hi,
This is the friendly patch-bot of Greg Kroah-Hartman. You have sent him a patch that has triggered this response. He used to manually respond to these common problems, but in order to save his sanity (he kept writing the same thing over and over, yet to different people), I was created. Hopefully you will not take offence and will fix the problem in your patch and resubmit it so that it can be accepted into the Linux kernel tree.
You are receiving this message because of the following common error(s) as indicated below:
- This looks like a new version of a previously submitted patch, but you did not list below the --- line any changes from the previous version. Please read the section entitled "The canonical patch format" in the kernel file, Documentation/SubmittingPatches for what needs to be done here to properly describe this.
If you wish to discuss this problem further, or you have questions about how to resolve this issue, please feel free to respond to this email and Greg will reply once he has dug out from the pending patches received from other developers.
thanks,
greg k-h's patch email bot