2 #include <linux/ceph/ceph_debug.h>
3 #include <linux/backing-dev.h>
4 #include <linux/ctype.h>
6 #include <linux/inet.h>
9 #include <keys/ceph-type.h>
10 #include <linux/module.h>
11 #include <linux/mount.h>
12 #include <linux/nsproxy.h>
13 #include <linux/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>
19 #include <linux/vmalloc.h>
22 #include <linux/ceph/ceph_features.h>
23 #include <linux/ceph/libceph.h>
24 #include <linux/ceph/debugfs.h>
25 #include <linux/ceph/decode.h>
26 #include <linux/ceph/mon_client.h>
27 #include <linux/ceph/auth.h>
32 * Module compatibility interface. For now it doesn't do anything,
33 * but its existence signals a certain level of functionality.
35 * The data buffer is used to pass information both to and from
36 * libceph. The return value indicates whether libceph determines
37 * it is compatible with the caller (from another kernel module),
38 * given the provided data.
40 * The data pointer can be null.
42 bool libceph_compatible(void *data
)
46 EXPORT_SYMBOL(libceph_compatible
);
48 static int param_get_supported_features(char *buffer
,
49 const struct kernel_param
*kp
)
51 return sprintf(buffer
, "0x%llx", CEPH_FEATURES_SUPPORTED_DEFAULT
);
53 static const struct kernel_param_ops param_ops_supported_features
= {
54 .get
= param_get_supported_features
,
56 module_param_cb(supported_features
, ¶m_ops_supported_features
, NULL
,
59 const char *ceph_msg_type_name(int type
)
62 case CEPH_MSG_SHUTDOWN
: return "shutdown";
63 case CEPH_MSG_PING
: return "ping";
64 case CEPH_MSG_AUTH
: return "auth";
65 case CEPH_MSG_AUTH_REPLY
: return "auth_reply";
66 case CEPH_MSG_MON_MAP
: return "mon_map";
67 case CEPH_MSG_MON_GET_MAP
: return "mon_get_map";
68 case CEPH_MSG_MON_SUBSCRIBE
: return "mon_subscribe";
69 case CEPH_MSG_MON_SUBSCRIBE_ACK
: return "mon_subscribe_ack";
70 case CEPH_MSG_STATFS
: return "statfs";
71 case CEPH_MSG_STATFS_REPLY
: return "statfs_reply";
72 case CEPH_MSG_MON_GET_VERSION
: return "mon_get_version";
73 case CEPH_MSG_MON_GET_VERSION_REPLY
: return "mon_get_version_reply";
74 case CEPH_MSG_MDS_MAP
: return "mds_map";
75 case CEPH_MSG_CLIENT_SESSION
: return "client_session";
76 case CEPH_MSG_CLIENT_RECONNECT
: return "client_reconnect";
77 case CEPH_MSG_CLIENT_REQUEST
: return "client_request";
78 case CEPH_MSG_CLIENT_REQUEST_FORWARD
: return "client_request_forward";
79 case CEPH_MSG_CLIENT_REPLY
: return "client_reply";
80 case CEPH_MSG_CLIENT_CAPS
: return "client_caps";
81 case CEPH_MSG_CLIENT_CAPRELEASE
: return "client_cap_release";
82 case CEPH_MSG_CLIENT_SNAP
: return "client_snap";
83 case CEPH_MSG_CLIENT_LEASE
: return "client_lease";
84 case CEPH_MSG_OSD_MAP
: return "osd_map";
85 case CEPH_MSG_OSD_OP
: return "osd_op";
86 case CEPH_MSG_OSD_OPREPLY
: return "osd_opreply";
87 case CEPH_MSG_WATCH_NOTIFY
: return "watch_notify";
88 default: return "unknown";
91 EXPORT_SYMBOL(ceph_msg_type_name
);
94 * Initially learn our fsid, or verify an fsid matches.
96 int ceph_check_fsid(struct ceph_client
*client
, struct ceph_fsid
*fsid
)
98 if (client
->have_fsid
) {
99 if (ceph_fsid_compare(&client
->fsid
, fsid
)) {
100 pr_err("bad fsid, had %pU got %pU",
101 &client
->fsid
, fsid
);
105 memcpy(&client
->fsid
, fsid
, sizeof(*fsid
));
109 EXPORT_SYMBOL(ceph_check_fsid
);
111 static int strcmp_null(const char *s1
, const char *s2
)
119 return strcmp(s1
, s2
);
122 int ceph_compare_options(struct ceph_options
*new_opt
,
123 struct ceph_client
*client
)
125 struct ceph_options
*opt1
= new_opt
;
126 struct ceph_options
*opt2
= client
->options
;
127 int ofs
= offsetof(struct ceph_options
, mon_addr
);
132 * Don't bother comparing options if network namespaces don't
135 if (!net_eq(current
->nsproxy
->net_ns
, read_pnet(&client
->msgr
.net
)))
138 ret
= memcmp(opt1
, opt2
, ofs
);
142 ret
= strcmp_null(opt1
->name
, opt2
->name
);
146 if (opt1
->key
&& !opt2
->key
)
148 if (!opt1
->key
&& opt2
->key
)
150 if (opt1
->key
&& opt2
->key
) {
151 if (opt1
->key
->type
!= opt2
->key
->type
)
153 if (opt1
->key
->created
.tv_sec
!= opt2
->key
->created
.tv_sec
)
155 if (opt1
->key
->created
.tv_nsec
!= opt2
->key
->created
.tv_nsec
)
157 if (opt1
->key
->len
!= opt2
->key
->len
)
159 if (opt1
->key
->key
&& !opt2
->key
->key
)
161 if (!opt1
->key
->key
&& opt2
->key
->key
)
163 if (opt1
->key
->key
&& opt2
->key
->key
) {
164 ret
= memcmp(opt1
->key
->key
, opt2
->key
->key
, opt1
->key
->len
);
170 /* any matching mon ip implies a match */
171 for (i
= 0; i
< opt1
->num_mon
; i
++) {
172 if (ceph_monmap_contains(client
->monc
.monmap
,
178 EXPORT_SYMBOL(ceph_compare_options
);
180 void *ceph_kvmalloc(size_t size
, gfp_t flags
)
182 if (size
<= (PAGE_SIZE
<< PAGE_ALLOC_COSTLY_ORDER
)) {
183 void *ptr
= kmalloc(size
, flags
| __GFP_NOWARN
);
188 return __vmalloc(size
, flags
, PAGE_KERNEL
);
192 static int parse_fsid(const char *str
, struct ceph_fsid
*fsid
)
199 dout("parse_fsid '%s'\n", str
);
201 while (*str
&& i
< 16) {
206 if (!isxdigit(str
[0]) || !isxdigit(str
[1]))
210 if (sscanf(tmp
, "%x", &d
) < 1)
212 fsid
->fsid
[i
] = d
& 0xff;
219 dout("parse_fsid ret %d got fsid %pU", err
, fsid
);
228 Opt_osdkeepalivetimeout
,
231 Opt_osd_request_timeout
,
240 /* string args above */
245 Opt_cephx_require_signatures
,
246 Opt_nocephx_require_signatures
,
247 Opt_cephx_sign_messages
,
248 Opt_nocephx_sign_messages
,
253 static match_table_t opt_tokens
= {
254 {Opt_osdtimeout
, "osdtimeout=%d"},
255 {Opt_osdkeepalivetimeout
, "osdkeepalive=%d"},
256 {Opt_mount_timeout
, "mount_timeout=%d"},
257 {Opt_osd_idle_ttl
, "osd_idle_ttl=%d"},
258 {Opt_osd_request_timeout
, "osd_request_timeout=%d"},
260 {Opt_fsid
, "fsid=%s"},
261 {Opt_name
, "name=%s"},
262 {Opt_secret
, "secret=%s"},
265 /* string args above */
266 {Opt_share
, "share"},
267 {Opt_noshare
, "noshare"},
269 {Opt_nocrc
, "nocrc"},
270 {Opt_cephx_require_signatures
, "cephx_require_signatures"},
271 {Opt_nocephx_require_signatures
, "nocephx_require_signatures"},
272 {Opt_cephx_sign_messages
, "cephx_sign_messages"},
273 {Opt_nocephx_sign_messages
, "nocephx_sign_messages"},
274 {Opt_tcp_nodelay
, "tcp_nodelay"},
275 {Opt_notcp_nodelay
, "notcp_nodelay"},
279 void ceph_destroy_options(struct ceph_options
*opt
)
281 dout("destroy_options %p\n", opt
);
284 ceph_crypto_key_destroy(opt
->key
);
287 kfree(opt
->mon_addr
);
290 EXPORT_SYMBOL(ceph_destroy_options
);
292 /* get secret from key store */
293 static int get_secret(struct ceph_crypto_key
*dst
, const char *name
) {
297 struct ceph_crypto_key
*ckey
;
299 ukey
= request_key(&key_type_ceph
, name
, NULL
);
300 if (!ukey
|| IS_ERR(ukey
)) {
301 /* request_key errors don't map nicely to mount(2)
302 errors; don't even try, but still printk */
303 key_err
= PTR_ERR(ukey
);
306 pr_warn("ceph: Mount failed due to key not found: %s\n",
310 pr_warn("ceph: Mount failed due to expired key: %s\n",
314 pr_warn("ceph: Mount failed due to revoked key: %s\n",
318 pr_warn("ceph: Mount failed due to unknown key error %d: %s\n",
325 ckey
= ukey
->payload
.data
[0];
326 err
= ceph_crypto_key_clone(dst
, ckey
);
329 /* pass through, err is 0 */
337 struct ceph_options
*
338 ceph_parse_options(char *options
, const char *dev_name
,
339 const char *dev_name_end
,
340 int (*parse_extra_token
)(char *c
, void *private),
343 struct ceph_options
*opt
;
346 substring_t argstr
[MAX_OPT_ARGS
];
348 opt
= kzalloc(sizeof(*opt
), GFP_KERNEL
);
350 return ERR_PTR(-ENOMEM
);
351 opt
->mon_addr
= kcalloc(CEPH_MAX_MON
, sizeof(*opt
->mon_addr
),
356 dout("parse_options %p options '%s' dev_name '%s'\n", opt
, options
,
359 /* start with defaults */
360 opt
->flags
= CEPH_OPT_DEFAULT
;
361 opt
->osd_keepalive_timeout
= CEPH_OSD_KEEPALIVE_DEFAULT
;
362 opt
->mount_timeout
= CEPH_MOUNT_TIMEOUT_DEFAULT
;
363 opt
->osd_idle_ttl
= CEPH_OSD_IDLE_TTL_DEFAULT
;
364 opt
->osd_request_timeout
= CEPH_OSD_REQUEST_TIMEOUT_DEFAULT
;
367 /* ip1[:port1][,ip2[:port2]...] */
368 err
= ceph_parse_ips(dev_name
, dev_name_end
, opt
->mon_addr
,
369 CEPH_MAX_MON
, &opt
->num_mon
);
373 /* parse mount options */
374 while ((c
= strsep(&options
, ",")) != NULL
) {
375 int token
, intval
, ret
;
379 token
= match_token((char *)c
, opt_tokens
, argstr
);
380 if (token
< 0 && parse_extra_token
) {
382 err
= parse_extra_token((char *)c
, private);
384 pr_err("bad option at '%s'\n", c
);
389 if (token
< Opt_last_int
) {
390 ret
= match_int(&argstr
[0], &intval
);
392 pr_err("bad mount option arg (not int) "
396 dout("got int token %d val %d\n", token
, intval
);
397 } else if (token
> Opt_last_int
&& token
< Opt_last_string
) {
398 dout("got string token %d val %s\n", token
,
401 dout("got token %d\n", token
);
405 err
= ceph_parse_ips(argstr
[0].from
,
411 opt
->flags
|= CEPH_OPT_MYIP
;
415 err
= parse_fsid(argstr
[0].from
, &opt
->fsid
);
417 opt
->flags
|= CEPH_OPT_FSID
;
420 opt
->name
= kstrndup(argstr
[0].from
,
421 argstr
[0].to
-argstr
[0].from
,
425 opt
->key
= kzalloc(sizeof(*opt
->key
), GFP_KERNEL
);
430 err
= ceph_crypto_key_unarmor(opt
->key
, argstr
[0].from
);
435 opt
->key
= kzalloc(sizeof(*opt
->key
), GFP_KERNEL
);
440 err
= get_secret(opt
->key
, argstr
[0].from
);
447 pr_warn("ignoring deprecated osdtimeout option\n");
449 case Opt_osdkeepalivetimeout
:
450 /* 0 isn't well defined right now, reject it */
451 if (intval
< 1 || intval
> INT_MAX
/ 1000) {
452 pr_err("osdkeepalive out of range\n");
456 opt
->osd_keepalive_timeout
=
457 msecs_to_jiffies(intval
* 1000);
459 case Opt_osd_idle_ttl
:
460 /* 0 isn't well defined right now, reject it */
461 if (intval
< 1 || intval
> INT_MAX
/ 1000) {
462 pr_err("osd_idle_ttl out of range\n");
466 opt
->osd_idle_ttl
= msecs_to_jiffies(intval
* 1000);
468 case Opt_mount_timeout
:
469 /* 0 is "wait forever" (i.e. infinite timeout) */
470 if (intval
< 0 || intval
> INT_MAX
/ 1000) {
471 pr_err("mount_timeout out of range\n");
475 opt
->mount_timeout
= msecs_to_jiffies(intval
* 1000);
477 case Opt_osd_request_timeout
:
478 /* 0 is "wait forever" (i.e. infinite timeout) */
479 if (intval
< 0 || intval
> INT_MAX
/ 1000) {
480 pr_err("osd_request_timeout out of range\n");
484 opt
->osd_request_timeout
= msecs_to_jiffies(intval
* 1000);
488 opt
->flags
&= ~CEPH_OPT_NOSHARE
;
491 opt
->flags
|= CEPH_OPT_NOSHARE
;
495 opt
->flags
&= ~CEPH_OPT_NOCRC
;
498 opt
->flags
|= CEPH_OPT_NOCRC
;
501 case Opt_cephx_require_signatures
:
502 opt
->flags
&= ~CEPH_OPT_NOMSGAUTH
;
504 case Opt_nocephx_require_signatures
:
505 opt
->flags
|= CEPH_OPT_NOMSGAUTH
;
507 case Opt_cephx_sign_messages
:
508 opt
->flags
&= ~CEPH_OPT_NOMSGSIGN
;
510 case Opt_nocephx_sign_messages
:
511 opt
->flags
|= CEPH_OPT_NOMSGSIGN
;
514 case Opt_tcp_nodelay
:
515 opt
->flags
|= CEPH_OPT_TCP_NODELAY
;
517 case Opt_notcp_nodelay
:
518 opt
->flags
&= ~CEPH_OPT_TCP_NODELAY
;
530 ceph_destroy_options(opt
);
533 EXPORT_SYMBOL(ceph_parse_options
);
535 int ceph_print_client_options(struct seq_file
*m
, struct ceph_client
*client
)
537 struct ceph_options
*opt
= client
->options
;
538 size_t pos
= m
->count
;
541 seq_puts(m
, "name=");
542 seq_escape(m
, opt
->name
, ", \t\n\\");
546 seq_puts(m
, "secret=<hidden>,");
548 if (opt
->flags
& CEPH_OPT_FSID
)
549 seq_printf(m
, "fsid=%pU,", &opt
->fsid
);
550 if (opt
->flags
& CEPH_OPT_NOSHARE
)
551 seq_puts(m
, "noshare,");
552 if (opt
->flags
& CEPH_OPT_NOCRC
)
553 seq_puts(m
, "nocrc,");
554 if (opt
->flags
& CEPH_OPT_NOMSGAUTH
)
555 seq_puts(m
, "nocephx_require_signatures,");
556 if (opt
->flags
& CEPH_OPT_NOMSGSIGN
)
557 seq_puts(m
, "nocephx_sign_messages,");
558 if ((opt
->flags
& CEPH_OPT_TCP_NODELAY
) == 0)
559 seq_puts(m
, "notcp_nodelay,");
561 if (opt
->mount_timeout
!= CEPH_MOUNT_TIMEOUT_DEFAULT
)
562 seq_printf(m
, "mount_timeout=%d,",
563 jiffies_to_msecs(opt
->mount_timeout
) / 1000);
564 if (opt
->osd_idle_ttl
!= CEPH_OSD_IDLE_TTL_DEFAULT
)
565 seq_printf(m
, "osd_idle_ttl=%d,",
566 jiffies_to_msecs(opt
->osd_idle_ttl
) / 1000);
567 if (opt
->osd_keepalive_timeout
!= CEPH_OSD_KEEPALIVE_DEFAULT
)
568 seq_printf(m
, "osdkeepalivetimeout=%d,",
569 jiffies_to_msecs(opt
->osd_keepalive_timeout
) / 1000);
570 if (opt
->osd_request_timeout
!= CEPH_OSD_REQUEST_TIMEOUT_DEFAULT
)
571 seq_printf(m
, "osd_request_timeout=%d,",
572 jiffies_to_msecs(opt
->osd_request_timeout
) / 1000);
574 /* drop redundant comma */
580 EXPORT_SYMBOL(ceph_print_client_options
);
582 struct ceph_entity_addr
*ceph_client_addr(struct ceph_client
*client
)
584 return &client
->msgr
.inst
.addr
;
586 EXPORT_SYMBOL(ceph_client_addr
);
588 u64
ceph_client_gid(struct ceph_client
*client
)
590 return client
->monc
.auth
->global_id
;
592 EXPORT_SYMBOL(ceph_client_gid
);
595 * create a fresh client instance
597 struct ceph_client
*ceph_create_client(struct ceph_options
*opt
, void *private)
599 struct ceph_client
*client
;
600 struct ceph_entity_addr
*myaddr
= NULL
;
603 client
= kzalloc(sizeof(*client
), GFP_KERNEL
);
605 return ERR_PTR(-ENOMEM
);
607 client
->private = private;
608 client
->options
= opt
;
610 mutex_init(&client
->mount_mutex
);
611 init_waitqueue_head(&client
->auth_wq
);
612 client
->auth_err
= 0;
614 client
->extra_mon_dispatch
= NULL
;
615 client
->supported_features
= CEPH_FEATURES_SUPPORTED_DEFAULT
;
616 client
->required_features
= CEPH_FEATURES_REQUIRED_DEFAULT
;
618 if (!ceph_test_opt(client
, NOMSGAUTH
))
619 client
->required_features
|= CEPH_FEATURE_MSG_AUTH
;
622 if (ceph_test_opt(client
, MYIP
))
623 myaddr
= &client
->options
->my_addr
;
625 ceph_messenger_init(&client
->msgr
, myaddr
);
628 err
= ceph_monc_init(&client
->monc
, client
);
631 err
= ceph_osdc_init(&client
->osdc
, client
);
638 ceph_monc_stop(&client
->monc
);
640 ceph_messenger_fini(&client
->msgr
);
644 EXPORT_SYMBOL(ceph_create_client
);
646 void ceph_destroy_client(struct ceph_client
*client
)
648 dout("destroy_client %p\n", client
);
650 atomic_set(&client
->msgr
.stopping
, 1);
653 ceph_osdc_stop(&client
->osdc
);
654 ceph_monc_stop(&client
->monc
);
655 ceph_messenger_fini(&client
->msgr
);
657 ceph_debugfs_client_cleanup(client
);
659 ceph_destroy_options(client
->options
);
662 dout("destroy_client %p done\n", client
);
664 EXPORT_SYMBOL(ceph_destroy_client
);
667 * true if we have the mon map (and have thus joined the cluster)
669 static bool have_mon_and_osd_map(struct ceph_client
*client
)
671 return client
->monc
.monmap
&& client
->monc
.monmap
->epoch
&&
672 client
->osdc
.osdmap
&& client
->osdc
.osdmap
->epoch
;
676 * mount: join the ceph cluster, and open root directory.
678 int __ceph_open_session(struct ceph_client
*client
, unsigned long started
)
680 unsigned long timeout
= client
->options
->mount_timeout
;
683 /* open session, and wait for mon and osd maps */
684 err
= ceph_monc_open_session(&client
->monc
);
688 while (!have_mon_and_osd_map(client
)) {
689 if (timeout
&& time_after_eq(jiffies
, started
+ timeout
))
693 dout("mount waiting for mon_map\n");
694 err
= wait_event_interruptible_timeout(client
->auth_wq
,
695 have_mon_and_osd_map(client
) || (client
->auth_err
< 0),
696 ceph_timeout_jiffies(timeout
));
699 if (client
->auth_err
< 0)
700 return client
->auth_err
;
703 pr_info("client%llu fsid %pU\n", ceph_client_gid(client
),
705 ceph_debugfs_client_init(client
);
709 EXPORT_SYMBOL(__ceph_open_session
);
712 int ceph_open_session(struct ceph_client
*client
)
715 unsigned long started
= jiffies
; /* note the start time */
717 dout("open_session start\n");
718 mutex_lock(&client
->mount_mutex
);
720 ret
= __ceph_open_session(client
, started
);
722 mutex_unlock(&client
->mount_mutex
);
725 EXPORT_SYMBOL(ceph_open_session
);
728 static int __init
init_ceph_lib(void)
732 ret
= ceph_debugfs_init();
736 ret
= ceph_crypto_init();
740 ret
= ceph_msgr_init();
744 ret
= ceph_osdc_setup();
748 pr_info("loaded (mon/osd proto %d/%d)\n",
749 CEPH_MONC_PROTOCOL
, CEPH_OSDC_PROTOCOL
);
756 ceph_crypto_shutdown();
758 ceph_debugfs_cleanup();
763 static void __exit
exit_ceph_lib(void)
765 dout("exit_ceph_lib\n");
766 WARN_ON(!ceph_strings_empty());
770 ceph_crypto_shutdown();
771 ceph_debugfs_cleanup();
774 module_init(init_ceph_lib
);
775 module_exit(exit_ceph_lib
);
777 MODULE_AUTHOR("Sage Weil <sage@newdream.net>");
778 MODULE_AUTHOR("Yehuda Sadeh <yehuda@hq.newdream.net>");
779 MODULE_AUTHOR("Patience Warnick <patience@newdream.net>");
780 MODULE_DESCRIPTION("Ceph core library");
781 MODULE_LICENSE("GPL");