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