Re: [PATCH v4 09/12] vfio: split vfio_pci_private.h into two files

[Alex Williamson]

On Tue,  7 Jan 2020 20:01:46 +0800
Liu Yi L <yi.l.liu@xxxxxxxxx> wrote:

> This patch splits the vfio_pci_private.h to be a private file
> in drivers/vfio/pci and a common file under include/linux/. It
> is a preparation for supporting vfio_pci common code sharing
> outside drivers/vfio/pci/.
> 
> The common header file is shrunk from the previous copied
> vfio_pci_common.h. The original vfio_pci_private.h is shrunk
> accordingly as well.
> 
> Cc: Kevin Tian <kevin.tian@xxxxxxxxx>
> Cc: Lu Baolu <baolu.lu@xxxxxxxxxxxxxxx>
> Signed-off-by: Liu Yi L <yi.l.liu@xxxxxxxxx>
> ---
>  drivers/vfio/pci/vfio_pci_private.h | 133 +-----------------------------------
>  include/linux/vfio_pci_common.h     |  86 ++---------------------
>  2 files changed, 7 insertions(+), 212 deletions(-)
> 
> diff --git a/drivers/vfio/pci/vfio_pci_private.h b/drivers/vfio/pci/vfio_pci_private.h
> index 499dd04..c4976a9 100644
> --- a/drivers/vfio/pci/vfio_pci_private.h
> +++ b/drivers/vfio/pci/vfio_pci_private.h
> @@ -12,6 +12,7 @@
>  #include <linux/pci.h>
>  #include <linux/irqbypass.h>
>  #include <linux/types.h>
> +#include <linux/vfio_pci_common.h>
>  
>  #ifndef VFIO_PCI_PRIVATE_H
>  #define VFIO_PCI_PRIVATE_H
> @@ -39,121 +40,12 @@ struct vfio_pci_ioeventfd {
>  	int			count;
>  };
>  
> -struct vfio_pci_irq_ctx {
> -	struct eventfd_ctx	*trigger;
> -	struct virqfd		*unmask;
> -	struct virqfd		*mask;
> -	char			*name;
> -	bool			masked;
> -	struct irq_bypass_producer	producer;
> -};

I think this can stay here, vfio_pci_common.h just needs a forward
declaration.

> -
> -struct vfio_pci_device;
> -struct vfio_pci_region;
> -
> -struct vfio_pci_regops {
> -	size_t	(*rw)(struct vfio_pci_device *vdev, char __user *buf,
> -		      size_t count, loff_t *ppos, bool iswrite);
> -	void	(*release)(struct vfio_pci_device *vdev,
> -			   struct vfio_pci_region *region);
> -	int	(*mmap)(struct vfio_pci_device *vdev,
> -			struct vfio_pci_region *region,
> -			struct vm_area_struct *vma);
> -	int	(*add_capability)(struct vfio_pci_device *vdev,
> -				  struct vfio_pci_region *region,
> -				  struct vfio_info_cap *caps);
> -};
> -
> -struct vfio_pci_region {
> -	u32				type;
> -	u32				subtype;
> -	const struct vfio_pci_regops	*ops;
> -	void				*data;
> -	size_t				size;
> -	u32				flags;
> -};
> -
>  struct vfio_pci_dummy_resource {
>  	struct resource		resource;
>  	int			index;
>  	struct list_head	res_next;
>  };
>  
> -struct vfio_pci_reflck {
> -	struct kref		kref;
> -	struct mutex		lock;
> -};

I think we can abstract this a little further to make it unnecessary to
put this in common as well.  See attached.

> -
> -struct vfio_pci_device {
> -	struct pci_dev		*pdev;
> -	void __iomem		*barmap[PCI_STD_NUM_BARS];
> -	bool			bar_mmap_supported[PCI_STD_NUM_BARS];
> -	u8			*pci_config_map;
> -	u8			*vconfig;
> -	struct perm_bits	*msi_perm;
> -	spinlock_t		irqlock;
> -	struct mutex		igate;
> -	struct vfio_pci_irq_ctx	*ctx;
> -	int			num_ctx;
> -	int			irq_type;
> -	int			num_regions;
> -	struct vfio_pci_region	*region;
> -	u8			msi_qmax;
> -	u8			msix_bar;
> -	u16			msix_size;
> -	u32			msix_offset;
> -	u32			rbar[7];
> -	bool			pci_2_3;
> -	bool			virq_disabled;
> -	bool			reset_works;
> -	bool			extended_caps;
> -	bool			bardirty;
> -	bool			has_vga;
> -	bool			needs_reset;
> -	bool			nointx;
> -	bool			needs_pm_restore;
> -	struct pci_saved_state	*pci_saved_state;
> -	struct pci_saved_state	*pm_save;
> -	struct vfio_pci_reflck	*reflck;
> -	int			refcnt;
> -	int			ioeventfds_nr;
> -	struct eventfd_ctx	*err_trigger;
> -	struct eventfd_ctx	*req_trigger;
> -	struct list_head	dummy_resources_list;
> -	struct mutex		ioeventfds_lock;
> -	struct list_head	ioeventfds_list;
> -	bool			nointxmask;
> -#ifdef CONFIG_VFIO_PCI_VGA
> -	bool			disable_vga;
> -#endif
> -	bool			disable_idle_d3;
> -};
> -
> -#define is_intx(vdev) (vdev->irq_type == VFIO_PCI_INTX_IRQ_INDEX)
> -#define is_msi(vdev) (vdev->irq_type == VFIO_PCI_MSI_IRQ_INDEX)
> -#define is_msix(vdev) (vdev->irq_type == VFIO_PCI_MSIX_IRQ_INDEX)
> -#define is_irq_none(vdev) (!(is_intx(vdev) || is_msi(vdev) || is_msix(vdev)))
> -#define irq_is(vdev, type) (vdev->irq_type == type)

