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