1 #ifndef __FS_CEPH_MESSENGER_H
2 #define __FS_CEPH_MESSENGER_H
4 #include <linux/kref.h>
5 #include <linux/mutex.h>
7 #include <linux/radix-tree.h>
9 #include <linux/workqueue.h>
11 #include <linux/ceph/types.h>
12 #include <linux/ceph/buffer.h>
15 struct ceph_connection
;
18 * Ceph defines these callbacks for handling connection events.
20 struct ceph_connection_operations
{
21 struct ceph_connection
*(*get
)(struct ceph_connection
*);
22 void (*put
)(struct ceph_connection
*);
24 /* handle an incoming message. */
25 void (*dispatch
) (struct ceph_connection
*con
, struct ceph_msg
*m
);
27 /* authorize an outgoing connection */
28 struct ceph_auth_handshake
*(*get_authorizer
) (
29 struct ceph_connection
*con
,
30 int *proto
, int force_new
);
31 int (*verify_authorizer_reply
) (struct ceph_connection
*con
, int len
);
32 int (*invalidate_authorizer
)(struct ceph_connection
*con
);
34 /* there was some error on the socket (disconnect, whatever) */
35 void (*fault
) (struct ceph_connection
*con
);
37 /* a remote host as terminated a message exchange session, and messages
38 * we sent (or they tried to send us) may be lost. */
39 void (*peer_reset
) (struct ceph_connection
*con
);
41 struct ceph_msg
* (*alloc_msg
) (struct ceph_connection
*con
,
42 struct ceph_msg_header
*hdr
,
46 /* use format string %s%d */
47 #define ENTITY_NAME(n) ceph_entity_type_name((n).type), le64_to_cpu((n).num)
49 struct ceph_messenger
{
50 struct ceph_entity_inst inst
; /* my name+address */
51 struct ceph_entity_addr my_enc_addr
;
57 * the global_seq counts connections i (attempt to) initiate
58 * in order to disambiguate certain connect race conditions.
61 spinlock_t global_seq_lock
;
63 u32 supported_features
;
64 u32 required_features
;
68 * a single message. it contains a header (src, dest, message type, etc.),
69 * footer (crc values, mainly), a "front" message body, and possibly a
70 * data payload (stored in some number of pages).
73 struct ceph_msg_header hdr
; /* header */
74 struct ceph_msg_footer footer
; /* footer */
75 struct kvec front
; /* unaligned blobs of message */
76 struct ceph_buffer
*middle
;
78 struct page
**pages
; /* data payload. NOT OWNER. */
79 unsigned int page_alignment
; /* io offset in first page */
80 unsigned int page_count
; /* # pages in array or list */
81 struct ceph_pagelist
*pagelist
; /* instead of pages */
83 unsigned int bio_seg
; /* current bio segment */
84 struct bio
*bio
; /* instead of pages/pagelist */
85 struct bio
*bio_iter
; /* bio iterator */
86 #endif /* CONFIG_BLOCK */
87 struct ceph_pagelist
*trail
; /* the trailing part of the data */
89 struct ceph_connection
*con
;
90 struct list_head list_head
; /* links for connection lists */
93 bool front_is_vmalloc
;
97 unsigned long ack_stamp
; /* tx: when we were acked */
99 struct ceph_msgpool
*pool
;
102 struct ceph_msg_pos
{
103 int page
, page_pos
; /* which page; offset in page */
104 int data_pos
; /* offset in data payload */
105 bool did_page_crc
; /* true if we've calculated crc for current page */
108 /* ceph connection fault delay defaults, for exponential backoff */
109 #define BASE_DELAY_INTERVAL (HZ/2)
110 #define MAX_DELAY_INTERVAL (5 * 60 * HZ)
113 * A single connection with another host.
115 * We maintain a queue of outgoing messages, and some session state to
116 * ensure that we can preserve the lossless, ordered delivery of
117 * messages in the case of a TCP disconnect.
119 struct ceph_connection
{
122 const struct ceph_connection_operations
*ops
;
124 struct ceph_messenger
*msgr
;
128 struct ceph_entity_addr peer_addr
; /* peer address */
129 struct ceph_entity_addr peer_addr_for_me
;
133 const char *error_msg
; /* error message, if any */
135 struct ceph_entity_name peer_name
; /* peer name */
137 unsigned peer_features
;
138 u32 connect_seq
; /* identify the most recent connection
139 attempt for this connection, client */
140 u32 peer_global_seq
; /* peer's global seq for this connection */
142 int auth_retry
; /* true if we need a newer authorizer */
143 void *auth_reply_buf
; /* where to put the authorizer reply */
144 int auth_reply_buf_len
;
149 struct list_head out_queue
;
150 struct list_head out_sent
; /* sending or sent but unacked */
151 u64 out_seq
; /* last message queued for send */
153 u64 in_seq
, in_seq_acked
; /* last message received, acked */
155 /* connection negotiation temps */
156 char in_banner
[CEPH_BANNER_MAX_LEN
];
157 struct ceph_msg_connect out_connect
;
158 struct ceph_msg_connect_reply in_reply
;
159 struct ceph_entity_addr actual_peer_addr
;
161 /* message out temps */
162 struct ceph_msg
*out_msg
; /* sending message (== tail of
165 struct ceph_msg_pos out_msg_pos
;
167 struct kvec out_kvec
[8], /* sending header/footer data */
169 int out_kvec_left
; /* kvec's left in out_kvec */
170 int out_skip
; /* skip this many bytes */
171 int out_kvec_bytes
; /* total bytes left */
172 bool out_kvec_is_msg
; /* kvec refers to out_msg */
173 int out_more
; /* there is more data after the kvecs */
174 __le64 out_temp_ack
; /* for writing an ack */
176 /* message in temps */
177 struct ceph_msg_header in_hdr
;
178 struct ceph_msg
*in_msg
;
179 struct ceph_msg_pos in_msg_pos
;
180 u32 in_front_crc
, in_middle_crc
, in_data_crc
; /* calculated crc */
182 char in_tag
; /* protocol control byte */
183 int in_base_pos
; /* bytes read */
184 __le64 in_temp_ack
; /* for reading an ack */
186 struct delayed_work work
; /* send|recv work */
187 unsigned long delay
; /* current delay interval */
191 extern const char *ceph_pr_addr(const struct sockaddr_storage
*ss
);
192 extern int ceph_parse_ips(const char *c
, const char *end
,
193 struct ceph_entity_addr
*addr
,
194 int max_count
, int *count
);
197 extern int ceph_msgr_init(void);
198 extern void ceph_msgr_exit(void);
199 extern void ceph_msgr_flush(void);
201 extern void ceph_messenger_init(struct ceph_messenger
*msgr
,
202 struct ceph_entity_addr
*myaddr
,
203 u32 supported_features
,
204 u32 required_features
,
207 extern void ceph_con_init(struct ceph_connection
*con
, void *private,
208 const struct ceph_connection_operations
*ops
,
209 struct ceph_messenger
*msgr
);
210 extern void ceph_con_open(struct ceph_connection
*con
,
211 __u8 entity_type
, __u64 entity_num
,
212 struct ceph_entity_addr
*addr
);
213 extern bool ceph_con_opened(struct ceph_connection
*con
);
214 extern void ceph_con_close(struct ceph_connection
*con
);
215 extern void ceph_con_send(struct ceph_connection
*con
, struct ceph_msg
*msg
);
217 extern void ceph_msg_revoke(struct ceph_msg
*msg
);
218 extern void ceph_msg_revoke_incoming(struct ceph_msg
*msg
);
220 extern void ceph_con_keepalive(struct ceph_connection
*con
);
222 extern void ceph_msg_data_set_pages(struct ceph_msg
*msg
, struct page
**pages
,
223 size_t length
, size_t alignment
);
224 extern void ceph_msg_data_set_pagelist(struct ceph_msg
*msg
,
225 struct ceph_pagelist
*pagelist
);
226 extern void ceph_msg_data_set_bio(struct ceph_msg
*msg
, struct bio
*bio
);
227 extern void ceph_msg_data_set_trail(struct ceph_msg
*msg
,
228 struct ceph_pagelist
*trail
);
230 extern struct ceph_msg
*ceph_msg_new(int type
, int front_len
, gfp_t flags
,
232 extern void ceph_msg_kfree(struct ceph_msg
*m
);
235 static inline struct ceph_msg
*ceph_msg_get(struct ceph_msg
*msg
)
237 kref_get(&msg
->kref
);
240 extern void ceph_msg_last_put(struct kref
*kref
);
241 static inline void ceph_msg_put(struct ceph_msg
*msg
)
243 kref_put(&msg
->kref
, ceph_msg_last_put
);
246 extern void ceph_msg_dump(struct ceph_msg
*msg
);