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 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 msecs_to_jiffies(60 * 1000) 67 #define CEPH_OSD_KEEPALIVE_DEFAULT msecs_to_jiffies(5 * 1000) 68 #define CEPH_OSD_IDLE_TTL_DEFAULT msecs_to_jiffies(60 * 1000) 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 static inline unsigned long ceph_timeout_jiffies(unsigned long timeout) 97 { 98 return timeout ?: MAX_SCHEDULE_TIMEOUT; 99 } 100 101 struct ceph_mds_client; 102 103 /* 104 * per client state 105 * 106 * possibly shared by multiple mount points, if they are 107 * mounting the same ceph filesystem/cluster. 108 */ 109 struct ceph_client { 110 struct ceph_fsid fsid; 111 bool have_fsid; 112 113 void *private; 114 115 struct ceph_options *options; 116 117 struct mutex mount_mutex; /* serialize mount attempts */ 118 wait_queue_head_t auth_wq; 119 int auth_err; 120 121 int (*extra_mon_dispatch)(struct ceph_client *, struct ceph_msg *); 122 123 u64 supported_features; 124 u64 required_features; 125 126 struct ceph_messenger msgr; /* messenger instance */ 127 struct ceph_mon_client monc; 128 struct ceph_osd_client osdc; 129 130 #ifdef CONFIG_DEBUG_FS 131 struct dentry *debugfs_dir; 132 struct dentry *debugfs_monmap; 133 struct dentry *debugfs_osdmap; 134 struct dentry *debugfs_options; 135 #endif 136 }; 137 138 139 140 /* 141 * snapshots 142 */ 143 144 /* 145 * A "snap context" is the set of existing snapshots when we 146 * write data. It is used by the OSD to guide its COW behavior. 147 * 148 * The ceph_snap_context is refcounted, and attached to each dirty 149 * page, indicating which context the dirty data belonged when it was 150 * dirtied. 151 */ 152 struct ceph_snap_context { 153 atomic_t nref; 154 u64 seq; 155 u32 num_snaps; 156 u64 snaps[]; 157 }; 158 159 extern struct ceph_snap_context *ceph_create_snap_context(u32 snap_count, 160 gfp_t gfp_flags); 161 extern struct ceph_snap_context *ceph_get_snap_context( 162 struct ceph_snap_context *sc); 163 extern void ceph_put_snap_context(struct ceph_snap_context *sc); 164 165 /* 166 * calculate the number of pages a given length and offset map onto, 167 * if we align the data. 168 */ 169 static inline int calc_pages_for(u64 off, u64 len) 170 { 171 return ((off+len+PAGE_CACHE_SIZE-1) >> PAGE_CACHE_SHIFT) - 172 (off >> PAGE_CACHE_SHIFT); 173 } 174 175 extern struct kmem_cache *ceph_inode_cachep; 176 extern struct kmem_cache *ceph_cap_cachep; 177 extern struct kmem_cache *ceph_cap_flush_cachep; 178 extern struct kmem_cache *ceph_dentry_cachep; 179 extern struct kmem_cache *ceph_file_cachep; 180 181 /* ceph_common.c */ 182 extern bool libceph_compatible(void *data); 183 184 extern const char *ceph_msg_type_name(int type); 185 extern int ceph_check_fsid(struct ceph_client *client, struct ceph_fsid *fsid); 186 extern void *ceph_kvmalloc(size_t size, gfp_t flags); 187 188 extern struct ceph_options *ceph_parse_options(char *options, 189 const char *dev_name, const char *dev_name_end, 190 int (*parse_extra_token)(char *c, void *private), 191 void *private); 192 int ceph_print_client_options(struct seq_file *m, struct ceph_client *client); 193 extern void ceph_destroy_options(struct ceph_options *opt); 194 extern int ceph_compare_options(struct ceph_options *new_opt, 195 struct ceph_client *client); 196 extern struct ceph_client *ceph_create_client(struct ceph_options *opt, 197 void *private, 198 u64 supported_features, 199 u64 required_features); 200 extern u64 ceph_client_id(struct ceph_client *client); 201 extern void ceph_destroy_client(struct ceph_client *client); 202 extern int __ceph_open_session(struct ceph_client *client, 203 unsigned long started); 204 extern int ceph_open_session(struct ceph_client *client); 205 206 /* pagevec.c */ 207 extern void ceph_release_page_vector(struct page **pages, int num_pages); 208 209 extern struct page **ceph_get_direct_page_vector(const void __user *data, 210 int num_pages, 211 bool write_page); 212 extern void ceph_put_page_vector(struct page **pages, int num_pages, 213 bool dirty); 214 extern struct page **ceph_alloc_page_vector(int num_pages, gfp_t flags); 215 extern int ceph_copy_user_to_page_vector(struct page **pages, 216 const void __user *data, 217 loff_t off, size_t len); 218 extern void ceph_copy_to_page_vector(struct page **pages, 219 const void *data, 220 loff_t off, size_t len); 221 extern void ceph_copy_from_page_vector(struct page **pages, 222 void *data, 223 loff_t off, size_t len); 224 extern void ceph_zero_page_vector_range(int off, int len, struct page **pages); 225 226 227 #endif /* _FS_CEPH_SUPER_H */ 228