[deliverable/linux.git] / include / linux / ceph / osd_client.h

#ifndef _FS_CEPH_OSD_CLIENT_H
#define _FS_CEPH_OSD_CLIENT_H

#include <linux/completion.h>
#include <linux/kref.h>
#include <linux/mempool.h>
#include <linux/rbtree.h>

#include <linux/ceph/types.h>
#include <linux/ceph/osdmap.h>
#include <linux/ceph/messenger.h>
#include <linux/ceph/auth.h>
#include <linux/ceph/pagelist.h>

/* 
 * Maximum object name size 
 * (must be at least as big as RBD_MAX_MD_NAME_LEN -- currently 100) 
 */
#define MAX_OBJ_NAME_SIZE 100

struct ceph_msg;
struct ceph_snap_context;
struct ceph_osd_request;
struct ceph_osd_client;
struct ceph_authorizer;

/*
 * completion callback for async writepages
 */
typedef void (*ceph_osdc_callback_t)(struct ceph_osd_request *,
				     struct ceph_msg *);

/* a given osd we're communicating with */
struct ceph_osd {
	atomic_t o_ref;
	struct ceph_osd_client *o_osdc;
	int o_osd;
	int o_incarnation;
	struct rb_node o_node;
	struct ceph_connection o_con;
	struct list_head o_requests;
	struct list_head o_linger_requests;
	struct list_head o_osd_lru;
	struct ceph_auth_handshake o_auth;
	unsigned long lru_ttl;
	int o_marked_for_keepalive;
	struct list_head o_keepalive_item;
};


#define CEPH_OSD_MAX_OP 10

enum ceph_osd_data_type {
	CEPH_OSD_DATA_TYPE_NONE,
	CEPH_OSD_DATA_TYPE_PAGES,
	CEPH_OSD_DATA_TYPE_PAGELIST,
#ifdef CONFIG_BLOCK
	CEPH_OSD_DATA_TYPE_BIO,
#endif /* CONFIG_BLOCK */
};

struct ceph_osd_data {
	enum ceph_osd_data_type	type;
	union {
		struct {
			struct page	**pages;
			u64		length;
			u32		alignment;
			bool		pages_from_pool;
			bool		own_pages;
		};
		struct ceph_pagelist	*pagelist;
#ifdef CONFIG_BLOCK
		struct bio       	*bio;
#endif /* CONFIG_BLOCK */
	};
};

/* an in-flight request */
struct ceph_osd_request {
	u64             r_tid;              /* unique for this client */
	struct rb_node  r_node;
	struct list_head r_req_lru_item;
	struct list_head r_osd_item;
	struct list_head r_linger_item;
	struct list_head r_linger_osd;
	struct ceph_osd *r_osd;
	struct ceph_pg   r_pgid;
	int              r_pg_osds[CEPH_PG_MAX_SIZE];
	int              r_num_pg_osds;

	struct ceph_msg  *r_request, *r_reply;
	int               r_flags;     /* any additional flags for the osd */
	u32               r_sent;      /* >0 if r_request is sending/sent */
	int               r_num_ops;

	/* encoded message content */
	struct ceph_osd_op *r_request_ops;
	/* these are updated on each send */
	__le32           *r_request_osdmap_epoch;
	__le32           *r_request_flags;
	__le64           *r_request_pool;
	void             *r_request_pgid;
	__le32           *r_request_attempts;
	struct ceph_eversion *r_request_reassert_version;

	int               r_result;
	int               r_reply_op_len[CEPH_OSD_MAX_OP];
	s32               r_reply_op_result[CEPH_OSD_MAX_OP];
	int               r_got_reply;
	int		  r_linger;
	int		  r_completed;

	struct ceph_osd_client *r_osdc;
	struct kref       r_kref;
	bool              r_mempool;
	struct completion r_completion, r_safe_completion;
	ceph_osdc_callback_t r_callback, r_safe_callback;
	struct ceph_eversion r_reassert_version;
	struct list_head  r_unsafe_item;

