bec181181d41f1ea43779d85a54c9607553fffc0
[linux-block.git] / net / ceph / ceph_common.c
1 // SPDX-License-Identifier: GPL-2.0-only
2
3 #include <linux/ceph/ceph_debug.h>
4 #include <linux/backing-dev.h>
5 #include <linux/ctype.h>
6 #include <linux/fs.h>
7 #include <linux/inet.h>
8 #include <linux/in6.h>
9 #include <linux/key.h>
10 #include <keys/ceph-type.h>
11 #include <linux/module.h>
12 #include <linux/mount.h>
13 #include <linux/nsproxy.h>
14 #include <linux/fs_parser.h>
15 #include <linux/sched.h>
16 #include <linux/sched/mm.h>
17 #include <linux/seq_file.h>
18 #include <linux/slab.h>
19 #include <linux/statfs.h>
20 #include <linux/string.h>
21 #include <linux/vmalloc.h>
22
23
24 #include <linux/ceph/ceph_features.h>
25 #include <linux/ceph/libceph.h>
26 #include <linux/ceph/debugfs.h>
27 #include <linux/ceph/decode.h>
28 #include <linux/ceph/mon_client.h>
29 #include <linux/ceph/auth.h>
30 #include "crypto.h"
31
32
33 /*
34  * Module compatibility interface.  For now it doesn't do anything,
35  * but its existence signals a certain level of functionality.
36  *
37  * The data buffer is used to pass information both to and from
38  * libceph.  The return value indicates whether libceph determines
39  * it is compatible with the caller (from another kernel module),
40  * given the provided data.
41  *
42  * The data pointer can be null.
43  */
44 bool libceph_compatible(void *data)
45 {
46         return true;
47 }
48 EXPORT_SYMBOL(libceph_compatible);
49
50 static int param_get_supported_features(char *buffer,
51                                         const struct kernel_param *kp)
52 {
53         return sprintf(buffer, "0x%llx", CEPH_FEATURES_SUPPORTED_DEFAULT);
54 }
55 static const struct kernel_param_ops param_ops_supported_features = {
56         .get = param_get_supported_features,
57 };
58 module_param_cb(supported_features, &param_ops_supported_features, NULL,
59                 0444);
60
61 const char *ceph_msg_type_name(int type)
62 {
63         switch (type) {
64         case CEPH_MSG_SHUTDOWN: return "shutdown";
65         case CEPH_MSG_PING: return "ping";
66         case CEPH_MSG_AUTH: return "auth";
67         case CEPH_MSG_AUTH_REPLY: return "auth_reply";
68         case CEPH_MSG_MON_MAP: return "mon_map";
69         case CEPH_MSG_MON_GET_MAP: return "mon_get_map";
70         case CEPH_MSG_MON_SUBSCRIBE: return "mon_subscribe";
71         case CEPH_MSG_MON_SUBSCRIBE_ACK: return "mon_subscribe_ack";
72         case CEPH_MSG_STATFS: return "statfs";
73         case CEPH_MSG_STATFS_REPLY: return "statfs_reply";
74         case CEPH_MSG_MON_GET_VERSION: return "mon_get_version";
75         case CEPH_MSG_MON_GET_VERSION_REPLY: return "mon_get_version_reply";
76         case CEPH_MSG_MDS_MAP: return "mds_map";
77         case CEPH_MSG_FS_MAP_USER: return "fs_map_user";
78         case CEPH_MSG_CLIENT_SESSION: return "client_session";
79         case CEPH_MSG_CLIENT_RECONNECT: return "client_reconnect";
80         case CEPH_MSG_CLIENT_REQUEST: return "client_request";
81         case CEPH_MSG_CLIENT_REQUEST_FORWARD: return "client_request_forward";
82         case CEPH_MSG_CLIENT_REPLY: return "client_reply";
83         case CEPH_MSG_CLIENT_CAPS: return "client_caps";
84         case CEPH_MSG_CLIENT_CAPRELEASE: return "client_cap_release";
85         case CEPH_MSG_CLIENT_QUOTA: return "client_quota";
86         case CEPH_MSG_CLIENT_SNAP: return "client_snap";
87         case CEPH_MSG_CLIENT_LEASE: return "client_lease";
88         case CEPH_MSG_POOLOP_REPLY: return "poolop_reply";
89         case CEPH_MSG_POOLOP: return "poolop";
90         case CEPH_MSG_MON_COMMAND: return "mon_command";
91         case CEPH_MSG_MON_COMMAND_ACK: return "mon_command_ack";
92         case CEPH_MSG_OSD_MAP: return "osd_map";
93         case CEPH_MSG_OSD_OP: return "osd_op";
94         case CEPH_MSG_OSD_OPREPLY: return "osd_opreply";
95         case CEPH_MSG_WATCH_NOTIFY: return "watch_notify";
96         case CEPH_MSG_OSD_BACKOFF: return "osd_backoff";
97         default: return "unknown";
98         }
99 }
100 EXPORT_SYMBOL(ceph_msg_type_name);
101
102 /*
103  * Initially learn our fsid, or verify an fsid matches.
104  */
105 int ceph_check_fsid(struct ceph_client *client, struct ceph_fsid *fsid)
106 {
107         if (client->have_fsid) {
108                 if (ceph_fsid_compare(&client->fsid, fsid)) {
109                         pr_err("bad fsid, had %pU got %pU",
110                                &client->fsid, fsid);
111                         return -1;
112                 }
113         } else {
114                 memcpy(&client->fsid, fsid, sizeof(*fsid));
115         }
116         return 0;
117 }
118 EXPORT_SYMBOL(ceph_check_fsid);
119
120 static int strcmp_null(const char *s1, const char *s2)
121 {
122         if (!s1 && !s2)
123                 return 0;
124         if (s1 && !s2)
125                 return -1;
126         if (!s1 && s2)
127                 return 1;
128         return strcmp(s1, s2);
129 }
130
131 int ceph_compare_options(struct ceph_options *new_opt,
132                          struct ceph_client *client)
133 {
134         struct ceph_options *opt1 = new_opt;
135         struct ceph_options *opt2 = client->options;
136         int ofs = offsetof(struct ceph_options, mon_addr);
137         int i;
138         int ret;
139
140         /*
141          * Don't bother comparing options if network namespaces don't
142          * match.
143          */
144         if (!net_eq(current->nsproxy->net_ns, read_pnet(&client->msgr.net)))
145                 return -1;
146
147         ret = memcmp(opt1, opt2, ofs);
148         if (ret)
149                 return ret;
150
151         ret = strcmp_null(opt1->name, opt2->name);
152         if (ret)
153                 return ret;
154
155         if (opt1->key && !opt2->key)
156                 return -1;
157         if (!opt1->key && opt2->key)
158                 return 1;
159         if (opt1->key && opt2->key) {
160                 if (opt1->key->type != opt2->key->type)
161                         return -1;
162                 if (opt1->key->created.tv_sec != opt2->key->created.tv_sec)
163                         return -1;
164                 if (opt1->key->created.tv_nsec != opt2->key->created.tv_nsec)
165                         return -1;
166                 if (opt1->key->len != opt2->key->len)
167                         return -1;
168                 if (opt1->key->key && !opt2->key->key)
169                         return -1;
170                 if (!opt1->key->key && opt2->key->key)
171                         return 1;
172                 if (opt1->key->key && opt2->key->key) {
173                         ret = memcmp(opt1->key->key, opt2->key->key, opt1->key->len);
174                         if (ret)
175                                 return ret;
176                 }
177         }
178
179         ret = ceph_compare_crush_locs(&opt1->crush_locs, &opt2->crush_locs);
180         if (ret)
181                 return ret;
182
183         /* any matching mon ip implies a match */
184         for (i = 0; i < opt1->num_mon; i++) {
185                 if (ceph_monmap_contains(client->monc.monmap,
186                                  &opt1->mon_addr[i]))
187                         return 0;
188         }
189         return -1;
190 }
191 EXPORT_SYMBOL(ceph_compare_options);
192
193 /*
194  * kvmalloc() doesn't fall back to the vmalloc allocator unless flags are
195  * compatible with (a superset of) GFP_KERNEL.  This is because while the
196  * actual pages are allocated with the specified flags, the page table pages
197  * are always allocated with GFP_KERNEL.
198  *
199  * ceph_kvmalloc() may be called with GFP_KERNEL, GFP_NOFS or GFP_NOIO.
200  */
201 void *ceph_kvmalloc(size_t size, gfp_t flags)
202 {
203         void *p;
204
205         if ((flags & (__GFP_IO | __GFP_FS)) == (__GFP_IO | __GFP_FS)) {
206                 p = kvmalloc(size, flags);
207         } else if ((flags & (__GFP_IO | __GFP_FS)) == __GFP_IO) {
208                 unsigned int nofs_flag = memalloc_nofs_save();
209                 p = kvmalloc(size, GFP_KERNEL);
210                 memalloc_nofs_restore(nofs_flag);
211         } else {
212                 unsigned int noio_flag = memalloc_noio_save();
213                 p = kvmalloc(size, GFP_KERNEL);
214                 memalloc_noio_restore(noio_flag);
215         }
216
217         return p;
218 }
219
220 static int parse_fsid(const char *str, struct ceph_fsid *fsid)
221 {
222         int i = 0;
223         char tmp[3];
224         int err = -EINVAL;
225         int d;
226
227         dout("parse_fsid '%s'\n", str);
228         tmp[2] = 0;
229         while (*str && i < 16) {
230                 if (ispunct(*str)) {
231                         str++;
232                         continue;
233                 }
234                 if (!isxdigit(str[0]) || !isxdigit(str[1]))
235                         break;
236                 tmp[0] = str[0];
237                 tmp[1] = str[1];
238                 if (sscanf(tmp, "%x", &d) < 1)
239                         break;
240                 fsid->fsid[i] = d & 0xff;
241                 i++;
242                 str += 2;
243         }
244
245         if (i == 16)
246                 err = 0;
247         dout("parse_fsid ret %d got fsid %pU\n", err, fsid);
248         return err;
249 }
250
251 /*
252  * ceph options
253  */
254 enum {
255         Opt_osdtimeout,
256         Opt_osdkeepalivetimeout,
257         Opt_mount_timeout,
258         Opt_osd_idle_ttl,
259         Opt_osd_request_timeout,
260         /* int args above */
261         Opt_fsid,
262         Opt_name,
263         Opt_secret,
264         Opt_key,
265         Opt_ip,
266         Opt_crush_location,
267         Opt_read_from_replica,
268         Opt_ms_mode,
269         /* string args above */
270         Opt_share,
271         Opt_crc,
272         Opt_cephx_require_signatures,
273         Opt_cephx_sign_messages,
274         Opt_tcp_nodelay,
275         Opt_abort_on_full,
276 };
277
278 enum {
279         Opt_read_from_replica_no,
280         Opt_read_from_replica_balance,
281         Opt_read_from_replica_localize,
282 };
283
284 static const struct constant_table ceph_param_read_from_replica[] = {
285         {"no",          Opt_read_from_replica_no},
286         {"balance",     Opt_read_from_replica_balance},
287         {"localize",    Opt_read_from_replica_localize},
288         {}
289 };
290
291 enum ceph_ms_mode {
292         Opt_ms_mode_legacy,
293         Opt_ms_mode_crc,
294         Opt_ms_mode_secure,
295         Opt_ms_mode_prefer_crc,
296         Opt_ms_mode_prefer_secure
297 };
298
299 static const struct constant_table ceph_param_ms_mode[] = {
300         {"legacy",              Opt_ms_mode_legacy},
301         {"crc",                 Opt_ms_mode_crc},
302         {"secure",              Opt_ms_mode_secure},
303         {"prefer-crc",          Opt_ms_mode_prefer_crc},
304         {"prefer-secure",       Opt_ms_mode_prefer_secure},
305         {}
306 };
307
308 static const struct fs_parameter_spec ceph_parameters[] = {
309         fsparam_flag    ("abort_on_full",               Opt_abort_on_full),
310         __fsparam       (NULL, "cephx_require_signatures", Opt_cephx_require_signatures,
311                          fs_param_neg_with_no|fs_param_deprecated, NULL),
312         fsparam_flag_no ("cephx_sign_messages",         Opt_cephx_sign_messages),
313         fsparam_flag_no ("crc",                         Opt_crc),
314         fsparam_string  ("crush_location",              Opt_crush_location),
315         fsparam_string  ("fsid",                        Opt_fsid),
316         fsparam_string  ("ip",                          Opt_ip),
317         fsparam_string  ("key",                         Opt_key),
318         fsparam_u32     ("mount_timeout",               Opt_mount_timeout),
319         fsparam_string  ("name",                        Opt_name),
320         fsparam_u32     ("osd_idle_ttl",                Opt_osd_idle_ttl),
321         fsparam_u32     ("osd_request_timeout",         Opt_osd_request_timeout),
322         fsparam_u32     ("osdkeepalive",                Opt_osdkeepalivetimeout),
323         __fsparam       (fs_param_is_s32, "osdtimeout", Opt_osdtimeout,
324                          fs_param_deprecated, NULL),
325         fsparam_enum    ("read_from_replica",           Opt_read_from_replica,
326                          ceph_param_read_from_replica),
327         fsparam_enum    ("ms_mode",                     Opt_ms_mode,
328                          ceph_param_ms_mode),
329         fsparam_string  ("secret",                      Opt_secret),
330         fsparam_flag_no ("share",                       Opt_share),
331         fsparam_flag_no ("tcp_nodelay",                 Opt_tcp_nodelay),
332         {}
333 };
334
335 struct ceph_options *ceph_alloc_options(void)
336 {
337         struct ceph_options *opt;
338
339         opt = kzalloc(sizeof(*opt), GFP_KERNEL);
340         if (!opt)
341                 return NULL;
342
343         opt->crush_locs = RB_ROOT;
344         opt->mon_addr = kcalloc(CEPH_MAX_MON, sizeof(*opt->mon_addr),
345                                 GFP_KERNEL);
346         if (!opt->mon_addr) {
347                 kfree(opt);
348                 return NULL;
349         }
350
351         opt->flags = CEPH_OPT_DEFAULT;
352         opt->osd_keepalive_timeout = CEPH_OSD_KEEPALIVE_DEFAULT;
353         opt->mount_timeout = CEPH_MOUNT_TIMEOUT_DEFAULT;
354         opt->osd_idle_ttl = CEPH_OSD_IDLE_TTL_DEFAULT;
355         opt->osd_request_timeout = CEPH_OSD_REQUEST_TIMEOUT_DEFAULT;
356         opt->read_from_replica = CEPH_READ_FROM_REPLICA_DEFAULT;
357         opt->con_modes[0] = CEPH_CON_MODE_UNKNOWN;
358         opt->con_modes[1] = CEPH_CON_MODE_UNKNOWN;
359         return opt;
360 }
361 EXPORT_SYMBOL(ceph_alloc_options);
362
363 void ceph_destroy_options(struct ceph_options *opt)
364 {
365         dout("destroy_options %p\n", opt);
366         if (!opt)
367                 return;
368
369         ceph_clear_crush_locs(&opt->crush_locs);
370         kfree(opt->name);
371         if (opt->key) {
372                 ceph_crypto_key_destroy(opt->key);
373                 kfree(opt->key);
374         }
375         kfree(opt->mon_addr);
376         kfree(opt);
377 }
378 EXPORT_SYMBOL(ceph_destroy_options);
379
380 /* get secret from key store */
381 static int get_secret(struct ceph_crypto_key *dst, const char *name,
382                       struct p_log *log)
383 {
384         struct key *ukey;
385         int key_err;
386         int err = 0;
387         struct ceph_crypto_key *ckey;
388
389         ukey = request_key(&key_type_ceph, name, NULL);
390         if (IS_ERR(ukey)) {
391                 /* request_key errors don't map nicely to mount(2)
392                    errors; don't even try, but still printk */
393                 key_err = PTR_ERR(ukey);
394                 switch (key_err) {
395                 case -ENOKEY:
396                         error_plog(log, "Failed due to key not found: %s",
397                                name);
398                         break;
399                 case -EKEYEXPIRED:
400                         error_plog(log, "Failed due to expired key: %s",
401                                name);
402                         break;
403                 case -EKEYREVOKED:
404                         error_plog(log, "Failed due to revoked key: %s",
405                                name);
406                         break;
407                 default:
408                         error_plog(log, "Failed due to key error %d: %s",
409                                key_err, name);
410                 }
411                 err = -EPERM;
412                 goto out;
413         }
414
415         ckey = ukey->payload.data[0];
416         err = ceph_crypto_key_clone(dst, ckey);
417         if (err)
418                 goto out_key;
419         /* pass through, err is 0 */
420
421 out_key:
422         key_put(ukey);
423 out:
424         return err;
425 }
426
427 int ceph_parse_mon_ips(const char *buf, size_t len, struct ceph_options *opt,
428                        struct fc_log *l)
429 {
430         struct p_log log = {.prefix = "libceph", .log = l};
431         int ret;
432
433         /* ip1[:port1][,ip2[:port2]...] */
434         ret = ceph_parse_ips(buf, buf + len, opt->mon_addr, CEPH_MAX_MON,
435                              &opt->num_mon);
436         if (ret) {
437                 error_plog(&log, "Failed to parse monitor IPs: %d", ret);
438                 return ret;
439         }
440
441         return 0;
442 }
443 EXPORT_SYMBOL(ceph_parse_mon_ips);
444
445 int ceph_parse_param(struct fs_parameter *param, struct ceph_options *opt,
446                      struct fc_log *l)
447 {
448         struct fs_parse_result result;
449         int token, err;
450         struct p_log log = {.prefix = "libceph", .log = l};
451
452         token = __fs_parse(&log, ceph_parameters, param, &result);
453         dout("%s fs_parse '%s' token %d\n", __func__, param->key, token);
454         if (token < 0)
455                 return token;
456
457         switch (token) {
458         case Opt_ip:
459                 err = ceph_parse_ips(param->string,
460                                      param->string + param->size,
461                                      &opt->my_addr,
462                                      1, NULL);
463                 if (err) {
464                         error_plog(&log, "Failed to parse ip: %d", err);
465                         return err;
466                 }
467                 opt->flags |= CEPH_OPT_MYIP;
468                 break;
469
470         case Opt_fsid:
471                 err = parse_fsid(param->string, &opt->fsid);
472                 if (err) {
473                         error_plog(&log, "Failed to parse fsid: %d", err);
474                         return err;
475                 }
476                 opt->flags |= CEPH_OPT_FSID;
477                 break;
478         case Opt_name:
479                 kfree(opt->name);
480                 opt->name = param->string;
481                 param->string = NULL;
482                 break;
483         case Opt_secret:
484                 ceph_crypto_key_destroy(opt->key);
485                 kfree(opt->key);
486
487                 opt->key = kzalloc(sizeof(*opt->key), GFP_KERNEL);
488                 if (!opt->key)
489                         return -ENOMEM;
490                 err = ceph_crypto_key_unarmor(opt->key, param->string);
491                 if (err) {
492                         error_plog(&log, "Failed to parse secret: %d", err);
493                         return err;
494                 }
495                 break;
496         case Opt_key:
497                 ceph_crypto_key_destroy(opt->key);
498                 kfree(opt->key);
499
500                 opt->key = kzalloc(sizeof(*opt->key), GFP_KERNEL);
501                 if (!opt->key)
502                         return -ENOMEM;
503                 return get_secret(opt->key, param->string, &log);
504         case Opt_crush_location:
505                 ceph_clear_crush_locs(&opt->crush_locs);
506                 err = ceph_parse_crush_location(param->string,
507                                                 &opt->crush_locs);
508                 if (err) {
509                         error_plog(&log, "Failed to parse CRUSH location: %d",
510                                    err);
511                         return err;
512                 }
513                 break;
514         case Opt_read_from_replica:
515                 switch (result.uint_32) {
516                 case Opt_read_from_replica_no:
517                         opt->read_from_replica = 0;
518                         break;
519                 case Opt_read_from_replica_balance:
520                         opt->read_from_replica = CEPH_OSD_FLAG_BALANCE_READS;
521                         break;
522                 case Opt_read_from_replica_localize:
523                         opt->read_from_replica = CEPH_OSD_FLAG_LOCALIZE_READS;
524                         break;
525                 default:
526                         BUG();
527                 }
528                 break;
529         case Opt_ms_mode:
530                 switch (result.uint_32) {
531                 case Opt_ms_mode_legacy:
532                         opt->con_modes[0] = CEPH_CON_MODE_UNKNOWN;
533                         opt->con_modes[1] = CEPH_CON_MODE_UNKNOWN;
534                         break;
535                 case Opt_ms_mode_crc:
536                         opt->con_modes[0] = CEPH_CON_MODE_CRC;
537                         opt->con_modes[1] = CEPH_CON_MODE_UNKNOWN;
538                         break;
539                 case Opt_ms_mode_secure:
540                         opt->con_modes[0] = CEPH_CON_MODE_SECURE;
541                         opt->con_modes[1] = CEPH_CON_MODE_UNKNOWN;
542                         break;
543                 case Opt_ms_mode_prefer_crc:
544                         opt->con_modes[0] = CEPH_CON_MODE_CRC;
545                         opt->con_modes[1] = CEPH_CON_MODE_SECURE;
546                         break;
547                 case Opt_ms_mode_prefer_secure:
548                         opt->con_modes[0] = CEPH_CON_MODE_SECURE;
549                         opt->con_modes[1] = CEPH_CON_MODE_CRC;
550                         break;
551                 default:
552                         BUG();
553                 }
554                 break;
555
556         case Opt_osdtimeout:
557                 warn_plog(&log, "Ignoring osdtimeout");
558                 break;
559         case Opt_osdkeepalivetimeout:
560                 /* 0 isn't well defined right now, reject it */
561                 if (result.uint_32 < 1 || result.uint_32 > INT_MAX / 1000)
562                         goto out_of_range;
563                 opt->osd_keepalive_timeout =
564                     msecs_to_jiffies(result.uint_32 * 1000);
565                 break;
566         case Opt_osd_idle_ttl:
567                 /* 0 isn't well defined right now, reject it */
568                 if (result.uint_32 < 1 || result.uint_32 > INT_MAX / 1000)
569                         goto out_of_range;
570                 opt->osd_idle_ttl = msecs_to_jiffies(result.uint_32 * 1000);
571                 break;
572         case Opt_mount_timeout:
573                 /* 0 is "wait forever" (i.e. infinite timeout) */
574                 if (result.uint_32 > INT_MAX / 1000)
575                         goto out_of_range;
576                 opt->mount_timeout = msecs_to_jiffies(result.uint_32 * 1000);
577                 break;
578         case Opt_osd_request_timeout:
579                 /* 0 is "wait forever" (i.e. infinite timeout) */
580                 if (result.uint_32 > INT_MAX / 1000)
581                         goto out_of_range;
582                 opt->osd_request_timeout =
583                     msecs_to_jiffies(result.uint_32 * 1000);
584                 break;
585
586         case Opt_share:
587                 if (!result.negated)
588                         opt->flags &= ~CEPH_OPT_NOSHARE;
589                 else
590                         opt->flags |= CEPH_OPT_NOSHARE;
591                 break;
592         case Opt_crc:
593                 if (!result.negated)
594                         opt->flags &= ~CEPH_OPT_NOCRC;
595                 else
596                         opt->flags |= CEPH_OPT_NOCRC;
597                 break;
598         case Opt_cephx_require_signatures:
599                 if (!result.negated)
600                         warn_plog(&log, "Ignoring cephx_require_signatures");
601                 else
602                         warn_plog(&log, "Ignoring nocephx_require_signatures, use nocephx_sign_messages");
603                 break;
604         case Opt_cephx_sign_messages:
605                 if (!result.negated)
606                         opt->flags &= ~CEPH_OPT_NOMSGSIGN;
607                 else
608                         opt->flags |= CEPH_OPT_NOMSGSIGN;
609                 break;
610         case Opt_tcp_nodelay:
611                 if (!result.negated)
612                         opt->flags |= CEPH_OPT_TCP_NODELAY;
613                 else
614                         opt->flags &= ~CEPH_OPT_TCP_NODELAY;
615                 break;
616
617         case Opt_abort_on_full:
618                 opt->flags |= CEPH_OPT_ABORT_ON_FULL;
619                 break;
620
621         default:
622                 BUG();
623         }
624
625         return 0;
626
627 out_of_range:
628         return inval_plog(&log, "%s out of range", param->key);
629 }
630 EXPORT_SYMBOL(ceph_parse_param);
631
632 int ceph_print_client_options(struct seq_file *m, struct ceph_client *client,
633                               bool show_all)
634 {
635         struct ceph_options *opt = client->options;
636         size_t pos = m->count;
637         struct rb_node *n;
638
639         if (opt->name) {
640                 seq_puts(m, "name=");
641                 seq_escape(m, opt->name, ", \t\n\\");
642                 seq_putc(m, ',');
643         }
644         if (opt->key)
645                 seq_puts(m, "secret=<hidden>,");
646
647         if (!RB_EMPTY_ROOT(&opt->crush_locs)) {
648                 seq_puts(m, "crush_location=");
649                 for (n = rb_first(&opt->crush_locs); ; ) {
650                         struct crush_loc_node *loc =
651                             rb_entry(n, struct crush_loc_node, cl_node);
652
653                         seq_printf(m, "%s:%s", loc->cl_loc.cl_type_name,
654                                    loc->cl_loc.cl_name);
655                         n = rb_next(n);
656                         if (!n)
657                                 break;
658
659                         seq_putc(m, '|');
660                 }
661                 seq_putc(m, ',');
662         }
663         if (opt->read_from_replica == CEPH_OSD_FLAG_BALANCE_READS) {
664                 seq_puts(m, "read_from_replica=balance,");
665         } else if (opt->read_from_replica == CEPH_OSD_FLAG_LOCALIZE_READS) {
666                 seq_puts(m, "read_from_replica=localize,");
667         }
668         if (opt->con_modes[0] != CEPH_CON_MODE_UNKNOWN) {
669                 if (opt->con_modes[0] == CEPH_CON_MODE_CRC &&
670                     opt->con_modes[1] == CEPH_CON_MODE_UNKNOWN) {
671                         seq_puts(m, "ms_mode=crc,");
672                 } else if (opt->con_modes[0] == CEPH_CON_MODE_SECURE &&
673                            opt->con_modes[1] == CEPH_CON_MODE_UNKNOWN) {
674                         seq_puts(m, "ms_mode=secure,");
675                 } else if (opt->con_modes[0] == CEPH_CON_MODE_CRC &&
676                            opt->con_modes[1] == CEPH_CON_MODE_SECURE) {
677                         seq_puts(m, "ms_mode=prefer-crc,");
678                 } else if (opt->con_modes[0] == CEPH_CON_MODE_SECURE &&
679                            opt->con_modes[1] == CEPH_CON_MODE_CRC) {
680                         seq_puts(m, "ms_mode=prefer-secure,");
681                 }
682         }
683
684         if (opt->flags & CEPH_OPT_FSID)
685                 seq_printf(m, "fsid=%pU,", &opt->fsid);
686         if (opt->flags & CEPH_OPT_NOSHARE)
687                 seq_puts(m, "noshare,");
688         if (opt->flags & CEPH_OPT_NOCRC)
689                 seq_puts(m, "nocrc,");
690         if (opt->flags & CEPH_OPT_NOMSGSIGN)
691                 seq_puts(m, "nocephx_sign_messages,");
692         if ((opt->flags & CEPH_OPT_TCP_NODELAY) == 0)
693                 seq_puts(m, "notcp_nodelay,");
694         if (show_all && (opt->flags & CEPH_OPT_ABORT_ON_FULL))
695                 seq_puts(m, "abort_on_full,");
696
697         if (opt->mount_timeout != CEPH_MOUNT_TIMEOUT_DEFAULT)
698                 seq_printf(m, "mount_timeout=%d,",
699                            jiffies_to_msecs(opt->mount_timeout) / 1000);
700         if (opt->osd_idle_ttl != CEPH_OSD_IDLE_TTL_DEFAULT)
701                 seq_printf(m, "osd_idle_ttl=%d,",
702                            jiffies_to_msecs(opt->osd_idle_ttl) / 1000);
703         if (opt->osd_keepalive_timeout != CEPH_OSD_KEEPALIVE_DEFAULT)
704                 seq_printf(m, "osdkeepalivetimeout=%d,",
705                     jiffies_to_msecs(opt->osd_keepalive_timeout) / 1000);
706         if (opt->osd_request_timeout != CEPH_OSD_REQUEST_TIMEOUT_DEFAULT)
707                 seq_printf(m, "osd_request_timeout=%d,",
708                            jiffies_to_msecs(opt->osd_request_timeout) / 1000);
709
710         /* drop redundant comma */
711         if (m->count != pos)
712                 m->count--;
713
714         return 0;
715 }
716 EXPORT_SYMBOL(ceph_print_client_options);
717
718 struct ceph_entity_addr *ceph_client_addr(struct ceph_client *client)
719 {
720         return &client->msgr.inst.addr;
721 }
722 EXPORT_SYMBOL(ceph_client_addr);
723
724 u64 ceph_client_gid(struct ceph_client *client)
725 {
726         return client->monc.auth->global_id;
727 }
728 EXPORT_SYMBOL(ceph_client_gid);
729
730 /*
731  * create a fresh client instance
732  */
733 struct ceph_client *ceph_create_client(struct ceph_options *opt, void *private)
734 {
735         struct ceph_client *client;
736         struct ceph_entity_addr *myaddr = NULL;
737         int err;
738
739         err = wait_for_random_bytes();
740         if (err < 0)
741                 return ERR_PTR(err);
742
743         client = kzalloc(sizeof(*client), GFP_KERNEL);
744         if (client == NULL)
745                 return ERR_PTR(-ENOMEM);
746
747         client->private = private;
748         client->options = opt;
749
750         mutex_init(&client->mount_mutex);
751         init_waitqueue_head(&client->auth_wq);
752         client->auth_err = 0;
753
754         client->extra_mon_dispatch = NULL;
755         client->supported_features = CEPH_FEATURES_SUPPORTED_DEFAULT;
756         client->required_features = CEPH_FEATURES_REQUIRED_DEFAULT;
757
758         if (!ceph_test_opt(client, NOMSGSIGN))
759                 client->required_features |= CEPH_FEATURE_MSG_AUTH;
760
761         /* msgr */
762         if (ceph_test_opt(client, MYIP))
763                 myaddr = &client->options->my_addr;
764
765         ceph_messenger_init(&client->msgr, myaddr);
766
767         /* subsystems */
768         err = ceph_monc_init(&client->monc, client);
769         if (err < 0)
770                 goto fail;
771         err = ceph_osdc_init(&client->osdc, client);
772         if (err < 0)
773                 goto fail_monc;
774
775         return client;
776
777 fail_monc:
778         ceph_monc_stop(&client->monc);
779 fail:
780         ceph_messenger_fini(&client->msgr);
781         kfree(client);
782         return ERR_PTR(err);
783 }
784 EXPORT_SYMBOL(ceph_create_client);
785
786 void ceph_destroy_client(struct ceph_client *client)
787 {
788         dout("destroy_client %p\n", client);
789
790         atomic_set(&client->msgr.stopping, 1);
791
792         /* unmount */
793         ceph_osdc_stop(&client->osdc);
794         ceph_monc_stop(&client->monc);
795         ceph_messenger_fini(&client->msgr);
796
797         ceph_debugfs_client_cleanup(client);
798
799         ceph_destroy_options(client->options);
800
801         kfree(client);
802         dout("destroy_client %p done\n", client);
803 }
804 EXPORT_SYMBOL(ceph_destroy_client);
805
806 void ceph_reset_client_addr(struct ceph_client *client)
807 {
808         ceph_messenger_reset_nonce(&client->msgr);
809         ceph_monc_reopen_session(&client->monc);
810         ceph_osdc_reopen_osds(&client->osdc);
811 }
812 EXPORT_SYMBOL(ceph_reset_client_addr);
813
814 /*
815  * true if we have the mon map (and have thus joined the cluster)
816  */
817 static bool have_mon_and_osd_map(struct ceph_client *client)
818 {
819         return client->monc.monmap && client->monc.monmap->epoch &&
820                client->osdc.osdmap && client->osdc.osdmap->epoch;
821 }
822
823 /*
824  * mount: join the ceph cluster, and open root directory.
825  */
826 int __ceph_open_session(struct ceph_client *client, unsigned long started)
827 {
828         unsigned long timeout = client->options->mount_timeout;
829         long err;
830
831         /* open session, and wait for mon and osd maps */
832         err = ceph_monc_open_session(&client->monc);
833         if (err < 0)
834                 return err;
835
836         while (!have_mon_and_osd_map(client)) {
837                 if (timeout && time_after_eq(jiffies, started + timeout))
838                         return -ETIMEDOUT;
839
840                 /* wait */
841                 dout("mount waiting for mon_map\n");
842                 err = wait_event_interruptible_timeout(client->auth_wq,
843                         have_mon_and_osd_map(client) || (client->auth_err < 0),
844                         ceph_timeout_jiffies(timeout));
845                 if (err < 0)
846                         return err;
847                 if (client->auth_err < 0)
848                         return client->auth_err;
849         }
850
851         pr_info("client%llu fsid %pU\n", ceph_client_gid(client),
852                 &client->fsid);
853         ceph_debugfs_client_init(client);
854
855         return 0;
856 }
857 EXPORT_SYMBOL(__ceph_open_session);
858
859 int ceph_open_session(struct ceph_client *client)
860 {
861         int ret;
862         unsigned long started = jiffies;  /* note the start time */
863
864         dout("open_session start\n");
865         mutex_lock(&client->mount_mutex);
866
867         ret = __ceph_open_session(client, started);
868
869         mutex_unlock(&client->mount_mutex);
870         return ret;
871 }
872 EXPORT_SYMBOL(ceph_open_session);
873
874 int ceph_wait_for_latest_osdmap(struct ceph_client *client,
875                                 unsigned long timeout)
876 {
877         u64 newest_epoch;
878         int ret;
879
880         ret = ceph_monc_get_version(&client->monc, "osdmap", &newest_epoch);
881         if (ret)
882                 return ret;
883
884         if (client->osdc.osdmap->epoch >= newest_epoch)
885                 return 0;
886
887         ceph_osdc_maybe_request_map(&client->osdc);
888         return ceph_monc_wait_osdmap(&client->monc, newest_epoch, timeout);
889 }
890 EXPORT_SYMBOL(ceph_wait_for_latest_osdmap);
891
892 static int __init init_ceph_lib(void)
893 {
894         int ret = 0;
895
896         ceph_debugfs_init();
897
898         ret = ceph_crypto_init();
899         if (ret < 0)
900                 goto out_debugfs;
901
902         ret = ceph_msgr_init();
903         if (ret < 0)
904                 goto out_crypto;
905
906         ret = ceph_osdc_setup();
907         if (ret < 0)
908                 goto out_msgr;
909
910         pr_info("loaded (mon/osd proto %d/%d)\n",
911                 CEPH_MONC_PROTOCOL, CEPH_OSDC_PROTOCOL);
912
913         return 0;
914
915 out_msgr:
916         ceph_msgr_exit();
917 out_crypto:
918         ceph_crypto_shutdown();
919 out_debugfs:
920         ceph_debugfs_cleanup();
921         return ret;
922 }
923
924 static void __exit exit_ceph_lib(void)
925 {
926         dout("exit_ceph_lib\n");
927         WARN_ON(!ceph_strings_empty());
928
929         ceph_osdc_cleanup();
930         ceph_msgr_exit();
931         ceph_crypto_shutdown();
932         ceph_debugfs_cleanup();
933 }
934
935 module_init(init_ceph_lib);
936 module_exit(exit_ceph_lib);
937
938 MODULE_AUTHOR("Sage Weil <sage@newdream.net>");
939 MODULE_AUTHOR("Yehuda Sadeh <yehuda@hq.newdream.net>");
940 MODULE_AUTHOR("Patience Warnick <patience@newdream.net>");
941 MODULE_DESCRIPTION("Ceph core library");
942 MODULE_LICENSE("GPL");