[deliverable/linux.git] / fs / ceph / messenger.h

#ifndef __FS_CEPH_MESSENGER_H
#define __FS_CEPH_MESSENGER_H

#include <linux/kref.h>
#include <linux/mutex.h>
#include <linux/net.h>
#include <linux/radix-tree.h>
#include <linux/uio.h>
#include <linux/version.h>
#include <linux/workqueue.h>

#include "types.h"
#include "buffer.h"

struct ceph_msg;
struct ceph_connection;

extern struct workqueue_struct *ceph_msgr_wq;       /* receive work queue */

/*
 * Ceph defines these callbacks for handling connection events.
 */
struct ceph_connection_operations {
	struct ceph_connection *(*get)(struct ceph_connection *);
	void (*put)(struct ceph_connection *);

	/* handle an incoming message. */
	void (*dispatch) (struct ceph_connection *con, struct ceph_msg *m);

	/* authorize an outgoing connection */
	int (*get_authorizer) (struct ceph_connection *con,
			       void **buf, int *len, int *proto,
			       void **reply_buf, int *reply_len, int force_new);
	int (*verify_authorizer_reply) (struct ceph_connection *con, int len);

	/* protocol version mismatch */
	void (*bad_proto) (struct ceph_connection *con);

	/* there was some error on the socket (disconnect, whatever) */
	void (*fault) (struct ceph_connection *con);

	/* a remote host as terminated a message exchange session, and messages
	 * we sent (or they tried to send us) may be lost. */
	void (*peer_reset) (struct ceph_connection *con);

	struct ceph_msg * (*alloc_msg) (struct ceph_connection *con,
					struct ceph_msg_header *hdr);
	int (*alloc_middle) (struct ceph_connection *con,
			     struct ceph_msg *msg);
	/* an incoming message has a data payload; tell me what pages I
	 * should read the data into. */
	int (*prepare_pages) (struct ceph_connection *con, struct ceph_msg *m,
			      int want);
};

extern const char *ceph_name_type_str(int t);

/* use format string %s%d */
#define ENTITY_NAME(n) ceph_name_type_str((n).type), le64_to_cpu((n).num)

struct ceph_messenger {
	struct ceph_entity_inst inst;    /* my name+address */
	struct ceph_entity_addr my_enc_addr;
	struct page *zero_page;          /* used in certain error cases */

	bool nocrc;

	/*
	 * the global_seq counts connections i (attempt to) initiate
	 * in order to disambiguate certain connect race conditions.
	 */
	u32 global_seq;
	spinlock_t global_seq_lock;
};

/*
 * a single message.  it contains a header (src, dest, message type, etc.),
 * footer (crc values, mainly), a "front" message body, and possibly a
 * data payload (stored in some number of pages).
 */
struct ceph_msg {
	struct ceph_msg_header hdr;	/* header */
	struct ceph_msg_footer footer;	/* footer */
	struct kvec front;              /* unaligned blobs of message */
	struct ceph_buffer *middle;
	struct page **pages;            /* data payload.  NOT OWNER. */
	unsigned nr_pages;              /* size of page array */
	struct ceph_pagelist *pagelist; /* instead of pages */
	struct list_head list_head;
	struct kref kref;
	bool front_is_vmalloc;
	bool more_to_follow;
	int front_max;

	struct ceph_msgpool *pool;
};

struct ceph_msg_pos {
	int page, page_pos;  /* which page; offset in page */
	int data_pos;        /* offset in data payload */
	int did_page_crc;    /* true if we've calculated crc for current page */
};

/* ceph connection fault delay defaults, for exponential backoff */
#define BASE_DELAY_INTERVAL	(HZ/2)
#define MAX_DELAY_INTERVAL	(5 * 60 * HZ)

/*
 * ceph_connection state bit flags
 *
 * QUEUED and BUSY are used together to ensure that only a single
 * thread is currently opening, reading or writing data to the socket.
 */
