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>
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
;
56 * the global_seq counts connections i (attempt to) initiate
57 * in order to disambiguate certain connect race conditions.
60 spinlock_t global_seq_lock
;
62 u32 supported_features
;
63 u32 required_features
;
67 * a single message. it contains a header (src, dest, message type, etc.),
68 * footer (crc values, mainly), a "front" message body, and possibly a
69 * data payload (stored in some number of pages).
72 struct ceph_msg_header hdr
; /* header */
73 struct ceph_msg_footer footer
; /* footer */
74 struct kvec front
; /* unaligned blobs of message */
75 struct ceph_buffer
*middle
;
76 struct page
**pages
; /* data payload. NOT OWNER. */
77 unsigned nr_pages
; /* size of page array */
78 unsigned page_alignment
; /* io offset in first page */
79 struct ceph_pagelist
*pagelist
; /* instead of pages */
81 struct ceph_connection
*con
;
82 struct list_head list_head
;
85 struct bio
*bio
; /* instead of pages/pagelist */
86 struct bio
*bio_iter
; /* bio iterator */
87 int bio_seg
; /* current bio segment */
88 struct ceph_pagelist
*trail
; /* the trailing part of the data */
89 bool front_is_vmalloc
;
93 unsigned long ack_stamp
; /* tx: when we were acked */
95 struct ceph_msgpool
*pool
;
99 int page
, page_pos
; /* which page; offset in page */
100 int data_pos
; /* offset in data payload */
101 bool did_page_crc
; /* true if we've calculated crc for current page */
104 /* ceph connection fault delay defaults, for exponential backoff */
105 #define BASE_DELAY_INTERVAL (HZ/2)
106 #define MAX_DELAY_INTERVAL (5 * 60 * HZ)
109 * ceph_connection flag bits
112 #define LOSSYTX 0 /* we can close channel or drop messages on errors */
113 #define KEEPALIVE_PENDING 3
114 #define WRITE_PENDING 4 /* we have data ready to send */
115 #define SOCK_CLOSED 11 /* socket state changed to closed */
119 * ceph_connection states
122 #define NEGOTIATING 2
124 #define STANDBY 8 /* no outgoing messages, socket closed. we keep
125 * the ceph_connection around to maintain shared
126 * state with the peer. */
127 #define CLOSED 10 /* we've closed the connection */
128 #define OPENING 13 /* open connection w/ (possibly new) peer */
131 * A single connection with another host.
133 * We maintain a queue of outgoing messages, and some session state to
134 * ensure that we can preserve the lossless, ordered delivery of
135 * messages in the case of a TCP disconnect.
137 struct ceph_connection
{
140 const struct ceph_connection_operations
*ops
;
142 struct ceph_messenger
*msgr
;
146 struct ceph_entity_addr peer_addr
; /* peer address */
147 struct ceph_entity_addr peer_addr_for_me
;
151 const char *error_msg
; /* error message, if any */
153 struct ceph_entity_name peer_name
; /* peer name */
155 unsigned peer_features
;
156 u32 connect_seq
; /* identify the most recent connection
157 attempt for this connection, client */
158 u32 peer_global_seq
; /* peer's global seq for this connection */
160 int auth_retry
; /* true if we need a newer authorizer */
161 void *auth_reply_buf
; /* where to put the authorizer reply */
162 int auth_reply_buf_len
;
167 struct list_head out_queue
;
168 struct list_head out_sent
; /* sending or sent but unacked */
169 u64 out_seq
; /* last message queued for send */
171 u64 in_seq
, in_seq_acked
; /* last message received, acked */
173 /* connection negotiation temps */
174 char in_banner
[CEPH_BANNER_MAX_LEN
];
176 struct { /* outgoing connection */
177 struct ceph_msg_connect out_connect
;
178 struct ceph_msg_connect_reply in_reply
;
180 struct { /* incoming */
181 struct ceph_msg_connect in_connect
;
182 struct ceph_msg_connect_reply out_reply
;
185 struct ceph_entity_addr actual_peer_addr
;
187 /* message out temps */
188 struct ceph_msg
*out_msg
; /* sending message (== tail of
191 struct ceph_msg_pos out_msg_pos
;
193 struct kvec out_kvec
[8], /* sending header/footer data */
195 int out_kvec_left
; /* kvec's left in out_kvec */
196 int out_skip
; /* skip this many bytes */
197 int out_kvec_bytes
; /* total bytes left */
198 bool out_kvec_is_msg
; /* kvec refers to out_msg */
199 int out_more
; /* there is more data after the kvecs */
200 __le64 out_temp_ack
; /* for writing an ack */
202 /* message in temps */
203 struct ceph_msg_header in_hdr
;
204 struct ceph_msg
*in_msg
;
205 struct ceph_msg_pos in_msg_pos
;
206 u32 in_front_crc
, in_middle_crc
, in_data_crc
; /* calculated crc */
208 char in_tag
; /* protocol control byte */
209 int in_base_pos
; /* bytes read */
210 __le64 in_temp_ack
; /* for reading an ack */
212 struct delayed_work work
; /* send|recv work */
213 unsigned long delay
; /* current delay interval */
217 extern const char *ceph_pr_addr(const struct sockaddr_storage
*ss
);
218 extern int ceph_parse_ips(const char *c
, const char *end
,
219 struct ceph_entity_addr
*addr
,
220 int max_count
, int *count
);
223 extern int ceph_msgr_init(void);
224 extern void ceph_msgr_exit(void);
225 extern void ceph_msgr_flush(void);
227 extern void ceph_messenger_init(struct ceph_messenger
*msgr
,
228 struct ceph_entity_addr
*myaddr
,
229 u32 supported_features
,
230 u32 required_features
,
233 extern void ceph_con_init(struct ceph_connection
*con
, void *private,
234 const struct ceph_connection_operations
*ops
,
235 struct ceph_messenger
*msgr
);
236 extern void ceph_con_open(struct ceph_connection
*con
,
237 __u8 entity_type
, __u64 entity_num
,
238 struct ceph_entity_addr
*addr
);
239 extern bool ceph_con_opened(struct ceph_connection
*con
);
240 extern void ceph_con_close(struct ceph_connection
*con
);
241 extern void ceph_con_send(struct ceph_connection
*con
, struct ceph_msg
*msg
);
243 extern void ceph_msg_revoke(struct ceph_msg
*msg
);
244 extern void ceph_msg_revoke_incoming(struct ceph_msg
*msg
);
246 extern void ceph_con_keepalive(struct ceph_connection
*con
);
248 extern struct ceph_msg
*ceph_msg_new(int type
, int front_len
, gfp_t flags
,
250 extern void ceph_msg_kfree(struct ceph_msg
*m
);
253 static inline struct ceph_msg
*ceph_msg_get(struct ceph_msg
*msg
)
255 kref_get(&msg
->kref
);
258 extern void ceph_msg_last_put(struct kref
*kref
);
259 static inline void ceph_msg_put(struct ceph_msg
*msg
)
261 kref_put(&msg
->kref
, ceph_msg_last_put
);
264 extern void ceph_msg_dump(struct ceph_msg
*msg
);