]> Pileus Git - ~andy/linux/blob - include/linux/ceph/osd_client.h
71c41575646d4dfd86d8b6a876ed5707a2665eb8
[~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
33 /* a given osd we're communicating with */
34 struct ceph_osd {
35         atomic_t o_ref;
36         struct ceph_osd_client *o_osdc;
37         int o_osd;
38         int o_incarnation;
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;
48 };
49
50
51 #define CEPH_OSD_MAX_OP 2
52
53 enum ceph_osd_data_type {
54         CEPH_OSD_DATA_TYPE_NONE,
55         CEPH_OSD_DATA_TYPE_PAGES,
56         CEPH_OSD_DATA_TYPE_PAGELIST,
57 #ifdef CONFIG_BLOCK
58         CEPH_OSD_DATA_TYPE_BIO,
59 #endif /* CONFIG_BLOCK */
60 };
61
62 struct ceph_osd_data {
63         enum ceph_osd_data_type type;
64         union {
65                 struct {
66                         struct page     **pages;
67                         u64             length;
68                         u32             alignment;
69                         bool            pages_from_pool;
70                         bool            own_pages;
71                 };
72                 struct ceph_pagelist    *pagelist;
73 #ifdef CONFIG_BLOCK
74                 struct {
75                         struct bio      *bio;           /* list of bios */
76                         size_t          bio_length;     /* total in list */
77                 };
78 #endif /* CONFIG_BLOCK */
79         };
80 };
81
82 struct ceph_osd_req_op {
83         u16 op;           /* CEPH_OSD_OP_* */
84         u32 payload_len;
85         union {
86                 struct {
87                         u64 offset, length;
88                         u64 truncate_size;
89                         u32 truncate_seq;
90                         struct ceph_osd_data *osd_data;
91                 } extent;
92                 struct {
93                         const char *class_name;
94                         const char *method_name;
95                         const void *request_data;
96                         struct ceph_osd_data *request_info;
97                         struct ceph_osd_data *response_data;
98                         u32 request_data_len;
99                         __u8 class_len;
100                         __u8 method_len;
101                         __u8 argc;
102                 } cls;
103                 struct {
104                         u64 cookie;
105                         u64 ver;
106                         u32 prot_ver;
107                         u32 timeout;
108                         __u8 flag;
109                 } watch;
110         };
111 };
112
113 /* an in-flight request */
114 struct ceph_osd_request {
115         u64             r_tid;              /* unique for this client */
116         struct rb_node  r_node;
117         struct list_head r_req_lru_item;
118         struct list_head r_osd_item;
119         struct list_head r_linger_item;
120         struct list_head r_linger_osd;
121         struct ceph_osd *r_osd;
122         struct ceph_pg   r_pgid;
123         int              r_pg_osds[CEPH_PG_MAX_SIZE];
124         int              r_num_pg_osds;
125
126         struct ceph_msg  *r_request, *r_reply;
127         int               r_flags;     /* any additional flags for the osd */
128         u32               r_sent;      /* >0 if r_request is sending/sent */
129
130         /* request osd ops array  */
131         unsigned int            r_num_ops;
132         struct ceph_osd_req_op  r_ops[CEPH_OSD_MAX_OP];
133
134         /* these are updated on each send */
135         __le32           *r_request_osdmap_epoch;
136         __le32           *r_request_flags;
137         __le64           *r_request_pool;
138         void             *r_request_pgid;
139         __le32           *r_request_attempts;
140         struct ceph_eversion *r_request_reassert_version;
141
142         int               r_result;
143         int               r_reply_op_len[CEPH_OSD_MAX_OP];
144         s32               r_reply_op_result[CEPH_OSD_MAX_OP];
145         int               r_got_reply;
146         int               r_linger;
147         int               r_completed;
148
149         struct ceph_osd_client *r_osdc;
150         struct kref       r_kref;
151         bool              r_mempool;
152         struct completion r_completion, r_safe_completion;
153         ceph_osdc_callback_t r_callback, r_safe_callback;
154         struct ceph_eversion r_reassert_version;
155         struct list_head  r_unsafe_item;
156
157         struct inode *r_inode;                /* for use by callbacks */
158         void *r_priv;                         /* ditto */
159
160         char              r_oid[MAX_OBJ_NAME_SIZE];          /* object name */
161         int               r_oid_len;
162         u64               r_snapid;
163         unsigned long     r_stamp;            /* send OR check time */
164
165         struct ceph_file_layout r_file_layout;
166         struct ceph_snap_context *r_snapc;    /* snap context for writes */
167
168         struct ceph_osd_data r_data_in;
169         struct ceph_osd_data r_data_out;
170 };
171
172 struct ceph_osd_event {
173         u64 cookie;
174         int one_shot;
175         struct ceph_osd_client *osdc;
176         void (*cb)(u64, u64, u8, void *);
177         void *data;
178         struct rb_node node;
179         struct list_head osd_node;
180         struct kref kref;
181 };
182
183 struct ceph_osd_event_work {
184         struct work_struct work;
185         struct ceph_osd_event *event;
186         u64 ver;
187         u64 notify_id;
188         u8 opcode;
189 };
190
191 struct ceph_osd_client {
192         struct ceph_client     *client;
193
194         struct ceph_osdmap     *osdmap;       /* current map */
195         struct rw_semaphore    map_sem;
196         struct completion      map_waiters;
197         u64                    last_requested_map;
198
199         struct mutex           request_mutex;
200         struct rb_root         osds;          /* osds */
201         struct list_head       osd_lru;       /* idle osds */
202         u64                    timeout_tid;   /* tid of timeout triggering rq */
203         u64                    last_tid;      /* tid of last request */
204         struct rb_root         requests;      /* pending requests */
205         struct list_head       req_lru;       /* in-flight lru */
206         struct list_head       req_unsent;    /* unsent/need-resend queue */
207         struct list_head       req_notarget;  /* map to no osd */
208         struct list_head       req_linger;    /* lingering requests */
209         int                    num_requests;
210         struct delayed_work    timeout_work;
211         struct delayed_work    osds_timeout_work;
212 #ifdef CONFIG_DEBUG_FS
213         struct dentry          *debugfs_file;
214 #endif
215
216         mempool_t              *req_mempool;
217
218         struct ceph_msgpool     msgpool_op;
219         struct ceph_msgpool     msgpool_op_reply;
220
221         spinlock_t              event_lock;
222         struct rb_root          event_tree;
223         u64                     event_count;
224
225         struct workqueue_struct *notify_wq;
226 };
227
228 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
229                           struct ceph_client *client);
230 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
231
232 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
233                                    struct ceph_msg *msg);
234 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
235                                  struct ceph_msg *msg);
236
237 extern void osd_req_op_extent_init(struct ceph_osd_request *osd_req,
238                                         unsigned int which, u16 opcode,
239                                         u64 offset, u64 length,
240                                         u64 truncate_size, u32 truncate_seq);
241 extern void osd_req_op_extent_update(struct ceph_osd_request *osd_req,
242                                         unsigned int which, u64 length);
243 extern void osd_req_op_extent_osd_data(struct ceph_osd_request *osd_req,
244                                         unsigned int which,
245                                         struct ceph_osd_data *osd_data);
246 extern void osd_req_op_cls_init(struct ceph_osd_request *osd_req,
247                                         unsigned int which, u16 opcode,
248                                         const char *class, const char *method,
249                                         const void *request_data,
250                                         size_t request_data_size);
251 extern void osd_req_op_cls_response_data(struct ceph_osd_request *osd_req,
252                                         unsigned int which,
253                                         struct ceph_osd_data *response_data);
254 extern void osd_req_op_watch_init(struct ceph_osd_request *osd_req,
255                                         unsigned int which, u16 opcode,
256                                         u64 cookie, u64 version, int flag);
257
258 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
259                                                struct ceph_snap_context *snapc,
260                                                unsigned int num_ops,
261                                                bool use_mempool,
262                                                gfp_t gfp_flags);
263
264 extern void ceph_osdc_build_request(struct ceph_osd_request *req, u64 off,
265                                     struct ceph_snap_context *snapc,
266                                     u64 snap_id,
267                                     struct timespec *mtime);
268
269 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
270                                       struct ceph_file_layout *layout,
271                                       struct ceph_vino vino,
272                                       u64 offset, u64 *len,
273                                       int num_ops, int opcode, int flags,
274                                       struct ceph_snap_context *snapc,
275                                       u32 truncate_seq, u64 truncate_size,
276                                       bool use_mempool);
277
278 extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
279                                          struct ceph_osd_request *req);
280 extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
281                                                 struct ceph_osd_request *req);
282
283 static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
284 {
285         kref_get(&req->r_kref);
286 }
287 extern void ceph_osdc_release_request(struct kref *kref);
288 static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
289 {
290         kref_put(&req->r_kref, ceph_osdc_release_request);
291 }
292
293 extern void ceph_osd_data_pages_init(struct ceph_osd_data *osd_data,
294                                      struct page **pages, u64 length,
295                                      u32 alignment, bool pages_from_pool,
296                                      bool own_pages);
297 extern void ceph_osd_data_pagelist_init(struct ceph_osd_data *osd_data,
298                                         struct ceph_pagelist *pagelist);
299 #ifdef CONFIG_BLOCK
300 extern void ceph_osd_data_bio_init(struct ceph_osd_data *osd_data,
301                                    struct bio *bio, size_t bio_length);
302 #endif /* CONFIG_BLOCK */
303
304 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
305                                    struct ceph_osd_request *req,
306                                    bool nofail);
307 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
308                                   struct ceph_osd_request *req);
309 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
310
311 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
312                                struct ceph_vino vino,
313                                struct ceph_file_layout *layout,
314                                u64 off, u64 *plen,
315                                u32 truncate_seq, u64 truncate_size,
316                                struct page **pages, int nr_pages,
317                                int page_align);
318
319 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
320                                 struct ceph_vino vino,
321                                 struct ceph_file_layout *layout,
322                                 struct ceph_snap_context *sc,
323                                 u64 off, u64 len,
324                                 u32 truncate_seq, u64 truncate_size,
325                                 struct timespec *mtime,
326                                 struct page **pages, int nr_pages);
327
328 /* watch/notify events */
329 extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
330                                   void (*event_cb)(u64, u64, u8, void *),
331                                   void *data, struct ceph_osd_event **pevent);
332 extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
333 extern void ceph_osdc_put_event(struct ceph_osd_event *event);
334 #endif
335