#define LOSSYTX         0  /* we can close channel or drop messages on errors */
#define CONNECTING	1
#define NEGOTIATING	2
#define KEEPALIVE_PENDING      3
#define WRITE_PENDING	4  /* we have data ready to send */
#define QUEUED          5  /* there is work queued on this connection */
#define BUSY            6  /* work is being done */
#define STANDBY		8  /* no outgoing messages, socket closed.  we keep
			    * the ceph_connection around to maintain shared
			    * state with the peer. */
#define CLOSED		10 /* we've closed the connection */
#define SOCK_CLOSED	11 /* socket state changed to closed */
#define REGISTERED      12 /* connection appears in con_tree */
#define OPENING         13 /* open connection w/ (possibly new) peer */
#define DEAD            14 /* dead, about to kfree */

/*
 * A single connection with another host.
 *
 * We maintain a queue of outgoing messages, and some session state to
 * ensure that we can preserve the lossless, ordered delivery of
 * messages in the case of a TCP disconnect.
 */
struct ceph_connection {
	void *private;
	atomic_t nref;

	const struct ceph_connection_operations *ops;

	struct ceph_messenger *msgr;
	struct socket *sock;
	unsigned long state;	/* connection state (see flags above) */
	const char *error_msg;  /* error message, if any */

	struct ceph_entity_addr peer_addr; /* peer address */
	struct ceph_entity_name peer_name; /* peer name */
	struct ceph_entity_addr peer_addr_for_me;
	u32 connect_seq;      /* identify the most recent connection
				 attempt for this connection, client */
	u32 peer_global_seq;  /* peer's global seq for this connection */

	int auth_retry;       /* true if we need a newer authorizer */
	void *auth_reply_buf;   /* where to put the authorizer reply */
	int auth_reply_buf_len;

	struct mutex mutex;

	/* out queue */
	struct list_head out_queue;
	struct list_head out_sent;   /* sending or sent but unacked */
	u64 out_seq;		     /* last message queued for send */
	u64 out_seq_sent;            /* last message sent */
	bool out_keepalive_pending;

	u64 in_seq, in_seq_acked;  /* last message received, acked */

	/* connection negotiation temps */
	char in_banner[CEPH_BANNER_MAX_LEN];
	union {
		struct {  /* outgoing connection */
			struct ceph_msg_connect out_connect;
			struct ceph_msg_connect_reply in_reply;
		};
		struct {  /* incoming */
			struct ceph_msg_connect in_connect;
			struct ceph_msg_connect_reply out_reply;
		};
	};
	struct ceph_entity_addr actual_peer_addr;

	/* message out temps */
	struct ceph_msg *out_msg;        /* sending message (== tail of
					    out_sent) */
	bool out_msg_done;
	struct ceph_msg_pos out_msg_pos;

	struct kvec out_kvec[8],         /* sending header/footer data */
		*out_kvec_cur;
	int out_kvec_left;   /* kvec's left in out_kvec */
	int out_skip;        /* skip this many bytes */
	int out_kvec_bytes;  /* total bytes left */
	bool out_kvec_is_msg; /* kvec refers to out_msg */
	int out_more;        /* there is more data after the kvecs */
	__le64 out_temp_ack; /* for writing an ack */

	/* message in temps */
	struct ceph_msg_header in_hdr;
	struct ceph_msg *in_msg;
	struct ceph_msg_pos in_msg_pos;
	u32 in_front_crc, in_middle_crc, in_data_crc;  /* calculated crc */

	char in_tag;         /* protocol control byte */
	int in_base_pos;     /* bytes read */
	__le64 in_temp_ack;  /* for reading an ack */

	struct delayed_work work;	    /* send|recv work */
	unsigned long       delay;          /* current delay interval */
};


extern const char *pr_addr(const struct sockaddr_storage *ss);
extern int ceph_parse_ips(const char *c, const char *end,
			  struct ceph_entity_addr *addr,
			  int max_count, int *count);


