Commit 5e69ea7e authored by Yufeng Mo's avatar Yufeng Mo Committed by David S. Miller
Browse files

net: hns3: refactor the debugfs process 



Currently, each debugfs command needs to create a file to get
the information. To better support more debugfs commands, the
debugfs process is reconstructed, including the process of
creating dentries and files, and obtaining information.

Signed-off-by: default avatarYufeng Mo <moyufeng@huawei.com>
Signed-off-by: default avatarHuazhong Tan <tanhuazhong@huawei.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 1ddc028a

drivers/net/ethernet/hisilicon/hns3/hnae3.h

+8 −5
Original line number Diff line number Diff line
@@ -250,6 +250,13 @@ enum hnae3_port_base_vlan_state { 
	HNAE3_PORT_BASE_VLAN_NOCHANGE,

};



enum hnae3_dbg_cmd {

	HNAE3_DBG_CMD_TM_NODES,

	HNAE3_DBG_CMD_TM_PRI,

	HNAE3_DBG_CMD_TM_QSET,

	HNAE3_DBG_CMD_UNKNOWN,

};



struct hnae3_vector_info {

	u8 __iomem *io_addr;

	int vector;
@@ -627,7 +634,7 @@ struct hnae3_ae_ops { 
	int (*add_arfs_entry)(struct hnae3_handle *handle, u16 queue_id,

			      u16 flow_id, struct flow_keys *fkeys);

	int (*dbg_run_cmd)(struct hnae3_handle *handle, const char *cmd_buf);

	int (*dbg_read_cmd)(struct hnae3_handle *handle, const char *cmd_buf,

	int (*dbg_read_cmd)(struct hnae3_handle *handle, enum hnae3_dbg_cmd cmd,

			    char *buf, int len);

	pci_ers_result_t (*handle_hw_ras_error)(struct hnae3_ae_dev *ae_dev);

	bool (*get_hw_reset_stat)(struct hnae3_handle *handle);
@@ -790,10 +797,6 @@ struct hnae3_handle { 
#define hnae3_get_bit(origin, shift) \

	hnae3_get_field(origin, 0x1 << (shift), shift)



#define HNAE3_DBG_TM_NODES		"tm_nodes"

#define HNAE3_DBG_TM_PRI		"tm_priority"

#define HNAE3_DBG_TM_QSET		"tm_qset"



int hnae3_register_ae_dev(struct hnae3_ae_dev *ae_dev);

void hnae3_unregister_ae_dev(struct hnae3_ae_dev *ae_dev);

drivers/net/ethernet/hisilicon/hns3/hns3_debugfs.c

+164 −29
Original line number Diff line number Diff line
@@ -5,13 +5,48 @@ 
#include <linux/device.h>



#include "hnae3.h"

#include "hns3_debugfs.h"

#include "hns3_enet.h"



#define HNS3_DBG_READ_LEN 65536

#define HNS3_DBG_WRITE_LEN 1024



static struct dentry *hns3_dbgfs_root;



static struct hns3_dbg_dentry_info hns3_dbg_dentry[] = {

	{

		.name = "tm"

	},

	/* keep common at the bottom and add new directory above */

	{

		.name = "common"

	},

};



static int hns3_dbg_common_file_init(struct hnae3_handle *handle,

				     unsigned int cmd);



static struct hns3_dbg_cmd_info hns3_dbg_cmd[] = {

	{

		.name = "tm_nodes",

		.cmd = HNAE3_DBG_CMD_TM_NODES,

		.dentry = HNS3_DBG_DENTRY_TM,

		.buf_len = HNS3_DBG_READ_LEN,

		.init = hns3_dbg_common_file_init,

	},

	{

		.name = "tm_priority",

		.cmd = HNAE3_DBG_CMD_TM_PRI,

		.dentry = HNS3_DBG_DENTRY_TM,

		.buf_len = HNS3_DBG_READ_LEN,

		.init = hns3_dbg_common_file_init,

	},

	{

		.name = "tm_qset",

		.cmd = HNAE3_DBG_CMD_TM_QSET,

		.dentry = HNS3_DBG_DENTRY_TM,

		.buf_len = HNS3_DBG_READ_LEN,

		.init = hns3_dbg_common_file_init,

	},

};



static int hns3_dbg_queue_info(struct hnae3_handle *h,

			       const char *cmd_buf)

{
@@ -493,37 +528,90 @@ static ssize_t hns3_dbg_cmd_write(struct file *filp, const char __user *buffer, 
	return count;

}



static int hns3_dbg_get_cmd_index(struct hnae3_handle *handle,

				  const unsigned char *name, u32 *index)

{

	u32 i;



	for (i = 0; i < ARRAY_SIZE(hns3_dbg_cmd); i++) {

		if (!strncmp(name, hns3_dbg_cmd[i].name,

			     strlen(hns3_dbg_cmd[i].name))) {

			*index = i;

			return 0;

		}

	}



	dev_err(&handle->pdev->dev, "unknown command(%s)\n", name);

	return -EINVAL;

}



static int hns3_dbg_read_cmd(struct hnae3_handle *handle,

			     enum hnae3_dbg_cmd cmd, char *buf, int len)

{

	const struct hnae3_ae_ops *ops = handle->ae_algo->ops;



	if (!ops->dbg_read_cmd)

		return -EOPNOTSUPP;



	return ops->dbg_read_cmd(handle, cmd, buf, len);

}



static ssize_t hns3_dbg_read(struct file *filp, char __user *buffer,

			     size_t count, loff_t *ppos)

{

	struct hnae3_handle *handle = filp->private_data;

	const struct hnae3_ae_ops *ops = handle->ae_algo->ops;

	struct hns3_nic_priv *priv = handle->priv;

	char *cmd_buf, *read_buf;

	ssize_t size = 0;

	int ret = 0;

	char **save_buf;

	char *read_buf;

	u32 index;

	int ret;



	read_buf = kzalloc(HNS3_DBG_READ_LEN, GFP_KERNEL);

	ret = hns3_dbg_get_cmd_index(handle, filp->f_path.dentry->d_iname,

				     &index);

	if (ret)

		return ret;



	save_buf = &hns3_dbg_cmd[index].buf;



	if (!test_bit(HNS3_NIC_STATE_INITED, &priv->state) ||

	    test_bit(HNS3_NIC_STATE_RESETTING, &priv->state)) {

		ret = -EBUSY;

		goto out;

	}



	if (*save_buf) {

		read_buf = *save_buf;

	} else {

		read_buf = kvzalloc(hns3_dbg_cmd[index].buf_len, GFP_KERNEL);

		if (!read_buf)

			return -ENOMEM;



	cmd_buf = filp->f_path.dentry->d_iname;



	if (ops->dbg_read_cmd)

		ret = ops->dbg_read_cmd(handle, cmd_buf, read_buf,

					HNS3_DBG_READ_LEN);

		/* save the buffer addr until the last read operation */

		*save_buf = read_buf;

	}



	if (ret) {

		dev_info(priv->dev, "unknown command\n");

	/* get data ready for the first time to read */

	if (!*ppos) {

		ret = hns3_dbg_read_cmd(handle, hns3_dbg_cmd[index].cmd,

					read_buf, hns3_dbg_cmd[index].buf_len);

		if (ret)

			goto out;

	}



	size = simple_read_from_buffer(buffer, count, ppos, read_buf,

				       strlen(read_buf));

	if (size > 0)

		return size;



out:

	kfree(read_buf);

	return size;

	/* free the buffer for the last read operation */

	if (*save_buf) {

		kvfree(*save_buf);

		*save_buf = NULL;

	}



	return ret;

}



static const struct file_operations hns3_dbg_cmd_fops = {
@@ -539,29 +627,76 @@ static const struct file_operations hns3_dbg_fops = { 
	.read  = hns3_dbg_read,

};



void hns3_dbg_init(struct hnae3_handle *handle)

static int

hns3_dbg_common_file_init(struct hnae3_handle *handle, u32 cmd)

{

	struct dentry *entry_dir;



	entry_dir = hns3_dbg_dentry[hns3_dbg_cmd[cmd].dentry].dentry;

	debugfs_create_file(hns3_dbg_cmd[cmd].name, 0400, entry_dir,

			    handle, &hns3_dbg_fops);



	return 0;

}



int hns3_dbg_init(struct hnae3_handle *handle)

{

	struct hnae3_ae_dev *ae_dev = pci_get_drvdata(handle->pdev);

	const char *name = pci_name(handle->pdev);

	struct dentry *entry_dir;

	int ret;

	u32 i;



	handle->hnae3_dbgfs = debugfs_create_dir(name, hns3_dbgfs_root);

	hns3_dbg_dentry[HNS3_DBG_DENTRY_COMMON].dentry =

				debugfs_create_dir(name, hns3_dbgfs_root);

	handle->hnae3_dbgfs = hns3_dbg_dentry[HNS3_DBG_DENTRY_COMMON].dentry;



	debugfs_create_file("cmd", 0600, handle->hnae3_dbgfs, handle,

			    &hns3_dbg_cmd_fops);



	entry_dir = debugfs_create_dir("tm", handle->hnae3_dbgfs);

	if (ae_dev->dev_version > HNAE3_DEVICE_VERSION_V2)

		debugfs_create_file(HNAE3_DBG_TM_NODES, 0600, entry_dir, handle,

				    &hns3_dbg_fops);

	debugfs_create_file(HNAE3_DBG_TM_PRI, 0600, entry_dir, handle,

			    &hns3_dbg_fops);

	debugfs_create_file(HNAE3_DBG_TM_QSET, 0600, entry_dir, handle,

			    &hns3_dbg_fops);

	for (i = 0; i < HNS3_DBG_DENTRY_COMMON; i++)

		hns3_dbg_dentry[i].dentry =

			debugfs_create_dir(hns3_dbg_dentry[i].name,

					   handle->hnae3_dbgfs);



	for (i = 0; i < ARRAY_SIZE(hns3_dbg_cmd); i++) {

		if (hns3_dbg_cmd[i].cmd == HNAE3_DBG_CMD_TM_NODES &&

		    ae_dev->dev_version <= HNAE3_DEVICE_VERSION_V2)

			continue;



		if (!hns3_dbg_cmd[i].init) {

			dev_err(&handle->pdev->dev,

				"cmd %s lack of init func\n",

				hns3_dbg_cmd[i].name);

			ret = -EINVAL;

			goto out;

		}



		ret = hns3_dbg_cmd[i].init(handle, i);

		if (ret) {

			dev_err(&handle->pdev->dev, "failed to init cmd %s\n",

				hns3_dbg_cmd[i].name);

			goto out;

		}

	}



	return 0;



out:

	debugfs_remove_recursive(handle->hnae3_dbgfs);

	handle->hnae3_dbgfs = NULL;

	return ret;

}



void hns3_dbg_uninit(struct hnae3_handle *handle)

{

	u32 i;



	for (i = 0; i < ARRAY_SIZE(hns3_dbg_cmd); i++)

		if (hns3_dbg_cmd[i].buf) {

			kvfree(hns3_dbg_cmd[i].buf);

			hns3_dbg_cmd[i].buf = NULL;

		}



	debugfs_remove_recursive(handle->hnae3_dbgfs);

	handle->hnae3_dbgfs = NULL;

}

drivers/net/ethernet/hisilicon/hns3/hns3_debugfs.h

0 → 100644
+29 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0+ */

/* Copyright (c) 2021 Hisilicon Limited. */



#ifndef __HNS3_DEBUGFS_H

#define __HNS3_DEBUGFS_H



#define HNS3_DBG_READ_LEN	65536

#define HNS3_DBG_WRITE_LEN	1024



enum hns3_dbg_dentry_type {

	HNS3_DBG_DENTRY_TM,

	HNS3_DBG_DENTRY_COMMON,

};



struct hns3_dbg_dentry_info {

	const char *name;

	struct dentry *dentry;

};



struct hns3_dbg_cmd_info {

	const char *name;

	enum hnae3_dbg_cmd cmd;

	enum hns3_dbg_dentry_type dentry;

	u32 buf_len;

	char *buf;

	int (*init)(struct hnae3_handle *handle, unsigned int cmd);

};



#endif

drivers/net/ethernet/hisilicon/hns3/hns3_enet.c

+6 −1
Original line number Diff line number Diff line
@@ -4648,7 +4648,12 @@ static int hns3_client_init(struct hnae3_handle *handle) 


	hns3_dcbnl_setup(handle);



	hns3_dbg_init(handle);

	ret = hns3_dbg_init(handle);

	if (ret) {

		dev_err(priv->dev, "failed to init debugfs, ret = %d\n",

			ret);

		goto out_client_start;

	}



	netdev->max_mtu = HNS3_MAX_MTU(ae_dev->dev_specs.max_frm_size);

drivers/net/ethernet/hisilicon/hns3/hns3_enet.h

+1 −1
Original line number Diff line number Diff line
@@ -650,7 +650,7 @@ void hns3_dcbnl_setup(struct hnae3_handle *handle); 
static inline void hns3_dcbnl_setup(struct hnae3_handle *handle) {}

#endif



void hns3_dbg_init(struct hnae3_handle *handle);

int hns3_dbg_init(struct hnae3_handle *handle);

void hns3_dbg_uninit(struct hnae3_handle *handle);

void hns3_dbg_register_debugfs(const char *debugfs_dir_name);

void hns3_dbg_unregister_debugfs(void);