Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1#ifndef __FS_CEPH_MESSENGER_H
2#define __FS_CEPH_MESSENGER_H
3
4#include <linux/kref.h>
5#include <linux/mutex.h>
6#include <linux/net.h>
7#include <linux/radix-tree.h>
8#include <linux/uio.h>
9#include <linux/version.h>
10#include <linux/workqueue.h>
11
12#include "types.h"
13#include "buffer.h"
14
15struct ceph_msg;
16struct ceph_connection;
17
18extern struct workqueue_struct *ceph_msgr_wq; /* receive work queue */
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 int (*get_authorizer) (struct ceph_connection *con,
32 void **buf, int *len, int *proto,
33 void **reply_buf, int *reply_len, int force_new);
34 int (*verify_authorizer_reply) (struct ceph_connection *con, int len);
35 int (*invalidate_authorizer)(struct ceph_connection *con);
36
37 /* protocol version mismatch */
38 void (*bad_proto) (struct ceph_connection *con);
39
40 /* there was some error on the socket (disconnect, whatever) */
41 void (*fault) (struct ceph_connection *con);
42
43 /* a remote host as terminated a message exchange session, and messages
44 * we sent (or they tried to send us) may be lost. */
45 void (*peer_reset) (struct ceph_connection *con);
46
47 struct ceph_msg * (*alloc_msg) (struct ceph_connection *con,
48 struct ceph_msg_header *hdr,
49 int *skip);
50};
51
52/* use format string %s%d */
53#define ENTITY_NAME(n) ceph_entity_type_name((n).type), le64_to_cpu((n).num)
54
55struct ceph_messenger {
56 struct ceph_entity_inst inst; /* my name+address */
57 struct ceph_entity_addr my_enc_addr;
58 struct page *zero_page; /* used in certain error cases */
59
60 bool nocrc;
61
62 /*
63 * the global_seq counts connections i (attempt to) initiate
64 * in order to disambiguate certain connect race conditions.
65 */
66 u32 global_seq;
67 spinlock_t global_seq_lock;
68
69 u32 supported_features;
70 u32 required_features;
71};
72
73/*
74 * a single message. it contains a header (src, dest, message type, etc.),
75 * footer (crc values, mainly), a "front" message body, and possibly a
76 * data payload (stored in some number of pages).
77 */
78struct ceph_msg {
79 struct ceph_msg_header hdr; /* header */
80 struct ceph_msg_footer footer; /* footer */
81 struct kvec front; /* unaligned blobs of message */
82 struct ceph_buffer *middle;
83 struct page **pages; /* data payload. NOT OWNER. */
84 unsigned nr_pages; /* size of page array */
85 unsigned page_alignment; /* io offset in first page */
86 struct ceph_pagelist *pagelist; /* instead of pages */
87 struct list_head list_head;
88 struct kref kref;
89 struct bio *bio; /* instead of pages/pagelist */
90 struct bio *bio_iter; /* bio iterator */
91 int bio_seg; /* current bio segment */
92 struct ceph_pagelist *trail; /* the trailing part of the data */
93 bool front_is_vmalloc;
94 bool more_to_follow;
95 bool needs_out_seq;
96 int front_max;
97 unsigned long ack_stamp; /* tx: when we were acked */
98
99 struct ceph_msgpool *pool;
100};
101
102struct ceph_msg_pos {
103 int page, page_pos; /* which page; offset in page */
104 int data_pos; /* offset in data payload */
105 int did_page_crc; /* true if we've calculated crc for current page */
106};
107
108/* ceph connection fault delay defaults, for exponential backoff */
109#define BASE_DELAY_INTERVAL (HZ/2)
110#define MAX_DELAY_INTERVAL (5 * 60 * HZ)
111
112/*
113 * ceph_connection state bit flags
114 */
115#define LOSSYTX 0 /* we can close channel or drop messages on errors */
116#define CONNECTING 1
117#define NEGOTIATING 2
118#define KEEPALIVE_PENDING 3
119#define WRITE_PENDING 4 /* we have data ready to send */
120#define STANDBY 8 /* no outgoing messages, socket closed. we keep
121 * the ceph_connection around to maintain shared
122 * state with the peer. */
123#define CLOSED 10 /* we've closed the connection */
124#define SOCK_CLOSED 11 /* socket state changed to closed */
125#define OPENING 13 /* open connection w/ (possibly new) peer */
126#define DEAD 14 /* dead, about to kfree */
127#define BACKOFF 15
128
129/*
130 * A single connection with another host.
131 *
132 * We maintain a queue of outgoing messages, and some session state to
133 * ensure that we can preserve the lossless, ordered delivery of
134 * messages in the case of a TCP disconnect.
135 */
136struct ceph_connection {
137 void *private;
138 atomic_t nref;
139
140 const struct ceph_connection_operations *ops;
141
142 struct ceph_messenger *msgr;
143 struct socket *sock;
144 unsigned long state; /* connection state (see flags above) */
145 const char *error_msg; /* error message, if any */
146
147 struct ceph_entity_addr peer_addr; /* peer address */
148 struct ceph_entity_name peer_name; /* peer name */
149 struct ceph_entity_addr peer_addr_for_me;
150 unsigned peer_features;
151 u32 connect_seq; /* identify the most recent connection
152 attempt for this connection, client */
153 u32 peer_global_seq; /* peer's global seq for this connection */
154
155 int auth_retry; /* true if we need a newer authorizer */
156 void *auth_reply_buf; /* where to put the authorizer reply */
157 int auth_reply_buf_len;
158
159 struct mutex mutex;
160
161 /* out queue */
162 struct list_head out_queue;
163 struct list_head out_sent; /* sending or sent but unacked */
164 u64 out_seq; /* last message queued for send */
165
166 u64 in_seq, in_seq_acked; /* last message received, acked */
167
168 /* connection negotiation temps */
169 char in_banner[CEPH_BANNER_MAX_LEN];
170 union {
171 struct { /* outgoing connection */
172 struct ceph_msg_connect out_connect;
173 struct ceph_msg_connect_reply in_reply;
174 };
175 struct { /* incoming */
176 struct ceph_msg_connect in_connect;
177 struct ceph_msg_connect_reply out_reply;
178 };
179 };
180 struct ceph_entity_addr actual_peer_addr;
181
182 /* message out temps */
183 struct ceph_msg *out_msg; /* sending message (== tail of
184 out_sent) */
185 bool out_msg_done;
186 struct ceph_msg_pos out_msg_pos;
187
188 struct kvec out_kvec[8], /* sending header/footer data */
189 *out_kvec_cur;
190 int out_kvec_left; /* kvec's left in out_kvec */
191 int out_skip; /* skip this many bytes */
192 int out_kvec_bytes; /* total bytes left */
193 bool out_kvec_is_msg; /* kvec refers to out_msg */
194 int out_more; /* there is more data after the kvecs */
195 __le64 out_temp_ack; /* for writing an ack */
196
197 /* message in temps */
198 struct ceph_msg_header in_hdr;
199 struct ceph_msg *in_msg;
200 struct ceph_msg_pos in_msg_pos;
201 u32 in_front_crc, in_middle_crc, in_data_crc; /* calculated crc */
202
203 char in_tag; /* protocol control byte */
204 int in_base_pos; /* bytes read */
205 __le64 in_temp_ack; /* for reading an ack */
206
207 struct delayed_work work; /* send|recv work */
208 unsigned long delay; /* current delay interval */
209};
210
211
212extern const char *ceph_pr_addr(const struct sockaddr_storage *ss);
213extern int ceph_parse_ips(const char *c, const char *end,
214 struct ceph_entity_addr *addr,
215 int max_count, int *count);
216
217
218extern int ceph_msgr_init(void);
219extern void ceph_msgr_exit(void);
220extern void ceph_msgr_flush(void);
221
222extern struct ceph_messenger *ceph_messenger_create(
223 struct ceph_entity_addr *myaddr,
224 u32 features, u32 required);
225extern void ceph_messenger_destroy(struct ceph_messenger *);
226
227extern void ceph_con_init(struct ceph_messenger *msgr,
228 struct ceph_connection *con);
229extern void ceph_con_open(struct ceph_connection *con,
230 struct ceph_entity_addr *addr);
231extern bool ceph_con_opened(struct ceph_connection *con);
232extern void ceph_con_close(struct ceph_connection *con);
233extern void ceph_con_send(struct ceph_connection *con, struct ceph_msg *msg);
234extern void ceph_con_revoke(struct ceph_connection *con, struct ceph_msg *msg);
235extern void ceph_con_revoke_message(struct ceph_connection *con,
236 struct ceph_msg *msg);
237extern void ceph_con_keepalive(struct ceph_connection *con);
238extern struct ceph_connection *ceph_con_get(struct ceph_connection *con);
239extern void ceph_con_put(struct ceph_connection *con);
240
241extern struct ceph_msg *ceph_msg_new(int type, int front_len, gfp_t flags);
242extern void ceph_msg_kfree(struct ceph_msg *m);
243
244
245static inline struct ceph_msg *ceph_msg_get(struct ceph_msg *msg)
246{
247 kref_get(&msg->kref);
248 return msg;
249}
250extern void ceph_msg_last_put(struct kref *kref);
251static inline void ceph_msg_put(struct ceph_msg *msg)
252{
253 kref_put(&msg->kref, ceph_msg_last_put);
254}
255
256extern void ceph_msg_dump(struct ceph_msg *msg);
257
258#endif