extern int ceph_msgr_init(void);
extern void ceph_msgr_exit(void);

extern struct ceph_messenger *ceph_messenger_create(
	struct ceph_entity_addr *myaddr);
extern void ceph_messenger_destroy(struct ceph_messenger *);

extern void ceph_con_init(struct ceph_messenger *msgr,
			  struct ceph_connection *con);
extern void ceph_con_open(struct ceph_connection *con,
			  struct ceph_entity_addr *addr);
extern void ceph_con_close(struct ceph_connection *con);
extern void ceph_con_send(struct ceph_connection *con, struct ceph_msg *msg);
extern void ceph_con_revoke(struct ceph_connection *con, struct ceph_msg *msg);
extern void ceph_con_revoke_pages(struct ceph_connection *con,
				  struct page **pages);
extern void ceph_con_keepalive(struct ceph_connection *con);
extern struct ceph_connection *ceph_con_get(struct ceph_connection *con);
extern void ceph_con_put(struct ceph_connection *con);

extern struct ceph_msg *ceph_msg_new(int type, int front_len,
				     int page_len, int page_off,
				     struct page **pages);
extern void ceph_msg_kfree(struct ceph_msg *m);

extern struct ceph_msg *ceph_alloc_msg(struct ceph_connection *con,
				       struct ceph_msg_header *hdr);
extern int ceph_alloc_middle(struct ceph_connection *con, struct ceph_msg *msg);


static inline struct ceph_msg *ceph_msg_get(struct ceph_msg *msg)
{
	kref_get(&msg->kref);
	return msg;
}
extern void ceph_msg_last_put(struct kref *kref);
static inline void ceph_msg_put(struct ceph_msg *msg)
{
	kref_put(&msg->kref, ceph_msg_last_put);
}

extern void ceph_msg_dump(struct ceph_msg *msg);

#endif
Commit	Line	Data
31b8006e SW	1	#ifndef __FS_CEPH_MESSENGER_H
	2	#define __FS_CEPH_MESSENGER_H
	3
c2e552e7	4	#include <linux/kref.h>
31b8006e SW	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
	15	struct ceph_msg;
	16	struct ceph_connection;
	17
	18	extern struct workqueue_struct ceph_msgr_wq; / receive work queue */
	19
	20	/*
	21	* Ceph defines these callbacks for handling connection events.
	22	*/
	23	struct 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
4e7a5dcd SW	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
31b8006e SW	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 (alloc_middle) (struct ceph_connection con,
	49	struct ceph_msg *msg);
	50	/* an incoming message has a data payload; tell me what pages I
	51	* should read the data into. */
	52	int (prepare_pages) (struct ceph_connection con, struct ceph_msg *m,
	53	int want);
	54	};
	55
	56	extern const char *ceph_name_type_str(int t);
	57
	58	/* use format string %s%d */
	59	#define ENTITY_NAME(n) ceph_name_type_str((n).type), le64_to_cpu((n).num)
	60
	61	struct ceph_messenger {
	62	struct ceph_entity_inst inst; /* my name+address */
63f2d211	63	struct ceph_entity_addr my_enc_addr;
31b8006e SW	64	struct page zero_page; / used in certain error cases */
	65
	66	bool nocrc;
	67
	68	/*
	69	* the global_seq counts connections i (attempt to) initiate
	70	* in order to disambiguate certain connect race conditions.
	71	*/
	72	u32 global_seq;
	73	spinlock_t global_seq_lock;
	74	};
	75
	76	/*
	77	* a single message. it contains a header (src, dest, message type, etc.),
	78	* footer (crc values, mainly), a "front" message body, and possibly a
	79	* data payload (stored in some number of pages).
	80	*/
	81	struct ceph_msg {
	82	struct ceph_msg_header hdr; /* header */
	83	struct ceph_msg_footer footer; /* footer */
	84	struct kvec front; /* unaligned blobs of message */
	85	struct ceph_buffer *middle;
	86	struct page *pages; / data payload. NOT OWNER. */
	87	unsigned nr_pages; /* size of page array */
58bb3b37	88	struct ceph_pagelist pagelist; / instead of pages */
31b8006e	89	struct list_head list_head;
c2e552e7	90	struct kref kref;
31b8006e SW	91	bool front_is_vmalloc;
	92	bool more_to_follow;
	93	int front_max;
	94
	95	struct ceph_msgpool *pool;
	96	};
	97
	98	struct ceph_msg_pos {
	99	int page, page_pos; /* which page; offset in page */
	100	int data_pos; /* offset in data payload */
	101	int did_page_crc; /* true if we've calculated crc for current page */
	102	};
	103
	104	/* ceph connection fault delay defaults, for exponential backoff */
	105	#define BASE_DELAY_INTERVAL (HZ/2)
	106	#define MAX_DELAY_INTERVAL (5 * 60 * HZ)
	107
	108	/*
	109	* ceph_connection state bit flags
	110	*
	111	* QUEUED and BUSY are used together to ensure that only a single
	112	* thread is currently opening, reading or writing data to the socket.
	113	*/
	114	#define LOSSYTX 0 /* we can close channel or drop messages on errors */
