libceph: define ceph_msg_has_*() data macros
[linux-3.10.git] / include / linux / ceph / messenger.h
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/workqueue.h>
10
11 #include <linux/ceph/types.h>
12 #include <linux/ceph/buffer.h>
13
14 struct ceph_msg;
15 struct ceph_connection;
16
17 /*
18  * Ceph defines these callbacks for handling connection events.
19  */
20 struct ceph_connection_operations {
21         struct ceph_connection *(*get)(struct ceph_connection *);
22         void (*put)(struct ceph_connection *);
23
24         /* handle an incoming message. */
25         void (*dispatch) (struct ceph_connection *con, struct ceph_msg *m);
26
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);
33
34         /* there was some error on the socket (disconnect, whatever) */
35         void (*fault) (struct ceph_connection *con);
36
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);
40
41         struct ceph_msg * (*alloc_msg) (struct ceph_connection *con,
42                                         struct ceph_msg_header *hdr,
43                                         int *skip);
44 };
45
46 /* use format string %s%d */
47 #define ENTITY_NAME(n) ceph_entity_type_name((n).type), le64_to_cpu((n).num)
48
49 struct ceph_messenger {
50         struct ceph_entity_inst inst;    /* my name+address */
51         struct ceph_entity_addr my_enc_addr;
52
53         atomic_t stopping;
54         bool nocrc;
55
56         /*
57          * the global_seq counts connections i (attempt to) initiate
58          * in order to disambiguate certain connect race conditions.
59          */
60         u32 global_seq;
61         spinlock_t global_seq_lock;
62
63         u32 supported_features;
64         u32 required_features;
65 };
66
67 #define ceph_msg_has_pages(m)           ((m)->pages != NULL)
68 #define ceph_msg_has_pagelist(m)        ((m)->pagelist != NULL)
69 #ifdef CONFIG_BLOCK
70 #define ceph_msg_has_bio(m)             ((m)->bio != NULL)
71 #endif /* CONFIG_BLOCK */
72 #define ceph_msg_has_trail(m)           ((m)->trail != NULL)
73
74 /*
75  * a single message.  it contains a header (src, dest, message type, etc.),
76  * footer (crc values, mainly), a "front" message body, and possibly a
77  * data payload (stored in some number of pages).
78  */
79 struct ceph_msg {
80         struct ceph_msg_header hdr;     /* header */
81         struct ceph_msg_footer footer;  /* footer */
82         struct kvec front;              /* unaligned blobs of message */
83         struct ceph_buffer *middle;
84
85         struct page **pages;            /* data payload.  NOT OWNER. */
86         unsigned int page_alignment;    /* io offset in first page */
87         size_t length;                  /* # data bytes in array or list */
88         struct ceph_pagelist *pagelist; /* instead of pages */
89 #ifdef CONFIG_BLOCK
90         unsigned int bio_seg;           /* current bio segment */
91         struct bio  *bio;               /* instead of pages/pagelist */
92         struct bio  *bio_iter;          /* bio iterator */
93 #endif /* CONFIG_BLOCK */
94         struct ceph_pagelist *trail;    /* the trailing part of the data */
95
96         struct ceph_connection *con;
97         struct list_head list_head;     /* links for connection lists */
98
99         struct kref kref;
100         bool front_is_vmalloc;
101         bool more_to_follow;
102         bool needs_out_seq;
103         int front_max;
104         unsigned long ack_stamp;        /* tx: when we were acked */
105
106         struct ceph_msgpool *pool;
107 };
108
109 struct ceph_msg_pos {
110         int page, page_pos;  /* which page; offset in page */
111         int data_pos;        /* offset in data payload */
112         bool did_page_crc;   /* true if we've calculated crc for current page */
113 };
114
115 /* ceph connection fault delay defaults, for exponential backoff */
116 #define BASE_DELAY_INTERVAL     (HZ/2)
117 #define MAX_DELAY_INTERVAL      (5 * 60 * HZ)
118
119 /*
120  * A single connection with another host.
121  *
122  * We maintain a queue of outgoing messages, and some session state to
123  * ensure that we can preserve the lossless, ordered delivery of
124  * messages in the case of a TCP disconnect.
125  */
126 struct ceph_connection {
127         void *private;
128
129         const struct ceph_connection_operations *ops;
130
131         struct ceph_messenger *msgr;
132
133         atomic_t sock_state;
134         struct socket *sock;
135         struct ceph_entity_addr peer_addr; /* peer address */
136         struct ceph_entity_addr peer_addr_for_me;
137
138         unsigned long flags;
139         unsigned long state;
140         const char *error_msg;  /* error message, if any */
141
142         struct ceph_entity_name peer_name; /* peer name */
143
144         unsigned peer_features;
145         u32 connect_seq;      /* identify the most recent connection
146                                  attempt for this connection, client */
147         u32 peer_global_seq;  /* peer's global seq for this connection */
148
149         int auth_retry;       /* true if we need a newer authorizer */
150         void *auth_reply_buf;   /* where to put the authorizer reply */
151         int auth_reply_buf_len;
152
153         struct mutex mutex;
154
155         /* out queue */
156         struct list_head out_queue;
157         struct list_head out_sent;   /* sending or sent but unacked */
158         u64 out_seq;                 /* last message queued for send */
159
160         u64 in_seq, in_seq_acked;  /* last message received, acked */
161
162         /* connection negotiation temps */
163         char in_banner[CEPH_BANNER_MAX_LEN];
164         struct ceph_msg_connect out_connect;
165         struct ceph_msg_connect_reply in_reply;
166         struct ceph_entity_addr actual_peer_addr;
167
168         /* message out temps */
169         struct ceph_msg *out_msg;        /* sending message (== tail of
170                                             out_sent) */
171         bool out_msg_done;
172         struct ceph_msg_pos out_msg_pos;
173
174         struct kvec out_kvec[8],         /* sending header/footer data */
175                 *out_kvec_cur;
176         int out_kvec_left;   /* kvec's left in out_kvec */
177         int out_skip;        /* skip this many bytes */
178         int out_kvec_bytes;  /* total bytes left */
179         bool out_kvec_is_msg; /* kvec refers to out_msg */
180         int out_more;        /* there is more data after the kvecs */
181         __le64 out_temp_ack; /* for writing an ack */
182
183         /* message in temps */
184         struct ceph_msg_header in_hdr;
185         struct ceph_msg *in_msg;
186         struct ceph_msg_pos in_msg_pos;
187         u32 in_front_crc, in_middle_crc, in_data_crc;  /* calculated crc */
188
189         char in_tag;         /* protocol control byte */
190         int in_base_pos;     /* bytes read */
191         __le64 in_temp_ack;  /* for reading an ack */
192
193         struct delayed_work work;           /* send|recv work */
194         unsigned long       delay;          /* current delay interval */
195 };
196
197
198 extern const char *ceph_pr_addr(const struct sockaddr_storage *ss);
199 extern int ceph_parse_ips(const char *c, const char *end,
200                           struct ceph_entity_addr *addr,
201                           int max_count, int *count);
202
203
204 extern int ceph_msgr_init(void);
205 extern void ceph_msgr_exit(void);
206 extern void ceph_msgr_flush(void);
207
208 extern void ceph_messenger_init(struct ceph_messenger *msgr,
209                         struct ceph_entity_addr *myaddr,
210                         u32 supported_features,
211                         u32 required_features,
212                         bool nocrc);
213
214 extern void ceph_con_init(struct ceph_connection *con, void *private,
215                         const struct ceph_connection_operations *ops,
216                         struct ceph_messenger *msgr);
217 extern void ceph_con_open(struct ceph_connection *con,
218                           __u8 entity_type, __u64 entity_num,
219                           struct ceph_entity_addr *addr);
220 extern bool ceph_con_opened(struct ceph_connection *con);
221 extern void ceph_con_close(struct ceph_connection *con);
222 extern void ceph_con_send(struct ceph_connection *con, struct ceph_msg *msg);
223
224 extern void ceph_msg_revoke(struct ceph_msg *msg);
225 extern void ceph_msg_revoke_incoming(struct ceph_msg *msg);
226
227 extern void ceph_con_keepalive(struct ceph_connection *con);
228
229 extern void ceph_msg_data_set_pages(struct ceph_msg *msg, struct page **pages,
230                                 size_t length, size_t alignment);
231 extern void ceph_msg_data_set_pagelist(struct ceph_msg *msg,
232                                 struct ceph_pagelist *pagelist);
233 extern void ceph_msg_data_set_bio(struct ceph_msg *msg, struct bio *bio);
234 extern void ceph_msg_data_set_trail(struct ceph_msg *msg,
235                                 struct ceph_pagelist *trail);
236
237 extern struct ceph_msg *ceph_msg_new(int type, int front_len, gfp_t flags,
238                                      bool can_fail);
239 extern void ceph_msg_kfree(struct ceph_msg *m);
240
241
242 static inline struct ceph_msg *ceph_msg_get(struct ceph_msg *msg)
243 {
244         kref_get(&msg->kref);
245         return msg;
246 }
247 extern void ceph_msg_last_put(struct kref *kref);
248 static inline void ceph_msg_put(struct ceph_msg *msg)
249 {
250         kref_put(&msg->kref, ceph_msg_last_put);
251 }
252
253 extern void ceph_msg_dump(struct ceph_msg *msg);
254
255 #endif