diff mbox series

[v5,3/3] scsi: qla2xxx: Use DEFINE_SHOW_STORE_ATTRIBUTE helper for debugfs

Message ID 20230904084804.39564-4-yangxingui@huawei.com (mailing list archive)
State New, archived
Headers show
Series Add helper macro DEFINE_SHOW_STORE_ATTRIBUTE at seq_file.c | expand

Commit Message

yangxingui Sept. 4, 2023, 8:48 a.m. UTC 
Use DEFINE_SHOW_STORE_ATTRIBUTE helper for read-write file to reduce some
duplicated code and delete unused macros.

Signed-off-by: Luo Jiaxing <luojiaxing@huawei.com>
Signed-off-by: Xingui Yang <yangxingui@huawei.com>
---
 drivers/scsi/qla2xxx/qla_dfs.c | 113 +--------------------------------
 1 file changed, 2 insertions(+), 111 deletions(-)

Comments

Andy Shevchenko Sept. 4, 2023, 10:56 a.m. UTC | #1 
On Mon, Sep 04, 2023 at 08:48:04AM +0000, Xingui Yang wrote:
> Use DEFINE_SHOW_STORE_ATTRIBUTE helper for read-write file to reduce some
> duplicated code and delete unused macros.

> Signed-off-by: Luo Jiaxing <luojiaxing@huawei.com>
> Signed-off-by: Xingui Yang <yangxingui@huawei.com>

Same comments as per previous patch.

...

> -/*
> - * Helper macros for setting up debugfs entries.
> - * _name: The name of the debugfs entry
> - * _ctx_struct: The context that was passed when creating the debugfs file
> - *
> - * QLA_DFS_SETUP_RD could be used when there is only a show function.
> - * - show function take the name qla_dfs_<sysfs-name>_show
> - *
> - * QLA_DFS_SETUP_RW could be used when there are both show and write functions.
> - * - show function take the name  qla_dfs_<sysfs-name>_show
> - * - write function take the name qla_dfs_<sysfs-name>_write
> - *
> - * To have a new debugfs entry, do:
> - * 1. Create a "struct dentry *" in the appropriate structure in the format
> - * dfs_<sysfs-name>
> - * 2. Setup debugfs entries using QLA_DFS_SETUP_RD / QLA_DFS_SETUP_RW
> - * 3. Create debugfs file in qla2x00_dfs_setup() using QLA_DFS_CREATE_FILE
> - * or QLA_DFS_ROOT_CREATE_FILE
> - * 4. Remove debugfs file in qla2x00_dfs_remove() using QLA_DFS_REMOVE_FILE
> - * or QLA_DFS_ROOT_REMOVE_FILE
> - *
> - * Example for creating "TEST" sysfs file:
> - * 1. struct qla_hw_data { ... struct dentry *dfs_TEST; }
> - * 2. QLA_DFS_SETUP_RD(TEST, scsi_qla_host_t);
> - * 3. In qla2x00_dfs_setup():
> - * QLA_DFS_CREATE_FILE(ha, TEST, 0600, ha->dfs_dir, vha);
> - * 4. In qla2x00_dfs_remove():
> - * QLA_DFS_REMOVE_FILE(ha, TEST);
> - */

I believe this comment (in some form) has to be preserved.
Try to rewrite it using reference to the new macro.

Otherwise looks good to me.
yangxingui Sept. 4, 2023, 1:05 p.m. UTC | #2 
On 2023/9/4 18:56, Andy Shevchenko wrote:
> On Mon, Sep 04, 2023 at 08:48:04AM +0000, Xingui Yang wrote:
>> Use DEFINE_SHOW_STORE_ATTRIBUTE helper for read-write file to reduce some
>> duplicated code and delete unused macros.
> 
>> Signed-off-by: Luo Jiaxing <luojiaxing@huawei.com>
>> Signed-off-by: Xingui Yang <yangxingui@huawei.com>
> 
> Same comments as per previous patch.
> 
> ...
> 
>> -/*
>> - * Helper macros for setting up debugfs entries.
>> - * _name: The name of the debugfs entry
>> - * _ctx_struct: The context that was passed when creating the debugfs file
>> - *
>> - * QLA_DFS_SETUP_RD could be used when there is only a show function.
>> - * - show function take the name qla_dfs_<sysfs-name>_show
>> - *
>> - * QLA_DFS_SETUP_RW could be used when there are both show and write functions.
>> - * - show function take the name  qla_dfs_<sysfs-name>_show
>> - * - write function take the name qla_dfs_<sysfs-name>_write
>> - *
>> - * To have a new debugfs entry, do:
>> - * 1. Create a "struct dentry *" in the appropriate structure in the format
>> - * dfs_<sysfs-name>
>> - * 2. Setup debugfs entries using QLA_DFS_SETUP_RD / QLA_DFS_SETUP_RW
>> - * 3. Create debugfs file in qla2x00_dfs_setup() using QLA_DFS_CREATE_FILE
>> - * or QLA_DFS_ROOT_CREATE_FILE
>> - * 4. Remove debugfs file in qla2x00_dfs_remove() using QLA_DFS_REMOVE_FILE
>> - * or QLA_DFS_ROOT_REMOVE_FILE
>> - *
>> - * Example for creating "TEST" sysfs file:
>> - * 1. struct qla_hw_data { ... struct dentry *dfs_TEST; }
>> - * 2. QLA_DFS_SETUP_RD(TEST, scsi_qla_host_t);
>> - * 3. In qla2x00_dfs_setup():
>> - * QLA_DFS_CREATE_FILE(ha, TEST, 0600, ha->dfs_dir, vha);
>> - * 4. In qla2x00_dfs_remove():
>> - * QLA_DFS_REMOVE_FILE(ha, TEST);
>> - */
> 
> I believe this comment (in some form) has to be preserved.
> Try to rewrite it using reference to the new macro.
Thanks for your reply, I checked and these macros aren't being called 
anywhere else, so I decided to delete them all. Of course, maybe this 
macro will be used in the future, and I can resubmit another version 
based on your suggestion.

