Skip to contentSkip to conversation

ASoC: use seq_file to dump the contents of dai_list,platform_list and codec_list

PATCH In review Donglin Peng 3 participants 9 messages Jan 18, 2018 – Feb 8, 2018

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 ASoC: use seq_file to dump the contents of dai_list,platform_list and codec_list

Now the debugfs files dais/platforms/codecs have a size limit PAGE_SIZE and the user can not see the whole contents of dai_list/platform_list/codec_list when they are larger than this limit.

This patch uses seq_file instead to make sure dais/platforms/codecs show the full contents of dai_list/platform_list/codec_list.

---
Changelog
v2
-fix commit log error

 sound/soc/soc-core.c | 111 +++++++++++++++++----------------------------------
 1 file changed, 37 insertions(+), 74 deletions(-)
sound/soc/soc-core.c +37 -74
index c0edac80df34..7b582112e3fc 100644
@@ -349,120 +349,84 @@ static void soc_init_codec_debugfs(struct snd_soc_component *component)
 			"ASoC: Failed to create codec register debugfs file\n");
 }
 
-static ssize_t codec_list_read_file(struct file *file, char __user *user_buf,
-				    size_t count, loff_t *ppos)
+static int codec_list_seq_show(struct seq_file *m, void *v)
 {
-	char *buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
-	ssize_t len, ret = 0;
 	struct snd_soc_codec *codec;
 
-	if (!buf)
-		return -ENOMEM;
-
 	mutex_lock(&client_mutex);
 
-	list_for_each_entry(codec, &codec_list, list) {
-		len = snprintf(buf + ret, PAGE_SIZE - ret, "%s\n",
-			       codec->component.name);
-		if (len >= 0)
-			ret += len;
-		if (ret > PAGE_SIZE) {
-			ret = PAGE_SIZE;
-			break;
-		}
-	}
+	list_for_each_entry(codec, &codec_list, list)
+		seq_printf(m, "%s\n", codec->component.name);
 
 	mutex_unlock(&client_mutex);
 
-	if (ret >= 0)
-		ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
-
-	kfree(buf);
+	return 0;
+}
 
-	return ret;
+static int codec_list_seq_open(struct inode *inode, struct file *file)
+{
+	return single_open(file, codec_list_seq_show, NULL);
 }
 
 static const struct file_operations codec_list_fops = {
-	.read = codec_list_read_file,
-	.llseek = default_llseek,/* read accesses f_pos */
+	.open = codec_list_seq_open,
+	.read = seq_read,
+	.llseek = seq_lseek,
+	.release = single_release,
 };
 
-static ssize_t dai_list_read_file(struct file *file, char __user *user_buf,
-				  size_t count, loff_t *ppos)
+static int dai_list_seq_show(struct seq_file *m, void *v)
 {
-	char *buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
-	ssize_t len, ret = 0;
 	struct snd_soc_component *component;
 	struct snd_soc_dai *dai;
 
-	if (!buf)
-		return -ENOMEM;
-
 	mutex_lock(&client_mutex);
 
-	list_for_each_entry(component, &component_list, list) {
-		list_for_each_entry(dai, &component->dai_list, list) {
-			len = snprintf(buf + ret, PAGE_SIZE - ret, "%s\n",
-				dai->name);
-			if (len >= 0)
-				ret += len;
-			if (ret > PAGE_SIZE) {
-				ret = PAGE_SIZE;
-				break;
-			}
-		}
-	}
+	list_for_each_entry(component, &component_list, list)
+		list_for_each_entry(dai, &component->dai_list, list)
+			seq_printf(m, "%s\n", dai->name);
 
 	mutex_unlock(&client_mutex);
 
-	ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
-
-	kfree(buf);
+	return 0;
+}
 
-	return ret;
+static int dai_list_seq_open(struct inode *inode, struct file *file)
+{
+	return single_open(file, dai_list_seq_show, NULL);
 }
 
 static const struct file_operations dai_list_fops = {
-	.read = dai_list_read_file,
-	.llseek = default_llseek,/* read accesses f_pos */
+	.open = dai_list_seq_open,
+	.read = seq_read,
+	.llseek = seq_lseek,
+	.release = single_release,
 };
 
-static ssize_t platform_list_read_file(struct file *file,
-				       char __user *user_buf,
-				       size_t count, loff_t *ppos)
+static int platform_list_seq_show(struct seq_file *m, void *v)
 {
-	char *buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
-	ssize_t len, ret = 0;
 	struct snd_soc_platform *platform;
 
-	if (!buf)
-		return -ENOMEM;
-
 	mutex_lock(&client_mutex);
 
-	list_for_each_entry(platform, &platform_list, list) {
-		len = snprintf(buf + ret, PAGE_SIZE - ret, "%s\n",
-			       platform->component.name);
-		if (len >= 0)
-			ret += len;
-		if (ret > PAGE_SIZE) {
-			ret = PAGE_SIZE;
-			break;
-		}
-	}
+	list_for_each_entry(platform, &platform_list, list)
+		seq_printf(m, "%s\n", platform->component.name);
 
 	mutex_unlock(&client_mutex);
 
-	ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
-
-	kfree(buf);
+	return 0;
+}
 
-	return ret;
+static int platform_list_seq_open(struct inode *inode, struct file *file)
+{
+	return single_open(file, platform_list_seq_show, NULL);
 }
 
 static const struct file_operations platform_list_fops = {
-	.read = platform_list_read_file,
-	.llseek = default_llseek,/* read accesses f_pos */
+	.open = platform_list_seq_open,
+	.read = seq_read,
+	.llseek = seq_lseek,
+	.release = single_release,
 };
 
 static void soc_init_card_debugfs(struct snd_soc_card *card)
