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