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>
15 * Maximum object name size
16 * (must be at least as big as RBD_MAX_MD_NAME_LEN -- currently 100)
18 #define MAX_OBJ_NAME_SIZE 100
21 struct ceph_snap_context;
22 struct ceph_osd_request;
23 struct ceph_osd_client;
24 struct ceph_authorizer;
28 * completion callback for async writepages
30 typedef void (*ceph_osdc_callback_t)(struct ceph_osd_request *,
33 /* a given osd we're communicating with */
36 struct ceph_osd_client *o_osdc;
39 struct rb_node o_node;
40 struct ceph_connection o_con;
41 struct list_head o_requests;
42 struct list_head o_linger_requests;
43 struct list_head o_osd_lru;
44 struct ceph_auth_handshake o_auth;
45 unsigned long lru_ttl;
46 int o_marked_for_keepalive;
47 struct list_head o_keepalive_item;
50 /* an in-flight request */
51 struct ceph_osd_request {
52 u64 r_tid; /* unique for this client */
53 struct rb_node r_node;
54 struct list_head r_req_lru_item;
55 struct list_head r_osd_item;
56 struct list_head r_linger_item;
57 struct list_head r_linger_osd;
58 struct ceph_osd *r_osd;
59 struct ceph_pg r_pgid;
60 int r_pg_osds[CEPH_PG_MAX_SIZE];
63 struct ceph_connection *r_con_filling_msg;
65 struct ceph_msg *r_request, *r_reply;
67 int r_flags; /* any additional flags for the osd */
68 u32 r_sent; /* >0 if r_request is sending/sent */
72 struct ceph_osd_client *r_osdc;
75 struct completion r_completion, r_safe_completion;
76 ceph_osdc_callback_t r_callback, r_safe_callback;
77 struct ceph_eversion r_reassert_version;
78 struct list_head r_unsafe_item;
80 struct inode *r_inode; /* for use by callbacks */
81 void *r_priv; /* ditto */
83 char r_oid[MAX_OBJ_NAME_SIZE]; /* object name */
85 unsigned long r_stamp; /* send OR check time */
87 struct ceph_file_layout r_file_layout;
88 struct ceph_snap_context *r_snapc; /* snap context for writes */
89 unsigned r_num_pages; /* size of page array (follows) */
90 unsigned r_page_alignment; /* io offset in first page */
91 struct page **r_pages; /* pages for data payload */
92 int r_pages_from_pool;
93 int r_own_pages; /* if true, i own page list */
95 struct bio *r_bio; /* instead of pages */
98 struct ceph_pagelist *r_trail; /* trailing part of the data */
101 struct ceph_osd_event {
104 struct ceph_osd_client *osdc;
105 void (*cb)(u64, u64, u8, void *);
108 struct list_head osd_node;
110 struct completion completion;
113 struct ceph_osd_event_work {
114 struct work_struct work;
115 struct ceph_osd_event *event;
121 struct ceph_osd_client {
122 struct ceph_client *client;
124 struct ceph_osdmap *osdmap; /* current map */
125 struct rw_semaphore map_sem;
126 struct completion map_waiters;
127 u64 last_requested_map;
129 struct mutex request_mutex;
130 struct rb_root osds; /* osds */
131 struct list_head osd_lru; /* idle osds */
132 u64 timeout_tid; /* tid of timeout triggering rq */
133 u64 last_tid; /* tid of last request */
134 struct rb_root requests; /* pending requests */
135 struct list_head req_lru; /* in-flight lru */
136 struct list_head req_unsent; /* unsent/need-resend queue */
137 struct list_head req_notarget; /* map to no osd */
138 struct list_head req_linger; /* lingering requests */
140 struct delayed_work timeout_work;
141 struct delayed_work osds_timeout_work;
142 #ifdef CONFIG_DEBUG_FS
143 struct dentry *debugfs_file;
146 mempool_t *req_mempool;
148 struct ceph_msgpool msgpool_op;
149 struct ceph_msgpool msgpool_op_reply;
151 spinlock_t event_lock;
152 struct rb_root event_tree;
155 struct workqueue_struct *notify_wq;
158 struct ceph_osd_req_op {
159 u16 op; /* CEPH_OSD_OP_* */
160 u32 flags; /* CEPH_OSD_FLAG_* */
172 __u8 cmp_op; /* CEPH_OSD_CMPXATTR_OP_* */
173 __u8 cmp_mode; /* CEPH_OSD_CMPXATTR_MODE_* */
176 const char *class_name;
178 const char *method_name;
201 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
202 struct ceph_client *client);
203 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
205 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
206 struct ceph_msg *msg);
207 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
208 struct ceph_msg *msg);
210 extern void ceph_calc_raw_layout(struct ceph_osd_client *osdc,
211 struct ceph_file_layout *layout,
213 u64 off, u64 *plen, u64 *bno,
214 struct ceph_osd_request *req,
215 struct ceph_osd_req_op *op);
217 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
219 struct ceph_snap_context *snapc,
220 struct ceph_osd_req_op *ops,
226 extern void ceph_osdc_build_request(struct ceph_osd_request *req,
228 struct ceph_osd_req_op *src_ops,
229 struct ceph_snap_context *snapc,
230 struct timespec *mtime,
234 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
235 struct ceph_file_layout *layout,
236 struct ceph_vino vino,
237 u64 offset, u64 *len, int op, int flags,
238 struct ceph_snap_context *snapc,
239 int do_sync, u32 truncate_seq,
241 struct timespec *mtime,
242 bool use_mempool, int num_reply,
245 extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
246 struct ceph_osd_request *req);
247 extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
248 struct ceph_osd_request *req);
250 static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
252 kref_get(&req->r_kref);
254 extern void ceph_osdc_release_request(struct kref *kref);
255 static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
257 kref_put(&req->r_kref, ceph_osdc_release_request);
260 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
261 struct ceph_osd_request *req,
263 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
264 struct ceph_osd_request *req);
265 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
267 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
268 struct ceph_vino vino,
269 struct ceph_file_layout *layout,
271 u32 truncate_seq, u64 truncate_size,
272 struct page **pages, int nr_pages,
275 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
276 struct ceph_vino vino,
277 struct ceph_file_layout *layout,
278 struct ceph_snap_context *sc,
280 u32 truncate_seq, u64 truncate_size,
281 struct timespec *mtime,
282 struct page **pages, int nr_pages,
283 int flags, int do_sync, bool nofail);
285 /* watch/notify events */
286 extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
287 void (*event_cb)(u64, u64, u8, void *),
288 int one_shot, void *data,
289 struct ceph_osd_event **pevent);
290 extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
291 extern int ceph_osdc_wait_event(struct ceph_osd_event *event,
292 unsigned long timeout);
293 extern void ceph_osdc_put_event(struct ceph_osd_event *event);