I think these can stay in the private header too.

> -
> -extern const struct pci_error_handlers vfio_err_handlers;
> -
> -static inline bool vfio_pci_is_vga(struct pci_dev *pdev)
> -{
> -	return (pdev->class >> 8) == PCI_CLASS_DISPLAY_VGA;
> -}
> -
> -static inline bool vfio_vga_disabled(struct vfio_pci_device *vdev)
> -{
> -#ifdef CONFIG_VFIO_PCI_VGA
> -	return vdev->disable_vga;
> -#else
> -	return true;
> -#endif
> -}

vfio_vga_disabled() is only used in vfio_pci_common.c, I think it can
remain in private.

> -
> -extern void vfio_pci_refresh_config(struct vfio_pci_device *vdev,
> -				bool nointxmask, bool disable_idle_d3);
> -
>  extern void vfio_pci_intx_mask(struct vfio_pci_device *vdev);
>  extern void vfio_pci_intx_unmask(struct vfio_pci_device *vdev);
>  
> @@ -180,29 +72,6 @@ extern void vfio_pci_uninit_perm_bits(void);
>  extern int vfio_config_init(struct vfio_pci_device *vdev);
>  extern void vfio_config_free(struct vfio_pci_device *vdev);
>  
> -extern int vfio_pci_register_dev_region(struct vfio_pci_device *vdev,
> -					unsigned int type, unsigned int subtype,
> -					const struct vfio_pci_regops *ops,
> -					size_t size, u32 flags, void *data);
> -
> -extern int vfio_pci_set_power_state(struct vfio_pci_device *vdev,
> -				    pci_power_t state);
> -extern unsigned int vfio_pci_set_vga_decode(void *opaque, bool single_vga);
> -extern int vfio_pci_enable(struct vfio_pci_device *vdev);
> -extern void vfio_pci_disable(struct vfio_pci_device *vdev);
> -extern long vfio_pci_ioctl(void *device_data,
> -			unsigned int cmd, unsigned long arg);
> -extern ssize_t vfio_pci_read(void *device_data, char __user *buf,
> -			size_t count, loff_t *ppos);
> -extern ssize_t vfio_pci_write(void *device_data, const char __user *buf,
> -			size_t count, loff_t *ppos);
> -extern int vfio_pci_mmap(void *device_data, struct vm_area_struct *vma);
> -extern void vfio_pci_request(void *device_data, unsigned int count);
> -extern void vfio_pci_fill_ids(char *ids, struct pci_driver *driver);
> -extern int vfio_pci_reflck_attach(struct vfio_pci_device *vdev);
> -extern void vfio_pci_reflck_put(struct vfio_pci_reflck *reflck);
> -extern void vfio_pci_probe_power_state(struct vfio_pci_device *vdev);
> -
>  #ifdef CONFIG_VFIO_PCI_IGD
>  extern int vfio_pci_igd_init(struct vfio_pci_device *vdev);
>  #else
> diff --git a/include/linux/vfio_pci_common.h b/include/linux/vfio_pci_common.h
> index 499dd04..862cd80 100644
> --- a/include/linux/vfio_pci_common.h
> +++ b/include/linux/vfio_pci_common.h
> @@ -1,5 +1,8 @@
>  /* SPDX-License-Identifier: GPL-2.0-only */
>  /*
> + * VFIO PCI API definition
> + *
> + * Derived from original vfio/pci/vfio_pci_private.h:
>   * Copyright (C) 2012 Red Hat, Inc.  All rights reserved.
>   *     Author: Alex Williamson <alex.williamson@xxxxxxxxxx>
>   *
> @@ -13,31 +16,8 @@
>  #include <linux/irqbypass.h>
>  #include <linux/types.h>
>  
> -#ifndef VFIO_PCI_PRIVATE_H
> -#define VFIO_PCI_PRIVATE_H
> -
> -#define VFIO_PCI_OFFSET_SHIFT   40
> -
> -#define VFIO_PCI_OFFSET_TO_INDEX(off)	(off >> VFIO_PCI_OFFSET_SHIFT)
> -#define VFIO_PCI_INDEX_TO_OFFSET(index)	((u64)(index) << VFIO_PCI_OFFSET_SHIFT)
> -#define VFIO_PCI_OFFSET_MASK	(((u64)(1) << VFIO_PCI_OFFSET_SHIFT) - 1)
> -
> -/* Special capability IDs predefined access */
> -#define PCI_CAP_ID_INVALID		0xFF	/* default raw access */
> -#define PCI_CAP_ID_INVALID_VIRT		0xFE	/* default virt access */
> -
> -/* Cap maximum number of ioeventfds per device (arbitrary) */
> -#define VFIO_PCI_IOEVENTFD_MAX		1000
> -
> -struct vfio_pci_ioeventfd {
> -	struct list_head	next;
> -	struct virqfd		*virqfd;
> -	void __iomem		*addr;
> -	uint64_t		data;
> -	loff_t			pos;
> -	int			bar;
> -	int			count;
> -};
> +#ifndef VFIO_PCI_COMMON_H
> +#define VFIO_PCI_COMMON_H
>  
>  struct vfio_pci_irq_ctx {
>  	struct eventfd_ctx	*trigger;
> @@ -73,12 +53,6 @@ struct vfio_pci_region {
>  	u32				flags;
>  };
>  
> -struct vfio_pci_dummy_resource {
> -	struct resource		resource;
> -	int			index;
> -	struct list_head	res_next;
> -};
> -
>  struct vfio_pci_reflck {
>  	struct kref		kref;
>  	struct mutex		lock;
> @@ -154,32 +128,6 @@ static inline bool vfio_vga_disabled(struct vfio_pci_device *vdev)
>  extern void vfio_pci_refresh_config(struct vfio_pci_device *vdev,
>  				bool nointxmask, bool disable_idle_d3);
>  
> -extern void vfio_pci_intx_mask(struct vfio_pci_device *vdev);
> -extern void vfio_pci_intx_unmask(struct vfio_pci_device *vdev);
> -
> -extern int vfio_pci_set_irqs_ioctl(struct vfio_pci_device *vdev,
> -				   uint32_t flags, unsigned index,
> -				   unsigned start, unsigned count, void *data);
> -
> -extern ssize_t vfio_pci_config_rw(struct vfio_pci_device *vdev,
> -				  char __user *buf, size_t count,
> -				  loff_t *ppos, bool iswrite);
> -
> -extern ssize_t vfio_pci_bar_rw(struct vfio_pci_device *vdev, char __user *buf,
> -			       size_t count, loff_t *ppos, bool iswrite);
> -
> -extern ssize_t vfio_pci_vga_rw(struct vfio_pci_device *vdev, char __user *buf,
> -			       size_t count, loff_t *ppos, bool iswrite);
> -
> -extern long vfio_pci_ioeventfd(struct vfio_pci_device *vdev, loff_t offset,
> -			       uint64_t data, int count, int fd);
> -
> -extern int vfio_pci_init_perm_bits(void);
> -extern void vfio_pci_uninit_perm_bits(void);
> -
> -extern int vfio_config_init(struct vfio_pci_device *vdev);
> -extern void vfio_config_free(struct vfio_pci_device *vdev);
> -
>  extern int vfio_pci_register_dev_region(struct vfio_pci_device *vdev,
>  					unsigned int type, unsigned int subtype,
>  					const struct vfio_pci_regops *ops,
> @@ -203,26 +151,4 @@ extern int vfio_pci_reflck_attach(struct vfio_pci_device *vdev);
>  extern void vfio_pci_reflck_put(struct vfio_pci_reflck *reflck);
>  extern void vfio_pci_probe_power_state(struct vfio_pci_device *vdev);
>  
> -#ifdef CONFIG_VFIO_PCI_IGD
> -extern int vfio_pci_igd_init(struct vfio_pci_device *vdev);
> -#else
> -static inline int vfio_pci_igd_init(struct vfio_pci_device *vdev)
> -{
> -	return -ENODEV;
> -}
> -#endif
> -#ifdef CONFIG_VFIO_PCI_NVLINK2
> -extern int vfio_pci_nvdia_v100_nvlink2_init(struct vfio_pci_device *vdev);
> -extern int vfio_pci_ibm_npu2_init(struct vfio_pci_device *vdev);
> -#else
> -static inline int vfio_pci_nvdia_v100_nvlink2_init(struct vfio_pci_device *vdev)
> -{
> -	return -ENODEV;
> -}
> -
> -static inline int vfio_pci_ibm_npu2_init(struct vfio_pci_device *vdev)
> -{
> -	return -ENODEV;
> -}
> -#endif
> -#endif /* VFIO_PCI_PRIVATE_H */
> +#endif /* VFIO_PCI_COMMON_H */

Attachment: return-to-private
Description: Binary data

Attachment: abstract-reflck
Description: Binary data