eed0ef2c SW	115	#define CONNECTING 1
eed0ef2c SW	116	#define NEGOTIATING 2
31b8006e SW	117	#define KEEPALIVE_PENDING 3
	118	#define WRITE_PENDING 4 /* we have data ready to send */
	119	#define QUEUED 5 /* there is work queued on this connection */
	120	#define BUSY 6 /* work is being done */
	121	#define STANDBY 8 /* no outgoing messages, socket closed. we keep
	122	* the ceph_connection around to maintain shared
	123	* state with the peer. */
	124	#define CLOSED 10 /* we've closed the connection */
	125	#define SOCK_CLOSED 11 /* socket state changed to closed */
	126	#define REGISTERED 12 /* connection appears in con_tree */
	127	#define OPENING 13 /* open connection w/ (possibly new) peer */
	128	#define DEAD 14 /* dead, about to kfree */
	129
	130	/*
	131	* A single connection with another host.
	132	*
	133	* We maintain a queue of outgoing messages, and some session state to
	134	* ensure that we can preserve the lossless, ordered delivery of
	135	* messages in the case of a TCP disconnect.
	136	*/
	137	struct ceph_connection {
	138	void *private;
	139	atomic_t nref;
	140
	141	const struct ceph_connection_operations *ops;
	142
	143	struct ceph_messenger *msgr;
	144	struct socket *sock;
	145	unsigned long state; /* connection state (see flags above) */
	146	const char error_msg; / error message, if any */
	147
	148	struct ceph_entity_addr peer_addr; /* peer address */
	149	struct ceph_entity_name peer_name; /* peer name */
	150	struct ceph_entity_addr peer_addr_for_me;
	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
4e7a5dcd SW	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
ec302645 SW	159	struct mutex mutex;
ec302645 SW	160
31b8006e	161	/* out queue */
31b8006e SW	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	u64 out_seq_sent; /* last message sent */
	166	bool out_keepalive_pending;
	167
	168	u64 in_seq, in_seq_acked; /* last message received, acked */
	169
	170	/* connection negotiation temps */
	171	char in_banner[CEPH_BANNER_MAX_LEN];
	172	union {
	173	struct { /* outgoing connection */
	174	struct ceph_msg_connect out_connect;
	175	struct ceph_msg_connect_reply in_reply;
	176	};
	177	struct { /* incoming */
	178	struct ceph_msg_connect in_connect;
	179	struct ceph_msg_connect_reply out_reply;
	180	};
	181	};
	182	struct ceph_entity_addr actual_peer_addr;
	183
	184	/* message out temps */
	185	struct ceph_msg out_msg; / sending message (== tail of
	186	out_sent) */
c86a2930	187	bool out_msg_done;
31b8006e SW	188	struct ceph_msg_pos out_msg_pos;
	189
	190	struct kvec out_kvec[8], /* sending header/footer data */
	191	*out_kvec_cur;
	192	int out_kvec_left; /* kvec's left in out_kvec */
	193	int out_skip; /* skip this many bytes */
	194	int out_kvec_bytes; /* total bytes left */
	195	bool out_kvec_is_msg; /* kvec refers to out_msg */
	196	int out_more; /* there is more data after the kvecs */
	197	__le64 out_temp_ack; /* for writing an ack */
	198
	199	/* message in temps */
	200	struct ceph_msg_header in_hdr;
	201	struct ceph_msg *in_msg;
	202	struct ceph_msg_pos in_msg_pos;
	203	u32 in_front_crc, in_middle_crc, in_data_crc; /* calculated crc */
	204
	205	char in_tag; /* protocol control byte */
	206	int in_base_pos; /* bytes read */
	207	__le64 in_temp_ack; /* for reading an ack */
	208
	209	struct delayed_work work; /* send\|recv work */
	210	unsigned long delay; /* current delay interval */
	211	};
	212
	213
	214	extern const char pr_addr(const struct sockaddr_storage ss);
	215	extern int ceph_parse_ips(const char c, const char end,
	216	struct ceph_entity_addr *addr,
	217	int max_count, int *count);
	218
	219
	220	extern int ceph_msgr_init(void);
	221	extern void ceph_msgr_exit(void);
	222
	223	extern struct ceph_messenger *ceph_messenger_create(
	224	struct ceph_entity_addr *myaddr);
	225	extern void ceph_messenger_destroy(struct ceph_messenger *);
	226
	227	extern void ceph_con_init(struct ceph_messenger *msgr,
	228	struct ceph_connection *con);
