xref: /linux-6.15/include/linux/ceph/osd_client.h (revision bb66fc67)
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 struct ceph_authorizer;
20 
21 /*
22  * completion callback for async writepages
23  */
24 typedef void (*ceph_osdc_callback_t)(struct ceph_osd_request *,
25 				     struct ceph_msg *);
26 typedef void (*ceph_osdc_unsafe_callback_t)(struct ceph_osd_request *, bool);
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 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;
43 };
44 
45 
46 #define CEPH_OSD_MAX_OP	3
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 payload_len;
81 	union {
82 		struct ceph_osd_data raw_data_in;
83 		struct {
84 			u64 offset, length;
85 			u64 truncate_size;
86 			u32 truncate_seq;
87 			struct ceph_osd_data osd_data;
88 		} extent;
89 		struct {
90 			const char *class_name;
91 			const char *method_name;
92 			struct ceph_osd_data request_info;
93 			struct ceph_osd_data request_data;
94 			struct ceph_osd_data response_data;
95 			__u8 class_len;
96 			__u8 method_len;
97 			__u8 argc;
98 		} cls;
99 		struct {
100 			u64 cookie;
101 			u64 ver;
102 			u32 prot_ver;
103 			u32 timeout;
104 			__u8 flag;
105 		} watch;
106 		struct {
107 			u64 expected_object_size;
108 			u64 expected_write_size;
109 		} alloc_hint;
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 	bool              r_paused;
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 
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;
154 	ceph_osdc_unsafe_callback_t r_unsafe_callback;
155 	struct ceph_eversion r_reassert_version;
156 	struct list_head  r_unsafe_item;
157 
158 	struct inode *r_inode;         	      /* for use by callbacks */
159 	void *r_priv;			      /* ditto */
160 
161 	struct ceph_object_locator r_base_oloc;
162 	struct ceph_object_id r_base_oid;
163 	struct ceph_object_locator r_target_oloc;
164 	struct ceph_object_id r_target_oid;
165 
166 	u64               r_snapid;
167 	unsigned long     r_stamp;            /* send OR check time */
168 
169 	struct ceph_snap_context *r_snapc;    /* snap context for writes */
170 };
171 
172 struct ceph_request_redirect {
173 	struct ceph_object_locator oloc;
174 };
175 
176 struct ceph_osd_event {
177 	u64 cookie;
178 	int one_shot;
179 	struct ceph_osd_client *osdc;
180 	void (*cb)(u64, u64, u8, void *);
181 	void *data;
182 	struct rb_node node;
183 	struct list_head osd_node;
184 	struct kref kref;
185 };
186 
187 struct ceph_osd_event_work {
188 	struct work_struct work;
189 	struct ceph_osd_event *event;
190         u64 ver;
191         u64 notify_id;
192         u8 opcode;
193 };
194 
195 struct ceph_osd_client {
196 	struct ceph_client     *client;
197 
198 	struct ceph_osdmap     *osdmap;       /* current map */
199 	struct rw_semaphore    map_sem;
200 	struct completion      map_waiters;
201 	u64                    last_requested_map;
202 
203 	struct mutex           request_mutex;
204 	struct rb_root         osds;          /* osds */
205 	struct list_head       osd_lru;       /* idle osds */
206 	u64                    timeout_tid;   /* tid of timeout triggering rq */
207 	u64                    last_tid;      /* tid of last request */
208 	struct rb_root         requests;      /* pending requests */
209 	struct list_head       req_lru;	      /* in-flight lru */
210 	struct list_head       req_unsent;    /* unsent/need-resend queue */
211 	struct list_head       req_notarget;  /* map to no osd */
212 	struct list_head       req_linger;    /* lingering requests */
213 	int                    num_requests;
214 	struct delayed_work    timeout_work;
215 	struct delayed_work    osds_timeout_work;
216 #ifdef CONFIG_DEBUG_FS
217 	struct dentry 	       *debugfs_file;
218 #endif
219 
220 	mempool_t              *req_mempool;
221 
222 	struct ceph_msgpool	msgpool_op;
223 	struct ceph_msgpool	msgpool_op_reply;
224 
225 	spinlock_t		event_lock;
226 	struct rb_root		event_tree;
227 	u64			event_count;
228 
229 	struct workqueue_struct	*notify_wq;
230 };
231 
232 extern int ceph_osdc_setup(void);
233 extern void ceph_osdc_cleanup(void);
234 
235 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
236 			  struct ceph_client *client);
237 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
238 
239 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
240 				   struct ceph_msg *msg);
241 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
242 				 struct ceph_msg *msg);
243 
244 extern void osd_req_op_init(struct ceph_osd_request *osd_req,
245 					unsigned int which, u16 opcode);
246 
247 extern void osd_req_op_raw_data_in_pages(struct ceph_osd_request *,
248 					unsigned int which,
249 					struct page **pages, u64 length,
250 					u32 alignment, bool pages_from_pool,
251 					bool own_pages);
252 
253 extern void osd_req_op_extent_init(struct ceph_osd_request *osd_req,
254 					unsigned int which, u16 opcode,
255 					u64 offset, u64 length,
256 					u64 truncate_size, u32 truncate_seq);
257 extern void osd_req_op_extent_update(struct ceph_osd_request *osd_req,
258 					unsigned int which, u64 length);
259 
260 extern struct ceph_osd_data *osd_req_op_extent_osd_data(
261 					struct ceph_osd_request *osd_req,
262 					unsigned int which);
263 extern struct ceph_osd_data *osd_req_op_cls_response_data(
264 					struct ceph_osd_request *osd_req,
265 					unsigned int which);
266 
267 extern void osd_req_op_extent_osd_data_pages(struct ceph_osd_request *,
268 					unsigned int which,
269 					struct page **pages, u64 length,
270 					u32 alignment, bool pages_from_pool,
271 					bool own_pages);
272 extern void osd_req_op_extent_osd_data_pagelist(struct ceph_osd_request *,
273 					unsigned int which,
274 					struct ceph_pagelist *pagelist);
275 #ifdef CONFIG_BLOCK
276 extern void osd_req_op_extent_osd_data_bio(struct ceph_osd_request *,
277 					unsigned int which,
278 					struct bio *bio, size_t bio_length);
279 #endif /* CONFIG_BLOCK */
280 
281 extern void osd_req_op_cls_request_data_pagelist(struct ceph_osd_request *,
282 					unsigned int which,
283 					struct ceph_pagelist *pagelist);
284 extern void osd_req_op_cls_request_data_pages(struct ceph_osd_request *,
285 					unsigned int which,
286 					struct page **pages, u64 length,
287 					u32 alignment, bool pages_from_pool,
288 					bool own_pages);
289 extern void osd_req_op_cls_response_data_pages(struct ceph_osd_request *,
290 					unsigned int which,
291 					struct page **pages, u64 length,
292 					u32 alignment, bool pages_from_pool,
293 					bool own_pages);
294 
295 extern void osd_req_op_cls_init(struct ceph_osd_request *osd_req,
296 					unsigned int which, u16 opcode,
297 					const char *class, const char *method);
298 extern void osd_req_op_watch_init(struct ceph_osd_request *osd_req,
299 					unsigned int which, u16 opcode,
300 					u64 cookie, u64 version, int flag);
301 extern void osd_req_op_alloc_hint_init(struct ceph_osd_request *osd_req,
302 				       unsigned int which,
303 				       u64 expected_object_size,
304 				       u64 expected_write_size);
305 
306 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
307 					       struct ceph_snap_context *snapc,
308 					       unsigned int num_ops,
309 					       bool use_mempool,
310 					       gfp_t gfp_flags);
311 
312 extern void ceph_osdc_build_request(struct ceph_osd_request *req, u64 off,
313 				    struct ceph_snap_context *snapc,
314 				    u64 snap_id,
315 				    struct timespec *mtime);
316 
317 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
318 				      struct ceph_file_layout *layout,
319 				      struct ceph_vino vino,
320 				      u64 offset, u64 *len,
321 				      int num_ops, int opcode, int flags,
322 				      struct ceph_snap_context *snapc,
323 				      u32 truncate_seq, u64 truncate_size,
324 				      bool use_mempool);
325 
326 extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
327 					 struct ceph_osd_request *req);
328 extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
329 						struct ceph_osd_request *req);
330 
331 static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
332 {
333 	kref_get(&req->r_kref);
334 }
335 extern void ceph_osdc_release_request(struct kref *kref);
336 static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
337 {
338 	kref_put(&req->r_kref, ceph_osdc_release_request);
339 }
340 
341 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
342 				   struct ceph_osd_request *req,
343 				   bool nofail);
344 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
345 				  struct ceph_osd_request *req);
346 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
347 
348 extern void ceph_osdc_flush_notifies(struct ceph_osd_client *osdc);
349 
350 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
351 			       struct ceph_vino vino,
352 			       struct ceph_file_layout *layout,
353 			       u64 off, u64 *plen,
354 			       u32 truncate_seq, u64 truncate_size,
355 			       struct page **pages, int nr_pages,
356 			       int page_align);
357 
358 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
359 				struct ceph_vino vino,
360 				struct ceph_file_layout *layout,
361 				struct ceph_snap_context *sc,
362 				u64 off, u64 len,
363 				u32 truncate_seq, u64 truncate_size,
364 				struct timespec *mtime,
365 				struct page **pages, int nr_pages);
366 
367 /* watch/notify events */
368 extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
369 				  void (*event_cb)(u64, u64, u8, void *),
370 				  void *data, struct ceph_osd_event **pevent);
371 extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
372 extern void ceph_osdc_put_event(struct ceph_osd_event *event);
373 #endif
374 
375