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/msgpool.h>
13 #include <linux/ceph/auth.h>
14 #include <linux/ceph/pagelist.h>
17 struct ceph_snap_context;
18 struct ceph_osd_request;
19 struct ceph_osd_client;
22 * completion callback for async writepages
24 typedef void (*ceph_osdc_callback_t)(struct ceph_osd_request *);
26 #define CEPH_HOMELESS_OSD -1
28 /* a given osd we're communicating with */
31 struct ceph_osd_client *o_osdc;
34 struct rb_node o_node;
35 struct ceph_connection o_con;
36 struct rb_root o_requests;
37 struct rb_root o_linger_requests;
38 struct list_head o_osd_lru;
39 struct ceph_auth_handshake o_auth;
40 unsigned long lru_ttl;
41 struct list_head o_keepalive_item;
45 #define CEPH_OSD_SLAB_OPS 2
46 #define CEPH_OSD_MAX_OPS 16
48 enum ceph_osd_data_type {
49 CEPH_OSD_DATA_TYPE_NONE = 0,
50 CEPH_OSD_DATA_TYPE_PAGES,
51 CEPH_OSD_DATA_TYPE_PAGELIST,
53 CEPH_OSD_DATA_TYPE_BIO,
54 #endif /* CONFIG_BLOCK */
57 struct ceph_osd_data {
58 enum ceph_osd_data_type type;
67 struct ceph_pagelist *pagelist;
70 struct bio *bio; /* list of bios */
71 size_t bio_length; /* total in list */
73 #endif /* CONFIG_BLOCK */
77 struct ceph_osd_req_op {
78 u16 op; /* CEPH_OSD_OP_* */
79 u32 flags; /* CEPH_OSD_OP_FLAG_* */
80 u32 indata_len; /* request */
81 u32 outdata_len; /* reply */
85 struct ceph_osd_data raw_data_in;
90 struct ceph_osd_data osd_data;
95 __u8 cmp_op; /* CEPH_OSD_CMPXATTR_OP_* */
96 __u8 cmp_mode; /* CEPH_OSD_CMPXATTR_MODE_* */
97 struct ceph_osd_data osd_data;
100 const char *class_name;
101 const char *method_name;
102 struct ceph_osd_data request_info;
103 struct ceph_osd_data request_data;
104 struct ceph_osd_data response_data;
111 __u8 op; /* CEPH_OSD_WATCH_OP_ */
115 struct ceph_osd_data request_data;
119 struct ceph_osd_data request_data;
120 struct ceph_osd_data response_data;
123 struct ceph_osd_data response_data;
126 u64 expected_object_size;
127 u64 expected_write_size;
132 struct ceph_osd_request_target {
133 struct ceph_object_id base_oid;
134 struct ceph_object_locator base_oloc;
135 struct ceph_object_id target_oid;
136 struct ceph_object_locator target_oloc;
141 struct ceph_osds acting;
147 unsigned int flags; /* CEPH_OSD_FLAG_* */
153 /* an in-flight request */
154 struct ceph_osd_request {
155 u64 r_tid; /* unique for this client */
156 struct rb_node r_node;
157 struct rb_node r_mc_node; /* map check */
158 struct ceph_osd *r_osd;
160 struct ceph_osd_request_target r_t;
161 #define r_base_oid r_t.base_oid
162 #define r_base_oloc r_t.base_oloc
163 #define r_flags r_t.flags
165 struct ceph_msg *r_request, *r_reply;
166 u32 r_sent; /* >0 if r_request is sending/sent */
168 /* request osd ops array */
169 unsigned int r_num_ops;
173 struct ceph_osd_client *r_osdc;
176 struct completion r_completion; /* private to osd_client.c */
177 ceph_osdc_callback_t r_callback;
178 struct list_head r_unsafe_item;
180 struct inode *r_inode; /* for use by callbacks */
181 void *r_priv; /* ditto */
183 /* set by submitter */
184 u64 r_snapid; /* for reads, CEPH_NOSNAP o/w */
185 struct ceph_snap_context *r_snapc; /* for writes */
186 struct timespec r_mtime; /* ditto */
187 u64 r_data_offset; /* ditto */
188 bool r_linger; /* don't resend on failure */
191 unsigned long r_stamp; /* jiffies, send or check time */
193 struct ceph_eversion r_replay_version; /* aka reassert_version */
194 u32 r_last_force_resend;
197 struct ceph_osd_req_op r_ops[];
200 struct ceph_request_redirect {
201 struct ceph_object_locator oloc;
204 typedef void (*rados_watchcb2_t)(void *arg, u64 notify_id, u64 cookie,
205 u64 notifier_id, void *data, size_t data_len);
206 typedef void (*rados_watcherrcb_t)(void *arg, u64 cookie, int err);
208 struct ceph_osd_linger_request {
209 struct ceph_osd_client *osdc;
212 bool is_watch; /* watch or notify */
214 struct ceph_osd *osd;
215 struct ceph_osd_request *reg_req;
216 struct ceph_osd_request *ping_req;
217 unsigned long ping_sent;
218 unsigned long watch_valid_thru;
219 struct list_head pending_lworks;
221 struct ceph_osd_request_target t;
222 u32 last_force_resend;
225 struct timespec mtime;
229 struct rb_node node; /* osd */
230 struct rb_node osdc_node; /* osdc */
231 struct rb_node mc_node; /* map check */
232 struct list_head scan_item;
234 struct completion reg_commit_wait;
235 struct completion notify_finish_wait;
236 int reg_commit_error;
237 int notify_finish_error;
243 rados_watchcb2_t wcb;
244 rados_watcherrcb_t errcb;
247 struct page ***preply_pages;
251 struct ceph_watch_item {
252 struct ceph_entity_name name;
254 struct ceph_entity_addr addr;
257 #define CEPH_LINGER_ID_START 0xffff000000000000ULL
259 struct ceph_osd_client {
260 struct ceph_client *client;
262 struct ceph_osdmap *osdmap; /* current map */
263 struct rw_semaphore lock;
265 struct rb_root osds; /* osds */
266 struct list_head osd_lru; /* idle osds */
267 spinlock_t osd_lru_lock;
268 struct ceph_osd homeless_osd;
269 atomic64_t last_tid; /* tid of last request */
271 struct rb_root linger_requests; /* lingering requests */
272 struct rb_root map_checks;
273 struct rb_root linger_map_checks;
274 atomic_t num_requests;
275 atomic_t num_homeless;
276 struct delayed_work timeout_work;
277 struct delayed_work osds_timeout_work;
278 #ifdef CONFIG_DEBUG_FS
279 struct dentry *debugfs_file;
282 mempool_t *req_mempool;
284 struct ceph_msgpool msgpool_op;
285 struct ceph_msgpool msgpool_op_reply;
287 struct workqueue_struct *notify_wq;
290 static inline bool ceph_osdmap_flag(struct ceph_osd_client *osdc, int flag)
292 return osdc->osdmap->flags & flag;
295 extern int ceph_osdc_setup(void);
296 extern void ceph_osdc_cleanup(void);
298 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
299 struct ceph_client *client);
300 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
302 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
303 struct ceph_msg *msg);
304 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
305 struct ceph_msg *msg);
307 extern void osd_req_op_init(struct ceph_osd_request *osd_req,
308 unsigned int which, u16 opcode, u32 flags);
310 extern void osd_req_op_raw_data_in_pages(struct ceph_osd_request *,
312 struct page **pages, u64 length,
313 u32 alignment, bool pages_from_pool,
316 extern void osd_req_op_extent_init(struct ceph_osd_request *osd_req,
317 unsigned int which, u16 opcode,
318 u64 offset, u64 length,
319 u64 truncate_size, u32 truncate_seq);
320 extern void osd_req_op_extent_update(struct ceph_osd_request *osd_req,
321 unsigned int which, u64 length);
322 extern void osd_req_op_extent_dup_last(struct ceph_osd_request *osd_req,
323 unsigned int which, u64 offset_inc);
325 extern struct ceph_osd_data *osd_req_op_extent_osd_data(
326 struct ceph_osd_request *osd_req,
329 extern void osd_req_op_extent_osd_data_pages(struct ceph_osd_request *,
331 struct page **pages, u64 length,
332 u32 alignment, bool pages_from_pool,
334 extern void osd_req_op_extent_osd_data_pagelist(struct ceph_osd_request *,
336 struct ceph_pagelist *pagelist);
338 extern void osd_req_op_extent_osd_data_bio(struct ceph_osd_request *,
340 struct bio *bio, size_t bio_length);
341 #endif /* CONFIG_BLOCK */
343 extern void osd_req_op_cls_request_data_pagelist(struct ceph_osd_request *,
345 struct ceph_pagelist *pagelist);
346 extern void osd_req_op_cls_request_data_pages(struct ceph_osd_request *,
348 struct page **pages, u64 length,
349 u32 alignment, bool pages_from_pool,
351 extern void osd_req_op_cls_response_data_pages(struct ceph_osd_request *,
353 struct page **pages, u64 length,
354 u32 alignment, bool pages_from_pool,
356 extern void osd_req_op_cls_init(struct ceph_osd_request *osd_req,
357 unsigned int which, u16 opcode,
358 const char *class, const char *method);
359 extern int osd_req_op_xattr_init(struct ceph_osd_request *osd_req, unsigned int which,
360 u16 opcode, const char *name, const void *value,
361 size_t size, u8 cmp_op, u8 cmp_mode);
362 extern void osd_req_op_alloc_hint_init(struct ceph_osd_request *osd_req,
364 u64 expected_object_size,
365 u64 expected_write_size);
367 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
368 struct ceph_snap_context *snapc,
369 unsigned int num_ops,
372 int ceph_osdc_alloc_messages(struct ceph_osd_request *req, gfp_t gfp);
374 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
375 struct ceph_file_layout *layout,
376 struct ceph_vino vino,
377 u64 offset, u64 *len,
378 unsigned int which, int num_ops,
379 int opcode, int flags,
380 struct ceph_snap_context *snapc,
381 u32 truncate_seq, u64 truncate_size,
384 extern void ceph_osdc_get_request(struct ceph_osd_request *req);
385 extern void ceph_osdc_put_request(struct ceph_osd_request *req);
387 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
388 struct ceph_osd_request *req,
390 extern void ceph_osdc_cancel_request(struct ceph_osd_request *req);
391 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
392 struct ceph_osd_request *req);
393 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
395 extern void ceph_osdc_flush_notifies(struct ceph_osd_client *osdc);
396 void ceph_osdc_maybe_request_map(struct ceph_osd_client *osdc);
398 int ceph_osdc_call(struct ceph_osd_client *osdc,
399 struct ceph_object_id *oid,
400 struct ceph_object_locator *oloc,
401 const char *class, const char *method,
403 struct page *req_page, size_t req_len,
404 struct page *resp_page, size_t *resp_len);
406 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
407 struct ceph_vino vino,
408 struct ceph_file_layout *layout,
410 u32 truncate_seq, u64 truncate_size,
411 struct page **pages, int nr_pages,
414 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
415 struct ceph_vino vino,
416 struct ceph_file_layout *layout,
417 struct ceph_snap_context *sc,
419 u32 truncate_seq, u64 truncate_size,
420 struct timespec *mtime,
421 struct page **pages, int nr_pages);
424 struct ceph_osd_linger_request *
425 ceph_osdc_watch(struct ceph_osd_client *osdc,
426 struct ceph_object_id *oid,
427 struct ceph_object_locator *oloc,
428 rados_watchcb2_t wcb,
429 rados_watcherrcb_t errcb,
431 int ceph_osdc_unwatch(struct ceph_osd_client *osdc,
432 struct ceph_osd_linger_request *lreq);
434 int ceph_osdc_notify_ack(struct ceph_osd_client *osdc,
435 struct ceph_object_id *oid,
436 struct ceph_object_locator *oloc,
441 int ceph_osdc_notify(struct ceph_osd_client *osdc,
442 struct ceph_object_id *oid,
443 struct ceph_object_locator *oloc,
447 struct page ***preply_pages,
449 int ceph_osdc_watch_check(struct ceph_osd_client *osdc,
450 struct ceph_osd_linger_request *lreq);
451 int ceph_osdc_list_watchers(struct ceph_osd_client *osdc,
452 struct ceph_object_id *oid,
453 struct ceph_object_locator *oloc,
454 struct ceph_watch_item **watchers,