]> Pileus Git - ~andy/linux/blob - include/linux/ceph/osd_client.h
4191cd2c55e54a612aba6c17b317c45350dd7e0a
[~andy/linux] / include / linux / ceph / osd_client.h
1 #ifndef _FS_CEPH_OSD_CLIENT_H
2 #define _FS_CEPH_OSD_CLIENT_H
3
4 #include <linux/completion.h>
5 #include <linux/kref.h>
6 #include <linux/mempool.h>
7 #include <linux/rbtree.h>
8
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>
14
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
21 struct ceph_msg;
22 struct ceph_snap_context;
23 struct ceph_osd_request;
24 struct ceph_osd_client;
25 struct ceph_authorizer;
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 typedef void (*ceph_osdc_unsafe_callback_t)(struct ceph_osd_request *, bool);
33
34 /* a given osd we're communicating with */
35 struct ceph_osd {
36         atomic_t o_ref;
37         struct ceph_osd_client *o_osdc;
38         int o_osd;
39         int o_incarnation;
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;
49 };
50
51
52 #define CEPH_OSD_MAX_OP 2
53
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,
58 #ifdef CONFIG_BLOCK
59         CEPH_OSD_DATA_TYPE_BIO,
60 #endif /* CONFIG_BLOCK */
61 };
62
63 struct ceph_osd_data {
64         enum ceph_osd_data_type type;
65         union {
66                 struct {
67                         struct page     **pages;
68                         u64             length;
69                         u32             alignment;
70                         bool            pages_from_pool;
71                         bool            own_pages;
72                 };
73                 struct ceph_pagelist    *pagelist;
74 #ifdef CONFIG_BLOCK
75                 struct {
76                         struct bio      *bio;           /* list of bios */
77                         size_t          bio_length;     /* total in list */
78                 };
79 #endif /* CONFIG_BLOCK */
80         };
81 };
82
83 struct ceph_osd_req_op {
84         u16 op;           /* CEPH_OSD_OP_* */
85         u32 payload_len;
86         union {
87                 struct ceph_osd_data raw_data_in;
88                 struct {
89                         u64 offset, length;
90                         u64 truncate_size;
91                         u32 truncate_seq;
92                         struct ceph_osd_data osd_data;
93                 } extent;
94                 struct {
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;
100                         __u8 class_len;
101                         __u8 method_len;
102                         __u8 argc;
103                 } cls;
104                 struct {
105                         u64 cookie;
106                         u64 ver;
107                         u32 prot_ver;
108                         u32 timeout;
109                         __u8 flag;
110                 } watch;
111         };
112 };
113
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];
125         int              r_num_pg_osds;
126
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 */
130
131         /* request osd ops array  */
132         unsigned int            r_num_ops;
133         struct ceph_osd_req_op  r_ops[CEPH_OSD_MAX_OP];
134
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;
142
143         int               r_result;
144         int               r_reply_op_len[CEPH_OSD_MAX_OP];
145         s32               r_reply_op_result[CEPH_OSD_MAX_OP];
146         int               r_got_reply;
147         int               r_linger;
148         int               r_completed;
149
150         struct ceph_osd_client *r_osdc;
151         struct kref       r_kref;
152         bool              r_mempool;
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;
158
159         struct inode *r_inode;                /* for use by callbacks */
160         void *r_priv;                         /* ditto */
161
162         char              r_oid[MAX_OBJ_NAME_SIZE];          /* object name */
163         int               r_oid_len;
164         u64               r_snapid;
165         unsigned long     r_stamp;            /* send OR check time */
166
167         struct ceph_file_layout r_file_layout;
168         struct ceph_snap_context *r_snapc;    /* snap context for writes */
169 };
170
171 struct ceph_osd_event {
172         u64 cookie;
173         int one_shot;
174         struct ceph_osd_client *osdc;
175         void (*cb)(u64, u64, u8, void *);
176         void *data;
177         struct rb_node node;
178         struct list_head osd_node;
179         struct kref kref;
180 };
181
182 struct ceph_osd_event_work {
183         struct work_struct work;
184         struct ceph_osd_event *event;
185         u64 ver;
186         u64 notify_id;
187         u8 opcode;
188 };
189
190 struct ceph_osd_client {
191         struct ceph_client     *client;
192
193         struct ceph_osdmap     *osdmap;       /* current map */
194         struct rw_semaphore    map_sem;
195         struct completion      map_waiters;
196         u64                    last_requested_map;
197
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 */
208         int                    num_requests;
209         struct delayed_work    timeout_work;
210         struct delayed_work    osds_timeout_work;
211 #ifdef CONFIG_DEBUG_FS
212         struct dentry          *debugfs_file;
213 #endif
214
215         mempool_t              *req_mempool;
216
217         struct ceph_msgpool     msgpool_op;
218         struct ceph_msgpool     msgpool_op_reply;
219
220         spinlock_t              event_lock;
221         struct rb_root          event_tree;
222         u64                     event_count;
223
224         struct workqueue_struct *notify_wq;
225 };
226
227 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
228                           struct ceph_client *client);
229 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
230
231 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
232                                    struct ceph_msg *msg);
233 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
234                                  struct ceph_msg *msg);
235
236 extern void osd_req_op_init(struct ceph_osd_request *osd_req,
237                                         unsigned int which, u16 opcode);
238
239 extern void osd_req_op_raw_data_in_pages(struct ceph_osd_request *,
240                                         unsigned int which,
241                                         struct page **pages, u64 length,
242                                         u32 alignment, bool pages_from_pool,
243                                         bool own_pages);
244
245 extern void osd_req_op_extent_init(struct ceph_osd_request *osd_req,
246                                         unsigned int which, u16 opcode,
247                                         u64 offset, u64 length,
248                                         u64 truncate_size, u32 truncate_seq);
249 extern void osd_req_op_extent_update(struct ceph_osd_request *osd_req,
250                                         unsigned int which, u64 length);
251
252 extern struct ceph_osd_data *osd_req_op_extent_osd_data(
253                                         struct ceph_osd_request *osd_req,
254                                         unsigned int which);
255 extern struct ceph_osd_data *osd_req_op_cls_response_data(
256                                         struct ceph_osd_request *osd_req,
257                                         unsigned int which);
258
259 extern void osd_req_op_extent_osd_data_pages(struct ceph_osd_request *,
260                                         unsigned int which,
261                                         struct page **pages, u64 length,
262                                         u32 alignment, bool pages_from_pool,
263                                         bool own_pages);
264 extern void osd_req_op_extent_osd_data_pagelist(struct ceph_osd_request *,
265                                         unsigned int which,
266                                         struct ceph_pagelist *pagelist);
267 #ifdef CONFIG_BLOCK
268 extern void osd_req_op_extent_osd_data_bio(struct ceph_osd_request *,
269                                         unsigned int which,
270                                         struct bio *bio, size_t bio_length);
271 #endif /* CONFIG_BLOCK */
272
273 extern void osd_req_op_cls_request_data_pagelist(struct ceph_osd_request *,
274                                         unsigned int which,
275                                         struct ceph_pagelist *pagelist);
276 extern void osd_req_op_cls_request_data_pages(struct ceph_osd_request *,
277                                         unsigned int which,
278                                         struct page **pages, u64 length,
279                                         u32 alignment, bool pages_from_pool,
280                                         bool own_pages);
281 extern void osd_req_op_cls_response_data_pages(struct ceph_osd_request *,
282                                         unsigned int which,
283                                         struct page **pages, u64 length,
284                                         u32 alignment, bool pages_from_pool,
285                                         bool own_pages);
286
287 extern void osd_req_op_cls_init(struct ceph_osd_request *osd_req,
288                                         unsigned int which, u16 opcode,
289                                         const char *class, const char *method);
290 extern void osd_req_op_watch_init(struct ceph_osd_request *osd_req,
291                                         unsigned int which, u16 opcode,
292                                         u64 cookie, u64 version, int flag);
293
294 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
295                                                struct ceph_snap_context *snapc,
296                                                unsigned int num_ops,
297                                                bool use_mempool,
298                                                gfp_t gfp_flags);
299
300 extern void ceph_osdc_build_request(struct ceph_osd_request *req, u64 off,
301                                     struct ceph_snap_context *snapc,
302                                     u64 snap_id,
303                                     struct timespec *mtime);
304
305 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
306                                       struct ceph_file_layout *layout,
307                                       struct ceph_vino vino,
308                                       u64 offset, u64 *len,
309                                       int num_ops, int opcode, int flags,
310                                       struct ceph_snap_context *snapc,
311                                       u32 truncate_seq, u64 truncate_size,
312                                       bool use_mempool);
313
314 extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
315                                          struct ceph_osd_request *req);
316 extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
317                                                 struct ceph_osd_request *req);
318
319 static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
320 {
321         kref_get(&req->r_kref);
322 }
323 extern void ceph_osdc_release_request(struct kref *kref);
324 static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
325 {
326         kref_put(&req->r_kref, ceph_osdc_release_request);
327 }
328
329 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
330                                    struct ceph_osd_request *req,
331                                    bool nofail);
332 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
333                                   struct ceph_osd_request *req);
334 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
335
336 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
337                                struct ceph_vino vino,
338                                struct ceph_file_layout *layout,
339                                u64 off, u64 *plen,
340                                u32 truncate_seq, u64 truncate_size,
341                                struct page **pages, int nr_pages,
342                                int page_align);
343
344 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
345                                 struct ceph_vino vino,
346                                 struct ceph_file_layout *layout,
347                                 struct ceph_snap_context *sc,
348                                 u64 off, u64 len,
349                                 u32 truncate_seq, u64 truncate_size,
350                                 struct timespec *mtime,
351                                 struct page **pages, int nr_pages);
352
353 /* watch/notify events */
354 extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
355                                   void (*event_cb)(u64, u64, u8, void *),
356                                   void *data, struct ceph_osd_event **pevent);
357 extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
358 extern void ceph_osdc_put_event(struct ceph_osd_event *event);
359 #endif
360