Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef __FS_CEPH_MESSENGER_H
3#define __FS_CEPH_MESSENGER_H
4
5#include <linux/bvec.h>
6#include <linux/kref.h>
7#include <linux/mutex.h>
8#include <linux/net.h>
9#include <linux/radix-tree.h>
10#include <linux/uio.h>
11#include <linux/workqueue.h>
12#include <net/net_namespace.h>
13
14#include <linux/ceph/types.h>
15#include <linux/ceph/buffer.h>
16
17struct ceph_msg;
18struct ceph_connection;
19
20/*
21 * Ceph defines these callbacks for handling connection events.
22 */
23struct ceph_connection_operations {
24 struct ceph_connection *(*get)(struct ceph_connection *);
25 void (*put)(struct ceph_connection *);
26
27 /* handle an incoming message. */
28 void (*dispatch) (struct ceph_connection *con, struct ceph_msg *m);
29
30 /* authorize an outgoing connection */
31 struct ceph_auth_handshake *(*get_authorizer) (
32 struct ceph_connection *con,
33 int *proto, int force_new);
34 int (*verify_authorizer_reply) (struct ceph_connection *con);
35 int (*invalidate_authorizer)(struct ceph_connection *con);
36
37 /* there was some error on the socket (disconnect, whatever) */
38 void (*fault) (struct ceph_connection *con);
39
40 /* a remote host as terminated a message exchange session, and messages
41 * we sent (or they tried to send us) may be lost. */
42 void (*peer_reset) (struct ceph_connection *con);
43
44 struct ceph_msg * (*alloc_msg) (struct ceph_connection *con,
45 struct ceph_msg_header *hdr,
46 int *skip);
47
48 void (*reencode_message) (struct ceph_msg *msg);
49
50 int (*sign_message) (struct ceph_msg *msg);
51 int (*check_message_signature) (struct ceph_msg *msg);
52};
53
54/* use format string %s%d */
55#define ENTITY_NAME(n) ceph_entity_type_name((n).type), le64_to_cpu((n).num)
56
57struct ceph_messenger {
58 struct ceph_entity_inst inst; /* my name+address */
59 struct ceph_entity_addr my_enc_addr;
60
61 atomic_t stopping;
62 possible_net_t net;
63
64 /*
65 * the global_seq counts connections i (attempt to) initiate
66 * in order to disambiguate certain connect race conditions.
67 */
68 u32 global_seq;
69 spinlock_t global_seq_lock;
70};
71
72enum ceph_msg_data_type {
73 CEPH_MSG_DATA_NONE, /* message contains no data payload */
74 CEPH_MSG_DATA_PAGES, /* data source/destination is a page array */
75 CEPH_MSG_DATA_PAGELIST, /* data source/destination is a pagelist */
76#ifdef CONFIG_BLOCK
77 CEPH_MSG_DATA_BIO, /* data source/destination is a bio list */
78#endif /* CONFIG_BLOCK */
79};
80
81static __inline__ bool ceph_msg_data_type_valid(enum ceph_msg_data_type type)
82{
83 switch (type) {
84 case CEPH_MSG_DATA_NONE:
85 case CEPH_MSG_DATA_PAGES:
86 case CEPH_MSG_DATA_PAGELIST:
87#ifdef CONFIG_BLOCK
88 case CEPH_MSG_DATA_BIO:
89#endif /* CONFIG_BLOCK */
90 return true;
91 default:
92 return false;
93 }
94}
95
96struct ceph_msg_data {
97 struct list_head links; /* ceph_msg->data */
98 enum ceph_msg_data_type type;
99 union {
100#ifdef CONFIG_BLOCK
101 struct {
102 struct bio *bio;
103 size_t bio_length;
104 };
105#endif /* CONFIG_BLOCK */
106 struct {
107 struct page **pages; /* NOT OWNER. */
108 size_t length; /* total # bytes */
109 unsigned int alignment; /* first page */
110 };
111 struct ceph_pagelist *pagelist;
112 };
113};
114
115struct ceph_msg_data_cursor {
116 size_t total_resid; /* across all data items */
117 struct list_head *data_head; /* = &ceph_msg->data */
118
119 struct ceph_msg_data *data; /* current data item */
120 size_t resid; /* bytes not yet consumed */
121 bool last_piece; /* current is last piece */
122 bool need_crc; /* crc update needed */
123 union {
124#ifdef CONFIG_BLOCK
125 struct { /* bio */
126 struct bio *bio; /* bio from list */
127 struct bvec_iter bvec_iter;
128 };
129#endif /* CONFIG_BLOCK */
130 struct { /* pages */
131 unsigned int page_offset; /* offset in page */
132 unsigned short page_index; /* index in array */
133 unsigned short page_count; /* pages in array */
134 };
135 struct { /* pagelist */
136 struct page *page; /* page from list */
137 size_t offset; /* bytes from list */
138 };
139 };
140};
141
142/*
143 * a single message. it contains a header (src, dest, message type, etc.),
144 * footer (crc values, mainly), a "front" message body, and possibly a
145 * data payload (stored in some number of pages).
146 */
147struct ceph_msg {
148 struct ceph_msg_header hdr; /* header */
149 union {
150 struct ceph_msg_footer footer; /* footer */
151 struct ceph_msg_footer_old old_footer; /* old format footer */
152 };
153 struct kvec front; /* unaligned blobs of message */
154 struct ceph_buffer *middle;
155
156 size_t data_length;
157 struct list_head data;
158 struct ceph_msg_data_cursor cursor;
159
160 struct ceph_connection *con;
161 struct list_head list_head; /* links for connection lists */
162
163 struct kref kref;
164 bool more_to_follow;
165 bool needs_out_seq;
166 int front_alloc_len;
167 unsigned long ack_stamp; /* tx: when we were acked */
168
169 struct ceph_msgpool *pool;
170};
171
172/* ceph connection fault delay defaults, for exponential backoff */
173#define BASE_DELAY_INTERVAL (HZ/2)
174#define MAX_DELAY_INTERVAL (5 * 60 * HZ)
175
176/*
177 * A single connection with another host.
178 *
179 * We maintain a queue of outgoing messages, and some session state to
180 * ensure that we can preserve the lossless, ordered delivery of
181 * messages in the case of a TCP disconnect.
182 */
183struct ceph_connection {
184 void *private;
185
186 const struct ceph_connection_operations *ops;
187
188 struct ceph_messenger *msgr;
189
190 atomic_t sock_state;
191 struct socket *sock;
192 struct ceph_entity_addr peer_addr; /* peer address */
193 struct ceph_entity_addr peer_addr_for_me;
194
195 unsigned long flags;
196 unsigned long state;
197 const char *error_msg; /* error message, if any */
198
199 struct ceph_entity_name peer_name; /* peer name */
200
201 u64 peer_features;
202 u32 connect_seq; /* identify the most recent connection
203 attempt for this connection, client */
204 u32 peer_global_seq; /* peer's global seq for this connection */
205
206 int auth_retry; /* true if we need a newer authorizer */
207 void *auth_reply_buf; /* where to put the authorizer reply */
208 int auth_reply_buf_len;
209
210 struct mutex mutex;
211
212 /* out queue */
213 struct list_head out_queue;
214 struct list_head out_sent; /* sending or sent but unacked */
215 u64 out_seq; /* last message queued for send */
216
217 u64 in_seq, in_seq_acked; /* last message received, acked */
218
219 /* connection negotiation temps */
220 char in_banner[CEPH_BANNER_MAX_LEN];
221 struct ceph_msg_connect out_connect;
222 struct ceph_msg_connect_reply in_reply;
223 struct ceph_entity_addr actual_peer_addr;
224
225 /* message out temps */
226 struct ceph_msg_header out_hdr;
227 struct ceph_msg *out_msg; /* sending message (== tail of
228 out_sent) */
229 bool out_msg_done;
230
231 struct kvec out_kvec[8], /* sending header/footer data */
232 *out_kvec_cur;
233 int out_kvec_left; /* kvec's left in out_kvec */
234 int out_skip; /* skip this many bytes */
235 int out_kvec_bytes; /* total bytes left */
236 int out_more; /* there is more data after the kvecs */
237 __le64 out_temp_ack; /* for writing an ack */
238 struct ceph_timespec out_temp_keepalive2; /* for writing keepalive2
239 stamp */
240
241 /* message in temps */
242 struct ceph_msg_header in_hdr;
243 struct ceph_msg *in_msg;
244 u32 in_front_crc, in_middle_crc, in_data_crc; /* calculated crc */
245
246 char in_tag; /* protocol control byte */
247 int in_base_pos; /* bytes read */
248 __le64 in_temp_ack; /* for reading an ack */
249
250 struct timespec last_keepalive_ack; /* keepalive2 ack stamp */
251
252 struct delayed_work work; /* send|recv work */
253 unsigned long delay; /* current delay interval */
254};
255
256
257extern const char *ceph_pr_addr(const struct sockaddr_storage *ss);
258extern int ceph_parse_ips(const char *c, const char *end,
259 struct ceph_entity_addr *addr,
260 int max_count, int *count);
261
262
263extern int ceph_msgr_init(void);
264extern void ceph_msgr_exit(void);
265extern void ceph_msgr_flush(void);
266
267extern void ceph_messenger_init(struct ceph_messenger *msgr,
268 struct ceph_entity_addr *myaddr);
269extern void ceph_messenger_fini(struct ceph_messenger *msgr);
270
271extern void ceph_con_init(struct ceph_connection *con, void *private,
272 const struct ceph_connection_operations *ops,
273 struct ceph_messenger *msgr);
274extern void ceph_con_open(struct ceph_connection *con,
275 __u8 entity_type, __u64 entity_num,
276 struct ceph_entity_addr *addr);
277extern bool ceph_con_opened(struct ceph_connection *con);
278extern void ceph_con_close(struct ceph_connection *con);
279extern void ceph_con_send(struct ceph_connection *con, struct ceph_msg *msg);
280
281extern void ceph_msg_revoke(struct ceph_msg *msg);
282extern void ceph_msg_revoke_incoming(struct ceph_msg *msg);
283
284extern void ceph_con_keepalive(struct ceph_connection *con);
285extern bool ceph_con_keepalive_expired(struct ceph_connection *con,
286 unsigned long interval);
287
288extern void ceph_msg_data_add_pages(struct ceph_msg *msg, struct page **pages,
289 size_t length, size_t alignment);
290extern void ceph_msg_data_add_pagelist(struct ceph_msg *msg,
291 struct ceph_pagelist *pagelist);
292#ifdef CONFIG_BLOCK
293extern void ceph_msg_data_add_bio(struct ceph_msg *msg, struct bio *bio,
294 size_t length);
295#endif /* CONFIG_BLOCK */
296
297extern struct ceph_msg *ceph_msg_new(int type, int front_len, gfp_t flags,
298 bool can_fail);
299
300extern struct ceph_msg *ceph_msg_get(struct ceph_msg *msg);
301extern void ceph_msg_put(struct ceph_msg *msg);
302
303extern void ceph_msg_dump(struct ceph_msg *msg);
304
305#endif