[linux-2.6-block.git] / include / linux / ceph / libceph.h

#ifndef _FS_CEPH_LIBCEPH_H
#define _FS_CEPH_LIBCEPH_H

#include <linux/ceph/ceph_debug.h>

#include <asm/unaligned.h>
#include <linux/backing-dev.h>
#include <linux/completion.h>
#include <linux/exportfs.h>
#include <linux/bug.h>
#include <linux/fs.h>
#include <linux/mempool.h>
#include <linux/pagemap.h>
#include <linux/wait.h>
#include <linux/writeback.h>
#include <linux/slab.h>

#include <linux/ceph/types.h>
#include <linux/ceph/messenger.h>
#include <linux/ceph/msgpool.h>
#include <linux/ceph/mon_client.h>
#include <linux/ceph/osd_client.h>
#include <linux/ceph/ceph_fs.h>

/*
 * mount options
 */
#define CEPH_OPT_FSID             (1<<0)
#define CEPH_OPT_NOSHARE          (1<<1) /* don't share client with other sbs */
#define CEPH_OPT_MYIP             (1<<2) /* specified my ip */
#define CEPH_OPT_NOCRC            (1<<3) /* no data crc on writes */
#define CEPH_OPT_NOMSGAUTH	  (1<<4) /* don't require msg signing feat */
#define CEPH_OPT_TCP_NODELAY	  (1<<5) /* TCP_NODELAY on TCP sockets */
#define CEPH_OPT_NOMSGSIGN	  (1<<6) /* don't sign msgs */

#define CEPH_OPT_DEFAULT   (CEPH_OPT_TCP_NODELAY)

#define ceph_set_opt(client, opt) \
	(client)->options->flags |= CEPH_OPT_##opt;
