char: misc: Various cleanup for miscdevice
v6 cover char: misc: Various cleanup for miscdevice
This patch series is to do cleanup for:
- Miscdevice APIs
- Miscdevice kunit test cases
- Drivers which use miscdevice APIs
---
Previous discussion link:
https://lore.kernel.org/all/[email protected]
---
Changes in v6:
- Correct title and commit message as cascardo's suggestion for [PATCH 5/8]
- Link to v5: https://lore.kernel.org/r/[email protected]
Changes in v5:
- Replace space with table in fist patch's Makefile
- Correct title and commit messages
- Link to v4: https://lore.kernel.org/r/[email protected]
Changes in v4:
- Fix WARNINGs reported by "kernel test robot <[email protected]>"
- Link to v3: https://lore.kernel.org/r/[email protected]
Changes in v3:
- Drop the change which allocates 4 fixed minors for watchdog
- Correct tile and commit message
- Link to v2: https://lore.kernel.org/r/[email protected]
---
Zijun Hu (8):
char: misc: Move drivers/misc/misc_minor_kunit.c to drivers/char/
char: misc: Adapt and add test cases for simple minor space division
char: misc: Disallow registering miscdevice whose minor > MISC_DYNAMIC_MINOR
char: misc: Add a case to test registering miscdevice again without reinitialization
char: misc: Make misc_register() reentry for miscdevice who wants dynamic minor
char: misc: Does not request module for miscdevice with dynamic minor
char: misc: Register fixed minor EISA_EEPROM_MINOR in linux/miscdevice.h
sparc: kernel: apc: Remove macro APC_MINOR definition
arch/sparc/kernel/apc.c | 3 +-
drivers/char/Makefile | 1 +
drivers/char/misc.c | 16 +++++-
drivers/{misc => char}/misc_minor_kunit.c | 95 +++++++++++++++++++++----------
drivers/misc/Makefile | 1 -
drivers/parisc/eisa_eeprom.c | 2 -
include/linux/miscdevice.h | 9 +++
7 files changed, 89 insertions(+), 38 deletions(-)---
base-commit: db15ec7abd33ce245120f36be91f56f0ba0b247e
change-id: 20250701-rfc_miscdev-35dd3310c7c0
Best regards,
Signature · 1 line
Zijun Hu <[email protected]>
PATCH v6 1/8 char: misc: Move drivers/misc/misc_minor_kunit.c to drivers/char/
From: Zijun Hu <[email protected]>
drivers/misc/misc_minor_kunit.c is to test APIs defined in drivers/char/misc.c, but is not in the same directory as the later.
Move misc_minor_kunit.c to drivers/char/.
---
drivers/char/Makefile | 1 +
drivers/{misc => char}/misc_minor_kunit.c | 0
drivers/misc/Makefile | 1 -
3 files changed, 1 insertion(+), 1 deletion(-)drivers/char/Makefile +1 -0
@@ -6,6 +6,7 @@ obj-y += mem.o random.o obj-$(CONFIG_TTY_PRINTK) += ttyprintk.o obj-y += misc.o +obj-$(CONFIG_TEST_MISC_MINOR) += misc_minor_kunit.o obj-$(CONFIG_ATARI_DSP56K) += dsp56k.o obj-$(CONFIG_VIRTIO_CONSOLE) += virtio_console.o obj-$(CONFIG_UV_MMTIMER) += uv_mmtimer.o
drivers/char/misc_minor_kunit.c renamed from drivers/misc/misc_minor_kunit.c +0 -0
drivers/misc/Makefile +0 -1
@@ -23,7 +23,6 @@ obj-$(CONFIG_SENSORS_BH1770) += bh1770glc.o obj-$(CONFIG_SENSORS_APDS990X) += apds990x.o obj-$(CONFIG_ENCLOSURE_SERVICES) += enclosure.o obj-$(CONFIG_KGDB_TESTS) += kgdbts.o -obj-$(CONFIG_TEST_MISC_MINOR) += misc_minor_kunit.o obj-$(CONFIG_SGI_XP) += sgi-xp/ obj-$(CONFIG_SGI_GRU) += sgi-gru/ obj-$(CONFIG_SMPRO_ERRMON) += smpro-errmon.o
Signature · 1 line
2.34.1
PATCH v6 2/8 char: misc: Adapt and add test cases for simple minor space division
In reply to Zijun HuFrom: Zijun Hu <[email protected]>
Adapt and add test cases for next change which regards minor whose value > macro MISC_DYNAMIC_MINOR as invalid parameter when register miscdevice, hence get a simple minor space division below:
< MISC_DYNAMIC_MINOR: fixed minor code
== MISC_DYNAMIC_MINOR: indicator to request dynamic minor code
Quoted 1 line
MISC_DYNAMIC_MINOR: dynamic minor code requested
--- drivers/char/misc_minor_kunit.c | 51 +++++++++++++++++------------------------ 1 file changed, 21 insertions(+), 30 deletions(-)
drivers/char/misc_minor_kunit.c +21 -30
@@ -7,12 +7,6 @@#include <linux/file.h> #include <linux/init_syscalls.h> -/* dynamic minor (2) */ -static struct miscdevice dev_dynamic_minor = { - .minor =2 , - .name ="dev_dynamic_minor" , -}; -/* static minor (LCD_MINOR) */ static struct miscdevice dev_static_minor = { .minor =LCD_MINOR ,
@@ -25,16 +19,6 @@ static struct miscdevice dev_misc_dynamic_minor = { .name = "dev_misc_dynamic_minor", }; -static void kunit_dynamic_minor (struct kunit *test) -{ -int ret; - - ret =misc_register (&dev_dynamic_minor); -KUNIT_EXPECT_EQ (test,0 , ret); -KUNIT_EXPECT_EQ (test,2 , dev_dynamic_minor.minor); -misc_deregister (&dev_dynamic_minor); -} -static void kunit_static_minor (struct kunit *test) {int ret;
@@ -157,13 +141,7 @@ static bool is_valid_dynamic_minor(int minor) {if (minor <0 )return false; -if (minor ==MISC_DYNAMIC_MINOR ) -return false; -if (minor >=0 && minor <=15 ) -return false; -if (minor >=128 && minor <MISC_DYNAMIC_MINOR ) -return false; -return true; +return minor >MISC_DYNAMIC_MINOR ; }static int miscdev_test_open (struct inode *inode,struct file *file)
@@ -557,7 +535,7 @@ static void __init miscdev_test_conflict(struct kunit *test)*/ miscstat.minor = miscdyn.minor; ret =misc_register (&miscstat); -KUNIT_EXPECT_EQ (test, ret, -EBUSY ); +KUNIT_EXPECT_EQ (test, ret, -EINVAL );if (ret ==0 )misc_deregister (&miscstat);
@@ -590,8 +568,9 @@ static void __init miscdev_test_conflict_reverse(struct kunit *test)misc_deregister (&miscdyn); ret =misc_register (&miscstat); -KUNIT_EXPECT_EQ (test, ret,0 ); -KUNIT_EXPECT_EQ (test, miscstat.minor, miscdyn.minor); +KUNIT_EXPECT_EQ (test, ret, -EINVAL ); +if (ret ==0 ) +misc_deregister (&miscstat);/* * Try to register a dynamic minor after registering a static minor
@@ -601,20 +580,32 @@ static void __init miscdev_test_conflict_reverse(struct kunit *test) miscdyn.minor =MISC_DYNAMIC_MINOR ; ret =misc_register (&miscdyn);KUNIT_EXPECT_EQ (test, ret,0 ); -KUNIT_EXPECT_NE (test, miscdyn.minor, miscstat.minor); +KUNIT_EXPECT_EQ (test, miscdyn.minor, miscstat.minor);KUNIT_EXPECT_TRUE (test,is_valid_dynamic_minor (miscdyn.minor));if (ret ==0 )misc_deregister (&miscdyn); +} -miscdev_test_can_open (test, &miscstat); +/* Take minor(> MISC_DYNAMIC_MINOR) as invalid when register miscdevice */ +static void miscdev_test_invalid_input (struct kunit *test) +{ +struct miscdevice misc_test = { + .minor =MISC_DYNAMIC_MINOR +1 , + .name ="misc_test" , + .fops = &miscdev_test_fops, + }; +int ret; -misc_deregister (&miscstat); + ret =misc_register (&misc_test); +KUNIT_EXPECT_EQ (test, ret, -EINVAL ); +if (ret ==0 ) +misc_deregister (&misc_test); }static struct kunit_case test_cases[] = { -KUNIT_CASE (kunit_dynamic_minor),KUNIT_CASE (kunit_static_minor),KUNIT_CASE (kunit_misc_dynamic_minor), +KUNIT_CASE (miscdev_test_invalid_input),KUNIT_CASE_PARAM (miscdev_test_twice, miscdev_gen_params),KUNIT_CASE_PARAM (miscdev_test_duplicate_minor, miscdev_gen_params),KUNIT_CASE (miscdev_test_duplicate_name),
Signature · 1 line
2.34.1
PATCH v6 3/8 char: misc: Disallow registering miscdevice whose minor > MISC_DYNAMIC_MINOR
In reply to Zijun HuFrom: Zijun Hu <[email protected]>
Currently, It is allowed to register miscdevice with minor > 255 which is defined by macro MISC_DYNAMIC_MINOR, and cause:
- Chaos regarding division and management of minor codes.
- Registering failure if the minor was allocated to other dynamic request.
Fortunately, in-kernel users have not had such usage yet. Fix by refusing to register miscdevice whose minor > 255.
Also bring in a very simple minor code space division and management:
< 255 : Fixed minor code
== 255 : Indicator to request dynamic minor code
Quoted 1 line
255 : Dynamic minor code requested, 1048320 minor codes totally
And all fixed minors allocated should be registered in 'linux/miscdevice.h'
--- drivers/char/misc.c | 6 ++++++ include/linux/miscdevice.h | 8 ++++++++ 2 files changed, 14 insertions(+)
drivers/char/misc.c +6 -0
@@ -210,6 +210,12 @@ int misc_register(struct miscdevice *misc)int err =0 ;bool is_dynamic = (misc->minor ==MISC_DYNAMIC_MINOR ); +if (misc->minor >MISC_DYNAMIC_MINOR ) { +pr_err ("Invalid fixed minor %d for miscdevice '%s'\n" , + misc->minor, misc->name); +return -EINVAL ; + } +INIT_LIST_HEAD (&misc->list);mutex_lock (&misc_mtx);
include/linux/miscdevice.h +8 -0
@@ -71,6 +71,14 @@#define USERIO_MINOR 240#define VHOST_VSOCK_MINOR 241#define RFKILL_MINOR 242 + +/* +* Misc char device minor code space division related to below macro: +* +* < 255 : Fixed minor code +* == 255 : Indicator to request dynamic minor code +* > 255 : Dynamic minor code requested, 1048320 minor codes totally. +*/ #define MISC_DYNAMIC_MINOR 255struct miscdevice {
Signature · 1 line
2.34.1
PATCH v6 4/8 char: misc: Add a case to test registering miscdevice again without reinitialization
In reply to Zijun HuFrom: Zijun Hu <[email protected]>
For miscdevice who wants dynamic minor, add a cast to test if it can be successfully registered again without reinitialization:
1) Provide Both miscdevice @dev_A and @dev_B want to request dynamic minor by initializing their minor to MISC_DYNAMIC_MINOR.
2) Register then de-register @dev_A.
3) Register @dev_B.
4) Register @dev_A again without reinitialization.
5) Check if @dev_A can be successfully registered.
--- drivers/char/misc_minor_kunit.c | 44 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+)
drivers/char/misc_minor_kunit.c +44 -0
@@ -602,6 +602,49 @@ static void miscdev_test_invalid_input(struct kunit *test)misc_deregister (&misc_test); } +/* +* Verify if @miscdyn_a can still be registered successfully without +* reinitialization even if its minor ever owned was requested by +* another miscdevice such as @miscdyn_b. +*/ +static void miscdev_test_dynamic_reentry (struct kunit *test) +{ +struct miscdevice miscdyn_a = { + .name ="miscdyn_a" , + .minor =MISC_DYNAMIC_MINOR , + .fops = &miscdev_test_fops, + }; +struct miscdevice miscdyn_b = { + .name ="miscdyn_b" , + .minor =MISC_DYNAMIC_MINOR , + .fops = &miscdev_test_fops, + }; +int ret, minor_a; + + ret =misc_register (&miscdyn_a); +KUNIT_ASSERT_EQ (test, ret,0 ); +KUNIT_EXPECT_TRUE (test,is_valid_dynamic_minor (miscdyn_a.minor)); + minor_a = miscdyn_a.minor; +if (ret !=0 ) +return ; +misc_deregister (&miscdyn_a); + + ret =misc_register (&miscdyn_b); +KUNIT_ASSERT_EQ (test, ret,0 ); +KUNIT_EXPECT_EQ (test, miscdyn_b.minor, minor_a); +if (ret !=0 ) +return ; + + ret =misc_register (&miscdyn_a); +KUNIT_ASSERT_EQ (test, ret,0 ); +KUNIT_EXPECT_TRUE (test,is_valid_dynamic_minor (miscdyn_a.minor)); +KUNIT_EXPECT_NE (test, miscdyn_a.minor, miscdyn_b.minor); +if (ret ==0 ) +misc_deregister (&miscdyn_a); + +misc_deregister (&miscdyn_b); +} +static struct kunit_case test_cases[] = {KUNIT_CASE (kunit_static_minor),KUNIT_CASE (kunit_misc_dynamic_minor),
@@ -611,6 +654,7 @@ static struct kunit_case test_cases[] = {KUNIT_CASE (miscdev_test_duplicate_name),KUNIT_CASE (miscdev_test_duplicate_name_leak),KUNIT_CASE_PARAM (miscdev_test_duplicate_error, miscdev_gen_params), + KUNIT_CASE(miscdev_test_dynamic_reentry), {} };
Signature · 1 line
2.34.1
PATCH v6 5/8 char: misc: Make misc_register() reentry for miscdevice who wants dynamic minor
In reply to Zijun HuFrom: Zijun Hu <[email protected]>
For miscdevice who wants dynamic minor, it may fail to be registered again without reinitialization after being de-registered, which is illustrated by kunit test case miscdev_test_dynamic_reentry() newly added.
There is a real case found by cascardo when a part of minor range were contained by range [0, 255):
1) wmi/dell-smbios registered minor 122, and acpi_thermal_rel registered minor 123
2) unbind "int3400 thermal" driver from its device, this will de-register acpi_thermal_rel
3) rmmod then insmod dell_smbios again, now wmi/dell-smbios is using minor 123
4) bind the device to "int3400 thermal" driver again, acpi_thermal_rel fails to register.
Some drivers may reuse the miscdevice structure after they are deregistered If the intention is to allocate a dynamic minor, if the minor number is not reset to MISC_DYNAMIC_MINOR before calling misc_register(), it will try to register a previously dynamically allocated minor number, which may have been registered by a different driver.
One such case is the acpi_thermal_rel misc device, registered by the int3400 thermal driver. If the device is unbound from the driver and later bound, if there was another dynamic misc device registered in between, it would fail to register the acpi_thermal_rel misc device. Other drivers behave similarly.
Actually, this kind of issue is prone to happen if APIs misc_register()/misc_deregister() are invoked by driver's probe()/remove() separately.
Instead of fixing all the drivers, just reset the minor member to MISC_DYNAMIC_MINOR in misc_deregister() in case it was a dynamically allocated minor number, as error handling of misc_register() does.
---
Thank you cascardo for sharing a real case and help to rework commit message. (^^)(^^)
--- drivers/char/misc.c | 2 ++ 1 file changed, 2 insertions(+)
drivers/char/misc.c +2 -0
@@ -288,6 +288,8 @@ void misc_deregister(struct miscdevice *misc)list_del (&misc->list);device_destroy (&misc_class,MKDEV (MISC_MAJOR , misc->minor));misc_minor_free (misc->minor); +if (misc->minor >MISC_DYNAMIC_MINOR ) + misc->minor =MISC_DYNAMIC_MINOR ;mutex_unlock (&misc_mtx); }EXPORT_SYMBOL (misc_deregister);
Signature · 1 line
2.34.1
PATCH v6 6/8 char: misc: Does not request module for miscdevice with dynamic minor
In reply to Zijun HuFrom: Zijun Hu <[email protected]>
misc_open() may request module for miscdevice with dynamic minor, which is meaningless since:
- The dynamic minor allocated is unknown in advance without registering miscdevice firstly.
- Macro MODULE_ALIAS_MISCDEV() is not applicable for dynamic minor.
Fix by only requesting module for miscdevice with fixed minor.
--- drivers/char/misc.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-)
drivers/char/misc.c +5 -3
@@ -132,7 +132,8 @@ static int misc_open(struct inode *inode, struct file *file)break ; } -if (!new_fops) { +/* Only request module for fixed minor code */ +if (!new_fops && minor <MISC_DYNAMIC_MINOR ) {mutex_unlock (&misc_mtx);request_module ("char-major-%d-%d" ,MISC_MAJOR , minor);mutex_lock (&misc_mtx);
@@ -144,10 +145,11 @@ static int misc_open(struct inode *inode, struct file *file) new_fops =fops_get (iter->fops);break ; } -if (!new_fops) - goto fail; } +if (!new_fops) + goto fail; +/* * Place the miscdevice in the file's * private_data so it can be used by the
Signature · 1 line
2.34.1
PATCH v6 7/8 char: misc: Register fixed minor EISA_EEPROM_MINOR in linux/miscdevice.h
In reply to Zijun HuFrom: Zijun Hu <[email protected]>
Move fixed minor EISA_EEPROM_MINOR definition to linux/miscdevice.h.
--- drivers/parisc/eisa_eeprom.c | 2 -- include/linux/miscdevice.h | 1 + 2 files changed, 1 insertion(+), 2 deletions(-)
drivers/parisc/eisa_eeprom.c +0 -2
@@ -15,8 +15,6 @@#include <linux/uaccess.h> #include <asm/eisa_eeprom.h> -#define EISA_EEPROM_MINOR 241 -static loff_t eisa_eeprom_llseek (struct file *file,loff_t offset,int origin) {return fixed_size_llseek (file, offset, origin,HPEE_MAX_LENGTH );
include/linux/miscdevice.h +1 -0
@@ -70,6 +70,7 @@#define UHID_MINOR 239#define USERIO_MINOR 240#define VHOST_VSOCK_MINOR 241 +#define EISA_EEPROM_MINOR 241#define RFKILL_MINOR 242/*
Signature · 1 line
2.34.1
PATCH v6 8/8 sparc: kernel: apc: Remove macro APC_MINOR definition
In reply to Zijun HuFrom: Zijun Hu <[email protected]>
Macro APC_MINOR is defined as MISC_DYNAMIC_MINOR to request dynamic minor, but its name 'APC_MINOR' looks like fixed minor.
Remove the macro definition and directly use MISC_DYNAMIC_MINOR instead.
--- arch/sparc/kernel/apc.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)
arch/sparc/kernel/apc.c +1 -2
@@ -28,7 +28,6 @@* #define APC_DEBUG_LED */ -#define APC_MINOR MISC_DYNAMIC_MINOR#define APC_OBPNAME "power-management"#define APC_DEVNAME "apc"
@@ -138,7 +137,7 @@ static const struct file_operations apc_fops = { .llseek = noop_llseek, }; -static struct miscdevice apc_miscdev = {APC_MINOR ,APC_DEVNAME , &apc_fops }; +static struct miscdevice apc_miscdev = {MISC_DYNAMIC_MINOR ,APC_DEVNAME , &apc_fops };static int apc_probe (struct platform_device *op) {
Signature · 1 line
2.34.1