Thanks.
Xingui
> 
> Otherwise looks good to me.
>
Andy Shevchenko Sept. 4, 2023, 1:45 p.m. UTC | #3 
On Mon, Sep 04, 2023 at 09:05:29PM +0800, yangxingui wrote:
> On 2023/9/4 18:56, Andy Shevchenko wrote:
> > On Mon, Sep 04, 2023 at 08:48:04AM +0000, Xingui Yang wrote:

...

> > > -/*
> > > - * Helper macros for setting up debugfs entries.
> > > - * _name: The name of the debugfs entry
> > > - * _ctx_struct: The context that was passed when creating the debugfs file
> > > - *
> > > - * QLA_DFS_SETUP_RD could be used when there is only a show function.
> > > - * - show function take the name qla_dfs_<sysfs-name>_show
> > > - *
> > > - * QLA_DFS_SETUP_RW could be used when there are both show and write functions.
> > > - * - show function take the name  qla_dfs_<sysfs-name>_show
> > > - * - write function take the name qla_dfs_<sysfs-name>_write
> > > - *
> > > - * To have a new debugfs entry, do:
> > > - * 1. Create a "struct dentry *" in the appropriate structure in the format
> > > - * dfs_<sysfs-name>
> > > - * 2. Setup debugfs entries using QLA_DFS_SETUP_RD / QLA_DFS_SETUP_RW
> > > - * 3. Create debugfs file in qla2x00_dfs_setup() using QLA_DFS_CREATE_FILE
> > > - * or QLA_DFS_ROOT_CREATE_FILE
> > > - * 4. Remove debugfs file in qla2x00_dfs_remove() using QLA_DFS_REMOVE_FILE
> > > - * or QLA_DFS_ROOT_REMOVE_FILE
> > > - *
> > > - * Example for creating "TEST" sysfs file:
> > > - * 1. struct qla_hw_data { ... struct dentry *dfs_TEST; }
> > > - * 2. QLA_DFS_SETUP_RD(TEST, scsi_qla_host_t);
> > > - * 3. In qla2x00_dfs_setup():
> > > - * QLA_DFS_CREATE_FILE(ha, TEST, 0600, ha->dfs_dir, vha);
> > > - * 4. In qla2x00_dfs_remove():
> > > - * QLA_DFS_REMOVE_FILE(ha, TEST);
> > > - */
> > 
> > I believe this comment (in some form) has to be preserved.
> > Try to rewrite it using reference to the new macro.
> Thanks for your reply, I checked and these macros aren't being called
> anywhere else, so I decided to delete them all. Of course, maybe this macro
> will be used in the future, and I can resubmit another version based on your
> suggestion.

Of course you need to rewrite it to use new approach.
diff mbox series

Patch

diff --git a/drivers/scsi/qla2xxx/qla_dfs.c b/drivers/scsi/qla2xxx/qla_dfs.c
index f060e593685d..fca01d551876 100644
--- a/drivers/scsi/qla2xxx/qla_dfs.c
+++ b/drivers/scsi/qla2xxx/qla_dfs.c
@@ -505,107 +505,6 @@  qla_dfs_naqp_show(struct seq_file *s, void *unused)
 	return 0;
 }
 
