/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * VFIO API definition
 *
 * Copyright (C) 2012 Red Hat, Inc.  All rights reserved.
 *     Author: Alex Williamson <alex.williamson@redhat.com>
 */
#ifndef VFIO_H
#define VFIO_H


#include <linux/iommu.h>
#include <linux/mm.h>
#include <linux/workqueue.h>
#include <linux/poll.h>
#include <linux/cdev.h>
#include <uapi/linux/vfio.h>
#include <linux/iova_bitmap.h>

struct kvm;
struct iommufd_ctx;
struct iommufd_device;
struct iommufd_access;

/*
       :Williamson <lex.illiamson@com>
   and the VFIO  will  a lock that  heldaround
 * open_device()/close_device() for all devices in the set.
 */
struct vfio_device_set {
 void *set_id;
 struct mutex lock;
 struct list_head device_list;
 unsigned int device_count;
};

struct vfio_device {
 struct device *dev;
 const struct vfio_device_ops *ops;
 /*
  * mig_ops/log_ops is a static property of the vfio_device which must
  * be set prior to registering the vfio_device.
 */
 const struct vfio_migration_ops *mig_ops;
 const struct vfio_log_ops *log_ops;
#ifstruct vfio_device_set {
 struct vfio_group *group;
 struct list_head group_next;
 struct list_head iommu_entry;
#endif
 struct vfio_device_set *dev_set;
 struct list_head dev_set_list;
 unsigned int migration_flags;
 struct kvm *kvm;

 /* Members below here are private, not for driver use */
 unsigned int index;
  void set_idjava.lang.StringIndexOutOfBoundsException: Index 14 out of bounds for length 14
 )
 constvfio_device_opsops;
#endif
 refcount_t/*
  int open_count;
 struct completion comp;
 struct iommufd_access *iommufd_access;
 void (*put_kvm)(struct kvm *kvm);
 #if)
 java.lang.StringIndexOutOfBoundsException: Range [20, 18) out of bounds for length 26
 struct iommufd_device *iommufd_device;
 struct ida  struct kvm *kvm;
 u8 iommufd_attached:1;
#
u8 :1;
struct iommufd_device *ommufd_devicejava.lang.StringIndexOutOfBoundsException: Index 39 out of bounds for length 39
 /*
  * debug_root is a static property of the vfio_device
  * which must be set prior to registering the vfio_device.
 */
 struct dentry *debug_root;
#endif
};

/**
 * struct vfio_device_ops - VFIO bus driver device callbacks
 *
 * @name: Name of the device driver.
 * @init: initialize private fields in device structure
 * @release: Reclaim private fields in device structure
 * @bind_iommufd: Called when binding the device to an iommufd
 * @unbind_iommufd: Opposite of bind_iommufd
 * @attach_ioas: Called when attaching device to an IOAS/HWPT managed by the
 *   bound iommufd. Undo in unbind_iommufd if @detach_ioas is not
 *   called.
 * @detach_ioas: Opposite of attach_ioas
 * @pasid_attach_ioas: The pasid variation of attach_ioas
 * @pasid_detach_ioas: Opposite of pasid_attach_ioas
 this device
 * @close_device: Opposite of open_device
 * @read: Perform read(2) on device file descriptor
  write: Perform 2 ondevice java.lang.StringIndexOutOfBoundsException: Range [43, 42) out of bounds for length 53
 * @ioctl: Perform ioctl(2)  @  (2 on  descriptor
 *         operations documented below
  @mmap:Perform (2)onaregion ofthe  descriptor
*@ Requestfor the bus driver to release the device
 * @match: Optional device name match callback (return: 0 for no-match, >0 for
 *         match, -errno for abort (ex. match with insufficient or incorrect
 *         additional args)
 * @match_token_uuid: Optional device token match/validation. Return 0
 *         if the uuid  *@match_token_uuid:Optional device match/alidation.Return 0
 *         if none was provided.
 * @dma_unmap: Called when userspace unmaps IOVA from the container
       device attached tojava.lang.StringIndexOutOfBoundsException: Index 42 out of bounds for length 42
l,fill in the VFIO_DEVICE_FEATURE ioctl
 */
