xref: /linux-6.15/include/linux/ceph/osd_client.h (revision 055d752f)
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 10
52 
53 /* an in-flight request */
54 struct ceph_osd_request {
55 	u64             r_tid;              /* unique for this client */
56 	struct rb_node  r_node;
57 	struct list_head r_req_lru_item;
58 	struct list_head r_osd_item;
59 	struct list_head r_linger_item;
60 	struct list_head r_linger_osd;
61 	struct ceph_osd *r_osd;
62 	struct ceph_pg   r_pgid;
63 	int              r_pg_osds[CEPH_PG_MAX_SIZE];
64 	int              r_num_pg_osds;
65 
66 	struct ceph_connection *r_con_filling_msg;
67 
68 	struct ceph_msg  *r_request, *r_reply;
69 	int               r_flags;     /* any additional flags for the osd */
70 	u32               r_sent;      /* >0 if r_request is sending/sent */
71 	int               r_num_ops;
72 
73 	/* encoded message content */
74 	struct ceph_osd_op *r_request_ops;
75 	/* these are updated on each send */
76 	__le32           *r_request_osdmap_epoch;
77 	__le32           *r_request_flags;
78 	__le64           *r_request_pool;
79 	void             *r_request_pgid;
80 	__le32           *r_request_attempts;
81 	struct ceph_eversion *r_request_reassert_version;
82 
83 	int               r_result;
84 	int               r_reply_op_len[CEPH_OSD_MAX_OP];
85 	s32               r_reply_op_result[CEPH_OSD_MAX_OP];
86 	int               r_got_reply;
87 	int		  r_linger;
88 
89 	struct ceph_osd_client *r_osdc;
90 	struct kref       r_kref;
91 	bool              r_mempool;
92 	struct completion r_completion, r_safe_completion;
93 	ceph_osdc_callback_t r_callback, r_safe_callback;
94 	struct ceph_eversion r_reassert_version;
95 	struct list_head  r_unsafe_item;
96 
97 	struct inode *r_inode;         	      /* for use by callbacks */
98 	void *r_priv;			      /* ditto */
99 
100 	char              r_oid[MAX_OBJ_NAME_SIZE];          /* object name */
101 	int               r_oid_len;
102 	u64               r_snapid;
103 	unsigned long     r_stamp;            /* send OR check time */
104 
105 	struct ceph_file_layout r_file_layout;
106 	struct ceph_snap_context *r_snapc;    /* snap context for writes */
107 	unsigned          r_num_pages;        /* size of page array (follows) */
108 	unsigned          r_page_alignment;   /* io offset in first page */
109 	struct page     **r_pages;            /* pages for data payload */
110 	int               r_pages_from_pool;
111 	int               r_own_pages;        /* if true, i own page list */
112 #ifdef CONFIG_BLOCK
113 	struct bio       *r_bio;	      /* instead of pages */
114 #endif
115 
116 	struct ceph_pagelist r_trail;	      /* trailing part of the data */
117 };
118 
119 struct ceph_osd_event {
120 	u64 cookie;
121 	int one_shot;
122 	struct ceph_osd_client *osdc;
123 	void (*cb)(u64, u64, u8, void *);
124 	void *data;
125 	struct rb_node node;
126 	struct list_head osd_node;
127 	struct kref kref;
128 };
129 
130 struct ceph_osd_event_work {
131 	struct work_struct work;
132 	struct ceph_osd_event *event;
133         u64 ver;
134         u64 notify_id;
135         u8 opcode;
136 };
137 
138 struct ceph_osd_client {
139 	struct ceph_client     *client;
140 
141 	struct ceph_osdmap     *osdmap;       /* current map */
142 	struct rw_semaphore    map_sem;
143 	struct completion      map_waiters;
144 	u64                    last_requested_map;
145 
146 	struct mutex           request_mutex;
147 	struct rb_root         osds;          /* osds */
148 	struct list_head       osd_lru;       /* idle osds */
149 	u64                    timeout_tid;   /* tid of timeout triggering rq */
150 	u64                    last_tid;      /* tid of last request */
151 	struct rb_root         requests;      /* pending requests */
152 	struct list_head       req_lru;	      /* in-flight lru */
153 	struct list_head       req_unsent;    /* unsent/need-resend queue */
154 	struct list_head       req_notarget;  /* map to no osd */
155 	struct list_head       req_linger;    /* lingering requests */
156 	int                    num_requests;
157 	struct delayed_work    timeout_work;
158 	struct delayed_work    osds_timeout_work;
159 #ifdef CONFIG_DEBUG_FS
160 	struct dentry 	       *debugfs_file;
161 #endif
162 
163 	mempool_t              *req_mempool;
164 
165 	struct ceph_msgpool	msgpool_op;
166 	struct ceph_msgpool	msgpool_op_reply;
167 
168 	spinlock_t		event_lock;
169 	struct rb_root		event_tree;
170 	u64			event_count;
171 
172 	struct workqueue_struct	*notify_wq;
173 };
174 
175 struct ceph_osd_req_op {
176 	u16 op;           /* CEPH_OSD_OP_* */
177 	u32 payload_len;
178 	union {
179 		struct {
180 			u64 offset, length;
181 			u64 truncate_size;
182 			u32 truncate_seq;
183 		} extent;
184 		struct {
185 			const char *name;
186 			const char  *val;
187 			u32 name_len;
188 			u32 value_len;
189 			__u8 cmp_op;       /* CEPH_OSD_CMPXATTR_OP_* */
190 			__u8 cmp_mode;     /* CEPH_OSD_CMPXATTR_MODE_* */
191 		} xattr;
192 		struct {
193 			const char *class_name;
194 			const char *method_name;
195 			const char *indata;
196 			u32 indata_len;
197 			__u8 class_len;
198 			__u8 method_len;
199 			__u8 argc;
200 		} cls;
201 		struct {
202 			u64 cookie;
203 			u64 count;
204 		} pgls;
205 	        struct {
206 		        u64 snapid;
207 	        } snap;
208 		struct {
209 			u64 cookie;
210 			u64 ver;
211 			u32 prot_ver;
212 			u32 timeout;
213 			__u8 flag;
214 		} watch;
215 	};
216 };
217 
218 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
219 			  struct ceph_client *client);
220 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
221 
222 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
223 				   struct ceph_msg *msg);
224 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
225 				 struct ceph_msg *msg);
226 
227 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
228 					       struct ceph_snap_context *snapc,
229 					       unsigned int num_op,
230 					       bool use_mempool,
231 					       gfp_t gfp_flags);
232 
233 extern void ceph_osdc_build_request(struct ceph_osd_request *req,
234 				    u64 off, u64 len,
235 				    unsigned int num_op,
236 				    struct ceph_osd_req_op *src_ops,
237 				    struct ceph_snap_context *snapc,
238 				    u64 snap_id,
239 				    struct timespec *mtime);
240 
241 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
242 				      struct ceph_file_layout *layout,
243 				      struct ceph_vino vino,
244 				      u64 offset, u64 *len, int op, int flags,
245 				      struct ceph_snap_context *snapc,
246 				      int do_sync, u32 truncate_seq,
247 				      u64 truncate_size,
248 				      struct timespec *mtime,
249 				      bool use_mempool, int page_align);
250 
251 extern void ceph_osdc_set_request_linger(struct ceph_osd_client *osdc,
252 					 struct ceph_osd_request *req);
253 extern void ceph_osdc_unregister_linger_request(struct ceph_osd_client *osdc,
254 						struct ceph_osd_request *req);
255 
256 static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
257 {
258 	kref_get(&req->r_kref);
259 }
260 extern void ceph_osdc_release_request(struct kref *kref);
261 static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
262 {
263 	kref_put(&req->r_kref, ceph_osdc_release_request);
264 }
265 
266 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
267 				   struct ceph_osd_request *req,
268 				   bool nofail);
269 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
270 				  struct ceph_osd_request *req);
271 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
272 
273 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
274 			       struct ceph_vino vino,
275 			       struct ceph_file_layout *layout,
276 			       u64 off, u64 *plen,
277 			       u32 truncate_seq, u64 truncate_size,
278 			       struct page **pages, int nr_pages,
279 			       int page_align);
280 
281 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
282 				struct ceph_vino vino,
283 				struct ceph_file_layout *layout,
284 				struct ceph_snap_context *sc,
285 				u64 off, u64 len,
286 				u32 truncate_seq, u64 truncate_size,
287 				struct timespec *mtime,
288 				struct page **pages, int nr_pages);
289 
290 /* watch/notify events */
291 extern int ceph_osdc_create_event(struct ceph_osd_client *osdc,
292 				  void (*event_cb)(u64, u64, u8, void *),
293 				  void *data, struct ceph_osd_event **pevent);
294 extern void ceph_osdc_cancel_event(struct ceph_osd_event *event);
295 extern void ceph_osdc_put_event(struct ceph_osd_event *event);
296 #endif
297 
298