	struct inode *r_inode;         	      /* for use by callbacks */
	void *r_priv;			      /* ditto */

	char              r_oid[MAX_OBJ_NAME_SIZE];          /* object name */
	int               r_oid_len;
	u64               r_snapid;
	unsigned long     r_stamp;            /* send OR check time */

	struct ceph_file_layout r_file_layout;
	struct ceph_snap_context *r_snapc;    /* snap context for writes */

	struct ceph_osd_data r_data_in;
	struct ceph_osd_data r_data_out;
};

struct ceph_osd_event {
	u64 cookie;
	int one_shot;
	struct ceph_osd_client *osdc;
	void (*cb)(u64, u64, u8, void *);
	void *data;
	struct rb_node node;
	struct list_head osd_node;
	struct kref kref;
};

struct ceph_osd_event_work {
	struct work_struct work;
	struct ceph_osd_event *event;
        u64 ver;
        u64 notify_id;
        u8 opcode;
};

struct ceph_osd_client {
	struct ceph_client     *client;

	struct ceph_osdmap     *osdmap;       /* current map */
	struct rw_semaphore    map_sem;
	struct completion      map_waiters;
	u64                    last_requested_map;

	struct mutex           request_mutex;
	struct rb_root         osds;          /* osds */
	struct list_head       osd_lru;       /* idle osds */
	u64                    timeout_tid;   /* tid of timeout triggering rq */
	u64                    last_tid;      /* tid of last request */
	struct rb_root         requests;      /* pending requests */
	struct list_head       req_lru;	      /* in-flight lru */
	struct list_head       req_unsent;    /* unsent/need-resend queue */
	struct list_head       req_notarget;  /* map to no osd */
	struct list_head       req_linger;    /* lingering requests */
	int                    num_requests;
	struct delayed_work    timeout_work;
	struct delayed_work    osds_timeout_work;
#ifdef CONFIG_DEBUG_FS
	struct dentry 	       *debugfs_file;
#endif

	mempool_t              *req_mempool;

	struct ceph_msgpool	msgpool_op;
	struct ceph_msgpool	msgpool_op_reply;

	spinlock_t		event_lock;
	struct rb_root		event_tree;
	u64			event_count;

	struct workqueue_struct	*notify_wq;
};

struct ceph_osd_req_op {
	u16 op;           /* CEPH_OSD_OP_* */
	u32 payload_len;
	union {
		struct {
			u64 offset, length;
			u64 truncate_size;
			u32 truncate_seq;
		} extent;
		struct {
			const char *class_name;
			const char *method_name;
			const void *indata;
			u32 indata_len;
			__u8 class_len;
			__u8 method_len;
			__u8 argc;
		} cls;
		struct {
			u64 cookie;
			u64 ver;
			u32 prot_ver;
			u32 timeout;
			__u8 flag;
		} watch;
	};
};

extern int ceph_osdc_init(struct ceph_osd_client *osdc,
			  struct ceph_client *client);
extern void ceph_osdc_stop(struct ceph_osd_client *osdc);

extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
				   struct ceph_msg *msg);
extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
				 struct ceph_msg *msg);

extern void osd_req_op_init(struct ceph_osd_req_op *op, u16 opcode);
extern void osd_req_op_extent_init(struct ceph_osd_req_op *op, u16 opcode,
					u64 offset, u64 length,
					u64 truncate_size, u32 truncate_seq);
extern void osd_req_op_cls_init(struct ceph_osd_req_op *op, u16 opcode,
					const char *class, const char *method,
					const void *request_data,
					size_t request_data_size);
extern void osd_req_op_watch_init(struct ceph_osd_req_op *op, u16 opcode,
					u64 cookie, u64 version, int flag);

extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
					       struct ceph_snap_context *snapc,
					       unsigned int num_op,
					       bool use_mempool,
					       gfp_t gfp_flags);

