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/cls_lock_client.h>
35 #include <linux/ceph/decode.h>
36 #include <linux/parser.h>
37 #include <linux/bsearch.h>
39 #include <linux/kernel.h>
40 #include <linux/device.h>
41 #include <linux/module.h>
42 #include <linux/blk-mq.h>
44 #include <linux/blkdev.h>
45 #include <linux/slab.h>
46 #include <linux/idr.h>
47 #include <linux/workqueue.h>
49 #include "rbd_types.h"
51 #define RBD_DEBUG /* Activate rbd_assert() calls */
54 * The basic unit of block I/O is a sector. It is interpreted in a
55 * number of contexts in Linux (blk, bio, genhd), but the default is
56 * universally 512 bytes. These symbols are just slightly more
57 * meaningful than the bare numbers they represent.
59 #define SECTOR_SHIFT 9
60 #define SECTOR_SIZE (1ULL << SECTOR_SHIFT)
63 * Increment the given counter and return its updated value.
64 * If the counter is already 0 it will not be incremented.
65 * If the counter is already at its maximum value returns
66 * -EINVAL without updating it.
68 static int atomic_inc_return_safe(atomic_t *v)
72 counter = (unsigned int)__atomic_add_unless(v, 1, 0);
73 if (counter <= (unsigned int)INT_MAX)
81 /* Decrement the counter. Return the resulting value, or -EINVAL */
82 static int atomic_dec_return_safe(atomic_t *v)
86 counter = atomic_dec_return(v);
95 #define RBD_DRV_NAME "rbd"
97 #define RBD_MINORS_PER_MAJOR 256
98 #define RBD_SINGLE_MAJOR_PART_SHIFT 4
100 #define RBD_MAX_PARENT_CHAIN_LEN 16
102 #define RBD_SNAP_DEV_NAME_PREFIX "snap_"
103 #define RBD_MAX_SNAP_NAME_LEN \
104 (NAME_MAX - (sizeof (RBD_SNAP_DEV_NAME_PREFIX) - 1))
106 #define RBD_MAX_SNAP_COUNT 510 /* allows max snapc to fit in 4KB */
108 #define RBD_SNAP_HEAD_NAME "-"
110 #define BAD_SNAP_INDEX U32_MAX /* invalid index into snap array */
112 /* This allows a single page to hold an image name sent by OSD */
113 #define RBD_IMAGE_NAME_LEN_MAX (PAGE_SIZE - sizeof (__le32) - 1)
114 #define RBD_IMAGE_ID_LEN_MAX 64
116 #define RBD_OBJ_PREFIX_LEN_MAX 64
118 #define RBD_NOTIFY_TIMEOUT 5 /* seconds */
119 #define RBD_RETRY_DELAY msecs_to_jiffies(1000)
123 #define RBD_FEATURE_LAYERING (1<<0)
124 #define RBD_FEATURE_STRIPINGV2 (1<<1)
125 #define RBD_FEATURE_EXCLUSIVE_LOCK (1<<2)
126 #define RBD_FEATURES_ALL (RBD_FEATURE_LAYERING | \
127 RBD_FEATURE_STRIPINGV2 | \
128 RBD_FEATURE_EXCLUSIVE_LOCK)
130 /* Features supported by this (client software) implementation. */
132 #define RBD_FEATURES_SUPPORTED (RBD_FEATURES_ALL)
135 * An RBD device name will be "rbd#", where the "rbd" comes from
136 * RBD_DRV_NAME above, and # is a unique integer identifier.
138 #define DEV_NAME_LEN 32
141 * block device image metadata (in-memory version)
143 struct rbd_image_header {
144 /* These six fields never change for a given rbd image */
151 u64 features; /* Might be changeable someday? */
153 /* The remaining fields need to be updated occasionally */
155 struct ceph_snap_context *snapc;
156 char *snap_names; /* format 1 only */
157 u64 *snap_sizes; /* format 1 only */
161 * An rbd image specification.
163 * The tuple (pool_id, image_id, snap_id) is sufficient to uniquely
164 * identify an image. Each rbd_dev structure includes a pointer to
165 * an rbd_spec structure that encapsulates this identity.
167 * Each of the id's in an rbd_spec has an associated name. For a
168 * user-mapped image, the names are supplied and the id's associated
169 * with them are looked up. For a layered image, a parent image is
170 * defined by the tuple, and the names are looked up.
172 * An rbd_dev structure contains a parent_spec pointer which is
173 * non-null if the image it represents is a child in a layered
174 * image. This pointer will refer to the rbd_spec structure used
175 * by the parent rbd_dev for its own identity (i.e., the structure
176 * is shared between the parent and child).
178 * Since these structures are populated once, during the discovery
179 * phase of image construction, they are effectively immutable so
180 * we make no effort to synchronize access to them.
182 * Note that code herein does not assume the image name is known (it
183 * could be a null pointer).
187 const char *pool_name;
189 const char *image_id;
190 const char *image_name;
193 const char *snap_name;
199 * an instance of the client. multiple devices may share an rbd client.
202 struct ceph_client *client;
204 struct list_head node;
207 struct rbd_img_request;
208 typedef void (*rbd_img_callback_t)(struct rbd_img_request *);
210 #define BAD_WHICH U32_MAX /* Good which or bad which, which? */
212 struct rbd_obj_request;
213 typedef void (*rbd_obj_callback_t)(struct rbd_obj_request *);
215 enum obj_request_type {
216 OBJ_REQUEST_NODATA, OBJ_REQUEST_BIO, OBJ_REQUEST_PAGES
219 enum obj_operation_type {
226 OBJ_REQ_DONE, /* completion flag: not done = 0, done = 1 */
227 OBJ_REQ_IMG_DATA, /* object usage: standalone = 0, image = 1 */
228 OBJ_REQ_KNOWN, /* EXISTS flag valid: no = 0, yes = 1 */
229 OBJ_REQ_EXISTS, /* target exists: no = 0, yes = 1 */
232 struct rbd_obj_request {
233 const char *object_name;
234 u64 offset; /* object start byte */
235 u64 length; /* bytes from offset */
239 * An object request associated with an image will have its
240 * img_data flag set; a standalone object request will not.
242 * A standalone object request will have which == BAD_WHICH
243 * and a null obj_request pointer.
245 * An object request initiated in support of a layered image
246 * object (to check for its existence before a write) will
247 * have which == BAD_WHICH and a non-null obj_request pointer.
249 * Finally, an object request for rbd image data will have
250 * which != BAD_WHICH, and will have a non-null img_request
251 * pointer. The value of which will be in the range
252 * 0..(img_request->obj_request_count-1).
255 struct rbd_obj_request *obj_request; /* STAT op */
257 struct rbd_img_request *img_request;
259 /* links for img_request->obj_requests list */
260 struct list_head links;
263 u32 which; /* posn image request list */
265 enum obj_request_type type;
267 struct bio *bio_list;
273 struct page **copyup_pages;
274 u32 copyup_page_count;
276 struct ceph_osd_request *osd_req;
278 u64 xferred; /* bytes transferred */
281 rbd_obj_callback_t callback;
282 struct completion completion;
288 IMG_REQ_WRITE, /* I/O direction: read = 0, write = 1 */
289 IMG_REQ_CHILD, /* initiator: block = 0, child image = 1 */
290 IMG_REQ_LAYERED, /* ENOENT handling: normal = 0, layered = 1 */
291 IMG_REQ_DISCARD, /* discard: normal = 0, discard request = 1 */
294 struct rbd_img_request {
295 struct rbd_device *rbd_dev;
296 u64 offset; /* starting image byte offset */
297 u64 length; /* byte count from offset */
300 u64 snap_id; /* for reads */
301 struct ceph_snap_context *snapc; /* for writes */
304 struct request *rq; /* block request */
305 struct rbd_obj_request *obj_request; /* obj req initiator */
307 struct page **copyup_pages;
308 u32 copyup_page_count;
309 spinlock_t completion_lock;/* protects next_completion */
311 rbd_img_callback_t callback;
312 u64 xferred;/* aggregate bytes transferred */
313 int result; /* first nonzero obj_request result */
315 u32 obj_request_count;
316 struct list_head obj_requests; /* rbd_obj_request structs */
321 #define for_each_obj_request(ireq, oreq) \
322 list_for_each_entry(oreq, &(ireq)->obj_requests, links)
323 #define for_each_obj_request_from(ireq, oreq) \
324 list_for_each_entry_from(oreq, &(ireq)->obj_requests, links)
325 #define for_each_obj_request_safe(ireq, oreq, n) \
326 list_for_each_entry_safe_reverse(oreq, n, &(ireq)->obj_requests, links)
328 enum rbd_watch_state {
329 RBD_WATCH_STATE_UNREGISTERED,
330 RBD_WATCH_STATE_REGISTERED,
331 RBD_WATCH_STATE_ERROR,
334 enum rbd_lock_state {
335 RBD_LOCK_STATE_UNLOCKED,
336 RBD_LOCK_STATE_LOCKED,
337 RBD_LOCK_STATE_RELEASING,
340 /* WatchNotify::ClientId */
341 struct rbd_client_id {
356 int dev_id; /* blkdev unique id */
358 int major; /* blkdev assigned major */
360 struct gendisk *disk; /* blkdev's gendisk and rq */
362 u32 image_format; /* Either 1 or 2 */
363 struct rbd_client *rbd_client;
365 char name[DEV_NAME_LEN]; /* blkdev name, e.g. rbd3 */
367 spinlock_t lock; /* queue, flags, open_count */
369 struct rbd_image_header header;
370 unsigned long flags; /* possibly lock protected */
371 struct rbd_spec *spec;
372 struct rbd_options *opts;
373 char *config_info; /* add{,_single_major} string */
375 struct ceph_object_id header_oid;
376 struct ceph_object_locator header_oloc;
378 struct ceph_file_layout layout; /* used for all rbd requests */
380 struct mutex watch_mutex;
381 enum rbd_watch_state watch_state;
382 struct ceph_osd_linger_request *watch_handle;
384 struct delayed_work watch_dwork;
386 struct rw_semaphore lock_rwsem;
387 enum rbd_lock_state lock_state;
388 struct rbd_client_id owner_cid;
389 struct work_struct acquired_lock_work;
390 struct work_struct released_lock_work;
391 struct delayed_work lock_dwork;
392 struct work_struct unlock_work;
393 wait_queue_head_t lock_waitq;
395 struct workqueue_struct *task_wq;
397 struct rbd_spec *parent_spec;
400 struct rbd_device *parent;
402 /* Block layer tags. */
403 struct blk_mq_tag_set tag_set;
405 /* protects updating the header */
406 struct rw_semaphore header_rwsem;
408 struct rbd_mapping mapping;
410 struct list_head node;
414 unsigned long open_count; /* protected by lock */
418 * Flag bits for rbd_dev->flags. If atomicity is required,
419 * rbd_dev->lock is used to protect access.
421 * Currently, only the "removing" flag (which is coupled with the
422 * "open_count" field) requires atomic access.
425 RBD_DEV_FLAG_EXISTS, /* mapped snapshot has not been deleted */
426 RBD_DEV_FLAG_REMOVING, /* this mapping is being removed */
429 static DEFINE_MUTEX(client_mutex); /* Serialize client creation */
431 static LIST_HEAD(rbd_dev_list); /* devices */
432 static DEFINE_SPINLOCK(rbd_dev_list_lock);
434 static LIST_HEAD(rbd_client_list); /* clients */
435 static DEFINE_SPINLOCK(rbd_client_list_lock);
437 /* Slab caches for frequently-allocated structures */
439 static struct kmem_cache *rbd_img_request_cache;
440 static struct kmem_cache *rbd_obj_request_cache;
441 static struct kmem_cache *rbd_segment_name_cache;
443 static int rbd_major;
444 static DEFINE_IDA(rbd_dev_id_ida);
446 static struct workqueue_struct *rbd_wq;
449 * Default to false for now, as single-major requires >= 0.75 version of
450 * userspace rbd utility.
452 static bool single_major = false;
453 module_param(single_major, bool, S_IRUGO);
454 MODULE_PARM_DESC(single_major, "Use a single major number for all rbd devices (default: false)");
456 static int rbd_img_request_submit(struct rbd_img_request *img_request);
458 static ssize_t rbd_add(struct bus_type *bus, const char *buf,
460 static ssize_t rbd_remove(struct bus_type *bus, const char *buf,
462 static ssize_t rbd_add_single_major(struct bus_type *bus, const char *buf,
464 static ssize_t rbd_remove_single_major(struct bus_type *bus, const char *buf,
466 static int rbd_dev_image_probe(struct rbd_device *rbd_dev, int depth);
467 static void rbd_spec_put(struct rbd_spec *spec);
469 static int rbd_dev_id_to_minor(int dev_id)
471 return dev_id << RBD_SINGLE_MAJOR_PART_SHIFT;
474 static int minor_to_rbd_dev_id(int minor)
476 return minor >> RBD_SINGLE_MAJOR_PART_SHIFT;
479 static bool rbd_is_lock_supported(struct rbd_device *rbd_dev)
481 return (rbd_dev->header.features & RBD_FEATURE_EXCLUSIVE_LOCK) &&
482 rbd_dev->spec->snap_id == CEPH_NOSNAP &&
483 !rbd_dev->mapping.read_only;
486 static bool __rbd_is_lock_owner(struct rbd_device *rbd_dev)
488 return rbd_dev->lock_state == RBD_LOCK_STATE_LOCKED ||
489 rbd_dev->lock_state == RBD_LOCK_STATE_RELEASING;
492 static bool rbd_is_lock_owner(struct rbd_device *rbd_dev)
496 down_read(&rbd_dev->lock_rwsem);
497 is_lock_owner = __rbd_is_lock_owner(rbd_dev);
498 up_read(&rbd_dev->lock_rwsem);
499 return is_lock_owner;
502 static BUS_ATTR(add, S_IWUSR, NULL, rbd_add);
503 static BUS_ATTR(remove, S_IWUSR, NULL, rbd_remove);
504 static BUS_ATTR(add_single_major, S_IWUSR, NULL, rbd_add_single_major);
505 static BUS_ATTR(remove_single_major, S_IWUSR, NULL, rbd_remove_single_major);
507 static struct attribute *rbd_bus_attrs[] = {
509 &bus_attr_remove.attr,
510 &bus_attr_add_single_major.attr,
511 &bus_attr_remove_single_major.attr,
515 static umode_t rbd_bus_is_visible(struct kobject *kobj,
516 struct attribute *attr, int index)
519 (attr == &bus_attr_add_single_major.attr ||
520 attr == &bus_attr_remove_single_major.attr))
526 static const struct attribute_group rbd_bus_group = {
527 .attrs = rbd_bus_attrs,
528 .is_visible = rbd_bus_is_visible,
530 __ATTRIBUTE_GROUPS(rbd_bus);
532 static struct bus_type rbd_bus_type = {
534 .bus_groups = rbd_bus_groups,
537 static void rbd_root_dev_release(struct device *dev)
541 static struct device rbd_root_dev = {
543 .release = rbd_root_dev_release,
546 static __printf(2, 3)
547 void rbd_warn(struct rbd_device *rbd_dev, const char *fmt, ...)
549 struct va_format vaf;
557 printk(KERN_WARNING "%s: %pV\n", RBD_DRV_NAME, &vaf);
558 else if (rbd_dev->disk)
559 printk(KERN_WARNING "%s: %s: %pV\n",
560 RBD_DRV_NAME, rbd_dev->disk->disk_name, &vaf);
561 else if (rbd_dev->spec && rbd_dev->spec->image_name)
562 printk(KERN_WARNING "%s: image %s: %pV\n",
563 RBD_DRV_NAME, rbd_dev->spec->image_name, &vaf);
564 else if (rbd_dev->spec && rbd_dev->spec->image_id)
565 printk(KERN_WARNING "%s: id %s: %pV\n",
566 RBD_DRV_NAME, rbd_dev->spec->image_id, &vaf);
568 printk(KERN_WARNING "%s: rbd_dev %p: %pV\n",
569 RBD_DRV_NAME, rbd_dev, &vaf);
574 #define rbd_assert(expr) \
575 if (unlikely(!(expr))) { \
576 printk(KERN_ERR "\nAssertion failure in %s() " \
578 "\trbd_assert(%s);\n\n", \
579 __func__, __LINE__, #expr); \
582 #else /* !RBD_DEBUG */
583 # define rbd_assert(expr) ((void) 0)
584 #endif /* !RBD_DEBUG */
586 static void rbd_osd_copyup_callback(struct rbd_obj_request *obj_request);
587 static int rbd_img_obj_request_submit(struct rbd_obj_request *obj_request);
588 static void rbd_img_parent_read(struct rbd_obj_request *obj_request);
589 static void rbd_dev_remove_parent(struct rbd_device *rbd_dev);
591 static int rbd_dev_refresh(struct rbd_device *rbd_dev);
592 static int rbd_dev_v2_header_onetime(struct rbd_device *rbd_dev);
593 static int rbd_dev_header_info(struct rbd_device *rbd_dev);
594 static int rbd_dev_v2_parent_info(struct rbd_device *rbd_dev);
595 static const char *rbd_dev_v2_snap_name(struct rbd_device *rbd_dev,
597 static int _rbd_dev_v2_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
598 u8 *order, u64 *snap_size);
599 static int _rbd_dev_v2_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
602 static int rbd_open(struct block_device *bdev, fmode_t mode)
604 struct rbd_device *rbd_dev = bdev->bd_disk->private_data;
605 bool removing = false;
607 if ((mode & FMODE_WRITE) && rbd_dev->mapping.read_only)
610 spin_lock_irq(&rbd_dev->lock);
611 if (test_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags))
614 rbd_dev->open_count++;
615 spin_unlock_irq(&rbd_dev->lock);
619 (void) get_device(&rbd_dev->dev);
624 static void rbd_release(struct gendisk *disk, fmode_t mode)
626 struct rbd_device *rbd_dev = disk->private_data;
627 unsigned long open_count_before;
629 spin_lock_irq(&rbd_dev->lock);
630 open_count_before = rbd_dev->open_count--;
631 spin_unlock_irq(&rbd_dev->lock);
632 rbd_assert(open_count_before > 0);
634 put_device(&rbd_dev->dev);
637 static int rbd_ioctl_set_ro(struct rbd_device *rbd_dev, unsigned long arg)
642 bool ro_changed = false;
644 /* get_user() may sleep, so call it before taking rbd_dev->lock */
645 if (get_user(val, (int __user *)(arg)))
648 ro = val ? true : false;
649 /* Snapshot doesn't allow to write*/
650 if (rbd_dev->spec->snap_id != CEPH_NOSNAP && !ro)
653 spin_lock_irq(&rbd_dev->lock);
654 /* prevent others open this device */
655 if (rbd_dev->open_count > 1) {
660 if (rbd_dev->mapping.read_only != ro) {
661 rbd_dev->mapping.read_only = ro;
666 spin_unlock_irq(&rbd_dev->lock);
667 /* set_disk_ro() may sleep, so call it after releasing rbd_dev->lock */
668 if (ret == 0 && ro_changed)
669 set_disk_ro(rbd_dev->disk, ro ? 1 : 0);
674 static int rbd_ioctl(struct block_device *bdev, fmode_t mode,
675 unsigned int cmd, unsigned long arg)
677 struct rbd_device *rbd_dev = bdev->bd_disk->private_data;
682 ret = rbd_ioctl_set_ro(rbd_dev, arg);
692 static int rbd_compat_ioctl(struct block_device *bdev, fmode_t mode,
693 unsigned int cmd, unsigned long arg)
695 return rbd_ioctl(bdev, mode, cmd, arg);
697 #endif /* CONFIG_COMPAT */
699 static const struct block_device_operations rbd_bd_ops = {
700 .owner = THIS_MODULE,
702 .release = rbd_release,
705 .compat_ioctl = rbd_compat_ioctl,
710 * Initialize an rbd client instance. Success or not, this function
711 * consumes ceph_opts. Caller holds client_mutex.
713 static struct rbd_client *rbd_client_create(struct ceph_options *ceph_opts)
715 struct rbd_client *rbdc;
718 dout("%s:\n", __func__);
719 rbdc = kmalloc(sizeof(struct rbd_client), GFP_KERNEL);
723 kref_init(&rbdc->kref);
724 INIT_LIST_HEAD(&rbdc->node);
726 rbdc->client = ceph_create_client(ceph_opts, rbdc, 0, 0);
727 if (IS_ERR(rbdc->client))
729 ceph_opts = NULL; /* Now rbdc->client is responsible for ceph_opts */
731 ret = ceph_open_session(rbdc->client);
735 spin_lock(&rbd_client_list_lock);
736 list_add_tail(&rbdc->node, &rbd_client_list);
737 spin_unlock(&rbd_client_list_lock);
739 dout("%s: rbdc %p\n", __func__, rbdc);
743 ceph_destroy_client(rbdc->client);
748 ceph_destroy_options(ceph_opts);
749 dout("%s: error %d\n", __func__, ret);
754 static struct rbd_client *__rbd_get_client(struct rbd_client *rbdc)
756 kref_get(&rbdc->kref);
762 * Find a ceph client with specific addr and configuration. If
763 * found, bump its reference count.
765 static struct rbd_client *rbd_client_find(struct ceph_options *ceph_opts)
767 struct rbd_client *client_node;
770 if (ceph_opts->flags & CEPH_OPT_NOSHARE)
773 spin_lock(&rbd_client_list_lock);
774 list_for_each_entry(client_node, &rbd_client_list, node) {
775 if (!ceph_compare_options(ceph_opts, client_node->client)) {
776 __rbd_get_client(client_node);
782 spin_unlock(&rbd_client_list_lock);
784 return found ? client_node : NULL;
788 * (Per device) rbd map options
795 /* string args above */
802 static match_table_t rbd_opts_tokens = {
803 {Opt_queue_depth, "queue_depth=%d"},
805 /* string args above */
806 {Opt_read_only, "read_only"},
807 {Opt_read_only, "ro"}, /* Alternate spelling */
808 {Opt_read_write, "read_write"},
809 {Opt_read_write, "rw"}, /* Alternate spelling */
810 {Opt_lock_on_read, "lock_on_read"},
820 #define RBD_QUEUE_DEPTH_DEFAULT BLKDEV_MAX_RQ
821 #define RBD_READ_ONLY_DEFAULT false
822 #define RBD_LOCK_ON_READ_DEFAULT false
824 static int parse_rbd_opts_token(char *c, void *private)
826 struct rbd_options *rbd_opts = private;
827 substring_t argstr[MAX_OPT_ARGS];
828 int token, intval, ret;
830 token = match_token(c, rbd_opts_tokens, argstr);
831 if (token < Opt_last_int) {
832 ret = match_int(&argstr[0], &intval);
834 pr_err("bad mount option arg (not int) at '%s'\n", c);
837 dout("got int token %d val %d\n", token, intval);
838 } else if (token > Opt_last_int && token < Opt_last_string) {
839 dout("got string token %d val %s\n", token, argstr[0].from);
841 dout("got token %d\n", token);
845 case Opt_queue_depth:
847 pr_err("queue_depth out of range\n");
850 rbd_opts->queue_depth = intval;
853 rbd_opts->read_only = true;
856 rbd_opts->read_only = false;
858 case Opt_lock_on_read:
859 rbd_opts->lock_on_read = true;
862 /* libceph prints "bad option" msg */
869 static char* obj_op_name(enum obj_operation_type op_type)
884 * Get a ceph client with specific addr and configuration, if one does
885 * not exist create it. Either way, ceph_opts is consumed by this
888 static struct rbd_client *rbd_get_client(struct ceph_options *ceph_opts)
890 struct rbd_client *rbdc;
892 mutex_lock_nested(&client_mutex, SINGLE_DEPTH_NESTING);
893 rbdc = rbd_client_find(ceph_opts);
894 if (rbdc) /* using an existing client */
895 ceph_destroy_options(ceph_opts);
897 rbdc = rbd_client_create(ceph_opts);
898 mutex_unlock(&client_mutex);
904 * Destroy ceph client
906 * Caller must hold rbd_client_list_lock.
908 static void rbd_client_release(struct kref *kref)
910 struct rbd_client *rbdc = container_of(kref, struct rbd_client, kref);
912 dout("%s: rbdc %p\n", __func__, rbdc);
913 spin_lock(&rbd_client_list_lock);
914 list_del(&rbdc->node);
915 spin_unlock(&rbd_client_list_lock);
917 ceph_destroy_client(rbdc->client);
922 * Drop reference to ceph client node. If it's not referenced anymore, release
925 static void rbd_put_client(struct rbd_client *rbdc)
928 kref_put(&rbdc->kref, rbd_client_release);
931 static bool rbd_image_format_valid(u32 image_format)
933 return image_format == 1 || image_format == 2;
936 static bool rbd_dev_ondisk_valid(struct rbd_image_header_ondisk *ondisk)
941 /* The header has to start with the magic rbd header text */
942 if (memcmp(&ondisk->text, RBD_HEADER_TEXT, sizeof (RBD_HEADER_TEXT)))
945 /* The bio layer requires at least sector-sized I/O */
947 if (ondisk->options.order < SECTOR_SHIFT)
950 /* If we use u64 in a few spots we may be able to loosen this */
952 if (ondisk->options.order > 8 * sizeof (int) - 1)
956 * The size of a snapshot header has to fit in a size_t, and
957 * that limits the number of snapshots.
959 snap_count = le32_to_cpu(ondisk->snap_count);
960 size = SIZE_MAX - sizeof (struct ceph_snap_context);
961 if (snap_count > size / sizeof (__le64))
965 * Not only that, but the size of the entire the snapshot
966 * header must also be representable in a size_t.
968 size -= snap_count * sizeof (__le64);
969 if ((u64) size < le64_to_cpu(ondisk->snap_names_len))
976 * Fill an rbd image header with information from the given format 1
979 static int rbd_header_from_disk(struct rbd_device *rbd_dev,
980 struct rbd_image_header_ondisk *ondisk)
982 struct rbd_image_header *header = &rbd_dev->header;
983 bool first_time = header->object_prefix == NULL;
984 struct ceph_snap_context *snapc;
985 char *object_prefix = NULL;
986 char *snap_names = NULL;
987 u64 *snap_sizes = NULL;
993 /* Allocate this now to avoid having to handle failure below */
998 len = strnlen(ondisk->object_prefix,
999 sizeof (ondisk->object_prefix));
1000 object_prefix = kmalloc(len + 1, GFP_KERNEL);
1003 memcpy(object_prefix, ondisk->object_prefix, len);
1004 object_prefix[len] = '\0';
1007 /* Allocate the snapshot context and fill it in */
1009 snap_count = le32_to_cpu(ondisk->snap_count);
1010 snapc = ceph_create_snap_context(snap_count, GFP_KERNEL);
1013 snapc->seq = le64_to_cpu(ondisk->snap_seq);
1015 struct rbd_image_snap_ondisk *snaps;
1016 u64 snap_names_len = le64_to_cpu(ondisk->snap_names_len);
1018 /* We'll keep a copy of the snapshot names... */
1020 if (snap_names_len > (u64)SIZE_MAX)
1022 snap_names = kmalloc(snap_names_len, GFP_KERNEL);
1026 /* ...as well as the array of their sizes. */
1028 size = snap_count * sizeof (*header->snap_sizes);
1029 snap_sizes = kmalloc(size, GFP_KERNEL);
1034 * Copy the names, and fill in each snapshot's id
1037 * Note that rbd_dev_v1_header_info() guarantees the
1038 * ondisk buffer we're working with has
1039 * snap_names_len bytes beyond the end of the
1040 * snapshot id array, this memcpy() is safe.
1042 memcpy(snap_names, &ondisk->snaps[snap_count], snap_names_len);
1043 snaps = ondisk->snaps;
1044 for (i = 0; i < snap_count; i++) {
1045 snapc->snaps[i] = le64_to_cpu(snaps[i].id);
1046 snap_sizes[i] = le64_to_cpu(snaps[i].image_size);
1050 /* We won't fail any more, fill in the header */
1053 header->object_prefix = object_prefix;
1054 header->obj_order = ondisk->options.order;
1055 header->crypt_type = ondisk->options.crypt_type;
1056 header->comp_type = ondisk->options.comp_type;
1057 /* The rest aren't used for format 1 images */
1058 header->stripe_unit = 0;
1059 header->stripe_count = 0;
1060 header->features = 0;
1062 ceph_put_snap_context(header->snapc);
1063 kfree(header->snap_names);
1064 kfree(header->snap_sizes);
1067 /* The remaining fields always get updated (when we refresh) */
1069 header->image_size = le64_to_cpu(ondisk->image_size);
1070 header->snapc = snapc;
1071 header->snap_names = snap_names;
1072 header->snap_sizes = snap_sizes;
1080 ceph_put_snap_context(snapc);
1081 kfree(object_prefix);
1086 static const char *_rbd_dev_v1_snap_name(struct rbd_device *rbd_dev, u32 which)
1088 const char *snap_name;
1090 rbd_assert(which < rbd_dev->header.snapc->num_snaps);
1092 /* Skip over names until we find the one we are looking for */
1094 snap_name = rbd_dev->header.snap_names;
1096 snap_name += strlen(snap_name) + 1;
1098 return kstrdup(snap_name, GFP_KERNEL);
1102 * Snapshot id comparison function for use with qsort()/bsearch().
1103 * Note that result is for snapshots in *descending* order.
1105 static int snapid_compare_reverse(const void *s1, const void *s2)
1107 u64 snap_id1 = *(u64 *)s1;
1108 u64 snap_id2 = *(u64 *)s2;
1110 if (snap_id1 < snap_id2)
1112 return snap_id1 == snap_id2 ? 0 : -1;
1116 * Search a snapshot context to see if the given snapshot id is
1119 * Returns the position of the snapshot id in the array if it's found,
1120 * or BAD_SNAP_INDEX otherwise.
1122 * Note: The snapshot array is in kept sorted (by the osd) in
1123 * reverse order, highest snapshot id first.
1125 static u32 rbd_dev_snap_index(struct rbd_device *rbd_dev, u64 snap_id)
1127 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
1130 found = bsearch(&snap_id, &snapc->snaps, snapc->num_snaps,
1131 sizeof (snap_id), snapid_compare_reverse);
1133 return found ? (u32)(found - &snapc->snaps[0]) : BAD_SNAP_INDEX;
1136 static const char *rbd_dev_v1_snap_name(struct rbd_device *rbd_dev,
1140 const char *snap_name;
1142 which = rbd_dev_snap_index(rbd_dev, snap_id);
1143 if (which == BAD_SNAP_INDEX)
1144 return ERR_PTR(-ENOENT);
1146 snap_name = _rbd_dev_v1_snap_name(rbd_dev, which);
1147 return snap_name ? snap_name : ERR_PTR(-ENOMEM);
1150 static const char *rbd_snap_name(struct rbd_device *rbd_dev, u64 snap_id)
1152 if (snap_id == CEPH_NOSNAP)
1153 return RBD_SNAP_HEAD_NAME;
1155 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
1156 if (rbd_dev->image_format == 1)
1157 return rbd_dev_v1_snap_name(rbd_dev, snap_id);
1159 return rbd_dev_v2_snap_name(rbd_dev, snap_id);
1162 static int rbd_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
1165 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
1166 if (snap_id == CEPH_NOSNAP) {
1167 *snap_size = rbd_dev->header.image_size;
1168 } else if (rbd_dev->image_format == 1) {
1171 which = rbd_dev_snap_index(rbd_dev, snap_id);
1172 if (which == BAD_SNAP_INDEX)
1175 *snap_size = rbd_dev->header.snap_sizes[which];
1180 ret = _rbd_dev_v2_snap_size(rbd_dev, snap_id, NULL, &size);
1189 static int rbd_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
1192 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
1193 if (snap_id == CEPH_NOSNAP) {
1194 *snap_features = rbd_dev->header.features;
1195 } else if (rbd_dev->image_format == 1) {
1196 *snap_features = 0; /* No features for format 1 */
1201 ret = _rbd_dev_v2_snap_features(rbd_dev, snap_id, &features);
1205 *snap_features = features;
1210 static int rbd_dev_mapping_set(struct rbd_device *rbd_dev)
1212 u64 snap_id = rbd_dev->spec->snap_id;
1217 ret = rbd_snap_size(rbd_dev, snap_id, &size);
1220 ret = rbd_snap_features(rbd_dev, snap_id, &features);
1224 rbd_dev->mapping.size = size;
1225 rbd_dev->mapping.features = features;
1230 static void rbd_dev_mapping_clear(struct rbd_device *rbd_dev)
1232 rbd_dev->mapping.size = 0;
1233 rbd_dev->mapping.features = 0;
1236 static void rbd_segment_name_free(const char *name)
1238 /* The explicit cast here is needed to drop the const qualifier */
1240 kmem_cache_free(rbd_segment_name_cache, (void *)name);
1243 static const char *rbd_segment_name(struct rbd_device *rbd_dev, u64 offset)
1250 name = kmem_cache_alloc(rbd_segment_name_cache, GFP_NOIO);
1253 segment = offset >> rbd_dev->header.obj_order;
1254 name_format = "%s.%012llx";
1255 if (rbd_dev->image_format == 2)
1256 name_format = "%s.%016llx";
1257 ret = snprintf(name, CEPH_MAX_OID_NAME_LEN + 1, name_format,
1258 rbd_dev->header.object_prefix, segment);
1259 if (ret < 0 || ret > CEPH_MAX_OID_NAME_LEN) {
1260 pr_err("error formatting segment name for #%llu (%d)\n",
1262 rbd_segment_name_free(name);
1269 static u64 rbd_segment_offset(struct rbd_device *rbd_dev, u64 offset)
1271 u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
1273 return offset & (segment_size - 1);
1276 static u64 rbd_segment_length(struct rbd_device *rbd_dev,
1277 u64 offset, u64 length)
1279 u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
1281 offset &= segment_size - 1;
1283 rbd_assert(length <= U64_MAX - offset);
1284 if (offset + length > segment_size)
1285 length = segment_size - offset;
1291 * returns the size of an object in the image
1293 static u64 rbd_obj_bytes(struct rbd_image_header *header)
1295 return 1 << header->obj_order;
1302 static void bio_chain_put(struct bio *chain)
1308 chain = chain->bi_next;
1314 * zeros a bio chain, starting at specific offset
1316 static void zero_bio_chain(struct bio *chain, int start_ofs)
1319 struct bvec_iter iter;
1320 unsigned long flags;
1325 bio_for_each_segment(bv, chain, iter) {
1326 if (pos + bv.bv_len > start_ofs) {
1327 int remainder = max(start_ofs - pos, 0);
1328 buf = bvec_kmap_irq(&bv, &flags);
1329 memset(buf + remainder, 0,
1330 bv.bv_len - remainder);
1331 flush_dcache_page(bv.bv_page);
1332 bvec_kunmap_irq(buf, &flags);
1337 chain = chain->bi_next;
1342 * similar to zero_bio_chain(), zeros data defined by a page array,
1343 * starting at the given byte offset from the start of the array and
1344 * continuing up to the given end offset. The pages array is
1345 * assumed to be big enough to hold all bytes up to the end.
1347 static void zero_pages(struct page **pages, u64 offset, u64 end)
1349 struct page **page = &pages[offset >> PAGE_SHIFT];
1351 rbd_assert(end > offset);
1352 rbd_assert(end - offset <= (u64)SIZE_MAX);
1353 while (offset < end) {
1356 unsigned long flags;
1359 page_offset = offset & ~PAGE_MASK;
1360 length = min_t(size_t, PAGE_SIZE - page_offset, end - offset);
1361 local_irq_save(flags);
1362 kaddr = kmap_atomic(*page);
1363 memset(kaddr + page_offset, 0, length);
1364 flush_dcache_page(*page);
1365 kunmap_atomic(kaddr);
1366 local_irq_restore(flags);
1374 * Clone a portion of a bio, starting at the given byte offset
1375 * and continuing for the number of bytes indicated.
1377 static struct bio *bio_clone_range(struct bio *bio_src,
1378 unsigned int offset,
1384 bio = bio_clone(bio_src, gfpmask);
1386 return NULL; /* ENOMEM */
1388 bio_advance(bio, offset);
1389 bio->bi_iter.bi_size = len;
1395 * Clone a portion of a bio chain, starting at the given byte offset
1396 * into the first bio in the source chain and continuing for the
1397 * number of bytes indicated. The result is another bio chain of
1398 * exactly the given length, or a null pointer on error.
1400 * The bio_src and offset parameters are both in-out. On entry they
1401 * refer to the first source bio and the offset into that bio where
1402 * the start of data to be cloned is located.
1404 * On return, bio_src is updated to refer to the bio in the source
1405 * chain that contains first un-cloned byte, and *offset will
1406 * contain the offset of that byte within that bio.
1408 static struct bio *bio_chain_clone_range(struct bio **bio_src,
1409 unsigned int *offset,
1413 struct bio *bi = *bio_src;
1414 unsigned int off = *offset;
1415 struct bio *chain = NULL;
1418 /* Build up a chain of clone bios up to the limit */
1420 if (!bi || off >= bi->bi_iter.bi_size || !len)
1421 return NULL; /* Nothing to clone */
1425 unsigned int bi_size;
1429 rbd_warn(NULL, "bio_chain exhausted with %u left", len);
1430 goto out_err; /* EINVAL; ran out of bio's */
1432 bi_size = min_t(unsigned int, bi->bi_iter.bi_size - off, len);
1433 bio = bio_clone_range(bi, off, bi_size, gfpmask);
1435 goto out_err; /* ENOMEM */
1438 end = &bio->bi_next;
1441 if (off == bi->bi_iter.bi_size) {
1452 bio_chain_put(chain);
1458 * The default/initial value for all object request flags is 0. For
1459 * each flag, once its value is set to 1 it is never reset to 0
1462 static void obj_request_img_data_set(struct rbd_obj_request *obj_request)
1464 if (test_and_set_bit(OBJ_REQ_IMG_DATA, &obj_request->flags)) {
1465 struct rbd_device *rbd_dev;
1467 rbd_dev = obj_request->img_request->rbd_dev;
1468 rbd_warn(rbd_dev, "obj_request %p already marked img_data",
1473 static bool obj_request_img_data_test(struct rbd_obj_request *obj_request)
1476 return test_bit(OBJ_REQ_IMG_DATA, &obj_request->flags) != 0;
1479 static void obj_request_done_set(struct rbd_obj_request *obj_request)
1481 if (test_and_set_bit(OBJ_REQ_DONE, &obj_request->flags)) {
1482 struct rbd_device *rbd_dev = NULL;
1484 if (obj_request_img_data_test(obj_request))
1485 rbd_dev = obj_request->img_request->rbd_dev;
1486 rbd_warn(rbd_dev, "obj_request %p already marked done",
1491 static bool obj_request_done_test(struct rbd_obj_request *obj_request)
1494 return test_bit(OBJ_REQ_DONE, &obj_request->flags) != 0;
1498 * This sets the KNOWN flag after (possibly) setting the EXISTS
1499 * flag. The latter is set based on the "exists" value provided.
1501 * Note that for our purposes once an object exists it never goes
1502 * away again. It's possible that the response from two existence
1503 * checks are separated by the creation of the target object, and
1504 * the first ("doesn't exist") response arrives *after* the second
1505 * ("does exist"). In that case we ignore the second one.
1507 static void obj_request_existence_set(struct rbd_obj_request *obj_request,
1511 set_bit(OBJ_REQ_EXISTS, &obj_request->flags);
1512 set_bit(OBJ_REQ_KNOWN, &obj_request->flags);
1516 static bool obj_request_known_test(struct rbd_obj_request *obj_request)
1519 return test_bit(OBJ_REQ_KNOWN, &obj_request->flags) != 0;
1522 static bool obj_request_exists_test(struct rbd_obj_request *obj_request)
1525 return test_bit(OBJ_REQ_EXISTS, &obj_request->flags) != 0;
1528 static bool obj_request_overlaps_parent(struct rbd_obj_request *obj_request)
1530 struct rbd_device *rbd_dev = obj_request->img_request->rbd_dev;
1532 return obj_request->img_offset <
1533 round_up(rbd_dev->parent_overlap, rbd_obj_bytes(&rbd_dev->header));
1536 static void rbd_obj_request_get(struct rbd_obj_request *obj_request)
1538 dout("%s: obj %p (was %d)\n", __func__, obj_request,
1539 atomic_read(&obj_request->kref.refcount));
1540 kref_get(&obj_request->kref);
1543 static void rbd_obj_request_destroy(struct kref *kref);
1544 static void rbd_obj_request_put(struct rbd_obj_request *obj_request)
1546 rbd_assert(obj_request != NULL);
1547 dout("%s: obj %p (was %d)\n", __func__, obj_request,
1548 atomic_read(&obj_request->kref.refcount));
1549 kref_put(&obj_request->kref, rbd_obj_request_destroy);
1552 static void rbd_img_request_get(struct rbd_img_request *img_request)
1554 dout("%s: img %p (was %d)\n", __func__, img_request,
1555 atomic_read(&img_request->kref.refcount));
1556 kref_get(&img_request->kref);
1559 static bool img_request_child_test(struct rbd_img_request *img_request);
1560 static void rbd_parent_request_destroy(struct kref *kref);
1561 static void rbd_img_request_destroy(struct kref *kref);
1562 static void rbd_img_request_put(struct rbd_img_request *img_request)
1564 rbd_assert(img_request != NULL);
1565 dout("%s: img %p (was %d)\n", __func__, img_request,
1566 atomic_read(&img_request->kref.refcount));
1567 if (img_request_child_test(img_request))
1568 kref_put(&img_request->kref, rbd_parent_request_destroy);
1570 kref_put(&img_request->kref, rbd_img_request_destroy);
1573 static inline void rbd_img_obj_request_add(struct rbd_img_request *img_request,
1574 struct rbd_obj_request *obj_request)
1576 rbd_assert(obj_request->img_request == NULL);
1578 /* Image request now owns object's original reference */
1579 obj_request->img_request = img_request;
1580 obj_request->which = img_request->obj_request_count;
1581 rbd_assert(!obj_request_img_data_test(obj_request));
1582 obj_request_img_data_set(obj_request);
1583 rbd_assert(obj_request->which != BAD_WHICH);
1584 img_request->obj_request_count++;
1585 list_add_tail(&obj_request->links, &img_request->obj_requests);
1586 dout("%s: img %p obj %p w=%u\n", __func__, img_request, obj_request,
1587 obj_request->which);
1590 static inline void rbd_img_obj_request_del(struct rbd_img_request *img_request,
1591 struct rbd_obj_request *obj_request)
1593 rbd_assert(obj_request->which != BAD_WHICH);
1595 dout("%s: img %p obj %p w=%u\n", __func__, img_request, obj_request,
1596 obj_request->which);
1597 list_del(&obj_request->links);
1598 rbd_assert(img_request->obj_request_count > 0);
1599 img_request->obj_request_count--;
1600 rbd_assert(obj_request->which == img_request->obj_request_count);
1601 obj_request->which = BAD_WHICH;
1602 rbd_assert(obj_request_img_data_test(obj_request));
1603 rbd_assert(obj_request->img_request == img_request);
1604 obj_request->img_request = NULL;
1605 obj_request->callback = NULL;
1606 rbd_obj_request_put(obj_request);
1609 static bool obj_request_type_valid(enum obj_request_type type)
1612 case OBJ_REQUEST_NODATA:
1613 case OBJ_REQUEST_BIO:
1614 case OBJ_REQUEST_PAGES:
1621 static void rbd_img_obj_callback(struct rbd_obj_request *obj_request);
1623 static void rbd_obj_request_submit(struct rbd_obj_request *obj_request)
1625 struct ceph_osd_request *osd_req = obj_request->osd_req;
1627 dout("%s %p osd_req %p\n", __func__, obj_request, osd_req);
1628 if (obj_request_img_data_test(obj_request)) {
1629 WARN_ON(obj_request->callback != rbd_img_obj_callback);
1630 rbd_img_request_get(obj_request->img_request);
1632 ceph_osdc_start_request(osd_req->r_osdc, osd_req, false);
1635 static void rbd_obj_request_end(struct rbd_obj_request *obj_request)
1637 dout("%s %p\n", __func__, obj_request);
1638 ceph_osdc_cancel_request(obj_request->osd_req);
1642 * Wait for an object request to complete. If interrupted, cancel the
1643 * underlying osd request.
1645 * @timeout: in jiffies, 0 means "wait forever"
1647 static int __rbd_obj_request_wait(struct rbd_obj_request *obj_request,
1648 unsigned long timeout)
1652 dout("%s %p\n", __func__, obj_request);
1653 ret = wait_for_completion_interruptible_timeout(
1654 &obj_request->completion,
1655 ceph_timeout_jiffies(timeout));
1659 rbd_obj_request_end(obj_request);
1664 dout("%s %p ret %d\n", __func__, obj_request, (int)ret);
1668 static int rbd_obj_request_wait(struct rbd_obj_request *obj_request)
1670 return __rbd_obj_request_wait(obj_request, 0);
1673 static void rbd_img_request_complete(struct rbd_img_request *img_request)
1676 dout("%s: img %p\n", __func__, img_request);
1679 * If no error occurred, compute the aggregate transfer
1680 * count for the image request. We could instead use
1681 * atomic64_cmpxchg() to update it as each object request
1682 * completes; not clear which way is better off hand.
1684 if (!img_request->result) {
1685 struct rbd_obj_request *obj_request;
1688 for_each_obj_request(img_request, obj_request)
1689 xferred += obj_request->xferred;
1690 img_request->xferred = xferred;
1693 if (img_request->callback)
1694 img_request->callback(img_request);
1696 rbd_img_request_put(img_request);
1700 * The default/initial value for all image request flags is 0. Each
1701 * is conditionally set to 1 at image request initialization time
1702 * and currently never change thereafter.
1704 static void img_request_write_set(struct rbd_img_request *img_request)
1706 set_bit(IMG_REQ_WRITE, &img_request->flags);
1710 static bool img_request_write_test(struct rbd_img_request *img_request)
1713 return test_bit(IMG_REQ_WRITE, &img_request->flags) != 0;
1717 * Set the discard flag when the img_request is an discard request
1719 static void img_request_discard_set(struct rbd_img_request *img_request)
1721 set_bit(IMG_REQ_DISCARD, &img_request->flags);
1725 static bool img_request_discard_test(struct rbd_img_request *img_request)
1728 return test_bit(IMG_REQ_DISCARD, &img_request->flags) != 0;
1731 static void img_request_child_set(struct rbd_img_request *img_request)
1733 set_bit(IMG_REQ_CHILD, &img_request->flags);
1737 static void img_request_child_clear(struct rbd_img_request *img_request)
1739 clear_bit(IMG_REQ_CHILD, &img_request->flags);
1743 static bool img_request_child_test(struct rbd_img_request *img_request)
1746 return test_bit(IMG_REQ_CHILD, &img_request->flags) != 0;
1749 static void img_request_layered_set(struct rbd_img_request *img_request)
1751 set_bit(IMG_REQ_LAYERED, &img_request->flags);
1755 static void img_request_layered_clear(struct rbd_img_request *img_request)
1757 clear_bit(IMG_REQ_LAYERED, &img_request->flags);
1761 static bool img_request_layered_test(struct rbd_img_request *img_request)
1764 return test_bit(IMG_REQ_LAYERED, &img_request->flags) != 0;
1767 static enum obj_operation_type
1768 rbd_img_request_op_type(struct rbd_img_request *img_request)
1770 if (img_request_write_test(img_request))
1771 return OBJ_OP_WRITE;
1772 else if (img_request_discard_test(img_request))
1773 return OBJ_OP_DISCARD;
1779 rbd_img_obj_request_read_callback(struct rbd_obj_request *obj_request)
1781 u64 xferred = obj_request->xferred;
1782 u64 length = obj_request->length;
1784 dout("%s: obj %p img %p result %d %llu/%llu\n", __func__,
1785 obj_request, obj_request->img_request, obj_request->result,
1788 * ENOENT means a hole in the image. We zero-fill the entire
1789 * length of the request. A short read also implies zero-fill
1790 * to the end of the request. An error requires the whole
1791 * length of the request to be reported finished with an error
1792 * to the block layer. In each case we update the xferred
1793 * count to indicate the whole request was satisfied.
1795 rbd_assert(obj_request->type != OBJ_REQUEST_NODATA);
1796 if (obj_request->result == -ENOENT) {
1797 if (obj_request->type == OBJ_REQUEST_BIO)
1798 zero_bio_chain(obj_request->bio_list, 0);
1800 zero_pages(obj_request->pages, 0, length);
1801 obj_request->result = 0;
1802 } else if (xferred < length && !obj_request->result) {
1803 if (obj_request->type == OBJ_REQUEST_BIO)
1804 zero_bio_chain(obj_request->bio_list, xferred);
1806 zero_pages(obj_request->pages, xferred, length);
1808 obj_request->xferred = length;
1809 obj_request_done_set(obj_request);
1812 static void rbd_obj_request_complete(struct rbd_obj_request *obj_request)
1814 dout("%s: obj %p cb %p\n", __func__, obj_request,
1815 obj_request->callback);
1816 if (obj_request->callback)
1817 obj_request->callback(obj_request);
1819 complete_all(&obj_request->completion);
1822 static void rbd_osd_read_callback(struct rbd_obj_request *obj_request)
1824 struct rbd_img_request *img_request = NULL;
1825 struct rbd_device *rbd_dev = NULL;
1826 bool layered = false;
1828 if (obj_request_img_data_test(obj_request)) {
1829 img_request = obj_request->img_request;
1830 layered = img_request && img_request_layered_test(img_request);
1831 rbd_dev = img_request->rbd_dev;
1834 dout("%s: obj %p img %p result %d %llu/%llu\n", __func__,
1835 obj_request, img_request, obj_request->result,
1836 obj_request->xferred, obj_request->length);
1837 if (layered && obj_request->result == -ENOENT &&
1838 obj_request->img_offset < rbd_dev->parent_overlap)
1839 rbd_img_parent_read(obj_request);
1840 else if (img_request)
1841 rbd_img_obj_request_read_callback(obj_request);
1843 obj_request_done_set(obj_request);
1846 static void rbd_osd_write_callback(struct rbd_obj_request *obj_request)
1848 dout("%s: obj %p result %d %llu\n", __func__, obj_request,
1849 obj_request->result, obj_request->length);
1851 * There is no such thing as a successful short write. Set
1852 * it to our originally-requested length.
1854 obj_request->xferred = obj_request->length;
1855 obj_request_done_set(obj_request);
1858 static void rbd_osd_discard_callback(struct rbd_obj_request *obj_request)
1860 dout("%s: obj %p result %d %llu\n", __func__, obj_request,
1861 obj_request->result, obj_request->length);
1863 * There is no such thing as a successful short discard. Set
1864 * it to our originally-requested length.
1866 obj_request->xferred = obj_request->length;
1867 /* discarding a non-existent object is not a problem */
1868 if (obj_request->result == -ENOENT)
1869 obj_request->result = 0;
1870 obj_request_done_set(obj_request);
1874 * For a simple stat call there's nothing to do. We'll do more if
1875 * this is part of a write sequence for a layered image.
1877 static void rbd_osd_stat_callback(struct rbd_obj_request *obj_request)
1879 dout("%s: obj %p\n", __func__, obj_request);
1880 obj_request_done_set(obj_request);
1883 static void rbd_osd_call_callback(struct rbd_obj_request *obj_request)
1885 dout("%s: obj %p\n", __func__, obj_request);
1887 if (obj_request_img_data_test(obj_request))
1888 rbd_osd_copyup_callback(obj_request);
1890 obj_request_done_set(obj_request);
1893 static void rbd_osd_req_callback(struct ceph_osd_request *osd_req)
1895 struct rbd_obj_request *obj_request = osd_req->r_priv;
1898 dout("%s: osd_req %p\n", __func__, osd_req);
1899 rbd_assert(osd_req == obj_request->osd_req);
1900 if (obj_request_img_data_test(obj_request)) {
1901 rbd_assert(obj_request->img_request);
1902 rbd_assert(obj_request->which != BAD_WHICH);
1904 rbd_assert(obj_request->which == BAD_WHICH);
1907 if (osd_req->r_result < 0)
1908 obj_request->result = osd_req->r_result;
1911 * We support a 64-bit length, but ultimately it has to be
1912 * passed to the block layer, which just supports a 32-bit
1915 obj_request->xferred = osd_req->r_ops[0].outdata_len;
1916 rbd_assert(obj_request->xferred < (u64)UINT_MAX);
1918 opcode = osd_req->r_ops[0].op;
1920 case CEPH_OSD_OP_READ:
1921 rbd_osd_read_callback(obj_request);
1923 case CEPH_OSD_OP_SETALLOCHINT:
1924 rbd_assert(osd_req->r_ops[1].op == CEPH_OSD_OP_WRITE ||
1925 osd_req->r_ops[1].op == CEPH_OSD_OP_WRITEFULL);
1927 case CEPH_OSD_OP_WRITE:
1928 case CEPH_OSD_OP_WRITEFULL:
1929 rbd_osd_write_callback(obj_request);
1931 case CEPH_OSD_OP_STAT:
1932 rbd_osd_stat_callback(obj_request);
1934 case CEPH_OSD_OP_DELETE:
1935 case CEPH_OSD_OP_TRUNCATE:
1936 case CEPH_OSD_OP_ZERO:
1937 rbd_osd_discard_callback(obj_request);
1939 case CEPH_OSD_OP_CALL:
1940 rbd_osd_call_callback(obj_request);
1943 rbd_warn(NULL, "%s: unsupported op %hu",
1944 obj_request->object_name, (unsigned short) opcode);
1948 if (obj_request_done_test(obj_request))
1949 rbd_obj_request_complete(obj_request);
1952 static void rbd_osd_req_format_read(struct rbd_obj_request *obj_request)
1954 struct rbd_img_request *img_request = obj_request->img_request;
1955 struct ceph_osd_request *osd_req = obj_request->osd_req;
1958 osd_req->r_snapid = img_request->snap_id;
1961 static void rbd_osd_req_format_write(struct rbd_obj_request *obj_request)
1963 struct ceph_osd_request *osd_req = obj_request->osd_req;
1965 osd_req->r_mtime = CURRENT_TIME;
1966 osd_req->r_data_offset = obj_request->offset;
1970 * Create an osd request. A read request has one osd op (read).
1971 * A write request has either one (watch) or two (hint+write) osd ops.
1972 * (All rbd data writes are prefixed with an allocation hint op, but
1973 * technically osd watch is a write request, hence this distinction.)
1975 static struct ceph_osd_request *rbd_osd_req_create(
1976 struct rbd_device *rbd_dev,
1977 enum obj_operation_type op_type,
1978 unsigned int num_ops,
1979 struct rbd_obj_request *obj_request)
1981 struct ceph_snap_context *snapc = NULL;
1982 struct ceph_osd_client *osdc;
1983 struct ceph_osd_request *osd_req;
1985 if (obj_request_img_data_test(obj_request) &&
1986 (op_type == OBJ_OP_DISCARD || op_type == OBJ_OP_WRITE)) {
1987 struct rbd_img_request *img_request = obj_request->img_request;
1988 if (op_type == OBJ_OP_WRITE) {
1989 rbd_assert(img_request_write_test(img_request));
1991 rbd_assert(img_request_discard_test(img_request));
1993 snapc = img_request->snapc;
1996 rbd_assert(num_ops == 1 || ((op_type == OBJ_OP_WRITE) && num_ops == 2));
1998 /* Allocate and initialize the request, for the num_ops ops */
2000 osdc = &rbd_dev->rbd_client->client->osdc;
2001 osd_req = ceph_osdc_alloc_request(osdc, snapc, num_ops, false,
2006 if (op_type == OBJ_OP_WRITE || op_type == OBJ_OP_DISCARD)
2007 osd_req->r_flags = CEPH_OSD_FLAG_WRITE | CEPH_OSD_FLAG_ONDISK;
2009 osd_req->r_flags = CEPH_OSD_FLAG_READ;
2011 osd_req->r_callback = rbd_osd_req_callback;
2012 osd_req->r_priv = obj_request;
2014 osd_req->r_base_oloc.pool = rbd_dev->layout.pool_id;
2015 if (ceph_oid_aprintf(&osd_req->r_base_oid, GFP_NOIO, "%s",
2016 obj_request->object_name))
2019 if (ceph_osdc_alloc_messages(osd_req, GFP_NOIO))
2025 ceph_osdc_put_request(osd_req);
2030 * Create a copyup osd request based on the information in the object
2031 * request supplied. A copyup request has two or three osd ops, a
2032 * copyup method call, potentially a hint op, and a write or truncate
2035 static struct ceph_osd_request *
2036 rbd_osd_req_create_copyup(struct rbd_obj_request *obj_request)
2038 struct rbd_img_request *img_request;
2039 struct ceph_snap_context *snapc;
2040 struct rbd_device *rbd_dev;
2041 struct ceph_osd_client *osdc;
2042 struct ceph_osd_request *osd_req;
2043 int num_osd_ops = 3;
2045 rbd_assert(obj_request_img_data_test(obj_request));
2046 img_request = obj_request->img_request;
2047 rbd_assert(img_request);
2048 rbd_assert(img_request_write_test(img_request) ||
2049 img_request_discard_test(img_request));
2051 if (img_request_discard_test(img_request))
2054 /* Allocate and initialize the request, for all the ops */
2056 snapc = img_request->snapc;
2057 rbd_dev = img_request->rbd_dev;
2058 osdc = &rbd_dev->rbd_client->client->osdc;
2059 osd_req = ceph_osdc_alloc_request(osdc, snapc, num_osd_ops,
2064 osd_req->r_flags = CEPH_OSD_FLAG_WRITE | CEPH_OSD_FLAG_ONDISK;
2065 osd_req->r_callback = rbd_osd_req_callback;
2066 osd_req->r_priv = obj_request;
2068 osd_req->r_base_oloc.pool = rbd_dev->layout.pool_id;
2069 if (ceph_oid_aprintf(&osd_req->r_base_oid, GFP_NOIO, "%s",
2070 obj_request->object_name))
2073 if (ceph_osdc_alloc_messages(osd_req, GFP_NOIO))
2079 ceph_osdc_put_request(osd_req);
2084 static void rbd_osd_req_destroy(struct ceph_osd_request *osd_req)
2086 ceph_osdc_put_request(osd_req);
2089 /* object_name is assumed to be a non-null pointer and NUL-terminated */
2091 static struct rbd_obj_request *rbd_obj_request_create(const char *object_name,
2092 u64 offset, u64 length,
2093 enum obj_request_type type)
2095 struct rbd_obj_request *obj_request;
2099 rbd_assert(obj_request_type_valid(type));
2101 size = strlen(object_name) + 1;
2102 name = kmalloc(size, GFP_NOIO);
2106 obj_request = kmem_cache_zalloc(rbd_obj_request_cache, GFP_NOIO);
2112 obj_request->object_name = memcpy(name, object_name, size);
2113 obj_request->offset = offset;
2114 obj_request->length = length;
2115 obj_request->flags = 0;
2116 obj_request->which = BAD_WHICH;
2117 obj_request->type = type;
2118 INIT_LIST_HEAD(&obj_request->links);
2119 init_completion(&obj_request->completion);
2120 kref_init(&obj_request->kref);
2122 dout("%s: \"%s\" %llu/%llu %d -> obj %p\n", __func__, object_name,
2123 offset, length, (int)type, obj_request);
2128 static void rbd_obj_request_destroy(struct kref *kref)
2130 struct rbd_obj_request *obj_request;
2132 obj_request = container_of(kref, struct rbd_obj_request, kref);
2134 dout("%s: obj %p\n", __func__, obj_request);
2136 rbd_assert(obj_request->img_request == NULL);
2137 rbd_assert(obj_request->which == BAD_WHICH);
2139 if (obj_request->osd_req)
2140 rbd_osd_req_destroy(obj_request->osd_req);
2142 rbd_assert(obj_request_type_valid(obj_request->type));
2143 switch (obj_request->type) {
2144 case OBJ_REQUEST_NODATA:
2145 break; /* Nothing to do */
2146 case OBJ_REQUEST_BIO:
2147 if (obj_request->bio_list)
2148 bio_chain_put(obj_request->bio_list);
2150 case OBJ_REQUEST_PAGES:
2151 if (obj_request->pages)
2152 ceph_release_page_vector(obj_request->pages,
2153 obj_request->page_count);
2157 kfree(obj_request->object_name);
2158 obj_request->object_name = NULL;
2159 kmem_cache_free(rbd_obj_request_cache, obj_request);
2162 /* It's OK to call this for a device with no parent */
2164 static void rbd_spec_put(struct rbd_spec *spec);
2165 static void rbd_dev_unparent(struct rbd_device *rbd_dev)
2167 rbd_dev_remove_parent(rbd_dev);
2168 rbd_spec_put(rbd_dev->parent_spec);
2169 rbd_dev->parent_spec = NULL;
2170 rbd_dev->parent_overlap = 0;
2174 * Parent image reference counting is used to determine when an
2175 * image's parent fields can be safely torn down--after there are no
2176 * more in-flight requests to the parent image. When the last
2177 * reference is dropped, cleaning them up is safe.
2179 static void rbd_dev_parent_put(struct rbd_device *rbd_dev)
2183 if (!rbd_dev->parent_spec)
2186 counter = atomic_dec_return_safe(&rbd_dev->parent_ref);
2190 /* Last reference; clean up parent data structures */
2193 rbd_dev_unparent(rbd_dev);
2195 rbd_warn(rbd_dev, "parent reference underflow");
2199 * If an image has a non-zero parent overlap, get a reference to its
2202 * Returns true if the rbd device has a parent with a non-zero
2203 * overlap and a reference for it was successfully taken, or
2206 static bool rbd_dev_parent_get(struct rbd_device *rbd_dev)
2210 if (!rbd_dev->parent_spec)
2213 down_read(&rbd_dev->header_rwsem);
2214 if (rbd_dev->parent_overlap)
2215 counter = atomic_inc_return_safe(&rbd_dev->parent_ref);
2216 up_read(&rbd_dev->header_rwsem);
2219 rbd_warn(rbd_dev, "parent reference overflow");
2225 * Caller is responsible for filling in the list of object requests
2226 * that comprises the image request, and the Linux request pointer
2227 * (if there is one).
2229 static struct rbd_img_request *rbd_img_request_create(
2230 struct rbd_device *rbd_dev,
2231 u64 offset, u64 length,
2232 enum obj_operation_type op_type,
2233 struct ceph_snap_context *snapc)
2235 struct rbd_img_request *img_request;
2237 img_request = kmem_cache_alloc(rbd_img_request_cache, GFP_NOIO);
2241 img_request->rq = NULL;
2242 img_request->rbd_dev = rbd_dev;
2243 img_request->offset = offset;
2244 img_request->length = length;
2245 img_request->flags = 0;
2246 if (op_type == OBJ_OP_DISCARD) {
2247 img_request_discard_set(img_request);
2248 img_request->snapc = snapc;
2249 } else if (op_type == OBJ_OP_WRITE) {
2250 img_request_write_set(img_request);
2251 img_request->snapc = snapc;
2253 img_request->snap_id = rbd_dev->spec->snap_id;
2255 if (rbd_dev_parent_get(rbd_dev))
2256 img_request_layered_set(img_request);
2257 spin_lock_init(&img_request->completion_lock);
2258 img_request->next_completion = 0;
2259 img_request->callback = NULL;
2260 img_request->result = 0;
2261 img_request->obj_request_count = 0;
2262 INIT_LIST_HEAD(&img_request->obj_requests);
2263 kref_init(&img_request->kref);
2265 dout("%s: rbd_dev %p %s %llu/%llu -> img %p\n", __func__, rbd_dev,
2266 obj_op_name(op_type), offset, length, img_request);
2271 static void rbd_img_request_destroy(struct kref *kref)
2273 struct rbd_img_request *img_request;
2274 struct rbd_obj_request *obj_request;
2275 struct rbd_obj_request *next_obj_request;
2277 img_request = container_of(kref, struct rbd_img_request, kref);
2279 dout("%s: img %p\n", __func__, img_request);
2281 for_each_obj_request_safe(img_request, obj_request, next_obj_request)
2282 rbd_img_obj_request_del(img_request, obj_request);
2283 rbd_assert(img_request->obj_request_count == 0);
2285 if (img_request_layered_test(img_request)) {
2286 img_request_layered_clear(img_request);
2287 rbd_dev_parent_put(img_request->rbd_dev);
2290 if (img_request_write_test(img_request) ||
2291 img_request_discard_test(img_request))
2292 ceph_put_snap_context(img_request->snapc);
2294 kmem_cache_free(rbd_img_request_cache, img_request);
2297 static struct rbd_img_request *rbd_parent_request_create(
2298 struct rbd_obj_request *obj_request,
2299 u64 img_offset, u64 length)
2301 struct rbd_img_request *parent_request;
2302 struct rbd_device *rbd_dev;
2304 rbd_assert(obj_request->img_request);
2305 rbd_dev = obj_request->img_request->rbd_dev;
2307 parent_request = rbd_img_request_create(rbd_dev->parent, img_offset,
2308 length, OBJ_OP_READ, NULL);
2309 if (!parent_request)
2312 img_request_child_set(parent_request);
2313 rbd_obj_request_get(obj_request);
2314 parent_request->obj_request = obj_request;
2316 return parent_request;
2319 static void rbd_parent_request_destroy(struct kref *kref)
2321 struct rbd_img_request *parent_request;
2322 struct rbd_obj_request *orig_request;
2324 parent_request = container_of(kref, struct rbd_img_request, kref);
2325 orig_request = parent_request->obj_request;
2327 parent_request->obj_request = NULL;
2328 rbd_obj_request_put(orig_request);
2329 img_request_child_clear(parent_request);
2331 rbd_img_request_destroy(kref);
2334 static bool rbd_img_obj_end_request(struct rbd_obj_request *obj_request)
2336 struct rbd_img_request *img_request;
2337 unsigned int xferred;
2341 rbd_assert(obj_request_img_data_test(obj_request));
2342 img_request = obj_request->img_request;
2344 rbd_assert(obj_request->xferred <= (u64)UINT_MAX);
2345 xferred = (unsigned int)obj_request->xferred;
2346 result = obj_request->result;
2348 struct rbd_device *rbd_dev = img_request->rbd_dev;
2349 enum obj_operation_type op_type;
2351 if (img_request_discard_test(img_request))
2352 op_type = OBJ_OP_DISCARD;
2353 else if (img_request_write_test(img_request))
2354 op_type = OBJ_OP_WRITE;
2356 op_type = OBJ_OP_READ;
2358 rbd_warn(rbd_dev, "%s %llx at %llx (%llx)",
2359 obj_op_name(op_type), obj_request->length,
2360 obj_request->img_offset, obj_request->offset);
2361 rbd_warn(rbd_dev, " result %d xferred %x",
2363 if (!img_request->result)
2364 img_request->result = result;
2366 * Need to end I/O on the entire obj_request worth of
2367 * bytes in case of error.
2369 xferred = obj_request->length;
2372 /* Image object requests don't own their page array */
2374 if (obj_request->type == OBJ_REQUEST_PAGES) {
2375 obj_request->pages = NULL;
2376 obj_request->page_count = 0;
2379 if (img_request_child_test(img_request)) {
2380 rbd_assert(img_request->obj_request != NULL);
2381 more = obj_request->which < img_request->obj_request_count - 1;
2383 rbd_assert(img_request->rq != NULL);
2385 more = blk_update_request(img_request->rq, result, xferred);
2387 __blk_mq_end_request(img_request->rq, result);
2393 static void rbd_img_obj_callback(struct rbd_obj_request *obj_request)
2395 struct rbd_img_request *img_request;
2396 u32 which = obj_request->which;
2399 rbd_assert(obj_request_img_data_test(obj_request));
2400 img_request = obj_request->img_request;
2402 dout("%s: img %p obj %p\n", __func__, img_request, obj_request);
2403 rbd_assert(img_request != NULL);
2404 rbd_assert(img_request->obj_request_count > 0);
2405 rbd_assert(which != BAD_WHICH);
2406 rbd_assert(which < img_request->obj_request_count);
2408 spin_lock_irq(&img_request->completion_lock);
2409 if (which != img_request->next_completion)
2412 for_each_obj_request_from(img_request, obj_request) {
2414 rbd_assert(which < img_request->obj_request_count);
2416 if (!obj_request_done_test(obj_request))
2418 more = rbd_img_obj_end_request(obj_request);
2422 rbd_assert(more ^ (which == img_request->obj_request_count));
2423 img_request->next_completion = which;
2425 spin_unlock_irq(&img_request->completion_lock);
2426 rbd_img_request_put(img_request);
2429 rbd_img_request_complete(img_request);
2433 * Add individual osd ops to the given ceph_osd_request and prepare
2434 * them for submission. num_ops is the current number of
2435 * osd operations already to the object request.
2437 static void rbd_img_obj_request_fill(struct rbd_obj_request *obj_request,
2438 struct ceph_osd_request *osd_request,
2439 enum obj_operation_type op_type,
2440 unsigned int num_ops)
2442 struct rbd_img_request *img_request = obj_request->img_request;
2443 struct rbd_device *rbd_dev = img_request->rbd_dev;
2444 u64 object_size = rbd_obj_bytes(&rbd_dev->header);
2445 u64 offset = obj_request->offset;
2446 u64 length = obj_request->length;
2450 if (op_type == OBJ_OP_DISCARD) {
2451 if (!offset && length == object_size &&
2452 (!img_request_layered_test(img_request) ||
2453 !obj_request_overlaps_parent(obj_request))) {
2454 opcode = CEPH_OSD_OP_DELETE;
2455 } else if ((offset + length == object_size)) {
2456 opcode = CEPH_OSD_OP_TRUNCATE;
2458 down_read(&rbd_dev->header_rwsem);
2459 img_end = rbd_dev->header.image_size;
2460 up_read(&rbd_dev->header_rwsem);
2462 if (obj_request->img_offset + length == img_end)
2463 opcode = CEPH_OSD_OP_TRUNCATE;
2465 opcode = CEPH_OSD_OP_ZERO;
2467 } else if (op_type == OBJ_OP_WRITE) {
2468 if (!offset && length == object_size)
2469 opcode = CEPH_OSD_OP_WRITEFULL;
2471 opcode = CEPH_OSD_OP_WRITE;
2472 osd_req_op_alloc_hint_init(osd_request, num_ops,
2473 object_size, object_size);
2476 opcode = CEPH_OSD_OP_READ;
2479 if (opcode == CEPH_OSD_OP_DELETE)
2480 osd_req_op_init(osd_request, num_ops, opcode, 0);
2482 osd_req_op_extent_init(osd_request, num_ops, opcode,
2483 offset, length, 0, 0);
2485 if (obj_request->type == OBJ_REQUEST_BIO)
2486 osd_req_op_extent_osd_data_bio(osd_request, num_ops,
2487 obj_request->bio_list, length);
2488 else if (obj_request->type == OBJ_REQUEST_PAGES)
2489 osd_req_op_extent_osd_data_pages(osd_request, num_ops,
2490 obj_request->pages, length,
2491 offset & ~PAGE_MASK, false, false);
2493 /* Discards are also writes */
2494 if (op_type == OBJ_OP_WRITE || op_type == OBJ_OP_DISCARD)
2495 rbd_osd_req_format_write(obj_request);
2497 rbd_osd_req_format_read(obj_request);
2501 * Split up an image request into one or more object requests, each
2502 * to a different object. The "type" parameter indicates whether
2503 * "data_desc" is the pointer to the head of a list of bio
2504 * structures, or the base of a page array. In either case this
2505 * function assumes data_desc describes memory sufficient to hold
2506 * all data described by the image request.
2508 static int rbd_img_request_fill(struct rbd_img_request *img_request,
2509 enum obj_request_type type,
2512 struct rbd_device *rbd_dev = img_request->rbd_dev;
2513 struct rbd_obj_request *obj_request = NULL;
2514 struct rbd_obj_request *next_obj_request;
2515 struct bio *bio_list = NULL;
2516 unsigned int bio_offset = 0;
2517 struct page **pages = NULL;
2518 enum obj_operation_type op_type;
2522 dout("%s: img %p type %d data_desc %p\n", __func__, img_request,
2523 (int)type, data_desc);
2525 img_offset = img_request->offset;
2526 resid = img_request->length;
2527 rbd_assert(resid > 0);
2528 op_type = rbd_img_request_op_type(img_request);
2530 if (type == OBJ_REQUEST_BIO) {
2531 bio_list = data_desc;
2532 rbd_assert(img_offset ==
2533 bio_list->bi_iter.bi_sector << SECTOR_SHIFT);
2534 } else if (type == OBJ_REQUEST_PAGES) {
2539 struct ceph_osd_request *osd_req;
2540 const char *object_name;
2544 object_name = rbd_segment_name(rbd_dev, img_offset);
2547 offset = rbd_segment_offset(rbd_dev, img_offset);
2548 length = rbd_segment_length(rbd_dev, img_offset, resid);
2549 obj_request = rbd_obj_request_create(object_name,
2550 offset, length, type);
2551 /* object request has its own copy of the object name */
2552 rbd_segment_name_free(object_name);
2557 * set obj_request->img_request before creating the
2558 * osd_request so that it gets the right snapc
2560 rbd_img_obj_request_add(img_request, obj_request);
2562 if (type == OBJ_REQUEST_BIO) {
2563 unsigned int clone_size;
2565 rbd_assert(length <= (u64)UINT_MAX);
2566 clone_size = (unsigned int)length;
2567 obj_request->bio_list =
2568 bio_chain_clone_range(&bio_list,
2572 if (!obj_request->bio_list)
2574 } else if (type == OBJ_REQUEST_PAGES) {
2575 unsigned int page_count;
2577 obj_request->pages = pages;
2578 page_count = (u32)calc_pages_for(offset, length);
2579 obj_request->page_count = page_count;
2580 if ((offset + length) & ~PAGE_MASK)
2581 page_count--; /* more on last page */
2582 pages += page_count;
2585 osd_req = rbd_osd_req_create(rbd_dev, op_type,
2586 (op_type == OBJ_OP_WRITE) ? 2 : 1,
2591 obj_request->osd_req = osd_req;
2592 obj_request->callback = rbd_img_obj_callback;
2593 obj_request->img_offset = img_offset;
2595 rbd_img_obj_request_fill(obj_request, osd_req, op_type, 0);
2597 img_offset += length;
2604 for_each_obj_request_safe(img_request, obj_request, next_obj_request)
2605 rbd_img_obj_request_del(img_request, obj_request);
2611 rbd_osd_copyup_callback(struct rbd_obj_request *obj_request)
2613 struct rbd_img_request *img_request;
2614 struct rbd_device *rbd_dev;
2615 struct page **pages;
2618 dout("%s: obj %p\n", __func__, obj_request);
2620 rbd_assert(obj_request->type == OBJ_REQUEST_BIO ||
2621 obj_request->type == OBJ_REQUEST_NODATA);
2622 rbd_assert(obj_request_img_data_test(obj_request));
2623 img_request = obj_request->img_request;
2624 rbd_assert(img_request);
2626 rbd_dev = img_request->rbd_dev;
2627 rbd_assert(rbd_dev);
2629 pages = obj_request->copyup_pages;
2630 rbd_assert(pages != NULL);
2631 obj_request->copyup_pages = NULL;
2632 page_count = obj_request->copyup_page_count;
2633 rbd_assert(page_count);
2634 obj_request->copyup_page_count = 0;
2635 ceph_release_page_vector(pages, page_count);
2638 * We want the transfer count to reflect the size of the
2639 * original write request. There is no such thing as a
2640 * successful short write, so if the request was successful
2641 * we can just set it to the originally-requested length.
2643 if (!obj_request->result)
2644 obj_request->xferred = obj_request->length;
2646 obj_request_done_set(obj_request);
2650 rbd_img_obj_parent_read_full_callback(struct rbd_img_request *img_request)
2652 struct rbd_obj_request *orig_request;
2653 struct ceph_osd_request *osd_req;
2654 struct rbd_device *rbd_dev;
2655 struct page **pages;
2656 enum obj_operation_type op_type;
2661 rbd_assert(img_request_child_test(img_request));
2663 /* First get what we need from the image request */
2665 pages = img_request->copyup_pages;
2666 rbd_assert(pages != NULL);
2667 img_request->copyup_pages = NULL;
2668 page_count = img_request->copyup_page_count;
2669 rbd_assert(page_count);
2670 img_request->copyup_page_count = 0;
2672 orig_request = img_request->obj_request;
2673 rbd_assert(orig_request != NULL);
2674 rbd_assert(obj_request_type_valid(orig_request->type));
2675 img_result = img_request->result;
2676 parent_length = img_request->length;
2677 rbd_assert(img_result || parent_length == img_request->xferred);
2678 rbd_img_request_put(img_request);
2680 rbd_assert(orig_request->img_request);
2681 rbd_dev = orig_request->img_request->rbd_dev;
2682 rbd_assert(rbd_dev);
2685 * If the overlap has become 0 (most likely because the
2686 * image has been flattened) we need to free the pages
2687 * and re-submit the original write request.
2689 if (!rbd_dev->parent_overlap) {
2690 ceph_release_page_vector(pages, page_count);
2691 rbd_obj_request_submit(orig_request);
2699 * The original osd request is of no use to use any more.
2700 * We need a new one that can hold the three ops in a copyup
2701 * request. Allocate the new copyup osd request for the
2702 * original request, and release the old one.
2704 img_result = -ENOMEM;
2705 osd_req = rbd_osd_req_create_copyup(orig_request);
2708 rbd_osd_req_destroy(orig_request->osd_req);
2709 orig_request->osd_req = osd_req;
2710 orig_request->copyup_pages = pages;
2711 orig_request->copyup_page_count = page_count;
2713 /* Initialize the copyup op */
2715 osd_req_op_cls_init(osd_req, 0, CEPH_OSD_OP_CALL, "rbd", "copyup");
2716 osd_req_op_cls_request_data_pages(osd_req, 0, pages, parent_length, 0,
2719 /* Add the other op(s) */
2721 op_type = rbd_img_request_op_type(orig_request->img_request);
2722 rbd_img_obj_request_fill(orig_request, osd_req, op_type, 1);
2724 /* All set, send it off. */
2726 rbd_obj_request_submit(orig_request);
2730 ceph_release_page_vector(pages, page_count);
2731 orig_request->result = img_result;
2732 orig_request->xferred = 0;
2733 rbd_img_request_get(orig_request->img_request);
2734 obj_request_done_set(orig_request);
2735 rbd_obj_request_complete(orig_request);
2739 * Read from the parent image the range of data that covers the
2740 * entire target of the given object request. This is used for
2741 * satisfying a layered image write request when the target of an
2742 * object request from the image request does not exist.
2744 * A page array big enough to hold the returned data is allocated
2745 * and supplied to rbd_img_request_fill() as the "data descriptor."
2746 * When the read completes, this page array will be transferred to
2747 * the original object request for the copyup operation.
2749 * If an error occurs, it is recorded as the result of the original
2750 * object request in rbd_img_obj_exists_callback().
2752 static int rbd_img_obj_parent_read_full(struct rbd_obj_request *obj_request)
2754 struct rbd_device *rbd_dev = obj_request->img_request->rbd_dev;
2755 struct rbd_img_request *parent_request = NULL;
2758 struct page **pages = NULL;
2762 rbd_assert(rbd_dev->parent != NULL);
2765 * Determine the byte range covered by the object in the
2766 * child image to which the original request was to be sent.
2768 img_offset = obj_request->img_offset - obj_request->offset;
2769 length = (u64)1 << rbd_dev->header.obj_order;
2772 * There is no defined parent data beyond the parent
2773 * overlap, so limit what we read at that boundary if
2776 if (img_offset + length > rbd_dev->parent_overlap) {
2777 rbd_assert(img_offset < rbd_dev->parent_overlap);
2778 length = rbd_dev->parent_overlap - img_offset;
2782 * Allocate a page array big enough to receive the data read
2785 page_count = (u32)calc_pages_for(0, length);
2786 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2787 if (IS_ERR(pages)) {
2788 result = PTR_ERR(pages);
2794 parent_request = rbd_parent_request_create(obj_request,
2795 img_offset, length);
2796 if (!parent_request)
2799 result = rbd_img_request_fill(parent_request, OBJ_REQUEST_PAGES, pages);
2803 parent_request->copyup_pages = pages;
2804 parent_request->copyup_page_count = page_count;
2805 parent_request->callback = rbd_img_obj_parent_read_full_callback;
2807 result = rbd_img_request_submit(parent_request);
2811 parent_request->copyup_pages = NULL;
2812 parent_request->copyup_page_count = 0;
2813 parent_request->obj_request = NULL;
2814 rbd_obj_request_put(obj_request);
2817 ceph_release_page_vector(pages, page_count);
2819 rbd_img_request_put(parent_request);
2823 static void rbd_img_obj_exists_callback(struct rbd_obj_request *obj_request)
2825 struct rbd_obj_request *orig_request;
2826 struct rbd_device *rbd_dev;
2829 rbd_assert(!obj_request_img_data_test(obj_request));
2832 * All we need from the object request is the original
2833 * request and the result of the STAT op. Grab those, then
2834 * we're done with the request.
2836 orig_request = obj_request->obj_request;
2837 obj_request->obj_request = NULL;
2838 rbd_obj_request_put(orig_request);
2839 rbd_assert(orig_request);
2840 rbd_assert(orig_request->img_request);
2842 result = obj_request->result;
2843 obj_request->result = 0;
2845 dout("%s: obj %p for obj %p result %d %llu/%llu\n", __func__,
2846 obj_request, orig_request, result,
2847 obj_request->xferred, obj_request->length);
2848 rbd_obj_request_put(obj_request);
2851 * If the overlap has become 0 (most likely because the
2852 * image has been flattened) we need to re-submit the
2855 rbd_dev = orig_request->img_request->rbd_dev;
2856 if (!rbd_dev->parent_overlap) {
2857 rbd_obj_request_submit(orig_request);
2862 * Our only purpose here is to determine whether the object
2863 * exists, and we don't want to treat the non-existence as
2864 * an error. If something else comes back, transfer the
2865 * error to the original request and complete it now.
2868 obj_request_existence_set(orig_request, true);
2869 } else if (result == -ENOENT) {
2870 obj_request_existence_set(orig_request, false);
2872 goto fail_orig_request;
2876 * Resubmit the original request now that we have recorded
2877 * whether the target object exists.
2879 result = rbd_img_obj_request_submit(orig_request);
2881 goto fail_orig_request;
2886 orig_request->result = result;
2887 orig_request->xferred = 0;
2888 rbd_img_request_get(orig_request->img_request);
2889 obj_request_done_set(orig_request);
2890 rbd_obj_request_complete(orig_request);
2893 static int rbd_img_obj_exists_submit(struct rbd_obj_request *obj_request)
2895 struct rbd_device *rbd_dev = obj_request->img_request->rbd_dev;
2896 struct rbd_obj_request *stat_request;
2897 struct page **pages = NULL;
2903 * The response data for a STAT call consists of:
2910 size = sizeof (__le64) + sizeof (__le32) + sizeof (__le32);
2911 page_count = (u32)calc_pages_for(0, size);
2912 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2914 return PTR_ERR(pages);
2917 stat_request = rbd_obj_request_create(obj_request->object_name, 0, 0,
2922 rbd_obj_request_get(obj_request);
2923 stat_request->obj_request = obj_request;
2924 stat_request->pages = pages;
2925 stat_request->page_count = page_count;
2927 stat_request->osd_req = rbd_osd_req_create(rbd_dev, OBJ_OP_READ, 1,
2929 if (!stat_request->osd_req)
2931 stat_request->callback = rbd_img_obj_exists_callback;
2933 osd_req_op_init(stat_request->osd_req, 0, CEPH_OSD_OP_STAT, 0);
2934 osd_req_op_raw_data_in_pages(stat_request->osd_req, 0, pages, size, 0,
2936 rbd_osd_req_format_read(stat_request);
2938 rbd_obj_request_submit(stat_request);
2943 rbd_obj_request_put(obj_request);
2948 static bool img_obj_request_simple(struct rbd_obj_request *obj_request)
2950 struct rbd_img_request *img_request = obj_request->img_request;
2951 struct rbd_device *rbd_dev = img_request->rbd_dev;
2954 if (!img_request_write_test(img_request) &&
2955 !img_request_discard_test(img_request))
2958 /* Non-layered writes */
2959 if (!img_request_layered_test(img_request))
2963 * Layered writes outside of the parent overlap range don't
2964 * share any data with the parent.
2966 if (!obj_request_overlaps_parent(obj_request))
2970 * Entire-object layered writes - we will overwrite whatever
2971 * parent data there is anyway.
2973 if (!obj_request->offset &&
2974 obj_request->length == rbd_obj_bytes(&rbd_dev->header))
2978 * If the object is known to already exist, its parent data has
2979 * already been copied.
2981 if (obj_request_known_test(obj_request) &&
2982 obj_request_exists_test(obj_request))
2988 static int rbd_img_obj_request_submit(struct rbd_obj_request *obj_request)
2990 rbd_assert(obj_request_img_data_test(obj_request));
2991 rbd_assert(obj_request_type_valid(obj_request->type));
2992 rbd_assert(obj_request->img_request);
2994 if (img_obj_request_simple(obj_request)) {
2995 rbd_obj_request_submit(obj_request);
3000 * It's a layered write. The target object might exist but
3001 * we may not know that yet. If we know it doesn't exist,
3002 * start by reading the data for the full target object from
3003 * the parent so we can use it for a copyup to the target.
3005 if (obj_request_known_test(obj_request))
3006 return rbd_img_obj_parent_read_full(obj_request);
3008 /* We don't know whether the target exists. Go find out. */
3010 return rbd_img_obj_exists_submit(obj_request);
3013 static int rbd_img_request_submit(struct rbd_img_request *img_request)
3015 struct rbd_obj_request *obj_request;
3016 struct rbd_obj_request *next_obj_request;
3019 dout("%s: img %p\n", __func__, img_request);
3021 rbd_img_request_get(img_request);
3022 for_each_obj_request_safe(img_request, obj_request, next_obj_request) {
3023 ret = rbd_img_obj_request_submit(obj_request);
3029 rbd_img_request_put(img_request);
3033 static void rbd_img_parent_read_callback(struct rbd_img_request *img_request)
3035 struct rbd_obj_request *obj_request;
3036 struct rbd_device *rbd_dev;
3041 rbd_assert(img_request_child_test(img_request));
3043 /* First get what we need from the image request and release it */
3045 obj_request = img_request->obj_request;
3046 img_xferred = img_request->xferred;
3047 img_result = img_request->result;
3048 rbd_img_request_put(img_request);
3051 * If the overlap has become 0 (most likely because the
3052 * image has been flattened) we need to re-submit the
3055 rbd_assert(obj_request);
3056 rbd_assert(obj_request->img_request);
3057 rbd_dev = obj_request->img_request->rbd_dev;
3058 if (!rbd_dev->parent_overlap) {
3059 rbd_obj_request_submit(obj_request);
3063 obj_request->result = img_result;
3064 if (obj_request->result)
3068 * We need to zero anything beyond the parent overlap
3069 * boundary. Since rbd_img_obj_request_read_callback()
3070 * will zero anything beyond the end of a short read, an
3071 * easy way to do this is to pretend the data from the
3072 * parent came up short--ending at the overlap boundary.
3074 rbd_assert(obj_request->img_offset < U64_MAX - obj_request->length);
3075 obj_end = obj_request->img_offset + obj_request->length;
3076 if (obj_end > rbd_dev->parent_overlap) {
3079 if (obj_request->img_offset < rbd_dev->parent_overlap)
3080 xferred = rbd_dev->parent_overlap -
3081 obj_request->img_offset;
3083 obj_request->xferred = min(img_xferred, xferred);
3085 obj_request->xferred = img_xferred;
3088 rbd_img_obj_request_read_callback(obj_request);
3089 rbd_obj_request_complete(obj_request);
3092 static void rbd_img_parent_read(struct rbd_obj_request *obj_request)
3094 struct rbd_img_request *img_request;
3097 rbd_assert(obj_request_img_data_test(obj_request));
3098 rbd_assert(obj_request->img_request != NULL);
3099 rbd_assert(obj_request->result == (s32) -ENOENT);
3100 rbd_assert(obj_request_type_valid(obj_request->type));
3102 /* rbd_read_finish(obj_request, obj_request->length); */
3103 img_request = rbd_parent_request_create(obj_request,
3104 obj_request->img_offset,
3105 obj_request->length);
3110 if (obj_request->type == OBJ_REQUEST_BIO)
3111 result = rbd_img_request_fill(img_request, OBJ_REQUEST_BIO,
3112 obj_request->bio_list);
3114 result = rbd_img_request_fill(img_request, OBJ_REQUEST_PAGES,
3115 obj_request->pages);
3119 img_request->callback = rbd_img_parent_read_callback;
3120 result = rbd_img_request_submit(img_request);
3127 rbd_img_request_put(img_request);
3128 obj_request->result = result;
3129 obj_request->xferred = 0;
3130 obj_request_done_set(obj_request);
3133 static const struct rbd_client_id rbd_empty_cid;
3135 static bool rbd_cid_equal(const struct rbd_client_id *lhs,
3136 const struct rbd_client_id *rhs)
3138 return lhs->gid == rhs->gid && lhs->handle == rhs->handle;
3141 static struct rbd_client_id rbd_get_cid(struct rbd_device *rbd_dev)
3143 struct rbd_client_id cid;
3145 mutex_lock(&rbd_dev->watch_mutex);
3146 cid.gid = ceph_client_gid(rbd_dev->rbd_client->client);
3147 cid.handle = rbd_dev->watch_cookie;
3148 mutex_unlock(&rbd_dev->watch_mutex);
3153 * lock_rwsem must be held for write
3155 static void rbd_set_owner_cid(struct rbd_device *rbd_dev,
3156 const struct rbd_client_id *cid)
3158 dout("%s rbd_dev %p %llu-%llu -> %llu-%llu\n", __func__, rbd_dev,
3159 rbd_dev->owner_cid.gid, rbd_dev->owner_cid.handle,
3160 cid->gid, cid->handle);
3161 rbd_dev->owner_cid = *cid; /* struct */
3164 static void format_lock_cookie(struct rbd_device *rbd_dev, char *buf)
3166 mutex_lock(&rbd_dev->watch_mutex);
3167 sprintf(buf, "%s %llu", RBD_LOCK_COOKIE_PREFIX, rbd_dev->watch_cookie);
3168 mutex_unlock(&rbd_dev->watch_mutex);
3172 * lock_rwsem must be held for write
3174 static int rbd_lock(struct rbd_device *rbd_dev)
3176 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3177 struct rbd_client_id cid = rbd_get_cid(rbd_dev);
3181 WARN_ON(__rbd_is_lock_owner(rbd_dev));
3183 format_lock_cookie(rbd_dev, cookie);
3184 ret = ceph_cls_lock(osdc, &rbd_dev->header_oid, &rbd_dev->header_oloc,
3185 RBD_LOCK_NAME, CEPH_CLS_LOCK_EXCLUSIVE, cookie,
3186 RBD_LOCK_TAG, "", 0);
3190 rbd_dev->lock_state = RBD_LOCK_STATE_LOCKED;
3191 rbd_set_owner_cid(rbd_dev, &cid);
3192 queue_work(rbd_dev->task_wq, &rbd_dev->acquired_lock_work);
3197 * lock_rwsem must be held for write
3199 static int rbd_unlock(struct rbd_device *rbd_dev)
3201 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3205 WARN_ON(!__rbd_is_lock_owner(rbd_dev));
3207 rbd_dev->lock_state = RBD_LOCK_STATE_UNLOCKED;
3209 format_lock_cookie(rbd_dev, cookie);
3210 ret = ceph_cls_unlock(osdc, &rbd_dev->header_oid, &rbd_dev->header_oloc,
3211 RBD_LOCK_NAME, cookie);
3212 if (ret && ret != -ENOENT) {
3213 rbd_warn(rbd_dev, "cls_unlock failed: %d", ret);
3217 rbd_set_owner_cid(rbd_dev, &rbd_empty_cid);
3218 queue_work(rbd_dev->task_wq, &rbd_dev->released_lock_work);
3222 static int __rbd_notify_op_lock(struct rbd_device *rbd_dev,
3223 enum rbd_notify_op notify_op,
3224 struct page ***preply_pages,
3227 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3228 struct rbd_client_id cid = rbd_get_cid(rbd_dev);
3229 int buf_size = 4 + 8 + 8 + CEPH_ENCODING_START_BLK_LEN;
3233 dout("%s rbd_dev %p notify_op %d\n", __func__, rbd_dev, notify_op);
3235 /* encode *LockPayload NotifyMessage (op + ClientId) */
3236 ceph_start_encoding(&p, 2, 1, buf_size - CEPH_ENCODING_START_BLK_LEN);
3237 ceph_encode_32(&p, notify_op);
3238 ceph_encode_64(&p, cid.gid);
3239 ceph_encode_64(&p, cid.handle);
3241 return ceph_osdc_notify(osdc, &rbd_dev->header_oid,
3242 &rbd_dev->header_oloc, buf, buf_size,
3243 RBD_NOTIFY_TIMEOUT, preply_pages, preply_len);
3246 static void rbd_notify_op_lock(struct rbd_device *rbd_dev,
3247 enum rbd_notify_op notify_op)
3249 struct page **reply_pages;
3252 __rbd_notify_op_lock(rbd_dev, notify_op, &reply_pages, &reply_len);
3253 ceph_release_page_vector(reply_pages, calc_pages_for(0, reply_len));
3256 static void rbd_notify_acquired_lock(struct work_struct *work)
3258 struct rbd_device *rbd_dev = container_of(work, struct rbd_device,
3259 acquired_lock_work);
3261 rbd_notify_op_lock(rbd_dev, RBD_NOTIFY_OP_ACQUIRED_LOCK);
3264 static void rbd_notify_released_lock(struct work_struct *work)
3266 struct rbd_device *rbd_dev = container_of(work, struct rbd_device,
3267 released_lock_work);
3269 rbd_notify_op_lock(rbd_dev, RBD_NOTIFY_OP_RELEASED_LOCK);
3272 static int rbd_request_lock(struct rbd_device *rbd_dev)
3274 struct page **reply_pages;
3276 bool lock_owner_responded = false;
3279 dout("%s rbd_dev %p\n", __func__, rbd_dev);
3281 ret = __rbd_notify_op_lock(rbd_dev, RBD_NOTIFY_OP_REQUEST_LOCK,
3282 &reply_pages, &reply_len);
3283 if (ret && ret != -ETIMEDOUT) {
3284 rbd_warn(rbd_dev, "failed to request lock: %d", ret);
3288 if (reply_len > 0 && reply_len <= PAGE_SIZE) {
3289 void *p = page_address(reply_pages[0]);
3290 void *const end = p + reply_len;
3293 ceph_decode_32_safe(&p, end, n, e_inval); /* num_acks */
3298 ceph_decode_need(&p, end, 8 + 8, e_inval);
3299 p += 8 + 8; /* skip gid and cookie */
3301 ceph_decode_32_safe(&p, end, len, e_inval);
3305 if (lock_owner_responded) {
3307 "duplicate lock owners detected");
3312 lock_owner_responded = true;
3313 ret = ceph_start_decoding(&p, end, 1, "ResponseMessage",
3317 "failed to decode ResponseMessage: %d",
3322 ret = ceph_decode_32(&p);
3326 if (!lock_owner_responded) {
3327 rbd_warn(rbd_dev, "no lock owners detected");
3332 ceph_release_page_vector(reply_pages, calc_pages_for(0, reply_len));
3340 static void wake_requests(struct rbd_device *rbd_dev, bool wake_all)
3342 dout("%s rbd_dev %p wake_all %d\n", __func__, rbd_dev, wake_all);
3344 cancel_delayed_work(&rbd_dev->lock_dwork);
3346 wake_up_all(&rbd_dev->lock_waitq);
3348 wake_up(&rbd_dev->lock_waitq);
3351 static int get_lock_owner_info(struct rbd_device *rbd_dev,
3352 struct ceph_locker **lockers, u32 *num_lockers)
3354 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3359 dout("%s rbd_dev %p\n", __func__, rbd_dev);
3361 ret = ceph_cls_lock_info(osdc, &rbd_dev->header_oid,
3362 &rbd_dev->header_oloc, RBD_LOCK_NAME,
3363 &lock_type, &lock_tag, lockers, num_lockers);
3367 if (*num_lockers == 0) {
3368 dout("%s rbd_dev %p no lockers detected\n", __func__, rbd_dev);
3372 if (strcmp(lock_tag, RBD_LOCK_TAG)) {
3373 rbd_warn(rbd_dev, "locked by external mechanism, tag %s",
3379 if (lock_type == CEPH_CLS_LOCK_SHARED) {
3380 rbd_warn(rbd_dev, "shared lock type detected");
3385 if (strncmp((*lockers)[0].id.cookie, RBD_LOCK_COOKIE_PREFIX,
3386 strlen(RBD_LOCK_COOKIE_PREFIX))) {
3387 rbd_warn(rbd_dev, "locked by external mechanism, cookie %s",
3388 (*lockers)[0].id.cookie);
3398 static int find_watcher(struct rbd_device *rbd_dev,
3399 const struct ceph_locker *locker)
3401 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3402 struct ceph_watch_item *watchers;
3408 ret = ceph_osdc_list_watchers(osdc, &rbd_dev->header_oid,
3409 &rbd_dev->header_oloc, &watchers,
3414 sscanf(locker->id.cookie, RBD_LOCK_COOKIE_PREFIX " %llu", &cookie);
3415 for (i = 0; i < num_watchers; i++) {
3416 if (!memcmp(&watchers[i].addr, &locker->info.addr,
3417 sizeof(locker->info.addr)) &&
3418 watchers[i].cookie == cookie) {
3419 struct rbd_client_id cid = {
3420 .gid = le64_to_cpu(watchers[i].name.num),
3424 dout("%s rbd_dev %p found cid %llu-%llu\n", __func__,
3425 rbd_dev, cid.gid, cid.handle);
3426 rbd_set_owner_cid(rbd_dev, &cid);
3432 dout("%s rbd_dev %p no watchers\n", __func__, rbd_dev);
3440 * lock_rwsem must be held for write
3442 static int rbd_try_lock(struct rbd_device *rbd_dev)
3444 struct ceph_client *client = rbd_dev->rbd_client->client;
3445 struct ceph_locker *lockers;
3450 ret = rbd_lock(rbd_dev);
3454 /* determine if the current lock holder is still alive */
3455 ret = get_lock_owner_info(rbd_dev, &lockers, &num_lockers);
3459 if (num_lockers == 0)
3462 ret = find_watcher(rbd_dev, lockers);
3465 ret = 0; /* have to request lock */
3469 rbd_warn(rbd_dev, "%s%llu seems dead, breaking lock",
3470 ENTITY_NAME(lockers[0].id.name));
3472 ret = ceph_monc_blacklist_add(&client->monc,
3473 &lockers[0].info.addr);
3475 rbd_warn(rbd_dev, "blacklist of %s%llu failed: %d",
3476 ENTITY_NAME(lockers[0].id.name), ret);
3480 ret = ceph_cls_break_lock(&client->osdc, &rbd_dev->header_oid,
3481 &rbd_dev->header_oloc, RBD_LOCK_NAME,
3482 lockers[0].id.cookie,
3483 &lockers[0].id.name);
3484 if (ret && ret != -ENOENT)
3488 ceph_free_lockers(lockers, num_lockers);
3492 ceph_free_lockers(lockers, num_lockers);
3497 * ret is set only if lock_state is RBD_LOCK_STATE_UNLOCKED
3499 static enum rbd_lock_state rbd_try_acquire_lock(struct rbd_device *rbd_dev,
3502 enum rbd_lock_state lock_state;
3504 down_read(&rbd_dev->lock_rwsem);
3505 dout("%s rbd_dev %p read lock_state %d\n", __func__, rbd_dev,
3506 rbd_dev->lock_state);
3507 if (__rbd_is_lock_owner(rbd_dev)) {
3508 lock_state = rbd_dev->lock_state;
3509 up_read(&rbd_dev->lock_rwsem);
3513 up_read(&rbd_dev->lock_rwsem);
3514 down_write(&rbd_dev->lock_rwsem);
3515 dout("%s rbd_dev %p write lock_state %d\n", __func__, rbd_dev,
3516 rbd_dev->lock_state);
3517 if (!__rbd_is_lock_owner(rbd_dev)) {
3518 *pret = rbd_try_lock(rbd_dev);
3520 rbd_warn(rbd_dev, "failed to acquire lock: %d", *pret);
3523 lock_state = rbd_dev->lock_state;
3524 up_write(&rbd_dev->lock_rwsem);
3528 static void rbd_acquire_lock(struct work_struct *work)
3530 struct rbd_device *rbd_dev = container_of(to_delayed_work(work),
3531 struct rbd_device, lock_dwork);
3532 enum rbd_lock_state lock_state;
3535 dout("%s rbd_dev %p\n", __func__, rbd_dev);
3537 lock_state = rbd_try_acquire_lock(rbd_dev, &ret);
3538 if (lock_state != RBD_LOCK_STATE_UNLOCKED || ret == -EBLACKLISTED) {
3539 if (lock_state == RBD_LOCK_STATE_LOCKED)
3540 wake_requests(rbd_dev, true);
3541 dout("%s rbd_dev %p lock_state %d ret %d - done\n", __func__,
3542 rbd_dev, lock_state, ret);
3546 ret = rbd_request_lock(rbd_dev);
3547 if (ret == -ETIMEDOUT) {
3548 goto again; /* treat this as a dead client */
3549 } else if (ret < 0) {
3550 rbd_warn(rbd_dev, "error requesting lock: %d", ret);
3551 mod_delayed_work(rbd_dev->task_wq, &rbd_dev->lock_dwork,
3555 * lock owner acked, but resend if we don't see them
3558 dout("%s rbd_dev %p requeueing lock_dwork\n", __func__,
3560 mod_delayed_work(rbd_dev->task_wq, &rbd_dev->lock_dwork,
3561 msecs_to_jiffies(2 * RBD_NOTIFY_TIMEOUT * MSEC_PER_SEC));
3566 * lock_rwsem must be held for write
3568 static bool rbd_release_lock(struct rbd_device *rbd_dev)
3570 dout("%s rbd_dev %p read lock_state %d\n", __func__, rbd_dev,
3571 rbd_dev->lock_state);
3572 if (rbd_dev->lock_state != RBD_LOCK_STATE_LOCKED)
3575 rbd_dev->lock_state = RBD_LOCK_STATE_RELEASING;
3576 downgrade_write(&rbd_dev->lock_rwsem);
3578 * Ensure that all in-flight IO is flushed.
3580 * FIXME: ceph_osdc_sync() flushes the entire OSD client, which
3581 * may be shared with other devices.
3583 ceph_osdc_sync(&rbd_dev->rbd_client->client->osdc);
3584 up_read(&rbd_dev->lock_rwsem);
3586 down_write(&rbd_dev->lock_rwsem);
3587 dout("%s rbd_dev %p write lock_state %d\n", __func__, rbd_dev,
3588 rbd_dev->lock_state);
3589 if (rbd_dev->lock_state != RBD_LOCK_STATE_RELEASING)
3592 if (!rbd_unlock(rbd_dev))
3594 * Give others a chance to grab the lock - we would re-acquire
3595 * almost immediately if we got new IO during ceph_osdc_sync()
3596 * otherwise. We need to ack our own notifications, so this
3597 * lock_dwork will be requeued from rbd_wait_state_locked()
3598 * after wake_requests() in rbd_handle_released_lock().
3600 cancel_delayed_work(&rbd_dev->lock_dwork);
3605 static void rbd_release_lock_work(struct work_struct *work)
3607 struct rbd_device *rbd_dev = container_of(work, struct rbd_device,
3610 down_write(&rbd_dev->lock_rwsem);
3611 rbd_release_lock(rbd_dev);
3612 up_write(&rbd_dev->lock_rwsem);
3615 static void rbd_handle_acquired_lock(struct rbd_device *rbd_dev, u8 struct_v,
3618 struct rbd_client_id cid = { 0 };
3620 if (struct_v >= 2) {
3621 cid.gid = ceph_decode_64(p);
3622 cid.handle = ceph_decode_64(p);
3625 dout("%s rbd_dev %p cid %llu-%llu\n", __func__, rbd_dev, cid.gid,
3627 if (!rbd_cid_equal(&cid, &rbd_empty_cid)) {
3628 down_write(&rbd_dev->lock_rwsem);
3629 if (rbd_cid_equal(&cid, &rbd_dev->owner_cid)) {
3631 * we already know that the remote client is
3634 up_write(&rbd_dev->lock_rwsem);
3638 rbd_set_owner_cid(rbd_dev, &cid);
3639 downgrade_write(&rbd_dev->lock_rwsem);
3641 down_read(&rbd_dev->lock_rwsem);
3644 if (!__rbd_is_lock_owner(rbd_dev))
3645 wake_requests(rbd_dev, false);
3646 up_read(&rbd_dev->lock_rwsem);
3649 static void rbd_handle_released_lock(struct rbd_device *rbd_dev, u8 struct_v,
3652 struct rbd_client_id cid = { 0 };
3654 if (struct_v >= 2) {
3655 cid.gid = ceph_decode_64(p);
3656 cid.handle = ceph_decode_64(p);
3659 dout("%s rbd_dev %p cid %llu-%llu\n", __func__, rbd_dev, cid.gid,
3661 if (!rbd_cid_equal(&cid, &rbd_empty_cid)) {
3662 down_write(&rbd_dev->lock_rwsem);
3663 if (!rbd_cid_equal(&cid, &rbd_dev->owner_cid)) {
3664 dout("%s rbd_dev %p unexpected owner, cid %llu-%llu != owner_cid %llu-%llu\n",
3665 __func__, rbd_dev, cid.gid, cid.handle,
3666 rbd_dev->owner_cid.gid, rbd_dev->owner_cid.handle);
3667 up_write(&rbd_dev->lock_rwsem);
3671 rbd_set_owner_cid(rbd_dev, &rbd_empty_cid);
3672 downgrade_write(&rbd_dev->lock_rwsem);
3674 down_read(&rbd_dev->lock_rwsem);
3677 if (!__rbd_is_lock_owner(rbd_dev))
3678 wake_requests(rbd_dev, false);
3679 up_read(&rbd_dev->lock_rwsem);
3682 static bool rbd_handle_request_lock(struct rbd_device *rbd_dev, u8 struct_v,
3685 struct rbd_client_id my_cid = rbd_get_cid(rbd_dev);
3686 struct rbd_client_id cid = { 0 };
3689 if (struct_v >= 2) {
3690 cid.gid = ceph_decode_64(p);
3691 cid.handle = ceph_decode_64(p);
3694 dout("%s rbd_dev %p cid %llu-%llu\n", __func__, rbd_dev, cid.gid,
3696 if (rbd_cid_equal(&cid, &my_cid))
3699 down_read(&rbd_dev->lock_rwsem);
3700 need_to_send = __rbd_is_lock_owner(rbd_dev);
3701 if (rbd_dev->lock_state == RBD_LOCK_STATE_LOCKED) {
3702 if (!rbd_cid_equal(&rbd_dev->owner_cid, &rbd_empty_cid)) {
3703 dout("%s rbd_dev %p queueing unlock_work\n", __func__,
3705 queue_work(rbd_dev->task_wq, &rbd_dev->unlock_work);
3708 up_read(&rbd_dev->lock_rwsem);
3709 return need_to_send;
3712 static void __rbd_acknowledge_notify(struct rbd_device *rbd_dev,
3713 u64 notify_id, u64 cookie, s32 *result)
3715 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3716 int buf_size = 4 + CEPH_ENCODING_START_BLK_LEN;
3723 /* encode ResponseMessage */
3724 ceph_start_encoding(&p, 1, 1,
3725 buf_size - CEPH_ENCODING_START_BLK_LEN);
3726 ceph_encode_32(&p, *result);
3731 ret = ceph_osdc_notify_ack(osdc, &rbd_dev->header_oid,
3732 &rbd_dev->header_oloc, notify_id, cookie,
3735 rbd_warn(rbd_dev, "acknowledge_notify failed: %d", ret);
3738 static void rbd_acknowledge_notify(struct rbd_device *rbd_dev, u64 notify_id,
3741 dout("%s rbd_dev %p\n", __func__, rbd_dev);
3742 __rbd_acknowledge_notify(rbd_dev, notify_id, cookie, NULL);
3745 static void rbd_acknowledge_notify_result(struct rbd_device *rbd_dev,
3746 u64 notify_id, u64 cookie, s32 result)
3748 dout("%s rbd_dev %p result %d\n", __func__, rbd_dev, result);
3749 __rbd_acknowledge_notify(rbd_dev, notify_id, cookie, &result);
3752 static void rbd_watch_cb(void *arg, u64 notify_id, u64 cookie,
3753 u64 notifier_id, void *data, size_t data_len)
3755 struct rbd_device *rbd_dev = arg;
3757 void *const end = p + data_len;
3763 dout("%s rbd_dev %p cookie %llu notify_id %llu data_len %zu\n",
3764 __func__, rbd_dev, cookie, notify_id, data_len);
3766 ret = ceph_start_decoding(&p, end, 1, "NotifyMessage",
3769 rbd_warn(rbd_dev, "failed to decode NotifyMessage: %d",
3774 notify_op = ceph_decode_32(&p);
3776 /* legacy notification for header updates */
3777 notify_op = RBD_NOTIFY_OP_HEADER_UPDATE;
3781 dout("%s rbd_dev %p notify_op %u\n", __func__, rbd_dev, notify_op);
3782 switch (notify_op) {
3783 case RBD_NOTIFY_OP_ACQUIRED_LOCK:
3784 rbd_handle_acquired_lock(rbd_dev, struct_v, &p);
3785 rbd_acknowledge_notify(rbd_dev, notify_id, cookie);
3787 case RBD_NOTIFY_OP_RELEASED_LOCK:
3788 rbd_handle_released_lock(rbd_dev, struct_v, &p);
3789 rbd_acknowledge_notify(rbd_dev, notify_id, cookie);
3791 case RBD_NOTIFY_OP_REQUEST_LOCK:
3792 if (rbd_handle_request_lock(rbd_dev, struct_v, &p))
3794 * send ResponseMessage(0) back so the client
3795 * can detect a missing owner
3797 rbd_acknowledge_notify_result(rbd_dev, notify_id,
3800 rbd_acknowledge_notify(rbd_dev, notify_id, cookie);
3802 case RBD_NOTIFY_OP_HEADER_UPDATE:
3803 ret = rbd_dev_refresh(rbd_dev);
3805 rbd_warn(rbd_dev, "refresh failed: %d", ret);
3807 rbd_acknowledge_notify(rbd_dev, notify_id, cookie);
3810 if (rbd_is_lock_owner(rbd_dev))
3811 rbd_acknowledge_notify_result(rbd_dev, notify_id,
3812 cookie, -EOPNOTSUPP);
3814 rbd_acknowledge_notify(rbd_dev, notify_id, cookie);
3819 static void __rbd_unregister_watch(struct rbd_device *rbd_dev);
3821 static void rbd_watch_errcb(void *arg, u64 cookie, int err)
3823 struct rbd_device *rbd_dev = arg;
3825 rbd_warn(rbd_dev, "encountered watch error: %d", err);
3827 down_write(&rbd_dev->lock_rwsem);
3828 rbd_set_owner_cid(rbd_dev, &rbd_empty_cid);
3829 up_write(&rbd_dev->lock_rwsem);
3831 mutex_lock(&rbd_dev->watch_mutex);
3832 if (rbd_dev->watch_state == RBD_WATCH_STATE_REGISTERED) {
3833 __rbd_unregister_watch(rbd_dev);
3834 rbd_dev->watch_state = RBD_WATCH_STATE_ERROR;
3836 queue_delayed_work(rbd_dev->task_wq, &rbd_dev->watch_dwork, 0);
3838 mutex_unlock(&rbd_dev->watch_mutex);
3842 * watch_mutex must be locked
3844 static int __rbd_register_watch(struct rbd_device *rbd_dev)
3846 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3847 struct ceph_osd_linger_request *handle;
3849 rbd_assert(!rbd_dev->watch_handle);
3850 dout("%s rbd_dev %p\n", __func__, rbd_dev);
3852 handle = ceph_osdc_watch(osdc, &rbd_dev->header_oid,
3853 &rbd_dev->header_oloc, rbd_watch_cb,
3854 rbd_watch_errcb, rbd_dev);
3856 return PTR_ERR(handle);
3858 rbd_dev->watch_handle = handle;
3863 * watch_mutex must be locked
3865 static void __rbd_unregister_watch(struct rbd_device *rbd_dev)
3867 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3870 rbd_assert(rbd_dev->watch_handle);
3871 dout("%s rbd_dev %p\n", __func__, rbd_dev);
3873 ret = ceph_osdc_unwatch(osdc, rbd_dev->watch_handle);
3875 rbd_warn(rbd_dev, "failed to unwatch: %d", ret);
3877 rbd_dev->watch_handle = NULL;
3880 static int rbd_register_watch(struct rbd_device *rbd_dev)
3884 mutex_lock(&rbd_dev->watch_mutex);
3885 rbd_assert(rbd_dev->watch_state == RBD_WATCH_STATE_UNREGISTERED);
3886 ret = __rbd_register_watch(rbd_dev);
3890 rbd_dev->watch_state = RBD_WATCH_STATE_REGISTERED;
3891 rbd_dev->watch_cookie = rbd_dev->watch_handle->linger_id;
3894 mutex_unlock(&rbd_dev->watch_mutex);
3898 static void cancel_tasks_sync(struct rbd_device *rbd_dev)
3900 dout("%s rbd_dev %p\n", __func__, rbd_dev);
3902 cancel_delayed_work_sync(&rbd_dev->watch_dwork);
3903 cancel_work_sync(&rbd_dev->acquired_lock_work);
3904 cancel_work_sync(&rbd_dev->released_lock_work);
3905 cancel_delayed_work_sync(&rbd_dev->lock_dwork);
3906 cancel_work_sync(&rbd_dev->unlock_work);
3909 static void rbd_unregister_watch(struct rbd_device *rbd_dev)
3911 WARN_ON(waitqueue_active(&rbd_dev->lock_waitq));
3912 cancel_tasks_sync(rbd_dev);
3914 mutex_lock(&rbd_dev->watch_mutex);
3915 if (rbd_dev->watch_state == RBD_WATCH_STATE_REGISTERED)
3916 __rbd_unregister_watch(rbd_dev);
3917 rbd_dev->watch_state = RBD_WATCH_STATE_UNREGISTERED;
3918 mutex_unlock(&rbd_dev->watch_mutex);
3920 ceph_osdc_flush_notifies(&rbd_dev->rbd_client->client->osdc);
3923 static void rbd_reregister_watch(struct work_struct *work)
3925 struct rbd_device *rbd_dev = container_of(to_delayed_work(work),
3926 struct rbd_device, watch_dwork);
3927 bool was_lock_owner = false;
3930 dout("%s rbd_dev %p\n", __func__, rbd_dev);
3932 down_write(&rbd_dev->lock_rwsem);
3933 if (rbd_dev->lock_state == RBD_LOCK_STATE_LOCKED)
3934 was_lock_owner = rbd_release_lock(rbd_dev);
3936 mutex_lock(&rbd_dev->watch_mutex);
3937 if (rbd_dev->watch_state != RBD_WATCH_STATE_ERROR)
3940 ret = __rbd_register_watch(rbd_dev);
3942 rbd_warn(rbd_dev, "failed to reregister watch: %d", ret);
3943 if (ret != -EBLACKLISTED)
3944 queue_delayed_work(rbd_dev->task_wq,
3945 &rbd_dev->watch_dwork,
3950 rbd_dev->watch_state = RBD_WATCH_STATE_REGISTERED;
3951 rbd_dev->watch_cookie = rbd_dev->watch_handle->linger_id;
3952 mutex_unlock(&rbd_dev->watch_mutex);
3954 ret = rbd_dev_refresh(rbd_dev);
3956 rbd_warn(rbd_dev, "reregisteration refresh failed: %d", ret);
3958 if (was_lock_owner) {
3959 ret = rbd_try_lock(rbd_dev);
3961 rbd_warn(rbd_dev, "reregisteration lock failed: %d",
3965 up_write(&rbd_dev->lock_rwsem);
3966 wake_requests(rbd_dev, true);
3970 mutex_unlock(&rbd_dev->watch_mutex);
3971 up_write(&rbd_dev->lock_rwsem);
3975 * Synchronous osd object method call. Returns the number of bytes
3976 * returned in the outbound buffer, or a negative error code.
3978 static int rbd_obj_method_sync(struct rbd_device *rbd_dev,
3979 const char *object_name,
3980 const char *class_name,
3981 const char *method_name,
3982 const void *outbound,
3983 size_t outbound_size,
3985 size_t inbound_size)
3987 struct rbd_obj_request *obj_request;
3988 struct page **pages;
3993 * Method calls are ultimately read operations. The result
3994 * should placed into the inbound buffer provided. They
3995 * also supply outbound data--parameters for the object
3996 * method. Currently if this is present it will be a
3999 page_count = (u32)calc_pages_for(0, inbound_size);
4000 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
4002 return PTR_ERR(pages);
4005 obj_request = rbd_obj_request_create(object_name, 0, inbound_size,
4010 obj_request->pages = pages;
4011 obj_request->page_count = page_count;
4013 obj_request->osd_req = rbd_osd_req_create(rbd_dev, OBJ_OP_READ, 1,
4015 if (!obj_request->osd_req)
4018 osd_req_op_cls_init(obj_request->osd_req, 0, CEPH_OSD_OP_CALL,
4019 class_name, method_name);
4020 if (outbound_size) {
4021 struct ceph_pagelist *pagelist;
4023 pagelist = kmalloc(sizeof (*pagelist), GFP_NOFS);
4027 ceph_pagelist_init(pagelist);
4028 ceph_pagelist_append(pagelist, outbound, outbound_size);
4029 osd_req_op_cls_request_data_pagelist(obj_request->osd_req, 0,
4032 osd_req_op_cls_response_data_pages(obj_request->osd_req, 0,
4033 obj_request->pages, inbound_size,
4035 rbd_osd_req_format_read(obj_request);
4037 rbd_obj_request_submit(obj_request);
4038 ret = rbd_obj_request_wait(obj_request);
4042 ret = obj_request->result;
4046 rbd_assert(obj_request->xferred < (u64)INT_MAX);
4047 ret = (int)obj_request->xferred;
4048 ceph_copy_from_page_vector(pages, inbound, 0, obj_request->xferred);
4051 rbd_obj_request_put(obj_request);
4053 ceph_release_page_vector(pages, page_count);
4059 * lock_rwsem must be held for read
4061 static void rbd_wait_state_locked(struct rbd_device *rbd_dev)
4067 * Note the use of mod_delayed_work() in rbd_acquire_lock()
4068 * and cancel_delayed_work() in wake_requests().
4070 dout("%s rbd_dev %p queueing lock_dwork\n", __func__, rbd_dev);
4071 queue_delayed_work(rbd_dev->task_wq, &rbd_dev->lock_dwork, 0);
4072 prepare_to_wait_exclusive(&rbd_dev->lock_waitq, &wait,
4073 TASK_UNINTERRUPTIBLE);
4074 up_read(&rbd_dev->lock_rwsem);
4076 down_read(&rbd_dev->lock_rwsem);
4077 } while (rbd_dev->lock_state != RBD_LOCK_STATE_LOCKED);
4078 finish_wait(&rbd_dev->lock_waitq, &wait);
4081 static void rbd_queue_workfn(struct work_struct *work)
4083 struct request *rq = blk_mq_rq_from_pdu(work);
4084 struct rbd_device *rbd_dev = rq->q->queuedata;
4085 struct rbd_img_request *img_request;
4086 struct ceph_snap_context *snapc = NULL;
4087 u64 offset = (u64)blk_rq_pos(rq) << SECTOR_SHIFT;
4088 u64 length = blk_rq_bytes(rq);
4089 enum obj_operation_type op_type;
4091 bool must_be_locked;
4094 if (rq->cmd_type != REQ_TYPE_FS) {
4095 dout("%s: non-fs request type %d\n", __func__,
4096 (int) rq->cmd_type);
4101 if (req_op(rq) == REQ_OP_DISCARD)
4102 op_type = OBJ_OP_DISCARD;
4103 else if (req_op(rq) == REQ_OP_WRITE)
4104 op_type = OBJ_OP_WRITE;
4106 op_type = OBJ_OP_READ;
4108 /* Ignore/skip any zero-length requests */
4111 dout("%s: zero-length request\n", __func__);
4116 /* Only reads are allowed to a read-only device */
4118 if (op_type != OBJ_OP_READ) {
4119 if (rbd_dev->mapping.read_only) {
4123 rbd_assert(rbd_dev->spec->snap_id == CEPH_NOSNAP);
4127 * Quit early if the mapped snapshot no longer exists. It's
4128 * still possible the snapshot will have disappeared by the
4129 * time our request arrives at the osd, but there's no sense in
4130 * sending it if we already know.
4132 if (!test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags)) {
4133 dout("request for non-existent snapshot");
4134 rbd_assert(rbd_dev->spec->snap_id != CEPH_NOSNAP);
4139 if (offset && length > U64_MAX - offset + 1) {
4140 rbd_warn(rbd_dev, "bad request range (%llu~%llu)", offset,
4143 goto err_rq; /* Shouldn't happen */
4146 blk_mq_start_request(rq);
4148 down_read(&rbd_dev->header_rwsem);
4149 mapping_size = rbd_dev->mapping.size;
4150 if (op_type != OBJ_OP_READ) {
4151 snapc = rbd_dev->header.snapc;
4152 ceph_get_snap_context(snapc);
4153 must_be_locked = rbd_is_lock_supported(rbd_dev);
4155 must_be_locked = rbd_dev->opts->lock_on_read &&
4156 rbd_is_lock_supported(rbd_dev);
4158 up_read(&rbd_dev->header_rwsem);
4160 if (offset + length > mapping_size) {
4161 rbd_warn(rbd_dev, "beyond EOD (%llu~%llu > %llu)", offset,
4162 length, mapping_size);
4167 if (must_be_locked) {
4168 down_read(&rbd_dev->lock_rwsem);
4169 if (rbd_dev->lock_state != RBD_LOCK_STATE_LOCKED)
4170 rbd_wait_state_locked(rbd_dev);
4173 img_request = rbd_img_request_create(rbd_dev, offset, length, op_type,
4179 img_request->rq = rq;
4180 snapc = NULL; /* img_request consumes a ref */
4182 if (op_type == OBJ_OP_DISCARD)
4183 result = rbd_img_request_fill(img_request, OBJ_REQUEST_NODATA,
4186 result = rbd_img_request_fill(img_request, OBJ_REQUEST_BIO,
4189 goto err_img_request;
4191 result = rbd_img_request_submit(img_request);
4193 goto err_img_request;
4196 up_read(&rbd_dev->lock_rwsem);
4200 rbd_img_request_put(img_request);
4203 up_read(&rbd_dev->lock_rwsem);
4206 rbd_warn(rbd_dev, "%s %llx at %llx result %d",
4207 obj_op_name(op_type), length, offset, result);
4208 ceph_put_snap_context(snapc);
4210 blk_mq_end_request(rq, result);
4213 static int rbd_queue_rq(struct blk_mq_hw_ctx *hctx,
4214 const struct blk_mq_queue_data *bd)
4216 struct request *rq = bd->rq;
4217 struct work_struct *work = blk_mq_rq_to_pdu(rq);
4219 queue_work(rbd_wq, work);
4220 return BLK_MQ_RQ_QUEUE_OK;
4223 static void rbd_free_disk(struct rbd_device *rbd_dev)
4225 struct gendisk *disk = rbd_dev->disk;
4230 rbd_dev->disk = NULL;
4231 if (disk->flags & GENHD_FL_UP) {
4234 blk_cleanup_queue(disk->queue);
4235 blk_mq_free_tag_set(&rbd_dev->tag_set);
4240 static int rbd_obj_read_sync(struct rbd_device *rbd_dev,
4241 const char *object_name,
4242 u64 offset, u64 length, void *buf)
4245 struct rbd_obj_request *obj_request;
4246 struct page **pages = NULL;
4251 page_count = (u32) calc_pages_for(offset, length);
4252 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
4254 return PTR_ERR(pages);
4257 obj_request = rbd_obj_request_create(object_name, offset, length,
4262 obj_request->pages = pages;
4263 obj_request->page_count = page_count;
4265 obj_request->osd_req = rbd_osd_req_create(rbd_dev, OBJ_OP_READ, 1,
4267 if (!obj_request->osd_req)
4270 osd_req_op_extent_init(obj_request->osd_req, 0, CEPH_OSD_OP_READ,
4271 offset, length, 0, 0);
4272 osd_req_op_extent_osd_data_pages(obj_request->osd_req, 0,
4274 obj_request->length,
4275 obj_request->offset & ~PAGE_MASK,
4277 rbd_osd_req_format_read(obj_request);
4279 rbd_obj_request_submit(obj_request);
4280 ret = rbd_obj_request_wait(obj_request);
4284 ret = obj_request->result;
4288 rbd_assert(obj_request->xferred <= (u64) SIZE_MAX);
4289 size = (size_t) obj_request->xferred;
4290 ceph_copy_from_page_vector(pages, buf, 0, size);
4291 rbd_assert(size <= (size_t)INT_MAX);
4295 rbd_obj_request_put(obj_request);
4297 ceph_release_page_vector(pages, page_count);
4303 * Read the complete header for the given rbd device. On successful
4304 * return, the rbd_dev->header field will contain up-to-date
4305 * information about the image.
4307 static int rbd_dev_v1_header_info(struct rbd_device *rbd_dev)
4309 struct rbd_image_header_ondisk *ondisk = NULL;
4316 * The complete header will include an array of its 64-bit
4317 * snapshot ids, followed by the names of those snapshots as
4318 * a contiguous block of NUL-terminated strings. Note that
4319 * the number of snapshots could change by the time we read
4320 * it in, in which case we re-read it.
4327 size = sizeof (*ondisk);
4328 size += snap_count * sizeof (struct rbd_image_snap_ondisk);
4330 ondisk = kmalloc(size, GFP_KERNEL);
4334 ret = rbd_obj_read_sync(rbd_dev, rbd_dev->header_oid.name,
4338 if ((size_t)ret < size) {
4340 rbd_warn(rbd_dev, "short header read (want %zd got %d)",
4344 if (!rbd_dev_ondisk_valid(ondisk)) {
4346 rbd_warn(rbd_dev, "invalid header");
4350 names_size = le64_to_cpu(ondisk->snap_names_len);
4351 want_count = snap_count;
4352 snap_count = le32_to_cpu(ondisk->snap_count);
4353 } while (snap_count != want_count);
4355 ret = rbd_header_from_disk(rbd_dev, ondisk);
4363 * Clear the rbd device's EXISTS flag if the snapshot it's mapped to
4364 * has disappeared from the (just updated) snapshot context.
4366 static void rbd_exists_validate(struct rbd_device *rbd_dev)
4370 if (!test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags))
4373 snap_id = rbd_dev->spec->snap_id;
4374 if (snap_id == CEPH_NOSNAP)
4377 if (rbd_dev_snap_index(rbd_dev, snap_id) == BAD_SNAP_INDEX)
4378 clear_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
4381 static void rbd_dev_update_size(struct rbd_device *rbd_dev)
4386 * If EXISTS is not set, rbd_dev->disk may be NULL, so don't
4387 * try to update its size. If REMOVING is set, updating size
4388 * is just useless work since the device can't be opened.
4390 if (test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags) &&
4391 !test_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags)) {
4392 size = (sector_t)rbd_dev->mapping.size / SECTOR_SIZE;
4393 dout("setting size to %llu sectors", (unsigned long long)size);
4394 set_capacity(rbd_dev->disk, size);
4395 revalidate_disk(rbd_dev->disk);
4399 static int rbd_dev_refresh(struct rbd_device *rbd_dev)
4404 down_write(&rbd_dev->header_rwsem);
4405 mapping_size = rbd_dev->mapping.size;
4407 ret = rbd_dev_header_info(rbd_dev);
4412 * If there is a parent, see if it has disappeared due to the
4413 * mapped image getting flattened.
4415 if (rbd_dev->parent) {
4416 ret = rbd_dev_v2_parent_info(rbd_dev);
4421 if (rbd_dev->spec->snap_id == CEPH_NOSNAP) {
4422 rbd_dev->mapping.size = rbd_dev->header.image_size;
4424 /* validate mapped snapshot's EXISTS flag */
4425 rbd_exists_validate(rbd_dev);
4429 up_write(&rbd_dev->header_rwsem);
4430 if (!ret && mapping_size != rbd_dev->mapping.size)
4431 rbd_dev_update_size(rbd_dev);
4436 static int rbd_init_request(void *data, struct request *rq,
4437 unsigned int hctx_idx, unsigned int request_idx,
4438 unsigned int numa_node)
4440 struct work_struct *work = blk_mq_rq_to_pdu(rq);
4442 INIT_WORK(work, rbd_queue_workfn);
4446 static struct blk_mq_ops rbd_mq_ops = {
4447 .queue_rq = rbd_queue_rq,
4448 .map_queue = blk_mq_map_queue,
4449 .init_request = rbd_init_request,
4452 static int rbd_init_disk(struct rbd_device *rbd_dev)
4454 struct gendisk *disk;
4455 struct request_queue *q;
4459 /* create gendisk info */
4460 disk = alloc_disk(single_major ?
4461 (1 << RBD_SINGLE_MAJOR_PART_SHIFT) :
4462 RBD_MINORS_PER_MAJOR);
4466 snprintf(disk->disk_name, sizeof(disk->disk_name), RBD_DRV_NAME "%d",
4468 disk->major = rbd_dev->major;
4469 disk->first_minor = rbd_dev->minor;
4471 disk->flags |= GENHD_FL_EXT_DEVT;
4472 disk->fops = &rbd_bd_ops;
4473 disk->private_data = rbd_dev;
4475 memset(&rbd_dev->tag_set, 0, sizeof(rbd_dev->tag_set));
4476 rbd_dev->tag_set.ops = &rbd_mq_ops;
4477 rbd_dev->tag_set.queue_depth = rbd_dev->opts->queue_depth;
4478 rbd_dev->tag_set.numa_node = NUMA_NO_NODE;
4479 rbd_dev->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_SG_MERGE;
4480 rbd_dev->tag_set.nr_hw_queues = 1;
4481 rbd_dev->tag_set.cmd_size = sizeof(struct work_struct);
4483 err = blk_mq_alloc_tag_set(&rbd_dev->tag_set);
4487 q = blk_mq_init_queue(&rbd_dev->tag_set);
4493 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, q);
4494 /* QUEUE_FLAG_ADD_RANDOM is off by default for blk-mq */
4496 /* set io sizes to object size */
4497 segment_size = rbd_obj_bytes(&rbd_dev->header);
4498 blk_queue_max_hw_sectors(q, segment_size / SECTOR_SIZE);
4499 q->limits.max_sectors = queue_max_hw_sectors(q);
4500 blk_queue_max_segments(q, segment_size / SECTOR_SIZE);
4501 blk_queue_max_segment_size(q, segment_size);
4502 blk_queue_io_min(q, segment_size);
4503 blk_queue_io_opt(q, segment_size);
4505 /* enable the discard support */
4506 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, q);
4507 q->limits.discard_granularity = segment_size;
4508 q->limits.discard_alignment = segment_size;
4509 blk_queue_max_discard_sectors(q, segment_size / SECTOR_SIZE);
4510 q->limits.discard_zeroes_data = 1;
4512 if (!ceph_test_opt(rbd_dev->rbd_client->client, NOCRC))
4513 q->backing_dev_info.capabilities |= BDI_CAP_STABLE_WRITES;
4517 q->queuedata = rbd_dev;
4519 rbd_dev->disk = disk;
4523 blk_mq_free_tag_set(&rbd_dev->tag_set);
4533 static struct rbd_device *dev_to_rbd_dev(struct device *dev)
4535 return container_of(dev, struct rbd_device, dev);
4538 static ssize_t rbd_size_show(struct device *dev,
4539 struct device_attribute *attr, char *buf)
4541 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4543 return sprintf(buf, "%llu\n",
4544 (unsigned long long)rbd_dev->mapping.size);
4548 * Note this shows the features for whatever's mapped, which is not
4549 * necessarily the base image.
4551 static ssize_t rbd_features_show(struct device *dev,
4552 struct device_attribute *attr, char *buf)
4554 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4556 return sprintf(buf, "0x%016llx\n",
4557 (unsigned long long)rbd_dev->mapping.features);
4560 static ssize_t rbd_major_show(struct device *dev,
4561 struct device_attribute *attr, char *buf)
4563 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4566 return sprintf(buf, "%d\n", rbd_dev->major);
4568 return sprintf(buf, "(none)\n");
4571 static ssize_t rbd_minor_show(struct device *dev,
4572 struct device_attribute *attr, char *buf)
4574 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4576 return sprintf(buf, "%d\n", rbd_dev->minor);
4579 static ssize_t rbd_client_addr_show(struct device *dev,
4580 struct device_attribute *attr, char *buf)
4582 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4583 struct ceph_entity_addr *client_addr =
4584 ceph_client_addr(rbd_dev->rbd_client->client);
4586 return sprintf(buf, "%pISpc/%u\n", &client_addr->in_addr,
4587 le32_to_cpu(client_addr->nonce));
4590 static ssize_t rbd_client_id_show(struct device *dev,
4591 struct device_attribute *attr, char *buf)
4593 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4595 return sprintf(buf, "client%lld\n",
4596 ceph_client_gid(rbd_dev->rbd_client->client));
4599 static ssize_t rbd_cluster_fsid_show(struct device *dev,
4600 struct device_attribute *attr, char *buf)
4602 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4604 return sprintf(buf, "%pU\n", &rbd_dev->rbd_client->client->fsid);
4607 static ssize_t rbd_config_info_show(struct device *dev,
4608 struct device_attribute *attr, char *buf)
4610 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4612 return sprintf(buf, "%s\n", rbd_dev->config_info);
4615 static ssize_t rbd_pool_show(struct device *dev,
4616 struct device_attribute *attr, char *buf)
4618 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4620 return sprintf(buf, "%s\n", rbd_dev->spec->pool_name);
4623 static ssize_t rbd_pool_id_show(struct device *dev,
4624 struct device_attribute *attr, char *buf)
4626 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4628 return sprintf(buf, "%llu\n",
4629 (unsigned long long) rbd_dev->spec->pool_id);
4632 static ssize_t rbd_name_show(struct device *dev,
4633 struct device_attribute *attr, char *buf)
4635 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4637 if (rbd_dev->spec->image_name)
4638 return sprintf(buf, "%s\n", rbd_dev->spec->image_name);
4640 return sprintf(buf, "(unknown)\n");
4643 static ssize_t rbd_image_id_show(struct device *dev,
4644 struct device_attribute *attr, char *buf)
4646 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4648 return sprintf(buf, "%s\n", rbd_dev->spec->image_id);
4652 * Shows the name of the currently-mapped snapshot (or
4653 * RBD_SNAP_HEAD_NAME for the base image).
4655 static ssize_t rbd_snap_show(struct device *dev,
4656 struct device_attribute *attr,
4659 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4661 return sprintf(buf, "%s\n", rbd_dev->spec->snap_name);
4664 static ssize_t rbd_snap_id_show(struct device *dev,
4665 struct device_attribute *attr, char *buf)
4667 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4669 return sprintf(buf, "%llu\n", rbd_dev->spec->snap_id);
4673 * For a v2 image, shows the chain of parent images, separated by empty
4674 * lines. For v1 images or if there is no parent, shows "(no parent
4677 static ssize_t rbd_parent_show(struct device *dev,
4678 struct device_attribute *attr,
4681 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4684 if (!rbd_dev->parent)
4685 return sprintf(buf, "(no parent image)\n");
4687 for ( ; rbd_dev->parent; rbd_dev = rbd_dev->parent) {
4688 struct rbd_spec *spec = rbd_dev->parent_spec;
4690 count += sprintf(&buf[count], "%s"
4691 "pool_id %llu\npool_name %s\n"
4692 "image_id %s\nimage_name %s\n"
4693 "snap_id %llu\nsnap_name %s\n"
4695 !count ? "" : "\n", /* first? */
4696 spec->pool_id, spec->pool_name,
4697 spec->image_id, spec->image_name ?: "(unknown)",
4698 spec->snap_id, spec->snap_name,
4699 rbd_dev->parent_overlap);
4705 static ssize_t rbd_image_refresh(struct device *dev,
4706 struct device_attribute *attr,
4710 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4713 ret = rbd_dev_refresh(rbd_dev);
4720 static DEVICE_ATTR(size, S_IRUGO, rbd_size_show, NULL);
4721 static DEVICE_ATTR(features, S_IRUGO, rbd_features_show, NULL);
4722 static DEVICE_ATTR(major, S_IRUGO, rbd_major_show, NULL);
4723 static DEVICE_ATTR(minor, S_IRUGO, rbd_minor_show, NULL);
4724 static DEVICE_ATTR(client_addr, S_IRUGO, rbd_client_addr_show, NULL);
4725 static DEVICE_ATTR(client_id, S_IRUGO, rbd_client_id_show, NULL);
4726 static DEVICE_ATTR(cluster_fsid, S_IRUGO, rbd_cluster_fsid_show, NULL);
4727 static DEVICE_ATTR(config_info, S_IRUSR, rbd_config_info_show, NULL);
4728 static DEVICE_ATTR(pool, S_IRUGO, rbd_pool_show, NULL);
4729 static DEVICE_ATTR(pool_id, S_IRUGO, rbd_pool_id_show, NULL);
4730 static DEVICE_ATTR(name, S_IRUGO, rbd_name_show, NULL);
4731 static DEVICE_ATTR(image_id, S_IRUGO, rbd_image_id_show, NULL);
4732 static DEVICE_ATTR(refresh, S_IWUSR, NULL, rbd_image_refresh);
4733 static DEVICE_ATTR(current_snap, S_IRUGO, rbd_snap_show, NULL);
4734 static DEVICE_ATTR(snap_id, S_IRUGO, rbd_snap_id_show, NULL);
4735 static DEVICE_ATTR(parent, S_IRUGO, rbd_parent_show, NULL);
4737 static struct attribute *rbd_attrs[] = {
4738 &dev_attr_size.attr,
4739 &dev_attr_features.attr,
4740 &dev_attr_major.attr,
4741 &dev_attr_minor.attr,
4742 &dev_attr_client_addr.attr,
4743 &dev_attr_client_id.attr,
4744 &dev_attr_cluster_fsid.attr,
4745 &dev_attr_config_info.attr,
4746 &dev_attr_pool.attr,
4747 &dev_attr_pool_id.attr,
4748 &dev_attr_name.attr,
4749 &dev_attr_image_id.attr,
4750 &dev_attr_current_snap.attr,
4751 &dev_attr_snap_id.attr,
4752 &dev_attr_parent.attr,
4753 &dev_attr_refresh.attr,
4757 static struct attribute_group rbd_attr_group = {
4761 static const struct attribute_group *rbd_attr_groups[] = {
4766 static void rbd_dev_release(struct device *dev);
4768 static struct device_type rbd_device_type = {
4770 .groups = rbd_attr_groups,
4771 .release = rbd_dev_release,
4774 static struct rbd_spec *rbd_spec_get(struct rbd_spec *spec)
4776 kref_get(&spec->kref);
4781 static void rbd_spec_free(struct kref *kref);
4782 static void rbd_spec_put(struct rbd_spec *spec)
4785 kref_put(&spec->kref, rbd_spec_free);
4788 static struct rbd_spec *rbd_spec_alloc(void)
4790 struct rbd_spec *spec;
4792 spec = kzalloc(sizeof (*spec), GFP_KERNEL);
4796 spec->pool_id = CEPH_NOPOOL;
4797 spec->snap_id = CEPH_NOSNAP;
4798 kref_init(&spec->kref);
4803 static void rbd_spec_free(struct kref *kref)
4805 struct rbd_spec *spec = container_of(kref, struct rbd_spec, kref);
4807 kfree(spec->pool_name);
4808 kfree(spec->image_id);
4809 kfree(spec->image_name);
4810 kfree(spec->snap_name);
4814 static void rbd_dev_free(struct rbd_device *rbd_dev)
4816 WARN_ON(rbd_dev->watch_state != RBD_WATCH_STATE_UNREGISTERED);
4817 WARN_ON(rbd_dev->lock_state != RBD_LOCK_STATE_UNLOCKED);
4819 ceph_oid_destroy(&rbd_dev->header_oid);
4820 ceph_oloc_destroy(&rbd_dev->header_oloc);
4821 kfree(rbd_dev->config_info);
4823 rbd_put_client(rbd_dev->rbd_client);
4824 rbd_spec_put(rbd_dev->spec);
4825 kfree(rbd_dev->opts);
4829 static void rbd_dev_release(struct device *dev)
4831 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
4832 bool need_put = !!rbd_dev->opts;
4835 destroy_workqueue(rbd_dev->task_wq);
4836 ida_simple_remove(&rbd_dev_id_ida, rbd_dev->dev_id);
4839 rbd_dev_free(rbd_dev);
4842 * This is racy, but way better than putting module outside of
4843 * the release callback. The race window is pretty small, so
4844 * doing something similar to dm (dm-builtin.c) is overkill.
4847 module_put(THIS_MODULE);
4850 static struct rbd_device *__rbd_dev_create(struct rbd_client *rbdc,
4851 struct rbd_spec *spec)
4853 struct rbd_device *rbd_dev;
4855 rbd_dev = kzalloc(sizeof(*rbd_dev), GFP_KERNEL);
4859 spin_lock_init(&rbd_dev->lock);
4860 INIT_LIST_HEAD(&rbd_dev->node);
4861 init_rwsem(&rbd_dev->header_rwsem);
4863 ceph_oid_init(&rbd_dev->header_oid);
4864 ceph_oloc_init(&rbd_dev->header_oloc);
4866 mutex_init(&rbd_dev->watch_mutex);
4867 rbd_dev->watch_state = RBD_WATCH_STATE_UNREGISTERED;
4868 INIT_DELAYED_WORK(&rbd_dev->watch_dwork, rbd_reregister_watch);
4870 init_rwsem(&rbd_dev->lock_rwsem);
4871 rbd_dev->lock_state = RBD_LOCK_STATE_UNLOCKED;
4872 INIT_WORK(&rbd_dev->acquired_lock_work, rbd_notify_acquired_lock);
4873 INIT_WORK(&rbd_dev->released_lock_work, rbd_notify_released_lock);
4874 INIT_DELAYED_WORK(&rbd_dev->lock_dwork, rbd_acquire_lock);
4875 INIT_WORK(&rbd_dev->unlock_work, rbd_release_lock_work);
4876 init_waitqueue_head(&rbd_dev->lock_waitq);
4878 rbd_dev->dev.bus = &rbd_bus_type;
4879 rbd_dev->dev.type = &rbd_device_type;
4880 rbd_dev->dev.parent = &rbd_root_dev;
4881 device_initialize(&rbd_dev->dev);
4883 rbd_dev->rbd_client = rbdc;
4884 rbd_dev->spec = spec;
4886 rbd_dev->layout.stripe_unit = 1 << RBD_MAX_OBJ_ORDER;
4887 rbd_dev->layout.stripe_count = 1;
4888 rbd_dev->layout.object_size = 1 << RBD_MAX_OBJ_ORDER;
4889 rbd_dev->layout.pool_id = spec->pool_id;
4890 RCU_INIT_POINTER(rbd_dev->layout.pool_ns, NULL);
4896 * Create a mapping rbd_dev.
4898 static struct rbd_device *rbd_dev_create(struct rbd_client *rbdc,
4899 struct rbd_spec *spec,
4900 struct rbd_options *opts)
4902 struct rbd_device *rbd_dev;
4904 rbd_dev = __rbd_dev_create(rbdc, spec);
4908 rbd_dev->opts = opts;
4910 /* get an id and fill in device name */
4911 rbd_dev->dev_id = ida_simple_get(&rbd_dev_id_ida, 0,
4912 minor_to_rbd_dev_id(1 << MINORBITS),
4914 if (rbd_dev->dev_id < 0)
4917 sprintf(rbd_dev->name, RBD_DRV_NAME "%d", rbd_dev->dev_id);
4918 rbd_dev->task_wq = alloc_ordered_workqueue("%s-tasks", WQ_MEM_RECLAIM,
4920 if (!rbd_dev->task_wq)
4923 /* we have a ref from do_rbd_add() */
4924 __module_get(THIS_MODULE);
4926 dout("%s rbd_dev %p dev_id %d\n", __func__, rbd_dev, rbd_dev->dev_id);
4930 ida_simple_remove(&rbd_dev_id_ida, rbd_dev->dev_id);
4932 rbd_dev_free(rbd_dev);
4936 static void rbd_dev_destroy(struct rbd_device *rbd_dev)
4939 put_device(&rbd_dev->dev);
4943 * Get the size and object order for an image snapshot, or if
4944 * snap_id is CEPH_NOSNAP, gets this information for the base
4947 static int _rbd_dev_v2_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
4948 u8 *order, u64 *snap_size)
4950 __le64 snapid = cpu_to_le64(snap_id);
4955 } __attribute__ ((packed)) size_buf = { 0 };
4957 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_oid.name,
4959 &snapid, sizeof (snapid),
4960 &size_buf, sizeof (size_buf));
4961 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
4964 if (ret < sizeof (size_buf))
4968 *order = size_buf.order;
4969 dout(" order %u", (unsigned int)*order);
4971 *snap_size = le64_to_cpu(size_buf.size);
4973 dout(" snap_id 0x%016llx snap_size = %llu\n",
4974 (unsigned long long)snap_id,
4975 (unsigned long long)*snap_size);
4980 static int rbd_dev_v2_image_size(struct rbd_device *rbd_dev)
4982 return _rbd_dev_v2_snap_size(rbd_dev, CEPH_NOSNAP,
4983 &rbd_dev->header.obj_order,
4984 &rbd_dev->header.image_size);
4987 static int rbd_dev_v2_object_prefix(struct rbd_device *rbd_dev)
4993 reply_buf = kzalloc(RBD_OBJ_PREFIX_LEN_MAX, GFP_KERNEL);
4997 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_oid.name,
4998 "rbd", "get_object_prefix", NULL, 0,
4999 reply_buf, RBD_OBJ_PREFIX_LEN_MAX);
5000 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
5005 rbd_dev->header.object_prefix = ceph_extract_encoded_string(&p,
5006 p + ret, NULL, GFP_NOIO);
5009 if (IS_ERR(rbd_dev->header.object_prefix)) {
5010 ret = PTR_ERR(rbd_dev->header.object_prefix);
5011 rbd_dev->header.object_prefix = NULL;
5013 dout(" object_prefix = %s\n", rbd_dev->header.object_prefix);
5021 static int _rbd_dev_v2_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
5024 __le64 snapid = cpu_to_le64(snap_id);
5028 } __attribute__ ((packed)) features_buf = { 0 };
5032 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_oid.name,
5033 "rbd", "get_features",
5034 &snapid, sizeof (snapid),
5035 &features_buf, sizeof (features_buf));
5036 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
5039 if (ret < sizeof (features_buf))
5042 unsup = le64_to_cpu(features_buf.incompat) & ~RBD_FEATURES_SUPPORTED;
5044 rbd_warn(rbd_dev, "image uses unsupported features: 0x%llx",
5049 *snap_features = le64_to_cpu(features_buf.features);
5051 dout(" snap_id 0x%016llx features = 0x%016llx incompat = 0x%016llx\n",
5052 (unsigned long long)snap_id,
5053 (unsigned long long)*snap_features,
5054 (unsigned long long)le64_to_cpu(features_buf.incompat));
5059 static int rbd_dev_v2_features(struct rbd_device *rbd_dev)
5061 return _rbd_dev_v2_snap_features(rbd_dev, CEPH_NOSNAP,
5062 &rbd_dev->header.features);
5065 static int rbd_dev_v2_parent_info(struct rbd_device *rbd_dev)
5067 struct rbd_spec *parent_spec;
5069 void *reply_buf = NULL;
5079 parent_spec = rbd_spec_alloc();
5083 size = sizeof (__le64) + /* pool_id */
5084 sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX + /* image_id */
5085 sizeof (__le64) + /* snap_id */
5086 sizeof (__le64); /* overlap */
5087 reply_buf = kmalloc(size, GFP_KERNEL);
5093 snapid = cpu_to_le64(rbd_dev->spec->snap_id);
5094 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_oid.name,
5095 "rbd", "get_parent",
5096 &snapid, sizeof (snapid),
5098 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
5103 end = reply_buf + ret;
5105 ceph_decode_64_safe(&p, end, pool_id, out_err);
5106 if (pool_id == CEPH_NOPOOL) {
5108 * Either the parent never existed, or we have
5109 * record of it but the image got flattened so it no
5110 * longer has a parent. When the parent of a
5111 * layered image disappears we immediately set the
5112 * overlap to 0. The effect of this is that all new
5113 * requests will be treated as if the image had no
5116 if (rbd_dev->parent_overlap) {
5117 rbd_dev->parent_overlap = 0;
5118 rbd_dev_parent_put(rbd_dev);
5119 pr_info("%s: clone image has been flattened\n",
5120 rbd_dev->disk->disk_name);
5123 goto out; /* No parent? No problem. */
5126 /* The ceph file layout needs to fit pool id in 32 bits */
5129 if (pool_id > (u64)U32_MAX) {
5130 rbd_warn(NULL, "parent pool id too large (%llu > %u)",
5131 (unsigned long long)pool_id, U32_MAX);
5135 image_id = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
5136 if (IS_ERR(image_id)) {
5137 ret = PTR_ERR(image_id);
5140 ceph_decode_64_safe(&p, end, snap_id, out_err);
5141 ceph_decode_64_safe(&p, end, overlap, out_err);
5144 * The parent won't change (except when the clone is
5145 * flattened, already handled that). So we only need to
5146 * record the parent spec we have not already done so.
5148 if (!rbd_dev->parent_spec) {
5149 parent_spec->pool_id = pool_id;
5150 parent_spec->image_id = image_id;
5151 parent_spec->snap_id = snap_id;
5152 rbd_dev->parent_spec = parent_spec;
5153 parent_spec = NULL; /* rbd_dev now owns this */
5159 * We always update the parent overlap. If it's zero we issue
5160 * a warning, as we will proceed as if there was no parent.
5164 /* refresh, careful to warn just once */
5165 if (rbd_dev->parent_overlap)
5167 "clone now standalone (overlap became 0)");
5170 rbd_warn(rbd_dev, "clone is standalone (overlap 0)");
5173 rbd_dev->parent_overlap = overlap;
5179 rbd_spec_put(parent_spec);
5184 static int rbd_dev_v2_striping_info(struct rbd_device *rbd_dev)
5188 __le64 stripe_count;
5189 } __attribute__ ((packed)) striping_info_buf = { 0 };
5190 size_t size = sizeof (striping_info_buf);
5197 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_oid.name,
5198 "rbd", "get_stripe_unit_count", NULL, 0,
5199 (char *)&striping_info_buf, size);
5200 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
5207 * We don't actually support the "fancy striping" feature
5208 * (STRIPINGV2) yet, but if the striping sizes are the
5209 * defaults the behavior is the same as before. So find
5210 * out, and only fail if the image has non-default values.
5213 obj_size = (u64)1 << rbd_dev->header.obj_order;
5214 p = &striping_info_buf;
5215 stripe_unit = ceph_decode_64(&p);
5216 if (stripe_unit != obj_size) {
5217 rbd_warn(rbd_dev, "unsupported stripe unit "
5218 "(got %llu want %llu)",
5219 stripe_unit, obj_size);
5222 stripe_count = ceph_decode_64(&p);
5223 if (stripe_count != 1) {
5224 rbd_warn(rbd_dev, "unsupported stripe count "
5225 "(got %llu want 1)", stripe_count);
5228 rbd_dev->header.stripe_unit = stripe_unit;
5229 rbd_dev->header.stripe_count = stripe_count;
5234 static char *rbd_dev_image_name(struct rbd_device *rbd_dev)
5236 size_t image_id_size;
5241 void *reply_buf = NULL;
5243 char *image_name = NULL;
5246 rbd_assert(!rbd_dev->spec->image_name);
5248 len = strlen(rbd_dev->spec->image_id);
5249 image_id_size = sizeof (__le32) + len;
5250 image_id = kmalloc(image_id_size, GFP_KERNEL);
5255 end = image_id + image_id_size;
5256 ceph_encode_string(&p, end, rbd_dev->spec->image_id, (u32)len);
5258 size = sizeof (__le32) + RBD_IMAGE_NAME_LEN_MAX;
5259 reply_buf = kmalloc(size, GFP_KERNEL);
5263 ret = rbd_obj_method_sync(rbd_dev, RBD_DIRECTORY,
5264 "rbd", "dir_get_name",
5265 image_id, image_id_size,
5270 end = reply_buf + ret;
5272 image_name = ceph_extract_encoded_string(&p, end, &len, GFP_KERNEL);
5273 if (IS_ERR(image_name))
5276 dout("%s: name is %s len is %zd\n", __func__, image_name, len);
5284 static u64 rbd_v1_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
5286 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
5287 const char *snap_name;
5290 /* Skip over names until we find the one we are looking for */
5292 snap_name = rbd_dev->header.snap_names;
5293 while (which < snapc->num_snaps) {
5294 if (!strcmp(name, snap_name))
5295 return snapc->snaps[which];
5296 snap_name += strlen(snap_name) + 1;
5302 static u64 rbd_v2_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
5304 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
5309 for (which = 0; !found && which < snapc->num_snaps; which++) {
5310 const char *snap_name;
5312 snap_id = snapc->snaps[which];
5313 snap_name = rbd_dev_v2_snap_name(rbd_dev, snap_id);
5314 if (IS_ERR(snap_name)) {
5315 /* ignore no-longer existing snapshots */
5316 if (PTR_ERR(snap_name) == -ENOENT)
5321 found = !strcmp(name, snap_name);
5324 return found ? snap_id : CEPH_NOSNAP;
5328 * Assumes name is never RBD_SNAP_HEAD_NAME; returns CEPH_NOSNAP if
5329 * no snapshot by that name is found, or if an error occurs.
5331 static u64 rbd_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
5333 if (rbd_dev->image_format == 1)
5334 return rbd_v1_snap_id_by_name(rbd_dev, name);
5336 return rbd_v2_snap_id_by_name(rbd_dev, name);
5340 * An image being mapped will have everything but the snap id.
5342 static int rbd_spec_fill_snap_id(struct rbd_device *rbd_dev)
5344 struct rbd_spec *spec = rbd_dev->spec;
5346 rbd_assert(spec->pool_id != CEPH_NOPOOL && spec->pool_name);
5347 rbd_assert(spec->image_id && spec->image_name);
5348 rbd_assert(spec->snap_name);
5350 if (strcmp(spec->snap_name, RBD_SNAP_HEAD_NAME)) {
5353 snap_id = rbd_snap_id_by_name(rbd_dev, spec->snap_name);
5354 if (snap_id == CEPH_NOSNAP)
5357 spec->snap_id = snap_id;
5359 spec->snap_id = CEPH_NOSNAP;
5366 * A parent image will have all ids but none of the names.
5368 * All names in an rbd spec are dynamically allocated. It's OK if we
5369 * can't figure out the name for an image id.
5371 static int rbd_spec_fill_names(struct rbd_device *rbd_dev)
5373 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
5374 struct rbd_spec *spec = rbd_dev->spec;
5375 const char *pool_name;
5376 const char *image_name;
5377 const char *snap_name;
5380 rbd_assert(spec->pool_id != CEPH_NOPOOL);
5381 rbd_assert(spec->image_id);
5382 rbd_assert(spec->snap_id != CEPH_NOSNAP);
5384 /* Get the pool name; we have to make our own copy of this */
5386 pool_name = ceph_pg_pool_name_by_id(osdc->osdmap, spec->pool_id);
5388 rbd_warn(rbd_dev, "no pool with id %llu", spec->pool_id);
5391 pool_name = kstrdup(pool_name, GFP_KERNEL);
5395 /* Fetch the image name; tolerate failure here */
5397 image_name = rbd_dev_image_name(rbd_dev);
5399 rbd_warn(rbd_dev, "unable to get image name");
5401 /* Fetch the snapshot name */
5403 snap_name = rbd_snap_name(rbd_dev, spec->snap_id);
5404 if (IS_ERR(snap_name)) {
5405 ret = PTR_ERR(snap_name);
5409 spec->pool_name = pool_name;
5410 spec->image_name = image_name;
5411 spec->snap_name = snap_name;
5421 static int rbd_dev_v2_snap_context(struct rbd_device *rbd_dev)
5430 struct ceph_snap_context *snapc;
5434 * We'll need room for the seq value (maximum snapshot id),
5435 * snapshot count, and array of that many snapshot ids.
5436 * For now we have a fixed upper limit on the number we're
5437 * prepared to receive.
5439 size = sizeof (__le64) + sizeof (__le32) +
5440 RBD_MAX_SNAP_COUNT * sizeof (__le64);
5441 reply_buf = kzalloc(size, GFP_KERNEL);
5445 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_oid.name,
5446 "rbd", "get_snapcontext", NULL, 0,
5448 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
5453 end = reply_buf + ret;
5455 ceph_decode_64_safe(&p, end, seq, out);
5456 ceph_decode_32_safe(&p, end, snap_count, out);
5459 * Make sure the reported number of snapshot ids wouldn't go
5460 * beyond the end of our buffer. But before checking that,
5461 * make sure the computed size of the snapshot context we
5462 * allocate is representable in a size_t.
5464 if (snap_count > (SIZE_MAX - sizeof (struct ceph_snap_context))
5469 if (!ceph_has_room(&p, end, snap_count * sizeof (__le64)))
5473 snapc = ceph_create_snap_context(snap_count, GFP_KERNEL);
5479 for (i = 0; i < snap_count; i++)
5480 snapc->snaps[i] = ceph_decode_64(&p);
5482 ceph_put_snap_context(rbd_dev->header.snapc);
5483 rbd_dev->header.snapc = snapc;
5485 dout(" snap context seq = %llu, snap_count = %u\n",
5486 (unsigned long long)seq, (unsigned int)snap_count);
5493 static const char *rbd_dev_v2_snap_name(struct rbd_device *rbd_dev,
5504 size = sizeof (__le32) + RBD_MAX_SNAP_NAME_LEN;
5505 reply_buf = kmalloc(size, GFP_KERNEL);
5507 return ERR_PTR(-ENOMEM);
5509 snapid = cpu_to_le64(snap_id);
5510 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_oid.name,
5511 "rbd", "get_snapshot_name",
5512 &snapid, sizeof (snapid),
5514 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
5516 snap_name = ERR_PTR(ret);
5521 end = reply_buf + ret;
5522 snap_name = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
5523 if (IS_ERR(snap_name))
5526 dout(" snap_id 0x%016llx snap_name = %s\n",
5527 (unsigned long long)snap_id, snap_name);
5534 static int rbd_dev_v2_header_info(struct rbd_device *rbd_dev)
5536 bool first_time = rbd_dev->header.object_prefix == NULL;
5539 ret = rbd_dev_v2_image_size(rbd_dev);
5544 ret = rbd_dev_v2_header_onetime(rbd_dev);
5549 ret = rbd_dev_v2_snap_context(rbd_dev);
5550 if (ret && first_time) {
5551 kfree(rbd_dev->header.object_prefix);
5552 rbd_dev->header.object_prefix = NULL;
5558 static int rbd_dev_header_info(struct rbd_device *rbd_dev)
5560 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
5562 if (rbd_dev->image_format == 1)
5563 return rbd_dev_v1_header_info(rbd_dev);
5565 return rbd_dev_v2_header_info(rbd_dev);
5569 * Skips over white space at *buf, and updates *buf to point to the
5570 * first found non-space character (if any). Returns the length of
5571 * the token (string of non-white space characters) found. Note
5572 * that *buf must be terminated with '\0'.
5574 static inline size_t next_token(const char **buf)
5577 * These are the characters that produce nonzero for
5578 * isspace() in the "C" and "POSIX" locales.
5580 const char *spaces = " \f\n\r\t\v";
5582 *buf += strspn(*buf, spaces); /* Find start of token */
5584 return strcspn(*buf, spaces); /* Return token length */
5588 * Finds the next token in *buf, dynamically allocates a buffer big
5589 * enough to hold a copy of it, and copies the token into the new
5590 * buffer. The copy is guaranteed to be terminated with '\0'. Note
5591 * that a duplicate buffer is created even for a zero-length token.
5593 * Returns a pointer to the newly-allocated duplicate, or a null
5594 * pointer if memory for the duplicate was not available. If
5595 * the lenp argument is a non-null pointer, the length of the token
5596 * (not including the '\0') is returned in *lenp.
5598 * If successful, the *buf pointer will be updated to point beyond
5599 * the end of the found token.
5601 * Note: uses GFP_KERNEL for allocation.
5603 static inline char *dup_token(const char **buf, size_t *lenp)
5608 len = next_token(buf);
5609 dup = kmemdup(*buf, len + 1, GFP_KERNEL);
5612 *(dup + len) = '\0';
5622 * Parse the options provided for an "rbd add" (i.e., rbd image
5623 * mapping) request. These arrive via a write to /sys/bus/rbd/add,
5624 * and the data written is passed here via a NUL-terminated buffer.
5625 * Returns 0 if successful or an error code otherwise.
5627 * The information extracted from these options is recorded in
5628 * the other parameters which return dynamically-allocated
5631 * The address of a pointer that will refer to a ceph options
5632 * structure. Caller must release the returned pointer using
5633 * ceph_destroy_options() when it is no longer needed.
5635 * Address of an rbd options pointer. Fully initialized by
5636 * this function; caller must release with kfree().
5638 * Address of an rbd image specification pointer. Fully
5639 * initialized by this function based on parsed options.
5640 * Caller must release with rbd_spec_put().
5642 * The options passed take this form:
5643 * <mon_addrs> <options> <pool_name> <image_name> [<snap_id>]
5646 * A comma-separated list of one or more monitor addresses.
5647 * A monitor address is an ip address, optionally followed
5648 * by a port number (separated by a colon).
5649 * I.e.: ip1[:port1][,ip2[:port2]...]
5651 * A comma-separated list of ceph and/or rbd options.
5653 * The name of the rados pool containing the rbd image.
5655 * The name of the image in that pool to map.
5657 * An optional snapshot id. If provided, the mapping will
5658 * present data from the image at the time that snapshot was
5659 * created. The image head is used if no snapshot id is
5660 * provided. Snapshot mappings are always read-only.
5662 static int rbd_add_parse_args(const char *buf,
5663 struct ceph_options **ceph_opts,
5664 struct rbd_options **opts,
5665 struct rbd_spec **rbd_spec)
5669 const char *mon_addrs;
5671 size_t mon_addrs_size;
5672 struct rbd_spec *spec = NULL;
5673 struct rbd_options *rbd_opts = NULL;
5674 struct ceph_options *copts;
5677 /* The first four tokens are required */
5679 len = next_token(&buf);
5681 rbd_warn(NULL, "no monitor address(es) provided");
5685 mon_addrs_size = len + 1;
5689 options = dup_token(&buf, NULL);
5693 rbd_warn(NULL, "no options provided");
5697 spec = rbd_spec_alloc();
5701 spec->pool_name = dup_token(&buf, NULL);
5702 if (!spec->pool_name)
5704 if (!*spec->pool_name) {
5705 rbd_warn(NULL, "no pool name provided");
5709 spec->image_name = dup_token(&buf, NULL);
5710 if (!spec->image_name)
5712 if (!*spec->image_name) {
5713 rbd_warn(NULL, "no image name provided");
5718 * Snapshot name is optional; default is to use "-"
5719 * (indicating the head/no snapshot).
5721 len = next_token(&buf);
5723 buf = RBD_SNAP_HEAD_NAME; /* No snapshot supplied */
5724 len = sizeof (RBD_SNAP_HEAD_NAME) - 1;
5725 } else if (len > RBD_MAX_SNAP_NAME_LEN) {
5726 ret = -ENAMETOOLONG;
5729 snap_name = kmemdup(buf, len + 1, GFP_KERNEL);
5732 *(snap_name + len) = '\0';
5733 spec->snap_name = snap_name;
5735 /* Initialize all rbd options to the defaults */
5737 rbd_opts = kzalloc(sizeof (*rbd_opts), GFP_KERNEL);
5741 rbd_opts->read_only = RBD_READ_ONLY_DEFAULT;
5742 rbd_opts->queue_depth = RBD_QUEUE_DEPTH_DEFAULT;
5743 rbd_opts->lock_on_read = RBD_LOCK_ON_READ_DEFAULT;
5745 copts = ceph_parse_options(options, mon_addrs,
5746 mon_addrs + mon_addrs_size - 1,
5747 parse_rbd_opts_token, rbd_opts);
5748 if (IS_ERR(copts)) {
5749 ret = PTR_ERR(copts);
5770 * Return pool id (>= 0) or a negative error code.
5772 static int rbd_add_get_pool_id(struct rbd_client *rbdc, const char *pool_name)
5774 struct ceph_options *opts = rbdc->client->options;
5780 ret = ceph_pg_poolid_by_name(rbdc->client->osdc.osdmap, pool_name);
5781 if (ret == -ENOENT && tries++ < 1) {
5782 ret = ceph_monc_get_version(&rbdc->client->monc, "osdmap",
5787 if (rbdc->client->osdc.osdmap->epoch < newest_epoch) {
5788 ceph_osdc_maybe_request_map(&rbdc->client->osdc);
5789 (void) ceph_monc_wait_osdmap(&rbdc->client->monc,
5791 opts->mount_timeout);
5794 /* the osdmap we have is new enough */
5803 * An rbd format 2 image has a unique identifier, distinct from the
5804 * name given to it by the user. Internally, that identifier is
5805 * what's used to specify the names of objects related to the image.
5807 * A special "rbd id" object is used to map an rbd image name to its
5808 * id. If that object doesn't exist, then there is no v2 rbd image
5809 * with the supplied name.
5811 * This function will record the given rbd_dev's image_id field if
5812 * it can be determined, and in that case will return 0. If any
5813 * errors occur a negative errno will be returned and the rbd_dev's
5814 * image_id field will be unchanged (and should be NULL).
5816 static int rbd_dev_image_id(struct rbd_device *rbd_dev)
5825 * When probing a parent image, the image id is already
5826 * known (and the image name likely is not). There's no
5827 * need to fetch the image id again in this case. We
5828 * do still need to set the image format though.
5830 if (rbd_dev->spec->image_id) {
5831 rbd_dev->image_format = *rbd_dev->spec->image_id ? 2 : 1;
5837 * First, see if the format 2 image id file exists, and if
5838 * so, get the image's persistent id from it.
5840 size = sizeof (RBD_ID_PREFIX) + strlen(rbd_dev->spec->image_name);
5841 object_name = kmalloc(size, GFP_NOIO);
5844 sprintf(object_name, "%s%s", RBD_ID_PREFIX, rbd_dev->spec->image_name);
5845 dout("rbd id object name is %s\n", object_name);
5847 /* Response will be an encoded string, which includes a length */
5849 size = sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX;
5850 response = kzalloc(size, GFP_NOIO);
5856 /* If it doesn't exist we'll assume it's a format 1 image */
5858 ret = rbd_obj_method_sync(rbd_dev, object_name,
5859 "rbd", "get_id", NULL, 0,
5860 response, RBD_IMAGE_ID_LEN_MAX);
5861 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
5862 if (ret == -ENOENT) {
5863 image_id = kstrdup("", GFP_KERNEL);
5864 ret = image_id ? 0 : -ENOMEM;
5866 rbd_dev->image_format = 1;
5867 } else if (ret >= 0) {
5870 image_id = ceph_extract_encoded_string(&p, p + ret,
5872 ret = PTR_ERR_OR_ZERO(image_id);
5874 rbd_dev->image_format = 2;
5878 rbd_dev->spec->image_id = image_id;
5879 dout("image_id is %s\n", image_id);
5889 * Undo whatever state changes are made by v1 or v2 header info
5892 static void rbd_dev_unprobe(struct rbd_device *rbd_dev)
5894 struct rbd_image_header *header;
5896 rbd_dev_parent_put(rbd_dev);
5898 /* Free dynamic fields from the header, then zero it out */
5900 header = &rbd_dev->header;
5901 ceph_put_snap_context(header->snapc);
5902 kfree(header->snap_sizes);
5903 kfree(header->snap_names);
5904 kfree(header->object_prefix);
5905 memset(header, 0, sizeof (*header));
5908 static int rbd_dev_v2_header_onetime(struct rbd_device *rbd_dev)
5912 ret = rbd_dev_v2_object_prefix(rbd_dev);
5917 * Get the and check features for the image. Currently the
5918 * features are assumed to never change.
5920 ret = rbd_dev_v2_features(rbd_dev);
5924 /* If the image supports fancy striping, get its parameters */
5926 if (rbd_dev->header.features & RBD_FEATURE_STRIPINGV2) {
5927 ret = rbd_dev_v2_striping_info(rbd_dev);
5931 /* No support for crypto and compression type format 2 images */
5935 rbd_dev->header.features = 0;
5936 kfree(rbd_dev->header.object_prefix);
5937 rbd_dev->header.object_prefix = NULL;
5943 * @depth is rbd_dev_image_probe() -> rbd_dev_probe_parent() ->
5944 * rbd_dev_image_probe() recursion depth, which means it's also the
5945 * length of the already discovered part of the parent chain.
5947 static int rbd_dev_probe_parent(struct rbd_device *rbd_dev, int depth)
5949 struct rbd_device *parent = NULL;
5952 if (!rbd_dev->parent_spec)
5955 if (++depth > RBD_MAX_PARENT_CHAIN_LEN) {
5956 pr_info("parent chain is too long (%d)\n", depth);
5961 parent = __rbd_dev_create(rbd_dev->rbd_client, rbd_dev->parent_spec);
5968 * Images related by parent/child relationships always share
5969 * rbd_client and spec/parent_spec, so bump their refcounts.
5971 __rbd_get_client(rbd_dev->rbd_client);
5972 rbd_spec_get(rbd_dev->parent_spec);
5974 ret = rbd_dev_image_probe(parent, depth);
5978 rbd_dev->parent = parent;
5979 atomic_set(&rbd_dev->parent_ref, 1);
5983 rbd_dev_unparent(rbd_dev);
5984 rbd_dev_destroy(parent);
5989 * rbd_dev->header_rwsem must be locked for write and will be unlocked
5992 static int rbd_dev_device_setup(struct rbd_device *rbd_dev)
5996 /* Record our major and minor device numbers. */
5998 if (!single_major) {
5999 ret = register_blkdev(0, rbd_dev->name);
6001 goto err_out_unlock;
6003 rbd_dev->major = ret;
6006 rbd_dev->major = rbd_major;
6007 rbd_dev->minor = rbd_dev_id_to_minor(rbd_dev->dev_id);
6010 /* Set up the blkdev mapping. */
6012 ret = rbd_init_disk(rbd_dev);
6014 goto err_out_blkdev;
6016 ret = rbd_dev_mapping_set(rbd_dev);
6020 set_capacity(rbd_dev->disk, rbd_dev->mapping.size / SECTOR_SIZE);
6021 set_disk_ro(rbd_dev->disk, rbd_dev->mapping.read_only);
6023 dev_set_name(&rbd_dev->dev, "%d", rbd_dev->dev_id);
6024 ret = device_add(&rbd_dev->dev);
6026 goto err_out_mapping;
6028 /* Everything's ready. Announce the disk to the world. */
6030 set_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
6031 up_write(&rbd_dev->header_rwsem);
6033 spin_lock(&rbd_dev_list_lock);
6034 list_add_tail(&rbd_dev->node, &rbd_dev_list);
6035 spin_unlock(&rbd_dev_list_lock);
6037 add_disk(rbd_dev->disk);
6038 pr_info("%s: capacity %llu features 0x%llx\n", rbd_dev->disk->disk_name,
6039 (unsigned long long)get_capacity(rbd_dev->disk) << SECTOR_SHIFT,
6040 rbd_dev->header.features);
6045 rbd_dev_mapping_clear(rbd_dev);
6047 rbd_free_disk(rbd_dev);
6050 unregister_blkdev(rbd_dev->major, rbd_dev->name);
6052 up_write(&rbd_dev->header_rwsem);
6056 static int rbd_dev_header_name(struct rbd_device *rbd_dev)
6058 struct rbd_spec *spec = rbd_dev->spec;
6061 /* Record the header object name for this rbd image. */
6063 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
6065 rbd_dev->header_oloc.pool = rbd_dev->layout.pool_id;
6066 if (rbd_dev->image_format == 1)
6067 ret = ceph_oid_aprintf(&rbd_dev->header_oid, GFP_KERNEL, "%s%s",
6068 spec->image_name, RBD_SUFFIX);
6070 ret = ceph_oid_aprintf(&rbd_dev->header_oid, GFP_KERNEL, "%s%s",
6071 RBD_HEADER_PREFIX, spec->image_id);
6076 static void rbd_dev_image_release(struct rbd_device *rbd_dev)
6078 rbd_dev_unprobe(rbd_dev);
6079 rbd_dev->image_format = 0;
6080 kfree(rbd_dev->spec->image_id);
6081 rbd_dev->spec->image_id = NULL;
6083 rbd_dev_destroy(rbd_dev);
6087 * Probe for the existence of the header object for the given rbd
6088 * device. If this image is the one being mapped (i.e., not a
6089 * parent), initiate a watch on its header object before using that
6090 * object to get detailed information about the rbd image.
6092 static int rbd_dev_image_probe(struct rbd_device *rbd_dev, int depth)
6097 * Get the id from the image id object. Unless there's an
6098 * error, rbd_dev->spec->image_id will be filled in with
6099 * a dynamically-allocated string, and rbd_dev->image_format
6100 * will be set to either 1 or 2.
6102 ret = rbd_dev_image_id(rbd_dev);
6106 ret = rbd_dev_header_name(rbd_dev);
6108 goto err_out_format;
6111 ret = rbd_register_watch(rbd_dev);
6114 pr_info("image %s/%s does not exist\n",
6115 rbd_dev->spec->pool_name,
6116 rbd_dev->spec->image_name);
6117 goto err_out_format;
6121 ret = rbd_dev_header_info(rbd_dev);
6126 * If this image is the one being mapped, we have pool name and
6127 * id, image name and id, and snap name - need to fill snap id.
6128 * Otherwise this is a parent image, identified by pool, image
6129 * and snap ids - need to fill in names for those ids.
6132 ret = rbd_spec_fill_snap_id(rbd_dev);
6134 ret = rbd_spec_fill_names(rbd_dev);
6137 pr_info("snap %s/%s@%s does not exist\n",
6138 rbd_dev->spec->pool_name,
6139 rbd_dev->spec->image_name,
6140 rbd_dev->spec->snap_name);
6144 if (rbd_dev->header.features & RBD_FEATURE_LAYERING) {
6145 ret = rbd_dev_v2_parent_info(rbd_dev);
6150 * Need to warn users if this image is the one being
6151 * mapped and has a parent.
6153 if (!depth && rbd_dev->parent_spec)
6155 "WARNING: kernel layering is EXPERIMENTAL!");
6158 ret = rbd_dev_probe_parent(rbd_dev, depth);
6162 dout("discovered format %u image, header name is %s\n",
6163 rbd_dev->image_format, rbd_dev->header_oid.name);
6167 rbd_dev_unprobe(rbd_dev);
6170 rbd_unregister_watch(rbd_dev);
6172 rbd_dev->image_format = 0;
6173 kfree(rbd_dev->spec->image_id);
6174 rbd_dev->spec->image_id = NULL;
6178 static ssize_t do_rbd_add(struct bus_type *bus,
6182 struct rbd_device *rbd_dev = NULL;
6183 struct ceph_options *ceph_opts = NULL;
6184 struct rbd_options *rbd_opts = NULL;
6185 struct rbd_spec *spec = NULL;
6186 struct rbd_client *rbdc;
6190 if (!try_module_get(THIS_MODULE))
6193 /* parse add command */
6194 rc = rbd_add_parse_args(buf, &ceph_opts, &rbd_opts, &spec);
6198 rbdc = rbd_get_client(ceph_opts);
6205 rc = rbd_add_get_pool_id(rbdc, spec->pool_name);
6208 pr_info("pool %s does not exist\n", spec->pool_name);
6209 goto err_out_client;
6211 spec->pool_id = (u64)rc;
6213 rbd_dev = rbd_dev_create(rbdc, spec, rbd_opts);
6216 goto err_out_client;
6218 rbdc = NULL; /* rbd_dev now owns this */
6219 spec = NULL; /* rbd_dev now owns this */
6220 rbd_opts = NULL; /* rbd_dev now owns this */
6222 rbd_dev->config_info = kstrdup(buf, GFP_KERNEL);
6223 if (!rbd_dev->config_info) {
6225 goto err_out_rbd_dev;
6228 down_write(&rbd_dev->header_rwsem);
6229 rc = rbd_dev_image_probe(rbd_dev, 0);
6231 up_write(&rbd_dev->header_rwsem);
6232 goto err_out_rbd_dev;
6235 /* If we are mapping a snapshot it must be marked read-only */
6237 read_only = rbd_dev->opts->read_only;
6238 if (rbd_dev->spec->snap_id != CEPH_NOSNAP)
6240 rbd_dev->mapping.read_only = read_only;
6242 rc = rbd_dev_device_setup(rbd_dev);
6245 * rbd_unregister_watch() can't be moved into
6246 * rbd_dev_image_release() without refactoring, see
6247 * commit 1f3ef78861ac.
6249 rbd_unregister_watch(rbd_dev);
6250 rbd_dev_image_release(rbd_dev);
6256 module_put(THIS_MODULE);
6260 rbd_dev_destroy(rbd_dev);
6262 rbd_put_client(rbdc);
6269 static ssize_t rbd_add(struct bus_type *bus,
6276 return do_rbd_add(bus, buf, count);
6279 static ssize_t rbd_add_single_major(struct bus_type *bus,
6283 return do_rbd_add(bus, buf, count);
6286 static void rbd_dev_device_release(struct rbd_device *rbd_dev)
6288 rbd_free_disk(rbd_dev);
6290 spin_lock(&rbd_dev_list_lock);
6291 list_del_init(&rbd_dev->node);
6292 spin_unlock(&rbd_dev_list_lock);
6294 clear_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
6295 device_del(&rbd_dev->dev);
6296 rbd_dev_mapping_clear(rbd_dev);
6298 unregister_blkdev(rbd_dev->major, rbd_dev->name);
6301 static void rbd_dev_remove_parent(struct rbd_device *rbd_dev)
6303 while (rbd_dev->parent) {
6304 struct rbd_device *first = rbd_dev;
6305 struct rbd_device *second = first->parent;
6306 struct rbd_device *third;
6309 * Follow to the parent with no grandparent and
6312 while (second && (third = second->parent)) {
6317 rbd_dev_image_release(second);
6318 first->parent = NULL;
6319 first->parent_overlap = 0;
6321 rbd_assert(first->parent_spec);
6322 rbd_spec_put(first->parent_spec);
6323 first->parent_spec = NULL;
6327 static ssize_t do_rbd_remove(struct bus_type *bus,
6331 struct rbd_device *rbd_dev = NULL;
6332 struct list_head *tmp;
6335 bool already = false;
6341 sscanf(buf, "%d %5s", &dev_id, opt_buf);
6343 pr_err("dev_id out of range\n");
6346 if (opt_buf[0] != '\0') {
6347 if (!strcmp(opt_buf, "force")) {
6350 pr_err("bad remove option at '%s'\n", opt_buf);
6356 spin_lock(&rbd_dev_list_lock);
6357 list_for_each(tmp, &rbd_dev_list) {
6358 rbd_dev = list_entry(tmp, struct rbd_device, node);
6359 if (rbd_dev->dev_id == dev_id) {
6365 spin_lock_irq(&rbd_dev->lock);
6366 if (rbd_dev->open_count && !force)
6369 already = test_and_set_bit(RBD_DEV_FLAG_REMOVING,
6371 spin_unlock_irq(&rbd_dev->lock);
6373 spin_unlock(&rbd_dev_list_lock);
6374 if (ret < 0 || already)
6379 * Prevent new IO from being queued and wait for existing
6380 * IO to complete/fail.
6382 blk_mq_freeze_queue(rbd_dev->disk->queue);
6383 blk_set_queue_dying(rbd_dev->disk->queue);
6386 down_write(&rbd_dev->lock_rwsem);
6387 if (__rbd_is_lock_owner(rbd_dev))
6388 rbd_unlock(rbd_dev);
6389 up_write(&rbd_dev->lock_rwsem);
6390 rbd_unregister_watch(rbd_dev);
6393 * Don't free anything from rbd_dev->disk until after all
6394 * notifies are completely processed. Otherwise
6395 * rbd_bus_del_dev() will race with rbd_watch_cb(), resulting
6396 * in a potential use after free of rbd_dev->disk or rbd_dev.
6398 rbd_dev_device_release(rbd_dev);
6399 rbd_dev_image_release(rbd_dev);
6404 static ssize_t rbd_remove(struct bus_type *bus,
6411 return do_rbd_remove(bus, buf, count);
6414 static ssize_t rbd_remove_single_major(struct bus_type *bus,
6418 return do_rbd_remove(bus, buf, count);
6422 * create control files in sysfs
6425 static int rbd_sysfs_init(void)
6429 ret = device_register(&rbd_root_dev);
6433 ret = bus_register(&rbd_bus_type);
6435 device_unregister(&rbd_root_dev);
6440 static void rbd_sysfs_cleanup(void)
6442 bus_unregister(&rbd_bus_type);
6443 device_unregister(&rbd_root_dev);
6446 static int rbd_slab_init(void)
6448 rbd_assert(!rbd_img_request_cache);
6449 rbd_img_request_cache = KMEM_CACHE(rbd_img_request, 0);
6450 if (!rbd_img_request_cache)
6453 rbd_assert(!rbd_obj_request_cache);
6454 rbd_obj_request_cache = KMEM_CACHE(rbd_obj_request, 0);
6455 if (!rbd_obj_request_cache)
6458 rbd_assert(!rbd_segment_name_cache);
6459 rbd_segment_name_cache = kmem_cache_create("rbd_segment_name",
6460 CEPH_MAX_OID_NAME_LEN + 1, 1, 0, NULL);
6461 if (rbd_segment_name_cache)
6464 kmem_cache_destroy(rbd_obj_request_cache);
6465 rbd_obj_request_cache = NULL;
6467 kmem_cache_destroy(rbd_img_request_cache);
6468 rbd_img_request_cache = NULL;
6473 static void rbd_slab_exit(void)
6475 rbd_assert(rbd_segment_name_cache);
6476 kmem_cache_destroy(rbd_segment_name_cache);
6477 rbd_segment_name_cache = NULL;
6479 rbd_assert(rbd_obj_request_cache);
6480 kmem_cache_destroy(rbd_obj_request_cache);
6481 rbd_obj_request_cache = NULL;
6483 rbd_assert(rbd_img_request_cache);
6484 kmem_cache_destroy(rbd_img_request_cache);
6485 rbd_img_request_cache = NULL;
6488 static int __init rbd_init(void)
6492 if (!libceph_compatible(NULL)) {
6493 rbd_warn(NULL, "libceph incompatibility (quitting)");
6497 rc = rbd_slab_init();
6502 * The number of active work items is limited by the number of
6503 * rbd devices * queue depth, so leave @max_active at default.
6505 rbd_wq = alloc_workqueue(RBD_DRV_NAME, WQ_MEM_RECLAIM, 0);
6512 rbd_major = register_blkdev(0, RBD_DRV_NAME);
6513 if (rbd_major < 0) {
6519 rc = rbd_sysfs_init();
6521 goto err_out_blkdev;
6524 pr_info("loaded (major %d)\n", rbd_major);
6526 pr_info("loaded\n");
6532 unregister_blkdev(rbd_major, RBD_DRV_NAME);
6534 destroy_workqueue(rbd_wq);
6540 static void __exit rbd_exit(void)
6542 ida_destroy(&rbd_dev_id_ida);
6543 rbd_sysfs_cleanup();
6545 unregister_blkdev(rbd_major, RBD_DRV_NAME);
6546 destroy_workqueue(rbd_wq);
6550 module_init(rbd_init);
6551 module_exit(rbd_exit);
6553 MODULE_AUTHOR("Alex Elder <elder@inktank.com>");
6554 MODULE_AUTHOR("Sage Weil <sage@newdream.net>");
6555 MODULE_AUTHOR("Yehuda Sadeh <yehuda@hq.newdream.net>");
6556 /* following authorship retained from original osdblk.c */
6557 MODULE_AUTHOR("Jeff Garzik <jeff@garzik.org>");
6559 MODULE_DESCRIPTION("RADOS Block Device (RBD) driver");
6560 MODULE_LICENSE("GPL");