1 #ifndef _FS_CEPH_OSD_CLIENT_H
2 #define _FS_CEPH_OSD_CLIENT_H
4 #include <linux/completion.h>
5 #include <linux/kref.h>
6 #include <linux/mempool.h>
7 #include <linux/rbtree.h>
9 #include <linux/ceph/types.h>
10 #include <linux/ceph/osdmap.h>
11 #include <linux/ceph/messenger.h>
12 #include <linux/ceph/auth.h>
13 #include <linux/ceph/pagelist.h>
16 * Maximum object name size
17 * (must be at least as big as RBD_MAX_MD_NAME_LEN -- currently 100)
19 #define MAX_OBJ_NAME_SIZE 100
22 struct ceph_snap_context;
23 struct ceph_osd_request;
24 struct ceph_osd_client;
25 struct ceph_authorizer;
28 * completion callback for async writepages
30 typedef void (*ceph_osdc_callback_t)(struct ceph_osd_request *,
32 typedef void (*ceph_osdc_unsafe_callback_t)(struct ceph_osd_request *, bool);
34 /* a given osd we're communicating with */
37 struct ceph_osd_client *o_osdc;
40 struct rb_node o_node;
41 struct ceph_connection o_con;
42 struct list_head o_requests;
43 struct list_head o_linger_requests;
44 struct list_head o_osd_lru;
45 struct ceph_auth_handshake o_auth;
46 unsigned long lru_ttl;
47 int o_marked_for_keepalive;
48 struct list_head o_keepalive_item;
52 #define CEPH_OSD_MAX_OP 2
54 enum ceph_osd_data_type {
55 CEPH_OSD_DATA_TYPE_NONE = 0,
56 CEPH_OSD_DATA_TYPE_PAGES,
57 CEPH_OSD_DATA_TYPE_PAGELIST,
59 CEPH_OSD_DATA_TYPE_BIO,
60 #endif /* CONFIG_BLOCK */
63 struct ceph_osd_data {
64 enum ceph_osd_data_type type;
73 struct ceph_pagelist *pagelist;
76 struct bio *bio; /* list of bios */
77 size_t bio_length; /* total in list */
79 #endif /* CONFIG_BLOCK */
83 struct ceph_osd_req_op {
84 u16 op; /* CEPH_OSD_OP_* */
87 struct ceph_osd_data raw_data_in;
92 struct ceph_osd_data osd_data;
95 const char *class_name;
96 const char *method_name;
97 struct ceph_osd_data request_info;
98 struct ceph_osd_data request_data;
99 struct ceph_osd_data response_data;
114 /* an in-flight request */
115 struct ceph_osd_request {
116 u64 r_tid; /* unique for this client */
117 struct rb_node r_node;
118 struct list_head r_req_lru_item;
119 struct list_head r_osd_item;
120 struct list_head r_linger_item;
121 struct list_head r_linger_osd;
122 struct ceph_osd *r_osd;
123 struct ceph_pg r_pgid;
124 int r_pg_osds[CEPH_PG_MAX_SIZE];
127 struct ceph_msg *r_request, *r_reply;
128 int r_flags; /* any additional flags for the osd */
129 u32 r_sent; /* >0 if r_request is sending/sent */
131 /* request osd ops array */
132 unsigned int r_num_ops;
133 struct ceph_osd_req_op r_ops[CEPH_OSD_MAX_OP];
135 /* these are updated on each send */
136 __le32 *r_request_osdmap_epoch;
137 __le32 *r_request_flags;
138 __le64 *r_request_pool;
139 void *r_request_pgid;
140 __le32 *r_request_attempts;
141 struct ceph_eversion *r_request_reassert_version;
144 int r_reply_op_len[CEPH_OSD_MAX_OP];
145 s32 r_reply_op_result[CEPH_OSD_MAX_OP];
150 struct ceph_osd_client *r_osdc;
153 struct completion r_completion, r_safe_completion;
154 ceph_osdc_callback_t r_callback;
155 ceph_osdc_unsafe_callback_t r_unsafe_callback;
156 struct ceph_eversion r_reassert_version;
157 struct list_head r_unsafe_item;
159 struct inode *r_inode; /* for use by callbacks */
160 void *r_priv; /* ditto */
162 char r_oid[MAX_OBJ_NAME_SIZE]; /* object name */
165 unsigned long r_stamp; /* send OR check time */
167 struct ceph_file_layout r_file_layout;
168 struct ceph_snap_context *r_snapc; /* snap context for writes */
171 struct ceph_osd_event {
174 struct ceph_osd_client *osdc;
175 void (*cb)(u64, u64, u8, void *);
178 struct list_head osd_node;
182 struct ceph_osd_event_work {
183 struct work_struct work;
184 struct ceph_osd_event *event;
190 struct ceph_osd_client {
191 struct ceph_client *client;
193 struct ceph_osdmap *osdmap; /* current map */
194 struct rw_semaphore map_sem;
195 struct completion map_waiters;
196 u64 last_requested_map;
198 struct mutex request_mutex;
199 struct rb_root osds; /* osds */
200 struct list_head osd_lru; /* idle osds */
201 u64 timeout_tid; /* tid of timeout triggering rq */
202 u64 last_tid; /* tid of last request */
203 struct rb_root requests; /* pending requests */
204 struct list_head req_lru; /* in-flight lru */
205 struct list_head req_unsent; /* unsent/need-resend queue */
206 struct list_head req_notarget; /* map to no osd */
207 struct list_head req_linger; /* lingering requests */
209 struct delayed_work timeout_work;
210 struct delayed_work osds_timeout_work;
211 #ifdef CONFIG_DEBUG_FS
212 struct dentry *debugfs_file;
215 mempool_t *req_mempool;
217 struct ceph_msgpool msgpool_op;
218 struct ceph_msgpool msgpool_op_reply;
220 spinlock_t event_lock;
221 struct rb_root event_tree;
224 struct workqueue_struct *notify_wq;
227 extern int ceph_osdc_setup(void);
228 extern void ceph_osdc_cleanup(void);
230 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
231 struct ceph_client *client);
232 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
234 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
235 struct ceph_msg *msg);
236 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
237 struct ceph_msg *msg);
239 extern void osd_req_op_init(struct ceph_osd_request *osd_req,
240 unsigned int which, u16 opcode);
242 extern void osd_req_op_raw_data_in_pages(struct ceph_osd_request *,
244 struct page **pages, u64 length,
245 u32 alignment, bool pages_from_pool,
248 extern void osd_req_op_extent_init(struct ceph_osd_request *osd_req,
249 unsigned int which, u16 opcode,
250 u64 offset, u64 length,
251 u64 truncate_size, u32 truncate_seq);
252 extern void osd_req_op_extent_update(struct ceph_osd_request *osd_req,
253 unsigned int which, u64 length);
255 extern struct ceph_osd_data *osd_req_op_extent_osd_data(
256 struct ceph_osd_request *osd_req,
258 extern struct ceph_osd_data *osd_req_op_cls_response_data(
259 struct ceph_osd_request *osd_req,
262 extern void osd_req_op_extent_osd_data_pages(struct ceph_osd_request *,
264 struct page **pages, u64 length,
265 u32 alignment, bool pages_from_pool,
267 extern void osd_req_op_extent_osd_data_pagelist(struct ceph_osd_request *,
269 struct ceph_pagelist *pagelist);
271 extern void osd_req_op_extent_osd_data_bio(struct ceph_osd_request *,
273 struct bio *bio, size_t bio_length);
274 #endif /* CONFIG_BLOCK */
276 extern void osd_req_op_cls_request_data_pagelist(struct ceph_osd_request *,
278 struct ceph_pagelist *pagelist);
279 extern void osd_req_op_cls_request_data_pages(struct ceph_osd_request *,
281 struct page **pages, u64 length,
282 u32 alignment, bool pages_from_pool,
284 extern void osd_req_op_cls_response_data_pages(struct ceph_osd_request *,
286 struct page **pages, u64 length,
287 u32 alignment, bool pages_from_pool,
290 extern void osd_req_op_cls_init(struct ceph_osd_request *osd_req,
291 unsigned int which, u16 opcode,
292 const char *class, const char *method);
293 extern void osd_req_op_watch_init(struct ceph_osd_request *osd_req,
294 unsigned int which, u16 opcode,
295 u64 cookie, u64 version, int flag);
297 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
298 struct ceph_snap_context *snapc,
299 unsigned int num_ops,
303 extern void ceph_osdc_build_request(struct ceph_osd_request *req, u64 off,
304 struct ceph_snap_context *snapc,
306 struct timespec *mtime);
308 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
309 struct ceph_file_layout *layout,
310 struct ceph_vino vino,
311 u64 offset, u64 *len,
312 int num_ops, int opcode, int flags,
313 struct ceph_snap_context *snapc,
314 u32 truncate_seq, u64 truncate_size,
317 extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
318 struct ceph_osd_request *req);
319 extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
320 struct ceph_osd_request *req);
322 static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
324 kref_get(&req->r_kref);
326 extern void ceph_osdc_release_request(struct kref *kref);
327 static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
329 kref_put(&req->r_kref, ceph_osdc_release_request);
332 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
333 struct ceph_osd_request *req,
335 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
336 struct ceph_osd_request *req);
337 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
339 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
340 struct ceph_vino vino,
341 struct ceph_file_layout *layout,
343 u32 truncate_seq, u64 truncate_size,
344 struct page **pages, int nr_pages,
347 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
348 struct ceph_vino vino,
349 struct ceph_file_layout *layout,
350 struct ceph_snap_context *sc,
352 u32 truncate_seq, u64 truncate_size,
353 struct timespec *mtime,
354 struct page **pages, int nr_pages);
356 /* watch/notify events */
357 extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
358 void (*event_cb)(u64, u64, u8, void *),
359 void *data, struct ceph_osd_event **pevent);
360 extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
361 extern void ceph_osdc_put_event(struct ceph_osd_event *event);