Device property improvements, add %pfw format specifier
Subsystems (9)
Sakari Ailus
reviewerv7 cover Device property improvements, add %pfw format specifier
Hi all,
This set adds functionality into the device property API (counting a node's parents as well as obtaining its name) in order to support printing fwnode names using a new conversion specifier "%pfw". The names that are produced are equivalent to its OF counterpart "%pOF" on OF systems for the two supported modifiers ("f" and "P").
Printing a node's name is something that's been available on OF for a long time and if something is converted to device property API (such as the V4L2 fwnode framework) it always got removed of a nice feature that was sometimes essential in debugging. With this set, that no longer is the case.
Note: the set now depends on 2d44d165e939 ("scsi: lpfc: Convert existing %pf users to %ps") that is expected from the linux-scsi tree. It is
since v6:
- Added a patch for a warning note on re-using obsolete %pf oand %pF extensions.
- Rework %pfw validatition in checkpatch.pl according to Joe's comments.
- Unwrap a line wrapped by a previous versions in get_bprint_format().
- Handle %pf and %pF modifiers again in make_bprint_args() in case they're no followed by 'w'.
since v5:
- Added a patch to convert %pf to %ps in tools/lib/traceevent.c (first in the set).
- Fix ReST syntax in Documentation/core-api/printk-formats.rst.
- Fix returning root swnode name in patch "device property: Add fwnode_get_name for returning the name of a node". Use to_swnode() directly as well in the same patch.
- Tests: take root node name into account, use direct indices and remove the comma from the guardian entry.
- Add a comment on how fwnode_full_name_string() enumerates the nodes.
- Fix error string in fwnode_string().
- Move 'f' + default case as last in the switch in fwnode_string().
- Fix %pfw validation in checkpatch.pl.
since v4:
- Improved documentation for fwnode_get_nth_parent().
- Removed comma from the guardian entry in fwnode_pointer() testcase.
since v3:
- Remove underscores in argument name of fwnode_count_parents().
- Re-introduce "%pO?" error string.
- Unwrap a call to string() in fwnode_string().
- Removed a useless Depends-on: on a patch that was merged long ago.
- Unwrap a Fixes: line.
- Added a patch to move fwnode_get_parent() up to make the review of the following patch easier.
since v2:
- Better comments in acpi_fwnode_get_name_prefix().
- Added swnode implementation.
- Fixed swnode refcounting in get_parent() ("swnode: Get reference to parent swnode in get_parent op")
- Make argument to to_software_node() const (a new patch)
- Factored out confusingly named kobject_string() that had a single caller.
- Cleaner fwnode_count_parents() implementation (as discussed in review).
- Made fwnode_count_parents() argument const.
- Added tests (last patch in the set).
since v1:
- Add patch to remove support for %pf and %pF (depends on another patch removing all use of %pf and %pF) (now 4th patch)
- Fix kerneldoc argument documentation for fwnode_get_name (2nd patch)
- Align kerneldoc style with the rest of drivers/base/property.c (no extra newline after function name)
- Make checkpatch.pl complain about "%pf" not followed by "w" (6th patch)
- WARN_ONCE() on use of invalid conversion specifiers ("%pf" not followed by "w")
Sakari Ailus (13):
tools lib traceevent: Convert remaining %p[fF] users to %p[sS] software node: Get reference to parent swnode in get_parent op software node: Make argument to to_software_node const device property: Move fwnode_get_parent() up
device property: Add functions for accessing node's parents device property: Add fwnode_get_name for returning the name of a node device property: Add a function to obtain a node's prefix lib/vsprintf: Remove support for %pF and %pf in favour of %pS and %ps lib/vsprintf: Add a note on re-using %pf or %pF lib/vsprintf: Make use of fwnode API to obtain node names and
separators
lib/vsprintf: OF nodes are first and foremost, struct device_nodes lib/vsprintf: Add %pfw conversion specifier for printing fwnode names lib/test_printf: Add tests for %pfw printk modifier
Documentation/core-api/printk-formats.rst | 34 +++++-- drivers/acpi/property.c | 48 ++++++++++ drivers/base/property.c | 83 +++++++++++++++-- drivers/base/swnode.c | 43 ++++++++- drivers/of/property.c | 16 ++++ include/linux/fwnode.h | 4 + include/linux/property.h | 8 +- lib/test_printf.c | 32 +++++++ lib/vsprintf.c | 91 ++++++++++++------- scripts/checkpatch.pl | 9 +- .../Documentation/libtraceevent-func_apis.txt | 10 +- tools/lib/traceevent/event-parse.c | 18 +++- 12 files changed, 328 insertions(+), 68 deletions(-)
Signature · 1 line
2.20.1
Sakari Ailus
reviewerPATCH v7 1/13 tools lib traceevent: Convert remaining %p[fF] users to %p[sS]
There are no in-kernel %p[fF] users left. Convert the traceevent tool, too, to align with the kernel.
--- .../Documentation/libtraceevent-func_apis.txt | 10 +++++----- tools/lib/traceevent/event-parse.c | 18 ++++++++++++++---- 2 files changed, 19 insertions(+), 9 deletions(-)
tools/lib/traceevent/Documentation/libtraceevent-func_apis.txt +5 -5
@@ -59,12 +59,12 @@ parser context. The _tep_register_function()_ function registers a function name mapped to an address and (optional) module. This mapping is used in case the function tracer -or events have "%pF" or "%pS" parameter in its format string. It is common to -pass in the kallsyms function names with their corresponding addresses with this +or events have "%pS" parameter in its format string. It is common to pass in +the kallsyms function names with their corresponding addresses with this function. The _tep_ argument is the trace event parser context. The _name_ is -the name of the function, the string is copied internally. The _addr_ is -the start address of the function. The _mod_ is the kernel module -the function may be in (NULL for none). +the name of the function, the string is copied internally. The _addr_ is the +start address of the function. The _mod_ is the kernel module the function may +be in (NULL for none). The _tep_register_print_string()_ function registers a string by the address it was stored in the kernel. Some strings internal to the kernel with static
tools/lib/traceevent/event-parse.c +14 -4
@@ -4335,10 +4335,20 @@ static struct tep_print_arg *make_bprint_args(char *fmt, void *data, int size, sswitch (*ptr) {case 's' :case 'S' : -case 'f' : -case 'F' :case 'x' :break ; +case 'f' : +case 'F' : +/* +* Pre-5.5 kernels use %pf and +* %pF for printing symbols +* while kernels since 5.5 use +* %pfw for fwnodes. So check +* %p[fF] isn't followed by 'w'. +*/ +if (ptr[1 ] !='w' ) +break ; +/* fall through */ default :/* * Older kernels do not process
@@ -4455,12 +4465,12 @@ get_bprint_format(void *data, int size __maybe_unused, printk =find_printk (tep, addr);if (!printk) { -if (asprintf (&format,"%%pf: (NO FORMAT FOUND at %llx)\n" , addr) <0 ) +if (asprintf (&format,"%%ps: (NO FORMAT FOUND at %llx)\n" , addr) <0 )return NULL ;return format; } -if (asprintf (&format,"%s: %s" ,"%pf" , printk->printk) <0 ) +if (asprintf (&format,"%s: %s" ,"%ps" , printk->printk) <0 )return NULL ;return format;
Signature · 1 line
2.20.1
Re: [PATCH v7 01/13] tools lib traceevent: Convert remaining %p[fF] users to %p[sS]
Quoted 48 lines · On Wed, 18 Sep 2019 16:34:07 +0300 Sakari Ailus <[email protected]>…
There are no in-kernel %p[fF] users left. Convert the traceevent tool, too, to align with the kernel.
Signed-off-by Sakari Ailus <[email protected]>Cc Steven Rostedt <[email protected]>Cc Arnaldo Carvalho de Melo <[email protected]>Cc Tzvetomir Stoyanov <[email protected]>Cc Jiri Olsa <[email protected]>Cc Namhyung Kim <[email protected]>--- .../Documentation/libtraceevent-func_apis.txt | 10 +++++----- tools/lib/traceevent/event-parse.c | 18 ++++++++++++++---- 2 files changed, 19 insertions(+), 9 deletions(-)tools/lib/traceevent/Documentation/libtraceevent-func_apis.txt +5
-5@@ -59,12 +59,12 @@ parser context. The _tep_register_function()_ function registers a function name mapped to an address and (optional) module. This mapping is used in case the function tracer -or events have "%pF" or "%pS" parameter in its format string. It is common to -pass in the kallsyms function names with their corresponding addresses with this +or events have "%pS" parameter in its format string. It is common to pass in +the kallsyms function names with their corresponding addresses with this function. The _tep_ argument is the trace event parser context. The _name_ is -the name of the function, the string is copied internally. The _addr_ is -the start address of the function. The _mod_ is the kernel module -the function may be in (NULL for none). +the name of the function, the string is copied internally. The _addr_ is the +start address of the function. The _mod_ is the kernel module the function may +be in (NULL for none). The _tep_register_print_string()_ function registers a string by the address it was stored in the kernel. Some strings internal to the kernel with statictools/lib/traceevent/event-parse.c +0
-2@@ -4335,10 +4335,20 @@ static struct tep_print_arg *make_bprint_args(char *fmt, void *data, int size, sswitch (*ptr) {case 's' :case 'S' : -case 'f' : -case 'F' :case 'x' :
tools/lib/traceevent/event-parse.c static struct tep_print_arg *make_bprint_args(char *fmt, void *data, int size, s · line 4348
Quoted 10 lines
tools/lib/traceevent/event-parse.c +9
-0break ; +case 'f' : +case 'F' : +/* +* Pre-5.5 kernels use %pf and +* %pF for printing symbols +* while kernels since 5.5 use +* %pfw for fwnodes. So check +* %p[fF] isn't followed by 'w'. +*/
-- Steve
Quoted 21 lines
tools/lib/traceevent/event-parse.c +5
-2+if (ptr[1 ] !='w' ) +break ; +/* fall through */ default :/* * Older kernels do not process @@ -4455,12 +4465,12 @@ get_bprint_format(void *data, int size __maybe_unused, printk =find_printk (tep, addr);if (!printk) { -if (asprintf (&format,"%%pf: (NO FORMAT FOUND at %llx)\n" , addr) <0 ) +if (asprintf (&format,"%%ps: (NO FORMAT FOUND at %llx)\n" , addr) <0 )return NULL ;return format; } -if (asprintf (&format,"%s: %s" ,"%pf" , printk->printk) <0 ) +if (asprintf (&format,"%s: %s" ,"%ps" , printk->printk) <0 )return NULL ;return format;
Andy Shevchenko
reviewerRe: [PATCH v7 01/13] tools lib traceevent: Convert remaining %p[fF] users to %p[sS]
In reply to Sakari Ailustools/lib/traceevent/Documentation/libtraceevent-func_apis.txt parser context. · line 67
Quoted 10 lines · Sakari Ailus
There are no in-kernel %p[fF] users left. Convert the traceevent tool, too, to align with the kernel.
function. The _tep_ argument is the trace event parser context. The _name_ is
tools/lib/traceevent/Documentation/libtraceevent-func_apis.txt +3
-3-the name of the function, the string is copied internally. The _addr_ is -the start address of the function. The _mod_ is the kernel module -the function may be in (NULL for none). +the name of the function, the string is copied internally. The _addr_ is the +start address of the function. The _mod_ is the kernel module the function may +be in (NULL for none).
I think this is unneeded churn (reformating string). But since maintainer Acked this, I don't care much. But think about burden to the Git index in million of instances around the world.
Signature · 2 lines
With Best Regards, Andy Shevchenko
[tip: perf/urgent] tools lib traceevent: Convert remaining %p[fF] users to %p[sS]
In reply to Sakari AilusThe following commit has been merged into the perf/urgent branch of tip:
The following commit has been merged into the perf/urgent branch of tip:
Commit-ID: b295c3e39c1383e06ba1db4dd836018502e2ff3a Gitweb: https://git.kernel.org/tip/b295c3e39c1383e06ba1db4dd836018502e2ff3a Author: Sakari Ailus <[email protected]> AuthorDate: Wed, 18 Sep 2019 16:34:07 +03:00 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitterDate: Fri, 20 Sep 2019 10:28:26 -03:00
tools lib traceevent: Convert remaining %p[fF] users to %p[sS]
There are no in-kernel %p[fF] users left. Convert the traceevent tool, too, to align with the kernel.
--- tools/lib/traceevent/Documentation/libtraceevent-func_apis.txt | 10 ++-- tools/lib/traceevent/event-parse.c | 18 +++++-- 2 files changed, 19 insertions(+), 9 deletions(-)
tools/lib/traceevent/Documentation/libtraceevent-func_apis.txt +5 -5
@@ -59,12 +59,12 @@ parser context. The _tep_register_function()_ function registers a function name mapped to an address and (optional) module. This mapping is used in case the function tracer -or events have "%pF" or "%pS" parameter in its format string. It is common to -pass in the kallsyms function names with their corresponding addresses with this +or events have "%pS" parameter in its format string. It is common to pass in +the kallsyms function names with their corresponding addresses with this function. The _tep_ argument is the trace event parser context. The _name_ is -the name of the function, the string is copied internally. The _addr_ is -the start address of the function. The _mod_ is the kernel module -the function may be in (NULL for none). +the name of the function, the string is copied internally. The _addr_ is the +start address of the function. The _mod_ is the kernel module the function may +be in (NULL for none). The _tep_register_print_string()_ function registers a string by the address it was stored in the kernel. Some strings internal to the kernel with static
tools/lib/traceevent/event-parse.c +14 -4
@@ -4367,10 +4367,20 @@ static struct tep_print_arg *make_bprint_args(char *fmt, void *data, int size, sswitch (*ptr) {case 's' :case 'S' : -case 'f' : -case 'F' :case 'x' :break ; +case 'f' : +case 'F' : +/* +* Pre-5.5 kernels use %pf and +* %pF for printing symbols +* while kernels since 5.5 use +* %pfw for fwnodes. So check +* %p[fF] isn't followed by 'w'. +*/ +if (ptr[1 ] !='w' ) +break ; +/* fall through */ default :/* * Older kernels do not process
@@ -4487,12 +4497,12 @@ get_bprint_format(void *data, int size __maybe_unused, printk =find_printk (tep, addr);if (!printk) { -if (asprintf (&format,"%%pf: (NO FORMAT FOUND at %llx)\n" , addr) <0 ) +if (asprintf (&format,"%%ps: (NO FORMAT FOUND at %llx)\n" , addr) <0 )return NULL ;return format; } -if (asprintf (&format,"%s: %s" ,"%pf" , printk->printk) <0 ) +if (asprintf (&format,"%s: %s" ,"%ps" , printk->printk) <0 )return NULL ;return format;
Sakari Ailus
reviewerPATCH v7 2/13 software node: Get reference to parent swnode in get_parent op
In reply to Sakari AilusThe software_node_get_parent() returned a pointer to the parent swnode, but did not take a reference to it, leading the caller to put a reference that was not taken. Take that reference now.
--- drivers/base/swnode.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/base/swnode.c +4 -1
@@ -520,7 +520,10 @@ software_node_get_parent(const struct fwnode_handle *fwnode) {struct swnode *swnode =to_swnode (fwnode); -return swnode ? (swnode->parent ? &swnode->parent->fwnode :NULL ) :NULL ; +if (!swnode || !swnode->parent) +return NULL ; + +return fwnode_handle_get (&swnode->parent->fwnode); } static struct fwnode_handle *
Signature · 1 line
2.20.1
Sakari Ailus
reviewerPATCH v7 3/13 software node: Make argument to to_software_node const
In reply to Sakari Ailusto_software_node() does not need to modify the fwnode_handle it operates on; therefore make it const. This allows passing a const fwnode_handle to to_software_node().
--- drivers/base/swnode.c | 4 ++-- include/linux/property.h | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-)
drivers/base/swnode.c +2 -2
@@ -71,9 +71,9 @@ software_node_to_swnode(const struct software_node *node)return swnode; } -const struct software_node *to_software_node (struct fwnode_handle *fwnode) +const struct software_node *to_software_node (const struct fwnode_handle *fwnode) { -struct swnode *swnode =to_swnode (fwnode); +const struct swnode *swnode =to_swnode (fwnode);return swnode ? swnode->node :NULL ; }
include/linux/property.h +2 -1
@@ -418,7 +418,8 @@ struct software_node { };bool is_software_node (const struct fwnode_handle *fwnode); -const struct software_node *to_software_node (struct fwnode_handle *fwnode); +const struct software_node * +to_software_node (const struct fwnode_handle *fwnode);struct fwnode_handle *software_node_fwnode (const struct software_node *node);int software_node_register_nodes (const struct software_node *nodes);
Signature · 1 line
2.20.1
Sakari Ailus
reviewerPATCH v7 4/13 device property: Move fwnode_get_parent() up
In reply to Sakari AilusMove fwnode_get_parent() above fwnode_get_next_parent(), making the order the same as in the header file.
--- drivers/base/property.c | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-)
drivers/base/property.c +13 -13
@@ -556,6 +556,19 @@ int device_add_properties(struct device *dev, }EXPORT_SYMBOL_GPL (device_add_properties); +/** +* fwnode_get_parent - Return parent firwmare node +* @fwnode: Firmware whose parent is retrieved +* +* Return parent firmware node of the given node if possible or %NULL if no +* parent was available. +*/ +struct fwnode_handle *fwnode_get_parent (const struct fwnode_handle *fwnode) +{ +return fwnode_call_ptr_op (fwnode, get_parent); +} +EXPORT_SYMBOL_GPL (fwnode_get_parent); +/** * fwnode_get_next_parent - Iterate to the node's parent * @fwnode: Firmware whose parent is retrieved
@@ -577,19 +590,6 @@ struct fwnode_handle *fwnode_get_next_parent(struct fwnode_handle *fwnode) }EXPORT_SYMBOL_GPL (fwnode_get_next_parent); -/** -* fwnode_get_parent - Return parent firwmare node -* @fwnode: Firmware whose parent is retrieved -* -* Return parent firmware node of the given node if possible or %NULL if no -* parent was available. -*/ -struct fwnode_handle *fwnode_get_parent (const struct fwnode_handle *fwnode) -{ -return fwnode_call_ptr_op (fwnode, get_parent); -} -EXPORT_SYMBOL_GPL (fwnode_get_parent); -/** * fwnode_get_next_child_node - Return the next child node handle for a node * @fwnode: Firmware node to find the next child node for.
Signature · 1 line
2.20.1
Sakari Ailus
reviewerPATCH v7 5/13 device property: Add functions for accessing node's parents
In reply to Sakari AilusAdd two convenience functions for accessing node's parents:
fwnode_count_parents() returns the number of parent nodes a given node has. fwnode_get_nth_parent() returns node's parent at a given distance from the node itself.
--- drivers/base/property.c | 46 ++++++++++++++++++++++++++++++++++++++++ include/linux/property.h | 3 +++ 2 files changed, 49 insertions(+)
drivers/base/property.c +46 -0
@@ -590,6 +590,52 @@ struct fwnode_handle *fwnode_get_next_parent(struct fwnode_handle *fwnode) }EXPORT_SYMBOL_GPL (fwnode_get_next_parent); +/** +* fwnode_count_parents - Return the number of parents a node has +* @fwnode: The node the parents of which are to be counted +* +* Returns the number of parents a node has. +*/ +unsigned int fwnode_count_parents (const struct fwnode_handle *fwnode) +{ +struct fwnode_handle *__fwnode; +unsigned int count; + + __fwnode =fwnode_get_parent (fwnode); + +for (count =0 ; __fwnode; count++) + __fwnode =fwnode_get_next_parent (__fwnode); + +return count; +} +EXPORT_SYMBOL_GPL (fwnode_count_parents); + +/** +* fwnode_get_nth_parent - Return an nth parent of a node +* @fwnode: The node the parent of which is requested +* @depth: Distance of the parent from the node +* +* Returns the nth parent of a node. If there is no parent at the requested +* @depth, %NULL is returned. If @depth is 0, the functionality is equivalent to +* fwnode_handle_get(). For @depth == 1, it is fwnode_get_parent() and so on. +* +* The caller is responsible for calling fwnode_handle_put() for the returned +* node. +*/ +struct fwnode_handle *fwnode_get_nth_parent (struct fwnode_handle *fwnode, +unsigned int depth) +{ +unsigned int i; + +fwnode_handle_get (fwnode); + +for (i =0 ; i < depth && fwnode; i++) + fwnode =fwnode_get_next_parent (fwnode); + +return fwnode; +} +EXPORT_SYMBOL_GPL (fwnode_get_nth_parent); +/** * fwnode_get_next_child_node - Return the next child node handle for a node * @fwnode: Firmware node to find the next child node for.
include/linux/property.h +3 -0
@@ -83,6 +83,9 @@ struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode,struct fwnode_handle *fwnode_get_parent (const struct fwnode_handle *fwnode);struct fwnode_handle *fwnode_get_next_parent (struct fwnode_handle *fwnode); +unsigned int fwnode_count_parents (const struct fwnode_handle *fwn); +struct fwnode_handle *fwnode_get_nth_parent (struct fwnode_handle *fwn, +unsigned int depth);struct fwnode_handle *fwnode_get_next_child_node (const struct fwnode_handle *fwnode,struct fwnode_handle *child); struct fwnode_handle *fwnode_get_next_available_child_node(
Signature · 1 line
2.20.1
Sakari Ailus
reviewerPATCH v7 6/13 device property: Add fwnode_get_name for returning the name of a node
In reply to Sakari AilusThe fwnode framework did not have means to obtain the name of a node. Add that now, in form of the fwnode_get_name() function and a corresponding get_name fwnode op. OF and ACPI support is included.
--- drivers/acpi/property.c | 26 ++++++++++++++++++++++++++ drivers/base/property.c | 11 +++++++++++ drivers/base/swnode.c | 12 ++++++++++++ drivers/of/property.c | 6 ++++++ include/linux/fwnode.h | 2 ++ include/linux/property.h | 1 + 6 files changed, 58 insertions(+)
drivers/acpi/property.c +26 -0
@@ -1311,6 +1311,31 @@ acpi_fwnode_get_reference_args(const struct fwnode_handle *fwnode, args_count, args); } +static const char *acpi_fwnode_get_name (const struct fwnode_handle *fwnode) +{ +const struct acpi_device *adev; +struct fwnode_handle *parent; + +/* Is this the root node? */ + parent =fwnode_get_parent (fwnode); +if (!parent) +return "\\" ; + +fwnode_handle_put (parent); + +if (is_acpi_data_node (fwnode)) { +const struct acpi_data_node *dn =to_acpi_data_node (fwnode); + +return dn->name; + } + + adev =to_acpi_device_node (fwnode); +if (WARN_ON (!adev)) +return NULL ; + +return acpi_device_bid (adev); +} +static struct fwnode_handle *acpi_fwnode_get_parent (struct fwnode_handle *fwnode) {
@@ -1351,6 +1376,7 @@ acpi_fwnode_device_get_match_data(const struct fwnode_handle *fwnode, .get_parent = acpi_node_get_parent, \ .get_next_child_node = acpi_get_next_subnode, \ .get_named_child_node = acpi_fwnode_get_named_child_node, \ + .get_name = acpi_fwnode_get_name, \ .get_reference_args = acpi_fwnode_get_reference_args, \ .graph_get_next_endpoint = \ acpi_graph_get_next_endpoint, \
drivers/base/property.c +11 -0
@@ -556,6 +556,17 @@ int device_add_properties(struct device *dev, }EXPORT_SYMBOL_GPL (device_add_properties); +/** +* fwnode_get_name - Return the name of a node +* @fwnode: The firmware node +* +* Returns a pointer to the node name. +*/ +const char *fwnode_get_name (const struct fwnode_handle *fwnode) +{ +return fwnode_call_ptr_op (fwnode, get_name); +} +/** * fwnode_get_parent - Return parent firwmare node * @fwnode: Firmware whose parent is retrieved
drivers/base/swnode.c +12 -0
@@ -515,6 +515,17 @@ static int software_node_read_string_array(const struct fwnode_handle *fwnode, propname, val, nval); } +static const char * +software_node_get_name (const struct fwnode_handle *fwnode) +{ +const struct swnode *swnode =to_swnode (fwnode); + +if (!swnode) +return "(null)" ; + +return kobject_name (&swnode->kobj); +} +static struct fwnode_handle *software_node_get_parent (const struct fwnode_handle *fwnode) {
@@ -615,6 +626,7 @@ static const struct fwnode_operations software_node_ops = { .property_present = software_node_property_present, .property_read_int_array = software_node_read_int_array, .property_read_string_array = software_node_read_string_array, + .get_name = software_node_get_name, .get_parent = software_node_get_parent, .get_next_child_node = software_node_get_next_child, .get_named_child_node = software_node_get_named_child_node,
drivers/of/property.c +6 -0
@@ -872,6 +872,11 @@ of_fwnode_property_read_string_array(const struct fwnode_handle *fwnode,of_property_count_strings (node, propname); } +static const char *of_fwnode_get_name (const struct fwnode_handle *fwnode) +{ +return kbasename (to_of_node (fwnode)->full_name); +} +static struct fwnode_handle *of_fwnode_get_parent (const struct fwnode_handle *fwnode) {
@@ -993,6 +998,7 @@ const struct fwnode_operations of_fwnode_ops = { .property_present = of_fwnode_property_present, .property_read_int_array = of_fwnode_property_read_int_array, .property_read_string_array = of_fwnode_property_read_string_array, + .get_name = of_fwnode_get_name, .get_parent = of_fwnode_get_parent, .get_next_child_node = of_fwnode_get_next_child_node, .get_named_child_node = of_fwnode_get_named_child_node,
include/linux/fwnode.h +2 -0
@@ -56,6 +56,7 @@ struct fwnode_reference_args {* otherwise. * @property_read_string_array: Read an array of string properties. Return zero * on success, a negative error code otherwise. +* @get_name: Return the name of an fwnode. * @get_parent: Return the parent of an fwnode. * @get_next_child_node: Return the next child node in an iteration. * @get_named_child_node: Return a child node with a given name.
@@ -82,6 +83,7 @@ struct fwnode_operations { (*property_read_string_array)(const struct fwnode_handle *fwnode_handle, const char *propname, const char **val, size_t nval); +const char *(*get_name)(const struct fwnode_handle *fwnode);struct fwnode_handle *(*get_parent)(const struct fwnode_handle *fwnode);struct fwnode_handle * (*get_next_child_node)(const struct fwnode_handle *fwnode,
include/linux/property.h +1 -0
@@ -80,6 +80,7 @@ struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode,const char *name, unsigned int index); +const char *fwnode_get_name (const struct fwnode_handle *fwnode);struct fwnode_handle *fwnode_get_parent (const struct fwnode_handle *fwnode);struct fwnode_handle *fwnode_get_next_parent (struct fwnode_handle *fwnode);
Signature · 1 line
2.20.1
Sakari Ailus
reviewerPATCH v7 7/13 device property: Add a function to obtain a node's prefix
In reply to Sakari AilusThe prefix is used for printing purpose before a node, and it also works as a separator between two nodes.
--- drivers/acpi/property.c | 22 ++++++++++++++++++++++ drivers/base/property.c | 12 ++++++++++++ drivers/base/swnode.c | 22 ++++++++++++++++++++++ drivers/of/property.c | 10 ++++++++++ include/linux/fwnode.h | 2 ++ include/linux/property.h | 1 + 6 files changed, 69 insertions(+)
drivers/acpi/property.c +22 -0
@@ -1336,6 +1336,27 @@ static const char *acpi_fwnode_get_name(const struct fwnode_handle *fwnode)return acpi_device_bid (adev); } +static const char * +acpi_fwnode_get_name_prefix (const struct fwnode_handle *fwnode) +{ +struct fwnode_handle *parent; + +/* Is this the root node? */ + parent =fwnode_get_parent (fwnode); +if (!parent) +return "" ; + +/* Is this 2nd node from the root? */ + parent =fwnode_get_next_parent (parent); +if (!parent) +return "" ; + +fwnode_handle_put (parent); + +/* ACPI device or data node. */ +return "." ; +} +static struct fwnode_handle *acpi_fwnode_get_parent (struct fwnode_handle *fwnode) {
@@ -1377,6 +1398,7 @@ acpi_fwnode_device_get_match_data(const struct fwnode_handle *fwnode, .get_next_child_node = acpi_get_next_subnode, \ .get_named_child_node = acpi_fwnode_get_named_child_node, \ .get_name = acpi_fwnode_get_name, \ + .get_name_prefix = acpi_fwnode_get_name_prefix, \ .get_reference_args = acpi_fwnode_get_reference_args, \ .graph_get_next_endpoint = \ acpi_graph_get_next_endpoint, \
drivers/base/property.c +12 -0
@@ -567,6 +567,18 @@ const char *fwnode_get_name(const struct fwnode_handle *fwnode)return fwnode_call_ptr_op (fwnode, get_name); } +/** +* fwnode_get_name_prefix - Return the prefix of node for printing purposes +* @fwnode: The firmware node +* +* Returns the prefix of a node, intended to be printed right before the node. +* The prefix works also as a separator between the nodes. +*/ +const char *fwnode_get_name_prefix (const struct fwnode_handle *fwnode) +{ +return fwnode_call_ptr_op (fwnode, get_name_prefix); +} +/** * fwnode_get_parent - Return parent firwmare node * @fwnode: Firmware whose parent is retrieved
drivers/base/swnode.c +22 -0
@@ -526,6 +526,27 @@ software_node_get_name(const struct fwnode_handle *fwnode)return kobject_name (&swnode->kobj); } +static const char * +software_node_get_name_prefix (const struct fwnode_handle *fwnode) +{ +struct fwnode_handle *parent; +const char *prefix; + + parent =fwnode_get_parent (fwnode); +if (!parent) +return "" ; + +/* Figure out the prefix from the parents. */ +while (is_software_node (parent)) + parent =fwnode_get_next_parent (parent); + + prefix =fwnode_get_name_prefix (parent); +fwnode_handle_put (parent); + +/* Guess something if prefix was NULL. */ +return prefix ?:"/" ; +} +static struct fwnode_handle *software_node_get_parent (const struct fwnode_handle *fwnode) {
@@ -627,6 +648,7 @@ static const struct fwnode_operations software_node_ops = { .property_read_int_array = software_node_read_int_array, .property_read_string_array = software_node_read_string_array, .get_name = software_node_get_name, + .get_name_prefix = software_node_get_name_prefix, .get_parent = software_node_get_parent, .get_next_child_node = software_node_get_next_child, .get_named_child_node = software_node_get_named_child_node,
drivers/of/property.c +10 -0
@@ -877,6 +877,15 @@ static const char *of_fwnode_get_name(const struct fwnode_handle *fwnode)return kbasename (to_of_node (fwnode)->full_name); } +static const char *of_fwnode_get_name_prefix (const struct fwnode_handle *fwnode) +{ +/* Root needs no prefix here (its name is "/"). */ +if (!to_of_node (fwnode)->parent) +return "" ; + +return "/" ; +} +static struct fwnode_handle *of_fwnode_get_parent (const struct fwnode_handle *fwnode) {
@@ -999,6 +1008,7 @@ const struct fwnode_operations of_fwnode_ops = { .property_read_int_array = of_fwnode_property_read_int_array, .property_read_string_array = of_fwnode_property_read_string_array, .get_name = of_fwnode_get_name, + .get_name_prefix = of_fwnode_get_name_prefix, .get_parent = of_fwnode_get_parent, .get_next_child_node = of_fwnode_get_next_child_node, .get_named_child_node = of_fwnode_get_named_child_node,
include/linux/fwnode.h +2 -0
@@ -57,6 +57,7 @@ struct fwnode_reference_args {* @property_read_string_array: Read an array of string properties. Return zero * on success, a negative error code otherwise. * @get_name: Return the name of an fwnode. +* @get_name_prefix: Get a prefix for a node (for printing purposes). * @get_parent: Return the parent of an fwnode. * @get_next_child_node: Return the next child node in an iteration. * @get_named_child_node: Return a child node with a given name.
@@ -84,6 +85,7 @@ struct fwnode_operations { const char *propname, const char **val, size_t nval);const char *(*get_name)(const struct fwnode_handle *fwnode); +const char *(*get_name_prefix)(const struct fwnode_handle *fwnode);struct fwnode_handle *(*get_parent)(const struct fwnode_handle *fwnode);struct fwnode_handle * (*get_next_child_node)(const struct fwnode_handle *fwnode,
include/linux/property.h +1 -0
@@ -81,6 +81,7 @@ struct fwnode_handle *fwnode_find_reference(const struct fwnode_handle *fwnode, unsigned int index);const char *fwnode_get_name (const struct fwnode_handle *fwnode); +const char *fwnode_get_name_prefix (const struct fwnode_handle *fwnode);struct fwnode_handle *fwnode_get_parent (const struct fwnode_handle *fwnode);struct fwnode_handle *fwnode_get_next_parent (struct fwnode_handle *fwnode);
Signature · 1 line
2.20.1
Sakari Ailus
reviewerPATCH v7 8/13 lib/vsprintf: Remove support for %pF and %pf in favour of %pS and %ps
In reply to Sakari Ailus%pS and %ps are now the preferred conversion specifiers to print function names. The functionality is equivalent; remove the old, deprecated %pF and %pf support.
Depends-on: commit 2d44d165e939 ("scsi: lpfc: Convert existing %pf users to %ps")
--- Documentation/core-api/printk-formats.rst | 10 ---------- lib/vsprintf.c | 8 ++------ scripts/checkpatch.pl | 1 - 3 files changed, 2 insertions(+), 17 deletions(-)
Documentation/core-api/printk-formats.rst +0 -10
@@ -86,8 +86,6 @@ Symbols/Function Pointers %pS versatile_init+0x0/0x110 %ps versatile_init - %pF versatile_init+0x0/0x110 - %pf versatile_init %pSR versatile_init+0x9/0x110 (with __builtin_extract_return_addr() translation) %pB prev_fn_of_versatile_init+0x88/0x88
@@ -97,14 +95,6 @@ The ``S`` and ``s`` specifiers are used for printing a pointer in symbolic format. They result in the symbol name with (S) or without (s) offsets. If KALLSYMS are disabled then the symbol address is printed instead. -Note, that the ``F`` and ``f`` specifiers are identical to ``S`` (``s``) -and thus deprecated. We have ``F`` and ``f`` because on ia64, ppc64 and -parisc64 function pointers are indirect and, in fact, are function -descriptors, which require additional dereferencing before we can lookup -the symbol. As of now, ``S`` and ``s`` perform dereferencing on those -platforms (when needed), so ``F`` and ``f`` exist for compatibility -reasons only. - The ``B`` specifier results in the symbol name with offsets and should be used when printing stack backtraces. The specifier takes into consideration the effect of compiler optimisations which may occur
lib/vsprintf.c +2 -6
@@ -909,7 +909,7 @@ char *symbol_string(char *buf, char *end, void *ptr,#ifdef CONFIG_KALLSYMS if (*fmt =='B' )sprint_backtrace (sym, value); -else if (*fmt !='f' && *fmt !='s' ) +else if (*fmt !='s' )sprint_symbol (sym, value);else sprint_symbol_no_offset (sym, value);
@@ -2007,9 +2007,7 @@ static char *kobject_string(char *buf, char *end, void *ptr,* * - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset -* - 'F' Same as 'S' -* - 'f' Same as 's' -* - '[FfSs]R' as above with __builtin_extract_return_addr() translation +* - '[Ss]R' as above with __builtin_extract_return_addr() translation * - 'B' For backtraced symbolic direct pointers with offset * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref] * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
@@ -2112,8 +2110,6 @@ char *pointer(const char *fmt, char *buf, char *end, void *ptr, struct printf_spec spec) {switch (*fmt) { -case 'F' : -case 'f' :case 'S' :case 's' : ptr =dereference_symbol_descriptor (ptr);
scripts/checkpatch.pl +0 -1
@@ -6012,7 +6012,6 @@ sub process { my $ext_type = "Invalid"; my $use = ""; if ($bad_specifier =~ /p[Ff]/) { - $ext_type = "Deprecated"; $use = " - use %pS instead"; $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); }
Signature · 1 line
2.20.1
Rafael J. Wysocki
maintainerRe: [PATCH v7 08/13] lib/vsprintf: Remove support for %pF and %pf in favour of %pS and %ps
Quoted 6 lines · Sakari Ailus
%pS and %ps are now the preferred conversion specifiers to print function names. The functionality is equivalent; remove the old, deprecated %pF and %pf support.
Depends-on: commit
2d44d165e939("scsi: lpfc: Convert existing %pf users to %ps")
Where is this commit present?
Not in the mainline as of today.
Quoted 84 lines
Signed-off-by Sakari Ailus <[email protected]>Reviewed-by Andy Shevchenko <[email protected]>--- Documentation/core-api/printk-formats.rst | 10 ---------- lib/vsprintf.c | 8 ++------ scripts/checkpatch.pl | 1 - 3 files changed, 2 insertions(+), 17 deletions(-)Documentation/core-api/printk-formats.rst +0
-10@@ -86,8 +86,6 @@ Symbols/Function Pointers %pS versatile_init+0x0/0x110 %ps versatile_init - %pF versatile_init+0x0/0x110 - %pf versatile_init %pSR versatile_init+0x9/0x110 (with __builtin_extract_return_addr() translation) %pB prev_fn_of_versatile_init+0x88/0x88@@ -97,14 +95,6 @@ The ``S`` and ``s`` specifiers are used for printing a pointer in symbolic format. They result in the symbol name with (S) or without (s) offsets. If KALLSYMS are disabled then the symbol address is printed instead. -Note, that the ``F`` and ``f`` specifiers are identical to ``S`` (``s``) -and thus deprecated. We have ``F`` and ``f`` because on ia64, ppc64 and -parisc64 function pointers are indirect and, in fact, are function -descriptors, which require additional dereferencing before we can lookup -the symbol. As of now, ``S`` and ``s`` perform dereferencing on those -platforms (when needed), so ``F`` and ``f`` exist for compatibility -reasons only. - The ``B`` specifier results in the symbol name with offsets and should be used when printing stack backtraces. The specifier takes into consideration the effect of compiler optimisations which may occurlib/vsprintf.c +2
-6@@ -909,7 +909,7 @@ char *symbol_string(char *buf, char *end, void *ptr,#ifdef CONFIG_KALLSYMS if (*fmt =='B' )sprint_backtrace (sym, value); -else if (*fmt !='f' && *fmt !='s' ) +else if (*fmt !='s' )sprint_symbol (sym, value);else sprint_symbol_no_offset (sym, value);@@ -2007,9 +2007,7 @@ static char *kobject_string(char *buf, char *end, void *ptr,* * - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset -* - 'F' Same as 'S' -* - 'f' Same as 's' -* - '[FfSs]R' as above with __builtin_extract_return_addr() translation +* - '[Ss]R' as above with __builtin_extract_return_addr() translation * - 'B' For backtraced symbolic direct pointers with offset * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref] * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201] @@ -2112,8 +2110,6 @@ char *pointer(const char *fmt, char *buf, char *end, void *ptr, struct printf_spec spec) {switch (*fmt) { -case 'F' : -case 'f' :case 'S' :case 's' : ptr =dereference_symbol_descriptor (ptr);scripts/checkpatch.pl +0
-2@@ -6012,7 +6012,6 @@ sub process { my $ext_type = "Invalid"; my $use = ""; if ($bad_specifier =~ /p[Ff]/) { - $ext_type = "Deprecated"; $use = " - use %pS instead"; $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); } --2.20.1
Petr Mladek
maintainerRe: [PATCH v7 08/13] lib/vsprintf: Remove support for %pF and %pf in favour of %pS and %ps
In reply to Sakari AilusQuoted 27 lines · Sakari Ailus
%pS and %ps are now the preferred conversion specifiers to print function names. The functionality is equivalent; remove the old, deprecated %pF and %pf support.
lib/vsprintf.c +2
-4@@ -909,7 +909,7 @@ char *symbol_string(char *buf, char *end, void *ptr,#ifdef CONFIG_KALLSYMS if (*fmt =='B' )sprint_backtrace (sym, value); -else if (*fmt !='f' && *fmt !='s' ) +else if (*fmt !='s' )sprint_symbol (sym, value);else sprint_symbol_no_offset (sym, value);@@ -2007,9 +2007,7 @@ static char *kobject_string(char *buf, char *end, void *ptr,* * - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset -* - 'F' Same as 'S' -* - 'f' Same as 's' -* - '[FfSs]R' as above with __builtin_extract_return_addr() translation +* - '[Ss]R' as above with __builtin_extract_return_addr() translation * - 'B' For backtraced symbolic direct pointers with offset * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref] * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
lib/vsprintf.c char *pointer(const char *fmt, char *buf, char *end, void *ptr, · line 2115
Quoted 8 lines
lib/vsprintf.c +0
-2@@ -2112,8 +2110,6 @@ char *pointer(const char *fmt, char *buf, char *end, void *ptr, struct printf_spec spec) {switch (*fmt) { -case 'F' : -case 'f' :case 'S' :case 's' : ptr =dereference_symbol_descriptor (ptr);
IMHO, we should do the same also in vbin_printf().
The compatibility with traceevent tools was discussed in the thread
https://lkml.kernel.org/r/[email protected]
If I understand it correctly the tools should be able to handle stored 'f' and 'F' modifiers because they might be produced by older kernels. But new kernels should not longer produce them.
Otherwise the patch looks good to me. I am getting used to the fact that we will remove the obsolete specifiers completely.
Best Regards,
Petr
Sakari Ailus
reviewerRe: [PATCH v7 08/13] lib/vsprintf: Remove support for %pF and %pf in favour of %pS and %ps
Hi Petr,
Thank you for the review.
Quoted 39 lines · Petr Mladek
Quoted 27 lines · Sakari Ailus
%pS and %ps are now the preferred conversion specifiers to print function names. The functionality is equivalent; remove the old, deprecated %pF and %pf support.
lib/vsprintf.c +2
-4@@ -909,7 +909,7 @@ char *symbol_string(char *buf, char *end, void *ptr,#ifdef CONFIG_KALLSYMS if (*fmt =='B' )sprint_backtrace (sym, value); -else if (*fmt !='f' && *fmt !='s' ) +else if (*fmt !='s' )sprint_symbol (sym, value);else sprint_symbol_no_offset (sym, value);@@ -2007,9 +2007,7 @@ static char *kobject_string(char *buf, char *end, void *ptr,* * - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset -* - 'F' Same as 'S' -* - 'f' Same as 's' -* - '[FfSs]R' as above with __builtin_extract_return_addr() translation +* - '[Ss]R' as above with __builtin_extract_return_addr() translation * - 'B' For backtraced symbolic direct pointers with offset * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref] * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201] lib/vsprintf.c char *pointer(const char *fmt, char *buf, char *end, void *ptr, · line 2115
Quoted 8 lines
lib/vsprintf.c +0
-2@@ -2112,8 +2110,6 @@ char *pointer(const char *fmt, char *buf, char *end, void *ptr, struct printf_spec spec) {switch (*fmt) { -case 'F' : -case 'f' :case 'S' :case 's' : ptr =dereference_symbol_descriptor (ptr);IMHO, we should do the same also in
vbin_printf().
Quoted 6 lines
The compatibility with traceevent tools was discussed in the thread
https://lkml.kernel.org/r/[email protected]If I understand it correctly the tools should be able to handle stored 'f' and 'F' modifiers because they might be produced by older kernels. But new kernels should not longer produce them.
Agreed.
Quoted 3 lines
Otherwise the patch looks good to me. I am getting used to the fact that we will remove the obsolete specifiers completely.
I'll address this in v8 soon.
Signature · 4 lines
Regards, Sakari Ailus [email protected]
Sakari Ailus
reviewerPATCH v7 9/13 lib/vsprintf: Add a note on re-using %pf or %pF
In reply to Sakari AilusAdd a note warning of re-use of obsolete %pf or %pF extensions.
--- lib/vsprintf.c | 2 ++ 1 file changed, 2 insertions(+)
lib/vsprintf.c +2 -0
@@ -2008,6 +2008,8 @@ static char *kobject_string(char *buf, char *end, void *ptr,* - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset * - '[Ss]R' as above with __builtin_extract_return_addr() translation +* - '[Ff]' Obsolete an now unsupported extension for printing direct pointers +* or function descriptors. Be careful when re-using %pf or %pF! * - 'B' For backtraced symbolic direct pointers with offset * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref] * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Signature · 1 line
2.20.1
Steven Rostedt
maintainerRe: [PATCH v7 09/13] lib/vsprintf: Add a note on re-using %pf or %pF
Quoted 4 lines · On Wed, 18 Sep 2019 16:34:15 +0300 Sakari Ailus <[email protected]>…
Add a note warning of re-use of obsolete %pf or %pF extensions.
Signed-off-by Sakari Ailus <[email protected]>Cc Steven Rostedt <[email protected]>
lib/vsprintf.c static char *kobject_string(char *buf, char *end, void *ptr, · line 2011
Quoted 13 lines
--- lib/vsprintf.c | 2 ++ 1 file changed, 2 insertions(+)lib/vsprintf.c +1
-0@@ -2008,6 +2008,8 @@ static char *kobject_string(char *buf, char *end, void *ptr,* - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset * - '[Ss]R' as above with __builtin_extract_return_addr() translation +* - '[Ff]' Obsolete an now unsupported extension for printing direct pointers
"Obsolete and now"?
-- Steve
Quoted 4 lines
lib/vsprintf.c +1
-0+* or function descriptors. Be careful when re-using %pf or %pF! * - 'B' For backtraced symbolic direct pointers with offset * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref] * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Sakari Ailus
reviewerRe: [PATCH v7 09/13] lib/vsprintf: Add a note on re-using %pf or %pF
Quoted 9 lines · Steven Rostedt
Quoted 4 lines · On Wed, 18 Sep 2019 16:34:15 +0300 Sakari Ailus <[email protected]>…
Add a note warning of re-use of obsolete %pf or %pF extensions.
Signed-off-by Sakari Ailus <[email protected]>Cc Steven Rostedt <[email protected]>Suggested-by Steven Rostedt (VMware) <[email protected]>
Yes, I'll add that for v8.
Quoted 5 lines
Quoted 5 lines
--- lib/vsprintf.c | 2 ++ 1 file changed, 2 insertions(+)
Quoted 11 lines
lib/vsprintf.c static char *kobject_string(char *buf, char *end, void *ptr, · line 2011
Quoted 9 lines
lib/vsprintf.c +1
-0@@ -2008,6 +2008,8 @@ static char *kobject_string(char *buf, char *end, void *ptr,* - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset * - '[Ss]R' as above with __builtin_extract_return_addr() translation +* - '[Ff]' Obsolete an now unsupported extension for printing direct pointers "Obsolete and now"?
Fixed.
Signature · 2 lines
Sakari Ailus [email protected]
Sakari Ailus
reviewerPATCH v8 9/13 lib/vsprintf: Add a note on re-using %pf or %pF
In reply to Sakari AilusAdd a note warning of re-use of obsolete %pf or %pF extensions.
--- lib/vsprintf.c | 2 ++ 1 file changed, 2 insertions(+)
lib/vsprintf.c +2 -0
@@ -2008,6 +2008,8 @@ static char *kobject_string(char *buf, char *end, void *ptr,* - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset * - '[Ss]R' as above with __builtin_extract_return_addr() translation +* - '[Ff]' Obsolete and now unsupported extension for printing direct pointers +* or function descriptors. Be careful when re-using %pf or %pF! * - 'B' For backtraced symbolic direct pointers with offset * - 'R' For decoded struct resource, e.g., [mem 0x0-0x1f 64bit pref] * - 'r' For raw struct resource, e.g., [mem 0x0-0x1f flags 0x201]
Signature · 1 line
2.20.1
Petr Mladek
maintainerRe: [PATCH v7 09/13] lib/vsprintf: Add a note on re-using %pf or %pF
In reply to Sakari AilusQuoted 13 lines · Sakari Ailus
Add a note warning of re-use of obsolete %pf or %pF extensions.
Signed-off-by Sakari Ailus <[email protected]>Cc Steven Rostedt <[email protected]>--- lib/vsprintf.c | 2 ++ 1 file changed, 2 insertions(+)lib/vsprintf.c +0
-0
lib/vsprintf.c static char *kobject_string(char *buf, char *end, void *ptr, · line 2012
Quoted 5 lines
lib/vsprintf.c +2
-0@@ -2008,6 +2008,8 @@ static char *kobject_string(char *buf, char *end, void *ptr,* - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset * - '[Ss]R' as above with __builtin_extract_return_addr() translation +* - '[Ff]' Obsolete an now unsupported extension for printing direct pointers +* or function descriptors. Be careful when re-using %pf or %pF!
I am not a native speaker but the sentence is hard to parse to me. Also I miss the word 'symbolic'. IMHO, it described that the output was a symbol name.
What about something like?
* - '[Ff]' %pf and %pF were obsoleted and later removed in favor of
* %ps and %pS. Be careful when re-using these specifiers.
Best Regards,
Petr
Sakari Ailus
reviewerRe: [PATCH v7 09/13] lib/vsprintf: Add a note on re-using %pf or %pF
Quoted 24 lines · Petr Mladek
Quoted 13 lines · Sakari Ailus
Add a note warning of re-use of obsolete %pf or %pF extensions.
Signed-off-by Sakari Ailus <[email protected]>Cc Steven Rostedt <[email protected]>--- lib/vsprintf.c | 2 ++ 1 file changed, 2 insertions(+)lib/vsprintf.c +0
-0lib/vsprintf.c static char *kobject_string(char *buf, char *end, void *ptr, · line 2012
Quoted 5 lines
lib/vsprintf.c +2
-0@@ -2008,6 +2008,8 @@ static char *kobject_string(char *buf, char *end, void *ptr,* - 'S' For symbolic direct pointers (or function descriptors) with offset * - 's' For symbolic direct pointers (or function descriptors) without offset * - '[Ss]R' as above with __builtin_extract_return_addr() translation +* - '[Ff]' Obsolete an now unsupported extension for printing direct pointers +* or function descriptors. Be careful when re-using %pf or %pF! I am not a native speaker but the sentence is hard to parse to me. Also I miss the word 'symbolic'. IMHO, it described that the output was a symbol name.
Quoted 4 lines
What about something like?
* - '[Ff]' %pf and %pF were obsoleted and later removed in favor of
* %ps and %pS. Be careful when re-using these specifiers.
Yes, I'll use this in v8.
Signature · 2 lines
Sakari Ailus [email protected]
Sakari Ailus
reviewerPATCH v7 10/13 lib/vsprintf: Make use of fwnode API to obtain node names and separators
In reply to Sakari AilusInstead of implementing our own means of discovering parent nodes, node names or counting how many parents a node has, use the newly added functions in the fwnode API to obtain that information.
--- lib/vsprintf.c | 39 +++++++++++++++++---------------------- 1 file changed, 17 insertions(+), 22 deletions(-)
lib/vsprintf.c +17 -22
@@ -38,6 +38,7 @@#include <net/addrconf.h> #include <linux/siphash.h> #include <linux/compiler.h> +#include <linux/property.h> #ifdef CONFIG_BLOCK #include <linux/blkdev.h> #endif
@@ -1863,32 +1864,25 @@ char *flags_string(char *buf, char *end, void *flags_ptr,return format_flags (buf, end, flags, names); } -static const char *device_node_name_for_depth (const struct device_node *np,int depth) -{ -for ( ; np && depth; depth--) - np = np->parent; - -return kbasename (np->full_name); -} -static noinline_for_stack -char *device_node_gen_full_name(const struct device_node *np, char *buf, char *end) +char *fwnode_full_name_string(struct fwnode_handle *fwnode, char *buf, +char *end) {int depth; -const struct device_node *parent = np->parent; -/* special case for root node */ -if (!parent) -return string_nocheck (buf, end,"/" , default_str_spec); +/* Loop starting from the root node to the current node. */ +for (depth =fwnode_count_parents (fwnode); depth >=0 ; depth--) { +struct fwnode_handle *__fwnode = +fwnode_get_nth_parent (fwnode, depth); -for (depth =0 ; parent->parent; depth++) - parent = parent->parent; - -for ( ; depth >=0 ; depth--) { - buf =string_nocheck (buf, end,"/" , default_str_spec); - buf =string (buf, end,device_node_name_for_depth (np, depth), + buf =string (buf, end,fwnode_get_name_prefix (__fwnode), + default_str_spec); + buf =string (buf, end,fwnode_get_name (__fwnode), default_str_spec); + +fwnode_handle_put (__fwnode); } +return buf; }
@@ -1933,10 +1927,11 @@ char *device_node_string(char *buf, char *end, struct device_node *dn,switch (*fmt) {case 'f' :/* full_name */ - buf =device_node_gen_full_name (dn, buf, end); + buf =fwnode_full_name_string (of_fwnode_handle (dn), buf, + end);break ;case 'n' :/* name */ - p =kbasename (of_node_full_name (dn)); + p =fwnode_get_name (of_fwnode_handle (dn)); precision = str_spec.precision; str_spec.precision =strchrnul (p,'@' ) - p; buf =string (buf, end, p, str_spec);
@@ -1946,7 +1941,7 @@ char *device_node_string(char *buf, char *end, struct device_node *dn, buf =number (buf, end, (unsigned int )dn->phandle, num_spec);break ;case 'P' :/* path-spec */ - p =kbasename (of_node_full_name (dn)); + p =fwnode_get_name (of_fwnode_handle (dn));if (!p[1 ]) p ="/" ; buf =string (buf, end, p, str_spec);
Signature · 1 line
2.20.1
Sakari Ailus
reviewerPATCH v7 11/13 lib/vsprintf: OF nodes are first and foremost, struct device_nodes
In reply to Sakari AilusFactor out static kobject_string() function that simply calls device_node_string(), and thus remove references to kobjects (as these are struct device_node).
--- lib/vsprintf.c | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-)
lib/vsprintf.c +4 -12
@@ -1906,6 +1906,9 @@ char *device_node_string(char *buf, char *end, struct device_node *dn,struct printf_spec str_spec = spec; str_spec.field_width =-1 ; +if (fmt[0 ] !='F' ) +return error_string (buf, end,"(%pO?)" , spec); +if (!IS_ENABLED (CONFIG_OF ))return error_string (buf, end,"(%pOF?)" , spec);
@@ -1979,17 +1982,6 @@ char *device_node_string(char *buf, char *end, struct device_node *dn,return widen_string (buf, buf - buf_start, end, spec); } -static char *kobject_string (char *buf,char *end,void *ptr, -struct printf_spec spec,const char *fmt) -{ -switch (fmt[1 ]) { -case 'F' : -return device_node_string (buf, end, ptr, spec, fmt +1 ); - } - -return error_string (buf, end,"(%pO?)" , spec); -} -/* * Show a '%p' thing. A kernel extension is that the '%p' is followed * by an extra set of alphanumeric characters that are extended format
@@ -2170,7 +2162,7 @@ char *pointer(const char *fmt, char *buf, char *end, void *ptr,case 'G' :return flags_string (buf, end, ptr, spec, fmt);case 'O' : -return kobject_string (buf, end, ptr, spec, fmt); +return device_node_string (buf, end, ptr, spec, fmt +1 );case 'x' :return pointer_string (buf, end, ptr, spec); }
Signature · 1 line
2.20.1
Sakari Ailus
reviewerPATCH v7 12/13 lib/vsprintf: Add %pfw conversion specifier for printing fwnode names
In reply to Sakari AilusAdd support for %pfw conversion specifier (with "f" and "P" modifiers) to support printing full path of the node, including its name ("f") and only the node's name ("P") in the printk family of functions. The two flags have equivalent functionality to existing %pOF with the same two modifiers ("f" and "P") on OF based systems. The ability to do the same on ACPI based systems is added by this patch.
On ACPI based systems the resulting strings look like
\[email protected]@0
where the nodes are separated by a dot (".") and the first three are ACPI device nodes and the latter two ACPI data nodes.
--- Documentation/core-api/printk-formats.rst | 24 +++++++++++++++ lib/vsprintf.c | 36 +++++++++++++++++++++++ scripts/checkpatch.pl | 8 +++-- 3 files changed, 66 insertions(+), 2 deletions(-)
Documentation/core-api/printk-formats.rst +24 -0
@@ -418,6 +418,30 @@ Examples:: Passed by reference. +Fwnode handles +-------------- + +:: + + %pfw[fP] + +For printing information on fwnode handles. The default is to print the full +node name, including the path. The modifiers are functionally equivalent to +%pOF above. + + - f - full name of the node, including the path + - P - the name of the node including an address (if there is one) + +Examples (ACPI):: + + %pfwf \[email protected]@0 - Full node name + %pfwP endpoint@0 - Node name + +Examples (OF):: + + %pfwf /ocp@68000000/i2c@48072000/camera@10/port/endpoint - Full name + %pfwP endpoint - Node name + Time and date (struct rtc_time) -------------------------------
lib/vsprintf.c +36 -0
@@ -1982,6 +1982,36 @@ char *device_node_string(char *buf, char *end, struct device_node *dn,return widen_string (buf, buf - buf_start, end, spec); } +static noinline_for_stack +char *fwnode_string(char *buf, char *end, struct fwnode_handle *fwnode, +struct printf_spec spec,const char *fmt) +{ +struct printf_spec str_spec = spec; +char *buf_start = buf; + + str_spec.field_width =-1 ; + +if (*fmt !='w' ) +return error_string (buf, end,"(%pf?)" , spec); + +if (check_pointer (&buf, end, fwnode, spec)) +return buf; + + fmt++; + +switch (*fmt) { +case 'P' :/* name */ + buf =string (buf, end,fwnode_get_name (fwnode), str_spec); +break ; +case 'f' :/* full_name */ +default : + buf =fwnode_full_name_string (fwnode, buf, end); +break ; + } + +return widen_string (buf, buf - buf_start, end, spec); +} +/* * Show a '%p' thing. A kernel extension is that the '%p' is followed * by an extra set of alphanumeric characters that are extended format
@@ -2086,6 +2116,10 @@ char *device_node_string(char *buf, char *end, struct device_node *dn,* F device node flags * c major compatible string * C full compatible string +* - 'fw[fP]' For a firmware node (struct fwnode_handle) pointer +* Without an option prints the full name of the node +* f full name +* P node name, including a possible unit address * - 'x' For printing the address. Equivalent to "%lx". * * ** When making changes please also update:
@@ -2163,6 +2197,8 @@ char *pointer(const char *fmt, char *buf, char *end, void *ptr,return flags_string (buf, end, ptr, spec, fmt);case 'O' :return device_node_string (buf, end, ptr, spec, fmt +1 ); +case 'f' : +return fwnode_string (buf, end, ptr, spec, fmt +1 );case 'x' :return pointer_string (buf, end, ptr, spec); }
scripts/checkpatch.pl +6 -2
@@ -5988,14 +5988,18 @@ sub process { for (my $count = $linenr; $count <= $lc; $count++) { my $specifier; my $extension; + my $qualifier; my $bad_specifier = ""; my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); $fmt =~ s/%%//g; - while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) { + while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { $specifier = $1; $extension = $2; - if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOxt]/) { + $qualifier = $3; + if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOxtf]/ || + ($extension eq "f" && + defined $qualifier && $qualifier !~ /^w/)) { $bad_specifier = $specifier; last; }
Signature · 1 line
2.20.1
Re: [PATCH v7 12/13] lib/vsprintf: Add %pfw conversion specifier for printing fwnode names
Quoted 9 lines · Sakari Ailus
Add support for %pfw conversion specifier (with "f" and "P" modifiers) to support printing full path of the node, including its name ("f") and only the node's name ("P") in the printk family of functions. The two flags have equivalent functionality to existing %pOF with the same two modifiers ("f" and "P") on OF based systems. The ability to do the same on ACPI based systems is added by this patch.
On ACPI based systems the resulting strings look like
Quoted 7 lines
\[email protected]@0where the nodes are separated by a dot (".") and the first three are ACPI device nodes and the latter two ACPI data nodes.
Signed-off-by Sakari Ailus <[email protected]>Reviewed-by Andy Shevchenko <[email protected]>
Best Regards,
Petr
Sakari Ailus
reviewerPATCH v7 13/13 lib/test_printf: Add tests for %pfw printk modifier
In reply to Sakari AilusAdd a test for the %pfw printk modifier using software nodes.
--- lib/test_printf.c | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+)
lib/test_printf.c +32 -0
@@ -22,6 +22,8 @@#include <linux/gfp.h> #include <linux/mm.h> +#include <linux/property.h> +#include "../tools/testing/selftests/kselftest_module.h" #define BUF_SIZE 256
@@ -588,6 +590,35 @@ flags(void)kfree (cmp_buffer); } +static void __init fwnode_pointer (void ) +{ +const struct software_node softnodes[] = { + { .name ="first" , }, + { .name ="second" , .parent = &softnodes[0 ], }, + { .name ="third" , .parent = &softnodes[1 ], }, + {NULL /* Guardian */ } + }; +const char *const full_name ="first/second/third" ; +const char *const full_name_second ="first/second" ; +const char *const second_name ="second" ; +const char *const third_name ="third" ; +int rval; + + rval =software_node_register_nodes (softnodes); +if (rval) { +pr_warn ("cannot register softnodes; rval %d\n" , rval); +return ; + } + +test (full_name_second,"%pfw" ,software_node_fwnode (&softnodes[1 ])); +test (full_name,"%pfw" ,software_node_fwnode (&softnodes[2 ])); +test (full_name,"%pfwf" ,software_node_fwnode (&softnodes[2 ])); +test (second_name,"%pfwP" ,software_node_fwnode (&softnodes[1 ])); +test (third_name,"%pfwP" ,software_node_fwnode (&softnodes[2 ])); + +software_node_unregister_nodes (softnodes); +} +static void __init test_pointer (void ) {
@@ -610,6 +641,7 @@ test_pointer(void)bitmap ();netdev_features ();flags (); +fwnode_pointer (); }static void __init selftest (void )
Signature · 1 line
2.20.1
Re: [PATCH v7 13/13] lib/test_printf: Add tests for %pfw printk modifier
Quoted 4 lines · Sakari Ailus
Add a test for the %pfw printk modifier using software nodes.
Signed-off-by Sakari Ailus <[email protected]>Reviewed-by Andy Shevchenko <[email protected]>
Best Regards,
Petr
Rafael J. Wysocki
maintainerQuoted 9 lines · Sakari Ailus
Hi all,
This set adds functionality into the device property API (counting a node's parents as well as obtaining its name) in order to support printing fwnode names using a new conversion specifier "%pfw". The names that are produced are equivalent to its OF counterpart "%pOF" on OF systems for the two supported modifiers ("f" and "P").
Quoted 8 lines
Printing a node's name is something that's been available on OF for a long time and if something is converted to device property API (such as the V4L2 fwnode framework) it always got removed of a nice feature that was sometimes essential in debugging. With this set, that no longer is the case.
Note: the set now depends on
2d44d165e939("scsi: lpfc: Convert existing %pf users to %ps") that is expected from the linux-scsi tree. It is
OK, so I will be expecting a refresh of the series when the above commit appears in the mainline.
Cheers,
Rafael
Sakari Ailus
reviewerQuoted 17 lines · Rafael J. Wysocki
Quoted 15 lines · Sakari Ailus
Hi all,
This set adds functionality into the device property API (counting a node's parents as well as obtaining its name) in order to support printing fwnode names using a new conversion specifier "%pfw". The names that are produced are equivalent to its OF counterpart "%pOF" on OF systems for the two supported modifiers ("f" and "P").
Printing a node's name is something that's been available on OF for a long time and if something is converted to device property API (such as the V4L2 fwnode framework) it always got removed of a nice feature that was sometimes essential in debugging. With this set, that no longer is the case.
Quoted 5 lines
Quoted 2 lines
Note: the set now depends on
2d44d165e939("scsi: lpfc: Convert existing %pf users to %ps") that is expected from the linux-scsi tree. It isOK, so I will be expecting a refresh of the series when the above commit appears in the mainline.
Works for me. I'll send v8 then, with Depends-on removed.
Signature · 2 lines
Sakari Ailus [email protected]