extern void ceph_osdc_build_request(struct ceph_osd_request *req, u64 off,
				    unsigned int num_op,
				    struct ceph_osd_req_op *src_ops,
				    struct ceph_snap_context *snapc,
				    u64 snap_id,
				    struct timespec *mtime);

extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
				      struct ceph_file_layout *layout,
				      struct ceph_vino vino,
				      u64 offset, u64 *len, int op, int flags,
				      struct ceph_snap_context *snapc,
				      int do_sync, u32 truncate_seq,
				      u64 truncate_size,
				      struct timespec *mtime,
				      bool use_mempool);

extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
					 struct ceph_osd_request *req);
extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
						struct ceph_osd_request *req);

static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
{
	kref_get(&req->r_kref);
}
extern void ceph_osdc_release_request(struct kref *kref);
static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
{
	kref_put(&req->r_kref, ceph_osdc_release_request);
}

extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
				   struct ceph_osd_request *req,
				   bool nofail);
extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
				  struct ceph_osd_request *req);
extern void ceph_osdc_sync(struct ceph_osd_client *osdc);

extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
			       struct ceph_vino vino,
			       struct ceph_file_layout *layout,
			       u64 off, u64 *plen,
			       u32 truncate_seq, u64 truncate_size,
			       struct page **pages, int nr_pages,
			       int page_align);

extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
				struct ceph_vino vino,
				struct ceph_file_layout *layout,
				struct ceph_snap_context *sc,
				u64 off, u64 len,
				u32 truncate_seq, u64 truncate_size,
				struct timespec *mtime,
				struct page **pages, int nr_pages);

/* watch/notify events */
extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
				  void (*event_cb)(u64, u64, u8, void *),
				  void *data, struct ceph_osd_event **pevent);
extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
extern void ceph_osdc_put_event(struct ceph_osd_event *event);
#endif
Commit	Line	Data
f24e9980 SW	1	#ifndef _FS_CEPH_OSD_CLIENT_H
	2	#define _FS_CEPH_OSD_CLIENT_H
	3
	4	#include <linux/completion.h>
415e49a9	5	#include <linux/kref.h>
f24e9980 SW	6	#include <linux/mempool.h>
	7	#include <linux/rbtree.h>
	8
6c4a1915 AE	9	#include <linux/ceph/types.h>
	10	#include <linux/ceph/osdmap.h>
	11	#include <linux/ceph/messenger.h>
	12	#include <linux/ceph/auth.h>
c885837f	13	#include <linux/ceph/pagelist.h>
f24e9980	14
224736d9 SP	15	/*
	16	* Maximum object name size
	17	* (must be at least as big as RBD_MAX_MD_NAME_LEN -- currently 100)
	18	*/
	19	#define MAX_OBJ_NAME_SIZE 100
	20
f24e9980 SW	21	struct ceph_msg;
	22	struct ceph_snap_context;
	23	struct ceph_osd_request;
	24	struct ceph_osd_client;
4e7a5dcd	25	struct ceph_authorizer;
f24e9980 SW	26
	27	/*
	28	* completion callback for async writepages
	29	*/
	30	typedef void (ceph_osdc_callback_t)(struct ceph_osd_request ,
	31	struct ceph_msg *);
	32
	33	/* a given osd we're communicating with */
	34	struct ceph_osd {
	35	atomic_t o_ref;
	36	struct ceph_osd_client *o_osdc;
	37	int o_osd;
	38	int o_incarnation;
	39	struct rb_node o_node;
	40	struct ceph_connection o_con;
	41	struct list_head o_requests;
a40c4f10	42	struct list_head o_linger_requests;
f5a2041b	43	struct list_head o_osd_lru;
6c4a1915	44	struct ceph_auth_handshake o_auth;
f5a2041b	45	unsigned long lru_ttl;
422d2cb8 YS	46	int o_marked_for_keepalive;
422d2cb8 YS	47	struct list_head o_keepalive_item;
f24e9980 SW	48	};
f24e9980 SW	49
1b83bef2 SW	50
	51	#define CEPH_OSD_MAX_OP 10
	52
