Documentation/ABI: Update sysfs-driver-toshiba_acpi entry
[linux/fpc-iii.git] / net / ceph / ceph_common.c
blobec565508e904113e65329b89dec5952bf5d41075
2 #include <linux/ceph/ceph_debug.h>
3 #include <linux/backing-dev.h>
4 #include <linux/ctype.h>
5 #include <linux/fs.h>
6 #include <linux/inet.h>
7 #include <linux/in6.h>
8 #include <linux/key.h>
9 #include <keys/ceph-type.h>
10 #include <linux/module.h>
11 #include <linux/mount.h>
12 #include <linux/parser.h>
13 #include <linux/sched.h>
14 #include <linux/seq_file.h>
15 #include <linux/slab.h>
16 #include <linux/statfs.h>
17 #include <linux/string.h>
18 #include <linux/vmalloc.h>
19 #include <linux/nsproxy.h>
20 #include <net/net_namespace.h>
23 #include <linux/ceph/ceph_features.h>
24 #include <linux/ceph/libceph.h>
25 #include <linux/ceph/debugfs.h>
26 #include <linux/ceph/decode.h>
27 #include <linux/ceph/mon_client.h>
28 #include <linux/ceph/auth.h>
29 #include "crypto.h"
33 * Module compatibility interface. For now it doesn't do anything,
34 * but its existence signals a certain level of functionality.
36 * The data buffer is used to pass information both to and from
37 * libceph. The return value indicates whether libceph determines
38 * it is compatible with the caller (from another kernel module),
39 * given the provided data.
41 * The data pointer can be null.
43 bool libceph_compatible(void *data)
45 return true;
47 EXPORT_SYMBOL(libceph_compatible);
50 * find filename portion of a path (/foo/bar/baz -> baz)
52 const char *ceph_file_part(const char *s, int len)
54 const char *e = s + len;
56 while (e != s && *(e-1) != '/')
57 e--;
58 return e;
60 EXPORT_SYMBOL(ceph_file_part);
62 const char *ceph_msg_type_name(int type)
64 switch (type) {
65 case CEPH_MSG_SHUTDOWN: return "shutdown";
66 case CEPH_MSG_PING: return "ping";
67 case CEPH_MSG_AUTH: return "auth";
68 case CEPH_MSG_AUTH_REPLY: return "auth_reply";
69 case CEPH_MSG_MON_MAP: return "mon_map";
70 case CEPH_MSG_MON_GET_MAP: return "mon_get_map";
71 case CEPH_MSG_MON_SUBSCRIBE: return "mon_subscribe";
72 case CEPH_MSG_MON_SUBSCRIBE_ACK: return "mon_subscribe_ack";
73 case CEPH_MSG_STATFS: return "statfs";
74 case CEPH_MSG_STATFS_REPLY: return "statfs_reply";
75 case CEPH_MSG_MON_GET_VERSION: return "mon_get_version";
76 case CEPH_MSG_MON_GET_VERSION_REPLY: return "mon_get_version_reply";
77 case CEPH_MSG_MDS_MAP: return "mds_map";
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_SNAP: return "client_snap";
86 case CEPH_MSG_CLIENT_LEASE: return "client_lease";
87 case CEPH_MSG_OSD_MAP: return "osd_map";
88 case CEPH_MSG_OSD_OP: return "osd_op";
89 case CEPH_MSG_OSD_OPREPLY: return "osd_opreply";
90 case CEPH_MSG_WATCH_NOTIFY: return "watch_notify";
91 default: return "unknown";
94 EXPORT_SYMBOL(ceph_msg_type_name);
97 * Initially learn our fsid, or verify an fsid matches.
99 int ceph_check_fsid(struct ceph_client *client, struct ceph_fsid *fsid)
101 if (client->have_fsid) {
102 if (ceph_fsid_compare(&client->fsid, fsid)) {
103 pr_err("bad fsid, had %pU got %pU",
104 &client->fsid, fsid);
105 return -1;
107 } else {
108 memcpy(&client->fsid, fsid, sizeof(*fsid));
110 return 0;
112 EXPORT_SYMBOL(ceph_check_fsid);
114 static int strcmp_null(const char *s1, const char *s2)
116 if (!s1 && !s2)
117 return 0;
118 if (s1 && !s2)
119 return -1;
120 if (!s1 && s2)
121 return 1;
122 return strcmp(s1, s2);
125 int ceph_compare_options(struct ceph_options *new_opt,
126 struct ceph_client *client)
128 struct ceph_options *opt1 = new_opt;
129 struct ceph_options *opt2 = client->options;
130 int ofs = offsetof(struct ceph_options, mon_addr);
131 int i;
132 int ret;
134 ret = memcmp(opt1, opt2, ofs);
135 if (ret)
136 return ret;
138 ret = strcmp_null(opt1->name, opt2->name);
139 if (ret)
140 return ret;
142 if (opt1->key && !opt2->key)
143 return -1;
144 if (!opt1->key && opt2->key)
145 return 1;
146 if (opt1->key && opt2->key) {
147 if (opt1->key->type != opt2->key->type)
148 return -1;
149 if (opt1->key->created.tv_sec != opt2->key->created.tv_sec)
150 return -1;
151 if (opt1->key->created.tv_nsec != opt2->key->created.tv_nsec)
152 return -1;
153 if (opt1->key->len != opt2->key->len)
154 return -1;
155 if (opt1->key->key && !opt2->key->key)
156 return -1;
157 if (!opt1->key->key && opt2->key->key)
158 return 1;
159 if (opt1->key->key && opt2->key->key) {
160 ret = memcmp(opt1->key->key, opt2->key->key, opt1->key->len);
161 if (ret)
162 return ret;
166 /* any matching mon ip implies a match */
167 for (i = 0; i < opt1->num_mon; i++) {
168 if (ceph_monmap_contains(client->monc.monmap,
169 &opt1->mon_addr[i]))
170 return 0;
172 return -1;
174 EXPORT_SYMBOL(ceph_compare_options);
176 void *ceph_kvmalloc(size_t size, gfp_t flags)
178 if (size <= (PAGE_SIZE << PAGE_ALLOC_COSTLY_ORDER)) {
179 void *ptr = kmalloc(size, flags | __GFP_NOWARN);
180 if (ptr)
181 return ptr;
184 return __vmalloc(size, flags | __GFP_HIGHMEM, PAGE_KERNEL);
188 static int parse_fsid(const char *str, struct ceph_fsid *fsid)
190 int i = 0;
191 char tmp[3];
192 int err = -EINVAL;
193 int d;
195 dout("parse_fsid '%s'\n", str);
196 tmp[2] = 0;
197 while (*str && i < 16) {
198 if (ispunct(*str)) {
199 str++;
200 continue;
202 if (!isxdigit(str[0]) || !isxdigit(str[1]))
203 break;
204 tmp[0] = str[0];
205 tmp[1] = str[1];
206 if (sscanf(tmp, "%x", &d) < 1)
207 break;
208 fsid->fsid[i] = d & 0xff;
209 i++;
210 str += 2;
213 if (i == 16)
214 err = 0;
215 dout("parse_fsid ret %d got fsid %pU", err, fsid);
216 return err;
220 * ceph options
222 enum {
223 Opt_osdtimeout,
224 Opt_osdkeepalivetimeout,
225 Opt_mount_timeout,
226 Opt_osd_idle_ttl,
227 Opt_last_int,
228 /* int args above */
229 Opt_fsid,
230 Opt_name,
231 Opt_secret,
232 Opt_key,
233 Opt_ip,
234 Opt_last_string,
235 /* string args above */
236 Opt_share,
237 Opt_noshare,
238 Opt_crc,
239 Opt_nocrc,
240 Opt_cephx_require_signatures,
241 Opt_nocephx_require_signatures,
242 Opt_tcp_nodelay,
243 Opt_notcp_nodelay,
246 static match_table_t opt_tokens = {
247 {Opt_osdtimeout, "osdtimeout=%d"},
248 {Opt_osdkeepalivetimeout, "osdkeepalive=%d"},
249 {Opt_mount_timeout, "mount_timeout=%d"},
250 {Opt_osd_idle_ttl, "osd_idle_ttl=%d"},
251 /* int args above */
252 {Opt_fsid, "fsid=%s"},
253 {Opt_name, "name=%s"},
254 {Opt_secret, "secret=%s"},
255 {Opt_key, "key=%s"},
256 {Opt_ip, "ip=%s"},
257 /* string args above */
258 {Opt_share, "share"},
259 {Opt_noshare, "noshare"},
260 {Opt_crc, "crc"},
261 {Opt_nocrc, "nocrc"},
262 {Opt_cephx_require_signatures, "cephx_require_signatures"},
263 {Opt_nocephx_require_signatures, "nocephx_require_signatures"},
264 {Opt_tcp_nodelay, "tcp_nodelay"},
265 {Opt_notcp_nodelay, "notcp_nodelay"},
266 {-1, NULL}
269 void ceph_destroy_options(struct ceph_options *opt)
271 dout("destroy_options %p\n", opt);
272 kfree(opt->name);
273 if (opt->key) {
274 ceph_crypto_key_destroy(opt->key);
275 kfree(opt->key);
277 kfree(opt->mon_addr);
278 kfree(opt);
280 EXPORT_SYMBOL(ceph_destroy_options);
282 /* get secret from key store */
283 static int get_secret(struct ceph_crypto_key *dst, const char *name) {
284 struct key *ukey;
285 int key_err;
286 int err = 0;
287 struct ceph_crypto_key *ckey;
289 ukey = request_key(&key_type_ceph, name, NULL);
290 if (!ukey || IS_ERR(ukey)) {
291 /* request_key errors don't map nicely to mount(2)
292 errors; don't even try, but still printk */
293 key_err = PTR_ERR(ukey);
294 switch (key_err) {
295 case -ENOKEY:
296 pr_warn("ceph: Mount failed due to key not found: %s\n",
297 name);
298 break;
299 case -EKEYEXPIRED:
300 pr_warn("ceph: Mount failed due to expired key: %s\n",
301 name);
302 break;
303 case -EKEYREVOKED:
304 pr_warn("ceph: Mount failed due to revoked key: %s\n",
305 name);
306 break;
307 default:
308 pr_warn("ceph: Mount failed due to unknown key error %d: %s\n",
309 key_err, name);
311 err = -EPERM;
312 goto out;
315 ckey = ukey->payload.data;
316 err = ceph_crypto_key_clone(dst, ckey);
317 if (err)
318 goto out_key;
319 /* pass through, err is 0 */
321 out_key:
322 key_put(ukey);
323 out:
324 return err;
327 struct ceph_options *
328 ceph_parse_options(char *options, const char *dev_name,
329 const char *dev_name_end,
330 int (*parse_extra_token)(char *c, void *private),
331 void *private)
333 struct ceph_options *opt;
334 const char *c;
335 int err = -ENOMEM;
336 substring_t argstr[MAX_OPT_ARGS];
338 if (current->nsproxy->net_ns != &init_net)
339 return ERR_PTR(-EINVAL);
341 opt = kzalloc(sizeof(*opt), GFP_KERNEL);
342 if (!opt)
343 return ERR_PTR(-ENOMEM);
344 opt->mon_addr = kcalloc(CEPH_MAX_MON, sizeof(*opt->mon_addr),
345 GFP_KERNEL);
346 if (!opt->mon_addr)
347 goto out;
349 dout("parse_options %p options '%s' dev_name '%s'\n", opt, options,
350 dev_name);
352 /* start with defaults */
353 opt->flags = CEPH_OPT_DEFAULT;
354 opt->osd_keepalive_timeout = CEPH_OSD_KEEPALIVE_DEFAULT;
355 opt->mount_timeout = CEPH_MOUNT_TIMEOUT_DEFAULT; /* seconds */
356 opt->osd_idle_ttl = CEPH_OSD_IDLE_TTL_DEFAULT; /* seconds */
358 /* get mon ip(s) */
359 /* ip1[:port1][,ip2[:port2]...] */
360 err = ceph_parse_ips(dev_name, dev_name_end, opt->mon_addr,
361 CEPH_MAX_MON, &opt->num_mon);
362 if (err < 0)
363 goto out;
365 /* parse mount options */
366 while ((c = strsep(&options, ",")) != NULL) {
367 int token, intval, ret;
368 if (!*c)
369 continue;
370 err = -EINVAL;
371 token = match_token((char *)c, opt_tokens, argstr);
372 if (token < 0 && parse_extra_token) {
373 /* extra? */
374 err = parse_extra_token((char *)c, private);
375 if (err < 0) {
376 pr_err("bad option at '%s'\n", c);
377 goto out;
379 continue;
381 if (token < Opt_last_int) {
382 ret = match_int(&argstr[0], &intval);
383 if (ret < 0) {
384 pr_err("bad mount option arg (not int) "
385 "at '%s'\n", c);
386 continue;
388 dout("got int token %d val %d\n", token, intval);
389 } else if (token > Opt_last_int && token < Opt_last_string) {
390 dout("got string token %d val %s\n", token,
391 argstr[0].from);
392 } else {
393 dout("got token %d\n", token);
395 switch (token) {
396 case Opt_ip:
397 err = ceph_parse_ips(argstr[0].from,
398 argstr[0].to,
399 &opt->my_addr,
400 1, NULL);
401 if (err < 0)
402 goto out;
403 opt->flags |= CEPH_OPT_MYIP;
404 break;
406 case Opt_fsid:
407 err = parse_fsid(argstr[0].from, &opt->fsid);
408 if (err == 0)
409 opt->flags |= CEPH_OPT_FSID;
410 break;
411 case Opt_name:
412 opt->name = kstrndup(argstr[0].from,
413 argstr[0].to-argstr[0].from,
414 GFP_KERNEL);
415 break;
416 case Opt_secret:
417 opt->key = kzalloc(sizeof(*opt->key), GFP_KERNEL);
418 if (!opt->key) {
419 err = -ENOMEM;
420 goto out;
422 err = ceph_crypto_key_unarmor(opt->key, argstr[0].from);
423 if (err < 0)
424 goto out;
425 break;
426 case Opt_key:
427 opt->key = kzalloc(sizeof(*opt->key), GFP_KERNEL);
428 if (!opt->key) {
429 err = -ENOMEM;
430 goto out;
432 err = get_secret(opt->key, argstr[0].from);
433 if (err < 0)
434 goto out;
435 break;
437 /* misc */
438 case Opt_osdtimeout:
439 pr_warn("ignoring deprecated osdtimeout option\n");
440 break;
441 case Opt_osdkeepalivetimeout:
442 opt->osd_keepalive_timeout = intval;
443 break;
444 case Opt_osd_idle_ttl:
445 opt->osd_idle_ttl = intval;
446 break;
447 case Opt_mount_timeout:
448 opt->mount_timeout = intval;
449 break;
451 case Opt_share:
452 opt->flags &= ~CEPH_OPT_NOSHARE;
453 break;
454 case Opt_noshare:
455 opt->flags |= CEPH_OPT_NOSHARE;
456 break;
458 case Opt_crc:
459 opt->flags &= ~CEPH_OPT_NOCRC;
460 break;
461 case Opt_nocrc:
462 opt->flags |= CEPH_OPT_NOCRC;
463 break;
465 case Opt_cephx_require_signatures:
466 opt->flags &= ~CEPH_OPT_NOMSGAUTH;
467 break;
468 case Opt_nocephx_require_signatures:
469 opt->flags |= CEPH_OPT_NOMSGAUTH;
470 break;
472 case Opt_tcp_nodelay:
473 opt->flags |= CEPH_OPT_TCP_NODELAY;
474 break;
475 case Opt_notcp_nodelay:
476 opt->flags &= ~CEPH_OPT_TCP_NODELAY;
477 break;
479 default:
480 BUG_ON(token);
484 /* success */
485 return opt;
487 out:
488 ceph_destroy_options(opt);
489 return ERR_PTR(err);
491 EXPORT_SYMBOL(ceph_parse_options);
493 u64 ceph_client_id(struct ceph_client *client)
495 return client->monc.auth->global_id;
497 EXPORT_SYMBOL(ceph_client_id);
500 * create a fresh client instance
502 struct ceph_client *ceph_create_client(struct ceph_options *opt, void *private,
503 u64 supported_features,
504 u64 required_features)
506 struct ceph_client *client;
507 struct ceph_entity_addr *myaddr = NULL;
508 int err = -ENOMEM;
510 client = kzalloc(sizeof(*client), GFP_KERNEL);
511 if (client == NULL)
512 return ERR_PTR(-ENOMEM);
514 client->private = private;
515 client->options = opt;
517 mutex_init(&client->mount_mutex);
518 init_waitqueue_head(&client->auth_wq);
519 client->auth_err = 0;
521 if (!ceph_test_opt(client, NOMSGAUTH))
522 required_features |= CEPH_FEATURE_MSG_AUTH;
524 client->extra_mon_dispatch = NULL;
525 client->supported_features = CEPH_FEATURES_SUPPORTED_DEFAULT |
526 supported_features;
527 client->required_features = CEPH_FEATURES_REQUIRED_DEFAULT |
528 required_features;
530 /* msgr */
531 if (ceph_test_opt(client, MYIP))
532 myaddr = &client->options->my_addr;
534 ceph_messenger_init(&client->msgr, myaddr,
535 client->supported_features,
536 client->required_features,
537 ceph_test_opt(client, NOCRC),
538 ceph_test_opt(client, TCP_NODELAY));
540 /* subsystems */
541 err = ceph_monc_init(&client->monc, client);
542 if (err < 0)
543 goto fail;
544 err = ceph_osdc_init(&client->osdc, client);
545 if (err < 0)
546 goto fail_monc;
548 return client;
550 fail_monc:
551 ceph_monc_stop(&client->monc);
552 fail:
553 kfree(client);
554 return ERR_PTR(err);
556 EXPORT_SYMBOL(ceph_create_client);
558 void ceph_destroy_client(struct ceph_client *client)
560 dout("destroy_client %p\n", client);
562 atomic_set(&client->msgr.stopping, 1);
564 /* unmount */
565 ceph_osdc_stop(&client->osdc);
567 ceph_monc_stop(&client->monc);
569 ceph_debugfs_client_cleanup(client);
571 ceph_destroy_options(client->options);
573 kfree(client);
574 dout("destroy_client %p done\n", client);
576 EXPORT_SYMBOL(ceph_destroy_client);
579 * true if we have the mon map (and have thus joined the cluster)
581 static int have_mon_and_osd_map(struct ceph_client *client)
583 return client->monc.monmap && client->monc.monmap->epoch &&
584 client->osdc.osdmap && client->osdc.osdmap->epoch;
588 * mount: join the ceph cluster, and open root directory.
590 int __ceph_open_session(struct ceph_client *client, unsigned long started)
592 int err;
593 unsigned long timeout = client->options->mount_timeout * HZ;
595 /* open session, and wait for mon and osd maps */
596 err = ceph_monc_open_session(&client->monc);
597 if (err < 0)
598 return err;
600 while (!have_mon_and_osd_map(client)) {
601 err = -EIO;
602 if (timeout && time_after_eq(jiffies, started + timeout))
603 return err;
605 /* wait */
606 dout("mount waiting for mon_map\n");
607 err = wait_event_interruptible_timeout(client->auth_wq,
608 have_mon_and_osd_map(client) || (client->auth_err < 0),
609 timeout);
610 if (err == -EINTR || err == -ERESTARTSYS)
611 return err;
612 if (client->auth_err < 0)
613 return client->auth_err;
616 return 0;
618 EXPORT_SYMBOL(__ceph_open_session);
621 int ceph_open_session(struct ceph_client *client)
623 int ret;
624 unsigned long started = jiffies; /* note the start time */
626 dout("open_session start\n");
627 mutex_lock(&client->mount_mutex);
629 ret = __ceph_open_session(client, started);
631 mutex_unlock(&client->mount_mutex);
632 return ret;
634 EXPORT_SYMBOL(ceph_open_session);
637 static int __init init_ceph_lib(void)
639 int ret = 0;
641 ret = ceph_debugfs_init();
642 if (ret < 0)
643 goto out;
645 ret = ceph_crypto_init();
646 if (ret < 0)
647 goto out_debugfs;
649 ret = ceph_msgr_init();
650 if (ret < 0)
651 goto out_crypto;
653 ret = ceph_osdc_setup();
654 if (ret < 0)
655 goto out_msgr;
657 pr_info("loaded (mon/osd proto %d/%d)\n",
658 CEPH_MONC_PROTOCOL, CEPH_OSDC_PROTOCOL);
660 return 0;
662 out_msgr:
663 ceph_msgr_exit();
664 out_crypto:
665 ceph_crypto_shutdown();
666 out_debugfs:
667 ceph_debugfs_cleanup();
668 out:
669 return ret;
672 static void __exit exit_ceph_lib(void)
674 dout("exit_ceph_lib\n");
675 ceph_osdc_cleanup();
676 ceph_msgr_exit();
677 ceph_crypto_shutdown();
678 ceph_debugfs_cleanup();
681 module_init(init_ceph_lib);
682 module_exit(exit_ceph_lib);
684 MODULE_AUTHOR("Sage Weil <sage@newdream.net>");
685 MODULE_AUTHOR("Yehuda Sadeh <yehuda@hq.newdream.net>");
686 MODULE_AUTHOR("Patience Warnick <patience@newdream.net>");
687 MODULE_DESCRIPTION("Ceph filesystem for Linux");
688 MODULE_LICENSE("GPL");