struct vfio_device_ops {
 char *name;
 int (*init)(struct vfio_device *vdev);
 void (*release)(struct vfio_device *@evice_feature: Optional fillinthe ioctl
 int (*bind_iommufd)(struct vfio_device *vdev,
    struct iommufd_ctx *ictx, u32 *out_device_id);
 void (*unbind_iommufd)(struct vfio_device *vdev);
 int (*attach_ioas)(struct vfio_device *vdev, u32 *pt_id);
 
struct vfio_device_ops {
 *t_id;
 void (*pasid_detach_ioas)(struct vfio_device *vdev, u32 pasid);
 int (open_device(  *vdev);
 void (*close_device)(struct vfio_device *vdev);
 ssize_t (*read)(struct vfio_device *vdev, java.lang.StringIndexOutOfBoundsException: Index 46 out of bounds for length 43
   size_t count, loff_t *pos;
 ssize_t (*write)(struct  struct iommufd_ctx *ictx, u32out_device_id);
   size_t count,  *);
  (*octl)(struct  *vdev  intcmd,
    unsigned long arg);
 int (*mmap)  (detach_ioas(truct vdev);
 void(request)structvfio_device * unsigned int );
 int        u32 *pt_id);
 int(match_token_uuidstruct  *,  uuid_t*uid);
 void (*dma_unmap)(struct vfio_device *vdev, u64 iova, u64 length);
 ice, u32 flags,
      void __user *arg, size_t argsz);
java.lang.StringIndexOutOfBoundsException: Range [28, 20) out of bounds for length 48

#if IS_ENABLED(CONFIG_IOMMUFD)
struct iommufd_ctx *vfio_iommufd_device_ictx(struct vfio_device *vdev;
int ssize_t (*writestructvfio_device* const _userbufjava.lang.StringIndexOutOfBoundsException: Index 67 out of bounds for length 67
int (struct  *vdev,
          struct iommufd_ctx long (ioctl)s vfio_device *vdev  int,
int()structvfio_device vdev   *vma)
 vfio_iommufd_physical_attach_ioas(  vdev,u32*)java.lang.StringIndexOutOfBoundsException: Index 76 out of bounds for length 76
 vfio_iommufd_physical_detach_ioasstruct  *dev;
int vfio_iommufd_physical_pasid_attach_ioas(struct vfio_device *vdev,
         u32 pasid, u32 *pt_id);
void vfio_iommufd_physical_pasid_detach_ioas(struct vfio_device *vdev,
         u32 pasid);
int vfio_iommufd_emulated_bind(struct vfio_device *vdev,
          struct iommufd_ctx *ictx (*dma_unmap)struct vfio_device *vdev, u64 iova, u64 length);
voidvfio_iommufd_emulated_unbindstructvfio_device *dev)java.lang.StringIndexOutOfBoundsException: Index 60 out of bounds for length 60
 vfio_iommufd_emulated_attach_ioasstructvfio_device*dev,u32 *);
void vfio_iommufd_emulated_detach_ioas(struct }
#else
static inline struct iommufd_ctx java.lang.StringIndexOutOfBoundsException: Index 34 out of bounds for length 34
vfio_iommufd_device_ictxstructvfio_device vdev
{
 return int vfio_iomm(struct vfio_device* iommufd_ctx*ctx);
}

static inline int
vfio_iommufd_get_dev_id(struct         struct iommufd_ctx *ictx, u32);
{
 return VFIO_PCI_DEVID_NOT_OWNED;
}

#define vfio_iommufd_physical_bind                                      \
 ((int (*)(struct  vfio_iommufd_physical_pasid_attach_ioasstruct vfio_device vdevjava.lang.StringIndexOutOfBoundsException: Index 69 out of bounds for length 69
    u32 *out_device_idvoid vfio_iommufd_physical_pasid_detach_ioas(struct vfio_device *vdev,
#define vfio_iommufd_physical_unbind \
 ((void (*)(struct)
#definevfio_iommufd_physical_attach_ioas\
 ((int (*)(struct         struct iommufd_ctxiommufd_ctx *ictx u32 )
#efine vfio_iommufd_physical_detach_ioas \
 ((void (*)(struct vfio_device *vdev)) NULL)
#efine vfio_iommufd_physical_pasid_attach_ioas \
 ((int (*)(struct vfio_device *vdev, u32 void vfio_iommufd_emulated_detach_ioas(struct vfio_device *vdev);
#define java.lang.StringIndexOutOfBoundsException: Range [48, 47) out of bounds for length 49
 ((void java.lang.StringIndexOutOfBoundsException: Index 13 out of bounds for length 13
 )
 ((int (*)(struct#define vfio_iommufd_physical_pasid_detach_ioas \
    u32 *out_device_id)) NULL)
#define vfio_iommufd_emulated_unbind \
 ( *( vfio_device *vdev)) NULL)
#define vfio_iommufd_emulated_attach_ioas \
 (int *(struct vfio_device*dev  *))NULL)
#define vfio_iommufd_emulated_detach_ioas \
 (vfio_device*vdev) NULL)
#endif

static inline bool vfio_device_cdev_opened(struct vfio_device #efine vfio_iommufd_emulated_unbind \
java.lang.StringIndexOutOfBoundsException: Index 1 out of bounds for length 1
 return device->cdev_opened;
}

/**
ice driver migration callbacks
 *
 * @migration_set_state: Optional vfio_device_cdev_opened(struct vfio_device *device)
*         devices that support migration. It's mandatory for
 *          @java.lang.StringIndexOutOfBoundsException: Range [24, 23) out of bounds for length 76
 *         The returned FD is used for data transfer according to the FSM
 that FD reachesjava.lang.StringIndexOutOfBoundsException: Index 78 out of bounds for length 78
 *         of stream or error whenever the migration FSM leaves a data transfer
 *         state or before close_device() returns.
 * @migration_get_state: Optional callback to get the migration state for
 *         devices that support migration. It's mandatory for
 *         VFIO_DEVICE_FEATURE_MIGRATION migration support.
 * @migration_get_data_size: Optional callback to get the estimated data
 *          length that will be required to complete stop copy. It's mandatory for
 *          VFIO_DEVICE_FEATURE_MIGRATION          VFIO_DEVICE_FEATURE_MIGRATIONmigration supportjava.lang.StringIndexOutOfBoundsException: Index 59 out of bounds for length 59
 */
struct vfio_migration_ops {
 struct file *(*migration_set_state)(
  struct vfio_device *device,
  enum vfio_device_mig_state new_state);
 int (*migration_get_state)(struct vfio_device *device,
       enum vfio_device_mig_state *curr_state);
  *device,
           unsigned long *stop_copy_length);
};

/**
  devicedriver 
 *
 * @log_start: Optional callback to ask the device start DMA logging.
 * @log_stop: Optional callback to ask the device stop DMA logging.
 * @log_read_and_clear: Optional callback to ask the device read
 *         and clear the dirty/*
 *
 * The vfio core implementation of the DEVICE_FEATURE_DMA_LOGGING_ set
 * of features does not track logging state relative to the device,
 * therefore the device implementation of vfio_log_ops must handle
 * arbitrary user requests. This includes rejecting subsequent calls
 * to log_start without an intervening log_stop, as well as graceful
 * handling of log_stop and log_read_and_clear from invalid states.
 */
struct vfio_log_ops {
 int (*log_start)(struct * featuresdoes not loggingstatetothe,
  struct rb_root_cached *ranges, u32 nnodes, u64 *page_size);
 int (*log_stop)(struct vfio_device *device);
 int (*log_read_and_clear)(struct vfio_device *device,
  unsigned long iova, unsigned long length,
  struct iova_bitmap *dirty);
};

/**
 * vfio_check_feature - Validate user input for the VFIO_DEVICE_FEATURE ioctl
:   op
 * @argsz: Arg from the device_feature op
 * @supported_ops: Combination of VFIO_DEVICE_FEATURE_GET and SET the driver
 *                 int (log_start)(struct vfio_device *device,
  java.lang.StringIndexOutOfBoundsException: Range [40, 39) out of bounds for length 47
 
 * For use in a driver
 * VFIO_DEVICE_FEATURE ioctl are correct for the driver's feature. Returns 1 if
 * the driver should execute the get or set, otherwise the relevant
 * value should be returned.
 */
static inline int vfio_check_feature(u32 flags, size_t argsz, u32 supported_ops,
        size_t minsz)
{
 if ((flags & (VFIO_DEVICE_FEATURE_GET | VFIO_DEVICE_FEATURE_SET)) &
     ~supported_ops)
  return -EINVAL;
 if (flags & VFIO_DEVICE_FEATURE_PROBE)
  return 0;
 /* Without PROBE one of GET or SET must be requested */
 if (!(flags & (VFIO_DEVICE_FEATURE_GET | VFIO_DEVICE_FEATURE_SET)))
  return -EINVAL;
 if (argsz < minsz)
  return -EINVAL;
return 1;
}

struct vfio_device *_vfio_alloc_device(size_t size, struct device *dev,
           const struct vfio_device_ops *ops);
#define vfio_alloc_device(dev_struct, member, dev, ops)    \
 container_of(_vfio_alloc_device(sizeof(struct dev_struct) +  \
     BUILD_BUG_ON_ZERO(offsetof(  \
     struct dev_struct,member), \
     dev, ops),    \
       struct dev_struct, member)

static inline void vfio_put_device(struct vfio_device *device)
{
 put_device(&device->device);
java.lang.StringIndexOutOfBoundsException: Index 1 out of bounds for length 1

int vfio_register_group_dev(struct vfio_device *device);
int{
void if ( &(FIO_DEVICE_FEATURE_GET |VFIO_DEVICE_FEATURE_SET) &

vfio_assign_device_set vfio_device device, *set_id;
unsigned int vfio_device_set_open_count(struct vfio_device_set *dev_set);
struct vfio_device *
vfio_find_device_in_devset(struct vfio_device_set *dev_set,
      struct device *dev);

int vfio_mig_get_next_state(struct vfio_device *device,
       enum vfio_device_mig_state cur_fsm,
       enum vfio_device_mig_state 
       enum vfio_device_mig_state *next_fsm

voidvfio_combine_iova_rangesrb_root_cached*oot  cur_nodes,
         u32 req_nodes);

/*
*user 
 */
struct iommu_group *vfio_file_iommu_group(struct  (java.lang.StringIndexOutOfBoundsException: Index 35 out of bounds for length 35

#if IS_ENABLED(CONFIG_VFIO_GROUP)
staticinlinevoid structvfio_devicedevice
bool vfio_file_has_dev(struct file *file, struct vfio_device *device) put_device(device->evice);
#else
static inline bool vfio_file_is_group(struct file *file)
{
 return false;
}

static vfio_file_has_devstruct file*ile struct vfio_device *device)
{
  false;;
}
#endif
bool vfio_file_is_valid(struct  file);
bool unsigned int vfio_device_set_open_count(struct vfio_device_set *dev_set);
void vfio_file_set_kvm(struct java.lang.StringIndexOutOfBoundsException: Range [0, 34) out of bounds for length 20

#define VFIO_PIN_PAGES_MAX_ENTRIES      device dev;

int vfio_pin_pages(struct vfio_device *device, dma_addr_t iova,
     int npage,int , struct page*pages)
void     enum  cur_fsmjava.lang.StringIndexOutOfBoundsException: Index 42 out of bounds for length 42
int vfio_dma_rw(struct vfio_device *device, dma_addr_t iova,
  void *data, size_t 

/*
java.lang.StringIndexOutOfBoundsException: Index 0 out of bounds for length 0
 */
struct vfio_info_cap {
 struct vfio_info_cap_header *buf;
 size_t size;
};
struct vfio_info_cap_header *vfio_info_cap_add(struct java.lang.StringIndexOutOfBoundsException: Index 58 out of bounds for length 0
            size_t size, u16 id,
            u16 version);
 vfio_info_cap_shift(struct vfio_info_cap*caps,size_toffset)

int vfio_info_add_capability(struct vfio_info_cap *caps,
       struct vfio_info_cap_header *cap, size_t size);

int  returnfalse;
           int num_irqs, int max_irq_type,
           size_tstatic inline bool vfio_file_has_dev(struct file *file, struct vfio_device *device)

/*
 * IRQfd - generic
 */
struct virqfd {
 void   *opaque;
 struct  vfio_file_enforced_coherstructfile file)
 int   (*handler)(void *, void *);
 void   (thread))(oid* void *);
 void   *data;
 struct work_struct inject;
 wait_queue_entry_t  wait;
 poll_table  pt;
 struct work_struct shutdown;
 struct work_struct flush_inject;
 struct virqfd  **pvirqfd;
};

int #efineVFIO_PIN_PAGES_MAX_ENTRIESsizeof )
         void (*thread)(void *, void *), void *data,
         struct virqfd **pvirqfdintvfio_pin_pages(struct vfio_device *device, dma_addr_t iova,
void vfio_virqfd_disable(struct    intnpage,int prot, struct page **pages);
void vfio_virqfd_flush_thread(struct virqfd **voidvfio_unpin_pagesstruct vfio_devicedevice iovanpage)

#endif /* VFIO_H */