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 struct ceph_snap_context
;
17 struct ceph_osd_request
;
18 struct ceph_osd_client
;
19 struct ceph_authorizer
;
22 * completion callback for async writepages
24 typedef void (*ceph_osdc_callback_t
)(struct ceph_osd_request
*,
26 typedef void (*ceph_osdc_unsafe_callback_t
)(struct ceph_osd_request
*, bool);
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 list_head o_requests
;
37 struct list_head o_linger_requests
;
38 struct list_head o_osd_lru
;
39 struct ceph_auth_handshake o_auth
;
40 unsigned long lru_ttl
;
41 int o_marked_for_keepalive
;
42 struct list_head o_keepalive_item
;
46 #define CEPH_OSD_SLAB_OPS 2
47 #define CEPH_OSD_MAX_OPS 16
49 enum ceph_osd_data_type
{
50 CEPH_OSD_DATA_TYPE_NONE
= 0,
51 CEPH_OSD_DATA_TYPE_PAGES
,
52 CEPH_OSD_DATA_TYPE_PAGELIST
,
54 CEPH_OSD_DATA_TYPE_BIO
,
55 #endif /* CONFIG_BLOCK */
58 struct ceph_osd_data
{
59 enum ceph_osd_data_type type
;
68 struct ceph_pagelist
*pagelist
;
71 struct bio
*bio
; /* list of bios */
72 size_t bio_length
; /* total in list */
74 #endif /* CONFIG_BLOCK */
78 struct ceph_osd_req_op
{
79 u16 op
; /* CEPH_OSD_OP_* */
80 u32 flags
; /* CEPH_OSD_OP_FLAG_* */
81 u32 indata_len
; /* request */
82 u32 outdata_len
; /* reply */
86 struct ceph_osd_data raw_data_in
;
91 struct ceph_osd_data osd_data
;
96 __u8 cmp_op
; /* CEPH_OSD_CMPXATTR_OP_* */
97 __u8 cmp_mode
; /* CEPH_OSD_CMPXATTR_MODE_* */
98 struct ceph_osd_data osd_data
;
101 const char *class_name
;
102 const char *method_name
;
103 struct ceph_osd_data request_info
;
104 struct ceph_osd_data request_data
;
105 struct ceph_osd_data response_data
;
118 u64 expected_object_size
;
119 u64 expected_write_size
;
124 /* an in-flight request */
125 struct ceph_osd_request
{
126 u64 r_tid
; /* unique for this client */
127 struct rb_node r_node
;
128 struct list_head r_req_lru_item
;
129 struct list_head r_osd_item
;
130 struct list_head r_linger_item
;
131 struct list_head r_linger_osd_item
;
132 struct ceph_osd
*r_osd
;
133 struct ceph_pg r_pgid
;
134 int r_pg_osds
[CEPH_PG_MAX_SIZE
];
137 struct ceph_msg
*r_request
, *r_reply
;
138 int r_flags
; /* any additional flags for the osd */
139 u32 r_sent
; /* >0 if r_request is sending/sent */
141 /* request osd ops array */
142 unsigned int r_num_ops
;
144 /* these are updated on each send */
145 __le32
*r_request_osdmap_epoch
;
146 __le32
*r_request_flags
;
147 __le64
*r_request_pool
;
148 void *r_request_pgid
;
149 __le32
*r_request_attempts
;
151 struct ceph_eversion
*r_request_reassert_version
;
157 struct ceph_osd_client
*r_osdc
;
160 struct completion r_completion
, r_safe_completion
;
161 ceph_osdc_callback_t r_callback
;
162 ceph_osdc_unsafe_callback_t r_unsafe_callback
;
163 struct ceph_eversion r_reassert_version
;
164 struct list_head r_unsafe_item
;
166 struct inode
*r_inode
; /* for use by callbacks */
167 void *r_priv
; /* ditto */
169 struct ceph_object_locator r_base_oloc
;
170 struct ceph_object_id r_base_oid
;
171 struct ceph_object_locator r_target_oloc
;
172 struct ceph_object_id r_target_oid
;
175 unsigned long r_stamp
; /* send OR check time */
177 struct ceph_snap_context
*r_snapc
; /* snap context for writes */
179 struct ceph_osd_req_op r_ops
[];
182 struct ceph_request_redirect
{
183 struct ceph_object_locator oloc
;
186 struct ceph_osd_event
{
189 struct ceph_osd_client
*osdc
;
190 void (*cb
)(u64
, u64
, u8
, void *);
193 struct list_head osd_node
;
197 struct ceph_osd_event_work
{
198 struct work_struct work
;
199 struct ceph_osd_event
*event
;
205 struct ceph_osd_client
{
206 struct ceph_client
*client
;
208 struct ceph_osdmap
*osdmap
; /* current map */
209 struct rw_semaphore map_sem
;
210 struct completion map_waiters
;
211 u64 last_requested_map
;
213 struct mutex request_mutex
;
214 struct rb_root osds
; /* osds */
215 struct list_head osd_lru
; /* idle osds */
216 u64 timeout_tid
; /* tid of timeout triggering rq */
217 u64 last_tid
; /* tid of last request */
218 struct rb_root requests
; /* pending requests */
219 struct list_head req_lru
; /* in-flight lru */
220 struct list_head req_unsent
; /* unsent/need-resend queue */
221 struct list_head req_notarget
; /* map to no osd */
222 struct list_head req_linger
; /* lingering requests */
224 struct delayed_work timeout_work
;
225 struct delayed_work osds_timeout_work
;
226 #ifdef CONFIG_DEBUG_FS
227 struct dentry
*debugfs_file
;
230 mempool_t
*req_mempool
;
232 struct ceph_msgpool msgpool_op
;
233 struct ceph_msgpool msgpool_op_reply
;
235 spinlock_t event_lock
;
236 struct rb_root event_tree
;
239 struct workqueue_struct
*notify_wq
;
242 extern int ceph_osdc_setup(void);
243 extern void ceph_osdc_cleanup(void);
245 extern int ceph_osdc_init(struct ceph_osd_client
*osdc
,
246 struct ceph_client
*client
);
247 extern void ceph_osdc_stop(struct ceph_osd_client
*osdc
);
249 extern void ceph_osdc_handle_reply(struct ceph_osd_client
*osdc
,
250 struct ceph_msg
*msg
);
251 extern void ceph_osdc_handle_map(struct ceph_osd_client
*osdc
,
252 struct ceph_msg
*msg
);
254 extern void osd_req_op_init(struct ceph_osd_request
*osd_req
,
255 unsigned int which
, u16 opcode
, u32 flags
);
257 extern void osd_req_op_raw_data_in_pages(struct ceph_osd_request
*,
259 struct page
**pages
, u64 length
,
260 u32 alignment
, bool pages_from_pool
,
263 extern void osd_req_op_extent_init(struct ceph_osd_request
*osd_req
,
264 unsigned int which
, u16 opcode
,
265 u64 offset
, u64 length
,
266 u64 truncate_size
, u32 truncate_seq
);
267 extern void osd_req_op_extent_update(struct ceph_osd_request
*osd_req
,
268 unsigned int which
, u64 length
);
269 extern void osd_req_op_extent_dup_last(struct ceph_osd_request
*osd_req
,
270 unsigned int which
, u64 offset_inc
);
272 extern struct ceph_osd_data
*osd_req_op_extent_osd_data(
273 struct ceph_osd_request
*osd_req
,
275 extern struct ceph_osd_data
*osd_req_op_cls_response_data(
276 struct ceph_osd_request
*osd_req
,
279 extern void osd_req_op_extent_osd_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_extent_osd_data_pagelist(struct ceph_osd_request
*,
286 struct ceph_pagelist
*pagelist
);
288 extern void osd_req_op_extent_osd_data_bio(struct ceph_osd_request
*,
290 struct bio
*bio
, size_t bio_length
);
291 #endif /* CONFIG_BLOCK */
293 extern void osd_req_op_cls_request_data_pagelist(struct ceph_osd_request
*,
295 struct ceph_pagelist
*pagelist
);
296 extern void osd_req_op_cls_request_data_pages(struct ceph_osd_request
*,
298 struct page
**pages
, u64 length
,
299 u32 alignment
, bool pages_from_pool
,
301 extern void osd_req_op_cls_response_data_pages(struct ceph_osd_request
*,
303 struct page
**pages
, u64 length
,
304 u32 alignment
, bool pages_from_pool
,
307 extern void osd_req_op_cls_init(struct ceph_osd_request
*osd_req
,
308 unsigned int which
, u16 opcode
,
309 const char *class, const char *method
);
310 extern int osd_req_op_xattr_init(struct ceph_osd_request
*osd_req
, unsigned int which
,
311 u16 opcode
, const char *name
, const void *value
,
312 size_t size
, u8 cmp_op
, u8 cmp_mode
);
313 extern void osd_req_op_watch_init(struct ceph_osd_request
*osd_req
,
314 unsigned int which
, u16 opcode
,
315 u64 cookie
, u64 version
, int flag
);
316 extern void osd_req_op_alloc_hint_init(struct ceph_osd_request
*osd_req
,
318 u64 expected_object_size
,
319 u64 expected_write_size
);
321 extern struct ceph_osd_request
*ceph_osdc_alloc_request(struct ceph_osd_client
*osdc
,
322 struct ceph_snap_context
*snapc
,
323 unsigned int num_ops
,
327 extern void ceph_osdc_build_request(struct ceph_osd_request
*req
, u64 off
,
328 struct ceph_snap_context
*snapc
,
330 struct timespec
*mtime
);
332 extern struct ceph_osd_request
*ceph_osdc_new_request(struct ceph_osd_client
*,
333 struct ceph_file_layout
*layout
,
334 struct ceph_vino vino
,
335 u64 offset
, u64
*len
,
336 unsigned int which
, int num_ops
,
337 int opcode
, int flags
,
338 struct ceph_snap_context
*snapc
,
339 u32 truncate_seq
, u64 truncate_size
,
342 extern void ceph_osdc_set_request_linger(struct ceph_osd_client
*osdc
,
343 struct ceph_osd_request
*req
);
345 extern void ceph_osdc_get_request(struct ceph_osd_request
*req
);
346 extern void ceph_osdc_put_request(struct ceph_osd_request
*req
);
348 extern int ceph_osdc_start_request(struct ceph_osd_client
*osdc
,
349 struct ceph_osd_request
*req
,
351 extern void ceph_osdc_cancel_request(struct ceph_osd_request
*req
);
352 extern int ceph_osdc_wait_request(struct ceph_osd_client
*osdc
,
353 struct ceph_osd_request
*req
);
354 extern void ceph_osdc_sync(struct ceph_osd_client
*osdc
);
356 extern void ceph_osdc_flush_notifies(struct ceph_osd_client
*osdc
);
358 extern int ceph_osdc_readpages(struct ceph_osd_client
*osdc
,
359 struct ceph_vino vino
,
360 struct ceph_file_layout
*layout
,
362 u32 truncate_seq
, u64 truncate_size
,
363 struct page
**pages
, int nr_pages
,
366 extern int ceph_osdc_writepages(struct ceph_osd_client
*osdc
,
367 struct ceph_vino vino
,
368 struct ceph_file_layout
*layout
,
369 struct ceph_snap_context
*sc
,
371 u32 truncate_seq
, u64 truncate_size
,
372 struct timespec
*mtime
,
373 struct page
**pages
, int nr_pages
);
375 /* watch/notify events */
376 extern int ceph_osdc_create_event(struct ceph_osd_client
*osdc
,
377 void (*event_cb
)(u64
, u64
, u8
, void *),
378 void *data
, struct ceph_osd_event
**pevent
);
379 extern void ceph_osdc_cancel_event(struct ceph_osd_event
*event
);
380 extern void ceph_osdc_put_event(struct ceph_osd_event
*event
);