1#ifndef _FS_CEPH_LIBCEPH_H 2#define _FS_CEPH_LIBCEPH_H 3 4#include <linux/ceph/ceph_debug.h> 5 6#include <asm/unaligned.h> 7#include <linux/backing-dev.h> 8#include <linux/completion.h> 9#include <linux/exportfs.h> 10#include <linux/bug.h> 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 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> 24 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 */ 32#define CEPH_OPT_NOMSGAUTH (1<<4) /* don't require msg signing feat */ 33#define CEPH_OPT_TCP_NODELAY (1<<5) /* TCP_NODELAY on TCP sockets */ 34#define CEPH_OPT_NOMSGSIGN (1<<6) /* don't sign msgs */ 35 36#define CEPH_OPT_DEFAULT (CEPH_OPT_TCP_NODELAY) 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 43struct ceph_options { 44 int flags; 45 struct ceph_fsid fsid; 46 struct ceph_entity_addr my_addr; 47 unsigned long mount_timeout; /* jiffies */ 48 unsigned long osd_idle_ttl; /* jiffies */ 49 unsigned long osd_keepalive_timeout; /* jiffies */ 50 unsigned long monc_ping_timeout; /* jiffies */ 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; 62 struct ceph_crypto_key *key; 63}; 64 65/* 66 * defaults 67 */ 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) 71#define CEPH_MONC_PING_TIMEOUT_DEFAULT msecs_to_jiffies(30 * 1000) 72 73#define CEPH_MSG_MAX_FRONT_LEN (16*1024*1024) 74#define CEPH_MSG_MAX_MIDDLE_LEN (16*1024*1024) 75#define CEPH_MSG_MAX_DATA_LEN (16*1024*1024) 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 */ 91enum { 92 CEPH_MOUNT_MOUNTING, 93 CEPH_MOUNT_MOUNTED, 94 CEPH_MOUNT_UNMOUNTING, 95 CEPH_MOUNT_UNMOUNTED, 96 CEPH_MOUNT_SHUTDOWN, 97}; 98 99static inline unsigned long ceph_timeout_jiffies(unsigned long timeout) 100{ 101 return timeout ?: MAX_SCHEDULE_TIMEOUT; 102} 103 104struct 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 */ 112struct 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 126 u64 supported_features; 127 u64 required_features; 128 129 struct ceph_messenger msgr; /* messenger instance */ 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; 137 struct dentry *debugfs_options; 138#endif 139}; 140 141#define from_msgr(ms) container_of(ms, struct ceph_client, msgr) 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 */ 156struct ceph_snap_context { 157 atomic_t nref; 158 u64 seq; 159 u32 num_snaps; 160 u64 snaps[]; 161}; 162 163extern struct ceph_snap_context *ceph_create_snap_context(u32 snap_count, 164 gfp_t gfp_flags); 165extern struct ceph_snap_context *ceph_get_snap_context( 166 struct ceph_snap_context *sc); 167extern void ceph_put_snap_context(struct ceph_snap_context *sc); 168 169/* 170 * calculate the number of pages a given length and offset map onto, 171 * if we align the data. 172 */ 173static 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 179extern struct kmem_cache *ceph_inode_cachep; 180extern struct kmem_cache *ceph_cap_cachep; 181extern struct kmem_cache *ceph_cap_flush_cachep; 182extern struct kmem_cache *ceph_dentry_cachep; 183extern struct kmem_cache *ceph_file_cachep; 184 185/* ceph_common.c */ 186extern bool libceph_compatible(void *data); 187 188extern const char *ceph_msg_type_name(int type); 189extern int ceph_check_fsid(struct ceph_client *client, struct ceph_fsid *fsid); 190extern void *ceph_kvmalloc(size_t size, gfp_t flags); 191 192extern struct ceph_options *ceph_parse_options(char *options, 193 const char *dev_name, const char *dev_name_end, 194 int (*parse_extra_token)(char *c, void *private), 195 void *private); 196int ceph_print_client_options(struct seq_file *m, struct ceph_client *client); 197extern void ceph_destroy_options(struct ceph_options *opt); 198extern int ceph_compare_options(struct ceph_options *new_opt, 199 struct ceph_client *client); 200extern struct ceph_client *ceph_create_client(struct ceph_options *opt, 201 void *private, 202 u64 supported_features, 203 u64 required_features); 204extern u64 ceph_client_id(struct ceph_client *client); 205extern void ceph_destroy_client(struct ceph_client *client); 206extern int __ceph_open_session(struct ceph_client *client, 207 unsigned long started); 208extern int ceph_open_session(struct ceph_client *client); 209 210/* pagevec.c */ 211extern void ceph_release_page_vector(struct page **pages, int num_pages); 212 213extern struct page **ceph_get_direct_page_vector(const void __user *data, 214 int num_pages, 215 bool write_page); 216extern void ceph_put_page_vector(struct page **pages, int num_pages, 217 bool dirty); 218extern struct page **ceph_alloc_page_vector(int num_pages, gfp_t flags); 219extern int ceph_copy_user_to_page_vector(struct page **pages, 220 const void __user *data, 221 loff_t off, size_t len); 222extern void ceph_copy_to_page_vector(struct page **pages, 223 const void *data, 224 loff_t off, size_t len); 225extern void ceph_copy_from_page_vector(struct page **pages, 226 void *data, 227 loff_t off, size_t len); 228extern void ceph_zero_page_vector_range(int off, int len, struct page **pages); 229 230 231#endif /* _FS_CEPH_SUPER_H */ 232