1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _FS_CEPH_LIBCEPH_H 3 #define _FS_CEPH_LIBCEPH_H 4 5 #include <linux/ceph/ceph_debug.h> 6 7 #include <asm/unaligned.h> 8 #include <linux/backing-dev.h> 9 #include <linux/completion.h> 10 #include <linux/exportfs.h> 11 #include <linux/bug.h> 12 #include <linux/fs.h> 13 #include <linux/mempool.h> 14 #include <linux/pagemap.h> 15 #include <linux/wait.h> 16 #include <linux/writeback.h> 17 #include <linux/slab.h> 18 #include <linux/refcount.h> 19 20 #include <linux/ceph/types.h> 21 #include <linux/ceph/messenger.h> 22 #include <linux/ceph/msgpool.h> 23 #include <linux/ceph/mon_client.h> 24 #include <linux/ceph/osd_client.h> 25 #include <linux/ceph/ceph_fs.h> 26 #include <linux/ceph/string_table.h> 27 28 /* 29 * mount options 30 */ 31 #define CEPH_OPT_FSID (1<<0) 32 #define CEPH_OPT_NOSHARE (1<<1) /* don't share client with other sbs */ 33 #define CEPH_OPT_MYIP (1<<2) /* specified my ip */ 34 #define CEPH_OPT_NOCRC (1<<3) /* no data crc on writes */ 35 #define CEPH_OPT_NOMSGAUTH (1<<4) /* don't require msg signing feat */ 36 #define CEPH_OPT_TCP_NODELAY (1<<5) /* TCP_NODELAY on TCP sockets */ 37 #define CEPH_OPT_NOMSGSIGN (1<<6) /* don't sign msgs */ 38 39 #define CEPH_OPT_DEFAULT (CEPH_OPT_TCP_NODELAY) 40 41 #define ceph_set_opt(client, opt) \ 42 (client)->options->flags |= CEPH_OPT_##opt; 43 #define ceph_test_opt(client, opt) \ 44 (!!((client)->options->flags & CEPH_OPT_##opt)) 45 46 struct ceph_options { 47 int flags; 48 struct ceph_fsid fsid; 49 struct ceph_entity_addr my_addr; 50 unsigned long mount_timeout; /* jiffies */ 51 unsigned long osd_idle_ttl; /* jiffies */ 52 unsigned long osd_keepalive_timeout; /* jiffies */ 53 unsigned long osd_request_timeout; /* jiffies */ 54 55 /* 56 * any type that can't be simply compared or doesn't need need 57 * to be compared should go beyond this point, 58 * ceph_compare_options() should be updated accordingly 59 */ 60 61 struct ceph_entity_addr *mon_addr; /* should be the first 62 pointer type of args */ 63 int num_mon; 64 char *name; 65 struct ceph_crypto_key *key; 66 }; 67 68 /* 69 * defaults 70 */ 71 #define CEPH_MOUNT_TIMEOUT_DEFAULT msecs_to_jiffies(60 * 1000) 72 #define CEPH_OSD_KEEPALIVE_DEFAULT msecs_to_jiffies(5 * 1000) 73 #define CEPH_OSD_IDLE_TTL_DEFAULT msecs_to_jiffies(60 * 1000) 74 #define CEPH_OSD_REQUEST_TIMEOUT_DEFAULT 0 /* no timeout */ 75 76 #define CEPH_MONC_HUNT_INTERVAL msecs_to_jiffies(3 * 1000) 77 #define CEPH_MONC_PING_INTERVAL msecs_to_jiffies(10 * 1000) 78 #define CEPH_MONC_PING_TIMEOUT msecs_to_jiffies(30 * 1000) 79 #define CEPH_MONC_HUNT_BACKOFF 2 80 #define CEPH_MONC_HUNT_MAX_MULT 10 81 82 #define CEPH_MSG_MAX_FRONT_LEN (16*1024*1024) 83 #define CEPH_MSG_MAX_MIDDLE_LEN (16*1024*1024) 84 #define CEPH_MSG_MAX_DATA_LEN (16*1024*1024) 85 86 #define CEPH_AUTH_NAME_DEFAULT "guest" 87 88 /* mount state */ 89 enum { 90 CEPH_MOUNT_MOUNTING, 91 CEPH_MOUNT_MOUNTED, 92 CEPH_MOUNT_UNMOUNTING, 93 CEPH_MOUNT_UNMOUNTED, 94 CEPH_MOUNT_SHUTDOWN, 95 }; 96 97 static inline unsigned long ceph_timeout_jiffies(unsigned long timeout) 98 { 99 return timeout ?: MAX_SCHEDULE_TIMEOUT; 100 } 101 102 struct ceph_mds_client; 103 104 /* 105 * per client state 106 * 107 * possibly shared by multiple mount points, if they are 108 * mounting the same ceph filesystem/cluster. 109 */ 110 struct ceph_client { 111 struct ceph_fsid fsid; 112 bool have_fsid; 113 114 void *private; 115 116 struct ceph_options *options; 117 118 struct mutex mount_mutex; /* serialize mount attempts */ 119 wait_queue_head_t auth_wq; 120 int auth_err; 121 122 int (*extra_mon_dispatch)(struct ceph_client *, struct ceph_msg *); 123 124 u64 supported_features; 125 u64 required_features; 126 127 struct ceph_messenger msgr; /* messenger instance */ 128 struct ceph_mon_client monc; 129 struct ceph_osd_client osdc; 130 131 #ifdef CONFIG_DEBUG_FS 132 struct dentry *debugfs_dir; 133 struct dentry *debugfs_monmap; 134 struct dentry *debugfs_osdmap; 135 struct dentry *debugfs_options; 136 #endif 137 }; 138 139 #define from_msgr(ms) container_of(ms, struct ceph_client, msgr) 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 refcount_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_SIZE-1) >> PAGE_SHIFT) - 174 (off >> PAGE_SHIFT); 175 } 176 177 #define RB_BYVAL(a) (a) 178 #define RB_BYPTR(a) (&(a)) 179 #define RB_CMP3WAY(a, b) ((a) < (b) ? -1 : (a) > (b)) 180 181 #define DEFINE_RB_INSDEL_FUNCS2(name, type, keyfld, cmpexp, keyexp, nodefld) \ 182 static void insert_##name(struct rb_root *root, type *t) \ 183 { \ 184 struct rb_node **n = &root->rb_node; \ 185 struct rb_node *parent = NULL; \ 186 \ 187 BUG_ON(!RB_EMPTY_NODE(&t->nodefld)); \ 188 \ 189 while (*n) { \ 190 type *cur = rb_entry(*n, type, nodefld); \ 191 int cmp; \ 192 \ 193 parent = *n; \ 194 cmp = cmpexp(keyexp(t->keyfld), keyexp(cur->keyfld)); \ 195 if (cmp < 0) \ 196 n = &(*n)->rb_left; \ 197 else if (cmp > 0) \ 198 n = &(*n)->rb_right; \ 199 else \ 200 BUG(); \ 201 } \ 202 \ 203 rb_link_node(&t->nodefld, parent, n); \ 204 rb_insert_color(&t->nodefld, root); \ 205 } \ 206 static void erase_##name(struct rb_root *root, type *t) \ 207 { \ 208 BUG_ON(RB_EMPTY_NODE(&t->nodefld)); \ 209 rb_erase(&t->nodefld, root); \ 210 RB_CLEAR_NODE(&t->nodefld); \ 211 } 212 213 /* 214 * @lookup_param_type is a parameter and not constructed from (@type, 215 * @keyfld) with typeof() because adding const is too unwieldy. 216 */ 217 #define DEFINE_RB_LOOKUP_FUNC2(name, type, keyfld, cmpexp, keyexp, \ 218 lookup_param_type, nodefld) \ 219 static type *lookup_##name(struct rb_root *root, lookup_param_type key) \ 220 { \ 221 struct rb_node *n = root->rb_node; \ 222 \ 223 while (n) { \ 224 type *cur = rb_entry(n, type, nodefld); \ 225 int cmp; \ 226 \ 227 cmp = cmpexp(key, keyexp(cur->keyfld)); \ 228 if (cmp < 0) \ 229 n = n->rb_left; \ 230 else if (cmp > 0) \ 231 n = n->rb_right; \ 232 else \ 233 return cur; \ 234 } \ 235 \ 236 return NULL; \ 237 } 238 239 #define DEFINE_RB_FUNCS2(name, type, keyfld, cmpexp, keyexp, \ 240 lookup_param_type, nodefld) \ 241 DEFINE_RB_INSDEL_FUNCS2(name, type, keyfld, cmpexp, keyexp, nodefld) \ 242 DEFINE_RB_LOOKUP_FUNC2(name, type, keyfld, cmpexp, keyexp, \ 243 lookup_param_type, nodefld) 244 245 /* 246 * Shorthands for integer keys. 247 */ 248 #define DEFINE_RB_INSDEL_FUNCS(name, type, keyfld, nodefld) \ 249 DEFINE_RB_INSDEL_FUNCS2(name, type, keyfld, RB_CMP3WAY, RB_BYVAL, nodefld) 250 251 #define DEFINE_RB_LOOKUP_FUNC(name, type, keyfld, nodefld) \ 252 extern type __lookup_##name##_key; \ 253 DEFINE_RB_LOOKUP_FUNC2(name, type, keyfld, RB_CMP3WAY, RB_BYVAL, \ 254 typeof(__lookup_##name##_key.keyfld), nodefld) 255 256 #define DEFINE_RB_FUNCS(name, type, keyfld, nodefld) \ 257 DEFINE_RB_INSDEL_FUNCS(name, type, keyfld, nodefld) \ 258 DEFINE_RB_LOOKUP_FUNC(name, type, keyfld, nodefld) 259 260 extern struct kmem_cache *ceph_inode_cachep; 261 extern struct kmem_cache *ceph_cap_cachep; 262 extern struct kmem_cache *ceph_cap_flush_cachep; 263 extern struct kmem_cache *ceph_dentry_cachep; 264 extern struct kmem_cache *ceph_file_cachep; 265 266 /* ceph_common.c */ 267 extern bool libceph_compatible(void *data); 268 269 extern const char *ceph_msg_type_name(int type); 270 extern int ceph_check_fsid(struct ceph_client *client, struct ceph_fsid *fsid); 271 extern void *ceph_kvmalloc(size_t size, gfp_t flags); 272 273 extern struct ceph_options *ceph_parse_options(char *options, 274 const char *dev_name, const char *dev_name_end, 275 int (*parse_extra_token)(char *c, void *private), 276 void *private); 277 int ceph_print_client_options(struct seq_file *m, struct ceph_client *client); 278 extern void ceph_destroy_options(struct ceph_options *opt); 279 extern int ceph_compare_options(struct ceph_options *new_opt, 280 struct ceph_client *client); 281 struct ceph_client *ceph_create_client(struct ceph_options *opt, void *private); 282 struct ceph_entity_addr *ceph_client_addr(struct ceph_client *client); 283 u64 ceph_client_gid(struct ceph_client *client); 284 extern void ceph_destroy_client(struct ceph_client *client); 285 extern int __ceph_open_session(struct ceph_client *client, 286 unsigned long started); 287 extern int ceph_open_session(struct ceph_client *client); 288 289 /* pagevec.c */ 290 extern void ceph_release_page_vector(struct page **pages, int num_pages); 291 292 extern struct page **ceph_get_direct_page_vector(const void __user *data, 293 int num_pages, 294 bool write_page); 295 extern void ceph_put_page_vector(struct page **pages, int num_pages, 296 bool dirty); 297 extern struct page **ceph_alloc_page_vector(int num_pages, gfp_t flags); 298 extern int ceph_copy_user_to_page_vector(struct page **pages, 299 const void __user *data, 300 loff_t off, size_t len); 301 extern void ceph_copy_to_page_vector(struct page **pages, 302 const void *data, 303 loff_t off, size_t len); 304 extern void ceph_copy_from_page_vector(struct page **pages, 305 void *data, 306 loff_t off, size_t len); 307 extern void ceph_zero_page_vector_range(int off, int len, struct page **pages); 308 309 310 #endif /* _FS_CEPH_SUPER_H */ 311