xref: /linux-6.15/include/linux/ceph/osd_client.h (revision facb4edc)
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 "types.h"
10 #include "osdmap.h"
11 #include "messenger.h"
12 
13 struct ceph_msg;
14 struct ceph_snap_context;
15 struct ceph_osd_request;
16 struct ceph_osd_client;
17 struct ceph_authorizer;
18 struct ceph_pagelist;
19 
20 /*
21  * completion callback for async writepages
22  */
23 typedef void (*ceph_osdc_callback_t)(struct ceph_osd_request *,
24 				     struct ceph_msg *);
25 
26 /* a given osd we're communicating with */
27 struct ceph_osd {
28 	atomic_t o_ref;
29 	struct ceph_osd_client *o_osdc;
30 	int o_osd;
31 	int o_incarnation;
32 	struct rb_node o_node;
33 	struct ceph_connection o_con;
34 	struct list_head o_requests;
35 	struct list_head o_osd_lru;
36 	struct ceph_authorizer *o_authorizer;
37 	void *o_authorizer_buf, *o_authorizer_reply_buf;
38 	size_t o_authorizer_buf_len, o_authorizer_reply_buf_len;
39 	unsigned long lru_ttl;
40 	int o_marked_for_keepalive;
41 	struct list_head o_keepalive_item;
42 };
43 
44 /* an in-flight request */
45 struct ceph_osd_request {
46 	u64             r_tid;              /* unique for this client */
47 	struct rb_node  r_node;
48 	struct list_head r_req_lru_item;
49 	struct list_head r_osd_item;
50 	struct ceph_osd *r_osd;
51 	struct ceph_pg   r_pgid;
52 	int              r_pg_osds[CEPH_PG_MAX_SIZE];
53 	int              r_num_pg_osds;
54 
55 	struct ceph_connection *r_con_filling_msg;
56 
57 	struct ceph_msg  *r_request, *r_reply;
58 	int               r_result;
59 	int               r_flags;     /* any additional flags for the osd */
60 	u32               r_sent;      /* >0 if r_request is sending/sent */
61 	int               r_got_reply;
62 
63 	struct ceph_osd_client *r_osdc;
64 	struct kref       r_kref;
65 	bool              r_mempool;
66 	struct completion r_completion, r_safe_completion;
67 	ceph_osdc_callback_t r_callback, r_safe_callback;
68 	struct ceph_eversion r_reassert_version;
69 	struct list_head  r_unsafe_item;
70 
71 	struct inode *r_inode;         	      /* for use by callbacks */
72 	void *r_priv;			      /* ditto */
73 
74 	char              r_oid[40];          /* object name */
75 	int               r_oid_len;
76 	unsigned long     r_stamp;            /* send OR check time */
77 	bool              r_resend;           /* msg send failed, needs retry */
78 
79 	struct ceph_file_layout r_file_layout;
80 	struct ceph_snap_context *r_snapc;    /* snap context for writes */
81 	unsigned          r_num_pages;        /* size of page array (follows) */
82 	unsigned          r_page_alignment;   /* io offset in first page */
83 	struct page     **r_pages;            /* pages for data payload */
84 	int               r_pages_from_pool;
85 	int               r_own_pages;        /* if true, i own page list */
86 #ifdef CONFIG_BLOCK
87 	struct bio       *r_bio;	      /* instead of pages */
88 #endif
89 
90 	struct ceph_pagelist *r_trail;	      /* trailing part of the data */
91 };
92 
93 struct ceph_osd_client {
94 	struct ceph_client     *client;
95 
96 	struct ceph_osdmap     *osdmap;       /* current map */
97 	struct rw_semaphore    map_sem;
98 	struct completion      map_waiters;
99 	u64                    last_requested_map;
100 
101 	struct mutex           request_mutex;
102 	struct rb_root         osds;          /* osds */
103 	struct list_head       osd_lru;       /* idle osds */
104 	u64                    timeout_tid;   /* tid of timeout triggering rq */
105 	u64                    last_tid;      /* tid of last request */
106 	struct rb_root         requests;      /* pending requests */
107 	struct list_head       req_lru;	      /* pending requests lru */
108 	int                    num_requests;
109 	struct delayed_work    timeout_work;
110 	struct delayed_work    osds_timeout_work;
111 #ifdef CONFIG_DEBUG_FS
112 	struct dentry 	       *debugfs_file;
113 #endif
114 
115 	mempool_t              *req_mempool;
116 
117 	struct ceph_msgpool	msgpool_op;
118 	struct ceph_msgpool	msgpool_op_reply;
119 };
120 
121 struct ceph_osd_req_op {
122 	u16 op;           /* CEPH_OSD_OP_* */
123 	u32 flags;        /* CEPH_OSD_FLAG_* */
124 	union {
125 		struct {
126 			u64 offset, length;
127 			u64 truncate_size;
128 			u32 truncate_seq;
129 		} extent;
130 		struct {
131 			const char *name;
132 			u32 name_len;
133 			const char  *val;
134 			u32 value_len;
135 			__u8 cmp_op;       /* CEPH_OSD_CMPXATTR_OP_* */
136 			__u8 cmp_mode;     /* CEPH_OSD_CMPXATTR_MODE_* */
137 		} xattr;
138 		struct {
139 			const char *class_name;
140 			__u8 class_len;
141 			const char *method_name;
142 			__u8 method_len;
143 			__u8 argc;
144 			const char *indata;
145 			u32 indata_len;
146 		} cls;
147 		struct {
148 			u64 cookie, count;
149 		} pgls;
150 	        struct {
151 		        u64 snapid;
152 	        } snap;
153 	};
154 	u32 payload_len;
155 };
156 
157 extern int ceph_osdc_init(struct ceph_osd_client *osdc,
158 			  struct ceph_client *client);
159 extern void ceph_osdc_stop(struct ceph_osd_client *osdc);
160 
161 extern void ceph_osdc_handle_reply(struct ceph_osd_client *osdc,
162 				   struct ceph_msg *msg);
163 extern void ceph_osdc_handle_map(struct ceph_osd_client *osdc,
164 				 struct ceph_msg *msg);
165 
166 extern void ceph_calc_raw_layout(struct ceph_osd_client *osdc,
167 			struct ceph_file_layout *layout,
168 			u64 snapid,
169 			u64 off, u64 *plen, u64 *bno,
170 			struct ceph_osd_request *req,
171 			struct ceph_osd_req_op *op);
172 
173 extern struct ceph_osd_request *ceph_osdc_alloc_request(struct ceph_osd_client *osdc,
174 					       int flags,
175 					       struct ceph_snap_context *snapc,
176 					       struct ceph_osd_req_op *ops,
177 					       bool use_mempool,
178 					       gfp_t gfp_flags,
179 					       struct page **pages,
180 					       struct bio *bio);
181 
182 extern void ceph_osdc_build_request(struct ceph_osd_request *req,
183 				    u64 off, u64 *plen,
184 				    struct ceph_osd_req_op *src_ops,
185 				    struct ceph_snap_context *snapc,
186 				    struct timespec *mtime,
187 				    const char *oid,
188 				    int oid_len);
189 
190 extern struct ceph_osd_request *ceph_osdc_new_request(struct ceph_osd_client *,
191 				      struct ceph_file_layout *layout,
192 				      struct ceph_vino vino,
193 				      u64 offset, u64 *len, int op, int flags,
194 				      struct ceph_snap_context *snapc,
195 				      int do_sync, u32 truncate_seq,
196 				      u64 truncate_size,
197 				      struct timespec *mtime,
198 				      bool use_mempool, int num_reply,
199 				      int page_align);
200 
201 static inline void ceph_osdc_get_request(struct ceph_osd_request *req)
202 {
203 	kref_get(&req->r_kref);
204 }
205 extern void ceph_osdc_release_request(struct kref *kref);
206 static inline void ceph_osdc_put_request(struct ceph_osd_request *req)
207 {
208 	kref_put(&req->r_kref, ceph_osdc_release_request);
209 }
210 
211 extern int ceph_osdc_start_request(struct ceph_osd_client *osdc,
212 				   struct ceph_osd_request *req,
213 				   bool nofail);
214 extern int ceph_osdc_wait_request(struct ceph_osd_client *osdc,
215 				  struct ceph_osd_request *req);
216 extern void ceph_osdc_sync(struct ceph_osd_client *osdc);
217 
218 extern int ceph_osdc_readpages(struct ceph_osd_client *osdc,
219 			       struct ceph_vino vino,
220 			       struct ceph_file_layout *layout,
221 			       u64 off, u64 *plen,
222 			       u32 truncate_seq, u64 truncate_size,
223 			       struct page **pages, int nr_pages,
224 			       int page_align);
225 
226 extern int ceph_osdc_writepages(struct ceph_osd_client *osdc,
227 				struct ceph_vino vino,
228 				struct ceph_file_layout *layout,
229 				struct ceph_snap_context *sc,
230 				u64 off, u64 len,
231 				u32 truncate_seq, u64 truncate_size,
232 				struct timespec *mtime,
233 				struct page **pages, int nr_pages,
234 				int flags, int do_sync, bool nofail);
235 
236 #endif
237 
238