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 (*add_authorizer_challenge)(struct ceph_connection *con,
35 int challenge_buf_len);
36 int (*verify_authorizer_reply) (struct ceph_connection *con);
37 int (*invalidate_authorizer)(struct ceph_connection *con);
39 /* there was some error on the socket (disconnect, whatever) */
40 void (*fault) (struct ceph_connection *con);
42 /* a remote host as terminated a message exchange session, and messages
43 * we sent (or they tried to send us) may be lost. */
44 void (*peer_reset) (struct ceph_connection *con);
46 struct ceph_msg * (*alloc_msg) (struct ceph_connection *con,
47 struct ceph_msg_header *hdr,
50 int (*sign_message) (struct ceph_msg *msg);
51 int (*check_message_signature) (struct ceph_msg *msg);
54 /* use format string %s%d */
55 #define ENTITY_NAME(n) ceph_entity_type_name((n).type), le64_to_cpu((n).num)
57 struct ceph_messenger {
58 struct ceph_entity_inst inst; /* my name+address */
59 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;
72 enum 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 */
77 CEPH_MSG_DATA_BIO, /* data source/destination is a bio list */
78 #endif /* CONFIG_BLOCK */
81 static __inline__ bool ceph_msg_data_type_valid(enum ceph_msg_data_type type)
84 case CEPH_MSG_DATA_NONE:
85 case CEPH_MSG_DATA_PAGES:
86 case CEPH_MSG_DATA_PAGELIST:
88 case CEPH_MSG_DATA_BIO:
89 #endif /* CONFIG_BLOCK */
96 struct ceph_msg_data {
97 struct list_head links; /* ceph_msg->data */
98 enum ceph_msg_data_type type;
105 #endif /* CONFIG_BLOCK */
107 struct page **pages; /* NOT OWNER. */
108 size_t length; /* total # bytes */
109 unsigned int alignment; /* first page */
111 struct ceph_pagelist *pagelist;
115 struct ceph_msg_data_cursor {
116 size_t total_resid; /* across all data items */
117 struct list_head *data_head; /* = &ceph_msg->data */
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 */
126 struct bio *bio; /* bio from list */
127 struct bvec_iter bvec_iter;
129 #endif /* CONFIG_BLOCK */
131 unsigned int page_offset; /* offset in page */
132 unsigned short page_index; /* index in array */
133 unsigned short page_count; /* pages in array */
135 struct { /* pagelist */
136 struct page *page; /* page from list */
137 size_t offset; /* bytes from list */
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).
148 struct ceph_msg_header hdr; /* header */
150 struct ceph_msg_footer footer; /* footer */
151 struct ceph_msg_footer_old old_footer; /* old format footer */
153 struct kvec front; /* unaligned blobs of message */
154 struct ceph_buffer *middle;
157 struct list_head data;
158 struct ceph_msg_data_cursor cursor;
160 struct ceph_connection *con;
161 struct list_head list_head; /* links for connection lists */
167 unsigned long ack_stamp; /* tx: when we were acked */
169 struct ceph_msgpool *pool;
172 /* ceph connection fault delay defaults, for exponential backoff */
173 #define BASE_DELAY_INTERVAL (HZ/2)
174 #define MAX_DELAY_INTERVAL (5 * 60 * HZ)
177 * A single connection with another host.
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.
183 struct ceph_connection {
186 const struct ceph_connection_operations *ops;
188 struct ceph_messenger *msgr;
192 struct ceph_entity_addr peer_addr; /* peer address */
193 struct ceph_entity_addr peer_addr_for_me;
197 const char *error_msg; /* error message, if any */
199 struct ceph_entity_name peer_name; /* peer name */
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 */
206 struct ceph_auth_handshake *auth;
207 int auth_retry; /* true if we need a newer authorizer */
212 struct list_head out_queue;
213 struct list_head out_sent; /* sending or sent but unacked */
214 u64 out_seq; /* last message queued for send */
216 u64 in_seq, in_seq_acked; /* last message received, acked */
218 /* connection negotiation temps */
219 char in_banner[CEPH_BANNER_MAX_LEN];
220 struct ceph_msg_connect out_connect;
221 struct ceph_msg_connect_reply in_reply;
222 struct ceph_entity_addr actual_peer_addr;
224 /* message out temps */
225 struct ceph_msg_header out_hdr;
226 struct ceph_msg *out_msg; /* sending message (== tail of
230 struct kvec out_kvec[8], /* sending header/footer data */
232 int out_kvec_left; /* kvec's left in out_kvec */
233 int out_skip; /* skip this many bytes */
234 int out_kvec_bytes; /* total bytes left */
235 int out_more; /* there is more data after the kvecs */
236 __le64 out_temp_ack; /* for writing an ack */
237 struct ceph_timespec out_temp_keepalive2; /* for writing keepalive2
240 /* message in temps */
241 struct ceph_msg_header in_hdr;
242 struct ceph_msg *in_msg;
243 u32 in_front_crc, in_middle_crc, in_data_crc; /* calculated crc */
245 char in_tag; /* protocol control byte */
246 int in_base_pos; /* bytes read */
247 __le64 in_temp_ack; /* for reading an ack */
249 struct timespec last_keepalive_ack; /* keepalive2 ack stamp */
251 struct delayed_work work; /* send|recv work */
252 unsigned long delay; /* current delay interval */
256 extern const char *ceph_pr_addr(const struct sockaddr_storage *ss);
257 extern int ceph_parse_ips(const char *c, const char *end,
258 struct ceph_entity_addr *addr,
259 int max_count, int *count);
262 extern int ceph_msgr_init(void);
263 extern void ceph_msgr_exit(void);
264 extern void ceph_msgr_flush(void);
266 extern void ceph_messenger_init(struct ceph_messenger *msgr,
267 struct ceph_entity_addr *myaddr);
268 extern void ceph_messenger_fini(struct ceph_messenger *msgr);
270 extern void ceph_con_init(struct ceph_connection *con, void *private,
271 const struct ceph_connection_operations *ops,
272 struct ceph_messenger *msgr);
273 extern void ceph_con_open(struct ceph_connection *con,
274 __u8 entity_type, __u64 entity_num,
275 struct ceph_entity_addr *addr);
276 extern bool ceph_con_opened(struct ceph_connection *con);
277 extern void ceph_con_close(struct ceph_connection *con);
278 extern void ceph_con_send(struct ceph_connection *con, struct ceph_msg *msg);
280 extern void ceph_msg_revoke(struct ceph_msg *msg);
281 extern void ceph_msg_revoke_incoming(struct ceph_msg *msg);
283 extern void ceph_con_keepalive(struct ceph_connection *con);
284 extern bool ceph_con_keepalive_expired(struct ceph_connection *con,
285 unsigned long interval);
287 extern void ceph_msg_data_add_pages(struct ceph_msg *msg, struct page **pages,
288 size_t length, size_t alignment);
289 extern void ceph_msg_data_add_pagelist(struct ceph_msg *msg,
290 struct ceph_pagelist *pagelist);
292 extern void ceph_msg_data_add_bio(struct ceph_msg *msg, struct bio *bio,
294 #endif /* CONFIG_BLOCK */
296 extern struct ceph_msg *ceph_msg_new(int type, int front_len, gfp_t flags,
299 extern struct ceph_msg *ceph_msg_get(struct ceph_msg *msg);
300 extern void ceph_msg_put(struct ceph_msg *msg);
302 extern void ceph_msg_dump(struct ceph_msg *msg);