2ac2b7a6 AE	53	enum ceph_osd_data_type {
	54	CEPH_OSD_DATA_TYPE_NONE,
	55	CEPH_OSD_DATA_TYPE_PAGES,
9a5e6d09	56	CEPH_OSD_DATA_TYPE_PAGELIST,
2ac2b7a6 AE	57	#ifdef CONFIG_BLOCK
	58	CEPH_OSD_DATA_TYPE_BIO,
	59	#endif /* CONFIG_BLOCK */
	60	};
	61
2794a82a	62	struct ceph_osd_data {
2ac2b7a6 AE	63	enum ceph_osd_data_type type;
2ac2b7a6 AE	64	union {
2794a82a AE	65	struct {
2794a82a AE	66	struct page **pages;
e0c59487	67	u64 length;
2794a82a AE	68	u32 alignment;
	69	bool pages_from_pool;
	70	bool own_pages;
	71	};
9a5e6d09	72	struct ceph_pagelist *pagelist;
2794a82a	73	#ifdef CONFIG_BLOCK
9a5e6d09	74	struct bio *bio;
2794a82a AE	75	#endif /* CONFIG_BLOCK */
	76	};
	77	};
	78
f24e9980 SW	79	/* an in-flight request */
	80	struct ceph_osd_request {
	81	u64 r_tid; /* unique for this client */
	82	struct rb_node r_node;
422d2cb8	83	struct list_head r_req_lru_item;
f24e9980	84	struct list_head r_osd_item;
a40c4f10 YS	85	struct list_head r_linger_item;
a40c4f10 YS	86	struct list_head r_linger_osd;
f24e9980	87	struct ceph_osd *r_osd;
5b191d99	88	struct ceph_pg r_pgid;
d85b7056 SW	89	int r_pg_osds[CEPH_PG_MAX_SIZE];
d85b7056 SW	90	int r_num_pg_osds;
f24e9980 SW	91
f24e9980 SW	92	struct ceph_msg r_request, r_reply;
f24e9980 SW	93	int r_flags; /* any additional flags for the osd */
f24e9980 SW	94	u32 r_sent; /* >0 if r_request is sending/sent */
1b83bef2 SW	95	int r_num_ops;
	96
	97	/* encoded message content */
	98	struct ceph_osd_op *r_request_ops;
	99	/* these are updated on each send */
	100	__le32 *r_request_osdmap_epoch;
	101	__le32 *r_request_flags;
	102	__le64 *r_request_pool;
	103	void *r_request_pgid;
	104	__le32 *r_request_attempts;
	105	struct ceph_eversion *r_request_reassert_version;
	106
	107	int r_result;
	108	int r_reply_op_len[CEPH_OSD_MAX_OP];
	109	s32 r_reply_op_result[CEPH_OSD_MAX_OP];
350b1c32	110	int r_got_reply;
a40c4f10	111	int r_linger;
0d5af164	112	int r_completed;
f24e9980 SW	113
f24e9980 SW	114	struct ceph_osd_client *r_osdc;
415e49a9	115	struct kref r_kref;
f24e9980 SW	116	bool r_mempool;
	117	struct completion r_completion, r_safe_completion;
	118	ceph_osdc_callback_t r_callback, r_safe_callback;
	119	struct ceph_eversion r_reassert_version;
	120	struct list_head r_unsafe_item;
	121
	122	struct inode r_inode; / for use by callbacks */
3d14c5d2	123	void r_priv; / ditto */
f24e9980	124
224736d9	125	char r_oid[MAX_OBJ_NAME_SIZE]; /* object name */
f24e9980	126	int r_oid_len;
2169aea6	127	u64 r_snapid;
3dd72fc0	128	unsigned long r_stamp; /* send OR check time */
f24e9980 SW	129
	130	struct ceph_file_layout r_file_layout;
	131	struct ceph_snap_context r_snapc; / snap context for writes */
68b4476b	132
0fff87ec AE	133	struct ceph_osd_data r_data_in;
0fff87ec AE	134	struct ceph_osd_data r_data_out;
f24e9980 SW	135	};
f24e9980 SW	136
a40c4f10 YS	137	struct ceph_osd_event {
	138	u64 cookie;
	139	int one_shot;
	140	struct ceph_osd_client *osdc;
	141	void (cb)(u64, u64, u8, void );
	142	void *data;
	143	struct rb_node node;
	144	struct list_head osd_node;
	145	struct kref kref;
a40c4f10 YS	146	};
	147
	148	struct ceph_osd_event_work {
	149	struct work_struct work;
	150	struct ceph_osd_event *event;
	151	u64 ver;
	152	u64 notify_id;
	153	u8 opcode;
	154	};
	155
