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