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