#define ceph_test_opt(client, opt) \
	(!!((client)->options->flags & CEPH_OPT_##opt))

struct ceph_options {
	int flags;
	struct ceph_fsid fsid;
	struct ceph_entity_addr my_addr;
	unsigned long mount_timeout;		/* jiffies */
	unsigned long osd_idle_ttl;		/* jiffies */
	unsigned long osd_keepalive_timeout;	/* jiffies */
	unsigned long monc_ping_timeout;	/* jiffies */

	/*
	 * any type that can't be simply compared or doesn't need need
	 * to be compared should go beyond this point,
	 * ceph_compare_options() should be updated accordingly
	 */

	struct ceph_entity_addr *mon_addr; /* should be the first
					      pointer type of args */
	int num_mon;
	char *name;
	struct ceph_crypto_key *key;
};

/*
 * defaults
 */
#define CEPH_MOUNT_TIMEOUT_DEFAULT	msecs_to_jiffies(60 * 1000)
#define CEPH_OSD_KEEPALIVE_DEFAULT	msecs_to_jiffies(5 * 1000)
#define CEPH_OSD_IDLE_TTL_DEFAULT	msecs_to_jiffies(60 * 1000)
#define CEPH_MONC_PING_TIMEOUT_DEFAULT	msecs_to_jiffies(30 * 1000)

#define CEPH_MSG_MAX_FRONT_LEN	(16*1024*1024)
#define CEPH_MSG_MAX_MIDDLE_LEN	(16*1024*1024)
#define CEPH_MSG_MAX_DATA_LEN	(16*1024*1024)

#define CEPH_AUTH_NAME_DEFAULT   "guest"

/*
 * Delay telling the MDS we no longer want caps, in case we reopen
 * the file.  Delay a minimum amount of time, even if we send a cap
 * message for some other reason.  Otherwise, take the oppotunity to
 * update the mds to avoid sending another message later.
 */
#define CEPH_CAPS_WANTED_DELAY_MIN_DEFAULT      5  /* cap release delay */
#define CEPH_CAPS_WANTED_DELAY_MAX_DEFAULT     60  /* cap release delay */

#define CEPH_CAP_RELEASE_SAFETY_DEFAULT        (CEPH_CAPS_PER_RELEASE * 4)

/* mount state */
enum {
	CEPH_MOUNT_MOUNTING,
	CEPH_MOUNT_MOUNTED,
	CEPH_MOUNT_UNMOUNTING,
	CEPH_MOUNT_UNMOUNTED,
	CEPH_MOUNT_SHUTDOWN,
};

static inline unsigned long ceph_timeout_jiffies(unsigned long timeout)
{
	return timeout ?: MAX_SCHEDULE_TIMEOUT;
}

struct ceph_mds_client;

/*
 * per client state
 *
 * possibly shared by multiple mount points, if they are
 * mounting the same ceph filesystem/cluster.
 */
struct ceph_client {
	struct ceph_fsid fsid;
	bool have_fsid;

	void *private;

	struct ceph_options *options;

	struct mutex mount_mutex;      /* serialize mount attempts */
	wait_queue_head_t auth_wq;
	int auth_err;

	int (*extra_mon_dispatch)(struct ceph_client *, struct ceph_msg *);

	u64 supported_features;
	u64 required_features;

	struct ceph_messenger msgr;   /* messenger instance */
	struct ceph_mon_client monc;
	struct ceph_osd_client osdc;

#ifdef CONFIG_DEBUG_FS
	struct dentry *debugfs_dir;
	struct dentry *debugfs_monmap;
	struct dentry *debugfs_osdmap;
	struct dentry *debugfs_options;
#endif
};

#define from_msgr(ms)	container_of(ms, struct ceph_client, msgr)


/*
 * snapshots
 */

/*
 * A "snap context" is the set of existing snapshots when we
 * write data.  It is used by the OSD to guide its COW behavior.
 *
 * The ceph_snap_context is refcounted, and attached to each dirty
 * page, indicating which context the dirty data belonged when it was
 * dirtied.
 */
struct ceph_snap_context {
	atomic_t nref;
	u64 seq;
	u32 num_snaps;
	u64 snaps[];
};

extern struct ceph_snap_context *ceph_create_snap_context(u32 snap_count,
					gfp_t gfp_flags);
extern struct ceph_snap_context *ceph_get_snap_context(
					struct ceph_snap_context *sc);
extern void ceph_put_snap_context(struct ceph_snap_context *sc);

/*
 * calculate the number of pages a given length and offset map onto,
 * if we align the data.
 */
static inline int calc_pages_for(u64 off, u64 len)
{
	return ((off+len+PAGE_CACHE_SIZE-1) >> PAGE_CACHE_SHIFT) -
		(off >> PAGE_CACHE_SHIFT);
}

extern struct kmem_cache *ceph_inode_cachep;
extern struct kmem_cache *ceph_cap_cachep;
extern struct kmem_cache *ceph_cap_flush_cachep;
extern struct kmem_cache *ceph_dentry_cachep;
extern struct kmem_cache *ceph_file_cachep;

/* ceph_common.c */
extern bool libceph_compatible(void *data);

extern const char *ceph_msg_type_name(int type);
extern int ceph_check_fsid(struct ceph_client *client, struct ceph_fsid *fsid);
extern void *ceph_kvmalloc(size_t size, gfp_t flags);

extern struct ceph_options *ceph_parse_options(char *options,
			      const char *dev_name, const char *dev_name_end,
			      int (*parse_extra_token)(char *c, void *private),
			      void *private);
int ceph_print_client_options(struct seq_file *m, struct ceph_client *client);
extern void ceph_destroy_options(struct ceph_options *opt);
extern int ceph_compare_options(struct ceph_options *new_opt,
				struct ceph_client *client);
extern struct ceph_client *ceph_create_client(struct ceph_options *opt,
					      void *private,
					      u64 supported_features,
					      u64 required_features);
extern u64 ceph_client_id(struct ceph_client *client);
extern void ceph_destroy_client(struct ceph_client *client);
extern int __ceph_open_session(struct ceph_client *client,
			       unsigned long started);
extern int ceph_open_session(struct ceph_client *client);

/* pagevec.c */
extern void ceph_release_page_vector(struct page **pages, int num_pages);

extern struct page **ceph_get_direct_page_vector(const void __user *data,
						 int num_pages,
						 bool write_page);
extern void ceph_put_page_vector(struct page **pages, int num_pages,
				 bool dirty);
extern struct page **ceph_alloc_page_vector(int num_pages, gfp_t flags);
extern int ceph_copy_user_to_page_vector(struct page **pages,
					 const void __user *data,
					 loff_t off, size_t len);
extern void ceph_copy_to_page_vector(struct page **pages,
				    const void *data,
				    loff_t off, size_t len);
extern void ceph_copy_from_page_vector(struct page **pages,
				    void *data,
				    loff_t off, size_t len);
extern void ceph_zero_page_vector_range(int off, int len, struct page **pages);


#endif /* _FS_CEPH_SUPER_H */
Commit	Line	Data
3d14c5d2 YS	1	#ifndef _FS_CEPH_LIBCEPH_H
	2	#define _FS_CEPH_LIBCEPH_H
	3
a1ce3928	4	#include <linux/ceph/ceph_debug.h>
3d14c5d2 YS	5
	6	#include <asm/unaligned.h>
	7	#include <linux/backing-dev.h>
	8	#include <linux/completion.h>
	9	#include <linux/exportfs.h>
187f1882	10	#include <linux/bug.h>
3d14c5d2 YS	11	#include <linux/fs.h>
	12	#include <linux/mempool.h>
	13	#include <linux/pagemap.h>
	14	#include <linux/wait.h>
	15	#include <linux/writeback.h>
	16	#include <linux/slab.h>
	17
a1ce3928 DH	18	#include <linux/ceph/types.h>
	19	#include <linux/ceph/messenger.h>
	20	#include <linux/ceph/msgpool.h>
	21	#include <linux/ceph/mon_client.h>
	22	#include <linux/ceph/osd_client.h>
	23	#include <linux/ceph/ceph_fs.h>
3d14c5d2	24
3d14c5d2 YS	25	/*
	26	* mount options
	27	*/
	28	#define CEPH_OPT_FSID (1<<0)
	29	#define CEPH_OPT_NOSHARE (1<<1) /* don't share client with other sbs */
	30	#define CEPH_OPT_MYIP (1<<2) /* specified my ip */
	31	#define CEPH_OPT_NOCRC (1<<3) /* no data crc on writes */
a51983e4	32	#define CEPH_OPT_NOMSGAUTH (1<<4) /* don't require msg signing feat */
ba988f87	33	#define CEPH_OPT_TCP_NODELAY (1<<5) /* TCP_NODELAY on TCP sockets */
a51983e4	34	#define CEPH_OPT_NOMSGSIGN (1<<6) /* don't sign msgs */
3d14c5d2	35
ba988f87	36	#define CEPH_OPT_DEFAULT (CEPH_OPT_TCP_NODELAY)
3d14c5d2 YS	37
	38	#define ceph_set_opt(client, opt) \
	39	(client)->options->flags \|= CEPH_OPT_##opt;
	40	#define ceph_test_opt(client, opt) \
	41	(!!((client)->options->flags & CEPH_OPT_##opt))
	42
	43	struct ceph_options {
	44	int flags;
	45	struct ceph_fsid fsid;
	46	struct ceph_entity_addr my_addr;
a319bf56 ID	47	unsigned long mount_timeout; /* jiffies */
	48	unsigned long osd_idle_ttl; /* jiffies */
	49	unsigned long osd_keepalive_timeout; /* jiffies */
8b9558aa	50	unsigned long monc_ping_timeout; /* jiffies */
3d14c5d2 YS	51
	52	/*
	53	* any type that can't be simply compared or doesn't need need
	54	* to be compared should go beyond this point,
	55	* ceph_compare_options() should be updated accordingly
	56	*/
	57
	58	struct ceph_entity_addr mon_addr; / should be the first
	59	pointer type of args */
	60	int num_mon;
	61	char *name;
8323c3aa	62	struct ceph_crypto_key *key;
3d14c5d2 YS	63	};
	64
	65	/*
	66	* defaults
	67	*/
a319bf56 ID	68	#define CEPH_MOUNT_TIMEOUT_DEFAULT msecs_to_jiffies(60 * 1000)
	69	#define CEPH_OSD_KEEPALIVE_DEFAULT msecs_to_jiffies(5 * 1000)
	70	#define CEPH_OSD_IDLE_TTL_DEFAULT msecs_to_jiffies(60 * 1000)
8b9558aa	71	#define CEPH_MONC_PING_TIMEOUT_DEFAULT msecs_to_jiffies(30 * 1000)
3d14c5d2 YS	72
3d14c5d2 YS	73	#define CEPH_MSG_MAX_FRONT_LEN (1610241024)
7b11ba37	74	#define CEPH_MSG_MAX_MIDDLE_LEN (1610241024)
3d14c5d2 YS	75	#define CEPH_MSG_MAX_DATA_LEN (1610241024)
	76
	77	#define CEPH_AUTH_NAME_DEFAULT "guest"
	78
	79	/*
	80	* Delay telling the MDS we no longer want caps, in case we reopen
	81	* the file. Delay a minimum amount of time, even if we send a cap
	82	* message for some other reason. Otherwise, take the oppotunity to
	83	* update the mds to avoid sending another message later.
	84	*/
	85	#define CEPH_CAPS_WANTED_DELAY_MIN_DEFAULT 5 /* cap release delay */
	86	#define CEPH_CAPS_WANTED_DELAY_MAX_DEFAULT 60 /* cap release delay */
	87
	88	#define CEPH_CAP_RELEASE_SAFETY_DEFAULT (CEPH_CAPS_PER_RELEASE * 4)
	89
	90	/* mount state */
	91	enum {
	92	CEPH_MOUNT_MOUNTING,
	93	CEPH_MOUNT_MOUNTED,
	94	CEPH_MOUNT_UNMOUNTING,
	95	CEPH_MOUNT_UNMOUNTED,
	96	CEPH_MOUNT_SHUTDOWN,
	97	};
	98
a319bf56 ID	99	static inline unsigned long ceph_timeout_jiffies(unsigned long timeout)
	100	{
	101	return timeout ?: MAX_SCHEDULE_TIMEOUT;
	102	}
	103
3d14c5d2 YS	104	struct ceph_mds_client;
	105
	106	/*
	107	* per client state
	108	*
	109	* possibly shared by multiple mount points, if they are
	110	* mounting the same ceph filesystem/cluster.
	111	*/
	112	struct ceph_client {
	113	struct ceph_fsid fsid;
	114	bool have_fsid;
	115
	116	void *private;
	117
	118	struct ceph_options *options;
	119
	120	struct mutex mount_mutex; /* serialize mount attempts */
	121	wait_queue_head_t auth_wq;
	122	int auth_err;
	123
	124	int (extra_mon_dispatch)(struct ceph_client , struct ceph_msg *);
	125
12b4629a ID	126	u64 supported_features;
12b4629a ID	127	u64 required_features;
3d14c5d2	128
15d9882c	129	struct ceph_messenger msgr; /* messenger instance */
3d14c5d2 YS	130	struct ceph_mon_client monc;
	131	struct ceph_osd_client osdc;
	132
	133	#ifdef CONFIG_DEBUG_FS
	134	struct dentry *debugfs_dir;
	135	struct dentry *debugfs_monmap;
	136	struct dentry *debugfs_osdmap;
5cf7bd30	137	struct dentry *debugfs_options;
3d14c5d2 YS	138	#endif
	139	};
	140
859bff51	141	#define from_msgr(ms) container_of(ms, struct ceph_client, msgr)
3d14c5d2 YS	142
	143
	144	/*
	145	* snapshots
	146	*/
	147
	148	/*
	149	* A "snap context" is the set of existing snapshots when we
	150	* write data. It is used by the OSD to guide its COW behavior.
	151	*
	152	* The ceph_snap_context is refcounted, and attached to each dirty
	153	* page, indicating which context the dirty data belonged when it was
	154	* dirtied.
	155	*/
	156	struct ceph_snap_context {
	157	atomic_t nref;
	158	u64 seq;
aa711ee3	159	u32 num_snaps;
3d14c5d2 YS	160	u64 snaps[];
	161	};
	162
4f0dcb10 AE	163	extern struct ceph_snap_context *ceph_create_snap_context(u32 snap_count,
	164	gfp_t gfp_flags);
	165	extern struct ceph_snap_context *ceph_get_snap_context(
	166	struct ceph_snap_context *sc);
	167	extern void ceph_put_snap_context(struct ceph_snap_context *sc);
3d14c5d2 YS	168
	169	/*
	170	* calculate the number of pages a given length and offset map onto,
	171	* if we align the data.
	172	*/
	173	static inline int calc_pages_for(u64 off, u64 len)
	174	{
	175	return ((off+len+PAGE_CACHE_SIZE-1) >> PAGE_CACHE_SHIFT) -
	176	(off >> PAGE_CACHE_SHIFT);
	177	}
	178
eeb0bed5 ID	179	extern struct kmem_cache *ceph_inode_cachep;
eeb0bed5 ID	180	extern struct kmem_cache *ceph_cap_cachep;
f66fd9f0	181	extern struct kmem_cache *ceph_cap_flush_cachep;
eeb0bed5 ID	182	extern struct kmem_cache *ceph_dentry_cachep;
	183	extern struct kmem_cache *ceph_file_cachep;
	184
3d14c5d2	185	/* ceph_common.c */
72fe25e3 AE	186	extern bool libceph_compatible(void *data);
72fe25e3 AE	187
3d14c5d2 YS	188	extern const char *ceph_msg_type_name(int type);
3d14c5d2 YS	189	extern int ceph_check_fsid(struct ceph_client client, struct ceph_fsid fsid);
eeb0bed5	190	extern void *ceph_kvmalloc(size_t size, gfp_t flags);
3d14c5d2	191
ee57741c	192	extern struct ceph_options ceph_parse_options(char options,
3d14c5d2 YS	193	const char dev_name, const char dev_name_end,
	194	int (parse_extra_token)(char c, void *private),
	195	void *private);
ff40f9ae	196	int ceph_print_client_options(struct seq_file m, struct ceph_client client);
3d14c5d2 YS	197	extern void ceph_destroy_options(struct ceph_options *opt);
	198	extern int ceph_compare_options(struct ceph_options *new_opt,
	199	struct ceph_client *client);
	200	extern struct ceph_client ceph_create_client(struct ceph_options opt,
6ab00d46	201	void *private,
12b4629a ID	202	u64 supported_features,
12b4629a ID	203	u64 required_features);
3d14c5d2 YS	204	extern u64 ceph_client_id(struct ceph_client *client);
	205	extern void ceph_destroy_client(struct ceph_client *client);
	206	extern int __ceph_open_session(struct ceph_client *client,
	207	unsigned long started);
	208	extern int ceph_open_session(struct ceph_client *client);
	209
	210	/* pagevec.c */
	211	extern void ceph_release_page_vector(struct page **pages, int num_pages);
	212
b324814e	213	extern struct page *ceph_get_direct_page_vector(const void __user data,
b6aa5901 HC	214	int num_pages,
	215	bool write_page);
	216	extern void ceph_put_page_vector(struct page **pages, int num_pages,
	217	bool dirty);
3d14c5d2 YS	218	extern struct page **ceph_alloc_page_vector(int num_pages, gfp_t flags);
3d14c5d2 YS	219	extern int ceph_copy_user_to_page_vector(struct page **pages,
b324814e	220	const void __user *data,
3d14c5d2	221	loff_t off, size_t len);
903bb32e	222	extern void ceph_copy_to_page_vector(struct page **pages,
b324814e	223	const void *data,
3d14c5d2	224	loff_t off, size_t len);
903bb32e	225	extern void ceph_copy_from_page_vector(struct page **pages,
b324814e	226	void *data,
3d14c5d2	227	loff_t off, size_t len);
3d14c5d2 YS	228	extern void ceph_zero_page_vector_range(int off, int len, struct page **pages);
	229
	230
	231	#endif /* _FS_CEPH_SUPER_H */