]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - include/linux/ceph/osd_client.h
rbd: rbd_dev_header_unwatch_sync() variant
[mirror_ubuntu-focal-kernel.git] / include / linux / ceph / osd_client.h
CommitLineData
f24e9980
SW
1#ifndef _FS_CEPH_OSD_CLIENT_H
2#define _FS_CEPH_OSD_CLIENT_H
3
4#include <linux/completion.h>
415e49a9 5#include <linux/kref.h>
f24e9980
SW
6#include <linux/mempool.h>
7#include <linux/rbtree.h>
8
6c4a1915
AE
9#include <linux/ceph/types.h>
10#include <linux/ceph/osdmap.h>
11#include <linux/ceph/messenger.h>
12#include <linux/ceph/auth.h>
c885837f 13#include <linux/ceph/pagelist.h>
f24e9980
SW
14
15struct ceph_msg;
16struct ceph_snap_context;
17struct ceph_osd_request;
18struct ceph_osd_client;
19
20/*
21 * completion callback for async writepages
22 */
85e084fe 23typedef void (*ceph_osdc_callback_t)(struct ceph_osd_request *);
26be8808 24typedef void (*ceph_osdc_unsafe_callback_t)(struct ceph_osd_request *, bool);
f24e9980 25
63244fa1
ID
26#define CEPH_HOMELESS_OSD -1
27
f24e9980
SW
28/* a given osd we're communicating with */
29struct ceph_osd {
30 atomic_t o_ref;
31 struct ceph_osd_client *o_osdc;
32 int o_osd;
33 int o_incarnation;
34 struct rb_node o_node;
35 struct ceph_connection o_con;
5aea3dcd 36 struct rb_root o_requests;
a40c4f10 37 struct list_head o_linger_requests;
f5a2041b 38 struct list_head o_osd_lru;
6c4a1915 39 struct ceph_auth_handshake o_auth;
f5a2041b 40 unsigned long lru_ttl;
422d2cb8 41 struct list_head o_keepalive_item;
5aea3dcd 42 struct mutex lock;
f24e9980
SW
43};
44
3f1af42a
ID
45#define CEPH_OSD_SLAB_OPS 2
46#define CEPH_OSD_MAX_OPS 16
1b83bef2 47
2ac2b7a6 48enum ceph_osd_data_type {
ec9123c5 49 CEPH_OSD_DATA_TYPE_NONE = 0,
2ac2b7a6 50 CEPH_OSD_DATA_TYPE_PAGES,
9a5e6d09 51 CEPH_OSD_DATA_TYPE_PAGELIST,
2ac2b7a6
AE
52#ifdef CONFIG_BLOCK
53 CEPH_OSD_DATA_TYPE_BIO,
54#endif /* CONFIG_BLOCK */
55};
56
2794a82a 57struct ceph_osd_data {
2ac2b7a6
AE
58 enum ceph_osd_data_type type;
59 union {
2794a82a
AE
60 struct {
61 struct page **pages;
e0c59487 62 u64 length;
2794a82a
AE
63 u32 alignment;
64 bool pages_from_pool;
65 bool own_pages;
66 };
9a5e6d09 67 struct ceph_pagelist *pagelist;
2794a82a 68#ifdef CONFIG_BLOCK
fdce58cc
AE
69 struct {
70 struct bio *bio; /* list of bios */
71 size_t bio_length; /* total in list */
72 };
2794a82a
AE
73#endif /* CONFIG_BLOCK */
74 };
75};
76
79528734
AE
77struct ceph_osd_req_op {
78 u16 op; /* CEPH_OSD_OP_* */
7b25bf5f 79 u32 flags; /* CEPH_OSD_OP_FLAG_* */
de2aa102 80 u32 indata_len; /* request */
7665d85b
YZ
81 u32 outdata_len; /* reply */
82 s32 rval;
83
79528734 84 union {
49719778 85 struct ceph_osd_data raw_data_in;
79528734
AE
86 struct {
87 u64 offset, length;
88 u64 truncate_size;
89 u32 truncate_seq;
5476492f 90 struct ceph_osd_data osd_data;
79528734 91 } extent;
d74b50be 92 struct {
d7d5a007
ID
93 u32 name_len;
94 u32 value_len;
d74b50be
YZ
95 __u8 cmp_op; /* CEPH_OSD_CMPXATTR_OP_* */
96 __u8 cmp_mode; /* CEPH_OSD_CMPXATTR_MODE_* */
97 struct ceph_osd_data osd_data;
98 } xattr;
79528734
AE
99 struct {
100 const char *class_name;
101 const char *method_name;
5476492f 102 struct ceph_osd_data request_info;
04017e29 103 struct ceph_osd_data request_data;
5476492f 104 struct ceph_osd_data response_data;
79528734
AE
105 __u8 class_len;
106 __u8 method_len;
bb873b53 107 u32 indata_len;
79528734
AE
108 } cls;
109 struct {
110 u64 cookie;
111 u64 ver;
112 u32 prot_ver;
113 u32 timeout;
114 __u8 flag;
115 } watch;
c647b8a8
ID
116 struct {
117 u64 expected_object_size;
118 u64 expected_write_size;
119 } alloc_hint;
79528734
AE
120 };
121};
122
63244fa1
ID
123struct ceph_osd_request_target {
124 struct ceph_object_id base_oid;
125 struct ceph_object_locator base_oloc;
126 struct ceph_object_id target_oid;
127 struct ceph_object_locator target_oloc;
128
129 struct ceph_pg pgid;
130 u32 pg_num;
131 u32 pg_num_mask;
132 struct ceph_osds acting;
133 struct ceph_osds up;
134 int size;
135 int min_size;
136 bool sort_bitwise;
137
138 unsigned int flags; /* CEPH_OSD_FLAG_* */
139 bool paused;
140
141 int osd;
142};
143
f24e9980
SW
144/* an in-flight request */
145struct ceph_osd_request {
146 u64 r_tid; /* unique for this client */
147 struct rb_node r_node;
a40c4f10 148 struct list_head r_linger_item;
1d0326b1 149 struct list_head r_linger_osd_item;
f24e9980 150 struct ceph_osd *r_osd;
a66dd383
ID
151
152 struct ceph_osd_request_target r_t;
153#define r_base_oid r_t.base_oid
154#define r_base_oloc r_t.base_oloc
155#define r_flags r_t.flags
f24e9980
SW
156
157 struct ceph_msg *r_request, *r_reply;
f24e9980 158 u32 r_sent; /* >0 if r_request is sending/sent */
1b83bef2 159
79528734
AE
160 /* request osd ops array */
161 unsigned int r_num_ops;
79528734 162
1b83bef2 163 int r_result;
fe5da05e 164 bool r_got_reply;
a40c4f10 165 int r_linger;
f24e9980
SW
166
167 struct ceph_osd_client *r_osdc;
415e49a9 168 struct kref r_kref;
f24e9980 169 bool r_mempool;
fe5da05e
ID
170 struct completion r_completion;
171 struct completion r_safe_completion; /* fsync waiter */
26be8808
AE
172 ceph_osdc_callback_t r_callback;
173 ceph_osdc_unsafe_callback_t r_unsafe_callback;
f24e9980
SW
174 struct list_head r_unsafe_item;
175
176 struct inode *r_inode; /* for use by callbacks */
3d14c5d2 177 void *r_priv; /* ditto */
f24e9980 178
bb873b53
ID
179 /* set by submitter */
180 u64 r_snapid; /* for reads, CEPH_NOSNAP o/w */
181 struct ceph_snap_context *r_snapc; /* for writes */
182 struct timespec r_mtime; /* ditto */
183 u64 r_data_offset; /* ditto */
f24e9980 184
bb873b53
ID
185 /* internal */
186 unsigned long r_stamp; /* jiffies, send or check time */
187 int r_attempts;
188 struct ceph_eversion r_replay_version; /* aka reassert_version */
189 u32 r_last_force_resend;
3f1af42a
ID
190
191 struct ceph_osd_req_op r_ops[];
f24e9980
SW
192};
193
205ee118
ID
194struct ceph_request_redirect {
195 struct ceph_object_locator oloc;
196};
197
a40c4f10
YS
198struct ceph_osd_event {
199 u64 cookie;
200 int one_shot;
201 struct ceph_osd_client *osdc;
202 void (*cb)(u64, u64, u8, void *);
203 void *data;
204 struct rb_node node;
205 struct list_head osd_node;
206 struct kref kref;
a40c4f10
YS
207};
208
209struct ceph_osd_event_work {
210 struct work_struct work;
211 struct ceph_osd_event *event;
212 u64 ver;
213 u64 notify_id;
214 u8 opcode;
215};
216
f24e9980
SW
217struct ceph_osd_client {
218 struct ceph_client *client;
219
220 struct ceph_osdmap *osdmap; /* current map */
5aea3dcd 221 struct rw_semaphore lock;
f24e9980 222
f24e9980 223 struct rb_root osds; /* osds */
f5a2041b 224 struct list_head osd_lru; /* idle osds */
9dd2845c 225 spinlock_t osd_lru_lock;
a40c4f10 226 struct list_head req_linger; /* lingering requests */
5aea3dcd
ID
227 struct ceph_osd homeless_osd;
228 atomic64_t last_tid; /* tid of last request */
229 atomic_t num_requests;
230 atomic_t num_homeless;
f24e9980 231 struct delayed_work timeout_work;
f5a2041b 232 struct delayed_work osds_timeout_work;
039934b8 233#ifdef CONFIG_DEBUG_FS
f24e9980 234 struct dentry *debugfs_file;
039934b8 235#endif
f24e9980
SW
236
237 mempool_t *req_mempool;
238
0d59ab81 239 struct ceph_msgpool msgpool_op;
c16e7869 240 struct ceph_msgpool msgpool_op_reply;
a40c4f10
YS
241
242 spinlock_t event_lock;
243 struct rb_root event_tree;
244 u64 event_count;
245
246 struct workqueue_struct *notify_wq;
f24e9980
SW
247};
248
5522ae0b
AE
249extern int ceph_osdc_setup(void);
250extern void ceph_osdc_cleanup(void);
251
f24e9980
SW
252extern int ceph_osdc_init(struct ceph_osd_client *osdc,
253 struct ceph_client *client);
254extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
255
256extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
257 struct ceph_msg *msg);
258extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
259 struct ceph_msg *msg);
260
49719778 261extern void osd_req_op_init(struct ceph_osd_request *osd_req,
144cba14 262 unsigned int which, u16 opcode, u32 flags);
49719778
AE
263
264extern void osd_req_op_raw_data_in_pages(struct ceph_osd_request *,
265 unsigned int which,
266 struct page **pages, u64 length,
267 u32 alignment, bool pages_from_pool,
268 bool own_pages);
269
c99d2d4a
AE
270extern void osd_req_op_extent_init(struct ceph_osd_request *osd_req,
271 unsigned int which, u16 opcode,
33803f33
AE
272 u64 offset, u64 length,
273 u64 truncate_size, u32 truncate_seq);
c99d2d4a
AE
274extern void osd_req_op_extent_update(struct ceph_osd_request *osd_req,
275 unsigned int which, u64 length);
2c63f49a
YZ
276extern void osd_req_op_extent_dup_last(struct ceph_osd_request *osd_req,
277 unsigned int which, u64 offset_inc);
a4ce40a9
AE
278
279extern struct ceph_osd_data *osd_req_op_extent_osd_data(
280 struct ceph_osd_request *osd_req,
406e2c9f 281 unsigned int which);
a4ce40a9
AE
282
283extern void osd_req_op_extent_osd_data_pages(struct ceph_osd_request *,
406e2c9f 284 unsigned int which,
a4ce40a9
AE
285 struct page **pages, u64 length,
286 u32 alignment, bool pages_from_pool,
287 bool own_pages);
288extern void osd_req_op_extent_osd_data_pagelist(struct ceph_osd_request *,
406e2c9f 289 unsigned int which,
a4ce40a9
AE
290 struct ceph_pagelist *pagelist);
291#ifdef CONFIG_BLOCK
292extern void osd_req_op_extent_osd_data_bio(struct ceph_osd_request *,
406e2c9f 293 unsigned int which,
a4ce40a9
AE
294 struct bio *bio, size_t bio_length);
295#endif /* CONFIG_BLOCK */
296
04017e29
AE
297extern void osd_req_op_cls_request_data_pagelist(struct ceph_osd_request *,
298 unsigned int which,
299 struct ceph_pagelist *pagelist);
6c57b554
AE
300extern void osd_req_op_cls_request_data_pages(struct ceph_osd_request *,
301 unsigned int which,
302 struct page **pages, u64 length,
303 u32 alignment, bool pages_from_pool,
304 bool own_pages);
a4ce40a9 305extern void osd_req_op_cls_response_data_pages(struct ceph_osd_request *,
c99d2d4a 306 unsigned int which,
a4ce40a9
AE
307 struct page **pages, u64 length,
308 u32 alignment, bool pages_from_pool,
309 bool own_pages);
310
c99d2d4a
AE
311extern void osd_req_op_cls_init(struct ceph_osd_request *osd_req,
312 unsigned int which, u16 opcode,
04017e29 313 const char *class, const char *method);
d74b50be
YZ
314extern int osd_req_op_xattr_init(struct ceph_osd_request *osd_req, unsigned int which,
315 u16 opcode, const char *name, const void *value,
316 size_t size, u8 cmp_op, u8 cmp_mode);
c99d2d4a
AE
317extern void osd_req_op_watch_init(struct ceph_osd_request *osd_req,
318 unsigned int which, u16 opcode,
33803f33 319 u64 cookie, u64 version, int flag);
c647b8a8
ID
320extern void osd_req_op_alloc_hint_init(struct ceph_osd_request *osd_req,
321 unsigned int which,
322 u64 expected_object_size,
323 u64 expected_write_size);
33803f33 324
3499e8a5 325extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
3499e8a5 326 struct ceph_snap_context *snapc,
acead002 327 unsigned int num_ops,
3499e8a5 328 bool use_mempool,
54a54007 329 gfp_t gfp_flags);
13d1ad16 330int ceph_osdc_alloc_messages(struct ceph_osd_request *req, gfp_t gfp);
3499e8a5 331
f24e9980
SW
332extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
333 struct ceph_file_layout *layout,
334 struct ceph_vino vino,
acead002 335 u64 offset, u64 *len,
715e4cd4
YZ
336 unsigned int which, int num_ops,
337 int opcode, int flags,
f24e9980 338 struct ceph_snap_context *snapc,
acead002 339 u32 truncate_seq, u64 truncate_size,
153e5167 340 bool use_mempool);
f24e9980 341
a40c4f10
YS
342extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
343 struct ceph_osd_request *req);
a40c4f10 344
9e94af20
ID
345extern void ceph_osdc_get_request(struct ceph_osd_request *req);
346extern void ceph_osdc_put_request(struct ceph_osd_request *req);
f24e9980
SW
347
348extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
349 struct ceph_osd_request *req,
350 bool nofail);
c9f9b93d 351extern void ceph_osdc_cancel_request(struct ceph_osd_request *req);
f24e9980
SW
352extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
353 struct ceph_osd_request *req);
354extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
355
dd935f44
JD
356extern void ceph_osdc_flush_notifies(struct ceph_osd_client *osdc);
357
f24e9980
SW
358extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
359 struct ceph_vino vino,
360 struct ceph_file_layout *layout,
361 u64 off, u64 *plen,
362 u32 truncate_seq, u64 truncate_size,
b7495fc2
SW
363 struct page **pages, int nr_pages,
364 int page_align);
f24e9980
SW
365
366extern 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,
370 u64 off, u64 len,
371 u32 truncate_seq, u64 truncate_size,
372 struct timespec *mtime,
24808826 373 struct page **pages, int nr_pages);
f24e9980 374
a40c4f10
YS
375/* watch/notify events */
376extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
377 void (*event_cb)(u64, u64, u8, void *),
3c663bbd 378 void *data, struct ceph_osd_event **pevent);
a40c4f10 379extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
a40c4f10 380extern void ceph_osdc_put_event(struct ceph_osd_event *event);
f24e9980
SW
381#endif
382