xref: /linux-6.15/include/linux/ceph/osd_client.h (revision e9c0d44f)
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 struct ceph_msg;
16 struct ceph_snap_context;
17 struct ceph_osd_request;
18 struct ceph_osd_client;
19 
20 /*
21  * completion callback for async writepages
22  */
23 typedef void (*ceph_osdc_callback_t)(struct ceph_osd_request *);
24 typedef void (*ceph_osdc_unsafe_callback_t)(struct ceph_osd_request *, bool);
25 
26 #define CEPH_HOMELESS_OSD	-1
27 
28 /* a given osd we're communicating with */
29 struct 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;
36 	struct rb_root o_requests;
37 	struct rb_root o_linger_requests;
38 	struct list_head o_osd_lru;
39 	struct ceph_auth_handshake o_auth;
40 	unsigned long lru_ttl;
41 	struct list_head o_keepalive_item;
42 	struct mutex lock;
43 };
44 
45 #define CEPH_OSD_SLAB_OPS	2
46 #define CEPH_OSD_MAX_OPS	16
47 
48 enum ceph_osd_data_type {
49 	CEPH_OSD_DATA_TYPE_NONE = 0,
50 	CEPH_OSD_DATA_TYPE_PAGES,
51 	CEPH_OSD_DATA_TYPE_PAGELIST,
52 #ifdef CONFIG_BLOCK
53 	CEPH_OSD_DATA_TYPE_BIO,
54 #endif /* CONFIG_BLOCK */
55 };
56 
57 struct ceph_osd_data {
58 	enum ceph_osd_data_type	type;
59 	union {
60 		struct {
61 			struct page	**pages;
62 			u64		length;
63 			u32		alignment;
64 			bool		pages_from_pool;
65 			bool		own_pages;
66 		};
67 		struct ceph_pagelist	*pagelist;
68 #ifdef CONFIG_BLOCK
69 		struct {
70 			struct bio	*bio;		/* list of bios */
71 			size_t		bio_length;	/* total in list */
72 		};
73 #endif /* CONFIG_BLOCK */
74 	};
75 };
76 
77 struct ceph_osd_req_op {
78 	u16 op;           /* CEPH_OSD_OP_* */
79 	u32 flags;        /* CEPH_OSD_OP_FLAG_* */
80 	u32 indata_len;   /* request */
81 	u32 outdata_len;  /* reply */
82 	s32 rval;
83 
84 	union {
85 		struct ceph_osd_data raw_data_in;
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 			u32 name_len;
94 			u32 value_len;
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;
99 		struct {
100 			const char *class_name;
101 			const char *method_name;
102 			struct ceph_osd_data request_info;
103 			struct ceph_osd_data request_data;
104 			struct ceph_osd_data response_data;
105 			__u8 class_len;
106 			__u8 method_len;
107 			u32 indata_len;
108 		} cls;
109 		struct {
110 			u64 cookie;
111 			__u8 op;           /* CEPH_OSD_WATCH_OP_ */
112 			u32 gen;
113 		} watch;
114 		struct {
115 			struct ceph_osd_data request_data;
116 		} notify_ack;
117 		struct {
118 			u64 cookie;
119 			struct ceph_osd_data request_data;
120 			struct ceph_osd_data response_data;
121 		} notify;
122 		struct {
123 			u64 expected_object_size;
124 			u64 expected_write_size;
125 		} alloc_hint;
126 	};
127 };
128 
129 struct ceph_osd_request_target {
130 	struct ceph_object_id base_oid;
131 	struct ceph_object_locator base_oloc;
132 	struct ceph_object_id target_oid;
133 	struct ceph_object_locator target_oloc;
134 
135 	struct ceph_pg pgid;
136 	u32 pg_num;
137 	u32 pg_num_mask;
138 	struct ceph_osds acting;
139 	struct ceph_osds up;
140 	int size;
141 	int min_size;
142 	bool sort_bitwise;
143 
144 	unsigned int flags;                /* CEPH_OSD_FLAG_* */
145 	bool paused;
146 
147 	int osd;
148 };
149 
150 /* an in-flight request */
151 struct ceph_osd_request {
152 	u64             r_tid;              /* unique for this client */
153 	struct rb_node  r_node;
154 	struct rb_node  r_mc_node;          /* map check */
155 	struct ceph_osd *r_osd;
156 
157 	struct ceph_osd_request_target r_t;
158 #define r_base_oid	r_t.base_oid
159 #define r_base_oloc	r_t.base_oloc
160 #define r_flags		r_t.flags
161 
162 	struct ceph_msg  *r_request, *r_reply;
163 	u32               r_sent;      /* >0 if r_request is sending/sent */
164 
165 	/* request osd ops array  */
166 	unsigned int		r_num_ops;
167 
168 	int               r_result;
169 	bool              r_got_reply;
170 
171 	struct ceph_osd_client *r_osdc;
172 	struct kref       r_kref;
173 	bool              r_mempool;
174 	struct completion r_completion;
175 	struct completion r_safe_completion;  /* fsync waiter */
176 	ceph_osdc_callback_t r_callback;
177 	ceph_osdc_unsafe_callback_t r_unsafe_callback;
178 	struct list_head  r_unsafe_item;
179 
180 	struct inode *r_inode;         	      /* for use by callbacks */
181 	void *r_priv;			      /* ditto */
182 
183 	/* set by submitter */
184 	u64 r_snapid;                         /* for reads, CEPH_NOSNAP o/w */
185 	struct ceph_snap_context *r_snapc;    /* for writes */
186 	struct timespec r_mtime;              /* ditto */
187 	u64 r_data_offset;                    /* ditto */
188 	bool r_linger;                        /* don't resend on failure */
189 
190 	/* internal */
191 	unsigned long r_stamp;                /* jiffies, send or check time */
192 	int r_attempts;
193 	struct ceph_eversion r_replay_version; /* aka reassert_version */
194 	u32 r_last_force_resend;
195 	u32 r_map_dne_bound;
196 
197 	struct ceph_osd_req_op r_ops[];
198 };
199 
200 struct ceph_request_redirect {
201 	struct ceph_object_locator oloc;
202 };
203 
204 typedef void (*rados_watchcb2_t)(void *arg, u64 notify_id, u64 cookie,
205 				 u64 notifier_id, void *data, size_t data_len);
206 typedef void (*rados_watcherrcb_t)(void *arg, u64 cookie, int err);
207 
208 struct ceph_osd_linger_request {
209 	struct ceph_osd_client *osdc;
210 	u64 linger_id;
211 	bool committed;
212 	bool is_watch;                  /* watch or notify */
213 
214 	struct ceph_osd *osd;
215 	struct ceph_osd_request *reg_req;
216 	struct ceph_osd_request *ping_req;
217 	unsigned long ping_sent;
218 	unsigned long watch_valid_thru;
219 	struct list_head pending_lworks;
220 
221 	struct ceph_osd_request_target t;
222 	u32 last_force_resend;
223 	u32 map_dne_bound;
224 
225 	struct timespec mtime;
226 
227 	struct kref kref;
228 	struct mutex lock;
229 	struct rb_node node;            /* osd */
230 	struct rb_node osdc_node;       /* osdc */
231 	struct rb_node mc_node;         /* map check */
232 	struct list_head scan_item;
233 
234 	struct completion reg_commit_wait;
235 	struct completion notify_finish_wait;
236 	int reg_commit_error;
237 	int notify_finish_error;
238 	int last_error;
239 
240 	u32 register_gen;
241 	u64 notify_id;
242 
243 	rados_watchcb2_t wcb;
244 	rados_watcherrcb_t errcb;
245 	void *data;
246 
247 	struct page ***preply_pages;
248 	size_t *preply_len;
249 };
250 
251 struct ceph_osd_client {
252 	struct ceph_client     *client;
253 
254 	struct ceph_osdmap     *osdmap;       /* current map */
255 	struct rw_semaphore    lock;
256 
257 	struct rb_root         osds;          /* osds */
258 	struct list_head       osd_lru;       /* idle osds */
259 	spinlock_t             osd_lru_lock;
260 	struct ceph_osd        homeless_osd;
261 	atomic64_t             last_tid;      /* tid of last request */
262 	u64                    last_linger_id;
263 	struct rb_root         linger_requests; /* lingering requests */
264 	struct rb_root         map_checks;
265 	struct rb_root         linger_map_checks;
266 	atomic_t               num_requests;
267 	atomic_t               num_homeless;
268 	struct delayed_work    timeout_work;
269 	struct delayed_work    osds_timeout_work;
270 #ifdef CONFIG_DEBUG_FS
271 	struct dentry 	       *debugfs_file;
272 #endif
273 
274 	mempool_t              *req_mempool;
275 
276 	struct ceph_msgpool	msgpool_op;
277 	struct ceph_msgpool	msgpool_op_reply;
278 
279 	struct workqueue_struct	*notify_wq;
280 };
281 
282 extern int ceph_osdc_setup(void);
283 extern void ceph_osdc_cleanup(void);
284 
285 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
286 			  struct ceph_client *client);
287 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
288 
289 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
290 				   struct ceph_msg *msg);
291 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
292 				 struct ceph_msg *msg);
293 
294 extern void osd_req_op_init(struct ceph_osd_request *osd_req,
295 			    unsigned int which, u16 opcode, u32 flags);
296 
297 extern void osd_req_op_raw_data_in_pages(struct ceph_osd_request *,
298 					unsigned int which,
299 					struct page **pages, u64 length,
300 					u32 alignment, bool pages_from_pool,
301 					bool own_pages);
302 
303 extern void osd_req_op_extent_init(struct ceph_osd_request *osd_req,
304 					unsigned int which, u16 opcode,
305 					u64 offset, u64 length,
306 					u64 truncate_size, u32 truncate_seq);
307 extern void osd_req_op_extent_update(struct ceph_osd_request *osd_req,
308 					unsigned int which, u64 length);
309 extern void osd_req_op_extent_dup_last(struct ceph_osd_request *osd_req,
310 				       unsigned int which, u64 offset_inc);
311 
312 extern struct ceph_osd_data *osd_req_op_extent_osd_data(
313 					struct ceph_osd_request *osd_req,
314 					unsigned int which);
315 
316 extern void osd_req_op_extent_osd_data_pages(struct ceph_osd_request *,
317 					unsigned int which,
318 					struct page **pages, u64 length,
319 					u32 alignment, bool pages_from_pool,
320 					bool own_pages);
321 extern void osd_req_op_extent_osd_data_pagelist(struct ceph_osd_request *,
322 					unsigned int which,
323 					struct ceph_pagelist *pagelist);
324 #ifdef CONFIG_BLOCK
325 extern void osd_req_op_extent_osd_data_bio(struct ceph_osd_request *,
326 					unsigned int which,
327 					struct bio *bio, size_t bio_length);
328 #endif /* CONFIG_BLOCK */
329 
330 extern void osd_req_op_cls_request_data_pagelist(struct ceph_osd_request *,
331 					unsigned int which,
332 					struct ceph_pagelist *pagelist);
333 extern void osd_req_op_cls_request_data_pages(struct ceph_osd_request *,
334 					unsigned int which,
335 					struct page **pages, u64 length,
336 					u32 alignment, bool pages_from_pool,
337 					bool own_pages);
338 extern void osd_req_op_cls_response_data_pages(struct ceph_osd_request *,
339 					unsigned int which,
340 					struct page **pages, u64 length,
341 					u32 alignment, bool pages_from_pool,
342 					bool own_pages);
343 
344 extern void osd_req_op_cls_init(struct ceph_osd_request *osd_req,
345 					unsigned int which, u16 opcode,
346 					const char *class, const char *method);
347 extern int osd_req_op_xattr_init(struct ceph_osd_request *osd_req, unsigned int which,
348 				 u16 opcode, const char *name, const void *value,
349 				 size_t size, u8 cmp_op, u8 cmp_mode);
350 extern void osd_req_op_alloc_hint_init(struct ceph_osd_request *osd_req,
351 				       unsigned int which,
352 				       u64 expected_object_size,
353 				       u64 expected_write_size);
354 
355 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
356 					       struct ceph_snap_context *snapc,
357 					       unsigned int num_ops,
358 					       bool use_mempool,
359 					       gfp_t gfp_flags);
360 int ceph_osdc_alloc_messages(struct ceph_osd_request *req, gfp_t gfp);
361 
362 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
363 				      struct ceph_file_layout *layout,
364 				      struct ceph_vino vino,
365 				      u64 offset, u64 *len,
366 				      unsigned int which, int num_ops,
367 				      int opcode, int flags,
368 				      struct ceph_snap_context *snapc,
369 				      u32 truncate_seq, u64 truncate_size,
370 				      bool use_mempool);
371 
372 extern void ceph_osdc_get_request(struct ceph_osd_request *req);
373 extern void ceph_osdc_put_request(struct ceph_osd_request *req);
374 
375 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
376 				   struct ceph_osd_request *req,
377 				   bool nofail);
378 extern void ceph_osdc_cancel_request(struct ceph_osd_request *req);
379 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
380 				  struct ceph_osd_request *req);
381 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
382 
383 extern void ceph_osdc_flush_notifies(struct ceph_osd_client *osdc);
384 void ceph_osdc_maybe_request_map(struct ceph_osd_client *osdc);
385 
386 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
387 			       struct ceph_vino vino,
388 			       struct ceph_file_layout *layout,
389 			       u64 off, u64 *plen,
390 			       u32 truncate_seq, u64 truncate_size,
391 			       struct page **pages, int nr_pages,
392 			       int page_align);
393 
394 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
395 				struct ceph_vino vino,
396 				struct ceph_file_layout *layout,
397 				struct ceph_snap_context *sc,
398 				u64 off, u64 len,
399 				u32 truncate_seq, u64 truncate_size,
400 				struct timespec *mtime,
401 				struct page **pages, int nr_pages);
402 
403 /* watch/notify */
404 struct ceph_osd_linger_request *
405 ceph_osdc_watch(struct ceph_osd_client *osdc,
406 		struct ceph_object_id *oid,
407 		struct ceph_object_locator *oloc,
408 		rados_watchcb2_t wcb,
409 		rados_watcherrcb_t errcb,
410 		void *data);
411 int ceph_osdc_unwatch(struct ceph_osd_client *osdc,
412 		      struct ceph_osd_linger_request *lreq);
413 
414 int ceph_osdc_notify_ack(struct ceph_osd_client *osdc,
415 			 struct ceph_object_id *oid,
416 			 struct ceph_object_locator *oloc,
417 			 u64 notify_id,
418 			 u64 cookie,
419 			 void *payload,
420 			 size_t payload_len);
421 int ceph_osdc_notify(struct ceph_osd_client *osdc,
422 		     struct ceph_object_id *oid,
423 		     struct ceph_object_locator *oloc,
424 		     void *payload,
425 		     size_t payload_len,
426 		     u32 timeout,
427 		     struct page ***preply_pages,
428 		     size_t *preply_len);
429 int ceph_osdc_watch_check(struct ceph_osd_client *osdc,
430 			  struct ceph_osd_linger_request *lreq);
431 #endif
432 
433