-/*
- * Helper macros for setting up debugfs entries.
- * _name: The name of the debugfs entry
- * _ctx_struct: The context that was passed when creating the debugfs file
- *
- * QLA_DFS_SETUP_RD could be used when there is only a show function.
- * - show function take the name qla_dfs_<sysfs-name>_show
- *
- * QLA_DFS_SETUP_RW could be used when there are both show and write functions.
- * - show function take the name  qla_dfs_<sysfs-name>_show
- * - write function take the name qla_dfs_<sysfs-name>_write
- *
- * To have a new debugfs entry, do:
- * 1. Create a "struct dentry *" in the appropriate structure in the format
- * dfs_<sysfs-name>
- * 2. Setup debugfs entries using QLA_DFS_SETUP_RD / QLA_DFS_SETUP_RW
- * 3. Create debugfs file in qla2x00_dfs_setup() using QLA_DFS_CREATE_FILE
- * or QLA_DFS_ROOT_CREATE_FILE
- * 4. Remove debugfs file in qla2x00_dfs_remove() using QLA_DFS_REMOVE_FILE
- * or QLA_DFS_ROOT_REMOVE_FILE
- *
- * Example for creating "TEST" sysfs file:
- * 1. struct qla_hw_data { ... struct dentry *dfs_TEST; }
- * 2. QLA_DFS_SETUP_RD(TEST, scsi_qla_host_t);
- * 3. In qla2x00_dfs_setup():
- * QLA_DFS_CREATE_FILE(ha, TEST, 0600, ha->dfs_dir, vha);
- * 4. In qla2x00_dfs_remove():
- * QLA_DFS_REMOVE_FILE(ha, TEST);
- */
-#define QLA_DFS_SETUP_RD(_name, _ctx_struct)				\
-static int								\
-qla_dfs_##_name##_open(struct inode *inode, struct file *file)		\
-{									\
-	_ctx_struct *__ctx = inode->i_private;				\
-									\
-	return single_open(file, qla_dfs_##_name##_show, __ctx);	\
-}									\
-									\
-static const struct file_operations qla_dfs_##_name##_ops = {		\
-	.open           = qla_dfs_##_name##_open,			\
-	.read           = seq_read,					\
-	.llseek         = seq_lseek,					\
-	.release        = single_release,				\
-};
-
-#define QLA_DFS_SETUP_RW(_name, _ctx_struct)				\
-static int								\
-qla_dfs_##_name##_open(struct inode *inode, struct file *file)		\
-{									\
-	_ctx_struct *__ctx = inode->i_private;				\
-									\
-	return single_open(file, qla_dfs_##_name##_show, __ctx);	\
-}									\
-									\
-static const struct file_operations qla_dfs_##_name##_ops = {		\
-	.open           = qla_dfs_##_name##_open,			\
-	.read           = seq_read,					\
-	.llseek         = seq_lseek,					\
-	.release        = single_release,				\
-	.write		= qla_dfs_##_name##_write,			\
-};
-
-#define QLA_DFS_ROOT_CREATE_FILE(_name, _perm, _ctx)			\
-	do {								\
-		if (!qla_dfs_##_name)					\
-			qla_dfs_##_name = debugfs_create_file(#_name,	\
-					_perm, qla2x00_dfs_root, _ctx,	\
-					&qla_dfs_##_name##_ops);	\
-	} while (0)
-
-#define QLA_DFS_ROOT_REMOVE_FILE(_name)					\
-	do {								\
-		if (qla_dfs_##_name) {					\
-			debugfs_remove(qla_dfs_##_name);		\
-			qla_dfs_##_name = NULL;				\
-		}							\
-	} while (0)
-
-#define QLA_DFS_CREATE_FILE(_struct, _name, _perm, _parent, _ctx)	\
-	do {								\
-		(_struct)->dfs_##_name = debugfs_create_file(#_name,	\
-					_perm, _parent, _ctx,		\
-					&qla_dfs_##_name##_ops)		\
-	} while (0)
-
-#define QLA_DFS_REMOVE_FILE(_struct, _name)				\
-	do {								\
-		if ((_struct)->dfs_##_name) {				\
-			debugfs_remove((_struct)->dfs_##_name);		\
-			(_struct)->dfs_##_name = NULL;			\
-		}							\
-	} while (0)
-
-static int
-qla_dfs_naqp_open(struct inode *inode, struct file *file)
-{
-	struct scsi_qla_host *vha = inode->i_private;
-
-	return single_open(file, qla_dfs_naqp_show, vha);
-}
-
 static ssize_t
 qla_dfs_naqp_write(struct file *file, const char __user *buffer,
     size_t count, loff_t *pos)
@@ -653,15 +552,7 @@  qla_dfs_naqp_write(struct file *file, const char __user *buffer,
 	kfree(buf);
 	return rc;
 }
-
-static const struct file_operations dfs_naqp_ops = {
-	.open		= qla_dfs_naqp_open,
-	.read		= seq_read,
-	.llseek		= seq_lseek,
-	.release	= single_release,
-	.write		= qla_dfs_naqp_write,
-};
-
+DEFINE_SHOW_STORE_ATTRIBUTE(qla_dfs_naqp);
 
 int
 qla2x00_dfs_setup(scsi_qla_host_t *vha)
@@ -707,7 +598,7 @@  qla2x00_dfs_setup(scsi_qla_host_t *vha)
 
 	if (IS_QLA27XX(ha) || IS_QLA83XX(ha) || IS_QLA28XX(ha)) {
 		ha->tgt.dfs_naqp = debugfs_create_file("naqp",
-		    0400, ha->dfs_dir, vha, &dfs_naqp_ops);
+		    0400, ha->dfs_dir, vha, &qla_dfs_naqp_fops);
 		if (!ha->tgt.dfs_naqp) {
 			ql_log(ql_log_warn, vha, 0xd011,
 			       "Unable to create debugFS naqp node.\n");