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
43 struct 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
76 /*
77 * Handle the largest possible rbd object in one message.
78 * There is no limit on the size of cephfs objects, but it has to obey
79 * rsize and wsize mount options anyway.
80 */
81 #define CEPH_MSG_MAX_DATA_LEN (32*1024*1024)
82
83 #define CEPH_AUTH_NAME_DEFAULT "guest"
84
85 /*
86 * Delay telling the MDS we no longer want caps, in case we reopen
87 * the file. Delay a minimum amount of time, even if we send a cap
88 * message for some other reason. Otherwise, take the oppotunity to
89 * update the mds to avoid sending another message later.
90 */
91 #define CEPH_CAPS_WANTED_DELAY_MIN_DEFAULT 5 /* cap release delay */
92 #define CEPH_CAPS_WANTED_DELAY_MAX_DEFAULT 60 /* cap release delay */
93
94 #define CEPH_CAP_RELEASE_SAFETY_DEFAULT (CEPH_CAPS_PER_RELEASE * 4)
95
96 /* mount state */
97 enum {
98 CEPH_MOUNT_MOUNTING,
99 CEPH_MOUNT_MOUNTED,
100 CEPH_MOUNT_UNMOUNTING,
101 CEPH_MOUNT_UNMOUNTED,
102 CEPH_MOUNT_SHUTDOWN,
103 };
104
ceph_timeout_jiffies(unsigned long timeout)105 static inline unsigned long ceph_timeout_jiffies(unsigned long timeout)
106 {
107 return timeout ?: MAX_SCHEDULE_TIMEOUT;
108 }
109
110 struct ceph_mds_client;
111
112 /*
113 * per client state
114 *
115 * possibly shared by multiple mount points, if they are
116 * mounting the same ceph filesystem/cluster.
117 */
118 struct ceph_client {
119 struct ceph_fsid fsid;
120 bool have_fsid;
121
122 void *private;
123
124 struct ceph_options *options;
125
126 struct mutex mount_mutex; /* serialize mount attempts */
127 wait_queue_head_t auth_wq;
128 int auth_err;
129
130 int (*extra_mon_dispatch)(struct ceph_client *, struct ceph_msg *);
131
132 u64 supported_features;
133 u64 required_features;
134
135 struct ceph_messenger msgr; /* messenger instance */
136 struct ceph_mon_client monc;
137 struct ceph_osd_client osdc;
138
139 #ifdef CONFIG_DEBUG_FS
140 struct dentry *debugfs_dir;
141 struct dentry *debugfs_monmap;
142 struct dentry *debugfs_osdmap;
143 struct dentry *debugfs_options;
144 #endif
145 };
146
147 #define from_msgr(ms) container_of(ms, struct ceph_client, msgr)
148
149
150 /*
151 * snapshots
152 */
153
154 /*
155 * A "snap context" is the set of existing snapshots when we
156 * write data. It is used by the OSD to guide its COW behavior.
157 *
158 * The ceph_snap_context is refcounted, and attached to each dirty
159 * page, indicating which context the dirty data belonged when it was
160 * dirtied.
161 */
162 struct ceph_snap_context {
163 atomic_t nref;
164 u64 seq;
165 u32 num_snaps;
166 u64 snaps[];
167 };
168
169 extern struct ceph_snap_context *ceph_create_snap_context(u32 snap_count,
170 gfp_t gfp_flags);
171 extern struct ceph_snap_context *ceph_get_snap_context(
172 struct ceph_snap_context *sc);
173 extern void ceph_put_snap_context(struct ceph_snap_context *sc);
174
175 /*
176 * calculate the number of pages a given length and offset map onto,
177 * if we align the data.
178 */
calc_pages_for(u64 off,u64 len)179 static inline int calc_pages_for(u64 off, u64 len)
180 {
181 return ((off+len+PAGE_CACHE_SIZE-1) >> PAGE_CACHE_SHIFT) -
182 (off >> PAGE_CACHE_SHIFT);
183 }
184
185 extern struct kmem_cache *ceph_inode_cachep;
186 extern struct kmem_cache *ceph_cap_cachep;
187 extern struct kmem_cache *ceph_cap_flush_cachep;
188 extern struct kmem_cache *ceph_dentry_cachep;
189 extern struct kmem_cache *ceph_file_cachep;
190
191 /* ceph_common.c */
192 extern bool libceph_compatible(void *data);
193
194 extern const char *ceph_msg_type_name(int type);
195 extern int ceph_check_fsid(struct ceph_client *client, struct ceph_fsid *fsid);
196 extern void *ceph_kvmalloc(size_t size, gfp_t flags);
197
198 extern struct ceph_options *ceph_parse_options(char *options,
199 const char *dev_name, const char *dev_name_end,
200 int (*parse_extra_token)(char *c, void *private),
201 void *private);
202 int ceph_print_client_options(struct seq_file *m, struct ceph_client *client);
203 extern void ceph_destroy_options(struct ceph_options *opt);
204 extern int ceph_compare_options(struct ceph_options *new_opt,
205 struct ceph_client *client);
206 extern struct ceph_client *ceph_create_client(struct ceph_options *opt,
207 void *private,
208 u64 supported_features,
209 u64 required_features);
210 extern u64 ceph_client_id(struct ceph_client *client);
211 extern void ceph_destroy_client(struct ceph_client *client);
212 extern int __ceph_open_session(struct ceph_client *client,
213 unsigned long started);
214 extern int ceph_open_session(struct ceph_client *client);
215
216 /* pagevec.c */
217 extern void ceph_release_page_vector(struct page **pages, int num_pages);
218
219 extern struct page **ceph_get_direct_page_vector(const void __user *data,
220 int num_pages,
221 bool write_page);
222 extern void ceph_put_page_vector(struct page **pages, int num_pages,
223 bool dirty);
224 extern struct page **ceph_alloc_page_vector(int num_pages, gfp_t flags);
225 extern int ceph_copy_user_to_page_vector(struct page **pages,
226 const void __user *data,
227 loff_t off, size_t len);
228 extern void ceph_copy_to_page_vector(struct page **pages,
229 const void *data,
230 loff_t off, size_t len);
231 extern void ceph_copy_from_page_vector(struct page **pages,
232 void *data,
233 loff_t off, size_t len);
234 extern void ceph_zero_page_vector_range(int off, int len, struct page **pages);
235
236
237 #endif /* _FS_CEPH_SUPER_H */
238