rbd: skip the copyup when an entire object writing
[linux-2.6-block.git] / drivers / block / rbd.c
CommitLineData
e2a58ee5 1
602adf40
YS
2/*
3 rbd.c -- Export ceph rados objects as a Linux block device
4
5
6 based on drivers/block/osdblk.c:
7
8 Copyright 2009 Red Hat, Inc.
9
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.
13
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.
18
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.
22
23
24
dfc5606d 25 For usage instructions, please refer to:
602adf40 26
dfc5606d 27 Documentation/ABI/testing/sysfs-bus-rbd
602adf40
YS
28
29 */
30
31#include <linux/ceph/libceph.h>
32#include <linux/ceph/osd_client.h>
33#include <linux/ceph/mon_client.h>
34#include <linux/ceph/decode.h>
59c2be1e 35#include <linux/parser.h>
30d1cff8 36#include <linux/bsearch.h>
602adf40
YS
37
38#include <linux/kernel.h>
39#include <linux/device.h>
40#include <linux/module.h>
41#include <linux/fs.h>
42#include <linux/blkdev.h>
1c2a9dfe 43#include <linux/slab.h>
f8a22fc2 44#include <linux/idr.h>
bc1ecc65 45#include <linux/workqueue.h>
602adf40
YS
46
47#include "rbd_types.h"
48
aafb230e
AE
49#define RBD_DEBUG /* Activate rbd_assert() calls */
50
593a9e7b
AE
51/*
52 * The basic unit of block I/O is a sector. It is interpreted in a
53 * number of contexts in Linux (blk, bio, genhd), but the default is
54 * universally 512 bytes. These symbols are just slightly more
55 * meaningful than the bare numbers they represent.
56 */
57#define SECTOR_SHIFT 9
58#define SECTOR_SIZE (1ULL << SECTOR_SHIFT)
59
a2acd00e
AE
60/*
61 * Increment the given counter and return its updated value.
62 * If the counter is already 0 it will not be incremented.
63 * If the counter is already at its maximum value returns
64 * -EINVAL without updating it.
65 */
66static int atomic_inc_return_safe(atomic_t *v)
67{
68 unsigned int counter;
69
70 counter = (unsigned int)__atomic_add_unless(v, 1, 0);
71 if (counter <= (unsigned int)INT_MAX)
72 return (int)counter;
73
74 atomic_dec(v);
75
76 return -EINVAL;
77}
78
79/* Decrement the counter. Return the resulting value, or -EINVAL */
80static int atomic_dec_return_safe(atomic_t *v)
81{
82 int counter;
83
84 counter = atomic_dec_return(v);
85 if (counter >= 0)
86 return counter;
87
88 atomic_inc(v);
89
90 return -EINVAL;
91}
92
f0f8cef5 93#define RBD_DRV_NAME "rbd"
602adf40 94
7e513d43
ID
95#define RBD_MINORS_PER_MAJOR 256
96#define RBD_SINGLE_MAJOR_PART_SHIFT 4
602adf40 97
d4b125e9
AE
98#define RBD_SNAP_DEV_NAME_PREFIX "snap_"
99#define RBD_MAX_SNAP_NAME_LEN \
100 (NAME_MAX - (sizeof (RBD_SNAP_DEV_NAME_PREFIX) - 1))
101
35d489f9 102#define RBD_MAX_SNAP_COUNT 510 /* allows max snapc to fit in 4KB */
602adf40
YS
103
104#define RBD_SNAP_HEAD_NAME "-"
105
9682fc6d
AE
106#define BAD_SNAP_INDEX U32_MAX /* invalid index into snap array */
107
9e15b77d
AE
108/* This allows a single page to hold an image name sent by OSD */
109#define RBD_IMAGE_NAME_LEN_MAX (PAGE_SIZE - sizeof (__le32) - 1)
1e130199 110#define RBD_IMAGE_ID_LEN_MAX 64
9e15b77d 111
1e130199 112#define RBD_OBJ_PREFIX_LEN_MAX 64
589d30e0 113
d889140c
AE
114/* Feature bits */
115
5cbf6f12
AE
116#define RBD_FEATURE_LAYERING (1<<0)
117#define RBD_FEATURE_STRIPINGV2 (1<<1)
118#define RBD_FEATURES_ALL \
119 (RBD_FEATURE_LAYERING | RBD_FEATURE_STRIPINGV2)
d889140c
AE
120
121/* Features supported by this (client software) implementation. */
122
770eba6e 123#define RBD_FEATURES_SUPPORTED (RBD_FEATURES_ALL)
d889140c 124
81a89793
AE
125/*
126 * An RBD device name will be "rbd#", where the "rbd" comes from
127 * RBD_DRV_NAME above, and # is a unique integer identifier.
128 * MAX_INT_FORMAT_WIDTH is used in ensuring DEV_NAME_LEN is big
129 * enough to hold all possible device names.
130 */
602adf40 131#define DEV_NAME_LEN 32
81a89793 132#define MAX_INT_FORMAT_WIDTH ((5 * sizeof (int)) / 2 + 1)
602adf40
YS
133
134/*
135 * block device image metadata (in-memory version)
136 */
137struct rbd_image_header {
f35a4dee 138 /* These six fields never change for a given rbd image */
849b4260 139 char *object_prefix;
602adf40
YS
140 __u8 obj_order;
141 __u8 crypt_type;
142 __u8 comp_type;
f35a4dee
AE
143 u64 stripe_unit;
144 u64 stripe_count;
145 u64 features; /* Might be changeable someday? */
602adf40 146
f84344f3
AE
147 /* The remaining fields need to be updated occasionally */
148 u64 image_size;
149 struct ceph_snap_context *snapc;
f35a4dee
AE
150 char *snap_names; /* format 1 only */
151 u64 *snap_sizes; /* format 1 only */
59c2be1e
YS
152};
153
0d7dbfce
AE
154/*
155 * An rbd image specification.
156 *
157 * The tuple (pool_id, image_id, snap_id) is sufficient to uniquely
c66c6e0c
AE
158 * identify an image. Each rbd_dev structure includes a pointer to
159 * an rbd_spec structure that encapsulates this identity.
160 *
161 * Each of the id's in an rbd_spec has an associated name. For a
162 * user-mapped image, the names are supplied and the id's associated
163 * with them are looked up. For a layered image, a parent image is
164 * defined by the tuple, and the names are looked up.
165 *
166 * An rbd_dev structure contains a parent_spec pointer which is
167 * non-null if the image it represents is a child in a layered
168 * image. This pointer will refer to the rbd_spec structure used
169 * by the parent rbd_dev for its own identity (i.e., the structure
170 * is shared between the parent and child).
171 *
172 * Since these structures are populated once, during the discovery
173 * phase of image construction, they are effectively immutable so
174 * we make no effort to synchronize access to them.
175 *
176 * Note that code herein does not assume the image name is known (it
177 * could be a null pointer).
0d7dbfce
AE
178 */
179struct rbd_spec {
180 u64 pool_id;
ecb4dc22 181 const char *pool_name;
0d7dbfce 182
ecb4dc22
AE
183 const char *image_id;
184 const char *image_name;
0d7dbfce
AE
185
186 u64 snap_id;
ecb4dc22 187 const char *snap_name;
0d7dbfce
AE
188
189 struct kref kref;
190};
191
602adf40 192/*
f0f8cef5 193 * an instance of the client. multiple devices may share an rbd client.
602adf40
YS
194 */
195struct rbd_client {
196 struct ceph_client *client;
197 struct kref kref;
198 struct list_head node;
199};
200
bf0d5f50
AE
201struct rbd_img_request;
202typedef void (*rbd_img_callback_t)(struct rbd_img_request *);
203
204#define BAD_WHICH U32_MAX /* Good which or bad which, which? */
205
206struct rbd_obj_request;
207typedef void (*rbd_obj_callback_t)(struct rbd_obj_request *);
208
9969ebc5
AE
209enum obj_request_type {
210 OBJ_REQUEST_NODATA, OBJ_REQUEST_BIO, OBJ_REQUEST_PAGES
211};
bf0d5f50 212
926f9b3f
AE
213enum obj_req_flags {
214 OBJ_REQ_DONE, /* completion flag: not done = 0, done = 1 */
6365d33a 215 OBJ_REQ_IMG_DATA, /* object usage: standalone = 0, image = 1 */
5679c59f
AE
216 OBJ_REQ_KNOWN, /* EXISTS flag valid: no = 0, yes = 1 */
217 OBJ_REQ_EXISTS, /* target exists: no = 0, yes = 1 */
926f9b3f
AE
218};
219
bf0d5f50
AE
220struct rbd_obj_request {
221 const char *object_name;
222 u64 offset; /* object start byte */
223 u64 length; /* bytes from offset */
926f9b3f 224 unsigned long flags;
bf0d5f50 225
c5b5ef6c
AE
226 /*
227 * An object request associated with an image will have its
228 * img_data flag set; a standalone object request will not.
229 *
230 * A standalone object request will have which == BAD_WHICH
231 * and a null obj_request pointer.
232 *
233 * An object request initiated in support of a layered image
234 * object (to check for its existence before a write) will
235 * have which == BAD_WHICH and a non-null obj_request pointer.
236 *
237 * Finally, an object request for rbd image data will have
238 * which != BAD_WHICH, and will have a non-null img_request
239 * pointer. The value of which will be in the range
240 * 0..(img_request->obj_request_count-1).
241 */
242 union {
243 struct rbd_obj_request *obj_request; /* STAT op */
244 struct {
245 struct rbd_img_request *img_request;
246 u64 img_offset;
247 /* links for img_request->obj_requests list */
248 struct list_head links;
249 };
250 };
bf0d5f50
AE
251 u32 which; /* posn image request list */
252
253 enum obj_request_type type;
788e2df3
AE
254 union {
255 struct bio *bio_list;
256 struct {
257 struct page **pages;
258 u32 page_count;
259 };
260 };
0eefd470 261 struct page **copyup_pages;
ebda6408 262 u32 copyup_page_count;
bf0d5f50
AE
263
264 struct ceph_osd_request *osd_req;
265
266 u64 xferred; /* bytes transferred */
1b83bef2 267 int result;
bf0d5f50
AE
268
269 rbd_obj_callback_t callback;
788e2df3 270 struct completion completion;
bf0d5f50
AE
271
272 struct kref kref;
273};
274
0c425248 275enum img_req_flags {
9849e986
AE
276 IMG_REQ_WRITE, /* I/O direction: read = 0, write = 1 */
277 IMG_REQ_CHILD, /* initiator: block = 0, child image = 1 */
d0b2e944 278 IMG_REQ_LAYERED, /* ENOENT handling: normal = 0, layered = 1 */
0c425248
AE
279};
280
bf0d5f50 281struct rbd_img_request {
bf0d5f50
AE
282 struct rbd_device *rbd_dev;
283 u64 offset; /* starting image byte offset */
284 u64 length; /* byte count from offset */
0c425248 285 unsigned long flags;
bf0d5f50 286 union {
9849e986 287 u64 snap_id; /* for reads */
bf0d5f50 288 struct ceph_snap_context *snapc; /* for writes */
9849e986
AE
289 };
290 union {
291 struct request *rq; /* block request */
292 struct rbd_obj_request *obj_request; /* obj req initiator */
bf0d5f50 293 };
3d7efd18 294 struct page **copyup_pages;
ebda6408 295 u32 copyup_page_count;
bf0d5f50
AE
296 spinlock_t completion_lock;/* protects next_completion */
297 u32 next_completion;
298 rbd_img_callback_t callback;
55f27e09 299 u64 xferred;/* aggregate bytes transferred */
a5a337d4 300 int result; /* first nonzero obj_request result */
bf0d5f50
AE
301
302 u32 obj_request_count;
303 struct list_head obj_requests; /* rbd_obj_request structs */
304
305 struct kref kref;
306};
307
308#define for_each_obj_request(ireq, oreq) \
ef06f4d3 309 list_for_each_entry(oreq, &(ireq)->obj_requests, links)
bf0d5f50 310#define for_each_obj_request_from(ireq, oreq) \
ef06f4d3 311 list_for_each_entry_from(oreq, &(ireq)->obj_requests, links)
bf0d5f50 312#define for_each_obj_request_safe(ireq, oreq, n) \
ef06f4d3 313 list_for_each_entry_safe_reverse(oreq, n, &(ireq)->obj_requests, links)
bf0d5f50 314
f84344f3 315struct rbd_mapping {
99c1f08f 316 u64 size;
34b13184 317 u64 features;
f84344f3
AE
318 bool read_only;
319};
320
602adf40
YS
321/*
322 * a single device
323 */
324struct rbd_device {
de71a297 325 int dev_id; /* blkdev unique id */
602adf40
YS
326
327 int major; /* blkdev assigned major */
dd82fff1 328 int minor;
602adf40 329 struct gendisk *disk; /* blkdev's gendisk and rq */
602adf40 330
a30b71b9 331 u32 image_format; /* Either 1 or 2 */
602adf40
YS
332 struct rbd_client *rbd_client;
333
334 char name[DEV_NAME_LEN]; /* blkdev name, e.g. rbd3 */
335
bc1ecc65 336 struct list_head rq_queue; /* incoming rq queue */
b82d167b 337 spinlock_t lock; /* queue, flags, open_count */
bc1ecc65
ID
338 struct workqueue_struct *rq_wq;
339 struct work_struct rq_work;
602adf40
YS
340
341 struct rbd_image_header header;
b82d167b 342 unsigned long flags; /* possibly lock protected */
0d7dbfce 343 struct rbd_spec *spec;
602adf40 344
0d7dbfce 345 char *header_name;
971f839a 346
0903e875
AE
347 struct ceph_file_layout layout;
348
59c2be1e 349 struct ceph_osd_event *watch_event;
975241af 350 struct rbd_obj_request *watch_request;
59c2be1e 351
86b00e0d
AE
352 struct rbd_spec *parent_spec;
353 u64 parent_overlap;
a2acd00e 354 atomic_t parent_ref;
2f82ee54 355 struct rbd_device *parent;
86b00e0d 356
c666601a
JD
357 /* protects updating the header */
358 struct rw_semaphore header_rwsem;
f84344f3
AE
359
360 struct rbd_mapping mapping;
602adf40
YS
361
362 struct list_head node;
dfc5606d 363
dfc5606d
YS
364 /* sysfs related */
365 struct device dev;
b82d167b 366 unsigned long open_count; /* protected by lock */
dfc5606d
YS
367};
368
b82d167b
AE
369/*
370 * Flag bits for rbd_dev->flags. If atomicity is required,
371 * rbd_dev->lock is used to protect access.
372 *
373 * Currently, only the "removing" flag (which is coupled with the
374 * "open_count" field) requires atomic access.
375 */
6d292906
AE
376enum rbd_dev_flags {
377 RBD_DEV_FLAG_EXISTS, /* mapped snapshot has not been deleted */
b82d167b 378 RBD_DEV_FLAG_REMOVING, /* this mapping is being removed */
6d292906
AE
379};
380
cfbf6377 381static DEFINE_MUTEX(client_mutex); /* Serialize client creation */
e124a82f 382
602adf40 383static LIST_HEAD(rbd_dev_list); /* devices */
e124a82f
AE
384static DEFINE_SPINLOCK(rbd_dev_list_lock);
385
432b8587
AE
386static LIST_HEAD(rbd_client_list); /* clients */
387static DEFINE_SPINLOCK(rbd_client_list_lock);
602adf40 388
78c2a44a
AE
389/* Slab caches for frequently-allocated structures */
390
1c2a9dfe 391static struct kmem_cache *rbd_img_request_cache;
868311b1 392static struct kmem_cache *rbd_obj_request_cache;
78c2a44a 393static struct kmem_cache *rbd_segment_name_cache;
1c2a9dfe 394
9b60e70b 395static int rbd_major;
f8a22fc2
ID
396static DEFINE_IDA(rbd_dev_id_ida);
397
9b60e70b
ID
398/*
399 * Default to false for now, as single-major requires >= 0.75 version of
400 * userspace rbd utility.
401 */
402static bool single_major = false;
403module_param(single_major, bool, S_IRUGO);
404MODULE_PARM_DESC(single_major, "Use a single major number for all rbd devices (default: false)");
405
3d7efd18
AE
406static int rbd_img_request_submit(struct rbd_img_request *img_request);
407
200a6a8b 408static void rbd_dev_device_release(struct device *dev);
dfc5606d 409
f0f8cef5
AE
410static ssize_t rbd_add(struct bus_type *bus, const char *buf,
411 size_t count);
412static ssize_t rbd_remove(struct bus_type *bus, const char *buf,
413 size_t count);
9b60e70b
ID
414static ssize_t rbd_add_single_major(struct bus_type *bus, const char *buf,
415 size_t count);
416static ssize_t rbd_remove_single_major(struct bus_type *bus, const char *buf,
417 size_t count);
1f3ef788 418static int rbd_dev_image_probe(struct rbd_device *rbd_dev, bool mapping);
a2acd00e 419static void rbd_spec_put(struct rbd_spec *spec);
f0f8cef5 420
9b60e70b
ID
421static int rbd_dev_id_to_minor(int dev_id)
422{
7e513d43 423 return dev_id << RBD_SINGLE_MAJOR_PART_SHIFT;
9b60e70b
ID
424}
425
426static int minor_to_rbd_dev_id(int minor)
427{
7e513d43 428 return minor >> RBD_SINGLE_MAJOR_PART_SHIFT;
9b60e70b
ID
429}
430
b15a21dd
GKH
431static BUS_ATTR(add, S_IWUSR, NULL, rbd_add);
432static BUS_ATTR(remove, S_IWUSR, NULL, rbd_remove);
9b60e70b
ID
433static BUS_ATTR(add_single_major, S_IWUSR, NULL, rbd_add_single_major);
434static BUS_ATTR(remove_single_major, S_IWUSR, NULL, rbd_remove_single_major);
b15a21dd
GKH
435
436static struct attribute *rbd_bus_attrs[] = {
437 &bus_attr_add.attr,
438 &bus_attr_remove.attr,
9b60e70b
ID
439 &bus_attr_add_single_major.attr,
440 &bus_attr_remove_single_major.attr,
b15a21dd 441 NULL,
f0f8cef5 442};
92c76dc0
ID
443
444static umode_t rbd_bus_is_visible(struct kobject *kobj,
445 struct attribute *attr, int index)
446{
9b60e70b
ID
447 if (!single_major &&
448 (attr == &bus_attr_add_single_major.attr ||
449 attr == &bus_attr_remove_single_major.attr))
450 return 0;
451
92c76dc0
ID
452 return attr->mode;
453}
454
455static const struct attribute_group rbd_bus_group = {
456 .attrs = rbd_bus_attrs,
457 .is_visible = rbd_bus_is_visible,
458};
459__ATTRIBUTE_GROUPS(rbd_bus);
f0f8cef5
AE
460
461static struct bus_type rbd_bus_type = {
462 .name = "rbd",
b15a21dd 463 .bus_groups = rbd_bus_groups,
f0f8cef5
AE
464};
465
466static void rbd_root_dev_release(struct device *dev)
467{
468}
469
470static struct device rbd_root_dev = {
471 .init_name = "rbd",
472 .release = rbd_root_dev_release,
473};
474
06ecc6cb
AE
475static __printf(2, 3)
476void rbd_warn(struct rbd_device *rbd_dev, const char *fmt, ...)
477{
478 struct va_format vaf;
479 va_list args;
480
481 va_start(args, fmt);
482 vaf.fmt = fmt;
483 vaf.va = &args;
484
485 if (!rbd_dev)
486 printk(KERN_WARNING "%s: %pV\n", RBD_DRV_NAME, &vaf);
487 else if (rbd_dev->disk)
488 printk(KERN_WARNING "%s: %s: %pV\n",
489 RBD_DRV_NAME, rbd_dev->disk->disk_name, &vaf);
490 else if (rbd_dev->spec && rbd_dev->spec->image_name)
491 printk(KERN_WARNING "%s: image %s: %pV\n",
492 RBD_DRV_NAME, rbd_dev->spec->image_name, &vaf);
493 else if (rbd_dev->spec && rbd_dev->spec->image_id)
494 printk(KERN_WARNING "%s: id %s: %pV\n",
495 RBD_DRV_NAME, rbd_dev->spec->image_id, &vaf);
496 else /* punt */
497 printk(KERN_WARNING "%s: rbd_dev %p: %pV\n",
498 RBD_DRV_NAME, rbd_dev, &vaf);
499 va_end(args);
500}
501
aafb230e
AE
502#ifdef RBD_DEBUG
503#define rbd_assert(expr) \
504 if (unlikely(!(expr))) { \
505 printk(KERN_ERR "\nAssertion failure in %s() " \
506 "at line %d:\n\n" \
507 "\trbd_assert(%s);\n\n", \
508 __func__, __LINE__, #expr); \
509 BUG(); \
510 }
511#else /* !RBD_DEBUG */
512# define rbd_assert(expr) ((void) 0)
513#endif /* !RBD_DEBUG */
dfc5606d 514
b454e36d 515static int rbd_img_obj_request_submit(struct rbd_obj_request *obj_request);
05a46afd
AE
516static void rbd_img_parent_read(struct rbd_obj_request *obj_request);
517static void rbd_dev_remove_parent(struct rbd_device *rbd_dev);
8b3e1a56 518
cc4a38bd 519static int rbd_dev_refresh(struct rbd_device *rbd_dev);
2df3fac7 520static int rbd_dev_v2_header_onetime(struct rbd_device *rbd_dev);
a720ae09 521static int rbd_dev_header_info(struct rbd_device *rbd_dev);
e8f59b59 522static int rbd_dev_v2_parent_info(struct rbd_device *rbd_dev);
54cac61f
AE
523static const char *rbd_dev_v2_snap_name(struct rbd_device *rbd_dev,
524 u64 snap_id);
2ad3d716
AE
525static int _rbd_dev_v2_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
526 u8 *order, u64 *snap_size);
527static int _rbd_dev_v2_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
528 u64 *snap_features);
529static u64 rbd_snap_id_by_name(struct rbd_device *rbd_dev, const char *name);
59c2be1e 530
602adf40
YS
531static int rbd_open(struct block_device *bdev, fmode_t mode)
532{
f0f8cef5 533 struct rbd_device *rbd_dev = bdev->bd_disk->private_data;
b82d167b 534 bool removing = false;
602adf40 535
f84344f3 536 if ((mode & FMODE_WRITE) && rbd_dev->mapping.read_only)
602adf40
YS
537 return -EROFS;
538
a14ea269 539 spin_lock_irq(&rbd_dev->lock);
b82d167b
AE
540 if (test_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags))
541 removing = true;
542 else
543 rbd_dev->open_count++;
a14ea269 544 spin_unlock_irq(&rbd_dev->lock);
b82d167b
AE
545 if (removing)
546 return -ENOENT;
547
c3e946ce 548 (void) get_device(&rbd_dev->dev);
340c7a2b 549
602adf40
YS
550 return 0;
551}
552
db2a144b 553static void rbd_release(struct gendisk *disk, fmode_t mode)
dfc5606d
YS
554{
555 struct rbd_device *rbd_dev = disk->private_data;
b82d167b
AE
556 unsigned long open_count_before;
557
a14ea269 558 spin_lock_irq(&rbd_dev->lock);
b82d167b 559 open_count_before = rbd_dev->open_count--;
a14ea269 560 spin_unlock_irq(&rbd_dev->lock);
b82d167b 561 rbd_assert(open_count_before > 0);
dfc5606d 562
c3e946ce 563 put_device(&rbd_dev->dev);
dfc5606d
YS
564}
565
131fd9f6
GZ
566static int rbd_ioctl_set_ro(struct rbd_device *rbd_dev, unsigned long arg)
567{
77f33c03 568 int ret = 0;
131fd9f6
GZ
569 int val;
570 bool ro;
77f33c03 571 bool ro_changed = false;
131fd9f6 572
77f33c03 573 /* get_user() may sleep, so call it before taking rbd_dev->lock */
131fd9f6
GZ
574 if (get_user(val, (int __user *)(arg)))
575 return -EFAULT;
576
577 ro = val ? true : false;
578 /* Snapshot doesn't allow to write*/
579 if (rbd_dev->spec->snap_id != CEPH_NOSNAP && !ro)
580 return -EROFS;
581
77f33c03
JD
582 spin_lock_irq(&rbd_dev->lock);
583 /* prevent others open this device */
584 if (rbd_dev->open_count > 1) {
585 ret = -EBUSY;
586 goto out;
587 }
588
131fd9f6
GZ
589 if (rbd_dev->mapping.read_only != ro) {
590 rbd_dev->mapping.read_only = ro;
77f33c03 591 ro_changed = true;
131fd9f6
GZ
592 }
593
77f33c03
JD
594out:
595 spin_unlock_irq(&rbd_dev->lock);
596 /* set_disk_ro() may sleep, so call it after releasing rbd_dev->lock */
597 if (ret == 0 && ro_changed)
598 set_disk_ro(rbd_dev->disk, ro ? 1 : 0);
599
600 return ret;
131fd9f6
GZ
601}
602
603static int rbd_ioctl(struct block_device *bdev, fmode_t mode,
604 unsigned int cmd, unsigned long arg)
605{
606 struct rbd_device *rbd_dev = bdev->bd_disk->private_data;
607 int ret = 0;
608
131fd9f6
GZ
609 switch (cmd) {
610 case BLKROSET:
611 ret = rbd_ioctl_set_ro(rbd_dev, arg);
612 break;
613 default:
614 ret = -ENOTTY;
615 }
616
131fd9f6
GZ
617 return ret;
618}
619
620#ifdef CONFIG_COMPAT
621static int rbd_compat_ioctl(struct block_device *bdev, fmode_t mode,
622 unsigned int cmd, unsigned long arg)
623{
624 return rbd_ioctl(bdev, mode, cmd, arg);
625}
626#endif /* CONFIG_COMPAT */
627
602adf40
YS
628static const struct block_device_operations rbd_bd_ops = {
629 .owner = THIS_MODULE,
630 .open = rbd_open,
dfc5606d 631 .release = rbd_release,
131fd9f6
GZ
632 .ioctl = rbd_ioctl,
633#ifdef CONFIG_COMPAT
634 .compat_ioctl = rbd_compat_ioctl,
635#endif
602adf40
YS
636};
637
638/*
7262cfca 639 * Initialize an rbd client instance. Success or not, this function
cfbf6377 640 * consumes ceph_opts. Caller holds client_mutex.
602adf40 641 */
f8c38929 642static struct rbd_client *rbd_client_create(struct ceph_options *ceph_opts)
602adf40
YS
643{
644 struct rbd_client *rbdc;
645 int ret = -ENOMEM;
646
37206ee5 647 dout("%s:\n", __func__);
602adf40
YS
648 rbdc = kmalloc(sizeof(struct rbd_client), GFP_KERNEL);
649 if (!rbdc)
650 goto out_opt;
651
652 kref_init(&rbdc->kref);
653 INIT_LIST_HEAD(&rbdc->node);
654
43ae4701 655 rbdc->client = ceph_create_client(ceph_opts, rbdc, 0, 0);
602adf40 656 if (IS_ERR(rbdc->client))
08f75463 657 goto out_rbdc;
43ae4701 658 ceph_opts = NULL; /* Now rbdc->client is responsible for ceph_opts */
602adf40
YS
659
660 ret = ceph_open_session(rbdc->client);
661 if (ret < 0)
08f75463 662 goto out_client;
602adf40 663
432b8587 664 spin_lock(&rbd_client_list_lock);
602adf40 665 list_add_tail(&rbdc->node, &rbd_client_list);
432b8587 666 spin_unlock(&rbd_client_list_lock);
602adf40 667
37206ee5 668 dout("%s: rbdc %p\n", __func__, rbdc);
bc534d86 669
602adf40 670 return rbdc;
08f75463 671out_client:
602adf40 672 ceph_destroy_client(rbdc->client);
08f75463 673out_rbdc:
602adf40
YS
674 kfree(rbdc);
675out_opt:
43ae4701
AE
676 if (ceph_opts)
677 ceph_destroy_options(ceph_opts);
37206ee5
AE
678 dout("%s: error %d\n", __func__, ret);
679
28f259b7 680 return ERR_PTR(ret);
602adf40
YS
681}
682
2f82ee54
AE
683static struct rbd_client *__rbd_get_client(struct rbd_client *rbdc)
684{
685 kref_get(&rbdc->kref);
686
687 return rbdc;
688}
689
602adf40 690/*
1f7ba331
AE
691 * Find a ceph client with specific addr and configuration. If
692 * found, bump its reference count.
602adf40 693 */
1f7ba331 694static struct rbd_client *rbd_client_find(struct ceph_options *ceph_opts)
602adf40
YS
695{
696 struct rbd_client *client_node;
1f7ba331 697 bool found = false;
602adf40 698
43ae4701 699 if (ceph_opts->flags & CEPH_OPT_NOSHARE)
602adf40
YS
700 return NULL;
701
1f7ba331
AE
702 spin_lock(&rbd_client_list_lock);
703 list_for_each_entry(client_node, &rbd_client_list, node) {
704 if (!ceph_compare_options(ceph_opts, client_node->client)) {
2f82ee54
AE
705 __rbd_get_client(client_node);
706
1f7ba331
AE
707 found = true;
708 break;
709 }
710 }
711 spin_unlock(&rbd_client_list_lock);
712
713 return found ? client_node : NULL;
602adf40
YS
714}
715
59c2be1e
YS
716/*
717 * mount options
718 */
719enum {
59c2be1e
YS
720 Opt_last_int,
721 /* int args above */
722 Opt_last_string,
723 /* string args above */
cc0538b6
AE
724 Opt_read_only,
725 Opt_read_write,
726 /* Boolean args above */
727 Opt_last_bool,
59c2be1e
YS
728};
729
43ae4701 730static match_table_t rbd_opts_tokens = {
59c2be1e
YS
731 /* int args above */
732 /* string args above */
be466c1c 733 {Opt_read_only, "read_only"},
cc0538b6
AE
734 {Opt_read_only, "ro"}, /* Alternate spelling */
735 {Opt_read_write, "read_write"},
736 {Opt_read_write, "rw"}, /* Alternate spelling */
737 /* Boolean args above */
59c2be1e
YS
738 {-1, NULL}
739};
740
98571b5a
AE
741struct rbd_options {
742 bool read_only;
743};
744
745#define RBD_READ_ONLY_DEFAULT false
746
59c2be1e
YS
747static int parse_rbd_opts_token(char *c, void *private)
748{
43ae4701 749 struct rbd_options *rbd_opts = private;
59c2be1e
YS
750 substring_t argstr[MAX_OPT_ARGS];
751 int token, intval, ret;
752
43ae4701 753 token = match_token(c, rbd_opts_tokens, argstr);
59c2be1e
YS
754 if (token < 0)
755 return -EINVAL;
756
757 if (token < Opt_last_int) {
758 ret = match_int(&argstr[0], &intval);
759 if (ret < 0) {
760 pr_err("bad mount option arg (not int) "
761 "at '%s'\n", c);
762 return ret;
763 }
764 dout("got int token %d val %d\n", token, intval);
765 } else if (token > Opt_last_int && token < Opt_last_string) {
766 dout("got string token %d val %s\n", token,
767 argstr[0].from);
cc0538b6
AE
768 } else if (token > Opt_last_string && token < Opt_last_bool) {
769 dout("got Boolean token %d\n", token);
59c2be1e
YS
770 } else {
771 dout("got token %d\n", token);
772 }
773
774 switch (token) {
cc0538b6
AE
775 case Opt_read_only:
776 rbd_opts->read_only = true;
777 break;
778 case Opt_read_write:
779 rbd_opts->read_only = false;
780 break;
59c2be1e 781 default:
aafb230e
AE
782 rbd_assert(false);
783 break;
59c2be1e
YS
784 }
785 return 0;
786}
787
602adf40
YS
788/*
789 * Get a ceph client with specific addr and configuration, if one does
7262cfca
AE
790 * not exist create it. Either way, ceph_opts is consumed by this
791 * function.
602adf40 792 */
9d3997fd 793static struct rbd_client *rbd_get_client(struct ceph_options *ceph_opts)
602adf40 794{
f8c38929 795 struct rbd_client *rbdc;
59c2be1e 796
cfbf6377 797 mutex_lock_nested(&client_mutex, SINGLE_DEPTH_NESTING);
1f7ba331 798 rbdc = rbd_client_find(ceph_opts);
9d3997fd 799 if (rbdc) /* using an existing client */
43ae4701 800 ceph_destroy_options(ceph_opts);
9d3997fd 801 else
f8c38929 802 rbdc = rbd_client_create(ceph_opts);
cfbf6377 803 mutex_unlock(&client_mutex);
602adf40 804
9d3997fd 805 return rbdc;
602adf40
YS
806}
807
808/*
809 * Destroy ceph client
d23a4b3f 810 *
432b8587 811 * Caller must hold rbd_client_list_lock.
602adf40
YS
812 */
813static void rbd_client_release(struct kref *kref)
814{
815 struct rbd_client *rbdc = container_of(kref, struct rbd_client, kref);
816
37206ee5 817 dout("%s: rbdc %p\n", __func__, rbdc);
cd9d9f5d 818 spin_lock(&rbd_client_list_lock);
602adf40 819 list_del(&rbdc->node);
cd9d9f5d 820 spin_unlock(&rbd_client_list_lock);
602adf40
YS
821
822 ceph_destroy_client(rbdc->client);
823 kfree(rbdc);
824}
825
826/*
827 * Drop reference to ceph client node. If it's not referenced anymore, release
828 * it.
829 */
9d3997fd 830static void rbd_put_client(struct rbd_client *rbdc)
602adf40 831{
c53d5893
AE
832 if (rbdc)
833 kref_put(&rbdc->kref, rbd_client_release);
602adf40
YS
834}
835
a30b71b9
AE
836static bool rbd_image_format_valid(u32 image_format)
837{
838 return image_format == 1 || image_format == 2;
839}
840
8e94af8e
AE
841static bool rbd_dev_ondisk_valid(struct rbd_image_header_ondisk *ondisk)
842{
103a150f
AE
843 size_t size;
844 u32 snap_count;
845
846 /* The header has to start with the magic rbd header text */
847 if (memcmp(&ondisk->text, RBD_HEADER_TEXT, sizeof (RBD_HEADER_TEXT)))
848 return false;
849
db2388b6
AE
850 /* The bio layer requires at least sector-sized I/O */
851
852 if (ondisk->options.order < SECTOR_SHIFT)
853 return false;
854
855 /* If we use u64 in a few spots we may be able to loosen this */
856
857 if (ondisk->options.order > 8 * sizeof (int) - 1)
858 return false;
859
103a150f
AE
860 /*
861 * The size of a snapshot header has to fit in a size_t, and
862 * that limits the number of snapshots.
863 */
864 snap_count = le32_to_cpu(ondisk->snap_count);
865 size = SIZE_MAX - sizeof (struct ceph_snap_context);
866 if (snap_count > size / sizeof (__le64))
867 return false;
868
869 /*
870 * Not only that, but the size of the entire the snapshot
871 * header must also be representable in a size_t.
872 */
873 size -= snap_count * sizeof (__le64);
874 if ((u64) size < le64_to_cpu(ondisk->snap_names_len))
875 return false;
876
877 return true;
8e94af8e
AE
878}
879
602adf40 880/*
bb23e37a
AE
881 * Fill an rbd image header with information from the given format 1
882 * on-disk header.
602adf40 883 */
662518b1 884static int rbd_header_from_disk(struct rbd_device *rbd_dev,
4156d998 885 struct rbd_image_header_ondisk *ondisk)
602adf40 886{
662518b1 887 struct rbd_image_header *header = &rbd_dev->header;
bb23e37a
AE
888 bool first_time = header->object_prefix == NULL;
889 struct ceph_snap_context *snapc;
890 char *object_prefix = NULL;
891 char *snap_names = NULL;
892 u64 *snap_sizes = NULL;
ccece235 893 u32 snap_count;
d2bb24e5 894 size_t size;
bb23e37a 895 int ret = -ENOMEM;
621901d6 896 u32 i;
602adf40 897
bb23e37a 898 /* Allocate this now to avoid having to handle failure below */
6a52325f 899
bb23e37a
AE
900 if (first_time) {
901 size_t len;
103a150f 902
bb23e37a
AE
903 len = strnlen(ondisk->object_prefix,
904 sizeof (ondisk->object_prefix));
905 object_prefix = kmalloc(len + 1, GFP_KERNEL);
906 if (!object_prefix)
907 return -ENOMEM;
908 memcpy(object_prefix, ondisk->object_prefix, len);
909 object_prefix[len] = '\0';
910 }
00f1f36f 911
bb23e37a 912 /* Allocate the snapshot context and fill it in */
00f1f36f 913
bb23e37a
AE
914 snap_count = le32_to_cpu(ondisk->snap_count);
915 snapc = ceph_create_snap_context(snap_count, GFP_KERNEL);
916 if (!snapc)
917 goto out_err;
918 snapc->seq = le64_to_cpu(ondisk->snap_seq);
602adf40 919 if (snap_count) {
bb23e37a 920 struct rbd_image_snap_ondisk *snaps;
f785cc1d
AE
921 u64 snap_names_len = le64_to_cpu(ondisk->snap_names_len);
922
bb23e37a 923 /* We'll keep a copy of the snapshot names... */
621901d6 924
bb23e37a
AE
925 if (snap_names_len > (u64)SIZE_MAX)
926 goto out_2big;
927 snap_names = kmalloc(snap_names_len, GFP_KERNEL);
928 if (!snap_names)
6a52325f
AE
929 goto out_err;
930
bb23e37a 931 /* ...as well as the array of their sizes. */
621901d6 932
d2bb24e5 933 size = snap_count * sizeof (*header->snap_sizes);
bb23e37a
AE
934 snap_sizes = kmalloc(size, GFP_KERNEL);
935 if (!snap_sizes)
6a52325f 936 goto out_err;
bb23e37a 937
f785cc1d 938 /*
bb23e37a
AE
939 * Copy the names, and fill in each snapshot's id
940 * and size.
941 *
99a41ebc 942 * Note that rbd_dev_v1_header_info() guarantees the
bb23e37a 943 * ondisk buffer we're working with has
f785cc1d
AE
944 * snap_names_len bytes beyond the end of the
945 * snapshot id array, this memcpy() is safe.
946 */
bb23e37a
AE
947 memcpy(snap_names, &ondisk->snaps[snap_count], snap_names_len);
948 snaps = ondisk->snaps;
949 for (i = 0; i < snap_count; i++) {
950 snapc->snaps[i] = le64_to_cpu(snaps[i].id);
951 snap_sizes[i] = le64_to_cpu(snaps[i].image_size);
952 }
602adf40 953 }
6a52325f 954
bb23e37a 955 /* We won't fail any more, fill in the header */
621901d6 956
bb23e37a
AE
957 if (first_time) {
958 header->object_prefix = object_prefix;
959 header->obj_order = ondisk->options.order;
960 header->crypt_type = ondisk->options.crypt_type;
961 header->comp_type = ondisk->options.comp_type;
962 /* The rest aren't used for format 1 images */
963 header->stripe_unit = 0;
964 header->stripe_count = 0;
965 header->features = 0;
602adf40 966 } else {
662518b1
AE
967 ceph_put_snap_context(header->snapc);
968 kfree(header->snap_names);
969 kfree(header->snap_sizes);
602adf40 970 }
849b4260 971
bb23e37a 972 /* The remaining fields always get updated (when we refresh) */
621901d6 973
f84344f3 974 header->image_size = le64_to_cpu(ondisk->image_size);
bb23e37a
AE
975 header->snapc = snapc;
976 header->snap_names = snap_names;
977 header->snap_sizes = snap_sizes;
468521c1 978
602adf40 979 return 0;
bb23e37a
AE
980out_2big:
981 ret = -EIO;
6a52325f 982out_err:
bb23e37a
AE
983 kfree(snap_sizes);
984 kfree(snap_names);
985 ceph_put_snap_context(snapc);
986 kfree(object_prefix);
ccece235 987
bb23e37a 988 return ret;
602adf40
YS
989}
990
9682fc6d
AE
991static const char *_rbd_dev_v1_snap_name(struct rbd_device *rbd_dev, u32 which)
992{
993 const char *snap_name;
994
995 rbd_assert(which < rbd_dev->header.snapc->num_snaps);
996
997 /* Skip over names until we find the one we are looking for */
998
999 snap_name = rbd_dev->header.snap_names;
1000 while (which--)
1001 snap_name += strlen(snap_name) + 1;
1002
1003 return kstrdup(snap_name, GFP_KERNEL);
1004}
1005
30d1cff8
AE
1006/*
1007 * Snapshot id comparison function for use with qsort()/bsearch().
1008 * Note that result is for snapshots in *descending* order.
1009 */
1010static int snapid_compare_reverse(const void *s1, const void *s2)
1011{
1012 u64 snap_id1 = *(u64 *)s1;
1013 u64 snap_id2 = *(u64 *)s2;
1014
1015 if (snap_id1 < snap_id2)
1016 return 1;
1017 return snap_id1 == snap_id2 ? 0 : -1;
1018}
1019
1020/*
1021 * Search a snapshot context to see if the given snapshot id is
1022 * present.
1023 *
1024 * Returns the position of the snapshot id in the array if it's found,
1025 * or BAD_SNAP_INDEX otherwise.
1026 *
1027 * Note: The snapshot array is in kept sorted (by the osd) in
1028 * reverse order, highest snapshot id first.
1029 */
9682fc6d
AE
1030static u32 rbd_dev_snap_index(struct rbd_device *rbd_dev, u64 snap_id)
1031{
1032 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
30d1cff8 1033 u64 *found;
9682fc6d 1034
30d1cff8
AE
1035 found = bsearch(&snap_id, &snapc->snaps, snapc->num_snaps,
1036 sizeof (snap_id), snapid_compare_reverse);
9682fc6d 1037
30d1cff8 1038 return found ? (u32)(found - &snapc->snaps[0]) : BAD_SNAP_INDEX;
9682fc6d
AE
1039}
1040
2ad3d716
AE
1041static const char *rbd_dev_v1_snap_name(struct rbd_device *rbd_dev,
1042 u64 snap_id)
9e15b77d 1043{
54cac61f 1044 u32 which;
da6a6b63 1045 const char *snap_name;
9e15b77d 1046
54cac61f
AE
1047 which = rbd_dev_snap_index(rbd_dev, snap_id);
1048 if (which == BAD_SNAP_INDEX)
da6a6b63 1049 return ERR_PTR(-ENOENT);
54cac61f 1050
da6a6b63
JD
1051 snap_name = _rbd_dev_v1_snap_name(rbd_dev, which);
1052 return snap_name ? snap_name : ERR_PTR(-ENOMEM);
54cac61f
AE
1053}
1054
1055static const char *rbd_snap_name(struct rbd_device *rbd_dev, u64 snap_id)
1056{
9e15b77d
AE
1057 if (snap_id == CEPH_NOSNAP)
1058 return RBD_SNAP_HEAD_NAME;
1059
54cac61f
AE
1060 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
1061 if (rbd_dev->image_format == 1)
1062 return rbd_dev_v1_snap_name(rbd_dev, snap_id);
9e15b77d 1063
54cac61f 1064 return rbd_dev_v2_snap_name(rbd_dev, snap_id);
9e15b77d
AE
1065}
1066
2ad3d716
AE
1067static int rbd_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
1068 u64 *snap_size)
602adf40 1069{
2ad3d716
AE
1070 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
1071 if (snap_id == CEPH_NOSNAP) {
1072 *snap_size = rbd_dev->header.image_size;
1073 } else if (rbd_dev->image_format == 1) {
1074 u32 which;
602adf40 1075
2ad3d716
AE
1076 which = rbd_dev_snap_index(rbd_dev, snap_id);
1077 if (which == BAD_SNAP_INDEX)
1078 return -ENOENT;
e86924a8 1079
2ad3d716
AE
1080 *snap_size = rbd_dev->header.snap_sizes[which];
1081 } else {
1082 u64 size = 0;
1083 int ret;
1084
1085 ret = _rbd_dev_v2_snap_size(rbd_dev, snap_id, NULL, &size);
1086 if (ret)
1087 return ret;
1088
1089 *snap_size = size;
1090 }
1091 return 0;
602adf40
YS
1092}
1093
2ad3d716
AE
1094static int rbd_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
1095 u64 *snap_features)
602adf40 1096{
2ad3d716
AE
1097 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
1098 if (snap_id == CEPH_NOSNAP) {
1099 *snap_features = rbd_dev->header.features;
1100 } else if (rbd_dev->image_format == 1) {
1101 *snap_features = 0; /* No features for format 1 */
602adf40 1102 } else {
2ad3d716
AE
1103 u64 features = 0;
1104 int ret;
8b0241f8 1105
2ad3d716
AE
1106 ret = _rbd_dev_v2_snap_features(rbd_dev, snap_id, &features);
1107 if (ret)
1108 return ret;
1109
1110 *snap_features = features;
1111 }
1112 return 0;
1113}
1114
1115static int rbd_dev_mapping_set(struct rbd_device *rbd_dev)
1116{
8f4b7d98 1117 u64 snap_id = rbd_dev->spec->snap_id;
2ad3d716
AE
1118 u64 size = 0;
1119 u64 features = 0;
1120 int ret;
1121
2ad3d716
AE
1122 ret = rbd_snap_size(rbd_dev, snap_id, &size);
1123 if (ret)
1124 return ret;
1125 ret = rbd_snap_features(rbd_dev, snap_id, &features);
1126 if (ret)
1127 return ret;
1128
1129 rbd_dev->mapping.size = size;
1130 rbd_dev->mapping.features = features;
1131
8b0241f8 1132 return 0;
602adf40
YS
1133}
1134
d1cf5788
AE
1135static void rbd_dev_mapping_clear(struct rbd_device *rbd_dev)
1136{
1137 rbd_dev->mapping.size = 0;
1138 rbd_dev->mapping.features = 0;
200a6a8b
AE
1139}
1140
7d5079aa
HS
1141static void rbd_segment_name_free(const char *name)
1142{
1143 /* The explicit cast here is needed to drop the const qualifier */
1144
1145 kmem_cache_free(rbd_segment_name_cache, (void *)name);
1146}
1147
98571b5a 1148static const char *rbd_segment_name(struct rbd_device *rbd_dev, u64 offset)
602adf40 1149{
65ccfe21
AE
1150 char *name;
1151 u64 segment;
1152 int ret;
3a96d5cd 1153 char *name_format;
602adf40 1154
78c2a44a 1155 name = kmem_cache_alloc(rbd_segment_name_cache, GFP_NOIO);
65ccfe21
AE
1156 if (!name)
1157 return NULL;
1158 segment = offset >> rbd_dev->header.obj_order;
3a96d5cd
JD
1159 name_format = "%s.%012llx";
1160 if (rbd_dev->image_format == 2)
1161 name_format = "%s.%016llx";
2d0ebc5d 1162 ret = snprintf(name, CEPH_MAX_OID_NAME_LEN + 1, name_format,
65ccfe21 1163 rbd_dev->header.object_prefix, segment);
2d0ebc5d 1164 if (ret < 0 || ret > CEPH_MAX_OID_NAME_LEN) {
65ccfe21
AE
1165 pr_err("error formatting segment name for #%llu (%d)\n",
1166 segment, ret);
7d5079aa 1167 rbd_segment_name_free(name);
65ccfe21
AE
1168 name = NULL;
1169 }
602adf40 1170
65ccfe21
AE
1171 return name;
1172}
602adf40 1173
65ccfe21
AE
1174static u64 rbd_segment_offset(struct rbd_device *rbd_dev, u64 offset)
1175{
1176 u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
602adf40 1177
65ccfe21
AE
1178 return offset & (segment_size - 1);
1179}
1180
1181static u64 rbd_segment_length(struct rbd_device *rbd_dev,
1182 u64 offset, u64 length)
1183{
1184 u64 segment_size = (u64) 1 << rbd_dev->header.obj_order;
1185
1186 offset &= segment_size - 1;
1187
aafb230e 1188 rbd_assert(length <= U64_MAX - offset);
65ccfe21
AE
1189 if (offset + length > segment_size)
1190 length = segment_size - offset;
1191
1192 return length;
602adf40
YS
1193}
1194
029bcbd8
JD
1195/*
1196 * returns the size of an object in the image
1197 */
1198static u64 rbd_obj_bytes(struct rbd_image_header *header)
1199{
1200 return 1 << header->obj_order;
1201}
1202
602adf40
YS
1203/*
1204 * bio helpers
1205 */
1206
1207static void bio_chain_put(struct bio *chain)
1208{
1209 struct bio *tmp;
1210
1211 while (chain) {
1212 tmp = chain;
1213 chain = chain->bi_next;
1214 bio_put(tmp);
1215 }
1216}
1217
1218/*
1219 * zeros a bio chain, starting at specific offset
1220 */
1221static void zero_bio_chain(struct bio *chain, int start_ofs)
1222{
7988613b
KO
1223 struct bio_vec bv;
1224 struct bvec_iter iter;
602adf40
YS
1225 unsigned long flags;
1226 void *buf;
602adf40
YS
1227 int pos = 0;
1228
1229 while (chain) {
7988613b
KO
1230 bio_for_each_segment(bv, chain, iter) {
1231 if (pos + bv.bv_len > start_ofs) {
602adf40 1232 int remainder = max(start_ofs - pos, 0);
7988613b 1233 buf = bvec_kmap_irq(&bv, &flags);
602adf40 1234 memset(buf + remainder, 0,
7988613b
KO
1235 bv.bv_len - remainder);
1236 flush_dcache_page(bv.bv_page);
85b5aaa6 1237 bvec_kunmap_irq(buf, &flags);
602adf40 1238 }
7988613b 1239 pos += bv.bv_len;
602adf40
YS
1240 }
1241
1242 chain = chain->bi_next;
1243 }
1244}
1245
b9434c5b
AE
1246/*
1247 * similar to zero_bio_chain(), zeros data defined by a page array,
1248 * starting at the given byte offset from the start of the array and
1249 * continuing up to the given end offset. The pages array is
1250 * assumed to be big enough to hold all bytes up to the end.
1251 */
1252static void zero_pages(struct page **pages, u64 offset, u64 end)
1253{
1254 struct page **page = &pages[offset >> PAGE_SHIFT];
1255
1256 rbd_assert(end > offset);
1257 rbd_assert(end - offset <= (u64)SIZE_MAX);
1258 while (offset < end) {
1259 size_t page_offset;
1260 size_t length;
1261 unsigned long flags;
1262 void *kaddr;
1263
491205a8
GU
1264 page_offset = offset & ~PAGE_MASK;
1265 length = min_t(size_t, PAGE_SIZE - page_offset, end - offset);
b9434c5b
AE
1266 local_irq_save(flags);
1267 kaddr = kmap_atomic(*page);
1268 memset(kaddr + page_offset, 0, length);
e2156054 1269 flush_dcache_page(*page);
b9434c5b
AE
1270 kunmap_atomic(kaddr);
1271 local_irq_restore(flags);
1272
1273 offset += length;
1274 page++;
1275 }
1276}
1277
602adf40 1278/*
f7760dad
AE
1279 * Clone a portion of a bio, starting at the given byte offset
1280 * and continuing for the number of bytes indicated.
602adf40 1281 */
f7760dad
AE
1282static struct bio *bio_clone_range(struct bio *bio_src,
1283 unsigned int offset,
1284 unsigned int len,
1285 gfp_t gfpmask)
602adf40 1286{
f7760dad
AE
1287 struct bio *bio;
1288
5341a627 1289 bio = bio_clone(bio_src, gfpmask);
f7760dad
AE
1290 if (!bio)
1291 return NULL; /* ENOMEM */
602adf40 1292
5341a627 1293 bio_advance(bio, offset);
4f024f37 1294 bio->bi_iter.bi_size = len;
f7760dad
AE
1295
1296 return bio;
1297}
1298
1299/*
1300 * Clone a portion of a bio chain, starting at the given byte offset
1301 * into the first bio in the source chain and continuing for the
1302 * number of bytes indicated. The result is another bio chain of
1303 * exactly the given length, or a null pointer on error.
1304 *
1305 * The bio_src and offset parameters are both in-out. On entry they
1306 * refer to the first source bio and the offset into that bio where
1307 * the start of data to be cloned is located.
1308 *
1309 * On return, bio_src is updated to refer to the bio in the source
1310 * chain that contains first un-cloned byte, and *offset will
1311 * contain the offset of that byte within that bio.
1312 */
1313static struct bio *bio_chain_clone_range(struct bio **bio_src,
1314 unsigned int *offset,
1315 unsigned int len,
1316 gfp_t gfpmask)
1317{
1318 struct bio *bi = *bio_src;
1319 unsigned int off = *offset;
1320 struct bio *chain = NULL;
1321 struct bio **end;
1322
1323 /* Build up a chain of clone bios up to the limit */
1324
4f024f37 1325 if (!bi || off >= bi->bi_iter.bi_size || !len)
f7760dad 1326 return NULL; /* Nothing to clone */
602adf40 1327
f7760dad
AE
1328 end = &chain;
1329 while (len) {
1330 unsigned int bi_size;
1331 struct bio *bio;
1332
f5400b7a
AE
1333 if (!bi) {
1334 rbd_warn(NULL, "bio_chain exhausted with %u left", len);
f7760dad 1335 goto out_err; /* EINVAL; ran out of bio's */
f5400b7a 1336 }
4f024f37 1337 bi_size = min_t(unsigned int, bi->bi_iter.bi_size - off, len);
f7760dad
AE
1338 bio = bio_clone_range(bi, off, bi_size, gfpmask);
1339 if (!bio)
1340 goto out_err; /* ENOMEM */
1341
1342 *end = bio;
1343 end = &bio->bi_next;
602adf40 1344
f7760dad 1345 off += bi_size;
4f024f37 1346 if (off == bi->bi_iter.bi_size) {
f7760dad
AE
1347 bi = bi->bi_next;
1348 off = 0;
1349 }
1350 len -= bi_size;
1351 }
1352 *bio_src = bi;
1353 *offset = off;
1354
1355 return chain;
1356out_err:
1357 bio_chain_put(chain);
602adf40 1358
602adf40
YS
1359 return NULL;
1360}
1361
926f9b3f
AE
1362/*
1363 * The default/initial value for all object request flags is 0. For
1364 * each flag, once its value is set to 1 it is never reset to 0
1365 * again.
1366 */
57acbaa7 1367static void obj_request_img_data_set(struct rbd_obj_request *obj_request)
926f9b3f 1368{
57acbaa7 1369 if (test_and_set_bit(OBJ_REQ_IMG_DATA, &obj_request->flags)) {
926f9b3f
AE
1370 struct rbd_device *rbd_dev;
1371
57acbaa7 1372 rbd_dev = obj_request->img_request->rbd_dev;
9584d508 1373 rbd_warn(rbd_dev, "obj_request %p already marked img_data",
926f9b3f
AE
1374 obj_request);
1375 }
1376}
1377
57acbaa7 1378static bool obj_request_img_data_test(struct rbd_obj_request *obj_request)
926f9b3f
AE
1379{
1380 smp_mb();
57acbaa7 1381 return test_bit(OBJ_REQ_IMG_DATA, &obj_request->flags) != 0;
926f9b3f
AE
1382}
1383
57acbaa7 1384static void obj_request_done_set(struct rbd_obj_request *obj_request)
6365d33a 1385{
57acbaa7
AE
1386 if (test_and_set_bit(OBJ_REQ_DONE, &obj_request->flags)) {
1387 struct rbd_device *rbd_dev = NULL;
6365d33a 1388
57acbaa7
AE
1389 if (obj_request_img_data_test(obj_request))
1390 rbd_dev = obj_request->img_request->rbd_dev;
9584d508 1391 rbd_warn(rbd_dev, "obj_request %p already marked done",
6365d33a
AE
1392 obj_request);
1393 }
1394}
1395
57acbaa7 1396static bool obj_request_done_test(struct rbd_obj_request *obj_request)
6365d33a
AE
1397{
1398 smp_mb();
57acbaa7 1399 return test_bit(OBJ_REQ_DONE, &obj_request->flags) != 0;
6365d33a
AE
1400}
1401
5679c59f
AE
1402/*
1403 * This sets the KNOWN flag after (possibly) setting the EXISTS
1404 * flag. The latter is set based on the "exists" value provided.
1405 *
1406 * Note that for our purposes once an object exists it never goes
1407 * away again. It's possible that the response from two existence
1408 * checks are separated by the creation of the target object, and
1409 * the first ("doesn't exist") response arrives *after* the second
1410 * ("does exist"). In that case we ignore the second one.
1411 */
1412static void obj_request_existence_set(struct rbd_obj_request *obj_request,
1413 bool exists)
1414{
1415 if (exists)
1416 set_bit(OBJ_REQ_EXISTS, &obj_request->flags);
1417 set_bit(OBJ_REQ_KNOWN, &obj_request->flags);
1418 smp_mb();
1419}
1420
1421static bool obj_request_known_test(struct rbd_obj_request *obj_request)
1422{
1423 smp_mb();
1424 return test_bit(OBJ_REQ_KNOWN, &obj_request->flags) != 0;
1425}
1426
1427static bool obj_request_exists_test(struct rbd_obj_request *obj_request)
1428{
1429 smp_mb();
1430 return test_bit(OBJ_REQ_EXISTS, &obj_request->flags) != 0;
1431}
1432
9638556a
ID
1433static bool obj_request_overlaps_parent(struct rbd_obj_request *obj_request)
1434{
1435 struct rbd_device *rbd_dev = obj_request->img_request->rbd_dev;
1436
1437 return obj_request->img_offset <
1438 round_up(rbd_dev->parent_overlap, rbd_obj_bytes(&rbd_dev->header));
1439}
1440
bf0d5f50
AE
1441static void rbd_obj_request_get(struct rbd_obj_request *obj_request)
1442{
37206ee5
AE
1443 dout("%s: obj %p (was %d)\n", __func__, obj_request,
1444 atomic_read(&obj_request->kref.refcount));
bf0d5f50
AE
1445 kref_get(&obj_request->kref);
1446}
1447
1448static void rbd_obj_request_destroy(struct kref *kref);
1449static void rbd_obj_request_put(struct rbd_obj_request *obj_request)
1450{
1451 rbd_assert(obj_request != NULL);
37206ee5
AE
1452 dout("%s: obj %p (was %d)\n", __func__, obj_request,
1453 atomic_read(&obj_request->kref.refcount));
bf0d5f50
AE
1454 kref_put(&obj_request->kref, rbd_obj_request_destroy);
1455}
1456
0f2d5be7
AE
1457static void rbd_img_request_get(struct rbd_img_request *img_request)
1458{
1459 dout("%s: img %p (was %d)\n", __func__, img_request,
1460 atomic_read(&img_request->kref.refcount));
1461 kref_get(&img_request->kref);
1462}
1463
e93f3152
AE
1464static bool img_request_child_test(struct rbd_img_request *img_request);
1465static void rbd_parent_request_destroy(struct kref *kref);
bf0d5f50
AE
1466static void rbd_img_request_destroy(struct kref *kref);
1467static void rbd_img_request_put(struct rbd_img_request *img_request)
1468{
1469 rbd_assert(img_request != NULL);
37206ee5
AE
1470 dout("%s: img %p (was %d)\n", __func__, img_request,
1471 atomic_read(&img_request->kref.refcount));
e93f3152
AE
1472 if (img_request_child_test(img_request))
1473 kref_put(&img_request->kref, rbd_parent_request_destroy);
1474 else
1475 kref_put(&img_request->kref, rbd_img_request_destroy);
bf0d5f50
AE
1476}
1477
1478static inline void rbd_img_obj_request_add(struct rbd_img_request *img_request,
1479 struct rbd_obj_request *obj_request)
1480{
25dcf954
AE
1481 rbd_assert(obj_request->img_request == NULL);
1482
b155e86c 1483 /* Image request now owns object's original reference */
bf0d5f50 1484 obj_request->img_request = img_request;
25dcf954 1485 obj_request->which = img_request->obj_request_count;
6365d33a
AE
1486 rbd_assert(!obj_request_img_data_test(obj_request));
1487 obj_request_img_data_set(obj_request);
bf0d5f50 1488 rbd_assert(obj_request->which != BAD_WHICH);
25dcf954
AE
1489 img_request->obj_request_count++;
1490 list_add_tail(&obj_request->links, &img_request->obj_requests);
37206ee5
AE
1491 dout("%s: img %p obj %p w=%u\n", __func__, img_request, obj_request,
1492 obj_request->which);
bf0d5f50
AE
1493}
1494
1495static inline void rbd_img_obj_request_del(struct rbd_img_request *img_request,
1496 struct rbd_obj_request *obj_request)
1497{
1498 rbd_assert(obj_request->which != BAD_WHICH);
25dcf954 1499
37206ee5
AE
1500 dout("%s: img %p obj %p w=%u\n", __func__, img_request, obj_request,
1501 obj_request->which);
bf0d5f50 1502 list_del(&obj_request->links);
25dcf954
AE
1503 rbd_assert(img_request->obj_request_count > 0);
1504 img_request->obj_request_count--;
1505 rbd_assert(obj_request->which == img_request->obj_request_count);
1506 obj_request->which = BAD_WHICH;
6365d33a 1507 rbd_assert(obj_request_img_data_test(obj_request));
bf0d5f50 1508 rbd_assert(obj_request->img_request == img_request);
bf0d5f50 1509 obj_request->img_request = NULL;
25dcf954 1510 obj_request->callback = NULL;
bf0d5f50
AE
1511 rbd_obj_request_put(obj_request);
1512}
1513
1514static bool obj_request_type_valid(enum obj_request_type type)
1515{
1516 switch (type) {
9969ebc5 1517 case OBJ_REQUEST_NODATA:
bf0d5f50 1518 case OBJ_REQUEST_BIO:
788e2df3 1519 case OBJ_REQUEST_PAGES:
bf0d5f50
AE
1520 return true;
1521 default:
1522 return false;
1523 }
1524}
1525
bf0d5f50
AE
1526static int rbd_obj_request_submit(struct ceph_osd_client *osdc,
1527 struct rbd_obj_request *obj_request)
1528{
71c20a06 1529 dout("%s %p\n", __func__, obj_request);
bf0d5f50
AE
1530 return ceph_osdc_start_request(osdc, obj_request->osd_req, false);
1531}
1532
71c20a06
ID
1533static void rbd_obj_request_end(struct rbd_obj_request *obj_request)
1534{
1535 dout("%s %p\n", __func__, obj_request);
1536 ceph_osdc_cancel_request(obj_request->osd_req);
1537}
1538
1539/*
1540 * Wait for an object request to complete. If interrupted, cancel the
1541 * underlying osd request.
1542 */
1543static int rbd_obj_request_wait(struct rbd_obj_request *obj_request)
1544{
1545 int ret;
1546
1547 dout("%s %p\n", __func__, obj_request);
1548
1549 ret = wait_for_completion_interruptible(&obj_request->completion);
1550 if (ret < 0) {
1551 dout("%s %p interrupted\n", __func__, obj_request);
1552 rbd_obj_request_end(obj_request);
1553 return ret;
1554 }
1555
1556 dout("%s %p done\n", __func__, obj_request);
1557 return 0;
1558}
1559
bf0d5f50
AE
1560static void rbd_img_request_complete(struct rbd_img_request *img_request)
1561{
55f27e09 1562
37206ee5 1563 dout("%s: img %p\n", __func__, img_request);
55f27e09
AE
1564
1565 /*
1566 * If no error occurred, compute the aggregate transfer
1567 * count for the image request. We could instead use
1568 * atomic64_cmpxchg() to update it as each object request
1569 * completes; not clear which way is better off hand.
1570 */
1571 if (!img_request->result) {
1572 struct rbd_obj_request *obj_request;
1573 u64 xferred = 0;
1574
1575 for_each_obj_request(img_request, obj_request)
1576 xferred += obj_request->xferred;
1577 img_request->xferred = xferred;
1578 }
1579
bf0d5f50
AE
1580 if (img_request->callback)
1581 img_request->callback(img_request);
1582 else
1583 rbd_img_request_put(img_request);
1584}
1585
0c425248
AE
1586/*
1587 * The default/initial value for all image request flags is 0. Each
1588 * is conditionally set to 1 at image request initialization time
1589 * and currently never change thereafter.
1590 */
1591static void img_request_write_set(struct rbd_img_request *img_request)
1592{
1593 set_bit(IMG_REQ_WRITE, &img_request->flags);
1594 smp_mb();
1595}
1596
1597static bool img_request_write_test(struct rbd_img_request *img_request)
1598{
1599 smp_mb();
1600 return test_bit(IMG_REQ_WRITE, &img_request->flags) != 0;
1601}
1602
9849e986
AE
1603static void img_request_child_set(struct rbd_img_request *img_request)
1604{
1605 set_bit(IMG_REQ_CHILD, &img_request->flags);
1606 smp_mb();
1607}
1608
e93f3152
AE
1609static void img_request_child_clear(struct rbd_img_request *img_request)
1610{
1611 clear_bit(IMG_REQ_CHILD, &img_request->flags);
1612 smp_mb();
1613}
1614
9849e986
AE
1615static bool img_request_child_test(struct rbd_img_request *img_request)
1616{
1617 smp_mb();
1618 return test_bit(IMG_REQ_CHILD, &img_request->flags) != 0;
1619}
1620
d0b2e944
AE
1621static void img_request_layered_set(struct rbd_img_request *img_request)
1622{
1623 set_bit(IMG_REQ_LAYERED, &img_request->flags);
1624 smp_mb();
1625}
1626
a2acd00e
AE
1627static void img_request_layered_clear(struct rbd_img_request *img_request)
1628{
1629 clear_bit(IMG_REQ_LAYERED, &img_request->flags);
1630 smp_mb();
1631}
1632
d0b2e944
AE
1633static bool img_request_layered_test(struct rbd_img_request *img_request)
1634{
1635 smp_mb();
1636 return test_bit(IMG_REQ_LAYERED, &img_request->flags) != 0;
1637}
1638
6e2a4505
AE
1639static void
1640rbd_img_obj_request_read_callback(struct rbd_obj_request *obj_request)
1641{
b9434c5b
AE
1642 u64 xferred = obj_request->xferred;
1643 u64 length = obj_request->length;
1644
6e2a4505
AE
1645 dout("%s: obj %p img %p result %d %llu/%llu\n", __func__,
1646 obj_request, obj_request->img_request, obj_request->result,
b9434c5b 1647 xferred, length);
6e2a4505 1648 /*
17c1cc1d
JD
1649 * ENOENT means a hole in the image. We zero-fill the entire
1650 * length of the request. A short read also implies zero-fill
1651 * to the end of the request. An error requires the whole
1652 * length of the request to be reported finished with an error
1653 * to the block layer. In each case we update the xferred
1654 * count to indicate the whole request was satisfied.
6e2a4505 1655 */
b9434c5b 1656 rbd_assert(obj_request->type != OBJ_REQUEST_NODATA);
6e2a4505 1657 if (obj_request->result == -ENOENT) {
b9434c5b
AE
1658 if (obj_request->type == OBJ_REQUEST_BIO)
1659 zero_bio_chain(obj_request->bio_list, 0);
1660 else
1661 zero_pages(obj_request->pages, 0, length);
6e2a4505 1662 obj_request->result = 0;
b9434c5b
AE
1663 } else if (xferred < length && !obj_request->result) {
1664 if (obj_request->type == OBJ_REQUEST_BIO)
1665 zero_bio_chain(obj_request->bio_list, xferred);
1666 else
1667 zero_pages(obj_request->pages, xferred, length);
6e2a4505 1668 }
17c1cc1d 1669 obj_request->xferred = length;
6e2a4505
AE
1670 obj_request_done_set(obj_request);
1671}
1672
bf0d5f50
AE
1673static void rbd_obj_request_complete(struct rbd_obj_request *obj_request)
1674{
37206ee5
AE
1675 dout("%s: obj %p cb %p\n", __func__, obj_request,
1676 obj_request->callback);
bf0d5f50
AE
1677 if (obj_request->callback)
1678 obj_request->callback(obj_request);
788e2df3
AE
1679 else
1680 complete_all(&obj_request->completion);
bf0d5f50
AE
1681}
1682
c47f9371 1683static void rbd_osd_trivial_callback(struct rbd_obj_request *obj_request)
39bf2c5d
AE
1684{
1685 dout("%s: obj %p\n", __func__, obj_request);
1686 obj_request_done_set(obj_request);
1687}
1688
c47f9371 1689static void rbd_osd_read_callback(struct rbd_obj_request *obj_request)
bf0d5f50 1690{
57acbaa7 1691 struct rbd_img_request *img_request = NULL;
a9e8ba2c 1692 struct rbd_device *rbd_dev = NULL;
57acbaa7
AE
1693 bool layered = false;
1694
1695 if (obj_request_img_data_test(obj_request)) {
1696 img_request = obj_request->img_request;
1697 layered = img_request && img_request_layered_test(img_request);
a9e8ba2c 1698 rbd_dev = img_request->rbd_dev;
57acbaa7 1699 }
8b3e1a56
AE
1700
1701 dout("%s: obj %p img %p result %d %llu/%llu\n", __func__,
1702 obj_request, img_request, obj_request->result,
1703 obj_request->xferred, obj_request->length);
a9e8ba2c
AE
1704 if (layered && obj_request->result == -ENOENT &&
1705 obj_request->img_offset < rbd_dev->parent_overlap)
8b3e1a56
AE
1706 rbd_img_parent_read(obj_request);
1707 else if (img_request)
6e2a4505
AE
1708 rbd_img_obj_request_read_callback(obj_request);
1709 else
1710 obj_request_done_set(obj_request);
bf0d5f50
AE
1711}
1712
c47f9371 1713static void rbd_osd_write_callback(struct rbd_obj_request *obj_request)
bf0d5f50 1714{
1b83bef2
SW
1715 dout("%s: obj %p result %d %llu\n", __func__, obj_request,
1716 obj_request->result, obj_request->length);
1717 /*
8b3e1a56
AE
1718 * There is no such thing as a successful short write. Set
1719 * it to our originally-requested length.
1b83bef2
SW
1720 */
1721 obj_request->xferred = obj_request->length;
07741308 1722 obj_request_done_set(obj_request);
bf0d5f50
AE
1723}
1724
fbfab539
AE
1725/*
1726 * For a simple stat call there's nothing to do. We'll do more if
1727 * this is part of a write sequence for a layered image.
1728 */
c47f9371 1729static void rbd_osd_stat_callback(struct rbd_obj_request *obj_request)
fbfab539 1730{
37206ee5 1731 dout("%s: obj %p\n", __func__, obj_request);
fbfab539
AE
1732 obj_request_done_set(obj_request);
1733}
1734
bf0d5f50
AE
1735static void rbd_osd_req_callback(struct ceph_osd_request *osd_req,
1736 struct ceph_msg *msg)
1737{
1738 struct rbd_obj_request *obj_request = osd_req->r_priv;
bf0d5f50
AE
1739 u16 opcode;
1740
37206ee5 1741 dout("%s: osd_req %p msg %p\n", __func__, osd_req, msg);
bf0d5f50 1742 rbd_assert(osd_req == obj_request->osd_req);
57acbaa7
AE
1743 if (obj_request_img_data_test(obj_request)) {
1744 rbd_assert(obj_request->img_request);
1745 rbd_assert(obj_request->which != BAD_WHICH);
1746 } else {
1747 rbd_assert(obj_request->which == BAD_WHICH);
1748 }
bf0d5f50 1749
1b83bef2
SW
1750 if (osd_req->r_result < 0)
1751 obj_request->result = osd_req->r_result;
bf0d5f50 1752
7cc69d42 1753 rbd_assert(osd_req->r_num_ops <= CEPH_OSD_MAX_OP);
bf0d5f50 1754
c47f9371
AE
1755 /*
1756 * We support a 64-bit length, but ultimately it has to be
1757 * passed to blk_end_request(), which takes an unsigned int.
1758 */
1b83bef2 1759 obj_request->xferred = osd_req->r_reply_op_len[0];
8b3e1a56 1760 rbd_assert(obj_request->xferred < (u64)UINT_MAX);
0ccd5926 1761
79528734 1762 opcode = osd_req->r_ops[0].op;
bf0d5f50
AE
1763 switch (opcode) {
1764 case CEPH_OSD_OP_READ:
c47f9371 1765 rbd_osd_read_callback(obj_request);
bf0d5f50 1766 break;
0ccd5926
ID
1767 case CEPH_OSD_OP_SETALLOCHINT:
1768 rbd_assert(osd_req->r_ops[1].op == CEPH_OSD_OP_WRITE);
1769 /* fall through */
bf0d5f50 1770 case CEPH_OSD_OP_WRITE:
c47f9371 1771 rbd_osd_write_callback(obj_request);
bf0d5f50 1772 break;
fbfab539 1773 case CEPH_OSD_OP_STAT:
c47f9371 1774 rbd_osd_stat_callback(obj_request);
fbfab539 1775 break;
36be9a76 1776 case CEPH_OSD_OP_CALL:
b8d70035 1777 case CEPH_OSD_OP_NOTIFY_ACK:
9969ebc5 1778 case CEPH_OSD_OP_WATCH:
c47f9371 1779 rbd_osd_trivial_callback(obj_request);
9969ebc5 1780 break;
bf0d5f50 1781 default:
9584d508 1782 rbd_warn(NULL, "%s: unsupported op %hu",
bf0d5f50
AE
1783 obj_request->object_name, (unsigned short) opcode);
1784 break;
1785 }
1786
07741308 1787 if (obj_request_done_test(obj_request))
bf0d5f50
AE
1788 rbd_obj_request_complete(obj_request);
1789}
1790
9d4df01f 1791static void rbd_osd_req_format_read(struct rbd_obj_request *obj_request)
430c28c3
AE
1792{
1793 struct rbd_img_request *img_request = obj_request->img_request;
8c042b0d 1794 struct ceph_osd_request *osd_req = obj_request->osd_req;
9d4df01f 1795 u64 snap_id;
430c28c3 1796
8c042b0d 1797 rbd_assert(osd_req != NULL);
430c28c3 1798
9d4df01f 1799 snap_id = img_request ? img_request->snap_id : CEPH_NOSNAP;
8c042b0d 1800 ceph_osdc_build_request(osd_req, obj_request->offset,
9d4df01f
AE
1801 NULL, snap_id, NULL);
1802}
1803
1804static void rbd_osd_req_format_write(struct rbd_obj_request *obj_request)
1805{
1806 struct rbd_img_request *img_request = obj_request->img_request;
1807 struct ceph_osd_request *osd_req = obj_request->osd_req;
1808 struct ceph_snap_context *snapc;
1809 struct timespec mtime = CURRENT_TIME;
1810
1811 rbd_assert(osd_req != NULL);
1812
1813 snapc = img_request ? img_request->snapc : NULL;
1814 ceph_osdc_build_request(osd_req, obj_request->offset,
1815 snapc, CEPH_NOSNAP, &mtime);
430c28c3
AE
1816}
1817
0ccd5926
ID
1818/*
1819 * Create an osd request. A read request has one osd op (read).
1820 * A write request has either one (watch) or two (hint+write) osd ops.
1821 * (All rbd data writes are prefixed with an allocation hint op, but
1822 * technically osd watch is a write request, hence this distinction.)
1823 */
bf0d5f50
AE
1824static struct ceph_osd_request *rbd_osd_req_create(
1825 struct rbd_device *rbd_dev,
1826 bool write_request,
deb236b3 1827 unsigned int num_ops,
430c28c3 1828 struct rbd_obj_request *obj_request)
bf0d5f50 1829{
bf0d5f50
AE
1830 struct ceph_snap_context *snapc = NULL;
1831 struct ceph_osd_client *osdc;
1832 struct ceph_osd_request *osd_req;
bf0d5f50 1833
6365d33a
AE
1834 if (obj_request_img_data_test(obj_request)) {
1835 struct rbd_img_request *img_request = obj_request->img_request;
1836
0c425248
AE
1837 rbd_assert(write_request ==
1838 img_request_write_test(img_request));
1839 if (write_request)
bf0d5f50 1840 snapc = img_request->snapc;
bf0d5f50
AE
1841 }
1842
0ccd5926 1843 rbd_assert(num_ops == 1 || (write_request && num_ops == 2));
deb236b3
ID
1844
1845 /* Allocate and initialize the request, for the num_ops ops */
bf0d5f50
AE
1846
1847 osdc = &rbd_dev->rbd_client->client->osdc;
deb236b3
ID
1848 osd_req = ceph_osdc_alloc_request(osdc, snapc, num_ops, false,
1849 GFP_ATOMIC);
bf0d5f50
AE
1850 if (!osd_req)
1851 return NULL; /* ENOMEM */
bf0d5f50 1852
430c28c3 1853 if (write_request)
bf0d5f50 1854 osd_req->r_flags = CEPH_OSD_FLAG_WRITE | CEPH_OSD_FLAG_ONDISK;
430c28c3 1855 else
bf0d5f50 1856 osd_req->r_flags = CEPH_OSD_FLAG_READ;
bf0d5f50
AE
1857
1858 osd_req->r_callback = rbd_osd_req_callback;
1859 osd_req->r_priv = obj_request;
1860
3c972c95
ID
1861 osd_req->r_base_oloc.pool = ceph_file_layout_pg_pool(rbd_dev->layout);
1862 ceph_oid_set_name(&osd_req->r_base_oid, obj_request->object_name);
bf0d5f50 1863
bf0d5f50
AE
1864 return osd_req;
1865}
1866
0eefd470
AE
1867/*
1868 * Create a copyup osd request based on the information in the
0ccd5926
ID
1869 * object request supplied. A copyup request has three osd ops,
1870 * a copyup method call, a hint op, and a write op.
0eefd470
AE
1871 */
1872static struct ceph_osd_request *
1873rbd_osd_req_create_copyup(struct rbd_obj_request *obj_request)
1874{
1875 struct rbd_img_request *img_request;
1876 struct ceph_snap_context *snapc;
1877 struct rbd_device *rbd_dev;
1878 struct ceph_osd_client *osdc;
1879 struct ceph_osd_request *osd_req;
1880
1881 rbd_assert(obj_request_img_data_test(obj_request));
1882 img_request = obj_request->img_request;
1883 rbd_assert(img_request);
1884 rbd_assert(img_request_write_test(img_request));
1885
0ccd5926 1886 /* Allocate and initialize the request, for the three ops */
0eefd470
AE
1887
1888 snapc = img_request->snapc;
1889 rbd_dev = img_request->rbd_dev;
1890 osdc = &rbd_dev->rbd_client->client->osdc;
0ccd5926 1891 osd_req = ceph_osdc_alloc_request(osdc, snapc, 3, false, GFP_ATOMIC);
0eefd470
AE
1892 if (!osd_req)
1893 return NULL; /* ENOMEM */
1894
1895 osd_req->r_flags = CEPH_OSD_FLAG_WRITE | CEPH_OSD_FLAG_ONDISK;
1896 osd_req->r_callback = rbd_osd_req_callback;
1897 osd_req->r_priv = obj_request;
1898
3c972c95
ID
1899 osd_req->r_base_oloc.pool = ceph_file_layout_pg_pool(rbd_dev->layout);
1900 ceph_oid_set_name(&osd_req->r_base_oid, obj_request->object_name);
0eefd470 1901
0eefd470
AE
1902 return osd_req;
1903}
1904
1905
bf0d5f50
AE
1906static void rbd_osd_req_destroy(struct ceph_osd_request *osd_req)
1907{
1908 ceph_osdc_put_request(osd_req);
1909}
1910
1911/* object_name is assumed to be a non-null pointer and NUL-terminated */
1912
1913static struct rbd_obj_request *rbd_obj_request_create(const char *object_name,
1914 u64 offset, u64 length,
1915 enum obj_request_type type)
1916{
1917 struct rbd_obj_request *obj_request;
1918 size_t size;
1919 char *name;
1920
1921 rbd_assert(obj_request_type_valid(type));
1922
1923 size = strlen(object_name) + 1;
f907ad55
AE
1924 name = kmalloc(size, GFP_KERNEL);
1925 if (!name)
bf0d5f50
AE
1926 return NULL;
1927
868311b1 1928 obj_request = kmem_cache_zalloc(rbd_obj_request_cache, GFP_KERNEL);
f907ad55
AE
1929 if (!obj_request) {
1930 kfree(name);
1931 return NULL;
1932 }
1933
bf0d5f50
AE
1934 obj_request->object_name = memcpy(name, object_name, size);
1935 obj_request->offset = offset;
1936 obj_request->length = length;
926f9b3f 1937 obj_request->flags = 0;
bf0d5f50
AE
1938 obj_request->which = BAD_WHICH;
1939 obj_request->type = type;
1940 INIT_LIST_HEAD(&obj_request->links);
788e2df3 1941 init_completion(&obj_request->completion);
bf0d5f50
AE
1942 kref_init(&obj_request->kref);
1943
37206ee5
AE
1944 dout("%s: \"%s\" %llu/%llu %d -> obj %p\n", __func__, object_name,
1945 offset, length, (int)type, obj_request);
1946
bf0d5f50
AE
1947 return obj_request;
1948}
1949
1950static void rbd_obj_request_destroy(struct kref *kref)
1951{
1952 struct rbd_obj_request *obj_request;
1953
1954 obj_request = container_of(kref, struct rbd_obj_request, kref);
1955
37206ee5
AE
1956 dout("%s: obj %p\n", __func__, obj_request);
1957
bf0d5f50
AE
1958 rbd_assert(obj_request->img_request == NULL);
1959 rbd_assert(obj_request->which == BAD_WHICH);
1960
1961 if (obj_request->osd_req)
1962 rbd_osd_req_destroy(obj_request->osd_req);
1963
1964 rbd_assert(obj_request_type_valid(obj_request->type));
1965 switch (obj_request->type) {
9969ebc5
AE
1966 case OBJ_REQUEST_NODATA:
1967 break; /* Nothing to do */
bf0d5f50
AE
1968 case OBJ_REQUEST_BIO:
1969 if (obj_request->bio_list)
1970 bio_chain_put(obj_request->bio_list);
1971 break;
788e2df3
AE
1972 case OBJ_REQUEST_PAGES:
1973 if (obj_request->pages)
1974 ceph_release_page_vector(obj_request->pages,
1975 obj_request->page_count);
1976 break;
bf0d5f50
AE
1977 }
1978
f907ad55 1979 kfree(obj_request->object_name);
868311b1
AE
1980 obj_request->object_name = NULL;
1981 kmem_cache_free(rbd_obj_request_cache, obj_request);
bf0d5f50
AE
1982}
1983
fb65d228
AE
1984/* It's OK to call this for a device with no parent */
1985
1986static void rbd_spec_put(struct rbd_spec *spec);
1987static void rbd_dev_unparent(struct rbd_device *rbd_dev)
1988{
1989 rbd_dev_remove_parent(rbd_dev);
1990 rbd_spec_put(rbd_dev->parent_spec);
1991 rbd_dev->parent_spec = NULL;
1992 rbd_dev->parent_overlap = 0;
1993}
1994
a2acd00e
AE
1995/*
1996 * Parent image reference counting is used to determine when an
1997 * image's parent fields can be safely torn down--after there are no
1998 * more in-flight requests to the parent image. When the last
1999 * reference is dropped, cleaning them up is safe.
2000 */
2001static void rbd_dev_parent_put(struct rbd_device *rbd_dev)
2002{
2003 int counter;
2004
2005 if (!rbd_dev->parent_spec)
2006 return;
2007
2008 counter = atomic_dec_return_safe(&rbd_dev->parent_ref);
2009 if (counter > 0)
2010 return;
2011
2012 /* Last reference; clean up parent data structures */
2013
2014 if (!counter)
2015 rbd_dev_unparent(rbd_dev);
2016 else
9584d508 2017 rbd_warn(rbd_dev, "parent reference underflow");
a2acd00e
AE
2018}
2019
2020/*
2021 * If an image has a non-zero parent overlap, get a reference to its
2022 * parent.
2023 *
392a9dad
AE
2024 * We must get the reference before checking for the overlap to
2025 * coordinate properly with zeroing the parent overlap in
2026 * rbd_dev_v2_parent_info() when an image gets flattened. We
2027 * drop it again if there is no overlap.
2028 *
a2acd00e
AE
2029 * Returns true if the rbd device has a parent with a non-zero
2030 * overlap and a reference for it was successfully taken, or
2031 * false otherwise.
2032 */
2033static bool rbd_dev_parent_get(struct rbd_device *rbd_dev)
2034{
2035 int counter;
2036
2037 if (!rbd_dev->parent_spec)
2038 return false;
2039
2040 counter = atomic_inc_return_safe(&rbd_dev->parent_ref);
2041 if (counter > 0 && rbd_dev->parent_overlap)
2042 return true;
2043
2044 /* Image was flattened, but parent is not yet torn down */
2045
2046 if (counter < 0)
9584d508 2047 rbd_warn(rbd_dev, "parent reference overflow");
a2acd00e
AE
2048
2049 return false;
2050}
2051
bf0d5f50
AE
2052/*
2053 * Caller is responsible for filling in the list of object requests
2054 * that comprises the image request, and the Linux request pointer
2055 * (if there is one).
2056 */
cc344fa1
AE
2057static struct rbd_img_request *rbd_img_request_create(
2058 struct rbd_device *rbd_dev,
bf0d5f50 2059 u64 offset, u64 length,
4e752f0a
JD
2060 bool write_request,
2061 struct ceph_snap_context *snapc)
bf0d5f50
AE
2062{
2063 struct rbd_img_request *img_request;
bf0d5f50 2064
7a716aac 2065 img_request = kmem_cache_alloc(rbd_img_request_cache, GFP_NOIO);
bf0d5f50
AE
2066 if (!img_request)
2067 return NULL;
2068
bf0d5f50
AE
2069 img_request->rq = NULL;
2070 img_request->rbd_dev = rbd_dev;
2071 img_request->offset = offset;
2072 img_request->length = length;
0c425248
AE
2073 img_request->flags = 0;
2074 if (write_request) {
2075 img_request_write_set(img_request);
4e752f0a 2076 img_request->snapc = snapc;
0c425248 2077 } else {
bf0d5f50 2078 img_request->snap_id = rbd_dev->spec->snap_id;
0c425248 2079 }
a2acd00e 2080 if (rbd_dev_parent_get(rbd_dev))
d0b2e944 2081 img_request_layered_set(img_request);
bf0d5f50
AE
2082 spin_lock_init(&img_request->completion_lock);
2083 img_request->next_completion = 0;
2084 img_request->callback = NULL;
a5a337d4 2085 img_request->result = 0;
bf0d5f50
AE
2086 img_request->obj_request_count = 0;
2087 INIT_LIST_HEAD(&img_request->obj_requests);
2088 kref_init(&img_request->kref);
2089
37206ee5
AE
2090 dout("%s: rbd_dev %p %s %llu/%llu -> img %p\n", __func__, rbd_dev,
2091 write_request ? "write" : "read", offset, length,
2092 img_request);
2093
bf0d5f50
AE
2094 return img_request;
2095}
2096
2097static void rbd_img_request_destroy(struct kref *kref)
2098{
2099 struct rbd_img_request *img_request;
2100 struct rbd_obj_request *obj_request;
2101 struct rbd_obj_request *next_obj_request;
2102
2103 img_request = container_of(kref, struct rbd_img_request, kref);
2104
37206ee5
AE
2105 dout("%s: img %p\n", __func__, img_request);
2106
bf0d5f50
AE
2107 for_each_obj_request_safe(img_request, obj_request, next_obj_request)
2108 rbd_img_obj_request_del(img_request, obj_request);
25dcf954 2109 rbd_assert(img_request->obj_request_count == 0);
bf0d5f50 2110
a2acd00e
AE
2111 if (img_request_layered_test(img_request)) {
2112 img_request_layered_clear(img_request);
2113 rbd_dev_parent_put(img_request->rbd_dev);
2114 }
2115
0c425248 2116 if (img_request_write_test(img_request))
812164f8 2117 ceph_put_snap_context(img_request->snapc);
bf0d5f50 2118
1c2a9dfe 2119 kmem_cache_free(rbd_img_request_cache, img_request);
bf0d5f50
AE
2120}
2121
e93f3152
AE
2122static struct rbd_img_request *rbd_parent_request_create(
2123 struct rbd_obj_request *obj_request,
2124 u64 img_offset, u64 length)
2125{
2126 struct rbd_img_request *parent_request;
2127 struct rbd_device *rbd_dev;
2128
2129 rbd_assert(obj_request->img_request);
2130 rbd_dev = obj_request->img_request->rbd_dev;
2131
4e752f0a
JD
2132 parent_request = rbd_img_request_create(rbd_dev->parent, img_offset,
2133 length, false, NULL);
e93f3152
AE
2134 if (!parent_request)
2135 return NULL;
2136
2137 img_request_child_set(parent_request);
2138 rbd_obj_request_get(obj_request);
2139 parent_request->obj_request = obj_request;
2140
2141 return parent_request;
2142}
2143
2144static void rbd_parent_request_destroy(struct kref *kref)
2145{
2146 struct rbd_img_request *parent_request;
2147 struct rbd_obj_request *orig_request;
2148
2149 parent_request = container_of(kref, struct rbd_img_request, kref);
2150 orig_request = parent_request->obj_request;
2151
2152 parent_request->obj_request = NULL;
2153 rbd_obj_request_put(orig_request);
2154 img_request_child_clear(parent_request);
2155
2156 rbd_img_request_destroy(kref);
2157}
2158
1217857f
AE
2159static bool rbd_img_obj_end_request(struct rbd_obj_request *obj_request)
2160{
6365d33a 2161 struct rbd_img_request *img_request;
1217857f
AE
2162 unsigned int xferred;
2163 int result;
8b3e1a56 2164 bool more;
1217857f 2165
6365d33a
AE
2166 rbd_assert(obj_request_img_data_test(obj_request));
2167 img_request = obj_request->img_request;
2168
1217857f
AE
2169 rbd_assert(obj_request->xferred <= (u64)UINT_MAX);
2170 xferred = (unsigned int)obj_request->xferred;
2171 result = obj_request->result;
2172 if (result) {
2173 struct rbd_device *rbd_dev = img_request->rbd_dev;
2174
9584d508 2175 rbd_warn(rbd_dev, "%s %llx at %llx (%llx)",
1217857f
AE
2176 img_request_write_test(img_request) ? "write" : "read",
2177 obj_request->length, obj_request->img_offset,
2178 obj_request->offset);
9584d508 2179 rbd_warn(rbd_dev, " result %d xferred %x",
1217857f
AE
2180 result, xferred);
2181 if (!img_request->result)
2182 img_request->result = result;
2183 }
2184
f1a4739f
AE
2185 /* Image object requests don't own their page array */
2186
2187 if (obj_request->type == OBJ_REQUEST_PAGES) {
2188 obj_request->pages = NULL;
2189 obj_request->page_count = 0;
2190 }
2191
8b3e1a56
AE
2192 if (img_request_child_test(img_request)) {
2193 rbd_assert(img_request->obj_request != NULL);
2194 more = obj_request->which < img_request->obj_request_count - 1;
2195 } else {
2196 rbd_assert(img_request->rq != NULL);
2197 more = blk_end_request(img_request->rq, result, xferred);
2198 }
2199
2200 return more;
1217857f
AE
2201}
2202
2169238d
AE
2203static void rbd_img_obj_callback(struct rbd_obj_request *obj_request)
2204{
2205 struct rbd_img_request *img_request;
2206 u32 which = obj_request->which;
2207 bool more = true;
2208
6365d33a 2209 rbd_assert(obj_request_img_data_test(obj_request));
2169238d
AE
2210 img_request = obj_request->img_request;
2211
2212 dout("%s: img %p obj %p\n", __func__, img_request, obj_request);
2213 rbd_assert(img_request != NULL);
2169238d
AE
2214 rbd_assert(img_request->obj_request_count > 0);
2215 rbd_assert(which != BAD_WHICH);
2216 rbd_assert(which < img_request->obj_request_count);
2169238d
AE
2217
2218 spin_lock_irq(&img_request->completion_lock);
2219 if (which != img_request->next_completion)
2220 goto out;
2221
2222 for_each_obj_request_from(img_request, obj_request) {
2169238d
AE
2223 rbd_assert(more);
2224 rbd_assert(which < img_request->obj_request_count);
2225
2226 if (!obj_request_done_test(obj_request))
2227 break;
1217857f 2228 more = rbd_img_obj_end_request(obj_request);
2169238d
AE
2229 which++;
2230 }
2231
2232 rbd_assert(more ^ (which == img_request->obj_request_count));
2233 img_request->next_completion = which;
2234out:
2235 spin_unlock_irq(&img_request->completion_lock);
0f2d5be7 2236 rbd_img_request_put(img_request);
2169238d
AE
2237
2238 if (!more)
2239 rbd_img_request_complete(img_request);
2240}
2241
f1a4739f
AE
2242/*
2243 * Split up an image request into one or more object requests, each
2244 * to a different object. The "type" parameter indicates whether
2245 * "data_desc" is the pointer to the head of a list of bio
2246 * structures, or the base of a page array. In either case this
2247 * function assumes data_desc describes memory sufficient to hold
2248 * all data described by the image request.
2249 */
2250static int rbd_img_request_fill(struct rbd_img_request *img_request,
2251 enum obj_request_type type,
2252 void *data_desc)
bf0d5f50
AE
2253{
2254 struct rbd_device *rbd_dev = img_request->rbd_dev;
2255 struct rbd_obj_request *obj_request = NULL;
2256 struct rbd_obj_request *next_obj_request;
0c425248 2257 bool write_request = img_request_write_test(img_request);
a158073c 2258 struct bio *bio_list = NULL;
f1a4739f 2259 unsigned int bio_offset = 0;
a158073c 2260 struct page **pages = NULL;
7da22d29 2261 u64 img_offset;
bf0d5f50
AE
2262 u64 resid;
2263 u16 opcode;
2264
f1a4739f
AE
2265 dout("%s: img %p type %d data_desc %p\n", __func__, img_request,
2266 (int)type, data_desc);
37206ee5 2267
430c28c3 2268 opcode = write_request ? CEPH_OSD_OP_WRITE : CEPH_OSD_OP_READ;
7da22d29 2269 img_offset = img_request->offset;
bf0d5f50 2270 resid = img_request->length;
4dda41d3 2271 rbd_assert(resid > 0);
f1a4739f
AE
2272
2273 if (type == OBJ_REQUEST_BIO) {
2274 bio_list = data_desc;
4f024f37
KO
2275 rbd_assert(img_offset ==
2276 bio_list->bi_iter.bi_sector << SECTOR_SHIFT);
f1a4739f
AE
2277 } else {
2278 rbd_assert(type == OBJ_REQUEST_PAGES);
2279 pages = data_desc;
2280 }
2281
bf0d5f50 2282 while (resid) {
2fa12320 2283 struct ceph_osd_request *osd_req;
bf0d5f50 2284 const char *object_name;
bf0d5f50
AE
2285 u64 offset;
2286 u64 length;
0ccd5926 2287 unsigned int which = 0;
bf0d5f50 2288
7da22d29 2289 object_name = rbd_segment_name(rbd_dev, img_offset);
bf0d5f50
AE
2290 if (!object_name)
2291 goto out_unwind;
7da22d29
AE
2292 offset = rbd_segment_offset(rbd_dev, img_offset);
2293 length = rbd_segment_length(rbd_dev, img_offset, resid);
bf0d5f50 2294 obj_request = rbd_obj_request_create(object_name,
f1a4739f 2295 offset, length, type);
78c2a44a
AE
2296 /* object request has its own copy of the object name */
2297 rbd_segment_name_free(object_name);
bf0d5f50
AE
2298 if (!obj_request)
2299 goto out_unwind;
62054da6 2300
03507db6
JD
2301 /*
2302 * set obj_request->img_request before creating the
2303 * osd_request so that it gets the right snapc
2304 */
2305 rbd_img_obj_request_add(img_request, obj_request);
bf0d5f50 2306
f1a4739f
AE
2307 if (type == OBJ_REQUEST_BIO) {
2308 unsigned int clone_size;
2309
2310 rbd_assert(length <= (u64)UINT_MAX);
2311 clone_size = (unsigned int)length;
2312 obj_request->bio_list =
2313 bio_chain_clone_range(&bio_list,
2314 &bio_offset,
2315 clone_size,
2316 GFP_ATOMIC);
2317 if (!obj_request->bio_list)
62054da6 2318 goto out_unwind;
f1a4739f
AE
2319 } else {
2320 unsigned int page_count;
2321
2322 obj_request->pages = pages;
2323 page_count = (u32)calc_pages_for(offset, length);
2324 obj_request->page_count = page_count;
2325 if ((offset + length) & ~PAGE_MASK)
2326 page_count--; /* more on last page */
2327 pages += page_count;
2328 }
bf0d5f50 2329
0ccd5926
ID
2330 osd_req = rbd_osd_req_create(rbd_dev, write_request,
2331 (write_request ? 2 : 1),
deb236b3 2332 obj_request);
2fa12320 2333 if (!osd_req)
62054da6 2334 goto out_unwind;
2fa12320 2335 obj_request->osd_req = osd_req;
2169238d 2336 obj_request->callback = rbd_img_obj_callback;
0f2d5be7 2337 rbd_img_request_get(img_request);
430c28c3 2338
0ccd5926
ID
2339 if (write_request) {
2340 osd_req_op_alloc_hint_init(osd_req, which,
2341 rbd_obj_bytes(&rbd_dev->header),
2342 rbd_obj_bytes(&rbd_dev->header));
2343 which++;
2344 }
2345
2346 osd_req_op_extent_init(osd_req, which, opcode, offset, length,
2347 0, 0);
f1a4739f 2348 if (type == OBJ_REQUEST_BIO)
0ccd5926 2349 osd_req_op_extent_osd_data_bio(osd_req, which,
f1a4739f
AE
2350 obj_request->bio_list, length);
2351 else
0ccd5926 2352 osd_req_op_extent_osd_data_pages(osd_req, which,
f1a4739f
AE
2353 obj_request->pages, length,
2354 offset & ~PAGE_MASK, false, false);
9d4df01f
AE
2355
2356 if (write_request)
2357 rbd_osd_req_format_write(obj_request);
2358 else
2359 rbd_osd_req_format_read(obj_request);
430c28c3 2360
7da22d29 2361 obj_request->img_offset = img_offset;
bf0d5f50 2362
7da22d29 2363 img_offset += length;
bf0d5f50
AE
2364 resid -= length;
2365 }
2366
2367 return 0;
2368
bf0d5f50
AE
2369out_unwind:
2370 for_each_obj_request_safe(img_request, obj_request, next_obj_request)
42dd037c 2371 rbd_img_obj_request_del(img_request, obj_request);
bf0d5f50
AE
2372
2373 return -ENOMEM;
2374}
2375
0eefd470
AE
2376static void
2377rbd_img_obj_copyup_callback(struct rbd_obj_request *obj_request)
2378{
2379 struct rbd_img_request *img_request;
2380 struct rbd_device *rbd_dev;
ebda6408 2381 struct page **pages;
0eefd470
AE
2382 u32 page_count;
2383
2384 rbd_assert(obj_request->type == OBJ_REQUEST_BIO);
2385 rbd_assert(obj_request_img_data_test(obj_request));
2386 img_request = obj_request->img_request;
2387 rbd_assert(img_request);
2388
2389 rbd_dev = img_request->rbd_dev;
2390 rbd_assert(rbd_dev);
0eefd470 2391
ebda6408
AE
2392 pages = obj_request->copyup_pages;
2393 rbd_assert(pages != NULL);
0eefd470 2394 obj_request->copyup_pages = NULL;
ebda6408
AE
2395 page_count = obj_request->copyup_page_count;
2396 rbd_assert(page_count);
2397 obj_request->copyup_page_count = 0;
2398 ceph_release_page_vector(pages, page_count);
0eefd470
AE
2399
2400 /*
2401 * We want the transfer count to reflect the size of the
2402 * original write request. There is no such thing as a
2403 * successful short write, so if the request was successful
2404 * we can just set it to the originally-requested length.
2405 */
2406 if (!obj_request->result)
2407 obj_request->xferred = obj_request->length;
2408
2409 /* Finish up with the normal image object callback */
2410
2411 rbd_img_obj_callback(obj_request);
2412}
2413
3d7efd18
AE
2414static void
2415rbd_img_obj_parent_read_full_callback(struct rbd_img_request *img_request)
2416{
2417 struct rbd_obj_request *orig_request;
0eefd470
AE
2418 struct ceph_osd_request *osd_req;
2419 struct ceph_osd_client *osdc;
2420 struct rbd_device *rbd_dev;
3d7efd18 2421 struct page **pages;
ebda6408 2422 u32 page_count;
bbea1c1a 2423 int img_result;
ebda6408 2424 u64 parent_length;
b91f09f1
AE
2425 u64 offset;
2426 u64 length;
3d7efd18
AE
2427
2428 rbd_assert(img_request_child_test(img_request));
2429
2430 /* First get what we need from the image request */
2431
2432 pages = img_request->copyup_pages;
2433 rbd_assert(pages != NULL);
2434 img_request->copyup_pages = NULL;
ebda6408
AE
2435 page_count = img_request->copyup_page_count;
2436 rbd_assert(page_count);
2437 img_request->copyup_page_count = 0;
3d7efd18
AE
2438
2439 orig_request = img_request->obj_request;
2440 rbd_assert(orig_request != NULL);
b91f09f1 2441 rbd_assert(obj_request_type_valid(orig_request->type));
bbea1c1a 2442 img_result = img_request->result;
ebda6408
AE
2443 parent_length = img_request->length;
2444 rbd_assert(parent_length == img_request->xferred);
91c6febb 2445 rbd_img_request_put(img_request);
3d7efd18 2446
91c6febb
AE
2447 rbd_assert(orig_request->img_request);
2448 rbd_dev = orig_request->img_request->rbd_dev;
0eefd470 2449 rbd_assert(rbd_dev);
0eefd470 2450
bbea1c1a
AE
2451 /*
2452 * If the overlap has become 0 (most likely because the
2453 * image has been flattened) we need to free the pages
2454 * and re-submit the original write request.
2455 */
2456 if (!rbd_dev->parent_overlap) {
2457 struct ceph_osd_client *osdc;
3d7efd18 2458
bbea1c1a
AE
2459 ceph_release_page_vector(pages, page_count);
2460 osdc = &rbd_dev->rbd_client->client->osdc;
2461 img_result = rbd_obj_request_submit(osdc, orig_request);
2462 if (!img_result)
2463 return;
2464 }
0eefd470 2465
bbea1c1a 2466 if (img_result)
0eefd470 2467 goto out_err;
0eefd470 2468
8785b1d4
AE
2469 /*
2470 * The original osd request is of no use to use any more.
0ccd5926 2471 * We need a new one that can hold the three ops in a copyup
8785b1d4
AE
2472 * request. Allocate the new copyup osd request for the
2473 * original request, and release the old one.
2474 */
bbea1c1a 2475 img_result = -ENOMEM;
0eefd470
AE
2476 osd_req = rbd_osd_req_create_copyup(orig_request);
2477 if (!osd_req)
2478 goto out_err;
8785b1d4 2479 rbd_osd_req_destroy(orig_request->osd_req);
0eefd470
AE
2480 orig_request->osd_req = osd_req;
2481 orig_request->copyup_pages = pages;
ebda6408 2482 orig_request->copyup_page_count = page_count;
3d7efd18 2483
0eefd470 2484 /* Initialize the copyup op */
3d7efd18 2485
0eefd470 2486 osd_req_op_cls_init(osd_req, 0, CEPH_OSD_OP_CALL, "rbd", "copyup");
ebda6408 2487 osd_req_op_cls_request_data_pages(osd_req, 0, pages, parent_length, 0,
0eefd470 2488 false, false);
3d7efd18 2489
0ccd5926
ID
2490 /* Then the hint op */
2491
2492 osd_req_op_alloc_hint_init(osd_req, 1, rbd_obj_bytes(&rbd_dev->header),
2493 rbd_obj_bytes(&rbd_dev->header));
2494
2495 /* And the original write request op */
0eefd470 2496
b91f09f1
AE
2497 offset = orig_request->offset;
2498 length = orig_request->length;
0ccd5926 2499 osd_req_op_extent_init(osd_req, 2, CEPH_OSD_OP_WRITE,
b91f09f1
AE
2500 offset, length, 0, 0);
2501 if (orig_request->type == OBJ_REQUEST_BIO)
0ccd5926 2502 osd_req_op_extent_osd_data_bio(osd_req, 2,
b91f09f1
AE
2503 orig_request->bio_list, length);
2504 else
0ccd5926 2505 osd_req_op_extent_osd_data_pages(osd_req, 2,
b91f09f1
AE
2506 orig_request->pages, length,
2507 offset & ~PAGE_MASK, false, false);
0eefd470
AE
2508
2509 rbd_osd_req_format_write(orig_request);
2510
2511 /* All set, send it off. */
2512
2513 orig_request->callback = rbd_img_obj_copyup_callback;
2514 osdc = &rbd_dev->rbd_client->client->osdc;
bbea1c1a
AE
2515 img_result = rbd_obj_request_submit(osdc, orig_request);
2516 if (!img_result)
0eefd470
AE
2517 return;
2518out_err:
2519 /* Record the error code and complete the request */
2520
bbea1c1a 2521 orig_request->result = img_result;
0eefd470
AE
2522 orig_request->xferred = 0;
2523 obj_request_done_set(orig_request);
2524 rbd_obj_request_complete(orig_request);
3d7efd18
AE
2525}
2526
2527/*
2528 * Read from the parent image the range of data that covers the
2529 * entire target of the given object request. This is used for
2530 * satisfying a layered image write request when the target of an
2531 * object request from the image request does not exist.
2532 *
2533 * A page array big enough to hold the returned data is allocated
2534 * and supplied to rbd_img_request_fill() as the "data descriptor."
2535 * When the read completes, this page array will be transferred to
2536 * the original object request for the copyup operation.
2537 *
2538 * If an error occurs, record it as the result of the original
2539 * object request and mark it done so it gets completed.
2540 */
2541static int rbd_img_obj_parent_read_full(struct rbd_obj_request *obj_request)
2542{
2543 struct rbd_img_request *img_request = NULL;
2544 struct rbd_img_request *parent_request = NULL;
2545 struct rbd_device *rbd_dev;
2546 u64 img_offset;
2547 u64 length;
2548 struct page **pages = NULL;
2549 u32 page_count;
2550 int result;
2551
2552 rbd_assert(obj_request_img_data_test(obj_request));
b91f09f1 2553 rbd_assert(obj_request_type_valid(obj_request->type));
3d7efd18
AE
2554
2555 img_request = obj_request->img_request;
2556 rbd_assert(img_request != NULL);
2557 rbd_dev = img_request->rbd_dev;
2558 rbd_assert(rbd_dev->parent != NULL);
2559
2560 /*
2561 * Determine the byte range covered by the object in the
2562 * child image to which the original request was to be sent.
2563 */
2564 img_offset = obj_request->img_offset - obj_request->offset;
2565 length = (u64)1 << rbd_dev->header.obj_order;
2566
a9e8ba2c
AE
2567 /*
2568 * There is no defined parent data beyond the parent
2569 * overlap, so limit what we read at that boundary if
2570 * necessary.
2571 */
2572 if (img_offset + length > rbd_dev->parent_overlap) {
2573 rbd_assert(img_offset < rbd_dev->parent_overlap);
2574 length = rbd_dev->parent_overlap - img_offset;
2575 }
2576
3d7efd18
AE
2577 /*
2578 * Allocate a page array big enough to receive the data read
2579 * from the parent.
2580 */
2581 page_count = (u32)calc_pages_for(0, length);
2582 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2583 if (IS_ERR(pages)) {
2584 result = PTR_ERR(pages);
2585 pages = NULL;
2586 goto out_err;
2587 }
2588
2589 result = -ENOMEM;
e93f3152
AE
2590 parent_request = rbd_parent_request_create(obj_request,
2591 img_offset, length);
3d7efd18
AE
2592 if (!parent_request)
2593 goto out_err;
3d7efd18
AE
2594
2595 result = rbd_img_request_fill(parent_request, OBJ_REQUEST_PAGES, pages);
2596 if (result)
2597 goto out_err;
2598 parent_request->copyup_pages = pages;
ebda6408 2599 parent_request->copyup_page_count = page_count;
3d7efd18
AE
2600
2601 parent_request->callback = rbd_img_obj_parent_read_full_callback;
2602 result = rbd_img_request_submit(parent_request);
2603 if (!result)
2604 return 0;
2605
2606 parent_request->copyup_pages = NULL;
ebda6408 2607 parent_request->copyup_page_count = 0;
3d7efd18
AE
2608 parent_request->obj_request = NULL;
2609 rbd_obj_request_put(obj_request);
2610out_err:
2611 if (pages)
2612 ceph_release_page_vector(pages, page_count);
2613 if (parent_request)
2614 rbd_img_request_put(parent_request);
2615 obj_request->result = result;
2616 obj_request->xferred = 0;
2617 obj_request_done_set(obj_request);
2618
2619 return result;
2620}
2621
c5b5ef6c
AE
2622static void rbd_img_obj_exists_callback(struct rbd_obj_request *obj_request)
2623{
c5b5ef6c 2624 struct rbd_obj_request *orig_request;
638f5abe 2625 struct rbd_device *rbd_dev;
c5b5ef6c
AE
2626 int result;
2627
2628 rbd_assert(!obj_request_img_data_test(obj_request));
2629
2630 /*
2631 * All we need from the object request is the original
2632 * request and the result of the STAT op. Grab those, then
2633 * we're done with the request.
2634 */
2635 orig_request = obj_request->obj_request;
2636 obj_request->obj_request = NULL;
912c317d 2637 rbd_obj_request_put(orig_request);
c5b5ef6c
AE
2638 rbd_assert(orig_request);
2639 rbd_assert(orig_request->img_request);
2640
2641 result = obj_request->result;
2642 obj_request->result = 0;
2643
2644 dout("%s: obj %p for obj %p result %d %llu/%llu\n", __func__,
2645 obj_request, orig_request, result,
2646 obj_request->xferred, obj_request->length);
2647 rbd_obj_request_put(obj_request);
2648
638f5abe
AE
2649 /*
2650 * If the overlap has become 0 (most likely because the
2651 * image has been flattened) we need to free the pages
2652 * and re-submit the original write request.
2653 */
2654 rbd_dev = orig_request->img_request->rbd_dev;
2655 if (!rbd_dev->parent_overlap) {
2656 struct ceph_osd_client *osdc;
2657
638f5abe
AE
2658 osdc = &rbd_dev->rbd_client->client->osdc;
2659 result = rbd_obj_request_submit(osdc, orig_request);
2660 if (!result)
2661 return;
2662 }
c5b5ef6c
AE
2663
2664 /*
2665 * Our only purpose here is to determine whether the object
2666 * exists, and we don't want to treat the non-existence as
2667 * an error. If something else comes back, transfer the
2668 * error to the original request and complete it now.
2669 */
2670 if (!result) {
2671 obj_request_existence_set(orig_request, true);
2672 } else if (result == -ENOENT) {
2673 obj_request_existence_set(orig_request, false);
2674 } else if (result) {
2675 orig_request->result = result;
3d7efd18 2676 goto out;
c5b5ef6c
AE
2677 }
2678
2679 /*
2680 * Resubmit the original request now that we have recorded
2681 * whether the target object exists.
2682 */
b454e36d 2683 orig_request->result = rbd_img_obj_request_submit(orig_request);
3d7efd18 2684out:
c5b5ef6c
AE
2685 if (orig_request->result)
2686 rbd_obj_request_complete(orig_request);
c5b5ef6c
AE
2687}
2688
2689static int rbd_img_obj_exists_submit(struct rbd_obj_request *obj_request)
2690{
2691 struct rbd_obj_request *stat_request;
2692 struct rbd_device *rbd_dev;
2693 struct ceph_osd_client *osdc;
2694 struct page **pages = NULL;
2695 u32 page_count;
2696 size_t size;
2697 int ret;
2698
2699 /*
2700 * The response data for a STAT call consists of:
2701 * le64 length;
2702 * struct {
2703 * le32 tv_sec;
2704 * le32 tv_nsec;
2705 * } mtime;
2706 */
2707 size = sizeof (__le64) + sizeof (__le32) + sizeof (__le32);
2708 page_count = (u32)calc_pages_for(0, size);
2709 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
2710 if (IS_ERR(pages))
2711 return PTR_ERR(pages);
2712
2713 ret = -ENOMEM;
2714 stat_request = rbd_obj_request_create(obj_request->object_name, 0, 0,
2715 OBJ_REQUEST_PAGES);
2716 if (!stat_request)
2717 goto out;
2718
2719 rbd_obj_request_get(obj_request);
2720 stat_request->obj_request = obj_request;
2721 stat_request->pages = pages;
2722 stat_request->page_count = page_count;
2723
2724 rbd_assert(obj_request->img_request);
2725 rbd_dev = obj_request->img_request->rbd_dev;
deb236b3
ID
2726 stat_request->osd_req = rbd_osd_req_create(rbd_dev, false, 1,
2727 stat_request);
c5b5ef6c
AE
2728 if (!stat_request->osd_req)
2729 goto out;
2730 stat_request->callback = rbd_img_obj_exists_callback;
2731
2732 osd_req_op_init(stat_request->osd_req, 0, CEPH_OSD_OP_STAT);
2733 osd_req_op_raw_data_in_pages(stat_request->osd_req, 0, pages, size, 0,
2734 false, false);
9d4df01f 2735 rbd_osd_req_format_read(stat_request);
c5b5ef6c
AE
2736
2737 osdc = &rbd_dev->rbd_client->client->osdc;
2738 ret = rbd_obj_request_submit(osdc, stat_request);
2739out:
2740 if (ret)
2741 rbd_obj_request_put(obj_request);
2742
2743 return ret;
2744}
2745
70d045f6 2746static bool img_obj_request_simple(struct rbd_obj_request *obj_request)
b454e36d
AE
2747{
2748 struct rbd_img_request *img_request;
a9e8ba2c 2749 struct rbd_device *rbd_dev;
b454e36d
AE
2750
2751 rbd_assert(obj_request_img_data_test(obj_request));
2752
2753 img_request = obj_request->img_request;
2754 rbd_assert(img_request);
a9e8ba2c 2755 rbd_dev = img_request->rbd_dev;
b454e36d 2756
70d045f6
ID
2757 /* Reads */
2758 if (!img_request_write_test(img_request))
2759 return true;
2760
2761 /* Non-layered writes */
2762 if (!img_request_layered_test(img_request))
2763 return true;
2764
b454e36d 2765 /*
70d045f6
ID
2766 * Layered writes outside of the parent overlap range don't
2767 * share any data with the parent.
b454e36d 2768 */
70d045f6
ID
2769 if (!obj_request_overlaps_parent(obj_request))
2770 return true;
b454e36d 2771
c622d226
GZ
2772 /*
2773 * Entire-object layered writes - we will overwrite whatever
2774 * parent data there is anyway.
2775 */
2776 if (!obj_request->offset &&
2777 obj_request->length == rbd_obj_bytes(&rbd_dev->header))
2778 return true;
2779
70d045f6
ID
2780 /*
2781 * If the object is known to already exist, its parent data has
2782 * already been copied.
2783 */
2784 if (obj_request_known_test(obj_request) &&
2785 obj_request_exists_test(obj_request))
2786 return true;
2787
2788 return false;
2789}
2790
2791static int rbd_img_obj_request_submit(struct rbd_obj_request *obj_request)
2792{
2793 if (img_obj_request_simple(obj_request)) {
b454e36d
AE
2794 struct rbd_device *rbd_dev;
2795 struct ceph_osd_client *osdc;
2796
2797 rbd_dev = obj_request->img_request->rbd_dev;
2798 osdc = &rbd_dev->rbd_client->client->osdc;
2799
2800 return rbd_obj_request_submit(osdc, obj_request);
2801 }
2802
2803 /*
3d7efd18
AE
2804 * It's a layered write. The target object might exist but
2805 * we may not know that yet. If we know it doesn't exist,
2806 * start by reading the data for the full target object from
2807 * the parent so we can use it for a copyup to the target.
b454e36d 2808 */
70d045f6 2809 if (obj_request_known_test(obj_request))
3d7efd18
AE
2810 return rbd_img_obj_parent_read_full(obj_request);
2811
2812 /* We don't know whether the target exists. Go find out. */
b454e36d
AE
2813
2814 return rbd_img_obj_exists_submit(obj_request);
2815}
2816
bf0d5f50
AE
2817static int rbd_img_request_submit(struct rbd_img_request *img_request)
2818{
bf0d5f50 2819 struct rbd_obj_request *obj_request;
46faeed4 2820 struct rbd_obj_request *next_obj_request;
bf0d5f50 2821
37206ee5 2822 dout("%s: img %p\n", __func__, img_request);
46faeed4 2823 for_each_obj_request_safe(img_request, obj_request, next_obj_request) {
bf0d5f50
AE
2824 int ret;
2825
b454e36d 2826 ret = rbd_img_obj_request_submit(obj_request);
bf0d5f50
AE
2827 if (ret)
2828 return ret;
bf0d5f50
AE
2829 }
2830
2831 return 0;
2832}
8b3e1a56
AE
2833
2834static void rbd_img_parent_read_callback(struct rbd_img_request *img_request)
2835{
2836 struct rbd_obj_request *obj_request;
a9e8ba2c
AE
2837 struct rbd_device *rbd_dev;
2838 u64 obj_end;
02c74fba
AE
2839 u64 img_xferred;
2840 int img_result;
8b3e1a56
AE
2841
2842 rbd_assert(img_request_child_test(img_request));
2843
02c74fba
AE
2844 /* First get what we need from the image request and release it */
2845
8b3e1a56 2846 obj_request = img_request->obj_request;
02c74fba
AE
2847 img_xferred = img_request->xferred;
2848 img_result = img_request->result;
2849 rbd_img_request_put(img_request);
2850
2851 /*
2852 * If the overlap has become 0 (most likely because the
2853 * image has been flattened) we need to re-submit the
2854 * original request.
2855 */
a9e8ba2c
AE
2856 rbd_assert(obj_request);
2857 rbd_assert(obj_request->img_request);
02c74fba
AE
2858 rbd_dev = obj_request->img_request->rbd_dev;
2859 if (!rbd_dev->parent_overlap) {
2860 struct ceph_osd_client *osdc;
2861
2862 osdc = &rbd_dev->rbd_client->client->osdc;
2863 img_result = rbd_obj_request_submit(osdc, obj_request);
2864 if (!img_result)
2865 return;
2866 }
a9e8ba2c 2867
02c74fba 2868 obj_request->result = img_result;
a9e8ba2c
AE
2869 if (obj_request->result)
2870 goto out;
2871
2872 /*
2873 * We need to zero anything beyond the parent overlap
2874 * boundary. Since rbd_img_obj_request_read_callback()
2875 * will zero anything beyond the end of a short read, an
2876 * easy way to do this is to pretend the data from the
2877 * parent came up short--ending at the overlap boundary.
2878 */
2879 rbd_assert(obj_request->img_offset < U64_MAX - obj_request->length);
2880 obj_end = obj_request->img_offset + obj_request->length;
a9e8ba2c
AE
2881 if (obj_end > rbd_dev->parent_overlap) {
2882 u64 xferred = 0;
2883
2884 if (obj_request->img_offset < rbd_dev->parent_overlap)
2885 xferred = rbd_dev->parent_overlap -
2886 obj_request->img_offset;
8b3e1a56 2887
02c74fba 2888 obj_request->xferred = min(img_xferred, xferred);
a9e8ba2c 2889 } else {
02c74fba 2890 obj_request->xferred = img_xferred;
a9e8ba2c
AE
2891 }
2892out:
8b3e1a56
AE
2893 rbd_img_obj_request_read_callback(obj_request);
2894 rbd_obj_request_complete(obj_request);
2895}
2896
2897static void rbd_img_parent_read(struct rbd_obj_request *obj_request)
2898{
8b3e1a56
AE
2899 struct rbd_img_request *img_request;
2900 int result;
2901
2902 rbd_assert(obj_request_img_data_test(obj_request));
2903 rbd_assert(obj_request->img_request != NULL);
2904 rbd_assert(obj_request->result == (s32) -ENOENT);
5b2ab72d 2905 rbd_assert(obj_request_type_valid(obj_request->type));
8b3e1a56 2906
8b3e1a56 2907 /* rbd_read_finish(obj_request, obj_request->length); */
e93f3152 2908 img_request = rbd_parent_request_create(obj_request,
8b3e1a56 2909 obj_request->img_offset,
e93f3152 2910 obj_request->length);
8b3e1a56
AE
2911 result = -ENOMEM;
2912 if (!img_request)
2913 goto out_err;
2914
5b2ab72d
AE
2915 if (obj_request->type == OBJ_REQUEST_BIO)
2916 result = rbd_img_request_fill(img_request, OBJ_REQUEST_BIO,
2917 obj_request->bio_list);
2918 else
2919 result = rbd_img_request_fill(img_request, OBJ_REQUEST_PAGES,
2920 obj_request->pages);
8b3e1a56
AE
2921 if (result)
2922 goto out_err;
2923
2924 img_request->callback = rbd_img_parent_read_callback;
2925 result = rbd_img_request_submit(img_request);
2926 if (result)
2927 goto out_err;
2928
2929 return;
2930out_err:
2931 if (img_request)
2932 rbd_img_request_put(img_request);
2933 obj_request->result = result;
2934 obj_request->xferred = 0;
2935 obj_request_done_set(obj_request);
2936}
bf0d5f50 2937
20e0af67 2938static int rbd_obj_notify_ack_sync(struct rbd_device *rbd_dev, u64 notify_id)
b8d70035
AE
2939{
2940 struct rbd_obj_request *obj_request;
2169238d 2941 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
b8d70035
AE
2942 int ret;
2943
2944 obj_request = rbd_obj_request_create(rbd_dev->header_name, 0, 0,
2945 OBJ_REQUEST_NODATA);
2946 if (!obj_request)
2947 return -ENOMEM;
2948
2949 ret = -ENOMEM;
deb236b3
ID
2950 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false, 1,
2951 obj_request);
b8d70035
AE
2952 if (!obj_request->osd_req)
2953 goto out;
2954
c99d2d4a 2955 osd_req_op_watch_init(obj_request->osd_req, 0, CEPH_OSD_OP_NOTIFY_ACK,
cc4a38bd 2956 notify_id, 0, 0);
9d4df01f 2957 rbd_osd_req_format_read(obj_request);
430c28c3 2958
b8d70035 2959 ret = rbd_obj_request_submit(osdc, obj_request);
cf81b60e 2960 if (ret)
20e0af67
JD
2961 goto out;
2962 ret = rbd_obj_request_wait(obj_request);
2963out:
2964 rbd_obj_request_put(obj_request);
b8d70035
AE
2965
2966 return ret;
2967}
2968
2969static void rbd_watch_cb(u64 ver, u64 notify_id, u8 opcode, void *data)
2970{
2971 struct rbd_device *rbd_dev = (struct rbd_device *)data;
e627db08 2972 int ret;
b8d70035
AE
2973
2974 if (!rbd_dev)
2975 return;
2976
37206ee5 2977 dout("%s: \"%s\" notify_id %llu opcode %u\n", __func__,
cc4a38bd
AE
2978 rbd_dev->header_name, (unsigned long long)notify_id,
2979 (unsigned int)opcode);
52bb1f9b
ID
2980
2981 /*
2982 * Until adequate refresh error handling is in place, there is
2983 * not much we can do here, except warn.
2984 *
2985 * See http://tracker.ceph.com/issues/5040
2986 */
e627db08
AE
2987 ret = rbd_dev_refresh(rbd_dev);
2988 if (ret)
9584d508 2989 rbd_warn(rbd_dev, "refresh failed: %d", ret);
b8d70035 2990
52bb1f9b
ID
2991 ret = rbd_obj_notify_ack_sync(rbd_dev, notify_id);
2992 if (ret)
9584d508 2993 rbd_warn(rbd_dev, "notify_ack ret %d", ret);
b8d70035
AE
2994}
2995
bb040aa0
ID
2996/*
2997 * Send a (un)watch request and wait for the ack. Return a request
2998 * with a ref held on success or error.
2999 */
3000static struct rbd_obj_request *rbd_obj_watch_request_helper(
3001 struct rbd_device *rbd_dev,
3002 bool watch)
3003{
3004 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3005 struct rbd_obj_request *obj_request;
3006 int ret;
3007
3008 obj_request = rbd_obj_request_create(rbd_dev->header_name, 0, 0,
3009 OBJ_REQUEST_NODATA);
3010 if (!obj_request)
3011 return ERR_PTR(-ENOMEM);
3012
3013 obj_request->osd_req = rbd_osd_req_create(rbd_dev, true, 1,
3014 obj_request);
3015 if (!obj_request->osd_req) {
3016 ret = -ENOMEM;
3017 goto out;
3018 }
3019
3020 osd_req_op_watch_init(obj_request->osd_req, 0, CEPH_OSD_OP_WATCH,
3021 rbd_dev->watch_event->cookie, 0, watch);
3022 rbd_osd_req_format_write(obj_request);
3023
3024 if (watch)
3025 ceph_osdc_set_request_linger(osdc, obj_request->osd_req);
3026
3027 ret = rbd_obj_request_submit(osdc, obj_request);
3028 if (ret)
3029 goto out;
3030
3031 ret = rbd_obj_request_wait(obj_request);
3032 if (ret)
3033 goto out;
3034
3035 ret = obj_request->result;
3036 if (ret) {
3037 if (watch)
3038 rbd_obj_request_end(obj_request);
3039 goto out;
3040 }
3041
3042 return obj_request;
3043
3044out:
3045 rbd_obj_request_put(obj_request);
3046 return ERR_PTR(ret);
3047}
3048
9969ebc5 3049/*
b30a01f2 3050 * Initiate a watch request, synchronously.
9969ebc5 3051 */
b30a01f2 3052static int rbd_dev_header_watch_sync(struct rbd_device *rbd_dev)
9969ebc5
AE
3053{
3054 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
3055 struct rbd_obj_request *obj_request;
9969ebc5
AE
3056 int ret;
3057
b30a01f2
ID
3058 rbd_assert(!rbd_dev->watch_event);
3059 rbd_assert(!rbd_dev->watch_request);
9969ebc5 3060
b30a01f2
ID
3061 ret = ceph_osdc_create_event(osdc, rbd_watch_cb, rbd_dev,
3062 &rbd_dev->watch_event);
3063 if (ret < 0)
3064 return ret;
3065
76756a51
ID
3066 obj_request = rbd_obj_watch_request_helper(rbd_dev, true);
3067 if (IS_ERR(obj_request)) {
3068 ceph_osdc_cancel_event(rbd_dev->watch_event);
3069 rbd_dev->watch_event = NULL;
3070 return PTR_ERR(obj_request);
b30a01f2 3071 }
9969ebc5 3072
8eb87565
AE
3073 /*
3074 * A watch request is set to linger, so the underlying osd
3075 * request won't go away until we unregister it. We retain
3076 * a pointer to the object request during that time (in
76756a51
ID
3077 * rbd_dev->watch_request), so we'll keep a reference to it.
3078 * We'll drop that reference after we've unregistered it in
3079 * rbd_dev_header_unwatch_sync().
8eb87565 3080 */
b30a01f2 3081 rbd_dev->watch_request = obj_request;
8eb87565 3082
b30a01f2 3083 return 0;
b30a01f2
ID
3084}
3085
3086/*
3087 * Tear down a watch request, synchronously.
3088 */
76756a51 3089static void rbd_dev_header_unwatch_sync(struct rbd_device *rbd_dev)
b30a01f2 3090{
b30a01f2 3091 struct rbd_obj_request *obj_request;
b30a01f2
ID
3092
3093 rbd_assert(rbd_dev->watch_event);
3094 rbd_assert(rbd_dev->watch_request);
3095
76756a51 3096 rbd_obj_request_end(rbd_dev->watch_request);
8eb87565
AE
3097 rbd_obj_request_put(rbd_dev->watch_request);
3098 rbd_dev->watch_request = NULL;
b30a01f2 3099
76756a51
ID
3100 obj_request = rbd_obj_watch_request_helper(rbd_dev, false);
3101 if (!IS_ERR(obj_request))
3102 rbd_obj_request_put(obj_request);
3103 else
3104 rbd_warn(rbd_dev, "unable to tear down watch request (%ld)",
3105 PTR_ERR(obj_request));
3106
9969ebc5
AE
3107 ceph_osdc_cancel_event(rbd_dev->watch_event);
3108 rbd_dev->watch_event = NULL;
fca27065
ID
3109}
3110
36be9a76 3111/*
f40eb349
AE
3112 * Synchronous osd object method call. Returns the number of bytes
3113 * returned in the outbound buffer, or a negative error code.
36be9a76
AE
3114 */
3115static int rbd_obj_method_sync(struct rbd_device *rbd_dev,
3116 const char *object_name,
3117 const char *class_name,
3118 const char *method_name,
4157976b 3119 const void *outbound,
36be9a76 3120 size_t outbound_size,
4157976b 3121 void *inbound,
e2a58ee5 3122 size_t inbound_size)
36be9a76 3123{
2169238d 3124 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
36be9a76 3125 struct rbd_obj_request *obj_request;
36be9a76
AE
3126 struct page **pages;
3127 u32 page_count;
3128 int ret;
3129
3130 /*
6010a451
AE
3131 * Method calls are ultimately read operations. The result
3132 * should placed into the inbound buffer provided. They
3133 * also supply outbound data--parameters for the object
3134 * method. Currently if this is present it will be a
3135 * snapshot id.
36be9a76 3136 */
57385b51 3137 page_count = (u32)calc_pages_for(0, inbound_size);
36be9a76
AE
3138 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
3139 if (IS_ERR(pages))
3140 return PTR_ERR(pages);
3141
3142 ret = -ENOMEM;
6010a451 3143 obj_request = rbd_obj_request_create(object_name, 0, inbound_size,
36be9a76
AE
3144 OBJ_REQUEST_PAGES);
3145 if (!obj_request)
3146 goto out;
3147
3148 obj_request->pages = pages;
3149 obj_request->page_count = page_count;
3150
deb236b3
ID
3151 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false, 1,
3152 obj_request);
36be9a76
AE
3153 if (!obj_request->osd_req)
3154 goto out;
3155
c99d2d4a 3156 osd_req_op_cls_init(obj_request->osd_req, 0, CEPH_OSD_OP_CALL,
04017e29
AE
3157 class_name, method_name);
3158 if (outbound_size) {
3159 struct ceph_pagelist *pagelist;
3160
3161 pagelist = kmalloc(sizeof (*pagelist), GFP_NOFS);
3162 if (!pagelist)
3163 goto out;
3164
3165 ceph_pagelist_init(pagelist);
3166 ceph_pagelist_append(pagelist, outbound, outbound_size);
3167 osd_req_op_cls_request_data_pagelist(obj_request->osd_req, 0,
3168 pagelist);
3169 }
a4ce40a9
AE
3170 osd_req_op_cls_response_data_pages(obj_request->osd_req, 0,
3171 obj_request->pages, inbound_size,
44cd188d 3172 0, false, false);
9d4df01f 3173 rbd_osd_req_format_read(obj_request);
430c28c3 3174
36be9a76
AE
3175 ret = rbd_obj_request_submit(osdc, obj_request);
3176 if (ret)
3177 goto out;
3178 ret = rbd_obj_request_wait(obj_request);
3179 if (ret)
3180 goto out;
3181
3182 ret = obj_request->result;
3183 if (ret < 0)
3184 goto out;
57385b51
AE
3185
3186 rbd_assert(obj_request->xferred < (u64)INT_MAX);
3187 ret = (int)obj_request->xferred;
903bb32e 3188 ceph_copy_from_page_vector(pages, inbound, 0, obj_request->xferred);
36be9a76
AE
3189out:
3190 if (obj_request)
3191 rbd_obj_request_put(obj_request);
3192 else
3193 ceph_release_page_vector(pages, page_count);
3194
3195 return ret;
3196}
3197
bc1ecc65 3198static void rbd_handle_request(struct rbd_device *rbd_dev, struct request *rq)
bf0d5f50 3199{
bc1ecc65 3200 struct rbd_img_request *img_request;
4e752f0a 3201 struct ceph_snap_context *snapc = NULL;
bc1ecc65
ID
3202 u64 offset = (u64)blk_rq_pos(rq) << SECTOR_SHIFT;
3203 u64 length = blk_rq_bytes(rq);
3204 bool wr = rq_data_dir(rq) == WRITE;
4e752f0a 3205 u64 mapping_size;
bf0d5f50
AE
3206 int result;
3207
bc1ecc65 3208 /* Ignore/skip any zero-length requests */
bf0d5f50 3209
bc1ecc65
ID
3210 if (!length) {
3211 dout("%s: zero-length request\n", __func__);
3212 result = 0;
3213 goto err_rq;
3214 }
bf0d5f50 3215
bc1ecc65
ID
3216 /* Disallow writes to a read-only device */
3217
3218 if (wr) {
3219 if (rbd_dev->mapping.read_only) {
3220 result = -EROFS;
3221 goto err_rq;
4dda41d3 3222 }
bc1ecc65
ID
3223 rbd_assert(rbd_dev->spec->snap_id == CEPH_NOSNAP);
3224 }
4dda41d3 3225
bc1ecc65
ID
3226 /*
3227 * Quit early if the mapped snapshot no longer exists. It's
3228 * still possible the snapshot will have disappeared by the
3229 * time our request arrives at the osd, but there's no sense in
3230 * sending it if we already know.
3231 */
3232 if (!test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags)) {
3233 dout("request for non-existent snapshot");
3234 rbd_assert(rbd_dev->spec->snap_id != CEPH_NOSNAP);
3235 result = -ENXIO;
3236 goto err_rq;
3237 }
4dda41d3 3238
bc1ecc65
ID
3239 if (offset && length > U64_MAX - offset + 1) {
3240 rbd_warn(rbd_dev, "bad request range (%llu~%llu)", offset,
3241 length);
3242 result = -EINVAL;
3243 goto err_rq; /* Shouldn't happen */
3244 }
4dda41d3 3245
4e752f0a
JD
3246 down_read(&rbd_dev->header_rwsem);
3247 mapping_size = rbd_dev->mapping.size;
3248 if (wr) {
3249 snapc = rbd_dev->header.snapc;
3250 ceph_get_snap_context(snapc);
3251 }
3252 up_read(&rbd_dev->header_rwsem);
3253
3254 if (offset + length > mapping_size) {
bc1ecc65 3255 rbd_warn(rbd_dev, "beyond EOD (%llu~%llu > %llu)", offset,
4e752f0a 3256 length, mapping_size);
bc1ecc65
ID
3257 result = -EIO;
3258 goto err_rq;
3259 }
bf0d5f50 3260
4e752f0a
JD
3261 img_request = rbd_img_request_create(rbd_dev, offset, length, wr,
3262 snapc);
bc1ecc65
ID
3263 if (!img_request) {
3264 result = -ENOMEM;
3265 goto err_rq;
3266 }
3267 img_request->rq = rq;
bf0d5f50 3268
bc1ecc65
ID
3269 result = rbd_img_request_fill(img_request, OBJ_REQUEST_BIO, rq->bio);
3270 if (result)
3271 goto err_img_request;
bf0d5f50 3272
bc1ecc65
ID
3273 result = rbd_img_request_submit(img_request);
3274 if (result)
3275 goto err_img_request;
bf0d5f50 3276
bc1ecc65 3277 return;
bf0d5f50 3278
bc1ecc65
ID
3279err_img_request:
3280 rbd_img_request_put(img_request);
3281err_rq:
3282 if (result)
3283 rbd_warn(rbd_dev, "%s %llx at %llx result %d",
3284 wr ? "write" : "read", length, offset, result);
4e752f0a
JD
3285 if (snapc)
3286 ceph_put_snap_context(snapc);
bc1ecc65
ID
3287 blk_end_request_all(rq, result);
3288}
bf0d5f50 3289
bc1ecc65
ID
3290static void rbd_request_workfn(struct work_struct *work)
3291{
3292 struct rbd_device *rbd_dev =
3293 container_of(work, struct rbd_device, rq_work);
3294 struct request *rq, *next;
3295 LIST_HEAD(requests);
00a653e2 3296
bc1ecc65
ID
3297 spin_lock_irq(&rbd_dev->lock); /* rq->q->queue_lock */
3298 list_splice_init(&rbd_dev->rq_queue, &requests);
3299 spin_unlock_irq(&rbd_dev->lock);
bf0d5f50 3300
bc1ecc65
ID
3301 list_for_each_entry_safe(rq, next, &requests, queuelist) {
3302 list_del_init(&rq->queuelist);
3303 rbd_handle_request(rbd_dev, rq);
3304 }
3305}
bf0d5f50 3306
bc1ecc65
ID
3307/*
3308 * Called with q->queue_lock held and interrupts disabled, possibly on
3309 * the way to schedule(). Do not sleep here!
3310 */
3311static void rbd_request_fn(struct request_queue *q)
3312{
3313 struct rbd_device *rbd_dev = q->queuedata;
3314 struct request *rq;
3315 int queued = 0;
3316
3317 rbd_assert(rbd_dev);
3318
3319 while ((rq = blk_fetch_request(q))) {
3320 /* Ignore any non-FS requests that filter through. */
3321 if (rq->cmd_type != REQ_TYPE_FS) {
3322 dout("%s: non-fs request type %d\n", __func__,
3323 (int) rq->cmd_type);
3324 __blk_end_request_all(rq, 0);
3325 continue;
bf0d5f50 3326 }
bc1ecc65
ID
3327
3328 list_add_tail(&rq->queuelist, &rbd_dev->rq_queue);
3329 queued++;
bf0d5f50 3330 }
bc1ecc65
ID
3331
3332 if (queued)
3333 queue_work(rbd_dev->rq_wq, &rbd_dev->rq_work);
bf0d5f50
AE
3334}
3335
602adf40
YS
3336/*
3337 * a queue callback. Makes sure that we don't create a bio that spans across
3338 * multiple osd objects. One exception would be with a single page bios,
f7760dad 3339 * which we handle later at bio_chain_clone_range()
602adf40
YS
3340 */
3341static int rbd_merge_bvec(struct request_queue *q, struct bvec_merge_data *bmd,
3342 struct bio_vec *bvec)
3343{
3344 struct rbd_device *rbd_dev = q->queuedata;
e5cfeed2
AE
3345 sector_t sector_offset;
3346 sector_t sectors_per_obj;
3347 sector_t obj_sector_offset;
3348 int ret;
3349
3350 /*
3351 * Find how far into its rbd object the partition-relative
3352 * bio start sector is to offset relative to the enclosing
3353 * device.
3354 */
3355 sector_offset = get_start_sect(bmd->bi_bdev) + bmd->bi_sector;
3356 sectors_per_obj = 1 << (rbd_dev->header.obj_order - SECTOR_SHIFT);
3357 obj_sector_offset = sector_offset & (sectors_per_obj - 1);
3358
3359 /*
3360 * Compute the number of bytes from that offset to the end
3361 * of the object. Account for what's already used by the bio.
3362 */
3363 ret = (int) (sectors_per_obj - obj_sector_offset) << SECTOR_SHIFT;
3364 if (ret > bmd->bi_size)
3365 ret -= bmd->bi_size;
3366 else
3367 ret = 0;
3368
3369 /*
3370 * Don't send back more than was asked for. And if the bio
3371 * was empty, let the whole thing through because: "Note
3372 * that a block device *must* allow a single page to be
3373 * added to an empty bio."
3374 */
3375 rbd_assert(bvec->bv_len <= PAGE_SIZE);
3376 if (ret > (int) bvec->bv_len || !bmd->bi_size)
3377 ret = (int) bvec->bv_len;
3378
3379 return ret;
602adf40
YS
3380}
3381
3382static void rbd_free_disk(struct rbd_device *rbd_dev)
3383{
3384 struct gendisk *disk = rbd_dev->disk;
3385
3386 if (!disk)
3387 return;
3388
a0cab924
AE
3389 rbd_dev->disk = NULL;
3390 if (disk->flags & GENHD_FL_UP) {
602adf40 3391 del_gendisk(disk);
a0cab924
AE
3392 if (disk->queue)
3393 blk_cleanup_queue(disk->queue);
3394 }
602adf40
YS
3395 put_disk(disk);
3396}
3397
788e2df3
AE
3398static int rbd_obj_read_sync(struct rbd_device *rbd_dev,
3399 const char *object_name,
7097f8df 3400 u64 offset, u64 length, void *buf)
788e2df3
AE
3401
3402{
2169238d 3403 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
788e2df3 3404 struct rbd_obj_request *obj_request;
788e2df3
AE
3405 struct page **pages = NULL;
3406 u32 page_count;
1ceae7ef 3407 size_t size;
788e2df3
AE
3408 int ret;
3409
3410 page_count = (u32) calc_pages_for(offset, length);
3411 pages = ceph_alloc_page_vector(page_count, GFP_KERNEL);
3412 if (IS_ERR(pages))
3413 ret = PTR_ERR(pages);
3414
3415 ret = -ENOMEM;
3416 obj_request = rbd_obj_request_create(object_name, offset, length,
36be9a76 3417 OBJ_REQUEST_PAGES);
788e2df3
AE
3418 if (!obj_request)
3419 goto out;
3420
3421 obj_request->pages = pages;
3422 obj_request->page_count = page_count;
3423
deb236b3
ID
3424 obj_request->osd_req = rbd_osd_req_create(rbd_dev, false, 1,
3425 obj_request);
788e2df3
AE
3426 if (!obj_request->osd_req)
3427 goto out;
3428
c99d2d4a
AE
3429 osd_req_op_extent_init(obj_request->osd_req, 0, CEPH_OSD_OP_READ,
3430 offset, length, 0, 0);
406e2c9f 3431 osd_req_op_extent_osd_data_pages(obj_request->osd_req, 0,
a4ce40a9 3432 obj_request->pages,
44cd188d
AE
3433 obj_request->length,
3434 obj_request->offset & ~PAGE_MASK,
3435 false, false);
9d4df01f 3436 rbd_osd_req_format_read(obj_request);
430c28c3 3437
788e2df3
AE
3438 ret = rbd_obj_request_submit(osdc, obj_request);
3439 if (ret)
3440 goto out;
3441 ret = rbd_obj_request_wait(obj_request);
3442 if (ret)
3443 goto out;
3444
3445 ret = obj_request->result;
3446 if (ret < 0)
3447 goto out;
1ceae7ef
AE
3448
3449 rbd_assert(obj_request->xferred <= (u64) SIZE_MAX);
3450 size = (size_t) obj_request->xferred;
903bb32e 3451 ceph_copy_from_page_vector(pages, buf, 0, size);
7097f8df
AE
3452 rbd_assert(size <= (size_t)INT_MAX);
3453 ret = (int)size;
788e2df3
AE
3454out:
3455 if (obj_request)
3456 rbd_obj_request_put(obj_request);
3457 else
3458 ceph_release_page_vector(pages, page_count);
3459
3460 return ret;
3461}
3462
602adf40 3463/*
662518b1
AE
3464 * Read the complete header for the given rbd device. On successful
3465 * return, the rbd_dev->header field will contain up-to-date
3466 * information about the image.
602adf40 3467 */
99a41ebc 3468static int rbd_dev_v1_header_info(struct rbd_device *rbd_dev)
602adf40 3469{
4156d998 3470 struct rbd_image_header_ondisk *ondisk = NULL;
50f7c4c9 3471 u32 snap_count = 0;
4156d998
AE
3472 u64 names_size = 0;
3473 u32 want_count;
3474 int ret;
602adf40 3475
00f1f36f 3476 /*
4156d998
AE
3477 * The complete header will include an array of its 64-bit
3478 * snapshot ids, followed by the names of those snapshots as
3479 * a contiguous block of NUL-terminated strings. Note that
3480 * the number of snapshots could change by the time we read
3481 * it in, in which case we re-read it.
00f1f36f 3482 */
4156d998
AE
3483 do {
3484 size_t size;
3485
3486 kfree(ondisk);
3487
3488 size = sizeof (*ondisk);
3489 size += snap_count * sizeof (struct rbd_image_snap_ondisk);
3490 size += names_size;
3491 ondisk = kmalloc(size, GFP_KERNEL);
3492 if (!ondisk)
662518b1 3493 return -ENOMEM;
4156d998 3494
788e2df3 3495 ret = rbd_obj_read_sync(rbd_dev, rbd_dev->header_name,
7097f8df 3496 0, size, ondisk);
4156d998 3497 if (ret < 0)
662518b1 3498 goto out;
c0cd10db 3499 if ((size_t)ret < size) {
4156d998 3500 ret = -ENXIO;
06ecc6cb
AE
3501 rbd_warn(rbd_dev, "short header read (want %zd got %d)",
3502 size, ret);
662518b1 3503 goto out;
4156d998
AE
3504 }
3505 if (!rbd_dev_ondisk_valid(ondisk)) {
3506 ret = -ENXIO;
06ecc6cb 3507 rbd_warn(rbd_dev, "invalid header");
662518b1 3508 goto out;
81e759fb 3509 }
602adf40 3510
4156d998
AE
3511 names_size = le64_to_cpu(ondisk->snap_names_len);
3512 want_count = snap_count;
3513 snap_count = le32_to_cpu(ondisk->snap_count);
3514 } while (snap_count != want_count);
00f1f36f 3515
662518b1
AE
3516 ret = rbd_header_from_disk(rbd_dev, ondisk);
3517out:
4156d998
AE
3518 kfree(ondisk);
3519
3520 return ret;
602adf40
YS
3521}
3522
15228ede
AE
3523/*
3524 * Clear the rbd device's EXISTS flag if the snapshot it's mapped to
3525 * has disappeared from the (just updated) snapshot context.
3526 */
3527static void rbd_exists_validate(struct rbd_device *rbd_dev)
3528{
3529 u64 snap_id;
3530
3531 if (!test_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags))
3532 return;
3533
3534 snap_id = rbd_dev->spec->snap_id;
3535 if (snap_id == CEPH_NOSNAP)
3536 return;
3537
3538 if (rbd_dev_snap_index(rbd_dev, snap_id) == BAD_SNAP_INDEX)
3539 clear_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
3540}
3541
9875201e
JD
3542static void rbd_dev_update_size(struct rbd_device *rbd_dev)
3543{
3544 sector_t size;
3545 bool removing;
3546
3547 /*
3548 * Don't hold the lock while doing disk operations,
3549 * or lock ordering will conflict with the bdev mutex via:
3550 * rbd_add() -> blkdev_get() -> rbd_open()
3551 */
3552 spin_lock_irq(&rbd_dev->lock);
3553 removing = test_bit(RBD_DEV_FLAG_REMOVING, &rbd_dev->flags);
3554 spin_unlock_irq(&rbd_dev->lock);
3555 /*
3556 * If the device is being removed, rbd_dev->disk has
3557 * been destroyed, so don't try to update its size
3558 */
3559 if (!removing) {
3560 size = (sector_t)rbd_dev->mapping.size / SECTOR_SIZE;
3561 dout("setting size to %llu sectors", (unsigned long long)size);
3562 set_capacity(rbd_dev->disk, size);
3563 revalidate_disk(rbd_dev->disk);
3564 }
3565}
3566
cc4a38bd 3567static int rbd_dev_refresh(struct rbd_device *rbd_dev)
1fe5e993 3568{
e627db08 3569 u64 mapping_size;
1fe5e993
AE
3570 int ret;
3571
cfbf6377 3572 down_write(&rbd_dev->header_rwsem);
3b5cf2a2 3573 mapping_size = rbd_dev->mapping.size;
a720ae09
ID
3574
3575 ret = rbd_dev_header_info(rbd_dev);
52bb1f9b
ID
3576 if (ret)
3577 return ret;
15228ede 3578
e8f59b59
ID
3579 /*
3580 * If there is a parent, see if it has disappeared due to the
3581 * mapped image getting flattened.
3582 */
3583 if (rbd_dev->parent) {
3584 ret = rbd_dev_v2_parent_info(rbd_dev);
3585 if (ret)
3586 return ret;
3587 }
3588
5ff1108c
ID
3589 if (rbd_dev->spec->snap_id == CEPH_NOSNAP) {
3590 if (rbd_dev->mapping.size != rbd_dev->header.image_size)
3591 rbd_dev->mapping.size = rbd_dev->header.image_size;
3592 } else {
3593 /* validate mapped snapshot's EXISTS flag */
3594 rbd_exists_validate(rbd_dev);
3595 }
15228ede 3596
cfbf6377
AE
3597 up_write(&rbd_dev->header_rwsem);
3598
e8f59b59 3599 if (mapping_size != rbd_dev->mapping.size)
9875201e 3600 rbd_dev_update_size(rbd_dev);
1fe5e993 3601
52bb1f9b 3602 return 0;
1fe5e993
AE
3603}
3604
602adf40
YS
3605static int rbd_init_disk(struct rbd_device *rbd_dev)
3606{
3607 struct gendisk *disk;
3608 struct request_queue *q;
593a9e7b 3609 u64 segment_size;
602adf40 3610
602adf40 3611 /* create gendisk info */
7e513d43
ID
3612 disk = alloc_disk(single_major ?
3613 (1 << RBD_SINGLE_MAJOR_PART_SHIFT) :
3614 RBD_MINORS_PER_MAJOR);
602adf40 3615 if (!disk)
1fcdb8aa 3616 return -ENOMEM;
602adf40 3617
f0f8cef5 3618 snprintf(disk->disk_name, sizeof(disk->disk_name), RBD_DRV_NAME "%d",
de71a297 3619 rbd_dev->dev_id);
602adf40 3620 disk->major = rbd_dev->major;
dd82fff1 3621 disk->first_minor = rbd_dev->minor;
7e513d43
ID
3622 if (single_major)
3623 disk->flags |= GENHD_FL_EXT_DEVT;
602adf40
YS
3624 disk->fops = &rbd_bd_ops;
3625 disk->private_data = rbd_dev;
3626
bf0d5f50 3627 q = blk_init_queue(rbd_request_fn, &rbd_dev->lock);
602adf40
YS
3628 if (!q)
3629 goto out_disk;
029bcbd8 3630
593a9e7b
AE
3631 /* We use the default size, but let's be explicit about it. */
3632 blk_queue_physical_block_size(q, SECTOR_SIZE);
3633
029bcbd8 3634 /* set io sizes to object size */
593a9e7b
AE
3635 segment_size = rbd_obj_bytes(&rbd_dev->header);
3636 blk_queue_max_hw_sectors(q, segment_size / SECTOR_SIZE);
3637 blk_queue_max_segment_size(q, segment_size);
3638 blk_queue_io_min(q, segment_size);
3639 blk_queue_io_opt(q, segment_size);
029bcbd8 3640
602adf40
YS
3641 blk_queue_merge_bvec(q, rbd_merge_bvec);
3642 disk->queue = q;
3643
3644 q->queuedata = rbd_dev;
3645
3646 rbd_dev->disk = disk;
602adf40 3647
602adf40 3648 return 0;
602adf40
YS
3649out_disk:
3650 put_disk(disk);
1fcdb8aa
AE
3651
3652 return -ENOMEM;
602adf40
YS
3653}
3654
dfc5606d
YS
3655/*
3656 sysfs
3657*/
3658
593a9e7b
AE
3659static struct rbd_device *dev_to_rbd_dev(struct device *dev)
3660{
3661 return container_of(dev, struct rbd_device, dev);
3662}
3663
dfc5606d
YS
3664static ssize_t rbd_size_show(struct device *dev,
3665 struct device_attribute *attr, char *buf)
3666{
593a9e7b 3667 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
a51aa0c0 3668
fc71d833
AE
3669 return sprintf(buf, "%llu\n",
3670 (unsigned long long)rbd_dev->mapping.size);
dfc5606d
YS
3671}
3672
34b13184
AE
3673/*
3674 * Note this shows the features for whatever's mapped, which is not
3675 * necessarily the base image.
3676 */
3677static ssize_t rbd_features_show(struct device *dev,
3678 struct device_attribute *attr, char *buf)
3679{
3680 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3681
3682 return sprintf(buf, "0x%016llx\n",
fc71d833 3683 (unsigned long long)rbd_dev->mapping.features);
34b13184
AE
3684}
3685
dfc5606d
YS
3686static ssize_t rbd_major_show(struct device *dev,
3687 struct device_attribute *attr, char *buf)
3688{
593a9e7b 3689 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
602adf40 3690
fc71d833
AE
3691 if (rbd_dev->major)
3692 return sprintf(buf, "%d\n", rbd_dev->major);
3693
3694 return sprintf(buf, "(none)\n");
dd82fff1
ID
3695}
3696
3697static ssize_t rbd_minor_show(struct device *dev,
3698 struct device_attribute *attr, char *buf)
3699{
3700 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
fc71d833 3701
dd82fff1 3702 return sprintf(buf, "%d\n", rbd_dev->minor);
dfc5606d
YS
3703}
3704
3705static ssize_t rbd_client_id_show(struct device *dev,
3706 struct device_attribute *attr, char *buf)
602adf40 3707{
593a9e7b 3708 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
dfc5606d 3709
1dbb4399
AE
3710 return sprintf(buf, "client%lld\n",
3711 ceph_client_id(rbd_dev->rbd_client->client));
602adf40
YS
3712}
3713
dfc5606d
YS
3714static ssize_t rbd_pool_show(struct device *dev,
3715 struct device_attribute *attr, char *buf)
602adf40 3716{
593a9e7b 3717 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
dfc5606d 3718
0d7dbfce 3719 return sprintf(buf, "%s\n", rbd_dev->spec->pool_name);
dfc5606d
YS
3720}
3721
9bb2f334
AE
3722static ssize_t rbd_pool_id_show(struct device *dev,
3723 struct device_attribute *attr, char *buf)
3724{
3725 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3726
0d7dbfce 3727 return sprintf(buf, "%llu\n",
fc71d833 3728 (unsigned long long) rbd_dev->spec->pool_id);
9bb2f334
AE
3729}
3730
dfc5606d
YS
3731static ssize_t rbd_name_show(struct device *dev,
3732 struct device_attribute *attr, char *buf)
3733{
593a9e7b 3734 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
dfc5606d 3735
a92ffdf8
AE
3736 if (rbd_dev->spec->image_name)
3737 return sprintf(buf, "%s\n", rbd_dev->spec->image_name);
3738
3739 return sprintf(buf, "(unknown)\n");
dfc5606d
YS
3740}
3741
589d30e0
AE
3742static ssize_t rbd_image_id_show(struct device *dev,
3743 struct device_attribute *attr, char *buf)
3744{
3745 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
3746
0d7dbfce 3747 return sprintf(buf, "%s\n", rbd_dev->spec->image_id);
589d30e0
AE
3748}
3749
34b13184
AE
3750/*
3751 * Shows the name of the currently-mapped snapshot (or
3752 * RBD_SNAP_HEAD_NAME for the base image).
3753 */
dfc5606d
YS
3754static ssize_t rbd_snap_show(struct device *dev,
3755 struct device_attribute *attr,
3756 char *buf)
3757{
593a9e7b 3758 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
dfc5606d 3759
0d7dbfce 3760 return sprintf(buf, "%s\n", rbd_dev->spec->snap_name);
dfc5606d
YS
3761}
3762
86b00e0d 3763/*
ff96128f
ID
3764 * For a v2 image, shows the chain of parent images, separated by empty
3765 * lines. For v1 images or if there is no parent, shows "(no parent
3766 * image)".
86b00e0d
AE
3767 */
3768static ssize_t rbd_parent_show(struct device *dev,
ff96128f
ID
3769 struct device_attribute *attr,
3770 char *buf)
86b00e0d
AE
3771{
3772 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
ff96128f 3773 ssize_t count = 0;
86b00e0d 3774
ff96128f 3775 if (!rbd_dev->parent)
86b00e0d
AE
3776 return sprintf(buf, "(no parent image)\n");
3777
ff96128f
ID
3778 for ( ; rbd_dev->parent; rbd_dev = rbd_dev->parent) {
3779 struct rbd_spec *spec = rbd_dev->parent_spec;
3780
3781 count += sprintf(&buf[count], "%s"
3782 "pool_id %llu\npool_name %s\n"
3783 "image_id %s\nimage_name %s\n"
3784 "snap_id %llu\nsnap_name %s\n"
3785 "overlap %llu\n",
3786 !count ? "" : "\n", /* first? */
3787 spec->pool_id, spec->pool_name,
3788 spec->image_id, spec->image_name ?: "(unknown)",
3789 spec->snap_id, spec->snap_name,
3790 rbd_dev->parent_overlap);
3791 }
3792
3793 return count;
86b00e0d
AE
3794}
3795
dfc5606d
YS
3796static ssize_t rbd_image_refresh(struct device *dev,
3797 struct device_attribute *attr,
3798 const char *buf,
3799 size_t size)
3800{
593a9e7b 3801 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
b813623a 3802 int ret;
602adf40 3803
cc4a38bd 3804 ret = rbd_dev_refresh(rbd_dev);
e627db08 3805 if (ret)
52bb1f9b 3806 return ret;
b813623a 3807
52bb1f9b 3808 return size;
dfc5606d 3809}
602adf40 3810
dfc5606d 3811static DEVICE_ATTR(size, S_IRUGO, rbd_size_show, NULL);
34b13184 3812static DEVICE_ATTR(features, S_IRUGO, rbd_features_show, NULL);
dfc5606d 3813static DEVICE_ATTR(major, S_IRUGO, rbd_major_show, NULL);
dd82fff1 3814static DEVICE_ATTR(minor, S_IRUGO, rbd_minor_show, NULL);
dfc5606d
YS
3815static DEVICE_ATTR(client_id, S_IRUGO, rbd_client_id_show, NULL);
3816static DEVICE_ATTR(pool, S_IRUGO, rbd_pool_show, NULL);
9bb2f334 3817static DEVICE_ATTR(pool_id, S_IRUGO, rbd_pool_id_show, NULL);
dfc5606d 3818static DEVICE_ATTR(name, S_IRUGO, rbd_name_show, NULL);
589d30e0 3819static DEVICE_ATTR(image_id, S_IRUGO, rbd_image_id_show, NULL);
dfc5606d
YS
3820static DEVICE_ATTR(refresh, S_IWUSR, NULL, rbd_image_refresh);
3821static DEVICE_ATTR(current_snap, S_IRUGO, rbd_snap_show, NULL);
86b00e0d 3822static DEVICE_ATTR(parent, S_IRUGO, rbd_parent_show, NULL);
dfc5606d
YS
3823
3824static struct attribute *rbd_attrs[] = {
3825 &dev_attr_size.attr,
34b13184 3826 &dev_attr_features.attr,
dfc5606d 3827 &dev_attr_major.attr,
dd82fff1 3828 &dev_attr_minor.attr,
dfc5606d
YS
3829 &dev_attr_client_id.attr,
3830 &dev_attr_pool.attr,
9bb2f334 3831 &dev_attr_pool_id.attr,
dfc5606d 3832 &dev_attr_name.attr,
589d30e0 3833 &dev_attr_image_id.attr,
dfc5606d 3834 &dev_attr_current_snap.attr,
86b00e0d 3835 &dev_attr_parent.attr,
dfc5606d 3836 &dev_attr_refresh.attr,
dfc5606d
YS
3837 NULL
3838};
3839
3840static struct attribute_group rbd_attr_group = {
3841 .attrs = rbd_attrs,
3842};
3843
3844static const struct attribute_group *rbd_attr_groups[] = {
3845 &rbd_attr_group,
3846 NULL
3847};
3848
3849static void rbd_sysfs_dev_release(struct device *dev)
3850{
3851}
3852
3853static struct device_type rbd_device_type = {
3854 .name = "rbd",
3855 .groups = rbd_attr_groups,
3856 .release = rbd_sysfs_dev_release,
3857};
3858
8b8fb99c
AE
3859static struct rbd_spec *rbd_spec_get(struct rbd_spec *spec)
3860{
3861 kref_get(&spec->kref);
3862
3863 return spec;
3864}
3865
3866static void rbd_spec_free(struct kref *kref);
3867static void rbd_spec_put(struct rbd_spec *spec)
3868{
3869 if (spec)
3870 kref_put(&spec->kref, rbd_spec_free);
3871}
3872
3873static struct rbd_spec *rbd_spec_alloc(void)
3874{
3875 struct rbd_spec *spec;
3876
3877 spec = kzalloc(sizeof (*spec), GFP_KERNEL);
3878 if (!spec)
3879 return NULL;
04077599
ID
3880
3881 spec->pool_id = CEPH_NOPOOL;
3882 spec->snap_id = CEPH_NOSNAP;
8b8fb99c
AE
3883 kref_init(&spec->kref);
3884
8b8fb99c
AE
3885 return spec;
3886}
3887
3888static void rbd_spec_free(struct kref *kref)
3889{
3890 struct rbd_spec *spec = container_of(kref, struct rbd_spec, kref);
3891
3892 kfree(spec->pool_name);
3893 kfree(spec->image_id);
3894 kfree(spec->image_name);
3895 kfree(spec->snap_name);
3896 kfree(spec);
3897}
3898
cc344fa1 3899static struct rbd_device *rbd_dev_create(struct rbd_client *rbdc,
c53d5893
AE
3900 struct rbd_spec *spec)
3901{
3902 struct rbd_device *rbd_dev;
3903
3904 rbd_dev = kzalloc(sizeof (*rbd_dev), GFP_KERNEL);
3905 if (!rbd_dev)
3906 return NULL;
3907
3908 spin_lock_init(&rbd_dev->lock);
bc1ecc65
ID
3909 INIT_LIST_HEAD(&rbd_dev->rq_queue);
3910 INIT_WORK(&rbd_dev->rq_work, rbd_request_workfn);
6d292906 3911 rbd_dev->flags = 0;
a2acd00e 3912 atomic_set(&rbd_dev->parent_ref, 0);
c53d5893 3913 INIT_LIST_HEAD(&rbd_dev->node);
c53d5893
AE
3914 init_rwsem(&rbd_dev->header_rwsem);
3915
3916 rbd_dev->spec = spec;
3917 rbd_dev->rbd_client = rbdc;
3918
0903e875
AE
3919 /* Initialize the layout used for all rbd requests */
3920
3921 rbd_dev->layout.fl_stripe_unit = cpu_to_le32(1 << RBD_MAX_OBJ_ORDER);
3922 rbd_dev->layout.fl_stripe_count = cpu_to_le32(1);
3923 rbd_dev->layout.fl_object_size = cpu_to_le32(1 << RBD_MAX_OBJ_ORDER);
3924 rbd_dev->layout.fl_pg_pool = cpu_to_le32((u32) spec->pool_id);
3925
c53d5893
AE
3926 return rbd_dev;
3927}
3928
3929static void rbd_dev_destroy(struct rbd_device *rbd_dev)
3930{
c53d5893
AE
3931 rbd_put_client(rbd_dev->rbd_client);
3932 rbd_spec_put(rbd_dev->spec);
3933 kfree(rbd_dev);
3934}
3935
9d475de5
AE
3936/*
3937 * Get the size and object order for an image snapshot, or if
3938 * snap_id is CEPH_NOSNAP, gets this information for the base
3939 * image.
3940 */
3941static int _rbd_dev_v2_snap_size(struct rbd_device *rbd_dev, u64 snap_id,
3942 u8 *order, u64 *snap_size)
3943{
3944 __le64 snapid = cpu_to_le64(snap_id);
3945 int ret;
3946 struct {
3947 u8 order;
3948 __le64 size;
3949 } __attribute__ ((packed)) size_buf = { 0 };
3950
36be9a76 3951 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
9d475de5 3952 "rbd", "get_size",
4157976b 3953 &snapid, sizeof (snapid),
e2a58ee5 3954 &size_buf, sizeof (size_buf));
36be9a76 3955 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
9d475de5
AE
3956 if (ret < 0)
3957 return ret;
57385b51
AE
3958 if (ret < sizeof (size_buf))
3959 return -ERANGE;
9d475de5 3960
c3545579 3961 if (order) {
c86f86e9 3962 *order = size_buf.order;
c3545579
JD
3963 dout(" order %u", (unsigned int)*order);
3964 }
9d475de5
AE
3965 *snap_size = le64_to_cpu(size_buf.size);
3966
c3545579
JD
3967 dout(" snap_id 0x%016llx snap_size = %llu\n",
3968 (unsigned long long)snap_id,
57385b51 3969 (unsigned long long)*snap_size);
9d475de5
AE
3970
3971 return 0;
3972}
3973
3974static int rbd_dev_v2_image_size(struct rbd_device *rbd_dev)
3975{
3976 return _rbd_dev_v2_snap_size(rbd_dev, CEPH_NOSNAP,
3977 &rbd_dev->header.obj_order,
3978 &rbd_dev->header.image_size);
3979}
3980
1e130199
AE
3981static int rbd_dev_v2_object_prefix(struct rbd_device *rbd_dev)
3982{
3983 void *reply_buf;
3984 int ret;
3985 void *p;
3986
3987 reply_buf = kzalloc(RBD_OBJ_PREFIX_LEN_MAX, GFP_KERNEL);
3988 if (!reply_buf)
3989 return -ENOMEM;
3990
36be9a76 3991 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
4157976b 3992 "rbd", "get_object_prefix", NULL, 0,
e2a58ee5 3993 reply_buf, RBD_OBJ_PREFIX_LEN_MAX);
36be9a76 3994 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
1e130199
AE
3995 if (ret < 0)
3996 goto out;
3997
3998 p = reply_buf;
3999 rbd_dev->header.object_prefix = ceph_extract_encoded_string(&p,
57385b51
AE
4000 p + ret, NULL, GFP_NOIO);
4001 ret = 0;
1e130199
AE
4002
4003 if (IS_ERR(rbd_dev->header.object_prefix)) {
4004 ret = PTR_ERR(rbd_dev->header.object_prefix);
4005 rbd_dev->header.object_prefix = NULL;
4006 } else {
4007 dout(" object_prefix = %s\n", rbd_dev->header.object_prefix);
4008 }
1e130199
AE
4009out:
4010 kfree(reply_buf);
4011
4012 return ret;
4013}
4014
b1b5402a
AE
4015static int _rbd_dev_v2_snap_features(struct rbd_device *rbd_dev, u64 snap_id,
4016 u64 *snap_features)
4017{
4018 __le64 snapid = cpu_to_le64(snap_id);
4019 struct {
4020 __le64 features;
4021 __le64 incompat;
4157976b 4022 } __attribute__ ((packed)) features_buf = { 0 };
d889140c 4023 u64 incompat;
b1b5402a
AE
4024 int ret;
4025
36be9a76 4026 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
b1b5402a 4027 "rbd", "get_features",
4157976b 4028 &snapid, sizeof (snapid),
e2a58ee5 4029 &features_buf, sizeof (features_buf));
36be9a76 4030 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
b1b5402a
AE
4031 if (ret < 0)
4032 return ret;
57385b51
AE
4033 if (ret < sizeof (features_buf))
4034 return -ERANGE;
d889140c
AE
4035
4036 incompat = le64_to_cpu(features_buf.incompat);
5cbf6f12 4037 if (incompat & ~RBD_FEATURES_SUPPORTED)
b8f5c6ed 4038 return -ENXIO;
d889140c 4039
b1b5402a
AE
4040 *snap_features = le64_to_cpu(features_buf.features);
4041
4042 dout(" snap_id 0x%016llx features = 0x%016llx incompat = 0x%016llx\n",
57385b51
AE
4043 (unsigned long long)snap_id,
4044 (unsigned long long)*snap_features,
4045 (unsigned long long)le64_to_cpu(features_buf.incompat));
b1b5402a
AE
4046
4047 return 0;
4048}
4049
4050static int rbd_dev_v2_features(struct rbd_device *rbd_dev)
4051{
4052 return _rbd_dev_v2_snap_features(rbd_dev, CEPH_NOSNAP,
4053 &rbd_dev->header.features);
4054}
4055
86b00e0d
AE
4056static int rbd_dev_v2_parent_info(struct rbd_device *rbd_dev)
4057{
4058 struct rbd_spec *parent_spec;
4059 size_t size;
4060 void *reply_buf = NULL;
4061 __le64 snapid;
4062 void *p;
4063 void *end;
642a2537 4064 u64 pool_id;
86b00e0d 4065 char *image_id;
3b5cf2a2 4066 u64 snap_id;
86b00e0d 4067 u64 overlap;
86b00e0d
AE
4068 int ret;
4069
4070 parent_spec = rbd_spec_alloc();
4071 if (!parent_spec)
4072 return -ENOMEM;
4073
4074 size = sizeof (__le64) + /* pool_id */
4075 sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX + /* image_id */
4076 sizeof (__le64) + /* snap_id */
4077 sizeof (__le64); /* overlap */
4078 reply_buf = kmalloc(size, GFP_KERNEL);
4079 if (!reply_buf) {
4080 ret = -ENOMEM;
4081 goto out_err;
4082 }
4083
4d9b67cd 4084 snapid = cpu_to_le64(rbd_dev->spec->snap_id);
36be9a76 4085 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
86b00e0d 4086 "rbd", "get_parent",
4157976b 4087 &snapid, sizeof (snapid),
e2a58ee5 4088 reply_buf, size);
36be9a76 4089 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
86b00e0d
AE
4090 if (ret < 0)
4091 goto out_err;
4092
86b00e0d 4093 p = reply_buf;
57385b51
AE
4094 end = reply_buf + ret;
4095 ret = -ERANGE;
642a2537 4096 ceph_decode_64_safe(&p, end, pool_id, out_err);
392a9dad
AE
4097 if (pool_id == CEPH_NOPOOL) {
4098 /*
4099 * Either the parent never existed, or we have
4100 * record of it but the image got flattened so it no
4101 * longer has a parent. When the parent of a
4102 * layered image disappears we immediately set the
4103 * overlap to 0. The effect of this is that all new
4104 * requests will be treated as if the image had no
4105 * parent.
4106 */
4107 if (rbd_dev->parent_overlap) {
4108 rbd_dev->parent_overlap = 0;
4109 smp_mb();
4110 rbd_dev_parent_put(rbd_dev);
4111 pr_info("%s: clone image has been flattened\n",
4112 rbd_dev->disk->disk_name);
4113 }
4114
86b00e0d 4115 goto out; /* No parent? No problem. */
392a9dad 4116 }
86b00e0d 4117
0903e875
AE
4118 /* The ceph file layout needs to fit pool id in 32 bits */
4119
4120 ret = -EIO;
642a2537 4121 if (pool_id > (u64)U32_MAX) {
9584d508 4122 rbd_warn(NULL, "parent pool id too large (%llu > %u)",
642a2537 4123 (unsigned long long)pool_id, U32_MAX);
57385b51 4124 goto out_err;
c0cd10db 4125 }
0903e875 4126
979ed480 4127 image_id = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
86b00e0d
AE
4128 if (IS_ERR(image_id)) {
4129 ret = PTR_ERR(image_id);
4130 goto out_err;
4131 }
3b5cf2a2 4132 ceph_decode_64_safe(&p, end, snap_id, out_err);
86b00e0d
AE
4133 ceph_decode_64_safe(&p, end, overlap, out_err);
4134
3b5cf2a2
AE
4135 /*
4136 * The parent won't change (except when the clone is
4137 * flattened, already handled that). So we only need to
4138 * record the parent spec we have not already done so.
4139 */
4140 if (!rbd_dev->parent_spec) {
4141 parent_spec->pool_id = pool_id;
4142 parent_spec->image_id = image_id;
4143 parent_spec->snap_id = snap_id;
70cf49cf
AE
4144 rbd_dev->parent_spec = parent_spec;
4145 parent_spec = NULL; /* rbd_dev now owns this */
fbba11b3
ID
4146 } else {
4147 kfree(image_id);
3b5cf2a2
AE
4148 }
4149
4150 /*
4151 * We always update the parent overlap. If it's zero we
4152 * treat it specially.
4153 */
4154 rbd_dev->parent_overlap = overlap;
4155 smp_mb();
4156 if (!overlap) {
4157
4158 /* A null parent_spec indicates it's the initial probe */
4159
4160 if (parent_spec) {
4161 /*
4162 * The overlap has become zero, so the clone
4163 * must have been resized down to 0 at some
4164 * point. Treat this the same as a flatten.
4165 */
4166 rbd_dev_parent_put(rbd_dev);
4167 pr_info("%s: clone image now standalone\n",
4168 rbd_dev->disk->disk_name);
4169 } else {
4170 /*
4171 * For the initial probe, if we find the
4172 * overlap is zero we just pretend there was
4173 * no parent image.
4174 */
9584d508 4175 rbd_warn(rbd_dev, "ignoring parent with overlap 0");
3b5cf2a2 4176 }
70cf49cf 4177 }
86b00e0d
AE
4178out:
4179 ret = 0;
4180out_err:
4181 kfree(reply_buf);
4182 rbd_spec_put(parent_spec);
4183
4184 return ret;
4185}
4186
cc070d59
AE
4187static int rbd_dev_v2_striping_info(struct rbd_device *rbd_dev)
4188{
4189 struct {
4190 __le64 stripe_unit;
4191 __le64 stripe_count;
4192 } __attribute__ ((packed)) striping_info_buf = { 0 };
4193 size_t size = sizeof (striping_info_buf);
4194 void *p;
4195 u64 obj_size;
4196 u64 stripe_unit;
4197 u64 stripe_count;
4198 int ret;
4199
4200 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
4201 "rbd", "get_stripe_unit_count", NULL, 0,
e2a58ee5 4202 (char *)&striping_info_buf, size);
cc070d59
AE
4203 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
4204 if (ret < 0)
4205 return ret;
4206 if (ret < size)
4207 return -ERANGE;
4208
4209 /*
4210 * We don't actually support the "fancy striping" feature
4211 * (STRIPINGV2) yet, but if the striping sizes are the
4212 * defaults the behavior is the same as before. So find
4213 * out, and only fail if the image has non-default values.
4214 */
4215 ret = -EINVAL;
4216 obj_size = (u64)1 << rbd_dev->header.obj_order;
4217 p = &striping_info_buf;
4218 stripe_unit = ceph_decode_64(&p);
4219 if (stripe_unit != obj_size) {
4220 rbd_warn(rbd_dev, "unsupported stripe unit "
4221 "(got %llu want %llu)",
4222 stripe_unit, obj_size);
4223 return -EINVAL;
4224 }
4225 stripe_count = ceph_decode_64(&p);
4226 if (stripe_count != 1) {
4227 rbd_warn(rbd_dev, "unsupported stripe count "
4228 "(got %llu want 1)", stripe_count);
4229 return -EINVAL;
4230 }
500d0c0f
AE
4231 rbd_dev->header.stripe_unit = stripe_unit;
4232 rbd_dev->header.stripe_count = stripe_count;
cc070d59
AE
4233
4234 return 0;
4235}
4236
9e15b77d
AE
4237static char *rbd_dev_image_name(struct rbd_device *rbd_dev)
4238{
4239 size_t image_id_size;
4240 char *image_id;
4241 void *p;
4242 void *end;
4243 size_t size;
4244 void *reply_buf = NULL;
4245 size_t len = 0;
4246 char *image_name = NULL;
4247 int ret;
4248
4249 rbd_assert(!rbd_dev->spec->image_name);
4250
69e7a02f
AE
4251 len = strlen(rbd_dev->spec->image_id);
4252 image_id_size = sizeof (__le32) + len;
9e15b77d
AE
4253 image_id = kmalloc(image_id_size, GFP_KERNEL);
4254 if (!image_id)
4255 return NULL;
4256
4257 p = image_id;
4157976b 4258 end = image_id + image_id_size;
57385b51 4259 ceph_encode_string(&p, end, rbd_dev->spec->image_id, (u32)len);
9e15b77d
AE
4260
4261 size = sizeof (__le32) + RBD_IMAGE_NAME_LEN_MAX;
4262 reply_buf = kmalloc(size, GFP_KERNEL);
4263 if (!reply_buf)
4264 goto out;
4265
36be9a76 4266 ret = rbd_obj_method_sync(rbd_dev, RBD_DIRECTORY,
9e15b77d
AE
4267 "rbd", "dir_get_name",
4268 image_id, image_id_size,
e2a58ee5 4269 reply_buf, size);
9e15b77d
AE
4270 if (ret < 0)
4271 goto out;
4272 p = reply_buf;
f40eb349
AE
4273 end = reply_buf + ret;
4274
9e15b77d
AE
4275 image_name = ceph_extract_encoded_string(&p, end, &len, GFP_KERNEL);
4276 if (IS_ERR(image_name))
4277 image_name = NULL;
4278 else
4279 dout("%s: name is %s len is %zd\n", __func__, image_name, len);
4280out:
4281 kfree(reply_buf);
4282 kfree(image_id);
4283
4284 return image_name;
4285}
4286
2ad3d716
AE
4287static u64 rbd_v1_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
4288{
4289 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
4290 const char *snap_name;
4291 u32 which = 0;
4292
4293 /* Skip over names until we find the one we are looking for */
4294
4295 snap_name = rbd_dev->header.snap_names;
4296 while (which < snapc->num_snaps) {
4297 if (!strcmp(name, snap_name))
4298 return snapc->snaps[which];
4299 snap_name += strlen(snap_name) + 1;
4300 which++;
4301 }
4302 return CEPH_NOSNAP;
4303}
4304
4305static u64 rbd_v2_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
4306{
4307 struct ceph_snap_context *snapc = rbd_dev->header.snapc;
4308 u32 which;
4309 bool found = false;
4310 u64 snap_id;
4311
4312 for (which = 0; !found && which < snapc->num_snaps; which++) {
4313 const char *snap_name;
4314
4315 snap_id = snapc->snaps[which];
4316 snap_name = rbd_dev_v2_snap_name(rbd_dev, snap_id);
efadc98a
JD
4317 if (IS_ERR(snap_name)) {
4318 /* ignore no-longer existing snapshots */
4319 if (PTR_ERR(snap_name) == -ENOENT)
4320 continue;
4321 else
4322 break;
4323 }
2ad3d716
AE
4324 found = !strcmp(name, snap_name);
4325 kfree(snap_name);
4326 }
4327 return found ? snap_id : CEPH_NOSNAP;
4328}
4329
4330/*
4331 * Assumes name is never RBD_SNAP_HEAD_NAME; returns CEPH_NOSNAP if
4332 * no snapshot by that name is found, or if an error occurs.
4333 */
4334static u64 rbd_snap_id_by_name(struct rbd_device *rbd_dev, const char *name)
4335{
4336 if (rbd_dev->image_format == 1)
4337 return rbd_v1_snap_id_by_name(rbd_dev, name);
4338
4339 return rbd_v2_snap_id_by_name(rbd_dev, name);
4340}
4341
9e15b77d 4342/*
04077599
ID
4343 * An image being mapped will have everything but the snap id.
4344 */
4345static int rbd_spec_fill_snap_id(struct rbd_device *rbd_dev)
4346{
4347 struct rbd_spec *spec = rbd_dev->spec;
4348
4349 rbd_assert(spec->pool_id != CEPH_NOPOOL && spec->pool_name);
4350 rbd_assert(spec->image_id && spec->image_name);
4351 rbd_assert(spec->snap_name);
4352
4353 if (strcmp(spec->snap_name, RBD_SNAP_HEAD_NAME)) {
4354 u64 snap_id;
4355
4356 snap_id = rbd_snap_id_by_name(rbd_dev, spec->snap_name);
4357 if (snap_id == CEPH_NOSNAP)
4358 return -ENOENT;
4359
4360 spec->snap_id = snap_id;
4361 } else {
4362 spec->snap_id = CEPH_NOSNAP;
4363 }
4364
4365 return 0;
4366}
4367
4368/*
4369 * A parent image will have all ids but none of the names.
e1d4213f 4370 *
04077599
ID
4371 * All names in an rbd spec are dynamically allocated. It's OK if we
4372 * can't figure out the name for an image id.
9e15b77d 4373 */
04077599 4374static int rbd_spec_fill_names(struct rbd_device *rbd_dev)
9e15b77d 4375{
2e9f7f1c
AE
4376 struct ceph_osd_client *osdc = &rbd_dev->rbd_client->client->osdc;
4377 struct rbd_spec *spec = rbd_dev->spec;
4378 const char *pool_name;
4379 const char *image_name;
4380 const char *snap_name;
9e15b77d
AE
4381 int ret;
4382
04077599
ID
4383 rbd_assert(spec->pool_id != CEPH_NOPOOL);
4384 rbd_assert(spec->image_id);
4385 rbd_assert(spec->snap_id != CEPH_NOSNAP);
9e15b77d 4386
2e9f7f1c 4387 /* Get the pool name; we have to make our own copy of this */
9e15b77d 4388
2e9f7f1c
AE
4389 pool_name = ceph_pg_pool_name_by_id(osdc->osdmap, spec->pool_id);
4390 if (!pool_name) {
4391 rbd_warn(rbd_dev, "no pool with id %llu", spec->pool_id);
935dc89f
AE
4392 return -EIO;
4393 }
2e9f7f1c
AE
4394 pool_name = kstrdup(pool_name, GFP_KERNEL);
4395 if (!pool_name)
9e15b77d
AE
4396 return -ENOMEM;
4397
4398 /* Fetch the image name; tolerate failure here */
4399
2e9f7f1c
AE
4400 image_name = rbd_dev_image_name(rbd_dev);
4401 if (!image_name)
06ecc6cb 4402 rbd_warn(rbd_dev, "unable to get image name");
9e15b77d 4403
04077599 4404 /* Fetch the snapshot name */
9e15b77d 4405
2e9f7f1c 4406 snap_name = rbd_snap_name(rbd_dev, spec->snap_id);
da6a6b63
JD
4407 if (IS_ERR(snap_name)) {
4408 ret = PTR_ERR(snap_name);
9e15b77d 4409 goto out_err;
2e9f7f1c
AE
4410 }
4411
4412 spec->pool_name = pool_name;
4413 spec->image_name = image_name;
4414 spec->snap_name = snap_name;
9e15b77d
AE
4415
4416 return 0;
04077599 4417
9e15b77d 4418out_err:
2e9f7f1c
AE
4419 kfree(image_name);
4420 kfree(pool_name);
9e15b77d
AE
4421 return ret;
4422}
4423
cc4a38bd 4424static int rbd_dev_v2_snap_context(struct rbd_device *rbd_dev)
35d489f9
AE
4425{
4426 size_t size;
4427 int ret;
4428 void *reply_buf;
4429 void *p;
4430 void *end;
4431 u64 seq;
4432 u32 snap_count;
4433 struct ceph_snap_context *snapc;
4434 u32 i;
4435
4436 /*
4437 * We'll need room for the seq value (maximum snapshot id),
4438 * snapshot count, and array of that many snapshot ids.
4439 * For now we have a fixed upper limit on the number we're
4440 * prepared to receive.
4441 */
4442 size = sizeof (__le64) + sizeof (__le32) +
4443 RBD_MAX_SNAP_COUNT * sizeof (__le64);
4444 reply_buf = kzalloc(size, GFP_KERNEL);
4445 if (!reply_buf)
4446 return -ENOMEM;
4447
36be9a76 4448 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
4157976b 4449 "rbd", "get_snapcontext", NULL, 0,
e2a58ee5 4450 reply_buf, size);
36be9a76 4451 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
35d489f9
AE
4452 if (ret < 0)
4453 goto out;
4454
35d489f9 4455 p = reply_buf;
57385b51
AE
4456 end = reply_buf + ret;
4457 ret = -ERANGE;
35d489f9
AE
4458 ceph_decode_64_safe(&p, end, seq, out);
4459 ceph_decode_32_safe(&p, end, snap_count, out);
4460
4461 /*
4462 * Make sure the reported number of snapshot ids wouldn't go
4463 * beyond the end of our buffer. But before checking that,
4464 * make sure the computed size of the snapshot context we
4465 * allocate is representable in a size_t.
4466 */
4467 if (snap_count > (SIZE_MAX - sizeof (struct ceph_snap_context))
4468 / sizeof (u64)) {
4469 ret = -EINVAL;
4470 goto out;
4471 }
4472 if (!ceph_has_room(&p, end, snap_count * sizeof (__le64)))
4473 goto out;
468521c1 4474 ret = 0;
35d489f9 4475
812164f8 4476 snapc = ceph_create_snap_context(snap_count, GFP_KERNEL);
35d489f9
AE
4477 if (!snapc) {
4478 ret = -ENOMEM;
4479 goto out;
4480 }
35d489f9 4481 snapc->seq = seq;
35d489f9
AE
4482 for (i = 0; i < snap_count; i++)
4483 snapc->snaps[i] = ceph_decode_64(&p);
4484
49ece554 4485 ceph_put_snap_context(rbd_dev->header.snapc);
35d489f9
AE
4486 rbd_dev->header.snapc = snapc;
4487
4488 dout(" snap context seq = %llu, snap_count = %u\n",
57385b51 4489 (unsigned long long)seq, (unsigned int)snap_count);
35d489f9
AE
4490out:
4491 kfree(reply_buf);
4492
57385b51 4493 return ret;
35d489f9
AE
4494}
4495
54cac61f
AE
4496static const char *rbd_dev_v2_snap_name(struct rbd_device *rbd_dev,
4497 u64 snap_id)
b8b1e2db
AE
4498{
4499 size_t size;
4500 void *reply_buf;
54cac61f 4501 __le64 snapid;
b8b1e2db
AE
4502 int ret;
4503 void *p;
4504 void *end;
b8b1e2db
AE
4505 char *snap_name;
4506
4507 size = sizeof (__le32) + RBD_MAX_SNAP_NAME_LEN;
4508 reply_buf = kmalloc(size, GFP_KERNEL);
4509 if (!reply_buf)
4510 return ERR_PTR(-ENOMEM);
4511
54cac61f 4512 snapid = cpu_to_le64(snap_id);
36be9a76 4513 ret = rbd_obj_method_sync(rbd_dev, rbd_dev->header_name,
b8b1e2db 4514 "rbd", "get_snapshot_name",
54cac61f 4515 &snapid, sizeof (snapid),
e2a58ee5 4516 reply_buf, size);
36be9a76 4517 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
f40eb349
AE
4518 if (ret < 0) {
4519 snap_name = ERR_PTR(ret);
b8b1e2db 4520 goto out;
f40eb349 4521 }
b8b1e2db
AE
4522
4523 p = reply_buf;
f40eb349 4524 end = reply_buf + ret;
e5c35534 4525 snap_name = ceph_extract_encoded_string(&p, end, NULL, GFP_KERNEL);
f40eb349 4526 if (IS_ERR(snap_name))
b8b1e2db 4527 goto out;
b8b1e2db 4528
f40eb349 4529 dout(" snap_id 0x%016llx snap_name = %s\n",
54cac61f 4530 (unsigned long long)snap_id, snap_name);
b8b1e2db
AE
4531out:
4532 kfree(reply_buf);
4533
f40eb349 4534 return snap_name;
b8b1e2db
AE
4535}
4536
2df3fac7 4537static int rbd_dev_v2_header_info(struct rbd_device *rbd_dev)
117973fb 4538{
2df3fac7 4539 bool first_time = rbd_dev->header.object_prefix == NULL;
117973fb 4540 int ret;
117973fb 4541
1617e40c
JD
4542 ret = rbd_dev_v2_image_size(rbd_dev);
4543 if (ret)
cfbf6377 4544 return ret;
1617e40c 4545
2df3fac7
AE
4546 if (first_time) {
4547 ret = rbd_dev_v2_header_onetime(rbd_dev);
4548 if (ret)
cfbf6377 4549 return ret;
2df3fac7
AE
4550 }
4551
cc4a38bd 4552 ret = rbd_dev_v2_snap_context(rbd_dev);
117973fb 4553 dout("rbd_dev_v2_snap_context returned %d\n", ret);
117973fb
AE
4554
4555 return ret;
4556}
4557
a720ae09
ID
4558static int rbd_dev_header_info(struct rbd_device *rbd_dev)
4559{
4560 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
4561
4562 if (rbd_dev->image_format == 1)
4563 return rbd_dev_v1_header_info(rbd_dev);
4564
4565 return rbd_dev_v2_header_info(rbd_dev);
4566}
4567
dfc5606d
YS
4568static int rbd_bus_add_dev(struct rbd_device *rbd_dev)
4569{
dfc5606d 4570 struct device *dev;
cd789ab9 4571 int ret;
dfc5606d 4572
cd789ab9 4573 dev = &rbd_dev->dev;
dfc5606d
YS
4574 dev->bus = &rbd_bus_type;
4575 dev->type = &rbd_device_type;
4576 dev->parent = &rbd_root_dev;
200a6a8b 4577 dev->release = rbd_dev_device_release;
de71a297 4578 dev_set_name(dev, "%d", rbd_dev->dev_id);
dfc5606d 4579 ret = device_register(dev);
dfc5606d 4580
dfc5606d 4581 return ret;
602adf40
YS
4582}
4583
dfc5606d
YS
4584static void rbd_bus_del_dev(struct rbd_device *rbd_dev)
4585{
4586 device_unregister(&rbd_dev->dev);
4587}
4588
1ddbe94e 4589/*
499afd5b 4590 * Get a unique rbd identifier for the given new rbd_dev, and add
f8a22fc2 4591 * the rbd_dev to the global list.
1ddbe94e 4592 */
f8a22fc2 4593static int rbd_dev_id_get(struct rbd_device *rbd_dev)
b7f23c36 4594{
f8a22fc2
ID
4595 int new_dev_id;
4596
9b60e70b
ID
4597 new_dev_id = ida_simple_get(&rbd_dev_id_ida,
4598 0, minor_to_rbd_dev_id(1 << MINORBITS),
4599 GFP_KERNEL);
f8a22fc2
ID
4600 if (new_dev_id < 0)
4601 return new_dev_id;
4602
4603 rbd_dev->dev_id = new_dev_id;
499afd5b
AE
4604
4605 spin_lock(&rbd_dev_list_lock);
4606 list_add_tail(&rbd_dev->node, &rbd_dev_list);
4607 spin_unlock(&rbd_dev_list_lock);
f8a22fc2 4608
70eebd20 4609 dout("rbd_dev %p given dev id %d\n", rbd_dev, rbd_dev->dev_id);
f8a22fc2
ID
4610
4611 return 0;
1ddbe94e 4612}
b7f23c36 4613
1ddbe94e 4614/*
499afd5b
AE
4615 * Remove an rbd_dev from the global list, and record that its
4616 * identifier is no longer in use.
1ddbe94e 4617 */
e2839308 4618static void rbd_dev_id_put(struct rbd_device *rbd_dev)
1ddbe94e 4619{
499afd5b
AE
4620 spin_lock(&rbd_dev_list_lock);
4621 list_del_init(&rbd_dev->node);
4622 spin_unlock(&rbd_dev_list_lock);
b7f23c36 4623
f8a22fc2
ID
4624 ida_simple_remove(&rbd_dev_id_ida, rbd_dev->dev_id);
4625
4626 dout("rbd_dev %p released dev id %d\n", rbd_dev, rbd_dev->dev_id);
b7f23c36
AE
4627}
4628
e28fff26
AE
4629/*
4630 * Skips over white space at *buf, and updates *buf to point to the
4631 * first found non-space character (if any). Returns the length of
593a9e7b
AE
4632 * the token (string of non-white space characters) found. Note
4633 * that *buf must be terminated with '\0'.
e28fff26
AE
4634 */
4635static inline size_t next_token(const char **buf)
4636{
4637 /*
4638 * These are the characters that produce nonzero for
4639 * isspace() in the "C" and "POSIX" locales.
4640 */
4641 const char *spaces = " \f\n\r\t\v";
4642
4643 *buf += strspn(*buf, spaces); /* Find start of token */
4644
4645 return strcspn(*buf, spaces); /* Return token length */
4646}
4647
4648/*
4649 * Finds the next token in *buf, and if the provided token buffer is
4650 * big enough, copies the found token into it. The result, if
593a9e7b
AE
4651 * copied, is guaranteed to be terminated with '\0'. Note that *buf
4652 * must be terminated with '\0' on entry.
e28fff26
AE
4653 *
4654 * Returns the length of the token found (not including the '\0').
4655 * Return value will be 0 if no token is found, and it will be >=
4656 * token_size if the token would not fit.
4657 *
593a9e7b 4658 * The *buf pointer will be updated to point beyond the end of the
e28fff26
AE
4659 * found token. Note that this occurs even if the token buffer is
4660 * too small to hold it.
4661 */
4662static inline size_t copy_token(const char **buf,
4663 char *token,
4664 size_t token_size)
4665{
4666 size_t len;
4667
4668 len = next_token(buf);
4669 if (len < token_size) {
4670 memcpy(token, *buf, len);
4671 *(token + len) = '\0';
4672 }
4673 *buf += len;
4674
4675 return len;
4676}
4677
ea3352f4
AE
4678/*
4679 * Finds the next token in *buf, dynamically allocates a buffer big
4680 * enough to hold a copy of it, and copies the token into the new
4681 * buffer. The copy is guaranteed to be terminated with '\0'. Note
4682 * that a duplicate buffer is created even for a zero-length token.
4683 *
4684 * Returns a pointer to the newly-allocated duplicate, or a null
4685 * pointer if memory for the duplicate was not available. If
4686 * the lenp argument is a non-null pointer, the length of the token
4687 * (not including the '\0') is returned in *lenp.
4688 *
4689 * If successful, the *buf pointer will be updated to point beyond
4690 * the end of the found token.
4691 *
4692 * Note: uses GFP_KERNEL for allocation.
4693 */
4694static inline char *dup_token(const char **buf, size_t *lenp)
4695{
4696 char *dup;
4697 size_t len;
4698
4699 len = next_token(buf);
4caf35f9 4700 dup = kmemdup(*buf, len + 1, GFP_KERNEL);
ea3352f4
AE
4701 if (!dup)
4702 return NULL;
ea3352f4
AE
4703 *(dup + len) = '\0';
4704 *buf += len;
4705
4706 if (lenp)
4707 *lenp = len;
4708
4709 return dup;
4710}
4711
a725f65e 4712/*
859c31df
AE
4713 * Parse the options provided for an "rbd add" (i.e., rbd image
4714 * mapping) request. These arrive via a write to /sys/bus/rbd/add,
4715 * and the data written is passed here via a NUL-terminated buffer.
4716 * Returns 0 if successful or an error code otherwise.
d22f76e7 4717 *
859c31df
AE
4718 * The information extracted from these options is recorded in
4719 * the other parameters which return dynamically-allocated
4720 * structures:
4721 * ceph_opts
4722 * The address of a pointer that will refer to a ceph options
4723 * structure. Caller must release the returned pointer using
4724 * ceph_destroy_options() when it is no longer needed.
4725 * rbd_opts
4726 * Address of an rbd options pointer. Fully initialized by
4727 * this function; caller must release with kfree().
4728 * spec
4729 * Address of an rbd image specification pointer. Fully
4730 * initialized by this function based on parsed options.
4731 * Caller must release with rbd_spec_put().
4732 *
4733 * The options passed take this form:
4734 * <mon_addrs> <options> <pool_name> <image_name> [<snap_id>]
4735 * where:
4736 * <mon_addrs>
4737 * A comma-separated list of one or more monitor addresses.
4738 * A monitor address is an ip address, optionally followed
4739 * by a port number (separated by a colon).
4740 * I.e.: ip1[:port1][,ip2[:port2]...]
4741 * <options>
4742 * A comma-separated list of ceph and/or rbd options.
4743 * <pool_name>
4744 * The name of the rados pool containing the rbd image.
4745 * <image_name>
4746 * The name of the image in that pool to map.
4747 * <snap_id>
4748 * An optional snapshot id. If provided, the mapping will
4749 * present data from the image at the time that snapshot was
4750 * created. The image head is used if no snapshot id is
4751 * provided. Snapshot mappings are always read-only.
a725f65e 4752 */
859c31df 4753static int rbd_add_parse_args(const char *buf,
dc79b113 4754 struct ceph_options **ceph_opts,
859c31df
AE
4755 struct rbd_options **opts,
4756 struct rbd_spec **rbd_spec)
e28fff26 4757{
d22f76e7 4758 size_t len;
859c31df 4759 char *options;
0ddebc0c 4760 const char *mon_addrs;
ecb4dc22 4761 char *snap_name;
0ddebc0c 4762 size_t mon_addrs_size;
859c31df 4763 struct rbd_spec *spec = NULL;
4e9afeba 4764 struct rbd_options *rbd_opts = NULL;
859c31df 4765 struct ceph_options *copts;
dc79b113 4766 int ret;
e28fff26
AE
4767
4768 /* The first four tokens are required */
4769
7ef3214a 4770 len = next_token(&buf);
4fb5d671
AE
4771 if (!len) {
4772 rbd_warn(NULL, "no monitor address(es) provided");
4773 return -EINVAL;
4774 }
0ddebc0c 4775 mon_addrs = buf;
f28e565a 4776 mon_addrs_size = len + 1;
7ef3214a 4777 buf += len;
a725f65e 4778
dc79b113 4779 ret = -EINVAL;
f28e565a
AE
4780 options = dup_token(&buf, NULL);
4781 if (!options)
dc79b113 4782 return -ENOMEM;
4fb5d671
AE
4783 if (!*options) {
4784 rbd_warn(NULL, "no options provided");
4785 goto out_err;
4786 }
e28fff26 4787
859c31df
AE
4788 spec = rbd_spec_alloc();
4789 if (!spec)
f28e565a 4790 goto out_mem;
859c31df
AE
4791
4792 spec->pool_name = dup_token(&buf, NULL);
4793 if (!spec->pool_name)
4794 goto out_mem;
4fb5d671
AE
4795 if (!*spec->pool_name) {
4796 rbd_warn(NULL, "no pool name provided");
4797 goto out_err;
4798 }
e28fff26 4799
69e7a02f 4800 spec->image_name = dup_token(&buf, NULL);
859c31df 4801 if (!spec->image_name)
f28e565a 4802 goto out_mem;
4fb5d671
AE
4803 if (!*spec->image_name) {
4804 rbd_warn(NULL, "no image name provided");
4805 goto out_err;
4806 }
d4b125e9 4807
f28e565a
AE
4808 /*
4809 * Snapshot name is optional; default is to use "-"
4810 * (indicating the head/no snapshot).
4811 */
3feeb894 4812 len = next_token(&buf);
820a5f3e 4813 if (!len) {
3feeb894
AE
4814 buf = RBD_SNAP_HEAD_NAME; /* No snapshot supplied */
4815 len = sizeof (RBD_SNAP_HEAD_NAME) - 1;
f28e565a 4816 } else if (len > RBD_MAX_SNAP_NAME_LEN) {
dc79b113 4817 ret = -ENAMETOOLONG;
f28e565a 4818 goto out_err;
849b4260 4819 }
ecb4dc22
AE
4820 snap_name = kmemdup(buf, len + 1, GFP_KERNEL);
4821 if (!snap_name)
f28e565a 4822 goto out_mem;
ecb4dc22
AE
4823 *(snap_name + len) = '\0';
4824 spec->snap_name = snap_name;
e5c35534 4825
0ddebc0c 4826 /* Initialize all rbd options to the defaults */
e28fff26 4827
4e9afeba
AE
4828 rbd_opts = kzalloc(sizeof (*rbd_opts), GFP_KERNEL);
4829 if (!rbd_opts)
4830 goto out_mem;
4831
4832 rbd_opts->read_only = RBD_READ_ONLY_DEFAULT;
d22f76e7 4833
859c31df 4834 copts = ceph_parse_options(options, mon_addrs,
0ddebc0c 4835 mon_addrs + mon_addrs_size - 1,
4e9afeba 4836 parse_rbd_opts_token, rbd_opts);
859c31df
AE
4837 if (IS_ERR(copts)) {
4838 ret = PTR_ERR(copts);
dc79b113
AE
4839 goto out_err;
4840 }
859c31df
AE
4841 kfree(options);
4842
4843 *ceph_opts = copts;
4e9afeba 4844 *opts = rbd_opts;
859c31df 4845 *rbd_spec = spec;
0ddebc0c 4846
dc79b113 4847 return 0;
f28e565a 4848out_mem:
dc79b113 4849 ret = -ENOMEM;
d22f76e7 4850out_err:
859c31df
AE
4851 kfree(rbd_opts);
4852 rbd_spec_put(spec);
f28e565a 4853 kfree(options);
d22f76e7 4854
dc79b113 4855 return ret;
a725f65e
AE
4856}
4857
30ba1f02
ID
4858/*
4859 * Return pool id (>= 0) or a negative error code.
4860 */
4861static int rbd_add_get_pool_id(struct rbd_client *rbdc, const char *pool_name)
4862{
4863 u64 newest_epoch;
4864 unsigned long timeout = rbdc->client->options->mount_timeout * HZ;
4865 int tries = 0;
4866 int ret;
4867
4868again:
4869 ret = ceph_pg_poolid_by_name(rbdc->client->osdc.osdmap, pool_name);
4870 if (ret == -ENOENT && tries++ < 1) {
4871 ret = ceph_monc_do_get_version(&rbdc->client->monc, "osdmap",
4872 &newest_epoch);
4873 if (ret < 0)
4874 return ret;
4875
4876 if (rbdc->client->osdc.osdmap->epoch < newest_epoch) {
4877 ceph_monc_request_next_osdmap(&rbdc->client->monc);
4878 (void) ceph_monc_wait_osdmap(&rbdc->client->monc,
4879 newest_epoch, timeout);
4880 goto again;
4881 } else {
4882 /* the osdmap we have is new enough */
4883 return -ENOENT;
4884 }
4885 }
4886
4887 return ret;
4888}
4889
589d30e0
AE
4890/*
4891 * An rbd format 2 image has a unique identifier, distinct from the
4892 * name given to it by the user. Internally, that identifier is
4893 * what's used to specify the names of objects related to the image.
4894 *
4895 * A special "rbd id" object is used to map an rbd image name to its
4896 * id. If that object doesn't exist, then there is no v2 rbd image
4897 * with the supplied name.
4898 *
4899 * This function will record the given rbd_dev's image_id field if
4900 * it can be determined, and in that case will return 0. If any
4901 * errors occur a negative errno will be returned and the rbd_dev's
4902 * image_id field will be unchanged (and should be NULL).
4903 */
4904static int rbd_dev_image_id(struct rbd_device *rbd_dev)
4905{
4906 int ret;
4907 size_t size;
4908 char *object_name;
4909 void *response;
c0fba368 4910 char *image_id;
2f82ee54 4911
2c0d0a10
AE
4912 /*
4913 * When probing a parent image, the image id is already
4914 * known (and the image name likely is not). There's no
c0fba368
AE
4915 * need to fetch the image id again in this case. We
4916 * do still need to set the image format though.
2c0d0a10 4917 */
c0fba368
AE
4918 if (rbd_dev->spec->image_id) {
4919 rbd_dev->image_format = *rbd_dev->spec->image_id ? 2 : 1;
4920
2c0d0a10 4921 return 0;
c0fba368 4922 }
2c0d0a10 4923
589d30e0
AE
4924 /*
4925 * First, see if the format 2 image id file exists, and if
4926 * so, get the image's persistent id from it.
4927 */
69e7a02f 4928 size = sizeof (RBD_ID_PREFIX) + strlen(rbd_dev->spec->image_name);
589d30e0
AE
4929 object_name = kmalloc(size, GFP_NOIO);
4930 if (!object_name)
4931 return -ENOMEM;
0d7dbfce 4932 sprintf(object_name, "%s%s", RBD_ID_PREFIX, rbd_dev->spec->image_name);
589d30e0
AE
4933 dout("rbd id object name is %s\n", object_name);
4934
4935 /* Response will be an encoded string, which includes a length */
4936
4937 size = sizeof (__le32) + RBD_IMAGE_ID_LEN_MAX;
4938 response = kzalloc(size, GFP_NOIO);
4939 if (!response) {
4940 ret = -ENOMEM;
4941 goto out;
4942 }
4943
c0fba368
AE
4944 /* If it doesn't exist we'll assume it's a format 1 image */
4945
36be9a76 4946 ret = rbd_obj_method_sync(rbd_dev, object_name,
4157976b 4947 "rbd", "get_id", NULL, 0,
e2a58ee5 4948 response, RBD_IMAGE_ID_LEN_MAX);
36be9a76 4949 dout("%s: rbd_obj_method_sync returned %d\n", __func__, ret);
c0fba368
AE
4950 if (ret == -ENOENT) {
4951 image_id = kstrdup("", GFP_KERNEL);
4952 ret = image_id ? 0 : -ENOMEM;
4953 if (!ret)
4954 rbd_dev->image_format = 1;
7dd440c9 4955 } else if (ret >= 0) {
c0fba368
AE
4956 void *p = response;
4957
4958 image_id = ceph_extract_encoded_string(&p, p + ret,
979ed480 4959 NULL, GFP_NOIO);
461f758a 4960 ret = PTR_ERR_OR_ZERO(image_id);
c0fba368
AE
4961 if (!ret)
4962 rbd_dev->image_format = 2;
c0fba368
AE
4963 }
4964
4965 if (!ret) {
4966 rbd_dev->spec->image_id = image_id;
4967 dout("image_id is %s\n", image_id);
589d30e0
AE
4968 }
4969out:
4970 kfree(response);
4971 kfree(object_name);
4972
4973 return ret;
4974}
4975
3abef3b3
AE
4976/*
4977 * Undo whatever state changes are made by v1 or v2 header info
4978 * call.
4979 */
6fd48b3b
AE
4980static void rbd_dev_unprobe(struct rbd_device *rbd_dev)
4981{
4982 struct rbd_image_header *header;
4983
392a9dad
AE
4984 /* Drop parent reference unless it's already been done (or none) */
4985
4986 if (rbd_dev->parent_overlap)
4987 rbd_dev_parent_put(rbd_dev);
6fd48b3b
AE
4988
4989 /* Free dynamic fields from the header, then zero it out */
4990
4991 header = &rbd_dev->header;
812164f8 4992 ceph_put_snap_context(header->snapc);
6fd48b3b
AE
4993 kfree(header->snap_sizes);
4994 kfree(header->snap_names);
4995 kfree(header->object_prefix);
4996 memset(header, 0, sizeof (*header));
4997}
4998
2df3fac7 4999static int rbd_dev_v2_header_onetime(struct rbd_device *rbd_dev)
a30b71b9
AE
5000{
5001 int ret;
a30b71b9 5002
1e130199 5003 ret = rbd_dev_v2_object_prefix(rbd_dev);
57385b51 5004 if (ret)
b1b5402a
AE
5005 goto out_err;
5006
2df3fac7
AE
5007 /*
5008 * Get the and check features for the image. Currently the
5009 * features are assumed to never change.
5010 */
b1b5402a 5011 ret = rbd_dev_v2_features(rbd_dev);
57385b51 5012 if (ret)
9d475de5 5013 goto out_err;
35d489f9 5014
cc070d59
AE
5015 /* If the image supports fancy striping, get its parameters */
5016
5017 if (rbd_dev->header.features & RBD_FEATURE_STRIPINGV2) {
5018 ret = rbd_dev_v2_striping_info(rbd_dev);
5019 if (ret < 0)
5020 goto out_err;
5021 }
2df3fac7 5022 /* No support for crypto and compression type format 2 images */
a30b71b9 5023
35152979 5024 return 0;
9d475de5 5025out_err:
642a2537 5026 rbd_dev->header.features = 0;
1e130199
AE
5027 kfree(rbd_dev->header.object_prefix);
5028 rbd_dev->header.object_prefix = NULL;
9d475de5
AE
5029
5030 return ret;
a30b71b9
AE
5031}
5032
124afba2 5033static int rbd_dev_probe_parent(struct rbd_device *rbd_dev)
83a06263 5034{
2f82ee54 5035 struct rbd_device *parent = NULL;
124afba2
AE
5036 struct rbd_spec *parent_spec;
5037 struct rbd_client *rbdc;
5038 int ret;
5039
5040 if (!rbd_dev->parent_spec)
5041 return 0;
5042 /*
5043 * We need to pass a reference to the client and the parent
5044 * spec when creating the parent rbd_dev. Images related by
5045 * parent/child relationships always share both.
5046 */
5047 parent_spec = rbd_spec_get(rbd_dev->parent_spec);
5048 rbdc = __rbd_get_client(rbd_dev->rbd_client);
5049
5050 ret = -ENOMEM;
5051 parent = rbd_dev_create(rbdc, parent_spec);
5052 if (!parent)
5053 goto out_err;
5054
1f3ef788 5055 ret = rbd_dev_image_probe(parent, false);
124afba2
AE
5056 if (ret < 0)
5057 goto out_err;
5058 rbd_dev->parent = parent;
a2acd00e 5059 atomic_set(&rbd_dev->parent_ref, 1);
124afba2
AE
5060
5061 return 0;
5062out_err:
5063 if (parent) {
fb65d228 5064 rbd_dev_unparent(rbd_dev);
124afba2
AE
5065 kfree(rbd_dev->header_name);
5066 rbd_dev_destroy(parent);
5067 } else {
5068 rbd_put_client(rbdc);
5069 rbd_spec_put(parent_spec);
5070 }
5071
5072 return ret;
5073}
5074
200a6a8b 5075static int rbd_dev_device_setup(struct rbd_device *rbd_dev)
124afba2 5076{
83a06263 5077 int ret;
d1cf5788 5078
f8a22fc2
ID
5079 /* Get an id and fill in device name. */
5080
5081 ret = rbd_dev_id_get(rbd_dev);
5082 if (ret)
5083 return ret;
83a06263 5084
83a06263
AE
5085 BUILD_BUG_ON(DEV_NAME_LEN
5086 < sizeof (RBD_DRV_NAME) + MAX_INT_FORMAT_WIDTH);
5087 sprintf(rbd_dev->name, "%s%d", RBD_DRV_NAME, rbd_dev->dev_id);
5088
9b60e70b 5089 /* Record our major and minor device numbers. */
83a06263 5090
9b60e70b
ID
5091 if (!single_major) {
5092 ret = register_blkdev(0, rbd_dev->name);
5093 if (ret < 0)
5094 goto err_out_id;
5095
5096 rbd_dev->major = ret;
5097 rbd_dev->minor = 0;
5098 } else {
5099 rbd_dev->major = rbd_major;
5100 rbd_dev->minor = rbd_dev_id_to_minor(rbd_dev->dev_id);
5101 }
83a06263
AE
5102
5103 /* Set up the blkdev mapping. */
5104
5105 ret = rbd_init_disk(rbd_dev);
5106 if (ret)
5107 goto err_out_blkdev;
5108
f35a4dee 5109 ret = rbd_dev_mapping_set(rbd_dev);
83a06263
AE
5110 if (ret)
5111 goto err_out_disk;
bc1ecc65 5112
f35a4dee 5113 set_capacity(rbd_dev->disk, rbd_dev->mapping.size / SECTOR_SIZE);
22001f61 5114 set_disk_ro(rbd_dev->disk, rbd_dev->mapping.read_only);
f35a4dee 5115
58d1362b 5116 rbd_dev->rq_wq = alloc_workqueue("%s", 0, 0, rbd_dev->disk->disk_name);
255939e7
WY
5117 if (!rbd_dev->rq_wq) {
5118 ret = -ENOMEM;
bc1ecc65 5119 goto err_out_mapping;
255939e7 5120 }
bc1ecc65 5121
f35a4dee
AE
5122 ret = rbd_bus_add_dev(rbd_dev);
5123 if (ret)
bc1ecc65 5124 goto err_out_workqueue;
83a06263 5125
83a06263
AE
5126 /* Everything's ready. Announce the disk to the world. */
5127
129b79d4 5128 set_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
83a06263
AE
5129 add_disk(rbd_dev->disk);
5130
5131 pr_info("%s: added with size 0x%llx\n", rbd_dev->disk->disk_name,
5132 (unsigned long long) rbd_dev->mapping.size);
5133
5134 return ret;
2f82ee54 5135
bc1ecc65
ID
5136err_out_workqueue:
5137 destroy_workqueue(rbd_dev->rq_wq);
5138 rbd_dev->rq_wq = NULL;
f35a4dee
AE
5139err_out_mapping:
5140 rbd_dev_mapping_clear(rbd_dev);
83a06263
AE
5141err_out_disk:
5142 rbd_free_disk(rbd_dev);
5143err_out_blkdev:
9b60e70b
ID
5144 if (!single_major)
5145 unregister_blkdev(rbd_dev->major, rbd_dev->name);
83a06263
AE
5146err_out_id:
5147 rbd_dev_id_put(rbd_dev);
d1cf5788 5148 rbd_dev_mapping_clear(rbd_dev);
83a06263
AE
5149
5150 return ret;
5151}
5152
332bb12d
AE
5153static int rbd_dev_header_name(struct rbd_device *rbd_dev)
5154{
5155 struct rbd_spec *spec = rbd_dev->spec;
5156 size_t size;
5157
5158 /* Record the header object name for this rbd image. */
5159
5160 rbd_assert(rbd_image_format_valid(rbd_dev->image_format));
5161
5162 if (rbd_dev->image_format == 1)
5163 size = strlen(spec->image_name) + sizeof (RBD_SUFFIX);
5164 else
5165 size = sizeof (RBD_HEADER_PREFIX) + strlen(spec->image_id);
5166
5167 rbd_dev->header_name = kmalloc(size, GFP_KERNEL);
5168 if (!rbd_dev->header_name)
5169 return -ENOMEM;
5170
5171 if (rbd_dev->image_format == 1)
5172 sprintf(rbd_dev->header_name, "%s%s",
5173 spec->image_name, RBD_SUFFIX);
5174 else
5175 sprintf(rbd_dev->header_name, "%s%s",
5176 RBD_HEADER_PREFIX, spec->image_id);
5177 return 0;
5178}
5179
200a6a8b
AE
5180static void rbd_dev_image_release(struct rbd_device *rbd_dev)
5181{
6fd48b3b 5182 rbd_dev_unprobe(rbd_dev);
200a6a8b 5183 kfree(rbd_dev->header_name);
6fd48b3b
AE
5184 rbd_dev->header_name = NULL;
5185 rbd_dev->image_format = 0;
5186 kfree(rbd_dev->spec->image_id);
5187 rbd_dev->spec->image_id = NULL;
5188
200a6a8b
AE
5189 rbd_dev_destroy(rbd_dev);
5190}
5191
a30b71b9
AE
5192/*
5193 * Probe for the existence of the header object for the given rbd
1f3ef788
AE
5194 * device. If this image is the one being mapped (i.e., not a
5195 * parent), initiate a watch on its header object before using that
5196 * object to get detailed information about the rbd image.
a30b71b9 5197 */
1f3ef788 5198static int rbd_dev_image_probe(struct rbd_device *rbd_dev, bool mapping)
a30b71b9
AE
5199{
5200 int ret;
5201
5202 /*
3abef3b3
AE
5203 * Get the id from the image id object. Unless there's an
5204 * error, rbd_dev->spec->image_id will be filled in with
5205 * a dynamically-allocated string, and rbd_dev->image_format
5206 * will be set to either 1 or 2.
a30b71b9
AE
5207 */
5208 ret = rbd_dev_image_id(rbd_dev);
5209 if (ret)
c0fba368 5210 return ret;
c0fba368 5211
332bb12d
AE
5212 ret = rbd_dev_header_name(rbd_dev);
5213 if (ret)
5214 goto err_out_format;
5215
1f3ef788 5216 if (mapping) {
fca27065 5217 ret = rbd_dev_header_watch_sync(rbd_dev);
1f3ef788
AE
5218 if (ret)
5219 goto out_header_name;
5220 }
b644de2b 5221
a720ae09 5222 ret = rbd_dev_header_info(rbd_dev);
5655c4d9 5223 if (ret)
b644de2b 5224 goto err_out_watch;
83a06263 5225
04077599
ID
5226 /*
5227 * If this image is the one being mapped, we have pool name and
5228 * id, image name and id, and snap name - need to fill snap id.
5229 * Otherwise this is a parent image, identified by pool, image
5230 * and snap ids - need to fill in names for those ids.
5231 */
5232 if (mapping)
5233 ret = rbd_spec_fill_snap_id(rbd_dev);
5234 else
5235 ret = rbd_spec_fill_names(rbd_dev);
9bb81c9b 5236 if (ret)
33dca39f 5237 goto err_out_probe;
9bb81c9b 5238
e8f59b59
ID
5239 if (rbd_dev->header.features & RBD_FEATURE_LAYERING) {
5240 ret = rbd_dev_v2_parent_info(rbd_dev);
5241 if (ret)
5242 goto err_out_probe;
5243
5244 /*
5245 * Need to warn users if this image is the one being
5246 * mapped and has a parent.
5247 */
5248 if (mapping && rbd_dev->parent_spec)
5249 rbd_warn(rbd_dev,
5250 "WARNING: kernel layering is EXPERIMENTAL!");
5251 }
5252
9bb81c9b 5253 ret = rbd_dev_probe_parent(rbd_dev);
30d60ba2
AE
5254 if (ret)
5255 goto err_out_probe;
5256
5257 dout("discovered format %u image, header name is %s\n",
5258 rbd_dev->image_format, rbd_dev->header_name);
30d60ba2 5259 return 0;
e8f59b59 5260
6fd48b3b
AE
5261err_out_probe:
5262 rbd_dev_unprobe(rbd_dev);
b644de2b 5263err_out_watch:
fca27065
ID
5264 if (mapping)
5265 rbd_dev_header_unwatch_sync(rbd_dev);
332bb12d
AE
5266out_header_name:
5267 kfree(rbd_dev->header_name);
5268 rbd_dev->header_name = NULL;
5269err_out_format:
5270 rbd_dev->image_format = 0;
5655c4d9
AE
5271 kfree(rbd_dev->spec->image_id);
5272 rbd_dev->spec->image_id = NULL;
a30b71b9
AE
5273 return ret;
5274}
5275
9b60e70b
ID
5276static ssize_t do_rbd_add(struct bus_type *bus,
5277 const char *buf,
5278 size_t count)
602adf40 5279{
cb8627c7 5280 struct rbd_device *rbd_dev = NULL;
dc79b113 5281 struct ceph_options *ceph_opts = NULL;
4e9afeba 5282 struct rbd_options *rbd_opts = NULL;
859c31df 5283 struct rbd_spec *spec = NULL;
9d3997fd 5284 struct rbd_client *rbdc;
51344a38 5285 bool read_only;
27cc2594 5286 int rc = -ENOMEM;
602adf40
YS
5287
5288 if (!try_module_get(THIS_MODULE))
5289 return -ENODEV;
5290
602adf40 5291 /* parse add command */
859c31df 5292 rc = rbd_add_parse_args(buf, &ceph_opts, &rbd_opts, &spec);
dc79b113 5293 if (rc < 0)
bd4ba655 5294 goto err_out_module;
51344a38
AE
5295 read_only = rbd_opts->read_only;
5296 kfree(rbd_opts);
5297 rbd_opts = NULL; /* done with this */
78cea76e 5298
9d3997fd
AE
5299 rbdc = rbd_get_client(ceph_opts);
5300 if (IS_ERR(rbdc)) {
5301 rc = PTR_ERR(rbdc);
0ddebc0c 5302 goto err_out_args;
9d3997fd 5303 }
602adf40 5304
602adf40 5305 /* pick the pool */
30ba1f02 5306 rc = rbd_add_get_pool_id(rbdc, spec->pool_name);
602adf40
YS
5307 if (rc < 0)
5308 goto err_out_client;
c0cd10db 5309 spec->pool_id = (u64)rc;
859c31df 5310
0903e875
AE
5311 /* The ceph file layout needs to fit pool id in 32 bits */
5312
c0cd10db 5313 if (spec->pool_id > (u64)U32_MAX) {
9584d508 5314 rbd_warn(NULL, "pool id too large (%llu > %u)",
c0cd10db 5315 (unsigned long long)spec->pool_id, U32_MAX);
0903e875
AE
5316 rc = -EIO;
5317 goto err_out_client;
5318 }
5319
c53d5893 5320 rbd_dev = rbd_dev_create(rbdc, spec);
bd4ba655
AE
5321 if (!rbd_dev)
5322 goto err_out_client;
c53d5893
AE
5323 rbdc = NULL; /* rbd_dev now owns this */
5324 spec = NULL; /* rbd_dev now owns this */
602adf40 5325
1f3ef788 5326 rc = rbd_dev_image_probe(rbd_dev, true);
a30b71b9 5327 if (rc < 0)
c53d5893 5328 goto err_out_rbd_dev;
05fd6f6f 5329
7ce4eef7
AE
5330 /* If we are mapping a snapshot it must be marked read-only */
5331
5332 if (rbd_dev->spec->snap_id != CEPH_NOSNAP)
5333 read_only = true;
5334 rbd_dev->mapping.read_only = read_only;
5335
b536f69a 5336 rc = rbd_dev_device_setup(rbd_dev);
3abef3b3 5337 if (rc) {
e37180c0
ID
5338 /*
5339 * rbd_dev_header_unwatch_sync() can't be moved into
5340 * rbd_dev_image_release() without refactoring, see
5341 * commit 1f3ef78861ac.
5342 */
5343 rbd_dev_header_unwatch_sync(rbd_dev);
3abef3b3
AE
5344 rbd_dev_image_release(rbd_dev);
5345 goto err_out_module;
5346 }
5347
5348 return count;
b536f69a 5349
c53d5893
AE
5350err_out_rbd_dev:
5351 rbd_dev_destroy(rbd_dev);
bd4ba655 5352err_out_client:
9d3997fd 5353 rbd_put_client(rbdc);
0ddebc0c 5354err_out_args:
859c31df 5355 rbd_spec_put(spec);
bd4ba655
AE
5356err_out_module:
5357 module_put(THIS_MODULE);
27cc2594 5358
602adf40 5359 dout("Error adding device %s\n", buf);
27cc2594 5360
c0cd10db 5361 return (ssize_t)rc;
602adf40
YS
5362}
5363
9b60e70b
ID
5364static ssize_t rbd_add(struct bus_type *bus,
5365 const char *buf,
5366 size_t count)
5367{
5368 if (single_major)
5369 return -EINVAL;
5370
5371 return do_rbd_add(bus, buf, count);
5372}
5373
5374static ssize_t rbd_add_single_major(struct bus_type *bus,
5375 const char *buf,
5376 size_t count)
5377{
5378 return do_rbd_add(bus, buf, count);
5379}
5380
200a6a8b 5381static void rbd_dev_device_release(struct device *dev)
602adf40 5382{
593a9e7b 5383 struct rbd_device *rbd_dev = dev_to_rbd_dev(dev);
602adf40 5384
bc1ecc65 5385 destroy_workqueue(rbd_dev->rq_wq);
602adf40 5386 rbd_free_disk(rbd_dev);
200a6a8b 5387 clear_bit(RBD_DEV_FLAG_EXISTS, &rbd_dev->flags);
6d80b130 5388 rbd_dev_mapping_clear(rbd_dev);
9b60e70b
ID
5389 if (!single_major)
5390 unregister_blkdev(rbd_dev->major, rbd_dev->name);
e2839308 5391 rbd_dev_id_put(rbd_dev);
d1cf5788 5392 rbd_dev_mapping_clear(rbd_dev);
602adf40
YS
5393}
5394
05a46afd
AE
5395static void rbd_dev_remove_parent(struct rbd_device *rbd_dev)
5396{
ad945fc1 5397 while (rbd_dev->parent) {
05a46afd
AE
5398 struct rbd_device *first = rbd_dev;
5399 struct rbd_device *second = first->parent;
5400 struct rbd_device *third;
5401
5402 /*
5403 * Follow to the parent with no grandparent and
5404 * remove it.
5405 */
5406 while (second && (third = second->parent)) {
5407 first = second;
5408 second = third;
5409 }
ad945fc1 5410 rbd_assert(second);
8ad42cd0 5411 rbd_dev_image_release(second);
ad945fc1
AE
5412 first->parent = NULL;
5413 first->parent_overlap = 0;
5414
5415 rbd_assert(first->parent_spec);
05a46afd
AE
5416 rbd_spec_put(first->parent_spec);
5417 first->parent_spec = NULL;
05a46afd
AE
5418 }
5419}
5420
9b60e70b
ID
5421static ssize_t do_rbd_remove(struct bus_type *bus,
5422 const char *buf,
5423 size_t count)
602adf40
YS
5424{
5425 struct rbd_device *rbd_dev = NULL;
751cc0e3
AE
5426 struct list_head *tmp;
5427 int dev_id;
602adf40 5428 unsigned long ul;
82a442d2 5429 bool already = false;
0d8189e1 5430 int ret;
602adf40 5431
bb8e0e84 5432 ret = kstrtoul(buf, 10, &ul);
0d8189e1
AE
5433 if (ret)
5434 return ret;
602adf40
YS
5435
5436 /* convert to int; abort if we lost anything in the conversion */
751cc0e3
AE
5437 dev_id = (int)ul;
5438 if (dev_id != ul)
602adf40
YS
5439 return -EINVAL;
5440
751cc0e3
AE
5441 ret = -ENOENT;
5442 spin_lock(&rbd_dev_list_lock);
5443 list_for_each(tmp, &rbd_dev_list) {
5444 rbd_dev = list_entry(tmp, struct rbd_device, node);
5445 if (rbd_dev->dev_id == dev_id) {
5446 ret = 0;
5447 break;
5448 }
42382b70 5449 }
751cc0e3
AE
5450 if (!ret) {
5451 spin_lock_irq(&rbd_dev->lock);
5452 if (rbd_dev->open_count)
5453 ret = -EBUSY;
5454 else
82a442d2
AE
5455 already = test_and_set_bit(RBD_DEV_FLAG_REMOVING,
5456 &rbd_dev->flags);
751cc0e3
AE
5457 spin_unlock_irq(&rbd_dev->lock);
5458 }
5459 spin_unlock(&rbd_dev_list_lock);
82a442d2 5460 if (ret < 0 || already)
1ba0f1e7 5461 return ret;
751cc0e3 5462
fca27065 5463 rbd_dev_header_unwatch_sync(rbd_dev);
9abc5990
JD
5464 /*
5465 * flush remaining watch callbacks - these must be complete
5466 * before the osd_client is shutdown
5467 */
5468 dout("%s: flushing notifies", __func__);
5469 ceph_osdc_flush_notifies(&rbd_dev->rbd_client->client->osdc);
fca27065 5470
9875201e
JD
5471 /*
5472 * Don't free anything from rbd_dev->disk until after all
5473 * notifies are completely processed. Otherwise
5474 * rbd_bus_del_dev() will race with rbd_watch_cb(), resulting
5475 * in a potential use after free of rbd_dev->disk or rbd_dev.
5476 */
5477 rbd_bus_del_dev(rbd_dev);
8ad42cd0 5478 rbd_dev_image_release(rbd_dev);
79ab7558 5479 module_put(THIS_MODULE);
aafb230e 5480
1ba0f1e7 5481 return count;
602adf40
YS
5482}
5483
9b60e70b
ID
5484static ssize_t rbd_remove(struct bus_type *bus,
5485 const char *buf,
5486 size_t count)
5487{
5488 if (single_major)
5489 return -EINVAL;
5490
5491 return do_rbd_remove(bus, buf, count);
5492}
5493
5494static ssize_t rbd_remove_single_major(struct bus_type *bus,
5495 const char *buf,
5496 size_t count)
5497{
5498 return do_rbd_remove(bus, buf, count);
5499}
5500
602adf40
YS
5501/*
5502 * create control files in sysfs
dfc5606d 5503 * /sys/bus/rbd/...
602adf40
YS
5504 */
5505static int rbd_sysfs_init(void)
5506{
dfc5606d 5507 int ret;
602adf40 5508
fed4c143 5509 ret = device_register(&rbd_root_dev);
21079786 5510 if (ret < 0)
dfc5606d 5511 return ret;
602adf40 5512
fed4c143
AE
5513 ret = bus_register(&rbd_bus_type);
5514 if (ret < 0)
5515 device_unregister(&rbd_root_dev);
602adf40 5516
602adf40
YS
5517 return ret;
5518}
5519
5520static void rbd_sysfs_cleanup(void)
5521{
dfc5606d 5522 bus_unregister(&rbd_bus_type);
fed4c143 5523 device_unregister(&rbd_root_dev);
602adf40
YS
5524}
5525
1c2a9dfe
AE
5526static int rbd_slab_init(void)
5527{
5528 rbd_assert(!rbd_img_request_cache);
5529 rbd_img_request_cache = kmem_cache_create("rbd_img_request",
5530 sizeof (struct rbd_img_request),
5531 __alignof__(struct rbd_img_request),
5532 0, NULL);
868311b1
AE
5533 if (!rbd_img_request_cache)
5534 return -ENOMEM;
5535
5536 rbd_assert(!rbd_obj_request_cache);
5537 rbd_obj_request_cache = kmem_cache_create("rbd_obj_request",
5538 sizeof (struct rbd_obj_request),
5539 __alignof__(struct rbd_obj_request),
5540 0, NULL);
78c2a44a
AE
5541 if (!rbd_obj_request_cache)
5542 goto out_err;
5543
5544 rbd_assert(!rbd_segment_name_cache);
5545 rbd_segment_name_cache = kmem_cache_create("rbd_segment_name",
2d0ebc5d 5546 CEPH_MAX_OID_NAME_LEN + 1, 1, 0, NULL);
78c2a44a 5547 if (rbd_segment_name_cache)
1c2a9dfe 5548 return 0;
78c2a44a
AE
5549out_err:
5550 if (rbd_obj_request_cache) {
5551 kmem_cache_destroy(rbd_obj_request_cache);
5552 rbd_obj_request_cache = NULL;
5553 }
1c2a9dfe 5554
868311b1
AE
5555 kmem_cache_destroy(rbd_img_request_cache);
5556 rbd_img_request_cache = NULL;
5557
1c2a9dfe
AE
5558 return -ENOMEM;
5559}
5560
5561static void rbd_slab_exit(void)
5562{
78c2a44a
AE
5563 rbd_assert(rbd_segment_name_cache);
5564 kmem_cache_destroy(rbd_segment_name_cache);
5565 rbd_segment_name_cache = NULL;
5566
868311b1
AE
5567 rbd_assert(rbd_obj_request_cache);
5568 kmem_cache_destroy(rbd_obj_request_cache);
5569 rbd_obj_request_cache = NULL;
5570
1c2a9dfe
AE
5571 rbd_assert(rbd_img_request_cache);
5572 kmem_cache_destroy(rbd_img_request_cache);
5573 rbd_img_request_cache = NULL;
5574}
5575
cc344fa1 5576static int __init rbd_init(void)
602adf40
YS
5577{
5578 int rc;
5579
1e32d34c
AE
5580 if (!libceph_compatible(NULL)) {
5581 rbd_warn(NULL, "libceph incompatibility (quitting)");
1e32d34c
AE
5582 return -EINVAL;
5583 }
e1b4d96d 5584
1c2a9dfe 5585 rc = rbd_slab_init();
602adf40
YS
5586 if (rc)
5587 return rc;
e1b4d96d 5588
9b60e70b
ID
5589 if (single_major) {
5590 rbd_major = register_blkdev(0, RBD_DRV_NAME);
5591 if (rbd_major < 0) {
5592 rc = rbd_major;
5593 goto err_out_slab;
5594 }
5595 }
5596
1c2a9dfe
AE
5597 rc = rbd_sysfs_init();
5598 if (rc)
9b60e70b
ID
5599 goto err_out_blkdev;
5600
5601 if (single_major)
5602 pr_info("loaded (major %d)\n", rbd_major);
5603 else
5604 pr_info("loaded\n");
1c2a9dfe 5605
e1b4d96d
ID
5606 return 0;
5607
9b60e70b
ID
5608err_out_blkdev:
5609 if (single_major)
5610 unregister_blkdev(rbd_major, RBD_DRV_NAME);
e1b4d96d
ID
5611err_out_slab:
5612 rbd_slab_exit();
1c2a9dfe 5613 return rc;
602adf40
YS
5614}
5615
cc344fa1 5616static void __exit rbd_exit(void)
602adf40 5617{
ffe312cf 5618 ida_destroy(&rbd_dev_id_ida);
602adf40 5619 rbd_sysfs_cleanup();
9b60e70b
ID
5620 if (single_major)
5621 unregister_blkdev(rbd_major, RBD_DRV_NAME);
1c2a9dfe 5622 rbd_slab_exit();
602adf40
YS
5623}
5624
5625module_init(rbd_init);
5626module_exit(rbd_exit);
5627
d552c619 5628MODULE_AUTHOR("Alex Elder <elder@inktank.com>");
602adf40
YS
5629MODULE_AUTHOR("Sage Weil <sage@newdream.net>");
5630MODULE_AUTHOR("Yehuda Sadeh <yehuda@hq.newdream.net>");
602adf40
YS
5631/* following authorship retained from original osdblk.c */
5632MODULE_AUTHOR("Jeff Garzik <jeff@garzik.org>");
5633
90da258b 5634MODULE_DESCRIPTION("RADOS Block Device (RBD) driver");
602adf40 5635MODULE_LICENSE("GPL");