Re: [PATCH v3 11/14] intel_gna: add ioctl handler

[Greg Kroah-Hartman]

On Thu, May 13, 2021 at 01:00:37PM +0200, Maciej Kwapulinski wrote:
> From: Tomasz Jankowski <tomasz1.jankowski@xxxxxxxxx>
> 
> Add ioctl handler into GNA driver.
> The ioctl interface provides the ability to do the following:
>  - Map and unmap memory buffers for GNA computation requests.
>  - Retrieve capabilities of the underlying GNA IP.
>  - Submit GNA computation requests.
>  - Request notification of scoring completion.

Do you have a pointer to the userspace code that uses this ioctl?
That's kind of required here, otherwise we have no idea how this all
works.

> 
> Signed-off-by: Tomasz Jankowski <tomasz1.jankowski@xxxxxxxxx>
> Tested-by: Savo Novakovic <savox.novakovic@xxxxxxxxx>
> Co-developed-by: Jianxun Zhang <jianxun.zhang@xxxxxxxxxxxxxxx>
> Signed-off-by: Jianxun Zhang <jianxun.zhang@xxxxxxxxxxxxxxx>
> Co-developed-by: Maciej Kwapulinski <maciej.kwapulinski@xxxxxxxxxxxxxxx>
> Signed-off-by: Maciej Kwapulinski <maciej.kwapulinski@xxxxxxxxxxxxxxx>
> ---
>  drivers/misc/intel/gna/Kbuild   |   2 +-
>  drivers/misc/intel/gna/device.c |  47 ++++++
>  drivers/misc/intel/gna/device.h |   2 +
>  drivers/misc/intel/gna/ioctl.c  | 257 ++++++++++++++++++++++++++++++++
>  drivers/misc/intel/gna/ioctl.h  |  11 ++
>  include/uapi/misc/intel/gna.h   |  53 +++++++
>  6 files changed, 371 insertions(+), 1 deletion(-)
>  create mode 100644 drivers/misc/intel/gna/ioctl.c
>  create mode 100644 drivers/misc/intel/gna/ioctl.h
> 
> diff --git a/drivers/misc/intel/gna/Kbuild b/drivers/misc/intel/gna/Kbuild
> index 38ff97360ed8..745a192a7304 100644
> --- a/drivers/misc/intel/gna/Kbuild
> +++ b/drivers/misc/intel/gna/Kbuild
> @@ -1,5 +1,5 @@
>  # SPDX-License-Identifier: GPL-2.0-only
>  
> -intel_gna-y := device.o hw.o mem.o pci.o request.o score.o
> +intel_gna-y := device.o hw.o ioctl.o mem.o pci.o request.o score.o
>  
>  obj-$(CONFIG_INTEL_GNA) += intel_gna.o
> diff --git a/drivers/misc/intel/gna/device.c b/drivers/misc/intel/gna/device.c
> index 75d8e1675485..0e31b8c6bb70 100644
> --- a/drivers/misc/intel/gna/device.c
> +++ b/drivers/misc/intel/gna/device.c
> @@ -6,8 +6,11 @@
>  #include <linux/interrupt.h>
>  #include <linux/module.h>
>  
> +#include <uapi/misc/intel/gna.h>
> +
>  #include "device.h"
>  #include "hw.h"
> +#include "ioctl.h"
>  #include "request.h"
>  
>  static int recovery_timeout = 60;
> @@ -145,6 +148,50 @@ int gna_probe(struct device *parent, struct gna_dev_info *dev_info, void __iomem
>  	return 0;
>  }
>  
> +static u32 gna_device_type_by_hwid(u32 hwid)
> +{
> +	switch (hwid) {
> +	case GNA_DEV_HWID_CNL:
> +		return GNA_DEV_TYPE_0_9;
> +	case GNA_DEV_HWID_GLK:
> +	case GNA_DEV_HWID_EHL:
> +	case GNA_DEV_HWID_ICL:
> +		return GNA_DEV_TYPE_1_0;
> +	case GNA_DEV_HWID_JSL:
> +	case GNA_DEV_HWID_TGL:
> +	case GNA_DEV_HWID_RKL:
> +		return GNA_DEV_TYPE_2_0;
> +	case GNA_DEV_HWID_ADL:
> +	case GNA_DEV_HWID_RPL:
> +		return GNA_DEV_TYPE_3_0;
> +	default:
> +		return 0;
> +	}
> +}
> +
> +int gna_getparam(struct gna_private *gna_priv, union gna_parameter *param)
> +{
> +	switch (param->in.id) {
> +	case GNA_PARAM_DEVICE_ID:
> +		param->out.value = gna_priv->info.hwid;
> +		break;

Why do you need an ioctl to get the device id?  What's wrong with sysfs?

> +	case GNA_PARAM_RECOVERY_TIMEOUT:
> +		param->out.value = jiffies_to_msecs(gna_priv->recovery_timeout_jiffies) / 1000;
> +		break;
> +	case GNA_PARAM_INPUT_BUFFER_S:
> +		param->out.value = gna_priv->hw_info.in_buf_s;
> +		break;
> +	case GNA_PARAM_DEVICE_TYPE:
> +		param->out.value = gna_device_type_by_hwid(gna_priv->info.hwid);

Same here, why isn't this a sysfs file?

> +		break;
> +	default:
> +		dev_err(gna_dev(gna_priv), "unknown parameter id %llu\n", param->in.id);

Userspace can cause syslog DoS?  Not nice :(

Please just eat the error and move on.

> +		return -EINVAL;

Wrong error value for invalid ioctl value.


> +	}
> +
> +	return 0;
> +}
> +
>  MODULE_AUTHOR("Intel Corporation");
>  MODULE_DESCRIPTION("Intel(R) Gaussian & Neural Accelerator (Intel(R) GNA) Driver");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/misc/intel/gna/device.h b/drivers/misc/intel/gna/device.h
> index d3c86d649b5c..75784882f57c 100644
> --- a/drivers/misc/intel/gna/device.h
> +++ b/drivers/misc/intel/gna/device.h
> @@ -17,6 +17,7 @@
>  #define GNA_DV_NAME	"intel_gna"
>  
>  struct workqueue_struct;
> +union gna_parameter;
>  struct device;
>  struct file;
>  
> @@ -71,6 +72,7 @@ struct gna_private {
>  };
>  
>  int gna_probe(struct device *parent, struct gna_dev_info *dev_info, void __iomem *iobase, int irq);
> +int gna_getparam(struct gna_private *gna_priv, union gna_parameter *param);
>  
>  static inline u32 gna_reg_read(struct gna_private *gna_priv, u32 reg)
>  {
> diff --git a/drivers/misc/intel/gna/ioctl.c b/drivers/misc/intel/gna/ioctl.c
> new file mode 100644
> index 000000000000..4a90135b3cc6
> --- /dev/null
> +++ b/drivers/misc/intel/gna/ioctl.c
> @@ -0,0 +1,257 @@
> +// SPDX-License-Identifier: GPL-2.0-only
> +// Copyright(c) 2017-2021 Intel Corporation
> +
> +#include <linux/device.h>
> +#include <linux/fs.h>
> +#include <linux/idr.h>
> +#include <linux/jiffies.h>
> +#include <linux/kref.h>
> +#include <linux/list.h>
> +#include <linux/mutex.h>
> +#include <linux/uaccess.h>
> +#include <linux/wait.h>
> +#include <linux/workqueue.h>
> +
> +#include <uapi/misc/intel/gna.h>
> +
> +#include "device.h"
> +#include "ioctl.h"
> +#include "mem.h"
> +#include "request.h"
> +#include "score.h"
> +
> +static int gna_ioctl_score(struct gna_file_private *file_priv, void __user *argptr)
> +{
> +	union gna_compute score_args;
> +	struct gna_private *gna_priv;
> +	u64 request_id;
> +	int ret;
> +
> +	gna_priv = file_priv->gna_priv;
> +
> +	if (copy_from_user(&score_args, argptr, sizeof(score_args))) {
> +		dev_err(gna_dev(gna_priv), "could not copy score ioctl config from user\n");

No need for errors that userspace can cause, please drop, you already
got a message if there needed to be one.

> +		return -EFAULT;
> +	}
> +
> +	ret = gna_validate_score_config(&score_args.in.config, file_priv);

This function is in a different patch?  Now I have to dig through that
to try to figure out if you really are validating the data properly?
That's just mean to reviewers, would you want to review code like this?
Please fix.

> +	if (ret) {
> +		dev_err(gna_dev(gna_priv), "request not valid\n");

Same here, clean up all error reporting in your ioctl to be none at all
please.

> +		return ret;
> +	}
> +
> +	ret = gna_enqueue_request(&score_args.in.config, file_priv, &request_id);

Same here, where is this function to review?

Same for all your other ioctl handlers, please fix up, this is rough to
review...

greg k-h