@@ -491,7 +455,6 @@ static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
 	debugfs_remove_recursive(card->debugfs_card_root);
 }
 
-
 static void snd_soc_debugfs_init(void)
 {
 	snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
Signature · 1 line
2.15.1
#1 lore raw
Quoted 6 lines · Donglin Peng

Now the debugfs files dais/platforms/codecs have a size limit PAGE_SIZE and the user can not see the whole contents of dai_list/platform_list/codec_list when they are larger than this limit.

This patch uses seq_file instead to make sure dais/platforms/codecs show the full contents of dai_list/platform_list/codec_list.

If it's not critical, I would suggest to wait till v4.16-rc1, where I would like to push [1], and switch to DEFINE_SHOW_ATTRIBUTE() macro.

sound/soc/soc-core.c static void soc_init_codec_debugfs(struct snd_soc_component *component) · line 376

Quoted 11 lines
sound/soc/soc-core.c +7 -0
+static int codec_list_seq_open(struct inode *inode, struct file *file)
+{
+       return single_open(file, codec_list_seq_show, NULL);
 }
 
 static const struct file_operations codec_list_fops = {
+       .open = codec_list_seq_open,
+       .read = seq_read,
+       .llseek = seq_lseek,
+       .release = single_release,
 };

This will be just

DEFINE_SHOW_ATTRIBUTE(codec_list_seq);

sound/soc/soc-core.c static void soc_init_codec_debugfs(struct snd_soc_component *component) · line 404

Quoted 11 lines
sound/soc/soc-core.c +7 -0
+static int dai_list_seq_open(struct inode *inode, struct file *file)
+{
+       return single_open(file, dai_list_seq_show, NULL);
 }
 
 static const struct file_operations dai_list_fops = {
+       .open = dai_list_seq_open,
+       .read = seq_read,
+       .llseek = seq_lseek,
+       .release = single_release,
 };

Ditto.

sound/soc/soc-core.c static void soc_init_codec_debugfs(struct snd_soc_component *component) · line 430

Quoted 11 lines
sound/soc/soc-core.c +7 -0
+static int platform_list_seq_open(struct inode *inode, struct file *file)
+{
+       return single_open(file, platform_list_seq_show, NULL);
 }
 
 static const struct file_operations platform_list_fops = {
+       .open = platform_list_seq_open,
+       .read = seq_read,
+       .llseek = seq_lseek,
+       .release = single_release,
 };

Ditto.

[1]: https://patchwork.kernel.org/patch/10178813/

Signature · 2 lines
With Best Regards,
Andy Shevchenko
maintainer
#2 lore raw
Quoted 2 lines · Andy Shevchenko

If it's not critical, I would suggest to wait till v4.16-rc1, where I would like to push [1], and switch to DEFINE_SHOW_ATTRIBUTE() macro.

Too late, I already applied this - a further conversion for the new macro would be good.

#3 lore raw
Quoted 7 lines · Mark Brown
Quoted 2 lines · Andy Shevchenko

If it's not critical, I would suggest to wait till v4.16-rc1, where I would like to push [1], and switch to DEFINE_SHOW_ATTRIBUTE() macro.

Too late, I already applied this - a further conversion for the new macro would be good.

I can send another patch after the following patch is merged:
https://patchwork.kernel.org/patch/10178813/

maintainer
#4 lore raw
Quoted 7 lines · Donglin Peng
Quoted 2 lines · Mark Brown

Too late, I already applied this - a further conversion for the new macro would be good.

I can send another patch after the following patch is merged:
https://patchwork.kernel.org/patch/10178813/

Yes, please - that'd be great!

#5 lore raw
Quoted 10 lines · Mark Brown
Quoted 7 lines · Donglin Peng
Quoted 2 lines · Mark Brown

Too late, I already applied this - a further conversion for the new macro would be good.

I can send another patch after the following patch is merged:
https://patchwork.kernel.org/patch/10178813/

Yes, please - that'd be great!

I have sent PR to Linus. If everything goes fine, it will be in upstream today evening.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#6 lore raw
In reply to Donglin Peng
Quoted 10 lines · Donglin Peng
Quoted 7 lines · Mark Brown
Quoted 2 lines · Andy Shevchenko

If it's not critical, I would suggest to wait till v4.16-rc1, where I would like to push [1], and switch to DEFINE_SHOW_ATTRIBUTE() macro.

Too late, I already applied this - a further conversion for the new macro would be good.

I can send another patch after the following patch is merged:
https://patchwork.kernel.org/patch/10178813/

It's merged. I think whenever Mark switched his repositories for new cycle you may be able to submit a patch.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
maintainer
#7 lore raw
Quoted 7 lines · Andy Shevchenko
Quoted 2 lines · Donglin Peng

I can send another patch after the following patch is merged:
https://patchwork.kernel.org/patch/10178813/

It's merged. I think whenever Mark switched his repositories for new cycle you may be able to submit a patch.

Send it any time, I'll just not apply it until after -rc1 comes out.

#8 lore raw

Okay, I will send it later.

Quoted 10 lines · Mark Brown
Quoted 7 lines · Andy Shevchenko
Quoted 2 lines · Donglin Peng

I can send another patch after the following patch is merged:
https://patchwork.kernel.org/patch/10178813/

It's merged. I think whenever Mark switched his repositories for new cycle you may be able to submit a patch.

Send it any time, I'll just not apply it until after -rc1 comes out.