1 // SPDX-License-Identifier: GPL-2.0-only
3 #include <linux/ceph/ceph_debug.h>
5 #include <linux/backing-dev.h>
6 #include <linux/ctype.h>
8 #include <linux/inet.h>
10 #include <linux/module.h>
11 #include <linux/mount.h>
12 #include <linux/fs_context.h>
13 #include <linux/fs_parser.h>
14 #include <linux/sched.h>
15 #include <linux/seq_file.h>
16 #include <linux/slab.h>
17 #include <linux/statfs.h>
18 #include <linux/string.h>
21 #include "mds_client.h"
24 #include <linux/ceph/ceph_features.h>
25 #include <linux/ceph/decode.h>
26 #include <linux/ceph/mon_client.h>
27 #include <linux/ceph/auth.h>
28 #include <linux/ceph/debugfs.h>
30 #include <uapi/linux/magic.h>
32 static DEFINE_SPINLOCK(ceph_fsc_lock);
33 static LIST_HEAD(ceph_fsc_list);
36 * Ceph superblock operations
38 * Handle the basics of mounting, unmounting.
44 static void ceph_put_super(struct super_block *s)
46 struct ceph_fs_client *fsc = ceph_sb_to_client(s);
49 ceph_mdsc_close_sessions(fsc->mdsc);
52 static int ceph_statfs(struct dentry *dentry, struct kstatfs *buf)
54 struct ceph_fs_client *fsc = ceph_inode_to_client(d_inode(dentry));
55 struct ceph_mon_client *monc = &fsc->client->monc;
56 struct ceph_statfs st;
60 if (fsc->mdsc->mdsmap->m_num_data_pg_pools == 1) {
61 data_pool = fsc->mdsc->mdsmap->m_data_pg_pools[0];
63 data_pool = CEPH_NOPOOL;
67 err = ceph_monc_do_statfs(monc, data_pool, &st);
72 buf->f_type = CEPH_SUPER_MAGIC; /* ?? */
75 * Express utilization in terms of large blocks to avoid
76 * overflow on 32-bit machines.
78 buf->f_frsize = 1 << CEPH_BLOCK_SHIFT;
81 * By default use root quota for stats; fallback to overall filesystem
82 * usage if using 'noquotadf' mount option or if the root dir doesn't
83 * have max_bytes quota set.
85 if (ceph_test_mount_opt(fsc, NOQUOTADF) ||
86 !ceph_quota_update_statfs(fsc, buf)) {
87 buf->f_blocks = le64_to_cpu(st.kb) >> (CEPH_BLOCK_SHIFT-10);
88 buf->f_bfree = le64_to_cpu(st.kb_avail) >> (CEPH_BLOCK_SHIFT-10);
89 buf->f_bavail = le64_to_cpu(st.kb_avail) >> (CEPH_BLOCK_SHIFT-10);
93 * NOTE: for the time being, we make bsize == frsize to humor
94 * not-yet-ancient versions of glibc that are broken.
95 * Someday, we will probably want to report a real block
96 * size... whatever that may mean for a network file system!
98 buf->f_bsize = buf->f_frsize;
100 buf->f_files = le64_to_cpu(st.num_objects);
102 buf->f_namelen = NAME_MAX;
104 /* Must convert the fsid, for consistent values across arches */
105 buf->f_fsid.val[0] = 0;
106 mutex_lock(&monc->mutex);
107 for (i = 0 ; i < sizeof(monc->monmap->fsid) / sizeof(__le32) ; ++i)
108 buf->f_fsid.val[0] ^= le32_to_cpu(((__le32 *)&monc->monmap->fsid)[i]);
109 mutex_unlock(&monc->mutex);
111 /* fold the fs_cluster_id into the upper bits */
112 buf->f_fsid.val[1] = monc->fs_cluster_id;
117 static int ceph_sync_fs(struct super_block *sb, int wait)
119 struct ceph_fs_client *fsc = ceph_sb_to_client(sb);
122 dout("sync_fs (non-blocking)\n");
123 ceph_flush_dirty_caps(fsc->mdsc);
124 dout("sync_fs (non-blocking) done\n");
128 dout("sync_fs (blocking)\n");
129 ceph_osdc_sync(&fsc->client->osdc);
130 ceph_mdsc_sync(fsc->mdsc);
131 dout("sync_fs (blocking) done\n");
142 Opt_caps_wanted_delay_min,
143 Opt_caps_wanted_delay_max,
145 Opt_readdir_max_entries,
146 Opt_readdir_max_bytes,
154 /* string args above */
162 Opt_require_active_mds,
170 enum ceph_recover_session_mode {
171 ceph_recover_session_no,
172 ceph_recover_session_clean
175 static const struct constant_table ceph_param_recover[] = {
176 { "no", ceph_recover_session_no },
177 { "clean", ceph_recover_session_clean },
181 static const struct fs_parameter_spec ceph_mount_parameters[] = {
182 fsparam_flag_no ("acl", Opt_acl),
183 fsparam_flag_no ("asyncreaddir", Opt_asyncreaddir),
184 fsparam_s32 ("caps_max", Opt_caps_max),
185 fsparam_u32 ("caps_wanted_delay_max", Opt_caps_wanted_delay_max),
186 fsparam_u32 ("caps_wanted_delay_min", Opt_caps_wanted_delay_min),
187 fsparam_u32 ("write_congestion_kb", Opt_congestion_kb),
188 fsparam_flag_no ("copyfrom", Opt_copyfrom),
189 fsparam_flag_no ("dcache", Opt_dcache),
190 fsparam_flag_no ("dirstat", Opt_dirstat),
191 fsparam_flag_no ("fsc", Opt_fscache), // fsc|nofsc
192 fsparam_string ("fsc", Opt_fscache), // fsc=...
193 fsparam_flag_no ("ino32", Opt_ino32),
194 fsparam_string ("mds_namespace", Opt_mds_namespace),
195 fsparam_flag_no ("poolperm", Opt_poolperm),
196 fsparam_flag_no ("quotadf", Opt_quotadf),
197 fsparam_u32 ("rasize", Opt_rasize),
198 fsparam_flag_no ("rbytes", Opt_rbytes),
199 fsparam_u32 ("readdir_max_bytes", Opt_readdir_max_bytes),
200 fsparam_u32 ("readdir_max_entries", Opt_readdir_max_entries),
201 fsparam_enum ("recover_session", Opt_recover_session, ceph_param_recover),
202 fsparam_flag_no ("require_active_mds", Opt_require_active_mds),
203 fsparam_u32 ("rsize", Opt_rsize),
204 fsparam_string ("snapdirname", Opt_snapdirname),
205 fsparam_string ("source", Opt_source),
206 fsparam_string ("mon_addr", Opt_mon_addr),
207 fsparam_u32 ("wsize", Opt_wsize),
208 fsparam_flag_no ("wsync", Opt_wsync),
209 fsparam_flag_no ("pagecache", Opt_pagecache),
213 struct ceph_parse_opts_ctx {
214 struct ceph_options *copts;
215 struct ceph_mount_options *opts;
219 * Remove adjacent slashes and then the trailing slash, unless it is
220 * the only remaining character.
222 * E.g. "//dir1////dir2///" --> "/dir1/dir2", "///" --> "/".
224 static void canonicalize_path(char *path)
228 for (i = 0; path[i] != '\0'; i++) {
229 if (path[i] != '/' || j < 1 || path[j - 1] != '/')
233 if (j > 1 && path[j - 1] == '/')
239 * Check if the mds namespace in ceph_mount_options matches
240 * the passed in namespace string. First time match (when
241 * ->mds_namespace is NULL) is treated specially, since
242 * ->mds_namespace needs to be initialized by the caller.
244 static int namespace_equals(struct ceph_mount_options *fsopt,
245 const char *namespace, size_t len)
247 return !(fsopt->mds_namespace &&
248 (strlen(fsopt->mds_namespace) != len ||
249 strncmp(fsopt->mds_namespace, namespace, len)));
252 static int ceph_parse_old_source(const char *dev_name, const char *dev_name_end,
253 struct fs_context *fc)
256 struct ceph_parse_opts_ctx *pctx = fc->fs_private;
257 struct ceph_mount_options *fsopt = pctx->opts;
259 if (*dev_name_end != ':')
260 return invalfc(fc, "separator ':' missing in source");
262 r = ceph_parse_mon_ips(dev_name, dev_name_end - dev_name,
263 pctx->copts, fc->log.log, ',');
267 fsopt->new_dev_syntax = false;
271 static int ceph_parse_new_source(const char *dev_name, const char *dev_name_end,
272 struct fs_context *fc)
275 struct ceph_fsid fsid;
276 struct ceph_parse_opts_ctx *pctx = fc->fs_private;
277 struct ceph_mount_options *fsopt = pctx->opts;
278 char *fsid_start, *fs_name_start;
280 if (*dev_name_end != '=') {
281 dout("separator '=' missing in source");
285 fsid_start = strchr(dev_name, '@');
287 return invalfc(fc, "missing cluster fsid");
288 ++fsid_start; /* start of cluster fsid */
290 fs_name_start = strchr(fsid_start, '.');
292 return invalfc(fc, "missing file system name");
294 if (ceph_parse_fsid(fsid_start, &fsid))
295 return invalfc(fc, "Invalid FSID");
297 ++fs_name_start; /* start of file system name */
298 len = dev_name_end - fs_name_start;
300 if (!namespace_equals(fsopt, fs_name_start, len))
301 return invalfc(fc, "Mismatching mds_namespace");
302 kfree(fsopt->mds_namespace);
303 fsopt->mds_namespace = kstrndup(fs_name_start, len, GFP_KERNEL);
304 if (!fsopt->mds_namespace)
306 dout("file system (mds namespace) '%s'\n", fsopt->mds_namespace);
308 fsopt->new_dev_syntax = true;
313 * Parse the source parameter for new device format. Distinguish the device
314 * spec from the path. Try parsing new device format and fallback to old
317 * New device syntax will looks like:
318 * <device_spec>=/<path>
320 * <device_spec> is name@fsid.fsname
321 * <path> is optional, but if present must begin with '/'
322 * (monitor addresses are passed via mount option)
324 * Old device syntax is:
325 * <server_spec>[,<server_spec>...]:[<path>]
327 * <server_spec> is <ip>[:<port>]
328 * <path> is optional, but if present must begin with '/'
330 static int ceph_parse_source(struct fs_parameter *param, struct fs_context *fc)
332 struct ceph_parse_opts_ctx *pctx = fc->fs_private;
333 struct ceph_mount_options *fsopt = pctx->opts;
334 char *dev_name = param->string, *dev_name_end;
337 dout("%s '%s'\n", __func__, dev_name);
338 if (!dev_name || !*dev_name)
339 return invalfc(fc, "Empty source");
341 dev_name_end = strchr(dev_name, '/');
344 * The server_path will include the whole chars from userland
345 * including the leading '/'.
347 kfree(fsopt->server_path);
348 fsopt->server_path = kstrdup(dev_name_end, GFP_KERNEL);
349 if (!fsopt->server_path)
352 canonicalize_path(fsopt->server_path);
354 dev_name_end = dev_name + strlen(dev_name);
357 dev_name_end--; /* back up to separator */
358 if (dev_name_end < dev_name)
359 return invalfc(fc, "Path missing in source");
361 dout("device name '%.*s'\n", (int)(dev_name_end - dev_name), dev_name);
362 if (fsopt->server_path)
363 dout("server path '%s'\n", fsopt->server_path);
365 dout("trying new device syntax");
366 ret = ceph_parse_new_source(dev_name, dev_name_end, fc);
370 dout("trying old device syntax");
371 ret = ceph_parse_old_source(dev_name, dev_name_end, fc);
376 fc->source = param->string;
377 param->string = NULL;
381 static int ceph_parse_mon_addr(struct fs_parameter *param,
382 struct fs_context *fc)
384 struct ceph_parse_opts_ctx *pctx = fc->fs_private;
385 struct ceph_mount_options *fsopt = pctx->opts;
387 kfree(fsopt->mon_addr);
388 fsopt->mon_addr = param->string;
389 param->string = NULL;
391 return ceph_parse_mon_ips(fsopt->mon_addr, strlen(fsopt->mon_addr),
392 pctx->copts, fc->log.log, '/');
395 static int ceph_parse_mount_param(struct fs_context *fc,
396 struct fs_parameter *param)
398 struct ceph_parse_opts_ctx *pctx = fc->fs_private;
399 struct ceph_mount_options *fsopt = pctx->opts;
400 struct fs_parse_result result;
404 ret = ceph_parse_param(param, pctx->copts, fc->log.log);
405 if (ret != -ENOPARAM)
408 token = fs_parse(fc, ceph_mount_parameters, param, &result);
409 dout("%s fs_parse '%s' token %d\n", __func__, param->key, token);
414 case Opt_snapdirname:
415 kfree(fsopt->snapdir_name);
416 fsopt->snapdir_name = param->string;
417 param->string = NULL;
419 case Opt_mds_namespace:
420 if (!namespace_equals(fsopt, param->string, strlen(param->string)))
421 return invalfc(fc, "Mismatching mds_namespace");
422 kfree(fsopt->mds_namespace);
423 fsopt->mds_namespace = param->string;
424 param->string = NULL;
426 case Opt_recover_session:
427 mode = result.uint_32;
428 if (mode == ceph_recover_session_no)
429 fsopt->flags &= ~CEPH_MOUNT_OPT_CLEANRECOVER;
430 else if (mode == ceph_recover_session_clean)
431 fsopt->flags |= CEPH_MOUNT_OPT_CLEANRECOVER;
437 return invalfc(fc, "Multiple sources specified");
438 return ceph_parse_source(param, fc);
440 return ceph_parse_mon_addr(param, fc);
442 if (result.uint_32 < PAGE_SIZE ||
443 result.uint_32 > CEPH_MAX_WRITE_SIZE)
445 fsopt->wsize = ALIGN(result.uint_32, PAGE_SIZE);
448 if (result.uint_32 < PAGE_SIZE ||
449 result.uint_32 > CEPH_MAX_READ_SIZE)
451 fsopt->rsize = ALIGN(result.uint_32, PAGE_SIZE);
454 fsopt->rasize = ALIGN(result.uint_32, PAGE_SIZE);
456 case Opt_caps_wanted_delay_min:
457 if (result.uint_32 < 1)
459 fsopt->caps_wanted_delay_min = result.uint_32;
461 case Opt_caps_wanted_delay_max:
462 if (result.uint_32 < 1)
464 fsopt->caps_wanted_delay_max = result.uint_32;
467 if (result.int_32 < 0)
469 fsopt->caps_max = result.int_32;
471 case Opt_readdir_max_entries:
472 if (result.uint_32 < 1)
474 fsopt->max_readdir = result.uint_32;
476 case Opt_readdir_max_bytes:
477 if (result.uint_32 < PAGE_SIZE && result.uint_32 != 0)
479 fsopt->max_readdir_bytes = result.uint_32;
481 case Opt_congestion_kb:
482 if (result.uint_32 < 1024) /* at least 1M */
484 fsopt->congestion_kb = result.uint_32;
488 fsopt->flags |= CEPH_MOUNT_OPT_DIRSTAT;
490 fsopt->flags &= ~CEPH_MOUNT_OPT_DIRSTAT;
494 fsopt->flags |= CEPH_MOUNT_OPT_RBYTES;
496 fsopt->flags &= ~CEPH_MOUNT_OPT_RBYTES;
498 case Opt_asyncreaddir:
500 fsopt->flags &= ~CEPH_MOUNT_OPT_NOASYNCREADDIR;
502 fsopt->flags |= CEPH_MOUNT_OPT_NOASYNCREADDIR;
506 fsopt->flags |= CEPH_MOUNT_OPT_DCACHE;
508 fsopt->flags &= ~CEPH_MOUNT_OPT_DCACHE;
512 fsopt->flags |= CEPH_MOUNT_OPT_INO32;
514 fsopt->flags &= ~CEPH_MOUNT_OPT_INO32;
518 #ifdef CONFIG_CEPH_FSCACHE
519 kfree(fsopt->fscache_uniq);
520 fsopt->fscache_uniq = NULL;
521 if (result.negated) {
522 fsopt->flags &= ~CEPH_MOUNT_OPT_FSCACHE;
524 fsopt->flags |= CEPH_MOUNT_OPT_FSCACHE;
525 fsopt->fscache_uniq = param->string;
526 param->string = NULL;
530 return invalfc(fc, "fscache support is disabled");
534 fsopt->flags &= ~CEPH_MOUNT_OPT_NOPOOLPERM;
536 fsopt->flags |= CEPH_MOUNT_OPT_NOPOOLPERM;
538 case Opt_require_active_mds:
540 fsopt->flags &= ~CEPH_MOUNT_OPT_MOUNTWAIT;
542 fsopt->flags |= CEPH_MOUNT_OPT_MOUNTWAIT;
546 fsopt->flags &= ~CEPH_MOUNT_OPT_NOQUOTADF;
548 fsopt->flags |= CEPH_MOUNT_OPT_NOQUOTADF;
552 fsopt->flags &= ~CEPH_MOUNT_OPT_NOCOPYFROM;
554 fsopt->flags |= CEPH_MOUNT_OPT_NOCOPYFROM;
557 if (!result.negated) {
558 #ifdef CONFIG_CEPH_FS_POSIX_ACL
559 fc->sb_flags |= SB_POSIXACL;
561 return invalfc(fc, "POSIX ACL support is disabled");
564 fc->sb_flags &= ~SB_POSIXACL;
569 fsopt->flags &= ~CEPH_MOUNT_OPT_ASYNC_DIROPS;
571 fsopt->flags |= CEPH_MOUNT_OPT_ASYNC_DIROPS;
575 fsopt->flags |= CEPH_MOUNT_OPT_NOPAGECACHE;
577 fsopt->flags &= ~CEPH_MOUNT_OPT_NOPAGECACHE;
585 return invalfc(fc, "%s out of range", param->key);
588 static void destroy_mount_options(struct ceph_mount_options *args)
590 dout("destroy_mount_options %p\n", args);
594 kfree(args->snapdir_name);
595 kfree(args->mds_namespace);
596 kfree(args->server_path);
597 kfree(args->fscache_uniq);
598 kfree(args->mon_addr);
602 static int strcmp_null(const char *s1, const char *s2)
610 return strcmp(s1, s2);
613 static int compare_mount_options(struct ceph_mount_options *new_fsopt,
614 struct ceph_options *new_opt,
615 struct ceph_fs_client *fsc)
617 struct ceph_mount_options *fsopt1 = new_fsopt;
618 struct ceph_mount_options *fsopt2 = fsc->mount_options;
619 int ofs = offsetof(struct ceph_mount_options, snapdir_name);
622 ret = memcmp(fsopt1, fsopt2, ofs);
626 ret = strcmp_null(fsopt1->snapdir_name, fsopt2->snapdir_name);
630 ret = strcmp_null(fsopt1->mds_namespace, fsopt2->mds_namespace);
634 ret = strcmp_null(fsopt1->server_path, fsopt2->server_path);
638 ret = strcmp_null(fsopt1->fscache_uniq, fsopt2->fscache_uniq);
642 ret = strcmp_null(fsopt1->mon_addr, fsopt2->mon_addr);
646 return ceph_compare_options(new_opt, fsc->client);
650 * ceph_show_options - Show mount options in /proc/mounts
651 * @m: seq_file to write to
652 * @root: root of that (sub)tree
654 static int ceph_show_options(struct seq_file *m, struct dentry *root)
656 struct ceph_fs_client *fsc = ceph_sb_to_client(root->d_sb);
657 struct ceph_mount_options *fsopt = fsc->mount_options;
661 /* a comma between MNT/MS and client options */
665 ret = ceph_print_client_options(m, fsc->client, false);
669 /* retract our comma if no client options */
673 if (fsopt->flags & CEPH_MOUNT_OPT_DIRSTAT)
674 seq_puts(m, ",dirstat");
675 if ((fsopt->flags & CEPH_MOUNT_OPT_RBYTES))
676 seq_puts(m, ",rbytes");
677 if (fsopt->flags & CEPH_MOUNT_OPT_NOASYNCREADDIR)
678 seq_puts(m, ",noasyncreaddir");
679 if ((fsopt->flags & CEPH_MOUNT_OPT_DCACHE) == 0)
680 seq_puts(m, ",nodcache");
681 if (fsopt->flags & CEPH_MOUNT_OPT_INO32)
682 seq_puts(m, ",ino32");
683 if (fsopt->flags & CEPH_MOUNT_OPT_FSCACHE) {
684 seq_show_option(m, "fsc", fsopt->fscache_uniq);
686 if (fsopt->flags & CEPH_MOUNT_OPT_NOPOOLPERM)
687 seq_puts(m, ",nopoolperm");
688 if (fsopt->flags & CEPH_MOUNT_OPT_NOQUOTADF)
689 seq_puts(m, ",noquotadf");
691 #ifdef CONFIG_CEPH_FS_POSIX_ACL
692 if (root->d_sb->s_flags & SB_POSIXACL)
695 seq_puts(m, ",noacl");
698 if ((fsopt->flags & CEPH_MOUNT_OPT_NOCOPYFROM) == 0)
699 seq_puts(m, ",copyfrom");
701 /* dump mds_namespace when old device syntax is in use */
702 if (fsopt->mds_namespace && !fsopt->new_dev_syntax)
703 seq_show_option(m, "mds_namespace", fsopt->mds_namespace);
706 seq_printf(m, ",mon_addr=%s", fsopt->mon_addr);
708 if (fsopt->flags & CEPH_MOUNT_OPT_CLEANRECOVER)
709 seq_show_option(m, "recover_session", "clean");
711 if (!(fsopt->flags & CEPH_MOUNT_OPT_ASYNC_DIROPS))
712 seq_puts(m, ",wsync");
714 if (fsopt->flags & CEPH_MOUNT_OPT_NOPAGECACHE)
715 seq_puts(m, ",nopagecache");
717 if (fsopt->wsize != CEPH_MAX_WRITE_SIZE)
718 seq_printf(m, ",wsize=%u", fsopt->wsize);
719 if (fsopt->rsize != CEPH_MAX_READ_SIZE)
720 seq_printf(m, ",rsize=%u", fsopt->rsize);
721 if (fsopt->rasize != CEPH_RASIZE_DEFAULT)
722 seq_printf(m, ",rasize=%u", fsopt->rasize);
723 if (fsopt->congestion_kb != default_congestion_kb())
724 seq_printf(m, ",write_congestion_kb=%u", fsopt->congestion_kb);
726 seq_printf(m, ",caps_max=%d", fsopt->caps_max);
727 if (fsopt->caps_wanted_delay_min != CEPH_CAPS_WANTED_DELAY_MIN_DEFAULT)
728 seq_printf(m, ",caps_wanted_delay_min=%u",
729 fsopt->caps_wanted_delay_min);
730 if (fsopt->caps_wanted_delay_max != CEPH_CAPS_WANTED_DELAY_MAX_DEFAULT)
731 seq_printf(m, ",caps_wanted_delay_max=%u",
732 fsopt->caps_wanted_delay_max);
733 if (fsopt->max_readdir != CEPH_MAX_READDIR_DEFAULT)
734 seq_printf(m, ",readdir_max_entries=%u", fsopt->max_readdir);
735 if (fsopt->max_readdir_bytes != CEPH_MAX_READDIR_BYTES_DEFAULT)
736 seq_printf(m, ",readdir_max_bytes=%u", fsopt->max_readdir_bytes);
737 if (strcmp(fsopt->snapdir_name, CEPH_SNAPDIRNAME_DEFAULT))
738 seq_show_option(m, "snapdirname", fsopt->snapdir_name);
744 * handle any mon messages the standard library doesn't understand.
745 * return error if we don't either.
747 static int extra_mon_dispatch(struct ceph_client *client, struct ceph_msg *msg)
749 struct ceph_fs_client *fsc = client->private;
750 int type = le16_to_cpu(msg->hdr.type);
753 case CEPH_MSG_MDS_MAP:
754 ceph_mdsc_handle_mdsmap(fsc->mdsc, msg);
756 case CEPH_MSG_FS_MAP_USER:
757 ceph_mdsc_handle_fsmap(fsc->mdsc, msg);
765 * create a new fs client
767 * Success or not, this function consumes @fsopt and @opt.
769 static struct ceph_fs_client *create_fs_client(struct ceph_mount_options *fsopt,
770 struct ceph_options *opt)
772 struct ceph_fs_client *fsc;
775 fsc = kzalloc(sizeof(*fsc), GFP_KERNEL);
781 fsc->client = ceph_create_client(opt, fsc);
782 if (IS_ERR(fsc->client)) {
783 err = PTR_ERR(fsc->client);
786 opt = NULL; /* fsc->client now owns this */
788 fsc->client->extra_mon_dispatch = extra_mon_dispatch;
789 ceph_set_opt(fsc->client, ABORT_ON_FULL);
791 if (!fsopt->mds_namespace) {
792 ceph_monc_want_map(&fsc->client->monc, CEPH_SUB_MDSMAP,
795 ceph_monc_want_map(&fsc->client->monc, CEPH_SUB_FSMAP,
799 fsc->mount_options = fsopt;
802 fsc->mount_state = CEPH_MOUNT_MOUNTING;
804 fsc->have_copy_from2 = true;
806 atomic_long_set(&fsc->writeback_count, 0);
807 fsc->write_congested = false;
811 * The number of concurrent works can be high but they don't need
812 * to be processed in parallel, limit concurrency.
814 fsc->inode_wq = alloc_workqueue("ceph-inode", WQ_UNBOUND, 0);
817 fsc->cap_wq = alloc_workqueue("ceph-cap", 0, 1);
821 hash_init(fsc->async_unlink_conflict);
822 spin_lock_init(&fsc->async_unlink_conflict_lock);
824 spin_lock(&ceph_fsc_lock);
825 list_add_tail(&fsc->metric_wakeup, &ceph_fsc_list);
826 spin_unlock(&ceph_fsc_lock);
831 destroy_workqueue(fsc->inode_wq);
833 ceph_destroy_client(fsc->client);
837 ceph_destroy_options(opt);
838 destroy_mount_options(fsopt);
842 static void flush_fs_workqueues(struct ceph_fs_client *fsc)
844 flush_workqueue(fsc->inode_wq);
845 flush_workqueue(fsc->cap_wq);
848 static void destroy_fs_client(struct ceph_fs_client *fsc)
850 dout("destroy_fs_client %p\n", fsc);
852 spin_lock(&ceph_fsc_lock);
853 list_del(&fsc->metric_wakeup);
854 spin_unlock(&ceph_fsc_lock);
856 ceph_mdsc_destroy(fsc);
857 destroy_workqueue(fsc->inode_wq);
858 destroy_workqueue(fsc->cap_wq);
860 destroy_mount_options(fsc->mount_options);
862 ceph_destroy_client(fsc->client);
865 dout("destroy_fs_client %p done\n", fsc);
871 struct kmem_cache *ceph_inode_cachep;
872 struct kmem_cache *ceph_cap_cachep;
873 struct kmem_cache *ceph_cap_snap_cachep;
874 struct kmem_cache *ceph_cap_flush_cachep;
875 struct kmem_cache *ceph_dentry_cachep;
876 struct kmem_cache *ceph_file_cachep;
877 struct kmem_cache *ceph_dir_file_cachep;
878 struct kmem_cache *ceph_mds_request_cachep;
879 mempool_t *ceph_wb_pagevec_pool;
881 static void ceph_inode_init_once(void *foo)
883 struct ceph_inode_info *ci = foo;
884 inode_init_once(&ci->netfs.inode);
887 static int __init init_caches(void)
891 ceph_inode_cachep = kmem_cache_create("ceph_inode_info",
892 sizeof(struct ceph_inode_info),
893 __alignof__(struct ceph_inode_info),
894 SLAB_RECLAIM_ACCOUNT|SLAB_MEM_SPREAD|
895 SLAB_ACCOUNT, ceph_inode_init_once);
896 if (!ceph_inode_cachep)
899 ceph_cap_cachep = KMEM_CACHE(ceph_cap, SLAB_MEM_SPREAD);
900 if (!ceph_cap_cachep)
902 ceph_cap_snap_cachep = KMEM_CACHE(ceph_cap_snap, SLAB_MEM_SPREAD);
903 if (!ceph_cap_snap_cachep)
905 ceph_cap_flush_cachep = KMEM_CACHE(ceph_cap_flush,
906 SLAB_RECLAIM_ACCOUNT|SLAB_MEM_SPREAD);
907 if (!ceph_cap_flush_cachep)
910 ceph_dentry_cachep = KMEM_CACHE(ceph_dentry_info,
911 SLAB_RECLAIM_ACCOUNT|SLAB_MEM_SPREAD);
912 if (!ceph_dentry_cachep)
915 ceph_file_cachep = KMEM_CACHE(ceph_file_info, SLAB_MEM_SPREAD);
916 if (!ceph_file_cachep)
919 ceph_dir_file_cachep = KMEM_CACHE(ceph_dir_file_info, SLAB_MEM_SPREAD);
920 if (!ceph_dir_file_cachep)
923 ceph_mds_request_cachep = KMEM_CACHE(ceph_mds_request, SLAB_MEM_SPREAD);
924 if (!ceph_mds_request_cachep)
927 ceph_wb_pagevec_pool = mempool_create_kmalloc_pool(10, CEPH_MAX_WRITE_SIZE >> PAGE_SHIFT);
928 if (!ceph_wb_pagevec_pool)
929 goto bad_pagevec_pool;
934 kmem_cache_destroy(ceph_mds_request_cachep);
936 kmem_cache_destroy(ceph_dir_file_cachep);
938 kmem_cache_destroy(ceph_file_cachep);
940 kmem_cache_destroy(ceph_dentry_cachep);
942 kmem_cache_destroy(ceph_cap_flush_cachep);
944 kmem_cache_destroy(ceph_cap_snap_cachep);
946 kmem_cache_destroy(ceph_cap_cachep);
948 kmem_cache_destroy(ceph_inode_cachep);
952 static void destroy_caches(void)
955 * Make sure all delayed rcu free inodes are flushed before we
960 kmem_cache_destroy(ceph_inode_cachep);
961 kmem_cache_destroy(ceph_cap_cachep);
962 kmem_cache_destroy(ceph_cap_snap_cachep);
963 kmem_cache_destroy(ceph_cap_flush_cachep);
964 kmem_cache_destroy(ceph_dentry_cachep);
965 kmem_cache_destroy(ceph_file_cachep);
966 kmem_cache_destroy(ceph_dir_file_cachep);
967 kmem_cache_destroy(ceph_mds_request_cachep);
968 mempool_destroy(ceph_wb_pagevec_pool);
971 static void __ceph_umount_begin(struct ceph_fs_client *fsc)
973 ceph_osdc_abort_requests(&fsc->client->osdc, -EIO);
974 ceph_mdsc_force_umount(fsc->mdsc);
975 fsc->filp_gen++; // invalidate open files
979 * ceph_umount_begin - initiate forced umount. Tear down the
980 * mount, skipping steps that may hang while waiting for server(s).
982 void ceph_umount_begin(struct super_block *sb)
984 struct ceph_fs_client *fsc = ceph_sb_to_client(sb);
986 dout("ceph_umount_begin - starting forced umount\n");
989 fsc->mount_state = CEPH_MOUNT_SHUTDOWN;
990 __ceph_umount_begin(fsc);
993 static const struct super_operations ceph_super_ops = {
994 .alloc_inode = ceph_alloc_inode,
995 .free_inode = ceph_free_inode,
996 .write_inode = ceph_write_inode,
997 .drop_inode = generic_delete_inode,
998 .evict_inode = ceph_evict_inode,
999 .sync_fs = ceph_sync_fs,
1000 .put_super = ceph_put_super,
1001 .show_options = ceph_show_options,
1002 .statfs = ceph_statfs,
1003 .umount_begin = ceph_umount_begin,
1007 * Bootstrap mount by opening the root directory. Note the mount
1008 * @started time from caller, and time out if this takes too long.
1010 static struct dentry *open_root_dentry(struct ceph_fs_client *fsc,
1012 unsigned long started)
1014 struct ceph_mds_client *mdsc = fsc->mdsc;
1015 struct ceph_mds_request *req = NULL;
1017 struct dentry *root;
1020 dout("open_root_inode opening '%s'\n", path);
1021 req = ceph_mdsc_create_request(mdsc, CEPH_MDS_OP_GETATTR, USE_ANY_MDS);
1023 return ERR_CAST(req);
1024 req->r_path1 = kstrdup(path, GFP_NOFS);
1025 if (!req->r_path1) {
1026 root = ERR_PTR(-ENOMEM);
1030 req->r_ino1.ino = CEPH_INO_ROOT;
1031 req->r_ino1.snap = CEPH_NOSNAP;
1032 req->r_started = started;
1033 req->r_timeout = fsc->client->options->mount_timeout;
1034 req->r_args.getattr.mask = cpu_to_le32(CEPH_STAT_CAP_INODE);
1035 req->r_num_caps = 2;
1036 err = ceph_mdsc_do_request(mdsc, NULL, req);
1038 struct inode *inode = req->r_target_inode;
1039 req->r_target_inode = NULL;
1040 dout("open_root_inode success\n");
1041 root = d_make_root(inode);
1043 root = ERR_PTR(-ENOMEM);
1046 dout("open_root_inode success, root dentry is %p\n", root);
1048 root = ERR_PTR(err);
1051 ceph_mdsc_put_request(req);
1056 * mount: join the ceph cluster, and open root directory.
1058 static struct dentry *ceph_real_mount(struct ceph_fs_client *fsc,
1059 struct fs_context *fc)
1062 unsigned long started = jiffies; /* note the start time */
1063 struct dentry *root;
1065 dout("mount start %p\n", fsc);
1066 mutex_lock(&fsc->client->mount_mutex);
1068 if (!fsc->sb->s_root) {
1069 const char *path = fsc->mount_options->server_path ?
1070 fsc->mount_options->server_path + 1 : "";
1072 err = __ceph_open_session(fsc->client, started);
1077 if (fsc->mount_options->flags & CEPH_MOUNT_OPT_FSCACHE) {
1078 err = ceph_fscache_register_fs(fsc, fc);
1083 dout("mount opening path '%s'\n", path);
1085 ceph_fs_debugfs_init(fsc);
1087 root = open_root_dentry(fsc, path, started);
1089 err = PTR_ERR(root);
1092 fsc->sb->s_root = dget(root);
1094 root = dget(fsc->sb->s_root);
1097 fsc->mount_state = CEPH_MOUNT_MOUNTED;
1098 dout("mount success\n");
1099 mutex_unlock(&fsc->client->mount_mutex);
1103 mutex_unlock(&fsc->client->mount_mutex);
1104 return ERR_PTR(err);
1107 static int ceph_set_super(struct super_block *s, struct fs_context *fc)
1109 struct ceph_fs_client *fsc = s->s_fs_info;
1112 dout("set_super %p\n", s);
1114 s->s_maxbytes = MAX_LFS_FILESIZE;
1116 s->s_xattr = ceph_xattr_handlers;
1118 fsc->max_file_size = 1ULL << 40; /* temp value until we get mdsmap */
1120 s->s_op = &ceph_super_ops;
1121 s->s_d_op = &ceph_dentry_ops;
1122 s->s_export_op = &ceph_export_ops;
1126 s->s_time_max = U32_MAX;
1127 s->s_flags |= SB_NODIRATIME | SB_NOATIME;
1129 ret = set_anon_super_fc(s, fc);
1136 * share superblock if same fs AND options
1138 static int ceph_compare_super(struct super_block *sb, struct fs_context *fc)
1140 struct ceph_fs_client *new = fc->s_fs_info;
1141 struct ceph_mount_options *fsopt = new->mount_options;
1142 struct ceph_options *opt = new->client->options;
1143 struct ceph_fs_client *fsc = ceph_sb_to_client(sb);
1145 dout("ceph_compare_super %p\n", sb);
1147 if (compare_mount_options(fsopt, opt, fsc)) {
1148 dout("monitor(s)/mount options don't match\n");
1151 if ((opt->flags & CEPH_OPT_FSID) &&
1152 ceph_fsid_compare(&opt->fsid, &fsc->client->fsid)) {
1153 dout("fsid doesn't match\n");
1156 if (fc->sb_flags != (sb->s_flags & ~SB_BORN)) {
1157 dout("flags differ\n");
1161 if (fsc->blocklisted && !ceph_test_mount_opt(fsc, CLEANRECOVER)) {
1162 dout("client is blocklisted (and CLEANRECOVER is not set)\n");
1166 if (fsc->mount_state == CEPH_MOUNT_SHUTDOWN) {
1167 dout("client has been forcibly unmounted\n");
1175 * construct our own bdi so we can control readahead, etc.
1177 static atomic_long_t bdi_seq = ATOMIC_LONG_INIT(0);
1179 static int ceph_setup_bdi(struct super_block *sb, struct ceph_fs_client *fsc)
1183 err = super_setup_bdi_name(sb, "ceph-%ld",
1184 atomic_long_inc_return(&bdi_seq));
1188 /* set ra_pages based on rasize mount option? */
1189 sb->s_bdi->ra_pages = fsc->mount_options->rasize >> PAGE_SHIFT;
1191 /* set io_pages based on max osd read size */
1192 sb->s_bdi->io_pages = fsc->mount_options->rsize >> PAGE_SHIFT;
1197 static int ceph_get_tree(struct fs_context *fc)
1199 struct ceph_parse_opts_ctx *pctx = fc->fs_private;
1200 struct ceph_mount_options *fsopt = pctx->opts;
1201 struct super_block *sb;
1202 struct ceph_fs_client *fsc;
1204 int (*compare_super)(struct super_block *, struct fs_context *) =
1208 dout("ceph_get_tree\n");
1211 return invalfc(fc, "No source");
1212 if (fsopt->new_dev_syntax && !fsopt->mon_addr)
1213 return invalfc(fc, "No monitor address");
1215 /* create client (which we may/may not use) */
1216 fsc = create_fs_client(pctx->opts, pctx->copts);
1224 err = ceph_mdsc_init(fsc);
1228 if (ceph_test_opt(fsc->client, NOSHARE))
1229 compare_super = NULL;
1231 fc->s_fs_info = fsc;
1232 sb = sget_fc(fc, compare_super, ceph_set_super);
1233 fc->s_fs_info = NULL;
1239 if (ceph_sb_to_client(sb) != fsc) {
1240 destroy_fs_client(fsc);
1241 fsc = ceph_sb_to_client(sb);
1242 dout("get_sb got existing client %p\n", fsc);
1244 dout("get_sb using new client %p\n", fsc);
1245 err = ceph_setup_bdi(sb, fsc);
1250 res = ceph_real_mount(fsc, fc);
1255 dout("root %p inode %p ino %llx.%llx\n", res,
1256 d_inode(res), ceph_vinop(d_inode(res)));
1257 fc->root = fsc->sb->s_root;
1261 if (!ceph_mdsmap_is_cluster_available(fsc->mdsc->mdsmap)) {
1262 pr_info("No mds server is up or the cluster is laggy\n");
1263 err = -EHOSTUNREACH;
1266 ceph_mdsc_close_sessions(fsc->mdsc);
1267 deactivate_locked_super(sb);
1271 destroy_fs_client(fsc);
1273 dout("ceph_get_tree fail %d\n", err);
1277 static void ceph_free_fc(struct fs_context *fc)
1279 struct ceph_parse_opts_ctx *pctx = fc->fs_private;
1282 destroy_mount_options(pctx->opts);
1283 ceph_destroy_options(pctx->copts);
1288 static int ceph_reconfigure_fc(struct fs_context *fc)
1290 struct ceph_parse_opts_ctx *pctx = fc->fs_private;
1291 struct ceph_mount_options *fsopt = pctx->opts;
1292 struct ceph_fs_client *fsc = ceph_sb_to_client(fc->root->d_sb);
1294 if (fsopt->flags & CEPH_MOUNT_OPT_ASYNC_DIROPS)
1295 ceph_set_mount_opt(fsc, ASYNC_DIROPS);
1297 ceph_clear_mount_opt(fsc, ASYNC_DIROPS);
1299 if (strcmp_null(fsc->mount_options->mon_addr, fsopt->mon_addr)) {
1300 kfree(fsc->mount_options->mon_addr);
1301 fsc->mount_options->mon_addr = fsopt->mon_addr;
1302 fsopt->mon_addr = NULL;
1303 pr_notice("ceph: monitor addresses recorded, but not used for reconnection");
1306 sync_filesystem(fc->root->d_sb);
1310 static const struct fs_context_operations ceph_context_ops = {
1311 .free = ceph_free_fc,
1312 .parse_param = ceph_parse_mount_param,
1313 .get_tree = ceph_get_tree,
1314 .reconfigure = ceph_reconfigure_fc,
1318 * Set up the filesystem mount context.
1320 static int ceph_init_fs_context(struct fs_context *fc)
1322 struct ceph_parse_opts_ctx *pctx;
1323 struct ceph_mount_options *fsopt;
1325 pctx = kzalloc(sizeof(*pctx), GFP_KERNEL);
1329 pctx->copts = ceph_alloc_options();
1333 pctx->opts = kzalloc(sizeof(*pctx->opts), GFP_KERNEL);
1338 fsopt->flags = CEPH_MOUNT_OPT_DEFAULT;
1340 fsopt->wsize = CEPH_MAX_WRITE_SIZE;
1341 fsopt->rsize = CEPH_MAX_READ_SIZE;
1342 fsopt->rasize = CEPH_RASIZE_DEFAULT;
1343 fsopt->snapdir_name = kstrdup(CEPH_SNAPDIRNAME_DEFAULT, GFP_KERNEL);
1344 if (!fsopt->snapdir_name)
1347 fsopt->caps_wanted_delay_min = CEPH_CAPS_WANTED_DELAY_MIN_DEFAULT;
1348 fsopt->caps_wanted_delay_max = CEPH_CAPS_WANTED_DELAY_MAX_DEFAULT;
1349 fsopt->max_readdir = CEPH_MAX_READDIR_DEFAULT;
1350 fsopt->max_readdir_bytes = CEPH_MAX_READDIR_BYTES_DEFAULT;
1351 fsopt->congestion_kb = default_congestion_kb();
1353 #ifdef CONFIG_CEPH_FS_POSIX_ACL
1354 fc->sb_flags |= SB_POSIXACL;
1357 fc->fs_private = pctx;
1358 fc->ops = &ceph_context_ops;
1362 destroy_mount_options(pctx->opts);
1363 ceph_destroy_options(pctx->copts);
1368 static void ceph_kill_sb(struct super_block *s)
1370 struct ceph_fs_client *fsc = ceph_sb_to_client(s);
1372 dout("kill_sb %p\n", s);
1374 ceph_mdsc_pre_umount(fsc->mdsc);
1375 flush_fs_workqueues(fsc);
1379 fsc->client->extra_mon_dispatch = NULL;
1380 ceph_fs_debugfs_cleanup(fsc);
1382 ceph_fscache_unregister_fs(fsc);
1384 destroy_fs_client(fsc);
1387 static struct file_system_type ceph_fs_type = {
1388 .owner = THIS_MODULE,
1390 .init_fs_context = ceph_init_fs_context,
1391 .kill_sb = ceph_kill_sb,
1392 .fs_flags = FS_RENAME_DOES_D_MOVE,
1394 MODULE_ALIAS_FS("ceph");
1396 int ceph_force_reconnect(struct super_block *sb)
1398 struct ceph_fs_client *fsc = ceph_sb_to_client(sb);
1401 fsc->mount_state = CEPH_MOUNT_RECOVER;
1402 __ceph_umount_begin(fsc);
1404 /* Make sure all page caches get invalidated.
1405 * see remove_session_caps_cb() */
1406 flush_workqueue(fsc->inode_wq);
1408 /* In case that we were blocklisted. This also reset
1409 * all mon/osd connections */
1410 ceph_reset_client_addr(fsc->client);
1412 ceph_osdc_clear_abort_err(&fsc->client->osdc);
1414 fsc->blocklisted = false;
1415 fsc->mount_state = CEPH_MOUNT_MOUNTED;
1418 err = __ceph_do_getattr(d_inode(sb->s_root), NULL,
1419 CEPH_STAT_CAP_INODE, true);
1424 static int __init init_ceph(void)
1426 int ret = init_caches();
1431 ret = register_filesystem(&ceph_fs_type);
1435 pr_info("loaded (mds proto %d)\n", CEPH_MDSC_PROTOCOL);
1445 static void __exit exit_ceph(void)
1447 dout("exit_ceph\n");
1448 unregister_filesystem(&ceph_fs_type);
1452 static int param_set_metrics(const char *val, const struct kernel_param *kp)
1454 struct ceph_fs_client *fsc;
1457 ret = param_set_bool(val, kp);
1459 pr_err("Failed to parse sending metrics switch value '%s'\n",
1462 } else if (!disable_send_metrics) {
1463 // wake up all the mds clients
1464 spin_lock(&ceph_fsc_lock);
1465 list_for_each_entry(fsc, &ceph_fsc_list, metric_wakeup) {
1466 metric_schedule_delayed(&fsc->mdsc->metric);
1468 spin_unlock(&ceph_fsc_lock);
1474 static const struct kernel_param_ops param_ops_metrics = {
1475 .set = param_set_metrics,
1476 .get = param_get_bool,
1479 bool disable_send_metrics = false;
1480 module_param_cb(disable_send_metrics, ¶m_ops_metrics, &disable_send_metrics, 0644);
1481 MODULE_PARM_DESC(disable_send_metrics, "Enable sending perf metrics to ceph cluster (default: on)");
1483 /* for both v1 and v2 syntax */
1484 static bool mount_support = true;
1485 static const struct kernel_param_ops param_ops_mount_syntax = {
1486 .get = param_get_bool,
1488 module_param_cb(mount_syntax_v1, ¶m_ops_mount_syntax, &mount_support, 0444);
1489 module_param_cb(mount_syntax_v2, ¶m_ops_mount_syntax, &mount_support, 0444);
1491 module_init(init_ceph);
1492 module_exit(exit_ceph);
1494 MODULE_AUTHOR("Sage Weil <sage@newdream.net>");
1495 MODULE_AUTHOR("Yehuda Sadeh <yehuda@hq.newdream.net>");
1496 MODULE_AUTHOR("Patience Warnick <patience@newdream.net>");
1497 MODULE_DESCRIPTION("Ceph filesystem for Linux");
1498 MODULE_LICENSE("GPL");