[mirror_ubuntu-bionic-kernel.git] / drivers / block / loop.h

/*
 * loop.h
 *
 * Written by Theodore Ts'o, 3/29/93.
 *
 * Copyright 1993 by Theodore Ts'o.  Redistribution of this file is
 * permitted under the GNU General Public License.
 */
#ifndef _LINUX_LOOP_H
#define _LINUX_LOOP_H

#include <linux/bio.h>
#include <linux/blkdev.h>
#include <linux/blk-mq.h>
#include <linux/spinlock.h>
#include <linux/mutex.h>
#include <linux/workqueue.h>
#include <uapi/linux/loop.h>

/* Possible states of device */
enum {
	Lo_unbound,
	Lo_bound,
	Lo_rundown,
};

struct loop_func_table;

struct loop_device {
	int		lo_number;
	int		lo_refcnt;
	loff_t		lo_offset;
	loff_t		lo_sizelimit;
	int		lo_flags;
	int		(*transfer)(struct loop_device *, int cmd,
				    struct page *raw_page, unsigned raw_off,
				    struct page *loop_page, unsigned loop_off,
				    int size, sector_t real_block);
	char		lo_file_name[LO_NAME_SIZE];
	char		lo_crypt_name[LO_NAME_SIZE];
	char		lo_encrypt_key[LO_KEY_SIZE];
	int		lo_encrypt_key_size;
	struct loop_func_table *lo_encryption;
	__u32           lo_init[2];
	kuid_t		lo_key_owner;	/* Who set the key */
	int		(*ioctl)(struct loop_device *, int cmd, 
				 unsigned long arg); 

	struct file *	lo_backing_file;
	struct block_device *lo_device;
	unsigned	lo_blocksize;
	void		*key_data; 

	gfp_t		old_gfp_mask;

	spinlock_t		lo_lock;
	struct workqueue_struct *wq;
	struct list_head	write_cmd_head;
	struct work_struct	write_work;
	bool			write_started;
	int			lo_state;
	struct mutex		lo_ctl_mutex;

	struct request_queue	*lo_queue;
	struct blk_mq_tag_set	tag_set;
	struct gendisk		*lo_disk;
};

struct loop_cmd {
	struct work_struct read_work;
	struct request *rq;
	struct list_head list;
};

/* Support for loadable transfer modules */
struct loop_func_table {
	int number;	/* filter type */ 
	int (*transfer)(struct loop_device *lo, int cmd,
			struct page *raw_page, unsigned raw_off,
			struct page *loop_page, unsigned loop_off,
			int size, sector_t real_block);
	int (*init)(struct loop_device *, const struct loop_info64 *); 
	/* release is called from loop_unregister_transfer or clr_fd */
	int (*release)(struct loop_device *); 
	int (*ioctl)(struct loop_device *, int cmd, unsigned long arg);
	struct module *owner;
}; 

int loop_register_transfer(struct loop_func_table *funcs);
int loop_unregister_transfer(int number); 

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