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