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