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