sysrq: Auto release device node using __free attribute
PATCH 1/1 sysrq: Auto release device node using __free attribute
Add a cleanup function attribute '__free(device_node)' to the device node pointer initialization statement and remove the pairing cleanup function call of 'of_node_put' at the end of the function.
The '_free()' attrubute is introduced by scope-based resource management in-kernel framework implemented in 'cleanup.h'. A pointer marked with '__free()' attribute makes a compiler insert a cleanup function call to the places where the pointer goes out of the scope. This feature allows to get rid of manual cleanup function calls.
---
This patch targets the next tree:
tree: git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
tag: next-20240411
--- drivers/tty/sysrq.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
drivers/tty/sysrq.c +3 -4
@@ -758,11 +758,12 @@ static void sysrq_detect_reset_sequence(struct sysrq_state *state,static void sysrq_of_get_keyreset_config (void ) {u32 key; -struct device_node *np;struct property *prop;const __be32 *p; - np =of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); + struct device_node *np __free(device_node) = +of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); +if (!np) {pr_debug ("No sysrq node found" );return ;
@@ -781,8 +782,6 @@ static void sysrq_of_get_keyreset_config(void)/* Get reset timeout if any. */ of_property_read_u32(np, "timeout-ms", &sysrq_reset_downtime_ms); - - of_node_put(np); }#else static void sysrq_of_get_keyreset_config (void )
Signature · 1 line
2.34.1
Greg KH
maintainerQuoted 25 lines · Roman Storozhenko
Add a cleanup function attribute '
__free(device_node)' to the device node pointer initialization statement and remove the pairing cleanup function call of 'of_node_put' at the end of the function.
The '_free()' attrubute is introduced by scope-based resource management in-kernel framework implemented in 'cleanup.h'. A pointer marked with '__free()' attribute makes a compiler insert a cleanup function call to the places where the pointer goes out of the scope. This feature allows to get rid of manual cleanup function calls.Suggested-by Julia.Lawall <[email protected]>Signed-off-by Roman Storozhenko <[email protected]>---
This patch targets the next tree:
tree:git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
tag: next-20240411--- drivers/tty/sysrq.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)drivers/tty/sysrq.c +0
-0@@ -758,11 +758,12 @@ static void sysrq_detect_reset_sequence(struct sysrq_state *state,static void sysrq_of_get_keyreset_config (void )
drivers/tty/sysrq.c static void sysrq_detect_reset_sequence(struct sysrq_state *state, · line 766
Quoted 10 lines
drivers/tty/sysrq.c +3
-2{u32 key; -struct device_node *np;struct property *prop;const __be32 *p; - np =of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); + struct device_node *np __free(device_node) = +of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); +
Did you run this through checkpatch.pl? Please do so.
Hi Greg,
This is the output of the checkpatch:
hedin@laptop:~/prj/linux-next$ ./scripts/checkpatch.pl --strict ~/lkmp/course_tasks/coccinele/patches/sysrq/v1/* -------------------------------------------------------------------------------- /home/hedin/lkmp/course_tasks/coccinele/patches/sysrq/v1/0000-cover-letter.patch -------------------------------------------------------------------------------- total: 0 errors, 0 warnings, 0 checks, 0 lines checked
/home/hedin/lkmp/course_tasks/coccinele/patches/sysrq/v1/0000-cover-letter.patch
has no obvious style problems and is ready for submission.
------------------------------------------------------------------------------------------------------------------------/home/hedin/lkmp/course_tasks/coccinele/patches/sysrq/v1/0001-sysrq-Auto-release-device-node-using-__free-attribut.patch
------------------------------------------------------------------------------------------------------------------------
total: 0 errors, 0 warnings, 0 checks, 16 lines checked
/home/hedin/lkmp/course_tasks/coccinele/patches/sysrq/v1/0001-sysrq-Auto-release-device-node-using-__free-attribut.patch has no obvious style problems and is ready for submission.
Before sending this patch to the mailing list I sent it to me, downloaded from the email, and then applied atop of the tree using git am. Encountered no issues.
I can guess that you checked the whole file and got some issues. But those are not related to my changes.
Thanks,
Roman
Quoted 40 lines · Greg KH
Quoted 25 lines · Roman Storozhenko
Add a cleanup function attribute '
__free(device_node)' to the device node pointer initialization statement and remove the pairing cleanup function call of 'of_node_put' at the end of the function.
The '_free()' attrubute is introduced by scope-based resource management in-kernel framework implemented in 'cleanup.h'. A pointer marked with '__free()' attribute makes a compiler insert a cleanup function call to the places where the pointer goes out of the scope. This feature allows to get rid of manual cleanup function calls.Suggested-by Julia.Lawall <[email protected]>Signed-off-by Roman Storozhenko <[email protected]>---
This patch targets the next tree:
tree:git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
tag: next-20240411--- drivers/tty/sysrq.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)drivers/tty/sysrq.c +0
-0@@ -758,11 +758,12 @@ static void sysrq_detect_reset_sequence(struct sysrq_state *state,static void sysrq_of_get_keyreset_config (void )drivers/tty/sysrq.c static void sysrq_detect_reset_sequence(struct sysrq_state *state, · line 766
Quoted 10 lines
drivers/tty/sysrq.c +3
-2{u32 key; -struct device_node *np;struct property *prop;const __be32 *p; - np =of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); + struct device_node *np __free(device_node) = +of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); +Did you run this through checkpatch.pl? Please do so.
Signature · 2 lines
Kind regards, Roman Storozhenko
Greg KH
maintainerQuoted 24 lines · Roman Storozhenko
Hi Greg,
This is the output of the checkpatch:
hedin@laptop:~/prj/linux-next$ ./scripts/checkpatch.pl --strict ~/lkmp/course_tasks/coccinele/patches/sysrq/v1/* -------------------------------------------------------------------------------- /home/hedin/lkmp/course_tasks/coccinele/patches/sysrq/v1/0000-cover-letter.patch -------------------------------------------------------------------------------- total: 0 errors, 0 warnings, 0 checks, 0 lines checked
/home/hedin/lkmp/course_tasks/coccinele/patches/sysrq/v1/0000-cover-letter.patch
has no obvious style problems and is ready for submission.
------------------------------------------------------------------------------------------------------------------------/home/hedin/lkmp/course_tasks/coccinele/patches/sysrq/v1/0001-sysrq-Auto-release-device-node-using-__free-attribut.patch
------------------------------------------------------------------------------------------------------------------------
total: 0 errors, 0 warnings, 0 checks, 16 lines checked
/home/hedin/lkmp/course_tasks/coccinele/patches/sysrq/v1/0001-sysrq-Auto-release-device-node-using-__free-attribut.patchhas no obvious style problems and is ready for submission.Before sending this patch to the mailing list I sent it to me, downloaded from the email, and then applied atop of the tree using git am. Encountered no issues.
Quoted 46 lines
I can guess that you checked the whole file and got some issues. But those are not related to my changes.
Thanks,
RomanQuoted 39 lines · Greg KH
Quoted 25 lines · Roman Storozhenko
Add a cleanup function attribute '
__free(device_node)' to the device node pointer initialization statement and remove the pairing cleanup function call of 'of_node_put' at the end of the function.
The '_free()' attrubute is introduced by scope-based resource management in-kernel framework implemented in 'cleanup.h'. A pointer marked with '__free()' attribute makes a compiler insert a cleanup function call to the places where the pointer goes out of the scope. This feature allows to get rid of manual cleanup function calls.Suggested-by Julia.Lawall <[email protected]>Signed-off-by Roman Storozhenko <[email protected]>---
This patch targets the next tree:
tree:git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
tag: next-20240411--- drivers/tty/sysrq.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)drivers/tty/sysrq.c +0
-0@@ -758,11 +758,12 @@ static void sysrq_detect_reset_sequence(struct sysrq_state *state,static void sysrq_of_get_keyreset_config (void )drivers/tty/sysrq.c static void sysrq_detect_reset_sequence(struct sysrq_state *state, · line 766
Quoted 10 lines
drivers/tty/sysrq.c +3
-2{u32 key; -struct device_node *np;struct property *prop;const __be32 *p; - np =of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); + struct device_node *np __free(device_node) = +of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); +Did you run this through checkpatch.pl? Please do so.
The issue is the blank line in the variable list now. Odd that checkpatch doesn't catch it, which implies the complexity added here might just not be a good idea :(
thanks,
greg k-h
Greg KH
maintainerQuoted 39 lines · Roman Storozhenko
Add a cleanup function attribute '
__free(device_node)' to the device node pointer initialization statement and remove the pairing cleanup function call of 'of_node_put' at the end of the function.
The '_free()' attrubute is introduced by scope-based resource management in-kernel framework implemented in 'cleanup.h'. A pointer marked with '__free()' attribute makes a compiler insert a cleanup function call to the places where the pointer goes out of the scope. This feature allows to get rid of manual cleanup function calls.Suggested-by Julia.Lawall <[email protected]>Signed-off-by Roman Storozhenko <[email protected]>---
This patch targets the next tree:
tree:git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
tag: next-20240411--- drivers/tty/sysrq.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)drivers/tty/sysrq.c +3
-2@@ -758,11 +758,12 @@ static void sysrq_detect_reset_sequence(struct sysrq_state *state,static void sysrq_of_get_keyreset_config (void ) {u32 key; -struct device_node *np;struct property *prop;const __be32 *p; - np =of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); + struct device_node *np __free(device_node) = +of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); +if (!np) {pr_debug ("No sysrq node found" );return ;
drivers/tty/sysrq.c static void sysrq_of_get_keyreset_config(void) · line 787
Quoted 8 lines
drivers/tty/sysrq.c +0
-2@@ -781,8 +782,6 @@ static void sysrq_of_get_keyreset_config(void)/* Get reset timeout if any. */ of_property_read_u32(np, "timeout-ms", &sysrq_reset_downtime_ms); - - of_node_put(np); }#else static void sysrq_of_get_keyreset_config (void )
Also, this change really makes no sense at all, the pointer never goes out of scope except when the function is over, at the bottom. So why make this complex change at all for no benefit?
In other words, properly understand the change you are making and only make it if it actually makes sense. It does not make any sense here, right?
thanks,
greg k-h
Quoted 53 lines · Greg KH
Quoted 39 lines · Roman Storozhenko
Add a cleanup function attribute '
__free(device_node)' to the device node pointer initialization statement and remove the pairing cleanup function call of 'of_node_put' at the end of the function.
The '_free()' attrubute is introduced by scope-based resource management in-kernel framework implemented in 'cleanup.h'. A pointer marked with '__free()' attribute makes a compiler insert a cleanup function call to the places where the pointer goes out of the scope. This feature allows to get rid of manual cleanup function calls.Suggested-by Julia.Lawall <[email protected]>Signed-off-by Roman Storozhenko <[email protected]>---
This patch targets the next tree:
tree:git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
tag: next-20240411--- drivers/tty/sysrq.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)drivers/tty/sysrq.c +3
-2@@ -758,11 +758,12 @@ static void sysrq_detect_reset_sequence(struct sysrq_state *state,static void sysrq_of_get_keyreset_config (void ) {u32 key; -struct device_node *np;struct property *prop;const __be32 *p; - np =of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); + struct device_node *np __free(device_node) = +of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); +if (!np) {pr_debug ("No sysrq node found" );return ;drivers/tty/sysrq.c static void sysrq_of_get_keyreset_config(void) · line 787
Quoted 8 lines
drivers/tty/sysrq.c +0
-2@@ -781,8 +782,6 @@ static void sysrq_of_get_keyreset_config(void)/* Get reset timeout if any. */ of_property_read_u32(np, "timeout-ms", &sysrq_reset_downtime_ms); - - of_node_put(np); }#else static void sysrq_of_get_keyreset_config (void )Also, this change really makes no sense at all, the pointer never goes out of scope except when the function is over, at the bottom. So why make this complex change at all for no benefit?
Quoted 3 lines
In other words, properly understand the change you are making and only make it if it actually makes sense. It does not make any sense here, right?
Maybe it would be nice to get rid of of_node_puts in the general case? Even though this one is not very annoying, there are some other functions where there are many of_node_puts, and convoluted error handling code to incorporate them on both the success and failure path. So maybe it would be better to avoid the situation of having them sometimes and not having them other times? But this is an opinion, and if the general consensus is to only get rid of the cases that currently add complexity, then that is possible too.
julia
Greg KH
maintainerQuoted 57 lines · Julia Lawall
Quoted 53 lines · Greg KH
Quoted 39 lines · Roman Storozhenko
Add a cleanup function attribute '
__free(device_node)' to the device node pointer initialization statement and remove the pairing cleanup function call of 'of_node_put' at the end of the function.
The '_free()' attrubute is introduced by scope-based resource management in-kernel framework implemented in 'cleanup.h'. A pointer marked with '__free()' attribute makes a compiler insert a cleanup function call to the places where the pointer goes out of the scope. This feature allows to get rid of manual cleanup function calls.Suggested-by Julia.Lawall <[email protected]>Signed-off-by Roman Storozhenko <[email protected]>---
This patch targets the next tree:
tree:git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
tag: next-20240411--- drivers/tty/sysrq.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)drivers/tty/sysrq.c +3
-2@@ -758,11 +758,12 @@ static void sysrq_detect_reset_sequence(struct sysrq_state *state,static void sysrq_of_get_keyreset_config (void ) {u32 key; -struct device_node *np;struct property *prop;const __be32 *p; - np =of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); + struct device_node *np __free(device_node) = +of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); +if (!np) {pr_debug ("No sysrq node found" );return ;drivers/tty/sysrq.c static void sysrq_of_get_keyreset_config(void) · line 787
Quoted 8 lines
drivers/tty/sysrq.c +0
-2@@ -781,8 +782,6 @@ static void sysrq_of_get_keyreset_config(void)/* Get reset timeout if any. */ of_property_read_u32(np, "timeout-ms", &sysrq_reset_downtime_ms); - - of_node_put(np); }#else static void sysrq_of_get_keyreset_config (void )Also, this change really makes no sense at all, the pointer never goes out of scope except when the function is over, at the bottom. So why make this complex change at all for no benefit?
Quoted 5 lines
Quoted 3 lines
In other words, properly understand the change you are making and only make it if it actually makes sense. It does not make any sense here, right?
Maybe it would be nice to get rid of
of_node_putsin the general case?
That's a call for the of maintainer to make, and then if so, to do it across the whole tree, right?
Quoted 7 lines
Even though this one is not very annoying, there are some other functions where there are many
of_node_puts, and convoluted error handling code to incorporate them on both the success and failure path. So maybe it would be better to avoid the situation of having them sometimes and not having them other times? But this is an opinion, and if the general consensus is to only get rid of the cases that currently add complexity, then that is possible too.
Let's keep things simple until it has to be complex please.
thanks,
greg k-h
[Adding the OF maintainers and device tree mailing list]
Quoted 4 lines
Quoted 1 line
Maybe it would be nice to get rid of
of_node_putsin the general case?That's a call for the of maintainer to make, and then if so, to do it across the whole tree, right?
Sure.
Rob and Saravana, what do you think about the following:
* Is it ok to use __free(device_tree) directly in a declaration, or is there some macro that should be used instead?
* If is ok to use __free(device_tree) even in simple cases where a variable is just declared at the start of the scope and freed at the end, and there is no internediate error handling code?
Please see for example:
https://lore.kernel.org/lkml/alpine.DEB.2.22.394.2401291455430.8649@hadrien/
But I don't think we can do the whole thing at once, in one patch. There are a lot of things that need to be checked, and it don't break anything to do them one at a time.
Quoted 10 lines
Quoted 8 lines
Even though this one is not very annoying, there are some other functions where there are many
of_node_puts, and convoluted error handling code to incorporate them on both the success and failure path. So maybe it would be better to avoid the situation of having them sometimes and not having them other times? But this is an opinion, and if the general consensus is to only get rid of the cases that currently add complexity, then that is possible too.Let's keep things simple until it has to be complex please.
I meant that the current code is complex and error prone, and using __free eliminates code that is ugly and has led to memory leaks in the past (and a lot of effort to find and fix them in the past). Even if some instances don't have that property, they may become more complex in the future, if some error condition is detected.
julia
Quoted 75 lines · Greg KH
Quoted 57 lines · Julia Lawall
Quoted 53 lines · Greg KH
Quoted 39 lines · Roman Storozhenko
Add a cleanup function attribute '
__free(device_node)' to the device node pointer initialization statement and remove the pairing cleanup function call of 'of_node_put' at the end of the function.
The '_free()' attrubute is introduced by scope-based resource management in-kernel framework implemented in 'cleanup.h'. A pointer marked with '__free()' attribute makes a compiler insert a cleanup function call to the places where the pointer goes out of the scope. This feature allows to get rid of manual cleanup function calls.Suggested-by Julia.Lawall <[email protected]>Signed-off-by Roman Storozhenko <[email protected]>---
This patch targets the next tree:
tree:git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
tag: next-20240411--- drivers/tty/sysrq.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)drivers/tty/sysrq.c +3
-2@@ -758,11 +758,12 @@ static void sysrq_detect_reset_sequence(struct sysrq_state *state,static void sysrq_of_get_keyreset_config (void ) {u32 key; -struct device_node *np;struct property *prop;const __be32 *p; - np =of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); + struct device_node *np __free(device_node) = +of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); +if (!np) {pr_debug ("No sysrq node found" );return ;drivers/tty/sysrq.c static void sysrq_of_get_keyreset_config(void) · line 787
Quoted 8 lines
drivers/tty/sysrq.c +0
-2@@ -781,8 +782,6 @@ static void sysrq_of_get_keyreset_config(void)/* Get reset timeout if any. */ of_property_read_u32(np, "timeout-ms", &sysrq_reset_downtime_ms); - - of_node_put(np); }#else static void sysrq_of_get_keyreset_config (void )Also, this change really makes no sense at all, the pointer never goes out of scope except when the function is over, at the bottom. So why make this complex change at all for no benefit?
Quoted 5 lines
Quoted 3 lines
In other words, properly understand the change you are making and only make it if it actually makes sense. It does not make any sense here, right?
Maybe it would be nice to get rid of
of_node_putsin the general case?That's a call for the of maintainer to make, and then if so, to do it across the whole tree, right?
Quoted 7 lines
Even though this one is not very annoying, there are some other functions where there are many
of_node_puts, and convoluted error handling code to incorporate them on both the success and failure path. So maybe it would be better to avoid the situation of having them sometimes and not having them other times? But this is an opinion, and if the general consensus is to only get rid of the cases that currently add complexity, then that is possible too.
Quoted 1 line
Let's keep things simple until it has to be complex please.
Jonathan Cameron pointed me to the following series from Rob Herring:
https://lore.kernel.org/linux-devicetree/[email protected]/
The patch for of_node_put is:
https://lore.kernel.org/linux-devicetree/[email protected]/
It uses __free directy. The cases in the file drivers/of/property.c have quite simple structure, with for each get just one put at the end of the scope in most cases.
julia
Quoted 5 lines
thanks,
greg k-h
This change allows us to put this pointer under automatic scope management and get rid of node_put. Besides, if a new code path is introduced we won't need to add a new of_node_put.
Thanks,
Roman
Quoted 61 lines · Greg KH
Quoted 39 lines · Roman Storozhenko
Add a cleanup function attribute '
__free(device_node)' to the device node pointer initialization statement and remove the pairing cleanup function call of 'of_node_put' at the end of the function.
The '_free()' attrubute is introduced by scope-based resource management in-kernel framework implemented in 'cleanup.h'. A pointer marked with '__free()' attribute makes a compiler insert a cleanup function call to the places where the pointer goes out of the scope. This feature allows to get rid of manual cleanup function calls.Suggested-by Julia.Lawall <[email protected]>Signed-off-by Roman Storozhenko <[email protected]>---
This patch targets the next tree:
tree:git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
tag: next-20240411--- drivers/tty/sysrq.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)drivers/tty/sysrq.c +3
-2@@ -758,11 +758,12 @@ static void sysrq_detect_reset_sequence(struct sysrq_state *state,static void sysrq_of_get_keyreset_config (void ) {u32 key; -struct device_node *np;struct property *prop;const __be32 *p; - np =of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); + struct device_node *np __free(device_node) = +of_find_node_by_path ("/chosen/linux,sysrq-reset-seq" ); +if (!np) {pr_debug ("No sysrq node found" );return ;drivers/tty/sysrq.c static void sysrq_of_get_keyreset_config(void) · line 787
Quoted 8 lines
drivers/tty/sysrq.c +0
-2@@ -781,8 +782,6 @@ static void sysrq_of_get_keyreset_config(void)/* Get reset timeout if any. */ of_property_read_u32(np, "timeout-ms", &sysrq_reset_downtime_ms); - - of_node_put(np); }#else static void sysrq_of_get_keyreset_config (void )Also, this change really makes no sense at all, the pointer never goes out of scope except when the function is over, at the bottom. So why make this complex change at all for no benefit?
In other words, properly understand the change you are making and only make it if it actually makes sense. It does not make any sense here, right?
thanks,
greg k-h
Signature · 2 lines
Kind regards, Roman Storozhenko
Greg KH
maintainerA: http://en.wikipedia.org/wiki/Top_post
Q: Were do I find info about this thing called top-posting?
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
A: Top-posting.
Q: What is the most annoying thing in e-mail?
A: No.
Q: Should I include quotations after my reply?
http://daringfireball.net/2007/07/on_top
Quoted 3 lines · Roman Storozhenko
This change allows us to put this pointer under automatic scope management and get rid of
node_put. Besides, if a new code path is introduced we won't need to add a newof_node_put.
We worry about future stuff then, in the future. So no need for changing code today for things that are not present at all, otherwise you would never be finished with anything, right?
Don't make things more complex when it is not needed. Only add complexity when it is needed.
thanks,
greg k-h