1 #ifndef __FS_CEPH_MESSENGER_H
2 #define __FS_CEPH_MESSENGER_H
4 #include <linux/blk_types.h>
5 #include <linux/kref.h>
6 #include <linux/mutex.h>
8 #include <linux/radix-tree.h>
10 #include <linux/workqueue.h>
11 #include <net/net_namespace.h>
13 #include <linux/ceph/types.h>
14 #include <linux/ceph/buffer.h>
17 struct ceph_connection;
20 * Ceph defines these callbacks for handling connection events.
22 struct ceph_connection_operations {
23 struct ceph_connection *(*get)(struct ceph_connection *);
24 void (*put)(struct ceph_connection *);
26 /* handle an incoming message. */
27 void (*dispatch) (struct ceph_connection *con, struct ceph_msg *m);
29 /* authorize an outgoing connection */
30 struct ceph_auth_handshake *(*get_authorizer) (
31 struct ceph_connection *con,
32 int *proto, int force_new);
33 int (*verify_authorizer_reply) (struct ceph_connection *con, int len);
34 int (*invalidate_authorizer)(struct ceph_connection *con);
36 /* there was some error on the socket (disconnect, whatever) */
37 void (*fault) (struct ceph_connection *con);
39 /* a remote host as terminated a message exchange session, and messages
40 * we sent (or they tried to send us) may be lost. */
41 void (*peer_reset) (struct ceph_connection *con);
43 struct ceph_msg * (*alloc_msg) (struct ceph_connection *con,
44 struct ceph_msg_header *hdr,
46 int (*sign_message) (struct ceph_connection *con, struct ceph_msg *msg);
48 int (*check_message_signature) (struct ceph_connection *con,
49 struct ceph_msg *msg);
52 /* use format string %s%d */
53 #define ENTITY_NAME(n) ceph_entity_type_name((n).type), le64_to_cpu((n).num)
55 struct ceph_messenger {
56 struct ceph_entity_inst inst; /* my name+address */
57 struct ceph_entity_addr my_enc_addr;
65 * the global_seq counts connections i (attempt to) initiate
66 * in order to disambiguate certain connect race conditions.
69 spinlock_t global_seq_lock;
71 u64 supported_features;
72 u64 required_features;
75 enum ceph_msg_data_type {
76 CEPH_MSG_DATA_NONE, /* message contains no data payload */
77 CEPH_MSG_DATA_PAGES, /* data source/destination is a page array */
78 CEPH_MSG_DATA_PAGELIST, /* data source/destination is a pagelist */
80 CEPH_MSG_DATA_BIO, /* data source/destination is a bio list */
81 #endif /* CONFIG_BLOCK */
84 static __inline__ bool ceph_msg_data_type_valid(enum ceph_msg_data_type type)
87 case CEPH_MSG_DATA_NONE:
88 case CEPH_MSG_DATA_PAGES:
89 case CEPH_MSG_DATA_PAGELIST:
91 case CEPH_MSG_DATA_BIO:
92 #endif /* CONFIG_BLOCK */
99 struct ceph_msg_data {
100 struct list_head links; /* ceph_msg->data */
101 enum ceph_msg_data_type type;
108 #endif /* CONFIG_BLOCK */
110 struct page **pages; /* NOT OWNER. */
111 size_t length; /* total # bytes */
112 unsigned int alignment; /* first page */
114 struct ceph_pagelist *pagelist;
118 struct ceph_msg_data_cursor {
119 size_t total_resid; /* across all data items */
120 struct list_head *data_head; /* = &ceph_msg->data */
122 struct ceph_msg_data *data; /* current data item */
123 size_t resid; /* bytes not yet consumed */
124 bool last_piece; /* current is last piece */
125 bool need_crc; /* crc update needed */
129 struct bio *bio; /* bio from list */
130 struct bvec_iter bvec_iter;
132 #endif /* CONFIG_BLOCK */
134 unsigned int page_offset; /* offset in page */
135 unsigned short page_index; /* index in array */
136 unsigned short page_count; /* pages in array */
138 struct { /* pagelist */
139 struct page *page; /* page from list */
140 size_t offset; /* bytes from list */
146 * a single message. it contains a header (src, dest, message type, etc.),
147 * footer (crc values, mainly), a "front" message body, and possibly a
148 * data payload (stored in some number of pages).
151 struct ceph_msg_header hdr; /* header */
153 struct ceph_msg_footer footer; /* footer */
154 struct ceph_msg_footer_old old_footer; /* old format footer */
156 struct kvec front; /* unaligned blobs of message */
157 struct ceph_buffer *middle;
160 struct list_head data;
161 struct ceph_msg_data_cursor cursor;
163 struct ceph_connection *con;
164 struct list_head list_head; /* links for connection lists */
170 unsigned long ack_stamp; /* tx: when we were acked */
172 struct ceph_msgpool *pool;
175 /* ceph connection fault delay defaults, for exponential backoff */
176 #define BASE_DELAY_INTERVAL (HZ/2)
177 #define MAX_DELAY_INTERVAL (5 * 60 * HZ)
180 * A single connection with another host.
182 * We maintain a queue of outgoing messages, and some session state to
183 * ensure that we can preserve the lossless, ordered delivery of
184 * messages in the case of a TCP disconnect.
186 struct ceph_connection {
189 const struct ceph_connection_operations *ops;
191 struct ceph_messenger *msgr;
195 struct ceph_entity_addr peer_addr; /* peer address */
196 struct ceph_entity_addr peer_addr_for_me;
200 const char *error_msg; /* error message, if any */
202 struct ceph_entity_name peer_name; /* peer name */
205 u32 connect_seq; /* identify the most recent connection
206 attempt for this connection, client */
207 u32 peer_global_seq; /* peer's global seq for this connection */
209 int auth_retry; /* true if we need a newer authorizer */
210 void *auth_reply_buf; /* where to put the authorizer reply */
211 int auth_reply_buf_len;
216 struct list_head out_queue;
217 struct list_head out_sent; /* sending or sent but unacked */
218 u64 out_seq; /* last message queued for send */
220 u64 in_seq, in_seq_acked; /* last message received, acked */
222 /* connection negotiation temps */
223 char in_banner[CEPH_BANNER_MAX_LEN];
224 struct ceph_msg_connect out_connect;
225 struct ceph_msg_connect_reply in_reply;
226 struct ceph_entity_addr actual_peer_addr;
228 /* message out temps */
229 struct ceph_msg *out_msg; /* sending message (== tail of
233 struct kvec out_kvec[8], /* sending header/footer data */
235 int out_kvec_left; /* kvec's left in out_kvec */
236 int out_skip; /* skip this many bytes */
237 int out_kvec_bytes; /* total bytes left */
238 bool out_kvec_is_msg; /* kvec refers to out_msg */
239 int out_more; /* there is more data after the kvecs */
240 __le64 out_temp_ack; /* for writing an ack */
241 struct ceph_timespec out_temp_keepalive2; /* for writing keepalive2
244 /* message in temps */
245 struct ceph_msg_header in_hdr;
246 struct ceph_msg *in_msg;
247 u32 in_front_crc, in_middle_crc, in_data_crc; /* calculated crc */
249 char in_tag; /* protocol control byte */
250 int in_base_pos; /* bytes read */
251 __le64 in_temp_ack; /* for reading an ack */
253 struct timespec last_keepalive_ack; /* keepalive2 ack stamp */
255 struct delayed_work work; /* send|recv work */
256 unsigned long delay; /* current delay interval */
260 extern const char *ceph_pr_addr(const struct sockaddr_storage *ss);
261 extern int ceph_parse_ips(const char *c, const char *end,
262 struct ceph_entity_addr *addr,
263 int max_count, int *count);
266 extern int ceph_msgr_init(void);
267 extern void ceph_msgr_exit(void);
268 extern void ceph_msgr_flush(void);
270 extern void ceph_messenger_init(struct ceph_messenger *msgr,
271 struct ceph_entity_addr *myaddr,
272 u64 supported_features,
273 u64 required_features,
276 extern void ceph_messenger_fini(struct ceph_messenger *msgr);
278 extern void ceph_con_init(struct ceph_connection *con, void *private,
279 const struct ceph_connection_operations *ops,
280 struct ceph_messenger *msgr);
281 extern void ceph_con_open(struct ceph_connection *con,
282 __u8 entity_type, __u64 entity_num,
283 struct ceph_entity_addr *addr);
284 extern bool ceph_con_opened(struct ceph_connection *con);
285 extern void ceph_con_close(struct ceph_connection *con);
286 extern void ceph_con_send(struct ceph_connection *con, struct ceph_msg *msg);
288 extern void ceph_msg_revoke(struct ceph_msg *msg);
289 extern void ceph_msg_revoke_incoming(struct ceph_msg *msg);
291 extern void ceph_con_keepalive(struct ceph_connection *con);
292 extern bool ceph_con_keepalive_expired(struct ceph_connection *con,
293 unsigned long interval);
295 extern void ceph_msg_data_add_pages(struct ceph_msg *msg, struct page **pages,
296 size_t length, size_t alignment);
297 extern void ceph_msg_data_add_pagelist(struct ceph_msg *msg,
298 struct ceph_pagelist *pagelist);
300 extern void ceph_msg_data_add_bio(struct ceph_msg *msg, struct bio *bio,
302 #endif /* CONFIG_BLOCK */
304 extern struct ceph_msg *ceph_msg_new(int type, int front_len, gfp_t flags,
307 extern struct ceph_msg *ceph_msg_get(struct ceph_msg *msg);
308 extern void ceph_msg_put(struct ceph_msg *msg);
310 extern void ceph_msg_dump(struct ceph_msg *msg);