31b8006e SW	229	extern void ceph_con_open(struct ceph_connection *con,
	230	struct ceph_entity_addr *addr);
	231	extern void ceph_con_close(struct ceph_connection *con);
	232	extern void ceph_con_send(struct ceph_connection con, struct ceph_msg msg);
	233	extern void ceph_con_revoke(struct ceph_connection con, struct ceph_msg msg);
350b1c32 SW	234	extern void ceph_con_revoke_pages(struct ceph_connection *con,
350b1c32 SW	235	struct page **pages);
31b8006e SW	236	extern void ceph_con_keepalive(struct ceph_connection *con);
	237	extern struct ceph_connection ceph_con_get(struct ceph_connection con);
	238	extern void ceph_con_put(struct ceph_connection *con);
	239
	240	extern struct ceph_msg *ceph_msg_new(int type, int front_len,
	241	int page_len, int page_off,
	242	struct page **pages);
	243	extern void ceph_msg_kfree(struct ceph_msg *m);
	244
	245	extern struct ceph_msg ceph_alloc_msg(struct ceph_connection con,
	246	struct ceph_msg_header *hdr);
	247	extern int ceph_alloc_middle(struct ceph_connection con, struct ceph_msg msg);
	248
	249
	250	static inline struct ceph_msg ceph_msg_get(struct ceph_msg msg)
	251	{
c2e552e7	252	kref_get(&msg->kref);
31b8006e SW	253	return msg;
31b8006e SW	254	}
c2e552e7 SW	255	extern void ceph_msg_last_put(struct kref *kref);
	256	static inline void ceph_msg_put(struct ceph_msg *msg)
	257	{
	258	kref_put(&msg->kref, ceph_msg_last_put);
	259	}
31b8006e	260
9ec7cab1 SW	261	extern void ceph_msg_dump(struct ceph_msg *msg);
9ec7cab1 SW	262
31b8006e	263	#endif