f24e9980 SW	156	struct ceph_osd_client {
	157	struct ceph_client *client;
	158
	159	struct ceph_osdmap osdmap; / current map */
	160	struct rw_semaphore map_sem;
	161	struct completion map_waiters;
	162	u64 last_requested_map;
	163
	164	struct mutex request_mutex;
	165	struct rb_root osds; /* osds */
f5a2041b	166	struct list_head osd_lru; /* idle osds */
f24e9980 SW	167	u64 timeout_tid; /* tid of timeout triggering rq */
	168	u64 last_tid; /* tid of last request */
	169	struct rb_root requests; /* pending requests */
6f6c7006 SW	170	struct list_head req_lru; /* in-flight lru */
	171	struct list_head req_unsent; /* unsent/need-resend queue */
	172	struct list_head req_notarget; /* map to no osd */
a40c4f10	173	struct list_head req_linger; /* lingering requests */
f24e9980 SW	174	int num_requests;
f24e9980 SW	175	struct delayed_work timeout_work;
f5a2041b	176	struct delayed_work osds_timeout_work;
039934b8	177	#ifdef CONFIG_DEBUG_FS
f24e9980	178	struct dentry *debugfs_file;
039934b8	179	#endif
f24e9980 SW	180
	181	mempool_t *req_mempool;
	182
0d59ab81	183	struct ceph_msgpool msgpool_op;
c16e7869	184	struct ceph_msgpool msgpool_op_reply;
a40c4f10 YS	185
	186	spinlock_t event_lock;
	187	struct rb_root event_tree;
	188	u64 event_count;
	189
	190	struct workqueue_struct *notify_wq;
f24e9980 SW	191	};
f24e9980 SW	192
68b4476b YS	193	struct ceph_osd_req_op {
68b4476b YS	194	u16 op; /* CEPH_OSD_OP_* */
e7e319a9	195	u32 payload_len;
68b4476b YS	196	union {
	197	struct {
	198	u64 offset, length;
	199	u64 truncate_size;
	200	u32 truncate_seq;
	201	} extent;
68b4476b	202	struct {
ae1533b6	203	const char *class_name;
ae1533b6	204	const char *method_name;
2a24d1f4	205	const void *indata;
68b4476b	206	u32 indata_len;
e7e319a9 AE	207	__u8 class_len;
	208	__u8 method_len;
	209	__u8 argc;
68b4476b	210	} cls;
a40c4f10 YS	211	struct {
	212	u64 cookie;
	213	u64 ver;
a40c4f10 YS	214	u32 prot_ver;
a40c4f10 YS	215	u32 timeout;
e7e319a9	216	__u8 flag;
a40c4f10	217	} watch;
68b4476b	218	};
68b4476b YS	219	};
68b4476b YS	220
f24e9980 SW	221	extern int ceph_osdc_init(struct ceph_osd_client *osdc,
	222	struct ceph_client *client);
	223	extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
	224
	225	extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
	226	struct ceph_msg *msg);
	227	extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
	228	struct ceph_msg *msg);
	229
