firmware_loader: allow firmware_class.path to take multiple paths
Subsystems (3)
v8 cover firmware_loader: allow firmware_class.path to take multiple paths
This version just has a couple of very minor nits fixed that sashiko flagged. I'd love to see this go into -next soon, so it can make v7.2.
Greg, are you ok with this version?
---
Changes in v8:
- add newline to output in fw_search_get()
- fix test #3 to test non-present file properly
- Link to v7: https://lore.kernel.org/r/[email protected]
Changes in v7:
- re-escape emitted paths in fw_search_get
- fix potential out-of-bounds read in fw_get_filesystem_firmware()
- ensure all files are cleaned up after failed selftests
- Link to v6: https://lore.kernel.org/r/[email protected]
Changes in v6:
- Add fw_search_unescape() to make the search path parsing more readable
- Rename search= to search_path=
- Link to v5: https://lore.kernel.org/r/[email protected]
Changes in v5:
- Increase search= string length from 256 to 4096
- Preprocess search= path when it's set rather than on every firmware load
- Add selftests for search= functionality
- Link to v4: https://lore.kernel.org/r/[email protected]
Changes in v4:
- Move search path to new search= option that is tried after path=
- Link to v3: https://lore.kernel.org/r/[email protected]
Changes in v3:
- Allow '\' to escape a literal ':' or '\' in the string
- Link to v2: https://lore.kernel.org/r/[email protected]
Changes in v2:
- switch to using ':' as path delimiter
- Link to v1: https://lore.kernel.org/r/[email protected]
---
Jeff Layton (2):
firmware_loader: add search_path= module option for multi-path firmware lookup selftests/firmware: add search path test for firmware_class.search_path=
drivers/base/firmware_loader/main.c | 306 +++++++++++++++++++------- tools/testing/selftests/firmware/Makefile | 2 +- tools/testing/selftests/firmware/fw_search.sh | 217 ++++++++++++++++++ 3 files changed, 448 insertions(+), 77 deletions(-)
---
base-commit: c369299895a591d96745d6492d4888259b004a9e
change-id: 20260317-fw-path-a094c30259a5
Best regards,
Signature · 1 line
Jeff Layton <[email protected]>
PATCH v8 1/2 firmware_loader: add search_path= module option for multi-path firmware lookup
Refactor fw_get_filesystem_firmware() by extracting the per-path firmware loading logic into a new fw_try_firmware_path() helper.
Add a new firmware_class.search_path= module option that accepts a ':'-separated list of firmware search directories. The input is preprocessed at set time (boot or sysfs write) into a NUL-separated sequence of paths, avoiding per-load parsing overhead. Backslash escapes are supported: '\:' for literal ':', '\\' for literal '\'.
The firmware lookup order is:
1. firmware_class.path= (single legacy path)
2. firmware_class.search_path= (colon-separated paths)
3. Built-in default paths (/lib/firmware/updates/..., /lib/firmware)
Example:
firmware_class.search_path=/custom/path1:/custom/path2
--- drivers/base/firmware_loader/main.c | 306 +++++++++++++++++++++++++++--------- 1 file changed, 230 insertions(+), 76 deletions(-)
drivers/base/firmware_loader/main.c +230 -76
@@ -469,8 +469,9 @@ static int fw_decompress_xz(struct device *dev, struct fw_priv *fw_priv,/* direct firmware loading support */ static char fw_path_para[256 ]; +static char fw_search_para[4096 ]; +static int fw_search_len;static const char *const fw_path[] = { - fw_path_para,"/lib/firmware/updates/" UTS_RELEASE ,"/lib/firmware/updates" ,"/lib/firmware/" UTS_RELEASE ,
@@ -485,6 +486,192 @@ static const char * const fw_path[] = {module_param_string (path, fw_path_para,sizeof (fw_path_para),0644 );MODULE_PARM_DESC (path,"customized firmware image search path with a higher priority than default path" ); +/* +* fw_search_unescape - copy src to dst, processing backslash escapes +* +* Handles '\:' (literal ':') and '\\' (literal '\'). Returns the number +* of bytes written (not counting the trailing NUL). +*/ +static int fw_search_unescape (char *dst,int dst_size,const char *src,int src_len) +{ +int i, len =0 ; + +for (i =0 ; i < src_len && len < dst_size -1 ; i++) { +if (src[i] =='\\' && i +1 < src_len && + (src[i +1 ] ==':' || src[i +1 ] =='\\' )) + i++; + dst[len++] = src[i]; + } + dst[len] ='\0' ; +return len; +} + +/* +* fw_search_set - preprocess a colon-separated search path string +* +* Converts the input into a NUL-separated sequence of paths stored in +* fw_search_para, with fw_search_len tracking the total used length. +* Backslash escapes '\:' (literal ':') and '\\' (literal '\'). +* Trailing newlines on each component are stripped. +*/ +static int fw_search_set (const char *val,const struct kernel_param *kp) +{ +int len =0 ; + +if (!val) { + fw_search_para[0 ] ='\0' ; + fw_search_len =0 ; +return 0 ; + } + +while (*val) { +const char *sep; +int comp_len, remaining; + +/* find the next unescaped ':' or end of string */ +for (sep = val; *sep; sep++) { +if (*sep =='\\' && (sep[1 ] ==':' || sep[1 ] =='\\' )) + sep++; +else if (*sep ==':' ) +break ; + } + + remaining =sizeof (fw_search_para) - len -1 ; + comp_len =fw_search_unescape (fw_search_para + len, remaining, + val, sep - val); + +/* strip trailing newline */ +if (comp_len >0 && fw_search_para[len + comp_len -1 ] =='\n' ) + comp_len--; + +/* only record non-empty components */ +if (comp_len >0 ) { + len += comp_len; + fw_search_para[len++] ='\0' ; + } + + val = *sep ? sep +1 : sep; + } + +/* ensure NUL termination even when empty */ + fw_search_para[len] ='\0' ; + fw_search_len = len; + +return 0 ; +} + +/* +* fw_search_get - reconstruct colon-separated string for sysfs reads +* +* Re-escapes ':' and '\' characters so the output can be written back +* to produce the same parsed result. +*/ +static int fw_search_get (char *buffer,const struct kernel_param *kp) +{ +const char *p; +int pos =0 ; + + p = fw_search_para; +while (p < fw_search_para + fw_search_len) { +int slen =strlen (p); +int i; + +if (!slen) +break ; +if (pos >0 && pos <PAGE_SIZE -1 ) + buffer[pos++] =':' ; +for (i =0 ; i < slen && pos <PAGE_SIZE -2 ; i++) { +if (p[i] ==':' || p[i] =='\\' ) + buffer[pos++] ='\\' ; + buffer[pos++] = p[i]; + } + p += slen +1 ; + } + buffer[pos++] ='\n' ; + buffer[pos] ='\0' ; +return pos; +} + +static const struct kernel_param_ops fw_search_ops = { + .set = fw_search_set, + .get = fw_search_get, +}; +module_param_cb (search_path, &fw_search_ops,NULL ,0644 ); +MODULE_PARM_DESC (search_path,"colon-separated list of firmware search paths, tried after path= (use '\\:' for literal ':', '\\\\' for literal '\\')" ); + +static int +fw_try_firmware_path (struct device *device,struct fw_priv *fw_priv, +const char *suffix, +int (*decompress)(struct device *dev, +struct fw_priv *fw_priv, +size_t in_size, +const void *in_buffer), +const char *dir,int dirlen, +char *path,void **bufp,size_t msize) +{ +size_t file_size =0 ; +size_t *file_size_ptr =NULL ; +size_t size; +int len, rc; + + len =snprintf (path,PATH_MAX ,"%.*s/%s%s" , + dirlen, dir, fw_priv->fw_name, suffix); +if (len >=PATH_MAX ) +return -ENAMETOOLONG ; + + fw_priv->size =0 ; + +/* +* The total file size is only examined when doing a partial +* read; the "full read" case needs to fail if the whole +* firmware was not completely loaded. +*/ +if ((fw_priv->opt_flags &FW_OPT_PARTIAL ) && *bufp) + file_size_ptr = &file_size; + +/* load firmware files from the mount namespace of init */ + rc =kernel_read_file_from_path_initns (path, fw_priv->offset, + bufp, msize, + file_size_ptr, +READING_FIRMWARE ); +if (rc <0 ) { +if (!(fw_priv->opt_flags &FW_OPT_NO_WARN )) { +if (rc != -ENOENT ) +dev_warn (device, +"loading %s failed with error %d\n" , + path, rc); +else +dev_dbg (device, +"loading %s failed for no such file or directory.\n" , + path); + } +return rc; + } + size = rc; + +dev_dbg (device,"Loading firmware from %s\n" , path); +if (decompress) { +dev_dbg (device,"f/w decompressing %s\n" , + fw_priv->fw_name); + rc =decompress (device, fw_priv, size, *bufp); +/* discard the superfluous original content */ +vfree (*bufp); + *bufp =NULL ; +if (rc) { +fw_free_paged_buf (fw_priv); +return rc; + } + }else { +dev_dbg (device,"direct-loading %s\n" , + fw_priv->fw_name); +if (!fw_priv->data) + fw_priv->data = *bufp; + fw_priv->size = size; + } +fw_state_done (fw_priv); +return 0 ; +} + static int fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv, const char *suffix,
@@ -493,10 +680,9 @@ fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv,size_t in_size, const void *in_buffer)) { - size_t size; -int i, len, maxlen =0 ; + int i;int rc = -ENOENT ; -char *path, *nt =NULL ; +char *path;size_t msize =INT_MAX ;void *buffer =NULL ;
@@ -511,83 +697,51 @@ fw_get_filesystem_firmware(struct device *device, struct fw_priv *fw_priv,return -ENOMEM ;wait_for_initramfs (); -for (i =0 ; i <ARRAY_SIZE (fw_path); i++) { -size_t file_size =0 ; -size_t *file_size_ptr =NULL ; - -/* skip the unset customized path */ -if (!fw_path[i][0 ]) -continue ; - -/* strip off \n from customized path */ - maxlen =strlen (fw_path[i]); -if (i ==0 ) { - nt =strchr (fw_path[i],'\n' ); -if (nt) - maxlen = nt - fw_path[i]; - } - len =snprintf (path,PATH_MAX ,"%.*s/%s%s" , - maxlen, fw_path[i], - fw_priv->fw_name, suffix); -if (len >=PATH_MAX ) { - rc = -ENAMETOOLONG ; -break ; - } +/* Try the customized path first */ +if (fw_path_para[0 ]) { +int dirlen =strlen (fw_path_para); - fw_priv->size =0 ; +/* strip trailing newline */ +if (dirlen >0 && fw_path_para[dirlen -1 ] =='\n' ) + dirlen--; -/* -* The total file size is only examined when doing a partial -* read; the "full read" case needs to fail if the whole -* firmware was not completely loaded. -*/ -if ((fw_priv->opt_flags &FW_OPT_PARTIAL ) && buffer) - file_size_ptr = &file_size; - -/* load firmware files from the mount namespace of init */ - rc =kernel_read_file_from_path_initns (path, fw_priv->offset, - &buffer, msize, - file_size_ptr, -READING_FIRMWARE ); -if (rc <0 ) { -if (!(fw_priv->opt_flags &FW_OPT_NO_WARN )) { -if (rc != -ENOENT ) -dev_warn (device, -"loading %s failed with error %d\n" , - path, rc); -else -dev_dbg (device, -"loading %s failed for no such file or directory.\n" , - path); - } -continue ; - } - size = rc; - rc =0 ; - -dev_dbg (device,"Loading firmware from %s\n" , path); -if (decompress) { -dev_dbg (device,"f/w decompressing %s\n" , - fw_priv->fw_name); - rc =decompress (device, fw_priv, size, buffer); -/* discard the superfluous original content */ -vfree (buffer); - buffer =NULL ; -if (rc) { -fw_free_paged_buf (fw_priv); -continue ; - } - }else { -dev_dbg (device,"direct-loading %s\n" , - fw_priv->fw_name); -if (!fw_priv->data) - fw_priv->data = buffer; - fw_priv->size = size; + rc =fw_try_firmware_path (device, fw_priv, suffix, decompress, + fw_path_para, dirlen, + path, &buffer, msize); +if (!rc) + goto done; + } + +/* Try each preprocessed NUL-separated path in fw_search_para */ +if (fw_search_len >0 ) { +const char *p = fw_search_para; + +while (p < fw_search_para + fw_search_len) { +int dirlen =strlen (p); + +if (!dirlen) +break ; + rc =fw_try_firmware_path (device, fw_priv, + suffix, decompress, + p, dirlen, + path, &buffer, msize); +if (!rc) + goto done; + p += dirlen +1 ; } -fw_state_done (fw_priv); -break ; } + +/* Try default firmware paths */ +for (i =0 ; i <ARRAY_SIZE (fw_path); i++) { + rc =fw_try_firmware_path (device, fw_priv, suffix, decompress, + fw_path[i],strlen (fw_path[i]), + path, &buffer, msize); +if (!rc) +break ; + } + +done:__putname (path);return rc;
Signature · 1 line
2.53.0
PATCH v8 2/2 selftests/firmware: add search path test for firmware_class.search_path=
In reply to Jeff LaytonAdd fw_search.sh, a new selftest to validate the firmware_class.search_path= module parameter. It covers multiple scenarios including prioritized path ordering, empty paths, path= priority over search_path=, sysfs readback, and escaped characters (colons and backslashes in directory names).
--- tools/testing/selftests/firmware/Makefile | 2 +- tools/testing/selftests/firmware/fw_search.sh | 217 ++++++++++++++++++++++++++ 2 files changed, 218 insertions(+), 1 deletion(-)
tools/testing/selftests/firmware/Makefile +1 -1
@@ -3,7 +3,7 @@ CFLAGS = -Wall \ -O2 -TEST_PROGS := fw_run_tests.sh +TEST_PROGS := fw_run_tests.sh fw_search.sh TEST_FILES := fw_fallback.sh fw_filesystem.sh fw_upload.sh fw_lib.sh TEST_GEN_FILES := fw_namespace
tools/testing/selftests/firmware/fw_search.sh new file +217 -0
217 lines not on this page · raw message
Signature · 1 line
2.53.0
Quoted 50 lines · Jeff Layton
This version just has a couple of very minor nits fixed that sashiko flagged. I'd love to see this go into -next soon, so it can make v7.2.
Greg, are you ok with this version?
Signed-off-by Jeff Layton <[email protected]>---
Changes in v8:
- add newline to output infw_search_get()
- fix test #3 to test non-present file properly
- Link to v7: https://lore.kernel.org/r/[email protected]Changes in v7:
- re-escape emitted paths infw_search_get
- fix potential out-of-bounds read infw_get_filesystem_firmware()
- ensure all files are cleaned up after failed selftests
- Link to v6: https://lore.kernel.org/r/[email protected]Changes in v6:
- Addfw_search_unescape()to make the search path parsing more readable
- Rename search= to search_path=
- Link to v5: https://lore.kernel.org/r/[email protected]Changes in v5:
- Increase search= string length from 256 to 4096
- Preprocess search= path when it's set rather than on every firmware load
- Add selftests for search= functionality
- Link to v4: https://lore.kernel.org/r/[email protected]Changes in v4:
- Move search path to new search= option that is tried after path=
- Link to v3: https://lore.kernel.org/r/[email protected]Changes in v3:
- Allow '\' to escape a literal ':' or '\' in the string
- Link to v2: https://lore.kernel.org/r/[email protected]Changes in v2:
- switch to using ':' as path delimiter
- Link to v1: https://lore.kernel.org/r/[email protected]---
Jeff Layton (2):
firmware_loader: add search_path= module option for multi-path firmware lookup selftests/firmware: add search path test for firmware_class.search_path=drivers/base/firmware_loader/main.c | 306 +++++++++++++++++++------- tools/testing/selftests/firmware/Makefile | 2 +- tools/testing/selftests/firmware/fw_search.sh | 217 ++++++++++++++++++ 3 files changed, 448 insertions(+), 77 deletions(-)
Quoted 5 lines
---
base-commit:c369299895a591d96745d6492d4888259b004a9e
change-id: 20260317-fw-path-a094c30259a5Best regards,
I wrote these patches before the recent addition of the agentic attribution guidelines. Both patches should get this tag as well:
Cheers,
Signature · 1 line
Jeff Layton <[email protected]>