messenger.h 8.0 KB

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