3 rbd.c -- Export ceph rados objects as a Linux block device
6 based on drivers/block/osdblk.c:
8 Copyright 2009 Red Hat, Inc.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; see the file COPYING. If not, write to
21 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 For usage instructions, please refer to:
27 Documentation/ABI/testing/sysfs-bus-rbd
31 #include <linux/ceph/libceph.h>
32 #include <linux/ceph/osd_client.h>
33 #include <linux/ceph/mon_client.h>
34 #include <linux/ceph/decode.h>
35 #include <linux/parser.h>
36 #include <linux/bsearch.h>
38 #include <linux/kernel.h>
39 #include <linux/device.h>
40 #include <linux/module.h>
42 #include <linux/blkdev.h>
43 #include <linux/slab.h>
45 #include "rbd_types.h"
47 #define RBD_DEBUG /* Activate rbd_assert() calls */
50 * The basic unit of block I/O is a sector. It is interpreted in a
51 * number of contexts in Linux (blk, bio, genhd), but the default is
52 * universally 512 bytes. These symbols are just slightly more
53 * meaningful than the bare numbers they represent.
55 #define SECTOR_SHIFT 9
56 #define SECTOR_SIZE (1ULL << SECTOR_SHIFT)
59 * Increment the given counter and return its updated value.
60 * If the counter is already 0 it will not be incremented.
61 * If the counter is already at its maximum value returns
62 * -EINVAL without updating it.
64 static int atomic_inc_return_safe(atomic_t *v)
68 counter = (unsigned int)__atomic_add_unless(v, 1, 0);
69 if (counter <= (unsigned int)INT_MAX)
77 /* Decrement the counter. Return the resulting value, or -EINVAL */
78 static int atomic_dec_return_safe(atomic_t *v)
82 counter = atomic_dec_return(v);
91 #define RBD_DRV_NAME "rbd"
92 #define RBD_DRV_NAME_LONG "rbd (rados block device)"
94 #define RBD_MINORS_PER_MAJOR 256 /* max minors per blkdev */
96 #define RBD_SNAP_DEV_NAME_PREFIX "snap_"
97 #define RBD_MAX_SNAP_NAME_LEN \
98 (NAME_MAX - (sizeof (RBD_SNAP_DEV_NAME_PREFIX) - 1))
100 #define RBD_MAX_SNAP_COUNT 510 /* allows max snapc to fit in 4KB */
102 #define RBD_SNAP_HEAD_NAME "-"
104 #define BAD_SNAP_INDEX U32_MAX /* invalid index into snap array */
106 /* This allows a single page to hold an image name sent by OSD */
107 #define RBD_IMAGE_NAME_LEN_MAX (PAGE_SIZE - sizeof (__le32) - 1)
108 #define RBD_IMAGE_ID_LEN_MAX 64
110 #define RBD_OBJ_PREFIX_LEN_MAX 64
114 #define RBD_FEATURE_LAYERING (1<<0)
115 #define RBD_FEATURE_STRIPINGV2 (1<<1)
116 #define RBD_FEATURES_ALL \
117 (RBD_FEATURE_LAYERING | RBD_FEATURE_STRIPINGV2)
119 /* Features supported by this (client software) implementation. */
121 #define RBD_FEATURES_SUPPORTED (RBD_FEATURES_ALL)
124 * An RBD device name will be "rbd#", where the "rbd" comes from
125 * RBD_DRV_NAME above, and # is a unique integer identifier.
126 * MAX_INT_FORMAT_WIDTH is used in ensuring DEV_NAME_LEN is big
127 * enough to hold all possible device names.
129 #define DEV_NAME_LEN 32
130 #define MAX_INT_FORMAT_WIDTH ((5 * sizeof (int)) / 2 + 1)
133 * block device image metadata (in-memory version)
135 struct rbd_image_header {
136 /* These six fields never change for a given rbd image */
143 u64 features; /* Might be changeable someday? */
145 /* The remaining fields need to be updated occasionally */
147 struct ceph_snap_context *snapc;
148 char *snap_names; /* format 1 only */
149 u64 *snap_sizes; /* format 1 only */
153 * An rbd image specification.
155 * The tuple (pool_id, image_id, snap_id) is sufficient to uniquely
156 * identify an image. Each rbd_dev structure includes a pointer to
157 * an rbd_spec structure that encapsulates this identity.
159 * Each of the id's in an rbd_spec has an associated name. For a
160 * user-mapped image, the names are supplied and the id's associated
161 * with them are looked up. For a layered image, a parent image is
162 * defined by the tuple, and the names are looked up.
164 * An rbd_dev structure contains a parent_spec pointer which is
165 * non-null if the image it represents is a child in a layered
166 * image. This pointer will refer to the rbd_spec structure used
167 * by the parent rbd_dev for its own identity (i.e., the structure
168 * is shared between the parent and child).
170 * Since these structures are populated once, during the discovery
171 * phase of image construction, they are effectively immutable so
172 * we make no effort to synchronize access to them.
174 * Note that code herein does not assume the image name is known (it
175 * could be a null pointer).
179 const char *pool_name;
181 const char *image_id;
182 const char *image_name;
185 const char *snap_name;
191 * an instance of the client. multiple devices may share an rbd client.
194 struct ceph_client *client;
196 struct list_head node;
199 struct rbd_img_request;
200 typedef void (*rbd_img_callback_t)(struct rbd_img_request *);
202 #define BAD_WHICH U32_MAX /* Good which or bad which, which? */
204 struct rbd_obj_request;
205 typedef void (*rbd_obj_callback_t)(struct rbd_obj_request *);
207 enum obj_request_type {
208 OBJ_REQUEST_NODATA, OBJ_REQUEST_BIO, OBJ_REQUEST_PAGES
212 OBJ_REQ_DONE, /* completion flag: not done = 0, done = 1 */
213 OBJ_REQ_IMG_DATA, /* object usage: standalone = 0, image = 1 */
214 OBJ_REQ_KNOWN, /* EXISTS flag valid: no = 0, yes = 1 */
215 OBJ_REQ_EXISTS, /* target exists: no = 0, yes = 1 */
218 struct rbd_obj_request {
219 const char *object_name;
220 u64 offset; /* object start byte */
221 u64 length; /* bytes from offset */
225 * An object request associated with an image will have its
226 * img_data flag set; a standalone object request will not.
228 * A standalone object request will have which == BAD_WHICH
229 * and a null obj_request pointer.
231 * An object request initiated in support of a layered image
232 * object (to check for its existence before a write) will
233 * have which == BAD_WHICH and a non-null obj_request pointer.
235 * Finally, an object request for rbd image data will have
236 * which != BAD_WHICH, and will have a non-null img_request
237 * pointer. The value of which will be in the range
238 * 0..(img_request->obj_request_count-1).
241 struct rbd_obj_request *obj_request; /* STAT op */
243 struct rbd_img_request *img_request;
245 /* links for img_request->obj_requests list */
246 struct list_head links;
249 u32 which; /* posn image request list */
251 enum obj_request_type type;
253 struct bio *bio_list;
259 struct page **copyup_pages;
260 u32 copyup_page_count;
262 struct ceph_osd_request *osd_req;
264 u64 xferred; /* bytes transferred */
267 rbd_obj_callback_t callback;
268 struct completion completion;
274 IMG_REQ_WRITE, /* I/O direction: read = 0, write = 1 */
275 IMG_REQ_CHILD, /* initiator: block = 0, child image = 1 */
276 IMG_REQ_LAYERED, /* ENOENT handling: normal = 0, layered = 1 */
279 struct rbd_img_request {
280 struct rbd_device *rbd_dev;
281 u64 offset; /* starting image byte offset */
282 u64 length; /* byte count from offset */
285 u64 snap_id; /* for reads */
286 struct ceph_snap_context *snapc; /* for writes */
289 struct request *rq; /* block request */
290 struct rbd_obj_request *obj_request; /* obj req initiator */
292 struct page **copyup_pages;
293 u32 copyup_page_count;
294 spinlock_t completion_lock;/* protects next_completion */
296 rbd_img_callback_t callback;
297 u64 xferred;/* aggregate bytes transferred */
298 int result; /* first nonzero obj_request result */
300 u32 obj_request_count;
301 struct list_head obj_requests; /* rbd_obj_request structs */
306 #define for_each_obj_request(ireq, oreq) \
307 list_for_each_entry(oreq, &(ireq)->obj_requests, links)
308 #define for_each_obj_request_from(ireq, oreq) \
309 list_for_each_entry_from(oreq, &(ireq)->obj_requests, links)
310 #define for_each_obj_request_safe(ireq, oreq, n) \
311 list_for_each_entry_safe_reverse(oreq, n, &(ireq)->obj_requests, links)
323 int dev_id; /* blkdev unique id */
325 int major; /* blkdev assigned major */
326 struct gendisk *disk; /* blkdev's gendisk and rq */
328 u32 image_format; /* Either 1 or 2 */
329 struct rbd_client *rbd_client;
331 char name[DEV_NAME_LEN]; /* blkdev name, e.g. rbd3 */
333 spinlock_t lock; /* queue, flags, open_count */
335 struct rbd_image_header header;
336 unsigned long flags; /* possibly lock protected */
337 struct rbd_spec *spec;
341 struct ceph_file_layout layout;
343 struct ceph_osd_event *watch_event;
344 struct rbd_obj_request *watch_request;
346 struct rbd_spec *parent_spec;
349 struct rbd_device *parent;
351 /* protects updating the header */
352 struct rw_semaphore header_rwsem;
354 struct rbd_mapping mapping;
356 struct list_head node;
360 unsigned long open_count; /* protected by lock */
364 * Flag bits for rbd_dev->flags. If atomicity is required,
365 * rbd_dev->lock is used to protect access.
367 * Currently, only the "removing" flag (which is coupled with the
368 * "open_count" field) requires atomic access.
371 RBD_DEV_FLAG_EXISTS, /* mapped snapshot has not been deleted */
372 RBD_DEV_FLAG_REMOVING, /* this mapping is being removed */
375 static DEFINE_MUTEX(ctl_mutex); /* Serialize open/close/setup/teardown */
377 static LIST_HEAD(rbd_dev_list); /* devices */
378 static DEFINE_SPINLOCK(rbd_dev_list_lock);
380 static LIST_HEAD(rbd_client_list); /* clients */
381 static DEFINE_SPINLOCK(rbd_client_list_lock);
383 /* Slab caches for frequently-allocated structures */
385 static struct kmem_cache *rbd_img_request_cache;
386 static struct kmem_cache *rbd_obj_request_cache;
387 static struct kmem_cache *rbd_segment_name_cache;
389 static int rbd_img_request_submit(struct rbd_img_request *img_request);
391 static void rbd_dev_device_release(struct device *dev);
393 static ssize_t rbd_add(struct bus_type *bus, const char *buf,
395 static ssize_t rbd_remove(struct bus_type *bus, const char *buf,
397 static int rbd_dev_image_probe(struct rbd_device *rbd_dev, bool mapping);
398 static void rbd_spec_put(struct rbd_spec *spec);
400 static struct bus_attribute rbd_bus_attrs[] = {
401 __ATTR(add, S_IWUSR, NULL, rbd_add),
402 __ATTR(remove, S_IWUSR, NULL, rbd_remove),
406 static struct bus_type rbd_bus_type = {
408 .bus_attrs = rbd_bus_attrs,
411 static void rbd_root_dev_release(struct device *dev)
415 static struct device rbd_root_dev = {
417 .release = rbd_root_dev_release,
420 static __printf(2, 3)
421 void rbd_warn(struct rbd_device *rbd_dev, const char *fmt, ...)
423 struct va_format vaf;
431 printk(KERN_WARNING "%s: %pV\n", RBD_DRV_NAME, &vaf);
432 else if (rbd_dev->disk)
433 printk(KERN_WARNING "%s: %s: %pV\n",
434 RBD_DRV_NAME, rbd_dev->disk->disk_name, &vaf);
435 else if (rbd_dev->spec && rbd_dev->spec->image_name)
436 printk(KERN_WARNING "%s: image %s: %pV\n",
437 RBD_DRV_NAME, rbd_dev->spec->image_name, &vaf);
438 else if (rbd_dev->spec && rbd_dev->spec->image_id)
439 printk(KERN_WARNING "%s: id %s: %pV\n",
440 RBD_DRV_NAME, rbd_dev->spec->image_id, &vaf);
442 printk(KERN_WARNING "%s: rbd_dev %p: %pV\n",
443 RBD_DRV_NAME, rbd_dev, &vaf);
448 #define rbd_assert(expr) \
449 if (unlikely(!(expr))) { \
450 printk(KERN_ERR "\nAssertion failure in %s() " \
452 "\trbd_assert(%s);\n\n", \
453 __func__, __LINE__, #expr); \
456 #else /* !RBD_DEBUG */
457 # define rbd_assert(expr) ((void) 0)
458 #endif /* !RBD_DEBUG */
460 static int rbd_img_obj_request_submit(struct rbd_obj_request *obj_request);
461 static void rbd_img_parent_read(struct rbd_obj_request *obj_request);
462 static void rbd_dev_remove_parent(struct rbd_device *rbd_dev);
464 static int rbd_dev_refresh(struct rbd_device *rbd_dev);
465 static int rbd_dev_v2_header_onetime(struct rbd_device *rbd_dev);
466 static int rbd_dev_v2_header_info(struct rbd_device *rbd_dev);
467 static const char *rbd_dev_v2_snap_name(struct rbd_device *rbd_dev,
469 static int _rbd_dev_v2_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
470 u8 *order, u64 *snap_size);
471 static int _rbd_dev_v2_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
473 static u64 rbd_snap_id_by_name(struct rbd_device *rbd_dev, const char *name);
475 static int rbd_open(struct block_device *bdev, fmode_t mode)
477 struct rbd_device *rbd_dev = bdev->bd_disk->private_data;
478 bool removing = false;
480 if ((mode & FMODE_WRITE) && rbd_dev->mapping.read_only)
483 spin_lock_irq(&rbd_dev->lock);
484 if (test_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags))
487 rbd_dev->open_count++;
488 spin_unlock_irq(&rbd_dev->lock);
492 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
493 (void) get_device(&rbd_dev->dev);
494 set_device_ro(bdev, rbd_dev->mapping.read_only);
495 mutex_unlock(&ctl_mutex);
500 static void rbd_release(struct gendisk *disk, fmode_t mode)
502 struct rbd_device *rbd_dev = disk->private_data;
503 unsigned long open_count_before;
505 spin_lock_irq(&rbd_dev->lock);
506 open_count_before = rbd_dev->open_count--;
507 spin_unlock_irq(&rbd_dev->lock);
508 rbd_assert(open_count_before > 0);
510 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
511 put_device(&rbd_dev->dev);
512 mutex_unlock(&ctl_mutex);
515 static const struct block_device_operations rbd_bd_ops = {
516 .owner = THIS_MODULE,
518 .release = rbd_release,
522 * Initialize an rbd client instance. Success or not, this function
523 * consumes ceph_opts.
525 static struct rbd_client *rbd_client_create(struct ceph_options *ceph_opts)
527 struct rbd_client *rbdc;
530 dout("%s:\n", __func__);
531 rbdc = kmalloc(sizeof(struct rbd_client), GFP_KERNEL);
535 kref_init(&rbdc->kref);
536 INIT_LIST_HEAD(&rbdc->node);
538 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
540 rbdc->client = ceph_create_client(ceph_opts, rbdc, 0, 0);
541 if (IS_ERR(rbdc->client))
543 ceph_opts = NULL; /* Now rbdc->client is responsible for ceph_opts */
545 ret = ceph_open_session(rbdc->client);
549 spin_lock(&rbd_client_list_lock);
550 list_add_tail(&rbdc->node, &rbd_client_list);
551 spin_unlock(&rbd_client_list_lock);
553 mutex_unlock(&ctl_mutex);
554 dout("%s: rbdc %p\n", __func__, rbdc);
559 ceph_destroy_client(rbdc->client);
561 mutex_unlock(&ctl_mutex);
565 ceph_destroy_options(ceph_opts);
566 dout("%s: error %d\n", __func__, ret);
571 static struct rbd_client *__rbd_get_client(struct rbd_client *rbdc)
573 kref_get(&rbdc->kref);
579 * Find a ceph client with specific addr and configuration. If
580 * found, bump its reference count.
582 static struct rbd_client *rbd_client_find(struct ceph_options *ceph_opts)
584 struct rbd_client *client_node;
587 if (ceph_opts->flags & CEPH_OPT_NOSHARE)
590 spin_lock(&rbd_client_list_lock);
591 list_for_each_entry(client_node, &rbd_client_list, node) {
592 if (!ceph_compare_options(ceph_opts, client_node->client)) {
593 __rbd_get_client(client_node);
599 spin_unlock(&rbd_client_list_lock);
601 return found ? client_node : NULL;
611 /* string args above */
614 /* Boolean args above */
618 static match_table_t rbd_opts_tokens = {
620 /* string args above */
621 {Opt_read_only, "read_only"},
622 {Opt_read_only, "ro"}, /* Alternate spelling */
623 {Opt_read_write, "read_write"},
624 {Opt_read_write, "rw"}, /* Alternate spelling */
625 /* Boolean args above */
633 #define RBD_READ_ONLY_DEFAULT false
635 static int parse_rbd_opts_token(char *c, void *private)
637 struct rbd_options *rbd_opts = private;
638 substring_t argstr[MAX_OPT_ARGS];
639 int token, intval, ret;
641 token = match_token(c, rbd_opts_tokens, argstr);
645 if (token < Opt_last_int) {
646 ret = match_int(&argstr[0], &intval);
648 pr_err("bad mount option arg (not int) "
652 dout("got int token %d val %d\n", token, intval);
653 } else if (token > Opt_last_int && token < Opt_last_string) {
654 dout("got string token %d val %s\n", token,
656 } else if (token > Opt_last_string && token < Opt_last_bool) {
657 dout("got Boolean token %d\n", token);
659 dout("got token %d\n", token);
664 rbd_opts->read_only = true;
667 rbd_opts->read_only = false;
677 * Get a ceph client with specific addr and configuration, if one does
678 * not exist create it. Either way, ceph_opts is consumed by this
681 static struct rbd_client *rbd_get_client(struct ceph_options *ceph_opts)
683 struct rbd_client *rbdc;
685 rbdc = rbd_client_find(ceph_opts);
686 if (rbdc) /* using an existing client */
687 ceph_destroy_options(ceph_opts);
689 rbdc = rbd_client_create(ceph_opts);
695 * Destroy ceph client
697 * Caller must hold rbd_client_list_lock.
699 static void rbd_client_release(struct kref *kref)
701 struct rbd_client *rbdc = container_of(kref, struct rbd_client, kref);
703 dout("%s: rbdc %p\n", __func__, rbdc);
704 spin_lock(&rbd_client_list_lock);
705 list_del(&rbdc->node);
706 spin_unlock(&rbd_client_list_lock);
708 ceph_destroy_client(rbdc->client);
713 * Drop reference to ceph client node. If it's not referenced anymore, release
716 static void rbd_put_client(struct rbd_client *rbdc)
719 kref_put(&rbdc->kref, rbd_client_release);
722 static bool rbd_image_format_valid(u32 image_format)
724 return image_format == 1 || image_format == 2;
727 static bool rbd_dev_ondisk_valid(struct rbd_image_header_ondisk *ondisk)
732 /* The header has to start with the magic rbd header text */
733 if (memcmp(&ondisk->text, RBD_HEADER_TEXT, sizeof (RBD_HEADER_TEXT)))
736 /* The bio layer requires at least sector-sized I/O */
738 if (ondisk->options.order < SECTOR_SHIFT)
741 /* If we use u64 in a few spots we may be able to loosen this */
743 if (ondisk->options.order > 8 * sizeof (int) - 1)
747 * The size of a snapshot header has to fit in a size_t, and
748 * that limits the number of snapshots.
750 snap_count = le32_to_cpu(ondisk->snap_count);
751 size = SIZE_MAX - sizeof (struct ceph_snap_context);
752 if (snap_count > size / sizeof (__le64))
756 * Not only that, but the size of the entire the snapshot
757 * header must also be representable in a size_t.
759 size -= snap_count * sizeof (__le64);
760 if ((u64) size < le64_to_cpu(ondisk->snap_names_len))
767 * Fill an rbd image header with information from the given format 1
770 static int rbd_header_from_disk(struct rbd_device *rbd_dev,
771 struct rbd_image_header_ondisk *ondisk)
773 struct rbd_image_header *header = &rbd_dev->header;
774 bool first_time = header->object_prefix == NULL;
775 struct ceph_snap_context *snapc;
776 char *object_prefix = NULL;
777 char *snap_names = NULL;
778 u64 *snap_sizes = NULL;
784 /* Allocate this now to avoid having to handle failure below */
789 len = strnlen(ondisk->object_prefix,
790 sizeof (ondisk->object_prefix));
791 object_prefix = kmalloc(len + 1, GFP_KERNEL);
794 memcpy(object_prefix, ondisk->object_prefix, len);
795 object_prefix[len] = '\0';
798 /* Allocate the snapshot context and fill it in */
800 snap_count = le32_to_cpu(ondisk->snap_count);
801 snapc = ceph_create_snap_context(snap_count, GFP_KERNEL);
804 snapc->seq = le64_to_cpu(ondisk->snap_seq);
806 struct rbd_image_snap_ondisk *snaps;
807 u64 snap_names_len = le64_to_cpu(ondisk->snap_names_len);
809 /* We'll keep a copy of the snapshot names... */
811 if (snap_names_len > (u64)SIZE_MAX)
813 snap_names = kmalloc(snap_names_len, GFP_KERNEL);
817 /* ...as well as the array of their sizes. */
819 size = snap_count * sizeof (*header->snap_sizes);
820 snap_sizes = kmalloc(size, GFP_KERNEL);
825 * Copy the names, and fill in each snapshot's id
828 * Note that rbd_dev_v1_header_info() guarantees the
829 * ondisk buffer we're working with has
830 * snap_names_len bytes beyond the end of the
831 * snapshot id array, this memcpy() is safe.
833 memcpy(snap_names, &ondisk->snaps[snap_count], snap_names_len);
834 snaps = ondisk->snaps;
835 for (i = 0; i < snap_count; i++) {
836 snapc->snaps[i] = le64_to_cpu(snaps[i].id);
837 snap_sizes[i] = le64_to_cpu(snaps[i].image_size);
841 /* We won't fail any more, fill in the header */
843 down_write(&rbd_dev->header_rwsem);
845 header->object_prefix = object_prefix;
846 header->obj_order = ondisk->options.order;
847 header->crypt_type = ondisk->options.crypt_type;
848 header->comp_type = ondisk->options.comp_type;
849 /* The rest aren't used for format 1 images */
850 header->stripe_unit = 0;
851 header->stripe_count = 0;
852 header->features = 0;
854 ceph_put_snap_context(header->snapc);
855 kfree(header->snap_names);
856 kfree(header->snap_sizes);
859 /* The remaining fields always get updated (when we refresh) */
861 header->image_size = le64_to_cpu(ondisk->image_size);
862 header->snapc = snapc;
863 header->snap_names = snap_names;
864 header->snap_sizes = snap_sizes;
866 /* Make sure mapping size is consistent with header info */
868 if (rbd_dev->spec->snap_id == CEPH_NOSNAP || first_time)
869 if (rbd_dev->mapping.size != header->image_size)
870 rbd_dev->mapping.size = header->image_size;
872 up_write(&rbd_dev->header_rwsem);
880 ceph_put_snap_context(snapc);
881 kfree(object_prefix);
886 static const char *_rbd_dev_v1_snap_name(struct rbd_device *rbd_dev, u32 which)
888 const char *snap_name;
890 rbd_assert(which < rbd_dev->header.snapc->num_snaps);
892 /* Skip over names until we find the one we are looking for */
894 snap_name = rbd_dev->header.snap_names;
896 snap_name += strlen(snap_name) + 1;
898 return kstrdup(snap_name, GFP_KERNEL);
902 * Snapshot id comparison function for use with qsort()/bsearch().
903 * Note that result is for snapshots in *descending* order.
905 static int snapid_compare_reverse(const void *s1, const void *s2)
907 u64 snap_id1 = *(u64 *)s1;
908 u64 snap_id2 = *(u64 *)s2;
910 if (snap_id1 < snap_id2)
912 return snap_id1 == snap_id2 ? 0 : -1;
916 * Search a snapshot context to see if the given snapshot id is
919 * Returns the position of the snapshot id in the array if it's found,
920 * or BAD_SNAP_INDEX otherwise.
922 * Note: The snapshot array is in kept sorted (by the osd) in
923 * reverse order, highest snapshot id first.
925 static u32 rbd_dev_snap_index(struct rbd_device *rbd_dev, u64 snap_id)
927 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
930 found = bsearch(&snap_id, &snapc->snaps, snapc->num_snaps,
931 sizeof (snap_id), snapid_compare_reverse);
933 return found ? (u32)(found - &snapc->snaps[0]) : BAD_SNAP_INDEX;
936 static const char *rbd_dev_v1_snap_name(struct rbd_device *rbd_dev,
941 which = rbd_dev_snap_index(rbd_dev, snap_id);
942 if (which == BAD_SNAP_INDEX)
945 return _rbd_dev_v1_snap_name(rbd_dev, which);
948 static const char *rbd_snap_name(struct rbd_device *rbd_dev, u64 snap_id)
950 if (snap_id == CEPH_NOSNAP)
951 return RBD_SNAP_HEAD_NAME;
953 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
954 if (rbd_dev->image_format == 1)
955 return rbd_dev_v1_snap_name(rbd_dev, snap_id);
957 return rbd_dev_v2_snap_name(rbd_dev, snap_id);
960 static int rbd_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
963 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
964 if (snap_id == CEPH_NOSNAP) {
965 *snap_size = rbd_dev->header.image_size;
966 } else if (rbd_dev->image_format == 1) {
969 which = rbd_dev_snap_index(rbd_dev, snap_id);
970 if (which == BAD_SNAP_INDEX)
973 *snap_size = rbd_dev->header.snap_sizes[which];
978 ret = _rbd_dev_v2_snap_size(rbd_dev, snap_id, NULL, &size);
987 static int rbd_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
990 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
991 if (snap_id == CEPH_NOSNAP) {
992 *snap_features = rbd_dev->header.features;
993 } else if (rbd_dev->image_format == 1) {
994 *snap_features = 0; /* No features for format 1 */
999 ret = _rbd_dev_v2_snap_features(rbd_dev, snap_id, &features);
1003 *snap_features = features;
1008 static int rbd_dev_mapping_set(struct rbd_device *rbd_dev)
1010 u64 snap_id = rbd_dev->spec->snap_id;
1015 ret = rbd_snap_size(rbd_dev, snap_id, &size);
1018 ret = rbd_snap_features(rbd_dev, snap_id, &features);
1022 rbd_dev->mapping.size = size;
1023 rbd_dev->mapping.features = features;
1028 static void rbd_dev_mapping_clear(struct rbd_device *rbd_dev)
1030 rbd_dev->mapping.size = 0;
1031 rbd_dev->mapping.features = 0;
1034 static const char *rbd_segment_name(struct rbd_device *rbd_dev, u64 offset)
1041 name = kmem_cache_alloc(rbd_segment_name_cache, GFP_NOIO);
1044 segment = offset >> rbd_dev->header.obj_order;
1045 name_format = "%s.%012llx";
1046 if (rbd_dev->image_format == 2)
1047 name_format = "%s.%016llx";
1048 ret = snprintf(name, MAX_OBJ_NAME_SIZE + 1, name_format,
1049 rbd_dev->header.object_prefix, segment);
1050 if (ret < 0 || ret > MAX_OBJ_NAME_SIZE) {
1051 pr_err("error formatting segment name for #%llu (%d)\n",
1060 static void rbd_segment_name_free(const char *name)
1062 /* The explicit cast here is needed to drop the const qualifier */
1064 kmem_cache_free(rbd_segment_name_cache, (void *)name);
1067 static u64 rbd_segment_offset(struct rbd_device *rbd_dev, u64 offset)
1069 u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
1071 return offset & (segment_size - 1);
1074 static u64 rbd_segment_length(struct rbd_device *rbd_dev,
1075 u64 offset, u64 length)
1077 u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
1079 offset &= segment_size - 1;
1081 rbd_assert(length <= U64_MAX - offset);
1082 if (offset + length > segment_size)
1083 length = segment_size - offset;
1089 * returns the size of an object in the image
1091 static u64 rbd_obj_bytes(struct rbd_image_header *header)
1093 return 1 << header->obj_order;
1100 static void bio_chain_put(struct bio *chain)
1106 chain = chain->bi_next;
1112 * zeros a bio chain, starting at specific offset
1114 static void zero_bio_chain(struct bio *chain, int start_ofs)
1117 unsigned long flags;
1123 bio_for_each_segment(bv, chain, i) {
1124 if (pos + bv->bv_len > start_ofs) {
1125 int remainder = max(start_ofs - pos, 0);
1126 buf = bvec_kmap_irq(bv, &flags);
1127 memset(buf + remainder, 0,
1128 bv->bv_len - remainder);
1129 bvec_kunmap_irq(buf, &flags);
1134 chain = chain->bi_next;
1139 * similar to zero_bio_chain(), zeros data defined by a page array,
1140 * starting at the given byte offset from the start of the array and
1141 * continuing up to the given end offset. The pages array is
1142 * assumed to be big enough to hold all bytes up to the end.
1144 static void zero_pages(struct page **pages, u64 offset, u64 end)
1146 struct page **page = &pages[offset >> PAGE_SHIFT];
1148 rbd_assert(end > offset);
1149 rbd_assert(end - offset <= (u64)SIZE_MAX);
1150 while (offset < end) {
1153 unsigned long flags;
1156 page_offset = offset & ~PAGE_MASK;
1157 length = min_t(size_t, PAGE_SIZE - page_offset, end - offset);
1158 local_irq_save(flags);
1159 kaddr = kmap_atomic(*page);
1160 memset(kaddr + page_offset, 0, length);
1161 kunmap_atomic(kaddr);
1162 local_irq_restore(flags);
1170 * Clone a portion of a bio, starting at the given byte offset
1171 * and continuing for the number of bytes indicated.
1173 static struct bio *bio_clone_range(struct bio *bio_src,
1174 unsigned int offset,
1182 unsigned short end_idx;
1183 unsigned short vcnt;
1186 /* Handle the easy case for the caller */
1188 if (!offset && len == bio_src->bi_size)
1189 return bio_clone(bio_src, gfpmask);
1191 if (WARN_ON_ONCE(!len))
1193 if (WARN_ON_ONCE(len > bio_src->bi_size))
1195 if (WARN_ON_ONCE(offset > bio_src->bi_size - len))
1198 /* Find first affected segment... */
1201 bio_for_each_segment(bv, bio_src, idx) {
1202 if (resid < bv->bv_len)
1204 resid -= bv->bv_len;
1208 /* ...and the last affected segment */
1211 __bio_for_each_segment(bv, bio_src, end_idx, idx) {
1212 if (resid <= bv->bv_len)
1214 resid -= bv->bv_len;
1216 vcnt = end_idx - idx + 1;
1218 /* Build the clone */
1220 bio = bio_alloc(gfpmask, (unsigned int) vcnt);
1222 return NULL; /* ENOMEM */
1224 bio->bi_bdev = bio_src->bi_bdev;
1225 bio->bi_sector = bio_src->bi_sector + (offset >> SECTOR_SHIFT);
1226 bio->bi_rw = bio_src->bi_rw;
1227 bio->bi_flags |= 1 << BIO_CLONED;
1230 * Copy over our part of the bio_vec, then update the first
1231 * and last (or only) entries.
1233 memcpy(&bio->bi_io_vec[0], &bio_src->bi_io_vec[idx],
1234 vcnt * sizeof (struct bio_vec));
1235 bio->bi_io_vec[0].bv_offset += voff;
1237 bio->bi_io_vec[0].bv_len -= voff;
1238 bio->bi_io_vec[vcnt - 1].bv_len = resid;
1240 bio->bi_io_vec[0].bv_len = len;
1243 bio->bi_vcnt = vcnt;
1251 * Clone a portion of a bio chain, starting at the given byte offset
1252 * into the first bio in the source chain and continuing for the
1253 * number of bytes indicated. The result is another bio chain of
1254 * exactly the given length, or a null pointer on error.
1256 * The bio_src and offset parameters are both in-out. On entry they
1257 * refer to the first source bio and the offset into that bio where
1258 * the start of data to be cloned is located.
1260 * On return, bio_src is updated to refer to the bio in the source
1261 * chain that contains first un-cloned byte, and *offset will
1262 * contain the offset of that byte within that bio.
1264 static struct bio *bio_chain_clone_range(struct bio **bio_src,
1265 unsigned int *offset,
1269 struct bio *bi = *bio_src;
1270 unsigned int off = *offset;
1271 struct bio *chain = NULL;
1274 /* Build up a chain of clone bios up to the limit */
1276 if (!bi || off >= bi->bi_size || !len)
1277 return NULL; /* Nothing to clone */
1281 unsigned int bi_size;
1285 rbd_warn(NULL, "bio_chain exhausted with %u left", len);
1286 goto out_err; /* EINVAL; ran out of bio's */
1288 bi_size = min_t(unsigned int, bi->bi_size - off, len);
1289 bio = bio_clone_range(bi, off, bi_size, gfpmask);
1291 goto out_err; /* ENOMEM */
1294 end = &bio->bi_next;
1297 if (off == bi->bi_size) {
1308 bio_chain_put(chain);
1314 * The default/initial value for all object request flags is 0. For
1315 * each flag, once its value is set to 1 it is never reset to 0
1318 static void obj_request_img_data_set(struct rbd_obj_request *obj_request)
1320 if (test_and_set_bit(OBJ_REQ_IMG_DATA, &obj_request->flags)) {
1321 struct rbd_device *rbd_dev;
1323 rbd_dev = obj_request->img_request->rbd_dev;
1324 rbd_warn(rbd_dev, "obj_request %p already marked img_data\n",
1329 static bool obj_request_img_data_test(struct rbd_obj_request *obj_request)
1332 return test_bit(OBJ_REQ_IMG_DATA, &obj_request->flags) != 0;
1335 static void obj_request_done_set(struct rbd_obj_request *obj_request)
1337 if (test_and_set_bit(OBJ_REQ_DONE, &obj_request->flags)) {
1338 struct rbd_device *rbd_dev = NULL;
1340 if (obj_request_img_data_test(obj_request))
1341 rbd_dev = obj_request->img_request->rbd_dev;
1342 rbd_warn(rbd_dev, "obj_request %p already marked done\n",
1347 static bool obj_request_done_test(struct rbd_obj_request *obj_request)
1350 return test_bit(OBJ_REQ_DONE, &obj_request->flags) != 0;
1354 * This sets the KNOWN flag after (possibly) setting the EXISTS
1355 * flag. The latter is set based on the "exists" value provided.
1357 * Note that for our purposes once an object exists it never goes
1358 * away again. It's possible that the response from two existence
1359 * checks are separated by the creation of the target object, and
1360 * the first ("doesn't exist") response arrives *after* the second
1361 * ("does exist"). In that case we ignore the second one.
1363 static void obj_request_existence_set(struct rbd_obj_request *obj_request,
1367 set_bit(OBJ_REQ_EXISTS, &obj_request->flags);
1368 set_bit(OBJ_REQ_KNOWN, &obj_request->flags);
1372 static bool obj_request_known_test(struct rbd_obj_request *obj_request)
1375 return test_bit(OBJ_REQ_KNOWN, &obj_request->flags) != 0;
1378 static bool obj_request_exists_test(struct rbd_obj_request *obj_request)
1381 return test_bit(OBJ_REQ_EXISTS, &obj_request->flags) != 0;
1384 static void rbd_obj_request_get(struct rbd_obj_request *obj_request)
1386 dout("%s: obj %p (was %d)\n", __func__, obj_request,
1387 atomic_read(&obj_request->kref.refcount));
1388 kref_get(&obj_request->kref);
1391 static void rbd_obj_request_destroy(struct kref *kref);
1392 static void rbd_obj_request_put(struct rbd_obj_request *obj_request)
1394 rbd_assert(obj_request != NULL);
1395 dout("%s: obj %p (was %d)\n", __func__, obj_request,
1396 atomic_read(&obj_request->kref.refcount));
1397 kref_put(&obj_request->kref, rbd_obj_request_destroy);
1400 static bool img_request_child_test(struct rbd_img_request *img_request);
1401 static void rbd_parent_request_destroy(struct kref *kref);
1402 static void rbd_img_request_destroy(struct kref *kref);
1403 static void rbd_img_request_put(struct rbd_img_request *img_request)
1405 rbd_assert(img_request != NULL);
1406 dout("%s: img %p (was %d)\n", __func__, img_request,
1407 atomic_read(&img_request->kref.refcount));
1408 if (img_request_child_test(img_request))
1409 kref_put(&img_request->kref, rbd_parent_request_destroy);
1411 kref_put(&img_request->kref, rbd_img_request_destroy);
1414 static inline void rbd_img_obj_request_add(struct rbd_img_request *img_request,
1415 struct rbd_obj_request *obj_request)
1417 rbd_assert(obj_request->img_request == NULL);
1419 /* Image request now owns object's original reference */
1420 obj_request->img_request = img_request;
1421 obj_request->which = img_request->obj_request_count;
1422 rbd_assert(!obj_request_img_data_test(obj_request));
1423 obj_request_img_data_set(obj_request);
1424 rbd_assert(obj_request->which != BAD_WHICH);
1425 img_request->obj_request_count++;
1426 list_add_tail(&obj_request->links, &img_request->obj_requests);
1427 dout("%s: img %p obj %p w=%u\n", __func__, img_request, obj_request,
1428 obj_request->which);
1431 static inline void rbd_img_obj_request_del(struct rbd_img_request *img_request,
1432 struct rbd_obj_request *obj_request)
1434 rbd_assert(obj_request->which != BAD_WHICH);
1436 dout("%s: img %p obj %p w=%u\n", __func__, img_request, obj_request,
1437 obj_request->which);
1438 list_del(&obj_request->links);
1439 rbd_assert(img_request->obj_request_count > 0);
1440 img_request->obj_request_count--;
1441 rbd_assert(obj_request->which == img_request->obj_request_count);
1442 obj_request->which = BAD_WHICH;
1443 rbd_assert(obj_request_img_data_test(obj_request));
1444 rbd_assert(obj_request->img_request == img_request);
1445 obj_request->img_request = NULL;
1446 obj_request->callback = NULL;
1447 rbd_obj_request_put(obj_request);
1450 static bool obj_request_type_valid(enum obj_request_type type)
1453 case OBJ_REQUEST_NODATA:
1454 case OBJ_REQUEST_BIO:
1455 case OBJ_REQUEST_PAGES:
1462 static int rbd_obj_request_submit(struct ceph_osd_client *osdc,
1463 struct rbd_obj_request *obj_request)
1465 dout("%s: osdc %p obj %p\n", __func__, osdc, obj_request);
1467 return ceph_osdc_start_request(osdc, obj_request->osd_req, false);
1470 static void rbd_img_request_complete(struct rbd_img_request *img_request)
1473 dout("%s: img %p\n", __func__, img_request);
1476 * If no error occurred, compute the aggregate transfer
1477 * count for the image request. We could instead use
1478 * atomic64_cmpxchg() to update it as each object request
1479 * completes; not clear which way is better off hand.
1481 if (!img_request->result) {
1482 struct rbd_obj_request *obj_request;
1485 for_each_obj_request(img_request, obj_request)
1486 xferred += obj_request->xferred;
1487 img_request->xferred = xferred;
1490 if (img_request->callback)
1491 img_request->callback(img_request);
1493 rbd_img_request_put(img_request);
1496 /* Caller is responsible for rbd_obj_request_destroy(obj_request) */
1498 static int rbd_obj_request_wait(struct rbd_obj_request *obj_request)
1500 dout("%s: obj %p\n", __func__, obj_request);
1502 return wait_for_completion_interruptible(&obj_request->completion);
1506 * The default/initial value for all image request flags is 0. Each
1507 * is conditionally set to 1 at image request initialization time
1508 * and currently never change thereafter.
1510 static void img_request_write_set(struct rbd_img_request *img_request)
1512 set_bit(IMG_REQ_WRITE, &img_request->flags);
1516 static bool img_request_write_test(struct rbd_img_request *img_request)
1519 return test_bit(IMG_REQ_WRITE, &img_request->flags) != 0;
1522 static void img_request_child_set(struct rbd_img_request *img_request)
1524 set_bit(IMG_REQ_CHILD, &img_request->flags);
1528 static void img_request_child_clear(struct rbd_img_request *img_request)
1530 clear_bit(IMG_REQ_CHILD, &img_request->flags);
1534 static bool img_request_child_test(struct rbd_img_request *img_request)
1537 return test_bit(IMG_REQ_CHILD, &img_request->flags) != 0;
1540 static void img_request_layered_set(struct rbd_img_request *img_request)
1542 set_bit(IMG_REQ_LAYERED, &img_request->flags);
1546 static void img_request_layered_clear(struct rbd_img_request *img_request)
1548 clear_bit(IMG_REQ_LAYERED, &img_request->flags);
1552 static bool img_request_layered_test(struct rbd_img_request *img_request)
1555 return test_bit(IMG_REQ_LAYERED, &img_request->flags) != 0;
1559 rbd_img_obj_request_read_callback(struct rbd_obj_request *obj_request)
1561 u64 xferred = obj_request->xferred;
1562 u64 length = obj_request->length;
1564 dout("%s: obj %p img %p result %d %llu/%llu\n", __func__,
1565 obj_request, obj_request->img_request, obj_request->result,
1568 * ENOENT means a hole in the image. We zero-fill the
1569 * entire length of the request. A short read also implies
1570 * zero-fill to the end of the request. Either way we
1571 * update the xferred count to indicate the whole request
1574 rbd_assert(obj_request->type != OBJ_REQUEST_NODATA);
1575 if (obj_request->result == -ENOENT) {
1576 if (obj_request->type == OBJ_REQUEST_BIO)
1577 zero_bio_chain(obj_request->bio_list, 0);
1579 zero_pages(obj_request->pages, 0, length);
1580 obj_request->result = 0;
1581 obj_request->xferred = length;
1582 } else if (xferred < length && !obj_request->result) {
1583 if (obj_request->type == OBJ_REQUEST_BIO)
1584 zero_bio_chain(obj_request->bio_list, xferred);
1586 zero_pages(obj_request->pages, xferred, length);
1587 obj_request->xferred = length;
1589 obj_request_done_set(obj_request);
1592 static void rbd_obj_request_complete(struct rbd_obj_request *obj_request)
1594 dout("%s: obj %p cb %p\n", __func__, obj_request,
1595 obj_request->callback);
1596 if (obj_request->callback)
1597 obj_request->callback(obj_request);
1599 complete_all(&obj_request->completion);
1602 static void rbd_osd_trivial_callback(struct rbd_obj_request *obj_request)
1604 dout("%s: obj %p\n", __func__, obj_request);
1605 obj_request_done_set(obj_request);
1608 static void rbd_osd_read_callback(struct rbd_obj_request *obj_request)
1610 struct rbd_img_request *img_request = NULL;
1611 struct rbd_device *rbd_dev = NULL;
1612 bool layered = false;
1614 if (obj_request_img_data_test(obj_request)) {
1615 img_request = obj_request->img_request;
1616 layered = img_request && img_request_layered_test(img_request);
1617 rbd_dev = img_request->rbd_dev;
1620 dout("%s: obj %p img %p result %d %llu/%llu\n", __func__,
1621 obj_request, img_request, obj_request->result,
1622 obj_request->xferred, obj_request->length);
1623 if (layered && obj_request->result == -ENOENT &&
1624 obj_request->img_offset < rbd_dev->parent_overlap)
1625 rbd_img_parent_read(obj_request);
1626 else if (img_request)
1627 rbd_img_obj_request_read_callback(obj_request);
1629 obj_request_done_set(obj_request);
1632 static void rbd_osd_write_callback(struct rbd_obj_request *obj_request)
1634 dout("%s: obj %p result %d %llu\n", __func__, obj_request,
1635 obj_request->result, obj_request->length);
1637 * There is no such thing as a successful short write. Set
1638 * it to our originally-requested length.
1640 obj_request->xferred = obj_request->length;
1641 obj_request_done_set(obj_request);
1645 * For a simple stat call there's nothing to do. We'll do more if
1646 * this is part of a write sequence for a layered image.
1648 static void rbd_osd_stat_callback(struct rbd_obj_request *obj_request)
1650 dout("%s: obj %p\n", __func__, obj_request);
1651 obj_request_done_set(obj_request);
1654 static void rbd_osd_req_callback(struct ceph_osd_request *osd_req,
1655 struct ceph_msg *msg)
1657 struct rbd_obj_request *obj_request = osd_req->r_priv;
1660 dout("%s: osd_req %p msg %p\n", __func__, osd_req, msg);
1661 rbd_assert(osd_req == obj_request->osd_req);
1662 if (obj_request_img_data_test(obj_request)) {
1663 rbd_assert(obj_request->img_request);
1664 rbd_assert(obj_request->which != BAD_WHICH);
1666 rbd_assert(obj_request->which == BAD_WHICH);
1669 if (osd_req->r_result < 0)
1670 obj_request->result = osd_req->r_result;
1672 BUG_ON(osd_req->r_num_ops > 2);
1675 * We support a 64-bit length, but ultimately it has to be
1676 * passed to blk_end_request(), which takes an unsigned int.
1678 obj_request->xferred = osd_req->r_reply_op_len[0];
1679 rbd_assert(obj_request->xferred < (u64)UINT_MAX);
1680 opcode = osd_req->r_ops[0].op;
1682 case CEPH_OSD_OP_READ:
1683 rbd_osd_read_callback(obj_request);
1685 case CEPH_OSD_OP_WRITE:
1686 rbd_osd_write_callback(obj_request);
1688 case CEPH_OSD_OP_STAT:
1689 rbd_osd_stat_callback(obj_request);
1691 case CEPH_OSD_OP_CALL:
1692 case CEPH_OSD_OP_NOTIFY_ACK:
1693 case CEPH_OSD_OP_WATCH:
1694 rbd_osd_trivial_callback(obj_request);
1697 rbd_warn(NULL, "%s: unsupported op %hu\n",
1698 obj_request->object_name, (unsigned short) opcode);
1702 if (obj_request_done_test(obj_request))
1703 rbd_obj_request_complete(obj_request);
1706 static void rbd_osd_req_format_read(struct rbd_obj_request *obj_request)
1708 struct rbd_img_request *img_request = obj_request->img_request;
1709 struct ceph_osd_request *osd_req = obj_request->osd_req;
1712 rbd_assert(osd_req != NULL);
1714 snap_id = img_request ? img_request->snap_id : CEPH_NOSNAP;
1715 ceph_osdc_build_request(osd_req, obj_request->offset,
1716 NULL, snap_id, NULL);
1719 static void rbd_osd_req_format_write(struct rbd_obj_request *obj_request)
1721 struct rbd_img_request *img_request = obj_request->img_request;
1722 struct ceph_osd_request *osd_req = obj_request->osd_req;
1723 struct ceph_snap_context *snapc;
1724 struct timespec mtime = CURRENT_TIME;
1726 rbd_assert(osd_req != NULL);
1728 snapc = img_request ? img_request->snapc : NULL;
1729 ceph_osdc_build_request(osd_req, obj_request->offset,
1730 snapc, CEPH_NOSNAP, &mtime);
1733 static struct ceph_osd_request *rbd_osd_req_create(
1734 struct rbd_device *rbd_dev,
1736 struct rbd_obj_request *obj_request)
1738 struct ceph_snap_context *snapc = NULL;
1739 struct ceph_osd_client *osdc;
1740 struct ceph_osd_request *osd_req;
1742 if (obj_request_img_data_test(obj_request)) {
1743 struct rbd_img_request *img_request = obj_request->img_request;
1745 rbd_assert(write_request ==
1746 img_request_write_test(img_request));
1748 snapc = img_request->snapc;
1751 /* Allocate and initialize the request, for the single op */
1753 osdc = &rbd_dev->rbd_client->client->osdc;
1754 osd_req = ceph_osdc_alloc_request(osdc, snapc, 1, false, GFP_ATOMIC);
1756 return NULL; /* ENOMEM */
1759 osd_req->r_flags = CEPH_OSD_FLAG_WRITE | CEPH_OSD_FLAG_ONDISK;
1761 osd_req->r_flags = CEPH_OSD_FLAG_READ;
1763 osd_req->r_callback = rbd_osd_req_callback;
1764 osd_req->r_priv = obj_request;
1766 osd_req->r_oid_len = strlen(obj_request->object_name);
1767 rbd_assert(osd_req->r_oid_len < sizeof (osd_req->r_oid));
1768 memcpy(osd_req->r_oid, obj_request->object_name, osd_req->r_oid_len);
1770 osd_req->r_file_layout = rbd_dev->layout; /* struct */
1776 * Create a copyup osd request based on the information in the
1777 * object request supplied. A copyup request has two osd ops,
1778 * a copyup method call, and a "normal" write request.
1780 static struct ceph_osd_request *
1781 rbd_osd_req_create_copyup(struct rbd_obj_request *obj_request)
1783 struct rbd_img_request *img_request;
1784 struct ceph_snap_context *snapc;
1785 struct rbd_device *rbd_dev;
1786 struct ceph_osd_client *osdc;
1787 struct ceph_osd_request *osd_req;
1789 rbd_assert(obj_request_img_data_test(obj_request));
1790 img_request = obj_request->img_request;
1791 rbd_assert(img_request);
1792 rbd_assert(img_request_write_test(img_request));
1794 /* Allocate and initialize the request, for the two ops */
1796 snapc = img_request->snapc;
1797 rbd_dev = img_request->rbd_dev;
1798 osdc = &rbd_dev->rbd_client->client->osdc;
1799 osd_req = ceph_osdc_alloc_request(osdc, snapc, 2, false, GFP_ATOMIC);
1801 return NULL; /* ENOMEM */
1803 osd_req->r_flags = CEPH_OSD_FLAG_WRITE | CEPH_OSD_FLAG_ONDISK;
1804 osd_req->r_callback = rbd_osd_req_callback;
1805 osd_req->r_priv = obj_request;
1807 osd_req->r_oid_len = strlen(obj_request->object_name);
1808 rbd_assert(osd_req->r_oid_len < sizeof (osd_req->r_oid));
1809 memcpy(osd_req->r_oid, obj_request->object_name, osd_req->r_oid_len);
1811 osd_req->r_file_layout = rbd_dev->layout; /* struct */
1817 static void rbd_osd_req_destroy(struct ceph_osd_request *osd_req)
1819 ceph_osdc_put_request(osd_req);
1822 /* object_name is assumed to be a non-null pointer and NUL-terminated */
1824 static struct rbd_obj_request *rbd_obj_request_create(const char *object_name,
1825 u64 offset, u64 length,
1826 enum obj_request_type type)
1828 struct rbd_obj_request *obj_request;
1832 rbd_assert(obj_request_type_valid(type));
1834 size = strlen(object_name) + 1;
1835 name = kmalloc(size, GFP_KERNEL);
1839 obj_request = kmem_cache_zalloc(rbd_obj_request_cache, GFP_KERNEL);
1845 obj_request->object_name = memcpy(name, object_name, size);
1846 obj_request->offset = offset;
1847 obj_request->length = length;
1848 obj_request->flags = 0;
1849 obj_request->which = BAD_WHICH;
1850 obj_request->type = type;
1851 INIT_LIST_HEAD(&obj_request->links);
1852 init_completion(&obj_request->completion);
1853 kref_init(&obj_request->kref);
1855 dout("%s: \"%s\" %llu/%llu %d -> obj %p\n", __func__, object_name,
1856 offset, length, (int)type, obj_request);
1861 static void rbd_obj_request_destroy(struct kref *kref)
1863 struct rbd_obj_request *obj_request;
1865 obj_request = container_of(kref, struct rbd_obj_request, kref);
1867 dout("%s: obj %p\n", __func__, obj_request);
1869 rbd_assert(obj_request->img_request == NULL);
1870 rbd_assert(obj_request->which == BAD_WHICH);
1872 if (obj_request->osd_req)
1873 rbd_osd_req_destroy(obj_request->osd_req);
1875 rbd_assert(obj_request_type_valid(obj_request->type));
1876 switch (obj_request->type) {
1877 case OBJ_REQUEST_NODATA:
1878 break; /* Nothing to do */
1879 case OBJ_REQUEST_BIO:
1880 if (obj_request->bio_list)
1881 bio_chain_put(obj_request->bio_list);
1883 case OBJ_REQUEST_PAGES:
1884 if (obj_request->pages)
1885 ceph_release_page_vector(obj_request->pages,
1886 obj_request->page_count);
1890 kfree(obj_request->object_name);
1891 obj_request->object_name = NULL;
1892 kmem_cache_free(rbd_obj_request_cache, obj_request);
1895 /* It's OK to call this for a device with no parent */
1897 static void rbd_spec_put(struct rbd_spec *spec);
1898 static void rbd_dev_unparent(struct rbd_device *rbd_dev)
1900 rbd_dev_remove_parent(rbd_dev);
1901 rbd_spec_put(rbd_dev->parent_spec);
1902 rbd_dev->parent_spec = NULL;
1903 rbd_dev->parent_overlap = 0;
1907 * Parent image reference counting is used to determine when an
1908 * image's parent fields can be safely torn down--after there are no
1909 * more in-flight requests to the parent image. When the last
1910 * reference is dropped, cleaning them up is safe.
1912 static void rbd_dev_parent_put(struct rbd_device *rbd_dev)
1916 if (!rbd_dev->parent_spec)
1919 counter = atomic_dec_return_safe(&rbd_dev->parent_ref);
1923 /* Last reference; clean up parent data structures */
1926 rbd_dev_unparent(rbd_dev);
1928 rbd_warn(rbd_dev, "parent reference underflow\n");
1932 * If an image has a non-zero parent overlap, get a reference to its
1935 * We must get the reference before checking for the overlap to
1936 * coordinate properly with zeroing the parent overlap in
1937 * rbd_dev_v2_parent_info() when an image gets flattened. We
1938 * drop it again if there is no overlap.
1940 * Returns true if the rbd device has a parent with a non-zero
1941 * overlap and a reference for it was successfully taken, or
1944 static bool rbd_dev_parent_get(struct rbd_device *rbd_dev)
1948 if (!rbd_dev->parent_spec)
1951 counter = atomic_inc_return_safe(&rbd_dev->parent_ref);
1952 if (counter > 0 && rbd_dev->parent_overlap)
1955 /* Image was flattened, but parent is not yet torn down */
1958 rbd_warn(rbd_dev, "parent reference overflow\n");
1964 * Caller is responsible for filling in the list of object requests
1965 * that comprises the image request, and the Linux request pointer
1966 * (if there is one).
1968 static struct rbd_img_request *rbd_img_request_create(
1969 struct rbd_device *rbd_dev,
1970 u64 offset, u64 length,
1973 struct rbd_img_request *img_request;
1975 img_request = kmem_cache_alloc(rbd_img_request_cache, GFP_ATOMIC);
1979 if (write_request) {
1980 down_read(&rbd_dev->header_rwsem);
1981 ceph_get_snap_context(rbd_dev->header.snapc);
1982 up_read(&rbd_dev->header_rwsem);
1985 img_request->rq = NULL;
1986 img_request->rbd_dev = rbd_dev;
1987 img_request->offset = offset;
1988 img_request->length = length;
1989 img_request->flags = 0;
1990 if (write_request) {
1991 img_request_write_set(img_request);
1992 img_request->snapc = rbd_dev->header.snapc;
1994 img_request->snap_id = rbd_dev->spec->snap_id;
1996 if (rbd_dev_parent_get(rbd_dev))
1997 img_request_layered_set(img_request);
1998 spin_lock_init(&img_request->completion_lock);
1999 img_request->next_completion = 0;
2000 img_request->callback = NULL;
2001 img_request->result = 0;
2002 img_request->obj_request_count = 0;
2003 INIT_LIST_HEAD(&img_request->obj_requests);
2004 kref_init(&img_request->kref);
2006 dout("%s: rbd_dev %p %s %llu/%llu -> img %p\n", __func__, rbd_dev,
2007 write_request ? "write" : "read", offset, length,
2013 static void rbd_img_request_destroy(struct kref *kref)
2015 struct rbd_img_request *img_request;
2016 struct rbd_obj_request *obj_request;
2017 struct rbd_obj_request *next_obj_request;
2019 img_request = container_of(kref, struct rbd_img_request, kref);
2021 dout("%s: img %p\n", __func__, img_request);
2023 for_each_obj_request_safe(img_request, obj_request, next_obj_request)
2024 rbd_img_obj_request_del(img_request, obj_request);
2025 rbd_assert(img_request->obj_request_count == 0);
2027 if (img_request_layered_test(img_request)) {
2028 img_request_layered_clear(img_request);
2029 rbd_dev_parent_put(img_request->rbd_dev);
2032 if (img_request_write_test(img_request))
2033 ceph_put_snap_context(img_request->snapc);
2035 kmem_cache_free(rbd_img_request_cache, img_request);
2038 static struct rbd_img_request *rbd_parent_request_create(
2039 struct rbd_obj_request *obj_request,
2040 u64 img_offset, u64 length)
2042 struct rbd_img_request *parent_request;
2043 struct rbd_device *rbd_dev;
2045 rbd_assert(obj_request->img_request);
2046 rbd_dev = obj_request->img_request->rbd_dev;
2048 parent_request = rbd_img_request_create(rbd_dev->parent,
2049 img_offset, length, false);
2050 if (!parent_request)
2053 img_request_child_set(parent_request);
2054 rbd_obj_request_get(obj_request);
2055 parent_request->obj_request = obj_request;
2057 return parent_request;
2060 static void rbd_parent_request_destroy(struct kref *kref)
2062 struct rbd_img_request *parent_request;
2063 struct rbd_obj_request *orig_request;
2065 parent_request = container_of(kref, struct rbd_img_request, kref);
2066 orig_request = parent_request->obj_request;
2068 parent_request->obj_request = NULL;
2069 rbd_obj_request_put(orig_request);
2070 img_request_child_clear(parent_request);
2072 rbd_img_request_destroy(kref);
2075 static bool rbd_img_obj_end_request(struct rbd_obj_request *obj_request)
2077 struct rbd_img_request *img_request;
2078 unsigned int xferred;
2082 rbd_assert(obj_request_img_data_test(obj_request));
2083 img_request = obj_request->img_request;
2085 rbd_assert(obj_request->xferred <= (u64)UINT_MAX);
2086 xferred = (unsigned int)obj_request->xferred;
2087 result = obj_request->result;
2089 struct rbd_device *rbd_dev = img_request->rbd_dev;
2091 rbd_warn(rbd_dev, "%s %llx at %llx (%llx)\n",
2092 img_request_write_test(img_request) ? "write" : "read",
2093 obj_request->length, obj_request->img_offset,
2094 obj_request->offset);
2095 rbd_warn(rbd_dev, " result %d xferred %x\n",
2097 if (!img_request->result)
2098 img_request->result = result;
2101 /* Image object requests don't own their page array */
2103 if (obj_request->type == OBJ_REQUEST_PAGES) {
2104 obj_request->pages = NULL;
2105 obj_request->page_count = 0;
2108 if (img_request_child_test(img_request)) {
2109 rbd_assert(img_request->obj_request != NULL);
2110 more = obj_request->which < img_request->obj_request_count - 1;
2112 rbd_assert(img_request->rq != NULL);
2113 more = blk_end_request(img_request->rq, result, xferred);
2119 static void rbd_img_obj_callback(struct rbd_obj_request *obj_request)
2121 struct rbd_img_request *img_request;
2122 u32 which = obj_request->which;
2125 rbd_assert(obj_request_img_data_test(obj_request));
2126 img_request = obj_request->img_request;
2128 dout("%s: img %p obj %p\n", __func__, img_request, obj_request);
2129 rbd_assert(img_request != NULL);
2130 rbd_assert(img_request->obj_request_count > 0);
2131 rbd_assert(which != BAD_WHICH);
2132 rbd_assert(which < img_request->obj_request_count);
2133 rbd_assert(which >= img_request->next_completion);
2135 spin_lock_irq(&img_request->completion_lock);
2136 if (which != img_request->next_completion)
2139 for_each_obj_request_from(img_request, obj_request) {
2141 rbd_assert(which < img_request->obj_request_count);
2143 if (!obj_request_done_test(obj_request))
2145 more = rbd_img_obj_end_request(obj_request);
2149 rbd_assert(more ^ (which == img_request->obj_request_count));
2150 img_request->next_completion = which;
2152 spin_unlock_irq(&img_request->completion_lock);
2155 rbd_img_request_complete(img_request);
2159 * Split up an image request into one or more object requests, each
2160 * to a different object. The "type" parameter indicates whether
2161 * "data_desc" is the pointer to the head of a list of bio
2162 * structures, or the base of a page array. In either case this
2163 * function assumes data_desc describes memory sufficient to hold
2164 * all data described by the image request.
2166 static int rbd_img_request_fill(struct rbd_img_request *img_request,
2167 enum obj_request_type type,
2170 struct rbd_device *rbd_dev = img_request->rbd_dev;
2171 struct rbd_obj_request *obj_request = NULL;
2172 struct rbd_obj_request *next_obj_request;
2173 bool write_request = img_request_write_test(img_request);
2174 struct bio *bio_list;
2175 unsigned int bio_offset = 0;
2176 struct page **pages;
2181 dout("%s: img %p type %d data_desc %p\n", __func__, img_request,
2182 (int)type, data_desc);
2184 opcode = write_request ? CEPH_OSD_OP_WRITE : CEPH_OSD_OP_READ;
2185 img_offset = img_request->offset;
2186 resid = img_request->length;
2187 rbd_assert(resid > 0);
2189 if (type == OBJ_REQUEST_BIO) {
2190 bio_list = data_desc;
2191 rbd_assert(img_offset == bio_list->bi_sector << SECTOR_SHIFT);
2193 rbd_assert(type == OBJ_REQUEST_PAGES);
2198 struct ceph_osd_request *osd_req;
2199 const char *object_name;
2203 object_name = rbd_segment_name(rbd_dev, img_offset);
2206 offset = rbd_segment_offset(rbd_dev, img_offset);
2207 length = rbd_segment_length(rbd_dev, img_offset, resid);
2208 obj_request = rbd_obj_request_create(object_name,
2209 offset, length, type);
2210 /* object request has its own copy of the object name */
2211 rbd_segment_name_free(object_name);
2215 if (type == OBJ_REQUEST_BIO) {
2216 unsigned int clone_size;
2218 rbd_assert(length <= (u64)UINT_MAX);
2219 clone_size = (unsigned int)length;
2220 obj_request->bio_list =
2221 bio_chain_clone_range(&bio_list,
2225 if (!obj_request->bio_list)
2228 unsigned int page_count;
2230 obj_request->pages = pages;
2231 page_count = (u32)calc_pages_for(offset, length);
2232 obj_request->page_count = page_count;
2233 if ((offset + length) & ~PAGE_MASK)
2234 page_count--; /* more on last page */
2235 pages += page_count;
2238 osd_req = rbd_osd_req_create(rbd_dev, write_request,
2242 obj_request->osd_req = osd_req;
2243 obj_request->callback = rbd_img_obj_callback;
2245 osd_req_op_extent_init(osd_req, 0, opcode, offset, length,
2247 if (type == OBJ_REQUEST_BIO)
2248 osd_req_op_extent_osd_data_bio(osd_req, 0,
2249 obj_request->bio_list, length);
2251 osd_req_op_extent_osd_data_pages(osd_req, 0,
2252 obj_request->pages, length,
2253 offset & ~PAGE_MASK, false, false);
2256 * set obj_request->img_request before formatting
2257 * the osd_request so that it gets the right snapc
2259 rbd_img_obj_request_add(img_request, obj_request);
2261 rbd_osd_req_format_write(obj_request);
2263 rbd_osd_req_format_read(obj_request);
2265 obj_request->img_offset = img_offset;
2267 img_offset += length;
2274 rbd_obj_request_put(obj_request);
2276 for_each_obj_request_safe(img_request, obj_request, next_obj_request)
2277 rbd_obj_request_put(obj_request);
2283 rbd_img_obj_copyup_callback(struct rbd_obj_request *obj_request)
2285 struct rbd_img_request *img_request;
2286 struct rbd_device *rbd_dev;
2287 struct page **pages;
2290 rbd_assert(obj_request->type == OBJ_REQUEST_BIO);
2291 rbd_assert(obj_request_img_data_test(obj_request));
2292 img_request = obj_request->img_request;
2293 rbd_assert(img_request);
2295 rbd_dev = img_request->rbd_dev;
2296 rbd_assert(rbd_dev);
2298 pages = obj_request->copyup_pages;
2299 rbd_assert(pages != NULL);
2300 obj_request->copyup_pages = NULL;
2301 page_count = obj_request->copyup_page_count;
2302 rbd_assert(page_count);
2303 obj_request->copyup_page_count = 0;
2304 ceph_release_page_vector(pages, page_count);
2307 * We want the transfer count to reflect the size of the
2308 * original write request. There is no such thing as a
2309 * successful short write, so if the request was successful
2310 * we can just set it to the originally-requested length.
2312 if (!obj_request->result)
2313 obj_request->xferred = obj_request->length;
2315 /* Finish up with the normal image object callback */
2317 rbd_img_obj_callback(obj_request);
2321 rbd_img_obj_parent_read_full_callback(struct rbd_img_request *img_request)
2323 struct rbd_obj_request *orig_request;
2324 struct ceph_osd_request *osd_req;
2325 struct ceph_osd_client *osdc;
2326 struct rbd_device *rbd_dev;
2327 struct page **pages;
2334 rbd_assert(img_request_child_test(img_request));
2336 /* First get what we need from the image request */
2338 pages = img_request->copyup_pages;
2339 rbd_assert(pages != NULL);
2340 img_request->copyup_pages = NULL;
2341 page_count = img_request->copyup_page_count;
2342 rbd_assert(page_count);
2343 img_request->copyup_page_count = 0;
2345 orig_request = img_request->obj_request;
2346 rbd_assert(orig_request != NULL);
2347 rbd_assert(obj_request_type_valid(orig_request->type));
2348 img_result = img_request->result;
2349 parent_length = img_request->length;
2350 rbd_assert(parent_length == img_request->xferred);
2351 rbd_img_request_put(img_request);
2353 rbd_assert(orig_request->img_request);
2354 rbd_dev = orig_request->img_request->rbd_dev;
2355 rbd_assert(rbd_dev);
2358 * If the overlap has become 0 (most likely because the
2359 * image has been flattened) we need to free the pages
2360 * and re-submit the original write request.
2362 if (!rbd_dev->parent_overlap) {
2363 struct ceph_osd_client *osdc;
2365 ceph_release_page_vector(pages, page_count);
2366 osdc = &rbd_dev->rbd_client->client->osdc;
2367 img_result = rbd_obj_request_submit(osdc, orig_request);
2376 * The original osd request is of no use to use any more.
2377 * We need a new one that can hold the two ops in a copyup
2378 * request. Allocate the new copyup osd request for the
2379 * original request, and release the old one.
2381 img_result = -ENOMEM;
2382 osd_req = rbd_osd_req_create_copyup(orig_request);
2385 rbd_osd_req_destroy(orig_request->osd_req);
2386 orig_request->osd_req = osd_req;
2387 orig_request->copyup_pages = pages;
2388 orig_request->copyup_page_count = page_count;
2390 /* Initialize the copyup op */
2392 osd_req_op_cls_init(osd_req, 0, CEPH_OSD_OP_CALL, "rbd", "copyup");
2393 osd_req_op_cls_request_data_pages(osd_req, 0, pages, parent_length, 0,
2396 /* Then the original write request op */
2398 offset = orig_request->offset;
2399 length = orig_request->length;
2400 osd_req_op_extent_init(osd_req, 1, CEPH_OSD_OP_WRITE,
2401 offset, length, 0, 0);
2402 if (orig_request->type == OBJ_REQUEST_BIO)
2403 osd_req_op_extent_osd_data_bio(osd_req, 1,
2404 orig_request->bio_list, length);
2406 osd_req_op_extent_osd_data_pages(osd_req, 1,
2407 orig_request->pages, length,
2408 offset & ~PAGE_MASK, false, false);
2410 rbd_osd_req_format_write(orig_request);
2412 /* All set, send it off. */
2414 orig_request->callback = rbd_img_obj_copyup_callback;
2415 osdc = &rbd_dev->rbd_client->client->osdc;
2416 img_result = rbd_obj_request_submit(osdc, orig_request);
2420 /* Record the error code and complete the request */
2422 orig_request->result = img_result;
2423 orig_request->xferred = 0;
2424 obj_request_done_set(orig_request);
2425 rbd_obj_request_complete(orig_request);
2429 * Read from the parent image the range of data that covers the
2430 * entire target of the given object request. This is used for
2431 * satisfying a layered image write request when the target of an
2432 * object request from the image request does not exist.
2434 * A page array big enough to hold the returned data is allocated
2435 * and supplied to rbd_img_request_fill() as the "data descriptor."
2436 * When the read completes, this page array will be transferred to
2437 * the original object request for the copyup operation.
2439 * If an error occurs, record it as the result of the original
2440 * object request and mark it done so it gets completed.
2442 static int rbd_img_obj_parent_read_full(struct rbd_obj_request *obj_request)
2444 struct rbd_img_request *img_request = NULL;
2445 struct rbd_img_request *parent_request = NULL;
2446 struct rbd_device *rbd_dev;
2449 struct page **pages = NULL;
2453 rbd_assert(obj_request_img_data_test(obj_request));
2454 rbd_assert(obj_request_type_valid(obj_request->type));
2456 img_request = obj_request->img_request;
2457 rbd_assert(img_request != NULL);
2458 rbd_dev = img_request->rbd_dev;
2459 rbd_assert(rbd_dev->parent != NULL);
2462 * Determine the byte range covered by the object in the
2463 * child image to which the original request was to be sent.
2465 img_offset = obj_request->img_offset - obj_request->offset;
2466 length = (u64)1 << rbd_dev->header.obj_order;
2469 * There is no defined parent data beyond the parent
2470 * overlap, so limit what we read at that boundary if
2473 if (img_offset + length > rbd_dev->parent_overlap) {
2474 rbd_assert(img_offset < rbd_dev->parent_overlap);
2475 length = rbd_dev->parent_overlap - img_offset;
2479 * Allocate a page array big enough to receive the data read
2482 page_count = (u32)calc_pages_for(0, length);
2483 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2484 if (IS_ERR(pages)) {
2485 result = PTR_ERR(pages);
2491 parent_request = rbd_parent_request_create(obj_request,
2492 img_offset, length);
2493 if (!parent_request)
2496 result = rbd_img_request_fill(parent_request, OBJ_REQUEST_PAGES, pages);
2499 parent_request->copyup_pages = pages;
2500 parent_request->copyup_page_count = page_count;
2502 parent_request->callback = rbd_img_obj_parent_read_full_callback;
2503 result = rbd_img_request_submit(parent_request);
2507 parent_request->copyup_pages = NULL;
2508 parent_request->copyup_page_count = 0;
2509 parent_request->obj_request = NULL;
2510 rbd_obj_request_put(obj_request);
2513 ceph_release_page_vector(pages, page_count);
2515 rbd_img_request_put(parent_request);
2516 obj_request->result = result;
2517 obj_request->xferred = 0;
2518 obj_request_done_set(obj_request);
2523 static void rbd_img_obj_exists_callback(struct rbd_obj_request *obj_request)
2525 struct rbd_obj_request *orig_request;
2526 struct rbd_device *rbd_dev;
2529 rbd_assert(!obj_request_img_data_test(obj_request));
2532 * All we need from the object request is the original
2533 * request and the result of the STAT op. Grab those, then
2534 * we're done with the request.
2536 orig_request = obj_request->obj_request;
2537 obj_request->obj_request = NULL;
2538 rbd_obj_request_put(orig_request);
2539 rbd_assert(orig_request);
2540 rbd_assert(orig_request->img_request);
2542 result = obj_request->result;
2543 obj_request->result = 0;
2545 dout("%s: obj %p for obj %p result %d %llu/%llu\n", __func__,
2546 obj_request, orig_request, result,
2547 obj_request->xferred, obj_request->length);
2548 rbd_obj_request_put(obj_request);
2551 * If the overlap has become 0 (most likely because the
2552 * image has been flattened) we need to free the pages
2553 * and re-submit the original write request.
2555 rbd_dev = orig_request->img_request->rbd_dev;
2556 if (!rbd_dev->parent_overlap) {
2557 struct ceph_osd_client *osdc;
2559 osdc = &rbd_dev->rbd_client->client->osdc;
2560 result = rbd_obj_request_submit(osdc, orig_request);
2566 * Our only purpose here is to determine whether the object
2567 * exists, and we don't want to treat the non-existence as
2568 * an error. If something else comes back, transfer the
2569 * error to the original request and complete it now.
2572 obj_request_existence_set(orig_request, true);
2573 } else if (result == -ENOENT) {
2574 obj_request_existence_set(orig_request, false);
2575 } else if (result) {
2576 orig_request->result = result;
2581 * Resubmit the original request now that we have recorded
2582 * whether the target object exists.
2584 orig_request->result = rbd_img_obj_request_submit(orig_request);
2586 if (orig_request->result)
2587 rbd_obj_request_complete(orig_request);
2590 static int rbd_img_obj_exists_submit(struct rbd_obj_request *obj_request)
2592 struct rbd_obj_request *stat_request;
2593 struct rbd_device *rbd_dev;
2594 struct ceph_osd_client *osdc;
2595 struct page **pages = NULL;
2601 * The response data for a STAT call consists of:
2608 size = sizeof (__le64) + sizeof (__le32) + sizeof (__le32);
2609 page_count = (u32)calc_pages_for(0, size);
2610 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2612 return PTR_ERR(pages);
2615 stat_request = rbd_obj_request_create(obj_request->object_name, 0, 0,
2620 rbd_obj_request_get(obj_request);
2621 stat_request->obj_request = obj_request;
2622 stat_request->pages = pages;
2623 stat_request->page_count = page_count;
2625 rbd_assert(obj_request->img_request);
2626 rbd_dev = obj_request->img_request->rbd_dev;
2627 stat_request->osd_req = rbd_osd_req_create(rbd_dev, false,
2629 if (!stat_request->osd_req)
2631 stat_request->callback = rbd_img_obj_exists_callback;
2633 osd_req_op_init(stat_request->osd_req, 0, CEPH_OSD_OP_STAT);
2634 osd_req_op_raw_data_in_pages(stat_request->osd_req, 0, pages, size, 0,
2636 rbd_osd_req_format_read(stat_request);
2638 osdc = &rbd_dev->rbd_client->client->osdc;
2639 ret = rbd_obj_request_submit(osdc, stat_request);
2642 rbd_obj_request_put(obj_request);
2647 static int rbd_img_obj_request_submit(struct rbd_obj_request *obj_request)
2649 struct rbd_img_request *img_request;
2650 struct rbd_device *rbd_dev;
2653 rbd_assert(obj_request_img_data_test(obj_request));
2655 img_request = obj_request->img_request;
2656 rbd_assert(img_request);
2657 rbd_dev = img_request->rbd_dev;
2660 * Only writes to layered images need special handling.
2661 * Reads and non-layered writes are simple object requests.
2662 * Layered writes that start beyond the end of the overlap
2663 * with the parent have no parent data, so they too are
2664 * simple object requests. Finally, if the target object is
2665 * known to already exist, its parent data has already been
2666 * copied, so a write to the object can also be handled as a
2667 * simple object request.
2669 if (!img_request_write_test(img_request) ||
2670 !img_request_layered_test(img_request) ||
2671 rbd_dev->parent_overlap <= obj_request->img_offset ||
2672 ((known = obj_request_known_test(obj_request)) &&
2673 obj_request_exists_test(obj_request))) {
2675 struct rbd_device *rbd_dev;
2676 struct ceph_osd_client *osdc;
2678 rbd_dev = obj_request->img_request->rbd_dev;
2679 osdc = &rbd_dev->rbd_client->client->osdc;
2681 return rbd_obj_request_submit(osdc, obj_request);
2685 * It's a layered write. The target object might exist but
2686 * we may not know that yet. If we know it doesn't exist,
2687 * start by reading the data for the full target object from
2688 * the parent so we can use it for a copyup to the target.
2691 return rbd_img_obj_parent_read_full(obj_request);
2693 /* We don't know whether the target exists. Go find out. */
2695 return rbd_img_obj_exists_submit(obj_request);
2698 static int rbd_img_request_submit(struct rbd_img_request *img_request)
2700 struct rbd_obj_request *obj_request;
2701 struct rbd_obj_request *next_obj_request;
2703 dout("%s: img %p\n", __func__, img_request);
2704 for_each_obj_request_safe(img_request, obj_request, next_obj_request) {
2707 ret = rbd_img_obj_request_submit(obj_request);
2715 static void rbd_img_parent_read_callback(struct rbd_img_request *img_request)
2717 struct rbd_obj_request *obj_request;
2718 struct rbd_device *rbd_dev;
2723 rbd_assert(img_request_child_test(img_request));
2725 /* First get what we need from the image request and release it */
2727 obj_request = img_request->obj_request;
2728 img_xferred = img_request->xferred;
2729 img_result = img_request->result;
2730 rbd_img_request_put(img_request);
2733 * If the overlap has become 0 (most likely because the
2734 * image has been flattened) we need to re-submit the
2737 rbd_assert(obj_request);
2738 rbd_assert(obj_request->img_request);
2739 rbd_dev = obj_request->img_request->rbd_dev;
2740 if (!rbd_dev->parent_overlap) {
2741 struct ceph_osd_client *osdc;
2743 osdc = &rbd_dev->rbd_client->client->osdc;
2744 img_result = rbd_obj_request_submit(osdc, obj_request);
2749 obj_request->result = img_result;
2750 if (obj_request->result)
2754 * We need to zero anything beyond the parent overlap
2755 * boundary. Since rbd_img_obj_request_read_callback()
2756 * will zero anything beyond the end of a short read, an
2757 * easy way to do this is to pretend the data from the
2758 * parent came up short--ending at the overlap boundary.
2760 rbd_assert(obj_request->img_offset < U64_MAX - obj_request->length);
2761 obj_end = obj_request->img_offset + obj_request->length;
2762 if (obj_end > rbd_dev->parent_overlap) {
2765 if (obj_request->img_offset < rbd_dev->parent_overlap)
2766 xferred = rbd_dev->parent_overlap -
2767 obj_request->img_offset;
2769 obj_request->xferred = min(img_xferred, xferred);
2771 obj_request->xferred = img_xferred;
2774 rbd_img_obj_request_read_callback(obj_request);
2775 rbd_obj_request_complete(obj_request);
2778 static void rbd_img_parent_read(struct rbd_obj_request *obj_request)
2780 struct rbd_img_request *img_request;
2783 rbd_assert(obj_request_img_data_test(obj_request));
2784 rbd_assert(obj_request->img_request != NULL);
2785 rbd_assert(obj_request->result == (s32) -ENOENT);
2786 rbd_assert(obj_request_type_valid(obj_request->type));
2788 /* rbd_read_finish(obj_request, obj_request->length); */
2789 img_request = rbd_parent_request_create(obj_request,
2790 obj_request->img_offset,
2791 obj_request->length);
2796 if (obj_request->type == OBJ_REQUEST_BIO)
2797 result = rbd_img_request_fill(img_request, OBJ_REQUEST_BIO,
2798 obj_request->bio_list);
2800 result = rbd_img_request_fill(img_request, OBJ_REQUEST_PAGES,
2801 obj_request->pages);
2805 img_request->callback = rbd_img_parent_read_callback;
2806 result = rbd_img_request_submit(img_request);
2813 rbd_img_request_put(img_request);
2814 obj_request->result = result;
2815 obj_request->xferred = 0;
2816 obj_request_done_set(obj_request);
2819 static int rbd_obj_notify_ack(struct rbd_device *rbd_dev, u64 notify_id)
2821 struct rbd_obj_request *obj_request;
2822 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
2825 obj_request = rbd_obj_request_create(rbd_dev->header_name, 0, 0,
2826 OBJ_REQUEST_NODATA);
2831 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false, obj_request);
2832 if (!obj_request->osd_req)
2834 obj_request->callback = rbd_obj_request_put;
2836 osd_req_op_watch_init(obj_request->osd_req, 0, CEPH_OSD_OP_NOTIFY_ACK,
2838 rbd_osd_req_format_read(obj_request);
2840 ret = rbd_obj_request_submit(osdc, obj_request);
2843 rbd_obj_request_put(obj_request);
2848 static void rbd_watch_cb(u64 ver, u64 notify_id, u8 opcode, void *data)
2850 struct rbd_device *rbd_dev = (struct rbd_device *)data;
2856 dout("%s: \"%s\" notify_id %llu opcode %u\n", __func__,
2857 rbd_dev->header_name, (unsigned long long)notify_id,
2858 (unsigned int)opcode);
2859 ret = rbd_dev_refresh(rbd_dev);
2861 rbd_warn(rbd_dev, ": header refresh error (%d)\n", ret);
2863 rbd_obj_notify_ack(rbd_dev, notify_id);
2867 * Request sync osd watch/unwatch. The value of "start" determines
2868 * whether a watch request is being initiated or torn down.
2870 static int rbd_dev_header_watch_sync(struct rbd_device *rbd_dev, bool start)
2872 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
2873 struct rbd_obj_request *obj_request;
2876 rbd_assert(start ^ !!rbd_dev->watch_event);
2877 rbd_assert(start ^ !!rbd_dev->watch_request);
2880 ret = ceph_osdc_create_event(osdc, rbd_watch_cb, rbd_dev,
2881 &rbd_dev->watch_event);
2884 rbd_assert(rbd_dev->watch_event != NULL);
2888 obj_request = rbd_obj_request_create(rbd_dev->header_name, 0, 0,
2889 OBJ_REQUEST_NODATA);
2893 obj_request->osd_req = rbd_osd_req_create(rbd_dev, true, obj_request);
2894 if (!obj_request->osd_req)
2898 ceph_osdc_set_request_linger(osdc, obj_request->osd_req);
2900 ceph_osdc_unregister_linger_request(osdc,
2901 rbd_dev->watch_request->osd_req);
2903 osd_req_op_watch_init(obj_request->osd_req, 0, CEPH_OSD_OP_WATCH,
2904 rbd_dev->watch_event->cookie, 0, start ? 1 : 0);
2905 rbd_osd_req_format_write(obj_request);
2907 ret = rbd_obj_request_submit(osdc, obj_request);
2910 ret = rbd_obj_request_wait(obj_request);
2913 ret = obj_request->result;
2918 * A watch request is set to linger, so the underlying osd
2919 * request won't go away until we unregister it. We retain
2920 * a pointer to the object request during that time (in
2921 * rbd_dev->watch_request), so we'll keep a reference to
2922 * it. We'll drop that reference (below) after we've
2926 rbd_dev->watch_request = obj_request;
2931 /* We have successfully torn down the watch request */
2933 rbd_obj_request_put(rbd_dev->watch_request);
2934 rbd_dev->watch_request = NULL;
2936 /* Cancel the event if we're tearing down, or on error */
2937 ceph_osdc_cancel_event(rbd_dev->watch_event);
2938 rbd_dev->watch_event = NULL;
2940 rbd_obj_request_put(obj_request);
2946 * Synchronous osd object method call. Returns the number of bytes
2947 * returned in the outbound buffer, or a negative error code.
2949 static int rbd_obj_method_sync(struct rbd_device *rbd_dev,
2950 const char *object_name,
2951 const char *class_name,
2952 const char *method_name,
2953 const void *outbound,
2954 size_t outbound_size,
2956 size_t inbound_size)
2958 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
2959 struct rbd_obj_request *obj_request;
2960 struct page **pages;
2965 * Method calls are ultimately read operations. The result
2966 * should placed into the inbound buffer provided. They
2967 * also supply outbound data--parameters for the object
2968 * method. Currently if this is present it will be a
2971 page_count = (u32)calc_pages_for(0, inbound_size);
2972 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2974 return PTR_ERR(pages);
2977 obj_request = rbd_obj_request_create(object_name, 0, inbound_size,
2982 obj_request->pages = pages;
2983 obj_request->page_count = page_count;
2985 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false, obj_request);
2986 if (!obj_request->osd_req)
2989 osd_req_op_cls_init(obj_request->osd_req, 0, CEPH_OSD_OP_CALL,
2990 class_name, method_name);
2991 if (outbound_size) {
2992 struct ceph_pagelist *pagelist;
2994 pagelist = kmalloc(sizeof (*pagelist), GFP_NOFS);
2998 ceph_pagelist_init(pagelist);
2999 ceph_pagelist_append(pagelist, outbound, outbound_size);
3000 osd_req_op_cls_request_data_pagelist(obj_request->osd_req, 0,
3003 osd_req_op_cls_response_data_pages(obj_request->osd_req, 0,
3004 obj_request->pages, inbound_size,
3006 rbd_osd_req_format_read(obj_request);
3008 ret = rbd_obj_request_submit(osdc, obj_request);
3011 ret = rbd_obj_request_wait(obj_request);
3015 ret = obj_request->result;
3019 rbd_assert(obj_request->xferred < (u64)INT_MAX);
3020 ret = (int)obj_request->xferred;
3021 ceph_copy_from_page_vector(pages, inbound, 0, obj_request->xferred);
3024 rbd_obj_request_put(obj_request);
3026 ceph_release_page_vector(pages, page_count);
3031 static void rbd_request_fn(struct request_queue *q)
3032 __releases(q->queue_lock) __acquires(q->queue_lock)
3034 struct rbd_device *rbd_dev = q->queuedata;
3035 bool read_only = rbd_dev->mapping.read_only;
3039 while ((rq = blk_fetch_request(q))) {
3040 bool write_request = rq_data_dir(rq) == WRITE;
3041 struct rbd_img_request *img_request;
3045 /* Ignore any non-FS requests that filter through. */
3047 if (rq->cmd_type != REQ_TYPE_FS) {
3048 dout("%s: non-fs request type %d\n", __func__,
3049 (int) rq->cmd_type);
3050 __blk_end_request_all(rq, 0);
3054 /* Ignore/skip any zero-length requests */
3056 offset = (u64) blk_rq_pos(rq) << SECTOR_SHIFT;
3057 length = (u64) blk_rq_bytes(rq);
3060 dout("%s: zero-length request\n", __func__);
3061 __blk_end_request_all(rq, 0);
3065 spin_unlock_irq(q->queue_lock);
3067 /* Disallow writes to a read-only device */
3069 if (write_request) {
3073 rbd_assert(rbd_dev->spec->snap_id == CEPH_NOSNAP);
3077 * Quit early if the mapped snapshot no longer
3078 * exists. It's still possible the snapshot will
3079 * have disappeared by the time our request arrives
3080 * at the osd, but there's no sense in sending it if
3083 if (!test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags)) {
3084 dout("request for non-existent snapshot");
3085 rbd_assert(rbd_dev->spec->snap_id != CEPH_NOSNAP);
3091 if (offset && length > U64_MAX - offset + 1) {
3092 rbd_warn(rbd_dev, "bad request range (%llu~%llu)\n",
3094 goto end_request; /* Shouldn't happen */
3098 if (offset + length > rbd_dev->mapping.size) {
3099 rbd_warn(rbd_dev, "beyond EOD (%llu~%llu > %llu)\n",
3100 offset, length, rbd_dev->mapping.size);
3105 img_request = rbd_img_request_create(rbd_dev, offset, length,
3110 img_request->rq = rq;
3112 result = rbd_img_request_fill(img_request, OBJ_REQUEST_BIO,
3115 result = rbd_img_request_submit(img_request);
3117 rbd_img_request_put(img_request);
3119 spin_lock_irq(q->queue_lock);
3121 rbd_warn(rbd_dev, "%s %llx at %llx result %d\n",
3122 write_request ? "write" : "read",
3123 length, offset, result);
3125 __blk_end_request_all(rq, result);
3131 * a queue callback. Makes sure that we don't create a bio that spans across
3132 * multiple osd objects. One exception would be with a single page bios,
3133 * which we handle later at bio_chain_clone_range()
3135 static int rbd_merge_bvec(struct request_queue *q, struct bvec_merge_data *bmd,
3136 struct bio_vec *bvec)
3138 struct rbd_device *rbd_dev = q->queuedata;
3139 sector_t sector_offset;
3140 sector_t sectors_per_obj;
3141 sector_t obj_sector_offset;
3145 * Find how far into its rbd object the partition-relative
3146 * bio start sector is to offset relative to the enclosing
3149 sector_offset = get_start_sect(bmd->bi_bdev) + bmd->bi_sector;
3150 sectors_per_obj = 1 << (rbd_dev->header.obj_order - SECTOR_SHIFT);
3151 obj_sector_offset = sector_offset & (sectors_per_obj - 1);
3154 * Compute the number of bytes from that offset to the end
3155 * of the object. Account for what's already used by the bio.
3157 ret = (int) (sectors_per_obj - obj_sector_offset) << SECTOR_SHIFT;
3158 if (ret > bmd->bi_size)
3159 ret -= bmd->bi_size;
3164 * Don't send back more than was asked for. And if the bio
3165 * was empty, let the whole thing through because: "Note
3166 * that a block device *must* allow a single page to be
3167 * added to an empty bio."
3169 rbd_assert(bvec->bv_len <= PAGE_SIZE);
3170 if (ret > (int) bvec->bv_len || !bmd->bi_size)
3171 ret = (int) bvec->bv_len;
3176 static void rbd_free_disk(struct rbd_device *rbd_dev)
3178 struct gendisk *disk = rbd_dev->disk;
3183 rbd_dev->disk = NULL;
3184 if (disk->flags & GENHD_FL_UP) {
3187 blk_cleanup_queue(disk->queue);
3192 static int rbd_obj_read_sync(struct rbd_device *rbd_dev,
3193 const char *object_name,
3194 u64 offset, u64 length, void *buf)
3197 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3198 struct rbd_obj_request *obj_request;
3199 struct page **pages = NULL;
3204 page_count = (u32) calc_pages_for(offset, length);
3205 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
3207 ret = PTR_ERR(pages);
3210 obj_request = rbd_obj_request_create(object_name, offset, length,
3215 obj_request->pages = pages;
3216 obj_request->page_count = page_count;
3218 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false, obj_request);
3219 if (!obj_request->osd_req)
3222 osd_req_op_extent_init(obj_request->osd_req, 0, CEPH_OSD_OP_READ,
3223 offset, length, 0, 0);
3224 osd_req_op_extent_osd_data_pages(obj_request->osd_req, 0,
3226 obj_request->length,
3227 obj_request->offset & ~PAGE_MASK,
3229 rbd_osd_req_format_read(obj_request);
3231 ret = rbd_obj_request_submit(osdc, obj_request);
3234 ret = rbd_obj_request_wait(obj_request);
3238 ret = obj_request->result;
3242 rbd_assert(obj_request->xferred <= (u64) SIZE_MAX);
3243 size = (size_t) obj_request->xferred;
3244 ceph_copy_from_page_vector(pages, buf, 0, size);
3245 rbd_assert(size <= (size_t)INT_MAX);
3249 rbd_obj_request_put(obj_request);
3251 ceph_release_page_vector(pages, page_count);
3257 * Read the complete header for the given rbd device. On successful
3258 * return, the rbd_dev->header field will contain up-to-date
3259 * information about the image.
3261 static int rbd_dev_v1_header_info(struct rbd_device *rbd_dev)
3263 struct rbd_image_header_ondisk *ondisk = NULL;
3270 * The complete header will include an array of its 64-bit
3271 * snapshot ids, followed by the names of those snapshots as
3272 * a contiguous block of NUL-terminated strings. Note that
3273 * the number of snapshots could change by the time we read
3274 * it in, in which case we re-read it.
3281 size = sizeof (*ondisk);
3282 size += snap_count * sizeof (struct rbd_image_snap_ondisk);
3284 ondisk = kmalloc(size, GFP_KERNEL);
3288 ret = rbd_obj_read_sync(rbd_dev, rbd_dev->header_name,
3292 if ((size_t)ret < size) {
3294 rbd_warn(rbd_dev, "short header read (want %zd got %d)",
3298 if (!rbd_dev_ondisk_valid(ondisk)) {
3300 rbd_warn(rbd_dev, "invalid header");
3304 names_size = le64_to_cpu(ondisk->snap_names_len);
3305 want_count = snap_count;
3306 snap_count = le32_to_cpu(ondisk->snap_count);
3307 } while (snap_count != want_count);
3309 ret = rbd_header_from_disk(rbd_dev, ondisk);
3317 * Clear the rbd device's EXISTS flag if the snapshot it's mapped to
3318 * has disappeared from the (just updated) snapshot context.
3320 static void rbd_exists_validate(struct rbd_device *rbd_dev)
3324 if (!test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags))
3327 snap_id = rbd_dev->spec->snap_id;
3328 if (snap_id == CEPH_NOSNAP)
3331 if (rbd_dev_snap_index(rbd_dev, snap_id) == BAD_SNAP_INDEX)
3332 clear_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
3335 static int rbd_dev_refresh(struct rbd_device *rbd_dev)
3340 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
3341 mapping_size = rbd_dev->mapping.size;
3342 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
3343 if (rbd_dev->image_format == 1)
3344 ret = rbd_dev_v1_header_info(rbd_dev);
3346 ret = rbd_dev_v2_header_info(rbd_dev);
3348 /* If it's a mapped snapshot, validate its EXISTS flag */
3350 rbd_exists_validate(rbd_dev);
3351 mutex_unlock(&ctl_mutex);
3352 if (mapping_size != rbd_dev->mapping.size) {
3355 size = (sector_t)rbd_dev->mapping.size / SECTOR_SIZE;
3356 dout("setting size to %llu sectors", (unsigned long long)size);
3357 set_capacity(rbd_dev->disk, size);
3358 revalidate_disk(rbd_dev->disk);
3364 static int rbd_init_disk(struct rbd_device *rbd_dev)
3366 struct gendisk *disk;
3367 struct request_queue *q;
3370 /* create gendisk info */
3371 disk = alloc_disk(RBD_MINORS_PER_MAJOR);
3375 snprintf(disk->disk_name, sizeof(disk->disk_name), RBD_DRV_NAME "%d",
3377 disk->major = rbd_dev->major;
3378 disk->first_minor = 0;
3379 disk->fops = &rbd_bd_ops;
3380 disk->private_data = rbd_dev;
3382 q = blk_init_queue(rbd_request_fn, &rbd_dev->lock);
3386 /* We use the default size, but let's be explicit about it. */
3387 blk_queue_physical_block_size(q, SECTOR_SIZE);
3389 /* set io sizes to object size */
3390 segment_size = rbd_obj_bytes(&rbd_dev->header);
3391 blk_queue_max_hw_sectors(q, segment_size / SECTOR_SIZE);
3392 blk_queue_max_segment_size(q, segment_size);
3393 blk_queue_io_min(q, segment_size);
3394 blk_queue_io_opt(q, segment_size);
3396 blk_queue_merge_bvec(q, rbd_merge_bvec);
3399 q->queuedata = rbd_dev;
3401 rbd_dev->disk = disk;
3414 static struct rbd_device *dev_to_rbd_dev(struct device *dev)
3416 return container_of(dev, struct rbd_device, dev);
3419 static ssize_t rbd_size_show(struct device *dev,
3420 struct device_attribute *attr, char *buf)
3422 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3424 return sprintf(buf, "%llu\n",
3425 (unsigned long long)rbd_dev->mapping.size);
3429 * Note this shows the features for whatever's mapped, which is not
3430 * necessarily the base image.
3432 static ssize_t rbd_features_show(struct device *dev,
3433 struct device_attribute *attr, char *buf)
3435 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3437 return sprintf(buf, "0x%016llx\n",
3438 (unsigned long long)rbd_dev->mapping.features);
3441 static ssize_t rbd_major_show(struct device *dev,
3442 struct device_attribute *attr, char *buf)
3444 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3447 return sprintf(buf, "%d\n", rbd_dev->major);
3449 return sprintf(buf, "(none)\n");
3453 static ssize_t rbd_client_id_show(struct device *dev,
3454 struct device_attribute *attr, char *buf)
3456 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3458 return sprintf(buf, "client%lld\n",
3459 ceph_client_id(rbd_dev->rbd_client->client));
3462 static ssize_t rbd_pool_show(struct device *dev,
3463 struct device_attribute *attr, char *buf)
3465 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3467 return sprintf(buf, "%s\n", rbd_dev->spec->pool_name);
3470 static ssize_t rbd_pool_id_show(struct device *dev,
3471 struct device_attribute *attr, char *buf)
3473 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3475 return sprintf(buf, "%llu\n",
3476 (unsigned long long) rbd_dev->spec->pool_id);
3479 static ssize_t rbd_name_show(struct device *dev,
3480 struct device_attribute *attr, char *buf)
3482 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3484 if (rbd_dev->spec->image_name)
3485 return sprintf(buf, "%s\n", rbd_dev->spec->image_name);
3487 return sprintf(buf, "(unknown)\n");
3490 static ssize_t rbd_image_id_show(struct device *dev,
3491 struct device_attribute *attr, char *buf)
3493 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3495 return sprintf(buf, "%s\n", rbd_dev->spec->image_id);
3499 * Shows the name of the currently-mapped snapshot (or
3500 * RBD_SNAP_HEAD_NAME for the base image).
3502 static ssize_t rbd_snap_show(struct device *dev,
3503 struct device_attribute *attr,
3506 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3508 return sprintf(buf, "%s\n", rbd_dev->spec->snap_name);
3512 * For an rbd v2 image, shows the pool id, image id, and snapshot id
3513 * for the parent image. If there is no parent, simply shows
3514 * "(no parent image)".
3516 static ssize_t rbd_parent_show(struct device *dev,
3517 struct device_attribute *attr,
3520 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3521 struct rbd_spec *spec = rbd_dev->parent_spec;
3526 return sprintf(buf, "(no parent image)\n");
3528 count = sprintf(bufp, "pool_id %llu\npool_name %s\n",
3529 (unsigned long long) spec->pool_id, spec->pool_name);
3534 count = sprintf(bufp, "image_id %s\nimage_name %s\n", spec->image_id,
3535 spec->image_name ? spec->image_name : "(unknown)");
3540 count = sprintf(bufp, "snap_id %llu\nsnap_name %s\n",
3541 (unsigned long long) spec->snap_id, spec->snap_name);
3546 count = sprintf(bufp, "overlap %llu\n", rbd_dev->parent_overlap);
3551 return (ssize_t) (bufp - buf);
3554 static ssize_t rbd_image_refresh(struct device *dev,
3555 struct device_attribute *attr,
3559 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3562 ret = rbd_dev_refresh(rbd_dev);
3564 rbd_warn(rbd_dev, ": manual header refresh error (%d)\n", ret);
3566 return ret < 0 ? ret : size;
3569 static DEVICE_ATTR(size, S_IRUGO, rbd_size_show, NULL);
3570 static DEVICE_ATTR(features, S_IRUGO, rbd_features_show, NULL);
3571 static DEVICE_ATTR(major, S_IRUGO, rbd_major_show, NULL);
3572 static DEVICE_ATTR(client_id, S_IRUGO, rbd_client_id_show, NULL);
3573 static DEVICE_ATTR(pool, S_IRUGO, rbd_pool_show, NULL);
3574 static DEVICE_ATTR(pool_id, S_IRUGO, rbd_pool_id_show, NULL);
3575 static DEVICE_ATTR(name, S_IRUGO, rbd_name_show, NULL);
3576 static DEVICE_ATTR(image_id, S_IRUGO, rbd_image_id_show, NULL);
3577 static DEVICE_ATTR(refresh, S_IWUSR, NULL, rbd_image_refresh);
3578 static DEVICE_ATTR(current_snap, S_IRUGO, rbd_snap_show, NULL);
3579 static DEVICE_ATTR(parent, S_IRUGO, rbd_parent_show, NULL);
3581 static struct attribute *rbd_attrs[] = {
3582 &dev_attr_size.attr,
3583 &dev_attr_features.attr,
3584 &dev_attr_major.attr,
3585 &dev_attr_client_id.attr,
3586 &dev_attr_pool.attr,
3587 &dev_attr_pool_id.attr,
3588 &dev_attr_name.attr,
3589 &dev_attr_image_id.attr,
3590 &dev_attr_current_snap.attr,
3591 &dev_attr_parent.attr,
3592 &dev_attr_refresh.attr,
3596 static struct attribute_group rbd_attr_group = {
3600 static const struct attribute_group *rbd_attr_groups[] = {
3605 static void rbd_sysfs_dev_release(struct device *dev)
3609 static struct device_type rbd_device_type = {
3611 .groups = rbd_attr_groups,
3612 .release = rbd_sysfs_dev_release,
3615 static struct rbd_spec *rbd_spec_get(struct rbd_spec *spec)
3617 kref_get(&spec->kref);
3622 static void rbd_spec_free(struct kref *kref);
3623 static void rbd_spec_put(struct rbd_spec *spec)
3626 kref_put(&spec->kref, rbd_spec_free);
3629 static struct rbd_spec *rbd_spec_alloc(void)
3631 struct rbd_spec *spec;
3633 spec = kzalloc(sizeof (*spec), GFP_KERNEL);
3636 kref_init(&spec->kref);
3641 static void rbd_spec_free(struct kref *kref)
3643 struct rbd_spec *spec = container_of(kref, struct rbd_spec, kref);
3645 kfree(spec->pool_name);
3646 kfree(spec->image_id);
3647 kfree(spec->image_name);
3648 kfree(spec->snap_name);
3652 static struct rbd_device *rbd_dev_create(struct rbd_client *rbdc,
3653 struct rbd_spec *spec)
3655 struct rbd_device *rbd_dev;
3657 rbd_dev = kzalloc(sizeof (*rbd_dev), GFP_KERNEL);
3661 spin_lock_init(&rbd_dev->lock);
3663 atomic_set(&rbd_dev->parent_ref, 0);
3664 INIT_LIST_HEAD(&rbd_dev->node);
3665 init_rwsem(&rbd_dev->header_rwsem);
3667 rbd_dev->spec = spec;
3668 rbd_dev->rbd_client = rbdc;
3670 /* Initialize the layout used for all rbd requests */
3672 rbd_dev->layout.fl_stripe_unit = cpu_to_le32(1 << RBD_MAX_OBJ_ORDER);
3673 rbd_dev->layout.fl_stripe_count = cpu_to_le32(1);
3674 rbd_dev->layout.fl_object_size = cpu_to_le32(1 << RBD_MAX_OBJ_ORDER);
3675 rbd_dev->layout.fl_pg_pool = cpu_to_le32((u32) spec->pool_id);
3680 static void rbd_dev_destroy(struct rbd_device *rbd_dev)
3682 rbd_put_client(rbd_dev->rbd_client);
3683 rbd_spec_put(rbd_dev->spec);
3688 * Get the size and object order for an image snapshot, or if
3689 * snap_id is CEPH_NOSNAP, gets this information for the base
3692 static int _rbd_dev_v2_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
3693 u8 *order, u64 *snap_size)
3695 __le64 snapid = cpu_to_le64(snap_id);
3700 } __attribute__ ((packed)) size_buf = { 0 };
3702 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
3704 &snapid, sizeof (snapid),
3705 &size_buf, sizeof (size_buf));
3706 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
3709 if (ret < sizeof (size_buf))
3713 *order = size_buf.order;
3714 *snap_size = le64_to_cpu(size_buf.size);
3716 dout(" snap_id 0x%016llx order = %u, snap_size = %llu\n",
3717 (unsigned long long)snap_id, (unsigned int)*order,
3718 (unsigned long long)*snap_size);
3723 static int rbd_dev_v2_image_size(struct rbd_device *rbd_dev)
3725 return _rbd_dev_v2_snap_size(rbd_dev, CEPH_NOSNAP,
3726 &rbd_dev->header.obj_order,
3727 &rbd_dev->header.image_size);
3730 static int rbd_dev_v2_object_prefix(struct rbd_device *rbd_dev)
3736 reply_buf = kzalloc(RBD_OBJ_PREFIX_LEN_MAX, GFP_KERNEL);
3740 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
3741 "rbd", "get_object_prefix", NULL, 0,
3742 reply_buf, RBD_OBJ_PREFIX_LEN_MAX);
3743 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
3748 rbd_dev->header.object_prefix = ceph_extract_encoded_string(&p,
3749 p + ret, NULL, GFP_NOIO);
3752 if (IS_ERR(rbd_dev->header.object_prefix)) {
3753 ret = PTR_ERR(rbd_dev->header.object_prefix);
3754 rbd_dev->header.object_prefix = NULL;
3756 dout(" object_prefix = %s\n", rbd_dev->header.object_prefix);
3764 static int _rbd_dev_v2_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
3767 __le64 snapid = cpu_to_le64(snap_id);
3771 } __attribute__ ((packed)) features_buf = { 0 };
3775 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
3776 "rbd", "get_features",
3777 &snapid, sizeof (snapid),
3778 &features_buf, sizeof (features_buf));
3779 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
3782 if (ret < sizeof (features_buf))
3785 incompat = le64_to_cpu(features_buf.incompat);
3786 if (incompat & ~RBD_FEATURES_SUPPORTED)
3789 *snap_features = le64_to_cpu(features_buf.features);
3791 dout(" snap_id 0x%016llx features = 0x%016llx incompat = 0x%016llx\n",
3792 (unsigned long long)snap_id,
3793 (unsigned long long)*snap_features,
3794 (unsigned long long)le64_to_cpu(features_buf.incompat));
3799 static int rbd_dev_v2_features(struct rbd_device *rbd_dev)
3801 return _rbd_dev_v2_snap_features(rbd_dev, CEPH_NOSNAP,
3802 &rbd_dev->header.features);
3805 static int rbd_dev_v2_parent_info(struct rbd_device *rbd_dev)
3807 struct rbd_spec *parent_spec;
3809 void *reply_buf = NULL;
3818 parent_spec = rbd_spec_alloc();
3822 size = sizeof (__le64) + /* pool_id */
3823 sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX + /* image_id */
3824 sizeof (__le64) + /* snap_id */
3825 sizeof (__le64); /* overlap */
3826 reply_buf = kmalloc(size, GFP_KERNEL);
3832 snapid = cpu_to_le64(CEPH_NOSNAP);
3833 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
3834 "rbd", "get_parent",
3835 &snapid, sizeof (snapid),
3837 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
3842 end = reply_buf + ret;
3844 ceph_decode_64_safe(&p, end, pool_id, out_err);
3845 if (pool_id == CEPH_NOPOOL) {
3847 * Either the parent never existed, or we have
3848 * record of it but the image got flattened so it no
3849 * longer has a parent. When the parent of a
3850 * layered image disappears we immediately set the
3851 * overlap to 0. The effect of this is that all new
3852 * requests will be treated as if the image had no
3855 if (rbd_dev->parent_overlap) {
3856 rbd_dev->parent_overlap = 0;
3858 rbd_dev_parent_put(rbd_dev);
3859 pr_info("%s: clone image has been flattened\n",
3860 rbd_dev->disk->disk_name);
3863 goto out; /* No parent? No problem. */
3866 /* The ceph file layout needs to fit pool id in 32 bits */
3869 if (pool_id > (u64)U32_MAX) {
3870 rbd_warn(NULL, "parent pool id too large (%llu > %u)\n",
3871 (unsigned long long)pool_id, U32_MAX);
3874 parent_spec->pool_id = pool_id;
3876 image_id = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
3877 if (IS_ERR(image_id)) {
3878 ret = PTR_ERR(image_id);
3881 parent_spec->image_id = image_id;
3882 ceph_decode_64_safe(&p, end, parent_spec->snap_id, out_err);
3883 ceph_decode_64_safe(&p, end, overlap, out_err);
3886 rbd_spec_put(rbd_dev->parent_spec);
3887 rbd_dev->parent_spec = parent_spec;
3888 parent_spec = NULL; /* rbd_dev now owns this */
3889 rbd_dev->parent_overlap = overlap;
3891 rbd_warn(rbd_dev, "ignoring parent of clone with overlap 0\n");
3897 rbd_spec_put(parent_spec);
3902 static int rbd_dev_v2_striping_info(struct rbd_device *rbd_dev)
3906 __le64 stripe_count;
3907 } __attribute__ ((packed)) striping_info_buf = { 0 };
3908 size_t size = sizeof (striping_info_buf);
3915 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
3916 "rbd", "get_stripe_unit_count", NULL, 0,
3917 (char *)&striping_info_buf, size);
3918 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
3925 * We don't actually support the "fancy striping" feature
3926 * (STRIPINGV2) yet, but if the striping sizes are the
3927 * defaults the behavior is the same as before. So find
3928 * out, and only fail if the image has non-default values.
3931 obj_size = (u64)1 << rbd_dev->header.obj_order;
3932 p = &striping_info_buf;
3933 stripe_unit = ceph_decode_64(&p);
3934 if (stripe_unit != obj_size) {
3935 rbd_warn(rbd_dev, "unsupported stripe unit "
3936 "(got %llu want %llu)",
3937 stripe_unit, obj_size);
3940 stripe_count = ceph_decode_64(&p);
3941 if (stripe_count != 1) {
3942 rbd_warn(rbd_dev, "unsupported stripe count "
3943 "(got %llu want 1)", stripe_count);
3946 rbd_dev->header.stripe_unit = stripe_unit;
3947 rbd_dev->header.stripe_count = stripe_count;
3952 static char *rbd_dev_image_name(struct rbd_device *rbd_dev)
3954 size_t image_id_size;
3959 void *reply_buf = NULL;
3961 char *image_name = NULL;
3964 rbd_assert(!rbd_dev->spec->image_name);
3966 len = strlen(rbd_dev->spec->image_id);
3967 image_id_size = sizeof (__le32) + len;
3968 image_id = kmalloc(image_id_size, GFP_KERNEL);
3973 end = image_id + image_id_size;
3974 ceph_encode_string(&p, end, rbd_dev->spec->image_id, (u32)len);
3976 size = sizeof (__le32) + RBD_IMAGE_NAME_LEN_MAX;
3977 reply_buf = kmalloc(size, GFP_KERNEL);
3981 ret = rbd_obj_method_sync(rbd_dev, RBD_DIRECTORY,
3982 "rbd", "dir_get_name",
3983 image_id, image_id_size,
3988 end = reply_buf + ret;
3990 image_name = ceph_extract_encoded_string(&p, end, &len, GFP_KERNEL);
3991 if (IS_ERR(image_name))
3994 dout("%s: name is %s len is %zd\n", __func__, image_name, len);
4002 static u64 rbd_v1_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
4004 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
4005 const char *snap_name;
4008 /* Skip over names until we find the one we are looking for */
4010 snap_name = rbd_dev->header.snap_names;
4011 while (which < snapc->num_snaps) {
4012 if (!strcmp(name, snap_name))
4013 return snapc->snaps[which];
4014 snap_name += strlen(snap_name) + 1;
4020 static u64 rbd_v2_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
4022 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
4027 for (which = 0; !found && which < snapc->num_snaps; which++) {
4028 const char *snap_name;
4030 snap_id = snapc->snaps[which];
4031 snap_name = rbd_dev_v2_snap_name(rbd_dev, snap_id);
4032 if (IS_ERR(snap_name))
4034 found = !strcmp(name, snap_name);
4037 return found ? snap_id : CEPH_NOSNAP;
4041 * Assumes name is never RBD_SNAP_HEAD_NAME; returns CEPH_NOSNAP if
4042 * no snapshot by that name is found, or if an error occurs.
4044 static u64 rbd_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
4046 if (rbd_dev->image_format == 1)
4047 return rbd_v1_snap_id_by_name(rbd_dev, name);
4049 return rbd_v2_snap_id_by_name(rbd_dev, name);
4053 * When an rbd image has a parent image, it is identified by the
4054 * pool, image, and snapshot ids (not names). This function fills
4055 * in the names for those ids. (It's OK if we can't figure out the
4056 * name for an image id, but the pool and snapshot ids should always
4057 * exist and have names.) All names in an rbd spec are dynamically
4060 * When an image being mapped (not a parent) is probed, we have the
4061 * pool name and pool id, image name and image id, and the snapshot
4062 * name. The only thing we're missing is the snapshot id.
4064 static int rbd_dev_spec_update(struct rbd_device *rbd_dev)
4066 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
4067 struct rbd_spec *spec = rbd_dev->spec;
4068 const char *pool_name;
4069 const char *image_name;
4070 const char *snap_name;
4074 * An image being mapped will have the pool name (etc.), but
4075 * we need to look up the snapshot id.
4077 if (spec->pool_name) {
4078 if (strcmp(spec->snap_name, RBD_SNAP_HEAD_NAME)) {
4081 snap_id = rbd_snap_id_by_name(rbd_dev, spec->snap_name);
4082 if (snap_id == CEPH_NOSNAP)
4084 spec->snap_id = snap_id;
4086 spec->snap_id = CEPH_NOSNAP;
4092 /* Get the pool name; we have to make our own copy of this */
4094 pool_name = ceph_pg_pool_name_by_id(osdc->osdmap, spec->pool_id);
4096 rbd_warn(rbd_dev, "no pool with id %llu", spec->pool_id);
4099 pool_name = kstrdup(pool_name, GFP_KERNEL);
4103 /* Fetch the image name; tolerate failure here */
4105 image_name = rbd_dev_image_name(rbd_dev);
4107 rbd_warn(rbd_dev, "unable to get image name");
4109 /* Look up the snapshot name, and make a copy */
4111 snap_name = rbd_snap_name(rbd_dev, spec->snap_id);
4117 spec->pool_name = pool_name;
4118 spec->image_name = image_name;
4119 spec->snap_name = snap_name;
4129 static int rbd_dev_v2_snap_context(struct rbd_device *rbd_dev)
4138 struct ceph_snap_context *snapc;
4142 * We'll need room for the seq value (maximum snapshot id),
4143 * snapshot count, and array of that many snapshot ids.
4144 * For now we have a fixed upper limit on the number we're
4145 * prepared to receive.
4147 size = sizeof (__le64) + sizeof (__le32) +
4148 RBD_MAX_SNAP_COUNT * sizeof (__le64);
4149 reply_buf = kzalloc(size, GFP_KERNEL);
4153 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
4154 "rbd", "get_snapcontext", NULL, 0,
4156 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
4161 end = reply_buf + ret;
4163 ceph_decode_64_safe(&p, end, seq, out);
4164 ceph_decode_32_safe(&p, end, snap_count, out);
4167 * Make sure the reported number of snapshot ids wouldn't go
4168 * beyond the end of our buffer. But before checking that,
4169 * make sure the computed size of the snapshot context we
4170 * allocate is representable in a size_t.
4172 if (snap_count > (SIZE_MAX - sizeof (struct ceph_snap_context))
4177 if (!ceph_has_room(&p, end, snap_count * sizeof (__le64)))
4181 snapc = ceph_create_snap_context(snap_count, GFP_KERNEL);
4187 for (i = 0; i < snap_count; i++)
4188 snapc->snaps[i] = ceph_decode_64(&p);
4190 ceph_put_snap_context(rbd_dev->header.snapc);
4191 rbd_dev->header.snapc = snapc;
4193 dout(" snap context seq = %llu, snap_count = %u\n",
4194 (unsigned long long)seq, (unsigned int)snap_count);
4201 static const char *rbd_dev_v2_snap_name(struct rbd_device *rbd_dev,
4212 size = sizeof (__le32) + RBD_MAX_SNAP_NAME_LEN;
4213 reply_buf = kmalloc(size, GFP_KERNEL);
4215 return ERR_PTR(-ENOMEM);
4217 snapid = cpu_to_le64(snap_id);
4218 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
4219 "rbd", "get_snapshot_name",
4220 &snapid, sizeof (snapid),
4222 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
4224 snap_name = ERR_PTR(ret);
4229 end = reply_buf + ret;
4230 snap_name = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
4231 if (IS_ERR(snap_name))
4234 dout(" snap_id 0x%016llx snap_name = %s\n",
4235 (unsigned long long)snap_id, snap_name);
4242 static int rbd_dev_v2_header_info(struct rbd_device *rbd_dev)
4244 bool first_time = rbd_dev->header.object_prefix == NULL;
4247 down_write(&rbd_dev->header_rwsem);
4249 ret = rbd_dev_v2_image_size(rbd_dev);
4254 ret = rbd_dev_v2_header_onetime(rbd_dev);
4260 * If the image supports layering, get the parent info. We
4261 * need to probe the first time regardless. Thereafter we
4262 * only need to if there's a parent, to see if it has
4263 * disappeared due to the mapped image getting flattened.
4265 if (rbd_dev->header.features & RBD_FEATURE_LAYERING &&
4266 (first_time || rbd_dev->parent_spec)) {
4269 ret = rbd_dev_v2_parent_info(rbd_dev);
4274 * Print a warning if this is the initial probe and
4275 * the image has a parent. Don't print it if the
4276 * image now being probed is itself a parent. We
4277 * can tell at this point because we won't know its
4278 * pool name yet (just its pool id).
4280 warn = rbd_dev->parent_spec && rbd_dev->spec->pool_name;
4281 if (first_time && warn)
4282 rbd_warn(rbd_dev, "WARNING: kernel layering "
4283 "is EXPERIMENTAL!");
4286 if (rbd_dev->spec->snap_id == CEPH_NOSNAP)
4287 if (rbd_dev->mapping.size != rbd_dev->header.image_size)
4288 rbd_dev->mapping.size = rbd_dev->header.image_size;
4290 ret = rbd_dev_v2_snap_context(rbd_dev);
4291 dout("rbd_dev_v2_snap_context returned %d\n", ret);
4293 up_write(&rbd_dev->header_rwsem);
4298 static int rbd_bus_add_dev(struct rbd_device *rbd_dev)
4303 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
4305 dev = &rbd_dev->dev;
4306 dev->bus = &rbd_bus_type;
4307 dev->type = &rbd_device_type;
4308 dev->parent = &rbd_root_dev;
4309 dev->release = rbd_dev_device_release;
4310 dev_set_name(dev, "%d", rbd_dev->dev_id);
4311 ret = device_register(dev);
4313 mutex_unlock(&ctl_mutex);
4318 static void rbd_bus_del_dev(struct rbd_device *rbd_dev)
4320 device_unregister(&rbd_dev->dev);
4323 static atomic64_t rbd_dev_id_max = ATOMIC64_INIT(0);
4326 * Get a unique rbd identifier for the given new rbd_dev, and add
4327 * the rbd_dev to the global list. The minimum rbd id is 1.
4329 static void rbd_dev_id_get(struct rbd_device *rbd_dev)
4331 rbd_dev->dev_id = atomic64_inc_return(&rbd_dev_id_max);
4333 spin_lock(&rbd_dev_list_lock);
4334 list_add_tail(&rbd_dev->node, &rbd_dev_list);
4335 spin_unlock(&rbd_dev_list_lock);
4336 dout("rbd_dev %p given dev id %llu\n", rbd_dev,
4337 (unsigned long long) rbd_dev->dev_id);
4341 * Remove an rbd_dev from the global list, and record that its
4342 * identifier is no longer in use.
4344 static void rbd_dev_id_put(struct rbd_device *rbd_dev)
4346 struct list_head *tmp;
4347 int rbd_id = rbd_dev->dev_id;
4350 rbd_assert(rbd_id > 0);
4352 dout("rbd_dev %p released dev id %llu\n", rbd_dev,
4353 (unsigned long long) rbd_dev->dev_id);
4354 spin_lock(&rbd_dev_list_lock);
4355 list_del_init(&rbd_dev->node);
4358 * If the id being "put" is not the current maximum, there
4359 * is nothing special we need to do.
4361 if (rbd_id != atomic64_read(&rbd_dev_id_max)) {
4362 spin_unlock(&rbd_dev_list_lock);
4367 * We need to update the current maximum id. Search the
4368 * list to find out what it is. We're more likely to find
4369 * the maximum at the end, so search the list backward.
4372 list_for_each_prev(tmp, &rbd_dev_list) {
4373 struct rbd_device *rbd_dev;
4375 rbd_dev = list_entry(tmp, struct rbd_device, node);
4376 if (rbd_dev->dev_id > max_id)
4377 max_id = rbd_dev->dev_id;
4379 spin_unlock(&rbd_dev_list_lock);
4382 * The max id could have been updated by rbd_dev_id_get(), in
4383 * which case it now accurately reflects the new maximum.
4384 * Be careful not to overwrite the maximum value in that
4387 atomic64_cmpxchg(&rbd_dev_id_max, rbd_id, max_id);
4388 dout(" max dev id has been reset\n");
4392 * Skips over white space at *buf, and updates *buf to point to the
4393 * first found non-space character (if any). Returns the length of
4394 * the token (string of non-white space characters) found. Note
4395 * that *buf must be terminated with '\0'.
4397 static inline size_t next_token(const char **buf)
4400 * These are the characters that produce nonzero for
4401 * isspace() in the "C" and "POSIX" locales.
4403 const char *spaces = " \f\n\r\t\v";
4405 *buf += strspn(*buf, spaces); /* Find start of token */
4407 return strcspn(*buf, spaces); /* Return token length */
4411 * Finds the next token in *buf, and if the provided token buffer is
4412 * big enough, copies the found token into it. The result, if
4413 * copied, is guaranteed to be terminated with '\0'. Note that *buf
4414 * must be terminated with '\0' on entry.
4416 * Returns the length of the token found (not including the '\0').
4417 * Return value will be 0 if no token is found, and it will be >=
4418 * token_size if the token would not fit.
4420 * The *buf pointer will be updated to point beyond the end of the
4421 * found token. Note that this occurs even if the token buffer is
4422 * too small to hold it.
4424 static inline size_t copy_token(const char **buf,
4430 len = next_token(buf);
4431 if (len < token_size) {
4432 memcpy(token, *buf, len);
4433 *(token + len) = '\0';
4441 * Finds the next token in *buf, dynamically allocates a buffer big
4442 * enough to hold a copy of it, and copies the token into the new
4443 * buffer. The copy is guaranteed to be terminated with '\0'. Note
4444 * that a duplicate buffer is created even for a zero-length token.
4446 * Returns a pointer to the newly-allocated duplicate, or a null
4447 * pointer if memory for the duplicate was not available. If
4448 * the lenp argument is a non-null pointer, the length of the token
4449 * (not including the '\0') is returned in *lenp.
4451 * If successful, the *buf pointer will be updated to point beyond
4452 * the end of the found token.
4454 * Note: uses GFP_KERNEL for allocation.
4456 static inline char *dup_token(const char **buf, size_t *lenp)
4461 len = next_token(buf);
4462 dup = kmemdup(*buf, len + 1, GFP_KERNEL);
4465 *(dup + len) = '\0';
4475 * Parse the options provided for an "rbd add" (i.e., rbd image
4476 * mapping) request. These arrive via a write to /sys/bus/rbd/add,
4477 * and the data written is passed here via a NUL-terminated buffer.
4478 * Returns 0 if successful or an error code otherwise.
4480 * The information extracted from these options is recorded in
4481 * the other parameters which return dynamically-allocated
4484 * The address of a pointer that will refer to a ceph options
4485 * structure. Caller must release the returned pointer using
4486 * ceph_destroy_options() when it is no longer needed.
4488 * Address of an rbd options pointer. Fully initialized by
4489 * this function; caller must release with kfree().
4491 * Address of an rbd image specification pointer. Fully
4492 * initialized by this function based on parsed options.
4493 * Caller must release with rbd_spec_put().
4495 * The options passed take this form:
4496 * <mon_addrs> <options> <pool_name> <image_name> [<snap_id>]
4499 * A comma-separated list of one or more monitor addresses.
4500 * A monitor address is an ip address, optionally followed
4501 * by a port number (separated by a colon).
4502 * I.e.: ip1[:port1][,ip2[:port2]...]
4504 * A comma-separated list of ceph and/or rbd options.
4506 * The name of the rados pool containing the rbd image.
4508 * The name of the image in that pool to map.
4510 * An optional snapshot id. If provided, the mapping will
4511 * present data from the image at the time that snapshot was
4512 * created. The image head is used if no snapshot id is
4513 * provided. Snapshot mappings are always read-only.
4515 static int rbd_add_parse_args(const char *buf,
4516 struct ceph_options **ceph_opts,
4517 struct rbd_options **opts,
4518 struct rbd_spec **rbd_spec)
4522 const char *mon_addrs;
4524 size_t mon_addrs_size;
4525 struct rbd_spec *spec = NULL;
4526 struct rbd_options *rbd_opts = NULL;
4527 struct ceph_options *copts;
4530 /* The first four tokens are required */
4532 len = next_token(&buf);
4534 rbd_warn(NULL, "no monitor address(es) provided");
4538 mon_addrs_size = len + 1;
4542 options = dup_token(&buf, NULL);
4546 rbd_warn(NULL, "no options provided");
4550 spec = rbd_spec_alloc();
4554 spec->pool_name = dup_token(&buf, NULL);
4555 if (!spec->pool_name)
4557 if (!*spec->pool_name) {
4558 rbd_warn(NULL, "no pool name provided");
4562 spec->image_name = dup_token(&buf, NULL);
4563 if (!spec->image_name)
4565 if (!*spec->image_name) {
4566 rbd_warn(NULL, "no image name provided");
4571 * Snapshot name is optional; default is to use "-"
4572 * (indicating the head/no snapshot).
4574 len = next_token(&buf);
4576 buf = RBD_SNAP_HEAD_NAME; /* No snapshot supplied */
4577 len = sizeof (RBD_SNAP_HEAD_NAME) - 1;
4578 } else if (len > RBD_MAX_SNAP_NAME_LEN) {
4579 ret = -ENAMETOOLONG;
4582 snap_name = kmemdup(buf, len + 1, GFP_KERNEL);
4585 *(snap_name + len) = '\0';
4586 spec->snap_name = snap_name;
4588 /* Initialize all rbd options to the defaults */
4590 rbd_opts = kzalloc(sizeof (*rbd_opts), GFP_KERNEL);
4594 rbd_opts->read_only = RBD_READ_ONLY_DEFAULT;
4596 copts = ceph_parse_options(options, mon_addrs,
4597 mon_addrs + mon_addrs_size - 1,
4598 parse_rbd_opts_token, rbd_opts);
4599 if (IS_ERR(copts)) {
4600 ret = PTR_ERR(copts);
4621 * An rbd format 2 image has a unique identifier, distinct from the
4622 * name given to it by the user. Internally, that identifier is
4623 * what's used to specify the names of objects related to the image.
4625 * A special "rbd id" object is used to map an rbd image name to its
4626 * id. If that object doesn't exist, then there is no v2 rbd image
4627 * with the supplied name.
4629 * This function will record the given rbd_dev's image_id field if
4630 * it can be determined, and in that case will return 0. If any
4631 * errors occur a negative errno will be returned and the rbd_dev's
4632 * image_id field will be unchanged (and should be NULL).
4634 static int rbd_dev_image_id(struct rbd_device *rbd_dev)
4643 * When probing a parent image, the image id is already
4644 * known (and the image name likely is not). There's no
4645 * need to fetch the image id again in this case. We
4646 * do still need to set the image format though.
4648 if (rbd_dev->spec->image_id) {
4649 rbd_dev->image_format = *rbd_dev->spec->image_id ? 2 : 1;
4655 * First, see if the format 2 image id file exists, and if
4656 * so, get the image's persistent id from it.
4658 size = sizeof (RBD_ID_PREFIX) + strlen(rbd_dev->spec->image_name);
4659 object_name = kmalloc(size, GFP_NOIO);
4662 sprintf(object_name, "%s%s", RBD_ID_PREFIX, rbd_dev->spec->image_name);
4663 dout("rbd id object name is %s\n", object_name);
4665 /* Response will be an encoded string, which includes a length */
4667 size = sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX;
4668 response = kzalloc(size, GFP_NOIO);
4674 /* If it doesn't exist we'll assume it's a format 1 image */
4676 ret = rbd_obj_method_sync(rbd_dev, object_name,
4677 "rbd", "get_id", NULL, 0,
4678 response, RBD_IMAGE_ID_LEN_MAX);
4679 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
4680 if (ret == -ENOENT) {
4681 image_id = kstrdup("", GFP_KERNEL);
4682 ret = image_id ? 0 : -ENOMEM;
4684 rbd_dev->image_format = 1;
4685 } else if (ret > sizeof (__le32)) {
4688 image_id = ceph_extract_encoded_string(&p, p + ret,
4690 ret = IS_ERR(image_id) ? PTR_ERR(image_id) : 0;
4692 rbd_dev->image_format = 2;
4698 rbd_dev->spec->image_id = image_id;
4699 dout("image_id is %s\n", image_id);
4709 * Undo whatever state changes are made by v1 or v2 header info
4712 static void rbd_dev_unprobe(struct rbd_device *rbd_dev)
4714 struct rbd_image_header *header;
4716 /* Drop parent reference unless it's already been done (or none) */
4718 if (rbd_dev->parent_overlap)
4719 rbd_dev_parent_put(rbd_dev);
4721 /* Free dynamic fields from the header, then zero it out */
4723 header = &rbd_dev->header;
4724 ceph_put_snap_context(header->snapc);
4725 kfree(header->snap_sizes);
4726 kfree(header->snap_names);
4727 kfree(header->object_prefix);
4728 memset(header, 0, sizeof (*header));
4731 static int rbd_dev_v2_header_onetime(struct rbd_device *rbd_dev)
4735 ret = rbd_dev_v2_object_prefix(rbd_dev);
4740 * Get the and check features for the image. Currently the
4741 * features are assumed to never change.
4743 ret = rbd_dev_v2_features(rbd_dev);
4747 /* If the image supports fancy striping, get its parameters */
4749 if (rbd_dev->header.features & RBD_FEATURE_STRIPINGV2) {
4750 ret = rbd_dev_v2_striping_info(rbd_dev);
4754 /* No support for crypto and compression type format 2 images */
4758 rbd_dev->header.features = 0;
4759 kfree(rbd_dev->header.object_prefix);
4760 rbd_dev->header.object_prefix = NULL;
4765 static int rbd_dev_probe_parent(struct rbd_device *rbd_dev)
4767 struct rbd_device *parent = NULL;
4768 struct rbd_spec *parent_spec;
4769 struct rbd_client *rbdc;
4772 if (!rbd_dev->parent_spec)
4775 * We need to pass a reference to the client and the parent
4776 * spec when creating the parent rbd_dev. Images related by
4777 * parent/child relationships always share both.
4779 parent_spec = rbd_spec_get(rbd_dev->parent_spec);
4780 rbdc = __rbd_get_client(rbd_dev->rbd_client);
4783 parent = rbd_dev_create(rbdc, parent_spec);
4787 ret = rbd_dev_image_probe(parent, false);
4790 rbd_dev->parent = parent;
4791 atomic_set(&rbd_dev->parent_ref, 1);
4796 rbd_dev_unparent(rbd_dev);
4797 kfree(rbd_dev->header_name);
4798 rbd_dev_destroy(parent);
4800 rbd_put_client(rbdc);
4801 rbd_spec_put(parent_spec);
4807 static int rbd_dev_device_setup(struct rbd_device *rbd_dev)
4811 /* generate unique id: find highest unique id, add one */
4812 rbd_dev_id_get(rbd_dev);
4814 /* Fill in the device name, now that we have its id. */
4815 BUILD_BUG_ON(DEV_NAME_LEN
4816 < sizeof (RBD_DRV_NAME) + MAX_INT_FORMAT_WIDTH);
4817 sprintf(rbd_dev->name, "%s%d", RBD_DRV_NAME, rbd_dev->dev_id);
4819 /* Get our block major device number. */
4821 ret = register_blkdev(0, rbd_dev->name);
4824 rbd_dev->major = ret;
4826 /* Set up the blkdev mapping. */
4828 ret = rbd_init_disk(rbd_dev);
4830 goto err_out_blkdev;
4832 ret = rbd_dev_mapping_set(rbd_dev);
4835 set_capacity(rbd_dev->disk, rbd_dev->mapping.size / SECTOR_SIZE);
4837 ret = rbd_bus_add_dev(rbd_dev);
4839 goto err_out_mapping;
4841 /* Everything's ready. Announce the disk to the world. */
4843 set_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
4844 add_disk(rbd_dev->disk);
4846 pr_info("%s: added with size 0x%llx\n", rbd_dev->disk->disk_name,
4847 (unsigned long long) rbd_dev->mapping.size);
4852 rbd_dev_mapping_clear(rbd_dev);
4854 rbd_free_disk(rbd_dev);
4856 unregister_blkdev(rbd_dev->major, rbd_dev->name);
4858 rbd_dev_id_put(rbd_dev);
4859 rbd_dev_mapping_clear(rbd_dev);
4864 static int rbd_dev_header_name(struct rbd_device *rbd_dev)
4866 struct rbd_spec *spec = rbd_dev->spec;
4869 /* Record the header object name for this rbd image. */
4871 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
4873 if (rbd_dev->image_format == 1)
4874 size = strlen(spec->image_name) + sizeof (RBD_SUFFIX);
4876 size = sizeof (RBD_HEADER_PREFIX) + strlen(spec->image_id);
4878 rbd_dev->header_name = kmalloc(size, GFP_KERNEL);
4879 if (!rbd_dev->header_name)
4882 if (rbd_dev->image_format == 1)
4883 sprintf(rbd_dev->header_name, "%s%s",
4884 spec->image_name, RBD_SUFFIX);
4886 sprintf(rbd_dev->header_name, "%s%s",
4887 RBD_HEADER_PREFIX, spec->image_id);
4891 static void rbd_dev_image_release(struct rbd_device *rbd_dev)
4893 rbd_dev_unprobe(rbd_dev);
4894 kfree(rbd_dev->header_name);
4895 rbd_dev->header_name = NULL;
4896 rbd_dev->image_format = 0;
4897 kfree(rbd_dev->spec->image_id);
4898 rbd_dev->spec->image_id = NULL;
4900 rbd_dev_destroy(rbd_dev);
4904 * Probe for the existence of the header object for the given rbd
4905 * device. If this image is the one being mapped (i.e., not a
4906 * parent), initiate a watch on its header object before using that
4907 * object to get detailed information about the rbd image.
4909 static int rbd_dev_image_probe(struct rbd_device *rbd_dev, bool mapping)
4915 * Get the id from the image id object. Unless there's an
4916 * error, rbd_dev->spec->image_id will be filled in with
4917 * a dynamically-allocated string, and rbd_dev->image_format
4918 * will be set to either 1 or 2.
4920 ret = rbd_dev_image_id(rbd_dev);
4923 rbd_assert(rbd_dev->spec->image_id);
4924 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
4926 ret = rbd_dev_header_name(rbd_dev);
4928 goto err_out_format;
4931 ret = rbd_dev_header_watch_sync(rbd_dev, true);
4933 goto out_header_name;
4936 if (rbd_dev->image_format == 1)
4937 ret = rbd_dev_v1_header_info(rbd_dev);
4939 ret = rbd_dev_v2_header_info(rbd_dev);
4943 ret = rbd_dev_spec_update(rbd_dev);
4947 ret = rbd_dev_probe_parent(rbd_dev);
4951 dout("discovered format %u image, header name is %s\n",
4952 rbd_dev->image_format, rbd_dev->header_name);
4956 rbd_dev_unprobe(rbd_dev);
4959 tmp = rbd_dev_header_watch_sync(rbd_dev, false);
4961 rbd_warn(rbd_dev, "unable to tear down "
4962 "watch request (%d)\n", tmp);
4965 kfree(rbd_dev->header_name);
4966 rbd_dev->header_name = NULL;
4968 rbd_dev->image_format = 0;
4969 kfree(rbd_dev->spec->image_id);
4970 rbd_dev->spec->image_id = NULL;
4972 dout("probe failed, returning %d\n", ret);
4977 static ssize_t rbd_add(struct bus_type *bus,
4981 struct rbd_device *rbd_dev = NULL;
4982 struct ceph_options *ceph_opts = NULL;
4983 struct rbd_options *rbd_opts = NULL;
4984 struct rbd_spec *spec = NULL;
4985 struct rbd_client *rbdc;
4986 struct ceph_osd_client *osdc;
4990 if (!try_module_get(THIS_MODULE))
4993 /* parse add command */
4994 rc = rbd_add_parse_args(buf, &ceph_opts, &rbd_opts, &spec);
4996 goto err_out_module;
4997 read_only = rbd_opts->read_only;
4999 rbd_opts = NULL; /* done with this */
5001 rbdc = rbd_get_client(ceph_opts);
5008 osdc = &rbdc->client->osdc;
5009 rc = ceph_pg_poolid_by_name(osdc->osdmap, spec->pool_name);
5011 goto err_out_client;
5012 spec->pool_id = (u64)rc;
5014 /* The ceph file layout needs to fit pool id in 32 bits */
5016 if (spec->pool_id > (u64)U32_MAX) {
5017 rbd_warn(NULL, "pool id too large (%llu > %u)\n",
5018 (unsigned long long)spec->pool_id, U32_MAX);
5020 goto err_out_client;
5023 rbd_dev = rbd_dev_create(rbdc, spec);
5025 goto err_out_client;
5026 rbdc = NULL; /* rbd_dev now owns this */
5027 spec = NULL; /* rbd_dev now owns this */
5029 rc = rbd_dev_image_probe(rbd_dev, true);
5031 goto err_out_rbd_dev;
5033 /* If we are mapping a snapshot it must be marked read-only */
5035 if (rbd_dev->spec->snap_id != CEPH_NOSNAP)
5037 rbd_dev->mapping.read_only = read_only;
5039 rc = rbd_dev_device_setup(rbd_dev);
5041 rbd_dev_image_release(rbd_dev);
5042 goto err_out_module;
5048 rbd_dev_destroy(rbd_dev);
5050 rbd_put_client(rbdc);
5054 module_put(THIS_MODULE);
5056 dout("Error adding device %s\n", buf);
5061 static struct rbd_device *__rbd_get_dev(unsigned long dev_id)
5063 struct list_head *tmp;
5064 struct rbd_device *rbd_dev;
5066 spin_lock(&rbd_dev_list_lock);
5067 list_for_each(tmp, &rbd_dev_list) {
5068 rbd_dev = list_entry(tmp, struct rbd_device, node);
5069 if (rbd_dev->dev_id == dev_id) {
5070 spin_unlock(&rbd_dev_list_lock);
5074 spin_unlock(&rbd_dev_list_lock);
5078 static void rbd_dev_device_release(struct device *dev)
5080 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
5082 rbd_free_disk(rbd_dev);
5083 clear_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
5084 rbd_dev_mapping_clear(rbd_dev);
5085 unregister_blkdev(rbd_dev->major, rbd_dev->name);
5087 rbd_dev_id_put(rbd_dev);
5088 rbd_dev_mapping_clear(rbd_dev);
5091 static void rbd_dev_remove_parent(struct rbd_device *rbd_dev)
5093 while (rbd_dev->parent) {
5094 struct rbd_device *first = rbd_dev;
5095 struct rbd_device *second = first->parent;
5096 struct rbd_device *third;
5099 * Follow to the parent with no grandparent and
5102 while (second && (third = second->parent)) {
5107 rbd_dev_image_release(second);
5108 first->parent = NULL;
5109 first->parent_overlap = 0;
5111 rbd_assert(first->parent_spec);
5112 rbd_spec_put(first->parent_spec);
5113 first->parent_spec = NULL;
5117 static ssize_t rbd_remove(struct bus_type *bus,
5121 struct rbd_device *rbd_dev = NULL;
5126 ret = strict_strtoul(buf, 10, &ul);
5130 /* convert to int; abort if we lost anything in the conversion */
5131 target_id = (int) ul;
5132 if (target_id != ul)
5135 mutex_lock_nested(&ctl_mutex, SINGLE_DEPTH_NESTING);
5137 rbd_dev = __rbd_get_dev(target_id);
5143 spin_lock_irq(&rbd_dev->lock);
5144 if (rbd_dev->open_count)
5147 set_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags);
5148 spin_unlock_irq(&rbd_dev->lock);
5151 rbd_bus_del_dev(rbd_dev);
5152 ret = rbd_dev_header_watch_sync(rbd_dev, false);
5154 rbd_warn(rbd_dev, "failed to cancel watch event (%d)\n", ret);
5155 rbd_dev_image_release(rbd_dev);
5156 module_put(THIS_MODULE);
5159 mutex_unlock(&ctl_mutex);
5165 * create control files in sysfs
5168 static int rbd_sysfs_init(void)
5172 ret = device_register(&rbd_root_dev);
5176 ret = bus_register(&rbd_bus_type);
5178 device_unregister(&rbd_root_dev);
5183 static void rbd_sysfs_cleanup(void)
5185 bus_unregister(&rbd_bus_type);
5186 device_unregister(&rbd_root_dev);
5189 static int rbd_slab_init(void)
5191 rbd_assert(!rbd_img_request_cache);
5192 rbd_img_request_cache = kmem_cache_create("rbd_img_request",
5193 sizeof (struct rbd_img_request),
5194 __alignof__(struct rbd_img_request),
5196 if (!rbd_img_request_cache)
5199 rbd_assert(!rbd_obj_request_cache);
5200 rbd_obj_request_cache = kmem_cache_create("rbd_obj_request",
5201 sizeof (struct rbd_obj_request),
5202 __alignof__(struct rbd_obj_request),
5204 if (!rbd_obj_request_cache)
5207 rbd_assert(!rbd_segment_name_cache);
5208 rbd_segment_name_cache = kmem_cache_create("rbd_segment_name",
5209 MAX_OBJ_NAME_SIZE + 1, 1, 0, NULL);
5210 if (rbd_segment_name_cache)
5213 if (rbd_obj_request_cache) {
5214 kmem_cache_destroy(rbd_obj_request_cache);
5215 rbd_obj_request_cache = NULL;
5218 kmem_cache_destroy(rbd_img_request_cache);
5219 rbd_img_request_cache = NULL;
5224 static void rbd_slab_exit(void)
5226 rbd_assert(rbd_segment_name_cache);
5227 kmem_cache_destroy(rbd_segment_name_cache);
5228 rbd_segment_name_cache = NULL;
5230 rbd_assert(rbd_obj_request_cache);
5231 kmem_cache_destroy(rbd_obj_request_cache);
5232 rbd_obj_request_cache = NULL;
5234 rbd_assert(rbd_img_request_cache);
5235 kmem_cache_destroy(rbd_img_request_cache);
5236 rbd_img_request_cache = NULL;
5239 static int __init rbd_init(void)
5243 if (!libceph_compatible(NULL)) {
5244 rbd_warn(NULL, "libceph incompatibility (quitting)");
5248 rc = rbd_slab_init();
5251 rc = rbd_sysfs_init();
5255 pr_info("loaded " RBD_DRV_NAME_LONG "\n");
5260 static void __exit rbd_exit(void)
5262 rbd_sysfs_cleanup();
5266 module_init(rbd_init);
5267 module_exit(rbd_exit);
5269 MODULE_AUTHOR("Sage Weil <sage@newdream.net>");
5270 MODULE_AUTHOR("Yehuda Sadeh <yehuda@hq.newdream.net>");
5271 MODULE_DESCRIPTION("rados block device");
5273 /* following authorship retained from original osdblk.c */
5274 MODULE_AUTHOR("Jeff Garzik <jeff@garzik.org>");
5276 MODULE_LICENSE("GPL");