ASoC: wm_adsp_fw_find_test: Fix a couple of bugs
Subsystems (3)
cover ASoC: wm_adsp_fw_find_test: Fix a couple of bugs
This short series fixes two bugs in wm_adsp_fw_find_test.
Richard Fitzgerald (2):
ASoC: wm_adsp_fw_find_test: Redirect wm_adsp_release_firmware_files()
ASoC: wm_adsp_fw_find_test: Clear searched_fw_files in find-by-index
test
sound/soc/codecs/wm_adsp_fw_find_test.c | 57 ++++++++++++++++++++----- 1 file changed, 47 insertions(+), 10 deletions(-)
Signature · 1 line
2.47.3
PATCH 1/2 ASoC: wm_adsp_fw_find_test: Redirect wm_adsp_release_firmware_files()
Redirect wm_adsp_release_firmware_files() to a replacement function that handles the dummy firmware created by the tests. Use the same cleanup function to cleanup in the test exit() function. Also call it on each loop in wm_adsp_fw_find_test_find_firmware_byindex() to free the created strings before reusing priv->found_fw on the next loop.
wm_adsp_release_firmware_files() will pass the struct firmware* pointers to release_firmware(). But the pointers created by the tests are dummies and must not be passed to release_firmware().
The test never invokes wm_adsp_release_firmware_files() so it wasn't redirected. But the error handling in wm_adsp_request_firmware_files() calls wm_adsp_release_firmware_files(). The redirected function makes this safe.
Using the same cleanup function to perform cleanup from the test exit() handler and wm_adsp_fw_find_test_find_firmware_byindex() avoids the risk of duplicate cleanup code that all needs updating if there is any change to the cleanup requirements.
This problem was found by https://sashiko.dev.
--- sound/soc/codecs/wm_adsp_fw_find_test.c | 56 ++++++++++++++++++++----- 1 file changed, 46 insertions(+), 10 deletions(-)
sound/soc/codecs/wm_adsp_fw_find_test.c +46 -10
@@ -45,6 +45,34 @@ struct wm_adsp_fw_find_test_params {/* Dummy struct firmware to return from wm_adsp_request_firmware_files */ static const struct firmware wm_adsp_find_test_dummy_firmware; +static void wm_adsp_fw_find_test_release_firmware_files_stub (struct wm_adsp_fw_files *fw) +{ +/* +* fw->wmfw.firmware and fw->coeff.firmware allocated by this KUnit +* test are dummies not allocated by the real request_firmware() call +* so they must not be passed to release_firmware(). +* This function replaces wm_adsp_release_firmware_files(). +*/ + +if (!fw) +return ; + +kfree (fw->wmfw.filename); +kfree (fw->coeff.filename); + + fw->wmfw.firmware =NULL ; + fw->coeff.firmware =NULL ; + fw->wmfw.filename =NULL ; + fw->coeff.filename =NULL ; +} + +static void wm_adsp_free_found_fw (struct kunit *test) +{ +struct wm_adsp_fw_find_test *priv = test->priv; + +wm_adsp_fw_find_test_release_firmware_files_stub (&priv->found_fw); +} +/* Simple lookup of a filename in a list of names */ static int wm_adsp_fw_find_test_firmware_request_simple_stub(const struct firmware **firmware, const char *filename,
@@ -97,9 +125,14 @@ static void wm_adsp_fw_find_test_pick_file(struct kunit *test)kunit_activate_static_stub (test, wm_adsp_firmware_request, wm_adsp_fw_find_test_firmware_request_simple_stub); +kunit_activate_static_stub (test, + wm_adsp_release_firmware_files, + wm_adsp_fw_find_test_release_firmware_files_stub); ret =wm_adsp_request_firmware_files (dsp, &priv->found_fw);kunit_deactivate_static_stub (test, wm_adsp_firmware_request); +kunit_deactivate_static_stub (test, wm_adsp_release_firmware_files); +KUNIT_EXPECT_EQ_MSG (test, ret, (params->expect_wmfw || params->expect_bin) ?0 : -ENOENT ,"%s\n" , priv->searched_fw_files);
@@ -173,10 +206,13 @@ static void wm_adsp_fw_find_test_search_order(struct kunit *test)kunit_activate_static_stub (test, wm_adsp_firmware_request, wm_adsp_fw_find_test_firmware_request_stub); +kunit_activate_static_stub (test, + wm_adsp_release_firmware_files, + wm_adsp_fw_find_test_release_firmware_files_stub);wm_adsp_request_firmware_files (dsp, &priv->found_fw); -kunit_deactivate_static_stub (test, wm_adsp_firmware_request); +kunit_deactivate_static_stub (test, wm_adsp_release_firmware_files);KUNIT_EXPECT_STREQ (test, priv->searched_fw_files, params->expected_searches);
@@ -201,6 +237,7 @@ static void wm_adsp_fw_find_test_find_firmware_byindex(struct kunit *test) dsp->cs_dsp.name ="cs1234" ; dsp->part ="dsp1" ; +for (dsp->fw =0 ;; dsp->fw++) { fw_name =wm_adsp_get_fwf_name_by_index (dsp->fw);if (!fw_name)
@@ -209,14 +246,21 @@ static void wm_adsp_fw_find_test_find_firmware_byindex(struct kunit *test)kunit_activate_static_stub (test, wm_adsp_firmware_request, wm_adsp_fw_find_test_firmware_request_stub); +kunit_activate_static_stub (test, + wm_adsp_release_firmware_files, + wm_adsp_fw_find_test_release_firmware_files_stub);wm_adsp_request_firmware_files (dsp, &priv->found_fw); +kunit_deactivate_static_stub (test, wm_adsp_firmware_request); +kunit_deactivate_static_stub (test, wm_adsp_release_firmware_files);KUNIT_EXPECT_NOT_NULL_MSG (test,strstr (priv->searched_fw_files, fw_name),"fw#%d Did not find '%s' in '%s'\n" , dsp->fw, fw_name, priv->searched_fw_files); + +wm_adsp_free_found_fw (test); } }
@@ -255,15 +299,7 @@ static int wm_adsp_fw_find_test_case_init(struct kunit *test)static void wm_adsp_fw_find_test_case_exit (struct kunit *test) { -struct wm_adsp_fw_find_test *priv = test->priv; - -/* -* priv->found_wmfw_firmware and priv->found_bin_firmware are -* dummies not allocated by the real request_firmware() call they -* must not be passed to release_firmware(). -*/ -kfree (priv->found_fw.wmfw.filename); -kfree (priv->found_fw.coeff.filename); +wm_adsp_free_found_fw (test); } static void wm_adsp_fw_find_test_param_desc(const struct wm_adsp_fw_find_test_params *param,
Signature · 1 line
2.47.3
PATCH 2/2 ASoC: wm_adsp_fw_find_test: Clear searched_fw_files in find-by-index test
In reply to Richard FitzgeraldIn wm_adsp_fw_find_test_find_firmware_byindex() the content of priv->searched_fw_files must be cleared before starting the next iteration.
The files searched for are appended to priv->searched_fw_files, so if it is not cleared on each iteration it will still contain the searches from the previous iteration.
--- sound/soc/codecs/wm_adsp_fw_find_test.c | 1 + 1 file changed, 1 insertion(+)
sound/soc/codecs/wm_adsp_fw_find_test.c +1 -0
@@ -261,6 +261,7 @@ static void wm_adsp_fw_find_test_find_firmware_byindex(struct kunit *test) dsp->fw, fw_name, priv->searched_fw_files);wm_adsp_free_found_fw (test); +memset (priv->searched_fw_files,0 ,sizeof (priv->searched_fw_files)); } }
Signature · 1 line
2.47.3
Mark Brown
maintainerQuoted 10 lines · Richard Fitzgerald
ASoC:
wm_adsp_fw_find_test: Fix a couple of bugsThis short series fixes two bugs in
wm_adsp_fw_find_test.Richard Fitzgerald (2):
ASoC:wm_adsp_fw_find_test: Redirectwm_adsp_release_firmware_files()
ASoC:wm_adsp_fw_find_test: Clearsearched_fw_filesin find-by-index
test[...]
Applied to
https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-7.1
Thanks!
[1/2] ASoC: wm_adsp_fw_find_test: Redirect wm_adsp_release_firmware_files()
https://git.kernel.org/broonie/sound/c/78538047717b [2/2] ASoC: wm_adsp_fw_find_test: Clear searched_fw_files in find-by-index test https://git.kernel.org/broonie/sound/c/af64f7909699
All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.
You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.
If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.
Please add any relevant lists and maintainers to the CCs when replying to this mail.
Thanks,
Mark