33803f33 AE	230	extern void osd_req_op_init(struct ceph_osd_req_op *op, u16 opcode);
	231	extern void osd_req_op_extent_init(struct ceph_osd_req_op *op, u16 opcode,
	232	u64 offset, u64 length,
	233	u64 truncate_size, u32 truncate_seq);
	234	extern void osd_req_op_cls_init(struct ceph_osd_req_op *op, u16 opcode,
	235	const char class, const char method,
	236	const void *request_data,
	237	size_t request_data_size);
	238	extern void osd_req_op_watch_init(struct ceph_osd_req_op *op, u16 opcode,
	239	u64 cookie, u64 version, int flag);
	240
3499e8a5	241	extern struct ceph_osd_request ceph_osdc_alloc_request(struct ceph_osd_client osdc,
3499e8a5	242	struct ceph_snap_context *snapc,
ae7ca4a3	243	unsigned int num_op,
3499e8a5	244	bool use_mempool,
54a54007	245	gfp_t gfp_flags);
3499e8a5	246
175face2	247	extern void ceph_osdc_build_request(struct ceph_osd_request *req, u64 off,
ae7ca4a3	248	unsigned int num_op,
68b4476b YS	249	struct ceph_osd_req_op *src_ops,
68b4476b YS	250	struct ceph_snap_context *snapc,
4d6b250b	251	u64 snap_id,
af77f26c	252	struct timespec *mtime);
3499e8a5	253
f24e9980 SW	254	extern struct ceph_osd_request ceph_osdc_new_request(struct ceph_osd_client ,
	255	struct ceph_file_layout *layout,
	256	struct ceph_vino vino,
	257	u64 offset, u64 *len, int op, int flags,
	258	struct ceph_snap_context *snapc,
	259	int do_sync, u32 truncate_seq,
	260	u64 truncate_size,
	261	struct timespec *mtime,
153e5167	262	bool use_mempool);
f24e9980	263
a40c4f10 YS	264	extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
	265	struct ceph_osd_request *req);
	266	extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
	267	struct ceph_osd_request *req);
	268
f24e9980 SW	269	static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
f24e9980 SW	270	{
415e49a9 SW	271	kref_get(&req->r_kref);
	272	}
	273	extern void ceph_osdc_release_request(struct kref *kref);
	274	static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
	275	{
	276	kref_put(&req->r_kref, ceph_osdc_release_request);
f24e9980	277	}
f24e9980 SW	278
	279	extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
	280	struct ceph_osd_request *req,
	281	bool nofail);
	282	extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
	283	struct ceph_osd_request *req);
	284	extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
	285
	286	extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
	287	struct ceph_vino vino,
	288	struct ceph_file_layout *layout,
	289	u64 off, u64 *plen,
	290	u32 truncate_seq, u64 truncate_size,
b7495fc2 SW	291	struct page **pages, int nr_pages,
b7495fc2 SW	292	int page_align);
f24e9980 SW	293
	294	extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
	295	struct ceph_vino vino,
	296	struct ceph_file_layout *layout,
	297	struct ceph_snap_context *sc,
	298	u64 off, u64 len,
	299	u32 truncate_seq, u64 truncate_size,
	300	struct timespec *mtime,
24808826	301	struct page **pages, int nr_pages);
f24e9980	302
a40c4f10 YS	303	/* watch/notify events */
	304	extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
	305	void (event_cb)(u64, u64, u8, void ),
3c663bbd	306	void data, struct ceph_osd_event *pevent);
a40c4f10	307	extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
a40c4f10	308	extern void ceph_osdc_put_event(struct ceph_osd_event *event);
f24e9980 SW	309	#endif
f24e9980 SW	310