drivers/block/loop.h

   1 /*
   2  * loop.h
   3  *
   4  * Written by Theodore Ts'o, 3/29/93.
   5  *
   6  * Copyright 1993 by Theodore Ts'o.  Redistribution of this file is
   7  * permitted under the GNU General Public License.
   8  */
   9 #ifndef _LINUX_LOOP_H
  10 #define _LINUX_LOOP_H
  11
  12 #include <linux/bio.h>
  13 #include <linux/blkdev.h>
  14 #include <linux/spinlock.h>
  15 #include <linux/mutex.h>
  16 #include <linux/workqueue.h>
  17 #include <uapi/linux/loop.h>
  18
  19 /* Possible states of device */
  20 enum {
  21         Lo_unbound,
  22         Lo_bound,
  23         Lo_rundown,
  24 };
  25
  26 struct loop_func_table;
  27
  28 struct loop_device {
  29         int             lo_number;
  30         int             lo_refcnt;
  31         loff_t          lo_offset;
  32         loff_t          lo_sizelimit;
  33         int             lo_flags;
  34         int             (*transfer)(struct loop_device *, int cmd,
  35                                     struct page *raw_page, unsigned raw_off,
  36                                     struct page *loop_page, unsigned loop_off,
  37                                     int size, sector_t real_block);
  38         char            lo_file_name[LO_NAME_SIZE];
  39         char            lo_crypt_name[LO_NAME_SIZE];
  40         char            lo_encrypt_key[LO_KEY_SIZE];
  41         int             lo_encrypt_key_size;
  42         struct loop_func_table *lo_encryption;
  43         __u32           lo_init[2];
  44         kuid_t          lo_key_owner;   /* Who set the key */
  45         int             (*ioctl)(struct loop_device *, int cmd,
  46                                  unsigned long arg);
  47
  48         struct file *   lo_backing_file;
  49         struct block_device *lo_device;
  50         unsigned        lo_blocksize;
  51         void            *key_data;
  52
  53         gfp_t           old_gfp_mask;
  54
  55         spinlock_t              lo_lock;
  56         struct list_head        write_cmd_head;
  57         struct work_struct      write_work;
  58         bool                    write_started;
  59         int                     lo_state;
  60         struct mutex            lo_ctl_mutex;
  61
  62         struct request_queue    *lo_queue;
  63         struct blk_mq_tag_set   tag_set;
  64         struct gendisk          *lo_disk;
  65 };
  66
  67 struct loop_cmd {
  68         struct work_struct read_work;
  69         struct request *rq;
  70         struct list_head list;
  71 };
  72
  73 /* Support for loadable transfer modules */
  74 struct loop_func_table {
  75         int number;     /* filter type */
  76         int (*transfer)(struct loop_device *lo, int cmd,
  77                         struct page *raw_page, unsigned raw_off,
  78                         struct page *loop_page, unsigned loop_off,
  79                         int size, sector_t real_block);
  80         int (*init)(struct loop_device *, const struct loop_info64 *);
  81         /* release is called from loop_unregister_transfer or clr_fd */
  82         int (*release)(struct loop_device *);
  83         int (*ioctl)(struct loop_device *, int cmd, unsigned long arg);
  84         struct module *owner;
  85 };
  86
  87 int loop_register_transfer(struct loop_func_table *funcs);
  88 int loop_unregister_transfer(int number);
  89
  90 #endif